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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
|
// Copyright (C) 2025 Jarek Kobus
// Copyright (C) 2025 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#ifndef QTASKTREERUNNER_H
#define QTASKTREERUNNER_H
#include <QtTaskTree/qttasktreeglobal.h>
#include <QtTaskTree/qtasktree.h>
#include <QtCore/QObject>
#include <unordered_map>
QT_BEGIN_NAMESPACE
class QAbstractTaskTreeRunnerPrivate;
class QSingleTaskTreeRunnerPrivate;
class QSequentialTaskTreeRunnerPrivate;
class QParallelTaskTreeRunnerPrivate;
class Q_TASKTREE_EXPORT QAbstractTaskTreeRunner : public QObject
{
Q_OBJECT
Q_DECLARE_PRIVATE(QAbstractTaskTreeRunner)
public:
using TreeSetupHandler = std::function<void(QTaskTree &)>;
using TreeDoneHandler = std::function<void(const QTaskTree &, QtTaskTree::DoneWith)>;
QAbstractTaskTreeRunner(QObject *parent = nullptr);
~QAbstractTaskTreeRunner() override;
virtual bool isRunning() const = 0;
virtual void cancel() = 0;
virtual void reset() = 0;
Q_SIGNALS:
void aboutToStart(QTaskTree *taskTree);
void done(QtTaskTree::DoneWith result, QTaskTree *taskTree);
protected:
QAbstractTaskTreeRunner(QAbstractTaskTreeRunnerPrivate &dd, QObject *parent);
template <typename Handler>
static TreeSetupHandler wrapTreeSetupHandler(Handler &&handler) {
using QtTaskTree::isInvocable;
if constexpr (std::is_same_v<std::decay_t<Handler>, TreeSetupHandler>) {
if (!handler)
return {}; // User passed {} for the setup handler.
}
// V, T stands for: [V]oid, [T]askTree
static constexpr bool isVT = isInvocable<void, Handler, QTaskTree &>();
static constexpr bool isV = isInvocable<void, Handler>();
static_assert(isVT || isV,
"Tree setup handler needs to take (TaskTree &) or (void) as an argument and has to "
"return void. The passed handler doesn't fulfill these requirements.");
return [handler = std::forward<Handler>(handler)](QTaskTree &taskTree) {
if constexpr (isVT)
std::invoke(handler, taskTree);
else if constexpr (isV)
std::invoke(handler);
};
}
template <typename Handler>
static TreeDoneHandler wrapTreeDoneHandler(Handler &&handler) {
using QtTaskTree::isInvocable;
if constexpr (std::is_same_v<std::decay_t<Handler>, TreeDoneHandler>) {
if (!handler)
return {}; // User passed {} for the done handler.
}
// V, T, D stands for: [V]oid, [T]askTree, [D]oneWith
static constexpr bool isVTD = isInvocable<void, Handler, const QTaskTree &, QtTaskTree::DoneWith>();
static constexpr bool isVT = isInvocable<void, Handler, const QTaskTree &>();
static constexpr bool isVD = isInvocable<void, Handler, QtTaskTree::DoneWith>();
static constexpr bool isV = isInvocable<void, Handler>();
static_assert(isVTD || isVT || isVD || isV,
"Task done handler needs to take (const TaskTree &, DoneWith), (const Task &), "
"(DoneWith) or (void) as arguments and has to return void. "
"The passed handler doesn't fulfill these requirements.");
return [handler = std::forward<Handler>(handler)](const QTaskTree &taskTree, QtTaskTree::DoneWith result) {
if constexpr (isVTD)
std::invoke(handler, taskTree, result);
else if constexpr (isVT)
std::invoke(handler, taskTree);
else if constexpr (isVD)
std::invoke(handler, result);
else if constexpr (isV)
std::invoke(handler);
};
}
};
class Q_TASKTREE_EXPORT QSingleTaskTreeRunner : public QAbstractTaskTreeRunner
{
Q_OBJECT
Q_DECLARE_PRIVATE(QSingleTaskTreeRunner)
public:
QSingleTaskTreeRunner(QObject *parent = nullptr);
~QSingleTaskTreeRunner() override;
bool isRunning() const override;
void cancel() override;
void reset() override;
template <typename SetupHandler = TreeSetupHandler, typename DoneHandler = TreeDoneHandler>
void start(const QtTaskTree::Group &recipe,
SetupHandler &&setupHandler = {},
DoneHandler &&doneHandler = {},
QtTaskTree::CallDoneFlags callDone = QtTaskTree::CallDone::Always)
{
startImpl(recipe,
wrapTreeSetupHandler(std::forward<SetupHandler>(setupHandler)),
wrapTreeDoneHandler(std::forward<DoneHandler>(doneHandler)),
callDone);
}
private:
void startImpl(const QtTaskTree::Group &recipe,
const TreeSetupHandler &setupHandler,
const TreeDoneHandler &doneHandler,
QtTaskTree::CallDoneFlags callDone);
};
class Q_TASKTREE_EXPORT QSequentialTaskTreeRunner : public QAbstractTaskTreeRunner
{
Q_OBJECT
Q_DECLARE_PRIVATE(QSequentialTaskTreeRunner)
public:
QSequentialTaskTreeRunner(QObject *parent = nullptr);
~QSequentialTaskTreeRunner();
bool isRunning() const override;
void cancel() override;
void reset() override;
void cancelCurrent();
void resetCurrent();
template <typename SetupHandler = TreeSetupHandler, typename DoneHandler = TreeDoneHandler>
void enqueue(const QtTaskTree::Group &recipe,
SetupHandler &&setupHandler = {},
DoneHandler &&doneHandler = {},
QtTaskTree::CallDoneFlags callDone = QtTaskTree::CallDone::Always)
{
enqueueImpl(recipe,
wrapTreeSetupHandler(std::forward<SetupHandler>(setupHandler)),
wrapTreeDoneHandler(std::forward<DoneHandler>(doneHandler)),
callDone);
}
private:
void enqueueImpl(const QtTaskTree::Group &recipe,
const TreeSetupHandler &setupHandler,
const TreeDoneHandler &doneHandler,
QtTaskTree::CallDoneFlags callDone);
};
class Q_TASKTREE_EXPORT QParallelTaskTreeRunner : public QAbstractTaskTreeRunner
{
Q_OBJECT
Q_DECLARE_PRIVATE(QParallelTaskTreeRunner)
public:
QParallelTaskTreeRunner(QObject *parent = nullptr);
~QParallelTaskTreeRunner();
bool isRunning() const override;
void cancel() override;
void reset() override;
template <typename SetupHandler = TreeSetupHandler, typename DoneHandler = TreeDoneHandler>
void start(const QtTaskTree::Group &recipe,
SetupHandler &&setupHandler = {},
DoneHandler &&doneHandler = {},
QtTaskTree::CallDoneFlags callDone = QtTaskTree::CallDone::Always)
{
startImpl(recipe,
wrapTreeSetupHandler(std::forward<SetupHandler>(setupHandler)),
wrapTreeDoneHandler(std::forward<DoneHandler>(doneHandler)),
callDone);
}
private:
void startImpl(const QtTaskTree::Group &recipe,
const TreeSetupHandler &setupHandler,
const TreeDoneHandler &doneHandler,
QtTaskTree::CallDoneFlags callDone);
};
template <typename Key>
class QMappedTaskTreeRunner : public QAbstractTaskTreeRunner
{
public:
QMappedTaskTreeRunner(QObject *parent = nullptr)
: QAbstractTaskTreeRunner(parent)
{}
~QMappedTaskTreeRunner() = default;
bool isRunning() const override { return !m_taskTrees.empty(); }
void cancel() override
{
while (!m_taskTrees.empty())
m_taskTrees.begin()->second->cancel();
}
void reset() override { m_taskTrees.clear(); }
bool isKeyRunning(const Key &key) const { return m_taskTrees.find(key) != m_taskTrees.end(); }
void cancelKey(const Key &key)
{
if (const auto it = m_taskTrees.find(key); it != m_taskTrees.end())
it->second->cancel();
}
void resetKey(const Key &key)
{
if (const auto it = m_taskTrees.find(key); it != m_taskTrees.end())
m_taskTrees.erase(it);
}
template <typename SetupHandler = TreeSetupHandler, typename DoneHandler = TreeDoneHandler>
void start(const Key &key, const QtTaskTree::Group &recipe,
SetupHandler &&setupHandler = {},
DoneHandler &&doneHandler = {},
QtTaskTree::CallDoneFlags callDone = QtTaskTree::CallDone::Always)
{
startImpl(key, recipe,
wrapTreeSetupHandler(std::forward<SetupHandler>(setupHandler)),
wrapTreeDoneHandler(std::forward<DoneHandler>(doneHandler)),
callDone);
}
private:
void startImpl(const Key &key, const QtTaskTree::Group &recipe,
const TreeSetupHandler &setupHandler,
const TreeDoneHandler &doneHandler,
QtTaskTree::CallDoneFlags callDone)
{
QTaskTree *taskTree = new QTaskTree(recipe);
connect(taskTree, &QTaskTree::done,
this, [this, key, doneHandler, callDone](QtTaskTree::DoneWith result) {
const auto it = m_taskTrees.find(key);
QTaskTree *runningTaskTree = it->second.release();
runningTaskTree->deleteLater();
m_taskTrees.erase(it);
if (doneHandler && shouldCallDone(callDone, result))
doneHandler(*runningTaskTree, result);
Q_EMIT done(result, runningTaskTree);
});
m_taskTrees[key].reset(taskTree);
if (setupHandler)
setupHandler(*taskTree);
Q_EMIT aboutToStart(taskTree);
taskTree->start();
}
std::unordered_map<Key, std::unique_ptr<QTaskTree>> m_taskTrees;
};
QT_END_NAMESPACE
#endif // QTASKTREERUNNER_H
|