aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/vcsbase/vcscommand.h
blob: a323c0d96a49427fdd4e0d82d130e17fcce833e8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
// Copyright (C) 2016 Brian McGillion and Hugues Delorme
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0

#pragma once

#include "vcsbase_global.h"
#include "vcsenums.h"

#include <coreplugin/progressmanager/processprogress.h>

#include <QtTaskTree/QTaskTree>

#include <utils/filepath.h>
#include <utils/processinterface.h>
#include <utils/qtcprocess.h>
#include <utils/textcodec.h>

#include <QObject>

namespace VcsBase {

namespace Internal { class VcsCommandPrivate; }

using ExitCodeInterpreter = std::function<Utils::ProcessResult(int /*exitCode*/)>;

class VCSBASE_EXPORT CommandResult
{
public:
    CommandResult() = default;
    CommandResult(const Utils::Process &process);
    CommandResult(const Utils::Process &process, Utils::ProcessResult result);
    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; }

    Utils::FilePath workingDirectory() const { return m_workingDirectory; }

private:
    Utils::ProcessResult m_result = Utils::ProcessResult::StartFailed;
    int m_exitCode = 0;
    QString m_exitMessage;

    QString m_cleanedStdOut;
    QString m_cleanedStdErr;

    QByteArray m_rawStdOut;

    Utils::FilePath m_workingDirectory;
};

class VCSBASE_EXPORT VcsProcessData
{
public:
    Utils::ProcessRunData runData;
    RunFlags flags = RunFlags::None;
    ExitCodeInterpreter interpreter = {};
    Core::ProgressParser progressParser = {};
    Utils::TextEncoding encoding = {};
    Utils::TextChannelCallback stdOutHandler = {};
    Utils::TextChannelCallback stdErrHandler = {};
};

VCSBASE_EXPORT QtTaskTree::ExecutableItem errorTask(const Utils::FilePath &workingDir,
                                                 const QString &errorMessage);

VCSBASE_EXPORT Utils::ProcessTask vcsProcessTask(const VcsProcessData &data,
    const std::optional<QtTaskTree::Storage<CommandResult>> &resultStorage = {});

// TODO: Avoid, migrate to asynchronous task tree recipes.
VCSBASE_EXPORT CommandResult vcsRunBlocking(const VcsProcessData &data,
    const std::chrono::seconds timeout = std::chrono::seconds(10));

} // namespace Utils