and Akim Demaille <akim@epita.fr>

[bison.git] / src / symtab.h

diff --git a/src/symtab.h b/src/symtab.h
index 8f79abb21fc78459797abd79ccb5e7a0e13fd28b..54ff80fa5db8f07f978338a36d59827be28c9f42 100644 (file)
--- a/src/symtab.h
+++ b/src/symtab.h
@@ -1,5 +1,6 @@
 /* Definitions for symtab.c and callers, part of bison,
-   Copyright (C) 1984, 1989, 1992, 2000 Free Software Foundation, Inc.
+   Copyright (C) 1984, 1989, 1992, 2000, 2001, 2002
+   Free Software Foundation, Inc.
 
    This file is part of Bison, the GNU Compiler Compiler.
 
@@ -20,12 +21,24 @@
 
 #ifndef SYMTAB_H_
 # define SYMTAB_H_
-# include "gram.h"
 
-#define        TABSIZE 1009
+# include "location.h"
 
-/*  symbol classes  */
+/*----------.
+| Symbols.  |
+`----------*/
 
+/* Associativity values for tokens and rules.  */
+typedef enum
+{
+  undef_assoc,
+  right_assoc,
+  left_assoc,
+  non_assoc
+} associativity;
+
+
+/* Symbol classes.  */
 typedef enum
 {
   unknown_sym,
@@ -33,36 +46,122 @@ typedef enum
   nterm_sym            /* non-terminal */
 } symbol_class;
 
-#define SALIAS -9991           /* for symbol generated with an alias */
 
-typedef struct bucket
-{
-  /* Needed for the hash table. */
-  struct bucket *link;
-  struct bucket *next;
+/* Internal token numbers. */
+typedef short symbol_number_t;
+
 
-  /* The key, name of the symbol. */
+typedef struct symbol_s symbol_t;
+struct symbol_s
+{
+  /* The key, name of the symbol.  */
   char *tag;
-  /* Its type. */
+
+  /* Its %type and associated destructor.  */
   char *type_name;
-  short value;
+  char *destructor;
+
+  /* The location of its first occurence.  */
+  location_t location;
+
+  symbol_number_t number;
   short prec;
   associativity assoc;
-  short user_token_number;
-  /* Points to the other in the identifier-symbol pair for an
-     alias. Special value SALIAS in the identifier half of the
+  int user_token_number;
+
+  /* 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_t *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 ((symbol_number_t) -1)
+
+
+/* Return the tag of this SYMBOL in a printable form.  Warning: uses
+   the QUOTEARG slot 0.  */
+const char *symbol_tag_get PARAMS ((symbol_t *symbol));
+
+/* Return the tag of this SYMBOL in a printable form.  Use the
+   QUOTEARG slot number N.  */
+const char *symbol_tag_get_n PARAMS ((symbol_t *symbol, int n));
+
+/* Print the tag of this SYMBOL.  */
+void symbol_tag_print PARAMS ((symbol_t *symbol, FILE *out));
+
+/* Fetch (or create) the symbol associated to KEY.  */
+symbol_t *getsym PARAMS ((const char *key, location_t location));
+
+/* Declare the new SYMBOL.  Make it an alias of SYMVAL.  */
+void symbol_make_alias PARAMS ((symbol_t *symbol, symbol_t *symval));
+
+/* Set the TYPE_NAME associated to SYMBOL. Does nothing if passed 0 as
+   TYPE_NAME.  */
+void symbol_type_set PARAMS ((symbol_t *symbol, location_t location,
+                             char *type_name));
+
+/* Set the DESTRUCTOR associated to SYMBOL.  */
+void symbol_destructor_set PARAMS ((symbol_t *symbol, location_t location,
+                                   char *destructor));
+
+/* Set the PRECEDENCE associated to SYMBOL.  Ensures that SYMBOL is a
+   terminal.  Does nothing if invoked with UNDEF_ASSOC as ASSOC.  */
+void symbol_precedence_set PARAMS ((symbol_t *symbol, location_t location,
+                                   int prec, associativity assoc));
+
+/* Set the CLASS associated to SYMBOL.  */
+void symbol_class_set PARAMS ((symbol_t *symbol, symbol_class class));
+
+/* Set the USER_TOKEN_NUMBER associated to SYMBOL.  */
+void symbol_user_token_number_set PARAMS ((symbol_t *symbol, int user_number));
+
+
+/* Distinguished symbols.  AXIOM is the real start symbol, that used
+   by the automaton.  STARTSYMBOL is the one specified by the user.
+   */
+extern symbol_t *errtoken;
+extern symbol_t *undeftoken;
+extern symbol_t *eoftoken;
+extern symbol_t *axiom;
+extern symbol_t *startsymbol;
+extern location_t startsymbol_location;
+
+
+/*---------------.
+| Symbol table.  |
+`---------------*/
+
+
+/* Create the symbol table.  */
+void symbols_new PARAMS ((void));
+
+/* A function to apply to each symbol. */
+typedef bool (*symbol_processor) PARAMS ((symbol_t *));
 
+/* Apply PROCESSOR to all the symbols.  PROCESSOR must return TRUE: on
+   FALSE, the processing stops.  */
+void symbols_do PARAMS ((symbol_processor processor, void *processor_data));
 
-extern bucket *firstsymbol;
+/* Free all the memory allocated for symbols.  */
+void symbols_free PARAMS ((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 PARAMS ((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 PARAMS ((void));
 
 #endif /* !SYMTAB_H_ */