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
|
/*
* This file is part of KDevelop
* Copyright 2013 Milian Wolff <mail@milianw.de>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License as
* published by the Free Software Foundation; either version 2 of
* the License or (at your option) version 3 or any later version
* accepted by the membership of KDE e.V. (or its successor approved
* by the membership of KDE e.V.), which shall act as a proxy
* defined in Section 14 of version 3 of the license.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "filter.h"
#include <KConfigGroup>
#include <array>
using namespace KDevelop;
Filter::Filter()
: targets(Files | Folders)
{
}
Filter::Filter(const SerializedFilter& filter)
: pattern(QString(), Qt::CaseSensitive, QRegExp::WildcardUnix)
, targets(filter.targets)
, type(filter.type)
{
QString pattern = filter.pattern;
if (!filter.pattern.startsWith(QLatin1Char('/')) && !filter.pattern.startsWith(QLatin1Char('*'))) {
// implicitly match against trailing relative path
pattern.prepend(QLatin1String("*/"));
}
if (pattern.endsWith(QLatin1Char('/')) && targets != Filter::Files) {
// implicitly match against folders
targets = Filter::Folders;
pattern.chop(1);
}
this->pattern.setPattern(pattern);
}
SerializedFilter::SerializedFilter()
: targets(Filter::Files | Filter::Folders)
{
}
SerializedFilter::SerializedFilter(const QString& pattern, Filter::Targets targets, Filter::Type type)
: pattern(pattern)
, targets(targets)
, type(type)
{
}
namespace KDevelop {
SerializedFilters defaultFilters()
{
SerializedFilters ret;
ret.reserve(41);
// filter hidden files
ret << SerializedFilter(QStringLiteral(".*"), Filter::Targets(Filter::Files | Filter::Folders));
// but do show some with special meaning
static const std::array<QString, 10> configFiles = {
// Version control
QStringLiteral(".gitignore"),
QStringLiteral(".gitmodules"),
// https://pre-commit.com/
QStringLiteral(".pre-commit-config.yaml"),
// CI config files
// https://docs.gitlab.com/ee/ci/yaml/
QStringLiteral(".gitlab-ci.yml"),
// https://travis-ci.org/
QStringLiteral(".travis.yml"),
// Linting configs
// https://editorconfig.org/
QStringLiteral(".editorconfig"),
// https://pep8.readthedocs.io
QStringLiteral(".pep8"),
// https://prettier.io/
QStringLiteral(".prettierignore"),
QStringLiteral(".prettierrc*"),
// https://clang.llvm.org/docs/ClangFormat.html
QStringLiteral(".clang-format"),
};
for (const QString& file : configFiles) {
ret << SerializedFilter(file, Filter::Files, Filter::Inclusive);
}
static const std::array<QString, 1> configFolders = {
// CI config folders
// https://circleci.com/docs/
QStringLiteral(".circleci"),
};
for (const QString& folder : configFolders) {
ret << SerializedFilter(folder, Filter::Folders, Filter::Inclusive);
}
// common vcs folders which we want to hide
static const std::array<QString, 9> invalidFolders = {
QStringLiteral(".git"), QStringLiteral("CVS"), QStringLiteral(".svn"), QStringLiteral("_svn"),
QStringLiteral("SCCS"), QStringLiteral("_darcs"), QStringLiteral(".hg"), QStringLiteral(".bzr"), QStringLiteral("__pycache__")
};
for (const QString& folder : invalidFolders) {
ret << SerializedFilter(folder, Filter::Folders);
}
// common files which we want to hide
static const std::array<QString, 20> filePatterns = {
// binary files (Unix)
QStringLiteral("*.o"), QStringLiteral("*.a"), QStringLiteral("*.so"), QStringLiteral("*.so.*"),
// binary files (Windows)
QStringLiteral("*.obj"), QStringLiteral("*.lib"), QStringLiteral("*.dll"), QStringLiteral("*.exp"), QStringLiteral("*.pdb"),
// generated files
QStringLiteral("moc_*.cpp"), QStringLiteral("*.moc"), QStringLiteral("ui_*.h"), QStringLiteral("*.qmlc"), QStringLiteral("qrc_*.cpp"),
// backup files
QStringLiteral("*~"), QStringLiteral("*.orig"), QStringLiteral(".*.kate-swp"), QStringLiteral(".*.swp"),
// python cache and object files
QStringLiteral("*.pyc"), QStringLiteral("*.pyo")
};
for (const QString& filePattern : filePatterns) {
ret << SerializedFilter(filePattern, Filter::Files);
}
return ret;
}
SerializedFilters readFilters(const KSharedConfigPtr& config)
{
if (!config->hasGroup("Filters")) {
return defaultFilters();
}
const KConfigGroup& group = config->group("Filters");
const int size = group.readEntry("size", -1);
if (size == -1) {
// fallback
return defaultFilters();
}
SerializedFilters filters;
filters.reserve(size);
for (int i = 0; i < size; ++i) {
const QByteArray subGroup = QByteArray::number(i);
if (!group.hasGroup(subGroup)) {
continue;
}
const KConfigGroup& subConfig = group.group(subGroup);
const QString pattern = subConfig.readEntry("pattern", QString());
Filter::Targets targets(subConfig.readEntry("targets", 0));
Filter::Type type = static_cast<Filter::Type>(subConfig.readEntry("inclusive", 0));
filters << SerializedFilter(pattern, targets, type);
}
return filters;
}
void writeFilters(const SerializedFilters& filters, KSharedConfigPtr config)
{
// clear existing
config->deleteGroup("Filters");
// write new
KConfigGroup group = config->group("Filters");
group.writeEntry("size", filters.size());
int i = 0;
for (const SerializedFilter& filter : filters) {
KConfigGroup subGroup = group.group(QByteArray::number(i++));
subGroup.writeEntry("pattern", filter.pattern);
subGroup.writeEntry("targets", static_cast<int>(filter.targets));
subGroup.writeEntry("inclusive", static_cast<int>(filter.type));
}
config->sync();
}
Filters deserialize(const SerializedFilters& filters)
{
Filters ret;
ret.reserve(filters.size());
for (const SerializedFilter& filter : filters) {
ret << Filter(filter);
}
return ret;
}
}
|
