]> git.saurik.com Git - bison.git/blobdiff - src/muscle_tab.h
Fix push parsing memory leak reported by Brandon Lucia at
[bison.git] / src / muscle_tab.h
index 35038c780eb7b501547bcfc03806d50dcf8b557d..4aab78c720bee09c369652d71a546338515e5c8c 100644 (file)
@@ -1,5 +1,5 @@
 /* Muscle table manager for Bison,
-   Copyright (C) 2001, 2002 Free Software Foundation, Inc.
+   Copyright (C) 2001, 2002, 2003, 2006, 2007 Free Software Foundation, Inc.
 
    This file is part of Bison, the GNU Compiler Compiler.
 
 
    You should have received a copy of the GNU General Public License
    along with Bison; see the file COPYING.  If not, write to
-   the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-   Boston, MA 02111-1307, USA.  */
+   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+   Boston, MA 02110-1301, USA.  */
 
 #ifndef MUSCLE_TAB_H_
 # define MUSCLE_TAB_H_
 
+# include "location.h"
+
 void muscle_init (void);
-void muscle_insert (const char *key, char *value);
-char *muscle_find (const char *key);
+void muscle_insert (char const *key, char const *value);
+char const *muscle_find_const (char const *key);
+char *muscle_find (char const *key);
 void muscle_free (void);
 
 
 /* An obstack dedicated to receive muscle keys and values.  */
 extern struct obstack muscle_obstack;
 
+#define MUSCLE_INSERT_BOOL(Key, Value)                         \
+do {                                                           \
+  int v = Value;                                               \
+  MUSCLE_INSERT_INT (Key, v);                                  \
+} while(0)
+
 #define MUSCLE_INSERT_INT(Key, Value)                          \
-{                                                              \
-  obstack_fgrow1 (&muscle_obstack, "%d", Value);               \
+do {                                                           \
+  obstack_fgrow1 (&muscle_obstack, "%d", Value);               \
   obstack_1grow (&muscle_obstack, 0);                          \
   muscle_insert (Key, obstack_finish (&muscle_obstack));       \
-}
+} while(0)
 
 #define MUSCLE_INSERT_LONG_INT(Key, Value)                     \
-{                                                              \
-  obstack_fgrow1 (&muscle_obstack, "%ld", Value);              \
+do {                                                           \
+  obstack_fgrow1 (&muscle_obstack, "%ld", Value);              \
   obstack_1grow (&muscle_obstack, 0);                          \
   muscle_insert (Key, obstack_finish (&muscle_obstack));       \
-}
+} while(0)
 
-#define MUSCLE_INSERT_STRING(Key, Value)                       \
-{                                                              \
+#define MUSCLE_INSERT_STRING_RAW(Key, Value)                   \
+do {                                                           \
   obstack_sgrow (&muscle_obstack, Value);                      \
   obstack_1grow (&muscle_obstack, 0);                          \
   muscle_insert (Key, obstack_finish (&muscle_obstack));       \
-}
+} while(0)
+
+#define MUSCLE_INSERT_STRING(Key, Value)                       \
+do {                                                           \
+  MUSCLE_OBSTACK_SGROW (&muscle_obstack, Value);                \
+  obstack_1grow (&muscle_obstack, 0);                          \
+  muscle_insert (Key, obstack_finish (&muscle_obstack));       \
+} while(0)
 
 #define MUSCLE_OBSTACK_SGROW(Obstack, Value)                   \
-{                                                              \
-  char const *s;                                               \
-  for (s = Value; *s; s++)                                     \
-    switch (*s)                                                        \
+do {                                                           \
+  char const *p;                                               \
+  for (p = Value; *p; p++)                                     \
+    switch (*p)                                                        \
       {                                                                \
       case '$':        obstack_sgrow (Obstack, "$]["); break;          \
       case '@':        obstack_sgrow (Obstack, "@@" ); break;          \
       case '[':        obstack_sgrow (Obstack, "@{" ); break;          \
       case ']':        obstack_sgrow (Obstack, "@}" ); break;          \
-      default: obstack_1grow (Obstack, *s); break;             \
+      default: obstack_1grow (Obstack, *p); break;             \
       }                                                                \
-}
+} while(0)
 
 #define MUSCLE_INSERT_C_STRING(Key, Value)                     \
