gcc/cpphash.h

   1 /* Part of CPP library.
   2    Copyright (C) 1997, 1998, 1999, 2000 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__
  23 #define __GCC_CPPHASH__
  24
  25 /* Test if a sign is valid within a preprocessing number.  */
  26 #define VALID_SIGN(c, prevc) \
  27   (((c) == '+' || (c) == '-') && \
  28    ((prevc) == 'e' || (prevc) == 'E' \
  29     || (((prevc) == 'p' || (prevc) == 'P') \
  30         && CPP_OPTION (pfile, extended_numbers))))
  31
  32 /* Memory pools.  */
  33 #define ALIGN(size, align) (((size) + ((align) - 1)) & ~((align) - 1))
  34 #define POOL_FRONT(p) ((p)->cur->front)
  35 #define POOL_LIMIT(p) ((p)->cur->limit)
  36 #define POOL_BASE(p)  ((p)->cur->base)
  37 #define POOL_SIZE(p)  ((p)->cur->limit - (p)->cur->base)
  38 #define POOL_ROOM(p)  ((p)->cur->limit - (p)->cur->front)
  39 #define POOL_USED(p)  ((p)->cur->front - (p)->cur->base)
  40 #define POOL_COMMIT(p, len) do {((p)->cur->front += ALIGN (len, (p)->align));\
  41   if ((p)->cur->front > (p)->cur->limit) abort ();} while (0)
  42
  43 typedef struct cpp_chunk cpp_chunk;
  44 struct cpp_chunk
  45 {
  46   cpp_chunk *next;
  47   unsigned char *front;
  48   unsigned char *limit;
  49   unsigned char *base;
  50 };
  51
  52 /* List of directories to look for include files in. */
  53 struct file_name_list
  54 {
  55   struct file_name_list *next;
  56   struct file_name_list *alloc; /* for the cache of
  57                                    current directory entries */
  58   char *name;
  59   unsigned int nlen;
  60   /* We use these to tell if the directory mentioned here is a duplicate
  61      of an earlier directory on the search path. */
  62   ino_t ino;
  63   dev_t dev;
  64   /* If the following is nonzero, it is a C-language system include
  65      directory.  */
  66   int sysp;
  67   /* Mapping of file names for this directory.
  68      Only used on MS-DOS and related platforms. */
  69   struct file_name_map *name_map;
  70 };
  71 #define ABSOLUTE_PATH ((struct file_name_list *)-1)
  72
  73 /* The cmacro works like this: If it's NULL, the file is to be
  74    included again.  If it's NEVER_REREAD, the file is never to be
  75    included again.  Otherwise it is a macro hashnode, and the file is
  76    to be included again if the macro is defined or not as specified by
  77    DEFINED.  */
  78 #define NEVER_REREAD ((const cpp_hashnode *)-1)
  79 #define DO_NOT_REREAD(inc) \
  80 ((inc)->cmacro && ((inc)->cmacro == NEVER_REREAD \
  81                    || ((inc)->cmacro->type == NT_MACRO) == (inc)->defined))
  82
  83 struct cpp_buffer
  84 {
  85   const unsigned char *cur;      /* current position */
  86   const unsigned char *rlimit; /* end of valid data */
  87   const unsigned char *line_base; /* start of current line */
  88   cppchar_t read_ahead;         /* read ahead character */
  89   cppchar_t extra_char;         /* extra read-ahead for long tokens.  */
  90
  91   struct cpp_reader *pfile;     /* Owns this buffer.  */
  92   struct cpp_buffer *prev;
  93
  94   const unsigned char *buf;      /* entire buffer */
  95
  96   /* Filename specified with #line command.  */
  97   const char *nominal_fname;
  98
  99   /* Actual directory of this file, used only for "" includes */
 100   struct file_name_list *actual_dir;
 101
 102   /* Pointer into the include table.  Used for include_next and
 103      to record control macros. */
 104   struct include_file *inc;
 105
 106   /* Value of if_stack at start of this file.
 107      Used to prohibit unmatched #endif (etc) in an include file.  */
 108   struct if_stack *if_stack;
 109
 110   /* Token column position adjustment owing to tabs in whitespace.  */
 111   unsigned int col_adjust;
 112
 113   /* Line number at line_base (above). */
 114   unsigned int lineno;
 115
 116   /* Because of the way the lexer works, -Wtrigraphs can sometimes
 117      warn twice for the same trigraph.  This helps prevent that.  */
 118   const unsigned char *last_Wtrigraphs;
 119
 120   /* True if we have already warned about C++ comments in this file.
 121      The warning happens only for C89 extended mode with -pedantic on,
 122      or for -Wtraditional, and only once per file (otherwise it would
 123      be far too noisy).  */
 124   unsigned char warned_cplusplus_comments;
 125
 126   /* True if we don't process trigraphs and escaped newlines.  True
 127      for preprocessed input, command line directives, and _Pragma
 128      buffers.  */
 129   unsigned char from_stage3;
 130
 131   /* Temporary storage for pfile->skipping whilst in a directive.  */
 132   unsigned char was_skipping;
 133
 134   /* 1 = system header file, 2 = C system header file used for C++.  */
 135   unsigned char sysp;
 136 };
 137
 138 /* Character classes.
 139    If the definition of `numchar' looks odd to you, please look up the
 140    definition of a pp-number in the C standard [section 6.4.8 of C99].
 141
 142    In the unlikely event that characters other than \r and \n enter
 143    the set is_vspace, the macro handle_newline() in cpplex.c must be
 144    updated.  */
 145 #define ISidnum         0x01    /* a-zA-Z0-9_ */
 146 #define ISidstart       0x02    /* _a-zA-Z */
 147 #define ISnumstart      0x04    /* 0-9 */
 148 #define IShspace        0x08    /* ' ' \t */
 149 #define ISvspace        0x10    /* \r \n */
 150 #define ISspace         0x20    /* ' ' \t \r \n \f \v \0 */
 151
 152 #define _dollar_ok(x)   ((x) == '$' && CPP_OPTION (pfile, dollars_in_ident))
 153
 154 #define is_idchar(x)    ((_cpp_IStable[x] & ISidnum) || _dollar_ok(x))
 155 #define is_idstart(x)   ((_cpp_IStable[x] & ISidstart) || _dollar_ok(x))
 156 #define is_numchar(x)   (_cpp_IStable[x] & ISidnum)
 157 #define is_numstart(x)  (_cpp_IStable[x] & ISnumstart)
 158 #define is_hspace(x)    (_cpp_IStable[x] & IShspace)
 159 #define is_vspace(x)    (_cpp_IStable[x] & ISvspace)
 160 #define is_nvspace(x)   ((_cpp_IStable[x] & (ISspace | ISvspace)) == ISspace)
 161 #define is_space(x)     (_cpp_IStable[x] & ISspace)
 162
 163 /* These tables are constant if they can be initialized at compile time,
 164    which is the case if cpp was compiled with GCC >=2.7, or another
 165    compiler that supports C99.  */
 166 #if HAVE_DESIGNATED_INITIALIZERS
 167 extern const unsigned char _cpp_IStable[UCHAR_MAX + 1];
 168 extern const unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
 169 #else
 170 extern unsigned char _cpp_IStable[UCHAR_MAX + 1];
 171 extern unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
 172 #endif
 173
 174 /* Macros.  */
 175
 176 #define CPP_PREV_BUFFER(BUFFER) ((BUFFER)->prev)
 177 #define CPP_PRINT_DEPS(PFILE) CPP_OPTION (PFILE, print_deps)
 178 #define CPP_IN_SYSTEM_HEADER(PFILE) \
 179   (CPP_BUFFER (PFILE) && CPP_BUFFER (PFILE)->sysp)
 180 #define CPP_PEDANTIC(PF) \
 181   CPP_OPTION (PF, pedantic)
 182 #define CPP_WTRADITIONAL(PF) \
 183   CPP_OPTION (PF, warn_traditional)
 184
 185 /* Hash step.  The hash calculation is duplicated in cpp_lookup and
 186    parse_name.  */
 187 #define HASHSTEP(r, c) ((r) * 67 + (c - 113));
 188
 189 /* In cpperror.c  */
 190 enum error_type { WARNING = 0, PEDWARN, ERROR, FATAL, ICE };
 191 extern int _cpp_begin_message PARAMS ((cpp_reader *, enum error_type,
 192                                        const char *, const cpp_lexer_pos *));
 193
 194 /* In cppmacro.c */
 195 extern void _cpp_free_definition        PARAMS ((cpp_hashnode *));
 196 extern int _cpp_create_definition       PARAMS ((cpp_reader *, cpp_hashnode *));
 197 extern void _cpp_pop_context            PARAMS ((cpp_reader *));
 198 extern void _cpp_free_lookaheads        PARAMS ((cpp_reader *));
 199 extern void _cpp_release_lookahead      PARAMS ((cpp_reader *));
 200 extern void _cpp_push_token             PARAMS ((cpp_reader *, const cpp_token *,
 201                                                  const cpp_lexer_pos *));
 202
 203 /* In cpphash.c */
 204 extern void _cpp_init_hashtable         PARAMS ((cpp_reader *));
 205 extern void _cpp_cleanup_hashtable      PARAMS ((cpp_reader *));
 206 extern cpp_hashnode *_cpp_lookup_with_hash PARAMS ((cpp_reader*, size_t,
 207                                                     unsigned int));
 208
 209 /* In cppfiles.c */
 210 extern void _cpp_never_reread           PARAMS ((struct include_file *));
 211 extern void _cpp_simplify_pathname      PARAMS ((char *));
 212 extern int _cpp_read_file               PARAMS ((cpp_reader *, const char *));
 213 extern void _cpp_execute_include        PARAMS ((cpp_reader *,
 214                                                  const cpp_token *, int, int));
 215 extern int _cpp_compare_file_date       PARAMS ((cpp_reader *,
 216                                                  const cpp_token *));
 217 extern void _cpp_report_missing_guards  PARAMS ((cpp_reader *));
 218 extern void _cpp_init_includes          PARAMS ((cpp_reader *));
 219 extern void _cpp_cleanup_includes       PARAMS ((cpp_reader *));
 220 extern void _cpp_pop_file_buffer        PARAMS ((cpp_reader *, cpp_buffer *));
 221
 222 /* In cppexp.c */
 223 extern int _cpp_parse_expr              PARAMS ((cpp_reader *));
 224
 225 /* In cpplex.c */
 226 extern void _cpp_lex_token              PARAMS ((cpp_reader *, cpp_token *));
 227 extern int _cpp_equiv_tokens            PARAMS ((const cpp_token *,
 228                                                  const cpp_token *));
 229 extern void _cpp_init_pool              PARAMS ((cpp_pool *, unsigned int,
 230                                                   unsigned int, unsigned int));
 231 extern void _cpp_free_pool              PARAMS ((cpp_pool *));
 232 extern unsigned char *_cpp_pool_reserve PARAMS ((cpp_pool *, unsigned int));
 233 extern unsigned char *_cpp_pool_alloc   PARAMS ((cpp_pool *, unsigned int));
 234 extern unsigned char *_cpp_next_chunk   PARAMS ((cpp_pool *, unsigned int,
 235                                                  unsigned char **));
 236 extern void _cpp_lock_pool              PARAMS ((cpp_pool *));
 237 extern void _cpp_unlock_pool            PARAMS ((cpp_pool *));
 238
 239 /* In cpplib.c */
 240 extern int _cpp_test_assertion PARAMS ((cpp_reader *, int *));
 241 extern int _cpp_handle_directive PARAMS ((cpp_reader *, int));
 242 extern void _cpp_define_builtin PARAMS ((cpp_reader *, const char *));
 243 extern void _cpp_do__Pragma     PARAMS ((cpp_reader *));
 244 extern void _cpp_init_stacks    PARAMS ((cpp_reader *));
 245 extern void _cpp_cleanup_stacks PARAMS ((cpp_reader *));
 246 extern void _cpp_init_internal_pragmas PARAMS ((cpp_reader *));
 247 extern void _cpp_do_file_change PARAMS ((cpp_reader *, enum cpp_fc_reason,
 248                                          const char *, unsigned int));
 249
 250 /* Utility routines and macros.  */
 251 #define DSC(str) (const U_CHAR *)str, sizeof str - 1
 252 #define xnew(T)         (T *) xmalloc (sizeof(T))
 253 #define xcnew(T)        (T *) xcalloc (1, sizeof(T))
 254 #define xnewvec(T, N)   (T *) xmalloc (sizeof(T) * (N))
 255 #define xcnewvec(T, N)  (T *) xcalloc (N, sizeof(T))
 256 #define xobnew(O, T)    (T *) obstack_alloc (O, sizeof(T))
 257
 258 #endif