The R Project SVN R

/*
 *  R : A Computer Language for Statistical Data Analysis
 *  Copyright (C) 1995, 1996  Robert Gentleman and Ross Ihaka
 *  Copyright (C) 1997--2000  The R Development Core Team.
 *
 *  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 of the License, 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, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include "Defn.h"
/* -> Errormsg.h */
#include "Startup.h" /* rather cleanup ..*/

/* limit on call length at which errorcall/warningcall is split over
   two lines */
#define LONGCALL 30

/* This is now non-static so that other applications that link or load libR.so
   can override it by defining their own version and hence by-pass the longjmp
   back into the standard R event loop.
 */
void jump_now();
/*
  Method that resets the global state of the evaluator in the event
  of an error. Was in jump_now(), but is now a separate method so that
  we can call it without invoking the longjmp. This is needed when embedding
  R in other applications.
*/
void Rf_resetStack(int topLevel);

/*
Different values of inError are used to indicate different places
in the error handling.
*/
static int inError = 0;
static int inWarning = 0;

/* Interface / Calling Hierarchy :

  R__stop()   -> do_error ->   errorcall --> jump_to_toplevel --> jump_now
             /
            error

  R__warning()-> do_warning   -> warningcall -> if(warn >= 2) errorcall
                 /
            warning /

  ErrorMessage   : similar to errorcall()   but with message from ErrorDB[]

  WarningMessage : similar to warningcall() but with message from WarningDB[].
*/


void onintr()
{
    REprintf("\n");
    jump_to_toplevel();
}

/* SIGUSR1: save and quit
   SIGUSR2: save and quit, don't run .Last or on.exit().
*/
void onsigusr1()
{
    RCNTXT *c;
    int nback=0;

    inError = 1;

    if( R_CollectWarnings ) {
    inError = 2;
    REprintf("In addition: ");
    PrintWarnings();
    inError = 1;
    }


    if (R_Inputfile != NULL)
    fclose(R_Inputfile);
    R_ResetConsole();
    R_FlushConsole();
    R_ClearerrConsole();
    R_ParseError = 0;
    vmaxset(NULL);
    if (R_GlobalContext->cend != NULL)
    (R_GlobalContext->cend) ();
    for (c = R_GlobalContext; c; c = c->nextcontext) {
    if (c->cloenv != R_NilValue && c->conexit != R_NilValue)
        eval(c->conexit, c->cloenv);
    if (c->callflag == CTXT_RETURN || c->callflag == CTXT_GENERIC )
        nback++;
    if (c->callflag == CTXT_RESTART) {
        inError=0;
        findcontext(CTXT_RESTART, c->cloenv, R_DollarSymbol);
    }
    }
    R_CleanUp(SA_SAVE, 2, 1); /* quit, save,  .Last, status=2 */
}


void onsigusr2()
{
    inError = 1;

    if( R_CollectWarnings ) {
    inError = 2;
    REprintf("In addition: ");
    PrintWarnings();
    inError = 1;
    }


    if (R_Inputfile != NULL)
    fclose(R_Inputfile);
    R_ResetConsole();
    R_FlushConsole();
    R_ClearerrConsole();
    R_ParseError = 0;
    vmaxset(NULL);
    R_CleanUp(SA_SAVE, 0, 0);
}


static void setupwarnings(void)
{
    R_Warnings = allocVector(VECSXP, 50);
    setAttrib(R_Warnings, R_NamesSymbol, allocVector(STRSXP, 50));
}

#define BUFSIZE 8192
void warning(const char *format, ...)
{
    char buf[BUFSIZE], *p;

    va_list(ap);
    va_start(ap, format);
    vsprintf(buf, format, ap);
    va_end(ap);
    p = buf + strlen(buf) - 1;
    if(strlen(buf) > 0 && *p == '\n') *p = '\0';
    warningcall(R_NilValue, buf);
}

