1 /* Output the generated parsing program for Bison.
3 Copyright (C) 1984, 1986, 1989, 1992, 2000, 2001, 2002, 2003, 2004,
4 2005, 2006, 2007 Free Software Foundation, Inc.
6 This file is part of Bison, the GNU Compiler Compiler.
8 Bison is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
13 Bison is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
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 the Free
20 Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
26 #include <configmake.h>
28 #include <get-errno.h>
37 #include "muscle_tab.h"
40 #include "scan-code.h" /* max_left_semantic_context */
41 #include "scan-skel.h"
46 static struct obstack format_obstack
;
49 /*-------------------------------------------------------------------.
50 | Create a function NAME which associates to the muscle NAME the |
51 | result of formatting the FIRST and then TABLE_DATA[BEGIN..END[ (of |
52 | TYPE), and to the muscle NAME_max, the max value of the |
54 `-------------------------------------------------------------------*/
57 #define GENERATE_MUSCLE_INSERT_TABLE(Name, Type) \
60 Name (char const *name, \
73 obstack_fgrow1 (&format_obstack, "%6d", first); \
74 for (i = begin; i < end; ++i) \
76 obstack_1grow (&format_obstack, ','); \
79 obstack_sgrow (&format_obstack, "\n "); \
84 obstack_fgrow1 (&format_obstack, "%6d", table_data[i]); \
85 if (table_data[i] < min) \
86 min = table_data[i]; \
87 if (max < table_data[i]) \
88 max = table_data[i]; \
90 obstack_1grow (&format_obstack, 0); \
91 muscle_insert (name, obstack_finish (&format_obstack)); \
95 /* Build `NAME_min' and `NAME_max' in the obstack. */ \
96 obstack_fgrow1 (&format_obstack, "%s_min", name); \
97 obstack_1grow (&format_obstack, 0); \
98 MUSCLE_INSERT_LONG_INT (obstack_finish (&format_obstack), lmin); \
99 obstack_fgrow1 (&format_obstack, "%s_max", name); \
100 obstack_1grow (&format_obstack, 0); \
101 MUSCLE_INSERT_LONG_INT (obstack_finish (&format_obstack), lmax); \
104 GENERATE_MUSCLE_INSERT_TABLE(muscle_insert_unsigned_int_table
, unsigned int)
105 GENERATE_MUSCLE_INSERT_TABLE(muscle_insert_int_table
, int)
106 GENERATE_MUSCLE_INSERT_TABLE(muscle_insert_base_table
, base_number
)
107 GENERATE_MUSCLE_INSERT_TABLE(muscle_insert_rule_number_table
, rule_number
)
108 GENERATE_MUSCLE_INSERT_TABLE(muscle_insert_symbol_number_table
, symbol_number
)
109 GENERATE_MUSCLE_INSERT_TABLE(muscle_insert_item_number_table
, item_number
)
110 GENERATE_MUSCLE_INSERT_TABLE(muscle_insert_state_number_table
, state_number
)
113 /*--------------------------------------------------------------------.
114 | Print to OUT a representation of STRING escaped both for C and M4. |
115 `--------------------------------------------------------------------*/
118 escaped_output (FILE *out
, char const *string
)
123 for (p
= quotearg_style (c_quoting_style
, string
); *p
; p
++)
126 case '$': fputs ("$][", out
); break;
127 case '@': fputs ("@@", out
); break;
128 case '[': fputs ("@{", out
); break;
129 case ']': fputs ("@}", out
); break;
130 default: fputc (*p
, out
); break;
137 /*------------------------------------------------------------------.
138 | Prepare the muscles related to the symbols: translate, tname, and |
140 `------------------------------------------------------------------*/
143 prepare_symbols (void)
145 MUSCLE_INSERT_BOOL ("token_table", token_table_flag
);
146 MUSCLE_INSERT_INT ("tokens_number", ntokens
);
147 MUSCLE_INSERT_INT ("nterms_number", nvars
);
148 MUSCLE_INSERT_INT ("undef_token_number", undeftoken
->number
);
149 MUSCLE_INSERT_INT ("user_token_number_max", max_user_token_number
);
151 muscle_insert_symbol_number_table ("translate",
153 token_translations
[0],
154 1, max_user_token_number
+ 1);
156 /* tname -- token names. */
159 /* We assume that the table will be output starting at column 2. */
161 for (i
= 0; i
< nsyms
; i
++)
163 char const *cp
= quotearg_style (c_quoting_style
, symbols
[i
]->tag
);
164 /* Width of the next token, including the two quotes, the
165 comma and the space. */
166 int width
= strlen (cp
) + 2;
170 obstack_sgrow (&format_obstack
, "\n ");
175 obstack_1grow (&format_obstack
, ' ');
176 MUSCLE_OBSTACK_SGROW (&format_obstack
, cp
);
177 obstack_1grow (&format_obstack
, ',');
180 obstack_sgrow (&format_obstack
, " ]b4_null[");
182 /* Finish table and store. */
183 obstack_1grow (&format_obstack
, 0);
184 muscle_insert ("tname", obstack_finish (&format_obstack
));
187 /* Output YYTOKNUM. */
190 int *values
= xnmalloc (ntokens
, sizeof *values
);
191 for (i
= 0; i
< ntokens
; ++i
)
192 values
[i
] = symbols
[i
]->user_token_number
;
193 muscle_insert_int_table ("toknum", values
,
194 values
[0], 1, ntokens
);
200 /*-------------------------------------------------------------.
201 | Prepare the muscles related to the rules: rhs, prhs, r1, r2, |
202 | rline, dprec, merger. |
203 `-------------------------------------------------------------*/
210 item_number
*rhs
= xnmalloc (nritems
, sizeof *rhs
);
211 unsigned int *prhs
= xnmalloc (nrules
, sizeof *prhs
);
212 unsigned int *rline
= xnmalloc (nrules
, sizeof *rline
);
213 symbol_number
*r1
= xnmalloc (nrules
, sizeof *r1
);
214 unsigned int *r2
= xnmalloc (nrules
, sizeof *r2
);
215 int *dprec
= xnmalloc (nrules
, sizeof *dprec
);
216 int *merger
= xnmalloc (nrules
, sizeof *merger
);
218 for (r
= 0; r
< nrules
; ++r
)
220 item_number
*rhsp
= NULL
;
221 /* Index of rule R in RHS. */
223 /* RHS of the rule R. */
224 for (rhsp
= rules
[r
].rhs
; *rhsp
>= 0; ++rhsp
)
226 /* LHS of the rule R. */
227 r1
[r
] = rules
[r
].lhs
->number
;
228 /* Length of rule R's RHS. */
230 /* Separator in RHS. */
232 /* Line where rule was defined. */
233 rline
[r
] = rules
[r
].location
.start
.line
;
234 /* Dynamic precedence (GLR). */
235 dprec
[r
] = rules
[r
].dprec
;
236 /* Merger-function index (GLR). */
237 merger
[r
] = rules
[r
].merger
;
241 muscle_insert_item_number_table ("rhs", rhs
, ritem
[0], 1, nritems
);
242 muscle_insert_unsigned_int_table ("prhs", prhs
, 0, 0, nrules
);
243 muscle_insert_unsigned_int_table ("rline", rline
, 0, 0, nrules
);
244 muscle_insert_symbol_number_table ("r1", r1
, 0, 0, nrules
);
245 muscle_insert_unsigned_int_table ("r2", r2
, 0, 0, nrules
);
246 muscle_insert_int_table ("dprec", dprec
, 0, 0, nrules
);
247 muscle_insert_int_table ("merger", merger
, 0, 0, nrules
);
249 MUSCLE_INSERT_INT ("rules_number", nrules
);
250 MUSCLE_INSERT_INT ("max_left_semantic_context", max_left_semantic_context
);
261 /*--------------------------------------------.
262 | Prepare the muscles related to the states. |
263 `--------------------------------------------*/
266 prepare_states (void)
269 symbol_number
*values
= xnmalloc (nstates
, sizeof *values
);
270 for (i
= 0; i
< nstates
; ++i
)
271 values
[i
] = states
[i
]->accessing_symbol
;
272 muscle_insert_symbol_number_table ("stos", values
,
276 MUSCLE_INSERT_INT ("last", high
);
277 MUSCLE_INSERT_INT ("final_state_number", final_state
->number
);
278 MUSCLE_INSERT_INT ("states_number", nstates
);
283 /*---------------------------------.
284 | Output the user actions to OUT. |
285 `---------------------------------*/
288 user_actions_output (FILE *out
)
292 fputs ("m4_define([b4_actions], \n[", out
);
293 for (r
= 0; r
< nrules
; ++r
)
296 fprintf (out
, "b4_case(%d, [b4_syncline(%d, ", r
+ 1,
297 rules
[r
].action_location
.start
.line
);
298 escaped_output (out
, rules
[r
].action_location
.start
.file
);
299 fprintf (out
, ")\n[ %s]])\n\n", rules
[r
].action
);
301 fputs ("])\n\n", out
);
304 /*--------------------------------------.
305 | Output the merge functions to OUT. |
306 `--------------------------------------*/
309 merger_output (FILE *out
)
314 fputs ("m4_define([b4_mergers], \n[[", out
);
315 for (n
= 1, p
= merge_functions
; p
!= NULL
; n
+= 1, p
= p
->next
)
317 if (p
->type
[0] == '\0')
318 fprintf (out
, " case %d: *yy0 = %s (*yy0, *yy1); break;\n",
321 fprintf (out
, " case %d: yy0->%s = %s (*yy0, *yy1); break;\n",
322 n
, p
->type
, p
->name
);
324 fputs ("]])\n\n", out
);
327 /*--------------------------------------.
328 | Output the tokens definition to OUT. |
329 `--------------------------------------*/
332 token_definitions_output (FILE *out
)
335 char const *sep
= "";
337 fputs ("m4_define([b4_tokens], \n[", out
);
338 for (i
= 0; i
< ntokens
; ++i
)
340 symbol
*sym
= symbols
[i
];
341 int number
= sym
->user_token_number
;
343 /* At this stage, if there are literal aliases, they are part of
344 SYMBOLS, so we should not find symbols which are the aliases
346 aver (number
!= USER_NUMBER_ALIAS
);
348 /* Skip error token. */
352 /* If this string has an alias, then it is necessarily the alias
353 which is to be output. */
357 /* Don't output literal chars or strings (when defined only as a
358 string). Note that must be done after the alias resolution:
359 think about `%token 'f' "f"'. */
360 if (sym
->tag
[0] == '\'' || sym
->tag
[0] == '\"')
363 /* Don't #define nonliteral tokens whose names contain periods
364 or '$' (as does the default value of the EOF token). */
365 if (strchr (sym
->tag
, '.') || strchr (sym
->tag
, '$'))
368 fprintf (out
, "%s[[[%s]], %d]",
369 sep
, sym
->tag
, number
);
372 fputs ("])\n\n", out
);
376 /*---------------------------------------------------.
377 | Output the symbol destructors or printers to OUT. |
378 `---------------------------------------------------*/
381 symbol_code_props_output (FILE *out
, char const *what
,
382 code_props
const *(*get
)(symbol
const *))
385 char const *sep
= "";
387 fputs ("m4_define([b4_symbol_", out
);
389 fputs ("], \n[", out
);
390 for (i
= 0; i
< nsyms
; ++i
)
392 symbol
*sym
= symbols
[i
];
393 char const *code
= (*get
) (sym
)->code
;
396 location loc
= (*get
) (sym
)->location
;
398 Symbol-name, Symbol-number,
399 code, optional typename. */
400 fprintf (out
, "%s[", sep
);
402 escaped_output (out
, loc
.start
.file
);
403 fprintf (out
, ", %d, ", loc
.start
.line
);
404 escaped_output (out
, sym
->tag
);
405 fprintf (out
, ", %d, [[%s]]", sym
->number
, code
);
407 fprintf (out
, ", [[%s]]", sym
->type_name
);
411 fputs ("])\n\n", out
);
416 prepare_actions (void)
418 /* Figure out the actions for the specified state, indexed by
419 lookahead token type. */
421 muscle_insert_rule_number_table ("defact", yydefact
,
422 yydefact
[0], 1, nstates
);
424 /* Figure out what to do after reducing with each rule, depending on
425 the saved state from before the beginning of parsing the data
426 that matched this rule. */
427 muscle_insert_state_number_table ("defgoto", yydefgoto
,
428 yydefgoto
[0], 1, nsyms
- ntokens
);
432 muscle_insert_base_table ("pact", base
,
433 base
[0], 1, nstates
);
434 MUSCLE_INSERT_INT ("pact_ninf", base_ninf
);
437 muscle_insert_base_table ("pgoto", base
,
438 base
[nstates
], nstates
+ 1, nvectors
);
440 muscle_insert_base_table ("table", table
,
441 table
[0], 1, high
+ 1);
442 MUSCLE_INSERT_INT ("table_ninf", table_ninf
);
444 muscle_insert_base_table ("check", check
,
445 check
[0], 1, high
+ 1);
447 /* GLR parsing slightly modifies YYTABLE and YYCHECK (and thus
448 YYPACT) so that in states with unresolved conflicts, the default
449 reduction is not used in the conflicted entries, so that there is
450 a place to put a conflict pointer.
452 This means that YYCONFLP and YYCONFL are nonsense for a non-GLR
453 parser, so we could avoid accidents by not writing them out in
454 that case. Nevertheless, it seems even better to be able to use
455 the GLR skeletons even without the non-deterministic tables. */
456 muscle_insert_unsigned_int_table ("conflict_list_heads", conflict_table
,
457 conflict_table
[0], 1, high
+ 1);
458 muscle_insert_unsigned_int_table ("conflicting_rules", conflict_list
,
459 0, 1, conflict_list_cnt
);
463 /*---------------------------.
464 | Call the skeleton parser. |
465 `---------------------------*/
468 output_skeleton (void)
476 /* Compute the names of the package data dir and skeleton file.
477 Test whether m4sugar.m4 is readable, to check for proper
478 installation. A faulty installation can cause deadlock, so a
479 cheap sanity check is worthwhile. */
480 char const m4sugar
[] = "m4sugar/m4sugar.m4";
481 char const m4bison
[] = "bison.m4";
486 char const *m4
= (p
= getenv ("M4")) ? p
: M4
;
487 char const *pkgdatadir
= (p
= getenv ("BISON_PKGDATADIR")) ? p
: PKGDATADIR
;
488 size_t skeleton_size
= strlen (skeleton
) + 1;
489 size_t pkgdatadirlen
= strlen (pkgdatadir
);
490 while (pkgdatadirlen
&& pkgdatadir
[pkgdatadirlen
- 1] == '/')
492 full_skeleton
= xmalloc (pkgdatadirlen
+ 1
493 + (skeleton_size
< sizeof m4sugar
494 ? sizeof m4sugar
: skeleton_size
));
495 strcpy (full_skeleton
, pkgdatadir
);
496 full_skeleton
[pkgdatadirlen
] = '/';
497 strcpy (full_skeleton
+ pkgdatadirlen
+ 1, m4sugar
);
498 full_m4sugar
= xstrdup (full_skeleton
);
499 strcpy (full_skeleton
+ pkgdatadirlen
+ 1, m4bison
);
500 full_m4bison
= xstrdup (full_skeleton
);
501 strcpy (full_skeleton
+ pkgdatadirlen
+ 1, skeleton
);
502 xfclose (xfopen (full_m4sugar
, "r"));
504 /* Create an m4 subprocess connected to us via two pipes. */
506 if (trace_flag
& trace_tools
)
507 fprintf (stderr
, "running: %s %s - %s %s\n",
508 m4
, full_m4sugar
, full_m4bison
, full_skeleton
);
511 argv
[1] = full_m4sugar
;
513 argv
[3] = full_m4bison
;
514 argv
[4] = full_skeleton
;
515 argv
[5] = trace_flag
& trace_m4
? "-dV" : NULL
;
519 pid
= create_subpipe (argv
, filter_fd
);
522 free (full_skeleton
);
524 out
= fdopen (filter_fd
[0], "w");
526 error (EXIT_FAILURE
, get_errno (),
529 /* Output the definitions of all the muscles. */
530 fputs ("m4_init()\n", out
);
532 user_actions_output (out
);
534 token_definitions_output (out
);
535 symbol_code_props_output (out
, "destructors", &symbol_destructor_get
);
536 symbol_code_props_output (out
, "printers", &symbol_printer_get
);
538 muscles_m4_output (out
);
540 fputs ("m4_wrap([m4_divert_pop(0)])\n", out
);
541 fputs ("m4_divert_push(0)dnl\n", out
);
544 /* Read and process m4's output. */
545 timevar_push (TV_M4
);
546 end_of_output_subpipe (pid
, filter_fd
);
547 in
= fdopen (filter_fd
[1], "r");
549 error (EXIT_FAILURE
, get_errno (),
553 reap_subpipe (pid
, m4
);
560 /* BISON_USE_PUSH_FOR_PULL is for the test suite and should not be documented
562 char const *use_push_for_pull_env
= getenv ("BISON_USE_PUSH_FOR_PULL");
563 bool use_push_for_pull_flag
= false;
564 if (use_push_for_pull_env
!= NULL
565 && use_push_for_pull_env
[0] != '\0'
566 && 0 != strcmp (use_push_for_pull_env
, "0"))
567 use_push_for_pull_flag
= true;
570 MUSCLE_INSERT_BOOL ("debug_flag", debug_flag
);
571 MUSCLE_INSERT_BOOL ("defines_flag", defines_flag
);
572 MUSCLE_INSERT_BOOL ("error_verbose_flag", error_verbose
);
573 MUSCLE_INSERT_BOOL ("glr_flag", glr_parser
);
574 MUSCLE_INSERT_BOOL ("locations_flag", locations_flag
);
575 MUSCLE_INSERT_BOOL ("nondeterministic_flag", nondeterministic_parser
);
576 MUSCLE_INSERT_BOOL ("pull_flag", pull_parser
);
577 MUSCLE_INSERT_BOOL ("pure_flag", pure_parser
);
578 MUSCLE_INSERT_BOOL ("push_flag", push_parser
);
579 MUSCLE_INSERT_BOOL ("synclines_flag", !no_lines_flag
);
580 MUSCLE_INSERT_BOOL ("tag_seen_flag", tag_seen
);
581 MUSCLE_INSERT_BOOL ("use_push_for_pull_flag", use_push_for_pull_flag
);
582 MUSCLE_INSERT_BOOL ("yacc_flag", yacc_flag
);
585 if (spec_name_prefix
)
586 MUSCLE_INSERT_STRING ("prefix", spec_name_prefix
);
588 MUSCLE_INSERT_STRING ("file_name_all_but_ext", all_but_ext
);
590 #define DEFINE(Name) MUSCLE_INSERT_STRING (#Name, Name ? Name : "")
592 DEFINE (parser_file_name
);
593 DEFINE (spec_defines_file
);
594 DEFINE (spec_file_prefix
);
595 DEFINE (spec_graph_file
);
596 DEFINE (spec_name_prefix
);
597 DEFINE (spec_outfile
);
598 DEFINE (spec_verbose_file
);
602 obstack_1grow (&pre_prologue_obstack
, 0);
603 obstack_1grow (&post_prologue_obstack
, 0);
604 muscle_insert ("pre_prologue", obstack_finish (&pre_prologue_obstack
));
605 muscle_insert ("post_prologue", obstack_finish (&post_prologue_obstack
));
607 /* Find the right skeleton file, and add muscles about the skeletons. */
609 MUSCLE_INSERT_C_STRING ("skeleton", skeleton
);
611 skeleton
= language
->skeleton
;
613 /* About the skeletons. */
615 char const *pkgdatadir
= getenv ("BISON_PKGDATADIR");
616 /* b4_pkgdatadir is used inside m4_include in the skeletons, so digraphs
617 would never be expanded. Hopefully no one has M4-special characters in
618 his Bison installation path. */
619 MUSCLE_INSERT_STRING_RAW ("pkgdatadir",
620 pkgdatadir
? pkgdatadir
: PKGDATADIR
);
625 /*----------------------------------------------------------.
626 | Output the parsing tables and the parser code to ftable. |
627 `----------------------------------------------------------*/
632 obstack_init (&format_obstack
);
641 /* Process the selected skeleton file. */
644 obstack_free (&format_obstack
, NULL
);
645 obstack_free (&pre_prologue_obstack
, NULL
);
646 obstack_free (&post_prologue_obstack
, NULL
);