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