* data/bison.m4: Update comments for rename to muscle-tab.h.

[bison.git] / data / bison.m4

diff --git a/data/bison.m4 b/data/bison.m4
index 2b4e504645262b9eeb69a5927f2aa328cee6b08a..f7c84633676e2a1302bd55f44a22cfadd396004d 100644 (file)
--- a/data/bison.m4
+++ b/data/bison.m4
@@ -255,9 +255,9 @@ m4_define([b4_integral_parser_tables_map],
 STATE-NUM.]])
 
 $1([defact], [b4_defact],
 STATE-NUM.]])
 
 $1([defact], [b4_defact],

-   [[YYDEFACT[S] -- default rule to reduce with in state S when YYTABLE
-does not specify something else to do.  Zero means the default is an
-error.]])
+   [[YYDEFACT[S] -- default reduction number in state S.  Performed when
+YYTABLE does not specify something else to do.  Zero means the default
+is an error.]])

 
 $1([pgoto], [b4_pgoto], [[YYPGOTO[NTERM-NUM].]])
 
 
 $1([pgoto], [b4_pgoto], [[YYPGOTO[NTERM-NUM].]])
 


@@ -266,8 +266,7 @@ $1([defgoto], [b4_defgoto], [[YYDEFGOTO[NTERM-NUM].]])
 $1([table], [b4_table],
    [[YYTABLE[YYPACT[STATE-NUM]].  What to do in state STATE-NUM.  If
 positive, shift that token.  If negative, reduce the rule which
 $1([table], [b4_table],
    [[YYTABLE[YYPACT[STATE-NUM]].  What to do in state STATE-NUM.  If
 positive, shift that token.  If negative, reduce the rule which

-number is the opposite.  If zero, do what YYDEFACT says.
-If YYTABLE_NINF, syntax error.]])
+number is the opposite.  If YYTABLE_NINF, syntax error.]])

 
 $1([check], [b4_check])
 
 
 $1([check], [b4_check])
 


@@ -355,7 +354,7 @@ m4_define([b4_symbol_],
 # undefined.  If FIELD = id, prepend the prefix.
 m4_define([b4_symbol],
 [m4_case([$2],
 # undefined.  If FIELD = id, prepend the prefix.
 m4_define([b4_symbol],
 [m4_case([$2],

-         [id],    [m4_do([b4_percent_define_get([token.prefix])],
+         [id],    [m4_do([b4_percent_define_get([api.tokens.prefix])],

                          [b4_symbol_([$1], [id])])],
          [b4_symbol_($@)])])
 
                          [b4_symbol_([$1], [id])])],
          [b4_symbol_($@)])])
 


@@ -501,13 +500,13 @@ b4_define_user_code([stype])
 
 
 # b4_check_user_names(WHAT, USER-LIST, BISON-NAMESPACE)
 
 
 # b4_check_user_names(WHAT, USER-LIST, BISON-NAMESPACE)

-# --------------------------------------------------------
-# Warn if any name of type WHAT is used by the user (as recorded in USER-LIST)
-# but is not used by Bison (as recorded by macros in the namespace
-# BISON-NAMESPACE).
+# -----------------------------------------------------
+# Complain if any name of type WHAT is used by the user (as recorded in
+# USER-LIST) but is not used by Bison (as recorded by macros in the
+# namespace BISON-NAMESPACE).

 #
 #

-# USER-LIST must expand to a list specifying all grammar occurrences of all
-# names of type WHAT.   Each item in the list must be a triplet specifying one
+# USER-LIST must expand to a list specifying all user occurrences of all names
+# of type WHAT.   Each item in the list must be a triplet specifying one

 # occurrence: name, start boundary, and end boundary.  Empty string names are
 # fine.  An empty list is fine.
 #
 # occurrence: name, start boundary, and end boundary.  Empty string names are
 # fine.  An empty list is fine.
 #


@@ -542,18 +541,32 @@ m4_pushdef([b4_user_name], m4_car(b4_occurrence))dnl
 m4_pushdef([b4_start], m4_car(m4_shift(b4_occurrence)))dnl
 m4_pushdef([b4_end], m4_shift(m4_shift(b4_occurrence)))dnl
 m4_ifndef($3[(]m4_quote(b4_user_name)[)],
 m4_pushdef([b4_start], m4_car(m4_shift(b4_occurrence)))dnl
 m4_pushdef([b4_end], m4_shift(m4_shift(b4_occurrence)))dnl
 m4_ifndef($3[(]m4_quote(b4_user_name)[)],

-          [b4_warn_at([b4_start], [b4_end],
-                      [[%s `%s' is not used]],
-                      [$1], [b4_user_name])])[]dnl
+          [b4_complain_at([b4_start], [b4_end],
+                          [[%s `%s' is not used]],
+                          [$1], [b4_user_name])])[]dnl

 m4_popdef([b4_occurrence])dnl
 m4_popdef([b4_user_name])dnl
 m4_popdef([b4_start])dnl
 m4_popdef([b4_end])dnl
 ])])
 
 m4_popdef([b4_occurrence])dnl
 m4_popdef([b4_user_name])dnl
 m4_popdef([b4_start])dnl
 m4_popdef([b4_end])dnl
 ])])
 

