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