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