about summary refs log tree commit diff stats
path: root/README
blob: 2dcaeddfdc0e18dc8971c71a5c56a9a2e4993e66 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
dwm - dynamic window manager
============================
dwm is an extremely fast, small, and dynamic window manager for X.


Requirements
------------
In order to build dwm you need the Xlib header files.


Installation
------------
Edit config.mk to match your local setup (dwm is installed into
the /usr/local namespace by default).

Afterwards enter the following command to build and install dwm (if
necessary as root):

    make clean install

If you are going to use the default bluegray color scheme it is highly
recommended to also install the bluegray files shipped in the dextra package.


Running dwm
-----------
Add the following line to your .xinitrc to start dwm using startx:

    exec dwm

In order to connect dwm to a specific display, make sure that
the DISPLAY environment variable is set correctly, e.g.:

    DISPLAY=foo.bar:1 exec dwm

(This will start dwm on display :1 of the host foo.bar.)

In order to display status info in the bar, you can do something
like this in your .xinitrc:

    while true
    do
        echo `date` `uptime | sed 's/.*,//'`
        sleep 1
    done | dwm


Configuration
-------------
The configuration of dwm is done by creating a custom config.h
and (re)compiling the source code.
00 3309' href='/akkartik/mu/commit/055shape_shifting_container.cc?h=hlt&id=af023b323bb6fdb09851cb673401fca2abe983b6'>af023b32 ^
4a943d4e ^









4ecab182 ^
3f34ac93 ^

4a943d4e ^






































































































6b2f2ed3 ^
5f05e954 ^
e3cb4d09 ^
42eeea1d ^



5f05e954 ^
d3902ff0 ^
e3cb4d09 ^




17b90929 ^
436b2b2e ^



e3cb4d09 ^

c442a5ad ^
b1ddb414 ^




e3cb4d09 ^


b1ddb414 ^
e3cb4d09 ^


b1ddb414 ^
6b2f2ed3 ^
b1ddb414 ^



c78bc9bd ^
b1ddb414 ^
c78bc9bd ^
b1ddb414 ^





f3760b0f ^
795f5244 ^
12f304a3 ^
b1ddb414 ^



6b2f2ed3 ^
b24eb476 ^
08cf048f ^
e3cb4d09 ^
6b2f2ed3 ^



555d95c1 ^
6b2f2ed3 ^


b1ddb414 ^
6b2f2ed3 ^
b1ddb414 ^
e3cb4d09 ^
b1ddb414 ^






6c96a437 ^
b1ddb414 ^

e3cb4d09 ^
b1ddb414 ^
e3cb4d09 ^

715806ca ^
e3cb4d09 ^
968866f7 ^
c4e143d6 ^



555d95c1 ^
e3cb4d09 ^



795f5244 ^
e3cb4d09 ^

4a943d4e ^




























3965ca03 ^
4769dd2e ^
29476997 ^

4769dd2e ^
4a943d4e ^
























































































452086e3 ^
a09697d0 ^
571791ba ^
3f34ac93 ^


































a09697d0 ^
4a943d4e ^

















a09697d0 ^





af023b32 ^
a09697d0 ^


4769dd2e ^



29476997 ^
4769dd2e ^


4f3d9065 ^
29476997 ^
5d4a1d3b ^
a09697d0 ^
af023b32 ^
93d4cc93 ^







29476997 ^

af023b32 ^

93d4cc93 ^






















d59554f5 ^
29476997 ^
d59554f5 ^

af023b32 ^

d59554f5 ^
af023b32 ^
dc80c7b9 ^
af023b32 ^
6c96a437 ^
af023b32 ^



d59554f5 ^
af023b32 ^




cd85ca3c ^

dc80c7b9 ^
cd85ca3c ^



a09697d0 ^
cd85ca3c ^
a09697d0 ^

4ea9905f ^
fbc3455b ^
07ca5691 ^

7a84094a ^
07ca5691 ^

471839da ^
84c9e3cf ^
07ca5691 ^

fbc3455b ^
07ca5691 ^






471839da ^
84c9e3cf ^
07ca5691 ^

fbc3455b ^
07ca5691 ^





