src/qml/qml/qqmlguard_p.h

   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 QtCore 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 #ifndef QQMLGUARD_P_H
  43 #define QQMLGUARD_P_H
  44
  45 //
  46 //  W A R N I N G
  47 //  -------------
  48 //
  49 // This file is not part of the Qt API.  It exists for the convenience
  50 // of qapplication_*.cpp, qwidget*.cpp and qfiledialog.cpp.  This header
  51 // file may change from version to version without notice, or even be removed.
  52 //
  53 // We mean it.
  54 //
  55
  56 #include <QtCore/qglobal.h>
  57 #include <QtCore/qvariant.h>
  58 #include <private/qqmldata_p.h>
  59
  60 QT_BEGIN_NAMESPACE
  61
  62 class QQmlGuardImpl
  63 {
  64 public:
  65     inline QQmlGuardImpl();
  66     inline QQmlGuardImpl(QObject *);
  67     inline QQmlGuardImpl(const QQmlGuardImpl &);
  68     inline ~QQmlGuardImpl();
  69
  70     QObject *o;
  71     QQmlGuardImpl  *next;
  72     QQmlGuardImpl **prev;
  73
  74     inline void addGuard();
  75     inline void remGuard();
  76 };
  77
  78 class QObject;
  79 template<class T>
  80 class QQmlGuard : private QQmlGuardImpl
  81 {
  82     friend class QQmlData;
  83 public:
  84     inline QQmlGuard();
  85     inline QQmlGuard(T *);
  86     inline QQmlGuard(const QQmlGuard<T> &);
  87     inline virtual ~QQmlGuard();
  88
  89     inline QQmlGuard<T> &operator=(const QQmlGuard<T> &o);
  90     inline QQmlGuard<T> &operator=(T *);
  91
  92     inline T *object() const;
  93     inline void setObject(T *g);
  94
  95     inline bool isNull() const
  96         { return !o; }
  97
  98     inline T* operator->() const
  99         { return static_cast<T*>(const_cast<QObject*>(o)); }
 100     inline T& operator*() const
 101         { return *static_cast<T*>(const_cast<QObject*>(o)); }
 102     inline operator T*() const
 103         { return static_cast<T*>(const_cast<QObject*>(o)); }
 104     inline T* data() const
 105         { return static_cast<T*>(const_cast<QObject*>(o)); }
 106
 107 protected:
 108     virtual void objectDestroyed(T *) {}
 109 };
 110
 111 QT_END_NAMESPACE
 112
 113 Q_DECLARE_METATYPE(QQmlGuard<QObject>)
 114
 115 QT_BEGIN_NAMESPACE
 116
 117 QQmlGuardImpl::QQmlGuardImpl()
 118 : o(0), next(0), prev(0)
 119 {
 120 }
 121
 122 QQmlGuardImpl::QQmlGuardImpl(QObject *g)
 123 : o(g), next(0), prev(0)
 124 {
 125     if (o) addGuard();
 126 }
 127
 128 QQmlGuardImpl::QQmlGuardImpl(const QQmlGuardImpl &g)
 129 : o(g.o), next(0), prev(0)
 130 {
 131     if (o) addGuard();
 132 }
 133
 134 QQmlGuardImpl::~QQmlGuardImpl()
 135 {
 136     if (prev) remGuard();
 137     o = 0;
 138 }
 139
 140 void QQmlGuardImpl::addGuard()
 141 {
 142     Q_ASSERT(!prev);
 143
 144     if (QObjectPrivate::get(o)->wasDeleted)
 145         return;
 146
 147     QQmlData *data = QQmlData::get(o, true);
 148     next = data->guards;
 149     if (next) next->prev = &next;
 150     data->guards = this;
 151     prev = &data->guards;
 152 }
 153
 154 void QQmlGuardImpl::remGuard()
 155 {
 156     Q_ASSERT(prev);
 157
 158     if (next) next->prev = prev;
 159     *prev = next;
 160     next = 0;
 161     prev = 0;
 162 }
 163
 164 template<class T>
 165 QQmlGuard<T>::QQmlGuard()
 166 {
 167 }
 168
 169 template<class T>
 170 QQmlGuard<T>::QQmlGuard(T *g)
 171 : QQmlGuardImpl(g)
 172 {
 173 }
 174
 175 template<class T>
 176 QQmlGuard<T>::QQmlGuard(const QQmlGuard<T> &g)
 177 : QQmlGuardImpl(g)
 178 {
 179 }
 180
 181 template<class T>
 182 QQmlGuard<T>::~QQmlGuard()
 183 {
 184 }
 185
 186 template<class T>
 187 QQmlGuard<T> &QQmlGuard<T>::operator=(const QQmlGuard<T> &g)
 188 {
 189     setObject(g.object());
 190     return *this;
 191 }
 192
 193 template<class T>
 194 QQmlGuard<T> &QQmlGuard<T>::operator=(T *g)
 195 {
 196     setObject(g);
 197     return *this;
 198 }
 199
 200 template<class T>
 201 T *QQmlGuard<T>::object() const
 202 {
 203     return static_cast<T *>(o);
 204 };
 205
 206 template<class T>
 207 void QQmlGuard<T>::setObject(T *g)
 208 {
 209     if (g != o) {
 210         if (prev) remGuard();
 211         o = g;
 212         if (o) addGuard();
 213     }
 214 }
 215
 216 QT_END_NAMESPACE
 217
 218 #endif // QQMLGUARD_P_H