void warningcall(SEXP call, char *format, ...)
{
    int w, slen;
    SEXP names, s;
    char *dcall, buf[BUFSIZE];
    RCNTXT *cptr;

    s = GetOption(install("warning.expression"), R_NilValue);
    if( s!= R_NilValue ) {
    if( !isLanguage(s) &&  ! isExpression(s) )
        error("invalid option \"warning.expression\"");
    cptr = R_GlobalContext;
    while ( !(cptr->callflag & CTXT_FUNCTION) && cptr->callflag )
        cptr = cptr->nextcontext;
    eval(s, cptr->cloenv);
    return;
    }

    w = asInteger(GetOption(install("warn"), R_NilValue));

    if( w == NA_INTEGER ) /* set to a sensible value */
    w = 0;

    if(w<0 || inWarning || inError)  {/* ignore if w<0 or already in here*/
    return;
    }
    inWarning = 1;

    if(w>=2) { /* make it an error */
    va_list(ap);
    va_start(ap, format);
    slen = vsprintf(buf, format, ap);
    va_end(ap);
    errorcall(call, "(converted from warning) %s", buf);
    }
    else if(w==1) { /* print as they happen */
    va_list(ap);
    if( call != R_NilValue ) {
        dcall = CHAR(STRING_ELT(deparse1(call, 0), 0));
        REprintf("Warning in %s : ", dcall);
        if (strlen(dcall) > LONGCALL) REprintf("\n   ");
    }
    else
        REprintf("Warning: ");
    va_start(ap, format);
    REvprintf(format, ap);
    va_end(ap);
    REprintf("\n");
    }
    else if(w==0) { /* collect them */
    va_list(ap);
    va_start(ap, format);
    if(!R_CollectWarnings)
        setupwarnings();
    if( R_CollectWarnings > 49 )
        return;
    SET_VECTOR_ELT(R_Warnings, R_CollectWarnings, call);
    slen = vsprintf(buf, format, ap);
    va_end(ap);
    names = CAR(ATTRIB(R_Warnings));
    SET_STRING_ELT(names, R_CollectWarnings++, mkChar(buf));
    }
    /* else:  w <= -1 */
    inWarning = 0;
}

void PrintWarnings(void)
{
    int i;
    SEXP names, s, t;

    inWarning = 1;
    if( R_CollectWarnings == 1 ) {
    REprintf("Warning message: \n");
    names = CAR(ATTRIB(R_Warnings));
    if( VECTOR_ELT(R_Warnings, 0) == R_NilValue )
       REprintf("%s \n", CHAR(STRING_ELT(names, 0)));
    else
       REprintf("%s in: %s \n", CHAR(STRING_ELT(names, 0)),
        CHAR(STRING_ELT(deparse1(VECTOR_ELT(R_Warnings, 0),0), 0)));
    }
    else if( R_CollectWarnings <= 10 ) {
    REprintf("Warning messages: \n");
    names = CAR(ATTRIB(R_Warnings));
    for(i=0; i<R_CollectWarnings; i++) {
        if( STRING_ELT(R_Warnings, i) == R_NilValue )
           REprintf("%d: %s \n",i+1, CHAR(STRING_ELT(names, i)));
        else
           REprintf("%d: %s in: %s \n", i+1, CHAR(STRING_ELT(names, i)),
           CHAR(STRING_ELT(deparse1(VECTOR_ELT(R_Warnings,i), 0), 0)));
    }
    }
    else {
    if (R_CollectWarnings < 50)
        REprintf("There were %d warnings (use warnings() to see them)\n",
             R_CollectWarnings);
    else
        REprintf("There were 50 or more warnings (use warnings() to see the first 50)\n");
    }
    /* now truncate and install last.warning */
    PROTECT(s = allocVector(VECSXP, R_CollectWarnings));
    PROTECT(t = allocVector(STRSXP, R_CollectWarnings));
    names = CAR(ATTRIB(R_Warnings));
    for(i=0; i<R_CollectWarnings; i++) {
    SET_VECTOR_ELT(s, i, VECTOR_ELT(R_Warnings, i));
    SET_VECTOR_ELT(t, i, VECTOR_ELT(names, i));
    }
    setAttrib(s, R_NamesSymbol, t);
    defineVar(install("last.warning"), s, R_GlobalEnv);
    UNPROTECT(2);
    inWarning = 0;
    R_CollectWarnings = 0;
    R_Warnings = R_NilValue;
    return;
}

static char errbuf[BUFSIZE];

void errorcall(SEXP call, char *format,...)
{
    char *p, *dcall;

    va_list(ap);

    if (inError) {
    if(inError == 3)
        REprintf("Error during wrapup \n");
    jump_now();
    }

    if(call != R_NilValue) {
    inError = 1;
    dcall = CHAR(STRING_ELT(deparse1(call, 0), 0));
    sprintf(errbuf, "Error in %s : ", dcall);
    if (strlen(dcall) > LONGCALL) strcat(errbuf, "\n    ");/* <- TAB */
    }
    else
    sprintf(errbuf, "Error: ");

    p = errbuf + strlen(errbuf);
    va_start(ap, format);
    vsprintf(p, format, ap);
    va_end(ap);
    p = errbuf + strlen(errbuf) - 1;
    if(*p != '\n') strcat(errbuf, "\n");
    if (R_ShowErrorMessages) REprintf("%s", errbuf);
    jump_to_toplevel();
}

