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