xref: /freebsd/contrib/byacc/defs.h (revision 822ca3276345b4a67ccbc9b54616d8b205fd37f2)

/* $Id: defs.h,v 1.74 2023/05/18 21:28:05 tom Exp $ */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <limits.h>
#include <stdlib.h>
#include <string.h>
#include <errno.h>
#include <assert.h>
#include <ctype.h>
#include <stdio.h>

#if defined(__cplusplus)	/* __cplusplus, etc. */
#define class myClass
#endif

#define YYMAJOR 2
#define YYMINOR 0

#define CONCAT(first,second)    first #second
#define CONCAT1(string,number)  CONCAT(string, number)
#define CONCAT2(first,second)   #first "." #second

#ifdef YYPATCH
#define VSTRING(a,b) CONCAT2(a,b) CONCAT1(" ",YYPATCH)
#else
#define VSTRING(a,b) CONCAT2(a,b)
#endif

#define VERSION VSTRING(YYMAJOR, YYMINOR)

/*  machine-dependent definitions:			*/

/*  MAXCHAR is the largest unsigned character value	*/
/*  MAXTABLE is the maximum table size			*/
/*  YYINT is the smallest C integer type that can be	*/
/*	used to address a table of size MAXTABLE	*/
/*  MAXYYINT is the largest value of a YYINT		*/
/*  MINYYINT is the most negative value of a YYINT	*/
/*  BITS_PER_WORD is the number of bits in a C unsigned	*/
/*  WORDSIZE computes the number of words needed to	*/
/*	store n bits					*/
/*  BIT returns the value of the n-th bit starting	*/
/*	from r (0-indexed)				*/
/*  SETBIT sets the n-th bit starting from r		*/

#define	MAXCHAR		UCHAR_MAX
#ifndef MAXTABLE
#define MAXTABLE	INT_MAX
#endif
#if MAXTABLE <= SHRT_MAX
#define YYINT		short
#define MAXYYINT	SHRT_MAX
#define MINYYINT	SHRT_MIN
#elif MAXTABLE <= INT_MAX
#define YYINT		int
#define MAXYYINT	INT_MAX
#define MINYYINT	INT_MIN
#elif MAXTABLE <= LONG_MAX
#define YYINT		long
#define MAXYYINT	LONG_MAX
#define MINYYINT	LONG_MIN
#else
#error "MAXTABLE is too large for this machine architecture!"
#endif

#define BITS_PER_WORD	((int) sizeof (unsigned) * CHAR_BIT)
#define WORDSIZE(n)	(((n)+(BITS_PER_WORD-1))/BITS_PER_WORD)
#define BIT(r, n)	((((r)[(n)/BITS_PER_WORD])>>((n)&(BITS_PER_WORD-1)))&1)
#define SETBIT(r, n)	((r)[(n)/BITS_PER_WORD]|=((unsigned)1<<((n)&(BITS_PER_WORD-1))))

/*  character names  */

#define	NUL		'\0'	/*  the null character  */
#define	NEWLINE		'\n'	/*  line feed  */
#define	SP		' '	/*  space  */
#define	BS		'\b'	/*  backspace  */
#define	HT		'\t'	/*  horizontal tab  */
#define	VT		'\013'	/*  vertical tab  */
#define	CR		'\r'	/*  carriage return  */
#define	FF		'\f'	/*  form feed  */
#define	QUOTE		'\''	/*  single quote  */
#define	DOUBLE_QUOTE	'\"'	/*  double quote  */
#define	BACKSLASH	'\\'	/*  backslash  */

#define UCH(c)          (unsigned char)(c)

/* defines for constructing filenames */

#if defined(VMS)
#define CODE_SUFFIX	"_code.c"
#define	DEFINES_SUFFIX	"_tab.h"
#define	EXTERNS_SUFFIX	"_tab.i"
#define	OUTPUT_SUFFIX	"_tab.c"
#else
#define CODE_SUFFIX	".code.c"
#define	DEFINES_SUFFIX	".tab.h"
#define	EXTERNS_SUFFIX	".tab.i"
#define	OUTPUT_SUFFIX	".tab.c"
#endif
#define	VERBOSE_SUFFIX	".output"
#define GRAPH_SUFFIX    ".dot"

/* keyword codes */

typedef enum
{
    TOKEN = 0
    ,LEFT
    ,RIGHT
    ,NONASSOC
    ,MARK
    ,TEXT
    ,TYPE
    ,START
    ,UNION
    ,IDENT

    /* trivial bison "extensions" which have POSIX equivalents */
    ,NONPOSIX_DEBUG

    /* other bison "extensions", some useful */
    ,HACK_DEFINE
    ,ERROR_VERBOSE
    ,EXPECT
    ,EXPECT_RR
    ,LEX_PARAM
    ,PARSE_PARAM
    ,POSIX_YACC
    ,PURE_PARSER
    ,TOKEN_TABLE
    ,XCODE

#if defined(YYBTYACC)
    ,DESTRUCTOR
    ,INITIAL_ACTION
    ,LOCATIONS
#endif
}
KEY_CASES;

