2000-07-03 Donn Terry (donnte@microsoft.com)

[official-gcc.git] / gcc / cpplib.c

/* CPP Library.
   Copyright (C) 1986, 1987, 1989, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
   1999, 2000 Free Software Foundation, Inc.
   Contributed by Per Bothner, 1994-95.
   Based on CCCP program by Paul Rubin, June 1986
   Adapted to ANSI C, Richard Stallman, Jan 1987

This program is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; either version 2, or (at your option) any
later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  */

#include "config.h"
#include "system.h"

#include "cpplib.h"
#include "cpphash.h"
#include "intl.h"
#include "obstack.h"
#include "symcat.h"

#ifdef HAVE_MMAP_FILE
# include <sys/mman.h>
#endif

/* Stack of conditionals currently in progress
   (including both successful and failing conditionals).  */

struct if_stack
{
  struct if_stack *next;
  unsigned int lineno;          /* line number where condition started */
  unsigned int colno;           /* and column */
  int was_skipping;             /* value of pfile->skipping before this if */
  const cpp_hashnode *cmacro;   /* macro name for #ifndef around entire file */
  int type;                     /* type of last directive seen in this group */
};

/* Forward declarations.  */

static void validate_else       PARAMS ((cpp_reader *, const U_CHAR *));
static int  parse_include       PARAMS ((cpp_reader *, const U_CHAR *, int,
                                         const U_CHAR **, unsigned int *,
                                         int *));
static void push_conditional    PARAMS ((cpp_reader *, int, int,
                                         const cpp_hashnode *));
static void pass_thru_directive PARAMS ((cpp_reader *));
static int  read_line_number    PARAMS ((cpp_reader *, int *));
static int  strtoul_for_line    PARAMS ((const U_CHAR *, unsigned int,
                                         unsigned long *));

static const cpp_hashnode *
            parse_ifdef         PARAMS ((cpp_reader *, const U_CHAR *));
static const cpp_hashnode *
            detect_if_not_defined PARAMS ((cpp_reader *));
static cpp_hashnode *
            get_define_node     PARAMS ((cpp_reader *));
static void dump_macro_name     PARAMS ((cpp_reader *, cpp_hashnode *));
static void unwind_if_stack     PARAMS ((cpp_reader *, cpp_buffer *));

/* Utility.  */
#define str_match(sym, len, str) \
((len) == (sizeof (str) - 1) && !ustrncmp ((sym), U(str), sizeof (str) - 1))

/* This is the table of directive handlers.  It is ordered by
   frequency of occurrence; the numbers at the end are directive
   counts from all the source code I have lying around (egcs and libc
   CVS as of 1999-05-18, plus grub-0.5.91, linux-2.2.9, and
   pcmcia-cs-3.0.9).

   The entries with a dash and a name after the count are extensions,
   of which all but #warning and #include_next are deprecated.  The name
   is where the extension appears to have come from.  */

/* #sccs is not always recognized.  */
#ifdef SCCS_DIRECTIVE
# define SCCS_ENTRY D(sccs, T_SCCS, EXTENSION, 0)
#else
# define SCCS_ENTRY /* nothing */
#endif

#define DIRECTIVE_TABLE                                                 \
D(define,       T_DEFINE = 0,   KANDR,     COMMENTS)       /* 270554 */ \
D(include,      T_INCLUDE,      KANDR,     EXPAND | INCL)  /*  52262 */ \
D(endif,        T_ENDIF,        KANDR,     COND)           /*  45855 */ \
D(ifdef,        T_IFDEF,        KANDR,     COND)           /*  22000 */ \
D(if,           T_IF,           KANDR,     COND | EXPAND)  /*  18162 */ \
D(else,         T_ELSE,         KANDR,     COND)           /*   9863 */ \
D(ifndef,       T_IFNDEF,       KANDR,     COND)           /*   9675 */ \
D(undef,        T_UNDEF,        KANDR,     0)              /*   4837 */ \
D(line,         T_LINE,         KANDR,     EXPAND)         /*   2465 */ \
D(elif,         T_ELIF,         KANDR,     COND | EXPAND)  /*    610 */ \
D(error,        T_ERROR,        STDC89,    0)              /*    475 */ \
D(pragma,       T_PRAGMA,       STDC89,    0)              /*    195 */ \
D(warning,      T_WARNING,      EXTENSION, 0)              /*     22 GNU   */ \
D(include_next, T_INCLUDE_NEXT, EXTENSION, EXPAND | INCL)  /*     19 GNU   */ \
D(ident,        T_IDENT,        EXTENSION, 0)              /*     11 SVR4  */ \
D(import,       T_IMPORT,       EXTENSION, EXPAND | INCL)  /*      0 ObjC  */ \
D(assert,       T_ASSERT,       EXTENSION, 0)              /*      0 SVR4  */ \
D(unassert,     T_UNASSERT,     EXTENSION, 0)              /*      0 SVR4  */ \
SCCS_ENTRY                                                 /*      0 SVR2? */

/* Use the table to generate a series of prototypes, an enum for the
   directive names, and an array of directive handlers.  */

/* The directive-processing functions are declared to return int
   instead of void, because some old compilers have trouble with
   pointers to functions returning void.  */

/* Don't invoke CONCAT2 with any whitespace or K&R cc will fail. */
#define D(name, t, o, f) static int CONCAT2(do_,name) PARAMS ((cpp_reader *));
DIRECTIVE_TABLE
#undef D

#define D(n, tag, o, f) tag,
enum
{
  DIRECTIVE_TABLE
  N_DIRECTIVES
};
#undef D

/* Don't invoke CONCAT2 with any whitespace or K&R cc will fail. */
#define D(name, t, origin, flags) \
{ CONCAT2(do_,name), (const U_CHAR *) STRINGX(name), \
  sizeof STRINGX(name) - 1, origin, flags },
static const struct directive dtable[] =
{
DIRECTIVE_TABLE
};
#undef D
#undef DIRECTIVE_TABLE

/* Check if a token's name matches that of a known directive.  Put in
   this file to save exporting dtable and other unneeded information.  */
