HandleVector.hpp

Go to the documentation of this file.

/*CXXR $Id: HandleVector.hpp 1030 2011-01-04 14:00:23Z 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-11 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 HANDLEVECTOR_HPP
#define HANDLEVECTOR_HPP 1

#include <algorithm>

#include "localization.h"
#include "R_ext/Error.h"
#include "CXXR/Allocator.hpp"
#include "CXXR/GCRoot.h"
#include "CXXR/VectorBase.h"

namespace CXXR {
    template <typename T, SEXPTYPE ST>
    class HandleVector : public VectorBase {
    private:
        typedef std::vector<Handle<T>, Allocator<Handle<T> > > Vector;
    public:
        typedef typename Vector::const_iterator const_iterator;

        explicit HandleVector(size_t sz, T* init = 0)
            : VectorBase(ST, sz), m_data(sz, Handle<T>(init))
        {}

        HandleVector(const HandleVector<T, ST>& pattern)
            : VectorBase(pattern), m_data(pattern.m_data.size())
        {
            for (unsigned int i = 0; i < m_data.size(); ++i) {
                // Use copy constructor to apply object copying logic:
                Handle<T> handle(pattern.m_data[i]);
                m_data[i] = handle;
            }
        }

        Handle<T>& operator[](unsigned int index)
        {
            return m_data[index];
        }

        const T* operator[](unsigned int index) const
        {
            return m_data[index];
        }

        const_iterator begin() const
        {
            return m_data.begin();
        }

        const_iterator end() const
        {
            return m_data.end();
        }

        inline static const char* staticTypeName();

        // Virtual function of RObject:
        const char* typeName() const;

        // Virtual function of GCNode:
        void visitReferents(const_visitor* v) const;
    protected:
        ~HandleVector() {}

        // Virtual function of GCNode:
        void detachReferents();
    private:
        Vector m_data;

        // Not implemented.  Declared to prevent
        // compiler-generated version:
        HandleVector& operator=(const HandleVector&);

        friend class ElementProxy;
    };

    template <typename T, SEXPTYPE ST>
    const char* HandleVector<T, ST>::typeName() const
    {
        return HandleVector<T, ST>::staticTypeName();
    }

    template <typename T, SEXPTYPE ST>
    void HandleVector<T, ST>::detachReferents()
    {
        VectorBase::detachReferents();
        m_data.clear();
    }

    template <typename T, SEXPTYPE ST>
    void HandleVector<T, ST>::visitReferents(const_visitor* v) const
    {
        VectorBase::visitReferents(v);
        typename Vector::const_iterator end = m_data.end();
        for (typename Vector::const_iterator it = m_data.begin();
             it != end; ++it) {
            T* node = *it;
            if (node)
                (*v)(node);
        }
    }
}  // namespace CXXR

#endif  // HANDLEVECTOR_HPP