Differential D17278 Diff 46623 plugins/meson/mesonbuilder.cpp

Changeset View

Standalone View

View Options

plugins/meson/mesonbuilder.cpp

  • This file was added.
1​/* This file is part of KDevelop
2​ Copyright 2017 Aleix Pol Gonzalez <aleixpol@kde.org>
3​ Copyright 2018 Daniel Mensinger <daniel@mensinger-ka.de>
4​
5​ This library is free software; you can redistribute it and/or
6​ modify it under the terms of the GNU Library General Public
7​ License as published by the Free Software Foundation; either
8​ version 2 of the License, or (at your option) any later version.
9​
10​ This library is distributed in the hope that it will be useful,
11​ but WITHOUT ANY WARRANTY; without even the implied warranty of
12​ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13​ Library General Public License for more details.
14​
15​ You should have received a copy of the GNU Library General Public License
16​ along with this library; see the file COPYING.LIB. If not, write to
17​ the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18​ Boston, MA 02110-1301, USA.
19​*/
20​
21​#include "mesonbuilder.h"
22​#include "mesonconfig.h"
23​#include "mesonjob.h"
24​#include "mesonjobprune.h"
25​#include <QDir>
26​#include <QFileInfo>
27​#include <debug.h>
28​#include <executecompositejob.h>
29​#include <interfaces/icore.h>
30​#include <interfaces/iplugincontroller.h>
31​#include <interfaces/iproject.h>
32​#include <klocalizedstring.h>
33​#include <outputview/outputexecutejob.h>
34​#include <project/projectmodel.h>
35​#include <util/path.h>
36​
37​using namespace KDevelop;
38​
39​class ErrorJob : public OutputJob
40​{
41​ Q_OBJECT
42​public:
43​ ErrorJob(QObject* parent, const QString& error)
44​ : OutputJob(parent)
45​ , m_error(error)
46​ {
47​ }
flherneUnsubmitted
Done

This needs setStandardToolView(KDevelop::IOutputView::BuildView); or similar, otherwise the output appears as a separate view with no name or icon.

flherne: This needs `setStandardToolView(KDevelop::IOutputView::BuildView);` or similar, otherwise the…
48​
49​ void start() override
50​ {
51​ auto* output = new OutputModel(this);
52​ setModel(output);
53​ startOutput();
54​
55​ output->appendLine(i18n(" *** MESON ERROR ***\n"));
56​ QStringList lines = m_error.split(QChar::fromLatin1('\n'));
rizzitelloUnsubmitted
Done

Would ending the string with a \n (or two) remove the need to append an empty QStringLiteral in the next line?

rizzitello: Would ending the string with a \n (or two) remove the need to append an empty QStringLiteral in…
57​ output->appendLines(lines);
58​
rizzitelloUnsubmitted
Done

QChar::fromLatin1('\n') instead of the older cast ?

rizzitello: QChar::fromLatin1('\n') instead of the older cast ?
59​ setError(!m_error.isEmpty());
60​ setErrorText(m_error);
61​ emitResult();
62​ }
63​
64​private:
65​ QString m_error;
66​};
67​
68​MesonBuilder::MesonBuilder(QObject* parent)
69​ : QObject(parent)
70​{
71​ auto p = KDevelop::ICore::self()->pluginController()->pluginForExtension(
72​ QStringLiteral("org.kdevelop.IProjectBuilder"), QStringLiteral("KDevNinjaBuilder"));
73​ if (p) {
74​ m_ninjaBuilder = p->extension<KDevelop::IProjectBuilder>();
75​ if (m_ninjaBuilder) {
76​ connect(p, SIGNAL(built(KDevelop::ProjectBaseItem*)), this, SIGNAL(built(KDevelop::ProjectBaseItem*)));
77​ connect(p, SIGNAL(installed(KDevelop::ProjectBaseItem*)), this,
78​ SIGNAL(installed(KDevelop::ProjectBaseItem*)));
79​ connect(p, SIGNAL(cleaned(KDevelop::ProjectBaseItem*)), this, SIGNAL(cleaned(KDevelop::ProjectBaseItem*)));
80​ connect(p, SIGNAL(failed(KDevelop::ProjectBaseItem*)), this, SIGNAL(failed(KDevelop::ProjectBaseItem*)));
81​ }
82​ }
83​}
84​
85​MesonBuilder::DirectoryStatus MesonBuilder::evaluateBuildDirectory(const Path& path, QString const& backend)
86​{
87​ QString pathSTR = path.toLocalFile();
88​ if (pathSTR.isEmpty()) {
89​ return EMPTY_STRING;
90​ }
91​
92​ QFileInfo info(pathSTR);
93​ if (!info.exists()) {
94​ return DOES_NOT_EXIST;
95​ }
96​
97​ if (!info.isDir() || !info.isReadable() || !info.isWritable()) {
98​ return INVALID_BUILD_DIR;
99​ }
100​
101​ QDir dir(path.toLocalFile());
102​ if (dir.isEmpty(QDir::NoDotAndDotDot | QDir::Hidden | QDir::AllEntries)) {
103​ return CLEAN;
104​ }
105​
106​ QStringList requiredPaths = { QStringLiteral("meson-logs"), QStringLiteral("meson-private") };
107​ if (backend == QStringLiteral("ninja")) {
108​ requiredPaths += QStringLiteral("build.ninja");
109​ }
110​
111​ // Check if this is a meson directory
112​ QStringList entries = dir.entryList();
113​ for (auto const& i : requiredPaths) {
114​ if (!entries.contains(i)) {
115​ return DIR_NOT_EMPTY;
116​ }
117​ }
118​
119​ return MESON_CONFIGURED;
120​}
yurchorUnsubmitted
Done

