src/symlist.h

   1 /* Lists of symbols for Bison
   2
   3    Copyright (C) 2002, 2005, 2006, 2007 Free Software Foundation, Inc.
   4
   5    This file is part of Bison, the GNU Compiler Compiler.
   6
   7    This program is free software: you can redistribute it and/or modify
   8    it under the terms of the GNU General Public License as published by
   9    the Free Software Foundation, either version 3 of the License, or
  10    (at your option) any later version.
  11
  12    This program is distributed in the hope that it will be useful,
  13    but WITHOUT ANY WARRANTY; without even the implied warranty of
  14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15    GNU General Public License for more details.
  16
  17    You should have received a copy of the GNU General Public License
  18    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
  19
  20 #ifndef SYMLIST_H_
  21 # define SYMLIST_H_
  22
  23 # include "location.h"
  24 # include "scan-code.h"
  25 # include "symtab.h"
  26 # include "named-ref.h"
  27
  28 /* A list of symbols, used during the parsing to store the rules.  */
  29 typedef struct symbol_list
  30 {
  31   /**
  32    * Whether this node contains a symbol, a semantic type, a \c <*>, or a
  33    * \c <>.
  34    */
  35   enum {
  36     SYMLIST_SYMBOL, SYMLIST_TYPE,
  37     SYMLIST_DEFAULT_TAGGED, SYMLIST_DEFAULT_TAGLESS
  38   } content_type;
  39   union {
  40     /**
  41      * The symbol or \c NULL iff
  42      * <tt>symbol_list::content_type = SYMLIST_SYMBOL</tt>.
  43      */
  44     symbol *sym;
  45     /**
  46      * The semantic type iff <tt>symbol_list::content_type = SYMLIST_TYPE</tt>.
  47      */
  48     uniqstr type_name;
  49   } content;
  50   location location;
  51
  52   /* Proper location of the symbol, not all the rule */
  53   location sym_loc;
  54
  55   /* If this symbol is the generated lhs for a midrule but this is the rule in
  56      whose rhs it appears, MIDRULE = a pointer to that midrule.  */
  57   struct symbol_list *midrule;
  58
  59   /* If this symbol is the generated lhs for a midrule and this is that
  60      midrule, MIDRULE_PARENT_RULE = a pointer to the rule in whose rhs it
  61      appears, and MIDRULE_PARENT_RHS_INDEX = its rhs index (1-origin) in the
  62      parent rule.  */
  63   struct symbol_list *midrule_parent_rule;
  64   int midrule_parent_rhs_index;
  65
  66   /* The action is attached to the LHS of a rule, but action properties for
  67    * each RHS are also stored here.  */
  68   code_props action_props;
  69
  70   /* Precedence/associativity.  */
  71   symbol *ruleprec;
  72   int dprec;
  73   int merger;
  74   location merger_declaration_location;
  75
  76   /* Named reference. */
  77   named_ref *named_ref;
  78
  79   /* The list.  */
  80   struct symbol_list *next;
  81 } symbol_list;
  82
  83
  84 /** Create a list containing \c sym at \c loc.  */
  85 symbol_list *symbol_list_sym_new (symbol *sym, location loc);
  86
  87 /** Create a list containing \c type_name at \c loc.  */
  88 symbol_list *symbol_list_type_new (uniqstr type_name, location loc);
  89
  90 /** Create a list containing a \c <*> at \c loc.  */
  91 symbol_list *symbol_list_default_tagged_new (location loc);
  92 /** Create a list containing a \c <> at \c loc.  */
  93 symbol_list *symbol_list_default_tagless_new (location loc);
  94
  95 /** Print this list.
  96
  97   \pre For every node \c n in the list, <tt>n->content_type =
  98   SYMLIST_SYMBOL</tt>.  */
  99 void symbol_list_syms_print (const symbol_list *l, FILE *f);
 100
 101 /** Prepend \c node to \c list.  */
 102 symbol_list *symbol_list_prepend (symbol_list *list, symbol_list *node);
 103
 104 /** Free \c list, but not the items it contains.  */
 105 void symbol_list_free (symbol_list *list);
 106
 107 /** Return the length of \c l. */
 108 int symbol_list_length (symbol_list const *l);
 109
 110 /** Get item \c n in symbol list \c l.  */
 111 symbol_list *symbol_list_n_get (symbol_list *l, int n);
 112
 113 /* Get the data type (alternative in the union) of the value for
 114    symbol N in rule RULE.  */
 115 uniqstr symbol_list_n_type_name_get (symbol_list *l, location loc, int n);
 116
 117 /* Check whether the node is a border element of a rule. */
 118 bool symbol_list_null (symbol_list *node);
 119
 120 /** Set the \c \%destructor for \c node as \c code at \c loc.  */
 121 void symbol_list_destructor_set (symbol_list *node, char const *code,
 122                                  location loc);
 123
 124 /** Set the \c \%printer for \c node as \c code at \c loc.  */
 125 void symbol_list_printer_set (symbol_list *node, char const *code,
 126                               location loc);
 127
 128 #endif /* !SYMLIST_H_ */