src/gram.h

   1 /* Data definitions for internal representation of bison's input,
   2    Copyright 1984, 1986, 1989, 1992, 2001  Free Software Foundation, Inc.
   3
   4    This file is part of Bison, the GNU Compiler Compiler.
   5
   6    Bison is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2, or (at your option)
   9    any later version.
  10
  11    Bison is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with Bison; see the file COPYING.  If not, write to
  18    the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  19    Boston, MA 02111-1307, USA.  */
  20
  21 #ifndef GRAM_H_
  22 # define GRAM_H_
  23
  24 /* representation of the grammar rules:
  25
  26    ntokens is the number of tokens, and nvars is the number of
  27    variables (nonterminals).  nsyms is the total number, ntokens +
  28    nvars.
  29
  30    (the true number of token values assigned is ntokens reduced by one
  31    for each alias declaration)
  32
  33    Each symbol (either token or variable) receives a symbol number.
  34    Numbers 0 to ntokens-1 are for tokens, and ntokens to nsyms-1 are
  35    for variables.  Symbol number zero is the end-of-input token.  This
  36    token is counted in ntokens.
  37
  38    The rules receive rule numbers 1 to nrules in the order they are
  39    written.  Actions and guards are accessed via the rule number.
  40
  41    The rules themselves are described by several arrays: amongst which
  42    RITEM, and RULES.
  43
  44    RULES is an array of struct rule_s, which members are:
  45
  46    RULES[R].lhs -- the symbol number of the left hand side of
  47    rule R.  If -1, the rule has been thrown out by reduce.c and should
  48    be ignored.
  49
  50    RULES[R].rhs -- the index in RITEM of the beginning of the
  51    portion for rule R.
  52
  53    RULES[R].prec -- the precedence level of R.
  54
  55    RULES[R].precsym -- the symbol-number of the symbol in %prec
  56    for R (if any).
  57
  58    RULES[R].assoc -- the associativity of R.
  59
  60    RULES[R].line -- the line where R was defined.
  61
  62    RULES[R].useful -- TRUE iff the rule is used.
  63
  64    The right hand side is stored as symbol numbers in a portion of
  65    RITEM.
  66
  67    The length of the portion is one greater than the number of symbols
  68    in the rule's right hand side.  The last element in the portion
  69    contains minus R, which identifies it as the end of a portion and
  70    says which rule it is for.
  71
  72    The portions of RITEM come in order of increasing rule number and
  73    are followed by an element which is zero to mark the end.  nitems
  74    is the total length of ritem, not counting the final zero.  Each
  75    element of ritem is called an "item" and its index in ritem is an
  76    item number.
  77
  78    Item numbers are used in the finite state machine to represent
  79    places that parsing can get to.
  80
  81    SYMBOLS[I]->PREC records the precedence level of each symbol.
  82
  83    Precedence levels are assigned in increasing order starting with 1
  84    so that numerically higher precedence values mean tighter binding
  85    as they ought to.  Zero as a symbol or rule's precedence means none
  86    is assigned.
  87
  88    Associativities are recorded similarly in rassoc and sassoc.  */
  89
  90
  91 #define ISTOKEN(s)      ((s) < ntokens)
  92 #define ISVAR(s)        ((s) >= ntokens)
  93
  94 extern int nitems;
  95 extern int nrules;
  96 extern int nsyms;
  97 extern int ntokens;
  98 extern int nvars;
  99
 100 extern short *ritem;
 101 extern int nritems;
 102
 103 extern int start_symbol;
 104
 105 /* associativity values in elements of rassoc, sassoc.  */
 106 typedef enum
 107 {
 108   right_assoc,
 109   left_assoc,
 110   non_assoc
 111 } associativity;
 112
 113
 114 typedef struct rule_s
 115 {
 116   short lhs;
 117   short rhs;
 118   short prec;
 119   short precsym;
 120   short assoc;
 121   short line;
 122   bool useful;
 123
 124   const char *action;
 125   short action_line;
 126
 127   const char *guard;
 128   short guard_line;
 129 } rule_t;
 130
 131 extern struct rule_s *rules;
 132
 133 /* Table of the symbols, indexed by the symbol number. */
 134 extern struct bucket **symbols;
 135
 136 /* token translation table: indexed by a token number as returned by
 137    the user's yylex routine, it yields the internal token number used
 138    by the parser and throughout bison.  */
 139
 140 extern short *token_translations;
 141 extern int max_user_token_number;
 142
 143 /* SEMANTIC_PARSER is nonzero if the input file says to use the hairy
 144    parser that provides for semantic error recovery.  If it is zero,
 145    the yacc-compatible simplified parser is used.  */
 146
 147 extern int semantic_parser;
 148
 149 /* PURE_PARSER is nonzero if should generate a parser that is all pure
 150    and reentrant.  */
 151
 152 extern int pure_parser;
 153
 154 /* ERROR_TOKEN_NUMBER is the token number of the error token.  */
 155
 156 extern int error_token_number;
 157
 158
 159 /* Dump RITEM for traces. */
 160 void ritem_print PARAMS ((FILE *out));
 161
 162 /* Return the size of the longest rule RHS.  */
 163 size_t ritem_longest_rhs PARAMS ((void));
 164
 165 #endif /* !GRAM_H_ */