-*- Autoconf -*- # Language-independent M4 Macros for Bison. # Copyright (C) 2002, 2004, 2005, 2006, 2007 Free Software Foundation, Inc. # This program is free software; you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation; either version 2 of the License, or # (at your option) any later version. # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # You should have received a copy of the GNU General Public License # along with this program; if not, write to the Free Software # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA # 02110-1301 USA ## ---------------- ## ## Identification. ## ## ---------------- ## # b4_copyright(TITLE, YEARS) # -------------------------- m4_define([b4_copyright], [b4_comment([A Bison parser, made by GNU Bison b4_version.]) b4_comment([$1 m4_text_wrap([Copyright (C) $2 Free Software Foundation, Inc.], [ ]) This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.]) b4_comment([As a special exception, you may create a larger work that contains part or all of the Bison parser skeleton and distribute that work under terms of your choice, so long as that work isn't itself a parser generator using the skeleton or a modified version thereof as a parser skeleton. Alternatively, if you modify or redistribute the parser skeleton itself, you may (at your option) remove this special exception, which will cause the skeleton and the resulting Bison output files to be licensed under the GNU General Public License without this special exception. This special exception was added by the Free Software Foundation in version 2.2 of Bison.])]) ## ---------------- ## ## Error handling. ## ## ---------------- ## # b4_error(KIND, FORMAT, [ARG1], [ARG2], ...) # ------------------------------------------- # Write @KIND(FORMAT@,ARG1@,ARG2@,...@) to diversion 0. m4_define([b4_error], [m4_divert_push(0)[@]$1[(]$2[]m4_if([$#], [2], [], [m4_foreach([b4_arg], m4_dquote(m4_shift(m4_shift($@))), [[@,]b4_arg])])[@)]m4_divert_pop(0)]) # b4_error_at(KIND, START, END, FORMAT, [ARG1], [ARG2], ...) # ---------------------------------------------------------- # Write @KIND(START@,END@,FORMAT@,ARG1@,ARG2@,...@) to diversion 0. m4_define([b4_error_at], [m4_divert_push(0)[@]$1[_at(]$2[@,]$3[@,]$4[]m4_if([$#], [4], [], [m4_foreach([b4_arg], m4_dquote(m4_shift(m4_shift(m4_shift(m4_shift($@))))), [[@,]b4_arg])])[@)]m4_divert_pop(0)]) # b4_warn(FORMAT, [ARG1], [ARG2], ...) # ------------------------------------ # Write @warn(FORMAT@,ARG1@,ARG2@,...@) to diversion 0. # # As a simple test suite, this: # # m4_define([asdf], [ASDF]) # m4_define([fsa], [FSA]) # m4_define([fdsa], [FDSA]) # b4_warn([[[asdf), asdf]]], [[[fsa), fsa]]], [[[fdsa), fdsa]]]) # m4_divert(0) # b4_warn([[asdf), asdf]], [[fsa), fsa]], [[fdsa), fdsa]]) # m4_divert(0) # b4_warn([asdf), asdf], [fsa), fsa], [fdsa), fdsa]) # m4_divert(0) # b4_warn() # m4_divert(0) # b4_warn(1) # m4_divert(0) # b4_warn(1, 2) # # Should produce this: # # @warn([asdf), asdf]@,[fsa), fsa]@,[fdsa), fdsa]@) # @warn(asdf), asdf@,fsa), fsa@,fdsa), fdsa@) # @warn(ASDF), ASDF@,FSA), FSA@,FDSA), FDSA@) # @warn(@) # @warn(1@) # @warn(1@,2@) m4_define([b4_warn], [b4_error([[warn]], $@)]) # b4_warn_at(START, END, FORMAT, [ARG1], [ARG2], ...) # --------------------------------------------------- # Write @warn(START@,END@,FORMAT@,ARG1@,ARG2@,...@) to diversion 0. m4_define([b4_warn_at], [b4_error_at([[warn]], $@)]) # b4_complain(FORMAT, [ARG1], [ARG2], ...) # ---------------------------------------- # Write @complain(FORMAT@,ARG1@,ARG2@,...@) to diversion 0. # # See the test suite for b4_warn above. m4_define([b4_complain], [b4_error([[complain]], $@)]) # b4_complain_at(START, END, FORMAT, [ARG1], [ARG2], ...) # ------------------------------------------------------- # Write @complain(START@,END@,FORMAT@,ARG1@,ARG2@,...@) to diversion 0. m4_define([b4_complain_at], [b4_error_at([[complain]], $@)]) # b4_fatal(FORMAT, [ARG1], [ARG2], ...) # ------------------------------------- # Write @fatal(FORMAT@,ARG1@,ARG2@,...@) to diversion 0. # # See the test suite for b4_warn above. m4_define([b4_fatal], [b4_error([[fatal]], $@)]) # b4_fatal_at(START, END, FORMAT, [ARG1], [ARG2], ...) # ---------------------------------------------------- # Write @fatal(START@,END@,FORMAT@,ARG1@,ARG2@,...@) to diversion 0. m4_define([b4_fatal_at], [b4_error_at([[fatal]], $@)]) ## ---------------- ## ## Default values. ## ## ---------------- ## # m4_define_default([b4_lex_param], []) dnl breaks other skeletons m4_define_default([b4_epilogue], []) m4_define_default([b4_parse_param], []) # The initial column and line. m4_define_default([b4_location_initial_column], [1]) m4_define_default([b4_location_initial_line], [1]) ## ------------ ## ## Data Types. ## ## ------------ ## # b4_ints_in(INT1, INT2, LOW, HIGH) # --------------------------------- # Return 1 iff both INT1 and INT2 are in [LOW, HIGH], 0 otherwise. m4_define([b4_ints_in], [m4_eval([$3 <= $1 && $1 <= $4 && $3 <= $2 && $2 <= $4])]) ## ------------------ ## ## Decoding options. ## ## ------------------ ## # b4_flag_if(FLAG, IF-TRUE, IF-FALSE) # ----------------------------------- # Run IF-TRUE if b4_FLAG_flag is 1, IF-FALSE if FLAG is 0, otherwise fail. m4_define([b4_flag_if], [m4_case(b4_$1_flag, [0], [$3], [1], [$2], [m4_fatal([invalid $1 value: ]$1)])]) # b4_define_flag_if(FLAG) # ----------------------- # Define "b4_FLAG_if(IF-TRUE, IF-FALSE)" that depends on the # value of the Boolean FLAG. m4_define([b4_define_flag_if], [_b4_define_flag_if($[1], $[2], [$1])]) # _b4_define_flag_if($1, $2, FLAG) # -------------------------------- # This macro works around the impossibility to define macros # inside macros, because issuing `[$1]' is not possible in M4 :(. # This sucks hard, GNU M4 should really provide M5 like $$1. m4_define([_b4_define_flag_if], [m4_if([$1$2], $[1]$[2], [], [m4_fatal([$0: Invalid arguments: $@])])dnl m4_define([b4_$3_if], [b4_flag_if([$3], [$1], [$2])])]) # b4_FLAG_if(IF-TRUE, IF-FALSE) # ----------------------------- # Expand IF-TRUE, if FLAG is true, IF-FALSE otherwise. b4_define_flag_if([defines]) # Whether headers are requested. b4_define_flag_if([error_verbose]) # Whether error are verbose. b4_define_flag_if([glr]) # Whether a GLR parser is requested. b4_define_flag_if([locations]) # Whether locations are tracked. b4_define_flag_if([nondeterministic]) # Whether conflicts should be handled. b4_define_flag_if([pull]) # Whether pull parsing is requested. b4_define_flag_if([pure]) # Whether the interface is pure. b4_define_flag_if([push]) # Whether push parsing is requested. b4_define_flag_if([use_push_for_pull]) # Whether push parsing should be used # in place of pull parsing (where # available) for the sake of the test # suite. b4_define_flag_if([yacc]) # Whether POSIX Yacc is emulated. ## ------------------------- ## ## Assigning token numbers. ## ## ------------------------- ## ## ----------- ## ## Synclines. ## ## ----------- ## # b4_basename(NAME) # ----------------- # Similar to POSIX basename; the differences don't matter here. # Beware that NAME is not evaluated. m4_define([b4_basename], [m4_bpatsubst([$1], [^.*/\([^/]+\)/*$], [\1])]) # b4_syncline(LINE, FILE) # ----------------------- m4_define([b4_syncline], [b4_flag_if([synclines], [ b4_sync_end([__line__], [b4_basename(m4_quote(__file__))]) b4_sync_start([$1], [$2])])]) m4_define([b4_sync_end], [b4_comment([Line $1 of $2])]) m4_define([b4_sync_start], [b4_comment([Line $1 of $2])]) # b4_user_code(USER-CODE) # ----------------------- # Emit code from the user, ending it with synclines. m4_define([b4_user_code], [$1 b4_syncline([@oline@], [@ofile@])]) # b4_define_user_code(MACRO) # -------------------------- # From b4_MACRO, build b4_user_MACRO that includes the synclines. m4_define([b4_define_user_code], [m4_define([b4_user_$1], [b4_user_code([b4_$1])])]) # b4_user_actions # b4_user_initial_action # b4_user_post_prologue # b4_user_pre_prologue # b4_user_stype # ---------------------- # Macros that issue user code, ending with synclines. b4_define_user_code([actions]) b4_define_user_code([initial_action]) b4_define_user_code([post_prologue]) b4_define_user_code([pre_prologue]) b4_define_user_code([stype]) # b4_check_for_unrecognized_names(WHAT, LIST, [VALID_NAME], [VALID_NAME]) # ----------------------------------------------------------------------- # Complain if any name of type WHAT is used in the grammar (as recorded in # LIST) but is not a VALID_NAME. # # LIST must expand to a list specifying all grammar occurrences of all names of # type WHAT. Each item in the list is a triplet specifying one occurrence: # name, start boundary, and end boundary. Empty string names are fine. An # empty list is fine. # # For example, to define b4_foo_list to be used for LIST with three name # occurrences and with correct quoting: # # m4_define([b4_foo_list], # [[[[[[bar]], [[parser.y:1.7]], [[parser.y:1.16]]]], # [[[[bar]], [[parser.y:5.7]], [[parser.y:5.16]]]], # [[[[baz]], [[parser.y:8.7]], [[parser.y:8.16]]]]]]) # # Each VALID_NAME must expand to a valid name of type WHAT. Multiple # occurrences of the same valid name are fine. A VALID_NAME that expands to # the empty string will correctly define the empty string as a valid name, but # it would be ugly for a Bison skeleton to actually use that. # # For example, to invoke b4_check_for_unrecognized_names with TYPE foo, with # LIST b4_foo_list, with two valid names, and with correct quoting: # # b4_check_for_unrecognized_names([[foo]], [b4_foo_list], # [[bar]], [[baz]]) # # Names and valid names must not contain the character `,'. m4_define([b4_check_for_unrecognized_names], [m4_foreach([b4_occurrence], $2, [m4_pushdef([b4_occurrence], b4_occurrence) m4_pushdef([b4_name], m4_car(b4_occurrence)) m4_pushdef([b4_start], m4_car(m4_shift(b4_occurrence))) m4_pushdef([b4_end], m4_shift(m4_shift(b4_occurrence))) m4_if(m4_index(m4_if($#, 2, [], [[,]m4_quote(m4_shift(m4_shift($*)))[,]]), [,]b4_name[,]), [-1], [b4_complain_at([b4_start], [b4_end], [[`%s' is not a recognized %s]], [b4_name], [$1]) ]) m4_popdef([b4_occurrence]) m4_popdef([b4_name]) m4_popdef([b4_start]) m4_popdef([b4_end]) ]) ]) # b4_check_percent_define_variables([VAILD_VARIABLE], [VALID_VARIABLE], ...) # -------------------------------------------------------------------------- # Wrapper around b4_check_for_unrecognized_names for %define variables. # # b4_used_percent_define_variables must contain a list of all %define variables # used in the grammar similar to b4_foo_list from the # b4_check_for_unrecognized_names documentation's example. If # b4_used_percent_define_variables is undefined, it's treated the same as an # empty list. # # Invoking b4_check_percent_define_variables with empty parens specifies one # valid variable that is an empty string. Invoke it without parens to specify # that there are no valid variables. m4_define([b4_check_percent_define_variables], [m4_ifdef([b4_used_percent_define_variables], [b4_check_for_unrecognized_names([[%define variable]], [b4_used_percent_define_variables]m4_if([$#], [0], [], [, $@]))])]) # b4_check_percent_code_qualifiers([VAILD_QUALIFIER], [VALID_QUALIFIER], ...) # --------------------------------------------------------------------------- # Same as b4_check_percent_define_variables but for %code qualifiers using # b4_used_percent_code_qualifiers. m4_define([b4_check_percent_code_qualifiers], [m4_ifdef([b4_used_percent_code_qualifiers], [b4_check_for_unrecognized_names([[%code qualifier]], [b4_used_percent_code_qualifiers]m4_if([$#], [0], [], [, $@]))])])