/*  symbol classes  */

typedef enum
{
    UNKNOWN = 0
    ,TERM
    ,NONTERM
    ,ACTION
    ,ARGUMENT
}
SYM_CASES;

/*  the undefined value  */

#define UNDEFINED (-1)

/*  action codes  */

#define SHIFT 1
#define REDUCE 2

/*  character macros  */

#define IS_NAME1(c)	(isalpha(UCH(c)) || (c) == '_' || (c) == '$')
#define IS_NAME2(c)	(isalnum(UCH(c)) || (c) == '_' || (c) == '$')
#define IS_IDENT(c)	(isalnum(UCH(c)) || (c) == '_' || (c) == '.' || (c) == '$')
#define	IS_OCTAL(c)	((c) >= '0' && (c) <= '7')

/*  symbol macros  */

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

/*  storage allocation macros  */

#define CALLOC(k,n)	(calloc((size_t)(k),(size_t)(n)))
#define	FREE(x)		(free((char*)(x)))
#define MALLOC(n)	(malloc((size_t)(n)))
#define TCMALLOC(t,n)	((t*) calloc((size_t)(n), sizeof(t)))
#define TMALLOC(t,n)	((t*) malloc((size_t)(n) * sizeof(t)))
#define	NEW(t)		((t*)allocate(sizeof(t)))
#define	NEW2(n,t)	((t*)allocate(((size_t)(n)*sizeof(t))))
#define REALLOC(p,n)	(realloc((char*)(p),(size_t)(n)))
#define TREALLOC(t,p,n)	((t*)realloc((char*)(p), (size_t)(n) * sizeof(t)))

#define DO_FREE(x)	if (x) { FREE(x); x = 0; }

#define NO_SPACE(p)	do { if (p == 0) on_error(); assert(p != 0); } while (0)

/* messages */
#define PLURAL(n) ((n) > 1 ? "s" : "")

/*
 * Features which depend indirectly on the btyacc configuration, but are not
 * essential.
 */
#if defined(YYBTYACC)
#define USE_HEADER_GUARDS 1
#else
#define USE_HEADER_GUARDS 0
#endif

typedef char Assoc_t;
typedef char Class_t;
typedef YYINT Index_t;
typedef YYINT Value_t;

/*  the structure of a symbol table entry  */

typedef struct bucket bucket;
struct bucket
{
    struct bucket *link;
    struct bucket *next;
    char *name;
    char *tag;
#if defined(YYBTYACC)
    char **argnames;
    char **argtags;
    int args;
    char *destructor;
#endif
    Value_t value;
    Index_t index;
    Value_t prec;
    Class_t class;
    Assoc_t assoc;
};

/*  the structure of the LR(0) state machine  */

typedef struct core core;
struct core
{
    struct core *next;
    struct core *link;
    Value_t number;
    Value_t accessing_symbol;
    Value_t nitems;
    Value_t items[1];
};

/*  the structure used to record shifts  */

typedef struct shifts shifts;
struct shifts
{
    struct shifts *next;
    Value_t number;
    Value_t nshifts;
    Value_t shift[1];
};

/*  the structure used to store reductions  */

typedef struct reductions reductions;
struct reductions
{
    struct reductions *next;
    Value_t number;
    Value_t nreds;
    Value_t rules[1];
};

/*  the structure used to represent parser actions  */

typedef struct action action;
struct action
{
    struct action *next;
    Value_t symbol;
    Value_t number;
    Value_t prec;
    char action_code;
    Assoc_t assoc;
    char suppressed;
};

/*  the structure used to store parse/lex parameters  */
typedef struct param param;
struct param
{
    struct param *next;
    char *name;		/* parameter name */
    char *type;		/* everything before parameter name */
    char *type2;	/* everything after parameter name */
};

/* global variables */

extern char dflag2;
extern char dflag;
extern char gflag;
extern char iflag;
extern char lflag;
extern char rflag;
extern char sflag;
extern char tflag;
extern char vflag;
extern const char *symbol_prefix;

extern const char *myname;
extern char *cptr;
extern char *line;
extern int lineno;
extern int outline;
extern int exit_code;
extern int pure_parser;
extern int token_table;
extern int error_verbose;
#if defined(YYBTYACC)
extern int locations;
extern int backtrack;
extern int destructor;
extern char *initial_action;
#endif

