X-Git-Url: https://git.saurik.com/bison.git/blobdiff_plain/e776192e4fcb3b34d8a279d7cc1ea153e96ae2e7..21fe08cadcb84fddd5038ac6857a904dbe1ad885:/src/symtab.h

diff --git a/src/symtab.h b/src/symtab.h
index 19e65e5f..243d3d0c 100644
--- 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, 2006
    Free Software Foundation, Inc.
 
    This file is part of Bison, the GNU Compiler Compiler.
@@ -16,69 +17,96 @@
 
    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.  */
+
+/**
+ * \file symtab.h
+ * \brief Manipulating ::symbol.
+ */
 
 #ifndef SYMTAB_H_
 # define SYMTAB_H_
 
+# include "assoc.h"
 # include "location.h"
+# include "uniqstr.h"
 
 /*----------.
 | Symbols.  |
 `----------*/
 
-/* Associativity values for tokens and rules.  */
+/** Symbol classes.  */
 typedef enum
 {
-  undef_assoc,
-  right_assoc,
-  left_assoc,
-  non_assoc
-} associativity;
+  unknown_sym,          /**< Undefined.  */
+  token_sym,		/**< Terminal. */
+  nterm_sym		/**< Non-terminal. */
+} symbol_class;
 
 
-/* Symbol classes.  */
-typedef enum
+/** Internal token numbers. */
+typedef int symbol_number;
+#define SYMBOL_NUMBER_MAXIMUM INT_MAX
+
+
+typedef struct symbol symbol;
+
+/* When extending this structure, be sure to complete
+   symbol_check_alias_consistency.  */
+struct symbol
 {
-  unknown_sym,
-  token_sym,		/* terminal symbol */
-  nterm_sym		/* non-terminal */
-} symbol_class;
+  /** The key, name of the symbol.  */
+  uniqstr tag;
+  /** The location of its first occurrence.  */
+  location location;
 
+  /** Its \c \%type.  */
+  uniqstr type_name;
+  /** Its \c \%type's location.  */
+  location type_location;
 
-/* Internal token numbers. */
-typedef short symbol_number_t;
+  /** Any \c \%destructor declared specifically for this symbol.
 
+     Access this field only through <tt>symbol</tt>'s interface functions.  For
+     example, if <tt>symbol::destructor = NULL</tt>, the default
+     \c \%destructor or a per-type \c \%destructor might be appropriate, and
+     \c symbol_destructor_get will compute the correct one.  */
+  const char *destructor;
 
-typedef struct symbol_s symbol_t;
-struct symbol_s
-{
-  /* The key, name of the symbol.  */
-  char *tag;
-  /* The location of its first occurence.  */
-  location_t location;
-
-  /* Its %type and associated printer and destructor.  */
-  char *type_name;
-  char *destructor;
-  location_t destructor_location;
-  char *printer;
-  location_t printer_location;
-
-  symbol_number_t number;
-  short prec;
-  associativity assoc;
+  /** The location of \c symbol::destructor.
+
+     Access this field only through <tt>symbol</tt>'s interface functions.
+     \sa symbol::destructor  */
+  location destructor_location;
+
+  /** Any \c \%printer declared specifically for this symbol.
+
+     Access this field only through <tt>symbol</tt>'s interface functions.
+     \sa symbol::destructor  */
+  const char *printer;
+
+  /** The location of \c symbol::printer.
+
+     Access this field only through <tt>symbol</tt>'s interface functions.
+     \sa symbol::destructor  */
+  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.  */
-  symbol_t *alias;
+  symbol *alias;
   symbol_class class;
+  bool declared;
 };
 
-/* Undefined user number.  */
+/** Undefined user number.  */
 #define USER_NUMBER_UNDEFINED -1
 
 /* `symbol->user_token_number == USER_NUMBER_ALIAS' means this symbol
@@ -88,89 +116,153 @@ struct symbol_s
 #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.  */
+symbol *symbol_from_uniqstr (const uniqstr key, location loc);
+
+/** Fetch (or create) the symbol associated to KEY.  */
+symbol *symbol_get (const char *key, location loc);
+
+/** Generate a dummy nonterminal.
+
+   Its name cannot conflict with the user's names.  */
+symbol *dummy_symbol_get (location loc);
+
+/** Is this a dummy nonterminal?  */
+bool symbol_is_dummy (const symbol *sym);
+
+/** Declare the new symbol \c sym.  Make it an alias of \c symval.  */
+void symbol_make_alias (symbol *sym, symbol *symval, location loc);
+
+/** Set the \c type_name associated with \c sym.
+
+    Do nothing if passed 0 as \c type_name.  */
+void symbol_type_set (symbol *sym, uniqstr type_name, location loc);
+
+/** Set the \c destructor associated with \c sym.  */
+void symbol_destructor_set (symbol *sym, const char *destructor, location loc);
+
+/** Get the computed \c \%destructor for \c sym, or \c NULL if none.   */
+const char *symbol_destructor_get (symbol *sym);
+
+/** Get the grammar location of the computed \c \%destructor for \c sym.
+ 
+  \pre <tt>symbol_destructor_get (sym) != NULL</tt> */
+location symbol_destructor_location_get (symbol *sym);
+
+/** Set the \c printer associated with \c sym.  */
+void symbol_printer_set (symbol *sym, const char *printer, location loc);
+
+/** Get the computed \c \%printer for \c sym, or \c NULL if none.  */
+const char *symbol_printer_get (symbol *sym);
+
+/** Get the grammar location of the computed \c \%printer for \c sym.
+
+  \pre <tt>symbol_printer_get (sym) != NULL</tt> */
+location symbol_printer_location_get (symbol *sym);
+
+/* Set the \c precedence associated with \c sym.
+
+   Ensure that \a symbol is a terminal.
+   Do nothing if invoked with \c undef_assoc as \c assoc.  */
+void symbol_precedence_set (symbol *sym, int prec, assoc a, location loc);
+
+/** Set the \c class associated with \c sym.  */
+void symbol_class_set (symbol *sym, symbol_class class, location loc,
+		       bool declaring);
+
+/** Set the \c user_token_number associated with \c sym.  */
+void symbol_user_token_number_set (symbol *sym, int user_number, location loc);
+
 
