3 # Language-independent M4 Macros for Bison.
4 # Copyright (C) 2002, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
6 # This program is free software: you can redistribute it and/or modify
7 # it under the terms of the GNU General Public License as published by
8 # the Free Software Foundation, either version 3 of the License, or
9 # (at your option) any later version.
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.
16 # You should have received a copy of the GNU General Public License
17 # along with this program. If not, see <http://www.gnu.org/licenses/>.
20 ## ---------------- ##
22 ## ---------------- ##
24 # b4_copyright(TITLE, YEARS)
25 # --------------------------
26 m4_define([b4_copyright],
27 [b4_comment([A Bison parser, made by GNU Bison b4_version.])
31 m4_text_wrap([Copyright (C) $2 Free Software Foundation, Inc.], [ ])
33 This program is free software: you can redistribute it and/or modify
34 it under the terms of the GNU General Public License as published by
35 the Free Software Foundation, either version 3 of the License, or
36 (at your option) any later version.
38 This program is distributed in the hope that it will be useful,
39 but WITHOUT ANY WARRANTY; without even the implied warranty of
40 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
41 GNU General Public License for more details.
43 You should have received a copy of the GNU General Public License
44 along with this program. If not, see <http://www.gnu.org/licenses/>.])
46 b4_comment([As a special exception, you may create a larger work that contains
47 part or all of the Bison parser skeleton and distribute that work
48 under terms of your choice, so long as that work isn't itself a
49 parser generator using the skeleton or a modified version thereof
50 as a parser skeleton. Alternatively, if you modify or redistribute
51 the parser skeleton itself, you may (at your option) remove this
52 special exception, which will cause the skeleton and the resulting
53 Bison output files to be licensed under the GNU General Public
54 License without this special exception.
56 This special exception was added by the Free Software Foundation in
57 version 2.2 of Bison.])])
60 ## ---------------- ##
62 ## ---------------- ##
64 # b4_error(KIND, FORMAT, [ARG1], [ARG2], ...)
65 # -------------------------------------------
66 # Write @KIND(FORMAT@,ARG1@,ARG2@,...@) to diversion 0.
68 [m4_divert_push(0)[@]$1[(]$2[]m4_if([$#], [2], [],
70 m4_dquote(m4_shift(m4_shift($@))),
71 [[@,]b4_arg])])[@)]m4_divert_pop(0)])
73 # b4_error_at(KIND, START, END, FORMAT, [ARG1], [ARG2], ...)
74 # ----------------------------------------------------------
75 # Write @KIND(START@,END@,FORMAT@,ARG1@,ARG2@,...@) to diversion 0.
76 m4_define([b4_error_at],
77 [m4_divert_push(0)[@]$1[_at(]$2[@,]$3[@,]$4[]m4_if([$#], [4], [],
79 m4_dquote(m4_shift(m4_shift(m4_shift(m4_shift($@))))),
80 [[@,]b4_arg])])[@)]m4_divert_pop(0)])
82 # b4_warn(FORMAT, [ARG1], [ARG2], ...)
83 # ------------------------------------
84 # Write @warn(FORMAT@,ARG1@,ARG2@,...@) to diversion 0.
86 # As a simple test suite, this:
88 # m4_define([asdf], [ASDF])
89 # m4_define([fsa], [FSA])
90 # m4_define([fdsa], [FDSA])
91 # b4_warn([[[asdf), asdf]]], [[[fsa), fsa]]], [[[fdsa), fdsa]]])
93 # b4_warn([[asdf), asdf]], [[fsa), fsa]], [[fdsa), fdsa]])
95 # b4_warn([asdf), asdf], [fsa), fsa], [fdsa), fdsa])
103 # Should produce this:
105 # @warn([asdf), asdf]@,[fsa), fsa]@,[fdsa), fdsa]@)
106 # @warn(asdf), asdf@,fsa), fsa@,fdsa), fdsa@)
107 # @warn(ASDF), ASDF@,FSA), FSA@,FDSA), FDSA@)
112 [b4_error([[warn]], $@)])
114 # b4_warn_at(START, END, FORMAT, [ARG1], [ARG2], ...)
115 # ---------------------------------------------------
116 # Write @warn(START@,END@,FORMAT@,ARG1@,ARG2@,...@) to diversion 0.
117 m4_define([b4_warn_at],
118 [b4_error_at([[warn]], $@)])
120 # b4_complain(FORMAT, [ARG1], [ARG2], ...)
121 # ----------------------------------------
122 # Write @complain(FORMAT@,ARG1@,ARG2@,...@) to diversion 0.
124 # See the test suite for b4_warn above.
125 m4_define([b4_complain],
126 [b4_error([[complain]], $@)])
128 # b4_complain_at(START, END, FORMAT, [ARG1], [ARG2], ...)
129 # -------------------------------------------------------
130 # Write @complain(START@,END@,FORMAT@,ARG1@,ARG2@,...@) to diversion 0.
131 m4_define([b4_complain_at],
132 [b4_error_at([[complain]], $@)])
134 # b4_fatal(FORMAT, [ARG1], [ARG2], ...)
135 # -------------------------------------
136 # Write @fatal(FORMAT@,ARG1@,ARG2@,...@) to diversion 0.
138 # See the test suite for b4_warn above.
139 m4_define([b4_fatal],
140 [b4_error([[fatal]], $@)])
142 # b4_fatal_at(START, END, FORMAT, [ARG1], [ARG2], ...)
143 # ----------------------------------------------------
144 # Write @fatal(START@,END@,FORMAT@,ARG1@,ARG2@,...@) to diversion 0.
145 m4_define([b4_fatal_at],
146 [b4_error_at([[fatal]], $@)])
149 ## ---------------- ##
150 ## Default values. ##
151 ## ---------------- ##
153 # m4_define_default([b4_lex_param], []) dnl breaks other skeletons
154 m4_define_default([b4_pre_prologue], [])
155 m4_define_default([b4_post_prologue], [])
156 m4_define_default([b4_epilogue], [])
157 m4_define_default([b4_parse_param], [])
159 # The initial column and line.
160 m4_define_default([b4_location_initial_column], [1])
161 m4_define_default([b4_location_initial_line], [1])
168 # b4_ints_in(INT1, INT2, LOW, HIGH)
169 # ---------------------------------
170 # Return 1 iff both INT1 and INT2 are in [LOW, HIGH], 0 otherwise.
171 m4_define([b4_ints_in],
172 [m4_eval([$3 <= $1 && $1 <= $4 && $3 <= $2 && $2 <= $4])])
176 ## ------------------ ##
177 ## Decoding options. ##
178 ## ------------------ ##
180 # b4_flag_if(FLAG, IF-TRUE, IF-FALSE)
181 # -----------------------------------
182 # Run IF-TRUE if b4_FLAG_flag is 1, IF-FALSE if FLAG is 0, otherwise fail.
183 m4_define([b4_flag_if],
187 [m4_fatal([invalid $1 value: ]$1)])])
190 # b4_define_flag_if(FLAG)
191 # -----------------------
192 # Define "b4_FLAG_if(IF-TRUE, IF-FALSE)" that depends on the
193 # value of the Boolean FLAG.
194 m4_define([b4_define_flag_if],
195 [_b4_define_flag_if($[1], $[2], [$1])])
197 # _b4_define_flag_if($1, $2, FLAG)
198 # --------------------------------
199 # This macro works around the impossibility to define macros
200 # inside macros, because issuing `[$1]' is not possible in M4 :(.
201 # This sucks hard, GNU M4 should really provide M5 like $$1.
202 m4_define([_b4_define_flag_if],
203 [m4_if([$1$2], $[1]$[2], [],
204 [m4_fatal([$0: Invalid arguments: $@])])dnl
205 m4_define([b4_$3_if],
206 [b4_flag_if([$3], [$1], [$2])])])
209 # b4_FLAG_if(IF-TRUE, IF-FALSE)
210 # -----------------------------
211 # Expand IF-TRUE, if FLAG is true, IF-FALSE otherwise.
212 b4_define_flag_if([defines]) # Whether headers are requested.
213 b4_define_flag_if([error_verbose]) # Whether error are verbose.
214 b4_define_flag_if([glr]) # Whether a GLR parser is requested.
215 b4_define_flag_if([locations]) # Whether locations are tracked.
216 b4_define_flag_if([nondeterministic]) # Whether conflicts should be handled.
217 b4_define_flag_if([pure]) # Whether the interface is pure.
218 b4_define_flag_if([yacc]) # Whether POSIX Yacc is emulated.
221 ## ------------------------- ##
222 ## Assigning token numbers. ##
223 ## ------------------------- ##
232 # Similar to POSIX basename; the differences don't matter here.
233 # Beware that NAME is not evaluated.
234 m4_define([b4_basename],
235 [m4_bpatsubst([$1], [^.*/\([^/]+\)/*$], [\1])])
238 # b4_syncline(LINE, FILE)
239 # -----------------------
240 m4_define([b4_syncline],
241 [b4_flag_if([synclines], [
242 b4_sync_end([__line__], [b4_basename(m4_quote(__file__))])
243 b4_sync_start([$1], [$2])])])
245 m4_define([b4_sync_end], [b4_comment([Line $1 of $2])])
246 m4_define([b4_sync_start], [b4_comment([Line $1 of $2])])
248 # b4_user_code(USER-CODE)
249 # -----------------------
250 # Emit code from the user, ending it with synclines.
251 m4_define([b4_user_code],
253 b4_syncline([@oline@], [@ofile@])])
256 # b4_define_user_code(MACRO)
257 # --------------------------
258 # From b4_MACRO, build b4_user_MACRO that includes the synclines.
259 m4_define([b4_define_user_code],
260 [m4_define([b4_user_$1],
261 [b4_user_code([b4_$1])])])
265 # b4_user_initial_action
266 # b4_user_post_prologue
267 # b4_user_pre_prologue
269 # ----------------------
270 # Macros that issue user code, ending with synclines.
271 b4_define_user_code([actions])
272 b4_define_user_code([initial_action])
273 b4_define_user_code([post_prologue])
274 b4_define_user_code([pre_prologue])
275 b4_define_user_code([stype])
278 # b4_check_user_names(WHAT, USER-LIST, BISON-NAMESPACE)
279 # --------------------------------------------------------
280 # Warn if any name of type WHAT is used by the user (as recorded in USER-LIST)
281 # but is not used by Bison (as recorded by macros in the namespace
284 # USER-LIST must expand to a list specifying all grammar occurrences of all
285 # names of type WHAT. Each item in the list must be a triplet specifying one
286 # occurrence: name, start boundary, and end boundary. Empty string names are
287 # fine. An empty list is fine.
289 # For example, to define b4_foo_user_names to be used for USER-LIST with three
290 # name occurrences and with correct quoting:
292 # m4_define([b4_foo_user_names],
293 # [[[[[[bar]], [[parser.y:1.7]], [[parser.y:1.16]]]],
294 # [[[[bar]], [[parser.y:5.7]], [[parser.y:5.16]]]],
295 # [[[[baz]], [[parser.y:8.7]], [[parser.y:8.16]]]]]])
297 # The macro BISON-NAMESPACE(bar) must be defined iff the name bar of type WHAT
298 # is used by Bison (in the front-end or in the skeleton). Empty string names
299 # are fine, but it would be ugly for Bison to actually use one.
301 # For example, to use b4_foo_bison_names for BISON-NAMESPACE and define that
302 # the names bar and baz are used by Bison:
304 # m4_define([b4_foo_bison_names(bar)])
305 # m4_define([b4_foo_bison_names(baz)])
307 # To invoke b4_check_user_names with TYPE foo, with USER-LIST
308 # b4_foo_user_names, with BISON-NAMESPACE b4_foo_bison_names, and with correct
311 # b4_check_user_names([[foo]], [b4_foo_user_names],
312 # [[b4_foo_bison_names]])
313 m4_define([b4_check_user_names],
314 [m4_foreach([b4_occurrence], $2,
315 [m4_pushdef([b4_occurrence], b4_occurrence)dnl
316 m4_pushdef([b4_user_name], m4_car(b4_occurrence))dnl
317 m4_pushdef([b4_start], m4_car(m4_shift(b4_occurrence)))dnl
318 m4_pushdef([b4_end], m4_shift(m4_shift(b4_occurrence)))dnl
319 m4_ifndef($3[(]m4_quote(b4_user_name)[)],
320 [b4_warn_at([b4_start], [b4_end],
321 [[%s `%s' is not used]],
322 [$1], [b4_user_name])])[]dnl
323 m4_popdef([b4_occurrence])dnl
324 m4_popdef([b4_user_name])dnl
325 m4_popdef([b4_start])dnl
326 m4_popdef([b4_end])dnl
329 # b4_percent_define_get(VARIABLE)
330 # -------------------------------
331 # Mimic muscle_percent_define_get in ../src/muscle_tab.h exactly. That is, if
332 # the %define variable VARIABLE is defined, emit its value. Also, record
333 # Bison's usage of VARIABLE by defining
334 # b4_percent_define_bison_variables(VARIABLE).
338 # b4_percent_define_get([[foo]])
339 m4_define([b4_percent_define_get],
340 [m4_define([b4_percent_define_bison_variables(]$1[)])dnl
341 m4_ifdef([b4_percent_define(]$1[)], [m4_indir([b4_percent_define(]$1[)])])])
343 # b4_percent_define_ifdef(VARIABLE, IF-TRUE, [IF-FALSE])
344 # ------------------------------------------------------
345 # Mimic muscle_percent_define_ifdef in ../src/muscle_tab.h exactly. That is,
346 # if the %define variable VARIABLE is defined, expand IF-TRUE, else expand
347 # IF-FALSE. Also, record Bison's usage of VARIABLE by defining
348 # b4_percent_define_bison_variables(VARIABLE).
352 # b4_percent_define_ifdef([[foo]], [[it's defined]], [[it's undefined]])
353 m4_define([b4_percent_define_ifdef],
354 [m4_ifdef([b4_percent_define(]$1[)],
355 [m4_define([b4_percent_define_bison_variables(]$1[)])$2],
358 # b4_percent_define_flag_if(VARIABLE, IF-TRUE, [IF-FALSE])
359 # --------------------------------------------------------
360 # Mimic muscle_percent_define_flag_if in ../src/muscle_tab.h exactly. That is,
361 # if the %define variable VARIABLE is defined to "" or "true", expand IF-TRUE.
362 # If it is defined to "false", expand IF-FALSE. Complain if it is undefined
363 # (a Bison or skeleton error since the default value should have been set
364 # already) or defined to any other value (possibly a user error). Also, record
365 # Bison's usage of VARIABLE by defining
366 # b4_percent_define_bison_variables(VARIABLE).
370 # b4_percent_define_flag_if([[foo]], [[it's true]], [[it's false]])
371 m4_define([b4_percent_define_flag_if],
372 [b4_percent_define_ifdef([$1],
373 [m4_case(b4_percent_define_get([$1]),
374 [], [$2], [true], [$2], [false], [$3],
376 m4_pushdef([b4_loc], m4_indir([b4_percent_define_loc(]$1[)]))dnl
377 b4_complain_at(b4_loc,
378 [[invalid value for %%define Boolean variable `%s']],
380 m4_popdef([b4_loc])],
381 [[b4_percent_define_flag_if($1)]])])],
382 [b4_fatal([[undefined %%define variable `%s' passed to b4_percent_define_flag_if]], [$1])])])
384 # b4_percent_define_default(VARIABLE, DEFAULT)
385 # --------------------------------------------
386 # Mimic muscle_percent_define_default in ../src/muscle_tab.h exactly. That is,
387 # if the %define variable VARIABLE is undefined, set its value to DEFAULT.
388 # Don't record this as a Bison usage of VARIABLE as there's no reason to
389 # suspect that the value has yet influenced the output.
393 # b4_percent_define_default([[foo]], [[default value]])
394 m4_define([b4_percent_define_default],
395 [m4_ifndef([b4_percent_define(]$1[)],
396 [m4_define([b4_percent_define(]$1[)], [$2])dnl
397 m4_define([b4_percent_define_loc(]$1[)],
398 [[[[[Bison:b4_percent_define_default]:0.0]], [[[Bison:b4_percent_define_default]:0.0]]]])])])
400 # b4_percent_define_check_values(VALUES)
401 # --------------------------------------
402 # Mimic muscle_percent_define_check_values in ../src/muscle_tab.h exactly
403 # except that the VALUES structure is more appropriate for M4. That is, VALUES
404 # is a list of sublists of strings. For each sublist, the first string is the
405 # name of a %define variable, and all remaining strings in that sublist are the
406 # valid values for that variable. Complain if such a variable is undefined (a
407 # Bison error since the default value should have been set already) or defined
408 # to any other value (possibly a user error). Don't record this as a Bison
409 # usage of the variable as there's no reason to suspect that the value has yet
410 # influenced the output.
414 # b4_percent_define_check_values([[[[foo]], [[foo-value1]], [[foo-value2]]]],
415 # [[[[bar]], [[bar-value1]]]])
416 m4_define([b4_percent_define_check_values],
417 [m4_foreach([b4_sublist], m4_quote($@),
418 [_b4_percent_define_check_values(b4_sublist)])])
420 m4_define([_b4_percent_define_check_values],
421 [m4_ifdef([b4_percent_define(]$1[)],
422 [m4_pushdef([b4_good_value], [0])dnl
424 [m4_foreach([b4_value], m4_dquote(m4_shift($@)),
425 [m4_if(m4_indir([b4_percent_define(]$1[)]), b4_value,
426 [m4_define([b4_good_value], [1])])])])dnl
427 m4_if(b4_good_value, [0],
428 [m4_pushdef([b4_loc], m4_indir([b4_percent_define_loc(]$1[)]))dnl
429 b4_complain_at(b4_loc,
430 [[invalid value for %%define variable `%s': `%s']],
432 m4_dquote(m4_indir([b4_percent_define(]$1[)])))dnl
433 m4_popdef([b4_loc])])dnl
434 m4_popdef([b4_good_value])],
435 [b4_fatal([[undefined %%define variable `%s' passed to b4_percent_define_check_values]], [$1])])])
437 # b4_percent_code_get([QUALIFIER])
438 # --------------------------------
439 # If any %code blocks for QUALIFIER are defined, emit them beginning with a
440 # comment and ending with synclines and a newline. If QUALIFIER is not
441 # specified or empty, do this for the unqualified %code blocks. Also, record
442 # Bison's usage of QUALIFIER (if specified) by defining
443 # b4_percent_code_bison_qualifiers(QUALIFIER).
445 # For example, to emit any unqualified %code blocks followed by any %code
446 # blocks for the qualifier foo:
448 # b4_percent_code_get
449 # b4_percent_code_get([[foo]])
450 m4_define([b4_percent_code_get],
451 [m4_pushdef([b4_macro_name], [[b4_percent_code(]$1[)]])dnl
452 m4_ifval([$1], [m4_define([b4_percent_code_bison_qualifiers(]$1[)])])dnl
453 m4_ifdef(b4_macro_name,
454 [b4_comment([m4_if([$#], [0], [[Unqualified %code]],
455 [[%code "]$1["]])[ blocks.]])
456 b4_user_code([m4_indir(b4_macro_name)])
458 m4_popdef([b4_macro_name])])
460 # b4_percent_code_ifdef(QUALIFIER, IF-TRUE, [IF-FALSE])
461 # -----------------------------------------------------
462 # If any %code blocks for QUALIFIER (or unqualified %code blocks if
463 # QUALIFIER is empty) are defined, expand IF-TRUE, else expand IF-FALSE.
464 # Also, record Bison's usage of QUALIFIER (if specified) by defining
465 # b4_percent_code_bison_qualifiers(QUALIFIER).
466 m4_define([b4_percent_code_ifdef],
467 [m4_ifdef([b4_percent_code(]$1[)],
468 [m4_ifval([$1], [m4_define([b4_percent_code_bison_qualifiers(]$1[)])])$2],
472 ## ----------------------------------------------------------- ##
473 ## After processing the skeletons, check that all the user's ##
474 ## %define variables and %code qualifiers were used by Bison. ##
475 ## ----------------------------------------------------------- ##
477 m4_define([b4_check_user_names_wrap],
478 [m4_ifdef([b4_percent_]$1[_user_]$2[s],
479 [b4_check_user_names([[%]$1 $2],
480 [b4_percent_]$1[_user_]$2[s],
481 [[b4_percent_]$1[_bison_]$2[s]])])])
484 b4_check_user_names_wrap([[define]], [[variable]])
485 b4_check_user_names_wrap([[code]], [[qualifier]])