FunctionBase.h

Go to the documentation of this file.

/*CXXR $Id: FunctionBase.h 1351 2013-03-08 15:12:28Z 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
 *  Copyright (C) 1995, 1996  Robert Gentleman and Ross Ihaka
 *  Copyright (C) 1999-2007   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.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 FUNCTIONBASE_H
#define FUNCTIONBASE_H

#include "CXXR/RObject.h"

#ifdef __cplusplus

#include <boost/serialization/nvp.hpp>

#include "CXXR/SEXP_downcast.hpp"

namespace CXXR {
    class ArgList;
    class Expression;
    class Environment;

    class FunctionBase : public RObject {
    public:
        virtual RObject* apply(ArgList* arglist, Environment* env,
                               const Expression* call) const = 0;

        static void enableTracing(bool on)
        {
            s_tracing_enabled = on;
        }

        static bool isA(const RObject* obj)
        {
            // We could of course use dynamic_cast here, but the
            // following is probably faster:
            if (!obj) return false;
            SEXPTYPE st = obj->sexptype();
            return st == CLOSXP || st == BUILTINSXP || st == SPECIALSXP;
        }

        void maybeTrace(const Expression* call) const
        {
            if (traced() && tracingEnabled())
                reportCall(call);
        }

        static const char* staticTypeName()
        {
            return "(function type)";
        }

        void setTracing(bool on)
        {
            m_traced = on;
        }

        bool traced() const
        {
            return m_traced;
        }

        static bool tracingEnabled()
        {
            return s_tracing_enabled;
        }
    protected:
        explicit FunctionBase(SEXPTYPE stype)
            : RObject(stype), m_traced(false)
        {}

        FunctionBase(const FunctionBase& pattern)
            : RObject(pattern), m_traced(false)
        {}

        virtual ~FunctionBase() {}
    private:
        friend class boost::serialization::access;

        static bool s_tracing_enabled;
        bool m_traced;

        static void reportCall(const Expression* call);

        // Fields not serialised here are set up by the constructor.
        template <class Archive>
        void serialize(Archive& ar, const unsigned int version)
        {
            ar & BOOST_SERIALIZATION_BASE_OBJECT_NVP(RObject);
        }
    };
}  // namespace CXXR

extern "C" {
#endif /* __cplusplus */

#ifndef __cplusplus
    int RTRACE(SEXP x);
#else
    inline int RTRACE(SEXP x)
    {
        using namespace CXXR;
        if (!x) return 0;
        const FunctionBase& f = *SEXP_downcast<const FunctionBase*>(x);
        return f.traced();
    }
#endif

#ifndef __cplusplus
    void SET_RTRACE(SEXP x, int v);
#else
    inline void SET_RTRACE(SEXP x, int v)
    {
        using namespace CXXR;
        FunctionBase* f = SEXP_downcast<FunctionBase*>(x);
        f->setTracing(v != 0);
    }
#endif

#ifdef __cplusplus
}
#endif

#endif /* FUNCTIONBASE_H */