]>
Commit | Line | Data |
---|---|---|
ae7453f2 | 1 | /* Muscle table manager for Bison, |
6e30ede8 | 2 | |
68f91d58 | 3 | Copyright (C) 2001-2003, 2006-2007, 2009-2013 Free Software |
ea0a7676 | 4 | Foundation, Inc. |
f753cd62 MA |
5 | |
6 | This file is part of Bison, the GNU Compiler Compiler. | |
7 | ||
f16b0819 | 8 | This program is free software: you can redistribute it and/or modify |
f753cd62 | 9 | it under the terms of the GNU General Public License as published by |
f16b0819 PE |
10 | the Free Software Foundation, either version 3 of the License, or |
11 | (at your option) any later version. | |
f753cd62 | 12 | |
f16b0819 | 13 | This program is distributed in the hope that it will be useful, |
f753cd62 MA |
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. | |
17 | ||
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/>. */ |
f753cd62 MA |
20 | |
21 | #ifndef MUSCLE_TAB_H_ | |
f7737e2e | 22 | # define MUSCLE_TAB_H_ |
f753cd62 | 23 | |
4c787a31 AD |
24 | # include <quotearg.h> |
25 | ||
cd3684cf AD |
26 | # include "location.h" |
27 | ||
d33cb3ae | 28 | void muscle_init (void); |
eb095650 | 29 | void muscle_insert (char const *key, char const *value); |
7eb8a0bc | 30 | char const *muscle_find_const (char const *key); |
9611cfa2 | 31 | char *muscle_find (char const *key); |
d33cb3ae | 32 | void muscle_free (void); |
592e8d4d AD |
33 | |
34 | ||
35 | /* An obstack dedicated to receive muscle keys and values. */ | |
36 | extern struct obstack muscle_obstack; | |
f753cd62 | 37 | |
9b858541 AD |
38 | #define MUSCLE_INSERT_BOOL(Key, Value) \ |
39 | do { \ | |
40 | int v = Value; \ | |
41 | MUSCLE_INSERT_INT (Key, v); \ | |
42 | } while (0) | |
43 | ||
44 | #define MUSCLE_INSERT_INT(Key, Value) \ | |
45 | do { \ | |
aaf63e45 | 46 | obstack_printf (&muscle_obstack, "%d", Value); \ |
9b858541 AD |
47 | obstack_1grow (&muscle_obstack, 0); \ |
48 | muscle_insert (Key, obstack_finish (&muscle_obstack)); \ | |
49 | } while (0) | |
50 | ||
51 | #define MUSCLE_INSERT_LONG_INT(Key, Value) \ | |
52 | do { \ | |
aaf63e45 | 53 | obstack_printf (&muscle_obstack, "%ld", Value); \ |
9b858541 AD |
54 | obstack_1grow (&muscle_obstack, 0); \ |
55 | muscle_insert (Key, obstack_finish (&muscle_obstack)); \ | |
56 | } while (0) | |
57 | ||
58 | #define MUSCLE_INSERT_STRING_RAW(Key, Value) \ | |
59 | do { \ | |
60 | obstack_sgrow (&muscle_obstack, Value); \ | |
61 | obstack_1grow (&muscle_obstack, 0); \ | |
62 | muscle_insert (Key, obstack_finish (&muscle_obstack)); \ | |
63 | } while (0) | |
64 | ||
65 | #define MUSCLE_INSERT_STRING(Key, Value) \ | |
66 | do { \ | |
13b712d7 | 67 | obstack_escape (&muscle_obstack, Value); \ |
9b858541 AD |
68 | obstack_1grow (&muscle_obstack, 0); \ |
69 | muscle_insert (Key, obstack_finish (&muscle_obstack)); \ | |
70 | } while (0) | |
71 | ||
9b858541 AD |
72 | #define MUSCLE_INSERT_C_STRING(Key, Value) \ |
73 | do { \ | |
13b712d7 AD |
74 | obstack_escape (&muscle_obstack, \ |
75 | quotearg_style (c_quoting_style, Value)); \ | |
9b858541 AD |
76 | obstack_1grow (&muscle_obstack, 0); \ |
77 | muscle_insert (Key, obstack_finish (&muscle_obstack)); \ | |
78 | } while (0) | |
9b3add5b | 79 | |
50a33993 JD |
80 | /* Append VALUE to the current value of KEY. If KEY did not already |
81 | exist, create it. Use MUSCLE_OBSTACK. De-allocate the previously | |
82 | associated value. Copy VALUE and SEPARATOR. */ | |
ae7453f2 | 83 | |
d33cb3ae | 84 | void muscle_grow (const char *key, const char *value, const char *separator); |
ae7453f2 | 85 | |
cd3684cf AD |
86 | |
87 | /* Append VALUE to the current value of KEY, using muscle_grow. But | |
88 | in addition, issue a synchronization line for the location LOC. */ | |
89 | ||
90 | void muscle_code_grow (const char *key, const char *value, location loc); | |
91 | ||
92 | ||
ae7453f2 | 93 | /* MUSCLE is an M4 list of pairs. Create or extend it with the pair |
7ecec4dd JD |
94 | (A1, A2) after escaping both values with digraphs. Note that because the |
95 | muscle values are output *double* quoted, one needs to strip the first level | |
96 | of quotes to reach the list itself. */ | |
d33cb3ae | 97 | void muscle_pair_list_grow (const char *muscle, |
9b858541 | 98 | const char *a1, const char *a2); |
be2a1a68 | 99 | |
6afc30cc JD |
100 | /* Grow KEY for the occurrence of the name USER_NAME at LOC appropriately for |
101 | use with b4_check_user_names in ../data/bison.m4. USER_NAME is not escaped | |
102 | with digraphs, so it must not contain `[' or `]'. */ | |
9611cfa2 | 103 | void muscle_user_name_list_grow (char const *key, char const *user_name, |
7eb8a0bc JD |
104 | location loc); |
105 | ||
34d41938 JD |
106 | /* Indicates whether a variable's value was specified with -D/--define, with |
107 | -F/--force-define, or in the grammar file. */ | |
108 | typedef enum { | |
109 | MUSCLE_PERCENT_DEFINE_D = 0, MUSCLE_PERCENT_DEFINE_F, | |
110 | MUSCLE_PERCENT_DEFINE_GRAMMAR_FILE | |
111 | } muscle_percent_define_how; | |
112 | ||
113 | /* Define the muscles for %define variable VARIABLE with VALUE specified | |
114 | at VARIABLE_LOC in the manner HOW unless it was specified in the | |
115 | grammar file while the previous definition for VARIABLE was specified | |
e3a33f7c | 116 | with -F/--force-define. Complain if a previous definition is being |
34d41938 JD |
117 | overridden and the new definition is specified in the grammar file. |
118 | (These rules support the documented behavior as long as command-line | |
119 | definitions are processed before grammar file definitions.) Record | |
120 | this as a user occurrence of VARIABLE by invoking | |
246c4efa | 121 | muscle_user_name_list_grow. */ |
9611cfa2 | 122 | void muscle_percent_define_insert (char const *variable, location variable_loc, |
34d41938 JD |
123 | char const *value, |
124 | muscle_percent_define_how how); | |
9611cfa2 | 125 | |
f124d423 JD |
126 | /* Mimic b4_percent_define_get in ../data/bison.m4 exactly. That is, if the |
127 | %define variable VARIABLE is defined, return its value. Otherwise, return | |
128 | the empty string. Also, record Bison's usage of VARIABLE by defining | |
129 | b4_percent_define_bison_variables(VARIABLE). The caller is responsible for | |
130 | freeing the memory of the returned string. */ | |
131 | char *muscle_percent_define_get (char const *variable); | |
132 | ||
35b8730d JD |
133 | /* Mimic muscle_percent_define_get_loc in ../data/bison.m4 exactly. That is, |
134 | if the %define variable VARIABLE is undefined, complain fatally since that's | |
135 | a Bison error. Otherwise, return its definition location in a form | |
136 | approriate for the first argument of warn_at, complain_at, or fatal_at. | |
137 | Don't record this as a Bison usage of VARIABLE as there's no reason to | |
138 | suspect that the user-supplied value has yet influenced the output. */ | |
139 | location muscle_percent_define_get_loc (char const *variable); | |
140 | ||
141 | /* Mimic muscle_percent_define_get_syncline in ../data/bison.m4 exactly. That | |
142 | is, if the %define variable VARIABLE is undefined, complain fatally since | |
143 | that's a Bison error. Otherwise, return its definition location as a | |
144 | b4_syncline invocation. Don't record this as a Bison usage of VARIABLE as | |
145 | there's no reason to suspect that the user-supplied value has yet influenced | |
146 | the output. */ | |
147 | char const *muscle_percent_define_get_syncline (char const *variable); | |
148 | ||
f124d423 JD |
149 | /* Mimic b4_percent_define_ifdef in ../data/bison.m4 exactly. That is, if the |
150 | %define variable VARIABLE is defined, return true. Otherwise, return false. | |
151 | Also, record Bison's usage of VARIABLE by defining | |
152 | b4_percent_define_bison_variables(VARIABLE). */ | |
153 | bool muscle_percent_define_ifdef (char const *variable); | |
154 | ||
9611cfa2 JD |
155 | /* Mimic b4_percent_define_flag_if in ../data/bison.m4 exactly. That is, if |
156 | the %define variable VARIABLE is defined to "" or "true", return true. If | |
157 | it is defined to "false", return false. Complain if it is undefined (a | |
158 | Bison error since the default value should have been set already) or defined | |
159 | to any other value (possibly a user error). Also, record Bison's usage of | |
160 | VARIABLE by defining b4_percent_define_bison_variables(VARIABLE). */ | |
161 | bool muscle_percent_define_flag_if (char const *variable); | |
162 | ||
163 | /* Mimic b4_percent_define_default in ../data/bison.m4 exactly. That is, if | |
164 | the %define variable VARIABLE is undefined, set its value to VALUE. | |
165 | Don't record this as a Bison usage of VARIABLE as there's no reason to | |
166 | suspect that the value has yet influenced the output. */ | |
167 | void muscle_percent_define_default (char const *variable, char const *value); | |
168 | ||
d782395d JD |
169 | /* Mimic b4_percent_define_check_values in ../data/bison.m4 exactly except that |
170 | the VALUES structure is more appropriate for C. That is, VALUES points to a | |
171 | list of strings that is partitioned into sublists by NULL's, one terminating | |
172 | each sublist. The last sublist is followed by a second NULL. For each | |
173 | sublist, the first string is the name of a %define variable, and all | |
174 | remaining strings in that sublist are the valid values for that variable. | |
175 | Complain if such a variable is undefined (a Bison error since the default | |
176 | value should have been set already) or defined to any other value (possibly | |
177 | a user error). Don't record this as a Bison usage of the variable as | |
178 | there's no reason to suspect that the value has yet influenced the | |
179 | output. */ | |
b1a81613 | 180 | void muscle_percent_define_check_values (char const * const *values); |
f124d423 | 181 | |
246c4efa JD |
182 | /* Grow the muscle for the %code qualifier QUALIFIER appearing at |
183 | QUALIFIER_LOC with code CODE appearing at CODE_LOC. Record this as a | |
184 | user occurrence of QUALIFIER by invoking | |
185 | muscle_user_name_list_grow. */ | |
9611cfa2 JD |
186 | void muscle_percent_code_grow (char const *qualifier, location qualifier_loc, |
187 | char const *code, location code_loc); | |
188 | ||
189 | void muscles_m4_output (FILE *out); | |
190 | ||
f753cd62 | 191 | #endif /* not MUSCLE_TAB_H_ */ |