src/corelib/tools/qscopedpointer_p.h

   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 QtCore 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 //
  43 //  W A R N I N G
  44 //  -------------
  45 //
  46 // This file is not part of the Qt API.  It exists for the convenience
  47 // of internal files.  This header file may change from version to version
  48 // without notice, or even be removed.
  49 //
  50 // We mean it.
  51 //
  52
  53 #ifndef QSCOPEDPOINTER_P_H
  54 #define QSCOPEDPOINTER_P_H
  55
  56 #include "QtCore/qscopedpointer.h"
  57
  58 QT_BEGIN_HEADER
  59 QT_BEGIN_NAMESPACE
  60
  61
  62 /* Internal helper class - exposes the data through data_ptr (legacy from QShared).
  63    Required for some internal Qt classes, do not use otherwise. */
  64 template <typename T, typename Cleanup = QScopedPointerDeleter<T> >
  65 class QCustomScopedPointer : public QScopedPointer<T, Cleanup>
  66 {
  67 public:
  68     explicit inline QCustomScopedPointer(T *p = 0)
  69         : QScopedPointer<T, Cleanup>(p)
  70     {
  71     }
  72
  73     inline T *&data_ptr()
  74     {
  75         return this->d;
  76     }
  77
  78     inline bool operator==(const QCustomScopedPointer<T, Cleanup> &other) const
  79     {
  80         return this->d == other.d;
  81     }
  82
  83     inline bool operator!=(const QCustomScopedPointer<T, Cleanup> &other) const
  84     {
  85         return this->d != other.d;
  86     }
  87
  88 private:
  89     Q_DISABLE_COPY(QCustomScopedPointer)
  90 };
  91
  92 /* Internal helper class - a handler for QShared* classes, to be used in QCustomScopedPointer */
  93 template <typename T>
  94 class QScopedPointerSharedDeleter
  95 {
  96 public:
  97     static inline void cleanup(T *d)
  98     {
  99         if (d && !d->ref.deref())
 100             delete d;
 101     }
 102 };
 103
 104 /* Internal.
 105    This class is basically a scoped pointer pointing to a ref-counted object
 106  */
 107 template <typename T>
 108 class QScopedSharedPointer : public QCustomScopedPointer<T, QScopedPointerSharedDeleter<T> >
 109 {
 110 public:
 111     explicit inline QScopedSharedPointer(T *p = 0)
 112         : QCustomScopedPointer<T, QScopedPointerSharedDeleter<T> >(p)
 113     {
 114     }
 115
 116     inline void detach()
 117     {
 118         qAtomicDetach(this->d);
 119     }
 120
 121     inline void assign(T *other)
 122     {
 123         if (this->d == other)
 124             return;
 125         if (other)
 126             other->ref.ref();
 127         T *oldD = this->d;
 128         this->d = other;
 129         QScopedPointerSharedDeleter<T>::cleanup(oldD);
 130     }
 131
 132     inline bool operator==(const QScopedSharedPointer<T> &other) const
 133     {
 134         return this->d == other.d;
 135     }
 136
 137     inline bool operator!=(const QScopedSharedPointer<T> &other) const
 138     {
 139         return this->d != other.d;
 140     }
 141
 142 private:
 143     Q_DISABLE_COPY(QScopedSharedPointer)
 144 };
 145
 146
 147 QT_END_NAMESPACE
 148 QT_END_HEADER
 149
 150 #endif