ZProcess.h

Go to the documentation of this file.

#ifndef ZPROCESS_H
#define ZPROCESS_H

#include <QObject>
#include "zglobal.h"
#include "ZioDevice.h"
#include <QProcess>

namespace Zbl
{

class ZProcess : public QObject
{
    Q_OBJECT
public:

    enum ProcessError {
        FailedToStart = QProcess::FailedToStart,
        Crashed = QProcess::Crashed,
        Timedout = QProcess::Timedout,
        ReadError = QProcess::ReadError,
        WriteError = QProcess::WriteError,
        UnknownError = QProcess::UnknownError
    };
    Q_ENUM(ProcessError)

    enum ProcessState {
        NotRunning = QProcess::NotRunning,
        Starting = QProcess::Starting,
        Running = QProcess::Running
    };
    Q_ENUM(ProcessState)

    enum ProcessChannel {
        StandardOutput = QProcess::StandardOutput,
        StandardError = QProcess::StandardError
    };
    Q_ENUM(ProcessChannel)

    enum ProcessChannelMode {
        SeparateChannels = QProcess::SeparateChannels,
        MergedChannels = QProcess::MergedChannels,
        ForwardedChannels = QProcess::ForwardedChannels,
        ForwardedOutputChannel = QProcess::ForwardedOutputChannel,
        ForwardedErrorChannel = QProcess::ForwardedErrorChannel
    };
    Q_ENUM(ProcessChannelMode)

    enum ExitStatus {
        NormalExit = QProcess::NormalExit,
        CrashExit = QProcess::CrashExit
    };
    Q_ENUM(ExitStatus)


    explicit ZProcess(QObject *parent = nullptr);
    virtual ~ZProcess();

    QObject* getJsDevice();
    QVariant getTags();

    static void registerType();


    Q_PROPERTY(QObject* device READ getJsDevice CONSTANT)

    
    Q_PROPERTY(QVariant tags READ getTags NOTIFY tagsChanged)

    Q_PROPERTY(QStringList arguments READ getArguments WRITE setArguments)

    Q_PROPERTY(QString program READ getProgram WRITE setProgram)

    Q_PROPERTY(int processChannelMode READ getProcessChannelMode WRITE setProcessChannelMode)

    Q_PROPERTY(int readChannel READ getReadChannel WRITE setReadChannel)

    Q_PROPERTY(qint64 processId READ getProcessID)

    Q_PROPERTY(qint64 state READ getState)

    Q_PROPERTY(qint64 error READ getError)


#if 0

    Q_INVOKABLE void release();
#endif


    QStringList getArguments();

    void setArguments(const QStringList &arguments);

    QString getProgram() const;

    void setProgram(const QString &program);


    void setProcessChannelMode(int mode);

    int getProcessChannelMode() const;


    void setReadChannel(int channel);

    int getReadChannel() const;


    qint64 getProcessID() const;

    int getState() const;

    int getError() const;

    int exitCode() const;

    int exitStatus() const;


    // working directory set/get?

    Q_INVOKABLE void envClear();

    Q_INVOKABLE QStringList envGetList();

    Q_INVOKABLE void envSetValue(const QString& name, const QString& value);

    Q_INVOKABLE QString envGetValue(const QString& name);

    Q_INVOKABLE bool envValueExists(const QString& name);

    Q_INVOKABLE void closeReadChannel(int channel);

    Q_INVOKABLE QObject* readAllStandardError();

    Q_INVOKABLE QObject* readAllStandardOutput();


public slots:

    void start(int mode = static_cast<int>(ZioDevice::ReadWrite));

    void closeWriteChannel();

    void getQDevice(QIODevice** device); // for ZioDevice::getCurrentDevice

signals:

    void tagsChanged();

    void started();
    void finished(int exitCode, QProcess::ExitStatus exitStatus);
    void errorOccurred(QProcess::ProcessError error);
    void stateChanged(QProcess::ProcessState state, QPrivateSignal);
    void readyReadStandardOutput(QPrivateSignal);
    void readyReadStandardError(QPrivateSignal);


protected:

    ZBL_DECLARE_LOGGED_OBJECT

    void initZioDevice();

    void createTags();


    QProcess* m_p;

    ZioDevice* m_zd;

    static QVariant m_tags;
};

} // Zbl

#endif // ZPROCESS_H