Differential D17278 Diff 48734 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​ setStandardToolView(IOutputView::BuildView);
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​
50​ void start() override
51​ {
52​ auto* output = new OutputModel(this);
53​ setModel(output);
54​ startOutput();
55​
56​ output->appendLine(i18n(" *** MESON ERROR ***\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​ QStringList lines = m_error.split(QChar::fromLatin1('\n'));
58​ output->appendLines(lines);
rizzitelloUnsubmitted
Done

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

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

Typo: cheks -> checks

yurchor: Typo: cheks -> checks
121​
122​ // Also check if the meson configuration succeeded. This should be the case if the backend file exists.
123​ // Meson actually checks for meson-private/coredata.dat, this might change in the future.
124​ // see: https://github.com/mesonbuild/meson/blob/master/mesonbuild/msetup.py#L117
125​ QStringList configured = {};
126​ if (backend == QStringLiteral("ninja")) {
127​ configured << QStringLiteral("build.ninja");
128​ }
129​
130​ // Check if this is a CONFIGURED meson directory
131​ for (auto const& i : configured) {
132​ Path curr = path;
133​ curr.addPath(i);
134​ QFileInfo currFI(curr.toLocalFile());
135​ if (!currFI.exists()) {
136​ return MESON_FAILED_CONFIGURATION;
137​ }
138​ }
139​
140​ return MESON_CONFIGURED;
141​}
142​
143​KJob* MesonBuilder::configure(IProject* project, const Meson::BuildDir& buildDir, DirectoryStatus status)
144​{
145​ Q_ASSERT(project);
146​
147​ if (!buildDir.isValid()) {
148​ return new ErrorJob(this, i18n("The current build directory for %1 is invalid", project->name()));
149​ }
150​
151​ if (status == ___UNDEFINED___) {
yurchorUnsubmitted
Done

Typo: seam -> seem

yurchor: Typo: seam -> seem
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…
152​ status = evaluateBuildDirectory(buildDir.buildDir, buildDir.mesonBackend);
153​ }
154​
155​ KJob* job = nullptr;
156​
yurchorUnsubmitted
Done

Typo: can not -> cannot

yurchor: Typo: can not -> cannot
157​ switch (status) {
158​ case DOES_NOT_EXIST:
159​ case CLEAN:
160​ case MESON_FAILED_CONFIGURATION:
161​ job = new MesonJob(buildDir, project, MesonJob::CONFIGURE, {}, this);
162​ connect(job, &KJob::result, this, [this, project]() { emit configured(project); });
163​ return job;
164​ case MESON_CONFIGURED:
165​ job = new MesonJob(buildDir, project, MesonJob::RE_CONFIGURE, {}, this);
166​ connect(job, &KJob::result, this, [this, project]() { emit configured(project); });
167​ return job;
168​ case DIR_NOT_EMPTY:
169​ return new ErrorJob(
170​ this,
171​ i18n("The directory '%1' is not empty and does not seem to be an already configured build directory",
172​ buildDir.buildDir.toLocalFile()));
173​ case INVALID_BUILD_DIR:
174​ return new ErrorJob(
175​ this,
176​ i18n("The directory '%1' cannot be used as a meson build directory", buildDir.buildDir.toLocalFile()));
177​ case EMPTY_STRING:
178​ return new ErrorJob(
179​ this, i18n("The current build configuration is broken, because the build directory is not specified"));
180​ default:
181​ // This code should NEVER be reached
182​ return new ErrorJob(this,
183​ i18n("Congratulations: You have reached unreachable code!\n"
184​ "Please report a bug at https://bugs.kde.org/\n"
185​ "FILE: %1:%2",
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​ QStringLiteral(__FILE__), __LINE__));
187​ }
188​}
189​
190​KJob* MesonBuilder::configure(KDevelop::IProject* project)
191​{
192​ Q_ASSERT(project);
193​ auto buildDir = Meson::currentBuildDir(project);
194​ return configure(project, buildDir);
195​}
196​
197​KJob* MesonBuilder::configureIfRequired(KDevelop::IProject* project, KJob* realJob)
198​{
199​ Q_ASSERT(project);
200​ Meson::BuildDir buildDir = Meson::currentBuildDir(project);
201​ DirectoryStatus status = evaluateBuildDirectory(buildDir.buildDir, buildDir.mesonBackend);
202​
203​ if (status == MESON_CONFIGURED) {
204​ return realJob;
205​ }
206​
207​ QList<KJob*> jobs = {
208​ configure(project, buildDir, status), // First configure the build directory
209​ realJob // If this succeeds execute the real job
210​ };
211​
212​ return new ExecuteCompositeJob(this, jobs);
213​}
214​
215​KJob* MesonBuilder::build(KDevelop::ProjectBaseItem* item)
216​{
217​ Q_ASSERT(item);
218​ Q_ASSERT(m_ninjaBuilder);
219​ return configureIfRequired(item->project(), m_ninjaBuilder->build(item));
220​}
221​
222​KJob* MesonBuilder::clean(KDevelop::ProjectBaseItem* item)
223​{
224​ Q_ASSERT(item);
225​ Q_ASSERT(m_ninjaBuilder);
226​ return configureIfRequired(item->project(), m_ninjaBuilder->clean(item));
227​}
228​
229​KJob* MesonBuilder::install(KDevelop::ProjectBaseItem* item, const QUrl& installPath)
230​{
231​ Q_ASSERT(item);
232​ Q_ASSERT(m_ninjaBuilder);
233​ return configureIfRequired(item->project(), m_ninjaBuilder->install(item, installPath));
234​}
235​
236​KJob* MesonBuilder::prune(KDevelop::IProject* project)
237​{
238​ Q_ASSERT(project);
239​ Meson::BuildDir buildDir = Meson::currentBuildDir(project);
240​ if (!buildDir.isValid()) {
241​ qCWarning(KDEV_Meson) << "The current build directory is invalid";
242​ return new ErrorJob(this, i18n("The current build directory for %1 is invalid", project->name()));
243​ }
244​
245​ KJob* job = new MesonJobPrune(buildDir, this);
246​ connect(job, &KJob::result, this, [this, project]() { emit pruned(project); });
247​ return job;
248​}
249​
250​QList<IProjectBuilder*> MesonBuilder::additionalBuilderPlugins(IProject*) const
251​{
252​ return { m_ninjaBuilder };
253​}
254​
255​bool MesonBuilder::hasError() const
256​{
257​ return m_errorString.size() > 0;
258​}
259​
260​QString MesonBuilder::errorDescription() const
261​{
262​ return m_errorString;
263​}
264​
265​#include "mesonbuilder.moc"