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
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0+ OR GPL-3.0 WITH Qt-GPL-exception-1.0
#include "iversioncontrol.h"
#include "vcsmanager.h"
#include <utils/algorithm.h>
#include <utils/hostosinfo.h>
#include <utils/qtcassert.h>
#include <QDir>
#include <QFileInfo>
#include <QRegularExpression>
#include <QStringList>
/*!
\class Core::IVersionControl::TopicCache
\inheaderfile coreplugin/iversioncontrol.h
\inmodule QtCreator
\brief The TopicCache class stores a cache which maps a directory to a topic.
A VCS topic is typically the current active branch name, but it can also have other
values (for example the latest tag) when there is no active branch.
It is displayed:
\list
\li In the project tree, next to each root project - corresponding to the project.
\li In the main window title - corresponding to the current active editor.
\endlist
In order to enable topic display, an IVersionControl subclass needs to create
an instance of the TopicCache subclass with appropriate overrides for its
pure virtual functions, and pass this instance to IVersionControl's constructor.
The cache tracks a file in the repository, which is expected to change when the
topic changes. When the file is modified, the cache is refreshed.
For example: for Git this file is typically <repository>/.git/HEAD
*/
/*!
\fn Utils::FilePath Core::IVersionControl::TopicCache::trackFile(const Utils::FilePath &repository)
Returns the path to the file that invalidates the cache for \a repository when
the file is modified.
\fn QString Core::IVersionControl::TopicCache::refreshTopic(const Utils::FilePath &repository)
Returns the current topic for \a repository.
*/
using namespace Utils;
namespace Core {
QString IVersionControl::vcsOpenText() const
{
return tr("Open with VCS (%1)").arg(displayName());
}
QString IVersionControl::vcsMakeWritableText() const
{
return QString();
}
FilePaths IVersionControl::additionalToolsPath() const
{
return {};
}
IVersionControl::RepoUrl::RepoUrl(const QString &location)
{
if (location.isEmpty())
return;
// Check for local remotes (refer to the root or relative path)
// On Windows, local paths typically starts with <drive>:
auto locationIsOnWindowsDrive = [&location] {
if (!Utils::HostOsInfo::isWindowsHost() || location.size() < 2)
return false;
const QChar drive = location.at(0).toLower();
return drive >= 'a' && drive <= 'z' && location.at(1) == ':';
};
if (location.startsWith("file://") || location.startsWith('/') || location.startsWith('.')
|| locationIsOnWindowsDrive()) {
protocol = "file";
path = QDir::fromNativeSeparators(location.startsWith("file://")
? location.mid(7) : location);
isValid = true;
return;
}
// TODO: Why not use QUrl?
static const QRegularExpression remotePattern(
"^(?:(?<protocol>[^:]+)://)?(?:(?<user>[^@]+)@)?(?<host>[^:/]+)"
"(?::(?<port>\\d+))?:?(?<path>.*)$");
const QRegularExpressionMatch match = remotePattern.match(location);
if (!match.hasMatch())
return;
bool ok = false;
protocol = match.captured("protocol");
userName = match.captured("user");
host = match.captured("host");
port = match.captured("port").toUShort(&ok);
path = match.captured("path");
isValid = !host.isEmpty() && (ok || match.captured("port").isEmpty());
}
IVersionControl::RepoUrl IVersionControl::getRepoUrl(const QString &location) const
{
return RepoUrl(location);
}
void IVersionControl::setTopicCache(TopicCache *topicCache)
{
m_topicCache = topicCache;
}
QString IVersionControl::vcsTopic(const FilePath &topLevel)
{
return m_topicCache ? m_topicCache->topic(topLevel) : QString();
}
IVersionControl::IVersionControl()
{
Core::VcsManager::addVersionControl(this);
}
IVersionControl::~IVersionControl()
{
delete m_topicCache;
}
FilePaths IVersionControl::unmanagedFiles(const FilePaths &filePaths) const
{
return Utils::filtered(filePaths, [this](const FilePath &fp) {
return !managesFile(fp.parentDir(), fp.fileName());
});
}
IVersionControl::OpenSupportMode IVersionControl::openSupportMode(const FilePath &filePath) const
{
Q_UNUSED(filePath)
return NoOpen;
}
IVersionControl::TopicCache::~TopicCache() = default;
/*!
Returns the topic for repository under \a topLevel.
If the cache for \a topLevel is valid, it will be used. Otherwise it will be refreshed.
*/
QString IVersionControl::TopicCache::topic(const FilePath &topLevel)
{
QTC_ASSERT(!topLevel.isEmpty(), return QString());
TopicData &data = m_cache[topLevel];
const FilePath file = trackFile(topLevel);
if (file.isEmpty())
return QString();
const QDateTime lastModified = file.lastModified();
if (lastModified == data.timeStamp)
return data.topic;
data.timeStamp = lastModified;
return data.topic = refreshTopic(topLevel);
}
void IVersionControl::fillLinkContextMenu(QMenu *, const FilePath &, const QString &)
{
}
bool IVersionControl::handleLink(const FilePath &workingDirectory, const QString &reference)
{
QTC_ASSERT(!reference.isEmpty(), return false);
vcsDescribe(workingDirectory, reference);
return true;
}
} // namespace Core
#if defined(WITH_TESTS)
#include <QFileInfo>
namespace Core {
TestVersionControl::~TestVersionControl()
{
VcsManager::clearVersionControlCache();
}
void TestVersionControl::setManagedDirectories(const QHash<FilePath, FilePath> &dirs)
{
m_managedDirs = dirs;
m_dirCount = 0;
VcsManager::clearVersionControlCache();
}
void TestVersionControl::setManagedFiles(const QSet<FilePath> &files)
{
m_managedFiles = files;
m_fileCount = 0;
VcsManager::clearVersionControlCache();
}
bool TestVersionControl::managesDirectory(const FilePath &filePath, FilePath *topLevel) const
{
++m_dirCount;
if (m_managedDirs.contains(filePath)) {
if (topLevel)
*topLevel = m_managedDirs.value(filePath);
return true;
}
return false;
}
bool TestVersionControl::managesFile(const FilePath &workingDirectory, const QString &fileName) const
{
++m_fileCount;
FilePath full = workingDirectory.pathAppended(fileName);
if (!managesDirectory(full.parentDir(), nullptr))
return false;
return m_managedFiles.contains(full.absoluteFilePath());
}
} // namespace Core
#endif
|
