]> git.saurik.com Git - bison.git/blob - src/muscle-tab.c
%define variables: support value changes in deprecation
[bison.git] / src / muscle-tab.c
1 /* Muscle table manager for Bison.
2
3 Copyright (C) 2001-2012 Free Software Foundation, Inc.
4
5 This file is part of Bison, the GNU Compiler Compiler.
6
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.
11
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.
16
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/>. */
19
20 #include <config.h>
21 #include "system.h"
22
23 #include <hash.h>
24
25 #include "complain.h"
26 #include "files.h"
27 #include "getargs.h"
28 #include "muscle-tab.h"
29 #include "quote.h"
30
31 /* A key-value pair, along with storage that can be reclaimed when
32 this pair is no longer needed. */
33 typedef struct
34 {
35 char const *key;
36 char const *value;
37 char *storage;
38 } muscle_entry;
39
40 /* An obstack used to create some entries. */
41 struct obstack muscle_obstack;
42
43 /* Initial capacity of muscles hash table. */
44 #define HT_INITIAL_CAPACITY 257
45
46 static struct hash_table *muscle_table = NULL;
47
48 static bool
49 hash_compare_muscles (void const *x, void const *y)
50 {
51 muscle_entry const *m1 = x;
52 muscle_entry const *m2 = y;
53 return STREQ (m1->key, m2->key);
54 }
55
56 static size_t
57 hash_muscle (const void *x, size_t tablesize)
58 {
59 muscle_entry const *m = x;
60 return hash_string (m->key, tablesize);
61 }
62
63 /*-----------------------------------------------------------------.
64 | Create the MUSCLE_TABLE, and initialize it with default values. |
65 | Also set up the MUSCLE_OBSTACK. |
66 `-----------------------------------------------------------------*/
67
68 static void
69 muscle_entry_free (void *entry)
70 {
71 muscle_entry *mentry = entry;
72 free (mentry->storage);
73 free (mentry);
74 }
75
76 void
77 muscle_init (void)
78 {
79 /* Initialize the muscle obstack. */
80 obstack_init (&muscle_obstack);
81
82 muscle_table = hash_initialize (HT_INITIAL_CAPACITY, NULL, hash_muscle,
83 hash_compare_muscles, muscle_entry_free);
84
85 /* Version and input file. */
86 MUSCLE_INSERT_STRING ("version", VERSION);
87 }
88
89
90 /*------------------------------------------------------------.
91 | Free all the memory consumed by the muscle machinery only. |
92 `------------------------------------------------------------*/
93
94 void
95 muscle_free (void)
96 {
97 hash_free (muscle_table);
98 obstack_free (&muscle_obstack, NULL);
99 }
100
101
102
103 /*------------------------------------------------------------.
104 | Insert (KEY, VALUE). If KEY already existed, overwrite the |
105 | previous value. |
106 `------------------------------------------------------------*/
107
108 void
109 muscle_insert (char const *key, char const *value)
110 {
111 muscle_entry probe;
112 muscle_entry *entry;
113
114 probe.key = key;
115 entry = hash_lookup (muscle_table, &probe);
116
117 if (!entry)
118 {
119 /* First insertion in the hash. */
120 entry = xmalloc (sizeof *entry);
121 entry->key = key;
122 if (!hash_insert (muscle_table, entry))
123 xalloc_die ();
124 }
125 else
126 free (entry->storage);
127 entry->value = value;
128 entry->storage = NULL;
129 }
130
131
132 /*-------------------------------------------------------------------.
133 | Append VALUE to the current value of KEY. If KEY did not already |
134 | exist, create it. Use MUSCLE_OBSTACK. De-allocate the previously |
135 | associated value. Copy VALUE and SEPARATOR. |
136 `-------------------------------------------------------------------*/
137
138 void
139 muscle_grow (const char *key, const char *val, const char *separator)
140 {
141 muscle_entry probe;
142 muscle_entry *entry = NULL;
143
144 probe.key = key;
145 entry = hash_lookup (muscle_table, &probe);
146
147 if (!entry)
148 {
149 /* First insertion in the hash. */
150 entry = xmalloc (sizeof *entry);
151 entry->key = key;
152 if (!hash_insert (muscle_table, entry))
153 xalloc_die ();
154 entry->value = entry->storage = xstrdup (val);
155 }
156 else
157 {
158 /* Grow the current value. */
159 char *new_val;
160 obstack_printf (&muscle_obstack, "%s%s%s", entry->value, separator, val);
161 free (entry->storage);
162 new_val = obstack_finish0 (&muscle_obstack);
163 entry->value = entry->storage = xstrdup (new_val);
164 obstack_free (&muscle_obstack, new_val);
165 }
166 }
167
168 /*------------------------------------------------------------------.
169 | Using muscle_grow, append a synchronization line for the location |
170 | LOC to the current value of KEY. |
171 `------------------------------------------------------------------*/
172
173 static void
174 muscle_syncline_grow (char const *key, location loc)
175 {
176 char *extension = NULL;
177 obstack_printf (&muscle_obstack, "]b4_syncline(%d, ", loc.start.line);
178 obstack_quote (&muscle_obstack,
179 quotearg_style (c_quoting_style, loc.start.file));
180 obstack_sgrow (&muscle_obstack, ")[");
181 extension = obstack_finish0 (&muscle_obstack);
182 muscle_grow (key, extension, "");
183 obstack_free (&muscle_obstack, extension);
184 }
185
186 /*------------------------------------------------------------------.
187 | Append VALUE to the current value of KEY, using muscle_grow. But |
188 | in addition, issue a synchronization line for the location LOC |
189 | using muscle_syncline_grow. |
190 `------------------------------------------------------------------*/
191
192 void
193 muscle_code_grow (const char *key, const char *val, location loc)
194 {
195 muscle_syncline_grow (key, loc);
196 muscle_grow (key, val, "\n");
197 }
198
199
200 void muscle_pair_list_grow (const char *muscle,
201 const char *a1, const char *a2)
202 {
203 char *pair;
204 obstack_sgrow (&muscle_obstack, "[");
205 obstack_quote (&muscle_obstack, a1);
206 obstack_sgrow (&muscle_obstack, ", ");
207 obstack_quote (&muscle_obstack, a2);
208 obstack_sgrow (&muscle_obstack, "]");
209 pair = obstack_finish0 (&muscle_obstack);
210 muscle_grow (muscle, pair, ",\n");
211 obstack_free (&muscle_obstack, pair);
212 }
213
214
215 /*----------------------------------------------------------------------------.
216 | Find the value of muscle KEY. Unlike MUSCLE_FIND, this is always reliable |
217 | to determine whether KEY has a value. |
218 `----------------------------------------------------------------------------*/
219
220 char const *
221 muscle_find_const (char const *key)
222 {
223 muscle_entry probe;
224 muscle_entry *result = NULL;
225
226 probe.key = key;
227 result = hash_lookup (muscle_table, &probe);
228 if (result)
229 return result->value;
230 return NULL;
231 }
232
233
234 /*----------------------------------------------------------------------------.
235 | Find the value of muscle KEY. Abort if muscle_insert was invoked more |
236 | recently than muscle_grow for KEY since muscle_find can't return a |
237 | char const *. |
238 `----------------------------------------------------------------------------*/
239
240 char *
241 muscle_find (char const *key)
242 {
243 muscle_entry probe;
244 muscle_entry *result = NULL;
245
246 probe.key = key;
247 result = hash_lookup (muscle_table, &probe);
248 if (result)
249 {
250 aver (result->value == result->storage);
251 return result->storage;
252 }
253 return NULL;
254 }
255
256
257 /* In the format `file_name:line.column', append BOUND to MUSCLE. Use
258 digraphs for special characters in the file name. */
259
260 static void
261 muscle_boundary_grow (char const *key, boundary bound)
262 {
263 char *extension;
264 obstack_sgrow (&muscle_obstack, "[[");
265 obstack_escape (&muscle_obstack, bound.file);
266 obstack_printf (&muscle_obstack, ":%d.%d]]", bound.line, bound.column);
267 extension = obstack_finish0 (&muscle_obstack);
268 muscle_grow (key, extension, "");
269 obstack_free (&muscle_obstack, extension);
270 }
271
272
273 /* In the format `[[file_name:line.column]], [[file_name:line.column]]',
274 append LOC to MUSCLE. Use digraphs for special characters in each
275 file name. */
276
277 static void
278 muscle_location_grow (char const *key, location loc)
279 {
280 muscle_boundary_grow (key, loc.start);
281 muscle_grow (key, "", ", ");
282 muscle_boundary_grow (key, loc.end);
283 }
284
285 #define COMMON_DECODE(Value) \
286 case '$': \
287 aver (*++(Value) == ']'); \
288 aver (*++(Value) == '['); \
289 obstack_sgrow (&muscle_obstack, "$"); \
290 break; \
291 case '@': \
292 switch (*++(Value)) \
293 { \
294 case '@': obstack_sgrow (&muscle_obstack, "@" ); break; \
295 case '{': obstack_sgrow (&muscle_obstack, "[" ); break; \
296 case '}': obstack_sgrow (&muscle_obstack, "]" ); break; \
297 default: aver (false); break; \
298 } \
299 break; \
300 default: \
301 obstack_1grow (&muscle_obstack, *(Value)); \
302 break;
303
304 /* Reverse of obstack_escape. */
305 static char *
306 string_decode (char const *key)
307 {
308 char const *value = muscle_find_const (key);
309 char *value_decoded;
310 char *result;
311
312 if (!value)
313 return NULL;
314 do {
315 switch (*value)
316 {
317 COMMON_DECODE (value)
318 case '[':
319 case ']':
320 aver (false);
321 break;
322 }
323 } while (*value++);
324 value_decoded = obstack_finish (&muscle_obstack);
325 result = xstrdup (value_decoded);
326 obstack_free (&muscle_obstack, value_decoded);
327 return result;
328 }
329
330 /* Reverse of muscle_location_grow. */
331 static location
332 location_decode (char const *key)
333 {
334 location loc;
335 char const *value = muscle_find_const (key);
336 aver (value);
337 aver (*value == '[');
338 aver (*++value == '[');
339 while (*++value)
340 switch (*value)
341 {
342 COMMON_DECODE (value)
343 case '[':
344 aver (false);
345 break;
346 case ']':
347 {
348 char *boundary_str;
349 aver (*++value == ']');
350 boundary_str = obstack_finish0 (&muscle_obstack);
351 switch (*++value)
352 {
353 case ',':
354 boundary_set_from_string (&loc.start, boundary_str);
355 obstack_free (&muscle_obstack, boundary_str);
356 aver (*++value == ' ');
357 aver (*++value == '[');
358 aver (*++value == '[');
359 break;
360 case '\0':
361 boundary_set_from_string (&loc.end, boundary_str);
362 obstack_free (&muscle_obstack, boundary_str);
363 return loc;
364 break;
365 default:
366 aver (false);
367 break;
368 }
369 }
370 break;
371 }
372 aver (false);
373 return loc;
374 }
375
376 void
377 muscle_user_name_list_grow (char const *key, char const *user_name,
378 location loc)
379 {
380 muscle_grow (key, "[[[[", ",");
381 muscle_grow (key, user_name, "");
382 muscle_grow (key, "]], ", "");
383 muscle_location_grow (key, loc);
384 muscle_grow (key, "]]", "");
385 }
386
387
388 /** Return an allocated string that represents the %define directive
389 that performs the assignment.
390
391 @param assignment "VAR", or "VAR=VAL".
392 @param value default value if VAL \a assignment has no '='.
393
394 For instance:
395 "foo", NULL => "%define foo"
396 "foo", "baz" => "%define foo baz"
397 "foo=bar", NULL => "%define foo bar"
398 "foo=bar", "baz" => "%define foo bar"
399 "foo=", NULL => "%define foo"
400 "foo=", "baz" => "%define foo"
401 */
402
403 static
404 char *
405 define_directive (char const *assignment, char const *value)
406 {
407 char *eq = strchr (assignment, '=');
408 char const *fmt = !eq && value && *value ? "%%define %s %s" : "%%define %s";
409 char *res = xmalloc (strlen (fmt) + strlen (assignment)
410 + (value ? strlen (value) : 0));
411 sprintf (res, fmt, assignment, value);
412 eq = strchr (res, '=');
413 if (eq)
414 *eq = eq[1] ? ' ' : '\0';
415 return res;
416 }
417
418 /** If the \a variable name is obsolete, return the name to use,
419 * otherwise \a variable. If the \a value is obsolete, update it too.
420 *
421 * Allocates the returned value. */
422 static
423 char *
424 muscle_percent_variable_update (char const *variable, location variable_loc,
425 char const **value)
426 {
427 typedef struct
428 {
429 const char *obsolete;
430 const char *updated;
431 } conversion_type;
432 const conversion_type conversion[] =
433 {
434 { "api.push_pull", "api.push-pull", },
435 { "api.tokens.prefix", "api.token.prefix", },
436 { "lex_symbol", "api.token.constructor", },
437 { "location_type", "api.location.type", },
438 { "lr.default-reductions", "lr.default-reduction", },
439 { "lr.keep-unreachable-states", "lr.keep-unreachable-state", },
440 { "lr.keep_unreachable_states", "lr.keep-unreachable-state", },
441 { "namespace", "api.namespace", },
442 { "variant=", "api.value.type=variant", },
443 { "variant=true", "api.value.type=variant", },
444 { NULL, NULL, }
445 };
446 conversion_type const *c;
447 for (c = conversion; c->obsolete; ++c)
448 {
449 char const *eq = strchr (c->obsolete, '=');
450 if (eq
451 ? (!strncmp (c->obsolete, variable, eq - c->obsolete)
452 && STREQ (eq + 1, *value))
453 : STREQ (c->obsolete, variable))
454 {
455 char *old = define_directive (c->obsolete, *value);
456 char *upd = define_directive (c->updated, *value);
457 deprecated_directive (&variable_loc, old, upd);
458 free (old);
459 free (upd);
460 char *res = xstrdup (c->updated);
461 {
462 char *eq2 = strchr (res, '=');
463 if (eq2)
464 {
465 *eq2 = '\0';
466 *value = eq2 + 1;
467 }
468 }
469 return res;
470 }
471 }
472 return xstrdup (variable);
473 }
474
475 void
476 muscle_percent_define_insert (char const *var, location variable_loc,
477 char const *value,
478 muscle_percent_define_how how)
479 {
480 /* Backward compatibility. */
481 char *variable = muscle_percent_variable_update (var, variable_loc, &value);
482 char const *name = UNIQSTR_CONCAT ("percent_define(", variable, ")");
483 char const *loc_name = UNIQSTR_CONCAT ("percent_define_loc(", variable, ")");
484 char const *syncline_name =
485 UNIQSTR_CONCAT ("percent_define_syncline(", variable, ")");
486 char const *how_name = UNIQSTR_CONCAT ("percent_define_how(", variable, ")");
487
488 /* Command-line options are processed before the grammar file. */
489 if (how == MUSCLE_PERCENT_DEFINE_GRAMMAR_FILE
490 && muscle_find_const (name))
491 {
492 muscle_percent_define_how how_old = atoi (muscle_find_const (how_name));
493 unsigned i = 0;
494 if (how_old == MUSCLE_PERCENT_DEFINE_F)
495 goto end;
496 complain_indent (&variable_loc, complaint, &i,
497 _("%%define variable %s redefined"),
498 quote (variable));
499 i += SUB_INDENT;
500 location loc = muscle_percent_define_get_loc (variable);
501 complain_indent (&loc, complaint, &i, _("previous definition"));
502 }
503
504 MUSCLE_INSERT_STRING (name, value);
505 muscle_insert (loc_name, "");
506 muscle_location_grow (loc_name, variable_loc);
507 muscle_insert (syncline_name, "");
508 muscle_syncline_grow (syncline_name, variable_loc);
509 muscle_user_name_list_grow ("percent_define_user_variables", variable,
510 variable_loc);
511 MUSCLE_INSERT_INT (how_name, how);
512 end:
513 free (variable);
514 }
515
516 /* This is used for backward compatibility, e.g., "%define api.pure"
517 supersedes "%pure-parser". */
518 void
519 muscle_percent_define_ensure (char const *variable, location loc,
520 bool value)
521 {
522 char const *val = value ? "" : "false";
523 char const *name = UNIQSTR_CONCAT ("percent_define(", variable, ")");
524
525 /* %pure-parser is deprecated in favor of `%define api.pure', so use
526 `%define api.pure' in a backward-compatible manner here. First,
527 don't complain if %pure-parser is specified multiple times. */
528 if (!muscle_find_const (name))
529 muscle_percent_define_insert (variable, loc, val,
530 MUSCLE_PERCENT_DEFINE_GRAMMAR_FILE);
531 /* In all cases, use api.pure now so that the backend doesn't complain if
532 the skeleton ignores api.pure, but do warn now if there's a previous
533 conflicting definition from an actual %define. */
534 if (muscle_percent_define_flag_if (variable) != value)
535 muscle_percent_define_insert (variable, loc, val,
536 MUSCLE_PERCENT_DEFINE_GRAMMAR_FILE);
537 }
538
539 char *
540 muscle_percent_define_get (char const *variable)
541 {
542 char const *name = UNIQSTR_CONCAT ("percent_define(", variable, ")");
543 char const *usage_name =
544 UNIQSTR_CONCAT ("percent_define_bison_variables(", variable, ")");
545 char *value = string_decode (name);
546 if (!value)
547 value = xstrdup ("");
548
549 muscle_insert (usage_name, "");
550 return value;
551 }
552
553 location
554 muscle_percent_define_get_loc (char const *variable)
555 {
556 char const *loc_name = UNIQSTR_CONCAT ("percent_define_loc(", variable, ")");
557 if (!muscle_find_const (loc_name))
558 complain (NULL, fatal, _("%s: undefined %%define variable %s"),
559 "muscle_percent_define_get_loc", quote (variable));
560 return location_decode (loc_name);
561 }
562
563 char const *
564 muscle_percent_define_get_syncline (char const *variable)
565 {
566 char const *syncline_name =
567 UNIQSTR_CONCAT ("percent_define_syncline(", variable, ")");
568 char const *syncline = muscle_find_const (syncline_name);
569 if (!syncline)
570 complain (NULL, fatal, _("%s: undefined %%define variable %s"),
571 "muscle_percent_define_get_syncline", quote (variable));
572 return syncline;
573 }
574
575 bool
576 muscle_percent_define_ifdef (char const *variable)
577 {
578 char const *name = UNIQSTR_CONCAT ("percent_define(", variable, ")");
579 char const *usage_name =
580 UNIQSTR_CONCAT ("percent_define_bison_variables(", variable, ")");
581 char const *value = muscle_find_const (name);
582 if (value)
583 {
584 muscle_insert (usage_name, "");
585 return true;
586 }
587
588 return false;
589 }
590
591 bool
592 muscle_percent_define_flag_if (char const *variable)
593 {
594 char const *invalid_boolean_name =
595 UNIQSTR_CONCAT ("percent_define_invalid_boolean(", variable, ")");
596 bool result = false;
597
598 if (muscle_percent_define_ifdef (variable))
599 {
600 char *value = muscle_percent_define_get (variable);
601 if (value[0] == '\0' || STREQ (value, "true"))
602 result = true;
603 else if (STREQ (value, "false"))
604 result = false;
605 else if (!muscle_find_const (invalid_boolean_name))
606 {
607 muscle_insert (invalid_boolean_name, "");
608 location loc = muscle_percent_define_get_loc (variable);
609 complain (&loc, complaint,
610 _("invalid value for %%define Boolean variable %s"),
611 quote (variable));
612 }
613 free (value);
614 }
615 else
616 complain (NULL, fatal, _("%s: undefined %%define variable %s"),
617 "muscle_percent_define_flag", quote (variable));
618
619 return result;
620 }
621
622 void
623 muscle_percent_define_default (char const *variable, char const *value)
624 {
625 char const *name = UNIQSTR_CONCAT ("percent_define(", variable, ")");
626 char const *loc_name = UNIQSTR_CONCAT ("percent_define_loc(", variable, ")");
627 char const *syncline_name =
628 UNIQSTR_CONCAT ("percent_define_syncline(", variable, ")");
629 if (!muscle_find_const (name))
630 {
631 location loc;
632 MUSCLE_INSERT_STRING (name, value);
633 loc.start.file = loc.end.file = "<default value>";
634 loc.start.line = loc.end.line = -1;
635 loc.start.column = loc.end.column = -1;
636 muscle_insert (loc_name, "");
637 muscle_location_grow (loc_name, loc);
638 muscle_insert (syncline_name, "");
639 }
640 }
641
642 void
643 muscle_percent_define_check_values (char const * const *values)
644 {
645 for (; *values; ++values)
646 {
647 char const * const *variablep = values;
648 char const *name = UNIQSTR_CONCAT ("percent_define(", *variablep, ")");
649 char *value = string_decode (name);
650 if (value)
651 {
652 for (++values; *values; ++values)
653 {
654 if (STREQ (value, *values))
655 break;
656 }
657 if (!*values)
658 {
659 unsigned i = 0;
660 location loc = muscle_percent_define_get_loc (*variablep);
661 complain_indent (&loc, complaint, &i,
662 _("invalid value for %%define variable %s: %s"),
663 quote (*variablep), quote_n (1, value));
664 i += SUB_INDENT;
665 for (values = variablep + 1; *values; ++values)
666 complain_indent (&loc, complaint | no_caret, &i,
667 _("accepted value: %s"), quote (*values));
668 }
669 else
670 {
671 while (*values)
672 ++values;
673 }
674 free (value);
675 }
676 else
677 complain (NULL, fatal, _("%s: undefined %%define variable %s"),
678 "muscle_percent_define_check_values", quote (*variablep));
679 }
680 }
681
682 void
683 muscle_percent_code_grow (char const *qualifier, location qualifier_loc,
684 char const *code, location code_loc)
685 {
686 char const *name = UNIQSTR_CONCAT ("percent_code(", qualifier, ")");
687 muscle_code_grow (name, code, code_loc);
688 muscle_user_name_list_grow ("percent_code_user_qualifiers", qualifier,
689 qualifier_loc);
690 }
691
692
693 /*------------------------------------------------.
694 | Output the definition of ENTRY as a m4_define. |
695 `------------------------------------------------*/
696
697 static inline bool
698 muscle_m4_output (muscle_entry *entry, FILE *out)
699 {
700 fprintf (out,
701 "m4_define([b4_%s],\n"
702 "[[%s]])\n\n\n", entry->key, entry->value);
703 return true;
704 }
705
706 static bool
707 muscle_m4_output_processor (void *entry, void *out)
708 {
709 return muscle_m4_output (entry, out);
710 }
711
712
713 /*----------------------------------------------------------------.
714 | Output the definition of all the current muscles into a list of |
715 | m4_defines. |
716 `----------------------------------------------------------------*/
717
718 void
719 muscles_m4_output (FILE *out)
720 {
721 hash_do_for_each (muscle_table, muscle_m4_output_processor, out);
722 }