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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
/****************************************************************************
**
** 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 "projectexplorer_export.h"
#include "projectconfiguration.h"
#include "task.h"
#include <utils/environment.h>
#include <utils/fileutils.h>
namespace Utils { class MacroExpander; }
namespace ProjectExplorer {
namespace Internal { class BuildConfigurationPrivate; }
class BuildDirectoryAspect;
class BuildInfo;
class BuildSystem;
class BuildStepList;
class Kit;
class NamedWidget;
class Node;
class RunConfiguration;
class Target;
class PROJECTEXPLORER_EXPORT BuildConfiguration : public ProjectConfiguration
{
Q_OBJECT
protected:
friend class BuildConfigurationFactory;
explicit BuildConfiguration(Target *target, Utils::Id id);
public:
~BuildConfiguration() override;
Utils::FilePath buildDirectory() const;
Utils::FilePath rawBuildDirectory() const;
void setBuildDirectory(const Utils::FilePath &dir);
virtual BuildSystem *buildSystem() const;
virtual NamedWidget *createConfigWidget();
virtual QList<NamedWidget *> createSubConfigWidgets();
// Maybe the BuildConfiguration is not the best place for the environment
Utils::Environment baseEnvironment() const;
QString baseEnvironmentText() const;
Utils::Environment environment() const;
void setUserEnvironmentChanges(const Utils::EnvironmentItems &diff);
Utils::EnvironmentItems userEnvironmentChanges() const;
bool useSystemEnvironment() const;
void setUseSystemEnvironment(bool b);
virtual void addToEnvironment(Utils::Environment &env) const;
const QList<Utils::Id> customParsers() const;
void setCustomParsers(const QList<Utils::Id> &parsers);
BuildStepList *buildSteps() const;
BuildStepList *cleanSteps() const;
void appendInitialBuildStep(Utils::Id id);
void appendInitialCleanStep(Utils::Id id);
bool fromMap(const QVariantMap &map) override;
QVariantMap toMap() const override;
virtual bool isEnabled() const;
virtual QString disabledReason() const;
virtual bool regenerateBuildFiles(Node *node);
virtual void restrictNextBuild(const RunConfiguration *rc);
enum BuildType {
Unknown,
Debug,
Profile,
Release
};
virtual BuildType buildType() const;
static QString buildTypeName(BuildType type);
bool isActive() const;
static void prependCompilerPathToEnvironment(Kit *k, Utils::Environment &env);
void updateCacheAndEmitEnvironmentChanged();
ProjectExplorer::BuildDirectoryAspect *buildDirectoryAspect() const;
void setConfigWidgetDisplayName(const QString &display);
void setBuildDirectoryHistoryCompleter(const QString &history);
void setConfigWidgetHasFrame(bool configWidgetHasFrame);
void setBuildDirectorySettingsKey(const QString &key);
void addConfigWidgets(const std::function<void (NamedWidget *)> &adder);
void doInitialize(const BuildInfo &info);
Utils::MacroExpander *macroExpander() const;
bool createBuildDirectory();
signals:
void environmentChanged();
void buildDirectoryChanged();
void enabledChanged();
void buildTypeChanged();
protected:
void setInitializer(const std::function<void(const BuildInfo &info)> &initializer);
private:
void emitBuildDirectoryChanged();
Internal::BuildConfigurationPrivate *d = nullptr;
};
class PROJECTEXPLORER_EXPORT BuildConfigurationFactory
{
protected:
BuildConfigurationFactory();
BuildConfigurationFactory(const BuildConfigurationFactory &) = delete;
BuildConfigurationFactory &operator=(const BuildConfigurationFactory &) = delete;
virtual ~BuildConfigurationFactory(); // Needed for dynamic_casts in importers.
public:
// List of build information that can be used to create a new build configuration via
// "Add Build Configuration" button.
const QList<BuildInfo> allAvailableBuilds(const Target *parent) const;
// List of build information that can be used to initially set up a new build configuration.
const QList<BuildInfo>
allAvailableSetups(const Kit *k, const Utils::FilePath &projectPath) const;
BuildConfiguration *create(Target *parent, const BuildInfo &info) const;
static BuildConfiguration *restore(Target *parent, const QVariantMap &map);
static BuildConfiguration *clone(Target *parent, const BuildConfiguration *source);
static BuildConfigurationFactory *find(const Kit *k, const Utils::FilePath &projectPath);
static BuildConfigurationFactory *find(Target *parent);
using IssueReporter = std::function<Tasks(Kit *, const QString &, const QString &)>;
void setIssueReporter(const IssueReporter &issueReporter);
const Tasks reportIssues(ProjectExplorer::Kit *kit,
const QString &projectPath, const QString &buildDir) const;
protected:
using BuildGenerator
= std::function<QList<BuildInfo>(const Kit *, const Utils::FilePath &, bool)>;
void setBuildGenerator(const BuildGenerator &buildGenerator);
bool supportsTargetDeviceType(Utils::Id id) const;
void setSupportedProjectType(Utils::Id id);
void setSupportedProjectMimeTypeName(const QString &mimeTypeName);
void addSupportedTargetDeviceType(Utils::Id id);
void setDefaultDisplayName(const QString &defaultDisplayName);
using BuildConfigurationCreator = std::function<BuildConfiguration *(Target *)>;
template <class BuildConfig>
void registerBuildConfiguration(Utils::Id buildConfigId)
{
m_creator = [buildConfigId](Target *t) { return new BuildConfig(t, buildConfigId); };
m_buildConfigId = buildConfigId;
}
private:
bool canHandle(const ProjectExplorer::Target *t) const;
BuildConfigurationCreator m_creator;
Utils::Id m_buildConfigId;
Utils::Id m_supportedProjectType;
QList<Utils::Id> m_supportedTargetDeviceTypes;
QString m_supportedProjectMimeTypeName;
IssueReporter m_issueReporter;
BuildGenerator m_buildGenerator;
};
} // namespace ProjectExplorer
|
