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 QtQml 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 QANIMATIONJOBUTIL_P_H
41#define QANIMATIONJOBUTIL_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 purely as an
48// implementation detail. 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 <type_traits>
55
56QT_REQUIRE_CONFIG(qml_animation);
57
58// SelfDeletable is used for self-destruction detection along with
59// ACTION_IF_DELETED and RETURN_IF_DELETED macros. While using, the objects
60// under test should have a member m_selfDeletable of type SelfDeletable
61struct SelfDeletable {
62 ~SelfDeletable() {
63 if (m_wasDeleted)
64 *m_wasDeleted = true;
65 }
66 bool *m_wasDeleted = nullptr;
67};
68
69// \param p pointer to object under test, which should have a member m_selfDeletable of type SelfDeletable
70// \param func statements or functions that to be executed under test.
71// \param action post process if p was deleted under test.
72#define ACTION_IF_DELETED(p, func, action) \
73{ \
74 static_assert(std::is_same<decltype((p)->m_selfDeletable), SelfDeletable>::value, "m_selfDeletable must be SelfDeletable");\
75 bool *prevWasDeleted = (p)->m_selfDeletable.m_wasDeleted; \
76 bool wasDeleted = false; \
77 (p)->m_selfDeletable.m_wasDeleted = &wasDeleted; \
78 {func;} \
79 if (wasDeleted) { \
80 if (prevWasDeleted) \
81 *prevWasDeleted = true; \
82 {action;} \
83 } \
84 (p)->m_selfDeletable.m_wasDeleted = prevWasDeleted; \
85}
86
87#define RETURN_IF_DELETED(func) \
88ACTION_IF_DELETED(this, func, return)
89
90#endif // QANIMATIONJOBUTIL_P_H
91