usr.bin/m4/mdef.h

   1 /*      $OpenBSD: mdef.h,v 1.33 2015/11/03 16:21:47 deraadt Exp $       */
   2 /*      $NetBSD: mdef.h,v 1.7 1996/01/13 23:25:27 pk Exp $      */
   3
   4 /*-
   5  * SPDX-License-Identifier: BSD-3-Clause
   6  *
   7  * Copyright (c) 1989, 1993
   8  *      The Regents of the University of California.  All rights reserved.
   9  *
  10  * This code is derived from software contributed to Berkeley by
  11  * Ozan Yigit at York University.
  12  *
  13  * Redistribution and use in source and binary forms, with or without
  14  * modification, are permitted provided that the following conditions
  15  * are met:
  16  * 1. Redistributions of source code must retain the above copyright
  17  *    notice, this list of conditions and the following disclaimer.
  18  * 2. Redistributions in binary form must reproduce the above copyright
  19  *    notice, this list of conditions and the following disclaimer in the
  20  *    documentation and/or other materials provided with the distribution.
  21  * 3. Neither the name of the University nor the names of its contributors
  22  *    may be used to endorse or promote products derived from this software
  23  *    without specific prior written permission.
  24  *
  25  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  26  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  27  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  28  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  29  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  30  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  31  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  32  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  33  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  34  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  35  * SUCH DAMAGE.
  36  *
  37  *      @(#)mdef.h      8.1 (Berkeley) 6/6/93
  38  */
  39
  40 #ifdef __GNUC__
  41 # define UNUSED __attribute__((__unused__))
  42 #else
  43 # define UNUSED
  44 #endif
  45
  46 #define MACRTYPE        1
  47 #define DEFITYPE        2
  48 #define EXPRTYPE        3
  49 #define SUBSTYPE        4
  50 #define IFELTYPE        5
  51 #define LENGTYPE        6
  52 #define CHNQTYPE        7
  53 #define SYSCTYPE        8
  54 #define UNDFTYPE        9
  55 #define INCLTYPE        10
  56 #define SINCTYPE        11
  57 #define PASTTYPE        12
  58 #define SPASTYPE        13
  59 #define INCRTYPE        14
  60 #define IFDFTYPE        15
  61 #define PUSDTYPE        16
  62 #define POPDTYPE        17
  63 #define SHIFTYPE        18
  64 #define DECRTYPE        19
  65 #define DIVRTYPE        20
  66 #define UNDVTYPE        21
  67 #define DIVNTYPE        22
  68 #define MKTMTYPE        23
  69 #define ERRPTYPE        24
  70 #define M4WRTYPE        25
  71 #define TRNLTYPE        26
  72 #define DNLNTYPE        27
  73 #define DUMPTYPE        28
  74 #define CHNCTYPE        29
  75 #define INDXTYPE        30
  76 #define SYSVTYPE        31
  77 #define EXITTYPE        32
  78 #define DEFNTYPE        33
  79 #define SELFTYPE        34
  80 #define INDIRTYPE       35
  81 #define BUILTINTYPE     36
  82 #define PATSTYPE        37
  83 #define FILENAMETYPE    38
  84 #define LINETYPE        39
  85 #define REGEXPTYPE      40
  86 #define ESYSCMDTYPE     41
  87 #define TRACEONTYPE     42
  88 #define TRACEOFFTYPE    43
  89 #define FORMATTYPE      44
  90
  91 #define BUILTIN_MARKER  "__builtin_"
  92
  93 #define TYPEMASK        63      /* Keep bits really corresponding to a type. */
  94 #define RECDEF          256     /* Pure recursive def, don't expand it */
  95 #define NOARGS          512     /* builtin needs no args */
  96 #define NEEDARGS        1024    /* mark builtin that need args with this */
  97
  98 /*
  99  * m4 special characters
 100  */
 101
 102 #define ARGFLAG         '$'
 103 #define LPAREN          '('
 104 #define RPAREN          ')'
 105 #define LQUOTE          '`'
 106 #define RQUOTE          '\''
 107 #define COMMA           ','
 108 #define SCOMMT          '#'
 109 #define ECOMMT          '\n'
 110
 111 /*
 112  * other important constants
 113  */
 114
 115 #define EOS             '\0'
 116 #define MAXINP          10              /* maximum include files            */
 117 #define MAXOUT          10              /* maximum # of diversions          */
 118 #define BUFSIZE         4096            /* starting size of pushback buffer */
 119 #define INITSTACKMAX    4096            /* starting size of call stack      */
 120 #define STRSPMAX        4096            /* starting size of string space    */
 121 #define MAXTOK          512             /* maximum chars in a tokn          */
 122 #define MAXCCHARS       5               /* max size of comment/quote delim  */
 123
 124 #define ALL             1
 125 #define TOP             0
 126
 127 #define TRUE            1
 128 #define FALSE           0
 129 #define cycle           for(;;)
 130
 131 /*
 132  * m4 data structures
 133  */
 134
 135 typedef struct ndblock *ndptr;
 136
 137 struct macro_definition {
 138         struct macro_definition *next;
 139         char            *defn;  /* definition..               */
 140         unsigned int    type;   /* type of the entry..        */
 141 };
 142
 143
 144 struct ndblock {                        /* hashtable structure         */
 145         unsigned int            builtin_type;
 146         unsigned int            trace_flags;
 147         struct macro_definition *d;
 148         char            name[1];        /* entry name..               */
 149 };
 150
 151 typedef union {                 /* stack structure */
 152         int     sfra;           /* frame entry  */
 153         char    *sstr;          /* string entry */
 154 } stae;
 155
 156 struct input_file {
 157         FILE            *file;
 158         char            *name;
 159         unsigned long   lineno;
 160         unsigned long   synch_lineno;   /* used for -s */
 161         int             c;
 162 };
 163
 164 #define STORAGE_STRSPACE 0
 165 #define STORAGE_MACRO 1
 166 #define STORAGE_OTHER 2
 167
 168 #define CURRENT_NAME    (infile[ilevel].name)
 169 #define CURRENT_LINE    (infile[ilevel].lineno)
 170 /*
 171  * macros for readibility and/or speed
 172  *
 173  *      gpbc()  - get a possibly pushed-back character
 174  *      pushf() - push a call frame entry onto stack
 175  *      pushs() - push a string pointer onto stack
 176  */
 177 #define gpbc()   (bp > bufbase) ? *--bp : obtain_char(infile+ilevel)
 178 #define pushf(x)                        \
 179         do {                            \
 180                 if (++sp == (int)STACKMAX)      \
 181                         enlarge_stack();\
 182                 mstack[sp].sfra = (x);  \
 183                 sstack[sp] = STORAGE_OTHER; \
 184         } while (0)
 185
 186 #define pushs(x)                        \
 187         do {                            \
 188                 if (++sp == (int)STACKMAX)      \
 189                         enlarge_stack();\
 190                 mstack[sp].sstr = (x);  \
 191                 sstack[sp] = STORAGE_STRSPACE; \
 192         } while (0)
 193
 194 #define pushs1(x)                       \
 195         do {                            \
 196                 if (++sp == (int)STACKMAX)      \
 197                         enlarge_stack();\
 198                 mstack[sp].sstr = (x);  \
 199                 sstack[sp] = STORAGE_OTHER; \
 200         } while (0)
 201
 202 #define pushdef(p)                      \
 203         do {                            \
 204                 if (++sp == (int)STACKMAX)      \
 205                         enlarge_stack();\
 206                 mstack[sp].sstr = macro_getdef(p)->defn;\
 207                 sstack[sp] = STORAGE_MACRO; \
 208         } while (0)
 209
 210
 211 /*
 212  *          .                              .
 213  *      |   .   |  <-- sp               |  .  |
 214  *      +-------+                       +-----+
 215  *      | arg 3 ----------------------->| str |
 216  *      +-------+                       |  .  |
 217  *      | arg 2 ---PREVEP-----+            .
 218  *      +-------+             |
 219  *          .                 |         |     |
 220  *      +-------+             |         +-----+
 221  *      | plev  |  PARLEV     +-------->| str |
 222  *      +-------+                       |  .  |
 223  *      | type  |  CALTYP                  .
 224  *      +-------+
 225  *      | prcf  ---PREVFP--+
 226  *      +-------+          |
 227  *      |   .   |  PREVSP  |
 228  *          .              |
 229  *      +-------+          |
 230  *      |       <----------+
 231  *      +-------+
 232  *
 233  */
 234 #define PARLEV  (mstack[fp].sfra)
 235 #define CALTYP  (mstack[fp-2].sfra)
 236 #define TRACESTATUS (mstack[fp-1].sfra)
 237 #define PREVEP  (mstack[fp+3].sstr)
 238 #define PREVSP  (fp-4)
 239 #define PREVFP  (mstack[fp-3].sfra)