1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
|
/* This file is part of KDevelop
Copyright 2017 Aleix Pol <aleixpol@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KDEVPLATFORM_IRUNTIME_H
#define KDEVPLATFORM_IRUNTIME_H
#include "interfacesexport.h"
#include <QObject>
#include <QString>
class QProcess;
class KProcess;
namespace KDevelop
{
class Path;
/**
* A runtime represents an environment we develop against
*
* It allows the IDE to interact with systems that differ from process where
* the process we are running in.
*
* It allows to execute processes into them and translate the paths these runtimes
* offer into ones that will be visible to our process so we can introspect the
* platform we are developing for as well.
*/
class KDEVPLATFORMINTERFACES_EXPORT IRuntime : public QObject
{
Q_OBJECT
public:
~IRuntime() override;
/** @returns a display string that identifies the runtime */
virtual QString name() const = 0;
/**
* Adapts the @p process and starts it within the environment
*
* Gives an opportunity to the runtime to set up environment variables
* or process the execution in any way necessary.
*/
virtual void startProcess(QProcess* process) const = 0;
/**
* @see startProcess(QProcess*)
*/
virtual void startProcess(KProcess* process) const = 0;
/**
* Given a @p localPath from our process's file system
* @returns the path that the runtime's environment can use
*/
virtual Path pathInRuntime(const Path& localPath) const = 0;
/**
* Given a @p runtimePath from the runtime
* @returns the path in our file system scope that maps to the runtime's
*/
virtual Path pathInHost(const Path& runtimePath) const = 0;
/**
* Analogous to QStandardPaths::findExecutable(), searches for the executable
* named @p executableName in the runtime system paths.
* @returns the absolute file path to the executable, or an empty string if not found.
*/
virtual QString findExecutable(const QString& executableName) const = 0;
/**
* @returns the value for an environment variable in the runtime
*/
virtual QByteArray getenv(const QByteArray& varname) const = 0;
/**
* @returns a path for binary directories or empty if there's no such thing.
*
* Some runtime systems won't be benefiting much from having custom build directories.
* For such systems, the project manager will offer to initialise the build directories
* there instead of asking where to create them.
*/
virtual Path buildPath() const = 0;
protected:
friend class RuntimeController;
/**
* notifies the runtime about its availability.
*
* This will be called exclusively from the IRuntimeController implementation.
*
* @see IRuntimeController::setCurrentRuntime
*/
virtual void setEnabled(bool enabled) = 0;
};
}
#endif
|
