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