QtScriptBackend.h

Go to the documentation of this file.

/*
    This file is part of Rocs.
    Copyright 2004-2011  Tomaz Canabrava <tomaz.canabrava@gmail.com>
    Copyright 2012       Andreas Cord-Landwehr <cola@uni-paderborn.de>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser 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 library 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 Lesser General Public
    License along with this library.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef QTSCRIPTBACKEND_H
#define QTSCRIPTBACKEND_H

#include <QtScript>
#include <QScriptValue>
#include <QScriptString>
#include "RocsCoreExport.h"
#include "IncludeManager.h"

class QtScriptBackendPrivate;
class QScriptEngineDebugger;
class Document;
class ToolsPluginInterface;
class QSignalSpy;

class ROCSLIB_EXPORT QtScriptBackend : public QObject
{
    Q_OBJECT
public:
    explicit QtScriptBackend(QObject* parent);

    ~QtScriptBackend();

    void setScript(const QString& script, Document *document);

    void loadFile(const QString& file);

    QScriptValue registerGlobalObject(QObject *qobject, const QString &name);
    
    void debug(const QString& message);

    void output(const QString& message);

    void interrupt();

    QScriptEngine *engine() const;

    void include(const QString& filePath);

    bool isRunning() const;

    IncludeManager& includeManager() const;

signals:
    void sendOutput(const QString &message);
    void sendDebug(const QString &message);
    void scriptError(const QString &message);
    void scriptInfo(const QString &message);
    void engineCreated(QScriptEngine* e);
    void finished();

public slots:
    QString execute();

    void executeStep();

    void continueExecutionStep();

    void stop();

private:
    const QScopedPointer<QtScriptBackendPrivate> d;
};

#endif