kitmanager.h 5.99 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
Tobias Hunger's avatar
Tobias Hunger committed
2
**
Eike Ziller's avatar
Eike Ziller committed
3
4
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
Tobias Hunger's avatar
Tobias Hunger committed
5
**
hjk's avatar
hjk committed
6
** This file is part of Qt Creator.
Tobias Hunger's avatar
Tobias Hunger committed
7
**
hjk's avatar
hjk committed
8
9
10
11
** 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
Eike Ziller's avatar
Eike Ziller committed
12
13
** a written agreement between you and The Qt Company.  For licensing terms and
** conditions see http://www.qt.io/terms-conditions.  For further information
Eike Ziller's avatar
Eike Ziller committed
14
** use the contact form at http://www.qt.io/contact-us.
Tobias Hunger's avatar
Tobias Hunger committed
15
16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17
** Alternatively, this file may be used under the terms of the GNU Lesser
Eike Ziller's avatar
Eike Ziller committed
18
19
20
21
22
23
** 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.
hjk's avatar
hjk committed
24
**
Eike Ziller's avatar
Eike Ziller committed
25
26
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
Tobias Hunger's avatar
Tobias Hunger committed
27
28
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
29
****************************************************************************/
Tobias Hunger's avatar
Tobias Hunger committed
30
31
32
33
34
35
36

#ifndef KITMANAGER_H
#define KITMANAGER_H

#include "projectexplorer_export.h"

#include <coreplugin/id.h>
37
#include <coreplugin/featureprovider.h>
Tobias Hunger's avatar
Tobias Hunger committed
38
39
40
41

#include <QObject>
#include <QPair>

42
43
#include <functional>

44
45
namespace Utils {
class Environment;
hjk's avatar
hjk committed
46
47
class FileName;
class MacroExpander;
48
}
Tobias Hunger's avatar
Tobias Hunger committed
49
50

namespace ProjectExplorer {
51
class Task;
52
class IOutputParser;
Tobias Hunger's avatar
Tobias Hunger committed
53
54
class Kit;
class KitConfigWidget;
55
class KitManager;
Tobias Hunger's avatar
Tobias Hunger committed
56
57

namespace Internal {
58
class KitManagerConfigWidget;
Tobias Hunger's avatar
Tobias Hunger committed
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
class KitModel;
} // namespace Internal

/**
 * @brief The KitInformation class
 *
 * One piece of information stored in the kit.
 *
 * This needs to get registered with the \a KitManager.
 */
class PROJECTEXPLORER_EXPORT KitInformation : public QObject
{
    Q_OBJECT

public:
    typedef QPair<QString, QString> Item;
    typedef QList<Item> ItemList;

77
    Core::Id id() const { return m_id; }
78
    int priority() const { return m_priority; }
Tobias Hunger's avatar
Tobias Hunger committed
79
80
81

    virtual QVariant defaultValue(Kit *) const = 0;

82
    // called to find issues with the kit
83
    virtual QList<Task> validate(const Kit *) const = 0;
84
    // called to fix issues with this kitinformation. Does not modify the rest of the kit.
85
    virtual void fix(Kit *) { return; }
86
87
    // called on initial setup of a kit.
    virtual void setup(Kit *) { return; }
Tobias Hunger's avatar
Tobias Hunger committed
88

89
    virtual ItemList toUserOutput(const Kit *) const = 0;
Tobias Hunger's avatar
Tobias Hunger committed
90
91
92
93

    virtual KitConfigWidget *createConfigWidget(Kit *) const = 0;

    virtual void addToEnvironment(const Kit *k, Utils::Environment &env) const;
94
    virtual IOutputParser *createOutputParser(const Kit *k) const;
Tobias Hunger's avatar
Tobias Hunger committed
95
96
97

