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
|
/****************************************************************************
**
** 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 "toolchain.h"
#include <utils/fileutils.h>
namespace ProjectExplorer {
class BuildInfo;
class Kit;
class Project;
class Target;
class ToolChain;
// Documentation inside.
class PROJECTEXPLORER_EXPORT ProjectImporter : public QObject
{
Q_OBJECT
public:
struct ToolChainData {
QList<ToolChain *> tcs;
bool areTemporary = false;
};
ProjectImporter(const Utils::FilePath &path);
~ProjectImporter() override;
const Utils::FilePath projectFilePath() const { return m_projectPath; }
const Utils::FilePath projectDirectory() const { return m_projectPath.parentDir(); }
virtual const QList<BuildInfo> import(const Utils::FilePath &importPath, bool silent = false);
virtual QStringList importCandidates() = 0;
virtual Target *preferredTarget(const QList<Target *> &possibleTargets);
bool isUpdating() const { return m_isUpdating; }
void makePersistent(Kit *k) const;
void cleanupKit(Kit *k) const;
bool isTemporaryKit(Kit *k) const;
void addProject(Kit *k) const;
void removeProject(Kit *k) const;
protected:
class UpdateGuard
{
public:
UpdateGuard(const ProjectImporter &i) : m_importer(i)
{
m_wasUpdating = m_importer.isUpdating();
m_importer.m_isUpdating = true;
}
~UpdateGuard() { m_importer.m_isUpdating = m_wasUpdating; }
private:
const ProjectImporter &m_importer;
bool m_wasUpdating;
};
// importPath is an existing directory at this point!
virtual QList<void *> examineDirectory(const Utils::FilePath &importPath) const = 0;
// will get one of the results from examineDirectory
virtual bool matchKit(void *directoryData, const Kit *k) const = 0;
// will get one of the results from examineDirectory
virtual Kit *createKit(void *directoryData) const = 0;
// will get one of the results from examineDirectory
virtual const QList<BuildInfo> buildInfoList(void *directoryData) const = 0;
virtual void deleteDirectoryData(void *directoryData) const = 0;
using KitSetupFunction = std::function<void(Kit *)>;
ProjectExplorer::Kit *createTemporaryKit(const KitSetupFunction &setup) const;
// Handle temporary additions to Kits (Qt Versions, ToolChains, etc.)
using CleanupFunction = std::function<void(Kit *, const QVariantList &)>;
using PersistFunction = std::function<void(Kit *, const QVariantList &)>;
void useTemporaryKitAspect(Utils::Id id,
CleanupFunction cleanup, PersistFunction persist);
void addTemporaryData(Utils::Id id, const QVariant &cleanupData, Kit *k) const;
// Does *any* kit feature the requested data yet?
bool hasKitWithTemporaryData(Utils::Id id, const QVariant &data) const;
ToolChainData findOrCreateToolChains(const ToolChainDescription &tcd) const;
private:
void markKitAsTemporary(Kit *k) const;
bool findTemporaryHandler(Utils::Id id) const;
void cleanupTemporaryToolChains(ProjectExplorer::Kit *k, const QVariantList &vl);
void persistTemporaryToolChains(ProjectExplorer::Kit *k, const QVariantList &vl);
const Utils::FilePath m_projectPath;
mutable bool m_isUpdating = false;
class TemporaryInformationHandler {
public:
Utils::Id id;
CleanupFunction cleanup;
PersistFunction persist;
};
QList<TemporaryInformationHandler> m_temporaryHandlers;
friend class UpdateGuard;
};
} // namespace ProjectExplorer
|
