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
|
// 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 "vcsbaseclientsettings.h"
#include <utils/fileutils.h>
#include <utils/id.h>
#include <utils/processenums.h>
#include <QObject>
#include <QStringList>
#include <QVariant>
#include <functional>
QT_BEGIN_NAMESPACE
class QTextCodec;
class QToolBar;
QT_END_NAMESPACE
namespace VcsBase {
class CommandResult;
class VcsBaseEditorConfig;
class VcsBaseEditorWidget;
class VcsCommand;
class VCSBASE_EXPORT VcsBaseClientImpl : public QObject
{
Q_OBJECT
public:
explicit VcsBaseClientImpl(VcsBaseSettings *baseSettings);
~VcsBaseClientImpl() override = default;
VcsBaseSettings &settings() const;
virtual Utils::FilePath vcsBinary() const;
int vcsTimeoutS() const;
enum JobOutputBindMode {
NoOutputBind,
VcsWindowOutputBind
};
static VcsCommand *createVcsCommand(const Utils::FilePath &defaultWorkingDir,
const Utils::Environment &environment);
VcsBaseEditorWidget *createVcsEditor(Utils::Id kind, QString title,
const QString &source, QTextCodec *codec,
const char *registerDynamicProperty,
const QString &dynamicPropertyValue) const;
VcsCommand *createCommand(const Utils::FilePath &workingDirectory,
VcsBaseEditorWidget *editor = nullptr,
JobOutputBindMode mode = NoOutputBind) const;
VcsCommand *execBgCommand(const Utils::FilePath &workingDirectory,
const QStringList &args,
const std::function<void (const QString &)> &outputCallback,
unsigned flags = 0) const;
void enqueueJob(VcsCommand *cmd, const QStringList &args,
const Utils::ExitCodeInterpreter &interpreter = {}) const;
virtual Utils::Environment processEnvironment() const;
// VCS functionality:
virtual VcsBaseEditorWidget *annotate(const Utils::FilePath &workingDir,
const QString &file,
const QString &revision = {},
int lineNumber = -1,
const QStringList &extraOptions = {}) = 0;
static QStringList splitLines(const QString &s);
static QString stripLastNewline(const QString &in);
// Fully synchronous VCS execution (QProcess-based)
CommandResult vcsFullySynchronousExec(const Utils::FilePath &workingDir,
const QStringList &args, unsigned flags = 0,
int timeoutS = -1, QTextCodec *codec = nullptr) const;
CommandResult vcsFullySynchronousExec(const Utils::FilePath &workingDir,
const Utils::CommandLine &cmdLine, unsigned flags = 0,
int timeoutS = -1, QTextCodec *codec = nullptr) const;
// Simple helper to execute a single command using createCommand and enqueueJob.
VcsCommand *vcsExec(const Utils::FilePath &workingDirectory,
const QStringList &arguments,
VcsBaseEditorWidget *editor = nullptr,
bool useOutputToWindow = false,
unsigned additionalFlags = 0) const;
protected:
void resetCachedVcsInfo(const Utils::FilePath &workingDir);
virtual void annotateRevisionRequested(const Utils::FilePath &workingDirectory, const QString &file,
const QString &change, int line);
// Synchronous VCS execution using Utils::SynchronousProcess, with
// log windows updating (using VcsBasePlugin::runVcs with flags)
CommandResult vcsSynchronousExec(const Utils::FilePath &workingDir,
const QStringList &args,
unsigned flags = 0,
QTextCodec *outputCodec = nullptr) const;
private:
void saveSettings();
VcsBaseSettings *m_baseSettings = nullptr; // Aspect based.
};
class VCSBASE_EXPORT VcsBaseClient : public VcsBaseClientImpl
{
Q_OBJECT
public:
class VCSBASE_EXPORT StatusItem
{
public:
StatusItem() = default;
QString flags;
QString file;
};
explicit VcsBaseClient(VcsBaseSettings *baseSettings);
virtual bool synchronousCreateRepository(const Utils::FilePath &workingDir,
const QStringList &extraOptions = {});
virtual bool synchronousClone(const Utils::FilePath &workingDir,
const QString &srcLocation,
const QString &dstLocation,
const QStringList &extraOptions = {});
virtual bool synchronousAdd(const Utils::FilePath &workingDir,
const QString &relFileName,
const QStringList &extraOptions = {});
virtual bool synchronousRemove(const Utils::FilePath &workingDir,
const QString &fileName,
const QStringList &extraOptions = {});
virtual bool synchronousMove(const Utils::FilePath &workingDir,
const QString &from, const QString &to,
const QStringList &extraOptions = {});
virtual bool synchronousPull(const Utils::FilePath &workingDir,
const QString &srcLocation,
const QStringList &extraOptions = {});
virtual bool synchronousPush(const Utils::FilePath &workingDir,
const QString &dstLocation,
const QStringList &extraOptions = {});
VcsBaseEditorWidget *annotate(const Utils::FilePath &workingDir,
const QString &file,
const QString &revision = {},
int lineNumber = -1,
const QStringList &extraOptions = {}) override;
virtual void diff(const Utils::FilePath &workingDir,
const QStringList &files = {},
const QStringList &extraOptions = {});
virtual void log(const Utils::FilePath &workingDir,
const QStringList &files = {},
const QStringList &extraOptions = {},
bool enableAnnotationContextMenu = false);
virtual void status(const Utils::FilePath &workingDir,
const QString &file = {},
const QStringList &extraOptions = {});
virtual void emitParsedStatus(const Utils::FilePath &repository,
const QStringList &extraOptions = {});
virtual void revertFile(const Utils::FilePath &workingDir,
const QString &file,
const QString &revision = {},
const QStringList &extraOptions = {});
virtual void revertAll(const Utils::FilePath &workingDir,
const QString &revision = {},
const QStringList &extraOptions = {});
virtual void import(const Utils::FilePath &repositoryRoot,
const QStringList &files,
const QStringList &extraOptions = {});
virtual void update(const Utils::FilePath &repositoryRoot,
const QString &revision = {},
const QStringList &extraOptions = {});
virtual void commit(const Utils::FilePath &repositoryRoot,
const QStringList &files,
const QString &commitMessageFile,
const QStringList &extraOptions = {});
virtual Utils::FilePath findTopLevelForFile(const Utils::FilePath &/*file*/) const { return {}; }
virtual void view(const QString &source, const QString &id,
const QStringList &extraOptions = QStringList());
signals:
void parsedStatus(const QList<VcsBase::VcsBaseClient::StatusItem> &statusList);
// Passes on changed signals from VcsJob to Control
void changed(const QVariant &v);
public:
enum VcsCommandTag
{
CreateRepositoryCommand,
CloneCommand,
AddCommand,
RemoveCommand,
MoveCommand,
PullCommand,
PushCommand,
CommitCommand,
ImportCommand,
UpdateCommand,
RevertCommand,
AnnotateCommand,
DiffCommand,
LogCommand,
StatusCommand
};
protected:
virtual QString vcsCommandString(VcsCommandTag cmd) const;
virtual Utils::Id vcsEditorKind(VcsCommandTag cmd) const = 0;
virtual Utils::ExitCodeInterpreter exitCodeInterpreter(VcsCommandTag cmd) const;
virtual QStringList revisionSpec(const QString &/*revision*/) const { return {}; }
typedef std::function<VcsBaseEditorConfig *(QToolBar *)> ConfigCreator;
void setDiffConfigCreator(ConfigCreator creator);
void setLogConfigCreator(ConfigCreator creator);
virtual StatusItem parseStatusLine(const QString &/*line*/) const { return {}; }
QString vcsEditorTitle(const QString &vcsCmd, const QString &sourceId) const;
private:
void statusParser(const QString &);
VcsBaseClient::ConfigCreator m_diffConfigCreator;
VcsBaseClient::ConfigCreator m_logConfigCreator;
};
} //namespace VcsBase
|
