1 //: So far the recipes we define can't run each other. Let's fix that.
  2 
  3 :(scenario calling_recipe)
  4 def main [
  5   f
  6 ]
  7 def f [
  8   3:num <- add 2, 2
  9 ]
 10 +mem: storing 4 in location 3
 11 
 12 :(scenario return_on_fallthrough)
 13 def main [
 14   f
 15   1:num <- copy 0
 16   2:num <- copy 0
 17   3:num <- copy 0
 18 ]
 19 def f [
 20   4:num <- copy 0
 21   5:num <- copy 0
 22 ]
 23 +run: f
 24 # running f
 25 +run: {4: "number"} <- copy {0: "literal"}
 26 +run: {5: "number"} <- copy {0: "literal"}
 27 # back out to main
 28 +run: {1: "number"} <- copy {0: "literal"}
 29 +run: {2: "number"} <- copy {0: "literal"}
 30 +run: {3: "number"} <- copy {0: "literal"}
 31 
 32 :(before "struct routine {")
 33 // Everytime a recipe runs another, we interrupt it and start running the new
 34 // recipe. When that finishes, we continue this one where we left off.
 35 // This requires maintaining a 'stack' of interrupted recipes or 'calls'.
 36 struct call {
 37   recipe_ordinal running_recipe;
 38   int running_step_index;
 39   // End call Fields
 40   call(recipe_ordinal r) {
 41   ¦ running_recipe = r;
 42   ¦ running_step_index = 0;
 43   ¦ // End call Constructor
 44   }
 45   ~call() {
 46   ¦ // End call Destructor
 47   }
 48 };
 49 typedef list<call> call_stack;
 50 
 51 :(replace{} "struct routine")
 52 struct routine {
 53   call_stack calls;
 54   // End routine Fields
 55   routine(recipe_ordinal r);
 56   bool completed() const;
 57   const vector<instruction>& steps() const;
 58 };
 59 :(code)
 60 routine::routine(recipe_ordinal r) {
 61   if (Trace_stream) {
 62   ¦ ++Trace_stream->callstack_depth;
 63   ¦ trace(9999, "trace") << "new routine; incrementing callstack depth to " << Trace_stream->callstack_depth << end();
 64   ¦ assert(Trace_stream->callstack_depth < 9000);  // 9998-101 plus cushion
 65   }
 66   calls.push_front(call(r));
 67   // End routine Constructor
 68 }
 69 
 70 //:: now update routine's helpers
 71 
 72 //: macro versions for a slight speedup
 73 
 74 :(delete{} "int& current_step_index()")
 75 :(delete{} "recipe_ordinal currently_running_recipe()")
 76 :(delete{} "const string& current_recipe_name()")
 77 :(delete{} "const recipe& current_recipe()")
 78 :(delete{} "const instruction& current_instruction()")
 79 
 80 :(before "End Includes")
 81 #define current_call() Current_routine->calls.front()
 82 #define current_step_index() current_call().running_step_index
 83 #define currently_running_recipe() current_call().running_recipe
 84 #define current_recipe() get(Recipe, currently_running_recipe())
 85 #define current_recipe_name() current_recipe().name
 86 #define to_instruction(call) get(Recipe, (call).running_recipe).steps.at((call).running_step_index)
 87 #define current_instruction() to_instruction(current_call())
 88 
 89 //: function versions for debugging
 90 
 91 :(code)
 92 //? :(before "End Globals")
 93 //? bool Foo2 = false;
 94 //? :(code)
 95 //? call& current_call() {
 96 //?   if (Foo2) cerr << __FUNCTION__ << '\n';
 97 //?   return Current_routine->calls.front();
 98 //? }
 99 //? :(replace{} "int& current_step_index()")
