Differential D17971 Diff 50673 addons/externaltools/externaltoolsplugin.cpp

Changeset View

Standalone View

addons/externaltools/externaltoolsplugin.cpp

This file was added.

1		/* This file is part of the KDE project
2		*
3		* Copyright 2019 Dominik Haumann <dhaumann@kde.org>
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		#include "externaltoolsplugin.h"
21
22		#include "kateexternaltoolsview.h"
23		#include "kateexternaltool.h"
24		#include "kateexternaltoolscommand.h"
25		#include "katemacroexpander.h"
26		#include "katetoolrunner.h"
27		#include "kateexternaltoolsconfigwidget.h"
28
29		#include <KTextEditor/Editor>
30		#include <KTextEditor/Document>
31		#include <KTextEditor/View>
32		#include <KActionCollection>
33		#include <KLocalizedString>
34		#include <QAction>
35		#include <kparts/part.h>
36
37		#include <KMessageBox>
38		#include <KAboutData>
39		#include <KAuthorized>
40		#include <KConfig>
41		#include <KConfigGroup>
42		#include <KPluginFactory>
43		#include <KXMLGUIFactory>
44
45		K_PLUGIN_FACTORY_WITH_JSON(KateExternalToolsFactory, "externaltoolsplugin.json",
46		registerPlugin<KateExternalToolsPlugin>();)
47
48		KateExternalToolsPlugin::KateExternalToolsPlugin(QObject* parent, const QList<QVariant>&)
49		: KTextEditor::Plugin(parent)
50		{
51		reload();
52		}
53
54		KateExternalToolsPlugin::~KateExternalToolsPlugin()
55		{
56		delete m_command;
57		m_command = nullptr;
58		}
59
60		QObject* KateExternalToolsPlugin::createView(KTextEditor::MainWindow* mainWindow)
61		{
62		KateExternalToolsPluginView* view = new KateExternalToolsPluginView(mainWindow, this);
63		connect(this, &KateExternalToolsPlugin::externalToolsChanged, view, &KateExternalToolsPluginView::rebuildMenu);
64		return view;
65		}
66
67		void KateExternalToolsPlugin::reload()
68		{
69		delete m_command;
70		m_command = nullptr;
71		m_commands.clear();
72		qDeleteAll(m_tools);
73		m_tools.clear();
74
75		KConfig _config(QStringLiteral("externaltools"), KConfig::NoGlobals, QStandardPaths::ApplicationsLocation);
76		KConfigGroup config(&_config, "Global");
77		const int toolCount = config.readEntry("tools", 0);
78
79		for (int i = 0; i < toolCount; ++i) {
80		config = KConfigGroup(&_config, QStringLiteral("Tool %1").arg(i));
81
82		auto t = new KateExternalTool();
83		t->load(config);
84		m_tools.push_back(t);
85
86		// FIXME test for a command name first!
87		if (t->hasexec && (!t->cmdname.isEmpty())) {
88		m_commands.push_back(t->cmdname);
89		}
90		}
91
92		if (KAuthorized::authorizeAction(QStringLiteral("shell_access"))) {
93		m_command = new KateExternalToolsCommand(this);
94		}
95
96		Q_EMIT externalToolsChanged();
97		}
98
99		QStringList KateExternalToolsPlugin::commands() const
100		{
101		return m_commands;
102		}
103
104		const KateExternalTool* KateExternalToolsPlugin::toolForCommand(const QString& cmd) const
105		{
106		for (auto tool : m_tools) {
107		if (tool->cmdname == cmd) {
108		return tool;
109		}
110		}
111		return nullptr;
112		}
113
114		const QVector<KateExternalTool*> & KateExternalToolsPlugin::tools() const
115		{
116		return m_tools;
117		}
118
119		void KateExternalToolsPlugin::runTool(const KateExternalTool& tool, KTextEditor::View* view)
120		{
121		// expand the macros in command if any,
122		// and construct a command with an absolute path
123		auto mw = view->mainWindow();
124
125		// save documents if requested
126		if (tool.saveMode == KateExternalTool::SaveMode::CurrentDocument) {
127		// only save if modified, to avoid unnecessary recompiles
128		if (view->document()->isModified()) {
129		view->document()->save();
130		}
131		} else if (tool.saveMode == KateExternalTool::SaveMode::AllDocuments) {
132		foreach (KXMLGUIClient* client, mw->guiFactory()->clients()) {
133		if (QAction* a = client->actionCollection()->action(QStringLiteral("file_save_all"))) {
134		a->trigger();
135		break;
136		}
137		}
138		}
139
140		// copy tool
141		std::unique_ptr<KateExternalTool> copy(new KateExternalTool(tool));
142
143		MacroExpander macroExpander(view);
144
145		if (!macroExpander.expandMacrosShellQuote(copy->executable)) {
146		KMessageBox::sorry(view, i18n("Failed to expand the executable '%1'.", copy->executable),
147		i18n("Kate External Tools"));
148		return;
149		}
150
151		if (!macroExpander.expandMacrosShellQuote(copy->arguments)) {
152		KMessageBox::sorry(view, i18n("Failed to expand the arguments '%1'.", copy->arguments),
153		i18n("Kate External Tools"));
154		return;
155		}
156
157		if (!macroExpander.expandMacrosShellQuote(copy->workingDir)) {
158		KMessageBox::sorry(view, i18n("Failed to expand the working directory '%1'.", copy->workingDir),
159		i18n("Kate External Tools"));
160		return;
161		}
162
163		if (!macroExpander.expandMacrosShellQuote(copy->input)) {
164		KMessageBox::sorry(view, i18n("Failed to expand the input '%1'.", copy->input),
165		i18n("Kate External Tools"));
166		return;
167		}
168
169		// Allocate runner on heap such that it lives as long as the child
170		// process is running and does not block the main thread.
171		auto runner = new KateToolRunner(std::move(copy), view, this);
172
173		// use QueuedConnection, since handleToolFinished deletes the runner
174		connect(runner, &KateToolRunner::toolFinished, this, &KateExternalToolsPlugin::handleToolFinished, Qt::QueuedConnection);
175		runner->run();
176		}
177
178		void KateExternalToolsPlugin::handleToolFinished(KateToolRunner* runner)
179		{
180		auto view = runner->view();
181		if (view && !runner->outputData().isEmpty()) {
182		switch (runner->tool()->outputMode) {
183		case KateExternalTool::OutputMode::InsertAtCursor: {
184		KTextEditor::Document::EditingTransaction transaction(view->document());
185		view->removeSelection();
186		view->insertText(runner->outputData());
187		break;
188		}
189		case KateExternalTool::OutputMode::ReplaceSelectedText: {
190		KTextEditor::Document::EditingTransaction transaction(view->document());
191		view->removeSelectionText();
192		view->insertText(runner->outputData());
193		break;
194		}
195		case KateExternalTool::OutputMode::ReplaceCurrentDocument: {
196		KTextEditor::Document::EditingTransaction transaction(view->document());
197		view->document()->clear();
198		view->insertText(runner->outputData());
199		break;
200		}
201		case KateExternalTool::OutputMode::AppendToCurrentDocument: {
202		view->document()->insertText(view->document()->documentEnd(), runner->outputData());
203		break;
204		}
205		case KateExternalTool::OutputMode::InsertInNewDocument: {
206		auto mainWindow = view->mainWindow();
207		auto newView = mainWindow->openUrl({});
208		newView->insertText(runner->outputData());
209		mainWindow->activateView(newView->document());
210		break;
211		}
212		default:
213		break;
214		}
215		}
216
217		if (view && runner->tool()->reload) {
218		// updates-enabled trick: avoid some flicker
219		const bool wereUpdatesEnabled = view->updatesEnabled();
220		view->setUpdatesEnabled(false);
221		view->document()->documentReload();
222		view->setUpdatesEnabled(wereUpdatesEnabled);
223		}
224
225		// TODO: case KateExternalTool::OutputMode::DisplayInPane: break;
226		// create a toolview with the contents. QTextEdit with fixed font? Something else?
227
228		delete runner;
229		}
230
231		int KateExternalToolsPlugin::configPages() const
232		{
233		return 1;
234		}
	loh.tarUnsubmitted Not Done runner->view() is your view loh.tar: runner->view() is your view
235
236		KTextEditor::ConfigPage* KateExternalToolsPlugin::configPage(int number, QWidget* parent)
237		{
238		if (number == 0) {
239		return new KateExternalToolsConfigWidget(parent, this);
240		}
241		return nullptr;
242		}
243
244		#include "externaltoolsplugin.moc"
245
246		// kate: space-indent on; indent-width 4; replace-tabs on;
	loh.tarUnsubmitted Not Done Looks to me that in case of auto view == nullptr you could return on top of function and avoid all further tests loh.tar: Looks to me that in case of auto view == nullptr you could return on top of function and avoid…