b0bf5321 ^
471839da ^
84c9e3cf ^
07ca5691 ^

fbc3455b ^
07ca5691 ^



7a84094a ^
07ca5691 ^

471839da ^
84c9e3cf ^
07ca5691 ^






b0bf5321 ^
471839da ^
84c9e3cf ^
471839da ^
84c9e3cf ^
07ca5691 ^

93d4cc93 ^








07ca5691 ^





b0bf5321 ^
471839da ^
84c9e3cf ^
471839da ^
84c9e3cf ^
471839da ^
84c9e3cf ^
07ca5691 ^

4f3d9065 ^




b0bf5321 ^
471839da ^
84c9e3cf ^
4f3d9065 ^



a0331a9b ^
4f3d9065 ^





b0bf5321 ^
471839da ^
84c9e3cf ^
4f3d9065 ^

4ea9905f ^
b24eb476 ^
5d4a1d3b ^
3c163ef7 ^
5d4a1d3b ^



4a943d4e ^









































c4cff3b3 ^
af023b32 ^
5ba1c3b9 ^
4a943d4e ^



































































































1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
                                                         
 

                                                                        
                                        
                                     
                                      
                                     
                                        
                                     
                                      
                                     
                                                  
                                     

                                           








                                                                 
 









                                      
 

                                                     






































































































                                                                               
 
                       
                                                                              



                                                                              
                                               
                                                               




                                                   
                                                              



                                                  

                                          
                                                                            




                                                                


       
                                                                 


                              
                                                  
                                                                 



                                                       
                                                                        
                                                                          
                                                                                              





                                                                                                              
                                                                        
                                                 
                                                                 



                                                         
                                                                                                        
                                                 
                        
                                       



                                                                                     
                                  


                                                                                                               
                                      
                                                                                                                                   
                   
     






                                                                                                     
                                                                                      

                                                    
   
              

 
                                              
                                    
                                               



                                                            
                                



                                         
                                                                                                   

         




























                                                                                                                  
 
                                          

                                                                                                                    
 
























































































                                                                               
 
                                          
                                                                                            


































                                                                                        
       

















                                                                     





                                                      
                                                               


                                                                                       



                                                                                                                                                                    
                                                                                                  


   
                                                                                            
                                                                                                                                                                    
                                                                          
                            
                            







                                                                                                                                        

                                                                                                              

           






















                                                                                                                                                                                                       
                                                            
                                                                                                                                                                    

           

                                                                                             
 
                                                                                                                                  
                                                                               
                                        
                                                     



                                                                                   
   




                                      

 
                                                                                           



                                                                                                  
   
              

 
                          
                                             

                               
                 

                                  
                                                   
                                                 

 
                                           






                                  
                                                   
                                                           

 
                                                         





                               
                                                    
                                                   
                                                                                     

 
                                                  



                               
                           

                                    
                                                   
                                                                        






                                                        
                                                                  
                                                    
                                                   
                                                    
                                                                              

 








                                                                                                   





                                                          
                                                                          
                                                    
                                                   
                                                    
                                                                              
                                                    
                                                    

 




                                                           
                                                                  
                                                   
                                                                               



                                                           
                                              





                                               
                                                                        
                                                   
                                                                                                                                     

 
       
                                                 
                 
                          



                                        









































                                                                                                                              
 
                                         
 



































































































                                                                                   
//:: Container definitions can contain 'type ingredients'

//: pre-requisite: extend our notion of containers to not necessarily be
//: atomic types
:(after "Update GET base_type in Check")
base_type = get_base_type(base_type);
:(after "Update GET base_type in Run")
base_type = get_base_type(base_type);
:(after "Update PUT base_type in Check")
base_type = get_base_type(base_type);
:(after "Update PUT base_type in Run")
base_type = get_base_type(base_type);
:(after "Update MAYBE_CONVERT base_type in Check")
base_type = get_base_type(base_type);
:(after "Update base_type in element_type")
base_type = get_base_type(base_type);
:(after "Update base_type in skip_addresses")
base_type = get_base_type(base_type);
:(replace{} "const type_tree* get_base_type(const type_tree* t)")
const type_tree* get_base_type(const type_tree* t) {
  const type_tree* result = t->atom ? t : t->left;
  if (!result->atom)
    raise << "invalid type " << to_string(t) << '\n' << end();
  return result;
}

