xref: /netbsd/external/bsd/byacc/dist/defs.h (revision 9db11b62)
1 /*	$NetBSD: defs.h,v 1.19 2021/02/20 22:57:56 christos Exp $	*/
2 
3 /* Id: defs.h,v 1.66 2020/09/10 20:21:20 tom Exp  */
4 
5 #if HAVE_NBTOOL_CONFIG_H
6 #include "nbtool_config.h"
7 #endif
8 
9 #ifdef HAVE_CONFIG_H
10 #include <config.h>
11 #endif
12 
13 #include <limits.h>
14 #include <stdlib.h>
15 #include <string.h>
16 #include <errno.h>
17 #include <assert.h>
18 #include <ctype.h>
19 #include <stdio.h>
20 
21 #if defined(__cplusplus)	/* __cplusplus, etc. */
22 #define class myClass
23 #endif
24 
25 #define YYMAJOR 2
26 #define YYMINOR 0
27 
28 #define CONCAT(first,second)    first #second
29 #define CONCAT1(string,number)  CONCAT(string, number)
30 #define CONCAT2(first,second)   #first "." #second
31 
32 #ifdef YYPATCH
33 #define VSTRING(a,b) CONCAT2(a,b) CONCAT1(" ",YYPATCH)
34 #else
35 #define VSTRING(a,b) CONCAT2(a,b)
36 #endif
37 
38 #define VERSION VSTRING(YYMAJOR, YYMINOR)
39 
40 /*  machine-dependent definitions:			*/
41 
42 /*  MAXCHAR is the largest unsigned character value	*/
43 /*  MAXTABLE is the maximum table size			*/
44 /*  YYINT is the smallest C integer type that can be	*/
45 /*	used to address a table of size MAXTABLE	*/
46 /*  MAXYYINT is the largest value of a YYINT		*/
47 /*  MINYYINT is the most negative value of a YYINT	*/
48 /*  BITS_PER_WORD is the number of bits in a C unsigned	*/
49 /*  WORDSIZE computes the number of words needed to	*/
50 /*	store n bits					*/
51 /*  BIT returns the value of the n-th bit starting	*/
52 /*	from r (0-indexed)				*/
53 /*  SETBIT sets the n-th bit starting from r		*/
54 
55 #define	MAXCHAR		UCHAR_MAX
56 #ifndef MAXTABLE
57 #define MAXTABLE	32500
58 #endif
59 #if MAXTABLE <= SHRT_MAX
60 #define YYINT		short
61 #define MAXYYINT	SHRT_MAX
62 #define MINYYINT	SHRT_MIN
63 #elif MAXTABLE <= INT_MAX
64 #define YYINT		int
65 #define MAXYYINT	INT_MAX
66 #define MINYYINT	INT_MIN
67 #else
68 #error "MAXTABLE is too large for this machine architecture!"
69 #endif
70 
71 #define BITS_PER_WORD	((int) sizeof (unsigned) * CHAR_BIT)
72 #define WORDSIZE(n)	(((n)+(BITS_PER_WORD-1))/BITS_PER_WORD)
73 #define BIT(r, n)	((((r)[(n)/BITS_PER_WORD])>>((n)&(BITS_PER_WORD-1)))&1)
74 #define SETBIT(r, n)	((r)[(n)/BITS_PER_WORD]|=((unsigned)1<<((n)&(BITS_PER_WORD-1))))
75 
76 /*  character names  */
77 
78 #define	NUL		'\0'	/*  the null character  */
79 #define	NEWLINE		'\n'	/*  line feed  */
80 #define	SP		' '	/*  space  */
81 #define	BS		'\b'	/*  backspace  */
82 #define	HT		'\t'	/*  horizontal tab  */
83 #define	VT		'\013'	/*  vertical tab  */
84 #define	CR		'\r'	/*  carriage return  */
85 #define	FF		'\f'	/*  form feed  */
86 #define	QUOTE		'\''	/*  single quote  */
87 #define	DOUBLE_QUOTE	'\"'	/*  double quote  */
88 #define	BACKSLASH	'\\'	/*  backslash  */
89 
90 #define UCH(c)          (unsigned char)(c)
91 
92 /* defines for constructing filenames */
93 
94 #if defined(VMS)
95 #define CODE_SUFFIX	"_code.c"
96 #define	DEFINES_SUFFIX	"_tab.h"
97 #define	EXTERNS_SUFFIX	"_tab.i"
98 #define	OUTPUT_SUFFIX	"_tab.c"
99 #else
100 #define CODE_SUFFIX	".code.c"
101 #define	DEFINES_SUFFIX	".tab.h"
102 #define	EXTERNS_SUFFIX	".tab.i"
103 #define	OUTPUT_SUFFIX	".tab.c"
104 #endif
105 #define	VERBOSE_SUFFIX	".output"
106 #define GRAPH_SUFFIX    ".dot"
107 
108 /* keyword codes */
109 
110 typedef enum
111 {
112     TOKEN = 0
113     ,LEFT
114     ,RIGHT
115     ,NONASSOC
116     ,MARK
117     ,TEXT
118     ,TYPE
119     ,START
120     ,UNION
121     ,IDENT
122     ,EXPECT
123     ,EXPECT_RR
124     ,PURE_PARSER
125     ,PARSE_PARAM
126     ,LEX_PARAM
127     ,POSIX_YACC
128     ,TOKEN_TABLE
129     ,ERROR_VERBOSE
130     ,XXXDEBUG
131     ,XCODE
132 
133 #if defined(YYBTYACC)
134     ,LOCATIONS
135     ,DESTRUCTOR
136     ,INITIAL_ACTION
137 #endif
138 }
139 KEY_CASES;
140 
141 /*  symbol classes  */
142 
143 typedef enum
144 {
145     UNKNOWN = 0
146     ,TERM
147     ,NONTERM
148     ,ACTION
149     ,ARGUMENT
150 }
151 SYM_CASES;
152 
153 /*  the undefined value  */
154 
155 #define UNDEFINED (-1)
156 
157 /*  action codes  */
158 
159 #define SHIFT 1
160 #define REDUCE 2
161 
162 /*  character macros  */
163 
164 #define IS_NAME1(c)	(isalpha(UCH(c)) || (c) == '_' || (c) == '$')
165 #define IS_NAME2(c)	(isalnum(UCH(c)) || (c) == '_' || (c) == '$')
166 #define IS_IDENT(c)	(isalnum(UCH(c)) || (c) == '_' || (c) == '.' || (c) == '$')
167 #define	IS_OCTAL(c)	((c) >= '0' && (c) <= '7')
168 
169 /*  symbol macros  */
170 
171 #define ISTOKEN(s)	((s) < start_symbol)
172 #define ISVAR(s)	((s) >= start_symbol)
173 
174 /*  storage allocation macros  */
175 
176 #define CALLOC(k,n)	(calloc((size_t)(k),(size_t)(n)))
177 #define	FREE(x)		(free((char*)(x)))
178 #define MALLOC(n)	(malloc((size_t)(n)))
179 #define TCMALLOC(t,n)	((t*) calloc((size_t)(n), sizeof(t)))
180 #define TMALLOC(t,n)	((t*) malloc((size_t)(n) * sizeof(t)))
181 #define	NEW(t)		((t*)allocate(sizeof(t)))
182 #define	NEW2(n,t)	((t*)allocate(((size_t)(n)*sizeof(t))))
183 #define REALLOC(p,n)	(realloc((char*)(p),(size_t)(n)))
184 #define TREALLOC(t,p,n)	((t*)realloc((char*)(p), (size_t)(n) * sizeof(t)))
185 
186 #define DO_FREE(x)	if (x) { FREE(x); x = 0; }
187 
188 #define NO_SPACE(p)	if (p == 0) no_space(); assert(p != 0)
189 
190 /* messages */
191 #define PLURAL(n) ((n) > 1 ? "s" : "")
192 
193 /*
194  * Features which depend indirectly on the btyacc configuration, but are not
195  * essential.
196  */
197 #if defined(YYBTYACC)
198 #define USE_HEADER_GUARDS 1
199 #else
200 #define USE_HEADER_GUARDS 0
201 #endif
202 
203 typedef char Assoc_t;
204 typedef char Class_t;
205 typedef YYINT Index_t;
206 typedef YYINT Value_t;
207 
208 /*  the structure of a symbol table entry  */
209 
210 typedef struct bucket bucket;
211 struct bucket
212 {
213     struct bucket *link;
214     struct bucket *next;
215     char *name;
216     char *tag;
217 #if defined(YYBTYACC)
218     char **argnames;
219     char **argtags;
220     int args;
221     char *destructor;
222 #endif
223     Value_t value;
224     Index_t index;
225     Value_t prec;
226     Class_t class;
227     Assoc_t assoc;
228 };
229 
230 /*  the structure of the LR(0) state machine  */
231 
232 typedef struct core core;
233 struct core
234 {
235     struct core *next;
236     struct core *link;
237     Value_t number;
238     Value_t accessing_symbol;
239     Value_t nitems;
240     Value_t items[1];
241 };
242 
243 /*  the structure used to record shifts  */
244 
245 typedef struct shifts shifts;
246 struct shifts
247 {
248     struct shifts *next;
249     Value_t number;
250     Value_t nshifts;
251     Value_t shift[1];
252 };
253 
254 /*  the structure used to store reductions  */
255 
256 typedef struct reductions reductions;
257 struct reductions
258 {
259     struct reductions *next;
260     Value_t number;
261     Value_t nreds;
262     Value_t rules[1];
263 };
264 
265 /*  the structure used to represent parser actions  */
266 
267 typedef struct action action;
268 struct action
269 {
270     struct action *next;
271     Value_t symbol;
272     Value_t number;
273     Value_t prec;
274     char action_code;
275     Assoc_t assoc;
276     char suppressed;
277 };
278 
279 /*  the structure used to store parse/lex parameters  */
280 typedef struct param param;
281 struct param
282 {
283     struct param *next;
284     char *name;		/* parameter name */
285     char *type;		/* everything before parameter name */
286     char *type2;	/* everything after parameter name */
287 };
288 
289 /* global variables */
290 
291 extern char dflag2;
292 extern char dflag;
293 extern char gflag;
294 extern char iflag;
295 extern char lflag;
296 extern char rflag;
297 extern char sflag;
298 extern char tflag;
299 extern char vflag;
300 extern const char *symbol_prefix;
301 
302 extern const char *myname;
303 extern char *cptr;
304 extern char *line;
305 extern int lineno;
306 extern int outline;
307 extern int exit_code;
308 extern int pure_parser;
309 extern int token_table;
310 extern int error_verbose;
311 #if defined(YYBTYACC)
312 extern int locations;
313 extern int backtrack;
314 extern int destructor;
315 extern char *initial_action;
316 #endif
317 
318 extern const char *const banner[];
319 extern const char *const xdecls[];
320 extern const char *const tables[];
321 extern const char *const global_vars[];
322 extern const char *const impure_vars[];
323 extern const char *const hdr_defs[];
324 extern const char *const hdr_vars[];
325 extern const char *const body_1[];
326 extern const char *const body_vars[];
327 extern const char *const init_vars[];
328 extern const char *const body_2[];
329 extern const char *const body_3[];
330 extern const char *const trailer[];
331 
332 extern char *code_file_name;
333 extern char *input_file_name;
334 extern size_t input_file_name_len;
335 extern char *defines_file_name;
336 extern char *externs_file_name;
337 
338 extern FILE *action_file;
339 extern FILE *code_file;
340 extern FILE *defines_file;
341 extern FILE *externs_file;
342 extern FILE *input_file;
343 extern FILE *output_file;
344 extern FILE *text_file;
345 extern FILE *union_file;
346 extern FILE *verbose_file;
347 extern FILE *graph_file;
348 
349 extern Value_t nitems;
350 extern Value_t nrules;
351 extern Value_t nsyms;
352 extern Value_t ntokens;
353 extern Value_t nvars;
354 extern int ntags;
355 
356 extern char unionized;
357 extern char line_format[];
358 
359 extern Value_t start_symbol;
360 extern char **symbol_name;
361 extern char **symbol_pname;
362 extern Value_t *symbol_value;
363 extern Value_t *symbol_prec;
364 extern char *symbol_assoc;
365 
366 #if defined(YYBTYACC)
367 extern Value_t *symbol_pval;
368 extern char **symbol_destructor;
369 extern char **symbol_type_tag;
370 #endif
371 
372 extern Value_t *ritem;
373 extern Value_t *rlhs;
374 extern Value_t *rrhs;
375 extern Value_t *rprec;
376 extern Assoc_t *rassoc;
377 
378 extern Value_t **derives;
379 extern char *nullable;
380 
381 extern bucket *first_symbol;
382 extern bucket *last_symbol;
383 
384 extern int nstates;
385 extern core *first_state;
386 extern shifts *first_shift;
387 extern reductions *first_reduction;
388 extern Value_t *accessing_symbol;
389 extern core **state_table;
390 extern shifts **shift_table;
391 extern reductions **reduction_table;
392 extern unsigned *LA;
393 extern Value_t *LAruleno;
394 extern Value_t *lookaheads;
395 extern Value_t *goto_base;
396 extern Value_t *goto_map;
397 extern Value_t *from_state;
398 extern Value_t *to_state;
399 
400 extern action **parser;
401 extern int SRexpect;
402 extern int RRexpect;
403 extern int SRtotal;
404 extern int RRtotal;
405 extern Value_t *SRconflicts;
406 extern Value_t *RRconflicts;
407 extern Value_t *defred;
408 extern Value_t *rules_used;
409 extern Value_t nunused;
410 extern Value_t final_state;
411 
412 extern Value_t *itemset;
413 extern Value_t *itemsetend;
414 extern unsigned *ruleset;
415 
416 extern param *lex_param;
417 extern param *parse_param;
418 
419 /* global functions */
420 
421 #ifndef GCC_NORETURN
422 #if defined(__dead2)
423 #define GCC_NORETURN		__dead2
424 #elif defined(__dead)
425 #define GCC_NORETURN		__dead
426 #else
427 #define GCC_NORETURN		/* nothing */
428 #endif
429 #endif
430 
431 #ifdef __GNUC__
432 #define ATTRIBUTE_NORETURN __attribute__((noreturn))
433 #elif defined(_MSC_VER)
434 #define ATTRIBUTE_NORETURN __declspec(noreturn)
435 #else
436 #define ATTRIBUTE_NORETURN
437 #endif
438 
439 #if defined(NDEBUG) && defined(_MSC_VER)
440 #define NODEFAULT   __assume(0);
441 #else
442 #define NODEFAULT
443 #endif
444 #define NOTREACHED	NODEFAULT
445 
446 #ifndef GCC_UNUSED
447 #if defined(__unused)
448 #define GCC_UNUSED		__unused
449 #else
450 #define GCC_UNUSED		/* nothing */
451 #endif
452 #endif
453 
454 #ifndef GCC_PRINTFLIKE
455 #define GCC_PRINTFLIKE(fmt,var)	/*nothing */
456 #endif
457 
458 /* closure.c */
459 extern void closure(Value_t *nucleus, int n);
460 extern void finalize_closure(void);
461 extern void set_first_derives(void);
462 
463 /* error.c */
464 struct ainfo
465 {
466     int a_lineno;
467     char *a_line;
468     char *a_cptr;
469 };
470 
471 extern void arg_number_disagree_warning(int a_lineno, char *a_name);
472 extern void arg_type_disagree_warning(int a_lineno, int i, char *a_name);
473 ATTRIBUTE_NORETURN
474 extern void at_error(int a_lineno, char *a_line, char *a_cptr) GCC_NORETURN;
475 extern void at_warning(int a_lineno, int i);
476 ATTRIBUTE_NORETURN
477 extern void bad_formals(void) GCC_NORETURN;
478 extern void default_action_warning(char *s);
479 extern void destructor_redeclared_warning(const struct ainfo *);
480 ATTRIBUTE_NORETURN
481 extern void dollar_error(int a_lineno, char *a_line, char *a_cptr) GCC_NORETURN;
482 extern void dollar_warning(int a_lineno, int i);
483 ATTRIBUTE_NORETURN
484 extern void fatal(const char *msg) GCC_NORETURN;
485 ATTRIBUTE_NORETURN
486 extern void illegal_character(char *c_cptr) GCC_NORETURN;
487 ATTRIBUTE_NORETURN
488 extern void illegal_tag(int t_lineno, char *t_line, char *t_cptr) GCC_NORETURN;
489 ATTRIBUTE_NORETURN
490 extern void missing_brace(void) GCC_NORETURN;
491 ATTRIBUTE_NORETURN
492 extern void no_grammar(void) GCC_NORETURN;
493 ATTRIBUTE_NORETURN
494 extern void no_space(void) GCC_NORETURN;
495 ATTRIBUTE_NORETURN
496 extern void open_error(const char *filename) GCC_NORETURN;
497 ATTRIBUTE_NORETURN
498 extern void over_unionized(char *u_cptr) GCC_NORETURN;
499 extern void prec_redeclared(void);
500 extern void reprec_warning(char *s);
501 extern void restarted_warning(void);
502 extern void retyped_warning(char *s);
503 extern void revalued_warning(char *s);
504 extern void start_requires_args(char *a_name);
505 ATTRIBUTE_NORETURN
506 extern void syntax_error(int st_lineno, char *st_line, char *st_cptr) GCC_NORETURN;
507 ATTRIBUTE_NORETURN
508 extern void terminal_lhs(int s_lineno) GCC_NORETURN;
509 ATTRIBUTE_NORETURN
510 extern void terminal_start(char *s) GCC_NORETURN;
511 ATTRIBUTE_NORETURN
512 extern void tokenized_start(char *s) GCC_NORETURN;
513 ATTRIBUTE_NORETURN
514 extern void undefined_goal(char *s) GCC_NORETURN;
515 extern void undefined_symbol_warning(char *s);
516 ATTRIBUTE_NORETURN
517 extern void unexpected_EOF(void) GCC_NORETURN;
518 extern void unknown_arg_warning(int d_lineno, const char *dlr_opt,
519 				const char *d_arg, const char *d_line,
520 				const char *d_cptr);
521 ATTRIBUTE_NORETURN
522 extern void unknown_rhs(int i) GCC_NORETURN;
523 extern void unsupported_flag_warning(const char *flag, const char *details);
524 ATTRIBUTE_NORETURN
525 extern void unterminated_action(const struct ainfo *) GCC_NORETURN;
526 ATTRIBUTE_NORETURN
527 extern void unterminated_comment(const struct ainfo *) GCC_NORETURN;
528 ATTRIBUTE_NORETURN
529 extern void unterminated_string(const struct ainfo *) GCC_NORETURN;
530 ATTRIBUTE_NORETURN
531 extern void unterminated_text(const struct ainfo *) GCC_NORETURN;
532 ATTRIBUTE_NORETURN
533 extern void unterminated_union(const struct ainfo *) GCC_NORETURN;
534 extern void untyped_arg_warning(int a_lineno, const char *dlr_opt, const char *a_name);
535 ATTRIBUTE_NORETURN
536 extern void untyped_lhs(void) GCC_NORETURN;
537 ATTRIBUTE_NORETURN
538 extern void untyped_rhs(int i, char *s) GCC_NORETURN;
539 ATTRIBUTE_NORETURN
540 extern void used_reserved(char *s) GCC_NORETURN;
541 ATTRIBUTE_NORETURN
542 extern void unterminated_arglist(const struct ainfo *) GCC_NORETURN;
543 extern void wrong_number_args_warning(const char *which, const char *a_name);
544 extern void wrong_type_for_arg_warning(int i, char *a_name);
545 
546 /* graph.c */
547 extern void graph(void);
548 
549 /* lalr.c */
550 extern void lalr(void);
551 
552 /* lr0.c */
553 extern void lr0(void);
554 extern void show_cores(void);
555 extern void show_ritems(void);
556 extern void show_rrhs(void);
557 extern void show_shifts(void);
558 
559 /* main.c */
560 extern void *allocate(size_t n);
561 ATTRIBUTE_NORETURN
562 extern void done(int k) GCC_NORETURN;
563 
564 /* mkpar.c */
565 extern void free_parser(void);
566 extern void make_parser(void);
567 
568 /* mstring.c */
569 struct mstring
570 {
571     char *base, *ptr, *end;
572 };
573 
574 extern void msprintf(struct mstring *, const char *, ...) GCC_PRINTFLIKE(2,3);
575 extern int mputchar(struct mstring *, int);
576 extern struct mstring *msnew(void);
577 extern struct mstring *msrenew(char *);
578 extern char *msdone(struct mstring *);
579 extern int strnscmp(const char *, const char *);
580 extern unsigned int strnshash(const char *);
581 
582 #define mputc(m, ch)	(((m)->ptr == (m)->end) \
583 			 ? mputchar(m,ch) \
584 			 : (*(m)->ptr++ = (char) (ch)))
585 
586 /* output.c */
587 extern void output(void);
588 
589 /* reader.c */
590 extern void reader(void);
591 
592 typedef enum
593 {
594     CODE_HEADER = 0
595     ,CODE_REQUIRES
596     ,CODE_PROVIDES
597     ,CODE_TOP
598     ,CODE_IMPORTS
599     ,CODE_MAX		/* this must be last */
600 }
601 CODE_CASES;
602 extern struct code_lines
603 {
604     const char *name;
605     char *lines;
606     size_t num;
607 }
608 code_lines[CODE_MAX];
609 
610 /* skeleton.c (generated by skel2c) */
611 extern void write_section(FILE * fp, const char *const section[]);
612 
613 /* symtab.c */
614 extern bucket *make_bucket(const char *);
615 extern bucket *lookup(const char *);
616 extern void create_symbol_table(void);
617 extern void free_symbol_table(void);
618 extern void free_symbols(void);
619 
620 /* verbose.c */
621 extern void verbose(void);
622 
623 /* warshall.c */
624 extern void reflexive_transitive_closure(unsigned *R, int n);
625 
626 #ifdef DEBUG
627     /* closure.c */
628 extern void print_closure(int n);
629 extern void print_EFF(void);
630 extern void print_first_derives(void);
631     /* lr0.c */
632 extern void print_derives(void);
633 #endif
634 
635 #ifdef NO_LEAKS
636 extern void lr0_leaks(void);
637 extern void lalr_leaks(void);
638 extern void mkpar_leaks(void);
639 extern void output_leaks(void);
640 extern void mstring_leaks(void);
641 extern void reader_leaks(void);
642 #endif
643