ocean-lang.org Git - ocean/blob - csrc/oceani.mdc

   1 # Ocean Interpreter - Jamison Creek version
   2
   3 Ocean is intended to be a compiled language, so this interpreter is
   4 not targeted at being the final product.  It is, rather, an intermediate
   5 stage and fills that role in two distinct ways.
   6
   7 Firstly, it exists as a platform to experiment with the early language
   8 design.  An interpreter is easy to write and easy to get working, so
   9 the barrier for entry is lower if I aim to start with an interpreter.
  10
  11 Secondly, the plan for the Ocean compiler is to write it in the
  12 [Ocean language](http://ocean-lang.org).  To achieve this we naturally
  13 need some sort of boot-strap process and this interpreter - written in
  14 portable C - will fill that role.  It will be used to bootstrap the
  15 Ocean compiler.
  16
  17 Two features that are not needed to fill either of these roles are
  18 performance and completeness.  The interpreter only needs to be fast
  19 enough to run small test programs and occasionally to run the compiler
  20 on itself.  It only needs to be complete enough to test aspects of the
  21 design which are developed before the compiler is working, and to run
  22 the compiler on itself.  Any features not used by the compiler when
  23 compiling itself are superfluous.  They may be included anyway, but
  24 they may not.
  25
  26 Nonetheless, the interpreter should end up being reasonably complete,
  27 and any performance bottlenecks which appear and are easily fixed, will
  28 be.
  29
  30 ## Current version
  31
  32 This third version of the interpreter exists to test out some initial
  33 ideas relating to types.  Particularly it adds arrays (indexed from
  34 zero) and simple structures.  Basic control flow and variable scoping
  35 are already fairly well established, as are basic numerical and
  36 boolean operators.
  37
  38 Some operators that have only recently been added, and so have not
  39 generated all that much experience yet are "and then" and "or else" as
  40 short-circuit Boolean operators, and the "if ... else" trinary
  41 operator which can select between two expressions based on a third
  42 (which appears syntactically in the middle).
  43
  44 The "func" clause currently only allows a "main" function to be
  45 declared.  That will be extended when proper function support is added.
  46
  47 An element that is present purely to make a usable language, and
  48 without any expectation that they will remain, is the "print" statement
  49 which performs simple output.
  50
  51 The current scalar types are "number", "Boolean", and "string".
  52 Boolean will likely stay in its current form, the other two might, but
  53 could just as easily be changed.
  54
  55 ## Naming
  56
  57 Versions of the interpreter which obviously do not support a complete
  58 language will be named after creeks and streams.  This one is Jamison
  59 Creek.
  60
  61 Once we have something reasonably resembling a complete language, the
  62 names of rivers will be used.
  63 Early versions of the compiler will be named after seas.  Major
  64 releases of the compiler will be named after oceans.  Hopefully I will
  65 be finished once I get to the Pacific Ocean release.
  66
  67 ## Outline
  68
  69 As well as parsing and executing a program, the interpreter can print
  70 out the program from the parsed internal structure.  This is useful
  71 for validating the parsing.
  72 So the main requirements of the interpreter are:
  73
  74 - Parse the program, possibly with tracing,
  75 - Analyse the parsed program to ensure consistency,
  76 - Print the program,
  77 - Execute the "main" function in the program, if no parsing or
  78   consistency errors were found.
  79
  80 This is all performed by a single C program extracted with
  81 `parsergen`.
  82
  83 There will be two formats for printing the program: a default and one
  84 that uses bracketing.  So a `--bracket` command line option is needed
  85 for that.  Normally the first code section found is used, however an
  86 alternate section can be requested so that a file (such as this one)
  87 can contain multiple programs.  This is effected with the `--section`
  88 option.
  89
  90 This code must be compiled with `-fplan9-extensions` so that anonymous
  91 structures can be used.
  92
  93 ###### File: oceani.mk
  94
  95         myCFLAGS := -Wall -g -fplan9-extensions
  96         CFLAGS := $(filter-out $(myCFLAGS),$(CFLAGS)) $(myCFLAGS)
  97         myLDLIBS:= libparser.o libscanner.o libmdcode.o -licuuc
  98         LDLIBS := $(filter-out $(myLDLIBS),$(LDLIBS)) $(myLDLIBS)
  99         ## libs
 100         all :: $(LDLIBS) oceani
 101         oceani.c oceani.h : oceani.mdc parsergen
 102                 ./parsergen -o oceani --LALR --tag Parser oceani.mdc
 103         oceani.mk: oceani.mdc md2c
 104                 ./md2c oceani.mdc
 105
 106         oceani: oceani.o $(LDLIBS)
 107                 $(CC) $(CFLAGS) -o oceani oceani.o $(LDLIBS)
 108
 109 ###### Parser: header
 110         ## macros
 111         struct parse_context;
 112         ## ast
 113         ## ast late
 114         struct parse_context {
 115                 struct token_config config;
 116                 char *file_name;
 117                 int parse_error;
 118                 ## parse context
 119         };
 120
 121 ###### macros
 122
 123         #define container_of(ptr, type, member) ({                      \
 124                 const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
 125                 (type *)( (char *)__mptr - offsetof(type,member) );})
 126
 127         #define config2context(_conf) container_of(_conf, struct parse_context, \
 128                 config)
 129
 130 ###### Parser: reduce
 131         struct parse_context *c = config2context(config);
 132
 133 ###### Parser: code
 134         #define _GNU_SOURCE
 135         #include <unistd.h>
 136         #include <stdlib.h>
 137         #include <fcntl.h>
 138         #include <errno.h>
 139         #include <sys/mman.h>
 140         #include <string.h>
 141         #include <stdio.h>
 142         #include <locale.h>
 143         #include <malloc.h>
 144         #include "mdcode.h"
 145         #include "scanner.h"
 146         #include "parser.h"
 147
 148         ## includes
 149
 150         #include "oceani.h"
 151
 152         ## forward decls
 153         ## value functions
 154         ## ast functions
 155         ## core functions
 156
 157         #include <getopt.h>
 158         static char Usage[] =
 159                 "Usage: oceani --trace --print --noexec --brackets --section=SectionName prog.ocn\n";
 160         static const struct option long_options[] = {
 161                 {"trace",     0, NULL, 't'},
 162                 {"print",     0, NULL, 'p'},
 163                 {"noexec",    0, NULL, 'n'},
 164                 {"brackets",  0, NULL, 'b'},
 165                 {"section",   1, NULL, 's'},
 166                 {NULL,        0, NULL, 0},
 167         };
 168         const char *options = "tpnbs";
 169
 170         static void pr_err(char *msg)                   // NOTEST
 171         {
 172                 fprintf(stderr, "%s\n", msg);           // NOTEST
 173         }                                               // NOTEST
 174
 175         int main(int argc, char *argv[])
 176         {
 177                 int fd;
 178                 int len;
 179                 char *file;
 180                 struct section *s = NULL, *ss;
 181                 char *section = NULL;
 182                 struct parse_context context = {
 183                         .config = {
 184                                 .ignored = (1 << TK_mark),
 185                                 .number_chars = ".,_+- ",
 186                                 .word_start = "_",
 187                                 .word_cont = "_",
 188                         },
 189                 };
 190                 int doprint=0, dotrace=0, doexec=1, brackets=0;
 191                 int opt;
 192                 while ((opt = getopt_long(argc, argv, options, long_options, NULL))
 193                        != -1) {
 194                         switch(opt) {
 195                         case 't': dotrace=1; break;
 196                         case 'p': doprint=1; break;
 197                         case 'n': doexec=0; break;
 198                         case 'b': brackets=1; break;
 199                         case 's': section = optarg; break;
 200                         default: fprintf(stderr, Usage);
 201                                 exit(1);
 202                         }
 203                 }
 204                 if (optind >= argc) {
 205                         fprintf(stderr, "oceani: no input file given\n");
 206                         exit(1);
 207                 }
 208                 fd = open(argv[optind], O_RDONLY);
 209                 if (fd < 0) {
 210                         fprintf(stderr, "oceani: cannot open %s\n", argv[optind]);
 211                         exit(1);
 212                 }
 213                 context.file_name = argv[optind];
 214                 len = lseek(fd, 0, 2);
 215                 file = mmap(NULL, len, PROT_READ, MAP_SHARED, fd, 0);
 216                 s = code_extract(file, file+len, pr_err);
 217                 if (!s) {
 218                         fprintf(stderr, "oceani: could not find any code in %s\n",
 219                                 argv[optind]);
 220                         exit(1);
 221                 }
 222
 223                 ## context initialization
 224
 225                 if (section) {
 226                         for (ss = s; ss; ss = ss->next) {
 227                                 struct text sec = ss->section;
 228                                 if (sec.len == strlen(section) &&
 229                                     strncmp(sec.txt, section, sec.len) == 0)
 230                                         break;
 231                         }
 232                         if (!ss) {
 233                                 fprintf(stderr, "oceani: cannot find section %s\n",
 234                                         section);
 235                                 goto cleanup;
 236                         }
 237                 } else
 238                         ss = s;                         // NOTEST
 239                 if (!ss->code) {
 240                         fprintf(stderr, "oceani: no code found in requested section\n");        // NOTEST
 241                         goto cleanup;                   // NOTEST
 242                 }
 243
 244                 parse_oceani(ss->code, &context.config, dotrace ? stderr : NULL);
 245
 246                 resolve_consts(&context);
 247                 prepare_types(&context);
 248                 if (!context.parse_error && !analyse_funcs(&context)) {
 249                         fprintf(stderr, "oceani: type error in program - not running.\n");
 250                         context.parse_error += 1;
 251                 }
 252
 253                 if (doprint) {
 254                         ## print const decls
 255                         ## print type decls
 256                         ## print func decls
 257                 }
 258                 if (doexec && !context.parse_error)
 259                         interp_main(&context, argc - optind, argv + optind);
 260         cleanup:
 261                 while (s) {
 262                         struct section *t = s->next;
 263                         code_free(s->code);
 264                         free(s);
 265                         s = t;
 266                 }
 267                 // FIXME parser should pop scope even on error
 268                 while (context.scope_depth > 0)
 269                         scope_pop(&context);
 270                 ## free global vars
 271                 ## free const decls
 272                 ## free context types
 273                 ## free context storage
 274                 exit(context.parse_error ? 1 : 0);
 275         }
 276
 277 ### Analysis
 278
 279 The four requirements of parse, analyse, print, interpret apply to
 280 each language element individually so that is how most of the code
 281 will be structured.
 282
 283 Three of the four are fairly self explanatory.  The one that requires
 284 a little explanation is the analysis step.
 285
 286 The current language design does not require the types of variables to
 287 be declared, but they must still have a single type.  Different
 288 operations impose different requirements on the variables, for example
 289 addition requires both arguments to be numeric, and assignment
 290 requires the variable on the left to have the same type as the
 291 expression on the right.
 292
 293 Analysis involves propagating these type requirements around and
 294 consequently setting the type of each variable.  If any requirements
 295 are violated (e.g. a string is compared with a number) or if a
 296 variable needs to have two different types, then an error is raised
 297 and the program will not run.
 298
 299 If the same variable is declared in both branchs of an 'if/else', or
 300 in all cases of a 'switch' then the multiple instances may be merged
 301 into just one variable if the variable is referenced after the
 302 conditional statement.  When this happens, the types must naturally be
 303 consistent across all the branches.  When the variable is not used
 304 outside the if, the variables in the different branches are distinct
 305 and can be of different types.
 306
 307 Undeclared names may only appear in "use" statements and "case" expressions.
 308 These names are given a type of "label" and a unique value.
 309 This allows them to fill the role of a name in an enumerated type, which
 310 is useful for testing the `switch` statement.
 311
 312 As we will see, the condition part of a `while` statement can return
 313 either a Boolean or some other type.  This requires that the expected
 314 type that gets passed around comprises a type and a flag to indicate
 315 that `Tbool` is also permitted.
 316
 317 As there are, as yet, no distinct types that are compatible, there
 318 isn't much subtlety in the analysis.  When we have distinct number
 319 types, this will become more interesting.
 320
 321 #### Error reporting
 322
 323 When analysis discovers an inconsistency it needs to report an error;
 324 just refusing to run the code ensures that the error doesn't cascade,
 325 but by itself it isn't very useful.  A clear understanding of the sort
 326 of error message that are useful will help guide the process of
 327 analysis.
 328
 329 At a simplistic level, the only sort of error that type analysis can
 330 report is that the type of some construct doesn't match a contextual
 331 requirement.  For example, in `4 + "hello"` the addition provides a
 332 contextual requirement for numbers, but `"hello"` is not a number.  In
 333 this particular example no further information is needed as the types
 334 are obvious from local information.  When a variable is involved that
 335 isn't the case.  It may be helpful to explain why the variable has a
 336 particular type, by indicating the location where the type was set,
 337 whether by declaration or usage.
 338
 339 Using a recursive-descent analysis we can easily detect a problem at
 340 multiple locations. In "`hello:= "there"; 4 + hello`" the addition
 341 will detect that one argument is not a number and the usage of `hello`
 342 will detect that a number was wanted, but not provided.  In this
 343 (early) version of the language, we will generate error reports at
 344 multiple locations, so the use of `hello` will report an error and
 345 explain were the value was set, and the addition will report an error
 346 and say why numbers are needed.  To be able to report locations for
 347 errors, each language element will need to record a file location
 348 (line and column) and each variable will need to record the language
 349 element where its type was set.  For now we will assume that each line
 350 of an error message indicates one location in the file, and up to 2
 351 types.  So we provide a `printf`-like function which takes a format, a
 352 location (a `struct exec` which has not yet been introduced), and 2
 353 types. "`%1`" reports the first type, "`%2`" reports the second.  We
 354 will need a function to print the location, once we know how that is
 355 stored. e As will be explained later, there are sometimes extra rules for
 356 type matching and they might affect error messages, we need to pass those
 357 in too.
 358
 359 As well as type errors, we sometimes need to report problems with
 360 tokens, which might be unexpected or might name a type that has not
 361 been defined.  For these we have `tok_err()` which reports an error
 362 with a given token.  Each of the error functions sets the flag in the
 363 context so indicate that parsing failed.
 364
 365 ###### forward decls
 366
 367         static void fput_loc(struct exec *loc, FILE *f);
 368         static void type_err(struct parse_context *c,
 369                              char *fmt, struct exec *loc,
 370                              struct type *t1, enum val_rules rules, struct type *t2);
 371         static void tok_err(struct parse_context *c, char *fmt, struct token *t);
 372
 373 ###### core functions
 374
 375         static void type_err(struct parse_context *c,
 376                              char *fmt, struct exec *loc,
 377                              struct type *t1, enum val_rules rules, struct type *t2)
 378         {
 379                 fprintf(stderr, "%s:", c->file_name);
 380                 fput_loc(loc, stderr);
 381                 for (; *fmt ; fmt++) {
 382                         if (*fmt != '%') {
 383                                 fputc(*fmt, stderr);
 384                                 continue;
 385                         }
 386                         fmt++;
 387                         switch (*fmt) {
 388                         case '%': fputc(*fmt, stderr); break;   // NOTEST
 389                         default: fputc('?', stderr); break;     // NOTEST
 390                         case '1':
 391                                 type_print(t1, stderr);
 392                                 break;
 393                         case '2':
 394                                 type_print(t2, stderr);
 395                                 break;
 396                         ## format cases
 397                         }
 398                 }
 399                 fputs("\n", stderr);
 400                 c->parse_error += 1;
 401         }
 402
 403         static void tok_err(struct parse_context *c, char *fmt, struct token *t)
 404         {
 405                 fprintf(stderr, "%s:%d:%d: %s: %.*s\n", c->file_name, t->line, t->col, fmt,
 406                         t->txt.len, t->txt.txt);
 407                 c->parse_error += 1;
 408         }
 409
 410 ## Entities: declared and predeclared.
 411
 412 There are various "things" that the language and/or the interpreter
 413 needs to know about to parse and execute a program.  These include
 414 types, variables, values, and executable code.  These are all lumped
 415 together under the term "entities" (calling them "objects" would be
 416 confusing) and introduced here.  The following section will present the
 417 different specific code elements which comprise or manipulate these
 418 various entities.
 419
 420 ### Executables
 421
 422 Executables can be lots of different things.  In many cases an
 423 executable is just an operation combined with one or two other
 424 executables.  This allows for expressions and lists etc.  Other times an
 425 executable is something quite specific like a constant or variable name.
 426 So we define a `struct exec` to be a general executable with a type, and
 427 a `struct binode` which is a subclass of `exec`, forms a node in a
 428 binary tree, and holds an operation.  There will be other subclasses,
 429 and to access these we need to be able to `cast` the `exec` into the
 430 various other types.  The first field in any `struct exec` is the type
 431 from the `exec_types` enum.
 432
 433 ###### macros
 434         #define cast(structname, pointer) ({            \
 435                 const typeof( ((struct structname *)0)->type) *__mptr = &(pointer)->type; \
 436                 if (__mptr && *__mptr != X##structname) abort();                \
 437                 (struct structname *)( (char *)__mptr);})
 438
 439         #define new(structname) ({                                              \
 440                 struct structname *__ptr = ((struct structname *)calloc(1,sizeof(struct structname))); \
 441                 __ptr->type = X##structname;                                            \
 442                 __ptr->line = -1; __ptr->column = -1;                                   \
 443                 __ptr;})
 444
 445         #define new_pos(structname, token) ({                                           \
 446                 struct structname *__ptr = ((struct structname *)calloc(1,sizeof(struct structname))); \
 447                 __ptr->type = X##structname;                                            \
 448                 __ptr->line = token.line; __ptr->column = token.col;                    \
 449                 __ptr;})
 450
 451 ###### ast
 452         enum exec_types {
 453                 Xbinode,
 454                 ## exec type
 455         };
 456         struct exec {
 457                 enum exec_types type;
 458                 int line, column;
 459                 ## exec fields
 460         };
 461         struct binode {
 462                 struct exec;
 463                 enum Btype {
 464                         ## Binode types
 465                 } op;
 466                 struct exec *left, *right;
 467         };
 468
 469 ###### ast functions
 470
 471         static int __fput_loc(struct exec *loc, FILE *f)
 472         {
 473                 if (!loc)
 474                         return 0;
 475                 if (loc->line >= 0) {
 476                         fprintf(f, "%d:%d: ", loc->line, loc->column);
 477                         return 1;
 478                 }
 479                 if (loc->type == Xbinode)
 480                         return __fput_loc(cast(binode,loc)->left, f) ||
 481                                __fput_loc(cast(binode,loc)->right, f);  // NOTEST
 482                 return 0;       // NOTEST
 483         }
 484         static void fput_loc(struct exec *loc, FILE *f)
 485         {
 486                 if (!__fput_loc(loc, f))
 487                         fprintf(f, "??:??: ");  // NOTEST
 488         }
 489
 490 Each different type of `exec` node needs a number of functions defined,
 491 a bit like methods.  We must be able to free it, print it, analyse it
 492 and execute it.  Once we have specific `exec` types we will need to
 493 parse them too.  Let's take this a bit more slowly.
 494
 495 #### Freeing
 496
 497 The parser generator requires a `free_foo` function for each struct
 498 that stores attributes and they will often be `exec`s and subtypes
 499 there-of.  So we need `free_exec` which can handle all the subtypes,
 500 and we need `free_binode`.
 501
 502 ###### ast functions
 503
 504         static void free_binode(struct binode *b)
 505         {
 506                 if (!b)
 507                         return;
 508                 free_exec(b->left);
 509                 free_exec(b->right);
 510                 free(b);
 511         }
 512
 513 ###### core functions
 514         static void free_exec(struct exec *e)
 515         {
 516                 if (!e)
 517                         return;
 518                 switch(e->type) {
 519                         ## free exec cases
 520                 }
 521         }
 522
 523 ###### forward decls
 524
 525         static void free_exec(struct exec *e);
 526
 527 ###### free exec cases
 528         case Xbinode: free_binode(cast(binode, e)); break;
 529
 530 #### Printing
 531
 532 Printing an `exec` requires that we know the current indent level for
 533 printing line-oriented components.  As will become clear later, we
 534 also want to know what sort of bracketing to use.
 535
 536 ###### ast functions
 537
 538         static void do_indent(int i, char *str)
 539         {
 540                 while (i-- > 0)
 541                         printf("    ");
 542                 printf("%s", str);
 543         }
 544
 545 ###### core functions
 546         static void print_binode(struct binode *b, int indent, int bracket)
 547         {
 548                 struct binode *b2;
 549                 switch(b->op) {
 550                 ## print binode cases
 551                 }
 552         }
 553
 554         static void print_exec(struct exec *e, int indent, int bracket)
 555         {
 556                 if (!e)
 557                         return;
 558                 switch (e->type) {
 559                 case Xbinode:
 560                         print_binode(cast(binode, e), indent, bracket); break;
 561                 ## print exec cases
 562                 }
 563                 if (e->to_free) {
 564                         struct variable *v;
 565                         do_indent(indent, "/* FREE");
 566                         for (v = e->to_free; v; v = v->next_free) {
 567                                 printf(" %.*s", v->name->name.len, v->name->name.txt);
 568                                 printf("[%d,%d]", v->scope_start, v->scope_end);
 569                                 if (v->frame_pos >= 0)
 570                                         printf("(%d+%d)", v->frame_pos,
 571                                                v->type ? v->type->size:0);
 572                         }
 573                         printf(" */\n");
 574                 }
 575         }
 576
 577 ###### forward decls
 578
 579         static void print_exec(struct exec *e, int indent, int bracket);
 580
 581 #### Analysing
 582
 583 As discussed, analysis involves propagating type requirements around the
 584 program and looking for errors.
 585
 586 So `propagate_types` is passed an expected type (being a `struct type`
 587 pointer together with some `val_rules` flags) that the `exec` is
 588 expected to return, and returns the type that it does return, either of
 589 which can be `NULL` signifying "unknown".  A `prop_err` flag set is
 590 passed by reference.  It has `Efail` set when an error is found, and
 591 `Eretry` when the type for some element is set via propagation.  If
 592 any expression cannot be evaluated a compile time, `Eruntime` is set.
 593 If the expression can be copied, `Emaycopy` is set.
 594
 595 If `Erval` is set, then the value cannot be assigned to because it is
 596 a temporary result.  If `Erval` is clear but `Econst` is set, then
 597 the value can only be assigned once, when the variable is declared.
 598
 599 ###### ast
 600
 601         enum val_rules {Rboolok = 1<<0,};
 602         enum prop_err {Efail = 1<<0, Eretry = 1<<1, Eruntime = 1<<2,
 603                        Emaycopy = 1<<3, Erval = 1<<4, Econst = 1<<5};
 604
 605 ###### forward decls
 606         static struct type *propagate_types(struct exec *prog, struct parse_context *c, enum prop_err *perr,
 607                                             struct type *type, enum val_rules rules);
 608 ###### core functions
 609
 610         static struct type *__propagate_types(struct exec *prog, struct parse_context *c, enum prop_err *perr,
 611                                               enum prop_err *perr_local,
 612                                               struct type *type, enum val_rules rules)
 613         {
 614                 struct type *t;
 615
 616                 if (!prog)
 617                         return Tnone;
 618
 619                 switch (prog->type) {
 620                 case Xbinode:
 621                 {
 622                         struct binode *b = cast(binode, prog);
 623                         switch (b->op) {
 624                         ## propagate binode cases
 625                         }
 626                         break;
 627                 }
 628                 ## propagate exec cases
 629                 }
 630                 return Tnone;
 631         }
 632
 633         static struct type *propagate_types(struct exec *prog, struct parse_context *c, enum prop_err *perr,
 634                                             struct type *type, enum val_rules rules)
 635         {
 636                 int pre_err = c->parse_error;
 637                 enum prop_err perr_local = 0;
 638                 struct type *ret = __propagate_types(prog, c, perr, &perr_local, type, rules);
 639
 640                 *perr |= perr_local & (Efail | Eretry);
 641                 if (c->parse_error > pre_err)
 642                         *perr |= Efail;
 643                 return ret;
 644         }
 645
 646 #### Interpreting
 647
 648 Interpreting an `exec` doesn't require anything but the `exec`.  State
 649 is stored in variables and each variable will be directly linked from
 650 within the `exec` tree.  The exception to this is the `main` function
 651 which needs to look at command line arguments.  This function will be
 652 interpreted separately.
 653
 654 Each `exec` can return a value combined with a type in `struct lrval`.
 655 The type may be `Tnone` but must be non-NULL.  Some `exec`s will return
 656 the location of a value, which can be updated, in `lval`.  Others will
 657 set `lval` to NULL indicating that there is a value of appropriate type
 658 in `rval`.
 659
 660 ###### forward decls
 661         static struct value interp_exec(struct parse_context *c, struct exec *e,
 662                                         struct type **typeret);
 663 ###### core functions
 664
 665         struct lrval {
 666                 struct type *type;
 667                 struct value rval, *lval;
 668         };
 669
 670         /* If dest is passed, dtype must give the expected type, and
 671          * result can go there, in which case type is returned as NULL.
 672          */
 673         static struct lrval _interp_exec(struct parse_context *c, struct exec *e,
 674                                          struct value *dest, struct type *dtype);
 675
 676         static struct value interp_exec(struct parse_context *c, struct exec *e,
 677                                         struct type **typeret)
 678         {
 679                 struct lrval ret = _interp_exec(c, e, NULL, NULL);
 680
 681                 if (!ret.type) abort();
 682                 if (typeret)
 683                         *typeret = ret.type;
 684                 if (ret.lval)
 685                         dup_value(ret.type, ret.lval, &ret.rval);
 686                 return ret.rval;
 687         }
 688
 689         static struct value *linterp_exec(struct parse_context *c, struct exec *e,
 690                                           struct type **typeret)
 691         {
 692                 struct lrval ret = _interp_exec(c, e, NULL, NULL);
 693
 694                 if (!ret.type) abort();
 695                 if (ret.lval)
 696                         *typeret = ret.type;
 697                 else
 698                         free_value(ret.type, &ret.rval);
 699                 return ret.lval;
 700         }
 701
 702         /* dinterp_exec is used when the destination type is certain and
 703          * the value has a place to go.
 704          */
 705         static void dinterp_exec(struct parse_context *c, struct exec *e,
 706                                  struct value *dest, struct type *dtype,
 707                                  int need_free)
 708         {
 709                 struct lrval ret = _interp_exec(c, e, dest, dtype);
 710                 if (!ret.type)
 711                         return;
 712                 if (need_free)
 713                         free_value(dtype, dest);
 714                 if (ret.lval)
 715                         dup_value(dtype, ret.lval, dest);
 716                 else
 717                         memcpy(dest, &ret.rval, dtype->size);
 718         }
 719
 720         static struct lrval _interp_exec(struct parse_context *c, struct exec *e,
 721                                          struct value *dest, struct type *dtype)
 722         {
 723                 /* If the result is copied to dest, ret.type is set to NULL */
 724                 struct lrval ret;
 725                 struct value rv = {}, *lrv = NULL;
 726                 struct type *rvtype;
 727
 728                 rvtype = ret.type = Tnone;
 729                 if (!e) {
 730                         ret.lval = lrv;
 731                         ret.rval = rv;
 732                         return ret;
 733                 }
 734
 735                 switch(e->type) {
 736                 case Xbinode:
 737                 {
 738                         struct binode *b = cast(binode, e);
 739                         struct value left, right, *lleft;
 740                         struct type *ltype, *rtype;
 741                         ltype = rtype = Tnone;
 742                         switch (b->op) {
 743                         ## interp binode cases
 744                         }
 745                         free_value(ltype, &left);
 746                         free_value(rtype, &right);
 747                         break;
 748                 }
 749                 ## interp exec cases
 750                 }
 751                 if (rvtype) {
 752                         ret.lval = lrv;
 753                         ret.rval = rv;
 754                         ret.type = rvtype;
 755                 }
 756                 ## interp exec cleanup
 757                 return ret;
 758         }
 759
 760 ### Types
 761
 762 Values come in a wide range of types, with more likely to be added.
 763 Each type needs to be able to print its own values (for convenience at
 764 least) as well as to compare two values, at least for equality and
 765 possibly for order.  For now, values might need to be duplicated and
 766 freed, though eventually such manipulations will be better integrated
 767 into the language.
 768
 769 Rather than requiring every numeric type to support all numeric
 770 operations (add, multiply, etc), we allow types to be able to present
 771 as one of a few standard types: integer, float, and fraction.  The
 772 existence of these conversion functions eventually enable types to
 773 determine if they are compatible with other types, though such types
 774 have not yet been implemented.
 775
 776 Named type are stored in a simple linked list.  Objects of each type are
 777 "values" which are often passed around by value.
 778
 779 There are both explicitly named types, and anonymous types.  Anonymous
 780 cannot be accessed by name, but are used internally and have a name
 781 which might be reported in error messages.
 782
 783 ###### ast
 784
 785         struct value {
 786                 union {
 787                         char ptr[1];
 788                         ## value union fields
 789                 };
 790         };
 791
 792 ###### ast late
 793         struct type {
 794                 struct text name;
 795                 struct type *next;
 796                 struct token first_use;
 797                 int size, align;
 798                 int anon;
 799                 void (*init)(struct type *type, struct value *val);
 800                 int (*prepare_type)(struct parse_context *c, struct type *type, int parse_time);
 801                 void (*print)(struct type *type, struct value *val, FILE *f);
 802                 void (*print_type)(struct type *type, FILE *f);
 803                 int (*cmp_order)(struct type *t1, struct type *t2,
 804                                  struct value *v1, struct value *v2);
 805                 int (*cmp_eq)(struct type *t1, struct type *t2,
 806                               struct value *v1, struct value *v2);
 807                 void (*dup)(struct type *type, struct value *vold, struct value *vnew);
 808                 int (*test)(struct type *type, struct value *val);
 809                 void (*free)(struct type *type, struct value *val);
 810                 void (*free_type)(struct type *t);
 811                 long long (*to_int)(struct value *v);
 812                 double (*to_float)(struct value *v);
 813                 int (*to_mpq)(mpq_t *q, struct value *v);
 814                 ## type functions
 815                 union {
 816                         ## type union fields
 817                 };
 818         };
 819
 820 ###### parse context
 821
 822         struct type *typelist;
 823
 824 ###### includes
 825         #include <stdarg.h>
 826
 827 ###### ast functions
 828
 829         static struct type *find_type(struct parse_context *c, struct text s)
 830         {
 831                 struct type *t = c->typelist;
 832
 833                 while (t && (t->anon ||
 834                              text_cmp(t->name, s) != 0))
 835                                 t = t->next;
 836                 return t;
 837         }
 838
 839         static struct type *_add_type(struct parse_context *c, struct text s,
 840                                      struct type *proto, int anon)
 841         {
 842                 struct type *n;
 843
 844                 n = calloc(1, sizeof(*n));
 845                 if (proto)
 846                         *n = *proto;
 847                 else
 848                         n->size = -1;
 849                 n->name = s;
 850                 n->anon = anon;
 851                 n->next = c->typelist;
 852                 c->typelist = n;
 853                 return n;
 854         }
 855
 856         static struct type *add_type(struct parse_context *c, struct text s,
 857                                       struct type *proto)
 858         {
 859                 return _add_type(c, s, proto, 0);
 860         }
 861
 862         static struct type *add_anon_type(struct parse_context *c,
 863                                           struct type *proto, char *name, ...)
 864         {
 865                 struct text t;
 866                 va_list ap;
 867
 868                 va_start(ap, name);
 869                 vasprintf(&t.txt, name, ap);
 870                 va_end(ap);
 871                 t.len = strlen(t.txt);
 872                 return _add_type(c, t, proto, 1);
 873         }
 874
 875         static struct type *find_anon_type(struct parse_context *c,
 876                                            struct type *proto, char *name, ...)
 877         {
 878                 struct type *t = c->typelist;
 879                 struct text nm;
 880                 va_list ap;
 881
 882                 va_start(ap, name);
 883                 vasprintf(&nm.txt, name, ap);
 884                 va_end(ap);
 885                 nm.len = strlen(name);
 886
 887                 while (t && (!t->anon ||
 888                              text_cmp(t->name, nm) != 0))
 889                                 t = t->next;
 890                 if (t) {
 891                         free(nm.txt);
 892                         return t;
 893                 }
 894                 return _add_type(c, nm, proto, 1);
 895         }
 896
 897         static void free_type(struct type *t)
 898         {
 899                 /* The type is always a reference to something in the
 900                  * context, so we don't need to free anything.
 901                  */
 902         }
 903
 904         static void free_value(struct type *type, struct value *v)
 905         {
 906                 if (type && v) {
 907                         type->free(type, v);
 908                         memset(v, 0x5a, type->size);
 909                 }
 910         }
 911
 912         static void type_print(struct type *type, FILE *f)
 913         {
 914                 if (!type)
 915                         fputs("*unknown*type*", f);     // NOTEST
 916                 else if (type->name.len && !type->anon)
 917                         fprintf(f, "%.*s", type->name.len, type->name.txt);
 918                 else if (type->print_type)
 919                         type->print_type(type, f);
 920                 else if (type->name.len && type->anon)
 921                         fprintf(f, "\"%.*s\"", type->name.len, type->name.txt);
 922                 else
 923                         fputs("*invalid*type*", f);     // NOTEST
 924         }
 925
 926         static void val_init(struct type *type, struct value *val)
 927         {
 928                 if (type && type->init)
 929                         type->init(type, val);
 930         }
 931
 932         static void dup_value(struct type *type,
 933                               struct value *vold, struct value *vnew)
 934         {
 935                 if (type && type->dup)
 936                         type->dup(type, vold, vnew);
 937         }
 938
 939         static int value_cmp(struct type *tl, struct type *tr,
 940                              struct value *left, struct value *right)
 941         {
 942                 if (tl && tl->cmp_order)
 943                         return tl->cmp_order(tl, tr, left, right);
 944                 if (tl && tl->cmp_eq)
 945                         return tl->cmp_eq(tl, tr, left, right);
 946                 return -1;                              // NOTEST
 947         }
 948
 949         static void print_value(struct type *type, struct value *v, FILE *f)
 950         {
 951                 if (type && type->print)
 952                         type->print(type, v, f);
 953                 else
 954                         fprintf(f, "*Unknown*");                // NOTEST
 955         }
 956
 957         static void prepare_types(struct parse_context *c)
 958         {
 959                 struct type *t;
 960                 int retry = 1;
 961                 enum { none, some, cannot } progress = none;
 962
 963                 while (retry) {
 964                         retry = 0;
 965
 966                         for (t = c->typelist; t; t = t->next) {
 967                                 if (t->size < 0)
 968                                         tok_err(c, "error: type used but not declared",
 969                                                  &t->first_use);
 970                                 if (t->size == 0 && t->prepare_type) {
 971                                         if (t->prepare_type(c, t, 1))
 972                                                 progress = some;
 973                                         else if (progress == cannot)
 974                                                 tok_err(c, "error: type has recursive definition",
 975                                                         &t->first_use);
 976                                         else
 977                                                 retry = 1;
 978                                 }
 979                         }
 980                         switch (progress) {
 981                         case cannot:
 982                                 retry = 0; break;
 983                         case none:
 984                                 progress = cannot; break;
 985                         case some:
 986                                 progress = none; break;
 987                         }
 988                 }
 989         }
 990
 991 ###### forward decls
 992
 993         static void free_value(struct type *type, struct value *v);
 994         static int type_compat(struct type *require, struct type *have, enum val_rules rules);
 995         static void type_print(struct type *type, FILE *f);
 996         static void val_init(struct type *type, struct value *v);
 997         static void dup_value(struct type *type,
 998                               struct value *vold, struct value *vnew);
 999         static int value_cmp(struct type *tl, struct type *tr,
1000                              struct value *left, struct value *right);
1001         static void print_value(struct type *type, struct value *v, FILE *f);
1002
1003 ###### free context types
1004
1005         while (context.typelist) {
1006                 struct type *t = context.typelist;
1007
1008                 context.typelist = t->next;
1009                 if (t->free_type)
1010                         t->free_type(t);
1011                 if (t->anon)
1012                         free(t->name.txt);
1013                 free(t);
1014         }
1015
1016 Type can be specified for local variables, for fields in a structure,
1017 for formal parameters to functions, and possibly elsewhere.  Different
1018 rules may apply in different contexts.  As a minimum, a named type may
1019 always be used.  Currently the type of a formal parameter can be
1020 different from types in other contexts, so we have a separate grammar
1021 symbol for those.
1022
1023 ###### Grammar
1024
1025         $*type
1026         Type -> IDENTIFIER ${
1027                 $0 = find_type(c, $ID.txt);
1028                 if (!$0) {
1029                         $0 = add_type(c, $ID.txt, NULL);
1030                         $0->first_use = $ID;
1031                 }
1032         }$
1033         ## type grammar
1034
1035         FormalType -> Type ${ $0 = $<1; }$
1036         ## formal type grammar
1037
1038 #### Base Types
1039
1040 Values of the base types can be numbers, which we represent as
1041 multi-precision fractions, strings, Booleans and labels.  When
1042 analysing the program we also need to allow for places where no value
1043 is meaningful (type `Tnone`) and where we don't know what type to
1044 expect yet (type is `NULL`).
1045
1046 Values are never shared, they are always copied when used, and freed
1047 when no longer needed.
1048
1049 When propagating type information around the program, we need to
1050 determine if two types are compatible, where type `NULL` is compatible
1051 with anything.  There are two special cases with type compatibility,
1052 both related to the Conditional Statement which will be described
1053 later.  In some cases a Boolean can be accepted as well as some other
1054 primary type, and in others any type is acceptable except a label (`Vlabel`).
1055 A separate function encoding these cases will simplify some code later.
1056
1057 ###### type functions
1058
1059         int (*compat)(struct type *this, struct type *other, enum val_rules rules);
1060
1061 ###### ast functions
1062
1063         static int type_compat(struct type *require, struct type *have,
1064                                enum val_rules rules)
1065         {
1066                 if ((rules & Rboolok) && have == Tbool)
1067                         return 1;       // NOTEST
1068                 if (!require || !have)
1069                         return 1;
1070
1071                 if (require->compat)
1072                         return require->compat(require, have, rules);
1073
1074                 return require == have;
1075         }
1076
1077 ###### includes
1078         #include <gmp.h>
1079         #include "parse_string.h"
1080         #include "parse_number.h"
1081
1082 ###### libs
1083         myLDLIBS := libnumber.o libstring.o -lgmp
1084         LDLIBS := $(filter-out $(myLDLIBS),$(LDLIBS)) $(myLDLIBS)
1085
1086 ###### type union fields
1087         enum vtype {Vnone, Vstr, Vnum, Vbool, Vlabel} vtype;
1088
1089 ###### value union fields
1090         struct text str;
1091         mpq_t num;
1092         unsigned char bool;
1093         int label;
1094
1095 ###### ast functions
1096         static void _free_value(struct type *type, struct value *v)
1097         {
1098                 if (!v)
1099                         return;         // NOTEST
1100                 switch (type->vtype) {
1101                 case Vnone: break;
1102                 case Vstr: free(v->str.txt); break;
1103                 case Vnum: mpq_clear(v->num); break;
1104                 case Vlabel:
1105                 case Vbool: break;
1106                 }
1107         }
1108
1109 ###### value functions
1110
1111         static void _val_init(struct type *type, struct value *val)
1112         {
1113                 switch(type->vtype) {
1114                 case Vnone:             // NOTEST
1115                         break;          // NOTEST
1116                 case Vnum:
1117                         mpq_init(val->num); break;
1118                 case Vstr:
1119                         val->str.txt = malloc(1);
1120                         val->str.len = 0;
1121                         break;
1122                 case Vbool:
1123                         val->bool = 0;
1124                         break;
1125                 case Vlabel:
1126                         val->label = 0; // NOTEST
1127                         break;          // NOTEST
1128                 }
1129         }
1130
1131         static void _dup_value(struct type *type,
1132                                struct value *vold, struct value *vnew)
1133         {
1134                 switch (type->vtype) {
1135                 case Vnone:             // NOTEST
1136                         break;          // NOTEST
1137                 case Vlabel:
1138                         vnew->label = vold->label;      // NOTEST
1139                         break;          // NOTEST
1140                 case Vbool:
1141                         vnew->bool = vold->bool;
1142                         break;
1143                 case Vnum:
1144                         mpq_init(vnew->num);
1145                         mpq_set(vnew->num, vold->num);
1146                         break;
1147                 case Vstr:
1148                         vnew->str.len = vold->str.len;
1149                         vnew->str.txt = malloc(vnew->str.len);
1150                         memcpy(vnew->str.txt, vold->str.txt, vnew->str.len);
1151                         break;
1152                 }
1153         }
1154
1155         static int _value_cmp(struct type *tl, struct type *tr,
1156                               struct value *left, struct value *right)
1157         {
1158                 int cmp;
1159                 if (tl != tr)
1160                         return tl - tr; // NOTEST
1161                 switch (tl->vtype) {
1162                 case Vlabel: cmp = left->label == right->label ? 0 : 1; break;
1163                 case Vnum: cmp = mpq_cmp(left->num, right->num); break;
1164                 case Vstr: cmp = text_cmp(left->str, right->str); break;
1165                 case Vbool: cmp = left->bool - right->bool; break;
1166                 case Vnone: cmp = 0;                    // NOTEST
1167                 }
1168                 return cmp;
1169         }
1170
1171         static void _print_value(struct type *type, struct value *v, FILE *f)
1172         {
1173                 switch (type->vtype) {
1174                 case Vnone:                             // NOTEST
1175                         fprintf(f, "*no-value*"); break;        // NOTEST
1176                 case Vlabel:                            // NOTEST
1177                         fprintf(f, "*label-%d*", v->label); break; // NOTEST
1178                 case Vstr:
1179                         fprintf(f, "%.*s", v->str.len, v->str.txt); break;
1180                 case Vbool:
1181                         fprintf(f, "%s", v->bool ? "True":"False"); break;
1182                 case Vnum:
1183                         {
1184                         mpf_t fl;
1185                         mpf_init2(fl, 20);
1186                         mpf_set_q(fl, v->num);
1187                         gmp_fprintf(f, "%.10Fg", fl);
1188                         mpf_clear(fl);
1189                         break;
1190                         }
1191                 }
1192         }
1193
1194         static void _free_value(struct type *type, struct value *v);
1195
1196         static int bool_test(struct type *type, struct value *v)
1197         {
1198                 return v->bool;
1199         }
1200
1201         static struct type base_prototype = {
1202                 .init = _val_init,
1203                 .print = _print_value,
1204                 .cmp_order = _value_cmp,
1205                 .cmp_eq = _value_cmp,
1206                 .dup = _dup_value,
1207                 .free = _free_value,
1208         };
1209
1210         static struct type *Tbool, *Tstr, *Tnum, *Tnone, *Tlabel;
1211
1212 ###### ast functions
1213         static struct type *add_base_type(struct parse_context *c, char *n,
1214                                           enum vtype vt, int size)
1215         {
1216                 struct text txt = { n, strlen(n) };
1217                 struct type *t;
1218
1219                 t = add_type(c, txt, &base_prototype);
1220                 t->vtype = vt;
1221                 t->size = size;
1222                 t->align = size > sizeof(void*) ? sizeof(void*) : size;
1223                 if (t->size & (t->align - 1))
1224                         t->size = (t->size | (t->align - 1)) + 1;       // NOTEST
1225                 return t;
1226         }
1227
1228 ###### context initialization
1229
1230         Tbool  = add_base_type(&context, "Boolean", Vbool, sizeof(char));
1231         Tbool->test = bool_test;
1232         Tstr   = add_base_type(&context, "string", Vstr, sizeof(struct text));
1233         Tnum   = add_base_type(&context, "number", Vnum, sizeof(mpq_t));
1234         Tnone  = add_base_type(&context, "none", Vnone, 0);
1235         Tlabel = add_base_type(&context, "label", Vlabel, sizeof(void*));
1236
1237 ##### Base Values
1238
1239 We have already met values as separate objects.  When manifest constants
1240 appear in the program text, that must result in an executable which has
1241 a constant value.  So the `val` structure embeds a value in an
1242 executable.
1243
1244 ###### exec type
1245         Xval,
1246
1247 ###### ast
1248         struct val {
1249                 struct exec;
1250                 struct type *vtype;
1251                 struct value val;
1252         };
1253
1254 ###### ast functions
1255         struct val *new_val(struct type *T, struct token tk)
1256         {
1257                 struct val *v = new_pos(val, tk);
1258                 v->vtype = T;
1259                 return v;
1260         }
1261
1262 ###### declare terminals
1263         $TERM True False
1264
1265 ###### Grammar
1266
1267         $*val
1268         Value ->  True ${
1269                 $0 = new_val(Tbool, $1);
1270                 $0->val.bool = 1;
1271         }$
1272         | False ${
1273                 $0 = new_val(Tbool, $1);
1274                 $0->val.bool = 0;
1275         }$
1276         | NUMBER ${ {
1277                 char tail[3];
1278                 $0 = new_val(Tnum, $1);
1279                 if (number_parse($0->val.num, tail, $1.txt) == 0)
1280                         mpq_init($0->val.num);  // UNTESTED
1281                         if (tail[0])
1282                                 tok_err(c, "error: unsupported number suffix",
1283                                         &$1);
1284         } }$
1285         | STRING ${ {
1286                 char tail[3];
1287                 $0 = new_val(Tstr, $1);
1288                 string_parse(&$1, '\\', &$0->val.str, tail);
1289                 if (tail[0])
1290                         tok_err(c, "error: unsupported string suffix",
1291                                 &$1);
1292         } }$
1293         | MULTI_STRING ${ {
1294                 char tail[3];
1295                 $0 = new_val(Tstr, $1);
1296                 string_parse(&$1, '\\', &$0->val.str, tail);
1297                 if (tail[0])
1298                         tok_err(c, "error: unsupported string suffix",
1299                                 &$1);
1300         } }$
1301
1302 ###### print exec cases
1303         case Xval:
1304         {
1305                 struct val *v = cast(val, e);
1306                 if (v->vtype == Tstr)
1307                         printf("\"");
1308                 // FIXME how to ensure numbers have same precision.
1309                 print_value(v->vtype, &v->val, stdout);
1310                 if (v->vtype == Tstr)
1311                         printf("\"");
1312                 break;
1313         }
1314
1315 ###### propagate exec cases
1316         case Xval:
1317         {
1318                 struct val *val = cast(val, prog);
1319                 if (!type_compat(type, val->vtype, rules))
1320                         type_err(c, "error: expected %1 found %2",
1321                                    prog, type, rules, val->vtype);
1322                 *perr |= Erval;
1323                 return val->vtype;
1324         }
1325
1326 ###### interp exec cases
1327         case Xval:
1328                 rvtype = cast(val, e)->vtype;
1329                 dup_value(rvtype, &cast(val, e)->val, &rv);
1330                 break;
1331
1332 ###### ast functions
1333         static void free_val(struct val *v)
1334         {
1335                 if (v)
1336                         free_value(v->vtype, &v->val);
1337                 free(v);
1338         }
1339
1340 ###### free exec cases
1341         case Xval: free_val(cast(val, e)); break;
1342
1343 ###### ast functions
1344         // Move all nodes from 'b' to 'rv', reversing their order.
1345         // In 'b' 'left' is a list, and 'right' is the last node.
1346         // In 'rv', left' is the first node and 'right' is a list.
1347         static struct binode *reorder_bilist(struct binode *b)
1348         {
1349                 struct binode *rv = NULL;
1350
1351                 while (b) {
1352                         struct exec *t = b->right;
1353                         b->right = rv;
1354                         rv = b;
1355                         if (b->left)
1356                                 b = cast(binode, b->left);
1357                         else
1358                                 b = NULL;
1359                         rv->left = t;
1360                 }
1361                 return rv;
1362         }
1363
1364 #### Labels
1365
1366 Labels are a temporary concept until I implement enums.  There are an
1367 anonymous enum which is declared by usage.  Thet are only allowed in
1368 `use` statements and corresponding `case` entries.  They appear as a
1369 period followed by an identifier.  All identifiers that are "used" must
1370 have a "case".
1371
1372 For now, we have a global list of labels, and don't check that all "use"
1373 match "case".
1374
1375 ###### exec type
1376         Xlabel,
1377
1378 ###### ast
1379         struct label {
1380                 struct exec;
1381                 struct text name;
1382                 int value;
1383         };
1384 ###### free exec cases
1385         case Xlabel:
1386                 free(e);
1387                 break;
1388 ###### print exec cases
1389         case Xlabel: {
1390                 struct label *l = cast(label, e);
1391                 printf(".%.*s", l->name.len, l->name.txt);
1392                 break;
1393         }
1394
1395 ###### ast
1396         struct labels {
1397                 struct labels *next;
1398                 struct text name;
1399                 int value;
1400         };
1401 ###### parse context
1402         struct labels *labels;
1403         int next_label;
1404 ###### ast functions
1405         static int label_lookup(struct parse_context *c, struct text name)
1406         {
1407                 struct labels *l, **lp = &c->labels;
1408                 while (*lp && text_cmp((*lp)->name, name) < 0)
1409                         lp = &(*lp)->next;
1410                 if (*lp && text_cmp((*lp)->name, name) == 0)
1411                         return (*lp)->value;
1412                 l = calloc(1, sizeof(*l));
1413                 l->next = *lp;
1414                 l->name = name;
1415                 if (c->next_label == 0)
1416                         c->next_label = 2;
1417                 l->value = c->next_label;
1418                 c->next_label += 1;
1419                 *lp = l;
1420                 return l->value;
1421         }
1422
1423 ###### free context storage
1424         while (context.labels) {
1425                 struct labels *l = context.labels;
1426                 context.labels = l->next;
1427                 free(l);
1428         }
1429
1430 ###### declare terminals
1431         $TERM .
1432 ###### term grammar
1433         | . IDENTIFIER ${ {
1434                 struct label *l = new_pos(label, $ID);
1435                 l->name = $ID.txt;
1436                 $0 = l;
1437         } }$
1438 ###### propagate exec cases
1439         case Xlabel: {
1440                 struct label *l = cast(label, prog);
1441                 l->value = label_lookup(c, l->name);
1442                 if (!type_compat(type, Tlabel, rules))
1443                         type_err(c, "error: expected %1 found %2",
1444                                  prog, type, rules, Tlabel);
1445                 *perr |= Erval;
1446                 return Tlabel;
1447         }
1448 ###### interp exec cases
1449         case Xlabel : {
1450                 struct label *l = cast(label, e);
1451                 rv.label = l->value;
1452                 rvtype = Tlabel;
1453                 break;
1454         }
1455
1456
1457 ### Variables
1458
1459 Variables are scoped named values.  We store the names in a linked list
1460 of "bindings" sorted in lexical order, and use sequential search and
1461 insertion sort.
1462
1463 ###### ast
1464
1465         struct binding {
1466                 struct text name;
1467                 struct binding *next;   // in lexical order
1468                 ## binding fields
1469         };
1470
1471 This linked list is stored in the parse context so that "reduce"
1472 functions can find or add variables, and so the analysis phase can
1473 ensure that every variable gets a type.
1474
1475 ###### parse context
1476
1477         struct binding *varlist;  // In lexical order
1478
1479 ###### ast functions
1480
1481         static struct binding *find_binding(struct parse_context *c, struct text s)
1482         {
1483                 struct binding **l = &c->varlist;
1484                 struct binding *n;
1485                 int cmp = 1;
1486
1487                 while (*l &&
1488                         (cmp = text_cmp((*l)->name, s)) < 0)
1489                                 l = & (*l)->next;
1490                 if (cmp == 0)
1491                         return *l;
1492                 n = calloc(1, sizeof(*n));
1493                 n->name = s;
1494                 n->next = *l;
1495                 *l = n;
1496                 return n;
1497         }
1498
1499 Each name can be linked to multiple variables defined in different
1500 scopes.  Each scope starts where the name is declared and continues
1501 until the end of the containing code block.  Scopes of a given name
1502 cannot nest, so a declaration while a name is in-scope is an error.
1503
1504 ###### binding fields
1505         struct variable *var;
1506
1507 ###### ast
1508         struct variable {
1509                 struct variable *previous;
1510                 struct type *type;
1511                 struct binding *name;
1512                 struct exec *where_decl;// where name was declared
1513                 struct exec *where_set; // where type was set
1514                 ## variable fields
1515         };
1516
1517 When a scope closes, the values of the variables might need to be freed.
1518 This happens in the context of some `struct exec` and each `exec` will
1519 need to know which variables need to be freed when it completes.
1520
1521 ####### exec fields
1522         struct variable *to_free;
1523
1524 ####### variable fields
1525         struct exec *cleanup_exec;
1526         struct variable *next_free;
1527
1528 ####### interp exec cleanup
1529         {
1530                 struct variable *v;
1531                 for (v = e->to_free; v; v = v->next_free) {
1532                         struct value *val = var_value(c, v);
1533                         free_value(v->type, val);
1534                 }
1535         }
1536
1537 ###### ast functions
1538         static void variable_unlink_exec(struct variable *v)
1539         {
1540                 struct variable **vp;
1541                 if (!v->cleanup_exec)
1542                         return;
1543                 for (vp = &v->cleanup_exec->to_free;
1544                     *vp; vp = &(*vp)->next_free) {
1545                         if (*vp != v)
1546                                 continue;
1547                         *vp = v->next_free;
1548                         v->cleanup_exec = NULL;
1549                         break;
1550                 }
1551         }
1552
1553 While the naming seems strange, we include local constants in the
1554 definition of variables.  A name declared `var := value` can
1555 subsequently be changed, but a name declared `var ::= value` cannot -
1556 it is constant
1557
1558 ###### variable fields
1559         int constant;
1560
1561 Scopes in parallel branches can be partially merged.  More
1562 specifically, if a given name is declared in both branches of an
1563 if/else then its scope is a candidate for merging.  Similarly if
1564 every branch of an exhaustive switch (e.g. has an "else" clause)
1565 declares a given name, then the scopes from the branches are
1566 candidates for merging.
1567
1568 Note that names declared inside a loop (which is only parallel to
1569 itself) are never visible after the loop.  Similarly names defined in
1570 scopes which are not parallel, such as those started by `for` and
1571 `switch`, are never visible after the scope.  Only variables defined in
1572 both `then` and `else` (including the implicit then after an `if`, and
1573 excluding `then` used with `for`) and in all `case`s and `else` of a
1574 `switch` or `while` can be visible beyond the `if`/`switch`/`while`.
1575
1576 Labels, which are a bit like variables, follow different rules.
1577 Labels are not explicitly declared, but if an undeclared name appears
1578 in a context where a label is legal, that effectively declares the
1579 name as a label.  The declaration remains in force (or in scope) at
1580 least to the end of the immediately containing block and conditionally
1581 in any larger containing block which does not declare the name in some
1582 other way.  Importantly, the conditional scope extension happens even
1583 if the label is only used in one parallel branch of a conditional --
1584 when used in one branch it is treated as having been declared in all
1585 branches.
1586
1587 Merge candidates are tentatively visible beyond the end of the
1588 branching statement which creates them.  If the name is used, the
1589 merge is affirmed and they become a single variable visible at the
1590 outer layer.  If not - if it is redeclared first - the merge lapses.
1591
1592 To track scopes we have an extra stack, implemented as a linked list,
1593 which roughly parallels the parse stack and which is used exclusively
1594 for scoping.  When a new scope is opened, a new frame is pushed and
1595 the child-count of the parent frame is incremented.  This child-count
1596 is used to distinguish between the first of a set of parallel scopes,
1597 in which declared variables must not be in scope, and subsequent
1598 branches, whether they may already be conditionally scoped.
1599
1600 We need a total ordering of scopes so we can easily compare to variables
1601 to see if they are concurrently in scope.  To achieve this we record a
1602 `scope_count` which is actually a count of both beginnings and endings
1603 of scopes.  Then each variable has a record of the scope count where it
1604 enters scope, and where it leaves.
1605
1606 To push a new frame *before* any code in the frame is parsed, we need a
1607 grammar reduction.  This is most easily achieved with a grammar
1608 element which derives the empty string, and creates the new scope when
1609 it is recognised.  This can be placed, for example, between a keyword
1610 like "if" and the code following it.
1611
1612 ###### ast
1613         struct scope {
1614                 struct scope *parent;
1615                 int child_count;
1616         };
1617
1618 ###### parse context
1619         int scope_depth;
1620         int scope_count;
1621         struct scope *scope_stack;
1622
1623 ###### variable fields
1624         int scope_start, scope_end;
1625
1626 ###### ast functions
1627         static void scope_pop(struct parse_context *c)
1628         {
1629                 struct scope *s = c->scope_stack;
1630
1631                 c->scope_stack = s->parent;
1632                 free(s);
1633                 c->scope_depth -= 1;
1634                 c->scope_count += 1;
1635         }
1636
1637         static void scope_push(struct parse_context *c)
1638         {
1639                 struct scope *s = calloc(1, sizeof(*s));
1640                 if (c->scope_stack)
1641                         c->scope_stack->child_count += 1;
1642                 s->parent = c->scope_stack;
1643                 c->scope_stack = s;
1644                 c->scope_depth += 1;
1645                 c->scope_count += 1;
1646         }
1647
1648 ###### Grammar
1649
1650         $void
1651         OpenScope -> ${ scope_push(c); }$
1652
1653 Each variable records a scope depth and is in one of four states:
1654
1655 - "in scope".  This is the case between the declaration of the
1656   variable and the end of the containing block, and also between
1657   the usage with affirms a merge and the end of that block.
1658
1659   The scope depth is not greater than the current parse context scope
1660   nest depth.  When the block of that depth closes, the state will
1661   change.  To achieve this, all "in scope" variables are linked
1662   together as a stack in nesting order.
1663
1664 - "pending".  The "in scope" block has closed, but other parallel
1665   scopes are still being processed.  So far, every parallel block at
1666   the same level that has closed has declared the name.
1667
1668   The scope depth is the depth of the last parallel block that
1669   enclosed the declaration, and that has closed.
1670
1671 - "conditionally in scope".  The "in scope" block and all parallel
1672   scopes have closed, and no further mention of the name has been seen.
1673   This state includes a secondary nest depth (`min_depth`) which records
1674   the outermost scope seen since the variable became conditionally in
1675   scope.  If a use of the name is found, the variable becomes "in scope"
1676   and that secondary depth becomes the recorded scope depth.  If the
1677   name is declared as a new variable, the old variable becomes "out of
1678   scope" and the recorded scope depth stays unchanged.
1679
1680 - "out of scope".  The variable is neither in scope nor conditionally
1681   in scope.  It is permanently out of scope now and can be removed from
1682   the "in scope" stack.  When a variable becomes out-of-scope it is
1683   moved to a separate list (`out_scope`) of variables which have fully
1684   known scope.  This will be used at the end of each function to assign
1685   each variable a place in the stack frame.
1686
1687 ###### variable fields
1688         int depth, min_depth;
1689         enum { OutScope, PendingScope, CondScope, InScope } scope;
1690         struct variable *in_scope;
1691
1692 ###### parse context
1693
1694         struct variable *in_scope;
1695         struct variable *out_scope;
1696
1697 All variables with the same name are linked together using the
1698 'previous' link.  Those variable that have been affirmatively merged all
1699 have a 'merged' pointer that points to one primary variable - the most
1700 recently declared instance.  When merging variables, we need to also
1701 adjust the 'merged' pointer on any other variables that had previously
1702 been merged with the one that will no longer be primary.
1703
1704 A variable that is no longer the most recent instance of a name may
1705 still have "pending" scope, if it might still be merged with most
1706 recent instance.  These variables don't really belong in the
1707 "in_scope" list, but are not immediately removed when a new instance
1708 is found.  Instead, they are detected and ignored when considering the
1709 list of in_scope names.
1710
1711 The storage of the value of a variable will be described later.  For now
1712 we just need to know that when a variable goes out of scope, it might
1713 need to be freed.  For this we need to be able to find it, so assume that
1714 `var_value()` will provide that.
1715
1716 ###### variable fields
1717         struct variable *merged;
1718
1719 ###### ast functions
1720
1721         static void variable_merge(struct variable *primary, struct variable *secondary)
1722         {
1723                 struct variable *v;
1724
1725                 primary = primary->merged;
1726
1727                 for (v = primary->previous; v; v=v->previous)
1728                         if (v == secondary || v == secondary->merged ||
1729                             v->merged == secondary ||
1730                             v->merged == secondary->merged) {
1731                                 v->scope = OutScope;
1732                                 v->merged = primary;
1733                                 if (v->scope_start < primary->scope_start)
1734                                         primary->scope_start = v->scope_start;
1735                                 if (v->scope_end > primary->scope_end)
1736                                         primary->scope_end = v->scope_end;      // NOTEST
1737                                 variable_unlink_exec(v);
1738                         }
1739         }
1740
1741 ###### forward decls
1742         static struct value *var_value(struct parse_context *c, struct variable *v);
1743
1744 ###### free global vars
1745
1746         while (context.varlist) {
1747                 struct binding *b = context.varlist;
1748                 struct variable *v = b->var;
1749                 context.varlist = b->next;
1750                 free(b);
1751                 while (v) {
1752                         struct variable *next = v->previous;
1753
1754                         if (v->global && v->frame_pos >= 0) {
1755                                 free_value(v->type, var_value(&context, v));
1756                                 if (v->depth == 0 && v->type->free == function_free)
1757                                         // This is a function constant
1758                                         free_exec(v->where_decl);
1759                         }
1760                         free(v);
1761                         v = next;
1762                 }
1763         }
1764
1765 #### Manipulating Bindings
1766
1767 When a name is conditionally visible, a new declaration discards the old
1768 binding - the condition lapses.  Similarly when we reach the end of a
1769 function (outermost non-global scope) any conditional scope must lapse.
1770 Conversely a usage of the name affirms the visibility and extends it to
1771 the end of the containing block - i.e.  the block that contains both the
1772 original declaration and the latest usage.  This is determined from
1773 `min_depth`.  When a conditionally visible variable gets affirmed like
1774 this, it is also merged with other conditionally visible variables with
1775 the same name.
1776
1777 When we parse a variable declaration we either report an error if the
1778 name is currently bound, or create a new variable at the current nest
1779 depth if the name is unbound or bound to a conditionally scoped or
1780 pending-scope variable.  If the previous variable was conditionally
1781 scoped, it and its homonyms becomes out-of-scope.
1782
1783 When we parse a variable reference (including non-declarative assignment
1784 "foo = bar") we report an error if the name is not bound or is bound to
1785 a pending-scope variable; update the scope if the name is bound to a
1786 conditionally scoped variable; or just proceed normally if the named
1787 variable is in scope.
1788
1789 When we exit a scope, any variables bound at this level are either
1790 marked out of scope or pending-scoped, depending on whether the scope
1791 was sequential or parallel.  Here a "parallel" scope means the "then"
1792 or "else" part of a conditional, or any "case" or "else" branch of a
1793 switch.  Other scopes are "sequential".
1794
1795 When exiting a parallel scope we check if there are any variables that
1796 were previously pending and are still visible. If there are, then
1797 they weren't redeclared in the most recent scope, so they cannot be
1798 merged and must become out-of-scope.  If it is not the first of
1799 parallel scopes (based on `child_count`), we check that there was a
1800 previous binding that is still pending-scope.  If there isn't, the new
1801 variable must now be out-of-scope.
1802
1803 When exiting a sequential scope that immediately enclosed parallel
1804 scopes, we need to resolve any pending-scope variables.  If there was
1805 no `else` clause, and we cannot determine that the `switch` was exhaustive,
1806 we need to mark all pending-scope variable as out-of-scope.  Otherwise
1807 all pending-scope variables become conditionally scoped.
1808
1809 ###### ast
1810         enum closetype { CloseSequential, CloseFunction, CloseParallel, CloseElse };
1811
1812 ###### ast functions
1813
1814         static struct variable *var_decl(struct parse_context *c, struct text s)
1815         {
1816                 struct binding *b = find_binding(c, s);
1817                 struct variable *v = b->var;
1818
1819                 switch (v ? v->scope : OutScope) {
1820                 case InScope:
1821                         /* Caller will report the error */
1822                         return NULL;
1823                 case CondScope:
1824                         for (;
1825                              v && v->scope == CondScope;
1826                              v = v->previous)
1827                                 v->scope = OutScope;
1828                         break;
1829                 default: break;
1830                 }
1831                 v = calloc(1, sizeof(*v));
1832                 v->previous = b->var;
1833                 b->var = v;
1834                 v->name = b;
1835                 v->merged = v;
1836                 v->min_depth = v->depth = c->scope_depth;
1837                 v->scope = InScope;
1838                 v->in_scope = c->in_scope;
1839                 v->scope_start = c->scope_count;
1840                 c->in_scope = v;
1841                 ## variable init
1842                 return v;
1843         }
1844
1845         static struct variable *var_ref(struct parse_context *c, struct text s)
1846         {
1847                 struct binding *b = find_binding(c, s);
1848                 struct variable *v = b->var;
1849                 struct variable *v2;
1850
1851                 switch (v ? v->scope : OutScope) {
1852                 case OutScope:
1853                 case PendingScope:
1854                         /* Caller will report the error */
1855                         return NULL;
1856                 case CondScope:
1857                         /* All CondScope variables of this name need to be merged
1858                          * and become InScope
1859                          */
1860                         v->depth = v->min_depth;
1861                         v->scope = InScope;
1862                         for (v2 = v->previous;
1863                              v2 && v2->scope == CondScope;
1864                              v2 = v2->previous)
1865                                 variable_merge(v, v2);
1866                         break;
1867                 case InScope:
1868                         break;
1869                 }
1870                 return v;
1871         }
1872
1873         static int var_refile(struct parse_context *c, struct variable *v)
1874         {
1875                 /* Variable just went out of scope.  Add it to the out_scope
1876                  * list, sorted by ->scope_start
1877                  */
1878                 struct variable **vp = &c->out_scope;
1879                 while ((*vp) && (*vp)->scope_start < v->scope_start)
1880                         vp = &(*vp)->in_scope;
1881                 v->in_scope = *vp;
1882                 *vp = v;
1883                 return 0;
1884         }
1885
1886         static void var_block_close(struct parse_context *c, enum closetype ct,
1887                                     struct exec *e)
1888         {
1889                 /* Close off all variables that are in_scope.
1890                  * Some variables in c->scope may already be not-in-scope,
1891                  * such as when a PendingScope variable is hidden by a new
1892                  * variable with the same name.
1893                  * So we check for v->name->var != v and drop them.
1894                  * If we choose to make a variable OutScope, we drop it
1895                  * immediately too.
1896                  */
1897                 struct variable *v, **vp, *v2;
1898
1899                 scope_pop(c);
1900                 for (vp = &c->in_scope;
1901                      (v = *vp) && v->min_depth > c->scope_depth;
1902                      (v->scope == OutScope || v->name->var != v)
1903                      ? (*vp =  v->in_scope, var_refile(c, v))
1904                      : ( vp = &v->in_scope, 0)) {
1905                         v->min_depth = c->scope_depth;
1906                         if (v->name->var != v)
1907                                 /* This is still in scope, but we haven't just
1908                                  * closed the scope.
1909                                  */
1910                                 continue;
1911                         v->min_depth = c->scope_depth;
1912                         if (v->scope == InScope)
1913                                 v->scope_end = c->scope_count;
1914                         if (v->scope == InScope && e && !v->global) {
1915                                 /* This variable gets cleaned up when 'e' finishes */
1916                                 variable_unlink_exec(v);
1917                                 v->cleanup_exec = e;
1918                                 v->next_free = e->to_free;
1919                                 e->to_free = v;
1920                         }
1921                         switch (ct) {
1922                         case CloseElse:
1923                         case CloseParallel: /* handle PendingScope */
1924                                 switch(v->scope) {
1925                                 case InScope:
1926                                 case CondScope:
1927                                         if (c->scope_stack->child_count == 1)
1928                                                 /* first among parallel branches */
1929                                                 v->scope = PendingScope;
1930                                         else if (v->previous &&
1931                                                  v->previous->scope == PendingScope)
1932                                                 /* all previous branches used name */
1933                                                 v->scope = PendingScope;
1934                                         else
1935                                                 v->scope = OutScope;
1936                                         if (ct == CloseElse) {
1937                                                 /* All Pending variables with this name
1938                                                  * are now Conditional */
1939                                                 for (v2 = v;
1940                                                      v2 && v2->scope == PendingScope;
1941                                                      v2 = v2->previous)
1942                                                         v2->scope = CondScope;
1943                                         }
1944                                         break;
1945                                 case PendingScope:
1946                                         /* Not possible as it would require
1947                                          * parallel scope to be nested immediately
1948                                          * in a parallel scope, and that never
1949                                          * happens.
1950                                          */                     // NOTEST
1951                                 case OutScope:
1952                                         /* Not possible as we already tested for
1953                                          * OutScope
1954                                          */
1955                                         abort();                // NOTEST
1956                                 }
1957                                 break;
1958                         case CloseFunction:
1959                                 if (v->scope == CondScope)
1960                                         /* Condition cannot continue past end of function */
1961                                         v->scope = InScope;
1962                                 /* fallthrough */
1963                         case CloseSequential:
1964                                 switch (v->scope) {
1965                                 case InScope:
1966                                         v->scope = OutScope;
1967                                         break;
1968                                 case PendingScope:
1969                                         /* There was no 'else', so we can only become
1970                                          * conditional if we know the cases were exhaustive,
1971                                          * and that doesn't mean anything yet.
1972                                          * So only labels become conditional..
1973                                          */
1974                                         for (v2 = v;
1975                                              v2 && v2->scope == PendingScope;
1976                                              v2 = v2->previous)
1977                                                 v2->scope = OutScope;
1978                                         break;
1979                                 case CondScope:
1980                                 case OutScope: break;
1981                                 }
1982                                 break;
1983                         }
1984                 }
1985         }
1986
1987 #### Storing Values
1988
1989 The value of a variable is store separately from the variable, on an
1990 analogue of a stack frame.  There are (currently) two frames that can be
1991 active.  A global frame which currently only stores constants, and a
1992 stacked frame which stores local variables.  Each variable knows if it
1993 is global or not, and what its index into the frame is.
1994
1995 Values in the global frame are known immediately they are relevant, so
1996 the frame needs to be reallocated as it grows so it can store those
1997 values.  The local frame doesn't get values until the interpreted phase
1998 is started, so there is no need to allocate until the size is known.
1999
2000 We initialize the `frame_pos` to an impossible value, so that we can
2001 tell if it was set or not later.
2002
2003 ###### variable fields
2004         short frame_pos;
2005         short global;
2006
2007 ###### variable init
2008         v->frame_pos = -1;
2009
2010 ###### parse context
2011
2012         short global_size, global_alloc;
2013         short local_size;
2014         void *global, *local;
2015
2016 ###### forward decls
2017         static struct value *global_alloc(struct parse_context *c, struct type *t,
2018                                           struct variable *v, struct value *init);
2019
2020 ###### ast functions
2021
2022         static struct value *var_value(struct parse_context *c, struct variable *v)
2023         {
2024                 if (!v->global) {
2025                         if (!c->local || !v->type)
2026                                 return NULL;    // UNTESTED
2027                         if (v->frame_pos + v->type->size > c->local_size) {
2028                                 printf("INVALID frame_pos\n");  // NOTEST
2029                                 exit(2);                        // NOTEST
2030                         }
2031                         return c->local + v->frame_pos;
2032                 }
2033                 if (c->global_size > c->global_alloc) {
2034                         int old = c->global_alloc;
2035                         c->global_alloc = (c->global_size | 1023) + 1024;
2036                         c->global = realloc(c->global, c->global_alloc);
2037                         memset(c->global + old, 0, c->global_alloc - old);
2038                 }
2039                 return c->global + v->frame_pos;
2040         }
2041
2042         static struct value *global_alloc(struct parse_context *c, struct type *t,
2043                                           struct variable *v, struct value *init)
2044         {
2045                 struct value *ret;
2046                 struct variable scratch;
2047
2048                 if (t->prepare_type)
2049                         t->prepare_type(c, t, 1);       // NOTEST
2050
2051                 if (c->global_size & (t->align - 1))
2052                         c->global_size = (c->global_size + t->align) & ~(t->align-1);   // NOTEST
2053                 if (!v) {
2054                         v = &scratch;
2055                         v->type = t;
2056                 }
2057                 v->frame_pos = c->global_size;
2058                 v->global = 1;
2059                 c->global_size += v->type->size;
2060                 ret = var_value(c, v);
2061                 if (init)
2062                         memcpy(ret, init, t->size);
2063                 else
2064                         val_init(t, ret);       // NOTEST
2065                 return ret;
2066         }
2067
2068 As global values are found -- struct field initializers, labels etc --
2069 `global_alloc()` is called to record the value in the global frame.
2070
2071 When the program is fully parsed, each function is analysed, we need to
2072 walk the list of variables local to that function and assign them an
2073 offset in the stack frame.  For this we have `scope_finalize()`.
2074
2075 We keep the stack from dense by re-using space for between variables
2076 that are not in scope at the same time.  The `out_scope` list is sorted
2077 by `scope_start` and as we process a varible, we move it to an FIFO
2078 stack.  For each variable we consider, we first discard any from the
2079 stack anything that went out of scope before the new variable came in.
2080 Then we place the new variable just after the one at the top of the
2081 stack.
2082
2083 ###### ast functions
2084
2085         static void scope_finalize(struct parse_context *c, struct type *ft)
2086         {
2087                 int size = ft->function.local_size;
2088                 struct variable *next = ft->function.scope;
2089                 struct variable *done = NULL;
2090
2091                 while (next) {
2092                         struct variable *v = next;
2093                         struct type *t = v->type;
2094                         int pos;
2095                         next = v->in_scope;
2096                         if (v->merged != v)
2097                                 continue;
2098                         if (!t)
2099                                 continue;
2100                         if (v->frame_pos >= 0)
2101                                 continue;
2102                         while (done && done->scope_end < v->scope_start)
2103                                 done = done->in_scope;
2104                         if (done)
2105                                 pos = done->frame_pos + done->type->size;
2106                         else
2107                                 pos = ft->function.local_size;
2108                         if (pos & (t->align - 1))
2109                                 pos = (pos + t->align) & ~(t->align-1);
2110                         v->frame_pos = pos;
2111                         if (size < pos + v->type->size)
2112                                 size = pos + v->type->size;
2113                         v->in_scope = done;
2114                         done = v;
2115                 }
2116                 c->out_scope = NULL;
2117                 ft->function.local_size = size;
2118         }
2119
2120 ###### free context storage
2121         free(context.global);
2122
2123 #### Variables as executables
2124
2125 Just as we used a `val` to wrap a value into an `exec`, we similarly
2126 need a `var` to wrap a `variable` into an exec.  While each `val`
2127 contained a copy of the value, each `var` holds a link to the variable
2128 because it really is the same variable no matter where it appears.
2129 When a variable is used, we need to remember to follow the `->merged`
2130 link to find the primary instance.
2131
2132 When a variable is declared, it may or may not be given an explicit
2133 type.  We need to record which so that we can report the parsed code
2134 correctly.
2135
2136 ###### exec type
2137         Xvar,
2138
2139 ###### ast
2140         struct var {
2141                 struct exec;
2142                 struct variable *var;
2143         };
2144
2145 ###### variable fields
2146         int explicit_type;
2147
2148 ###### Grammar
2149
2150         $TERM : ::
2151
2152         $*var
2153         VariableDecl -> IDENTIFIER : ${ {
2154                 struct variable *v = var_decl(c, $1.txt);
2155                 $0 = new_pos(var, $1);
2156                 $0->var = v;
2157                 if (v)
2158                         v->where_decl = $0;
2159                 else {
2160                         v = var_ref(c, $1.txt);
2161                         $0->var = v;
2162                         type_err(c, "error: variable '%v' redeclared",
2163                                  $0, NULL, 0, NULL);
2164                         type_err(c, "info: this is where '%v' was first declared",
2165                                  v->where_decl, NULL, 0, NULL);
2166                 }
2167         } }$
2168         | IDENTIFIER :: ${ {
2169                 struct variable *v = var_decl(c, $1.txt);
2170                 $0 = new_pos(var, $1);
2171                 $0->var = v;
2172                 if (v) {
2173                         v->where_decl = $0;
2174                         v->constant = 1;
2175                 } else {
2176                         v = var_ref(c, $1.txt);
2177                         $0->var = v;
2178                         type_err(c, "error: variable '%v' redeclared",
2179                                  $0, NULL, 0, NULL);
2180                         type_err(c, "info: this is where '%v' was first declared",
2181                                  v->where_decl, NULL, 0, NULL);
2182                 }
2183         } }$
2184         | IDENTIFIER : Type ${ {
2185                 struct variable *v = var_decl(c, $1.txt);
2186                 $0 = new_pos(var, $1);
2187                 $0->var = v;
2188                 if (v) {
2189                         v->where_decl = $0;
2190                         v->where_set = $0;
2191                         v->type = $<Type;
2192                         v->explicit_type = 1;
2193                 } else {
2194                         v = var_ref(c, $1.txt);
2195                         $0->var = v;
2196                         type_err(c, "error: variable '%v' redeclared",
2197                                  $0, NULL, 0, NULL);
2198                         type_err(c, "info: this is where '%v' was first declared",
2199                                  v->where_decl, NULL, 0, NULL);
2200                 }
2201         } }$
2202         | IDENTIFIER :: Type ${ {
2203                 struct variable *v = var_decl(c, $1.txt);
2204                 $0 = new_pos(var, $1);
2205                 $0->var = v;
2206                 if (v) {
2207                         v->where_decl = $0;
2208                         v->where_set = $0;
2209                         v->type = $<Type;
2210                         v->constant = 1;
2211                         v->explicit_type = 1;
2212                 } else {
2213                         v = var_ref(c, $1.txt);
2214                         $0->var = v;
2215                         type_err(c, "error: variable '%v' redeclared",
2216                                  $0, NULL, 0, NULL);
2217                         type_err(c, "info: this is where '%v' was first declared",
2218                                  v->where_decl, NULL, 0, NULL);
2219                 }
2220         } }$
2221
2222         $*exec
2223         Variable -> IDENTIFIER ${ {
2224                 struct variable *v = var_ref(c, $1.txt);
2225                 $0 = new_pos(var, $1);
2226                 if (v == NULL) {
2227                         /* This might be a global const or a label
2228                          * Allocate a var with impossible type Tnone,
2229                          * which will be adjusted when we find out what it is,
2230                          * or will trigger an error.
2231                          */
2232                         v = var_decl(c, $1.txt);
2233                         if (v) {
2234                                 v->type = Tnone;
2235                                 v->where_decl = $0;
2236                                 v->where_set = $0;
2237                         }
2238                 }
2239                 cast(var, $0)->var = v;
2240         } }$
2241
2242 ###### print exec cases
2243         case Xvar:
2244         {
2245                 struct var *v = cast(var, e);
2246                 if (v->var) {
2247                         struct binding *b = v->var->name;
2248                         printf("%.*s", b->name.len, b->name.txt);
2249                 }
2250                 break;
2251         }
2252
2253 ###### format cases
2254         case 'v':
2255                 if (loc && loc->type == Xvar) {
2256                         struct var *v = cast(var, loc);
2257                         if (v->var) {
2258                                 struct binding *b = v->var->name;
2259                                 fprintf(stderr, "%.*s", b->name.len, b->name.txt);
2260                         } else
2261                                 fputs("???", stderr);   // NOTEST
2262                 } else
2263                         fputs("NOTVAR", stderr);        // NOTEST
2264                 break;
2265
2266 ###### propagate exec cases
2267
2268         case Xvar:
2269         {
2270                 struct var *var = cast(var, prog);
2271                 struct variable *v = var->var;
2272                 if (!v) {
2273                         type_err(c, "%d:BUG: no variable!!", prog, NULL, 0, NULL); // NOTEST
2274                         return Tnone;                                   // NOTEST
2275                 }
2276                 v = v->merged;
2277                 if (v->type == Tnone && v->where_decl == prog)
2278                         type_err(c, "error: variable used but not declared: %v",
2279                                  prog, NULL, 0, NULL);
2280                 if (v->type == NULL) {
2281                         if (type && !(*perr & Efail)) {
2282                                 v->type = type;
2283                                 v->where_set = prog;
2284                                 *perr |= Eretry;
2285                         }
2286                 } else if (!type_compat(type, v->type, rules)) {
2287                         type_err(c, "error: expected %1 but variable '%v' is %2", prog,
2288                                  type, rules, v->type);
2289                         type_err(c, "info: this is where '%v' was set to %1", v->where_set,
2290                                  v->type, rules, NULL);
2291                 }
2292                 if (!v->global || v->frame_pos < 0)
2293                         *perr |= Eruntime;
2294                 if (v->constant)
2295                         *perr |= Econst;
2296                 if (!type)
2297                         return v->type;
2298                 return type;
2299         }
2300
2301 ###### interp exec cases
2302         case Xvar:
2303         {
2304                 struct var *var = cast(var, e);
2305                 struct variable *v = var->var;
2306
2307                 v = v->merged;
2308                 lrv = var_value(c, v);
2309                 rvtype = v->type;
2310                 break;
2311         }
2312
2313 ###### ast functions
2314
2315         static void free_var(struct var *v)
2316         {
2317                 free(v);
2318         }
2319
2320 ###### free exec cases
2321         case Xvar: free_var(cast(var, e)); break;
2322
2323
2324 ### Complex types
2325
2326 Now that we have the shape of the interpreter in place we can add some
2327 complex types and connected them in to the data structures and the
2328 different phases of parse, analyse, print, interpret.
2329
2330 Being "complex" the language will naturally have syntax to access
2331 specifics of objects of these types.  These will fit into the grammar as
2332 "Terms" which are the things that are combined with various operators to
2333 form "Expression".  Where a Term is formed by some operation on another
2334 Term, the subordinate Term will always come first, so for example a
2335 member of an array will be expressed as the Term for the array followed
2336 by an index in square brackets.  The strict rule of using postfix
2337 operations makes precedence irrelevant within terms.  To provide a place
2338 to put the grammar for each terms of each type, we will start out by
2339 introducing the "Term" grammar production, with contains at least a
2340 simple "Value" (to be explained later).
2341
2342 ###### Grammar
2343         $*exec
2344         Term ->  Value ${ $0 = $<1; }$
2345         | Variable ${ $0 = $<1; }$
2346         ## term grammar
2347
2348 Thus far the complex types we have are arrays and structs.
2349
2350 #### Arrays
2351
2352 Arrays can be declared by giving a size and a type, as `[size]type' so
2353 `freq:[26]number` declares `freq` to be an array of 26 numbers.  The
2354 size can be either a literal number, or a named constant.  Some day an
2355 arbitrary expression will be supported.
2356
2357 As a formal parameter to a function, the array can be declared with a
2358 new variable as the size: `name:[size::number]string`.  The `size`
2359 variable is set to the size of the array and must be a constant.  As
2360 `number` is the only supported type, it can be left out:
2361 `name:[size::]string`.
2362
2363 Arrays cannot be assigned.  When pointers are introduced we will also
2364 introduce array slices which can refer to part or all of an array -
2365 the assignment syntax will create a slice.  For now, an array can only
2366 ever be referenced by the name it is declared with.  It is likely that
2367 a "`copy`" primitive will eventually be define which can be used to
2368 make a copy of an array with controllable recursive depth.
2369
2370 For now we have two sorts of array, those with fixed size either because
2371 it is given as a literal number or because it is a struct member (which
2372 cannot have a runtime-changing size), and those with a size that is
2373 determined at runtime - local variables with a const size.  The former
2374 have their size calculated at parse time, the latter at run time.
2375
2376 For the latter type, the `size` field of the type is the size of a
2377 pointer, and the array is reallocated every time it comes into scope.
2378
2379 We differentiate struct fields with a const size from local variables
2380 with a const size by whether they are prepared at parse time or not.
2381
2382 ###### type union fields
2383
2384         struct {
2385                 int unspec;     // size is unspecified - vsize must be set.
2386                 short size;
2387                 short static_size;
2388                 struct variable *vsize;
2389                 struct type *member;
2390         } array;
2391
2392 ###### value union fields
2393         void *array;  // used if not static_size
2394
2395 ###### value functions
2396
2397         static int array_prepare_type(struct parse_context *c, struct type *type,
2398                                        int parse_time)
2399         {
2400                 struct value *vsize;
2401                 mpz_t q;
2402                 if (type->array.static_size)
2403                         return 1;       // UNTESTED
2404                 if (type->array.unspec && parse_time)
2405                         return 1;       // UNTESTED
2406                 if (parse_time && type->array.vsize && !type->array.vsize->global)
2407                         return 1;       // UNTESTED
2408
2409                 if (type->array.vsize) {
2410                         vsize = var_value(c, type->array.vsize);
2411                         if (!vsize)
2412                                 return 1;       // UNTESTED
2413                         mpz_init(q);
2414                         mpz_tdiv_q(q, mpq_numref(vsize->num), mpq_denref(vsize->num));
2415                         type->array.size = mpz_get_si(q);
2416                         mpz_clear(q);
2417                 }
2418                 if (!parse_time)
2419                         return 1;
2420                 if (type->array.member->size <= 0)
2421                         return 0;       // UNTESTED
2422
2423                 type->array.static_size = 1;
2424                 type->size = type->array.size * type->array.member->size;
2425                 type->align = type->array.member->align;
2426
2427                 return 1;
2428         }
2429
2430         static void array_init(struct type *type, struct value *val)
2431         {
2432                 int i;
2433                 void *ptr = val->ptr;
2434
2435                 if (!val)
2436                         return;                         // NOTEST
2437                 if (!type->array.static_size) {
2438                         val->array = calloc(type->array.size,
2439                                             type->array.member->size);
2440                         ptr = val->array;
2441                 }
2442                 for (i = 0; i < type->array.size; i++) {
2443                         struct value *v;
2444                         v = (void*)ptr + i * type->array.member->size;
2445                         val_init(type->array.member, v);
2446                 }
2447         }
2448
2449         static void array_free(struct type *type, struct value *val)
2450         {
2451                 int i;
2452                 void *ptr = val->ptr;
2453
2454                 if (!type->array.static_size)
2455                         ptr = val->array;
2456                 for (i = 0; i < type->array.size; i++) {
2457                         struct value *v;
2458                         v = (void*)ptr + i * type->array.member->size;
2459                         free_value(type->array.member, v);
2460                 }
2461                 if (!type->array.static_size)
2462                         free(ptr);
2463         }
2464
2465         static int array_compat(struct type *require, struct type *have,
2466                                 enum val_rules rules)
2467         {
2468                 if (have->compat != require->compat)
2469                         return 0;
2470                 /* Both are arrays, so we can look at details */
2471                 if (!type_compat(require->array.member, have->array.member, 0))
2472                         return 0;
2473                 if (have->array.unspec && require->array.unspec) {
2474                         if (have->array.vsize && require->array.vsize &&
2475                             have->array.vsize != require->array.vsize)  // UNTESTED
2476                                 /* sizes might not be the same */
2477                                 return 0;       // UNTESTED
2478                         return 1;
2479                 }
2480                 if (have->array.unspec || require->array.unspec)
2481                         return 1;       // UNTESTED
2482                 if (require->array.vsize == NULL && have->array.vsize == NULL)
2483                         return require->array.size == have->array.size;
2484
2485                 return require->array.vsize == have->array.vsize;       // UNTESTED
2486         }
2487
2488         static void array_print_type(struct type *type, FILE *f)
2489         {
2490                 fputs("[", f);
2491                 if (type->array.vsize) {
2492                         struct binding *b = type->array.vsize->name;
2493                         fprintf(f, "%.*s%s]", b->name.len, b->name.txt,
2494                                 type->array.unspec ? "::" : "");
2495                 } else if (type->array.size)
2496                         fprintf(f, "%d]", type->array.size);
2497                 else
2498                         fprintf(f, "]");
2499                 type_print(type->array.member, f);
2500         }
2501
2502         static struct type array_prototype = {
2503                 .init = array_init,
2504                 .prepare_type = array_prepare_type,
2505                 .print_type = array_print_type,
2506                 .compat = array_compat,
2507                 .free = array_free,
2508                 .size = sizeof(void*),
2509                 .align = sizeof(void*),
2510         };
2511
2512 ###### declare terminals
2513         $TERM [ ]
2514
2515 ###### type grammar
2516
2517         | [ NUMBER ] Type ${ {
2518                 char tail[3];
2519                 mpq_t num;
2520                 struct type *t;
2521                 int elements = 0;
2522
2523                 if (number_parse(num, tail, $2.txt) == 0)
2524                         tok_err(c, "error: unrecognised number", &$2);
2525                 else if (tail[0]) {
2526                         tok_err(c, "error: unsupported number suffix", &$2);
2527                         mpq_clear(num);
2528                 } else {
2529                         elements = mpz_get_ui(mpq_numref(num));
2530                         if (mpz_cmp_ui(mpq_denref(num), 1) != 0) {
2531                                 tok_err(c, "error: array size must be an integer",
2532                                         &$2);
2533                         } else if (mpz_cmp_ui(mpq_numref(num), 1UL << 30) >= 0)
2534                                 tok_err(c, "error: array size is too large",
2535                                         &$2);
2536                         mpq_clear(num);
2537                 }
2538
2539                 $0 = t = add_anon_type(c, &array_prototype, "array[%d]", elements );
2540                 t->array.size = elements;
2541                 t->array.member = $<4;
2542                 t->array.vsize = NULL;
2543         } }$
2544
2545         | [ IDENTIFIER ] Type ${ {
2546                 struct variable *v = var_ref(c, $2.txt);
2547
2548                 if (!v)
2549                         tok_err(c, "error: name undeclared", &$2);
2550                 else if (!v->constant)
2551                         tok_err(c, "error: array size must be a constant", &$2);
2552
2553                 $0 = add_anon_type(c, &array_prototype, "array[%.*s]", $2.txt.len, $2.txt.txt);
2554                 $0->array.member = $<4;
2555                 $0->array.size = 0;
2556                 $0->array.vsize = v;
2557         } }$
2558
2559 ###### Grammar
2560         $*type
2561         OptType -> Type ${ $0 = $<1; }$
2562                 | ${ $0 = NULL; }$
2563
2564 ###### formal type grammar
2565
2566         | [ IDENTIFIER :: OptType ] Type ${ {
2567                 struct variable *v = var_decl(c, $ID.txt);
2568
2569                 v->type = $<OT;
2570                 v->constant = 1;
2571                 if (!v->type)
2572                         v->type = Tnum;
2573                 $0 = add_anon_type(c, &array_prototype, "array[var]");
2574                 $0->array.member = $<6;
2575                 $0->array.size = 0;
2576                 $0->array.unspec = 1;
2577                 $0->array.vsize = v;
2578         } }$
2579
2580 ###### Binode types
2581         Index,
2582
2583 ###### term grammar
2584
2585         | Term [ Expression ] ${ {
2586                 struct binode *b = new(binode);
2587                 b->op = Index;
2588                 b->left = $<1;
2589                 b->right = $<3;
2590                 $0 = b;
2591         } }$
2592
2593 ###### print binode cases
2594         case Index:
2595                 print_exec(b->left, -1, bracket);
2596                 printf("[");
2597                 print_exec(b->right, -1, bracket);
2598                 printf("]");
2599                 break;
2600
2601 ###### propagate binode cases
2602         case Index:
2603                 /* left must be an array, right must be a number,
2604                  * result is the member type of the array
2605                  */
2606                 propagate_types(b->right, c, perr_local, Tnum, 0);
2607                 t = propagate_types(b->left, c, perr, NULL, 0);
2608                 if (!t || t->compat != array_compat) {
2609                         type_err(c, "error: %1 cannot be indexed", prog, t, 0, NULL);
2610                         return NULL;
2611                 } else {
2612                         if (!type_compat(type, t->array.member, rules)) {
2613                                 type_err(c, "error: have %1 but need %2", prog,
2614                                          t->array.member, rules, type);
2615                         }
2616                         return t->array.member;
2617                 }
2618                 break;
2619
2620 ###### interp binode cases
2621         case Index: {
2622                 mpz_t q;
2623                 long i;
2624                 void *ptr;
2625
2626                 lleft = linterp_exec(c, b->left, &ltype);
2627                 right = interp_exec(c, b->right, &rtype);
2628                 mpz_init(q);
2629                 mpz_tdiv_q(q, mpq_numref(right.num), mpq_denref(right.num));
2630                 i = mpz_get_si(q);
2631                 mpz_clear(q);
2632
2633                 if (ltype->array.static_size)
2634                         ptr = lleft;
2635                 else
2636                         ptr = *(void**)lleft;
2637                 rvtype = ltype->array.member;
2638                 if (i >= 0 && i < ltype->array.size)
2639                         lrv = ptr + i * rvtype->size;
2640                 else
2641                         val_init(ltype->array.member, &rv); // UNSAFE
2642                 ltype = NULL;
2643                 break;
2644         }
2645
2646 #### Structs
2647
2648 A `struct` is a data-type that contains one or more other data-types.
2649 It differs from an array in that each member can be of a different
2650 type, and they are accessed by name rather than by number.  Thus you
2651 cannot choose an element by calculation, you need to know what you
2652 want up-front.
2653
2654 The language makes no promises about how a given structure will be
2655 stored in memory - it is free to rearrange fields to suit whatever
2656 criteria seems important.
2657
2658 Structs are declared separately from program code - they cannot be
2659 declared in-line in a variable declaration like arrays can.  A struct
2660 is given a name and this name is used to identify the type - the name
2661 is not prefixed by the word `struct` as it would be in C.
2662
2663 Structs are only treated as the same if they have the same name.
2664 Simply having the same fields in the same order is not enough.  This
2665 might change once we can create structure initializers from a list of
2666 values.
2667
2668 Each component datum is identified much like a variable is declared,
2669 with a name, one or two colons, and a type.  The type cannot be omitted
2670 as there is no opportunity to deduce the type from usage.  An initial
2671 value can be given following an equals sign, so
2672
2673 ##### Example: a struct type
2674
2675         struct complex:
2676                 x:number = 0
2677                 y:number = 0
2678
2679 would declare a type called "complex" which has two number fields,
2680 each initialised to zero.
2681
2682 Struct will need to be declared separately from the code that uses
2683 them, so we will need to be able to print out the declaration of a
2684 struct when reprinting the whole program.  So a `print_type_decl` type
2685 function will be needed.
2686
2687 ###### type union fields
2688
2689         struct {
2690                 int nfields;
2691                 struct field {
2692                         struct text name;
2693                         struct type *type;
2694                         struct value *init;
2695                         int offset;
2696                 } *fields; // This is created when field_list is analysed.
2697                 struct fieldlist {
2698                         struct fieldlist *prev;
2699                         struct field f;
2700                         struct exec *init;
2701                 } *field_list; // This is created during parsing
2702         } structure;
2703
2704 ###### type functions
2705         void (*print_type_decl)(struct type *type, FILE *f);
2706         struct type *(*fieldref)(struct type *t, struct parse_context *c,
2707                                  struct fieldref *f, struct value **vp);
2708
2709 ###### value functions
2710
2711         static void structure_init(struct type *type, struct value *val)
2712         {
2713                 int i;
2714
2715                 for (i = 0; i < type->structure.nfields; i++) {
2716                         struct value *v;
2717                         v = (void*) val->ptr + type->structure.fields[i].offset;
2718                         if (type->structure.fields[i].init)
2719                                 dup_value(type->structure.fields[i].type,
2720                                           type->structure.fields[i].init,
2721                                           v);
2722                         else
2723                                 val_init(type->structure.fields[i].type, v);
2724                 }
2725         }
2726
2727         static void structure_free(struct type *type, struct value *val)
2728         {
2729                 int i;
2730
2731                 for (i = 0; i < type->structure.nfields; i++) {
2732                         struct value *v;
2733                         v = (void*)val->ptr + type->structure.fields[i].offset;
2734                         free_value(type->structure.fields[i].type, v);
2735                 }
2736         }
2737
2738         static void free_fieldlist(struct fieldlist *f)
2739         {
2740                 if (!f)
2741                         return;
2742                 free_fieldlist(f->prev);
2743                 free_exec(f->init);
2744                 free(f);
2745         }
2746
2747         static void structure_free_type(struct type *t)
2748         {
2749                 int i;
2750                 for (i = 0; i < t->structure.nfields; i++)
2751                         if (t->structure.fields[i].init) {
2752                                 free_value(t->structure.fields[i].type,
2753                                            t->structure.fields[i].init);
2754                         }
2755                 free(t->structure.fields);
2756                 free_fieldlist(t->structure.field_list);
2757         }
2758
2759         static int structure_prepare_type(struct parse_context *c,
2760                                           struct type *t, int parse_time)
2761         {
2762                 int cnt = 0;
2763                 struct fieldlist *f;
2764
2765                 if (!parse_time || t->structure.fields)
2766                         return 1;
2767
2768                 for (f = t->structure.field_list; f; f=f->prev) {
2769                         enum prop_err perr;
2770                         cnt += 1;
2771
2772                         if (f->f.type->size <= 0)
2773                                 return 0;
2774                         if (f->f.type->prepare_type)
2775                                 f->f.type->prepare_type(c, f->f.type, parse_time);
2776
2777                         if (f->init == NULL)
2778                                 continue;
2779                         do {
2780                                 perr = 0;
2781                                 propagate_types(f->init, c, &perr, f->f.type, 0);
2782                         } while (perr & Eretry);
2783                         if (perr & Efail)
2784                                 c->parse_error += 1;    // NOTEST
2785                 }
2786
2787                 t->structure.nfields = cnt;
2788                 t->structure.fields = calloc(cnt, sizeof(struct field));
2789                 f = t->structure.field_list;
2790                 while (cnt > 0) {
2791                         int a = f->f.type->align;
2792                         cnt -= 1;
2793                         t->structure.fields[cnt] = f->f;
2794                         if (t->size & (a-1))
2795                                 t->size = (t->size | (a-1)) + 1;
2796                         t->structure.fields[cnt].offset = t->size;
2797                         t->size += ((f->f.type->size - 1) | (a-1)) + 1;
2798                         if (a > t->align)
2799                                 t->align = a;
2800
2801                         if (f->init && !c->parse_error) {
2802                                 struct value vl = interp_exec(c, f->init, NULL);
2803                                 t->structure.fields[cnt].init =
2804                                         global_alloc(c, f->f.type, NULL, &vl);
2805                         }
2806
2807                         f = f->prev;
2808                 }
2809                 return 1;
2810         }
2811
2812         static int find_struct_index(struct type *type, struct text field)
2813         {
2814                 int i;
2815                 for (i = 0; i < type->structure.nfields; i++)
2816                         if (text_cmp(type->structure.fields[i].name, field) == 0)
2817                                 return i;
2818                 return IndexInvalid;
2819         }
2820
2821         static struct type *structure_fieldref(struct type *t, struct parse_context *c,
2822                                                struct fieldref *f, struct value **vp)
2823         {
2824                 if (f->index == IndexUnknown) {
2825                         f->index = find_struct_index(t, f->name);
2826                         if (f->index < 0)
2827                                 type_err(c, "error: cannot find requested field in %1",
2828                                          f->left, t, 0, NULL);
2829                 }
2830                 if (f->index < 0)
2831                         return NULL;
2832                 if (vp) {
2833                         struct value *v = *vp;
2834                         v = (void*)v->ptr + t->structure.fields[f->index].offset;
2835                         *vp = v;
2836                 }
2837                 return t->structure.fields[f->index].type;
2838         }
2839
2840         static struct type structure_prototype = {
2841                 .init = structure_init,
2842                 .free = structure_free,
2843                 .free_type = structure_free_type,
2844                 .print_type_decl = structure_print_type,
2845                 .prepare_type = structure_prepare_type,
2846                 .fieldref = structure_fieldref,
2847         };
2848
2849 ###### exec type
2850         Xfieldref,
2851
2852 ###### ast
2853         struct fieldref {
2854                 struct exec;
2855                 struct exec *left;
2856                 int index;
2857                 struct text name;
2858         };
2859         enum { IndexUnknown = -1, IndexInvalid = -2 };
2860
2861 ###### free exec cases
2862         case Xfieldref:
2863                 free_exec(cast(fieldref, e)->left);
2864                 free(e);
2865                 break;
2866
2867 ###### declare terminals
2868         $TERM struct
2869
2870 ###### term grammar
2871
2872         | Term . IDENTIFIER ${ {
2873                 struct fieldref *fr = new_pos(fieldref, $2);
2874                 fr->left = $<1;
2875                 fr->name = $3.txt;
2876                 fr->index = IndexUnknown;
2877                 $0 = fr;
2878         } }$
2879
2880 ###### print exec cases
2881
2882         case Xfieldref:
2883         {
2884                 struct fieldref *f = cast(fieldref, e);
2885                 print_exec(f->left, -1, bracket);
2886                 printf(".%.*s", f->name.len, f->name.txt);
2887                 break;
2888         }
2889
2890 ###### propagate exec cases
2891
2892         case Xfieldref:
2893         {
2894                 struct fieldref *f = cast(fieldref, prog);
2895                 struct type *st = propagate_types(f->left, c, perr, NULL, 0);
2896
2897                 if (!st || !st->fieldref)
2898                         type_err(c, "error: field reference on %1 is not supported",
2899                                  f->left, st, 0, NULL);
2900                 else {
2901                         t = st->fieldref(st, c, f, NULL);
2902                         if (t && !type_compat(type, t, rules))
2903                                 type_err(c, "error: have %1 but need %2", prog,
2904                                          t, rules, type);
2905                         return t;
2906                 }
2907                 break;
2908         }
2909
2910 ###### interp exec cases
2911         case Xfieldref:
2912         {
2913                 struct fieldref *f = cast(fieldref, e);
2914                 struct type *ltype;
2915                 struct value *lleft = linterp_exec(c, f->left, &ltype);
2916                 lrv = lleft;
2917                 rvtype = ltype->fieldref(ltype, c, f, &lrv);
2918                 break;
2919         }
2920
2921 ###### top level grammar
2922         DeclareStruct -> struct IDENTIFIER FieldBlock Newlines ${ {
2923                 struct type *t;
2924                 t = find_type(c, $ID.txt);
2925                 if (!t)
2926                         t = add_type(c, $ID.txt, &structure_prototype);
2927                 else if (t->size >= 0) {
2928                         tok_err(c, "error: type already declared", &$ID);
2929                         tok_err(c, "info: this is location of declartion", &t->first_use);
2930                         /* Create a new one - duplicate */
2931                         t = add_type(c, $ID.txt, &structure_prototype);
2932                 } else {
2933                         struct type tmp = *t;
2934                         *t = structure_prototype;
2935                         t->name = tmp.name;
2936                         t->next = tmp.next;
2937                 }
2938                 t->structure.field_list = $<FB;
2939                 t->first_use = $ID;
2940         } }$
2941
2942         $*fieldlist
2943         FieldBlock -> { IN OptNL FieldLines OUT OptNL } ${ $0 = $<FL; }$
2944         | { SimpleFieldList } ${ $0 = $<SFL; }$
2945         | IN OptNL FieldLines OUT ${ $0 = $<FL; }$
2946         | SimpleFieldList EOL ${ $0 = $<SFL; }$
2947
2948         FieldLines -> SimpleFieldList Newlines ${ $0 = $<SFL; }$
2949         | FieldLines SimpleFieldList Newlines ${
2950                 $SFL->prev = $<FL;
2951                 $0 = $<SFL;
2952         }$
2953
2954         SimpleFieldList -> Field ${ $0 = $<F; }$
2955         | SimpleFieldList ; Field ${
2956                 $F->prev = $<SFL;
2957                 $0 = $<F;
2958         }$
2959         | SimpleFieldList ; ${
2960                 $0 = $<SFL;
2961         }$
2962         | ERROR ${ tok_err(c, "Syntax error in struct field", &$1); }$
2963
2964         Field -> IDENTIFIER : Type = Expression ${ {
2965                 $0 = calloc(1, sizeof(struct fieldlist));
2966                 $0->f.name = $ID.txt;
2967                 $0->f.type = $<Type;
2968                 $0->f.init = NULL;
2969                 $0->init = $<Expr;
2970         } }$
2971         | IDENTIFIER : Type ${
2972                 $0 = calloc(1, sizeof(struct fieldlist));
2973                 $0->f.name = $ID.txt;
2974                 $0->f.type = $<Type;
2975         }$
2976
2977 ###### forward decls
2978         static void structure_print_type(struct type *t, FILE *f);
2979
2980 ###### value functions
2981         static void structure_print_type(struct type *t, FILE *f)
2982         {
2983                 int i;
2984
2985                 fprintf(f, "struct %.*s\n", t->name.len, t->name.txt);
2986
2987                 for (i = 0; i < t->structure.nfields; i++) {
2988                         struct field *fl = t->structure.fields + i;
2989                         fprintf(f, "    %.*s : ", fl->name.len, fl->name.txt);
2990                         type_print(fl->type, f);
2991                         if (fl->type->print && fl->init) {
2992                                 fprintf(f, " = ");
2993                                 if (fl->type == Tstr)
2994                                         fprintf(f, "\"");       // UNTESTED
2995                                 print_value(fl->type, fl->init, f);
2996                                 if (fl->type == Tstr)
2997                                         fprintf(f, "\"");       // UNTESTED
2998                         }
2999                         fprintf(f, "\n");
3000                 }
3001         }
3002
3003 ###### print type decls
3004         {
3005                 struct type *t;
3006                 int target = -1;
3007
3008                 while (target != 0) {
3009                         int i = 0;
3010                         for (t = context.typelist; t ; t=t->next)
3011                                 if (!t->anon && t->print_type_decl &&
3012                                     !t->check_args) {
3013                                         i += 1;
3014                                         if (i == target)
3015                                                 break;
3016                                 }
3017
3018                         if (target == -1) {
3019                                 target = i;
3020                         } else {
3021                                 t->print_type_decl(t, stdout);
3022                                 target -= 1;
3023                         }
3024                 }
3025         }
3026
3027 #### References
3028
3029 References, or pointers, are values that refer to another value.  They
3030 can only refer to a `struct`, though as a struct can embed anything they
3031 can effectively refer to anything.
3032
3033 References are potentially dangerous as they might refer to some
3034 variable which no longer exists - either because a stack frame
3035 containing it has been discarded or because the value was allocated on
3036 the heap and has now been free.  Ocean does not yet provide any
3037 protection against these problems.  It will in due course.
3038
3039 With references comes the opportunity and the need to explicitly
3040 allocate values on the "heap" and to free them.  We currently provide
3041 fairly basic support for this.
3042
3043 Reference make use of the `@` symbol in various ways.  A type that starts
3044 with `@` is a reference to whatever follows.  A reference value
3045 followed by an `@` acts as the referred value, though the `@` is often
3046 not needed.  Finally, an expression that starts with `@` is a special
3047 reference related expression.  Some examples might help.
3048
3049 ##### Example: Reference examples
3050
3051         struct foo
3052                 a: number
3053                 b: string
3054         ref: @foo
3055         bar: foo
3056         bar.number = 23; bar.string = "hello"
3057         baz: foo
3058         ref = bar
3059         baz = @ref
3060         baz.a = ref.a * 2
3061
3062         ref = @new()
3063         ref@ = baz
3064         @free = ref
3065         ref = @nil
3066
3067 Obviously this is very contrived.  `ref` is a reference to a `foo` which
3068 is initially set to refer to the value stored in `bar` - no extra syntax
3069 is needed to "Take the address of" `bar` - the fact that `ref` is a
3070 reference means that only the address make sense.
3071
3072 When `ref.a` is accessed, that is whatever value is stored in `bar.a`.
3073 The same syntax is used for accessing fields both in structs and in
3074 references to structs.  It would be correct to use `ref@.a`, but not
3075 necessary.
3076
3077 `@new()` creates an object of whatever type is needed for the program
3078 to by type-correct.  In future iterations of Ocean, arguments a
3079 constructor will access arguments, so the the syntax now looks like a
3080 function call.  `@free` can be assigned any reference that was returned
3081 by `@new()`, and it will be freed.  `@nil` is a value of whatever
3082 reference type is appropriate, and is stable and never the address of
3083 anything in the heap or on the stack.  A reference can be assigned
3084 `@nil` or compared against that value.
3085
3086 ###### declare terminals
3087         $TERM @
3088
3089 ###### type union fields
3090
3091         struct {
3092                 struct type *referent;
3093         } reference;
3094
3095 ###### value union fields
3096         struct value *ref;
3097
3098 ###### value functions
3099
3100         static void reference_print_type(struct type *t, FILE *f)
3101         {
3102                 fprintf(f, "@");
3103                 type_print(t->reference.referent, f);
3104         }
3105
3106         static int reference_cmp(struct type *tl, struct type *tr,
3107                                  struct value *left, struct value *right)
3108         {
3109                 return left->ref == right->ref ? 0 : 1;
3110         }
3111
3112         static void reference_dup(struct type *t,
3113                                   struct value *vold, struct value *vnew)
3114         {
3115                 vnew->ref = vold->ref;
3116         }
3117
3118         static void reference_free(struct type *t, struct value *v)
3119         {
3120                 /* Nothing to do here */
3121         }
3122
3123         static int reference_compat(struct type *require, struct type *have,
3124                                     enum val_rules rules)
3125         {
3126                 if (have->compat != require->compat)
3127                         return 0;
3128                 if (have->reference.referent != require->reference.referent)
3129                         return 0;
3130                 return 1;
3131         }
3132
3133         static int reference_test(struct type *type, struct value *val)
3134         {
3135                 return val->ref != NULL;
3136         }
3137
3138         static struct type *reference_fieldref(struct type *t, struct parse_context *c,
3139                                                struct fieldref *f, struct value **vp)
3140         {
3141                 struct type *rt = t->reference.referent;
3142
3143                 if (rt->fieldref) {
3144                         if (vp)
3145                                 *vp = (*vp)->ref;
3146                         return rt->fieldref(rt, c, f, vp);
3147                 }
3148                 type_err(c, "error: field reference on %1 is not supported",
3149                                  f->left, rt, 0, NULL);
3150                 return Tnone;
3151         }
3152
3153
3154         static struct type reference_prototype = {
3155                 .print_type = reference_print_type,
3156                 .cmp_eq = reference_cmp,
3157                 .dup = reference_dup,
3158                 .test = reference_test,
3159                 .free = reference_free,
3160                 .compat = reference_compat,
3161                 .fieldref = reference_fieldref,
3162                 .size = sizeof(void*),
3163                 .align = sizeof(void*),
3164         };
3165
3166 ###### type grammar
3167
3168         | @ IDENTIFIER ${ {
3169                 struct type *t = find_type(c, $ID.txt);
3170                 if (!t) {
3171                         t = add_type(c, $ID.txt, NULL);
3172                         t->first_use = $ID;
3173                 }
3174                 $0 = find_anon_type(c, &reference_prototype, "@%.*s",
3175                                     $ID.txt.len, $ID.txt.txt);
3176                 $0->reference.referent = t;
3177         } }$
3178
3179 ###### core functions
3180         static int text_is(struct text t, char *s)
3181         {
3182                 return (strlen(s) == t.len &&
3183                         strncmp(s, t.txt, t.len) == 0);
3184         }
3185
3186 ###### exec type
3187         Xref,
3188
3189 ###### ast
3190         struct ref {
3191                 struct exec;
3192                 enum ref_func { RefNew, RefFree, RefNil } action;
3193                 struct type *reftype;
3194                 struct exec *right;
3195         };
3196
3197 ###### SimpleStatement Grammar
3198
3199         | @ IDENTIFIER = Expression ${ {
3200                 struct ref *r = new_pos(ref, $ID);
3201                 // Must be "free"
3202                 if (!text_is($ID.txt, "free"))
3203                         tok_err(c, "error: only \"@free\" makes sense here",
3204                                 &$ID);
3205
3206                 $0 = r;
3207                 r->action = RefFree;
3208                 r->right = $<Exp;
3209         } }$
3210
3211 ###### expression grammar
3212         | @ IDENTIFIER ( ) ${
3213                 // Only 'new' valid here
3214                 if (!text_is($ID.txt, "new")) {
3215                         tok_err(c, "error: Only reference function is \"@new()\"",
3216                                 &$ID);
3217                 } else {
3218                         struct ref *r = new_pos(ref,$ID);
3219                         $0 = r;
3220                         r->action = RefNew;
3221                 }
3222         }$
3223         | @ IDENTIFIER ${
3224                 // Only 'nil' valid here
3225                 if (!text_is($ID.txt, "nil")) {
3226                         tok_err(c, "error: Only reference value is \"@nil\"",
3227                                 &$ID);
3228                 } else {
3229                         struct ref *r = new_pos(ref,$ID);
3230                         $0 = r;
3231                         r->action = RefNil;
3232                 }
3233         }$
3234
3235 ###### print exec cases
3236         case Xref: {
3237                 struct ref *r = cast(ref, e);
3238                 switch (r->action) {
3239                 case RefNew:
3240                         printf("@new()"); break;
3241                 case RefNil:
3242                         printf("@nil"); break;
3243                 case RefFree:
3244                         do_indent(indent, "@free = ");
3245                         print_exec(r->right, indent, bracket);
3246                         break;
3247                 }
3248                 break;
3249         }
3250
3251 ###### propagate exec cases
3252         case Xref: {
3253                 struct ref *r = cast(ref, prog);
3254                 switch (r->action) {
3255                 case RefNew:
3256                         if (type && type->free != reference_free) {
3257                                 type_err(c, "error: @new() can only be used with references, not %1",
3258                                          prog, type, 0, NULL);
3259                                 return NULL;
3260                         }
3261                         if (type && !r->reftype) {
3262                                 r->reftype = type;
3263                                 *perr |= Eretry;
3264                         }
3265                         *perr |= Erval;
3266                         return type;
3267                 case RefNil:
3268                         if (type && type->free != reference_free)
3269                                 type_err(c, "error: @nil can only be used with reference, not %1",
3270                                          prog, type, 0, NULL);
3271                         if (type && !r->reftype) {
3272                                 r->reftype = type;
3273                                 *perr |= Eretry;
3274                         }
3275                         *perr |= Erval;
3276                         return type;
3277                 case RefFree:
3278                         t = propagate_types(r->right, c, perr_local, NULL, 0);
3279                         if (t && t->free != reference_free)
3280                                 type_err(c, "error: @free can only be assigned a reference, not %1",
3281                                          prog, t, 0, NULL);
3282                         r->reftype = Tnone;
3283                         return Tnone;
3284                 }
3285                 break;  // NOTEST
3286         }
3287
3288
3289 ###### interp exec cases
3290         case Xref: {
3291                 struct ref *r = cast(ref, e);
3292                 switch (r->action) {
3293                 case RefNew:
3294                         if (r->reftype)
3295                                 rv.ref = calloc(1, r->reftype->reference.referent->size);
3296                         rvtype = r->reftype;
3297                         break;
3298                 case RefNil:
3299                         rv.ref = NULL;
3300                         rvtype = r->reftype;
3301                         break;
3302                 case RefFree:
3303                         rv = interp_exec(c, r->right, &rvtype);
3304                         free_value(rvtype->reference.referent, rv.ref);
3305                         free(rv.ref);
3306                         rvtype = Tnone;
3307                         break;
3308                 }
3309                 break;
3310         }
3311
3312 ###### free exec cases
3313         case Xref: {
3314                 struct ref *r = cast(ref, e);
3315                 free_exec(r->right);
3316                 free(r);
3317                 break;
3318         }
3319
3320 ###### Expressions: dereference
3321
3322 ###### Binode types
3323         Deref,
3324
3325 ###### term grammar
3326
3327         | Term @ ${ {
3328                 struct binode *b = new(binode);
3329                 b->op = Deref;
3330                 b->left = $<Trm;
3331                 $0 = b;
3332         } }$
3333
3334 ###### print binode cases
3335         case Deref:
3336                 print_exec(b->left, -1, bracket);
3337                 printf("@");
3338                 break;
3339
3340 ###### propagate binode cases
3341         case Deref:
3342                 /* left must be a reference, and we return what it refers to */
3343                 /* FIXME how can I pass the expected type down? */
3344                 t = propagate_types(b->left, c, perr, NULL, 0);
3345                 *perr &= ~Erval;
3346                 if (!t || t->free != reference_free)
3347                         type_err(c, "error: Cannot dereference %1", b, t, 0, NULL);
3348                 else
3349                         return t->reference.referent;
3350                 break;
3351
3352 ###### interp binode cases
3353         case Deref: {
3354                 left = interp_exec(c, b->left, &ltype);
3355                 lrv = left.ref;
3356                 rvtype = ltype->reference.referent;
3357                 break;
3358         }
3359
3360
3361 #### Functions
3362
3363 A function is a chunk of code which can be passed parameters and can
3364 return results.  Each function has a type which includes the set of
3365 parameters and the return value.  As yet these types cannot be declared
3366 separately from the function itself.
3367
3368 The parameters can be specified either in parentheses as a ';' separated
3369 list, such as
3370
3371 ##### Example: function 1
3372
3373         func main(av:[ac::number]string; env:[envc::number]string)
3374                 code block
3375
3376 or as an indented list of one parameter per line (though each line can
3377 be a ';' separated list)
3378
3379 ##### Example: function 2
3380
3381         func main
3382                 argv:[argc::number]string
3383                 env:[envc::number]string
3384         do
3385                 code block
3386
3387 In the first case a return type can follow the parentheses after a colon,
3388 in the second it is given on a line starting with the word `return`.
3389
3390 ##### Example: functions that return
3391
3392         func add(a:number; b:number): number
3393                 code block
3394
3395         func catenate
3396                 a: string
3397                 b: string
3398         return string
3399         do
3400                 code block
3401
3402 Rather than returning a type, the function can specify a set of local
3403 variables to return as a struct.  The values of these variables when the
3404 function exits will be provided to the caller.  For this the return type
3405 is replaced with a block of result declarations, either in parentheses
3406 or bracketed by `return` and `do`.
3407
3408 ##### Example: functions returning multiple variables
3409
3410         func to_cartesian(rho:number; theta:number):(x:number; y:number)
3411                 x = .....
3412                 y = .....
3413
3414         func to_polar
3415                 x:number; y:number
3416         return
3417                 rho:number
3418                 theta:number
3419         do
3420                 rho = ....
3421                 theta = ....
3422
3423 For constructing the lists we use a `List` binode, which will be
3424 further detailed when Expression Lists are introduced.
3425
3426 ###### type union fields
3427
3428         struct {
3429                 struct binode *params;
3430                 struct type *return_type;
3431                 struct variable *scope;
3432                 int inline_result;      // return value is at start of 'local'
3433                 int local_size;
3434         } function;
3435
3436 ###### value union fields
3437         struct exec *function;
3438
3439 ###### type functions
3440         void (*check_args)(struct parse_context *c, enum prop_err *perr,
3441                            struct type *require, struct exec *args);
3442
3443 ###### value functions
3444
3445         static void function_free(struct type *type, struct value *val)
3446         {
3447                 free_exec(val->function);
3448                 val->function = NULL;
3449         }
3450
3451         static int function_compat(struct type *require, struct type *have,
3452                                    enum val_rules rules)
3453         {
3454                 // FIXME can I do anything here yet?
3455                 return 0;
3456         }
3457
3458         static void function_check_args(struct parse_context *c, enum prop_err *perr,
3459                                         struct type *require, struct exec *args)
3460         {
3461                 /* This should be 'compat', but we don't have a 'tuple' type to
3462                  * hold the type of 'args'
3463                  */
3464                 struct binode *arg = cast(binode, args);
3465                 struct binode *param = require->function.params;
3466
3467                 while (param) {
3468                         struct var *pv = cast(var, param->left);
3469                         if (!arg) {
3470                                 type_err(c, "error: insufficient arguments to function.",
3471                                          args, NULL, 0, NULL);
3472                                 break;
3473                         }
3474                         *perr = 0;
3475                         propagate_types(arg->left, c, perr, pv->var->type, 0);
3476                         param = cast(binode, param->right);
3477                         arg = cast(binode, arg->right);
3478                 }
3479                 if (arg)
3480                         type_err(c, "error: too many arguments to function.",
3481                                  args, NULL, 0, NULL);
3482         }
3483
3484         static void function_print(struct type *type, struct value *val, FILE *f)
3485         {
3486                 print_exec(val->function, 1, 0);
3487         }
3488
3489         static void function_print_type_decl(struct type *type, FILE *f)
3490         {
3491                 struct binode *b;
3492                 fprintf(f, "(");
3493                 for (b = type->function.params; b; b = cast(binode, b->right)) {
3494                         struct variable *v = cast(var, b->left)->var;
3495                         fprintf(f, "%.*s%s", v->name->name.len, v->name->name.txt,
3496                                 v->constant ? "::" : ":");
3497                         type_print(v->type, f);
3498                         if (b->right)
3499                                 fprintf(f, "; ");
3500                 }
3501                 fprintf(f, ")");
3502                 if (type->function.return_type != Tnone) {
3503                         fprintf(f, ":");
3504                         if (type->function.inline_result) {
3505                                 int i;
3506                                 struct type *t = type->function.return_type;
3507                                 fprintf(f, " (");
3508                                 for (i = 0; i < t->structure.nfields; i++) {
3509                                         struct field *fl = t->structure.fields + i;
3510                                         if (i)
3511                                                 fprintf(f, "; ");
3512                                         fprintf(f, "%.*s:", fl->name.len, fl->name.txt);
3513                                         type_print(fl->type, f);
3514                                 }
3515                                 fprintf(f, ")");
3516                         } else
3517                                 type_print(type->function.return_type, f);
3518                 }
3519                 fprintf(f, "\n");
3520         }
3521
3522         static void function_free_type(struct type *t)
3523         {
3524                 free_exec(t->function.params);
3525         }
3526
3527         static struct type function_prototype = {
3528                 .size = sizeof(void*),
3529                 .align = sizeof(void*),
3530                 .free = function_free,
3531                 .compat = function_compat,
3532                 .check_args = function_check_args,
3533                 .print = function_print,
3534                 .print_type_decl = function_print_type_decl,
3535                 .free_type = function_free_type,
3536         };
3537
3538 ###### declare terminals
3539
3540         $TERM func
3541
3542 ###### Binode types
3543         List,
3544
3545 ###### Grammar
3546
3547         $*variable
3548         FuncName -> IDENTIFIER ${ {
3549                 struct variable *v = var_decl(c, $1.txt);
3550                 struct var *e = new_pos(var, $1);
3551                 e->var = v;
3552                 if (v) {
3553                         v->where_decl = e;
3554                         v->where_set = e;
3555                         $0 = v;
3556                 } else {
3557                         v = var_ref(c, $1.txt);
3558                         e->var = v;
3559                         type_err(c, "error: function '%v' redeclared",
3560                                 e, NULL, 0, NULL);
3561                         type_err(c, "info: this is where '%v' was first declared",
3562                                 v->where_decl, NULL, 0, NULL);
3563                         free_exec(e);
3564                 }
3565         } }$
3566
3567         $*binode
3568         Args -> ArgsLine NEWLINE ${ $0 = $<AL; }$
3569         | Args ArgsLine NEWLINE ${ {
3570                 struct binode *b = $<AL;
3571                 struct binode **bp = &b;
3572                 while (*bp)
3573                         bp = (struct binode **)&(*bp)->left;
3574                 *bp = $<A;
3575                 $0 = b;
3576         } }$
3577
3578         ArgsLine -> ${ $0 = NULL; }$
3579         | Varlist ${ $0 = $<1; }$
3580         | Varlist ; ${ $0 = $<1; }$
3581
3582         Varlist -> Varlist ; ArgDecl ${
3583                 $0 = new_pos(binode, $2);
3584                 $0->op = List;
3585                 $0->left = $<Vl;
3586                 $0->right = $<AD;
3587         }$
3588         | ArgDecl ${
3589                 $0 = new(binode);
3590                 $0->op = List;
3591                 $0->left = NULL;
3592                 $0->right = $<AD;
3593         }$
3594
3595         $*var
3596         ArgDecl -> IDENTIFIER : FormalType ${ {
3597                 struct variable *v = var_decl(c, $ID.txt);
3598                 $0 = new_pos(var, $ID);
3599                 $0->var = v;
3600                 v->where_decl = $0;
3601                 v->where_set = $0;
3602                 v->type = $<FT;
3603         } }$
3604
3605 ##### Function calls
3606
3607 A function call can appear either as an expression or as a statement.
3608 We use a new 'Funcall' binode type to link the function with a list of
3609 arguments, form with the 'List' nodes.
3610
3611 We have already seen the "Term" which is how a function call can appear
3612 in an expression.  To parse a function call into a statement we include
3613 it in the "SimpleStatement Grammar" which will be described later.
3614
3615 ###### Binode types
3616         Funcall,
3617
3618 ###### term grammar
3619         | Term ( ExpressionList ) ${ {
3620                 struct binode *b = new(binode);
3621                 b->op = Funcall;
3622                 b->left = $<T;
3623                 b->right = reorder_bilist($<EL);
3624                 $0 = b;
3625         } }$
3626         | Term ( ) ${ {
3627                 struct binode *b = new(binode);
3628                 b->op = Funcall;
3629                 b->left = $<T;
3630                 b->right = NULL;
3631                 $0 = b;
3632         } }$
3633
3634 ###### SimpleStatement Grammar
3635
3636         | Term ( ExpressionList ) ${ {
3637                 struct binode *b = new(binode);
3638                 b->op = Funcall;
3639                 b->left = $<T;
3640                 b->right = reorder_bilist($<EL);
3641                 $0 = b;
3642         } }$
3643
3644 ###### print binode cases
3645
3646         case Funcall:
3647                 do_indent(indent, "");
3648                 print_exec(b->left, -1, bracket);
3649                 printf("(");
3650                 for (b = cast(binode, b->right); b; b = cast(binode, b->right)) {
3651                         if (b->left) {
3652                                 printf(" ");
3653                                 print_exec(b->left, -1, bracket);
3654                                 if (b->right)
3655                                         printf(",");
3656                         }
3657                 }
3658                 printf(")");
3659                 if (indent >= 0)
3660                         printf("\n");
3661                 break;
3662
3663 ###### propagate binode cases
3664
3665         case Funcall: {
3666                 /* Every arg must match formal parameter, and result
3667                  * is return type of function
3668                  */
3669                 struct binode *args = cast(binode, b->right);
3670                 struct var *v = cast(var, b->left);
3671
3672                 if (!v->var->type || v->var->type->check_args == NULL) {
3673                         type_err(c, "error: attempt to call a non-function.",
3674                                  prog, NULL, 0, NULL);
3675                         return NULL;
3676                 }
3677                 *perr |= Eruntime;
3678                 v->var->type->check_args(c, perr_local, v->var->type, args);
3679                 if (v->var->type->function.inline_result)
3680                         *perr |= Emaycopy;
3681                 *perr |= Erval;
3682                 return v->var->type->function.return_type;
3683         }
3684
3685 ###### interp binode cases
3686
3687         case Funcall: {
3688                 struct var *v = cast(var, b->left);
3689                 struct type *t = v->var->type;
3690                 void *oldlocal = c->local;
3691                 int old_size = c->local_size;
3692                 void *local = calloc(1, t->function.local_size);
3693                 struct value *fbody = var_value(c, v->var);
3694                 struct binode *arg = cast(binode, b->right);
3695                 struct binode *param = t->function.params;
3696
3697                 while (param) {
3698                         struct var *pv = cast(var, param->left);
3699                         struct type *vtype = NULL;
3700                         struct value val = interp_exec(c, arg->left, &vtype);
3701                         struct value *lval;
3702                         c->local = local; c->local_size = t->function.local_size;
3703                         lval = var_value(c, pv->var);
3704                         c->local = oldlocal; c->local_size = old_size;
3705                         memcpy(lval, &val, vtype->size);
3706                         param = cast(binode, param->right);
3707                         arg = cast(binode, arg->right);
3708                 }
3709                 c->local = local; c->local_size = t->function.local_size;
3710                 if (t->function.inline_result && dtype) {
3711                         _interp_exec(c, fbody->function, NULL, NULL);
3712                         memcpy(dest, local, dtype->size);
3713                         rvtype = ret.type = NULL;
3714                 } else
3715                         rv = interp_exec(c, fbody->function, &rvtype);
3716                 c->local = oldlocal; c->local_size = old_size;
3717                 free(local);
3718                 break;
3719         }
3720
3721 ## Complex executables: statements and expressions
3722
3723 Now that we have types and values and variables and most of the basic
3724 Terms which provide access to these, we can explore the more complex
3725 code that combine all of these to get useful work done.  Specifically
3726 statements and expressions.
3727
3728 Expressions are various combinations of Terms.  We will use operator
3729 precedence to ensure correct parsing.  The simplest Expression is just a
3730 Term - others will follow.
3731
3732 ###### Grammar
3733
3734         $*exec
3735         Expression -> Term ${ $0 = $<Term; }$
3736         ## expression grammar
3737
3738 ### Expressions: Conditional
3739
3740 Our first user of the `binode` will be conditional expressions, which
3741 is a bit odd as they actually have three components.  That will be
3742 handled by having 2 binodes for each expression.  The conditional
3743 expression is the lowest precedence operator which is why we define it
3744 first - to start the precedence list.
3745
3746 Conditional expressions are of the form "value `if` condition `else`
3747 other_value".  They associate to the right, so everything to the right
3748 of `else` is part of an else value, while only a higher-precedence to
3749 the left of `if` is the if values.  Between `if` and `else` there is no
3750 room for ambiguity, so a full conditional expression is allowed in
3751 there.
3752
3753 ###### Binode types
3754         CondExpr,
3755
3756 ###### declare terminals
3757
3758         $LEFT if $$ifelse
3759
3760 ###### expression grammar
3761
3762         | Expression if Expression else Expression $$ifelse ${ {
3763                 struct binode *b1 = new(binode);
3764                 struct binode *b2 = new(binode);
3765                 b1->op = CondExpr;
3766                 b1->left = $<3;
3767                 b1->right = b2;
3768                 b2->op = CondExpr;
3769                 b2->left = $<1;
3770                 b2->right = $<5;
3771                 $0 = b1;
3772         } }$
3773
3774 ###### print binode cases
3775
3776         case CondExpr:
3777                 b2 = cast(binode, b->right);
3778                 if (bracket) printf("(");
3779                 print_exec(b2->left, -1, bracket);
3780                 printf(" if ");
3781                 print_exec(b->left, -1, bracket);
3782                 printf(" else ");
3783                 print_exec(b2->right, -1, bracket);
3784                 if (bracket) printf(")");
3785                 break;
3786
3787 ###### propagate binode cases
3788
3789         case CondExpr: {
3790                 /* cond must be Tbool, others must match */
3791                 struct binode *b2 = cast(binode, b->right);
3792                 struct type *t2;
3793
3794                 propagate_types(b->left, c, perr_local, Tbool, 0);
3795                 t = propagate_types(b2->left, c, perr, type, 0);
3796                 t2 = propagate_types(b2->right, c, perr, type ?: t, 0);
3797                 return t ?: t2;
3798         }
3799
3800 ###### interp binode cases
3801
3802         case CondExpr: {
3803                 struct binode *b2 = cast(binode, b->right);
3804                 left = interp_exec(c, b->left, &ltype);
3805                 if (left.bool)
3806                         rv = interp_exec(c, b2->left, &rvtype); // UNTESTED
3807                 else
3808                         rv = interp_exec(c, b2->right, &rvtype);
3809                 }
3810                 break;
3811
3812 ### Expression list
3813
3814 We take a brief detour, now that we have expressions, to describe lists
3815 of expressions.  These will be needed for function parameters and
3816 possibly other situations.  They seem generic enough to introduce here
3817 to be used elsewhere.
3818
3819 And ExpressionList will use the `List` type of `binode`, building up at
3820 the end.  And place where they are used will probably call
3821 `reorder_bilist()` to get a more normal first/next arrangement.
3822
3823 ###### declare terminals
3824         $TERM ,
3825
3826 `List` execs have no implicit semantics, so they are never propagated or
3827 interpreted.  The can be printed as a comma separate list, which is how
3828 they are parsed.  Note they are also used for function formal parameter
3829 lists.  In that case a separate function is used to print them.
3830
3831 ###### print binode cases
3832         case List:
3833                 while (b) {
3834                         printf(" ");
3835                         print_exec(b->left, -1, bracket);
3836                         if (b->right)
3837                                 printf(",");
3838                         b = cast(binode, b->right);
3839                 }
3840                 break;
3841
3842 ###### propagate binode cases
3843         case List: abort(); // NOTEST
3844 ###### interp binode cases
3845         case List: abort(); // NOTEST
3846
3847 ###### Grammar
3848
3849         $*binode
3850         ExpressionList -> ExpressionList , Expression ${
3851                 $0 = new(binode);
3852                 $0->op = List;
3853                 $0->left = $<1;
3854                 $0->right = $<3;
3855         }$
3856         | Expression ${
3857                 $0 = new(binode);
3858                 $0->op = List;
3859                 $0->left = NULL;
3860                 $0->right = $<1;
3861         }$
3862
3863 ### Expressions: Boolean
3864
3865 The next class of expressions to use the `binode` will be Boolean
3866 expressions.  "`and then`" and "`or else`" are similar to `and` and `or`
3867 have same corresponding precendence.  The difference is that they don't
3868 evaluate the second expression if not necessary.
3869
3870 ###### Binode types
3871         And,
3872         AndThen,
3873         Or,
3874         OrElse,
3875         Not,
3876
3877 ###### declare terminals
3878         $LEFT or
3879         $LEFT and
3880         $LEFT not
3881
3882 ###### expression grammar
3883         | Expression or Expression ${ {
3884                 struct binode *b = new(binode);
3885                 b->op = Or;
3886                 b->left = $<1;
3887                 b->right = $<3;
3888                 $0 = b;
3889         } }$
3890         | Expression or else Expression ${ {
3891                 struct binode *b = new(binode);
3892                 b->op = OrElse;
3893                 b->left = $<1;
3894                 b->right = $<4;
3895                 $0 = b;
3896         } }$
3897
3898         | Expression and Expression ${ {
3899                 struct binode *b = new(binode);
3900                 b->op = And;
3901                 b->left = $<1;
3902                 b->right = $<3;
3903                 $0 = b;
3904         } }$
3905         | Expression and then Expression ${ {
3906                 struct binode *b = new(binode);
3907                 b->op = AndThen;
3908                 b->left = $<1;
3909                 b->right = $<4;
3910                 $0 = b;
3911         } }$
3912
3913         | not Expression ${ {
3914                 struct binode *b = new(binode);
3915                 b->op = Not;
3916                 b->right = $<2;
3917                 $0 = b;
3918         } }$
3919
3920 ###### print binode cases
3921         case And:
3922                 if (bracket) printf("(");
3923                 print_exec(b->left, -1, bracket);
3924                 printf(" and ");
3925                 print_exec(b->right, -1, bracket);
3926                 if (bracket) printf(")");
3927                 break;
3928         case AndThen:
3929                 if (bracket) printf("(");
3930                 print_exec(b->left, -1, bracket);
3931                 printf(" and then ");
3932                 print_exec(b->right, -1, bracket);
3933                 if (bracket) printf(")");
3934                 break;
3935         case Or:
3936                 if (bracket) printf("(");
3937                 print_exec(b->left, -1, bracket);
3938                 printf(" or ");
3939                 print_exec(b->right, -1, bracket);
3940                 if (bracket) printf(")");
3941                 break;
3942         case OrElse:
3943                 if (bracket) printf("(");
3944                 print_exec(b->left, -1, bracket);
3945                 printf(" or else ");
3946                 print_exec(b->right, -1, bracket);
3947                 if (bracket) printf(")");
3948                 break;
3949         case Not:
3950                 if (bracket) printf("(");
3951                 printf("not ");
3952                 print_exec(b->right, -1, bracket);
3953                 if (bracket) printf(")");
3954                 break;
3955
3956 ###### propagate binode cases
3957         case And:
3958         case AndThen:
3959         case Or:
3960         case OrElse:
3961         case Not:
3962                 /* both must be Tbool, result is Tbool */
3963                 propagate_types(b->left, c, perr, Tbool, 0);
3964                 propagate_types(b->right, c, perr, Tbool, 0);
3965                 if (type && type != Tbool)
3966                         type_err(c, "error: %1 operation found where %2 expected", prog,
3967                                    Tbool, 0, type);
3968                 *perr |= Erval;
3969                 return Tbool;
3970
3971 ###### interp binode cases
3972         case And:
3973                 rv = interp_exec(c, b->left, &rvtype);
3974                 right = interp_exec(c, b->right, &rtype);
3975                 rv.bool = rv.bool && right.bool;
3976                 break;
3977         case AndThen:
3978                 rv = interp_exec(c, b->left, &rvtype);
3979                 if (rv.bool)
3980                         rv = interp_exec(c, b->right, NULL);
3981                 break;
3982         case Or:
3983                 rv = interp_exec(c, b->left, &rvtype);
3984                 right = interp_exec(c, b->right, &rtype);
3985                 rv.bool = rv.bool || right.bool;
3986                 break;
3987         case OrElse:
3988                 rv = interp_exec(c, b->left, &rvtype);
3989                 if (!rv.bool)
3990                         rv = interp_exec(c, b->right, NULL);
3991                 break;
3992         case Not:
3993                 rv = interp_exec(c, b->right, &rvtype);
3994                 rv.bool = !rv.bool;
3995                 break;
3996
3997 ### Expressions: Comparison
3998
3999 Of slightly higher precedence that Boolean expressions are Comparisons.
4000 A comparison takes arguments of any comparable type, but the two types
4001 must be the same.
4002
4003 To simplify the parsing we introduce an `eop` which can record an
4004 expression operator, and the `CMPop` non-terminal will match one of them.
4005
4006 ###### ast
4007         struct eop {
4008                 enum Btype op;
4009         };
4010
4011 ###### ast functions
4012         static void free_eop(struct eop *e)
4013         {
4014                 if (e)
4015                         free(e);
4016         }
4017
4018 ###### Binode types
4019         Less,
4020         Gtr,
4021         LessEq,
4022         GtrEq,
4023         Eql,
4024         NEql,
4025
4026 ###### declare terminals
4027         $LEFT < > <= >= == != CMPop
4028
4029 ###### expression grammar
4030         | Expression CMPop Expression ${ {
4031                 struct binode *b = new(binode);
4032                 b->op = $2.op;
4033                 b->left = $<1;
4034                 b->right = $<3;
4035                 $0 = b;
4036         } }$
4037
4038 ###### Grammar
4039
4040         $eop
4041         CMPop ->  < ${ $0.op = Less; }$
4042         |         > ${ $0.op = Gtr; }$
4043         |         <= ${ $0.op = LessEq; }$
4044         |         >= ${ $0.op = GtrEq; }$
4045         |         == ${ $0.op = Eql; }$
4046         |         != ${ $0.op = NEql; }$
4047
4048 ###### print binode cases
4049
4050         case Less:
4051         case LessEq:
4052         case Gtr:
4053         case GtrEq:
4054         case Eql:
4055         case NEql:
4056                 if (bracket) printf("(");
4057                 print_exec(b->left, -1, bracket);
4058                 switch(b->op) {
4059                 case Less:   printf(" < "); break;
4060                 case LessEq: printf(" <= "); break;
4061                 case Gtr:    printf(" > "); break;
4062                 case GtrEq:  printf(" >= "); break;
4063                 case Eql:    printf(" == "); break;
4064                 case NEql:   printf(" != "); break;
4065                 default: abort();               // NOTEST
4066                 }
4067                 print_exec(b->right, -1, bracket);
4068                 if (bracket) printf(")");
4069                 break;
4070
4071 ###### propagate binode cases
4072         case Less:
4073         case LessEq:
4074         case Gtr:
4075         case GtrEq:
4076         case Eql:
4077         case NEql:
4078                 /* Both must match but not be labels, result is Tbool */
4079                 t = propagate_types(b->left, c, perr, NULL, 0);
4080                 if (t)
4081                         propagate_types(b->right, c, perr, t, 0);
4082                 else {
4083                         t = propagate_types(b->right, c, perr, NULL, 0);        // UNTESTED
4084                         if (t)  // UNTESTED
4085                                 t = propagate_types(b->left, c, perr, t, 0);    // UNTESTED
4086                 }
4087                 if (!type_compat(type, Tbool, 0))
4088                         type_err(c, "error: Comparison returns %1 but %2 expected", prog,
4089                                     Tbool, rules, type);
4090                 *perr |= Erval;
4091                 return Tbool;
4092
4093 ###### interp binode cases
4094         case Less:
4095         case LessEq:
4096         case Gtr:
4097         case GtrEq:
4098         case Eql:
4099         case NEql:
4100         {
4101                 int cmp;
4102                 left = interp_exec(c, b->left, &ltype);
4103                 right = interp_exec(c, b->right, &rtype);
4104                 cmp = value_cmp(ltype, rtype, &left, &right);
4105                 rvtype = Tbool;
4106                 switch (b->op) {
4107                 case Less:      rv.bool = cmp <  0; break;
4108                 case LessEq:    rv.bool = cmp <= 0; break;
4109                 case Gtr:       rv.bool = cmp >  0; break;
4110                 case GtrEq:     rv.bool = cmp >= 0; break;
4111                 case Eql:       rv.bool = cmp == 0; break;
4112                 case NEql:      rv.bool = cmp != 0; break;
4113                 default:        rv.bool = 0; break;     // NOTEST
4114                 }
4115                 break;
4116         }
4117
4118 ### Expressions: Arithmetic etc.
4119
4120 The remaining expressions with the highest precedence are arithmetic,
4121 string concatenation, string conversion, and testing.  String concatenation
4122 (`++`) has the same precedence as multiplication and division, but lower
4123 than the uniary.
4124
4125 Testing comes in two forms.  A single question mark (`?`) is a uniary
4126 operator which converts come types into Boolean.  The general meaning is
4127 "is this a value value" and there will be more uses as the language
4128 develops.  A double questionmark (`??`) is a binary operator (Choose),
4129 with same precedence as multiplication, which returns the LHS if it
4130 tests successfully, else returns the RHS.
4131
4132 String conversion is a temporary feature until I get a better type
4133 system.  `$` is a prefix operator which expects a string and returns
4134 a number.
4135
4136 `+` and `-` are both infix and prefix operations (where they are
4137 absolute value and negation).  These have different operator names.
4138
4139 We also have a 'Bracket' operator which records where parentheses were
4140 found.  This makes it easy to reproduce these when printing.  Possibly I
4141 should only insert brackets were needed for precedence.  Putting
4142 parentheses around an expression converts it into a Term,
4143
4144 ###### Binode types
4145         Plus, Minus,
4146         Times, Divide, Rem,
4147         Concat, Choose,
4148         Absolute, Negate, Test,
4149         StringConv,
4150         Bracket,
4151
4152 ###### declare terminals
4153         $LEFT + - Eop
4154         $LEFT * / % ++ ?? Top
4155         $LEFT Uop $ ?
4156         $TERM ( )
4157
4158 ###### expression grammar
4159         | Expression Eop Expression ${ {
4160                 struct binode *b = new(binode);
4161                 b->op = $2.op;
4162                 b->left = $<1;
4163                 b->right = $<3;
4164                 $0 = b;
4165         } }$
4166
4167         | Expression Top Expression ${ {
4168                 struct binode *b = new(binode);
4169                 b->op = $2.op;
4170                 b->left = $<1;
4171                 b->right = $<3;
4172                 $0 = b;
4173         } }$
4174
4175         | Uop Expression ${ {
4176                 struct binode *b = new(binode);
4177                 b->op = $1.op;
4178                 b->right = $<2;
4179                 $0 = b;
4180         } }$
4181
4182 ###### term grammar
4183
4184         | ( Expression ) ${ {
4185                 struct binode *b = new_pos(binode, $1);
4186                 b->op = Bracket;
4187                 b->right = $<2;
4188                 $0 = b;
4189         } }$
4190
4191 ###### Grammar
4192
4193         $eop
4194         Eop ->   + ${ $0.op = Plus; }$
4195         |        - ${ $0.op = Minus; }$
4196
4197         Uop ->   + ${ $0.op = Absolute; }$
4198         |        - ${ $0.op = Negate; }$
4199         |        $ ${ $0.op = StringConv; }$
4200         |        ? ${ $0.op = Test; }$
4201
4202         Top ->   * ${ $0.op = Times; }$
4203         |        / ${ $0.op = Divide; }$
4204         |        % ${ $0.op = Rem; }$
4205         |        ++ ${ $0.op = Concat; }$
4206         |        ?? ${ $0.op = Choose; }$
4207
4208 ###### print binode cases
4209         case Plus:
4210         case Minus:
4211         case Times:
4212         case Divide:
4213         case Concat:
4214         case Rem:
4215         case Choose:
4216                 if (bracket) printf("(");
4217                 print_exec(b->left, indent, bracket);
4218                 switch(b->op) {
4219                 case Plus:   fputs(" + ", stdout); break;
4220                 case Minus:  fputs(" - ", stdout); break;
4221                 case Times:  fputs(" * ", stdout); break;
4222                 case Divide: fputs(" / ", stdout); break;
4223                 case Rem:    fputs(" % ", stdout); break;
4224                 case Concat: fputs(" ++ ", stdout); break;
4225                 case Choose: fputs(" ?? ", stdout); break;
4226                 default: abort();       // NOTEST
4227                 }                       // NOTEST
4228                 print_exec(b->right, indent, bracket);
4229                 if (bracket) printf(")");
4230                 break;
4231         case Absolute:
4232         case Negate:
4233         case StringConv:
4234         case Test:
4235                 if (bracket) printf("(");
4236                 switch (b->op) {
4237                 case Absolute:   fputs("+", stdout); break;
4238                 case Negate:     fputs("-", stdout); break;
4239                 case StringConv: fputs("$", stdout); break;
4240                 case Test:       fputs("?", stdout); break;
4241                 default: abort();       // NOTEST
4242                 }                       // NOTEST
4243                 print_exec(b->right, indent, bracket);
4244                 if (bracket) printf(")");
4245                 break;
4246         case Bracket:
4247                 printf("(");
4248                 print_exec(b->right, indent, bracket);
4249                 printf(")");
4250                 break;
4251
4252 ###### propagate binode cases
4253         case Plus:
4254         case Minus:
4255         case Times:
4256         case Rem:
4257         case Divide:
4258                 /* both must be numbers, result is Tnum */
4259         case Absolute:
4260         case Negate:
4261                 /* as propagate_types ignores a NULL,
4262                  * unary ops fit here too */
4263                 propagate_types(b->left, c, perr, Tnum, 0);
4264                 propagate_types(b->right, c, perr, Tnum, 0);
4265                 if (!type_compat(type, Tnum, 0))
4266                         type_err(c, "error: Arithmetic returns %1 but %2 expected", prog,
4267                                    Tnum, rules, type);
4268                 *perr |= Erval;
4269                 return Tnum;
4270
4271         case Concat:
4272                 /* both must be Tstr, result is Tstr */
4273                 propagate_types(b->left, c, perr, Tstr, 0);
4274                 propagate_types(b->right, c, perr, Tstr, 0);
4275                 if (!type_compat(type, Tstr, 0))
4276                         type_err(c, "error: Concat returns %1 but %2 expected", prog,
4277                                    Tstr, rules, type);
4278                 *perr |= Erval;
4279                 return Tstr;
4280
4281         case StringConv:
4282                 /* op must be string, result is number */
4283                 propagate_types(b->left, c, perr, Tstr, 0);
4284                 if (!type_compat(type, Tnum, 0))
4285                         type_err(c,     // UNTESTED
4286                           "error: Can only convert string to number, not %1",
4287                                 prog, type, 0, NULL);
4288                 *perr |= Erval;
4289                 return Tnum;
4290
4291         case Test:
4292                 /* LHS must support ->test, result is Tbool */
4293                 t = propagate_types(b->right, c, perr, NULL, 0);
4294                 if (!t || !t->test)
4295                         type_err(c, "error: '?' requires a testable value, not %1",
4296                                  prog, t, 0, NULL);
4297                 *perr |= Erval;
4298                 return Tbool;
4299
4300         case Choose:
4301                 /* LHS and RHS must match and are returned. Must support
4302                  * ->test
4303                  */
4304                 t = propagate_types(b->left, c, perr, type, rules);
4305                 t = propagate_types(b->right, c, perr, t, rules);
4306                 if (t && t->test == NULL)
4307                         type_err(c, "error: \"??\" requires a testable value, not %1",
4308                                  prog, t, 0, NULL);
4309                 *perr |= Erval;
4310                 return t;
4311
4312         case Bracket:
4313                 return propagate_types(b->right, c, perr, type, rules);
4314
4315 ###### interp binode cases
4316
4317         case Plus:
4318                 rv = interp_exec(c, b->left, &rvtype);
4319                 right = interp_exec(c, b->right, &rtype);
4320                 mpq_add(rv.num, rv.num, right.num);
4321                 break;
4322         case Minus:
4323                 rv = interp_exec(c, b->left, &rvtype);
4324                 right = interp_exec(c, b->right, &rtype);
4325                 mpq_sub(rv.num, rv.num, right.num);
4326                 break;
4327         case Times:
4328                 rv = interp_exec(c, b->left, &rvtype);
4329                 right = interp_exec(c, b->right, &rtype);
4330                 mpq_mul(rv.num, rv.num, right.num);
4331                 break;
4332         case Divide:
4333                 rv = interp_exec(c, b->left, &rvtype);
4334                 right = interp_exec(c, b->right, &rtype);
4335                 mpq_div(rv.num, rv.num, right.num);
4336                 break;
4337         case Rem: {
4338                 mpz_t l, r, rem;
4339
4340                 left = interp_exec(c, b->left, &ltype);
4341                 right = interp_exec(c, b->right, &rtype);
4342                 mpz_init(l); mpz_init(r); mpz_init(rem);
4343                 mpz_tdiv_q(l, mpq_numref(left.num), mpq_denref(left.num));
4344                 mpz_tdiv_q(r, mpq_numref(right.num), mpq_denref(right.num));
4345                 mpz_tdiv_r(rem, l, r);
4346                 val_init(Tnum, &rv);
4347                 mpq_set_z(rv.num, rem);
4348                 mpz_clear(r); mpz_clear(l); mpz_clear(rem);
4349                 rvtype = ltype;
4350                 break;
4351         }
4352         case Negate:
4353                 rv = interp_exec(c, b->right, &rvtype);
4354                 mpq_neg(rv.num, rv.num);
4355                 break;
4356         case Absolute:
4357                 rv = interp_exec(c, b->right, &rvtype);
4358                 mpq_abs(rv.num, rv.num);
4359                 break;
4360         case Bracket:
4361                 rv = interp_exec(c, b->right, &rvtype);
4362                 break;
4363         case Concat:
4364                 left = interp_exec(c, b->left, &ltype);
4365                 right = interp_exec(c, b->right, &rtype);
4366                 rvtype = Tstr;
4367                 rv.str = text_join(left.str, right.str);
4368                 break;
4369         case StringConv:
4370                 right = interp_exec(c, b->right, &rvtype);
4371                 rtype = Tstr;
4372                 rvtype = Tnum;
4373
4374                 struct text tx = right.str;
4375                 char tail[3];
4376                 int neg = 0;
4377                 if (tx.txt[0] == '-') {
4378                         neg = 1;        // UNTESTED
4379                         tx.txt++;       // UNTESTED
4380                         tx.len--;       // UNTESTED
4381                 }
4382                 if (number_parse(rv.num, tail, tx) == 0)
4383                         mpq_init(rv.num);       // UNTESTED
4384                 else if (neg)
4385                         mpq_neg(rv.num, rv.num);        // UNTESTED
4386                 if (tail[0])
4387                         printf("Unsupported suffix: %.*s\n", tx.len, tx.txt);   // UNTESTED
4388
4389                 break;
4390         case Test:
4391                 right = interp_exec(c, b->right, &rtype);
4392                 rvtype = Tbool;
4393                 rv.bool = !!rtype->test(rtype, &right);
4394                 break;
4395         case Choose:
4396                 left = interp_exec(c, b->left, &ltype);
4397                 if (ltype->test(ltype, &left)) {
4398                         rv = left;
4399                         rvtype = ltype;
4400                         ltype = NULL;
4401                 } else
4402                         rv = interp_exec(c, b->right, &rvtype);
4403                 break;
4404
4405 ###### value functions
4406
4407         static struct text text_join(struct text a, struct text b)
4408         {
4409                 struct text rv;
4410                 rv.len = a.len + b.len;
4411                 rv.txt = malloc(rv.len);
4412                 memcpy(rv.txt, a.txt, a.len);
4413                 memcpy(rv.txt+a.len, b.txt, b.len);
4414                 return rv;
4415         }
4416
4417 ### Blocks, Statements, and Statement lists.
4418
4419 Now that we have expressions out of the way we need to turn to
4420 statements.  There are simple statements and more complex statements.
4421 Simple statements do not contain (syntactic) newlines, complex statements do.
4422
4423 Statements often come in sequences and we have corresponding simple
4424 statement lists and complex statement lists.
4425 The former comprise only simple statements separated by semicolons.
4426 The later comprise complex statements and simple statement lists.  They are
4427 separated by newlines.  Thus the semicolon is only used to separate
4428 simple statements on the one line.  This may be overly restrictive,
4429 but I'm not sure I ever want a complex statement to share a line with
4430 anything else.
4431
4432 Note that a simple statement list can still use multiple lines if
4433 subsequent lines are indented, so
4434
4435 ###### Example: wrapped simple statement list
4436
4437         a = b; c = d;
4438            e = f; print g
4439
4440 is a single simple statement list.  This might allow room for
4441 confusion, so I'm not set on it yet.
4442
4443 A simple statement list needs no extra syntax.  A complex statement
4444 list has two syntactic forms.  It can be enclosed in braces (much like
4445 C blocks), or it can be introduced by an indent and continue until an
4446 unindented newline (much like Python blocks).  With this extra syntax
4447 it is referred to as a block.
4448
4449 Note that a block does not have to include any newlines if it only
4450 contains simple statements.  So both of:
4451
4452         if condition: a=b; d=f
4453
4454         if condition { a=b; print f }
4455
4456 are valid.
4457
4458 In either case the list is constructed from a `binode` list with
4459 `Block` as the operator.  When parsing the list it is most convenient
4460 to append to the end, so a list is a list and a statement.  When using
4461 the list it is more convenient to consider a list to be a statement
4462 and a list.  So we need a function to re-order a list.
4463 `reorder_bilist` serves this purpose.
4464
4465 The only stand-alone statement we introduce at this stage is `pass`
4466 which does nothing and is represented as a `NULL` pointer in a `Block`
4467 list.  Other stand-alone statements will follow once the infrastructure
4468 is in-place.
4469
4470 As many statements will use binodes, we declare a binode pointer 'b' in
4471 the common header for all reductions to use.
4472
4473 ###### Parser: reduce
4474         struct binode *b;
4475
4476 ###### Binode types
4477         Block,
4478
4479 ###### Grammar
4480
4481         $TERM { } ;
4482
4483         $*binode
4484         Block -> { IN OptNL Statementlist OUT OptNL } ${ $0 = $<Sl; }$
4485         |        { SimpleStatements } ${ $0 = reorder_bilist($<SS); }$
4486         |        SimpleStatements ; ${ $0 = reorder_bilist($<SS); }$
4487         |        SimpleStatements EOL ${ $0 = reorder_bilist($<SS); }$
4488         |        IN OptNL Statementlist OUT ${ $0 = $<Sl; }$
4489
4490         OpenBlock -> OpenScope { IN OptNL Statementlist OUT OptNL } ${ $0 = $<Sl; }$
4491         |        OpenScope { SimpleStatements } ${ $0 = reorder_bilist($<SS); }$
4492         |        OpenScope SimpleStatements ; ${ $0 = reorder_bilist($<SS); }$
4493         |        OpenScope SimpleStatements EOL ${ $0 = reorder_bilist($<SS); }$
4494         |        IN OpenScope OptNL Statementlist OUT ${ $0 = $<Sl; }$
4495
4496         UseBlock -> { OpenScope IN OptNL Statementlist OUT OptNL } ${ $0 = $<Sl; }$
4497         |        { OpenScope SimpleStatements } ${ $0 = reorder_bilist($<SS); }$
4498         |        IN OpenScope OptNL Statementlist OUT ${ $0 = $<Sl; }$
4499
4500         ColonBlock -> { IN OptNL Statementlist OUT OptNL } ${ $0 = $<Sl; }$
4501         |        { SimpleStatements } ${ $0 = reorder_bilist($<SS); }$
4502         |        : SimpleStatements ; ${ $0 = reorder_bilist($<SS); }$
4503         |        : SimpleStatements EOL ${ $0 = reorder_bilist($<SS); }$
4504         |        : IN OptNL Statementlist OUT ${ $0 = $<Sl; }$
4505
4506         Statementlist -> ComplexStatements ${ $0 = reorder_bilist($<CS); }$
4507
4508         ComplexStatements -> ComplexStatements ComplexStatement ${
4509                 if ($2 == NULL) {
4510                         $0 = $<1;
4511                 } else {
4512                         $0 = new(binode);
4513                         $0->op = Block;
4514                         $0->left = $<1;
4515                         $0->right = $<2;
4516                 }
4517         }$
4518         | ComplexStatement ${
4519                 if ($1 == NULL) {
4520                         $0 = NULL;
4521                 } else {
4522                         $0 = new(binode);
4523                         $0->op = Block;
4524                         $0->left = NULL;
4525                         $0->right = $<1;
4526                 }
4527         }$
4528
4529         $*exec
4530         ComplexStatement -> SimpleStatements Newlines ${
4531                 $0 = reorder_bilist($<SS);
4532         }$
4533         |  SimpleStatements ; Newlines ${
4534                 $0 = reorder_bilist($<SS);
4535         }$
4536         ## ComplexStatement Grammar
4537
4538         $*binode
4539         SimpleStatements -> SimpleStatements ; SimpleStatement ${
4540                 $0 = new(binode);
4541                 $0->op = Block;
4542                 $0->left = $<1;
4543                 $0->right = $<3;
4544         }$
4545         | SimpleStatement ${
4546                 $0 = new(binode);
4547                 $0->op = Block;
4548                 $0->left = NULL;
4549                 $0->right = $<1;
4550         }$
4551
4552         $TERM pass
4553         $*exec
4554         SimpleStatement -> pass ${ $0 = NULL; }$
4555         | ERROR ${ tok_err(c, "Syntax error in statement", &$1); }$
4556         ## SimpleStatement Grammar
4557
4558 ###### print binode cases
4559         case Block:
4560                 if (indent < 0) {
4561                         // simple statement
4562                         if (b->left == NULL)    // UNTESTED
4563                                 printf("pass"); // UNTESTED
4564                         else
4565                                 print_exec(b->left, indent, bracket);   // UNTESTED
4566                         if (b->right) { // UNTESTED
4567                                 printf("; ");   // UNTESTED
4568                                 print_exec(b->right, indent, bracket);  // UNTESTED
4569                         }
4570                 } else {
4571                         // block, one per line
4572                         if (b->left == NULL)
4573                                 do_indent(indent, "pass\n");
4574                         else
4575                                 print_exec(b->left, indent, bracket);
4576                         if (b->right)
4577                                 print_exec(b->right, indent, bracket);
4578                 }
4579                 break;
4580
4581 ###### propagate binode cases
4582         case Block:
4583         {
4584                 /* If any statement returns something other than Tnone
4585                  * or Tbool then all such must return same type.
4586                  * As each statement may be Tnone or something else,
4587                  * we must always pass NULL (unknown) down, otherwise an incorrect
4588                  * error might occur.  We never return Tnone unless it is
4589                  * passed in.
4590                  */
4591                 struct binode *e;
4592
4593                 for (e = b; e; e = cast(binode, e->right)) {
4594                         t = propagate_types(e->left, c, perr, NULL, rules);
4595                         if ((rules & Rboolok) && (t == Tbool || t == Tnone))
4596                                 t = NULL;
4597                         if (t == Tnone && e->right)
4598                                 /* Only the final statement *must* return a value
4599                                  * when not Rboolok
4600                                  */
4601                                 t = NULL;
4602                         if (t) {
4603                                 if (!type)
4604                                         type = t;
4605                                 else if (t != type)
4606                                         type_err(c, "error: expected %1, found %2",
4607                                                  e->left, type, rules, t);
4608                         }
4609                 }
4610                 return type;
4611         }
4612
4613 ###### interp binode cases
4614         case Block:
4615                 while (rvtype == Tnone &&
4616                        b) {
4617                         if (b->left)
4618                                 rv = interp_exec(c, b->left, &rvtype);
4619                         b = cast(binode, b->right);
4620                 }
4621                 break;
4622
4623 ### The Print statement
4624
4625 `print` is a simple statement that takes a comma-separated list of
4626 expressions and prints the values separated by spaces and terminated
4627 by a newline.  No control of formatting is possible.
4628
4629 `print` uses `ExpressionList` to collect the expressions and stores them
4630 on the left side of a `Print` binode unlessthere is a trailing comma
4631 when the list is stored on the `right` side and no trailing newline is
4632 printed.
4633
4634 ###### Binode types
4635         Print,
4636
4637 ##### declare terminals
4638         $TERM print
4639
4640 ###### SimpleStatement Grammar
4641
4642         | print ExpressionList ${
4643                 $0 = b = new_pos(binode, $1);
4644                 b->op = Print;
4645                 b->right = NULL;
4646                 b->left = reorder_bilist($<EL);
4647         }$
4648         | print ExpressionList , ${ {
4649                 $0 = b = new_pos(binode, $1);
4650                 b->op = Print;
4651                 b->right = reorder_bilist($<EL);
4652                 b->left = NULL;
4653         } }$
4654         | print ${
4655                 $0 = b = new_pos(binode, $1);
4656                 b->op = Print;
4657                 b->left = NULL;
4658                 b->right = NULL;
4659         }$
4660
4661 ###### print binode cases
4662
4663         case Print:
4664                 do_indent(indent, "print");
4665                 if (b->right) {
4666                         print_exec(b->right, -1, bracket);
4667                         printf(",");
4668                 } else
4669                         print_exec(b->left, -1, bracket);
4670                 if (indent >= 0)
4671                         printf("\n");
4672                 break;
4673
4674 ###### propagate binode cases
4675
4676         case Print:
4677                 /* don't care but all must be consistent */
4678                 if (b->left)
4679                         b = cast(binode, b->left);
4680                 else
4681                         b = cast(binode, b->right);
4682                 while (b) {
4683                         propagate_types(b->left, c, perr_local, NULL, 0);
4684                         b = cast(binode, b->right);
4685                 }
4686                 break;
4687
4688 ###### interp binode cases
4689
4690         case Print:
4691         {
4692                 struct binode *b2 = cast(binode, b->left);
4693                 if (!b2)
4694                         b2 = cast(binode, b->right);
4695                 for (; b2; b2 = cast(binode, b2->right)) {
4696                         left = interp_exec(c, b2->left, &ltype);
4697                         print_value(ltype, &left, stdout);
4698                         free_value(ltype, &left);
4699                         if (b2->right)
4700                                 putchar(' ');
4701                 }
4702                 if (b->right == NULL)
4703                         printf("\n");
4704                 ltype = Tnone;
4705                 break;
4706         }
4707
4708 ###### Assignment statement
4709
4710 An assignment will assign a value to a variable, providing it hasn't
4711 been declared as a constant.  The analysis phase ensures that the type
4712 will be correct so the interpreter just needs to perform the
4713 calculation.  There is a form of assignment which declares a new
4714 variable as well as assigning a value.  If a name is used before
4715 it is declared, it is assumed to be a global constant which are allowed to
4716 be declared at any time.
4717
4718 ###### Binode types
4719         Assign,
4720         Declare,
4721
4722 ###### declare terminals
4723         $TERM =
4724
4725 ###### SimpleStatement Grammar
4726         | Term = Expression ${
4727                 $0 = b= new(binode);
4728                 b->op = Assign;
4729                 b->left = $<1;
4730                 b->right = $<3;
4731         }$
4732         | VariableDecl = Expression ${
4733                 $0 = b= new(binode);
4734                 b->op = Declare;
4735                 b->left = $<1;
4736                 b->right =$<3;
4737         }$
4738
4739         | VariableDecl ${
4740                 if ($1->var->where_set == NULL) {
4741                         type_err(c,
4742                                  "Variable declared with no type or value: %v",
4743                                  $1, NULL, 0, NULL);
4744                         free_var($1);
4745                 } else {
4746                         $0 = b = new(binode);
4747                         b->op = Declare;
4748                         b->left = $<1;
4749                         b->right = NULL;
4750                 }
4751         }$
4752
4753 ###### print binode cases
4754
4755         case Assign:
4756                 do_indent(indent, "");
4757                 print_exec(b->left, -1, bracket);
4758                 printf(" = ");
4759                 print_exec(b->right, -1, bracket);
4760                 if (indent >= 0)
4761                         printf("\n");
4762                 break;
4763
4764         case Declare:
4765                 {
4766                 struct variable *v = cast(var, b->left)->var;
4767                 do_indent(indent, "");
4768                 print_exec(b->left, -1, bracket);
4769                 if (cast(var, b->left)->var->constant) {
4770                         printf("::");
4771                         if (v->explicit_type) {
4772                                 type_print(v->type, stdout);
4773                                 printf(" ");
4774                         }
4775                 } else {
4776                         printf(":");
4777                         if (v->explicit_type) {
4778                                 type_print(v->type, stdout);
4779                                 printf(" ");
4780                         }
4781                 }
4782                 if (b->right) {
4783                         printf("= ");
4784                         print_exec(b->right, -1, bracket);
4785                 }
4786                 if (indent >= 0)
4787                         printf("\n");
4788                 }
4789                 break;
4790
4791 ###### propagate binode cases
4792
4793         case Assign:
4794         case Declare:
4795                 /* Both must match and not be labels,
4796                  * Type must support 'dup',
4797                  * For Assign, left must not be constant.
4798                  * result is Tnone
4799                  */
4800                 *perr &= ~(Erval | Econst);
4801                 t = propagate_types(b->left, c, perr, NULL, 0);
4802                 if (!b->right)
4803                         return Tnone;
4804
4805                 if (t) {
4806                         if (propagate_types(b->right, c, perr_local, t, 0) != t)
4807                                 if (b->left->type == Xvar)
4808                                         type_err(c, "info: variable '%v' was set as %1 here.",
4809                                                  cast(var, b->left)->var->where_set, t, rules, NULL);
4810                 } else {
4811                         t = propagate_types(b->right, c, perr_local, NULL, 0);
4812                         if (t)
4813                                 propagate_types(b->left, c, perr, t, 0);
4814                 }
4815                 if (*perr & Erval)
4816                         type_err(c, "error: cannot assign to an rval", b,
4817                                  NULL, 0, NULL);
4818                 else if (b->op == Assign && (*perr & Econst)) {
4819                         type_err(c, "error: Cannot assign to a constant: %v",
4820                                  b->left, NULL, 0, NULL);
4821                         if (b->left->type == Xvar) {
4822                                 struct var *var = cast(var, b->left);
4823                                 struct variable *v = var->var;
4824                                 type_err(c, "info: name was defined as a constant here",
4825                                          v->where_decl, NULL, 0, NULL);
4826                         }
4827                 }
4828                 if (t && t->dup == NULL && !(*perr_local & Emaycopy))
4829                         type_err(c, "error: cannot assign value of type %1", b, t, 0, NULL);
4830                 return Tnone;
4831
4832                 break;
4833
4834 ###### interp binode cases
4835
4836         case Assign:
4837                 lleft = linterp_exec(c, b->left, &ltype);
4838                 if (lleft)
4839                         dinterp_exec(c, b->right, lleft, ltype, 1);
4840                 ltype = Tnone;
4841                 break;
4842
4843         case Declare:
4844         {
4845                 struct variable *v = cast(var, b->left)->var;
4846                 struct value *val;
4847                 v = v->merged;
4848                 val = var_value(c, v);
4849                 if (v->type->prepare_type)
4850                         v->type->prepare_type(c, v->type, 0);
4851                 if (b->right)
4852                         dinterp_exec(c, b->right, val, v->type, 0);
4853                 else
4854                         val_init(v->type, val);
4855                 break;
4856         }
4857
4858 ### The `use` statement
4859
4860 The `use` statement is the last "simple" statement.  It is needed when a
4861 statement block can return a value.  This includes the body of a
4862 function which has a return type, and the "condition" code blocks in
4863 `if`, `while`, and `switch` statements.
4864
4865 ###### Binode types
4866         Use,
4867
4868 ###### declare terminals
4869         $TERM use
4870
4871 ###### SimpleStatement Grammar
4872         | use Expression ${
4873                 $0 = b = new_pos(binode, $1);
4874                 b->op = Use;
4875                 b->right = $<2;
4876         }$
4877
4878 ###### print binode cases
4879
4880         case Use:
4881                 do_indent(indent, "use ");
4882                 print_exec(b->right, -1, bracket);
4883                 if (indent >= 0)
4884                         printf("\n");
4885                 break;
4886
4887 ###### propagate binode cases
4888
4889         case Use:
4890                 /* result matches value */
4891                 return propagate_types(b->right, c, perr, type, 0);
4892
4893 ###### interp binode cases
4894
4895         case Use:
4896                 rv = interp_exec(c, b->right, &rvtype);
4897                 break;
4898
4899 ### The Conditional Statement
4900
4901 This is the biggy and currently the only complex statement.  This
4902 subsumes `if`, `while`, `do/while`, `switch`, and some parts of `for`.
4903 It is comprised of a number of parts, all of which are optional though
4904 set combinations apply.  Each part is (usually) a key word (`then` is
4905 sometimes optional) followed by either an expression or a code block,
4906 except the `casepart` which is a "key word and an expression" followed
4907 by a code block.  The code-block option is valid for all parts and,
4908 where an expression is also allowed, the code block can use the `use`
4909 statement to report a value.  If the code block does not report a value
4910 the effect is similar to reporting `True`.
4911
4912 The `else` and `case` parts, as well as `then` when combined with
4913 `if`, can contain a `use` statement which will apply to some
4914 containing conditional statement. `for` parts, `do` parts and `then`
4915 parts used with `for` can never contain a `use`, except in some
4916 subordinate conditional statement.
4917
4918 If there is a `forpart`, it is executed first, only once.
4919 If there is a `dopart`, then it is executed repeatedly providing
4920 always that the `condpart` or `cond`, if present, does not return a non-True
4921 value.  `condpart` can fail to return any value if it simply executes
4922 to completion.  This is treated the same as returning `True`.
4923
4924 If there is a `thenpart` it will be executed whenever the `condpart`
4925 or `cond` returns True (or does not return any value), but this will happen
4926 *after* `dopart` (when present).
4927
4928 If `elsepart` is present it will be executed at most once when the
4929 condition returns `False` or some value that isn't `True` and isn't
4930 matched by any `casepart`.  If there are any `casepart`s, they will be
4931 executed when the condition returns a matching value.
4932
4933 The particular sorts of values allowed in case parts has not yet been
4934 determined in the language design, so nothing is prohibited.
4935
4936 The various blocks in this complex statement potentially provide scope
4937 for variables as described earlier.  Each such block must include the
4938 "OpenScope" nonterminal before parsing the block, and must call
4939 `var_block_close()` when closing the block.
4940
4941 The code following "`if`", "`switch`" and "`for`" does not get its own
4942 scope, but is in a scope covering the whole statement, so names
4943 declared there cannot be redeclared elsewhere.  Similarly the
4944 condition following "`while`" is in a scope the covers the body
4945 ("`do`" part) of the loop, and which does not allow conditional scope
4946 extension.  Code following "`then`" (both looping and non-looping),
4947 "`else`" and "`case`" each get their own local scope.
4948
4949 The type requirements on the code block in a `whilepart` are quite
4950 unusal.  It is allowed to return a value of some identifiable type, in
4951 which case the loop aborts and an appropriate `casepart` is run, or it
4952 can return a Boolean, in which case the loop either continues to the
4953 `dopart` (on `True`) or aborts and runs the `elsepart` (on `False`).
4954 This is different both from the `ifpart` code block which is expected to
4955 return a Boolean, or the `switchpart` code block which is expected to
4956 return the same type as the casepart values.  The correct analysis of
4957 the type of the `whilepart` code block is the reason for the
4958 `Rboolok` flag which is passed to `propagate_types()`.
4959
4960 The `cond_statement` cannot fit into a `binode` so a new `exec` is
4961 defined.  As there are two scopes which cover multiple parts - one for
4962 the whole statement and one for "while" and "do" - and as we will use
4963 the 'struct exec' to track scopes, we actually need two new types of
4964 exec.  One is a `binode` for the looping part, the rest is the
4965 `cond_statement`.  The `cond_statement` will use an auxilliary `struct
4966 casepart` to track a list of case parts.
4967
4968 ###### Binode types
4969         Loop
4970
4971 ###### exec type
4972         Xcond_statement,
4973
4974 ###### ast
4975         struct casepart {
4976                 struct exec *value;
4977                 struct exec *action;
4978                 struct casepart *next;
4979         };
4980         struct cond_statement {
4981                 struct exec;
4982                 struct exec *forpart, *condpart, *thenpart, *elsepart;
4983                 struct binode *looppart;
4984                 struct casepart *casepart;
4985         };
4986
4987 ###### ast functions
4988
4989         static void free_casepart(struct casepart *cp)
4990         {
4991                 while (cp) {
4992                         struct casepart *t;
4993                         free_exec(cp->value);
4994                         free_exec(cp->action);
4995                         t = cp->next;
4996                         free(cp);
4997                         cp = t;
4998                 }
4999         }
5000
5001         static void free_cond_statement(struct cond_statement *s)
5002         {
5003                 if (!s)
5004                         return;
5005                 free_exec(s->forpart);
5006                 free_exec(s->condpart);
5007                 free_exec(s->looppart);
5008                 free_exec(s->thenpart);
5009                 free_exec(s->elsepart);
5010                 free_casepart(s->casepart);
5011                 free(s);
5012         }
5013
5014 ###### free exec cases
5015         case Xcond_statement: free_cond_statement(cast(cond_statement, e)); break;
5016
5017 ###### ComplexStatement Grammar
5018         | CondStatement ${ $0 = $<1; }$
5019
5020 ###### declare terminals
5021         $TERM for then while do
5022         $TERM else
5023         $TERM switch case
5024
5025 ###### Grammar
5026
5027         $*cond_statement
5028         // A CondStatement must end with EOL, as does CondSuffix and
5029         // IfSuffix.
5030         // ForPart, ThenPart, SwitchPart, CasePart are non-empty and
5031         // may or may not end with EOL
5032         // WhilePart and IfPart include an appropriate Suffix
5033
5034         // ForPart, SwitchPart, and IfPart open scopes, o we have to close
5035         // them.  WhilePart opens and closes its own scope.
5036         CondStatement -> ForPart OptNL ThenPart OptNL WhilePart CondSuffix ${
5037                 $0 = $<CS;
5038                 $0->forpart = $<FP;
5039                 $0->thenpart = $<TP;
5040                 $0->looppart = $<WP;
5041                 var_block_close(c, CloseSequential, $0);
5042         }$
5043         | ForPart OptNL WhilePart CondSuffix ${
5044                 $0 = $<CS;
5045                 $0->forpart = $<FP;
5046                 $0->looppart = $<WP;
5047                 var_block_close(c, CloseSequential, $0);
5048         }$
5049         | WhilePart CondSuffix ${
5050                 $0 = $<CS;
5051                 $0->looppart = $<WP;
5052         }$
5053         | SwitchPart OptNL CasePart CondSuffix ${
5054                 $0 = $<CS;
5055                 $0->condpart = $<SP;
5056                 $CP->next = $0->casepart;
5057                 $0->casepart = $<CP;
5058                 var_block_close(c, CloseSequential, $0);
5059         }$
5060         | SwitchPart : IN OptNL CasePart CondSuffix OUT Newlines ${
5061                 $0 = $<CS;
5062                 $0->condpart = $<SP;
5063                 $CP->next = $0->casepart;
5064                 $0->casepart = $<CP;
5065                 var_block_close(c, CloseSequential, $0);
5066         }$
5067         | IfPart IfSuffix ${
5068                 $0 = $<IS;
5069                 $0->condpart = $IP.condpart; $IP.condpart = NULL;
5070                 $0->thenpart = $IP.thenpart; $IP.thenpart = NULL;
5071                 // This is where we close an "if" statement
5072                 var_block_close(c, CloseSequential, $0);
5073         }$
5074
5075         CondSuffix -> IfSuffix ${
5076                 $0 = $<1;
5077         }$
5078         | Newlines CasePart CondSuffix ${
5079                 $0 = $<CS;
5080                 $CP->next = $0->casepart;
5081                 $0->casepart = $<CP;
5082         }$
5083         | CasePart CondSuffix ${
5084                 $0 = $<CS;
5085                 $CP->next = $0->casepart;
5086                 $0->casepart = $<CP;
5087         }$
5088
5089         IfSuffix -> Newlines ${ $0 = new(cond_statement); }$
5090         | Newlines ElsePart ${ $0 = $<EP; }$
5091         | ElsePart ${$0 = $<EP; }$
5092
5093         ElsePart -> else OpenBlock Newlines ${
5094                 $0 = new(cond_statement);
5095                 $0->elsepart = $<OB;
5096                 var_block_close(c, CloseElse, $0->elsepart);
5097         }$
5098         | else OpenScope CondStatement ${
5099                 $0 = new(cond_statement);
5100                 $0->elsepart = $<CS;
5101                 var_block_close(c, CloseElse, $0->elsepart);
5102         }$
5103
5104         $*casepart
5105         CasePart -> case Expression OpenScope ColonBlock ${
5106                 $0 = calloc(1,sizeof(struct casepart));
5107                 $0->value = $<Ex;
5108                 $0->action = $<Bl;
5109                 var_block_close(c, CloseParallel, $0->action);
5110         }$
5111
5112         $*exec
5113         // These scopes are closed in CondStatement
5114         ForPart -> for OpenBlock ${
5115                 $0 = $<Bl;
5116         }$
5117
5118         ThenPart -> then OpenBlock ${
5119                 $0 = $<OB;
5120                 var_block_close(c, CloseSequential, $0);
5121         }$
5122
5123         $*binode
5124         // This scope is closed in CondStatement
5125         WhilePart -> while UseBlock OptNL do OpenBlock ${
5126                 $0 = new(binode);
5127                 $0->op = Loop;
5128                 $0->left = $<UB;
5129                 $0->right = $<OB;
5130                 var_block_close(c, CloseSequential, $0->right);
5131                 var_block_close(c, CloseSequential, $0);
5132         }$
5133         | while OpenScope Expression OpenScope ColonBlock ${
5134                 $0 = new(binode);
5135                 $0->op = Loop;
5136                 $0->left = $<Exp;
5137                 $0->right = $<CB;
5138                 var_block_close(c, CloseSequential, $0->right);
5139                 var_block_close(c, CloseSequential, $0);
5140         }$
5141
5142         $cond_statement
5143         IfPart -> if UseBlock OptNL then OpenBlock ${
5144                 $0.condpart = $<UB;
5145                 $0.thenpart = $<OB;
5146                 var_block_close(c, CloseParallel, $0.thenpart);
5147         }$
5148         | if OpenScope Expression OpenScope ColonBlock ${
5149                 $0.condpart = $<Ex;
5150                 $0.thenpart = $<CB;
5151                 var_block_close(c, CloseParallel, $0.thenpart);
5152         }$
5153         | if OpenScope Expression OpenScope OptNL then Block ${
5154                 $0.condpart = $<Ex;
5155                 $0.thenpart = $<Bl;
5156                 var_block_close(c, CloseParallel, $0.thenpart);
5157         }$
5158
5159         $*exec
5160         // This scope is closed in CondStatement
5161         SwitchPart -> switch OpenScope Expression ${
5162                 $0 = $<Ex;
5163         }$
5164         | switch UseBlock ${
5165                 $0 = $<Bl;
5166         }$
5167
5168 ###### print binode cases
5169         case Loop:
5170                 if (b->left && b->left->type == Xbinode &&
5171                     cast(binode, b->left)->op == Block) {
5172                         if (bracket)
5173                                 do_indent(indent, "while {\n");
5174                         else
5175                                 do_indent(indent, "while\n");
5176                         print_exec(b->left, indent+1, bracket);
5177                         if (bracket)
5178                                 do_indent(indent, "} do {\n");
5179                         else
5180                                 do_indent(indent, "do\n");
5181                         print_exec(b->right, indent+1, bracket);
5182                         if (bracket)
5183                                 do_indent(indent, "}\n");
5184                 } else {
5185                         do_indent(indent, "while ");
5186                         print_exec(b->left, 0, bracket);
5187                         if (bracket)
5188                                 printf(" {\n");
5189                         else
5190                                 printf(":\n");
5191                         print_exec(b->right, indent+1, bracket);
5192                         if (bracket)
5193                                 do_indent(indent, "}\n");
5194                 }
5195                 break;
5196
5197 ###### print exec cases
5198
5199         case Xcond_statement:
5200         {
5201                 struct cond_statement *cs = cast(cond_statement, e);
5202                 struct casepart *cp;
5203                 if (cs->forpart) {
5204                         do_indent(indent, "for");
5205                         if (bracket) printf(" {\n"); else printf("\n");
5206                         print_exec(cs->forpart, indent+1, bracket);
5207                         if (cs->thenpart) {
5208                                 if (bracket)
5209                                         do_indent(indent, "} then {\n");
5210                                 else
5211                                         do_indent(indent, "then\n");
5212                                 print_exec(cs->thenpart, indent+1, bracket);
5213                         }
5214                         if (bracket) do_indent(indent, "}\n");
5215                 }
5216                 if (cs->looppart) {
5217                         print_exec(cs->looppart, indent, bracket);
5218                 } else {
5219                         // a condition
5220                         if (cs->casepart)
5221                                 do_indent(indent, "switch");
5222                         else
5223                                 do_indent(indent, "if");
5224                         if (cs->condpart && cs->condpart->type == Xbinode &&
5225                             cast(binode, cs->condpart)->op == Block) {
5226                                 if (bracket)
5227                                         printf(" {\n");
5228                                 else
5229                                         printf("\n");
5230                                 print_exec(cs->condpart, indent+1, bracket);
5231                                 if (bracket)
5232                                         do_indent(indent, "}\n");
5233                                 if (cs->thenpart) {
5234                                         do_indent(indent, "then\n");
5235                                         print_exec(cs->thenpart, indent+1, bracket);
5236                                 }
5237                         } else {
5238                                 printf(" ");
5239                                 print_exec(cs->condpart, 0, bracket);
5240                                 if (cs->thenpart) {
5241                                         if (bracket)
5242                                                 printf(" {\n");
5243                                         else
5244                                                 printf(":\n");
5245                                         print_exec(cs->thenpart, indent+1, bracket);
5246                                         if (bracket)
5247                                                 do_indent(indent, "}\n");
5248                                 } else
5249                                         printf("\n");
5250                         }
5251                 }
5252                 for (cp = cs->casepart; cp; cp = cp->next) {
5253                         do_indent(indent, "case ");
5254                         print_exec(cp->value, -1, 0);
5255                         if (bracket)
5256                                 printf(" {\n");
5257                         else
5258                                 printf(":\n");
5259                         print_exec(cp->action, indent+1, bracket);
5260                         if (bracket)
5261                                 do_indent(indent, "}\n");
5262                 }
5263                 if (cs->elsepart) {
5264                         do_indent(indent, "else");
5265                         if (bracket)
5266                                 printf(" {\n");
5267                         else
5268                                 printf("\n");
5269                         print_exec(cs->elsepart, indent+1, bracket);
5270                         if (bracket)
5271                                 do_indent(indent, "}\n");
5272                 }
5273                 break;
5274         }
5275
5276 ###### propagate binode cases
5277         case Loop:
5278                 t = propagate_types(b->right, c, perr_local, Tnone, 0);
5279                 if (!type_compat(Tnone, t, 0))
5280                         *perr |= Efail; // UNTESTED
5281                 return propagate_types(b->left, c, perr, type, rules);
5282
5283 ###### propagate exec cases
5284         case Xcond_statement:
5285         {
5286                 // forpart and looppart->right must return Tnone
5287                 // thenpart must return Tnone if there is a loopart,
5288                 // otherwise it is like elsepart.
5289                 // condpart must:
5290                 //    be bool if there is no casepart
5291                 //    match casepart->values if there is a switchpart
5292                 //    either be bool or match casepart->value if there
5293                 //             is a whilepart
5294                 // elsepart and casepart->action must match the return type
5295                 //   expected of this statement.
5296                 struct cond_statement *cs = cast(cond_statement, prog);
5297                 struct casepart *cp;
5298
5299                 t = propagate_types(cs->forpart, c, perr, Tnone, 0);
5300                 if (!type_compat(Tnone, t, 0))
5301                         *perr |= Efail; // UNTESTED
5302
5303                 if (cs->looppart) {
5304                         t = propagate_types(cs->thenpart, c, perr, Tnone, 0);
5305                         if (!type_compat(Tnone, t, 0))
5306                                 *perr |= Efail; // UNTESTED
5307                 }
5308                 if (cs->casepart == NULL) {
5309                         propagate_types(cs->condpart, c, perr, Tbool, 0);
5310                         propagate_types(cs->looppart, c, perr, Tbool, 0);
5311                 } else {
5312                         /* Condpart must match case values, with bool permitted */
5313                         t = NULL;
5314                         for (cp = cs->casepart;
5315                              cp && !t; cp = cp->next)
5316                                 t = propagate_types(cp->value, c, perr, NULL, 0);
5317                         if (!t && cs->condpart)
5318                                 t = propagate_types(cs->condpart, c, perr, NULL, Rboolok);      // UNTESTED
5319                         if (!t && cs->looppart)
5320                                 t = propagate_types(cs->looppart, c, perr, NULL, Rboolok);      // UNTESTED
5321                         // Now we have a type (I hope) push it down
5322                         if (t) {
5323                                 for (cp = cs->casepart; cp; cp = cp->next)
5324                                         propagate_types(cp->value, c, perr, t, 0);
5325                                 propagate_types(cs->condpart, c, perr, t, Rboolok);
5326                                 propagate_types(cs->looppart, c, perr, t, Rboolok);
5327                         }
5328                 }
5329                 // (if)then, else, and case parts must return expected type.
5330                 if (!cs->looppart && !type)
5331                         type = propagate_types(cs->thenpart, c, perr, NULL, rules);
5332                 if (!type)
5333                         type = propagate_types(cs->elsepart, c, perr, NULL, rules);
5334                 for (cp = cs->casepart;
5335                      cp && !type;
5336                      cp = cp->next)     // UNTESTED
5337                         type = propagate_types(cp->action, c, perr, NULL, rules);       // UNTESTED
5338                 if (type) {
5339                         if (!cs->looppart)
5340                                 propagate_types(cs->thenpart, c, perr, type, rules);
5341                         propagate_types(cs->elsepart, c, perr, type, rules);
5342                         for (cp = cs->casepart; cp ; cp = cp->next)
5343                                 propagate_types(cp->action, c, perr, type, rules);
5344                         return type;
5345                 } else
5346                         return NULL;
5347         }
5348
5349 ###### interp binode cases
5350         case Loop:
5351                 // This just performs one iterration of the loop
5352                 rv = interp_exec(c, b->left, &rvtype);
5353                 if (rvtype == Tnone ||
5354                     (rvtype == Tbool && rv.bool != 0))
5355                         // rvtype is Tnone or Tbool, doesn't need to be freed
5356                         interp_exec(c, b->right, NULL);
5357                 break;
5358
5359 ###### interp exec cases
5360         case Xcond_statement:
5361         {
5362                 struct value v, cnd;
5363                 struct type *vtype, *cndtype;
5364                 struct casepart *cp;
5365                 struct cond_statement *cs = cast(cond_statement, e);
5366
5367                 if (cs->forpart)
5368                         interp_exec(c, cs->forpart, NULL);
5369                 if (cs->looppart) {
5370                         while ((cnd = interp_exec(c, cs->looppart, &cndtype)),
5371                                cndtype == Tnone || (cndtype == Tbool && cnd.bool != 0))
5372                                 interp_exec(c, cs->thenpart, NULL);
5373                 } else {
5374                         cnd = interp_exec(c, cs->condpart, &cndtype);
5375                         if ((cndtype == Tnone ||
5376                             (cndtype == Tbool && cnd.bool != 0))) {
5377                                 // cnd is Tnone or Tbool, doesn't need to be freed
5378                                 rv = interp_exec(c, cs->thenpart, &rvtype);
5379                                 // skip else (and cases)
5380                                 goto Xcond_done;
5381                         }
5382                 }
5383                 for (cp = cs->casepart; cp; cp = cp->next) {
5384                         v = interp_exec(c, cp->value, &vtype);
5385                         if (value_cmp(cndtype, vtype, &v, &cnd) == 0) {
5386                                 free_value(vtype, &v);
5387                                 free_value(cndtype, &cnd);
5388                                 rv = interp_exec(c, cp->action, &rvtype);
5389                                 goto Xcond_done;
5390                         }
5391                         free_value(vtype, &v);
5392                 }
5393                 free_value(cndtype, &cnd);
5394                 if (cs->elsepart)
5395                         rv = interp_exec(c, cs->elsepart, &rvtype);
5396                 else
5397                         rvtype = Tnone;
5398         Xcond_done:
5399                 break;
5400         }
5401
5402 ### Top level structure
5403
5404 All the language elements so far can be used in various places.  Now
5405 it is time to clarify what those places are.
5406
5407 At the top level of a file there will be a number of declarations.
5408 Many of the things that can be declared haven't been described yet,
5409 such as functions, procedures, imports, and probably more.
5410 For now there are two sorts of things that can appear at the top
5411 level.  They are predefined constants, `struct` types, and the `main`
5412 function.  While the syntax will allow the `main` function to appear
5413 multiple times, that will trigger an error if it is actually attempted.
5414
5415 The various declarations do not return anything.  They store the
5416 various declarations in the parse context.
5417
5418 ###### Parser: grammar
5419
5420         $void
5421         Ocean -> OptNL DeclarationList
5422
5423         ## declare terminals
5424
5425         OptNL ->
5426         | OptNL NEWLINE
5427
5428         Newlines -> NEWLINE
5429         | Newlines NEWLINE
5430
5431         DeclarationList -> Declaration
5432         | DeclarationList Declaration
5433
5434         Declaration -> ERROR Newlines ${
5435                 tok_err(c,      // UNTESTED
5436                         "error: unhandled parse error", &$1);
5437         }$
5438         | DeclareConstant
5439         | DeclareFunction
5440         | DeclareStruct
5441
5442         ## top level grammar
5443
5444         ## Grammar
5445
5446 ### The `const` section
5447
5448 As well as being defined in with the code that uses them, constants can
5449 be declared at the top level.  These have full-file scope, so they are
5450 always `InScope`, even before(!) they have been declared.  The value of
5451 a top level constant can be given as an expression, and this is
5452 evaluated after parsing and before execution.
5453
5454 A function call can be used to evaluate a constant, but it will not have
5455 access to any program state, once such statement becomes meaningful.
5456 e.g.  arguments and filesystem will not be visible.
5457
5458 Constants are defined in a section that starts with the reserved word
5459 `const` and then has a block with a list of assignment statements.
5460 For syntactic consistency, these must use the double-colon syntax to
5461 make it clear that they are constants.  Type can also be given: if
5462 not, the type will be determined during analysis, as with other
5463 constants.
5464
5465 ###### parse context
5466         struct binode *constlist;
5467
5468 ###### top level grammar
5469
5470         $TERM const
5471
5472         DeclareConstant -> const { IN OptNL ConstList OUT OptNL } Newlines
5473         | const { SimpleConstList } Newlines
5474         | const IN OptNL ConstList OUT Newlines
5475         | const SimpleConstList Newlines
5476
5477         ConstList -> ConstList SimpleConstLine
5478         | SimpleConstLine
5479
5480         SimpleConstList -> SimpleConstList ; Const
5481         | Const
5482         | SimpleConstList ;
5483
5484         SimpleConstLine -> SimpleConstList Newlines
5485         | ERROR Newlines ${ tok_err(c, "Syntax error in constant", &$1); }$
5486
5487         $*type
5488         CType -> Type   ${ $0 = $<1; }$
5489         |               ${ $0 = NULL; }$
5490
5491         $void
5492         Const -> IDENTIFIER :: CType = Expression ${ {
5493                 struct variable *v;
5494                 struct binode *bl, *bv;
5495                 struct var *var = new_pos(var, $ID);
5496
5497                 v = var_decl(c, $ID.txt);
5498                 if (v) {
5499                         v->where_decl = var;
5500                         v->where_set = var;
5501                         v->type = $<CT;
5502                         v->constant = 1;
5503                         v->global = 1;
5504                 } else {
5505                         v = var_ref(c, $1.txt);
5506                         if (v->type == Tnone) {
5507                                 v->where_decl = var;
5508                                 v->where_set = var;
5509                                 v->type = $<CT;
5510                                 v->constant = 1;
5511                                 v->global = 1;
5512                         } else {
5513                                 tok_err(c, "error: name already declared", &$1);
5514                                 type_err(c, "info: this is where '%v' was first declared",
5515                                          v->where_decl, NULL, 0, NULL);
5516                         }
5517                 }
5518                 var->var = v;
5519
5520                 bv = new(binode);
5521                 bv->op = Declare;
5522                 bv->left = var;
5523                 bv->right= $<Exp;
5524
5525                 bl = new(binode);
5526                 bl->op = List;
5527                 bl->left = c->constlist;
5528                 bl->right = bv;
5529                 c->constlist = bl;
5530         } }$
5531
5532 ###### core functions
5533         static void resolve_consts(struct parse_context *c)
5534         {
5535                 struct binode *b;
5536                 int retry = 1;
5537                 enum { none, some, cannot } progress = none;
5538
5539                 c->constlist = reorder_bilist(c->constlist);
5540                 while (retry) {
5541                         retry = 0;
5542                         for (b = cast(binode, c->constlist); b;
5543                              b = cast(binode, b->right)) {
5544                                 enum prop_err perr;
5545                                 struct binode *vb = cast(binode, b->left);
5546                                 struct var *v = cast(var, vb->left);
5547                                 if (v->var->frame_pos >= 0)
5548                                         continue;
5549                                 do {
5550                                         perr = 0;
5551                                         propagate_types(vb->right, c, &perr,
5552                                                         v->var->type, 0);
5553                                 } while (perr & Eretry);
5554                                 if (perr & Efail)
5555                                         c->parse_error += 1;
5556                                 else if (!(perr & Eruntime)) {
5557                                         progress = some;
5558                                         struct value res = interp_exec(
5559                                                 c, vb->right, &v->var->type);
5560                                         global_alloc(c, v->var->type, v->var, &res);
5561                                 } else {
5562                                         if (progress == cannot)
5563                                                 type_err(c, "error: const %v cannot be resolved.",
5564                                                          v, NULL, 0, NULL);
5565                                         else
5566                                                 retry = 1;
5567                                 }
5568                         }
5569                         switch (progress) {
5570                         case cannot:
5571                                 retry = 0; break;
5572                         case none:
5573                                 progress = cannot; break;
5574                         case some:
5575                                 progress = none; break;
5576                         }
5577                 }
5578         }
5579
5580 ###### print const decls
5581         {
5582                 struct binode *b;
5583                 int first = 1;
5584
5585                 for (b = cast(binode, context.constlist); b;
5586                      b = cast(binode, b->right)) {
5587                         struct binode *vb = cast(binode, b->left);
5588                         struct var *vr = cast(var, vb->left);
5589                         struct variable *v = vr->var;
5590
5591                         if (first)
5592                                 printf("const\n");
5593                         first = 0;
5594
5595                         printf("    %.*s :: ", v->name->name.len, v->name->name.txt);
5596                         type_print(v->type, stdout);
5597                         printf(" = ");
5598                         print_exec(vb->right, -1, 0);
5599                         printf("\n");
5600                 }
5601         }
5602
5603 ###### free const decls
5604         free_binode(context.constlist);
5605
5606 ### Function declarations
5607
5608 The code in an Ocean program is all stored in function declarations.
5609 One of the functions must be named `main` and it must accept an array of
5610 strings as a parameter - the command line arguments.
5611
5612 As this is the top level, several things are handled a bit differently.
5613 The function is not interpreted by `interp_exec` as that isn't passed
5614 the argument list which the program requires.  Similarly type analysis
5615 is a bit more interesting at this level.
5616
5617 ###### ast functions
5618
5619         static struct type *handle_results(struct parse_context *c,
5620                                            struct binode *results)
5621         {
5622                 /* Create a 'struct' type from the results list, which
5623                  * is a list for 'struct var'
5624                  */
5625                 struct type *t = add_anon_type(c, &structure_prototype,
5626                                                "function result");
5627                 int cnt = 0;
5628                 struct binode *b;
5629
5630                 for (b = results; b; b = cast(binode, b->right))
5631                         cnt += 1;
5632                 t->structure.nfields = cnt;
5633                 t->structure.fields = calloc(cnt, sizeof(struct field));
5634                 cnt = 0;
5635                 for (b = results; b; b = cast(binode, b->right)) {
5636                         struct var *v = cast(var, b->left);
5637                         struct field *f = &t->structure.fields[cnt++];
5638                         int a = v->var->type->align;
5639                         f->name = v->var->name->name;
5640                         f->type = v->var->type;
5641                         f->init = NULL;
5642                         f->offset = t->size;
5643                         v->var->frame_pos = f->offset;
5644                         t->size += ((f->type->size - 1) | (a-1)) + 1;
5645                         if (a > t->align)
5646                                 t->align = a;
5647                         variable_unlink_exec(v->var);
5648                 }
5649                 free_binode(results);
5650                 return t;
5651         }
5652
5653         static struct variable *declare_function(struct parse_context *c,
5654                                                 struct variable *name,
5655                                                 struct binode *args,
5656                                                 struct type *ret,
5657                                                 struct binode *results,
5658                                                 struct exec *code)
5659         {
5660                 if (name) {
5661                         struct value fn = {.function = code};
5662                         struct type *t;
5663                         var_block_close(c, CloseFunction, code);
5664                         t = add_anon_type(c, &function_prototype,
5665                                           "func %.*s", name->name->name.len,
5666                                           name->name->name.txt);
5667                         name->type = t;
5668                         t->function.params = reorder_bilist(args);
5669                         if (!ret) {
5670                                 ret = handle_results(c, reorder_bilist(results));
5671                                 t->function.inline_result = 1;
5672                                 t->function.local_size = ret->size;
5673                         }
5674                         t->function.return_type = ret;
5675                         global_alloc(c, t, name, &fn);
5676                         name->type->function.scope = c->out_scope;
5677                 } else {
5678                         free_binode(args);
5679                         free_type(ret);
5680                         free_exec(code);
5681                         var_block_close(c, CloseFunction, NULL);
5682                 }
5683                 c->out_scope = NULL;
5684                 return name;
5685         }
5686
5687 ###### declare terminals
5688         $TERM return
5689
5690 ###### top level grammar
5691
5692         $*variable
5693         DeclareFunction -> func FuncName ( OpenScope ArgsLine ) Block Newlines ${
5694                 $0 = declare_function(c, $<FN, $<Ar, Tnone, NULL, $<Bl);
5695         }$
5696         | func FuncName IN OpenScope Args OUT OptNL do Block Newlines ${
5697                 $0 = declare_function(c, $<FN, $<Ar, Tnone, NULL, $<Bl);
5698         }$
5699         | func FuncName NEWLINE OpenScope OptNL do Block Newlines ${
5700                 $0 = declare_function(c, $<FN, NULL, Tnone, NULL, $<Bl);
5701         }$
5702         | func FuncName ( OpenScope ArgsLine ) : Type Block Newlines ${
5703                 $0 = declare_function(c, $<FN, $<Ar, $<Ty, NULL, $<Bl);
5704         }$
5705         | func FuncName ( OpenScope ArgsLine ) : ( ArgsLine ) Block Newlines ${
5706                 $0 = declare_function(c, $<FN, $<AL, NULL, $<AL2, $<Bl);
5707         }$
5708         | func FuncName IN OpenScope Args OUT OptNL return Type Newlines do Block Newlines ${
5709                 $0 = declare_function(c, $<FN, $<Ar, $<Ty, NULL, $<Bl);
5710         }$
5711         | func FuncName NEWLINE OpenScope return Type Newlines do Block Newlines ${
5712                 $0 = declare_function(c, $<FN, NULL, $<Ty, NULL, $<Bl);
5713         }$
5714         | func FuncName IN OpenScope Args OUT OptNL return IN Args OUT OptNL do Block Newlines ${
5715                 $0 = declare_function(c, $<FN, $<Ar, NULL, $<Ar2, $<Bl);
5716         }$
5717         | func FuncName NEWLINE OpenScope return IN Args OUT OptNL do Block Newlines ${
5718                 $0 = declare_function(c, $<FN, NULL, NULL, $<Ar, $<Bl);
5719         }$
5720
5721 ###### print func decls
5722         {
5723                 struct variable *v;
5724                 int target = -1;
5725
5726                 while (target != 0) {
5727                         int i = 0;
5728                         for (v = context.in_scope; v; v=v->in_scope)
5729                                 if (v->depth == 0 && v->type && v->type->check_args) {
5730                                         i += 1;
5731                                         if (i == target)
5732                                                 break;
5733                                 }
5734
5735                         if (target == -1) {
5736                                 target = i;
5737                         } else {
5738                                 struct value *val = var_value(&context, v);
5739                                 printf("func %.*s", v->name->name.len, v->name->name.txt);
5740                                 v->type->print_type_decl(v->type, stdout);
5741                                 if (brackets)
5742                                         print_exec(val->function, 0, brackets);
5743                                 else
5744                                         print_value(v->type, val, stdout);
5745                                 printf("/* frame size %d */\n", v->type->function.local_size);
5746                                 target -= 1;
5747                         }
5748                 }
5749         }
5750
5751 ###### core functions
5752
5753         static int analyse_funcs(struct parse_context *c)
5754         {
5755                 struct variable *v;
5756                 int all_ok = 1;
5757                 for (v = c->in_scope; v; v = v->in_scope) {
5758                         struct value *val;
5759                         struct type *ret;
5760                         enum prop_err perr;
5761                         if (v->depth != 0 || !v->type || !v->type->check_args)
5762                                 continue;
5763                         ret = v->type->function.inline_result ?
5764                                 Tnone : v->type->function.return_type;
5765                         val = var_value(c, v);
5766                         do {
5767                                 perr = 0;
5768                                 propagate_types(val->function, c, &perr, ret, 0);
5769                         } while (!(perr & Efail) && (perr & Eretry));
5770                         if (!(perr & Efail))
5771                                 /* Make sure everything is still consistent */
5772                                 propagate_types(val->function, c, &perr, ret, 0);
5773                         if (perr & Efail)
5774                                 all_ok = 0;
5775                         if (!v->type->function.inline_result &&
5776                             !v->type->function.return_type->dup) {
5777                                 type_err(c, "error: function cannot return value of type %1",
5778                                          v->where_decl, v->type->function.return_type, 0, NULL);
5779                         }
5780
5781                         scope_finalize(c, v->type);
5782                 }
5783                 return all_ok;
5784         }
5785
5786         static int analyse_main(struct type *type, struct parse_context *c)
5787         {
5788                 struct binode *bp = type->function.params;
5789                 struct binode *b;
5790                 enum prop_err perr;
5791                 int arg = 0;
5792                 struct type *argv_type;
5793
5794                 argv_type = add_anon_type(c, &array_prototype, "argv");
5795                 argv_type->array.member = Tstr;
5796                 argv_type->array.unspec = 1;
5797
5798                 for (b = bp; b; b = cast(binode, b->right)) {
5799                         perr = 0;
5800                         switch (arg++) {
5801                         case 0: /* argv */
5802                                 propagate_types(b->left, c, &perr, argv_type, 0);
5803                                 break;
5804                         default: /* invalid */  // NOTEST
5805                                 propagate_types(b->left, c, &perr, Tnone, 0);   // NOTEST
5806                         }
5807                         if (perr & Efail)
5808                                 c->parse_error += 1;
5809                 }
5810
5811                 return !c->parse_error;
5812         }
5813
5814         static void interp_main(struct parse_context *c, int argc, char **argv)
5815         {
5816                 struct value *progp = NULL;
5817                 struct text main_name = { "main", 4 };
5818                 struct variable *mainv;
5819                 struct binode *al;
5820                 int anum = 0;
5821                 struct value v;
5822                 struct type *vtype;
5823
5824                 mainv = var_ref(c, main_name);
5825                 if (mainv)
5826                         progp = var_value(c, mainv);
5827                 if (!progp || !progp->function) {
5828                         fprintf(stderr, "oceani: no main function found.\n");
5829                         c->parse_error += 1;
5830                         return;
5831                 }
5832                 if (!analyse_main(mainv->type, c)) {
5833                         fprintf(stderr, "oceani: main has wrong type.\n");
5834                         c->parse_error += 1;
5835                         return;
5836                 }
5837                 al = mainv->type->function.params;
5838
5839                 c->local_size = mainv->type->function.local_size;
5840                 c->local = calloc(1, c->local_size);
5841                 while (al) {
5842                         struct var *v = cast(var, al->left);
5843                         struct value *vl = var_value(c, v->var);
5844                         struct value arg;
5845                         struct type *t;
5846                         mpq_t argcq;
5847                         int i;
5848
5849                         switch (anum++) {
5850                         case 0: /* argv */
5851                                 t = v->var->type;
5852                                 mpq_init(argcq);
5853                                 mpq_set_ui(argcq, argc, 1);
5854                                 memcpy(var_value(c, t->array.vsize), &argcq, sizeof(argcq));
5855                                 t->prepare_type(c, t, 0);
5856                                 array_init(v->var->type, vl);
5857                                 for (i = 0; i < argc; i++) {
5858                                         struct value *vl2 = vl->array + i * v->var->type->array.member->size;
5859
5860                                         arg.str.txt = argv[i];
5861                                         arg.str.len = strlen(argv[i]);
5862                                         free_value(Tstr, vl2);
5863                                         dup_value(Tstr, &arg, vl2);
5864                                 }
5865                                 break;
5866                         }
5867                         al = cast(binode, al->right);
5868                 }
5869                 v = interp_exec(c, progp->function, &vtype);
5870                 free_value(vtype, &v);
5871                 free(c->local);
5872                 c->local = NULL;
5873         }
5874
5875 ###### ast functions
5876         void free_variable(struct variable *v)
5877         {
5878         }
5879
5880 ## And now to test it out.
5881
5882 Having a language requires having a "hello world" program.  I'll
5883 provide a little more than that: a program that prints "Hello world"
5884 finds the GCD of two numbers, prints the first few elements of
5885 Fibonacci, performs a binary search for a number, and a few other
5886 things which will likely grow as the languages grows.
5887
5888 ###### File: oceani.mk
5889         demos :: sayhello
5890         sayhello : oceani
5891                 @echo "===== DEMO ====="
5892                 ./oceani --section "demo: hello" oceani.mdc 55 33
5893
5894 ###### demo: hello
5895
5896         const
5897                 pi ::= 3.141_592_6
5898                 four ::= 2 + 2 ; five ::= 10/2
5899         const pie ::= "I like Pie";
5900                 cake ::= "The cake is"
5901                   ++ " a lie"
5902
5903         struct fred
5904                 size:[four]number
5905                 name:string
5906                 alive:Boolean
5907
5908         func main(argv:[argc::]string)
5909                 print "Hello World, what lovely oceans you have!"
5910                 print "Are there", five, "?"
5911                 print pi, pie, "but", cake
5912
5913                 A := $argv[1]; B := $argv[2]
5914
5915                 /* When a variable is defined in both branches of an 'if',
5916                  * and used afterwards, the variables are merged.
5917                  */
5918                 if A > B:
5919                         bigger := "yes"
5920                 else
5921                         bigger := "no"
5922                 print "Is", A, "bigger than", B,"? ", bigger
5923                 /* If a variable is not used after the 'if', no
5924                  * merge happens, so types can be different
5925                  */
5926                 if A > B * 2:
5927                         double:string = "yes"
5928                         print A, "is more than twice", B, "?", double
5929                 else
5930                         double := B*2
5931                         print "double", B, "is", double
5932
5933                 a : number
5934                 a = A;
5935                 b:number = B
5936                 if a > 0 and then b > 0:
5937                         while a != b:
5938                                 if a < b:
5939                                         b = b - a
5940                                 else
5941                                         a = a - b
5942                         print "GCD of", A, "and", B,"is", a
5943                 else if a <= 0:
5944                         print a, "is not positive, cannot calculate GCD"
5945                 else
5946                         print b, "is not positive, cannot calculate GCD"
5947
5948                 for
5949                         togo := 10
5950                         f1 := 1; f2 := 1
5951                         print "Fibonacci:", f1,f2,
5952                 then togo = togo - 1
5953                 while togo > 0:
5954                         f3 := f1 + f2
5955                         print "", f3,
5956                         f1 = f2
5957                         f2 = f3
5958                 print ""
5959
5960                 /* Binary search... */
5961                 for
5962                         lo:= 0; hi := 100
5963                         target := 77
5964                 while
5965                         mid := (lo + hi) / 2
5966                         if mid == target:
5967                                 use .Found
5968                         if mid < target:
5969                                 lo = mid
5970                         else
5971                                 hi = mid
5972                         if hi - lo < 1:
5973                                 lo = mid
5974                                 use .GiveUp
5975                         use True
5976                 do pass
5977                 case .Found:
5978                         print "Yay, I found", target
5979                 case .GiveUp:
5980                         print "Closest I found was", lo
5981
5982                 size::= 10
5983                 list:[size]number
5984                 list[0] = 1234
5985                 // "middle square" PRNG.  Not particularly good, but one my
5986                 // Dad taught me - the first one I ever heard of.
5987                 for i:=1; then i = i + 1; while i < size:
5988                         n := list[i-1] * list[i-1]
5989                         list[i] = (n / 100) % 10 000
5990
5991                 print "Before sort:",
5992                 for i:=0; then i = i + 1; while i < size:
5993                         print "", list[i],
5994                 print
5995
5996                 for i := 1; then i=i+1; while i < size:
5997                         for j:=i-1; then j=j-1; while j >= 0:
5998                                 if list[j] > list[j+1]:
5999                                         t:= list[j]
6000                                         list[j] = list[j+1]
6001                                         list[j+1] = t
6002                 print " After sort:",
6003                 for i:=0; then i = i + 1; while i < size:
6004                         print "", list[i],
6005                 print
6006
6007                 if 1 == 2 then print "yes"; else print "no"
6008
6009                 bob:fred
6010                 bob.name = "Hello"
6011                 bob.alive = (bob.name == "Hello")
6012                 print "bob", "is" if  bob.alive else "isn't", "alive"