diff options
Diffstat (limited to 'src/libs/utils/process.h')
| -rw-r--r-- | src/libs/utils/process.h | 219 |
1 files changed, 219 insertions, 0 deletions
diff --git a/src/libs/utils/process.h b/src/libs/utils/process.h new file mode 100644 index 0000000000..f89b6f9b22 --- /dev/null +++ b/src/libs/utils/process.h @@ -0,0 +1,219 @@ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0 + +#pragma once + +#include "utils_global.h" + +#include "commandline.h" +#include "processenums.h" +#include "tasktree.h" + +#include <QProcess> + +QT_BEGIN_NAMESPACE +class QDebug; +class QTextCodec; +QT_END_NAMESPACE + +class tst_QtcProcess; + +namespace Utils { + +namespace Internal { class QtcProcessPrivate; } +namespace Pty { class Data; } + +class Environment; +class DeviceProcessHooks; +class ProcessInterface; +class ProcessResultData; + +class QTCREATOR_UTILS_EXPORT Process final : public QObject +{ + Q_OBJECT + +public: + explicit Process(QObject *parent = nullptr); + ~Process(); + + // ProcessInterface related + + void start(); + + void terminate(); + void kill(); + void interrupt(); + void kickoffProcess(); + void closeWriteChannel(); + void close(); + void stop(); + + QString readAllStandardOutput(); + QString readAllStandardError(); + + QByteArray readAllRawStandardOutput(); + QByteArray readAllRawStandardError(); + + qint64 write(const QString &input); + qint64 writeRaw(const QByteArray &input); + + qint64 processId() const; + qint64 applicationMainThreadId() const; + + QProcess::ProcessState state() const; + ProcessResultData resultData() const; + + int exitCode() const; + QProcess::ExitStatus exitStatus() const; + + QProcess::ProcessError error() const; + QString errorString() const; + + bool waitForStarted(int msecs = 30000); + bool waitForReadyRead(int msecs = 30000); + bool waitForFinished(int msecs = 30000); + + // ProcessSetupData related + + void setProcessImpl(ProcessImpl processImpl); + + void setPtyData(const std::optional<Pty::Data> &data); + std::optional<Pty::Data> ptyData() const; + + void setTerminalMode(TerminalMode mode); + TerminalMode terminalMode() const; + bool usesTerminal() const { return terminalMode() != TerminalMode::Off; } + + void setProcessMode(ProcessMode processMode); + ProcessMode processMode() const; + + void setEnvironment(const Environment &env); // Main process + const Environment &environment() const; + + void setControlEnvironment(const Environment &env); // Possible helper process (ssh on host etc) + const Environment &controlEnvironment() const; + + void setCommand(const CommandLine &cmdLine); + const CommandLine &commandLine() const; + + void setWorkingDirectory(const FilePath &dir); + FilePath workingDirectory() const; + + void setWriteData(const QByteArray &writeData); + + void setUseCtrlCStub(bool enabled); // release only + void setLowPriority(); + void setDisableUnixTerminal(); + void setRunAsRoot(bool on); + bool isRunAsRoot() const; + void setAbortOnMetaChars(bool abort); + + QProcess::ProcessChannelMode processChannelMode() const; + void setProcessChannelMode(QProcess::ProcessChannelMode mode); + void setStandardInputFile(const QString &inputFile); + + void setExtraData(const QString &key, const QVariant &value); + QVariant extraData(const QString &key) const; + + void setExtraData(const QVariantHash &extraData); + QVariantHash extraData() const; + + void setReaperTimeout(int msecs); + int reaperTimeout() const; + + static void setRemoteProcessHooks(const DeviceProcessHooks &hooks); + + // TODO: Some usages of this method assume that Starting phase is also a running state + // i.e. if isRunning() returns false, they assume NotRunning state, what may be an error. + bool isRunning() const; // Short for state() == QProcess::Running. + + // Other enhancements. + // These (or some of them) may be potentially moved outside of the class. + // For some we may aggregate in another public utils class (or subclass of QtcProcess)? + + // TODO: Unused currently? Should it serve as a compartment for contrary of remoteEnvironment? + static Environment systemEnvironmentForBinary(const FilePath &filePath); + + static bool startDetached(const CommandLine &cmd, const FilePath &workingDirectory = {}, + qint64 *pid = nullptr); + + // Starts the command and waits for finish. + // User input processing is enabled when EventLoopMode::On was passed. + void runBlocking(EventLoopMode eventLoopMode = EventLoopMode::Off); + + /* Timeout for hanging processes (triggers after no more output + * occurs on stderr/stdout). */ + void setTimeoutS(int timeoutS); + int timeoutS() const; + + // TODO: We should specify the purpose of the codec, e.g. setCodecForStandardChannel() + void setCodec(QTextCodec *c); + void setTimeOutMessageBoxEnabled(bool); + void setExitCodeInterpreter(const ExitCodeInterpreter &interpreter); + + void setStdOutCallback(const TextChannelCallback &callback); + void setStdOutLineCallback(const TextChannelCallback &callback); + void setStdErrCallback(const TextChannelCallback &callback); + void setStdErrLineCallback(const TextChannelCallback &callback); + + void setTextChannelMode(Channel channel, TextChannelMode mode); + TextChannelMode textChannelMode(Channel channel) const; + + bool readDataFromProcess(QByteArray *stdOut, QByteArray *stdErr, int timeoutS = 30); + + ProcessResult result() const; + + QByteArray allRawOutput() const; + QString allOutput() const; + + QByteArray rawStdOut() const; + + QString stdOut() const; // possibly with CR + QString stdErr() const; // possibly with CR + + QString cleanedStdOut() const; // with sequences of CR squashed and CR LF replaced by LF + QString cleanedStdErr() const; // with sequences of CR squashed and CR LF replaced by LF + + const QStringList stdOutLines() const; // split, CR removed + const QStringList stdErrLines() const; // split, CR removed + + QString exitMessage() const; + + QString toStandaloneCommandLine() const; + + void setCreateConsoleOnWindows(bool create); + bool createConsoleOnWindows() const; + +signals: + void starting(); // On NotRunning -> Starting state transition + void started(); // On Starting -> Running state transition + void done(); // On Starting | Running -> NotRunning state transition + void readyReadStandardOutput(); + void readyReadStandardError(); + void textOnStandardOutput(const QString &text); + void textOnStandardError(const QString &text); + +private: + friend QTCREATOR_UTILS_EXPORT QDebug operator<<(QDebug str, const Process &r); + + friend class Internal::QtcProcessPrivate; + Internal::QtcProcessPrivate *d = nullptr; +}; + +class DeviceProcessHooks +{ +public: + std::function<ProcessInterface *(const FilePath &)> processImplHook; + std::function<Environment(const FilePath &)> systemEnvironmentForBinary; +}; + +class QTCREATOR_UTILS_EXPORT ProcessTaskAdapter : public Tasking::TaskAdapter<Process> +{ +public: + ProcessTaskAdapter(); + void start() final; +}; + +} // namespace Utils + +QTC_DECLARE_CUSTOM_TASK(ProcessTask, Utils::ProcessTaskAdapter); |