const struct directive *
_cpp_check_directive (pfile, token, bol)
     cpp_reader *pfile;
     const cpp_token *token;
     int bol;
{
  const U_CHAR *name = token->val.name.text;
  size_t len = token->val.name.len;
  unsigned int i;

  /* If we are rescanning preprocessed input, don't obey any directives
     other than # nnn.  */
  if (CPP_OPTION (pfile, preprocessed))
    return 0;

  for (i = 0; i < N_DIRECTIVES; i++)
    if (dtable[i].length == len && !memcmp (dtable[i].name, name, len))
      {
        /* If we are skipping a failed conditional group, all non-conditional
           directives are ignored.  */
        if (pfile->skipping && !(dtable[i].flags & COND))
          return 0;

        /* In -traditional mode, a directive is ignored unless its #
           is in column 1.  */
        if (!bol && dtable[i].origin == KANDR && CPP_WTRADITIONAL (pfile))
          cpp_warning (pfile, "traditional C ignores #%s with the # indented",
                       dtable[i].name);
              
        if (!bol && CPP_TRADITIONAL (pfile))
          return 0;

        /* Issue -pedantic warnings for extended directives.   */
        if (CPP_PEDANTIC (pfile) && dtable[i].origin == EXTENSION)
          cpp_pedwarn (pfile, "ISO C does not allow #%s", dtable[i].name);

        /* -Wtraditional gives warnings about directives with inappropriate
           indentation of #.  */
        if (bol && dtable[i].origin != KANDR && CPP_WTRADITIONAL (pfile))
          cpp_warning (pfile,
                    "suggest hiding #%s from traditional C with an indented #",
                       dtable[i].name);

        return &dtable[i];
      }

  return 0;
}

const struct directive *
_cpp_check_linemarker (pfile, token, bol)
     cpp_reader *pfile;
     const cpp_token *token ATTRIBUTE_UNUSED;
     int bol;
{
  /* # followed by a number is equivalent to #line.  Do not recognize
     this form in assembly language source files or skipped
     conditional groups.  Complain about this form if we're being
     pedantic, but not if this is regurgitated input (preprocessed or
     fed back in by the C++ frontend).  */
  if (pfile->skipping || CPP_OPTION (pfile, lang_asm))
    return 0;

  if (CPP_PEDANTIC (pfile) && CPP_BUFFER (pfile)->inc
      && ! CPP_OPTION (pfile, preprocessed))
    cpp_pedwarn (pfile, "# followed by integer");

  /* In -traditional mode, a directive is ignored unless its #
     is in column 1.  */
  if (!bol && CPP_WTRADITIONAL (pfile))
    cpp_warning (pfile, "traditional C ignores #%s with the # indented",
                 dtable[T_LINE].name);
              
  if (!bol && CPP_TRADITIONAL (pfile))
    return 0;
  
  return &dtable[T_LINE];
}  

static void
dump_macro_name (pfile, node)
     cpp_reader *pfile;
     cpp_hashnode *node;
{
  CPP_PUTS (pfile, "#define ", sizeof "#define " - 1);
  CPP_PUTS (pfile, node->name, node->length);
}

/* Pass the current directive through to the output file.  */
static void
pass_thru_directive (pfile)
     cpp_reader *pfile;
{
  /* XXX This output may be genuinely needed even when there is no
     printer.  */
  if (! pfile->printer)
    return;
  /* Flush first (temporary).  */
  cpp_output_tokens (pfile, pfile->printer, pfile->token_list.line);
  _cpp_dump_list (pfile, &pfile->token_list, pfile->first_directive_token, 1);
}

static cpp_hashnode *
get_define_node (pfile)
     cpp_reader *pfile;
{
  cpp_hashnode *node;
  const cpp_token *token;
  const U_CHAR *sym;
  unsigned int len;

  /* Skip any -C comments.  */
  while ((token = cpp_get_token (pfile))->type == CPP_COMMENT)
    ;

  if (token->type != CPP_NAME)
    {
      cpp_error_with_line (pfile, pfile->token_list.line, token->col,
                           "macro names must be identifiers");
      return 0;
    }

  /* That identifier is not allowed to be "defined".  See predefined
     macro names (6.10.8.4).  */
  len = token->val.name.len;
  sym = token->val.name.text;
  if (str_match (sym, len, "defined"))
    {
      cpp_error_with_line (pfile, pfile->token_list.line, token->col,
                           "\"defined\" is not a legal macro name");
      return 0;
    }

  node = cpp_lookup (pfile, sym, len);
  /* Check for poisoned identifiers now.  */
  if (node->type == T_POISON)
    {
      cpp_error (pfile, "attempt to use poisoned \"%.*s\"", (int) len, sym);
      return 0;
    }

  return node;
}

/* Process a #define command.  */
static int
do_define (pfile)
     cpp_reader *pfile;
{
  cpp_hashnode *node;

  if ((node = get_define_node (pfile)))
    if (_cpp_create_definition (pfile, node))
      {
        if (CPP_OPTION (pfile, debug_output)
            || CPP_OPTION (pfile, dump_macros) == dump_definitions)
          _cpp_dump_definition (pfile, node);
        else if (CPP_OPTION (pfile, dump_macros) == dump_names)
          dump_macro_name (pfile, node);
      }
  return 0;
}

/* Remove the definition of a symbol from the symbol table.  */
static int
do_undef (pfile)
     cpp_reader *pfile;
{
  cpp_hashnode *node = get_define_node (pfile);  

  if (cpp_get_token (pfile)->type != CPP_EOF)
    cpp_pedwarn (pfile, "junk on line after #undef");

  /* 6.10.3.5 paragraph 2: [#undef] is ignored if the specified identifier
     is not currently defined as a macro name.  */
  if (node && node->type != T_VOID)
    {
      /* If we are generating additional info for debugging (with -g) we
         need to pass through all effective #undef commands.  */
      if (CPP_OPTION (pfile, debug_output)
          || CPP_OPTION (pfile, dump_macros) == dump_definitions
          || CPP_OPTION (pfile, dump_macros) == dump_names)
        pass_thru_directive (pfile);

      if (node->type != T_MACRO)
        cpp_warning (pfile, "undefining \"%s\"", node->name);

      _cpp_free_definition (node);
      node->type = T_VOID;
    }

  return 0;
}


