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