tests: minor refactoring

[bison.git] / src / symtab.h

diff --git a/src/symtab.h b/src/symtab.h
index 84113394b5fcce7612b311036c2cfced7194a262..1a50bb95b793c4a1073bdc93f8d60f0e6dfe68b3 100644 (file)
--- a/src/symtab.h
+++ b/src/symtab.h
@@ -1,6 +1,6 @@
 /* Definitions for symtab.c and callers, part of Bison.
 
 /* Definitions for symtab.c and callers, part of Bison.
 

-   Copyright (C) 1984, 1989, 1992, 2000-2002, 2004-2012 Free Software
+   Copyright (C) 1984, 1989, 1992, 2000-2002, 2004-2013 Free Software

    Foundation, Inc.
 
    This file is part of Bison, the GNU Compiler Compiler.
    Foundation, Inc.
 
    This file is part of Bison, the GNU Compiler Compiler.


@@ -46,7 +46,7 @@ typedef enum
 
 /** Internal token numbers. */
 typedef int symbol_number;
 
 /** Internal token numbers. */
 typedef int symbol_number;

-#define SYMBOL_NUMBER_MAXIMUM INT_MAX
+# define SYMBOL_NUMBER_MAXIMUM INT_MAX

 
 
 typedef struct symbol symbol;
 
 
 typedef struct symbol symbol;


@@ -54,13 +54,12 @@ typedef struct symbol symbol;
 /* Declaration status of a symbol.
 
    First, it is "undeclared".  Then, if "undeclared" and used in a
 /* 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".
+   %printer/%destructor, it is "used".  If not "declared" but used in
+   a rule, it is "needed".  Finally, if declared (via a rule for
+   nonterminals, or %token), it is "declared".

 
    When status are checked at the end, "declared" symbols are fine,
 
    When status are checked at the end, "declared" symbols are fine,

-   "used" symbols trigger warnings, otherwise it's an error.
-*/
+   "used" symbols trigger warnings, otherwise it's an error.  */

 
 typedef enum
   {
 
 typedef enum
   {


@@ -92,8 +91,14 @@ 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;
 
   /** Its \c \%type's location.  */
   location type_location;
 


@@ -101,9 +106,9 @@ struct symbol
       symbol.
 
       Access this field only through <tt>symbol</tt>'s interface functions. For
       symbol.
 
       Access this field only through <tt>symbol</tt>'s interface functions. For

-      Example, if <tt>symbol::destructor = NULL</tt> (resp. <tt>symbol::printer
+      example, if <tt>symbol::destructor = NULL</tt> (resp. <tt>symbol::printer

       = NULL</tt>), a default \c \%destructor (resp. \%printer) or a per-type
       = NULL</tt>), a default \c \%destructor (resp. \%printer) or a per-type

-      \c symbol_destructor_printer_get will compute the corect one. */
+      \c symbol_destructor_printer_get will compute the correct one. */

   code_props props[CODE_PROPS_SIZE];
 
   symbol_number number;
   code_props props[CODE_PROPS_SIZE];
 
   symbol_number number;


@@ -121,16 +126,16 @@ struct symbol
 };
 
 /** Undefined user number.  */
 };
 
 /** Undefined user number.  */

-#define USER_NUMBER_UNDEFINED -1
+# define USER_NUMBER_UNDEFINED -1

 
 /* `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_HAS_STRING_ALIAS.  */
 
 /* `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_HAS_STRING_ALIAS.  */

-#define USER_NUMBER_HAS_STRING_ALIAS -9991
+# define USER_NUMBER_HAS_STRING_ALIAS -9991

 
 /* Undefined internal token number.  */
 
 /* Undefined internal token number.  */

-#define NUMBER_UNDEFINED (-1)
+# 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.  */
 symbol *symbol_from_uniqstr (const uniqstr key, location loc);


@@ -149,7 +154,7 @@ symbol *dummy_symbol_get (location loc);
 `--------------------*/
 
 /** Print a symbol (for debugging). */
 `--------------------*/
 
 /** Print a symbol (for debugging). */

-void symbol_print (symbol *s, FILE *f);
+void symbol_print (symbol const *s, FILE *f);

 
 /** Is this a dummy nonterminal?  */
 bool symbol_is_dummy (const symbol *sym);
 
 /** Is this a dummy nonterminal?  */
 bool symbol_is_dummy (const symbol *sym);


@@ -179,15 +184,14 @@ void symbol_code_props_set (symbol *sym, code_props_type kind,
                             code_props const *destructor);
 
 /** Get the computed \c \%destructor or \c %printer for \c sym, which was
                             code_props const *destructor);
 
 /** 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);
+    initialized with \c code_props_none_init if there's no \c \%destructor or
+    \c %printer.  */
+code_props *symbol_code_props_get (symbol *sym, code_props_type kind);

 
 

-/* Set the \c precedence associated with \c 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.  */
+    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);
 
 /** Set the \c class associated with \c sym.  */
 void symbol_precedence_set (symbol *sym, int prec, assoc a, location loc);
 
 /** Set the \c class associated with \c sym.  */


@@ -278,16 +282,4 @@ void symbols_check_defined (void);
    #token_translations.  */
 void symbols_pack (void);
 
    #token_translations.  */
 void symbols_pack (void);
 

-
-/*---------------------------------------.
-| Default %destructor's and %printer's.  |
-`---------------------------------------*/
-
-/** 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_ */
 #endif /* !SYMTAB_H_ */