kitmanager.h 5.88 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
Tobias Hunger's avatar
Tobias Hunger committed
2
**
3
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
hjk's avatar
hjk committed
4
** Contact: http://www.qt-project.org/legal
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
12
13
14
** 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 Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
Tobias Hunger's avatar
Tobias Hunger committed
15
16
**
** GNU Lesser General Public License Usage
hjk's avatar
hjk committed
17
18
19
20
21
22
23
24
25
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
Tobias Hunger's avatar
Tobias Hunger committed
26
27
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
hjk's avatar
hjk committed
28
****************************************************************************/
Tobias Hunger's avatar
Tobias Hunger committed
29
30
31
32
33
34
35

#ifndef KITMANAGER_H
#define KITMANAGER_H

#include "projectexplorer_export.h"

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

#include <QObject>
#include <QPair>

41
42
#include <functional>

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

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

namespace Internal {
57
class KitManagerConfigWidget;
Tobias Hunger's avatar
Tobias Hunger committed
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
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;

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

    virtual QVariant defaultValue(Kit *) const = 0;

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

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

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

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

    virtual QString displayNamePostfix(const Kit *k) const;

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

101
102
103
    virtual Utils::AbstractMacroExpander *createMacroExpander(const Kit *k) const
    { Q_UNUSED(k); return 0; }

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
    typedef std::function<bool(const Kit *)> Matcher;
118
    KitMatcher() : m_matcher([](const Kit *k) -> bool { Q_UNUSED(k); return true; }) {}
119
120
121
122
123
124
    KitMatcher(const Matcher &m) : m_matcher(m) {}

    bool matches(const Kit *kit) const { return m_matcher(kit); }

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

class PROJECTEXPLORER_EXPORT KitManager : public QObject
{
    Q_OBJECT

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

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

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

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

145
146
    static void deleteKit(Kit *k);

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

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

154
155
156
157
    static QSet<QString> availablePlatforms();
    static QString displayNameForPlatform(const QString &platform);
    static Core::FeatureSet availableFeatures(const QString &platform);

158
159
public slots:
    void saveKits();
Tobias Hunger's avatar
Tobias Hunger committed
160
161
162
163
164
165
166

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

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

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);

191
    static void notifyAboutUpdate(Kit *k);
Tobias Hunger's avatar
Tobias Hunger committed
192
193
194
195
196
    void addKit(Kit *k);

    friend class ProjectExplorerPlugin; // for constructor
    friend class Kit;
    friend class Internal::KitModel;
197
    friend class KitInformation; // for notifyAbutUpdate
Tobias Hunger's avatar
Tobias Hunger committed
198
199
200
201
202
};

} // namespace ProjectExplorer

#endif // KITMANAGER_H