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   /* Nonzero when in a # NUMBER directive.  */
 157   unsigned char line_extension;
 158 };
 159
 160 /* Special nodes - identifiers with predefined significance.  */
 161 struct spec_nodes
 162 {
 163   cpp_hashnode *n_defined;              /* defined operator */
 164   cpp_hashnode *n_true;                 /* C++ keyword true */
 165   cpp_hashnode *n_false;                /* C++ keyword false */
 166   cpp_hashnode *n__STRICT_ANSI__;       /* STDC_0_IN_SYSTEM_HEADERS */
 167   cpp_hashnode *n__CHAR_UNSIGNED__;     /* plain char is unsigned */
 168   cpp_hashnode *n__VA_ARGS__;           /* C99 vararg macros */
 169 };
 170
 171 /* Represents the contents of a file cpplib has read in.  */
 172 struct cpp_buffer
 173 {
 174   const unsigned char *cur;      /* current position */
 175   const unsigned char *backup_to; /* if peeked character is not wanted */
 176   const unsigned char *rlimit; /* end of valid data */
 177   const unsigned char *line_base; /* start of current line */
 178
 179   struct cpp_buffer *prev;
 180
 181   const unsigned char *buf;      /* Entire character buffer.  */
 182
 183   /* Pointer into the include table; non-NULL if this is a file
 184      buffer.  Used for include_next and to record control macros.  */
 185   struct include_file *inc;
 186
 187   /* Value of if_stack at start of this file.
 188      Used to prohibit unmatched #endif (etc) in an include file.  */
 189   struct if_stack *if_stack;
 190
 191   /* Token column position adjustment owing to tabs in whitespace.  */
 192   unsigned int col_adjust;
 193
 194   /* Contains PREV_WHITE and/or AVOID_LPASTE.  */
 195   unsigned char saved_flags;
 196
 197   /* Because of the way the lexer works, -Wtrigraphs can sometimes
 198      warn twice for the same trigraph.  This helps prevent that.  */
 199   const unsigned char *last_Wtrigraphs;
 200
 201   /* True if we have already warned about C++ comments in this file.
 202      The warning happens only for C89 extended mode with -pedantic on,
 203      or for -Wtraditional, and only once per file (otherwise it would
 204      be far too noisy).  */
 205   unsigned char warned_cplusplus_comments;
 206
 207   /* True if we don't process trigraphs and escaped newlines.  True
 208      for preprocessed input, command line directives, and _Pragma
 209      buffers.  */
 210   unsigned char from_stage3;
 211
 212   /* Nonzero means that the directory to start searching for ""
 213      include files has been calculated and stored in "dir" below.  */
 214   unsigned char search_cached;
 215
 216   /* At EOF, a buffer is automatically popped.  If RETURN_AT_EOF is
 217      true, a CPP_EOF token is then returned.  Otherwise, the next
 218      token from the enclosing buffer is returned.  */
 219   bool return_at_eof;
 220
 221   /* The directory of the this buffer's file.  Its NAME member is not
 222      allocated, so we don't need to worry about freeing it.  */
 223   struct search_path dir;
 224 };
 225
 226 /* A cpp_reader encapsulates the "state" of a pre-processor run.
 227    Applying cpp_get_token repeatedly yields a stream of pre-processor
 228    tokens.  Usually, there is only one cpp_reader object active.  */
 229 struct cpp_reader
 230 {
 231   /* Top of buffer stack.  */
 232   cpp_buffer *buffer;
 233
 234   /* Lexer state.  */
 235   struct lexer_state state;
 236
 237   /* Source line tracking.  */
 238   struct line_maps line_maps;
 239   const struct line_map *map;
 240   unsigned int line;
 241
 242   /* The line of the '#' of the current directive.  */
 243   unsigned int directive_line;
 244
 245   /* Memory buffers.  */
 246   _cpp_buff *a_buff;            /* Aligned permanent storage.  */
 247   _cpp_buff *u_buff;            /* Unaligned permanent storage.  */
 248   _cpp_buff *free_buffs;        /* Free buffer chain.  */
 249
 250   /* Context stack.  */
 251   struct cpp_context base_context;
 252   struct cpp_context *context;
 253
 254   /* If in_directive, the directive if known.  */
 255   const struct directive *directive;
 256
 257   /* Multiple inlcude optimisation.  */
 258   const cpp_hashnode *mi_cmacro;
 259   const cpp_hashnode *mi_ind_cmacro;
 260   bool mi_valid;
 261
 262   /* Lexing.  */
 263   cpp_token *cur_token;
 264   tokenrun base_run, *cur_run;
 265   unsigned int lookaheads;
 266
 267   /* Non-zero prevents the lexer from re-using the token runs.  */
 268   unsigned int keep_tokens;
 269
 270   /* Error counter for exit code.  */
 271   unsigned int errors;
 272
 273   /* Line and column where a newline was first seen in a string
 274      constant (multi-line strings).  */
 275   unsigned int mls_line;
 276   unsigned int mls_col;
 277
 278   /* Buffer to hold macro definition string.  */
 279   unsigned char *macro_buffer;
 280   unsigned int macro_buffer_len;
 281
 282   /* Tree of other included files.  See cppfiles.c.  */
 283   struct splay_tree_s *all_include_files;
 284
 285   /* Current maximum length of directory names in the search path
 286      for include files.  (Altered as we get more of them.)  */
 287   unsigned int max_include_len;
 288
 289   /* Date and time tokens.  Calculated together if either is requested.  */
 290   cpp_token date;
 291   cpp_token time;
 292
 293   /* EOF token, and a token forcing paste avoidance.  */
 294   cpp_token avoid_paste;
 295   cpp_token eof;
 296
 297   /* Opaque handle to the dependencies of mkdeps.c.  Used by -M etc.  */
 298   struct deps *deps;
 299
 300   /* Obstack holding all macro hash nodes.  This never shrinks.
 301      See cpphash.c */
 302   struct obstack hash_ob;
 303
 304   /* Obstack holding buffer and conditional structures.  This is a
 305      real stack.  See cpplib.c.  */
 306   struct obstack buffer_ob;
 307
 308   /* Pragma table - dynamic, because a library user can add to the
 309      list of recognized pragmas.  */
 310   struct pragma_entry *pragmas;
 311
 312   /* Call backs.  */
 313   struct cpp_callbacks cb;
 314
 315   /* Identifier hash table.  */
 316   struct ht *hash_table;
 317
 318   /* User visible options.  */
 319   struct cpp_options opts;
 320
 321   /* Special nodes - identifiers with predefined significance to the
 322      preprocessor.  */
 323   struct spec_nodes spec_nodes;
 324
 325   /* Whether to print our version number.  Done this way so
 326      we don't get it twice for -v -version.  */
 327   unsigned char print_version;
 328
 329   /* Whether cpplib owns the hashtable.  */
 330   unsigned char our_hashtable;
 331 };
 332
 333 /* Character classes.  Based on the more primitive macros in safe-ctype.h.
 334    If the definition of `numchar' looks odd to you, please look up the
 335    definition of a pp-number in the C standard [section 6.4.8 of C99].
 336
 337    In the unlikely event that characters other than \r and \n enter
 338    the set is_vspace, the macro handle_newline() in cpplex.c must be
 339    updated.  */
 340 #define _dollar_ok(x)   ((x) == '$' && CPP_OPTION (pfile, dollars_in_ident))
 341
 342 #define is_idchar(x)    (ISIDNUM(x) || _dollar_ok(x))
 343 #define is_numchar(x)   ISIDNUM(x)
 344 #define is_idstart(x)   (ISIDST(x) || _dollar_ok(x))
 345 #define is_numstart(x)  ISDIGIT(x)
 346 #define is_hspace(x)    ISBLANK(x)
 347 #define is_vspace(x)    IS_VSPACE(x)
 348 #define is_nvspace(x)   IS_NVSPACE(x)
 349 #define is_space(x)     IS_SPACE_OR_NUL(x)
 350
 351 /* This table is constant if it can be initialized at compile time,
 352    which is the case if cpp was compiled with GCC >=2.7, or another
 353    compiler that supports C99.  */
 354 #if HAVE_DESIGNATED_INITIALIZERS
 355 extern const unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
 356 #else
 357 extern unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
 358 #endif
 359
 360 /* Macros.  */
 361
 362 #define CPP_PRINT_DEPS(PFILE) CPP_OPTION (PFILE, print_deps)
 363 #define CPP_IN_SYSTEM_HEADER(PFILE) ((PFILE)->map && (PFILE)->map->sysp)
 364 #define CPP_PEDANTIC(PF) CPP_OPTION (PF, pedantic)
 365 #define CPP_WTRADITIONAL(PF) CPP_OPTION (PF, warn_traditional)
 366
 367 /* In cpperror.c  */
 368 enum error_type { WARNING = 0, WARNING_SYSHDR, PEDWARN, ERROR, FATAL, ICE };
 369 extern int _cpp_begin_message PARAMS ((cpp_reader *, enum error_type,
 370                                        unsigned int, unsigned int));
 371
 372 /* In cppmacro.c */
 373 extern void _cpp_free_definition        PARAMS ((cpp_hashnode *));
 374 extern int _cpp_create_definition       PARAMS ((cpp_reader *, cpp_hashnode *));
 375 extern void _cpp_pop_context            PARAMS ((cpp_reader *));
 376
 377 /* In cpphash.c */
 378 extern void _cpp_init_hashtable         PARAMS ((cpp_reader *, hash_table *));
 379 extern void _cpp_destroy_hashtable      PARAMS ((cpp_reader *));
 380
 381 /* In cppfiles.c */
 382 extern void _cpp_fake_include           PARAMS ((cpp_reader *, const char *));
 383 extern void _cpp_never_reread           PARAMS ((struct include_file *));
 384 extern char *_cpp_simplify_pathname     PARAMS ((char *));
 385 extern bool _cpp_read_file              PARAMS ((cpp_reader *, const char *));
 386 extern bool _cpp_execute_include        PARAMS ((cpp_reader *,
 387                                                  const cpp_token *,
 388                                                  enum include_type));
 389 extern int _cpp_compare_file_date       PARAMS ((cpp_reader *,
 390                                                  const cpp_token *));
 391 extern void _cpp_report_missing_guards  PARAMS ((cpp_reader *));
 392 extern void _cpp_init_includes          PARAMS ((cpp_reader *));
 393 extern void _cpp_cleanup_includes       PARAMS ((cpp_reader *));
 394 extern bool _cpp_pop_file_buffer        PARAMS ((cpp_reader *,
 395                                                  struct include_file *));
 396
 397 /* In cppexp.c */
 398 extern int _cpp_parse_expr              PARAMS ((cpp_reader *));
 399
 400 /* In cpplex.c */
 401 extern cpp_token *_cpp_temp_token       PARAMS ((cpp_reader *));
 402 extern const cpp_token *_cpp_lex_token  PARAMS ((cpp_reader *));
 403 extern cpp_token *_cpp_lex_direct       PARAMS ((cpp_reader *));
 404 extern int _cpp_equiv_tokens            PARAMS ((const cpp_token *,
 405                                                  const cpp_token *));
 406 extern void _cpp_init_tokenrun          PARAMS ((tokenrun *, unsigned int));
 407
 408 /* In cppinit.c.  */
 409 extern bool _cpp_push_next_buffer       PARAMS ((cpp_reader *));
 410
 411 /* In cpplib.c */
 412 extern int _cpp_test_assertion PARAMS ((cpp_reader *, int *));
 413 extern int _cpp_handle_directive PARAMS ((cpp_reader *, int));
 414 extern void _cpp_define_builtin PARAMS ((cpp_reader *, const char *));
 415 extern void _cpp_do__Pragma     PARAMS ((cpp_reader *));
 416 extern void _cpp_init_directives PARAMS ((cpp_reader *));
 417 extern void _cpp_init_internal_pragmas PARAMS ((cpp_reader *));
 418 extern void _cpp_do_file_change PARAMS ((cpp_reader *, enum lc_reason,
 419                                          const char *,
 420                                          unsigned int, unsigned int));
 421 extern void _cpp_pop_buffer PARAMS ((cpp_reader *));
 422
 423 /* Utility routines and macros.  */
 424 #define DSC(str) (const U_CHAR *)str, sizeof str - 1
 425 #define xnew(T)         (T *) xmalloc (sizeof(T))
 426 #define xcnew(T)        (T *) xcalloc (1, sizeof(T))
 427 #define xnewvec(T, N)   (T *) xmalloc (sizeof(T) * (N))
 428 #define xcnewvec(T, N)  (T *) xcalloc (N, sizeof(T))
 429 #define xobnew(O, T)    (T *) obstack_alloc (O, sizeof(T))
 430
 431 /* These are inline functions instead of macros so we can get type
 432    checking.  */
 433 typedef unsigned char U_CHAR;
 434 #define U (const U_CHAR *)  /* Intended use: U"string" */
 435
 436 static inline int ustrcmp       PARAMS ((const U_CHAR *, const U_CHAR *));
 437 static inline int ustrncmp      PARAMS ((const U_CHAR *, const U_CHAR *,
 438                                          size_t));
 439 static inline size_t ustrlen    PARAMS ((const U_CHAR *));
 440 static inline U_CHAR *uxstrdup  PARAMS ((const U_CHAR *));
 441 static inline U_CHAR *ustrchr   PARAMS ((const U_CHAR *, int));
 442 static inline int ufputs        PARAMS ((const U_CHAR *, FILE *));
 443
 444 static inline int
 445 ustrcmp (s1, s2)
 446      const U_CHAR *s1, *s2;
 447 {
 448   return strcmp ((const char *)s1, (const char *)s2);
 449 }
 450
 451 static inline int
 452 ustrncmp (s1, s2, n)
 453      const U_CHAR *s1, *s2;
 454      size_t n;
 455 {
 456   return strncmp ((const char *)s1, (const char *)s2, n);
 457 }
 458
 459 static inline size_t
 460 ustrlen (s1)
 461      const U_CHAR *s1;
 462 {
 463   return strlen ((const char *)s1);
 464 }
 465
 466 static inline U_CHAR *
 467 uxstrdup (s1)
 468      const U_CHAR *s1;
 469 {
 470   return (U_CHAR *) xstrdup ((const char *)s1);
 471 }
 472
 473 static inline U_CHAR *
 474 ustrchr (s1, c)
 475      const U_CHAR *s1;
 476      int c;
 477 {
 478   return (U_CHAR *) strchr ((const char *)s1, c);
 479 }
 480
 481 static inline int
 482 ufputs (s, f)
 483      const U_CHAR *s;
 484      FILE *f;
 485 {
 486   return fputs ((const char *)s, f);
 487 }
 488
 489 #endif /* ! GCC_CPPHASH_H */