src/qml/qml/qqmlcleanup.cpp

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   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 Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #include "qqmlcleanup_p.h"
  43
  44 #include "qqmlengine_p.h"
  45
  46 QT_BEGIN_NAMESPACE
  47
  48 /*!
  49 \internal
  50 \class QQmlCleanup
  51 \brief The QQmlCleanup provides a callback when a QQmlEngine is deleted.
  52
  53 Any object that needs cleanup to occur before the QQmlEngine's V8 engine is
  54 destroyed should inherit from QQmlCleanup.  The clear() virtual method will be
  55 called by QQmlEngine just before it destroys the context.
  56 */
  57
  58
  59 /*
  60 Create a QQmlCleanup that is not associated with any engine.
  61 */
  62 QQmlCleanup::QQmlCleanup()
  63 : prev(0), next(0), engine(0)
  64 {
  65 }
  66
  67 /*!
  68 Create a QQmlCleanup for \a engine
  69 */
  70 QQmlCleanup::QQmlCleanup(QQmlEngine *engine)
  71 : prev(0), next(0), engine(0)
  72 {
  73     if (!engine)
  74         return;
  75
  76     addToEngine(engine);
  77 }
  78
  79 /*!
  80 Adds this object to \a engine's cleanup list.  hasEngine() must be false
  81 before calling this method.
  82 */
  83 void QQmlCleanup::addToEngine(QQmlEngine *engine)
  84 {
  85     Q_ASSERT(engine);
  86     Q_ASSERT(QQmlEnginePrivate::isEngineThread(engine));
  87
  88     this->engine = engine;
  89
  90     QQmlEnginePrivate *p = QQmlEnginePrivate::get(engine);
  91
  92     if (p->cleanup) next = p->cleanup;
  93     p->cleanup = this;
  94     prev = &p->cleanup;
  95     if (next) next->prev = &next;
  96 }
  97
  98 /*!
  99 \fn bool QQmlCleanup::hasEngine() const
 100
 101 Returns true if this QQmlCleanup is associated with an engine, otherwise false.
 102 */
 103
 104 /*!
 105 \internal
 106 */
 107 QQmlCleanup::~QQmlCleanup()
 108 {
 109     Q_ASSERT(!prev || engine);
 110     Q_ASSERT(!prev || QQmlEnginePrivate::isEngineThread(engine));
 111
 112     if (prev) *prev = next;
 113     if (next) next->prev = prev;
 114     prev = 0;
 115     next = 0;
 116 }
 117
 118 QT_END_NAMESPACE