summaryrefslogtreecommitdiff
path: root/src/plugins/projectexplorer/projectconfiguration.h
blob: 76b3080291c6119e6fd25bc6e45d05034db8ed57 (plain)
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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
/****************************************************************************
**
** 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 <coreplugin/id.h>
#include <utils/displayname.h>
#include <utils/macroexpander.h>

#include <QObject>
#include <QPointer>
#include <QString>
#include <QVariantMap>
#include <QWidget>

namespace ProjectExplorer {

class Project;
class ProjectConfigurationAspects;
class Target;

class PROJECTEXPLORER_EXPORT LayoutBuilder
{
public:
    explicit LayoutBuilder(QWidget *parent);
    ~LayoutBuilder();

    class LayoutItem
    {
    public:
        LayoutItem(QLayout *layout) : layout(layout) {}
        LayoutItem(QWidget *widget) : widget(widget) {}
        LayoutItem(const QString &text) : text(text) {}

        QLayout *layout = nullptr;
        QWidget *widget = nullptr;
        QString text;
    };

    void addItem(LayoutItem item);
    void startNewRow();

    QLayout *layout() const;

private:
    void flushPendingItems();

    QLayout *m_layout = nullptr;
    QList<LayoutItem> m_pendingItems;
};

class PROJECTEXPLORER_EXPORT ProjectConfigurationAspect : public QObject
{
    Q_OBJECT

public:
    ProjectConfigurationAspect();
    ~ProjectConfigurationAspect() override;

    void setId(Core::Id id) { m_id = id; }
    void setDisplayName(const QString &displayName) { m_displayName = displayName; }
    void setSettingsKey(const QString &settingsKey) { m_settingsKey = settingsKey; }

    Core::Id id() const { return m_id; }
    QString displayName() const { return m_displayName; }
    QString settingsKey() const { return  m_settingsKey; }

    bool isVisible() const { return m_visible; }
    void setVisible(bool visible) { m_visible = visible; }

    using ConfigWidgetCreator = std::function<QWidget *()>;
    void setConfigWidgetCreator(const ConfigWidgetCreator &configWidgetCreator);
    QWidget *createConfigWidget() const;

    virtual void fromMap(const QVariantMap &) {}
    virtual void toMap(QVariantMap &) const {}
    virtual void acquaintSiblings(const ProjectConfigurationAspects &) {}

    virtual void addToLayout(LayoutBuilder &builder);

signals:
    void changed();

protected:
    Core::Id m_id;
    QString m_displayName;
    QString m_settingsKey; // Name of data in settings.
    bool m_visible = true;
    ConfigWidgetCreator m_configWidgetCreator;
};

class PROJECTEXPLORER_EXPORT ProjectConfigurationAspects
        : private QList<ProjectConfigurationAspect *>
{
    using Base = QList<ProjectConfigurationAspect *>;

public:
    ProjectConfigurationAspects();
    ProjectConfigurationAspects(const ProjectConfigurationAspects &) = delete;
    ProjectConfigurationAspects &operator=(const ProjectConfigurationAspects &) = delete;
    ~ProjectConfigurationAspects();

    template <class Aspect, typename ...Args>
    Aspect *addAspect(Args && ...args)
    {
        auto aspect = new Aspect(args...);
        append(aspect);
        return aspect;
    }

    ProjectConfigurationAspect *aspect(Core::Id id) const;

    template <typename T> T *aspect() const
    {
        for (ProjectConfigurationAspect *aspect : *this)
            if (T *result = qobject_cast<T *>(aspect))
                return result;
        return nullptr;
    }

    void fromMap(const QVariantMap &map) const;
    void toMap(QVariantMap &map) const;

    using Base::append;
    using Base::begin;
    using Base::end;

private:
    Base &base() { return *this; }
    const Base &base() const { return *this; }
};

class PROJECTEXPLORER_EXPORT ProjectConfiguration : public QObject
{
    Q_OBJECT

protected:
    explicit ProjectConfiguration(QObject *parent, Core::Id id);

public:
    ~ProjectConfiguration() override;

    Core::Id id() const;

    QString displayName() const { return m_displayName.value(); }
    bool usesDefaultDisplayName() const { return m_displayName.usesDefaultValue(); }
    void setDisplayName(const QString &name);
    void setDefaultDisplayName(const QString &name);

    void setToolTip(const QString &text);
    QString toolTip() const;

    // Note: Make sure subclasses call the superclasses' fromMap() function!
    virtual bool fromMap(const QVariantMap &map);

    // Note: Make sure subclasses call the superclasses' toMap() function!
    virtual QVariantMap toMap() const;

    Utils::MacroExpander *macroExpander() { return &m_macroExpander; }
    const Utils::MacroExpander *macroExpander() const { return &m_macroExpander; }

    Target *target() const;
    Project *project() const;

    virtual bool isActive() const = 0;

    static QString settingsIdKey();

    template<class Aspect, typename ...Args>
    Aspect *addAspect(Args && ...args)
    {
        return m_aspects.addAspect<Aspect>(std::forward<Args>(args)...);
    }

    const ProjectConfigurationAspects &aspects() const { return m_aspects; }

    ProjectConfigurationAspect *aspect(Core::Id id) const;
    template <typename T> T *aspect() const { return m_aspects.aspect<T>(); }

    void acquaintAspects();

signals:
    void displayNameChanged();
    void toolTipChanged();

protected:
    ProjectConfigurationAspects m_aspects;

private:
    QPointer<Target> m_target;
    const Core::Id m_id;
    Utils::DisplayName m_displayName;
    QString m_toolTip;
    Utils::MacroExpander m_macroExpander;
};

// helper function:
PROJECTEXPLORER_EXPORT Core::Id idFromMap(const QVariantMap &map);

} // namespace ProjectExplorer