Typo: cheks -> checks

yurchor: Typo: cheks -> checks
121​
122​KJob* MesonBuilder::configure(IProject* project, const Meson::BuildDir& buildDir, DirectoryStatus status)
123​{
124​ Q_ASSERT(project);
125​
126​ if (!buildDir.isValid()) {
127​ return new ErrorJob(this, i18n("The current build directory for %1 is invalid", project->name()));
128​ }
129​
130​ if (status == ___UNDEFINED___) {
131​ status = evaluateBuildDirectory(buildDir.buildDir, buildDir.mesonBackend);
132​ }
133​
134​ KJob* job = nullptr;
135​
136​ switch (status) {
137​ case DOES_NOT_EXIST:
138​ case CLEAN:
139​ job = new MesonJob(buildDir, project, MesonJob::CONFIGURE, {}, this);
140​ connect(job, &KJob::result, this, [this, project]() { emit configured(project); });
141​ return job;
142​ case MESON_CONFIGURED:
143​ job = new MesonJob(buildDir, project, MesonJob::RE_CONFIGURE, {}, this);
144​ connect(job, &KJob::result, this, [this, project]() { emit configured(project); });
145​ return job;
146​ case DIR_NOT_EMPTY:
147​ return new ErrorJob(
148​ this,
149​ i18n("The directory '%1' is not empty and does not seem to be an already configured build directory",
150​ buildDir.buildDir.toLocalFile()));
flherneUnsubmitted
Done

This condition is reached in case a previous configure attempt failed, e.g. because of a missing dependency.

KDevelop refuses to re-try the configure step (after installing the dependency) until the build dir is removed, which is quite inconvenient.

flherne: This condition is reached in case a previous configure attempt failed, e.g. because of a…
151​ case INVALID_BUILD_DIR:
yurchorUnsubmitted
Done

Typo: seam -> seem

yurchor: Typo: seam -> seem
152​ return new ErrorJob(
153​ this,
154​ i18n("The directory '%1' cannot be used as a meson build directory", buildDir.buildDir.toLocalFile()));
155​ case EMPTY_STRING:
156​ return new ErrorJob(
yurchorUnsubmitted
Done

Typo: can not -> cannot

yurchor: Typo: can not -> cannot
157​ this, i18n("The current build configuration is broken, because the build directory is not specified"));
158​ default:
159​ // This code should NEVER be reached
160​ return new ErrorJob(this,
161​ i18n("Congratulations: You have reached unreachable code!\n"
162​ "Please report a bug at https://bugs.kde.org/\n"
163​ "FILE: %1:%2",
164​ QStringLiteral(__FILE__), __LINE__));
165​ }
166​}
167​
168​KJob* MesonBuilder::configure(KDevelop::IProject* project)
169​{
170​ Q_ASSERT(project);
171​ auto buildDir = Meson::currentBuildDir(project);
172​ return configure(project, buildDir);
173​}
174​
175​KJob* MesonBuilder::configureIfRequired(KDevelop::IProject* project, KJob* realJob)
176​{
177​ Q_ASSERT(project);
178​ Meson::BuildDir buildDir = Meson::currentBuildDir(project);
179​ DirectoryStatus status = evaluateBuildDirectory(buildDir.buildDir, buildDir.mesonBackend);
180​
181​ if (status == MESON_CONFIGURED) {
182​ return realJob;
183​ }
184​
185​ QList<KJob*> jobs = {
rizzitelloUnsubmitted
Done

Else is not needed since the if ends with a return.

rizzitello: Else is not needed since the if ends with a return.
186​ configure(project, buildDir, status), // First configure the build directory
187​ realJob // If this succeeds execute the real job
188​ };
189​
190​ return new ExecuteCompositeJob(this, jobs);
191​}
192​
193​KJob* MesonBuilder::build(KDevelop::ProjectBaseItem* item)
194​{
195​ Q_ASSERT(item);
196​ return configureIfRequired(item->project(), m_ninjaBuilder->build(item));
197​}
198​
199​KJob* MesonBuilder::clean(KDevelop::ProjectBaseItem* item)
200​{
201​ Q_ASSERT(item);
202​ return configureIfRequired(item->project(), m_ninjaBuilder->clean(item));
203​}
204​
205​KJob* MesonBuilder::install(KDevelop::ProjectBaseItem* item, const QUrl& installPath)
206​{
207​ Q_ASSERT(item);
208​ return configureIfRequired(item->project(), m_ninjaBuilder->install(item, installPath));
209​}
210​
211​KJob* MesonBuilder::prune(KDevelop::IProject* project)
212​{
213​ Q_ASSERT(project);
214​ Meson::BuildDir buildDir = Meson::currentBuildDir(project);
215​ if (!buildDir.isValid()) {
216​ qCWarning(KDEV_Meson) << "The current build directory is invalid";
217​ return new ErrorJob(this, i18n("The current build directory for %1 is invalid", project->name()));
218​ }
219​
220​ KJob* job = new MesonJobPrune(buildDir, this);
221​ connect(job, &KJob::result, this, [this, project]() { emit pruned(project); });
222​ return job;
223​}
224​
225​QList<IProjectBuilder*> MesonBuilder::additionalBuilderPlugins(IProject*) const
226​{
227​ return { m_ninjaBuilder };
228​}
229​
230​#include "mesonbuilder.moc"