src/muscle-tab.h

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