:(code)
void test_ill_formed_container() {
  Hide_errors = true;
  run(
      "def main [\n"
      "  {1: ((foo) num)} <- copy 0\n"
      "]\n"
  );
  // no crash
}

//: update size_of to handle non-atom container types

void test_size_of_shape_shifting_container() {
  run(
      "container foo:_t [\n"
      "  x:_t\n"
      "  y:num\n"
      "]\n"
      "def main [\n"
      "  1:foo:num <- merge 12, 13\n"
      "  3:foo:point <- merge 14, 15, 16\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "mem: storing 12 in location 1\n"
      "mem: storing 13 in location 2\n"
      "mem: storing 14 in location 3\n"
      "mem: storing 15 in location 4\n"
      "mem: storing 16 in location 5\n"
  );
}
void test_size_of_shape_shifting_container_2() {
  run(
      // multiple type ingredients
      "container foo:_a:_b [\n"
      "  x:_a\n"
      "  y:_b\n"
      "]\n"
      "def main [\n"
      "  1:foo:num:bool <- merge 34, true\n"
      "]\n"
  );
  CHECK_TRACE_COUNT("error", 0);
}
void test_size_of_shape_shifting_container_3() {
  run(
      "container foo:_a:_b [\n"
      "  x:_a\n"
      "  y:_b\n"
      "]\n"
      "def main [\n"
      "  1:text <- new [abc]\n"
         // compound types for type ingredients
      "  {3: (foo number (address array character))} <- merge 34/x, 1:text/y\n"
      "]\n"
  );
  CHECK_TRACE_COUNT("error", 0);
}

void test_size_of_shape_shifting_container_4() {
  run(
      "container foo:_a:_b [\n"
      "  x:_a\n"
      "  y:_b\n"
      "]\n"
      "container bar:_a:_b [\n"
         // dilated element
      "  {data: (foo _a (address _b))}\n"
      "]\n"
      "def main [\n"
      "  1:text <- new [abc]\n"
      "  3:bar:num:@:char <- merge 34/x, 1:text/y\n"
      "]\n"
  );
  CHECK_TRACE_COUNT("error", 0);
}

void test_shape_shifting_container_extend() {
  run(
      "container foo:_a [\n"
      "  x:_a\n"
      "]\n"
      "container foo:_a [\n"
      "  y:_a\n"
      "]\n"
  );
  CHECK_TRACE_COUNT("error", 0);
}

void test_shape_shifting_container_extend_error() {
  Hide_errors = true;
  run(
      "container foo:_a [\n"
      "  x:_a\n"
      "]\n"
      "container foo:_b [\n"
      "  y:_b\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "error: headers of container 'foo' must use identical type ingredients\n"
  );
}

void test_type_ingredient_must_start_with_underscore() {
  Hide_errors = true;
  run(
      "container foo:t [\n"
      "  x:num\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "error: foo: type ingredient 't' must begin with an underscore\n"
  );
}

:(before "End Globals")
// We'll use large type ordinals to mean "the following type of the variable".
// For example, if we have a generic type called foo:_elem, the type
// ingredient _elem in foo's type_info will have value START_TYPE_INGREDIENTS,
// and we'll handle it by looking in the current reagent for the next type
// that appears after foo.
extern const int START_TYPE_INGREDIENTS = 2000;
:(before "End Commandline Parsing")  // after loading .mu files
assert(Next_type_ordinal < START_TYPE_INGREDIENTS);

:(before "End type_info Fields")
map<string, type_ordinal> type_ingredient_names;

//: Suppress unknown type checks in shape-shifting containers.

:(before "Check Container Field Types(info)")
if (!info.type_ingredient_names.empty()) continue;

:(before "End container Name Refinements")
if (name.find(':') != string::npos) {
  trace(101, "parse") << "container has type ingredients; parsing" << end();
  if (!read_type_ingredients(name, command)) {
    // error; skip rest of the container definition and continue
    slurp_balanced_bracket(in);
    return;
  }
}

