src/symtab.h

   1 /* Definitions for symtab.c and callers, part of Bison.
   2
   3    Copyright (C) 1984, 1989, 1992, 2000, 2001, 2002, 2004, 2005
   4    Free Software Foundation, Inc.
   5
   6    This file is part of Bison, the GNU Compiler Compiler.
   7
   8    Bison is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 2, or (at your option)
  11    any later version.
  12
  13    Bison is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with Bison; see the file COPYING.  If not, write to
  20    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  21    Boston, MA 02110-1301, USA.  */
  22
  23 #ifndef SYMTAB_H_
  24 # define SYMTAB_H_
  25
  26 # include "assoc.h"
  27 # include "location.h"
  28 # include "uniqstr.h"
  29
  30 /*----------.
  31 | Symbols.  |
  32 `----------*/
  33
  34 /* Symbol classes.  */
  35 typedef enum
  36 {
  37   unknown_sym,
  38   token_sym,            /* terminal symbol */
  39   nterm_sym             /* non-terminal */
  40 } symbol_class;
  41
  42
  43 /* Internal token numbers. */
  44 typedef int symbol_number;
  45 #define SYMBOL_NUMBER_MAXIMUM INT_MAX
  46
  47
  48 typedef struct symbol symbol;
  49
  50 /* When extending this structure, be sure to complete
  51    symbol_check_alias_consistency.  */
  52 struct symbol
  53 {
  54   /* The key, name of the symbol.  */
  55   uniqstr tag;
  56   /* The location of its first occurrence.  */
  57   location location;
  58
  59   /* Its %type and associated printer and destructor.  */
  60   uniqstr type_name;
  61   location type_location;
  62
  63   char *destructor;
  64   location destructor_location;
  65
  66   char *printer;
  67   location printer_location;
  68
  69   symbol_number number;
  70   location prec_location;
  71   int prec;
  72   assoc assoc;
  73   int user_token_number;
  74
  75   /* Points to the other in the identifier-symbol pair for an alias.
  76      Special value USER_NUMBER_ALIAS in the identifier half of the
  77      identifier-symbol pair for an alias.  */
  78   symbol *alias;
  79   symbol_class class;
  80 };
  81
  82 /* Undefined user number.  */
  83 #define USER_NUMBER_UNDEFINED -1
  84
  85 /* `symbol->user_token_number == USER_NUMBER_ALIAS' means this symbol
  86    *has* (not is) a string literal alias.  For instance, `%token foo
  87    "foo"' has `"foo"' numbered regularly, and `foo' numbered as
  88    USER_NUMBER_ALIAS.  */
  89 #define USER_NUMBER_ALIAS -9991
  90
  91 /* Undefined internal token number.  */
  92 #define NUMBER_UNDEFINED (-1)
  93
  94 /* Print a symbol (for debugging). */
  95 void symbol_print (FILE *f, symbol *s);
  96
  97 /* Fetch (or create) the symbol associated to KEY.  */
  98 symbol *symbol_get (const char *key, location loc);
  99
 100 /* Generate a dummy nonterminal, whose name cannot conflict with the
 101    user's names.  */
 102 symbol *dummy_symbol_get (location loc);
 103
 104 /* Declare the new symbol SYM.  Make it an alias of SYMVAL.  */
 105 void symbol_make_alias (symbol *sym, symbol *symval, location loc);
 106
 107 /* Set the TYPE_NAME associated with SYM.  Do nothing if passed 0 as
 108    TYPE_NAME.  */
 109 void symbol_type_set (symbol *sym, uniqstr type_name, location loc);
 110
 111 /* Set the DESTRUCTOR associated with SYM.  */
 112 void symbol_destructor_set (symbol *sym, char *destructor, location loc);
 113
 114 /* Set the PRINTER associated with SYM.  */
 115 void symbol_printer_set (symbol *sym, char *printer, location loc);
 116
 117 /* Set the PRECEDENCE associated with SYM.  Ensure that SYMBOL is a
 118    terminal.  Do nothing if invoked with UNDEF_ASSOC as ASSOC.  */
 119 void symbol_precedence_set (symbol *sym, int prec, assoc a, location loc);
 120
 121 /* Set the CLASS associated with SYM.  */
 122 void symbol_class_set (symbol *sym, symbol_class class, location loc);
 123
 124 /* Set the USER_TOKEN_NUMBER associated with SYM.  */
 125 void symbol_user_token_number_set (symbol *sym, int user_number, location loc);
 126
 127
 128 /* Distinguished symbols.  AXIOM is the real start symbol, that used
 129    by the automaton.  STARTSYMBOL is the one specified by the user.
 130    */
 131 extern symbol *errtoken;
 132 extern symbol *undeftoken;
 133 extern symbol *endtoken;
 134 extern symbol *accept;
 135 extern symbol *startsymbol;
 136 extern location startsymbol_location;
 137
 138
 139 /*---------------.
 140 | Symbol table.  |
 141 `---------------*/
 142
 143
 144 /* Create the symbol table.  */
 145 void symbols_new (void);
 146
 147 /* Free all the memory allocated for symbols.  */
 148 void symbols_free (void);
 149
 150 /* Check that all the symbols are defined.  Report any undefined
 151    symbols and consider them nonterminals.  */
 152 void symbols_check_defined (void);
 153
 154 /* Perform various sanity checks, assign symbol numbers, and set up
 155    TOKEN_TRANSLATIONS.  */
 156 void symbols_pack (void);
 157
 158 #endif /* !SYMTAB_H_ */