intern/memutil/MEM_RefCounted.h

   1 /**
   2  * $Id$
   3  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License
   7  * as published by the Free Software Foundation; either version 2
   8  * of the License, or (at your option) any later version. The Blender
   9  * Foundation also sells licenses for use in proprietary software under
  10  * the Blender License.  See http://www.blender.org/BL/ for information
  11  * about this.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software Foundation,
  20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  21  *
  22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
  23  * All rights reserved.
  24  *
  25  * The Original Code is: all of this file.
  26  *
  27  * Contributor(s): none yet.
  28  *
  29  * ***** END GPL/BL DUAL LICENSE BLOCK *****
  30  */
  31
  32 /**
  33
  34  * $Id$
  35  * Copyright (C) 2001 NaN Technologies B.V.
  36  * @author      Maarten Gribnau
  37  * @date        March 31, 2001
  38  */
  39
  40 #ifndef _H_MEM_REF_COUNTED
  41 #define _H_MEM_REF_COUNTED
  42
  43 #ifdef HAVE_CONFIG_H
  44 #include <config.h>
  45 #endif
  46
  47 /**
  48  * An object with reference counting.
  49  * Base class for objects with reference counting.
  50  * When a shared object is ceated, it has reference count == 1.
  51  * If the the reference count of a shared object reaches zero, the object self-destructs.
  52  * The default destructor of this object has been made protected on purpose.
  53  * This disables the creation of shared objects on the stack.
  54  *
  55  * @author      Maarten Gribnau
  56  * @date        March 31, 2001
  57  */
  58
  59 class MEM_RefCounted {
  60 public:
  61         /**
  62          * Constructs a a shared object.
  63          */
  64         MEM_RefCounted() : m_refCount(1)
  65         {
  66         }
  67
  68         /**
  69          * Returns the reference count of this object.
  70          * @return the reference count.
  71          */
  72         inline virtual int getRef() const;
  73
  74         /**
  75          * Increases the reference count of this object.
  76          * @return the new reference count.
  77          */
  78         inline virtual int incRef();
  79
  80         /**
  81          * Decreases the reference count of this object.
  82          * If the the reference count reaches zero, the object self-destructs.
  83          * @return the new reference count.
  84          */
  85         inline virtual int decRef();
  86
  87 protected:
  88         /**
  89          * Destructs a shared object.
  90          * The destructor is protected to force the use of incRef and decRef.
  91          */
  92         virtual ~MEM_RefCounted()
  93         {
  94         }
  95
  96 protected:
  97         /// The reference count.
  98         int m_refCount;
  99 };
 100
 101
 102 inline int MEM_RefCounted::getRef() const
 103 {
 104         return m_refCount;
 105 }
 106
 107 inline int MEM_RefCounted::incRef()
 108 {
 109         return ++m_refCount;
 110 }
 111
 112 inline int MEM_RefCounted::decRef()
 113 {
 114         m_refCount--;
 115         if (m_refCount == 0) {
 116                 delete this;
 117                 return 0;
 118         }
 119         return m_refCount;
 120 }
 121
 122 #endif // _H_MEM_REF_COUNTED
 123