kitmanager.h 5.14 KB
Newer Older
hjk's avatar
hjk committed
1
/****************************************************************************
Tobias Hunger's avatar
Tobias Hunger committed
2
**
hjk's avatar
hjk committed
3
4
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** 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
36
37
38
39
40
41
42
43
44
45

#ifndef KITMANAGER_H
#define KITMANAGER_H

#include "projectexplorer_export.h"

#include "task.h"

#include <coreplugin/id.h>
#include <utils/fileutils.h>

#include <QObject>
#include <QPair>

namespace Utils { class Environment; }

namespace ProjectExplorer {
46
class IOutputParser;
Tobias Hunger's avatar
Tobias Hunger committed
47
48
49
50
class Kit;
class KitConfigWidget;

namespace Internal {
51
class KitManagerConfigWidget;
Tobias Hunger's avatar
Tobias Hunger committed
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
class KitManagerPrivate;
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;

    virtual Core::Id dataId() const = 0;

    virtual unsigned int priority() const = 0; // the higher the closer to the top.

    virtual QVariant defaultValue(Kit *) const = 0;

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

    virtual ItemList toUserOutput(Kit *) const = 0;

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

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

    virtual QString displayNamePostfix(const Kit *k) const;

93
94
95
protected:
    void notifyAboutUpdate(Kit *k);

Tobias Hunger's avatar
Tobias Hunger committed
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
signals:
    void validationNeeded();
};

class PROJECTEXPLORER_EXPORT KitMatcher
{
public:
    virtual ~KitMatcher() { }
    virtual bool matches(const Kit *k) const = 0;
};

class PROJECTEXPLORER_EXPORT KitManager : public QObject
{
    Q_OBJECT

public:
    static KitManager *instance();
    ~KitManager();

    QList<Kit *> kits(const KitMatcher *m = 0) const;
    Kit *find(const Core::Id &id) const;
    Kit *find(const KitMatcher *m) const;
118
    Kit *defaultKit() const;
Tobias Hunger's avatar
Tobias Hunger committed
119
120
121

    QList<KitInformation *> kitInformation() const;

122
    Internal::KitManagerConfigWidget *createConfigWidget(Kit *k) const;
Tobias Hunger's avatar
Tobias Hunger committed
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

public slots:
    bool registerKit(ProjectExplorer::Kit *k);
    void deregisterKit(ProjectExplorer::Kit *k);
    void setDefaultKit(ProjectExplorer::Kit *k);

    void saveKits();

    void registerKitInformation(ProjectExplorer::KitInformation *ki);
    void deregisterKitInformation(ProjectExplorer::KitInformation *ki);

signals:
    void kitAdded(ProjectExplorer::Kit *);
    // Kit is still valid when this call happens!
    void kitRemoved(ProjectExplorer::Kit *);
    // Kit was updated.
    void kitUpdated(ProjectExplorer::Kit *);
140
    void unmanagedKitUpdated(ProjectExplorer::Kit *);
Tobias Hunger's avatar
Tobias Hunger committed
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
    // Default kit was changed.
    void defaultkitChanged();
    // Something changed.
    void kitsChanged();

private slots:
    void validateKits();

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

165
    void notifyAboutUpdate(ProjectExplorer::Kit *k);
Tobias Hunger's avatar
Tobias Hunger committed
166
167
168
169
170
171
172
173
174
175
    void addKit(Kit *k);

    Internal::KitManagerPrivate *const d;

    static KitManager *m_instance;

    friend class Internal::KitManagerPrivate; // for the restoreToolChains methods
    friend class ProjectExplorerPlugin; // for constructor
    friend class Kit;
    friend class Internal::KitModel;
176
    friend class KitInformation; // for notifyAbutUpdate
Tobias Hunger's avatar
Tobias Hunger committed
177
178
179
180
181
};

} // namespace ProjectExplorer

#endif // KITMANAGER_H