/* Handle #include and #import.  */

static int
parse_include (pfile, dir, trail, strp, lenp, abp)
     cpp_reader *pfile;
     const U_CHAR *dir;
     int trail;
     const U_CHAR **strp;
     unsigned int *lenp;
     int *abp;
{
  const cpp_token *name = cpp_get_token (pfile);

  if (name->type != CPP_STRING && name->type != CPP_HEADER_NAME)
    {
      if (name->type == CPP_LESS)
        name = _cpp_glue_header_name (pfile);
      else
        {
          cpp_error (pfile, "#%s expects \"FILENAME\" or <FILENAME>", dir);
          return 1;
        }
    }
  if (name->val.name.len == 0)
    {
      cpp_error (pfile, "empty file name in #%s", dir);
      return 1;
    }

  if (!trail && cpp_get_token (pfile)->type != CPP_EOF)
    cpp_error (pfile, "junk at end of #%s", dir);

  *lenp = name->val.name.len;
  *strp = name->val.name.text;
  *abp = (name->type == CPP_HEADER_NAME);
  return 0;
}

static int
do_include (pfile)
     cpp_reader *pfile;
{
  unsigned int len;
  const U_CHAR *str;
  int ab;

  if (parse_include (pfile, dtable[T_INCLUDE].name, 0, &str, &len, &ab))
    return 0;

  _cpp_execute_include (pfile, str, len, 0, 0, ab);
  if (CPP_OPTION (pfile, dump_includes))
    pass_thru_directive (pfile);
  return 0;
}

static int
do_import (pfile)
     cpp_reader *pfile;
{
  unsigned int len;
  const U_CHAR *str;
  int ab;

  if (CPP_OPTION (pfile, warn_import)
      && !CPP_IN_SYSTEM_HEADER (pfile) && !pfile->import_warning)
    {
      pfile->import_warning = 1;
      cpp_warning (pfile,
           "#import is obsolete, use an #ifndef wrapper in the header file");
    }

  if (parse_include (pfile, dtable[T_IMPORT].name, 0, &str, &len, &ab))
    return 0;

  _cpp_execute_include (pfile, str, len, 1, 0, ab);
  if (CPP_OPTION (pfile, dump_includes))
    pass_thru_directive (pfile);
  return 0;
}

static int
do_include_next (pfile)
     cpp_reader *pfile;
{
  unsigned int len;
  const U_CHAR *str;
  struct file_name_list *search_start = 0;
  int ab;

  if (parse_include (pfile, dtable[T_INCLUDE_NEXT].name, 0, &str, &len, &ab))
    return 0;

  /* For #include_next, skip in the search path past the dir in which
     the current file was found.  If this is the last directory in the
     search path, don't include anything.  If the current file was
     specified with an absolute path, use the normal search logic.  If
     this is the primary source file, use the normal search logic and
     generate a warning.  */
  if (CPP_PREV_BUFFER (CPP_BUFFER (pfile)))
    {
      if (CPP_BUFFER (pfile)->inc->foundhere)
        {
          search_start = CPP_BUFFER (pfile)->inc->foundhere->next;
          if (!search_start)
            return 0;
        }
    }
  else
    cpp_warning (pfile, "#include_next in primary source file");

  _cpp_execute_include (pfile, str, len, 0, search_start, ab);
  if (CPP_OPTION (pfile, dump_includes))
    pass_thru_directive (pfile);

  return 0;
}

/* Subroutine of do_line.  Read next token from PFILE without adding it to
   the output buffer.  If it is a number between 1 and 4, store it in *NUM
   and return 1; otherwise, return 0 and complain if we aren't at the end
   of the directive.  */

static int
read_line_number (pfile, num)
     cpp_reader *pfile;
     int *num;
{
  const cpp_token *tok = cpp_get_token (pfile);
  enum cpp_ttype type = tok->type;
  const U_CHAR *p = tok->val.name.text;
  unsigned int len = tok->val.name.len;

  if (type == CPP_NUMBER && len == 1 && p[0] >= '1' && p[0] <= '4')
    {
      *num = p[0] - '0';
      return 1;
    }
  else
    {
      if (type != CPP_EOF)
        cpp_error (pfile, "invalid format #line");
      return 0;
    }
}

/* Another subroutine of do_line.  Convert a number in STR, of length
   LEN, to binary; store it in NUMP, and return 0 if the number was
   legal, 1 if not.  Temporary, hopefully.  */
static int
strtoul_for_line (str, len, nump)
     const U_CHAR *str;
     unsigned int len;
     unsigned long *nump;
{
  unsigned long reg = 0;
  U_CHAR c;
  while (len--)
    {
      c = *str++;
      if (!ISDIGIT (c))
        return 1;
      reg *= 10;
      reg += c - '0';
    }
  *nump = reg;
  return 0;
}

/* Interpret #line command.
   Note that the filename string (if any) is treated as if it were an
   include filename.  That means no escape handling.  */

