summaryrefslogtreecommitdiffstats
path: root/src/runtime/dragon/dragontask_p.h
blob: 4d3150c483ba5ceaade6f36c8c49f03a1862de59 (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
/****************************************************************************
**
** 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 DRAGONTASK_P_H
#define DRAGONTASK_P_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 <QSharedPointer>
#include <Qt3DCore/QAspectJob>
#include <functional>

QT_BEGIN_NAMESPACE
namespace Qt3DRender {
namespace Dragon {

/*!
 * \internal
 * Simple wrapper around a value to make it easier for other jobs to
 * use tasks as input.
 *
 * TODO: Consider removing as this adds unnecessary jobs.
 */
template <typename Output>
class SourceTask : public Qt3DCore::QAspectJob
{
public:
    using result_type = Output;

    SourceTask()
        : QAspectJob()
    {
    }

    SourceTask(const SourceTask &other)
        : QAspectJob()
        , m_result(other.m_result)
    {
    }

    void setInput(Output argument)
    {
        m_hasInput = true;
        m_isFinished = true;
        m_result = argument;
    }

    void run()
    {
        Q_ASSERT(false); // the source tasks don't need to be run
    }

    const Output &result() const
    {
        Q_ASSERT(m_isFinished);
        return m_result;
    }
    bool isFinished() const { return m_isFinished; }

private:
    Output m_result;
    bool m_hasInput = false;
    bool m_isFinished = false;
};

template <typename Output>
using SourceTaskPtr = QSharedPointer<SourceTask<Output>>;

// TODO rename
// TODO consider using an enum instead
struct SelfT
{
    explicit SelfT() = default;
};

constexpr SelfT Self;

template <typename Output>
struct Task : public Qt3DCore::QAspectJob
{
    //    using Callable = std::function<Output(Output, Inputs...)>;
    using result_type = Output;

    template <typename Callable, typename... Tasks>
    Task(Callable callable, SelfT self, Tasks... tasks)
        : Qt3DCore::QAspectJob()
        , m_function(createSelfFunction(callable, tasks...))
    {
        Q_UNUSED(self);
        addDeps(tasks...);
    }

    template <typename Callable, typename... Tasks>
    Task(Callable callable, Tasks... tasks)
        : Qt3DCore::QAspectJob()
        , m_function(createFunction(callable, tasks...))
    {
        addDeps(tasks...);
    }

    Task(const Task &other)
        : Qt3DCore::QAspectJob()
        , m_function(other.m_function)
        , m_result(other.m_result)
    {
    }

    template<typename Dependency>
    void addDep(Dependency dep)
    {
        Q_UNUSED(dep);
    }

    template<typename U>
    void addDep(QSharedPointer<Task<U>> dep)
    {
        addDependency(dep);
    }

    // TODO consider getting rid of SourceTask
    template<typename U>
    void addDep(QSharedPointer<SourceTask<U>> dep)
    {
        addDependency(dep);
    }

    void addDeps() {}

    template <typename Dependency, typename... Dependencies>
    void addDeps(Dependency dep, Dependencies... deps)
    {
        Q_UNUSED(dep);
        addDep(dep);
        addDeps(deps...);
    }

    void assertTaskFinished() {}

    template <typename OtherTask, typename... Tasks>
    void assertTaskFinished(OtherTask task, Tasks... tasks)
    {
        Q_ASSERT(task != nullptr);
        Q_ASSERT(task->isFinished());
        assertTaskFinished(tasks...);
    }

    template <typename Callable, typename... Tasks>
    std::function<void()> createSelfFunction(Callable callable, Tasks... tasks)
    {
        return [this, callable, tasks...]() {
            assertTaskFinished(tasks...);
            m_result = callable(std::move(m_result), (tasks->result())...);
        };
    }

    template <typename Callable, typename... Tasks>
    std::function<void()> createFunction(Callable callable, Tasks... tasks)
    {
        return [this, callable, tasks...]() {
            assertTaskFinished(tasks...);
            m_result = callable((tasks->result())...);
        };
    }

    void run()
    {
        m_function();

        // TODO is never reset, consider adding a function to reset after all jobs finished
        // TODO if so, take into consideration cached results
        m_isFinished = true;
    }

    const Output &result() const
    {
        Q_ASSERT(m_isFinished);
        return m_result;
    }

    bool isFinished() const { return m_isFinished; }

private:
    std::function<void()> m_function;
    Output m_result;
    bool m_isFinished = false;
};

template <typename Output>
using TaskPtr = QSharedPointer<Task<Output>>;

} // namespace Dragon
} // namespace Qt3DRender
QT_END_NAMESPACE

#endif // DRAGONTASK_P_H