2007-02-07 Paolo Bonzini <bonzini@gnu.org>

[bison.git] / src / symtab.h

diff --git a/src/symtab.h b/src/symtab.h
index 61bd4017904b59ede7d50ca0401523281b075ee3..7a25b360a747890e3418d2c276cefff8a9e46471 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, 2006, 2007

    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,61 +17,85 @@
 
    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.  */
+
+/**
+ * \file symtab.h
+ * \brief Manipulating ::symbol.
+ */

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

-# include "location.h"

 # include "assoc.h"
 # include "assoc.h"

+# include "location.h"
+# include "scan-code.h"
+# include "uniqstr.h"

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

-/* Symbol classes.  */
+/** Symbol classes.  */

 typedef enum
 {
 typedef enum
 {

-  unknown_sym,
-  token_sym,           /* terminal symbol */
-  nterm_sym            /* non-terminal */
+  unknown_sym,          /**< Undefined.  */
+  token_sym,           /**< Terminal. */
+  nterm_sym            /**< Non-terminal. */

 } symbol_class;
 
 
 } symbol_class;
 
 

-/* Internal token numbers. */
-typedef short symbol_number_t;
-#define SYMBOL_NUMBER_MAX ((symbol_number_t) SHRT_MAX)
+/** Internal token numbers. */
+typedef int symbol_number;
+#define SYMBOL_NUMBER_MAXIMUM INT_MAX

 
 
 
 

-typedef struct symbol_s symbol_t;
-struct symbol_s
+typedef struct symbol symbol;
+
+/* When extending this structure, be sure to complete
+   symbol_check_alias_consistency.  */
+struct symbol

 {
 {

-  /* 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;
-  assoc_t assoc;
+  /** 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;
+
+  /** 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>, a default \c \%destructor
+     or a per-type \c \%destructor might be appropriate, and
+     \c symbol_destructor_get will compute the correct one.  */
+  code_props destructor;
+
+  /** Any \c \%printer declared specifically for this symbol.
+
+     Access this field only through <tt>symbol</tt>'s interface functions.
+     \sa symbol::destructor  */
+  code_props printer;
+
+  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;

+  bool declared;

 };
 
 };
 

-/* Undefined user number.  */
+/** Undefined user number.  */

 #define USER_NUMBER_UNDEFINED -1
 
 /* `symbol->user_token_number == USER_NUMBER_ALIAS' means this symbol
 #define USER_NUMBER_UNDEFINED -1
 
 /* `symbol->user_token_number == USER_NUMBER_ALIAS' means this symbol


@@ -80,82 +105,144 @@ 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.  */
-symbol_t *symbol_get (const char *key, location_t location);
+/** Fetch (or create) the symbol associated to KEY.  */
+symbol *symbol_from_uniqstr (const uniqstr key, location loc);

 
 

-/* Generate a dummy nonterminal, whose name cannot conflict with the
-   user's names.  */
-symbol_t *dummy_symbol_get (location_t location);
+/** Fetch (or create) the symbol associated to KEY.  */
+symbol *symbol_get (const char *key, location loc);

 
 

-/* Declare the new SYMBOL.  Make it an alias of SYMVAL.  */
-void symbol_make_alias (symbol_t *symbol, symbol_t *symval,
-                       location_t location);
+/** Generate a dummy nonterminal.

 
 

-/* Set the TYPE_NAME associated to SYMBOL. Does nothing if passed 0 as
-   TYPE_NAME.  */
-void symbol_type_set (symbol_t *symbol,
-                     char *type_name, location_t location);
+   Its name cannot conflict with the user's names.  */
+symbol *dummy_symbol_get (location loc);

 
 

-/* Set the DESTRUCTOR associated to SYMBOL.  */
-void symbol_destructor_set (symbol_t *symbol,
-                           char *destructor, location_t location);
+/** Is this a dummy nonterminal?  */
+bool symbol_is_dummy (const symbol *sym);

 
 

-/* Set the PRINTER associated to SYMBOL.  */
-void symbol_printer_set (symbol_t *symbol,
-                        char *printer, location_t location);
+/** 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 PRECEDENCE associated to SYMBOL.  Ensures that SYMBOL is a
-   terminal.  Does nothing if invoked with UNDEF_ASSOC as ASSOC.  */
-void symbol_precedence_set (symbol_t *symbol,
-                           int prec, assoc_t assoc, location_t location);
+/** Set the \c type_name associated with \c sym.

 
 

-/* Set the CLASS associated to SYMBOL.  */
-void symbol_class_set (symbol_t *symbol,
-                      symbol_class class, location_t location);
+    Do nothing if passed 0 as \c type_name.  */
+void symbol_type_set (symbol *sym, uniqstr type_name, location loc);

 
 

