scriptEngineWorker.h

Go to the documentation of this file.

/* Copyright 2013 - 2015 Yurii Litvinov and CyberTech Labs Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License. */

#pragma once

#include <functional>

#include <QtCore/QString>
#include <QtCore/QThread>
#include <QtScript/QScriptEngine>

#include <trikControl/brickInterface.h>
#include <trikNetwork/mailboxInterface.h>

#include "scriptExecutionControl.h"
#include "threading.h"

namespace trikScriptRunner
{

class ScriptEngineWorker : public QObject
{
    Q_OBJECT

public:
    ScriptEngineWorker(trikControl::BrickInterface &brick
            , trikNetwork::MailboxInterface * mailbox
            , ScriptExecutionControl &scriptControl
            );

    QScriptEngine *createScriptEngine(bool supportThreads = true);

    QScriptEngine *copyScriptEngine(const QScriptEngine * original);

    void registerUserFunction(const QString &name, QScriptEngine::FunctionSignature function);

    void addCustomEngineInitStep(const std::function<void (QScriptEngine *)> &step);

    void resetBrick();

    void stopScript();


    QStringList knownMethodNames() const;

signals:
    void completed(const QString &error, int scriptId);

    void startedScript(int scriptId);

    void getVariables(const QString &propertyName);

    void variablesReady(const QJsonObject &data);

public slots:
    void run(const QString &script, int scriptId);

    void runDirect(const QString &command, int scriptId);

    void brickBeep();

private slots:
    void onScriptRequestingToQuit();

    void doRun(const QString &script);

    void doRunDirect(const QString &command, int scriptId);

private:
    enum State {
        ready
        , starting
        , stopping
        , running
    };

    void startScriptEvaluation(int scriptId);

    void evalSystemJs(QScriptEngine * engine) const;

    trikControl::BrickInterface &mBrick;
    trikNetwork::MailboxInterface * const mMailbox;  // Does not have ownership.
    ScriptExecutionControl &mScriptControl;
    Threading mThreading;
    QScriptEngine *mDirectScriptsEngine = nullptr;  // Has ownership.
    int mScriptId = 0;
    State mState = State::ready;
    QHash<QString, QScriptEngine::FunctionSignature> mRegisteredUserFunctions;
    QVector<std::function<void (QScriptEngine *)>> mCustomInitSteps;

    QMutex mScriptStateMutex;
};

}