doc: clean up references to `Tracking Locations'.

[bison.git] / data / bison.m4

diff --git a/data/bison.m4 b/data/bison.m4
index 5e5039197d297e7b5a633c6a991499c059222098..aa222a4dfddd923259ef1bd4a2b7cb29f3664358 100644 (file)
--- a/data/bison.m4
+++ b/data/bison.m4
@@ -1,7 +1,8 @@
                                                             -*- Autoconf -*-
 
 # Language-independent M4 Macros for Bison.
                                                             -*- Autoconf -*-
 
 # Language-independent M4 Macros for Bison.

-# Copyright (C) 2002, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
+
+# Copyright (C) 2002, 2004-2011 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
 
 # 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


@@ -74,7 +75,8 @@ version 2.2 of Bison.])])
 m4_define([b4_cat],
 [m4_syscmd([cat <<'_m4eof'
 ]m4_bpatsubst(m4_dquote($1), [_m4eof], [_m4@`eof])[@
 m4_define([b4_cat],
 [m4_syscmd([cat <<'_m4eof'
 ]m4_bpatsubst(m4_dquote($1), [_m4eof], [_m4@`eof])[@

-_m4eof])dnl
+_m4eof
+])dnl

 m4_if(m4_sysval, [0], [], [m4_fatal([$0: cannot write to stdout])])])
 
 # b4_error(KIND, FORMAT, [ARG1], [ARG2], ...)
 m4_if(m4_sysval, [0], [], [m4_fatal([$0: cannot write to stdout])])])
 
 # b4_error(KIND, FORMAT, [ARG1], [ARG2], ...)


@@ -249,7 +251,6 @@ 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([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([pure])              # Whether the interface is pure.

 b4_define_flag_if([yacc])              # Whether POSIX Yacc is emulated.
 
 
 b4_define_flag_if([yacc])              # Whether POSIX Yacc is emulated.
 
 


@@ -311,13 +312,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.
 #


@@ -352,19 +353,35 @@ 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_get(VARIABLE)
+
+
+
+## --------------------- ##
+## b4_percent_define_*.  ##
+## --------------------- ##
+
+
+# b4_percent_define_use(VARIABLE)

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

-# 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
+# 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, [DEFAULT])
+# ------------------------------------------
+# Mimic muscle_percent_define_get in ../src/muscle-tab.h.  That is, if
+# the %define variable VARIABLE is defined, emit its value.  Contrary
+# to its C counterpart, return DEFAULT otherwise.  Also, record

 # Bison's usage of VARIABLE by defining
 # b4_percent_define_bison_variables(VARIABLE).
 #
 # Bison's usage of VARIABLE by defining
 # b4_percent_define_bison_variables(VARIABLE).
 #


@@ -372,12 +389,51 @@ 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
-m4_ifdef([b4_percent_define(]$1[)], [m4_indir([b4_percent_define(]$1[)])])])
+[b4_percent_define_use([$1])dnl
+m4_ifdef([b4_percent_define(]$1[)],
+         [m4_indir([b4_percent_define(]$1[)])],
+         [$2])])
+
+
+# b4_percent_define_get_loc(VARIABLE)
+# -----------------------------------
+# 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
+# b4_fatal_at.  Don't record this as a Bison usage of VARIABLE as there's no
+# reason to suspect that the user-supplied value has yet influenced the output.
+#
+# For example:
+#
+#   b4_complain_at(b4_percent_define_get_loc([[foo]]), [[invalid foo]])
+m4_define([b4_percent_define_get_loc],
+[m4_ifdef([b4_percent_define_loc(]$1[)],
+          [m4_pushdef([b4_loc], m4_indir([b4_percent_define_loc(]$1[)]))dnl
+b4_loc[]dnl
+m4_popdef([b4_loc])],
+          [b4_fatal([[undefined %%define variable `%s' passed to b4_percent_define_get_loc]], [$1])])])
+
+# b4_percent_define_get_syncline(VARIABLE)
+# ----------------------------------------
+# 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
+# VARIABLE as there's no reason to suspect that the user-supplied value has yet
+# influenced the output.
+#
+# For example:
+#
+#   b4_percent_define_get_syncline([[foo]])
+m4_define([b4_percent_define_get_syncline],
+[m4_ifdef([b4_percent_define_syncline(]$1[)],
+          [m4_indir([b4_percent_define_syncline(]$1[)])],
+          [b4_fatal([[undefined %%define variable `%s' passed to b4_percent_define_get_syncline]], [$1])])])

 
 # 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).


@@ -392,7 +448,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


@@ -407,18 +463,15 @@ m4_define([b4_percent_define_flag_if],
 [b4_percent_define_ifdef([$1],
   [m4_case(b4_percent_define_get([$1]),
            [], [$2], [true], [$2], [false], [$3],
 [b4_percent_define_ifdef([$1],
   [m4_case(b4_percent_define_get([$1]),
            [], [$2], [true], [$2], [false], [$3],

-           [m4_expand_once([dnl
-             m4_pushdef([b4_loc], m4_indir([b4_percent_define_loc(]$1[)]))dnl
-             b4_complain_at(b4_loc,
-                            [[invalid value for %%define Boolean variable `%s']],
-                            [$1])dnl
-             m4_popdef([b4_loc])],
-             [[b4_percent_define_flag_if($1)]])])],
+           [m4_expand_once([b4_complain_at(b4_percent_define_get_loc([$1]),
+                                           [[invalid value for %%define Boolean variable `%s']],
+                                           [$1])],
+                           [[b4_percent_define_flag_if($1)]])])],

   [b4_fatal([[undefined %%define variable `%s' passed to b4_percent_define_flag_if]], [$1])])])
 
 # b4_percent_define_default(VARIABLE, DEFAULT)
 # --------------------------------------------
   [b4_fatal([[undefined %%define variable `%s' passed to b4_percent_define_flag_if]], [$1])])])
 
 # 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.


@@ -430,11 +483,13 @@ m4_define([b4_percent_define_default],
 [m4_ifndef([b4_percent_define(]$1[)],
            [m4_define([b4_percent_define(]$1[)], [$2])dnl
             m4_define([b4_percent_define_loc(]$1[)],
 [m4_ifndef([b4_percent_define(]$1[)],
            [m4_define([b4_percent_define(]$1[)], [$2])dnl
             m4_define([b4_percent_define_loc(]$1[)],

-                      [[[[[Bison:b4_percent_define_default]:0.0]], [[[Bison:b4_percent_define_default]:0.0]]]])])])
+                      [[[[<skeleton default value>:-1.-1]],
+                        [[<skeleton default value>:-1.-1]]]])dnl
+            m4_define([b4_percent_define_syncline(]$1[)], [[]])])])

 
 # 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


@@ -460,12 +515,14 @@ m4_define([_b4_percent_define_check_values],
                      [m4_if(m4_indir([b4_percent_define(]$1[)]), b4_value,
                             [m4_define([b4_good_value], [1])])])])dnl
    m4_if(b4_good_value, [0],
                      [m4_if(m4_indir([b4_percent_define(]$1[)]), b4_value,
                             [m4_define([b4_good_value], [1])])])])dnl
    m4_if(b4_good_value, [0],

-         [m4_pushdef([b4_loc], m4_indir([b4_percent_define_loc(]$1[)]))dnl
-          b4_complain_at(b4_loc,
+         [b4_complain_at(b4_percent_define_get_loc([$1]),

                          [[invalid value for %%define variable `%s': `%s']],
                          [$1],
                          [[invalid value for %%define variable `%s': `%s']],
                          [$1],

-                         m4_dquote(m4_indir([b4_percent_define(]$1[)])))dnl
-          m4_popdef([b4_loc])])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])])])
 


@@ -487,7 +544,7 @@ m4_define([b4_percent_code_get],
 m4_ifval([$1], [m4_define([b4_percent_code_bison_qualifiers(]$1[)])])dnl
 m4_ifdef(b4_macro_name,
 [b4_comment([m4_if([$#], [0], [[Unqualified %code]],
 m4_ifval([$1], [m4_define([b4_percent_code_bison_qualifiers(]$1[)])])dnl
 m4_ifdef(b4_macro_name,
 [b4_comment([m4_if([$#], [0], [[Unqualified %code]],

-                   [[%code "]$1["]])[ blocks.]])
+                   [["%code ]$1["]])[ blocks.]])

 b4_user_code([m4_indir(b4_macro_name)])
 ])dnl
 m4_popdef([b4_macro_name])])
 b4_user_code([m4_indir(b4_macro_name)])
 ])dnl
 m4_popdef([b4_macro_name])])


@@ -515,7 +572,7 @@ m4_define([b4_check_user_names_wrap],
                                [b4_percent_]$1[_user_]$2[s],
                                [[b4_percent_]$1[_bison_]$2[s]])])])
 
                                [b4_percent_]$1[_user_]$2[s],
                                [[b4_percent_]$1[_bison_]$2[s]])])])
 

-m4_wrap([
+m4_wrap_lifo([

 b4_check_user_names_wrap([[define]], [[variable]])
 b4_check_user_names_wrap([[code]], [[qualifier]])
 ])
 b4_check_user_names_wrap([[define]], [[variable]])
 b4_check_user_names_wrap([[code]], [[qualifier]])
 ])