blob: 26dd43f6a4149f5c123869ac737dff6de62b8b42 (
plain)
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
|
// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#pragma once
#include "projectexplorer_export.h"
#include "runconfiguration.h"
#include <utils/aspects.h>
#include <utils/environment.h>
#include <utils/store.h>
namespace ProjectExplorer {
class PROJECTEXPLORER_EXPORT EnvironmentAspect : public Utils::BaseAspect
{
Q_OBJECT
public:
EnvironmentAspect(Utils::AspectContainer *container = nullptr);
enum DeviceSelector { HostDevice, BuildDevice, RunDevice };
void setDeviceSelector(Target *target, DeviceSelector selector);
// The environment including the user's modifications.
Utils::Environment environment() const;
// Environment including modifiers, but without explicit user changes.
Utils::Environment modifiedBaseEnvironment() const;
int baseEnvironmentBase() const;
void setBaseEnvironmentBase(int base);
Utils::EnvironmentItems userEnvironmentChanges() const { return m_userChanges; }
void setUserEnvironmentChanges(const Utils::EnvironmentItems &diff);
int addSupportedBaseEnvironment(const QString &displayName,
const std::function<Utils::Environment()> &getter);
int addPreferredBaseEnvironment(const QString &displayName,
const std::function<Utils::Environment()> &getter);
void setSupportForBuildEnvironment(Target *target);
QString currentDisplayName() const;
const QStringList displayNames() const;
using EnvironmentModifier = std::function<void(Utils::Environment &)>;
void addModifier(const EnvironmentModifier &);
bool isLocal() const { return m_isLocal; }
Target *target() const { return m_target; }
bool isPrintOnRunAllowed() const { return m_allowPrintOnRun; }
bool isPrintOnRunEnabled() const { return m_printOnRun; }
void setPrintOnRun(bool enabled) { m_printOnRun = enabled; }
struct Data : BaseAspect::Data
{
Utils::Environment environment;
};
using Utils::BaseAspect::createLabel;
signals:
void baseEnvironmentChanged();
void userEnvironmentChangesChanged(const Utils::EnvironmentItems &diff);
void environmentChanged();
protected:
void fromMap(const Utils::Store &map) override;
void toMap(Utils::Store &map) const override;
void setIsLocal(bool local) { m_isLocal = local; }
void setAllowPrintOnRun(bool allow) { m_allowPrintOnRun = allow; }
static constexpr char BASE_KEY[] = "PE.EnvironmentAspect.Base";
static constexpr char CHANGES_KEY[] = "PE.EnvironmentAspect.Changes";
private:
// One possible choice in the Environment aspect.
struct BaseEnvironment {
Utils::Environment unmodifiedBaseEnvironment() const;
std::function<Utils::Environment()> getter;
QString displayName;
};
Utils::EnvironmentItems m_userChanges;
QList<EnvironmentModifier> m_modifiers;
QList<BaseEnvironment> m_baseEnvironments;
int m_base = -1;
bool m_isLocal = false;
bool m_allowPrintOnRun = true;
bool m_printOnRun = false;
Target *m_target = nullptr;
DeviceSelector m_selector = RunDevice;
};
} // namespace ProjectExplorer
|