ZScriptThread.h

Go to the documentation of this file.

/*
* Zuble - A run-time system for QML/Javascript applications
* Copyright (C) 2013, 2014  Bob Dinitto
*
* Filename:   ZScriptThread.h
* Created on: 11/9/2014
* Author:     Bob Dinitto
*
* Zuble 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*
*/

#ifndef ZSCRIPTTHREAD_H
#define ZSCRIPTTHREAD_H

#include <QThread>
#include <QJSValue>
#include <QVariant>
#include "zglobal.h"
#include "zblcore_global.h"

namespace Zbl
{

class ZScriptWorker;
class ZblJsonHelper;

class ZScriptThread : public QObject
{
    friend class ZblApp;

    Q_OBJECT
public:

    typedef enum alertConversion {

        UNDEFINED,
        INTEGER,
        DOUBLE,
        STRING,
        JSON

    } AlertConversion;

    Q_ENUM(AlertConversion)


    explicit ZScriptThread(QObject *parent = nullptr);

    virtual ~ZScriptThread();

    static void registerType();

    Q_PROPERTY(QString initScript READ getInitScript WRITE setInitScript)

    
    Q_PROPERTY(QVariant initError READ getInitError)


    Q_PROPERTY(bool ready READ getReady NOTIFY initComplete)

    Q_PROPERTY(bool complete READ getCompleted NOTIFY finished)


    QString getInitScript();
    void setInitScript(const QString& script);
    QVariant getInitError();
    bool getReady();
    bool getCompleted();

    Q_INVOKABLE bool isInterrupted() const;

signals:

    void execComplete(qulonglong requestID, QVariant result, QVariant userData);

    //TBD: initComplete send userData too!

    void initComplete(QVariant status);

    void beginShutdown(); //TBD: ARE WE ISSUING THIS?

    void finished();



    void alert(const QString signalID, QVariant payload);

    void readyChanged();

    void completeChanged();




    
public slots:

    void execScript(qulonglong requestID, const QString& script, QVariantMap userData = QVariantMap());

    bool waitThreadComplete(unsigned long time = ULONG_MAX);


    void start();

    void quit();

    void sendInterruptRequest();


protected:


    void onWorkerExecComplete(qulonglong requestID, QString result, QString userData);


    Q_INVOKABLE void onThreadAlert(QString signalID,
                                   QString payload,
                                   int conversion);



    void onStarted();

    void onFinished();

    void destroyThread();

    static QString variantToJson(QVariant& var);

    static QVariant jsonToVariant(const QString& json);


    ZBL_DECLARE_LOGGED_OBJECT

    QThread* m_thread;

    ZScriptWorker* m_worker;

    QString m_initScript;

    QVariant m_initError;

    bool m_initReady;

    bool m_threadCompleted;

};

//typedef QMap<QString, ZScriptThread*> ZScriptMap;


} // Zbl

//Q_DECLARE_METATYPE(Zbl::ZScriptThread::AlertConversion)

#endif // ZSCRIPTTHREAD_H