SEXP do_geterrmessage(SEXP call, SEXP op, SEXP args, SEXP env)
{
    SEXP res;

    checkArity(op, args);
    PROTECT(res = allocVector(STRSXP, 1));
    SET_STRING_ELT(res, 0, mkChar(errbuf));
    UNPROTECT(1);
    return res;
}

void error(const char *format, ...)
{
    char buf[BUFSIZE], *p;

    va_list(ap);
    va_start(ap, format);
    vsprintf(buf, format, ap);
    va_end(ap);
    p = buf + strlen(buf) - 1;
    if(*p != '\n') strcat(buf, "\n");
    errorcall(R_GlobalContext->call, buf);
}

/* Unwind the call stack in an orderly fashion */
/* calling the code installed by on.exit along the way */
/* and finally longjmping to the innermost TOPLEVEL context */

void jump_to_toplevel()
{
    RCNTXT *c;
    SEXP s, t;
    int haveHandler;
    int nback = 0;

    inError = 1;

    if( R_CollectWarnings ) {
    inError = 2;
    REprintf("In addition: ");
    PrintWarnings();
    inError = 1;
    }

    /*now see if options("error") is set */
    s = GetOption(install("error"), R_NilValue);
    haveHandler = ( s != R_NilValue );
    if (haveHandler) {
    if( !isLanguage(s) &&  ! isExpression(s) )  /* shouldn't happen */
        REprintf("invalid option \"error\"\n");
    else {
        inError = 3;
        if (isLanguage(s))
        eval(s, R_GlobalEnv);
        else /* expression */
        {
        int i, n = LENGTH(s);
        for (i = 0 ; i < n ; i++)
            eval(VECTOR_ELT(s, i), R_GlobalEnv);
        }
        inError = 1;
    }
    }

    if (R_Inputfile != NULL)
    fclose(R_Inputfile);
    R_ResetConsole();
    R_FlushConsole();
    R_ClearerrConsole();
    R_ParseError = 0;
    vmaxset(NULL);
    if (R_GlobalContext->cend != NULL)
    (R_GlobalContext->cend) ();
    for (c = R_GlobalContext; c; c = c->nextcontext) {
    if (c->cloenv != R_NilValue && c->conexit != R_NilValue)
        eval(c->conexit, c->cloenv);
    if (c->callflag == CTXT_RETURN || c->callflag == CTXT_GENERIC )
        nback++;
    if (c->callflag == CTXT_RESTART) {
        inError=0;
        findcontext(CTXT_RESTART, c->cloenv, R_DollarSymbol);
    }
    if (c->callflag == CTXT_TOPLEVEL)
        break;
    }
    if ( !R_Interactive && !haveHandler && inError ) {
    REprintf("Execution halted\n");
    R_CleanUp(SA_NOSAVE, 1, 0); /* quit, no save, no .Last, status=1 */
    }
#ifdef OLD
    if (R_Sinkfile) R_Outputfile = R_Sinkfile;
    else R_Outputfile = R_Consolefile;
#endif
    R_OutputCon = R_SinkCon;

    PROTECT(s = allocList(nback));
    t = s;
    for (c = R_GlobalContext ; c ; c = c->nextcontext)
    if (c->callflag & CTXT_FUNCTION ) {
        SETCAR(t, deparse1(c->call, 0));
        t = CDR(t);
    }
    setVar(install(".Traceback"), s, R_GlobalEnv);
    UNPROTECT(1);
    jump_now();
}

/*
   Absolutely no allocation can be triggered in jump_now.
   The error could be an out of memory error and any allocation
   could result in an infinite-loop condition. All you can do
   is reset things and exit.
*/
void jump_now()
{
  Rf_resetStack(0);
  LONGJMP(R_ToplevelContext->cjmpbuf, 0);
}


/*
 The topLevelReset argument controls whether the R_GlobalContext is 
 reset to its initial condition.
 In regular stand-alone R, this is not needed (see jump_now() above).
 But when R is embedded in an application, this must be set or otherwise
 subsequent errors get caught in an infinite loop when iterating over
 the contexts in the error handling routine jump_to_toplevel() above.
*/
void Rf_resetStack(int topLevelReset) {
    if( inError == 2 )
    REprintf("Lost warning messages\n");
    inError=0;
    inWarning=0;
    R_PPStackTop = 0;
    R_Warnings = R_NilValue;
    R_CollectWarnings = 0;
    if(topLevelReset) {
        R_GlobalContext = R_ToplevelContext;
    }
}

#ifdef OLD_Macintosh

#include <signal.h>
#include <errno.h>

void isintrpt()
{
    register EvQElPtr q;

    for (q = (EvQElPtr) GetEvQHdr()->qHead; q; q = (EvQElPtr) q->qLink)
    if (q->evtQWhat == keyDown && (char) q->evtQMessage == '.')
        if (q->evtQModifiers & cmdKey) {
        FlushEvents(keyDownMask, 0);
        raise(SIGINT);
                /* errno = EINTR; */
        return;
        }
}
#endif

