Really add m4sugar to the repo.

[bison.git] / src / gram.h

diff --git a/src/gram.h b/src/gram.h
index 4a0450259bee6c8895c13c845f5a0251c1f810f7..75f4653ea7bab1a2ead7e3408c449da10b4d5952 100644 (file)
--- a/src/gram.h
+++ b/src/gram.h
@@ -1,5 +1,5 @@
 /* Data definitions for internal representation of bison's input,
 /* Data definitions for internal representation of bison's input,

-   Copyright (C) 1984, 1986, 1989, 1992 Free Software Foundation, Inc.
+   Copyright 1984, 1986, 1989, 1992, 2001  Free Software Foundation, Inc.

 
    This file is part of Bison, the GNU Compiler Compiler.
 
 
    This file is part of Bison, the GNU Compiler Compiler.
 


@@ -21,57 +21,81 @@
 #ifndef GRAM_H_
 # define GRAM_H_
 
 #ifndef GRAM_H_
 # define GRAM_H_
 

-/* representation of the grammar rules:
+/* Representation of the grammar rules:

 
 

-   ntokens is the number of tokens, and nvars is the number of
-   variables (nonterminals).  nsyms is the total number, ntokens +
+   NTOKENS is the number of tokens, and NVARS is the number of
+   variables (nonterminals).  NSYMS is the total number, ntokens +

    nvars.
 
    nvars.
 

-   (the true number of token values assigned is ntokens reduced by one
-   for each alias declaration)
-

    Each symbol (either token or variable) receives a symbol number.
    Each symbol (either token or variable) receives a symbol number.

-   Numbers 0 to ntokens-1 are for tokens, and ntokens to nsyms-1 are
-   for variables.  Symbol number zero is the end-of-input token.  This
-   token is counted in ntokens.
+   Numbers 0 to NTOKENS - 1 are for tokens, and NTOKENS to NSYMS - 1
+   are for variables.  Symbol number zero is the end-of-input token.
+   This token is counted in ntokens.  The true number of token values
+   assigned is NTOKENS reduced by one for each alias declaration.
+
+   The rules receive rule numbers 1 to NRULES in the order they are
+   written.  More precisely Bison augments the grammar with the
+   initial rule, `$axiom: START-SYMBOL EOF', which is numbered 1, all
+   the user rules are 2, 3 etc.  Each time a rule number is presented
+   to the user, we subtract 1, so *displayed* rule numbers are 0, 1,
+   2...
+
+   Internally, we cannot use the number 0 for a rule because for
+   instance RITEM stores both symbol (the RHS) and rule numbers: the
+   symbols are shorts >= 0, and rule number are stored negative.
+   Therefore 0 cannot be used, since it would be both the rule number
+   0, and the token EOF).
+
+   Actions and guards are accessed via the rule number.
+
+   The rules themselves are described by several arrays: amongst which
+   RITEM, and RULES.
+
+   RULES is an array of struct rule_s, which members are:
+
+   RULES[R].lhs -- the symbol number of the left hand side of rule R.
+   If -1, the rule has been thrown out by reduce.c and should be
+   ignored.
+
+   RULES[R].rhs -- the index in RITEM of the beginning of the portion
+   for rule R.
+
+   RULES[R].prec -- the precedence level of R.
+
+   RULES[R].precsym -- the symbol-number of the symbol in %prec for R
+   (if any).
+
+   RULES[R].assoc -- the associativity of R.

 
 

-   The rules receive rule numbers 1 to nrules in the order they are
-   written.  Actions and guards are accessed via the rule number.
+   RULES[R].line -- the line where R was defined.

 
 

-   The rules themselves are described by three arrays: rrhs, rlhs and
-   ritem.  rlhs[R] is the symbol number of the left hand side of rule
-   R.  The right hand side is stored as symbol numbers in a portion of
-   ritem.  rrhs[R] contains the index in ritem of the beginning of the
-   portion for rule R.
+   RULES[R].useful -- TRUE iff the rule is used.

 
 

-   If rlhs[R] is -1, the rule has been thrown out by reduce.c and
-   should be ignored.
+   The right hand side is stored as symbol numbers in a portion of
+   RITEM.

 
    The length of the portion is one greater than the number of symbols
    in the rule's right hand side.  The last element in the portion
    contains minus R, which identifies it as the end of a portion and
    says which rule it is for.
 
 
    The length of the portion is one greater than the number of symbols
    in the rule's right hand side.  The last element in the portion
    contains minus R, which identifies it as the end of a portion and
    says which rule it is for.
 

-   The portions of ritem come in order of increasing rule number and
+   The portions of RITEM come in order of increasing rule number and

    are followed by an element which is zero to mark the end.  nitems
    is the total length of ritem, not counting the final zero.  Each
    are followed by an element which is zero to mark the end.  nitems
    is the total length of ritem, not counting the final zero.  Each

-   element of ritem is called an "item" and its index in ritem is an
+   element of RITEM is called an "item" and its index in RITEM is an

    item number.
 
    Item numbers are used in the finite state machine to represent
    places that parsing can get to.
 
    item number.
 
    Item numbers are used in the finite state machine to represent
    places that parsing can get to.
 

-   Precedence levels are recorded in the vectors sprec and rprec.
-   sprec records the precedence level of each symbol, rprec the
-   precedence level of each rule.  rprecsym is the symbol-number of
-   the symbol in %prec for this rule (if any).
+   SYMBOLS[I]->prec records the precedence level of each symbol.

 
    Precedence levels are assigned in increasing order starting with 1
    so that numerically higher precedence values mean tighter binding
    as they ought to.  Zero as a symbol or rule's precedence means none
    is assigned.
 
 
    Precedence levels are assigned in increasing order starting with 1
    so that numerically higher precedence values mean tighter binding
    as they ought to.  Zero as a symbol or rule's precedence means none
    is assigned.
 

-   Associativities are recorded similarly in rassoc and sassoc.  */
+   Associativities are recorded similarly in SYMBOLS[I]->assoc.  */

 
 
 #define        ISTOKEN(s)      ((s) < ntokens)
 
 
 #define        ISTOKEN(s)      ((s) < ntokens)