+
+
+## --------------------- ##
+## b4_percent_define_*.  ##
+## --------------------- ##
+
+
+# b4_percent_define_use(VARIABLE)
+# -------------------------------
+# Declare that VARIABLE was used.
+m4_define([b4_percent_define_use],
+[m4_define([b4_percent_define_bison_variables(]$1[)])dnl
+])
+

 # b4_percent_define_get(VARIABLE)
 # -------------------------------
 # b4_percent_define_get(VARIABLE)
 # -------------------------------

-# Mimic muscle_percent_define_get in ../src/muscle_tab.h exactly.  That is, if
+# Mimic muscle_percent_define_get in ../src/muscle-tab.h exactly.  That is, if

 # the %define variable VARIABLE is defined, emit its value.  Also, record
 # Bison's usage of VARIABLE by defining
 # b4_percent_define_bison_variables(VARIABLE).
 # the %define variable VARIABLE is defined, emit its value.  Also, record
 # Bison's usage of VARIABLE by defining
 # b4_percent_define_bison_variables(VARIABLE).


@@ -562,12 +575,12 @@ m4_popdef([b4_end])dnl
 #
 #   b4_percent_define_get([[foo]])
 m4_define([b4_percent_define_get],
 #
 #   b4_percent_define_get([[foo]])
 m4_define([b4_percent_define_get],

-[m4_define([b4_percent_define_bison_variables(]$1[)])dnl
+[b4_percent_define_use([$1])dnl

 m4_ifdef([b4_percent_define(]$1[)], [m4_indir([b4_percent_define(]$1[)])])])
 
 # b4_percent_define_get_loc(VARIABLE)
 # -----------------------------------
 m4_ifdef([b4_percent_define(]$1[)], [m4_indir([b4_percent_define(]$1[)])])])
 
 # b4_percent_define_get_loc(VARIABLE)
 # -----------------------------------

-# Mimic muscle_percent_define_get_loc in ../src/muscle_tab.h exactly.  That is,
+# Mimic muscle_percent_define_get_loc in ../src/muscle-tab.h exactly.  That is,

 # if the %define variable VARIABLE is undefined, complain fatally since that's
 # a Bison or skeleton error.  Otherwise, return its definition location in a
 # form approriate for the first two arguments of b4_warn_at, b4_complain_at, or
 # if the %define variable VARIABLE is undefined, complain fatally since that's
 # a Bison or skeleton error.  Otherwise, return its definition location in a
 # form approriate for the first two arguments of b4_warn_at, b4_complain_at, or


@@ -586,7 +599,7 @@ m4_popdef([b4_loc])],
 
 # b4_percent_define_get_syncline(VARIABLE)
 # ----------------------------------------
 
 # b4_percent_define_get_syncline(VARIABLE)
 # ----------------------------------------

-# Mimic muscle_percent_define_get_syncline in ../src/muscle_tab.h exactly.
+# Mimic muscle_percent_define_get_syncline in ../src/muscle-tab.h exactly.

 # That is, if the %define variable VARIABLE is undefined, complain fatally
 # since that's a Bison or skeleton error.  Otherwise, return its definition
 # location as a b4_syncline invocation.  Don't record this as a Bison usage of
 # That is, if the %define variable VARIABLE is undefined, complain fatally
 # since that's a Bison or skeleton error.  Otherwise, return its definition
 # location as a b4_syncline invocation.  Don't record this as a Bison usage of


