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