summaryrefslogtreecommitdiffstats
path: root/src/runtime/dragon/dragontrackingchangescontainer_p.h
blob: bba173c1afb0f87ce1842f203c7aa4648287f19d (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
225
226
227
228
229
230
231
232
233
234
235
236
237
/****************************************************************************
**
** Copyright (C) 2015 Klaralvdalens Datakonsult AB (KDAB).
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of Qt 3D Studio.
**
** $QT_BEGIN_LICENSE:GPL$
** 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 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** 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.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef TRACKINGCHANGESCONTAINER_H
#define TRACKINGCHANGESCONTAINER_H

//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists for the convenience
// of other Qt classes.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//

#include <Qt3DCore/QNodeId>
#include <private/dragonimmutable_p.h>

QT_BEGIN_NAMESPACE
namespace Qt3DRender {
namespace Dragon {

// TODO consider if this is really needed
class AbstractContainer
{
public:
    class DirtyInfo {
    public:
        DirtyInfo() = default;
        virtual ~DirtyInfo() = default;
    };

    virtual ~AbstractContainer() {}
    virtual void markDirty(const Qt3DCore::QNodeId &id) = 0;
    virtual void markDirty(const Qt3DCore::QNodeId &id, const Immutable<DirtyInfo> &dirtyInfo) = 0;
};

// TODO make sure creating and removing is counted properly - consider adding a changelist instead
// TODO consider adding a key-value iterator
template<typename T>
class TrackingChangesContainer : public AbstractContainer
{
public:
    using Key = Qt3DCore::QNodeId;
    using DataContainer = QHash<Key, T>;
    using value_type = T;

    using iterator = typename DataContainer::iterator;
    using const_iterator = typename DataContainer::const_iterator;

    void markDirty(const Key &id) override
    {
        // If m_dirty already contains id, don't replace it. Otherwise there
        // is a risk to override DirtyTreeInfo{} with DirtyInfo{}
        if (m_dirty.contains(id))
            return;

        m_dirty.insert(id, DirtyInfo{});
    }

    void markDirty(const Key &id, const Immutable<DirtyInfo> &dirtyInfo) override
    {
        m_dirty.insert(id, dirtyInfo);
    }

    QList<Key> keys() const
    {
        return m_container.keys();
    }

    QList<T> values() const
    {
        return m_container.values();
    }

    bool contains(const Key &key) const
    {
        return m_container.contains(key);
    }

    // TODO consider adding a function that asserts that the container does not contain the key
    const T operator[](const Key &key) const
    {
        return m_container[key];
    }

    T& operator[](const Key &key)
    {
        if (!m_container.contains(key))
            m_created.push_back(key);
        return m_container[key];
    }

    iterator begin()
    {
        return m_container.begin();
    }

    iterator end()
    {
        return m_container.end();
    }

    const_iterator begin() const
    {
        return m_container.begin();
    }

    const_iterator end() const
    {
        return m_container.end();
    }

    QVector<Key> created() const
    {
        return m_created;
    }

    QVector<Key> removed() const
    {
        return m_removed;
    }

    QSet<Key> dirty() const
    {
        return m_dirty.keys().toSet();
    }

    // TODO reconsider the use of QList...
    QList<Key> dirtyOrNew() const
    {
        return m_dirty.keys() + m_created.toList();
    }

    bool anythingDirty() const
    {
        return !m_dirty.isEmpty()
                || !m_created.isEmpty()
                || !m_removed.isEmpty();
    }

    void insert(const Key & key, T value)
    {
        m_created.push_back(key);
        m_container.insert(key, value);
    }

    T value(const Key & key)
    {
        return m_container.value(key);
    }

    T take(const Key & key)
    {
        m_removed.push_back(key);
        return m_container.take(key);
    }

    size_t size() const
    {
        return m_container.size();
    }

    void remove(const Key &key)
    {
        take(key);
    }

    void reset()
    {
        m_created.clear();
        m_removed.clear();
        m_dirty.clear();
    }

    void clear()
    {
        m_removed = m_removed + m_container.keys();
        m_container.clear();
    }

    // TODO rename to dirty
    const QHash<Key, Immutable<DirtyInfo>> &dirtyInfo()
    {
        return m_dirty;
    }

private:
    DataContainer m_container;
    QHash<Key, Immutable<DirtyInfo>> m_dirty;
    QVector<Key> m_created;
    QVector<Key> m_removed;
};

template<typename T, typename Key>
class CacheContainer : public TrackingChangesContainer<T>
{
public:
    using key_type = Key;
    using Cache = QHash<Key, T>;
    Cache cache;
};

}
}
QT_END_NAMESPACE

#endif // TRACKINGCHANGESCONTAINER_H