Differential D14288 Diff 39668 plugins/clazy/plugin.cpp

Changeset View

Standalone View

View Options

plugins/clazy/plugin.cpp

  • This file was added.
1​/* This file is part of KDevelop
2​
3​ Copyright 2018 Anton Anikin <anton@anikin.xyz>
4​
5​ This program is free software; you can redistribute it and/or
6​ modify it under the terms of the GNU 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 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 GNU
13​ 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; see the file COPYING. 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 "plugin.h"
22​
23​#include "checksdb.h"
24​#include "config/globalconfigpage.h"
25​#include "config/projectconfigpage.h"
26​#include "debug.h"
27​#include "globalsettings.h"
28​#include "problemmodel.h"
29​
30​#include <interfaces/contextmenuextension.h>
31​#include <interfaces/icore.h>
32​#include <interfaces/idocumentcontroller.h>
33​#include <interfaces/iprojectcontroller.h>
34​#include <interfaces/iruncontroller.h>
35​#include <interfaces/iuicontroller.h>
36​#include <language/interfaces/editorcontext.h>
37​#include <project/projectconfigpage.h>
38​#include <project/projectmodel.h>
39​#include <util/jobstatus.h>
40​
41​#include <KActionCollection>
42​#include <KMessageBox>
43​#include <KPluginFactory>
44​
45​#include <QApplication>
46​
47​K_PLUGIN_FACTORY_WITH_JSON(ClazyFactory, "kdevclazy.json", registerPlugin<Clazy::Plugin>();)
48​
49​namespace Clazy
50​{
51​
52​Plugin::Plugin(QObject* parent, const QVariantList&)
53​ : IPlugin("kdevclazy", parent)
54​ , m_job(nullptr)
55​ , m_project(nullptr)
56​ , m_model(new ProblemModel(this))
57​ , m_db(nullptr)
58​{
59​ setXMLFile("kdevclazy.rc");
60​
61​ reloadDB();
62​
63​ const QIcon clazyIcon = QIcon::fromTheme(QStringLiteral("clazy"));
kossebauUnsubmitted
Done

Ideally the loading of the db could be delayed until needed, given this is in the hotpath of starting.

kossebau: Ideally the loading of the db could be delayed until needed, given this is in the hotpath of…
antonanikinAuthorUnsubmitted
Not Done

Done. Now we check and load db at clazy start and at project config open.
Not so beautiful but works.

antonanikin: Done. Now we check and load db at clazy start and at project config open. Not so beautiful but…
64​
65​ m_menuActionFile = new QAction(clazyIcon, i18n("Analyze Current File with Clazy"), this);
66​ connect(m_menuActionFile, &QAction::triggered, this, [this](){
kossebauUnsubmitted
Done

IMHO the lambdas could be deduplicated (or perhaps turned into normal class methods, whatever is the better approach).

kossebau: IMHO the lambdas could be deduplicated (or perhaps turned into normal class methods, whatever…
67​ runClazy(false);
68​ });
69​ actionCollection()->addAction("clazy_file", m_menuActionFile);
70​
71​ m_contextActionFile = new QAction(clazyIcon, i18n("Clazy"), this);
72​ connect(m_contextActionFile, &QAction::triggered, this, [this]() {
73​ runClazy(false);
74​ });
75​
76​ m_menuActionProject = new QAction(clazyIcon, i18n("Analyze Current Project with Clazy"), this);
77​ connect(m_menuActionProject, &QAction::triggered, this, [this](){
78​ runClazy(true);
79​ });
80​ actionCollection()->addAction("clazy_project", m_menuActionProject);
81​
82​ m_contextActionProject = new QAction(clazyIcon, i18n("Clazy"), this);
83​ connect(m_contextActionProject, &QAction::triggered, this, [this]() {
84​ runClazy(true);
85​ });
86​
87​ m_contextActionProjectItem = new QAction(clazyIcon, i18n("Clazy"), this);
88​
89​ connect(core()->documentController(), &KDevelop::IDocumentController::documentClosed,
90​ this, &Plugin::updateActions);
91​
92​ connect(core()->documentController(), &KDevelop::IDocumentController::documentActivated,
93​ this, &Plugin::updateActions);
94​
95​ connect(core()->projectController(), &KDevelop::IProjectController::projectOpened,
96​ this, &Plugin::updateActions);
97​
98​ connect(core()->projectController(), &KDevelop::IProjectController::projectClosed,
99​ this, &Plugin::projectClosed);
100​
101​ updateActions();
102​}
103​
104​Plugin::~Plugin()
105​{
106​ killClazy();
107​}
108​
109​bool Plugin::isRunning() const
110​{
111​ return m_job;
kossebauUnsubmitted
Done

Other than in if-statements here IMHO an explicit != nullptr makes the code better to read on quick parsing.

kossebau: Other than in if-statements here IMHO an explicit `!= nullptr` makes the code better to read on…
112​}
113​
114​void Plugin::killClazy()
115​{
116​ if (m_job) {
117​ m_job->kill(KJob::EmitResult);
118​ }
119​}
120​
121​void Plugin::raiseProblemsView()
122​{
123​ m_model->show();
124​}
125​
126​void Plugin::raiseOutputView()
127​{
128​ core()->uiController()->findToolView(
129​ i18ndc("kdevstandardoutputview", "@title:window", "Test"),
130​ nullptr,
131​ KDevelop::IUiController::FindFlags::Raise);
132​}
133​
134​void Plugin::updateActions()
135​{
136​ m_project = nullptr;
137​
138​ m_menuActionFile->setEnabled(false);
139​ m_menuActionProject->setEnabled(false);
140​
141​ if (isRunning()) {
142​ return;
143​ }
144​
145​ auto activeDocument = core()->documentController()->activeDocument();
146​ if (!activeDocument) {
147​ return;
148​ }
149​
150​ m_project = core()->projectController()->findProjectForUrl(activeDocument->url());
151​ if (!m_project) {
152​ return;
153​ }
154​
155​ m_menuActionFile->setEnabled(true);
156​ m_menuActionProject->setEnabled(true);
157​}
158​
159​void Plugin::projectClosed(KDevelop::IProject* project)
160​{
161​ if (project != m_model->project()) {
162​ return;
163​ }
164​
165​ killClazy();
166​ m_model->reset();
167​}
168​
169​void Plugin::runClazy(bool checkProject)
170​{
171​ auto doc = core()->documentController()->activeDocument();
172​ Q_ASSERT(doc);
173​
174​ if (checkProject) {
175​ runClazy(m_project, m_project->path().toUrl().toLocalFile());
176​ } else {
177​ runClazy(m_project, doc->url().toLocalFile());
178​ }
179​}
180​
181​void Plugin::runClazy(KDevelop::IProject* project, const QString& path)
182​{
183​ JobParameters params(project, path);
184​
185​ if (!params.isValid()) {
186​ const QString errorMessage = i18n("Unable to start clazy check for \"%1\":\n\n%2", path, params.error());
187​ KMessageBox::error(qApp->activeWindow(), errorMessage, i18n("Clazy Error"));
188​ return;
pinoUnsubmitted
Done

This is a string puzzle that can be avoided, since you have the whole message at this point:

const QString errorMessage = i18n("Unable to start clazy check for \"%1\":\n\n%2", path, params.error());
pino: This is a string puzzle that can be avoided, since you have the whole message at this point…
189​ }
190​
191​ m_model->reset(project, path);
192​
193​ m_job = new Job(params, m_db);
194​
195​ connect(m_job, &Job::problemsDetected, m_model, &ProblemModel::addProblems);
196​ connect(m_job, &Job::finished, this, &Plugin::result);
197​
198​ core()->uiController()->registerStatus(new KDevelop::JobStatus(m_job, "clazy"));
199​ core()->runController()->registerJob(m_job);
200​
201​ if (GlobalSettings::hideOutputView()) {
202​ raiseProblemsView();
203​ } else {
204​ raiseOutputView();
205​ }
206​
207​ updateActions();
208​}
209​
210​void Plugin::result(KJob*)
211​{
212​ if (!core()->projectController()->projects().contains(m_model->project())) {
213​ m_model->reset();
214​ } else {
215​ m_model->setProblems();
216​
217​ if (m_job->status() == KDevelop::OutputExecuteJob::JobStatus::JobSucceeded ||
218​ m_job->status() == KDevelop::OutputExecuteJob::JobStatus::JobCanceled) {
219​
220​ raiseProblemsView();
221​ } else {
222​ raiseOutputView();
223​ }
224​ }
225​
226​ m_job = nullptr; // job is automatically deleted later
kossebauUnsubmitted
Done

be more explicit and ssay who takes care of that: "job automatically deletes itself later", so the code reader does not potentially wrongly expect the plugin code to do it elsewhere.

kossebau: be more explicit and ssay who takes care of that: "job automatically deletes itself later", so…
227​
228​ updateActions();
229​}
230​
231​KDevelop::ContextMenuExtension Plugin::contextMenuExtension(KDevelop::Context* context, QWidget* parent)
232​{
233​ Q_UNUSED(parent);
234​ KDevelop::ContextMenuExtension extension;
235​
236​ if (context->hasType(KDevelop::Context::EditorContext) && m_project && !isRunning()) {
237​ extension.addAction(KDevelop::ContextMenuExtension::AnalyzeFileGroup, m_contextActionFile);
238​ extension.addAction(KDevelop::ContextMenuExtension::AnalyzeProjectGroup, m_contextActionProject);
239​ }
240​
241​ if (context->hasType(KDevelop::Context::ProjectItemContext) && !isRunning()) {
242​ auto pContext = dynamic_cast<KDevelop::ProjectItemContext*>(context);
243​ if (pContext->items().size() != 1) {
244​ return extension;
245​ }
246​
247​ auto item = pContext->items().constFirst();
248​ switch (item->type()) {
249​ case KDevelop::ProjectBaseItem::File:
250​ case KDevelop::ProjectBaseItem::Folder:
251​ case KDevelop::ProjectBaseItem::BuildFolder:
kossebauUnsubmitted
Done

Build folder as well?

kossebau: Build folder as well?
antonanikinAuthorUnsubmitted
Not Done

We may want to check generated files, for example. Or you think we should disable such checking?

antonanikin: We may want to check generated files, for example. Or you think we should disable such checking?
kossebauUnsubmitted
Not Done

Hm, unsure. Given we cannot influence the generating tools, such checks might not help that much. But perhaps some people still prefer to be able to do that, so perhaps we can keep it, does not hurt anyone I guess :)

kossebau: Hm, unsure. Given we cannot influence the generating tools, such checks might not help that…
252​ break;
253​
254​ default:
255​ return extension;
256​ }
257​
258​ m_contextActionProjectItem->disconnect();
259​ connect(m_contextActionProjectItem, &QAction::triggered, this, [this, item](){
260​ runClazy(item->project(), item->path().toLocalFile());
261​ });
262​
263​ extension.addAction(KDevelop::ContextMenuExtension::AnalyzeProjectGroup, m_contextActionProjectItem);
264​ }
265​
266​ return extension;
267​}
268​
269​KDevelop::ConfigPage* Plugin::perProjectConfigPage(int number, const KDevelop::ProjectConfigOptions& options, QWidget* parent)
270​{
271​ return number ? nullptr : new ProjectConfigPage(this, options.project, parent);
272​}
273​
274​KDevelop::ConfigPage* Plugin::configPage(int number, QWidget* parent)
275​{
276​ return number ? nullptr : new GlobalConfigPage(this, parent);
277​}
278​
279​QSharedPointer<const ChecksDB> Plugin::checksDB() const
280​{
281​ return m_db;
282​}
283​
284​void Plugin::reloadDB()
285​{
286​ m_db.reset(new ChecksDB(GlobalSettings::docsPath()));
287​ connect(GlobalSettings::self(), &GlobalSettings::docsPathChanged, this, &Plugin::reloadDB);
288​}
289​
290​}
291​
292​#include "plugin.moc"