Differential D5584 Diff 14675 interfaces/iruntimecontroller.h

Changeset View

Standalone View

interfaces/iruntimecontroller.h

This file was added.

1		/*
2		Copyright 2017 Aleix Pol Gonzalez <aleixpol@kde.org>
3
4		This library is free software; you can redistribute it and/or
5		modify it under the terms of the GNU Library General Public
6		License version 2 as published by the Free Software Foundation.
7
8		This library is distributed in the hope that it will be useful,
9		but WITHOUT ANY WARRANTY; without even the implied warranty of
10		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11		Library General Public License for more details.
12
13		You should have received a copy of the GNU Library General Public License
14		along with this library; see the file COPYING.LIB. If not, write to
15		the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
16		Boston, MA 02110-1301, USA.
17		*/
18
19		#ifndef KDEVPLATFORM_IRUNTIMECONTROLLER_H
20		#define KDEVPLATFORM_IRUNTIMECONTROLLER_H
21
22		#include <interfaces/idocumentation.h>
23		#include <QtCore/QObject>
24		#include <QtCore/QVector>
25
26		namespace KDevelop {
27		class IRuntime;
28
29		/**
30		* @brief Exposes runtimes
31		*
32		* Makes it possible to have the IDE develop for different platforms other
33		* than the local host by having available different runtimes that will give
34		* access to the target systems.
35		*
36		* Allows to add runtimes, list them and offer a currentRuntime.
37		* The currentRuntime will be the runtime towards which all the runtime and build
38		* information * gathered by the IDE will be fetched from.
39		*
40		* @see IRuntime
41		*/
42		class KDEVPLATFORMINTERFACES_EXPORT IRuntimeController: public QObject
43		{
44		Q_OBJECT
45		public:
46		IRuntimeController();
47		~IRuntimeController() override;
48
49		/**
50		* Makes @p runtimes available to be used.
51		*/
	mwolffUnsubmitted Done is ownership being transferred here? mwolff: is ownership being transferred here?
52		virtual void addRuntimes(KDevelop::IRuntime* runtimes) = 0;
53
	mwolffUnsubmitted Done do we usually add multiple ones in a go? I'd expect when the user adds _a_ runtime, it's only one - so having an add function that does not take a vector would be good to have. also, are we never removing runtimes? mwolff: do we usually add multiple ones in a go? I'd expect when the user adds _a_ runtime, it's only…
	apolAuthorUnsubmitted Not Done Yes, you are right, I added this in an iteration where I had a model. Probably doesn't make much sense now. Some plugins add at bulk, such as docker at boot. Will remove them on deletion. apol: Yes, you are right, I added this in an iteration where I had a model. Probably doesn't make…
54		/**
55		* Lists available runtimes
56		*/
57		virtual QVector<IRuntime*> availableRuntimes() const = 0;
58
59		/**
60		* Sets @p runtime as the currently used runtime and emits currentRuntimeChanged
61		* so the IDE can adapt, if necessary.
62		*/
63		virtual void setCurrentRuntime(IRuntime* runtime) = 0;
64
65		/**
66		* @returns the current runtime
67		*/
68		virtual IRuntime* currentRuntime() const = 0;
69
70		Q_SIGNALS:
71		void currentRuntimeChanged(IRuntime* currentRuntime);
72		};
73
74		}
75
76		#endif