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