:(code)
bool read_type_ingredients(string& name, const string& command) {
  string save_name = name;
  istringstream in(save_name);
  name = slurp_until(in, ':');
  map<string, type_ordinal> type_ingredient_names;
  if (!slurp_type_ingredients(in, type_ingredient_names, name)) {
    return false;
  }
  if (contains_key(Type_ordinal, name)
      && contains_key(Type, get(Type_ordinal, name))) {
    const type_info& previous_info = get(Type, get(Type_ordinal, name));
    // we've already seen this container; make sure type ingredients match
    if (!type_ingredients_match(type_ingredient_names, previous_info.type_ingredient_names)) {
      raise << "headers of " << command << " '" << name << "' must use identical type ingredients\n" << end();
      return false;
    }
    return true;
  }
  // we haven't seen this container before
  if (!contains_key(Type_ordinal, name) || get(Type_ordinal, name) == 0)
    put(Type_ordinal, name, Next_type_ordinal++);
  type_info& info = get_or_insert(Type, get(Type_ordinal, name));
  info.type_ingredient_names.swap(type_ingredient_names);
  return true;
}

bool slurp_type_ingredients(istream& in, map<string, type_ordinal>& out, const string& container_name) {
  int next_type_ordinal = START_TYPE_INGREDIENTS;
  while (has_data(in)) {
    string curr = slurp_until(in, ':');
    if (curr.empty()) {
      raise << container_name << ": empty type ingredients not permitted\n" << end();
      return false;
    }
    if (!starts_with(curr, "_")) {
      raise << container_name << ": type ingredient '" << curr << "' must begin with an underscore\n" << end();
      return false;
    }
    if (out.find(curr) != out.end()) {
      raise << container_name << ": can't repeat type ingredient name'" << curr << "' in a single container definition\n" << end();
      return false;
    }
    put(out, curr, next_type_ordinal++);
  }
  return true;
}

bool type_ingredients_match(const map<string, type_ordinal>& a, const map<string, type_ordinal>& b) {
  if (SIZE(a) != SIZE(b)) return false;
  for (map<string, type_ordinal>::const_iterator p = a.begin();  p != a.end();  ++p) {
    if (!contains_key(b, p->first)) return false;
    if (p->second != get(b, p->first)) return false;
  }
  return true;
}

:(before "End insert_container Special-cases")
// check for use of type ingredients
else if (is_type_ingredient_name(type->name)) {
  type->value = get(info.type_ingredient_names, type->name);
}
:(code)
bool is_type_ingredient_name(const string& type) {
  return starts_with(type, "_");
}

:(before "End Container Type Checks")
if (type->value >= START_TYPE_INGREDIENTS
    && (type->value - START_TYPE_INGREDIENTS) < SIZE(get(Type, type->value).type_ingredient_names))
  return;

