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
|
/* This file is part of KDevelop
Copyright 2012 Aleix Pol Gonzalez <aleixpol@kde.org>
Copyright 2017 Kevin Funk <kfunk@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License version 2 as published by the Free Software Foundation.
This library 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
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#include "ninjabuilder.h"
#include "ninjajob.h"
#include "ninjabuilderpreferences.h"
#include <debug.h>
#include <KPluginFactory>
#include <KConfigGroup>
#include <KShell>
#include <project/projectmodel.h>
#include <project/interfaces/ibuildsystemmanager.h>
#include <project/builderjob.h>
#include <interfaces/iproject.h>
#include <QFile>
K_PLUGIN_FACTORY_WITH_JSON(NinjaBuilderFactory, "kdevninja.json", registerPlugin<NinjaBuilder>(); )
NinjaBuilder::NinjaBuilder(QObject* parent, const QVariantList&)
: KDevelop::IPlugin(QStringLiteral("kdevninja"), parent)
{
if (NinjaJob::ninjaExecutable().isEmpty()) {
setErrorDescription(i18n("Unable to find ninja executable. Is it installed on the system?"));
}
}
static QStringList targetsInFolder(KDevelop::ProjectFolderItem* item)
{
QStringList ret;
const auto targets = item->targetList();
ret.reserve(targets.size());
for (auto* target : targets) {
ret += target->text();
}
return ret;
}
/**
* Returns the first non-empty list of targets in folder @p item
* or any of its ancestors if possible
*/
static QStringList closestTargetsForFolder(KDevelop::ProjectFolderItem* item)
{
KDevelop::ProjectFolderItem* current = item;
while (current) {
const QStringList targets = targetsInFolder(current);
if (!targets.isEmpty()) {
return targets;
}
current = (current->parent() ? current->parent()->folder() : nullptr);
}
return QStringList();
}
static QStringList argumentsForItem(KDevelop::ProjectBaseItem* item)
{
if (!item->parent() &&
QFile::exists(item->project()->buildSystemManager()->buildDirectory(item->project()->projectItem()).toLocalFile())) {
return QStringList();
}
switch (item->type()) {
case KDevelop::ProjectBaseItem::File:
return QStringList(item->path().toLocalFile() + QLatin1Char('^'));
case KDevelop::ProjectBaseItem::Target:
case KDevelop::ProjectBaseItem::ExecutableTarget:
case KDevelop::ProjectBaseItem::LibraryTarget:
return QStringList(item->target()->text());
case KDevelop::ProjectBaseItem::Folder:
case KDevelop::ProjectBaseItem::BuildFolder:
return closestTargetsForFolder(item->folder());
}
return QStringList();
}
NinjaJob* NinjaBuilder::runNinja(KDevelop::ProjectBaseItem* item, NinjaJob::CommandType commandType,
const QStringList& args, const QByteArray& signal)
{
///Running the same builder twice may result in serious problems,
///so kill jobs already running on the same project
const auto ninjaJobs = m_activeNinjaJobs.data();
for (NinjaJob* ninjaJob : ninjaJobs) {
if (item && ninjaJob->item() && ninjaJob->item()->project() == item->project() && ninjaJob->commandType() == commandType) {
qCDebug(NINJABUILDER) << "killing running ninja job, due to new started build on same project:" << ninjaJob;
ninjaJob->kill(KJob::EmitResult);
}
}
// Build arguments using data from KCM
QStringList jobArguments;
KSharedConfigPtr config = item->project()->projectConfiguration();
KConfigGroup group = config->group("NinjaBuilder");
if (!group.readEntry("Abort on First Error", true)) {
jobArguments << QStringLiteral("-k");
}
if (group.readEntry("Override Number Of Jobs", false)) {
int jobCount = group.readEntry("Number Of Jobs", 1);
if (jobCount > 0) {
jobArguments << QStringLiteral("-j%1").arg(jobCount);
}
}
int errorCount = group.readEntry("Number Of Errors", 1);
if (errorCount > 1) {
jobArguments << QStringLiteral("-k%1").arg(errorCount);
}
if (group.readEntry("Display Only", false)) {
jobArguments << QStringLiteral("-n");
}
QString extraOptions = group.readEntry("Additional Options", QString());
if (!extraOptions.isEmpty()) {
const auto options = KShell::splitArgs(extraOptions);
for (const QString& option : options) {
jobArguments << option;
}
}
jobArguments << args;
auto* job = new NinjaJob(item, commandType, jobArguments, signal, this);
m_activeNinjaJobs.append(job);
return job;
}
KJob* NinjaBuilder::build(KDevelop::ProjectBaseItem* item)
{
return runNinja(item, NinjaJob::BuildCommand, argumentsForItem(item), "built");
}
KJob* NinjaBuilder::clean(KDevelop::ProjectBaseItem* item)
{
return runNinja(item, NinjaJob::CleanCommand, QStringList(QStringLiteral("-t")) << QStringLiteral("clean"), "cleaned");
}
KJob* NinjaBuilder::install(KDevelop::ProjectBaseItem* item)
{
NinjaJob* installJob = runNinja(item, NinjaJob::InstallCommand, QStringList(QStringLiteral("install")), "installed");
installJob->setIsInstalling(true);
KSharedConfigPtr configPtr = item->project()->projectConfiguration();
KConfigGroup builderGroup(configPtr, "NinjaBuilder");
bool installAsRoot = builderGroup.readEntry("Install As Root", false);
if (installAsRoot) {
auto* job = new KDevelop::BuilderJob;
job->addCustomJob(KDevelop::BuilderJob::Build, build(item), item);
job->addCustomJob(KDevelop::BuilderJob::Install, installJob, item);
job->updateJobName();
return job;
} else {
return installJob;
}
}
int NinjaBuilder::perProjectConfigPages() const
{
return 1;
}
KDevelop::ConfigPage* NinjaBuilder::perProjectConfigPage(int number, const KDevelop::ProjectConfigOptions& options, QWidget* parent)
{
if (number == 0) {
return new NinjaBuilderPreferences(this, options, parent);
}
return nullptr;
}
class ErrorJob
: public KJob
{
Q_OBJECT
public:
ErrorJob(QObject* parent, const QString& error)
: KJob(parent)
, m_error(error)
{}
void start() override
{
setError(!m_error.isEmpty());
setErrorText(m_error);
emitResult();
}
private:
QString m_error;
};
KJob* NinjaBuilder::install(KDevelop::ProjectBaseItem* dom, const QUrl& installPath)
{
return installPath.isEmpty() ? install(dom) : new ErrorJob(nullptr, i18n("Cannot specify prefix in %1, on ninja", installPath.toDisplayString()));
}
#include "ninjabuilder.moc"
|
