/*      $NetBSD: mdef.h,v 1.18 2026/06/10 22:25:02 christos Exp $       */
/*      $OpenBSD: mdef.h,v 1.35 2026/02/25 05:37:25 op Exp $    */

/*
 * Copyright (c) 1989, 1993
 *      The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Ozan Yigit at York University.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *      @(#)mdef.h      8.1 (Berkeley) 6/6/93
 */

#ifdef __GNUC__
# define UNUSED __attribute__((__unused__))
#else
# define UNUSED
#endif

#define MACROTYPE               1
#define DEFINETYPE              2
#define EVALTYPE                3
#define SUBSTRTYPE              4
#define IFELSETYPE              5
#define LENTYPE                 6
#define CHANGEQUOTETYPE         7
#define SYSCMDTYPE              8
#define UNDEFINETYPE            9
#define INCLUDETYPE             10
#define SINCLUDETYPE            11
#define PASTETYPE               12
#define SPASTETYPE              13
#define INCRTYPE                14
#define IFDEFTYPE               15
#define PUSHDEFTYPE             16
#define POPDEFTYPE              17
#define SHIFTTYPE               18
#define DECRTYPE                19
#define DIVERTTYPE              20
#define UNDIVERTTYPE            21
#define DIVNUMTYPE              22
#define MKSTEMPTYPE             23
#define ERRPRINTTYPE            24
#define M4WRAPTYPE              25
#define TRANSLITTYPE            26
#define DNLTYPE                 27
#define DUMPDEFTYPE             28
#define CHANGECOMTYPE           29
#define INDEXTYPE               30
#define SYSVALTYPE              31
#define M4EXITTYPE              32
#define DEFNTYPE                33
#define SELFTYPE                34
#define INDIRTYPE               35
#define BUILTINTYPE             36
#define PATSUBSTTYPE            37
#define FILENAMETYPE            38
#define LINETYPE                39
#define REGEXPTYPE              40
#define ESYSCMDTYPE             41
#define TRACEONTYPE             42
#define TRACEOFFTYPE            43
#define FORMATTYPE              44

#define BUILTIN_MARKER  "__builtin_"

#define TYPEMASK        63      /* Keep bits really corresponding to a type. */
#define RECDEF          256     /* Pure recursive def, don't expand it */
#define NOARGS          512     /* builtin needs no args */
#define NEEDARGS        1024    /* mark builtin that need args with this */

/*
 * m4 special characters
 */

#define ARGFLAG         '$'
#define LPAREN          '('
#define RPAREN          ')'
#define LQUOTE          '`'
#define RQUOTE          '\''
#define COMMA           ','
#define SCOMMT          '#'
#define ECOMMT          '\n'

/*
 * other important constants
 */

#define EOS             '\0'
#define MAXINP          10              /* maximum include files            */
#define MAXOUT          10              /* maximum # of diversions          */
#define BUFSIZE         4096            /* starting size of pushback buffer */
#define INITSTACKMAX    4096            /* starting size of call stack      */
#define STRSPMAX        4096            /* starting size of string space    */
#define MAXTOK          512             /* maximum chars in a tokn          */
#define HASHSIZE        199             /* maximum size of hashtab        */
#define MAXCCHARS       5               /* max size of comment/quote delim  */

#define ALL             1
#define TOP             0

#ifndef TRUE
#define TRUE            1
#endif
#ifndef FALSE
#define FALSE           0
#endif
#define cycle           for(;;)

/*
 * m4 data structures
 */

typedef struct ndblock *ndptr;

struct macro_definition {
        struct macro_definition *next;
        char            *defn;  /* definition..               */
        unsigned int    type;   /* type of the entry..        */
};


struct ndblock {                        /* hashtable structure         */
        unsigned int            builtin_type;
        unsigned int            trace_flags;
        struct macro_definition *d;
        char            name[1];        /* entry name..               */
};

typedef union {                 /* stack structure */
        int     sfra;           /* frame entry  */
        char    *sstr;          /* string entry */
} stae;

struct input_file {
        FILE            *file;
        char            *name;
        unsigned long   lineno;
        unsigned long   synch_lineno;   /* used for -s */
        int             c;
};

#define STORAGE_STRSPACE 0
#define STORAGE_MACRO 1
#define STORAGE_OTHER 2

#define CURRENT_NAME    (infile[ilevel].name)
#define CURRENT_LINE    (infile[ilevel].lineno)
#define TOKEN_LINE(f)   ((f)->lineno - ((f)->c == '\n' ? 1 : 0))

/*
 * macros for readability and/or speed
 *
 *      gpbc()  - get a possibly pushed-back character
 *      pushf() - push a call frame entry onto stack
 *      pushs() - push a string pointer onto stack
 */
#define gpbc()   (bp > bufbase) ? *--bp : obtain_char(infile+ilevel)
#define pushf(x)                        \
        do {                            \
                if ((size_t)++sp == STACKMAX)   \
                        enlarge_stack();\
                mstack[sp].sfra = (x);  \
                sstack[sp] = STORAGE_OTHER; \
        } while (0)

#define pushs(x)                        \
        do {                            \
                if ((size_t)++sp == STACKMAX)   \
                        enlarge_stack();\
                mstack[sp].sstr = (x);  \
                sstack[sp] = STORAGE_STRSPACE; \
        } while (0)

#define pushs1(x)                       \
        do {                            \
                if ((size_t)++sp == STACKMAX)   \
                        enlarge_stack();\
                mstack[sp].sstr = (x);  \
                sstack[sp] = STORAGE_OTHER; \
        } while (0)

#define pushdef(p)                      \
        do {                            \
                if ((size_t)++sp == STACKMAX)   \
                        enlarge_stack();\
                mstack[sp].sstr = macro_getdef(p)->defn;\
                sstack[sp] = STORAGE_MACRO; \
        } while (0)
                

/*
 *          .                              .
 *      |   .   |  <-- sp               |  .  |
 *      +-------+                       +-----+
 *      | arg 3 ----------------------->| str |
 *      +-------+                       |  .  |
 *      | arg 2 ---PREVEP-----+            .
 *      +-------+             |
 *          .                 |         |     |
 *      +-------+             |         +-----+
 *      | plev  |  PARLEV     +-------->| str |
 *      +-------+                       |  .  |
 *      | type  |  CALTYP                  .
 *      +-------+
 *      | prcf  ---PREVFP--+
 *      +-------+          |
 *      |   .   |  PREVSP  |
 *          .              |
 *      +-------+          |
 *      |       <----------+
 *      +-------+
 *
 */
#define PARLEV  (mstack[fp].sfra)
#define CALTYP  (mstack[fp-2].sfra)
#define TRACESTATUS (mstack[fp-1].sfra)
#define PREVEP  (mstack[fp+3].sstr)
#define PREVSP  (fp-4)
#define PREVFP  (mstack[fp-3].sfra)

#define VERSION       20260610