:(code)
void test_size_of_shape_shifting_exclusive_container() {
  run(
      "exclusive-container foo:_t [\n"
      "  x:_t\n"
      "  y:num\n"
      "]\n"
      "def main [\n"
      "  1:foo:num <- merge 0/x, 34\n"
      "  3:foo:point <- merge 0/x, 15, 16\n"
      "  6:foo:point <- merge 1/y, 23\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "run: {1: (\"foo\" \"number\")} <- merge {0: \"literal\", \"x\": ()}, {34: \"literal\"}\n"
      "mem: storing 0 in location 1\n"
      "mem: storing 34 in location 2\n"
      "run: {3: (\"foo\" \"point\")} <- merge {0: \"literal\", \"x\": ()}, {15: \"literal\"}, {16: \"literal\"}\n"
      "mem: storing 0 in location 3\n"
      "mem: storing 15 in location 4\n"
      "mem: storing 16 in location 5\n"
      "run: {6: (\"foo\" \"point\")} <- merge {1: \"literal\", \"y\": ()}, {23: \"literal\"}\n"
      "mem: storing 1 in location 6\n"
      "mem: storing 23 in location 7\n"
      "run: return\n"
  );
  // no other stores
  CHECK_EQ(trace_count_prefix("mem", "storing"), 7);
}

:(before "End variant_type Special-cases")
if (contains_type_ingredient(element))
  replace_type_ingredients(element.type, type->right, info, " while computing variant type of exclusive-container");

:(code)
void test_get_on_shape_shifting_container() {
  run(
      "container foo:_t [\n"
      "  x:_t\n"
      "  y:num\n"
      "]\n"
      "def main [\n"
      "  1:foo:point <- merge 14, 15, 16\n"
      "  4:num <- get 1:foo:point, y:offset\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "mem: storing 16 in location 4\n"
  );
}

void test_get_on_shape_shifting_container_2() {
  run(
      "container foo:_t [\n"
      "  x:_t\n"
      "  y:num\n"
      "]\n"
      "def main [\n"
      "  1:foo:point <- merge 14, 15, 16\n"
      "  4:point <- get 1:foo:point, x:offset\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "mem: storing 14 in location 4\n"
      "mem: storing 15 in location 5\n"
  );
}

void test_get_on_shape_shifting_container_3() {
  run(
      "container foo:_t [\n"
      "  x:_t\n"
      "  y:num\n"
      "]\n"
      "def main [\n"
      "  1:num/alloc-id, 2:num <- copy 0, 34\n"
      "  3:foo:&:point <- merge 1:&:point, 48\n"
      "  6:&:point <- get 1:foo:&:point, x:offset\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "mem: storing 0 in location 6\n"
      "mem: storing 34 in location 7\n"
  );
}

void test_get_on_shape_shifting_container_inside_container() {
  run(
      "container foo:_t [\n"
      "  x:_t\n"
      "  y:num\n"
      "]\n"
      "container bar [\n"
      "  x:foo:point\n"
      "  y:num\n"
      "]\n"
      "def main [\n"
      "  1:bar <- merge 14, 15, 16, 17\n"
      "  5:num <- get 1:bar, 1:offset\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "mem: storing 17 in location 5\n"
  );
}

void test_get_on_complex_shape_shifting_container() {
  run(
      "container foo:_a:_b [\n"
      "  x:_a\n"
      "  y:_b\n"
      "]\n"
      "def main [\n"
      "  1:text <- new [abc]\n"
      "  {3: (foo number (address array character))} <- merge 34/x, 1:text/y\n"
      "  6:text <- get {3: (foo number (address array character))}, y:offset\n"
      "  8:bool <- equal 1:text, 6:text\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "mem: storing 1 in location 8\n"
  );
}

:(before "End element_type Special-cases")
replace_type_ingredients(element, type, info, " while computing element type of container");

:(before "End size_of(type) Non-atom Special-cases")
assert(type->left->atom);
if (!contains_key(Type, type->left->value)) {
  raise << "no such type " << type->left->value << '\n' << end();
  return 0;
}
type_info t = get(Type, type->left->value);
if (t.kind == CONTAINER) {
  // size of a container is the sum of the sizes of its elements
  int result = 0;
  for (int i = 0; i < SIZE(t.elements); ++i) {
    // todo: strengthen assertion to disallow mutual type recursion
    if (get_base_type(t.elements.at(i).type)->value == get_base_type(type)->value) {
      raise << "container " << t.name << " can't include itself as a member\n" << end();
      return 0;
    }
    result += size_of(element_type(type, i));
  }
  return result;
}
if (t.kind == EXCLUSIVE_CONTAINER) {
  // size of an exclusive container is the size of its largest variant
  // (So like containers, it can't contain arrays.)
  int result = 0;
  for (int i = 0; i < SIZE(t.elements); ++i) {
    reagent tmp;
    tmp.type = new type_tree(*type);
    int size = size_of(variant_type(tmp, i));
    if (size > result) result = size;
  }
  // ...+1 for its tag.
  return result+1;
}

:(code)
void test_complex_shape_shifting_exclusive_container() {
  run(
      "exclusive-container foo:_a [\n"
      "  x:_a\n"
      "  y:num\n"
      "]\n"
      "def main [\n"
      "  1:text <- new [abc]\n"
      "  3:foo:point <- merge 0/variant, 34/xx, 35/xy\n"
      "  10:point, 20:bool <- maybe-convert 3:foo:point, 0/variant\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "mem: storing 1 in location 20\n"
      "mem: storing 35 in location 11\n"
  );
}

bool contains_type_ingredient(const reagent& x) {
  return contains_type_ingredient(x.type);
}

bool contains_type_ingredient(const type_tree* type) {
  if (!type) return false;
  if (type->atom) return type->value >= START_TYPE_INGREDIENTS;
  return contains_type_ingredient(type->left) || contains_type_ingredient(type->right);
}

void replace_type_ingredients(reagent& element, const type_tree* caller_type, const type_info& info, const string& location_for_error_messages) {
  if (contains_type_ingredient(element)) {
    if (!caller_type->right)
      raise << "illegal type " << names_to_string(caller_type) << " seems to be missing a type ingredient or three" << location_for_error_messages << '\n' << end();
    replace_type_ingredients(element.type, caller_type->right, info, location_for_error_messages);
  }
}

// replace all type_ingredients in element_type with corresponding elements of callsite_type
void replace_type_ingredients(type_tree* element_type, const type_tree* callsite_type, const type_info& container_info, const string& location_for_error_messages) {
  if (!callsite_type) return;  // error but it's already been raised above
  if (!element_type) return;
  if (!element_type->atom) {
    if (element_type->right == NULL && is_type_ingredient(element_type->left)) {
      int type_ingredient_index = to_type_ingredient_index(element_type->left);
      if (corresponding(callsite_type, type_ingredient_index, is_final_type_ingredient(type_ingredient_index, container_info))->right) {
        // replacing type ingredient at end of list, and replacement is a non-degenerate compound type -- (a b) but not (a)
        replace_type_ingredient_at(type_ingredient_index, element_type, callsite_type, container_info, location_for_error_messages);
        return;
      }
    }
    replace_type_ingredients(element_type->left, callsite_type, container_info, location_for_error_messages);
    replace_type_ingredients(element_type->right, callsite_type, container_info, location_for_error_messages);
    return;
  }
  if (is_type_ingredient(element_type))
    replace_type_ingredient_at(to_type_ingredient_index(element_type), element_type, callsite_type, container_info, location_for_error_messages);
}

const type_tree* corresponding(const type_tree* type, int index, bool final) {
  for (const type_tree* curr = type;  curr;  curr = curr->right, --index) {
    assert_for_now(!curr->atom);
    if (index == 0)
      return final ? curr : curr->left;
  }
  assert_for_now(false);
}

bool is_type_ingredient(const type_tree* type) {
  return type->atom && type->value >= START_TYPE_INGREDIENTS;
}

int to_type_ingredient_index(const type_tree* type) {
  assert(type->atom);
  return type->value-START_TYPE_INGREDIENTS;
}

void replace_type_ingredient_at(const int type_ingredient_index, type_tree* element_type, const type_tree* callsite_type, const type_info& container_info, const string& location_for_error_messages) {
  if (!has_nth_type(callsite_type, type_ingredient_index)) {
    raise << "illegal type " << names_to_string(callsite_type) << " seems to be missing a type ingredient or three" << location_for_error_messages << '\n' << end();
    return;
  }
  *element_type = *nth_type_ingredient(callsite_type, type_ingredient_index, container_info);
}

const type_tree* nth_type_ingredient(const type_tree* callsite_type, int type_ingredient_index, const type_info& container_info) {
  bool final = is_final_type_ingredient(type_ingredient_index, container_info);
  const type_tree* curr = callsite_type;
  for (int i = 0;  i < type_ingredient_index;  ++i) {
    assert(curr);
    assert(!curr->atom);
//?     cerr << "type ingredient " << i << " is " << to_string(curr->left) << '\n';
    curr = curr->right;
  }
  assert(curr);
  if (curr->atom) return curr;
  if (!final) return curr->left;
  if (!curr->right) return curr->left;
  return curr;
}

bool is_final_type_ingredient(int type_ingredient_index, const type_info& container_info) {
  for (map<string, type_ordinal>::const_iterator p = container_info.type_ingredient_names.begin();
       p != container_info.type_ingredient_names.end();
       ++p) {
    if (p->second > START_TYPE_INGREDIENTS+type_ingredient_index) return false;
  }
  return true;
}

:(before "End Unit Tests")
void test_replace_type_ingredients_entire() {
  run("container foo:_elem [\n"
      "  x:_elem\n"
      "  y:num\n"
      "]\n");
  reagent callsite("x:foo:point");
  reagent element = element_type(callsite.type, 0);
  CHECK_EQ(to_string(element), "{x: \"point\"}");
}

void test_replace_type_ingredients_tail() {
  run("container foo:_elem [\n"
      "  x:_elem\n"
      "]\n"
      "container bar:_elem [\n"
      "  x:foo:_elem\n"
      "]\n");
  reagent callsite("x:bar:point");
  reagent element = element_type(callsite.type, 0);
  CHECK_EQ(to_string(element), "{x: (\"foo\" \"point\")}");
}

void test_replace_type_ingredients_head_tail_multiple() {
  run("container foo:_elem [\n"
      "  x:_elem\n"
      "]\n"
      "container bar:_elem [\n"
      "  x:foo:_elem\n"
      "]\n");
  reagent callsite("x:bar:address:array:character");
  reagent element = element_type(callsite.type, 0);
  CHECK_EQ(to_string(element), "{x: (\"foo\" \"address\" \"array\" \"character\")}");
}

void test_replace_type_ingredients_head_middle() {
  run("container foo:_elem [\n"
      "  x:_elem\n"
      "]\n"
      "container bar:_elem [\n"
      "  x:foo:_elem:num\n"
      "]\n");
  reagent callsite("x:bar:address");
  reagent element = element_type(callsite.type, 0);
  CHECK_EQ(to_string(element), "{x: (\"foo\" \"address\" \"number\")}");
}

void test_replace_last_type_ingredient_with_multiple() {
  run("container foo:_a:_b [\n"
      "  x:_a\n"
      "  y:_b\n"
      "]\n");
  reagent callsite("{f: (foo number (address array character))}");
  reagent element1 = element_type(callsite.type, 0);
  CHECK_EQ(to_string(element1), "{x: \"number\"}");
  reagent element2 = element_type(callsite.type, 1);
  CHECK_EQ(to_string(element2), "{y: (\"address\" \"array\" \"character\")}");
}

void test_replace_last_type_ingredient_inside_compound() {
  run("container foo:_a:_b [\n"
      "  {x: (bar _a (address _b))}\n"
      "]\n");
  reagent callsite("f:foo:number:array:character");
  reagent element = element_type(callsite.type, 0);
  CHECK_EQ(names_to_string_without_quotes(element.type), "(bar number (address array character))");
}

void test_replace_middle_type_ingredient_with_multiple() {
  run("container foo:_a:_b:_c [\n"
      "  x:_a\n"
      "  y:_b\n"
      "  z:_c\n"
      "]\n");
  reagent callsite("{f: (foo number (address array character) boolean)}");
  reagent element1 = element_type(callsite.type, 0);
  CHECK_EQ(to_string(element1), "{x: \"number\"}");
  reagent element2 = element_type(callsite.type, 1);
  CHECK_EQ(to_string(element2), "{y: (\"address\" \"array\" \"character\")}");
  reagent element3 = element_type(callsite.type, 2);
  CHECK_EQ(to_string(element3), "{z: \"boolean\"}");
}

void test_replace_middle_type_ingredient_with_multiple2() {
  run("container foo:_key:_value [\n"
      "  key:_key\n"
      "  value:_value\n"
      "]\n");
  reagent callsite("{f: (foo (address array character) number)}");
  reagent element = element_type(callsite.type, 0);
  CHECK_EQ(to_string(element), "{key: (\"address\" \"array\" \"character\")}");
}

void test_replace_middle_type_ingredient_with_multiple3() {
  run("container foo_table:_key:_value [\n"
      "  data:&:@:foo_table_row:_key:_value\n"
      "]\n"
      "\n"
      "container foo_table_row:_key:_value [\n"
      "  key:_key\n"
      "  value:_value\n"
      "]\n");
  reagent callsite("{f: (foo_table (address array character) number)}");
  reagent element = element_type(callsite.type, 0);
  CHECK_EQ(to_string(element), "{data: (\"address\" \"array\" \"foo_table_row\" (\"address\" \"array\" \"character\") \"number\")}");
}

:(code)
bool has_nth_type(const type_tree* base, int n) {
  assert(n >= 0);
  if (!base) return false;
  if (n == 0) return true;
  return has_nth_type(base->right, n-1);
}

void test_get_on_shape_shifting_container_error() {
  Hide_errors = true;
  run(
      "container foo:_t [\n"
      "  x:_t\n"
      "  y:num\n"
      "]\n"
      "def main [\n"
      "  1:foo:point <- merge 14, 15, 16\n"
      "  10:num <- get 1:foo, 1:offset\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "error: illegal type \"foo\" seems to be missing a type ingredient or three while computing element type of container\n"
  );
  // todo: improve error message
}

void test_typos_in_container_definitions() {
  Hide_errors = true;
  run(
      "container foo:_t [\n"
      "  x:adress:_t  # typo\n"
      "]\n"
      "def main [\n"
      "  local-scope\n"
      "  x:address:foo:num <- new {(foo num): type}\n"
      "]\n"
  );
  // no crash
}

void test_typos_in_recipes() {
  Hide_errors = true;
  run(
      "def foo [\n"
      "  local-scope\n"
      "  x:adress:array:number <- copy null  # typo\n"
      "]\n"
  );
  // shouldn't crash
}

//:: 'merge' on shape-shifting containers

void test_merge_check_shape_shifting_container_containing_exclusive_container() {
  run(
      "container foo:_elem [\n"
      "  x:num\n"
      "  y:_elem\n"
      "]\n"
      "exclusive-container bar [\n"
      "  x:num\n"
      "  y:num\n"
      "]\n"
      "def main [\n"
      "  1:foo:bar <- merge 23, 1/y, 34\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "mem: storing 23 in location 1\n"
      "mem: storing 1 in location 2\n"
      "mem: storing 34 in location 3\n"
  );
  CHECK_TRACE_COUNT("error", 0);
}

void test_merge_check_shape_shifting_container_containing_exclusive_container_2() {
  Hide_errors = true;
  run(
      "container foo:_elem [\n"
      "  x:num\n"
      "  y:_elem\n"
      "]\n"
      "exclusive-container bar [\n"
      "  x:num\n"
      "  y:num\n"
      "]\n"
      "def main [\n"
      "  1:foo:bar <- merge 23, 1/y, 34, 35\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "error: main: too many ingredients in '1:foo:bar <- merge 23, 1/y, 34, 35'\n"
  );
}

void test_merge_check_shape_shifting_exclusive_container_containing_container() {
  run(
      "exclusive-container foo:_elem [\n"
      "  x:num\n"
      "  y:_elem\n"
      "]\n"
      "container bar [\n"
      "  x:num\n"
      "  y:num\n"
      "]\n"
      "def main [\n"
      "  1:foo:bar <- merge 1/y, 23, 34\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "mem: storing 1 in location 1\n"
      "mem: storing 23 in location 2\n"
      "mem: storing 34 in location 3\n"
  );
  CHECK_TRACE_COUNT("error", 0);
}

void test_merge_check_shape_shifting_exclusive_container_containing_container_2() {
  run(
      "exclusive-container foo:_elem [\n"
      "  x:num\n"
      "  y:_elem\n"
      "]\n"
      "container bar [\n"
      "  x:num\n"
      "  y:num\n"
      "]\n"
      "def main [\n"
      "  1:foo:bar <- merge 0/x, 23\n"
      "]\n"
  );
  CHECK_TRACE_COUNT("error", 0);
}

void test_merge_check_shape_shifting_exclusive_container_containing_container_3() {
  Hide_errors = true;
  run(
      "exclusive-container foo:_elem [\n"
      "  x:num\n"
      "  y:_elem\n"
      "]\n"
      "container bar [\n"
      "  x:num\n"
      "  y:num\n"
      "]\n"
      "def main [\n"
      "  1:foo:bar <- merge 1/y, 23\n"
      "]\n"
  );
  CHECK_TRACE_CONTENTS(
      "error: main: too few ingredients in '1:foo:bar <- merge 1/y, 23'\n"
  );
}