src/symlist.h

   1 /* Lists of symbols for Bison
   2
   3    Copyright (C) 2002, 2005, 2006 Free Software Foundation, Inc.
   4
   5    This file is part of Bison, the GNU Compiler Compiler.
   6
   7    Bison 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 2, or (at your option)
  10    any later version.
  11
  12    Bison 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 Bison; see the file COPYING.  If not, write to
  19    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  20    Boston, MA 02110-1301, USA.  */
  21
  22 #ifndef SYMLIST_H_
  23 # define SYMLIST_H_
  24
  25 # include "location.h"
  26 # include "symtab.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     /** The symbol or \c NULL iff <tt>node_type = SYMLIST_SYMBOL</tt>.  */
  41     symbol *sym;
  42     /** The semantic type iff <tt>node_type = SYMLIST_TYPE</tt>.  */
  43     uniqstr type_name;
  44   } content;
  45   location location;
  46
  47   /* If this symbol is the generated lhs for a midrule but this is the rule in
  48      whose rhs it appears, MIDRULE = a pointer to that midrule.  */
  49   struct symbol_list *midrule;
  50
  51   /* If this symbol is the generated lhs for a midrule and this is that
  52      midrule, MIDRULE_PARENT_RULE = a pointer to the rule in whose rhs it
  53      appears, and MIDRULE_PARENT_RHS_INDEX = its rhs index (1-origin) in the
  54      parent rule.  */
  55   struct symbol_list *midrule_parent_rule;
  56   int midrule_parent_rhs_index;
  57
  58   /* The action is attached to the LHS of a rule. */
  59   const char *action;
  60   location action_location;
  61
  62   /* Whether this symbol's value is used in the current action.  */
  63   bool used;
  64
  65   /* Precedence/associativity.  */
  66   symbol *ruleprec;
  67   int dprec;
  68   int merger;
  69   location merger_declaration_location;
  70
  71   /* The list.  */
  72   struct symbol_list *next;
  73 } symbol_list;
  74
  75
  76 /** Create a list containing \c sym at \c loc.  */
  77 symbol_list *symbol_list_sym_new (symbol *sym, location loc);
  78
  79 /** Create a list containing \c type_name at \c loc.  */
  80 symbol_list *symbol_list_type_new (uniqstr type_name, location loc);
  81
  82 /** Create a list containing a \c <*> at \c loc.  */
  83 symbol_list *symbol_list_default_tagged_new (location loc);
  84 /** Create a list containing a \c <!> at \c loc.  */
  85 symbol_list *symbol_list_default_tagless_new (location loc);
  86
  87 /** Print this list.
  88
  89   \pre For every node \c n in the list, <tt>n->content_type =
  90   SYMLIST_SYMBOL</tt>.  */
  91 void symbol_list_syms_print (const symbol_list *l, FILE *f);
  92
  93 /** Prepend \c node to \c list.  */
  94 symbol_list *symbol_list_prepend (symbol_list *list, symbol_list *node);
  95
  96 /** Free \c list, but not the items it contains.  */
  97 void symbol_list_free (symbol_list *list);
  98
  99 /** Return the length of \c l. */
 100 int symbol_list_length (symbol_list const *l);
 101
 102 /** Get item \c n in symbol list \c l.  */
 103 symbol_list *symbol_list_n_get (symbol_list *l, int n);
 104
 105 /* Get the data type (alternative in the union) of the value for
 106    symbol N in rule RULE.  */
 107 uniqstr symbol_list_n_type_name_get (symbol_list *l, location loc, int n);
 108
 109 /** The item \c n in symbol list \c l is \c used.  */
 110 void symbol_list_n_used_set (symbol_list *l, int n, bool used);
 111
 112 /** Set the \c \%destructor for \c node as \c destructor at \c loc.  */
 113 void symbol_list_destructor_set (symbol_list *node, const char *destructor,
 114                                  location loc);
 115
 116 /** Set the \c \%printer for \c node as \c printer at \c loc.  */
 117 void symbol_list_printer_set (symbol_list *node, const char *printer,
 118                               location loc);
 119
 120 #endif /* !SYMLIST_H_ */