/* Definitions for symtab.c and callers, part of Bison.
- Copyright (C) 1984, 1989, 1992, 2000, 2001, 2002, 2004, 2005, 2006
- Free Software Foundation, Inc.
+ Copyright (C) 1984, 1989, 1992, 2000-2002, 2004-2012 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
# include "assoc.h"
# include "location.h"
+# include "scan-code.h"
# include "uniqstr.h"
/*----------.
typedef enum
{
unknown_sym, /**< Undefined. */
- token_sym, /**< Terminal. */
- nterm_sym /**< Non-terminal. */
+ token_sym, /**< Terminal. */
+ nterm_sym /**< Non-terminal. */
} symbol_class;
/** 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
+ 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. */
- const char *destructor;
-
- /** The location of \c symbol::destructor.
-
- Access this field only through <tt>symbol</tt>'s interface functions.
- \sa symbol::destructor */
- location destructor_location;
+ 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 */
- 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;
+ code_props printer;
symbol_number number;
location prec_location;
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. */
+ /* Points to the other in the symbol-string pair for an alias.
+ Special value USER_NUMBER_HAS_STRING_ALIAS in the symbol half of the
+ symbol-string pair for an alias. */
symbol *alias;
symbol_class class;
bool declared;
};
-
/** Undefined user number. */
#define USER_NUMBER_UNDEFINED -1
-/* `symbol->user_token_number == USER_NUMBER_ALIAS' means this symbol
- *has* (not is) a string literal alias. For instance, `%token foo
+/* `symbol->user_token_number == USER_NUMBER_HAS_STRING_ALIAS' means
+ this symbol has a literal string alias. For instance, `%token foo
"foo"' has `"foo"' numbered regularly, and `foo' numbered as
- USER_NUMBER_ALIAS. */
-#define USER_NUMBER_ALIAS -9991
+ USER_NUMBER_HAS_STRING_ALIAS. */
+#define USER_NUMBER_HAS_STRING_ALIAS -9991
/* 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);
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);
-/** Declare the new symbol \c sym. Make it an alias of \c symval. */
-void symbol_make_alias (symbol *sym, symbol *symval, location loc);
+/** 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);
+
+/**
+ * Make \c str the literal string alias of \c sym. Copy token number,
+ * symbol number, and type from \c sym to \c str.
+ */
+void symbol_make_alias (symbol *sym, symbol *str, location loc);
/** Set the \c type_name associated with \c sym.
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);
+void symbol_destructor_set (symbol *sym, code_props const *destructor);
-/** 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);
+/** 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 \c printer associated with \c sym. */
-void symbol_printer_set (symbol *sym, const char *printer, location loc);
+void symbol_printer_set (symbol *sym, code_props const *printer);
-/** 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);
+/** 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.
/** Set the \c class associated with \c sym. */
void symbol_class_set (symbol *sym, symbol_class class, location loc,
- bool declaring);
+ 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);
+
+/*------------------.
+| Special symbols. |
+`------------------*/
+
/** The error token. */
extern symbol *errtoken;
/** The token for unknown tokens. */
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);
+
+/** 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 table. */
+/** Create the symbol and semantic type tables. */
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);
/** Check that all the symbols are defined.
void symbols_pack (void);
-/*-----------------------------------.
-| Default %destructor and %printer. |
-`-----------------------------------*/
+/*---------------------------------------.
+| Default %destructor's and %printer's. |
+`---------------------------------------*/
-/** Set the default \c \%destructor. */
-void default_destructor_set (const char *destructor, location loc);
+/** 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. */
-void default_printer_set (const char *printer, location loc);
+/** 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_ */
projects / bison.git / blobdiff