src/declarative/qml/qdeclarativecleanup.cpp

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtDeclarative module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #include "qdeclarativecleanup_p.h"
  43
  44 #include "qdeclarativeengine_p.h"
  45
  46 QT_BEGIN_NAMESPACE
  47
  48 /*!
  49 \internal
  50 \class QDeclarativeCleanup
  51 \brief The QDeclarativeCleanup provides a callback when a QDeclarativeEngine is deleted.
  52
  53 Any object that needs cleanup to occur before the QDeclarativeEngine's V8 engine is
  54 destroyed should inherit from QDeclarativeCleanup.  The clear() virtual method will be
  55 called by QDeclarativeEngine just before it destroys the context.
  56 */
  57
  58
  59 /*
  60 Create a QDeclarativeCleanup that is not associated with any engine.
  61 */
  62 QDeclarativeCleanup::QDeclarativeCleanup()
  63 : prev(0), next(0), engine(0)
  64 {
  65 }
  66
  67 /*!
  68 Create a QDeclarativeCleanup for \a engine
  69 */
  70 QDeclarativeCleanup::QDeclarativeCleanup(QDeclarativeEngine *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 QDeclarativeCleanup::addToEngine(QDeclarativeEngine *engine)
  84 {
  85     Q_ASSERT(engine);
  86     Q_ASSERT(QDeclarativeEnginePrivate::isEngineThread(engine));
  87
  88     this->engine = engine;
  89
  90     QDeclarativeEnginePrivate *p = QDeclarativeEnginePrivate::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 QDeclarativeCleanup::hasEngine() const
 100
 101 Returns true if this QDeclarativeCleanup is associated with an engine, otherwise false.
 102 */
 103
 104 /*!
 105 \internal
 106 */
 107 QDeclarativeCleanup::~QDeclarativeCleanup()
 108 {
 109     Q_ASSERT(!prev || engine);
 110     Q_ASSERT(!prev || QDeclarativeEnginePrivate::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