factor the handling of m4 escaping

[bison.git] / src / symlist.h

diff --git a/src/symlist.h b/src/symlist.h
index 480c97d444f1c28f989df475b6f647724cd908bb..43936b294147d2b851c701dbcd4eb558dadbb1bc 100644 (file)
--- a/src/symlist.h
+++ b/src/symlist.h
@@ -1,79 +1,129 @@
 /* Lists of symbols for Bison
 
 /* Lists of symbols for Bison
 

-   Copyright (C) 2002, 2005 Free Software Foundation, Inc.
+   Copyright (C) 2002, 2005-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/>.  */

 
 #ifndef SYMLIST_H_
 # define SYMLIST_H_
 
 # include "location.h"
 
 #ifndef SYMLIST_H_
 # define SYMLIST_H_
 
 # include "location.h"

+# include "scan-code.h"

 # include "symtab.h"
 # include "symtab.h"

+# include "named-ref.h"

 
 /* A list of symbols, used during the parsing to store the rules.  */
 typedef struct symbol_list
 {
 
 /* A list of symbols, used during the parsing to store the rules.  */
 typedef struct symbol_list
 {

-  /* The symbol.  */
-  symbol *sym;
+  /**
+   * Whether this node contains a symbol, a semantic type, a \c <*>, or a
+   * \c <>.
+   */
+  enum {
+    SYMLIST_SYMBOL, SYMLIST_TYPE,
+    SYMLIST_DEFAULT_TAGGED, SYMLIST_DEFAULT_TAGLESS
+  } content_type;
+  union {
+    /**
+     * The symbol or \c NULL iff
+     * <tt>symbol_list::content_type = SYMLIST_SYMBOL</tt>.
+     */
+    symbol *sym;
+    /**
+     * The semantic type iff <tt>symbol_list::content_type = SYMLIST_TYPE</tt>.
+     */
+    uniqstr type_name;
+  } content;

   location location;
 
   location location;
 

-  /* The action is attached to the LHS of a rule. */
-  const char *action;
-  location action_location;
+  /* Proper location of the symbol, not all the rule */
+  location sym_loc;

 
 

-  /* Whether this symbol's value is used in the current action. */
-  bool used;
+  /* 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, but action properties for
+   * each RHS are also stored here.  */
+  code_props action_props;

 
   /* Precedence/associativity.  */
   symbol *ruleprec;
   int dprec;
   int merger;
 
   /* Precedence/associativity.  */
   symbol *ruleprec;
   int dprec;
   int merger;

+  location merger_declaration_location;
+
+  /* Named reference. */
+  named_ref *named_ref;

 
   /* The list.  */
   struct symbol_list *next;
 } symbol_list;
 
 
 
   /* The list.  */
   struct symbol_list *next;
 } symbol_list;
 
 

-/* Create a list containing SYM at LOC.  */
-symbol_list *symbol_list_new (symbol *sym, location loc);
+/** Create a list containing \c sym at \c loc.  */
+symbol_list *symbol_list_sym_new (symbol *sym, location loc);
+
+/** Create a list containing \c type_name at \c loc.  */
+symbol_list *symbol_list_type_new (uniqstr type_name, location loc);

 
 

-/* Print it.  */
-void symbol_list_print (const symbol_list *l, FILE *f);
+/** Create a list containing a \c <*> at \c loc.  */
+symbol_list *symbol_list_default_tagged_new (location loc);
+/** Create a list containing a \c <> at \c loc.  */
+symbol_list *symbol_list_default_tagless_new (location loc);

 
 

-/* Prepend SYM at LOC to the LIST.  */
-symbol_list *symbol_list_prepend (symbol_list *l,
-                                 symbol *sym,
-                                 location loc);
+/** Print this list.

 
 

-/* Free the LIST, but not the symbols it contains.  */
-void symbol_list_free (symbol_list *l);
+  \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);

 
 

-/* Return its length. */
-unsigned int symbol_list_length (const symbol_list *l);
+/** Prepend \c node to \c list.  */
+symbol_list *symbol_list_prepend (symbol_list *list, symbol_list *node);

 
 

-/* Get symbol N in symbol list L.  */
+/** 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.  */
 uniqstr symbol_list_n_type_name_get (symbol_list *l, location loc, int n);
 
 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.  */
 uniqstr symbol_list_n_type_name_get (symbol_list *l, location loc, int n);
 

-/* The symbol N in symbol list L is USED.  */
-void symbol_list_n_used_set (symbol_list *l, int n, bool used);
+/* Check whether the node is a border element of a rule. */
+bool symbol_list_null (symbol_list *node);
+
+/** Set the \c \%destructor for \c node as \c code at \c loc.  */
+void symbol_list_destructor_set (symbol_list *node, char const *code,
+                                 location loc);
+
+/** Set the \c \%printer for \c node as \c code at \c loc.  */
+void symbol_list_printer_set (symbol_list *node, char const *code,
+                              location loc);

 
 #endif /* !SYMLIST_H_ */
 
 #endif /* !SYMLIST_H_ */