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