gcc/cpphash.h

   1 /* Part of CPP library.
   2    Copyright (C) 1997, 1998, 1999, 2000, 2001 Free Software Foundation, Inc.
   3
   4 This program is free software; you can redistribute it and/or modify it
   5 under the terms of the GNU General Public License as published by the
   6 Free Software Foundation; either version 2, or (at your option) any
   7 later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 GNU General Public License for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program; if not, write to the Free Software
  16 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  17
  18 /* This header defines all the internal data structures and functions
  19    that need to be visible across files.  It's called cpphash.h for
  20    historical reasons.  */
  21
  22 #ifndef __GCC_CPPHASH__
  23 #define __GCC_CPPHASH__
  24
  25 struct directive;               /* These are deliberately incomplete.  */
  26 struct htab;
  27
  28 /* Test if a sign is valid within a preprocessing number.  */
  29 #define VALID_SIGN(c, prevc) \
  30   (((c) == '+' || (c) == '-') && \
  31    ((prevc) == 'e' || (prevc) == 'E' \
  32     || (((prevc) == 'p' || (prevc) == 'P') \
  33         && CPP_OPTION (pfile, extended_numbers))))
  34
  35 #define CPP_OPTION(PFILE, OPTION) ((PFILE)->opts.OPTION)
  36 #define CPP_BUFFER(PFILE) ((PFILE)->buffer)
  37 #define CPP_BUF_LINE(BUF) ((BUF)->lineno)
  38 #define CPP_BUF_COLUMN(BUF, CUR) ((CUR) - (BUF)->line_base + (BUF)->col_adjust)
  39 #define CPP_BUF_COL(BUF) CPP_BUF_COLUMN(BUF, (BUF)->cur)
  40
  41 /* Maximum nesting of cpp_buffers.  We use a static limit, partly for
  42    efficiency, and partly to limit runaway recursion.  */
  43 #define CPP_STACK_MAX 200
  44
  45 /* Memory pools.  */
  46 #define POOL_ALIGN(size, align) (((size) + ((align) - 1)) & ~((align) - 1))
  47 #define POOL_FRONT(p) ((p)->cur->front)
  48 #define POOL_LIMIT(p) ((p)->cur->limit)
  49 #define POOL_BASE(p)  ((p)->cur->base)
  50 #define POOL_SIZE(p)  ((p)->cur->limit - (p)->cur->base)
  51 #define POOL_ROOM(p)  ((p)->cur->limit - (p)->cur->front)
  52 #define POOL_USED(p)  ((p)->cur->front - (p)->cur->base)
  53 #define POOL_COMMIT(p, len) do {\
  54   ((p)->cur->front += POOL_ALIGN (len, (p)->align));\
  55   if ((p)->cur->front > (p)->cur->limit) abort ();} while (0)
  56
  57 typedef struct cpp_chunk cpp_chunk;
  58 struct cpp_chunk
  59 {
  60   cpp_chunk *next;
  61   unsigned char *front;
  62   unsigned char *limit;
  63   unsigned char *base;
  64 };
  65
  66 typedef struct cpp_pool cpp_pool;
  67 struct cpp_pool
  68 {
  69   struct cpp_chunk *cur, *locked;
  70   unsigned char *pos;           /* Current position.  */
  71   unsigned int align;
  72   unsigned int locks;
  73 };
  74
  75 /* List of directories to look for include files in. */
  76 struct file_name_list
  77 {
  78   struct file_name_list *next;
  79   struct file_name_list *alloc; /* for the cache of
  80                                    current directory entries */
  81   char *name;
  82   unsigned int nlen;
  83   /* We use these to tell if the directory mentioned here is a duplicate
  84      of an earlier directory on the search path. */
  85   ino_t ino;
  86   dev_t dev;
  87   /* If the following is nonzero, it is a C-language system include
  88      directory.  */
  89   int sysp;
  90   /* Mapping of file names for this directory.
  91      Only used on MS-DOS and related platforms. */
  92   struct file_name_map *name_map;
  93 };
  94
  95 /* Multiple-include optimisation.  */
  96 enum mi_state {MI_FAILED = 0, MI_OUTSIDE};
  97 enum mi_ind {MI_IND_NONE = 0, MI_IND_NOT};
  98
  99 typedef struct toklist toklist;
 100 struct toklist
 101 {
 102   cpp_token *first;
 103   cpp_token *limit;
 104 };
 105
 106 typedef struct cpp_context cpp_context;
 107 struct cpp_context
 108 {
 109   /* Doubly-linked list.  */
 110   cpp_context *next, *prev;
 111
 112   /* Contexts other than the base context are contiguous tokens.
 113      e.g. macro expansions, expanded argument tokens.  */
 114   struct toklist list;
 115
 116   /* For a macro context, these are the macro and its arguments.  */
 117   cpp_macro *macro;
 118 };
 119
 120 struct lexer_state
 121 {
 122   /* Nonzero if first token on line is CPP_HASH.  */
 123   unsigned char in_directive;
 124
 125   /* Nonzero if in a directive that takes angle-bracketed headers.  */
 126   unsigned char angled_headers;
 127
 128   /* Nonzero to save comments.  Turned off if discard_comments, and in
 129      all directives apart from #define.  */
 130   unsigned char save_comments;
 131
 132   /* If nonzero the next token is at the beginning of the line.  */
 133   unsigned char next_bol;
 134
 135   /* Nonzero if we're mid-comment.  */
 136   unsigned char lexing_comment;
 137
 138   /* Nonzero if lexing __VA_ARGS__ is valid.  */
 139   unsigned char va_args_ok;
 140
 141   /* Nonzero if lexing poisoned identifiers is valid.  */
 142   unsigned char poisoned_ok;
 143
 144   /* Nonzero to prevent macro expansion.  */
 145   unsigned char prevent_expansion;
 146
 147   /* Nonzero when parsing arguments to a function-like macro.  */
 148   unsigned char parsing_args;
 149
 150   /* Nonzero when in a # NUMBER directive.  */
 151   unsigned char line_extension;
 152 };
 153
 154 /* Special nodes - identifiers with predefined significance.  */
 155 struct spec_nodes
 156 {
 157   cpp_hashnode *n_L;                    /* L"str" */
 158   cpp_hashnode *n_defined;              /* defined operator */
 159   cpp_hashnode *n__Pragma;              /* _Pragma operator */
 160   cpp_hashnode *n__STRICT_ANSI__;       /* STDC_0_IN_SYSTEM_HEADERS */
 161   cpp_hashnode *n__CHAR_UNSIGNED__;     /* plain char is unsigned */
 162   cpp_hashnode *n__VA_ARGS__;           /* C99 vararg macros */
 163 };
 164
 165 struct cpp_buffer
 166 {
 167   const unsigned char *cur;      /* current position */
 168   const unsigned char *rlimit; /* end of valid data */
 169   const unsigned char *line_base; /* start of current line */
 170   cppchar_t read_ahead;         /* read ahead character */
 171   cppchar_t extra_char;         /* extra read-ahead for long tokens.  */
 172
 173   struct cpp_reader *pfile;     /* Owns this buffer.  */
 174   struct cpp_buffer *prev;
 175
 176   const unsigned char *buf;      /* entire buffer */
 177
 178   /* Filename specified with #line command.  */
 179   const char *nominal_fname;
 180
 181   /* Actual directory of this file, used only for "" includes */
 182   struct file_name_list *actual_dir;
 183
 184   /* Pointer into the include table.  Used for include_next and
 185      to record control macros. */
 186   struct include_file *inc;
 187
 188   /* Value of if_stack at start of this file.
 189      Used to prohibit unmatched #endif (etc) in an include file.  */
 190   struct if_stack *if_stack;
 191
 192   /* Token column position adjustment owing to tabs in whitespace.  */
 193   unsigned int col_adjust;
 194
 195   /* Line number at line_base (above). */
 196   unsigned int lineno;
 197
 198   /* Contains PREV_WHITE and/or AVOID_LPASTE.  */
 199   unsigned char saved_flags;
 200
 201   /* Because of the way the lexer works, -Wtrigraphs can sometimes
 202      warn twice for the same trigraph.  This helps prevent that.  */
 203   const unsigned char *last_Wtrigraphs;
 204
 205   /* True if we have already warned about C++ comments in this file.
 206      The warning happens only for C89 extended mode with -pedantic on,
 207      or for -Wtraditional, and only once per file (otherwise it would
 208      be far too noisy).  */
 209   unsigned char warned_cplusplus_comments;
 210
 211   /* True if we don't process trigraphs and escaped newlines.  True
 212      for preprocessed input, command line directives, and _Pragma
 213      buffers.  */
 214   unsigned char from_stage3;
 215
 216   /* Temporary storage for pfile->skipping whilst in a directive.  */
 217   unsigned char was_skipping;
 218
 219   /* 1 = system header file, 2 = C system header file used for C++.  */
 220   unsigned char sysp;
 221
 222   /* Nonzero means we have printed (while error reporting) a list of
 223      containing files that matches the current status.  */
 224   unsigned char include_stack_listed;
 225
 226   /* Buffer type.  */
 227   ENUM_BITFIELD (cpp_buffer_type) type : 8;
 228 };
 229
 230 /* A cpp_reader encapsulates the "state" of a pre-processor run.
 231    Applying cpp_get_token repeatedly yields a stream of pre-processor
 232    tokens.  Usually, there is only one cpp_reader object active.  */
 233
 234 struct cpp_reader
 235 {
 236   /* Top of buffer stack.  */
 237   cpp_buffer *buffer;
 238
 239   /* Lexer state.  */
 240   struct lexer_state state;
 241
 242   /* The position of the last lexed token and last lexed directive.  */
 243   cpp_lexer_pos lexer_pos;
 244   cpp_lexer_pos directive_pos;
 245
 246   /* Memory pools.  */
 247   cpp_pool ident_pool;          /* For all identifiers, and permanent
 248                                    numbers and strings.  */
 249   cpp_pool macro_pool;          /* For macro definitions.  Permanent.  */
 250   cpp_pool argument_pool;       /* For macro arguments.  Temporary.   */
 251
 252   /* Context stack.  */
 253   struct cpp_context base_context;
 254   struct cpp_context *context;
 255
 256   /* If in_directive, the directive if known.  */
 257   const struct directive *directive;
 258
 259   /* Multiple inlcude optimisation.  */
 260   enum mi_state mi_state;
 261   enum mi_ind mi_if_not_defined;
 262   unsigned int mi_lexed;
 263   const cpp_hashnode *mi_cmacro;
 264   const cpp_hashnode *mi_ind_cmacro;
 265
 266   /* Token lookahead.  */
 267   struct cpp_lookahead *la_read;        /* Read from this lookahead.  */
 268   struct cpp_lookahead *la_write;       /* Write to this lookahead.  */
 269   struct cpp_lookahead *la_unused;      /* Free store.  */
 270   struct cpp_lookahead *la_saved;       /* Backup when entering directive.  */
 271
 272   /* Error counter for exit code.  */
 273   unsigned int errors;
 274
 275   /* Line and column where a newline was first seen in a string
 276      constant (multi-line strings).  */
 277   cpp_lexer_pos mlstring_pos;
 278
 279   /* Buffer to hold macro definition string.  */
 280   unsigned char *macro_buffer;
 281   unsigned int macro_buffer_len;
 282
 283   /* Current depth in #include directives that use <...>.  */
 284   unsigned int system_include_depth;
 285
 286   /* Current depth of buffer stack.  */
 287   unsigned int buffer_stack_depth;
 288
 289   /* Current depth in #include directives.  */
 290   unsigned int include_depth;
 291
 292   /* Hash table of macros and assertions.  See cpphash.c.  */
 293   struct htab *hashtab;
 294
 295   /* Tree of other included files.  See cppfiles.c.  */
 296   struct splay_tree_s *all_include_files;
 297
 298   /* Chain of `actual directory' file_name_list entries, for ""
 299      inclusion.  */
 300   struct file_name_list *actual_dirs;
 301
 302   /* Current maximum length of directory names in the search path
 303      for include files.  (Altered as we get more of them.)  */
 304   unsigned int max_include_len;
 305
 306   /* Date and time tokens.  Calculated together if either is requested.  */
 307   cpp_token date;
 308   cpp_token time;
 309
 310   /* Opaque handle to the dependencies of mkdeps.c.  Used by -M etc.  */
 311   struct deps *deps;
 312
 313   /* Obstack holding all macro hash nodes.  This never shrinks.
 314      See cpphash.c */
 315   struct obstack *hash_ob;
 316
 317   /* Obstack holding buffer and conditional structures.  This is a
 318      real stack.  See cpplib.c */
 319   struct obstack *buffer_ob;
 320
 321   /* Pragma table - dynamic, because a library user can add to the
 322      list of recognized pragmas.  */
 323   struct pragma_entry *pragmas;
 324
 325   /* Call backs.  */
 326   struct cpp_callbacks cb;
 327
 328   /* User visible options.  */
 329   struct cpp_options opts;
 330
 331   /* Special nodes - identifiers with predefined significance to the
 332      preprocessor.  */
 333   struct spec_nodes spec_nodes;
 334
 335   /* We're printed a warning recommending against using #import.  */
 336   unsigned char import_warning;
 337
 338   /* True after cpp_start_read completes.  Used to inhibit some
 339      warnings while parsing the command line.  */
 340   unsigned char done_initializing;
 341
 342   /* True if we are skipping a failed conditional group.  */
 343   unsigned char skipping;
 344 };
 345
 346 /* Character classes.  Based on the more primitive macros in safe-ctype.h.
 347    If the definition of `numchar' looks odd to you, please look up the
 348    definition of a pp-number in the C standard [section 6.4.8 of C99].
 349
 350    In the unlikely event that characters other than \r and \n enter
 351    the set is_vspace, the macro handle_newline() in cpplex.c must be
 352    updated.  */
 353 #define _dollar_ok(x)   ((x) == '$' && CPP_OPTION (pfile, dollars_in_ident))
 354
 355 #define is_idchar(x)    (ISIDNUM(x) || _dollar_ok(x))
 356 #define is_numchar(x)   ISIDNUM(x)
 357 #define is_idstart(x)   (ISIDST(x) || _dollar_ok(x))
 358 #define is_numstart(x)  ISDIGIT(x)
 359 #define is_hspace(x)    ISBLANK(x)
 360 #define is_vspace(x)    IS_VSPACE(x)
 361 #define is_nvspace(x)   IS_NVSPACE(x)
 362 #define is_space(x)     IS_SPACE_OR_NUL(x)
 363
 364 /* This table is constant if it can be initialized at compile time,
 365    which is the case if cpp was compiled with GCC >=2.7, or another
 366    compiler that supports C99.  */
 367 #if HAVE_DESIGNATED_INITIALIZERS
 368 extern const unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
 369 #else
 370 extern unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
 371 #endif
 372
 373 /* Macros.  */
 374
 375 #define CPP_PREV_BUFFER(BUFFER) ((BUFFER)->prev)
 376 #define CPP_PRINT_DEPS(PFILE) CPP_OPTION (PFILE, print_deps)
 377 #define CPP_IN_SYSTEM_HEADER(PFILE) \
 378   (CPP_BUFFER (PFILE) && CPP_BUFFER (PFILE)->sysp)
 379 #define CPP_PEDANTIC(PF) CPP_OPTION (PF, pedantic)
 380 #define CPP_WTRADITIONAL(PF) CPP_OPTION (PF, warn_traditional)
 381
 382 /* Hash step.  The hash calculation is duplicated in cpp_lookup and
 383    parse_name.  */
 384 #define HASHSTEP(r, c) ((r) * 67 + (c - 113));
 385
 386 /* In cpperror.c  */
 387 enum error_type { WARNING = 0, PEDWARN, ERROR, FATAL, ICE };
 388 extern int _cpp_begin_message PARAMS ((cpp_reader *, enum error_type,
 389                                        const char *, const cpp_lexer_pos *));
 390
 391 /* In cppmacro.c */
 392 extern void _cpp_free_definition        PARAMS ((cpp_hashnode *));
 393 extern int _cpp_create_definition       PARAMS ((cpp_reader *, cpp_hashnode *));
 394 extern void _cpp_pop_context            PARAMS ((cpp_reader *));
 395 extern void _cpp_free_lookaheads        PARAMS ((cpp_reader *));
 396 extern void _cpp_release_lookahead      PARAMS ((cpp_reader *));
 397 extern void _cpp_push_token             PARAMS ((cpp_reader *, const cpp_token *,
 398                                                  const cpp_lexer_pos *));
 399
 400 /* In cpphash.c */
 401 extern void _cpp_init_hashtable         PARAMS ((cpp_reader *));
 402 extern void _cpp_cleanup_hashtable      PARAMS ((cpp_reader *));
 403 extern cpp_hashnode *_cpp_lookup_with_hash PARAMS ((cpp_reader*, size_t,
 404                                                     unsigned int));
 405
 406 /* In cppfiles.c */
 407 extern void _cpp_fake_include           PARAMS ((cpp_reader *, const char *));
 408 extern void _cpp_never_reread           PARAMS ((struct include_file *));
 409 extern void _cpp_simplify_pathname      PARAMS ((char *));
 410 extern int _cpp_read_file               PARAMS ((cpp_reader *, const char *));
 411 extern void _cpp_execute_include        PARAMS ((cpp_reader *,
 412                                                  const cpp_token *, int, int));
 413 extern int _cpp_compare_file_date       PARAMS ((cpp_reader *,
 414                                                  const cpp_token *));
 415 extern void _cpp_report_missing_guards  PARAMS ((cpp_reader *));
 416 extern void _cpp_init_includes          PARAMS ((cpp_reader *));
 417 extern void _cpp_cleanup_includes       PARAMS ((cpp_reader *));
 418 extern void _cpp_pop_file_buffer        PARAMS ((cpp_reader *, cpp_buffer *));
 419
 420 /* In cppexp.c */
 421 extern int _cpp_parse_expr              PARAMS ((cpp_reader *));
 422
 423 /* In cpplex.c */
 424 extern void _cpp_lex_token              PARAMS ((cpp_reader *, cpp_token *));
 425 extern int _cpp_equiv_tokens            PARAMS ((const cpp_token *,
 426                                                  const cpp_token *));
 427 extern void _cpp_init_pool              PARAMS ((cpp_pool *, unsigned int,
 428                                                   unsigned int, unsigned int));
 429 extern void _cpp_free_pool              PARAMS ((cpp_pool *));
 430 extern unsigned char *_cpp_pool_reserve PARAMS ((cpp_pool *, unsigned int));
 431 extern unsigned char *_cpp_pool_alloc   PARAMS ((cpp_pool *, unsigned int));
 432 extern unsigned char *_cpp_next_chunk   PARAMS ((cpp_pool *, unsigned int,
 433                                                  unsigned char **));
 434 extern void _cpp_lock_pool              PARAMS ((cpp_pool *));
 435 extern void _cpp_unlock_pool            PARAMS ((cpp_pool *));
 436
 437 /* In cpplib.c */
 438 extern int _cpp_test_assertion PARAMS ((cpp_reader *, int *));
 439 extern int _cpp_handle_directive PARAMS ((cpp_reader *, int));
 440 extern void _cpp_define_builtin PARAMS ((cpp_reader *, const char *));
 441 extern void _cpp_do__Pragma     PARAMS ((cpp_reader *));
 442 extern void _cpp_init_stacks    PARAMS ((cpp_reader *));
 443 extern void _cpp_cleanup_stacks PARAMS ((cpp_reader *));
 444 extern void _cpp_init_internal_pragmas PARAMS ((cpp_reader *));
 445 extern void _cpp_do_file_change PARAMS ((cpp_reader *, enum cpp_fc_reason,
 446                                          const char *, unsigned int));
 447
 448 /* Utility routines and macros.  */
 449 #define DSC(str) (const U_CHAR *)str, sizeof str - 1
 450 #define xnew(T)         (T *) xmalloc (sizeof(T))
 451 #define xcnew(T)        (T *) xcalloc (1, sizeof(T))
 452 #define xnewvec(T, N)   (T *) xmalloc (sizeof(T) * (N))
 453 #define xcnewvec(T, N)  (T *) xcalloc (N, sizeof(T))
 454 #define xobnew(O, T)    (T *) obstack_alloc (O, sizeof(T))
 455
 456 /* These are inline functions instead of macros so we can get type
 457    checking.  */
 458 typedef unsigned char U_CHAR;
 459 #define U (const U_CHAR *)  /* Intended use: U"string" */
 460
 461 static inline int ustrcmp       PARAMS ((const U_CHAR *, const U_CHAR *));
 462 static inline int ustrncmp      PARAMS ((const U_CHAR *, const U_CHAR *,
 463                                          size_t));
 464 static inline size_t ustrlen    PARAMS ((const U_CHAR *));
 465 static inline U_CHAR *uxstrdup  PARAMS ((const U_CHAR *));
 466 static inline U_CHAR *ustrchr   PARAMS ((const U_CHAR *, int));
 467 static inline int ufputs        PARAMS ((const U_CHAR *, FILE *));
 468
 469 static inline int
 470 ustrcmp (s1, s2)
 471      const U_CHAR *s1, *s2;
 472 {
 473   return strcmp ((const char *)s1, (const char *)s2);
 474 }
 475
 476 static inline int
 477 ustrncmp (s1, s2, n)
 478      const U_CHAR *s1, *s2;
 479      size_t n;
 480 {
 481   return strncmp ((const char *)s1, (const char *)s2, n);
 482 }
 483
 484 static inline size_t
 485 ustrlen (s1)
 486      const U_CHAR *s1;
 487 {
 488   return strlen ((const char *)s1);
 489 }
 490
 491 static inline U_CHAR *
 492 uxstrdup (s1)
 493      const U_CHAR *s1;
 494 {
 495   return (U_CHAR *) xstrdup ((const char *)s1);
 496 }
 497
 498 static inline U_CHAR *
 499 ustrchr (s1, c)
 500      const U_CHAR *s1;
 501      int c;
 502 {
 503   return (U_CHAR *) strchr ((const char *)s1, c);
 504 }
 505
 506 static inline int
 507 ufputs (s, f)
 508      const U_CHAR *s;
 509      FILE *f;
 510 {
 511   return fputs ((const char *)s, f);
 512 }
 513
 514 #endif