]> git.saurik.com Git - bison.git/blame - src/symtab.h
Remove uses of 'short int' and 'unsigned short int' in the parser generators.
[bison.git] / src / symtab.h
CommitLineData
2cc6b612
PE
1/* Definitions for symtab.c and callers, part of Bison.
2
779e7ceb 3 Copyright (C) 1984, 1989, 1992, 2000, 2001, 2002, 2004
03b31c0c 4 Free Software Foundation, Inc.
f7d4d87a 5
340ef489 6 This file is part of Bison, the GNU Compiler Compiler.
f7d4d87a 7
340ef489
AD
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.
f7d4d87a 12
340ef489
AD
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.
f7d4d87a 17
340ef489
AD
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., 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
f7d4d87a 22
340ef489
AD
23#ifndef SYMTAB_H_
24# define SYMTAB_H_
f7d4d87a 25
a945ec39 26# include "assoc.h"
7486e51b
PE
27# include "location.h"
28# include "uniqstr.h"
8efe435c 29
2f1afb73
AD
30/*----------.
31| Symbols. |
32`----------*/
f7d4d87a 33
bba97eb2 34/* Symbol classes. */
d7020c20
AD
35typedef enum
36{
37 unknown_sym,
38 token_sym, /* terminal symbol */
39 nterm_sym /* non-terminal */
40} symbol_class;
340ef489 41
b87f8b21 42
007a50a4 43/* Internal token numbers. */
f6fbd3da
PE
44typedef int symbol_number;
45#define SYMBOL_NUMBER_MAXIMUM INT_MAX
5fbb0954 46
5fbb0954 47
7486e51b 48typedef struct symbol symbol;
df09ef2e
AD
49
50/* When extending this structure, be sure to complete
51 symbol_check_alias_consistency. */
7486e51b 52struct symbol
340ef489 53{
1e0bab92 54 /* The key, name of the symbol. */
7486e51b
PE
55 uniqstr tag;
56 /* The location of its first occurrence. */
57 location location;
1e0bab92 58
366eea36 59 /* Its %type and associated printer and destructor. */
7486e51b 60 uniqstr type_name;
df09ef2e
AD
61 location type_location;
62
9280d3ef 63 char *destructor;
7486e51b 64 location destructor_location;
df09ef2e 65
366eea36 66 char *printer;
7486e51b 67 location printer_location;
ee000ba4 68
7486e51b 69 symbol_number number;
df09ef2e 70 location prec_location;
f6fbd3da 71 int prec;
7486e51b 72 assoc assoc;
62a3e4f0 73 int user_token_number;
3f96f4dc 74
b87f8b21
AD
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
1e9798d5 77 identifier-symbol pair for an alias. */
7486e51b 78 symbol *alias;
d7020c20 79 symbol_class class;
db8837cb
AD
80};
81
b87f8b21
AD
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. */
2cc6b612 92#define NUMBER_UNDEFINED (-1)
b87f8b21 93
f7d4d87a 94
2f1afb73 95/* Fetch (or create) the symbol associated to KEY. */
7486e51b 96symbol *symbol_get (const char *key, location loc);
39f41916
AD
97
98/* Generate a dummy nonterminal, whose name cannot conflict with the
99 user's names. */
7486e51b 100symbol *dummy_symbol_get (location loc);
2f1afb73 101
7486e51b
PE
102/* Declare the new symbol SYM. Make it an alias of SYMVAL. */
103void symbol_make_alias (symbol *sym, symbol *symval, location loc);
2f1afb73 104
7486e51b 105/* Set the TYPE_NAME associated with SYM. Do nothing if passed 0 as
e9955c83 106 TYPE_NAME. */
7486e51b 107void symbol_type_set (symbol *sym, uniqstr type_name, location loc);
3ae2b51f 108
7486e51b
PE
109/* Set the DESTRUCTOR associated with SYM. */
110void symbol_destructor_set (symbol *sym, char *destructor, location loc);
9280d3ef 111
7486e51b
PE
112/* Set the PRINTER associated with SYM. */
113void symbol_printer_set (symbol *sym, char *printer, location loc);
366eea36 114
7486e51b
PE
115/* Set the PRECEDENCE associated with SYM. Ensure that SYMBOL is a
116 terminal. Do nothing if invoked with UNDEF_ASSOC as ASSOC. */
117void symbol_precedence_set (symbol *sym, int prec, assoc a, location loc);
3ae2b51f 118
7486e51b
PE
119/* Set the CLASS associated with SYM. */
120void symbol_class_set (symbol *sym, symbol_class class, location loc);
44536b35 121
7486e51b
PE
122/* Set the USER_TOKEN_NUMBER associated with SYM. */
123void symbol_user_token_number_set (symbol *sym, int user_number, location loc);
44536b35
AD
124
125
2f1afb73
AD
126/* Distinguished symbols. AXIOM is the real start symbol, that used
127 by the automaton. STARTSYMBOL is the one specified by the user.
128 */
7486e51b
PE
129extern symbol *errtoken;
130extern symbol *undeftoken;
131extern symbol *endtoken;
132extern symbol *accept;
133extern symbol *startsymbol;
134extern location startsymbol_location;
f7d4d87a 135
340ef489 136
2f1afb73
AD
137/*---------------.
138| Symbol table. |
139`---------------*/
140
141
142/* Create the symbol table. */
d33cb3ae 143void symbols_new (void);
2f1afb73 144
2f1afb73 145/* Free all the memory allocated for symbols. */
d33cb3ae 146void symbols_free (void);
340ef489 147
e9955c83
AD
148/* Check that all the symbols are defined. Report any undefined
149 symbols and consider them nonterminals. */
d33cb3ae 150void symbols_check_defined (void);
2f1afb73
AD
151
152/* Perform various sanity checks, assign symbol numbers, and set up
153 TOKEN_TRANSLATIONS. */
d33cb3ae 154void symbols_pack (void);
2f1afb73 155
340ef489 156#endif /* !SYMTAB_H_ */