src/symtab.h

/* Definitions for symtab.c and callers, part of Bison.

   Copyright (C) 1984, 1989, 1992, 2000, 2001, 2002
   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 SYMTAB_H_
# define SYMTAB_H_

# include "assoc.h"
# include "location.h"
# include "uniqstr.h"

/*----------.
| Symbols.  |
`----------*/

/* Symbol classes.  */
typedef enum
{
  unknown_sym,
  token_sym,		/* terminal symbol */
  nterm_sym		/* non-terminal */
} symbol_class;


/* Internal token numbers. */
typedef short symbol_number;
#define SYMBOL_NUMBER_MAXIMUM SHRT_MAX


typedef struct symbol symbol;
struct symbol
{
  /* The key, name of the symbol.  */
  uniqstr tag;
  /* The location of its first occurrence.  */
  location location;

  /* Its %type and associated printer and destructor.  */
  uniqstr type_name;
  char *destructor;
  location destructor_location;
  char *printer;
  location printer_location;

  symbol_number number;
  short prec;
  assoc assoc;
  int user_token_number;

  /* Points to the other in the identifier-symbol pair for an alias.
     Special value USER_NUMBER_ALIAS in the identifier half of the
     identifier-symbol pair for an alias.  */
  symbol *alias;
  symbol_class class;
};

/* Undefined user number.  */
#define USER_NUMBER_UNDEFINED -1

/* `symbol->user_token_number == USER_NUMBER_ALIAS' means this symbol
   *has* (not is) a string literal alias.  For instance, `%token foo
   "foo"' has `"foo"' numbered regularly, and `foo' numbered as
   USER_NUMBER_ALIAS.  */
#define USER_NUMBER_ALIAS -9991

/* Undefined internal token number.  */
#define NUMBER_UNDEFINED (-1)


/* Fetch (or create) the symbol associated to KEY.  */
symbol *symbol_get (const char *key, location loc);

/* Generate a dummy nonterminal, whose name cannot conflict with the
   user's names.  */
symbol *dummy_symbol_get (location loc);

/* Declare the new symbol SYM.  Make it an alias of SYMVAL.  */
void symbol_make_alias (symbol *sym, symbol *symval, location loc);

/* Set the TYPE_NAME associated with SYM.  Do nothing if passed 0 as
   TYPE_NAME.  */
void symbol_type_set (symbol *sym, uniqstr type_name, location loc);

/* Set the DESTRUCTOR associated with SYM.  */
void symbol_destructor_set (symbol *sym, char *destructor, location loc);

/* Set the PRINTER associated with SYM.  */
void symbol_printer_set (symbol *sym, char *printer, location loc);

/* Set the PRECEDENCE associated with SYM.  Ensure that SYMBOL is a
   terminal.  Do nothing if invoked with UNDEF_ASSOC as ASSOC.  */
void symbol_precedence_set (symbol *sym, int prec, assoc a, location loc);

/* Set the CLASS associated with SYM.  */
void symbol_class_set (symbol *sym, symbol_class class, location loc);

/* Set the USER_TOKEN_NUMBER associated with SYM.  */
void symbol_user_token_number_set (symbol *sym, int user_number, location loc);


/* Distinguished symbols.  AXIOM is the real start symbol, that used
   by the automaton.  STARTSYMBOL is the one specified by the user.
   */
extern symbol *errtoken;
extern symbol *undeftoken;
extern symbol *endtoken;
extern symbol *accept;
extern symbol *startsymbol;
extern location startsymbol_location;


/*---------------.
| Symbol table.  |
`---------------*/


/* Create the symbol table.  */
void symbols_new (void);

/* Free all the memory allocated for symbols.  */
void symbols_free (void);

/* Check that all the symbols are defined.  Report any undefined
   symbols and consider them nonterminals.  */
void symbols_check_defined (void);

/* Perform various sanity checks, assign symbol numbers, and set up
   TOKEN_TRANSLATIONS.  */
void symbols_pack (void);

