src/language/lexer/lexer.c

   1 /* PSPP - a program for statistical analysis.
   2    Copyright (C) 1997-9, 2000, 2006, 2009 Free Software Foundation, Inc.
   3
   4    This program is free software: you can redistribute it and/or modify
   5    it under the terms of the GNU General Public License as published by
   6    the Free Software Foundation, either version 3 of the License, or
   7    (at your option) any later version.
   8
   9    This program is distributed in the hope that it will be useful,
  10    but WITHOUT ANY WARRANTY; without even the implied warranty of
  11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12    GNU General Public License for more details.
  13
  14    You should have received a copy of the GNU General Public License
  15    along with this program.  If not, see <http://www.gnu.org/licenses/>. */
  16
  17 #include <config.h>
  18 #include "lexer.h"
  19 #include <libpspp/message.h>
  20 #include <c-ctype.h>
  21 #include <c-strtod.h>
  22 #include <errno.h>
  23 #include <limits.h>
  24 #include <math.h>
  25 #include <stdarg.h>
  26 #include <stdint.h>
  27 #include <stdlib.h>
  28 #include <libpspp/assertion.h>
  29 #include <language/command.h>
  30 #include <libpspp/message.h>
  31 #include <data/settings.h>
  32 #include <libpspp/getl.h>
  33 #include <libpspp/str.h>
  34 #include <output/journal.h>
  35 #include <output/text-item.h>
  36
  37 #include "xalloc.h"
  38
  39 #include "gettext.h"
  40 #define _(msgid) gettext (msgid)
  41 #define N_(msgid) msgid
  42
  43
  44 #define DUMP_TOKENS 0
  45
  46
  47
  48 struct lexer
  49 {
  50   struct string line_buffer;
  51
  52   struct source_stream *ss;
  53
  54   int token;      /* Current token. */
  55   double tokval;  /* T_POS_NUM, T_NEG_NUM: the token's value. */
  56
  57   char tokid [VAR_NAME_LEN + 1];   /* T_ID: the identifier. */
  58
  59   struct string tokstr;   /* T_ID, T_STRING: token string value.
  60                             For T_ID, this is not truncated as is
  61                             tokid. */
  62
  63   char *prog; /* Pointer to next token in line_buffer. */
  64   bool dot;   /* True only if this line ends with a terminal dot. */
  65
  66   int put_token ; /* If nonzero, next token returned by lex_get().
  67                     Used only in exceptional circumstances. */
  68
  69   struct string put_tokstr;
  70   double put_tokval;
  71 };
  72
  73
  74 static int parse_id (struct lexer *);
  75
  76 /* How a string represents its contents. */
  77 enum string_type
  78   {
  79     CHARACTER_STRING,   /* Characters. */
  80     BINARY_STRING,      /* Binary digits. */
  81     OCTAL_STRING,       /* Octal digits. */
  82     HEX_STRING          /* Hexadecimal digits. */
  83   };
  84
  85 static int parse_string (struct lexer *, enum string_type);
  86
  87 #if DUMP_TOKENS
  88 static void dump_token (struct lexer *);
  89 #endif
  90 \f
  91 /* Initialization. */
  92
  93 /* Initializes the lexer. */
  94 struct lexer *
  95 lex_create (struct source_stream *ss)
  96 {
  97   struct lexer *lexer = xzalloc (sizeof (*lexer));
  98
  99   ds_init_empty (&lexer->tokstr);
 100   ds_init_empty (&lexer->put_tokstr);
 101   ds_init_empty (&lexer->line_buffer);
 102   lexer->ss = ss;
 103
 104   return lexer;
 105 }
 106
 107 struct source_stream *
 108 lex_get_source_stream (const struct lexer *lex)
 109 {
 110   return lex->ss;
 111 }
 112
 113 enum syntax_mode
 114 lex_current_syntax_mode (const struct lexer *lex)
 115 {
 116   return source_stream_current_syntax_mode (lex->ss);
 117 }
 118
 119 enum error_mode
 120 lex_current_error_mode (const struct lexer *lex)
 121 {
 122   return source_stream_current_error_mode (lex->ss);
 123 }
 124
 125
 126 void
 127 lex_destroy (struct lexer *lexer)
 128 {
 129   if ( NULL != lexer )
 130     {
 131       ds_destroy (&lexer->put_tokstr);
 132       ds_destroy (&lexer->tokstr);
 133       ds_destroy (&lexer->line_buffer);
 134
 135       free (lexer);
 136     }
 137 }
 138
 139 \f
 140 /* Common functions. */
 141
 142 /* Copies put_token, lexer->put_tokstr, put_tokval into token, tokstr,
 143    tokval, respectively, and sets tokid appropriately. */
 144 static void
 145 restore_token (struct lexer *lexer)
 146 {
 147   assert (lexer->put_token != 0);
 148   lexer->token = lexer->put_token;
 149   ds_assign_string (&lexer->tokstr, &lexer->put_tokstr);
 150   str_copy_trunc (lexer->tokid, sizeof lexer->tokid, ds_cstr (&lexer->tokstr));
 151   lexer->tokval = lexer->put_tokval;
 152   lexer->put_token = 0;
 153 }
 154
 155 /* Copies token, tokstr, lexer->tokval into lexer->put_token, put_tokstr,
 156    put_lexer->tokval respectively. */
 157 static void
 158 save_token (struct lexer *lexer)
 159 {
 160   lexer->put_token = lexer->token;
 161   ds_assign_string (&lexer->put_tokstr, &lexer->tokstr);
 162   lexer->put_tokval = lexer->tokval;
 163 }
 164
 165 /* Parses a single token, setting appropriate global variables to
 166    indicate the token's attributes. */
 167 void
 168 lex_get (struct lexer *lexer)
 169 {
 170   /* Find a token. */
 171   for (;;)
 172     {
 173       if (NULL == lexer->prog && ! lex_get_line (lexer) )
 174         {
 175           lexer->token = T_STOP;
 176           return;
 177         }
 178
 179   /* If a token was pushed ahead, return it. */
 180   if (lexer->put_token)
 181     {
 182       restore_token (lexer);
 183 #if DUMP_TOKENS
 184           dump_token (lexer);
 185 #endif
 186       return;
 187     }
 188
 189   for (;;)
 190     {
 191       /* Skip whitespace. */
 192           while (c_isspace ((unsigned char) *lexer->prog))
 193             lexer->prog++;
 194
 195           if (*lexer->prog)
 196             break;
 197
 198           if (lexer->dot)
 199             {
 200               lexer->dot = 0;
 201               lexer->token = '.';
 202 #if DUMP_TOKENS
 203               dump_token (lexer);
 204 #endif
 205               return;
 206             }
 207           else if (!lex_get_line (lexer))
 208             {
 209               lexer->prog = NULL;
 210               lexer->token = T_STOP;
 211 #if DUMP_TOKENS
 212               dump_token (lexer);
 213 #endif
 214               return;
 215             }
 216
 217           if (lexer->put_token)
 218             {
 219               restore_token (lexer);
 220 #if DUMP_TOKENS
 221               dump_token (lexer);
 222 #endif
 223               return;
 224             }
 225         }
 226
 227
 228       /* Actually parse the token. */
 229       ds_clear (&lexer->tokstr);
 230
 231       switch (*lexer->prog)
 232         {
 233         case '-': case '.':
 234         case '0': case '1': case '2': case '3': case '4':
 235         case '5': case '6': case '7': case '8': case '9':
 236           {
 237             char *tail;
 238
 239             /* `-' can introduce a negative number, or it can be a
 240                token by itself.  If it is not followed by a digit or a
 241                decimal point, it is definitely not a number.
 242                Otherwise, it might be either, but most of the time we
 243                want it as a number.  When the syntax calls for a `-'
 244                token, lex_negative_to_dash() must be used to break
 245                negative numbers into two tokens. */
 246             if (*lexer->prog == '-')
 247               {
 248                 ds_put_char (&lexer->tokstr, *lexer->prog++);
 249                 while (c_isspace ((unsigned char) *lexer->prog))
 250                   lexer->prog++;
 251
 252                 if (!c_isdigit ((unsigned char) *lexer->prog) && *lexer->prog != '.')
 253                   {
 254                     lexer->token = '-';
 255                     break;
 256                   }
 257                 lexer->token = T_NEG_NUM;
 258               }
 259             else
 260               lexer->token = T_POS_NUM;
 261
 262             /* Parse the number, copying it into tokstr. */
 263             while (c_isdigit ((unsigned char) *lexer->prog))
 264               ds_put_char (&lexer->tokstr, *lexer->prog++);
 265             if (*lexer->prog == '.')
 266               {
 267                 ds_put_char (&lexer->tokstr, *lexer->prog++);
 268                 while (c_isdigit ((unsigned char) *lexer->prog))
 269                   ds_put_char (&lexer->tokstr, *lexer->prog++);
 270               }
 271             if (*lexer->prog == 'e' || *lexer->prog == 'E')
 272               {
 273                 ds_put_char (&lexer->tokstr, *lexer->prog++);
 274                 if (*lexer->prog == '+' || *lexer->prog == '-')
 275                   ds_put_char (&lexer->tokstr, *lexer->prog++);
 276                 while (c_isdigit ((unsigned char) *lexer->prog))
 277                   ds_put_char (&lexer->tokstr, *lexer->prog++);
 278               }
 279
 280             /* Parse as floating point. */
 281             lexer->tokval = c_strtod (ds_cstr (&lexer->tokstr), &tail);
 282             if (*tail)
 283               {
 284                 msg (SE, _("%s does not form a valid number."),
 285                      ds_cstr (&lexer->tokstr));
 286                 lexer->tokval = 0.0;
 287
 288                 ds_clear (&lexer->tokstr);
 289                 ds_put_char (&lexer->tokstr, '0');
 290               }
 291
 292             break;
 293           }
 294
 295         case '\'': case '"':
 296           lexer->token = parse_string (lexer, CHARACTER_STRING);
 297           break;
 298
 299         case '(': case ')': case ',': case '=': case '+': case '/':
 300         case '[': case ']':
 301           lexer->token = *lexer->prog++;
 302           break;
 303
 304         case '*':
 305           if (*++lexer->prog == '*')
 306             {
 307               lexer->prog++;
 308               lexer->token = T_EXP;
 309             }
 310           else
 311             lexer->token = '*';
 312           break;
 313
 314         case '<':
 315           if (*++lexer->prog == '=')
 316             {
 317               lexer->prog++;
 318               lexer->token = T_LE;
 319             }
 320           else if (*lexer->prog == '>')
 321             {
 322               lexer->prog++;
 323               lexer->token = T_NE;
 324             }
 325           else
 326             lexer->token = T_LT;
 327           break;
 328
 329         case '>':
 330           if (*++lexer->prog == '=')
 331             {
 332               lexer->prog++;
 333               lexer->token = T_GE;
 334             }
 335           else
 336             lexer->token = T_GT;
 337           break;
 338
 339         case '~':
 340           if (*++lexer->prog == '=')
 341             {
 342               lexer->prog++;
 343               lexer->token = T_NE;
 344             }
 345           else
 346             lexer->token = T_NOT;
 347           break;
 348
 349         case '&':
 350           lexer->prog++;
 351           lexer->token = T_AND;
 352           break;
 353
 354         case '|':
 355           lexer->prog++;
 356           lexer->token = T_OR;
 357           break;
 358
 359         case 'b': case 'B':
 360           if (lexer->prog[1] == '\'' || lexer->prog[1] == '"')
 361             lexer->token = parse_string (lexer, BINARY_STRING);
 362           else
 363             lexer->token = parse_id (lexer);
 364           break;
 365
 366         case 'o': case 'O':
 367           if (lexer->prog[1] == '\'' || lexer->prog[1] == '"')
 368             lexer->token = parse_string (lexer, OCTAL_STRING);
 369           else
 370             lexer->token = parse_id (lexer);
 371           break;
 372
 373         case 'x': case 'X':
 374           if (lexer->prog[1] == '\'' || lexer->prog[1] == '"')
 375             lexer->token = parse_string (lexer, HEX_STRING);
 376           else
 377             lexer->token = parse_id (lexer);
 378           break;
 379
 380         default:
 381           if (lex_is_id1 (*lexer->prog))
 382             {
 383               lexer->token = parse_id (lexer);
 384               break;
 385             }
 386           else
 387             {
 388               unsigned char c = *lexer->prog++;
 389               char *c_name = xasprintf (c_isgraph (c) ? "%c" : "\\%o", c);
 390               msg (SE, _("Bad character in input: `%s'."), c_name);
 391               free (c_name);
 392               continue;
 393             }
 394         }
 395       break;
 396     }
 397
 398 #if DUMP_TOKENS
 399   dump_token (lexer);
 400 #endif
 401 }
 402
 403 /* Parses an identifier at the current position into tokid and
 404    tokstr.
 405    Returns the correct token type. */
 406 static int
 407 parse_id (struct lexer *lexer)
 408 {
 409   struct substring rest_of_line
 410     = ss_substr (ds_ss (&lexer->line_buffer),
 411                  ds_pointer_to_position (&lexer->line_buffer, lexer->prog),
 412                  SIZE_MAX);
 413   struct substring id = ss_head (rest_of_line,
 414                                  lex_id_get_length (rest_of_line));
 415   lexer->prog += ss_length (id);
 416
 417   ds_assign_substring (&lexer->tokstr, id);
 418   str_copy_trunc (lexer->tokid, sizeof lexer->tokid, ds_cstr (&lexer->tokstr));
 419   return lex_id_to_token (id);
 420 }
 421
 422 /* Reports an error to the effect that subcommand SBC may only be
 423    specified once. */
 424 void
 425 lex_sbc_only_once (const char *sbc)
 426 {
 427   msg (SE, _("Subcommand %s may only be specified once."), sbc);
 428 }
 429
 430 /* Reports an error to the effect that subcommand SBC is
 431    missing. */
 432 void
 433 lex_sbc_missing (struct lexer *lexer, const char *sbc)
 434 {
 435   lex_error (lexer, _("missing required subcommand %s"), sbc);
 436 }
 437
 438 /* Prints a syntax error message containing the current token and
 439    given message MESSAGE (if non-null). */
 440 void
 441 lex_error (struct lexer *lexer, const char *message, ...)
 442 {
 443   char *token_rep;
 444   char where[128];
 445
 446   token_rep = lex_token_representation (lexer);
 447   if (lexer->token == T_STOP)
 448     strcpy (where, "end of file");
 449   else if (lexer->token == '.')
 450     strcpy (where, "end of command");
 451   else
 452     snprintf (where, sizeof where, "`%s'", token_rep);
 453   free (token_rep);
 454
 455   if (message)
 456     {
 457       char buf[1024];
 458       va_list args;
 459
 460       va_start (args, message);
 461       vsnprintf (buf, 1024, message, args);
 462       va_end (args);
 463
 464       msg (SE, _("Syntax error %s at %s."), buf, where);
 465     }
 466   else
 467     msg (SE, _("Syntax error at %s."), where);
 468 }
 469
 470 /* Checks that we're at end of command.
 471    If so, returns a successful command completion code.
 472    If not, flags a syntax error and returns an error command
 473    completion code. */
 474 int
 475 lex_end_of_command (struct lexer *lexer)
 476 {
 477   if (lexer->token != '.')
 478     {
 479       lex_error (lexer, _("expecting end of command"));
 480       return CMD_FAILURE;
 481     }
 482   else
 483     return CMD_SUCCESS;
 484 }
 485 \f
 486 /* Token testing functions. */
 487
 488 /* Returns true if the current token is a number. */
 489 bool
 490 lex_is_number (struct lexer *lexer)
 491 {
 492   return lexer->token == T_POS_NUM || lexer->token == T_NEG_NUM;
 493 }
 494
 495
 496 /* Returns true if the current token is a string. */
 497 bool
 498 lex_is_string (struct lexer *lexer)
 499 {
 500   return lexer->token == T_STRING;
 501 }
 502
 503
 504 /* Returns the value of the current token, which must be a
 505    floating point number. */
 506 double
 507 lex_number (struct lexer *lexer)
 508 {
 509   assert (lex_is_number (lexer));
 510   return lexer->tokval;
 511 }
 512
 513 /* Returns true iff the current token is an integer. */
 514 bool
 515 lex_is_integer (struct lexer *lexer)
 516 {
 517   return (lex_is_number (lexer)
 518           && lexer->tokval > LONG_MIN
 519           && lexer->tokval <= LONG_MAX
 520           && floor (lexer->tokval) == lexer->tokval);
 521 }
 522
 523 /* Returns the value of the current token, which must be an
 524    integer. */
 525 long
 526 lex_integer (struct lexer *lexer)
 527 {
 528   assert (lex_is_integer (lexer));
 529   return lexer->tokval;
 530 }
 531 \f
 532 /* Token matching functions. */
 533
 534 /* If TOK is the current token, skips it and returns true
 535    Otherwise, returns false. */
 536 bool
 537 lex_match (struct lexer *lexer, int t)
 538 {
 539   if (lexer->token == t)
 540     {
 541       lex_get (lexer);
 542       return true;
 543     }
 544   else
 545     return false;
 546 }
 547
 548 /* If the current token is the identifier S, skips it and returns
 549    true.  The identifier may be abbreviated to its first three
 550    letters.
 551    Otherwise, returns false. */
 552 bool
 553 lex_match_id (struct lexer *lexer, const char *s)
 554 {
 555   return lex_match_id_n (lexer, s, 3);
 556 }
 557
 558 /* If the current token is the identifier S, skips it and returns
 559    true.  The identifier may be abbreviated to its first N
 560    letters.
 561    Otherwise, returns false. */
 562 bool
 563 lex_match_id_n (struct lexer *lexer, const char *s, size_t n)
 564 {
 565   if (lexer->token == T_ID
 566       && lex_id_match_n (ss_cstr (s), ss_cstr (lexer->tokid), n))
 567     {
 568       lex_get (lexer);
 569       return true;
 570     }
 571   else
 572     return false;
 573 }
 574
 575 /* If the current token is integer N, skips it and returns true.
 576    Otherwise, returns false. */
 577 bool
 578 lex_match_int (struct lexer *lexer, int x)
 579 {
 580   if (lex_is_integer (lexer) && lex_integer (lexer) == x)
 581     {
 582       lex_get (lexer);
 583       return true;
 584     }
 585   else
 586     return false;
 587 }
 588 \f
 589 /* Forced matches. */
 590
 591 /* If this token is identifier S, fetches the next token and returns
 592    nonzero.
 593    Otherwise, reports an error and returns zero. */
 594 bool
 595 lex_force_match_id (struct lexer *lexer, const char *s)
 596 {
 597   if (lex_match_id (lexer, s))
 598     return true;
 599   else
 600     {
 601       lex_error (lexer, _("expecting `%s'"), s);
 602       return false;
 603     }
 604 }
 605
 606 /* If the current token is T, skips the token.  Otherwise, reports an
 607    error and returns from the current function with return value false. */
 608 bool
 609 lex_force_match (struct lexer *lexer, int t)
 610 {
 611   if (lexer->token == t)
 612     {
 613       lex_get (lexer);
 614       return true;
 615     }
 616   else
 617     {
 618       lex_error (lexer, _("expecting `%s'"), lex_token_name (t));
 619       return false;
 620     }
 621 }
 622
 623 /* If this token is a string, does nothing and returns true.
 624    Otherwise, reports an error and returns false. */
 625 bool
 626 lex_force_string (struct lexer *lexer)
 627 {
 628   if (lexer->token == T_STRING)
 629     return true;
 630   else
 631     {
 632       lex_error (lexer, _("expecting string"));
 633       return false;
 634     }
 635 }
 636
 637 /* If this token is an integer, does nothing and returns true.
 638    Otherwise, reports an error and returns false. */
 639 bool
 640 lex_force_int (struct lexer *lexer)
 641 {
 642   if (lex_is_integer (lexer))
 643     return true;
 644   else
 645     {
 646       lex_error (lexer, _("expecting integer"));
 647       return false;
 648     }
 649 }
 650
 651 /* If this token is a number, does nothing and returns true.
 652    Otherwise, reports an error and returns false. */
 653 bool
 654 lex_force_num (struct lexer *lexer)
 655 {
 656   if (lex_is_number (lexer))
 657     return true;
 658
 659   lex_error (lexer, _("expecting number"));
 660   return false;
 661 }
 662
 663 /* If this token is an identifier, does nothing and returns true.
 664    Otherwise, reports an error and returns false. */
 665 bool
 666 lex_force_id (struct lexer *lexer)
 667 {
 668   if (lexer->token == T_ID)
 669     return true;
 670
 671   lex_error (lexer, _("expecting identifier"));
 672   return false;
 673 }
 674
 675 /* Weird token functions. */
 676
 677 /* Returns the first character of the next token, except that if the
 678    next token is not an identifier, the character returned will not be
 679    a character that can begin an identifier.  Specifically, the
 680    hexstring lead-in X' causes lookahead() to return '.  Note that an
 681    alphanumeric return value doesn't guarantee an ID token, it could
 682    also be a reserved-word token. */
 683 int
 684 lex_look_ahead (struct lexer *lexer)
 685 {
 686   if (lexer->put_token)
 687     return lexer->put_token;
 688
 689   for (;;)
 690     {
 691       if (NULL == lexer->prog && ! lex_get_line (lexer) )
 692         return 0;
 693
 694       for (;;)
 695         {
 696           while (c_isspace ((unsigned char) *lexer->prog))
 697             lexer->prog++;
 698           if (*lexer->prog)
 699             break;
 700
 701           if (lexer->dot)
 702             return '.';
 703           else if (!lex_get_line (lexer))
 704             return 0;
 705
 706           if (lexer->put_token)
 707             return lexer->put_token;
 708         }
 709
 710       if ((toupper ((unsigned char) *lexer->prog) == 'X'
 711            || toupper ((unsigned char) *lexer->prog) == 'B'
 712            || toupper ((unsigned char) *lexer->prog) == 'O')
 713           && (lexer->prog[1] == '\'' || lexer->prog[1] == '"'))
 714         return '\'';
 715
 716       return *lexer->prog;
 717     }
 718 }
 719
 720 /* Makes the current token become the next token to be read; the
 721    current token is set to T. */
 722 void
 723 lex_put_back (struct lexer *lexer, int t)
 724 {
 725   save_token (lexer);
 726   lexer->token = t;
 727 }
 728
 729 /* Makes the current token become the next token to be read; the
 730    current token is set to the identifier ID. */
 731 void
 732 lex_put_back_id (struct lexer *lexer, const char *id)
 733 {
 734   assert (lex_id_to_token (ss_cstr (id)) == T_ID);
 735   save_token (lexer);
 736   lexer->token = T_ID;
 737   ds_assign_cstr (&lexer->tokstr, id);
 738   str_copy_trunc (lexer->tokid, sizeof lexer->tokid, ds_cstr (&lexer->tokstr));
 739 }
 740 \f
 741 /* Weird line processing functions. */
 742
 743 /* Returns the entire contents of the current line. */
 744 const char *
 745 lex_entire_line (const struct lexer *lexer)
 746 {
 747   return ds_cstr (&lexer->line_buffer);
 748 }
 749
 750 const struct string *
 751 lex_entire_line_ds (const struct lexer *lexer)
 752 {
 753   return &lexer->line_buffer;
 754 }
 755
 756 /* As lex_entire_line(), but only returns the part of the current line
 757    that hasn't already been tokenized. */
 758 const char *
 759 lex_rest_of_line (const struct lexer *lexer)
 760 {
 761   return lexer->prog;
 762 }
 763
 764 /* Returns true if the current line ends in a terminal dot,
 765    false otherwise. */
 766 bool
 767 lex_end_dot (const struct lexer *lexer)
 768 {
 769   return lexer->dot;
 770 }
 771
 772 /* Causes the rest of the current input line to be ignored for
 773    tokenization purposes. */
 774 void
 775 lex_discard_line (struct lexer *lexer)
 776 {
 777   ds_cstr (&lexer->line_buffer);  /* Ensures ds_end points to something valid */
 778   lexer->prog = ds_end (&lexer->line_buffer);
 779   lexer->dot = false;
 780   lexer->put_token = 0;
 781 }
 782
 783
 784 /* Discards the rest of the current command.
 785    When we're reading commands from a file, we skip tokens until
 786    a terminal dot or EOF.
 787    When we're reading commands interactively from the user,
 788    that's just discarding the current line, because presumably
 789    the user doesn't want to finish typing a command that will be
 790    ignored anyway. */
 791 void
 792 lex_discard_rest_of_command (struct lexer *lexer)
 793 {
 794   if (!getl_is_interactive (lexer->ss))
 795     {
 796       while (lexer->token != T_STOP && lexer->token != '.')
 797         lex_get (lexer);
 798     }
 799   else
 800     lex_discard_line (lexer);
 801 }
 802 \f
 803 /* Weird line reading functions. */
 804
 805 /* Remove C-style comments in STRING, begun by slash-star and
 806    terminated by star-slash or newline. */
 807 static void
 808 strip_comments (struct string *string)
 809 {
 810   char *cp;
 811   int quote;
 812   bool in_comment;
 813
 814   in_comment = false;
 815   quote = EOF;
 816   for (cp = ds_cstr (string); *cp; )
 817     {
 818       /* If we're not in a comment, check for quote marks. */
 819       if (!in_comment)
 820         {
 821           if (*cp == quote)
 822             quote = EOF;
 823           else if (*cp == '\'' || *cp == '"')
 824             quote = *cp;
 825         }
 826
 827       /* If we're not inside a quotation, check for comment. */
 828       if (quote == EOF)
 829         {
 830           if (cp[0] == '/' && cp[1] == '*')
 831             {
 832               in_comment = true;
 833               *cp++ = ' ';
 834               *cp++ = ' ';
 835               continue;
 836             }
 837           else if (in_comment && cp[0] == '*' && cp[1] == '/')
 838             {
 839               in_comment = false;
 840               *cp++ = ' ';
 841               *cp++ = ' ';
 842               continue;
 843             }
 844         }
 845
 846       /* Check commenting. */
 847       if (in_comment)
 848         *cp = ' ';
 849       cp++;
 850     }
 851 }
 852
 853 /* Prepares LINE, which is subject to the given SYNTAX rules, for
 854    tokenization by stripping comments and determining whether it
 855    is the beginning or end of a command and storing into
 856    *LINE_STARTS_COMMAND and *LINE_ENDS_COMMAND appropriately. */
 857 void
 858 lex_preprocess_line (struct string *line,
 859                      enum syntax_mode syntax,
 860                      bool *line_starts_command,
 861                      bool *line_ends_command)
 862 {
 863   strip_comments (line);
 864   ds_rtrim (line, ss_cstr (CC_SPACES));
 865   *line_ends_command = (ds_chomp (line, settings_get_endcmd ())
 866                         || (ds_is_empty (line) && settings_get_nulline ()));
 867   *line_starts_command = false;
 868   if (syntax == GETL_BATCH)
 869     {
 870       int first = ds_first (line);
 871       *line_starts_command = !c_isspace (first);
 872       if (first == '+' || first == '-')
 873         *ds_data (line) = ' ';
 874     }
 875 }
 876
 877 /* Reads a line, without performing any preprocessing. */
 878 bool
 879 lex_get_line_raw (struct lexer *lexer)
 880 {
 881   bool ok = getl_read_line (lexer->ss, &lexer->line_buffer);
 882   if (ok)
 883     {
 884       const char *line = ds_cstr (&lexer->line_buffer);
 885       journal_write (lex_current_syntax_mode (lexer) == GETL_BATCH, line);
 886       text_item_submit (text_item_create (TEXT_ITEM_SYNTAX, line));
 887     }
 888   return ok;
 889 }
 890
 891 /* Reads a line for use by the tokenizer, and preprocesses it by
 892    removing comments, stripping trailing whitespace and the
 893    terminal dot, and removing leading indentors. */
 894 bool
 895 lex_get_line (struct lexer *lexer)
 896 {
 897   bool line_starts_command;
 898
 899   if (!lex_get_line_raw (lexer))
 900     {
 901       lexer->prog = NULL;
 902       return false;
 903     }
 904
 905   lex_preprocess_line (&lexer->line_buffer,
 906                        lex_current_syntax_mode (lexer),
 907                        &line_starts_command, &lexer->dot);
 908
 909   if (line_starts_command)
 910     lexer->put_token = '.';
 911
 912   lexer->prog = ds_cstr (&lexer->line_buffer);
 913   return true;
 914 }
 915 \f
 916 /* Token names. */
 917
 918 /* Returns the name of a token. */
 919 const char *
 920 lex_token_name (int token)
 921 {
 922   if (lex_is_keyword (token))
 923     return lex_id_name (token);
 924   else if (token < 256)
 925     {
 926       static char t[256][2];
 927       char *s = t[token];
 928       s[0] = token;
 929       s[1] = '\0';
 930       return s;
 931     }
 932   else
 933     NOT_REACHED ();
 934 }
 935
 936 /* Returns an ASCII representation of the current token as a
 937    malloc()'d string. */
 938 char *
 939 lex_token_representation (struct lexer *lexer)
 940 {
 941   char *token_rep;
 942
 943   switch (lexer->token)
 944     {
 945     case T_ID:
 946     case T_POS_NUM:
 947     case T_NEG_NUM:
 948       return ds_xstrdup (&lexer->tokstr);
 949       break;
 950
 951     case T_STRING:
 952       {
 953         int hexstring = 0;
 954         char *sp, *dp;
 955
 956         for (sp = ds_cstr (&lexer->tokstr); sp < ds_end (&lexer->tokstr); sp++)
 957           if (!c_isprint ((unsigned char) *sp))
 958             {
 959               hexstring = 1;
 960               break;
 961             }
 962
 963         token_rep = xmalloc (2 + ds_length (&lexer->tokstr) * 2 + 1 + 1);
 964
 965         dp = token_rep;
 966         if (hexstring)
 967           *dp++ = 'X';
 968         *dp++ = '\'';
 969
 970         if (!hexstring)
 971           for (sp = ds_cstr (&lexer->tokstr); *sp; )
 972             {
 973               if (*sp == '\'')
 974                 *dp++ = '\'';
 975               *dp++ = (unsigned char) *sp++;
 976             }
 977         else
 978           for (sp = ds_cstr (&lexer->tokstr); sp < ds_end (&lexer->tokstr); sp++)
 979             {
 980               *dp++ = (((unsigned char) *sp) >> 4)["0123456789ABCDEF"];
 981               *dp++ = (((unsigned char) *sp) & 15)["0123456789ABCDEF"];
 982             }
 983         *dp++ = '\'';
 984         *dp = '\0';
 985
 986         return token_rep;
 987       }
 988     break;
 989
 990     case T_STOP:
 991       token_rep = xmalloc (1);
 992       *token_rep = '\0';
 993       return token_rep;
 994
 995     case T_EXP:
 996       return xstrdup ("**");
 997
 998     default:
 999       return xstrdup (lex_token_name (lexer->token));
1000     }
1001
1002   NOT_REACHED ();
1003 }
1004 \f
1005 /* Really weird functions. */
1006
1007 /* Most of the time, a `-' is a lead-in to a negative number.  But
1008    sometimes it's actually part of the syntax.  If a dash can be part
1009    of syntax then this function is called to rip it off of a
1010    number. */
1011 void
1012 lex_negative_to_dash (struct lexer *lexer)
1013 {
1014   if (lexer->token == T_NEG_NUM)
1015     {
1016       lexer->token = T_POS_NUM;
1017       lexer->tokval = -lexer->tokval;
1018       ds_assign_substring (&lexer->tokstr, ds_substr (&lexer->tokstr, 1, SIZE_MAX));
1019       save_token (lexer);
1020       lexer->token = '-';
1021     }
1022 }
1023
1024 /* Skip a COMMENT command. */
1025 void
1026 lex_skip_comment (struct lexer *lexer)
1027 {
1028   for (;;)
1029     {
1030       if (!lex_get_line (lexer))
1031         {
1032           lexer->put_token = T_STOP;
1033           lexer->prog = NULL;
1034           return;
1035         }
1036
1037       if (lexer->put_token == '.')
1038         break;
1039
1040       ds_cstr (&lexer->line_buffer); /* Ensures ds_end will point to a valid char */
1041       lexer->prog = ds_end (&lexer->line_buffer);
1042       if (lexer->dot)
1043         break;
1044     }
1045 }
1046 \f
1047 /* Private functions. */
1048
1049 /* When invoked, tokstr contains a string of binary, octal, or
1050    hex digits, according to TYPE.  The string is converted to
1051    characters having the specified values. */
1052 static void
1053 convert_numeric_string_to_char_string (struct lexer *lexer,
1054                                        enum string_type type)
1055 {
1056   const char *base_name;
1057   int base;
1058   int chars_per_byte;
1059   size_t byte_cnt;
1060   size_t i;
1061   char *p;
1062
1063   switch (type)
1064     {
1065     case BINARY_STRING:
1066       base_name = _("binary");
1067       base = 2;
1068       chars_per_byte = 8;
1069       break;
1070     case OCTAL_STRING:
1071       base_name = _("octal");
1072       base = 8;
1073       chars_per_byte = 3;
1074       break;
1075     case HEX_STRING:
1076       base_name = _("hex");
1077       base = 16;
1078       chars_per_byte = 2;
1079       break;
1080     default:
1081       NOT_REACHED ();
1082     }
1083
1084   byte_cnt = ds_length (&lexer->tokstr) / chars_per_byte;
1085   if (ds_length (&lexer->tokstr) % chars_per_byte)
1086     msg (SE, _("String of %s digits has %zu characters, which is not a "
1087                "multiple of %d."),
1088          base_name, ds_length (&lexer->tokstr), chars_per_byte);
1089
1090   p = ds_cstr (&lexer->tokstr);
1091   for (i = 0; i < byte_cnt; i++)
1092     {
1093       int value;
1094       int j;
1095
1096       value = 0;
1097       for (j = 0; j < chars_per_byte; j++, p++)
1098         {
1099           int v;
1100
1101           if (*p >= '0' && *p <= '9')
1102             v = *p - '0';
1103           else
1104             {
1105               static const char alpha[] = "abcdef";
1106               const char *q = strchr (alpha, tolower ((unsigned char) *p));
1107
1108               if (q)
1109                 v = q - alpha + 10;
1110               else
1111                 v = base;
1112             }
1113
1114           if (v >= base)
1115             msg (SE, _("`%c' is not a valid %s digit."), *p, base_name);
1116
1117           value = value * base + v;
1118         }
1119
1120       ds_cstr (&lexer->tokstr)[i] = (unsigned char) value;
1121     }
1122
1123   ds_truncate (&lexer->tokstr, byte_cnt);
1124 }
1125
1126 /* Parses a string from the input buffer into tokstr.  The input
1127    buffer pointer lexer->prog must point to the initial single or double
1128    quote.  TYPE indicates the type of string to be parsed.
1129    Returns token type. */
1130 static int
1131 parse_string (struct lexer *lexer, enum string_type type)
1132 {
1133   if (type != CHARACTER_STRING)
1134     lexer->prog++;
1135
1136   /* Accumulate the entire string, joining sections indicated by +
1137      signs. */
1138   for (;;)
1139     {
1140       /* Single or double quote. */
1141       int c = *lexer->prog++;
1142
1143       /* Accumulate section. */
1144       for (;;)
1145         {
1146           /* Check end of line. */
1147           if (*lexer->prog == '\0')
1148             {
1149               msg (SE, _("Unterminated string constant."));
1150               goto finish;
1151             }
1152
1153           /* Double quote characters to embed them in strings. */
1154           if (*lexer->prog == c)
1155             {
1156               if (lexer->prog[1] == c)
1157                 lexer->prog++;
1158               else
1159                 break;
1160             }
1161
1162           ds_put_char (&lexer->tokstr, *lexer->prog++);
1163         }
1164       lexer->prog++;
1165
1166       /* Skip whitespace after final quote mark. */
1167       if (lexer->prog == NULL)
1168         break;
1169       for (;;)
1170         {
1171           while (c_isspace ((unsigned char) *lexer->prog))
1172             lexer->prog++;
1173           if (*lexer->prog)
1174             break;
1175
1176           if (lexer->dot)
1177             goto finish;
1178
1179           if (!lex_get_line (lexer))
1180             goto finish;
1181         }
1182
1183       /* Skip plus sign. */
1184       if (*lexer->prog != '+')
1185         break;
1186       lexer->prog++;
1187
1188       /* Skip whitespace after plus sign. */
1189       if (lexer->prog == NULL)
1190         break;
1191       for (;;)
1192         {
1193           while (c_isspace ((unsigned char) *lexer->prog))
1194             lexer->prog++;
1195           if (*lexer->prog)
1196             break;
1197
1198           if (lexer->dot)
1199             goto finish;
1200
1201           if (!lex_get_line (lexer))
1202             {
1203               msg (SE, _("Unexpected end of file in string concatenation."));
1204               goto finish;
1205             }
1206         }
1207
1208       /* Ensure that a valid string follows. */
1209       if (*lexer->prog != '\'' && *lexer->prog != '"')
1210         {
1211           msg (SE, _("String expected following `+'."));
1212           goto finish;
1213         }
1214     }
1215
1216   /* We come here when we've finished concatenating all the string sections
1217      into one large string. */
1218 finish:
1219   if (type != CHARACTER_STRING)
1220     convert_numeric_string_to_char_string (lexer, type);
1221
1222   if (ds_length (&lexer->tokstr) > 255)
1223     {
1224       msg (SE, _("String exceeds 255 characters in length (%zu characters)."),
1225            ds_length (&lexer->tokstr));
1226       ds_truncate (&lexer->tokstr, 255);
1227     }
1228
1229   return T_STRING;
1230 }
1231 \f
1232 #if DUMP_TOKENS
1233 /* Reads one token from the lexer and writes a textual representation
1234    on stdout for debugging purposes. */
1235 static void
1236 dump_token (struct lexer *lexer)
1237 {
1238   {
1239     const char *curfn;
1240     int curln;
1241
1242     curln = getl_source_location (lexer->ss);
1243     curfn = getl_source_name (lexer->ss);
1244     if (curfn)
1245       fprintf (stderr, "%s:%d\t", curfn, curln);
1246   }
1247
1248   switch (lexer->token)
1249     {
1250     case T_ID:
1251       fprintf (stderr, "ID\t%s\n", lexer->tokid);
1252       break;
1253
1254     case T_POS_NUM:
1255     case T_NEG_NUM:
1256       fprintf (stderr, "NUM\t%f\n", lexer->tokval);
1257       break;
1258
1259     case T_STRING:
1260       fprintf (stderr, "STRING\t\"%s\"\n", ds_cstr (&lexer->tokstr));
1261       break;
1262
1263     case T_STOP:
1264       fprintf (stderr, "STOP\n");
1265       break;
1266
1267     case T_EXP:
1268       fprintf (stderr, "MISC\tEXP\"");
1269       break;
1270
1271     case 0:
1272       fprintf (stderr, "MISC\tEOF\n");
1273       break;
1274
1275     default:
1276       if (lex_is_keyword (lexer->token))
1277         fprintf (stderr, "KEYWORD\t%s\n", lex_token_name (lexer->token));
1278       else
1279         fprintf (stderr, "PUNCT\t%c\n", lexer->token);
1280       break;
1281     }
1282 }
1283 #endif /* DUMP_TOKENS */
1284
1285
1286 /* Token Accessor Functions */
1287
1288 int
1289 lex_token (const struct lexer *lexer)
1290 {
1291   return lexer->token;
1292 }
1293
1294 double
1295 lex_tokval (const struct lexer *lexer)
1296 {
1297   return lexer->tokval;
1298 }
1299
1300 const char *
1301 lex_tokid (const struct lexer *lexer)
1302 {
1303   return lexer->tokid;
1304 }
1305
1306 const struct string *
1307 lex_tokstr (const struct lexer *lexer)
1308 {
1309   return &lexer->tokstr;
1310 }
1311
1312 /* If the lexer is positioned at the (pseudo)identifier S, which
1313    may contain a hyphen ('-'), skips it and returns true.  Each
1314    half of the identifier may be abbreviated to its first three
1315    letters.
1316    Otherwise, returns false. */
1317 bool
1318 lex_match_hyphenated_word (struct lexer *lexer, const char *s)
1319 {
1320   const char *hyphen = strchr (s, '-');
1321   if (hyphen == NULL)
1322     return lex_match_id (lexer, s);
1323   else if (lexer->token != T_ID
1324            || !lex_id_match (ss_buffer (s, hyphen - s), ss_cstr (lexer->tokid))
1325            || lex_look_ahead (lexer) != '-')
1326     return false;
1327   else
1328     {
1329       lex_get (lexer);
1330       lex_force_match (lexer, '-');
1331       lex_force_match_id (lexer, hyphen + 1);
1332       return true;
1333     }
1334 }
1335