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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
|
/**************************************************************************
**
** Copyright (C) 2015 Brian McGillion and Hugues Delorme
** Contact: http://www.qt.io/licensing
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms and
** conditions see http://www.qt.io/terms-conditions. For further information
** use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
#ifndef VCSBASECLIENT_H
#define VCSBASECLIENT_H
#include "vcsbase_global.h"
#include <utils/fileutils.h>
#include <QObject>
#include <QStringList>
#include <QVariant>
#include <functional>
QT_BEGIN_NAMESPACE
class QFileInfo;
class QProcessEnvironment;
QT_END_NAMESPACE
namespace Core { class Id; }
namespace Utils {
struct SynchronousProcessResponse;
class ExitCodeInterpreter;
}
namespace VcsBase {
class VcsCommand;
class VcsBaseEditorWidget;
class VcsBaseClientSettings;
class VcsJob;
class VcsBaseClientImplPrivate;
class VcsBaseClientPrivate;
class VcsBaseEditorParameterWidget;
class VCSBASE_EXPORT VcsBaseClientImpl : public QObject
{
Q_OBJECT
public:
explicit VcsBaseClientImpl(VcsBaseClientSettings *settings);
~VcsBaseClientImpl();
VcsBaseClientSettings &settings() const;
virtual Utils::FileName vcsBinary() const;
int vcsTimeoutS() const;
enum JobOutputBindMode {
NoOutputBind,
VcsWindowOutputBind
};
VcsBaseEditorWidget *createVcsEditor(Core::Id kind, QString title,
const QString &source, QTextCodec *codec,
const char *registerDynamicProperty,
const QString &dynamicPropertyValue) const;
VcsCommand *createCommand(const QString &workingDirectory,
VcsBaseEditorWidget *editor = 0,
JobOutputBindMode mode = NoOutputBind) const;
void enqueueJob(VcsCommand *cmd, const QStringList &args,
const QString &workingDirectory = QString(),
Utils::ExitCodeInterpreter *interpreter = 0);
virtual QProcessEnvironment processEnvironment() const;
// VCS functionality:
virtual void annotate(const QString &workingDir, const QString &file,
const QString &revision = QString(), int lineNumber = -1,
const QStringList &extraOptions = QStringList()) = 0;
// Return converted command output, remove '\r' read on Windows
static QString commandOutputFromLocal8Bit(const QByteArray &a);
// Return converted command output split into lines
static QStringList commandOutputLinesFromLocal8Bit(const QByteArray &a);
protected:
void resetCachedVcsInfo(const QString &workingDir);
virtual void annotateRevisionRequested(const QString &workingDirectory, const QString &file,
const QString &change, int line);
// Fully synchronous VCS execution (QProcess-based)
bool vcsFullySynchronousExec(const QString &workingDir, const QStringList &args,
QByteArray *outputData, QByteArray *errorData = 0,
unsigned flags = 0) const;
// Simple helper to execute a single command using createCommand and enqueueJob.
VcsCommand *vcsExec(const QString &workingDirectory, const QStringList &arguments,
VcsBaseEditorWidget *editor = 0, bool useOutputToWindow = false,
unsigned additionalFlags = 0, const QVariant &cookie = QVariant());
// Synchronous VCS execution using Utils::SynchronousProcess, with
// log windows updating (using VcsBasePlugin::runVcs with flags)
Utils::SynchronousProcessResponse vcsSynchronousExec(const QString &workingDir,
const QStringList &args,
unsigned flags = 0,
QTextCodec *outputCodec = 0) const;
private:
void saveSettings();
VcsBaseClientImplPrivate *d;
};
class VCSBASE_EXPORT VcsBaseClient : public VcsBaseClientImpl
{
Q_OBJECT
public:
class VCSBASE_EXPORT StatusItem
{
public:
StatusItem() {}
StatusItem(const QString &s, const QString &f);
QString flags;
QString file;
};
explicit VcsBaseClient(VcsBaseClientSettings *settings);
~VcsBaseClient();
virtual bool synchronousCreateRepository(const QString &workingDir,
const QStringList &extraOptions = QStringList());
virtual bool synchronousClone(const QString &workingDir,
const QString &srcLocation,
const QString &dstLocation,
const QStringList &extraOptions = QStringList());
virtual bool synchronousAdd(const QString &workingDir, const QString &fileName,
const QStringList &extraOptions = QStringList());
virtual bool synchronousRemove(const QString &workingDir, const QString &fileName,
const QStringList &extraOptions = QStringList());
virtual bool synchronousMove(const QString &workingDir,
const QString &from, const QString &to,
const QStringList &extraOptions = QStringList());
virtual bool synchronousPull(const QString &workingDir,
const QString &srcLocation,
const QStringList &extraOptions = QStringList());
virtual bool synchronousPush(const QString &workingDir,
const QString &dstLocation,
const QStringList &extraOptions = QStringList());
virtual void annotate(const QString &workingDir, const QString &file,
const QString &revision = QString(), int lineNumber = -1,
const QStringList &extraOptions = QStringList());
virtual void diff(const QString &workingDir, const QStringList &files = QStringList(),
const QStringList &extraOptions = QStringList());
virtual void log(const QString &workingDir, const QStringList &files = QStringList(),
const QStringList &extraOptions = QStringList(),
bool enableAnnotationContextMenu = false);
virtual void status(const QString &workingDir, const QString &file = QString(),
const QStringList &extraOptions = QStringList());
virtual void emitParsedStatus(const QString &repository,
const QStringList &extraOptions = QStringList());
virtual void revertFile(const QString &workingDir, const QString &file,
const QString &revision = QString(),
const QStringList &extraOptions = QStringList());
virtual void revertAll(const QString &workingDir, const QString &revision = QString(),
const QStringList &extraOptions = QStringList());
virtual void import(const QString &repositoryRoot, const QStringList &files,
const QStringList &extraOptions = QStringList());
virtual void update(const QString &repositoryRoot, const QString &revision = QString(),
const QStringList &extraOptions = QStringList());
virtual void commit(const QString &repositoryRoot, const QStringList &files,
const QString &commitMessageFile,
const QStringList &extraOptions = QStringList());
virtual QString findTopLevelForFile(const QFileInfo &file) const = 0;
signals:
void parsedStatus(const QList<VcsBase::VcsBaseClient::StatusItem> &statusList);
// Passes on changed signals from VcsJob to Control
void changed(const QVariant &v);
public slots:
virtual void view(const QString &source, const QString &id,
const QStringList &extraOptions = QStringList());
protected:
enum VcsCommandTag
{
CreateRepositoryCommand,
CloneCommand,
AddCommand,
RemoveCommand,
MoveCommand,
PullCommand,
PushCommand,
CommitCommand,
ImportCommand,
UpdateCommand,
RevertCommand,
AnnotateCommand,
DiffCommand,
LogCommand,
StatusCommand
};
virtual QString vcsCommandString(VcsCommandTag cmd) const;
virtual Core::Id vcsEditorKind(VcsCommandTag cmd) const = 0;
virtual Utils::ExitCodeInterpreter *exitCodeInterpreter(VcsCommandTag cmd, QObject *parent) const;
virtual QStringList revisionSpec(const QString &revision) const = 0;
typedef std::function<VcsBaseEditorParameterWidget *()> ParameterWidgetCreator;
void setDiffParameterWidgetCreator(ParameterWidgetCreator creator);
void setLogParameterWidgetCreator(ParameterWidgetCreator creator);
virtual StatusItem parseStatusLine(const QString &line) const = 0;
QString vcsEditorTitle(const QString &vcsCmd, const QString &sourceId) const;
private:
void statusParser(const QString&);
friend class VcsBaseClientPrivate;
VcsBaseClientPrivate *d;
};
} //namespace VcsBase
#endif // VCSBASECLIENT_H
|
