1 /* Muscle table manager for Bison.
3 Copyright (C) 2001-2012 Free Software Foundation, Inc.
5 This file is part of Bison, the GNU Compiler Compiler.
7 This program is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 This program is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with this program. If not, see <http://www.gnu.org/licenses/>. */
28 #include "muscle-tab.h"
31 /* A key-value pair, along with storage that can be reclaimed when
32 this pair is no longer needed. */
40 /* An obstack used to create some entries. */
41 struct obstack muscle_obstack
;
43 /* Initial capacity of muscles hash table. */
44 #define HT_INITIAL_CAPACITY 257
46 static struct hash_table
*muscle_table
= NULL
;
49 hash_compare_muscles (void const *x
, void const *y
)
51 muscle_entry
const *m1
= x
;
52 muscle_entry
const *m2
= y
;
53 return STREQ (m1
->key
, m2
->key
);
57 hash_muscle (const void *x
, size_t tablesize
)
59 muscle_entry
const *m
= x
;
60 return hash_string (m
->key
, tablesize
);
63 /*-----------------------------------------------------------------.
64 | Create the MUSCLE_TABLE, and initialize it with default values. |
65 | Also set up the MUSCLE_OBSTACK. |
66 `-----------------------------------------------------------------*/
69 muscle_entry_free (void *entry
)
71 muscle_entry
*mentry
= entry
;
72 free (mentry
->storage
);
79 /* Initialize the muscle obstack. */
80 obstack_init (&muscle_obstack
);
82 muscle_table
= hash_initialize (HT_INITIAL_CAPACITY
, NULL
, hash_muscle
,
83 hash_compare_muscles
, muscle_entry_free
);
85 /* Version and input file. */
86 MUSCLE_INSERT_STRING ("version", VERSION
);
90 /*------------------------------------------------------------.
91 | Free all the memory consumed by the muscle machinery only. |
92 `------------------------------------------------------------*/
97 hash_free (muscle_table
);
98 obstack_free (&muscle_obstack
, NULL
);
103 /*------------------------------------------------------------.
104 | Insert (KEY, VALUE). If KEY already existed, overwrite the |
106 `------------------------------------------------------------*/
109 muscle_insert (char const *key
, char const *value
)
115 entry
= hash_lookup (muscle_table
, &probe
);
119 /* First insertion in the hash. */
120 entry
= xmalloc (sizeof *entry
);
122 if (!hash_insert (muscle_table
, entry
))
126 free (entry
->storage
);
127 entry
->value
= value
;
128 entry
->storage
= NULL
;
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 `-------------------------------------------------------------------*/
139 muscle_grow (const char *key
, const char *val
, const char *separator
)
142 muscle_entry
*entry
= NULL
;
145 entry
= hash_lookup (muscle_table
, &probe
);
149 /* First insertion in the hash. */
150 entry
= xmalloc (sizeof *entry
);
152 if (!hash_insert (muscle_table
, entry
))
154 entry
->value
= entry
->storage
= xstrdup (val
);
158 /* Grow the current value. */
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
);
168 /*------------------------------------------------------------------.
169 | Using muscle_grow, append a synchronization line for the location |
170 | LOC to the current value of KEY. |
171 `------------------------------------------------------------------*/
174 muscle_syncline_grow (char const *key
, location loc
)
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
);
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 `------------------------------------------------------------------*/
193 muscle_code_grow (const char *key
, const char *val
, location loc
)
195 muscle_syncline_grow (key
, loc
);
196 muscle_grow (key
, val
, "\n");
200 void muscle_pair_list_grow (const char *muscle
,
201 const char *a1
, const char *a2
)
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
);
215 /*----------------------------------------------------------------------------.
216 | Find the value of muscle KEY. Unlike MUSCLE_FIND, this is always reliable |
217 | to determine whether KEY has a value. |
218 `----------------------------------------------------------------------------*/
221 muscle_find_const (char const *key
)
224 muscle_entry
*result
= NULL
;
227 result
= hash_lookup (muscle_table
, &probe
);
229 return result
->value
;
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 |
238 `----------------------------------------------------------------------------*/
241 muscle_find (char const *key
)
244 muscle_entry
*result
= NULL
;
247 result
= hash_lookup (muscle_table
, &probe
);
250 aver (result
->value
== result
->storage
);
251 return result
->storage
;
257 /* In the format `file_name:line.column', append BOUND to MUSCLE. Use
258 digraphs for special characters in the file name. */
261 muscle_boundary_grow (char const *key
, boundary bound
)
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
);
273 /* In the format `[[file_name:line.column]], [[file_name:line.column]]',
274 append LOC to MUSCLE. Use digraphs for special characters in each
278 muscle_location_grow (char const *key
, location loc
)
280 muscle_boundary_grow (key
, loc
.start
);
281 muscle_grow (key
, "", ", ");
282 muscle_boundary_grow (key
, loc
.end
);
285 #define COMMON_DECODE(Value) \
287 aver (*++(Value) == ']'); \
288 aver (*++(Value) == '['); \
289 obstack_sgrow (&muscle_obstack, "$"); \
292 switch (*++(Value)) \
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; \
301 obstack_1grow (&muscle_obstack, *(Value)); \
304 /* Reverse of obstack_escape. */
306 string_decode (char const *key
)
308 char const *value
= muscle_find_const (key
);
317 COMMON_DECODE (value
)
324 value_decoded
= obstack_finish (&muscle_obstack
);
325 result
= xstrdup (value_decoded
);
326 obstack_free (&muscle_obstack
, value_decoded
);
330 /* Reverse of muscle_location_grow. */
332 location_decode (char const *key
)
335 char const *value
= muscle_find_const (key
);
337 aver (*value
== '[');
338 aver (*++value
== '[');
342 COMMON_DECODE (value
)
349 aver (*++value
== ']');
350 boundary_str
= obstack_finish0 (&muscle_obstack
);
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
== '[');
361 boundary_set_from_string (&loc
.end
, boundary_str
);
362 obstack_free (&muscle_obstack
, boundary_str
);
377 muscle_user_name_list_grow (char const *key
, char const *user_name
,
380 muscle_grow (key
, "[[[[", ",");
381 muscle_grow (key
, user_name
, "");
382 muscle_grow (key
, "]], ", "");
383 muscle_location_grow (key
, loc
);
384 muscle_grow (key
, "]]", "");
388 /** Return an allocated string that represents the %define directive
389 that performs the assignment.
391 @param assignment "VAR", or "VAR=VAL".
392 @param value default value if VAL \a assignment has no '='.
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"
405 define_directive (char const *assignment
, char const *value
)
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
, '=');
414 *eq
= eq
[1] ? ' ' : '\0';
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.
421 * Allocates the returned value. */
424 muscle_percent_variable_update (char const *variable
, location variable_loc
,
429 const char *obsolete
;
432 const conversion_type conversion
[] =
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", },
446 conversion_type
const *c
;
447 for (c
= conversion
; c
->obsolete
; ++c
)
449 char const *eq
= strchr (c
->obsolete
, '=');
451 ? (!strncmp (c
->obsolete
, variable
, eq
- c
->obsolete
)
452 && STREQ (eq
+ 1, *value
))
453 : STREQ (c
->obsolete
, variable
))
455 char *old
= define_directive (c
->obsolete
, *value
);
456 char *upd
= define_directive (c
->updated
, *value
);
457 deprecated_directive (&variable_loc
, old
, upd
);
460 char *res
= xstrdup (c
->updated
);
462 char *eq2
= strchr (res
, '=');
472 return xstrdup (variable
);
476 muscle_percent_define_insert (char const *var
, location variable_loc
,
478 muscle_percent_define_how how
)
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
, ")");
488 /* Command-line options are processed before the grammar file. */
489 if (how
== MUSCLE_PERCENT_DEFINE_GRAMMAR_FILE
490 && muscle_find_const (name
))
492 muscle_percent_define_how how_old
= atoi (muscle_find_const (how_name
));
494 if (how_old
== MUSCLE_PERCENT_DEFINE_F
)
496 complain_indent (&variable_loc
, complaint
, &i
,
497 _("%%define variable %s redefined"),
500 location loc
= muscle_percent_define_get_loc (variable
);
501 complain_indent (&loc
, complaint
, &i
, _("previous definition"));
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
,
511 MUSCLE_INSERT_INT (how_name
, how
);
516 /* This is used for backward compatibility, e.g., "%define api.pure"
517 supersedes "%pure-parser". */
519 muscle_percent_define_ensure (char const *variable
, location loc
,
522 char const *val
= value
? "" : "false";
523 char const *name
= UNIQSTR_CONCAT ("percent_define(", variable
, ")");
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
);
540 muscle_percent_define_get (char const *variable
)
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
);
547 value
= xstrdup ("");
549 muscle_insert (usage_name
, "");
554 muscle_percent_define_get_loc (char const *variable
)
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
);
564 muscle_percent_define_get_syncline (char const *variable
)
566 char const *syncline_name
=
567 UNIQSTR_CONCAT ("percent_define_syncline(", variable
, ")");
568 char const *syncline
= muscle_find_const (syncline_name
);
570 complain (NULL
, fatal
, _("%s: undefined %%define variable %s"),
571 "muscle_percent_define_get_syncline", quote (variable
));
576 muscle_percent_define_ifdef (char const *variable
)
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
);
584 muscle_insert (usage_name
, "");
592 muscle_percent_define_flag_if (char const *variable
)
594 char const *invalid_boolean_name
=
595 UNIQSTR_CONCAT ("percent_define_invalid_boolean(", variable
, ")");
598 if (muscle_percent_define_ifdef (variable
))
600 char *value
= muscle_percent_define_get (variable
);
601 if (value
[0] == '\0' || STREQ (value
, "true"))
603 else if (STREQ (value
, "false"))
605 else if (!muscle_find_const (invalid_boolean_name
))
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"),
616 complain (NULL
, fatal
, _("%s: undefined %%define variable %s"),
617 "muscle_percent_define_flag", quote (variable
));
623 muscle_percent_define_default (char const *variable
, char const *value
)
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
))
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
, "");
643 muscle_percent_define_check_values (char const * const *values
)
645 for (; *values
; ++values
)
647 char const * const *variablep
= values
;
648 char const *name
= UNIQSTR_CONCAT ("percent_define(", *variablep
, ")");
649 char *value
= string_decode (name
);
652 for (++values
; *values
; ++values
)
654 if (STREQ (value
, *values
))
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
));
665 for (values
= variablep
+ 1; *values
; ++values
)
666 complain_indent (&loc
, complaint
| no_caret
, &i
,
667 _("accepted value: %s"), quote (*values
));
677 complain (NULL
, fatal
, _("%s: undefined %%define variable %s"),
678 "muscle_percent_define_check_values", quote (*variablep
));
683 muscle_percent_code_grow (char const *qualifier
, location qualifier_loc
,
684 char const *code
, location code_loc
)
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
,
693 /*------------------------------------------------.
694 | Output the definition of ENTRY as a m4_define. |
695 `------------------------------------------------*/
698 muscle_m4_output (muscle_entry
*entry
, FILE *out
)
701 "m4_define([b4_%s],\n"
702 "[[%s]])\n\n\n", entry
->key
, entry
->value
);
707 muscle_m4_output_processor (void *entry
, void *out
)
709 return muscle_m4_output (entry
, out
);
713 /*----------------------------------------------------------------.
714 | Output the definition of all the current muscles into a list of |
716 `----------------------------------------------------------------*/
719 muscles_m4_output (FILE *out
)
721 hash_do_for_each (muscle_table
, muscle_m4_output_processor
, out
);