]> git.saurik.com Git - bison.git/blobdiff - src/symtab.h
xml: beware of user strings used to give a %prec to rules.
[bison.git] / src / symtab.h
index 1a4b70181a4c193e12a459511f0dd3693170d289..0e521626c7e41b96e6c0e20945c9c0f2c3ceb79a 100644 (file)
@@ -1,24 +1,22 @@
 /* Definitions for symtab.c and callers, part of Bison.
 
-   Copyright (C) 1984, 1989, 1992, 2000, 2001, 2002, 2004, 2005, 2006
+   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.
 
-   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
-   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
-   along with Bison; see the file COPYING.  If not, write to
-   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-   Boston, MA 02110-1301, USA.  */
+   along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
 
 /**
  * \file symtab.h
@@ -107,9 +105,6 @@ struct symbol
 /* Undefined internal token number.  */
 #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);
 
@@ -121,9 +116,23 @@ symbol *symbol_get (const char *key, location loc);
    Its name cannot conflict with the user's names.  */
 symbol *dummy_symbol_get (location loc);
 
+
+/*--------------------.
+| 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);
 
@@ -132,19 +141,22 @@ void symbol_make_alias (symbol *sym, symbol *symval, location loc);
     Do nothing if passed 0 as \c type_name.  */
 void symbol_type_set (symbol *sym, uniqstr type_name, 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 destructor);
+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 symbol_destructor_get (symbol *sym);
+code_props const *symbol_destructor_get (symbol const *sym);
 
 /** Set the \c printer associated with \c sym.  */
-void symbol_printer_set (symbol *sym, code_props printer);
+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 symbol_printer_get (symbol *sym);
+code_props const *symbol_printer_get (symbol const *sym);
 
 /* Set the \c precedence associated with \c sym.
 
@@ -160,6 +172,11 @@ void symbol_class_set (symbol *sym, symbol_class class, location loc,
 void symbol_user_token_number_set (symbol *sym, int user_number, location loc);
 
 
+
+/*------------------.
+| Special symbols.  |
+`------------------*/
+
 /** The error token. */
 extern symbol *errtoken;
 /** The token for unknown tokens.  */
@@ -182,10 +199,10 @@ extern location startsymbol_location;
 `-----------------*/
 
 /** 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 {
+typedef struct {
   /** The key, name of the semantic type.  */
   uniqstr tag;
 
@@ -202,10 +219,12 @@ semantic_type *semantic_type_from_uniqstr (const uniqstr 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 destructor);
+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 printer);
+void semantic_type_printer_set (semantic_type *type,
+                                code_props const *printer);
 
 /*----------------------------------.
 | Symbol and semantic type tables.  |
@@ -234,13 +253,13 @@ void symbols_pack (void);
 `---------------------------------------*/
 
 /** Set the default \c \%destructor for tagged values.  */
-void default_tagged_destructor_set (code_props destructor);
+void default_tagged_destructor_set (code_props const *destructor);
 /** Set the default \c \%destructor for tagless values.  */
-void default_tagless_destructor_set (code_props destructor);
+void default_tagless_destructor_set (code_props const *destructor);
 
 /** Set the default \c \%printer for tagged values.  */
-void default_tagged_printer_set (code_props printer);
+void default_tagged_printer_set (code_props const *printer);
 /** Set the default \c \%printer for tagless values.  */
-void default_tagless_printer_set (code_props printer);
+void default_tagless_printer_set (code_props const *printer);
 
 #endif /* !SYMTAB_H_ */