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