extern const char *const banner[];
extern const char *const xdecls[];
extern const char *const tables[];
extern const char *const global_vars[];
extern const char *const impure_vars[];
extern const char *const hdr_defs[];
extern const char *const hdr_vars[];
extern const char *const body_1[];
extern const char *const body_vars[];
extern const char *const init_vars[];
extern const char *const body_2[];
extern const char *const body_3[];
extern const char *const trailer[];

extern char *code_file_name;
extern char *input_file_name;
extern size_t input_file_name_len;
extern char *defines_file_name;
extern char *externs_file_name;

extern FILE *action_file;
extern FILE *code_file;
extern FILE *defines_file;
extern FILE *externs_file;
extern FILE *input_file;
extern FILE *output_file;
extern FILE *text_file;
extern FILE *union_file;
extern FILE *verbose_file;
extern FILE *graph_file;

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

extern char unionized;
extern char line_format[];

#define fprintf_lineno(f, n, s) \
	    if (!lflag) \
		fprintf(f, line_format, (n), (s) ? (s) : "(null)")

extern Value_t start_symbol;
extern char **symbol_name;
extern char **symbol_pname;
extern Value_t *symbol_value;
extern Value_t *symbol_prec;
extern char *symbol_assoc;

#if defined(YYBTYACC)
extern Value_t *symbol_pval;
extern char **symbol_destructor;
extern char **symbol_type_tag;
#endif

extern Value_t *ritem;
extern Value_t *rlhs;
extern Value_t *rrhs;
extern Value_t *rprec;
extern Assoc_t *rassoc;

extern Value_t **derives;
extern char *nullable;

extern bucket *first_symbol;
extern bucket *last_symbol;

extern Value_t nstates;
extern core *first_state;
extern shifts *first_shift;
extern reductions *first_reduction;
extern Value_t *accessing_symbol;
extern core **state_table;
extern shifts **shift_table;
extern reductions **reduction_table;
extern unsigned *LA;
extern Value_t *LAruleno;
extern Value_t *lookaheads;
extern Value_t *goto_base;
extern Value_t *goto_map;
extern Value_t *from_state;
extern Value_t *to_state;

extern action **parser;
extern int SRexpect;
extern int RRexpect;
extern int SRtotal;
extern int RRtotal;
extern Value_t *SRconflicts;
extern Value_t *RRconflicts;
extern Value_t *defred;
extern Value_t *rules_used;
extern Value_t nunused;
extern Value_t final_state;

extern Value_t *itemset;
extern Value_t *itemsetend;
extern unsigned *ruleset;

extern param *lex_param;
extern param *parse_param;

/* global functions */

#ifdef HAVE_STDNORETURN_H
#undef GCC_NORETURN
#include <stdnoreturn.h>
#define GCC_NORETURN _Noreturn
#endif

#ifndef GCC_NORETURN
#if defined(_MSC_VER)
#define GCC_NORETURN		__declspec(noreturn)
#else
#define GCC_NORETURN		/* nothing */
#endif
#endif

#if defined(NDEBUG) && defined(_MSC_VER)
#define NODEFAULT   __assume(0);
#else
#define NODEFAULT
#endif
#define NOTREACHED	NODEFAULT

#ifndef GCC_UNUSED
#if defined(__unused)
#define GCC_UNUSED		__unused
#else
#define GCC_UNUSED		/* nothing */
#endif
#endif

#ifndef GCC_PRINTFLIKE
#define GCC_PRINTFLIKE(fmt,var)	/*nothing */
#endif

/* closure.c */
extern void closure(Value_t *nucleus, int n);
extern void finalize_closure(void);
extern void set_first_derives(void);

/* error.c */
struct ainfo
{
    int a_lineno;
    char *a_line;
    char *a_cptr;
};