#endif /* !SYMTAB_H_ */
Commit	Line	Data
	1	/* Definitions for symtab.c and callers, part of Bison.
	2
	3	Copyright (C) 1984, 1989, 1992, 2000, 2001, 2002
	4	Free Software Foundation, Inc.
	5
	6	This file is part of Bison, the GNU Compiler Compiler.
	7
	8	Bison is free software; you can redistribute it and/or modify
	9	it under the terms of the GNU General Public License as published by
	10	the Free Software Foundation; either version 2, or (at your option)
	11	any later version.
	12
	13	Bison is distributed in the hope that it will be useful,
	14	but WITHOUT ANY WARRANTY; without even the implied warranty of
	15	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	16	GNU General Public License for more details.
	17
	18	You should have received a copy of the GNU General Public License
	19	along with Bison; see the file COPYING. If not, write to
	20	the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
	21	Boston, MA 02111-1307, USA. */
	22
	23	#ifndef SYMTAB_H_
	24	# define SYMTAB_H_
	25
	26	# include "assoc.h"
	27	# include "location.h"
	28	# include "uniqstr.h"
	29
	30	/*----------.
	31	\| Symbols. \|
	32	`----------*/
	33
	34	/* Symbol classes. */
	35	typedef enum
	36	{
	37	unknown_sym,
	38	token_sym, /* terminal symbol */
	39	nterm_sym /* non-terminal */
	40	} symbol_class;
	41
	42
	43	/* Internal token numbers. */
	44	typedef short symbol_number;
	45	#define SYMBOL_NUMBER_MAXIMUM SHRT_MAX
	46
	47
	48	typedef struct symbol symbol;
	49	struct symbol
	50	{
	51	/* The key, name of the symbol. */
	52	uniqstr tag;
	53	/* The location of its first occurrence. */
	54	location location;
	55
	56	/* Its %type and associated printer and destructor. */
	57	uniqstr type_name;
	58	char *destructor;
	59	location destructor_location;
	60	char *printer;
	61	location printer_location;
	62
	63	symbol_number number;
	64	short prec;
	65	assoc assoc;
	66	int user_token_number;
	67
	68	/* Points to the other in the identifier-symbol pair for an alias.
	69	Special value USER_NUMBER_ALIAS in the identifier half of the
	70	identifier-symbol pair for an alias. */
	71	symbol *alias;
	72	symbol_class class;
	73	};
	74
	75	/* Undefined user number. */
	76	#define USER_NUMBER_UNDEFINED -1
	77
	78	/* `symbol->user_token_number == USER_NUMBER_ALIAS' means this symbol
	79	has (not is) a string literal alias. For instance, `%token foo
	80	"foo"' has `"foo"' numbered regularly, and `foo' numbered as
	81	USER_NUMBER_ALIAS. */
	82	#define USER_NUMBER_ALIAS -9991
	83
	84	/* Undefined internal token number. */
	85	#define NUMBER_UNDEFINED (-1)
	86
	87
	88	/* Fetch (or create) the symbol associated to KEY. */
	89	symbol symbol_get (const char key, location loc);
	90
	91	/* Generate a dummy nonterminal, whose name cannot conflict with the
	92	user's names. */
	93	symbol *dummy_symbol_get (location loc);
	94
	95	/* Declare the new symbol SYM. Make it an alias of SYMVAL. */
	96	void symbol_make_alias (symbol sym, symbol symval, location loc);
	97
	98	/* Set the TYPE_NAME associated with SYM. Do nothing if passed 0 as
	99	TYPE_NAME. */
	100	void symbol_type_set (symbol *sym, uniqstr type_name, location loc);
	101
	102	/* Set the DESTRUCTOR associated with SYM. */
	103	void symbol_destructor_set (symbol sym, char destructor, location loc);
	104
	105	/* Set the PRINTER associated with SYM. */
	106	void symbol_printer_set (symbol sym, char printer, location loc);
	107
	108	/* Set the PRECEDENCE associated with SYM. Ensure that SYMBOL is a
	109	terminal. Do nothing if invoked with UNDEF_ASSOC as ASSOC. */
	110	void symbol_precedence_set (symbol *sym, int prec, assoc a, location loc);
	111
	112	/* Set the CLASS associated with SYM. */
	113	void symbol_class_set (symbol *sym, symbol_class class, location loc);
	114
	115	/* Set the USER_TOKEN_NUMBER associated with SYM. */
	116	void symbol_user_token_number_set (symbol *sym, int user_number, location loc);
	117
	118
	119	/* Distinguished symbols. AXIOM is the real start symbol, that used
	120	by the automaton. STARTSYMBOL is the one specified by the user.
	121	*/
	122	extern symbol *errtoken;
	123	extern symbol *undeftoken;
	124	extern symbol *endtoken;
	125	extern symbol *accept;
	126	extern symbol *startsymbol;
	127	extern location startsymbol_location;
	128
	129
	130	/*---------------.
	131	\| Symbol table. \|
	132	`---------------*/
	133
	134
	135	/* Create the symbol table. */
	136	void symbols_new (void);
	137
	138	/* Free all the memory allocated for symbols. */
	139	void symbols_free (void);
	140
	141	/* Check that all the symbols are defined. Report any undefined
	142	symbols and consider them nonterminals. */
	143	void symbols_check_defined (void);
	144
	145	/* Perform various sanity checks, assign symbol numbers, and set up
	146	TOKEN_TRANSLATIONS. */
	147	void symbols_pack (void);
	148
	149	#endif /* !SYMTAB_H_ */