1 //: Containers contain a fixed number of elements of different types.
  2 
  3 :(before "End Mu Types Initialization")
  4 //: We'll use this container as a running example in scenarios below.
  5 type_ordinal point = put(Type_ordinal, "point", Next_type_ordinal++);
  6 get_or_insert(Type, point);  // initialize
  7 get(Type, point).kind = CONTAINER;
  8 get(Type, point).name = "point";
  9 get(Type, point).elements.push_back(reagent("x:number"));
 10 get(Type, point).elements.push_back(reagent("y:number"));
 11 
 12 //: Containers can be copied around with a single instruction just like
 13 //: numbers, no matter how large they are.
 14 
 15 //: Tests in this layer often explicitly set up memory before reading it as a
 16 //: container. Don't do this in general. I'm tagging exceptions with /unsafe to
 17 //: skip later checks.
 18 :(scenario copy_multiple_locations)
 19 def main [
 20   1:num <- copy 34
 21   2:num <- copy 35
 22   3:point <- copy 1:point/unsafe
 23 ]
 24 +mem: storing 34 in location 3
 25 +mem: storing 35 in location 4
 26 
 27 //: trying to copy to a differently-typed destination will fail
 28 :(scenario copy_checks_size)
 29 % Hide_errors = true;
 30 def main [
 31   2:point <- copy 1:num
 32 ]
 33 +error: main: can't copy '1:num' to '2:point'; types don't match
 34 
 35 :(before "End Mu Types Initialization")
 36 // A more complex example container, containing another container as one of
 37 // its elements.
 38 type_ordinal point_number = put(Type_ordinal, "point-number", Next_type_ordinal++);
 39 get_or_insert(Type, point_number);  // initialize
 40 get(Type, point_number).kind = CONTAINER;
 41 get(Type, point_number).name = "point-number";
 42 get(Type, point_number).elements.push_back(reagent("xy:point"));
 43 get(Type, point_number).elements.push_back(reagent("z:number"));
 44 
 45 :(scenario copy_handles_nested_container_elements)
 46 def main [
 47   12:num <- copy 34
 48   13:num <- copy 35
 49   14:num <- copy 36
 50   15:point-number <- copy 12:point-number/unsafe
 51 ]
 52 +mem: storing 36 in location 17
 53 
 54 //: products of recipes can include containers
 55 :(scenario return_container)
 56 def main [
 57   3:point <- f 2
 58 ]
 59 def f [
 60   12:num <- next-ingredient
 61   13:num <- copy 35
 62   return 12:point/raw
 63 ]
 64 +run: result 0 is [2, 35]
 65 +mem: storing 2 in location 3
 66 +mem: storing 35 in location 4
 67 
 68 //: Containers can be checked for equality with a single instruction just like
 69 //: numbers, no matter how large they are.
 70 
 71 :(scenario compare_multiple_locations)
 72 def main [
 73   1:num <- copy 34  # first
 74   2:num <- copy 35
 75   3:num <- copy 36
 76   4:num <- copy 34  # second
 77   5:num <- copy 35
 78   6:num <- copy 36
 79   7:bool <- equal 1:point-number/raw, 4:point-number/unsafe
 80 ]
 81 +mem: storing 1 in location 7
 82 
 83 :(scenario compare_multiple_locations_2)
 84 def main [
 85   1:num <- copy 34  # first
 86   2:num <- copy 35
 87   3:num <- copy 36
 88   4:num <- copy 34  # second
 89   5:num <- copy 35
 90   6:num <- copy 37  # different
 91   7:bool <- equal 1:point-number/raw, 4:point-number/unsafe
 92 ]
 93 +mem: storing 0 in location 7
 94 
 95 //: Can't put this in type_info because later layers will add support for more
 96 //: complex type trees where metadata depends on *combinations* of types.
 97 :(before "struct reagent")
 98 struct container_metadata {
 99   int size;
100   vector<int> offset;  // not used by exclusive containers
101   // End container_metadata Fields
102   container_metadata() :size(0) {
103     // End container_metadata Constructor
104   }
105 };
106 :(before "End reagent Fields")
107 container_metadata metadata;  // can't be a pointer into Container_metadata because we keep changing the base storage when we save/restore snapshots
108 :(before "End reagent Copy Operator")
109 metadata = other.metadata;
110 :(before "End reagent Copy Constructor")
111 metadata = other.metadata;
112 
113 :(before "End Globals")
114 // todo: switch to map after figuring out how to consistently compare type trees
115 vector<pair<type_tree*, container_metadata> > Container_metadata, Container_metadata_snapshot;
116 :(before "End save_snapshots")
117 Container_metadata_snapshot = Container_metadata;
118 :(before "End restore_snapshots")
119 restore_container_metadata();
120 :(before "End One-time Setup")
121 atexit(clear_container_metadata);
122 :(code)
123 // invariant: Container_metadata always contains a superset of Container_metadata_snapshot
124 void restore_container_metadata() {
125   for (int i = 0;  i < SIZE(Container_metadata);  ++i) {
126     assert(Container_metadata.at(i).first);
127     if (i < SIZE(Container_metadata_snapshot)) {
128       assert(Container_metadata.at(i).first == Container_metadata_snapshot.at(i).first);
129       continue;
130     }
131     delete Container_metadata.at(i).first;
132     Container_metadata.at(i).first = NULL;
133   }
134   Container_metadata.resize(SIZE(Container_metadata_snapshot));
135 }
136 void clear_container_metadata() {
137   Container_metadata_snapshot.clear();
138   for (int i = 0;  i < SIZE(Container_metadata);  ++i) {
139     delete Container_metadata.at(i).first;
140     Container_metadata.at(i).first = NULL;
141   }
142   Container_metadata.clear();
143 }
144 
145 //: do no work in size_of, simply lookup Container_metadata
146 
147 :(before "End size_of(reagent r) Special-cases")
148 if (r.metadata.size) return r.metadata.size;
149 
150 :(before "End size_of(type) Special-cases")
151 const type_tree* base_type = type;
152 // Update base_type in size_of(type)
153 if (!contains_key(Type, base_type->value)) {
154   raise << "no such type " << base_type->value << '\n' << end();
155   return 0;
156 }
157 type_info t = get(Type, base_type->value);
158 if (t.kind == CONTAINER) {
159   // Compute size_of Container
160   if (!contains_key(Container_metadata, type)) {
161     raise << "unknown size for container type '" << to_string(type) << "'\n" << end();
162 //?     DUMP("");
163     return 0;
164   }
165   return get(Container_metadata, type).size;
166 }
167 
168 //: precompute Container_metadata before we need size_of
169 //: also store a copy in each reagent in each instruction in each recipe
170 
171 :(after "End Type Modifying Transforms")
172 Transform.push_back(compute_container_sizes);  // idempotent
173 :(code)
174 void compute_container_sizes(const recipe_ordinal r) {
175   recipe& caller = get(Recipe, r);
176   trace(9992, "transform") << "--- compute container sizes for " << caller.name << end();
177   for (int i = 0;  i < SIZE(caller.steps);  ++i) {
178     instruction& inst = caller.steps.at(i);
179     trace(9993, "transform") << "- compute container sizes for " << to_string(inst) << end();
180     for (int i = 0;  i < SIZE(inst.ingredients);  ++i)
181       compute_container_sizes(inst.ingredients.at(i), " in '"+to_original_string(inst)+"'");
182     for (int i = 0;  i < SIZE(inst.products);  ++i)
183       compute_container_sizes(inst.products.at(i), " in '"+to_original_string(inst)+"'");
184   }
185 }
186 
187 void compute_container_sizes(reagent& r, const string& location_for_error_messages) {
188   expand_type_abbreviations(r.type);
189   if (is_literal(r) || is_dummy(r)) return;
190   reagent rcopy = r;
191   // Compute Container Size(reagent rcopy)
192   set<type_tree> pending_metadata;  // might actually be faster to just convert to string rather than compare type_tree directly; so far the difference is negligible
193   compute_container_sizes(rcopy.type, pending_metadata, location_for_error_messages);
194   if (contains_key(Container_metadata, rcopy.type))
195     r.metadata = get(Container_metadata, rcopy.type);
196 }
197 
198 void compute_container_sizes(const type_tree* type, set<type_tree>& pending_metadata, const string& location_for_error_messages) {
199   if (!type) return;
200   trace(9993, "transform") << "compute container sizes for " << to_string(type) << end();
201   if (contains_key(Container_metadata, type)) return;
202   if (contains_key(pending_metadata, *type)) return;
203   pending_metadata.insert(*type);
204   if (!type->atom) {
205     if (!type->left->atom) {
206       raise << "invalid type " << to_string(type) << location_for_error_messages << '\n' << end();
207       return;
208     }
209     if (type->left->name == "address")
210       compute_container_sizes(payload_type(type), pending_metadata, location_for_error_messages);
211     // End compute_container_sizes Non-atom Special-cases
212     return;
213   }
214   assert(type->atom);
215   if (!contains_key(Type, type->value)) return;  // error raised elsewhere
216   type_info& info = get(Type, type->value);
217   if (info.kind == CONTAINER)
218     compute_container_sizes(info, type, pending_metadata, location_for_error_messages);
219   // End compute_container_sizes Atom Special-cases
220 }
221 
222 void compute_container_sizes(const type_info& container_info, const type_tree* full_type, set<type_tree>& pending_metadata, const string& location_for_error_messages) {
223   assert(container_info.kind == CONTAINER);
224   // size of a container is the sum of the sizes of its element
225   // (So it can only contain arrays if they're static and include their
226   // length in the type.)
227   container_metadata metadata;
228   for (int i = 0;  i < SIZE(container_info.elements);  ++i) {
229     reagent/*copy*/ element = container_info.elements.at(i);
230     // Compute Container Size(element, full_type)
231     compute_container_sizes(element.type, pending_metadata, location_for_error_messages);
232     metadata.offset.push_back(metadata.size);  // save previous size as offset
233     metadata.size += size_of(element.type);
234   }
235   Container_metadata.push_back(pair<type_tree*, container_metadata>(new type_tree(*full_type), metadata));
236 }
237 
238 const type_tree* payload_type(const type_tree* type) {
239   assert(!type->atom);
240   const type_tree* result = type->right;
241   assert(!result->atom);
242   if (!result->right) return result->left;
243   return result;
244 }
245 
246 container_metadata& get(vector<pair<type_tree*, container_metadata> >& all, const type_tree* key) {
247   for (int i = 0;  i < SIZE(all);  ++i) {
248     if (matches(all.at(i).first, key))
249       return all.at(i).second;
250   }
251   tb_shutdown();
252   raise << "unknown size for type '" << to_string(key) << "'\n" << end();
253   assert(false);
254 }
255 
256 bool contains_key(const vector<pair<type_tree*, container_metadata> >& all, const type_tree* key) {
257   for (int i = 0;  i < SIZE(all);  ++i) {
258     if (matches(all.at(i).first, key))
259       return true;
260   }
261   return false;
262 }
263 
264 bool matches(const type_tree* a, const type_tree* b) {
265   if (a == b) return true;
266   if (!a || !b) return false;
267   if (a->atom != b->atom) return false;
268   if (a->atom) return a->value == b->value;
269   return matches(a->left, b->left) && matches(a->right, b->right);
270 }
271 
272 :(scenario stash_container)
273 def main [
274   1:num <- copy 34  # first
275   2:num <- copy 35
276   3:num <- copy 36
277   stash [foo:], 1:point-number/raw
278 ]
279 +app: foo: 34 35 36
280 
281 //: for the following unit tests we'll do the work of the transform by hand
282 
283 :(before "End Unit Tests")
284 void test_container_sizes() {
285   // a container we don't have the size for
286   reagent r("x:point");
287   CHECK(!contains_key(Container_metadata, r.type));
288   // scan
289   compute_container_sizes(r, "");
290   // the reagent we scanned knows its size
291   CHECK_EQ(r.metadata.size, 2);
292   // the global table also knows its size
293   CHECK(contains_key(Container_metadata, r.type));
294   CHECK_EQ(get(Container_metadata, r.type).size, 2);
295 }
296 
297 void test_container_sizes_through_aliases() {
298   // a new alias for a container
299   put(Type_abbreviations, "pt", new_type_tree("point"));
300   reagent r("x:pt");
301   // scan
302   compute_container_sizes(r, "");
303   // the reagent we scanned knows its size
304   CHECK_EQ(r.metadata.size, 2);
305   // the global table also knows its size
306   CHECK(contains_key(Container_metadata, r.type));
307   CHECK_EQ(get(Container_metadata, r.type).size, 2);
308 }
309 
310 void test_container_sizes_nested() {
311   // a container we don't have the size for
312   reagent r("x:point-number");
313   CHECK(!contains_key(Container_metadata, r.type));
314   // scan
315   compute_container_sizes(r, "");
316   // the reagent we scanned knows its size
317   CHECK_EQ(r.metadata.size, 3);
318   // the global table also knows its size
319   CHECK(contains_key(Container_metadata, r.type));
320   CHECK_EQ(get(Container_metadata, r.type).size, 3);
321 }
322 
323 void test_container_sizes_recursive() {
324   // define a container containing an address to itself
325   run("container foo [\n"
326       "  x:num\n"
327       "  y:address:foo\n"
328       "]\n");
329   reagent r("x:foo");
330   compute_container_sizes(r, "");
331   CHECK_EQ(r.metadata.size, 2);
332 }
333 
334 void test_container_sizes_from_address() {
335   // a container we don't have the size for
336   reagent container("x:point");
337   CHECK(!contains_key(Container_metadata, container.type));
338   // scanning an address to the container precomputes the size of the container
339   reagent r("x:address:point");
340   compute_container_sizes(r, "");
341   CHECK(contains_key(Container_metadata, container.type));
342   CHECK_EQ(get(Container_metadata, container.type).size, 2);
343 }
344 
345 //:: To access elements of a container, use 'get'
346 //: 'get' takes a 'base' container and an 'offset' into it and returns the
347 //: appropriate element of the container value.
348 
349 :(scenario get)
350 def main [
351   12:num <- copy 34
352   13:num <- copy 35
353   15:num <- get 12:point/raw, 1:offset  # unsafe
354 ]
355 +mem: storing 35 in location 15
356 
357 :(before "End Primitive Recipe Declarations")
358 GET,
359 :(before "End Primitive Recipe Numbers")
360 put(Recipe_ordinal, "get", GET);
361 :(before "End Primitive Recipe Checks")
362 case GET: {
363   if (SIZE(inst.ingredients) != 2) {
364     raise << maybe(get(Recipe, r).name) << "'get' expects exactly 2 ingredients in '" << inst.original_string << "'\n" << end();
365     break;
366   }
367   reagent/*copy*/ base = inst.ingredients.at(0);  // new copy for every invocation
368   // Update GET base in Check
369   if (!base.type) {
370     raise << maybe(get(Recipe, r).name) << "first ingredient of 'get' should be a container, but got '" << inst.ingredients.at(0).original_string << "'\n" << end();
371     break;
372   }
373   const type_tree* base_type = base.type;
374   // Update GET base_type in Check
375   if (!base_type->atom || base_type->value == 0 || !contains_key(Type, base_type->value) || get(Type, base_type->value).kind != CONTAINER) {
376     raise << maybe(get(Recipe, r).name) << "first ingredient of 'get' should be a container, but got '" << inst.ingredients.at(0).original_string << "'\n" << end();
377     break;
378   }
379   const reagent& offset = inst.ingredients.at(1);
380   if (!is_literal(offset) || !is_mu_scalar(offset)) {
381     raise << maybe(get(Recipe, r).name) << "second ingredient of 'get' should have type 'offset', but got '" << inst.ingredients.at(1).original_string << "'\n" << end();
382     break;
383   }
384   int offset_value = 0;
385   //: later layers will permit non-integer offsets
386   if (is_integer(offset.name))
387     offset_value = to_integer(offset.name);
388   else
389     offset_value = offset.value;
390   if (offset_value < 0 || offset_value >= SIZE(get(Type, base_type->value).elements)) {
391     raise << maybe(get(Recipe, r).name) << "invalid offset '" << offset_value << "' for '" << get(Type, base_type->value).name << "'\n" << end();
392     break;
393   }
394   if (inst.products.empty()) break;
395   reagent/*copy*/ product = inst.products.at(0);
396   // Update GET product in Check
397   //: use base.type rather than base_type because later layers will introduce compound types
398   const reagent/*copy*/ element = element_type(base.type, offset_value);
399   if (!types_coercible(product, element)) {
400     raise << maybe(get(Recipe, r).name) << "'get " << base.original_string << ", " << offset.original_string << "' should write to " << names_to_string_without_quotes(element.type) << " but '" << product.name << "' has type " << names_to_string_without_quotes(product.type) << '\n' << end();
401     break;
402   }
403   break;
404 }
405 :(before "End Primitive Recipe Implementations")
406 case GET: {
407   reagent/*copy*/ base = current_instruction().ingredients.at(0);
408   // Update GET base in Run
409   int base_address = base.value;
410   if (base_address == 0) {
411     raise << maybe(current_recipe_name()) << "tried to access location 0 in '" << to_original_string(current_instruction()) << "'\n" << end();
412     break;
413   }
414   const type_tree* base_type = base.type;
415   // Update GET base_type in Run
416   int offset = ingredients.at(1).at(0);
417   if (offset < 0 || offset >= SIZE(get(Type, base_type->value).elements)) break;  // copied from Check above
418   assert(base.metadata.size);
419   int src = base_address + base.metadata.offset.at(offset);
420   trace(9998, "run") << "address to copy is " << src << end();
421   //: use base.type rather than base_type because later layers will introduce compound types
422   reagent/*copy*/ element = element_type(base.type, offset);
423   element.set_value(src);
424   trace(9998, "run") << "its type is " << names_to_string(element.type) << end();
425   // Read element
426   products.push_back(read_memory(element));
427   break;
428 }
429 
430 :(code)
431 const reagent element_type(const type_tree* type, int offset_value) {
432   assert(offset_value >= 0);
433   const type_tree* base_type = type;
434   // Update base_type in element_type
435   assert(contains_key(Type, base_type->value));
436   assert(!get(Type, base_type->value).name.empty());
437   const type_info& info = get(Type, base_type->value);
438   assert(info.kind == CONTAINER);
439   if (offset_value >= SIZE(info.elements)) return reagent();  // error handled elsewhere
440   reagent/*copy*/ element = info.elements.at(offset_value);
441   // End element_type Special-cases
442   return element;
443 }
444 
445 :(scenario get_handles_nested_container_elements)
446 def main [
447   12:num <- copy 34
448   13:num <- copy 35
449   14:num <- copy 36
450   15:num <- get 12:point-number/raw, 1:offset  # unsafe
451 ]
452 +mem: storing 36 in location 15
453 
454 :(scenario get_out_of_bounds)
455 % Hide_errors = true;
456 def main [
457   12:num <- copy 34
458   13:num <- copy 35
459   14:num <- copy 36
460   get 12:point-number/raw, 2:offset  # point-number occupies 3 locations but has only 2 fields; out of bounds
461 ]
462 +error: main: invalid offset '2' for 'point-number'
463 
464 :(scenario get_out_of_bounds_2)
465 % Hide_errors = true;
466 def main [
467   12:num <- copy 34
468   13:num <- copy 35
469   14:num <- copy 36
470   get 12:point-number/raw, -1:offset
471 ]
472 +error: main: invalid offset '-1' for 'point-number'
473 
474 :(scenario get_product_type_mismatch)
475 % Hide_errors = true;
476 def main [
477   12:num <- copy 34
478   13:num <- copy 35
479   14:num <- copy 36
480   15:address:num <- get 12:point-number/raw, 1:offset
481 ]
482 +error: main: 'get 12:point-number/raw, 1:offset' should write to number but '15' has type (address number)
483 
484 //: we might want to call 'get' without saving the results, say in a sandbox
485 
486 :(scenario get_without_product)
487 def main [
488   12:num <- copy 34
489   13:num <- copy 35
490   get 12:point/raw, 1:offset  # unsafe
491 ]
492 # just don't die
493 
494 //:: To write to elements of containers, use 'put'.
495 
496 :(scenario put)
497 def main [
498   12:num <- copy 34
499   13:num <- copy 35
500   $clear-trace
501   12:point <- put 12:point, 1:offset, 36
502 ]
503 +mem: storing 36 in location 13
504 -mem: storing 34 in location 12
505 
506 :(before "End Primitive Recipe Declarations")
507 PUT,
508 :(before "End Primitive Recipe Numbers")
509 put(Recipe_ordinal, "put", PUT);
510 :(before "End Primitive Recipe Checks")
511 case PUT: {
512   if (SIZE(inst.ingredients) != 3) {
513     raise << maybe(get(Recipe, r).name) << "'put' expects exactly 3 ingredients in '" << inst.original_string << "'\n" << end();
514     break;
515   }
516   reagent/*copy*/ base = inst.ingredients.at(0);
517   // Update PUT base in Check
518   if (!base.type) {
519     raise << maybe(get(Recipe, r).name) << "first ingredient of 'put' should be a container, but got '" << inst.ingredients.at(0).original_string << "'\n" << end();
520     break;
521   }
522   const type_tree* base_type = base.type;
523   // Update PUT base_type in Check
524   if (!base_type->atom || base_type->value == 0 || !contains_key(Type, base_type->value) || get(Type, base_type->value).kind != CONTAINER) {
525     raise << maybe(get(Recipe, r).name) << "first ingredient of 'put' should be a container, but got '" << inst.ingredients.at(0).original_string << "'\n" << end();
526     break;
527   }
528   reagent/*copy*/ offset = inst.ingredients.at(1);
529   // Update PUT offset in Check
530   if (!is_literal(offset) || !is_mu_scalar(offset)) {
531     raise << maybe(get(Recipe, r).name) << "second ingredient of 'put' should have type 'offset', but got '" << inst.ingredients.at(1).original_string << "'\n" << end();
532     break;
533   }
534   int offset_value = 0;
535   //: later layers will permit non-integer offsets
536   if (is_integer(offset.name)) {
537     offset_value = to_integer(offset.name);
538     if (offset_value < 0 || offset_value >= SIZE(get(Type, base_type->value).elements)) {
539       raise << maybe(get(Recipe, r).name) << "invalid offset '" << offset_value << "' for '" << get(Type, base_type->value).name << "'\n" << end();
540       break;
541     }
542   }
543   else {
544     offset_value = offset.value;
545   }
546   const reagent& value = inst.ingredients.at(2);
547   //: use base.type rather than base_type because later layers will introduce compound types
548   const reagent& element = element_type(base.type, offset_value);
549   if (!types_coercible(element, value)) {
550     raise << maybe(get(Recipe, r).name) << "'put " << base.original_string << ", " << offset.original_string << "' should write to " << names_to_string_without_quotes(element.type) << " but '" << value.name << "' has type " << names_to_string_without_quotes(value.type) << '\n' << end();
551     break;
552   }
553   if (inst.products.empty()) break;  // no more checks necessary
554   if (inst.products.at(0).name != inst.ingredients.at(0).name) {
555     raise << maybe(get(Recipe, r).name) << "product of 'put' must be first ingredient '" << inst.ingredients.at(0).original_string << "', but got '" << inst.products.at(0).original_string << "'\n" << end();
556     break;
557   }
558   // End PUT Product Checks
559   break;
560 }
561 :(before "End Primitive Recipe Implementations")
562 case PUT: {
563   reagent/*copy*/ base = current_instruction().ingredients.at(0);
564   // Update PUT base in Run
565   int base_address = base.value;
566   if (base_address == 0) {
567     raise << maybe(current_recipe_name()) << "tried to access location 0 in '" << to_original_string(current_instruction()) << "'\n" << end();
568     break;
569   }
570   const type_tree* base_type = base.type;
571   // Update PUT base_type in Run
572   int offset = ingredients.at(1).at(0);
573   if (offset < 0 || offset >= SIZE(get(Type, base_type->value).elements)) break;  // copied from Check above
574   int address = base_address + base.metadata.offset.at(offset);
575   trace(9998, "run") << "address to copy to is " << address << end();
576   // optimization: directly write the element rather than updating 'product'
577   // and writing the entire container
578   // Write Memory in PUT in Run
579   for (int i = 0;  i < SIZE(ingredients.at(2));  ++i) {
580     trace(9999, "mem") << "storing " << no_scientific(ingredients.at(2).at(i)) << " in location " << address+i << end();
581     put(Memory, address+i, ingredients.at(2).at(i));
582   }
583   goto finish_instruction;
584 }
585 
586 :(scenario put_product_error)
587 % Hide_errors = true;
588 def main [
589   local-scope
590   load-ingredients
591   1:point <- merge 34, 35
592   3:point <- put 1:point, x:offset, 36
593 ]
594 +error: main: product of 'put' must be first ingredient '1:point', but got '3:point'
595 
596 //:: Allow containers to be defined in Mu code.
597 
598 :(scenarios load)
599 :(scenario container)
600 container foo [
601   x:num
602   y:num
603 ]
604 +parse: --- defining container foo
605 +parse: element: {x: "number"}
606 +parse: element: {y: "number"}
607 
608 :(scenario container_use_before_definition)
609 container foo [
610   x:num
611   y:bar
612 ]
613 container bar [
614   x:num
615   y:num
616 ]
617 +parse: --- defining container foo
618 +parse: type number: 1000
619 +parse:   element: {x: "number"}
620 # todo: brittle
621 # type bar is unknown at this point, but we assign it a number
622 +parse:   element: {y: "bar"}
623 # later type bar geon
624 +parse: --- defining container bar
625 +parse: type number: 1001
626 +parse:   element: {x: "number"}
627 +parse:   element: {y: "number"}
628 
629 //: if a container is defined again, the new fields add to the original definition
630 :(scenarios run)
631 :(scenario container_extend)
632 container foo [
633   x:num
634 ]
635 # add to previous definition
636 container foo [
637   y:num
638 ]
639 def main [
640   1:num <- copy 34
641   2:num <- copy 35
642   3:num <- get 1:foo, 0:offset
643   4:num <- get 1:foo, 1:offset
644 ]
645 +mem: storing 34 in location 3
646 +mem: storing 35 in location 4
647 
648 :(before "End Command Handlers")
649 else if (command == "container") {
650   insert_container(command, CONTAINER, in);
651 }
652 
653 //: Even though we allow containers to be extended, we don't allow this after
654 //: a call to transform_all. But we do want to detect this situation and raise
655 //: an error. This field will help us raise such errors.
656 :(before "End type_info Fields")
657 int Num_calls_to_transform_all_at_first_definition;
658 :(before "End type_info Constructor")
659 Num_calls_to_transform_all_at_first_definition = -1;
660 
661 :(code)
662 void insert_container(const string& command, kind_of_type kind, istream& in) {
663   skip_whitespace_but_not_newline(in);
664   string name = next_word(in);
665   if (name.empty()) {
666     assert(!has_data(in));
667     raise << "incomplete container definition at end of file (0)\n" << end();
668     return;
669   }
670   // End container Name Refinements
671   trace(9991, "parse") << "--- defining " << command << ' ' << name << end();
672   if (!contains_key(Type_ordinal, name)
673       || get(Type_ordinal, name) == 0) {
674     put(Type_ordinal, name, Next_type_ordinal++);
675   }
676   trace(9999, "parse") << "type number: " << get(Type_ordinal, name) << end();
677   skip_bracket(in, "'"+command+"' must begin with '['");
678   type_info& info = get_or_insert(Type, get(Type_ordinal, name));
679   if (info.Num_calls_to_transform_all_at_first_definition == -1) {
680     // initial definition of this container
681     info.Num_calls_to_transform_all_at_first_definition = Num_calls_to_transform_all;
682   }
683   else if (info.Num_calls_to_transform_all_at_first_definition != Num_calls_to_transform_all) {
684     // extension after transform_all
685     raise << "there was a call to transform_all() between the definition of container '" << name << "' and a subsequent extension. This is not supported, since any recipes that used '" << name << "' values have already been transformed and \"frozen\".\n" << end();
686     return;
687   }
688   info.name = name;
689   info.kind = kind;
690   while (has_data(in)) {
691     skip_whitespace_and_comments(in);
692     string element = next_word(in);
693     if (element.empty()) {
694       assert(!has_data(in));
695       raise << "incomplete container definition at end of file (1)\n" << end();
696       return;
697     }
698     if (element == "]") break;
699     if (in.peek() != '\n') {
700       raise << command << " '" << name << "' contains multiple elements on a single line. Containers and exclusive containers must only contain elements, one to a line, no code.\n" << end();
701       // skip rest of container declaration
702       while (has_data(in)) {
703         skip_whitespace_and_comments(in);
704         if (next_word(in) == "]") break;
705       }
706       break;
707     }
708     info.elements.push_back(reagent(element));
709     expand_type_abbreviations(info.elements.back().type);  // todo: use abbreviation before declaration
710     replace_unknown_types_with_unique_ordinals(info.elements.back().type, info);
711     trace(9993, "parse") << "  element: " << to_string(info.elements.back()) << end();
712     // End Load Container Element Definition
713   }
714 }
715 
716 void replace_unknown_types_with_unique_ordinals(type_tree* type, const type_info& info) {
717   if (!type) return;
718   if (!type->atom) {
719     replace_unknown_types_with_unique_ordinals(type->left, info);
720     replace_unknown_types_with_unique_ordinals(type->right, info);
721     return;
722   }
723   assert(!type->name.empty());
724   if (contains_key(Type_ordinal, type->name)) {
725     type->value = get(Type_ordinal, type->name);
726   }
727   // End insert_container Special-cases
728   else if (type->name != "->") {  // used in recipe types
729     put(Type_ordinal, type->name, Next_type_ordinal++);
730     type->value = get(Type_ordinal, type->name);
731   }
732 }
733 
734 void skip_bracket(istream& in, string message) {
735   skip_whitespace_and_comments(in);
736   if (in.get() != '[')
737     raise << message << '\n' << end();
738 }
739 
740 :(scenario multi_word_line_in_container_declaration)
741 % Hide_errors = true;
742 container foo [
743   x:num y:num
744 ]
745 +error: container 'foo' contains multiple elements on a single line. Containers and exclusive containers must only contain elements, one to a line, no code.
746 
747 //: support type abbreviations in container definitions
748 
749 :(scenario type_abbreviations_in_containers)
750 type foo = number
751 container bar [
752   x:foo
753 ]
754 def main [
755   1:num <- copy 34
756   2:foo <- get 1:bar/unsafe, 0:offset
757 ]
758 +mem: storing 34 in location 2
759 
760 :(after "Transform.push_back(expand_type_abbreviations)")
761 Transform.push_back(expand_type_abbreviations_in_containers);  // idempotent
762 :(code)
763 // extremely inefficient; we process all types over and over again, once for every single recipe
764 // but it doesn't seem to cause any noticeable slowdown
765 void expand_type_abbreviations_in_containers(unused const recipe_ordinal r) {
766   for (map<type_ordinal, type_info>::iterator p = Type.begin();  p != Type.end();  ++p) {
767     for (int i = 0;  i < SIZE(p->second.elements);  ++i)
768       expand_type_abbreviations(p->second.elements.at(i).type);
769   }
770 }
771 
772 //: ensure scenarios are consistent by always starting new container
773 //: declarations at the same type number
774 :(before "End Setup")  //: for tests
775 Next_type_ordinal = 1000;
776 :(before "End Test Run Initialization")
777 assert(Next_type_ordinal < 1000);
778 
779 :(code)
780 void test_error_on_transform_all_between_container_definition_and_extension() {
781   // define a container
782   run("container foo [\n"
783       "  a:num\n"
784       "]\n");
785   // try to extend the container after transform
786   transform_all();
787   CHECK_TRACE_DOESNT_CONTAIN_ERRORS();
788   Hide_errors = true;
789   run("container foo [\n"
790       "  b:num\n"
791       "]\n");
792   CHECK_TRACE_CONTAINS_ERRORS();
793 }
794 
795 //:: Allow container definitions anywhere in the codebase, but complain if you
796 //:: can't find a definition at the end.
797 
798 :(scenario run_complains_on_unknown_types)
799 % Hide_errors = true;
800 def main [
801   # integer is not a type
802   1:integer <- copy 0
803 ]
804 +error: main: unknown type integer in '1:integer <- copy 0'
805 
806 :(scenario run_allows_type_definition_after_use)
807 def main [
808   1:bar <- copy 0/unsafe
809 ]
810 container bar [
811   x:num
812 ]
813 $error: 0
814 
815 :(before "End Type Modifying Transforms")
816 Transform.push_back(check_or_set_invalid_types);  // idempotent
817 
818 :(code)
819 void check_or_set_invalid_types(const recipe_ordinal r) {
820   recipe& caller = get(Recipe, r);
821   trace(9991, "transform") << "--- check for invalid types in recipe " << caller.name << end();
822   for (int index = 0;  index < SIZE(caller.steps);  ++index) {
823     instruction& inst = caller.steps.at(index);
824     for (int i = 0;  i < SIZE(inst.ingredients);  ++i)
825       check_or_set_invalid_types(inst.ingredients.at(i), caller, inst);
826     for (int i = 0;  i < SIZE(inst.products);  ++i)
827       check_or_set_invalid_types(inst.products.at(i), caller, inst);
828   }
829   // End check_or_set_invalid_types
830 }
831 
832 void check_or_set_invalid_types(reagent& r, const recipe& caller, const instruction& inst) {
833   // Begin check_or_set_invalid_types(r)
834   check_or_set_invalid_types(r.type, maybe(caller.name), "'"+inst.original_string+"'");
835 }
836 
837 void check_or_set_invalid_types(type_tree* type, const string& location_for_error_messages, const string& name_for_error_messages) {
838   if (!type) return;
839   // End Container Type Checks
840   if (!type->atom) {
841     check_or_set_invalid_types(type->left, location_for_error_messages, name_for_error_messages);
842     check_or_set_invalid_types(type->right, location_for_error_messages, name_for_error_messages);
843     return;
844   }
845   if (type->value == 0) return;
846   if (!contains_key(Type, type->value)) {
847     assert(!type->name.empty());
848     if (contains_key(Type_ordinal, type->name))
849       type->value = get(Type_ordinal, type->name);
850     else
851       raise << location_for_error_messages << "unknown type " << type->name << " in " << name_for_error_messages << '\n' << end();
852   }
853 }
854 
855 :(scenario container_unknown_field)
856 % Hide_errors = true;
857 container foo [
858   x:num
859   y:bar
860 ]
861 +error: foo: unknown type in y
862 
863 :(scenario read_container_with_bracket_in_comment)
864 container foo [
865   x:num
866   # ']' in comment
867   y:num
868 ]
869 +parse: --- defining container foo
870 +parse: element: {x: "number"}
871 +parse: element: {y: "number"}
872 
873 :(scenario container_with_compound_field_type)
874 container foo [
875   {x: (address array (address array character))}
876 ]
877 $error: 0
878 
879 :(before "End transform_all")
880 check_container_field_types();
881 
882 :(code)
883 void check_container_field_types() {
884   for (map<type_ordinal, type_info>::iterator p = Type.begin();  p != Type.end();  ++p) {
885     const type_info& info = p->second;
886     // Check Container Field Types(info)
887     for (int i = 0;  i < SIZE(info.elements);  ++i)
888       check_invalid_types(info.elements.at(i).type, maybe(info.name), info.elements.at(i).name);
889   }
890 }
891 
892 void check_invalid_types(const type_tree* type, const string& location_for_error_messages, const string& name_for_error_messages) {
893   if (!type) return;  // will throw a more precise error elsewhere
894   if (!type->atom) {
895     check_invalid_types(type->left, location_for_error_messages, name_for_error_messages);
896     check_invalid_types(type->right, location_for_error_messages, name_for_error_messages);
897     return;
898   }
899   if (type->value != 0) {  // value 0 = compound types (layer parse_tree) or type ingredients (layer shape_shifting_container)
900     if (!contains_key(Type, type->value))
901       raise << location_for_error_messages << "unknown type in " << name_for_error_messages << '\n' << end();
902   }
903 }