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; // NOTEST
1161                 switch (tl->vtype) {
1162                 case Vlabel: cmp = left->label == right->label ? 0 : 1; break;
1163                 case Vnum: cmp = mpq_cmp(left->num, right->num); break;
1164                 case Vstr: cmp = text_cmp(left->str, right->str); break;
1165                 case Vbool: cmp = left->bool - right->bool; break;
1166                 case Vnone: cmp = 0;                    // NOTEST
1167                 }
1168                 return cmp;
1169         }
1170
1171         static void _print_value(struct type *type, struct value *v, FILE *f)
1172         {
1173                 switch (type->vtype) {
1174                 case Vnone:                             // NOTEST
1175                         fprintf(f, "*no-value*"); break;        // NOTEST
1176                 case Vlabel:                            // NOTEST
1177                         fprintf(f, "*label-%d*", v->label); break; // NOTEST
1178                 case Vstr:
1179                         fprintf(f, "%.*s", v->str.len, v->str.txt); break;
1180                 case Vbool:
1181                         fprintf(f, "%s", v->bool ? "True":"False"); break;
1182                 case Vnum:
1183                         {
1184                         mpf_t fl;
1185                         mpf_init2(fl, 20);
1186                         mpf_set_q(fl, v->num);
1187                         gmp_fprintf(f, "%.10Fg", fl);
1188                         mpf_clear(fl);
1189                         break;
1190                         }
1191                 }
1192         }
1193
1194         static void _free_value(struct type *type, struct value *v);
1195
1196         static int bool_test(struct type *type, struct value *v)
1197         {
1198                 return v->bool;
1199         }
1200
1201         static struct type base_prototype = {
1202                 .init = _val_init,
1203                 .print = _print_value,
1204                 .cmp_order = _value_cmp,
1205                 .cmp_eq = _value_cmp,
1206                 .dup = _dup_value,
1207                 .free = _free_value,
1208         };
1209
1210         static struct type *Tbool, *Tstr, *Tnum, *Tnone, *Tlabel;
1211
1212 ###### ast functions
1213         static struct type *add_base_type(struct parse_context *c, char *n,
1214                                           enum vtype vt, int size)
1215         {
1216                 struct text txt = { n, strlen(n) };
1217                 struct type *t;
1218
1219                 t = add_type(c, txt, &base_prototype);
1220                 t->vtype = vt;
1221                 t->size = size;
1222                 t->align = size > sizeof(void*) ? sizeof(void*) : size;
1223                 if (t->size & (t->align - 1))
1224                         t->size = (t->size | (t->align - 1)) + 1;       // NOTEST
1225                 return t;
1226         }
1227
1228 ###### context initialization
1229
1230         Tbool  = add_base_type(&context, "Boolean", Vbool, sizeof(char));
1231         Tbool->test = bool_test;
1232         Tstr   = add_base_type(&context, "string", Vstr, sizeof(struct text));
1233         Tnum   = add_base_type(&context, "number", Vnum, sizeof(mpq_t));
1234         Tnone  = add_base_type(&context, "none", Vnone, 0);
1235         Tlabel = add_base_type(&context, "label", Vlabel, sizeof(void*));
1236
1237 ##### Base Values
1238
1239 We have already met values as separate objects.  When manifest constants
1240 appear in the program text, that must result in an executable which has
1241 a constant value.  So the `val` structure embeds a value in an
1242 executable.
1243
1244 ###### exec type
1245         Xval,
1246
1247 ###### ast
1248         struct val {
1249                 struct exec;
1250                 struct type *vtype;
1251                 struct value val;
1252         };
1253
1254 ###### ast functions
1255         struct val *new_val(struct type *T, struct token tk)
1256         {
1257                 struct val *v = new_pos(val, tk);
1258                 v->vtype = T;
1259                 return v;
1260         }
1261
1262 ###### declare terminals
1263         $TERM True False
1264
1265 ###### Grammar
1266
1267         $*val
1268         Value ->  True ${
1269                 $0 = new_val(Tbool, $1);
1270                 $0->val.bool = 1;
1271         }$
1272         | False ${
1273                 $0 = new_val(Tbool, $1);
1274                 $0->val.bool = 0;
1275         }$
1276         | NUMBER ${ {
1277                 char tail[3];
1278                 $0 = new_val(Tnum, $1);
1279                 if (number_parse($0->val.num, tail, $1.txt) == 0)
1280                         mpq_init($0->val.num);  // UNTESTED
1281                         if (tail[0])
1282                                 tok_err(c, "error: unsupported number suffix",
1283                                         &$1);
1284         } }$
1285         | STRING ${ {
1286                 char tail[3];
1287                 $0 = new_val(Tstr, $1);
1288                 string_parse(&$1, '\\', &$0->val.str, tail);
1289                 if (tail[0])
1290                         tok_err(c, "error: unsupported string suffix",
1291                                 &$1);
1292         } }$
1293         | MULTI_STRING ${ {
1294                 char tail[3];
1295                 $0 = new_val(Tstr, $1);
1296                 string_parse(&$1, '\\', &$0->val.str, tail);
1297                 if (tail[0])
1298                         tok_err(c, "error: unsupported string suffix",
1299                                 &$1);
1300         } }$
1301
1302 ###### print exec cases
1303         case Xval:
1304         {
1305                 struct val *v = cast(val, e);
1306                 if (v->vtype == Tstr)
1307                         printf("\"");
1308                 // FIXME how to ensure numbers have same precision.
1309                 print_value(v->vtype, &v->val, stdout);
1310                 if (v->vtype == Tstr)
1311                         printf("\"");
1312                 break;
1313         }
1314
1315 ###### propagate exec cases
1316         case Xval:
1317         {
1318                 struct val *val = cast(val, prog);
1319                 if (!type_compat(type, val->vtype, rules))
1320                         type_err(c, "error: expected %1 found %2",
1321                                    prog, type, rules, val->vtype);
1322                 *perr |= Erval;
1323                 return val->vtype;
1324         }
1325
1326 ###### interp exec cases
1327         case Xval:
1328                 rvtype = cast(val, e)->vtype;
1329                 dup_value(rvtype, &cast(val, e)->val, &rv);
1330                 break;
1331
1332 ###### ast functions
1333         static void free_val(struct val *v)
1334         {
1335                 if (v)
1336                         free_value(v->vtype, &v->val);
1337                 free(v);
1338         }
1339
1340 ###### free exec cases
1341         case Xval: free_val(cast(val, e)); break;
1342
1343 ###### ast functions
1344         // Move all nodes from 'b' to 'rv', reversing their order.
1345         // In 'b' 'left' is a list, and 'right' is the last node.
1346         // In 'rv', left' is the first node and 'right' is a list.
1347         static struct binode *reorder_bilist(struct binode *b)
1348         {
1349                 struct binode *rv = NULL;
1350
1351                 while (b) {
1352                         struct exec *t = b->right;
1353                         b->right = rv;
1354                         rv = b;
1355                         if (b->left)
1356                                 b = cast(binode, b->left);
1357                         else
1358                                 b = NULL;
1359                         rv->left = t;
1360                 }
1361                 return rv;
1362         }
1363
1364 #### Labels
1365
1366 Labels are a temporary concept until I implement enums.  There are an
1367 anonymous enum which is declared by usage.  Thet are only allowed in
1368 `use` statements and corresponding `case` entries.  They appear as a
1369 period followed by an identifier.  All identifiers that are "used" must
1370 have a "case".
1371
1372 For now, we have a global list of labels, and don't check that all "use"
1373 match "case".
1374
1375 ###### exec type
1376         Xlabel,
1377
1378 ###### ast
1379         struct label {
1380                 struct exec;
1381                 struct text name;
1382                 int value;
1383         };
1384 ###### free exec cases
1385         case Xlabel:
1386                 free(e);
1387                 break;
1388 ###### print exec cases
1389         case Xlabel: {
1390                 struct label *l = cast(label, e);
1391                 printf(".%.*s", l->name.len, l->name.txt);
1392                 break;
1393         }
1394
1395 ###### ast
1396         struct labels {
1397                 struct labels *next;
1398                 struct text name;
1399                 int value;
1400         };
1401 ###### parse context
1402         struct labels *labels;
1403         int next_label;
1404 ###### ast functions
1405         static int label_lookup(struct parse_context *c, struct text name)
1406         {
1407                 struct labels *l, **lp = &c->labels;
1408                 while (*lp && text_cmp((*lp)->name, name) < 0)
1409                         lp = &(*lp)->next;
1410                 if (*lp && text_cmp((*lp)->name, name) == 0)
1411                         return (*lp)->value;
1412                 l = calloc(1, sizeof(*l));
1413                 l->next = *lp;
1414                 l->name = name;
1415                 if (c->next_label == 0)
1416                         c->next_label = 2;
1417                 l->value = c->next_label;
1418                 c->next_label += 1;
1419                 *lp = l;
1420                 return l->value;
1421         }
1422
1423 ###### free context storage
1424         while (context.labels) {
1425                 struct labels *l = context.labels;
1426                 context.labels = l->next;
1427                 free(l);
1428         }
1429
1430 ###### declare terminals
1431         $TERM .
1432 ###### term grammar
1433         | . IDENTIFIER ${ {
1434                 struct label *l = new_pos(label, $ID);
1435                 l->name = $ID.txt;
1436                 $0 = l;
1437         } }$
1438 ###### propagate exec cases
1439         case Xlabel: {
1440                 struct label *l = cast(label, prog);
1441                 l->value = label_lookup(c, l->name);
1442                 if (!type_compat(type, Tlabel, rules))
1443                         type_err(c, "error: expected %1 found %2",
1444                                  prog, type, rules, Tlabel);
1445                 *perr |= Erval;
1446                 return Tlabel;
1447         }
1448 ###### interp exec cases
1449         case Xlabel : {
1450                 struct label *l = cast(label, e);
1451                 rv.label = l->value;
1452                 rvtype = Tlabel;
1453                 break;
1454         }
1455
1456
1457 ### Variables
1458
1459 Variables are scoped named values.  We store the names in a linked list
1460 of "bindings" sorted in lexical order, and use sequential search and
1461 insertion sort.
1462
1463 ###### ast
1464
1465         struct binding {
1466                 struct text name;
1467                 struct binding *next;   // in lexical order
1468                 ## binding fields
1469         };
1470
1471 This linked list is stored in the parse context so that "reduce"
1472 functions can find or add variables, and so the analysis phase can
1473 ensure that every variable gets a type.
1474
1475 ###### parse context
1476
1477         struct binding *varlist;  // In lexical order
1478
1479 ###### ast functions
1480
1481         static struct binding *find_binding(struct parse_context *c, struct text s)
1482         {
1483                 struct binding **l = &c->varlist;
1484                 struct binding *n;
1485                 int cmp = 1;
1486
1487                 while (*l &&
1488                         (cmp = text_cmp((*l)->name, s)) < 0)
1489                                 l = & (*l)->next;
1490                 if (cmp == 0)
1491                         return *l;
1492                 n = calloc(1, sizeof(*n));
1493                 n->name = s;
1494                 n->next = *l;
1495                 *l = n;
1496                 return n;
1497         }
1498
1499 Each name can be linked to multiple variables defined in different
1500 scopes.  Each scope starts where the name is declared and continues
1501 until the end of the containing code block.  Scopes of a given name
1502 cannot nest, so a declaration while a name is in-scope is an error.
1503
1504 ###### binding fields
1505         struct variable *var;
1506
1507 ###### ast
1508         struct variable {
1509                 struct variable *previous;
1510                 struct type *type;
1511                 struct binding *name;
1512                 struct exec *where_decl;// where name was declared
1513                 struct exec *where_set; // where type was set
1514                 ## variable fields
1515         };
1516
1517 When a scope closes, the values of the variables might need to be freed.
1518 This happens in the context of some `struct exec` and each `exec` will
1519 need to know which variables need to be freed when it completes.
1520
1521 ####### exec fields
1522         struct variable *to_free;
1523
1524 ####### variable fields
1525         struct exec *cleanup_exec;
1526         struct variable *next_free;
1527
1528 ####### interp exec cleanup
1529         {
1530                 struct variable *v;
1531                 for (v = e->to_free; v; v = v->next_free) {
1532                         struct value *val = var_value(c, v);
1533                         free_value(v->type, val);
1534                 }
1535         }
1536
1537 ###### ast functions
1538         static void variable_unlink_exec(struct variable *v)
1539         {
1540                 struct variable **vp;
1541                 if (!v->cleanup_exec)
1542                         return;
1543                 for (vp = &v->cleanup_exec->to_free;
1544                     *vp; vp = &(*vp)->next_free) {
1545                         if (*vp != v)
1546                                 continue;
1547                         *vp = v->next_free;
1548                         v->cleanup_exec = NULL;
1549                         break;
1550                 }
1551         }
1552
1553 While the naming seems strange, we include local constants in the
1554 definition of variables.  A name declared `var := value` can
1555 subsequently be changed, but a name declared `var ::= value` cannot -
1556 it is constant
1557
1558 ###### variable fields
1559         int constant;
1560
1561 Scopes in parallel branches can be partially merged.  More
1562 specifically, if a given name is declared in both branches of an
1563 if/else then its scope is a candidate for merging.  Similarly if
1564 every branch of an exhaustive switch (e.g. has an "else" clause)
1565 declares a given name, then the scopes from the branches are
1566 candidates for merging.
1567
1568 Note that names declared inside a loop (which is only parallel to
1569 itself) are never visible after the loop.  Similarly names defined in
1570 scopes which are not parallel, such as those started by `for` and
1571 `switch`, are never visible after the scope.  Only variables defined in
1572 both `then` and `else` (including the implicit then after an `if`, and
1573 excluding `then` used with `for`) and in all `case`s and `else` of a
1574 `switch` or `while` can be visible beyond the `if`/`switch`/`while`.
1575
1576 Labels, which are a bit like variables, follow different rules.
1577 Labels are not explicitly declared, but if an undeclared name appears
1578 in a context where a label is legal, that effectively declares the
1579 name as a label.  The declaration remains in force (or in scope) at
1580 least to the end of the immediately containing block and conditionally
1581 in any larger containing block which does not declare the name in some
1582 other way.  Importantly, the conditional scope extension happens even
1583 if the label is only used in one parallel branch of a conditional --
1584 when used in one branch it is treated as having been declared in all
1585 branches.
1586
1587 Merge candidates are tentatively visible beyond the end of the
1588 branching statement which creates them.  If the name is used, the
1589 merge is affirmed and they become a single variable visible at the
1590 outer layer.  If not - if it is redeclared first - the merge lapses.
1591
1592 To track scopes we have an extra stack, implemented as a linked list,
1593 which roughly parallels the parse stack and which is used exclusively
1594 for scoping.  When a new scope is opened, a new frame is pushed and
1595 the child-count of the parent frame is incremented.  This child-count
1596 is used to distinguish between the first of a set of parallel scopes,
1597 in which declared variables must not be in scope, and subsequent
1598 branches, whether they may already be conditionally scoped.
1599
1600 We need a total ordering of scopes so we can easily compare to variables
1601 to see if they are concurrently in scope.  To achieve this we record a
1602 `scope_count` which is actually a count of both beginnings and endings
1603 of scopes.  Then each variable has a record of the scope count where it
1604 enters scope, and where it leaves.
1605
1606 To push a new frame *before* any code in the frame is parsed, we need a
1607 grammar reduction.  This is most easily achieved with a grammar
1608 element which derives the empty string, and creates the new scope when
1609 it is recognised.  This can be placed, for example, between a keyword
1610 like "if" and the code following it.
1611
1612 ###### ast
1613         struct scope {
1614                 struct scope *parent;
1615                 int child_count;
1616         };
1617
1618 ###### parse context
1619         int scope_depth;
1620         int scope_count;
1621         struct scope *scope_stack;
1622
1623 ###### variable fields
1624         int scope_start, scope_end;
1625
1626 ###### ast functions
1627         static void scope_pop(struct parse_context *c)
1628         {
1629                 struct scope *s = c->scope_stack;
1630
1631                 c->scope_stack = s->parent;
1632                 free(s);
1633                 c->scope_depth -= 1;
1634                 c->scope_count += 1;
1635         }
1636
1637         static void scope_push(struct parse_context *c)
1638         {
1639                 struct scope *s = calloc(1, sizeof(*s));
1640                 if (c->scope_stack)
1641                         c->scope_stack->child_count += 1;
1642                 s->parent = c->scope_stack;
1643                 c->scope_stack = s;
1644                 c->scope_depth += 1;
1645                 c->scope_count += 1;
1646         }
1647
1648 ###### Grammar
1649
1650         $void
1651         OpenScope -> ${ scope_push(c); }$
1652
1653 Each variable records a scope depth and is in one of four states:
1654
1655 - "in scope".  This is the case between the declaration of the
1656   variable and the end of the containing block, and also between
1657   the usage with affirms a merge and the end of that block.
1658
1659   The scope depth is not greater than the current parse context scope
1660   nest depth.  When the block of that depth closes, the state will
1661   change.  To achieve this, all "in scope" variables are linked
1662   together as a stack in nesting order.
1663
1664 - "pending".  The "in scope" block has closed, but other parallel
1665   scopes are still being processed.  So far, every parallel block at
1666   the same level that has closed has declared the name.
1667
1668   The scope depth is the depth of the last parallel block that
1669   enclosed the declaration, and that has closed.
1670
1671 - "conditionally in scope".  The "in scope" block and all parallel
1672   scopes have closed, and no further mention of the name has been seen.
1673   This state includes a secondary nest depth (`min_depth`) which records
1674   the outermost scope seen since the variable became conditionally in
1675   scope.  If a use of the name is found, the variable becomes "in scope"
1676   and that secondary depth becomes the recorded scope depth.  If the
1677   name is declared as a new variable, the old variable becomes "out of
1678   scope" and the recorded scope depth stays unchanged.
1679
1680 - "out of scope".  The variable is neither in scope nor conditionally
1681   in scope.  It is permanently out of scope now and can be removed from
1682   the "in scope" stack.  When a variable becomes out-of-scope it is
1683   moved to a separate list (`out_scope`) of variables which have fully
1684   known scope.  This will be used at the end of each function to assign
1685   each variable a place in the stack frame.
1686
1687 ###### variable fields
1688         int depth, min_depth;
1689         enum { OutScope, PendingScope, CondScope, InScope } scope;
1690         struct variable *in_scope;
1691
1692 ###### parse context
1693
1694         struct variable *in_scope;
1695         struct variable *out_scope;
1696
1697 All variables with the same name are linked together using the
1698 'previous' link.  Those variable that have been affirmatively merged all
1699 have a 'merged' pointer that points to one primary variable - the most
1700 recently declared instance.  When merging variables, we need to also
1701 adjust the 'merged' pointer on any other variables that had previously
1702 been merged with the one that will no longer be primary.
1703
1704 A variable that is no longer the most recent instance of a name may
1705 still have "pending" scope, if it might still be merged with most
1706 recent instance.  These variables don't really belong in the
1707 "in_scope" list, but are not immediately removed when a new instance
1708 is found.  Instead, they are detected and ignored when considering the
1709 list of in_scope names.
1710
1711 The storage of the value of a variable will be described later.  For now
1712 we just need to know that when a variable goes out of scope, it might
1713 need to be freed.  For this we need to be able to find it, so assume that
1714 `var_value()` will provide that.
1715
1716 ###### variable fields
1717         struct variable *merged;
1718
1719 ###### ast functions
1720
1721         static void variable_merge(struct variable *primary, struct variable *secondary)
1722         {
1723                 struct variable *v;
1724
1725                 primary = primary->merged;
1726
1727                 for (v = primary->previous; v; v=v->previous)
1728                         if (v == secondary || v == secondary->merged ||
1729                             v->merged == secondary ||
1730                             v->merged == secondary->merged) {
1731                                 v->scope = OutScope;
1732                                 v->merged = primary;
1733                                 if (v->scope_start < primary->scope_start)
1734                                         primary->scope_start = v->scope_start;
1735                                 if (v->scope_end > primary->scope_end)
1736                                         primary->scope_end = v->scope_end;      // NOTEST
1737                                 variable_unlink_exec(v);
1738                         }
1739         }
1740
1741 ###### forward decls
1742         static struct value *var_value(struct parse_context *c, struct variable *v);
1743
1744 ###### free global vars
1745
1746         while (context.varlist) {
1747                 struct binding *b = context.varlist;
1748                 struct variable *v = b->var;
1749                 context.varlist = b->next;
1750                 free(b);
1751                 while (v) {
1752                         struct variable *next = v->previous;
1753
1754                         if (v->global && v->frame_pos >= 0) {
1755                                 free_value(v->type, var_value(&context, v));
1756                                 if (v->depth == 0 && v->type->free == function_free)
1757                                         // This is a function constant
1758                                         free_exec(v->where_decl);
1759                         }
1760                         free(v);
1761                         v = next;
1762                 }
1763         }
1764
1765 #### Manipulating Bindings
1766
1767 When a name is conditionally visible, a new declaration discards the old
1768 binding - the condition lapses.  Similarly when we reach the end of a
1769 function (outermost non-global scope) any conditional scope must lapse.
1770 Conversely a usage of the name affirms the visibility and extends it to
1771 the end of the containing block - i.e.  the block that contains both the
1772 original declaration and the latest usage.  This is determined from
1773 `min_depth`.  When a conditionally visible variable gets affirmed like
1774 this, it is also merged with other conditionally visible variables with
1775 the same name.
1776
1777 When we parse a variable declaration we either report an error if the
1778 name is currently bound, or create a new variable at the current nest
1779 depth if the name is unbound or bound to a conditionally scoped or
1780 pending-scope variable.  If the previous variable was conditionally
1781 scoped, it and its homonyms becomes out-of-scope.
1782
1783 When we parse a variable reference (including non-declarative assignment
1784 "foo = bar") we report an error if the name is not bound or is bound to
1785 a pending-scope variable; update the scope if the name is bound to a
1786 conditionally scoped variable; or just proceed normally if the named
1787 variable is in scope.
1788
1789 When we exit a scope, any variables bound at this level are either
1790 marked out of scope or pending-scoped, depending on whether the scope
1791 was sequential or parallel.  Here a "parallel" scope means the "then"
1792 or "else" part of a conditional, or any "case" or "else" branch of a
1793 switch.  Other scopes are "sequential".
1794
1795 When exiting a parallel scope we check if there are any variables that
1796 were previously pending and are still visible. If there are, then
1797 they weren't redeclared in the most recent scope, so they cannot be
1798 merged and must become out-of-scope.  If it is not the first of
1799 parallel scopes (based on `child_count`), we check that there was a
1800 previous binding that is still pending-scope.  If there isn't, the new
1801 variable must now be out-of-scope.
1802
1803 When exiting a sequential scope that immediately enclosed parallel
1804 scopes, we need to resolve any pending-scope variables.  If there was
1805 no `else` clause, and we cannot determine that the `switch` was exhaustive,
1806 we need to mark all pending-scope variable as out-of-scope.  Otherwise
1807 all pending-scope variables become conditionally scoped.
1808
1809 ###### ast
1810         enum closetype { CloseSequential, CloseFunction, CloseParallel, CloseElse };
1811
1812 ###### ast functions
1813
1814         static struct variable *var_decl(struct parse_context *c, struct text s)
1815         {
1816                 struct binding *b = find_binding(c, s);
1817                 struct variable *v = b->var;
1818
1819                 switch (v ? v->scope : OutScope) {
1820                 case InScope:
1821                         /* Caller will report the error */
1822                         return NULL;
1823                 case CondScope:
1824                         for (;
1825                              v && v->scope == CondScope;
1826                              v = v->previous)
1827                                 v->scope = OutScope;
1828                         break;
1829                 default: break;
1830                 }
1831                 v = calloc(1, sizeof(*v));
1832                 v->previous = b->var;
1833                 b->var = v;
1834                 v->name = b;
1835                 v->merged = v;
1836                 v->min_depth = v->depth = c->scope_depth;
1837                 v->scope = InScope;
1838                 v->in_scope = c->in_scope;
1839                 v->scope_start = c->scope_count;
1840                 c->in_scope = v;
1841                 ## variable init
1842                 return v;
1843         }
1844
1845         static struct variable *var_ref(struct parse_context *c, struct text s)
1846         {
1847                 struct binding *b = find_binding(c, s);
1848                 struct variable *v = b->var;
1849                 struct variable *v2;
1850
1851                 switch (v ? v->scope : OutScope) {
1852                 case OutScope:
1853                 case PendingScope:
1854                         /* Caller will report the error */
1855                         return NULL;
1856                 case CondScope:
1857                         /* All CondScope variables of this name need to be merged
1858                          * and become InScope
1859                          */
1860                         v->depth = v->min_depth;
1861                         v->scope = InScope;
1862                         for (v2 = v->previous;
1863                              v2 && v2->scope == CondScope;
1864                              v2 = v2->previous)
1865                                 variable_merge(v, v2);
1866                         break;
1867                 case InScope:
1868                         break;
1869                 }
1870                 return v;
1871         }
1872
1873         static int var_refile(struct parse_context *c, struct variable *v)
1874         {
1875                 /* Variable just went out of scope.  Add it to the out_scope
1876                  * list, sorted by ->scope_start
1877                  */
1878                 struct variable **vp = &c->out_scope;
1879                 while ((*vp) && (*vp)->scope_start < v->scope_start)
1880                         vp = &(*vp)->in_scope;
1881                 v->in_scope = *vp;
1882                 *vp = v;
1883                 return 0;
1884         }
1885
1886         static void var_block_close(struct parse_context *c, enum closetype ct,
1887                                     struct exec *e)
1888         {
1889                 /* Close off all variables that are in_scope.
1890                  * Some variables in c->scope may already be not-in-scope,
1891                  * such as when a PendingScope variable is hidden by a new
1892                  * variable with the same name.
1893                  * So we check for v->name->var != v and drop them.
1894                  * If we choose to make a variable OutScope, we drop it
1895                  * immediately too.
1896                  */
1897                 struct variable *v, **vp, *v2;
1898
1899                 scope_pop(c);
1900                 for (vp = &c->in_scope;
1901                      (v = *vp) && v->min_depth > c->scope_depth;
1902                      (v->scope == OutScope || v->name->var != v)
1903                      ? (*vp =  v->in_scope, var_refile(c, v))
1904                      : ( vp = &v->in_scope, 0)) {
1905                         v->min_depth = c->scope_depth;
1906                         if (v->name->var != v)
1907                                 /* This is still in scope, but we haven't just
1908                                  * closed the scope.
1909                                  */
1910                                 continue;
1911                         v->min_depth = c->scope_depth;
1912                         if (v->scope == InScope)
1913                                 v->scope_end = c->scope_count;
1914                         if (v->scope == InScope && e && !v->global) {
1915                                 /* This variable gets cleaned up when 'e' finishes */
1916                                 variable_unlink_exec(v);
1917                                 v->cleanup_exec = e;
1918                                 v->next_free = e->to_free;
1919                                 e->to_free = v;
1920                         }
1921                         switch (ct) {
1922                         case CloseElse:
1923                         case CloseParallel: /* handle PendingScope */
1924                                 switch(v->scope) {
1925                                 case InScope:
1926                                 case CondScope:
1927                                         if (c->scope_stack->child_count == 1)
1928                                                 /* first among parallel branches */
1929                                                 v->scope = PendingScope;
1930                                         else if (v->previous &&
1931                                                  v->previous->scope == PendingScope)
1932                                                 /* all previous branches used name */
1933                                                 v->scope = PendingScope;
1934                                         else
1935                                                 v->scope = OutScope;
1936                                         if (ct == CloseElse) {
1937                                                 /* All Pending variables with this name
1938                                                  * are now Conditional */
1939                                                 for (v2 = v;
1940                                                      v2 && v2->scope == PendingScope;
1941                                                      v2 = v2->previous)
1942                                                         v2->scope = CondScope;
1943                                         }
1944                                         break;
1945                                 case PendingScope:
1946                                         /* Not possible as it would require
1947                                          * parallel scope to be nested immediately
1948                                          * in a parallel scope, and that never
1949                                          * happens.
1950                                          */                     // NOTEST
1951                                 case OutScope:
1952                                         /* Not possible as we already tested for
1953                                          * OutScope
1954                                          */
1955                                         abort();                // NOTEST
1956                                 }
1957                                 break;
1958                         case CloseFunction:
1959                                 if (v->scope == CondScope)
1960                                         /* Condition cannot continue past end of function */
1961                                         v->scope = InScope;
1962                                 /* fallthrough */
1963                         case CloseSequential:
1964                                 switch (v->scope) {
1965                                 case InScope:
1966                                         v->scope = OutScope;
1967                                         break;
1968                                 case PendingScope:
1969                                         /* There was no 'else', so we can only become
1970                                          * conditional if we know the cases were exhaustive,
1971                                          * and that doesn't mean anything yet.
1972                                          * So only labels become conditional..
1973                                          */
1974                                         for (v2 = v;
1975                                              v2 && v2->scope == PendingScope;
1976                                              v2 = v2->previous)
1977                                                 v2->scope = OutScope;
1978                                         break;
1979                                 case CondScope:
1980                                 case OutScope: break;
1981                                 }
1982                                 break;
1983                         }
1984                 }
1985         }
1986
1987 #### Storing Values
1988
1989 The value of a variable is store separately from the variable, on an
1990 analogue of a stack frame.  There are (currently) two frames that can be
1991 active.  A global frame which currently only stores constants, and a
1992 stacked frame which stores local variables.  Each variable knows if it
1993 is global or not, and what its index into the frame is.
1994
1995 Values in the global frame are known immediately they are relevant, so
1996 the frame needs to be reallocated as it grows so it can store those
1997 values.  The local frame doesn't get values until the interpreted phase
1998 is started, so there is no need to allocate until the size is known.
1999
2000 We initialize the `frame_pos` to an impossible value, so that we can
2001 tell if it was set or not later.
2002
2003 ###### variable fields
2004         short frame_pos;
2005         short global;
2006
2007 ###### variable init
2008         v->frame_pos = -1;
2009
2010 ###### parse context
2011
2012         short global_size, global_alloc;
2013         short local_size;
2014         void *global, *local;
2015
2016 ###### forward decls
2017         static struct value *global_alloc(struct parse_context *c, struct type *t,
2018                                           struct variable *v, struct value *init);
2019
2020 ###### ast functions
2021
2022         static struct value *var_value(struct parse_context *c, struct variable *v)
2023         {
2024                 if (!v->global) {
2025                         if (!c->local || !v->type)
2026                                 return NULL;    // UNTESTED
2027                         if (v->frame_pos + v->type->size > c->local_size) {
2028                                 printf("INVALID frame_pos\n");  // NOTEST
2029                                 exit(2);                        // NOTEST
2030                         }
2031                         return c->local + v->frame_pos;
2032                 }
2033                 if (c->global_size > c->global_alloc) {
2034                         int old = c->global_alloc;
2035                         c->global_alloc = (c->global_size | 1023) + 1024;
2036                         c->global = realloc(c->global, c->global_alloc);
2037                         memset(c->global + old, 0, c->global_alloc - old);
2038                 }
2039                 return c->global + v->frame_pos;
2040         }
2041
2042         static struct value *global_alloc(struct parse_context *c, struct type *t,
2043                                           struct variable *v, struct value *init)
2044         {
2045                 struct value *ret;
2046                 struct variable scratch;
2047
2048                 if (t->prepare_type)
2049                         t->prepare_type(c, t, 1);       // NOTEST
2050
2051                 if (c->global_size & (t->align - 1))
2052                         c->global_size = (c->global_size + t->align) & ~(t->align-1);   // NOTEST
2053                 if (!v) {
2054                         v = &scratch;
2055                         v->type = t;
2056                 }
2057                 v->frame_pos = c->global_size;
2058                 v->global = 1;
2059                 c->global_size += v->type->size;
2060                 ret = var_value(c, v);
2061                 if (init)
2062                         memcpy(ret, init, t->size);
2063                 else
2064                         val_init(t, ret);       // NOTEST
2065                 return ret;
2066         }
2067
2068 As global values are found -- struct field initializers, labels etc --
2069 `global_alloc()` is called to record the value in the global frame.
2070
2071 When the program is fully parsed, each function is analysed, we need to
2072 walk the list of variables local to that function and assign them an
2073 offset in the stack frame.  For this we have `scope_finalize()`.
2074
2075 We keep the stack from dense by re-using space for between variables
2076 that are not in scope at the same time.  The `out_scope` list is sorted
2077 by `scope_start` and as we process a varible, we move it to an FIFO
2078 stack.  For each variable we consider, we first discard any from the
2079 stack anything that went out of scope before the new variable came in.
2080 Then we place the new variable just after the one at the top of the
2081 stack.
2082
2083 ###### ast functions
2084
2085         static void scope_finalize(struct parse_context *c, struct type *ft)
2086         {
2087                 int size = ft->function.local_size;
2088                 struct variable *next = ft->function.scope;
2089                 struct variable *done = NULL;
2090
2091                 while (next) {
2092                         struct variable *v = next;
2093                         struct type *t = v->type;
2094                         int pos;
2095                         next = v->in_scope;
2096                         if (v->merged != v)
2097                                 continue;
2098                         if (!t)
2099                                 continue;
2100                         if (v->frame_pos >= 0)
2101                                 continue;
2102                         while (done && done->scope_end < v->scope_start)
2103                                 done = done->in_scope;
2104                         if (done)
2105                                 pos = done->frame_pos + done->type->size;
2106                         else
2107                                 pos = ft->function.local_size;
2108                         if (pos & (t->align - 1))
2109                                 pos = (pos + t->align) & ~(t->align-1);
2110                         v->frame_pos = pos;
2111                         if (size < pos + v->type->size)
2112                                 size = pos + v->type->size;
2113                         v->in_scope = done;
2114                         done = v;
2115                 }
2116                 c->out_scope = NULL;
2117                 ft->function.local_size = size;
2118         }
2119
2120 ###### free context storage
2121         free(context.global);
2122
2123 #### Variables as executables
2124
2125 Just as we used a `val` to wrap a value into an `exec`, we similarly
2126 need a `var` to wrap a `variable` into an exec.  While each `val`
2127 contained a copy of the value, each `var` holds a link to the variable
2128 because it really is the same variable no matter where it appears.
2129 When a variable is used, we need to remember to follow the `->merged`
2130 link to find the primary instance.
2131
2132 When a variable is declared, it may or may not be given an explicit
2133 type.  We need to record which so that we can report the parsed code
2134 correctly.
2135
2136 ###### exec type
2137         Xvar,
2138
2139 ###### ast
2140         struct var {
2141                 struct exec;
2142                 struct variable *var;
2143         };
2144
2145 ###### variable fields
2146         int explicit_type;
2147
2148 ###### Grammar
2149
2150         $TERM : ::
2151
2152         $*var
2153         VariableDecl -> IDENTIFIER : ${ {
2154                 struct variable *v = var_decl(c, $1.txt);
2155                 $0 = new_pos(var, $1);
2156                 $0->var = v;
2157                 if (v)
2158                         v->where_decl = $0;
2159                 else {
2160                         v = var_ref(c, $1.txt);
2161                         $0->var = v;
2162                         type_err(c, "error: variable '%v' redeclared",
2163                                  $0, NULL, 0, NULL);
2164                         type_err(c, "info: this is where '%v' was first declared",
2165                                  v->where_decl, NULL, 0, NULL);
2166                 }
2167         } }$
2168         | IDENTIFIER :: ${ {
2169                 struct variable *v = var_decl(c, $1.txt);
2170                 $0 = new_pos(var, $1);
2171                 $0->var = v;
2172                 if (v) {
2173                         v->where_decl = $0;
2174                         v->constant = 1;
2175                 } else {
2176                         v = var_ref(c, $1.txt);
2177                         $0->var = v;
2178                         type_err(c, "error: variable '%v' redeclared",
2179                                  $0, NULL, 0, NULL);
2180                         type_err(c, "info: this is where '%v' was first declared",
2181                                  v->where_decl, NULL, 0, NULL);
2182                 }
2183         } }$
2184         | IDENTIFIER : Type ${ {
2185                 struct variable *v = var_decl(c, $1.txt);
2186                 $0 = new_pos(var, $1);
2187                 $0->var = v;
2188                 if (v) {
2189                         v->where_decl = $0;
2190                         v->where_set = $0;
2191                         v->type = $<Type;
2192                         v->explicit_type = 1;
2193                 } else {
2194                         v = var_ref(c, $1.txt);
2195                         $0->var = v;
2196                         type_err(c, "error: variable '%v' redeclared",
2197                                  $0, NULL, 0, NULL);
2198                         type_err(c, "info: this is where '%v' was first declared",
2199                                  v->where_decl, NULL, 0, NULL);
2200                 }
2201         } }$
2202         | IDENTIFIER :: Type ${ {
2203                 struct variable *v = var_decl(c, $1.txt);
2204                 $0 = new_pos(var, $1);
2205                 $0->var = v;
2206                 if (v) {
2207                         v->where_decl = $0;
2208                         v->where_set = $0;
2209                         v->type = $<Type;
2210                         v->constant = 1;
2211                         v->explicit_type = 1;
2212                 } else {
2213                         v = var_ref(c, $1.txt);
2214                         $0->var = v;
2215                         type_err(c, "error: variable '%v' redeclared",
2216                                  $0, NULL, 0, NULL);
2217                         type_err(c, "info: this is where '%v' was first declared",
2218                                  v->where_decl, NULL, 0, NULL);
2219                 }
2220         } }$
2221
2222         $*exec
2223         Variable -> IDENTIFIER ${ {
2224                 struct variable *v = var_ref(c, $1.txt);
2225                 $0 = new_pos(var, $1);
2226                 if (v == NULL) {
2227                         /* This might be a global const or a label
2228                          * Allocate a var with impossible type Tnone,
2229                          * which will be adjusted when we find out what it is,
2230                          * or will trigger an error.
2231                          */
2232                         v = var_decl(c, $1.txt);
2233                         if (v) {
2234                                 v->type = Tnone;
2235                                 v->where_decl = $0;
2236                                 v->where_set = $0;
2237                         }
2238                 }
2239                 cast(var, $0)->var = v;
2240         } }$
2241
2242 ###### print exec cases
2243         case Xvar:
2244         {
2245                 struct var *v = cast(var, e);
2246                 if (v->var) {
2247                         struct binding *b = v->var->name;
2248                         printf("%.*s", b->name.len, b->name.txt);
2249                 }
2250                 break;
2251         }
2252
2253 ###### format cases
2254         case 'v':
2255                 if (loc && loc->type == Xvar) {
2256                         struct var *v = cast(var, loc);
2257                         if (v->var) {
2258                                 struct binding *b = v->var->name;
2259                                 fprintf(stderr, "%.*s", b->name.len, b->name.txt);
2260                         } else
2261                                 fputs("???", stderr);   // NOTEST
2262                 } else
2263                         fputs("NOTVAR", stderr);        // NOTEST
2264                 break;
2265
2266 ###### propagate exec cases
2267
2268         case Xvar:
2269         {
2270                 struct var *var = cast(var, prog);
2271                 struct variable *v = var->var;
2272                 if (!v) {
2273                         type_err(c, "%d:BUG: no variable!!", prog, NULL, 0, NULL); // NOTEST
2274                         return Tnone;                                   // NOTEST
2275                 }
2276                 v = v->merged;
2277                 if (v->type == Tnone && v->where_decl == prog)
2278                         type_err(c, "error: variable used but not declared: %v",
2279                                  prog, NULL, 0, NULL);
2280                 if (v->type == NULL) {
2281                         if (type && !(*perr & Efail)) {
2282                                 v->type = type;
2283                                 v->where_set = prog;
2284                                 *perr |= Eretry;
2285                         }
2286                 } else if (!type_compat(type, v->type, rules)) {
2287                         type_err(c, "error: expected %1 but variable '%v' is %2", prog,
2288                                  type, rules, v->type);
2289                         type_err(c, "info: this is where '%v' was set to %1", v->where_set,
2290                                  v->type, rules, NULL);
2291                 }
2292                 if (!v->global || v->frame_pos < 0)
2293                         *perr |= Eruntime;
2294                 if (v->constant)
2295                         *perr |= Econst;
2296                 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;       // UNTESTED
2402                 if (type->array.unspec && parse_time)
2403                         return 1;       // UNTESTED
2404                 if (parse_time && type->array.vsize && !type->array.vsize->global)
2405                         return 1;       // UNTESTED
2406
2407                 if (type->array.vsize) {
2408                         vsize = var_value(c, type->array.vsize);
2409                         if (!vsize)
2410                                 return 1;       // UNTESTED
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;       // UNTESTED
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;       // UNTESTED
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;       // UNTESTED
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                 $SFL->prev = $<FL;
2974                 $0 = $<SFL;
2975         }$
2976
2977         SimpleFieldList -> Field ${ $0 = $<F; }$
2978         | SimpleFieldList ; Field ${
2979                 $F->prev = $<SFL;
2980                 $0 = $<F;
2981         }$
2982         | SimpleFieldList ; ${
2983                 $0 = $<SFL;
2984         }$
2985         | ERROR ${ tok_err(c, "Syntax error in struct field", &$1); }$
2986
2987         Field -> IDENTIFIER : Type = Expression ${ {
2988                 $0 = calloc(1, sizeof(struct fieldlist));
2989                 $0->f.name = $ID.txt;
2990                 $0->f.type = $<Type;
2991                 $0->f.init = NULL;
2992                 $0->init = $<Expr;
2993         } }$
2994         | IDENTIFIER : Type ${
2995                 $0 = calloc(1, sizeof(struct fieldlist));
2996                 $0->f.name = $ID.txt;
2997                 $0->f.type = $<Type;
2998         }$
2999
3000 ###### forward decls
3001         static void structure_print_type(struct type *t, FILE *f);
3002
3003 ###### value functions
3004         static void structure_print_type(struct type *t, FILE *f)
3005         {
3006                 int i;
3007
3008                 fprintf(f, "struct %.*s\n", t->name.len, t->name.txt);
3009
3010                 for (i = 0; i < t->structure.nfields; i++) {
3011                         struct field *fl = t->structure.fields + i;
3012                         fprintf(f, "    %.*s : ", fl->name.len, fl->name.txt);
3013                         type_print(fl->type, f);
3014                         if (fl->type->print && fl->init) {
3015                                 fprintf(f, " = ");
3016                                 if (fl->type == Tstr)
3017                                         fprintf(f, "\"");       // UNTESTED
3018                                 print_value(fl->type, fl->init, f);
3019                                 if (fl->type == Tstr)
3020                                         fprintf(f, "\"");       // UNTESTED
3021                         }
3022                         fprintf(f, "\n");
3023                 }
3024         }
3025
3026 ###### print type decls
3027         {
3028                 struct type *t;
3029                 int target = -1;
3030
3031                 while (target != 0) {
3032                         int i = 0;
3033                         for (t = context.typelist; t ; t=t->next)
3034                                 if (!t->anon && t->print_type_decl &&
3035                                     !t->check_args) {
3036                                         i += 1;
3037                                         if (i == target)
3038                                                 break;
3039                                 }
3040
3041                         if (target == -1) {
3042                                 target = i;
3043                         } else {
3044                                 t->print_type_decl(t, stdout);
3045                                 target -= 1;
3046                         }
3047                 }
3048         }
3049
3050 #### References
3051
3052 References, or pointers, are values that refer to another value.  They
3053 can only refer to a `struct`, though as a struct can embed anything they
3054 can effectively refer to anything.
3055
3056 References are potentially dangerous as they might refer to some
3057 variable which no longer exists - either because a stack frame
3058 containing it has been discarded or because the value was allocated on
3059 the heap and has now been free.  Ocean does not yet provide any
3060 protection against these problems.  It will in due course.
3061
3062 With references comes the opportunity and the need to explicitly
3063 allocate values on the "heap" and to free them.  We currently provide
3064 fairly basic support for this.
3065
3066 Reference make use of the `@` symbol in various ways.  A type that starts
3067 with `@` is a reference to whatever follows.  A reference value
3068 followed by an `@` acts as the referred value, though the `@` is often
3069 not needed.  Finally, an expression that starts with `@` is a special
3070 reference related expression.  Some examples might help.
3071
3072 ##### Example: Reference examples
3073
3074         struct foo
3075                 a: number
3076                 b: string
3077         ref: @foo
3078         bar: foo
3079         bar.number = 23; bar.string = "hello"
3080         baz: foo
3081         ref = bar
3082         baz = @ref
3083         baz.a = ref.a * 2
3084
3085         ref = @new()
3086         ref@ = baz
3087         @free = ref
3088         ref = @nil
3089
3090 Obviously this is very contrived.  `ref` is a reference to a `foo` which
3091 is initially set to refer to the value stored in `bar` - no extra syntax
3092 is needed to "Take the address of" `bar` - the fact that `ref` is a
3093 reference means that only the address make sense.
3094
3095 When `ref.a` is accessed, that is whatever value is stored in `bar.a`.
3096 The same syntax is used for accessing fields both in structs and in
3097 references to structs.  It would be correct to use `ref@.a`, but not
3098 necessary.
3099
3100 `@new()` creates an object of whatever type is needed for the program
3101 to by type-correct.  In future iterations of Ocean, arguments a
3102 constructor will access arguments, so the the syntax now looks like a
3103 function call.  `@free` can be assigned any reference that was returned
3104 by `@new()`, and it will be freed.  `@nil` is a value of whatever
3105 reference type is appropriate, and is stable and never the address of
3106 anything in the heap or on the stack.  A reference can be assigned
3107 `@nil` or compared against that value.
3108
3109 ###### declare terminals
3110         $TERM @
3111
3112 ###### type union fields
3113
3114         struct {
3115                 struct type *referent;
3116         } reference;
3117
3118 ###### value union fields
3119         struct value *ref;
3120
3121 ###### value functions
3122
3123         static void reference_print_type(struct type *t, FILE *f)
3124         {
3125                 fprintf(f, "@");
3126                 type_print(t->reference.referent, f);
3127         }
3128
3129         static int reference_cmp(struct type *tl, struct type *tr,
3130                                  struct value *left, struct value *right)
3131         {
3132                 return left->ref == right->ref ? 0 : 1;
3133         }
3134
3135         static void reference_dup(struct type *t,
3136                                   struct value *vold, struct value *vnew)
3137         {
3138                 vnew->ref = vold->ref;
3139         }
3140
3141         static void reference_free(struct type *t, struct value *v)
3142         {
3143                 /* Nothing to do here */
3144         }
3145
3146         static int reference_compat(struct type *require, struct type *have,
3147                                     enum val_rules rules)
3148         {
3149                 if (rules & Rrefok)
3150                         if (require->reference.referent == have)
3151                                 return 1;
3152                 if (have->compat != require->compat)
3153                         return 0;
3154                 if (have->reference.referent != require->reference.referent)
3155                         return 0;
3156                 return 1;
3157         }
3158
3159         static int reference_test(struct type *type, struct value *val)
3160         {
3161                 return val->ref != NULL;
3162         }
3163
3164         static struct type *reference_fieldref(struct type *t, struct parse_context *c,
3165                                                struct fieldref *f, struct value **vp)
3166         {
3167                 struct type *rt = t->reference.referent;
3168
3169                 if (rt->fieldref) {
3170                         if (vp)
3171                                 *vp = (*vp)->ref;
3172                         return rt->fieldref(rt, c, f, vp);
3173                 }
3174                 type_err(c, "error: field reference on %1 is not supported",
3175                                  f->left, rt, 0, NULL);
3176                 return Tnone;
3177         }
3178
3179         static struct type reference_prototype = {
3180                 .print_type = reference_print_type,
3181                 .cmp_eq = reference_cmp,
3182                 .dup = reference_dup,
3183                 .test = reference_test,
3184                 .free = reference_free,
3185                 .compat = reference_compat,
3186                 .fieldref = reference_fieldref,
3187                 .size = sizeof(void*),
3188                 .align = sizeof(void*),
3189         };
3190
3191 ###### type grammar
3192
3193         | @ IDENTIFIER ${ {
3194                 struct type *t = find_type(c, $ID.txt);
3195                 if (!t) {
3196                         t = add_type(c, $ID.txt, NULL);
3197                         t->first_use = $ID;
3198                 }
3199                 $0 = find_anon_type(c, &reference_prototype, "@%.*s",
3200                                     $ID.txt.len, $ID.txt.txt);
3201                 $0->reference.referent = t;
3202         } }$
3203
3204 ###### core functions
3205         static int text_is(struct text t, char *s)
3206         {
3207                 return (strlen(s) == t.len &&
3208                         strncmp(s, t.txt, t.len) == 0);
3209         }
3210
3211 ###### exec type
3212         Xref,
3213
3214 ###### ast
3215         struct ref {
3216                 struct exec;
3217                 enum ref_func { RefNew, RefFree, RefNil } action;
3218                 struct type *reftype;
3219                 struct exec *right;
3220         };
3221
3222 ###### SimpleStatement Grammar
3223
3224         | @ IDENTIFIER = Expression ${ {
3225                 struct ref *r = new_pos(ref, $ID);
3226                 // Must be "free"
3227                 if (!text_is($ID.txt, "free"))
3228                         tok_err(c, "error: only \"@free\" makes sense here",
3229                                 &$ID);
3230
3231                 $0 = r;
3232                 r->action = RefFree;
3233                 r->right = $<Exp;
3234         } }$
3235
3236 ###### expression grammar
3237         | @ IDENTIFIER ( ) ${
3238                 // Only 'new' valid here
3239                 if (!text_is($ID.txt, "new")) {
3240                         tok_err(c, "error: Only reference function is \"@new()\"",
3241                                 &$ID);
3242                 } else {
3243                         struct ref *r = new_pos(ref,$ID);
3244                         $0 = r;
3245                         r->action = RefNew;
3246                 }
3247         }$
3248         | @ IDENTIFIER ${
3249                 // Only 'nil' valid here
3250                 if (!text_is($ID.txt, "nil")) {
3251                         tok_err(c, "error: Only reference value is \"@nil\"",
3252                                 &$ID);
3253                 } else {
3254                         struct ref *r = new_pos(ref,$ID);
3255                         $0 = r;
3256                         r->action = RefNil;
3257                 }
3258         }$
3259
3260 ###### print exec cases
3261         case Xref: {
3262                 struct ref *r = cast(ref, e);
3263                 switch (r->action) {
3264                 case RefNew:
3265                         printf("@new()"); break;
3266                 case RefNil:
3267                         printf("@nil"); break;
3268                 case RefFree:
3269                         do_indent(indent, "@free = ");
3270                         print_exec(r->right, indent, bracket);
3271                         break;
3272                 }
3273                 break;
3274         }
3275
3276 ###### propagate exec cases
3277         case Xref: {
3278                 struct ref *r = cast(ref, prog);
3279                 switch (r->action) {
3280                 case RefNew:
3281                         if (type && type->free != reference_free) {
3282                                 type_err(c, "error: @new() can only be used with references, not %1",
3283                                          prog, type, 0, NULL);
3284                                 return NULL;
3285                         }
3286                         if (type && !r->reftype) {
3287                                 r->reftype = type;
3288                                 *perr |= Eretry;
3289                         }
3290                         *perr |= Erval;
3291                         return type;
3292                 case RefNil:
3293                         if (type && type->free != reference_free)
3294                                 type_err(c, "error: @nil can only be used with reference, not %1",
3295                                          prog, type, 0, NULL);
3296                         if (type && !r->reftype) {
3297                                 r->reftype = type;
3298                                 *perr |= Eretry;
3299                         }
3300                         *perr |= Erval;
3301                         return type;
3302                 case RefFree:
3303                         t = propagate_types(r->right, c, perr_local, NULL, 0);
3304                         if (t && t->free != reference_free)
3305                                 type_err(c, "error: @free can only be assigned a reference, not %1",
3306                                          prog, t, 0, NULL);
3307                         r->reftype = Tnone;
3308                         return Tnone;
3309                 }
3310                 break;  // NOTEST
3311         }
3312
3313
3314 ###### interp exec cases
3315         case Xref: {
3316                 struct ref *r = cast(ref, e);
3317                 switch (r->action) {
3318                 case RefNew:
3319                         if (r->reftype)
3320                                 rv.ref = calloc(1, r->reftype->reference.referent->size);
3321                         rvtype = r->reftype;
3322                         break;
3323                 case RefNil:
3324                         rv.ref = NULL;
3325                         rvtype = r->reftype;
3326                         break;
3327                 case RefFree:
3328                         rv = interp_exec(c, r->right, &rvtype);
3329                         free_value(rvtype->reference.referent, rv.ref);
3330                         free(rv.ref);
3331                         rvtype = Tnone;
3332                         break;
3333                 }
3334                 break;
3335         }
3336
3337 ###### free exec cases
3338         case Xref: {
3339                 struct ref *r = cast(ref, e);
3340                 free_exec(r->right);
3341                 free(r);
3342                 break;
3343         }
3344
3345 ###### Expressions: dereference
3346
3347 ###### Binode types
3348         Deref, AddressOf,
3349
3350 ###### term grammar
3351
3352         | Term @ ${ {
3353                 struct binode *b = new(binode);
3354                 b->op = Deref;
3355                 b->left = $<Trm;
3356                 $0 = b;
3357         } }$
3358
3359 ###### print binode cases
3360         case Deref:
3361                 print_exec(b->left, -1, bracket);
3362                 printf("@");
3363                 break;
3364         case AddressOf:
3365                 print_exec(b->left, -1, bracket);
3366                 break;
3367
3368 ###### propagate binode cases
3369         case Deref:
3370                 /* left must be a reference, and we return what it refers to */
3371                 /* FIXME how can I pass the expected type down? */
3372                 t = propagate_types(b->left, c, perr, NULL, 0);
3373                 *perr &= ~Erval;
3374                 if (!t || t->free != reference_free)
3375                         type_err(c, "error: Cannot dereference %1", b, t, 0, NULL);
3376                 else
3377                         return t->reference.referent;
3378                 break;
3379
3380         case AddressOf:
3381                 /* left must be lval, we create reference to it */
3382                 if (!type || type->free != reference_free)
3383                         t = propagate_types(b->left, c, perr, type, 0); // UNTESTED
3384                 else
3385                         t = propagate_types(b->left, c, perr,
3386                                             type->reference.referent, 0);
3387                 if (t)
3388                         t = find_anon_type(c, &reference_prototype, "@%.*s",
3389                                         t->name.len, t->name.txt);
3390                 return t;
3391
3392 ###### interp binode cases
3393         case Deref:
3394                 left = interp_exec(c, b->left, &ltype);
3395                 lrv = left.ref;
3396                 rvtype = ltype->reference.referent;
3397                 break;
3398
3399         case AddressOf:
3400                 rv.ref = linterp_exec(c, b->left, &rvtype);
3401                 rvtype = find_anon_type(c, &reference_prototype, "@%.*s",
3402                                         rvtype->name.len, rvtype->name.txt);
3403                 break;
3404
3405
3406 #### Functions
3407
3408 A function is a chunk of code which can be passed parameters and can
3409 return results.  Each function has a type which includes the set of
3410 parameters and the return value.  As yet these types cannot be declared
3411 separately from the function itself.
3412
3413 The parameters can be specified either in parentheses as a ';' separated
3414 list, such as
3415
3416 ##### Example: function 1
3417
3418         func main(av:[ac::number]string; env:[envc::number]string)
3419                 code block
3420
3421 or as an indented list of one parameter per line (though each line can
3422 be a ';' separated list)
3423
3424 ##### Example: function 2
3425
3426         func main
3427                 argv:[argc::number]string
3428                 env:[envc::number]string
3429         do
3430                 code block
3431
3432 In the first case a return type can follow the parentheses after a colon,
3433 in the second it is given on a line starting with the word `return`.
3434
3435 ##### Example: functions that return
3436
3437         func add(a:number; b:number): number
3438                 code block
3439
3440         func catenate
3441                 a: string
3442                 b: string
3443         return string
3444         do
3445                 code block
3446
3447 Rather than returning a type, the function can specify a set of local
3448 variables to return as a struct.  The values of these variables when the
3449 function exits will be provided to the caller.  For this the return type
3450 is replaced with a block of result declarations, either in parentheses
3451 or bracketed by `return` and `do`.
3452
3453 ##### Example: functions returning multiple variables
3454
3455         func to_cartesian(rho:number; theta:number):(x:number; y:number)
3456                 x = .....
3457                 y = .....
3458
3459         func to_polar
3460                 x:number; y:number
3461         return
3462                 rho:number
3463                 theta:number
3464         do
3465                 rho = ....
3466                 theta = ....
3467
3468 For constructing the lists we use a `List` binode, which will be
3469 further detailed when Expression Lists are introduced.
3470
3471 ###### type union fields
3472
3473         struct {
3474                 struct binode *params;
3475                 struct type *return_type;
3476                 struct variable *scope;
3477                 int inline_result;      // return value is at start of 'local'
3478                 int local_size;
3479         } function;
3480
3481 ###### value union fields
3482         struct exec *function;
3483
3484 ###### type functions
3485         void (*check_args)(struct parse_context *c, enum prop_err *perr,
3486                            struct type *require, struct exec *args);
3487
3488 ###### value functions
3489
3490         static void function_free(struct type *type, struct value *val)
3491         {
3492                 free_exec(val->function);
3493                 val->function = NULL;
3494         }
3495
3496         static int function_compat(struct type *require, struct type *have,
3497                                    enum val_rules rules)
3498         {
3499                 // FIXME can I do anything here yet?
3500                 return 0;
3501         }
3502
3503         static struct exec *take_addr(struct exec *e)
3504         {
3505                 struct binode *rv = new(binode);
3506                 rv->op = AddressOf;
3507                 rv->left = e;
3508                 return rv;
3509         }
3510
3511         static void function_check_args(struct parse_context *c, enum prop_err *perr,
3512                                         struct type *require, struct exec *args)
3513         {
3514                 /* This should be 'compat', but we don't have a 'tuple' type to
3515                  * hold the type of 'args'
3516                  */
3517                 struct binode *arg = cast(binode, args);
3518                 struct binode *param = require->function.params;
3519
3520                 while (param) {
3521                         struct var *pv = cast(var, param->left);
3522                         struct type *t = pv->var->type, *t2;
3523                         if (!arg) {
3524                                 type_err(c, "error: insufficient arguments to function.",
3525                                          args, NULL, 0, NULL);
3526                                 break;
3527                         }
3528                         *perr = 0;
3529                         t2 = propagate_types(arg->left, c, perr, t, Rrefok);
3530                         if (t->free == reference_free &&
3531                             t->reference.referent == t2 &&
3532                             !(*perr & Erval)) {
3533                                 arg->left = take_addr(arg->left);
3534                         } else if (!(*perr & Efail) && !type_compat(t2, t, 0)) {
3535                                 type_err(c, "error: cannot pass rval when reference expected",
3536                                          arg->left, NULL, 0, NULL);
3537                         }
3538                         param = cast(binode, param->right);
3539                         arg = cast(binode, arg->right);
3540                 }
3541                 if (arg)
3542                         type_err(c, "error: too many arguments to function.",
3543                                  args, NULL, 0, NULL);
3544         }
3545
3546         static void function_print(struct type *type, struct value *val, FILE *f)
3547         {
3548                 print_exec(val->function, 1, 0);
3549         }
3550
3551         static void function_print_type_decl(struct type *type, FILE *f)
3552         {
3553                 struct binode *b;
3554                 fprintf(f, "(");
3555                 for (b = type->function.params; b; b = cast(binode, b->right)) {
3556                         struct variable *v = cast(var, b->left)->var;
3557                         fprintf(f, "%.*s%s", v->name->name.len, v->name->name.txt,
3558                                 v->constant ? "::" : ":");
3559                         type_print(v->type, f);
3560                         if (b->right)
3561                                 fprintf(f, "; ");
3562                 }
3563                 fprintf(f, ")");
3564                 if (type->function.return_type != Tnone) {
3565                         fprintf(f, ":");
3566                         if (type->function.inline_result) {
3567                                 int i;
3568                                 struct type *t = type->function.return_type;
3569                                 fprintf(f, " (");
3570                                 for (i = 0; i < t->structure.nfields; i++) {
3571                                         struct field *fl = t->structure.fields + i;
3572                                         if (i)
3573                                                 fprintf(f, "; ");
3574                                         fprintf(f, "%.*s:", fl->name.len, fl->name.txt);
3575                                         type_print(fl->type, f);
3576                                 }
3577                                 fprintf(f, ")");
3578                         } else
3579                                 type_print(type->function.return_type, f);
3580                 }
3581                 fprintf(f, "\n");
3582         }
3583
3584         static void function_free_type(struct type *t)
3585         {
3586                 free_exec(t->function.params);
3587         }
3588
3589         static struct type function_prototype = {
3590                 .size = sizeof(void*),
3591                 .align = sizeof(void*),
3592                 .free = function_free,
3593                 .compat = function_compat,
3594                 .check_args = function_check_args,
3595                 .print = function_print,
3596                 .print_type_decl = function_print_type_decl,
3597                 .free_type = function_free_type,
3598         };
3599
3600 ###### declare terminals
3601
3602         $TERM func
3603
3604 ###### Binode types
3605         List,
3606
3607 ###### Grammar
3608
3609         $*variable
3610         FuncName -> IDENTIFIER ${ {
3611                 struct variable *v = var_decl(c, $1.txt);
3612                 struct var *e = new_pos(var, $1);
3613                 e->var = v;
3614                 if (v) {
3615                         v->where_decl = e;
3616                         v->where_set = e;
3617                         $0 = v;
3618                 } else {
3619                         v = var_ref(c, $1.txt);
3620                         e->var = v;
3621                         type_err(c, "error: function '%v' redeclared",
3622                                 e, NULL, 0, NULL);
3623                         type_err(c, "info: this is where '%v' was first declared",
3624                                 v->where_decl, NULL, 0, NULL);
3625                         free_exec(e);
3626                 }
3627         } }$
3628
3629         $*binode
3630         Args -> ArgsLine NEWLINE ${ $0 = $<AL; }$
3631         | Args ArgsLine NEWLINE ${ {
3632                 struct binode *b = $<AL;
3633                 struct binode **bp = &b;
3634                 while (*bp)
3635                         bp = (struct binode **)&(*bp)->left;
3636                 *bp = $<A;
3637                 $0 = b;
3638         } }$
3639
3640         ArgsLine -> ${ $0 = NULL; }$
3641         | Varlist ${ $0 = $<1; }$
3642         | Varlist ; ${ $0 = $<1; }$
3643
3644         Varlist -> Varlist ; ArgDecl ${
3645                 $0 = new_pos(binode, $2);
3646                 $0->op = List;
3647                 $0->left = $<Vl;
3648                 $0->right = $<AD;
3649         }$
3650         | ArgDecl ${
3651                 $0 = new(binode);
3652                 $0->op = List;
3653                 $0->left = NULL;
3654                 $0->right = $<AD;
3655         }$
3656
3657         $*var
3658         ArgDecl -> IDENTIFIER : FormalType ${ {
3659                 struct variable *v = var_decl(c, $ID.txt);
3660                 $0 = new_pos(var, $ID);
3661                 $0->var = v;
3662                 v->where_decl = $0;
3663                 v->where_set = $0;
3664                 v->type = $<FT;
3665         } }$
3666
3667 ##### Function calls
3668
3669 A function call can appear either as an expression or as a statement.
3670 We use a new 'Funcall' binode type to link the function with a list of
3671 arguments, form with the 'List' nodes.
3672
3673 We have already seen the "Term" which is how a function call can appear
3674 in an expression.  To parse a function call into a statement we include
3675 it in the "SimpleStatement Grammar" which will be described later.
3676
3677 ###### Binode types
3678         Funcall,
3679
3680 ###### term grammar
3681         | Term ( ExpressionList ) ${ {
3682                 struct binode *b = new(binode);
3683                 b->op = Funcall;
3684                 b->left = $<T;
3685                 b->right = reorder_bilist($<EL);
3686                 $0 = b;
3687         } }$
3688         | Term ( ) ${ {
3689                 struct binode *b = new(binode);
3690                 b->op = Funcall;
3691                 b->left = $<T;
3692                 b->right = NULL;
3693                 $0 = b;
3694         } }$
3695
3696 ###### SimpleStatement Grammar
3697
3698         | Term ( ExpressionList ) ${ {
3699                 struct binode *b = new(binode);
3700                 b->op = Funcall;
3701                 b->left = $<T;
3702                 b->right = reorder_bilist($<EL);
3703                 $0 = b;
3704         } }$
3705
3706 ###### print binode cases
3707
3708         case Funcall:
3709                 do_indent(indent, "");
3710                 print_exec(b->left, -1, bracket);
3711                 printf("(");
3712                 for (b = cast(binode, b->right); b; b = cast(binode, b->right)) {
3713                         if (b->left) {
3714                                 printf(" ");
3715                                 print_exec(b->left, -1, bracket);
3716                                 if (b->right)
3717                                         printf(",");
3718                         }
3719                 }
3720                 printf(")");
3721                 if (indent >= 0)
3722                         printf("\n");
3723                 break;
3724
3725 ###### propagate binode cases
3726
3727         case Funcall: {
3728                 /* Every arg must match formal parameter, and result
3729                  * is return type of function
3730                  */
3731                 struct binode *args = cast(binode, b->right);
3732                 struct var *v = cast(var, b->left);
3733
3734                 if (!v->var->type || v->var->type->check_args == NULL) {
3735                         type_err(c, "error: attempt to call a non-function.",
3736                                  prog, NULL, 0, NULL);
3737                         return NULL;
3738                 }
3739                 *perr |= Eruntime;
3740                 v->var->type->check_args(c, perr_local, v->var->type, args);
3741                 if (v->var->type->function.inline_result)
3742                         *perr |= Emaycopy;
3743                 *perr |= Erval;
3744                 return v->var->type->function.return_type;
3745         }
3746
3747 ###### interp binode cases
3748
3749         case Funcall: {
3750                 struct var *v = cast(var, b->left);
3751                 struct type *t = v->var->type;
3752                 void *oldlocal = c->local;
3753                 int old_size = c->local_size;
3754                 void *local = calloc(1, t->function.local_size);
3755                 struct value *fbody = var_value(c, v->var);
3756                 struct binode *arg = cast(binode, b->right);
3757                 struct binode *param = t->function.params;
3758
3759                 while (param) {
3760                         struct var *pv = cast(var, param->left);
3761                         struct type *vtype = NULL;
3762                         struct value val = interp_exec(c, arg->left, &vtype);
3763                         struct value *lval;
3764                         c->local = local; c->local_size = t->function.local_size;
3765                         lval = var_value(c, pv->var);
3766                         c->local = oldlocal; c->local_size = old_size;
3767                         memcpy(lval, &val, vtype->size);
3768                         param = cast(binode, param->right);
3769                         arg = cast(binode, arg->right);
3770                 }
3771                 c->local = local; c->local_size = t->function.local_size;
3772                 if (t->function.inline_result && dtype) {
3773                         _interp_exec(c, fbody->function, NULL, NULL);
3774                         memcpy(dest, local, dtype->size);
3775                         rvtype = ret.type = NULL;
3776                 } else
3777                         rv = interp_exec(c, fbody->function, &rvtype);
3778                 c->local = oldlocal; c->local_size = old_size;
3779                 free(local);
3780                 break;
3781         }
3782
3783 ## Complex executables: statements and expressions
3784
3785 Now that we have types and values and variables and most of the basic
3786 Terms which provide access to these, we can explore the more complex
3787 code that combine all of these to get useful work done.  Specifically
3788 statements and expressions.
3789
3790 Expressions are various combinations of Terms.  We will use operator
3791 precedence to ensure correct parsing.  The simplest Expression is just a
3792 Term - others will follow.
3793
3794 ###### Grammar
3795
3796         $*exec
3797         Expression -> Term ${ $0 = $<Term; }$
3798         ## expression grammar
3799
3800 ### Expressions: Conditional
3801
3802 Our first user of the `binode` will be conditional expressions, which
3803 is a bit odd as they actually have three components.  That will be
3804 handled by having 2 binodes for each expression.  The conditional
3805 expression is the lowest precedence operator which is why we define it
3806 first - to start the precedence list.
3807
3808 Conditional expressions are of the form "value `if` condition `else`
3809 other_value".  They associate to the right, so everything to the right
3810 of `else` is part of an else value, while only a higher-precedence to
3811 the left of `if` is the if values.  Between `if` and `else` there is no
3812 room for ambiguity, so a full conditional expression is allowed in
3813 there.
3814
3815 ###### Binode types
3816         CondExpr,
3817
3818 ###### declare terminals
3819
3820         $LEFT if $$ifelse
3821
3822 ###### expression grammar
3823
3824         | Expression if Expression else Expression $$ifelse ${ {
3825                 struct binode *b1 = new(binode);
3826                 struct binode *b2 = new(binode);
3827                 b1->op = CondExpr;
3828                 b1->left = $<3;
3829                 b1->right = b2;
3830                 b2->op = CondExpr;
3831                 b2->left = $<1;
3832                 b2->right = $<5;
3833                 $0 = b1;
3834         } }$
3835
3836 ###### print binode cases
3837
3838         case CondExpr:
3839                 b2 = cast(binode, b->right);
3840                 if (bracket) printf("(");
3841                 print_exec(b2->left, -1, bracket);
3842                 printf(" if ");
3843                 print_exec(b->left, -1, bracket);
3844                 printf(" else ");
3845                 print_exec(b2->right, -1, bracket);
3846                 if (bracket) printf(")");
3847                 break;
3848
3849 ###### propagate binode cases
3850
3851         case CondExpr: {
3852                 /* cond must be Tbool, others must match */
3853                 struct binode *b2 = cast(binode, b->right);
3854                 struct type *t2;
3855
3856                 propagate_types(b->left, c, perr_local, Tbool, 0);
3857                 t = propagate_types(b2->left, c, perr, type, 0);
3858                 t2 = propagate_types(b2->right, c, perr, type ?: t, 0);
3859                 return t ?: t2;
3860         }
3861
3862 ###### interp binode cases
3863
3864         case CondExpr: {
3865                 struct binode *b2 = cast(binode, b->right);
3866                 left = interp_exec(c, b->left, &ltype);
3867                 if (left.bool)
3868                         rv = interp_exec(c, b2->left, &rvtype); // UNTESTED
3869                 else
3870                         rv = interp_exec(c, b2->right, &rvtype);
3871                 }
3872                 break;
3873
3874 ### Expression list
3875
3876 We take a brief detour, now that we have expressions, to describe lists
3877 of expressions.  These will be needed for function parameters and
3878 possibly other situations.  They seem generic enough to introduce here
3879 to be used elsewhere.
3880
3881 And ExpressionList will use the `List` type of `binode`, building up at
3882 the end.  And place where they are used will probably call
3883 `reorder_bilist()` to get a more normal first/next arrangement.
3884
3885 ###### declare terminals
3886         $TERM ,
3887
3888 `List` execs have no implicit semantics, so they are never propagated or
3889 interpreted.  The can be printed as a comma separate list, which is how
3890 they are parsed.  Note they are also used for function formal parameter
3891 lists.  In that case a separate function is used to print them.
3892
3893 ###### print binode cases
3894         case List:
3895                 while (b) {
3896                         printf(" ");
3897                         print_exec(b->left, -1, bracket);
3898                         if (b->right)
3899                                 printf(",");
3900                         b = cast(binode, b->right);
3901                 }
3902                 break;
3903
3904 ###### propagate binode cases
3905         case List: abort(); // NOTEST
3906 ###### interp binode cases
3907         case List: abort(); // NOTEST
3908
3909 ###### Grammar
3910
3911         $*binode
3912         ExpressionList -> ExpressionList , Expression ${
3913                 $0 = new(binode);
3914                 $0->op = List;
3915                 $0->left = $<1;
3916                 $0->right = $<3;
3917         }$
3918         | Expression ${
3919                 $0 = new(binode);
3920                 $0->op = List;
3921                 $0->left = NULL;
3922                 $0->right = $<1;
3923         }$
3924
3925 ### Expressions: Boolean
3926
3927 The next class of expressions to use the `binode` will be Boolean
3928 expressions.  "`and then`" and "`or else`" are similar to `and` and `or`
3929 have same corresponding precendence.  The difference is that they don't
3930 evaluate the second expression if not necessary.
3931
3932 ###### Binode types
3933         And,
3934         AndThen,
3935         Or,
3936         OrElse,
3937         Not,
3938
3939 ###### declare terminals
3940         $LEFT or
3941         $LEFT and
3942         $LEFT not
3943
3944 ###### expression grammar
3945         | Expression or Expression ${ {
3946                 struct binode *b = new(binode);
3947                 b->op = Or;
3948                 b->left = $<1;
3949                 b->right = $<3;
3950                 $0 = b;
3951         } }$
3952         | Expression or else Expression ${ {
3953                 struct binode *b = new(binode);
3954                 b->op = OrElse;
3955                 b->left = $<1;
3956                 b->right = $<4;
3957                 $0 = b;
3958         } }$
3959
3960         | Expression and Expression ${ {
3961                 struct binode *b = new(binode);
3962                 b->op = And;
3963                 b->left = $<1;
3964                 b->right = $<3;
3965                 $0 = b;
3966         } }$
3967         | Expression and then Expression ${ {
3968                 struct binode *b = new(binode);
3969                 b->op = AndThen;
3970                 b->left = $<1;
3971                 b->right = $<4;
3972                 $0 = b;
3973         } }$
3974
3975         | not Expression ${ {
3976                 struct binode *b = new(binode);
3977                 b->op = Not;
3978                 b->right = $<2;
3979                 $0 = b;
3980         } }$
3981
3982 ###### print binode cases
3983         case And:
3984                 if (bracket) printf("(");
3985                 print_exec(b->left, -1, bracket);
3986                 printf(" and ");
3987                 print_exec(b->right, -1, bracket);
3988                 if (bracket) printf(")");
3989                 break;
3990         case AndThen:
3991                 if (bracket) printf("(");
3992                 print_exec(b->left, -1, bracket);
3993                 printf(" and then ");
3994                 print_exec(b->right, -1, bracket);
3995                 if (bracket) printf(")");
3996                 break;
3997         case Or:
3998                 if (bracket) printf("(");
3999                 print_exec(b->left, -1, bracket);
4000                 printf(" or ");
4001                 print_exec(b->right, -1, bracket);
4002                 if (bracket) printf(")");
4003                 break;
4004         case OrElse:
4005                 if (bracket) printf("(");
4006                 print_exec(b->left, -1, bracket);
4007                 printf(" or else ");
4008                 print_exec(b->right, -1, bracket);
4009                 if (bracket) printf(")");
4010                 break;
4011         case Not:
4012                 if (bracket) printf("(");
4013                 printf("not ");
4014                 print_exec(b->right, -1, bracket);
4015                 if (bracket) printf(")");
4016                 break;
4017
4018 ###### propagate binode cases
4019         case And:
4020         case AndThen:
4021         case Or:
4022         case OrElse:
4023         case Not:
4024                 /* both must be Tbool, result is Tbool */
4025                 propagate_types(b->left, c, perr, Tbool, 0);
4026                 propagate_types(b->right, c, perr, Tbool, 0);
4027                 if (type && type != Tbool)
4028                         type_err(c, "error: %1 operation found where %2 expected", prog,
4029                                    Tbool, 0, type);
4030                 *perr |= Erval;
4031                 return Tbool;
4032
4033 ###### interp binode cases
4034         case And:
4035                 rv = interp_exec(c, b->left, &rvtype);
4036                 right = interp_exec(c, b->right, &rtype);
4037                 rv.bool = rv.bool && right.bool;
4038                 break;
4039         case AndThen:
4040                 rv = interp_exec(c, b->left, &rvtype);
4041                 if (rv.bool)
4042                         rv = interp_exec(c, b->right, NULL);
4043                 break;
4044         case Or:
4045                 rv = interp_exec(c, b->left, &rvtype);
4046                 right = interp_exec(c, b->right, &rtype);
4047                 rv.bool = rv.bool || right.bool;
4048                 break;
4049         case OrElse:
4050                 rv = interp_exec(c, b->left, &rvtype);
4051                 if (!rv.bool)
4052                         rv = interp_exec(c, b->right, NULL);
4053                 break;
4054         case Not:
4055                 rv = interp_exec(c, b->right, &rvtype);
4056                 rv.bool = !rv.bool;
4057                 break;
4058
4059 ### Expressions: Comparison
4060
4061 Of slightly higher precedence that Boolean expressions are Comparisons.
4062 A comparison takes arguments of any comparable type, but the two types
4063 must be the same.
4064
4065 To simplify the parsing we introduce an `eop` which can record an
4066 expression operator, and the `CMPop` non-terminal will match one of them.
4067
4068 ###### ast
4069         struct eop {
4070                 enum Btype op;
4071         };
4072
4073 ###### ast functions
4074         static void free_eop(struct eop *e)
4075         {
4076                 if (e)
4077                         free(e);
4078         }
4079
4080 ###### Binode types
4081         Less,
4082         Gtr,
4083         LessEq,
4084         GtrEq,
4085         Eql,
4086         NEql,
4087
4088 ###### declare terminals
4089         $LEFT < > <= >= == != CMPop
4090
4091 ###### expression grammar
4092         | Expression CMPop Expression ${ {
4093                 struct binode *b = new(binode);
4094                 b->op = $2.op;
4095                 b->left = $<1;
4096                 b->right = $<3;
4097                 $0 = b;
4098         } }$
4099
4100 ###### Grammar
4101
4102         $eop
4103         CMPop ->  < ${ $0.op = Less; }$
4104         |         > ${ $0.op = Gtr; }$
4105         |         <= ${ $0.op = LessEq; }$
4106         |         >= ${ $0.op = GtrEq; }$
4107         |         == ${ $0.op = Eql; }$
4108         |         != ${ $0.op = NEql; }$
4109
4110 ###### print binode cases
4111
4112         case Less:
4113         case LessEq:
4114         case Gtr:
4115         case GtrEq:
4116         case Eql:
4117         case NEql:
4118                 if (bracket) printf("(");
4119                 print_exec(b->left, -1, bracket);
4120                 switch(b->op) {
4121                 case Less:   printf(" < "); break;
4122                 case LessEq: printf(" <= "); break;
4123                 case Gtr:    printf(" > "); break;
4124                 case GtrEq:  printf(" >= "); break;
4125                 case Eql:    printf(" == "); break;
4126                 case NEql:   printf(" != "); break;
4127                 default: abort();               // NOTEST
4128                 }
4129                 print_exec(b->right, -1, bracket);
4130                 if (bracket) printf(")");
4131                 break;
4132
4133 ###### propagate binode cases
4134         case Less:
4135         case LessEq:
4136         case Gtr:
4137         case GtrEq:
4138         case Eql:
4139         case NEql:
4140                 /* Both must match but not be labels, result is Tbool */
4141                 t = propagate_types(b->left, c, perr, NULL, 0);
4142                 if (t)
4143                         propagate_types(b->right, c, perr, t, 0);
4144                 else {
4145                         t = propagate_types(b->right, c, perr, NULL, 0);        // UNTESTED
4146                         if (t)  // UNTESTED
4147                                 t = propagate_types(b->left, c, perr, t, 0);    // UNTESTED
4148                 }
4149                 if (!type_compat(type, Tbool, 0))
4150                         type_err(c, "error: Comparison returns %1 but %2 expected", prog,
4151                                     Tbool, rules, type);
4152                 *perr |= Erval;
4153                 return Tbool;
4154
4155 ###### interp binode cases
4156         case Less:
4157         case LessEq:
4158         case Gtr:
4159         case GtrEq:
4160         case Eql:
4161         case NEql:
4162         {
4163                 int cmp;
4164                 left = interp_exec(c, b->left, &ltype);
4165                 right = interp_exec(c, b->right, &rtype);
4166                 cmp = value_cmp(ltype, rtype, &left, &right);
4167                 rvtype = Tbool;
4168                 switch (b->op) {
4169                 case Less:      rv.bool = cmp <  0; break;
4170                 case LessEq:    rv.bool = cmp <= 0; break;
4171                 case Gtr:       rv.bool = cmp >  0; break;
4172                 case GtrEq:     rv.bool = cmp >= 0; break;
4173                 case Eql:       rv.bool = cmp == 0; break;
4174                 case NEql:      rv.bool = cmp != 0; break;
4175                 default:        rv.bool = 0; break;     // NOTEST
4176                 }
4177                 break;
4178         }
4179
4180 ### Expressions: Arithmetic etc.
4181
4182 The remaining expressions with the highest precedence are arithmetic,
4183 string concatenation, string conversion, and testing.  String concatenation
4184 (`++`) has the same precedence as multiplication and division, but lower
4185 than the uniary.
4186
4187 Testing comes in two forms.  A single question mark (`?`) is a uniary
4188 operator which converts come types into Boolean.  The general meaning is
4189 "is this a value value" and there will be more uses as the language
4190 develops.  A double questionmark (`??`) is a binary operator (Choose),
4191 with same precedence as multiplication, which returns the LHS if it
4192 tests successfully, else returns the RHS.
4193
4194 String conversion is a temporary feature until I get a better type
4195 system.  `$` is a prefix operator which expects a string and returns
4196 a number.
4197
4198 `+` and `-` are both infix and prefix operations (where they are
4199 absolute value and negation).  These have different operator names.
4200
4201 We also have a 'Bracket' operator which records where parentheses were
4202 found.  This makes it easy to reproduce these when printing.  Possibly I
4203 should only insert brackets were needed for precedence.  Putting
4204 parentheses around an expression converts it into a Term,
4205
4206 ###### Binode types
4207         Plus, Minus,
4208         Times, Divide, Rem,
4209         Concat, Choose,
4210         Absolute, Negate, Test,
4211         StringConv,
4212         Bracket,
4213
4214 ###### declare terminals
4215         $LEFT + - Eop
4216         $LEFT * / % ++ ?? Top
4217         $LEFT Uop $ ?
4218         $TERM ( )
4219
4220 ###### expression grammar
4221         | Expression Eop Expression ${ {
4222                 struct binode *b = new(binode);
4223                 b->op = $2.op;
4224                 b->left = $<1;
4225                 b->right = $<3;
4226                 $0 = b;
4227         } }$
4228
4229         | Expression Top Expression ${ {
4230                 struct binode *b = new(binode);
4231                 b->op = $2.op;
4232                 b->left = $<1;
4233                 b->right = $<3;
4234                 $0 = b;
4235         } }$
4236
4237         | Uop Expression ${ {
4238                 struct binode *b = new(binode);
4239                 b->op = $1.op;
4240                 b->right = $<2;
4241                 $0 = b;
4242         } }$
4243
4244 ###### term grammar
4245
4246         | ( Expression ) ${ {
4247                 struct binode *b = new_pos(binode, $1);
4248                 b->op = Bracket;
4249                 b->right = $<2;
4250                 $0 = b;
4251         } }$
4252
4253 ###### Grammar
4254
4255         $eop
4256         Eop ->   + ${ $0.op = Plus; }$
4257         |        - ${ $0.op = Minus; }$
4258
4259         Uop ->   + ${ $0.op = Absolute; }$
4260         |        - ${ $0.op = Negate; }$
4261         |        $ ${ $0.op = StringConv; }$
4262         |        ? ${ $0.op = Test; }$
4263
4264         Top ->   * ${ $0.op = Times; }$
4265         |        / ${ $0.op = Divide; }$
4266         |        % ${ $0.op = Rem; }$
4267         |        ++ ${ $0.op = Concat; }$
4268         |        ?? ${ $0.op = Choose; }$
4269
4270 ###### print binode cases
4271         case Plus:
4272         case Minus:
4273         case Times:
4274         case Divide:
4275         case Concat:
4276         case Rem:
4277         case Choose:
4278                 if (bracket) printf("(");
4279                 print_exec(b->left, indent, bracket);
4280                 switch(b->op) {
4281                 case Plus:   fputs(" + ", stdout); break;
4282                 case Minus:  fputs(" - ", stdout); break;
4283                 case Times:  fputs(" * ", stdout); break;
4284                 case Divide: fputs(" / ", stdout); break;
4285                 case Rem:    fputs(" % ", stdout); break;
4286                 case Concat: fputs(" ++ ", stdout); break;
4287                 case Choose: fputs(" ?? ", stdout); break;
4288                 default: abort();       // NOTEST
4289                 }                       // NOTEST
4290                 print_exec(b->right, indent, bracket);
4291                 if (bracket) printf(")");
4292                 break;
4293         case Absolute:
4294         case Negate:
4295         case StringConv:
4296         case Test:
4297                 if (bracket) printf("(");
4298                 switch (b->op) {
4299                 case Absolute:   fputs("+", stdout); break;
4300                 case Negate:     fputs("-", stdout); break;
4301                 case StringConv: fputs("$", stdout); break;
4302                 case Test:       fputs("?", stdout); break;
4303                 default: abort();       // NOTEST
4304                 }                       // NOTEST
4305                 print_exec(b->right, indent, bracket);
4306                 if (bracket) printf(")");
4307                 break;
4308         case Bracket:
4309                 printf("(");
4310                 print_exec(b->right, indent, bracket);
4311                 printf(")");
4312                 break;
4313
4314 ###### propagate binode cases
4315         case Plus:
4316         case Minus:
4317         case Times:
4318         case Rem:
4319         case Divide:
4320                 /* both must be numbers, result is Tnum */
4321         case Absolute:
4322         case Negate:
4323                 /* as propagate_types ignores a NULL,
4324                  * unary ops fit here too */
4325                 propagate_types(b->left, c, perr, Tnum, 0);
4326                 propagate_types(b->right, c, perr, Tnum, 0);
4327                 if (!type_compat(type, Tnum, 0))
4328                         type_err(c, "error: Arithmetic returns %1 but %2 expected", prog,
4329                                    Tnum, rules, type);
4330                 *perr |= Erval;
4331                 return Tnum;
4332
4333         case Concat:
4334                 /* both must be Tstr, result is Tstr */
4335                 propagate_types(b->left, c, perr, Tstr, 0);
4336                 propagate_types(b->right, c, perr, Tstr, 0);
4337                 if (!type_compat(type, Tstr, 0))
4338                         type_err(c, "error: Concat returns %1 but %2 expected", prog,
4339                                    Tstr, rules, type);
4340                 *perr |= Erval;
4341                 return Tstr;
4342
4343         case StringConv:
4344                 /* op must be string, result is number */
4345                 propagate_types(b->left, c, perr, Tstr, 0);
4346                 if (!type_compat(type, Tnum, 0))
4347                         type_err(c,     // UNTESTED
4348                           "error: Can only convert string to number, not %1",
4349                                 prog, type, 0, NULL);
4350                 *perr |= Erval;
4351                 return Tnum;
4352
4353         case Test:
4354                 /* LHS must support ->test, result is Tbool */
4355                 t = propagate_types(b->right, c, perr, NULL, 0);
4356                 if (!t || !t->test)
4357                         type_err(c, "error: '?' requires a testable value, not %1",
4358                                  prog, t, 0, NULL);
4359                 *perr |= Erval;
4360                 return Tbool;
4361
4362         case Choose:
4363                 /* LHS and RHS must match and are returned. Must support
4364                  * ->test
4365                  */
4366                 t = propagate_types(b->left, c, perr, type, rules);
4367                 t = propagate_types(b->right, c, perr, t, rules);
4368                 if (t && t->test == NULL)
4369                         type_err(c, "error: \"??\" requires a testable value, not %1",
4370                                  prog, t, 0, NULL);
4371                 *perr |= Erval;
4372                 return t;
4373
4374         case Bracket:
4375                 return propagate_types(b->right, c, perr, type, rules);
4376
4377 ###### interp binode cases
4378
4379         case Plus:
4380                 rv = interp_exec(c, b->left, &rvtype);
4381                 right = interp_exec(c, b->right, &rtype);
4382                 mpq_add(rv.num, rv.num, right.num);
4383                 break;
4384         case Minus:
4385                 rv = interp_exec(c, b->left, &rvtype);
4386                 right = interp_exec(c, b->right, &rtype);
4387                 mpq_sub(rv.num, rv.num, right.num);
4388                 break;
4389         case Times:
4390                 rv = interp_exec(c, b->left, &rvtype);
4391                 right = interp_exec(c, b->right, &rtype);
4392                 mpq_mul(rv.num, rv.num, right.num);
4393                 break;
4394         case Divide:
4395                 rv = interp_exec(c, b->left, &rvtype);
4396                 right = interp_exec(c, b->right, &rtype);
4397                 mpq_div(rv.num, rv.num, right.num);
4398                 break;
4399         case Rem: {
4400                 mpz_t l, r, rem;
4401
4402                 left = interp_exec(c, b->left, &ltype);
4403                 right = interp_exec(c, b->right, &rtype);
4404                 mpz_init(l); mpz_init(r); mpz_init(rem);
4405                 mpz_tdiv_q(l, mpq_numref(left.num), mpq_denref(left.num));
4406                 mpz_tdiv_q(r, mpq_numref(right.num), mpq_denref(right.num));
4407                 mpz_tdiv_r(rem, l, r);
4408                 val_init(Tnum, &rv);
4409                 mpq_set_z(rv.num, rem);
4410                 mpz_clear(r); mpz_clear(l); mpz_clear(rem);
4411                 rvtype = ltype;
4412                 break;
4413         }
4414         case Negate:
4415                 rv = interp_exec(c, b->right, &rvtype);
4416                 mpq_neg(rv.num, rv.num);
4417                 break;
4418         case Absolute:
4419                 rv = interp_exec(c, b->right, &rvtype);
4420                 mpq_abs(rv.num, rv.num);
4421                 break;
4422         case Bracket:
4423                 rv = interp_exec(c, b->right, &rvtype);
4424                 break;
4425         case Concat:
4426                 left = interp_exec(c, b->left, &ltype);
4427                 right = interp_exec(c, b->right, &rtype);
4428                 rvtype = Tstr;
4429                 rv.str = text_join(left.str, right.str);
4430                 break;
4431         case StringConv:
4432                 right = interp_exec(c, b->right, &rvtype);
4433                 rtype = Tstr;
4434                 rvtype = Tnum;
4435
4436                 struct text tx = right.str;
4437                 char tail[3];
4438                 int neg = 0;
4439                 if (tx.txt[0] == '-') {
4440                         neg = 1;        // UNTESTED
4441                         tx.txt++;       // UNTESTED
4442                         tx.len--;       // UNTESTED
4443                 }
4444                 if (number_parse(rv.num, tail, tx) == 0)
4445                         mpq_init(rv.num);       // UNTESTED
4446                 else if (neg)
4447                         mpq_neg(rv.num, rv.num);        // UNTESTED
4448                 if (tail[0])
4449                         printf("Unsupported suffix: %.*s\n", tx.len, tx.txt);   // UNTESTED
4450
4451                 break;
4452         case Test:
4453                 right = interp_exec(c, b->right, &rtype);
4454                 rvtype = Tbool;
4455                 rv.bool = !!rtype->test(rtype, &right);
4456                 break;
4457         case Choose:
4458                 left = interp_exec(c, b->left, &ltype);
4459                 if (ltype->test(ltype, &left)) {
4460                         rv = left;
4461                         rvtype = ltype;
4462                         ltype = NULL;
4463                 } else
4464                         rv = interp_exec(c, b->right, &rvtype);
4465                 break;
4466
4467 ###### value functions
4468
4469         static struct text text_join(struct text a, struct text b)
4470         {
4471                 struct text rv;
4472                 rv.len = a.len + b.len;
4473                 rv.txt = malloc(rv.len);
4474                 memcpy(rv.txt, a.txt, a.len);
4475                 memcpy(rv.txt+a.len, b.txt, b.len);
4476                 return rv;
4477         }
4478
4479 ### Blocks, Statements, and Statement lists.
4480
4481 Now that we have expressions out of the way we need to turn to
4482 statements.  There are simple statements and more complex statements.
4483 Simple statements do not contain (syntactic) newlines, complex statements do.
4484
4485 Statements often come in sequences and we have corresponding simple
4486 statement lists and complex statement lists.
4487 The former comprise only simple statements separated by semicolons.
4488 The later comprise complex statements and simple statement lists.  They are
4489 separated by newlines.  Thus the semicolon is only used to separate
4490 simple statements on the one line.  This may be overly restrictive,
4491 but I'm not sure I ever want a complex statement to share a line with
4492 anything else.
4493
4494 Note that a simple statement list can still use multiple lines if
4495 subsequent lines are indented, so
4496
4497 ###### Example: wrapped simple statement list
4498
4499         a = b; c = d;
4500            e = f; print g
4501
4502 is a single simple statement list.  This might allow room for
4503 confusion, so I'm not set on it yet.
4504
4505 A simple statement list needs no extra syntax.  A complex statement
4506 list has two syntactic forms.  It can be enclosed in braces (much like
4507 C blocks), or it can be introduced by an indent and continue until an
4508 unindented newline (much like Python blocks).  With this extra syntax
4509 it is referred to as a block.
4510
4511 Note that a block does not have to include any newlines if it only
4512 contains simple statements.  So both of:
4513
4514         if condition: a=b; d=f
4515
4516         if condition { a=b; print f }
4517
4518 are valid.
4519
4520 In either case the list is constructed from a `binode` list with
4521 `Block` as the operator.  When parsing the list it is most convenient
4522 to append to the end, so a list is a list and a statement.  When using
4523 the list it is more convenient to consider a list to be a statement
4524 and a list.  So we need a function to re-order a list.
4525 `reorder_bilist` serves this purpose.
4526
4527 The only stand-alone statement we introduce at this stage is `pass`
4528 which does nothing and is represented as a `NULL` pointer in a `Block`
4529 list.  Other stand-alone statements will follow once the infrastructure
4530 is in-place.
4531
4532 As many statements will use binodes, we declare a binode pointer 'b' in
4533 the common header for all reductions to use.
4534
4535 ###### Parser: reduce
4536         struct binode *b;
4537
4538 ###### Binode types
4539         Block,
4540
4541 ###### Grammar
4542
4543         $TERM { } ;
4544
4545         $*binode
4546         Block -> { IN OptNL Statementlist OUT OptNL } ${ $0 = $<Sl; }$
4547         |        { SimpleStatements } ${ $0 = reorder_bilist($<SS); }$
4548         |        SimpleStatements ; ${ $0 = reorder_bilist($<SS); }$
4549         |        SimpleStatements EOL ${ $0 = reorder_bilist($<SS); }$
4550         |        IN OptNL Statementlist OUT ${ $0 = $<Sl; }$
4551
4552         OpenBlock -> OpenScope { IN OptNL Statementlist OUT OptNL } ${ $0 = $<Sl; }$
4553         |        OpenScope { SimpleStatements } ${ $0 = reorder_bilist($<SS); }$
4554         |        OpenScope SimpleStatements ; ${ $0 = reorder_bilist($<SS); }$
4555         |        OpenScope SimpleStatements EOL ${ $0 = reorder_bilist($<SS); }$
4556         |        IN OpenScope OptNL Statementlist OUT ${ $0 = $<Sl; }$
4557
4558         UseBlock -> { OpenScope IN OptNL Statementlist OUT OptNL } ${ $0 = $<Sl; }$
4559         |        { OpenScope SimpleStatements } ${ $0 = reorder_bilist($<SS); }$
4560         |        IN OpenScope OptNL Statementlist OUT ${ $0 = $<Sl; }$
4561
4562         ColonBlock -> { IN OptNL Statementlist OUT OptNL } ${ $0 = $<Sl; }$
4563         |        { SimpleStatements } ${ $0 = reorder_bilist($<SS); }$
4564         |        : SimpleStatements ; ${ $0 = reorder_bilist($<SS); }$
4565         |        : SimpleStatements EOL ${ $0 = reorder_bilist($<SS); }$
4566         |        : IN OptNL Statementlist OUT ${ $0 = $<Sl; }$
4567
4568         Statementlist -> ComplexStatements ${ $0 = reorder_bilist($<CS); }$
4569
4570         ComplexStatements -> ComplexStatements ComplexStatement ${
4571                 if ($2 == NULL) {
4572                         $0 = $<1;
4573                 } else {
4574                         $0 = new(binode);
4575                         $0->op = Block;
4576                         $0->left = $<1;
4577                         $0->right = $<2;
4578                 }
4579         }$
4580         | ComplexStatement ${
4581                 if ($1 == NULL) {
4582                         $0 = NULL;
4583                 } else {
4584                         $0 = new(binode);
4585                         $0->op = Block;
4586                         $0->left = NULL;
4587                         $0->right = $<1;
4588                 }
4589         }$
4590
4591         $*exec
4592         ComplexStatement -> SimpleStatements Newlines ${
4593                 $0 = reorder_bilist($<SS);
4594         }$
4595         |  SimpleStatements ; Newlines ${
4596                 $0 = reorder_bilist($<SS);
4597         }$
4598         ## ComplexStatement Grammar
4599
4600         $*binode
4601         SimpleStatements -> SimpleStatements ; SimpleStatement ${
4602                 $0 = new(binode);
4603                 $0->op = Block;
4604                 $0->left = $<1;
4605                 $0->right = $<3;
4606         }$
4607         | SimpleStatement ${
4608                 $0 = new(binode);
4609                 $0->op = Block;
4610                 $0->left = NULL;
4611                 $0->right = $<1;
4612         }$
4613
4614         $TERM pass
4615         $*exec
4616         SimpleStatement -> pass ${ $0 = NULL; }$
4617         | ERROR ${ tok_err(c, "Syntax error in statement", &$1); }$
4618         ## SimpleStatement Grammar
4619
4620 ###### print binode cases
4621         case Block:
4622                 if (indent < 0) {
4623                         // simple statement
4624                         if (b->left == NULL)    // UNTESTED
4625                                 printf("pass"); // UNTESTED
4626                         else
4627                                 print_exec(b->left, indent, bracket);   // UNTESTED
4628                         if (b->right) { // UNTESTED
4629                                 printf("; ");   // UNTESTED
4630                                 print_exec(b->right, indent, bracket);  // UNTESTED
4631                         }
4632                 } else {
4633                         // block, one per line
4634                         if (b->left == NULL)
4635                                 do_indent(indent, "pass\n");
4636                         else
4637                                 print_exec(b->left, indent, bracket);
4638                         if (b->right)
4639                                 print_exec(b->right, indent, bracket);
4640                 }
4641                 break;
4642
4643 ###### propagate binode cases
4644         case Block:
4645         {
4646                 /* If any statement returns something other than Tnone
4647                  * or Tbool then all such must return same type.
4648                  * As each statement may be Tnone or something else,
4649                  * we must always pass NULL (unknown) down, otherwise an incorrect
4650                  * error might occur.  We never return Tnone unless it is
4651                  * passed in.
4652                  */
4653                 struct binode *e;
4654
4655                 for (e = b; e; e = cast(binode, e->right)) {
4656                         t = propagate_types(e->left, c, perr, NULL, rules);
4657                         if ((rules & Rboolok) && (t == Tbool || t == Tnone))
4658                                 t = NULL;
4659                         if (t == Tnone && e->right)
4660                                 /* Only the final statement *must* return a value
4661                                  * when not Rboolok
4662                                  */
4663                                 t = NULL;
4664                         if (t) {
4665                                 if (!type)
4666                                         type = t;
4667                                 else if (t != type)
4668                                         type_err(c, "error: expected %1, found %2",
4669                                                  e->left, type, rules, t);
4670                         }
4671                 }
4672                 return type;
4673         }
4674
4675 ###### interp binode cases
4676         case Block:
4677                 while (rvtype == Tnone &&
4678                        b) {
4679                         if (b->left)
4680                                 rv = interp_exec(c, b->left, &rvtype);
4681                         b = cast(binode, b->right);
4682                 }
4683                 break;
4684
4685 ### The Print statement
4686
4687 `print` is a simple statement that takes a comma-separated list of
4688 expressions and prints the values separated by spaces and terminated
4689 by a newline.  No control of formatting is possible.
4690
4691 `print` uses `ExpressionList` to collect the expressions and stores them
4692 on the left side of a `Print` binode unlessthere is a trailing comma
4693 when the list is stored on the `right` side and no trailing newline is
4694 printed.
4695
4696 ###### Binode types
4697         Print,
4698
4699 ##### declare terminals
4700         $TERM print
4701
4702 ###### SimpleStatement Grammar
4703
4704         | print ExpressionList ${
4705                 $0 = b = new_pos(binode, $1);
4706                 b->op = Print;
4707                 b->right = NULL;
4708                 b->left = reorder_bilist($<EL);
4709         }$
4710         | print ExpressionList , ${ {
4711                 $0 = b = new_pos(binode, $1);
4712                 b->op = Print;
4713                 b->right = reorder_bilist($<EL);
4714                 b->left = NULL;
4715         } }$
4716         | print ${
4717                 $0 = b = new_pos(binode, $1);
4718                 b->op = Print;
4719                 b->left = NULL;
4720                 b->right = NULL;
4721         }$
4722
4723 ###### print binode cases
4724
4725         case Print:
4726                 do_indent(indent, "print");
4727                 if (b->right) {
4728                         print_exec(b->right, -1, bracket);
4729                         printf(",");
4730                 } else
4731                         print_exec(b->left, -1, bracket);
4732                 if (indent >= 0)
4733                         printf("\n");
4734                 break;
4735
4736 ###### propagate binode cases
4737
4738         case Print:
4739                 /* don't care but all must be consistent */
4740                 if (b->left)
4741                         b = cast(binode, b->left);
4742                 else
4743                         b = cast(binode, b->right);
4744                 while (b) {
4745                         propagate_types(b->left, c, perr_local, NULL, 0);
4746                         b = cast(binode, b->right);
4747                 }
4748                 break;
4749
4750 ###### interp binode cases
4751
4752         case Print:
4753         {
4754                 struct binode *b2 = cast(binode, b->left);
4755                 if (!b2)
4756                         b2 = cast(binode, b->right);
4757                 for (; b2; b2 = cast(binode, b2->right)) {
4758                         left = interp_exec(c, b2->left, &ltype);
4759                         print_value(ltype, &left, stdout);
4760                         free_value(ltype, &left);
4761                         if (b2->right)
4762                                 putchar(' ');
4763                 }
4764                 if (b->right == NULL)
4765                         printf("\n");
4766                 ltype = Tnone;
4767                 break;
4768         }
4769
4770 ###### Assignment statement
4771
4772 An assignment will assign a value to a variable, providing it hasn't
4773 been declared as a constant.  The analysis phase ensures that the type
4774 will be correct so the interpreter just needs to perform the
4775 calculation.  There is a form of assignment which declares a new
4776 variable as well as assigning a value.  If a name is used before
4777 it is declared, it is assumed to be a global constant which are allowed to
4778 be declared at any time.
4779
4780 ###### Binode types
4781         Assign, AssignRef,
4782         Declare, DeclareRef,
4783
4784 ###### declare terminals
4785         $TERM =
4786
4787 ###### SimpleStatement Grammar
4788         | Term = Expression ${
4789                 $0 = b= new(binode);
4790                 b->op = Assign;
4791                 b->left = $<1;
4792                 b->right = $<3;
4793         }$
4794         | VariableDecl = Expression ${
4795                 $0 = b= new(binode);
4796                 b->op = Declare;
4797                 b->left = $<1;
4798                 b->right =$<3;
4799         }$
4800
4801         | VariableDecl ${
4802                 if ($1->var->where_set == NULL) {
4803                         type_err(c,
4804                                  "Variable declared with no type or value: %v",
4805                                  $1, NULL, 0, NULL);
4806                         free_var($1);
4807                 } else {
4808                         $0 = b = new(binode);
4809                         b->op = Declare;
4810                         b->left = $<1;
4811                         b->right = NULL;
4812                 }
4813         }$
4814
4815 ###### print binode cases
4816
4817         case Assign:
4818         case AssignRef:
4819                 do_indent(indent, "");
4820                 print_exec(b->left, -1, bracket);
4821                 printf(" = ");
4822                 print_exec(b->right, -1, bracket);
4823                 if (indent >= 0)
4824                         printf("\n");
4825                 break;
4826
4827         case Declare:
4828         case DeclareRef:
4829                 {
4830                 struct variable *v = cast(var, b->left)->var;
4831                 do_indent(indent, "");
4832                 print_exec(b->left, -1, bracket);
4833                 if (cast(var, b->left)->var->constant) {
4834                         printf("::");
4835                         if (v->explicit_type) {
4836                                 type_print(v->type, stdout);
4837                                 printf(" ");
4838                         }
4839                 } else {
4840                         printf(":");
4841                         if (v->explicit_type) {
4842                                 type_print(v->type, stdout);
4843                                 printf(" ");
4844                         }
4845                 }
4846                 if (b->right) {
4847                         printf("= ");
4848                         print_exec(b->right, -1, bracket);
4849                 }
4850                 if (indent >= 0)
4851                         printf("\n");
4852                 }
4853                 break;
4854
4855 ###### propagate binode cases
4856
4857         case Assign:
4858         case AssignRef:
4859         case Declare:
4860         case DeclareRef:
4861                 /* Both must match, or left may be ref and right an lval
4862                  * Type must support 'dup',
4863                  * For Assign, left must not be constant.
4864                  * result is Tnone
4865                  */
4866                 *perr &= ~(Erval | Econst);
4867                 t = propagate_types(b->left, c, perr, NULL, 0);
4868                 if (!b->right)
4869                         return Tnone;
4870
4871                 if (t) {
4872                         struct type *t2 = propagate_types(b->right, c, perr_local,
4873                                                           t, Rrefok);
4874                         if (!t2 || t2 == t || (*perr_local & Efail))
4875                                 ; // No more effort needed
4876                         else if (t->free == reference_free &&
4877                                  t->reference.referent == t2 &&
4878                                  !(*perr_local & Erval)) {
4879                                 if (b->op == Assign)
4880                                         b->op = AssignRef;
4881                                 if (b->op == Declare)
4882                                         b->op = DeclareRef;
4883                         }
4884                         else if (t->free == reference_free &&
4885                                  t->reference.referent == t2 &&
4886                                  (*perr_local & Erval))
4887                                 type_err(c, "error: Cannot assign an rval to a reference.",
4888                                          b, NULL, 0, NULL);
4889                 } else {
4890                         t = propagate_types(b->right, c, perr_local, NULL, 0);
4891                         if (t)
4892                                 propagate_types(b->left, c, perr, t, 0);
4893                 }
4894                 if (*perr & Erval)
4895                         type_err(c, "error: cannot assign to an rval", b,
4896                                  NULL, 0, NULL);
4897                 else if ((b->op == Assign || b->op == AssignRef) && (*perr & Econst)) {
4898                         type_err(c, "error: Cannot assign to a constant: %v",
4899                                  b->left, NULL, 0, NULL);
4900                         if (b->left->type == Xvar) {
4901                                 struct var *var = cast(var, b->left);
4902                                 struct variable *v = var->var;
4903                                 type_err(c, "info: name was defined as a constant here",
4904                                          v->where_decl, NULL, 0, NULL);
4905                         }
4906                 }
4907                 if (t && t->dup == NULL && !(*perr_local & Emaycopy))
4908                         type_err(c, "error: cannot assign value of type %1", b, t, 0, NULL);
4909                 if (b->left->type == Xvar && (*perr_local & Efail))
4910                         type_err(c, "info: variable '%v' was set as %1 here.",
4911                                  cast(var, b->left)->var->where_set, t, rules, NULL);
4912                 return Tnone;
4913
4914                 break;
4915
4916 ###### interp binode cases
4917
4918         case Assign:
4919         case AssignRef:
4920                 lleft = linterp_exec(c, b->left, &ltype);
4921                 if (!lleft)
4922                         // FIXME lleft==NULL probably means illegal array ref
4923                         // should that cause a runtime error
4924                         ;
4925                 else if (b->op == AssignRef)
4926                         lleft->ref = linterp_exec(c, b->right, &rtype);
4927                 else
4928                         dinterp_exec(c, b->right, lleft, ltype, 1);
4929                 ltype = Tnone;
4930                 break;
4931
4932         case Declare:
4933         case DeclareRef:
4934         {
4935                 struct variable *v = cast(var, b->left)->var;
4936                 struct value *val;
4937                 v = v->merged;
4938                 val = var_value(c, v);
4939                 if (v->type->prepare_type)
4940                         v->type->prepare_type(c, v->type, 0);
4941                 if (!b->right)
4942                         val_init(v->type, val);
4943                 else if (b->op == DeclareRef)
4944                         val->ref = linterp_exec(c, b->right, &rtype);
4945                 else
4946                         dinterp_exec(c, b->right, val, v->type, 0);
4947                 break;
4948         }
4949
4950 ### The `use` statement
4951
4952 The `use` statement is the last "simple" statement.  It is needed when a
4953 statement block can return a value.  This includes the body of a
4954 function which has a return type, and the "condition" code blocks in
4955 `if`, `while`, and `switch` statements.
4956
4957 ###### Binode types
4958         Use,
4959
4960 ###### declare terminals
4961         $TERM use
4962
4963 ###### SimpleStatement Grammar
4964         | use Expression ${
4965                 $0 = b = new_pos(binode, $1);
4966                 b->op = Use;
4967                 b->right = $<2;
4968         }$
4969
4970 ###### print binode cases
4971
4972         case Use:
4973                 do_indent(indent, "use ");
4974                 print_exec(b->right, -1, bracket);
4975                 if (indent >= 0)
4976                         printf("\n");
4977                 break;
4978
4979 ###### propagate binode cases
4980
4981         case Use:
4982                 /* result matches value */
4983                 return propagate_types(b->right, c, perr, type, 0);
4984
4985 ###### interp binode cases
4986
4987         case Use:
4988                 rv = interp_exec(c, b->right, &rvtype);
4989                 break;
4990
4991 ### The Conditional Statement
4992
4993 This is the biggy and currently the only complex statement.  This
4994 subsumes `if`, `while`, `do/while`, `switch`, and some parts of `for`.
4995 It is comprised of a number of parts, all of which are optional though
4996 set combinations apply.  Each part is (usually) a key word (`then` is
4997 sometimes optional) followed by either an expression or a code block,
4998 except the `casepart` which is a "key word and an expression" followed
4999 by a code block.  The code-block option is valid for all parts and,
5000 where an expression is also allowed, the code block can use the `use`
5001 statement to report a value.  If the code block does not report a value
5002 the effect is similar to reporting `True`.
5003
5004 The `else` and `case` parts, as well as `then` when combined with
5005 `if`, can contain a `use` statement which will apply to some
5006 containing conditional statement. `for` parts, `do` parts and `then`
5007 parts used with `for` can never contain a `use`, except in some
5008 subordinate conditional statement.
5009
5010 If there is a `forpart`, it is executed first, only once.
5011 If there is a `dopart`, then it is executed repeatedly providing
5012 always that the `condpart` or `cond`, if present, does not return a non-True
5013 value.  `condpart` can fail to return any value if it simply executes
5014 to completion.  This is treated the same as returning `True`.
5015
5016 If there is a `thenpart` it will be executed whenever the `condpart`
5017 or `cond` returns True (or does not return any value), but this will happen
5018 *after* `dopart` (when present).
5019
5020 If `elsepart` is present it will be executed at most once when the
5021 condition returns `False` or some value that isn't `True` and isn't
5022 matched by any `casepart`.  If there are any `casepart`s, they will be
5023 executed when the condition returns a matching value.
5024
5025 The particular sorts of values allowed in case parts has not yet been
5026 determined in the language design, so nothing is prohibited.
5027
5028 The various blocks in this complex statement potentially provide scope
5029 for variables as described earlier.  Each such block must include the
5030 "OpenScope" nonterminal before parsing the block, and must call
5031 `var_block_close()` when closing the block.
5032
5033 The code following "`if`", "`switch`" and "`for`" does not get its own
5034 scope, but is in a scope covering the whole statement, so names
5035 declared there cannot be redeclared elsewhere.  Similarly the
5036 condition following "`while`" is in a scope the covers the body
5037 ("`do`" part) of the loop, and which does not allow conditional scope
5038 extension.  Code following "`then`" (both looping and non-looping),
5039 "`else`" and "`case`" each get their own local scope.
5040
5041 The type requirements on the code block in a `whilepart` are quite
5042 unusal.  It is allowed to return a value of some identifiable type, in
5043 which case the loop aborts and an appropriate `casepart` is run, or it
5044 can return a Boolean, in which case the loop either continues to the
5045 `dopart` (on `True`) or aborts and runs the `elsepart` (on `False`).
5046 This is different both from the `ifpart` code block which is expected to
5047 return a Boolean, or the `switchpart` code block which is expected to
5048 return the same type as the casepart values.  The correct analysis of
5049 the type of the `whilepart` code block is the reason for the
5050 `Rboolok` flag which is passed to `propagate_types()`.
5051
5052 The `cond_statement` cannot fit into a `binode` so a new `exec` is
5053 defined.  As there are two scopes which cover multiple parts - one for
5054 the whole statement and one for "while" and "do" - and as we will use
5055 the 'struct exec' to track scopes, we actually need two new types of
5056 exec.  One is a `binode` for the looping part, the rest is the
5057 `cond_statement`.  The `cond_statement` will use an auxilliary `struct
5058 casepart` to track a list of case parts.
5059
5060 ###### Binode types
5061         Loop
5062
5063 ###### exec type
5064         Xcond_statement,
5065
5066 ###### ast
5067         struct casepart {
5068                 struct exec *value;
5069                 struct exec *action;
5070                 struct casepart *next;
5071         };
5072         struct cond_statement {
5073                 struct exec;
5074                 struct exec *forpart, *condpart, *thenpart, *elsepart;
5075                 struct binode *looppart;
5076                 struct casepart *casepart;
5077         };
5078
5079 ###### ast functions
5080
5081         static void free_casepart(struct casepart *cp)
5082         {
5083                 while (cp) {
5084                         struct casepart *t;
5085                         free_exec(cp->value);
5086                         free_exec(cp->action);
5087                         t = cp->next;
5088                         free(cp);
5089                         cp = t;
5090                 }
5091         }
5092
5093         static void free_cond_statement(struct cond_statement *s)
5094         {
5095                 if (!s)
5096                         return;
5097                 free_exec(s->forpart);
5098                 free_exec(s->condpart);
5099                 free_exec(s->looppart);
5100                 free_exec(s->thenpart);
5101                 free_exec(s->elsepart);
5102                 free_casepart(s->casepart);
5103                 free(s);
5104         }
5105
5106 ###### free exec cases
5107         case Xcond_statement: free_cond_statement(cast(cond_statement, e)); break;
5108
5109 ###### ComplexStatement Grammar
5110         | CondStatement ${ $0 = $<1; }$
5111
5112 ###### declare terminals
5113         $TERM for then while do
5114         $TERM else
5115         $TERM switch case
5116
5117 ###### Grammar
5118
5119         $*cond_statement
5120         // A CondStatement must end with EOL, as does CondSuffix and
5121         // IfSuffix.
5122         // ForPart, ThenPart, SwitchPart, CasePart are non-empty and
5123         // may or may not end with EOL
5124         // WhilePart and IfPart include an appropriate Suffix
5125
5126         // ForPart, SwitchPart, and IfPart open scopes, o we have to close
5127         // them.  WhilePart opens and closes its own scope.
5128         CondStatement -> ForPart OptNL ThenPart OptNL WhilePart CondSuffix ${
5129                 $0 = $<CS;
5130                 $0->forpart = $<FP;
5131                 $0->thenpart = $<TP;
5132                 $0->looppart = $<WP;
5133                 var_block_close(c, CloseSequential, $0);
5134         }$
5135         | ForPart OptNL WhilePart CondSuffix ${
5136                 $0 = $<CS;
5137                 $0->forpart = $<FP;
5138                 $0->looppart = $<WP;
5139                 var_block_close(c, CloseSequential, $0);
5140         }$
5141         | WhilePart CondSuffix ${
5142                 $0 = $<CS;
5143                 $0->looppart = $<WP;
5144         }$
5145         | SwitchPart OptNL CasePart CondSuffix ${
5146                 $0 = $<CS;
5147                 $0->condpart = $<SP;
5148                 $CP->next = $0->casepart;
5149                 $0->casepart = $<CP;
5150                 var_block_close(c, CloseSequential, $0);
5151         }$
5152         | SwitchPart : IN OptNL CasePart CondSuffix OUT Newlines ${
5153                 $0 = $<CS;
5154                 $0->condpart = $<SP;
5155                 $CP->next = $0->casepart;
5156                 $0->casepart = $<CP;
5157                 var_block_close(c, CloseSequential, $0);
5158         }$
5159         | IfPart IfSuffix ${
5160                 $0 = $<IS;
5161                 $0->condpart = $IP.condpart; $IP.condpart = NULL;
5162                 $0->thenpart = $IP.thenpart; $IP.thenpart = NULL;
5163                 // This is where we close an "if" statement
5164                 var_block_close(c, CloseSequential, $0);
5165         }$
5166
5167         CondSuffix -> IfSuffix ${
5168                 $0 = $<1;
5169         }$
5170         | Newlines CasePart CondSuffix ${
5171                 $0 = $<CS;
5172                 $CP->next = $0->casepart;
5173                 $0->casepart = $<CP;
5174         }$
5175         | CasePart CondSuffix ${
5176                 $0 = $<CS;
5177                 $CP->next = $0->casepart;
5178                 $0->casepart = $<CP;
5179         }$
5180
5181         IfSuffix -> Newlines ${ $0 = new(cond_statement); }$
5182         | Newlines ElsePart ${ $0 = $<EP; }$
5183         | ElsePart ${$0 = $<EP; }$
5184
5185         ElsePart -> else OpenBlock Newlines ${
5186                 $0 = new(cond_statement);
5187                 $0->elsepart = $<OB;
5188                 var_block_close(c, CloseElse, $0->elsepart);
5189         }$
5190         | else OpenScope CondStatement ${
5191                 $0 = new(cond_statement);
5192                 $0->elsepart = $<CS;
5193                 var_block_close(c, CloseElse, $0->elsepart);
5194         }$
5195
5196         $*casepart
5197         CasePart -> case Expression OpenScope ColonBlock ${
5198                 $0 = calloc(1,sizeof(struct casepart));
5199                 $0->value = $<Ex;
5200                 $0->action = $<Bl;
5201                 var_block_close(c, CloseParallel, $0->action);
5202         }$
5203
5204         $*exec
5205         // These scopes are closed in CondStatement
5206         ForPart -> for OpenBlock ${
5207                 $0 = $<Bl;
5208         }$
5209
5210         ThenPart -> then OpenBlock ${
5211                 $0 = $<OB;
5212                 var_block_close(c, CloseSequential, $0);
5213         }$
5214
5215         $*binode
5216         // This scope is closed in CondStatement
5217         WhilePart -> while UseBlock OptNL do OpenBlock ${
5218                 $0 = new(binode);
5219                 $0->op = Loop;
5220                 $0->left = $<UB;
5221                 $0->right = $<OB;
5222                 var_block_close(c, CloseSequential, $0->right);
5223                 var_block_close(c, CloseSequential, $0);
5224         }$
5225         | while OpenScope Expression OpenScope ColonBlock ${
5226                 $0 = new(binode);
5227                 $0->op = Loop;
5228                 $0->left = $<Exp;
5229                 $0->right = $<CB;
5230                 var_block_close(c, CloseSequential, $0->right);
5231                 var_block_close(c, CloseSequential, $0);
5232         }$
5233
5234         $cond_statement
5235         IfPart -> if UseBlock OptNL then OpenBlock ${
5236                 $0.condpart = $<UB;
5237                 $0.thenpart = $<OB;
5238                 var_block_close(c, CloseParallel, $0.thenpart);
5239         }$
5240         | if OpenScope Expression OpenScope ColonBlock ${
5241                 $0.condpart = $<Ex;
5242                 $0.thenpart = $<CB;
5243                 var_block_close(c, CloseParallel, $0.thenpart);
5244         }$
5245         | if OpenScope Expression OpenScope OptNL then Block ${
5246                 $0.condpart = $<Ex;
5247                 $0.thenpart = $<Bl;
5248                 var_block_close(c, CloseParallel, $0.thenpart);
5249         }$
5250
5251         $*exec
5252         // This scope is closed in CondStatement
5253         SwitchPart -> switch OpenScope Expression ${
5254                 $0 = $<Ex;
5255         }$
5256         | switch UseBlock ${
5257                 $0 = $<Bl;
5258         }$
5259
5260 ###### print binode cases
5261         case Loop:
5262                 if (b->left && b->left->type == Xbinode &&
5263                     cast(binode, b->left)->op == Block) {
5264                         if (bracket)
5265                                 do_indent(indent, "while {\n");
5266                         else
5267                                 do_indent(indent, "while\n");
5268                         print_exec(b->left, indent+1, bracket);
5269                         if (bracket)
5270                                 do_indent(indent, "} do {\n");
5271                         else
5272                                 do_indent(indent, "do\n");
5273                         print_exec(b->right, indent+1, bracket);
5274                         if (bracket)
5275                                 do_indent(indent, "}\n");
5276                 } else {
5277                         do_indent(indent, "while ");
5278                         print_exec(b->left, 0, bracket);
5279                         if (bracket)
5280                                 printf(" {\n");
5281                         else
5282                                 printf(":\n");
5283                         print_exec(b->right, indent+1, bracket);
5284                         if (bracket)
5285                                 do_indent(indent, "}\n");
5286                 }
5287                 break;
5288
5289 ###### print exec cases
5290
5291         case Xcond_statement:
5292         {
5293                 struct cond_statement *cs = cast(cond_statement, e);
5294                 struct casepart *cp;
5295                 if (cs->forpart) {
5296                         do_indent(indent, "for");
5297                         if (bracket) printf(" {\n"); else printf("\n");
5298                         print_exec(cs->forpart, indent+1, bracket);
5299                         if (cs->thenpart) {
5300                                 if (bracket)
5301                                         do_indent(indent, "} then {\n");
5302                                 else
5303                                         do_indent(indent, "then\n");
5304                                 print_exec(cs->thenpart, indent+1, bracket);
5305                         }
5306                         if (bracket) do_indent(indent, "}\n");
5307                 }
5308                 if (cs->looppart) {
5309                         print_exec(cs->looppart, indent, bracket);
5310                 } else {
5311                         // a condition
5312                         if (cs->casepart)
5313                                 do_indent(indent, "switch");
5314                         else
5315                                 do_indent(indent, "if");
5316                         if (cs->condpart && cs->condpart->type == Xbinode &&
5317                             cast(binode, cs->condpart)->op == Block) {
5318                                 if (bracket)
5319                                         printf(" {\n");
5320                                 else
5321                                         printf("\n");
5322                                 print_exec(cs->condpart, indent+1, bracket);
5323                                 if (bracket)
5324                                         do_indent(indent, "}\n");
5325                                 if (cs->thenpart) {
5326                                         do_indent(indent, "then\n");
5327                                         print_exec(cs->thenpart, indent+1, bracket);
5328                                 }
5329                         } else {
5330                                 printf(" ");
5331                                 print_exec(cs->condpart, 0, bracket);
5332                                 if (cs->thenpart) {
5333                                         if (bracket)
5334                                                 printf(" {\n");
5335                                         else
5336                                                 printf(":\n");
5337                                         print_exec(cs->thenpart, indent+1, bracket);
5338                                         if (bracket)
5339                                                 do_indent(indent, "}\n");
5340                                 } else
5341                                         printf("\n");
5342                         }
5343                 }
5344                 for (cp = cs->casepart; cp; cp = cp->next) {
5345                         do_indent(indent, "case ");
5346                         print_exec(cp->value, -1, 0);
5347                         if (bracket)
5348                                 printf(" {\n");
5349                         else
5350                                 printf(":\n");
5351                         print_exec(cp->action, indent+1, bracket);
5352                         if (bracket)
5353                                 do_indent(indent, "}\n");
5354                 }
5355                 if (cs->elsepart) {
5356                         do_indent(indent, "else");
5357                         if (bracket)
5358                                 printf(" {\n");
5359                         else
5360                                 printf("\n");
5361                         print_exec(cs->elsepart, indent+1, bracket);
5362                         if (bracket)
5363                                 do_indent(indent, "}\n");
5364                 }
5365                 break;
5366         }
5367
5368 ###### propagate binode cases
5369         case Loop:
5370                 t = propagate_types(b->right, c, perr_local, Tnone, 0);
5371                 if (!type_compat(Tnone, t, 0))
5372                         *perr |= Efail; // UNTESTED
5373                 return propagate_types(b->left, c, perr, type, rules);
5374
5375 ###### propagate exec cases
5376         case Xcond_statement:
5377         {
5378                 // forpart and looppart->right must return Tnone
5379                 // thenpart must return Tnone if there is a loopart,
5380                 // otherwise it is like elsepart.
5381                 // condpart must:
5382                 //    be bool if there is no casepart
5383                 //    match casepart->values if there is a switchpart
5384                 //    either be bool or match casepart->value if there
5385                 //             is a whilepart
5386                 // elsepart and casepart->action must match the return type
5387                 //   expected of this statement.
5388                 struct cond_statement *cs = cast(cond_statement, prog);
5389                 struct casepart *cp;
5390
5391                 t = propagate_types(cs->forpart, c, perr, Tnone, 0);
5392                 if (!type_compat(Tnone, t, 0))
5393                         *perr |= Efail; // UNTESTED
5394
5395                 if (cs->looppart) {
5396                         t = propagate_types(cs->thenpart, c, perr, Tnone, 0);
5397                         if (!type_compat(Tnone, t, 0))
5398                                 *perr |= Efail; // UNTESTED
5399                 }
5400                 if (cs->casepart == NULL) {
5401                         propagate_types(cs->condpart, c, perr, Tbool, 0);
5402                         propagate_types(cs->looppart, c, perr, Tbool, 0);
5403                 } else {
5404                         /* Condpart must match case values, with bool permitted */
5405                         t = NULL;
5406                         for (cp = cs->casepart;
5407                              cp && !t; cp = cp->next)
5408                                 t = propagate_types(cp->value, c, perr, NULL, 0);
5409                         if (!t && cs->condpart)
5410                                 t = propagate_types(cs->condpart, c, perr, NULL, Rboolok);      // UNTESTED
5411                         if (!t && cs->looppart)
5412                                 t = propagate_types(cs->looppart, c, perr, NULL, Rboolok);      // UNTESTED
5413                         // Now we have a type (I hope) push it down
5414                         if (t) {
5415                                 for (cp = cs->casepart; cp; cp = cp->next)
5416                                         propagate_types(cp->value, c, perr, t, 0);
5417                                 propagate_types(cs->condpart, c, perr, t, Rboolok);
5418                                 propagate_types(cs->looppart, c, perr, t, Rboolok);
5419                         }
5420                 }
5421                 // (if)then, else, and case parts must return expected type.
5422                 if (!cs->looppart && !type)
5423                         type = propagate_types(cs->thenpart, c, perr, NULL, rules);
5424                 if (!type)
5425                         type = propagate_types(cs->elsepart, c, perr, NULL, rules);
5426                 for (cp = cs->casepart;
5427                      cp && !type;
5428                      cp = cp->next)     // UNTESTED
5429                         type = propagate_types(cp->action, c, perr, NULL, rules);       // UNTESTED
5430                 if (type) {
5431                         if (!cs->looppart)
5432                                 propagate_types(cs->thenpart, c, perr, type, rules);
5433                         propagate_types(cs->elsepart, c, perr, type, rules);
5434                         for (cp = cs->casepart; cp ; cp = cp->next)
5435                                 propagate_types(cp->action, c, perr, type, rules);
5436                         return type;
5437                 } else
5438                         return NULL;
5439         }
5440
5441 ###### interp binode cases
5442         case Loop:
5443                 // This just performs one iterration of the loop
5444                 rv = interp_exec(c, b->left, &rvtype);
5445                 if (rvtype == Tnone ||
5446                     (rvtype == Tbool && rv.bool != 0))
5447                         // rvtype is Tnone or Tbool, doesn't need to be freed
5448                         interp_exec(c, b->right, NULL);
5449                 break;
5450
5451 ###### interp exec cases
5452         case Xcond_statement:
5453         {
5454                 struct value v, cnd;
5455                 struct type *vtype, *cndtype;
5456                 struct casepart *cp;
5457                 struct cond_statement *cs = cast(cond_statement, e);
5458
5459                 if (cs->forpart)
5460                         interp_exec(c, cs->forpart, NULL);
5461                 if (cs->looppart) {
5462                         while ((cnd = interp_exec(c, cs->looppart, &cndtype)),
5463                                cndtype == Tnone || (cndtype == Tbool && cnd.bool != 0))
5464                                 interp_exec(c, cs->thenpart, NULL);
5465                 } else {
5466                         cnd = interp_exec(c, cs->condpart, &cndtype);
5467                         if ((cndtype == Tnone ||
5468                             (cndtype == Tbool && cnd.bool != 0))) {
5469                                 // cnd is Tnone or Tbool, doesn't need to be freed
5470                                 rv = interp_exec(c, cs->thenpart, &rvtype);
5471                                 // skip else (and cases)
5472                                 goto Xcond_done;
5473                         }
5474                 }
5475                 for (cp = cs->casepart; cp; cp = cp->next) {
5476                         v = interp_exec(c, cp->value, &vtype);
5477                         if (value_cmp(cndtype, vtype, &v, &cnd) == 0) {
5478                                 free_value(vtype, &v);
5479                                 free_value(cndtype, &cnd);
5480                                 rv = interp_exec(c, cp->action, &rvtype);
5481                                 goto Xcond_done;
5482                         }
5483                         free_value(vtype, &v);
5484                 }
5485                 free_value(cndtype, &cnd);
5486                 if (cs->elsepart)
5487                         rv = interp_exec(c, cs->elsepart, &rvtype);
5488                 else
5489                         rvtype = Tnone;
5490         Xcond_done:
5491                 break;
5492         }
5493
5494 ### Top level structure
5495
5496 All the language elements so far can be used in various places.  Now
5497 it is time to clarify what those places are.
5498
5499 At the top level of a file there will be a number of declarations.
5500 Many of the things that can be declared haven't been described yet,
5501 such as functions, procedures, imports, and probably more.
5502 For now there are two sorts of things that can appear at the top
5503 level.  They are predefined constants, `struct` types, and the `main`
5504 function.  While the syntax will allow the `main` function to appear
5505 multiple times, that will trigger an error if it is actually attempted.
5506
5507 The various declarations do not return anything.  They store the
5508 various declarations in the parse context.
5509
5510 ###### Parser: grammar
5511
5512         $void
5513         Ocean -> OptNL DeclarationList
5514
5515         ## declare terminals
5516
5517         OptNL ->
5518         | OptNL NEWLINE
5519
5520         Newlines -> NEWLINE
5521         | Newlines NEWLINE
5522
5523         DeclarationList -> Declaration
5524         | DeclarationList Declaration
5525
5526         Declaration -> ERROR Newlines ${
5527                 tok_err(c,      // UNTESTED
5528                         "error: unhandled parse error", &$1);
5529         }$
5530         | DeclareConstant
5531         | DeclareFunction
5532         | DeclareStruct
5533
5534         ## top level grammar
5535
5536         ## Grammar
5537
5538 ### The `const` section
5539
5540 As well as being defined in with the code that uses them, constants can
5541 be declared at the top level.  These have full-file scope, so they are
5542 always `InScope`, even before(!) they have been declared.  The value of
5543 a top level constant can be given as an expression, and this is
5544 evaluated after parsing and before execution.
5545
5546 A function call can be used to evaluate a constant, but it will not have
5547 access to any program state, once such statement becomes meaningful.
5548 e.g.  arguments and filesystem will not be visible.
5549
5550 Constants are defined in a section that starts with the reserved word
5551 `const` and then has a block with a list of assignment statements.
5552 For syntactic consistency, these must use the double-colon syntax to
5553 make it clear that they are constants.  Type can also be given: if
5554 not, the type will be determined during analysis, as with other
5555 constants.
5556
5557 ###### parse context
5558         struct binode *constlist;
5559
5560 ###### top level grammar
5561
5562         $TERM const
5563
5564         DeclareConstant -> const { IN OptNL ConstList OUT OptNL } Newlines
5565         | const { SimpleConstList } Newlines
5566         | const IN OptNL ConstList OUT Newlines
5567         | const SimpleConstList Newlines
5568
5569         ConstList -> ConstList SimpleConstLine
5570         | SimpleConstLine
5571
5572         SimpleConstList -> SimpleConstList ; Const
5573         | Const
5574         | SimpleConstList ;
5575
5576         SimpleConstLine -> SimpleConstList Newlines
5577         | ERROR Newlines ${ tok_err(c, "Syntax error in constant", &$1); }$
5578
5579         $*type
5580         CType -> Type   ${ $0 = $<1; }$
5581         |               ${ $0 = NULL; }$
5582
5583         $void
5584         Const -> IDENTIFIER :: CType = Expression ${ {
5585                 struct variable *v;
5586                 struct binode *bl, *bv;
5587                 struct var *var = new_pos(var, $ID);
5588
5589                 v = var_decl(c, $ID.txt);
5590                 if (v) {
5591                         v->where_decl = var;
5592                         v->where_set = var;
5593                         v->type = $<CT;
5594                         v->constant = 1;
5595                         v->global = 1;
5596                 } else {
5597                         v = var_ref(c, $1.txt);
5598                         if (v->type == Tnone) {
5599                                 v->where_decl = var;
5600                                 v->where_set = var;
5601                                 v->type = $<CT;
5602                                 v->constant = 1;
5603                                 v->global = 1;
5604                         } else {
5605                                 tok_err(c, "error: name already declared", &$1);
5606                                 type_err(c, "info: this is where '%v' was first declared",
5607                                          v->where_decl, NULL, 0, NULL);
5608                         }
5609                 }
5610                 var->var = v;
5611
5612                 bv = new(binode);
5613                 bv->op = Declare;
5614                 bv->left = var;
5615                 bv->right= $<Exp;
5616
5617                 bl = new(binode);
5618                 bl->op = List;
5619                 bl->left = c->constlist;
5620                 bl->right = bv;
5621                 c->constlist = bl;
5622         } }$
5623
5624 ###### core functions
5625         static void resolve_consts(struct parse_context *c)
5626         {
5627                 struct binode *b;
5628                 int retry = 1;
5629                 enum { none, some, cannot } progress = none;
5630
5631                 c->constlist = reorder_bilist(c->constlist);
5632                 while (retry) {
5633                         retry = 0;
5634                         for (b = cast(binode, c->constlist); b;
5635                              b = cast(binode, b->right)) {
5636                                 enum prop_err perr;
5637                                 struct binode *vb = cast(binode, b->left);
5638                                 struct var *v = cast(var, vb->left);
5639                                 if (v->var->frame_pos >= 0)
5640                                         continue;
5641                                 do {
5642                                         perr = 0;
5643                                         propagate_types(vb->right, c, &perr,
5644                                                         v->var->type, 0);
5645                                 } while (perr & Eretry);
5646                                 if (perr & Efail)
5647                                         c->parse_error += 1;
5648                                 else if (!(perr & Eruntime)) {
5649                                         progress = some;
5650                                         struct value res = interp_exec(
5651                                                 c, vb->right, &v->var->type);
5652                                         global_alloc(c, v->var->type, v->var, &res);
5653                                 } else {
5654                                         if (progress == cannot)
5655                                                 type_err(c, "error: const %v cannot be resolved.",
5656                                                          v, NULL, 0, NULL);
5657                                         else
5658                                                 retry = 1;
5659                                 }
5660                         }
5661                         switch (progress) {
5662                         case cannot:
5663                                 retry = 0; break;
5664                         case none:
5665                                 progress = cannot; break;
5666                         case some:
5667                                 progress = none; break;
5668                         }
5669                 }
5670         }
5671
5672 ###### print const decls
5673         {
5674                 struct binode *b;
5675                 int first = 1;
5676
5677                 for (b = cast(binode, context.constlist); b;
5678                      b = cast(binode, b->right)) {
5679                         struct binode *vb = cast(binode, b->left);
5680                         struct var *vr = cast(var, vb->left);
5681                         struct variable *v = vr->var;
5682
5683                         if (first)
5684                                 printf("const\n");
5685                         first = 0;
5686
5687                         printf("    %.*s :: ", v->name->name.len, v->name->name.txt);
5688                         type_print(v->type, stdout);
5689                         printf(" = ");
5690                         print_exec(vb->right, -1, 0);
5691                         printf("\n");
5692                 }
5693         }
5694
5695 ###### free const decls
5696         free_binode(context.constlist);
5697
5698 ### Function declarations
5699
5700 The code in an Ocean program is all stored in function declarations.
5701 One of the functions must be named `main` and it must accept an array of
5702 strings as a parameter - the command line arguments.
5703
5704 As this is the top level, several things are handled a bit differently.
5705 The function is not interpreted by `interp_exec` as that isn't passed
5706 the argument list which the program requires.  Similarly type analysis
5707 is a bit more interesting at this level.
5708
5709 ###### ast functions
5710
5711         static struct type *handle_results(struct parse_context *c,
5712                                            struct binode *results)
5713         {
5714                 /* Create a 'struct' type from the results list, which
5715                  * is a list for 'struct var'
5716                  */
5717                 struct type *t = add_anon_type(c, &structure_prototype,
5718                                                "function result");
5719                 int cnt = 0;
5720                 struct binode *b;
5721
5722                 for (b = results; b; b = cast(binode, b->right))
5723                         cnt += 1;
5724                 t->structure.nfields = cnt;
5725                 t->structure.fields = calloc(cnt, sizeof(struct field));
5726                 cnt = 0;
5727                 for (b = results; b; b = cast(binode, b->right)) {
5728                         struct var *v = cast(var, b->left);
5729                         struct field *f = &t->structure.fields[cnt++];
5730                         int a = v->var->type->align;
5731                         f->name = v->var->name->name;
5732                         f->type = v->var->type;
5733                         f->init = NULL;
5734                         f->offset = t->size;
5735                         v->var->frame_pos = f->offset;
5736                         t->size += ((f->type->size - 1) | (a-1)) + 1;
5737                         if (a > t->align)
5738                                 t->align = a;
5739                         variable_unlink_exec(v->var);
5740                 }
5741                 free_binode(results);
5742                 return t;
5743         }
5744
5745         static struct variable *declare_function(struct parse_context *c,
5746                                                 struct variable *name,
5747                                                 struct binode *args,
5748                                                 struct type *ret,
5749                                                 struct binode *results,
5750                                                 struct exec *code)
5751         {
5752                 if (name) {
5753                         struct value fn = {.function = code};
5754                         struct type *t;
5755                         var_block_close(c, CloseFunction, code);
5756                         t = add_anon_type(c, &function_prototype,
5757                                           "func %.*s", name->name->name.len,
5758                                           name->name->name.txt);
5759                         name->type = t;
5760                         t->function.params = reorder_bilist(args);
5761                         if (!ret) {
5762                                 ret = handle_results(c, reorder_bilist(results));
5763                                 t->function.inline_result = 1;
5764                                 t->function.local_size = ret->size;
5765                         }
5766                         t->function.return_type = ret;
5767                         global_alloc(c, t, name, &fn);
5768                         name->type->function.scope = c->out_scope;
5769                 } else {
5770                         free_binode(args);
5771                         free_type(ret);
5772                         free_exec(code);
5773                         var_block_close(c, CloseFunction, NULL);
5774                 }
5775                 c->out_scope = NULL;
5776                 return name;
5777         }
5778
5779 ###### declare terminals
5780         $TERM return
5781
5782 ###### top level grammar
5783
5784         $*variable
5785         DeclareFunction -> func FuncName ( OpenScope ArgsLine ) Block Newlines ${
5786                 $0 = declare_function(c, $<FN, $<Ar, Tnone, NULL, $<Bl);
5787         }$
5788         | func FuncName IN OpenScope Args OUT OptNL do Block Newlines ${
5789                 $0 = declare_function(c, $<FN, $<Ar, Tnone, NULL, $<Bl);
5790         }$
5791         | func FuncName NEWLINE OpenScope OptNL do Block Newlines ${
5792                 $0 = declare_function(c, $<FN, NULL, Tnone, NULL, $<Bl);
5793         }$
5794         | func FuncName ( OpenScope ArgsLine ) : Type Block Newlines ${
5795                 $0 = declare_function(c, $<FN, $<Ar, $<Ty, NULL, $<Bl);
5796         }$
5797         | func FuncName ( OpenScope ArgsLine ) : ( ArgsLine ) Block Newlines ${
5798                 $0 = declare_function(c, $<FN, $<AL, NULL, $<AL2, $<Bl);
5799         }$
5800         | func FuncName IN OpenScope Args OUT OptNL return Type Newlines do Block Newlines ${
5801                 $0 = declare_function(c, $<FN, $<Ar, $<Ty, NULL, $<Bl);
5802         }$
5803         | func FuncName NEWLINE OpenScope return Type Newlines do Block Newlines ${
5804                 $0 = declare_function(c, $<FN, NULL, $<Ty, NULL, $<Bl);
5805         }$
5806         | func FuncName IN OpenScope Args OUT OptNL return IN Args OUT OptNL do Block Newlines ${
5807                 $0 = declare_function(c, $<FN, $<Ar, NULL, $<Ar2, $<Bl);
5808         }$
5809         | func FuncName NEWLINE OpenScope return IN Args OUT OptNL do Block Newlines ${
5810                 $0 = declare_function(c, $<FN, NULL, NULL, $<Ar, $<Bl);
5811         }$
5812
5813 ###### print func decls
5814         {
5815                 struct variable *v;
5816                 int target = -1;
5817
5818                 while (target != 0) {
5819                         int i = 0;
5820                         for (v = context.in_scope; v; v=v->in_scope)
5821                                 if (v->depth == 0 && v->type && v->type->check_args) {
5822                                         i += 1;
5823                                         if (i == target)
5824                                                 break;
5825                                 }
5826
5827                         if (target == -1) {
5828                                 target = i;
5829                         } else {
5830                                 struct value *val = var_value(&context, v);
5831                                 printf("func %.*s", v->name->name.len, v->name->name.txt);
5832                                 v->type->print_type_decl(v->type, stdout);
5833                                 if (brackets)
5834                                         print_exec(val->function, 0, brackets);
5835                                 else
5836                                         print_value(v->type, val, stdout);
5837                                 printf("/* frame size %d */\n", v->type->function.local_size);
5838                                 target -= 1;
5839                         }
5840                 }
5841         }
5842
5843 ###### core functions
5844
5845         static int analyse_funcs(struct parse_context *c)
5846         {
5847                 struct variable *v;
5848                 int all_ok = 1;
5849                 for (v = c->in_scope; v; v = v->in_scope) {
5850                         struct value *val;
5851                         struct type *ret;
5852                         enum prop_err perr;
5853                         if (v->depth != 0 || !v->type || !v->type->check_args)
5854                                 continue;
5855                         ret = v->type->function.inline_result ?
5856                                 Tnone : v->type->function.return_type;
5857                         val = var_value(c, v);
5858                         do {
5859                                 perr = 0;
5860                                 propagate_types(val->function, c, &perr, ret, 0);
5861                         } while (!(perr & Efail) && (perr & Eretry));
5862                         if (!(perr & Efail))
5863                                 /* Make sure everything is still consistent */
5864                                 propagate_types(val->function, c, &perr, ret, 0);
5865                         if (perr & Efail)
5866                                 all_ok = 0;
5867                         if (!v->type->function.inline_result &&
5868                             !v->type->function.return_type->dup) {
5869                                 type_err(c, "error: function cannot return value of type %1",
5870                                          v->where_decl, v->type->function.return_type, 0, NULL);
5871                         }
5872
5873                         scope_finalize(c, v->type);
5874                 }
5875                 return all_ok;
5876         }
5877
5878         static int analyse_main(struct type *type, struct parse_context *c)
5879         {
5880                 struct binode *bp = type->function.params;
5881                 struct binode *b;
5882                 enum prop_err perr;
5883                 int arg = 0;
5884                 struct type *argv_type;
5885
5886                 argv_type = add_anon_type(c, &array_prototype, "argv");
5887                 argv_type->array.member = Tstr;
5888                 argv_type->array.unspec = 1;
5889
5890                 for (b = bp; b; b = cast(binode, b->right)) {
5891                         perr = 0;
5892                         switch (arg++) {
5893                         case 0: /* argv */
5894                                 propagate_types(b->left, c, &perr, argv_type, 0);
5895                                 break;
5896                         default: /* invalid */  // NOTEST
5897                                 propagate_types(b->left, c, &perr, Tnone, 0);   // NOTEST
5898                         }
5899                         if (perr & Efail)
5900                                 c->parse_error += 1;
5901                 }
5902
5903                 return !c->parse_error;
5904         }
5905
5906         static void interp_main(struct parse_context *c, int argc, char **argv)
5907         {
5908                 struct value *progp = NULL;
5909                 struct text main_name = { "main", 4 };
5910                 struct variable *mainv;
5911                 struct binode *al;
5912                 int anum = 0;
5913                 struct value v;
5914                 struct type *vtype;
5915
5916                 mainv = var_ref(c, main_name);
5917                 if (mainv)
5918                         progp = var_value(c, mainv);
5919                 if (!progp || !progp->function) {
5920                         fprintf(stderr, "oceani: no main function found.\n");
5921                         c->parse_error += 1;
5922                         return;
5923                 }
5924                 if (!analyse_main(mainv->type, c)) {
5925                         fprintf(stderr, "oceani: main has wrong type.\n");
5926                         c->parse_error += 1;
5927                         return;
5928                 }
5929                 al = mainv->type->function.params;
5930
5931                 c->local_size = mainv->type->function.local_size;
5932                 c->local = calloc(1, c->local_size);
5933                 while (al) {
5934                         struct var *v = cast(var, al->left);
5935                         struct value *vl = var_value(c, v->var);
5936                         struct value arg;
5937                         struct type *t;
5938                         int i;
5939
5940                         switch (anum++) {
5941                         case 0: /* argv */
5942                                 t = v->var->type;
5943                                 t->array.size = argc;
5944                                 t->prepare_type(c, t, 0);
5945                                 array_init(v->var->type, vl);
5946                                 for (i = 0; i < argc; i++) {
5947                                         struct value *vl2 = vl->array + i * v->var->type->array.member->size;
5948
5949                                         arg.str.txt = argv[i];
5950                                         arg.str.len = strlen(argv[i]);
5951                                         free_value(Tstr, vl2);
5952                                         dup_value(Tstr, &arg, vl2);
5953                                 }
5954                                 break;
5955                         }
5956                         al = cast(binode, al->right);
5957                 }
5958                 v = interp_exec(c, progp->function, &vtype);
5959                 free_value(vtype, &v);
5960                 free(c->local);
5961                 c->local = NULL;
5962         }
5963
5964 ###### ast functions
5965         void free_variable(struct variable *v)
5966         {
5967         }
5968
5969 ## And now to test it out.
5970
5971 Having a language requires having a "hello world" program.  I'll
5972 provide a little more than that: a program that prints "Hello world"
5973 finds the GCD of two numbers, prints the first few elements of
5974 Fibonacci, performs a binary search for a number, and a few other
5975 things which will likely grow as the languages grows.
5976
5977 ###### File: oceani.mk
5978         demos :: sayhello
5979         sayhello : oceani
5980                 @echo "===== DEMO ====="
5981                 ./oceani --section "demo: hello" oceani.mdc 55 33
5982
5983 ###### demo: hello
5984
5985         const
5986                 pi ::= 3.141_592_6
5987                 four ::= 2 + 2 ; five ::= 10/2
5988         const pie ::= "I like Pie";
5989                 cake ::= "The cake is"
5990                   ++ " a lie"
5991
5992         struct fred
5993                 size:[four]number
5994                 name:string
5995                 alive:Boolean
5996
5997         func main(argv:[]string)
5998                 print "Hello World, what lovely oceans you have!"
5999                 print "Are there", five, "?"
6000                 print pi, pie, "but", cake
6001
6002                 A := $argv[1]; B := $argv[2]
6003
6004                 /* When a variable is defined in both branches of an 'if',
6005                  * and used afterwards, the variables are merged.
6006                  */
6007                 if A > B:
6008                         bigger := "yes"
6009                 else
6010                         bigger := "no"
6011                 print "Is", A, "bigger than", B,"? ", bigger
6012                 /* If a variable is not used after the 'if', no
6013                  * merge happens, so types can be different
6014                  */
6015                 if A > B * 2:
6016                         double:string = "yes"
6017                         print A, "is more than twice", B, "?", double
6018                 else
6019                         double := B*2
6020                         print "double", B, "is", double
6021
6022                 a : number
6023                 a = A;
6024                 b:number = B
6025                 if a > 0 and then b > 0:
6026                         while a != b:
6027                                 if a < b:
6028                                         b = b - a
6029                                 else
6030                                         a = a - b
6031                         print "GCD of", A, "and", B,"is", a
6032                 else if a <= 0:
6033                         print a, "is not positive, cannot calculate GCD"
6034                 else
6035                         print b, "is not positive, cannot calculate GCD"
6036
6037                 for
6038                         togo := 10
6039                         f1 := 1; f2 := 1
6040                         print "Fibonacci:", f1,f2,
6041                 then togo = togo - 1
6042                 while togo > 0:
6043                         f3 := f1 + f2
6044                         print "", f3,
6045                         f1 = f2
6046                         f2 = f3
6047                 print ""
6048
6049                 /* Binary search... */
6050                 for
6051                         lo:= 0; hi := 100
6052                         target := 77
6053                 while
6054                         mid := (lo + hi) / 2
6055                         if mid == target:
6056                                 use .Found
6057                         if mid < target:
6058                                 lo = mid
6059                         else
6060                                 hi = mid
6061                         if hi - lo < 1:
6062                                 lo = mid
6063                                 use .GiveUp
6064                         use True
6065                 do pass
6066                 case .Found:
6067                         print "Yay, I found", target
6068                 case .GiveUp:
6069                         print "Closest I found was", lo
6070
6071                 size::= 10
6072                 list:[size]number
6073                 list[0] = 1234
6074                 // "middle square" PRNG.  Not particularly good, but one my
6075                 // Dad taught me - the first one I ever heard of.
6076                 for i:=1; then i = i + 1; while i < size:
6077                         n := list[i-1] * list[i-1]
6078                         list[i] = (n / 100) % 10 000
6079
6080                 print "Before sort:",
6081                 for i:=0; then i = i + 1; while i < size:
6082                         print "", list[i],
6083                 print
6084
6085                 for i := 1; then i=i+1; while i < size:
6086                         for j:=i-1; then j=j-1; while j >= 0:
6087                                 if list[j] > list[j+1]:
6088                                         t:= list[j]
6089                                         list[j] = list[j+1]
6090                                         list[j+1] = t
6091                 print " After sort:",
6092                 for i:=0; then i = i + 1; while i < size:
6093                         print "", list[i],
6094                 print
6095
6096                 if 1 == 2 then print "yes"; else print "no"
6097
6098                 bob:fred
6099                 bob.name = "Hello"
6100                 bob.alive = (bob.name == "Hello")
6101                 print "bob", "is" if  bob.alive else "isn't", "alive"