3 # C M4 Macros for Bison.
5 # Copyright (C) 2002, 2004-2012 Free Software Foundation, Inc.
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/>.
20 m4_include(b4_pkgdatadir/[c-like.m4])
24 # Convert STRING into a valid C macro name.
26 [m4_toupper(m4_bpatsubst(m4_quote($1), [[^a-zA-Z0-9]+], [_]))])
31 # A valid C macro name to use as a CPP header guard for FILE.
32 m4_define([b4_cpp_guard],
33 [b4_tocpp(m4_defn([b4_prefix])/[$1])])
36 # b4_cpp_guard_open(FILE)
37 # b4_cpp_guard_close(FILE)
38 # ------------------------
39 # Open/close CPP inclusion guards for FILE.
40 m4_define([b4_cpp_guard_open],
41 [#ifndef b4_cpp_guard([$1])
42 # define b4_cpp_guard([$1])])
44 m4_define([b4_cpp_guard_close],
45 [#endif b4_comment([!b4_cpp_guard([$1])])])
48 ## ---------------- ##
50 ## ---------------- ##
54 m4_define([b4_comment], [/* m4_bpatsubst([$1], [
60 # Depends on individual skeletons to define b4_pure_flag, b4_push_flag, or
61 # b4_pull_flag if they use the values of the %define variables api.pure or
63 m4_define([b4_identification],
64 [[/* Identify Bison output. */
68 #define YYBISON_VERSION "]b4_version["
71 #define YYSKELETON_NAME ]b4_skeleton[]m4_ifdef([b4_pure_flag], [[
74 #define YYPURE ]b4_pure_flag])[]m4_ifdef([b4_push_flag], [[
77 #define YYPUSH ]b4_push_flag])[]m4_ifdef([b4_pull_flag], [[
80 #define YYPULL ]b4_pull_flag])[
84 ## ---------------- ##
86 ## ---------------- ##
88 # b4_api_prefix, b4_api_PREFIX
89 # ----------------------------
90 # Corresponds to %define api.prefix
91 b4_percent_define_default([[api.prefix]], [[yy]])
92 m4_define([b4_api_prefix],
93 [b4_percent_define_get([[api.prefix]])])
94 m4_define([b4_api_PREFIX],
95 [m4_toupper(b4_api_prefix)])
100 # If the %name-prefix is not given, it is api.prefix.
101 m4_define_default([b4_prefix], [b4_api_prefix])
103 # If the %union is not named, its name is YYSTYPE.
104 m4_define_default([b4_union_name], [b4_api_PREFIX[]STYPE])
107 ## ------------------------ ##
108 ## Pure/impure interfaces. ##
109 ## ------------------------ ##
113 m4_define([b4_user_args],
114 [m4_ifset([b4_parse_param], [, b4_c_args(b4_parse_param)])])
119 # If defined, b4_parse_param arrives double quoted, but below we prefer
120 # it to be single quoted.
121 m4_define([b4_parse_param],
125 # b4_parse_param_for(DECL, FORMAL, BODY)
126 # ---------------------------------------
127 # Iterate over the user parameters, binding the declaration to DECL,
128 # the formal name to FORMAL, and evaluating the BODY.
129 m4_define([b4_parse_param_for],
130 [m4_foreach([$1_$2], m4_defn([b4_parse_param]),
131 [m4_pushdef([$1], m4_unquote(m4_car($1_$2)))dnl
132 m4_pushdef([$2], m4_shift($1_$2))dnl
140 # `YYUSE' all the parse-params.
141 m4_define([b4_parse_param_use],
142 [b4_parse_param_for([Decl], [Formal], [ YYUSE (Formal);
151 # b4_int_type(MIN, MAX)
152 # ---------------------
153 # Return the smallest int type able to handle numbers ranging from
154 # MIN to MAX (included).
155 m4_define([b4_int_type],
156 [m4_if(b4_ints_in($@, [0], [255]), [1], [unsigned char],
157 b4_ints_in($@, [-128], [127]), [1], [signed char],
159 b4_ints_in($@, [0], [65535]), [1], [unsigned short int],
160 b4_ints_in($@, [-32768], [32767]), [1], [short int],
162 m4_eval([0 <= $1]), [1], [unsigned int],
167 # b4_int_type_for(NAME)
168 # ---------------------
169 # Return the smallest int type able to handle numbers ranging from
170 # `NAME_min' to `NAME_max' (included).
171 m4_define([b4_int_type_for],
172 [b4_int_type($1_min, $1_max)])
175 # b4_table_value_equals(TABLE, VALUE, LITERAL)
176 # --------------------------------------------
177 # Without inducing a comparison warning from the compiler, check if the
178 # literal value LITERAL equals VALUE from table TABLE, which must have
179 # TABLE_min and TABLE_max defined. YYID must be defined as an identity
180 # function that suppresses warnings about constant conditions.
181 m4_define([b4_table_value_equals],
182 [m4_if(m4_eval($3 < m4_indir([b4_]$1[_min])
183 || m4_indir([b4_]$1[_max]) < $3), [1],
185 [[((]$2[) == (]$3[))]])])
195 # Portability issues: define a YY_NULL appropriate for the current
196 # language (C, C++98, or C++11).
197 m4_define([b4_null_define],
199 # if defined __cplusplus && 201103L <= __cplusplus
200 # define YY_NULL nullptr
210 # Return a null pointer constant.
211 m4_define([b4_null], [YY_NULL])
215 ## ------------------------- ##
216 ## Assigning token numbers. ##
217 ## ------------------------- ##
219 # b4_token_define(TOKEN-NAME, TOKEN-NUMBER)
220 # -----------------------------------------
221 # Output the definition of this token as #define.
222 m4_define([b4_token_define],
227 # b4_token_defines(LIST-OF-PAIRS-TOKEN-NAME-TOKEN-NUMBER)
228 # -------------------------------------------------------
229 # Output the definition of the tokens (if there are) as #defines.
230 m4_define([b4_token_defines],
231 [m4_if([$#$1], [1], [],
233 m4_map([b4_token_define], [$@])])
237 # b4_token_enum(TOKEN-NAME, TOKEN-NUMBER)
238 # ---------------------------------------
239 # Output the definition of this token as an enum.
240 m4_define([b4_token_enum],
244 # b4_token_enums(LIST-OF-PAIRS-TOKEN-NAME-TOKEN-NUMBER)
245 # -----------------------------------------------------
246 # Output the definition of the tokens (if there are) as enums.
247 m4_define([b4_token_enums],
248 [m4_if([$#$1], [1], [],
250 #ifndef ]b4_api_PREFIX[TOKENTYPE
251 # define ]b4_api_PREFIX[TOKENTYPE
252 /* Put the tokens into the symbol table, so that GDB and other debuggers
254 enum ]b4_api_prefix[tokentype {
255 ]m4_map_sep([ b4_token_enum], [,
263 # b4_token_enums_defines(LIST-OF-PAIRS-TOKEN-NAME-TOKEN-NUMBER)
264 # -------------------------------------------------------------
265 # Output the definition of the tokens (if there are any) as enums and, if POSIX
266 # Yacc is enabled, as #defines.
267 m4_define([b4_token_enums_defines],
268 [b4_token_enums($@)b4_yacc_if([b4_token_defines($@)], [])
273 ## --------------------------------------------- ##
274 ## Defining C functions in both K&R and ANSI-C. ##
275 ## --------------------------------------------- ##
280 # A predicate useful in #if to determine whether C is ancient or modern.
282 # If __STDC__ is defined, the compiler is modern. IBM xlc 7.0 when run
283 # as 'cc' doesn't define __STDC__ (or __STDC_VERSION__) for pedantic
284 # reasons, but it defines __C99__FUNC__ so check that as well.
285 # Microsoft C normally doesn't define these macros, but it defines _MSC_VER.
286 # Consider a C++ compiler to be modern if it defines __cplusplus.
288 m4_define([b4_c_modern],
289 [[(defined __STDC__ || defined __C99__FUNC__ \
290 || defined __cplusplus || defined _MSC_VER)]])
292 # b4_c_function_def(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
293 # ----------------------------------------------------------
294 # Declare the function NAME.
295 m4_define([b4_c_function_def],
297 b4_c_ansi_function_def($@)
300 $1 (b4_c_knr_formal_names(m4_shift2($@)))
301 b4_c_knr_formal_decls(m4_shift2($@))
306 # b4_c_ansi_function_def(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
307 # ---------------------------------------------------------------
308 # Declare the function NAME in ANSI.
309 m4_define([b4_c_ansi_function_def],
311 $1 (b4_c_ansi_formals(m4_shift2($@)))[]dnl
315 # b4_c_ansi_formals([DECL1, NAME1], ...)
316 # --------------------------------------
317 # Output the arguments ANSI-C definition.
318 m4_define([b4_c_ansi_formals],
319 [m4_if([$#], [0], [void],
321 [m4_map_sep([b4_c_ansi_formal], [, ], [$@])])])
323 m4_define([b4_c_ansi_formal],
327 # b4_c_knr_formal_names([DECL1, NAME1], ...)
328 # ------------------------------------------
329 # Output the argument names.
330 m4_define([b4_c_knr_formal_names],
331 [m4_map_sep([b4_c_knr_formal_name], [, ], [$@])])
333 m4_define([b4_c_knr_formal_name],
337 # b4_c_knr_formal_decls([DECL1, NAME1], ...)
338 # ------------------------------------------
339 # Output the K&R argument declarations.
340 m4_define([b4_c_knr_formal_decls],
341 [m4_map_sep([b4_c_knr_formal_decl],
346 m4_define([b4_c_knr_formal_decl],
351 ## ------------------------------------------------------------ ##
352 ## Declaring (prototyping) C functions in both K&R and ANSI-C. ##
353 ## ------------------------------------------------------------ ##
356 # b4_c_function_decl(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
357 # -----------------------------------------------------------
358 # Declare the function NAME.
359 m4_define([b4_c_function_decl],
360 [#if defined __STDC__ || defined __cplusplus
361 b4_c_ansi_function_decl($@)
368 # b4_c_ansi_function_decl(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
369 # ----------------------------------------------------------------
370 # Declare the function NAME.
371 m4_define([b4_c_ansi_function_decl],
372 [$2 $1 (b4_c_ansi_formals(m4_shift2($@)));[]dnl
378 ## --------------------- ##
379 ## Calling C functions. ##
380 ## --------------------- ##
383 # b4_c_function_call(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
384 # -----------------------------------------------------------
385 # Call the function NAME with arguments NAME1, NAME2 etc.
386 m4_define([b4_c_function_call],
387 [$1 (b4_c_args(m4_shift2($@)))[]dnl
391 # b4_c_args([DECL1, NAME1], ...)
392 # ------------------------------
393 # Output the arguments NAME1, NAME2...
394 m4_define([b4_c_args],
395 [m4_map_sep([b4_c_arg], [, ], [$@])])
397 m4_define([b4_c_arg],
405 # b4_sync_start(LINE, FILE)
406 # -----------------------
407 m4_define([b4_sync_start], [[#]line $1 $2])
414 # b4_case(LABEL, STATEMENTS)
415 # --------------------------
421 # b4_symbol_actions(FILENAME, LINENO,
422 # SYMBOL-TAG, SYMBOL-NUM,
423 # SYMBOL-ACTION, SYMBOL-TYPENAME)
424 # -------------------------------------------------
425 # Issue the code for a symbol action (e.g., %printer).
427 # Define b4_dollar_dollar([TYPE-NAME]), and b4_at_dollar, which are
428 # invoked where $<TYPE-NAME>$ and @$ were specified by the user.
429 m4_define([b4_symbol_actions],
430 [b4_dollar_pushdef([(*yyvaluep)], [$6], [(*yylocationp)])dnl
432 b4_syncline([$2], [$1])
434 b4_syncline([@oline@], [@ofile@])
436 b4_dollar_popdef[]dnl
440 # b4_yydestruct_generate(FUNCTION-DECLARATOR)
441 # -------------------------------------------
442 # Generate the "yydestruct" function, which declaration is issued using
443 # FUNCTION-DECLARATOR, which may be "b4_c_ansi_function_def" for ISO C
444 # or "b4_c_function_def" for K&R.
445 m4_define_default([b4_yydestruct_generate],
446 [[/*-----------------------------------------------.
447 | Release the memory associated to this symbol. |
448 `-----------------------------------------------*/
453 [[const char *yymsg], [yymsg]],
454 [[int yytype], [yytype]],
455 [[YYSTYPE *yyvaluep], [yyvaluep]][]dnl
456 b4_locations_if( [, [[YYLTYPE *yylocationp], [yylocationp]]])[]dnl
457 m4_ifset([b4_parse_param], [, b4_parse_param]))[
460 ]b4_locations_if([ YYUSE (yylocationp);
462 b4_parse_param_use[]dnl
466 YY_SYMBOL_PRINT (yymsg, yytype, yyvaluep, yylocationp);
470 ]m4_map([b4_symbol_actions], m4_defn([b4_symbol_destructors]))[
478 # b4_yy_symbol_print_generate(FUNCTION-DECLARATOR)
479 # ------------------------------------------------
480 # Generate the "yy_symbol_print" function, which declaration is issued using
481 # FUNCTION-DECLARATOR, which may be "b4_c_ansi_function_def" for ISO C
482 # or "b4_c_function_def" for K&R.
483 m4_define_default([b4_yy_symbol_print_generate],
485 /*--------------------------------.
486 | Print this symbol on YYOUTPUT. |
487 `--------------------------------*/
490 ]$1([yy_symbol_value_print],
492 [[FILE *yyoutput], [yyoutput]],
493 [[int yytype], [yytype]],
494 [[YYSTYPE const * const yyvaluep], [yyvaluep]][]dnl
495 b4_locations_if([, [[YYLTYPE const * const yylocationp], [yylocationp]]])[]dnl
496 m4_ifset([b4_parse_param], [, b4_parse_param]))[
498 FILE *yyo = yyoutput;
502 ]b4_locations_if([ YYUSE (yylocationp);
504 b4_parse_param_use[]dnl
506 if (yytype < YYNTOKENS)
507 YYPRINT (yyoutput, yytoknum[yytype], *yyvaluep);
513 ]m4_map([b4_symbol_actions], m4_defn([b4_symbol_printers]))dnl
520 /*--------------------------------.
521 | Print this symbol on YYOUTPUT. |
522 `--------------------------------*/
524 ]$1([yy_symbol_print],
526 [[FILE *yyoutput], [yyoutput]],
527 [[int yytype], [yytype]],
528 [[YYSTYPE const * const yyvaluep], [yyvaluep]][]dnl
529 b4_locations_if([, [[YYLTYPE const * const yylocationp], [yylocationp]]])[]dnl
530 m4_ifset([b4_parse_param], [, b4_parse_param]))[
532 if (yytype < YYNTOKENS)
533 YYFPRINTF (yyoutput, "token %s (", yytname[yytype]);
535 YYFPRINTF (yyoutput, "nterm %s (", yytname[yytype]);
537 ]b4_locations_if([ YY_LOCATION_PRINT (yyoutput, *yylocationp);
538 YYFPRINTF (yyoutput, ": ");
540 [ yy_symbol_value_print (yyoutput, yytype, yyvaluep]dnl
541 b4_locations_if([, yylocationp])[]b4_user_args[);
542 YYFPRINTF (yyoutput, ")");
550 # b4_declare_yylstype
551 # -------------------
552 # Declarations that might either go into the header (if --defines) or
553 # in the parser body. Declare YYSTYPE/YYLTYPE, and yylval/yylloc.
554 m4_define([b4_declare_yylstype],
555 [[#if ! defined ]b4_api_PREFIX[STYPE && ! defined ]b4_api_PREFIX[STYPE_IS_DECLARED
556 ]m4_ifdef([b4_stype],
557 [[typedef union ]b4_union_name[
560 } ]b4_api_PREFIX[STYPE;
561 # define ]b4_api_PREFIX[STYPE_IS_TRIVIAL 1]],
562 [m4_if(b4_tag_seen_flag, 0,
563 [[typedef int ]b4_api_PREFIX[STYPE;
564 # define ]b4_api_PREFIX[STYPE_IS_TRIVIAL 1]])])[
565 # define ]b4_api_prefix[stype ]b4_api_PREFIX[STYPE /* obsolescent; will be withdrawn */
566 # define ]b4_api_PREFIX[STYPE_IS_DECLARED 1
567 #endif]b4_locations_if([[
569 #if ! defined ]b4_api_PREFIX[LTYPE && ! defined ]b4_api_PREFIX[LTYPE_IS_DECLARED
570 typedef struct ]b4_api_PREFIX[LTYPE
576 } ]b4_api_PREFIX[LTYPE;
577 # define ]b4_api_prefix[ltype ]b4_api_PREFIX[LTYPE /* obsolescent; will be withdrawn */
578 # define ]b4_api_PREFIX[LTYPE_IS_DECLARED 1
579 # define ]b4_api_PREFIX[LTYPE_IS_TRIVIAL 1
582 b4_pure_if([], [[extern ]b4_api_PREFIX[STYPE ]b4_prefix[lval;
583 ]b4_locations_if([[extern ]b4_api_PREFIX[LTYPE ]b4_prefix[lloc;]])])[]dnl
588 m4_define([b4_YYDEBUG_define],
589 [[/* Enabling traces. */
590 ]m4_if(b4_api_prefix, [yy],
592 # define YYDEBUG ]b4_debug_flag[
594 [[#ifndef ]b4_api_PREFIX[DEBUG
597 # define ]b4_api_PREFIX[DEBUG 1
599 # define ]b4_api_PREFIX[DEBUG 0
601 # else /* ! defined YYDEBUG */
602 # define ]b4_api_PREFIX[DEBUG ]b4_debug_flag[
603 # endif /* ! defined ]b4_api_PREFIX[DEBUG */
604 #endif /* ! defined ]b4_api_PREFIX[DEBUG */]])[]dnl
609 m4_define([b4_declare_yydebug],
611 #if ]b4_api_PREFIX[DEBUG
612 extern int ]b4_prefix[debug;
616 # b4_yylloc_default_define
617 # ------------------------
618 # Define YYLLOC_DEFAULT.
619 m4_define([b4_yylloc_default_define],
620 [[/* YYLLOC_DEFAULT -- Set CURRENT to span from RHS[1] to RHS[N].
621 If N is 0, then set CURRENT to the empty location which ends
622 the previous symbol: RHS[0] (always defined). */
624 #ifndef YYLLOC_DEFAULT
625 # define YYLLOC_DEFAULT(Current, Rhs, N) \
629 (Current).first_line = YYRHSLOC (Rhs, 1).first_line; \
630 (Current).first_column = YYRHSLOC (Rhs, 1).first_column; \
631 (Current).last_line = YYRHSLOC (Rhs, N).last_line; \
632 (Current).last_column = YYRHSLOC (Rhs, N).last_column; \
636 (Current).first_line = (Current).last_line = \
637 YYRHSLOC (Rhs, 0).last_line; \
638 (Current).first_column = (Current).last_column = \
639 YYRHSLOC (Rhs, 0).last_column; \