-/* Set the USER_TOKEN_NUMBER associated to SYMBOL.  */
-void symbol_user_token_number_set (symbol_t *symbol,
-                                  int user_number, location_t location);
+/** Set the \c destructor associated with \c sym.  */
+void symbol_destructor_set (symbol *sym, code_props const *destructor);

 
 

+/** Get the computed \c \%destructor for \c sym, which was initialized with
+    \c code_props_none_init if there's no \c \%destructor.  */
+code_props const *symbol_destructor_get (symbol const *sym);

 
 

-/* 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 *endtoken;
-extern symbol_t *accept;
-extern symbol_t *startsymbol;
-extern location_t startsymbol_location;
+/** Set the \c printer associated with \c sym.  */
+void symbol_printer_set (symbol *sym, code_props const *printer);

 
 

+/** Get the computed \c \%printer for \c sym, which was initialized with
+    \c code_props_none_init if there's no \c \%printer.  */
+code_props const *symbol_printer_get (symbol const *sym);

 
 

-/*---------------.
-| Symbol table.  |
-`---------------*/
+/* 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);

 
 

-/* Create the symbol table.  */
-void symbols_new (void);
+/** 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.
+
+   $accept: start-symbol $end */
+extern symbol *accept;
+
+/** The user start symbol. */
+extern symbol *startsymbol;
+/** The location of the \c \%start declaration.  */
+extern location startsymbol_location;
+
+
+/*-----------------.
+| Semantic types.  |
+`-----------------*/
+
+/** A semantic type and its associated \c \%destructor and \c \%printer.

 
 

-/* A function to apply to each symbol. */
-typedef bool (*symbol_processor) (symbol_t *);
+   Access the fields of this struct only through the interface functions in
+   this file.  \sa symbol::destructor  */
+typedef struct {
+  /** The key, name of the semantic type.  */
+  uniqstr tag;

 
 

-/* Apply PROCESSOR to all the symbols.  PROCESSOR must return true: on
-   false, the processing stops.  */
-void symbols_do (symbol_processor processor, void *processor_data);
+  /** Any \c %destructor declared for this semantic type.  */
+  code_props destructor;
+  /** Any \c %printer declared for this semantic type.  */
+  code_props printer;
+} semantic_type;

 
 

-/* Free all the memory allocated for symbols.  */
+/** Fetch (or create) the semantic type associated to KEY.  */
+semantic_type *semantic_type_from_uniqstr (const uniqstr key);
+
+/** Fetch (or create) the semantic type associated to KEY.  */
+semantic_type *semantic_type_get (const char *key);
+
+/** Set the \c destructor associated with \c type.  */
+void semantic_type_destructor_set (semantic_type *type,
+                                   code_props const *destructor);
+
+/** Set the \c printer associated with \c type.  */
+void semantic_type_printer_set (semantic_type *type,
+                                code_props const *printer);
+
+/*----------------------------------.
+| Symbol and semantic type tables.  |
+`----------------------------------*/
+
+/** 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);
 
 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 (void);
 
 void symbols_check_defined (void);
 

-/* Perform various sanity checks, assign symbol numbers, and set up
-   TOKEN_TRANSLATIONS.  */
+/** Sanity checks and #token_translations construction.
+
+   Perform various sanity checks, assign symbol numbers, and set up
+   #token_translations.  */

 void symbols_pack (void);
 
 void symbols_pack (void);
 

+
+/*---------------------------------------.
+| Default %destructor's and %printer's.  |
+`---------------------------------------*/
+
+/** Set the default \c \%destructor for tagged values.  */
+void default_tagged_destructor_set (code_props const *destructor);
+/** Set the default \c \%destructor for tagless values.  */
+void default_tagless_destructor_set (code_props const *destructor);
+
+/** Set the default \c \%printer for tagged values.  */
+void default_tagged_printer_set (code_props const *printer);
+/** Set the default \c \%printer for tagless values.  */
+void default_tagless_printer_set (code_props const *printer);
+

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