Differential D17971 Diff 50673 addons/externaltools/katetoolrunner.h

Changeset View

Standalone View

addons/externaltools/katetoolrunner.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
21		#ifndef KTEXTEDITOR_EXTERNALTOOLRUNNER_H
22		#define KTEXTEDITOR_EXTERNALTOOLRUNNER_H
23
24		#include <QByteArray>
25		#include <QObject>
26		#include <QProcess>
27		#include <QString>
28		#include <QPointer>
29
30		#include <memory>
31
32		class KateExternalTool;
33		class QProcess;
34		namespace KTextEditor {
35		class View;
36		}
37
38		/**
39		* Helper class to run a KateExternalTool.
40		*/
41		class KateToolRunner : public QObject
42		{
43		Q_OBJECT
44
45		public:
46		/**
47		* Constructor that will run @p tool in the run() method.
48		* The @p view can later be retrieved again with view() to process the data when the tool is finished.
49		*/
50		KateToolRunner(std::unique_ptr<KateExternalTool> tool, KTextEditor::View * view, QObject* parent = nullptr);
51
52		KateToolRunner(const KateToolRunner&) = delete;
53		void operator=(const KateToolRunner&) = delete;
54
55		~KateToolRunner();
56
57		/**
58		* Returns the view that was active when running the tool.
59		* @warning May be a nullptr, since the view could have been closed in the meantime.
60		*/
61		KTextEditor::View* view() const;
62
63		/**
64		* Returns the tool that was passed in the constructor.
65		*/
66		KateExternalTool* tool() const;
67
68		/**
69		* Starts a child process that executes the tool.
70		*/
71		void run();
72
73		/**
74		* Blocking call that waits until the tool is finised.
75		* Used internally for unit testing.
	loh.tarUnsubmitted Not Done Blockingcall ... finished. or done? loh.tar: Blockingcall ... finished. or done?
76		*/
77		void waitForFinished();
78
79		/**
80		* Returns the data that was collected on stdout.
81		* stderr is also included if includeStderr was set.
82		*/
83		QString outputData() const;
84
85		Q_SIGNALS:
86		/**
87		* This signal is emitted when the tool is finished.
88		*/
89		void toolFinished(KateToolRunner* runner);
90
91		private Q_SLOTS:
92		/**
93		* More tool output is available
94		*/
95		void slotReadyRead();
96
97		/**
98		* Analysis finished
99		* @param exitCode analyzer process exit code
100		* @param exitStatus analyzer process exit status
101		*/
102		void handleToolFinished(int exitCode, QProcess::ExitStatus exitStatus);
103
104		private:
105		//! Use QPointer here, since the View may be closed in the meantime.
106		QPointer<KTextEditor::View> m_view;
107
108		//! We are the owner of the tool (it was copied)
109		std::unique_ptr<KateExternalTool> m_tool;
110
111		//! Child process that runs the tool
112		std::unique_ptr<QProcess> m_process;
113
114		//! Collect stdout, and optionally also stderr
115		QByteArray m_output;
116		};
117
118		#endif // KTEXTEDITOR_EXTERNALTOOLRUNNER_H
119
120		// kate: space-indent on; indent-width 4; replace-tabs on;