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, Rrefok = 1<<1,};
 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;
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);
1281                         tok_err(c, "error: unsupported number format", &$NUM);
1282                 } else if (tail[0])
1283                         tok_err(c, "error: unsupported number suffix", &$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;    // NOTEST
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);
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                 return v->type;
2297         }
2298
2299 ###### interp exec cases
2300         case Xvar:
2301         {
2302                 struct var *var = cast(var, e);
2303                 struct variable *v = var->var;
2304
2305                 v = v->merged;
2306                 lrv = var_value(c, v);
2307                 rvtype = v->type;
2308                 break;
2309         }
2310
2311 ###### ast functions
2312
2313         static void free_var(struct var *v)
2314         {
2315                 free(v);
2316         }
2317
2318 ###### free exec cases
2319         case Xvar: free_var(cast(var, e)); break;
2320
2321
2322 ### Complex types
2323
2324 Now that we have the shape of the interpreter in place we can add some
2325 complex types and connected them in to the data structures and the
2326 different phases of parse, analyse, print, interpret.
2327
2328 Being "complex" the language will naturally have syntax to access
2329 specifics of objects of these types.  These will fit into the grammar as
2330 "Terms" which are the things that are combined with various operators to
2331 form "Expression".  Where a Term is formed by some operation on another
2332 Term, the subordinate Term will always come first, so for example a
2333 member of an array will be expressed as the Term for the array followed
2334 by an index in square brackets.  The strict rule of using postfix
2335 operations makes precedence irrelevant within terms.  To provide a place
2336 to put the grammar for each terms of each type, we will start out by
2337 introducing the "Term" grammar production, with contains at least a
2338 simple "Value" (to be explained later).
2339
2340 ###### Grammar
2341         $*exec
2342         Term ->  Value ${ $0 = $<1; }$
2343         | Variable ${ $0 = $<1; }$
2344         ## term grammar
2345
2346 Thus far the complex types we have are arrays and structs.
2347
2348 #### Arrays
2349
2350 Arrays can be declared by giving a size and a type, as `[size]type' so
2351 `freq:[26]number` declares `freq` to be an array of 26 numbers.  The
2352 size can be either a literal number, or a named constant.  Some day an
2353 arbitrary expression will be supported.
2354
2355 As a formal parameter to a function, the array can be declared with a
2356 new variable as the size: `name:[size::number]string`.  The `size`
2357 variable is set to the size of the array and must be a constant.  As
2358 `number` is the only supported type, it can be left out:
2359 `name:[size::]string`.
2360
2361 Arrays cannot be assigned.  When pointers are introduced we will also
2362 introduce array slices which can refer to part or all of an array -
2363 the assignment syntax will create a slice.  For now, an array can only
2364 ever be referenced by the name it is declared with.  It is likely that
2365 a "`copy`" primitive will eventually be define which can be used to
2366 make a copy of an array with controllable recursive depth.
2367
2368 For now we have two sorts of array, those with fixed size either because
2369 it is given as a literal number or because it is a struct member (which
2370 cannot have a runtime-changing size), and those with a size that is
2371 determined at runtime - local variables with a const size.  The former
2372 have their size calculated at parse time, the latter at run time.
2373
2374 For the latter type, the `size` field of the type is the size of a
2375 pointer, and the array is reallocated every time it comes into scope.
2376
2377 We differentiate struct fields with a const size from local variables
2378 with a const size by whether they are prepared at parse time or not.
2379
2380 ###### type union fields
2381
2382         struct {
2383                 int unspec;     // size is unspecified - vsize must be set.
2384                 short size;
2385                 short static_size;
2386                 struct variable *vsize;
2387                 struct type *member;
2388         } array;
2389
2390 ###### value union fields
2391         void *array;  // used if not static_size
2392
2393 ###### value functions
2394
2395         static int array_prepare_type(struct parse_context *c, struct type *type,
2396                                        int parse_time)
2397         {
2398                 struct value *vsize;
2399                 mpz_t q;
2400                 if (type->array.static_size)
2401                         return 1;       // NOTEST - guard against reentry
2402                 if (type->array.unspec && parse_time)
2403                         return 1;       // NOTEST - unspec is still incomplete
2404                 if (parse_time && type->array.vsize && !type->array.vsize->global)
2405                         return 1;       // NOTEST - should be impossible
2406
2407                 if (type->array.vsize) {
2408                         vsize = var_value(c, type->array.vsize);
2409                         if (!vsize)
2410                                 return 1;       // NOTEST - should be impossible
2411                         mpz_init(q);
2412                         mpz_tdiv_q(q, mpq_numref(vsize->num), mpq_denref(vsize->num));
2413                         type->array.size = mpz_get_si(q);
2414                         mpz_clear(q);
2415                 }
2416                 if (!parse_time)
2417                         return 1;
2418                 if (type->array.member->size <= 0)
2419                         return 0;       // NOTEST - error caught before here
2420
2421                 type->array.static_size = 1;
2422                 type->size = type->array.size * type->array.member->size;
2423                 type->align = type->array.member->align;
2424
2425                 return 1;
2426         }
2427
2428         static void array_init(struct type *type, struct value *val)
2429         {
2430                 int i;
2431                 void *ptr = val->ptr;
2432
2433                 if (!val)
2434                         return;                         // NOTEST
2435                 if (!type->array.static_size) {
2436                         val->array = calloc(type->array.size,
2437                                             type->array.member->size);
2438                         ptr = val->array;
2439                 }
2440                 for (i = 0; i < type->array.size; i++) {
2441                         struct value *v;
2442                         v = (void*)ptr + i * type->array.member->size;
2443                         val_init(type->array.member, v);
2444                 }
2445         }
2446
2447         static void array_free(struct type *type, struct value *val)
2448         {
2449                 int i;
2450                 void *ptr = val->ptr;
2451
2452                 if (!type->array.static_size)
2453                         ptr = val->array;
2454                 for (i = 0; i < type->array.size; i++) {
2455                         struct value *v;
2456                         v = (void*)ptr + i * type->array.member->size;
2457                         free_value(type->array.member, v);
2458                 }
2459                 if (!type->array.static_size)
2460                         free(ptr);
2461         }
2462
2463         static int array_compat(struct type *require, struct type *have,
2464                                 enum val_rules rules)
2465         {
2466                 if (have->compat != require->compat)
2467                         return 0;
2468                 /* Both are arrays, so we can look at details */
2469                 if (!type_compat(require->array.member, have->array.member, 0))
2470                         return 0;
2471                 if (have->array.unspec && require->array.unspec &&
2472                     have->array.size != require->array.size)
2473                         return 0;       // NOTEST
2474                 if (have->array.unspec || require->array.unspec)
2475                         return 1;
2476                 if (require->array.vsize == NULL && have->array.vsize == NULL)
2477                         return require->array.size == have->array.size;
2478
2479                 return require->array.vsize == have->array.vsize;
2480         }
2481
2482         static void array_print_type(struct type *type, FILE *f)
2483         {
2484                 fputs("[", f);
2485                 if (type->array.vsize) {
2486                         struct binding *b = type->array.vsize->name;
2487                         fprintf(f, "%.*s%s]", b->name.len, b->name.txt,
2488                                 type->array.unspec ? "::" : "");
2489                 } else if (type->array.size)
2490                         fprintf(f, "%d]", type->array.size);
2491                 else
2492                         fprintf(f, "]");
2493                 type_print(type->array.member, f);
2494         }
2495
2496         static struct type array_prototype = {
2497                 .init = array_init,
2498                 .prepare_type = array_prepare_type,
2499                 .print_type = array_print_type,
2500                 .compat = array_compat,
2501                 .free = array_free,
2502                 .size = sizeof(void*),
2503                 .align = sizeof(void*),
2504         };
2505
2506 ###### declare terminals
2507         $TERM [ ]
2508
2509 ###### type grammar
2510
2511         | [ NUMBER ] Type ${ {
2512                 char tail[3];
2513                 mpq_t num;
2514                 struct type *t;
2515                 int elements = 0;
2516
2517                 if (number_parse(num, tail, $2.txt) == 0)
2518                         tok_err(c, "error: unrecognised number", &$2);
2519                 else if (tail[0]) {
2520                         tok_err(c, "error: unsupported number suffix", &$2);
2521                         mpq_clear(num);
2522                 } else {
2523                         elements = mpz_get_ui(mpq_numref(num));
2524                         if (mpz_cmp_ui(mpq_denref(num), 1) != 0) {
2525                                 tok_err(c, "error: array size must be an integer",
2526                                         &$2);
2527                         } else if (mpz_cmp_ui(mpq_numref(num), 1UL << 30) >= 0)
2528                                 tok_err(c, "error: array size is too large",
2529                                         &$2);
2530                         mpq_clear(num);
2531                 }
2532
2533                 $0 = t = add_anon_type(c, &array_prototype, "array[%d]", elements );
2534                 t->array.size = elements;
2535                 t->array.member = $<4;
2536                 t->array.vsize = NULL;
2537         } }$
2538
2539         | [ IDENTIFIER ] Type ${ {
2540                 struct variable *v = var_ref(c, $2.txt);
2541
2542                 if (!v)
2543                         tok_err(c, "error: name undeclared", &$2);
2544                 else if (!v->constant)
2545                         tok_err(c, "error: array size must be a constant", &$2);
2546
2547                 $0 = add_anon_type(c, &array_prototype, "array[%.*s]", $2.txt.len, $2.txt.txt);
2548                 $0->array.member = $<4;
2549                 $0->array.size = 0;
2550                 $0->array.vsize = v;
2551         } }$
2552
2553 ###### formal type grammar
2554
2555         | [ ] Type ${ {
2556                 $0 = add_anon_type(c, &array_prototype, "array[]");
2557                 $0->array.member = $<Type;
2558                 $0->array.size = 0;
2559                 $0->array.unspec = 1;
2560                 $0->array.vsize = NULL;
2561         } }$
2562
2563 ###### Binode types
2564         Index, Length,
2565
2566 ###### term grammar
2567
2568         | Term [ Expression ] ${ {
2569                 struct binode *b = new(binode);
2570                 b->op = Index;
2571                 b->left = $<1;
2572                 b->right = $<3;
2573                 $0 = b;
2574         } }$
2575
2576         | Term [ ] ${ {
2577                 struct binode *b = new(binode);
2578                 b->op = Length;
2579                 b->left = $<Term;
2580                 $0 = b;
2581         } }$
2582
2583 ###### print binode cases
2584         case Index:
2585                 print_exec(b->left, -1, bracket);
2586                 printf("[");
2587                 print_exec(b->right, -1, bracket);
2588                 printf("]");
2589                 break;
2590
2591         case Length:
2592                 print_exec(b->left, -1, bracket);
2593                 printf("[]");
2594                 break;
2595
2596 ###### propagate binode cases
2597         case Index:
2598                 /* left must be an array, right must be a number,
2599                  * result is the member type of the array
2600                  */
2601                 propagate_types(b->right, c, perr_local, Tnum, 0);
2602                 t = propagate_types(b->left, c, perr, NULL, 0);
2603                 if (!t || t->compat != array_compat) {
2604                         type_err(c, "error: %1 cannot be indexed", prog, t, 0, NULL);
2605                         return NULL;
2606                 } else {
2607                         if (!type_compat(type, t->array.member, rules)) {
2608                                 type_err(c, "error: have %1 but need %2", prog,
2609                                          t->array.member, rules, type);
2610                         }
2611                         return t->array.member;
2612                 }
2613                 break;
2614
2615         case Length:
2616                 /* left must be an array, result is a number
2617                  */
2618                 t = propagate_types(b->left, c, perr, NULL, 0);
2619                 if (!t || t->compat != array_compat) {
2620                         type_err(c, "error: %1 cannot provide length", prog, t, 0, NULL);
2621                         return NULL;
2622                 }
2623                 if (!type_compat(type, Tnum, rules))
2624                         type_err(c, "error: have %1 but need %2", prog,
2625                                          Tnum, rules, type);
2626                 return Tnum;
2627                 break;
2628
2629 ###### interp binode cases
2630         case Index: {
2631                 mpz_t q;
2632                 long i;
2633                 void *ptr;
2634
2635                 lleft = linterp_exec(c, b->left, &ltype);
2636                 right = interp_exec(c, b->right, &rtype);
2637                 mpz_init(q);
2638                 mpz_tdiv_q(q, mpq_numref(right.num), mpq_denref(right.num));
2639                 i = mpz_get_si(q);
2640                 mpz_clear(q);
2641
2642                 if (ltype->array.static_size)
2643                         ptr = lleft;
2644                 else
2645                         ptr = *(void**)lleft;
2646                 rvtype = ltype->array.member;
2647                 if (i >= 0 && i < ltype->array.size)
2648                         lrv = ptr + i * rvtype->size;
2649                 else
2650                         val_init(ltype->array.member, &rv); // UNSAFE
2651                 ltype = NULL;
2652                 break;
2653         }
2654         case Length: {
2655                 lleft = linterp_exec(c, b->left, &ltype);
2656                 mpq_set_ui(rv.num, ltype->array.size, 1);
2657                 ltype = NULL;
2658                 rvtype = Tnum;
2659                 break;
2660         }
2661
2662 #### Structs
2663
2664 A `struct` is a data-type that contains one or more other data-types.
2665 It differs from an array in that each member can be of a different
2666 type, and they are accessed by name rather than by number.  Thus you
2667 cannot choose an element by calculation, you need to know what you
2668 want up-front.
2669
2670 The language makes no promises about how a given structure will be
2671 stored in memory - it is free to rearrange fields to suit whatever
2672 criteria seems important.
2673
2674 Structs are declared separately from program code - they cannot be
2675 declared in-line in a variable declaration like arrays can.  A struct
2676 is given a name and this name is used to identify the type - the name
2677 is not prefixed by the word `struct` as it would be in C.
2678
2679 Structs are only treated as the same if they have the same name.
2680 Simply having the same fields in the same order is not enough.  This
2681 might change once we can create structure initializers from a list of
2682 values.
2683
2684 Each component datum is identified much like a variable is declared,
2685 with a name, one or two colons, and a type.  The type cannot be omitted
2686 as there is no opportunity to deduce the type from usage.  An initial
2687 value can be given following an equals sign, so
2688
2689 ##### Example: a struct type
2690
2691         struct complex:
2692                 x:number = 0
2693                 y:number = 0
2694
2695 would declare a type called "complex" which has two number fields,
2696 each initialised to zero.
2697
2698 Struct will need to be declared separately from the code that uses
2699 them, so we will need to be able to print out the declaration of a
2700 struct when reprinting the whole program.  So a `print_type_decl` type
2701 function will be needed.
2702
2703 ###### type union fields
2704
2705         struct {
2706                 int nfields;
2707                 struct field {
2708                         struct text name;
2709                         struct type *type;
2710                         struct value *init;
2711                         int offset;
2712                 } *fields; // This is created when field_list is analysed.
2713                 struct fieldlist {
2714                         struct fieldlist *prev;
2715                         struct field f;
2716                         struct exec *init;
2717                 } *field_list; // This is created during parsing
2718         } structure;
2719
2720 ###### type functions
2721         void (*print_type_decl)(struct type *type, FILE *f);
2722         struct type *(*fieldref)(struct type *t, struct parse_context *c,
2723                                  struct fieldref *f, struct value **vp);
2724
2725 ###### value functions
2726
2727         static void structure_init(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                         if (type->structure.fields[i].init)
2735                                 dup_value(type->structure.fields[i].type,
2736                                           type->structure.fields[i].init,
2737                                           v);
2738                         else
2739                                 val_init(type->structure.fields[i].type, v);
2740                 }
2741         }
2742
2743         static void structure_free(struct type *type, struct value *val)
2744         {
2745                 int i;
2746
2747                 for (i = 0; i < type->structure.nfields; i++) {
2748                         struct value *v;
2749                         v = (void*)val->ptr + type->structure.fields[i].offset;
2750                         free_value(type->structure.fields[i].type, v);
2751                 }
2752         }
2753
2754         static void free_fieldlist(struct fieldlist *f)
2755         {
2756                 if (!f)
2757                         return;
2758                 free_fieldlist(f->prev);
2759                 free_exec(f->init);
2760                 free(f);
2761         }
2762
2763         static void structure_free_type(struct type *t)
2764         {
2765                 int i;
2766                 for (i = 0; i < t->structure.nfields; i++)
2767                         if (t->structure.fields[i].init) {
2768                                 free_value(t->structure.fields[i].type,
2769                                            t->structure.fields[i].init);
2770                         }
2771                 free(t->structure.fields);
2772                 free_fieldlist(t->structure.field_list);
2773         }
2774
2775         static int structure_prepare_type(struct parse_context *c,
2776                                           struct type *t, int parse_time)
2777         {
2778                 int cnt = 0;
2779                 struct fieldlist *f;
2780
2781                 if (!parse_time || t->structure.fields)
2782                         return 1;
2783
2784                 for (f = t->structure.field_list; f; f=f->prev) {
2785                         enum prop_err perr;
2786                         cnt += 1;
2787
2788                         if (f->f.type->size <= 0)
2789                                 return 0;
2790                         if (f->f.type->prepare_type)
2791                                 f->f.type->prepare_type(c, f->f.type, parse_time);
2792
2793                         if (f->init == NULL)
2794                                 continue;
2795                         do {
2796                                 perr = 0;
2797                                 propagate_types(f->init, c, &perr, f->f.type, 0);
2798                         } while (perr & Eretry);
2799                         if (perr & Efail)
2800                                 c->parse_error += 1;    // NOTEST
2801                 }
2802
2803                 t->structure.nfields = cnt;
2804                 t->structure.fields = calloc(cnt, sizeof(struct field));
2805                 f = t->structure.field_list;
2806                 while (cnt > 0) {
2807                         int a = f->f.type->align;
2808                         cnt -= 1;
2809                         t->structure.fields[cnt] = f->f;
2810                         if (t->size & (a-1))
2811                                 t->size = (t->size | (a-1)) + 1;
2812                         t->structure.fields[cnt].offset = t->size;
2813                         t->size += ((f->f.type->size - 1) | (a-1)) + 1;
2814                         if (a > t->align)
2815                                 t->align = a;
2816
2817                         if (f->init && !c->parse_error) {
2818                                 struct value vl = interp_exec(c, f->init, NULL);
2819                                 t->structure.fields[cnt].init =
2820                                         global_alloc(c, f->f.type, NULL, &vl);
2821                         }
2822
2823                         f = f->prev;
2824                 }
2825                 return 1;
2826         }
2827
2828         static int find_struct_index(struct type *type, struct text field)
2829         {
2830                 int i;
2831                 for (i = 0; i < type->structure.nfields; i++)
2832                         if (text_cmp(type->structure.fields[i].name, field) == 0)
2833                                 return i;
2834                 return IndexInvalid;
2835         }
2836
2837         static struct type *structure_fieldref(struct type *t, struct parse_context *c,
2838                                                struct fieldref *f, struct value **vp)
2839         {
2840                 if (f->index == IndexUnknown) {
2841                         f->index = find_struct_index(t, f->name);
2842                         if (f->index < 0)
2843                                 type_err(c, "error: cannot find requested field in %1",
2844                                          f->left, t, 0, NULL);
2845                 }
2846                 if (f->index < 0)
2847                         return NULL;
2848                 if (vp) {
2849                         struct value *v = *vp;
2850                         v = (void*)v->ptr + t->structure.fields[f->index].offset;
2851                         *vp = v;
2852                 }
2853                 return t->structure.fields[f->index].type;
2854         }
2855
2856         static struct type structure_prototype = {
2857                 .init = structure_init,
2858                 .free = structure_free,
2859                 .free_type = structure_free_type,
2860                 .print_type_decl = structure_print_type,
2861                 .prepare_type = structure_prepare_type,
2862                 .fieldref = structure_fieldref,
2863         };
2864
2865 ###### exec type
2866         Xfieldref,
2867
2868 ###### ast
2869         struct fieldref {
2870                 struct exec;
2871                 struct exec *left;
2872                 int index;
2873                 struct text name;
2874         };
2875         enum { IndexUnknown = -1, IndexInvalid = -2 };
2876
2877 ###### free exec cases
2878         case Xfieldref:
2879                 free_exec(cast(fieldref, e)->left);
2880                 free(e);
2881                 break;
2882
2883 ###### declare terminals
2884         $TERM struct
2885
2886 ###### term grammar
2887
2888         | Term . IDENTIFIER ${ {
2889                 struct fieldref *fr = new_pos(fieldref, $2);
2890                 fr->left = $<1;
2891                 fr->name = $3.txt;
2892                 fr->index = IndexUnknown;
2893                 $0 = fr;
2894         } }$
2895
2896 ###### print exec cases
2897
2898         case Xfieldref:
2899         {
2900                 struct fieldref *f = cast(fieldref, e);
2901                 print_exec(f->left, -1, bracket);
2902                 printf(".%.*s", f->name.len, f->name.txt);
2903                 break;
2904         }
2905
2906 ###### propagate exec cases
2907
2908         case Xfieldref:
2909         {
2910                 struct fieldref *f = cast(fieldref, prog);
2911                 struct type *st = propagate_types(f->left, c, perr, NULL, 0);
2912
2913                 if (!st || !st->fieldref)
2914                         type_err(c, "error: field reference on %1 is not supported",
2915                                  f->left, st, 0, NULL);
2916                 else {
2917                         t = st->fieldref(st, c, f, NULL);
2918                         if (t && !type_compat(type, t, rules))
2919                                 type_err(c, "error: have %1 but need %2", prog,
2920                                          t, rules, type);
2921                         return t;
2922                 }
2923                 break;
2924         }
2925
2926 ###### interp exec cases
2927         case Xfieldref:
2928         {
2929                 struct fieldref *f = cast(fieldref, e);
2930                 struct type *ltype;
2931                 struct value *lleft = linterp_exec(c, f->left, &ltype);
2932                 lrv = lleft;
2933                 rvtype = ltype->fieldref(ltype, c, f, &lrv);
2934                 break;
2935         }
2936
2937 ###### top level grammar
2938         $*type
2939         StructName -> IDENTIFIER ${ {
2940                 struct type *t = find_type(c, $ID.txt);
2941
2942                 if (t && t->size >= 0) {
2943                         tok_err(c, "error: type already declared", &$ID);
2944                         tok_err(c, "info: this is location of declartion", &t->first_use);
2945                         t = NULL;
2946                 }
2947                 if (!t)
2948                         t = add_type(c, $ID.txt, NULL);
2949                 t->first_use = $ID;
2950                 $0 = t;
2951         } }$
2952         $void
2953         DeclareStruct -> struct StructName FieldBlock Newlines ${ {
2954                 struct type *t = $<SN;
2955                 struct type tmp = *t;
2956
2957                 *t = structure_prototype;
2958                 t->name = tmp.name;
2959                 t->next = tmp.next;
2960                 t->first_use = tmp.first_use;
2961
2962                 t->structure.field_list = $<FB;
2963         } }$
2964
2965         $*fieldlist
2966         FieldBlock -> { IN OptNL FieldLines OUT OptNL } ${ $0 = $<FL; }$
2967         | { SimpleFieldList } ${ $0 = $<SFL; }$
2968         | IN OptNL FieldLines OUT ${ $0 = $<FL; }$
2969         | SimpleFieldList EOL ${ $0 = $<SFL; }$
2970
2971         FieldLines -> SimpleFieldList Newlines ${ $0 = $<SFL; }$
2972         | FieldLines SimpleFieldList Newlines ${ {
2973                 struct fieldlist *f = $<SFL;
2974
2975                 if (f) {
2976                         $0 = f;
2977                         while (f->prev)
2978                                 f = f->prev;
2979                         f->prev = $<FL;
2980                 } else
2981                         $0 = $<FL;
2982         } }$
2983
2984         SimpleFieldList -> Field ${ $0 = $<F; }$
2985         | SimpleFieldList ; Field ${
2986                 $F->prev = $<SFL;
2987                 $0 = $<F;
2988         }$
2989         | SimpleFieldList ; ${
2990                 $0 = $<SFL;
2991         }$
2992         | ERROR ${ tok_err(c, "Syntax error in struct field", &$1); }$
2993
2994         Field -> IDENTIFIER : Type = Expression ${ {
2995                 $0 = calloc(1, sizeof(struct fieldlist));
2996                 $0->f.name = $ID.txt;
2997                 $0->f.type = $<Type;
2998                 $0->f.init = NULL;
2999                 $0->init = $<Expr;
3000         } }$
3001         | IDENTIFIER : Type ${
3002                 $0 = calloc(1, sizeof(struct fieldlist));
3003                 $0->f.name = $ID.txt;
3004                 $0->f.type = $<Type;
3005         }$
3006
3007 ###### forward decls
3008         static void structure_print_type(struct type *t, FILE *f);
3009
3010 ###### value functions
3011         static void structure_print_type(struct type *t, FILE *f)
3012         {
3013                 int i;
3014
3015                 fprintf(f, "struct %.*s\n", t->name.len, t->name.txt);
3016
3017                 for (i = 0; i < t->structure.nfields; i++) {
3018                         struct field *fl = t->structure.fields + i;
3019                         fprintf(f, "    %.*s : ", fl->name.len, fl->name.txt);
3020                         type_print(fl->type, f);
3021                         if (fl->type->print && fl->init) {
3022                                 fprintf(f, " = ");
3023                                 if (fl->type == Tstr)
3024                                         fprintf(f, "\"");
3025                                 print_value(fl->type, fl->init, f);
3026                                 if (fl->type == Tstr)
3027                                         fprintf(f, "\"");
3028                         }
3029                         fprintf(f, "\n");
3030                 }
3031         }
3032
3033 ###### print type decls
3034         {
3035                 struct type *t;
3036                 int target = -1;
3037
3038                 while (target != 0) {
3039                         int i = 0;
3040                         for (t = context.typelist; t ; t=t->next)
3041                                 if (!t->anon && t->print_type_decl &&
3042                                     !t->check_args) {
3043                                         i += 1;
3044                                         if (i == target)
3045                                                 break;
3046                                 }
3047
3048                         if (target == -1) {
3049                                 target = i;
3050                         } else {
3051                                 t->print_type_decl(t, stdout);
3052                                 target -= 1;
3053                         }
3054                 }
3055         }
3056
3057 #### References
3058
3059 References, or pointers, are values that refer to another value.  They
3060 can only refer to a `struct`, though as a struct can embed anything they
3061 can effectively refer to anything.
3062
3063 References are potentially dangerous as they might refer to some
3064 variable which no longer exists - either because a stack frame
3065 containing it has been discarded or because the value was allocated on
3066 the heap and has now been free.  Ocean does not yet provide any
3067 protection against these problems.  It will in due course.
3068
3069 With references comes the opportunity and the need to explicitly
3070 allocate values on the "heap" and to free them.  We currently provide
3071 fairly basic support for this.
3072
3073 Reference make use of the `@` symbol in various ways.  A type that starts
3074 with `@` is a reference to whatever follows.  A reference value
3075 followed by an `@` acts as the referred value, though the `@` is often
3076 not needed.  Finally, an expression that starts with `@` is a special
3077 reference related expression.  Some examples might help.
3078
3079 ##### Example: Reference examples
3080
3081         struct foo
3082                 a: number
3083                 b: string
3084         ref: @foo
3085         bar: foo
3086         bar.number = 23; bar.string = "hello"
3087         baz: foo
3088         ref = bar
3089         baz = @ref
3090         baz.a = ref.a * 2
3091
3092         ref = @new()
3093         ref@ = baz
3094         @free = ref
3095         ref = @nil
3096
3097 Obviously this is very contrived.  `ref` is a reference to a `foo` which
3098 is initially set to refer to the value stored in `bar` - no extra syntax
3099 is needed to "Take the address of" `bar` - the fact that `ref` is a
3100 reference means that only the address make sense.
3101
3102 When `ref.a` is accessed, that is whatever value is stored in `bar.a`.
3103 The same syntax is used for accessing fields both in structs and in
3104 references to structs.  It would be correct to use `ref@.a`, but not
3105 necessary.
3106
3107 `@new()` creates an object of whatever type is needed for the program
3108 to by type-correct.  In future iterations of Ocean, arguments a
3109 constructor will access arguments, so the the syntax now looks like a
3110 function call.  `@free` can be assigned any reference that was returned
3111 by `@new()`, and it will be freed.  `@nil` is a value of whatever
3112 reference type is appropriate, and is stable and never the address of
3113 anything in the heap or on the stack.  A reference can be assigned
3114 `@nil` or compared against that value.
3115
3116 ###### declare terminals
3117         $TERM @
3118
3119 ###### type union fields
3120
3121         struct {
3122                 struct type *referent;
3123         } reference;
3124
3125 ###### value union fields
3126         struct value *ref;
3127
3128 ###### value functions
3129
3130         static void reference_print_type(struct type *t, FILE *f)
3131         {
3132                 fprintf(f, "@");
3133                 type_print(t->reference.referent, f);
3134         }
3135
3136         static int reference_cmp(struct type *tl, struct type *tr,
3137                                  struct value *left, struct value *right)
3138         {
3139                 return left->ref == right->ref ? 0 : 1;
3140         }
3141
3142         static void reference_dup(struct type *t,
3143                                   struct value *vold, struct value *vnew)
3144         {
3145                 vnew->ref = vold->ref;
3146         }
3147
3148         static void reference_free(struct type *t, struct value *v)
3149         {
3150                 /* Nothing to do here */
3151         }
3152
3153         static int reference_compat(struct type *require, struct type *have,
3154                                     enum val_rules rules)
3155         {
3156                 if (rules & Rrefok)
3157                         if (require->reference.referent == have)
3158                                 return 1;
3159                 if (have->compat != require->compat)
3160                         return 0;
3161                 if (have->reference.referent != require->reference.referent)
3162                         return 0;
3163                 return 1;
3164         }
3165
3166         static int reference_test(struct type *type, struct value *val)
3167         {
3168                 return val->ref != NULL;
3169         }
3170
3171         static struct type *reference_fieldref(struct type *t, struct parse_context *c,
3172                                                struct fieldref *f, struct value **vp)
3173         {
3174                 struct type *rt = t->reference.referent;
3175
3176                 if (rt->fieldref) {
3177                         if (vp)
3178                                 *vp = (*vp)->ref;
3179                         return rt->fieldref(rt, c, f, vp);
3180                 }
3181                 type_err(c, "error: field reference on %1 is not supported",
3182                                  f->left, rt, 0, NULL);
3183                 return Tnone;
3184         }
3185
3186         static struct type reference_prototype = {
3187                 .print_type = reference_print_type,
3188                 .cmp_eq = reference_cmp,
3189                 .dup = reference_dup,
3190                 .test = reference_test,
3191                 .free = reference_free,
3192                 .compat = reference_compat,
3193                 .fieldref = reference_fieldref,
3194                 .size = sizeof(void*),
3195                 .align = sizeof(void*),
3196         };
3197
3198 ###### type grammar
3199
3200         | @ IDENTIFIER ${ {
3201                 struct type *t = find_type(c, $ID.txt);
3202                 if (!t) {
3203                         t = add_type(c, $ID.txt, NULL);
3204                         t->first_use = $ID;
3205                 }
3206                 $0 = find_anon_type(c, &reference_prototype, "@%.*s",
3207                                     $ID.txt.len, $ID.txt.txt);
3208                 $0->reference.referent = t;
3209         } }$
3210
3211 ###### core functions
3212         static int text_is(struct text t, char *s)
3213         {
3214                 return (strlen(s) == t.len &&
3215                         strncmp(s, t.txt, t.len) == 0);
3216         }
3217
3218 ###### exec type
3219         Xref,
3220
3221 ###### ast
3222         struct ref {
3223                 struct exec;
3224                 enum ref_func { RefNew, RefFree, RefNil } action;
3225                 struct type *reftype;
3226                 struct exec *right;
3227         };
3228
3229 ###### SimpleStatement Grammar
3230
3231         | @ IDENTIFIER = Expression ${ {
3232                 struct ref *r = new_pos(ref, $ID);
3233                 // Must be "free"
3234                 if (!text_is($ID.txt, "free"))
3235                         tok_err(c, "error: only \"@free\" makes sense here",
3236                                 &$ID);
3237
3238                 $0 = r;
3239                 r->action = RefFree;
3240                 r->right = $<Exp;
3241         } }$
3242
3243 ###### expression grammar
3244         | @ IDENTIFIER ( ) ${
3245                 // Only 'new' valid here
3246                 if (!text_is($ID.txt, "new")) {
3247                         tok_err(c, "error: Only reference function is \"@new()\"",
3248                                 &$ID);
3249                 } else {
3250                         struct ref *r = new_pos(ref,$ID);
3251                         $0 = r;
3252                         r->action = RefNew;
3253                 }
3254         }$
3255         | @ IDENTIFIER ${
3256                 // Only 'nil' valid here
3257                 if (!text_is($ID.txt, "nil")) {
3258                         tok_err(c, "error: Only reference value is \"@nil\"",
3259                                 &$ID);
3260                 } else {
3261                         struct ref *r = new_pos(ref,$ID);
3262                         $0 = r;
3263                         r->action = RefNil;
3264                 }
3265         }$
3266
3267 ###### print exec cases
3268         case Xref: {
3269                 struct ref *r = cast(ref, e);
3270                 switch (r->action) {
3271                 case RefNew:
3272                         printf("@new()"); break;
3273                 case RefNil:
3274                         printf("@nil"); break;
3275                 case RefFree:
3276                         do_indent(indent, "@free = ");
3277                         print_exec(r->right, indent, bracket);
3278                         break;
3279                 }
3280                 break;
3281         }
3282
3283 ###### propagate exec cases
3284         case Xref: {
3285                 struct ref *r = cast(ref, prog);
3286                 switch (r->action) {
3287                 case RefNew:
3288                         if (type && type->free != reference_free) {
3289                                 type_err(c, "error: @new() can only be used with references, not %1",
3290                                          prog, type, 0, NULL);
3291                                 return NULL;
3292                         }
3293                         if (type && !r->reftype) {
3294                                 r->reftype = type;
3295                                 *perr |= Eretry;
3296                         }
3297                         *perr |= Erval;
3298                         return type;
3299                 case RefNil:
3300                         if (type && type->free != reference_free)
3301                                 type_err(c, "error: @nil can only be used with reference, not %1",
3302                                          prog, type, 0, NULL);
3303                         if (type && !r->reftype) {
3304                                 r->reftype = type;
3305                                 *perr |= Eretry;
3306                         }
3307                         *perr |= Erval;
3308                         return type;
3309                 case RefFree:
3310                         t = propagate_types(r->right, c, perr_local, NULL, 0);
3311                         if (t && t->free != reference_free)
3312                                 type_err(c, "error: @free can only be assigned a reference, not %1",
3313                                          prog, t, 0, NULL);
3314                         r->reftype = Tnone;
3315                         return Tnone;
3316                 }
3317                 break;  // NOTEST
3318         }
3319
3320
3321 ###### interp exec cases
3322         case Xref: {
3323                 struct ref *r = cast(ref, e);
3324                 switch (r->action) {
3325                 case RefNew:
3326                         if (r->reftype)
3327                                 rv.ref = calloc(1, r->reftype->reference.referent->size);
3328                         rvtype = r->reftype;
3329                         break;
3330                 case RefNil:
3331                         rv.ref = NULL;
3332                         rvtype = r->reftype;
3333                         break;
3334                 case RefFree:
3335                         rv = interp_exec(c, r->right, &rvtype);
3336                         free_value(rvtype->reference.referent, rv.ref);
3337                         free(rv.ref);
3338                         rvtype = Tnone;
3339                         break;
3340                 }
3341                 break;
3342         }
3343
3344 ###### free exec cases
3345         case Xref: {
3346                 struct ref *r = cast(ref, e);
3347                 free_exec(r->right);
3348                 free(r);
3349                 break;
3350         }
3351
3352 ###### Expressions: dereference
3353
3354 ###### Binode types
3355         Deref, AddressOf,
3356
3357 ###### term grammar
3358
3359         | Term @ ${ {
3360                 struct binode *b = new(binode);
3361                 b->op = Deref;
3362                 b->left = $<Trm;
3363                 $0 = b;
3364         } }$
3365
3366 ###### print binode cases
3367         case Deref:
3368                 print_exec(b->left, -1, bracket);
3369                 printf("@");
3370                 break;
3371         case AddressOf:
3372                 print_exec(b->left, -1, bracket);
3373                 break;
3374
3375 ###### propagate binode cases
3376         case Deref:
3377                 /* left must be a reference, and we return what it refers to */
3378                 /* FIXME how can I pass the expected type down? */
3379                 t = propagate_types(b->left, c, perr, NULL, 0);
3380                 *perr &= ~Erval;
3381                 if (!t || t->free != reference_free)
3382                         type_err(c, "error: Cannot dereference %1", b, t, 0, NULL);
3383                 else
3384                         return t->reference.referent;
3385                 break;
3386
3387         case AddressOf:
3388                 /* left must be lval, we create reference to it */
3389                 if (!type || type->free != reference_free)
3390                         t = propagate_types(b->left, c, perr, type, 0); // NOTEST impossible
3391                 else
3392                         t = propagate_types(b->left, c, perr,
3393                                             type->reference.referent, 0);
3394                 if (t)
3395                         t = find_anon_type(c, &reference_prototype, "@%.*s",
3396                                         t->name.len, t->name.txt);
3397                 return t;
3398
3399 ###### interp binode cases
3400         case Deref:
3401                 left = interp_exec(c, b->left, &ltype);
3402                 lrv = left.ref;
3403                 rvtype = ltype->reference.referent;
3404                 break;
3405
3406         case AddressOf:
3407                 rv.ref = linterp_exec(c, b->left, &rvtype);
3408                 rvtype = find_anon_type(c, &reference_prototype, "@%.*s",
3409                                         rvtype->name.len, rvtype->name.txt);
3410                 break;
3411
3412
3413 #### Functions
3414
3415 A function is a chunk of code which can be passed parameters and can
3416 return results.  Each function has a type which includes the set of
3417 parameters and the return value.  As yet these types cannot be declared
3418 separately from the function itself.
3419
3420 The parameters can be specified either in parentheses as a ';' separated
3421 list, such as
3422
3423 ##### Example: function 1
3424
3425         func main(av:[ac::number]string; env:[envc::number]string)
3426                 code block
3427
3428 or as an indented list of one parameter per line (though each line can
3429 be a ';' separated list)
3430
3431 ##### Example: function 2
3432
3433         func main
3434                 argv:[argc::number]string
3435                 env:[envc::number]string
3436         do
3437                 code block
3438
3439 In the first case a return type can follow the parentheses after a colon,
3440 in the second it is given on a line starting with the word `return`.
3441
3442 ##### Example: functions that return
3443
3444         func add(a:number; b:number): number
3445                 code block
3446
3447         func catenate
3448                 a: string
3449                 b: string
3450         return string
3451         do
3452                 code block
3453
3454 Rather than returning a type, the function can specify a set of local
3455 variables to return as a struct.  The values of these variables when the
3456 function exits will be provided to the caller.  For this the return type
3457 is replaced with a block of result declarations, either in parentheses
3458 or bracketed by `return` and `do`.
3459
3460 ##### Example: functions returning multiple variables
3461
3462         func to_cartesian(rho:number; theta:number):(x:number; y:number)
3463                 x = .....
3464                 y = .....
3465
3466         func to_polar
3467                 x:number; y:number
3468         return
3469                 rho:number
3470                 theta:number
3471         do
3472                 rho = ....
3473                 theta = ....
3474
3475 For constructing the lists we use a `List` binode, which will be
3476 further detailed when Expression Lists are introduced.
3477
3478 ###### type union fields
3479
3480         struct {
3481                 struct binode *params;
3482                 struct type *return_type;
3483                 struct variable *scope;
3484                 int inline_result;      // return value is at start of 'local'
3485                 int local_size;
3486         } function;
3487
3488 ###### value union fields
3489         struct exec *function;
3490
3491 ###### type functions
3492         void (*check_args)(struct parse_context *c, enum prop_err *perr,
3493                            struct type *require, struct exec *args);
3494
3495 ###### value functions
3496
3497         static void function_free(struct type *type, struct value *val)
3498         {
3499                 free_exec(val->function);
3500                 val->function = NULL;
3501         }
3502
3503         static int function_compat(struct type *require, struct type *have,
3504                                    enum val_rules rules)
3505         {
3506                 // FIXME can I do anything here yet?
3507                 return 0;
3508         }
3509
3510         static struct exec *take_addr(struct exec *e)
3511         {
3512                 struct binode *rv = new(binode);
3513                 rv->op = AddressOf;
3514                 rv->left = e;
3515                 return rv;
3516         }
3517
3518         static void function_check_args(struct parse_context *c, enum prop_err *perr,
3519                                         struct type *require, struct exec *args)
3520         {
3521                 /* This should be 'compat', but we don't have a 'tuple' type to
3522                  * hold the type of 'args'
3523                  */
3524                 struct binode *arg = cast(binode, args);
3525                 struct binode *param = require->function.params;
3526
3527                 while (param) {
3528                         struct var *pv = cast(var, param->left);
3529                         struct type *t = pv->var->type, *t2;
3530                         if (!arg) {
3531                                 type_err(c, "error: insufficient arguments to function.",
3532                                          args, NULL, 0, NULL);
3533                                 break;
3534                         }
3535                         *perr = 0;
3536                         t2 = propagate_types(arg->left, c, perr, t, Rrefok);
3537                         if (t->free == reference_free &&
3538                             t->reference.referent == t2 &&
3539                             !(*perr & Erval)) {
3540                                 arg->left = take_addr(arg->left);
3541                         } else if (!(*perr & Efail) && !type_compat(t2, t, 0)) {
3542                                 type_err(c, "error: cannot pass rval when reference expected",
3543                                          arg->left, NULL, 0, NULL);
3544                         }
3545                         param = cast(binode, param->right);
3546                         arg = cast(binode, arg->right);
3547                 }
3548                 if (arg)
3549                         type_err(c, "error: too many arguments to function.",
3550                                  args, NULL, 0, NULL);
3551         }
3552
3553         static void function_print(struct type *type, struct value *val, FILE *f)
3554         {
3555                 fprintf(f, "\n");
3556                 print_exec(val->function, 1, 0);
3557         }
3558
3559         static void function_print_type_decl(struct type *type, FILE *f)
3560         {
3561                 struct binode *b;
3562                 fprintf(f, "(");
3563                 for (b = type->function.params; b; b = cast(binode, b->right)) {
3564                         struct variable *v = cast(var, b->left)->var;
3565                         fprintf(f, "%.*s%s", v->name->name.len, v->name->name.txt,
3566                                 v->constant ? "::" : ":");
3567                         type_print(v->type, f);
3568                         if (b->right)
3569                                 fprintf(f, "; ");
3570                 }
3571                 fprintf(f, ")");
3572                 if (type->function.return_type != Tnone) {
3573                         fprintf(f, ":");
3574                         if (type->function.inline_result) {
3575                                 int i;
3576                                 struct type *t = type->function.return_type;
3577                                 fprintf(f, " (");
3578                                 for (i = 0; i < t->structure.nfields; i++) {
3579                                         struct field *fl = t->structure.fields + i;
3580                                         if (i)
3581                                                 fprintf(f, "; ");
3582                                         fprintf(f, "%.*s:", fl->name.len, fl->name.txt);
3583                                         type_print(fl->type, f);
3584                                 }
3585                                 fprintf(f, ")");
3586                         } else
3587                                 type_print(type->function.return_type, f);
3588                 }
3589         }
3590
3591         static void function_free_type(struct type *t)
3592         {
3593                 free_exec(t->function.params);
3594         }
3595
3596         static struct type function_prototype = {
3597                 .size = sizeof(void*),
3598                 .align = sizeof(void*),
3599                 .free = function_free,
3600                 .compat = function_compat,
3601                 .check_args = function_check_args,
3602                 .print = function_print,
3603                 .print_type_decl = function_print_type_decl,
3604                 .free_type = function_free_type,
3605         };
3606
3607 ###### declare terminals
3608
3609         $TERM func
3610
3611 ###### Binode types
3612         List,
3613
3614 ###### Grammar
3615
3616         $*variable
3617         FuncName -> IDENTIFIER ${ {
3618                 struct variable *v = var_decl(c, $1.txt);
3619                 struct var *e = new_pos(var, $1);
3620                 e->var = v;
3621                 if (v) {
3622                         v->where_decl = e;
3623                         v->where_set = e;
3624                         $0 = v;
3625                 } else {
3626                         v = var_ref(c, $1.txt);
3627                         e->var = v;
3628                         type_err(c, "error: function '%v' redeclared",
3629                                 e, NULL, 0, NULL);
3630                         type_err(c, "info: this is where '%v' was first declared",
3631                                 v->where_decl, NULL, 0, NULL);
3632                         free_exec(e);
3633                 }
3634         } }$
3635
3636         $*binode
3637         Args -> ArgsLine NEWLINE ${ $0 = $<AL; }$
3638         | Args ArgsLine NEWLINE ${ {
3639                 struct binode *b = $<AL;
3640                 struct binode **bp = &b;
3641                 while (*bp)
3642                         bp = (struct binode **)&(*bp)->left;
3643                 *bp = $<A;
3644                 $0 = b;
3645         } }$
3646
3647         ArgsLine -> ${ $0 = NULL; }$
3648         | Varlist ${ $0 = $<1; }$
3649         | Varlist ; ${ $0 = $<1; }$
3650
3651         Varlist -> Varlist ; ArgDecl ${
3652                 $0 = new_pos(binode, $2);
3653                 $0->op = List;
3654                 $0->left = $<Vl;
3655                 $0->right = $<AD;
3656         }$
3657         | ArgDecl ${
3658                 $0 = new(binode);
3659                 $0->op = List;
3660                 $0->left = NULL;
3661                 $0->right = $<AD;
3662         }$
3663
3664         $*var
3665         ArgDecl -> IDENTIFIER : FormalType ${ {
3666                 struct variable *v = var_decl(c, $ID.txt);
3667                 $0 = new_pos(var, $ID);
3668                 $0->var = v;
3669                 v->where_decl = $0;
3670                 v->where_set = $0;
3671                 v->type = $<FT;
3672         } }$
3673
3674 ##### Function calls
3675
3676 A function call can appear either as an expression or as a statement.
3677 We use a new 'Funcall' binode type to link the function with a list of
3678 arguments, form with the 'List' nodes.
3679
3680 We have already seen the "Term" which is how a function call can appear
3681 in an expression.  To parse a function call into a statement we include
3682 it in the "SimpleStatement Grammar" which will be described later.
3683
3684 ###### Binode types
3685         Funcall,
3686
3687 ###### term grammar
3688         | Term ( ExpressionList ) ${ {
3689                 struct binode *b = new(binode);
3690                 b->op = Funcall;
3691                 b->left = $<T;
3692                 b->right = reorder_bilist($<EL);
3693                 $0 = b;
3694         } }$
3695         | Term ( ) ${ {
3696                 struct binode *b = new(binode);
3697                 b->op = Funcall;
3698                 b->left = $<T;
3699                 b->right = NULL;
3700                 $0 = b;
3701         } }$
3702
3703 ###### SimpleStatement Grammar
3704
3705         | Term ( ExpressionList ) ${ {
3706                 struct binode *b = new(binode);
3707                 b->op = Funcall;
3708                 b->left = $<T;
3709                 b->right = reorder_bilist($<EL);
3710                 $0 = b;
3711         } }$
3712
3713 ###### print binode cases
3714
3715         case Funcall:
3716                 do_indent(indent, "");
3717                 print_exec(b->left, -1, bracket);
3718                 printf("(");
3719                 for (b = cast(binode, b->right); b; b = cast(binode, b->right)) {
3720                         if (b->left) {
3721                                 printf(" ");
3722                                 print_exec(b->left, -1, bracket);
3723                                 if (b->right)
3724                                         printf(",");
3725                         }
3726                 }
3727                 printf(")");
3728                 if (indent >= 0)
3729                         printf("\n");
3730                 break;
3731
3732 ###### propagate binode cases
3733
3734         case Funcall: {
3735                 /* Every arg must match formal parameter, and result
3736                  * is return type of function
3737                  */
3738                 struct binode *args = cast(binode, b->right);
3739                 struct var *v = cast(var, b->left);
3740
3741                 if (!v->var->type || v->var->type->check_args == NULL) {
3742                         type_err(c, "error: attempt to call a non-function.",
3743                                  prog, NULL, 0, NULL);
3744                         return NULL;
3745                 }
3746                 *perr |= Eruntime;
3747                 v->var->type->check_args(c, perr_local, v->var->type, args);
3748                 if (v->var->type->function.inline_result)
3749                         *perr |= Emaycopy;
3750                 *perr |= Erval;
3751                 return v->var->type->function.return_type;
3752         }
3753
3754 ###### interp binode cases
3755
3756         case Funcall: {
3757                 struct var *v = cast(var, b->left);
3758                 struct type *t = v->var->type;
3759                 void *oldlocal = c->local;
3760                 int old_size = c->local_size;
3761                 void *local = calloc(1, t->function.local_size);
3762                 struct value *fbody = var_value(c, v->var);
3763                 struct binode *arg = cast(binode, b->right);
3764                 struct binode *param = t->function.params;
3765
3766                 while (param) {
3767                         struct var *pv = cast(var, param->left);
3768                         struct type *vtype = NULL;
3769                         struct value val = interp_exec(c, arg->left, &vtype);
3770                         struct value *lval;
3771                         c->local = local; c->local_size = t->function.local_size;
3772                         lval = var_value(c, pv->var);
3773                         c->local = oldlocal; c->local_size = old_size;
3774                         memcpy(lval, &val, vtype->size);
3775                         param = cast(binode, param->right);
3776                         arg = cast(binode, arg->right);
3777                 }
3778                 c->local = local; c->local_size = t->function.local_size;
3779                 if (t->function.inline_result && dtype) {
3780                         _interp_exec(c, fbody->function, NULL, NULL);
3781                         memcpy(dest, local, dtype->size);
3782                         rvtype = ret.type = NULL;
3783                 } else
3784                         rv = interp_exec(c, fbody->function, &rvtype);
3785                 c->local = oldlocal; c->local_size = old_size;
3786                 free(local);
3787                 break;
3788         }
3789
3790 ## Complex executables: statements and expressions
3791
3792 Now that we have types and values and variables and most of the basic
3793 Terms which provide access to these, we can explore the more complex
3794 code that combine all of these to get useful work done.  Specifically
3795 statements and expressions.
3796
3797 Expressions are various combinations of Terms.  We will use operator
3798 precedence to ensure correct parsing.  The simplest Expression is just a
3799 Term - others will follow.
3800
3801 ###### Grammar
3802
3803         $*exec
3804         Expression -> Term ${ $0 = $<Term; }$
3805         ## expression grammar
3806
3807 ### Expressions: Conditional
3808
3809 Our first user of the `binode` will be conditional expressions, which
3810 is a bit odd as they actually have three components.  That will be
3811 handled by having 2 binodes for each expression.  The conditional
3812 expression is the lowest precedence operator which is why we define it
3813 first - to start the precedence list.
3814
3815 Conditional expressions are of the form "value `if` condition `else`
3816 other_value".  They associate to the right, so everything to the right
3817 of `else` is part of an else value, while only a higher-precedence to
3818 the left of `if` is the if values.  Between `if` and `else` there is no
3819 room for ambiguity, so a full conditional expression is allowed in
3820 there.
3821
3822 ###### Binode types
3823         CondExpr,
3824
3825 ###### declare terminals
3826
3827         $LEFT if $$ifelse
3828
3829 ###### expression grammar
3830
3831         | Expression if Expression else Expression $$ifelse ${ {
3832                 struct binode *b1 = new(binode);
3833                 struct binode *b2 = new(binode);
3834                 b1->op = CondExpr;
3835                 b1->left = $<3;
3836                 b1->right = b2;
3837                 b2->op = CondExpr;
3838                 b2->left = $<1;
3839                 b2->right = $<5;
3840                 $0 = b1;
3841         } }$
3842
3843 ###### print binode cases
3844
3845         case CondExpr:
3846                 b2 = cast(binode, b->right);
3847                 if (bracket) printf("(");
3848                 print_exec(b2->left, -1, bracket);
3849                 printf(" if ");
3850                 print_exec(b->left, -1, bracket);
3851                 printf(" else ");
3852                 print_exec(b2->right, -1, bracket);
3853                 if (bracket) printf(")");
3854                 break;
3855
3856 ###### propagate binode cases
3857
3858         case CondExpr: {
3859                 /* cond must be Tbool, others must match */
3860                 struct binode *b2 = cast(binode, b->right);
3861                 struct type *t2;
3862
3863                 propagate_types(b->left, c, perr_local, Tbool, 0);
3864                 t = propagate_types(b2->left, c, perr, type, 0);
3865                 t2 = propagate_types(b2->right, c, perr, type ?: t, 0);
3866                 return t ?: t2;
3867         }
3868
3869 ###### interp binode cases
3870
3871         case CondExpr: {
3872                 struct binode *b2 = cast(binode, b->right);
3873                 left = interp_exec(c, b->left, &ltype);
3874                 if (left.bool)
3875                         rv = interp_exec(c, b2->left, &rvtype);
3876                 else
3877                         rv = interp_exec(c, b2->right, &rvtype);
3878                 }
3879                 break;
3880
3881 ### Expression list
3882
3883 We take a brief detour, now that we have expressions, to describe lists
3884 of expressions.  These will be needed for function parameters and
3885 possibly other situations.  They seem generic enough to introduce here
3886 to be used elsewhere.
3887
3888 And ExpressionList will use the `List` type of `binode`, building up at
3889 the end.  And place where they are used will probably call
3890 `reorder_bilist()` to get a more normal first/next arrangement.
3891
3892 ###### declare terminals
3893         $TERM ,
3894
3895 `List` execs have no implicit semantics, so they are never propagated or
3896 interpreted.  The can be printed as a comma separate list, which is how
3897 they are parsed.  Note they are also used for function formal parameter
3898 lists.  In that case a separate function is used to print them.
3899
3900 ###### print binode cases
3901         case List:
3902                 while (b) {
3903                         printf(" ");
3904                         print_exec(b->left, -1, bracket);
3905                         if (b->right)
3906                                 printf(",");
3907                         b = cast(binode, b->right);
3908                 }
3909                 break;
3910
3911 ###### propagate binode cases
3912         case List: abort(); // NOTEST
3913 ###### interp binode cases
3914         case List: abort(); // NOTEST
3915
3916 ###### Grammar
3917
3918         $*binode
3919         ExpressionList -> ExpressionList , Expression ${
3920                 $0 = new(binode);
3921                 $0->op = List;
3922                 $0->left = $<1;
3923                 $0->right = $<3;
3924         }$
3925         | Expression ${
3926                 $0 = new(binode);
3927                 $0->op = List;
3928                 $0->left = NULL;
3929                 $0->right = $<1;
3930         }$
3931
3932 ### Expressions: Boolean
3933
3934 The next class of expressions to use the `binode` will be Boolean
3935 expressions.  "`and then`" and "`or else`" are similar to `and` and `or`
3936 have same corresponding precendence.  The difference is that they don't
3937 evaluate the second expression if not necessary.
3938
3939 ###### Binode types
3940         And,
3941         AndThen,
3942         Or,
3943         OrElse,
3944         Not,
3945
3946 ###### declare terminals
3947         $LEFT or
3948         $LEFT and
3949         $LEFT not
3950
3951 ###### expression grammar
3952         | Expression or Expression ${ {
3953                 struct binode *b = new(binode);
3954                 b->op = Or;
3955                 b->left = $<1;
3956                 b->right = $<3;
3957                 $0 = b;
3958         } }$
3959         | Expression or else Expression ${ {
3960                 struct binode *b = new(binode);
3961                 b->op = OrElse;
3962                 b->left = $<1;
3963                 b->right = $<4;
3964                 $0 = b;
3965         } }$
3966
3967         | Expression and Expression ${ {
3968                 struct binode *b = new(binode);
3969                 b->op = And;
3970                 b->left = $<1;
3971                 b->right = $<3;
3972                 $0 = b;
3973         } }$
3974         | Expression and then Expression ${ {
3975                 struct binode *b = new(binode);
3976                 b->op = AndThen;
3977                 b->left = $<1;
3978                 b->right = $<4;
3979                 $0 = b;
3980         } }$
3981
3982         | not Expression ${ {
3983                 struct binode *b = new(binode);
3984                 b->op = Not;
3985                 b->right = $<2;
3986                 $0 = b;
3987         } }$
3988
3989 ###### print binode cases
3990         case And:
3991                 if (bracket) printf("(");
3992                 print_exec(b->left, -1, bracket);
3993                 printf(" and ");
3994                 print_exec(b->right, -1, bracket);
3995                 if (bracket) printf(")");
3996                 break;
3997         case AndThen:
3998                 if (bracket) printf("(");
3999                 print_exec(b->left, -1, bracket);
4000                 printf(" and then ");
4001                 print_exec(b->right, -1, bracket);
4002                 if (bracket) printf(")");
4003                 break;
4004         case Or:
4005                 if (bracket) printf("(");
4006                 print_exec(b->left, -1, bracket);
4007                 printf(" or ");
4008                 print_exec(b->right, -1, bracket);
4009                 if (bracket) printf(")");
4010                 break;
4011         case OrElse:
4012                 if (bracket) printf("(");
4013                 print_exec(b->left, -1, bracket);
4014                 printf(" or else ");
4015                 print_exec(b->right, -1, bracket);
4016                 if (bracket) printf(")");
4017                 break;
4018         case Not:
4019                 if (bracket) printf("(");
4020                 printf("not ");
4021                 print_exec(b->right, -1, bracket);
4022                 if (bracket) printf(")");
4023                 break;
4024
4025 ###### propagate binode cases
4026         case And:
4027         case AndThen:
4028         case Or:
4029         case OrElse:
4030         case Not:
4031                 /* both must be Tbool, result is Tbool */
4032                 propagate_types(b->left, c, perr, Tbool, 0);
4033                 propagate_types(b->right, c, perr, Tbool, 0);
4034                 if (type && type != Tbool)
4035                         type_err(c, "error: %1 operation found where %2 expected", prog,
4036                                    Tbool, 0, type);
4037                 *perr |= Erval;
4038                 return Tbool;
4039
4040 ###### interp binode cases
4041         case And:
4042                 rv = interp_exec(c, b->left, &rvtype);
4043                 right = interp_exec(c, b->right, &rtype);
4044                 rv.bool = rv.bool && right.bool;
4045                 break;
4046         case AndThen:
4047                 rv = interp_exec(c, b->left, &rvtype);
4048                 if (rv.bool)
4049                         rv = interp_exec(c, b->right, NULL);
4050                 break;
4051         case Or:
4052                 rv = interp_exec(c, b->left, &rvtype);
4053                 right = interp_exec(c, b->right, &rtype);
4054                 rv.bool = rv.bool || right.bool;
4055                 break;
4056         case OrElse:
4057                 rv = interp_exec(c, b->left, &rvtype);
4058                 if (!rv.bool)
4059                         rv = interp_exec(c, b->right, NULL);
4060                 break;
4061         case Not:
4062                 rv = interp_exec(c, b->right, &rvtype);
4063                 rv.bool = !rv.bool;
4064                 break;
4065
4066 ### Expressions: Comparison
4067
4068 Of slightly higher precedence that Boolean expressions are Comparisons.
4069 A comparison takes arguments of any comparable type, but the two types
4070 must be the same.
4071
4072 To simplify the parsing we introduce an `eop` which can record an
4073 expression operator, and the `CMPop` non-terminal will match one of them.
4074
4075 ###### ast
4076         struct eop {
4077                 enum Btype op;
4078         };
4079
4080 ###### ast functions
4081         static void free_eop(struct eop *e)
4082         {
4083                 if (e)
4084                         free(e);
4085         }
4086
4087 ###### Binode types
4088         Less,
4089         Gtr,
4090         LessEq,
4091         GtrEq,
4092         Eql,
4093         NEql,
4094
4095 ###### declare terminals
4096         $LEFT < > <= >= == != CMPop
4097
4098 ###### expression grammar
4099         | Expression CMPop Expression ${ {
4100                 struct binode *b = new(binode);
4101                 b->op = $2.op;
4102                 b->left = $<1;
4103                 b->right = $<3;
4104                 $0 = b;
4105         } }$
4106
4107 ###### Grammar
4108
4109         $eop
4110         CMPop ->  < ${ $0.op = Less; }$
4111         |         > ${ $0.op = Gtr; }$
4112         |         <= ${ $0.op = LessEq; }$
4113         |         >= ${ $0.op = GtrEq; }$
4114         |         == ${ $0.op = Eql; }$
4115         |         != ${ $0.op = NEql; }$
4116
4117 ###### print binode cases
4118
4119         case Less:
4120         case LessEq:
4121         case Gtr:
4122         case GtrEq:
4123         case Eql:
4124         case NEql:
4125                 if (bracket) printf("(");
4126                 print_exec(b->left, -1, bracket);
4127                 switch(b->op) {
4128                 case Less:   printf(" < "); break;
4129                 case LessEq: printf(" <= "); break;
4130                 case Gtr:    printf(" > "); break;
4131                 case GtrEq:  printf(" >= "); break;
4132                 case Eql:    printf(" == "); break;
4133                 case NEql:   printf(" != "); break;
4134                 default: abort();               // NOTEST
4135                 }
4136                 print_exec(b->right, -1, bracket);
4137                 if (bracket) printf(")");
4138                 break;
4139
4140 ###### propagate binode cases
4141         case Less:
4142         case LessEq:
4143         case Gtr:
4144         case GtrEq:
4145         case Eql:
4146         case NEql:
4147                 /* Both must match but not be labels, result is Tbool */
4148                 t = propagate_types(b->left, c, perr, NULL, 0);
4149                 if (t)
4150                         propagate_types(b->right, c, perr, t, 0);
4151                 else {
4152                         t = propagate_types(b->right, c, perr, NULL, 0);        // NOTEST
4153                         if (t)  // NOTEST
4154                                 t = propagate_types(b->left, c, perr, t, 0);    // NOTEST
4155                 }
4156                 if (!type_compat(type, Tbool, 0))
4157                         type_err(c, "error: Comparison returns %1 but %2 expected", prog,
4158                                     Tbool, rules, type);
4159                 *perr |= Erval;
4160                 return Tbool;
4161
4162 ###### interp binode cases
4163         case Less:
4164         case LessEq:
4165         case Gtr:
4166         case GtrEq:
4167         case Eql:
4168         case NEql:
4169         {
4170                 int cmp;
4171                 left = interp_exec(c, b->left, &ltype);
4172                 right = interp_exec(c, b->right, &rtype);
4173                 cmp = value_cmp(ltype, rtype, &left, &right);
4174                 rvtype = Tbool;
4175                 switch (b->op) {
4176                 case Less:      rv.bool = cmp <  0; break;
4177                 case LessEq:    rv.bool = cmp <= 0; break;
4178                 case Gtr:       rv.bool = cmp >  0; break;
4179                 case GtrEq:     rv.bool = cmp >= 0; break;
4180                 case Eql:       rv.bool = cmp == 0; break;
4181                 case NEql:      rv.bool = cmp != 0; break;
4182                 default:        rv.bool = 0; break;     // NOTEST
4183                 }
4184                 break;
4185         }
4186
4187 ### Expressions: Arithmetic etc.
4188
4189 The remaining expressions with the highest precedence are arithmetic,
4190 string concatenation, string conversion, and testing.  String concatenation
4191 (`++`) has the same precedence as multiplication and division, but lower
4192 than the uniary.
4193
4194 Testing comes in two forms.  A single question mark (`?`) is a uniary
4195 operator which converts come types into Boolean.  The general meaning is
4196 "is this a value value" and there will be more uses as the language
4197 develops.  A double questionmark (`??`) is a binary operator (Choose),
4198 with same precedence as multiplication, which returns the LHS if it
4199 tests successfully, else returns the RHS.
4200
4201 String conversion is a temporary feature until I get a better type
4202 system.  `$` is a prefix operator which expects a string and returns
4203 a number.
4204
4205 `+` and `-` are both infix and prefix operations (where they are
4206 absolute value and negation).  These have different operator names.
4207
4208 We also have a 'Bracket' operator which records where parentheses were
4209 found.  This makes it easy to reproduce these when printing.  Possibly I
4210 should only insert brackets were needed for precedence.  Putting
4211 parentheses around an expression converts it into a Term,
4212
4213 ###### Binode types
4214         Plus, Minus,
4215         Times, Divide, Rem,
4216         Concat, Choose,
4217         Absolute, Negate, Test,
4218         StringConv,
4219         Bracket,
4220
4221 ###### declare terminals
4222         $LEFT + - Eop
4223         $LEFT * / % ++ ?? Top
4224         $LEFT Uop $ ?
4225         $TERM ( )
4226
4227 ###### expression grammar
4228         | Expression Eop Expression ${ {
4229                 struct binode *b = new(binode);
4230                 b->op = $2.op;
4231                 b->left = $<1;
4232                 b->right = $<3;
4233                 $0 = b;
4234         } }$
4235
4236         | Expression Top Expression ${ {
4237                 struct binode *b = new(binode);
4238                 b->op = $2.op;
4239                 b->left = $<1;
4240                 b->right = $<3;
4241                 $0 = b;
4242         } }$
4243
4244         | Uop Expression ${ {
4245                 struct binode *b = new(binode);
4246                 b->op = $1.op;
4247                 b->right = $<2;
4248                 $0 = b;
4249         } }$
4250
4251 ###### term grammar
4252
4253         | ( Expression ) ${ {
4254                 struct binode *b = new_pos(binode, $1);
4255                 b->op = Bracket;
4256                 b->right = $<2;
4257                 $0 = b;
4258         } }$
4259
4260 ###### Grammar
4261
4262         $eop
4263         Eop ->   + ${ $0.op = Plus; }$
4264         |        - ${ $0.op = Minus; }$
4265
4266         Uop ->   + ${ $0.op = Absolute; }$
4267         |        - ${ $0.op = Negate; }$
4268         |        $ ${ $0.op = StringConv; }$
4269         |        ? ${ $0.op = Test; }$
4270
4271         Top ->   * ${ $0.op = Times; }$
4272         |        / ${ $0.op = Divide; }$
4273         |        % ${ $0.op = Rem; }$
4274         |        ++ ${ $0.op = Concat; }$
4275         |        ?? ${ $0.op = Choose; }$
4276
4277 ###### print binode cases
4278         case Plus:
4279         case Minus:
4280         case Times:
4281         case Divide:
4282         case Concat:
4283         case Rem:
4284         case Choose:
4285                 if (bracket) printf("(");
4286                 print_exec(b->left, indent, bracket);
4287                 switch(b->op) {
4288                 case Plus:   fputs(" + ", stdout); break;
4289                 case Minus:  fputs(" - ", stdout); break;
4290                 case Times:  fputs(" * ", stdout); break;
4291                 case Divide: fputs(" / ", stdout); break;
4292                 case Rem:    fputs(" % ", stdout); break;
4293                 case Concat: fputs(" ++ ", stdout); break;
4294                 case Choose: fputs(" ?? ", stdout); break;
4295                 default: abort();       // NOTEST
4296                 }                       // NOTEST
4297                 print_exec(b->right, indent, bracket);
4298                 if (bracket) printf(")");
4299                 break;
4300         case Absolute:
4301         case Negate:
4302         case StringConv:
4303         case Test:
4304                 if (bracket) printf("(");
4305                 switch (b->op) {
4306                 case Absolute:   fputs("+", stdout); break;
4307                 case Negate:     fputs("-", stdout); break;
4308                 case StringConv: fputs("$", stdout); break;
4309                 case Test:       fputs("?", stdout); break;
4310                 default: abort();       // NOTEST
4311                 }                       // NOTEST
4312                 print_exec(b->right, indent, bracket);
4313                 if (bracket) printf(")");
4314                 break;
4315         case Bracket:
4316                 /* Avoid double brackets... */
4317                 if (!bracket) printf("(");
4318                 print_exec(b->right, indent, bracket);
4319                 if (!bracket) printf(")");
4320                 break;
4321
4322 ###### propagate binode cases
4323         case Plus:
4324         case Minus:
4325         case Times:
4326         case Rem:
4327         case Divide:
4328                 /* both must be numbers, result is Tnum */
4329         case Absolute:
4330         case Negate:
4331                 /* as propagate_types ignores a NULL,
4332                  * unary ops fit here too */
4333                 propagate_types(b->left, c, perr, Tnum, 0);
4334                 propagate_types(b->right, c, perr, Tnum, 0);
4335                 if (!type_compat(type, Tnum, 0))
4336                         type_err(c, "error: Arithmetic returns %1 but %2 expected", prog,
4337                                    Tnum, rules, type);
4338                 *perr |= Erval;
4339                 return Tnum;
4340
4341         case Concat:
4342                 /* both must be Tstr, result is Tstr */
4343                 propagate_types(b->left, c, perr, Tstr, 0);
4344                 propagate_types(b->right, c, perr, Tstr, 0);
4345                 if (!type_compat(type, Tstr, 0))
4346                         type_err(c, "error: Concat returns %1 but %2 expected", prog,
4347                                    Tstr, rules, type);
4348                 *perr |= Erval;
4349                 return Tstr;
4350
4351         case StringConv:
4352                 /* op must be string, result is number */
4353                 propagate_types(b->left, c, perr, Tstr, 0);
4354                 if (!type_compat(type, Tnum, 0))
4355                         type_err(c,
4356                           "error: Can only convert string to number, not %1",
4357                                 prog, type, 0, NULL);
4358                 *perr |= Erval;
4359                 return Tnum;
4360
4361         case Test:
4362                 /* LHS must support ->test, result is Tbool */
4363                 t = propagate_types(b->right, c, perr, NULL, 0);
4364                 if (!t || !t->test)
4365                         type_err(c, "error: '?' requires a testable value, not %1",
4366                                  prog, t, 0, NULL);
4367                 *perr |= Erval;
4368                 return Tbool;
4369
4370         case Choose:
4371                 /* LHS and RHS must match and are returned. Must support
4372                  * ->test
4373                  */
4374                 t = propagate_types(b->left, c, perr, type, rules);
4375                 t = propagate_types(b->right, c, perr, t, rules);
4376                 if (t && t->test == NULL)
4377                         type_err(c, "error: \"??\" requires a testable value, not %1",
4378                                  prog, t, 0, NULL);
4379                 *perr |= Erval;
4380                 return t;
4381
4382         case Bracket:
4383                 return propagate_types(b->right, c, perr, type, rules);
4384
4385 ###### interp binode cases
4386
4387         case Plus:
4388                 rv = interp_exec(c, b->left, &rvtype);
4389                 right = interp_exec(c, b->right, &rtype);
4390                 mpq_add(rv.num, rv.num, right.num);
4391                 break;
4392         case Minus:
4393                 rv = interp_exec(c, b->left, &rvtype);
4394                 right = interp_exec(c, b->right, &rtype);
4395                 mpq_sub(rv.num, rv.num, right.num);
4396                 break;
4397         case Times:
4398                 rv = interp_exec(c, b->left, &rvtype);
4399                 right = interp_exec(c, b->right, &rtype);
4400                 mpq_mul(rv.num, rv.num, right.num);
4401                 break;
4402         case Divide:
4403                 rv = interp_exec(c, b->left, &rvtype);
4404                 right = interp_exec(c, b->right, &rtype);
4405                 mpq_div(rv.num, rv.num, right.num);
4406                 break;
4407         case Rem: {
4408                 mpz_t l, r, rem;
4409
4410                 left = interp_exec(c, b->left, &ltype);
4411                 right = interp_exec(c, b->right, &rtype);
4412                 mpz_init(l); mpz_init(r); mpz_init(rem);
4413                 mpz_tdiv_q(l, mpq_numref(left.num), mpq_denref(left.num));
4414                 mpz_tdiv_q(r, mpq_numref(right.num), mpq_denref(right.num));
4415                 mpz_tdiv_r(rem, l, r);
4416                 val_init(Tnum, &rv);
4417                 mpq_set_z(rv.num, rem);
4418                 mpz_clear(r); mpz_clear(l); mpz_clear(rem);
4419                 rvtype = ltype;
4420                 break;
4421         }
4422         case Negate:
4423                 rv = interp_exec(c, b->right, &rvtype);
4424                 mpq_neg(rv.num, rv.num);
4425                 break;
4426         case Absolute:
4427                 rv = interp_exec(c, b->right, &rvtype);
4428                 mpq_abs(rv.num, rv.num);
4429                 break;
4430         case Bracket:
4431                 rv = interp_exec(c, b->right, &rvtype);
4432                 break;
4433         case Concat:
4434                 left = interp_exec(c, b->left, &ltype);
4435                 right = interp_exec(c, b->right, &rtype);
4436                 rvtype = Tstr;
4437                 rv.str = text_join(left.str, right.str);
4438                 break;
4439         case StringConv:
4440                 right = interp_exec(c, b->right, &rvtype);
4441                 rtype = Tstr;
4442                 rvtype = Tnum;
4443
4444                 struct text tx = right.str;
4445                 char tail[3] = "";
4446                 int neg = 0;
4447                 if (tx.txt[0] == '-') {
4448                         neg = 1;
4449                         tx.txt++;
4450                         tx.len--;
4451                 }
4452                 if (number_parse(rv.num, tail, tx) == 0)
4453                         mpq_init(rv.num);
4454                 else if (neg)
4455                         mpq_neg(rv.num, rv.num);
4456                 if (tail[0])
4457                         printf("Unsupported suffix: %.*s\n", tx.len, tx.txt);
4458
4459                 break;
4460         case Test:
4461                 right = interp_exec(c, b->right, &rtype);
4462                 rvtype = Tbool;
4463                 rv.bool = !!rtype->test(rtype, &right);
4464                 break;
4465         case Choose:
4466                 left = interp_exec(c, b->left, &ltype);
4467                 if (ltype->test(ltype, &left)) {
4468                         rv = left;
4469                         rvtype = ltype;
4470                         ltype = NULL;
4471                 } else
4472                         rv = interp_exec(c, b->right, &rvtype);
4473                 break;
4474
4475 ###### value functions
4476
4477         static struct text text_join(struct text a, struct text b)
4478         {
4479                 struct text rv;
4480                 rv.len = a.len + b.len;
4481                 rv.txt = malloc(rv.len);
4482                 memcpy(rv.txt, a.txt, a.len);
4483                 memcpy(rv.txt+a.len, b.txt, b.len);
4484                 return rv;
4485         }
4486
4487 ### Blocks, Statements, and Statement lists.
4488
4489 Now that we have expressions out of the way we need to turn to
4490 statements.  There are simple statements and more complex statements.
4491 Simple statements do not contain (syntactic) newlines, complex statements do.
4492
4493 Statements often come in sequences and we have corresponding simple
4494 statement lists and complex statement lists.
4495 The former comprise only simple statements separated by semicolons.
4496 The later comprise complex statements and simple statement lists.  They are
4497 separated by newlines.  Thus the semicolon is only used to separate
4498 simple statements on the one line.  This may be overly restrictive,
4499 but I'm not sure I ever want a complex statement to share a line with
4500 anything else.
4501
4502 Note that a simple statement list can still use multiple lines if
4503 subsequent lines are indented, so
4504
4505 ###### Example: wrapped simple statement list
4506
4507         a = b; c = d;
4508            e = f; print g
4509
4510 is a single simple statement list.  This might allow room for
4511 confusion, so I'm not set on it yet.
4512
4513 A simple statement list needs no extra syntax.  A complex statement
4514 list has two syntactic forms.  It can be enclosed in braces (much like
4515 C blocks), or it can be introduced by an indent and continue until an
4516 unindented newline (much like Python blocks).  With this extra syntax
4517 it is referred to as a block.
4518
4519 Note that a block does not have to include any newlines if it only
4520 contains simple statements.  So both of:
4521
4522         if condition: a=b; d=f
4523
4524         if condition { a=b; print f }
4525
4526 are valid.
4527
4528 In either case the list is constructed from a `binode` list with
4529 `Block` as the operator.  When parsing the list it is most convenient
4530 to append to the end, so a list is a list and a statement.  When using
4531 the list it is more convenient to consider a list to be a statement
4532 and a list.  So we need a function to re-order a list.
4533 `reorder_bilist` serves this purpose.
4534
4535 The only stand-alone statement we introduce at this stage is `pass`
4536 which does nothing and is represented as a `NULL` pointer in a `Block`
4537 list.  Other stand-alone statements will follow once the infrastructure
4538 is in-place.
4539
4540 As many statements will use binodes, we declare a binode pointer 'b' in
4541 the common header for all reductions to use.
4542
4543 ###### Parser: reduce
4544         struct binode *b;
4545
4546 ###### Binode types
4547         Block,
4548
4549 ###### Grammar
4550
4551         $TERM { } ;
4552
4553         $*binode
4554         Block -> { IN OptNL Statementlist OUT OptNL } ${ $0 = $<Sl; }$
4555         |        { SimpleStatements } ${ $0 = reorder_bilist($<SS); }$
4556         |        SimpleStatements ; ${ $0 = reorder_bilist($<SS); }$
4557         |        SimpleStatements EOL ${ $0 = reorder_bilist($<SS);
4558                 }$
4559         |        IN OptNL Statementlist OUT ${ $0 = $<Sl; }$
4560
4561         OpenBlock -> OpenScope { IN OptNL Statementlist OUT OptNL } ${ $0 = $<Sl; }$
4562         |        OpenScope { SimpleStatements } ${ $0 = reorder_bilist($<SS); }$
4563         |        OpenScope SimpleStatements ; ${ $0 = reorder_bilist($<SS); }$
4564         |        OpenScope SimpleStatements EOL ${ $0 = reorder_bilist($<SS); }$
4565         |        IN OpenScope OptNL Statementlist OUT ${ $0 = $<Sl; }$
4566
4567         UseBlock -> { IN OpenScope OptNL Statementlist OUT OptNL } ${ $0 = $<Sl; }$
4568         |        { OpenScope SimpleStatements } ${ $0 = reorder_bilist($<SS); }$
4569         |        IN OpenScope OptNL Statementlist OUT ${ $0 = $<Sl; }$
4570
4571         ColonBlock -> { IN OptNL Statementlist OUT OptNL } ${ $0 = $<Sl; }$
4572         |        { SimpleStatements } ${ $0 = reorder_bilist($<SS); }$
4573         |        : SimpleStatements ; ${ $0 = reorder_bilist($<SS); }$
4574         |        : SimpleStatements EOL ${ $0 = reorder_bilist($<SS); }$
4575         |        : IN OptNL Statementlist OUT ${ $0 = $<Sl; }$
4576
4577         Statementlist -> ComplexStatements ${ $0 = reorder_bilist($<CS); }$
4578
4579         ComplexStatements -> ComplexStatements ComplexStatement ${
4580                 if ($2 == NULL) {
4581                         $0 = $<1;       // NOTEST - impossible
4582                 } else {
4583                         $0 = new(binode);
4584                         $0->op = Block;
4585                         $0->left = $<1;
4586                         $0->right = $<2;
4587                 }
4588         }$
4589         | ComplexStatement ${
4590                 if ($1 == NULL) {
4591                         $0 = NULL;      // NOTEST - impossible
4592                 } else {
4593                         $0 = new(binode);
4594                         $0->op = Block;
4595                         $0->left = NULL;
4596                         $0->right = $<1;
4597                 }
4598         }$
4599
4600         $*exec
4601         ComplexStatement -> SimpleStatements Newlines ${
4602                 $0 = reorder_bilist($<SS);
4603         }$
4604         |  SimpleStatements ; Newlines ${
4605                 $0 = reorder_bilist($<SS);
4606         }$
4607         ## ComplexStatement Grammar
4608
4609         $*binode
4610         SimpleStatements -> SimpleStatements ; SimpleStatement ${
4611                 $0 = new(binode);
4612                 $0->op = Block;
4613                 $0->left = $<1;
4614                 $0->right = $<3;
4615         }$
4616         | SimpleStatement ${
4617                 $0 = new(binode);
4618                 $0->op = Block;
4619                 $0->left = NULL;
4620                 $0->right = $<1;
4621         }$
4622
4623         $TERM pass
4624         $*exec
4625         SimpleStatement -> pass ${ $0 = NULL; }$
4626         | ERROR ${ tok_err(c, "Syntax error in statement", &$1); }$
4627         ## SimpleStatement Grammar
4628
4629 ###### print binode cases
4630         case Block:
4631                 // block, one per line
4632                 if (b->left == NULL)
4633                         do_indent(indent, "pass\n");
4634                 else
4635                         print_exec(b->left, indent, bracket);
4636                 if (b->right)
4637                         print_exec(b->right, indent, bracket);
4638                 break;
4639
4640 ###### propagate binode cases
4641         case Block:
4642         {
4643                 /* If any statement returns something other than Tnone
4644                  * or Tbool then all such must return same type.
4645                  * As each statement may be Tnone or something else,
4646                  * we must always pass NULL (unknown) down, otherwise an incorrect
4647                  * error might occur.  We never return Tnone unless it is
4648                  * passed in.
4649                  */
4650                 struct binode *e;
4651
4652                 for (e = b; e; e = cast(binode, e->right)) {
4653                         t = propagate_types(e->left, c, perr, NULL, rules);
4654                         if ((rules & Rboolok) && (t == Tbool || t == Tnone))
4655                                 t = NULL;
4656                         if (t == Tnone && e->right)
4657                                 /* Only the final statement *must* return a value
4658                                  * when not Rboolok
4659                                  */
4660                                 t = NULL;
4661                         if (t) {
4662                                 if (!type)
4663                                         type = t;
4664                                 else if (t != type)
4665                                         type_err(c, "error: expected %1, found %2",
4666                                                  e->left, type, rules, t);
4667                         }
4668                 }
4669                 return type;
4670         }
4671
4672 ###### interp binode cases
4673         case Block:
4674                 while (rvtype == Tnone &&
4675                        b) {
4676                         if (b->left)
4677                                 rv = interp_exec(c, b->left, &rvtype);
4678                         b = cast(binode, b->right);
4679                 }
4680                 break;
4681
4682 ### The Print statement
4683
4684 `print` is a simple statement that takes a comma-separated list of
4685 expressions and prints the values separated by spaces and terminated
4686 by a newline.  No control of formatting is possible.
4687
4688 `print` uses `ExpressionList` to collect the expressions and stores them
4689 on the left side of a `Print` binode unlessthere is a trailing comma
4690 when the list is stored on the `right` side and no trailing newline is
4691 printed.
4692
4693 ###### Binode types
4694         Print,
4695
4696 ##### declare terminals
4697         $TERM print
4698
4699 ###### SimpleStatement Grammar
4700
4701         | print ExpressionList ${
4702                 $0 = b = new_pos(binode, $1);
4703                 b->op = Print;
4704                 b->right = NULL;
4705                 b->left = reorder_bilist($<EL);
4706         }$
4707         | print ExpressionList , ${ {
4708                 $0 = b = new_pos(binode, $1);
4709                 b->op = Print;
4710                 b->right = reorder_bilist($<EL);
4711                 b->left = NULL;
4712         } }$
4713         | print ${
4714                 $0 = b = new_pos(binode, $1);
4715                 b->op = Print;
4716                 b->left = NULL;
4717                 b->right = NULL;
4718         }$
4719
4720 ###### print binode cases
4721
4722         case Print:
4723                 do_indent(indent, "print");
4724                 if (b->right) {
4725                         print_exec(b->right, -1, bracket);
4726                         printf(",");
4727                 } else
4728                         print_exec(b->left, -1, bracket);
4729                 if (indent >= 0)
4730                         printf("\n");
4731                 break;
4732
4733 ###### propagate binode cases
4734
4735         case Print:
4736                 /* don't care but all must be consistent */
4737                 if (b->left)
4738                         b = cast(binode, b->left);
4739                 else
4740                         b = cast(binode, b->right);
4741                 while (b) {
4742                         propagate_types(b->left, c, perr_local, NULL, 0);
4743                         b = cast(binode, b->right);
4744                 }
4745                 break;
4746
4747 ###### interp binode cases
4748
4749         case Print:
4750         {
4751                 struct binode *b2 = cast(binode, b->left);
4752                 if (!b2)
4753                         b2 = cast(binode, b->right);
4754                 for (; b2; b2 = cast(binode, b2->right)) {
4755                         left = interp_exec(c, b2->left, &ltype);
4756                         print_value(ltype, &left, stdout);
4757                         free_value(ltype, &left);
4758                         if (b2->right)
4759                                 putchar(' ');
4760                 }
4761                 if (b->right == NULL)
4762                         printf("\n");
4763                 ltype = Tnone;
4764                 break;
4765         }
4766
4767 ###### Assignment statement
4768
4769 An assignment will assign a value to a variable, providing it hasn't
4770 been declared as a constant.  The analysis phase ensures that the type
4771 will be correct so the interpreter just needs to perform the
4772 calculation.  There is a form of assignment which declares a new
4773 variable as well as assigning a value.  If a name is used before
4774 it is declared, it is assumed to be a global constant which are allowed to
4775 be declared at any time.
4776
4777 ###### Binode types
4778         Assign,
4779         Declare,
4780
4781 ###### declare terminals
4782         $TERM =
4783
4784 ###### SimpleStatement Grammar
4785         | Term = Expression ${
4786                 $0 = b= new(binode);
4787                 b->op = Assign;
4788                 b->left = $<1;
4789                 b->right = $<3;
4790         }$
4791         | VariableDecl = Expression ${
4792                 $0 = b= new(binode);
4793                 b->op = Declare;
4794                 b->left = $<1;
4795                 b->right =$<3;
4796         }$
4797
4798         | VariableDecl ${
4799                 if ($1->var->where_set == NULL) {
4800                         type_err(c,
4801                                  "Variable declared with no type or value: %v",
4802                                  $1, NULL, 0, NULL);
4803                         free_var($1);
4804                 } else {
4805                         $0 = b = new(binode);
4806                         b->op = Declare;
4807                         b->left = $<1;
4808                         b->right = NULL;
4809                 }
4810         }$
4811
4812 ###### print binode cases
4813
4814         case Assign:
4815                 do_indent(indent, "");
4816                 print_exec(b->left, -1, bracket);
4817                 printf(" = ");
4818                 print_exec(b->right, -1, bracket);
4819                 if (indent >= 0)
4820                         printf("\n");
4821                 break;
4822
4823         case Declare:
4824                 {
4825                 struct variable *v = cast(var, b->left)->var;
4826                 do_indent(indent, "");
4827                 print_exec(b->left, -1, bracket);
4828                 if (cast(var, b->left)->var->constant) {
4829                         printf("::");
4830                         if (v->explicit_type) {
4831                                 type_print(v->type, stdout);
4832                                 printf(" ");
4833                         }
4834                 } else {
4835                         printf(":");
4836                         if (v->explicit_type) {
4837                                 type_print(v->type, stdout);
4838                                 printf(" ");
4839                         }
4840                 }
4841                 if (b->right) {
4842                         printf("= ");
4843                         print_exec(b->right, -1, bracket);
4844                 }
4845                 if (indent >= 0)
4846                         printf("\n");
4847                 }
4848                 break;
4849
4850 ###### propagate binode cases
4851
4852         case Assign:
4853         case Declare:
4854                 /* Both must match, or left may be ref and right an lval
4855                  * Type must support 'dup',
4856                  * For Assign, left must not be constant.
4857                  * result is Tnone
4858                  */
4859                 *perr &= ~(Erval | Econst);
4860                 t = propagate_types(b->left, c, perr, NULL, 0);
4861                 if (!b->right)
4862                         return Tnone;
4863
4864                 if (t) {
4865                         struct type *t2 = propagate_types(b->right, c, perr_local,
4866                                                           t, Rrefok);
4867                         if (!t2 || t2 == t || (*perr_local & Efail))
4868                                 ; // No more effort needed
4869                         else if (t->free == reference_free &&
4870                                  t->reference.referent == t2 &&
4871                                  !(*perr_local & Erval))
4872                                 b->right = take_addr(b->right);
4873                         else if (t->free == reference_free &&
4874                                  t->reference.referent == t2 &&
4875                                  (*perr_local & Erval))
4876                                 type_err(c, "error: Cannot assign an rval to a reference.",
4877                                          b, NULL, 0, NULL);
4878                 } else {
4879                         t = propagate_types(b->right, c, perr_local, NULL, 0);
4880                         if (t)
4881                                 propagate_types(b->left, c, perr, t, 0);
4882                 }
4883                 if (*perr & Erval)
4884                         type_err(c, "error: cannot assign to an rval", b,
4885                                  NULL, 0, NULL);
4886                 else if (b->op == Assign && (*perr & Econst)) {
4887                         type_err(c, "error: Cannot assign to a constant: %v",
4888                                  b->left, NULL, 0, NULL);
4889                         if (b->left->type == Xvar) {
4890                                 struct var *var = cast(var, b->left);
4891                                 struct variable *v = var->var;
4892                                 type_err(c, "info: name was defined as a constant here",
4893                                          v->where_decl, NULL, 0, NULL);
4894                         }
4895                 }
4896                 if (t && t->dup == NULL && !(*perr_local & Emaycopy))
4897                         type_err(c, "error: cannot assign value of type %1", b, t, 0, NULL);
4898                 if (b->left->type == Xvar && (*perr_local & Efail))
4899                         type_err(c, "info: variable '%v' was set as %1 here.",
4900                                  cast(var, b->left)->var->where_set, t, rules, NULL);
4901                 return Tnone;
4902
4903                 break;
4904
4905 ###### interp binode cases
4906
4907         case Assign:
4908                 lleft = linterp_exec(c, b->left, &ltype);
4909                 if (lleft)
4910                         dinterp_exec(c, b->right, lleft, ltype, 1);
4911                 ltype = Tnone;
4912                 break;
4913
4914         case Declare:
4915         {
4916                 struct variable *v = cast(var, b->left)->var;
4917                 struct value *val;
4918                 v = v->merged;
4919                 val = var_value(c, v);
4920                 if (v->type->prepare_type)
4921                         v->type->prepare_type(c, v->type, 0);
4922                 if (!b->right)
4923                         val_init(v->type, val);
4924                 else
4925                         dinterp_exec(c, b->right, val, v->type, 0);
4926                 break;
4927         }
4928
4929 ### The `use` statement
4930
4931 The `use` statement is the last "simple" statement.  It is needed when a
4932 statement block can return a value.  This includes the body of a
4933 function which has a return type, and the "condition" code blocks in
4934 `if`, `while`, and `switch` statements.
4935
4936 ###### Binode types
4937         Use,
4938
4939 ###### declare terminals
4940         $TERM use
4941
4942 ###### SimpleStatement Grammar
4943         | use Expression ${
4944                 $0 = b = new_pos(binode, $1);
4945                 b->op = Use;
4946                 b->right = $<2;
4947         }$
4948
4949 ###### print binode cases
4950
4951         case Use:
4952                 do_indent(indent, "use ");
4953                 print_exec(b->right, -1, bracket);
4954                 if (indent >= 0)
4955                         printf("\n");
4956                 break;
4957
4958 ###### propagate binode cases
4959
4960         case Use:
4961                 /* result matches value */
4962                 return propagate_types(b->right, c, perr, type, 0);
4963
4964 ###### interp binode cases
4965
4966         case Use:
4967                 rv = interp_exec(c, b->right, &rvtype);
4968                 break;
4969
4970 ### The Conditional Statement
4971
4972 This is the biggy and currently the only complex statement.  This
4973 subsumes `if`, `while`, `do/while`, `switch`, and some parts of `for`.
4974 It is comprised of a number of parts, all of which are optional though
4975 set combinations apply.  Each part is (usually) a key word (`then` is
4976 sometimes optional) followed by either an expression or a code block,
4977 except the `casepart` which is a "key word and an expression" followed
4978 by a code block.  The code-block option is valid for all parts and,
4979 where an expression is also allowed, the code block can use the `use`
4980 statement to report a value.  If the code block does not report a value
4981 the effect is similar to reporting `True`.
4982
4983 The `else` and `case` parts, as well as `then` when combined with
4984 `if`, can contain a `use` statement which will apply to some
4985 containing conditional statement. `for` parts, `do` parts and `then`
4986 parts used with `for` can never contain a `use`, except in some
4987 subordinate conditional statement.
4988
4989 If there is a `forpart`, it is executed first, only once.
4990 If there is a `dopart`, then it is executed repeatedly providing
4991 always that the `condpart` or `cond`, if present, does not return a non-True
4992 value.  `condpart` can fail to return any value if it simply executes
4993 to completion.  This is treated the same as returning `True`.
4994
4995 If there is a `thenpart` it will be executed whenever the `condpart`
4996 or `cond` returns True (or does not return any value), but this will happen
4997 *after* `dopart` (when present).
4998
4999 If `elsepart` is present it will be executed at most once when the
5000 condition returns `False` or some value that isn't `True` and isn't
5001 matched by any `casepart`.  If there are any `casepart`s, they will be
5002 executed when the condition returns a matching value.
5003
5004 The particular sorts of values allowed in case parts has not yet been
5005 determined in the language design, so nothing is prohibited.
5006
5007 The various blocks in this complex statement potentially provide scope
5008 for variables as described earlier.  Each such block must include the
5009 "OpenScope" nonterminal before parsing the block, and must call
5010 `var_block_close()` when closing the block.
5011
5012 The code following "`if`", "`switch`" and "`for`" does not get its own
5013 scope, but is in a scope covering the whole statement, so names
5014 declared there cannot be redeclared elsewhere.  Similarly the
5015 condition following "`while`" is in a scope the covers the body
5016 ("`do`" part) of the loop, and which does not allow conditional scope
5017 extension.  Code following "`then`" (both looping and non-looping),
5018 "`else`" and "`case`" each get their own local scope.
5019
5020 The type requirements on the code block in a `whilepart` are quite
5021 unusal.  It is allowed to return a value of some identifiable type, in
5022 which case the loop aborts and an appropriate `casepart` is run, or it
5023 can return a Boolean, in which case the loop either continues to the
5024 `dopart` (on `True`) or aborts and runs the `elsepart` (on `False`).
5025 This is different both from the `ifpart` code block which is expected to
5026 return a Boolean, or the `switchpart` code block which is expected to
5027 return the same type as the casepart values.  The correct analysis of
5028 the type of the `whilepart` code block is the reason for the
5029 `Rboolok` flag which is passed to `propagate_types()`.
5030
5031 The `cond_statement` cannot fit into a `binode` so a new `exec` is
5032 defined.  As there are two scopes which cover multiple parts - one for
5033 the whole statement and one for "while" and "do" - and as we will use
5034 the 'struct exec' to track scopes, we actually need two new types of
5035 exec.  One is a `binode` for the looping part, the rest is the
5036 `cond_statement`.  The `cond_statement` will use an auxilliary `struct
5037 casepart` to track a list of case parts.
5038
5039 ###### Binode types
5040         Loop
5041
5042 ###### exec type
5043         Xcond_statement,
5044
5045 ###### ast
5046         struct casepart {
5047                 struct exec *value;
5048                 struct exec *action;
5049                 struct casepart *next;
5050         };
5051         struct cond_statement {
5052                 struct exec;
5053                 struct exec *forpart, *condpart, *thenpart, *elsepart;
5054                 struct binode *looppart;
5055                 struct casepart *casepart;
5056         };
5057
5058 ###### ast functions
5059
5060         static void free_casepart(struct casepart *cp)
5061         {
5062                 while (cp) {
5063                         struct casepart *t;
5064                         free_exec(cp->value);
5065                         free_exec(cp->action);
5066                         t = cp->next;
5067                         free(cp);
5068                         cp = t;
5069                 }
5070         }
5071
5072         static void free_cond_statement(struct cond_statement *s)
5073         {
5074                 if (!s)
5075                         return;
5076                 free_exec(s->forpart);
5077                 free_exec(s->condpart);
5078                 free_exec(s->looppart);
5079                 free_exec(s->thenpart);
5080                 free_exec(s->elsepart);
5081                 free_casepart(s->casepart);
5082                 free(s);
5083         }
5084
5085 ###### free exec cases
5086         case Xcond_statement: free_cond_statement(cast(cond_statement, e)); break;
5087
5088 ###### ComplexStatement Grammar
5089         | CondStatement ${ $0 = $<1; }$
5090
5091 ###### declare terminals
5092         $TERM for then while do
5093         $TERM else
5094         $TERM switch case
5095
5096 ###### Grammar
5097
5098         $*cond_statement
5099         // A CondStatement must end with EOL, as does CondSuffix and
5100         // IfSuffix.
5101         // ForPart, ThenPart, SwitchPart, CasePart are non-empty and
5102         // may or may not end with EOL
5103         // WhilePart and IfPart include an appropriate Suffix
5104
5105         // ForPart, SwitchPart, and IfPart open scopes, o we have to close
5106         // them.  WhilePart opens and closes its own scope.
5107         CondStatement -> ForPart OptNL ThenPart OptNL WhilePart CondSuffix ${
5108                 $0 = $<CS;
5109                 $0->forpart = $<FP;
5110                 $0->thenpart = $<TP;
5111                 $0->looppart = $<WP;
5112                 var_block_close(c, CloseSequential, $0);
5113         }$
5114         | ForPart OptNL WhilePart CondSuffix ${
5115                 $0 = $<CS;
5116                 $0->forpart = $<FP;
5117                 $0->looppart = $<WP;
5118                 var_block_close(c, CloseSequential, $0);
5119         }$
5120         | WhilePart CondSuffix ${
5121                 $0 = $<CS;
5122                 $0->looppart = $<WP;
5123         }$
5124         | SwitchPart OptNL CasePart CondSuffix ${
5125                 $0 = $<CS;
5126                 $0->condpart = $<SP;
5127                 $CP->next = $0->casepart;
5128                 $0->casepart = $<CP;
5129                 var_block_close(c, CloseSequential, $0);
5130         }$
5131         | SwitchPart : IN OptNL CasePart CondSuffix OUT Newlines ${
5132                 $0 = $<CS;
5133                 $0->condpart = $<SP;
5134                 $CP->next = $0->casepart;
5135                 $0->casepart = $<CP;
5136                 var_block_close(c, CloseSequential, $0);
5137         }$
5138         | IfPart IfSuffix ${
5139                 $0 = $<IS;
5140                 $0->condpart = $IP.condpart; $IP.condpart = NULL;
5141                 $0->thenpart = $IP.thenpart; $IP.thenpart = NULL;
5142                 // This is where we close an "if" statement
5143                 var_block_close(c, CloseSequential, $0);
5144         }$
5145
5146         CondSuffix -> IfSuffix ${
5147                 $0 = $<1;
5148         }$
5149         | Newlines CasePart CondSuffix ${
5150                 $0 = $<CS;
5151                 $CP->next = $0->casepart;
5152                 $0->casepart = $<CP;
5153         }$
5154         | CasePart CondSuffix ${
5155                 $0 = $<CS;
5156                 $CP->next = $0->casepart;
5157                 $0->casepart = $<CP;
5158         }$
5159
5160         IfSuffix -> Newlines ${ $0 = new(cond_statement); }$
5161         | Newlines ElsePart ${ $0 = $<EP; }$
5162         | ElsePart ${$0 = $<EP; }$
5163
5164         ElsePart -> else OpenBlock Newlines ${
5165                 $0 = new(cond_statement);
5166                 $0->elsepart = $<OB;
5167                 var_block_close(c, CloseElse, $0->elsepart);
5168         }$
5169         | else OpenScope CondStatement ${
5170                 $0 = new(cond_statement);
5171                 $0->elsepart = $<CS;
5172                 var_block_close(c, CloseElse, $0->elsepart);
5173         }$
5174
5175         $*casepart
5176         CasePart -> case Expression OpenScope ColonBlock ${
5177                 $0 = calloc(1,sizeof(struct casepart));
5178                 $0->value = $<Ex;
5179                 $0->action = $<Bl;
5180                 var_block_close(c, CloseParallel, $0->action);
5181         }$
5182
5183         $*exec
5184         // These scopes are closed in CondStatement
5185         ForPart -> for OpenBlock ${
5186                 $0 = $<Bl;
5187         }$
5188
5189         ThenPart -> then OpenBlock ${
5190                 $0 = $<OB;
5191                 var_block_close(c, CloseSequential, $0);
5192         }$
5193
5194         $*binode
5195         // This scope is closed in CondStatement
5196         WhilePart -> while UseBlock OptNL do OpenBlock ${
5197                 $0 = new(binode);
5198                 $0->op = Loop;
5199                 $0->left = $<UB;
5200                 $0->right = $<OB;
5201                 var_block_close(c, CloseSequential, $0->right);
5202                 var_block_close(c, CloseSequential, $0);
5203         }$
5204         | while OpenScope Expression OpenScope ColonBlock ${
5205                 $0 = new(binode);
5206                 $0->op = Loop;
5207                 $0->left = $<Exp;
5208                 $0->right = $<CB;
5209                 var_block_close(c, CloseSequential, $0->right);
5210                 var_block_close(c, CloseSequential, $0);
5211         }$
5212
5213         $cond_statement
5214         IfPart -> if UseBlock OptNL then OpenBlock ${
5215                 $0.condpart = $<UB;
5216                 $0.thenpart = $<OB;
5217                 var_block_close(c, CloseParallel, $0.thenpart);
5218         }$
5219         | if OpenScope Expression OpenScope ColonBlock ${
5220                 $0.condpart = $<Ex;
5221                 $0.thenpart = $<CB;
5222                 var_block_close(c, CloseParallel, $0.thenpart);
5223         }$
5224         | if OpenScope Expression OpenScope OptNL then Block ${
5225                 $0.condpart = $<Ex;
5226                 $0.thenpart = $<Bl;
5227                 var_block_close(c, CloseParallel, $0.thenpart);
5228         }$
5229
5230         $*exec
5231         // This scope is closed in CondStatement
5232         SwitchPart -> switch OpenScope Expression ${
5233                 $0 = $<Ex;
5234         }$
5235         | switch UseBlock ${
5236                 $0 = $<Bl;
5237         }$
5238
5239 ###### print binode cases
5240         case Loop:
5241                 if (b->left && b->left->type == Xbinode &&
5242                     cast(binode, b->left)->op == Block) {
5243                         if (bracket)
5244                                 do_indent(indent, "while {\n");
5245                         else
5246                                 do_indent(indent, "while\n");
5247                         print_exec(b->left, indent+1, bracket);
5248                         if (bracket)
5249                                 do_indent(indent, "} do {\n");
5250                         else
5251                                 do_indent(indent, "do\n");
5252                         print_exec(b->right, indent+1, bracket);
5253                         if (bracket)
5254                                 do_indent(indent, "}\n");
5255                 } else {
5256                         do_indent(indent, "while ");
5257                         print_exec(b->left, 0, bracket);
5258                         if (bracket)
5259                                 printf(" {\n");
5260                         else
5261                                 printf(":\n");
5262                         print_exec(b->right, indent+1, bracket);
5263                         if (bracket)
5264                                 do_indent(indent, "}\n");
5265                 }
5266                 break;
5267
5268 ###### print exec cases
5269
5270         case Xcond_statement:
5271         {
5272                 struct cond_statement *cs = cast(cond_statement, e);
5273                 struct casepart *cp;
5274                 if (cs->forpart) {
5275                         do_indent(indent, "for");
5276                         if (bracket) printf(" {\n"); else printf("\n");
5277                         print_exec(cs->forpart, indent+1, bracket);
5278                         if (cs->thenpart) {
5279                                 if (bracket)
5280                                         do_indent(indent, "} then {\n");
5281                                 else
5282                                         do_indent(indent, "then\n");
5283                                 print_exec(cs->thenpart, indent+1, bracket);
5284                         }
5285                         if (bracket) do_indent(indent, "}\n");
5286                 }
5287                 if (cs->looppart) {
5288                         print_exec(cs->looppart, indent, bracket);
5289                 } else {
5290                         // a condition
5291                         if (cs->casepart)
5292                                 do_indent(indent, "switch");
5293                         else
5294                                 do_indent(indent, "if");
5295                         if (cs->condpart && cs->condpart->type == Xbinode &&
5296                             cast(binode, cs->condpart)->op == Block) {
5297                                 if (bracket)
5298                                         printf(" {\n");
5299                                 else
5300                                         printf("\n");
5301                                 print_exec(cs->condpart, indent+1, bracket);
5302                                 if (bracket)
5303                                         do_indent(indent, "}\n");
5304                                 if (cs->thenpart) {
5305                                         do_indent(indent, "then\n");
5306                                         print_exec(cs->thenpart, indent+1, bracket);
5307                                 }
5308                         } else {
5309                                 printf(" ");
5310                                 print_exec(cs->condpart, 0, bracket);
5311                                 if (cs->thenpart) {
5312                                         if (bracket)
5313                                                 printf(" {\n");
5314                                         else
5315                                                 printf(":\n");
5316                                         print_exec(cs->thenpart, indent+1, bracket);
5317                                         if (bracket)
5318                                                 do_indent(indent, "}\n");
5319                                 } else
5320                                         printf("\n");
5321                         }
5322                 }
5323                 for (cp = cs->casepart; cp; cp = cp->next) {
5324                         do_indent(indent, "case ");
5325                         print_exec(cp->value, -1, 0);
5326                         if (bracket)
5327                                 printf(" {\n");
5328                         else
5329                                 printf(":\n");
5330                         print_exec(cp->action, indent+1, bracket);
5331                         if (bracket)
5332                                 do_indent(indent, "}\n");
5333                 }
5334                 if (cs->elsepart) {
5335                         do_indent(indent, "else");
5336                         if (bracket)
5337                                 printf(" {\n");
5338                         else
5339                                 printf("\n");
5340                         print_exec(cs->elsepart, indent+1, bracket);
5341                         if (bracket)
5342                                 do_indent(indent, "}\n");
5343                 }
5344                 break;
5345         }
5346
5347 ###### propagate binode cases
5348         case Loop:
5349                 propagate_types(b->right, c, perr_local, Tnone, 0);
5350                 return propagate_types(b->left, c, perr, type, rules);
5351
5352 ###### propagate exec cases
5353         case Xcond_statement:
5354         {
5355                 // forpart and looppart->right must return Tnone
5356                 // thenpart must return Tnone if there is a loopart,
5357                 // otherwise it is like elsepart.
5358                 // condpart must:
5359                 //    be bool if there is no casepart
5360                 //    match casepart->values if there is a switchpart
5361                 //    either be bool or match casepart->value if there
5362                 //             is a whilepart
5363                 // elsepart and casepart->action must match the return type
5364                 //   expected of this statement.
5365                 struct cond_statement *cs = cast(cond_statement, prog);
5366                 struct casepart *cp;
5367
5368                 t = propagate_types(cs->forpart, c, perr, Tnone, 0);
5369
5370                 if (cs->looppart) {
5371                         t = propagate_types(cs->thenpart, c, perr, Tnone, 0);
5372                 }
5373                 if (cs->casepart == NULL) {
5374                         propagate_types(cs->condpart, c, perr, Tbool, 0);
5375                         propagate_types(cs->looppart, c, perr, Tbool, 0);
5376                 } else {
5377                         /* Condpart must match case values, with bool permitted */
5378                         t = NULL;
5379                         for (cp = cs->casepart;
5380                              cp && !t; cp = cp->next)
5381                                 t = propagate_types(cp->value, c, perr, NULL, 0);
5382                         if (!t && cs->condpart)
5383                                 t = propagate_types(cs->condpart, c, perr, NULL, Rboolok);      // NOTEST
5384                         if (!t && cs->looppart)
5385                                 t = propagate_types(cs->looppart, c, perr, NULL, Rboolok);      // NOTEST
5386                         // Now we have a type (I hope) push it down
5387                         if (t) {
5388                                 for (cp = cs->casepart; cp; cp = cp->next)
5389                                         propagate_types(cp->value, c, perr, t, 0);
5390                                 propagate_types(cs->condpart, c, perr, t, Rboolok);
5391                                 propagate_types(cs->looppart, c, perr, t, Rboolok);
5392                         }
5393                 }
5394                 // (if)then, else, and case parts must return expected type.
5395                 if (!cs->looppart && !type)
5396                         type = propagate_types(cs->thenpart, c, perr, NULL, rules);
5397                 if (!type)
5398                         type = propagate_types(cs->elsepart, c, perr, NULL, rules);
5399                 for (cp = cs->casepart;
5400                      cp && !type;
5401                      cp = cp->next)     // NOTEST
5402                         type = propagate_types(cp->action, c, perr, NULL, rules);       // NOTEST
5403                 if (type) {
5404                         if (!cs->looppart)
5405                                 propagate_types(cs->thenpart, c, perr, type, rules);
5406                         propagate_types(cs->elsepart, c, perr, type, rules);
5407                         for (cp = cs->casepart; cp ; cp = cp->next)
5408                                 propagate_types(cp->action, c, perr, type, rules);
5409                         return type;
5410                 } else
5411                         return NULL;
5412         }
5413
5414 ###### interp binode cases
5415         case Loop:
5416                 // This just performs one iterration of the loop
5417                 rv = interp_exec(c, b->left, &rvtype);
5418                 if (rvtype == Tnone ||
5419                     (rvtype == Tbool && rv.bool != 0))
5420                         // rvtype is Tnone or Tbool, doesn't need to be freed
5421                         interp_exec(c, b->right, NULL);
5422                 break;
5423
5424 ###### interp exec cases
5425         case Xcond_statement:
5426         {
5427                 struct value v, cnd;
5428                 struct type *vtype, *cndtype;
5429                 struct casepart *cp;
5430                 struct cond_statement *cs = cast(cond_statement, e);
5431
5432                 if (cs->forpart)
5433                         interp_exec(c, cs->forpart, NULL);
5434                 if (cs->looppart) {
5435                         while ((cnd = interp_exec(c, cs->looppart, &cndtype)),
5436                                cndtype == Tnone || (cndtype == Tbool && cnd.bool != 0))
5437                                 interp_exec(c, cs->thenpart, NULL);
5438                 } else {
5439                         cnd = interp_exec(c, cs->condpart, &cndtype);
5440                         if ((cndtype == Tnone ||
5441                             (cndtype == Tbool && cnd.bool != 0))) {
5442                                 // cnd is Tnone or Tbool, doesn't need to be freed
5443                                 rv = interp_exec(c, cs->thenpart, &rvtype);
5444                                 // skip else (and cases)
5445                                 goto Xcond_done;
5446                         }
5447                 }
5448                 for (cp = cs->casepart; cp; cp = cp->next) {
5449                         v = interp_exec(c, cp->value, &vtype);
5450                         if (value_cmp(cndtype, vtype, &v, &cnd) == 0) {
5451                                 free_value(vtype, &v);
5452                                 free_value(cndtype, &cnd);
5453                                 rv = interp_exec(c, cp->action, &rvtype);
5454                                 goto Xcond_done;
5455                         }
5456                         free_value(vtype, &v);
5457                 }
5458                 free_value(cndtype, &cnd);
5459                 if (cs->elsepart)
5460                         rv = interp_exec(c, cs->elsepart, &rvtype);
5461                 else
5462                         rvtype = Tnone;
5463         Xcond_done:
5464                 break;
5465         }
5466
5467 ### Top level structure
5468
5469 All the language elements so far can be used in various places.  Now
5470 it is time to clarify what those places are.
5471
5472 At the top level of a file there will be a number of declarations.
5473 Many of the things that can be declared haven't been described yet,
5474 such as functions, procedures, imports, and probably more.
5475 For now there are two sorts of things that can appear at the top
5476 level.  They are predefined constants, `struct` types, and the `main`
5477 function.  While the syntax will allow the `main` function to appear
5478 multiple times, that will trigger an error if it is actually attempted.
5479
5480 The various declarations do not return anything.  They store the
5481 various declarations in the parse context.
5482
5483 ###### Parser: grammar
5484
5485         $void
5486         Ocean -> OptNL DeclarationList
5487
5488         ## declare terminals
5489
5490         OptNL ->
5491         | OptNL NEWLINE
5492
5493         Newlines -> NEWLINE
5494         | Newlines NEWLINE
5495
5496         DeclarationList -> Declaration
5497         | DeclarationList Declaration
5498
5499         Declaration -> ERROR Newlines ${
5500                 tok_err(c,      // NOTEST
5501                         "error: unhandled parse error", &$1);
5502         }$
5503         | DeclareConstant
5504         | DeclareFunction
5505         | DeclareStruct
5506
5507         ## top level grammar
5508
5509         ## Grammar
5510
5511 ### The `const` section
5512
5513 As well as being defined in with the code that uses them, constants can
5514 be declared at the top level.  These have full-file scope, so they are
5515 always `InScope`, even before(!) they have been declared.  The value of
5516 a top level constant can be given as an expression, and this is
5517 evaluated after parsing and before execution.
5518
5519 A function call can be used to evaluate a constant, but it will not have
5520 access to any program state, once such statement becomes meaningful.
5521 e.g.  arguments and filesystem will not be visible.
5522
5523 Constants are defined in a section that starts with the reserved word
5524 `const` and then has a block with a list of assignment statements.
5525 For syntactic consistency, these must use the double-colon syntax to
5526 make it clear that they are constants.  Type can also be given: if
5527 not, the type will be determined during analysis, as with other
5528 constants.
5529
5530 ###### parse context
5531         struct binode *constlist;
5532
5533 ###### top level grammar
5534
5535         $TERM const
5536
5537         DeclareConstant -> const { IN OptNL ConstList OUT OptNL } Newlines
5538         | const { SimpleConstList } Newlines
5539         | const IN OptNL ConstList OUT Newlines
5540         | const SimpleConstList Newlines
5541
5542         ConstList -> ConstList SimpleConstLine
5543         | SimpleConstLine
5544
5545         SimpleConstList -> SimpleConstList ; Const
5546         | Const
5547         | SimpleConstList ;
5548
5549         SimpleConstLine -> SimpleConstList Newlines
5550         | ERROR Newlines ${ tok_err(c, "Syntax error in constant", &$1); }$
5551
5552         $*type
5553         CType -> Type   ${ $0 = $<1; }$
5554         |               ${ $0 = NULL; }$
5555
5556         $void
5557         Const -> IDENTIFIER :: CType = Expression ${ {
5558                 struct variable *v;
5559                 struct binode *bl, *bv;
5560                 struct var *var = new_pos(var, $ID);
5561
5562                 v = var_decl(c, $ID.txt);
5563                 if (v) {
5564                         v->where_decl = var;
5565                         v->where_set = var;
5566                         v->type = $<CT;
5567                         v->constant = 1;
5568                         v->global = 1;
5569                 } else {
5570                         v = var_ref(c, $1.txt);
5571                         if (v->type == Tnone) {
5572                                 v->where_decl = var;
5573                                 v->where_set = var;
5574                                 v->type = $<CT;
5575                                 v->constant = 1;
5576                                 v->global = 1;
5577                         } else {
5578                                 tok_err(c, "error: name already declared", &$1);
5579                                 type_err(c, "info: this is where '%v' was first declared",
5580                                          v->where_decl, NULL, 0, NULL);
5581                         }
5582                 }
5583                 var->var = v;
5584
5585                 bv = new(binode);
5586                 bv->op = Declare;
5587                 bv->left = var;
5588                 bv->right= $<Exp;
5589
5590                 bl = new(binode);
5591                 bl->op = List;
5592                 bl->left = c->constlist;
5593                 bl->right = bv;
5594                 c->constlist = bl;
5595         } }$
5596
5597 ###### core functions
5598         static void resolve_consts(struct parse_context *c)
5599         {
5600                 struct binode *b;
5601                 int retry = 1;
5602                 enum { none, some, cannot } progress = none;
5603
5604                 c->constlist = reorder_bilist(c->constlist);
5605                 while (retry) {
5606                         retry = 0;
5607                         for (b = cast(binode, c->constlist); b;
5608                              b = cast(binode, b->right)) {
5609                                 enum prop_err perr;
5610                                 struct binode *vb = cast(binode, b->left);
5611                                 struct var *v = cast(var, vb->left);
5612                                 if (v->var->frame_pos >= 0)
5613                                         continue;
5614                                 do {
5615                                         perr = 0;
5616                                         propagate_types(vb->right, c, &perr,
5617                                                         v->var->type, 0);
5618                                 } while (perr & Eretry);
5619                                 if (perr & Efail)
5620                                         c->parse_error += 1;
5621                                 else if (!(perr & Eruntime)) {
5622                                         progress = some;
5623                                         struct value res = interp_exec(
5624                                                 c, vb->right, &v->var->type);
5625                                         global_alloc(c, v->var->type, v->var, &res);
5626                                 } else {
5627                                         if (progress == cannot)
5628                                                 type_err(c, "error: const %v cannot be resolved.",
5629                                                          v, NULL, 0, NULL);
5630                                         else
5631                                                 retry = 1;
5632                                 }
5633                         }
5634                         switch (progress) {
5635                         case cannot:
5636                                 retry = 0; break;
5637                         case none:
5638                                 progress = cannot; break;
5639                         case some:
5640                                 progress = none; break;
5641                         }
5642                 }
5643         }
5644
5645 ###### print const decls
5646         {
5647                 struct binode *b;
5648                 int first = 1;
5649
5650                 for (b = cast(binode, context.constlist); b;
5651                      b = cast(binode, b->right)) {
5652                         struct binode *vb = cast(binode, b->left);
5653                         struct var *vr = cast(var, vb->left);
5654                         struct variable *v = vr->var;
5655
5656                         if (first)
5657                                 printf("const\n");
5658                         first = 0;
5659
5660                         printf("    %.*s :: ", v->name->name.len, v->name->name.txt);
5661                         type_print(v->type, stdout);
5662                         printf(" = ");
5663                         print_exec(vb->right, -1, 0);
5664                         printf("\n");
5665                 }
5666         }
5667
5668 ###### free const decls
5669         free_binode(context.constlist);
5670
5671 ### Function declarations
5672
5673 The code in an Ocean program is all stored in function declarations.
5674 One of the functions must be named `main` and it must accept an array of
5675 strings as a parameter - the command line arguments.
5676
5677 As this is the top level, several things are handled a bit differently.
5678 The function is not interpreted by `interp_exec` as that isn't passed
5679 the argument list which the program requires.  Similarly type analysis
5680 is a bit more interesting at this level.
5681
5682 ###### ast functions
5683
5684         static struct type *handle_results(struct parse_context *c,
5685                                            struct binode *results)
5686         {
5687                 /* Create a 'struct' type from the results list, which
5688                  * is a list for 'struct var'
5689                  */
5690                 struct type *t = add_anon_type(c, &structure_prototype,
5691                                                "function result");
5692                 int cnt = 0;
5693                 struct binode *b;
5694
5695                 for (b = results; b; b = cast(binode, b->right))
5696                         cnt += 1;
5697                 t->structure.nfields = cnt;
5698                 t->structure.fields = calloc(cnt, sizeof(struct field));
5699                 cnt = 0;
5700                 for (b = results; b; b = cast(binode, b->right)) {
5701                         struct var *v = cast(var, b->left);
5702                         struct field *f = &t->structure.fields[cnt++];
5703                         int a = v->var->type->align;
5704                         f->name = v->var->name->name;
5705                         f->type = v->var->type;
5706                         f->init = NULL;
5707                         f->offset = t->size;
5708                         v->var->frame_pos = f->offset;
5709                         t->size += ((f->type->size - 1) | (a-1)) + 1;
5710                         if (a > t->align)
5711                                 t->align = a;
5712                         variable_unlink_exec(v->var);
5713                 }
5714                 free_binode(results);
5715                 return t;
5716         }
5717
5718         static struct variable *declare_function(struct parse_context *c,
5719                                                 struct variable *name,
5720                                                 struct binode *args,
5721                                                 struct type *ret,
5722                                                 struct binode *results,
5723                                                 struct exec *code)
5724         {
5725                 if (name) {
5726                         struct value fn = {.function = code};
5727                         struct type *t;
5728                         var_block_close(c, CloseFunction, code);
5729                         t = add_anon_type(c, &function_prototype,
5730                                           "func %.*s", name->name->name.len,
5731                                           name->name->name.txt);
5732                         name->type = t;
5733                         t->function.params = reorder_bilist(args);
5734                         if (!ret) {
5735                                 ret = handle_results(c, reorder_bilist(results));
5736                                 t->function.inline_result = 1;
5737                                 t->function.local_size = ret->size;
5738                         }
5739                         t->function.return_type = ret;
5740                         global_alloc(c, t, name, &fn);
5741                         name->type->function.scope = c->out_scope;
5742                 } else {
5743                         free_binode(args);
5744                         free_type(ret);
5745                         free_exec(code);
5746                         var_block_close(c, CloseFunction, NULL);
5747                 }
5748                 c->out_scope = NULL;
5749                 return name;
5750         }
5751
5752 ###### declare terminals
5753         $TERM return
5754
5755 ###### top level grammar
5756
5757         $*variable
5758         DeclareFunction -> func FuncName ( OpenScope ArgsLine ) Block Newlines ${
5759                 $0 = declare_function(c, $<FN, $<Ar, Tnone, NULL, $<Bl);
5760         }$
5761         | func FuncName IN OpenScope Args OUT OptNL do Block Newlines ${
5762                 $0 = declare_function(c, $<FN, $<Ar, Tnone, NULL, $<Bl);
5763         }$
5764         | func FuncName NEWLINE OpenScope OptNL do Block Newlines ${
5765                 $0 = declare_function(c, $<FN, NULL, Tnone, NULL, $<Bl);
5766         }$
5767         | func FuncName ( OpenScope ArgsLine ) : Type Block Newlines ${
5768                 $0 = declare_function(c, $<FN, $<Ar, $<Ty, NULL, $<Bl);
5769         }$
5770         | func FuncName ( OpenScope ArgsLine ) : ( ArgsLine ) Block Newlines ${
5771                 $0 = declare_function(c, $<FN, $<AL, NULL, $<AL2, $<Bl);
5772         }$
5773         | func FuncName IN OpenScope Args OUT OptNL return Type Newlines do Block Newlines ${
5774                 $0 = declare_function(c, $<FN, $<Ar, $<Ty, NULL, $<Bl);
5775         }$
5776         | func FuncName NEWLINE OpenScope return Type Newlines do Block Newlines ${
5777                 $0 = declare_function(c, $<FN, NULL, $<Ty, NULL, $<Bl);
5778         }$
5779         | func FuncName IN OpenScope Args OUT OptNL return IN Args OUT OptNL do Block Newlines ${
5780                 $0 = declare_function(c, $<FN, $<Ar, NULL, $<Ar2, $<Bl);
5781         }$
5782         | func FuncName NEWLINE OpenScope return IN Args OUT OptNL do Block Newlines ${
5783                 $0 = declare_function(c, $<FN, NULL, NULL, $<Ar, $<Bl);
5784         }$
5785
5786 ###### print func decls
5787         {
5788                 struct variable *v;
5789                 int target = -1;
5790
5791                 while (target != 0) {
5792                         int i = 0;
5793                         for (v = context.in_scope; v; v=v->in_scope)
5794                                 if (v->depth == 0 && v->type && v->type->check_args) {
5795                                         i += 1;
5796                                         if (i == target)
5797                                                 break;
5798                                 }
5799
5800                         if (target == -1) {
5801                                 target = i;
5802                         } else {
5803                                 struct value *val = var_value(&context, v);
5804                                 printf("func %.*s", v->name->name.len, v->name->name.txt);
5805                                 v->type->print_type_decl(v->type, stdout);
5806                                 if (brackets) {
5807                                         printf(" {\n");
5808                                         print_exec(val->function, 1, brackets);
5809                                         printf("}\n");
5810                                 } else {
5811                                         print_value(v->type, val, stdout);
5812                                 }
5813                                 printf("/* frame size %d */\n", v->type->function.local_size);
5814                                 target -= 1;
5815                         }
5816                 }
5817         }
5818
5819 ###### core functions
5820
5821         static int analyse_funcs(struct parse_context *c)
5822         {
5823                 struct variable *v;
5824                 int all_ok = 1;
5825                 for (v = c->in_scope; v; v = v->in_scope) {
5826                         struct value *val;
5827                         struct type *ret;
5828                         enum prop_err perr;
5829                         if (v->depth != 0 || !v->type || !v->type->check_args)
5830                                 continue;
5831                         ret = v->type->function.inline_result ?
5832                                 Tnone : v->type->function.return_type;
5833                         val = var_value(c, v);
5834                         do {
5835                                 perr = 0;
5836                                 propagate_types(val->function, c, &perr, ret, 0);
5837                         } while (!(perr & Efail) && (perr & Eretry));
5838                         if (!(perr & Efail))
5839                                 /* Make sure everything is still consistent */
5840                                 propagate_types(val->function, c, &perr, ret, 0);
5841                         if (perr & Efail)
5842                                 all_ok = 0;
5843                         if (!v->type->function.inline_result &&
5844                             !v->type->function.return_type->dup) {
5845                                 type_err(c, "error: function cannot return value of type %1",
5846                                          v->where_decl, v->type->function.return_type, 0, NULL);
5847                         }
5848
5849                         scope_finalize(c, v->type);
5850                 }
5851                 return all_ok;
5852         }
5853
5854         static int analyse_main(struct type *type, struct parse_context *c)
5855         {
5856                 struct binode *bp = type->function.params;
5857                 struct binode *b;
5858                 enum prop_err perr;
5859                 int arg = 0;
5860                 struct type *argv_type;
5861
5862                 argv_type = add_anon_type(c, &array_prototype, "argv");
5863                 argv_type->array.member = Tstr;
5864                 argv_type->array.unspec = 1;
5865
5866                 for (b = bp; b; b = cast(binode, b->right)) {
5867                         perr = 0;
5868                         switch (arg++) {
5869                         case 0: /* argv */
5870                                 propagate_types(b->left, c, &perr, argv_type, 0);
5871                                 break;
5872                         default: /* invalid */  // NOTEST
5873                                 propagate_types(b->left, c, &perr, Tnone, 0);   // NOTEST
5874                         }
5875                         if (perr & Efail)
5876                                 c->parse_error += 1;
5877                 }
5878
5879                 return !c->parse_error;
5880         }
5881
5882         static void interp_main(struct parse_context *c, int argc, char **argv)
5883         {
5884                 struct value *progp = NULL;
5885                 struct text main_name = { "main", 4 };
5886                 struct variable *mainv;
5887                 struct binode *al;
5888                 int anum = 0;
5889                 struct value v;
5890                 struct type *vtype;
5891
5892                 mainv = var_ref(c, main_name);
5893                 if (mainv)
5894                         progp = var_value(c, mainv);
5895                 if (!progp || !progp->function) {
5896                         fprintf(stderr, "oceani: no main function found.\n");
5897                         c->parse_error += 1;
5898                         return;
5899                 }
5900                 if (!analyse_main(mainv->type, c)) {
5901                         fprintf(stderr, "oceani: main has wrong type.\n");
5902                         c->parse_error += 1;
5903                         return;
5904                 }
5905                 al = mainv->type->function.params;
5906
5907                 c->local_size = mainv->type->function.local_size;
5908                 c->local = calloc(1, c->local_size);
5909                 while (al) {
5910                         struct var *v = cast(var, al->left);
5911                         struct value *vl = var_value(c, v->var);
5912                         struct value arg;
5913                         struct type *t;
5914                         int i;
5915
5916                         switch (anum++) {
5917                         case 0: /* argv */
5918                                 t = v->var->type;
5919                                 t->array.size = argc;
5920                                 t->prepare_type(c, t, 0);
5921                                 array_init(v->var->type, vl);
5922                                 for (i = 0; i < argc; i++) {
5923                                         struct value *vl2 = vl->array + i * v->var->type->array.member->size;
5924
5925                                         arg.str.txt = argv[i];
5926                                         arg.str.len = strlen(argv[i]);
5927                                         free_value(Tstr, vl2);
5928                                         dup_value(Tstr, &arg, vl2);
5929                                 }
5930                                 break;
5931                         }
5932                         al = cast(binode, al->right);
5933                 }
5934                 v = interp_exec(c, progp->function, &vtype);
5935                 free_value(vtype, &v);
5936                 free(c->local);
5937                 c->local = NULL;
5938         }
5939
5940 ###### ast functions
5941         void free_variable(struct variable *v)
5942         {
5943         }
5944
5945 ## And now to test it out.
5946
5947 Having a language requires having a "hello world" program.  I'll
5948 provide a little more than that: a program that prints "Hello world"
5949 finds the GCD of two numbers, prints the first few elements of
5950 Fibonacci, performs a binary search for a number, and a few other
5951 things which will likely grow as the languages grows.
5952
5953 ###### File: oceani.mk
5954         demos :: sayhello
5955         sayhello : oceani
5956                 @echo "===== DEMO ====="
5957                 ./oceani --section "demo: hello" oceani.mdc 55 33
5958
5959 ###### demo: hello
5960
5961         const
5962                 pi ::= 3.141_592_6
5963                 four ::= 2 + 2 ; five ::= 10/2
5964         const pie ::= "I like Pie";
5965                 cake ::= "The cake is"
5966                   ++ " a lie"
5967
5968         struct fred
5969                 size:[four]number
5970                 name:string
5971                 alive:Boolean
5972
5973         func main(argv:[]string)
5974                 print "Hello World, what lovely oceans you have!"
5975                 print "Are there", five, "?"
5976                 print pi, pie, "but", cake
5977
5978                 A := $argv[1]; B := $argv[2]
5979
5980                 /* When a variable is defined in both branches of an 'if',
5981                  * and used afterwards, the variables are merged.
5982                  */
5983                 if A > B:
5984                         bigger := "yes"
5985                 else
5986                         bigger := "no"
5987                 print "Is", A, "bigger than", B,"? ", bigger
5988                 /* If a variable is not used after the 'if', no
5989                  * merge happens, so types can be different
5990                  */
5991                 if A > B * 2:
5992                         double:string = "yes"
5993                         print A, "is more than twice", B, "?", double
5994                 else
5995                         double := B*2
5996                         print "double", B, "is", double
5997
5998                 a : number
5999                 a = A;
6000                 b:number = B
6001                 if a > 0 and then b > 0:
6002                         while a != b:
6003                                 if a < b:
6004                                         b = b - a
6005                                 else
6006                                         a = a - b
6007                         print "GCD of", A, "and", B,"is", a
6008                 else if a <= 0:
6009                         print a, "is not positive, cannot calculate GCD"
6010                 else
6011                         print b, "is not positive, cannot calculate GCD"
6012
6013                 for
6014                         togo := 10
6015                         f1 := 1; f2 := 1
6016                         print "Fibonacci:", f1,f2,
6017                 then togo = togo - 1
6018                 while togo > 0:
6019                         f3 := f1 + f2
6020                         print "", f3,
6021                         f1 = f2
6022                         f2 = f3
6023                 print ""
6024
6025                 /* Binary search... */
6026                 for
6027                         lo:= 0; hi := 100
6028                         target := 77
6029                 while
6030                         mid := (lo + hi) / 2
6031                         if mid == target:
6032                                 use .Found
6033                         if mid < target:
6034                                 lo = mid
6035                         else
6036                                 hi = mid
6037                         if hi - lo < 1:
6038                                 lo = mid
6039                                 use .GiveUp
6040                         use True
6041                 do pass
6042                 case .Found:
6043                         print "Yay, I found", target
6044                 case .GiveUp:
6045                         print "Closest I found was", lo
6046
6047                 size::= 10
6048                 list:[size]number
6049                 list[0] = 1234
6050                 // "middle square" PRNG.  Not particularly good, but one my
6051                 // Dad taught me - the first one I ever heard of.
6052                 for i:=1; then i = i + 1; while i < size:
6053                         n := list[i-1] * list[i-1]
6054                         list[i] = (n / 100) % 10 000
6055
6056                 print "Before sort:",
6057                 for i:=0; then i = i + 1; while i < size:
6058                         print "", list[i],
6059                 print
6060
6061                 for i := 1; then i=i+1; while i < size:
6062                         for j:=i-1; then j=j-1; while j >= 0:
6063                                 if list[j] > list[j+1]:
6064                                         t:= list[j]
6065                                         list[j] = list[j+1]
6066                                         list[j+1] = t
6067                 print " After sort:",
6068                 for i:=0; then i = i + 1; while i < size:
6069                         print "", list[i],
6070                 print
6071
6072                 if 1 == 2 then print "yes"; else print "no"
6073
6074                 bob:fred
6075                 bob.name = "Hello"
6076                 bob.alive = (bob.name == "Hello")
6077                 print "bob", "is" if  bob.alive else "isn't", "alive"