src/reader.c

   1 /* Input parser for Bison
   2
   3    Copyright (C) 1984, 1986, 1989, 1992, 1998, 2000, 2001, 2002, 2003,
   4    2005, 2006 Free Software Foundation, Inc.
   5
   6    This file is part of Bison, the GNU Compiler Compiler.
   7
   8    Bison is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 2, or (at your option)
  11    any later version.
  12
  13    Bison is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with Bison; see the file COPYING.  If not, write to
  20    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  21    Boston, MA 02110-1301, USA.  */
  22
  23 #include <config.h>
  24 #include "system.h"
  25
  26 #include <quotearg.h>
  27
  28 #include "complain.h"
  29 #include "conflicts.h"
  30 #include "files.h"
  31 #include "getargs.h"
  32 #include "gram.h"
  33 #include "muscle_tab.h"
  34 #include "reader.h"
  35 #include "symlist.h"
  36 #include "symtab.h"
  37 #include "scan-gram.h"
  38 #include "scan-code.h"
  39
  40 static void check_and_convert_grammar (void);
  41
  42 static symbol_list *grammar = NULL;
  43 static bool start_flag = false;
  44 merger_list *merge_functions;
  45
  46 /* Was %union seen?  */
  47 bool union_seen = false;
  48
  49 /* Was a tag seen?  */
  50 bool tag_seen = false;
  51
  52 /* Should rules have a default precedence?  */
  53 bool default_prec = true;
  54 \f
  55 /*-----------------------.
  56 | Set the start symbol.  |
  57 `-----------------------*/
  58
  59 void
  60 grammar_start_symbol_set (symbol *sym, location loc)
  61 {
  62   if (start_flag)
  63     complain_at (loc, _("multiple %s declarations"), "%start");
  64   else
  65     {
  66       start_flag = true;
  67       startsymbol = sym;
  68       startsymbol_location = loc;
  69     }
  70 }
  71
  72
  73 /*---------------------------------------------------------------------.
  74 | There are two prologues: one before the first %union and one after.  |
  75 | Augment the one specified by POST.                                   |
  76 `---------------------------------------------------------------------*/
  77
  78 void
  79 prologue_augment (const char *prologue, location loc, bool post)
  80 {
  81   struct obstack *oout =
  82     !post ? &pre_prologue_obstack : &post_prologue_obstack;
  83
  84   obstack_fgrow1 (oout, "]b4_syncline(%d, [[", loc.start.line);
  85   /* FIXME: Protection of M4 characters missing here.  See
  86      output.c:escaped_output.  */
  87   MUSCLE_OBSTACK_SGROW (oout,
  88                         quotearg_style (c_quoting_style, loc.start.file));
  89   obstack_sgrow (oout, "]])[\n");
  90   obstack_sgrow (oout, prologue);
  91 }
  92
  93 \f
  94
  95 /*------------------------------------------------------------------------.
  96 | Return the merger index for a merging function named NAME.  Records the |
  97 | function, if new, in MERGER_LIST.                                       |
  98 `------------------------------------------------------------------------*/
  99
 100 static int
 101 get_merge_function (uniqstr name)
 102 {
 103   merger_list *syms;
 104   merger_list head;
 105   int n;
 106
 107   if (! glr_parser)
 108     return 0;
 109
 110   head.next = merge_functions;
 111   for (syms = &head, n = 1; syms->next; syms = syms->next, n += 1)
 112     if (UNIQSTR_EQ (name, syms->next->name))
 113       break;
 114   if (syms->next == NULL)
 115     {
 116       syms->next = xmalloc (sizeof syms->next[0]);
 117       syms->next->name = uniqstr_new (name);
 118       /* After all symbol type declarations have been parsed, packgram invokes
 119          record_merge_function_type to set the type.  */
 120       syms->next->type = NULL;
 121       syms->next->next = NULL;
 122       merge_functions = head.next;
 123     }
 124   return n;
 125 }
 126
 127 /*-------------------------------------------------------------------------.
 128 | For the existing merging function with index MERGER, record the result   |
 129 | type as TYPE as required by the lhs of the rule whose %merge declaration |
 130 | is at DECLARATION_LOC.                                                   |
 131 `-------------------------------------------------------------------------*/
 132
 133 static void
 134 record_merge_function_type (int merger, uniqstr type, location declaration_loc)
 135 {
 136   int merger_find;
 137   merger_list *merge_function;
 138
 139   if (merger <= 0)
 140     return;
 141
 142   if (type == NULL)
 143     type = uniqstr_new ("");
 144
 145   merger_find = 1;
 146   for (merge_function = merge_functions;
 147        merge_function != NULL && merger_find != merger;
 148        merge_function = merge_function->next)
 149     merger_find += 1;
 150   aver (merge_function != NULL && merger_find == merger);
 151   if (merge_function->type != NULL && !UNIQSTR_EQ (merge_function->type, type))
 152     {
 153       complain_at (declaration_loc,
 154                    _("result type clash on merge function `%s': <%s> != <%s>"),
 155                    merge_function->name, type, merge_function->type);
 156       complain_at (merge_function->type_declaration_location,
 157                    _("previous declaration"));
 158     }
 159   merge_function->type = uniqstr_new (type);
 160   merge_function->type_declaration_location = declaration_loc;
 161 }
 162
 163 /*--------------------------------------.
 164 | Free all merge-function definitions.  |
 165 `--------------------------------------*/
 166
 167 void
 168 free_merger_functions (void)
 169 {
 170   merger_list *L0 = merge_functions;
 171   while (L0)
 172     {
 173       merger_list *L1 = L0->next;
 174       free (L0);
 175       L0 = L1;
 176     }
 177 }
 178
 179 \f
 180 /*-------------------------------------------------------------------.
 181 | Parse the input grammar into a one symbol_list structure.  Each    |
 182 | rule is represented by a sequence of symbols: the left hand side   |
 183 | followed by the contents of the right hand side, followed by a     |
 184 | null pointer instead of a symbol to terminate the rule.  The next  |
 185 | symbol is the lhs of the following rule.                           |
 186 |                                                                    |
 187 | All actions are copied out, labelled by the rule number they apply |
 188 | to.                                                                |
 189 `-------------------------------------------------------------------*/
 190
 191 /* The (currently) last symbol of GRAMMAR. */
 192 static symbol_list *grammar_end = NULL;
 193
 194 /* Append SYM to the grammar.  */
 195 static void
 196 grammar_symbol_append (symbol *sym, location loc)
 197 {
 198   symbol_list *p = symbol_list_sym_new (sym, loc);
 199
 200   if (grammar_end)
 201     grammar_end->next = p;
 202   else
 203     grammar = p;
 204
 205   grammar_end = p;
 206
 207   /* A null SYM stands for an end of rule; it is not an actual
 208      part of it.  */
 209   if (sym)
 210     ++nritems;
 211 }
 212
 213 /* The rule currently being defined, and the previous rule.
 214    CURRENT_RULE points to the first LHS of the current rule, while
 215    PREVIOUS_RULE_END points to the *end* of the previous rule (NULL).  */
 216 static symbol_list *current_rule = NULL;
 217 static symbol_list *previous_rule_end = NULL;
 218
 219
 220 /*----------------------------------------------.
 221 | Create a new rule for LHS in to the GRAMMAR.  |
 222 `----------------------------------------------*/
 223
 224 void
 225 grammar_current_rule_begin (symbol *lhs, location loc)
 226 {
 227   /* Start a new rule and record its lhs.  */
 228   ++nrules;
 229   previous_rule_end = grammar_end;
 230   grammar_symbol_append (lhs, loc);
 231   current_rule = grammar_end;
 232
 233   /* Mark the rule's lhs as a nonterminal if not already so.  */
 234   if (lhs->class == unknown_sym)
 235     {
 236       lhs->class = nterm_sym;
 237       lhs->number = nvars;
 238       ++nvars;
 239     }
 240   else if (lhs->class == token_sym)
 241     complain_at (loc, _("rule given for %s, which is a token"), lhs->tag);
 242 }
 243
 244
 245 /*----------------------------------------------------------------------.
 246 | A symbol should be used if either:                                    |
 247 |   1. It has a destructor.                                             |
 248 |   2. --warnings=midrule-values and the symbol is a mid-rule symbol    |
 249 |      (i.e., the generated LHS replacing a mid-rule action) that was   |
 250 |      assigned to or used, as in "exp: { $$ = 1; } { $$ = $1; }".      |
 251 `----------------------------------------------------------------------*/
 252
 253 static bool
 254 symbol_should_be_used (symbol_list const *s)
 255 {
 256   if (symbol_destructor_get (s->content.sym))
 257     return true;
 258   if (warnings_flag & warnings_midrule_values)
 259     return ((s->midrule && s->midrule->used)
 260             || (s->midrule_parent_rule
 261                 && symbol_list_n_get (s->midrule_parent_rule,
 262                                       s->midrule_parent_rhs_index)->used));
 263   return false;
 264 }
 265
 266 /*----------------------------------------------------------------.
 267 | Check that the rule R is properly defined.  For instance, there |
 268 | should be no type clash on the default action.                  |
 269 `----------------------------------------------------------------*/
 270
 271 static void
 272 grammar_rule_check (const symbol_list *r)
 273 {
 274   /* Type check.
 275
 276      If there is an action, then there is nothing we can do: the user
 277      is allowed to shoot herself in the foot.
 278
 279      Don't worry about the default action if $$ is untyped, since $$'s
 280      value can't be used.  */
 281   if (!r->action && r->content.sym->type_name)
 282     {
 283       symbol *first_rhs = r->next->content.sym;
 284       /* If $$ is being set in default way, report if any type mismatch.  */
 285       if (first_rhs)
 286         {
 287           char const *lhs_type = r->content.sym->type_name;
 288           const char *rhs_type =
 289             first_rhs->type_name ? first_rhs->type_name : "";
 290           if (!UNIQSTR_EQ (lhs_type, rhs_type))
 291             warn_at (r->location,
 292                      _("type clash on default action: <%s> != <%s>"),
 293                      lhs_type, rhs_type);
 294         }
 295       /* Warn if there is no default for $$ but we need one.  */
 296       else
 297         warn_at (r->location,
 298                  _("empty rule for typed nonterminal, and no action"));
 299     }
 300
 301   /* Check that symbol values that should be used are in fact used.  */
 302   {
 303     symbol_list const *l = r;
 304     int n = 0;
 305     for (; l && l->content.sym; l = l->next, ++n)
 306       if (! (l->used
 307              || !symbol_should_be_used (l)
 308              /* The default action, $$ = $1, `uses' both.  */
 309              || (!r->action && (n == 0 || n == 1))))
 310         {
 311           if (n)
 312             warn_at (r->location, _("unused value: $%d"), n);
 313           else
 314             warn_at (r->location, _("unset value: $$"));
 315         }
 316   }
 317 }
 318
 319
 320 /*-------------------------------------.
 321 | End the currently being grown rule.  |
 322 `-------------------------------------*/
 323
 324 void
 325 grammar_current_rule_end (location loc)
 326 {
 327   /* Put an empty link in the list to mark the end of this rule  */
 328   grammar_symbol_append (NULL, grammar_end->location);
 329   current_rule->location = loc;
 330 }
 331
 332
 333 /*-------------------------------------------------------------------.
 334 | The previous action turns out the be a mid-rule action.  Attach it |
 335 | to the current rule, i.e., create a dummy symbol, attach it this   |
 336 | mid-rule action, and append this dummy nonterminal to the current  |
 337 | rule.                                                              |
 338 `-------------------------------------------------------------------*/
 339
 340 void
 341 grammar_midrule_action (void)
 342 {
 343   /* Since the action was written out with this rule's number, we must
 344      give the new rule this number by inserting the new rule before
 345      it.  */
 346
 347   /* Make a DUMMY nonterminal, whose location is that of the midrule
 348      action.  Create the MIDRULE.  */
 349   location dummy_location = current_rule->action_location;
 350   symbol *dummy = dummy_symbol_get (dummy_location);
 351   symbol_list *midrule = symbol_list_sym_new (dummy, dummy_location);
 352
 353   /* Make a new rule, whose body is empty, before the current one, so
 354      that the action just read can belong to it.  */
 355   ++nrules;
 356   ++nritems;
 357   /* Attach its location and actions to that of the DUMMY.  */
 358   midrule->location = dummy_location;
 359   midrule->action = current_rule->action;
 360   midrule->action_location = dummy_location;
 361   current_rule->action = NULL;
 362   /* The action has not been translated yet, so $$ use hasn't been
 363      detected yet.  */
 364   midrule->used = false;
 365
 366   if (previous_rule_end)
 367     previous_rule_end->next = midrule;
 368   else
 369     grammar = midrule;
 370
 371   /* End the dummy's rule.  */
 372   midrule->next = symbol_list_sym_new (NULL, dummy_location);
 373   midrule->next->next = current_rule;
 374
 375   previous_rule_end = midrule->next;
 376
 377   /* Insert the dummy nonterminal replacing the midrule action into
 378      the current rule.  Bind it to its dedicated rule.  */
 379   grammar_current_rule_symbol_append (dummy, dummy_location);
 380   grammar_end->midrule = midrule;
 381   midrule->midrule_parent_rule = current_rule;
 382   midrule->midrule_parent_rhs_index = symbol_list_length (current_rule->next);
 383 }
 384
 385 /* Set the precedence symbol of the current rule to PRECSYM. */
 386
 387 void
 388 grammar_current_rule_prec_set (symbol *precsym, location loc)
 389 {
 390   symbol_class_set (precsym, token_sym, loc, false);
 391   if (current_rule->ruleprec)
 392     complain_at (loc, _("only one %s allowed per rule"), "%prec");
 393   current_rule->ruleprec = precsym;
 394 }
 395
 396 /* Attach dynamic precedence DPREC to the current rule. */
 397
 398 void
 399 grammar_current_rule_dprec_set (int dprec, location loc)
 400 {
 401   if (! glr_parser)
 402     warn_at (loc, _("%s affects only GLR parsers"), "%dprec");
 403   if (dprec <= 0)
 404     complain_at (loc, _("%s must be followed by positive number"), "%dprec");
 405   else if (current_rule->dprec != 0)
 406     complain_at (loc, _("only one %s allowed per rule"), "%dprec");
 407   current_rule->dprec = dprec;
 408 }
 409
 410 /* Attach a merge function NAME with argument type TYPE to current
 411    rule. */
 412
 413 void
 414 grammar_current_rule_merge_set (uniqstr name, location loc)
 415 {
 416   if (! glr_parser)
 417     warn_at (loc, _("%s affects only GLR parsers"), "%merge");
 418   if (current_rule->merger != 0)
 419     complain_at (loc, _("only one %s allowed per rule"), "%merge");
 420   current_rule->merger = get_merge_function (name);
 421   current_rule->merger_declaration_location = loc;
 422 }
 423
 424 /* Attach SYM to the current rule.  If needed, move the previous
 425    action as a mid-rule action.  */
 426
 427 void
 428 grammar_current_rule_symbol_append (symbol *sym, location loc)
 429 {
 430   if (current_rule->action)
 431     grammar_midrule_action ();
 432   grammar_symbol_append (sym, loc);
 433 }
 434
 435 /* Attach an ACTION to the current rule.  */
 436
 437 void
 438 grammar_current_rule_action_append (const char *action, location loc)
 439 {
 440   if (current_rule->action)
 441     grammar_midrule_action ();
 442   /* After all symbol declarations have been parsed, packgram invokes
 443      translate_rule_action.  */
 444   current_rule->action = action;
 445   current_rule->action_location = loc;
 446 }
 447
 448 \f
 449 /*---------------------------------------------------------------.
 450 | Convert the rules into the representation using RRHS, RLHS and |
 451 | RITEM.                                                         |
 452 `---------------------------------------------------------------*/
 453
 454 static void
 455 packgram (void)
 456 {
 457   unsigned int itemno = 0;
 458   rule_number ruleno = 0;
 459   symbol_list *p = grammar;
 460
 461   ritem = xnmalloc (nritems + 1, sizeof *ritem);
 462
 463   /* This sentinel is used by build_relations in gram.c.  */
 464   *ritem++ = 0;
 465
 466   rules = xnmalloc (nrules, sizeof *rules);
 467
 468   /* Before invoking grammar_rule_check on any rule, make sure all actions have
 469      already been scanned in order to set `used' flags.  Otherwise, checking
 470      that a midrule's $$ should be set will not always work properly because
 471      the check must forward-reference the midrule's parent rule.  For the same
 472      reason, all the `used' flags must be set before checking whether to remove
 473      `$' from any midrule symbol name.  */
 474   while (p)
 475     {
 476       if (p->action)
 477         p->action = translate_rule_action (p);
 478       if (p)
 479         p = p->next;
 480     }
 481
 482   p = grammar;
 483   while (p)
 484     {
 485       int rule_length = 0;
 486       symbol *ruleprec = p->ruleprec;
 487       record_merge_function_type (p->merger, p->content.sym->type_name,
 488                                   p->merger_declaration_location);
 489       rules[ruleno].user_number = ruleno;
 490       rules[ruleno].number = ruleno;
 491       rules[ruleno].lhs = p->content.sym;
 492       rules[ruleno].rhs = ritem + itemno;
 493       rules[ruleno].prec = NULL;
 494       rules[ruleno].dprec = p->dprec;
 495       rules[ruleno].merger = p->merger;
 496       rules[ruleno].precsym = NULL;
 497       rules[ruleno].location = p->location;
 498       rules[ruleno].useful = true;
 499       rules[ruleno].action = p->action;
 500       rules[ruleno].action_location = p->action_location;
 501
 502       /* If the midrule's $$ is set or its $n is used, remove the `$' from the
 503          symbol name so that it's a user-defined symbol so that the default
 504          %destructor and %printer apply.  */
 505       if (p->midrule_parent_rule
 506           && (p->used
 507               || symbol_list_n_get (p->midrule_parent_rule,
 508                                     p->midrule_parent_rhs_index)->used))
 509         p->content.sym->tag += 1;
 510
 511       /* Don't check the generated rule 0.  It has no action, so some rhs
 512          symbols may appear unused, but the parsing algorithm ensures that
 513          %destructor's are invoked appropriately.  */
 514       if (p != grammar)
 515         grammar_rule_check (p);
 516
 517       for (p = p->next; p && p->content.sym; p = p->next)
 518         {
 519           ++rule_length;
 520
 521           /* Don't allow rule_length == INT_MAX, since that might
 522              cause confusion with strtol if INT_MAX == LONG_MAX.  */
 523           if (rule_length == INT_MAX)
 524               fatal_at (rules[ruleno].location, _("rule is too long"));
 525
 526           /* item_number = symbol_number.
 527              But the former needs to contain more: negative rule numbers. */
 528           ritem[itemno++] =
 529             symbol_number_as_item_number (p->content.sym->number);
 530           /* A rule gets by default the precedence and associativity
 531              of its last token.  */
 532           if (p->content.sym->class == token_sym && default_prec)
 533             rules[ruleno].prec = p->content.sym;
 534         }
 535
 536       /* If this rule has a %prec,
 537          the specified symbol's precedence replaces the default.  */
 538       if (ruleprec)
 539         {
 540           rules[ruleno].precsym = ruleprec;
 541           rules[ruleno].prec = ruleprec;
 542         }
 543       /* An item ends by the rule number (negated).  */
 544       ritem[itemno++] = rule_number_as_item_number (ruleno);
 545       aver (itemno < ITEM_NUMBER_MAX);
 546       ++ruleno;
 547       aver (ruleno < RULE_NUMBER_MAX);
 548
 549       if (p)
 550         p = p->next;
 551     }
 552
 553   aver (itemno == nritems);
 554
 555   if (trace_flag & trace_sets)
 556     ritem_print (stderr);
 557 }
 558 \f
 559 /*------------------------------------------------------------------.
 560 | Read in the grammar specification and record it in the format     |
 561 | described in gram.h.  All actions are copied into ACTION_OBSTACK, |
 562 | in each case forming the body of a C function (YYACTION) which    |
 563 | contains a switch statement to decide which action to execute.    |
 564 `------------------------------------------------------------------*/
 565
 566 void
 567 reader (void)
 568 {
 569   /* Initialize the symbol table.  */
 570   symbols_new ();
 571
 572   /* Construct the accept symbol. */
 573   accept = symbol_get ("$accept", empty_location);
 574   accept->class = nterm_sym;
 575   accept->number = nvars++;
 576
 577   /* Construct the error token */
 578   errtoken = symbol_get ("error", empty_location);
 579   errtoken->class = token_sym;
 580   errtoken->number = ntokens++;
 581
 582   /* Construct a token that represents all undefined literal tokens.
 583      It is always token number 2.  */
 584   undeftoken = symbol_get ("$undefined", empty_location);
 585   undeftoken->class = token_sym;
 586   undeftoken->number = ntokens++;
 587
 588   /* Initialize the obstacks. */
 589   obstack_init (&pre_prologue_obstack);
 590   obstack_init (&post_prologue_obstack);
 591
 592   gram_in = xfopen (grammar_file, "r");
 593
 594   gram__flex_debug = trace_flag & trace_scan;
 595   gram_debug = trace_flag & trace_parse;
 596   gram_scanner_initialize ();
 597   gram_parse ();
 598
 599   if (! complaint_issued)
 600     check_and_convert_grammar ();
 601
 602   xfclose (gram_in);
 603 }
 604
 605
 606 /*-------------------------------------------------------------.
 607 | Check the grammar that has just been read, and convert it to |
 608 | internal form.                                               |
 609 `-------------------------------------------------------------*/
 610
 611 static void
 612 check_and_convert_grammar (void)
 613 {
 614   /* Grammar has been read.  Do some checking.  */
 615   if (nrules == 0)
 616     fatal (_("no rules in the input grammar"));
 617
 618   /* Report any undefined symbols and consider them nonterminals.  */
 619   symbols_check_defined ();
 620
 621   /* If the user did not define her ENDTOKEN, do it now. */
 622   if (!endtoken)
 623     {
 624       endtoken = symbol_get ("$end", empty_location);
 625       endtoken->class = token_sym;
 626       endtoken->number = 0;
 627       /* Value specified by POSIX.  */
 628       endtoken->user_token_number = 0;
 629     }
 630
 631   /* Find the start symbol if no %start.  */
 632   if (!start_flag)
 633     {
 634       symbol_list *node;
 635       for (node = grammar;
 636            node != NULL && symbol_is_dummy (node->content.sym);
 637            node = node->next)
 638         {
 639           for (node = node->next;
 640                node != NULL && node->content.sym != NULL;
 641                node = node->next)
 642             ;
 643         }
 644       aver (node != NULL);
 645       grammar_start_symbol_set (node->content.sym,
 646                                 node->content.sym->location);
 647     }
 648
 649   /* Insert the initial rule, whose line is that of the first rule
 650      (not that of the start symbol):
 651
 652      accept: %start EOF.  */
 653   {
 654     symbol_list *p = symbol_list_sym_new (accept, empty_location);
 655     p->location = grammar->location;
 656     p->next = symbol_list_sym_new (startsymbol, empty_location);
 657     p->next->next = symbol_list_sym_new (endtoken, empty_location);
 658     p->next->next->next = symbol_list_sym_new (NULL, empty_location);
 659     p->next->next->next->next = grammar;
 660     nrules += 1;
 661     nritems += 3;
 662     grammar = p;
 663   }
 664
 665   aver (nsyms <= SYMBOL_NUMBER_MAXIMUM && nsyms == ntokens + nvars);
 666
 667   /* Assign the symbols their symbol numbers.  Write #defines for the
 668      token symbols into FDEFINES if requested.  */
 669   symbols_pack ();
 670
 671   /* Convert the grammar into the format described in gram.h.  */
 672   packgram ();
 673
 674   /* The grammar as a symbol_list is no longer needed. */
 675   symbol_list_free (grammar);
 676 }