Differential D16484 Diff 44451 plugins/scratchpad/scratchpadjob.cpp

Changeset View

Standalone View

View Options

plugins/scratchpad/scratchpadjob.cpp

  • This file was added.
1​/* This file is part of KDevelop
2​ *
3​ * Copyright 2018 Amish K. Naidu <amhndu@gmail.com>
4​ *
5​ * This program is free software; you can redistribute it and/or
6​ * modify it under the terms of the GNU General Public License
7​ * as published by the Free Software Foundation; either version 2
8​ * of the License, or (at your option) any later version.
9​ *
10​ * This program 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
13​ * GNU General Public License for more details.
14​ *
15​ * You should have received a copy of the GNU General Public License
16​ * along with this program; if not, write to the Free Software
17​ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
18​ * 02110-1301, USA.
19​ */
20​
21​#include "scratchpadjob.h"
22​#include "scratchpad.h"
23​
24​#include <debug.h>
25​
26​#include <outputview/outputmodel.h>
27​#include <util/processlinemaker.h>
28​
29​#include <KProcess>
30​#include <KLocalizedString>
31​
32​#include <QMetaEnum>
33​#include <QStandardItem>
34​
35​ScratchpadJob::ScratchpadJob(const QStandardItem* item, const QString& compiler,
36​ const QString& command, QObject* parent)
37​ : KDevelop::OutputJob(parent)
38​ , m_item(item)
39​ , m_process(new KProcess(this))
40​ , m_lineMaker(new KDevelop::ProcessLineMaker(m_process, this))
41​{
42​ qCDebug(PLUGIN_SCRATCHPAD) << "Creating job for" << item->text();
43​
44​ QString substituted = command;
45​ substituted.replace(QStringLiteral("$cc"), compiler);
46​ substituted.replace(QStringLiteral("$f"), item->data(Scratchpad::FullPathRole).toString());
47​
48​ if (!substituted.isEmpty()) {
49​ m_process->setShellCommand(substituted);
brauchUnsubmitted
Done

You need to check whether the command is non-empty, otherwise you create unkillable zombie processes.

brauch: You need to check whether the command is non-empty, otherwise you create unkillable zombie…
50​ setCapabilities(Killable);
51​
52​ setStandardToolView(KDevelop::IOutputView::RunView);
53​ setTitle(i18n("scratch:%1", item->text()));
brauchUnsubmitted
Done

I think the i18n calls with the word "scratch" need a context, otherwise translators will not know what's going on here

brauch: I think the i18n calls with the word "scratch" need a context, otherwise translators will not…
amhnduAuthorUnsubmitted
Done

I'm not sure how to do that. Does this even require i18n ?

amhndu: I'm not sure how to do that. Does this even require i18n ?
brauchUnsubmitted
Done

Look at "i18nc". I think it does, yes, all user-visible strings should be wrapped in i18n calls.

brauch: Look at "i18nc". I think it does, yes, all user-visible strings should be wrapped in i18n calls.
54​
55​ auto* model = new KDevelop::OutputModel(this);
56​ setModel(model);
57​
58​ connect(m_lineMaker, &KDevelop::ProcessLineMaker::receivedStdoutLines,
59​ model, &KDevelop::OutputModel::appendLines);
60​ connect(m_lineMaker, &KDevelop::ProcessLineMaker::receivedStderrLines,
61​ model, &KDevelop::OutputModel::appendLines);
62​ m_process->setOutputChannelMode(KProcess::MergedChannels);
63​ connect(m_process, QOverload<int, QProcess::ExitStatus>::of(&KProcess::finished),
brauchUnsubmitted
Done
QOverload<int, QProcess::ExitStatus>::of(&KProcess::finished)
brauch: ``` QOverload<int, QProcess::ExitStatus>::of(&KProcess::finished) ```
64​ this, &ScratchpadJob::processFinished);
65​ connect(m_process, &KProcess::errorOccurred, this, &ScratchpadJob::processError);
66​ } else {
67​ qCCritical(PLUGIN_SCRATCHPAD) << "Empty command in scratch job.";
68​ deleteLater();
69​ }
70​}
71​
72​void ScratchpadJob::start()
73​{
74​ startOutput();
75​ outputModel()->appendLine(i18n("Running %1...", m_process->program().join(QLatin1Char(' '))));
76​ m_process->start();
77​}
78​
79​bool ScratchpadJob::doKill()
80​{
81​ qCDebug(PLUGIN_SCRATCHPAD) << "killing process";
82​ m_process->kill();
83​ return true;
84​}
85​
86​void ScratchpadJob::processFinished(int exitCode, QProcess::ExitStatus)
87​{
88​ qCDebug(PLUGIN_SCRATCHPAD) << "finished process";
89​ m_lineMaker->flushBuffers();
90​ outputModel()->appendLine(i18n("Process finished with exit code %1.", exitCode));
91​ emitResult();
92​}
93​
brauchUnsubmitted
Done

This is always an internal error, i.e. this plugin doing something wrong. I think it should be presented to the user as such.

brauch: This is always an internal error, i.e. this plugin doing something wrong. I think it should be…
amhnduAuthorUnsubmitted
Done

"Failed to run scratch: %1" ?

amhndu: "Failed to run scratch: %1" ?
brauchUnsubmitted
Done

Something like that, yeah. It's an error which occured with the process, not an error the process itself encountered.

brauch: Something like that, yeah. It's an error which occured with the process, not an error the…
94​void ScratchpadJob::processError(QProcess::ProcessError error)
95​{
96​ qCDebug(PLUGIN_SCRATCHPAD) << "process encountered error" << error;
97​ outputModel()->appendLine(i18n("Process encountered error: %1.",
98​ QLatin1String(QMetaEnum::fromType<QProcess::ProcessError>().valueToKey(error))));
99​ emitResult();
100​}
kfunkUnsubmitted
Done

const

kfunk: `const`
amhnduAuthorUnsubmitted
Not Done

see line 94 right above, can't be const

amhndu: see line 94 right above, can't be const
kfunkUnsubmitted
Not Done

Dito

kfunk: Dito
101​
102​KDevelop::OutputModel* ScratchpadJob::outputModel()
103​{
104​ return static_cast<KDevelop::OutputModel*>(model());
105​}