koffice/lib/kross/python/pythonscript.h

/***************************************************************************
 * pythonscript.h
 * This file is part of the KDE project
 * copyright (C)2004-2005 by Sebastian Sauer (mail@dipe.org)
 *
 * 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_PYTHON_PYTHONSCRIPT_H
#define KROSS_PYTHON_PYTHONSCRIPT_H

#include "pythonconfig.h"
#include "../api/script.h"

namespace Kross { namespace Python {

    // Forward declarations.
    class PythonScriptPrivate;
    class PythonModuleManager;

    /**
     * Handle python scripts. This class implements
     * \a Kross::Api::Script for python.
     */
    class PythonScript : public Kross::Api::Script
    {
        public:

            /**
             * Constructor.
             *
             * \param interpreter The \a Kross::Python::PythonInterpreter used
             *       to create this PythonScript instance.
             * \param scriptcontainer The with this PythonScript associated
             *       \a Kross::Api::ScriptContainer instance that spends us
             *       e.g. the python scripting code.
             */
            explicit PythonScript(Kross::Api::Interpreter* interpreter, Kross::Api::ScriptContainer* scriptcontainer);

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

            /**
             * 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:
            /// Private d-pointer class.
            PythonScriptPrivate* d;

            /// Initialize the script.
            void initialize();
            /// Finalize and cleanup the script.
            void finalize();

            /// \return a \a Kross::Api::Exception instance.
            Kross::Api::Exception::Ptr toException(const TQString& error);
    };

}}

#endif