kitmanager.h 6.08 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 44 45 46
namespace Utils {
class FileName;
class Environment;
}
Tobias Hunger's avatar
Tobias Hunger committed
47 48

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

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

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

    virtual QVariant defaultValue(Kit *) const = 0;

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

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

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

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

    virtual QString displayNamePostfix(const Kit *k) const;

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

100
protected:
101
    void setId(Core::Id id) { m_id = id; }
102
    void setPriority(int priority) { m_priority = priority; }
103
    void notifyAboutUpdate(Kit *k);
104 105

private:
106
    Core::Id m_id;
107
    int m_priority; // The higher the closer to the top.
Tobias Hunger's avatar
Tobias Hunger committed
108 109 110 111 112
};

class PROJECTEXPLORER_EXPORT KitMatcher
{
public:
113
    typedef std::function<bool(const Kit *)> Matcher;
114
    KitMatcher() : m_matcher([](const Kit *k) -> bool { Q_UNUSED(k); return true; }) {}
115 116 117 118 119 120
    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
121 122 123 124 125 126 127
};

class PROJECTEXPLORER_EXPORT KitManager : public QObject
{
    Q_OBJECT

public:
128
    static QObject *instance();
Tobias Hunger's avatar
Tobias Hunger committed
129 130
    ~KitManager();

131 132
    static QList<Kit *> kits();
    static QList<Kit *> matchingKits(const KitMatcher &matcher);
133
    static Kit *find(Core::Id id);
134
    static Kit *find(const KitMatcher &matcher);
135
    static Kit *defaultKit();
Tobias Hunger's avatar
Tobias Hunger committed
136

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

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

141 142
    static void deleteKit(Kit *k);

143
    static QString uniqueKitName(const Kit *k, const QString &name, const QList<Kit *> &allKits);
144

145 146 147
    static bool registerKit(ProjectExplorer::Kit *k);
    static void deregisterKit(ProjectExplorer::Kit *k);
    static void setDefaultKit(ProjectExplorer::Kit *k);
Tobias Hunger's avatar
Tobias Hunger committed
148

149 150
    static void registerKitInformation(ProjectExplorer::KitInformation *ki);
    static void deregisterKitInformation(ProjectExplorer::KitInformation *ki);
Tobias Hunger's avatar
Tobias Hunger committed
151

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

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

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

171
    void kitsLoaded();
Tobias Hunger's avatar
Tobias Hunger committed
172 173 174 175

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

176
    static bool setKeepDisplayNameUnique(bool unique);
177

Tobias Hunger's avatar
Tobias Hunger committed
178 179 180 181 182 183 184 185 186 187 188 189 190
    // 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 192
    static void notifyAboutDisplayNameChange(ProjectExplorer::Kit *k);
    static void notifyAboutUpdate(ProjectExplorer::Kit *k);
Tobias Hunger's avatar
Tobias Hunger committed
193 194 195 196 197
    void addKit(Kit *k);

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

} // namespace ProjectExplorer

#endif // KITMANAGER_H