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
208
209
210
211
212
213
214
215
216
217
218
|
/****************************************************************************
**
** 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 "kit.h"
#include <coreplugin/id.h>
#include <coreplugin/idocument.h>
#include <utils/fileutils.h>
#include <QObject>
#include <QFileSystemModel>
#include <functional>
namespace Core { class Context; }
namespace Utils { class MacroExpander; }
namespace ProjectExplorer {
class BuildInfo;
class ContainerNode;
class EditorConfiguration;
class FileNode;
class NamedWidget;
class ProjectImporter;
class ProjectNode;
class ProjectPrivate;
class Session;
class Target;
// Auto-registers with the DocumentManager if a callback is set!
class PROJECTEXPLORER_EXPORT ProjectDocument : public Core::IDocument
{
public:
using ProjectCallback = std::function<void()>;
ProjectDocument(const QString &mimeType, const Utils::FileName &fileName,
const ProjectCallback &callback = {});
Core::IDocument::ReloadBehavior reloadBehavior(Core::IDocument::ChangeTrigger state,
Core::IDocument::ChangeType type) const final;
bool reload(QString *errorString, Core::IDocument::ReloadFlag flag,
Core::IDocument::ChangeType type) final;
private:
ProjectCallback m_callback;
};
// Documentation inside.
class PROJECTEXPLORER_EXPORT Project : public QObject
{
friend class SessionManager; // for setActiveTarget
friend class ProjectExplorerPlugin; // for projectLoaded
Q_OBJECT
public:
// Roles to be implemented by all models that are exported via model()
enum ModelRoles {
// Absolute file path
FilePathRole = QFileSystemModel::FilePathRole,
EnabledRole
};
Project(const QString &mimeType, const Utils::FileName &fileName,
const ProjectDocument::ProjectCallback &callback = {});
~Project() override;
virtual QString displayName() const = 0;
Core::Id id() const;
Core::IDocument *document() const;
Utils::FileName projectFilePath() const;
Utils::FileName projectDirectory() const;
static Utils::FileName projectDirectory(const Utils::FileName &top);
virtual ProjectNode *rootProjectNode() const;
ContainerNode *containerNode() const;
bool hasActiveBuildSettings() const;
// EditorConfiguration:
EditorConfiguration *editorConfiguration() const;
// Target:
void addTarget(Target *target);
bool removeTarget(Target *target);
QList<Target *> targets() const;
// Note: activeTarget can be 0 (if no targets are defined).
Target *activeTarget() const;
Target *target(Core::Id id) const;
Target *target(Kit *k) const;
virtual bool supportsKit(Kit *k, QString *errorMessage = nullptr) const;
Target *createTarget(Kit *k);
static bool copySteps(Target *sourceTarget, Target *newTarget);
Target *restoreTarget(const QVariantMap &data);
void saveSettings();
enum class RestoreResult { Ok, Error, UserAbort };
RestoreResult restoreSettings(QString *errorMessage);
enum FilesMode {
SourceFiles = 0x1,
GeneratedFiles = 0x2,
AllFiles = SourceFiles | GeneratedFiles
};
QStringList files(FilesMode fileMode,
const std::function<bool(const FileNode *)> &filter = {}) const;
virtual QStringList filesGeneratedFrom(const QString &sourceFile) const;
static QString makeUnique(const QString &preferredName, const QStringList &usedNames);
virtual QVariantMap toMap() const;
Core::Context projectContext() const;
Core::Context projectLanguages() const;
QVariant namedSettings(const QString &name) const;
void setNamedSettings(const QString &name, const QVariant &value);
virtual bool needsConfiguration() const;
virtual void configureAsExampleProject(const QSet<Core::Id> &platforms);
virtual bool requiresTargetPanel() const;
virtual ProjectImporter *projectImporter() const;
Kit::Predicate requiredKitPredicate() const;
Kit::Predicate preferredKitPredicate() const;
virtual bool needsSpecialDeployment() const;
// The build system is able to report all executables that can be built, independent
// of configuration.
virtual bool knowsAllBuildExecutables() const;
void setup(QList<const BuildInfo *> infoList);
Utils::MacroExpander *macroExpander() const;
signals:
void fileListChanged();
// Note: activeTarget can be 0 (if no targets are defined).
void activeTargetChanged(ProjectExplorer::Target *target);
void aboutToRemoveTarget(ProjectExplorer::Target *target);
void removedTarget(ProjectExplorer::Target *target);
void addedTarget(ProjectExplorer::Target *target);
void environmentChanged();
void buildConfigurationEnabledChanged();
void buildDirectoryChanged();
void settingsLoaded();
void aboutToSaveSettings();
void projectContextUpdated();
void projectLanguagesUpdated();
void parsingFinished();
protected:
virtual RestoreResult fromMap(const QVariantMap &map, QString *errorMessage);
virtual bool setupTarget(Target *t);
void setRequiredKitPredicate(const Kit::Predicate &predicate);
void setPreferredKitPredicate(const Kit::Predicate &predicate);
void setId(Core::Id id);
void setRootProjectNode(ProjectNode *root); // takes ownership!
void setProjectContext(Core::Context context);
void setProjectLanguages(Core::Context language);
void addProjectLanguage(Core::Id id);
void removeProjectLanguage(Core::Id id);
void setProjectLanguage(Core::Id id, bool enabled);
virtual void projectLoaded(); // Called when the project is fully loaded.
private:
void changeEnvironment();
void changeBuildConfigurationEnabled();
void onBuildDirectoryChanged();
void setActiveTarget(Target *target);
ProjectPrivate *d;
friend class Session;
};
} // namespace ProjectExplorer
Q_DECLARE_METATYPE(ProjectExplorer::Project *)
|
