Comment wording fix.

[bison.git] / src / symtab.h

diff --git a/src/symtab.h b/src/symtab.h
index 5b03e567f7f79347e2c23d18123eaf023d5a18cf..3cf2f588fdf21a3da63fa56cc56d245a9f604d6e 100644 (file)
--- a/src/symtab.h
+++ b/src/symtab.h
@@ -1,4 +1,5 @@
-/* Definitions for symtab.c and callers, part of bison,
+/* Definitions for symtab.c and callers, part of Bison.
+
    Copyright (C) 1984, 1989, 1992, 2000, 2001, 2002
    Free Software Foundation, Inc.
 
@@ -22,16 +23,13 @@
 #ifndef SYMTAB_H_
 # define SYMTAB_H_
 
-#define        TABSIZE 1009
-
-/* Associativity values for tokens and rules.  */
-typedef enum
-{
-  right_assoc,
-  left_assoc,
-  non_assoc
-} associativity;
+# include "assoc.h"
+# include "location.h"
+# include "uniqstr.h"
 
+/*----------.
+| Symbols.  |
+`----------*/
 
 /* Symbol classes.  */
 typedef enum
@@ -41,37 +39,111 @@ typedef enum
   nterm_sym            /* non-terminal */
 } symbol_class;
 
-#define SUNDEF  -1              /* For undefined user number. */
-#define SALIAS -9991           /* for symbol generated with an alias */
 
-typedef struct bucket
+/* Internal token numbers. */
+typedef short symbol_number;
+#define SYMBOL_NUMBER_MAXIMUM SHRT_MAX
+
+
+typedef struct symbol symbol;
+struct symbol
 {
-  /* Needed for the hash table. */
-  struct bucket *link;
-  struct bucket *next;
-
-  /* The key, name of the symbol. */
-  char *tag;
-  /* Its type. */
-  char *type_name;
-  short number;
+  /* The key, name of the symbol.  */
+  uniqstr tag;
+  /* The location of its first occurrence.  */
+  location location;
+
+  /* Its %type and associated printer and destructor.  */
+  uniqstr type_name;
+  char *destructor;
+  location destructor_location;
+  char *printer;
+  location printer_location;
+
+  symbol_number number;
   short prec;
-  associativity assoc;
-  short user_token_number;
+  assoc assoc;
+  int user_token_number;
 
-  /* Points to the other in the identifier-symbol pair for an
-     alias. Special value SALIAS in the identifier half of the
+  /* Points to the other in the identifier-symbol pair for an alias.
+     Special value USER_NUMBER_ALIAS in the identifier half of the
      identifier-symbol pair for an alias.  */
-  struct bucket *alias;
+  symbol *alias;
   symbol_class class;
-} bucket;
+};
+
+/* Undefined user number.  */
+#define USER_NUMBER_UNDEFINED -1
+
+/* `symbol->user_token_number == USER_NUMBER_ALIAS' means this symbol
+   *has* (not is) a string literal alias.  For instance, `%token foo
+   "foo"' has `"foo"' numbered regularly, and `foo' numbered as
+   USER_NUMBER_ALIAS.  */
+#define USER_NUMBER_ALIAS -9991
+
+/* Undefined internal token number.  */
+#define NUMBER_UNDEFINED (-1)
+
+
+/* Fetch (or create) the symbol associated to KEY.  */
+symbol *symbol_get (const char *key, location loc);
+
+/* Generate a dummy nonterminal, whose name cannot conflict with the
+   user's names.  */
+symbol *dummy_symbol_get (location loc);
+
+/* Declare the new symbol SYM.  Make it an alias of SYMVAL.  */
+void symbol_make_alias (symbol *sym, symbol *symval, location loc);
+
+/* Set the TYPE_NAME associated with SYM.  Do nothing if passed 0 as
+   TYPE_NAME.  */
+void symbol_type_set (symbol *sym, uniqstr type_name, location loc);
+
+/* Set the DESTRUCTOR associated with SYM.  */
+void symbol_destructor_set (symbol *sym, char *destructor, location loc);
+
+/* Set the PRINTER associated with SYM.  */
+void symbol_printer_set (symbol *sym, char *printer, location loc);
+
+/* Set the PRECEDENCE associated with SYM.  Ensure that SYMBOL is a
+   terminal.  Do nothing if invoked with UNDEF_ASSOC as ASSOC.  */
+void symbol_precedence_set (symbol *sym, int prec, assoc a, location loc);
+
+/* Set the CLASS associated with SYM.  */
+void symbol_class_set (symbol *sym, symbol_class class, location loc);
+
+/* Set the USER_TOKEN_NUMBER associated with SYM.  */
+void symbol_user_token_number_set (symbol *sym, int user_number, location loc);
+
+
+/* Distinguished symbols.  AXIOM is the real start symbol, that used
+   by the automaton.  STARTSYMBOL is the one specified by the user.
+   */
+extern symbol *errtoken;
+extern symbol *undeftoken;
+extern symbol *endtoken;
+extern symbol *accept;
+extern symbol *startsymbol;
+extern location startsymbol_location;
+
+
+/*---------------.
+| Symbol table.  |
+`---------------*/
+
 
+/* Create the symbol table.  */
+void symbols_new (void);
 
-extern bucket *firstsymbol;
+/* Free all the memory allocated for symbols.  */
+void symbols_free (void);
 
-bucket *getsym PARAMS ((const char *));
+/* Check that all the symbols are defined.  Report any undefined
+   symbols and consider them nonterminals.  */
+void symbols_check_defined (void);
 
-void tabinit PARAMS ((void));
-void free_symtab PARAMS ((void));
+/* Perform various sanity checks, assign symbol numbers, and set up
+   TOKEN_TRANSLATIONS.  */
+void symbols_pack (void);
 
 #endif /* !SYMTAB_H_ */