static int
do_line (pfile)
     cpp_reader *pfile;
{
  cpp_buffer *ip = CPP_BUFFER (pfile);
  unsigned long new_lineno, old_lineno;
  /* C99 raised the minimum limit on #line numbers.  */
  unsigned int cap = CPP_OPTION (pfile, c99) ? 2147483647 : 32767;
  int action_number = 0;
  enum cpp_ttype type;
  const U_CHAR *str;
  char *fname;
  unsigned int len;
  const cpp_token *tok;

  tok = cpp_get_token (pfile);
  type = tok->type;
  str = tok->val.name.text;
  len = tok->val.name.len;

  if (type != CPP_NUMBER || strtoul_for_line (str, len, &new_lineno))
    {
      cpp_error (pfile, "token after #line is not a positive integer");
      goto done;
    }      

  if (CPP_PEDANTIC (pfile) && (new_lineno == 0 || new_lineno > cap))
    cpp_pedwarn (pfile, "line number out of range");

  old_lineno = ip->lineno;
  ip->lineno = new_lineno;
  tok = cpp_get_token (pfile);
  type = tok->type;
  str = tok->val.name.text;
  len = tok->val.name.len;

  if (type == CPP_EOF)
    goto done;
  else if (type != CPP_STRING)
    {
      cpp_error (pfile, "second token after #line is not a string");
      ip->lineno = old_lineno;  /* malformed #line should have no effect */
      goto done;
    }

  fname = alloca (len + 1);
  memcpy (fname, str, len);
  fname[len] = '\0';
    
  if (strcmp (fname, ip->nominal_fname))
    {
      if (!strcmp (fname, ip->inc->name))
        ip->nominal_fname = ip->inc->name;
      else
        ip->nominal_fname = _cpp_fake_include (pfile, fname);
    }

  if (read_line_number (pfile, &action_number) == 0)
    return 0;

  if (CPP_PEDANTIC (pfile))
    cpp_pedwarn (pfile, "garbage at end of #line");

  /* This is somewhat questionable: change the buffer stack
     depth so that output_line_command thinks we've stacked
     another buffer. */
  if (action_number == 1)
    {
      pfile->buffer_stack_depth++;
      cpp_make_system_header (pfile, ip, 0);
      read_line_number (pfile, &action_number);
    }
  else if (action_number == 2)
    {
      pfile->buffer_stack_depth--;
      cpp_make_system_header (pfile, ip, 0);
      read_line_number (pfile, &action_number);
    }
  if (action_number == 3)
    {
      cpp_make_system_header (pfile, ip, 1);
      read_line_number (pfile, &action_number);
    }
  if (action_number == 4)
    {
      cpp_make_system_header (pfile, ip, 2);
      read_line_number (pfile, &action_number);
    }
   return 0;

 done:
  return 0;
}

/*
 * Report an error detected by the program we are processing.
 * Use the text of the line in the error message.
 * (We use error because it prints the filename & line#.)
 */

static int
do_error (pfile)
     cpp_reader *pfile;
{
  U_CHAR *text, *limit;

  text = pfile->limit;
  _cpp_dump_list (pfile, &pfile->token_list, pfile->first_directive_token, 0);
  limit = pfile->limit;
  pfile->limit = text;
  cpp_error (pfile, "%.*s", (int)(limit - text), text);

  return 0;
}

/*
 * Report a warning detected by the program we are processing.
 * Use the text of the line in the warning message, then continue.
 */

static int
do_warning (pfile)
     cpp_reader *pfile;
{
  U_CHAR *text, *limit;

  text = pfile->limit;
  _cpp_dump_list (pfile, &pfile->token_list, pfile->first_directive_token, 0);
  limit = pfile->limit;
  pfile->limit = text;
  cpp_warning (pfile, "%.*s", (int)(limit - text), text);
  return 0;
}

/* Report program identification.  */

static int
do_ident (pfile)
     cpp_reader *pfile;
{
  /* Next token should be a string constant.  */
  if (cpp_get_token (pfile)->type == CPP_STRING)
    /* And then a newline.  */
    if (cpp_get_token (pfile)->type == CPP_EOF)
      {
        /* Good - ship it.  */
        pass_thru_directive (pfile);
        return 0;
      }

  cpp_error (pfile, "invalid #ident");
  return 0;
}

/* Pragmata handling.  We handle some of these, and pass the rest on
   to the front end.  C99 defines three pragmas and says that no macro
   expansion is to be performed on them; whether or not macro
   expansion happens for other pragmas is implementation defined.
   This implementation never macro-expands the text after #pragma.

   We currently do not support the _Pragma operator.  Support for that
   has to be coordinated with the front end.  Proposed implementation:
   both #pragma blah blah and _Pragma("blah blah") become
   __builtin_pragma(blah blah) and we teach the parser about that.  */

/* Sub-handlers for the pragmas needing treatment here.
   They return 1 if the token buffer is to be popped, 0 if not. */
struct pragma_entry
{
  const char *name;
  int (*handler) PARAMS ((cpp_reader *));
};

static int pragma_dispatch             
    PARAMS ((cpp_reader *, const struct pragma_entry *,
             const U_CHAR *, size_t));
static int do_pragma_once               PARAMS ((cpp_reader *));
static int do_pragma_implementation     PARAMS ((cpp_reader *));
static int do_pragma_poison             PARAMS ((cpp_reader *));
static int do_pragma_system_header      PARAMS ((cpp_reader *));
static int do_pragma_gcc                PARAMS ((cpp_reader *));
static int do_pragma_dependency         PARAMS ((cpp_reader *));

static const struct pragma_entry top_pragmas[] =
{
  {"once", do_pragma_once},
  {"implementation", do_pragma_implementation},
  {"poison", do_pragma_poison},
  {"GCC", do_pragma_gcc},
  {NULL, NULL}
};

static const struct pragma_entry gcc_pragmas[] =
{
  {"implementation", do_pragma_implementation},
  {"poison", do_pragma_poison},
  {"system_header", do_pragma_system_header},
  {"dependency", do_pragma_dependency},
  {NULL, NULL}
};

static int pragma_dispatch (pfile, table, p, len)
     cpp_reader *pfile;
     const struct pragma_entry *table;
     const U_CHAR *p;
     size_t len;
{
  for (; table->name; table++)
    if (strlen (table->name) == len && !memcmp (p, table->name, len))
      return (*table->handler) (pfile);
  return 0;
}

static int
do_pragma (pfile)
     cpp_reader *pfile;
{
  const cpp_token *tok;
  int pop;

  tok = cpp_get_token (pfile);
  if (tok->type == CPP_EOF)
    return 0;
  else if (tok->type != CPP_NAME)
    {
      cpp_error (pfile, "malformed #pragma directive");
      return 0;
    }

  pop = pragma_dispatch (pfile, top_pragmas,
                         tok->val.name.text, tok->val.name.len);
  if (!pop)
    pass_thru_directive (pfile);
  return 0;
}

static int
do_pragma_gcc (pfile)
     cpp_reader *pfile;
{
  const cpp_token *tok;

  tok = cpp_get_token (pfile);
  if (tok->type == CPP_EOF)
    return 1;
  else if (tok->type != CPP_NAME)
    return 0;
  
  return pragma_dispatch (pfile, gcc_pragmas,
                          tok->val.name.text, tok->val.name.len);
}

