S3Launcher.hpp

/*CXXR $Id: S3Launcher.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 S3LAUNCHER_HPP
#define S3LAUNCHER_HPP 1

#include "CXXR/GCNode.hpp"

#include "CXXR/StringVector.h"

namespace CXXR {
    class Environment;
    class Frame;
    class FunctionBase;
    class Symbol;

    class S3Launcher : public GCNode {
    public:
        void addMethodBindings(Frame* frame) const;

        const StringVector* classes() const
        {
            return m_classes;
        }

        String* className() const
        {
            if (!usingClass())
                return 0;
            return (*m_classes)[m_index];
        }

        static S3Launcher*
        create(RObject* object, std::string generic, std::string group,
               Environment* call_env, Environment* table_env,
               bool allow_default);

        static std::pair<FunctionBase*, bool>
        findMethod(const Symbol* symbol, Environment* call_env,
                   Environment* table_env);

        FunctionBase* function() const
        {
            return m_function;
        }

        std::size_t locInClasses() const
        {
            return m_index;
        }

        Symbol* symbol() const
        {
            return m_symbol;
        }

        bool usingClass() const
        {
            return m_index < m_classes->size();
        }

        // Virtual function of GCNode:
        void visitReferents(const_visitor* v) const;
    protected:
        // Virtual function of GCNode:
        void detachReferents();
    private:
        std::string m_generic;
        std::string m_group;
        GCEdge<Environment> m_call_env;
        GCEdge<Environment> m_table_env;
        GCEdge<StringVector> m_classes;  // Pointer to a vector of
          // class names, or a null pointer.  If null, subsequent
          // fields are not meaningful.
        GCEdge<FunctionBase> m_function;  // Pointer to the method found, or
          // null if no method was found.  If null, subsequent fields
          // are not meaningful.
        Symbol* m_symbol;  // Pointer to the Symbol naming the method found.  
        std::size_t m_index;  // Location within the classes vector to which
          // 'function' corresponds, or one past the end if using a
          // default method.
        bool m_using_group;  // True iff 'function' is a group method.

        S3Launcher(const std::string& generic, const std::string& group,
                   Environment* call_env, Environment* table_env)
            : m_generic(generic), m_group(group), m_call_env(call_env),
              m_table_env(table_env), m_using_group(false)
        {}
    };
}

#endif  // S3LAUNCHER_HPP