usr.bin/m4/extern.h

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