static int
do_pragma_once (pfile)
     cpp_reader *pfile;
{
  cpp_buffer *ip = CPP_BUFFER (pfile);

  /* Allow #pragma once in system headers, since that's not the user's
     fault.  */
  if (!CPP_IN_SYSTEM_HEADER (pfile))
    cpp_warning (pfile, "#pragma once is obsolete");
      
  if (CPP_PREV_BUFFER (ip) == NULL)
    cpp_warning (pfile, "#pragma once outside include file");
  else
    ip->inc->cmacro = NEVER_REREAD;

  return 1;
}

static int
do_pragma_implementation (pfile)
     cpp_reader *pfile;
{
  /* Be quiet about `#pragma implementation' for a file only if it hasn't
     been included yet.  */
  const cpp_token *tok = cpp_get_token (pfile);
  char *copy;

  if (tok->type == CPP_EOF)
    return 0;
  else if (tok->type != CPP_STRING
           || cpp_get_token (pfile)->type != CPP_EOF)
    {
      cpp_error (pfile, "malformed #pragma implementation");
      return 1;
    }

  /* Make a NUL-terminated copy of the string.  */
  copy = alloca (tok->val.name.len + 1);
  memcpy (copy, tok->val.name.text, tok->val.name.len);
  copy[tok->val.name.len] = '\0';
  
  if (cpp_included (pfile, copy))
    cpp_warning (pfile,
         "#pragma implementation for %s appears after file is included",
                 copy);
  return 0;
}

static int
do_pragma_poison (pfile)
     cpp_reader *pfile;
{
  /* Poison these symbols so that all subsequent usage produces an
     error message.  */
  const cpp_token *tok;
  cpp_hashnode *hp;
  int writeit;

  /* As a rule, don't include #pragma poison commands in output,  
     unless the user asks for them.  */
  writeit = (CPP_OPTION (pfile, debug_output)
             || CPP_OPTION (pfile, dump_macros) == dump_definitions
             || CPP_OPTION (pfile, dump_macros) == dump_names);

  for (;;)
    {
      tok = cpp_get_token (pfile);
      if (tok->type == CPP_EOF)
        break;
      if (tok->type != CPP_NAME)
        {
          cpp_error (pfile, "invalid #pragma poison directive");
          return 1;
        }

      hp = cpp_lookup (pfile, tok->val.name.text, tok->val.name.len);
      if (hp->type == T_POISON)
        ;  /* It is allowed to poison the same identifier twice.  */
      else
        {
          if (hp->type != T_VOID)
            cpp_warning (pfile, "poisoning existing macro \"%s\"", hp->name);
          _cpp_free_definition (hp);
          hp->type = T_POISON;
        }
    }
  return !writeit;
}

/* Mark the current header as a system header.  This will suppress
   some categories of warnings (notably those from -pedantic).  It is
   intended for use in system libraries that cannot be implemented in
   conforming C, but cannot be certain that their headers appear in a
   system include directory.  To prevent abuse, it is rejected in the
   primary source file.  */
static int
do_pragma_system_header (pfile)
     cpp_reader *pfile;
{
  cpp_buffer *ip = CPP_BUFFER (pfile);
  if (CPP_PREV_BUFFER (ip) == NULL)
    cpp_warning (pfile, "#pragma system_header outside include file");
  else
    cpp_make_system_header (pfile, ip, 1);

  return 1;
}

/* Check the modified date of the current include file against a specified
   file. Issue a diagnostic, if the specified file is newer. We use this to
   determine if a fixed header should be refixed.  */
static int
do_pragma_dependency (pfile)
     cpp_reader *pfile;
{
  const U_CHAR *name;
  unsigned int len;
  int ordering, ab;
  char left, right;
 
  if (parse_include (pfile, U"pragma dependency", 1, &name, &len, &ab))
    return 1;

  left = ab ? '<' : '"';
  right = ab ? '>' : '"';
 
  ordering = _cpp_compare_file_date (pfile, name, len, ab);
  if (ordering < 0)
    cpp_warning (pfile, "cannot find source %c%s%c", left, name, right);
  else if (ordering > 0)
    {
      const cpp_token *msg = cpp_get_token (pfile);
      
      cpp_warning (pfile, "current file is older than %c%s%c",
                   left, name, right);
      if (msg->type != CPP_EOF)
        {
          U_CHAR *text, *limit;

          text = pfile->limit;
          _cpp_dump_list (pfile, &pfile->token_list, msg, 0);
          limit = pfile->limit;
          pfile->limit = text;
          cpp_warning (pfile, "%.*s", (int)(limit - text), text);
        }
    }
  return 1;
}

/* Just ignore #sccs, on systems where we define it at all.  */
#ifdef SCCS_DIRECTIVE
static int
do_sccs (pfile)
     cpp_reader *pfile ATTRIBUTE_UNUSED;
{
  return 0;
}
#endif

/* We've found an `#if' directive.  If the only thing before it in
   this file is white space, and if it is of the form
   `#if ! defined SYMBOL', then SYMBOL is a possible controlling macro
   for inclusion of this file.  (See redundant_include_p in cppfiles.c
   for an explanation of controlling macros.)  If so, return the
   hash node for SYMBOL.  Otherwise, return NULL.  */

static const cpp_hashnode *
detect_if_not_defined (pfile)
     cpp_reader *pfile;
{
  const cpp_token *token;
  cpp_hashnode *cmacro = 0;

  /* We are guaranteed that tokens are consecutive and end in CPP_EOF.  */
  token = pfile->first_directive_token + 2;

  if (token->type != CPP_NOT)
    return 0;

  token++;
  if (token->type != CPP_NAME
      || !str_match (token->val.name.text, token->val.name.len, "defined"))
    return 0;

  token++;
  if (token->type == CPP_OPEN_PAREN)
    token++;

  if (token->type != CPP_NAME)
    return 0;

  cmacro = cpp_lookup (pfile, token->val.name.text, token->val.name.len);

  if (token[-1].type == CPP_OPEN_PAREN)
    {
      token++;
      if (token->type != CPP_CLOSE_PAREN)
        return 0;
    }

  token++;
  if (token->type != CPP_EOF)
    return 0;

  return cmacro;
}

