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
|
/****************************************************************************
**
** 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 "fileutils.h"
#include "hostosinfo.h"
#include "namevaluedictionary.h"
#include "namevalueitem.h"
#include "optional.h"
#include <QStringList>
#include <functional>
QT_FORWARD_DECLARE_CLASS(QProcessEnvironment)
namespace Utils {
class QTCREATOR_UTILS_EXPORT Environment final : public NameValueDictionary
{
public:
using NameValueDictionary::NameValueDictionary;
static Environment systemEnvironment();
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 Utils::FilePath &value);
void prependOrSetPath(const Utils::FilePath &value);
void prependOrSetLibrarySearchPath(const Utils::FilePath &value);
void prependOrSetLibrarySearchPaths(const Utils::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;
static void modifySystemEnvironment(const EnvironmentItems &list); // use with care!!!
static void setSystemEnvironment(const Environment &environment); // don't use at all!!!
};
class QTCREATOR_UTILS_EXPORT EnvironmentChange final
{
public:
using Item = std::function<void(Environment &)>;
EnvironmentChange() = default;
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 Utils::FilePaths &values);
void addAppendToPath(const Utils::FilePaths &values);
void addModify(const NameValueItems &items);
void addChange(const Item &item) { m_changeItems.append(item); }
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);
};
} // namespace Utils
|