src/gram.h

/* Data definitions for internal representation of bison's input,
   Copyright 1984, 1986, 1989, 1992, 2001  Free Software Foundation, Inc.

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

   Bison is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2, or (at your option)
   any later version.

   Bison is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with Bison; see the file COPYING.  If not, write to
   the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
   Boston, MA 02111-1307, USA.  */

#ifndef GRAM_H_
# define GRAM_H_

/* 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 +
   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.
   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 rules receive rule numbers 1 to nrules in the order they are
   written.  Actions and guards are accessed via the rule number.

   The rules themselves are described by several arrays: amongst which
   RITEM, and RULE_TABLE.

   RULE_TABLE is an array of struct rule_s, which members are:

   RULE_TABLE[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.

   RULE_TABLE[R].rhs -- the index in RITEM of the beginning of the
   portion for rule R.

   RULE_TABLE[R].prec -- the precedence level of R.

   RULE_TABLE[R].precsym -- the symbol-number of the symbol in %prec
   for R (if any).

   RULE_TABLE[R].assoc -- the associativity of R.

   RULE_TABLE[R].line -- the line where R was defined.

   RULE_TABLE[R].useful -- TRUE iff the rule is used.

   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 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
   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.

   SPREC 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.

   Associativities are recorded similarly in rassoc and sassoc.  */


#define	ISTOKEN(s)	((s) < ntokens)
#define	ISVAR(s)	((s) >= ntokens)

extern int nitems;
extern int nrules;
extern int nsyms;
extern int ntokens;
extern int nvars;

extern short *ritem;

extern short *sprec;
extern short *sassoc;

extern int start_symbol;

/* associativity values in elements of rassoc, sassoc.  */
typedef enum
{
  right_assoc,
  left_assoc,
  non_assoc
} associativity;


typedef struct rule_s
{
  short lhs;
  short rhs;
  short prec;
  short precsym;
  short assoc;
  short line;
  bool useful;
} rule_t;

extern struct rule_s *rule_table;

/* 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.  */

extern short *token_translations;
extern int max_user_token_number;

/* SEMANTIC_PARSER is nonzero if the input file says to use the hairy
   parser that provides for semantic error recovery.  If it is zero,
   the yacc-compatible simplified parser is used.  */

extern int semantic_parser;

/* PURE_PARSER is nonzero if should generate a parser that is all pure
   and reentrant.  */

extern int pure_parser;

/* 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_ */
Commit	Line	Data
	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 RULE_TABLE.
	43
	44	RULE_TABLE is an array of struct rule_s, which members are:
	45
	46	RULE_TABLE[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	RULE_TABLE[R].rhs -- the index in RITEM of the beginning of the
	51	portion for rule R.
	52
	53	RULE_TABLE[R].prec -- the precedence level of R.
	54
	55	RULE_TABLE[R].precsym -- the symbol-number of the symbol in %prec
	56	for R (if any).
	57
	58	RULE_TABLE[R].assoc -- the associativity of R.
	59
	60	RULE_TABLE[R].line -- the line where R was defined.
	61
	62	RULE_TABLE[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	SPREC 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
	102	extern short *sprec;
	103	extern short *sassoc;
	104
	105	extern int start_symbol;
	106
	107	/* associativity values in elements of rassoc, sassoc. */
	108	typedef enum
	109	{
	110	right_assoc,
	111	left_assoc,
	112	non_assoc
	113	} associativity;
	114
	115
	116	typedef struct rule_s
	117	{
	118	short lhs;
	119	short rhs;
	120	short prec;
	121	short precsym;
	122	short assoc;
	123	short line;
	124	bool useful;
	125	} rule_t;
	126
	127	extern struct rule_s *rule_table;
	128
	129	/* token translation table: indexed by a token number as returned by
	130	the user's yylex routine, it yields the internal token number used
	131	by the parser and throughout bison. */
	132
	133	extern short *token_translations;
	134	extern int max_user_token_number;
	135
	136	/* SEMANTIC_PARSER is nonzero if the input file says to use the hairy
	137	parser that provides for semantic error recovery. If it is zero,
	138	the yacc-compatible simplified parser is used. */
	139
	140	extern int semantic_parser;
	141
	142	/* PURE_PARSER is nonzero if should generate a parser that is all pure
	143	and reentrant. */
	144
	145	extern int pure_parser;
	146
	147	/* ERROR_TOKEN_NUMBER is the token number of the error token. */
	148
	149	extern int error_token_number;
	150
	151
	152	/* Dump RITEM for traces. */
	153	void ritem_print PARAMS ((FILE *out));
	154
	155	/* Return the size of the longest rule RHS. */
	156	size_t ritem_longest_rhs PARAMS ((void));
	157
	158	#endif /* !GRAM_H_ */