CommandChronicle.hpp

Go to the documentation of this file.

/*CXXR $Id: CommandChronicle.hpp 1353 2013-03-18 16:59:38Z 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 */

/* This file incorporates material Copyright (C) Chris A. Silles 2009-12.
 */

/*
 *  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 COMMANDCHRONICLE_HPP
#define COMMANDCHRONICLE_HPP 1

#include <set>
#include <vector>
#include <boost/serialization/access.hpp>
#include <boost/serialization/nvp.hpp>

#include "CXXR/GCEdge.hpp"
#include "CXXR/RObject.h"

namespace CXXR {
    class Provenance;

    class CommandChronicle : public GCNode {
    public:
        typedef std::vector<GCEdge<const Provenance> > ParentVector;

        CommandChronicle(const RObject* command_arg)
            : m_command(command_arg)
        {}

        const ParentVector& bindingsRead() const
        {
            return m_reads;
        }

        void close()
        {
            m_seen.clear();
        }

        const RObject* command() const
        {
            return m_command;
        }

        void readBinding(const Provenance* bdgprov);

        void writeBinding(const Provenance* bdgprov);

        // Virtual functions of GCNode:
        void detachReferents();
        void visitReferents(const_visitor* v) const;
    private:
        friend class boost::serialization::access;
        friend class Provenance;

        ParentVector m_reads;

        std::set<unsigned int> m_seen;  // Set of serial numbers of
          // all Provenance objects associated with bindings so far
          // read or written during the evaluation of the top-level
          // command.

        GCEdge<const RObject> m_command;

        // Although it is possible that a CommandChronicle object may
        // not have been closed by the time it is serialised, it is
        // assumed that it *will* have been closed before any
        // subsequent deserialisation of it takes place.  Consequently
        // the m_seen set is not itself serialised.
        template<class Archive>
        void serialize(Archive & ar, const unsigned int version) {
            using namespace boost::serialization;
            ar & BOOST_SERIALIZATION_BASE_OBJECT_NVP(GCNode);
            size_t sz = m_reads.size();
            ar & boost::serialization::make_nvp("size", sz);
            m_reads.resize(sz);
            for (size_t i = 0; i < sz; ++i) {
                GCEdge<const Provenance>& parent = m_reads[i];
                GCNPTR_SERIALIZE(ar, parent);
            }
        }
    };
}  // namespace CXXR

BOOST_CLASS_EXPORT_KEY(CXXR::CommandChronicle)

namespace boost {
    namespace serialization {
        template<class Archive>
        void load_construct_data(Archive& ar, CXXR::CommandChronicle* chron,
                                 const unsigned int version)
        {
            using namespace CXXR;
            GCStackRoot<> command;
            GCNPTR_SERIALIZE(ar, command);
            new (chron) CommandChronicle(command);
        }

        template<class Archive>
        void save_construct_data(Archive& ar,
                                 const CXXR::CommandChronicle* chron,
                                 const unsigned int version)
        {
            using namespace CXXR;
            const RObject* command = chron->command();
            GCNPTR_SERIALIZE(ar, command);
        }
    }  // namespace serialization
}  // namespace boost

#endif // COMMANDCHRONICLE_HPP