/* Parse an #ifdef or #ifndef directive.  Returns the hash node of the
   macro being tested, and issues various error messages.  */

static const cpp_hashnode *
parse_ifdef (pfile, name)
     cpp_reader *pfile;
     const U_CHAR *name;
{
  const U_CHAR *ident;
  unsigned int len;
  enum cpp_ttype type;
  const cpp_hashnode *node = 0;

  const cpp_token *token = cpp_get_token (pfile);
  type = token->type;
  ident = token->val.name.text;
  len = token->val.name.len;

  if (!CPP_TRADITIONAL (pfile))
    {
      if (type == CPP_EOF)
        cpp_pedwarn (pfile, "#%s with no argument", name);
      else if (type != CPP_NAME)
        cpp_pedwarn (pfile, "#%s with invalid argument", name);
      else if (cpp_get_token (pfile)->type != CPP_EOF)
        cpp_pedwarn (pfile, "garbage at end of #%s", name);
    }

  if (type == CPP_NAME)
    node = cpp_lookup (pfile, ident, len);
  if (node && node->type == T_POISON)
    cpp_error (pfile, "attempt to use poisoned identifier \"%s\"", node->name);
    
  return node;
}

/* #ifdef is dead simple.  */

static int
do_ifdef (pfile)
     cpp_reader *pfile;
{
  int def = 0;
  const cpp_hashnode *node = 0;

  if (! pfile->skipping)
    {
      node = parse_ifdef (pfile, dtable[T_IFDEF].name);
      if (node)
        def = (node->type != T_VOID && node->type != T_POISON);
    }

  push_conditional (pfile, !def, T_IFDEF, 0);
  return 0;
}

/* #ifndef is a tad more complex, because we need to check for a
   no-reinclusion wrapper.  */

static int
do_ifndef (pfile)
     cpp_reader *pfile;
{
  int start_of_file = 0;
  int def = 0;
  const cpp_hashnode *cmacro = 0;

  if (! pfile->skipping)
    {
      start_of_file = (pfile->token_list.flags & BEG_OF_FILE);
      cmacro = parse_ifdef (pfile, dtable[T_IFNDEF].name);
      if (cmacro)
        def = cmacro->type != T_VOID;
    }

  push_conditional (pfile, def, T_IFNDEF, start_of_file ? cmacro : 0);
  return 0;
}

/* #if is straightforward; just call _cpp_parse_expr, then conditional_skip.
   Also, check for a reinclude preventer of the form #if !defined (MACRO).  */

static int
do_if (pfile)
     cpp_reader *pfile;
{
  const cpp_hashnode *cmacro = 0;
  int value = 0;

  if (! pfile->skipping)
    {
      cmacro = detect_if_not_defined (pfile);  
      value = _cpp_parse_expr (pfile);
    }
  push_conditional (pfile, value == 0, T_IF, cmacro);
  return 0;
}

/* #else flips pfile->skipping and continues without changing
   if_stack; this is so that the error message for missing #endif's
   etc. will point to the original #if.  */

static int
do_else (pfile)
     cpp_reader *pfile;
{
  struct if_stack *ifs = CPP_BUFFER (pfile)->if_stack;
  validate_else (pfile, dtable[T_ELSE].name);

  if (ifs == NULL)
    {
      cpp_error (pfile, "#else without #if");
      return 0;
    }
  if (ifs->type == T_ELSE)
    {
      cpp_error (pfile, "#else after #else");
      cpp_error_with_line (pfile, ifs->lineno, ifs->colno,
                           "the conditional began here");
    }

  /* #ifndef can't have its special treatment for containing the whole file
     if it has a #else clause.  */
  ifs->cmacro = 0;
  ifs->type = T_ELSE;
  if (! ifs->was_skipping)
    {
      /* If pfile->skipping is 2, one of the blocks in an #if/#elif/... chain
         succeeded, so we mustn't do the else block.  */
      if (pfile->skipping < 2)
        pfile->skipping = ! pfile->skipping;
    }
  return 0;
}

/*
 * handle a #elif directive by not changing if_stack either.
 * see the comment above do_else.
 */

static int
do_elif (pfile)
     cpp_reader *pfile;
{
  struct if_stack *ifs = CPP_BUFFER (pfile)->if_stack;

  if (ifs == NULL)
    {
      cpp_error (pfile, "#elif without #if");
      return 0;
    }
  if (ifs->type == T_ELSE)
    {
      cpp_error (pfile, "#elif after #else");
      cpp_error_with_line (pfile, ifs->lineno, ifs->colno,
                           "the conditional began here");
    }

  ifs->type = T_ELIF;
  if (ifs->was_skipping)
    return 0;  /* Don't evaluate a nested #if */

  if (pfile->skipping != 1)
    {
      pfile->skipping = 2;  /* one block succeeded, so don't do any others */
      return 0;
    }

  pfile->skipping = ! _cpp_parse_expr (pfile);
  return 0;
}

/* #endif pops the if stack and resets pfile->skipping.  */

static int
do_endif (pfile)
     cpp_reader *pfile;
{
  struct if_stack *ifs = CPP_BUFFER (pfile)->if_stack;

  validate_else (pfile, dtable[T_ENDIF].name);

  if (ifs == NULL)
    cpp_error (pfile, "#endif without #if");
  else
    {
      CPP_BUFFER (pfile)->if_stack = ifs->next;
      pfile->skipping = ifs->was_skipping;
      pfile->potential_control_macro = ifs->cmacro;
      obstack_free (pfile->buffer_ob, ifs);
    }
  return 0;
}


/* Push an if_stack entry and set pfile->skipping accordingly.
   If this is a #ifndef starting at the beginning of a file,
   CMACRO is the macro name tested by the #ifndef.  */

static void
push_conditional (pfile, skip, type, cmacro)
     cpp_reader *pfile;
     int skip;
     int type;
     const cpp_hashnode *cmacro;
{
  struct if_stack *ifs;

  ifs = xobnew (pfile->buffer_ob, struct if_stack);
  ifs->lineno = _cpp_get_line (pfile, &ifs->colno);
  ifs->next = CPP_BUFFER (pfile)->if_stack;
  ifs->cmacro = cmacro;
  ifs->was_skipping = pfile->skipping;
  ifs->type = type;

  if (!pfile->skipping)
    pfile->skipping = skip;

  CPP_BUFFER (pfile)->if_stack = ifs;
}

