blob: 02637a677e863e9fec9084928551dc5ac786602a (
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
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
|
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://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 http://www.qt.io/terms-conditions. For further information
** use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, The Qt Company gives you certain additional
** rights. These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/
#ifndef KIT_H
#define KIT_H
#include "projectexplorer_export.h"
#include "task.h"
#include <coreplugin/featureprovider.h>
#include <QSet>
#include <QVariant>
namespace Utils {
class Environment;
class MacroExpander;
} // namespace Utils
namespace ProjectExplorer {
class IOutputParser;
namespace Internal {
class KitModel;
class KitPrivate;
} // namespace Internal
/**
* @brief The Kit class
*
* The kit holds a set of values defining a system targeted by the software
* under development.
*/
class PROJECTEXPLORER_EXPORT Kit
{
public:
Kit(Core::Id id = Core::Id());
// Do not trigger evaluations
void blockNotification();
// Trigger evaluations again.
void unblockNotification();
bool isValid() const;
bool hasWarning() const;
QList<Task> validate() const;
void fix(); // Fix the individual kit information: Make sure it contains a valid value.
// Fix will not look at other information in the kit!
void setup(); // Apply advanced magic(TM). Used only once on each kit during initial setup.
QString unexpandedDisplayName() const;
QString displayName() const;
void setUnexpandedDisplayName(const QString &name);
QStringList candidateNameList(const QString &base) const;
QString fileSystemFriendlyName() const;
QString customFileSystemFriendlyName() const;
void setCustomFileSystemFriendlyName(const QString &fileSystemFriendlyName);
bool isAutoDetected() const;
QString autoDetectionSource() const;
bool isSdkProvided() const;
Core::Id id() const;
QIcon icon() const;
static QIcon icon(const Utils::FileName &path);
Utils::FileName iconPath() const;
void setIconPath(const Utils::FileName &path);
QVariant value(Core::Id key, const QVariant &unset = QVariant()) const;
bool hasValue(Core::Id key) const;
void setValue(Core::Id key, const QVariant &value);
void setValueSilently(Core::Id key, const QVariant &value);
void removeKey(Core::Id key);
void removeKeySilently(Core::Id key);
bool isSticky(Core::Id id) const;
bool isDataEqual(const Kit *other) const;
bool isEqual(const Kit *other) const;
void addToEnvironment(Utils::Environment &env) const;
IOutputParser *createOutputParser() const;
QString toHtml(const QList<Task> &additional = QList<Task>()) const;
Kit *clone(bool keepName = false) const;
void copyFrom(const Kit *k);
// Note: Stickyness is *not* saved!
void setAutoDetected(bool detected);
void setAutoDetectionSource(const QString &autoDetectionSource);
void makeSticky();
void setSticky(Core::Id id, bool b);
void makeUnSticky();
void setMutable(Core::Id id, bool b);
bool isMutable(Core::Id id) const;
QSet<QString> availablePlatforms() const;
bool hasPlatform(const QString &platform) const;
QString displayNameForPlatform(const QString &platform) const;
Core::FeatureSet availableFeatures() const;
bool hasFeatures(const Core::FeatureSet &features) const;
Utils::MacroExpander *macroExpander() const;
private:
void setSdkProvided(bool sdkProvided);
~Kit();
Kit(const QVariantMap &data);
// Unimplemented.
Kit(const Kit &other);
void operator=(const Kit &other);
void kitDisplayNameChanged();
void kitUpdated();
QVariantMap toMap() const;
Internal::KitPrivate *const d;
friend class KitInformation;
friend class KitManager;
friend class Internal::KitModel; // needed for setAutoDetected() when cloning kits
};
class KitGuard
{
public:
KitGuard(Kit *k) : m_kit(k)
{ k->blockNotification(); }
~KitGuard() { m_kit->unblockNotification(); }
private:
Kit *m_kit;
};
} // namespace ProjectExplorer
Q_DECLARE_METATYPE(ProjectExplorer::Kit *)
#endif // KIT_H
|
