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 #define TABSIZE 1009
  26
  27 /* Associativity values for tokens and rules.  */
  28 typedef enum
  29 {
  30   right_assoc,
  31   left_assoc,
  32   non_assoc
  33 } associativity;
  34
  35
  36 /* Symbol classes.  */
  37 typedef enum
  38 {
  39   unknown_sym,
  40   token_sym,            /* terminal symbol */
  41   nterm_sym             /* non-terminal */
  42 } symbol_class;
  43
  44
  45 /* Internal token numbers. */
  46 typedef short symbol_number_t;
  47
  48
  49 typedef struct symbol_s symbol_t;
  50 struct symbol_s
  51 {
  52   /* The key, name of the symbol. */
  53   char *tag;
  54   /* Its type. */
  55   char *type_name;
  56
  57   symbol_number_t number;
  58   short prec;
  59   associativity assoc;
  60   int user_token_number;
  61
  62   /* Points to the other in the identifier-symbol pair for an alias.
  63      Special value USER_NUMBER_ALIAS in the identifier half of the
  64      identifier-symbol pair for an alias.  */
  65   symbol_t *alias;
  66   symbol_class class;
  67 };
  68
  69 /* Undefined user number.  */
  70 #define USER_NUMBER_UNDEFINED -1
  71
  72 /* `symbol->user_token_number == USER_NUMBER_ALIAS' means this symbol
  73    *has* (not is) a string literal alias.  For instance, `%token foo
  74    "foo"' has `"foo"' numbered regularly, and `foo' numbered as
  75    USER_NUMBER_ALIAS.  */
  76 #define USER_NUMBER_ALIAS -9991
  77
  78 /* Undefined internal token number.  */
  79 #define NUMBER_UNDEFINED ((symbol_number_t) -1)
  80
  81
  82 /* A function to apply to each symbol. */
  83 typedef bool (*symbol_processor) PARAMS ((symbol_t *));
  84
  85 symbol_t *getsym PARAMS ((const char *));
  86
  87 void symbols_new PARAMS ((void));
  88 void symbols_do PARAMS ((symbol_processor processor, void *processor_data));
  89 void symbols_free PARAMS ((void));
  90
  91 #endif /* !SYMTAB_H_ */