d4/d7c/qprocess_8h_source.html

// Copyright (C) 2016 The Qt Company Ltd.

// Copyright (C) 2023 Intel Corporation.

// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only


#ifndef QPROCESS_H

#define QPROCESS_H


#include <QtCore/qiodevice.h>

#include <QtCore/qstringlist.h>

#include <QtCore/qshareddata.h>


#include <functional>


QT_REQUIRE_CONFIG(processenvironment);


#if defined(Q_OS_WIN) || defined(Q_QDOC)

struct _PROCESS_INFORMATION;

struct _SECURITY_ATTRIBUTES;

struct _STARTUPINFOW;

using Q_PROCESS_INFORMATION = _PROCESS_INFORMATION;

using Q_SECURITY_ATTRIBUTES = _SECURITY_ATTRIBUTES;

using Q_STARTUPINFO = _STARTUPINFOW;

#endif


QT_BEGIN_NAMESPACE


class QProcessPrivate;

class QProcessEnvironmentPrivate;


class Q_CORE_EXPORT QProcessEnvironment

{

public:

    enum Initialization { InheritFromParent };


    QProcessEnvironment();

    QProcessEnvironment(Initialization) noexcept;

    QProcessEnvironment(const QProcessEnvironment &other);

    ~QProcessEnvironment();

    QT_MOVE_ASSIGNMENT_OPERATOR_IMPL_VIA_PURE_SWAP(QProcessEnvironment)

    QProcessEnvironment &operator=(const QProcessEnvironment &other);


    void swap(QProcessEnvironment &other) noexcept { d.swap(other.d); }


    bool operator==(const QProcessEnvironment &other) const;

    inline bool operator!=(const QProcessEnvironment &other) const

    { return !(*this == other); }


    bool isEmpty() const;

    [[nodiscard]] bool inheritsFromParent() const;

    void clear();


    bool contains(const QString &name) const;

    void insert(const QString &name, const QString &value);

    void remove(const QString &name);

    QString value(const QString &name, const QString &defaultValue = QString()) const;


    QStringList toStringList() const;


    QStringList keys() const;


    void insert(const QProcessEnvironment &e);


    static QProcessEnvironment systemEnvironment();


private:

    friend class QProcessPrivate;

    friend class QProcessEnvironmentPrivate;

    QSharedDataPointer<QProcessEnvironmentPrivate> d;

};


Q_DECLARE_SHARED(QProcessEnvironment)


#if QT_CONFIG(process)


class Q_CORE_EXPORT QProcess : public QIODevice

{

    Q_OBJECT

public:

    enum ProcessError {

        FailedToStart,

        Crashed,

        Timedout,

        ReadError,

        WriteError,

        UnknownError

    };

    Q_ENUM(ProcessError)


    enum ProcessState {

        NotRunning,

        Starting,

        Running

    };

    Q_ENUM(ProcessState)


    enum ProcessChannel {

        StandardOutput,

        StandardError

    };

    Q_ENUM(ProcessChannel)


    enum ProcessChannelMode {

        SeparateChannels,

        MergedChannels,

        ForwardedChannels,

        ForwardedOutputChannel,

        ForwardedErrorChannel

    };

    Q_ENUM(ProcessChannelMode)


    enum InputChannelMode {

        ManagedInputChannel,

        ForwardedInputChannel

    };

    Q_ENUM(InputChannelMode)


    enum ExitStatus {

        NormalExit,

        CrashExit

    };

    Q_ENUM(ExitStatus)


    explicit QProcess(QObject *parent = nullptr);

    virtual ~QProcess();


    void start(const QString &program, const QStringList &arguments = {}, OpenMode mode = ReadWrite);

    void start(OpenMode mode = ReadWrite);

    void startCommand(const QString &command, OpenMode mode = ReadWrite);

    bool startDetached(qint64 *pid = nullptr);

    bool open(OpenMode mode = ReadWrite) override;


    QString program() const;

    void setProgram(const QString &program);


    QStringList arguments() const;

    void setArguments(const QStringList & arguments);


    ProcessChannelMode processChannelMode() const;

    void setProcessChannelMode(ProcessChannelMode mode);

    InputChannelMode inputChannelMode() const;

    void setInputChannelMode(InputChannelMode mode);


    ProcessChannel readChannel() const;

    void setReadChannel(ProcessChannel channel);


