Home | History | Annotate | Line # | Download | only in m4
      1 /*	$NetBSD: mdef.h,v 1.18 2026/06/10 22:25:02 christos Exp $	*/
      2 /*	$OpenBSD: mdef.h,v 1.35 2026/02/25 05:37:25 op Exp $	*/
      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. 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  *	@(#)mdef.h	8.1 (Berkeley) 6/6/93
     36  */
     37 
     38 #ifdef __GNUC__
     39 # define UNUSED	__attribute__((__unused__))
     40 #else
     41 # define UNUSED
     42 #endif
     43 
     44 #define MACROTYPE		1
     45 #define DEFINETYPE		2
     46 #define EVALTYPE		3
     47 #define SUBSTRTYPE		4
     48 #define IFELSETYPE		5
     49 #define LENTYPE			6
     50 #define CHANGEQUOTETYPE		7
     51 #define SYSCMDTYPE		8
     52 #define UNDEFINETYPE		9
     53 #define INCLUDETYPE		10
     54 #define SINCLUDETYPE		11
     55 #define PASTETYPE		12
     56 #define SPASTETYPE		13
     57 #define INCRTYPE		14
     58 #define IFDEFTYPE		15
     59 #define PUSHDEFTYPE		16
     60 #define POPDEFTYPE		17
     61 #define SHIFTTYPE		18
     62 #define DECRTYPE		19
     63 #define DIVERTTYPE		20
     64 #define UNDIVERTTYPE		21
     65 #define DIVNUMTYPE		22
     66 #define MKSTEMPTYPE		23
     67 #define ERRPRINTTYPE		24
     68 #define M4WRAPTYPE		25
     69 #define TRANSLITTYPE		26
     70 #define DNLTYPE			27
     71 #define DUMPDEFTYPE		28
     72 #define CHANGECOMTYPE		29
     73 #define INDEXTYPE		30
     74 #define SYSVALTYPE		31
     75 #define M4EXITTYPE		32
     76 #define DEFNTYPE		33
     77 #define SELFTYPE		34
     78 #define INDIRTYPE		35
     79 #define BUILTINTYPE		36
     80 #define PATSUBSTTYPE		37
     81 #define FILENAMETYPE		38
     82 #define LINETYPE		39
     83 #define REGEXPTYPE		40
     84 #define ESYSCMDTYPE		41
     85 #define TRACEONTYPE		42
     86 #define TRACEOFFTYPE		43
     87 #define FORMATTYPE		44
     88 
     89 #define BUILTIN_MARKER	"__builtin_"
     90 
     91 #define TYPEMASK	63	/* Keep bits really corresponding to a type. */
     92 #define RECDEF		256	/* Pure recursive def, don't expand it */
     93 #define NOARGS		512	/* builtin needs no args */
     94 #define NEEDARGS	1024	/* mark builtin that need args with this */
     95 
     96 /*
     97  * m4 special characters
     98  */
     99 
    100 #define ARGFLAG         '$'
    101 #define LPAREN          '('
    102 #define RPAREN          ')'
    103 #define LQUOTE          '`'
    104 #define RQUOTE          '\''
    105 #define COMMA           ','
    106 #define SCOMMT          '#'
    107 #define ECOMMT          '\n'
    108 
    109 /*
    110  * other important constants
    111  */
    112 
    113 #define EOS             '\0'
    114 #define MAXINP          10              /* maximum include files	    */
    115 #define MAXOUT          10              /* maximum # of diversions	    */
    116 #define BUFSIZE         4096            /* starting size of pushback buffer */
    117 #define INITSTACKMAX    4096		/* starting size of call stack      */
    118 #define STRSPMAX        4096            /* starting size of string space    */
    119 #define MAXTOK          512		/* maximum chars in a tokn	    */
    120 #define HASHSIZE        199		/* maximum size of hashtab        */
    121 #define MAXCCHARS	5		/* max size of comment/quote delim  */
    122 
    123 #define ALL             1
    124 #define TOP             0
    125 
    126 #ifndef TRUE
    127 #define TRUE            1
    128 #endif
    129 #ifndef FALSE
    130 #define FALSE           0
    131 #endif
    132 #define cycle           for(;;)
    133 
    134 /*
    135  * m4 data structures
    136  */
    137 
    138 typedef struct ndblock *ndptr;
    139 
    140 struct macro_definition {
    141 	struct macro_definition *next;
    142 	char		*defn;	/* definition..               */
    143 	unsigned int	type;	/* type of the entry..        */
    144 };
    145 
    146 
    147 struct ndblock {			/* hashtable structure         */
    148 	unsigned int		builtin_type;
    149 	unsigned int		trace_flags;
    150 	struct macro_definition *d;
    151 	char		name[1];	/* entry name..               */
    152 };
    153 
    154 typedef union {			/* stack structure */
    155 	int	sfra;		/* frame entry  */
    156 	char	*sstr;		/* string entry */
    157 } stae;
    158 
    159 struct input_file {
    160 	FILE		*file;
    161 	char		*name;
    162 	unsigned long	lineno;
    163 	unsigned long   synch_lineno;	/* used for -s */
    164 	int		c;
    165 };
    166 
    167 #define STORAGE_STRSPACE 0
    168 #define STORAGE_MACRO 1
    169 #define STORAGE_OTHER 2
    170 
    171 #define CURRENT_NAME	(infile[ilevel].name)
    172 #define CURRENT_LINE	(infile[ilevel].lineno)
    173 #define TOKEN_LINE(f)	((f)->lineno - ((f)->c == '\n' ? 1 : 0))
    174 
    175 /*
    176  * macros for readability and/or speed
    177  *
    178  *      gpbc()  - get a possibly pushed-back character
    179  *      pushf() - push a call frame entry onto stack
    180  *      pushs() - push a string pointer onto stack
    181  */
    182 #define gpbc()	 (bp > bufbase) ? *--bp : obtain_char(infile+ilevel)
    183 #define pushf(x)			\
    184 	do {				\
    185 		if ((size_t)++sp == STACKMAX)	\
    186 			enlarge_stack();\
    187 		mstack[sp].sfra = (x);	\
    188 		sstack[sp] = STORAGE_OTHER; \
    189 	} while (0)
    190 
    191 #define pushs(x)			\
    192 	do {				\
    193 		if ((size_t)++sp == STACKMAX)	\
    194 			enlarge_stack();\
    195 		mstack[sp].sstr = (x);	\
    196 		sstack[sp] = STORAGE_STRSPACE; \
    197 	} while (0)
    198 
    199 #define pushs1(x)			\
    200 	do {				\
    201 		if ((size_t)++sp == STACKMAX)	\
    202 			enlarge_stack();\
    203 		mstack[sp].sstr = (x);	\
    204 		sstack[sp] = STORAGE_OTHER; \
    205 	} while (0)
    206 
    207 #define pushdef(p)			\
    208 	do {				\
    209 		if ((size_t)++sp == STACKMAX)	\
    210 			enlarge_stack();\
    211 		mstack[sp].sstr = macro_getdef(p)->defn;\
    212 		sstack[sp] = STORAGE_MACRO; \
    213 	} while (0)
    214 
    215 
    216 /*
    217  *	    .				   .
    218  *	|   .	|  <-- sp		|  .  |
    219  *	+-------+			+-----+
    220  *	| arg 3 ----------------------->| str |
    221  *	+-------+			|  .  |
    222  *	| arg 2 ---PREVEP-----+		   .
    223  *	+-------+	      |
    224  *	    .		      |		|     |
    225  *	+-------+	      |		+-----+
    226  *	| plev	|  PARLEV     +-------->| str |
    227  *	+-------+			|  .  |
    228  *	| type	|  CALTYP		   .
    229  *	+-------+
    230  *	| prcf	---PREVFP--+
    231  *	+-------+	   |
    232  *	|   .	|  PREVSP  |
    233  *	    .		   |
    234  *	+-------+	   |
    235  *	|	<----------+
    236  *	+-------+
    237  *
    238  */
    239 #define PARLEV  (mstack[fp].sfra)
    240 #define CALTYP  (mstack[fp-2].sfra)
    241 #define TRACESTATUS (mstack[fp-1].sfra)
    242 #define PREVEP	(mstack[fp+3].sstr)
    243 #define PREVSP	(fp-4)
    244 #define PREVFP	(mstack[fp-3].sfra)
    245 
    246 #define VERSION       20260610
    247 
    248