]> git.saurik.com Git - bison.git/blobdiff - src/muscle_tab.h
tests: don't abuse AT_BISON_CHECK.
[bison.git] / src / muscle_tab.h
index e2c8a8ecc55ee695f2acd442136e9d22cdf3ce77..e06126b338b92b49f37319ba6965d43959f17dce 100644 (file)
@@ -1,5 +1,6 @@
 /* Muscle table manager for Bison,
-   Copyright (C) 2001, 2002, 2003, 2006, 2007 Free Software Foundation, Inc.
+   Copyright (C) 2001, 2002, 2003, 2006, 2007, 2009 Free Software
+   Foundation, Inc.
 
    This file is part of Bison, the GNU Compiler Compiler.
 
@@ -122,12 +123,25 @@ void muscle_boundary_grow (char const *key, boundary bound);
 void muscle_user_name_list_grow (char const *key, char const *user_name,
                                  location loc);
 
-/* Define the muscle for the %define variable VARIABLE appearing at
-   VARIABLE_LOC in the grammar file with value VALUE.  Warn if VARIABLE is
-   already defined.  Record this as a grammar occurrence of VARIABLE by
-   invoking muscle_user_name_list_grow.  */
+/* Indicates whether a variable's value was specified with -D/--define, with
+   -F/--force-define, or in the grammar file.  */
+typedef enum {
+  MUSCLE_PERCENT_DEFINE_D = 0, MUSCLE_PERCENT_DEFINE_F,
+  MUSCLE_PERCENT_DEFINE_GRAMMAR_FILE
+} muscle_percent_define_how;
+
+/* Define the muscles for %define variable VARIABLE with VALUE specified
+   at VARIABLE_LOC in the manner HOW unless it was specified in the
+   grammar file while the previous definition for VARIABLE was specified
+   with -F/--force-define.  Complain if a previous definition is being
+   overridden and the new definition is specified in the grammar file.
+   (These rules support the documented behavior as long as command-line
+   definitions are processed before grammar file definitions.)  Record
+   this as a user occurrence of VARIABLE by invoking
+   muscle_user_name_list_grow.  */
 void muscle_percent_define_insert (char const *variable, location variable_loc,
-                                   char const *value);
+                                   char const *value,
+                                   muscle_percent_define_how how);
 
 /* Mimic b4_percent_define_get in ../data/bison.m4 exactly.  That is, if the
    %define variable VARIABLE is defined, return its value.  Otherwise, return
@@ -136,6 +150,22 @@ void muscle_percent_define_insert (char const *variable, location variable_loc,
    freeing the memory of the returned string.  */
 char *muscle_percent_define_get (char const *variable);
 
+/* Mimic muscle_percent_define_get_loc in ../data/bison.m4 exactly.  That is,
+   if the %define variable VARIABLE is undefined, complain fatally since that's
+   a Bison error.  Otherwise, return its definition location in a form
+   approriate for the first argument of warn_at, complain_at, or 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.  */
+location muscle_percent_define_get_loc (char const *variable);
+
+/* Mimic muscle_percent_define_get_syncline in ../data/bison.m4 exactly.  That
+   is, if the %define variable VARIABLE is undefined, complain fatally since
+   that's a Bison 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.  */
+char const *muscle_percent_define_get_syncline (char const *variable);
+
 /* Mimic b4_percent_define_ifdef in ../data/bison.m4 exactly.  That is, if the
    %define variable VARIABLE is defined, return true.  Otherwise, return false.
    Also, record Bison's usage of VARIABLE by defining
@@ -156,20 +186,23 @@ bool muscle_percent_define_flag_if (char const *variable);
    suspect that the value has yet influenced the output.  */
 void muscle_percent_define_default (char const *variable, char const *value);
 
-/* VALUES points to a sequence of strings that is partitioned into
-   subsequences by NULL's, one terminating each subsequence.  The last
-   subsequence is followed by a second NULL.  For each subsequence, the first
-   string is the name of a %define variable, and all remaining strings in that
-   subsequence are the valid values for that variable.  Complain if such a
-   variable is undefined (a Bison error since the default value should have
-   been set already) or defined to any other value (possibly a user error).
-   Don't record this as a Bison usage of the variable as there's no reason to
-   suspect that the value has yet influenced the output.  */
+/* Mimic b4_percent_define_check_values in ../data/bison.m4 exactly except that
+   the VALUES structure is more appropriate for C.  That is, VALUES points to a
+   list of strings that is partitioned into sublists by NULL's, one terminating
+   each sublist.  The last sublist is followed by a second NULL.  For each
+   sublist, the first string is the name of a %define variable, and all
+   remaining strings in that sublist are the valid values for that variable.
+   Complain if such a variable is undefined (a Bison error since the default
+   value should have been set already) or defined to any other value (possibly
+   a user error).  Don't record this as a Bison usage of the variable as
+   there's no reason to suspect that the value has yet influenced the
+   output.  */
 void muscle_percent_define_check_values (char const * const *values);
 
-/* Grow the muscle for the %code qualifier QUALIFIER appearing at QUALIFIER_LOC
-   in the grammar file with code CODE appearing at CODE_LOC.  Record this as a
-   grammar occurrence of VARIABLE by invoking muscle_user_name_list_grow.  */
+/* Grow the muscle for the %code qualifier QUALIFIER appearing at
+   QUALIFIER_LOC with code CODE appearing at CODE_LOC.  Record this as a
+   user occurrence of QUALIFIER by invoking
+   muscle_user_name_list_grow.  */
 void muscle_percent_code_grow (char const *qualifier, location qualifier_loc,
                                char const *code, location code_loc);