qts-interpreter/script.h

/***************************************************************************
 * script.h
 * This file is part of the KDE project
 * copyright (C)2007-2008 by Sebastian Sauer ([email protected])
 *
 * 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_QTS_SCRIPT_H
#define KROSS_QTS_SCRIPT_H
 
#include <kross/core/krossconfig.h>
#include <kross/core/interpreter.h>
#include <kross/core/manager.h>
#include <kross/core/script.h>
#include <kross/core/action.h>
#include <kross/core/object.h>
 
namespace Kross
{
 
/**
* The EcmaScript class implements a \a Kross::Script to handle
* a single script. Each script and script file will have its
* own \a EcmaScript instance as container for a Ecma QtScript
* that is managed by the \a Kross::Action class.
*/
class EcmaScript : public Kross::Script
{
    Q_OBJECT
public:
 
    /**
    * Constructor.
    *
    * \param interpreter The \a EcmaInterpreter instance this
    * script belongs to.
    * \param action The \a Kross::Action instance that contains
    * details about the script and that decorates this script.
    */
    EcmaScript(Kross::Interpreter *interpreter, Kross::Action *action);
 
    /**
    * Destructor.
    */
    ~EcmaScript() override;
 
public Q_SLOTS:
 
    /**
    * Executes the script.
    */
    void execute() override;
 
    /**
    * \return a list of function-names.
    */
    QStringList functionNames() override;
 
    /**
    * Execute a function.
    *
    * \param name The name of the function that should be called.
    * \param args The optional arguments for the function.
    * \return The return value of the function.
    */
    QVariant callFunction(const QString &name, const QVariantList &args = QVariantList()) override;
 
    /**
     * Evaluate some scripting code.
     *
     * \param code The scripting code to evaluate.
     * \return The return value of the evaluation.
     */
    QVariant evaluate(const QByteArray &code) override;
 
    /**
    * \return the internal used QScriptEngine instance.
    */
    QObject *engine() const;
 
private:
    class Private;
    Private *const d;
};
 
}
 
#endif