    virtual QString displayNamePostfix(const Kit *k) const;

98
99
    virtual QSet<Core::Id> availablePlatforms(const Kit *k) const;
    virtual QString displayNameForPlatform(const Kit *k, Core::Id platform) const;
100
    virtual QSet<Core::Id> availableFeatures(const Kit *k) const;
101

hjk's avatar
hjk committed
102
    virtual void addToMacroExpander(ProjectExplorer::Kit *kit, Utils::MacroExpander *expander) const;
103

104
protected:
105
    void setId(Core::Id id) { m_id = id; }
106
    void setPriority(int priority) { m_priority = priority; }
107
    void notifyAboutUpdate(Kit *k);
108
109

private:
110
    Core::Id m_id;
111
    int m_priority; // The higher the closer to the top.
Tobias Hunger's avatar
Tobias Hunger committed
112
113
114
115
116
};

class PROJECTEXPLORER_EXPORT KitMatcher
{
public:
117
118
    typedef std::function<bool(const Kit *)> Matcher;
    KitMatcher(const Matcher &m) : m_matcher(m) {}
Daniel Teske's avatar
Daniel Teske committed
119
    KitMatcher() {}
120

Daniel Teske's avatar
Daniel Teske committed
121
    bool isValid() const { return !!m_matcher; }
122
123
124
125
    bool matches(const Kit *kit) const { return m_matcher(kit); }

private:
    Matcher m_matcher;
Tobias Hunger's avatar
Tobias Hunger committed
126
127
128
129
130
131
132
};

class PROJECTEXPLORER_EXPORT KitManager : public QObject
{
    Q_OBJECT

public:
133
    static KitManager *instance();
Tobias Hunger's avatar
Tobias Hunger committed
134
135
    ~KitManager();

136
137
    static QList<Kit *> kits();
    static QList<Kit *> matchingKits(const KitMatcher &matcher);
138
    static Kit *find(Core::Id id);
139
    static Kit *find(const KitMatcher &matcher);
140
    static Kit *defaultKit();
Tobias Hunger's avatar
Tobias Hunger committed
141

142
    static QList<KitInformation *> kitInformation();
Tobias Hunger's avatar
Tobias Hunger committed
143

144
    static Internal::KitManagerConfigWidget *createConfigWidget(Kit *k);
Tobias Hunger's avatar
Tobias Hunger committed
145

146
147
    static void deleteKit(Kit *k);

148
149
150
    static bool registerKit(Kit *k);
    static void deregisterKit(Kit *k);
    static void setDefaultKit(Kit *k);
Tobias Hunger's avatar
Tobias Hunger committed
151

152
153
    static void registerKitInformation(KitInformation *ki);
    static void deregisterKitInformation(KitInformation *ki);
Tobias Hunger's avatar
Tobias Hunger committed
154

155
156
157
    static QSet<Core::Id> availablePlatforms();
    static QString displayNameForPlatform(Core::Id platform);
    static QSet<Core::Id> availableFeatures(Core::Id platform);
158

159
160
    static QList<Kit *> sortKits(const QList<Kit *> kits); // Avoid sorting whenever possible!

161
162
public slots:
    void saveKits();
Tobias Hunger's avatar
Tobias Hunger committed
163
164
165
166
167
168
169

signals:
    void kitAdded(ProjectExplorer::Kit *);
    // Kit is still valid when this call happens!
    void kitRemoved(ProjectExplorer::Kit *);
    // Kit was updated.
    void kitUpdated(ProjectExplorer::Kit *);
170
    void unmanagedKitUpdated(ProjectExplorer::Kit *);
Tobias Hunger's avatar
Tobias Hunger committed
171
172
173
174
175
    // Default kit was changed.
    void defaultkitChanged();
    // Something changed.
    void kitsChanged();

176
    void kitsLoaded();
Tobias Hunger's avatar
Tobias Hunger committed
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193

private:
    explicit KitManager(QObject *parent = 0);

    // Make sure the this is only called after all
    // KitInformation are registered!
    void restoreKits();
    class KitList
    {
    public:
        KitList()
        { }
        Core::Id defaultKit;
        QList<Kit *> kits;
    };
    KitList restoreKits(const Utils::FileName &fileName);

194
    static void notifyAboutUpdate(Kit *k);
Tobias Hunger's avatar
Tobias Hunger committed
195
196
197
198
199
    void addKit(Kit *k);

    friend class ProjectExplorerPlugin; // for constructor
    friend class Kit;
    friend class Internal::KitModel;
200
    friend class KitInformation; // for notifyAbutUpdate
Tobias Hunger's avatar
Tobias Hunger committed
201
202
203
204
205
};

} // namespace ProjectExplorer

#endif // KITMANAGER_H