xref: /freebsd/usr.bin/m4/extern.h (revision 3bdf775801b218aa5a89564839405b122f4b233e)
1 /*	$OpenBSD: extern.h,v 1.52 2012/04/12 17:00:11 espie Exp $	*/
2 /*	$NetBSD: extern.h,v 1.3 1996/01/13 23:25:24 pk 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  * $FreeBSD$
37  */
38 
39 /* eval.c */
40 extern void	eval(const char *[], int, int, int);
41 extern void	dodefine(const char *, const char *);
42 extern unsigned long expansion_id;
43 
44 /* expr.c */
45 extern int	expr(const char *);
46 extern int32_t end_result;
47 
48 /* gnum4.c */
49 extern void	addtoincludepath(const char *);
50 extern struct input_file *fopen_trypath(struct input_file *, const char *);
51 extern void doindir(const char *[], int);
52 extern void dobuiltin(const char *[], int);
53 extern void dopatsubst(const char *[], int);
54 extern void doregexp(const char *[], int);
55 
56 extern void doprintlineno(struct input_file *);
57 extern void doprintfilename(struct input_file *);
58 
59 extern void doesyscmd(const char *);
60 extern void getdivfile(const char *);
61 extern void doformat(const char *[], int);
62 
63 /* look.c */
64 
65 #define FLAG_UNTRACED 0
66 #define FLAG_TRACED 1
67 #define FLAG_NO_TRACE 2
68 
69 extern void	init_macros(void);
70 extern ndptr	lookup(const char *);
71 extern void mark_traced(const char *, int);
72 extern struct ohash macros;
73 
74 extern struct macro_definition *lookup_macro_definition(const char *);
75 extern void	macro_define(const char *, const char *);
76 extern void	macro_pushdef(const char *, const char *);
77 extern void	macro_popdef(const char *);
78 extern void	macro_undefine(const char *);
79 extern void	setup_builtin(const char *, unsigned int);
80 extern void	macro_for_all(void (*)(const char *, struct macro_definition *));
81 #define macro_getdef(p)		((p)->d)
82 #define macro_name(p)		((p)->name)
83 #define macro_builtin_type(p)	((p)->builtin_type)
84 #define is_traced(p) ((p)->trace_flags == FLAG_NO_TRACE ? (trace_flags & TRACE_ALL) : (p)->trace_flags)
85 
86 extern ndptr macro_getbuiltin(const char *);
87 
88 /* main.c */
89 extern void outputstr(const char *);
90 extern void do_emit_synchline(void);
91 extern int exit_code;
92 #define emit_synchline() do { if (synch_lines) do_emit_synchline(); } while(0)
93 
94 /* misc.c */
95 extern void	chrsave(int);
96 extern char	*compute_prevep(void);
97 extern void	getdiv(int);
98 extern ptrdiff_t indx(const char *, const char *);
99 extern void	initspaces(void);
100 extern void	killdiv(void);
101 extern void	onintr(int);
102 extern void	pbnum(int);
103 extern void	pbnumbase(int, int, int);
104 extern void	pbunsigned(unsigned long);
105 extern void	pbstr(const char *);
106 extern void	pushback(int);
107 extern void	*xalloc(size_t, const char *fmt, ...);
108 extern void	*xrealloc(void *, size_t, const char *fmt, ...);
109 extern char	*xstrdup(const char *);
110 extern void	usage(void);
111 extern void	resizedivs(int);
112 extern size_t	buffer_mark(void);
113 extern void	dump_buffer(FILE *, size_t);
114 extern void	m4errx(int, const char *, ...);
115 
116 extern int	obtain_char(struct input_file *);
117 extern void	set_input(struct input_file *, FILE *, const char *);
118 extern void	release_input(struct input_file *);
119 
120 /* speeded-up versions of chrsave/pushback */
121 #define PUSHBACK(c)				\
122 	do {					\
123 		if (bp >= endpbb)		\
124 			enlarge_bufspace();	\
125 		*bp++ = (c);			\
126 	} while(0)
127 
128 #define CHRSAVE(c)				\
129 	do {					\
130 		if (ep >= endest)		\
131 			enlarge_strspace();	\
132 		*ep++ = (c);			\
133 	} while(0)
134 
135 /* and corresponding exposure for local symbols */
136 extern void enlarge_bufspace(void);
137 extern void enlarge_strspace(void);
138 extern unsigned char *endpbb;
139 extern char *endest;
140 
141 /* trace.c */
142 extern unsigned int trace_flags;
143 #define TRACE_ALL	512
144 extern void trace_file(const char *);
145 extern size_t trace(const char **, int, struct input_file *);
146 extern void finish_trace(size_t);
147 extern void set_trace_flags(const char *);
148 extern FILE *traceout;
149 
150 extern stae *mstack;		/* stack of m4 machine */
151 extern char *sstack;		/* shadow stack, for string space extension */
152 extern FILE *active;		/* active output file pointer */
153 extern struct input_file infile[];/* input file stack (0=stdin) */
154 extern FILE **outfile;		/* diversion array(0=bitbucket) */
155 extern int maxout;		/* maximum number of diversions */
156 extern int fp;			/* m4 call frame pointer */
157 extern int ilevel;		/* input file stack pointer */
158 extern int oindex;		/* diversion index. */
159 extern int sp;			/* current m4 stack pointer */
160 extern unsigned char *bp;	/* first available character */
161 extern unsigned char *buf;	/* push-back buffer */
162 extern unsigned char *bufbase;	/* buffer base for this ilevel */
163 extern unsigned char *bbase[];	/* buffer base per ilevel */
164 extern char ecommt[MAXCCHARS+1];/* end character for comment */
165 extern char *ep;		/* first free char in strspace */
166 extern char lquote[MAXCCHARS+1];/* left quote character (`) */
167 extern char **m4wraps;		/* m4wrap string default. */
168 extern int maxwraps;		/* size of m4wraps array */
169 extern int wrapindex;		/* current index in m4wraps */
170 
171 extern const char *null;	/* as it says.. just a null. */
172 extern char rquote[MAXCCHARS+1];/* right quote character (') */
173 extern char scommt[MAXCCHARS+1];/* start character for comment */
174 extern int  synch_lines;	/* line synchronisation directives */
175 
176 extern int mimic_gnu;		/* behaves like gnu-m4 */
177 extern int prefix_builtins;	/* prefix builtin macros with m4_ */
178 
179