-{                                                              \
+do {                                                           \
   MUSCLE_OBSTACK_SGROW (&muscle_obstack,                       \
                        quotearg_style (c_quoting_style,        \
                                        Value));                \
   obstack_1grow (&muscle_obstack, 0);                          \
   muscle_insert (Key, obstack_finish (&muscle_obstack));       \
-}
+} while(0)
 
-/* Insert (KEY, VALUE).  If KEY already existed, overwrite the
-   previous value.  Uses MUSCLE_OBSTACK.  De-allocates the previously
-   associated value.  VALUE and SEPARATOR are copied.  */
+/* Append VALUE to the current value of KEY.  If KEY did not already
+   exist, create it.  Use MUSCLE_OBSTACK.  De-allocate the previously
+   associated value.  Copy VALUE and SEPARATOR.  */
 
 void muscle_grow (const char *key, const char *value, const char *separator);
 
-/* MUSCLE is an M4 list of pairs.  Create or extend it with the pair
-   (A1, A2).  Note that because the muscle values are output *double*
-   quoted, one needs to strip the first level of quotes to reach the
-   list itself.  */
 
+/* Append VALUE to the current value of KEY, using muscle_grow.  But
+   in addition, issue a synchronization line for the location LOC.  */
+
+void muscle_code_grow (const char *key, const char *value, location loc);
+
+
+/* MUSCLE is an M4 list of pairs.  Create or extend it with the pair
+   (A1, A2) after escaping both values with digraphs.  Note that because the
+   muscle values are output *double* quoted, one needs to strip the first level
+   of quotes to reach the list itself.  */
 void muscle_pair_list_grow (const char *muscle,
                            const char *a1, const char *a2);
 
+/* In the format `[[file_name:line.column]], [[file_name:line.column]]', append
+   LOC to MUSCLE.  Use digraphs for special characters in each file name.  */
+void muscle_location_grow (char const *key, location loc);
+
+/* In the format `file_name:line.column', append BOUND to MUSCLE.  Use digraphs
+   for special characters in the file name.  */
+void muscle_boundary_grow (char const *key, boundary bound);
+
+/* Grow KEY for the occurrence of the name USER_NAME at LOC appropriately for
+   use with b4_check_user_names in ../data/bison.m4.  USER_NAME is not escaped
+   with digraphs, so it must not contain `[' or `]'.  */
+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.  */
+void muscle_percent_define_insert (char const *variable, location variable_loc,
+                                   char const *value);
+
+/* Mimic b4_percent_define_get in ../data/bison.m4 exactly.  That is, if the
+   %define variable VARIABLE is defined, return its value.  Otherwise, return
+   the empty string.  Also, record Bison's usage of VARIABLE by defining
+   b4_percent_define_bison_variables(VARIABLE).  The caller is responsible for
+   freeing the memory of the returned string.  */
+char *muscle_percent_define_get (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
+   b4_percent_define_bison_variables(VARIABLE).  */
+bool muscle_percent_define_ifdef (char const *variable);
+
+/* Mimic b4_percent_define_flag_if in ../data/bison.m4 exactly.  That is, if
+   the %define variable VARIABLE is defined to "" or "true", return true.  If
+   it is defined to "false", return false.  Complain if it is undefined (a
+   Bison error since the default value should have been set already) or defined
+   to any other value (possibly a user error).  Also, record Bison's usage of
+   VARIABLE by defining b4_percent_define_bison_variables(VARIABLE).  */
+bool muscle_percent_define_flag_if (char const *variable);
+
+/* Mimic b4_percent_define_default in ../data/bison.m4 exactly.  That is, if
+   the %define variable VARIABLE is undefined, set its value to VALUE.
+   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.  */
+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.  */
+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.  */
+void muscle_percent_code_grow (char const *qualifier, location qualifier_loc,
+                               char const *code, location code_loc);
+
 void muscles_m4_output (FILE *out);
 
 #endif /* not MUSCLE_TAB_H_ */