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