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_H
  23 #define GCC_CPPHASH_H
  24
  25 #include "hashtable.h"
  26
  27 struct directive;               /* Deliberately incomplete.  */
  28
  29 /* Test if a sign is valid within a preprocessing number.  */
  30 #define VALID_SIGN(c, prevc) \
  31   (((c) == '+' || (c) == '-') && \
  32    ((prevc) == 'e' || (prevc) == 'E' \
  33     || (((prevc) == 'p' || (prevc) == 'P') \
  34         && CPP_OPTION (pfile, extended_numbers))))
  35
  36 #define CPP_OPTION(PFILE, OPTION) ((PFILE)->opts.OPTION)
  37 #define CPP_BUFFER(PFILE) ((PFILE)->buffer)
  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, *first;
  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 search_path
  77 {
  78   struct search_path *next;
  79
  80   /* NOTE: NAME may not be null terminated for the case of the current
  81      file's directory!  */
  82   const char *name;
  83   unsigned int len;
  84   /* We use these to tell if the directory mentioned here is a duplicate
  85      of an earlier directory on the search path.  */
  86   ino_t ino;
  87   dev_t dev;
  88   /* Non-zero if it is a system include directory.  */
  89   int sysp;
  90   /* Mapping of file names for this directory.  Only used on MS-DOS
  91      and related platforms.  */
  92   struct file_name_map *name_map;
  93 };
  94
  95 /* #include types.  */
  96 enum include_type {IT_INCLUDE, IT_INCLUDE_NEXT, IT_IMPORT, IT_CMDLINE};
  97
  98 typedef struct toklist toklist;
  99 struct toklist
 100 {
 101   cpp_token *first;
 102   cpp_token *limit;
 103 };
 104
 105 typedef struct cpp_context cpp_context;
 106 struct cpp_context
 107 {
 108   /* Doubly-linked list.  */
 109   cpp_context *next, *prev;
 110
 111   /* Contexts other than the base context are contiguous tokens.
 112      e.g. macro expansions, expanded argument tokens.  */
 113   struct toklist list;
 114
 115   /* For a macro context, these are the macro and its arguments.  */
 116   cpp_macro *macro;
 117 };
 118
 119 struct lexer_state
 120 {
 121   /* Nonzero if first token on line is CPP_HASH.  */
 122   unsigned char in_directive;
 123
 124   /* True if we are skipping a failed conditional group.  */
 125   unsigned char skipping;
 126
 127   /* Nonzero if in a directive that takes angle-bracketed headers.  */
 128   unsigned char angled_headers;
 129
 130   /* Nonzero to save comments.  Turned off if discard_comments, and in
 131      all directives apart from #define.  */
 132   unsigned char save_comments;
 133
 134   /* Nonzero if we're mid-comment.  */
 135   unsigned char lexing_comment;
 136
 137   /* Nonzero if lexing __VA_ARGS__ is valid.  */
 138   unsigned char va_args_ok;
 139
 140   /* Nonzero if lexing poisoned identifiers is valid.  */
 141   unsigned char poisoned_ok;
 142
 143   /* Nonzero to prevent macro expansion.  */
 144   unsigned char prevent_expansion;
 145
 146   /* Nonzero when parsing arguments to a function-like macro.  */
 147   unsigned char parsing_args;
 148
 149   /* Nonzero when in a # NUMBER directive.  */
 150   unsigned char line_extension;
 151 };
 152
 153 /* Special nodes - identifiers with predefined significance.  */
 154 struct spec_nodes
 155 {
 156   cpp_hashnode *n_L;                    /* L"str" */
 157   cpp_hashnode *n_defined;              /* defined operator */
 158   cpp_hashnode *n_true;                 /* C++ keyword true */
 159   cpp_hashnode *n_false;                /* C++ keyword false */
 160   cpp_hashnode *n__Pragma;              /* _Pragma operator */
 161   cpp_hashnode *n__STRICT_ANSI__;       /* STDC_0_IN_SYSTEM_HEADERS */
 162   cpp_hashnode *n__CHAR_UNSIGNED__;     /* plain char is unsigned */
 163   cpp_hashnode *n__VA_ARGS__;           /* C99 vararg macros */
 164 };
 165
 166 struct cpp_buffer
 167 {
 168   const unsigned char *cur;      /* current position */
 169   const unsigned char *rlimit; /* end of valid data */
 170   const unsigned char *line_base; /* start of current line */
 171   cppchar_t read_ahead;         /* read ahead character */
 172   cppchar_t extra_char;         /* extra read-ahead for long tokens.  */
 173
 174   struct cpp_reader *pfile;     /* Owns this buffer.  */
 175   struct cpp_buffer *prev;
 176
 177   const unsigned char *buf;      /* entire buffer */
 178
 179   /* Pointer into the include table.  Used for include_next and
 180      to record control macros. */
 181   struct include_file *inc;
 182
 183   /* Value of if_stack at start of this file.
 184      Used to prohibit unmatched #endif (etc) in an include file.  */
 185   struct if_stack *if_stack;
 186
 187   /* Token column position adjustment owing to tabs in whitespace.  */
 188   unsigned int col_adjust;
 189
 190   /* Contains PREV_WHITE and/or AVOID_LPASTE.  */
 191   unsigned char saved_flags;
 192
 193   /* Because of the way the lexer works, -Wtrigraphs can sometimes
 194      warn twice for the same trigraph.  This helps prevent that.  */
 195   const unsigned char *last_Wtrigraphs;
 196
 197   /* True if we have already warned about C++ comments in this file.
 198      The warning happens only for C89 extended mode with -pedantic on,
 199      or for -Wtraditional, and only once per file (otherwise it would
 200      be far too noisy).  */
 201   unsigned char warned_cplusplus_comments;
 202
 203   /* True if we don't process trigraphs and escaped newlines.  True
 204      for preprocessed input, command line directives, and _Pragma
 205      buffers.  */
 206   unsigned char from_stage3;
 207
 208   /* Nonzero means that the directory to start searching for ""
 209      include files has been calculated and stored in "dir" below.  */
 210   unsigned char search_cached;
 211
 212   /* At EOF, a buffer is automatically popped.  If RETURN_AT_EOF is
 213      true, a CPP_EOF token is then returned.  Otherwise, the next
 214      token from the enclosing buffer is returned.  */
 215   bool return_at_eof;
 216
 217   /* Buffer type.  */
 218   ENUM_BITFIELD (cpp_buffer_type) type : 8;
 219
 220   /* The directory of the this buffer's file.  Its NAME member is not
 221      allocated, so we don't need to worry about freeing it.  */
 222   struct search_path dir;
 223 };
 224
 225 /* A cpp_reader encapsulates the "state" of a pre-processor run.
 226    Applying cpp_get_token repeatedly yields a stream of pre-processor
 227    tokens.  Usually, there is only one cpp_reader object active.  */
 228
 229 struct cpp_reader
 230 {
 231   /* Top of buffer stack.  */
 232   cpp_buffer *buffer;
 233
 234   /* Lexer state.  */
 235   struct lexer_state state;
 236
 237   /* Source line tracking.  */
 238   struct line_maps line_maps;
 239   const struct line_map *map;
 240   unsigned int line;
 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   unsigned int directive_line;
 246
 247   /* Memory pools.  */
 248   cpp_pool ident_pool;          /* For all identifiers, and permanent
 249                                    numbers and strings.  */
 250   cpp_pool macro_pool;          /* For macro definitions.  Permanent.  */
 251   cpp_pool argument_pool;       /* For macro arguments.  Temporary.   */
 252
 253   /* Context stack.  */
 254   struct cpp_context base_context;
 255   struct cpp_context *context;
 256
 257   /* If in_directive, the directive if known.  */
 258   const struct directive *directive;
 259
 260   /* Multiple inlcude optimisation.  */
 261   const cpp_hashnode *mi_cmacro;
 262   const cpp_hashnode *mi_ind_cmacro;
 263   bool mi_valid;
 264
 265   /* Token lookahead.  */
 266   struct cpp_lookahead *la_read;        /* Read from this lookahead.  */
 267   struct cpp_lookahead *la_write;       /* Write to this lookahead.  */
 268   struct cpp_lookahead *la_unused;      /* Free store.  */
 269   struct cpp_lookahead *la_saved;       /* Backup when entering directive.  */
 270
 271   /* Error counter for exit code.  */
 272   unsigned int errors;
 273
 274   /* Line and column where a newline was first seen in a string
 275      constant (multi-line strings).  */
 276   cpp_lexer_pos mlstring_pos;
 277
 278   /* Buffer to hold macro definition string.  */
 279   unsigned char *macro_buffer;
 280   unsigned int macro_buffer_len;
 281
 282   /* Current depth in #include directives that use <...>.  */
 283   unsigned int system_include_depth;
 284
 285   /* Current depth of buffer stack.  */
 286   unsigned int buffer_stack_depth;
 287
 288   /* Current depth in #include directives.  */
 289   unsigned int include_depth;
 290
 291   /* Tree of other included files.  See cppfiles.c.  */
 292   struct splay_tree_s *all_include_files;
 293
 294   /* Current maximum length of directory names in the search path
 295      for include files.  (Altered as we get more of them.)  */
 296   unsigned int max_include_len;
 297
 298   /* Date and time tokens.  Calculated together if either is requested.  */
 299   cpp_token date;
 300   cpp_token time;
 301
 302   /* Opaque handle to the dependencies of mkdeps.c.  Used by -M etc.  */
 303   struct deps *deps;
 304
 305   /* Obstack holding all macro hash nodes.  This never shrinks.
 306      See cpphash.c */
 307   struct obstack hash_ob;
 308
 309   /* Obstack holding buffer and conditional structures.  This is a
 310      real stack.  See cpplib.c.  */
 311   struct obstack buffer_ob;
 312
 313   /* Pragma table - dynamic, because a library user can add to the
 314      list of recognized pragmas.  */
 315   struct pragma_entry *pragmas;
 316
 317   /* Call backs.  */
 318   struct cpp_callbacks cb;
 319
 320   /* Identifier hash table.  */
 321   struct ht *hash_table;
 322
 323   /* User visible options.  */
 324   struct cpp_options opts;
 325
 326   /* Special nodes - identifiers with predefined significance to the
 327      preprocessor.  */
 328   struct spec_nodes spec_nodes;
 329
 330   /* Whether to print our version number.  Done this way so
 331      we don't get it twice for -v -version.  */
 332   unsigned char print_version;
 333
 334   /* Whether cpplib owns the hashtable.  */
 335   unsigned char our_hashtable;
 336 };
 337
 338 /* Character classes.  Based on the more primitive macros in safe-ctype.h.
 339    If the definition of `numchar' looks odd to you, please look up the
 340    definition of a pp-number in the C standard [section 6.4.8 of C99].
 341
 342    In the unlikely event that characters other than \r and \n enter
 343    the set is_vspace, the macro handle_newline() in cpplex.c must be
 344    updated.  */
 345 #define _dollar_ok(x)   ((x) == '$' && CPP_OPTION (pfile, dollars_in_ident))
 346
 347 #define is_idchar(x)    (ISIDNUM(x) || _dollar_ok(x))
 348 #define is_numchar(x)   ISIDNUM(x)
 349 #define is_idstart(x)   (ISIDST(x) || _dollar_ok(x))
 350 #define is_numstart(x)  ISDIGIT(x)
 351 #define is_hspace(x)    ISBLANK(x)
 352 #define is_vspace(x)    IS_VSPACE(x)
 353 #define is_nvspace(x)   IS_NVSPACE(x)
 354 #define is_space(x)     IS_SPACE_OR_NUL(x)
 355
 356 /* This table is constant if it can be initialized at compile time,
 357    which is the case if cpp was compiled with GCC >=2.7, or another
 358    compiler that supports C99.  */
 359 #if HAVE_DESIGNATED_INITIALIZERS
 360 extern const unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
 361 #else
 362 extern unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
 363 #endif
 364
 365 /* Macros.  */
 366
 367 #define CPP_PRINT_DEPS(PFILE) CPP_OPTION (PFILE, print_deps)
 368 #define CPP_IN_SYSTEM_HEADER(PFILE) ((PFILE)->map && (PFILE)->map->sysp)
 369 #define CPP_PEDANTIC(PF) CPP_OPTION (PF, pedantic)
 370 #define CPP_WTRADITIONAL(PF) CPP_OPTION (PF, warn_traditional)
 371
 372 /* In cpperror.c  */
 373 enum error_type { WARNING = 0, WARNING_SYSHDR, PEDWARN, ERROR, FATAL, ICE };
 374 extern int _cpp_begin_message PARAMS ((cpp_reader *, enum error_type,
 375                                        const cpp_lexer_pos *));
 376
 377 /* In cppmacro.c */
 378 extern void _cpp_free_definition        PARAMS ((cpp_hashnode *));
 379 extern int _cpp_create_definition       PARAMS ((cpp_reader *, cpp_hashnode *));
 380 extern void _cpp_pop_context            PARAMS ((cpp_reader *));
 381 extern void _cpp_free_lookaheads        PARAMS ((cpp_reader *));
 382 extern void _cpp_release_lookahead      PARAMS ((cpp_reader *));
 383 extern void _cpp_push_token             PARAMS ((cpp_reader *, const cpp_token *,
 384                                                  const cpp_lexer_pos *));
 385
 386 /* In cpphash.c */
 387 extern void _cpp_init_hashtable         PARAMS ((cpp_reader *, hash_table *));
 388 extern void _cpp_destroy_hashtable      PARAMS ((cpp_reader *));
 389
 390 /* In cppfiles.c */
 391 extern void _cpp_fake_include           PARAMS ((cpp_reader *, const char *));
 392 extern void _cpp_never_reread           PARAMS ((struct include_file *));
 393 extern char *_cpp_simplify_pathname     PARAMS ((char *));
 394 extern bool _cpp_read_file              PARAMS ((cpp_reader *, const char *));
 395 extern bool _cpp_execute_include        PARAMS ((cpp_reader *,
 396                                                  const cpp_token *,
 397                                                  enum include_type));
 398 extern int _cpp_compare_file_date       PARAMS ((cpp_reader *,
 399                                                  const cpp_token *));
 400 extern void _cpp_report_missing_guards  PARAMS ((cpp_reader *));
 401 extern void _cpp_init_includes          PARAMS ((cpp_reader *));
 402 extern void _cpp_cleanup_includes       PARAMS ((cpp_reader *));
 403 extern void _cpp_pop_file_buffer        PARAMS ((cpp_reader *, cpp_buffer *));
 404
 405 /* In cppexp.c */
 406 extern int _cpp_parse_expr              PARAMS ((cpp_reader *));
 407
 408 /* In cpplex.c */
 409 extern void _cpp_lex_token              PARAMS ((cpp_reader *, cpp_token *));
 410 extern int _cpp_equiv_tokens            PARAMS ((const cpp_token *,
 411                                                  const cpp_token *));
 412 extern void _cpp_init_pool              PARAMS ((cpp_pool *, unsigned int,
 413                                                   unsigned int, unsigned int));
 414 extern void _cpp_free_pool              PARAMS ((cpp_pool *));
 415 extern unsigned char *_cpp_pool_reserve PARAMS ((cpp_pool *, unsigned int));
 416 extern unsigned char *_cpp_pool_alloc   PARAMS ((cpp_pool *, unsigned int));
 417 extern unsigned char *_cpp_next_chunk   PARAMS ((cpp_pool *, unsigned int,
 418                                                  unsigned char **));
 419 extern void _cpp_lock_pool              PARAMS ((cpp_pool *));
 420 extern void _cpp_unlock_pool            PARAMS ((cpp_pool *));
 421
 422 /* In cppinit.c.  */
 423 extern bool _cpp_push_next_buffer       PARAMS ((cpp_reader *));
 424
 425 /* In cpplib.c */
 426 extern int _cpp_test_assertion PARAMS ((cpp_reader *, int *));
 427 extern int _cpp_handle_directive PARAMS ((cpp_reader *, int));
 428 extern void _cpp_define_builtin PARAMS ((cpp_reader *, const char *));
 429 extern void _cpp_do__Pragma     PARAMS ((cpp_reader *));
 430 extern void _cpp_init_directives PARAMS ((cpp_reader *));
 431 extern void _cpp_init_internal_pragmas PARAMS ((cpp_reader *));
 432 extern void _cpp_do_file_change PARAMS ((cpp_reader *, enum lc_reason,
 433                                          const char *,
 434                                          unsigned int, unsigned int));
 435 extern void _cpp_pop_buffer PARAMS ((cpp_reader *));
 436
 437 /* Utility routines and macros.  */
 438 #define DSC(str) (const U_CHAR *)str, sizeof str - 1
 439 #define xnew(T)         (T *) xmalloc (sizeof(T))
 440 #define xcnew(T)        (T *) xcalloc (1, sizeof(T))
 441 #define xnewvec(T, N)   (T *) xmalloc (sizeof(T) * (N))
 442 #define xcnewvec(T, N)  (T *) xcalloc (N, sizeof(T))
 443 #define xobnew(O, T)    (T *) obstack_alloc (O, sizeof(T))
 444
 445 /* These are inline functions instead of macros so we can get type
 446    checking.  */
 447 typedef unsigned char U_CHAR;
 448 #define U (const U_CHAR *)  /* Intended use: U"string" */
 449
 450 static inline int ustrcmp       PARAMS ((const U_CHAR *, const U_CHAR *));
 451 static inline int ustrncmp      PARAMS ((const U_CHAR *, const U_CHAR *,
 452                                          size_t));
 453 static inline size_t ustrlen    PARAMS ((const U_CHAR *));
 454 static inline U_CHAR *uxstrdup  PARAMS ((const U_CHAR *));
 455 static inline U_CHAR *ustrchr   PARAMS ((const U_CHAR *, int));
 456 static inline int ufputs        PARAMS ((const U_CHAR *, FILE *));
 457
 458 static inline int
 459 ustrcmp (s1, s2)
 460      const U_CHAR *s1, *s2;
 461 {
 462   return strcmp ((const char *)s1, (const char *)s2);
 463 }
 464
 465 static inline int
 466 ustrncmp (s1, s2, n)
 467      const U_CHAR *s1, *s2;
 468      size_t n;
 469 {
 470   return strncmp ((const char *)s1, (const char *)s2, n);
 471 }
 472
 473 static inline size_t
 474 ustrlen (s1)
 475      const U_CHAR *s1;
 476 {
 477   return strlen ((const char *)s1);
 478 }
 479
 480 static inline U_CHAR *
 481 uxstrdup (s1)
 482      const U_CHAR *s1;
 483 {
 484   return (U_CHAR *) xstrdup ((const char *)s1);
 485 }
 486
 487 static inline U_CHAR *
 488 ustrchr (s1, c)
 489      const U_CHAR *s1;
 490      int c;
 491 {
 492   return (U_CHAR *) strchr ((const char *)s1, c);
 493 }
 494
 495 static inline int
 496 ufputs (s, f)
 497      const U_CHAR *s;
 498      FILE *f;
 499 {
 500   return fputs ((const char *)s, f);
 501 }
 502
 503 #endif /* ! GCC_CPPHASH_H */