threading.h

Go to the documentation of this file.

/* Copyright 2014 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 <QtCore/QQueue>
#include <QtCore/QThread>
#include <QtCore/QMutex>
#include <QtCore/QWaitCondition>
#include <QtCore/QSet>

#include <QtScript/QScriptEngine>

#include "scriptExecutionControl.h"

namespace trikScriptRunner {

class ScriptEngineWorker;
class ScriptThread;

class Threading : public QObject
{
    Q_OBJECT

public:
    explicit Threading(ScriptEngineWorker *scriptWorker, ScriptExecutionControl &scriptControl);
    ~Threading() override;

    void startMainThread(const QString &script);

    Q_INVOKABLE void startThread(const QScriptValue &threadId, const QScriptValue &function);

    Q_INVOKABLE void joinThread(const QString &threadId);

    Q_INVOKABLE void sendMessage(const QString &threadId, const QScriptValue &message);

    Q_INVOKABLE QScriptValue receiveMessage(bool waitForMessage = true);

    Q_INVOKABLE void killThread(const QString &threadId);

    void waitForAll();

    void waitForAllYielding();

    Q_INVOKABLE void reset();

    QString errorMessage() const;

    void threadFinished(const QString &id);

    bool inEventDrivenMode() const;

signals:
    void finished();

    void getVariables(const QString &propertyName);

    void variablesReady(const QJsonObject &data);

private:
    void startThread(const QString &threadId, QScriptEngine *engine, const QString &script);

    QScriptEngine *cloneEngine(QScriptEngine *engine);

    bool tryLockReset();

    QHash<QString, ScriptThread *> mThreads;
    QSet<QString> mFinishedThreads;
    QSet<QString> mPreventFromStart;
    QMutex mThreadsMutex;
    QString mErrorMessage;

    QHash<QString, QQueue<QScriptValue>> mMessageQueues;
    QMutex mMessageMutex;
    QHash<QString, QMutex *> mMessageQueueMutexes;
    QHash<QString, QWaitCondition *> mMessageQueueConditions;

    bool mResetStarted = false;
    QMutex mResetMutex;

    ScriptEngineWorker * const mScriptWorker;  // Doesn't have ownership.
    ScriptExecutionControl &mScriptControl;
    QString mScript;

    QScriptEngine *mMainScriptEngine; // Doesn't have ownership.
    const QString mMainThreadName = "main";
};

}