ocean-lang.org Git - ocean/blob - csrc/scanner.mdc

   1 # Lexical Scanner #
   2
   3 ## The Task at Hand ##
   4
   5 The main task of the lexical scanner is to convert a stream of
   6 characters into a stream of tokens.  The tokens are then typically
   7 used by a parser to extract the syntactic structure.
   8
   9 The stream of characters are assumed to be in memory identified by a
  10 linked list of blocks, such as provided by the "[mdcode][]" literate
  11 program extractor.  A single token may never cross a block boundary.
  12
  13 [mdcode]: mdcode.html
  14
  15 ###### includes
  16         #include "mdcode.h"
  17
  18 The text is assumed to be UTF-8 though some matching assumes the
  19 ASCII subset.  If the text provided does not conform to UTF-8 an error
  20 will be reported and some number of bytes will be skipped.
  21
  22 ###### public types
  23         #include <wchar.h>
  24         #include <wctype.h>
  25         #include <unicode/uchar.h>
  26
  27 Tokens are returned by successive calls to the main interface
  28 function: `token_next()` which has a `state` structure to keep track
  29 of where it is up to.  Each token carries not just a numeric
  30 identifier but also the code block, the line and character within that
  31 block, and the actual start and length using the `struct text` from
  32 "mdcode".
  33
  34 ###### public types
  35         struct token {
  36                 int               num;
  37                 struct code_node *node;
  38                 struct text       txt;
  39                 int               line, col;
  40         };
  41         struct token_state;
  42
  43 ###### private types
  44         struct token_state {
  45                 ## state fields
  46         };
  47
  48 ###### exported functions
  49         struct token token_next(struct token_state *state);
  50
  51 ###### main functions
  52         struct token token_next(struct token_state *state)
  53         {
  54                 ## token_next init
  55                 while (1) {
  56                         wint_t ch;
  57                         struct token tk;
  58
  59                         ## one token
  60                 }
  61         }
  62
  63 The `line` and `col` offsets are useful for reporting errors.
  64 The `txt` provides the content when that is important.
  65
  66 ### Token types and configuration ##
  67
  68 The scanner is not completely general, yet not completely specified.
  69 There are a fixed set of token types, though particular tokens within
  70 those types can be distinguish via configuration.
  71
  72 Most token types may be explicitly ignored, as typically comments
  73 would be.  The exact consequence of ignoring each token type varies
  74 from token to token.
  75
  76 ###### public types
  77         struct token_config {
  78                 int ignored;    // bit set of ignored tokens.
  79                 ## token config parameters
  80         };
  81
  82 ###### state fields
  83         struct token_config *conf;
  84
  85 ###### token_next init
  86         int ignored = state->conf->ignored;
  87
  88 The different tokens are numbers, words, marks, strings, comments,
  89 newlines, EOF, and indents, each of which is examined in detail below.
  90
  91 There are various cases where no token can be found in part of the
  92 input.  All of these will be reported as a `TK_error` token.
  93
  94 It is possible to declare a number of strings which form distinct
  95 tokens (rather than being grouped as e.g. 'word').  These are given
  96 token numbers from `TK_reserved` upwards.
  97
  98 ###### public types
  99         enum token_num {
 100                 TK_error,
 101                 ## token types
 102                 TK_reserved
 103         };
 104
 105 ### Numbers
 106
 107 Numbers are the messiest tokens to parse, primarily because they can
 108 contain characters that also have meaning outside of numbers and,
 109 particularly, immediately after numbers.
 110
 111 The obvious example is the '`-`' sign.  It can come inside a number for
 112 a negative exponent, or after a number as a subtraction operator.  To
 113 be sure we have parsed as best as possible we need to only allow the
 114 '`-`' inside a number if it is after an exponent character.  This can be
 115 `e` or `p` (for hex exponents), but `e` can also be a hexadecimal
 116 digit, so we don't allow '`-`' after just any `e`.
 117
 118 To make matters worse, our language designer has decided to experiment
 119 with allowing commas to be used as the decimal indicator, and spaces
 120 to be used to separate groups of digits in large numbers.  Both of
 121 these can reasonably be restricted to appear between two digits, so we
 122 have to add that condition to our tests.  For consistency we require
 123 every non-alpha-numeric to appear between two hex digits, with the
 124 exception that a sign can appear only after a 'p' or 'e', and a space
 125 can only appear between decimal digits.  Allowing a space before a
 126 letter easily leads to confusion, such a in `a < 3 and b < 4`.
 127
 128 So we cannot just treat numbers as starting with a digit and being
 129 followed by some set of characters.  We need more structure than that.
 130
 131 So:
 132
 133 - Numbers must start with a digit.
 134 - If the first digit is zero, the next character should be a base
 135   signifier (one of `xob`) or a decimal marker (`.` or `,`) (though this isn't
 136   enforced at this stage)
 137   In the first case the only first `p` or `P` may be followed by a sign.
 138 - If the number doesn't start with `0` followed by one of `xob`, the
 139   first `e` may be followed by a sign.
 140 - A sign must always be followed by a digit.
 141 - Any digit may be followed by a space or underscore and any hex digit
 142   maybe followed by an underscore, providing that the subsequence character
 143   is also a digit (for space) or hex digit (for underscore).
 144   This rule will require an extra level of 'unget' to be
 145   supported when handling characters.
 146 - Otherwise any digits or ASCII letters are allowed.  We do not at
 147   this point check that the digits given are permitted by the base.
 148   That will happen when the token is converted to a number.
 149
 150 To allow easy configuration, the various non alphanumeric characters
 151 are only permitted if they are listed in a configuration parameter.
 152
 153 ###### token config parameters
 154         char *number_chars;
 155
 156 Note that numbers may not start with a period, so `.75` is not a
 157 number.  This is not the norm, but is not unheard of.  Excluding these
 158 numbers simplifies the rule at very little cost.
 159
 160 ###### token types
 161         TK_number,
 162
 163 If TK_number is ignored, digits will result in an error unless they
 164 are declared to be a start character for words.
 165
 166 ###### includes
 167
 168         #include <string.h>
 169
 170 ###### parse number
 171
 172         if (iswdigit(ch) && !(ignored & (1<<TK_number))) {
 173                 int prev = 0;
 174                 int expect_p = 0;
 175                 int decimal_mark = 0;
 176                 if (ch == '0') {
 177                         wchar_t ch2 = get_char(state);
 178                         if (strchr("xobXOB", ch2) != NULL)
 179                                 expect_p = 1;
 180                         unget_char(state);
 181                 }
 182                 while (1) {
 183                         int sign_ok = 0;
 184                         switch(expect_p) {
 185                         case 0:
 186                                 if (ch == 'e' || ch == 'E') {
 187                                         sign_ok = 1;
 188                                         decimal_mark = 1;
 189                                 }
 190                                 break;
 191                         case 1:
 192                                 if (ch == 'p' || ch == 'P') {
 193                                         sign_ok = 1;
 194                                         decimal_mark = 1;
 195                                 }
 196                                 break;
 197                         }
 198                         save_unget_state(state);
 199                         prev = ch;
 200                         ch = get_char(state);
 201
 202                         if (!iswalnum(prev)) {
 203                                 /* special characters, like separators and decimal marks
 204                                  * and signs, must be followed by a hexdigit, and the
 205                                  * space and signs must be followed by a decimal digit.
 206                                  */
 207                                 if (!iswxdigit(ch) ||
 208                                    ((prev == '-' || prev == '+') && !iswdigit(ch)) ||
 209                                    (prev == ' ' && !iswdigit(ch))) {
 210                                         /* don't want the new char or the special */
 211                                         restore_unget_state(state);
 212                                         break;
 213                                 }
 214                         }
 215                         if (iswalnum(ch))
 216                                 continue;
 217
 218                         if (!strchr(state->conf->number_chars, ch)) {
 219                                 /* non-number char */
 220                                 break;
 221                         }
 222                         if (ch == '+' || ch == '-') {
 223                                 /* previous must be 'e' or 'p' in appropraite context */
 224                                 if (!sign_ok)
 225                                         break;
 226                                 expect_p = -1;
 227                         } else if (ch == ' ') {
 228                                 /* previous must be a digit */
 229                                 if (!iswdigit(prev))
 230                                         break;
 231                         } else {
 232                                 /* previous must be a hex digit */
 233                                 if (!iswxdigit(prev))
 234                                         break;
 235                         }
 236                         if (ch == '.' || ch == ',') {
 237                                 /* only one of these permitted */
 238                                 if (decimal_mark)
 239                                         break;
 240                                 decimal_mark = 1;
 241                         }
 242                 }
 243                 /* We seem to have a "number" token */
 244                 unget_char(state);
 245                 close_token(state, &tk);
 246                 tk.num = TK_number;
 247                 return tk;
 248         }
 249
 250 ### Words
 251 Words start with a "start" character followed by the longest
 252 sequence of "continue" characters.  The Unicode ID_START and
 253 ID_CONTINUE sets are always permitted, but other ASCII characters
 254 can be added to these sets.
 255
 256 ###### token config parameters
 257         char *word_start;
 258         char *word_cont;
 259
 260 ###### internal functions
 261         static int is_word_start(wchar_t ch, struct token_config *conf)
 262         {
 263                 return iswalpha(ch) ||
 264                        strchr(conf->word_start, ch) != NULL ||
 265                        u_hasBinaryProperty(ch, UCHAR_ID_START);
 266         }
 267
 268         static int is_word_continue(wchar_t ch, struct token_config *conf)
 269         {
 270                 return iswalnum(ch) ||
 271                        strchr(conf->word_cont, ch) != NULL ||
 272                        u_hasBinaryProperty(ch, UCHAR_ID_CONTINUE);
 273         }
 274
 275 Words can be either known or unknown.  Known words are referred to as
 276 "reserved words" and get a unique token number.  Unknown words are
 277 "identifiers" and are syntactically a single token.
 278
 279 ###### token types
 280         TK_ident,
 281
 282 A list of known words must be provided.  This list is shared with the
 283 "marks" which are described next.  The list must be lexically sorted
 284 and the length of the list must be given (`known_count`).
 285 Tokens matching these known words are reported as the index of the
 286 list added to `TK_reserved`.
 287
 288 If identifiers are ignored, then any word which is not listed as a
 289 known word results in an error.
 290
 291 ###### token config parameters
 292         const char **words_marks;
 293         int known_count;
 294
 295 ###### parse word
 296
 297         if (is_word_start(ch, state->conf)) {
 298                 int n;
 299                 /* A word: identifier or reserved */
 300                 do
 301                         ch = get_char(state);
 302                 while (is_word_continue(ch, state->conf));
 303                 unget_char(state);
 304                 close_token(state, &tk);
 305                 tk.num = TK_ident;
 306                 if (ignored & (1<<TK_ident))
 307                         tk.num = TK_error;
 308                 n = find_known(state->conf, tk.txt);
 309                 if (n >= 0)
 310                         tk.num = TK_reserved + n;
 311                 return tk;
 312         }
 313
 314 ### Marks
 315
 316 Marks are generally one or more punctuation marks joined together.  It
 317 would be nice to use the term "symbol" for these, but that causes
 318 confusion in a subsequent discussion of the grammar, which has terminal
 319 symbols and non-terminal symbols which are conceptually quite
 320 different.  So strings of punctuation characters will be marks.
 321
 322 A "mark" consists of ASCII characters that are not white space, are not
 323 "start" characters for words, and are not digits.
 324 These will collectively be called mark characters.
 325
 326 ###### internal functions
 327         static int is_mark(wchar_t ch, struct token_config *conf)
 328         {
 329                 return ch > ' ' &&
 330                        ch < 0x7f &&
 331                        !iswalnum(ch) &&
 332                        strchr(conf->word_start, ch) == NULL;
 333         }
 334
 335 As with words, there can be known and unknown marks, though the rules
 336 are slightly different.
 337
 338 Two marks do not need to be separated by a non-mark characters.  This
 339 is different from words which do need to be separated by at least one
 340 non-continue character.
 341
 342 The scanner will normally prefer longer sequences of mark characters,
 343 but will more strongly prefer known marks over unknown marks.  So if
 344 it finds a known mark where adding one more character does not result
 345 in a known mark, it will return that first known mark.
 346
 347 If no known mark is found we will test against strings and comments
 348 below before giving up and assuming an unknown mark.
 349
 350 If an unknown mark contains a quote character or a comment marker, and
 351 that token is not being ignored, then we terminate the unknown mark
 352 before that quote or comment.  This ensures that an unknown mark
 353 immediately before a string is handled correctly.
 354
 355 If the first character of a comment marker (i.e. '/') is a known mark,
 356 the above rules would suggest that the start of a comment would be
 357 parsed as that mark, which is not what is wanted.  So the introductory
 358 sequences for a comment ("//" and "/*") are treated as
 359 partially-known.  They prevent the leading "/" from being a mark by
 360 itself, but do not actually constitute a stand-alone mark.
 361
 362 If `TK_mark` is ignored, then unknown marks are returned as errors.
 363
 364 ###### token types
 365         TK_mark,
 366
 367 Known marks are included in the same list as the list of known words.
 368
 369 ###### parse mark
 370         tk.num = TK_error;
 371         while (is_mark(ch, state->conf)) {
 372                 int n;
 373                 wchar_t prev;
 374                 close_token(state, &tk);
 375                 n = find_known(state->conf, tk.txt);
 376                 if (n >= 0)
 377                         tk.num = TK_reserved + n;
 378                 else if (tk.num != TK_error) {
 379                         /* found a longest-known-mark, still need to
 380                          * check for comments
 381                          */
 382                         if (tk.txt.len == 2 && tk.txt.txt[0] == '/' &&
 383                             (ch == '/' || ch == '*')) {
 384                                 /* Yes, this is a comment, not a '/' */
 385                                 restore_unget_state(state);
 386                                 tk.num = TK_error;
 387                                 break;
 388                         }
 389                         unget_char(state);
 390                         close_token(state, &tk);
 391                         return tk;
 392                 }
 393                 prev = ch;
 394                 save_unget_state(state);
 395                 ch = get_char(state);
 396                 if (!(ignored & (1<<TK_string)) && n < 0 &&is_quote(ch) && !is_quote(prev))
 397                         /* If strings are allowed, a quote (Which isn't a known mark)
 398                          * mustn't be treated as part of an unknown mark.  It can be
 399                          * part of a multi-line srtings though.
 400                          */
 401                         break;
 402                 if (prev == '#' && n < 0)
 403                         /* '#' is not a known mark, so assume it is a comment */
 404                         break;
 405                 if (prev == '/' && ch == '/' && tk.txt.len == 1 && n < 0) {
 406                         close_token(state, &tk);
 407                         restore_unget_state(state);
 408                         break;
 409                 }
 410                 if (prev == '/' && ch == '*' && tk.txt.len == 1 && n < 0) {
 411                         close_token(state, &tk);
 412                         restore_unget_state(state);
 413                         break;
 414                 }
 415         }
 416         unget_char(state);
 417         if (tk.num != TK_error) {
 418                 close_token(state, &tk);
 419                 return tk;
 420         }
 421
 422 If we don't find a known mark, we will check for strings and comments
 423 before assuming that we have an unknown mark
 424
 425 ###### parse mark
 426         ## parse string
 427         ## parse comment
 428         ## unknown mark
 429
 430 ### Strings
 431
 432 Strings start with one of single quote, double quote, or back quote
 433 and continue until a matching character on the same line.  Any of
 434 these characters can be included in the list of known marks and then
 435 they will not be used for identifying strings.
 436
 437 Immediately following the close quote, one or two ASCII letters may
 438 appear.  These are somewhat like the arbitrary letters allowed in
 439 "Numbers" above.  They can be used by the language in various ways.
 440
 441 If 3 identical quote characters appear in a row and are
 442 followed by a newline, then this forms a multi-line string which
 443 continues until an identical triple quote appears on a line preceded
 444 only by whitespace and followed immediately by 0-2 ASCII letters and a newline.
 445
 446 Multi-line strings may not extend beyond the end of the `code_node` in
 447 which they start.
 448
 449 Normal strings and multi-line strings are encoded as two different
 450 token types.
 451
 452 ###### token types
 453         TK_string,
 454         TK_multi_string,
 455
 456 ###### internal functions
 457         static int is_quote(wchar_t ch)
 458         {
 459                 return ch == '\'' || ch == '"' || ch == '`'; // "
 460         }
 461
 462 #### Multi-line strings
 463
 464 The multi-line string is checked for first.  If they are being
 465 ignored, we fall through and treat a triple quote as an empty string
 466 followed by the start of a new string.
 467
 468 ###### parse string
 469         if (tk.txt.len == 3 &&
 470             !(ignored & (1 << TK_multi_string)) &&
 471             is_quote(tk.txt.txt[0]) &&
 472             memcmp(tk.txt.txt, tk.txt.txt+1, 2) == 0 &&
 473             is_newline(tk.txt.txt[3])) {
 474                 // triple quote
 475                 wchar_t first = tk.txt.txt[0];
 476                 int qseen = 0;
 477                 int at_sol = 1;
 478                 while (!at_eon(state) && qseen < 3) {
 479                         ch = get_char(state);
 480                         if (is_newline(ch)) {
 481                                 at_sol = 1;
 482                                 qseen = 0;
 483                         } else if (at_sol && ch == first) {
 484                                 qseen += 1;
 485                         } else if (ch != ' ' && ch != '\t') {
 486                                 at_sol = 0;
 487                                 qseen = 0;
 488                         }
 489                 }
 490                 if (qseen != 3) {
 491                         /* Hit end of node - error.
 492                          * unget so the newline is seen,
 493                          * but return rest of string as an error.
 494                          */
 495                         if (is_newline(ch))
 496                                 unget_char(state);
 497                         close_token(state, &tk);
 498                         tk.num = TK_error;
 499                         return tk;
 500                 }
 501                 /* 2 letters are allowed */
 502                 ch = get_char(state);
 503                 if (iswalpha(ch))
 504                         ch = get_char(state);
 505                 if (iswalpha(ch))
 506                         ch = get_char(state);
 507                 /* Now we must have a newline, but we don't return it
 508                  * whatever it is.*/
 509                 unget_char(state);
 510                 close_token(state, &tk);
 511                 tk.num = TK_multi_string;
 512                 if (!is_newline(ch))
 513                         tk.num = TK_error;
 514                 return tk;
 515         }
 516
 517 #### Single-line strings
 518
 519 The sequence of marks collected may be more than a single-line
 520 string, so we reset to the start and collect characters until
 521 we find a close quote or a newline.
 522
 523 If `TK_string` is ignored, then quote characters will appear as `TK_mark`s.
 524
 525 ###### parse string
 526         if (tk.txt.len && is_quote(tk.txt.txt[0]) &&
 527             !(ignored & (1<<TK_string))) {
 528                 wchar_t first = tk.txt.txt[0];
 529                 reset_token(state, &tk);
 530                 ch = get_char(state);
 531                 tk.num = TK_error;
 532                 while (!at_eon(state) && !is_newline(ch)) {
 533                         ch = get_char(state);
 534                         if (ch == first) {
 535                                 tk.num = TK_string;
 536                                 break;
 537                         }
 538                         if (is_newline(ch)) {
 539                                 unget_char(state);
 540                                 break;
 541                         }
 542                 }
 543                 while (!at_eon(state) && (ch = get_char(state)) &&
 544                                           iswalpha(ch))
 545                         ;
 546                 unget_char(state);
 547                 close_token(state, &tk);
 548                 return tk;
 549         }
 550
 551 ### Comments
 552
 553 Single line comments may start with '`//`' or '`#`' providing that these
 554 are not known marks.  They continue to the end of the line.
 555
 556 Block comments start with '`/*`' if this is not a known mark.  They
 557 continue to the first occurrence of '`*/`' and may not contain any
 558 occurrence of '`/*`'.
 559
 560 Block comments can be wholly within one line or can continue over
 561 multiple lines.  The multi-line version should be followed immediately
 562 by a newline.  The Linux kernel contains over 285000 multi-line
 563 comments are only 34 are followed by characters other than white space
 564 (which should be removed) or a backslash (only needed in macros).  So
 565 it would not suffer from this rule.
 566
 567 These two comment types are reported as two separate token types, and
 568 consequently can be ignored separately.  When ignored a comment is
 569 still parsed, but is discarded.
 570
 571 ###### token types
 572         TK_line_comment,
 573         TK_block_comment,
 574
 575 ###### internal functions
 576         static int is_line_comment(struct text txt)
 577         {
 578                 return (txt.len >= 1 && txt.txt[0] == '#') ||
 579                        (txt.len >= 2 && txt.txt[0] == '/' &&
 580                                         txt.txt[1] == '/');
 581         }
 582
 583         static int is_block_comment(struct text txt)
 584         {
 585                 return txt.len >= 2 && txt.txt[0] == '/' &&
 586                        txt.txt[1] == '*';
 587         }
 588
 589 #### Single line comments
 590
 591 A single-line comment continues up to, but not including the newline
 592 or end of node.
 593
 594 ###### parse comment
 595
 596         if (is_line_comment(tk.txt)) {
 597                 while (!is_newline(ch) && !at_eon(state))
 598                         ch = get_char(state);
 599                 if (is_newline(ch))
 600                         unget_char(state);
 601                 close_token(state, &tk);
 602                 tk.num = TK_line_comment;
 603                 if (ignored & (1 << TK_line_comment))
 604                         continue;
 605                 return tk;
 606         }
 607
 608 #### Block comments
 609
 610 The token text collected so far could exceed the comment, so we need
 611 to reset it first.
 612
 613 If we find an embedded `/*` we reset to just before the '/' and report
 614 an error.  That way the next thing to be parsed will be the rest of
 615 the comment.  This requires a double unget, so we need to save/restore
 616 the unget state (explained later).
 617
 618 ###### parse comment
 619
 620         if (is_block_comment(tk.txt)) {
 621                 wchar_t prev;
 622                 int newlines = 0;
 623                 reset_token(state, &tk);
 624                 get_char(state);
 625                 get_char(state);
 626                 save_unget_state(state);
 627                 ch = get_char(state);
 628                 prev = 0;
 629                 while (!at_eon(state) &&
 630                        (prev != '/' || ch != '*') &&
 631                        (prev != '*' || ch != '/')) {
 632                         if (is_newline(ch))
 633                                 newlines = 1;
 634                         prev = ch;
 635                         save_unget_state(state);
 636                         ch = get_char(state);
 637                 }
 638                 close_token(state, &tk);
 639                 if (at_eon(state)) {
 640                         tk.num = TK_error;
 641                         return tk;
 642                 }
 643                 if (prev == '/') {
 644                         /* embedded.  Need to unget twice! */
 645                         restore_unget_state(state);
 646                         unget_char(state);
 647                         tk.num = TK_error;
 648                         return tk;
 649                 }
 650                 tk.num = TK_block_comment;
 651                 if (newlines && !(ignored & (1<<TK_newline))) {
 652                         /* next char must be newline */
 653                         ch = get_char(state);
 654                         unget_char(state);
 655                         if (!is_newline(ch))
 656                                 tk.num = TK_error;
 657                 }
 658                 if (tk.num == TK_error ||
 659                     !(ignored & (1 << TK_block_comment)))
 660                         return tk;
 661                 continue;
 662         }
 663
 664 ### Indents, Newlines, and White Space.
 665
 666 Normally white space is ignored.  However newlines can be important as
 667 can indents, which are either after a newline or at the start of a
 668 node (detected by `at_son()`);
 669
 670 ###### exported functions
 671         static inline int is_newline(wchar_t ch)
 672         {
 673                 return ch == '\n' || ch == '\f' || ch == '\v';
 674         }
 675
 676 ###### white space
 677         if (ch <= ' ' && !is_newline(ch)
 678             && ! at_son(state))
 679                 continue;
 680
 681 If a line starts with more white-space than the previous non-blank
 682 line - or if the first non-blank line in the document starts with any
 683 white-space - then an "IN" is reported at the start of the line.
 684
 685 Before the next non-blank line which starts with less white space, or
 686 at the latest at the end of the document, a matching "OUT" token
 687 is reported.  There will always be an exact match between "IN" and
 688 "OUT" tokens.
 689
 690 It is possible for "OUT" to be followed (almost) immediately by an
 691 "IN".  This happens if, for example, the indent of three consecutive
 692 lines are 0, 8, 4 spaces.  Before the second line we report an
 693 "IN".  Before the third line we must report an "OUT", as 4 is less
 694 than 8, then also an Ident as 4 is greater than 0.
 695
 696 ###### token types
 697         TK_in,
 698         TK_out,
 699
 700 For the purpose of measuring the length of white space, a tab adds at
 701 least one space, and rounds up to a multiple of 8.
 702
 703 ###### exported functions
 704         static inline int indent_tab(int indent)
 705         {
 706                 return (indent|7)+1;
 707         }
 708
 709 We need to track the current levels of indent.  This requires some
 710 sort of stack as indent levels are pushed on and popped off.  In
 711 practice this stack is unlikely to often exceed 5 so we will used a
 712 fixed stack of 20 indent levels.  More than this will be silently
 713 ignored.
 714
 715 ###### state fields
 716         int     indent_level;
 717         int     indent_sizes[20];
 718
 719 `indent_sizes[0]` will always be zero - this simplifies some code.
 720
 721 #### Newlines
 722
 723 Newlines can optionally be reported.  Newlines within a block comment
 724 or a multi-line string are not reported separately, but each of these
 725 must be followed immediately by a newline so these constructs cannot
 726 hide the fact that a newline was present.
 727
 728 When indents are being reported, the Newline which would normally be
 729 reported immediately before the "IN" is delayed until after the
 730 matching "OUT".  This makes an indented section act like a
 731 continuation of the previous line to some extent.
 732
 733 A blank line would normally be reported simply as two consecutive Newline
 734 tokens.  However if the subsequent line is indented (and indents are being
 735 reported) then the right thing to do is less obvious as Newlines should be
 736 delayed - but how many Newlines?
 737
 738 The approach we will take is to report the extra Newlines immediately after
 739 the IN token, so the blank line is treated as though it were an indented
 740 blank line.
 741
 742 ###### token types
 743         TK_newline,
 744
 745 If we find a newline or white space at the start of a block, we keep
 746 collecting spaces, tabs, and newlines until we find some real text.
 747 Then depending on the indent we generate some number of tokens.  These
 748 will be a sequence of "Newline OUT" pairs representing a decrease
 749 in indent, then either a Newline or an IN depending on whether the
 750 next line is indented, then zero or more Newlines representing all the
 751 blank lines that have been skipped.
 752
 753 When a Newline leads to the next block of code there is a question of
 754 whether the various Newline and OUT/IN tokens should appear to
 755 belong to the earlier or later block.  This is addressed by processing
 756 the tokens in two stages based on the relative indent levels of the
 757 two blocks (each block has a base indent to which the actual indents
 758 are added).
 759
 760 Any "Newline OUT" pairs needed to reduce the current indent to the
 761 maximum of the base indents of the old and new blocks are generated
 762 against the old block.  Then if the next block does not have an
 763 increased indent, one more "Newline" is generated.
 764
 765 If further "Newline OUT" pairs are needed to get to the indent
 766 level of the 'next' block, they are generated against that block,
 767 though the first Newline is suppressed (it having already been
 768 generated).
 769
 770 Finally the Newline or IN for the first line of the new block is
 771 generated, unless the Newline needs to be suppressed because it
 772 appeared at the end of the previous block.
 773
 774 This means that a block may start with an OUT or an IN, but
 775 will only start with a Newline if it actually starts with a blank
 776 line.
 777
 778 We will need to represent in the `token_state` where in this sequence
 779 of delayed tokens we are.  As `state.col` records the target indent we
 780 don't need to record how many OUTs or INs are needed.  We do
 781 need to record the number of blank lines, and which of Newline and
 782 OUT is needed next in the initial sequence of pairs.
 783
 784 For this we store one more than the number of blank lines as
 785 `delayed_lines` and a flag for `out_next`.
 786
 787 ###### state fields
 788         int check_indent;
 789         int delayed_lines;
 790         int out_next;
 791
 792 Generating these tokens involves two separate pieces of code.
 793
 794 Firstly we need to recognise white space and count the indents and
 795 newlines.  These are recorded in the above state fields.
 796
 797 Separately we need, on each call to `token_next`, to check if
 798 there are some delayed tokens and if so we need to advance the state
 799 information and return one token.
 800
 801 ###### internal functions
 802         static int state_indent(struct token_state *state)
 803         {
 804                 if (state->node == NULL)
 805                         return state->col;
 806                 return state->node->indent - state->node->needs_strip + state->col;
 807         }
 808
 809 ###### white space
 810         if (is_newline(ch))
 811                 state_check_node(state);
 812         if (is_newline(ch) || (at_son(state) && ch <= ' ')) {
 813                 int newlines = 0;
 814                 int was_nl = is_newline(ch);
 815                 if (ignored & (1<<TK_in)) {
 816                         if (!is_newline(ch))
 817                                 continue;
 818                         if (ignored & (1<<TK_newline))
 819                                 continue;
 820                         tk.num = TK_newline;
 821                         close_token(state, &tk);
 822                         return tk;
 823                 }
 824                 // Indents are needed, so check all white space.
 825                 while (ch <= ' ' && ch != WEOF) {
 826                         if (is_newline(ch))
 827                                 newlines += 1;
 828                         ch = get_char(state);
 829                         if (is_newline(ch))
 830                                 state_check_node(state);
 831                 }
 832                 if (ch != WEOF)
 833                         unget_char(state);
 834                 state->delayed_lines = newlines;
 835                 state->out_next = !was_nl;
 836                 state->check_indent = 1;
 837                 continue;
 838         }
 839
 840 ###### delayed tokens
 841
 842         if (state->check_indent || state->delayed_lines) {
 843                 if (state_indent(state) < state->indent_sizes[state->indent_level]) {
 844                         if (!state->out_next &&
 845                             !(ignored & (1<<TK_newline))) {
 846                                 state->out_next = 1;
 847                                 tk.num = TK_newline;
 848                                 return tk;
 849                         }
 850                         state->indent_level -= 1;
 851                         state->out_next = 0;
 852                         tk.num = TK_out;
 853                         return tk;
 854                 }
 855                 if (state_indent(state) > state->indent_sizes[state->indent_level] &&
 856                     state->indent_level < sizeof(state->indent_sizes)-1) {
 857                         state->indent_level += 1;
 858                         state->indent_sizes[state->indent_level] = state_indent(state);
 859                         if (state->delayed_lines)
 860                                 state->delayed_lines -= 1;
 861                         tk.num = TK_in;
 862                         return tk;
 863                 }
 864                 state->check_indent = 0;
 865                 if (state->delayed_lines && !(ignored & (1<<TK_newline))) {
 866                         tk.num = TK_newline;
 867                         state->delayed_lines -= 1;
 868                         return tk;
 869                 }
 870                 state->delayed_lines = 0;
 871                 continue;
 872         }
 873
 874 ### End of File
 875
 876 After the last newline in the file has been processed, a special
 877 end-of-file token will be returned.  any further attempts to get more
 878 tokens will continue to return the same end-of-file token.
 879
 880 ###### token types
 881         TK_eof,
 882
 883 ###### white space
 884         if (ch == WEOF) {
 885                 tk.num = TK_eof;
 886                 return tk;
 887         }
 888
 889 ### Unknown Marks, or errors.
 890
 891 We have now handled all the possible known mark-like tokens.
 892 If the token we have is not empty and `TK_mark` is allowed,
 893 we have an unknown mark, otherwise this must be an error.
 894
 895 ###### unknown mark
 896
 897         /* one unknown mark character */
 898         if (tk.txt.len) {
 899                 close_token(state, &tk);
 900                 if (ignored & (1<<TK_mark))
 901                         tk.num = TK_error;
 902                 else
 903                         tk.num = TK_mark;
 904                 return tk;
 905         }
 906         /* Completely unrecognised character is next, possibly
 907          * a digit and we are ignoring numbers.
 908          * What ever it is, make it an error.
 909          */
 910         get_char(state);
 911         close_token(state, &tk);
 912         tk.num = TK_error;
 913         return tk;
 914
 915 ## Tools For The Task
 916
 917 You may have noticed that are few gaps we left in the above -
 918 functions used without first defining them.  Doing so above would have
 919 broken the flow.
 920
 921 ### Character by character
 922
 923 As we walk through the various `code_node`s we need to process whole
 924 Unicode codepoints, and keep track of which line and column we are on.
 925 We will assume for now that any printing character uses one column,
 926 though that is not true in general.
 927
 928 As the text in a `code_node` may include an indent that identifies it as
 929 being code, we need to be careful to strip that.  The `code_node` has
 930 a flag that tells us whether or not we need to strip.
 931
 932 ###### includes
 933         #include <memory.h>
 934
 935 ###### state fields
 936         struct code_node *node;
 937         int    offset;
 938         int    line;
 939         int    col;
 940         int    strip_offset;
 941
 942 ###### internal functions
 943
 944         static void do_strip(struct token_state *state)
 945         {
 946                 int indent = 0;
 947                 if (state->node->needs_strip) {
 948                         int n = 4;
 949                         while (n && state->node->code.txt[state->offset] == ' ') {
 950                                 indent += 1;
 951                                 state->offset += 1;
 952                                 n -= 1;
 953                         }
 954                         while (n == 4 && state->node->code.txt[state->offset] == '\t') {
 955                                 indent = indent_tab(indent);
 956                                 state->offset += 1;
 957                                 n -= 4;
 958                         }
 959                 }
 960         }
 961
 962         static void state_check_node(struct token_state *state)
 963         {
 964                 if (!state->node)
 965                         return;
 966                 if (state->node->code.len > state->offset)
 967                         return;
 968
 969                 do
 970                         state->node = state->node->next;
 971                 while (state->node && state->node->code.txt == NULL);
 972                 state->offset = 0;
 973                 state->prev_offset = 0;
 974                 state->strip_offset = 0;
 975                 state->col = 0;
 976                 if (state->node == NULL)
 977                         return;
 978                 state->line = state->node->line_no;
 979                 do_strip(state);
 980                 state->col = state->node->needs_strip;
 981                 state->strip_offset = state->offset;
 982         }
 983
 984         static wint_t get_char(struct token_state *state)
 985         {
 986                 wchar_t next;
 987                 size_t n;
 988                 mbstate_t mbstate;
 989
 990                 state_check_node(state);
 991                 if (state->node == NULL)
 992                         return WEOF;
 993
 994                 ## before get_char
 995
 996                 memset(&mbstate, 0, sizeof(mbstate));
 997
 998                 n = mbrtowc(&next, state->node->code.txt + state->offset,
 999                             state->node->code.len - state->offset,
1000                             &mbstate);
1001                 if (n == -2 || n == 0) {
1002                         /* Not enough bytes - not really possible */
1003                         next = '\n';                            // NOTEST
1004                         state->offset = state->node->code.len;  // NOTEST
1005                 } else if (n == -1) {
1006                         /* error */
1007                         state->offset += 1;                     // NOTEST
1008                         next = 0x7f; // an illegal character    // NOTEST
1009                 } else
1010                         state->offset += n;
1011
1012                 if (next >= ' ') {
1013                         state->col += 1;
1014                 } else if (is_newline(next)) {
1015                         state->line += 1;
1016                         do_strip(state);
1017                         state->col = state->node->needs_strip;
1018                 } else if (next == '\t') {
1019                         state->col = indent_tab(state->col);
1020                 }
1021                 return next;
1022         }
1023
1024 We will sometimes want to "unget" the last character as it needs to be
1025 considered again as part of the next token.  So we need to store a
1026 'previous' version of all metadata.
1027
1028 ###### state fields
1029         int    prev_offset;
1030         int    prev_line;
1031         int    prev_col;
1032
1033 ###### before get_char
1034         state->prev_offset = state->offset;
1035         state->prev_line   = state->line;
1036         state->prev_col    = state->col;
1037
1038 ###### internal functions
1039
1040         static void unget_char(struct token_state *state)
1041         {
1042                 if (state->node) {
1043                         state->offset = state->prev_offset;
1044                         state->line   = state->prev_line;
1045                         state->col    = state->prev_col;
1046                 }
1047         }
1048
1049 We occasionally need a double-unget, particularly for numbers and
1050 block comments.  We don't impose this cost on all scanning, but
1051 require those code sections that need it to call `save_unget_state`
1052 before each `get_char`, and then `restore_unget_state` when a
1053 double-unget is needed.
1054
1055 ###### state fields
1056         int     prev_offset2;
1057         int     prev_line2;
1058         int     prev_col2;
1059
1060 ###### internal functions
1061         static void save_unget_state(struct token_state *state)
1062         {
1063                 state->prev_offset2 = state->prev_offset;
1064                 state->prev_line2 = state->prev_line;
1065                 state->prev_col2 = state->prev_col;
1066         }
1067
1068         static void restore_unget_state(struct token_state *state)
1069         {
1070                 state->prev_offset = state->prev_offset2;
1071                 state->prev_line = state->prev_line2;
1072                 state->prev_col = state->prev_col2;
1073         }
1074
1075 At the start of a token we don't want to be at the end of a code block
1076 if we can help it.  To avoid this possibility, we 'get' and 'unget' a
1077 single character.  This will move into the next non-empty code block
1078 and leave the current pointer at the start of it.
1079
1080 This has to happen _after_ dealing with delayed tokens as some of them
1081 must appear in the previous node.  When we do this, we need to reset
1082 the data in the token.
1083
1084 ###### delayed tokens
1085         if (at_eon(state)) {
1086                 get_char(state);
1087                 unget_char(state);
1088                 tk.node = state->node;
1089                 if (state->node)
1090                         tk.txt.txt = state->node->code.txt + state->offset;
1091                 tk.line = state->line;
1092                 tk.col = state->col;
1093                 tk.txt.len = 0;
1094         }
1095
1096 ### Managing tokens
1097
1098 The current token is initialized to line up with the first character
1099 that we 'get' for each token.  When we have, or might have, a full
1100 token we can call `close_token` to set the `len` of the token
1101 appropriately.  This can safely be called multiple times.
1102
1103 Finally we occasionally (for single-line strings and block comments)
1104 need to reset to the beginning of the current token as we might have
1105 parsed too much already.  For that there is `reset_token`.
1106
1107 ###### one token
1108         tk.node = state->node;
1109         if (state->node)
1110                 tk.txt.txt = state->node->code.txt + state->offset;
1111         tk.line = state->line;
1112         tk.col = state->col;
1113         tk.txt.len = 0;
1114
1115 ###### internal functions
1116
1117         static void close_token(struct token_state *state,
1118                                 struct token *tk)
1119         {
1120                 if (state->node != tk->node)
1121                         tk->txt.len = tk->node->code.len - (tk->txt.txt - tk->node->code.txt);
1122                 else
1123                         tk->txt.len = (state->node->code.txt + state->offset)
1124                                       - tk->txt.txt;
1125         }
1126
1127         static void reset_token(struct token_state *state, struct token *tok)
1128         {
1129                 state->prev_line = tok->line;
1130                 state->prev_col = tok->col;
1131                 state->prev_offset = tok->txt.txt - state->node->code.txt;
1132                 unget_char(state);
1133                 tok->txt.len = 0;
1134         }
1135
1136 Tokens may not cross into the next `code_node`, and some tokens can
1137 include the newline at the and of a `code_node`, we must be able to
1138 easily check if we have reached the end.  Equally we need to know if
1139 we are at the start of a node, as white space is treated a little
1140 differently there.
1141
1142 ###### internal functions
1143
1144         static int at_son(struct token_state *state)
1145         {
1146                 return state->prev_offset <= state->strip_offset;
1147         }
1148
1149         static int at_eon(struct token_state *state)
1150         {
1151                 // at end-of-node ??
1152                 return state->node == NULL ||
1153                        state->offset >= state->node->code.len;
1154         }
1155
1156 ### Find a known word
1157
1158 As the known-word list is sorted we can use a simple binary search.
1159 Following the pattern established in "mdcode", we will use a `struct
1160 text` with start and length to represent the code fragment we are
1161 searching for.
1162
1163 ###### internal functions
1164         static int find_known(struct token_config *conf, struct text txt)
1165         {
1166                 int lo = 0;
1167                 int hi = conf->known_count;
1168
1169                 while (lo + 1 < hi) {
1170                         int mid = (lo + hi) / 2;
1171                         int cmp = strncmp(conf->words_marks[mid],
1172                                           txt.txt, txt.len);
1173                         if (cmp == 0 && conf->words_marks[mid][txt.len])
1174                                 cmp = 1;
1175                         if (cmp <= 0)
1176                                 lo = mid;
1177                         else
1178                                 hi = mid;
1179                 }
1180                 if (strncmp(conf->words_marks[lo],
1181                            txt.txt, txt.len) == 0
1182                     && conf->words_marks[lo][txt.len] == 0)
1183                         return lo;
1184                 else
1185                         return -1;
1186         }
1187
1188 ### Bringing it all together
1189
1190 Now we have all the bits there is just one section missing:  combining
1191 all the token parsing code into one block.
1192
1193 The handling of delayed tokens (Newlines, INs, OUTs) must come
1194 first before we try getting another character.
1195
1196 Then we parse all the test, making sure that we check for known marks
1197 before strings and comments, but unknown marks after strings and comments.
1198
1199 This block of code will either return a token, or will choose to
1200 ignore one, in which case it will `continue` around to the top of the
1201 loop.
1202
1203 ###### one token
1204         ## delayed tokens
1205
1206         ch = get_char(state);
1207
1208         ## white space
1209         ## parse number
1210         ## parse word
1211         ## parse mark
1212
1213 ### Start and stop
1214
1215 As well as getting tokens, we need to be able to create the
1216 `token_state` to start with, and discard it later.
1217
1218 ###### includes
1219         #include <malloc.h>
1220
1221 ###### main functions
1222         struct token_state *token_open(struct code_node *code, struct
1223                                        token_config *conf)
1224         {
1225                 struct token_state *state = malloc(sizeof(*state));
1226                 memset(state, 0, sizeof(*state));
1227                 state->node = code;
1228                 state->line = code->line_no;
1229                 do_strip(state);
1230                 state->col = state->node->needs_strip;
1231                 state->strip_offset = state->offset;
1232                 state->conf = conf;
1233                 return state;
1234         }
1235         void token_close(struct token_state *state)
1236         {
1237                 free(state);
1238         }
1239
1240 ###### exported functions
1241         struct token_state *token_open(struct code_node *code, struct
1242                                        token_config *conf);
1243         void token_close(struct token_state *state);
1244
1245 ### Trace tokens
1246
1247 Getting tokens is the main thing but it is also useful to be able to
1248 print out token information, particularly for tracing and testing.
1249
1250 Known tokens are printed verbatim.  Other tokens are printed as
1251 `type(content)` where content is truncated to a given number of characters.
1252
1253 The function for printing a truncated string (`text_dump`) is also exported
1254 so that it can be used to tracing processed strings too.
1255
1256 ###### includes
1257         #include <stdio.h>
1258
1259 ###### exported functions
1260         void token_trace(FILE *f, struct token tok, int max);
1261         void text_dump(FILE *f, struct text t, int max);
1262
1263 ###### main functions
1264
1265         void text_dump(FILE *f, struct text txt, int max)
1266         {
1267                 int i;
1268                 if (txt.len > max)
1269                         max -= 2;
1270                 else
1271                         max = txt.len;
1272                 for (i = 0; i < max; i++) {
1273                         char c = txt.txt[i];
1274                         if (c < ' ' || c > '~')
1275                                 fprintf(f, "\\x%02x", c & 0xff);
1276                         else if (c == '\\')
1277                                 fprintf(f, "\\\\");
1278                         else
1279                                 fprintf(f, "%c", c);
1280                 }
1281                 if (i < txt.len)
1282                         fprintf(f, "..");
1283         }
1284
1285         void token_trace(FILE *f, struct token tok, int max)
1286         {
1287                 static char *types[] = {
1288                         [TK_ident] = "ident",
1289                         [TK_mark] = "mark",
1290                         [TK_number] = "number",
1291                         [TK_string] = "string",
1292                         [TK_multi_string] = "mstring",
1293                         [TK_line_comment] = "lcomment",
1294                         [TK_block_comment] = "bcomment",
1295                         [TK_in] = "in",
1296                         [TK_out] = "out",
1297                         [TK_newline] = "newline",
1298                         [TK_eof] = "eof",
1299                         [TK_error] = "ERROR",
1300                         };
1301
1302                 switch (tok.num) {
1303                 default: /* known word or mark */
1304                         fprintf(f, "%.*s", tok.txt.len, tok.txt.txt);
1305                         break;
1306                 case TK_in:
1307                 case TK_out:
1308                 case TK_newline:
1309                 case TK_eof:
1310                         /* No token text included */
1311                         fprintf(f, "%s()", types[tok.num]);
1312                         break;
1313                 case TK_ident:
1314                 case TK_mark:
1315                 case TK_number:
1316                 case TK_string:
1317                 case TK_multi_string:
1318                 case TK_line_comment:
1319                 case TK_block_comment:
1320                 case TK_error:
1321                         fprintf(f, "%s(", types[tok.num]);
1322                         text_dump(f, tok.txt, max);
1323                         fprintf(f, ")");
1324                         break;
1325                 }
1326         }
1327
1328 ### And there we have it
1329
1330 We now have all the library functions defined for reading and printing
1331 tokens.  Now we just need C files to store them, and a mk file to make them.
1332
1333 ###### File: scanner.h
1334         ## public types
1335         ## exported functions
1336
1337 ###### File: libscanner.c
1338         ## includes
1339         #include "scanner.h"
1340         ## private types
1341         ## internal functions
1342         ## main functions
1343
1344 ###### File: scanner.mk
1345
1346         CFLAGS += -Wall -g
1347         all ::
1348         scanner.mk scanner.h libscanner.c : scanner.mdc
1349                 ./md2c scanner.mdc
1350         all :: libscanner.o
1351         libscanner.o : libscanner.c
1352                 $(CC) $(CFLAGS) -c libscanner.c
1353
1354 ## Processing numbers
1355
1356 Converting a `TK_number` token to a numerical value is a slightly
1357 higher level task than lexical analysis, and slightly lower than
1358 grammar parsing, so put it here - as an appendix if you like.
1359
1360 Importantly it will be used by the same testing rig that is used for
1361 testing the token scanner.
1362
1363 The numeric value that we will convert all numbers into is the `mpq_t`
1364 from the GNU high precision number library "libgmp".
1365
1366 ###### number includes
1367         #include <gmp.h>
1368         #include "mdcode.h"
1369
1370 Firstly we need to be able to parse a string of digits in a given base
1371 and possibly with a decimal marker.  We store this in an `mpz_t`
1372 integer and report the number of digits after the decimal mark.
1373
1374 On error we return zero and ensure that the 'mpz_t' has been freed, or
1375 had never been initialised.
1376
1377 ###### number functions
1378
1379         static int parse_digits(mpz_t num, struct text tok, int base,
1380                                 int *placesp)
1381         {
1382                 /* Accept digits up to 'base', ignore '_' and
1383                  * (for base 10) ' ' if they appear between two
1384                  * legal digits, and if `placesp` is not NULL,
1385                  * allow a single '.' or ',' and report the number
1386                  * of digits beyond there.
1387                  * Return number of characters processed (p),
1388                  * or 0 if something illegal was found.
1389                  */
1390                 int p;
1391                 int decimal = -1; // digits after marker
1392                 enum {Digit, Space, Other} prev = Other;
1393                 int digits = 0;
1394
1395                 for (p = 0; p < tok.len; p++) {
1396                         int dig;
1397                         char c = tok.txt[p];
1398
1399                         if (c == '_' || (c == ' ' && base == 10)) {
1400                                 if (prev != Digit)
1401                                         goto bad;
1402                                 prev = Space;
1403                                 continue;
1404                         }
1405                         if (c == '.' || c == ',') {
1406                                 if (prev != Digit)
1407                                         goto bad;
1408                                 if (!placesp || decimal >= 0)
1409                                         return p-1;
1410                                 decimal = 0;
1411                                 prev = Other;
1412                                 continue;
1413                         }
1414                         if (isdigit(c))
1415                                 dig = c - '0';
1416                         else if (isupper(c))
1417                                 dig = 10 + c - 'A';
1418                         else if (islower(c))
1419                                 dig = 10 + c - 'a';
1420                         else
1421                                 dig = base;
1422                         if (dig >= base) {
1423                                 if (prev == Space)
1424                                         p--;
1425                                 break;
1426                         }
1427                         prev = Digit;
1428                         if (digits)
1429                                 mpz_mul_ui(num, num, base);
1430                         else
1431                                 mpz_init(num);
1432                         digits += 1;
1433                         mpz_add_ui(num, num, dig);
1434                         if (decimal >= 0)
1435                                 decimal++;
1436                 }
1437                 if (digits == 0)
1438                         return 0;
1439                 if (placesp) {
1440                         if (decimal >= 0)
1441                                 *placesp = decimal;
1442                         else
1443                                 *placesp = 0;
1444                 }
1445                 return p;
1446         bad:
1447                 if (digits)
1448                         mpz_clear(num);
1449                 return 0;
1450         }
1451
1452 ###### number includes
1453         #include <ctype.h>
1454
1455 To parse a full number we need to consider the optional base, the
1456 mantissa, and the optional exponent.  We will treat these one at a
1457 time.
1458
1459 The base is indicated by a letter after a leading zero, which must be
1460 followed by a base letter or a period.  The base also determines the
1461 character which will mark an exponent.
1462
1463 ###### number vars
1464         int base = 10;
1465         char expc = 'e';
1466
1467 ###### parse base
1468
1469         if (tok.txt[0] == '0' && tok.len > 1) {
1470                 int skip = 0;
1471                 switch(tok.txt[1]) {
1472                 case 'x':
1473                 case 'X':
1474                         base = 16;
1475                         skip = 2;
1476                         expc = 'p';
1477                         break;
1478                 case 'o':
1479                 case 'O':
1480                         base = 8;
1481                         skip = 2;
1482                         expc = 'p';
1483                         break;
1484                 case 'b':
1485                 case 'B':
1486                         base = 2;
1487                         skip = 2;
1488                         expc = 'p';
1489                         break;
1490                 case '0':
1491                 case '1':
1492                 case '2':
1493                 case '3':
1494                 case '4':
1495                 case '5':
1496                 case '6':
1497                 case '7':
1498                 case '8':
1499                 case '9':
1500                 case '_':
1501                 case ' ':
1502                         // another digit is not permitted
1503                         // after a zero.
1504                         return 0;
1505                 default:
1506                         // must be decimal marker or trailing
1507                         // letter, which are OK;
1508                         break;
1509                 }
1510                 tok.txt += skip;
1511                 tok.len -= skip;
1512         }
1513
1514 After the base is the mantissa, which may contain a decimal mark, so
1515 we need to record the number of places.  We won't impose the number of
1516 places until we have the exponent as well.
1517
1518 ###### number vars
1519         int places = 0;
1520         mpz_t mant;
1521         int d;
1522
1523 ###### parse mantissa
1524
1525         d = parse_digits(mant, tok, base, &places);
1526         if (d == 0)
1527                 return 0;
1528         tok.txt += d;
1529         tok.len -= d;
1530         mpq_init(num);
1531         mpq_set_z(num, mant);
1532         mpz_clear(mant);
1533
1534 After the mantissa number may come an exponent which may be positive
1535 or negative.  We assume at this point that we have seen the exponent
1536 character `expc`.
1537
1538 ###### number vars
1539         long lexp = 0;
1540         mpz_t exp;
1541         int esign = 1;
1542
1543 ###### parse exponent
1544         if (tok.len > 1) {
1545                 if (tok.txt[0] == '+') {
1546                         tok.txt++;
1547                         tok.len--;
1548                 } else if (tok.txt[0] == '-') {
1549                         esign = -1;
1550                         tok.txt++;
1551                         tok.len--;
1552                 }
1553         }
1554         d = parse_digits(exp, tok, 10, NULL);
1555         if (d == 0) {
1556                 mpq_clear(num);
1557                 return 0;
1558         }
1559         if (!mpz_fits_slong_p(exp)) {
1560                 mpq_clear(num);
1561                 mpz_clear(exp);
1562                 return 0;
1563         }
1564         lexp = mpz_get_si(exp) * esign;
1565         mpz_clear(exp);
1566         tok.txt += d;
1567         tok.len -= d;
1568
1569 Now that we have the mantissa and the exponent we can multiply them
1570 together, also allowing for the number of digits after the decimal
1571 mark.
1572
1573 For base 10, we simply subtract the decimal places from the exponent.
1574 For the other bases, as the exponent is alway based on 2, even for
1575 octal and hex, we need a bit more detail.
1576 We then recover the sign from the exponent, as division is quite
1577 different from multiplication.
1578
1579 ###### calc exponent
1580         switch (base) {
1581         case 10:
1582         case 2:
1583                 lexp -= places;
1584                 break;
1585         case 16:
1586                 lexp -= 4*places;
1587                 break;
1588         case 8:
1589                 lexp -= 3*places;
1590                 break;
1591         }
1592         if (lexp < 0) {
1593                 lexp = -lexp;
1594                 esign = -1;
1595         } else
1596                 esign = 1;
1597
1598 Imposing the exponent on the number is also very different for base 10
1599 than for the others.  For the binary shift `gmp` provides a simple
1600 function.  For base 10 we use something like Russian Peasant
1601 Multiplication.
1602
1603 ###### calc exponent
1604         if (expc == 'e') {
1605                 mpq_t tens;
1606                 mpq_init(tens);
1607                 mpq_set_ui(tens, 10, 1);
1608                 while (1) {
1609                         if (lexp & 1) {
1610                                 if (esign > 0)
1611                                         mpq_mul(num, num, tens);
1612                                 else
1613                                         mpq_div(num, num, tens);
1614                         }
1615                         lexp >>= 1;
1616                         if (lexp == 0)
1617                                 break;
1618                         mpq_mul(tens, tens, tens);
1619                 }
1620                 mpq_clear(tens);
1621         } else {
1622                 if (esign > 0)
1623                         mpq_mul_2exp(num, num, lexp);
1624                 else
1625                         mpq_div_2exp(num, num, lexp);
1626         }
1627
1628 Now we are ready to parse a number: the base, mantissa, and exponent.
1629 If all goes well we check for the possible trailing letters and
1630 return.  Return value is 1 for success and 0 for failure.
1631
1632 ###### number functions
1633         int number_parse(mpq_t num, char tail[3], struct text tok)
1634         {
1635                 ## number vars
1636                 int i;
1637
1638                 ## parse base
1639                 ## parse mantissa
1640                 if (tok.len > 1 && (tok.txt[0] == expc ||
1641                                     tok.txt[0] == toupper(expc))) {
1642                         tok.txt++;
1643                         tok.len--;
1644                         ## parse exponent
1645                 }
1646                 ## calc exponent
1647
1648                 for (i = 0; i < 2; i++) {
1649                         if (tok.len <= i)
1650                                 break;
1651                         if (!isalpha(tok.txt[i]))
1652                                 goto err;
1653                         tail[i] = tok.txt[i];
1654                 }
1655                 tail[i] = 0;
1656                 if (i == tok.len)
1657                         return 1;
1658         err:
1659                 mpq_clear(num);
1660                 return 0;
1661         }
1662
1663 Number parsing goes in `libnumber.c`
1664
1665 ###### File: libnumber.c
1666
1667         #include <unistd.h>
1668         #include <stdlib.h>
1669
1670         ## number includes
1671         ## number functions
1672
1673 ###### File: parse_number.h
1674         int number_parse(mpq_t num, char tail[3], struct text tok);
1675
1676 ###### File: scanner.mk
1677         all :: libnumber.o
1678         libnumber.o : libnumber.c
1679                 $(CC) $(CFLAGS) -c libnumber.c
1680
1681 ## Processing strings
1682
1683 Both `TK_string` and `TK_multi_string` require post-processing which
1684 can be one of two types: literal or with escapes processed.
1685 Even literal processing is non-trivial as the file may contain indents
1686 which need to be stripped.
1687
1688 Errors can only occur when processing escapes.  Any unrecognised
1689 character following the escape character will cause an error.
1690
1691 Processing escapes and striping indents can only make the string
1692 shorter, not longer, so we allocate a buffer which is the same size as
1693 the string and process into that.
1694
1695 To request escape processing, we pass the character we want to use for
1696 quoting, usually '`\`'.  To avoid escape processing we pass a zero.
1697
1698 ###### string main
1699         int string_parse(struct token *tok, char escape,
1700                          struct text *str, char tail[3])
1701         {
1702                 ## string vars
1703                 struct text t = tok->txt;
1704
1705                 str->txt = NULL;
1706                 ## strip tail
1707                 if (tok->num == TK_string) {
1708                         ## strip single
1709                 } else {
1710                         ## strip multi
1711                 }
1712                 str->txt = malloc(t.len);
1713                 str->len = 0;
1714
1715                 ## process string
1716                 return 1;
1717         err:
1718                 free(str->txt);
1719                 str->txt = NULL;
1720                 return 0;
1721         }
1722
1723 ### strip tail
1724
1725 The tail of the string can be 0, 1, or 2 letters
1726
1727         i = t.len;
1728         if (i >= 0 && isalpha(t.txt[i-1]))
1729                 i -= 1;
1730         if (i >= 0 && isalpha(t.txt[i-1]))
1731                 i -= 1;
1732         strncpy(tail, t.txt+i, t.len-i);
1733         tail[t.len-i] = 0;
1734         t.len = i;
1735
1736 ###### string vars
1737         int i;
1738
1739 ### strip single
1740
1741 Stripping the quote of a single-line string is trivial.
1742 The only part that is at all interesting is that quote character must
1743 be remembered.
1744
1745         quote = t.txt[0];
1746         if (t.txt[t.len-1] != quote)
1747                 goto err;
1748         t.txt += 1;
1749         t.len -= 2;
1750
1751 ###### string vars
1752         char quote;
1753
1754 ### strip multi
1755
1756 For a multi-line string we have a little more work to do.  We need to
1757 remove 3 quotes, not 1, and need to count the indent of the close
1758 quote as it will need to be stripped from all lines.
1759
1760         quote = t.txt[0];
1761         if (t.len < 7 ||
1762             t.txt[1] != quote || t.txt[2] != quote ||
1763             !is_newline(t.txt[3]))
1764                 goto err;
1765         t.txt += 4;
1766         t.len -= 4;
1767         i = t.len;
1768         if (i <= 0 || t.txt[i-1] != quote)
1769                 goto err;
1770         i -= 1;
1771         if (i <= 0 || t.txt[i-1] != quote)
1772                 goto err;
1773         i -= 1;
1774         if (i <= 0 || t.txt[i-1] != quote)
1775                 goto err;
1776         i -= 1;
1777         t.len = i;
1778         while (i > 0 && !is_newline(t.txt[i-1]))
1779                 i--;
1780         indent = 0;
1781         while (i < t.len) {
1782                 if (t.txt[i] == ' ')
1783                         indent += 1;
1784                 if (t.txt[i] == '\t')
1785                         indent = indent_tab(indent);
1786                 i++;
1787         }
1788
1789 ###### string vars
1790         int indent = 0;
1791
1792 ### process string
1793
1794 Now we just take one byte at a time. trans-ASCII unicode won't look
1795 like anything we are interested in so it will just be copied byte by
1796 byte.
1797
1798         cp = str->txt;
1799         at_sol = 1;
1800         for (i = 0; i < t.len; i++) {
1801                 char c;
1802                 if (at_sol) {
1803                         at_sol = 0;
1804                         ## strip indent
1805                         if (i >= t.len)
1806                                 break;
1807                 }
1808                 c = t.txt[i];
1809                 if (c != escape) {
1810                         *cp = c;
1811                         cp += 1;
1812                         if (is_newline(c))
1813                                 at_sol = 1;
1814                 } else if (i+1 >= t.len) {
1815                         // escape and end of string
1816                         goto err;
1817                 } else {
1818                         i += 1;
1819                         c = t.txt[i];
1820                         ## parse escape
1821                 }
1822         }
1823         str->len = cp - str->txt;
1824
1825 ###### string vars
1826         char *cp;
1827         int at_sol;
1828
1829 ### strip indent
1830
1831 Every time we find a start of line, we strip spaces and tabs until the
1832 required indent is found.
1833
1834         int skipped = 0;
1835         while (i < t.len && skipped < indent) {
1836                 c = t.txt[i];
1837                 if (c == ' ')
1838                         skipped += 1;
1839                 else if (c == '\t')
1840                         skipped = indent_tab(skipped);
1841                 else
1842                         break;
1843                 i+= 1;
1844         }
1845
1846 ### parse escape
1847         switch (c) {
1848         case 'n':
1849                 *cp++ = '\n'; break;
1850         case 'r':
1851                 *cp++ = '\r'; break;
1852         case 't':
1853                 *cp++ = '\t'; break;
1854         case 'b':
1855                 *cp++ = '\b'; break;
1856         case 'q':
1857                 *cp++ = quote; break;
1858         case 'f':
1859                 *cp++ = '\f'; break;
1860         case 'v':
1861                 *cp++ = '\v'; break;
1862         case 'a':
1863                 *cp++ = '\a'; break;
1864         case '0':
1865         case '1':
1866         case '2':
1867         case '3':
1868                 // 3 digit octal number
1869                 if (i+2 >= t.len)
1870                         goto err;
1871                 if (t.txt[i+1] < '0' || t.txt[i+1] > '7' ||
1872                     t.txt[i+2] < '0' || t.txt[i+1] > '7')
1873                         goto err;
1874                 n = (t.txt[i  ]-'0') * 64 +
1875                     (t.txt[i+1]-'0') *  8 +
1876                     (t.txt[i+2]-'0') *  1;
1877                 *cp++ = n;
1878                 i += 2;
1879                 break;
1880         case 'x':
1881                 // 2 hex digits
1882                 n = take_hex(2, t.txt+i+1, t.len-i-1);
1883                 if (n < 0)
1884                         goto err;
1885                 *cp++ = n;
1886                 i += 2;
1887                 break;
1888         case 'u':
1889         case 'U':
1890                 // 4 or 8 hex digits for unicode
1891                 n = take_hex(c == 'u'?4:8, t.txt+i+1, t.len-i-1);
1892                 if (n < 0)
1893                         goto err;
1894                 memset(&pstate, 0, sizeof(pstate));
1895                 n = wcrtomb(cp, n, &pstate);
1896                 if (n <= 0)
1897                         goto err;
1898                 cp += n;
1899                 i += c == 'u' ? 4 : 8;
1900                 break;
1901         default:
1902                 if (c == escape)
1903                         *cp++ = c;
1904                 else if (is_newline(c))
1905                         at_sol = 1;
1906                 else
1907                         goto err;
1908         }
1909
1910 ###### string vars
1911         long n;
1912         mbstate_t pstate;
1913
1914 For `\x` `\u` and `\U` we need to collect a specific number of
1915 hexadecimal digits
1916
1917 ###### string functions
1918
1919         static long take_hex(int digits, char *cp, int l)
1920         {
1921                 long n = 0;
1922                 if (l < digits)
1923                         return -1;
1924                 while (digits) {
1925                         char  c = *cp;
1926                         int d;
1927                         if (!isxdigit(c))
1928                                 return -1;
1929                         if (isdigit(c))
1930                                 d = c - '0';
1931                         else if (isupper(c))
1932                                 d = 10 + c - 'A';
1933                         else
1934                                 d = 10 + c - 'a';
1935                         n = n * 16 + d;
1936                         digits--;
1937                         cp++;
1938                 }
1939                 return n;
1940         }
1941
1942 #### File: libstring.c
1943
1944 String parsing goes in `libstring.c`
1945
1946         #include <unistd.h>
1947         #include <stdlib.h>
1948         #include <stdio.h>
1949         #include <string.h>
1950         #include <ctype.h>
1951         #include <wchar.h>
1952         #include "mdcode.h"
1953         #include "scanner.h"
1954         ## string functions
1955         ## string main
1956
1957 ###### File: parse_string.h
1958         int string_parse(struct token *tok, char escape,
1959                          struct text *str, char tail[3]);
1960
1961 ###### File: scanner.mk
1962         all :: libstring.o
1963         libstring.o : libstring.c
1964                 $(CC) $(CFLAGS) -c libstring.c
1965
1966 ## Testing
1967
1968 As "untested code is buggy code" we need a program to easily test
1969 the scanner library.  This will simply parse a given file and report
1970 the tokens one per line.
1971
1972 ###### File: scanner.c
1973
1974         #include <unistd.h>
1975         #include <stdlib.h>
1976         #include <fcntl.h>
1977         #include <errno.h>
1978         #include <sys/mman.h>
1979         #include <string.h>
1980         #include <stdio.h>
1981         #include <gmp.h>
1982         #include <locale.h>
1983         #include <getopt.h>
1984         #include "mdcode.h"
1985         #include "scanner.h"
1986         #include "parse_number.h"
1987         #include "parse_string.h"
1988
1989         static int errs;
1990         static void pr_err(char *msg)
1991         {
1992                 errs++;
1993                 fprintf(stderr, "%s\n", msg);
1994         }
1995
1996         static int kcmp(const void *ap, const void *bp)
1997         {
1998                 char * const *a = ap;
1999                 char * const *b = bp;
2000                 return strcmp(*a, *b);
2001         }
2002
2003         int main(int argc, char *argv[])
2004         {
2005                 int fd;
2006                 int len;
2007                 char *file;
2008                 char *filename = NULL;
2009                 struct token_state *state;
2010                 const char *known[] = {
2011                         "==",
2012                         "else",
2013                         "if",
2014                         "then",
2015                         "while",
2016                         "{",
2017                         "}",
2018                 };
2019                 struct token_config conf = {
2020                         .word_start = "_$",
2021                         .word_cont = "",
2022                         .words_marks = known,
2023                         .number_chars = "., _+-",
2024                         .known_count = sizeof(known)/sizeof(known[0]),
2025                         .ignored = 0,
2026                 };
2027                 static const struct option long_options[] = {
2028                         { "word-start",         1, NULL, 'W'},
2029                         { "word-cont",          1, NULL, 'w'},
2030                         { "number-chars",       1, NULL, 'n'},
2031                         { "ignore-numbers",     0, NULL, 'N'},
2032                         { "ignore-ident",       0, NULL, 'I'},
2033                         { "ignore-marks",       0, NULL, 'M'},
2034                         { "ignore-strings",     0, NULL, 'S'},
2035                         { "ignore-multi-strings",0, NULL, 'z'},
2036                         { "ignore-line-comment",0, NULL, 'c'},
2037                         { "ignore-newline",     0, NULL, 'l'},
2038                         { "ignore-block-comment", 0, NULL, 'C'},
2039                         { "ignore-indent",      0, NULL, 'i'},
2040                         { "file",               1, NULL, 'f'},
2041                         { "section",            1, NULL, 's'},
2042                         { NULL,                 0, NULL, 0},
2043                 };
2044                 static const char options[] = "W:w:n:NIMSzclCif:s:";
2045
2046                 struct section *table, *s, *prev;
2047                 int opt;
2048                 char *section_name = NULL;
2049                 int section_found = 0;
2050
2051                 setlocale(LC_ALL,"");
2052                 while ((opt = getopt_long(argc, argv, options, long_options, NULL))
2053                        != -1) {
2054                         switch(opt) {
2055                         case 'W': conf.word_start = optarg; break;
2056                         case 'w': conf.word_cont = optarg; break;
2057                         case 'n': conf.number_chars = optarg; break;
2058                         case 'N': conf.ignored |= 1 << TK_number; break;
2059                         case 'I': conf.ignored |= 1 << TK_ident; break;
2060                         case 'M': conf.ignored |= 1 << TK_mark; break;
2061                         case 'S': conf.ignored |= 1 << TK_string; break;
2062                         case 'z': conf.ignored |= 1 << TK_multi_string; break;
2063                         case 'c': conf.ignored |= 1 << TK_line_comment; break;
2064                         case 'C': conf.ignored |= 1 << TK_block_comment; break;
2065                         case 'l': conf.ignored |= 1 << TK_newline; break;
2066                         case 'i': conf.ignored |= 1 << TK_in; break;
2067                         case 'f': filename = optarg; break;
2068                         case 's': section_name = optarg; break;
2069                         default: fprintf(stderr, "scanner: unknown option '%c'.\n",
2070                                          opt);
2071                                 exit(1);
2072                         }
2073                 }
2074
2075                 if (optind < argc) {
2076                         const char **wm = calloc(argc - optind, sizeof(char*));
2077                         int i;
2078                         for (i = optind; i < argc; i++)
2079                                 wm[i - optind] = argv[i];
2080                         qsort(wm, argc-optind, sizeof(char*), kcmp);
2081                         conf.words_marks = wm;
2082                         conf.known_count = argc - optind;
2083                 }
2084
2085                 if (filename)
2086                         fd = open(filename, O_RDONLY);
2087                 else
2088                         fd = 0;
2089                 if (fd < 0) {
2090                         fprintf(stderr, "scanner: cannot open %s: %s\n",
2091                                 filename, strerror(errno));
2092                         exit(1);
2093                 }
2094                 len = lseek(fd, 0, 2);
2095                 if (len <= 0) {
2096                         fprintf(stderr,"scanner: %s is empty or not seekable\n",
2097                                 filename ?: "stdin");
2098                         exit(1);
2099                 }
2100                 file = mmap(NULL, len, PROT_READ, MAP_SHARED, fd, 0);
2101                 table = code_extract(file, file+len, pr_err);
2102
2103                 for (s = table; s;
2104                         (code_free(s->code), prev = s, s = s->next, free(prev))) {
2105                         if (section_name &&
2106                             (s->section.len != strlen(section_name) ||
2107                              strncmp(s->section.txt, section_name, s->section.len) != 0))
2108                                 continue;
2109                         if (section_name)
2110                                 section_found = 1;
2111                         printf("Tokenizing: %.*s\n", s->section.len,
2112                                 s->section.txt);
2113                         state = token_open(s->code, &conf);
2114                         while(1) {
2115                                 struct token tk = token_next(state);
2116                                 printf("%d:%d ", tk.line, tk.col);
2117                                 token_trace(stdout, tk, 20);
2118                                 if (tk.num == TK_number) {
2119                                         mpq_t num;
2120                                         char tail[3];
2121                                         if (number_parse(num, tail,tk.txt)) {
2122                                                 printf(" %s ", tail);
2123                                                 mpq_out_str(stdout, 10, num);
2124                                                 mpq_clear(num);
2125                                         } else
2126                                                 printf(" BAD NUMBER");
2127                                 }
2128                                 if (tk.num == TK_string ||
2129                                     tk.num == TK_multi_string) {
2130                                         char esc = '\\';
2131                                         struct text str;
2132                                         char tail[3];
2133                                         if (tk.txt.txt[0] == '`')
2134                                                 esc = 0;
2135                                         if (string_parse(&tk, esc,
2136                                                          &str, tail)) {
2137                                                 printf(" %s ", tail);
2138                                                 text_dump(stdout, str, 20);
2139                                                 free(str.txt);
2140                                         } else
2141                                                 printf(" BAD STRING");
2142                                 }
2143                                 printf("\n");
2144                                 if (tk.num == TK_error)
2145                                         errs = 1;
2146                                 if (tk.num == TK_eof)
2147                                         break;
2148                         }
2149                         token_close(state);
2150                 }
2151                 if (conf.words_marks != known)
2152                         free(conf.words_marks);
2153                 if (section_name && !section_found) {
2154                         fprintf(stderr, "scanner: section %s not found\n", section_name);
2155                         errs = 1;
2156                 }
2157                 exit(!!errs);
2158         }
2159 ###### File: scanner.mk
2160         scanner.c : scanner.mdc
2161                 ./md2c scanner.mdc
2162         all :: scanner
2163         scanner : scanner.o scanner.h libscanner.o libmdcode.o mdcode.h
2164                 $(CC) $(CFLAGS) -o scanner scanner.o libscanner.o \
2165                         libmdcode.o libnumber.o libstring.o -licuuc -lgmp
2166         scanner.o : scanner.c
2167                 $(CC) $(CFLAGS) -c scanner.c