FunctionContext.hpp

Go to the documentation of this file.

/*CXXR $Id: FunctionContext.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 FUNCTIONCONTEXT_HPP
#define FUNCTIONCONTEXT_HPP 1

#include "CXXR/Evaluator_Context.hpp"
#include "CXXR/Expression.h"
#include "CXXR/FunctionBase.h"
#include "CXXR/GCStackRoot.hpp"

extern "C" {
    // Parked here temporarily:
    extern CXXR::RObject* R_Srcref;
}

namespace CXXR {
    class FunctionContext : public Evaluator::Context {
    public:
        FunctionContext(const Expression* the_call, Environment* call_env,
                        const FunctionBase* function);

        ~FunctionContext();

        const Expression* call() const
        {
            return m_call;
        }

        Environment* callEnvironment() const
        {
            return m_call_env;
        }

        const FunctionBase* function() const
        {
            return m_function;
        }

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

        RObject* sourceLocation() const
        {
            return m_srcref;
        }

    private:
        GCStackRoot<> m_srcref;
        GCStackRoot<const Expression> m_call;
        GCStackRoot<Environment> m_call_env;
        GCStackRoot<const FunctionBase> m_function;
    };
}  // namespace CXXR

#endif  // FUNCTIONCONTEXT_HPP