X-Git-Url: https://git.saurik.com/bison.git/blobdiff_plain/ec5479ce351b0365549e9c7d570b0ee86a4a6589..3eb4f1a3e62807125a815dc572da9204b5b51865:/src/symtab.h diff --git a/src/symtab.h b/src/symtab.h index 1a3ada4c..84113394 100644 --- a/src/symtab.h +++ b/src/symtab.h @@ -1,24 +1,22 @@ /* 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 . */ /** * \file symtab.h @@ -30,6 +28,7 @@ # include "assoc.h" # include "location.h" +# include "scan-code.h" # include "uniqstr.h" /*----------. @@ -40,8 +39,8 @@ typedef enum { unknown_sym, /**< Undefined. */ - token_sym, /**< Terminal. */ - nterm_sym /**< Non-terminal. */ + token_sym, /**< Terminal. */ + nterm_sym /**< Non-terminal. */ } symbol_class; @@ -52,6 +51,38 @@ typedef int symbol_number; typedef struct symbol symbol; +/* Declaration status of a symbol. + + First, it is "undeclared". Then, if "undeclared" and used in a + %printer/%destructor, it is "used". If not "declared" by used in a + rule, it is "needed". Finally, if declared (via a rule for + nonterminals, or %oken), it is "declared". + + When status are checked at the end, "declared" symbols are fine, + "used" symbols trigger warnings, otherwise it's an error. +*/ + +typedef enum + { + /** Used in the input file for an unknown reason (error). */ + undeclared, + /** Used by %destructor/%printer but not defined (warning). */ + used, + /** Used in the gramar (rules) but not defined (error). */ + needed, + /** Defined with %type or %token (good). */ + declared, + } status; + +typedef enum code_props_type code_props_type; +enum code_props_type + { + destructor = 0, + printer = 1, + }; + +enum { CODE_PROPS_SIZE = 2 }; + /* When extending this structure, be sure to complete symbol_check_alias_consistency. */ struct symbol @@ -66,31 +97,14 @@ struct symbol /** Its \c \%type's location. */ location type_location; - /** Any \c \%destructor declared specifically for this symbol. - - Access this field only through symbol's interface functions. For - example, if symbol::destructor = NULL, 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; - - /** The location of \c symbol::destructor. - - Access this field only through symbol's interface functions. - \sa symbol::destructor */ - location destructor_location; - - /** Any \c \%printer declared specifically for this symbol. - - Access this field only through symbol's interface functions. - \sa symbol::destructor */ - const char *printer; + /** Any \c \%destructor (resp. \%printer) declared specificially for this + symbol. - /** The location of \c symbol::printer. - - Access this field only through symbol's interface functions. - \sa symbol::destructor */ - location printer_location; + Access this field only through symbol's interface functions. For + Example, if symbol::destructor = NULL (resp. symbol::printer + = NULL), a default \c \%destructor (resp. \%printer) or a per-type + \c symbol_destructor_printer_get will compute the corect one. */ + code_props props[CODE_PROPS_SIZE]; symbol_number number; location prec_location; @@ -98,30 +112,26 @@ struct symbol 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; + status status; }; - /** 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); @@ -133,35 +143,46 @@ symbol *symbol_get (const char *key, location loc); Its name cannot conflict with the user's names. */ symbol *dummy_symbol_get (location loc); -/** 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. +/*--------------------. +| Methods on symbol. | +`--------------------*/ - Do nothing if passed 0 as \c type_name. */ -void symbol_type_set (symbol *sym, uniqstr type_name, location loc); +/** Print a symbol (for debugging). */ +void symbol_print (symbol *s, FILE *f); -/** Set the \c destructor associated with \c sym. */ -void symbol_destructor_set (symbol *sym, const char *destructor, location loc); +/** Is this a dummy nonterminal? */ +bool symbol_is_dummy (const symbol *sym); -/** Get the computed \c \%destructor for \c sym, or \c NULL if none. */ -const char *symbol_destructor_get (symbol *sym); +/** The name of the code_props type: "\%destructor" or "\%printer". */ +char const *code_props_type_string (code_props_type kind); -/** Get the grammar location of the computed \c \%destructor for \c sym. - - \pre symbol_destructor_get (sym) != NULL */ -location symbol_destructor_location_get (symbol *sym); +/** 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); -/** Set the \c printer associated with \c sym. */ -void symbol_printer_set (symbol *sym, const char *printer, location loc); +/** + * 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); -/** Get the computed \c \%printer for \c sym, or \c NULL if none. */ -const char *symbol_printer_get (symbol *sym); +/** 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); -/** Get the grammar location of the computed \c \%printer for \c sym. +/** Set the \c \%destructor or \c \%printer associated with \c sym. */ +void symbol_code_props_set (symbol *sym, code_props_type kind, + code_props const *destructor); - \pre symbol_printer_get (sym) != NULL */ -location symbol_printer_location_get (symbol *sym); +/** Get the computed \c \%destructor or \c %printer for \c sym, which was +initialized with \c code_props_none_init if there's no \c \%destructor or +\c %printer. */ +code_props const *symbol_code_props_get (symbol const *sym, + code_props_type kind); /* Set the \c precedence associated with \c sym. @@ -171,12 +192,17 @@ 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); + 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. */ @@ -194,15 +220,51 @@ extern symbol *startsymbol; 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; + + /** The location of its first occurence. */ + location location; + + /** Its status : "undeclared", "used" or "declared". + It cannot be "needed". */ + status status; + + /** Any \c %destructor and %printer declared for this + semantic type. */ + code_props props[CODE_PROPS_SIZE]; +} semantic_type; -/** Create the symbol table. */ +/** Fetch (or create) the semantic type associated to KEY. */ +semantic_type *semantic_type_from_uniqstr (const uniqstr key, + const location *loc); + +/** Fetch (or create) the semantic type associated to KEY. */ +semantic_type *semantic_type_get (const char *key, const location *loc); + +/** Set the \c destructor or \c printer associated with \c type. */ +void semantic_type_code_props_set (semantic_type *type, + code_props_type kind, + code_props const *code); + +/*----------------------------------. +| Symbol and semantic type tables. | +`----------------------------------*/ + +/** 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. @@ -217,14 +279,15 @@ void symbols_check_defined (void); void symbols_pack (void); -/*-----------------------------------. -| Default %destructor and %printer. | -`-----------------------------------*/ - -/** Set the default \c \%destructor. */ -void default_destructor_set (const char *destructor, location loc); +/*---------------------------------------. +| Default %destructor's and %printer's. | +`---------------------------------------*/ -/** Set the default \c \%printer. */ -void default_printer_set (const char *printer, location loc); +/** Set the default \c \%destructor or \c \%printer for tagged values. */ +void default_tagged_code_props_set (code_props_type kind, + code_props const *code); +/** Set the default \c \%destructor or \c \%printer for tagless values. */ +void default_tagless_code_props_set (code_props_type kind, + code_props const *destructor); #endif /* !SYMTAB_H_ */