    void closeReadChannel(ProcessChannel channel);

    void closeWriteChannel();


    void setStandardInputFile(const QString &fileName);

    void setStandardOutputFile(const QString &fileName, OpenMode mode = Truncate);

    void setStandardErrorFile(const QString &fileName, OpenMode mode = Truncate);

    void setStandardOutputProcess(QProcess *destination);


#if defined(Q_OS_WIN) || defined(Q_QDOC)

    QString nativeArguments() const;

    void setNativeArguments(const QString &arguments);

    struct CreateProcessArguments

    {

        const wchar_t *applicationName;

        wchar_t *arguments;

        Q_SECURITY_ATTRIBUTES *processAttributes;

        Q_SECURITY_ATTRIBUTES *threadAttributes;

        bool inheritHandles;

        unsigned long flags;

        void *environment;

        const wchar_t *currentDirectory;

        Q_STARTUPINFO *startupInfo;

        Q_PROCESS_INFORMATION *processInformation;

    };

    typedef std::function<void(CreateProcessArguments *)> CreateProcessArgumentModifier;

    CreateProcessArgumentModifier createProcessArgumentsModifier() const;

    void setCreateProcessArgumentsModifier(CreateProcessArgumentModifier modifier);

#endif // Q_OS_WIN || Q_QDOC

#if defined(Q_OS_UNIX) || defined(Q_QDOC)

    std::function<void(void)> childProcessModifier() const;

    void setChildProcessModifier(const std::function<void(void)> &modifier);

    Q_NORETURN void failChildProcessModifier(const char *description, int error = 0) noexcept;


    enum class UnixProcessFlag : quint32 {

        ResetSignalHandlers                 = 0x0001, // like POSIX_SPAWN_SETSIGDEF

        IgnoreSigPipe                       = 0x0002,

        // some room if we want to add IgnoreSigHup or so

        CloseFileDescriptors                = 0x0010,

        UseVFork                            = 0x0020, // like POSIX_SPAWN_USEVFORK

        CreateNewSession                    = 0x0040, // like POSIX_SPAWN_SETSID

        DisconnectControllingTerminal       = 0x0080,

        ResetIds                            = 0x0100, // like POSIX_SPAWN_RESETIDS

    };

    Q_DECLARE_FLAGS(UnixProcessFlags, UnixProcessFlag)

    struct UnixProcessParameters

    {

        UnixProcessFlags flags = {};

        int lowestFileDescriptorToClose = 0;


        quint32 _reserved[6] {};

    };

    UnixProcessParameters unixProcessParameters() const noexcept;

    void setUnixProcessParameters(const UnixProcessParameters &params);

    void setUnixProcessParameters(UnixProcessFlags flagsOnly);

#endif


    QString workingDirectory() const;

    void setWorkingDirectory(const QString &dir);


    void setEnvironment(const QStringList &environment);

    QStringList environment() const;

    void setProcessEnvironment(const QProcessEnvironment &environment);

    QProcessEnvironment processEnvironment() const;


    QProcess::ProcessError error() const;

    QProcess::ProcessState state() const;


    qint64 processId() const;


    bool waitForStarted(int msecs = 30000);

    bool waitForReadyRead(int msecs = 30000) override;

    bool waitForBytesWritten(int msecs = 30000) override;

    bool waitForFinished(int msecs = 30000);


    QByteArray readAllStandardOutput();

    QByteArray readAllStandardError();


    int exitCode() const;

    QProcess::ExitStatus exitStatus() const;


    // QIODevice

    qint64 bytesToWrite() const override;

    bool isSequential() const override;

    void close() override;


    static int execute(const QString &program, const QStringList &arguments = {});

    static bool startDetached(const QString &program, const QStringList &arguments = {},

                              const QString &workingDirectory = QString(), qint64 *pid = nullptr);


    static QStringList systemEnvironment();


    static QString nullDevice();


    static QStringList splitCommand(QStringView command);


public Q_SLOTS:

    void terminate();

    void kill();


Q_SIGNALS:

    void started(QPrivateSignal);

    void finished(int exitCode, QProcess::ExitStatus exitStatus = NormalExit);

    void errorOccurred(QProcess::ProcessError error);

    void stateChanged(QProcess::ProcessState state, QPrivateSignal);


    void readyReadStandardOutput(QPrivateSignal);

