2987

1 files changed, 492 insertions, 0 deletions

diff --git a/053recipe_header.cc b/053recipe_header.cc
new file mode 100644
index 00000000..c58962a0
--- /dev/null
+++ b/053recipe_header.cc
@@ -0,0 +1,492 @@
+//: Advanced notation for the common/easy case where a recipe takes some fixed
+//: number of ingredients and yields some fixed number of products.
+
+:(scenario recipe_with_header)
+def main [
+  1:number/raw <- add2 3, 5
+]
+def add2 x:number, y:number -> z:number [
+  local-scope
+  load-ingredients
+  z:number <- add x, y
+  return z
+]
++mem: storing 8 in location 1
+
+//: When loading recipes save any header.
+
+:(before "End recipe Fields")
+bool has_header;
+vector<reagent> ingredients;
+vector<reagent> products;
+:(before "End recipe Constructor")
+has_header = false;
+
+:(before "End Recipe Refinements")
+if (in.peek() != '[') {
+  trace(9999, "parse") << "recipe has a header; parsing" << end();
+  load_recipe_header(in, result);
+}
+
+:(code)
+void load_recipe_header(istream& in, recipe& result) {
+  result.has_header = true;
+  while (has_data(in) && in.peek() != '[' && in.peek() != '\n') {
+    string s = next_word(in);
+    if (s == "<-")
+      raise << "recipe " << result.name << " should say '->' and not '<-'\n" << end();
+    if (s == "->") break;
+    result.ingredients.push_back(reagent(s));
+    trace(9999, "parse") << "header ingredient: " << result.ingredients.back().original_string << end();
+    skip_whitespace_but_not_newline(in);
+  }
+  while (has_data(in) && in.peek() != '[' && in.peek() != '\n') {
+    string s = next_word(in);
+    result.products.push_back(reagent(s));
+    trace(9999, "parse") << "header product: " << result.products.back().original_string << end();
+    skip_whitespace_but_not_newline(in);
+  }
+  // End Load Recipe Header(result)
+}
+
+:(scenario recipe_handles_stray_comma)
+def main [
+  1:number/raw <- add2 3, 5
+]
+def add2 x:number, y:number -> z:number, [
+  local-scope
+  load-ingredients
+  z:number <- add x, y
+  return z
+]
++mem: storing 8 in location 1
+
+:(scenario recipe_handles_stray_comma_2)
+def main [
+  foo
+]
+def foo, [
+  1:number/raw <- add 2, 2
+]
+def bar [
+  1:number/raw <- add 2, 3
+]
++mem: storing 4 in location 1
+
+:(scenario recipe_handles_wrong_arrow)
+% Hide_errors = true;
+def foo a:number <- b:number [
+]
++error: recipe foo should say '->' and not '<-'
+
+:(scenario recipe_handles_missing_bracket)
+% Hide_errors = true;
+def main
+]
++error: recipe body must begin with '['
+
+:(scenario recipe_handles_missing_bracket_2)
+% Hide_errors = true;
+def main
+  local-scope
+  {
+  }
+]
+# doesn't overflow line when reading header
+-parse: header ingredient: local-scope
++error: recipe body must begin with '['
+
+:(scenario recipe_handles_missing_bracket_3)
+% Hide_errors = true;
+def main  # comment
+  local-scope
+  {
+  }
+]
+# doesn't overflow line when reading header
+-parse: header ingredient: local-scope
++error: recipe body must begin with '['
+
+:(after "Begin debug_string(recipe x)")
+out << "ingredients:\n";
+for (int i = 0; i < SIZE(x.ingredients); ++i)
+  out << "  " << debug_string(x.ingredients.at(i)) << '\n';
+out << "products:\n";
+for (int i = 0; i < SIZE(x.products); ++i)
+  out << "  " << debug_string(x.products.at(i)) << '\n';
+
+//: If a recipe never mentions any ingredients or products, assume it has a header.
+
+:(scenario recipe_without_ingredients_or_products_has_header)
+def test [
+  1:number <- copy 34
+]
++parse: recipe test has a header
+
+:(before "End Recipe Body(result)")
+if (!result.has_header) {
+  result.has_header = true;
+  for (int i = 0; i < SIZE(result.steps); ++i) {
+    const instruction& inst = result.steps.at(i);
+    if ((inst.name == "reply" && !inst.ingredients.empty())
+        || (inst.name == "return" && !inst.ingredients.empty())
+        || inst.name == "next-ingredient"
+        || inst.name == "ingredient"
+        || inst.name == "rewind-ingredients") {
+      result.has_header = false;
+      break;
+    }
+  }
+}
+if (result.has_header) {
+  trace(9999, "parse") << "recipe " << result.name << " has a header" << end();
+}
+
+//: Rewrite 'load-ingredients' to instructions to create all reagents in the header.
+
+:(before "End Rewrite Instruction(curr, recipe result)")
+if (curr.name == "load-ingredients") {
+  curr.clear();
+  recipe_ordinal op = get(Recipe_ordinal, "next-ingredient-without-typechecking");
+  for (int i = 0; i < SIZE(result.ingredients); ++i) {
+    curr.operation = op;
+    curr.name = "next-ingredient-without-typechecking";
+    curr.products.push_back(result.ingredients.at(i));
+    result.steps.push_back(curr);
+    curr.clear();
+  }
+}
+
+//: internal version of next-ingredient; don't call this directly
+:(before "End Primitive Recipe Declarations")
+NEXT_INGREDIENT_WITHOUT_TYPECHECKING,
+:(before "End Primitive Recipe Numbers")
+put(Recipe_ordinal, "next-ingredient-without-typechecking", NEXT_INGREDIENT_WITHOUT_TYPECHECKING);
+:(before "End Primitive Recipe Checks")
+case NEXT_INGREDIENT_WITHOUT_TYPECHECKING: {
+  break;
+}
+:(before "End Primitive Recipe Implementations")
+case NEXT_INGREDIENT_WITHOUT_TYPECHECKING: {
+  assert(!Current_routine->calls.empty());
+  if (current_call().next_ingredient_to_process < SIZE(current_call().ingredient_atoms)) {
+    products.push_back(
+        current_call().ingredient_atoms.at(current_call().next_ingredient_to_process));
+    assert(SIZE(products) == 1);  products.resize(2);  // push a new vector
+    products.at(1).push_back(1);
+    ++current_call().next_ingredient_to_process;
+  }
+  else {
+    products.resize(2);
+    // pad the first product with sufficient zeros to match its type
+    int size = size_of(current_instruction().products.at(0));
+    for (int i = 0; i < size; ++i)
+      products.at(0).push_back(0);
+    products.at(1).push_back(0);
+  }
+  break;
+}
+
+//:: Check all calls against headers.
+
+:(scenario show_clear_error_on_bad_call)
+% Hide_errors = true;
+def main [
+  1:number <- foo 34
+]
+def foo x:point -> y:number [
+  local-scope
+  load-ingredients
+  return 35
+]
++error: main: ingredient 0 has the wrong type at '1:number <- foo 34'
+
+:(scenario show_clear_error_on_bad_call_2)
+% Hide_errors = true;
+def main [
+  1:point <- foo 34
+]
+def foo x:number -> y:number [
+  local-scope
+  load-ingredients
+  return x
+]
++error: main: product 0 has the wrong type at '1:point <- foo 34'
+
+:(after "Transform.push_back(check_instruction)")
+Transform.push_back(check_calls_against_header);  // idempotent
+:(code)
+void check_calls_against_header(const recipe_ordinal r) {
+  trace(9991, "transform") << "--- type-check calls inside recipe " << get(Recipe, r).name << end();
+  const recipe& caller = get(Recipe, r);
+  for (int i = 0; i < SIZE(caller.steps); ++i) {
+    const instruction& inst = caller.steps.at(i);
+    if (inst.operation < MAX_PRIMITIVE_RECIPES) continue;
+    const recipe& callee = get(Recipe, inst.operation);
+    if (!callee.has_header) continue;
+    for (long int i = 0; i < min(SIZE(inst.ingredients), SIZE(callee.ingredients)); ++i) {
+      // ingredients coerced from call to callee
+      if (!types_coercible(callee.ingredients.at(i), inst.ingredients.at(i)))
+        raise << maybe(caller.name) << "ingredient " << i << " has the wrong type at '" << to_original_string(inst) << "'\n" << end();
+    }
+    for (long int i = 0; i < min(SIZE(inst.products), SIZE(callee.products)); ++i) {
+      if (is_dummy(inst.products.at(i))) continue;
+      // products coerced from callee to call
+      if (!types_coercible(inst.products.at(i), callee.products.at(i)))
+        raise << maybe(caller.name) << "product " << i << " has the wrong type at '" << to_original_string(inst) << "'\n" << end();
+    }
+  }
+}
+
+//:: Check types going in and out of all recipes with headers.
+
+:(scenarios transform)
+:(scenario recipe_headers_are_checked)
+% Hide_errors = true;
+def add2 x:number, y:number -> z:number [
+  local-scope
+  load-ingredients
+  z:address:number <- copy 0/unsafe
+  return z
+]
++error: add2: replied with the wrong type at 'return z'
+
+:(before "End Checks")
+Transform.push_back(check_reply_instructions_against_header);  // idempotent
+
+:(code)
+void check_reply_instructions_against_header(const recipe_ordinal r) {
+  const recipe& caller_recipe = get(Recipe, r);
+  if (!caller_recipe.has_header) return;
+  trace(9991, "transform") << "--- checking reply instructions against header for " << caller_recipe.name << end();
+  for (int i = 0; i < SIZE(caller_recipe.steps); ++i) {
+    const instruction& inst = caller_recipe.steps.at(i);
+    if (inst.name != "reply" && inst.name != "return") continue;
+    if (SIZE(caller_recipe.products) != SIZE(inst.ingredients)) {
+      raise << maybe(caller_recipe.name) << "replied with the wrong number of products at '" << to_original_string(inst) << "'\n" << end();
+      continue;
+    }
+    for (int i = 0; i < SIZE(caller_recipe.products); ++i) {
+      if (!types_match(caller_recipe.products.at(i), inst.ingredients.at(i)))
+        raise << maybe(caller_recipe.name) << "replied with the wrong type at '" << to_original_string(inst) << "'\n" << end();
+    }
+  }
+}
+
+:(scenario recipe_headers_are_checked_2)
+% Hide_errors = true;
+def add2 x:number, y:number [
+  local-scope
+  load-ingredients
+  z:address:number <- copy 0/unsafe
+  return z
+]
++error: add2: replied with the wrong number of products at 'return z'
+
+:(scenario recipe_headers_check_for_duplicate_names)
+% Hide_errors = true;
+def add2 x:number, x:number -> z:number [
+  local-scope
+  load-ingredients
+  return z
+]
++error: add2: x can't repeat in the ingredients
+
+:(before "End recipe Fields")
+map<string, int> ingredient_index;
+
+:(after "Begin Instruction Modifying Transforms")
+Transform.push_back(check_header_ingredients);  // idempotent
+
+:(code)
+void check_header_ingredients(const recipe_ordinal r) {
+  recipe& caller_recipe = get(Recipe, r);
+  if (caller_recipe.products.empty()) return;
+  caller_recipe.ingredient_index.clear();
+  trace(9991, "transform") << "--- checking reply instructions against header for " << caller_recipe.name << end();
+  for (int i = 0; i < SIZE(caller_recipe.ingredients); ++i) {
+    if (contains_key(caller_recipe.ingredient_index, caller_recipe.ingredients.at(i).name))
+      raise << maybe(caller_recipe.name) << caller_recipe.ingredients.at(i).name << " can't repeat in the ingredients\n" << end();
+    put(caller_recipe.ingredient_index, caller_recipe.ingredients.at(i).name, i);
+  }
+}
+
+//: Deduce types from the header if possible.
+
+:(scenarios run)
+:(scenario deduce_instruction_types_from_recipe_header)
+def main [
+  1:number/raw <- add2 3, 5
+]
+def add2 x:number, y:number -> z:number [
+  local-scope
+  load-ingredients
+  z <- add x, y  # no type for z
+  return z
+]
++mem: storing 8 in location 1
+
+:(after "Begin Type Modifying Transforms")
+Transform.push_back(deduce_types_from_header);  // idempotent
+
+:(code)
+void deduce_types_from_header(const recipe_ordinal r) {
+  recipe& caller_recipe = get(Recipe, r);
+  if (caller_recipe.products.empty()) return;
+  trace(9991, "transform") << "--- deduce types from header for " << caller_recipe.name << end();
+  map<string, const type_tree*> header_type;
+  for (int i = 0; i < SIZE(caller_recipe.ingredients); ++i) {
+    if (!caller_recipe.ingredients.at(i).type) continue;  // error handled elsewhere
+    put(header_type, caller_recipe.ingredients.at(i).name, caller_recipe.ingredients.at(i).type);
+    trace(9993, "transform") << "type of " << caller_recipe.ingredients.at(i).name << " is " << names_to_string(caller_recipe.ingredients.at(i).type) << end();
+  }
+  for (int i = 0; i < SIZE(caller_recipe.products); ++i) {
+    if (!caller_recipe.products.at(i).type) continue;  // error handled elsewhere
+    put(header_type, caller_recipe.products.at(i).name, caller_recipe.products.at(i).type);
+    trace(9993, "transform") << "type of " << caller_recipe.products.at(i).name << " is " << names_to_string(caller_recipe.products.at(i).type) << end();
+  }
+  for (int i = 0; i < SIZE(caller_recipe.steps); ++i) {
+    instruction& inst = caller_recipe.steps.at(i);
+    trace(9992, "transform") << "instruction: " << to_string(inst) << end();
+    for (int i = 0; i < SIZE(inst.ingredients); ++i) {
+      if (inst.ingredients.at(i).type) continue;
+      if (header_type.find(inst.ingredients.at(i).name) == header_type.end())
+        continue;
+      if (!contains_key(header_type, inst.ingredients.at(i).name)) continue;  // error handled elsewhere
+      inst.ingredients.at(i).type = new type_tree(*get(header_type, inst.ingredients.at(i).name));
+      trace(9993, "transform") << "type of " << inst.ingredients.at(i).name << " is " << names_to_string(inst.ingredients.at(i).type) << end();
+    }
+    for (int i = 0; i < SIZE(inst.products); ++i) {
+      trace(9993, "transform") << "  product: " << to_string(inst.products.at(i)) << end();
+      if (inst.products.at(i).type) continue;
+      if (header_type.find(inst.products.at(i).name) == header_type.end())
+        continue;
+      if (!contains_key(header_type, inst.products.at(i).name)) continue;  // error handled elsewhere
+      inst.products.at(i).type = new type_tree(*get(header_type, inst.products.at(i).name));
+      trace(9993, "transform") << "type of " << inst.products.at(i).name << " is " << names_to_string(inst.products.at(i).type) << end();
+    }
+  }
+}
+
+//: One final convenience: no need to say what to return if the information is
+//: in the header.
+
+:(scenario return_based_on_header)
+def main [
+  1:number/raw <- add2 3, 5
+]
+def add2 x:number, y:number -> z:number [
+  local-scope
+  load-ingredients
+  z <- add x, y
+  return
+]
++mem: storing 8 in location 1
+
+:(after "Transform.push_back(check_header_ingredients)")
+Transform.push_back(fill_in_reply_ingredients);  // idempotent
+
+:(code)
+void fill_in_reply_ingredients(recipe_ordinal r) {
+  recipe& caller_recipe = get(Recipe, r);
+  if (!caller_recipe.has_header) return;
+  trace(9991, "transform") << "--- fill in reply ingredients from header for recipe " << caller_recipe.name << end();
+  for (int i = 0; i < SIZE(caller_recipe.steps); ++i) {
+    instruction& inst = caller_recipe.steps.at(i);
+    if (inst.name == "reply" || inst.name == "return")
+      add_header_products(inst, caller_recipe);
+  }
+  // fall through reply
+  const instruction& final_instruction = caller_recipe.steps.at(SIZE(caller_recipe.steps)-1);
+  if (final_instruction.name != "reply" && final_instruction.name != "return") {
+    instruction inst;
+    inst.name = "reply";
+    add_header_products(inst, caller_recipe);
+    caller_recipe.steps.push_back(inst);
+  }
+}
+
+void add_header_products(instruction& inst, const recipe& caller_recipe) {
+  assert(inst.name == "reply" || inst.name == "return");
+  // collect any products with the same names as ingredients
+  for (int i = 0; i < SIZE(caller_recipe.products); ++i) {
+    // if the ingredient is missing, add it from the header
+    if (SIZE(inst.ingredients) == i)
+      inst.ingredients.push_back(caller_recipe.products.at(i));
+    // if it's missing /same_as_ingredient, try to fill it in
+    if (contains_key(caller_recipe.ingredient_index, caller_recipe.products.at(i).name) && !has_property(inst.ingredients.at(i), "same_as_ingredient")) {
+      ostringstream same_as_ingredient;
+      same_as_ingredient << get(caller_recipe.ingredient_index, caller_recipe.products.at(i).name);
+      inst.ingredients.at(i).properties.push_back(pair<string, string_tree*>("same-as-ingredient", new string_tree(same_as_ingredient.str())));
+    }
+  }
+}
+
+:(scenario explicit_reply_ignores_header)
+def main [
+  1:number/raw, 2:number/raw <- add2 3, 5
+]
+def add2 a:number, b:number -> y:number, z:number [
+  local-scope
+  load-ingredients
+  y <- add a, b
+  z <- subtract a, b
+  return a, z
+]
++mem: storing 3 in location 1
++mem: storing -2 in location 2
+
+:(scenario return_on_fallthrough_based_on_header)
+def main [
+  1:number/raw <- add2 3, 5
+]
+def add2 x:number, y:number -> z:number [
+  local-scope
+  load-ingredients
+  z <- add x, y
+]
++transform: instruction: reply {z: "number"}
++mem: storing 8 in location 1
+
+:(scenario return_on_fallthrough_already_exists)
+def main [
+  1:number/raw <- add2 3, 5
+]
+def add2 x:number, y:number -> z:number [
+  local-scope
+  load-ingredients
+  z <- add x, y  # no type for z
+  return z
+]
++transform: instruction: return {z: ()}
+-transform: instruction: reply z:number
++mem: storing 8 in location 1
+
+:(scenario return_after_conditional_reply_based_on_header)
+def main [
+  1:number/raw <- add2 3, 5
+]
+def add2 x:number, y:number -> z:number [
+  local-scope
+  load-ingredients
+  z <- add x, y  # no type for z
+  return-if 0/false, 34
+]
++mem: storing 8 in location 1
+
+:(scenario recipe_headers_perform_same_ingredient_check)
+% Hide_errors = true;
+def main [
+  1:number <- copy 34
+  2:number <- copy 34
+  3:number <- add2 1:number, 2:number
+]
+def add2 x:number, y:number -> x:number [
+  local-scope
+  load-ingredients
+]
++error: main: '3:number <- add2 1:number, 2:number' should write to 1:number rather than 3:number
+
+:(before "End Includes")
+using std::min;
+using std::max;