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
|
// Copyright (C) 2019 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#include "compilationdbparser.h"
#include "compilationdatabaseconstants.h"
#include "compilationdatabaseprojectmanagertr.h"
#include <coreplugin/progressmanager/progressmanager.h>
#include <projectexplorer/treescanner.h>
#include <utils/async.h>
#include <utils/futuresynchronizer.h>
#include <utils/mimeutils.h>
#include <QCryptographicHash>
#include <QJsonArray>
#include <QJsonDocument>
#include <QJsonObject>
#include <vector>
using namespace ProjectExplorer;
using namespace Utils;
namespace CompilationDatabaseProjectManager::Internal {
static QStringList jsonObjectFlags(const QJsonObject &object, QSet<QString> &flagsCache)
{
QStringList flags;
const QJsonArray arguments = object["arguments"].toArray();
if (arguments.isEmpty()) {
flags = splitCommandLine(object["command"].toString(), flagsCache);
} else {
flags.reserve(arguments.size());
for (const QJsonValue &arg : arguments) {
auto flagIt = flagsCache.insert(arg.toString());
flags.append(*flagIt);
}
}
return flags;
}
static FilePath jsonObjectFilePath(const QJsonObject &object)
{
const FilePath workingDir = FilePath::fromUserInput(object["directory"].toString());
return workingDir.resolvePath(object["file"].toString());
}
static std::vector<DbEntry> readJsonObjects(const QByteArray &projectFileContents)
{
std::vector<DbEntry> result;
int objectStart = projectFileContents.indexOf('{');
int objectEnd = projectFileContents.indexOf('}', objectStart + 1);
QSet<QString> flagsCache;
while (objectStart >= 0 && objectEnd >= 0) {
const QJsonDocument document = QJsonDocument::fromJson(
projectFileContents.mid(objectStart, objectEnd - objectStart + 1));
if (document.isNull()) {
// The end was found incorrectly, search for the next one.
objectEnd = projectFileContents.indexOf('}', objectEnd + 1);
continue;
}
const QJsonObject object = document.object();
const FilePath filePath = jsonObjectFilePath(object);
const QStringList flags = filterFromFileName(jsonObjectFlags(object, flagsCache),
filePath.fileName());
result.push_back({flags, filePath, FilePath::fromUserInput(object["directory"].toString())});
objectStart = projectFileContents.indexOf('{', objectEnd + 1);
objectEnd = projectFileContents.indexOf('}', objectStart + 1);
}
return result;
}
static QStringList readExtraFiles(const QString &filePath)
{
QStringList result;
QFile file(filePath);
if (file.open(QFile::ReadOnly)) {
QTextStream stream(&file);
while (!stream.atEnd()) {
const QString line = stream.readLine().trimmed();
if (line.isEmpty() || line.startsWith('#'))
continue;
result.push_back(line);
}
}
return result;
}
static DbContents parseProject(const QByteArray &projectFileContents,
const FilePath &projectFilePath)
{
DbContents dbContents;
dbContents.entries = readJsonObjects(projectFileContents);
dbContents.extraFileName = projectFilePath.path()
+ Constants::COMPILATIONDATABASEPROJECT_FILES_SUFFIX;
dbContents.extras = readExtraFiles(dbContents.extraFileName);
std::sort(dbContents.entries.begin(), dbContents.entries.end(),
[](const DbEntry &lhs, const DbEntry &rhs) {
return std::lexicographical_compare(lhs.flags.begin(), lhs.flags.end(),
rhs.flags.begin(), rhs.flags.end());
});
return dbContents;
}
CompilationDbParser::CompilationDbParser(const QString &projectName,
const FilePath &projectPath,
const FilePath &rootPath,
MimeBinaryCache &mimeBinaryCache,
BuildSystem::ParseGuard &&guard,
QObject *parent)
: QObject(parent)
, m_projectName(projectName)
, m_projectFilePath(projectPath)
, m_rootPath(rootPath)
, m_mimeBinaryCache(mimeBinaryCache)
, m_guard(std::move(guard))
{
connect(&m_parserWatcher, &QFutureWatcher<void>::finished, this, [this] {
m_dbContents = m_parserWatcher.result();
parserJobFinished();
});
}
CompilationDbParser::~CompilationDbParser()
{
if (m_treeScanner && !m_treeScanner->isFinished()) {
auto future = m_treeScanner->future();
future.cancel();
future.waitForFinished();
}
}
void CompilationDbParser::start()
{
// Check hash first.
Result<QByteArray> fileContents = m_projectFilePath.fileContents();
if (!fileContents) {
finish(ParseResult::Failure);
return;
}
m_projectFileContents = *std::move(fileContents);
const QByteArray newHash
= QCryptographicHash::hash(m_projectFileContents, QCryptographicHash::Sha1);
if (m_projectFileHash == newHash) {
finish(ParseResult::Cached);
return;
}
m_projectFileHash = newHash;
m_runningParserJobs = 0;
// Thread 1: Scan disk.
if (!m_rootPath.isEmpty()) {
m_treeScanner = new TreeScanner(this);
m_treeScanner->setFilter([this](const MimeType &mimeType, const FilePath &fn) {
// Mime checks requires more resources, so keep it last in check list
bool isIgnored = fn.startsWith(m_projectFilePath.path() + ".user")
|| TreeScanner::isWellKnownBinary(mimeType, fn);
// Cache mime check result for speed up
if (!isIgnored) {
if (auto it = m_mimeBinaryCache.get<std::optional<bool>>(
[mimeType](const QHash<QString, bool> &cache) -> std::optional<bool> {
const auto cache_it = cache.find(mimeType.name());
if (cache_it != cache.end())
return *cache_it;
return {};
})) {
isIgnored = *it;
} else {
isIgnored = TreeScanner::isMimeBinary(mimeType, fn);
m_mimeBinaryCache.writeLocked()->insert(mimeType.name(), isIgnored);
}
}
return isIgnored;
});
m_treeScanner->setTypeFactory([](const MimeType &mimeType, const FilePath &fn) {
return TreeScanner::genericFileType(mimeType, fn);
});
m_treeScanner->asyncScanForFiles(m_rootPath);
Core::ProgressManager::addTask(m_treeScanner->future(),
Tr::tr("Scan \"%1\" project tree").arg(m_projectName),
"CompilationDatabase.Scan.Tree");
++m_runningParserJobs;
connect(m_treeScanner, &TreeScanner::finished,
this, &CompilationDbParser::parserJobFinished);
}
// Thread 2: Parse the project file.
const auto future = Utils::asyncRun(parseProject, m_projectFileContents, m_projectFilePath);
Core::ProgressManager::addTask(future,
Tr::tr("Parse \"%1\" project").arg(m_projectName),
"CompilationDatabase.Parse");
++m_runningParserJobs;
m_parserWatcher.setFuture(future);
Utils::futureSynchronizer()->addFuture(future);
}
void CompilationDbParser::stop()
{
disconnect();
m_parserWatcher.disconnect();
m_parserWatcher.cancel();
if (m_treeScanner) {
m_treeScanner->disconnect();
m_treeScanner->future().cancel();
}
m_guard = {};
deleteLater();
}
QList<FileNode *> CompilationDbParser::scannedFiles() const
{
const bool canceled = m_treeScanner->future().isCanceled();
TreeScanner::Result result = m_treeScanner->release();
return !canceled ? result.takeAllFiles() : QList<FileNode *>();
}
void CompilationDbParser::parserJobFinished()
{
if (--m_runningParserJobs == 0)
finish(ParseResult::Success);
}
void CompilationDbParser::finish(ParseResult result)
{
if (result != ParseResult::Failure)
m_guard.markAsSuccess();
emit finished(result);
deleteLater();
}
} // namespace CompilationDatabaseProjectManager::Internal
|
