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