Annotation of src/usr.bin/m4/mdef.h, Revision 1.9
1.9 ! espie 1: /* $OpenBSD: mdef.h,v 1.8 1999/11/20 17:49:00 espie Exp $ */
1.2 deraadt 2: /* $NetBSD: mdef.h,v 1.7 1996/01/13 23:25:27 pk Exp $ */
1.1 deraadt 3:
4: /*
5: * Copyright (c) 1989, 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. All advertising materials mentioning features or use of this software
20: * must display the following acknowledgement:
21: * This product includes software developed by the University of
22: * California, Berkeley and its contributors.
23: * 4. Neither the name of the University nor the names of its contributors
24: * may be used to endorse or promote products derived from this software
25: * without specific prior written permission.
26: *
27: * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28: * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30: * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33: * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35: * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36: * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37: * SUCH DAMAGE.
38: *
39: * @(#)mdef.h 8.1 (Berkeley) 6/6/93
40: */
41:
42: #define MACRTYPE 1
43: #define DEFITYPE 2
44: #define EXPRTYPE 3
45: #define SUBSTYPE 4
46: #define IFELTYPE 5
47: #define LENGTYPE 6
48: #define CHNQTYPE 7
49: #define SYSCTYPE 8
50: #define UNDFTYPE 9
51: #define INCLTYPE 10
52: #define SINCTYPE 11
53: #define PASTTYPE 12
54: #define SPASTYPE 13
55: #define INCRTYPE 14
56: #define IFDFTYPE 15
57: #define PUSDTYPE 16
58: #define POPDTYPE 17
59: #define SHIFTYPE 18
60: #define DECRTYPE 19
61: #define DIVRTYPE 20
62: #define UNDVTYPE 21
63: #define DIVNTYPE 22
64: #define MKTMTYPE 23
65: #define ERRPTYPE 24
66: #define M4WRTYPE 25
67: #define TRNLTYPE 26
68: #define DNLNTYPE 27
69: #define DUMPTYPE 28
70: #define CHNCTYPE 29
71: #define INDXTYPE 30
72: #define SYSVTYPE 31
73: #define EXITTYPE 32
74: #define DEFNTYPE 33
75:
1.9 ! espie 76: #define TYPEMASK 63 /* Keep bits really corresponding to a type. */
! 77: #define STATIC 128 /* Name is statically allocated, don't free. */
! 78: #define RECDEF 256 /* Pure recursive def, don't expand it */
1.1 deraadt 79:
80: /*
81: * m4 special characters
82: */
83:
84: #define ARGFLAG '$'
85: #define LPAREN '('
86: #define RPAREN ')'
87: #define LQUOTE '`'
88: #define RQUOTE '\''
89: #define COMMA ','
90: #define SCOMMT '#'
91: #define ECOMMT '\n'
92:
93: #ifdef msdos
94: #define system(str) (-1)
95: #endif
96:
97: /*
98: * other important constants
99: */
100:
1.5 espie 101: #define EOS '\0'
1.6 espie 102: #define MAXINP 10 /* maximum include files */
103: #define MAXOUT 10 /* maximum # of diversions */
104: #define MAXSTR 512 /* maximum size of string */
105: #define BUFSIZE 4096 /* starting size of pushback buffer */
1.7 espie 106: #define STACKMAX 4096 /* size of call stack */
1.6 espie 107: #define STRSPMAX 4096 /* starting size of string space */
108: #define MAXTOK MAXSTR /* maximum chars in a tokn */
109: #define HASHSIZE 199 /* maximum size of hashtab */
110: #define MAXCCHARS 5 /* max size of comment/quote delim */
1.1 deraadt 111:
112: #define ALL 1
113: #define TOP 0
114:
115: #define TRUE 1
116: #define FALSE 0
117: #define cycle for(;;)
118:
119: /*
120: * m4 data structures
121: */
122:
123: typedef struct ndblock *ndptr;
124:
1.9 ! espie 125: struct ndblock { /* hastable structure */
! 126: char *name; /* entry name.. */
! 127: char *defn; /* definition.. */
! 128: unsigned int type; /* type of the entry.. */
! 129: unsigned int hv; /* hash function value.. */
! 130: ndptr nxtptr; /* link to next entry.. */
1.1 deraadt 131: };
132:
133: #define nil ((ndptr) 0)
134:
135: struct keyblk {
136: char *knam; /* keyword name */
137: int ktyp; /* keyword type */
138: };
139:
140: typedef union { /* stack structure */
141: int sfra; /* frame entry */
142: char *sstr; /* string entry */
143: } stae;
1.4 deraadt 144:
145: typedef short pbent; /* pushback entry; needs to hold chars + EOF */
1.1 deraadt 146:
147: /*
148: * macros for readibility and/or speed
149: *
150: * gpbc() - get a possibly pushed-back character
151: * pushf() - push a call frame entry onto stack
152: * pushs() - push a string pointer onto stack
153: */
154: #define gpbc() (bp > bufbase) ? *--bp : getc(infile[ilevel])
155: #define pushf(x) if (sp < STACKMAX) mstack[++sp].sfra = (x)
156: #define pushs(x) if (sp < STACKMAX) mstack[++sp].sstr = (x)
157:
158: /*
159: * . .
160: * | . | <-- sp | . |
161: * +-------+ +-----+
162: * | arg 3 ----------------------->| str |
163: * +-------+ | . |
164: * | arg 2 ---PREVEP-----+ .
165: * +-------+ |
166: * . | | |
167: * +-------+ | +-----+
168: * | plev | PARLEV +-------->| str |
169: * +-------+ | . |
170: * | type | CALTYP .
171: * +-------+
172: * | prcf ---PREVFP--+
173: * +-------+ |
174: * | . | PREVSP |
175: * . |
176: * +-------+ |
177: * | <----------+
178: * +-------+
179: *
180: */
181: #define PARLEV (mstack[fp].sfra)
182: #define CALTYP (mstack[fp-1].sfra)
1.6 espie 183: #define PREVEP compute_prevep()
1.1 deraadt 184: #define PREVSP (fp-3)
185: #define PREVFP (mstack[fp-2].sfra)