+/** The error token. */
+extern symbol *errtoken;
+/** The token for unknown tokens.  */
+extern symbol *undeftoken;
+/** The end of input token.  */
+extern symbol *endtoken;
+/** The genuine start symbol.
 
-/* 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));
+   $accept: start-symbol $end */
+extern symbol *accept;
 
-/* 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));
+/** The user start symbol. */
+extern symbol *startsymbol;
+/** The location of the \c \%start declaration.  */
+extern location startsymbol_location;
 
-/* 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));
+/*-----------------.
+| Semantic types.  |
+`-----------------*/
 
-/* Declare the new SYMBOL.  Make it an alias of SYMVAL.  */
-void symbol_make_alias PARAMS ((symbol_t *symbol, symbol_t *symval));
+/** A semantic type and its associated \c \%destructor and \c \%printer.
+   
+   Access the fields of this struct only through the interface functions in
+   this file.  \sa symbol::destructor  */
+typedef struct semantic_type {
+  /** The key, name of the semantic type.  */
+  uniqstr tag;
 
-/* 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));
+  /** Any \c %destructor declared for this semantic type.  */
+  const char *destructor;
+  /** The location of \c semantic_type::destructor.  */
+  location destructor_location;
 
-/* Set the DESTRUCTOR associated to SYMBOL.  */
-void symbol_destructor_set PARAMS ((symbol_t *symbol, location_t location,
-				    char *destructor));
+  /** Any \c %printer declared for this semantic type.  */
+  const char *printer;
+  /** The location of \c semantic_type::printer.  */
+  location printer_location;
+} semantic_type;
 
-/* Set the PRINTER associated to SYMBOL.  */
-void symbol_printer_set PARAMS ((symbol_t *symbol,
-				 char *printer, location_t location));
+/** Fetch (or create) the semantic type associated to KEY.  */
+semantic_type *semantic_type_from_uniqstr (const uniqstr key);
 
-/* 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));
+/** Fetch (or create) the semantic type associated to KEY.  */
+semantic_type *semantic_type_get (const char *key);
 
-/* Set the CLASS associated to SYMBOL.  */
-void symbol_class_set PARAMS ((symbol_t *symbol,
-			       symbol_class class, location_t location));
+/** Set the \c destructor associated with \c type.  */
+void semantic_type_destructor_set (semantic_type *type, const char *destructor,
+                                   location loc);
 
-/* Set the USER_TOKEN_NUMBER associated to SYMBOL.  */
-void symbol_user_token_number_set PARAMS ((symbol_t *symbol,
-					   int user_number,
-					   location_t location));
+/** Set the \c printer associated with \c type.  */
+void semantic_type_printer_set (semantic_type *type, const char *printer,
+                                location loc);
 
+/*----------------------------------.
+| Symbol and semantic type tables.  |
+`----------------------------------*/
 
-/* 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;
+/** Create the symbol and semantic type tables.  */
+void symbols_new (void);
 
+/** Free all the memory allocated for symbols and semantic types.  */
+void symbols_free (void);
 
-/*---------------.
-| Symbol table.  |
-`---------------*/
+/** Check that all the symbols are defined.
 
+    Report any undefined symbols and consider them nonterminals.  */
+void symbols_check_defined (void);
 
-/* Create the symbol table.  */
-void symbols_new PARAMS ((void));
+/** Sanity checks and #token_translations construction.
 
-/* A function to apply to each symbol. */
-typedef bool (*symbol_processor) PARAMS ((symbol_t *));
+   Perform various sanity checks, assign symbol numbers, and set up
+   #token_translations.  */
+void symbols_pack (void);
 
-/* 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));
 
-/* Free all the memory allocated for symbols.  */
-void symbols_free PARAMS ((void));
+/*-----------------------------------.
+| Default %destructor and %printer.  |
+`-----------------------------------*/
 
-/* Check that all the symbols are defined.  Report any undefined
-   symbols and consider them nonterminals.  */
-void symbols_check_defined PARAMS ((void));
+/** Set the default \c \%destructor.  */
+void default_destructor_set (const char *destructor, location loc);
 
-/* Perform various sanity checks, assign symbol numbers, and set up
-   TOKEN_TRANSLATIONS.  */
-void symbols_pack PARAMS ((void));
+/** Set the default \c \%printer.  */
+void default_printer_set (const char *printer, location loc);
 
 #endif /* !SYMTAB_H_ */