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 [[YY_]b4_tocpp(m4_defn([b4_prefix])/[$1])[_INCLUDED]])
36 # b4_cpp_guard_open(FILE)
37 # b4_cpp_guard_close(FILE)
38 # ------------------------
39 # If FILE does not expand to nothing, open/close CPP inclusion guards for FILE.
40 m4_define([b4_cpp_guard_open],
41 [m4_ifval(m4_quote($1),
42 [#ifndef b4_cpp_guard([$1])
43 # define b4_cpp_guard([$1])])])
45 m4_define([b4_cpp_guard_close],
46 [m4_ifval(m4_quote($1),
47 [#endif b4_comment([!b4_cpp_guard([$1])])])])
50 ## ---------------- ##
52 ## ---------------- ##
56 m4_define([b4_comment], [/* m4_bpatsubst([$1], [
62 # Depends on individual skeletons to define b4_pure_flag, b4_push_flag, or
63 # b4_pull_flag if they use the values of the %define variables api.pure or
65 m4_define([b4_identification],
66 [[/* Identify Bison output. */
70 #define YYBISON_VERSION "]b4_version["
73 #define YYSKELETON_NAME ]b4_skeleton[]m4_ifdef([b4_pure_flag], [[
76 #define YYPURE ]b4_pure_flag])[]m4_ifdef([b4_push_flag], [[
79 #define YYPUSH ]b4_push_flag])[]m4_ifdef([b4_pull_flag], [[
82 #define YYPULL ]b4_pull_flag])[
86 ## ---------------- ##
88 ## ---------------- ##
90 # b4_api_prefix, b4_api_PREFIX
91 # ----------------------------
92 # Corresponds to %define api.prefix
93 b4_percent_define_default([[api.prefix]], [[yy]])
94 m4_define([b4_api_prefix],
95 [b4_percent_define_get([[api.prefix]])])
96 m4_define([b4_api_PREFIX],
97 [m4_toupper(b4_api_prefix)])
102 # If the %name-prefix is not given, it is api.prefix.
103 m4_define_default([b4_prefix], [b4_api_prefix])
105 # If the %union is not named, its name is YYSTYPE.
106 m4_define_default([b4_union_name], [b4_api_PREFIX[]STYPE])
109 ## ------------------------ ##
110 ## Pure/impure interfaces. ##
111 ## ------------------------ ##
115 m4_define([b4_user_args],
116 [m4_ifset([b4_parse_param], [, b4_c_args(b4_parse_param)])])
121 # If defined, b4_parse_param arrives double quoted, but below we prefer
122 # it to be single quoted.
123 m4_define([b4_parse_param],
127 # b4_parse_param_for(DECL, FORMAL, BODY)
128 # ---------------------------------------
129 # Iterate over the user parameters, binding the declaration to DECL,
130 # the formal name to FORMAL, and evaluating the BODY.
131 m4_define([b4_parse_param_for],
132 [m4_foreach([$1_$2], m4_defn([b4_parse_param]),
133 [m4_pushdef([$1], m4_unquote(m4_car($1_$2)))dnl
134 m4_pushdef([$2], m4_shift($1_$2))dnl
142 # `YYUSE' all the parse-params.
143 m4_define([b4_parse_param_use],
144 [b4_parse_param_for([Decl], [Formal], [ YYUSE (Formal);
153 # b4_int_type(MIN, MAX)
154 # ---------------------
155 # Return the smallest int type able to handle numbers ranging from
156 # MIN to MAX (included).
157 m4_define([b4_int_type],
158 [m4_if(b4_ints_in($@, [0], [255]), [1], [unsigned char],
159 b4_ints_in($@, [-128], [127]), [1], [signed char],
161 b4_ints_in($@, [0], [65535]), [1], [unsigned short int],
162 b4_ints_in($@, [-32768], [32767]), [1], [short int],
164 m4_eval([0 <= $1]), [1], [unsigned int],
169 # b4_int_type_for(NAME)
170 # ---------------------
171 # Return the smallest int type able to handle numbers ranging from
172 # `NAME_min' to `NAME_max' (included).
173 m4_define([b4_int_type_for],
174 [b4_int_type($1_min, $1_max)])
177 # b4_table_value_equals(TABLE, VALUE, LITERAL)
178 # --------------------------------------------
179 # Without inducing a comparison warning from the compiler, check if the
180 # literal value LITERAL equals VALUE from table TABLE, which must have
181 # TABLE_min and TABLE_max defined. YYID must be defined as an identity
182 # function that suppresses warnings about constant conditions.
183 m4_define([b4_table_value_equals],
184 [m4_if(m4_eval($3 < m4_indir([b4_]$1[_min])
185 || m4_indir([b4_]$1[_max]) < $3), [1],
187 [(!!(($2) == ($3)))])])
190 ## ----------------- ##
191 ## Compiler issues. ##
192 ## ----------------- ##
194 # b4_attribute_define
195 # -------------------
196 # Provide portability for __attribute__.
197 m4_define([b4_attribute_define],
198 [#ifndef __attribute__
199 /* This feature is available in gcc versions 2.5 and later. */
200 # if (! defined __GNUC__ || __GNUC__ < 2 \
201 || (__GNUC__ == 2 && __GNUC_MINOR__ < 5))
202 # define __attribute__(Spec) /* empty */
206 /* Suppress unused-variable warnings by "using" E. */
207 #if ! defined lint || defined __GNUC__
208 # define YYUSE(E) ((void) (E))
210 # define YYUSE(E) /* empty */
217 # Portability issues: define a YY_NULL appropriate for the current
218 # language (C, C++98, or C++11).
219 m4_define([b4_null_define],
221 # if defined __cplusplus && 201103L <= __cplusplus
222 # define YY_NULL nullptr
232 # Return a null pointer constant.
233 m4_define([b4_null], [YY_NULL])
237 ## ------------------------- ##
238 ## Assigning token numbers. ##
239 ## ------------------------- ##
241 # b4_token_define(TOKEN-NAME, TOKEN-NUMBER)
242 # -----------------------------------------
243 # Output the definition of this token as #define.
244 m4_define([b4_token_define],
249 # b4_token_defines(LIST-OF-PAIRS-TOKEN-NAME-TOKEN-NUMBER)
250 # -------------------------------------------------------
251 # Output the definition of the tokens (if there are) as #defines.
252 m4_define([b4_token_defines],
253 [m4_if([$#$1], [1], [],
255 m4_map([b4_token_define], [$@])])
259 # b4_token_enum(TOKEN-NAME, TOKEN-NUMBER)
260 # ---------------------------------------
261 # Output the definition of this token as an enum.
262 m4_define([b4_token_enum],
266 # b4_token_enums(LIST-OF-PAIRS-TOKEN-NAME-TOKEN-NUMBER)
267 # -----------------------------------------------------
268 # Output the definition of the tokens (if there are) as enums.
269 m4_define([b4_token_enums],
270 [m4_if([$#$1], [1], [],
272 #ifndef ]b4_api_PREFIX[TOKENTYPE
273 # define ]b4_api_PREFIX[TOKENTYPE
274 /* Put the tokens into the symbol table, so that GDB and other debuggers
276 enum ]b4_api_prefix[tokentype {
277 ]m4_map_sep([ b4_token_enum], [,
285 # b4_token_enums_defines(LIST-OF-PAIRS-TOKEN-NAME-TOKEN-NUMBER)
286 # -------------------------------------------------------------
287 # Output the definition of the tokens (if there are any) as enums and, if POSIX
288 # Yacc is enabled, as #defines.
289 m4_define([b4_token_enums_defines],
290 [b4_token_enums($@)b4_yacc_if([b4_token_defines($@)], [])
295 ## --------------------------------------------- ##
296 ## Defining C functions in both K&R and ANSI-C. ##
297 ## --------------------------------------------- ##
302 # A predicate useful in #if to determine whether C is ancient or modern.
304 # If __STDC__ is defined, the compiler is modern. IBM xlc 7.0 when run
305 # as 'cc' doesn't define __STDC__ (or __STDC_VERSION__) for pedantic
306 # reasons, but it defines __C99__FUNC__ so check that as well.
307 # Microsoft C normally doesn't define these macros, but it defines _MSC_VER.
308 # Consider a C++ compiler to be modern if it defines __cplusplus.
310 m4_define([b4_c_modern],
311 [[(defined __STDC__ || defined __C99__FUNC__ \
312 || defined __cplusplus || defined _MSC_VER)]])
314 # b4_c_function_def(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
315 # ----------------------------------------------------------
316 # Declare the function NAME.
317 m4_define([b4_c_function_def],
319 b4_c_ansi_function_def($@)
322 $1 (b4_c_knr_formal_names(m4_shift2($@)))
323 b4_c_knr_formal_decls(m4_shift2($@))
328 # b4_c_ansi_function_def(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
329 # ---------------------------------------------------------------
330 # Declare the function NAME in ANSI.
331 m4_define([b4_c_ansi_function_def],
333 $1 (b4_c_ansi_formals(m4_shift2($@)))[]dnl
337 # b4_c_ansi_formals([DECL1, NAME1], ...)
338 # --------------------------------------
339 # Output the arguments ANSI-C definition.
340 m4_define([b4_c_ansi_formals],
341 [m4_if([$#], [0], [void],
343 [m4_map_sep([b4_c_ansi_formal], [, ], [$@])])])
345 m4_define([b4_c_ansi_formal],
349 # b4_c_knr_formal_names([DECL1, NAME1], ...)
350 # ------------------------------------------
351 # Output the argument names.
352 m4_define([b4_c_knr_formal_names],
353 [m4_map_sep([b4_c_knr_formal_name], [, ], [$@])])
355 m4_define([b4_c_knr_formal_name],
359 # b4_c_knr_formal_decls([DECL1, NAME1], ...)
360 # ------------------------------------------
361 # Output the K&R argument declarations.
362 m4_define([b4_c_knr_formal_decls],
363 [m4_map_sep([b4_c_knr_formal_decl],
368 m4_define([b4_c_knr_formal_decl],
373 ## ------------------------------------------------------------ ##
374 ## Declaring (prototyping) C functions in both K&R and ANSI-C. ##
375 ## ------------------------------------------------------------ ##
378 # b4_c_ansi_function_decl(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
379 # ----------------------------------------------------------------
380 # Declare the function NAME ANSI C style.
381 m4_define([b4_c_ansi_function_decl],
382 [$2 $1 (b4_c_ansi_formals(m4_shift2($@)));[]dnl
387 # b4_c_function_decl(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
388 # -----------------------------------------------------------
389 # Declare the function NAME in both K&R and ANSI C.
390 m4_define([b4_c_function_decl],
391 [#if defined __STDC__ || defined __cplusplus
392 b4_c_ansi_function_decl($@)
400 ## --------------------- ##
401 ## Calling C functions. ##
402 ## --------------------- ##
405 # b4_c_function_call(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
406 # -----------------------------------------------------------
407 # Call the function NAME with arguments NAME1, NAME2 etc.
408 m4_define([b4_c_function_call],
409 [$1 (b4_c_args(m4_shift2($@)))[]dnl
413 # b4_c_args([DECL1, NAME1], ...)
414 # ------------------------------
415 # Output the arguments NAME1, NAME2...
416 m4_define([b4_c_args],
417 [m4_map_sep([b4_c_arg], [, ], [$@])])
419 m4_define([b4_c_arg],
427 # b4_sync_start(LINE, FILE)
428 # -------------------------
429 m4_define([b4_sync_start], [[#]line $1 $2])
436 # b4_case(LABEL, STATEMENTS)
437 # --------------------------
443 # _b4_symbol_actions(FILENAME, LINENO,
444 # SYMBOL-TAG, SYMBOL-NUM,
445 # SYMBOL-ACTION, SYMBOL-TYPENAME)
446 # --------------------------------------------------
447 # Issue the code for a symbol action (e.g., %printer).
449 # Define b4_dollar_dollar([TYPE-NAME]), and b4_at_dollar, which are
450 # invoked where $<TYPE-NAME>$ and @$ were specified by the user.
451 m4_define([_b4_symbol_actions],
452 [b4_dollar_pushdef([(*yyvaluep)], [$6], [(*yylocationp)])dnl
454 b4_syncline([$2], [$1])
456 b4_syncline([@oline@], [@ofile@])
458 b4_dollar_popdef[]dnl
461 # b4_symbol_actions(KIND)
462 # -----------------------
463 # Emit the symbol actions for KIND ("printers" or "destructors").
464 # Dispatch on "yytype".
465 m4_define([b4_symbol_actions],
466 [m4_ifval(m4_defn([b4_symbol_$1]),
469 ]m4_map([_b4_symbol_actions], m4_defn([b4_symbol_$1]))[
476 # b4_yydestruct_generate(FUNCTION-DECLARATOR)
477 # -------------------------------------------
478 # Generate the "yydestruct" function, which declaration is issued using
479 # FUNCTION-DECLARATOR, which may be "b4_c_ansi_function_def" for ISO C
480 # or "b4_c_function_def" for K&R.
481 m4_define_default([b4_yydestruct_generate],
482 [[/*-----------------------------------------------.
483 | Release the memory associated to this symbol. |
484 `-----------------------------------------------*/
489 [[const char *yymsg], [yymsg]],
490 [[int yytype], [yytype]],
491 [[YYSTYPE *yyvaluep], [yyvaluep]][]dnl
492 b4_locations_if( [, [[YYLTYPE *yylocationp], [yylocationp]]])[]dnl
493 m4_ifset([b4_parse_param], [, b4_parse_param]))[
496 ]b4_locations_if([ YYUSE (yylocationp);
498 b4_parse_param_use[]dnl
502 YY_SYMBOL_PRINT (yymsg, yytype, yyvaluep, yylocationp);
504 ]b4_symbol_actions([destructors])[
509 # b4_yy_symbol_print_generate(FUNCTION-DECLARATOR)
510 # ------------------------------------------------
511 # Generate the "yy_symbol_print" function, which declaration is issued using
512 # FUNCTION-DECLARATOR, which may be "b4_c_ansi_function_def" for ISO C
513 # or "b4_c_function_def" for K&R.
514 m4_define_default([b4_yy_symbol_print_generate],
516 /*--------------------------------.
517 | Print this symbol on YYOUTPUT. |
518 `--------------------------------*/
521 ]$1([yy_symbol_value_print],
523 [[FILE *yyoutput], [yyoutput]],
524 [[int yytype], [yytype]],
525 [[YYSTYPE const * const yyvaluep], [yyvaluep]][]dnl
526 b4_locations_if([, [[YYLTYPE const * const yylocationp], [yylocationp]]])[]dnl
527 m4_ifset([b4_parse_param], [, b4_parse_param]))[
529 FILE *yyo = yyoutput;
533 ]b4_locations_if([ YYUSE (yylocationp);
535 b4_parse_param_use[]dnl
537 if (yytype < YYNTOKENS)
538 YYPRINT (yyoutput, yytoknum[yytype], *yyvaluep);
542 ]b4_symbol_actions([printers])[
546 /*--------------------------------.
547 | Print this symbol on YYOUTPUT. |
548 `--------------------------------*/
550 ]$1([yy_symbol_print],
552 [[FILE *yyoutput], [yyoutput]],
553 [[int yytype], [yytype]],
554 [[YYSTYPE const * const yyvaluep], [yyvaluep]][]dnl
555 b4_locations_if([, [[YYLTYPE const * const yylocationp], [yylocationp]]])[]dnl
556 m4_ifset([b4_parse_param], [, b4_parse_param]))[
558 if (yytype < YYNTOKENS)
559 YYFPRINTF (yyoutput, "token %s (", yytname[yytype]);
561 YYFPRINTF (yyoutput, "nterm %s (", yytname[yytype]);
563 ]b4_locations_if([ YY_LOCATION_PRINT (yyoutput, *yylocationp);
564 YYFPRINTF (yyoutput, ": ");
566 [ yy_symbol_value_print (yyoutput, yytype, yyvaluep]dnl
567 b4_locations_if([, yylocationp])[]b4_user_args[);
568 YYFPRINTF (yyoutput, ")");
576 # b4_declare_yylstype
577 # -------------------
578 # Declarations that might either go into the header (if --defines) or
579 # in the parser body. Declare YYSTYPE/YYLTYPE, and yylval/yylloc.
580 m4_define([b4_declare_yylstype],
581 [[#if ! defined ]b4_api_PREFIX[STYPE && ! defined ]b4_api_PREFIX[STYPE_IS_DECLARED
582 ]m4_ifdef([b4_stype],
583 [[typedef union ]b4_union_name[
586 } ]b4_api_PREFIX[STYPE;
587 # define ]b4_api_PREFIX[STYPE_IS_TRIVIAL 1]],
588 [m4_if(b4_tag_seen_flag, 0,
589 [[typedef int ]b4_api_PREFIX[STYPE;
590 # define ]b4_api_PREFIX[STYPE_IS_TRIVIAL 1]])])[
591 # define ]b4_api_prefix[stype ]b4_api_PREFIX[STYPE /* obsolescent; will be withdrawn */
592 # define ]b4_api_PREFIX[STYPE_IS_DECLARED 1
593 #endif]b4_locations_if([[
595 #if ! defined ]b4_api_PREFIX[LTYPE && ! defined ]b4_api_PREFIX[LTYPE_IS_DECLARED
596 typedef struct ]b4_api_PREFIX[LTYPE
602 } ]b4_api_PREFIX[LTYPE;
603 # define ]b4_api_prefix[ltype ]b4_api_PREFIX[LTYPE /* obsolescent; will be withdrawn */
604 # define ]b4_api_PREFIX[LTYPE_IS_DECLARED 1
605 # define ]b4_api_PREFIX[LTYPE_IS_TRIVIAL 1
608 b4_pure_if([], [[extern ]b4_api_PREFIX[STYPE ]b4_prefix[lval;
609 ]b4_locations_if([[extern ]b4_api_PREFIX[LTYPE ]b4_prefix[lloc;]])])[]dnl
614 m4_define([b4_YYDEBUG_define],
615 [[/* Enabling traces. */
616 ]m4_if(b4_api_prefix, [yy],
618 # define YYDEBUG ]b4_debug_flag[
620 [[#ifndef ]b4_api_PREFIX[DEBUG
623 # define ]b4_api_PREFIX[DEBUG 1
625 # define ]b4_api_PREFIX[DEBUG 0
627 # else /* ! defined YYDEBUG */
628 # define ]b4_api_PREFIX[DEBUG ]b4_debug_flag[
629 # endif /* ! defined YYDEBUG */
630 #endif /* ! defined ]b4_api_PREFIX[DEBUG */]])[]dnl
635 m4_define([b4_declare_yydebug],
637 #if ]b4_api_PREFIX[DEBUG
638 extern int ]b4_prefix[debug;
642 # b4_yylloc_default_define
643 # ------------------------
644 # Define YYLLOC_DEFAULT.
645 m4_define([b4_yylloc_default_define],
646 [[/* YYLLOC_DEFAULT -- Set CURRENT to span from RHS[1] to RHS[N].
647 If N is 0, then set CURRENT to the empty location which ends
648 the previous symbol: RHS[0] (always defined). */
650 #ifndef YYLLOC_DEFAULT
651 # define YYLLOC_DEFAULT(Current, Rhs, N) \
655 (Current).first_line = YYRHSLOC (Rhs, 1).first_line; \
656 (Current).first_column = YYRHSLOC (Rhs, 1).first_column; \
657 (Current).last_line = YYRHSLOC (Rhs, N).last_line; \
658 (Current).last_column = YYRHSLOC (Rhs, N).last_column; \
662 (Current).first_line = (Current).last_line = \
663 YYRHSLOC (Rhs, 0).last_line; \
664 (Current).first_column = (Current).last_column = \
665 YYRHSLOC (Rhs, 0).last_column; \
671 # b4_yy_location_print_define
672 # ---------------------------
673 # Define YY_LOCATION_PRINT.
674 m4_define([b4_yy_location_print_define],
676 /* YY_LOCATION_PRINT -- Print the location on the stream.
677 This macro was not mandated originally: define only if we know
678 we won't break user code: when these are the locations we know. */
680 #ifndef YY_LOCATION_PRINT
681 # if defined ]b4_api_PREFIX[LTYPE_IS_TRIVIAL && ]b4_api_PREFIX[LTYPE_IS_TRIVIAL
683 /* Print *YYLOCP on YYO. Private, do not rely on its existence. */
685 __attribute__((__unused__))
686 ]b4_c_function_def([yy_location_print_],
688 [[FILE *yyo], [yyo]],
689 [[YYLTYPE const * const yylocp], [yylocp]])[
692 int end_col = 0 != yylocp->last_column ? yylocp->last_column - 1 : 0;
693 if (0 <= yylocp->first_line)
695 res += fprintf (yyo, "%d", yylocp->first_line);
696 if (0 <= yylocp->first_column)
697 res += fprintf (yyo, ".%d", yylocp->first_column);
699 if (0 <= yylocp->last_line)
701 if (yylocp->first_line < yylocp->last_line)
703 res += fprintf (yyo, "-%d", yylocp->last_line);
705 res += fprintf (yyo, ".%d", end_col);
707 else if (0 <= end_col && yylocp->first_column < end_col)
708 res += fprintf (yyo, "-%d", end_col);
713 # define YY_LOCATION_PRINT(File, Loc) \
714 yy_location_print_ (File, &(Loc))
717 # define YY_LOCATION_PRINT(File, Loc) ((void) 0)
720 [[/* This macro is provided for backward compatibility. */
721 #ifndef YY_LOCATION_PRINT
722 # define YY_LOCATION_PRINT(File, Loc) ((void) 0)
728 # Expand to a possible default value for yylloc.
729 m4_define([b4_yyloc_default],
731 # if defined ]b4_api_PREFIX[LTYPE_IS_TRIVIAL && ]b4_api_PREFIX[LTYPE_IS_TRIVIAL
733 m4_defn([b4_location_initial_line]),
734 m4_defn([b4_location_initial_column]),
735 m4_defn([b4_location_initial_line]),
736 m4_defn([b4_location_initial_column]))[ }