1 /* Input parser for Bison
3 Copyright (C) 1984, 1986, 1989, 1992, 1998, 2000-2003, 2005-2007,
4 2009-2013 Free Software Foundation, Inc.
6 This file is part of Bison, the GNU Compiler Compiler.
8 This program 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 3 of the License, or
11 (at your option) any later version.
13 This program 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.
18 You should have received a copy of the GNU General Public License
19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
27 #include "conflicts.h"
31 #include "muscle-tab.h"
35 #include "scan-gram.h"
36 #include "scan-code.h"
38 static void prepare_percent_define_front_end_variables (void);
39 static void check_and_convert_grammar (void);
41 static symbol_list
*grammar
= NULL
;
42 static bool start_flag
= false;
43 merger_list
*merge_functions
;
45 /* Was %union seen? */
46 bool union_seen
= false;
49 bool tag_seen
= false;
51 /* Should rules have a default precedence? */
52 bool default_prec
= true;
54 /*-----------------------.
55 | Set the start symbol. |
56 `-----------------------*/
59 grammar_start_symbol_set (symbol
*sym
, location loc
)
62 complain (&loc
, complaint
, _("multiple %s declarations"), "%start");
67 startsymbol_location
= loc
;
73 /*------------------------------------------------------------------------.
74 | Return the merger index for a merging function named NAME. Records the |
75 | function, if new, in MERGER_LIST. |
76 `------------------------------------------------------------------------*/
79 get_merge_function (uniqstr name
)
88 head
.next
= merge_functions
;
89 for (syms
= &head
, n
= 1; syms
->next
; syms
= syms
->next
, n
+= 1)
90 if (UNIQSTR_EQ (name
, syms
->next
->name
))
92 if (syms
->next
== NULL
)
94 syms
->next
= xmalloc (sizeof syms
->next
[0]);
95 syms
->next
->name
= uniqstr_new (name
);
96 /* After all symbol type declarations have been parsed, packgram invokes
97 record_merge_function_type to set the type. */
98 syms
->next
->type
= NULL
;
99 syms
->next
->next
= NULL
;
100 merge_functions
= head
.next
;
105 /*-------------------------------------------------------------------------.
106 | For the existing merging function with index MERGER, record the result |
107 | type as TYPE as required by the lhs of the rule whose %merge declaration |
108 | is at DECLARATION_LOC. |
109 `-------------------------------------------------------------------------*/
112 record_merge_function_type (int merger
, uniqstr type
, location declaration_loc
)
115 merger_list
*merge_function
;
121 type
= uniqstr_new ("");
124 for (merge_function
= merge_functions
;
125 merge_function
!= NULL
&& merger_find
!= merger
;
126 merge_function
= merge_function
->next
)
128 aver (merge_function
!= NULL
&& merger_find
== merger
);
129 if (merge_function
->type
!= NULL
&& !UNIQSTR_EQ (merge_function
->type
, type
))
132 complain_indent (&declaration_loc
, complaint
, &indent
,
133 _("result type clash on merge function %s: "
135 quote (merge_function
->name
), type
,
136 merge_function
->type
);
137 indent
+= SUB_INDENT
;
138 complain_indent (&merge_function
->type_declaration_location
, complaint
,
140 _("previous declaration"));
142 merge_function
->type
= uniqstr_new (type
);
143 merge_function
->type_declaration_location
= declaration_loc
;
146 /*--------------------------------------.
147 | Free all merge-function definitions. |
148 `--------------------------------------*/
151 free_merger_functions (void)
153 merger_list
*L0
= merge_functions
;
156 merger_list
*L1
= L0
->next
;
163 /*-------------------------------------------------------------------.
164 | Parse the input grammar into a one symbol_list structure. Each |
165 | rule is represented by a sequence of symbols: the left hand side |
166 | followed by the contents of the right hand side, followed by a |
167 | null pointer instead of a symbol to terminate the rule. The next |
168 | symbol is the lhs of the following rule. |
170 | All actions are copied out, labelled by the rule number they apply |
172 `-------------------------------------------------------------------*/
174 /* The (currently) last symbol of GRAMMAR. */
175 static symbol_list
*grammar_end
= NULL
;
177 /* Append SYM to the grammar. */
179 grammar_symbol_append (symbol
*sym
, location loc
)
181 symbol_list
*p
= symbol_list_sym_new (sym
, loc
);
184 grammar_end
->next
= p
;
190 /* A null SYM stands for an end of rule; it is not an actual
199 assign_named_ref (symbol_list
*p
, named_ref
*name
)
201 symbol
*sym
= p
->content
.sym
;
203 if (name
->id
== sym
->tag
)
205 complain (&name
->loc
, Wother
,
206 _("duplicated symbol name for %s ignored"),
208 named_ref_free (name
);
215 /* The rule currently being defined, and the previous rule.
216 CURRENT_RULE points to the first LHS of the current rule, while
217 PREVIOUS_RULE_END points to the *end* of the previous rule (NULL). */
218 static symbol_list
*current_rule
= NULL
;
219 static symbol_list
*previous_rule_end
= NULL
;
222 /*----------------------------------------------.
223 | Create a new rule for LHS in to the GRAMMAR. |
224 `----------------------------------------------*/
227 grammar_current_rule_begin (symbol
*lhs
, location loc
,
232 /* Start a new rule and record its lhs. */
234 previous_rule_end
= grammar_end
;
236 p
= grammar_symbol_append (lhs
, loc
);
238 assign_named_ref (p
, named_ref_copy (lhs_name
));
240 current_rule
= grammar_end
;
242 /* Mark the rule's lhs as a nonterminal if not already so. */
243 if (lhs
->class == unknown_sym
)
245 lhs
->class = nterm_sym
;
249 else if (lhs
->class == token_sym
)
250 complain (&loc
, complaint
, _("rule given for %s, which is a token"),
255 /*----------------------------------------------------------------------.
256 | A symbol should be used if either: |
257 | 1. It has a destructor. |
258 | 2. The symbol is a mid-rule symbol (i.e., the generated LHS |
259 | replacing a mid-rule action) that was assigned to or used, as in |
260 | "exp: { $$ = 1; } { $$ = $1; }". |
261 `----------------------------------------------------------------------*/
264 symbol_should_be_used (symbol_list
const *s
, bool *midrule_warning
)
266 if (symbol_code_props_get (s
->content
.sym
, destructor
)->code
)
268 if ((s
->midrule
&& s
->midrule
->action_props
.is_value_used
)
269 || (s
->midrule_parent_rule
270 && symbol_list_n_get (s
->midrule_parent_rule
,
271 s
->midrule_parent_rhs_index
)
272 ->action_props
.is_value_used
))
274 *midrule_warning
= true;
280 /*----------------------------------------------------------------.
281 | Check that the rule R is properly defined. For instance, there |
282 | should be no type clash on the default action. |
283 `----------------------------------------------------------------*/
286 grammar_rule_check (const symbol_list
*r
)
290 If there is an action, then there is nothing we can do: the user
291 is allowed to shoot herself in the foot.
293 Don't worry about the default action if $$ is untyped, since $$'s
294 value can't be used. */
295 if (!r
->action_props
.code
&& r
->content
.sym
->type_name
)
297 symbol
*first_rhs
= r
->next
->content
.sym
;
298 /* If $$ is being set in default way, report if any type mismatch. */
301 char const *lhs_type
= r
->content
.sym
->type_name
;
302 const char *rhs_type
=
303 first_rhs
->type_name
? first_rhs
->type_name
: "";
304 if (!UNIQSTR_EQ (lhs_type
, rhs_type
))
305 complain (&r
->location
, Wother
,
306 _("type clash on default action: <%s> != <%s>"),
309 /* Warn if there is no default for $$ but we need one. */
311 complain (&r
->location
, Wother
,
312 _("empty rule for typed nonterminal, and no action"));
315 /* Check that symbol values that should be used are in fact used. */
317 symbol_list
const *l
= r
;
319 for (; l
&& l
->content
.sym
; l
= l
->next
, ++n
)
321 bool midrule_warning
= false;
322 if (!l
->action_props
.is_value_used
323 && symbol_should_be_used (l
, &midrule_warning
)
324 /* The default action, $$ = $1, `uses' both. */
325 && (r
->action_props
.code
|| (n
!= 0 && n
!= 1)))
327 warnings warn_flag
= midrule_warning
? Wmidrule_values
: Wother
;
329 complain (&l
->location
, warn_flag
, _("unused value: $%d"), n
);
331 complain (&l
->location
, warn_flag
, _("unset value: $$"));
336 /* See comments in grammar_current_rule_prec_set for how POSIX
337 mandates this complaint. It's only for identifiers, so skip
338 it for char literals and strings, which are always tokens. */
340 && r
->ruleprec
->tag
[0] != '\'' && r
->ruleprec
->tag
[0] != '"'
341 && r
->ruleprec
->status
!= declared
&& !r
->ruleprec
->prec
)
342 complain (&r
->location
, Wother
,
343 _("token for %%prec is not defined: %s"), r
->ruleprec
->tag
);
347 /*-------------------------------------.
348 | End the currently being grown rule. |
349 `-------------------------------------*/
352 grammar_current_rule_end (location loc
)
354 /* Put an empty link in the list to mark the end of this rule */
355 grammar_symbol_append (NULL
, grammar_end
->location
);
356 current_rule
->location
= loc
;
360 /*-------------------------------------------------------------------.
361 | The previous action turns out the be a mid-rule action. Attach it |
362 | to the current rule, i.e., create a dummy symbol, attach it this |
363 | mid-rule action, and append this dummy nonterminal to the current |
365 `-------------------------------------------------------------------*/
368 grammar_midrule_action (void)
370 /* Since the action was written out with this rule's number, we must
371 give the new rule this number by inserting the new rule before
374 /* Make a DUMMY nonterminal, whose location is that of the midrule
375 action. Create the MIDRULE. */
376 location dummy_location
= current_rule
->action_props
.location
;
377 symbol
*dummy
= dummy_symbol_get (dummy_location
);
378 symbol_list
*midrule
= symbol_list_sym_new (dummy
, dummy_location
);
380 /* Remember named_ref of previous action. */
381 named_ref
*action_name
= current_rule
->action_props
.named_ref
;
383 /* Make a new rule, whose body is empty, before the current one, so
384 that the action just read can belong to it. */
387 /* Attach its location and actions to that of the DUMMY. */
388 midrule
->location
= dummy_location
;
389 code_props_rule_action_init (&midrule
->action_props
,
390 current_rule
->action_props
.code
,
391 current_rule
->action_props
.location
,
393 current_rule
->action_props
.is_predicate
);
394 code_props_none_init (¤t_rule
->action_props
);
396 if (previous_rule_end
)
397 previous_rule_end
->next
= midrule
;
401 /* End the dummy's rule. */
402 midrule
->next
= symbol_list_sym_new (NULL
, dummy_location
);
403 midrule
->next
->next
= current_rule
;
405 previous_rule_end
= midrule
->next
;
407 /* Insert the dummy nonterminal replacing the midrule action into
408 the current rule. Bind it to its dedicated rule. */
409 grammar_current_rule_symbol_append (dummy
, dummy_location
,
411 grammar_end
->midrule
= midrule
;
412 midrule
->midrule_parent_rule
= current_rule
;
413 midrule
->midrule_parent_rhs_index
= symbol_list_length (current_rule
->next
);
416 /* Set the precedence symbol of the current rule to PRECSYM. */
419 grammar_current_rule_prec_set (symbol
*precsym
, location loc
)
421 /* POSIX says that any identifier is a nonterminal if it does not
422 appear on the LHS of a grammar rule and is not defined by %token
423 or by one of the directives that assigns precedence to a token. We
424 ignore this here because the only kind of identifier that POSIX
425 allows to follow a %prec is a token and because assuming it's a
426 token now can produce more logical error messages. Nevertheless,
427 grammar_rule_check does obey what we believe is the real intent of
428 POSIX here: that an error be reported for any identifier that
429 appears after %prec but that is not defined separately as a
431 symbol_class_set (precsym
, token_sym
, loc
, false);
432 if (current_rule
->ruleprec
)
433 complain (&loc
, complaint
, _("only one %s allowed per rule"), "%prec");
434 current_rule
->ruleprec
= precsym
;
437 /* Attach dynamic precedence DPREC to the current rule. */
440 grammar_current_rule_dprec_set (int dprec
, location loc
)
443 complain (&loc
, Wother
, _("%s affects only GLR parsers"),
446 complain (&loc
, complaint
, _("%s must be followed by positive number"),
448 else if (current_rule
->dprec
!= 0)
449 complain (&loc
, complaint
, _("only one %s allowed per rule"), "%dprec");
450 current_rule
->dprec
= dprec
;
453 /* Attach a merge function NAME with argument type TYPE to current
457 grammar_current_rule_merge_set (uniqstr name
, location loc
)
460 complain (&loc
, Wother
, _("%s affects only GLR parsers"),
462 if (current_rule
->merger
!= 0)
463 complain (&loc
, complaint
, _("only one %s allowed per rule"), "%merge");
464 current_rule
->merger
= get_merge_function (name
);
465 current_rule
->merger_declaration_location
= loc
;
468 /* Attach SYM to the current rule. If needed, move the previous
469 action as a mid-rule action. */
472 grammar_current_rule_symbol_append (symbol
*sym
, location loc
,
476 if (current_rule
->action_props
.code
)
477 grammar_midrule_action ();
478 p
= grammar_symbol_append (sym
, loc
);
480 assign_named_ref(p
, name
);
481 if (sym
->status
== undeclared
|| sym
->status
== used
)
482 sym
->status
= needed
;
485 /* Attach an ACTION to the current rule. */
488 grammar_current_rule_action_append (const char *action
, location loc
,
489 named_ref
*name
, bool is_predicate
)
491 if (current_rule
->action_props
.code
)
492 grammar_midrule_action ();
493 /* After all symbol declarations have been parsed, packgram invokes
494 code_props_translate_code. */
495 code_props_rule_action_init (¤t_rule
->action_props
, action
, loc
,
496 current_rule
, name
, is_predicate
);
500 /*---------------------------------------------------------------.
501 | Convert the rules into the representation using RRHS, RLHS and |
503 `---------------------------------------------------------------*/
508 unsigned int itemno
= 0;
509 rule_number ruleno
= 0;
510 symbol_list
*p
= grammar
;
512 ritem
= xnmalloc (nritems
+ 1, sizeof *ritem
);
514 /* This sentinel is used by build_relations in gram.c. */
517 rules
= xnmalloc (nrules
, sizeof *rules
);
522 symbol
*ruleprec
= p
->ruleprec
;
523 record_merge_function_type (p
->merger
, p
->content
.sym
->type_name
,
524 p
->merger_declaration_location
);
525 rules
[ruleno
].user_number
= ruleno
;
526 rules
[ruleno
].number
= ruleno
;
527 rules
[ruleno
].lhs
= p
->content
.sym
;
528 rules
[ruleno
].rhs
= ritem
+ itemno
;
529 rules
[ruleno
].prec
= NULL
;
530 rules
[ruleno
].dprec
= p
->dprec
;
531 rules
[ruleno
].merger
= p
->merger
;
532 rules
[ruleno
].precsym
= NULL
;
533 rules
[ruleno
].location
= p
->location
;
534 rules
[ruleno
].useful
= true;
535 rules
[ruleno
].action
= p
->action_props
.code
;
536 rules
[ruleno
].action_location
= p
->action_props
.location
;
537 rules
[ruleno
].is_predicate
= p
->action_props
.is_predicate
;
539 /* If the midrule's $$ is set or its $n is used, remove the `$' from the
540 symbol name so that it's a user-defined symbol so that the default
541 %destructor and %printer apply. */
542 if (p
->midrule_parent_rule
543 && (p
->action_props
.is_value_used
544 || symbol_list_n_get (p
->midrule_parent_rule
,
545 p
->midrule_parent_rhs_index
)
546 ->action_props
.is_value_used
))
547 p
->content
.sym
->tag
+= 1;
549 /* Don't check the generated rule 0. It has no action, so some rhs
550 symbols may appear unused, but the parsing algorithm ensures that
551 %destructor's are invoked appropriately. */
553 grammar_rule_check (p
);
555 for (p
= p
->next
; p
&& p
->content
.sym
; p
= p
->next
)
559 /* Don't allow rule_length == INT_MAX, since that might
560 cause confusion with strtol if INT_MAX == LONG_MAX. */
561 if (rule_length
== INT_MAX
)
562 complain (&rules
[ruleno
].location
, fatal
, _("rule is too long"));
564 /* item_number = symbol_number.
565 But the former needs to contain more: negative rule numbers. */
567 symbol_number_as_item_number (p
->content
.sym
->number
);
568 /* A rule gets by default the precedence and associativity
569 of its last token. */
570 if (p
->content
.sym
->class == token_sym
&& default_prec
)
571 rules
[ruleno
].prec
= p
->content
.sym
;
574 /* If this rule has a %prec,
575 the specified symbol's precedence replaces the default. */
578 rules
[ruleno
].precsym
= ruleprec
;
579 rules
[ruleno
].prec
= ruleprec
;
581 /* An item ends by the rule number (negated). */
582 ritem
[itemno
++] = rule_number_as_item_number (ruleno
);
583 aver (itemno
< ITEM_NUMBER_MAX
);
585 aver (ruleno
< RULE_NUMBER_MAX
);
591 aver (itemno
== nritems
);
593 if (trace_flag
& trace_sets
)
594 ritem_print (stderr
);
597 /*------------------------------------------------------------------.
598 | Read in the grammar specification and record it in the format |
599 | described in gram.h. All actions are copied into ACTION_OBSTACK, |
600 | in each case forming the body of a C function (YYACTION) which |
601 | contains a switch statement to decide which action to execute. |
602 `------------------------------------------------------------------*/
607 /* Initialize the symbol table. */
610 /* Construct the accept symbol. */
611 accept
= symbol_get ("$accept", empty_location
);
612 accept
->class = nterm_sym
;
613 accept
->number
= nvars
++;
615 /* Construct the error token */
616 errtoken
= symbol_get ("error", empty_location
);
617 errtoken
->class = token_sym
;
618 errtoken
->number
= ntokens
++;
620 /* Construct a token that represents all undefined literal tokens.
621 It is always token number 2. */
622 undeftoken
= symbol_get ("$undefined", empty_location
);
623 undeftoken
->class = token_sym
;
624 undeftoken
->number
= ntokens
++;
626 gram_in
= xfopen (grammar_file
, "r");
628 gram__flex_debug
= trace_flag
& trace_scan
;
629 gram_debug
= trace_flag
& trace_parse
;
630 gram_scanner_initialize ();
632 prepare_percent_define_front_end_variables ();
634 if (complaint_status
< status_complaint
)
635 check_and_convert_grammar ();
641 prepare_percent_define_front_end_variables (void)
643 /* Set %define front-end variable defaults. */
644 muscle_percent_define_default ("lr.keep-unreachable-state", "false");
647 /* IELR would be a better default, but LALR is historically the
649 muscle_percent_define_default ("lr.type", "lalr");
650 lr_type
= muscle_percent_define_get ("lr.type");
651 if (STRNEQ (lr_type
, "canonical-lr"))
652 muscle_percent_define_default ("lr.default-reduction", "most");
654 muscle_percent_define_default ("lr.default-reduction", "accepting");
658 /* Check %define front-end variables. */
660 static char const * const values
[] = {
661 "lr.type", "lalr", "ielr", "canonical-lr", NULL
,
662 "lr.default-reduction", "most", "consistent", "accepting", NULL
,
665 muscle_percent_define_check_values (values
);
670 /*-------------------------------------------------------------.
671 | Check the grammar that has just been read, and convert it to |
673 `-------------------------------------------------------------*/
676 check_and_convert_grammar (void)
678 /* Grammar has been read. Do some checking. */
680 complain (NULL
, fatal
, _("no rules in the input grammar"));
682 /* If the user did not define her ENDTOKEN, do it now. */
685 endtoken
= symbol_get ("$end", empty_location
);
686 endtoken
->class = token_sym
;
687 endtoken
->number
= 0;
688 /* Value specified by POSIX. */
689 endtoken
->user_token_number
= 0;
692 /* Report any undefined symbols and consider them nonterminals. */
693 symbols_check_defined ();
695 /* Find the start symbol if no %start. */
700 node
!= NULL
&& symbol_is_dummy (node
->content
.sym
);
703 for (node
= node
->next
;
704 node
!= NULL
&& node
->content
.sym
!= NULL
;
709 grammar_start_symbol_set (node
->content
.sym
,
710 node
->content
.sym
->location
);
713 /* Insert the initial rule, whose line is that of the first rule
714 (not that of the start symbol):
716 accept: %start EOF. */
718 symbol_list
*p
= symbol_list_sym_new (accept
, empty_location
);
719 p
->location
= grammar
->location
;
720 p
->next
= symbol_list_sym_new (startsymbol
, empty_location
);
721 p
->next
->next
= symbol_list_sym_new (endtoken
, empty_location
);
722 p
->next
->next
->next
= symbol_list_sym_new (NULL
, empty_location
);
723 p
->next
->next
->next
->next
= grammar
;
729 aver (nsyms
<= SYMBOL_NUMBER_MAXIMUM
&& nsyms
== ntokens
+ nvars
);
731 /* Assign the symbols their symbol numbers. Write #defines for the
732 token symbols into FDEFINES if requested. */
735 /* Scan rule actions after invoking symbol_check_alias_consistency (in
736 symbols_pack above) so that token types are set correctly before the rule
737 action type checking.
739 Before invoking grammar_rule_check (in packgram below) on any rule, make
740 sure all actions have already been scanned in order to set `used' flags.
741 Otherwise, checking that a midrule's $$ should be set will not always work
742 properly because the check must forward-reference the midrule's parent
743 rule. For the same reason, all the `used' flags must be set before
744 checking whether to remove `$' from any midrule symbol name (also in
748 for (sym
= grammar
; sym
; sym
= sym
->next
)
749 code_props_translate_code (&sym
->action_props
);
752 /* Convert the grammar into the format described in gram.h. */
755 /* The grammar as a symbol_list is no longer needed. */
756 symbol_list_free (grammar
);