koffice/lib/kross/ruby/rubyscript.h

/***************************************************************************
 * rubyscript.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_RUBYRUBYSCRIPT_H
#define KROSS_RUBYRUBYSCRIPT_H

#include <api/script.h>

namespace Kross {

namespace Ruby {

class RubyScriptPrivate;

/**
 * Handle ruby scripts. This class implements
 * \a Kross::Api::Script for ruby.
 * @author Cyrille Berger
 */
class RubyScript : public Kross::Api::Script
{
    public:

        /**
         * Constructor.
         *
         * @param interpreter The @a RubyInterpreter instance used to
         *        create this script.
         * @param scriptcontainer The @a Kross::Api::ScriptContainer
         *        instance this @a RubyScript does handle the
         *        backend-work for.
         */
        RubyScript(Kross::Api::Interpreter* interpreter, Kross::Api::ScriptContainer* scriptcontainer);

        /**
         * Destructor.
         */
        ~RubyScript();

        /**
         * Return a list of callable functionnames this
         * script spends.
         */
        virtual const TQStringList& getFunctionNames();

        /**
         * Execute the script.
         */
        virtual Kross::Api::Object::Ptr execute();

        /**
         * Call a function.
         */
        virtual Kross::Api::Object::Ptr callFunction(const TQString& name, Kross::Api::List::Ptr args);

        /**
         * Return a list of class types this script supports.
         */
        virtual const TQStringList& getClassNames();

        /**
         * Create and return a new class instance.
         */
        virtual Kross::Api::Object::Ptr classInstance(const TQString& name);

    private:

        /**
         * Compile the script.
         */
        void compile();

    private:
        /// Private d-pointer.
        RubyScriptPrivate* d;
};

}

}

#endif