src/muscle-tab.h

   1 /* Muscle table manager for Bison,
   2
   3    Copyright (C) 2001-2003, 2006-2013 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 /* Create the MUSCLE_TABLE, and initialize it with default values.
  28    Also set up the MUSCLE_OBSTACK.  */
  29 void muscle_init (void);
  30
  31 /* Insert (KEY, VALUE).  If KEY already existed, overwrite the
  32    previous value.  */
  33 void muscle_insert (char const *key, char const *value);
  34
  35 /* Find the value of muscle KEY.  Unlike MUSCLE_FIND, this is always
  36    reliable to determine whether KEY has a value.  */
  37 char const *muscle_find_const (char const *key);
  38
  39 /* Find the value of muscle KEY.  Abort if muscle_insert was invoked
  40    more recently than muscle_grow for KEY since muscle_find can't
  41    return a char const *.  */
  42 char *muscle_find (char const *key);
  43
  44 /* Free all the memory consumed by the muscle machinery only.  */
  45 void muscle_free (void);
  46
  47
  48 /* An obstack dedicated to receive muscle keys and values.  */
  49 extern struct obstack muscle_obstack;
  50
  51 # define MUSCLE_INSERT_BOOL(Key, Value)         \
  52   do {                                          \
  53     int v__ = Value;                            \
  54     MUSCLE_INSERT_INT (Key, v__);               \
  55   } while (0)
  56
  57 # define MUSCLE_INSERTF(Key, Format, Value)                     \
  58   do {                                                          \
  59     obstack_printf (&muscle_obstack, Format, Value);            \
  60     muscle_insert (Key, obstack_finish0 (&muscle_obstack));     \
  61   } while (0)
  62
  63 # define MUSCLE_INSERT_INT(Key, Value)          \
  64   MUSCLE_INSERTF(Key, "%d", Value)
  65
  66 # define MUSCLE_INSERT_LONG_INT(Key, Value)     \
  67   MUSCLE_INSERTF(Key, "%ld", Value)
  68
  69 /* Key -> Value, but don't apply escaping to Value. */
  70 # define MUSCLE_INSERT_STRING_RAW(Key, Value)   \
  71   MUSCLE_INSERTF(Key, "%s", Value)
  72
  73 /* Key -> Value, applying M4 escaping to Value. */
  74 # define MUSCLE_INSERT_STRING(Key, Value)                       \
  75   do {                                                          \
  76     obstack_escape (&muscle_obstack, Value);                    \
  77     muscle_insert (Key, obstack_finish0 (&muscle_obstack));     \
  78   } while (0)
  79
  80 /* Key -> Value, applying C escaping to Value (and then M4). */
  81 # define MUSCLE_INSERT_C_STRING(Key, Value)                     \
  82   MUSCLE_INSERT_STRING(Key, quotearg_style (c_quoting_style, Value))
  83
  84
  85 /* Append VALUE to the current value of KEY.  If KEY did not already
  86    exist, create it.  Use MUSCLE_OBSTACK.  De-allocate the previously
  87    associated value.  Copy VALUE and SEPARATOR.  */
  88 void muscle_grow (const char *key, const char *value, const char *separator);
  89
  90
  91 /* Append VALUE to the current value of KEY, using muscle_grow.  But
  92    in addition, issue a synchronization line for the location LOC.  */
  93 void muscle_code_grow (const char *key, const char *value, location loc);
  94
  95
  96 /* MUSCLE is an M4 list of pairs.  Create or extend it with the pair
  97    (A1, A2) after escaping both values with digraphs.  Note that because the
  98    muscle values are output *double* quoted, one needs to strip the first level
  99    of quotes to reach the list itself.  */
 100 void muscle_pair_list_grow (const char *muscle,
 101                             const char *a1, const char *a2);
 102
 103 /* Grow KEY for the occurrence of the name USER_NAME at LOC appropriately for
 104    use with b4_check_user_names in ../data/bison.m4.  USER_NAME is not escaped
 105    with digraphs, so it must not contain '[' or ']'.  */
 106 void muscle_user_name_list_grow (char const *key, char const *user_name,
 107                                  location loc);
 108
 109 /* Indicates whether a variable's value was specified with -D/--define, with
 110    -F/--force-define, or in the grammar file.  */
 111 typedef enum {
 112   MUSCLE_PERCENT_DEFINE_D = 0,
 113   MUSCLE_PERCENT_DEFINE_F,
 114   MUSCLE_PERCENT_DEFINE_GRAMMAR_FILE
 115 } muscle_percent_define_how;
 116
 117 /* Define the muscles for %define variable VARIABLE with VALUE specified
 118    at VARIABLE_LOC in the manner HOW unless it was specified in the
 119    grammar file while the previous definition for VARIABLE was specified
 120    with -F/--force-define.  Complain if a previous definition is being
 121    overridden and the new definition is specified in the grammar file.
 122    (These rules support the documented behavior as long as command-line
 123    definitions are processed before grammar file definitions.)  Record
 124    this as a user occurrence of VARIABLE by invoking
 125    muscle_user_name_list_grow.  */
 126 void muscle_percent_define_insert (char const *variable, location variable_loc,
 127                                    char const *value,
 128                                    muscle_percent_define_how how);
 129
 130 /* Make sure that VARIABLE is set to the boolean VALUE.  Warn on mismatches
 131    only, but accept repeated declaration.  Used for backward compatibility
 132    between old directives such as %pure-parser, and the recommended use of
 133    variables (%define api.pure).   */
 134 void muscle_percent_define_ensure (char const *variable, location variable_loc,
 135                                    bool value);
 136
 137 /* Mimic b4_percent_define_get in ../data/bison.m4 exactly.  That is, if the
 138    %define variable VARIABLE is defined, return its value.  Otherwise, return
 139    the empty string.  Also, record Bison's usage of VARIABLE by defining
 140    b4_percent_define_bison_variables(VARIABLE).  The caller is responsible for
 141    freeing the memory of the returned string.  */
 142 char *muscle_percent_define_get (char const *variable);
 143
 144 /* Mimic muscle_percent_define_get_loc in ../data/bison.m4 exactly.  That is,
 145    if the %define variable VARIABLE is undefined, complain fatally since that's
 146    a Bison error.  Otherwise, return its definition location in a form
 147    approriate for the first argument of warn_at, complain_at, or fatal_at.
 148    Don't record this as a Bison usage of VARIABLE as there's no reason to
 149    suspect that the user-supplied value has yet influenced the output.  */
 150 location muscle_percent_define_get_loc (char const *variable);
 151
 152 /* Mimic muscle_percent_define_get_syncline in ../data/bison.m4 exactly.  That
 153    is, if the %define variable VARIABLE is undefined, complain fatally since
 154    that's a Bison error.  Otherwise, return its definition location as a
 155    b4_syncline invocation.  Don't record this as a Bison usage of VARIABLE as
 156    there's no reason to suspect that the user-supplied value has yet influenced
 157    the output.  */
 158 char const *muscle_percent_define_get_syncline (char const *variable);
 159
 160 /* Mimic b4_percent_define_ifdef in ../data/bison.m4 exactly.  That is, if the
 161    %define variable VARIABLE is defined, return true.  Otherwise, return false.
 162    Also, record Bison's usage of VARIABLE by defining
 163    b4_percent_define_bison_variables(VARIABLE).  */
 164 bool muscle_percent_define_ifdef (char const *variable);
 165
 166 /* Mimic b4_percent_define_flag_if in ../data/bison.m4 exactly.  That is, if
 167    the %define variable VARIABLE is defined to "" or "true", return true.  If
 168    it is defined to "false", return false.  Complain if it is undefined (a
 169    Bison error since the default value should have been set already) or defined
 170    to any other value (possibly a user error).  Also, record Bison's usage of
 171    VARIABLE by defining b4_percent_define_bison_variables(VARIABLE).  */
 172 bool muscle_percent_define_flag_if (char const *variable);
 173
 174 /* Mimic b4_percent_define_default in ../data/bison.m4 exactly.  That is, if
 175    the %define variable VARIABLE is undefined, set its value to VALUE.
 176    Don't record this as a Bison usage of VARIABLE as there's no reason to
 177    suspect that the value has yet influenced the output.  */
 178 void muscle_percent_define_default (char const *variable, char const *value);
 179
 180 /* Mimic b4_percent_define_check_values in ../data/bison.m4 exactly except that
 181    the VALUES structure is more appropriate for C.  That is, VALUES points to a
 182    list of strings that is partitioned into sublists by NULL's, one terminating
 183    each sublist.  The last sublist is followed by a second NULL.  For each
 184    sublist, the first string is the name of a %define variable, and all
 185    remaining strings in that sublist are the valid values for that variable.
 186    Complain if such a variable is undefined (a Bison error since the default
 187    value should have been set already) or defined to any other value (possibly
 188    a user error).  Don't record this as a Bison usage of the variable as
 189    there's no reason to suspect that the value has yet influenced the
 190    output.  */
 191 void muscle_percent_define_check_values (char const * const *values);
 192
 193 /* Grow the muscle for the %code qualifier QUALIFIER appearing at
 194    QUALIFIER_LOC with code CODE appearing at CODE_LOC.  Record this as a
 195    user occurrence of QUALIFIER by invoking
 196    muscle_user_name_list_grow.  */
 197 void muscle_percent_code_grow (char const *qualifier, location qualifier_loc,
 198                                char const *code, location code_loc);
 199
 200 /* Output the definition of all the current muscles into a list of
 201    m4_defines.  */
 202 void muscles_m4_output (FILE *out);
 203
 204 #endif /* not MUSCLE_TAB_H_ */