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