ClosureContext.hpp

Go to the documentation of this file.

/*CXXR $Id: ClosureContext.hpp 1348 2013-02-25 17:49:03Z arr $
 *CXXR
 *CXXR This file is part of CXXR, a project to refactor the R interpreter
 *CXXR into C++.  It may consist in whole or in part of program code and
 *CXXR documentation taken from the R project itself, incorporated into
 *CXXR CXXR (and possibly MODIFIED) under the terms of the GNU General Public
 *CXXR Licence.
 *CXXR 
 *CXXR CXXR is Copyright (C) 2008-13 Andrew R. Runnalls, subject to such other
 *CXXR copyrights and copyright restrictions as may be stated below.
 *CXXR 
 *CXXR CXXR is not part of the R project, and bugs and other issues should
 *CXXR not be reported via r-bugs or other R project channels; instead refer
 *CXXR to the CXXR website.
 *CXXR */

/*
 *  R : A Computer Language for Statistical Data Analysis
 *
 *  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.1 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 Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, a copy is available at
 *  http://www.r-project.org/Licenses/
 */

#ifndef CLOSURECONTEXT_HPP
#define CLOSURECONTEXT_HPP 1

#include "CXXR/FunctionBase.h"
#include "CXXR/FunctionContext.hpp"

extern "C" {
    // Parked here pending the creation of an ErrorHandling class:
    extern CXXR::GCRoot<> R_HandlerStack;  // Condition handler stack
    extern CXXR::GCRoot<> R_RestartStack;  // Stack of available restarts
}

namespace CXXR {
    class ClosureContext : public FunctionContext {
    public:
        ClosureContext(const Expression* the_call, Environment* call_env,
                       const FunctionBase* function, Environment* working_env,
                       const PairList* promise_args);

        ~ClosureContext();

        RObject* handlerStack() const
        {
            return m_handlerstack;
        }

        static ClosureContext* innermost(Evaluator::Context* start
                                         = Evaluator::Context::innermost());

        RObject* onExit() const
        {
            return m_onexit;
        }

        const PairList* promiseArgs() const
        {
            return m_promise_args;
        }

        void setOnExit(RObject* onexit)
        {
            m_onexit = onexit;
        }

        Environment* workingEnvironment() const
        {
            return m_working_env;
        }
    private:
        Rboolean m_interrupts_suspended;
        GCStackRoot<> m_handlerstack;
        GCStackRoot<> m_restartstack;
        GCStackRoot<Environment> m_working_env;
        GCStackRoot<const PairList> m_promise_args;
        GCStackRoot<> m_onexit;
    };
}  // namespace CXXR

SEXP Rf_dynamicfindVar(SEXP, CXXR::ClosureContext*);
int Rf_framedepth(CXXR::ClosureContext*);
void R_InsertRestartHandlers(CXXR::ClosureContext*, Rboolean);
SEXP R_syscall(int, CXXR::ClosureContext*);
int R_sysparent(int, CXXR::ClosureContext*);
SEXP R_sysframe(int, CXXR::ClosureContext*);
SEXP R_sysfunction(int, CXXR::ClosureContext*);

#endif  // CLOSURECONTEXT_HPP