Files
qt-creator/src/plugins/vcsbase/vcscommand.h
Jarek Kobus 363731a8c8 RunFlags: Add ProgressiveOutput flag
It replaces VcsCommand::setProgressiveOutput() property.

Change-Id: Icebd2205a5b489f60ded1eeee21e2deacbfde1fe
Reviewed-by: Orgad Shaneh <orgads@gmail.com>
2022-10-06 13:35:48 +00:00

132 lines
3.5 KiB
C++

// Copyright (C) 2016 Brian McGillion and Hugues Delorme
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0+ OR GPL-3.0 WITH Qt-GPL-exception-1.0
#pragma once
#include "vcsbase_global.h"
#include "vcsenums.h"
#include <utils/filepath.h>
#include <utils/processenums.h>
#include <QObject>
QT_BEGIN_NAMESPACE
class QMutex;
class QVariant;
template <typename T>
class QFuture;
template <typename T>
class QFutureInterface;
class QTextCodec;
QT_END_NAMESPACE
namespace Utils {
class CommandLine;
class Environment;
class QtcProcess;
}
namespace VcsBase {
namespace Internal { class VcsCommandPrivate; }
class VCSBASE_EXPORT ProgressParser
{
public:
ProgressParser();
virtual ~ProgressParser();
protected:
virtual void parseProgress(const QString &text) = 0;
void setProgressAndMaximum(int value, int maximum);
private:
void setFuture(QFutureInterface<void> *future);
QFutureInterface<void> *m_future;
QMutex *m_futureMutex = nullptr;
friend class Internal::VcsCommandPrivate;
};
class VCSBASE_EXPORT CommandResult
{
public:
CommandResult() = default;
CommandResult(const Utils::QtcProcess &process);
CommandResult(Utils::ProcessResult result, const QString &exitMessage)
: m_result(result), m_exitMessage(exitMessage) {}
Utils::ProcessResult result() const { return m_result; }
int exitCode() const { return m_exitCode; }
QString exitMessage() const { return m_exitMessage; }
QString cleanedStdOut() const { return m_cleanedStdOut; }
QString cleanedStdErr() const { return m_cleanedStdErr; }
QByteArray rawStdOut() const { return m_rawStdOut; }
private:
Utils::ProcessResult m_result = Utils::ProcessResult::StartFailed;
int m_exitCode = 0;
QString m_exitMessage;
QString m_cleanedStdOut;
QString m_cleanedStdErr;
QByteArray m_rawStdOut;
};
class VCSBASE_EXPORT VcsCommand final : public QObject
{
Q_OBJECT
public:
VcsCommand(const Utils::FilePath &workingDirectory, const Utils::Environment &environment);
~VcsCommand() override;
void setDisplayName(const QString &name);
void addJob(const Utils::CommandLine &command, int timeoutS,
const Utils::FilePath &workingDirectory = {},
const Utils::ExitCodeInterpreter &interpreter = {});
void start();
void addFlags(RunFlags f);
void setCodec(QTextCodec *codec);
void setProgressParser(ProgressParser *parser);
static CommandResult runBlocking(const Utils::FilePath &workingDirectory,
const Utils::Environment &environmentconst,
const Utils::CommandLine &command, RunFlags flags,
int timeoutS, QTextCodec *codec);
void cancel();
QString cleanedStdOut() const;
QString cleanedStdErr() const;
Utils::ProcessResult result() const;
signals:
void stdOutText(const QString &);
void stdErrText(const QString &);
void done();
void append(const QString &text);
void appendSilently(const QString &text);
void appendError(const QString &text);
void appendCommand(const Utils::FilePath &workingDirectory, const Utils::CommandLine &command);
void appendMessage(const QString &text);
void runCommandFinished(const Utils::FilePath &workingDirectory);
private:
CommandResult runBlockingHelper(const Utils::CommandLine &command, int timeoutS);
void postRunCommand(const Utils::FilePath &workingDirectory);
class Internal::VcsCommandPrivate *const d;
};
} // namespace Utils