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