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
|
/****************************************************************************
**
** Copyright (C) 2019 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** 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 The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/
#include "executableinfo.h"
#include <coreplugin/icore.h>
#include <coreplugin/messagemanager.h>
#include <utils/environment.h>
#include <utils/synchronousprocess.h>
#include <QDir>
#include <QFileInfo>
#include <QJsonArray>
#include <QJsonDocument>
#include <QJsonObject>
#include <QTextStream>
using namespace Utils;
namespace ClangTools {
namespace Internal {
enum class FailSilently { Yes, No };
static QString runExecutable(const Utils::CommandLine &commandLine,
FailSilently failSilently = FailSilently::No)
{
if (commandLine.executable().isEmpty() || !commandLine.executable().toFileInfo().isExecutable())
return {};
SynchronousProcess cpp;
Utils::Environment env = Environment::systemEnvironment();
Environment::setupEnglishOutput(&env);
cpp.setEnvironment(env.toStringList());
const SynchronousProcessResponse response = cpp.runBlocking(commandLine);
if (response.result != SynchronousProcessResponse::Finished
&& (failSilently == FailSilently::No
|| response.result != SynchronousProcessResponse::FinishedError)) {
Core::MessageManager::write(response.exitMessage(commandLine.toUserOutput(), 10));
Core::MessageManager::write(QString::fromUtf8(response.allRawOutput()));
return {};
}
return response.allOutput();
}
static QStringList queryClangTidyChecks(const QString &executable,
const QString &checksArgument)
{
QStringList arguments = QStringList("-list-checks");
if (!checksArgument.isEmpty())
arguments.prepend(checksArgument);
const CommandLine commandLine(executable, arguments);
QString output = runExecutable(commandLine);
if (output.isEmpty())
return {};
// Expected output is (clang-tidy 8.0):
// Enabled checks:
// abseil-duration-comparison
// abseil-duration-division
// abseil-duration-factory-float
// ...
QTextStream stream(&output);
QString line = stream.readLine();
if (!line.startsWith("Enabled checks:"))
return {};
QStringList checks;
while (!stream.atEnd()) {
const QString candidate = stream.readLine().trimmed();
if (!candidate.isEmpty())
checks << candidate;
}
return checks;
}
static ClazyChecks querySupportedClazyChecks(const QString &executablePath)
{
static const QString queryFlag = "-supported-checks-json";
QString jsonOutput = runExecutable(CommandLine(executablePath, {queryFlag}));
// Some clazy 1.6.x versions have a bug where they expect an argument after the
// option.
if (jsonOutput.isEmpty())
jsonOutput = runExecutable(CommandLine(executablePath, {queryFlag, "dummy"}));
if (jsonOutput.isEmpty())
return {};
// Expected output is (clazy-standalone 1.6):
// {
// "available_categories" : ["readability", "qt4", "containers", ... ],
// "checks" : [
// {
// "name" : "qt-keywords",
// "level" : -1,
// "fixits" : [ { "name" : "qt-keywords" } ]
// },
// ...
// {
// "name" : "inefficient-qlist",
// "level" : -1,
// "categories" : ["containers", "performance"],
// "visits_decls" : true
// },
// ...
// ]
// }
ClazyChecks infos;
const QJsonDocument document = QJsonDocument::fromJson(jsonOutput.toUtf8());
if (document.isNull())
return {};
const QJsonArray checksArray = document.object()["checks"].toArray();
for (const QJsonValue &item: checksArray) {
const QJsonObject checkObject = item.toObject();
ClazyCheck info;
info.name = checkObject["name"].toString().trimmed();
if (info.name.isEmpty())
continue;
info.level = checkObject["level"].toInt();
for (const QJsonValue &item : checkObject["categories"].toArray())
info.topics.append(item.toString().trimmed());
infos << info;
}
return infos;
}
ClangTidyInfo::ClangTidyInfo(const QString &executablePath)
: defaultChecks(queryClangTidyChecks(executablePath, {}))
, supportedChecks(queryClangTidyChecks(executablePath, "-checks=*"))
{}
ClazyStandaloneInfo::ClazyStandaloneInfo(const QString &executablePath)
: defaultChecks(queryClangTidyChecks(executablePath, {})) // Yup, behaves as clang-tidy.
, supportedChecks(querySupportedClazyChecks(executablePath))
{}
static FilePath queryResourceDir(const FilePath &clangToolPath)
{
QString output = runExecutable(CommandLine(clangToolPath, {"someFilePath", "--",
"-print-resource-dir"}),
FailSilently::Yes);
// Expected output is (clang-tidy 10):
// lib/clang/10.0.1
// Error while trying to load a compilation database:
// ...
// Parse
QTextStream stream(&output);
const QString path = clangToolPath.parentDir().parentDir()
.pathAppended(stream.readLine()).toString();
const auto filePath = FilePath::fromUserInput(QDir::cleanPath(path));
if (filePath.exists())
return filePath;
return {};
}
static QString queryVersion(const FilePath &clangToolPath)
{
QString output = runExecutable(CommandLine(clangToolPath, {"--version"}));
QTextStream stream(&output);
while (!stream.atEnd()) {
static const QStringList versionPrefixes{"LLVM version ", "clang version: "};
const QString line = stream.readLine().simplified();
for (const QString &prefix : versionPrefixes) {
if (line.startsWith(prefix))
return line.mid(prefix.length());
}
}
return {};
}
QPair<FilePath, QString> getClangResourceDirAndVersion(const FilePath &clangToolPath)
{
const FilePath dynamicResourceDir = queryResourceDir(clangToolPath);
const QString dynamicVersion = queryVersion(clangToolPath);
if (dynamicResourceDir.isEmpty() || dynamicVersion.isEmpty())
return qMakePair(FilePath::fromString(CLANG_RESOURCE_DIR), QString(CLANG_VERSION));
return qMakePair(dynamicResourceDir, dynamicVersion);
}
} // namespace Internal
} // namespace ClangTools
|
