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/>.
23 # Convert STRING into a valid C macro name.
25 [m4_toupper(m4_bpatsubst(m4_quote($1), [[^a-zA-Z0-9]+], [_]))])
30 # A valid C macro name to use as a CPP header guard for FILE.
31 m4_define([b4_cpp_guard],
32 [b4_tocpp(m4_defn([b4_prefix])/[$1])])
35 # b4_cpp_guard_open(FILE)
36 # b4_cpp_guard_close(FILE)
37 # ------------------------
38 # Open/close CPP inclusion guards for FILE.
39 m4_define([b4_cpp_guard_open],
40 [#ifndef b4_cpp_guard([$1])
41 # define b4_cpp_guard([$1])])
43 m4_define([b4_cpp_guard_close],
44 [#endif b4_comment([!b4_cpp_guard([$1])])])
47 ## ---------------- ##
49 ## ---------------- ##
53 m4_define([b4_comment], [/* m4_bpatsubst([$1], [
59 # Depends on individual skeletons to define b4_pure_flag, b4_push_flag, or
60 # b4_pull_flag if they use the values of the %define variables api.pure or
62 m4_define([b4_identification],
63 [[/* Identify Bison output. */
67 #define YYBISON_VERSION "]b4_version["
70 #define YYSKELETON_NAME ]b4_skeleton[]m4_ifdef([b4_pure_flag], [[
73 #define YYPURE ]b4_pure_flag])[]m4_ifdef([b4_push_flag], [[
76 #define YYPUSH ]b4_push_flag])[]m4_ifdef([b4_pull_flag], [[
79 #define YYPULL ]b4_pull_flag])[
83 ## ---------------- ##
85 ## ---------------- ##
87 # b4_api_prefix, b4_api_PREFIX
88 # ----------------------------
89 # Corresponds to %define api.prefix
90 b4_percent_define_default([[api.prefix]], [[yy]])
91 m4_define([b4_api_prefix],
92 [b4_percent_define_get([[api.prefix]])])
93 m4_define([b4_api_PREFIX],
94 [m4_toupper(b4_api_prefix)])
99 # If the %name-prefix is not given, it is api.prefix.
100 m4_define_default([b4_prefix], [b4_api_prefix])
102 # If the %union is not named, its name is YYSTYPE.
103 m4_define_default([b4_union_name], [b4_api_PREFIX[]STYPE])
106 ## ------------------------ ##
107 ## Pure/impure interfaces. ##
108 ## ------------------------ ##
112 m4_define([b4_user_args],
113 [m4_ifset([b4_parse_param], [, b4_c_args(b4_parse_param)])])
118 # If defined, b4_parse_param arrives double quoted, but below we prefer
119 # it to be single quoted.
120 m4_define([b4_parse_param],
124 # b4_parse_param_for(DECL, FORMAL, BODY)
125 # ---------------------------------------
126 # Iterate over the user parameters, binding the declaration to DECL,
127 # the formal name to FORMAL, and evaluating the BODY.
128 m4_define([b4_parse_param_for],
129 [m4_foreach([$1_$2], m4_defn([b4_parse_param]),
130 [m4_pushdef([$1], m4_unquote(m4_car($1_$2)))dnl
131 m4_pushdef([$2], m4_shift($1_$2))dnl
139 # `YYUSE' all the parse-params.
140 m4_define([b4_parse_param_use],
141 [b4_parse_param_for([Decl], [Formal], [ YYUSE (Formal);
150 # b4_int_type(MIN, MAX)
151 # ---------------------
152 # Return the smallest int type able to handle numbers ranging from
153 # MIN to MAX (included).
154 m4_define([b4_int_type],
155 [m4_if(b4_ints_in($@, [0], [255]), [1], [unsigned char],
156 b4_ints_in($@, [-128], [127]), [1], [signed char],
158 b4_ints_in($@, [0], [65535]), [1], [unsigned short int],
159 b4_ints_in($@, [-32768], [32767]), [1], [short int],
161 m4_eval([0 <= $1]), [1], [unsigned int],
166 # b4_int_type_for(NAME)
167 # ---------------------
168 # Return the smallest int type able to handle numbers ranging from
169 # `NAME_min' to `NAME_max' (included).
170 m4_define([b4_int_type_for],
171 [b4_int_type($1_min, $1_max)])
174 # b4_table_value_equals(TABLE, VALUE, LITERAL)
175 # --------------------------------------------
176 # Without inducing a comparison warning from the compiler, check if the
177 # literal value LITERAL equals VALUE from table TABLE, which must have
178 # TABLE_min and TABLE_max defined. YYID must be defined as an identity
179 # function that suppresses warnings about constant conditions.
180 m4_define([b4_table_value_equals],
181 [m4_if(m4_eval($3 < m4_indir([b4_]$1[_min])
182 || m4_indir([b4_]$1[_max]) < $3), [1],
184 [[((]$2[) == (]$3[))]])])
194 # Portability issues: define a YY_NULL appropriate for the current
195 # language (C, C++98, or C++11).
196 m4_define([b4_null_define],
198 # if defined __cplusplus && 201103L <= __cplusplus
199 # define YY_NULL nullptr
209 # Return a null pointer constant.
210 m4_define([b4_null], [YY_NULL])
214 ## ------------------------- ##
215 ## Assigning token numbers. ##
216 ## ------------------------- ##
218 # b4_token_define(TOKEN-NAME, TOKEN-NUMBER)
219 # -----------------------------------------
220 # Output the definition of this token as #define.
221 m4_define([b4_token_define],
226 # b4_token_defines(LIST-OF-PAIRS-TOKEN-NAME-TOKEN-NUMBER)
227 # -------------------------------------------------------
228 # Output the definition of the tokens (if there are) as #defines.
229 m4_define([b4_token_defines],
230 [m4_if([$#$1], [1], [],
232 m4_map([b4_token_define], [$@])])
236 # b4_token_enum(TOKEN-NAME, TOKEN-NUMBER)
237 # ---------------------------------------
238 # Output the definition of this token as an enum.
239 m4_define([b4_token_enum],
243 # b4_token_enums(LIST-OF-PAIRS-TOKEN-NAME-TOKEN-NUMBER)
244 # -----------------------------------------------------
245 # Output the definition of the tokens (if there are) as enums.
246 m4_define([b4_token_enums],
247 [m4_if([$#$1], [1], [],
249 #ifndef ]b4_api_PREFIX[TOKENTYPE
250 # define ]b4_api_PREFIX[TOKENTYPE
251 /* Put the tokens into the symbol table, so that GDB and other debuggers
253 enum ]b4_api_prefix[tokentype {
254 ]m4_map_sep([ b4_token_enum], [,
262 # b4_token_enums_defines(LIST-OF-PAIRS-TOKEN-NAME-TOKEN-NUMBER)
263 # -------------------------------------------------------------
264 # Output the definition of the tokens (if there are any) as enums and, if POSIX
265 # Yacc is enabled, as #defines.
266 m4_define([b4_token_enums_defines],
267 [b4_token_enums($@)b4_yacc_if([b4_token_defines($@)], [])
272 ## --------------------------------------------- ##
273 ## Defining C functions in both K&R and ANSI-C. ##
274 ## --------------------------------------------- ##
279 # A predicate useful in #if to determine whether C is ancient or modern.
281 # If __STDC__ is defined, the compiler is modern. IBM xlc 7.0 when run
282 # as 'cc' doesn't define __STDC__ (or __STDC_VERSION__) for pedantic
283 # reasons, but it defines __C99__FUNC__ so check that as well.
284 # Microsoft C normally doesn't define these macros, but it defines _MSC_VER.
285 # Consider a C++ compiler to be modern if it defines __cplusplus.
287 m4_define([b4_c_modern],
288 [[(defined __STDC__ || defined __C99__FUNC__ \
289 || defined __cplusplus || defined _MSC_VER)]])
291 # b4_c_function_def(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
292 # ----------------------------------------------------------
293 # Declare the function NAME.
294 m4_define([b4_c_function_def],
296 b4_c_ansi_function_def($@)
299 $1 (b4_c_knr_formal_names(m4_shift2($@)))
300 b4_c_knr_formal_decls(m4_shift2($@))
305 # b4_c_ansi_function_def(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
306 # ---------------------------------------------------------------
307 # Declare the function NAME in ANSI.
308 m4_define([b4_c_ansi_function_def],
310 $1 (b4_c_ansi_formals(m4_shift2($@)))[]dnl
314 # b4_c_ansi_formals([DECL1, NAME1], ...)
315 # --------------------------------------
316 # Output the arguments ANSI-C definition.
317 m4_define([b4_c_ansi_formals],
318 [m4_if([$#], [0], [void],
320 [m4_map_sep([b4_c_ansi_formal], [, ], [$@])])])
322 m4_define([b4_c_ansi_formal],
326 # b4_c_knr_formal_names([DECL1, NAME1], ...)
327 # ------------------------------------------
328 # Output the argument names.
329 m4_define([b4_c_knr_formal_names],
330 [m4_map_sep([b4_c_knr_formal_name], [, ], [$@])])
332 m4_define([b4_c_knr_formal_name],
336 # b4_c_knr_formal_decls([DECL1, NAME1], ...)
337 # ------------------------------------------
338 # Output the K&R argument declarations.
339 m4_define([b4_c_knr_formal_decls],
340 [m4_map_sep([b4_c_knr_formal_decl],
345 m4_define([b4_c_knr_formal_decl],
350 ## ------------------------------------------------------------ ##
351 ## Declaring (prototyping) C functions in both K&R and ANSI-C. ##
352 ## ------------------------------------------------------------ ##
355 # b4_c_function_decl(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
356 # -----------------------------------------------------------
357 # Declare the function NAME.
358 m4_define([b4_c_function_decl],
359 [#if defined __STDC__ || defined __cplusplus
360 b4_c_ansi_function_decl($@)
367 # b4_c_ansi_function_decl(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
368 # ----------------------------------------------------------------
369 # Declare the function NAME.
370 m4_define([b4_c_ansi_function_decl],
371 [$2 $1 (b4_c_ansi_formals(m4_shift2($@)));[]dnl
377 ## --------------------- ##
378 ## Calling C functions. ##
379 ## --------------------- ##
382 # b4_c_function_call(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
383 # -----------------------------------------------------------
384 # Call the function NAME with arguments NAME1, NAME2 etc.
385 m4_define([b4_c_function_call],
386 [$1 (b4_c_args(m4_shift2($@)))[]dnl
390 # b4_c_args([DECL1, NAME1], ...)
391 # ------------------------------
392 # Output the arguments NAME1, NAME2...
393 m4_define([b4_c_args],
394 [m4_map_sep([b4_c_arg], [, ], [$@])])
396 m4_define([b4_c_arg],
404 # b4_sync_start(LINE, FILE)
405 # -----------------------
406 m4_define([b4_sync_start], [[#]line $1 $2])
413 # b4_case(LABEL, STATEMENTS)
414 # --------------------------
420 # b4_dollar_dollar_(NAME, FIELD, DEFAULT-FIELD)
421 # ---------------------------------------------
422 # If FIELD (or DEFAULT-FIELD) is non-null, read it in pointer NAME,
423 # otherwise just dereference.
424 m4_define([b4_dollar_dollar_],
426 [m4_ifval([$3], [($1->$3)],
431 # b4_symbol_actions(FILENAME, LINENO,
432 # SYMBOL-TAG, SYMBOL-NUM,
433 # SYMBOL-ACTION, SYMBOL-TYPENAME)
434 # -------------------------------------------------
435 # Issue the code for a symbol action (e.g., %printer).
437 # Define b4_dollar_dollar([TYPE-NAME]), and b4_at_dollar, which are
438 # invoked where $<TYPE-NAME>$ and @$ were specified by the user.
439 m4_define([b4_symbol_actions],
440 [m4_pushdef([b4_dollar_dollar],
441 [b4_dollar_dollar_([yyvaluep], m4_dquote($][1), [$6])])dnl
442 m4_pushdef([b4_at_dollar], [(*yylocationp)])dnl
444 b4_syncline([$2], [$1])
446 b4_syncline([@oline@], [@ofile@])
448 m4_popdef([b4_at_dollar])dnl
449 m4_popdef([b4_dollar_dollar])dnl
453 # b4_yydestruct_generate(FUNCTION-DECLARATOR)
454 # -------------------------------------------
455 # Generate the "yydestruct" function, which declaration is issued using
456 # FUNCTION-DECLARATOR, which may be "b4_c_ansi_function_def" for ISO C
457 # or "b4_c_function_def" for K&R.
458 m4_define_default([b4_yydestruct_generate],
459 [[/*-----------------------------------------------.
460 | Release the memory associated to this symbol. |
461 `-----------------------------------------------*/
466 [[const char *yymsg], [yymsg]],
467 [[int yytype], [yytype]],
468 [[YYSTYPE *yyvaluep], [yyvaluep]][]dnl
469 b4_locations_if( [, [[YYLTYPE *yylocationp], [yylocationp]]])[]dnl
470 m4_ifset([b4_parse_param], [, b4_parse_param]))[
473 ]b4_locations_if([ YYUSE (yylocationp);
475 b4_parse_param_use[]dnl
479 YY_SYMBOL_PRINT (yymsg, yytype, yyvaluep, yylocationp);
483 ]m4_map([b4_symbol_actions], m4_defn([b4_symbol_destructors]))[
491 # b4_yy_symbol_print_generate(FUNCTION-DECLARATOR)
492 # ------------------------------------------------
493 # Generate the "yy_symbol_print" function, which declaration is issued using
494 # FUNCTION-DECLARATOR, which may be "b4_c_ansi_function_def" for ISO C
495 # or "b4_c_function_def" for K&R.
496 m4_define_default([b4_yy_symbol_print_generate],
498 /*--------------------------------.
499 | Print this symbol on YYOUTPUT. |
500 `--------------------------------*/
503 ]$1([yy_symbol_value_print],
505 [[FILE *yyoutput], [yyoutput]],
506 [[int yytype], [yytype]],
507 [[YYSTYPE const * const yyvaluep], [yyvaluep]][]dnl
508 b4_locations_if([, [[YYLTYPE const * const yylocationp], [yylocationp]]])[]dnl
509 m4_ifset([b4_parse_param], [, b4_parse_param]))[
511 FILE *yyo = yyoutput;
515 ]b4_locations_if([ YYUSE (yylocationp);
517 b4_parse_param_use[]dnl
519 if (yytype < YYNTOKENS)
520 YYPRINT (yyoutput, yytoknum[yytype], *yyvaluep);
526 ]m4_map([b4_symbol_actions], m4_defn([b4_symbol_printers]))dnl
533 /*--------------------------------.
534 | Print this symbol on YYOUTPUT. |
535 `--------------------------------*/
537 ]$1([yy_symbol_print],
539 [[FILE *yyoutput], [yyoutput]],
540 [[int yytype], [yytype]],
541 [[YYSTYPE const * const yyvaluep], [yyvaluep]][]dnl
542 b4_locations_if([, [[YYLTYPE const * const yylocationp], [yylocationp]]])[]dnl
543 m4_ifset([b4_parse_param], [, b4_parse_param]))[
545 if (yytype < YYNTOKENS)
546 YYFPRINTF (yyoutput, "token %s (", yytname[yytype]);
548 YYFPRINTF (yyoutput, "nterm %s (", yytname[yytype]);
550 ]b4_locations_if([ YY_LOCATION_PRINT (yyoutput, *yylocationp);
551 YYFPRINTF (yyoutput, ": ");
553 [ yy_symbol_value_print (yyoutput, yytype, yyvaluep]dnl
554 b4_locations_if([, yylocationp])[]b4_user_args[);
555 YYFPRINTF (yyoutput, ")");
563 # b4_declare_yylstype
564 # -------------------
565 # Declarations that might either go into the header (if --defines) or
566 # in the parser body. Declare YYSTYPE/YYLTYPE, and yylval/yylloc.
567 m4_define([b4_declare_yylstype],
568 [[#if ! defined ]b4_api_PREFIX[STYPE && ! defined ]b4_api_PREFIX[STYPE_IS_DECLARED
569 ]m4_ifdef([b4_stype],
570 [[typedef union ]b4_union_name[
573 } ]b4_api_PREFIX[STYPE;
574 # define ]b4_api_PREFIX[STYPE_IS_TRIVIAL 1]],
575 [m4_if(b4_tag_seen_flag, 0,
576 [[typedef int ]b4_api_PREFIX[STYPE;
577 # define ]b4_api_PREFIX[STYPE_IS_TRIVIAL 1]])])[
578 # define ]b4_api_prefix[stype ]b4_api_PREFIX[STYPE /* obsolescent; will be withdrawn */
579 # define ]b4_api_PREFIX[STYPE_IS_DECLARED 1
580 #endif]b4_locations_if([[
582 #if ! defined ]b4_api_PREFIX[LTYPE && ! defined ]b4_api_PREFIX[LTYPE_IS_DECLARED
583 typedef struct ]b4_api_PREFIX[LTYPE
589 } ]b4_api_PREFIX[LTYPE;
590 # define ]b4_api_prefix[ltype ]b4_api_PREFIX[LTYPE /* obsolescent; will be withdrawn */
591 # define ]b4_api_PREFIX[LTYPE_IS_DECLARED 1
592 # define ]b4_api_PREFIX[LTYPE_IS_TRIVIAL 1
595 b4_pure_if([], [[extern ]b4_api_PREFIX[STYPE ]b4_prefix[lval;
596 ]b4_locations_if([[extern ]b4_api_PREFIX[LTYPE ]b4_prefix[lloc;]])])[]dnl
601 m4_define([b4_YYDEBUG_define],
602 [[/* Enabling traces. */
603 ]m4_if(b4_api_prefix, [yy],
605 # define YYDEBUG ]b4_debug_flag[
607 [[#ifndef ]b4_api_PREFIX[DEBUG
610 # define ]b4_api_PREFIX[DEBUG 1
612 # define ]b4_api_PREFIX[DEBUG 0
614 # else /* ! defined YYDEBUG */
615 # define ]b4_api_PREFIX[DEBUG ]b4_debug_flag[
616 # endif /* ! defined ]b4_api_PREFIX[DEBUG */
617 #endif /* ! defined ]b4_api_PREFIX[DEBUG */]])[]dnl
622 m4_define([b4_declare_yydebug],
624 #if ]b4_api_PREFIX[DEBUG
625 extern int ]b4_prefix[debug;
629 # b4_yylloc_default_define
630 # ------------------------
631 # Define YYLLOC_DEFAULT.
632 m4_define([b4_yylloc_default_define],
633 [[/* YYLLOC_DEFAULT -- Set CURRENT to span from RHS[1] to RHS[N].
634 If N is 0, then set CURRENT to the empty location which ends
635 the previous symbol: RHS[0] (always defined). */
637 #ifndef YYLLOC_DEFAULT
638 # define YYLLOC_DEFAULT(Current, Rhs, N) \
642 (Current).first_line = YYRHSLOC (Rhs, 1).first_line; \
643 (Current).first_column = YYRHSLOC (Rhs, 1).first_column; \
644 (Current).last_line = YYRHSLOC (Rhs, N).last_line; \
645 (Current).last_column = YYRHSLOC (Rhs, N).last_column; \
649 (Current).first_line = (Current).last_line = \
650 YYRHSLOC (Rhs, 0).last_line; \
651 (Current).first_column = (Current).last_column = \
652 YYRHSLOC (Rhs, 0).last_column; \