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
  60   /* Its %type.  */
  61   char *type_name;
  62
  63   /* The location of its first occurence.  */
  64   location_t location;
  65
  66   symbol_number_t number;
  67   short prec;
  68   associativity assoc;
  69   int user_token_number;
  70
  71   /* Points to the other in the identifier-symbol pair for an alias.
  72      Special value USER_NUMBER_ALIAS in the identifier half of the
  73      identifier-symbol pair for an alias.  */
  74   symbol_t *alias;
  75   symbol_class class;
  76 };
  77
  78 /* Undefined user number.  */
  79 #define USER_NUMBER_UNDEFINED -1
  80
  81 /* `symbol->user_token_number == USER_NUMBER_ALIAS' means this symbol
  82    *has* (not is) a string literal alias.  For instance, `%token foo
  83    "foo"' has `"foo"' numbered regularly, and `foo' numbered as
  84    USER_NUMBER_ALIAS.  */
  85 #define USER_NUMBER_ALIAS -9991
  86
  87 /* Undefined internal token number.  */
  88 #define NUMBER_UNDEFINED ((symbol_number_t) -1)
  89
  90
  91 /* Return the tag of this SYMBOL in a printable form.  Warning: uses
  92    the QUOTEARG slot 0.  */
  93 const char *symbol_tag_get PARAMS ((symbol_t *symbol));
  94
  95 /* Return the tag of this SYMBOL in a printable form.  Use the
  96    QUOTEARG slot number N.  */
  97 const char *symbol_tag_get_n PARAMS ((symbol_t *symbol, int n));
  98
  99 /* Print the tag of this SYMBOL.  */
 100 void symbol_tag_print PARAMS ((symbol_t *symbol, FILE *out));
 101
 102 /* Fetch (or create) the symbol associated to KEY.  */
 103 symbol_t *getsym PARAMS ((const char *key, location_t location));
 104
 105 /* Declare the new SYMBOL.  Make it an alias of SYMVAL.  */
 106 void symbol_make_alias PARAMS ((symbol_t *symbol, symbol_t *symval));
 107
 108 /* Set the TYPE_NAME associated to SYMBOL. Does nothing if passed 0 as
 109    TYPE_NAME.  */
 110 void symbol_type_set PARAMS ((symbol_t *symbol, location_t location,
 111                               char *type_name));
 112
 113 /* Set the PRECEDENCE associated to SYMBOL.  Ensures that SYMBOL is a
 114    terminal.  Does nothing if invoked with UNDEF_ASSOC as ASSOC.  */
 115 void symbol_precedence_set PARAMS ((symbol_t *symbol, location_t location,
 116                                     int prec, associativity assoc));
 117
 118 /* Set the CLASS associated to SYMBOL.  */
 119 void symbol_class_set PARAMS ((symbol_t *symbol, symbol_class class));
 120
 121 /* Set the USER_TOKEN_NUMBER associated to SYMBOL.  */
 122 void symbol_user_token_number_set PARAMS ((symbol_t *symbol, int user_number));
 123
 124
 125 /* Distinguished symbols.  AXIOM is the real start symbol, that used
 126    by the automaton.  STARTSYMBOL is the one specified by the user.
 127    */
 128 extern symbol_t *errtoken;
 129 extern symbol_t *undeftoken;
 130 extern symbol_t *eoftoken;
 131 extern symbol_t *axiom;
 132 extern symbol_t *startsymbol;
 133 extern location_t startsymbol_location;
 134
 135
 136 /*---------------.
 137 | Symbol table.  |
 138 `---------------*/
 139
 140
 141 /* Create the symbol table.  */
 142 void symbols_new PARAMS ((void));
 143
 144 /* A function to apply to each symbol. */
 145 typedef bool (*symbol_processor) PARAMS ((symbol_t *));
 146
 147 /* Apply PROCESSOR to all the symbols.  PROCESSOR must return TRUE: on
 148    FALSE, the processing stops.  */
 149 void symbols_do PARAMS ((symbol_processor processor, void *processor_data));
 150
 151 /* Free all the memory allocated for symbols.  */
 152 void symbols_free PARAMS ((void));
 153
 154 /* Check that all the symbols are defined.  Report any undefined
 155    symbols and consider them nonterminals.  */
 156 void symbols_check_defined PARAMS ((void));
 157
 158 /* Perform various sanity checks, assign symbol numbers, and set up
 159    TOKEN_TRANSLATIONS.  */
 160 void symbols_pack PARAMS ((void));
 161
 162 #endif /* !SYMTAB_H_ */