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