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