src/muscle-tab.h

   1 /* Muscle table manager for Bison,
   2
   3    Copyright (C) 2001-2003, 2006-2012 Free Software Foundation, Inc.
   4
   5    This file is part of Bison, the GNU Compiler Compiler.
   6
   7    This program is free software: you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation, either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef MUSCLE_TAB_H_
  21 # define MUSCLE_TAB_H_
  22
  23 # include <quotearg.h>
  24
  25 # include "location.h"
  26
  27 void muscle_init (void);
  28 void muscle_insert (char const *key, char const *value);
  29 char const *muscle_find_const (char const *key);
  30 char *muscle_find (char const *key);
  31 void muscle_free (void);
  32
  33
  34 /* An obstack dedicated to receive muscle keys and values.  */
  35 extern struct obstack muscle_obstack;
  36
  37 #define MUSCLE_INSERT_BOOL(Key, Value)                          \
  38   do {                                                          \
  39     int v__ = Value;                                            \
  40     MUSCLE_INSERT_INT (Key, v__);                               \
  41   } while (0)
  42
  43 #define MUSCLE_INSERT_INT(Key, Value)                           \
  44   do {                                                          \
  45     obstack_fgrow1 (&muscle_obstack, "%d", Value);              \
  46     obstack_1grow (&muscle_obstack, 0);                         \
  47     muscle_insert (Key, obstack_finish (&muscle_obstack));      \
  48   } while (0)
  49
  50 #define MUSCLE_INSERT_LONG_INT(Key, Value)                      \
  51   do {                                                          \
  52     obstack_fgrow1 (&muscle_obstack, "%ld", Value);             \
  53     obstack_1grow (&muscle_obstack, 0);                         \
  54     muscle_insert (Key, obstack_finish (&muscle_obstack));      \
  55   } while (0)
  56
  57 /* Key -> Value, but don't apply escaping to Value. */
  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 /* Key -> Value, applying M4 escaping to Value. */
  66 #define MUSCLE_INSERT_STRING(Key, Value)                        \
  67   do {                                                          \
  68     obstack_escape (&muscle_obstack, Value);                    \
  69     obstack_1grow (&muscle_obstack, 0);                         \
  70     muscle_insert (Key, obstack_finish (&muscle_obstack));      \
  71   } while (0)
  72
  73 #define MUSCLE_INSERT_C_STRING(Key, Value)                      \
  74   do {                                                          \
  75     obstack_escape (&muscle_obstack,                            \
  76                     quotearg_style (c_quoting_style, Value));   \
  77     obstack_1grow (&muscle_obstack, 0);                         \
  78     muscle_insert (Key, obstack_finish (&muscle_obstack));      \
  79   } while (0)
  80
  81 /* Append VALUE to the current value of KEY.  If KEY did not already
  82    exist, create it.  Use MUSCLE_OBSTACK.  De-allocate the previously
  83    associated value.  Copy VALUE and SEPARATOR.  */
  84
  85 void muscle_grow (const char *key, const char *value, const char *separator);
  86
  87
  88 /* Append VALUE to the current value of KEY, using muscle_grow.  But
  89    in addition, issue a synchronization line for the location LOC.  */
  90
  91 void muscle_code_grow (const char *key, const char *value, location loc);
  92
  93
  94 /* MUSCLE is an M4 list of pairs.  Create or extend it with the pair
  95    (A1, A2) after escaping both values with digraphs.  Note that because the
  96    muscle values are output *double* quoted, one needs to strip the first level
  97    of quotes to reach the list itself.  */
  98 void muscle_pair_list_grow (const char *muscle,
  99                             const char *a1, const char *a2);
 100
 101 /* Grow KEY for the occurrence of the name USER_NAME at LOC appropriately for
 102    use with b4_check_user_names in ../data/bison.m4.  USER_NAME is not escaped
 103    with digraphs, so it must not contain `[' or `]'.  */
 104 void muscle_user_name_list_grow (char const *key, char const *user_name,
 105                                  location loc);
 106
 107 /* Indicates whether a variable's value was specified with -D/--define, with
 108    -F/--force-define, or in the grammar file.  */
 109 typedef enum {
 110   MUSCLE_PERCENT_DEFINE_D = 0, MUSCLE_PERCENT_DEFINE_F,
 111   MUSCLE_PERCENT_DEFINE_GRAMMAR_FILE
 112 } muscle_percent_define_how;
 113
 114 /* Define the muscles for %define variable VARIABLE with VALUE specified
 115    at VARIABLE_LOC in the manner HOW unless it was specified in the
 116    grammar file while the previous definition for VARIABLE was specified
 117    with -F/--force-define.  Complain if a previous definition is being
 118    overridden and the new definition is specified in the grammar file.
 119    (These rules support the documented behavior as long as command-line
 120    definitions are processed before grammar file definitions.)  Record
 121    this as a user occurrence of VARIABLE by invoking
 122    muscle_user_name_list_grow.  */
 123 void muscle_percent_define_insert (char const *variable, location variable_loc,
 124                                    char const *value,
 125                                    muscle_percent_define_how how);
 126
 127 /* Make sure that VARIABLE is set to the boolean VALUE.  Warn on mismatches
 128    only, but accept repeated declaration.  Used for backward compatibility
 129    between old directives such as %pure-parser, and the recommended use of
 130    variables (%define api.pure).   */
 131 void muscle_percent_define_ensure (char const *variable, location variable_loc,
 132                                    bool 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
 191    QUALIFIER_LOC with code CODE appearing at CODE_LOC.  Record this as a
 192    user occurrence of QUALIFIER by invoking
 193    muscle_user_name_list_grow.  */
 194 void muscle_percent_code_grow (char const *qualifier, location qualifier_loc,
 195                                char const *code, location code_loc);
 196
 197 void muscles_m4_output (FILE *out);
 198
 199 #endif /* not MUSCLE_TAB_H_ */