Fix incorrect comment.

[bison.git] / src / symtab.h

diff --git a/src/symtab.h b/src/symtab.h
index 2f53c8b8a12d70a0f48e3bb3b527421baacaa94e..0f87c224fcb03144cf0bafda7aa6583482a5e730 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, 2001, 2002
+/* Definitions for symtab.c and callers, part of Bison.
+
+   Copyright (C) 1984, 1989, 1992, 2000, 2001, 2002, 2004, 2005

    Free Software Foundation, Inc.
 
    This file is part of Bison, the GNU Compiler Compiler.
    Free Software Foundation, Inc.
 
    This file is part of Bison, the GNU Compiler Compiler.


@@ -16,28 +17,20 @@
 
    You should have received a copy of the GNU General Public License
    along with Bison; see the file COPYING.  If not, write to
 
    You should have received a copy of the GNU General Public License
    along with Bison; see the file COPYING.  If not, write to

-   the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-   Boston, MA 02111-1307, USA.  */
+   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+   Boston, MA 02110-1301, USA.  */

 
 #ifndef SYMTAB_H_
 # define SYMTAB_H_
 
 
 #ifndef SYMTAB_H_
 # define SYMTAB_H_
 

+# include "assoc.h"

 # include "location.h"
 # include "location.h"

+# include "uniqstr.h"

 
 /*----------.
 | Symbols.  |
 `----------*/
 
 
 /*----------.
 | Symbols.  |
 `----------*/
 

-/* Associativity values for tokens and rules.  */
-typedef enum
-{
-  undef_assoc,
-  right_assoc,
-  left_assoc,
-  non_assoc
-} associativity;
-
-

 /* Symbol classes.  */
 typedef enum
 {
 /* Symbol classes.  */
 typedef enum
 {


@@ -48,29 +41,43 @@ typedef enum
 
 
 /* Internal token numbers. */
 
 
 /* Internal token numbers. */

-typedef short symbol_number_t;
-
+typedef int symbol_number;
+#define SYMBOL_NUMBER_MAXIMUM INT_MAX

 
 

-typedef struct symbol_s symbol_t;
-struct symbol_s
-{
-  /* The key, name of the symbol. */
-  char *tag;
-  /* Its type. */
-  char *type_name;

 
 

-  /* The location of its first occurence. */
-  location_t location;
+typedef struct symbol symbol;

 
 

-  symbol_number_t number;
-  short prec;
-  associativity assoc;
+/* When extending this structure, be sure to complete
+   symbol_check_alias_consistency.  */
+struct symbol
+{
+  /* 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;
+  location type_location;
+
+  /* Does not own the memory. */
+  const char *destructor;
+  location destructor_location;
+
+  /* Does not own the memory. */
+  const char *printer;
+  location printer_location;
+
+  symbol_number number;
+  location prec_location;
+  int prec;
+  assoc assoc;

   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.  */
   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.  */

-  symbol_t *alias;
+  symbol *alias;

   symbol_class class;
 };
 
   symbol_class class;
 };
 


@@ -84,40 +91,51 @@ struct symbol_s
 #define USER_NUMBER_ALIAS -9991
 
 /* Undefined internal token number.  */
 #define USER_NUMBER_ALIAS -9991
 
 /* Undefined internal token number.  */

-#define NUMBER_UNDEFINED ((symbol_number_t) -1)
+#define NUMBER_UNDEFINED (-1)

 
 

+/* Print a symbol (for debugging). */
+void symbol_print (symbol *s, FILE *f);

 
 /* Fetch (or create) the symbol associated to KEY.  */
 
 /* Fetch (or create) the symbol associated to KEY.  */

-symbol_t *getsym PARAMS ((const char *key, location_t location));
+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.  Make it an alias of SYMVAL.  */
-void symbol_make_alias PARAMS ((symbol_t *symbol, symbol_t *symval));
+/* 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 to SYMBOL. Does nothing if passed 0 as
+/* Set the TYPE_NAME associated with SYM.  Do nothing if passed 0 as

    TYPE_NAME.  */
    TYPE_NAME.  */

-void symbol_type_set PARAMS ((symbol_t *symbol, char *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, const char *destructor, location loc);

 
 

-/* 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,
-                                   int prec, associativity assoc));
+/* Set the PRINTER associated with SYM.  */
+void symbol_printer_set (symbol *sym, const char *printer, location loc);

 
 

-/* Set the CLASS associated to SYMBOL.  */
-void symbol_class_set PARAMS ((symbol_t *symbol, symbol_class class));
+/* 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 USER_TOKEN_NUMBER associated to SYMBOL.  */
-void symbol_user_token_number_set PARAMS ((symbol_t *symbol, int user_number));
+/* 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.
    */
 
 
 /* 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;
+extern symbol *errtoken;
+extern symbol *undeftoken;
+extern symbol *endtoken;
+extern symbol *accept;
+extern symbol *startsymbol;
+extern location startsymbol_location;

 
 
 /*---------------.
 
 
 /*---------------.


@@ -126,24 +144,17 @@ extern location_t startsymbol_location;
 
 
 /* Create the 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));
+void symbols_new (void);

 
 /* Free all the memory allocated for symbols.  */
 
 /* Free all the memory allocated for symbols.  */

-void symbols_free PARAMS ((void));
+void symbols_free (void);

 
 /* Check that all the symbols are defined.  Report any undefined
    symbols and consider them nonterminals.  */
 
 /* Check that all the symbols are defined.  Report any undefined
    symbols and consider them nonterminals.  */

-void symbols_check_defined PARAMS ((void));
+void symbols_check_defined (void);

 
 /* Perform various sanity checks, assign symbol numbers, and set up
    TOKEN_TRANSLATIONS.  */
 
 /* Perform various sanity checks, assign symbol numbers, and set up
    TOKEN_TRANSLATIONS.  */

-void symbols_pack PARAMS ((void));
+void symbols_pack (void);

 
 #endif /* !SYMTAB_H_ */
 
 #endif /* !SYMTAB_H_ */