1/*	$OpenBSD: extern.h,v 1.49 2009/10/14 17:19:47 sthen Exp $	*/
2/*	$NetBSD: extern.h,v 1.20 2020/06/25 02:25:53 uwe Exp $	*/
3
4/*-
5 * Copyright (c) 1991, 1993
6 *	The Regents of the University of California.  All rights reserved.
7 *
8 * This code is derived from software contributed to Berkeley by
9 * Ozan Yigit at York University.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 *    notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 *    notice, this list of conditions and the following disclaimer in the
18 *    documentation and/or other materials provided with the distribution.
19 * 3. Neither the name of the University nor the names of its contributors
20 *    may be used to endorse or promote products derived from this software
21 *    without specific prior written permission.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 * SUCH DAMAGE.
34 *
35 *	@(#)extern.h	8.1 (Berkeley) 6/6/93
36 */
37
38/* eval.c */
39extern void	eval(const char *[], int, int, int);
40extern void	dodefine(const char *, const char *);
41extern unsigned long expansion_id;
42
43/* expr.c */
44extern int	expr(const char *);
45
46/* gnum4.c */
47extern void 	addtoincludepath(const char *);
48extern struct input_file *fopen_trypath(struct input_file *, const char *);
49extern void doindir(const char *[], int);
50extern void dobuiltin(const char *[], int);
51extern void dopatsubst(const char *[], int);
52extern void doregexp(const char *[], int);
53
54extern void doprintlineno(struct input_file *);
55extern void doprintfilename(struct input_file *);
56
57extern void doesyscmd(const char *);
58extern void getdivfile(const char *);
59extern void doformat(const char *[], int);
60#ifdef REAL_FREEZE
61extern void freeze_state(const char *);
62extern void thaw_state(const char *);
63#endif
64
65
66/* look.c */
67
68#define FLAG_UNTRACED 0
69#define FLAG_TRACED 1
70#define FLAG_NO_TRACE 2
71
72extern void	init_macros(void);
73extern ndptr	lookup(const char *);
74extern void mark_traced(const char *, int);
75extern struct ohash macros;
76
77extern struct macro_definition *lookup_macro_definition(const char *);
78extern void 	macro_define(const char *, const char *);
79extern void 	macro_pushdef(const char *, const char *);
80extern void 	macro_popdef(const char *);
81extern void 	macro_undefine(const char *);
82extern void 	setup_builtin(const char *, unsigned int);
83extern void 	macro_for_all(void (*)(const char *, struct macro_definition *));
84#define macro_getdef(p) 	((p)->d)
85#define macro_name(p)		((p)->name)
86#define macro_builtin_type(p)	((p)->builtin_type)
87#define is_traced(p) ((p)->trace_flags == FLAG_NO_TRACE ? (trace_flags & TRACE_ALL) : (p)->trace_flags)
88
89extern ndptr macro_getbuiltin(const char *);
90#ifdef REAL_FREEZE
91extern void  dump_state(FILE *);
92extern void  restore_state(FILE *);
93#endif
94
95/* main.c */
96extern void outputstr(const char *);
97extern void do_emit_synchline(void);
98#define emit_synchline() do { if (synch_lines) do_emit_synchline(); } while(0)
99
100/* misc.c */
101extern void	chrsave(int);
102extern char 	*compute_prevep(void);
103extern void	getdiv(int);
104extern ptrdiff_t indx(const char *, const char *);
105extern void 	initspaces(void);
106extern void	killdiv(void);
107extern void	pbnum(int);
108extern void	pbnumbase(int, int, int);
109extern void	pbunsigned(unsigned long);
110extern void	pbstr(const char *);
111extern void	pushback(int);
112extern void	*xalloc(size_t, const char *fmt, ...) __printflike(2, 3);
113extern void	*xrealloc(void *, size_t, const char *fmt, ...)
114    __printflike(3, 4);
115extern char	*xstrdup(const char *);
116extern void	resizedivs(int);
117extern size_t	buffer_mark(void);
118extern void	dump_buffer(FILE *, size_t);
119extern void	__dead m4errx(int, const char *, ...) __printflike(2, 3);
120
121extern int 	obtain_char(struct input_file *);
122extern void	set_input(struct input_file *, FILE *, const char *);
123extern void	release_input(struct input_file *);
124
125/* speeded-up versions of chrsave/pushback */
126#define PUSHBACK(c)				\
127	do {					\
128		if (bp >= endpbb)		\
129			enlarge_bufspace();	\
130		*bp++ = (c);			\
131	} while(0)
132
133#define CHRSAVE(c)				\
134	do {					\
135		if (ep >= endest)		\
136			enlarge_strspace();	\
137		*ep++ = (c);			\
138	} while(0)
139
140/* and corresponding exposure for local symbols */
141extern void enlarge_bufspace(void);
142extern void enlarge_strspace(void);
143extern unsigned char *endpbb;
144extern char *endest;
145
146/* trace.c */
147extern unsigned int trace_flags;
148#define TRACE_ALL	512
149extern int trace_file(const char *);
150extern size_t trace(const char **, int, struct input_file *);
151extern void finish_trace(size_t);
152extern void set_trace_flags(const char *);
153extern FILE *traceout;
154
155extern ndptr hashtab[];		/* hash table for macros etc. */
156extern stae *mstack;		/* stack of m4 machine */
157extern char *sstack;		/* shadow stack, for string space extension */
158extern FILE *active;		/* active output file pointer */
159extern struct input_file infile[];/* input file stack (0=stdin) */
160extern FILE **outfile;		/* diversion array(0=bitbucket) */
161extern int maxout;		/* maximum number of diversions */
162extern int fp; 			/* m4 call frame pointer */
163extern int ilevel;		/* input file stack pointer */
164extern int oindex;		/* diversion index. */
165extern int sp;			/* current m4 stack pointer */
166extern unsigned char *bp;	/* first available character */
167extern unsigned char *buf;	/* push-back buffer */
168extern unsigned char *bufbase;	/* buffer base for this ilevel */
169extern unsigned char *bbase[];	/* buffer base per ilevel */
170extern char ecommt[MAXCCHARS+1];/* end character for comment */
171extern char *ep;		/* first free char in strspace */
172extern char lquote[MAXCCHARS+1];/* left quote character (`) */
173extern char **m4wraps;		/* m4wrap string default. */
174extern int maxwraps;		/* size of m4wraps array */
175extern int wrapindex;		/* current index in m4wraps */
176extern int fatal_warnings;	/* exit on warning */
177extern int quiet;		/* no warnings */
178extern int nesting_limit;	/* macro expansion nesting limit */
179#ifndef REAL_FREEZE
180extern FILE *freezef;		/* copy of input */
181extern int thawing;		/* don't process includes during thaw */
182#endif
183
184extern const char *null;	/* as it says.. just a null. */
185extern char rquote[MAXCCHARS+1];/* right quote character (') */
186extern char scommt[MAXCCHARS+1];/* start character for comment */
187extern int  synch_lines;	/* line synchronisation directives */
188
189extern int mimic_gnu;		/* behaves like gnu-m4 */
190extern int prefix_builtins;	/* prefix builtin macros with m4_ */
191