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 Elements that are present purely to make a usable language, and
  45 without any expectation that they will remain, are the "program'
  46 clause, which provides a list of variables to received command-line
  47 arguments, and the "print" statement which performs simple output.
  48
  49 The current scalar types are "number", "Boolean", and "string".
  50 Boolean will likely stay in its current form, the other two might, but
  51 could just as easily be changed.
  52
  53 ## Naming
  54
  55 Versions of the interpreter which obviously do not support a complete
  56 language will be named after creeks and streams.  This one is Jamison
  57 Creek.
  58
  59 Once we have something reasonably resembling a complete language, the
  60 names of rivers will be used.
  61 Early versions of the compiler will be named after seas.  Major
  62 releases of the compiler will be named after oceans.  Hopefully I will
  63 be finished once I get to the Pacific Ocean release.
  64
  65 ## Outline
  66
  67 As well as parsing and executing a program, the interpreter can print
  68 out the program from the parsed internal structure.  This is useful
  69 for validating the parsing.
  70 So the main requirements of the interpreter are:
  71
  72 - Parse the program, possibly with tracing,
  73 - Analyse the parsed program to ensure consistency,
  74 - Print the program,
  75 - Execute the program, if no parsing or consistency errors were found.
  76
  77 This is all performed by a single C program extracted with
  78 `parsergen`.
  79
  80 There will be two formats for printing the program: a default and one
  81 that uses bracketing.  So a `--bracket` command line option is needed
  82 for that.  Normally the first code section found is used, however an
  83 alternate section can be requested so that a file (such as this one)
  84 can contain multiple programs This is effected with the `--section`
  85 option.
  86
  87 This code must be compiled with `-fplan9-extensions` so that anonymous
  88 structures can be used.
  89
  90 ###### File: oceani.mk
  91
  92         myCFLAGS := -Wall -g -fplan9-extensions
  93         CFLAGS := $(filter-out $(myCFLAGS),$(CFLAGS)) $(myCFLAGS)
  94         myLDLIBS:= libparser.o libscanner.o libmdcode.o -licuuc
  95         LDLIBS := $(filter-out $(myLDLIBS),$(LDLIBS)) $(myLDLIBS)
  96         ## libs
  97         all :: $(LDLIBS) oceani
  98         oceani.c oceani.h : oceani.mdc parsergen
  99                 ./parsergen -o oceani --LALR --tag Parser oceani.mdc
 100         oceani.mk: oceani.mdc md2c
 101                 ./md2c oceani.mdc
 102
 103         oceani: oceani.o $(LDLIBS)
 104                 $(CC) $(CFLAGS) -o oceani oceani.o $(LDLIBS)
 105
 106 ###### Parser: header
 107         ## macros
 108         ## ast
 109         struct parse_context {
 110                 struct token_config config;
 111                 char *file_name;
 112                 int parse_error;
 113                 struct exec *prog;
 114                 ## parse context
 115         };
 116
 117 ###### macros
 118
 119         #define container_of(ptr, type, member) ({                      \
 120                 const typeof( ((type *)0)->member ) *__mptr = (ptr);    \
 121                 (type *)( (char *)__mptr - offsetof(type,member) );})
 122
 123         #define config2context(_conf) container_of(_conf, struct parse_context, \
 124                 config)
 125
 126 ###### Parser: code
 127
 128         #include <unistd.h>
 129         #include <stdlib.h>
 130         #include <fcntl.h>
 131         #include <errno.h>
 132         #include <sys/mman.h>
 133         #include <string.h>
 134         #include <stdio.h>
 135         #include <locale.h>
 136         #include <malloc.h>
 137         #include "mdcode.h"
 138         #include "scanner.h"
 139         #include "parser.h"
 140
 141         ## includes
 142
 143         #include "oceani.h"
 144
 145         ## forward decls
 146         ## value functions
 147         ## ast functions
 148         ## core functions
 149
 150         #include <getopt.h>
 151         static char Usage[] = "Usage: oceani --trace --print --noexec --brackets"
 152                               "--section=SectionName prog.ocn\n";
 153         static const struct option long_options[] = {
 154                 {"trace",     0, NULL, 't'},
 155                 {"print",     0, NULL, 'p'},
 156                 {"noexec",    0, NULL, 'n'},
 157                 {"brackets",  0, NULL, 'b'},
 158                 {"section",   1, NULL, 's'},
 159                 {NULL,        0, NULL, 0},
 160         };
 161         const char *options = "tpnbs";
 162         int main(int argc, char *argv[])
 163         {
 164                 int fd;
 165                 int len;
 166                 char *file;
 167                 struct section *s, *ss;
 168                 char *section = NULL;
 169                 struct parse_context context = {
 170                         .config = {
 171                                 .ignored = (1 << TK_line_comment)
 172                                          | (1 << TK_block_comment)
 173                                          | (1 << TK_mark),
 174                                 .number_chars = ".,_+- ",
 175                                 .word_start = "_",
 176                                 .word_cont = "_",
 177                         },
 178                 };
 179                 int doprint=0, dotrace=0, doexec=1, brackets=0;
 180                 int opt;
 181                 while ((opt = getopt_long(argc, argv, options, long_options, NULL))
 182                        != -1) {
 183                         switch(opt) {
 184                         case 't': dotrace=1; break;
 185                         case 'p': doprint=1; break;
 186                         case 'n': doexec=0; break;
 187                         case 'b': brackets=1; break;
 188                         case 's': section = optarg; break;
 189                         default: fprintf(stderr, Usage);
 190                                 exit(1);
 191                         }
 192                 }
 193                 if (optind >= argc) {
 194                         fprintf(stderr, "oceani: no input file given\n");
 195                         exit(1);
 196                 }
 197                 fd = open(argv[optind], O_RDONLY);
 198                 if (fd < 0) {
 199                         fprintf(stderr, "oceani: cannot open %s\n", argv[optind]);
 200                         exit(1);
 201                 }
 202                 context.file_name = argv[optind];
 203                 len = lseek(fd, 0, 2);
 204                 file = mmap(NULL, len, PROT_READ, MAP_SHARED, fd, 0);
 205                 s = code_extract(file, file+len, NULL);
 206                 if (!s) {
 207                         fprintf(stderr, "oceani: could not find any code in %s\n",
 208                                 argv[optind]);
 209                         exit(1);
 210                 }
 211
 212                 ## context initialization
 213
 214                 if (section) {
 215                         for (ss = s; ss; ss = ss->next) {
 216                                 struct text sec = ss->section;
 217                                 if (sec.len == strlen(section) &&
 218                                     strncmp(sec.txt, section, sec.len) == 0)
 219                                         break;
 220                         }
 221                         if (!ss) {
 222                                 fprintf(stderr, "oceani: cannot find section %s\n",
 223                                         section);
 224                                 exit(1);
 225                         }
 226                 } else
 227                         ss = s;
 228                 parse_oceani(ss->code, &context.config, dotrace ? stderr : NULL);
 229
 230                 if (!context.prog) {
 231                         fprintf(stderr, "oceani: no program found.\n");
 232                         context.parse_error = 1;
 233                 }
 234                 if (context.prog && doprint) {
 235                         ## print const decls
 236                         ## print type decls
 237                         print_exec(context.prog, 0, brackets);
 238                 }
 239                 if (context.prog && doexec && !context.parse_error) {
 240                         if (!analyse_prog(context.prog, &context)) {
 241                                 fprintf(stderr, "oceani: type error in program - not running.\n");
 242                                 exit(1);
 243                         }
 244                         interp_prog(context.prog, argv+optind+1);
 245                 }
 246                 free_exec(context.prog);
 247
 248                 while (s) {
 249                         struct section *t = s->next;
 250                         code_free(s->code);
 251                         free(s);
 252                         s = t;
 253                 }
 254                 ## free context vars
 255                 ## free context types
 256                 exit(context.parse_error ? 1 : 0);
 257         }
 258
 259 ### Analysis
 260
 261 The four requirements of parse, analyse, print, interpret apply to
 262 each language element individually so that is how most of the code
 263 will be structured.
 264
 265 Three of the four are fairly self explanatory.  The one that requires
 266 a little explanation is the analysis step.
 267
 268 The current language design does not require the types of variables to
 269 be declared, but they must still have a single type.  Different
 270 operations impose different requirements on the variables, for example
 271 addition requires both arguments to be numeric, and assignment
 272 requires the variable on the left to have the same type as the
 273 expression on the right.
 274
 275 Analysis involves propagating these type requirements around and
 276 consequently setting the type of each variable.  If any requirements
 277 are violated (e.g. a string is compared with a number) or if a
 278 variable needs to have two different types, then an error is raised
 279 and the program will not run.
 280
 281 If the same variable is declared in both branchs of an 'if/else', or
 282 in all cases of a 'switch' then the multiple instances may be merged
 283 into just one variable if the variable is references after the
 284 conditional statement.  When this happens, the types must naturally be
 285 consistent across all the branches.  When the variable is not used
 286 outside the if, the variables in the different branches are distinct
 287 and can be of different types.
 288
 289 Determining the types of all variables early is important for
 290 processing command line arguments.  These can be assigned to any of
 291 several types of variable, but we must first know the correct type so
 292 any required conversion can happen.  If a variable is associated with
 293 a command line argument but no type can be interpreted (e.g. the
 294 variable is only ever used in a `print` statement), then the type is
 295 set to 'string'.
 296
 297 Undeclared names may only appear in "use" statements and "case" expressions.
 298 These names are given a type of "label" and a unique value.
 299 This allows them to fill the role of a name in an enumerated type, which
 300 is useful for testing the `switch` statement.
 301
 302 As we will see, the condition part of a `while` statement can return
 303 either a Boolean or some other type.  This requires that the expected
 304 type that gets passed around comprises a type and a flag to indicate
 305 that `Tbool` is also permitted.
 306
 307 As there are, as yet, no distinct types that are compatible, there
 308 isn't much subtlety in the analysis.  When we have distinct number
 309 types, this will become more interesting.
 310
 311 #### Error reporting
 312
 313 When analysis discovers an inconsistency it needs to report an error;
 314 just refusing to run the code ensures that the error doesn't cascade,
 315 but by itself it isn't very useful.  A clear understanding of the sort
 316 of error message that are useful will help guide the process of
 317 analysis.
 318
 319 At a simplistic level, the only sort of error that type analysis can
 320 report is that the type of some construct doesn't match a contextual
 321 requirement.  For example, in `4 + "hello"` the addition provides a
 322 contextual requirement for numbers, but `"hello"` is not a number.  In
 323 this particular example no further information is needed as the types
 324 are obvious from local information.  When a variable is involved that
 325 isn't the case.  It may be helpful to explain why the variable has a
 326 particular type, by indicating the location where the type was set,
 327 whether by declaration or usage.
 328
 329 Using a recursive-descent analysis we can easily detect a problem at
 330 multiple locations. In "`hello:= "there"; 4 + hello`" the addition
 331 will detect that one argument is not a number and the usage of `hello`
 332 will detect that a number was wanted, but not provided.  In this
 333 (early) version of the language, we will generate error reports at
 334 multiple locations, so the use of `hello` will report an error and
 335 explain were the value was set, and the addition will report an error
 336 and say why numbers are needed.  To be able to report locations for
 337 errors, each language element will need to record a file location
 338 (line and column) and each variable will need to record the language
 339 element where its type was set.  For now we will assume that each line
 340 of an error message indicates one location in the file, and up to 2
 341 types.  So we provide a `printf`-like function which takes a format, a
 342 language (a `struct exec` which has not yet been introduced), and 2
 343 types. "`%1`" reports the first type, "`%2`" reports the second.  We
 344 will need a function to print the location, once we know how that is
 345 stored.  As will be explained later, there are sometimes extra rules for
 346 type matching and they might affect error messages, we need to pass those
 347 in too.
 348
 349 As well as type errors, we sometimes need to report problems with
 350 tokens, which might be unexpected or might name a type that has not
 351 been defined.  For these we have `tok_err()` which reports an error
 352 with a given token.  Each of the error functions sets the flag in the
 353 context so indicate that parsing failed.
 354
 355 ###### forward decls
 356
 357         static void fput_loc(struct exec *loc, FILE *f);
 358
 359 ###### core functions
 360
 361         static void type_err(struct parse_context *c,
 362                              char *fmt, struct exec *loc,
 363                              struct type *t1, int rules, struct type *t2)
 364         {
 365                 fprintf(stderr, "%s:", c->file_name);
 366                 fput_loc(loc, stderr);
 367                 for (; *fmt ; fmt++) {
 368                         if (*fmt != '%') {
 369                                 fputc(*fmt, stderr);
 370                                 continue;
 371                         }
 372                         fmt++;
 373                         switch (*fmt) {
 374                         case '%': fputc(*fmt, stderr); break;   // NOTEST
 375                         default: fputc('?', stderr); break;     // NOTEST
 376                         case '1':
 377                                 type_print(t1, stderr);
 378                                 break;
 379                         case '2':
 380                                 type_print(t2, stderr);
 381                                 break;
 382                         ## format cases
 383                         }
 384                 }
 385                 fputs("\n", stderr);
 386                 c->parse_error = 1;
 387         }
 388
 389         static void tok_err(struct parse_context *c, char *fmt, struct token *t)
 390         {
 391                 fprintf(stderr, "%s:%d:%d: %s: %.*s\n", c->file_name, t->line, t->col, fmt,
 392                         t->txt.len, t->txt.txt);
 393                 c->parse_error = 1;
 394         }
 395
 396 ## Entities: declared and predeclared.
 397
 398 There are various "things" that the language and/or the interpreter
 399 needs to know about to parse and execute a program.  These include
 400 types, variables, values, and executable code.  These are all lumped
 401 together under the term "entities" (calling them "objects" would be
 402 confusing) and introduced here.  These will introduced and described
 403 here.  The following section will present the different specific code
 404 elements which comprise or manipulate these various entities.
 405
 406 ### Types
 407
 408 Values come in a wide range of types, with more likely to be added.
 409 Each type needs to be able to parse and print its own values (for
 410 convenience at least) as well as to compare two values, at least for
 411 equality and possibly for order.  For now, values might need to be
 412 duplicated and freed, though eventually such manipulations will be
 413 better integrated into the language.
 414
 415 Rather than requiring every numeric type to support all numeric
 416 operations (add, multiple, etc), we allow types to be able to present
 417 as one of a few standard types: integer, float, and fraction.  The
 418 existence of these conversion functions eventaully enable types to
 419 determine if they are compatible with other types, though such types
 420 have not yet been implemented.
 421
 422 Named type are stored in a simple linked list.  Objects of each type are "values"
 423 which are often passed around by value.
 424
 425 ###### ast
 426
 427         struct value {
 428                 struct type *type;
 429                 union {
 430                         ## value union fields
 431                 };
 432         };
 433
 434         struct type {
 435                 struct text name;
 436                 struct type *next;
 437                 struct value (*init)(struct type *type);
 438                 struct value (*prepare)(struct type *type);
 439                 struct value (*parse)(struct type *type, char *str);
 440                 void (*print)(struct value val);
 441                 void (*print_type)(struct type *type, FILE *f);
 442                 int (*cmp_order)(struct value v1, struct value v2);
 443                 int (*cmp_eq)(struct value v1, struct value v2);
 444                 struct value (*dup)(struct value val);
 445                 void (*free)(struct value val);
 446                 void (*free_type)(struct type *t);
 447                 int (*compat)(struct type *this, struct type *other);
 448                 long long (*to_int)(struct value *v);
 449                 double (*to_float)(struct value *v);
 450                 int (*to_mpq)(mpq_t *q, struct value *v);
 451                 ## type functions
 452                 union {
 453                         ## type union fields
 454                 };
 455         };
 456
 457 ###### parse context
 458
 459         struct type *typelist;
 460
 461 ###### ast functions
 462
 463         static struct type *find_type(struct parse_context *c, struct text s)
 464         {
 465                 struct type *l = c->typelist;
 466
 467                 while (l &&
 468                        text_cmp(l->name, s) != 0)
 469                                 l = l->next;
 470                 return l;
 471         }
 472
 473         static struct type *add_type(struct parse_context *c, struct text s,
 474                                      struct type *proto)
 475         {
 476                 struct type *n;
 477
 478                 n = calloc(1, sizeof(*n));
 479                 *n = *proto;
 480                 n->name = s;
 481                 n->next = c->typelist;
 482                 c->typelist = n;
 483                 return n;
 484         }
 485
 486         static void free_type(struct type *t)
 487         {
 488                 /* The type is always a reference to something in the
 489                  * context, so we don't need to free anything.
 490                  */
 491         }
 492
 493         static void free_value(struct value v)
 494         {
 495                 if (v.type)
 496                         v.type->free(v);
 497         }
 498
 499         static int type_compat(struct type *require, struct type *have, int rules)
 500         {
 501                 if ((rules & Rboolok) && have == Tbool)
 502                         return 1;
 503                 if ((rules & Rnolabel) && have == Tlabel)
 504                         return 0;
 505                 if (!require || !have)
 506                         return 1;
 507
 508                 if (require->compat)
 509                         return require->compat(require, have);
 510
 511                 return require == have;
 512         }
 513
 514         static void type_print(struct type *type, FILE *f)
 515         {
 516                 if (!type)
 517                         fputs("*unknown*type*", f);
 518                 else if (type->name.len)
 519                         fprintf(f, "%.*s", type->name.len, type->name.txt);
 520                 else if (type->print_type)
 521                         type->print_type(type, f);
 522                 else
 523                         fputs("*invalid*type*", f);     // NOTEST
 524         }
 525
 526         static struct value val_prepare(struct type *type)
 527         {
 528                 struct value rv;
 529
 530                 if (type)
 531                         return type->prepare(type);
 532                 rv.type = type;
 533                 return rv;
 534         }
 535
 536         static struct value val_init(struct type *type)
 537         {
 538                 struct value rv;
 539
 540                 if (type)
 541                         return type->init(type);
 542                 rv.type = type;
 543                 return rv;
 544         }
 545
 546         static struct value dup_value(struct value v)
 547         {
 548                 if (v.type)
 549                         return v.type->dup(v);
 550                 return v;
 551         }
 552
 553         static int value_cmp(struct value left, struct value right)
 554         {
 555                 if (left.type && left.type->cmp_order)
 556                         return left.type->cmp_order(left, right);
 557                 if (left.type && left.type->cmp_eq)
 558                         return left.type->cmp_eq(left, right);
 559                 return -1;
 560         }
 561
 562         static void print_value(struct value v)
 563         {
 564                 if (v.type && v.type->print)
 565                         v.type->print(v);
 566                 else
 567                         printf("*Unknown*");            // NOTEST
 568         }
 569
 570         static struct value parse_value(struct type *type, char *arg)
 571         {
 572                 struct value rv;
 573
 574                 if (type && type->parse)
 575                         return type->parse(type, arg);
 576                 rv.type = NULL;                         // NOTEST
 577                 return rv;                              // NOTEST
 578         }
 579
 580 ###### forward decls
 581
 582         static void free_value(struct value v);
 583         static int type_compat(struct type *require, struct type *have, int rules);
 584         static void type_print(struct type *type, FILE *f);
 585         static struct value val_init(struct type *type);
 586         static struct value dup_value(struct value v);
 587         static int value_cmp(struct value left, struct value right);
 588         static void print_value(struct value v);
 589         static struct value parse_value(struct type *type, char *arg);
 590
 591 ###### free context types
 592
 593         while (context.typelist) {
 594                 struct type *t = context.typelist;
 595
 596                 context.typelist = t->next;
 597                 if (t->free_type)
 598                         t->free_type(t);
 599                 free(t);
 600         }
 601
 602 #### Base Types
 603
 604 Values of the base types can be numbers, which we represent as
 605 multi-precision fractions, strings, Booleans and labels.  When
 606 analysing the program we also need to allow for places where no value
 607 is meaningful (type `Tnone`) and where we don't know what type to
 608 expect yet (type is `NULL`).
 609
 610 Values are never shared, they are always copied when used, and freed
 611 when no longer needed.
 612
 613 When propagating type information around the program, we need to
 614 determine if two types are compatible, where type `NULL` is compatible
 615 with anything.  There are two special cases with type compatibility,
 616 both related to the Conditional Statement which will be described
 617 later.  In some cases a Boolean can be accepted as well as some other
 618 primary type, and in others any type is acceptable except a label (`Vlabel`).
 619 A separate function encoding these cases will simplify some code later.
 620
 621 When assigning command line arguments to variables, we need to be able
 622 to parse each type from a string.
 623
 624 The distinction beteen "prepare" and "init" needs to be explained.
 625 "init" sets up an initial value, such as "zero" or the empty string.
 626 "prepare" simply prepares the data structure so that if "free" gets
 627 called on it, it won't do something silly.  Normally a value will be
 628 stored after "prepare" but before "free", but this might not happen if
 629 there are errors.
 630
 631 ###### includes
 632         #include <gmp.h>
 633         #include "string.h"
 634         #include "number.h"
 635
 636 ###### libs
 637         myLDLIBS := libnumber.o libstring.o -lgmp
 638         LDLIBS := $(filter-out $(myLDLIBS),$(LDLIBS)) $(myLDLIBS)
 639
 640 ###### type union fields
 641         enum vtype {Vnone, Vstr, Vnum, Vbool, Vlabel} vtype;
 642
 643 ###### value union fields
 644         struct text str;
 645         mpq_t num;
 646         int bool;
 647         void *label;
 648
 649 ###### ast functions
 650         static void _free_value(struct value v)
 651         {
 652                 switch (v.type->vtype) {
 653                 case Vnone: break;
 654                 case Vstr: free(v.str.txt); break;
 655                 case Vnum: mpq_clear(v.num); break;
 656                 case Vlabel:
 657                 case Vbool: break;
 658                 }
 659         }
 660
 661 ###### value functions
 662
 663         static struct value _val_prepare(struct type *type)
 664         {
 665                 struct value rv;
 666
 667                 rv.type = type;
 668                 switch(type->vtype) {
 669                 case Vnone:
 670                         break;
 671                 case Vnum:
 672                         memset(&rv.num, 0, sizeof(rv.num));
 673                         break;
 674                 case Vstr:
 675                         rv.str.txt = NULL;
 676                         rv.str.len = 0;
 677                         break;
 678                 case Vbool:
 679                         rv.bool = 0;
 680                         break;
 681                 case Vlabel:
 682                         rv.label = NULL;
 683                         break;
 684                 }
 685                 return rv;
 686         }
 687
 688         static struct value _val_init(struct type *type)
 689         {
 690                 struct value rv;
 691
 692                 rv.type = type;
 693                 switch(type->vtype) {
 694                 case Vnone:             // NOTEST
 695                         break;          // NOTEST
 696                 case Vnum:
 697                         mpq_init(rv.num); break;
 698                 case Vstr:
 699                         rv.str.txt = malloc(1);
 700                         rv.str.len = 0;
 701                         break;
 702                 case Vbool:
 703                         rv.bool = 0;
 704                         break;
 705                 case Vlabel:                    // NOTEST
 706                         rv.label = NULL;        // NOTEST
 707                         break;                  // NOTEST
 708                 }
 709                 return rv;
 710         }
 711
 712         static struct value _dup_value(struct value v)
 713         {
 714                 struct value rv;
 715                 rv.type = v.type;
 716                 switch (rv.type->vtype) {
 717                 case Vnone:             // NOTEST
 718                         break;          // NOTEST
 719                 case Vlabel:
 720                         rv.label = v.label;
 721                         break;
 722                 case Vbool:
 723                         rv.bool = v.bool;
 724                         break;
 725                 case Vnum:
 726                         mpq_init(rv.num);
 727                         mpq_set(rv.num, v.num);
 728                         break;
 729                 case Vstr:
 730                         rv.str.len = v.str.len;
 731                         rv.str.txt = malloc(rv.str.len);
 732                         memcpy(rv.str.txt, v.str.txt, v.str.len);
 733                         break;
 734                 }
 735                 return rv;
 736         }
 737
 738         static int _value_cmp(struct value left, struct value right)
 739         {
 740                 int cmp;
 741                 if (left.type != right.type)
 742                         return left.type - right.type;  // NOTEST
 743                 switch (left.type->vtype) {
 744                 case Vlabel: cmp = left.label == right.label ? 0 : 1; break;
 745                 case Vnum: cmp = mpq_cmp(left.num, right.num); break;
 746                 case Vstr: cmp = text_cmp(left.str, right.str); break;
 747                 case Vbool: cmp = left.bool - right.bool; break;
 748                 case Vnone: cmp = 0;                    // NOTEST
 749                 }
 750                 return cmp;
 751         }
 752
 753         static void _print_value(struct value v)
 754         {
 755                 switch (v.type->vtype) {
 756                 case Vnone:                             // NOTEST
 757                         printf("*no-value*"); break;    // NOTEST
 758                 case Vlabel:                            // NOTEST
 759                         printf("*label-%p*", v.label); break; // NOTEST
 760                 case Vstr:
 761                         printf("%.*s", v.str.len, v.str.txt); break;
 762                 case Vbool:
 763                         printf("%s", v.bool ? "True":"False"); break;
 764                 case Vnum:
 765                         {
 766                         mpf_t fl;
 767                         mpf_init2(fl, 20);
 768                         mpf_set_q(fl, v.num);
 769                         gmp_printf("%Fg", fl);
 770                         mpf_clear(fl);
 771                         break;
 772                         }
 773                 }
 774         }
 775
 776         static struct value _parse_value(struct type *type, char *arg)
 777         {
 778                 struct value val;
 779                 struct text tx;
 780                 int neg = 0;
 781                 char tail[3] = "";
 782
 783                 val.type = type;
 784                 switch(type->vtype) {
 785                 case Vlabel:                            // NOTEST
 786                 case Vnone:                             // NOTEST
 787                         val.type = NULL;                // NOTEST
 788                         break;                          // NOTEST
 789                 case Vstr:
 790                         val.str.len = strlen(arg);
 791                         val.str.txt = malloc(val.str.len);
 792                         memcpy(val.str.txt, arg, val.str.len);
 793                         break;
 794                 case Vnum:
 795                         if (*arg == '-') {
 796                                 neg = 1;
 797                                 arg++;
 798                         }
 799                         tx.txt = arg; tx.len = strlen(tx.txt);
 800                         if (number_parse(val.num, tail, tx) == 0)
 801                                 mpq_init(val.num);
 802                         else if (neg)
 803                                 mpq_neg(val.num, val.num);
 804                         if (tail[0]) {
 805                                 printf("Unsupported suffix: %s\n", arg);
 806                                 val.type = NULL;
 807                         }
 808                         break;
 809                 case Vbool:
 810                         if (strcasecmp(arg, "true") == 0 ||
 811                             strcmp(arg, "1") == 0)
 812                                 val.bool = 1;
 813                         else if (strcasecmp(arg, "false") == 0 ||
 814                                  strcmp(arg, "0") == 0)
 815                                 val.bool = 0;
 816                         else {
 817                                 printf("Bad bool: %s\n", arg);
 818                                 val.type = NULL;
 819                         }
 820                         break;
 821                 }
 822                 return val;
 823         }
 824
 825         static void _free_value(struct value v);
 826
 827         static struct type base_prototype = {
 828                 .init = _val_init,
 829                 .prepare = _val_prepare,
 830                 .parse = _parse_value,
 831                 .print = _print_value,
 832                 .cmp_order = _value_cmp,
 833                 .cmp_eq = _value_cmp,
 834                 .dup = _dup_value,
 835                 .free = _free_value,
 836         };
 837
 838         static struct type *Tbool, *Tstr, *Tnum, *Tnone, *Tlabel;
 839
 840 ###### ast functions
 841         static struct type *add_base_type(struct parse_context *c, char *n, enum vtype vt)
 842         {
 843                 struct text txt = { n, strlen(n) };
 844                 struct type *t;
 845
 846                 t = add_type(c, txt, &base_prototype);
 847                 t->vtype = vt;
 848                 return t;
 849         }
 850
 851 ###### context initialization
 852
 853         Tbool  = add_base_type(&context, "Boolean", Vbool);
 854         Tstr   = add_base_type(&context, "string", Vstr);
 855         Tnum   = add_base_type(&context, "number", Vnum);
 856         Tnone  = add_base_type(&context, "none", Vnone);
 857         Tlabel = add_base_type(&context, "label", Vlabel);
 858
 859 ### Variables
 860
 861 Variables are scoped named values.  We store the names in a linked
 862 list of "bindings" sorted lexically, and use sequential search and
 863 insertion sort.
 864
 865 ###### ast
 866
 867         struct binding {
 868                 struct text name;
 869                 struct binding *next;   // in lexical order
 870                 ## binding fields
 871         };
 872
 873 This linked list is stored in the parse context so that "reduce"
 874 functions can find or add variables, and so the analysis phase can
 875 ensure that every variable gets a type.
 876
 877 ###### parse context
 878
 879         struct binding *varlist;  // In lexical order
 880
 881 ###### ast functions
 882
 883         static struct binding *find_binding(struct parse_context *c, struct text s)
 884         {
 885                 struct binding **l = &c->varlist;
 886                 struct binding *n;
 887                 int cmp = 1;
 888
 889                 while (*l &&
 890                         (cmp = text_cmp((*l)->name, s)) < 0)
 891                                 l = & (*l)->next;
 892                 if (cmp == 0)
 893                         return *l;
 894                 n = calloc(1, sizeof(*n));
 895                 n->name = s;
 896                 n->next = *l;
 897                 *l = n;
 898                 return n;
 899         }
 900
 901 Each name can be linked to multiple variables defined in different
 902 scopes.  Each scope starts where the name is declared and continues
 903 until the end of the containing code block.  Scopes of a given name
 904 cannot nest, so a declaration while a name is in-scope is an error.
 905
 906 ###### binding fields
 907         struct variable *var;
 908
 909 ###### ast
 910         struct variable {
 911                 struct variable *previous;
 912                 struct value val;
 913                 struct binding *name;
 914                 struct exec *where_decl;// where name was declared
 915                 struct exec *where_set; // where type was set
 916                 ## variable fields
 917         };
 918
 919 While the naming seems strange, we include local constants in the
 920 definition of variables.  A name declared `var := value` can
 921 subsequently be changed, but a name declared `var ::= value` cannot -
 922 it is constant
 923
 924 ###### variable fields
 925         int constant;
 926
 927 Scopes in parallel branches can be partially merged.  More
 928 specifically, if a given name is declared in both branches of an
 929 if/else then its scope is a candidate for merging.  Similarly if
 930 every branch of an exhaustive switch (e.g. has an "else" clause)
 931 declares a given name, then the scopes from the branches are
 932 candidates for merging.
 933
 934 Note that names declared inside a loop (which is only parallel to
 935 itself) are never visible after the loop.  Similarly names defined in
 936 scopes which are not parallel, such as those started by `for` and
 937 `switch`, are never visible after the scope.  Only variables defined in
 938 both `then` and `else` (including the implicit then after an `if`, and
 939 excluding `then` used with `for`) and in all `case`s and `else` of a
 940 `switch` or `while` can be visible beyond the `if`/`switch`/`while`.
 941
 942 Labels, which are a bit like variables, follow different rules.
 943 Labels are not explicitly declared, but if an undeclared name appears
 944 in a context where a label is legal, that effectively declares the
 945 name as a label.  The declaration remains in force (or in scope) at
 946 least to the end of the immediately containing block and conditionally
 947 in any larger containing block which does not declare the name in some
 948 other way.  Importantly, the conditional scope extension happens even
 949 if the label is only used in one parallel branch of a conditional --
 950 when used in one branch it is treated as having been declared in all
 951 branches.
 952
 953 Merge candidates are tentatively visible beyond the end of the
 954 branching statement which creates them.  If the name is used, the
 955 merge is affirmed and they become a single variable visible at the
 956 outer layer.  If not - if it is redeclared first - the merge lapses.
 957
 958 To track scopes we have an extra stack, implemented as a linked list,
 959 which roughly parallels the parse stack and which is used exclusively
 960 for scoping.  When a new scope is opened, a new frame is pushed and
 961 the child-count of the parent frame is incremented.  This child-count
 962 is used to distinguish between the first of a set of parallel scopes,
 963 in which declared variables must not be in scope, and subsequent
 964 branches, whether they must already be conditionally scoped.
 965
 966 To push a new frame *before* any code in the frame is parsed, we need a
 967 grammar reduction.  This is most easily achieved with a grammar
 968 element which derives the empty string, and creates the new scope when
 969 it is recognized.  This can be placed, for example, between a keyword
 970 like "if" and the code following it.
 971
 972 ###### ast
 973         struct scope {
 974                 struct scope *parent;
 975                 int child_count;
 976         };
 977
 978 ###### parse context
 979         int scope_depth;
 980         struct scope *scope_stack;
 981
 982 ###### ast functions
 983         static void scope_pop(struct parse_context *c)
 984         {
 985                 struct scope *s = c->scope_stack;
 986
 987                 c->scope_stack = s->parent;
 988                 free(s);
 989                 c->scope_depth -= 1;
 990         }
 991
 992         static void scope_push(struct parse_context *c)
 993         {
 994                 struct scope *s = calloc(1, sizeof(*s));
 995                 if (c->scope_stack)
 996                         c->scope_stack->child_count += 1;
 997                 s->parent = c->scope_stack;
 998                 c->scope_stack = s;
 999                 c->scope_depth += 1;
1000         }
1001
1002 ###### Grammar
1003
1004         $void
1005         OpenScope -> ${ scope_push(config2context(config)); }$
1006
1007 Each variable records a scope depth and is in one of four states:
1008
1009 - "in scope".  This is the case between the declaration of the
1010   variable and the end of the containing block, and also between
1011   the usage with affirms a merge and the end of that block.
1012
1013   The scope depth is not greater than the current parse context scope
1014   nest depth.  When the block of that depth closes, the state will
1015   change.  To achieve this, all "in scope" variables are linked
1016   together as a stack in nesting order.
1017
1018 - "pending".  The "in scope" block has closed, but other parallel
1019   scopes are still being processed.  So far, every parallel block at
1020   the same level that has closed has declared the name.
1021
1022   The scope depth is the depth of the last parallel block that
1023   enclosed the declaration, and that has closed.
1024
1025 - "conditionally in scope".  The "in scope" block and all parallel
1026   scopes have closed, and no further mention of the name has been
1027   seen.  This state includes a secondary nest depth which records the
1028   outermost scope seen since the variable became conditionally in
1029   scope.  If a use of the name is found, the variable becomes "in
1030   scope" and that secondary depth becomes the recorded scope depth.
1031   If the name is declared as a new variable, the old variable becomes
1032   "out of scope" and the recorded scope depth stays unchanged.
1033
1034 - "out of scope".  The variable is neither in scope nor conditionally
1035   in scope.  It is permanently out of scope now and can be removed from
1036   the "in scope" stack.
1037
1038 ###### variable fields
1039         int depth, min_depth;
1040         enum { OutScope, PendingScope, CondScope, InScope } scope;
1041         struct variable *in_scope;
1042
1043 ###### parse context
1044
1045         struct variable *in_scope;
1046
1047 All variables with the same name are linked together using the
1048 'previous' link.  Those variable that have
1049 been affirmatively merged all have a 'merged' pointer that points to
1050 one primary variable - the most recently declared instance. When
1051 merging variables, we need to also adjust the 'merged' pointer on any
1052 other variables that had previously been merged with the one that will
1053 no longer be primary.
1054
1055 A variable that is no longer the most recent instance of a name may
1056 still have "pending" scope, if it might still be merged with most
1057 recent instance.  These variables don't really belong in the
1058 "in_scope" list, but are not immediately removed when a new instance
1059 is found.  Instead, they are detected and ignored when considering the
1060 list of in_scope names.
1061
1062 ###### variable fields
1063         struct variable *merged;
1064
1065 ###### ast functions
1066
1067         static void variable_merge(struct variable *primary, struct variable *secondary)
1068         {
1069                 struct variable *v;
1070
1071                 if (primary->merged)
1072                         // shouldn't happen
1073                         primary = primary->merged;
1074
1075                 for (v = primary->previous; v; v=v->previous)
1076                         if (v == secondary || v == secondary->merged ||
1077                             v->merged == secondary ||
1078                             (v->merged && v->merged == secondary->merged)) {
1079                                 v->scope = OutScope;
1080                                 v->merged = primary;
1081                         }
1082         }
1083
1084 ###### free context vars
1085
1086         while (context.varlist) {
1087                 struct binding *b = context.varlist;
1088                 struct variable *v = b->var;
1089                 context.varlist = b->next;
1090                 free(b);
1091                 while (v) {
1092                         struct variable *t = v;
1093
1094                         v = t->previous;
1095                         free_value(t->val);
1096                         if (t->min_depth == 0)
1097                                 // This is a global constant
1098                                 free_exec(t->where_decl);
1099                         free(t);
1100                 }
1101         }
1102
1103 #### Manipulating Bindings
1104
1105 When a name is conditionally visible, a new declaration discards the
1106 old binding - the condition lapses.  Conversely a usage of the name
1107 affirms the visibility and extends it to the end of the containing
1108 block - i.e. the block that contains both the original declaration and
1109 the latest usage.  This is determined from `min_depth`.  When a
1110 conditionally visible variable gets affirmed like this, it is also
1111 merged with other conditionally visible variables with the same name.
1112
1113 When we parse a variable declaration we either report an error if the
1114 name is currently bound, or create a new variable at the current nest
1115 depth if the name is unbound or bound to a conditionally scoped or
1116 pending-scope variable.  If the previous variable was conditionally
1117 scoped, it and its homonyms becomes out-of-scope.
1118
1119 When we parse a variable reference (including non-declarative
1120 assignment) we report an error if the name is not bound or is bound to
1121 a pending-scope variable; update the scope if the name is bound to a
1122 conditionally scoped variable; or just proceed normally if the named
1123 variable is in scope.
1124
1125 When we exit a scope, any variables bound at this level are either
1126 marked out of scope or pending-scoped, depending on whether the scope
1127 was sequential or parallel.  Here a "parallel" scope means the "then"
1128 or "else" part of a conditional, or any "case" or "else" branch of a
1129 switch.  Other scopes are "sequential".
1130
1131 When exiting a parallel scope we check if there are any variables that
1132 were previously pending and are still visible. If there are, then
1133 there weren't redeclared in the most recent scope, so they cannot be
1134 merged and must become out-of-scope.  If it is not the first of
1135 parallel scopes (based on `child_count`), we check that there was a
1136 previous binding that is still pending-scope.  If there isn't, the new
1137 variable must now be out-of-scope.
1138
1139 When exiting a sequential scope that immediately enclosed parallel
1140 scopes, we need to resolve any pending-scope variables.  If there was
1141 no `else` clause, and we cannot determine that the `switch` was exhaustive,
1142 we need to mark all pending-scope variable as out-of-scope.  Otherwise
1143 all pending-scope variables become conditionally scoped.
1144
1145 ###### ast
1146         enum closetype { CloseSequential, CloseParallel, CloseElse };
1147
1148 ###### ast functions
1149
1150         static struct variable *var_decl(struct parse_context *c, struct text s)
1151         {
1152                 struct binding *b = find_binding(c, s);
1153                 struct variable *v = b->var;
1154
1155                 switch (v ? v->scope : OutScope) {
1156                 case InScope:
1157                         /* Caller will report the error */
1158                         return NULL;
1159                 case CondScope:
1160                         for (;
1161                              v && v->scope == CondScope;
1162                              v = v->previous)
1163                                 v->scope = OutScope;
1164                         break;
1165                 default: break;
1166                 }
1167                 v = calloc(1, sizeof(*v));
1168                 v->previous = b->var;
1169                 b->var = v;
1170                 v->name = b;
1171                 v->min_depth = v->depth = c->scope_depth;
1172                 v->scope = InScope;
1173                 v->in_scope = c->in_scope;
1174                 c->in_scope = v;
1175                 v->val = val_prepare(NULL);
1176                 return v;
1177         }
1178
1179         static struct variable *var_ref(struct parse_context *c, struct text s)
1180         {
1181                 struct binding *b = find_binding(c, s);
1182                 struct variable *v = b->var;
1183                 struct variable *v2;
1184
1185                 switch (v ? v->scope : OutScope) {
1186                 case OutScope:
1187                 case PendingScope:
1188                         /* Caller will report the error */
1189                         return NULL;
1190                 case CondScope:
1191                         /* All CondScope variables of this name need to be merged
1192                          * and become InScope
1193                          */
1194                         v->depth = v->min_depth;
1195                         v->scope = InScope;
1196                         for (v2 = v->previous;
1197                              v2 && v2->scope == CondScope;
1198                              v2 = v2->previous)
1199                                 variable_merge(v, v2);
1200                         break;
1201                 case InScope:
1202                         break;
1203                 }
1204                 return v;
1205         }
1206
1207         static void var_block_close(struct parse_context *c, enum closetype ct)
1208         {
1209                 /* Close off all variables that are in_scope */
1210                 struct variable *v, **vp, *v2;
1211
1212                 scope_pop(c);
1213                 for (vp = &c->in_scope;
1214                      v = *vp, v && v->depth > c->scope_depth && v->min_depth > c->scope_depth;
1215                      ) {
1216                         if (v->name->var == v) switch (ct) {
1217                         case CloseElse:
1218                         case CloseParallel: /* handle PendingScope */
1219                                 switch(v->scope) {
1220                                 case InScope:
1221                                 case CondScope:
1222                                         if (c->scope_stack->child_count == 1)
1223                                                 v->scope = PendingScope;
1224                                         else if (v->previous &&
1225                                                  v->previous->scope == PendingScope)
1226                                                 v->scope = PendingScope;
1227                                         else if (v->val.type == Tlabel)
1228                                                 v->scope = PendingScope;
1229                                         else if (v->name->var == v)
1230                                                 v->scope = OutScope;
1231                                         if (ct == CloseElse) {
1232                                                 /* All Pending variables with this name
1233                                                  * are now Conditional */
1234                                                 for (v2 = v;
1235                                                      v2 && v2->scope == PendingScope;
1236                                                      v2 = v2->previous)
1237                                                         v2->scope = CondScope;
1238                                         }
1239                                         break;
1240                                 case PendingScope:
1241                                         for (v2 = v;
1242                                              v2 && v2->scope == PendingScope;
1243                                              v2 = v2->previous)
1244                                                 if (v2->val.type != Tlabel)
1245                                                         v2->scope = OutScope;
1246                                         break;
1247                                 case OutScope: break;
1248                                 }
1249                                 break;
1250                         case CloseSequential:
1251                                 if (v->val.type == Tlabel)
1252                                         v->scope = PendingScope;
1253                                 switch (v->scope) {
1254                                 case InScope:
1255                                         v->scope = OutScope;
1256                                         break;
1257                                 case PendingScope:
1258                                         /* There was no 'else', so we can only become
1259                                          * conditional if we know the cases were exhaustive,
1260                                          * and that doesn't mean anything yet.
1261                                          * So only labels become conditional..
1262                                          */
1263                                         for (v2 = v;
1264                                              v2 && v2->scope == PendingScope;
1265                                              v2 = v2->previous)
1266                                                 if (v2->val.type == Tlabel) {
1267                                                         v2->scope = CondScope;
1268                                                         v2->min_depth = c->scope_depth;
1269                                                 } else
1270                                                         v2->scope = OutScope;
1271                                         break;
1272                                 case CondScope:
1273                                 case OutScope: break;
1274                                 }
1275                                 break;
1276                         }
1277                         if (v->scope == OutScope || v->name->var != v)
1278                                 *vp = v->in_scope;
1279                         else
1280                                 vp = &v->in_scope;
1281                 }
1282         }
1283
1284 ### Executables
1285
1286 Executables can be lots of different things.  In many cases an
1287 executable is just an operation combined with one or two other
1288 executables.  This allows for expressions and lists etc.  Other times
1289 an executable is something quite specific like a constant or variable
1290 name.  So we define a `struct exec` to be a general executable with a
1291 type, and a `struct binode` which is a subclass of `exec`, forms a
1292 node in a binary tree, and holds an operation. There will be other
1293 subclasses, and to access these we need to be able to `cast` the
1294 `exec` into the various other types.
1295
1296 ###### macros
1297         #define cast(structname, pointer) ({            \
1298                 const typeof( ((struct structname *)0)->type) *__mptr = &(pointer)->type; \
1299                 if (__mptr && *__mptr != X##structname) abort();                \
1300                 (struct structname *)( (char *)__mptr);})
1301
1302         #define new(structname) ({                                              \
1303                 struct structname *__ptr = ((struct structname *)calloc(1,sizeof(struct structname))); \
1304                 __ptr->type = X##structname;                                            \
1305                 __ptr->line = -1; __ptr->column = -1;                                   \
1306                 __ptr;})
1307
1308         #define new_pos(structname, token) ({                                           \
1309                 struct structname *__ptr = ((struct structname *)calloc(1,sizeof(struct structname))); \
1310                 __ptr->type = X##structname;                                            \
1311                 __ptr->line = token.line; __ptr->column = token.col;                    \
1312                 __ptr;})
1313
1314 ###### ast
1315         enum exec_types {
1316                 Xbinode,
1317                 ## exec type
1318         };
1319         struct exec {
1320                 enum exec_types type;
1321                 int line, column;
1322         };
1323         struct binode {
1324                 struct exec;
1325                 enum Btype {
1326                         ## Binode types
1327                 } op;
1328                 struct exec *left, *right;
1329         };
1330
1331 ###### ast functions
1332
1333         static int __fput_loc(struct exec *loc, FILE *f)
1334         {
1335                 if (!loc)
1336                         return 0;               // NOTEST
1337                 if (loc->line >= 0) {
1338                         fprintf(f, "%d:%d: ", loc->line, loc->column);
1339                         return 1;
1340                 }
1341                 if (loc->type == Xbinode)
1342                         return __fput_loc(cast(binode,loc)->left, f) ||
1343                                __fput_loc(cast(binode,loc)->right, f);
1344                 return 0;
1345         }
1346         static void fput_loc(struct exec *loc, FILE *f)
1347         {
1348                 if (!__fput_loc(loc, f))
1349                         fprintf(f, "??:??: ");  // NOTEST
1350         }
1351
1352 Each different type of `exec` node needs a number of functions
1353 defined, a bit like methods.  We must be able to be able to free it,
1354 print it, analyse it and execute it.  Once we have specific `exec`
1355 types we will need to parse them too.  Let's take this a bit more
1356 slowly.
1357
1358 #### Freeing
1359
1360 The parser generator requires a `free_foo` function for each struct
1361 that stores attributes and they will often be `exec`s and subtypes
1362 there-of.  So we need `free_exec` which can handle all the subtypes,
1363 and we need `free_binode`.
1364
1365 ###### ast functions
1366
1367         static void free_binode(struct binode *b)
1368         {
1369                 if (!b)
1370                         return;
1371                 free_exec(b->left);
1372                 free_exec(b->right);
1373                 free(b);
1374         }
1375
1376 ###### core functions
1377         static void free_exec(struct exec *e)
1378         {
1379                 if (!e)
1380                         return;
1381                 switch(e->type) {
1382                         ## free exec cases
1383                 }
1384         }
1385
1386 ###### forward decls
1387
1388         static void free_exec(struct exec *e);
1389
1390 ###### free exec cases
1391         case Xbinode: free_binode(cast(binode, e)); break;
1392
1393 #### Printing
1394
1395 Printing an `exec` requires that we know the current indent level for
1396 printing line-oriented components.  As will become clear later, we
1397 also want to know what sort of bracketing to use.
1398
1399 ###### ast functions
1400
1401         static void do_indent(int i, char *str)
1402         {
1403                 while (i--)
1404                         printf("    ");
1405                 printf("%s", str);
1406         }
1407
1408 ###### core functions
1409         static void print_binode(struct binode *b, int indent, int bracket)
1410         {
1411                 struct binode *b2;
1412                 switch(b->op) {
1413                 ## print binode cases
1414                 }
1415         }
1416
1417         static void print_exec(struct exec *e, int indent, int bracket)
1418         {
1419                 if (!e)
1420                         return;         // NOTEST
1421                 switch (e->type) {
1422                 case Xbinode:
1423                         print_binode(cast(binode, e), indent, bracket); break;
1424                 ## print exec cases
1425                 }
1426         }
1427
1428 ###### forward decls
1429
1430         static void print_exec(struct exec *e, int indent, int bracket);
1431
1432 #### Analysing
1433
1434 As discussed, analysis involves propagating type requirements around
1435 the program and looking for errors.
1436
1437 So `propagate_types` is passed an expected type (being a `struct type`
1438 pointer together with some `val_rules` flags) that the `exec` is
1439 expected to return, and returns the type that it does return, either
1440 of which can be `NULL` signifying "unknown".  An `ok` flag is passed
1441 by reference. It is set to `0` when an error is found, and `2` when
1442 any change is made.  If it remains unchanged at `1`, then no more
1443 propagation is needed.
1444
1445 ###### ast
1446
1447         enum val_rules {Rnolabel = 1<<0, Rboolok = 1<<1, Rnoconstant = 2<<1};
1448
1449 ###### format cases
1450         case 'r':
1451                 if (rules & Rnolabel)
1452                         fputs(" (labels not permitted)", stderr);
1453                 break;
1454
1455 ###### core functions
1456
1457         static struct type *propagate_types(struct exec *prog, struct parse_context *c, int *ok,
1458                                             struct type *type, int rules)
1459         {
1460                 struct type *t;
1461
1462                 if (!prog)
1463                         return Tnone;
1464
1465                 switch (prog->type) {
1466                 case Xbinode:
1467                 {
1468                         struct binode *b = cast(binode, prog);
1469                         switch (b->op) {
1470                         ## propagate binode cases
1471                         }
1472                         break;
1473                 }
1474                 ## propagate exec cases
1475                 }
1476                 return Tnone;
1477         }
1478
1479 #### Interpreting
1480
1481 Interpreting an `exec` doesn't require anything but the `exec`.  State
1482 is stored in variables and each variable will be directly linked from
1483 within the `exec` tree.  The exception to this is the whole `program`
1484 which needs to look at command line arguments.  The `program` will be
1485 interpreted separately.
1486
1487 Each `exec` can return a value, which may be `Tnone` but must be
1488 non-NULL;  Some `exec`s will return the location of a value, which can
1489 be updates.  To support this, each exec case must store either a value
1490 in `val` or the pointer to a value in `lval`.  If `lval` is set, but a
1491 simple value is required, `inter_exec()` will dereference `lval` to
1492 get the value.
1493
1494 ###### core functions
1495
1496         struct lrval {
1497                 struct value val, *lval;
1498         };
1499
1500         static struct lrval _interp_exec(struct exec *e);
1501
1502         static struct value interp_exec(struct exec *e)
1503         {
1504                 struct lrval ret = _interp_exec(e);
1505
1506                 if (ret.lval)
1507                         return dup_value(*ret.lval);
1508                 else
1509                         return ret.val;
1510         }
1511
1512         static struct value *linterp_exec(struct exec *e)
1513         {
1514                 struct lrval ret = _interp_exec(e);
1515
1516                 return ret.lval;
1517         }
1518
1519         static struct lrval _interp_exec(struct exec *e)
1520         {
1521                 struct lrval ret;
1522                 struct value rv, *lrv = NULL;
1523                 rv.type = Tnone;
1524                 if (!e) {
1525                         ret.lval = lrv;
1526                         ret.val = rv;
1527                         return ret;
1528                 }
1529
1530                 switch(e->type) {
1531                 case Xbinode:
1532                 {
1533                         struct binode *b = cast(binode, e);
1534                         struct value left, right, *lleft;
1535                         left.type = right.type = Tnone;
1536                         switch (b->op) {
1537                         ## interp binode cases
1538                         }
1539                         free_value(left); free_value(right);
1540                         break;
1541                 }
1542                 ## interp exec cases
1543                 }
1544                 ret.lval = lrv;
1545                 ret.val = rv;
1546                 return ret;
1547         }
1548
1549 ### Complex types
1550
1551 Now that we have the shape of the interpreter in place we can add some
1552 complex types and connected them in to the data structures and the
1553 different phases of parse, analyse, print, interpret.
1554
1555 Thus far we have arrays and structs.
1556
1557 #### Arrays
1558
1559 Arrays can be declared by giving a size and a type, as `[size]type' so
1560 `freq:[26]number` declares `freq` to be an array of 26 numbers.  The
1561 size can be an arbitrary expression which is evaluated when the name
1562 comes into scope.
1563
1564 Arrays cannot be assigned.  When pointers are introduced we will also
1565 introduce array slices which can refer to part or all of an array -
1566 the assignment syntax will create a slice.  For now, an array can only
1567 ever be referenced by the name it is declared with.  It is likely that
1568 a "`copy`" primitive will eventually be define which can be used to
1569 make a copy of an array with controllable depth.
1570
1571 ###### type union fields
1572
1573         struct {
1574                 int size;
1575                 struct variable *vsize;
1576                 struct type *member;
1577         } array;
1578
1579 ###### value union fields
1580         struct {
1581                 struct value *elmnts;
1582         } array;
1583
1584 ###### value functions
1585
1586         static struct value array_prepare(struct type *type)
1587         {
1588                 struct value ret;
1589
1590                 ret.type = type;
1591                 ret.array.elmnts = NULL;
1592                 return ret;
1593         }
1594
1595         static struct value array_init(struct type *type)
1596         {
1597                 struct value ret;
1598                 int i;
1599
1600                 ret.type = type;
1601                 if (type->array.vsize) {
1602                         mpz_t q;
1603                         mpz_init(q);
1604                         mpz_tdiv_q(q, mpq_numref(type->array.vsize->val.num),
1605                                    mpq_denref(type->array.vsize->val.num));
1606                         type->array.size = mpz_get_si(q);
1607                         mpz_clear(q);
1608                 }
1609                 ret.array.elmnts = calloc(type->array.size,
1610                                           sizeof(ret.array.elmnts[0]));
1611                 for (i = 0; ret.array.elmnts && i < type->array.size; i++)
1612                         ret.array.elmnts[i] = val_init(type->array.member);
1613                 return ret;
1614         }
1615
1616         static void array_free(struct value val)
1617         {
1618                 int i;
1619
1620                 if (val.array.elmnts)
1621                         for (i = 0; i < val.type->array.size; i++)
1622                                 free_value(val.array.elmnts[i]);
1623                 free(val.array.elmnts);
1624         }
1625
1626         static int array_compat(struct type *require, struct type *have)
1627         {
1628                 if (have->compat != require->compat)
1629                         return 0;
1630                 /* Both are arrays, so we can look at details */
1631                 if (!type_compat(require->array.member, have->array.member, 0))
1632                         return 0;
1633                 if (require->array.vsize == NULL && have->array.vsize == NULL)
1634                         return require->array.size == have->array.size;
1635
1636                 return require->array.vsize == have->array.vsize;
1637         }
1638
1639         static void array_print_type(struct type *type, FILE *f)
1640         {
1641                 fputs("[", f);
1642                 if (type->array.vsize) {
1643                         struct binding *b = type->array.vsize->name;
1644                         fprintf(f, "%.*s]", b->name.len, b->name.txt);
1645                 } else
1646                         fprintf(f, "%d]", type->array.size);
1647                 type_print(type->array.member, f);
1648         }
1649
1650         static struct type array_prototype = {
1651                 .prepare = array_prepare,
1652                 .init = array_init,
1653                 .print_type = array_print_type,
1654                 .compat = array_compat,
1655                 .free = array_free,
1656         };
1657
1658 ###### type grammar
1659
1660         | [ NUMBER ] Type ${
1661                 $0 = calloc(1, sizeof(struct type));
1662                 *($0) = array_prototype;
1663                 $0->array.member = $<4;
1664                 $0->array.vsize = NULL;
1665                 {
1666                 struct parse_context *c = config2context(config);
1667                 char tail[3];
1668                 mpq_t num;
1669                 if (number_parse(num, tail, $2.txt) == 0)
1670                         tok_err(c, "error: unrecognised number", &$2);
1671                 else if (tail[0])
1672                         tok_err(c, "error: unsupported number suffix", &$2);
1673                 else {
1674                         $0->array.size = mpz_get_ui(mpq_numref(num));
1675                         if (mpz_cmp_ui(mpq_denref(num), 1) != 0) {
1676                                 tok_err(c, "error: array size must be an integer",
1677                                         &$2);
1678                         } else if (mpz_cmp_ui(mpq_numref(num), 1UL << 30) >= 0)
1679                                 tok_err(c, "error: array size is too large",
1680                                         &$2);
1681                         mpq_clear(num);
1682                 }
1683                 $0->next= c->anon_typelist;
1684                 c->anon_typelist = $0;
1685                 }
1686         }$
1687
1688         | [ IDENTIFIER ] Type ${ {
1689                 struct parse_context *c = config2context(config);
1690                 struct variable *v = var_ref(c, $2.txt);
1691
1692                 if (!v)
1693                         tok_err(config2context(config), "error: name undeclared", &$2);
1694                 else if (!v->constant)
1695                         tok_err(config2context(config), "error: array size must be a constant", &$2);
1696
1697                 $0 = calloc(1, sizeof(struct type));
1698                 *($0) = array_prototype;
1699                 $0->array.member = $<4;
1700                 $0->array.size = 0;
1701                 $0->array.vsize = v;
1702                 $0->next= c->anon_typelist;
1703                 c->anon_typelist = $0;
1704         } }$
1705
1706 ###### parse context
1707
1708         struct type *anon_typelist;
1709
1710 ###### free context types
1711
1712         while (context.anon_typelist) {
1713                 struct type *t = context.anon_typelist;
1714
1715                 context.anon_typelist = t->next;
1716                 free(t);
1717         }
1718
1719 ###### Binode types
1720         Index,
1721
1722 ###### variable grammar
1723
1724         | Variable [ Expression ] ${ {
1725                 struct binode *b = new(binode);
1726                 b->op = Index;
1727                 b->left = $<1;
1728                 b->right = $<3;
1729                 $0 = b;
1730         } }$
1731
1732 ###### print binode cases
1733         case Index:
1734                 print_exec(b->left, -1, 0);
1735                 printf("[");
1736                 print_exec(b->right, -1, 0);
1737                 printf("]");
1738                 break;
1739
1740 ###### propagate binode cases
1741         case Index:
1742                 /* left must be an array, right must be a number,
1743                  * result is the member type of the array
1744                  */
1745                 propagate_types(b->right, c, ok, Tnum, 0);
1746                 t = propagate_types(b->left, c, ok, NULL, rules & Rnoconstant);
1747                 if (!t || t->compat != array_compat) {
1748                         type_err(c, "error: %1 cannot be indexed", prog, t, 0, NULL);
1749                         *ok = 0;
1750                         return NULL;
1751                 } else {
1752                         if (!type_compat(type, t->array.member, rules)) {
1753                                 type_err(c, "error: have %1 but need %2", prog,
1754                                          t->array.member, rules, type);
1755                                 *ok = 0;
1756                         }
1757                         return t->array.member;
1758                 }
1759                 break;
1760
1761 ###### interp binode cases
1762         case Index: {
1763                 mpz_t q;
1764                 long i;
1765
1766                 lleft = linterp_exec(b->left);
1767                 right = interp_exec(b->right);
1768                 mpz_init(q);
1769                 mpz_tdiv_q(q, mpq_numref(right.num), mpq_denref(right.num));
1770                 i = mpz_get_si(q);
1771                 mpz_clear(q);
1772
1773                 if (i >= 0 && i < lleft->type->array.size)
1774                         lrv = &lleft->array.elmnts[i];
1775                 else
1776                         rv = val_init(lleft->type->array.member);
1777                 break;
1778         }
1779
1780 #### Structs
1781
1782 A `struct` is a data-type that contains one or more other data-types.
1783 It differs from an array in that each member can be of a different
1784 type, and they are accessed by name rather than by number.  Thus you
1785 cannot choose an element by calculation, you need to know what you
1786 want up-front.
1787
1788 The language makes no promises about how a given structure will be
1789 stored in memory - it is free to rearrange fields to suit whatever
1790 criteria seems important.
1791
1792 Structs are declared separately from program code - they cannot be
1793 declared in-line in a variable declaration like arrays can.  A struct
1794 is given a name and this name is used to identify the type - the name
1795 is not prefixed by the word `struct` as it would be in C.
1796
1797 Structs are only treated as the same if they have the same name.
1798 Simply having the same fields in the same order is not enough.  This
1799 might change once we can create structure initializes from a list of
1800 values.
1801
1802 Each component datum is identified much like a variable is declared,
1803 with a name, one or two colons, and a type.  The type cannot be omitted
1804 as there is no opportunity to deduce the type from usage.  An initial
1805 value can be given following an equals sign, so
1806
1807 ##### Example: a struct type
1808
1809         struct complex:
1810                 x:number = 0
1811                 y:number = 0
1812
1813 would declare a type called "complex" which has two number fields,
1814 each initialised to zero.
1815
1816 Struct will need to be declared separately from the code that uses
1817 them, so we will need to be able to print out the declaration of a
1818 struct when reprinting the whole program.  So a `print_type_decl` type
1819 function will be needed.
1820
1821 ###### type union fields
1822
1823         struct {
1824                 int nfields;
1825                 struct field {
1826                         struct text name;
1827                         struct type *type;
1828                         struct value init;
1829                 } *fields;
1830         } structure;
1831
1832 ###### value union fields
1833         struct {
1834                 struct value *fields;
1835         } structure;
1836
1837 ###### type functions
1838         void (*print_type_decl)(struct type *type, FILE *f);
1839
1840 ###### value functions
1841
1842         static struct value structure_prepare(struct type *type)
1843         {
1844                 struct value ret;
1845
1846                 ret.type = type;
1847                 ret.structure.fields = NULL;
1848                 return ret;
1849         }
1850
1851         static struct value structure_init(struct type *type)
1852         {
1853                 struct value ret;
1854                 int i;
1855
1856                 ret.type = type;
1857                 ret.structure.fields = calloc(type->structure.nfields,
1858                                               sizeof(ret.structure.fields[0]));
1859                 for (i = 0; ret.structure.fields && i < type->structure.nfields; i++)
1860                         ret.structure.fields[i] = val_init(type->structure.fields[i].type);
1861                 return ret;
1862         }
1863
1864         static void structure_free(struct value val)
1865         {
1866                 int i;
1867
1868                 if (val.structure.fields)
1869                         for (i = 0; i < val.type->structure.nfields; i++)
1870                                 free_value(val.structure.fields[i]);
1871                 free(val.structure.fields);
1872         }
1873
1874         static void structure_free_type(struct type *t)
1875         {
1876                 int i;
1877                 for (i = 0; i < t->structure.nfields; i++)
1878                         free_value(t->structure.fields[i].init);
1879                 free(t->structure.fields);
1880         }
1881
1882         static struct type structure_prototype = {
1883                 .prepare = structure_prepare,
1884                 .init = structure_init,
1885                 .free = structure_free,
1886                 .free_type = structure_free_type,
1887                 .print_type_decl = structure_print_type,
1888         };
1889
1890 ###### exec type
1891         Xfieldref,
1892
1893 ###### ast
1894         struct fieldref {
1895                 struct exec;
1896                 struct exec *left;
1897                 int index;
1898                 struct text name;
1899         };
1900
1901 ###### free exec cases
1902         case Xfieldref:
1903                 free_exec(cast(fieldref, e)->left);
1904                 free(e);
1905                 break;
1906
1907 ###### variable grammar
1908
1909         | Variable . IDENTIFIER ${ {
1910                 struct fieldref *fr = new_pos(fieldref, $2);
1911                 fr->left = $<1;
1912                 fr->name = $3.txt;
1913                 fr->index = -2;
1914                 $0 = fr;
1915         } }$
1916
1917 ###### print exec cases
1918
1919         case Xfieldref:
1920         {
1921                 struct fieldref *f = cast(fieldref, e);
1922                 print_exec(f->left, -1, 0);
1923                 printf(".%.*s", f->name.len, f->name.txt);
1924                 break;
1925         }
1926
1927 ###### ast functions
1928         static int find_struct_index(struct type *type, struct text field)
1929         {
1930                 int i;
1931                 for (i = 0; i < type->structure.nfields; i++)
1932                         if (text_cmp(type->structure.fields[i].name, field) == 0)
1933                                 return i;
1934                 return -1;
1935         }
1936
1937 ###### propagate exec cases
1938
1939         case Xfieldref:
1940         {
1941                 struct fieldref *f = cast(fieldref, prog);
1942                 struct type *st = propagate_types(f->left, c, ok, NULL, 0);
1943
1944                 if (!st)
1945                         type_err(c, "error: unknown type for field access", f->left,
1946                                  NULL, 0, NULL);
1947                 else if (st->prepare != structure_prepare)
1948                         type_err(c, "error: field reference attempted on %1, not a struct",
1949                                  f->left, st, 0, NULL);
1950                 else if (f->index == -2) {
1951                         f->index = find_struct_index(st, f->name);
1952                         if (f->index < 0) {
1953                                 type_err(c, "error: cannot find requested field in %1",
1954                                          f->left, st, 0, NULL);
1955                                 *ok = 0;
1956                         }
1957                 }
1958                 if (f->index >= 0) {
1959                         struct type *ft = st->structure.fields[f->index].type;
1960                         if (!type_compat(type, ft, rules)) {
1961                                 type_err(c, "error: have %1 but need %2", prog,
1962                                          ft, rules, type);
1963                                 *ok = 0;
1964                         }
1965                         return ft;
1966                 }
1967                 break;
1968         }
1969
1970 ###### interp exec cases
1971         case Xfieldref:
1972         {
1973                 struct fieldref *f = cast(fieldref, e);
1974                 struct value *lleft = linterp_exec(f->left);
1975                 lrv = &lleft->structure.fields[f->index];
1976                 break;
1977         }
1978
1979 ###### ast
1980         struct fieldlist {
1981                 struct fieldlist *prev;
1982                 struct field f;
1983         };
1984
1985 ###### ast functions
1986         static void free_fieldlist(struct fieldlist *f)
1987         {
1988                 if (!f)
1989                         return;
1990                 free_fieldlist(f->prev);
1991                 free_value(f->f.init);
1992                 free(f);
1993         }
1994
1995 ###### top level grammar
1996         DeclareStruct -> struct IDENTIFIER FieldBlock ${ {
1997                 struct type *t =
1998                         add_type(config2context(config), $2.txt, &structure_prototype);
1999                 int cnt = 0;
2000                 struct fieldlist *f;
2001
2002                 for (f = $3; f; f=f->prev)
2003                         cnt += 1;
2004
2005                 t->structure.nfields = cnt;
2006                 t->structure.fields = calloc(cnt, sizeof(struct field));
2007                 f = $3;
2008                 while (cnt > 0) {
2009                         cnt -= 1;
2010                         t->structure.fields[cnt] = f->f;
2011                         f->f.init = val_prepare(Tnone);
2012                         f = f->prev;
2013                 }
2014         } }$
2015
2016         $void
2017         Open -> {
2018                 | NEWLINE Open
2019         Close -> }
2020                 | NEWLINE Close
2021         $*fieldlist
2022         FieldBlock -> Open FieldList Close ${ $0 = $<2; }$
2023                 | Open SimpleFieldList } ${ $0 = $<2; }$
2024                 | : FieldList  ${ $0 = $<2; }$
2025
2026         FieldList -> SimpleFieldList NEWLINE ${ $0 = $<1; }$
2027                 | FieldList SimpleFieldList NEWLINE ${
2028                         $2->prev = $<1;
2029                         $0 = $<2;
2030                 }$
2031
2032         SimpleFieldList -> Field ${ $0 = $<1; }$
2033                 | SimpleFieldList ; Field ${
2034                         $3->prev = $<1;
2035                         $0 = $<3;
2036                 }$
2037                 | SimpleFieldList ; ${
2038                         $0 = $<1;
2039                 }$
2040
2041         Field -> IDENTIFIER : Type = Expression ${ {
2042                         int ok;
2043
2044                         $0 = calloc(1, sizeof(struct fieldlist));
2045                         $0->f.name = $1.txt;
2046                         $0->f.type = $<3;
2047                         $0->f.init = val_prepare($0->f.type);
2048                         do {
2049                                 ok = 1;
2050                                 propagate_types($<5, config2context(config), &ok, $3, 0);
2051                         } while (ok == 2);
2052                         if (!ok)
2053                                 config2context(config)->parse_error = 1;
2054                         else
2055                                 $0->f.init = interp_exec($5);
2056                 } }$
2057                 | IDENTIFIER : Type ${
2058                         $0 = calloc(1, sizeof(struct fieldlist));
2059                         $0->f.name = $1.txt;
2060                         $0->f.type = $<3;
2061                         $0->f.init = val_init($3);
2062                 }$
2063
2064 ###### forward decls
2065         static void structure_print_type(struct type *t, FILE *f);
2066
2067 ###### value functions
2068         static void structure_print_type(struct type *t, FILE *f)
2069         {
2070                 int i;
2071
2072                 fprintf(f, "struct %.*s:\n", t->name.len, t->name.txt);
2073
2074                 for (i = 0; i < t->structure.nfields; i++) {
2075                         struct field *fl = t->structure.fields + i;
2076                         fprintf(f, "    %.*s : ", fl->name.len, fl->name.txt);
2077                         type_print(fl->type, f);
2078                         if (fl->init.type->print) {
2079                                 fprintf(f, " = ");
2080                                 if (fl->init.type == Tstr)
2081                                         fprintf(f, "\"");
2082                                 print_value(fl->init);
2083                                 if (fl->init.type == Tstr)
2084                                         fprintf(f, "\"");
2085                         }
2086                         printf("\n");
2087                 }
2088         }
2089
2090 ###### print type decls
2091         {
2092                 struct type *t;
2093                 int target = -1;
2094
2095                 while (target != 0) {
2096                         int i = 0;
2097                         for (t = context.typelist; t ; t=t->next)
2098                                 if (t->print_type_decl) {
2099                                         i += 1;
2100                                         if (i == target)
2101                                                 break;
2102                                 }
2103
2104                         if (target == -1) {
2105                                 target = i;
2106                         } else {
2107                                 t->print_type_decl(t, stdout);
2108                                 target -= 1;
2109                         }
2110                 }
2111         }
2112
2113 ## Executables: the elements of code
2114
2115 Each code element needs to be parsed, printed, analysed,
2116 interpreted, and freed.  There are several, so let's just start with
2117 the easy ones and work our way up.
2118
2119 ### Values
2120
2121 We have already met values as separate objects.  When manifest
2122 constants appear in the program text, that must result in an executable
2123 which has a constant value.  So the `val` structure embeds a value in
2124 an executable.
2125
2126 ###### exec type
2127         Xval,
2128
2129 ###### ast
2130         struct val {
2131                 struct exec;
2132                 struct value val;
2133         };
2134
2135 ###### Grammar
2136
2137         $*val
2138         Value ->  True ${
2139                         $0 = new_pos(val, $1);
2140                         $0->val.type = Tbool;
2141                         $0->val.bool = 1;
2142                         }$
2143                 | False ${
2144                         $0 = new_pos(val, $1);
2145                         $0->val.type = Tbool;
2146                         $0->val.bool = 0;
2147                         }$
2148                 | NUMBER ${
2149                         $0 = new_pos(val, $1);
2150                         $0->val.type = Tnum;
2151                         {
2152                         char tail[3];
2153                         if (number_parse($0->val.num, tail, $1.txt) == 0)
2154                                 mpq_init($0->val.num);
2155                                 if (tail[0])
2156                                         tok_err(config2context(config), "error: unsupported number suffix",
2157                                                 &$1);
2158                         }
2159                         }$
2160                 | STRING ${
2161                         $0 = new_pos(val, $1);
2162                         $0->val.type = Tstr;
2163                         {
2164                         char tail[3];
2165                         string_parse(&$1, '\\', &$0->val.str, tail);
2166                         if (tail[0])
2167                                 tok_err(config2context(config), "error: unsupported string suffix",
2168                                         &$1);
2169                         }
2170                         }$
2171                 | MULTI_STRING ${
2172                         $0 = new_pos(val, $1);
2173                         $0->val.type = Tstr;
2174                         {
2175                         char tail[3];
2176                         string_parse(&$1, '\\', &$0->val.str, tail);
2177                         if (tail[0])
2178                                 tok_err(config2context(config), "error: unsupported string suffix",
2179                                         &$1);
2180                         }
2181                         }$
2182
2183 ###### print exec cases
2184         case Xval:
2185         {
2186                 struct val *v = cast(val, e);
2187                 if (v->val.type == Tstr)
2188                         printf("\"");
2189                 print_value(v->val);
2190                 if (v->val.type == Tstr)
2191                         printf("\"");
2192                 break;
2193         }
2194
2195 ###### propagate exec cases
2196         case Xval:
2197         {
2198                 struct val *val = cast(val, prog);
2199                 if (!type_compat(type, val->val.type, rules)) {
2200                         type_err(c, "error: expected %1%r found %2",
2201                                    prog, type, rules, val->val.type);
2202                         *ok = 0;
2203                 }
2204                 return val->val.type;
2205         }
2206
2207 ###### interp exec cases
2208         case Xval:
2209                 rv = dup_value(cast(val, e)->val);
2210                 break;
2211
2212 ###### ast functions
2213         static void free_val(struct val *v)
2214         {
2215                 if (!v)
2216                         return;
2217                 free_value(v->val);
2218                 free(v);
2219         }
2220
2221 ###### free exec cases
2222         case Xval: free_val(cast(val, e)); break;
2223
2224 ###### ast functions
2225         // Move all nodes from 'b' to 'rv', reversing the order.
2226         // In 'b' 'left' is a list, and 'right' is the last node.
2227         // In 'rv', left' is the first node and 'right' is a list.
2228         static struct binode *reorder_bilist(struct binode *b)
2229         {
2230                 struct binode *rv = NULL;
2231
2232                 while (b) {
2233                         struct exec *t = b->right;
2234                         b->right = rv;
2235                         rv = b;
2236                         if (b->left)
2237                                 b = cast(binode, b->left);
2238                         else
2239                                 b = NULL;
2240                         rv->left = t;
2241                 }
2242                 return rv;
2243         }
2244
2245 ### Variables
2246
2247 Just as we used a `val` to wrap a value into an `exec`, we similarly
2248 need a `var` to wrap a `variable` into an exec.  While each `val`
2249 contained a copy of the value, each `var` hold a link to the variable
2250 because it really is the same variable no matter where it appears.
2251 When a variable is used, we need to remember to follow the `->merged`
2252 link to find the primary instance.
2253
2254 ###### exec type
2255         Xvar,
2256
2257 ###### ast
2258         struct var {
2259                 struct exec;
2260                 struct variable *var;
2261         };
2262
2263 ###### Grammar
2264
2265         $*var
2266         VariableDecl -> IDENTIFIER : ${ {
2267                 struct variable *v = var_decl(config2context(config), $1.txt);
2268                 $0 = new_pos(var, $1);
2269                 $0->var = v;
2270                 if (v)
2271                         v->where_decl = $0;
2272                 else {
2273                         v = var_ref(config2context(config), $1.txt);
2274                         $0->var = v;
2275                         type_err(config2context(config), "error: variable '%v' redeclared",
2276                                  $0, NULL, 0, NULL);
2277                         type_err(config2context(config), "info: this is where '%v' was first declared",
2278                                  v->where_decl, NULL, 0, NULL);
2279                 }
2280         } }$
2281             | IDENTIFIER :: ${ {
2282                 struct variable *v = var_decl(config2context(config), $1.txt);
2283                 $0 = new_pos(var, $1);
2284                 $0->var = v;
2285                 if (v) {
2286                         v->where_decl = $0;
2287                         v->constant = 1;
2288                 } else {
2289                         v = var_ref(config2context(config), $1.txt);
2290                         $0->var = v;
2291                         type_err(config2context(config), "error: variable '%v' redeclared",
2292                                  $0, NULL, 0, NULL);
2293                         type_err(config2context(config), "info: this is where '%v' was first declared",
2294                                  v->where_decl, NULL, 0, NULL);
2295                 }
2296         } }$
2297             | IDENTIFIER : Type ${ {
2298                 struct variable *v = var_decl(config2context(config), $1.txt);
2299                 $0 = new_pos(var, $1);
2300                 $0->var = v;
2301                 if (v) {
2302                         v->where_decl = $0;
2303                         v->where_set = $0;
2304                         v->val = val_prepare($<3);
2305                 } else {
2306                         v = var_ref(config2context(config), $1.txt);
2307                         $0->var = v;
2308                         type_err(config2context(config), "error: variable '%v' redeclared",
2309                                  $0, NULL, 0, NULL);
2310                         type_err(config2context(config), "info: this is where '%v' was first declared",
2311                                  v->where_decl, NULL, 0, NULL);
2312                 }
2313         } }$
2314             | IDENTIFIER :: Type ${ {
2315                 struct variable *v = var_decl(config2context(config), $1.txt);
2316                 $0 = new_pos(var, $1);
2317                 $0->var = v;
2318                 if (v) {
2319                         v->where_decl = $0;
2320                         v->where_set = $0;
2321                         v->val = val_prepare($<3);
2322                         v->constant = 1;
2323                 } else {
2324                         v = var_ref(config2context(config), $1.txt);
2325                         $0->var = v;
2326                         type_err(config2context(config), "error: variable '%v' redeclared",
2327                                  $0, NULL, 0, NULL);
2328                         type_err(config2context(config), "info: this is where '%v' was first declared",
2329                                  v->where_decl, NULL, 0, NULL);
2330                 }
2331         } }$
2332
2333         $*exec
2334         Variable -> IDENTIFIER ${ {
2335                 struct variable *v = var_ref(config2context(config), $1.txt);
2336                 $0 = new_pos(var, $1);
2337                 if (v == NULL) {
2338                         /* This might be a label - allocate a var just in case */
2339                         v = var_decl(config2context(config), $1.txt);
2340                         if (v) {
2341                                 v->val = val_prepare(Tlabel);
2342                                 v->val.label = &v->val;
2343                                 v->where_set = $0;
2344                         }
2345                 }
2346                 cast(var, $0)->var = v;
2347         } }$
2348         ## variable grammar
2349
2350         $*type
2351         Type -> IDENTIFIER ${
2352                 $0 = find_type(config2context(config), $1.txt);
2353                 if (!$0) {
2354                         tok_err(config2context(config),
2355                                 "error: undefined type", &$1);
2356
2357                         $0 = Tnone;
2358                 }
2359         }$
2360         ## type grammar
2361
2362 ###### print exec cases
2363         case Xvar:
2364         {
2365                 struct var *v = cast(var, e);
2366                 if (v->var) {
2367                         struct binding *b = v->var->name;
2368                         printf("%.*s", b->name.len, b->name.txt);
2369                 }
2370                 break;
2371         }
2372
2373 ###### format cases
2374         case 'v':
2375                 if (loc->type == Xvar) {
2376                         struct var *v = cast(var, loc);
2377                         if (v->var) {
2378                                 struct binding *b = v->var->name;
2379                                 fprintf(stderr, "%.*s", b->name.len, b->name.txt);
2380                         } else
2381                                 fputs("???", stderr);   // NOTEST
2382                 } else
2383                         fputs("NOTVAR", stderr);        // NOTEST
2384                 break;
2385
2386 ###### propagate exec cases
2387
2388         case Xvar:
2389         {
2390                 struct var *var = cast(var, prog);
2391                 struct variable *v = var->var;
2392                 if (!v) {
2393                         type_err(c, "%d:BUG: no variable!!", prog, NULL, 0, NULL); // NOTEST
2394                         *ok = 0;                                        // NOTEST
2395                         return Tnone;                                   // NOTEST
2396                 }
2397                 if (v->merged)
2398                         v = v->merged;
2399                 if (v->constant && (rules & Rnoconstant)) {
2400                         type_err(c, "error: Cannot assign to a constant: %v",
2401                                  prog, NULL, 0, NULL);
2402                         type_err(c, "info: name was defined as a constant here",
2403                                  v->where_decl, NULL, 0, NULL);
2404                         *ok = 0;
2405                         return v->val.type;
2406                 }
2407                 if (v->val.type == NULL) {
2408                         if (type && *ok != 0) {
2409                                 v->val = val_prepare(type);
2410                                 v->where_set = prog;
2411                                 *ok = 2;
2412                         }
2413                         return type;
2414                 }
2415                 if (!type_compat(type, v->val.type, rules)) {
2416                         type_err(c, "error: expected %1%r but variable '%v' is %2", prog,
2417                                  type, rules, v->val.type);
2418                         type_err(c, "info: this is where '%v' was set to %1", v->where_set,
2419                                  v->val.type, rules, NULL);
2420                         *ok = 0;
2421                 }
2422                 if (!type)
2423                         return v->val.type;
2424                 return type;
2425         }
2426
2427 ###### interp exec cases
2428         case Xvar:
2429         {
2430                 struct var *var = cast(var, e);
2431                 struct variable *v = var->var;
2432
2433                 if (v->merged)
2434                         v = v->merged;
2435                 lrv = &v->val;
2436                 break;
2437         }
2438
2439 ###### ast functions
2440
2441         static void free_var(struct var *v)
2442         {
2443                 free(v);
2444         }
2445
2446 ###### free exec cases
2447         case Xvar: free_var(cast(var, e)); break;
2448
2449 ### Expressions: Conditional
2450
2451 Our first user of the `binode` will be conditional expressions, which
2452 is a bit odd as they actually have three components.  That will be
2453 handled by having 2 binodes for each expression.  The conditional
2454 expression is the lowest precedence operatior, so it gets to define
2455 what an "Expression" is.  The next level up is "BoolExpr", which
2456 comes next.
2457
2458 Conditional expressions are of the form "value `if` condition `else`
2459 other_value".  They associate to the right, so everything to the right
2460 of `else` is part of an else value, while only the BoolExpr to the
2461 left of `if` is the if values.  Between `if` and `else` there is no
2462 room for ambiguity, so a full conditional expression is allowed in there.
2463
2464 ###### Binode types
2465         CondExpr,
2466
2467 ###### Grammar
2468
2469         $*exec
2470         Expression -> BoolExpr if Expression else Expression ${ {
2471                         struct binode *b1 = new(binode);
2472                         struct binode *b2 = new(binode);
2473                         b1->op = CondExpr;
2474                         b1->left = $<3;
2475                         b1->right = b2;
2476                         b2->op = CondExpr;
2477                         b2->left = $<1;
2478                         b2->right = $<5;
2479                         $0 = b1;
2480                 } }$
2481                 | BoolExpr ${ $0 = $<1; }$
2482
2483 ###### print binode cases
2484
2485         case CondExpr:
2486                 b2 = cast(binode, b->right);
2487                 print_exec(b2->left, -1, 0);
2488                 printf(" if ");
2489                 print_exec(b->left, -1, 0);
2490                 printf(" else ");
2491                 print_exec(b2->right, -1, 0);
2492                 break;
2493
2494 ###### propagate binode cases
2495
2496         case CondExpr: {
2497                 /* cond must be Tbool, others must match */
2498                 struct binode *b2 = cast(binode, b->right);
2499                 struct type *t2;
2500
2501                 propagate_types(b->left, c, ok, Tbool, 0);
2502                 t = propagate_types(b2->left, c, ok, type, Rnolabel);
2503                 t2 = propagate_types(b2->right, c, ok, type ?: t, Rnolabel);
2504                 return t ?: t2;
2505         }
2506
2507 ###### interp binode cases
2508
2509         case CondExpr: {
2510                 struct binode *b2 = cast(binode, b->right);
2511                 left = interp_exec(b->left);
2512                 if (left.bool)
2513                         rv = interp_exec(b2->left);
2514                 else
2515                         rv = interp_exec(b2->right);
2516                 }
2517                 break;
2518
2519 ### Expressions: Boolean
2520
2521 The next class of expressions to use the `binode` will be Boolean
2522 expressions.  As I haven't implemented precedence in the parser
2523 generator yet, we need different names for each precedence level used
2524 by expressions.  The outer most or lowest level precedence after
2525 conditional expressions are Boolean operators which form an `BoolExpr`
2526 out of `BTerm`s and `BFact`s.  As well as `or` `and`, and `not` we
2527 have `and then` and `or else` which only evaluate the second operand
2528 if the result would make a difference.
2529
2530 ###### Binode types
2531         And,
2532         AndThen,
2533         Or,
2534         OrElse,
2535         Not,
2536
2537 ###### Grammar
2538
2539         $*exec
2540         BoolExpr -> BoolExpr or BTerm ${ {
2541                         struct binode *b = new(binode);
2542                         b->op = Or;
2543                         b->left = $<1;
2544                         b->right = $<3;
2545                         $0 = b;
2546                 } }$
2547                 | BoolExpr or else BTerm ${ {
2548                         struct binode *b = new(binode);
2549                         b->op = OrElse;
2550                         b->left = $<1;
2551                         b->right = $<4;
2552                         $0 = b;
2553                 } }$
2554                 | BTerm ${ $0 = $<1; }$
2555
2556         BTerm -> BTerm and BFact ${ {
2557                         struct binode *b = new(binode);
2558                         b->op = And;
2559                         b->left = $<1;
2560                         b->right = $<3;
2561                         $0 = b;
2562                 } }$
2563                 | BTerm and then BFact ${ {
2564                         struct binode *b = new(binode);
2565                         b->op = AndThen;
2566                         b->left = $<1;
2567                         b->right = $<4;
2568                         $0 = b;
2569                 } }$
2570                 | BFact ${ $0 = $<1; }$
2571
2572         BFact -> not BFact ${ {
2573                         struct binode *b = new(binode);
2574                         b->op = Not;
2575                         b->right = $<2;
2576                         $0 = b;
2577                 } }$
2578                 ## other BFact
2579
2580 ###### print binode cases
2581         case And:
2582                 print_exec(b->left, -1, 0);
2583                 printf(" and ");
2584                 print_exec(b->right, -1, 0);
2585                 break;
2586         case AndThen:
2587                 print_exec(b->left, -1, 0);
2588                 printf(" and then ");
2589                 print_exec(b->right, -1, 0);
2590                 break;
2591         case Or:
2592                 print_exec(b->left, -1, 0);
2593                 printf(" or ");
2594                 print_exec(b->right, -1, 0);
2595                 break;
2596         case OrElse:
2597                 print_exec(b->left, -1, 0);
2598                 printf(" or else ");
2599                 print_exec(b->right, -1, 0);
2600                 break;
2601         case Not:
2602                 printf("not ");
2603                 print_exec(b->right, -1, 0);
2604                 break;
2605
2606 ###### propagate binode cases
2607         case And:
2608         case AndThen:
2609         case Or:
2610         case OrElse:
2611         case Not:
2612                 /* both must be Tbool, result is Tbool */
2613                 propagate_types(b->left, c, ok, Tbool, 0);
2614                 propagate_types(b->right, c, ok, Tbool, 0);
2615                 if (type && type != Tbool) {
2616                         type_err(c, "error: %1 operation found where %2 expected", prog,
2617                                    Tbool, 0, type);
2618                         *ok = 0;
2619                 }
2620                 return Tbool;
2621
2622 ###### interp binode cases
2623         case And:
2624                 rv = interp_exec(b->left);
2625                 right = interp_exec(b->right);
2626                 rv.bool = rv.bool && right.bool;
2627                 break;
2628         case AndThen:
2629                 rv = interp_exec(b->left);
2630                 if (rv.bool)
2631                         rv = interp_exec(b->right);
2632                 break;
2633         case Or:
2634                 rv = interp_exec(b->left);
2635                 right = interp_exec(b->right);
2636                 rv.bool = rv.bool || right.bool;
2637                 break;
2638         case OrElse:
2639                 rv = interp_exec(b->left);
2640                 if (!rv.bool)
2641                         rv = interp_exec(b->right);
2642                 break;
2643         case Not:
2644                 rv = interp_exec(b->right);
2645                 rv.bool = !rv.bool;
2646                 break;
2647
2648 ### Expressions: Comparison
2649
2650 Of slightly higher precedence that Boolean expressions are
2651 Comparisons.
2652 A comparison takes arguments of any comparable type, but the two types must be
2653 the same.
2654
2655 To simplify the parsing we introduce an `eop` which can record an
2656 expression operator.
2657
2658 ###### ast
2659         struct eop {
2660                 enum Btype op;
2661         };
2662
2663 ###### ast functions
2664         static void free_eop(struct eop *e)
2665         {
2666                 if (e)
2667                         free(e);
2668         }
2669
2670 ###### Binode types
2671         Less,
2672         Gtr,
2673         LessEq,
2674         GtrEq,
2675         Eql,
2676         NEql,
2677
2678 ###### other BFact
2679         | Expr CMPop Expr ${ {
2680                 struct binode *b = new(binode);
2681                 b->op = $2.op;
2682                 b->left = $<1;
2683                 b->right = $<3;
2684                 $0 = b;
2685         } }$
2686         | Expr ${ $0 = $<1; }$
2687
2688 ###### Grammar
2689
2690         $eop
2691         CMPop ->   < ${ $0.op = Less; }$
2692                 |  > ${ $0.op = Gtr; }$
2693                 |  <= ${ $0.op = LessEq; }$
2694                 |  >= ${ $0.op = GtrEq; }$
2695                 |  == ${ $0.op = Eql; }$
2696                 |  != ${ $0.op = NEql; }$
2697
2698 ###### print binode cases
2699
2700         case Less:
2701         case LessEq:
2702         case Gtr:
2703         case GtrEq:
2704         case Eql:
2705         case NEql:
2706                 print_exec(b->left, -1, 0);
2707                 switch(b->op) {
2708                 case Less:   printf(" < "); break;
2709                 case LessEq: printf(" <= "); break;
2710                 case Gtr:    printf(" > "); break;
2711                 case GtrEq:  printf(" >= "); break;
2712                 case Eql:    printf(" == "); break;
2713                 case NEql:   printf(" != "); break;
2714                 default: abort();               // NOTEST
2715                 }
2716                 print_exec(b->right, -1, 0);
2717                 break;
2718
2719 ###### propagate binode cases
2720         case Less:
2721         case LessEq:
2722         case Gtr:
2723         case GtrEq:
2724         case Eql:
2725         case NEql:
2726                 /* Both must match but not be labels, result is Tbool */
2727                 t = propagate_types(b->left, c, ok, NULL, Rnolabel);
2728                 if (t)
2729                         propagate_types(b->right, c, ok, t, 0);
2730                 else {
2731                         t = propagate_types(b->right, c, ok, NULL, Rnolabel);
2732                         if (t)
2733                                 t = propagate_types(b->left, c, ok, t, 0);
2734                 }
2735                 if (!type_compat(type, Tbool, 0)) {
2736                         type_err(c, "error: Comparison returns %1 but %2 expected", prog,
2737                                     Tbool, rules, type);
2738                         *ok = 0;
2739                 }
2740                 return Tbool;
2741
2742 ###### interp binode cases
2743         case Less:
2744         case LessEq:
2745         case Gtr:
2746         case GtrEq:
2747         case Eql:
2748         case NEql:
2749         {
2750                 int cmp;
2751                 left = interp_exec(b->left);
2752                 right = interp_exec(b->right);
2753                 cmp = value_cmp(left, right);
2754                 rv.type = Tbool;
2755                 switch (b->op) {
2756                 case Less:      rv.bool = cmp <  0; break;
2757                 case LessEq:    rv.bool = cmp <= 0; break;
2758                 case Gtr:       rv.bool = cmp >  0; break;
2759                 case GtrEq:     rv.bool = cmp >= 0; break;
2760                 case Eql:       rv.bool = cmp == 0; break;
2761                 case NEql:      rv.bool = cmp != 0; break;
2762                 default: rv.bool = 0; break;    // NOTEST
2763                 }
2764                 break;
2765         }
2766
2767 ### Expressions: The rest
2768
2769 The remaining expressions with the highest precedence are arithmetic
2770 and string concatenation.  They are `Expr`, `Term`, and `Factor`.
2771 The `Factor` is where the `Value` and `Variable` that we already have
2772 are included.
2773
2774 `+` and `-` are both infix and prefix operations (where they are
2775 absolute value and negation).  These have different operator names.
2776
2777 We also have a 'Bracket' operator which records where parentheses were
2778 found.  This makes it easy to reproduce these when printing.  Once
2779 precedence is handled better I might be able to discard this.
2780
2781 ###### Binode types
2782         Plus, Minus,
2783         Times, Divide, Rem,
2784         Concat,
2785         Absolute, Negate,
2786         Bracket,
2787
2788 ###### Grammar
2789
2790         $*exec
2791         Expr -> Expr Eop Term ${ {
2792                         struct binode *b = new(binode);
2793                         b->op = $2.op;
2794                         b->left = $<1;
2795                         b->right = $<3;
2796                         $0 = b;
2797                 } }$
2798                 | Term ${ $0 = $<1; }$
2799
2800         Term -> Term Top Factor ${ {
2801                         struct binode *b = new(binode);
2802                         b->op = $2.op;
2803                         b->left = $<1;
2804                         b->right = $<3;
2805                         $0 = b;
2806                 } }$
2807                 | Factor ${ $0 = $<1; }$
2808
2809         Factor -> ( Expression ) ${ {
2810                         struct binode *b = new_pos(binode, $1);
2811                         b->op = Bracket;
2812                         b->right = $<2;
2813                         $0 = b;
2814                 } }$
2815                 | Uop Factor ${ {
2816                         struct binode *b = new(binode);
2817                         b->op = $1.op;
2818                         b->right = $<2;
2819                         $0 = b;
2820                 } }$
2821                 | Value ${ $0 = $<1; }$
2822                 | Variable ${ $0 = $<1; }$
2823
2824         $eop
2825         Eop ->    + ${ $0.op = Plus; }$
2826                 | - ${ $0.op = Minus; }$
2827
2828         Uop ->    + ${ $0.op = Absolute; }$
2829                 | - ${ $0.op = Negate; }$
2830
2831         Top ->    * ${ $0.op = Times; }$
2832                 | / ${ $0.op = Divide; }$
2833                 | % ${ $0.op = Rem; }$
2834                 | ++ ${ $0.op = Concat; }$
2835
2836 ###### print binode cases
2837         case Plus:
2838         case Minus:
2839         case Times:
2840         case Divide:
2841         case Concat:
2842         case Rem:
2843                 print_exec(b->left, indent, 0);
2844                 switch(b->op) {
2845                 case Plus:   fputs(" + ", stdout); break;
2846                 case Minus:  fputs(" - ", stdout); break;
2847                 case Times:  fputs(" * ", stdout); break;
2848                 case Divide: fputs(" / ", stdout); break;
2849                 case Rem:    fputs(" % ", stdout); break;
2850                 case Concat: fputs(" ++ ", stdout); break;
2851                 default: abort();       // NOTEST
2852                 }                       // NOTEST
2853                 print_exec(b->right, indent, 0);
2854                 break;
2855         case Absolute:
2856                 printf("+");
2857                 print_exec(b->right, indent, 0);
2858                 break;
2859         case Negate:
2860                 printf("-");
2861                 print_exec(b->right, indent, 0);
2862                 break;
2863         case Bracket:
2864                 printf("(");
2865                 print_exec(b->right, indent, 0);
2866                 printf(")");
2867                 break;
2868
2869 ###### propagate binode cases
2870         case Plus:
2871         case Minus:
2872         case Times:
2873         case Rem:
2874         case Divide:
2875                 /* both must be numbers, result is Tnum */
2876         case Absolute:
2877         case Negate:
2878                 /* as propagate_types ignores a NULL,
2879                  * unary ops fit here too */
2880                 propagate_types(b->left, c, ok, Tnum, 0);
2881                 propagate_types(b->right, c, ok, Tnum, 0);
2882                 if (!type_compat(type, Tnum, 0)) {
2883                         type_err(c, "error: Arithmetic returns %1 but %2 expected", prog,
2884                                    Tnum, rules, type);
2885                         *ok = 0;
2886                 }
2887                 return Tnum;
2888
2889         case Concat:
2890                 /* both must be Tstr, result is Tstr */
2891                 propagate_types(b->left, c, ok, Tstr, 0);
2892                 propagate_types(b->right, c, ok, Tstr, 0);
2893                 if (!type_compat(type, Tstr, 0)) {
2894                         type_err(c, "error: Concat returns %1 but %2 expected", prog,
2895                                    Tstr, rules, type);
2896                         *ok = 0;
2897                 }
2898                 return Tstr;
2899
2900         case Bracket:
2901                 return propagate_types(b->right, c, ok, type, 0);
2902
2903 ###### interp binode cases
2904
2905         case Plus:
2906                 rv = interp_exec(b->left);
2907                 right = interp_exec(b->right);
2908                 mpq_add(rv.num, rv.num, right.num);
2909                 break;
2910         case Minus:
2911                 rv = interp_exec(b->left);
2912                 right = interp_exec(b->right);
2913                 mpq_sub(rv.num, rv.num, right.num);
2914                 break;
2915         case Times:
2916                 rv = interp_exec(b->left);
2917                 right = interp_exec(b->right);
2918                 mpq_mul(rv.num, rv.num, right.num);
2919                 break;
2920         case Divide:
2921                 rv = interp_exec(b->left);
2922                 right = interp_exec(b->right);
2923                 mpq_div(rv.num, rv.num, right.num);
2924                 break;
2925         case Rem: {
2926                 mpz_t l, r, rem;
2927
2928                 left = interp_exec(b->left);
2929                 right = interp_exec(b->right);
2930                 mpz_init(l); mpz_init(r); mpz_init(rem);
2931                 mpz_tdiv_q(l, mpq_numref(left.num), mpq_denref(left.num));
2932                 mpz_tdiv_q(r, mpq_numref(right.num), mpq_denref(right.num));
2933                 mpz_tdiv_r(rem, l, r);
2934                 rv = val_init(Tnum);
2935                 mpq_set_z(rv.num, rem);
2936                 mpz_clear(r); mpz_clear(l); mpz_clear(rem);
2937                 break;
2938         }
2939         case Negate:
2940                 rv = interp_exec(b->right);
2941                 mpq_neg(rv.num, rv.num);
2942                 break;
2943         case Absolute:
2944                 rv = interp_exec(b->right);
2945                 mpq_abs(rv.num, rv.num);
2946                 break;
2947         case Bracket:
2948                 rv = interp_exec(b->right);
2949                 break;
2950         case Concat:
2951                 left = interp_exec(b->left);
2952                 right = interp_exec(b->right);
2953                 rv.type = Tstr;
2954                 rv.str = text_join(left.str, right.str);
2955                 break;
2956
2957 ###### value functions
2958
2959         static struct text text_join(struct text a, struct text b)
2960         {
2961                 struct text rv;
2962                 rv.len = a.len + b.len;
2963                 rv.txt = malloc(rv.len);
2964                 memcpy(rv.txt, a.txt, a.len);
2965                 memcpy(rv.txt+a.len, b.txt, b.len);
2966                 return rv;
2967         }
2968
2969 ### Blocks, Statements, and Statement lists.
2970
2971 Now that we have expressions out of the way we need to turn to
2972 statements.  There are simple statements and more complex statements.
2973 Simple statements do not contain (syntactic) newlines, complex statements do.
2974
2975 Statements often come in sequences and we have corresponding simple
2976 statement lists and complex statement lists.
2977 The former comprise only simple statements separated by semicolons.
2978 The later comprise complex statements and simple statement lists.  They are
2979 separated by newlines.  Thus the semicolon is only used to separate
2980 simple statements on the one line.  This may be overly restrictive,
2981 but I'm not sure I ever want a complex statement to share a line with
2982 anything else.
2983
2984 Note that a simple statement list can still use multiple lines if
2985 subsequent lines are indented, so
2986
2987 ###### Example: wrapped simple statement list
2988
2989         a = b; c = d;
2990            e = f; print g
2991
2992 is a single simple statement list.  This might allow room for
2993 confusion, so I'm not set on it yet.
2994
2995 A simple statement list needs no extra syntax.  A complex statement
2996 list has two syntactic forms.  It can be enclosed in braces (much like
2997 C blocks), or it can be introduced by a colon and continue until an
2998 unindented newline (much like Python blocks).  With this extra syntax
2999 it is referred to as a block.
3000
3001 Note that a block does not have to include any newlines if it only
3002 contains simple statements.  So both of:
3003
3004         if condition: a=b; d=f
3005
3006         if condition { a=b; print f }
3007
3008 are valid.
3009
3010 In either case the list is constructed from a `binode` list with
3011 `Block` as the operator.  When parsing the list it is most convenient
3012 to append to the end, so a list is a list and a statement.  When using
3013 the list it is more convenient to consider a list to be a statement
3014 and a list.  So we need a function to re-order a list.
3015 `reorder_bilist` serves this purpose.
3016
3017 The only stand-alone statement we introduce at this stage is `pass`
3018 which does nothing and is represented as a `NULL` pointer in a `Block`
3019 list.  Other stand-alone statements will follow once the infrastructure
3020 is in-place.
3021
3022 ###### Binode types
3023         Block,
3024
3025 ###### Grammar
3026
3027         $void
3028         Newlines -> NEWLINE
3029                 | Newlines NEWLINE
3030
3031         $*binode
3032         Block -> Open Statementlist Close ${ $0 = $<2; }$
3033                 | Open SimpleStatements } ${ $0 = reorder_bilist($<2); }$
3034                 | : SimpleStatements ${ $0 = reorder_bilist($<2); }$
3035                 | : Statementlist  ${ $0 = $<2; }$
3036
3037         Statementlist -> ComplexStatements ${ $0 = reorder_bilist($<1); }$
3038
3039         ComplexStatements -> ComplexStatements ComplexStatement ${
3040                         if ($2 == NULL) {
3041                                 $0 = $<1;
3042                         } else {
3043                                 $0 = new(binode);
3044                                 $0->op = Block;
3045                                 $0->left = $<1;
3046                                 $0->right = $<2;
3047                         }
3048                 }$
3049                 | ComplexStatement ${
3050                         if ($1 == NULL) {
3051                                 $0 = NULL;
3052                         } else {
3053                                 $0 = new(binode);
3054                                 $0->op = Block;
3055                                 $0->left = NULL;
3056                                 $0->right = $<1;
3057                         }
3058                 }$
3059
3060         $*exec
3061         ComplexStatement -> SimpleStatements NEWLINE ${
3062                         $0 = reorder_bilist($<1);
3063                         }$
3064                 | Newlines ${ $0 = NULL; }$
3065                 ## ComplexStatement Grammar
3066
3067         $*binode
3068         SimpleStatements -> SimpleStatements ; SimpleStatement ${
3069                         $0 = new(binode);
3070                         $0->op = Block;
3071                         $0->left = $<1;
3072                         $0->right = $<3;
3073                         }$
3074                 | SimpleStatement ${
3075                         $0 = new(binode);
3076                         $0->op = Block;
3077                         $0->left = NULL;
3078                         $0->right = $<1;
3079                         }$
3080                 | SimpleStatements ; ${ $0 = $<1; }$
3081
3082         SimpleStatement -> pass ${ $0 = NULL; }$
3083                 ## SimpleStatement Grammar
3084
3085 ###### print binode cases
3086         case Block:
3087                 if (indent < 0) {
3088                         // simple statement
3089                         if (b->left == NULL)
3090                                 printf("pass");
3091                         else
3092                                 print_exec(b->left, indent, 0);
3093                         if (b->right) {
3094                                 printf("; ");
3095                                 print_exec(b->right, indent, 0);
3096                         }
3097                 } else {
3098                         // block, one per line
3099                         if (b->left == NULL)
3100                                 do_indent(indent, "pass\n");
3101                         else
3102                                 print_exec(b->left, indent, bracket);
3103                         if (b->right)
3104                                 print_exec(b->right, indent, bracket);
3105                 }
3106                 break;
3107
3108 ###### propagate binode cases
3109         case Block:
3110         {
3111                 /* If any statement returns something other than Tnone
3112                  * or Tbool then all such must return same type.
3113                  * As each statement may be Tnone or something else,
3114                  * we must always pass NULL (unknown) down, otherwise an incorrect
3115                  * error might occur.  We never return Tnone unless it is
3116                  * passed in.
3117                  */
3118                 struct binode *e;
3119
3120                 for (e = b; e; e = cast(binode, e->right)) {
3121                         t = propagate_types(e->left, c, ok, NULL, rules);
3122                         if ((rules & Rboolok) && t == Tbool)
3123                                 t = NULL;
3124                         if (t && t != Tnone && t != Tbool) {
3125                                 if (!type)
3126                                         type = t;
3127                                 else if (t != type) {
3128                                         type_err(c, "error: expected %1%r, found %2",
3129                                                  e->left, type, rules, t);
3130                                         *ok = 0;
3131                                 }
3132                         }
3133                 }
3134                 return type;
3135         }
3136
3137 ###### interp binode cases
3138         case Block:
3139                 while (rv.type == Tnone &&
3140                        b) {
3141                         if (b->left)
3142                                 rv = interp_exec(b->left);
3143                         b = cast(binode, b->right);
3144                 }
3145                 break;
3146
3147 ### The Print statement
3148
3149 `print` is a simple statement that takes a comma-separated list of
3150 expressions and prints the values separated by spaces and terminated
3151 by a newline.  No control of formatting is possible.
3152
3153 `print` faces the same list-ordering issue as blocks, and uses the
3154 same solution.
3155
3156 ###### Binode types
3157         Print,
3158
3159 ###### SimpleStatement Grammar
3160
3161         | print ExpressionList ${
3162                 $0 = reorder_bilist($<2);
3163         }$
3164         | print ExpressionList , ${
3165                 $0 = new(binode);
3166                 $0->op = Print;
3167                 $0->right = NULL;
3168                 $0->left = $<2;
3169                 $0 = reorder_bilist($0);
3170         }$
3171         | print ${
3172                 $0 = new(binode);
3173                 $0->op = Print;
3174                 $0->right = NULL;
3175         }$
3176
3177 ###### Grammar
3178
3179         $*binode
3180         ExpressionList -> ExpressionList , Expression ${
3181                 $0 = new(binode);
3182                 $0->op = Print;
3183                 $0->left = $<1;
3184                 $0->right = $<3;
3185                 }$
3186                 | Expression ${
3187                         $0 = new(binode);
3188                         $0->op = Print;
3189                         $0->left = NULL;
3190                         $0->right = $<1;
3191                 }$
3192
3193 ###### print binode cases
3194
3195         case Print:
3196                 do_indent(indent, "print");
3197                 while (b) {
3198                         if (b->left) {
3199                                 printf(" ");
3200                                 print_exec(b->left, -1, 0);
3201                                 if (b->right)
3202                                         printf(",");
3203                         }
3204                         b = cast(binode, b->right);
3205                 }
3206                 if (indent >= 0)
3207                         printf("\n");
3208                 break;
3209
3210 ###### propagate binode cases
3211
3212         case Print:
3213                 /* don't care but all must be consistent */
3214                 propagate_types(b->left, c, ok, NULL, Rnolabel);
3215                 propagate_types(b->right, c, ok, NULL, Rnolabel);
3216                 break;
3217
3218 ###### interp binode cases
3219
3220         case Print:
3221         {
3222                 char sep = 0;
3223                 int eol = 1;
3224                 for ( ; b; b = cast(binode, b->right))
3225                         if (b->left) {
3226                                 if (sep)
3227                                         putchar(sep);
3228                                 left = interp_exec(b->left);
3229                                 print_value(left);
3230                                 free_value(left);
3231                                 if (b->right)
3232                                         sep = ' ';
3233                         } else if (sep)
3234                                 eol = 0;
3235                 left.type = Tnone;
3236                 if (eol)
3237                         printf("\n");
3238                 break;
3239         }
3240
3241 ###### Assignment statement
3242
3243 An assignment will assign a value to a variable, providing it hasn't
3244 be declared as a constant.  The analysis phase ensures that the type
3245 will be correct so the interpreter just needs to perform the
3246 calculation.  There is a form of assignment which declares a new
3247 variable as well as assigning a value.  If a name is assigned before
3248 it is declared, and error will be raised as the name is created as
3249 `Tlabel` and it is illegal to assign to such names.
3250
3251 ###### Binode types
3252         Assign,
3253         Declare,
3254
3255 ###### SimpleStatement Grammar
3256         | Variable = Expression ${
3257                         $0 = new(binode);
3258                         $0->op = Assign;
3259                         $0->left = $<1;
3260                         $0->right = $<3;
3261                 }$
3262         | VariableDecl = Expression ${
3263                         $0 = new(binode);
3264                         $0->op = Declare;
3265                         $0->left = $<1;
3266                         $0->right =$<3;
3267                 }$
3268
3269         | VariableDecl ${
3270                         if ($1->var->where_set == NULL) {
3271                                 type_err(config2context(config),
3272                                          "Variable declared with no type or value: %v",
3273                                          $1, NULL, 0, NULL);
3274                         } else {
3275                                 $0 = new(binode);
3276                                 $0->op = Declare;
3277                                 $0->left = $<1;
3278                                 $0->right = NULL;
3279                         }
3280                 }$
3281
3282 ###### print binode cases
3283
3284         case Assign:
3285                 do_indent(indent, "");
3286                 print_exec(b->left, indent, 0);
3287                 printf(" = ");
3288                 print_exec(b->right, indent, 0);
3289                 if (indent >= 0)
3290                         printf("\n");
3291                 break;
3292
3293         case Declare:
3294                 {
3295                 struct variable *v = cast(var, b->left)->var;
3296                 do_indent(indent, "");
3297                 print_exec(b->left, indent, 0);
3298                 if (cast(var, b->left)->var->constant) {
3299                         if (v->where_decl == v->where_set) {
3300                                 printf("::");
3301                                 type_print(v->val.type, stdout);
3302                                 printf(" ");
3303                         } else
3304                                 printf(" ::");
3305                 } else {
3306                         if (v->where_decl == v->where_set) {
3307                                 printf(":");
3308                                 type_print(v->val.type, stdout);
3309                                 printf(" ");
3310                         } else
3311                                 printf(" :");
3312                 }
3313                 if (b->right) {
3314                         printf("= ");
3315                         print_exec(b->right, indent, 0);
3316                 }
3317                 if (indent >= 0)
3318                         printf("\n");
3319                 }
3320                 break;
3321
3322 ###### propagate binode cases
3323
3324         case Assign:
3325         case Declare:
3326                 /* Both must match and not be labels,
3327                  * Type must support 'dup',
3328                  * For Assign, left must not be constant.
3329                  * result is Tnone
3330                  */
3331                 t = propagate_types(b->left, c, ok, NULL,
3332                                     Rnolabel | (b->op == Assign ? Rnoconstant : 0));
3333                 if (!b->right)
3334                         return Tnone;
3335
3336                 if (t) {
3337                         if (propagate_types(b->right, c, ok, t, 0) != t)
3338                                 if (b->left->type == Xvar)
3339                                         type_err(c, "info: variable '%v' was set as %1 here.",
3340                                                  cast(var, b->left)->var->where_set, t, rules, NULL);
3341                 } else {
3342                         t = propagate_types(b->right, c, ok, NULL, Rnolabel);
3343                         if (t)
3344                                 propagate_types(b->left, c, ok, t,
3345                                                 (b->op == Assign ? Rnoconstant : 0));
3346                 }
3347                 if (t && t->dup == NULL) {
3348                         type_err(c, "error: cannot assign value of type %1", b, t, 0, NULL);
3349                         *ok = 0;
3350                 }
3351                 return Tnone;
3352
3353                 break;
3354
3355 ###### interp binode cases
3356
3357         case Assign:
3358                 lleft = linterp_exec(b->left);
3359                 right = interp_exec(b->right);
3360                 if (lleft) {
3361                         free_value(*lleft);
3362                         *lleft = right;
3363                 } else
3364                         free_value(right);      // NOTEST
3365                 right.type = NULL;
3366                 break;
3367
3368         case Declare:
3369         {
3370                 struct variable *v = cast(var, b->left)->var;
3371                 if (v->merged)
3372                         v = v->merged;
3373                 if (b->right)
3374                         right = interp_exec(b->right);
3375                 else
3376                         right = val_init(v->val.type);
3377                 free_value(v->val);
3378                 v->val = right;
3379                 right.type = NULL;
3380                 break;
3381         }
3382
3383 ### The `use` statement
3384
3385 The `use` statement is the last "simple" statement.  It is needed when
3386 the condition in a conditional statement is a block.  `use` works much
3387 like `return` in C, but only completes the `condition`, not the whole
3388 function.
3389
3390 ###### Binode types
3391         Use,
3392
3393 ###### SimpleStatement Grammar
3394         | use Expression ${
3395                 $0 = new_pos(binode, $1);
3396                 $0->op = Use;
3397                 $0->right = $<2;
3398         }$
3399
3400 ###### print binode cases
3401
3402         case Use:
3403                 do_indent(indent, "use ");
3404                 print_exec(b->right, -1, 0);
3405                 if (indent >= 0)
3406                         printf("\n");
3407                 break;
3408
3409 ###### propagate binode cases
3410
3411         case Use:
3412                 /* result matches value */
3413                 return propagate_types(b->right, c, ok, type, 0);
3414
3415 ###### interp binode cases
3416
3417         case Use:
3418                 rv = interp_exec(b->right);
3419                 break;
3420
3421 ### The Conditional Statement
3422
3423 This is the biggy and currently the only complex statement.  This
3424 subsumes `if`, `while`, `do/while`, `switch`, and some parts of `for`.
3425 It is comprised of a number of parts, all of which are optional though
3426 set combinations apply.  Each part is (usually) a key word (`then` is
3427 sometimes optional) followed by either an expression or a code block,
3428 except the `casepart` which is a "key word and an expression" followed
3429 by a code block.  The code-block option is valid for all parts and,
3430 where an expression is also allowed, the code block can use the `use`
3431 statement to report a value.  If the code block does not report a value
3432 the effect is similar to reporting `True`.
3433
3434 The `else` and `case` parts, as well as `then` when combined with
3435 `if`, can contain a `use` statement which will apply to some
3436 containing conditional statement. `for` parts, `do` parts and `then`
3437 parts used with `for` can never contain a `use`, except in some
3438 subordinate conditional statement.
3439
3440 If there is a `forpart`, it is executed first, only once.
3441 If there is a `dopart`, then it is executed repeatedly providing
3442 always that the `condpart` or `cond`, if present, does not return a non-True
3443 value.  `condpart` can fail to return any value if it simply executes
3444 to completion.  This is treated the same as returning `True`.
3445
3446 If there is a `thenpart` it will be executed whenever the `condpart`
3447 or `cond` returns True (or does not return any value), but this will happen
3448 *after* `dopart` (when present).
3449
3450 If `elsepart` is present it will be executed at most once when the
3451 condition returns `False` or some value that isn't `True` and isn't
3452 matched by any `casepart`.  If there are any `casepart`s, they will be
3453 executed when the condition returns a matching value.
3454
3455 The particular sorts of values allowed in case parts has not yet been
3456 determined in the language design, so nothing is prohibited.
3457
3458 The various blocks in this complex statement potentially provide scope
3459 for variables as described earlier.  Each such block must include the
3460 "OpenScope" nonterminal before parsing the block, and must call
3461 `var_block_close()` when closing the block.
3462
3463 The code following "`if`", "`switch`" and "`for`" does not get its own
3464 scope, but is in a scope covering the whole statement, so names
3465 declared there cannot be redeclared elsewhere.  Similarly the
3466 condition following "`while`" is in a scope the covers the body
3467 ("`do`" part) of the loop, and which does not allow conditional scope
3468 extension.  Code following "`then`" (both looping and non-looping),
3469 "`else`" and "`case`" each get their own local scope.
3470
3471 The type requirements on the code block in a `whilepart` are quite
3472 unusal.  It is allowed to return a value of some identifiable type, in
3473 which case the loop aborts and an appropriate `casepart` is run, or it
3474 can return a Boolean, in which case the loop either continues to the
3475 `dopart` (on `True`) or aborts and runs the `elsepart` (on `False`).
3476 This is different both from the `ifpart` code block which is expected to
3477 return a Boolean, or the `switchpart` code block which is expected to
3478 return the same type as the casepart values.  The correct analysis of
3479 the type of the `whilepart` code block is the reason for the
3480 `Rboolok` flag which is passed to `propagate_types()`.
3481
3482 The `cond_statement` cannot fit into a `binode` so a new `exec` is
3483 defined.
3484
3485 ###### exec type
3486         Xcond_statement,
3487
3488 ###### ast
3489         struct casepart {
3490                 struct exec *value;
3491                 struct exec *action;
3492                 struct casepart *next;
3493         };
3494         struct cond_statement {
3495                 struct exec;
3496                 struct exec *forpart, *condpart, *dopart, *thenpart, *elsepart;
3497                 struct casepart *casepart;
3498         };
3499
3500 ###### ast functions
3501
3502         static void free_casepart(struct casepart *cp)
3503         {
3504                 while (cp) {
3505                         struct casepart *t;
3506                         free_exec(cp->value);
3507                         free_exec(cp->action);
3508                         t = cp->next;
3509                         free(cp);
3510                         cp = t;
3511                 }
3512         }
3513
3514         static void free_cond_statement(struct cond_statement *s)
3515         {
3516                 if (!s)
3517                         return;
3518                 free_exec(s->forpart);
3519                 free_exec(s->condpart);
3520                 free_exec(s->dopart);
3521                 free_exec(s->thenpart);
3522                 free_exec(s->elsepart);
3523                 free_casepart(s->casepart);
3524                 free(s);
3525         }
3526
3527 ###### free exec cases
3528         case Xcond_statement: free_cond_statement(cast(cond_statement, e)); break;
3529
3530 ###### ComplexStatement Grammar
3531         | CondStatement ${ $0 = $<1; }$
3532
3533 ###### Grammar
3534
3535         $*cond_statement
3536         // both ForThen and Whilepart open scopes, and CondSuffix only
3537         // closes one - so in the first branch here we have another to close.
3538         CondStatement -> forPart ThenPart WhilePart CondSuffix ${
3539                         $0 = $<4;
3540                         $0->forpart = $<1;
3541                         $0->thenpart = $<2;
3542                         $0->condpart = $3.condpart; $3.condpart = NULL;
3543                         $0->dopart = $3.dopart; $3.dopart = NULL;
3544                         var_block_close(config2context(config), CloseSequential);
3545                         }$
3546                 |  forPart WhilePart CondSuffix ${
3547                         $0 = $<3;
3548                         $0->forpart = $<1;
3549                         $0->thenpart = NULL;
3550                         $0->condpart = $2.condpart; $2.condpart = NULL;
3551                         $0->dopart = $2.dopart; $2.dopart = NULL;
3552                         var_block_close(config2context(config), CloseSequential);
3553                         }$
3554                 | whilePart CondSuffix ${
3555                         $0 = $<2;
3556                         $0->condpart = $1.condpart; $1.condpart = NULL;
3557                         $0->dopart = $1.dopart; $1.dopart = NULL;
3558                         }$
3559                 | switchPart CondSuffix ${
3560                         $0 = $<2;
3561                         $0->condpart = $<1;
3562                         }$
3563                 | ifPart IfSuffix ${
3564                         $0 = $<2;
3565                         $0->condpart = $1.condpart; $1.condpart = NULL;
3566                         $0->thenpart = $1.thenpart; $1.thenpart = NULL;
3567                         // This is where we close an "if" statement
3568                         var_block_close(config2context(config), CloseSequential);
3569                         }$
3570
3571         CondSuffix -> IfSuffix ${
3572                         $0 = $<1;
3573                         // This is where we close scope of the whole
3574                         // "for" or "while" statement
3575                         var_block_close(config2context(config), CloseSequential);
3576                 }$
3577                 | CasePart CondSuffix ${
3578                         $0 = $<2;
3579                         $1->next = $0->casepart;
3580                         $0->casepart = $<1;
3581                 }$
3582
3583         $void
3584         Case -> case
3585                 | NEWLINE Case
3586         $*casepart
3587         CasePart -> Case Expression OpenScope Block ${
3588                         $0 = calloc(1,sizeof(struct casepart));
3589                         $0->value = $<2;
3590                         $0->action = $<4;
3591                         var_block_close(config2context(config), CloseParallel);
3592                 }$
3593
3594         $*cond_statement
3595         IfSuffix ->  ${ $0 = new(cond_statement); }$
3596                 | NEWLINE IfSuffix ${ $0 = $<2; }$
3597                 | else OpenScope Block ${
3598                         $0 = new(cond_statement);
3599                         $0->elsepart = $<3;
3600                         var_block_close(config2context(config), CloseElse);
3601                 }$
3602                 | else OpenScope CondStatement ${
3603                         $0 = new(cond_statement);
3604                         $0->elsepart = $<3;
3605                         var_block_close(config2context(config), CloseElse);
3606                 }$
3607
3608         $void
3609         Then -> then
3610                 | NEWLINE Then
3611         While -> while
3612                 | NEWLINE While
3613         Do -> do
3614                 | NEWLINE Do
3615         $*exec
3616         // These scopes are closed in CondSuffix
3617         forPart -> for OpenScope SimpleStatements ${
3618                         $0 = reorder_bilist($<3);
3619                 }$
3620                 |  for OpenScope Block ${
3621                         $0 = $<3;
3622                 }$
3623
3624         ThenPart -> Then OpenScope SimpleStatements ${
3625                         $0 = reorder_bilist($<3);
3626                         var_block_close(config2context(config), CloseSequential);
3627                 }$
3628                 |  Then OpenScope Block ${
3629                         $0 = $<3;
3630                         var_block_close(config2context(config), CloseSequential);
3631                 }$
3632
3633         // This scope is closed in CondSuffix
3634         WhileHead -> While OpenScope Block ${
3635                 $0 = $<3;
3636                 }$
3637         whileHead -> while OpenScope Block ${
3638                 $0 = $<3;
3639                 }$
3640
3641         $cond_statement
3642         // This scope is closed in CondSuffix
3643         whilePart -> while OpenScope Expression Block ${
3644                         $0.type = Xcond_statement;
3645                         $0.condpart = $<3;
3646                         $0.dopart = $<4;
3647                 }$
3648                 | whileHead Do Block ${
3649                         $0.type = Xcond_statement;
3650                         $0.condpart = $<1;
3651                         $0.dopart = $<3;
3652                 }$
3653         WhilePart -> While OpenScope Expression Block ${
3654                         $0.type = Xcond_statement;
3655                         $0.condpart = $<3;
3656                         $0.dopart = $<4;
3657                 }$
3658                 | WhileHead Do Block ${
3659                         $0.type = Xcond_statement;
3660                         $0.condpart = $<1;
3661                         $0.dopart = $<3;
3662                 }$
3663
3664         ifPart -> if OpenScope Expression OpenScope Block ${
3665                         $0.type = Xcond_statement;
3666                         $0.condpart = $<3;
3667                         $0.thenpart = $<5;
3668                         var_block_close(config2context(config), CloseParallel);
3669                 }$
3670                 | if OpenScope Block Then OpenScope Block ${
3671                         $0.type = Xcond_statement;
3672                         $0.condpart = $<3;
3673                         $0.thenpart = $<6;
3674                         var_block_close(config2context(config), CloseParallel);
3675                 }$
3676
3677         $*exec
3678         // This scope is closed in CondSuffix
3679         switchPart -> switch OpenScope Expression ${
3680                         $0 = $<3;
3681                 }$
3682                 | switch OpenScope Block ${
3683                         $0 = $<3;
3684                 }$
3685
3686 ###### print exec cases
3687
3688         case Xcond_statement:
3689         {
3690                 struct cond_statement *cs = cast(cond_statement, e);
3691                 struct casepart *cp;
3692                 if (cs->forpart) {
3693                         do_indent(indent, "for");
3694                         if (bracket) printf(" {\n"); else printf(":\n");
3695                         print_exec(cs->forpart, indent+1, bracket);
3696                         if (cs->thenpart) {
3697                                 if (bracket)
3698                                         do_indent(indent, "} then {\n");
3699                                 else
3700                                         do_indent(indent, "then:\n");
3701                                 print_exec(cs->thenpart, indent+1, bracket);
3702                         }
3703                         if (bracket) do_indent(indent, "}\n");
3704                 }
3705                 if (cs->dopart) {
3706                         // a loop
3707                         if (cs->condpart && cs->condpart->type == Xbinode &&
3708                             cast(binode, cs->condpart)->op == Block) {
3709                                 if (bracket)
3710                                         do_indent(indent, "while {\n");
3711                                 else
3712                                         do_indent(indent, "while:\n");
3713                                 print_exec(cs->condpart, indent+1, bracket);
3714                                 if (bracket)
3715                                         do_indent(indent, "} do {\n");
3716                                 else
3717                                         do_indent(indent, "do:\n");
3718                                 print_exec(cs->dopart, indent+1, bracket);
3719                                 if (bracket)
3720                                         do_indent(indent, "}\n");
3721                         } else {
3722                                 do_indent(indent, "while ");
3723                                 print_exec(cs->condpart, 0, bracket);
3724                                 if (bracket)
3725                                         printf(" {\n");
3726                                 else
3727                                         printf(":\n");
3728                                 print_exec(cs->dopart, indent+1, bracket);
3729                                 if (bracket)
3730                                         do_indent(indent, "}\n");
3731                         }
3732                 } else {
3733                         // a condition
3734                         if (cs->casepart)
3735                                 do_indent(indent, "switch");
3736                         else
3737                                 do_indent(indent, "if");
3738                         if (cs->condpart && cs->condpart->type == Xbinode &&
3739                             cast(binode, cs->condpart)->op == Block) {
3740                                 if (bracket)
3741                                         printf(" {\n");
3742                                 else
3743                                         printf(":\n");
3744                                 print_exec(cs->condpart, indent+1, bracket);
3745                                 if (bracket)
3746                                         do_indent(indent, "}\n");
3747                                 if (cs->thenpart) {
3748                                         do_indent(indent, "then:\n");
3749                                         print_exec(cs->thenpart, indent+1, bracket);
3750                                 }
3751                         } else {
3752                                 printf(" ");
3753                                 print_exec(cs->condpart, 0, bracket);
3754                                 if (cs->thenpart) {
3755                                         if (bracket)
3756                                                 printf(" {\n");
3757                                         else
3758                                                 printf(":\n");
3759                                         print_exec(cs->thenpart, indent+1, bracket);
3760                                         if (bracket)
3761                                                 do_indent(indent, "}\n");
3762                                 } else
3763                                         printf("\n");
3764                         }
3765                 }
3766                 for (cp = cs->casepart; cp; cp = cp->next) {
3767                         do_indent(indent, "case ");
3768                         print_exec(cp->value, -1, 0);
3769                         if (bracket)
3770                                 printf(" {\n");
3771                         else
3772                                 printf(":\n");
3773                         print_exec(cp->action, indent+1, bracket);
3774                         if (bracket)
3775                                 do_indent(indent, "}\n");
3776                 }
3777                 if (cs->elsepart) {
3778                         do_indent(indent, "else");
3779                         if (bracket)
3780                                 printf(" {\n");
3781                         else
3782                                 printf(":\n");
3783                         print_exec(cs->elsepart, indent+1, bracket);
3784                         if (bracket)
3785                                 do_indent(indent, "}\n");
3786                 }
3787                 break;
3788         }
3789
3790 ###### propagate exec cases
3791         case Xcond_statement:
3792         {
3793                 // forpart and dopart must return Tnone
3794                 // thenpart must return Tnone if there is a dopart,
3795                 // otherwise it is like elsepart.
3796                 // condpart must:
3797                 //    be bool if there is no casepart
3798                 //    match casepart->values if there is a switchpart
3799                 //    either be bool or match casepart->value if there
3800                 //             is a whilepart
3801                 // elsepart and casepart->action must match the return type
3802                 //   expected of this statement.
3803                 struct cond_statement *cs = cast(cond_statement, prog);
3804                 struct casepart *cp;
3805
3806                 t = propagate_types(cs->forpart, c, ok, Tnone, 0);
3807                 if (!type_compat(Tnone, t, 0))
3808                         *ok = 0;
3809                 t = propagate_types(cs->dopart, c, ok, Tnone, 0);
3810                 if (!type_compat(Tnone, t, 0))
3811                         *ok = 0;
3812                 if (cs->dopart) {
3813                         t = propagate_types(cs->thenpart, c, ok, Tnone, 0);
3814                         if (!type_compat(Tnone, t, 0))
3815                                 *ok = 0;
3816                 }
3817                 if (cs->casepart == NULL)
3818                         propagate_types(cs->condpart, c, ok, Tbool, 0);
3819                 else {
3820                         /* Condpart must match case values, with bool permitted */
3821                         t = NULL;
3822                         for (cp = cs->casepart;
3823                              cp && !t; cp = cp->next)
3824                                 t = propagate_types(cp->value, c, ok, NULL, 0);
3825                         if (!t && cs->condpart)
3826                                 t = propagate_types(cs->condpart, c, ok, NULL, Rboolok);
3827                         // Now we have a type (I hope) push it down
3828                         if (t) {
3829                                 for (cp = cs->casepart; cp; cp = cp->next)
3830                                         propagate_types(cp->value, c, ok, t, 0);
3831                                 propagate_types(cs->condpart, c, ok, t, Rboolok);
3832                         }
3833                 }
3834                 // (if)then, else, and case parts must return expected type.
3835                 if (!cs->dopart && !type)
3836                         type = propagate_types(cs->thenpart, c, ok, NULL, rules);
3837                 if (!type)
3838                         type = propagate_types(cs->elsepart, c, ok, NULL, rules);
3839                 for (cp = cs->casepart;
3840                      cp && !type;
3841                      cp = cp->next)
3842                         type = propagate_types(cp->action, c, ok, NULL, rules);
3843                 if (type) {
3844                         if (!cs->dopart)
3845                                 propagate_types(cs->thenpart, c, ok, type, rules);
3846                         propagate_types(cs->elsepart, c, ok, type, rules);
3847                         for (cp = cs->casepart; cp ; cp = cp->next)
3848                                 propagate_types(cp->action, c, ok, type, rules);
3849                         return type;
3850                 } else
3851                         return NULL;
3852         }
3853
3854 ###### interp exec cases
3855         case Xcond_statement:
3856         {
3857                 struct value v, cnd;
3858                 struct casepart *cp;
3859                 struct cond_statement *c = cast(cond_statement, e);
3860
3861                 if (c->forpart)
3862                         interp_exec(c->forpart);
3863                 do {
3864                         if (c->condpart)
3865                                 cnd = interp_exec(c->condpart);
3866                         else
3867                                 cnd.type = Tnone;
3868                         if (!(cnd.type == Tnone ||
3869                               (cnd.type == Tbool && cnd.bool != 0)))
3870                                 break;
3871                         // cnd is Tnone or Tbool, doesn't need to be freed
3872                         if (c->dopart)
3873                                 interp_exec(c->dopart);
3874
3875                         if (c->thenpart) {
3876                                 rv = interp_exec(c->thenpart);
3877                                 if (rv.type != Tnone || !c->dopart)
3878                                         goto Xcond_done;
3879                                 free_value(rv);
3880                         }
3881                 } while (c->dopart);
3882
3883                 for (cp = c->casepart; cp; cp = cp->next) {
3884                         v = interp_exec(cp->value);
3885                         if (value_cmp(v, cnd) == 0) {
3886                                 free_value(v);
3887                                 free_value(cnd);
3888                                 rv = interp_exec(cp->action);
3889                                 goto Xcond_done;
3890                         }
3891                         free_value(v);
3892                 }
3893                 free_value(cnd);
3894                 if (c->elsepart)
3895                         rv = interp_exec(c->elsepart);
3896                 else
3897                         rv.type = Tnone;
3898         Xcond_done:
3899                 break;
3900         }
3901
3902 ### Top level structure
3903
3904 All the language elements so far can be used in various places.  Now
3905 it is time to clarify what those places are.
3906
3907 At the top level of a file there will be a number of declarations.
3908 Many of the things that can be declared haven't been described yet,
3909 such as functions, procedures, imports, and probably more.
3910 For now there are two sorts of things that can appear at the top
3911 level.  They are predefined constants, `struct` types, and the main
3912 program.  While the syntax will allow the main program to appear
3913 multiple times, that will trigger an error if it is actually attempted.
3914
3915 The various declarations do not return anything.  They store the
3916 various declarations in the parse context.
3917
3918 ###### Parser: grammar
3919
3920         $void
3921         Ocean -> DeclarationList
3922
3923         DeclarationList -> Declaration
3924                 | DeclarationList Declaration
3925
3926         Declaration -> DeclareConstant
3927                 | DeclareProgram
3928                 | DeclareStruct
3929                 | NEWLINE
3930
3931         ## top level grammar
3932
3933 ### The `const` section
3934
3935 As well as being defined in with the code that uses them, constants
3936 can be declared at the top level.  These have full-file scope, so they
3937 are always `InScope`.  The value of a top level constant can be given
3938 as an expression, and this is evaluated immediately rather than in the
3939 later interpretation stage.  Once we add functions to the language, we
3940 will need rules concern which, if any, can be used to define a top
3941 level constant.
3942
3943 Constants are defined in a section that starts with the reserved word
3944 `const` and then has a block with a list of assignment statements.
3945 For syntactic consistency, these must use the double-colon syntax to
3946 make it clear that they are constants.  Type can also be given: if
3947 not, the type will be determined during analysis, as with other
3948 constants.
3949
3950 As the types constants are inserted at the head of a list, printing
3951 them in the same order that they were read is not straight forward.
3952 We take a quadratic approach here and count the number of constants
3953 (variables of depth 0), then count down from there, each time
3954 searching through for the Nth constant for decreasing N.
3955
3956 ###### top level grammar
3957
3958         DeclareConstant -> const Open ConstList Close
3959                 | const Open SimpleConstList }
3960                 | const : ConstList
3961                 | const SimpleConstList NEWLINE
3962
3963         ConstList -> ComplexConsts
3964                 | NEWLINE ConstList
3965         ComplexConsts -> ComplexConst ComplexConsts
3966                 | ComplexConst
3967         ComplexConst -> SimpleConstList NEWLINE
3968         SimpleConstList -> SimpleConstList ; Const
3969                 | Const
3970                 | SimpleConstList ;
3971
3972         $*type
3973         CType -> Type   ${ $0 = $<1; }$
3974                 |       ${ $0 = NULL; }$
3975         $void
3976         Const -> IDENTIFIER :: CType = Expression ${ {
3977                 int ok;
3978                 struct variable *v;
3979
3980                 v = var_decl(config2context(config), $1.txt);
3981                 if (v) {
3982                         struct var *var = new_pos(var, $1);
3983                         v->where_decl = var;
3984                         v->where_set = var;
3985                         var->var = v;
3986                         v->constant = 1;
3987                 } else {
3988                         v = var_ref(config2context(config), $1.txt);
3989                         tok_err(config2context(config), "error: name already declared", &$1);
3990                         type_err(config2context(config), "info: this is where '%v' was first declared",
3991                                  v->where_decl, NULL, 0, NULL);
3992                 }
3993                 do {
3994                         ok = 1;
3995                         propagate_types($5, config2context(config), &ok, $3, 0);
3996                 } while (ok == 2);
3997                 if (!ok)
3998                         config2context(config)->parse_error = 1;
3999                 else if (v) {
4000                         v->val = interp_exec($5);
4001                 }
4002         } }$
4003
4004 ###### print const decls
4005         {
4006                 struct variable *v;
4007                 int target = -1;
4008
4009                 while (target != 0) {
4010                         int i = 0;
4011                         for (v = context.in_scope; v; v=v->in_scope)
4012                                 if (v->depth == 0) {
4013                                         i += 1;
4014                                         if (i == target)
4015                                                 break;
4016                                 }
4017
4018                         if (target == -1) {
4019                                 if (i)
4020                                         printf("const:\n");
4021                                 target = i;
4022                         } else {
4023                                 printf("    %.*s :: ", v->name->name.len, v->name->name.txt);
4024                                 type_print(v->val.type, stdout);
4025                                 printf(" = ");
4026                                 if (v->val.type == Tstr)
4027                                         printf("\"");
4028                                 print_value(v->val);
4029                                 if (v->val.type == Tstr)
4030                                         printf("\"");
4031                                 printf("\n");
4032                                 target -= 1;
4033                         }
4034                 }
4035         }
4036
4037 ### Finally the whole program.
4038
4039 Somewhat reminiscent of Pascal a (current) Ocean program starts with
4040 the keyword "program" and a list of variable names which are assigned
4041 values from command line arguments.  Following this is a `block` which
4042 is the code to execute.  Unlike Pascal, constants and other
4043 declarations come *before* the program.
4044
4045 As this is the top level, several things are handled a bit
4046 differently.
4047 The whole program is not interpreted by `interp_exec` as that isn't
4048 passed the argument list which the program requires.  Similarly type
4049 analysis is a bit more interesting at this level.
4050
4051 ###### Binode types
4052         Program,
4053
4054 ###### top level grammar
4055
4056         DeclareProgram -> Program ${ {
4057                 struct parse_context *c = config2context(config);
4058                 if (c->prog)
4059                         type_err(c, "Program defined a second time",
4060                                  $1, NULL, 0, NULL);
4061                 else
4062                         c->prog = $<1;
4063         } }$
4064
4065         $*binode
4066         Program -> program OpenScope Varlist Block ${
4067                 $0 = new(binode);
4068                 $0->op = Program;
4069                 $0->left = reorder_bilist($<3);
4070                 $0->right = $<4;
4071                 var_block_close(config2context(config), CloseSequential);
4072                 if (config2context(config)->scope_stack) abort();
4073                 }$
4074                 | ERROR ${
4075                         tok_err(config2context(config),
4076                                 "error: unhandled parse error", &$1);
4077                 }$
4078
4079         Varlist -> Varlist ArgDecl ${
4080                         $0 = new(binode);
4081                         $0->op = Program;
4082                         $0->left = $<1;
4083                         $0->right = $<2;
4084                 }$
4085                 | ${ $0 = NULL; }$
4086
4087         $*var
4088         ArgDecl -> IDENTIFIER ${ {
4089                 struct variable *v = var_decl(config2context(config), $1.txt);
4090                 $0 = new(var);
4091                 $0->var = v;
4092         } }$
4093
4094         ## Grammar
4095
4096 ###### print binode cases
4097         case Program:
4098                 do_indent(indent, "program");
4099                 for (b2 = cast(binode, b->left); b2; b2 = cast(binode, b2->right)) {
4100                         printf(" ");
4101                         print_exec(b2->left, 0, 0);
4102                 }
4103                 if (bracket)
4104                         printf(" {\n");
4105                 else
4106                         printf(":\n");
4107                 print_exec(b->right, indent+1, bracket);
4108                 if (bracket)
4109                         do_indent(indent, "}\n");
4110                 break;
4111
4112 ###### propagate binode cases
4113         case Program: abort();          // NOTEST
4114
4115 ###### core functions
4116
4117         static int analyse_prog(struct exec *prog, struct parse_context *c)
4118         {
4119                 struct binode *b = cast(binode, prog);
4120                 int ok = 1;
4121
4122                 if (!b)
4123                         return 0;       // NOTEST
4124                 do {
4125                         ok = 1;
4126                         propagate_types(b->right, c, &ok, Tnone, 0);
4127                 } while (ok == 2);
4128                 if (!ok)
4129                         return 0;
4130
4131                 for (b = cast(binode, b->left); b; b = cast(binode, b->right)) {
4132                         struct var *v = cast(var, b->left);
4133                         if (!v->var->val.type) {
4134                                 v->var->where_set = b;
4135                                 v->var->val = val_prepare(Tstr);
4136                         }
4137                 }
4138                 b = cast(binode, prog);
4139                 do {
4140                         ok = 1;
4141                         propagate_types(b->right, c, &ok, Tnone, 0);
4142                 } while (ok == 2);
4143                 if (!ok)
4144                         return 0;
4145
4146                 /* Make sure everything is still consistent */
4147                 propagate_types(b->right, c, &ok, Tnone, 0);
4148                 return !!ok;
4149         }
4150
4151         static void interp_prog(struct exec *prog, char **argv)
4152         {
4153                 struct binode *p = cast(binode, prog);
4154                 struct binode *al;
4155                 struct value v;
4156
4157                 if (!prog)
4158                         return;         // NOTEST
4159                 al = cast(binode, p->left);
4160                 while (al) {
4161                         struct var *v = cast(var, al->left);
4162                         struct value *vl = &v->var->val;
4163
4164                         if (argv[0] == NULL) {
4165                                 printf("Not enough args\n");
4166                                 exit(1);
4167                         }
4168                         al = cast(binode, al->right);
4169                         free_value(*vl);
4170                         *vl = parse_value(vl->type, argv[0]);
4171                         if (vl->type == NULL)
4172                                 exit(1);
4173                         argv++;
4174                 }
4175                 v = interp_exec(p->right);
4176                 free_value(v);
4177         }
4178
4179 ###### interp binode cases
4180         case Program: abort();  // NOTEST
4181
4182 ## And now to test it out.
4183
4184 Having a language requires having a "hello world" program.  I'll
4185 provide a little more than that: a program that prints "Hello world"
4186 finds the GCD of two numbers, prints the first few elements of
4187 Fibonacci, performs a binary search for a number, and a few other
4188 things which will likely grow as the languages grows.
4189
4190 ###### File: oceani.mk
4191         demos :: sayhello
4192         sayhello : oceani
4193                 @echo "===== DEMO ====="
4194                 ./oceani --section "demo: hello" oceani.mdc 55 33
4195
4196 ###### demo: hello
4197
4198         const:
4199                 pi ::= 3.141_592_6
4200                 four ::= 2 + 2 ; five ::= 10/2
4201         const pie ::= "I like Pie";
4202                 cake ::= "The cake is"
4203                   ++ " a lie"
4204
4205         struct fred:
4206                 size:[four]number
4207                 name:string
4208                 alive:Boolean
4209
4210         program A B:
4211                 print "Hello World, what lovely oceans you have!"
4212                 print "Are there", five, "?"
4213                 print pi, pie, "but", cake
4214
4215                 /* When a variable is defined in both branches of an 'if',
4216                  * and used afterwards, the variables are merged.
4217                  */
4218                 if A > B:
4219                         bigger := "yes"
4220                 else:
4221                         bigger := "no"
4222                 print "Is", A, "bigger than", B,"? ", bigger
4223                 /* If a variable is not used after the 'if', no
4224                  * merge happens, so types can be different
4225                  */
4226                 if A > B * 2:
4227                         double:string = "yes"
4228                         print A, "is more than twice", B, "?", double
4229                 else:
4230                         double := B*2
4231                         print "double", B, "is", double
4232
4233                 a : number
4234                 a = A;
4235                 b:number = B
4236                 if a > 0 and then b > 0:
4237                         while a != b:
4238                                 if a < b:
4239                                         b = b - a
4240                                 else:
4241                                         a = a - b
4242                         print "GCD of", A, "and", B,"is", a
4243                 else if a <= 0:
4244                         print a, "is not positive, cannot calculate GCD"
4245                 else:
4246                         print b, "is not positive, cannot calculate GCD"
4247
4248                 for:
4249                         togo := 10
4250                         f1 := 1; f2 := 1
4251                         print "Fibonacci:", f1,f2,
4252                 then togo = togo - 1
4253                 while togo > 0:
4254                         f3 := f1 + f2
4255                         print "", f3,
4256                         f1 = f2
4257                         f2 = f3
4258                 print ""
4259
4260                 /* Binary search... */
4261                 for:
4262                         lo:= 0; hi := 100
4263                         target := 77
4264                 while:
4265                         mid := (lo + hi) / 2
4266                         if mid == target:
4267                                 use Found
4268                         if mid < target:
4269                                 lo = mid
4270                         else:
4271                                 hi = mid
4272                         if hi - lo < 1:
4273                                 use GiveUp
4274                         use True
4275                 do: pass
4276                 case Found:
4277                         print "Yay, I found", target
4278                 case GiveUp:
4279                         print "Closest I found was", mid
4280
4281                 size::= 10
4282                 list:[size]number
4283                 list[0] = 1234
4284                 // "middle square" PRNG.  Not particularly good, but one my
4285                 // Dad taught me - the first one I ever heard of.
4286                 for i:=1; then i = i + 1; while i < size:
4287                         n := list[i-1] * list[i-1]
4288                         list[i] = (n / 100) % 10 000
4289
4290                 print "Before sort:",
4291                 for i:=0; then i = i + 1; while i < size:
4292                         print "", list[i],
4293                 print
4294
4295                 for i := 1; then i=i+1; while i < size:
4296                         for j:=i-1; then j=j-1; while j >= 0:
4297                                 if list[j] > list[j+1]:
4298                                         t:= list[j]
4299                                         list[j] = list[j+1]
4300                                         list[j+1] = t
4301                 print " After sort:",
4302                 for i:=0; then i = i + 1; while i < size:
4303                         print "", list[i],
4304                 print
4305
4306                 bob:fred
4307                 bob.name = "Hello"
4308                 bob.alive = (bob.name == "Hello")
4309                 print "bob", "is" if  bob.alive else "isn't", "alive"