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
|
/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** 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 Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/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 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, Digia gives you certain additional
** rights. These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
#include "iversioncontrol.h"
#include "vcsmanager.h"
#include <utils/qtcassert.h>
#include <QFileInfo>
#include <QStringList>
/*!
\class Core::IVersionControl::TopicCache
\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 Core::IVersionControl::TopicCache::trackFile(const QString &repository)
Returns the path to the file that invalidates the cache for \a repository when
the file is modified.
\fn Core::IVersionControl::TopicCache::refreshTopic(const QString &repository)
Returns the current topic for \a repository.
*/
namespace Core {
QString IVersionControl::vcsOpenText() const
{
return tr("Open with VCS (%1)").arg(displayName());
}
QString IVersionControl::vcsMakeWritableText() const
{
return QString();
}
QStringList IVersionControl::additionalToolsPath() const
{
return QStringList();
}
QString IVersionControl::vcsTopic(const QString &topLevel)
{
return m_topicCache ? m_topicCache->topic(topLevel) : QString();
}
IVersionControl::~IVersionControl()
{
delete m_topicCache;
}
IVersionControl::OpenSupportMode IVersionControl::openSupportMode(const QString &fileName) const
{
Q_UNUSED(fileName);
return NoOpen;
}
IVersionControl::TopicCache::~TopicCache()
{
}
/*!
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 QString &topLevel)
{
QTC_ASSERT(!topLevel.isEmpty(), return QString());
TopicData &data = m_cache[topLevel];
QString file = trackFile(topLevel);
if (file.isEmpty())
return QString();
const QDateTime lastModified = QFileInfo(file).lastModified();
if (lastModified == data.timeStamp)
return data.topic;
data.timeStamp = lastModified;
return data.topic = refreshTopic(topLevel);
}
} // namespace Core
#if defined(WITH_TESTS)
#include "vcsmanager.h"
#include <QFileInfo>
namespace Core {
TestVersionControl::~TestVersionControl()
{
VcsManager::instance()->clearVersionControlCache();
}
void TestVersionControl::setManagedDirectories(const QHash<QString, QString> &dirs)
{
m_managedDirs = dirs;
m_dirCount = 0;
VcsManager::instance()->clearVersionControlCache();
}
void TestVersionControl::setManagedFiles(const QSet<QString> &files)
{
m_managedFiles = files;
m_fileCount = 0;
VcsManager::instance()->clearVersionControlCache();
}
bool TestVersionControl::managesDirectory(const QString &filename, QString *topLevel) const
{
++m_dirCount;
if (m_managedDirs.contains(filename)) {
if (topLevel)
*topLevel = m_managedDirs.value(filename);
return true;
}
return false;
}
bool TestVersionControl::managesFile(const QString &workingDirectory, const QString &fileName) const
{
++m_fileCount;
QFileInfo fi(workingDirectory + QLatin1Char('/') + fileName);
QString dir = fi.absolutePath();
if (!managesDirectory(dir, 0))
return false;
QString file = fi.absoluteFilePath();
return m_managedFiles.contains(file);
}
} // namespace Core
#endif
|