/* Issue -pedantic warning for text which is not a comment following
   an #else or #endif.  */

static void
validate_else (pfile, directive)
     cpp_reader *pfile;
     const U_CHAR *directive;
{
  if (CPP_PEDANTIC (pfile) && cpp_get_token (pfile)->type != CPP_EOF)
    cpp_pedwarn (pfile, "ISO C forbids text after #%s", directive);
}

/* Called when we reach the end of a file.  Walk back up the
   conditional stack till we reach its level at entry to this file,
   issuing error messages.  Then force skipping off.  */
static void
unwind_if_stack (pfile, pbuf)
     cpp_reader *pfile;
     cpp_buffer *pbuf;
{
  struct if_stack *ifs, *nifs;

  for (ifs = pbuf->if_stack; ifs; ifs = nifs)
    {
      cpp_error_with_line (pfile, ifs->lineno, ifs->colno, "unterminated #%s",
                           dtable[ifs->type].name);
      nifs = ifs->next;
      /* No need to free - they'll all go away with the buffer.  */
    }
  pfile->skipping = 0;
}

/* Parses an assertion, returning a pointer to the hash node of the
   predicate, or 0 on error.  If an answer was supplied, it is
   allocated and placed in ANSWERP, otherwise it is set to 0.  We use
   _cpp_get_raw_token, since we cannot assume tokens are consecutive
   in a #if statement (we may be in a macro), and we don't want to
   macro expand.  */
cpp_hashnode *
_cpp_parse_assertion (pfile, answerp)
     cpp_reader *pfile;
     struct answer **answerp;
{
  struct answer *answer = 0;
  cpp_toklist *list;
  U_CHAR *sym;
  const cpp_token *token, *predicate;
  const struct directive *d = pfile->token_list.directive;
  unsigned int len = 0;

  predicate = _cpp_get_raw_token (pfile);
  if (predicate->type == CPP_EOF)
    {
      cpp_error (pfile, "assertion without predicate");
      return 0;
    }
  else if (predicate->type != CPP_NAME)
    {
      cpp_error (pfile, "predicate must be an identifier");
      return 0;
    }

  token = _cpp_get_raw_token (pfile);
  if (token->type != CPP_OPEN_PAREN)
    {
      /* #unassert and #if are OK without predicate.  */
      if (d == &dtable[T_UNASSERT])
        {
          if (token->type == CPP_EOF)
            goto lookup_node;
        }
      else if (d != &dtable[T_ASSERT])
        {
          _cpp_push_token (pfile, token);
          goto lookup_node;
        }
      cpp_error (pfile, "missing '(' after predicate");
      return 0;
    }

  /* Allocate a struct answer, and copy the answer to it.  */
  answer = (struct answer *) xmalloc (sizeof (struct answer));
  list = &answer->list;
  _cpp_init_toklist (list, NO_DUMMY_TOKEN);

  for (;;)
    {
      cpp_token *dest;

      token = _cpp_get_raw_token (pfile);

      if (token->type == CPP_EOF)
        {
          cpp_error (pfile, "missing ')' to complete answer");
          goto error;
        }
      if (token->type == CPP_CLOSE_PAREN)
        break;

      /* Copy the token.  */
      _cpp_expand_token_space (list, 1);
      dest = &list->tokens[list->tokens_used++];
      *dest = *token;

      if (token_spellings[token->type].type > SPELL_NONE)
        {
          _cpp_expand_name_space (list, token->val.name.len);
          dest->val.name.text = list->namebuf + list->name_used;
          memcpy (list->namebuf + list->name_used,
                  token->val.name.text, token->val.name.len);
          list->name_used += token->val.name.len;
        }
    }

  if (list->tokens_used == 0)
    {
      cpp_error (pfile, "predicate's answer is empty");
      goto error;
    }

  /* Drop whitespace at start.  */
  list->tokens[0].flags &= ~PREV_WHITE;

  if ((d == &dtable[T_ASSERT] || d == &dtable[T_UNASSERT])
      && token[1].type != CPP_EOF)
    {
      cpp_error (pfile, "junk at end of assertion");
      goto error;
    }

 lookup_node:
  *answerp = answer;
  len = predicate->val.name.len;
  sym = alloca (len + 1);

  /* Prefix '#' to get it out of macro namespace.  */
  sym[0] = '#';
  memcpy (sym + 1, predicate->val.name.text, len);
  return cpp_lookup (pfile, sym, len + 1);

 error:
  FREE_ANSWER (answer);
  return 0;
}

/* Returns a pointer to the pointer to the answer in the answer chain,
   or a pointer to NULL if the answer is not in the chain.  */
struct answer **
_cpp_find_answer (node, candidate)
     cpp_hashnode *node;
     const cpp_toklist *candidate;
{
  struct answer **result;

  for (result = &node->value.answers; *result; result = &(*result)->next)
    if (_cpp_equiv_toklists (&(*result)->list, candidate))
      break;

  return result;
}

#define WARNING(msgid) do { cpp_warning(pfile, msgid); goto error; } while (0)
#define ERROR(msgid) do { cpp_error(pfile, msgid); goto error; } while (0)
#define ICE(msgid) do { cpp_ice(pfile, msgid); goto error; } while (0)
static int
do_assert (pfile)
     cpp_reader *pfile;
{
  struct answer *new_answer;
  cpp_hashnode *node;
  
  node = _cpp_parse_assertion (pfile, &new_answer);
  if (node)
    {
      new_answer->next = 0;
      new_answer->list.line = pfile->token_list.line;
      new_answer->list.file = pfile->token_list.file;

      if (node->type == T_ASSERTION)
        {
          if (*_cpp_find_answer (node, &new_answer->list))
            goto err;
          new_answer->next = node->value.answers;
        }
      node->type = T_ASSERTION;
      node->value.answers = new_answer;
    }
  return 0;

 err:
  cpp_warning (pfile, "\"%.*s\" re-asserted",
               node->length - 1, node->name + 1);
  FREE_ANSWER (new_answer);
  return 0;
}

