summaryrefslogtreecommitdiffstats
path: root/framework/src/domain/eventtreemodel.h
blob: 9088b4c3960584736faebf67e704eeab44594029 (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
/*
    Copyright (c) 2018 Michael Bohlender <michael.bohlender@kdemail.net>
    Copyright (c) 2018 Christian Mollekopf <mollekopf@kolabsys.com>
    Copyright (c) 2018 Rémi Nicole <minijackson@riseup.net>

    This library is free software; you can redistribute it and/or modify it
    under the terms of the GNU Library General Public License as published by
    the Free Software Foundation; either version 2 of the License, or (at your
    option) any later version.

    This library is distributed in the hope that it will be useful, but WITHOUT
    ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
    FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
    License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to the
    Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
    02110-1301, USA.
*/

#pragma once

#include <sink/applicationdomaintype.h>

#include <QAbstractItemModel>
#include <QList>
#include <QMutex>
#include <QSharedPointer>
#include <QVector>

// Implementation notes
// ====================
//
// On the model side
// -----------------
//
// Columns are never used.
//
// Top-level items just contains the ".events" attribute, and their rows
// correspond to their day of week. In that case the internalId contains
// DAY_ID.
//
// Direct children are events, and their rows corresponds to their index in
// their partition. In that case no internalId / internalPointer is used.
//
// Internally:
// -----------
//
// On construction and on dataChanged, all events are processed and partitioned
// in partitionedEvents:
//
// QVector< QList<QSharedPointer<Event> >
// ~~~~~~~  ~~~~~~~~~~~~~~~~~~~~~~~~~~~
//    |                |
//    |                '--- List of event pointers for that day
//    '--- Partition / day
//
class EventTreeModel : public QAbstractItemModel
{
    Q_OBJECT

public:
    using Event = Sink::ApplicationDomain::Event;

    enum Roles
    {
        Events = Qt::UserRole + 1,
        Summary,
        Description,
        StartTime,
        Duration,
    };
    Q_ENUM(Roles);
    EventTreeModel(QObject *parent = nullptr);
    ~EventTreeModel() = default;

    QModelIndex index(int row, int column, const QModelIndex &parent = {}) const override;
    QModelIndex parent(const QModelIndex &index) const override;

    int rowCount(const QModelIndex &parent) const override;
    int columnCount(const QModelIndex &parent) const override;

    //bool hasChildren(const QModelIndex &parent) const override;

    QVariant data(const QModelIndex &index, int role) const override;

    QHash<int, QByteArray> roleNames() const override;

private:
    void partitionData();

    QSharedPointer<QAbstractItemModel> eventModel;
    QVector<QList<QSharedPointer<Event>>> partitionedEvents;

    QMutex partitioningMutex;

    static const constexpr quintptr DAY_ID = 7;
};