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 | #include "qqmlcleanup_p.h" |
41 | |
42 | #include "qqmlengine_p.h" |
43 | |
44 | QT_BEGIN_NAMESPACE |
45 | |
46 | /*! |
47 | \internal |
48 | \class QQmlCleanup |
49 | \brief The QQmlCleanup provides a callback when a QQmlEngine is deleted. |
50 | |
51 | Any object that needs cleanup to occur before the QQmlEngine's V8 engine is |
52 | destroyed should inherit from QQmlCleanup. The clear() virtual method will be |
53 | called by QQmlEngine just before it destroys the context. |
54 | */ |
55 | |
56 | |
57 | /* |
58 | Create a QQmlCleanup that is not associated with any engine. |
59 | */ |
60 | QQmlCleanup::QQmlCleanup() |
61 | : prev(nullptr), next(nullptr), engine(nullptr) |
62 | { |
63 | } |
64 | |
65 | /*! |
66 | Create a QQmlCleanup for \a engine |
67 | */ |
68 | QQmlCleanup::QQmlCleanup(QQmlEngine *engine) |
69 | : prev(nullptr), next(nullptr), engine(nullptr) |
70 | { |
71 | if (!engine) |
72 | return; |
73 | |
74 | addToEngine(engine); |
75 | } |
76 | |
77 | /*! |
78 | Adds this object to \a engine's cleanup list. hasEngine() must be false |
79 | before calling this method. |
80 | */ |
81 | void QQmlCleanup::addToEngine(QQmlEngine *engine) |
82 | { |
83 | Q_ASSERT(engine); |
84 | Q_ASSERT(QQmlEnginePrivate::isEngineThread(engine)); |
85 | |
86 | this->engine = engine; |
87 | |
88 | QQmlEnginePrivate *p = QQmlEnginePrivate::get(e: engine); |
89 | |
90 | if (p->cleanup) next = p->cleanup; |
91 | p->cleanup = this; |
92 | prev = &p->cleanup; |
93 | if (next) next->prev = &next; |
94 | } |
95 | |
96 | /*! |
97 | \fn bool QQmlCleanup::hasEngine() const |
98 | |
99 | Returns true if this QQmlCleanup is associated with an engine, otherwise false. |
100 | */ |
101 | |
102 | /*! |
103 | \internal |
104 | */ |
105 | QQmlCleanup::~QQmlCleanup() |
106 | { |
107 | Q_ASSERT(!prev || engine); |
108 | Q_ASSERT(!prev || QQmlEnginePrivate::isEngineThread(engine)); |
109 | |
110 | if (prev) *prev = next; |
111 | if (next) next->prev = prev; |
112 | prev = nullptr; |
113 | next = nullptr; |
114 | } |
115 | |
116 | QT_END_NAMESPACE |
117 | |