ProvenanceTracker.h

Go to the documentation of this file.

/*CXXR $Id: ProvenanceTracker.h 1400 2013-08-30 12:50:21Z 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 PROVENANCETRACKER_H
#define PROVENANCETRACKER_H

#ifdef __cplusplus

#include "CXXR/Frame.hpp"

namespace CXXR {

#ifndef PROVENANCE_TRACKING
    // Vestigial implementation of ProvenanceTracker:
    struct ProvenanceTracker {
        static void flagXenogenesis()
        {}
    };
#else

    class ProvenanceTracker {
    public:
        class CommandScope {
        public:
            CommandScope(const RObject* command);

            ~CommandScope();

            void flagXenogenesis()
            {
                m_xenogenetic = true;
            }

            void monitorRead(const Frame::Binding& bdg);

            void monitorWrite(const Frame::Binding& bdg);
        private:
            GCStackRoot<CommandChronicle> m_chronicle;
            bool m_xenogenetic;
        };

        static void flagXenogenesis();

        static void monitorRead(const Frame::Binding& bdg);

        static void monitorWrite(const Frame::Binding& bdg);

        static void setMonitors();
    private:
        static CommandScope* s_scope;  // Pointer to the current scope
          // or null if none.  If scopes are nested, this points to
          // the outermost scope.

        // Declared private to prevent instantiation of this class:
        ProvenanceTracker();
    };
#endif  // PROVENANCE_TRACKING
} // namespace CXXR

extern "C" {
#endif // __cplusplus

    void flagXenogenesis();

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

#endif // PROVENANCETRACKER_H