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->min_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, 0);
1748                 printf("[");
1749                 print_exec(b->right, -1, 0);
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, 0);
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
2023         $void
2024         Open -> {
2025                 | NEWLINE Open
2026         Close -> }
2027                 | NEWLINE Close
2028         $*fieldlist
2029         FieldBlock -> Open FieldList Close ${ $0 = $<2; }$
2030                 | Open SimpleFieldList } ${ $0 = $<2; }$
2031                 | : FieldList  ${ $0 = $<2; }$
2032
2033         FieldList -> SimpleFieldList NEWLINE ${ $0 = $<1; }$
2034                 | FieldList SimpleFieldList NEWLINE ${
2035                         $2->prev = $<1;
2036                         $0 = $<2;
2037                 }$
2038
2039         SimpleFieldList -> Field ${ $0 = $<1; }$
2040                 | SimpleFieldList ; Field ${
2041                         $3->prev = $<1;
2042                         $0 = $<3;
2043                 }$
2044                 | SimpleFieldList ; ${
2045                         $0 = $<1;
2046                 }$
2047
2048         Field -> IDENTIFIER : Type = Expression ${ {
2049                         int ok;
2050
2051                         $0 = calloc(1, sizeof(struct fieldlist));
2052                         $0->f.name = $1.txt;
2053                         $0->f.type = $<3;
2054                         $0->f.init = val_prepare($0->f.type);
2055                         do {
2056                                 ok = 1;
2057                                 propagate_types($<5, c, &ok, $3, 0);
2058                         } while (ok == 2);
2059                         if (!ok)
2060                                 c->parse_error = 1;
2061                         else
2062                                 $0->f.init = interp_exec($5);
2063                 } }$
2064                 | IDENTIFIER : Type ${
2065                         $0 = calloc(1, sizeof(struct fieldlist));
2066                         $0->f.name = $1.txt;
2067                         $0->f.type = $<3;
2068                         $0->f.init = val_init($3);
2069                 }$
2070
2071 ###### forward decls
2072         static void structure_print_type(struct type *t, FILE *f);
2073
2074 ###### value functions
2075         static void structure_print_type(struct type *t, FILE *f)
2076         {
2077                 int i;
2078
2079                 fprintf(f, "struct %.*s:\n", t->name.len, t->name.txt);
2080
2081                 for (i = 0; i < t->structure.nfields; i++) {
2082                         struct field *fl = t->structure.fields + i;
2083                         fprintf(f, "    %.*s : ", fl->name.len, fl->name.txt);
2084                         type_print(fl->type, f);
2085                         if (fl->init.type->print) {
2086                                 fprintf(f, " = ");
2087                                 if (fl->init.type == Tstr)
2088                                         fprintf(f, "\"");
2089                                 print_value(fl->init);
2090                                 if (fl->init.type == Tstr)
2091                                         fprintf(f, "\"");
2092                         }
2093                         printf("\n");
2094                 }
2095         }
2096
2097 ###### print type decls
2098         {
2099                 struct type *t;
2100                 int target = -1;
2101
2102                 while (target != 0) {
2103                         int i = 0;
2104                         for (t = context.typelist; t ; t=t->next)
2105                                 if (t->print_type_decl) {
2106                                         i += 1;
2107                                         if (i == target)
2108                                                 break;
2109                                 }
2110
2111                         if (target == -1) {
2112                                 target = i;
2113                         } else {
2114                                 t->print_type_decl(t, stdout);
2115                                 target -= 1;
2116                         }
2117                 }
2118         }
2119
2120 ## Executables: the elements of code
2121
2122 Each code element needs to be parsed, printed, analysed,
2123 interpreted, and freed.  There are several, so let's just start with
2124 the easy ones and work our way up.
2125
2126 ### Values
2127
2128 We have already met values as separate objects.  When manifest
2129 constants appear in the program text, that must result in an executable
2130 which has a constant value.  So the `val` structure embeds a value in
2131 an executable.
2132
2133 ###### exec type
2134         Xval,
2135
2136 ###### ast
2137         struct val {
2138                 struct exec;
2139                 struct value val;
2140         };
2141
2142 ###### Grammar
2143
2144         $*val
2145         Value ->  True ${
2146                         $0 = new_pos(val, $1);
2147                         $0->val.type = Tbool;
2148                         $0->val.bool = 1;
2149                         }$
2150                 | False ${
2151                         $0 = new_pos(val, $1);
2152                         $0->val.type = Tbool;
2153                         $0->val.bool = 0;
2154                         }$
2155                 | NUMBER ${
2156                         $0 = new_pos(val, $1);
2157                         $0->val.type = Tnum;
2158                         {
2159                         char tail[3];
2160                         if (number_parse($0->val.num, tail, $1.txt) == 0)
2161                                 mpq_init($0->val.num);
2162                                 if (tail[0])
2163                                         tok_err(c, "error: unsupported number suffix",
2164                                                 &$1);
2165                         }
2166                         }$
2167                 | STRING ${
2168                         $0 = new_pos(val, $1);
2169                         $0->val.type = Tstr;
2170                         {
2171                         char tail[3];
2172                         string_parse(&$1, '\\', &$0->val.str, tail);
2173                         if (tail[0])
2174                                 tok_err(c, "error: unsupported string suffix",
2175                                         &$1);
2176                         }
2177                         }$
2178                 | MULTI_STRING ${
2179                         $0 = new_pos(val, $1);
2180                         $0->val.type = Tstr;
2181                         {
2182                         char tail[3];
2183                         string_parse(&$1, '\\', &$0->val.str, tail);
2184                         if (tail[0])
2185                                 tok_err(c, "error: unsupported string suffix",
2186                                         &$1);
2187                         }
2188                         }$
2189
2190 ###### print exec cases
2191         case Xval:
2192         {
2193                 struct val *v = cast(val, e);
2194                 if (v->val.type == Tstr)
2195                         printf("\"");
2196                 print_value(v->val);
2197                 if (v->val.type == Tstr)
2198                         printf("\"");
2199                 break;
2200         }
2201
2202 ###### propagate exec cases
2203         case Xval:
2204         {
2205                 struct val *val = cast(val, prog);
2206                 if (!type_compat(type, val->val.type, rules))
2207                         type_err(c, "error: expected %1%r found %2",
2208                                    prog, type, rules, val->val.type);
2209                 return val->val.type;
2210         }
2211
2212 ###### interp exec cases
2213         case Xval:
2214                 rv = dup_value(cast(val, e)->val);
2215                 break;
2216
2217 ###### ast functions
2218         static void free_val(struct val *v)
2219         {
2220                 if (!v)
2221                         return;
2222                 free_value(v->val);
2223                 free(v);
2224         }
2225
2226 ###### free exec cases
2227         case Xval: free_val(cast(val, e)); break;
2228
2229 ###### ast functions
2230         // Move all nodes from 'b' to 'rv', reversing the order.
2231         // In 'b' 'left' is a list, and 'right' is the last node.
2232         // In 'rv', left' is the first node and 'right' is a list.
2233         static struct binode *reorder_bilist(struct binode *b)
2234         {
2235                 struct binode *rv = NULL;
2236
2237                 while (b) {
2238                         struct exec *t = b->right;
2239                         b->right = rv;
2240                         rv = b;
2241                         if (b->left)
2242                                 b = cast(binode, b->left);
2243                         else
2244                                 b = NULL;
2245                         rv->left = t;
2246                 }
2247                 return rv;
2248         }
2249
2250 ### Variables
2251
2252 Just as we used a `val` to wrap a value into an `exec`, we similarly
2253 need a `var` to wrap a `variable` into an exec.  While each `val`
2254 contained a copy of the value, each `var` hold a link to the variable
2255 because it really is the same variable no matter where it appears.
2256 When a variable is used, we need to remember to follow the `->merged`
2257 link to find the primary instance.
2258
2259 ###### exec type
2260         Xvar,
2261
2262 ###### ast
2263         struct var {
2264                 struct exec;
2265                 struct variable *var;
2266         };
2267
2268 ###### Grammar
2269
2270         $*var
2271         VariableDecl -> IDENTIFIER : ${ {
2272                 struct variable *v = var_decl(c, $1.txt);
2273                 $0 = new_pos(var, $1);
2274                 $0->var = v;
2275                 if (v)
2276                         v->where_decl = $0;
2277                 else {
2278                         v = var_ref(c, $1.txt);
2279                         $0->var = v;
2280                         type_err(c, "error: variable '%v' redeclared",
2281                                  $0, NULL, 0, NULL);
2282                         type_err(c, "info: this is where '%v' was first declared",
2283                                  v->where_decl, NULL, 0, NULL);
2284                 }
2285         } }$
2286             | IDENTIFIER :: ${ {
2287                 struct variable *v = var_decl(c, $1.txt);
2288                 $0 = new_pos(var, $1);
2289                 $0->var = v;
2290                 if (v) {
2291                         v->where_decl = $0;
2292                         v->constant = 1;
2293                 } else {
2294                         v = var_ref(c, $1.txt);
2295                         $0->var = v;
2296                         type_err(c, "error: variable '%v' redeclared",
2297                                  $0, NULL, 0, NULL);
2298                         type_err(c, "info: this is where '%v' was first declared",
2299                                  v->where_decl, NULL, 0, NULL);
2300                 }
2301         } }$
2302             | IDENTIFIER : Type ${ {
2303                 struct variable *v = var_decl(c, $1.txt);
2304                 $0 = new_pos(var, $1);
2305                 $0->var = v;
2306                 if (v) {
2307                         v->where_decl = $0;
2308                         v->where_set = $0;
2309                         v->val = val_prepare($<3);
2310                 } else {
2311                         v = var_ref(c, $1.txt);
2312                         $0->var = v;
2313                         type_err(c, "error: variable '%v' redeclared",
2314                                  $0, NULL, 0, NULL);
2315                         type_err(c, "info: this is where '%v' was first declared",
2316                                  v->where_decl, NULL, 0, NULL);
2317                 }
2318         } }$
2319             | IDENTIFIER :: Type ${ {
2320                 struct variable *v = var_decl(c, $1.txt);
2321                 $0 = new_pos(var, $1);
2322                 $0->var = v;
2323                 if (v) {
2324                         v->where_decl = $0;
2325                         v->where_set = $0;
2326                         v->val = val_prepare($<3);
2327                         v->constant = 1;
2328                 } else {
2329                         v = var_ref(c, $1.txt);
2330                         $0->var = v;
2331                         type_err(c, "error: variable '%v' redeclared",
2332                                  $0, NULL, 0, NULL);
2333                         type_err(c, "info: this is where '%v' was first declared",
2334                                  v->where_decl, NULL, 0, NULL);
2335                 }
2336         } }$
2337
2338         $*exec
2339         Variable -> IDENTIFIER ${ {
2340                 struct variable *v = var_ref(c, $1.txt);
2341                 $0 = new_pos(var, $1);
2342                 if (v == NULL) {
2343                         /* This might be a label - allocate a var just in case */
2344                         v = var_decl(c, $1.txt);
2345                         if (v) {
2346                                 v->val = val_prepare(Tlabel);
2347                                 v->val.label = &v->val;
2348                                 v->where_set = $0;
2349                         }
2350                 }
2351                 cast(var, $0)->var = v;
2352         } }$
2353         ## variable grammar
2354
2355         $*type
2356         Type -> IDENTIFIER ${
2357                 $0 = find_type(c, $1.txt);
2358                 if (!$0) {
2359                         tok_err(c,
2360                                 "error: undefined type", &$1);
2361
2362                         $0 = Tnone;
2363                 }
2364         }$
2365         ## type grammar
2366
2367 ###### print exec cases
2368         case Xvar:
2369         {
2370                 struct var *v = cast(var, e);
2371                 if (v->var) {
2372                         struct binding *b = v->var->name;
2373                         printf("%.*s", b->name.len, b->name.txt);
2374                 }
2375                 break;
2376         }
2377
2378 ###### format cases
2379         case 'v':
2380                 if (loc->type == Xvar) {
2381                         struct var *v = cast(var, loc);
2382                         if (v->var) {
2383                                 struct binding *b = v->var->name;
2384                                 fprintf(stderr, "%.*s", b->name.len, b->name.txt);
2385                         } else
2386                                 fputs("???", stderr);   // NOTEST
2387                 } else
2388                         fputs("NOTVAR", stderr);        // NOTEST
2389                 break;
2390
2391 ###### propagate exec cases
2392
2393         case Xvar:
2394         {
2395                 struct var *var = cast(var, prog);
2396                 struct variable *v = var->var;
2397                 if (!v) {
2398                         type_err(c, "%d:BUG: no variable!!", prog, NULL, 0, NULL); // NOTEST
2399                         return Tnone;                                   // NOTEST
2400                 }
2401                 if (v->merged)
2402                         v = v->merged;
2403                 if (v->constant && (rules & Rnoconstant)) {
2404                         type_err(c, "error: Cannot assign to a constant: %v",
2405                                  prog, NULL, 0, NULL);
2406                         type_err(c, "info: name was defined as a constant here",
2407                                  v->where_decl, NULL, 0, NULL);
2408                         return v->val.type;
2409                 }
2410                 if (v->val.type == NULL) {
2411                         if (type && *ok != 0) {
2412                                 v->val = val_prepare(type);
2413                                 v->where_set = prog;
2414                                 *ok = 2;
2415                         }
2416                         return type;
2417                 }
2418                 if (!type_compat(type, v->val.type, rules)) {
2419                         type_err(c, "error: expected %1%r but variable '%v' is %2", prog,
2420                                  type, rules, v->val.type);
2421                         type_err(c, "info: this is where '%v' was set to %1", v->where_set,
2422                                  v->val.type, rules, NULL);
2423                 }
2424                 if (!type)
2425                         return v->val.type;
2426                 return type;
2427         }
2428
2429 ###### interp exec cases
2430         case Xvar:
2431         {
2432                 struct var *var = cast(var, e);
2433                 struct variable *v = var->var;
2434
2435                 if (v->merged)
2436                         v = v->merged;
2437                 lrv = &v->val;
2438                 break;
2439         }
2440
2441 ###### ast functions
2442
2443         static void free_var(struct var *v)
2444         {
2445                 free(v);
2446         }
2447
2448 ###### free exec cases
2449         case Xvar: free_var(cast(var, e)); break;
2450
2451 ### Expressions: Conditional
2452
2453 Our first user of the `binode` will be conditional expressions, which
2454 is a bit odd as they actually have three components.  That will be
2455 handled by having 2 binodes for each expression.  The conditional
2456 expression is the lowest precedence operatior, so it gets to define
2457 what an "Expression" is.  The next level up is "BoolExpr", which
2458 comes next.
2459
2460 Conditional expressions are of the form "value `if` condition `else`
2461 other_value".  They associate to the right, so everything to the right
2462 of `else` is part of an else value, while only the BoolExpr to the
2463 left of `if` is the if values.  Between `if` and `else` there is no
2464 room for ambiguity, so a full conditional expression is allowed in there.
2465
2466 ###### Binode types
2467         CondExpr,
2468
2469 ###### Grammar
2470
2471         $*exec
2472         Expression -> BoolExpr if Expression else Expression ${ {
2473                         struct binode *b1 = new(binode);
2474                         struct binode *b2 = new(binode);
2475                         b1->op = CondExpr;
2476                         b1->left = $<3;
2477                         b1->right = b2;
2478                         b2->op = CondExpr;
2479                         b2->left = $<1;
2480                         b2->right = $<5;
2481                         $0 = b1;
2482                 } }$
2483                 | BoolExpr ${ $0 = $<1; }$
2484
2485 ###### print binode cases
2486
2487         case CondExpr:
2488                 b2 = cast(binode, b->right);
2489                 print_exec(b2->left, -1, 0);
2490                 printf(" if ");
2491                 print_exec(b->left, -1, 0);
2492                 printf(" else ");
2493                 print_exec(b2->right, -1, 0);
2494                 break;
2495
2496 ###### propagate binode cases
2497
2498         case CondExpr: {
2499                 /* cond must be Tbool, others must match */
2500                 struct binode *b2 = cast(binode, b->right);
2501                 struct type *t2;
2502
2503                 propagate_types(b->left, c, ok, Tbool, 0);
2504                 t = propagate_types(b2->left, c, ok, type, Rnolabel);
2505                 t2 = propagate_types(b2->right, c, ok, type ?: t, Rnolabel);
2506                 return t ?: t2;
2507         }
2508
2509 ###### interp binode cases
2510
2511         case CondExpr: {
2512                 struct binode *b2 = cast(binode, b->right);
2513                 left = interp_exec(b->left);
2514                 if (left.bool)
2515                         rv = interp_exec(b2->left);
2516                 else
2517                         rv = interp_exec(b2->right);
2518                 }
2519                 break;
2520
2521 ### Expressions: Boolean
2522
2523 The next class of expressions to use the `binode` will be Boolean
2524 expressions.  As I haven't implemented precedence in the parser
2525 generator yet, we need different names for each precedence level used
2526 by expressions.  The outer most or lowest level precedence after
2527 conditional expressions are Boolean operators which form an `BoolExpr`
2528 out of `BTerm`s and `BFact`s.  As well as `or` `and`, and `not` we
2529 have `and then` and `or else` which only evaluate the second operand
2530 if the result would make a difference.
2531
2532 ###### Binode types
2533         And,
2534         AndThen,
2535         Or,
2536         OrElse,
2537         Not,
2538
2539 ###### Grammar
2540
2541         $*exec
2542         BoolExpr -> BoolExpr or BTerm ${ {
2543                         struct binode *b = new(binode);
2544                         b->op = Or;
2545                         b->left = $<1;
2546                         b->right = $<3;
2547                         $0 = b;
2548                 } }$
2549                 | BoolExpr or else BTerm ${ {
2550                         struct binode *b = new(binode);
2551                         b->op = OrElse;
2552                         b->left = $<1;
2553                         b->right = $<4;
2554                         $0 = b;
2555                 } }$
2556                 | BTerm ${ $0 = $<1; }$
2557
2558         BTerm -> BTerm and BFact ${ {
2559                         struct binode *b = new(binode);
2560                         b->op = And;
2561                         b->left = $<1;
2562                         b->right = $<3;
2563                         $0 = b;
2564                 } }$
2565                 | BTerm and then BFact ${ {
2566                         struct binode *b = new(binode);
2567                         b->op = AndThen;
2568                         b->left = $<1;
2569                         b->right = $<4;
2570                         $0 = b;
2571                 } }$
2572                 | BFact ${ $0 = $<1; }$
2573
2574         BFact -> not BFact ${ {
2575                         struct binode *b = new(binode);
2576                         b->op = Not;
2577                         b->right = $<2;
2578                         $0 = b;
2579                 } }$
2580                 ## other BFact
2581
2582 ###### print binode cases
2583         case And:
2584                 print_exec(b->left, -1, 0);
2585                 printf(" and ");
2586                 print_exec(b->right, -1, 0);
2587                 break;
2588         case AndThen:
2589                 print_exec(b->left, -1, 0);
2590                 printf(" and then ");
2591                 print_exec(b->right, -1, 0);
2592                 break;
2593         case Or:
2594                 print_exec(b->left, -1, 0);
2595                 printf(" or ");
2596                 print_exec(b->right, -1, 0);
2597                 break;
2598         case OrElse:
2599                 print_exec(b->left, -1, 0);
2600                 printf(" or else ");
2601                 print_exec(b->right, -1, 0);
2602                 break;
2603         case Not:
2604                 printf("not ");
2605                 print_exec(b->right, -1, 0);
2606                 break;
2607
2608 ###### propagate binode cases
2609         case And:
2610         case AndThen:
2611         case Or:
2612         case OrElse:
2613         case Not:
2614                 /* both must be Tbool, result is Tbool */
2615                 propagate_types(b->left, c, ok, Tbool, 0);
2616                 propagate_types(b->right, c, ok, Tbool, 0);
2617                 if (type && type != Tbool)
2618                         type_err(c, "error: %1 operation found where %2 expected", prog,
2619                                    Tbool, 0, type);
2620                 return Tbool;
2621
2622 ###### interp binode cases
2623         case And:
2624                 rv = interp_exec(b->left);
2625                 right = interp_exec(b->right);
2626                 rv.bool = rv.bool && right.bool;
2627                 break;
2628         case AndThen:
2629                 rv = interp_exec(b->left);
2630                 if (rv.bool)
2631                         rv = interp_exec(b->right);
2632                 break;
2633         case Or:
2634                 rv = interp_exec(b->left);
2635                 right = interp_exec(b->right);
2636                 rv.bool = rv.bool || right.bool;
2637                 break;
2638         case OrElse:
2639                 rv = interp_exec(b->left);
2640                 if (!rv.bool)
2641                         rv = interp_exec(b->right);
2642                 break;
2643         case Not:
2644                 rv = interp_exec(b->right);
2645                 rv.bool = !rv.bool;
2646                 break;
2647
2648 ### Expressions: Comparison
2649
2650 Of slightly higher precedence that Boolean expressions are
2651 Comparisons.
2652 A comparison takes arguments of any comparable type, but the two types must be
2653 the same.
2654
2655 To simplify the parsing we introduce an `eop` which can record an
2656 expression operator.
2657
2658 ###### ast
2659         struct eop {
2660                 enum Btype op;
2661         };
2662
2663 ###### ast functions
2664         static void free_eop(struct eop *e)
2665         {
2666                 if (e)
2667                         free(e);
2668         }
2669
2670 ###### Binode types
2671         Less,
2672         Gtr,
2673         LessEq,
2674         GtrEq,
2675         Eql,
2676         NEql,
2677
2678 ###### other BFact
2679         | Expr CMPop Expr ${ {
2680                 struct binode *b = new(binode);
2681                 b->op = $2.op;
2682                 b->left = $<1;
2683                 b->right = $<3;
2684                 $0 = b;
2685         } }$
2686         | Expr ${ $0 = $<1; }$
2687
2688 ###### Grammar
2689
2690         $eop
2691         CMPop ->   < ${ $0.op = Less; }$
2692                 |  > ${ $0.op = Gtr; }$
2693                 |  <= ${ $0.op = LessEq; }$
2694                 |  >= ${ $0.op = GtrEq; }$
2695                 |  == ${ $0.op = Eql; }$
2696                 |  != ${ $0.op = NEql; }$
2697
2698 ###### print binode cases
2699
2700         case Less:
2701         case LessEq:
2702         case Gtr:
2703         case GtrEq:
2704         case Eql:
2705         case NEql:
2706                 print_exec(b->left, -1, 0);
2707                 switch(b->op) {
2708                 case Less:   printf(" < "); break;
2709                 case LessEq: printf(" <= "); break;
2710                 case Gtr:    printf(" > "); break;
2711                 case GtrEq:  printf(" >= "); break;
2712                 case Eql:    printf(" == "); break;
2713                 case NEql:   printf(" != "); break;
2714                 default: abort();               // NOTEST
2715                 }
2716                 print_exec(b->right, -1, 0);
2717                 break;
2718
2719 ###### propagate binode cases
2720         case Less:
2721         case LessEq:
2722         case Gtr:
2723         case GtrEq:
2724         case Eql:
2725         case NEql:
2726                 /* Both must match but not be labels, result is Tbool */
2727                 t = propagate_types(b->left, c, ok, NULL, Rnolabel);
2728                 if (t)
2729                         propagate_types(b->right, c, ok, t, 0);
2730                 else {
2731                         t = propagate_types(b->right, c, ok, NULL, Rnolabel);
2732                         if (t)
2733                                 t = propagate_types(b->left, c, ok, t, 0);
2734                 }
2735                 if (!type_compat(type, Tbool, 0))
2736                         type_err(c, "error: Comparison returns %1 but %2 expected", prog,
2737                                     Tbool, rules, type);
2738                 return Tbool;
2739
2740 ###### interp binode cases
2741         case Less:
2742         case LessEq:
2743         case Gtr:
2744         case GtrEq:
2745         case Eql:
2746         case NEql:
2747         {
2748                 int cmp;
2749                 left = interp_exec(b->left);
2750                 right = interp_exec(b->right);
2751                 cmp = value_cmp(left, right);
2752                 rv.type = Tbool;
2753                 switch (b->op) {
2754                 case Less:      rv.bool = cmp <  0; break;
2755                 case LessEq:    rv.bool = cmp <= 0; break;
2756                 case Gtr:       rv.bool = cmp >  0; break;
2757                 case GtrEq:     rv.bool = cmp >= 0; break;
2758                 case Eql:       rv.bool = cmp == 0; break;
2759                 case NEql:      rv.bool = cmp != 0; break;
2760                 default: rv.bool = 0; break;    // NOTEST
2761                 }
2762                 break;
2763         }
2764
2765 ### Expressions: The rest
2766
2767 The remaining expressions with the highest precedence are arithmetic
2768 and string concatenation.  They are `Expr`, `Term`, and `Factor`.
2769 The `Factor` is where the `Value` and `Variable` that we already have
2770 are included.
2771
2772 `+` and `-` are both infix and prefix operations (where they are
2773 absolute value and negation).  These have different operator names.
2774
2775 We also have a 'Bracket' operator which records where parentheses were
2776 found.  This makes it easy to reproduce these when printing.  Once
2777 precedence is handled better I might be able to discard this.
2778
2779 ###### Binode types
2780         Plus, Minus,
2781         Times, Divide, Rem,
2782         Concat,
2783         Absolute, Negate,
2784         Bracket,
2785
2786 ###### Grammar
2787
2788         $*exec
2789         Expr -> Expr Eop Term ${ {
2790                         struct binode *b = new(binode);
2791                         b->op = $2.op;
2792                         b->left = $<1;
2793                         b->right = $<3;
2794                         $0 = b;
2795                 } }$
2796                 | Term ${ $0 = $<1; }$
2797
2798         Term -> Term Top Factor ${ {
2799                         struct binode *b = new(binode);
2800                         b->op = $2.op;
2801                         b->left = $<1;
2802                         b->right = $<3;
2803                         $0 = b;
2804                 } }$
2805                 | Factor ${ $0 = $<1; }$
2806
2807         Factor -> ( Expression ) ${ {
2808                         struct binode *b = new_pos(binode, $1);
2809                         b->op = Bracket;
2810                         b->right = $<2;
2811                         $0 = b;
2812                 } }$
2813                 | Uop Factor ${ {
2814                         struct binode *b = new(binode);
2815                         b->op = $1.op;
2816                         b->right = $<2;
2817                         $0 = b;
2818                 } }$
2819                 | Value ${ $0 = $<1; }$
2820                 | Variable ${ $0 = $<1; }$
2821
2822         $eop
2823         Eop ->    + ${ $0.op = Plus; }$
2824                 | - ${ $0.op = Minus; }$
2825
2826         Uop ->    + ${ $0.op = Absolute; }$
2827                 | - ${ $0.op = Negate; }$
2828
2829         Top ->    * ${ $0.op = Times; }$
2830                 | / ${ $0.op = Divide; }$
2831                 | % ${ $0.op = Rem; }$
2832                 | ++ ${ $0.op = Concat; }$
2833
2834 ###### print binode cases
2835         case Plus:
2836         case Minus:
2837         case Times:
2838         case Divide:
2839         case Concat:
2840         case Rem:
2841                 print_exec(b->left, indent, 0);
2842                 switch(b->op) {
2843                 case Plus:   fputs(" + ", stdout); break;
2844                 case Minus:  fputs(" - ", stdout); break;
2845                 case Times:  fputs(" * ", stdout); break;
2846                 case Divide: fputs(" / ", stdout); break;
2847                 case Rem:    fputs(" % ", stdout); break;
2848                 case Concat: fputs(" ++ ", stdout); break;
2849                 default: abort();       // NOTEST
2850                 }                       // NOTEST
2851                 print_exec(b->right, indent, 0);
2852                 break;
2853         case Absolute:
2854                 printf("+");
2855                 print_exec(b->right, indent, 0);
2856                 break;
2857         case Negate:
2858                 printf("-");
2859                 print_exec(b->right, indent, 0);
2860                 break;
2861         case Bracket:
2862                 printf("(");
2863                 print_exec(b->right, indent, 0);
2864                 printf(")");
2865                 break;
2866
2867 ###### propagate binode cases
2868         case Plus:
2869         case Minus:
2870         case Times:
2871         case Rem:
2872         case Divide:
2873                 /* both must be numbers, result is Tnum */
2874         case Absolute:
2875         case Negate:
2876                 /* as propagate_types ignores a NULL,
2877                  * unary ops fit here too */
2878                 propagate_types(b->left, c, ok, Tnum, 0);
2879                 propagate_types(b->right, c, ok, Tnum, 0);
2880                 if (!type_compat(type, Tnum, 0))
2881                         type_err(c, "error: Arithmetic returns %1 but %2 expected", prog,
2882                                    Tnum, rules, type);
2883                 return Tnum;
2884
2885         case Concat:
2886                 /* both must be Tstr, result is Tstr */
2887                 propagate_types(b->left, c, ok, Tstr, 0);
2888                 propagate_types(b->right, c, ok, Tstr, 0);
2889                 if (!type_compat(type, Tstr, 0))
2890                         type_err(c, "error: Concat returns %1 but %2 expected", prog,
2891                                    Tstr, rules, type);
2892                 return Tstr;
2893
2894         case Bracket:
2895                 return propagate_types(b->right, c, ok, type, 0);
2896
2897 ###### interp binode cases
2898
2899         case Plus:
2900                 rv = interp_exec(b->left);
2901                 right = interp_exec(b->right);
2902                 mpq_add(rv.num, rv.num, right.num);
2903                 break;
2904         case Minus:
2905                 rv = interp_exec(b->left);
2906                 right = interp_exec(b->right);
2907                 mpq_sub(rv.num, rv.num, right.num);
2908                 break;
2909         case Times:
2910                 rv = interp_exec(b->left);
2911                 right = interp_exec(b->right);
2912                 mpq_mul(rv.num, rv.num, right.num);
2913                 break;
2914         case Divide:
2915                 rv = interp_exec(b->left);
2916                 right = interp_exec(b->right);
2917                 mpq_div(rv.num, rv.num, right.num);
2918                 break;
2919         case Rem: {
2920                 mpz_t l, r, rem;
2921
2922                 left = interp_exec(b->left);
2923                 right = interp_exec(b->right);
2924                 mpz_init(l); mpz_init(r); mpz_init(rem);
2925                 mpz_tdiv_q(l, mpq_numref(left.num), mpq_denref(left.num));
2926                 mpz_tdiv_q(r, mpq_numref(right.num), mpq_denref(right.num));
2927                 mpz_tdiv_r(rem, l, r);
2928                 rv = val_init(Tnum);
2929                 mpq_set_z(rv.num, rem);
2930                 mpz_clear(r); mpz_clear(l); mpz_clear(rem);
2931                 break;
2932         }
2933         case Negate:
2934                 rv = interp_exec(b->right);
2935                 mpq_neg(rv.num, rv.num);
2936                 break;
2937         case Absolute:
2938                 rv = interp_exec(b->right);
2939                 mpq_abs(rv.num, rv.num);
2940                 break;
2941         case Bracket:
2942                 rv = interp_exec(b->right);
2943                 break;
2944         case Concat:
2945                 left = interp_exec(b->left);
2946                 right = interp_exec(b->right);
2947                 rv.type = Tstr;
2948                 rv.str = text_join(left.str, right.str);
2949                 break;
2950
2951 ###### value functions
2952
2953         static struct text text_join(struct text a, struct text b)
2954         {
2955                 struct text rv;
2956                 rv.len = a.len + b.len;
2957                 rv.txt = malloc(rv.len);
2958                 memcpy(rv.txt, a.txt, a.len);
2959                 memcpy(rv.txt+a.len, b.txt, b.len);
2960                 return rv;
2961         }
2962
2963 ### Blocks, Statements, and Statement lists.
2964
2965 Now that we have expressions out of the way we need to turn to
2966 statements.  There are simple statements and more complex statements.
2967 Simple statements do not contain (syntactic) newlines, complex statements do.
2968
2969 Statements often come in sequences and we have corresponding simple
2970 statement lists and complex statement lists.
2971 The former comprise only simple statements separated by semicolons.
2972 The later comprise complex statements and simple statement lists.  They are
2973 separated by newlines.  Thus the semicolon is only used to separate
2974 simple statements on the one line.  This may be overly restrictive,
2975 but I'm not sure I ever want a complex statement to share a line with
2976 anything else.
2977
2978 Note that a simple statement list can still use multiple lines if
2979 subsequent lines are indented, so
2980
2981 ###### Example: wrapped simple statement list
2982
2983         a = b; c = d;
2984            e = f; print g
2985
2986 is a single simple statement list.  This might allow room for
2987 confusion, so I'm not set on it yet.
2988
2989 A simple statement list needs no extra syntax.  A complex statement
2990 list has two syntactic forms.  It can be enclosed in braces (much like
2991 C blocks), or it can be introduced by a colon and continue until an
2992 unindented newline (much like Python blocks).  With this extra syntax
2993 it is referred to as a block.
2994
2995 Note that a block does not have to include any newlines if it only
2996 contains simple statements.  So both of:
2997
2998         if condition: a=b; d=f
2999
3000         if condition { a=b; print f }
3001
3002 are valid.
3003
3004 In either case the list is constructed from a `binode` list with
3005 `Block` as the operator.  When parsing the list it is most convenient
3006 to append to the end, so a list is a list and a statement.  When using
3007 the list it is more convenient to consider a list to be a statement
3008 and a list.  So we need a function to re-order a list.
3009 `reorder_bilist` serves this purpose.
3010
3011 The only stand-alone statement we introduce at this stage is `pass`
3012 which does nothing and is represented as a `NULL` pointer in a `Block`
3013 list.  Other stand-alone statements will follow once the infrastructure
3014 is in-place.
3015
3016 ###### Binode types
3017         Block,
3018
3019 ###### Grammar
3020
3021         $void
3022         Newlines -> NEWLINE
3023                 | Newlines NEWLINE
3024
3025         $*binode
3026         Block -> Open Statementlist Close ${ $0 = $<2; }$
3027                 | Open SimpleStatements } ${ $0 = reorder_bilist($<2); }$
3028                 | : SimpleStatements ${ $0 = reorder_bilist($<2); }$
3029                 | : Statementlist  ${ $0 = $<2; }$
3030
3031         Statementlist -> ComplexStatements ${ $0 = reorder_bilist($<1); }$
3032
3033         ComplexStatements -> ComplexStatements ComplexStatement ${
3034                         if ($2 == NULL) {
3035                                 $0 = $<1;
3036                         } else {
3037                                 $0 = new(binode);
3038                                 $0->op = Block;
3039                                 $0->left = $<1;
3040                                 $0->right = $<2;
3041                         }
3042                 }$
3043                 | ComplexStatement ${
3044                         if ($1 == NULL) {
3045                                 $0 = NULL;
3046                         } else {
3047                                 $0 = new(binode);
3048                                 $0->op = Block;
3049                                 $0->left = NULL;
3050                                 $0->right = $<1;
3051                         }
3052                 }$
3053
3054         $*exec
3055         ComplexStatement -> SimpleStatements NEWLINE ${
3056                         $0 = reorder_bilist($<1);
3057                         }$
3058                 | Newlines ${ $0 = NULL; }$
3059                 ## ComplexStatement Grammar
3060
3061         $*binode
3062         SimpleStatements -> SimpleStatements ; SimpleStatement ${
3063                         $0 = new(binode);
3064                         $0->op = Block;
3065                         $0->left = $<1;
3066                         $0->right = $<3;
3067                         }$
3068                 | SimpleStatement ${
3069                         $0 = new(binode);
3070                         $0->op = Block;
3071                         $0->left = NULL;
3072                         $0->right = $<1;
3073                         }$
3074                 | SimpleStatements ; ${ $0 = $<1; }$
3075
3076         SimpleStatement -> pass ${ $0 = NULL; }$
3077                 ## SimpleStatement Grammar
3078
3079 ###### print binode cases
3080         case Block:
3081                 if (indent < 0) {
3082                         // simple statement
3083                         if (b->left == NULL)
3084                                 printf("pass");
3085                         else
3086                                 print_exec(b->left, indent, 0);
3087                         if (b->right) {
3088                                 printf("; ");
3089                                 print_exec(b->right, indent, 0);
3090                         }
3091                 } else {
3092                         // block, one per line
3093                         if (b->left == NULL)
3094                                 do_indent(indent, "pass\n");
3095                         else
3096                                 print_exec(b->left, indent, bracket);
3097                         if (b->right)
3098                                 print_exec(b->right, indent, bracket);
3099                 }
3100                 break;
3101
3102 ###### propagate binode cases
3103         case Block:
3104         {
3105                 /* If any statement returns something other than Tnone
3106                  * or Tbool then all such must return same type.
3107                  * As each statement may be Tnone or something else,
3108                  * we must always pass NULL (unknown) down, otherwise an incorrect
3109                  * error might occur.  We never return Tnone unless it is
3110                  * passed in.
3111                  */
3112                 struct binode *e;
3113
3114                 for (e = b; e; e = cast(binode, e->right)) {
3115                         t = propagate_types(e->left, c, ok, NULL, rules);
3116                         if ((rules & Rboolok) && t == Tbool)
3117                                 t = NULL;
3118                         if (t && t != Tnone && t != Tbool) {
3119                                 if (!type)
3120                                         type = t;
3121                                 else if (t != type)
3122                                         type_err(c, "error: expected %1%r, found %2",
3123                                                  e->left, type, rules, t);
3124                         }
3125                 }
3126                 return type;
3127         }
3128
3129 ###### interp binode cases
3130         case Block:
3131                 while (rv.type == Tnone &&
3132                        b) {
3133                         if (b->left)
3134                                 rv = interp_exec(b->left);
3135                         b = cast(binode, b->right);
3136                 }
3137                 break;
3138
3139 ### The Print statement
3140
3141 `print` is a simple statement that takes a comma-separated list of
3142 expressions and prints the values separated by spaces and terminated
3143 by a newline.  No control of formatting is possible.
3144
3145 `print` faces the same list-ordering issue as blocks, and uses the
3146 same solution.
3147
3148 ###### Binode types
3149         Print,
3150
3151 ###### SimpleStatement Grammar
3152
3153         | print ExpressionList ${
3154                 $0 = reorder_bilist($<2);
3155         }$
3156         | print ExpressionList , ${
3157                 $0 = new(binode);
3158                 $0->op = Print;
3159                 $0->right = NULL;
3160                 $0->left = $<2;
3161                 $0 = reorder_bilist($0);
3162         }$
3163         | print ${
3164                 $0 = new(binode);
3165                 $0->op = Print;
3166                 $0->right = NULL;
3167         }$
3168
3169 ###### Grammar
3170
3171         $*binode
3172         ExpressionList -> ExpressionList , Expression ${
3173                 $0 = new(binode);
3174                 $0->op = Print;
3175                 $0->left = $<1;
3176                 $0->right = $<3;
3177                 }$
3178                 | Expression ${
3179                         $0 = new(binode);
3180                         $0->op = Print;
3181                         $0->left = NULL;
3182                         $0->right = $<1;
3183                 }$
3184
3185 ###### print binode cases
3186
3187         case Print:
3188                 do_indent(indent, "print");
3189                 while (b) {
3190                         if (b->left) {
3191                                 printf(" ");
3192                                 print_exec(b->left, -1, 0);
3193                                 if (b->right)
3194                                         printf(",");
3195                         }
3196                         b = cast(binode, b->right);
3197                 }
3198                 if (indent >= 0)
3199                         printf("\n");
3200                 break;
3201
3202 ###### propagate binode cases
3203
3204         case Print:
3205                 /* don't care but all must be consistent */
3206                 propagate_types(b->left, c, ok, NULL, Rnolabel);
3207                 propagate_types(b->right, c, ok, NULL, Rnolabel);
3208                 break;
3209
3210 ###### interp binode cases
3211
3212         case Print:
3213         {
3214                 char sep = 0;
3215                 int eol = 1;
3216                 for ( ; b; b = cast(binode, b->right))
3217                         if (b->left) {
3218                                 if (sep)
3219                                         putchar(sep);
3220                                 left = interp_exec(b->left);
3221                                 print_value(left);
3222                                 free_value(left);
3223                                 if (b->right)
3224                                         sep = ' ';
3225                         } else if (sep)
3226                                 eol = 0;
3227                 left.type = Tnone;
3228                 if (eol)
3229                         printf("\n");
3230                 break;
3231         }
3232
3233 ###### Assignment statement
3234
3235 An assignment will assign a value to a variable, providing it hasn't
3236 be declared as a constant.  The analysis phase ensures that the type
3237 will be correct so the interpreter just needs to perform the
3238 calculation.  There is a form of assignment which declares a new
3239 variable as well as assigning a value.  If a name is assigned before
3240 it is declared, and error will be raised as the name is created as
3241 `Tlabel` and it is illegal to assign to such names.
3242
3243 ###### Binode types
3244         Assign,
3245         Declare,
3246
3247 ###### SimpleStatement Grammar
3248         | Variable = Expression ${
3249                         $0 = new(binode);
3250                         $0->op = Assign;
3251                         $0->left = $<1;
3252                         $0->right = $<3;
3253                 }$
3254         | VariableDecl = Expression ${
3255                         $0 = new(binode);
3256                         $0->op = Declare;
3257                         $0->left = $<1;
3258                         $0->right =$<3;
3259                 }$
3260
3261         | VariableDecl ${
3262                         if ($1->var->where_set == NULL) {
3263                                 type_err(c,
3264                                          "Variable declared with no type or value: %v",
3265                                          $1, NULL, 0, NULL);
3266                         } else {
3267                                 $0 = new(binode);
3268                                 $0->op = Declare;
3269                                 $0->left = $<1;
3270                                 $0->right = NULL;
3271                         }
3272                 }$
3273
3274 ###### print binode cases
3275
3276         case Assign:
3277                 do_indent(indent, "");
3278                 print_exec(b->left, indent, 0);
3279                 printf(" = ");
3280                 print_exec(b->right, indent, 0);
3281                 if (indent >= 0)
3282                         printf("\n");
3283                 break;
3284
3285         case Declare:
3286                 {
3287                 struct variable *v = cast(var, b->left)->var;
3288                 do_indent(indent, "");
3289                 print_exec(b->left, indent, 0);
3290                 if (cast(var, b->left)->var->constant) {
3291                         if (v->where_decl == v->where_set) {
3292                                 printf("::");
3293                                 type_print(v->val.type, stdout);
3294                                 printf(" ");
3295                         } else
3296                                 printf(" ::");
3297                 } else {
3298                         if (v->where_decl == v->where_set) {
3299                                 printf(":");
3300                                 type_print(v->val.type, stdout);
3301                                 printf(" ");
3302                         } else
3303                                 printf(" :");
3304                 }
3305                 if (b->right) {
3306                         printf("= ");
3307                         print_exec(b->right, indent, 0);
3308                 }
3309                 if (indent >= 0)
3310                         printf("\n");
3311                 }
3312                 break;
3313
3314 ###### propagate binode cases
3315
3316         case Assign:
3317         case Declare:
3318                 /* Both must match and not be labels,
3319                  * Type must support 'dup',
3320                  * For Assign, left must not be constant.
3321                  * result is Tnone
3322                  */
3323                 t = propagate_types(b->left, c, ok, NULL,
3324                                     Rnolabel | (b->op == Assign ? Rnoconstant : 0));
3325                 if (!b->right)
3326                         return Tnone;
3327
3328                 if (t) {
3329                         if (propagate_types(b->right, c, ok, t, 0) != t)
3330                                 if (b->left->type == Xvar)
3331                                         type_err(c, "info: variable '%v' was set as %1 here.",
3332                                                  cast(var, b->left)->var->where_set, t, rules, NULL);
3333                 } else {
3334                         t = propagate_types(b->right, c, ok, NULL, Rnolabel);
3335                         if (t)
3336                                 propagate_types(b->left, c, ok, t,
3337                                                 (b->op == Assign ? Rnoconstant : 0));
3338                 }
3339                 if (t && t->dup == NULL)
3340                         type_err(c, "error: cannot assign value of type %1", b, t, 0, NULL);
3341                 return Tnone;
3342
3343                 break;
3344
3345 ###### interp binode cases
3346
3347         case Assign:
3348                 lleft = linterp_exec(b->left);
3349                 right = interp_exec(b->right);
3350                 if (lleft) {
3351                         free_value(*lleft);
3352                         *lleft = right;
3353                 } else
3354                         free_value(right);      // NOTEST
3355                 right.type = NULL;
3356                 break;
3357
3358         case Declare:
3359         {
3360                 struct variable *v = cast(var, b->left)->var;
3361                 if (v->merged)
3362                         v = v->merged;
3363                 if (b->right)
3364                         right = interp_exec(b->right);
3365                 else
3366                         right = val_init(v->val.type);
3367                 free_value(v->val);
3368                 v->val = right;
3369                 right.type = NULL;
3370                 break;
3371         }
3372
3373 ### The `use` statement
3374
3375 The `use` statement is the last "simple" statement.  It is needed when
3376 the condition in a conditional statement is a block.  `use` works much
3377 like `return` in C, but only completes the `condition`, not the whole
3378 function.
3379
3380 ###### Binode types
3381         Use,
3382
3383 ###### SimpleStatement Grammar
3384         | use Expression ${
3385                 $0 = new_pos(binode, $1);
3386                 $0->op = Use;
3387                 $0->right = $<2;
3388         }$
3389
3390 ###### print binode cases
3391
3392         case Use:
3393                 do_indent(indent, "use ");
3394                 print_exec(b->right, -1, 0);
3395                 if (indent >= 0)
3396                         printf("\n");
3397                 break;
3398
3399 ###### propagate binode cases
3400
3401         case Use:
3402                 /* result matches value */
3403                 return propagate_types(b->right, c, ok, type, 0);
3404
3405 ###### interp binode cases
3406
3407         case Use:
3408                 rv = interp_exec(b->right);
3409                 break;
3410
3411 ### The Conditional Statement
3412
3413 This is the biggy and currently the only complex statement.  This
3414 subsumes `if`, `while`, `do/while`, `switch`, and some parts of `for`.
3415 It is comprised of a number of parts, all of which are optional though
3416 set combinations apply.  Each part is (usually) a key word (`then` is
3417 sometimes optional) followed by either an expression or a code block,
3418 except the `casepart` which is a "key word and an expression" followed
3419 by a code block.  The code-block option is valid for all parts and,
3420 where an expression is also allowed, the code block can use the `use`
3421 statement to report a value.  If the code block does not report a value
3422 the effect is similar to reporting `True`.
3423
3424 The `else` and `case` parts, as well as `then` when combined with
3425 `if`, can contain a `use` statement which will apply to some
3426 containing conditional statement. `for` parts, `do` parts and `then`
3427 parts used with `for` can never contain a `use`, except in some
3428 subordinate conditional statement.
3429
3430 If there is a `forpart`, it is executed first, only once.
3431 If there is a `dopart`, then it is executed repeatedly providing
3432 always that the `condpart` or `cond`, if present, does not return a non-True
3433 value.  `condpart` can fail to return any value if it simply executes
3434 to completion.  This is treated the same as returning `True`.
3435
3436 If there is a `thenpart` it will be executed whenever the `condpart`
3437 or `cond` returns True (or does not return any value), but this will happen
3438 *after* `dopart` (when present).
3439
3440 If `elsepart` is present it will be executed at most once when the
3441 condition returns `False` or some value that isn't `True` and isn't
3442 matched by any `casepart`.  If there are any `casepart`s, they will be
3443 executed when the condition returns a matching value.
3444
3445 The particular sorts of values allowed in case parts has not yet been
3446 determined in the language design, so nothing is prohibited.
3447
3448 The various blocks in this complex statement potentially provide scope
3449 for variables as described earlier.  Each such block must include the
3450 "OpenScope" nonterminal before parsing the block, and must call
3451 `var_block_close()` when closing the block.
3452
3453 The code following "`if`", "`switch`" and "`for`" does not get its own
3454 scope, but is in a scope covering the whole statement, so names
3455 declared there cannot be redeclared elsewhere.  Similarly the
3456 condition following "`while`" is in a scope the covers the body
3457 ("`do`" part) of the loop, and which does not allow conditional scope
3458 extension.  Code following "`then`" (both looping and non-looping),
3459 "`else`" and "`case`" each get their own local scope.
3460
3461 The type requirements on the code block in a `whilepart` are quite
3462 unusal.  It is allowed to return a value of some identifiable type, in
3463 which case the loop aborts and an appropriate `casepart` is run, or it
3464 can return a Boolean, in which case the loop either continues to the
3465 `dopart` (on `True`) or aborts and runs the `elsepart` (on `False`).
3466 This is different both from the `ifpart` code block which is expected to
3467 return a Boolean, or the `switchpart` code block which is expected to
3468 return the same type as the casepart values.  The correct analysis of
3469 the type of the `whilepart` code block is the reason for the
3470 `Rboolok` flag which is passed to `propagate_types()`.
3471
3472 The `cond_statement` cannot fit into a `binode` so a new `exec` is
3473 defined.
3474
3475 ###### exec type
3476         Xcond_statement,
3477
3478 ###### ast
3479         struct casepart {
3480                 struct exec *value;
3481                 struct exec *action;
3482                 struct casepart *next;
3483         };
3484         struct cond_statement {
3485                 struct exec;
3486                 struct exec *forpart, *condpart, *dopart, *thenpart, *elsepart;
3487                 struct casepart *casepart;
3488         };
3489
3490 ###### ast functions
3491
3492         static void free_casepart(struct casepart *cp)
3493         {
3494                 while (cp) {
3495                         struct casepart *t;
3496                         free_exec(cp->value);
3497                         free_exec(cp->action);
3498                         t = cp->next;
3499                         free(cp);
3500                         cp = t;
3501                 }
3502         }
3503
3504         static void free_cond_statement(struct cond_statement *s)
3505         {
3506                 if (!s)
3507                         return;
3508                 free_exec(s->forpart);
3509                 free_exec(s->condpart);
3510                 free_exec(s->dopart);
3511                 free_exec(s->thenpart);
3512                 free_exec(s->elsepart);
3513                 free_casepart(s->casepart);
3514                 free(s);
3515         }
3516
3517 ###### free exec cases
3518         case Xcond_statement: free_cond_statement(cast(cond_statement, e)); break;
3519
3520 ###### ComplexStatement Grammar
3521         | CondStatement ${ $0 = $<1; }$
3522
3523 ###### Grammar
3524
3525         $*cond_statement
3526         // both ForThen and Whilepart open scopes, and CondSuffix only
3527         // closes one - so in the first branch here we have another to close.
3528         CondStatement -> forPart ThenPart WhilePart CondSuffix ${
3529                         $0 = $<4;
3530                         $0->forpart = $<1;
3531                         $0->thenpart = $<2;
3532                         $0->condpart = $3.condpart; $3.condpart = NULL;
3533                         $0->dopart = $3.dopart; $3.dopart = NULL;
3534                         var_block_close(c, CloseSequential);
3535                         }$
3536                 |  forPart WhilePart CondSuffix ${
3537                         $0 = $<3;
3538                         $0->forpart = $<1;
3539                         $0->thenpart = NULL;
3540                         $0->condpart = $2.condpart; $2.condpart = NULL;
3541                         $0->dopart = $2.dopart; $2.dopart = NULL;
3542                         var_block_close(c, CloseSequential);
3543                         }$
3544                 | whilePart CondSuffix ${
3545                         $0 = $<2;
3546                         $0->condpart = $1.condpart; $1.condpart = NULL;
3547                         $0->dopart = $1.dopart; $1.dopart = NULL;
3548                         }$
3549                 | switchPart CondSuffix ${
3550                         $0 = $<2;
3551                         $0->condpart = $<1;
3552                         }$
3553                 | ifPart IfSuffix ${
3554                         $0 = $<2;
3555                         $0->condpart = $1.condpart; $1.condpart = NULL;
3556                         $0->thenpart = $1.thenpart; $1.thenpart = NULL;
3557                         // This is where we close an "if" statement
3558                         var_block_close(c, CloseSequential);
3559                         }$
3560
3561         CondSuffix -> IfSuffix ${
3562                         $0 = $<1;
3563                         // This is where we close scope of the whole
3564                         // "for" or "while" statement
3565                         var_block_close(c, CloseSequential);
3566                 }$
3567                 | CasePart CondSuffix ${
3568                         $0 = $<2;
3569                         $1->next = $0->casepart;
3570                         $0->casepart = $<1;
3571                 }$
3572
3573         $void
3574         Case -> case
3575                 | NEWLINE Case
3576         $*casepart
3577         CasePart -> Case Expression OpenScope Block ${
3578                         $0 = calloc(1,sizeof(struct casepart));
3579                         $0->value = $<2;
3580                         $0->action = $<4;
3581                         var_block_close(c, CloseParallel);
3582                 }$
3583
3584         $*cond_statement
3585         IfSuffix ->  ${ $0 = new(cond_statement); }$
3586                 | NEWLINE IfSuffix ${ $0 = $<2; }$
3587                 | else OpenScope Block ${
3588                         $0 = new(cond_statement);
3589                         $0->elsepart = $<3;
3590                         var_block_close(c, CloseElse);
3591                 }$
3592                 | else OpenScope CondStatement ${
3593                         $0 = new(cond_statement);
3594                         $0->elsepart = $<3;
3595                         var_block_close(c, CloseElse);
3596                 }$
3597
3598         $void
3599         Then -> then
3600                 | NEWLINE Then
3601         While -> while
3602                 | NEWLINE While
3603         Do -> do
3604                 | NEWLINE Do
3605         $*exec
3606         // These scopes are closed in CondSuffix
3607         forPart -> for OpenScope SimpleStatements ${
3608                         $0 = reorder_bilist($<3);
3609                 }$
3610                 |  for OpenScope Block ${
3611                         $0 = $<3;
3612                 }$
3613
3614         ThenPart -> Then OpenScope SimpleStatements ${
3615                         $0 = reorder_bilist($<3);
3616                         var_block_close(c, CloseSequential);
3617                 }$
3618                 |  Then OpenScope Block ${
3619                         $0 = $<3;
3620                         var_block_close(c, CloseSequential);
3621                 }$
3622
3623         // This scope is closed in CondSuffix
3624         WhileHead -> While OpenScope Block ${
3625                 $0 = $<3;
3626                 }$
3627         whileHead -> while OpenScope Block ${
3628                 $0 = $<3;
3629                 }$
3630
3631         $cond_statement
3632         // This scope is closed in CondSuffix
3633         whilePart -> while OpenScope Expression Block ${
3634                         $0.type = Xcond_statement;
3635                         $0.condpart = $<3;
3636                         $0.dopart = $<4;
3637                 }$
3638                 | whileHead Do Block ${
3639                         $0.type = Xcond_statement;
3640                         $0.condpart = $<1;
3641                         $0.dopart = $<3;
3642                 }$
3643         WhilePart -> While OpenScope Expression Block ${
3644                         $0.type = Xcond_statement;
3645                         $0.condpart = $<3;
3646                         $0.dopart = $<4;
3647                 }$
3648                 | WhileHead Do Block ${
3649                         $0.type = Xcond_statement;
3650                         $0.condpart = $<1;
3651                         $0.dopart = $<3;
3652                 }$
3653
3654         ifPart -> if OpenScope Expression OpenScope Block ${
3655                         $0.type = Xcond_statement;
3656                         $0.condpart = $<3;
3657                         $0.thenpart = $<5;
3658                         var_block_close(c, CloseParallel);
3659                 }$
3660                 | if OpenScope Block Then OpenScope Block ${
3661                         $0.type = Xcond_statement;
3662                         $0.condpart = $<3;
3663                         $0.thenpart = $<6;
3664                         var_block_close(c, CloseParallel);
3665                 }$
3666
3667         $*exec
3668         // This scope is closed in CondSuffix
3669         switchPart -> switch OpenScope Expression ${
3670                         $0 = $<3;
3671                 }$
3672                 | switch OpenScope Block ${
3673                         $0 = $<3;
3674                 }$
3675
3676 ###### print exec cases
3677
3678         case Xcond_statement:
3679         {
3680                 struct cond_statement *cs = cast(cond_statement, e);
3681                 struct casepart *cp;
3682                 if (cs->forpart) {
3683                         do_indent(indent, "for");
3684                         if (bracket) printf(" {\n"); else printf(":\n");
3685                         print_exec(cs->forpart, indent+1, bracket);
3686                         if (cs->thenpart) {
3687                                 if (bracket)
3688                                         do_indent(indent, "} then {\n");
3689                                 else
3690                                         do_indent(indent, "then:\n");
3691                                 print_exec(cs->thenpart, indent+1, bracket);
3692                         }
3693                         if (bracket) do_indent(indent, "}\n");
3694                 }
3695                 if (cs->dopart) {
3696                         // a loop
3697                         if (cs->condpart && cs->condpart->type == Xbinode &&
3698                             cast(binode, cs->condpart)->op == Block) {
3699                                 if (bracket)
3700                                         do_indent(indent, "while {\n");
3701                                 else
3702                                         do_indent(indent, "while:\n");
3703                                 print_exec(cs->condpart, indent+1, bracket);
3704                                 if (bracket)
3705                                         do_indent(indent, "} do {\n");
3706                                 else
3707                                         do_indent(indent, "do:\n");
3708                                 print_exec(cs->dopart, indent+1, bracket);
3709                                 if (bracket)
3710                                         do_indent(indent, "}\n");
3711                         } else {
3712                                 do_indent(indent, "while ");
3713                                 print_exec(cs->condpart, 0, bracket);
3714                                 if (bracket)
3715                                         printf(" {\n");
3716                                 else
3717                                         printf(":\n");
3718                                 print_exec(cs->dopart, indent+1, bracket);
3719                                 if (bracket)
3720                                         do_indent(indent, "}\n");
3721                         }
3722                 } else {
3723                         // a condition
3724                         if (cs->casepart)
3725                                 do_indent(indent, "switch");
3726                         else
3727                                 do_indent(indent, "if");
3728                         if (cs->condpart && cs->condpart->type == Xbinode &&
3729                             cast(binode, cs->condpart)->op == Block) {
3730                                 if (bracket)
3731                                         printf(" {\n");
3732                                 else
3733                                         printf(":\n");
3734                                 print_exec(cs->condpart, indent+1, bracket);
3735                                 if (bracket)
3736                                         do_indent(indent, "}\n");
3737                                 if (cs->thenpart) {
3738                                         do_indent(indent, "then:\n");
3739                                         print_exec(cs->thenpart, indent+1, bracket);
3740                                 }
3741                         } else {
3742                                 printf(" ");
3743                                 print_exec(cs->condpart, 0, bracket);
3744                                 if (cs->thenpart) {
3745                                         if (bracket)
3746                                                 printf(" {\n");
3747                                         else
3748                                                 printf(":\n");
3749                                         print_exec(cs->thenpart, indent+1, bracket);
3750                                         if (bracket)
3751                                                 do_indent(indent, "}\n");
3752                                 } else
3753                                         printf("\n");
3754                         }
3755                 }
3756                 for (cp = cs->casepart; cp; cp = cp->next) {
3757                         do_indent(indent, "case ");
3758                         print_exec(cp->value, -1, 0);
3759                         if (bracket)
3760                                 printf(" {\n");
3761                         else
3762                                 printf(":\n");
3763                         print_exec(cp->action, indent+1, bracket);
3764                         if (bracket)
3765                                 do_indent(indent, "}\n");
3766                 }
3767                 if (cs->elsepart) {
3768                         do_indent(indent, "else");
3769                         if (bracket)
3770                                 printf(" {\n");
3771                         else
3772                                 printf(":\n");
3773                         print_exec(cs->elsepart, indent+1, bracket);
3774                         if (bracket)
3775                                 do_indent(indent, "}\n");
3776                 }
3777                 break;
3778         }
3779
3780 ###### propagate exec cases
3781         case Xcond_statement:
3782         {
3783                 // forpart and dopart must return Tnone
3784                 // thenpart must return Tnone if there is a dopart,
3785                 // otherwise it is like elsepart.
3786                 // condpart must:
3787                 //    be bool if there is no casepart
3788                 //    match casepart->values if there is a switchpart
3789                 //    either be bool or match casepart->value if there
3790                 //             is a whilepart
3791                 // elsepart and casepart->action must match the return type
3792                 //   expected of this statement.
3793                 struct cond_statement *cs = cast(cond_statement, prog);
3794                 struct casepart *cp;
3795
3796                 t = propagate_types(cs->forpart, c, ok, Tnone, 0);
3797                 if (!type_compat(Tnone, t, 0))
3798                         *ok = 0;
3799                 t = propagate_types(cs->dopart, c, ok, Tnone, 0);
3800                 if (!type_compat(Tnone, t, 0))
3801                         *ok = 0;
3802                 if (cs->dopart) {
3803                         t = propagate_types(cs->thenpart, c, ok, Tnone, 0);
3804                         if (!type_compat(Tnone, t, 0))
3805                                 *ok = 0;
3806                 }
3807                 if (cs->casepart == NULL)
3808                         propagate_types(cs->condpart, c, ok, Tbool, 0);
3809                 else {
3810                         /* Condpart must match case values, with bool permitted */
3811                         t = NULL;
3812                         for (cp = cs->casepart;
3813                              cp && !t; cp = cp->next)
3814                                 t = propagate_types(cp->value, c, ok, NULL, 0);
3815                         if (!t && cs->condpart)
3816                                 t = propagate_types(cs->condpart, c, ok, NULL, Rboolok);
3817                         // Now we have a type (I hope) push it down
3818                         if (t) {
3819                                 for (cp = cs->casepart; cp; cp = cp->next)
3820                                         propagate_types(cp->value, c, ok, t, 0);
3821                                 propagate_types(cs->condpart, c, ok, t, Rboolok);
3822                         }
3823                 }
3824                 // (if)then, else, and case parts must return expected type.
3825                 if (!cs->dopart && !type)
3826                         type = propagate_types(cs->thenpart, c, ok, NULL, rules);
3827                 if (!type)
3828                         type = propagate_types(cs->elsepart, c, ok, NULL, rules);
3829                 for (cp = cs->casepart;
3830                      cp && !type;
3831                      cp = cp->next)
3832                         type = propagate_types(cp->action, c, ok, NULL, rules);
3833                 if (type) {
3834                         if (!cs->dopart)
3835                                 propagate_types(cs->thenpart, c, ok, type, rules);
3836                         propagate_types(cs->elsepart, c, ok, type, rules);
3837                         for (cp = cs->casepart; cp ; cp = cp->next)
3838                                 propagate_types(cp->action, c, ok, type, rules);
3839                         return type;
3840                 } else
3841                         return NULL;
3842         }
3843
3844 ###### interp exec cases
3845         case Xcond_statement:
3846         {
3847                 struct value v, cnd;
3848                 struct casepart *cp;
3849                 struct cond_statement *c = cast(cond_statement, e);
3850
3851                 if (c->forpart)
3852                         interp_exec(c->forpart);
3853                 do {
3854                         if (c->condpart)
3855                                 cnd = interp_exec(c->condpart);
3856                         else
3857                                 cnd.type = Tnone;
3858                         if (!(cnd.type == Tnone ||
3859                               (cnd.type == Tbool && cnd.bool != 0)))
3860                                 break;
3861                         // cnd is Tnone or Tbool, doesn't need to be freed
3862                         if (c->dopart)
3863                                 interp_exec(c->dopart);
3864
3865                         if (c->thenpart) {
3866                                 rv = interp_exec(c->thenpart);
3867                                 if (rv.type != Tnone || !c->dopart)
3868                                         goto Xcond_done;
3869                                 free_value(rv);
3870                         }
3871                 } while (c->dopart);
3872
3873                 for (cp = c->casepart; cp; cp = cp->next) {
3874                         v = interp_exec(cp->value);
3875                         if (value_cmp(v, cnd) == 0) {
3876                                 free_value(v);
3877                                 free_value(cnd);
3878                                 rv = interp_exec(cp->action);
3879                                 goto Xcond_done;
3880                         }
3881                         free_value(v);
3882                 }
3883                 free_value(cnd);
3884                 if (c->elsepart)
3885                         rv = interp_exec(c->elsepart);
3886                 else
3887                         rv.type = Tnone;
3888         Xcond_done:
3889                 break;
3890         }
3891
3892 ### Top level structure
3893
3894 All the language elements so far can be used in various places.  Now
3895 it is time to clarify what those places are.
3896
3897 At the top level of a file there will be a number of declarations.
3898 Many of the things that can be declared haven't been described yet,
3899 such as functions, procedures, imports, and probably more.
3900 For now there are two sorts of things that can appear at the top
3901 level.  They are predefined constants, `struct` types, and the main
3902 program.  While the syntax will allow the main program to appear
3903 multiple times, that will trigger an error if it is actually attempted.
3904
3905 The various declarations do not return anything.  They store the
3906 various declarations in the parse context.
3907
3908 ###### Parser: grammar
3909
3910         $void
3911         Ocean -> DeclarationList
3912
3913         DeclarationList -> Declaration
3914                 | DeclarationList Declaration
3915
3916         Declaration -> DeclareConstant
3917                 | DeclareProgram
3918                 | DeclareStruct
3919                 | NEWLINE
3920
3921         ## top level grammar
3922
3923 ### The `const` section
3924
3925 As well as being defined in with the code that uses them, constants
3926 can be declared at the top level.  These have full-file scope, so they
3927 are always `InScope`.  The value of a top level constant can be given
3928 as an expression, and this is evaluated immediately rather than in the
3929 later interpretation stage.  Once we add functions to the language, we
3930 will need rules concern which, if any, can be used to define a top
3931 level constant.
3932
3933 Constants are defined in a section that starts with the reserved word
3934 `const` and then has a block with a list of assignment statements.
3935 For syntactic consistency, these must use the double-colon syntax to
3936 make it clear that they are constants.  Type can also be given: if
3937 not, the type will be determined during analysis, as with other
3938 constants.
3939
3940 As the types constants are inserted at the head of a list, printing
3941 them in the same order that they were read is not straight forward.
3942 We take a quadratic approach here and count the number of constants
3943 (variables of depth 0), then count down from there, each time
3944 searching through for the Nth constant for decreasing N.
3945
3946 ###### top level grammar
3947
3948         DeclareConstant -> const Open ConstList Close
3949                 | const Open SimpleConstList }
3950                 | const : ConstList
3951                 | const SimpleConstList NEWLINE
3952
3953         ConstList -> ComplexConsts
3954                 | NEWLINE ConstList
3955         ComplexConsts -> ComplexConst ComplexConsts
3956                 | ComplexConst
3957         ComplexConst -> SimpleConstList NEWLINE
3958         SimpleConstList -> SimpleConstList ; Const
3959                 | Const
3960                 | SimpleConstList ;
3961
3962         $*type
3963         CType -> Type   ${ $0 = $<1; }$
3964                 |       ${ $0 = NULL; }$
3965         $void
3966         Const -> IDENTIFIER :: CType = Expression ${ {
3967                 int ok;
3968                 struct variable *v;
3969
3970                 v = var_decl(c, $1.txt);
3971                 if (v) {
3972                         struct var *var = new_pos(var, $1);
3973                         v->where_decl = var;
3974                         v->where_set = var;
3975                         var->var = v;
3976                         v->constant = 1;
3977                 } else {
3978                         v = var_ref(c, $1.txt);
3979                         tok_err(c, "error: name already declared", &$1);
3980                         type_err(c, "info: this is where '%v' was first declared",
3981                                  v->where_decl, NULL, 0, NULL);
3982                 }
3983                 do {
3984                         ok = 1;
3985                         propagate_types($5, c, &ok, $3, 0);
3986                 } while (ok == 2);
3987                 if (!ok)
3988                         c->parse_error = 1;
3989                 else if (v) {
3990                         v->val = interp_exec($5);
3991                 }
3992         } }$
3993
3994 ###### print const decls
3995         {
3996                 struct variable *v;
3997                 int target = -1;
3998
3999                 while (target != 0) {
4000                         int i = 0;
4001                         for (v = context.in_scope; v; v=v->in_scope)
4002                                 if (v->depth == 0) {
4003                                         i += 1;
4004                                         if (i == target)
4005                                                 break;
4006                                 }
4007
4008                         if (target == -1) {
4009                                 if (i)
4010                                         printf("const:\n");
4011                                 target = i;
4012                         } else {
4013                                 printf("    %.*s :: ", v->name->name.len, v->name->name.txt);
4014                                 type_print(v->val.type, stdout);
4015                                 printf(" = ");
4016                                 if (v->val.type == Tstr)
4017                                         printf("\"");
4018                                 print_value(v->val);
4019                                 if (v->val.type == Tstr)
4020                                         printf("\"");
4021                                 printf("\n");
4022                                 target -= 1;
4023                         }
4024                 }
4025         }
4026
4027 ### Finally the whole program.
4028
4029 Somewhat reminiscent of Pascal a (current) Ocean program starts with
4030 the keyword "program" and a list of variable names which are assigned
4031 values from command line arguments.  Following this is a `block` which
4032 is the code to execute.  Unlike Pascal, constants and other
4033 declarations come *before* the program.
4034
4035 As this is the top level, several things are handled a bit
4036 differently.
4037 The whole program is not interpreted by `interp_exec` as that isn't
4038 passed the argument list which the program requires.  Similarly type
4039 analysis is a bit more interesting at this level.
4040
4041 ###### Binode types
4042         Program,
4043
4044 ###### top level grammar
4045
4046         DeclareProgram -> Program ${ {
4047                 if (c->prog)
4048                         type_err(c, "Program defined a second time",
4049                                  $1, NULL, 0, NULL);
4050                 else
4051                         c->prog = $<1;
4052         } }$
4053
4054         $*binode
4055         Program -> program OpenScope Varlist Block ${
4056                 $0 = new(binode);
4057                 $0->op = Program;
4058                 $0->left = reorder_bilist($<3);
4059                 $0->right = $<4;
4060                 var_block_close(c, CloseSequential);
4061                 if (c->scope_stack) abort();
4062                 }$
4063                 | ERROR ${
4064                         tok_err(c,
4065                                 "error: unhandled parse error", &$1);
4066                 }$
4067
4068         Varlist -> Varlist ArgDecl ${
4069                         $0 = new(binode);
4070                         $0->op = Program;
4071                         $0->left = $<1;
4072                         $0->right = $<2;
4073                 }$
4074                 | ${ $0 = NULL; }$
4075
4076         $*var
4077         ArgDecl -> IDENTIFIER ${ {
4078                 struct variable *v = var_decl(c, $1.txt);
4079                 $0 = new(var);
4080                 $0->var = v;
4081         } }$
4082
4083         ## Grammar
4084
4085 ###### print binode cases
4086         case Program:
4087                 do_indent(indent, "program");
4088                 for (b2 = cast(binode, b->left); b2; b2 = cast(binode, b2->right)) {
4089                         printf(" ");
4090                         print_exec(b2->left, 0, 0);
4091                 }
4092                 if (bracket)
4093                         printf(" {\n");
4094                 else
4095                         printf(":\n");
4096                 print_exec(b->right, indent+1, bracket);
4097                 if (bracket)
4098                         do_indent(indent, "}\n");
4099                 break;
4100
4101 ###### propagate binode cases
4102         case Program: abort();          // NOTEST
4103
4104 ###### core functions
4105
4106         static int analyse_prog(struct exec *prog, struct parse_context *c)
4107         {
4108                 struct binode *b = cast(binode, prog);
4109                 int ok = 1;
4110
4111                 if (!b)
4112                         return 0;       // NOTEST
4113                 do {
4114                         ok = 1;
4115                         propagate_types(b->right, c, &ok, Tnone, 0);
4116                 } while (ok == 2);
4117                 if (!ok)
4118                         return 0;
4119
4120                 for (b = cast(binode, b->left); b; b = cast(binode, b->right)) {
4121                         struct var *v = cast(var, b->left);
4122                         if (!v->var->val.type) {
4123                                 v->var->where_set = b;
4124                                 v->var->val = val_prepare(Tstr);
4125                         }
4126                 }
4127                 b = cast(binode, prog);
4128                 do {
4129                         ok = 1;
4130                         propagate_types(b->right, c, &ok, Tnone, 0);
4131                 } while (ok == 2);
4132                 if (!ok)
4133                         return 0;
4134
4135                 /* Make sure everything is still consistent */
4136                 propagate_types(b->right, c, &ok, Tnone, 0);
4137                 return !!ok;
4138         }
4139
4140         static void interp_prog(struct exec *prog, char **argv)
4141         {
4142                 struct binode *p = cast(binode, prog);
4143                 struct binode *al;
4144                 struct value v;
4145
4146                 if (!prog)
4147                         return;         // NOTEST
4148                 al = cast(binode, p->left);
4149                 while (al) {
4150                         struct var *v = cast(var, al->left);
4151                         struct value *vl = &v->var->val;
4152
4153                         if (argv[0] == NULL) {
4154                                 printf("Not enough args\n");
4155                                 exit(1);
4156                         }
4157                         al = cast(binode, al->right);
4158                         free_value(*vl);
4159                         *vl = parse_value(vl->type, argv[0]);
4160                         if (vl->type == NULL)
4161                                 exit(1);
4162                         argv++;
4163                 }
4164                 v = interp_exec(p->right);
4165                 free_value(v);
4166         }
4167
4168 ###### interp binode cases
4169         case Program: abort();  // NOTEST
4170
4171 ## And now to test it out.
4172
4173 Having a language requires having a "hello world" program.  I'll
4174 provide a little more than that: a program that prints "Hello world"
4175 finds the GCD of two numbers, prints the first few elements of
4176 Fibonacci, performs a binary search for a number, and a few other
4177 things which will likely grow as the languages grows.
4178
4179 ###### File: oceani.mk
4180         demos :: sayhello
4181         sayhello : oceani
4182                 @echo "===== DEMO ====="
4183                 ./oceani --section "demo: hello" oceani.mdc 55 33
4184
4185 ###### demo: hello
4186
4187         const:
4188                 pi ::= 3.141_592_6
4189                 four ::= 2 + 2 ; five ::= 10/2
4190         const pie ::= "I like Pie";
4191                 cake ::= "The cake is"
4192                   ++ " a lie"
4193
4194         struct fred:
4195                 size:[four]number
4196                 name:string
4197                 alive:Boolean
4198
4199         program A B:
4200                 print "Hello World, what lovely oceans you have!"
4201                 print "Are there", five, "?"
4202                 print pi, pie, "but", cake
4203
4204                 /* When a variable is defined in both branches of an 'if',
4205                  * and used afterwards, the variables are merged.
4206                  */
4207                 if A > B:
4208                         bigger := "yes"
4209                 else:
4210                         bigger := "no"
4211                 print "Is", A, "bigger than", B,"? ", bigger
4212                 /* If a variable is not used after the 'if', no
4213                  * merge happens, so types can be different
4214                  */
4215                 if A > B * 2:
4216                         double:string = "yes"
4217                         print A, "is more than twice", B, "?", double
4218                 else:
4219                         double := B*2
4220                         print "double", B, "is", double
4221
4222                 a : number
4223                 a = A;
4224                 b:number = B
4225                 if a > 0 and then b > 0:
4226                         while a != b:
4227                                 if a < b:
4228                                         b = b - a
4229                                 else:
4230                                         a = a - b
4231                         print "GCD of", A, "and", B,"is", a
4232                 else if a <= 0:
4233                         print a, "is not positive, cannot calculate GCD"
4234                 else:
4235                         print b, "is not positive, cannot calculate GCD"
4236
4237                 for:
4238                         togo := 10
4239                         f1 := 1; f2 := 1
4240                         print "Fibonacci:", f1,f2,
4241                 then togo = togo - 1
4242                 while togo > 0:
4243                         f3 := f1 + f2
4244                         print "", f3,
4245                         f1 = f2
4246                         f2 = f3
4247                 print ""
4248
4249                 /* Binary search... */
4250                 for:
4251                         lo:= 0; hi := 100
4252                         target := 77
4253                 while:
4254                         mid := (lo + hi) / 2
4255                         if mid == target:
4256                                 use Found
4257                         if mid < target:
4258                                 lo = mid
4259                         else:
4260                                 hi = mid
4261                         if hi - lo < 1:
4262                                 use GiveUp
4263                         use True
4264                 do: pass
4265                 case Found:
4266                         print "Yay, I found", target
4267                 case GiveUp:
4268                         print "Closest I found was", mid
4269
4270                 size::= 10
4271                 list:[size]number
4272                 list[0] = 1234
4273                 // "middle square" PRNG.  Not particularly good, but one my
4274                 // Dad taught me - the first one I ever heard of.
4275                 for i:=1; then i = i + 1; while i < size:
4276                         n := list[i-1] * list[i-1]
4277                         list[i] = (n / 100) % 10 000
4278
4279                 print "Before sort:",
4280                 for i:=0; then i = i + 1; while i < size:
4281                         print "", list[i],
4282                 print
4283
4284                 for i := 1; then i=i+1; while i < size:
4285                         for j:=i-1; then j=j-1; while j >= 0:
4286                                 if list[j] > list[j+1]:
4287                                         t:= list[j]
4288                                         list[j] = list[j+1]
4289                                         list[j+1] = t
4290                 print " After sort:",
4291                 for i:=0; then i = i + 1; while i < size:
4292                         print "", list[i],
4293                 print
4294
4295                 bob:fred
4296                 bob.name = "Hello"
4297                 bob.alive = (bob.name == "Hello")
4298                 print "bob", "is" if  bob.alive else "isn't", "alive"