    void readyReadStandardError(QPrivateSignal);


protected:

    void setProcessState(ProcessState state);


    // QIODevice

    qint64 readData(char *data, qint64 maxlen) override;

    qint64 writeData(const char *data, qint64 len) override;


private:

    Q_DECLARE_PRIVATE(QProcess)

    Q_DISABLE_COPY(QProcess)


#if QT_VERSION < QT_VERSION_CHECK(7,0,0)

    // ### Qt7: Remove this struct and the virtual function; they're here only

    // to cause build errors in Qt 5 code that wasn't updated to Qt 6's

    // setChildProcessModifier()

    struct Use_setChildProcessModifier_Instead {};

    QT_DEPRECATED_X("Use setChildProcessModifier() instead")

    virtual Use_setChildProcessModifier_Instead setupChildProcess();

#endif


    Q_PRIVATE_SLOT(d_func(), bool _q_canReadStandardOutput())

    Q_PRIVATE_SLOT(d_func(), bool _q_canReadStandardError())

#ifdef Q_OS_UNIX

    Q_PRIVATE_SLOT(d_func(), bool _q_canWrite())

#endif

    Q_PRIVATE_SLOT(d_func(), bool _q_startupNotification())

    Q_PRIVATE_SLOT(d_func(), void _q_processDied())

};


#ifdef Q_OS_UNIX

Q_DECLARE_OPERATORS_FOR_FLAGS(QProcess::UnixProcessFlags)

#endif


#endif // QT_CONFIG(process)


QT_END_NAMESPACE


#endif // QPROCESS_H

channel
IOBluetoothL2CAPChannel * channel
Definition btl2capchannel.mm:18

QByteArray
\inmodule QtCore
Definition qbytearray.h:57

QIODevice
\inmodule QtCore \reentrant
Definition qiodevice.h:34

QObject
\inmodule QtCore
Definition qobject.h:90

QProcessEnvironmentPrivate
Definition qprocess_p.h:104

QProcessEnvironment
\inmodule QtCore
Definition qprocess.h:31

QProcessEnvironment::Initialization
Initialization
This enum contains a token that is used to disambiguate constructors.
Definition qprocess.h:33

QProcessEnvironment::operator!=
bool operator!=(const QProcessEnvironment &other) const
Returns true if this and the other QProcessEnvironment objects are different.
Definition qprocess.h:45

QProcessEnvironment::swap
void swap(QProcessEnvironment &other) noexcept
Definition qprocess.h:42

QSharedDataPointer
\inmodule QtCore
Definition qshareddata.h:35

QStringList
\inmodule QtCore

QStringView
\inmodule QtCore
Definition qstringview.h:76

QString
\macro QT_RESTRICTED_CAST_FROM_ASCII
Definition qstring.h:127

clear
b clear()

e
double e
Definition doc_src_qalgorithms.cpp:6

insert
cache insert(employee->id(), employee)

arguments
QList< QVariant > arguments
Definition doc_src_qsignalspy.cpp:12

state
else opt state
[0]
Definition doc_src_styles.cpp:11

QT_BEGIN_NAMESPACE
Combined button and popup list for selecting options.
Definition qstandardpaths_haiku.cpp:21

QT_END_NAMESPACE
Definition qsharedpointer.cpp:1545

Running
@ Running
Definition qandroideventdispatcher.cpp:21

Q_NORETURN
#define Q_NORETURN
Definition qcompilerdetection.h:1000

void
DBusConnection const char DBusError DBusBusType DBusError return DBusConnection DBusHandleMessageFunction void DBusFreeFunction return DBusConnection return DBusConnection return const char DBusError return DBusConnection DBusMessage dbus_uint32_t return DBusConnection dbus_bool_t DBusConnection DBusAddWatchFunction DBusRemoveWatchFunction DBusWatchToggledFunction void DBusFreeFunction return DBusConnection DBusDispatchStatusFunction void DBusFreeFunction DBusTimeout return DBusTimeout return DBusWatch return DBusWatch unsigned int return DBusError const DBusError return const DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessageIter int const void return DBusMessageIter DBusMessageIter return DBusMessageIter void DBusMessageIter void int return DBusMessage DBusMessageIter return DBusMessageIter return DBusMessageIter DBusMessageIter const char const char const char const char return DBusMessage return DBusMessage const char return DBusMessage dbus_bool_t return DBusMessage dbus_uint32_t return DBusMessage void
Definition qdbus_symbols_p.h:401

