2006-10-08 Paolo Bonzini <bonzini@gnu.org>

[bison.git] / src / symlist.h

diff --git a/src/symlist.h b/src/symlist.h
index 02af5bbc79ca348205f8cc0e3483ca420d40ad20..6acb982e3116e259ac70d08e7191c9af34594e0d 100644 (file)
--- a/src/symlist.h
+++ b/src/symlist.h
@@ -1,5 +1,6 @@
 /* Lists of symbols for Bison
-   Copyright (C) 2002  Free Software Foundation, Inc.
+
+   Copyright (C) 2002, 2005, 2006 Free Software Foundation, Inc.
 
    This file is part of Bison, the GNU Compiler Compiler.
 
@@ -15,50 +16,100 @@
 
    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., 59 Temple Place - Suite 330,
-   Boston, MA 02111-1307, USA.  */
+   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+   Boston, MA 02110-1301, USA.  */
 
 #ifndef SYMLIST_H_
 # define SYMLIST_H_
 
-# include "symtab.h"
 # include "location.h"
+# include "symtab.h"
 
-typedef struct symbol_list_s
+/* A list of symbols, used during the parsing to store the rules.  */
+typedef struct symbol_list
 {
-  struct symbol_list_s *next;
-  symbol_t *sym;
-  location_t location;
+  /**
+   * Whether this node contains a symbol, a semantic type, or a
+   * \c \%symbol-default.
+   */
+  enum { SYMLIST_SYMBOL, SYMLIST_TYPE, SYMLIST_DEFAULT } content_type;
+  union {
+    /** The symbol or \c NULL iff <tt>node_type = SYMLIST_SYMBOL</tt>.  */
+    symbol *sym;
+    /** The semantic type iff <tt>node_type = SYMLIST_TYPE</tt>.  */
+    uniqstr type_name;
+  } content;
+  location location;
+
+  /* If this symbol is the generated lhs for a midrule but this is the rule in
+     whose rhs it appears, MIDRULE = a pointer to that midrule.  */
+  struct symbol_list *midrule;
+
+  /* If this symbol is the generated lhs for a midrule and this is that
+     midrule, MIDRULE_PARENT_RULE = a pointer to the rule in whose rhs it
+     appears, and MIDRULE_PARENT_RHS_INDEX = its rhs index (1-origin) in the
+     parent rule.  */
+  struct symbol_list *midrule_parent_rule;
+  int midrule_parent_rhs_index;
 
   /* The action is attached to the LHS of a rule. */
   const char *action;
-  location_t action_location;
+  location action_location;
 
-  symbol_t *ruleprec;
+  /* Whether this symbol's value is used in the current action.  */
+  bool used;
+
+  /* Precedence/associativity.  */
+  symbol *ruleprec;
   int dprec;
   int merger;
-} symbol_list_t;
+  location merger_declaration_location;
+
+  /* The list.  */
+  struct symbol_list *next;
+} symbol_list;
+
 
+/** Create a list containing \c sym at \c loc.  */
+symbol_list *symbol_list_sym_new (symbol *sym, location loc);
 
-/* Create a list containing SYMBOL at LOCATION.  */
-symbol_list_t *symbol_list_new PARAMS ((symbol_t *sym, location_t location));
+/** Create a list containing \c type_name at \c loc.  */
+symbol_list *symbol_list_type_new (uniqstr type_name, location loc);
 
+/** Create a list containing a \c \%symbol-default at \c loc.  */
+symbol_list *symbol_list_default_new (location loc);
 
-/* Prepend SYMBOL at LOCATION to the LIST.  */
-symbol_list_t * symbol_list_prepend PARAMS ((symbol_list_t *list,
-                                            symbol_t *symbol,
-                                            location_t location));
+/** Print this list.
 
+  \pre For every node \c n in the list, <tt>n->content_type =
+  SYMLIST_SYMBOL</tt>.  */
+void symbol_list_syms_print (const symbol_list *l, FILE *f);
 
-/* Free the LIST, but not the symbols it contains.  */
-void symbol_list_free PARAMS ((symbol_list_t *list));
+/** Prepend \c node to \c list.  */
+symbol_list *symbol_list_prepend (symbol_list *list, symbol_list *node);
 
-/* Return its length. */
-unsigned int symbol_list_length PARAMS ((symbol_list_t *list));
+/** Free \c list, but not the items it contains.  */
+void symbol_list_free (symbol_list *list);
+
+/** Return the length of \c l. */
+int symbol_list_length (symbol_list const *l);
+
+/** Get item \c n in symbol list \c l.  */
+symbol_list *symbol_list_n_get (symbol_list *l, int n);
 
 /* Get the data type (alternative in the union) of the value for
    symbol N in rule RULE.  */
-char *symbol_list_n_type_name_get PARAMS ((symbol_list_t *rule,
-                                          location_t location, int n));
+uniqstr symbol_list_n_type_name_get (symbol_list *l, location loc, int n);
+
+/** The item \c n in symbol list \c l is \c used.  */
+void symbol_list_n_used_set (symbol_list *l, int n, bool used);
+
+/** Set the \c \%destructor for \c node as \c destructor at \c loc.  */
+void symbol_list_destructor_set (symbol_list *node, const char *destructor,
+                                 location loc);
+
+/** Set the \c \%printer for \c node as \c printer at \c loc.  */
+void symbol_list_printer_set (symbol_list *node, const char *printer,
+                              location loc);
 
 #endif /* !SYMLIST_H_ */