NEWS: update.

[bison.git] / src / symtab.h

diff --git a/src/symtab.h b/src/symtab.h
index c29492330d618db5aab4a50fff2b0b7968792fc7..7d8cf982650f36ff71f829976388eaa23a7563dd 100644 (file)
--- a/src/symtab.h
+++ b/src/symtab.h
@@ -1,24 +1,22 @@
 /* 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, 2005, 2006
-   Free Software Foundation, Inc.
+   Copyright (C) 1984, 1989, 1992, 2000-2002, 2004-2007, 2009-2012 Free
+   Software Foundation, Inc.

 
    This file is part of Bison, the GNU Compiler Compiler.
 
 
    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., 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
 
 /**
  * \file symtab.h


@@ -30,6 +28,7 @@
 
 # include "assoc.h"
 # include "location.h"
 
 # include "assoc.h"
 # include "location.h"

+# include "scan-code.h"

 # include "uniqstr.h"
 
 /*----------.
 # include "uniqstr.h"
 
 /*----------.


@@ -61,36 +60,31 @@ struct symbol
   /** The location of its first occurrence.  */
   location location;
 
   /** The location of its first occurrence.  */
   location location;
 

-  /** Its \c \%type.  */
+  /** Its \c \%type.
+
+      Beware that this is the type_name as was entered by the user,
+      including silly things such as "]" if she entered "%token <]> t".
+      Therefore, when outputting type_name to M4, be sure to escape it
+      into "@}".  See quoted_output for instance.  */

   uniqstr type_name;
   uniqstr type_name;

+

   /** Its \c \%type's location.  */
   location type_location;
 
   /** Any \c \%destructor declared specifically for this symbol.
 
   /** 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.  */
-  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;
+      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.
 
 
   /** 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;
+      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;


@@ -98,9 +92,9 @@ struct symbol
   assoc assoc;
   int user_token_number;
 
   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;
   symbol *alias;
   symbol_class class;
   bool declared;


@@ -109,11 +103,11 @@ struct symbol
 /** Undefined user number.  */
 #define USER_NUMBER_UNDEFINED -1
 
 /** 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
    "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)
 
 /* Undefined internal token number.  */
 #define NUMBER_UNDEFINED (-1)


@@ -135,8 +129,11 @@ symbol *dummy_symbol_get (location loc);
 /** Is this a dummy nonterminal?  */
 bool symbol_is_dummy (const symbol *sym);
 
 /** 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);
+/**
+ * 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.
 
 
 /** Set the \c type_name associated with \c sym.
 


@@ -144,26 +141,18 @@ void symbol_make_alias (symbol *sym, symbol *symval, location loc);
 void symbol_type_set (symbol *sym, uniqstr type_name, location loc);
 
 /** Set the \c destructor 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.  */
 
 /** Set the \c printer associated with \c sym.  */

-void symbol_printer_set (symbol *sym, const char *printer, location loc);
-
-/** Get the computed \c \%printer for \c sym, or \c NULL if none.  */
-const char *symbol_printer_get (symbol *sym);
+void symbol_printer_set (symbol *sym, code_props const *printer);

 
 

-/** 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 precedence associated with \c sym.
 


@@ -201,22 +190,17 @@ extern location startsymbol_location;
 `-----------------*/
 
 /** A semantic type and its associated \c \%destructor and \c \%printer.
 `-----------------*/
 
 /** 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  */
    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;
 
   /** Any \c %destructor declared for this semantic type.  */
   /** The key, name of the semantic type.  */
   uniqstr tag;
 
   /** Any \c %destructor declared for this semantic type.  */

-  const char *destructor;
-  /** The location of \c semantic_type::destructor.  */
-  location destructor_location;
-
+  code_props destructor;

   /** Any \c %printer declared for this semantic type.  */
   /** Any \c %printer declared for this semantic type.  */

-  const char *printer;
-  /** The location of \c semantic_type::printer.  */
-  location printer_location;
+  code_props printer;

 } semantic_type;
 
 /** Fetch (or create) the semantic type associated to KEY.  */
 } semantic_type;
 
 /** Fetch (or create) the semantic type associated to KEY.  */


@@ -226,12 +210,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.  */
 semantic_type *semantic_type_get (const char *key);
 
 /** Set the \c destructor associated with \c type.  */

-void semantic_type_destructor_set (semantic_type *type, const char *destructor,
-                                   location loc);
+void semantic_type_destructor_set (semantic_type *type,
+                                   code_props const *destructor);

 
 /** Set the \c printer associated with \c type.  */
 
 /** Set the \c printer associated with \c type.  */

-void semantic_type_printer_set (semantic_type *type, const char *printer,
-                                location loc);
+void semantic_type_printer_set (semantic_type *type,
+                                code_props const *printer);

 
 /*----------------------------------.
 | Symbol and semantic type tables.  |
 
 /*----------------------------------.
 | Symbol and semantic type tables.  |


@@ -260,13 +244,13 @@ void symbols_pack (void);
 `---------------------------------------*/
 
 /** Set the default \c \%destructor for tagged values.  */
 `---------------------------------------*/
 
 /** Set the default \c \%destructor for tagged values.  */

-void default_tagged_destructor_set (const char *destructor, location loc);
+void default_tagged_destructor_set (code_props const *destructor);

 /** Set the default \c \%destructor for tagless values.  */
 /** Set the default \c \%destructor for tagless values.  */

-void default_tagless_destructor_set (const char *destructor, location loc);
+void default_tagless_destructor_set (code_props const *destructor);

 
 /** Set the default \c \%printer for tagged values.  */
 
 /** Set the default \c \%printer for tagged values.  */

-void default_tagged_printer_set (const char *printer, location loc);
+void default_tagged_printer_set (code_props const *printer);

 /** Set the default \c \%printer for tagless values.  */
 /** Set the default \c \%printer for tagless values.  */

-void default_tagless_printer_set (const char *printer, location loc);
+void default_tagless_printer_set (code_props const *printer);

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