1 /* Bison Grammar Parser -*- C -*-
3 Copyright (C) 2002-2013 Free Software Foundation, Inc.
5 This file is part of Bison, the GNU Compiler Compiler.
7 This program is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
33 #include "conflicts.h"
37 #include "named-ref.h"
40 #include "scan-gram.h"
41 #include "scan-code.h"
44 static int current_prec = 0;
45 static location current_lhs_location;
46 static named_ref *current_lhs_named_ref;
47 static symbol *current_lhs_symbol;
48 static symbol_class current_class = unknown_sym;
49 static uniqstr current_type = NULL;
51 /** Set the new current left-hand side symbol, possibly common
52 * to several right-hand side parts of rule.
54 static void current_lhs (symbol *sym, location loc, named_ref *ref);
56 #define YYLLOC_DEFAULT(Current, Rhs, N) \
57 (Current) = lloc_default (Rhs, N)
58 static YYLTYPE lloc_default (YYLTYPE const *, int);
60 #define YY_LOCATION_PRINT(File, Loc) \
61 location_print (Loc, File)
63 /* Strip initial '{' and final '}' (must be first and last characters).
65 static char *strip_braces (char *code);
67 /* Convert CODE by calling code_props_plain_init if PLAIN, otherwise
68 code_props_symbol_action_init. Call
69 gram_scanner_last_string_free to release the latest string from
70 the scanner (should be CODE). */
71 static char const *translate_code (char *code, location loc, bool plain);
73 /* Convert CODE by calling code_props_plain_init after having
74 stripped the first and last characters (expected to be '{', and
75 '}'). Call gram_scanner_last_string_free to release the latest
76 string from the scanner (should be CODE). */
77 static char const *translate_code_braceless (char *code, location loc);
79 static void version_check (location const *loc, char const *version);
81 static void gram_error (location const *, char const *);
83 /* A string that describes a char (e.g., 'a' -> "'a'"). */
84 static char const *char_name (char);
86 #define YYTYPE_INT16 int_fast16_t
87 #define YYTYPE_INT8 int_fast8_t
88 #define YYTYPE_UINT16 uint_fast16_t
89 #define YYTYPE_UINT8 uint_fast8_t
92 %define api.prefix {gram_}
95 %define parse.error verbose
96 %define parse.lac full
104 /* Bison's grammar can initial empty locations, hence a default
105 location is needed. */
106 boundary_set (&@$.start, current_file, 1, 1);
107 boundary_set (&@$.end, current_file, 1, 1);
110 /* Define the tokens together with their human representation. */
111 %token GRAM_EOF 0 "end of file"
112 %token STRING "string"
114 %token PERCENT_TOKEN "%token"
115 %token PERCENT_NTERM "%nterm"
117 %token PERCENT_TYPE "%type"
118 %token PERCENT_DESTRUCTOR "%destructor"
119 %token PERCENT_PRINTER "%printer"
121 %token PERCENT_LEFT "%left"
122 %token PERCENT_RIGHT "%right"
123 %token PERCENT_NONASSOC "%nonassoc"
124 %token PERCENT_PRECEDENCE "%precedence"
126 %token PERCENT_PREC "%prec"
127 %token PERCENT_DPREC "%dprec"
128 %token PERCENT_MERGE "%merge"
130 /*----------------------.
131 | Global Declarations. |
132 `----------------------*/
136 PERCENT_DEFAULT_PREC "%default-prec"
137 PERCENT_DEFINE "%define"
138 PERCENT_DEFINES "%defines"
139 PERCENT_ERROR_VERBOSE "%error-verbose"
140 PERCENT_EXPECT "%expect"
141 PERCENT_EXPECT_RR "%expect-rr"
142 PERCENT_FLAG "%<flag>"
143 PERCENT_FILE_PREFIX "%file-prefix"
144 PERCENT_GLR_PARSER "%glr-parser"
145 PERCENT_INITIAL_ACTION "%initial-action"
146 PERCENT_LANGUAGE "%language"
147 PERCENT_NAME_PREFIX "%name-prefix"
148 PERCENT_NO_DEFAULT_PREC "%no-default-prec"
149 PERCENT_NO_LINES "%no-lines"
150 PERCENT_NONDETERMINISTIC_PARSER
151 "%nondeterministic-parser"
152 PERCENT_OUTPUT "%output"
153 PERCENT_REQUIRE "%require"
154 PERCENT_SKELETON "%skeleton"
155 PERCENT_START "%start"
156 PERCENT_TOKEN_TABLE "%token-table"
157 PERCENT_VERBOSE "%verbose"
161 %token BRACED_CODE "{...}"
162 %token BRACED_PREDICATE "%?{...}"
163 %token BRACKETED_ID "[identifier]"
165 %token EPILOGUE "epilogue"
167 %token ID "identifier"
168 %token ID_COLON "identifier:"
169 %token PERCENT_PERCENT "%%"
171 %token PROLOGUE "%{...%}"
177 %union {unsigned char character;}
178 %type <character> CHAR
179 %printer { fputs (char_name ($$), yyo); } CHAR
181 %union {char *code;};
182 %type <code> "{...}" "%?{...}" "%{...%}" EPILOGUE STRING
183 %printer { fputs (quotearg_style (c_quoting_style, $$), yyo); } STRING
184 %printer { fprintf (yyo, "{\n%s\n}", $$); } <code>
186 %union {uniqstr uniqstr;}
187 %type <uniqstr> BRACKETED_ID ID ID_COLON PERCENT_FLAG TAG tag variable
188 %printer { fputs ($$, yyo); } <uniqstr>
189 %printer { fprintf (yyo, "[%s]", $$); } BRACKETED_ID
190 %printer { fprintf (yyo, "%s:", $$); } ID_COLON
191 %printer { fprintf (yyo, "%%%s", $$); } PERCENT_FLAG
192 %printer { fprintf (yyo, "<%s>", $$); } TAG tag
194 %union {int integer;};
195 %token <integer> INT "integer"
196 %printer { fprintf (yyo, "%d", $$); } <integer>
198 %union {symbol *symbol;}
199 %type <symbol> id id_colon string_as_id symbol symbol.prec
200 %printer { fprintf (yyo, "%s", $$->tag); } <symbol>
201 %printer { fprintf (yyo, "%s:", $$->tag); } id_colon
203 %union {assoc assoc;};
204 %type <assoc> precedence_declarator
206 %union {symbol_list *list;}
207 %type <list> symbols.1 symbols.prec generic_symlist generic_symlist_item
209 %union {named_ref *named_ref;}
210 %type <named_ref> named_ref.opt
221 param_parse = 1 << 1,
222 param_both = param_lex | param_parse
227 /** Add a lex-param and/or a parse-param.
229 * \param type where to push this formal argument.
230 * \param decl the formal argument. Destroyed.
231 * \param loc the location in the source.
233 static void add_param (param_type type, char *decl, location loc);
234 static param_type current_param = param_none;
236 %union {param_type param;}
237 %token <param> PERCENT_PARAM "%param";
242 #define CASE(In, Out) \
243 case param_ ## In: fputs ("%" #Out, yyo); break
244 CASE (lex, lex-param);
245 CASE (parse, parse-param);
248 case param_none: aver (false); break;
259 prologue_declarations "%%" grammar epilogue.opt
263 /*------------------------------------.
264 | Declarations: before the first %%. |
265 `------------------------------------*/
267 prologue_declarations:
269 | prologue_declarations prologue_declaration
272 prologue_declaration:
276 muscle_code_grow (union_seen ? "post_prologue" : "pre_prologue",
277 translate_code ($1, @1, true), @1);
278 code_scanner_last_string_free ();
282 muscle_percent_define_ensure ($1, @1, true);
284 | "%define" variable value
286 muscle_percent_define_insert ($2, @2, $3.kind, $3.chars,
287 MUSCLE_PERCENT_DEFINE_GRAMMAR_FILE);
289 | "%defines" { defines_flag = true; }
293 spec_defines_file = xstrdup ($2);
297 muscle_percent_define_insert ("parse.error", @1, muscle_keyword,
299 MUSCLE_PERCENT_DEFINE_GRAMMAR_FILE);
301 | "%expect" INT { expected_sr_conflicts = $2; }
302 | "%expect-rr" INT { expected_rr_conflicts = $2; }
303 | "%file-prefix" STRING { spec_file_prefix = $2; }
306 nondeterministic_parser = true;
309 | "%initial-action" "{...}"
311 muscle_code_grow ("initial_action", translate_code ($2, @2, false), @2);
312 code_scanner_last_string_free ();
314 | "%language" STRING { language_argmatch ($2, grammar_prio, @1); }
315 | "%name-prefix" STRING { spec_name_prefix = $2; }
316 | "%no-lines" { no_lines_flag = true; }
317 | "%nondeterministic-parser" { nondeterministic_parser = true; }
318 | "%output" STRING { spec_outfile = $2; }
319 | "%param" { current_param = $1; } params { current_param = param_none; }
320 | "%require" STRING { version_check (&@2, $2); }
323 char const *skeleton_user = $2;
324 if (strchr (skeleton_user, '/'))
326 size_t dir_length = strlen (current_file);
327 char *skeleton_build;
328 while (dir_length && current_file[dir_length - 1] != '/')
330 while (dir_length && current_file[dir_length - 1] == '/')
333 xmalloc (dir_length + 1 + strlen (skeleton_user) + 1);
336 memcpy (skeleton_build, current_file, dir_length);
337 skeleton_build[dir_length++] = '/';
339 strcpy (skeleton_build + dir_length, skeleton_user);
340 skeleton_user = uniqstr_new (skeleton_build);
341 free (skeleton_build);
343 skeleton_arg (skeleton_user, grammar_prio, @1);
345 | "%token-table" { token_table_flag = true; }
346 | "%verbose" { report_flag |= report_states; }
347 | "%yacc" { yacc_flag = true; }
348 | /*FIXME: Err? What is this horror doing here? */ ";"
352 params "{...}" { add_param (current_param, $2, @2); }
353 | "{...}" { add_param (current_param, $1, @1); }
357 /*----------------------.
358 | grammar_declaration. |
359 `----------------------*/
362 precedence_declaration
366 grammar_start_symbol_set ($2, @2);
368 | code_props_type "{...}" generic_symlist
371 code_props_symbol_action_init (&code, $2, @2);
372 code_props_translate_code (&code);
375 for (list = $3; list; list = list->next)
376 symbol_list_code_props_set (list, $1, &code);
377 symbol_list_free ($3);
386 default_prec = false;
390 /* Do not invoke muscle_percent_code_grow here since it invokes
391 muscle_user_name_list_grow. */
392 muscle_code_grow ("percent_code()",
393 translate_code_braceless ($2, @2), @2);
394 code_scanner_last_string_free ();
398 muscle_percent_code_grow ($2, @2, translate_code_braceless ($3, @3), @3);
399 code_scanner_last_string_free ();
403 %type <code_type> code_props_type;
404 %union {code_props_type code_type;};
405 %printer { fprintf (yyo, "%s", code_props_type_string ($$)); } <code_type>;
407 "%destructor" { $$ = destructor; }
408 | "%printer" { $$ = printer; }
415 %token PERCENT_UNION "%union";
419 | ID { muscle_code_grow ("union_name", $1, @1); }
423 "%union" union_name "{...}"
426 muscle_code_grow ("union_members", translate_code_braceless ($3, @3), @3);
427 code_scanner_last_string_free ();
435 "%nterm" { current_class = nterm_sym; } symbol_defs.1
437 current_class = unknown_sym;
440 | "%token" { current_class = token_sym; } symbol_defs.1
442 current_class = unknown_sym;
445 | "%type" TAG symbols.1
449 for (list = $3; list; list = list->next)
450 symbol_type_set (list->content.sym, $2, @2);
451 symbol_list_free ($3);
455 precedence_declaration:
456 precedence_declarator tag.opt symbols.prec
460 for (list = $3; list; list = list->next)
462 symbol_type_set (list->content.sym, current_type, @2);
463 symbol_precedence_set (list->content.sym, current_prec, $1, @1);
465 symbol_list_free ($3);
470 precedence_declarator:
471 "%left" { $$ = left_assoc; }
472 | "%right" { $$ = right_assoc; }
473 | "%nonassoc" { $$ = non_assoc; }
474 | "%precedence" { $$ = precedence_assoc; }
478 %empty { current_type = NULL; }
479 | TAG { current_type = $1; tag_seen = true; }
482 /* Just like symbols.1 but accept INT for the sake of POSIX. */
485 { $$ = symbol_list_sym_new ($1, @1); }
486 | symbols.prec symbol.prec
487 { $$ = symbol_list_append ($1, symbol_list_sym_new ($2, @2)); }
494 symbol_class_set ($1, token_sym, @1, false);
499 symbol_user_token_number_set ($1, $2, @2);
500 symbol_class_set ($1, token_sym, @1, false);
504 /* One or more symbols to be %typed. */
507 { $$ = symbol_list_sym_new ($1, @1); }
509 { $$ = symbol_list_append ($1, symbol_list_sym_new ($2, @2)); }
513 generic_symlist_item { $$ = $1; }
514 | generic_symlist generic_symlist_item { $$ = symbol_list_append ($1, $2); }
517 generic_symlist_item:
518 symbol { $$ = symbol_list_sym_new ($1, @1); }
519 | tag { $$ = symbol_list_type_new ($1, @1); }
524 | "<*>" { $$ = uniqstr_new ("*"); }
525 | "<>" { $$ = uniqstr_new (""); }
528 /* One token definition. */
537 symbol_class_set ($1, current_class, @1, true);
538 symbol_type_set ($1, current_type, @1);
542 symbol_class_set ($1, current_class, @1, true);
543 symbol_type_set ($1, current_type, @1);
544 symbol_user_token_number_set ($1, $2, @2);
548 symbol_class_set ($1, current_class, @1, true);
549 symbol_type_set ($1, current_type, @1);
550 symbol_make_alias ($1, $2, @$);
552 | id INT string_as_id
554 symbol_class_set ($1, current_class, @1, true);
555 symbol_type_set ($1, current_type, @1);
556 symbol_user_token_number_set ($1, $2, @2);
557 symbol_make_alias ($1, $3, @$);
561 /* One or more symbol definitions. */
564 | symbol_defs.1 symbol_def
568 /*------------------------------------------.
569 | The grammar section: between the two %%. |
570 `------------------------------------------*/
573 rules_or_grammar_declaration
574 | grammar rules_or_grammar_declaration
577 /* As a Bison extension, one can use the grammar declarations in the
578 body of the grammar. */
579 rules_or_grammar_declaration:
581 | grammar_declaration ";"
589 id_colon named_ref.opt { current_lhs ($1, @1, $2); } rhses.1
591 /* Free the current lhs. */
592 current_lhs (0, @1, 0);
597 rhs { grammar_current_rule_end (@1); }
598 | rhses.1 "|" rhs { grammar_current_rule_end (@3); }
602 %token PERCENT_EMPTY "%empty";
605 { grammar_current_rule_begin (current_lhs_symbol, current_lhs_location,
606 current_lhs_named_ref); }
607 | rhs symbol named_ref.opt
608 { grammar_current_rule_symbol_append ($2, @2, $3); }
609 | rhs "{...}" named_ref.opt
610 { grammar_current_rule_action_append ($2, @2, $3, false); }
612 { grammar_current_rule_action_append ($2, @2, NULL, true); }
614 { grammar_current_rule_empty_set (@2); }
616 { grammar_current_rule_prec_set ($3, @3); }
618 { grammar_current_rule_dprec_set ($3, @3); }
620 { grammar_current_rule_merge_set ($3, @3); }
625 | BRACKETED_ID { $$ = named_ref_new($1, @1); }
628 /*---------------------.
629 | variable and value. |
630 `---------------------*/
632 /* The STRING form of variable is deprecated and is not M4-friendly.
633 For example, M4 fails for '%define "[" "value"'. */
636 | STRING { $$ = uniqstr_new ($1); }
639 /* Some content or empty by default. */
640 %code requires {#include "muscle-tab.h"};
654 case muscle_code: fprintf (yyo, "{%s}", $$.chars); break;
655 case muscle_keyword: fprintf (yyo, "%s", $$.chars); break;
656 case muscle_string: fprintf (yyo, "\"%s\"", $$.chars); break;
661 %empty { $$.kind = muscle_keyword; $$.chars = ""; }
662 | ID { $$.kind = muscle_keyword; $$.chars = $1; }
663 | STRING { $$.kind = muscle_string; $$.chars = $1; }
664 | "{...}" { $$.kind = muscle_code;
665 $$.chars = translate_code_braceless ($1, @1); }
673 /* Identifiers are returned as uniqstr values by the scanner.
674 Depending on their use, we may need to make them genuine symbols. */
678 { $$ = symbol_from_uniqstr ($1, @1); }
681 $$ = symbol_get (char_name ($1), @1);
682 symbol_class_set ($$, token_sym, @1, false);
683 symbol_user_token_number_set ($$, $1, @1);
688 ID_COLON { $$ = symbol_from_uniqstr ($1, @1); }
697 /* A string used as an ID: quote it. */
701 $$ = symbol_get (quotearg_style (c_quoting_style, $1), @1);
702 symbol_class_set ($$, token_sym, @1, false);
710 muscle_code_grow ("epilogue", translate_code ($2, @2, true), @2);
711 code_scanner_last_string_free ();
717 /* Return the location of the left-hand side of a rule whose
718 right-hand side is RHS[1] ... RHS[N]. Ignore empty nonterminals in
719 the right-hand side, and return an empty location equal to the end
720 boundary of RHS[0] if the right-hand side is empty. */
723 lloc_default (YYLTYPE const *rhs, int n)
728 /* SGI MIPSpro 7.4.1m miscompiles "loc.start = loc.end = rhs[n].end;".
729 The bug is fixed in 7.4.2m, but play it safe for now. */
730 loc.start = rhs[n].end;
731 loc.end = rhs[n].end;
733 /* Ignore empty nonterminals the start of the right-hand side.
734 Do not bother to ignore them at the end of the right-hand side,
735 since empty nonterminals have the same end as their predecessors. */
736 for (i = 1; i <= n; i++)
737 if (! equal_boundaries (rhs[i].start, rhs[i].end))
739 loc.start = rhs[i].start;
747 char *strip_braces (char *code)
749 code[strlen(code) - 1] = 0;
755 translate_code (char *code, location loc, bool plain)
757 code_props plain_code;
759 code_props_plain_init (&plain_code, code, loc);
761 code_props_symbol_action_init (&plain_code, code, loc);
762 code_props_translate_code (&plain_code);
763 gram_scanner_last_string_free ();
764 return plain_code.code;
769 translate_code_braceless (char *code, location loc)
771 return translate_code (strip_braces (code), loc, true);
775 add_param (param_type type, char *decl, location loc)
777 static char const alphanum[26 + 26 + 1 + 10] =
778 "abcdefghijklmnopqrstuvwxyz"
779 "ABCDEFGHIJKLMNOPQRSTUVWXYZ"
783 char const *name_start = NULL;
786 /* Stop on last actual character. */
787 for (p = decl; p[1]; p++)
789 || ! memchr (alphanum, p[-1], sizeof alphanum))
790 && memchr (alphanum, p[0], sizeof alphanum - 10))
793 /* Strip the surrounding '{' and '}', and any blanks just inside
796 while (c_isspace ((unsigned char) *p))
800 while (c_isspace ((unsigned char) *decl))
805 complain (&loc, complaint, _("missing identifier in parameter declaration"));
808 char *name = xmemdup0 (name_start, strspn (name_start, alphanum));
809 if (type & param_lex)
810 muscle_pair_list_grow ("lex_param", decl, name);
811 if (type & param_parse)
812 muscle_pair_list_grow ("parse_param", decl, name);
816 gram_scanner_last_string_free ();
821 version_check (location const *loc, char const *version)
823 if (strverscmp (version, PACKAGE_VERSION) > 0)
825 complain (loc, complaint, "require bison %s, but have %s",
826 version, PACKAGE_VERSION);
832 gram_error (location const *loc, char const *msg)
834 complain (loc, complaint, "%s", msg);
838 token_name (int type)
840 return yytname[YYTRANSLATE (type)];
851 buf[0] = '\''; buf[1] = c; buf[2] = '\''; buf[3] = '\0';
852 return quotearg_style (escape_quoting_style, buf);
858 current_lhs (symbol *sym, location loc, named_ref *ref)
860 current_lhs_symbol = sym;
861 current_lhs_location = loc;
862 /* In order to simplify memory management, named references for lhs
863 are always assigned by deep copy into the current symbol_list
864 node. This is because a single named-ref in the grammar may
865 result in several uses when the user factors lhs between several
866 rules using "|". Therefore free the parser's original copy. */
867 free (current_lhs_named_ref);
868 current_lhs_named_ref = ref;