@@ -603,7 +616,7 @@ m4_define([b4_percent_define_get_syncline],
 
 # b4_percent_define_ifdef(VARIABLE, IF-TRUE, [IF-FALSE])
 # ------------------------------------------------------
 
 # b4_percent_define_ifdef(VARIABLE, IF-TRUE, [IF-FALSE])
 # ------------------------------------------------------

-# Mimic muscle_percent_define_ifdef in ../src/muscle_tab.h exactly.  That is,
+# Mimic muscle_percent_define_ifdef in ../src/muscle-tab.h exactly.  That is,

 # if the %define variable VARIABLE is defined, expand IF-TRUE, else expand
 # IF-FALSE.  Also, record Bison's usage of VARIABLE by defining
 # b4_percent_define_bison_variables(VARIABLE).
 # if the %define variable VARIABLE is defined, expand IF-TRUE, else expand
 # IF-FALSE.  Also, record Bison's usage of VARIABLE by defining
 # b4_percent_define_bison_variables(VARIABLE).


@@ -613,7 +626,7 @@ m4_define([b4_percent_define_get_syncline],
 #   b4_percent_define_ifdef([[foo]], [[it's defined]], [[it's undefined]])
 m4_define([b4_percent_define_ifdef],
 [m4_ifdef([b4_percent_define(]$1[)],
 #   b4_percent_define_ifdef([[foo]], [[it's defined]], [[it's undefined]])
 m4_define([b4_percent_define_ifdef],
 [m4_ifdef([b4_percent_define(]$1[)],

-         [m4_define([b4_percent_define_bison_variables(]$1[)])$2],
+         [b4_percent_define_use([$1])$2],

          [$3])])
 
 
          [$3])])
 
 


@@ -624,7 +637,7 @@ m4_define([b4_percent_define_ifdef],
 
 # b4_percent_define_flag_if(VARIABLE, IF-TRUE, [IF-FALSE])
 # --------------------------------------------------------
 
 # b4_percent_define_flag_if(VARIABLE, IF-TRUE, [IF-FALSE])
 # --------------------------------------------------------

-# Mimic muscle_percent_define_flag_if in ../src/muscle_tab.h exactly.  That is,
+# Mimic muscle_percent_define_flag_if in ../src/muscle-tab.h exactly.  That is,

 # if the %define variable VARIABLE is defined to "" or "true", expand IF-TRUE.
 # If it is defined to "false", expand IF-FALSE.  Complain if it is undefined
 # (a Bison or skeleton error since the default value should have been set
 # if the %define variable VARIABLE is defined to "" or "true", expand IF-TRUE.
 # If it is defined to "false", expand IF-FALSE.  Complain if it is undefined
 # (a Bison or skeleton error since the default value should have been set


@@ -648,7 +661,7 @@ m4_define([b4_percent_define_flag_if],
 
 # b4_percent_define_default(VARIABLE, DEFAULT)
 # --------------------------------------------
 
 # b4_percent_define_default(VARIABLE, DEFAULT)
 # --------------------------------------------

-# Mimic muscle_percent_define_default in ../src/muscle_tab.h exactly.  That is,
+# Mimic muscle_percent_define_default in ../src/muscle-tab.h exactly.  That is,

 # if the %define variable VARIABLE is undefined, set its value to DEFAULT.
 # Don't record this as a Bison usage of VARIABLE as there's no reason to
 # suspect that the value has yet influenced the output.
 # if the %define variable VARIABLE is undefined, set its value to DEFAULT.
 # Don't record this as a Bison usage of VARIABLE as there's no reason to
 # suspect that the value has yet influenced the output.


@@ -668,33 +681,19 @@ m4_define([b4_percent_define_default],
 # b4_percent_define_if_define(VARIABLE)
 # -------------------------------------
 # Define b4_VARIABLE_if that executes its $1 or $2 depending whether
 # b4_percent_define_if_define(VARIABLE)
 # -------------------------------------
 # Define b4_VARIABLE_if that executes its $1 or $2 depending whether

-# VARIABLE was %defined.  The character `.' in VARIABLE is mapped to `_'.
+# VARIABLE was %defined.  The characters `.' and `-' in VARIABLE are mapped
+# to `_'.

 m4_define([b4_percent_define_if_define_],
 m4_define([b4_percent_define_if_define_],

-[m4_define(m4_bpatsubst([b4_$1_if], [[.]], [_]),
+[m4_define(m4_bpatsubst([b4_$1_if], [[-.]], [_]),

            [b4_percent_define_flag_if([$1], [$2], [$3])])])
 m4_define([b4_percent_define_if_define],
 [b4_percent_define_default([[$1]], [[false]])
 b4_percent_define_if_define_([$1], $[1], $[2])])
 
 
            [b4_percent_define_flag_if([$1], [$2], [$3])])])
 m4_define([b4_percent_define_if_define],
 [b4_percent_define_default([[$1]], [[false]])
 b4_percent_define_if_define_([$1], $[1], $[2])])
 
 

-# b4_parse_assert_if([IF-ASSERTIONS-ARE-USED], [IF-NOT])
-# b4_parse_trace_if([IF-DEBUG-TRACES-ARE-ENABLED], [IF-NOT])
-# b4_error_verbose_if([IF-ERRORS-ARE-VERBOSE], [IF-NOT])
-# b4_lex_symbol_if([IF-YYLEX-RETURNS-A-COMPLETE-SYMBOL], [IF-NOT])
-# b4_variant_if([IF-VARIANT-ARE-USED], [IF-NOT])
-# ----------------------------------------------
-b4_percent_define_if_define([error_verbose])
-b4_percent_define_if_define([lex_symbol])
-b4_percent_define_if_define([locations])     # Whether locations are tracked.
-b4_percent_define_if_define([parse.assert])
-b4_percent_define_if_define([parse.trace])
-b4_percent_define_if_define([variant])
-
-
-

 # b4_percent_define_check_values(VALUES)
 # --------------------------------------
 # b4_percent_define_check_values(VALUES)
 # --------------------------------------

-# Mimic muscle_percent_define_check_values in ../src/muscle_tab.h exactly
+# Mimic muscle_percent_define_check_values in ../src/muscle-tab.h exactly

 # except that the VALUES structure is more appropriate for M4.  That is, VALUES
 # is a list of sublists of strings.  For each sublist, the first string is the
 # name of a %define variable, and all remaining strings in that sublist are the
 # except that the VALUES structure is more appropriate for M4.  That is, VALUES
 # is a list of sublists of strings.  For each sublist, the first string is the
 # name of a %define variable, and all remaining strings in that sublist are the


@@ -723,7 +722,11 @@ m4_define([_b4_percent_define_check_values],
          [b4_complain_at(b4_percent_define_get_loc([$1]),
                          [[invalid value for %%define variable `%s': `%s']],
                          [$1],
          [b4_complain_at(b4_percent_define_get_loc([$1]),
                          [[invalid value for %%define variable `%s': `%s']],
                          [$1],

-                         m4_dquote(m4_indir([b4_percent_define(]$1[)])))])dnl
+                         m4_dquote(m4_indir([b4_percent_define(]$1[)])))
+          m4_foreach([b4_value], m4_dquote(m4_shift($@)),
+                     [b4_complain_at(b4_percent_define_get_loc([$1]),
+                                     [[accepted value: `%s']],
+                                     m4_dquote(b4_value))])])dnl

    m4_popdef([b4_good_value])],
   [b4_fatal([[undefined %%define variable `%s' passed to b4_percent_define_check_values]], [$1])])])
 
    m4_popdef([b4_good_value])],
   [b4_fatal([[undefined %%define variable `%s' passed to b4_percent_define_check_values]], [$1])])])
 


@@ -762,11 +765,39 @@ m4_define([b4_percent_code_ifdef],
          [$3])])
 
 
          [$3])])
 
 

+## ------------------ ##
+## Common variables.  ##
+## ------------------ ##
+

 # Default values for %define.
 # ---------------------------
 # Default values for %define.
 # ---------------------------

-# If the %token.prefix, it is empty.
-m4_percent_define_default([[token.prefix]], [[]])
+# If the api.tokens.prefix, it is empty.
+m4_percent_define_default([[api.tokens.prefix]], [[]])

 
 

+# b4_parse_assert_if([IF-ASSERTIONS-ARE-USED], [IF-NOT])
+# b4_parse_trace_if([IF-DEBUG-TRACES-ARE-ENABLED], [IF-NOT])
+# b4_lex_symbol_if([IF-YYLEX-RETURNS-A-COMPLETE-SYMBOL], [IF-NOT])
+# b4_variant_if([IF-VARIANT-ARE-USED], [IF-NOT])
+# ----------------------------------------------
+b4_percent_define_if_define([lex_symbol])
+b4_percent_define_if_define([locations])     # Whether locations are tracked.
+b4_percent_define_if_define([parse.assert])
+b4_percent_define_if_define([parse.trace])
+b4_percent_define_if_define([variant])
+
+
+# b4_error_verbose_if([IF-ERRORS-ARE-VERBOSE], [IF-NOT])
+# ------------------------------------------------------
+# Map %define parse.error "(simple|verbose)" to b4_error_verbose_if and
+# b4_error_verbose_flag.
+b4_percent_define_default([[parse.error]], [[simple]])
+b4_percent_define_check_values([[[[parse.error]],
+                                 [[simple]], [[verbose]]]])
+m4_define([b4_error_verbose_flag],
+          [m4_case(b4_percent_define_get([[parse.error]]),
+                   [simple],  [[0]],
+                   [verbose], [[1]])])
+b4_define_flag_if([error_verbose])

 
 
 ## ----------------------------------------------------------- ##
 
 
 ## ----------------------------------------------------------- ##