100 //? int& current_step_index() {
101 //?   assert(!Current_routine->calls.empty());
102 //?   if (Foo2) cerr << __FUNCTION__ << '\n';
103 //?   return current_call().running_step_index;
104 //? }
105 //? :(replace{} "recipe_ordinal currently_running_recipe()")
106 //? recipe_ordinal currently_running_recipe() {
107 //?   assert(!Current_routine->calls.empty());
108 //?   if (Foo2) cerr << __FUNCTION__ << '\n';
109 //?   return current_call().running_recipe;
110 //? }
111 //? :(replace{} "const string& current_recipe_name()")
112 //? const string& current_recipe_name() {
113 //?   assert(!Current_routine->calls.empty());
114 //?   if (Foo2) cerr << __FUNCTION__ << '\n';
115 //?   return get(Recipe, current_call().running_recipe).name;
116 //? }
117 //? :(replace{} "const recipe& current_recipe()")
118 //? const recipe& current_recipe() {
119 //?   assert(!Current_routine->calls.empty());
120 //?   if (Foo2) cerr << __FUNCTION__ << '\n';
121 //?   return get(Recipe, current_call().running_recipe);
122 //? }
123 //? :(replace{} "const instruction& current_instruction()")
124 //? const instruction& current_instruction() {
125 //?   assert(!Current_routine->calls.empty());
126 //?   if (Foo2) cerr << __FUNCTION__ << '\n';
127 //?   return to_instruction(current_call());
128 //? }
129 //? :(code)
130 //? const instruction& to_instruction(const call& call) {
131 //?   return get(Recipe, call.running_recipe).steps.at(call.running_step_index);
132 //? }
133 
134 :(after "Defined Recipe Checks")
135 // not a primitive; check that it's present in the book of recipes
136 if (!contains_key(Recipe, inst.operation)) {
137   raise << maybe(get(Recipe, r).name) << "undefined operation in '" << to_original_string(inst) << "'\n" << end();
138   break;
139 }
140 :(replace{} "default:" following "End Primitive Recipe Implementations")
141 default: {
142   if (contains_key(Recipe, current_instruction().operation)) {  // error already raised in Checks above
143   ¦ // not a primitive; look up the book of recipes
144   ¦ if (Trace_stream) {
145   ¦ ¦ ++Trace_stream->callstack_depth;
146   ¦ ¦ trace(9999, "trace") << "incrementing callstack depth to " << Trace_stream->callstack_depth << end();
147   ¦ ¦ assert(Trace_stream->callstack_depth < 9000);  // 9998-101 plus cushion
148   ¦ }
149   ¦ const call& caller_frame = current_call();
150   ¦ Current_routine->calls.push_front(call(to_instruction(caller_frame).operation));
151   ¦ finish_call_housekeeping(to_instruction(caller_frame), ingredients);
152   ¦ // not done with caller
153   ¦ write_products = false;
154   ¦ fall_through_to_next_instruction = false;
155   ¦ // End Non-primitive Call(caller_frame)
156   }
157 }
158 :(code)
159 void finish_call_housekeeping(const instruction& call_instruction, const vector<vector<double> >& ingredients) {
160   // End Call Housekeeping
161 }
162 
163 :(scenario calling_undefined_recipe_fails)
164 % Hide_errors = true;
165 def main [
166   foo
167 ]
168 +error: main: undefined operation in 'foo'
169 
170 :(scenario calling_undefined_recipe_handles_missing_result)
171 % Hide_errors = true;
172 def main [
173   x:num <- foo
174 ]
175 +error: main: undefined operation in 'x:num <- foo'
176 
177 //:: finally, we need to fix the termination conditions for the run loop
178 
179 :(replace{} "bool routine::completed() const")
180 bool routine::completed() const {
181   return calls.empty();
182 }
183 
184 :(replace{} "const vector<instruction>& routine::steps() const")
185 const vector<instruction>& routine::steps() const {
186   assert(!calls.empty());
187   return get(Recipe, calls.front().running_recipe).steps;
188 }
189 
190 :(after "Running One Instruction")
191 // when we reach the end of one call, we may reach the end of the one below
192 // it, and the one below that, and so on
193 while (current_step_index() >= SIZE(Current_routine->steps())) {
194   // Falling Through End Of Recipe
195   if (Trace_stream) {
196   ¦ trace(9999, "trace") << "fall-through: exiting " << current_recipe_name() << "; decrementing callstack depth from " << Trace_stream->callstack_depth << end();
197   ¦ --Trace_stream->callstack_depth;
198   ¦ assert(Trace_stream->callstack_depth >= 0);
199   }
200   Current_routine->calls.pop_front();
201   if (Current_routine->calls.empty()) goto stop_running_current_routine;
202   // Complete Call Fallthrough
203   // todo: fail if no products returned
204   ++current_step_index();
205 }