doxygen: intern/itasc tagged
[blender.git] / intern / memutil / MEM_RefCounted.h
1 /**
2  * $Id$
3  * ***** BEGIN GPL 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.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  *
19  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
20  * All rights reserved.
21  *
22  * The Original Code is: all of this file.
23  *
24  * Contributor(s): none yet.
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28 /**
29  * @file        MEM_RefCounted.h
30  * Declaration of MEM_RefCounted class.
31  */
32
33 #ifndef MEM_REFCOUNTED_H
34 #define MEM_REFCOUNTED_H
35
36 /**
37  * An object with reference counting.
38  * Base class for objects with reference counting.
39  * When a shared object is ceated, it has reference count == 1.
40  * If the the reference count of a shared object reaches zero, the object self-destructs.
41  * The default destructor of this object has been made protected on purpose.
42  * This disables the creation of shared objects on the stack.
43  *
44  * @author      Maarten Gribnau
45  * @date        March 31, 2001
46  */
47
48 class MEM_RefCounted {
49 public:
50         /**
51          * Constructs a a shared object.
52          */
53         MEM_RefCounted() : m_refCount(1)
54         {
55         }
56
57         /** 
58          * Returns the reference count of this object.
59          * @return the reference count.
60          */
61         inline virtual int getRef() const;
62
63         /** 
64          * Increases the reference count of this object.
65          * @return the new reference count.
66          */
67         inline virtual int incRef();
68
69         /** 
70          * Decreases the reference count of this object.
71          * If the the reference count reaches zero, the object self-destructs.
72          * @return the new reference count.
73          */
74         inline virtual int decRef();
75
76 protected:
77         /**
78          * Destructs a shared object.
79          * The destructor is protected to force the use of incRef and decRef.
80          */
81         virtual ~MEM_RefCounted()
82         {
83         }
84
85 protected:
86         /// The reference count.
87         int m_refCount;
88 };
89
90
91 inline int MEM_RefCounted::getRef() const
92 {
93         return m_refCount;
94 }
95
96 inline int MEM_RefCounted::incRef()
97 {
98         return ++m_refCount;
99 }
100
101 inline int MEM_RefCounted::decRef()
102 {
103         m_refCount--;
104         if (m_refCount == 0) {
105                 delete this;
106                 return 0;
107         }
108         return m_refCount;
109 }
110
111 #endif // MEM_REFCOUNTED_H
112