Differential D17971 Diff 49909 addons/externaltools/externaltools.h

Changeset View

Standalone View

addons/externaltools/externaltools.h

This file was added.

		1		/*
		2		This file is part of the Kate text editor of the KDE project.
		3		It describes a "external tools" action for kate and provides a dialog
		4		page to configure that.
		5
		6		This library is free software; you can redistribute it and/or
		7		modify it under the terms of the GNU Library General Public
		8		License version 2 as published by the Free Software Foundation.
		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		---
		21		Copyright (C) 2004 Anders Lund <anders@alweb.dk>
		22		Copyright (C) 2019 Dominik Haumann <dhaumann@kde.org>
		23		*/
		24
		25		#ifndef KTEXTEDITOR_EXTERNALTOOLS_H
		26		#define KTEXTEDITOR_EXTERNALTOOLS_H
		27
		28		#include "ui_configwidget.h"
		29		#include "ui_tooldialog.h"
		30
		31		#include <KTextEditor/Application>
		32		#include <KTextEditor/Command>
		33		#include <KTextEditor/ConfigPage>
		34		#include <KTextEditor/MainWindow>
		35		#include <KTextEditor/Plugin>
		36
		37		#include <KActionMenu>
		38		#include <KMacroExpander>
		39		#include <QDialog>
		40
		41		#include <QHash>
		42		#include <QPixmap>
		43		#include <QProcess>
		44
		45		class KateExternalToolsPlugin;
		46		class KateExternalTool;
		47
		48		/**
		49		* The external tools action
		50		* This action creates a menu, in which each item will launch a process
		51		* with the provided arguments, which may include the following macros:
		52		* - %URLS: the URLs of all open documents.
		53		* - %URL: The URL of the active document.
		54		* - %filedir: The directory of the current document, if that is a local file.
		55		* - %selection: The selection of the active document.
		56		* - %text: The text of the active document.
		57		* - %line: The line number of the cursor in the active view.
		58		* - %column: The column of the cursor in the active view.
		59		*
		60		* Each item has the following properties:
		61		* - Name: The friendly text for the menu
		62		* - Exec: The command to execute, including arguments.
		63		* - TryExec: the name of the executable, if not available, the
		64		* item will not be displayed.
		65		* - MimeTypes: An optional list of mimetypes. The item will be disabled or
		66		* hidden if the current file is not of one of the indicated types.
		67		*
		68		*/
		69		class KateExternalToolsMenuAction : public KActionMenu
		70		{
		71		friend class KateExternalToolAction;
		72
		73		Q_OBJECT
		74		public:
		75		KateExternalToolsMenuAction(const QString& text, class KActionCollection* collection, QObject* parent,
		76		class KTextEditor::MainWindow* mw = nullptr);
		77		virtual ~KateExternalToolsMenuAction();
		78
		79		/**
		80		* This will load all the configured services.
		81		*/
		82		void reload();
		83
		84		class KActionCollection* actionCollection() { return m_actionCollection; }
		85
		86		private Q_SLOTS:
		87		void slotViewChanged(KTextEditor::View* view);
		88
		89		private:
		90		class KActionCollection* m_actionCollection;
		91		KTextEditor::MainWindow* mainwindow; // for the actions to access view/doc managers
		92		};
		93
		94		/**
		95		* This Action contains a KateExternalTool
		96		*/
		97		class KateExternalToolAction : public QAction, public KWordMacroExpander
		98		{
		99		Q_OBJECT
		100		public:
		101		KateExternalToolAction(QObject* parent, class KateExternalTool* t);
		102		~KateExternalToolAction();
		103
		104		protected:
		105		bool expandMacro(const QString& str, QStringList& ret) override;
		106
		107		private Q_SLOTS:
		108		void slotRun();
		109
		110		public:
		111		class KateExternalTool* tool;
		112		};
		113
		114		/**
		115		* The config widget.
		116		* The config widget allows the user to view a list of services of the type
		117		* "Kate/ExternalTool" and add, remove or edit them.
		118		*/
		119		class KateExternalToolsConfigWidget : public KTextEditor::ConfigPage, public Ui::ExternalToolsConfigWidget
		120		{
		121		Q_OBJECT
		122		public:
		123		KateExternalToolsConfigWidget(QWidget* parent, KateExternalToolsPlugin* plugin);
		124		virtual ~KateExternalToolsConfigWidget();
		125
		126		QString name() const override;
		127		QString fullName() const override;
		128		QIcon icon() const override;
		129
		130		public Q_SLOTS:
		131		void apply() override;
		132		void reset() override;
		133		void defaults() override { reset(); } // double sigh
		134
		135		private Q_SLOTS:
		136		void slotNew();
		137		void slotEdit();
		138		void slotRemove();
		139		void slotInsertSeparator();
		140
		141		void slotMoveUp();
		142		void slotMoveDown();
		143
		144		void slotSelectionChanged();
		145
		146		private:
		147		QPixmap blankIcon();
		148
		149		QStringList m_removed;
		150
		151		class KConfig* m_config = nullptr;
		152		bool m_changed = false;
		153		KateExternalToolsPlugin* m_plugin;
		154		};
		155
		156		/**
		157		* A Singleton class for invoking external tools with the view command line
		158		*/
		159		class KateExternalToolsCommand : public KTextEditor::Command
		160		{
		161		public:
		162		KateExternalToolsCommand(KateExternalToolsPlugin* plugin);
		163		virtual ~KateExternalToolsCommand() {}
		164		void reload();
		165
		166		public:
		167		// const QStringList& cmds() override; // FIXME
		168		bool exec(KTextEditor::View* view, const QString& cmd, QString& msg,
		169		const KTextEditor::Range& range = KTextEditor::Range::invalid()) override;
		170		bool help(KTextEditor::View* view, const QString& cmd, QString& msg) override;
		171
		172		private:
		173		QStringList m_list;
		174		QHash<QString, QString> m_map;
		175		QHash<QString, QString> m_name;
		176		KateExternalToolsPlugin* m_plugin;
		177		};
		178
		179		/**
		180		* A Dialog to edit a single KateExternalTool object
		181		*/
		182		class KateExternalToolServiceEditor : public QDialog
		183		{
		184		Q_OBJECT
		185
		186		public:
		187		explicit KateExternalToolServiceEditor(KateExternalTool* tool = nullptr, QWidget* parent = nullptr);
		188
		189		private Q_SLOTS:
		190		/**
		191		* Run when the OK button is clicked, to ensure critical values are provided.
		192		*/
		193		void slotOKClicked();
		194
		195		/**
		196		* show a mimetype chooser dialog
		197		*/
		198		void showMTDlg();
		199
		200		public:
		201		Ui::ToolDialog * ui;
		202		private:
		203		KateExternalTool* tool;
		204		};
		205
		206		/**
		207		* Helper class to run a KateExternalTool.
		208		*/
		209		class ExternalToolRunner
		210		{
		211		public:
		212		ExternalToolRunner(KateExternalTool * tool);
		213		ExternalToolRunner(const ExternalToolRunner &) = delete;
		214		void operator=(const ExternalToolRunner &) = delete;
		215
		216		~ExternalToolRunner();
		217
		218		void run();
		219
		220		private:
		221		KateExternalTool * m_tool;
		222		QProcess * m_process = nullptr;
		223		};
		224
		225		#endif // KTEXTEDITOR_EXTERNALTOOLS_H
		226
		227		// kate: space-indent on; indent-width 4; replace-tabs on;