src/xmlpatterns/api/qreferencecountedvalue_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 QtXmlPatterns 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 //
  43 //  W A R N I N G
  44 //  -------------
  45 //
  46 // This file is not part of the Qt API.  It exists purely as an
  47 // implementation detail.  This header file may change from version to
  48 // version without notice, or even be removed.
  49 //
  50 // We mean it.
  51
  52 #ifndef QPatternist_ReferenceCountedValue_p_h
  53 #define QPatternist_ReferenceCountedValue_p_h
  54
  55 QT_BEGIN_HEADER
  56 QT_BEGIN_NAMESPACE
  57
  58 namespace QPatternist
  59 {
  60 /*!
  61    \class ReferenceCountedValue
  62    \internal
  63    \since 4.4
  64    \brief A template class that reference counts a value.
  65
  66    This class is useful when an instance needs to have ownership semantics
  67    as if it was value based. A typical examples is a QObject pointer, which
  68    doesn't have a single owner.
  69
  70    This is achieved through storing a copy of the object as
  71    a member inside ReferenceCountedValue, which never is copied. It will
  72    stay in scope until the last reference to the ReferenceCountedValue instance
  73    is removed, and subsequently ReferenceCountedValue is deleted and hence also
  74    the contained value. One should use ReferenceCountedValue by passing around
  75    copies of Ptr, which is a typedef for the QExplicitlySharedDataPointer
  76    smart pointer.
  77 */
  78     template<typename T>
  79     class ReferenceCountedValue : public QSharedData
  80     {
  81     public:
  82         typedef QExplicitlySharedDataPointer<ReferenceCountedValue<T> > Ptr;
  83
  84         inline ReferenceCountedValue(T *const v) : value(v)
  85         {
  86         }
  87
  88         inline ~ReferenceCountedValue()
  89         {
  90             delete value;
  91         }
  92
  93         T *const value;
  94     private:
  95         /*!
  96           Disabled, no implementation provided.
  97          */
  98         inline ReferenceCountedValue();
  99         Q_DISABLE_COPY(ReferenceCountedValue)
 100     };
 101 }
 102
 103 QT_END_NAMESPACE
 104 QT_END_HEADER
 105
 106 #endif