extern void arg_number_disagree_warning(int a_lineno, const char *a_name);
extern void arg_type_disagree_warning(int a_lineno, int i, const char *a_name);
extern GCC_NORETURN void at_error(int a_lineno, const char *a_line, const char *a_cptr);
extern void at_warning(int a_lineno, int i);
extern GCC_NORETURN void bad_formals(void);
extern void default_action_warning(const char *s);
extern void destructor_redeclared_warning(const struct ainfo *);
extern void dislocations_warning(void);
extern GCC_NORETURN void dollar_error(int a_lineno, const char *a_line, const char *a_cptr);
extern void dollar_warning(int a_lineno, int i);
extern GCC_NORETURN void fatal(const char *msg);
extern GCC_NORETURN void illegal_character(const char *c_cptr);
extern GCC_NORETURN void illegal_tag(int t_lineno, const char *t_line, const char *t_cptr);
extern GCC_NORETURN void missing_brace(void);
extern GCC_NORETURN void no_grammar(void);
extern GCC_NORETURN void on_error(void);
extern GCC_NORETURN void open_error(const char *filename);
extern GCC_NORETURN void over_unionized(const char *u_cptr);
extern void prec_redeclared(void);
extern void reprec_warning(const char *s);
extern void restarted_warning(void);
extern void retyped_warning(const char *s);
extern void revalued_warning(const char *s);
extern void start_requires_args(const char *a_name);
extern GCC_NORETURN void syntax_error(int st_lineno, const char *st_line, const char *st_cptr);
extern GCC_NORETURN void terminal_lhs(int s_lineno);
extern GCC_NORETURN void terminal_start(const char *s);
extern GCC_NORETURN void tokenized_start(const char *s);
extern GCC_NORETURN void undefined_goal(const char *s);
extern void undefined_symbol_warning(const char *s);
extern GCC_NORETURN void unexpected_EOF(void);
extern void unknown_arg_warning(int d_lineno,
				const char *dlr_opt,
				const char *d_arg,
				const char *d_line,
				const char *d_cptr);
extern GCC_NORETURN void unknown_rhs(int i);
extern void unsupported_flag_warning(const char *flag, const char *details);
extern GCC_NORETURN void unexpected_value(const struct ainfo *);
extern GCC_NORETURN void unterminated_action(const struct ainfo *);
extern GCC_NORETURN void unterminated_comment(const struct ainfo *);
extern GCC_NORETURN void unterminated_string(const struct ainfo *);
extern GCC_NORETURN void unterminated_text(const struct ainfo *);
extern GCC_NORETURN void unterminated_union(const struct ainfo *);
extern void untyped_arg_warning(int a_lineno, const char *dlr_opt, const char *a_name);
extern GCC_NORETURN void untyped_lhs(void);
extern GCC_NORETURN void untyped_rhs(int i, const char *s);
extern GCC_NORETURN void used_reserved(const char *s);
extern GCC_NORETURN void unterminated_arglist(const struct ainfo *);
extern void wrong_number_args_warning(const char *which, const char *a_name);
extern void wrong_type_for_arg_warning(int i, const char *a_name);

/* graph.c */
extern void graph(void);

/* lalr.c */
extern void lalr(void);

/* lr0.c */
extern void lr0(void);
extern void show_cores(void);
extern void show_ritems(void);
extern void show_rrhs(void);
extern void show_shifts(void);

/* main.c */
extern void *allocate(size_t n);
extern GCC_NORETURN void done(int k);

/* mkpar.c */
extern void free_parser(void);
extern void make_parser(void);

/* mstring.c */
struct mstring
{
    char *base, *ptr, *end;
};

extern void msprintf(struct mstring *, const char *, ...) GCC_PRINTFLIKE(2,3);
extern int mputchar(struct mstring *, int);
extern struct mstring *msnew(void);
extern struct mstring *msrenew(char *);
extern char *msdone(struct mstring *);
extern int strnscmp(const char *, const char *);
extern unsigned int strnshash(const char *);

#define mputc(m, ch)	(((m)->ptr == (m)->end) \
			 ? mputchar(m,ch) \
			 : (*(m)->ptr++ = (char) (ch)))

/* output.c */
extern void output(void);

/* reader.c */
extern void reader(void);

typedef enum
{
    CODE_HEADER = 0
    ,CODE_REQUIRES
    ,CODE_PROVIDES
    ,CODE_TOP
    ,CODE_IMPORTS
    ,CODE_MAX		/* this must be last */
}
CODE_CASES;
extern struct code_lines
{
    const char *name;
    char *lines;
    size_t num;
}
code_lines[CODE_MAX];

/* skeleton.c (generated by skel2c) */
extern void write_section(FILE * fp, const char *const section[]);

/* symtab.c */
extern bucket *make_bucket(const char *);
extern bucket *lookup(const char *);
extern void create_symbol_table(void);
extern void free_symbol_table(void);
extern void free_symbols(void);

/* verbose.c */
extern void verbose(void);

/* warshall.c */
extern void reflexive_transitive_closure(unsigned *R, int n);

#ifdef DEBUG
    /* closure.c */
extern void print_closure(int n);
extern void print_EFF(void);
extern void print_first_derives(void);
    /* lr0.c */
extern void print_derives(void);
#endif

#ifdef NO_LEAKS
extern void lr0_leaks(void);
extern void lalr_leaks(void);
extern void mkpar_leaks(void);
extern void output_leaks(void);
extern void mstring_leaks(void);
extern void reader_leaks(void);
#endif