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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
/*
SPDX-FileCopyrightText: 2007 Andreas Pakulat <apaku@gmx.de>
SPDX-License-Identifier: LGPL-2.0-or-later
*/
#ifndef KDEVPLATFORM_ENVIRONMENTPROFILELIST_H
#define KDEVPLATFORM_ENVIRONMENTPROFILELIST_H
#include "utilexport.h"
#include <KSharedConfig>
class QProcessEnvironment;
class KConfig;
template<typename T1, typename T2> class QMap;
class QString;
class QStringList;
namespace KDevelop {
class EnvironmentProfileListPrivate;
/**
* This class manages a list of environment profiles, each profile containing a number
* of environment variables and their values.
*
* The class is constructed from a KConfig object for easy usage in the plugins.
*
* The methods to change the environments is protected to disallow access to those methods
* from plugins, only the environment widget is allowed to change them.
*
* Example Usage
* \code
* KSharedConfigPtr config = KSharedConfig::openConfig();
* EnvironmentProfileList env(config);
* KConfigGroup cfg(config, "QMake Builder");
* QMap<QString,QString> myenvVars = env.variables( cfg.readEntry("QMake Environment") );
* \endcode
*
* Two entries are used by this class:
* "Default Environment Group" and "Environment Variables".
*
* "Default Environment Variables" stores the default profile that should be used if the
* user didn't select a profile via a plugins configuration dialog.
*
* "Environment Variables" entry stores the actual list of
* <profilename%varname=varvalue>. The profilename can't contain '%' or '='.
* For example, suppose that two configuration, say "release" and "debug" exist.
* Then the actual contents of .kdev4 project file will be
*
* \code
* [Environment Settings]
* Default Environment Group=debug
* Environment Variables=debug_PATH=/home/kde-devel/usr/bin,release_PATH=/usr/bin
* \endcode
*
*/
class KDEVPLATFORMUTIL_EXPORT EnvironmentProfileList
{
public:
EnvironmentProfileList(const EnvironmentProfileList& rhs);
EnvironmentProfileList& operator=(const EnvironmentProfileList& rhs);
/**
* Creates an a list of environment profiles from a KConfig object
* @param config the KConfig object to read the environment profiles from
*/
explicit EnvironmentProfileList(const KSharedConfigPtr& config);
explicit EnvironmentProfileList(KConfig* config);
~EnvironmentProfileList();
/**
* Creates a merged environment between the defaults specified by
* \a defaultEnvironment and those saved in \a profileName
*/
QStringList createEnvironment(const QString& profileName, const QStringList& defaultEnvironment) const;
/**
* returns the variables that are set for a given profile.
* This function provides read-only access to the environment
* @param profileName the name of the profile for which the environment should be returned
* @return a map containing the environment variables for this profile, or an empty map if the profile doesn't exist in this list
*/
QMap<QString, QString> variables(const QString& profileName) const;
/**
* returns the name of the default profile
* The default profile should be used by plugins unless the user chooses a different profile
* @return the name of the default profile, defaults to "default"
*/
QString defaultProfileName() const;
/**
* Fetch the list of names of known profiles from the list
* @return the list of profile names
*/
QStringList profileNames() const;
protected:
EnvironmentProfileList();
/**
* returns the variables that are set for a given profile.
* This function provides write access to the environment, so new variables can be inserted, existing ones changed or deleted
*
* If a non-existing profile is specified this returns a new empty map and that way this function can be used to add a new profile
* to the list of environment profiles
* @param profileName the name of the profile for which the environment should be returned
* @return a map containing the environment variables for this profile, or an empty map if the profile doesn't exist in this list
*/
QMap<QString, QString>& variables(const QString& profileName);
/**
* Changes the default profile.
* @param profileName the name of the new default profile, if a profile of this name doesn't exist the default profile is not changed
*/
void setDefaultProfile(const QString& profileName);
/**
* Stores the environment profiles in this list to the given KConfig object
* @param config a KConfig object to which the environment settings should be stored
*/
void saveSettings(KConfig* config) const;
void loadSettings(KConfig* config);
void removeProfile(const QString& profileName);
private:
const QScopedPointer<class EnvironmentProfileListPrivate> d_ptr;
Q_DECLARE_PRIVATE(EnvironmentProfileList)
};
KDEVPLATFORMUTIL_EXPORT void expandVariables(QMap<QString, QString>& variables, const QProcessEnvironment& environment);
}
#endif
|
