forked from qt-creator/qt-creator
Utils: Introduce TaskTree and Tasking namespace
The TaskTree class is responsible for running async task tree structure defined in a declarative way. Change-Id: Ieaf706c7d2efdc8b431a17b2db8b28bf4b7c38e5 Reviewed-by: hjk <hjk@qt.io>
This commit is contained in:
Jarek Kobus
239
src/libs/utils/tasktree.h
Normal file
239
src/libs/utils/tasktree.h
Normal file
@@ -0,0 +1,239 @@
|
||||
// Copyright (C) 2022 The Qt Company Ltd.
|
||||
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0+ OR GPL-3.0 WITH Qt-GPL-exception-1.0
|
||||
|
||||
#pragma once
|
||||
|
||||
#include "utils_global.h"
|
||||
|
||||
#include <QObject>
|
||||
|
||||
namespace Utils {
|
||||
namespace Tasking {
|
||||
|
||||
class QTCREATOR_UTILS_EXPORT TaskInterface : public QObject
|
||||
{
|
||||
Q_OBJECT
|
||||
|
||||
public:
|
||||
TaskInterface() = default;
|
||||
virtual void start() = 0;
|
||||
|
||||
signals:
|
||||
void done(bool success);
|
||||
};
|
||||
|
||||
class QTCREATOR_UTILS_EXPORT TaskItem
|
||||
{
|
||||
public:
|
||||
// Internal, provided by QTC_DECLARE_CUSTOM_TASK
|
||||
using TaskCreateHandler = std::function<TaskInterface *(void)>;
|
||||
// Called prior to task start, just after createHandler
|
||||
using TaskSetupHandler = std::function<void(TaskInterface &)>;
|
||||
// Called on task done / error
|
||||
using TaskEndHandler = std::function<void(const TaskInterface &)>;
|
||||
// Called when sub tree entered / after sub three ended with success or failure
|
||||
using GroupSimpleHandler = std::function<void()>;
|
||||
|
||||
struct TaskHandler {
|
||||
TaskCreateHandler m_createHandler;
|
||||
TaskSetupHandler m_setupHandler;
|
||||
TaskEndHandler m_doneHandler;
|
||||
TaskEndHandler m_errorHandler;
|
||||
};
|
||||
|
||||
struct GroupHandler {
|
||||
GroupSimpleHandler m_simpleSetupHandler;
|
||||
GroupSimpleHandler m_simpleDoneHandler;
|
||||
GroupSimpleHandler m_simpleErrorHandler;
|
||||
};
|
||||
|
||||
enum class ExecuteMode {
|
||||
Parallel, // default
|
||||
Sequential
|
||||
};
|
||||
|
||||
// 4 policies:
|
||||
// 1. When all children finished with done -> report done, otherwise:
|
||||
// a) Report error on first error and stop executing other children (including their subtree)
|
||||
// b) On first error - wait for all children to be finished and report error afterwards
|
||||
// 2. When all children finished with error -> report error, otherwise:
|
||||
// a) Report done on first done and stop executing other children (including their subtree)
|
||||
// b) On first done - wait for all children to be finished and report done afterwards
|
||||
|
||||
enum class WorkflowPolicy {
|
||||
StopOnError, // 1a - Will report error on any child error, otherwise done (if all children were done)
|
||||
ContinueOnError, // 1b - the same. When no children it reports done.
|
||||
StopOnDone, // 2a - Will report done on any child done, otherwise error (if all children were error)
|
||||
ContinueOnDone, // 2b - the same. When no children it reports done. (?)
|
||||
Optional // Returns always done after all children finished
|
||||
};
|
||||
|
||||
ExecuteMode executeMode() const { return m_executeMode; }
|
||||
WorkflowPolicy workflowPolicy() const { return m_workflowPolicy; }
|
||||
TaskHandler taskHandler() const { return m_taskHandler; }
|
||||
GroupHandler groupHandler() const { return m_groupHandler; }
|
||||
QList<TaskItem> children() const { return m_children; }
|
||||
|
||||
protected:
|
||||
enum class Type {
|
||||
Group,
|
||||
Mode,
|
||||
Policy,
|
||||
TaskHandler,
|
||||
GroupHandler
|
||||
// TODO: Add Cond type (with CondHandler and True and False branches)?
|
||||
};
|
||||
|
||||
TaskItem() = default;
|
||||
TaskItem(ExecuteMode mode)
|
||||
: m_type(Type::Mode)
|
||||
, m_executeMode(mode) {}
|
||||
TaskItem(WorkflowPolicy policy)
|
||||
: m_type(Type::Policy)
|
||||
, m_workflowPolicy(policy) {}
|
||||
TaskItem(const TaskHandler &handler)
|
||||
: m_type(Type::TaskHandler)
|
||||
, m_taskHandler(handler) {}
|
||||
TaskItem(const GroupHandler &handler)
|
||||
: m_type(Type::GroupHandler)
|
||||
, m_groupHandler(handler) {}
|
||||
void addChildren(const QList<TaskItem> &children);
|
||||
|
||||
private:
|
||||
Type m_type = Type::Group;
|
||||
ExecuteMode m_executeMode = ExecuteMode::Sequential;
|
||||
WorkflowPolicy m_workflowPolicy = WorkflowPolicy::StopOnError;
|
||||
TaskHandler m_taskHandler;
|
||||
GroupHandler m_groupHandler;
|
||||
QList<TaskItem> m_children;
|
||||
};
|
||||
|
||||
class QTCREATOR_UTILS_EXPORT Group : public TaskItem
|
||||
{
|
||||
public:
|
||||
Group(const QList<TaskItem> &children) { addChildren(children); }
|
||||
Group(std::initializer_list<TaskItem> children) { addChildren(children); }
|
||||
};
|
||||
|
||||
class QTCREATOR_UTILS_EXPORT ExecuteInSequence : public TaskItem
|
||||
{
|
||||
public:
|
||||
ExecuteInSequence() : TaskItem(ExecuteMode::Sequential) {}
|
||||
};
|
||||
|
||||
class QTCREATOR_UTILS_EXPORT ExecuteInParallel : public TaskItem
|
||||
{
|
||||
public:
|
||||
ExecuteInParallel() : TaskItem(ExecuteMode::Parallel) {}
|
||||
};
|
||||
|
||||
class QTCREATOR_UTILS_EXPORT WorkflowPolicy : public TaskItem
|
||||
{
|
||||
public:
|
||||
WorkflowPolicy(TaskItem::WorkflowPolicy policy) : TaskItem(policy) {}
|
||||
};
|
||||
|
||||
class QTCREATOR_UTILS_EXPORT OnGroupSetup : public TaskItem
|
||||
{
|
||||
public:
|
||||
OnGroupSetup(const GroupSimpleHandler &handler) : TaskItem({{handler}, {}, {}}) {}
|
||||
};
|
||||
|
||||
class QTCREATOR_UTILS_EXPORT OnGroupDone : public TaskItem
|
||||
{
|
||||
public:
|
||||
OnGroupDone(const GroupSimpleHandler &handler) : TaskItem({{}, handler, {}}) {}
|
||||
};
|
||||
|
||||
class QTCREATOR_UTILS_EXPORT OnGroupError : public TaskItem
|
||||
{
|
||||
public:
|
||||
OnGroupError(const GroupSimpleHandler &handler) : TaskItem({{}, {}, handler}) {}
|
||||
};
|
||||
|
||||
QTCREATOR_UTILS_EXPORT extern ExecuteInSequence sequential;
|
||||
QTCREATOR_UTILS_EXPORT extern ExecuteInParallel parallel;
|
||||
QTCREATOR_UTILS_EXPORT extern WorkflowPolicy stopOnError;
|
||||
QTCREATOR_UTILS_EXPORT extern WorkflowPolicy continueOnError;
|
||||
QTCREATOR_UTILS_EXPORT extern WorkflowPolicy stopOnDone;
|
||||
QTCREATOR_UTILS_EXPORT extern WorkflowPolicy continueOnDone;
|
||||
QTCREATOR_UTILS_EXPORT extern WorkflowPolicy optional;
|
||||
|
||||
template <typename Task>
|
||||
class TaskAdapter : public TaskInterface
|
||||
{
|
||||
public:
|
||||
using Type = Task;
|
||||
TaskAdapter() = default;
|
||||
Task *task() { return &m_task; }
|
||||
const Task *task() const { return &m_task; }
|
||||
private:
|
||||
Task m_task;
|
||||
};
|
||||
|
||||
template <typename Adapter>
|
||||
class CustomTask : public TaskItem
|
||||
{
|
||||
public:
|
||||
using Task = typename Adapter::Type;
|
||||
using SetupHandler = std::function<void(Task &)>;
|
||||
using EndHandler = std::function<void(const Task &)>;
|
||||
static Adapter *createAdapter() { return new Adapter; }
|
||||
CustomTask(const SetupHandler &setup, const EndHandler &done = {}, const EndHandler &error = {})
|
||||
: TaskItem({&createAdapter, wrapSetup(setup),
|
||||
wrapEnd(done), wrapEnd(error)}) {}
|
||||
|
||||
private:
|
||||
static TaskSetupHandler wrapSetup(SetupHandler handler) {
|
||||
if (!handler)
|
||||
return {};
|
||||
return [handler](TaskInterface &taskInterface) {
|
||||
Adapter &adapter = static_cast<Adapter &>(taskInterface);
|
||||
handler(*adapter.task());
|
||||
};
|
||||
};
|
||||
static TaskEndHandler wrapEnd(EndHandler handler) {
|
||||
if (!handler)
|
||||
return {};
|
||||
return [handler](const TaskInterface &taskInterface) {
|
||||
const Adapter &adapter = static_cast<const Adapter &>(taskInterface);
|
||||
handler(*adapter.task());
|
||||
};
|
||||
};
|
||||
};
|
||||
|
||||
} // namespace Tasking
|
||||
|
||||
class TaskTreePrivate;
|
||||
|
||||
class QTCREATOR_UTILS_EXPORT TaskTree : public QObject
|
||||
{
|
||||
Q_OBJECT
|
||||
|
||||
public:
|
||||
TaskTree(const Tasking::Group &root);
|
||||
~TaskTree();
|
||||
|
||||
void start();
|
||||
void stop();
|
||||
bool isRunning() const;
|
||||
|
||||
signals:
|
||||
void done();
|
||||
void errorOccurred();
|
||||
|
||||
private:
|
||||
TaskTreePrivate *d;
|
||||
};
|
||||
|
||||
} // namespace Utils
|
||||
|
||||
#define QTC_DECLARE_CUSTOM_TASK(CustomTaskName, TaskAdapterClass)\
|
||||
namespace Utils::Tasking { using CustomTaskName = CustomTask<TaskAdapterClass>; }
|
||||
|
||||
#define QTC_DECLARE_CUSTOM_TEMPLATE_TASK(CustomTaskName, TaskAdapterClass)\
|
||||
namespace Utils::Tasking {\
|
||||
template <typename ...Args>\
|
||||
using CustomTaskName = CustomTask<TaskAdapterClass<Args...>>;\
|
||||
} // namespace Utils::Tasking
|
||||
|
||||
Reference in New Issue
Block a user