src/ScopedPtr.h

   1 //
   2 // This file is part of the aMule Project.
   3 //
   4 // Copyright (c) 2006-2008 Mikkel Schubert ( xaignar@users.sourceforge.net )
   5 // Copyright (c) 2006-2008 aMule Team ( admin@amule.org / http://www.amule.org )
   6 //
   7 // Any parts of this program derived from the xMule, lMule or eMule project,
   8 // or contributed by third-party developers are copyrighted by their
   9 // respective authors.
  10 //
  11 // This program is free software; you can redistribute it and/or modify
  12 // it under the terms of the GNU General Public License as published by
  13 // the Free Software Foundation; either version 2 of the License, or
  14 // (at your option) any later version.
  15 //
  16 // This program is distributed in the hope that it will be useful,
  17 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 // GNU General Public License for more details.
  20 //
  21 // You should have received a copy of the GNU General Public License
  22 // along with this program; if not, write to the Free Software
  23 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
  24 //
  25
  26 #ifndef SCOPEDPTR_H
  27 #define SCOPEDPTR_H
  28
  29
  30 /**
  31  * CScopedPtr is a simple smart pointer.
  32  *
  33  * This class is a replacement for std::auto_ptr, with simpler
  34  * copying schematics, in that it doesn't allow copying or
  35  * assignment, compared to auto_ptr, which allows only one
  36  * instance to own a pointer (swapping at assignment).
  37  */
  38 template <typename TYPE>
  39 class CScopedPtr
  40 {
  41 public:
  42         /** Constructor. Note that CScopedPtr takes ownership of the pointer. */
  43         CScopedPtr(TYPE* ptr);
  44
  45         /** Frees the pointer owned by the instance. */
  46         ~CScopedPtr();
  47
  48
  49         //@{
  50         /** Deference operators. */
  51         TYPE& operator*() const;
  52         TYPE* operator->() const;
  53         //@}
  54
  55
  56         /** Returns the actual pointer value. */
  57         TYPE* get() const;
  58
  59         /** Sets the actual pointer to a different value. The old pointer is freed. */
  60         void reset(TYPE* ptr = 0);
  61
  62         /** Returns the actual pointer. The scoped-ptr will thereafter contain NULL. */
  63         TYPE* release();
  64
  65 private:
  66         //@{
  67         //! A scoped pointer is neither copyable, nor assignable.
  68         CScopedPtr(const CScopedPtr<TYPE>&);
  69         CScopedPtr<TYPE>& operator=(const CScopedPtr<TYPE>&);
  70         //@}
  71
  72         TYPE* m_ptr;
  73 };
  74
  75
  76 /**
  77  * Similar to CScopedPtr, except that an array is expected.
  78  *
  79  * @see CScopedPtr
  80  */
  81 template <typename TYPE>
  82 class CScopedArray
  83 {
  84 public:
  85         /** Constructor. Note that CScopedArray takes ownership of the array. */
  86         CScopedArray(TYPE* ptr);
  87
  88         /** Frees the array owned by this instance. */
  89         ~CScopedArray();
  90
  91
  92         /** Accessor. */
  93         TYPE& operator[](unsigned i) const;
  94
  95
  96         /** @see CScopedPtr::get */
  97         TYPE* get() const;
  98
  99         /** @see CScopedPtr::reset */
 100         void reset(TYPE* ptr = 0);
 101
 102         /** @see CScopedPtr::release */
 103         TYPE* release();
 104
 105 private:
 106         //@{
 107         //! A scoped array is neither copyable, nor assignable.
 108         CScopedArray(const CScopedArray<TYPE>&);
 109         CScopedArray<TYPE>& operator=(const CScopedArray<TYPE>&);
 110         //@}
 111
 112         TYPE* m_ptr;
 113 };
 114
 115
 116
 117
 118 ////////////////////////////////////////////////////////////
 119 // Implementations
 120
 121 template <typename TYPE>
 122 CScopedPtr<TYPE>::CScopedPtr(TYPE* ptr)
 123         : m_ptr(ptr)
 124 {
 125 }
 126
 127
 128 template <typename TYPE>
 129 CScopedPtr<TYPE>::~CScopedPtr()
 130 {
 131         delete m_ptr;
 132 }
 133
 134
 135 template <typename TYPE>
 136 TYPE& CScopedPtr<TYPE>::operator*() const
 137 {
 138         return *m_ptr;
 139 }
 140
 141
 142 template <typename TYPE>
 143 TYPE* CScopedPtr<TYPE>::operator->() const
 144 {
 145         return m_ptr;
 146 }
 147
 148
 149 template <typename TYPE>
 150 TYPE* CScopedPtr<TYPE>::get() const
 151 {
 152         return m_ptr;
 153 }
 154
 155
 156 template <typename TYPE>
 157 void CScopedPtr<TYPE>::reset(TYPE* ptr)
 158 {
 159         delete m_ptr;
 160         m_ptr = ptr;
 161 }
 162
 163
 164 template <typename TYPE>
 165 TYPE* CScopedPtr<TYPE>::release()
 166 {
 167         TYPE* ptr = m_ptr;
 168         m_ptr = 0;
 169         return ptr;
 170 }
 171
 172
 173
 174 template <typename TYPE>
 175 CScopedArray<TYPE>::CScopedArray(TYPE* ptr)
 176         : m_ptr(ptr)
 177 {
 178 }
 179
 180
 181 template <typename TYPE>
 182 CScopedArray<TYPE>::~CScopedArray()
 183 {
 184         delete[] m_ptr;
 185 }
 186
 187
 188 template <typename TYPE>
 189 TYPE& CScopedArray<TYPE>::operator[](unsigned i) const
 190 {
 191         return m_ptr[i];
 192 }
 193
 194
 195 template <typename TYPE>
 196 TYPE* CScopedArray<TYPE>::get() const
 197 {
 198         return m_ptr;
 199 }
 200
 201
 202 template <typename TYPE>
 203 void CScopedArray<TYPE>::reset(TYPE* ptr)
 204 {
 205         delete[] m_ptr;
 206         m_ptr = ptr;
 207 }
 208
 209
 210 template <typename TYPE>
 211 TYPE* CScopedArray<TYPE>::release()
 212 {
 213         TYPE* ptr = m_ptr;
 214         m_ptr = 0;
 215         return ptr;
 216 }
 217
 218
 219 #endif // SCOPEDPTR_H
 220 // File_checked_for_headers