ProtectStack.h

Go to the documentation of this file.

/*CXXR $Id: ProtectStack.h 1397 2013-08-16 18:25:59Z 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 PROTECTSTACK_H
#define PROTECTSTACK_H 1

#include "CXXR/RObject.h"

#ifdef __cplusplus

#include "CXXR/NodeStack.hpp"

namespace CXXR {
    class ProtectStack {
    public:
        class Scope : public NodeStack::Scope {
        public:
            Scope()
                : NodeStack::Scope(s_stack)
            {}
        };

        static unsigned int protect(RObject* node)
        {
            return s_stack->push(node);
        }

        static void reprotect(RObject* node, unsigned int index)
        {
            s_stack->retarget(node, index);
        }

        static void restoreSize(size_t new_size);

        static size_t size()
        {
            return s_stack->size();
        }

        static void unprotect(unsigned int count = 1)
        {
            s_stack->pop(count);
        }

        static void unprotectPtr(RObject* node)
        {
            s_stack->eraseTopmost(node);
        }

        static void visitRoots(GCNode::const_visitor* v)
        {
            s_stack->visitRoots(v);
        }
    private:
        friend class GCNode;

        static NodeStack* s_stack;

        // Not implemented:
        ProtectStack();

        // Clean up static data at end of run (called by
        // GCNode::SchwarzCtr destructor):
        static void cleanup();

        // Initialize static data (called by GCNode::SchwarzCtr
        // constructor):
        static void initialize();

        // Put all entries into the protecting state:
        static void protectAll()
        {
            s_stack->protectAll();
        }
    };
}  // namespace CXXR

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

    /* ***** C interface ***** */

    typedef unsigned int PROTECT_INDEX;

#ifndef __cplusplus
    void R_ProtectWithIndex(SEXP node, PROTECT_INDEX *iptr);
#else
    inline void R_ProtectWithIndex(SEXP node, PROTECT_INDEX *iptr)
    {
        *iptr = CXXR::ProtectStack::protect(node);
    }
#endif

#ifndef __cplusplus
    void R_Reprotect(SEXP node, PROTECT_INDEX index);
#else
    inline void R_Reprotect(SEXP node, PROTECT_INDEX index)
    {
        CXXR::ProtectStack::reprotect(node, index);
    }
#endif

    void Rf_ppsRestoreSize(size_t new_size);
    
    size_t Rf_ppsSize();

#ifndef __cplusplus
    SEXP Rf_protect(SEXP node);
#else
    inline SEXP Rf_protect(SEXP node)
    {
        CXXR::ProtectStack::protect(node);
        return node;
    }
#endif

#ifndef __cplusplus
    void Rf_unprotect(int count);
#else
    inline void Rf_unprotect(int count)
    {
        CXXR::ProtectStack::unprotect(count);
    }
#endif  

#ifndef __cplusplus
    void Rf_unprotect_ptr(SEXP node);
#else
    inline void Rf_unprotect_ptr(SEXP node)
    {
        CXXR::ProtectStack::unprotectPtr(node);
    }
#endif

#ifdef __cplusplus
}  /* extern "C" */
#endif

#endif  // PROTECTSTACK_H