src/muscle_tab.h

   1 /* Muscle table manager for Bison,
   2    Copyright (C) 2001, 2002, 2003, 2006, 2007, 2008 Free Software Foundation, Inc.
   3
   4    This file is part of Bison, the GNU Compiler Compiler.
   5
   6    This program is free software: you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation, either version 3 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  18
  19 #ifndef MUSCLE_TAB_H_
  20 # define MUSCLE_TAB_H_
  21
  22 # include "location.h"
  23
  24 void muscle_init (void);
  25 void muscle_insert (char const *key, char const *value);
  26 char const *muscle_find_const (char const *key);
  27 char *muscle_find (char const *key);
  28 void muscle_free (void);
  29
  30
  31 /* An obstack dedicated to receive muscle keys and values.  */
  32 extern struct obstack muscle_obstack;
  33
  34 #define MUSCLE_INSERT_BOOL(Key, Value)                          \
  35 do {                                                            \
  36   int v = Value;                                                \
  37   MUSCLE_INSERT_INT (Key, v);                                   \
  38 } while(0)
  39
  40 #define MUSCLE_INSERT_INT(Key, Value)                           \
  41 do {                                                            \
  42   obstack_fgrow1 (&muscle_obstack, "%d", Value);                \
  43   obstack_1grow (&muscle_obstack, 0);                           \
  44   muscle_insert (Key, obstack_finish (&muscle_obstack));        \
  45 } while(0)
  46
  47 #define MUSCLE_INSERT_LONG_INT(Key, Value)                      \
  48 do {                                                            \
  49   obstack_fgrow1 (&muscle_obstack, "%ld", Value);               \
  50   obstack_1grow (&muscle_obstack, 0);                           \
  51   muscle_insert (Key, obstack_finish (&muscle_obstack));        \
  52 } while(0)
  53
  54 /* Key -> Value, but don't apply escaping to Value. */
  55 #define MUSCLE_INSERT_STRING_RAW(Key, Value)                    \
  56 do {                                                            \
  57   obstack_sgrow (&muscle_obstack, Value);                       \
  58   obstack_1grow (&muscle_obstack, 0);                           \
  59   muscle_insert (Key, obstack_finish (&muscle_obstack));        \
  60 } while(0)
  61
  62 /* Key -> Value, applying M4 escaping to Value. */
  63 #define MUSCLE_INSERT_STRING(Key, Value)                        \
  64 do {                                                            \
  65   MUSCLE_OBSTACK_SGROW (&muscle_obstack, Value);                \
  66   obstack_1grow (&muscle_obstack, 0);                           \
  67   muscle_insert (Key, obstack_finish (&muscle_obstack));        \
  68 } while(0)
  69
  70 #define MUSCLE_OBSTACK_SGROW(Obstack, Value)                    \
  71 do {                                                            \
  72   char const *p;                                                \
  73   for (p = Value; *p; p++)                                      \
  74     switch (*p)                                                 \
  75       {                                                         \
  76       case '$': obstack_sgrow (Obstack, "$]["); break;          \
  77       case '@': obstack_sgrow (Obstack, "@@" ); break;          \
  78       case '[': obstack_sgrow (Obstack, "@{" ); break;          \
  79       case ']': obstack_sgrow (Obstack, "@}" ); break;          \
  80       default: obstack_1grow (Obstack, *p); break;              \
  81       }                                                         \
  82 } while(0)
  83
  84 #define MUSCLE_INSERT_C_STRING(Key, Value)                      \
  85 do {                                                            \
  86   MUSCLE_OBSTACK_SGROW (&muscle_obstack,                        \
  87                         quotearg_style (c_quoting_style,        \
  88                                         Value));                \
  89   obstack_1grow (&muscle_obstack, 0);                           \
  90   muscle_insert (Key, obstack_finish (&muscle_obstack));        \
  91 } while(0)
  92
  93 /* Append VALUE to the current value of KEY.  If KEY did not already
  94    exist, create it.  Use MUSCLE_OBSTACK.  De-allocate the previously
  95    associated value.  Copy VALUE and SEPARATOR.  */
  96
  97 void muscle_grow (const char *key, const char *value, const char *separator);
  98
  99
 100 /* Append VALUE to the current value of KEY, using muscle_grow.  But
 101    in addition, issue a synchronization line for the location LOC.  */
 102
 103 void muscle_code_grow (const char *key, const char *value, location loc);
 104
 105
 106 /* MUSCLE is an M4 list of pairs.  Create or extend it with the pair
 107    (A1, A2) after escaping both values with digraphs.  Note that because the
 108    muscle values are output *double* quoted, one needs to strip the first level
 109    of quotes to reach the list itself.  */
 110 void muscle_pair_list_grow (const char *muscle,
 111                             const char *a1, const char *a2);
 112
 113 /* In the format `[[file_name:line.column]], [[file_name:line.column]]', append
 114    LOC to MUSCLE.  Use digraphs for special characters in each file name.  */
 115 void muscle_location_grow (char const *key, location loc);
 116
 117 /* In the format `file_name:line.column', append BOUND to MUSCLE.  Use digraphs
 118    for special characters in the file name.  */
 119 void muscle_boundary_grow (char const *key, boundary bound);
 120
 121 /* Grow KEY for the occurrence of the name USER_NAME at LOC appropriately for
 122    use with b4_check_user_names in ../data/bison.m4.  USER_NAME is not escaped
 123    with digraphs, so it must not contain `[' or `]'.  */
 124 void muscle_user_name_list_grow (char const *key, char const *user_name,
 125                                  location loc);
 126
 127 /* Define the muscle for the %define variable VARIABLE appearing at
 128    VARIABLE_LOC in the grammar file with value VALUE.  Warn if VARIABLE is
 129    already defined.  Record this as a grammar occurrence of VARIABLE by
 130    invoking muscle_user_name_list_grow.  */
 131 void muscle_percent_define_insert (char const *variable, location variable_loc,
 132                                    char const *value);
 133
 134 /* Mimic b4_percent_define_get in ../data/bison.m4 exactly.  That is, if the
 135    %define variable VARIABLE is defined, return its value.  Otherwise, return
 136    the empty string.  Also, record Bison's usage of VARIABLE by defining
 137    b4_percent_define_bison_variables(VARIABLE).  The caller is responsible for
 138    freeing the memory of the returned string.  */
 139 char *muscle_percent_define_get (char const *variable);
 140
 141 /* Mimic muscle_percent_define_get_loc in ../data/bison.m4 exactly.  That is,
 142    if the %define variable VARIABLE is undefined, complain fatally since that's
 143    a Bison error.  Otherwise, return its definition location in a form
 144    approriate for the first argument of warn_at, complain_at, or fatal_at.
 145    Don't record this as a Bison usage of VARIABLE as there's no reason to
 146    suspect that the user-supplied value has yet influenced the output.  */
 147 location muscle_percent_define_get_loc (char const *variable);
 148
 149 /* Mimic muscle_percent_define_get_syncline in ../data/bison.m4 exactly.  That
 150    is, if the %define variable VARIABLE is undefined, complain fatally since
 151    that's a Bison error.  Otherwise, return its definition location as a
 152    b4_syncline invocation.  Don't record this as a Bison usage of VARIABLE as
 153    there's no reason to suspect that the user-supplied value has yet influenced
 154    the output.  */
 155 char const *muscle_percent_define_get_syncline (char const *variable);
 156
 157 /* Mimic b4_percent_define_ifdef in ../data/bison.m4 exactly.  That is, if the
 158    %define variable VARIABLE is defined, return true.  Otherwise, return false.
 159    Also, record Bison's usage of VARIABLE by defining
 160    b4_percent_define_bison_variables(VARIABLE).  */
 161 bool muscle_percent_define_ifdef (char const *variable);
 162
 163 /* Mimic b4_percent_define_flag_if in ../data/bison.m4 exactly.  That is, if
 164    the %define variable VARIABLE is defined to "" or "true", return true.  If
 165    it is defined to "false", return false.  Complain if it is undefined (a
 166    Bison error since the default value should have been set already) or defined
 167    to any other value (possibly a user error).  Also, record Bison's usage of
 168    VARIABLE by defining b4_percent_define_bison_variables(VARIABLE).  */
 169 bool muscle_percent_define_flag_if (char const *variable);
 170
 171 /* Mimic b4_percent_define_default in ../data/bison.m4 exactly.  That is, if
 172    the %define variable VARIABLE is undefined, set its value to VALUE.
 173    Don't record this as a Bison usage of VARIABLE as there's no reason to
 174    suspect that the value has yet influenced the output.  */
 175 void muscle_percent_define_default (char const *variable, char const *value);
 176
 177 /* Mimic b4_percent_define_check_values in ../data/bison.m4 exactly except that
 178    the VALUES structure is more appropriate for C.  That is, VALUES points to a
 179    list of strings that is partitioned into sublists by NULL's, one terminating
 180    each sublist.  The last sublist is followed by a second NULL.  For each
 181    sublist, the first string is the name of a %define variable, and all
 182    remaining strings in that sublist are the valid values for that variable.
 183    Complain if such a variable is undefined (a Bison error since the default
 184    value should have been set already) or defined to any other value (possibly
 185    a user error).  Don't record this as a Bison usage of the variable as
 186    there's no reason to suspect that the value has yet influenced the
 187    output.  */
 188 void muscle_percent_define_check_values (char const * const *values);
 189
 190 /* Grow the muscle for the %code qualifier QUALIFIER appearing at QUALIFIER_LOC
 191    in the grammar file with code CODE appearing at CODE_LOC.  Record this as a
 192    grammar occurrence of VARIABLE by invoking muscle_user_name_list_grow.  */
 193 void muscle_percent_code_grow (char const *qualifier, location qualifier_loc,
 194                                char const *code, location code_loc);
 195
 196 void muscles_m4_output (FILE *out);
 197
 198 #endif /* not MUSCLE_TAB_H_ */