gcc/cpplib.h

   1 /* Definitions for CPP library.
   2    Copyright (C) 1995, 96-99, 2000 Free Software Foundation, Inc.
   3    Written by Per Bothner, 1994-95.
   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  In other words, you are welcome to use, share and improve this program.
  20  You are forbidden to forbid anyone else to use, share and improve
  21  what you give them.   Help stamp out software-hoarding!  */
  22 #ifndef __GCC_CPPLIB__
  23 #define __GCC_CPPLIB__
  24
  25 #include <sys/types.h>
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 typedef struct cpp_reader cpp_reader;
  32 typedef struct cpp_buffer cpp_buffer;
  33 typedef struct cpp_options cpp_options;
  34
  35 enum cpp_token
  36 {
  37   CPP_EOF = -1,
  38   CPP_OTHER = 0,
  39   CPP_COMMENT = 1,
  40   CPP_HSPACE,
  41   CPP_VSPACE, /* newlines and #line directives */
  42   CPP_NAME,
  43   CPP_MACRO,
  44   CPP_NUMBER,
  45   CPP_CHAR,
  46   CPP_WCHAR,
  47   CPP_STRING,
  48   CPP_WSTRING,
  49   CPP_DIRECTIVE,
  50   CPP_ASSERTION,        /* #machine(a29k) */
  51   CPP_STRINGIZE,        /* stringize macro argument */
  52   CPP_TOKPASTE,         /* paste macro arg with next/prev token */
  53   CPP_LPAREN,           /* "(" */
  54   CPP_RPAREN,           /* ")" */
  55   CPP_LBRACE,           /* "{" */
  56   CPP_RBRACE,           /* "}" */
  57   CPP_COMMA,            /* "," */
  58   CPP_SEMICOLON,        /* ";" */
  59   CPP_3DOTS,            /* "..." */
  60   CPP_POP               /* We're about to pop the buffer stack.  */
  61 };
  62
  63 typedef int (*parse_cleanup_t) PARAMS((cpp_buffer *, cpp_reader *));
  64
  65 struct cpp_buffer
  66 {
  67   const unsigned char *cur;      /* current position */
  68   const unsigned char *rlimit; /* end of valid data */
  69   const unsigned char *buf;      /* entire buffer */
  70   const unsigned char *line_base; /* start of current line */
  71   const unsigned char *mark;  /* Saved position for lengthy backtrack. */
  72
  73   struct cpp_buffer *prev;
  74
  75   /* Filename specified with #line command.  */
  76   const char *nominal_fname;
  77   /* Last filename specified with #line command.  */
  78   const char *last_nominal_fname;
  79   /* Actual directory of this file, used only for "" includes */
  80   struct file_name_list *actual_dir;
  81
  82   /* Pointer into the include hash table.  Used for include_next and
  83      to record control macros. */
  84   struct ihash *ihash;
  85
  86   long lineno; /* Line number at CPP_LINE_BASE. */
  87   parse_cleanup_t cleanup;
  88
  89   /* If the buffer is the expansion of a macro, this points to the
  90      macro's hash table entry.  */
  91   struct hashnode *macro;
  92
  93   /* Value of if_stack at start of this file.
  94      Used to prohibit unmatched #endif (etc) in an include file.  */
  95   struct if_stack *if_stack;
  96
  97   /* True if this is a header file included using <FILENAME>.  */
  98   char system_header_p;
  99   char seen_eof;
 100
 101   /* True if buffer contains escape sequences.
 102      Currently there are two kinds:
 103      "\r-" means following identifier should not be macro-expanded.
 104      "\r " means a token-separator.  This turns into " " in final output
 105           if not stringizing and needed to separate tokens; otherwise nothing.
 106      Any other two-character sequence beginning with \r is an error.
 107
 108      If this is NOT set, then \r is a one-character escape meaning backslash
 109      newline.  This is guaranteed not to occur in the middle of a token.
 110      The two interpretations of \r do not conflict, because the two-character
 111      escapes are used only in macro buffers, and backslash-newline is removed
 112      from macro expansion text in collect_expansion and/or macarg.  */
 113   char has_escapes;
 114
 115   /* Used by the C++ frontend to implement redirected input (such as for
 116      default argument and/or template parsing).  */
 117   char manual_pop;
 118
 119   /* True if we have already warned about C++ comments in this file.
 120      The warning happens only for C89 extended mode with -pedantic on,
 121      and only once per file (otherwise it would be far too noisy).  */
 122   char warned_cplusplus_comments;
 123 };
 124
 125 struct file_name_map_list;
 126 struct htab;
 127
 128 /* Maximum nesting of cpp_buffers.  We use a static limit, partly for
 129    efficiency, and partly to limit runaway recursion.  */
 130 #define CPP_STACK_MAX 200
 131
 132 /* Values for opts.dump_macros.
 133   dump_only means inhibit output of the preprocessed text
 134              and instead output the definitions of all user-defined
 135              macros in a form suitable for use as input to cccp.
 136    dump_names means pass #define and the macro name through to output.
 137    dump_definitions means pass the whole definition (plus #define) through
 138 */
 139 enum { dump_none = 0, dump_only, dump_names, dump_definitions };
 140
 141 /* This structure is nested inside struct cpp_reader, and
 142    carries all the options visible to the command line.  */
 143 struct cpp_options
 144 {
 145   /* Name of input and output files.  */
 146   const char *in_fname;
 147   const char *out_fname;
 148
 149   /* Pending options - -D, -U, -A, -I, -ixxx. */
 150   struct cpp_pending *pending;
 151
 152   /* File name which deps are being written to.  This is 0 if deps are
 153      being written to stdout.  */
 154   const char *deps_file;
 155
 156   /* Target-name to write with the dependency information.  */
 157   char *deps_target;
 158
 159   /* Search paths for include files.  */
 160   struct file_name_list *quote_include;  /* First dir to search for "file" */
 161   struct file_name_list *bracket_include;/* First dir to search for <file> */
 162
 163   /* Map between header names and file names, used only on DOS where
 164      file names are limited in length.  */
 165   struct file_name_map_list *map_list;
 166
 167   /* Directory prefix that should replace `/usr/lib/gcc-lib/TARGET/VERSION'
 168      in the standard include file directories.  */
 169   const char *include_prefix;
 170   unsigned int include_prefix_len;
 171
 172   /* Non-0 means -v, so print the full set of include dirs.  */
 173   unsigned char verbose;
 174
 175   /* Nonzero means use extra default include directories for C++.  */
 176   unsigned char cplusplus;
 177
 178   /* Nonzero means handle cplusplus style comments */
 179   unsigned char cplusplus_comments;
 180
 181   /* Nonzero means handle #import, for objective C.  */
 182   unsigned char objc;
 183
 184   /* Nonzero means this is an assembly file, so ignore unrecognized
 185      directives and the "# 33" form of #line, both of which are
 186      probably comments.  Also, permit unbalanced ' strings (again,
 187      likely to be in comments).  */
 188   unsigned char lang_asm;
 189
 190   /* Nonzero means this is Fortran, and we don't know where the
 191      comments are, so permit unbalanced ' strings.  Unlike lang_asm,
 192      this does not ignore unrecognized directives.  */
 193   unsigned char lang_fortran;
 194
 195   /* Nonzero means handle CHILL comment syntax and output CHILL string
 196      delimiters for __DATE__ etc. */
 197   unsigned char chill;
 198
 199   /* Nonzero means don't copy comments into the output file.  */
 200   unsigned char discard_comments;
 201
 202   /* Nonzero means process the ANSI trigraph sequences.  */
 203   unsigned char trigraphs;
 204
 205   /* Nonzero means print the names of included files rather than the
 206      preprocessed output.  1 means just the #include "...", 2 means
 207      #include <...> as well.  */
 208   unsigned char print_deps;
 209
 210   /* Nonzero if missing .h files in -M output are assumed to be
 211      generated files and not errors.  */
 212   unsigned char print_deps_missing_files;
 213
 214   /* If true, fopen (deps_file, "a") else fopen (deps_file, "w"). */
 215   unsigned char print_deps_append;
 216
 217   /* Nonzero means print names of header files (-H).  */
 218   unsigned char print_include_names;
 219
 220   /* Nonzero means cpp_pedwarn causes a hard error.  */
 221   unsigned char pedantic_errors;
 222
 223   /* Nonzero means don't print warning messages.  */
 224   unsigned char inhibit_warnings;
 225
 226   /* Nonzero means don't print error messages.  Has no option to
 227      select it, but can be set by a user of cpplib (e.g. fix-header).  */
 228   unsigned char inhibit_errors;
 229
 230   /* Nonzero means warn if slash-star appears in a comment.  */
 231   unsigned char warn_comments;
 232
 233   /* Nonzero means warn if there are any trigraphs.  */
 234   unsigned char warn_trigraphs;
 235
 236   /* Nonzero means warn if #import is used.  */
 237   unsigned char warn_import;
 238
 239   /* Nonzero means warn if a macro argument is (or would be)
 240      stringified with -traditional, and warn about directives
 241      with the # indented from the beginning of the line.  */
 242   unsigned char warn_traditional;
 243
 244   /* Nonzero means turn warnings into errors.  */
 245   unsigned char warnings_are_errors;
 246
 247   /* Nonzero causes output not to be done, but directives such as
 248      #define that have side effects are still obeyed.  */
 249   unsigned char no_output;
 250
 251   /* Nonzero means we should look for header.gcc files that remap file
 252      names.  */
 253   unsigned char remap;
 254
 255   /* Nonzero means don't output line number information.  */
 256   unsigned char no_line_commands;
 257
 258   /* Nonzero means -I- has been seen, so don't look for #include "foo"
 259      the source-file directory.  */
 260   unsigned char ignore_srcdir;
 261
 262   /* Zero means dollar signs are punctuation. */
 263   unsigned char dollars_in_ident;
 264
 265   /* Nonzero means try to imitate old fashioned non-ANSI preprocessor.  */
 266   unsigned char traditional;
 267
 268   /* Nonzero means warn if undefined identifiers are evaluated in an #if.  */
 269   unsigned char warn_undef;
 270
 271   /* Nonzero for the 1989 C Standard, including corrigenda and amendments.  */
 272   unsigned char c89;
 273
 274   /* Nonzero for the 1999 C Standard, including corrigenda and amendments.  */
 275   unsigned char c99;
 276
 277   /* Nonzero means give all the error messages the ANSI standard requires.  */
 278   unsigned char pedantic;
 279
 280   /* Nonzero means we're looking at already preprocessed code, so don't
 281      bother trying to do macro expansion and whatnot.  */
 282   unsigned char preprocessed;
 283
 284   /* Nonzero disables all the standard directories for headers.  */
 285   unsigned char no_standard_includes;
 286
 287   /* Nonzero disables the C++-specific standard directories for headers.  */
 288   unsigned char no_standard_cplusplus_includes;
 289
 290   /* Nonzero means dump macros in some fashion - see above.  */
 291   unsigned char dump_macros;
 292
 293   /* Nonzero means pass all #define and #undef directives which we
 294      actually process through to the output stream.  This feature is
 295      used primarily to allow cc1 to record the #defines and #undefs
 296      for the sake of debuggers which understand about preprocessor
 297      macros, but it may also be useful with -E to figure out how
 298      symbols are defined, and where they are defined.  */
 299   unsigned char debug_output;
 300
 301   /* Nonzero means pass #include lines through to the output.  */
 302   unsigned char dump_includes;
 303
 304   /* Print column number in error messages.  */
 305   unsigned char show_column;
 306 };
 307
 308
 309 /* A cpp_reader encapsulates the "state" of a pre-processor run.
 310    Applying cpp_get_token repeatedly yields a stream of pre-processor
 311    tokens.  Usually, there is only one cpp_reader object active. */
 312
 313 struct cpp_reader
 314 {
 315   cpp_buffer *buffer;
 316
 317   /* A buffer used for both for cpp_get_token's output, and also internally. */
 318   unsigned char *token_buffer;
 319   /* Allocated size of token_buffer.  CPP_RESERVE allocates space.  */
 320   unsigned int token_buffer_size;
 321   /* End of the written part of token_buffer. */
 322   unsigned char *limit;
 323
 324   /* Error counter for exit code */
 325   int errors;
 326
 327   /* Line where a newline was first seen in a string constant.  */
 328   int multiline_string_line;
 329
 330   /* Current depth in #include directives that use <...>.  */
 331   int system_include_depth;
 332
 333   /* Current depth of buffer stack. */
 334   int buffer_stack_depth;
 335
 336   /* Hash table of macros and assertions.  See cpphash.c */
 337   struct htab *hashtab;
 338
 339   /* Hash table of other included files.  See cppfiles.c */
 340   struct htab *all_include_files;
 341
 342   /* Chain of `actual directory' file_name_list entries,
 343      for "" inclusion. */
 344   struct file_name_list *actual_dirs;
 345
 346   /* Current maximum length of directory names in the search path
 347      for include files.  (Altered as we get more of them.)  */
 348   unsigned int max_include_len;
 349
 350   struct if_stack *if_stack;
 351   const unsigned char *potential_control_macro;
 352
 353   long lineno;
 354
 355   struct tm *timebuf;
 356
 357   /* Buffer of -M output.  */
 358   struct deps *deps;
 359
 360   /* A buffer used only by read_and_prescan (in cppfiles.c), which is
 361      allocated once per cpp_reader object to keep it off the stack.  */
 362   unsigned char *input_buffer;
 363   size_t input_buffer_len;
 364
 365   /* User visible options.  */
 366   struct cpp_options opts;
 367
 368   /* Nonzero means we have printed (while error reporting) a list of
 369      containing files that matches the current status.  */
 370   unsigned char input_stack_listing_current;
 371
 372   /* If non-zero, macros are not expanded.  */
 373   unsigned char no_macro_expand;
 374
 375   /* If non-zero, directives cause a hard error.  Used when parsing
 376      macro arguments.  */
 377   unsigned char no_directives;
 378
 379   /* We're printed a warning recommending against using #import.  */
 380   unsigned char import_warning;
 381
 382   /* If true, characters between '<' and '>' are a single (string) token.  */
 383   unsigned char parsing_include_directive;
 384
 385   /* If true, # introduces an assertion (see do_assert) */
 386   unsigned char parsing_if_directive;
 387
 388   /* If true, # and ## are the STRINGIZE and TOKPASTE operators */
 389   unsigned char parsing_define_directive;
 390
 391   /* True if escape sequences (as described for has_escapes in
 392      parse_buffer) should be emitted.  */
 393   unsigned char output_escapes;
 394
 395   /* 0: Have seen non-white-space on this line.
 396      1: Only seen white space so far on this line.
 397      2: Only seen white space so far in this file.  */
 398   unsigned char only_seen_white;
 399
 400   /* True after cpp_start_read completes.  Used to inhibit some
 401      warnings while parsing the command line.  */
 402   unsigned char done_initializing;
 403 };
 404
 405 #define CPP_FATAL_LIMIT 1000
 406 /* True if we have seen a "fatal" error. */
 407 #define CPP_FATAL_ERRORS(READER) ((READER)->errors >= CPP_FATAL_LIMIT)
 408
 409 /* Macros for manipulating the token_buffer. */
 410
 411 /* Number of characters currently in PFILE's output buffer. */
 412 #define CPP_WRITTEN(PFILE) ((size_t)((PFILE)->limit - (PFILE)->token_buffer))
 413 #define CPP_PWRITTEN(PFILE) ((PFILE)->limit)
 414 #define CPP_ADJUST_WRITTEN(PFILE,DELTA) ((PFILE)->limit += (DELTA))
 415 #define CPP_SET_WRITTEN(PFILE,N) ((PFILE)->limit = (PFILE)->token_buffer + (N))
 416
 417 #define CPP_OPTION(PFILE, OPTION) ((PFILE)->opts.OPTION)
 418 #define CPP_BUFFER(PFILE) ((PFILE)->buffer)
 419
 420 /* Name under which this program was invoked.  */
 421 extern const char *progname;
 422
 423 extern int cpp_handle_options PARAMS ((cpp_reader *, int, char **));
 424 extern enum cpp_token cpp_get_token PARAMS ((cpp_reader *));
 425 extern enum cpp_token cpp_get_non_space_token PARAMS ((cpp_reader *));
 426
 427 extern void cpp_reader_init PARAMS ((cpp_reader *));
 428 extern int cpp_start_read PARAMS ((cpp_reader *, const char *));
 429 extern void cpp_finish PARAMS ((cpp_reader *));
 430 extern void cpp_cleanup PARAMS ((cpp_reader *PFILE));
 431
 432 extern void cpp_buf_line_and_col PARAMS((cpp_buffer *, long *, long *));
 433 extern cpp_buffer *cpp_file_buffer PARAMS((cpp_reader *));
 434 extern void cpp_define PARAMS ((cpp_reader *, const char *));
 435 extern void cpp_assert PARAMS ((cpp_reader *, const char *));
 436 extern void cpp_undef  PARAMS ((cpp_reader *, const char *));
 437 extern void cpp_unassert PARAMS ((cpp_reader *, const char *));
 438
 439 /* N.B. The error-message-printer prototypes have not been nicely
 440    formatted because exgettext needs to see 'msgid' on the same line
 441    as the name of the function in order to work properly.  Only the
 442    string argument gets a name in an effort to keep the lines from
 443    getting ridiculously oversized.  */
 444
 445 extern void cpp_ice PARAMS ((cpp_reader *, const char *msgid, ...))
 446   ATTRIBUTE_PRINTF_2;
 447 extern void cpp_fatal PARAMS ((cpp_reader *, const char *msgid, ...))
 448   ATTRIBUTE_PRINTF_2;
 449 extern void cpp_error PARAMS ((cpp_reader *, const char *msgid, ...))
 450   ATTRIBUTE_PRINTF_2;
 451 extern void cpp_warning PARAMS ((cpp_reader *, const char *msgid, ...))
 452   ATTRIBUTE_PRINTF_2;
 453 extern void cpp_pedwarn PARAMS ((cpp_reader *, const char *msgid, ...))
 454   ATTRIBUTE_PRINTF_2;
 455 extern void cpp_notice PARAMS ((cpp_reader *, const char *msgid, ...))
 456   ATTRIBUTE_PRINTF_2;
 457 extern void cpp_error_with_line PARAMS ((cpp_reader *, int, int, const char *msgid, ...))
 458   ATTRIBUTE_PRINTF_4;
 459 extern void cpp_warning_with_line PARAMS ((cpp_reader *, int, int, const char *msgid, ...))
 460   ATTRIBUTE_PRINTF_4;
 461 extern void cpp_pedwarn_with_line PARAMS ((cpp_reader *, int, int, const char *msgid, ...))
 462   ATTRIBUTE_PRINTF_4;
 463 extern void cpp_pedwarn_with_file_and_line PARAMS ((cpp_reader *, const char *, int, int, const char *msgid, ...))
 464   ATTRIBUTE_PRINTF_5;
 465 extern void cpp_error_from_errno PARAMS ((cpp_reader *, const char *));
 466 extern void cpp_notice_from_errno PARAMS ((cpp_reader *, const char *));
 467
 468 extern cpp_buffer *cpp_push_buffer PARAMS ((cpp_reader *,
 469                                             const unsigned char *, long));
 470 extern cpp_buffer *cpp_pop_buffer PARAMS ((cpp_reader *));
 471 extern int cpp_defined PARAMS ((cpp_reader *, const unsigned char *, int));
 472
 473 extern void cpp_expand_to_buffer        PARAMS ((cpp_reader *,
 474                                                  const unsigned char *, int));
 475 extern void cpp_scan_buffer             PARAMS ((cpp_reader *));
 476
 477 /* In cppfiles.c */
 478 extern int cpp_included                 PARAMS ((cpp_reader *, const char *));
 479 extern int cpp_read_file                PARAMS ((cpp_reader *, const char *));
 480
 481 #ifdef __cplusplus
 482 }
 483 #endif
 484 #endif /* __GCC_CPPLIB__ */