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