@@ -84,19 +108,11 @@ extern int ntokens;
 extern int nvars;
 
 extern short *ritem;
 extern int nvars;
 
 extern short *ritem;

-extern short *rlhs;
-extern short *rrhs;
-extern short *rprec;
-extern short *rprecsym;
-extern short *sprec;
-extern short *rassoc;
-extern short *sassoc;
-extern short *rline;           /* Source line number of each rule */
+extern int nritems;

 
 extern int start_symbol;
 
 
 extern int start_symbol;
 

-
-/* associativity values in elements of rassoc, sassoc.  */
+/* Associativity values for tokens and rules.  */

 typedef enum
 {
   right_assoc,
 typedef enum
 {
   right_assoc,


@@ -105,15 +121,33 @@ typedef enum
 } associativity;
 
 
 } associativity;
 
 

+typedef struct rule_s
+{
+  short lhs;
+  short rhs;
+  short prec;
+  short precsym;
+  associativity assoc;
+  short line;
+  bool useful;
+
+  const char *action;
+  short action_line;
+
+  const char *guard;
+  short guard_line;
+} rule_t;
+
+extern struct rule_s *rules;
+
+/* Table of the symbols, indexed by the symbol number. */
+extern struct bucket **symbols;
+

 /* token translation table: indexed by a token number as returned by
    the user's yylex routine, it yields the internal token number used
 /* token translation table: indexed by a token number as returned by
    the user's yylex routine, it yields the internal token number used

-   by the parser and throughout bison.  If translations is zero, the
-   translation table is not used because the two kinds of token
-   numbers are the same.  (It is noted in reader.c that "Nowadays
-   translations is always set to 1...") */
+   by the parser and throughout bison.  */

 
 extern short *token_translations;
 
 extern short *token_translations;

-extern int translations;

 extern int max_user_token_number;
 
 /* SEMANTIC_PARSER is nonzero if the input file says to use the hairy
 extern int max_user_token_number;
 
 /* SEMANTIC_PARSER is nonzero if the input file says to use the hairy


@@ -130,4 +164,12 @@ extern int pure_parser;
 /* ERROR_TOKEN_NUMBER is the token number of the error token.  */
 
 extern int error_token_number;
 /* ERROR_TOKEN_NUMBER is the token number of the error token.  */
 
 extern int error_token_number;

+
+
+/* Dump RITEM for traces. */
+void ritem_print PARAMS ((FILE *out));
+
+/* Return the size of the longest rule RHS.  */
+size_t ritem_longest_rhs PARAMS ((void));
+

 #endif /* !GRAM_H_ */
 #endif /* !GRAM_H_ */