Initial revision
[blender.git] / 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
44 /**
45  * An object with reference counting.
46  * Base class for objects with reference counting.
47  * When a shared object is ceated, it has reference count == 1.
48  * If the the reference count of a shared object reaches zero, the object self-destructs.
49  * The default destructor of this object has been made protected on purpose.
50  * This disables the creation of shared objects on the stack.
51  *
52  * @author      Maarten Gribnau
53  * @date        March 31, 2001
54  */
55
56 class MEM_RefCounted {
57 public:
58         /**
59          * Constructs a a shared object.
60          */
61         MEM_RefCounted() : m_refCount(1)
62         {
63         }
64
65         /** 
66          * Returns the reference count of this object.
67          * @return the reference count.
68          */
69         inline virtual int getRef() const;
70
71         /** 
72          * Increases the reference count of this object.
73          * @return the new reference count.
74          */
75         inline virtual int incRef();
76
77         /** 
78          * Decreases the reference count of this object.
79          * If the the reference count reaches zero, the object self-destructs.
80          * @return the new reference count.
81          */
82         inline virtual int decRef();
83
84 protected:
85         /**
86          * Destructs a shared object.
87          * The destructor is protected to force the use of incRef and decRef.
88          */
89         virtual ~MEM_RefCounted()
90         {
91         }
92
93 protected:
94         /// The reference count.
95         int m_refCount;
96 };
97
98
99 inline int MEM_RefCounted::getRef() const
100 {
101         return m_refCount;
102 }
103
104 inline int MEM_RefCounted::incRef()
105 {
106         return ++m_refCount;
107 }
108
109 inline int MEM_RefCounted::decRef()
110 {
111         m_refCount--;
112         if (m_refCount == 0) {
113                 delete this;
114                 return 0;
115         }
116         return m_refCount;
117 }
118
119
120 #endif // _H_MEM_REF_COUNTED