src/declarative/qml/ftw/qdeclarativerefcount_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: http://www.qt-project.org/
   6 **
   7 ** This file is part of the QtDeclarative module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QDECLARATIVEREFCOUNT_P_H
  43 #define QDECLARATIVEREFCOUNT_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 purely as an
  50 // implementation detail.  This header file may change from version to
  51 // version without notice, or even be removed.
  52 //
  53 // We mean it.
  54 //
  55
  56 #include <QtCore/qglobal.h>
  57 #include <QtCore/qatomic.h>
  58
  59 QT_BEGIN_HEADER
  60
  61 QT_BEGIN_NAMESPACE
  62
  63
  64 class QDeclarativeRefCount
  65 {
  66 public:
  67     inline QDeclarativeRefCount();
  68     inline virtual ~QDeclarativeRefCount();
  69     inline void addref();
  70     inline void release();
  71
  72 protected:
  73     inline virtual void destroy();
  74
  75 private:
  76     QAtomicInt refCount;
  77 };
  78
  79 template<class T>
  80 class QDeclarativeRefPointer
  81 {
  82 public:
  83     inline QDeclarativeRefPointer();
  84     inline QDeclarativeRefPointer(T *);
  85     inline QDeclarativeRefPointer(const QDeclarativeRefPointer<T> &);
  86     inline ~QDeclarativeRefPointer();
  87
  88     inline QDeclarativeRefPointer<T> &operator=(const QDeclarativeRefPointer<T> &o);
  89     inline QDeclarativeRefPointer<T> &operator=(T *);
  90
  91     inline bool isNull() const { return !o; }
  92
  93     inline T* operator->() const { return o; }
  94     inline T& operator*() const { return *o; }
  95     inline operator T*() const { return o; }
  96     inline T* data() const { return o; }
  97
  98     inline QDeclarativeRefPointer<T> &take(T *);
  99
 100 private:
 101     T *o;
 102 };
 103
 104 QDeclarativeRefCount::QDeclarativeRefCount()
 105 : refCount(1)
 106 {
 107 }
 108
 109 QDeclarativeRefCount::~QDeclarativeRefCount()
 110 {
 111     Q_ASSERT(refCount.load() == 0);
 112 }
 113
 114 void QDeclarativeRefCount::addref()
 115 {
 116     Q_ASSERT(refCount.load() > 0);
 117     refCount.ref();
 118 }
 119
 120 void QDeclarativeRefCount::release()
 121 {
 122     Q_ASSERT(refCount.load() > 0);
 123     if (!refCount.deref())
 124         destroy();
 125 }
 126
 127 void QDeclarativeRefCount::destroy()
 128 {
 129     delete this;
 130 }
 131
 132 template<class T>
 133 QDeclarativeRefPointer<T>::QDeclarativeRefPointer()
 134 : o(0)
 135 {
 136 }
 137
 138 template<class T>
 139 QDeclarativeRefPointer<T>::QDeclarativeRefPointer(T *o)
 140 : o(o)
 141 {
 142     if (o) o->addref();
 143 }
 144
 145 template<class T>
 146 QDeclarativeRefPointer<T>::QDeclarativeRefPointer(const QDeclarativeRefPointer<T> &other)
 147 : o(other.o)
 148 {
 149     if (o) o->addref();
 150 }
 151
 152 template<class T>
 153 QDeclarativeRefPointer<T>::~QDeclarativeRefPointer()
 154 {
 155     if (o) o->release();
 156 }
 157
 158 template<class T>
 159 QDeclarativeRefPointer<T> &QDeclarativeRefPointer<T>::operator=(const QDeclarativeRefPointer<T> &other)
 160 {
 161     if (other.o) other.o->addref();
 162     if (o) o->release();
 163     o = other.o;
 164     return *this;
 165 }
 166
 167 template<class T>
 168 QDeclarativeRefPointer<T> &QDeclarativeRefPointer<T>::operator=(T *other)
 169 {
 170     if (other) other->addref();
 171     if (o) o->release();
 172     o = other;
 173     return *this;
 174 }
 175
 176 /*!
 177 Takes ownership of \a other.  take() does *not* add a reference, as it assumes ownership
 178 of the callers reference of other.
 179 */
 180 template<class T>
 181 QDeclarativeRefPointer<T> &QDeclarativeRefPointer<T>::take(T *other)
 182 {
 183     if (o) o->release();
 184     o = other;
 185     return *this;
 186 }
 187
 188 QT_END_NAMESPACE
 189
 190 QT_END_HEADER
 191
 192 #endif // QDECLARATIVEREFCOUNT_P_H