SEXP do_stop(SEXP call, SEXP op, SEXP args, SEXP rho)
{
/* error(.) : really doesn't return anything; but all do_foo() must be SEXP */
    RCNTXT *cptr;
    SEXP c_call;

    if(asLogical(CAR(args))) {/* find context -> "Error in ..:" */
    cptr = R_GlobalContext->nextcontext;
    while ( !(cptr->callflag & CTXT_FUNCTION) && cptr->nextcontext != NULL)
        cptr = cptr->nextcontext;
    c_call = cptr->call;
    }
    else
    c_call = R_NilValue;

    args = CDR(args);

    if (CAR(args) != R_NilValue) { /* message */
      SETCAR(args, coerceVector(CAR(args), STRSXP));
      if(!isValidString(CAR(args)))
      errorcall(c_call, " [invalid string in stop(.)]");
      errorcall(c_call, "%s", CHAR(STRING_ELT(CAR(args), 0)));
    }
    else
      errorcall(c_call, "");
    /* never called: */return c_call;
}

SEXP do_warning(SEXP call, SEXP op, SEXP args, SEXP rho)
{
    RCNTXT *cptr;

    cptr = R_GlobalContext->nextcontext;
    while ( !(cptr->callflag & CTXT_FUNCTION) && cptr->nextcontext != NULL)
    cptr = cptr->nextcontext;
    if (CAR(args) != R_NilValue) {
    SETCAR(args, coerceVector(CAR(args), STRSXP));
    if(!isValidString(CAR(args)))
        warningcall(cptr->call, " [invalid string in warning(.)]");
    else
        warningcall(cptr->call,"%s", CHAR(STRING_ELT(CAR(args), 0)));
    }
    else
    warningcall(cptr->call,"");
    return CAR(args);
}

/* Error recovery for incorrect argument count error. */
void WrongArgCount(char *s)
{
    error("incorrect number of arguments to \"%s\"", s);
}


void UNIMPLEMENTED(char *s)
{
    error("Unimplemented feature in %s", s);
}

/* ERROR_.. codes in Errormsg.h */
static struct {
    R_WARNING code;
    char* format;
}
ErrorDB[] = {
    { ERROR_NUMARGS,        "invalid number of arguments"       },
    { ERROR_ARGTYPE,        "invalid argument type"         },

    { ERROR_TSVEC_MISMATCH, "time-series/vector length mismatch"    },
    { ERROR_INCOMPAT_ARGS,  "incompatible arguments"        },

    { ERROR_UNIMPLEMENTED,  "unimplemented feature in %s"       },
    { ERROR_UNKNOWN,        "unknown error (report this!)"      }
};

static struct {
    R_WARNING code;
    char* format;
}
WarningDB[] = {
    { WARNING_coerce_NA,    "NAs introduced by coercion"        },
    { WARNING_coerce_INACC, "inaccurate integer conversion in coercion" },
    { WARNING_coerce_IMAG,  "imaginary parts discarded in coercion" },

    { WARNING_UNKNOWN,      "unknown warning (report this!)"    },
};


void ErrorMessage(SEXP call, int which_error, ...)
{
    int i;
    va_list(ap);
    char *dcall;
    if (inError)
    jump_now();
    if (call != R_NilValue) {
    dcall = CHAR(STRING_ELT(deparse1(call, 0), 0));
    REprintf("Error in %s : ", dcall);
    if (strlen(dcall) > LONGCALL) REprintf("\n   ");
    }
    else
    REprintf("Error: ");    /* -- dcall = ??? */
    i = 0;
    while(ErrorDB[i].code != ERROR_UNKNOWN) {
    if (ErrorDB[i].code == which_error)
        break;
    i++;
    }
    va_start(ap, which_error);
    REvprintf(ErrorDB[i].format, ap);
    va_end(ap);
    jump_to_toplevel();
}

void WarningMessage(SEXP call, R_WARNING which_warn, ...)
{
    int i;
    va_list(ap);
    char *dcall;
    if (inError)
    jump_now();
    if (call != R_NilValue) {
    dcall = CHAR(STRING_ELT(deparse1(call, 0), 0));
    REprintf("Warning in %s : ", dcall);
    }
    else
    REprintf("Warning: ");  /* -- dcall = ??? */
    i = 0;
    while(WarningDB[i].code != WARNING_UNKNOWN) {
    if (WarningDB[i].code == which_warn)
        break;
    i++;
    }
    va_start(ap, which_warn);
    REvprintf(WarningDB[i].format, ap);
    va_end(ap);
}