3 # C M4 Macros for Bison.
5 # Copyright (C) 2002, 2004-2013 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 # Depends on individual skeletons to define b4_pure_flag, b4_push_flag, or
57 # b4_pull_flag if they use the values of the %define variables api.pure or
59 m4_define([b4_identification],
60 [[/* Identify Bison output. */
64 #define YYBISON_VERSION "]b4_version["
67 #define YYSKELETON_NAME ]b4_skeleton[]m4_ifdef([b4_pure_flag], [[
70 #define YYPURE ]b4_pure_flag])[]m4_ifdef([b4_push_flag], [[
73 #define YYPUSH ]b4_push_flag])[]m4_ifdef([b4_pull_flag], [[
76 #define YYPULL ]b4_pull_flag])[
80 ## ---------------- ##
82 ## ---------------- ##
84 # b4_api_prefix, b4_api_PREFIX
85 # ----------------------------
86 # Corresponds to %define api.prefix
87 b4_percent_define_default([[api.prefix]], [[yy]])
88 m4_define([b4_api_prefix],
89 [b4_percent_define_get([[api.prefix]])])
90 m4_define([b4_api_PREFIX],
91 [m4_toupper(b4_api_prefix)])
96 # If the %name-prefix is not given, it is api.prefix.
97 m4_define_default([b4_prefix], [b4_api_prefix])
99 # If the %union is not named, its name is YYSTYPE.
100 m4_define_default([b4_union_name], [b4_api_PREFIX[]STYPE])
103 ## ------------------------ ##
104 ## Pure/impure interfaces. ##
105 ## ------------------------ ##
109 # All the yylex formal arguments.
110 # b4_lex_param arrives quoted twice, but we want to keep only one level.
111 m4_define([b4_lex_formals],
112 [b4_pure_if([[[[YYSTYPE *yylvalp]], [[&yylval]]][]dnl
113 b4_locations_if([, [[YYLTYPE *yyllocp], [&yylloc]]])])dnl
114 m4_ifdef([b4_lex_param], [, ]b4_lex_param)])
121 [b4_function_call([yylex], [int], b4_lex_formals)])
126 m4_define([b4_user_args],
127 [m4_ifset([b4_parse_param], [, b4_args(b4_parse_param)])])
132 # If defined, b4_parse_param arrives double quoted, but below we prefer
133 # it to be single quoted.
134 m4_define([b4_parse_param],
138 # b4_parse_param_for(DECL, FORMAL, BODY)
139 # ---------------------------------------
140 # Iterate over the user parameters, binding the declaration to DECL,
141 # the formal name to FORMAL, and evaluating the BODY.
142 m4_define([b4_parse_param_for],
143 [m4_foreach([$1_$2], m4_defn([b4_parse_param]),
144 [m4_pushdef([$1], m4_unquote(m4_car($1_$2)))dnl
145 m4_pushdef([$2], m4_shift($1_$2))dnl
151 # b4_parse_param_use([VAL], [LOC])
152 # --------------------------------
153 # 'YYUSE' VAL, LOC if locations are enabled, and all the parse-params.
154 m4_define([b4_parse_param_use],
155 [m4_ifvaln([$1], [ YYUSE ([$1]);])dnl
156 b4_locations_if([m4_ifvaln([$2], [ YYUSE ([$2]);])])dnl
157 b4_parse_param_for([Decl], [Formal], [ YYUSE (Formal);
166 # b4_int_type(MIN, MAX)
167 # ---------------------
168 # Return the smallest int type able to handle numbers ranging from
169 # MIN to MAX (included).
170 m4_define([b4_int_type],
171 [m4_if(b4_ints_in($@, [0], [255]), [1], [unsigned char],
172 b4_ints_in($@, [-128], [127]), [1], [signed char],
174 b4_ints_in($@, [0], [65535]), [1], [unsigned short int],
175 b4_ints_in($@, [-32768], [32767]), [1], [short int],
177 m4_eval([0 <= $1]), [1], [unsigned int],
182 # b4_int_type_for(NAME)
183 # ---------------------
184 # Return the smallest int type able to handle numbers ranging from
185 # 'NAME_min' to 'NAME_max' (included).
186 m4_define([b4_int_type_for],
187 [b4_int_type($1_min, $1_max)])
190 # b4_table_value_equals(TABLE, VALUE, LITERAL)
191 # --------------------------------------------
192 # Without inducing a comparison warning from the compiler, check if the
193 # literal value LITERAL equals VALUE from table TABLE, which must have
194 # TABLE_min and TABLE_max defined.
195 m4_define([b4_table_value_equals],
196 [m4_if(m4_eval($3 < m4_indir([b4_]$1[_min])
197 || m4_indir([b4_]$1[_max]) < $3), [1],
199 [(!!(($2) == ($3)))])])
209 # Portability issues: define a YY_NULL appropriate for the current
210 # language (C, C++98, or C++11).
211 m4_define([b4_null_define],
213 # if defined __cplusplus && 201103L <= __cplusplus
214 # define YY_NULL nullptr
224 # Return a null pointer constant.
225 m4_define([b4_null], [YY_NULL])
227 # b4_integral_parser_table_define(TABLE-NAME, CONTENT, COMMENT)
228 # -------------------------------------------------------------
229 # Define "yy<TABLE-NAME>" whose contents is CONTENT.
230 m4_define([b4_integral_parser_table_define],
231 [m4_ifvaln([$3], [b4_comment([$3], [ ])])dnl
232 static const b4_int_type_for([$2]) yy$1[[]] =
239 ## ------------------------- ##
240 ## Assigning token numbers. ##
241 ## ------------------------- ##
243 # b4_token_define(TOKEN-NUM)
244 # --------------------------
245 # Output the definition of this token as #define.
246 m4_define([b4_token_define],
247 [b4_token_format([#define %s %s], [$1])])
251 # Output the definition of the tokens.
252 m4_define([b4_token_defines],
253 [b4_any_token_visible_if([/* Tokens. */
255 ], b4_symbol_map([b4_token_define]))
259 # b4_token_enum(TOKEN-NUM)
260 # ------------------------
261 # Output the definition of this token as an enum.
262 m4_define([b4_token_enum],
263 [b4_token_format([%s = %s], [$1])])
268 # Output the definition of the tokens (if there are) as enums.
269 m4_define([b4_token_enums],
270 [b4_any_token_visible_if([[/* Token type. */
271 #ifndef ]b4_api_PREFIX[TOKENTYPE
272 # define ]b4_api_PREFIX[TOKENTYPE
273 enum ]b4_api_prefix[tokentype
277 b4_symbol_map([b4_token_enum]))[
283 # b4_token_enums_defines
284 # ----------------------
285 # Output the definition of the tokens (if there are any) as enums and,
286 # if POSIX Yacc is enabled, as #defines.
287 m4_define([b4_token_enums_defines],
288 [b4_token_enums[]b4_yacc_if([b4_token_defines])])
291 ## ----------------- ##
292 ## Semantic Values. ##
293 ## ----------------- ##
296 # b4_symbol_value(VAL, [TYPE])
297 # ----------------------------
298 # Given a semantic value VAL ($$, $1 etc.), extract its value of type
299 # TYPE if TYPE is given, otherwise just return VAL. The result can be
300 # used safetly, it is put in parens to avoid nasty precedence issues.
301 # TYPE is *not* put in braces, provide some if needed.
302 m4_define([b4_symbol_value],
303 [($1[]m4_ifval([$2], [.$2]))])
307 ## ---------------------- ##
308 ## Defining C functions. ##
309 ## ---------------------- ##
312 # b4_function_define(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
313 # -----------------------------------------------------------
314 # Declare the function NAME in C.
315 m4_define([b4_function_define],
317 $1 (b4_formals(m4_shift2($@)))[]dnl
321 # b4_formals([DECL1, NAME1], ...)
322 # -------------------------------
323 # The formal arguments of a C function definition.
324 m4_define([b4_formals],
325 [m4_if([$#], [0], [void],
327 [m4_map_sep([b4_formal], [, ], [$@])])])
329 m4_define([b4_formal],
334 ## ----------------------- ##
335 ## Declaring C functions. ##
336 ## ----------------------- ##
339 # b4_function_declare(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
340 # ------------------------------------------------------------
341 # Declare the function NAME.
342 m4_define([b4_function_declare],
343 [$2 $1 (b4_formals(m4_shift2($@)));[]dnl
349 ## --------------------- ##
350 ## Calling C functions. ##
351 ## --------------------- ##
354 # b4_function_call(NAME, RETURN-VALUE, [DECL1, NAME1], ...)
355 # -----------------------------------------------------------
356 # Call the function NAME with arguments NAME1, NAME2 etc.
357 m4_define([b4_function_call],
358 [$1 (b4_args(m4_shift2($@)))[]dnl
362 # b4_args([DECL1, NAME1], ...)
363 # ----------------------------
364 # Output the arguments NAME1, NAME2...
366 [m4_map_sep([b4_arg], [, ], [$@])])
376 # b4_sync_start(LINE, FILE)
377 # -------------------------
378 m4_define([b4_sync_start], [[#]line $1 $2])
385 # b4_case(LABEL, STATEMENTS)
386 # --------------------------
390 b4_syncline([@oline@], [@ofile@])
394 # b4_predicate_case(LABEL, CONDITIONS)
395 # ------------------------------------
396 m4_define([b4_predicate_case],
399 b4_syncline([@oline@], [@ofile@])
403 # b4_yydestruct_define
404 # --------------------
405 # Define the "yydestruct" function.
406 m4_define_default([b4_yydestruct_define],
407 [[/*-----------------------------------------------.
408 | Release the memory associated to this symbol. |
409 `-----------------------------------------------*/
411 ]b4_function_define([yydestruct],
413 [[const char *yymsg], [yymsg]],
414 [[int yytype], [yytype]],
415 [[YYSTYPE *yyvaluep], [yyvaluep]][]dnl
416 b4_locations_if( [, [[YYLTYPE *yylocationp], [yylocationp]]])[]dnl
417 m4_ifset([b4_parse_param], [, b4_parse_param]))[
419 ]b4_parse_param_use([yyvaluep], [yylocationp])dnl
422 YY_SYMBOL_PRINT (yymsg, yytype, yyvaluep, yylocationp);
426 ]b4_symbol_foreach([b4_symbol_destructor])dnl
434 # b4_yy_symbol_print_define
435 # -------------------------
436 # Define the "yy_symbol_print" function.
437 m4_define_default([b4_yy_symbol_print_define],
439 /*--------------------------------.
440 | Print this symbol on YYOUTPUT. |
441 `--------------------------------*/
443 ]b4_function_define([yy_symbol_value_print],
445 [[FILE *yyoutput], [yyoutput]],
446 [[int yytype], [yytype]],
447 [[YYSTYPE const * const yyvaluep], [yyvaluep]][]dnl
448 b4_locations_if([, [[YYLTYPE const * const yylocationp], [yylocationp]]])[]dnl
449 m4_ifset([b4_parse_param], [, b4_parse_param]))[
451 FILE *yyo = yyoutput;
452 ]b4_parse_param_use([yyo], [yylocationp])dnl
455 dnl glr.c does not feature yytoknum.
456 m4_if(b4_skeleton, ["yacc.c"],
458 if (yytype < YYNTOKENS)
459 YYPRINT (yyoutput, yytoknum[yytype], *yyvaluep);
464 ]b4_symbol_foreach([b4_symbol_printer])dnl
471 /*--------------------------------.
472 | Print this symbol on YYOUTPUT. |
473 `--------------------------------*/
475 ]b4_function_define([yy_symbol_print],
477 [[FILE *yyoutput], [yyoutput]],
478 [[int yytype], [yytype]],
479 [[YYSTYPE const * const yyvaluep], [yyvaluep]][]dnl
480 b4_locations_if([, [[YYLTYPE const * const yylocationp], [yylocationp]]])[]dnl
481 m4_ifset([b4_parse_param], [, b4_parse_param]))[
483 YYFPRINTF (yyoutput, "%s %s (",
484 yytype < YYNTOKENS ? "token" : "nterm", yytname[yytype]);
486 ]b4_locations_if([ YY_LOCATION_PRINT (yyoutput, *yylocationp);
487 YYFPRINTF (yyoutput, ": ");
489 [ yy_symbol_value_print (yyoutput, yytype, yyvaluep]dnl
490 b4_locations_if([, yylocationp])[]b4_user_args[);
491 YYFPRINTF (yyoutput, ")");
496 ## ---------------- ##
497 ## api.value.type. ##
498 ## ---------------- ##
501 # ---------------------- #
502 # api.value.type=union. #
503 # ---------------------- #
505 # b4_symbol_type_register(SYMBOL-NUM)
506 # -----------------------------------
507 # Symbol SYMBOL-NUM has a type (for variant) instead of a type-tag.
508 # Extend the definition of %union's body with a field of that type,
509 # and extend the symbol's "type" field to point to the field name,
510 # instead of the type name.
511 m4_define([b4_symbol_type_register],
512 [m4_define([b4_symbol($1, type_tag)],
513 [b4_symbol_if([$1], [has_id],
514 [b4_symbol([$1], [id])],
515 [yytype_[]b4_symbol([$1], [number])])])dnl
516 m4_append([b4_user_union_members],
518 b4_symbol_tag_comment([$1])dnl
519 b4_symbol([$1], [type]) b4_symbol([$1], [type_tag]);]))
523 # b4_type_define_tag(SYMBOL1-NUM, ...)
524 # ------------------------------------
525 # For the batch of symbols SYMBOL1-NUM... (which all have the same
526 # type), enhance the %union definition for each of them, and set
527 # there "type" field to the field tag name, instead of the type name.
528 m4_define([b4_type_define_tag],
529 [b4_symbol_if([$1], [has_type],
530 [m4_map([b4_symbol_type_register], [$@])])
534 # b4_symbol_value_union(VAL, [TYPE])
535 # ----------------------------------
536 # Same of b4_symbol_value, but when api.value.type=union.
537 m4_define([b4_symbol_value_union],
544 # b4_value_type_setup_union
545 # -------------------------
546 # Setup support for api.value.type=union. Symbols are defined with a
547 # type instead of a union member name: build the corresponding union,
548 # and give the symbols their tag.
549 m4_define([b4_value_type_setup_union],
550 [m4_define([b4_union_members])
551 b4_type_foreach([b4_type_define_tag])
552 m4_copy_force([b4_symbol_value_union], [b4_symbol_value])
561 # b4_value_type_setup_variant
562 # ---------------------------
563 # Setup support for api.value.type=variant. By default, fail, specialized
564 # by other skeletons.
565 m4_define([b4_value_type_setup_variant],
566 [b4_complain_at(b4_percent_define_get_loc([api.value.type]),
567 [['%s' does not support '%s']],
569 [%define api.value.type variant])])
572 # b4_value_type_setup
573 # -------------------
574 # Check if api.value.type is properly defined, and possibly prepare
576 m4_define([b4_value_type_setup],
577 [b4_percent_define_default([[api.value.type]],
578 [m4_ifdef([b4_union_members], [%union],
579 [m4_if(b4_tag_seen_flag, 0, [int],
581 m4_case(b4_percent_define_get([api.value.type]),
582 [union], [b4_value_type_setup_union],
583 [variant], [b4_value_type_setup_variant])])
592 # b4_value_type_define
593 # --------------------
594 m4_define([b4_value_type_define],
595 [b4_value_type_setup[]dnl
597 m4_bmatch(b4_percent_define_get([api.value.type]),
599 [[#if ! defined ]b4_api_PREFIX[STYPE && ! defined ]b4_api_PREFIX[STYPE_IS_DECLARED
600 typedef union ]b4_union_name[ ]b4_api_PREFIX[STYPE;
601 union ]b4_union_name[
603 ]b4_user_union_members[
605 # define ]b4_api_PREFIX[STYPE_IS_TRIVIAL 1
606 # define ]b4_api_PREFIX[STYPE_IS_DECLARED 1
610 [[#if ! defined ]b4_api_PREFIX[STYPE && ! defined ]b4_api_PREFIX[STYPE_IS_DECLARED
611 typedef ]b4_percent_define_get([api.value.type])[ ]b4_api_PREFIX[STYPE;
612 # define ]b4_api_PREFIX[STYPE_IS_TRIVIAL 1
613 # define ]b4_api_PREFIX[STYPE_IS_DECLARED 1
618 # b4_location_type_define
619 # -----------------------
620 m4_define([b4_location_type_define],
621 [[/* Location type. */
622 #if ! defined ]b4_api_PREFIX[LTYPE && ! defined ]b4_api_PREFIX[LTYPE_IS_DECLARED
623 typedef struct ]b4_api_PREFIX[LTYPE ]b4_api_PREFIX[LTYPE;
624 struct ]b4_api_PREFIX[LTYPE
631 # define ]b4_api_PREFIX[LTYPE_IS_DECLARED 1
632 # define ]b4_api_PREFIX[LTYPE_IS_TRIVIAL 1
637 # b4_declare_yylstype
638 # -------------------
639 # Declarations that might either go into the header (if --defines) or
640 # in the parser body. Declare YYSTYPE/YYLTYPE, and yylval/yylloc.
641 m4_define([b4_declare_yylstype],
642 [b4_value_type_define[]b4_locations_if([
643 b4_location_type_define])
645 b4_pure_if([], [[extern ]b4_api_PREFIX[STYPE ]b4_prefix[lval;
646 ]b4_locations_if([[extern ]b4_api_PREFIX[LTYPE ]b4_prefix[lloc;]])])[]dnl
652 m4_define([b4_YYDEBUG_define],
653 [[/* Debug traces. */
654 ]m4_if(b4_api_prefix, [yy],
656 # define YYDEBUG ]b4_parse_trace_if([1], [0])[
658 [[#ifndef ]b4_api_PREFIX[DEBUG
661 # define ]b4_api_PREFIX[DEBUG 1
663 # define ]b4_api_PREFIX[DEBUG 0
665 # else /* ! defined YYDEBUG */
666 # define ]b4_api_PREFIX[DEBUG ]b4_parse_trace_if([1], [0])[
667 # endif /* ! defined YYDEBUG */
668 #endif /* ! defined ]b4_api_PREFIX[DEBUG */]])[]dnl
673 m4_define([b4_declare_yydebug],
675 #if ]b4_api_PREFIX[DEBUG
676 extern int ]b4_prefix[debug;
680 # b4_yylloc_default_define
681 # ------------------------
682 # Define YYLLOC_DEFAULT.
683 m4_define([b4_yylloc_default_define],
684 [[/* YYLLOC_DEFAULT -- Set CURRENT to span from RHS[1] to RHS[N].
685 If N is 0, then set CURRENT to the empty location which ends
686 the previous symbol: RHS[0] (always defined). */
688 #ifndef YYLLOC_DEFAULT
689 # define YYLLOC_DEFAULT(Current, Rhs, N) \
693 (Current).first_line = YYRHSLOC (Rhs, 1).first_line; \
694 (Current).first_column = YYRHSLOC (Rhs, 1).first_column; \
695 (Current).last_line = YYRHSLOC (Rhs, N).last_line; \
696 (Current).last_column = YYRHSLOC (Rhs, N).last_column; \
700 (Current).first_line = (Current).last_line = \
701 YYRHSLOC (Rhs, 0).last_line; \
702 (Current).first_column = (Current).last_column = \
703 YYRHSLOC (Rhs, 0).last_column; \
709 # b4_yy_location_print_define
710 # ---------------------------
711 # Define YY_LOCATION_PRINT.
712 m4_define([b4_yy_location_print_define],
714 /* YY_LOCATION_PRINT -- Print the location on the stream.
715 This macro was not mandated originally: define only if we know
716 we won't break user code: when these are the locations we know. */
718 #ifndef YY_LOCATION_PRINT
719 # if defined ]b4_api_PREFIX[LTYPE_IS_TRIVIAL && ]b4_api_PREFIX[LTYPE_IS_TRIVIAL
721 /* Print *YYLOCP on YYO. Private, do not rely on its existence. */
723 __attribute__((__unused__))
724 ]b4_function_define([yy_location_print_],
726 [[FILE *yyo], [yyo]],
727 [[YYLTYPE const * const yylocp], [yylocp]])[
730 int end_col = 0 != yylocp->last_column ? yylocp->last_column - 1 : 0;
731 if (0 <= yylocp->first_line)
733 res += YYFPRINTF (yyo, "%d", yylocp->first_line);
734 if (0 <= yylocp->first_column)
735 res += YYFPRINTF (yyo, ".%d", yylocp->first_column);
737 if (0 <= yylocp->last_line)
739 if (yylocp->first_line < yylocp->last_line)
741 res += YYFPRINTF (yyo, "-%d", yylocp->last_line);
743 res += YYFPRINTF (yyo, ".%d", end_col);
745 else if (0 <= end_col && yylocp->first_column < end_col)
746 res += YYFPRINTF (yyo, "-%d", end_col);
751 # define YY_LOCATION_PRINT(File, Loc) \
752 yy_location_print_ (File, &(Loc))
755 # define YY_LOCATION_PRINT(File, Loc) ((void) 0)
758 [[/* This macro is provided for backward compatibility. */
759 #ifndef YY_LOCATION_PRINT
760 # define YY_LOCATION_PRINT(File, Loc) ((void) 0)
766 # Expand to a possible default value for yylloc.
767 m4_define([b4_yyloc_default],
769 # if defined ]b4_api_PREFIX[LTYPE_IS_TRIVIAL && ]b4_api_PREFIX[LTYPE_IS_TRIVIAL
771 m4_defn([b4_location_initial_line]),
772 m4_defn([b4_location_initial_column]),
773 m4_defn([b4_location_initial_line]),
774 m4_defn([b4_location_initial_column]))[ }