]> git.saurik.com Git - bison.git/blame - src/output.c
Use b4_symbol for printers and destructors everywhere.
[bison.git] / src / output.c
CommitLineData
a932883e 1/* Output the generated parsing program for Bison.
87ceef73 2
e2a21b6f 3 Copyright (C) 1984, 1986, 1989, 1992, 2000, 2001, 2002, 2003, 2004,
1cfe6375 4 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
c3e23647 5
9ee3c97b 6 This file is part of Bison, the GNU Compiler Compiler.
c3e23647 7
f16b0819
PE
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.
c3e23647 12
f16b0819
PE
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.
c3e23647 17
9ee3c97b 18 You should have received a copy of the GNU General Public License
f16b0819 19 along with this program. If not, see <http://www.gnu.org/licenses/>. */
c3e23647 20
2cec9080 21#include <config.h>
c3e23647 22#include "system.h"
21fd22d6 23
3b2942e6 24#include <configmake.h>
21fd22d6
PE
25#include <error.h>
26#include <get-errno.h>
27#include <quotearg.h>
28#include <subpipe.h>
29#include <timevar.h>
30
31#include "complain.h"
c3e23647 32#include "files.h"
21fd22d6 33#include "getargs.h"
c3e23647 34#include "gram.h"
21fd22d6 35#include "muscle_tab.h"
6c89f1c1 36#include "output.h"
a70083a3 37#include "reader.h"
e9071366 38#include "scan-code.h" /* max_left_semantic_context */
04098407 39#include "scan-skel.h"
ad949da9 40#include "symtab.h"
c6f1a33c 41#include "tables.h"
be2a1a68 42
12b0043a 43
f87685c3 44static struct obstack format_obstack;
c3e23647 45
133c20e2 46
5372019f
AD
47/*-------------------------------------------------------------------.
48| Create a function NAME which associates to the muscle NAME the |
49| result of formatting the FIRST and then TABLE_DATA[BEGIN..END[ (of |
50| TYPE), and to the muscle NAME_max, the max value of the |
51| TABLE_DATA. |
52`-------------------------------------------------------------------*/
62a3e4f0 53
62a3e4f0 54
5372019f 55#define GENERATE_MUSCLE_INSERT_TABLE(Name, Type) \
5fbb0954 56 \
5372019f 57static void \
9e0876fb 58Name (char const *name, \
5fbb0954
AD
59 Type *table_data, \
60 Type first, \
61 int begin, \
62 int end) \
63{ \
12b0043a 64 Type min = first; \
0c2d3f4c 65 Type max = first; \
87ceef73
PE
66 long int lmin; \
67 long int lmax; \
5fbb0954
AD
68 int i; \
69 int j = 1; \
70 \
5372019f 71 obstack_fgrow1 (&format_obstack, "%6d", first); \
5fbb0954
AD
72 for (i = begin; i < end; ++i) \
73 { \
5372019f 74 obstack_1grow (&format_obstack, ','); \
5fbb0954
AD
75 if (j >= 10) \
76 { \
5372019f 77 obstack_sgrow (&format_obstack, "\n "); \
5fbb0954
AD
78 j = 1; \
79 } \
80 else \
81 ++j; \
5372019f 82 obstack_fgrow1 (&format_obstack, "%6d", table_data[i]); \
12b0043a
AD
83 if (table_data[i] < min) \
84 min = table_data[i]; \
85 if (max < table_data[i]) \
5fbb0954
AD
86 max = table_data[i]; \
87 } \
5372019f
AD
88 obstack_1grow (&format_obstack, 0); \
89 muscle_insert (name, obstack_finish (&format_obstack)); \
5fbb0954 90 \
87ceef73
PE
91 lmin = min; \
92 lmax = max; \
12b0043a
AD
93 /* Build `NAME_min' and `NAME_max' in the obstack. */ \
94 obstack_fgrow1 (&format_obstack, "%s_min", name); \
95 obstack_1grow (&format_obstack, 0); \
87ceef73 96 MUSCLE_INSERT_LONG_INT (obstack_finish (&format_obstack), lmin); \
5372019f
AD
97 obstack_fgrow1 (&format_obstack, "%s_max", name); \
98 obstack_1grow (&format_obstack, 0); \
87ceef73 99 MUSCLE_INSERT_LONG_INT (obstack_finish (&format_obstack), lmax); \
62a3e4f0
AD
100}
101
5372019f 102GENERATE_MUSCLE_INSERT_TABLE(muscle_insert_unsigned_int_table, unsigned int)
12b0043a 103GENERATE_MUSCLE_INSERT_TABLE(muscle_insert_int_table, int)
21fd22d6
PE
104GENERATE_MUSCLE_INSERT_TABLE(muscle_insert_base_table, base_number)
105GENERATE_MUSCLE_INSERT_TABLE(muscle_insert_rule_number_table, rule_number)
106GENERATE_MUSCLE_INSERT_TABLE(muscle_insert_symbol_number_table, symbol_number)
107GENERATE_MUSCLE_INSERT_TABLE(muscle_insert_item_number_table, item_number)
108GENERATE_MUSCLE_INSERT_TABLE(muscle_insert_state_number_table, state_number)
c3e23647
RS
109
110
05ac60f3
PE
111/*--------------------------------------------------------------------.
112| Print to OUT a representation of STRING escaped both for C and M4. |
113`--------------------------------------------------------------------*/
3813e141
PE
114
115static void
05ac60f3 116escaped_output (FILE *out, char const *string)
3813e141
PE
117{
118 char const *p;
2f4f028d 119 fprintf (out, "[[");
3813e141 120
05ac60f3 121 for (p = quotearg_style (c_quoting_style, string); *p; p++)
3813e141
PE
122 switch (*p)
123 {
124 case '$': fputs ("$][", out); break;
125 case '@': fputs ("@@", out); break;
126 case '[': fputs ("@{", out); break;
127 case ']': fputs ("@}", out); break;
128 default: fputc (*p, out); break;
129 }
130
2f4f028d 131 fprintf (out, "]]");
3813e141
PE
132}
133
134
39912f52
AD
135/*------------------------------------------------------------------.
136| Prepare the muscles related to the symbols: translate, tname, and |
137| toknum. |
138`------------------------------------------------------------------*/
b0940840 139
4a120d45 140static void
39912f52 141prepare_symbols (void)
c3e23647 142{
141f5793 143 MUSCLE_INSERT_BOOL ("token_table", token_table_flag);
39912f52
AD
144 MUSCLE_INSERT_INT ("tokens_number", ntokens);
145 MUSCLE_INSERT_INT ("nterms_number", nvars);
d69c9694 146 MUSCLE_INSERT_INT ("symbols_number", nsyms);
39912f52
AD
147 MUSCLE_INSERT_INT ("undef_token_number", undeftoken->number);
148 MUSCLE_INSERT_INT ("user_token_number_max", max_user_token_number);
149
a49aecd5 150 muscle_insert_symbol_number_table ("translate",
fc5734fe
AD
151 token_translations,
152 token_translations[0],
153 1, max_user_token_number + 1);
c3e23647 154
39912f52 155 /* tname -- token names. */
b0940840
AD
156 {
157 int i;
d423d460
AD
158 /* We assume that the table will be output starting at column 2. */
159 int j = 2;
1cfe6375
JD
160 struct quoting_options *qo = clone_quoting_options (0);
161 set_quoting_style (qo, c_quoting_style);
162 set_quoting_flags (qo, QA_SPLIT_TRIGRAPHS);
b0940840
AD
163 for (i = 0; i < nsyms; i++)
164 {
1cfe6375 165 char *cp = quotearg_alloc (symbols[i]->tag, -1, qo);
d423d460
AD
166 /* Width of the next token, including the two quotes, the
167 comma and the space. */
21fd22d6 168 int width = strlen (cp) + 2;
b0940840 169
21fd22d6 170 if (j + width > 75)
b0940840 171 {
d423d460
AD
172 obstack_sgrow (&format_obstack, "\n ");
173 j = 1;
b0940840
AD
174 }
175
d423d460
AD
176 if (i)
177 obstack_1grow (&format_obstack, ' ');
3813e141 178 MUSCLE_OBSTACK_SGROW (&format_obstack, cp);
1cfe6375 179 free (cp);
d423d460 180 obstack_1grow (&format_obstack, ',');
21fd22d6 181 j += width;
b0940840 182 }
1cfe6375 183 free (qo);
8e1687ae 184 obstack_sgrow (&format_obstack, " ]b4_null[");
c3e23647 185
b0940840
AD
186 /* Finish table and store. */
187 obstack_1grow (&format_obstack, 0);
188 muscle_insert ("tname", obstack_finish (&format_obstack));
189 }
190
12b0043a 191 /* Output YYTOKNUM. */
b2ed6e58
AD
192 {
193 int i;
da2a7671 194 int *values = xnmalloc (ntokens, sizeof *values);
3650b4b8 195 for (i = 0; i < ntokens; ++i)
b0940840 196 values[i] = symbols[i]->user_token_number;
12b0043a 197 muscle_insert_int_table ("toknum", values,
3650b4b8 198 values[0], 1, ntokens);
b0940840 199 free (values);
b2ed6e58 200 }
b0940840 201}
b2ed6e58 202
b0940840 203
3d3bc1fe
AD
204/*----------------------------------------------------------------.
205| Prepare the muscles related to the rules: r1, r2, rline, dprec, |
206| merger. |
207`----------------------------------------------------------------*/
b0940840
AD
208
209static void
210prepare_rules (void)
211{
da2a7671
PE
212 unsigned int *rline = xnmalloc (nrules, sizeof *rline);
213 symbol_number *r1 = xnmalloc (nrules, sizeof *r1);
214 unsigned int *r2 = xnmalloc (nrules, sizeof *r2);
f6fbd3da
PE
215 int *dprec = xnmalloc (nrules, sizeof *dprec);
216 int *merger = xnmalloc (nrules, sizeof *merger);
4b3d3a8e 217
3d3bc1fe 218 rule_number r;
4b3d3a8e 219 for (r = 0; r < nrules; ++r)
b0940840 220 {
b0940840
AD
221 /* LHS of the rule R. */
222 r1[r] = rules[r].lhs->number;
223 /* Length of rule R's RHS. */
3d3bc1fe 224 r2[r] = rule_rhs_length(&rules[r]);
b0940840 225 /* Line where rule was defined. */
2073702c 226 rline[r] = rules[r].location.start.line;
95612cfa 227 /* Dynamic precedence (GLR). */
676385e2 228 dprec[r] = rules[r].dprec;
95612cfa 229 /* Merger-function index (GLR). */
676385e2 230 merger[r] = rules[r].merger;
b0940840 231 }
b0940840 232
4b3d3a8e
AD
233 muscle_insert_unsigned_int_table ("rline", rline, 0, 0, nrules);
234 muscle_insert_symbol_number_table ("r1", r1, 0, 0, nrules);
235 muscle_insert_unsigned_int_table ("r2", r2, 0, 0, nrules);
f6fbd3da
PE
236 muscle_insert_int_table ("dprec", dprec, 0, 0, nrules);
237 muscle_insert_int_table ("merger", merger, 0, 0, nrules);
796d61fb 238
39912f52 239 MUSCLE_INSERT_INT ("rules_number", nrules);
25005f6a 240 MUSCLE_INSERT_INT ("max_left_semantic_context", max_left_semantic_context);
39912f52 241
5df5f6d5
AD
242 free (rline);
243 free (r1);
b0940840 244 free (r2);
676385e2
PH
245 free (dprec);
246 free (merger);
c3e23647
RS
247}
248
b0940840
AD
249/*--------------------------------------------.
250| Prepare the muscles related to the states. |
251`--------------------------------------------*/
c3e23647 252
4a120d45 253static void
b0940840 254prepare_states (void)
c3e23647 255{
21fd22d6 256 state_number i;
da2a7671 257 symbol_number *values = xnmalloc (nstates, sizeof *values);
9703cc49 258 for (i = 0; i < nstates; ++i)
29e88316 259 values[i] = states[i]->accessing_symbol;
a49aecd5 260 muscle_insert_symbol_number_table ("stos", values,
d57650a5 261 0, 1, nstates);
87ceef73 262 free (values);
39912f52
AD
263
264 MUSCLE_INSERT_INT ("last", high);
265 MUSCLE_INSERT_INT ("final_state_number", final_state->number);
266 MUSCLE_INSERT_INT ("states_number", nstates);
c3e23647
RS
267}
268
269
4c3cc7da
AD
270/*-------------------------------------------------------.
271| Compare two symbols by type-name, and then by number. |
272`-------------------------------------------------------*/
273
d73e55e0 274static int
4c3cc7da
AD
275symbol_type_name_cmp (const symbol **lhs, const symbol **rhs)
276{
277 int res = UNIQSTR_CMP((*lhs)->type_name, (*rhs)->type_name);
278 if (res)
279 return res;
280 return (*lhs)->number - (*rhs)->number;
281}
282
283
284/*----------------------------------------------------------------.
285| Return a (malloc'ed) table of the symbols sorted by type-name. |
286`----------------------------------------------------------------*/
287
288static symbol **
d73e55e0 289symbols_by_type_name (void)
4c3cc7da
AD
290{
291 typedef int (*qcmp_type) (const void *, const void *);
292 symbol **res = xmemdup (symbols, nsyms * sizeof *res);
293 qsort (res, nsyms, sizeof *res, (qcmp_type) &symbol_type_name_cmp);
294 return res;
295}
296
297
298/*------------------------------------------------------------------.
299| Define b4_type_names, which is a list of (lists of the numbers of |
300| symbols with same type-name). |
301`------------------------------------------------------------------*/
302
303static void
304type_names_output (FILE *out)
305{
306 int i;
4c3cc7da
AD
307 symbol **syms = symbols_by_type_name ();
308 fputs ("m4_define([b4_type_names],\n[", out);
5d731440
AD
309 for (i = 0; i < nsyms; /* nothing */)
310 {
311 // The index of the first symbol of the current type-name.
312 int i0 = i;
313 fputs (i ? ",\n[" : "[", out);
314 for (; i < nsyms && syms[i]->type_name == syms[i0]->type_name; ++i)
315 fprintf (out, "%s%d", i != i0 ? ", " : "", syms[i]->number);
316 fputs ("]", out);
317 }
4c3cc7da
AD
318 fputs ("])\n\n", out);
319 free (syms);
320}
321
c3e23647 322
d69c9694
AD
323/*-------------------------------------.
324| The list of all the symbol numbers. |
325`-------------------------------------*/
5ab8c47b
AD
326
327static void
d69c9694 328symbol_numbers_output (FILE *out)
5ab8c47b
AD
329{
330 int i;
d69c9694 331 fputs ("m4_define([b4_symbol_numbers],\n[", out);
5ab8c47b 332 for (i = 0; i < nsyms; ++i)
d69c9694 333 fprintf (out, "%s[%d]", i ? ", " : "", i);
5ab8c47b
AD
334 fputs ("])\n\n", out);
335}
336
337
bb33f19a
PE
338/*---------------------------------.
339| Output the user actions to OUT. |
340`---------------------------------*/
12b0043a 341
4a120d45 342static void
c6f1a33c 343user_actions_output (FILE *out)
3f96f4dc 344{
21fd22d6 345 rule_number r;
dafdc66f 346
8e1687ae 347 fputs ("m4_define([b4_actions], \n[", out);
4b3d3a8e 348 for (r = 0; r < nrules; ++r)
9222837b 349 if (rules[r].action)
3f96f4dc 350 {
8e1687ae 351 fprintf (out, "b4_case(%d, [b4_syncline(%d, ", r + 1,
2073702c 352 rules[r].action_location.start.line);
05ac60f3 353 escaped_output (out, rules[r].action_location.start.file);
8e1687ae 354 fprintf (out, ")\n[ %s]])\n\n", rules[r].action);
3f96f4dc 355 }
8e1687ae 356 fputs ("])\n\n", out);
3f96f4dc
AD
357}
358
1de69d6a
AD
359/*------------------------------------.
360| Output the merge functions to OUT. |
361`------------------------------------*/
676385e2 362
41442480 363static void
676385e2
PH
364merger_output (FILE *out)
365{
366 int n;
367 merger_list* p;
368
369 fputs ("m4_define([b4_mergers], \n[[", out);
e0e5bf84 370 for (n = 1, p = merge_functions; p != NULL; n += 1, p = p->next)
676385e2 371 {
e0e5bf84 372 if (p->type[0] == '\0')
16caa4f4 373 fprintf (out, " case %d: *yy0 = %s (*yy0, *yy1); break;\n",
676385e2
PH
374 n, p->name);
375 else
16caa4f4 376 fprintf (out, " case %d: yy0->%s = %s (*yy0, *yy1); break;\n",
676385e2
PH
377 n, p->type, p->name);
378 }
379 fputs ("]])\n\n", out);
380}
3f96f4dc 381
d69c9694 382
d73e55e0
DJ
383/*---------------------------------------------.
384| Prepare the muscles for symbol definitions. |
385`---------------------------------------------*/
d69c9694
AD
386
387static void
d73e55e0 388prepare_symbol_definitions (void)
d69c9694
AD
389{
390 int i;
391 for (i = 0; i < nsyms; ++i)
392 {
393 symbol *sym = symbols[i];
394 const char *key;
aea10ef4 395 const char *value;
d69c9694
AD
396
397#define SET_KEY(Entry) \
398 obstack_fgrow2 (&format_obstack, "symbol(%d, %s)", i, Entry); \
399 obstack_1grow (&format_obstack, 0); \
400 key = obstack_finish (&format_obstack);
401
aea10ef4
AD
402 // Whether the symbol has an identifier.
403 value = symbol_id_get (sym);
404 SET_KEY("has_id");
405 MUSCLE_INSERT_INT (key, !!value);
406
407 // Its identifier.
408 SET_KEY("id");
409 MUSCLE_INSERT_STRING (key, value ? value : "");
8be046d7 410
aea10ef4 411 // Its tag. Typically for documentation purpose.
d69c9694
AD
412 SET_KEY("tag");
413 MUSCLE_INSERT_STRING (key, sym->tag);
414
415 SET_KEY("user_number");
416 MUSCLE_INSERT_INT (key, sym->user_token_number);
417
5d731440
AD
418 SET_KEY("is_token");
419 MUSCLE_INSERT_INT (key,
420 i < ntokens && sym != errtoken && sym != undeftoken);
421
d69c9694
AD
422 SET_KEY("number");
423 MUSCLE_INSERT_INT (key, sym->number);
424
6659366c 425 SET_KEY("has_type");
5d731440
AD
426 MUSCLE_INSERT_INT (key, !!sym->type_name);
427
6659366c 428 SET_KEY("type");
d69c9694
AD
429 MUSCLE_INSERT_STRING (key, sym->type_name ? sym->type_name : "");
430
2bde9113
AD
431#define CODE_PROP(PropName) \
432 do { \
433 code_props const *p = symbol_ ## PropName ## _get (sym); \
434 SET_KEY("has_" #PropName); \
435 MUSCLE_INSERT_INT (key, !!p->code); \
436 \
437 if (p->code) \
438 { \
439 SET_KEY(#PropName "_file"); \
440 MUSCLE_INSERT_STRING (key, p->location.start.file); \
441 \
442 SET_KEY(#PropName "_line"); \
443 MUSCLE_INSERT_INT (key, p->location.start.line); \
444 \
445 SET_KEY(#PropName); \
446 MUSCLE_INSERT_STRING_RAW (key, p->code); \
447 } \
448 } while (0)
449
450 CODE_PROP(destructor);
451 CODE_PROP(printer);
452#undef CODE_PROP
d69c9694
AD
453#undef SET_KEY
454 }
455}
456
457
ae7453f2
AD
458/*--------------------------------------.
459| Output the tokens definition to OUT. |
460`--------------------------------------*/
091e20bb 461
c6f1a33c 462static void
be2a1a68 463token_definitions_output (FILE *out)
091e20bb
AD
464{
465 int i;
d0829076 466 char const *sep = "";
dafdc66f
AD
467
468 fputs ("m4_define([b4_tokens], \n[", out);
091e20bb
AD
469 for (i = 0; i < ntokens; ++i)
470 {
21fd22d6
PE
471 symbol *sym = symbols[i];
472 int number = sym->user_token_number;
091e20bb 473
b87f8b21
AD
474 /* At this stage, if there are literal aliases, they are part of
475 SYMBOLS, so we should not find symbols which are the aliases
476 here. */
4f82b42a 477 aver (number != USER_NUMBER_ALIAS);
b87f8b21 478
091e20bb 479 /* Skip error token. */
21fd22d6 480 if (sym == errtoken)
091e20bb 481 continue;
b87f8b21
AD
482
483 /* If this string has an alias, then it is necessarily the alias
484 which is to be output. */
21fd22d6
PE
485 if (sym->alias)
486 sym = sym->alias;
b87f8b21
AD
487
488 /* Don't output literal chars or strings (when defined only as a
489 string). Note that must be done after the alias resolution:
490 think about `%token 'f' "f"'. */
21fd22d6 491 if (sym->tag[0] == '\'' || sym->tag[0] == '\"')
b87f8b21 492 continue;
091e20bb
AD
493
494 /* Don't #define nonliteral tokens whose names contain periods
495 or '$' (as does the default value of the EOF token). */
21fd22d6 496 if (strchr (sym->tag, '.') || strchr (sym->tag, '$'))
091e20bb
AD
497 continue;
498
05ac60f3 499 fprintf (out, "%s[[[%s]], %d]",
d0829076
PE
500 sep, sym->tag, number);
501 sep = ",\n";
091e20bb 502 }
dafdc66f 503 fputs ("])\n\n", out);
091e20bb
AD
504}
505
506
4a120d45 507static void
c6f1a33c 508prepare_actions (void)
6c89f1c1 509{
c6f1a33c 510 /* Figure out the actions for the specified state, indexed by
742e4900 511 lookahead token type. */
bbb5bcc6 512
c6f1a33c
AD
513 muscle_insert_rule_number_table ("defact", yydefact,
514 yydefact[0], 1, nstates);
6c89f1c1 515
c6f1a33c
AD
516 /* Figure out what to do after reducing with each rule, depending on
517 the saved state from before the beginning of parsing the data
518 that matched this rule. */
d57650a5
AD
519 muscle_insert_state_number_table ("defgoto", yydefgoto,
520 yydefgoto[0], 1, nsyms - ntokens);
12b0043a 521
12b0043a 522
12b0043a
AD
523 /* Output PACT. */
524 muscle_insert_base_table ("pact", base,
5372019f 525 base[0], 1, nstates);
12b0043a 526 MUSCLE_INSERT_INT ("pact_ninf", base_ninf);
c3e23647 527
12b0043a
AD
528 /* Output PGOTO. */
529 muscle_insert_base_table ("pgoto", base,
5372019f 530 base[nstates], nstates + 1, nvectors);
c3e23647 531
12b0043a
AD
532 muscle_insert_base_table ("table", table,
533 table[0], 1, high + 1);
534 MUSCLE_INSERT_INT ("table_ninf", table_ninf);
676385e2 535
12b0043a
AD
536 muscle_insert_base_table ("check", check,
537 check[0], 1, high + 1);
c3e23647 538
ea99527d
AD
539 /* GLR parsing slightly modifies YYTABLE and YYCHECK (and thus
540 YYPACT) so that in states with unresolved conflicts, the default
541 reduction is not used in the conflicted entries, so that there is
542 a place to put a conflict pointer.
543
544 This means that YYCONFLP and YYCONFL are nonsense for a non-GLR
545 parser, so we could avoid accidents by not writing them out in
546 that case. Nevertheless, it seems even better to be able to use
547 the GLR skeletons even without the non-deterministic tables. */
548 muscle_insert_unsigned_int_table ("conflict_list_heads", conflict_table,
39912f52 549 conflict_table[0], 1, high + 1);
ea99527d 550 muscle_insert_unsigned_int_table ("conflicting_rules", conflict_list,
da2a7671 551 0, 1, conflict_list_cnt);
6c89f1c1 552}
4175f6bb
AD
553
554
555/*--------------------------------------------.
556| Output the definitions of all the muscles. |
557`--------------------------------------------*/
558
559static void
560muscles_output (FILE *out)
561{
562 fputs ("m4_init()\n", out);
4175f6bb 563 merger_output (out);
d69c9694
AD
564 symbol_numbers_output (out);
565 token_definitions_output (out);
4c3cc7da 566 type_names_output (out);
d69c9694 567 user_actions_output (out);
4c3cc7da 568 // Must be last.
4175f6bb
AD
569 muscles_m4_output (out);
570}
652def80 571\f
1239777d
AD
572/*---------------------------.
573| Call the skeleton parser. |
574`---------------------------*/
c3e23647 575
4a120d45 576static void
1239777d 577output_skeleton (void)
9b3add5b 578{
573312ac 579 FILE *in;
573312ac 580 int filter_fd[2];
d67c52e8 581 char const *argv[9];
573312ac
PE
582 pid_t pid;
583
a9fc7990 584 /* Compute the names of the package data dir and skeleton files. */
573312ac 585 char const m4sugar[] = "m4sugar/m4sugar.m4";
90b9908d 586 char const m4bison[] = "bison.m4";
2fd4e131 587 char *full_m4sugar;
90b9908d 588 char *full_m4bison;
eecf08fe 589 char *full_skeleton;
573312ac
PE
590 char const *p;
591 char const *m4 = (p = getenv ("M4")) ? p : M4;
d4bd2295 592 char const *pkgdatadir = compute_pkgdatadir ();
573312ac
PE
593 size_t skeleton_size = strlen (skeleton) + 1;
594 size_t pkgdatadirlen = strlen (pkgdatadir);
595 while (pkgdatadirlen && pkgdatadir[pkgdatadirlen - 1] == '/')
596 pkgdatadirlen--;
eecf08fe
PE
597 full_skeleton = xmalloc (pkgdatadirlen + 1
598 + (skeleton_size < sizeof m4sugar
599 ? sizeof m4sugar : skeleton_size));
a7867f53 600 strncpy (full_skeleton, pkgdatadir, pkgdatadirlen);
eecf08fe
PE
601 full_skeleton[pkgdatadirlen] = '/';
602 strcpy (full_skeleton + pkgdatadirlen + 1, m4sugar);
603 full_m4sugar = xstrdup (full_skeleton);
90b9908d
PB
604 strcpy (full_skeleton + pkgdatadirlen + 1, m4bison);
605 full_m4bison = xstrdup (full_skeleton);
a7867f53
JD
606 if (strchr (skeleton, '/'))
607 strcpy (full_skeleton, skeleton);
608 else
609 strcpy (full_skeleton + pkgdatadirlen + 1, skeleton);
a9fc7990
JD
610
611 /* Test whether m4sugar.m4 is readable, to check for proper
612 installation. A faulty installation can cause deadlock, so a
613 cheap sanity check is worthwhile. */
2fd4e131 614 xfclose (xfopen (full_m4sugar, "r"));
573312ac
PE
615
616 /* Create an m4 subprocess connected to us via two pipes. */
617
618 if (trace_flag & trace_tools)
90b9908d 619 fprintf (stderr, "running: %s %s - %s %s\n",
a9fc7990 620 m4, full_m4sugar, full_m4bison, full_skeleton);
573312ac 621
a9fc7990
JD
622 /* Some future version of GNU M4 (most likely 1.6) may treat the -dV in a
623 position-dependent manner. Keep it as the first argument so that all
624 files are traced.
573312ac 625
a9fc7990
JD
626 See the thread starting at
627 <http://lists.gnu.org/archive/html/bug-bison/2008-07/msg00000.html>
628 for details. */
629 {
630 int i = 0;
631 argv[i++] = m4;
d67c52e8
EB
632 argv[i++] = "-I";
633 argv[i++] = pkgdatadir;
a9fc7990
JD
634 if (trace_flag & trace_m4)
635 argv[i++] = "-dV";
636 argv[i++] = full_m4sugar;
637 argv[i++] = "-";
638 argv[i++] = full_m4bison;
639 argv[i++] = full_skeleton;
640 argv[i++] = NULL;
641 }
642 /* When POSIXLY_CORRECT is set, some future versions of GNU M4 (most likely
643 2.0) may drop some of the GNU extensions that Bison's skeletons depend
644 upon. So that the next release of Bison is forward compatible with those
645 future versions of GNU M4, we unset POSIXLY_CORRECT here.
646
647 FIXME: A user might set POSIXLY_CORRECT to affect processes run from
648 macros like m4_syscmd in a custom skeleton. For now, Bison makes no
649 promises about the behavior of custom skeletons, so this scenario is not a
650 concern. However, we eventually want to eliminate this shortcoming. The
651 next release of GNU M4 (1.4.12 or 1.6) will accept the -g command-line
652 option as a no-op, and later releases will accept it to indicate that
653 POSIXLY_CORRECT should be ignored. Once the GNU M4 versions that accept
654 -g are pervasive, Bison should use -g instead of unsetting
655 POSIXLY_CORRECT.
656
657 See the thread starting at
658 <http://lists.gnu.org/archive/html/bug-bison/2008-07/msg00000.html>
659 for details. */
660 unsetenv ("POSIXLY_CORRECT");
573312ac
PE
661 init_subpipe ();
662 pid = create_subpipe (argv, filter_fd);
2fd4e131 663 free (full_m4sugar);
a9fc7990 664 free (full_m4bison);
eecf08fe 665 free (full_skeleton);
573312ac 666
5263bea9
AD
667 if (trace_flag & trace_muscles)
668 muscles_output (stderr);
669 {
670 FILE *out = fdopen (filter_fd[0], "w");
671 if (! out)
672 error (EXIT_FAILURE, get_errno (),
673 "fdopen");
674 muscles_output (out);
675 xfclose (out);
676 }
be2a1a68 677
573312ac 678 /* Read and process m4's output. */
1509d42f 679 timevar_push (TV_M4);
ec4d88f4 680 end_of_output_subpipe (pid, filter_fd);
573312ac
PE
681 in = fdopen (filter_fd[1], "r");
682 if (! in)
04098407
PE
683 error (EXIT_FAILURE, get_errno (),
684 "fdopen");
573312ac 685 scan_skel (in);
573312ac
PE
686 xfclose (in);
687 reap_subpipe (pid, m4);
1509d42f 688 timevar_pop (TV_M4);
26f609ff
RA
689}
690
691static void
692prepare (void)
693{
945e396c
JD
694 /* BISON_USE_PUSH_FOR_PULL is for the test suite and should not be documented
695 for the user. */
696 char const *use_push_for_pull_env = getenv ("BISON_USE_PUSH_FOR_PULL");
697 bool use_push_for_pull_flag = false;
698 if (use_push_for_pull_env != NULL
699 && use_push_for_pull_env[0] != '\0'
700 && 0 != strcmp (use_push_for_pull_env, "0"))
701 use_push_for_pull_flag = true;
702
7db2ed2d 703 /* Flags. */
327afc7c 704 MUSCLE_INSERT_BOOL ("debug_flag", debug_flag);
d0829076 705 MUSCLE_INSERT_BOOL ("defines_flag", defines_flag);
327afc7c 706 MUSCLE_INSERT_BOOL ("error_verbose_flag", error_verbose);
90b9908d 707 MUSCLE_INSERT_BOOL ("glr_flag", glr_parser);
d0829076 708 MUSCLE_INSERT_BOOL ("locations_flag", locations_flag);
90b9908d 709 MUSCLE_INSERT_BOOL ("nondeterministic_flag", nondeterministic_parser);
d0829076 710 MUSCLE_INSERT_BOOL ("synclines_flag", !no_lines_flag);
ddc8ede1 711 MUSCLE_INSERT_BOOL ("tag_seen_flag", tag_seen);
95021767 712 MUSCLE_INSERT_BOOL ("use_push_for_pull_flag", use_push_for_pull_flag);
b931235e 713 MUSCLE_INSERT_BOOL ("yacc_flag", yacc_flag);
11d82f03 714
573a6cd3 715 /* File names. */
90b9908d
PB
716 if (spec_name_prefix)
717 MUSCLE_INSERT_STRING ("prefix", spec_name_prefix);
718
bd9d212b
JD
719 MUSCLE_INSERT_STRING ("file_name_all_but_ext", all_but_ext);
720
2b81e969
AD
721#define DEFINE(Name) MUSCLE_INSERT_STRING (#Name, Name ? Name : "")
722 DEFINE (dir_prefix);
723 DEFINE (parser_file_name);
724 DEFINE (spec_defines_file);
725 DEFINE (spec_file_prefix);
726 DEFINE (spec_graph_file);
727 DEFINE (spec_name_prefix);
728 DEFINE (spec_outfile);
729 DEFINE (spec_verbose_file);
730#undef DEFINE
b85810ae 731
0e021770
PE
732 /* Find the right skeleton file, and add muscles about the skeletons. */
733 if (skeleton)
734 MUSCLE_INSERT_C_STRING ("skeleton", skeleton);
735 else
736 skeleton = language->skeleton;
381fb12e 737
0e021770 738 /* About the skeletons. */
cf147260 739 {
bd9d212b
JD
740 /* b4_pkgdatadir is used inside m4_include in the skeletons, so digraphs
741 would never be expanded. Hopefully no one has M4-special characters in
742 his Bison installation path. */
d4bd2295 743 MUSCLE_INSERT_STRING_RAW ("pkgdatadir", compute_pkgdatadir ());
cf147260 744 }
26f609ff 745}
c3e23647 746
93ede233 747
6c89f1c1
AD
748/*----------------------------------------------------------.
749| Output the parsing tables and the parser code to ftable. |
750`----------------------------------------------------------*/
c3e23647 751
6c89f1c1
AD
752void
753output (void)
754{
f87685c3 755 obstack_init (&format_obstack);
dd60faec 756
39912f52 757 prepare_symbols ();
b0940840
AD
758 prepare_rules ();
759 prepare_states ();
536545f3 760 prepare_actions ();
d73e55e0 761 prepare_symbol_definitions ();
342b8b6e 762
26f609ff 763 prepare ();
652def80 764
9b3add5b
RA
765 /* Process the selected skeleton file. */
766 output_skeleton ();
767
f499b062 768 obstack_free (&format_obstack, NULL);
c3e23647 769}
d4bd2295
JD
770
771char const *
772compute_pkgdatadir (void)
773{
774 char const *pkgdatadir = getenv ("BISON_PKGDATADIR");
775 return pkgdatadir ? pkgdatadir : PKGDATADIR;
776}