ReturnBailout.hpp

Go to the documentation of this file.

/*CXXR $Id: ReturnBailout.hpp 1348 2013-02-25 17:49:03Z 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 RETURNBAILOUT_HPP
#define RETURNBAILOUT_HPP 1

#include "CXXR/Bailout.hpp"
#include "CXXR/Evaluator.h"

namespace CXXR {
    class Environment;

    class ReturnBailout : public Bailout {
    public:
        ReturnBailout(Environment* the_environment, RObject* the_value)
            : m_environment(the_environment), m_value(the_value),
              m_print_result(R_Visible)
        {}

        Environment* environment() const
        {
            return m_environment;
        }

        bool printResult() const
        {
            return m_print_result;
        }

        RObject* value() const
        {
            return m_value;
        }

        // Virtual function of Bailout:
        void throwException();

        // Virtual function of GCNode:
        void visitReferents(const_visitor* v) const;
    protected:
        // Virtual function of GCNode:
        void detachReferents();
    private:
        GCEdge<Environment> m_environment;
        GCEdge<> m_value;
        bool m_print_result;

        // Declared private to ensure that ReturnBailout objects are
        // allocated only using 'new':
        ~ReturnBailout() {}

        // Not implemented.  Declared to prevent compiler-generated versions:
        ReturnBailout(const ReturnBailout&);
        ReturnBailout& operator=(const ReturnBailout&);
    };
}

#endif  // RETURNBAILOUT_HPP