aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/vcsbase/vcsjobrunner.h
blob: edc27f032ea6c5da54801eea34c72d02448f30f2 (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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2010 Brian McGillion & Hugues Delorme
**
** Contact: Nokia Corporation (info@qt.nokia.com)
**
**
** GNU Lesser General Public License Usage
**
** This file may be used under the terms of the GNU Lesser General Public
** License version 2.1 as published by the Free Software Foundation and
** appearing in the file LICENSE.LGPL included in the packaging of this file.
** Please review the following information to ensure the GNU Lesser General
** Public License version 2.1 requirements will be met:
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** Other Usage
**
** Alternatively, this file may be used in accordance with the terms and
** conditions contained in a signed written agreement between you and Nokia.
**
** If you have questions regarding the use of this file, please contact
** Nokia at info@qt.nokia.com.
**
**************************************************************************/

#ifndef VCSJOBRUNNER_H
#define VCSJOBRUNNER_H

#include "vcsbase_global.h"

#include <QtCore/QThread>
#include <QtCore/QStringList>
#include <QtCore/QString>
#include <QtCore/QPointer>
#include <QtCore/QSharedPointer>
#include <QtCore/QScopedPointer>
#include <QtCore/QVariant>

QT_BEGIN_NAMESPACE
class QProcess;
QT_END_NAMESPACE

namespace VCSBase {
class VCSBaseEditorWidget;
class VCSJobRunnerPrivate;

class VCSBASE_EXPORT VCSJob : public QObject
{
    Q_OBJECT
public:
    enum DataEmitMode {
        NoDataEmitMode,
        RawDataEmitMode,
        EditorDataEmitMode
    };

    VCSJob(const QString &workingDir,
           const QStringList &args,
           DataEmitMode emitMode = NoDataEmitMode);
    VCSJob(const QString &workingDir,
           const QStringList &args,
           VCSBase::VCSBaseEditorWidget *editor);

    DataEmitMode dataEmitMode() const;
    VCSBase::VCSBaseEditorWidget *displayEditor() const;
    QStringList arguments() const;
    QString workingDirectory() const;
    const QVariant &cookie() const;
    bool unixTerminalDisabled() const;

    void setDisplayEditor(VCSBase::VCSBaseEditorWidget *editor);
    void setCookie(const QVariant &cookie);
    // Disable terminal to suppress SSH prompting
    void setUnixTerminalDisabled(bool v);

signals:
    void succeeded(const QVariant &cookie); // Use a queued connection
    void rawData(const QByteArray &data);

private:
    friend class VCSJobRunner;
    const QString m_workingDir;
    const QStringList m_arguments;
    bool m_emitRaw;
    QVariant m_cookie;
    QPointer<VCSBase::VCSBaseEditorWidget> m_editor; // User might close it
    bool m_unixTerminalDisabled;
};

class VCSBASE_EXPORT VCSJobRunner : public QThread
{
    Q_OBJECT
public:
    VCSJobRunner();
    ~VCSJobRunner();
    void enqueueJob(const QSharedPointer<VCSJob> &job);
    void restart();

    static QString msgStartFailed(const QString &binary, const QString &why);
    static QString msgTimeout(const QString &binary, int timeoutSeconds);

    // Set environment for a VCS process to run in locale "C"
    static void setProcessEnvironment(QProcess *p);

    void setSettings(const QString &bin, const QStringList &stdArgs, int timeoutMsec);

protected:
    void run();

signals:
    void commandStarted(const QString &notice);
    void error(const QString &error);
    void output(const QByteArray &output);

private:
    void task(const QSharedPointer<VCSJob> &job);
    void stop();

    QScopedPointer<VCSJobRunnerPrivate> d;
};

} //namespace VCSBase

#endif // VCSJOBRUNNER_H