src/symtab.h

   1 /* Definitions for symtab.c and callers, part of bison,
   2    Copyright (C) 1984, 1989, 1992, 2000, 2001, 2002
   3    Free Software Foundation, Inc.
   4
   5    This file is part of Bison, the GNU Compiler Compiler.
   6
   7    Bison 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 2, or (at your option)
  10    any later version.
  11
  12    Bison 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 Bison; see the file COPYING.  If not, write to
  19    the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20    Boston, MA 02111-1307, USA.  */
  21
  22 #ifndef SYMTAB_H_
  23 # define SYMTAB_H_
  24
  25 # include "location.h"
  26
  27 /*----------.
  28 | Symbols.  |
  29 `----------*/
  30
  31 /* Associativity values for tokens and rules.  */
  32 typedef enum
  33 {
  34   undef_assoc,
  35   right_assoc,
  36   left_assoc,
  37   non_assoc
  38 } associativity;
  39
  40
  41 /* Symbol classes.  */
  42 typedef enum
  43 {
  44   unknown_sym,
  45   token_sym,            /* terminal symbol */
  46   nterm_sym             /* non-terminal */
  47 } symbol_class;
  48
  49
  50 /* Internal token numbers. */
  51 typedef short symbol_number_t;
  52
  53
  54 typedef struct symbol_s symbol_t;
  55 struct symbol_s
  56 {
  57   /* The key, name of the symbol.  */
  58   char *tag;
  59   /* The location of its first occurence.  */
  60   location_t location;
  61
  62   /* Its %type and associated printer and destructor.  */
  63   char *type_name;
  64   char *destructor;
  65   location_t destructor_location;
  66   char *printer;
  67   location_t printer_location;
  68
  69   symbol_number_t number;
  70   short prec;
  71   associativity assoc;
  72   int user_token_number;
  73
  74   /* Points to the other in the identifier-symbol pair for an alias.
  75      Special value USER_NUMBER_ALIAS in the identifier half of the
  76      identifier-symbol pair for an alias.  */
  77   symbol_t *alias;
  78   symbol_class class;
  79 };
  80
  81 /* Undefined user number.  */
  82 #define USER_NUMBER_UNDEFINED -1
  83
  84 /* `symbol->user_token_number == USER_NUMBER_ALIAS' means this symbol
  85    *has* (not is) a string literal alias.  For instance, `%token foo
  86    "foo"' has `"foo"' numbered regularly, and `foo' numbered as
  87    USER_NUMBER_ALIAS.  */
  88 #define USER_NUMBER_ALIAS -9991
  89
  90 /* Undefined internal token number.  */
  91 #define NUMBER_UNDEFINED ((symbol_number_t) -1)
  92
  93
  94 /* Return the tag of this SYMBOL in a printable form.  Warning: uses
  95    the QUOTEARG slot 0.  */
  96 const char *symbol_tag_get PARAMS ((symbol_t *symbol));
  97
  98 /* Return the tag of this SYMBOL in a printable form.  Use the
  99    QUOTEARG slot number N.  */
 100 const char *symbol_tag_get_n PARAMS ((symbol_t *symbol, int n));
 101
 102 /* Print the tag of this SYMBOL.  */
 103 void symbol_tag_print PARAMS ((symbol_t *symbol, FILE *out));
 104
 105 /* Fetch (or create) the symbol associated to KEY.  */
 106 symbol_t *getsym PARAMS ((const char *key, location_t location));
 107
 108 /* Declare the new SYMBOL.  Make it an alias of SYMVAL.  */
 109 void symbol_make_alias PARAMS ((symbol_t *symbol, symbol_t *symval));
 110
 111 /* Set the TYPE_NAME associated to SYMBOL. Does nothing if passed 0 as
 112    TYPE_NAME.  */
 113 void symbol_type_set PARAMS ((symbol_t *symbol,
 114                               char *type_name, location_t location));
 115
 116 /* Set the DESTRUCTOR associated to SYMBOL.  */
 117 void symbol_destructor_set PARAMS ((symbol_t *symbol,
 118                                     char *destructor, location_t location));
 119
 120 /* Set the PRINTER associated to SYMBOL.  */
 121 void symbol_printer_set PARAMS ((symbol_t *symbol,
 122                                  char *printer, location_t location));
 123
 124 /* Set the PRECEDENCE associated to SYMBOL.  Ensures that SYMBOL is a
 125    terminal.  Does nothing if invoked with UNDEF_ASSOC as ASSOC.  */
 126 void symbol_precedence_set PARAMS ((symbol_t *symbol,
 127                                     int prec, associativity assoc,
 128                                     location_t location));
 129
 130 /* Set the CLASS associated to SYMBOL.  */
 131 void symbol_class_set PARAMS ((symbol_t *symbol,
 132                                symbol_class class, location_t location));
 133
 134 /* Set the USER_TOKEN_NUMBER associated to SYMBOL.  */
 135 void symbol_user_token_number_set PARAMS ((symbol_t *symbol,
 136                                            int user_number,
 137                                            location_t location));
 138
 139
 140 /* Distinguished symbols.  AXIOM is the real start symbol, that used
 141    by the automaton.  STARTSYMBOL is the one specified by the user.
 142    */
 143 extern symbol_t *errtoken;
 144 extern symbol_t *undeftoken;
 145 extern symbol_t *eoftoken;
 146 extern symbol_t *axiom;
 147 extern symbol_t *startsymbol;
 148 extern location_t startsymbol_location;
 149
 150
 151 /*---------------.
 152 | Symbol table.  |
 153 `---------------*/
 154
 155
 156 /* Create the symbol table.  */
 157 void symbols_new PARAMS ((void));
 158
 159 /* A function to apply to each symbol. */
 160 typedef bool (*symbol_processor) PARAMS ((symbol_t *));
 161
 162 /* Apply PROCESSOR to all the symbols.  PROCESSOR must return TRUE: on
 163    FALSE, the processing stops.  */
 164 void symbols_do PARAMS ((symbol_processor processor, void *processor_data));
 165
 166 /* Free all the memory allocated for symbols.  */
 167 void symbols_free PARAMS ((void));
 168
 169 /* Check that all the symbols are defined.  Report any undefined
 170    symbols and consider them nonterminals.  */
 171 void symbols_check_defined PARAMS ((void));
 172
 173 /* Perform various sanity checks, assign symbol numbers, and set up
 174    TOKEN_TRANSLATIONS.  */
 175 void symbols_pack PARAMS ((void));
 176
 177 #endif /* !SYMTAB_H_ */