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 typedef unsigned char U_CHAR;
  26 #define U (const U_CHAR *)  /* Intended use: U"string" */
  27
  28 /* Tokens with SPELL_STRING store their spelling in the token list,
  29    and it's length in the token->val.name.len.  */
  30 enum spell_type
  31 {
  32   SPELL_OPERATOR = 0,
  33   SPELL_CHAR,
  34   SPELL_IDENT,
  35   SPELL_STRING,
  36   SPELL_NONE
  37 };
  38
  39 struct token_spelling
  40 {
  41   enum spell_type category;
  42   const U_CHAR *name;
  43 };
  44
  45 extern const struct token_spelling _cpp_token_spellings[];
  46 #define TOKEN_SPELL(token) (_cpp_token_spellings[(token)->type].category)
  47 #define TOKEN_NAME(token) (_cpp_token_spellings[(token)->type].name)
  48
  49 /* Chained list of answers to an assertion.  */
  50 struct answer
  51 {
  52   struct answer *next;
  53   cpp_toklist list;
  54 };
  55 #define FREE_ANSWER(answer) do {_cpp_free_toklist (&answer->list); \
  56                                 free (answer); } while (0)
  57
  58 /* Values for the origin field of struct directive.  KANDR directives
  59    come from traditional (K&R) C.  STDC89 directives come from the
  60    1989 C standard.  EXTENSION directives are extensions.  */
  61 #define KANDR           0
  62 #define STDC89          1
  63 #define EXTENSION       2
  64
  65 /* Values for the flags field of struct directive.  COND indicates a
  66    conditional.  EXPAND means that macros are to be expanded on the
  67    directive line.  INCL means to treat "..." and <...> as
  68    q-char-sequence and h-char-sequence respectively.  COMMENTS means
  69    preserve comments in the directive if -C.  IN_I means this directive
  70    should be handled even if -fpreprocessed is in effect (these are the
  71    directives with callback hooks).  */
  72 #define COND            (1 << 0)
  73 #define EXPAND          (1 << 1)
  74 #define INCL            (1 << 2)
  75 #define COMMENTS        (1 << 3)
  76 #define IN_I            (1 << 4)
  77
  78 /* Defines one #-directive, including how to handle it.  */
  79 typedef void (*directive_handler) PARAMS ((cpp_reader *));
  80 struct directive
  81 {
  82   directive_handler handler;    /* Function to handle directive.  */
  83   const U_CHAR *name;           /* Name of directive.  */
  84   unsigned short length;        /* Length of name.  */
  85   unsigned char origin;         /* Origin of directive.  */
  86   unsigned char flags;          /* Flags describing this directive.  */
  87 };
  88
  89 /* List of directories to look for include files in. */
  90 struct file_name_list
  91 {
  92   struct file_name_list *next;
  93   struct file_name_list *alloc; /* for the cache of
  94                                    current directory entries */
  95   char *name;
  96   unsigned int nlen;
  97   /* We use these to tell if the directory mentioned here is a duplicate
  98      of an earlier directory on the search path. */
  99   ino_t ino;
 100   dev_t dev;
 101   /* If the following is nonzero, it is a C-language system include
 102      directory.  */
 103   int sysp;
 104   /* Mapping of file names for this directory.
 105      Only used on MS-DOS and related platforms. */
 106   struct file_name_map *name_map;
 107 };
 108 #define ABSOLUTE_PATH ((struct file_name_list *)-1)
 109
 110 /* This structure is used for the table of all includes.  */
 111 struct include_file
 112 {
 113   const char *name;             /* actual path name of file */
 114   const cpp_hashnode *cmacro;   /* macro, if any, preventing reinclusion.  */
 115   const struct file_name_list *foundhere;
 116                                 /* location in search path where file was
 117                                    found, for #include_next */
 118   int fd;                       /* file descriptor possibly open on file */
 119   unsigned short include_count; /* number of times file has been read */
 120   unsigned short sysp;          /* file is a system header */
 121   time_t  date;                 /* modification date of file, if known */
 122 };
 123
 124 /* Special nodes - identifiers with predefined significance.
 125    Note that the array length of dirs[] must be kept in sync with
 126    cpplib.c's dtable[].  */
 127 struct spec_nodes
 128 {
 129   cpp_hashnode *n_L;                    /* L"str" */
 130   cpp_hashnode *n__STRICT_ANSI__;       /* STDC_0_IN_SYSTEM_HEADERS */
 131   cpp_hashnode *n__CHAR_UNSIGNED__;     /* plain char is unsigned */
 132   cpp_hashnode *n__VA_ARGS__;           /* C99 vararg macros */
 133   cpp_hashnode *dirs[19];               /* 19 directives counting #sccs */
 134 };
 135
 136
 137 /* The cmacro works like this: If it's NULL, the file is to be
 138    included again.  If it's NEVER_REREAD, the file is never to be
 139    included again.  Otherwise it is a macro hashnode, and the file is
 140    to be included again if the macro is not defined.  */
 141 #define NEVER_REREAD ((const cpp_hashnode *)-1)
 142 #define DO_NOT_REREAD(inc) \
 143 ((inc)->cmacro && \
 144  ((inc)->cmacro == NEVER_REREAD || (inc)->cmacro->type != T_VOID))
 145
 146 /* Character classes.
 147    If the definition of `numchar' looks odd to you, please look up the
 148    definition of a pp-number in the C standard [section 6.4.8 of C99].
 149
 150    In the unlikely event that characters other than \r and \n enter
 151    the set is_vspace, the macro handle_newline() in cpplex.c must be
 152    updated.  */
 153 #define ISidnum         0x01    /* a-zA-Z0-9_ */
 154 #define ISidstart       0x02    /* _a-zA-Z */
 155 #define ISnumstart      0x04    /* 0-9 */
 156 #define IShspace        0x08    /* ' ' \t */
 157 #define ISvspace        0x10    /* \r \n */
 158 #define ISspace         0x20    /* ' ' \t \r \n \f \v \0 */
 159
 160 #define _dollar_ok(x)   ((x) == '$' && CPP_OPTION (pfile, dollars_in_ident))
 161
 162 #define is_idchar(x)    ((_cpp_IStable[x] & ISidnum) || _dollar_ok(x))
 163 #define is_idstart(x)   ((_cpp_IStable[x] & ISidstart) || _dollar_ok(x))
 164 #define is_numchar(x)   (_cpp_IStable[x] & ISidnum)
 165 #define is_numstart(x)  (_cpp_IStable[x] & ISnumstart)
 166 #define is_hspace(x)    (_cpp_IStable[x] & IShspace)
 167 #define is_vspace(x)    (_cpp_IStable[x] & ISvspace)
 168 #define is_nvspace(x)   ((_cpp_IStable[x] & (ISspace | ISvspace)) == ISspace)
 169 #define is_space(x)     (_cpp_IStable[x] & ISspace)
 170
 171 /* These tables are constant if they can be initialized at compile time,
 172    which is the case if cpp was compiled with GCC >=2.7, or another
 173    compiler that supports C99.  */
 174 #if HAVE_DESIGNATED_INITIALIZERS
 175 extern const unsigned char _cpp_IStable[UCHAR_MAX + 1];
 176 extern const unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
 177 #else
 178 extern unsigned char _cpp_IStable[UCHAR_MAX + 1];
 179 extern unsigned char _cpp_trigraph_map[UCHAR_MAX + 1];
 180 #endif
 181
 182 /* Macros.  */
 183
 184 /* Make sure PFILE->token_buffer has space for at least N more characters. */
 185 #define CPP_RESERVE(PFILE, N) \
 186   (CPP_WRITTEN (PFILE) + (size_t)(N) > (PFILE)->token_buffer_size \
 187    && (_cpp_grow_token_buffer (PFILE, N), 0))
 188
 189 /* Append string STR (of length N) to PFILE's output buffer.
 190    Assume there is enough space. */
 191 #define CPP_PUTS_Q(PFILE, STR, N) \
 192   (memcpy ((PFILE)->limit, STR, (N)), (PFILE)->limit += (N))
 193 /* Append string STR (of length N) to PFILE's output buffer.  Make space. */
 194 #define CPP_PUTS(PFILE, STR, N) CPP_RESERVE(PFILE, N), CPP_PUTS_Q(PFILE, STR,N)
 195 /* Append character CH to PFILE's output buffer.  Assume sufficient space. */
 196 #define CPP_PUTC_Q(PFILE, CH) (*(PFILE)->limit++ = (CH))
 197 /* Append character CH to PFILE's output buffer.  Make space if need be. */
 198 #define CPP_PUTC(PFILE, CH) (CPP_RESERVE (PFILE, 1), CPP_PUTC_Q (PFILE, CH))
 199
 200 #define CPP_PREV_BUFFER(BUFFER) ((BUFFER)->prev)
 201 #define CPP_PRINT_DEPS(PFILE) CPP_OPTION (PFILE, print_deps)
 202 #define CPP_IN_SYSTEM_HEADER(PFILE) \
 203   (CPP_BUFFER (PFILE) && CPP_BUFFER (PFILE)->inc \
 204    && CPP_BUFFER (PFILE)->inc->sysp)
 205 #define CPP_PEDANTIC(PF) \
 206   (CPP_OPTION (PF, pedantic) && !CPP_IN_SYSTEM_HEADER (PF))
 207 #define CPP_WTRADITIONAL(PF) \
 208   (CPP_OPTION (PF, warn_traditional) && !CPP_IN_SYSTEM_HEADER (PF))
 209
 210 /* Hash step.  The hash calculation is duplicated in cpp_lookup and
 211    parse_name.  */
 212 #define HASHSTEP(r, str) ((r) * 67 + (*str - 113));
 213
 214 /* Flags for _cpp_init_toklist.  */
 215 #define DUMMY_TOKEN     0
 216 #define NO_DUMMY_TOKEN  1
 217
 218 /* In cpperror.c  */
 219 enum error_type { WARNING = 0, PEDWARN, ERROR, FATAL, ICE };
 220 extern int _cpp_begin_message PARAMS ((cpp_reader *, enum error_type,
 221                                        const char *, unsigned int,
 222                                        unsigned int));
 223
 224 /* In cppmacro.c */
 225 extern void _cpp_free_definition        PARAMS ((cpp_hashnode *));
 226 extern int _cpp_create_definition       PARAMS ((cpp_reader *, cpp_hashnode *));
 227
 228 /* In cpphash.c */
 229 extern void _cpp_init_macros            PARAMS ((cpp_reader *));
 230 extern void _cpp_cleanup_macros         PARAMS ((cpp_reader *));
 231 extern cpp_hashnode *_cpp_lookup_with_hash PARAMS ((cpp_reader*, const U_CHAR *,
 232                                                     size_t, unsigned int));
 233
 234 /* In cppfiles.c */
 235 extern void _cpp_simplify_pathname      PARAMS ((char *));
 236 extern void _cpp_execute_include        PARAMS ((cpp_reader *, const U_CHAR *,
 237                                                  unsigned int, int,
 238                                                  struct file_name_list *,
 239                                                  int));
 240 extern int _cpp_compare_file_date       PARAMS ((cpp_reader *, const U_CHAR *,
 241                                                  unsigned int, int));
 242 extern void _cpp_report_missing_guards  PARAMS ((cpp_reader *));
 243 extern void _cpp_init_includes          PARAMS ((cpp_reader *));
 244 extern void _cpp_cleanup_includes       PARAMS ((cpp_reader *));
 245 extern const char *_cpp_fake_include    PARAMS ((cpp_reader *, const char *));
 246 extern void _cpp_pop_file_buffer        PARAMS ((cpp_reader *, cpp_buffer *));
 247
 248 /* In cppexp.c */
 249 extern int _cpp_parse_expr              PARAMS ((cpp_reader *));
 250
 251 /* In cpplex.c */
 252 extern void _cpp_skip_rest_of_line      PARAMS ((cpp_reader *));
 253 extern void _cpp_free_temp_tokens       PARAMS ((cpp_reader *));
 254 extern void _cpp_init_input_buffer      PARAMS ((cpp_reader *));
 255 extern void _cpp_grow_token_buffer      PARAMS ((cpp_reader *, long));
 256 extern void _cpp_init_toklist           PARAMS ((cpp_toklist *, int));
 257 extern void _cpp_clear_toklist          PARAMS ((cpp_toklist *));
 258 extern void _cpp_free_toklist           PARAMS ((const cpp_toklist *));
 259 extern int _cpp_equiv_tokens            PARAMS ((const cpp_token *,
 260                                                  const cpp_token *));
 261 extern int _cpp_equiv_toklists          PARAMS ((const cpp_toklist *,
 262                                                  const cpp_toklist *));
 263 extern void _cpp_expand_token_space     PARAMS ((cpp_toklist *, unsigned int));
 264 extern void _cpp_reserve_name_space     PARAMS ((cpp_toklist *, unsigned int));
 265 extern void _cpp_expand_name_space      PARAMS ((cpp_toklist *, unsigned int));
 266 extern int _cpp_equiv_tokens            PARAMS ((const cpp_token *,
 267                                                  const cpp_token *));
 268 extern void _cpp_run_directive          PARAMS ((cpp_reader *,
 269                                                  const struct directive *,
 270                                                  const char *, size_t));
 271 extern unsigned int _cpp_get_line       PARAMS ((cpp_reader *,
 272                                                  unsigned int *));
 273 extern const cpp_token *_cpp_get_token PARAMS ((cpp_reader *));
 274 extern const cpp_token *_cpp_get_raw_token PARAMS ((cpp_reader *));
 275 extern void _cpp_push_token PARAMS ((cpp_reader *, const cpp_token*));
 276 extern const cpp_token *_cpp_glue_header_name PARAMS ((cpp_reader *));
 277
 278 /* In cpplib.c */
 279 extern const struct directive *_cpp_check_directive
 280                         PARAMS ((cpp_reader *, const cpp_token *, int));
 281 extern const struct directive *_cpp_check_linemarker
 282                         PARAMS ((cpp_reader *, const cpp_token *, int));
 283 extern cpp_hashnode *_cpp_parse_assertion PARAMS ((cpp_reader *,
 284                                                     struct answer **));
 285 extern struct answer **_cpp_find_answer PARAMS ((cpp_hashnode *,
 286                                                  const cpp_toklist *));
 287 extern void _cpp_init_stacks    PARAMS ((cpp_reader *));
 288 extern void _cpp_cleanup_stacks PARAMS ((cpp_reader *));
 289 extern void _cpp_init_internal_pragmas PARAMS ((cpp_reader *));
 290
 291 /* Utility routines and macros.  */
 292 #define xnew(T)         (T *) xmalloc (sizeof(T))
 293 #define xnewvec(T, N)   (T *) xmalloc (sizeof(T) * (N))
 294 #define xcnewvec(T, N)  (T *) xcalloc (N, sizeof(T))
 295 #define xobnew(O, T)    (T *) obstack_alloc (O, sizeof(T))
 296
 297 /* These are inline functions instead of macros so we can get type
 298    checking.  */
 299
 300 static inline int ustrcmp       PARAMS ((const U_CHAR *, const U_CHAR *));
 301 static inline int ustrncmp      PARAMS ((const U_CHAR *, const U_CHAR *,
 302                                          size_t));
 303 static inline size_t ustrlen    PARAMS ((const U_CHAR *));
 304 static inline U_CHAR *uxstrdup  PARAMS ((const U_CHAR *));
 305 static inline U_CHAR *ustrchr   PARAMS ((const U_CHAR *, int));
 306 static inline int ufputs        PARAMS ((const U_CHAR *, FILE *));
 307
 308 static inline int
 309 ustrcmp (s1, s2)
 310      const U_CHAR *s1, *s2;
 311 {
 312   return strcmp ((const char *)s1, (const char *)s2);
 313 }
 314
 315 static inline int
 316 ustrncmp (s1, s2, n)
 317      const U_CHAR *s1, *s2;
 318      size_t n;
 319 {
 320   return strncmp ((const char *)s1, (const char *)s2, n);
 321 }
 322
 323 static inline size_t
 324 ustrlen (s1)
 325      const U_CHAR *s1;
 326 {
 327   return strlen ((const char *)s1);
 328 }
 329
 330 static inline U_CHAR *
 331 uxstrdup (s1)
 332      const U_CHAR *s1;
 333 {
 334   return (U_CHAR *) xstrdup ((const char *)s1);
 335 }
 336
 337 static inline U_CHAR *
 338 ustrchr (s1, c)
 339      const U_CHAR *s1;
 340      int c;
 341 {
 342   return (U_CHAR *) strchr ((const char *)s1, c);
 343 }
 344
 345 static inline int
 346 ufputs (s, f)
 347      const U_CHAR *s;
 348      FILE *f;
 349 {
 350   return fputs ((const char *)s, f);
 351 }
 352
 353 #endif