]> git.saurik.com Git - bison.git/blob - data/c.m4
Fix incorrect comment.
[bison.git] / data / c.m4
1 m4_divert(-1) -*- Autoconf -*-
2
3 # C M4 Macros for Bison.
4 # Copyright (C) 2002, 2004, 2005 Free Software Foundation, Inc.
5
6 # This program is free software; you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation; either version 2 of the License, or
9 # (at your option) any later version.
10
11 # This program is distributed in the hope that it will be useful,
12 # but WITHOUT ANY WARRANTY; without even the implied warranty of
13 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 # GNU General Public License for more details.
15
16 # You should have received a copy of the GNU General Public License
17 # along with this program; if not, write to the Free Software
18 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
19 # 02110-1301 USA
20
21
22 ## ---------------- ##
23 ## Identification. ##
24 ## ---------------- ##
25
26 # b4_copyright(TITLE, YEARS)
27 # --------------------------
28 m4_define([b4_copyright],
29 [/* A Bison parser, made by GNU Bison b4_version. */
30
31 /* $1,
32 Copyright (C) $2 Free Software Foundation, Inc.
33
34 This program is free software; you can redistribute it and/or modify
35 it under the terms of the GNU General Public License as published by
36 the Free Software Foundation; either version 2, or (at your option)
37 any later version.
38
39 This program is distributed in the hope that it will be useful,
40 but WITHOUT ANY WARRANTY; without even the implied warranty of
41 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
42 GNU General Public License for more details.
43
44 You should have received a copy of the GNU General Public License
45 along with this program; if not, write to the Free Software
46 Foundation, Inc., 51 Franklin Street, Fifth Floor,
47 Boston, MA 02110-1301, USA. */])
48
49
50 # b4_identification
51 # -----------------
52 m4_define([b4_identification],
53 [/* Identify Bison output. */
54 [#]define YYBISON 1
55
56 /* Bison version. */
57 [#]define YYBISON_VERSION "b4_version"
58
59 /* Skeleton name. */
60 [#]define YYSKELETON_NAME b4_skeleton
61
62 /* Pure parsers. */
63 [#]define YYPURE b4_pure
64
65 /* Using locations. */
66 [#]define YYLSP_NEEDED b4_locations_flag
67 ])
68
69
70
71 ## ---------------- ##
72 ## Default values. ##
73 ## ---------------- ##
74
75 m4_define_default([b4_epilogue], [])
76
77
78
79 ## ------------------------ ##
80 ## Pure/impure interfaces. ##
81 ## ------------------------ ##
82
83
84 # b4_user_args
85 # ------------
86 m4_define([b4_user_args],
87 [m4_ifset([b4_parse_param], [, b4_c_args(b4_parse_param)])])
88
89
90 # b4_parse_param
91 # --------------
92 # If defined, b4_parse_param arrives double quoted, but below we prefer
93 # it to be single quoted.
94 m4_define_default([b4_parse_param])
95 m4_define([b4_parse_param],
96 b4_parse_param))
97
98 # b4_parse_param_for(DECL, FORMAL, BODY)
99 # ---------------------------------------
100 # Iterate over the user parameters, binding the declaration to DECL,
101 # the formal name to FORMAL, and evaluating the BODY.
102 m4_define([b4_parse_param_for],
103 [m4_foreach([$1_$2], m4_defn([b4_parse_param]),
104 [m4_pushdef([$1], m4_fst($1_$2))dnl
105 m4_pushdef([$2], m4_shift($1_$2))dnl
106 $3[]dnl
107 m4_popdef([$2])dnl
108 m4_popdef([$1])dnl
109 ])])
110
111 # b4_parse_param_use
112 # ------------------
113 # `YYUSE' all the parse-params.
114 m4_define([b4_parse_param_use],
115 [b4_parse_param_for([Decl], [Formal], [ YYUSE (Formal);
116 ])dnl
117 ])
118
119 ## ------------ ##
120 ## Data Types. ##
121 ## ------------ ##
122
123
124 # b4_ints_in(INT1, INT2, LOW, HIGH)
125 # ---------------------------------
126 # Return 1 iff both INT1 and INT2 are in [LOW, HIGH], 0 otherwise.
127 m4_define([b4_ints_in],
128 [m4_eval([$3 <= $1 && $1 <= $4 && $3 <= $2 && $2 <= $4])])
129
130
131 # b4_int_type(MIN, MAX)
132 # ---------------------
133 # Return the smallest int type able to handle numbers ranging from
134 # MIN to MAX (included).
135 m4_define([b4_int_type],
136 [m4_if(b4_ints_in($@, [0], [255]), [1], [unsigned char],
137 b4_ints_in($@, [-128], [127]), [1], [signed char],
138
139 b4_ints_in($@, [0], [65535]), [1], [unsigned short int],
140 b4_ints_in($@, [-32768], [32767]), [1], [short int],
141
142 m4_eval([0 <= $1]), [1], [unsigned int],
143
144 [int])])
145
146
147 # b4_int_type_for(NAME)
148 # ---------------------
149 # Return the smallest int type able to handle numbers ranging from
150 # `NAME_min' to `NAME_max' (included).
151 m4_define([b4_int_type_for],
152 [b4_int_type($1_min, $1_max)])
153
154
155 ## ------------------ ##
156 ## Decoding options. ##
157 ## ------------------ ##
158
159
160 # b4_error_verbose_if(IF-TRUE, IF-FALSE)
161 # --------------------------------------
162 # Expand IF-TRUE, if errors are verbose, IF-FALSE otherwise.
163 m4_define([b4_error_verbose_if],
164 [m4_if(b4_error_verbose, [1],
165 [$1],
166 [$2])])
167
168
169 # b4_location_if(IF-TRUE, IF-FALSE)
170 # ---------------------------------
171 # Expand IF-TRUE, if locations are used, IF-FALSE otherwise.
172 m4_define([b4_location_if],
173 [m4_if(b4_locations_flag, [1],
174 [$1],
175 [$2])])
176
177
178 # b4_pure_if(IF-TRUE, IF-FALSE)
179 # -----------------------------
180 # Expand IF-TRUE, if %pure-parser, IF-FALSE otherwise.
181 m4_define([b4_pure_if],
182 [m4_if(b4_pure, [1],
183 [$1],
184 [$2])])
185
186
187
188 ## ------------------------- ##
189 ## Assigning token numbers. ##
190 ## ------------------------- ##
191
192 # b4_token_define(TOKEN-NAME, TOKEN-NUMBER)
193 # -----------------------------------------
194 # Output the definition of this token as #define.
195 m4_define([b4_token_define],
196 [#define $1 $2
197 ])
198
199
200 # b4_token_defines(LIST-OF-PAIRS-TOKEN-NAME-TOKEN-NUMBER)
201 # -------------------------------------------------------
202 # Output the definition of the tokens (if there are) as #defines.
203 m4_define([b4_token_defines],
204 [m4_if([$@], [[]], [],
205 [/* Tokens. */
206 m4_map([b4_token_define], [$@])])
207 ])
208
209
210 # b4_token_enum(TOKEN-NAME, TOKEN-NUMBER)
211 # ---------------------------------------
212 # Output the definition of this token as an enum.
213 m4_define([b4_token_enum],
214 [$1 = $2])
215
216
217 # b4_token_enums(LIST-OF-PAIRS-TOKEN-NAME-TOKEN-NUMBER)
218 # -----------------------------------------------------
219 # Output the definition of the tokens (if there are) as enums.
220 m4_define([b4_token_enums],
221 [m4_if([$@], [[]], [],
222 [/* Tokens. */
223 #ifndef YYTOKENTYPE
224 # define YYTOKENTYPE
225 /* Put the tokens into the symbol table, so that GDB and other debuggers
226 know about them. */
227 enum yytokentype {
228 m4_map_sep([ b4_token_enum], [,
229 ],
230 [$@])
231 };
232 #endif
233 ])])
234
235
236 # b4_token_enums_defines(LIST-OF-PAIRS-TOKEN-NAME-TOKEN-NUMBER)
237 # -------------------------------------------------------------
238 # Output the definition of the tokens (if there are) as enums and #defines.
239 m4_define([b4_token_enums_defines],
240 [b4_token_enums($@)b4_token_defines($@)
241 ])
242
243
244
245 ## --------------------------------------------- ##
246 ## Defining C functions in both K&R and ANSI-C. ##
247 ## --------------------------------------------- ##
248
249
250 # b4_c_function_def(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
251 # ----------------------------------------------------------
252 # Declare the function NAME.
253 m4_define([b4_c_function_def],
254 [#if defined (__STDC__) || defined (__C99__FUNC__) || defined (__cplusplus)
255 b4_c_ansi_function_def($@)
256 #else
257 $2
258 $1 (b4_c_knr_formal_names(m4_shiftn(2, $@)))
259 b4_c_knr_formal_decls(m4_shiftn(2, $@))
260 #endif[]dnl
261 ])
262
263
264 # b4_c_ansi_function_def(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
265 # ---------------------------------------------------------------
266 # Declare the function NAME in ANSI.
267 m4_define([b4_c_ansi_function_def],
268 [$2
269 $1 (b4_c_ansi_formals(m4_shiftn(2, $@)))[]dnl
270 ])
271
272
273 # b4_c_ansi_formals([DECL1, NAME1], ...)
274 # --------------------------------------
275 # Output the arguments ANSI-C definition.
276 m4_define([b4_c_ansi_formals],
277 [m4_case([$@],
278 [], [void],
279 [[]], [void],
280 [m4_map_sep([b4_c_ansi_formal], [, ], [$@])])])
281
282 m4_define([b4_c_ansi_formal],
283 [$1])
284
285
286 # b4_c_knr_formal_names([DECL1, NAME1], ...)
287 # ------------------------------------------
288 # Output the argument names.
289 m4_define([b4_c_knr_formal_names],
290 [m4_map_sep([b4_c_knr_formal_name], [, ], [$@])])
291
292 m4_define([b4_c_knr_formal_name],
293 [$2])
294
295
296 # b4_c_knr_formal_decls([DECL1, NAME1], ...)
297 # ------------------------------------------
298 # Output the K&R argument declarations.
299 m4_define([b4_c_knr_formal_decls],
300 [m4_map_sep([b4_c_knr_formal_decl],
301 [
302 ],
303 [$@])])
304
305 m4_define([b4_c_knr_formal_decl],
306 [ $1;])
307
308
309
310 ## ------------------------------------------------------------ ##
311 ## Declaring (prototyping) C functions in both K&R and ANSI-C. ##
312 ## ------------------------------------------------------------ ##
313
314
315 # b4_c_function_decl(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
316 # -----------------------------------------------------------
317 # Declare the function NAME.
318 m4_define([b4_c_function_decl],
319 [#if defined (__STDC__) || defined (__cplusplus)
320 b4_c_ansi_function_decl($@)
321 #else
322 $2 $1 ();
323 #endif[]dnl
324 ])
325
326
327 # b4_c_ansi_function_decl(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
328 # ----------------------------------------------------------------
329 # Declare the function NAME.
330 m4_define([b4_c_ansi_function_decl],
331 [$2 $1 (b4_c_ansi_formals(m4_shiftn(2, $@)));[]dnl
332 ])
333
334
335
336
337 ## --------------------- ##
338 ## Calling C functions. ##
339 ## --------------------- ##
340
341
342 # b4_c_function_call(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
343 # -----------------------------------------------------------
344 # Call the function NAME with arguments NAME1, NAME2 etc.
345 m4_define([b4_c_function_call],
346 [$1 (b4_c_args(m4_shiftn(2, $@)))[]dnl
347 ])
348
349
350 # b4_c_args([DECL1, NAME1], ...)
351 # ------------------------------
352 # Output the arguments NAME1, NAME2...
353 m4_define([b4_c_args],
354 [m4_map_sep([b4_c_arg], [, ], [$@])])
355
356 m4_define([b4_c_arg],
357 [$2])
358
359
360 ## ----------- ##
361 ## Synclines. ##
362 ## ----------- ##
363
364 # b4_syncline(LINE, FILE)
365 # -----------------------
366 m4_define([b4_syncline],
367 [m4_if(b4_synclines_flag, 1,
368 [[#]line $1 $2])])
369
370
371
372 ## -------------- ##
373 ## User actions. ##
374 ## -------------- ##
375
376 # b4_symbol_actions(FILENAME, LINENO,
377 # SYMBOL-TAG, SYMBOL-NUM,
378 # SYMBOL-ACTION, SYMBOL-TYPENAME)
379 # -------------------------------------------------
380 m4_define([b4_symbol_actions],
381 [m4_pushdef([b4_dollar_dollar],
382 [m4_ifval([$6], [(yyvaluep->$6)], [(*yyvaluep)])])dnl
383 m4_pushdef([b4_at_dollar], [(*yylocationp)])dnl
384 case $4: /* $3 */
385 b4_syncline([$2], [$1])
386 $5;
387 b4_syncline([@oline@], [@ofile@])
388 break;
389 m4_popdef([b4_at_dollar])dnl
390 m4_popdef([b4_dollar_dollar])dnl
391 ])
392
393
394 # b4_yydestruct_generate(FUNCTION-DECLARATOR)
395 # -------------------------------------------
396 # Generate the "yydestruct" function, which declaration is issued using
397 # FUNCTION-DECLARATOR, which may be "b4_c_ansi_function_def" for ISO C
398 # or "b4_c_function_def" for K&R.
399 m4_define_default([b4_yydestruct_generate],
400 [[/*-----------------------------------------------.
401 | Release the memory associated to this symbol. |
402 `-----------------------------------------------*/
403
404 ]$1([yydestruct],
405 [static void],
406 [[const char *yymsg], [yymsg]],
407 [[int yytype], [yytype]],
408 [[YYSTYPE *yyvaluep], [yyvaluep]][]dnl
409 b4_location_if( [, [[YYLTYPE *yylocationp], [yylocationp]]])[]dnl
410 m4_ifset([b4_parse_param], [, b4_parse_param]))[
411 {
412 YYUSE (yyvaluep);
413 ]b4_location_if([ YYUSE (yylocationp);
414 ])dnl
415 b4_parse_param_use[]dnl
416 [
417 if (!yymsg)
418 yymsg = "Deleting";
419 YY_SYMBOL_PRINT (yymsg, yytype, yyvaluep, yylocationp);
420
421 switch (yytype)
422 {
423 ]m4_map([b4_symbol_actions], m4_defn([b4_symbol_destructors]))[
424 default:
425 break;
426 }
427 }]dnl
428 ])
429
430
431 # b4_yysymprint_generate(FUNCTION-DECLARATOR)
432 # -------------------------------------------
433 # Generate the "yysymprint" function, which declaration is issued using
434 # FUNCTION-DECLARATOR, which may be "b4_c_ansi_function_def" for ISO C
435 # or "b4_c_function_def" for K&R.
436 m4_define_default([b4_yysymprint_generate],
437 [[/*--------------------------------.
438 | Print this symbol on YYOUTPUT. |
439 `--------------------------------*/
440
441 ]$1([yysymprint],
442 [static void],
443 [[FILE *yyoutput], [yyoutput]],
444 [[int yytype], [yytype]],
445 [[const YYSTYPE * const yyvaluep], [yyvaluep]][]dnl
446 b4_location_if([, [[const YYLTYPE * const yylocationp], [yylocationp]]])[]dnl
447 m4_ifset([b4_parse_param], [, b4_parse_param]))[
448 {
449 YYUSE (yyvaluep);
450 ]b4_location_if([ YYUSE (yylocationp);
451 ])dnl
452 b4_parse_param_use[]dnl
453 [ if (yytype < YYNTOKENS)
454 YYFPRINTF (yyoutput, "token %s (", yytname[yytype]);
455 else
456 YYFPRINTF (yyoutput, "nterm %s (", yytname[yytype]);
457
458 ]b4_location_if([ YY_LOCATION_PRINT (yyoutput, *yylocationp);
459 YYFPRINTF (yyoutput, ": ");
460 ])dnl
461 [
462 # ifdef YYPRINT
463 if (yytype < YYNTOKENS)
464 YYPRINT (yyoutput, yytoknum[yytype], *yyvaluep);
465 # endif
466 switch (yytype)
467 {
468 ]m4_map([b4_symbol_actions], m4_defn([b4_symbol_printers]))dnl
469 [ default:
470 break;
471 }
472 YYFPRINTF (yyoutput, ")");
473 }]dnl
474 ])