bison: catch bad symbol names.

[bison.git] / src / symtab.h

diff --git a/src/symtab.h b/src/symtab.h
index 0f9435069b28fa7954215e6c75d100e13b9c8220..0e521626c7e41b96e6c0e20945c9c0f2c3ceb79a 100644 (file)
--- a/src/symtab.h
+++ b/src/symtab.h
@@ -1,48 +1,52 @@
 /* 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, 2004
+   Copyright (C) 1984, 1989, 1992, 2000, 2001, 2002, 2004, 2005, 2006, 2007, 2008

    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.
 

-   Bison is free software; you can redistribute it and/or modify
+   This program is free software: you can redistribute it and/or modify

    it under the terms of the GNU General Public License as published by
    it under the terms of the GNU General Public License as published by

-   the Free Software Foundation; either version 2, or (at your option)
-   any later version.
+   the Free Software Foundation, either version 3 of the License, or
+   (at your option) any later version.

 
 

-   Bison is distributed in the hope that it will be useful,
+   This program is distributed in the hope that it will be useful,

    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.
 
    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.  */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
+
+/**
+ * \file symtab.h
+ * \brief Manipulating ::symbol.
+ */

 
 #ifndef SYMTAB_H_
 # define SYMTAB_H_
 
 # include "assoc.h"
 # include "location.h"
 
 #ifndef SYMTAB_H_
 # define SYMTAB_H_
 
 # include "assoc.h"
 # include "location.h"

+# include "scan-code.h"

 # include "uniqstr.h"
 
 /*----------.
 | Symbols.  |
 `----------*/
 
 # include "uniqstr.h"
 
 /*----------.
 | 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 int symbol_number;
-#define SYMBOL_NUMBER_MAXIMUM SHRT_MAX
+/** Internal token numbers. */
+typedef int symbol_number;
+#define SYMBOL_NUMBER_MAXIMUM INT_MAX

 
 
 typedef struct symbol symbol;
 
 
 typedef struct symbol symbol;


@@ -51,24 +55,33 @@ typedef struct symbol symbol;
    symbol_check_alias_consistency.  */
 struct symbol
 {
    symbol_check_alias_consistency.  */
 struct symbol
 {

-  /* The key, name of the symbol.  */
+  /** The key, name of the symbol.  */

   uniqstr tag;
   uniqstr tag;

-  /* The location of its first occurrence.  */
+  /** The location of its first occurrence.  */

   location location;
 
   location location;
 

-  /* Its %type and associated printer and destructor.  */
+  /** Its \c \%type.  */

   uniqstr type_name;
   uniqstr type_name;

+  /** Its \c \%type's location.  */

   location type_location;
 
   location type_location;
 

-  char *destructor;
-  location destructor_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;

 
 

-  char *printer;
-  location printer_location;
+  /** 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;
 
   symbol_number number;
   location prec_location;

-  short int prec;
+  int prec;

   assoc assoc;
   int user_token_number;
 
   assoc assoc;
   int user_token_number;
 


@@ -77,9 +90,10 @@ struct symbol
      identifier-symbol pair for an alias.  */
   symbol *alias;
   symbol_class class;
      identifier-symbol pair for an 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
 #define USER_NUMBER_UNDEFINED -1
 
 /* `symbol->user_token_number == USER_NUMBER_ALIAS' means this symbol


@@ -91,66 +105,161 @@ struct symbol
 /* Undefined internal token number.  */
 #define NUMBER_UNDEFINED (-1)
 
 /* Undefined internal token number.  */
 #define NUMBER_UNDEFINED (-1)
 

+/** 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.  */
+/** Fetch (or create) the symbol associated to KEY.  */

 symbol *symbol_get (const char *key, location loc);
 
 symbol *symbol_get (const char *key, location loc);
 

-/* Generate a dummy nonterminal, whose name cannot conflict with the
-   user's names.  */
+/** Generate a dummy nonterminal.
+
+   Its name cannot conflict with the user's names.  */

 symbol *dummy_symbol_get (location loc);
 
 symbol *dummy_symbol_get (location loc);
 

-/* Declare the new symbol SYM.  Make it an alias of SYMVAL.  */
+
+/*--------------------.
+| Methods on symbol.  |
+`--------------------*/
+
+/** Print a symbol (for debugging). */
+void symbol_print (symbol *s, FILE *f);
+
+/** Is this a dummy nonterminal?  */
+bool symbol_is_dummy (const symbol *sym);
+
+/** Return the name of the symbol that can be used as an identifier.
+ ** Consider the alias if needed.
+ ** Return 0 if there is none (e.g., the symbol is only defined as
+ ** a string). */
+uniqstr symbol_id_get (symbol const *sym);
+
+/** Declare the new symbol \c sym.  Make it an alias of \c symval.  */

 void symbol_make_alias (symbol *sym, symbol *symval, location loc);
 
 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.  */
+/** 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);
 
 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);
+/** Get the \c class string associated with \c sym.  */
+const char *symbol_class_get_string (symbol *sym);
+
+/** 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);

 
 

-/* Set the PRINTER associated with SYM.  */
-void symbol_printer_set (symbol *sym, char *printer, location loc);
+/** Set the \c printer associated with \c sym.  */
+void symbol_printer_set (symbol *sym, code_props const *printer);

 
 

-/* Set the PRECEDENCE associated with SYM.  Ensure that SYMBOL is a
-   terminal.  Do nothing if invoked with UNDEF_ASSOC as ASSOC.  */
+/** 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);
+
+/* 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);
 
 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 \c class associated with \c sym.  */
+void symbol_class_set (symbol *sym, symbol_class class, location loc,
+                      bool declaring);

 
 

-/* Set the USER_TOKEN_NUMBER associated with SYM.  */
+/** Set the \c user_token_number associated with \c sym.  */

 void symbol_user_token_number_set (symbol *sym, int user_number, location loc);
 
 
 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.
-   */
+
+/*------------------.
+| Special symbols.  |
+`------------------*/
+
+/** The error token. */

 extern symbol *errtoken;
 extern symbol *errtoken;

+/** The token for unknown tokens.  */

 extern symbol *undeftoken;
 extern symbol *undeftoken;

+/** The end of input token.  */

 extern symbol *endtoken;
 extern symbol *endtoken;

+/** The genuine start symbol.
+
+   $accept: start-symbol $end */

 extern symbol *accept;
 extern symbol *accept;

+
+/** The user start symbol. */

 extern symbol *startsymbol;
 extern symbol *startsymbol;

+/** The location of the \c \%start declaration.  */

 extern location startsymbol_location;
 
 
 extern location startsymbol_location;
 
 

-/*---------------.
-| Symbol table.  |
-`---------------*/
+/*-----------------.
+| Semantic types.  |
+`-----------------*/
+
+/** 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 {
+  /** The key, name of the semantic type.  */
+  uniqstr tag;
+
+  /** Any \c %destructor declared for this semantic type.  */
+  code_props destructor;
+  /** Any \c %printer declared for this semantic type.  */
+  code_props printer;
+} semantic_type;
+
+/** 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);

 
 

-/* Create the symbol table.  */
+/** 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);
 
 void symbols_new (void);
 

-/* Free all the memory allocated for symbols.  */
+/** 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_ */