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
  27 /* Structure allocated for every #define.  For a simple replacement
  28    such as
  29         #define foo bar ,
  30    nargs = -1, the `pattern' list is null, and the expansion is just
  31    the replacement text.  Nargs = 0 means a functionlike macro with no args,
  32    e.g.,
  33        #define getchar() getc (stdin) .
  34    When there are args, the expansion is the replacement text with the
  35    args squashed out, and the reflist is a list describing how to
  36    build the output from the input: e.g., "3 chars, then the 1st arg,
  37    then 9 chars, then the 3rd arg, then 0 chars, then the 2nd arg".
  38    The chars here come from the expansion.  Whatever is left of the
  39    expansion after the last arg-occurrence is copied after that arg.
  40    Note that the reflist can be arbitrarily long---
  41    its length depends on the number of times the arguments appear in
  42    the replacement text, not how many args there are.  Example:
  43    #define f(x) x+x+x+x+x+x+x would have replacement text "++++++" and
  44    pattern list
  45      { (0, 1), (1, 1), (1, 1), ..., (1, 1), NULL }
  46    where (x, y) means (nchars, argno). */
  47
  48 struct reflist
  49 {
  50   struct reflist *next;
  51   char stringify;               /* nonzero if this arg was preceded by a
  52                                    # operator. */
  53   char raw_before;              /* Nonzero if a ## operator before arg. */
  54   char raw_after;               /* Nonzero if a ## operator after arg. */
  55   char rest_args;               /* Nonzero if this arg. absorbs the rest */
  56   int nchars;                   /* Number of literal chars to copy before
  57                                    this arg occurrence.  */
  58   int argno;                    /* Number of arg to substitute (origin-0) */
  59 };
  60
  61 typedef struct definition DEFINITION;
  62 struct definition
  63 {
  64   int nargs;
  65   int length;                   /* length of expansion string */
  66   U_CHAR *expansion;
  67   int line;                     /* Line number of definition */
  68   int col;
  69   const char *file;             /* File of definition */
  70   char rest_args;               /* Nonzero if last arg. absorbs the rest */
  71   struct reflist *pattern;
  72
  73   /* Names of macro args, concatenated in order with \0 between
  74      them.  The only use of this is that we warn on redefinition if
  75      this differs between the old and new definitions.  */
  76   U_CHAR *argnames;
  77 };
  78
  79 /* The structure of a node in the hash table.  The hash table
  80    has entries for all tokens defined by #define commands (type T_MACRO),
  81    plus some special tokens like __LINE__ (these each have their own
  82    type, and the appropriate code is run when that type of node is seen.
  83    It does not contain control words like "#define", which are recognized
  84    by a separate piece of code. */
  85
  86 /* different flavors of hash nodes --- also used in keyword table */
  87 enum node_type
  88 {
  89   T_DEFINE = 1,    /* `#define' */
  90   T_INCLUDE,       /* `#include' */
  91   T_INCLUDE_NEXT,  /* `#include_next' */
  92   T_IMPORT,        /* `#import' */
  93   T_IFDEF,         /* `#ifdef' */
  94   T_IFNDEF,        /* `#ifndef' */
  95   T_IF,            /* `#if' */
  96   T_ELSE,          /* `#else' */
  97   T_PRAGMA,        /* `#pragma' */
  98   T_ELIF,          /* `#elif' */
  99   T_UNDEF,         /* `#undef' */
 100   T_LINE,          /* `#line' */
 101   T_ERROR,         /* `#error' */
 102   T_WARNING,       /* `#warning' */
 103   T_ENDIF,         /* `#endif' */
 104   T_SCCS,          /* `#sccs' */
 105   T_IDENT,         /* `#ident' */
 106   T_ASSERT,        /* `#assert' */
 107   T_UNASSERT,      /* `#unassert', */
 108   T_SPECLINE,      /* `__LINE__' */
 109   T_DATE,          /* `__DATE__' */
 110   T_FILE,          /* `__FILE__' */
 111   T_BASE_FILE,     /* `__BASE_FILE__' */
 112   T_INCLUDE_LEVEL, /* `__INCLUDE_LEVEL__' */
 113   T_VERSION,       /* `__VERSION__' */
 114   T_TIME,          /* `__TIME__' */
 115   T_STDC,          /* `__STDC__' */
 116   T_CONST,         /* Constant string, used by `__SIZE_TYPE__' etc */
 117   T_MACRO,         /* macro defined by `#define' */
 118   T_DISABLED,      /* macro temporarily turned off for rescan */
 119   T_POISON,        /* macro defined with `#pragma poison' */
 120   T_UNUSED         /* Used for something not defined.  */
 121 };
 122
 123 /* different kinds of things that can appear in the value field
 124    of a hash node. */
 125 union hashval
 126 {
 127   const char *cpval;            /* some predefined macros */
 128   DEFINITION *defn;             /* #define */
 129   struct hashnode *aschain;     /* #assert */
 130 };
 131
 132 typedef struct hashnode HASHNODE;
 133 struct hashnode
 134 {
 135   const U_CHAR *name;           /* the actual name */
 136   size_t length;                /* length of token, for quick comparison */
 137   unsigned long hash;           /* cached hash value */
 138   union hashval value;          /* pointer to expansion, or whatever */
 139   enum node_type type;          /* type of special token */
 140 };
 141
 142 /* List of directories to look for include files in. */
 143 struct file_name_list
 144 {
 145   struct file_name_list *next;
 146   struct file_name_list *alloc; /* for the cache of
 147                                    current directory entries */
 148   char *name;
 149   unsigned int nlen;
 150   /* We use these to tell if the directory mentioned here is a duplicate
 151      of an earlier directory on the search path. */
 152   ino_t ino;
 153   dev_t dev;
 154   /* If the following is nonzero, it is a C-language system include
 155      directory.  */
 156   int sysp;
 157   /* Mapping of file names for this directory.
 158      Only used on MS-DOS and related platforms. */
 159   struct file_name_map *name_map;
 160 };
 161 #define ABSOLUTE_PATH ((struct file_name_list *)-1)
 162
 163 /* This structure is used for the table of all includes.  It is
 164    indexed by the `short name' (the name as it appeared in the
 165    #include statement) which is stored in *nshort.  */
 166 struct ihash
 167 {
 168   /* Next file with the same short name but a
 169      different (partial) pathname). */
 170   struct ihash *next_this_file;
 171
 172   /* Location of the file in the include search path.
 173      Used for include_next */
 174   struct file_name_list *foundhere;
 175
 176   unsigned long hash;           /* save hash value for future reference */
 177   const char *nshort;           /* name of file as referenced in #include;
 178                                    points into name[]  */
 179   const U_CHAR *control_macro;  /* macro, if any, preventing reinclusion -
 180                                    see redundant_include_p */
 181   const char name[1];           /* (partial) pathname of file */
 182 };
 183 typedef struct ihash IHASH;
 184
 185 /* Character classes.
 186    If the definition of `numchar' looks odd to you, please look up the
 187    definition of a pp-number in the C standard [section 6.4.8 of C99] */
 188 #define ISidnum         0x01    /* a-zA-Z0-9_ */
 189 #define ISidstart       0x02    /* _a-zA-Z */
 190 #define ISnumstart      0x04    /* 0-9 */
 191 #define IShspace        0x08    /* ' ' \t \f \v */
 192 #define ISspace         0x10    /* ' ' \t \f \v \n */
 193
 194 #define _dollar_ok(x)   ((x) == '$' && CPP_OPTIONS (pfile)->dollars_in_ident)
 195
 196 #define is_idchar(x)    ((_cpp_IStable[x] & ISidnum) || _dollar_ok(x))
 197 #define is_idstart(x)   ((_cpp_IStable[x] & ISidstart) || _dollar_ok(x))
 198 #define is_numchar(x)   (_cpp_IStable[x] & ISidnum)
 199 #define is_numstart(x)  (_cpp_IStable[x] & ISnumstart)
 200 #define is_hspace(x)    (_cpp_IStable[x] & IShspace)
 201 #define is_space(x)     (_cpp_IStable[x] & ISspace)
 202
 203 /* This table is constant if it can be initialized at compile time,
 204    which is the case if cpp was compiled with GCC >=2.7, or another
 205    compiler that supports C99.  */
 206 #if (GCC_VERSION >= 2007) || (__STDC_VERSION__ >= 199901L)
 207 extern const unsigned char _cpp_IStable[256];
 208 #else
 209 extern unsigned char _cpp_IStable[256];
 210 #endif
 211
 212 /* Macros.  */
 213
 214 #define CPP_BUF_PEEK(BUFFER) \
 215   ((BUFFER)->cur < (BUFFER)->rlimit ? *(BUFFER)->cur : EOF)
 216 #define CPP_BUF_GET(BUFFER) \
 217   ((BUFFER)->cur < (BUFFER)->rlimit ? *(BUFFER)->cur++ : EOF)
 218 #define CPP_FORWARD(BUFFER, N) ((BUFFER)->cur += (N))
 219
 220 /* Make sure PFILE->token_buffer has space for at least N more characters. */
 221 #define CPP_RESERVE(PFILE, N) \
 222   (CPP_WRITTEN (PFILE) + (size_t)(N) > (PFILE)->token_buffer_size \
 223    && (_cpp_grow_token_buffer (PFILE, N), 0))
 224
 225 /* Append string STR (of length N) to PFILE's output buffer.
 226    Assume there is enough space. */
 227 #define CPP_PUTS_Q(PFILE, STR, N) \
 228   (memcpy ((PFILE)->limit, STR, (N)), (PFILE)->limit += (N))
 229 /* Append string STR (of length N) to PFILE's output buffer.  Make space. */
 230 #define CPP_PUTS(PFILE, STR, N) CPP_RESERVE(PFILE, N), CPP_PUTS_Q(PFILE, STR,N)
 231 /* Append character CH to PFILE's output buffer.  Assume sufficient space. */
 232 #define CPP_PUTC_Q(PFILE, CH) (*(PFILE)->limit++ = (CH))
 233 /* Append character CH to PFILE's output buffer.  Make space if need be. */
 234 #define CPP_PUTC(PFILE, CH) (CPP_RESERVE (PFILE, 1), CPP_PUTC_Q (PFILE, CH))
 235 /* Make sure PFILE->limit is followed by '\0'. */
 236 #define CPP_NUL_TERMINATE_Q(PFILE) (*(PFILE)->limit = 0)
 237 #define CPP_NUL_TERMINATE(PFILE) (CPP_RESERVE(PFILE, 1), *(PFILE)->limit = 0)
 238
 239 /* Advance the current line by one. */
 240 #define CPP_BUMP_BUFFER_LINE(PBUF) ((PBUF)->lineno++,\
 241                                     (PBUF)->line_base = (PBUF)->cur)
 242 #define CPP_BUMP_LINE(PFILE) CPP_BUMP_BUFFER_LINE(CPP_BUFFER(PFILE))
 243 #define CPP_PREV_BUFFER(BUFFER) ((BUFFER)->prev)
 244
 245 #define CPP_PRINT_DEPS(PFILE) (CPP_OPTIONS (PFILE)->print_deps)
 246 #define CPP_TRADITIONAL(PFILE) (CPP_OPTIONS(PFILE)->traditional)
 247 #define CPP_PEDANTIC(PFILE) \
 248   (CPP_OPTIONS (PFILE)->pedantic && !CPP_BUFFER (pfile)->system_header_p)
 249
 250 /* CPP_IS_MACRO_BUFFER is true if the buffer contains macro expansion.
 251    (Note that it is false while we're expanding macro *arguments*.) */
 252 #define CPP_IS_MACRO_BUFFER(PBUF) ((PBUF)->data != NULL)
 253
 254 /* Remember the current position of PFILE so it may be returned to
 255    after looking ahead a bit.
 256
 257    Note that when you set a mark, you _must_ return to that mark.  You
 258    may not forget about it and continue parsing.  You may not pop a
 259    buffer with an active mark.  You may not call CPP_BUMP_LINE while a
 260    mark is active.  */
 261 #define CPP_SET_BUF_MARK(IP)   ((IP)->mark = (IP)->cur - (IP)->buf)
 262 #define CPP_GOTO_BUF_MARK(IP)  ((IP)->cur = (IP)->buf + (IP)->mark, \
 263                                 (IP)->mark = -1)
 264 #define CPP_SET_MARK(PFILE)  CPP_SET_BUF_MARK(CPP_BUFFER(PFILE))
 265 #define CPP_GOTO_MARK(PFILE) CPP_GOTO_BUF_MARK(CPP_BUFFER(PFILE))
 266
 267 /* ACTIVE_MARK_P is true if there's a live mark in the buffer.  */
 268 #define ACTIVE_MARK_P(PFILE) (CPP_BUFFER (PFILE)->mark != -1)
 269
 270 /* Last arg to output_line_command.  */
 271 enum file_change_code {same_file, rename_file, enter_file, leave_file};
 272
 273 /* In cpphash.c */
 274 extern HASHNODE *_cpp_make_hashnode     PARAMS ((const U_CHAR *, size_t,
 275                                                  enum node_type,
 276                                                  unsigned long));
 277 extern HASHNODE *_cpp_lookup            PARAMS ((cpp_reader *,
 278                                                  const U_CHAR *, int));
 279 extern HASHNODE **_cpp_lookup_slot      PARAMS ((cpp_reader *,
 280                                                  const U_CHAR *, int, int,
 281                                                  unsigned long *));
 282 extern void _cpp_free_definition        PARAMS ((DEFINITION *));
 283 extern DEFINITION *_cpp_create_definition PARAMS ((cpp_reader *, int));
 284 extern void _cpp_dump_definition        PARAMS ((cpp_reader *, const U_CHAR *,
 285                                                  long, DEFINITION *));
 286 extern int _cpp_compare_defs            PARAMS ((cpp_reader *, DEFINITION *,
 287                                                  DEFINITION *));
 288 extern void _cpp_quote_string           PARAMS ((cpp_reader *, const char *));
 289 extern void _cpp_macroexpand            PARAMS ((cpp_reader *, HASHNODE *));
 290 extern void _cpp_init_macro_hash        PARAMS ((cpp_reader *));
 291 extern void _cpp_dump_macro_hash        PARAMS ((cpp_reader *));
 292
 293 /* In cppfiles.c */
 294 extern void _cpp_simplify_pathname      PARAMS ((char *));
 295 extern int _cpp_find_include_file       PARAMS ((cpp_reader *, const char *,
 296                                                 struct file_name_list *,
 297                                                 IHASH **, int *));
 298 extern int _cpp_read_include_file       PARAMS ((cpp_reader *, int, IHASH *));
 299 extern void _cpp_init_include_hash      PARAMS ((cpp_reader *));
 300
 301 /* In cppexp.c */
 302 extern int _cpp_parse_expr              PARAMS ((cpp_reader *));
 303
 304 /* In cpplex.c */
 305 extern void _cpp_parse_name             PARAMS ((cpp_reader *, int));
 306 extern void _cpp_skip_rest_of_line      PARAMS ((cpp_reader *));
 307 extern void _cpp_skip_hspace            PARAMS ((cpp_reader *));
 308 extern int _cpp_parse_assertion         PARAMS ((cpp_reader *));
 309 extern enum cpp_token _cpp_lex_token    PARAMS ((cpp_reader *));
 310 extern long _cpp_read_and_prescan       PARAMS ((cpp_reader *, cpp_buffer *,
 311                                                  int, size_t));
 312 extern void _cpp_init_input_buffer      PARAMS ((cpp_reader *));
 313 extern void _cpp_grow_token_buffer      PARAMS ((cpp_reader *, long));
 314 extern enum cpp_token _cpp_get_directive_token
 315                                         PARAMS ((cpp_reader *));
 316
 317 /* In cpplib.c */
 318 extern int _cpp_handle_directive        PARAMS ((cpp_reader *));
 319 extern void _cpp_handle_eof             PARAMS ((cpp_reader *));
 320 extern void _cpp_output_line_command    PARAMS ((cpp_reader *,
 321                                                  enum file_change_code));
 322
 323
 324 #endif