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
  27 /* A list of symbols, used during the parsing to store the rules.  */
  28 typedef struct symbol_list
  29 {
  30   /**
  31    * Whether this node contains a symbol, a semantic type, a \c <*>, or a
  32    * \c <>.
  33    */
  34   enum {
  35     SYMLIST_SYMBOL, SYMLIST_TYPE,
  36     SYMLIST_DEFAULT_TAGGED, SYMLIST_DEFAULT_TAGLESS
  37   } content_type;
  38   union {
  39     /**
  40      * The symbol or \c NULL iff
  41      * <tt>symbol_list::content_type = SYMLIST_SYMBOL</tt>.
  42      */
  43     symbol *sym;
  44     /**
  45      * The semantic type iff <tt>symbol_list::content_type = SYMLIST_TYPE</tt>.
  46      */
  47     uniqstr type_name;
  48   } content;
  49   location location;
  50
  51   /* If this symbol is the generated lhs for a midrule but this is the rule in
  52      whose rhs it appears, MIDRULE = a pointer to that midrule.  */
  53   struct symbol_list *midrule;
  54
  55   /* If this symbol is the generated lhs for a midrule and this is that
  56      midrule, MIDRULE_PARENT_RULE = a pointer to the rule in whose rhs it
  57      appears, and MIDRULE_PARENT_RHS_INDEX = its rhs index (1-origin) in the
  58      parent rule.  */
  59   struct symbol_list *midrule_parent_rule;
  60   int midrule_parent_rhs_index;
  61
  62   /* The action is attached to the LHS of a rule, but action properties for
  63    * each RHS are also stored here.  */
  64   code_props action_props;
  65
  66   /* Precedence/associativity.  */
  67   symbol *ruleprec;
  68   int dprec;
  69   int merger;
  70   location merger_declaration_location;
  71
  72   /* The list.  */
  73   struct symbol_list *next;
  74 } symbol_list;
  75
  76
  77 /** Create a list containing \c sym at \c loc.  */
  78 symbol_list *symbol_list_sym_new (symbol *sym, location loc);
  79
  80 /** Create a list containing \c type_name at \c loc.  */
  81 symbol_list *symbol_list_type_new (uniqstr type_name, location loc);
  82
  83 /** Create a list containing a \c <*> at \c loc.  */
  84 symbol_list *symbol_list_default_tagged_new (location loc);
  85 /** Create a list containing a \c <> at \c loc.  */
  86 symbol_list *symbol_list_default_tagless_new (location loc);
  87
  88 /** Print this list.
  89
  90   \pre For every node \c n in the list, <tt>n->content_type =
  91   SYMLIST_SYMBOL</tt>.  */
  92 void symbol_list_syms_print (const symbol_list *l, FILE *f);
  93
  94 /** Prepend \c node to \c list.  */
  95 symbol_list *symbol_list_prepend (symbol_list *list, symbol_list *node);
  96
  97 /** Free \c list, but not the items it contains.  */
  98 void symbol_list_free (symbol_list *list);
  99
 100 /** Return the length of \c l. */
 101 int symbol_list_length (symbol_list const *l);
 102
 103 /** Get item \c n in symbol list \c l.  */
 104 symbol_list *symbol_list_n_get (symbol_list *l, int n);
 105
 106 /* Get the data type (alternative in the union) of the value for
 107    symbol N in rule RULE.  */
 108 uniqstr symbol_list_n_type_name_get (symbol_list *l, location loc, int n);
 109
 110 /** Set the \c \%destructor for \c node as \c code at \c loc.  */
 111 void symbol_list_destructor_set (symbol_list *node, char const *code,
 112                                  location loc);
 113
 114 /** Set the \c \%printer for \c node as \c code at \c loc.  */
 115 void symbol_list_printer_set (symbol_list *node, char const *code,
 116                               location loc);
 117
 118 #endif /* !SYMLIST_H_ */