1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the Qt3D module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QT3DCORE_TASK_P_H
41#define QT3DCORE_TASK_P_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists for the convenience
48// of other Qt classes. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include <QtCore/QRunnable>
55#include <QtCore/QSharedPointer>
56#include <QtCore/QThread>
57#include <QtCore/QtGlobal>
58
59#include <Qt3DCore/private/qaspectjobmanager_p.h>
60
61QT_BEGIN_NAMESPACE
62
63namespace Qt3DCore {
64
65class JobRunner;
66class DependencyHandler;
67class QThreadPooler;
68class QSystemInformationService;
69
70class RunnableInterface : public QRunnable
71{
72public:
73 enum class RunnableType {
74 AspectTask,
75 SyncTask
76 };
77
78 virtual ~RunnableInterface();
79
80 virtual bool isRequired() const = 0;
81 virtual void run() override = 0;
82
83 virtual int id() = 0;
84 virtual void setId(int id) = 0;
85
86 virtual void setReserved(bool reserved) = 0;
87 virtual bool reserved() = 0;
88
89 virtual void setPooler(QThreadPooler *pooler) = 0;
90
91 virtual RunnableType type() const = 0;
92};
93
94class AspectTaskRunnable : public RunnableInterface
95{
96public:
97 AspectTaskRunnable(QSystemInformationService *service);
98 ~AspectTaskRunnable();
99
100 bool isRequired() const override;
101 void run() override;
102
103 void setPooler(QThreadPooler *pooler) override { m_pooler = pooler; }
104
105 void setReserved(bool reserved) override { m_reserved = reserved; }
106 bool reserved() override { return m_reserved; }
107
108 int id() override { return m_id; }
109 void setId(int id) override { m_id = id; }
110
111 RunnableType type() const Q_DECL_OVERRIDE { return RunnableType::AspectTask; }
112
113public:
114 QSharedPointer<QAspectJob> m_job;
115 QVector<AspectTaskRunnable *> m_dependers;
116 int m_dependerCount = 0;
117
118private:
119 QSystemInformationService *m_service;
120 QThreadPooler *m_pooler;
121 int m_id; // For testing purposes for now
122 bool m_reserved;
123};
124
125class SyncTaskRunnable : public RunnableInterface
126{
127public:
128 explicit SyncTaskRunnable(QAbstractAspectJobManager::JobFunction func, void *arg,
129 QAtomicInt *atomicCount);
130 ~SyncTaskRunnable();
131
132 bool isRequired() const override;
133 void run() override;
134
135 void setPooler(QThreadPooler *pooler) override { m_pooler = pooler; }
136
137 void setReserved(bool reserved) override { m_reserved = reserved; }
138 bool reserved() override { return m_reserved; }
139
140 int id() override { return m_id; }
141 void setId(int id) override { m_id = id; }
142
143 RunnableType type() const Q_DECL_OVERRIDE { return RunnableType::SyncTask; }
144
145private:
146 QAbstractAspectJobManager::JobFunction m_func;
147 void *m_arg;
148 QAtomicInt *m_atomicCount;
149
150 QThreadPooler *m_pooler;
151 bool m_reserved;
152
153 int m_id;
154};
155
156} // namespace Qt3DCore
157
158QT_END_NAMESPACE
159
160#endif // QT3DCORE_TASK_P_H
161
162

source code of qt3d/src/core/jobs/task_p.h