src/m4.h

   1 /* GNU m4 -- A simple macro processor
   2
   3    Copyright (C) 1989, 1990, 1991, 1992, 1993, 1994, 2004, 2005, 2006, 2007
   4    Free Software Foundation, Inc.
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, write to the Free Software
  18    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19    02110-1301  USA
  20 */
  21
  22 /* We use <config.h> instead of "config.h" so that a compilation
  23    using -I. -I$srcdir will use ./config.h rather than $srcdir/config.h
  24    (which it would do because it found this file in $srcdir).  */
  25
  26 #include <config.h>
  27
  28 #include <ctype.h>
  29 #include <errno.h>
  30 #include <stdbool.h>
  31 #include <stdint.h>
  32 #include <string.h>
  33 #include <sys/types.h>
  34
  35 #include "binary-io.h"
  36 #include "clean-temp.h"
  37 #include "cloexec.h"
  38 #include "close-stream.h"
  39 #include "closeout.h"
  40 #include "error.h"
  41 #include "exit.h"
  42 #include "exitfail.h"
  43 #include "obstack.h"
  44 #include "stdio--.h"
  45 #include "stdlib--.h"
  46 #include "unistd--.h"
  47 #include "verror.h"
  48 #include "xalloc.h"
  49 #include "xvasprintf.h"
  50
  51 /* Canonicalize UNIX recognition macros.  */
  52 #if defined unix || defined __unix || defined __unix__ \
  53   || defined _POSIX_VERSION || defined _POSIX2_VERSION \
  54   || defined __NetBSD__ || defined __OpenBSD__ \
  55   || defined __APPLE__ || defined __APPLE_CC__
  56 # define UNIX 1
  57 #endif
  58
  59 /* Canonicalize Windows recognition macros.  */
  60 #if (defined _WIN32 || defined __WIN32__) && !defined __CYGWIN__
  61 # define W32_NATIVE 1
  62 #endif
  63
  64 /* Canonicalize OS/2 recognition macro.  */
  65 #ifdef __EMX__
  66 # define OS2 1
  67 #endif
  68
  69 /* Used for version mismatch, when -R detects a frozen file it can't parse.  */
  70 #define EXIT_MISMATCH 63
  71 \f
  72 /* Various declarations.  */
  73
  74 struct string
  75   {
  76     char *string;               /* characters of the string */
  77     size_t length;              /* length of the string */
  78   };
  79 typedef struct string STRING;
  80
  81 /* Memory allocation.  */
  82 #define obstack_chunk_alloc     xmalloc
  83 #define obstack_chunk_free      free
  84
  85 /* Those must come first.  */
  86 typedef struct token_data token_data;
  87 typedef void builtin_func (struct obstack *, int, token_data **);
  88
  89 /* Gnulib's stdbool doesn't work with bool bitfields.  For nicer
  90    debugging, use bool when we know it works, but use the more
  91    portable unsigned int elsewhere.  */
  92 #if __GNUC__ > 2
  93 typedef bool bool_bitfield;
  94 #else
  95 typedef unsigned int bool_bitfield;
  96 #endif /* ! __GNUC__ */
  97
  98 /* Take advantage of GNU C compiler source level optimization hints,
  99    using portable macros.  */
 100 #if __GNUC__ > 2 || (__GNUC__ == 2 && __GNUC_MINOR__ > 6)
 101 #  define M4_GNUC_ATTRIBUTE(args)       __attribute__(args)
 102 #else
 103 #  define M4_GNUC_ATTRIBUTE(args)
 104 #endif  /* __GNUC__ */
 105
 106 #define M4_GNUC_UNUSED          M4_GNUC_ATTRIBUTE((__unused__))
 107 #define M4_GNUC_PRINTF(fmt, arg)                        \
 108   M4_GNUC_ATTRIBUTE((__format__ (__printf__, fmt, arg)))
 109 \f
 110 /* File: m4.c  --- global definitions.  */
 111
 112 /* Option flags.  */
 113 extern int sync_output;                 /* -s */
 114 extern int debug_level;                 /* -d */
 115 extern size_t hash_table_size;          /* -H */
 116 extern int no_gnu_extensions;           /* -G */
 117 extern int prefix_all_builtins;         /* -P */
 118 extern int max_debug_argument_length;   /* -l */
 119 extern int suppress_warnings;           /* -Q */
 120 extern int warning_status;              /* -E */
 121 extern int nesting_limit;               /* -L */
 122 #ifdef ENABLE_CHANGEWORD
 123 extern const char *user_word_regexp;    /* -W */
 124 #endif
 125
 126 /* Error handling.  */
 127 extern int retcode;
 128 extern const char *program_name;
 129
 130 void m4_error (int, int, const char *, ...) M4_GNUC_PRINTF(3, 4);
 131 void m4_error_at_line (int, int, const char *, int,
 132                        const char *, ...) M4_GNUC_PRINTF(5, 6);
 133
 134 #define M4ERROR(Arglist) (m4_error Arglist)
 135 #define M4ERROR_AT_LINE(Arglist) (m4_error_at_line Arglist)
 136
 137 #ifdef USE_STACKOVF
 138 void setup_stackovf_trap (char *const *, char *const *,
 139                           void (*handler) (void));
 140 #endif
 141 \f
 142 /* File: debug.c  --- debugging and tracing function.  */
 143
 144 extern FILE *debug;
 145
 146 /* The value of debug_level is a bitmask of the following.  */
 147
 148 /* a: show arglist in trace output */
 149 #define DEBUG_TRACE_ARGS 1
 150 /* e: show expansion in trace output */
 151 #define DEBUG_TRACE_EXPANSION 2
 152 /* q: quote args and expansion in trace output */
 153 #define DEBUG_TRACE_QUOTE 4
 154 /* t: trace all macros -- overrides trace{on,off} */
 155 #define DEBUG_TRACE_ALL 8
 156 /* l: add line numbers to trace output */
 157 #define DEBUG_TRACE_LINE 16
 158 /* f: add file name to trace output */
 159 #define DEBUG_TRACE_FILE 32
 160 /* p: trace path search of include files */
 161 #define DEBUG_TRACE_PATH 64
 162 /* c: show macro call before args collection */
 163 #define DEBUG_TRACE_CALL 128
 164 /* i: trace changes of input files */
 165 #define DEBUG_TRACE_INPUT 256
 166 /* x: add call id to trace output */
 167 #define DEBUG_TRACE_CALLID 512
 168
 169 /* V: very verbose --  print everything */
 170 #define DEBUG_TRACE_VERBOSE 1023
 171 /* default flags -- equiv: aeq */
 172 #define DEBUG_TRACE_DEFAULT 7
 173
 174 #define DEBUG_PRINT1(Fmt, Arg1) \
 175   do                                                            \
 176     {                                                           \
 177       if (debug != NULL)                                        \
 178         fprintf (debug, Fmt, Arg1);                             \
 179     }                                                           \
 180   while (0)
 181
 182 #define DEBUG_PRINT3(Fmt, Arg1, Arg2, Arg3) \
 183   do                                                            \
 184     {                                                           \
 185       if (debug != NULL)                                        \
 186         fprintf (debug, Fmt, Arg1, Arg2, Arg3);                 \
 187     }                                                           \
 188   while (0)
 189
 190 #define DEBUG_MESSAGE(Fmt) \
 191   do                                                            \
 192     {                                                           \
 193       if (debug != NULL)                                        \
 194         {                                                       \
 195           debug_message_prefix ();                              \
 196           fprintf (debug, Fmt);                                 \
 197           putc ('\n', debug);                                   \
 198         }                                                       \
 199     }                                                           \
 200   while (0)
 201
 202 #define DEBUG_MESSAGE1(Fmt, Arg1) \
 203   do                                                            \
 204     {                                                           \
 205       if (debug != NULL)                                        \
 206         {                                                       \
 207           debug_message_prefix ();                              \
 208           fprintf (debug, Fmt, Arg1);                           \
 209           putc ('\n', debug);                                   \
 210         }                                                       \
 211     }                                                           \
 212   while (0)
 213
 214 #define DEBUG_MESSAGE2(Fmt, Arg1, Arg2) \
 215   do                                                            \
 216     {                                                           \
 217       if (debug != NULL)                                        \
 218         {                                                       \
 219           debug_message_prefix ();                              \
 220           fprintf (debug, Fmt, Arg1, Arg2);                     \
 221           putc ('\n', debug);                                   \
 222         }                                                       \
 223     }                                                           \
 224   while (0)
 225
 226 void debug_init (void);
 227 int debug_decode (const char *);
 228 void debug_flush_files (void);
 229 bool debug_set_output (const char *);
 230 void debug_message_prefix (void);
 231
 232 void trace_prepre (const char *, int);
 233 void trace_pre (const char *, int, int, token_data **);
 234 void trace_post (const char *, int, int, token_data **, const char *);
 235 \f
 236 /* File: input.c  --- lexical definitions.  */
 237
 238 /* Various different token types.  */
 239 enum token_type
 240 {
 241   TOKEN_EOF,                    /* end of file */
 242   TOKEN_STRING,                 /* a quoted string or comment */
 243   TOKEN_WORD,                   /* an identifier */
 244   TOKEN_OPEN,                   /* ( */
 245   TOKEN_COMMA,                  /* , */
 246   TOKEN_CLOSE,                  /* ) */
 247   TOKEN_SIMPLE,                 /* any other single character */
 248   TOKEN_MACDEF                  /* a macro's definition (see "defn") */
 249 };
 250
 251 /* The data for a token, a macro argument, and a macro definition.  */
 252 enum token_data_type
 253 {
 254   TOKEN_VOID,
 255   TOKEN_TEXT,
 256   TOKEN_FUNC
 257 };
 258
 259 struct token_data
 260 {
 261   enum token_data_type type;
 262   union
 263     {
 264       struct
 265         {
 266           char *text;
 267 #ifdef ENABLE_CHANGEWORD
 268           char *original_text;
 269 #endif
 270         }
 271       u_t;
 272       builtin_func *func;
 273     }
 274   u;
 275 };
 276
 277 #define TOKEN_DATA_TYPE(Td)             ((Td)->type)
 278 #define TOKEN_DATA_TEXT(Td)             ((Td)->u.u_t.text)
 279 #ifdef ENABLE_CHANGEWORD
 280 # define TOKEN_DATA_ORIG_TEXT(Td)       ((Td)->u.u_t.original_text)
 281 #endif
 282 #define TOKEN_DATA_FUNC(Td)             ((Td)->u.func)
 283
 284 typedef enum token_type token_type;
 285 typedef enum token_data_type token_data_type;
 286
 287 void input_init (void);
 288 token_type peek_token (void);
 289 token_type next_token (token_data *);
 290 void skip_line (void);
 291
 292 /* push back input */
 293 void push_file (FILE *, const char *, bool);
 294 void push_macro (builtin_func *);
 295 struct obstack *push_string_init (void);
 296 const char *push_string_finish (void);
 297 void push_wrapup (const char *);
 298 bool pop_wrapup (void);
 299
 300 /* current input file, and line */
 301 extern const char *current_file;
 302 extern int current_line;
 303
 304 /* left and right quote, begin and end comment */
 305 extern STRING bcomm, ecomm;
 306 extern STRING lquote, rquote;
 307
 308 #define DEF_LQUOTE "`"
 309 #define DEF_RQUOTE "\'"
 310 #define DEF_BCOMM "#"
 311 #define DEF_ECOMM "\n"
 312
 313 void set_quotes (const char *, const char *);
 314 void set_comment (const char *, const char *);
 315 #ifdef ENABLE_CHANGEWORD
 316 void set_word_regexp (const char *);
 317 #endif
 318 \f
 319 /* File: output.c --- output functions.  */
 320 extern int current_diversion;
 321 extern int output_current_line;
 322
 323 void output_init (void);
 324 void output_exit (void);
 325 void shipout_text (struct obstack *, const char *, int);
 326 void make_diversion (int);
 327 void insert_diversion (int);
 328 void insert_file (FILE *);
 329 void freeze_diversions (FILE *);
 330 \f
 331 /* File symtab.c  --- symbol table definitions.  */
 332
 333 /* Operation modes for lookup_symbol ().  */
 334 enum symbol_lookup
 335 {
 336   SYMBOL_LOOKUP,
 337   SYMBOL_INSERT,
 338   SYMBOL_DELETE,
 339   SYMBOL_PUSHDEF,
 340   SYMBOL_POPDEF
 341 };
 342
 343 /* Symbol table entry.  */
 344 struct symbol
 345 {
 346   struct symbol *next;
 347   bool_bitfield traced : 1;
 348   bool_bitfield shadowed : 1;
 349   bool_bitfield macro_args : 1;
 350   bool_bitfield blind_no_args : 1;
 351   bool_bitfield deleted : 1;
 352   int pending_expansions;
 353
 354   char *name;
 355   token_data data;
 356 };
 357
 358 #define SYMBOL_NEXT(S)          ((S)->next)
 359 #define SYMBOL_TRACED(S)        ((S)->traced)
 360 #define SYMBOL_SHADOWED(S)      ((S)->shadowed)
 361 #define SYMBOL_MACRO_ARGS(S)    ((S)->macro_args)
 362 #define SYMBOL_BLIND_NO_ARGS(S) ((S)->blind_no_args)
 363 #define SYMBOL_DELETED(S)       ((S)->deleted)
 364 #define SYMBOL_PENDING_EXPANSIONS(S) ((S)->pending_expansions)
 365 #define SYMBOL_NAME(S)          ((S)->name)
 366 #define SYMBOL_TYPE(S)          (TOKEN_DATA_TYPE (&(S)->data))
 367 #define SYMBOL_TEXT(S)          (TOKEN_DATA_TEXT (&(S)->data))
 368 #define SYMBOL_FUNC(S)          (TOKEN_DATA_FUNC (&(S)->data))
 369
 370 typedef enum symbol_lookup symbol_lookup;
 371 typedef struct symbol symbol;
 372 typedef void hack_symbol (symbol *, void *);
 373
 374 #define HASHMAX 509             /* default, overridden by -Hsize */
 375
 376 extern symbol **symtab;
 377
 378 void free_symbol (symbol *sym);
 379 void symtab_init (void);
 380 symbol *lookup_symbol (const char *, symbol_lookup);
 381 void hack_all_symbols (hack_symbol *, void *);
 382 \f
 383 /* File: macro.c  --- macro expansion.  */
 384
 385 void expand_input (void);
 386 void call_macro (symbol *, int, token_data **, struct obstack *);
 387 \f
 388 /* File: builtin.c  --- builtins.  */
 389
 390 struct builtin
 391 {
 392   const char *name;
 393   bool_bitfield gnu_extension : 1;
 394   bool_bitfield groks_macro_args : 1;
 395   bool_bitfield blind_if_no_args : 1;
 396   builtin_func *func;
 397 };
 398
 399 struct predefined
 400 {
 401   const char *unix_name;
 402   const char *gnu_name;
 403   const char *func;
 404 };
 405
 406 typedef struct builtin builtin;
 407 typedef struct predefined predefined;
 408 struct re_pattern_buffer;
 409 struct re_registers;
 410
 411 void builtin_init (void);
 412 void define_builtin (const char *, const builtin *, symbol_lookup);
 413 void set_macro_sequence (const char *);
 414 void free_macro_sequence (void);
 415 void define_user_macro (const char *, const char *, symbol_lookup);
 416 void undivert_all (void);
 417 void expand_user_macro (struct obstack *, symbol *, int, token_data **);
 418 void m4_placeholder (struct obstack *, int, token_data **);
 419 void init_pattern_buffer (struct re_pattern_buffer *, struct re_registers *);
 420
 421 const builtin *find_builtin_by_addr (builtin_func *);
 422 const builtin *find_builtin_by_name (const char *);
 423 \f
 424 /* File: path.c  --- path search for include files.  */
 425
 426 void include_init (void);
 427 void include_env_init (void);
 428 void add_include_directory (const char *);
 429 FILE *m4_path_search (const char *, char **);
 430 \f
 431 /* File: eval.c  --- expression evaluation.  */
 432
 433 bool evaluate (const char *, int32_t *);
 434 \f
 435 /* File: format.c  --- printf like formatting.  */
 436
 437 void format (struct obstack *, int, token_data **);
 438 \f
 439 /* File: freeze.c --- frozen state files.  */
 440
 441 void produce_frozen_state (const char *);
 442 void reload_frozen_state (const char *);
 443 \f
 444 /* Debugging the memory allocator.  */
 445
 446 #ifdef WITH_DMALLOC
 447 # define DMALLOC_FUNC_CHECK
 448 # include <dmalloc.h>
 449 #endif
 450
 451 /* Other debug stuff.  */
 452
 453 #ifdef DEBUG
 454 # define DEBUG_INCL   1
 455 # define DEBUG_INPUT  1
 456 # define DEBUG_MACRO  1
 457 # define DEBUG_OUTPUT 1
 458 # define DEBUG_STKOVF 1
 459 # define DEBUG_SYM    1
 460 #endif
 461
 462 /* Convert a possibly-signed character to an unsigned character.  This is
 463    a bit safer than casting to unsigned char, since it catches some type
 464    errors that the cast doesn't.  */
 465 #if HAVE_INLINE
 466 static inline unsigned char to_uchar (char ch) { return ch; }
 467 #else
 468 # define to_uchar(C) ((unsigned char) (C))
 469 #endif