Differential D17971 Diff 50859 addons/externaltools/externaltoolsplugin.h

Changeset View

Standalone View

addons/externaltools/externaltoolsplugin.h

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		#ifndef KTEXTEDITOR_EXTERNALTOOLS_PLUGIN_H
21		#define KTEXTEDITOR_EXTERNALTOOLS_PLUGIN_H
22
23		#include <QVector>
24		#include <KTextEditor/Plugin>
25
26		namespace KTextEditor { class View; }
27
28		class KateExternalToolsMenuAction;
29		class KateExternalToolsPluginView;
30		class KateExternalToolsCommand;
31		class KateExternalTool;
32		class KateToolRunner;
33
34		class KateExternalToolsPlugin : public KTextEditor::Plugin
35		{
36		Q_OBJECT
37
38		public:
39		explicit KateExternalToolsPlugin(QObject* parent = nullptr, const QList<QVariant>& = QList<QVariant>());
40		virtual ~KateExternalToolsPlugin();
41
42		/**
43		* Reimplemented to return the number of config pages, in this case 1.
44		*/
45		int configPages() const override;
46
47		/**
48		* Reimplemented to return the KateExternalToolConfigWidget for number==0.
49		*/
50		KTextEditor::ConfigPage* configPage(int number = 0, QWidget* parent = nullptr) override;
51
52		/**
53		* Reimplemented to instanciate a PluginView for each MainWindow.
54		*/
	loh.tarUnsubmitted Not Done instantiate ? loh.tar: instantiate ?
55		QObject* createView(KTextEditor::MainWindow* mainWindow) override;
56
57		/**
58		* Reloads the external tools from disk.
59		*/
60		void reload();
61
62		/**
63		* Returns a list of KTextEDitor::Command strings. This is needed by
64		* the KateExternalToolsCommand constructor to pass the list of commands to
65		* the KTextEditor::Editor.
66		*/
67		QStringList commands() const;
68
69		/**
70		* Returns the KateExternalTool for a specific command line command 'cmd.
71		*/
	loh.tarUnsubmitted Not Done \@p cmd ? loh.tar: \@p cmd ?
72		const KateExternalTool* toolForCommand(const QString& cmd) const;
73
74		/**
75		* Returns a list of all existing external tools.
76		*/
77		const QVector<KateExternalTool*> & tools() const;
78
79		/**
80		* Executes the tool based on the view as current document.
81		*/
82		void runTool(const KateExternalTool& tool, KTextEditor::View* view);
83
84		Q_SIGNALS:
85		/**
86		* This signal is emitted whenever the external tools change.
87		* This is typically the case when external tools were modified,
88		* added, or removed via the config page.
89		*/
90		void externalToolsChanged();
91
92		public:
93		/**
94		* Called by the KateExternalToolsPluginView to register itself.
95		*/
96		void registerPluginView(KateExternalToolsPluginView * view);
97
98		/**
99		* Called by the KateExternalToolsPluginView to unregister itself.
100		*/
101		void unregisterPluginView(KateExternalToolsPluginView * view);
102
103		/**
104		* Returns the KateExternalToolsPluginView for the given mainWindow.
105		*/
106		KateExternalToolsPluginView* viewForMainWindow(KTextEditor::MainWindow* mainWindow) const;
107
108		private:
109		QVector<KateExternalToolsPluginView*> m_views;
110		QVector<KateExternalTool*> m_tools;
111		QStringList m_commands;
112		KateExternalToolsCommand* m_command = nullptr;
113
114		private Q_SLOT:
115		/**
116		* Called whenever an external tool is done.
117		*/
118		void handleToolFinished(KateToolRunner* runner, int exitCode, bool crashed);
119		};
120
121		#endif
122
123		// kate: space-indent on; indent-width 4; replace-tabs on;