src/symlist.h

   1 /* Lists of symbols for Bison
   2
   3    Copyright (C) 2002, 2005 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   /* The symbol.  */
  32   symbol *sym;
  33   location location;
  34
  35   /* If this symbol is the generated lhs for a midrule but this is the rule in
  36      whose rhs it appears, MIDRULE = a pointer to that midrule.  */
  37   struct symbol_list *midrule;
  38
  39   /* If this symbol is the generated lhs for a midrule and this is that
  40      midrule, MIDRULE_PARENT_RULE = a pointer to the rule in whose rhs it
  41      appears, and MIDRULE_PARENT_RHS_INDEX = its rhs index (1-origin) in the
  42      parent rule.  */
  43   struct symbol_list *midrule_parent_rule;
  44   int midrule_parent_rhs_index;
  45
  46   /* The action is attached to the LHS of a rule. */
  47   const char *action;
  48   location action_location;
  49
  50   /* Whether this symbol's value is used in the current action. */
  51   bool used;
  52
  53   /* Precedence/associativity.  */
  54   symbol *ruleprec;
  55   int dprec;
  56   int merger;
  57
  58   /* The list.  */
  59   struct symbol_list *next;
  60 } symbol_list;
  61
  62
  63 /* Create a list containing SYM at LOC.  */
  64 symbol_list *symbol_list_new (symbol *sym, location loc);
  65
  66 /* Print it.  */
  67 void symbol_list_print (const symbol_list *l, FILE *f);
  68
  69 /* Prepend SYM at LOC to the LIST.  */
  70 symbol_list *symbol_list_prepend (symbol_list *l,
  71                                   symbol *sym,
  72                                   location loc);
  73
  74 /* Free the LIST, but not the symbols it contains.  */
  75 void symbol_list_free (symbol_list *l);
  76
  77 /* Return its length. */
  78 unsigned int symbol_list_length (const symbol_list *l);
  79
  80 /* Get symbol N in symbol list L.  */
  81 symbol_list *symbol_list_n_get (symbol_list *l, int n);
  82
  83 /* Get the data type (alternative in the union) of the value for
  84    symbol N in rule RULE.  */
  85 uniqstr symbol_list_n_type_name_get (symbol_list *l, location loc, int n);
  86
  87 /* The symbol N in symbol list L is USED.  */
  88 void symbol_list_n_used_set (symbol_list *l, int n, bool used);
  89
  90 #endif /* !SYMLIST_H_ */