gcc/cpphash.h

   1 /* Part of CPP library.
   2    Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002
   3    Free Software Foundation, Inc.
   4
   5 This program is free software; you can redistribute it and/or modify it
   6 under the terms of the GNU General Public License as published by the
   7 Free Software Foundation; either version 2, or (at your option) any
   8 later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this program; if not, write to the Free Software
  17 Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */
  18
  19 /* This header defines all the internal data structures and functions
  20    that need to be visible across files.  It's called cpphash.h for
  21    historical reasons.  */
  22
  23 #ifndef GCC_CPPHASH_H
  24 #define GCC_CPPHASH_H
  25
  26 #include "hashtable.h"
  27
  28 struct directive;               /* Deliberately incomplete.  */
  29
  30 /* Test if a sign is valid within a preprocessing number.  */
  31 #define VALID_SIGN(c, prevc) \
  32   (((c) == '+' || (c) == '-') && \
  33    ((prevc) == 'e' || (prevc) == 'E' \
  34     || (((prevc) == 'p' || (prevc) == 'P') \
  35         && CPP_OPTION (pfile, extended_numbers))))
  36
  37 #define CPP_OPTION(PFILE, OPTION) ((PFILE)->opts.OPTION)
  38 #define CPP_BUFFER(PFILE) ((PFILE)->buffer)
  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 /* A generic memory buffer, and operations on it.  */
  47 typedef struct _cpp_buff _cpp_buff;
  48 struct _cpp_buff
  49 {
  50   struct _cpp_buff *next;
  51   unsigned char *base, *cur, *limit;
  52 };
  53
  54 extern _cpp_buff *_cpp_get_buff PARAMS ((cpp_reader *, size_t));
  55 extern void _cpp_release_buff PARAMS ((cpp_reader *, _cpp_buff *));
  56 extern void _cpp_extend_buff PARAMS ((cpp_reader *, _cpp_buff **, size_t));
  57 extern _cpp_buff *_cpp_append_extend_buff PARAMS ((cpp_reader *, _cpp_buff *,
  58                                                    size_t));
  59 extern void _cpp_free_buff PARAMS ((_cpp_buff *));
  60 extern unsigned char *_cpp_aligned_alloc PARAMS ((cpp_reader *, size_t));
  61 extern unsigned char *_cpp_unaligned_alloc PARAMS ((cpp_reader *, size_t));
  62
  63 #define BUFF_ROOM(BUFF) (size_t) ((BUFF)->limit - (BUFF)->cur)
  64 #define BUFF_FRONT(BUFF) ((BUFF)->cur)
  65 #define BUFF_LIMIT(BUFF) ((BUFF)->limit)
  66
  67 /* List of directories to look for include files in.  */
  68 struct search_path
  69 {
  70   struct search_path *next;
  71
  72   /* NOTE: NAME may not be null terminated for the case of the current
  73      file's directory!  */
  74   const char *name;
  75   unsigned int len;
  76   /* We use these to tell if the directory mentioned here is a duplicate
  77      of an earlier directory on the search path.  */
  78   ino_t ino;
  79   dev_t dev;
  80   /* Non-zero if it is a system include directory.  */
  81   int sysp;
  82   /* Mapping of file names for this directory.  Only used on MS-DOS
  83      and related platforms.  */
  84   struct file_name_map *name_map;
  85 };
  86
  87 /* #include types.  */
  88 enum include_type {IT_INCLUDE, IT_INCLUDE_NEXT, IT_IMPORT, IT_CMDLINE};
  89
  90 union utoken
  91 {
  92   const cpp_token *token;
  93   const cpp_token **ptoken;
  94 };
  95
  96 /* A "run" of tokens; part of a chain of runs.  */
  97 typedef struct tokenrun tokenrun;
  98 struct tokenrun
  99 {
 100   tokenrun *next, *prev;
 101   cpp_token *base, *limit;
 102 };
 103
 104 typedef struct cpp_context cpp_context;
 105 struct cpp_context
 106 {
 107   /* Doubly-linked list.  */
 108   cpp_context *next, *prev;
 109
 110   /* Contexts other than the base context are contiguous tokens.
 111      e.g. macro expansions, expanded argument tokens.  */
 112   union utoken first;
 113   union utoken last;
 114
 115   /* If non-NULL, a buffer used for storage related to this context.
 116      When the context is popped, the buffer is released.  */
 117   _cpp_buff *buff;
 118
 119   /* For a macro context, the macro node, otherwise NULL.  */
 120   cpp_hashnode *macro;
 121
 122   /* True if utoken element is token, else ptoken.  */
 123   bool direct_p;
 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
 157 /* Special nodes - identifiers with predefined significance.  */
 158 struct spec_nodes
 159 {
 160   cpp_hashnode *n_defined;              /* defined operator */
 161   cpp_hashnode *n_true;                 /* C++ keyword true */
 162   cpp_hashnode *n_false;                /* C++ keyword false */
 163   cpp_hashnode *n__STRICT_ANSI__;       /* STDC_0_IN_SYSTEM_HEADERS */
 164   cpp_hashnode *n__VA_ARGS__;           /* C99 vararg macros */
 165 };
 166
 167 /* Represents the contents of a file cpplib has read in.  */
 168 struct cpp_buffer
 169 {
 170   const unsigned char *cur;      /* current position */
 171   const unsigned char *backup_to; /* if peeked character is not wanted */
 172   const unsigned char *rlimit; /* end of valid data */
 173   const unsigned char *line_base; /* start of current line */
 174
 175   struct cpp_buffer *prev;
 176
 177   const unsigned char *buf;      /* Entire character buffer.  */
 178
 179   /* Pointer into the include table; non-NULL if this is a file
 180      buffer.  Used for include_next and to record control macros.  */
 181   struct include_file *inc;
 182
 183   /* Value of if_stack at start of this file.
 184      Used to prohibit unmatched #endif (etc) in an include file.  */
 185   struct if_stack *if_stack;
 186
 187   /* Token column position adjustment owing to tabs in whitespace.  */
 188   unsigned int col_adjust;
 189
 190   /* Contains PREV_WHITE and/or AVOID_LPASTE.  */
 191   unsigned char saved_flags;
 192
 193   /* Because of the way the lexer works, -Wtrigraphs can sometimes
 194      warn twice for the same trigraph.  This helps prevent that.  */
 195   const unsigned char *last_Wtrigraphs;
 196
 197   /* True if we have already warned about C++ comments in this file.
 198      The warning happens only for C89 extended mode with -pedantic on,
 199      or for -Wtraditional, and only once per file (otherwise it would
 200      be far too noisy).  */
 201   unsigned char warned_cplusplus_comments;
 202
 203   /* True if we don't process trigraphs and escaped newlines.  True
 204      for preprocessed input, command line directives, and _Pragma
 205      buffers.  */
 206   unsigned char from_stage3;
 207
 208   /* Nonzero means that the directory to start searching for ""
 209      include files has been calculated and stored in "dir" below.  */
 210   unsigned char search_cached;
 211
 212   /* At EOF, a buffer is automatically popped.  If RETURN_AT_EOF is
 213      true, a CPP_EOF token is then returned.  Otherwise, the next
 214      token from the enclosing buffer is returned.  */
 215   bool return_at_eof;
 216
 217   /* The directory of the this buffer's file.  Its NAME member is not
 218      allocated, so we don't need to worry about freeing it.  */
 219   struct search_path dir;
 220 };
 221
 222 /* A cpp_reader encapsulates the "state" of a pre-processor run.
 223    Applying cpp_get_token repeatedly yields a stream of pre-processor
 224    tokens.  Usually, there is only one cpp_reader object active.  */
 225 struct cpp_reader
 226 {
 227   /* Top of buffer stack.  */
 228   cpp_buffer *buffer;
 229
 230   /* Lexer state.  */
 231   struct lexer_state state;
 232
 233   /* Source line tracking.  */
 234   struct line_maps line_maps;
 235   const struct line_map *map;
 236   unsigned int line;
 237
 238   /* The line of the '#' of the current directive.  */
 239   unsigned int directive_line;
 240
 241   /* Memory buffers.  */
 242   _cpp_buff *a_buff;            /* Aligned permanent storage.  */
 243   _cpp_buff *u_buff;            /* Unaligned permanent storage.  */
 244   _cpp_buff *free_buffs;        /* Free buffer chain.  */
 245
 246   /* Context stack.  */
 247   struct cpp_context base_context;
 248   struct cpp_context *context;
 249
 250   /* If in_directive, the directive if known.  */
 251   const struct directive *directive;
 252
 253   /* Multiple inlcude optimisation.  */
 254   const cpp_hashnode *mi_cmacro;
 255   const cpp_hashnode *mi_ind_cmacro;
 256   bool mi_valid;
 257
 258   /* Lexing.  */
 259   cpp_token *cur_token;
 260   tokenrun base_run, *cur_run;
 261   unsigned int lookaheads;
 262
 263   /* Non-zero prevents the lexer from re-using the token runs.  */
 264   unsigned int keep_tokens;
 265
 266   /* Error counter for exit code.  */
 267   unsigned int errors;
 268
 269   /* Buffer to hold macro definition string.  */
 270   unsigned char *macro_buffer;
 271   unsigned int macro_buffer_len;
 272
 273   /* Tree of other included files.  See cppfiles.c.  */
 274   struct splay_tree_s *all_include_files;
 275
 276   /* Current maximum length of directory names in the search path
 277      for include files.  (Altered as we get more of them.)  */
 278   unsigned int max_include_len;
 279
 280   /* Date and time tokens.  Calculated together if either is requested.  */
 281   cpp_token date;
 282   cpp_token time;
 283
 284   /* EOF token, and a token forcing paste avoidance.  */
 285   cpp_token avoid_paste;
 286   cpp_token eof;
 287
 288   /* Opaque handle to the dependencies of mkdeps.c.  Used by -M etc.  */
 289   struct deps *deps;
 290
 291   /* Obstack holding all macro hash nodes.  This never shrinks.
 292      See cpphash.c */
 293   struct obstack hash_ob;
 294
 295   /* Obstack holding buffer and conditional structures.  This is a
 296      real stack.  See cpplib.c.  */
 297   struct obstack buffer_ob;
 298
 299   /* Pragma table - dynamic, because a library user can add to the
 300      list of recognized pragmas.  */
 301   struct pragma_entry *pragmas;
 302
 303   /* Call backs.  */
 304   struct cpp_callbacks cb;
 305
 306   /* Identifier hash table.  */
 307   struct ht *hash_table;
 308
 309   /* User visible options.  */
 310   struct cpp_options opts;
 311
 312   /* Special nodes - identifiers with predefined significance to the
 313      preprocessor.  */
 314   struct spec_nodes spec_nodes;
 315
 316   /* Whether to print our version number.  Done this way so
 317      we don't get it twice for -v -version.  */
 318   unsigned char print_version;
 319
 320   /* Whether cpplib owns the hashtable.  */
 321   unsigned char our_hashtable;
 322 };
 323
 324 /* Character classes.  Based on the more primitive macros in safe-ctype.h.
 325    If the definition of `numchar' looks odd to you, please look up the
 326    definition of a pp-number in the C standard [section 6.4.8 of C99].
 327
 328    In the unlikely event that characters other than \r and \n enter
 329    the set is_vspace, the macro handle_newline() in cpplex.c must be
 330    updated.  */
 331 #define _dollar_ok(x)   ((x) == '$' && CPP_OPTION (pfile, dollars_in_ident))
 332
 333 #define is_idchar(x)    (ISIDNUM(x) || _dollar_ok(x))
 334 #define is_numchar(x)   ISIDNUM(x)
 335 #define is_idstart(x)   (ISIDST(x) || _dollar_ok(x))
 336 #define is_numstart(x)  ISDIGIT(x)
 337 #define is_hspace(x)    ISBLANK(x)
 338 #define is_vspace(x)    IS_VSPACE(x)
 339 #define is_nvspace(x)   IS_NVSPACE(x)
 340 #define is_space(x)     IS_SPACE_OR_NUL(x)
 341
 342 /* This table is constant if it can be initialized at compile time,
 343    which is the case if cpp was compiled with GCC >=2.7, or another
 344    compiler that supports C99.  */
 345 #if HAVE_DESIGNATED_INITIALIZERS
 346 extern const unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
 347 #else
 348 extern unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
 349 #endif
 350
 351 /* Macros.  */
 352
 353 #define CPP_PRINT_DEPS(PFILE) CPP_OPTION (PFILE, print_deps)
 354 #define CPP_IN_SYSTEM_HEADER(PFILE) ((PFILE)->map && (PFILE)->map->sysp)
 355 #define CPP_PEDANTIC(PF) CPP_OPTION (PF, pedantic)
 356 #define CPP_WTRADITIONAL(PF) CPP_OPTION (PF, warn_traditional)
 357
 358 /* In cpperror.c  */
 359 enum error_type { WARNING = 0, WARNING_SYSHDR, PEDWARN, ERROR, FATAL, ICE };
 360 extern int _cpp_begin_message PARAMS ((cpp_reader *, enum error_type,
 361                                        unsigned int, unsigned int));
 362
 363 /* In cppmacro.c */
 364 extern void _cpp_free_definition        PARAMS ((cpp_hashnode *));
 365 extern int _cpp_create_definition       PARAMS ((cpp_reader *, cpp_hashnode *));
 366 extern void _cpp_pop_context            PARAMS ((cpp_reader *));
 367
 368 /* In cpphash.c */
 369 extern void _cpp_init_hashtable         PARAMS ((cpp_reader *, hash_table *));
 370 extern void _cpp_destroy_hashtable      PARAMS ((cpp_reader *));
 371
 372 /* In cppfiles.c */
 373 extern void _cpp_fake_include           PARAMS ((cpp_reader *, const char *));
 374 extern void _cpp_never_reread           PARAMS ((struct include_file *));
 375 extern char *_cpp_simplify_pathname     PARAMS ((char *));
 376 extern bool _cpp_read_file              PARAMS ((cpp_reader *, const char *));
 377 extern bool _cpp_execute_include        PARAMS ((cpp_reader *,
 378                                                  const cpp_token *,
 379                                                  enum include_type));
 380 extern int _cpp_compare_file_date       PARAMS ((cpp_reader *,
 381                                                  const cpp_token *));
 382 extern void _cpp_report_missing_guards  PARAMS ((cpp_reader *));
 383 extern void _cpp_init_includes          PARAMS ((cpp_reader *));
 384 extern void _cpp_cleanup_includes       PARAMS ((cpp_reader *));
 385 extern bool _cpp_pop_file_buffer        PARAMS ((cpp_reader *,
 386                                                  struct include_file *));
 387
 388 /* In cppexp.c */
 389 extern int _cpp_parse_expr              PARAMS ((cpp_reader *));
 390
 391 /* In cpplex.c */
 392 extern cpp_token *_cpp_temp_token       PARAMS ((cpp_reader *));
 393 extern const cpp_token *_cpp_lex_token  PARAMS ((cpp_reader *));
 394 extern cpp_token *_cpp_lex_direct       PARAMS ((cpp_reader *));
 395 extern int _cpp_equiv_tokens            PARAMS ((const cpp_token *,
 396                                                  const cpp_token *));
 397 extern void _cpp_init_tokenrun          PARAMS ((tokenrun *, unsigned int));
 398
 399 /* In cppinit.c.  */
 400 extern bool _cpp_push_next_buffer       PARAMS ((cpp_reader *));
 401
 402 /* In cpplib.c */
 403 extern int _cpp_test_assertion PARAMS ((cpp_reader *, int *));
 404 extern int _cpp_handle_directive PARAMS ((cpp_reader *, int));
 405 extern void _cpp_define_builtin PARAMS ((cpp_reader *, const char *));
 406 extern void _cpp_do__Pragma     PARAMS ((cpp_reader *));
 407 extern void _cpp_init_directives PARAMS ((cpp_reader *));
 408 extern void _cpp_init_internal_pragmas PARAMS ((cpp_reader *));
 409 extern void _cpp_do_file_change PARAMS ((cpp_reader *, enum lc_reason,
 410                                          const char *,
 411                                          unsigned int, unsigned int));
 412 extern void _cpp_pop_buffer PARAMS ((cpp_reader *));
 413
 414 /* Utility routines and macros.  */
 415 #define DSC(str) (const U_CHAR *)str, sizeof str - 1
 416 #define xnew(T)         (T *) xmalloc (sizeof(T))
 417 #define xcnew(T)        (T *) xcalloc (1, sizeof(T))
 418 #define xnewvec(T, N)   (T *) xmalloc (sizeof(T) * (N))
 419 #define xcnewvec(T, N)  (T *) xcalloc (N, sizeof(T))
 420 #define xobnew(O, T)    (T *) obstack_alloc (O, sizeof(T))
 421
 422 /* These are inline functions instead of macros so we can get type
 423    checking.  */
 424 typedef unsigned char U_CHAR;
 425 #define U (const U_CHAR *)  /* Intended use: U"string" */
 426
 427 static inline int ustrcmp       PARAMS ((const U_CHAR *, const U_CHAR *));
 428 static inline int ustrncmp      PARAMS ((const U_CHAR *, const U_CHAR *,
 429                                          size_t));
 430 static inline size_t ustrlen    PARAMS ((const U_CHAR *));
 431 static inline U_CHAR *uxstrdup  PARAMS ((const U_CHAR *));
 432 static inline U_CHAR *ustrchr   PARAMS ((const U_CHAR *, int));
 433 static inline int ufputs        PARAMS ((const U_CHAR *, FILE *));
 434
 435 static inline int
 436 ustrcmp (s1, s2)
 437      const U_CHAR *s1, *s2;
 438 {
 439   return strcmp ((const char *)s1, (const char *)s2);
 440 }
 441
 442 static inline int
 443 ustrncmp (s1, s2, n)
 444      const U_CHAR *s1, *s2;
 445      size_t n;
 446 {
 447   return strncmp ((const char *)s1, (const char *)s2, n);
 448 }
 449
 450 static inline size_t
 451 ustrlen (s1)
 452      const U_CHAR *s1;
 453 {
 454   return strlen ((const char *)s1);
 455 }
 456
 457 static inline U_CHAR *
 458 uxstrdup (s1)
 459      const U_CHAR *s1;
 460 {
 461   return (U_CHAR *) xstrdup ((const char *)s1);
 462 }
 463
 464 static inline U_CHAR *
 465 ustrchr (s1, c)
 466      const U_CHAR *s1;
 467      int c;
 468 {
 469   return (U_CHAR *) strchr ((const char *)s1, c);
 470 }
 471
 472 static inline int
 473 ufputs (s, f)
 474      const U_CHAR *s;
 475      FILE *f;
 476 {
 477   return fputs ((const char *)s, f);
 478 }
 479
 480 #endif /* ! GCC_CPPHASH_H */