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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/
#pragma once
#include "utils_global.h"
#include "environmentfwd.h"
#include "filepath.h"
#include "namevaluedictionary.h"
#include "optional.h"
#include <functional>
QT_BEGIN_NAMESPACE
class QProcessEnvironment;
QT_END_NAMESPACE
namespace Utils {
class QTCREATOR_UTILS_EXPORT Environment final
{
public:
Environment() : m_dict(HostOsInfo::hostOs()) {}
explicit Environment(OsType osType) : m_dict(osType) {}
explicit Environment(const QStringList &env, OsType osType = HostOsInfo::hostOs())
: m_dict(env, osType) {}
explicit Environment(const NameValuePairs &nameValues) : m_dict(nameValues) {}
explicit Environment(const NameValueDictionary &dict) : m_dict(dict) {}
QString value(const QString &key) const { return m_dict.value(key); }
bool hasKey(const QString &key) const { return m_dict.hasKey(key); }
void set(const QString &key, const QString &value, bool enabled = true) { m_dict.set(key, value, enabled); }
void unset(const QString &key) { m_dict.unset(key); }
void modify(const NameValueItems &items) { m_dict.modify(items); }
int isValid() const;
void clear() { return m_dict.clear(); }
QStringList toStringList() const { return m_dict.toStringList(); }
QProcessEnvironment toProcessEnvironment() const;
void appendOrSet(const QString &key, const QString &value, const QString &sep = QString());
void prependOrSet(const QString &key, const QString &value, const QString &sep = QString());
void appendOrSetPath(const FilePath &value);
void prependOrSetPath(const FilePath &value);
void prependOrSetLibrarySearchPath(const FilePath &value);
void prependOrSetLibrarySearchPaths(const FilePaths &values);
void setupEnglishOutput();
using PathFilter = std::function<bool(const FilePath &)>;
FilePath searchInPath(const QString &executable,
const FilePaths &additionalDirs = FilePaths(),
const PathFilter &func = PathFilter()) const;
FilePath searchInDirectories(const QString &executable,
const FilePaths &dirs) const;
FilePaths findAllInPath(const QString &executable,
const FilePaths &additionalDirs = FilePaths(),
const PathFilter &func = PathFilter()) const;
FilePaths path() const;
FilePaths pathListValue(const QString &varName) const;
QStringList appendExeExtensions(const QString &executable) const;
bool isSameExecutable(const QString &exe1, const QString &exe2) const;
QString expandedValueForKey(const QString &key) const;
QString expandVariables(const QString &input) const;
FilePath expandVariables(const FilePath &input) const;
QStringList expandVariables(const QStringList &input) const;
OsType osType() const { return m_dict.osType(); }
QString userName() const;
using const_iterator = NameValueMap::const_iterator; // FIXME: avoid
NameValueDictionary toDictionary() const { return m_dict; } // FIXME: avoid
NameValueItems diff(const Environment &other, bool checkAppendPrepend = false) const; // FIXME: avoid
QString key(const_iterator it) const { return m_dict.key(it); } // FIXME: avoid
QString value(const_iterator it) const { return m_dict.value(it); } // FIXME: avoid
bool isEnabled(const_iterator it) const { return m_dict.isEnabled(it); } // FIXME: avoid
const_iterator constBegin() const { return m_dict.constBegin(); } // FIXME: avoid
const_iterator constEnd() const { return m_dict.constEnd(); } // FIXME: avoid
const_iterator constFind(const QString &name) const { return m_dict.constFind(name); } // FIXME: avoid
friend bool operator!=(const Environment &first, const Environment &second)
{
return first.m_dict != second.m_dict;
}
friend bool operator==(const Environment &first, const Environment &second)
{
return first.m_dict == second.m_dict;
}
static Environment systemEnvironment();
static void modifySystemEnvironment(const EnvironmentItems &list); // use with care!!!
static void setSystemEnvironment(const Environment &environment); // don't use at all!!!
private:
NameValueDictionary m_dict;
};
class QTCREATOR_UTILS_EXPORT EnvironmentChange final
{
public:
EnvironmentChange() = default;
class Item final
{
public:
enum Type {
SetSystemEnvironment,
SetFixedEnvironment,
SetValue,
UnsetValue,
PrependToPath,
AppendToPath,
};
Type type;
QVariant data;
};
static EnvironmentChange fromFixedEnvironment(const Environment &fixedEnv);
void applyToEnvironment(Environment &) const;
void addSetValue(const QString &key, const QString &value);
void addUnsetValue(const QString &key);
void addPrependToPath(const FilePaths &values);
void addAppendToPath(const FilePaths &values);
private:
QList<Item> m_changeItems;
};
class QTCREATOR_UTILS_EXPORT EnvironmentProvider
{
public:
QByteArray id;
QString displayName;
std::function<Environment()> environment;
static void addProvider(EnvironmentProvider &&provider);
static const QVector<EnvironmentProvider> providers();
static optional<EnvironmentProvider> provider(const QByteArray &id);
};
QTCREATOR_UTILS_EXPORT QString qtcEnvironmentVariable(const QString &key);
QTCREATOR_UTILS_EXPORT QString qtcEnvironmentVariable(const QString &key,
const QString &defaultValue);
QTCREATOR_UTILS_EXPORT bool qtcEnvironmentVariableIsSet(const QString &key);
QTCREATOR_UTILS_EXPORT bool qtcEnvironmentVariableIsEmpty(const QString &key);
QTCREATOR_UTILS_EXPORT int qtcEnvironmentVariableIntValue(const QString &key, bool *ok = nullptr);
} // namespace Utils
Q_DECLARE_METATYPE(Utils::Environment)
|