static int
do_unassert (pfile)
     cpp_reader *pfile;
{
  cpp_hashnode *node;
  struct answer *answer, *temp, *next;
  
  node = _cpp_parse_assertion (pfile, &answer);
  if (node)
    {
      /* It isn't an error to #unassert something that isn't asserted.  */
      if (node->type == T_ASSERTION)
        {
          if (answer)
            {
              struct answer **p = _cpp_find_answer (node, &answer->list);

              temp = *p;
              if (temp)
                {
                  *p = temp->next;
                  FREE_ANSWER (temp);
                }
              if (node->value.answers == 0)
                node->type = T_VOID;
            }
          else
            {
              for (temp = node->value.answers; temp; temp = next)
                {
                  next = temp->next;
                  FREE_ANSWER (temp);
                }
              node->type = T_VOID;
            }
        }

      if (answer)
        FREE_ANSWER (answer);
    }
  return 0;
}

/* These are for -D, -U, -A.  */

/* Process the string STR as if it appeared as the body of a #define.
   If STR is just an identifier, define it with value 1.
   If STR has anything after the identifier, then it should
   be identifier=definition. */

void
cpp_define (pfile, str)
     cpp_reader *pfile;
     const char *str;
{
  char *buf, *p;
  size_t count;

  p = strchr (str, '=');
  /* Copy the entire option so we can modify it. 
     Change the first "=" in the string to a space.  If there is none,
     tack " 1" on the end.  Then add a newline and a NUL.  */
  
  if (p)
    {
      count = strlen (str) + 2;
      buf = (char *) alloca (count);
      memcpy (buf, str, count - 2);
      buf[p - str] = ' ';
      buf[count - 2] = '\n';
      buf[count - 1] = '\0';
    }
  else
    {
      count = strlen (str) + 4;
      buf = (char *) alloca (count);
      memcpy (buf, str, count - 4);
      strcpy (&buf[count-4], " 1\n");
    }

  _cpp_run_directive (pfile, &dtable[T_DEFINE], buf, count - 1);
}

/* Process MACRO as if it appeared as the body of an #undef.  */
void
cpp_undef (pfile, macro)
     cpp_reader *pfile;
     const char *macro;
{
  _cpp_run_directive (pfile, &dtable[T_UNDEF], macro, strlen (macro));
}

/* Process the string STR as if it appeared as the body of a #assert. */
void
cpp_assert (pfile, str)
     cpp_reader *pfile;
     const char *str;
{
  _cpp_run_directive (pfile, &dtable[T_ASSERT], str, strlen (str));
}

/* Process STR as if it appeared as the body of an #unassert. */
void
cpp_unassert (pfile, str)
     cpp_reader *pfile;
     const char *str;
{
  _cpp_run_directive (pfile, &dtable[T_UNASSERT], str, strlen (str));
}  

/* Determine whether the identifier ID, of length LEN, is a defined macro.  */
int
cpp_defined (pfile, id, len)
     cpp_reader *pfile;
     const U_CHAR *id;
     int len;
{
  cpp_hashnode *hp = cpp_lookup (pfile, id, len);
  if (hp->type == T_POISON)
    {
      cpp_error (pfile, "attempt to use poisoned \"%s\"", hp->name);
      return 0;
    }
  return (hp->type != T_VOID);
}

/* Allocate a new cpp_buffer for PFILE, and push it on the input buffer stack.
   If BUFFER != NULL, then use the LENGTH characters in BUFFER
   as the new input buffer.
   Return the new buffer, or NULL on failure.  */

cpp_buffer *
cpp_push_buffer (pfile, buffer, length)
     cpp_reader *pfile;
     const U_CHAR *buffer;
     long length;
{
  cpp_buffer *buf = CPP_BUFFER (pfile);
  cpp_buffer *new;
  if (++pfile->buffer_stack_depth == CPP_STACK_MAX)
    {
      cpp_fatal (pfile, "#include recursion too deep");
      return NULL;
    }

  new = xobnew (pfile->buffer_ob, cpp_buffer);
  memset (new, 0, sizeof (cpp_buffer));

  new->buf = new->cur = buffer;
  new->rlimit = buffer + length;
  new->prev = buf;

  CPP_BUFFER (pfile) = new;
  return new;
}

cpp_buffer *
cpp_pop_buffer (pfile)
     cpp_reader *pfile;
{
  cpp_buffer *buf = CPP_BUFFER (pfile);

  unwind_if_stack (pfile, buf);
#ifdef HAVE_MMAP_FILE
  if (buf->mapped)
    munmap ((caddr_t) buf->buf, buf->rlimit - buf->buf);
  else
#endif
    if (buf->inc)
      free ((PTR) buf->buf);

  if (buf->inc)
    {
      if (pfile->system_include_depth)
        pfile->system_include_depth--;
      if (pfile->include_depth)
        pfile->include_depth--;
      if (pfile->potential_control_macro)
        {
          if (buf->inc->cmacro != NEVER_REREAD)
            buf->inc->cmacro = pfile->potential_control_macro;
          pfile->potential_control_macro = 0;
        }
      pfile->input_stack_listing_current = 0;
      /* If the file will not be included again, then close it.  */
      if (DO_NOT_REREAD (buf->inc))
        {
          close (buf->inc->fd);
          buf->inc->fd = -1;
        }
    }

  CPP_BUFFER (pfile) = CPP_PREV_BUFFER (buf);
  obstack_free (pfile->buffer_ob, buf);
  pfile->buffer_stack_depth--;
  return CPP_BUFFER (pfile);
}

#define obstack_chunk_alloc xmalloc
#define obstack_chunk_free free
void
_cpp_init_stacks (pfile)
     cpp_reader *pfile;
{
  pfile->buffer_ob = xnew (struct obstack);
  obstack_init (pfile->buffer_ob);
}

void
_cpp_cleanup_stacks (pfile)
     cpp_reader *pfile;
{
  obstack_free (pfile->buffer_ob, 0);
  free (pfile->buffer_ob);
}