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) || (at_son(state) && ch <= ' ')) {
 811                 int newlines = 0;
 812                 int was_son = at_son(state);
 813                 if (ignored & (1<<TK_in)) {
 814                         if (!is_newline(ch))
 815                                 continue;
 816                         if (ignored & (1<<TK_newline))
 817                                 continue;
 818                         tk.num = TK_newline;
 819                         close_token(state, &tk);
 820                         return tk;
 821                 }
 822                 // Indents are needed, so check all white space.
 823                 while (ch <= ' ' && !at_eon(state)) {
 824                         if (is_newline(ch))
 825                                 newlines += 1;
 826                         ch = get_char(state);
 827                 }
 828                 if (at_eon(state)) {
 829                         newlines += 1;
 830                 } else
 831                         unget_char(state);
 832                 state->delayed_lines = newlines;
 833                 state->out_next = was_son;
 834                 state->check_indent = 1;
 835                 continue;
 836         }
 837
 838 ###### delayed tokens
 839
 840         if (state->check_indent || state->delayed_lines) {
 841                 if (state_indent(state) < state->indent_sizes[state->indent_level]) {
 842                         if (!state->out_next &&
 843                             !(ignored & (1<<TK_newline))) {
 844                                 state->out_next = 1;
 845                                 tk.num = TK_newline;
 846                                 return tk;
 847                         }
 848                         state->indent_level -= 1;
 849                         state->out_next = 0;
 850                         tk.num = TK_out;
 851                         return tk;
 852                 }
 853                 if (state_indent(state) > state->indent_sizes[state->indent_level] &&
 854                     state->indent_level < sizeof(state->indent_sizes)-1) {
 855                         state->indent_level += 1;
 856                         state->indent_sizes[state->indent_level] = state_indent(state);
 857                         if (state->delayed_lines)
 858                                 state->delayed_lines -= 1;
 859                         tk.num = TK_in;
 860                         return tk;
 861                 }
 862                 state->check_indent = 0;
 863                 if (state->delayed_lines && !(ignored & (1<<TK_newline))) {
 864                         tk.num = TK_newline;
 865                         state->delayed_lines -= 1;
 866                         return tk;
 867                 }
 868                 state->delayed_lines = 0;
 869                 continue;
 870         }
 871
 872 ### End of File
 873
 874 After the last newline in the file has been processed, a special
 875 end-of-file token will be returned.  any further attempts to get more
 876 tokens will continue to return the same end-of-file token.
 877
 878 ###### token types
 879         TK_eof,
 880
 881 ###### white space
 882         if (ch == WEOF) {
 883                 if (state->col) {
 884                         state->col = 0;
 885                         state->check_indent = 1;
 886                         continue;
 887                 }
 888                 tk.num = TK_eof;
 889                 return tk;
 890         }
 891
 892 ### Unknown Marks, or errors.
 893
 894 We have now handled all the possible known mark-like tokens.
 895 If the token we have is not empty and `TK_mark` is allowed,
 896 we have an unknown mark, otherwise this must be an error.
 897
 898 ###### unknown mark
 899
 900         /* one unknown mark character */
 901         if (tk.txt.len) {
 902                 close_token(state, &tk);
 903                 if (ignored & (1<<TK_mark))
 904                         tk.num = TK_error;
 905                 else
 906                         tk.num = TK_mark;
 907                 return tk;
 908         }
 909         /* Completely unrecognised character is next, possibly
 910          * a digit and we are ignoring numbers.
 911          * What ever it is, make it an error.
 912          */
 913         get_char(state);
 914         close_token(state, &tk);
 915         tk.num = TK_error;
 916         return tk;
 917
 918 ## Tools For The Task
 919
 920 You may have noticed that are few gaps we left in the above -
 921 functions used without first defining them.  Doing so above would have
 922 broken the flow.
 923
 924 ### Character by character
 925
 926 As we walk through the various `code_node`s we need to process whole
 927 Unicode codepoints, and keep track of which line and column we are on.
 928 We will assume for now that any printing character uses one column,
 929 though that is not true in general.
 930
 931 As the text in a `code_node` may include an indent that identifies it as
 932 being code, we need to be careful to strip that.  The `code_node` has
 933 a flag that tells us whether or not we need to strip.
 934
 935 ###### includes
 936         #include <memory.h>
 937
 938 ###### state fields
 939         struct code_node *node;
 940         int    offset;
 941         int    line;
 942         int    col;
 943         int    strip_offset;
 944
 945 ###### internal functions
 946
 947         static void do_strip(struct token_state *state)
 948         {
 949                 int indent = 0;
 950                 if (state->node->needs_strip) {
 951                         int n = 4;
 952                         while (n && state->node->code.txt[state->offset] == ' ') {
 953                                 indent += 1;
 954                                 state->offset += 1;
 955                                 n -= 1;
 956                         }
 957                         while (n == 4 && state->node->code.txt[state->offset] == '\t') {
 958                                 indent = indent_tab(indent);
 959                                 state->offset += 1;
 960                                 n -= 4;
 961                         }
 962                 }
 963         }
 964
 965         static wint_t get_char(struct token_state *state)
 966         {
 967                 wchar_t next;
 968                 size_t n;
 969                 mbstate_t mbstate;
 970
 971                 if (state->node == NULL)
 972                         return WEOF;
 973                 if (state->node->code.len <= state->offset) {
 974                         do
 975                                 state->node = state->node->next;
 976                         while (state->node && state->node->code.txt == NULL);
 977                         state->offset = 0;
 978                         if (state->node == NULL)
 979                                 return WEOF;
 980                         state->line = state->node->line_no;
 981                         do_strip(state);
 982                         state->col = state->node->needs_strip;
 983                         state->strip_offset = state->offset;
 984                 }
 985
 986                 ## before get_char
 987
 988                 memset(&mbstate, 0, sizeof(mbstate));
 989
 990                 n = mbrtowc(&next, state->node->code.txt + state->offset,
 991                             state->node->code.len - state->offset,
 992                             &mbstate);
 993                 if (n == -2 || n == 0) {
 994                         /* Not enough bytes - not really possible */
 995                         next = '\n';
 996                         state->offset = state->node->code.len;
 997                 } else if (n == -1) {
 998                         /* error */
 999                         state->offset += 1;
1000                         next = 0x7f; // an illegal character
1001                 } else
1002                         state->offset += n;
1003
1004                 if (next >= ' ') {
1005                         state->col += 1;
1006                 } else if (is_newline(next)) {
1007                         state->line += 1;
1008                         do_strip(state);
1009                         state->col = state->node->needs_strip;
1010                 } else if (next == '\t') {
1011                         state->col = indent_tab(state->col);
1012                 }
1013                 return next;
1014         }
1015
1016 We will sometimes want to "unget" the last character as it needs to be
1017 considered again as part of the next token.  So we need to store a
1018 'previous' version of all metadata.
1019
1020 ###### state fields
1021         int    prev_offset;
1022         int    prev_line;
1023         int    prev_col;
1024
1025 ###### before get_char
1026         state->prev_offset = state->offset;
1027         state->prev_line   = state->line;
1028         state->prev_col    = state->col;
1029
1030 ###### internal functions
1031
1032         static void unget_char(struct token_state *state)
1033         {
1034                 if (state->node) {
1035                         state->offset = state->prev_offset;
1036                         state->line   = state->prev_line;
1037                         state->col    = state->prev_col;
1038                 }
1039         }
1040
1041 We occasionally need a double-unget, particularly for numbers and
1042 block comments.  We don't impose this cost on all scanning, but
1043 require those code sections that need it to call `save_unget_state`
1044 before each `get_char`, and then `restore_unget_state` when a
1045 double-unget is needed.
1046
1047 ###### state fields
1048         int     prev_offset2;
1049         int     prev_line2;
1050         int     prev_col2;
1051
1052 ###### internal functions
1053         static void save_unget_state(struct token_state *state)
1054         {
1055                 state->prev_offset2 = state->prev_offset;
1056                 state->prev_line2 = state->prev_line;
1057                 state->prev_col2 = state->prev_col;
1058         }
1059
1060         static void restore_unget_state(struct token_state *state)
1061         {
1062                 state->prev_offset = state->prev_offset2;
1063                 state->prev_line = state->prev_line2;
1064                 state->prev_col = state->prev_col2;
1065         }
1066
1067 At the start of a token we don't want to be at the end of a code block
1068 if we can help it.  To avoid this possibility, we 'get' and 'unget' a
1069 single character.  This will move into the next non-empty code block
1070 and leave the current pointer at the start of it.
1071
1072 This has to happen _after_ dealing with delayed tokens as some of them
1073 must appear in the previous node.  When we do this, we need to reset
1074 the data in the token.
1075
1076 ###### delayed tokens
1077         if (at_eon(state)) {
1078                 get_char(state);
1079                 unget_char(state);
1080                 tk.node = state->node;
1081                 if (state->node)
1082                         tk.txt.txt = state->node->code.txt + state->offset;
1083                 tk.line = state->line;
1084                 tk.col = state->col;
1085                 tk.txt.len = 0;
1086         }
1087
1088 ### Managing tokens
1089
1090 The current token is initialized to line up with the first character
1091 that we 'get' for each token.  When we have, or might have, a full
1092 token we can call `close_token` to set the `len` of the token
1093 appropriately.  This can safely be called multiple times.
1094
1095 Finally we occasionally (for single-line strings and block comments)
1096 need to reset to the beginning of the current token as we might have
1097 parsed too much already.  For that there is `reset_token`.
1098
1099 ###### one token
1100         tk.node = state->node;
1101         if (state->node)
1102                 tk.txt.txt = state->node->code.txt + state->offset;
1103         tk.line = state->line;
1104         tk.col = state->col;
1105         tk.txt.len = 0;
1106
1107 ###### internal functions
1108
1109         static void close_token(struct token_state *state,
1110                                 struct token *tk)
1111         {
1112                 if (state->node != tk->node)
1113                         tk->txt.len = tk->node->code.len - (tk->txt.txt - tk->node->code.txt);
1114                 else
1115                         tk->txt.len = (state->node->code.txt + state->offset)
1116                                       - tk->txt.txt;
1117         }
1118
1119         static void reset_token(struct token_state *state, struct token *tok)
1120         {
1121                 state->prev_line = tok->line;
1122                 state->prev_col = tok->col;
1123                 state->prev_offset = tok->txt.txt - state->node->code.txt;
1124                 unget_char(state);
1125                 tok->txt.len = 0;
1126         }
1127
1128 Tokens may not cross into the next `code_node`, and some tokens can
1129 include the newline at the and of a `code_node`, we must be able to
1130 easily check if we have reached the end.  Equally we need to know if
1131 we are at the start of a node, as white space is treated a little
1132 differently there.
1133
1134 ###### internal functions
1135
1136         static int at_son(struct token_state *state)
1137         {
1138                 return state->prev_offset <= state->strip_offset;
1139         }
1140
1141         static int at_eon(struct token_state *state)
1142         {
1143                 // at end-of-node ??
1144                 return state->node == NULL ||
1145                        state->offset >= state->node->code.len;
1146         }
1147
1148 ### Find a known word
1149
1150 As the known-word list is sorted we can use a simple binary search.
1151 Following the pattern established in "mdcode", we will use a `struct
1152 text` with start and length to represent the code fragment we are
1153 searching for.
1154
1155 ###### internal functions
1156         static int find_known(struct token_config *conf, struct text txt)
1157         {
1158                 int lo = 0;
1159                 int hi = conf->known_count;
1160
1161                 while (lo + 1 < hi) {
1162                         int mid = (lo + hi) / 2;
1163                         int cmp = strncmp(conf->words_marks[mid],
1164                                           txt.txt, txt.len);
1165                         if (cmp == 0 && conf->words_marks[mid][txt.len])
1166                                 cmp = 1;
1167                         if (cmp <= 0)
1168                                 lo = mid;
1169                         else
1170                                 hi = mid;
1171                 }
1172                 if (strncmp(conf->words_marks[lo],
1173                            txt.txt, txt.len) == 0
1174                     && conf->words_marks[lo][txt.len] == 0)
1175                         return lo;
1176                 else
1177                         return -1;
1178         }
1179
1180 ### Bringing it all together
1181
1182 Now we have all the bits there is just one section missing:  combining
1183 all the token parsing code into one block.
1184
1185 The handling of delayed tokens (Newlines, INs, OUTs) must come
1186 first before we try getting another character.
1187
1188 Then we parse all the test, making sure that we check for known marks
1189 before strings and comments, but unknown marks after strings and comments.
1190
1191 This block of code will either return a token, or will choose to
1192 ignore one, in which case it will `continue` around to the top of the
1193 loop.
1194
1195 ###### one token
1196         ## delayed tokens
1197
1198         ch = get_char(state);
1199
1200         ## white space
1201         ## parse number
1202         ## parse word
1203         ## parse mark
1204
1205 ### Start and stop
1206
1207 As well as getting tokens, we need to be able to create the
1208 `token_state` to start with, and discard it later.
1209
1210 ###### includes
1211         #include <malloc.h>
1212
1213 ###### main functions
1214         struct token_state *token_open(struct code_node *code, struct
1215                                        token_config *conf)
1216         {
1217                 struct token_state *state = malloc(sizeof(*state));
1218                 memset(state, 0, sizeof(*state));
1219                 state->node = code;
1220                 state->line = code->line_no;
1221                 do_strip(state);
1222                 state->col = state->node->needs_strip;
1223                 state->strip_offset = state->offset;
1224                 state->conf = conf;
1225                 return state;
1226         }
1227         void token_close(struct token_state *state)
1228         {
1229                 free(state);
1230         }
1231
1232 ###### exported functions
1233         struct token_state *token_open(struct code_node *code, struct
1234                                        token_config *conf);
1235         void token_close(struct token_state *state);
1236
1237 ### Trace tokens
1238
1239 Getting tokens is the main thing but it is also useful to be able to
1240 print out token information, particularly for tracing and testing.
1241
1242 Known tokens are printed verbatim.  Other tokens are printed as
1243 `type(content)` where content is truncated to a given number of characters.
1244
1245 The function for printing a truncated string (`text_dump`) is also exported
1246 so that it can be used to tracing processed strings too.
1247
1248 ###### includes
1249         #include <stdio.h>
1250
1251 ###### exported functions
1252         void token_trace(FILE *f, struct token tok, int max);
1253         void text_dump(FILE *f, struct text t, int max);
1254
1255 ###### main functions
1256
1257         void text_dump(FILE *f, struct text txt, int max)
1258         {
1259                 int i;
1260                 if (txt.len > max)
1261                         max -= 2;
1262                 else
1263                         max = txt.len;
1264                 for (i = 0; i < max; i++) {
1265                         char c = txt.txt[i];
1266                         if (c < ' ' || c > '~')
1267                                 fprintf(f, "\\x%02x", c & 0xff);
1268                         else if (c == '\\')
1269                                 fprintf(f, "\\\\");
1270                         else
1271                                 fprintf(f, "%c", c);
1272                 }
1273                 if (i < txt.len)
1274                         fprintf(f, "..");
1275         }
1276
1277         void token_trace(FILE *f, struct token tok, int max)
1278         {
1279                 static char *types[] = {
1280                         [TK_ident] = "ident",
1281                         [TK_mark] = "mark",
1282                         [TK_number] = "number",
1283                         [TK_string] = "string",
1284                         [TK_multi_string] = "mstring",
1285                         [TK_line_comment] = "lcomment",
1286                         [TK_block_comment] = "bcomment",
1287                         [TK_in] = "in",
1288                         [TK_out] = "out",
1289                         [TK_newline] = "newline",
1290                         [TK_eof] = "eof",
1291                         [TK_error] = "ERROR",
1292                         };
1293
1294                 switch (tok.num) {
1295                 default: /* known word or mark */
1296                         fprintf(f, "%.*s", tok.txt.len, tok.txt.txt);
1297                         break;
1298                 case TK_in:
1299                 case TK_out:
1300                 case TK_newline:
1301                 case TK_eof:
1302                         /* No token text included */
1303                         fprintf(f, "%s()", types[tok.num]);
1304                         break;
1305                 case TK_ident:
1306                 case TK_mark:
1307                 case TK_number:
1308                 case TK_string:
1309                 case TK_multi_string:
1310                 case TK_line_comment:
1311                 case TK_block_comment:
1312                 case TK_error:
1313                         fprintf(f, "%s(", types[tok.num]);
1314                         text_dump(f, tok.txt, max);
1315                         fprintf(f, ")");
1316                         break;
1317                 }
1318         }
1319
1320 ### And there we have it
1321
1322 We now have all the library functions defined for reading and printing
1323 tokens.  Now we just need C files to store them, and a mk file to make them.
1324
1325 ###### File: scanner.h
1326         ## public types
1327         ## exported functions
1328
1329 ###### File: libscanner.c
1330         ## includes
1331         #include "scanner.h"
1332         ## private types
1333         ## internal functions
1334         ## main functions
1335
1336 ###### File: scanner.mk
1337
1338         CFLAGS += -Wall -g
1339         all ::
1340         scanner.mk scanner.h libscanner.c : scanner.mdc
1341                 ./md2c scanner.mdc
1342         all :: libscanner.o
1343         libscanner.o : libscanner.c
1344                 $(CC) $(CFLAGS) -c libscanner.c
1345
1346 ## Processing numbers
1347
1348 Converting a `TK_number` token to a numerical value is a slightly
1349 higher level task than lexical analysis, and slightly lower than
1350 grammar parsing, so put it here - as an appendix if you like.
1351
1352 Importantly it will be used by the same testing rig that is used for
1353 testing the token scanner.
1354
1355 The numeric value that we will convert all numbers into is the `mpq_t`
1356 from the GNU high precision number library "libgmp".
1357
1358 ###### number includes
1359         #include <gmp.h>
1360         #include "mdcode.h"
1361
1362 Firstly we need to be able to parse a string of digits in a given base
1363 and possibly with a decimal marker.  We store this in an `mpz_t`
1364 integer and report the number of digits after the decimal mark.
1365
1366 On error we return zero and ensure that the 'mpz_t' has been freed, or
1367 had never been initialised.
1368
1369 ###### number functions
1370
1371         static int parse_digits(mpz_t num, struct text tok, int base,
1372                                 int *placesp)
1373         {
1374                 /* Accept digits up to 'base', ignore '_' and
1375                  * (for base 10) ' ' if they appear between two
1376                  * legal digits, and if `placesp` is not NULL,
1377                  * allow a single '.' or ',' and report the number
1378                  * of digits beyond there.
1379                  * Return number of characters processed (p),
1380                  * or 0 if something illegal was found.
1381                  */
1382                 int p;
1383                 int decimal = -1; // digits after marker
1384                 enum {Digit, Space, Other} prev = Other;
1385                 int digits = 0;
1386
1387                 for (p = 0; p < tok.len; p++) {
1388                         int dig;
1389                         char c = tok.txt[p];
1390
1391                         if (c == '_' || (c == ' ' && base == 10)) {
1392                                 if (prev != Digit)
1393                                         goto bad;
1394                                 prev = Space;
1395                                 continue;
1396                         }
1397                         if (c == '.' || c == ',') {
1398                                 if (prev != Digit)
1399                                         goto bad;
1400                                 if (!placesp || decimal >= 0)
1401                                         return p-1;
1402                                 decimal = 0;
1403                                 prev = Other;
1404                                 continue;
1405                         }
1406                         if (isdigit(c))
1407                                 dig = c - '0';
1408                         else if (isupper(c))
1409                                 dig = 10 + c - 'A';
1410                         else if (islower(c))
1411                                 dig = 10 + c - 'a';
1412                         else
1413                                 dig = base;
1414                         if (dig >= base) {
1415                                 if (prev == Space)
1416                                         p--;
1417                                 break;
1418                         }
1419                         prev = Digit;
1420                         if (digits)
1421                                 mpz_mul_ui(num, num, base);
1422                         else
1423                                 mpz_init(num);
1424                         digits += 1;
1425                         mpz_add_ui(num, num, dig);
1426                         if (decimal >= 0)
1427                                 decimal++;
1428                 }
1429                 if (digits == 0)
1430                         return 0;
1431                 if (placesp) {
1432                         if (decimal >= 0)
1433                                 *placesp = decimal;
1434                         else
1435                                 *placesp = 0;
1436                 }
1437                 return p;
1438         bad:
1439                 if (digits)
1440                         mpz_clear(num);
1441                 return 0;
1442         }
1443
1444 ###### number includes
1445         #include <ctype.h>
1446
1447 To parse a full number we need to consider the optional base, the
1448 mantissa, and the optional exponent.  We will treat these one at a
1449 time.
1450
1451 The base is indicated by a letter after a leading zero, which must be
1452 followed by a base letter or a period.  The base also determines the
1453 character which will mark an exponent.
1454
1455 ###### number vars
1456         int base = 10;
1457         char expc = 'e';
1458
1459 ###### parse base
1460
1461         if (tok.txt[0] == '0' && tok.len > 1) {
1462                 int skip = 0;
1463                 switch(tok.txt[1]) {
1464                 case 'x':
1465                 case 'X':
1466                         base = 16;
1467                         skip = 2;
1468                         expc = 'p';
1469                         break;
1470                 case 'o':
1471                 case 'O':
1472                         base = 8;
1473                         skip = 2;
1474                         expc = 'p';
1475                         break;
1476                 case 'b':
1477                 case 'B':
1478                         base = 2;
1479                         skip = 2;
1480                         expc = 'p';
1481                         break;
1482                 case '0':
1483                 case '1':
1484                 case '2':
1485                 case '3':
1486                 case '4':
1487                 case '5':
1488                 case '6':
1489                 case '7':
1490                 case '8':
1491                 case '9':
1492                 case '_':
1493                 case ' ':
1494                         // another digit is not permitted
1495                         // after a zero.
1496                         return 0;
1497                 default:
1498                         // must be decimal marker or trailing
1499                         // letter, which are OK;
1500                         break;
1501                 }
1502                 tok.txt += skip;
1503                 tok.len -= skip;
1504         }
1505
1506 After the base is the mantissa, which may contain a decimal mark, so
1507 we need to record the number of places.  We won't impose the number of
1508 places until we have the exponent as well.
1509
1510 ###### number vars
1511         int places = 0;
1512         mpz_t mant;
1513         int d;
1514
1515 ###### parse mantissa
1516
1517         d = parse_digits(mant, tok, base, &places);
1518         if (d == 0)
1519                 return 0;
1520         tok.txt += d;
1521         tok.len -= d;
1522         mpq_init(num);
1523         mpq_set_z(num, mant);
1524         mpz_clear(mant);
1525
1526 After the mantissa number may come an exponent which may be positive
1527 or negative.  We assume at this point that we have seen the exponent
1528 character `expc`.
1529
1530 ###### number vars
1531         long lexp = 0;
1532         mpz_t exp;
1533         int esign = 1;
1534
1535 ###### parse exponent
1536         if (tok.len > 1) {
1537                 if (tok.txt[0] == '+') {
1538                         tok.txt++;
1539                         tok.len--;
1540                 } else if (tok.txt[0] == '-') {
1541                         esign = -1;
1542                         tok.txt++;
1543                         tok.len--;
1544                 }
1545         }
1546         d = parse_digits(exp, tok, 10, NULL);
1547         if (d == 0) {
1548                 mpq_clear(num);
1549                 return 0;
1550         }
1551         if (!mpz_fits_slong_p(exp)) {
1552                 mpq_clear(num);
1553                 mpz_clear(exp);
1554                 return 0;
1555         }
1556         lexp = mpz_get_si(exp) * esign;
1557         mpz_clear(exp);
1558         tok.txt += d;
1559         tok.len -= d;
1560
1561 Now that we have the mantissa and the exponent we can multiply them
1562 together, also allowing for the number of digits after the decimal
1563 mark.
1564
1565 For base 10, we simply subtract the decimal places from the exponent.
1566 For the other bases, as the exponent is alway based on 2, even for
1567 octal and hex, we need a bit more detail.
1568 We then recover the sign from the exponent, as division is quite
1569 different from multiplication.
1570
1571 ###### calc exponent
1572         switch (base) {
1573         case 10:
1574         case 2:
1575                 lexp -= places;
1576                 break;
1577         case 16:
1578                 lexp -= 4*places;
1579                 break;
1580         case 8:
1581                 lexp -= 3*places;
1582                 break;
1583         }
1584         if (lexp < 0) {
1585                 lexp = -lexp;
1586                 esign = -1;
1587         } else
1588                 esign = 1;
1589
1590 Imposing the exponent on the number is also very different for base 10
1591 than for the others.  For the binary shift `gmp` provides a simple
1592 function.  For base 10 we use something like Russian Peasant
1593 Multiplication.
1594
1595 ###### calc exponent
1596         if (expc == 'e') {
1597                 mpq_t tens;
1598                 mpq_init(tens);
1599                 mpq_set_ui(tens, 10, 1);
1600                 while (1) {
1601                         if (lexp & 1) {
1602                                 if (esign > 0)
1603                                         mpq_mul(num, num, tens);
1604                                 else
1605                                         mpq_div(num, num, tens);
1606                         }
1607                         lexp >>= 1;
1608                         if (lexp == 0)
1609                                 break;
1610                         mpq_mul(tens, tens, tens);
1611                 }
1612                 mpq_clear(tens);
1613         } else {
1614                 if (esign > 0)
1615                         mpq_mul_2exp(num, num, lexp);
1616                 else
1617                         mpq_div_2exp(num, num, lexp);
1618         }
1619
1620 Now we are ready to parse a number: the base, mantissa, and exponent.
1621 If all goes well we check for the possible trailing letters and
1622 return.  Return value is 1 for success and 0 for failure.
1623
1624 ###### number functions
1625         int number_parse(mpq_t num, char tail[3], struct text tok)
1626         {
1627                 ## number vars
1628                 int i;
1629
1630                 ## parse base
1631                 ## parse mantissa
1632                 if (tok.len > 1 && (tok.txt[0] == expc ||
1633                                     tok.txt[0] == toupper(expc))) {
1634                         tok.txt++;
1635                         tok.len--;
1636                         ## parse exponent
1637                 }
1638                 ## calc exponent
1639
1640                 for (i = 0; i < 2; i++) {
1641                         if (tok.len <= i)
1642                                 break;
1643                         if (!isalpha(tok.txt[i]))
1644                                 goto err;
1645                         tail[i] = tok.txt[i];
1646                 }
1647                 tail[i] = 0;
1648                 if (i == tok.len)
1649                         return 1;
1650         err:
1651                 mpq_clear(num);
1652                 return 0;
1653         }
1654
1655 Number parsing goes in `libnumber.c`
1656
1657 ###### File: libnumber.c
1658
1659         #include <unistd.h>
1660         #include <stdlib.h>
1661
1662         ## number includes
1663         ## number functions
1664
1665 ###### File: number.h
1666         int number_parse(mpq_t num, char tail[3], struct text tok);
1667
1668 ###### File: scanner.mk
1669         all :: libnumber.o
1670         libnumber.o : libnumber.c
1671                 $(CC) $(CFLAGS) -c libnumber.c
1672
1673 ## Processing strings
1674
1675 Both `TK_string` and `TK_multi_string` require post-processing which
1676 can be one of two types: literal or with escapes processed.
1677 Even literal processing is non-trivial as the file may contain indents
1678 which need to be stripped.
1679
1680 Errors can only occur when processing escapes.  Any unrecognised
1681 character following the escape character will cause an error.
1682
1683 Processing escapes and striping indents can only make the string
1684 shorter, not longer, so we allocate a buffer which is the same size as
1685 the string and process into that.
1686
1687 To request escape processing, we pass the character we want to use for
1688 quoting, usually '`\`'.  To avoid escape processing we pass a zero.
1689
1690 ###### string main
1691         int string_parse(struct token *tok, char escape,
1692                          struct text *str, char tail[3])
1693         {
1694                 ## string vars
1695                 struct text t = tok->txt;
1696
1697                 str->txt = NULL;
1698                 ## strip tail
1699                 if (tok->num == TK_string) {
1700                         ## strip single
1701                 } else {
1702                         ## strip multi
1703                 }
1704                 str->txt = malloc(t.len);
1705                 str->len = 0;
1706
1707                 ## process string
1708                 return 1;
1709         err:
1710                 free(str->txt);
1711                 str->txt = NULL;
1712                 return 0;
1713         }
1714
1715 ### strip tail
1716
1717 The tail of the string can be 0, 1, or 2 letters
1718
1719         i = t.len;
1720         if (i >= 0 && isalpha(t.txt[i-1]))
1721                 i -= 1;
1722         if (i >= 0 && isalpha(t.txt[i-1]))
1723                 i -= 1;
1724         strncpy(tail, t.txt+i, t.len-i);
1725         tail[t.len-i] = 0;
1726         t.len = i;
1727
1728 ###### string vars
1729         int i;
1730
1731 ### strip single
1732
1733 Stripping the quote of a single-line string is trivial.
1734 The only part that is at all interesting is that quote character must
1735 be remembered.
1736
1737         quote = t.txt[0];
1738         if (t.txt[t.len-1] != quote)
1739                 goto err;
1740         t.txt += 1;
1741         t.len -= 2;
1742
1743 ###### string vars
1744         char quote;
1745
1746 ### strip multi
1747
1748 For a multi-line string we have a little more work to do.  We need to
1749 remove 3 quotes, not 1, and need to count the indent of the close
1750 quote as it will need to be stripped from all lines.
1751
1752         quote = t.txt[0];
1753         if (t.len < 7 ||
1754             t.txt[1] != quote || t.txt[2] != quote ||
1755             !is_newline(t.txt[3]))
1756                 goto err;
1757         t.txt += 4;
1758         t.len -= 4;
1759         i = t.len;
1760         if (i <= 0 || t.txt[i-1] != quote)
1761                 goto err;
1762         i -= 1;
1763         if (i <= 0 || t.txt[i-1] != quote)
1764                 goto err;
1765         i -= 1;
1766         if (i <= 0 || t.txt[i-1] != quote)
1767                 goto err;
1768         i -= 1;
1769         t.len = i;
1770         while (i > 0 && !is_newline(t.txt[i-1]))
1771                 i--;
1772         indent = 0;
1773         while (i < t.len) {
1774                 if (t.txt[i] == ' ')
1775                         indent += 1;
1776                 if (t.txt[i] == '\t')
1777                         indent = indent_tab(indent);
1778                 i++;
1779         }
1780
1781 ###### string vars
1782         int indent = 0;
1783
1784 ### process string
1785
1786 Now we just take one byte at a time. trans-ASCII unicode won't look
1787 like anything we are interested in so it will just be copied byte by
1788 byte.
1789
1790         cp = str->txt;
1791         at_sol = 1;
1792         for (i = 0; i < t.len; i++) {
1793                 char c;
1794                 if (at_sol) {
1795                         at_sol = 0;
1796                         ## strip indent
1797                         if (i >= t.len)
1798                                 break;
1799                 }
1800                 c = t.txt[i];
1801                 if (c != escape) {
1802                         *cp = c;
1803                         cp += 1;
1804                         if (is_newline(c))
1805                                 at_sol = 1;
1806                 } else if (i+1 >= t.len) {
1807                         // escape and end of string
1808                         goto err;
1809                 } else {
1810                         i += 1;
1811                         c = t.txt[i];
1812                         ## parse escape
1813                 }
1814         }
1815         str->len = cp - str->txt;
1816
1817 ###### string vars
1818         char *cp;
1819         int at_sol;
1820
1821 ### strip indent
1822
1823 Every time we find a start of line, we strip spaces and tabs until the
1824 required indent is found.
1825
1826         int skipped = 0;
1827         while (i < t.len && skipped < indent) {
1828                 c = t.txt[i];
1829                 if (c == ' ')
1830                         skipped += 1;
1831                 else if (c == '\t')
1832                         skipped = indent_tab(skipped);
1833                 else
1834                         break;
1835                 i+= 1;
1836         }
1837
1838 ### parse escape
1839         switch (c) {
1840         case 'n':
1841                 *cp++ = '\n'; break;
1842         case 'r':
1843                 *cp++ = '\r'; break;
1844         case 't':
1845                 *cp++ = '\t'; break;
1846         case 'b':
1847                 *cp++ = '\b'; break;
1848         case 'q':
1849                 *cp++ = quote; break;
1850         case 'f':
1851                 *cp++ = '\f'; break;
1852         case 'v':
1853                 *cp++ = '\v'; break;
1854         case 'a':
1855                 *cp++ = '\a'; break;
1856         case '0':
1857         case '1':
1858         case '2':
1859         case '3':
1860                 // 3 digit octal number
1861                 if (i+2 >= t.len)
1862                         goto err;
1863                 if (t.txt[i+1] < '0' || t.txt[i+1] > '7' ||
1864                     t.txt[i+2] < '0' || t.txt[i+1] > '7')
1865                         goto err;
1866                 n = (t.txt[i  ]-'0') * 64 +
1867                     (t.txt[i+1]-'0') *  8 +
1868                     (t.txt[i+2]-'0') *  1;
1869                 *cp++ = n;
1870                 i += 2;
1871                 break;
1872         case 'x':
1873                 // 2 hex digits
1874                 n = take_hex(2, t.txt+i+1, t.len-i-1);
1875                 if (n < 0)
1876                         goto err;
1877                 *cp++ = n;
1878                 i += 2;
1879                 break;
1880         case 'u':
1881         case 'U':
1882                 // 4 or 8 hex digits for unicode
1883                 n = take_hex(c == 'u'?4:8, t.txt+i+1, t.len-i-1);
1884                 if (n < 0)
1885                         goto err;
1886                 memset(&pstate, 0, sizeof(pstate));
1887                 n = wcrtomb(cp, n, &pstate);
1888                 if (n <= 0)
1889                         goto err;
1890                 cp += n;
1891                 i += c == 'u' ? 4 : 8;
1892                 break;
1893         default:
1894                 if (c == escape)
1895                         *cp++ = c;
1896                 else if (is_newline(c))
1897                         at_sol = 1;
1898                 else
1899                         goto err;
1900         }
1901
1902 ###### string vars
1903         long n;
1904         mbstate_t pstate;
1905
1906 For `\x` `\u` and `\U` we need to collect a specific number of
1907 hexadecimal digits
1908
1909 ###### string functions
1910
1911         static long take_hex(int digits, char *cp, int l)
1912         {
1913                 long n = 0;
1914                 if (l < digits)
1915                         return -1;
1916                 while (digits) {
1917                         char  c = *cp;
1918                         int d;
1919                         if (!isxdigit(c))
1920                                 return -1;
1921                         if (isdigit(c))
1922                                 d = c - '0';
1923                         else if (isupper(c))
1924                                 d = 10 + c - 'A';
1925                         else
1926                                 d = 10 + c - 'a';
1927                         n = n * 16 + d;
1928                         digits--;
1929                         cp++;
1930                 }
1931                 return n;
1932         }
1933
1934 #### File: libstring.c
1935
1936 String parsing goes in `libstring.c`
1937
1938         #include <unistd.h>
1939         #include <stdlib.h>
1940         #include <stdio.h>
1941         #include <string.h>
1942         #include <ctype.h>
1943         #include <wchar.h>
1944         #include "mdcode.h"
1945         #include "scanner.h"
1946         ## string functions
1947         ## string main
1948
1949 ###### File: string.h
1950         int string_parse(struct token *tok, char escape,
1951                          struct text *str, char tail[3]);
1952
1953 ###### File: scanner.mk
1954         all :: libstring.o
1955         libstring.o : libstring.c
1956                 $(CC) $(CFLAGS) -c libstring.c
1957
1958 ## Testing
1959
1960 As "untested code is buggy code" we need a program to easily test
1961 the scanner library.  This will simply parse a given file and report
1962 the tokens one per line.
1963
1964 ###### File: scanner.c
1965
1966         #include <unistd.h>
1967         #include <stdlib.h>
1968         #include <fcntl.h>
1969         #include <errno.h>
1970         #include <sys/mman.h>
1971         #include <string.h>
1972         #include <stdio.h>
1973         #include <gmp.h>
1974         #include <locale.h>
1975         #include <getopt.h>
1976         #include "mdcode.h"
1977         #include "scanner.h"
1978         #include "number.h"
1979         #include "string.h"
1980
1981         static int errs;
1982         static void pr_err(char *msg)
1983         {
1984                 errs++;
1985                 fprintf(stderr, "%s\n", msg);
1986         }
1987
1988         static int kcmp(const void *ap, const void *bp)
1989         {
1990                 char * const *a = ap;
1991                 char * const *b = bp;
1992                 return strcmp(*a, *b);
1993         }
1994
1995         int main(int argc, char *argv[])
1996         {
1997                 int fd;
1998                 int len;
1999                 char *file;
2000                 char *filename = NULL;
2001                 struct token_state *state;
2002                 const char *known[] = {
2003                         "==",
2004                         "else",
2005                         "if",
2006                         "then",
2007                         "while",
2008                         "{",
2009                         "}",
2010                 };
2011                 struct token_config conf = {
2012                         .word_start = "_$",
2013                         .word_cont = "",
2014                         .words_marks = known,
2015                         .number_chars = "., _+-",
2016                         .known_count = sizeof(known)/sizeof(known[0]),
2017                         .ignored = 0,
2018                 };
2019                 static const struct option long_options[] = {
2020                         { "word-start",         1, NULL, 'W'},
2021                         { "word-cont",          1, NULL, 'w'},
2022                         { "number-chars",       1, NULL, 'n'},
2023                         { "ignore-numbers",     0, NULL, 'N'},
2024                         { "ignore-ident",       0, NULL, 'I'},
2025                         { "ignore-marks",       0, NULL, 'M'},
2026                         { "ignore-strings",     0, NULL, 'S'},
2027                         { "ignore-multi-strings",0, NULL, 'z'},
2028                         { "ignore-line-comment",0, NULL, 'c'},
2029                         { "ignore-newline",     0, NULL, 'l'},
2030                         { "ignore-block-comment", 0, NULL, 'C'},
2031                         { "ignore-indent",      0, NULL, 'i'},
2032                         { "file",               1, NULL, 'f'},
2033                         { "section",            1, NULL, 's'},
2034                         { NULL,                 0, NULL, 0},
2035                 };
2036                 static const char options[] = "W:w:n:NIMSzclCif:s:";
2037
2038                 struct section *table, *s, *prev;
2039                 int opt;
2040                 char *section_name = NULL;
2041                 int section_found = 0;
2042
2043                 setlocale(LC_ALL,"");
2044                 while ((opt = getopt_long(argc, argv, options, long_options, NULL))
2045                        != -1) {
2046                         switch(opt) {
2047                         case 'W': conf.word_start = optarg; break;
2048                         case 'w': conf.word_cont = optarg; break;
2049                         case 'n': conf.number_chars = optarg; break;
2050                         case 'N': conf.ignored |= 1 << TK_number; break;
2051                         case 'I': conf.ignored |= 1 << TK_ident; break;
2052                         case 'M': conf.ignored |= 1 << TK_mark; break;
2053                         case 'S': conf.ignored |= 1 << TK_string; break;
2054                         case 'z': conf.ignored |= 1 << TK_multi_string; break;
2055                         case 'c': conf.ignored |= 1 << TK_line_comment; break;
2056                         case 'C': conf.ignored |= 1 << TK_block_comment; break;
2057                         case 'l': conf.ignored |= 1 << TK_newline; break;
2058                         case 'i': conf.ignored |= 1 << TK_in; break;
2059                         case 'f': filename = optarg; break;
2060                         case 's': section_name = optarg; break;
2061                         default: fprintf(stderr, "scanner: unknown option '%c'.\n",
2062                                          opt);
2063                                 exit(1);
2064                         }
2065                 }
2066
2067                 if (optind < argc) {
2068                         const char **wm = calloc(argc - optind, sizeof(char*));
2069                         int i;
2070                         for (i = optind; i < argc; i++)
2071                                 wm[i - optind] = argv[i];
2072                         qsort(wm, argc-optind, sizeof(char*), kcmp);
2073                         conf.words_marks = wm;
2074                         conf.known_count = argc - optind;
2075                 }
2076
2077                 if (filename)
2078                         fd = open(filename, O_RDONLY);
2079                 else
2080                         fd = 0;
2081                 if (fd < 0) {
2082                         fprintf(stderr, "scanner: cannot open %s: %s\n",
2083                                 filename, strerror(errno));
2084                         exit(1);
2085                 }
2086                 len = lseek(fd, 0, 2);
2087                 if (len <= 0) {
2088                         fprintf(stderr,"scanner: %s is empty or not seekable\n",
2089                                 filename ?: "stdin");
2090                         exit(1);
2091                 }
2092                 file = mmap(NULL, len, PROT_READ, MAP_SHARED, fd, 0);
2093                 table = code_extract(file, file+len, pr_err);
2094
2095                 for (s = table; s;
2096                         (code_free(s->code), prev = s, s = s->next, free(prev))) {
2097                         if (section_name &&
2098                             (s->section.len != strlen(section_name) ||
2099                              strncmp(s->section.txt, section_name, s->section.len) != 0))
2100                                 continue;
2101                         if (section_name)
2102                                 section_found = 1;
2103                         printf("Tokenizing: %.*s\n", s->section.len,
2104                                 s->section.txt);
2105                         state = token_open(s->code, &conf);
2106                         while(1) {
2107                                 struct token tk = token_next(state);
2108                                 printf("%d:%d ", tk.line, tk.col);
2109                                 token_trace(stdout, tk, 20);
2110                                 if (tk.num == TK_number) {
2111                                         mpq_t num;
2112                                         char tail[3];
2113                                         if (number_parse(num, tail,tk.txt)) {
2114                                                 printf(" %s ", tail);
2115                                                 mpq_out_str(stdout, 10, num);
2116                                                 mpq_clear(num);
2117                                         } else
2118                                                 printf(" BAD NUMBER");
2119                                 }
2120                                 if (tk.num == TK_string ||
2121                                     tk.num == TK_multi_string) {
2122                                         char esc = '\\';
2123                                         struct text str;
2124                                         char tail[3];
2125                                         if (tk.txt.txt[0] == '`')
2126                                                 esc = 0;
2127                                         if (string_parse(&tk, esc,
2128                                                          &str, tail)) {
2129                                                 printf(" %s ", tail);
2130                                                 text_dump(stdout, str, 20);
2131                                                 free(str.txt);
2132                                         } else
2133                                                 printf(" BAD STRING");
2134                                 }
2135                                 printf("\n");
2136                                 if (tk.num == TK_error)
2137                                         errs = 1;
2138                                 if (tk.num == TK_eof)
2139                                         break;
2140                         }
2141                         token_close(state);
2142                 }
2143                 if (conf.words_marks != known)
2144                         free(conf.words_marks);
2145                 if (section_name && !section_found) {
2146                         fprintf(stderr, "scanner: section %s not found\n", section_name);
2147                         errs = 1;
2148                 }
2149                 exit(!!errs);
2150         }
2151 ###### File: scanner.mk
2152         scanner.c : scanner.mdc
2153                 ./md2c scanner.mdc
2154         all :: scanner
2155         scanner : scanner.o scanner.h libscanner.o libmdcode.o mdcode.h
2156                 $(CC) $(CFLAGS) -o scanner scanner.o libscanner.o \
2157                         libmdcode.o libnumber.o libstring.o -licuuc -lgmp
2158         scanner.o : scanner.c
2159                 $(CC) $(CFLAGS) -c scanner.c