]> git.saurik.com Git - bison.git/blame - data/c.m4
ChangeLog (2006-09-15): add Odd Arild Olsen's role for push.c.
[bison.git] / data / c.m4
CommitLineData
08af01c2 1 -*- Autoconf -*-
fb8135fa
AD
2
3# C M4 Macros for Bison.
219c26ea 4# Copyright (C) 2002, 2004-2010 Free Software Foundation, Inc.
fb8135fa 5
f16b0819 6# This program is free software: you can redistribute it and/or modify
fb8135fa 7# it under the terms of the GNU General Public License as published by
f16b0819 8# the Free Software Foundation, either version 3 of the License, or
fb8135fa 9# (at your option) any later version.
f16b0819 10#
fb8135fa
AD
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.
f16b0819 15#
fb8135fa 16# You should have received a copy of the GNU General Public License
f16b0819 17# along with this program. If not, see <http://www.gnu.org/licenses/>.
fb8135fa 18
2a8d363a
AD
19## ---------------- ##
20## Identification. ##
21## ---------------- ##
fb8135fa 22
90b9908d
PB
23# b4_comment(TEXT)
24# ----------------
25m4_define([b4_comment], [/* m4_bpatsubst([$1], [
26], [
27 ]) */])
fb8135fa 28
2a8d363a
AD
29# b4_identification
30# -----------------
d9df47b6
JD
31# Depends on individual skeletons to define b4_pure_flag, b4_push_flag, or
32# b4_pull_flag if they use the values of the %define variables api.pure or
33# api.push_pull.
2a8d363a 34m4_define([b4_identification],
d9df47b6
JD
35[[/* Identify Bison output. */
36#define YYBISON 1
2a8d363a 37
55f64b82 38/* Bison version. */
d9df47b6 39#define YYBISON_VERSION "]b4_version["
55f64b82 40
2a8d363a 41/* Skeleton name. */
d9df47b6 42#define YYSKELETON_NAME ]b4_skeleton[]m4_ifdef([b4_pure_flag], [[
2a8d363a
AD
43
44/* Pure parsers. */
d9df47b6
JD
45#define YYPURE ]b4_pure_flag])[]m4_ifdef([b4_push_flag], [[
46
47/* Push parsers. */
48#define YYPUSH ]b4_push_flag])[]m4_ifdef([b4_pull_flag], [[
49
50/* Pull parsers. */
51#define YYPULL ]b4_pull_flag])[
2a8d363a
AD
52
53/* Using locations. */
d9df47b6
JD
54#define YYLSP_NEEDED ]b4_locations_flag[
55]])
2a8d363a
AD
56
57
7ec2d4cd
AD
58## ---------------- ##
59## Default values. ##
60## ---------------- ##
61
1b818f33
AD
62# If the %union is not named, its name is YYSTYPE.
63m4_define_default([b4_union_name], [YYSTYPE])
7ec2d4cd 64
90b9908d
PB
65# If the %name-prefix is not given, it is yy.
66m4_define_default([b4_prefix], [yy])
cd48d21d 67
2a8d363a
AD
68## ------------------------ ##
69## Pure/impure interfaces. ##
70## ------------------------ ##
71
2a8d363a
AD
72# b4_user_args
73# ------------
74m4_define([b4_user_args],
75[m4_ifset([b4_parse_param], [, b4_c_args(b4_parse_param)])])
76
77
78# b4_parse_param
79# --------------
80# If defined, b4_parse_param arrives double quoted, but below we prefer
81# it to be single quoted.
2a8d363a 82m4_define([b4_parse_param],
7ecec4dd 83b4_parse_param)
2a8d363a 84
8f7e3cf9 85
613d8952
AD
86# b4_parse_param_for(DECL, FORMAL, BODY)
87# ---------------------------------------
88# Iterate over the user parameters, binding the declaration to DECL,
89# the formal name to FORMAL, and evaluating the BODY.
90m4_define([b4_parse_param_for],
91[m4_foreach([$1_$2], m4_defn([b4_parse_param]),
6bbb2ed5 92[m4_pushdef([$1], m4_unquote(m4_car($1_$2)))dnl
613d8952
AD
93m4_pushdef([$2], m4_shift($1_$2))dnl
94$3[]dnl
95m4_popdef([$2])dnl
96m4_popdef([$1])dnl
97])])
98
99# b4_parse_param_use
100# ------------------
101# `YYUSE' all the parse-params.
613d8952
AD
102m4_define([b4_parse_param_use],
103[b4_parse_param_for([Decl], [Formal], [ YYUSE (Formal);
104])dnl
105])
2a8d363a 106
8e1687ae 107
fb8135fa
AD
108## ------------ ##
109## Data Types. ##
110## ------------ ##
111
a762e609
AD
112# b4_int_type(MIN, MAX)
113# ---------------------
114# Return the smallest int type able to handle numbers ranging from
115# MIN to MAX (included).
116m4_define([b4_int_type],
117[m4_if(b4_ints_in($@, [0], [255]), [1], [unsigned char],
f1886bb2 118 b4_ints_in($@, [-128], [127]), [1], [signed char],
a762e609 119
779e7ceb
PE
120 b4_ints_in($@, [0], [65535]), [1], [unsigned short int],
121 b4_ints_in($@, [-32768], [32767]), [1], [short int],
a762e609
AD
122
123 m4_eval([0 <= $1]), [1], [unsigned int],
124
02650b7f 125 [int])])
a762e609 126
f1886bb2 127
a762e609
AD
128# b4_int_type_for(NAME)
129# ---------------------
130# Return the smallest int type able to handle numbers ranging from
131# `NAME_min' to `NAME_max' (included).
132m4_define([b4_int_type_for],
133[b4_int_type($1_min, $1_max)])
fb8135fa 134
cf98343c
AD
135
136
8e1687ae
PE
137## ---------##
138## Values. ##
139## ---------##
140
141# b4_null
142---------
143# Return a null pointer constant. NULL infringes on the user name
144# space in C, so use 0 rather than NULL.
145m4_define([b4_null], [0])
146
147
cf98343c
AD
148
149
fb8135fa
AD
150## ------------------------- ##
151## Assigning token numbers. ##
152## ------------------------- ##
153
154# b4_token_define(TOKEN-NAME, TOKEN-NUMBER)
155# -----------------------------------------
156# Output the definition of this token as #define.
157m4_define([b4_token_define],
158[#define $1 $2
159])
160
161
cf147260
AD
162# b4_token_defines(LIST-OF-PAIRS-TOKEN-NAME-TOKEN-NUMBER)
163# -------------------------------------------------------
164# Output the definition of the tokens (if there are) as #defines.
165m4_define([b4_token_defines],
6bbb2ed5 166[m4_if([$#$1], [1], [],
cf147260
AD
167[/* Tokens. */
168m4_map([b4_token_define], [$@])])
169])
170
171
fb8135fa
AD
172# b4_token_enum(TOKEN-NAME, TOKEN-NUMBER)
173# ---------------------------------------
174# Output the definition of this token as an enum.
175m4_define([b4_token_enum],
176[$1 = $2])
177
178
cf147260
AD
179# b4_token_enums(LIST-OF-PAIRS-TOKEN-NAME-TOKEN-NUMBER)
180# -----------------------------------------------------
181# Output the definition of the tokens (if there are) as enums.
182m4_define([b4_token_enums],
6bbb2ed5 183[m4_if([$#$1], [1], [],
fb8135fa 184[/* Tokens. */
6b8c3254
PE
185#ifndef YYTOKENTYPE
186# define YYTOKENTYPE
fb8135fa
AD
187 /* Put the tokens into the symbol table, so that GDB and other debuggers
188 know about them. */
189 enum yytokentype {
190m4_map_sep([ b4_token_enum], [,
191],
02650b7f 192 [$@])
fb8135fa 193 };
095b9f05 194#endif
cf147260
AD
195])])
196
197
198# b4_token_enums_defines(LIST-OF-PAIRS-TOKEN-NAME-TOKEN-NUMBER)
199# -------------------------------------------------------------
b931235e
JD
200# Output the definition of the tokens (if there are any) as enums and, if POSIX
201# Yacc is enabled, as #defines.
cf147260 202m4_define([b4_token_enums_defines],
b931235e 203[b4_token_enums($@)b4_yacc_if([b4_token_defines($@)], [])
fb8135fa 204])
4a2a22f4
AD
205
206
ae7453f2 207
0245f82d
AD
208## --------------------------------------------- ##
209## Defining C functions in both K&R and ANSI-C. ##
210## --------------------------------------------- ##
4a2a22f4
AD
211
212
1b9c21fb
PE
213# b4_modern_c
214# -----------
215# A predicate useful in #if to determine whether C is ancient or modern.
216#
217# If __STDC__ is defined, the compiler is modern. IBM xlc 7.0 when run
218# as 'cc' doesn't define __STDC__ (or __STDC_VERSION__) for pedantic
219# reasons, but it defines __C99__FUNC__ so check that as well.
220# Microsoft C normally doesn't define these macros, but it defines _MSC_VER.
7a0db73e 221# Consider a C++ compiler to be modern if it defines __cplusplus.
1b9c21fb
PE
222#
223m4_define([b4_c_modern],
02650b7f
PE
224 [[(defined __STDC__ || defined __C99__FUNC__ \
225 || defined __cplusplus || defined _MSC_VER)]])
1b9c21fb 226
0245f82d
AD
227# b4_c_function_def(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
228# ----------------------------------------------------------
4a2a22f4 229# Declare the function NAME.
0245f82d 230m4_define([b4_c_function_def],
1b9c21fb 231[#if b4_c_modern
0245f82d 232b4_c_ansi_function_def($@)
4a2a22f4 233#else
0245f82d 234$2
a3764451
EB
235$1 (b4_c_knr_formal_names(m4_shift2($@)))
236b4_c_knr_formal_decls(m4_shift2($@))
4a2a22f4
AD
237#endif[]dnl
238])
239
240
0245f82d
AD
241# b4_c_ansi_function_def(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
242# ---------------------------------------------------------------
243# Declare the function NAME in ANSI.
244m4_define([b4_c_ansi_function_def],
245[$2
a3764451 246$1 (b4_c_ansi_formals(m4_shift2($@)))[]dnl
0245f82d
AD
247])
248
249
250# b4_c_ansi_formals([DECL1, NAME1], ...)
251# --------------------------------------
4a2a22f4 252# Output the arguments ANSI-C definition.
0245f82d 253m4_define([b4_c_ansi_formals],
6bbb2ed5
EB
254[m4_if([$#], [0], [void],
255 [$#$1], [1], [void],
02650b7f 256 [m4_map_sep([b4_c_ansi_formal], [, ], [$@])])])
4a2a22f4 257
0245f82d
AD
258m4_define([b4_c_ansi_formal],
259[$1])
4a2a22f4
AD
260
261
0245f82d
AD
262# b4_c_knr_formal_names([DECL1, NAME1], ...)
263# ------------------------------------------
4a2a22f4 264# Output the argument names.
0245f82d
AD
265m4_define([b4_c_knr_formal_names],
266[m4_map_sep([b4_c_knr_formal_name], [, ], [$@])])
4a2a22f4 267
0245f82d 268m4_define([b4_c_knr_formal_name],
4a2a22f4
AD
269[$2])
270
271
0245f82d
AD
272# b4_c_knr_formal_decls([DECL1, NAME1], ...)
273# ------------------------------------------
4a2a22f4 274# Output the K&R argument declarations.
0245f82d
AD
275m4_define([b4_c_knr_formal_decls],
276[m4_map_sep([b4_c_knr_formal_decl],
02650b7f 277 [
4a2a22f4 278],
02650b7f 279 [$@])])
4a2a22f4 280
0245f82d
AD
281m4_define([b4_c_knr_formal_decl],
282[ $1;])
21964f43
AD
283
284
285
0245f82d
AD
286## ------------------------------------------------------------ ##
287## Declaring (prototyping) C functions in both K&R and ANSI-C. ##
288## ------------------------------------------------------------ ##
21964f43
AD
289
290
0245f82d
AD
291# b4_c_function_decl(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
292# -----------------------------------------------------------
293# Declare the function NAME.
294m4_define([b4_c_function_decl],
02650b7f 295[#if defined __STDC__ || defined __cplusplus
0245f82d
AD
296b4_c_ansi_function_decl($@)
297#else
298$2 $1 ();
299#endif[]dnl
300])
21964f43
AD
301
302
0245f82d
AD
303# b4_c_ansi_function_decl(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
304# ----------------------------------------------------------------
305# Declare the function NAME.
306m4_define([b4_c_ansi_function_decl],
a3764451 307[$2 $1 (b4_c_ansi_formals(m4_shift2($@)));[]dnl
0245f82d
AD
308])
309
310
311
312
313## --------------------- ##
314## Calling C functions. ##
315## --------------------- ##
316
317
318# b4_c_function_call(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
319# -----------------------------------------------------------
320# Call the function NAME with arguments NAME1, NAME2 etc.
321m4_define([b4_c_function_call],
a3764451 322[$1 (b4_c_args(m4_shift2($@)))[]dnl
0245f82d
AD
323])
324
325
326# b4_c_args([DECL1, NAME1], ...)
327# ------------------------------
328# Output the arguments NAME1, NAME2...
329m4_define([b4_c_args],
330[m4_map_sep([b4_c_arg], [, ], [$@])])
331
332m4_define([b4_c_arg],
333[$2])
437c2d80
AD
334
335
336## ----------- ##
337## Synclines. ##
338## ----------- ##
339
90b9908d 340# b4_sync_start(LINE, FILE)
8ec0a172 341# -----------------------
90b9908d 342m4_define([b4_sync_start], [[#]line $1 $2])
8ec0a172 343
613d8952
AD
344
345## -------------- ##
346## User actions. ##
347## -------------- ##
348
8e1687ae
PE
349# b4_case(LABEL, STATEMENTS)
350# --------------------------
351m4_define([b4_case],
352[ case $1:
353$2
354 break;])
355
b0400cc6
AD
356# b4_symbol_actions(FILENAME, LINENO,
357# SYMBOL-TAG, SYMBOL-NUM,
358# SYMBOL-ACTION, SYMBOL-TYPENAME)
359# -------------------------------------------------
360m4_define([b4_symbol_actions],
60c82948
PE
361[m4_pushdef([b4_dollar_dollar],
362 [m4_ifval([$6], [(yyvaluep->$6)], [(*yyvaluep)])])dnl
7bd6c77e 363m4_pushdef([b4_at_dollar], [(*yylocationp)])dnl
b0400cc6
AD
364 case $4: /* $3 */
365b4_syncline([$2], [$1])
02650b7f 366 $5;
b0400cc6 367b4_syncline([@oline@], [@ofile@])
02650b7f 368 break;
b0400cc6
AD
369m4_popdef([b4_at_dollar])dnl
370m4_popdef([b4_dollar_dollar])dnl
371])
372
373
14740648
PE
374# b4_yydestruct_generate(FUNCTION-DECLARATOR)
375# -------------------------------------------
b0400cc6 376# Generate the "yydestruct" function, which declaration is issued using
14740648 377# FUNCTION-DECLARATOR, which may be "b4_c_ansi_function_def" for ISO C
b0400cc6 378# or "b4_c_function_def" for K&R.
cf147260 379m4_define_default([b4_yydestruct_generate],
b0400cc6
AD
380[[/*-----------------------------------------------.
381| Release the memory associated to this symbol. |
382`-----------------------------------------------*/
383
12ce2df6 384/*ARGSUSED*/
b0400cc6
AD
385]$1([yydestruct],
386 [static void],
a0e68930 387 [[const char *yymsg], [yymsg]],
7bd6c77e 388 [[int yytype], [yytype]],
4b367315 389 [[YYSTYPE *yyvaluep], [yyvaluep]][]dnl
327afc7c 390b4_locations_if( [, [[YYLTYPE *yylocationp], [yylocationp]]])[]dnl
4b367315 391m4_ifset([b4_parse_param], [, b4_parse_param]))[
b0400cc6 392{
2a4647a3 393 YYUSE (yyvaluep);
327afc7c 394]b4_locations_if([ YYUSE (yylocationp);
613d8952
AD
395])dnl
396b4_parse_param_use[]dnl
397[
a0e68930
AD
398 if (!yymsg)
399 yymsg = "Deleting";
400 YY_SYMBOL_PRINT (yymsg, yytype, yyvaluep, yylocationp);
401
b0400cc6
AD
402 switch (yytype)
403 {
404]m4_map([b4_symbol_actions], m4_defn([b4_symbol_destructors]))[
405 default:
02650b7f 406 break;
b0400cc6
AD
407 }
408}]dnl
409])
7bd6c77e
AD
410
411
a0af42fc
AD
412# b4_yy_symbol_print_generate(FUNCTION-DECLARATOR)
413# ------------------------------------------------
414# Generate the "yy_symbol_print" function, which declaration is issued using
14740648 415# FUNCTION-DECLARATOR, which may be "b4_c_ansi_function_def" for ISO C
7bd6c77e 416# or "b4_c_function_def" for K&R.
a0af42fc
AD
417m4_define_default([b4_yy_symbol_print_generate],
418[[
419/*--------------------------------.
14740648
PE
420| Print this symbol on YYOUTPUT. |
421`--------------------------------*/
7bd6c77e 422
12ce2df6 423/*ARGSUSED*/
a0af42fc 424]$1([yy_symbol_value_print],
7bd6c77e 425 [static void],
02650b7f
PE
426 [[FILE *yyoutput], [yyoutput]],
427 [[int yytype], [yytype]],
50cce58e
PE
428 [[YYSTYPE const * const yyvaluep], [yyvaluep]][]dnl
429b4_locations_if([, [[YYLTYPE const * const yylocationp], [yylocationp]]])[]dnl
4b367315 430m4_ifset([b4_parse_param], [, b4_parse_param]))[
7bd6c77e 431{
05449a2c
JD
432 if (!yyvaluep)
433 return;
327afc7c 434]b4_locations_if([ YYUSE (yylocationp);
7bd6c77e 435])dnl
613d8952 436b4_parse_param_use[]dnl
a0af42fc 437[# ifdef YYPRINT
619404e3
AD
438 if (yytype < YYNTOKENS)
439 YYPRINT (yyoutput, yytoknum[yytype], *yyvaluep);
c66dfadd
PE
440# else
441 YYUSE (yyoutput);
619404e3 442# endif
7bd6c77e
AD
443 switch (yytype)
444 {
3fc16193
AD
445]m4_map([b4_symbol_actions], m4_defn([b4_symbol_printers]))dnl
446[ default:
02650b7f 447 break;
7bd6c77e 448 }
a0af42fc
AD
449}
450
451
452/*--------------------------------.
453| Print this symbol on YYOUTPUT. |
454`--------------------------------*/
455
456]$1([yy_symbol_print],
457 [static void],
02650b7f
PE
458 [[FILE *yyoutput], [yyoutput]],
459 [[int yytype], [yytype]],
50cce58e
PE
460 [[YYSTYPE const * const yyvaluep], [yyvaluep]][]dnl
461b4_locations_if([, [[YYLTYPE const * const yylocationp], [yylocationp]]])[]dnl
a0af42fc
AD
462m4_ifset([b4_parse_param], [, b4_parse_param]))[
463{
464 if (yytype < YYNTOKENS)
465 YYFPRINTF (yyoutput, "token %s (", yytname[yytype]);
466 else
467 YYFPRINTF (yyoutput, "nterm %s (", yytname[yytype]);
468
327afc7c 469]b4_locations_if([ YY_LOCATION_PRINT (yyoutput, *yylocationp);
a0af42fc
AD
470 YYFPRINTF (yyoutput, ": ");
471])dnl
472[ yy_symbol_value_print (yyoutput, yytype, yyvaluep]dnl
327afc7c 473b4_locations_if([, yylocationp])[]b4_user_args[);
2f4f028d 474 YYFPRINTF (yyoutput, ")");
4b367315
AD
475}]dnl
476])