koffice/lib/kross/ruby/rubyinterpreter.h

/***************************************************************************
 * rubyinterpreter.h
 * This file is part of the KDE project
 * copyright (C)2005 by Cyrille Berger (cberger@cberger.net)
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 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
 * Library General Public License for more details.
 * You should have received a copy of the GNU Library General Public License
 * along with this program; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 ***************************************************************************/
#ifndef KROSS_RUBYRUBYINTERPRETER_H
#define KROSS_RUBYRUBYINTERPRETER_H

#include <ruby.h>

#include <api/interpreter.h>

namespace Kross {

namespace Ruby {

class RubyInterpreterPrivate;
/**
 * This class is the bridget between Kross and Ruby.
 * @author Cyrille Berger
 */
class RubyInterpreter : public Kross::Api::Interpreter
{
    public:

        /**
         * Constructor
         *
         * @param info The \a Kross::Api::InterpreterInfo instance
         *        that describes this \a RubyInterpreter .
         */
        RubyInterpreter(Kross::Api::InterpreterInfo* info);

        /**
         * Destructor.
         */
        virtual ~RubyInterpreter();

        /**
         * Factory method to create and return a new \a RubyScript instance.
         */
        virtual Kross::Api::Script* createScript(Kross::Api::ScriptContainer* scriptcontainer);

    private:
        /// Initialize the ruby interpreter.
        void initRuby();
        /// Finalize the ruby interpreter.
        void finalizeRuby();
        /// Load an external plugin / module.
        static VALUE require (VALUE, VALUE);

    public:
        /**
         * @return the ruby object with the module Kross, this module holds class
         * definition used by kross, and scripts object. All kross specific objects
         * should be member of that module.
         */
        static VALUE krossModule();

    private:
        /// Private d-pointer.
        static RubyInterpreterPrivate* d;
};

}

}

#endif