1 /* Muscle table manager for Bison,
3 Copyright (C) 2001-2003, 2006-2013 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/>. */
21 # define MUSCLE_TAB_H_
23 # include <quotearg.h>
25 # include "location.h"
27 void muscle_init (void);
28 void muscle_insert (char const *key
, char const *value
);
29 char const *muscle_find_const (char const *key
);
30 char *muscle_find (char const *key
);
31 void muscle_free (void);
34 /* An obstack dedicated to receive muscle keys and values. */
35 extern struct obstack muscle_obstack
;
37 # define MUSCLE_INSERT_BOOL(Key, Value) \
40 MUSCLE_INSERT_INT (Key, v__); \
43 # define MUSCLE_INSERTF(Key, Format, Value) \
45 obstack_printf (&muscle_obstack, Format, Value); \
46 muscle_insert (Key, obstack_finish0 (&muscle_obstack)); \
49 # define MUSCLE_INSERT_INT(Key, Value) \
50 MUSCLE_INSERTF(Key, "%d", Value)
52 # define MUSCLE_INSERT_LONG_INT(Key, Value) \
53 MUSCLE_INSERTF(Key, "%ld", Value)
55 /* Key -> Value, but don't apply escaping to Value. */
56 # define MUSCLE_INSERT_STRING_RAW(Key, Value) \
57 MUSCLE_INSERTF(Key, "%s", Value)
59 /* Key -> Value, applying M4 escaping to Value. */
60 # define MUSCLE_INSERT_STRING(Key, Value) \
62 obstack_escape (&muscle_obstack, Value); \
63 muscle_insert (Key, obstack_finish0 (&muscle_obstack)); \
66 /* Key -> Value, applying C escaping to Value (and then M4). */
67 # define MUSCLE_INSERT_C_STRING(Key, Value) \
68 MUSCLE_INSERT_STRING(Key, quotearg_style (c_quoting_style, Value))
71 /* Append VALUE to the current value of KEY. If KEY did not already
72 exist, create it. Use MUSCLE_OBSTACK. De-allocate the previously
73 associated value. Copy VALUE and SEPARATOR. */
75 void muscle_grow (const char *key
, const char *value
, const char *separator
);
78 /* Append VALUE to the current value of KEY, using muscle_grow. But
79 in addition, issue a synchronization line for the location LOC. */
81 void muscle_code_grow (const char *key
, const char *value
, location loc
);
84 /* MUSCLE is an M4 list of pairs. Create or extend it with the pair
85 (A1, A2) after escaping both values with digraphs. Note that because the
86 muscle values are output *double* quoted, one needs to strip the first level
87 of quotes to reach the list itself. */
88 void muscle_pair_list_grow (const char *muscle
,
89 const char *a1
, const char *a2
);
91 /* Grow KEY for the occurrence of the name USER_NAME at LOC appropriately for
92 use with b4_check_user_names in ../data/bison.m4. USER_NAME is not escaped
93 with digraphs, so it must not contain '[' or ']'. */
94 void muscle_user_name_list_grow (char const *key
, char const *user_name
,
97 /* Indicates whether a variable's value was specified with -D/--define, with
98 -F/--force-define, or in the grammar file. */
100 MUSCLE_PERCENT_DEFINE_D
= 0, MUSCLE_PERCENT_DEFINE_F
,
101 MUSCLE_PERCENT_DEFINE_GRAMMAR_FILE
102 } muscle_percent_define_how
;
104 /* Define the muscles for %define variable VARIABLE with VALUE specified
105 at VARIABLE_LOC in the manner HOW unless it was specified in the
106 grammar file while the previous definition for VARIABLE was specified
107 with -F/--force-define. Complain if a previous definition is being
108 overridden and the new definition is specified in the grammar file.
109 (These rules support the documented behavior as long as command-line
110 definitions are processed before grammar file definitions.) Record
111 this as a user occurrence of VARIABLE by invoking
112 muscle_user_name_list_grow. */
113 void muscle_percent_define_insert (char const *variable
, location variable_loc
,
115 muscle_percent_define_how how
);
117 /* Make sure that VARIABLE is set to the boolean VALUE. Warn on mismatches
118 only, but accept repeated declaration. Used for backward compatibility
119 between old directives such as %pure-parser, and the recommended use of
120 variables (%define api.pure). */
121 void muscle_percent_define_ensure (char const *variable
, location variable_loc
,
124 /* Mimic b4_percent_define_get in ../data/bison.m4 exactly. That is, if the
125 %define variable VARIABLE is defined, return its value. Otherwise, return
126 the empty string. Also, record Bison's usage of VARIABLE by defining
127 b4_percent_define_bison_variables(VARIABLE). The caller is responsible for
128 freeing the memory of the returned string. */
129 char *muscle_percent_define_get (char const *variable
);
131 /* Mimic muscle_percent_define_get_loc in ../data/bison.m4 exactly. That is,
132 if the %define variable VARIABLE is undefined, complain fatally since that's
133 a Bison error. Otherwise, return its definition location in a form
134 approriate for the first argument of warn_at, complain_at, or fatal_at.
135 Don't record this as a Bison usage of VARIABLE as there's no reason to
136 suspect that the user-supplied value has yet influenced the output. */
137 location
muscle_percent_define_get_loc (char const *variable
);
139 /* Mimic muscle_percent_define_get_syncline in ../data/bison.m4 exactly. That
140 is, if the %define variable VARIABLE is undefined, complain fatally since
141 that's a Bison error. Otherwise, return its definition location as a
142 b4_syncline invocation. Don't record this as a Bison usage of VARIABLE as
143 there's no reason to suspect that the user-supplied value has yet influenced
145 char const *muscle_percent_define_get_syncline (char const *variable
);
147 /* Mimic b4_percent_define_ifdef in ../data/bison.m4 exactly. That is, if the
148 %define variable VARIABLE is defined, return true. Otherwise, return false.
149 Also, record Bison's usage of VARIABLE by defining
150 b4_percent_define_bison_variables(VARIABLE). */
151 bool muscle_percent_define_ifdef (char const *variable
);
153 /* Mimic b4_percent_define_flag_if in ../data/bison.m4 exactly. That is, if
154 the %define variable VARIABLE is defined to "" or "true", return true. If
155 it is defined to "false", return false. Complain if it is undefined (a
156 Bison error since the default value should have been set already) or defined
157 to any other value (possibly a user error). Also, record Bison's usage of
158 VARIABLE by defining b4_percent_define_bison_variables(VARIABLE). */
159 bool muscle_percent_define_flag_if (char const *variable
);
161 /* Mimic b4_percent_define_default in ../data/bison.m4 exactly. That is, if
162 the %define variable VARIABLE is undefined, set its value to VALUE.
163 Don't record this as a Bison usage of VARIABLE as there's no reason to
164 suspect that the value has yet influenced the output. */
165 void muscle_percent_define_default (char const *variable
, char const *value
);
167 /* Mimic b4_percent_define_check_values in ../data/bison.m4 exactly except that
168 the VALUES structure is more appropriate for C. That is, VALUES points to a
169 list of strings that is partitioned into sublists by NULL's, one terminating
170 each sublist. The last sublist is followed by a second NULL. For each
171 sublist, the first string is the name of a %define variable, and all
172 remaining strings in that sublist are the valid values for that variable.
173 Complain if such a variable is undefined (a Bison error since the default
174 value should have been set already) or defined to any other value (possibly
175 a user error). Don't record this as a Bison usage of the variable as
176 there's no reason to suspect that the value has yet influenced the
178 void muscle_percent_define_check_values (char const * const *values
);
180 /* Grow the muscle for the %code qualifier QUALIFIER appearing at
181 QUALIFIER_LOC with code CODE appearing at CODE_LOC. Record this as a
182 user occurrence of QUALIFIER by invoking
183 muscle_user_name_list_grow. */
184 void muscle_percent_code_grow (char const *qualifier
, location qualifier_loc
,
185 char const *code
, location code_loc
);
187 void muscles_m4_output (FILE *out
);
189 #endif /* not MUSCLE_TAB_H_ */