destination
DBusConnection const char DBusError DBusBusType DBusError return DBusConnection DBusHandleMessageFunction void DBusFreeFunction return DBusConnection return DBusConnection return const char DBusError return DBusConnection DBusMessage dbus_uint32_t return DBusConnection dbus_bool_t DBusConnection DBusAddWatchFunction DBusRemoveWatchFunction DBusWatchToggledFunction void DBusFreeFunction return DBusConnection DBusDispatchStatusFunction void DBusFreeFunction DBusTimeout return DBusTimeout return DBusWatch return DBusWatch unsigned int return DBusError const DBusError return const DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessage return DBusMessageIter int const void return DBusMessageIter DBusMessageIter return DBusMessageIter void DBusMessageIter void int return DBusMessage DBusMessageIter return DBusMessageIter return DBusMessageIter DBusMessageIter const char const char const char const char return DBusMessage return DBusMessage const char * destination
Definition qdbus_symbols_p.h:360

error
DBusConnection const char DBusError * error
Definition qdbus_symbols_p.h:157

value
EGLOutputLayerEXT EGLint EGLAttrib value
[5]
Definition qeglstreamconvenience_p.h:46

Q_DECLARE_FLAGS
#define Q_DECLARE_FLAGS(Flags, Enum)
Definition qflags.h:174

Q_DECLARE_OPERATORS_FOR_FLAGS
#define Q_DECLARE_OPERATORS_FOR_FLAGS(Flags)
Definition qflags.h:194

contains
static bool contains(const QJsonArray &haystack, unsigned needle)
Definition qopengl.cpp:116

mode
GLenum mode
Definition qopengles2ext.h:333

flags
GLbitfield flags
Definition qopengles2ext.h:1026

program
GLuint program
Definition qopengles2ext.h:1805

data
GLint GLsizei GLsizei GLenum GLenum GLsizei void * data
Definition qopengles2ext.h:206

start
GLuint start
Definition qopengles2ext.h:354

name
GLuint name
Definition qopengles2ext.h:156

params
void ** params
Definition qopengles2ext.h:160

len
GLenum GLsizei len
Definition qopenglext.h:3292

operator==
bool operator==(const QRandomGenerator &rng1, const QRandomGenerator &rng2)
Definition qrandom.cpp:1219

QT_REQUIRE_CONFIG
#define QT_REQUIRE_CONFIG(feature)
Definition qtconfigmacros.h:66

QT_DEPRECATED_X
#define QT_DEPRECATED_X(text)
Definition qtdeprecationmarkers.h:27

Q_ENUM
#define Q_ENUM(x)
Definition qtmetamacros.h:68

Q_OBJECT
#define Q_OBJECT
Definition qtmetamacros.h:117

Q_SLOTS
#define Q_SLOTS
Definition qtmetamacros.h:44

Q_PRIVATE_SLOT
#define Q_PRIVATE_SLOT(d, signature)
Definition qtmetamacros.h:46

Q_SIGNALS
#define Q_SIGNALS
Definition qtmetamacros.h:45

toStringList
static QStringList toStringList(const QJsonArray &jsonArray)
Definition qtmoduleinfo.cpp:18

quint32
unsigned int quint32
Definition qtypes.h:45

qint64
long long qint64
Definition qtypes.h:55

waitForFinished
future waitForFinished()

open
file open(QIODevice::ReadOnly)

keys
QStringList keys
Definition src_corelib_io_qsettings.cpp:157

remove
settings remove("monkey")

waitForReadyRead
device waitForReadyRead(deadline)

d
double d
Definition src_corelib_text_qlocale.cpp:9

writeData
void writeData(const QByteArray &data)
Definition src_corelib_thread_qreadwritelock.cpp:55

readData
QByteArray readData()
Definition src_corelib_thread_qreadwritelock.cpp:30

other
QSharedPointer< T > other(t)
[5]

dir
QString dir
[11]
Definition src_gui_dialogs_qfiledialog.cpp:79

fileName
fileName
[0]
Definition src_gui_dialogs_qfiledialog.cpp:5

parent
IUIAutomationTreeWalker __RPC__deref_out_opt IUIAutomationElement ** parent
Definition uiaclientinterfaces_p.h:209