Differential D17278 Diff 46704 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​ }
83​ }
84​}
85​
86​MesonBuilder::DirectoryStatus MesonBuilder::evaluateBuildDirectory(const Path& path, QString const& backend)
87​{
88​ QString pathSTR = path.toLocalFile();
89​ if (pathSTR.isEmpty()) {
90​ return EMPTY_STRING;
91​ }
92​
93​ QFileInfo info(pathSTR);
94​ if (!info.exists()) {
95​ return DOES_NOT_EXIST;
96​ }
97​
98​ if (!info.isDir() || !info.isReadable() || !info.isWritable()) {
99​ return INVALID_BUILD_DIR;
100​ }
101​
102​ QDir dir(path.toLocalFile());
103​ if (dir.isEmpty(QDir::NoDotAndDotDot | QDir::Hidden | QDir::AllEntries)) {
104​ return CLEAN;
105​ }
106​
107​ // Check if the directory is a meson directory
108​ const static QStringList mesonPaths = { QStringLiteral("meson-logs"), QStringLiteral("meson-private") };
109​ for (auto const& i : mesonPaths) {
110​ Path curr = path;
111​ curr.addPath(i);
112​ QFileInfo currFI(curr.toLocalFile());
113​ if (!currFI.exists()) {
114​ return DIR_NOT_EMPTY;
115​ }
116​ }
117​
118​ // Also check if the meson configuration succeeded. This should be the case if the backend file exists.
119​ // Meson actually cheks for meson-private/coredata.dat, this might change in the future.
yurchorUnsubmitted
Done

Typo: cheks -> checks

yurchor: Typo: cheks -> checks
120​ // see: https://github.com/mesonbuild/meson/blob/master/mesonbuild/msetup.py#L117
121​ QStringList configured = {};
122​ if(backend == QStringLiteral("ninja")) {
123​ configured << QStringLiteral("build.ninja");
124​ }
125​
126​ // Check if this is a CONFIGURED meson directory
127​ for (auto const& i : configured) {
128​ Path curr = path;
129​ curr.addPath(i);
130​ QFileInfo currFI(curr.toLocalFile());
131​ if (!currFI.exists()) {
132​ return MESON_FAILED_CONFIGURATION;
133​ }
134​ }
135​
136​ return MESON_CONFIGURED;
137​}
138​
139​KJob* MesonBuilder::configure(IProject* project, const Meson::BuildDir& buildDir, DirectoryStatus status)
140​{
141​ Q_ASSERT(project);
142​
143​ if (!buildDir.isValid()) {
144​ return new ErrorJob(this, i18n("The current build directory for %1 is invalid", project->name()));
145​ }
146​
147​ if (status == ___UNDEFINED___) {
148​ status = evaluateBuildDirectory(buildDir.buildDir, buildDir.mesonBackend);
149​ }
150​
151​ KJob* job = nullptr;
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​
153​ switch (status) {
154​ case DOES_NOT_EXIST:
155​ case CLEAN:
156​ case MESON_FAILED_CONFIGURATION:
yurchorUnsubmitted
Done

Typo: can not -> cannot

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