aboutsummaryrefslogtreecommitdiffstats
path: root/src/plugins/studiowelcome/newprojectmodel.h
blob: ec7cc005add985a5578ddfac8bb8ee56b232b6c5 (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
/****************************************************************************
**
** Copyright (C) 2021 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 <QAbstractListModel>
#include <QDebug>
#include <QUrl>

#include <utils/filepath.h>
#include <utils/optional.h>

namespace Utils {
class Wizard;
}

namespace StudioWelcome {

struct ProjectItem
{
    QString name;
    QString categoryId;
    QString description;
    QUrl qmlPath;
    QString fontIconCode;
    std::function<Utils::Wizard *(const Utils::FilePath &path)> create;
};

inline QDebug &operator<<(QDebug &d, const ProjectItem &item)
{
    d << "name=" << item.name;
    d << "; category = " << item.categoryId;

    return d;
}

struct ProjectCategory
{
    QString id;
    QString name;
    std::vector<ProjectItem> items;
};

inline QDebug &operator<<(QDebug &d, const ProjectCategory &cat)
{
    d << "id=" << cat.id;
    d << "; name=" << cat.name;
    d << "; items=" << cat.items;

    return d;
}

using ProjectsByCategory = std::map<QString, ProjectCategory>;

/****************** BaseNewProjectModel ******************/

class BaseNewProjectModel : public QAbstractListModel
{
    using ProjectItems = std::vector<std::vector<ProjectItem>>;
    using Categories = std::vector<QString>;

public:
    explicit BaseNewProjectModel(QObject *parent = nullptr);
    QHash<int, QByteArray> roleNames() const override;
    void setProjects(const ProjectsByCategory &projects);

protected:
    const ProjectItems &projects() const { return m_projects; }
    const Categories &categories() const { return m_categories; }

private:
    ProjectItems m_projects;
    Categories m_categories;
};

/****************** NewProjectCategoryModel ******************/

class NewProjectCategoryModel : public BaseNewProjectModel
{
public:
    explicit NewProjectCategoryModel(QObject *parent = nullptr);
    int rowCount(const QModelIndex &parent) const override;
    QVariant data(const QModelIndex &index, int role) const override;
};

/****************** NewProjectModel ******************/

class NewProjectModel : public BaseNewProjectModel
{
    Q_OBJECT
public:
    explicit NewProjectModel(QObject *parent = nullptr);
    int rowCount(const QModelIndex &parent) const override;
    QVariant data(const QModelIndex &index, int role) const override;

    Q_INVOKABLE void setPage(int index); // called from QML when view's header item is clicked
    Q_INVOKABLE QString fontIconCode(int index) const;

    int page() const { return static_cast<int>(m_page); }

    Utils::optional<ProjectItem> project(size_t selection) const
    {
        if (projects().empty())
            return {};

        if (m_page < projects().size()) {
            const std::vector<ProjectItem> projectsOfCategory = projects().at(m_page);
            if (selection < projectsOfCategory.size())
                return projects().at(m_page).at(selection);
        }
        return {};
    }

    bool empty() const { return projects().empty(); }

private:
    const std::vector<ProjectItem> projectsOfCurrentCategory() const
    { return projects().at(m_page); }

private:
    size_t m_page = 0;
};

} // namespace StudioWelcome