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
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
|
/*
* Copyright (C) 2005-2013 Team XBMC
* http://xbmc.org
*
* 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, 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 XBMC; see the file COPYING. If not, see
* <http://www.gnu.org/licenses/>.
*
*/
#pragma once
/**
* Defining LOG_LIFECYCLE_EVENTS will log all instantiations, deletions
* and also reference countings (increments and decrements) that take
* place on any Addon* class.
*
* Comment out (or uncomment out) to change the setting.
*/
//#define LOG_LIFECYCLE_EVENTS
/**
* Defining XBMC_ADDON_DEBUG_MEMORY will make the Acquire and Release
* methods virtual allow the developer to overload them in a sub-class
* and set breakpoints to aid in debugging. It will also cause the
* reference counting mechanism to never actually delete any AddonClass
* instance allowing for the tracking of more references to (supposedly)
* deallocated classes.
*
* Comment out (or uncomment out) to change the setting.
*/
//#define XBMC_ADDON_DEBUG_MEMORY
#include "AddonString.h"
#include "threads/SingleLock.h"
#include "threads/Atomics.h"
#ifdef XBMC_ADDON_DEBUG_MEMORY
#include "utils/log.h"
#endif
#include "AddonUtils.h"
#include <typeindex>
namespace XBMCAddon
{
class LanguageHook;
/**
* This class is the superclass for all reference counted classes in the api.
* It provides a means for the bindings to handle all api objects generically.
*
* It also provides some means for debugging "lifecycle" events (see the above
* description of LOG_LIFECYCLE_EVENTS).
*
* If a scripting language bindings require specific handling there is a
* hook to add in these language specifics that can be set here.
*/
class AddonClass : public CCriticalSection
{
private:
long refs;
bool m_isDeallocating;
// no copying
inline AddonClass(const AddonClass&);
#ifdef XBMC_ADDON_DEBUG_MEMORY
bool isDeleted;
#endif
protected:
LanguageHook* languageHook;
/**
* This method is meant to be called from the destructor of the
* lowest level class.
*
* It's virtual because it's a conveinent place to receive messages that
* we're about to go be deleted but prior to any real tear-down.
*
* Any overloading classes need to remember to pass the call up the chain.
*/
virtual void deallocating()
{
CSingleLock lock(*this);
m_isDeallocating = true;
}
/**
* This is meant to be called during static initialization and so isn't
* synchronized.
*/
static short getNextClassIndex();
public:
AddonClass();
virtual ~AddonClass();
inline const char* GetClassname() const { return typeid(*this).name(); }
inline LanguageHook* GetLanguageHook() { return languageHook; }
/**
* This method should be called while holding a Synchronize
* on the object. It will prevent the deallocation during
* the time it's held.
*/
bool isDeallocating() { XBMC_TRACE; return m_isDeallocating; }
static short getNumAddonClasses();
#ifdef XBMC_ADDON_DEBUG_MEMORY
virtual
#else
inline
#endif
void Release() const
#ifndef XBMC_ADDON_DEBUG_MEMORY
{
long ct = AtomicDecrement((long*)&refs);
#ifdef LOG_LIFECYCLE_EVENTS
CLog::Log(LOGDEBUG,"NEWADDON REFCNT decrementing to %ld on %s 0x%lx", ct,GetClassname(), (long)(((void*)this)));
#endif
if(ct == 0)
delete this;
}
#else
;
#endif
#ifdef XBMC_ADDON_DEBUG_MEMORY
virtual
#else
inline
#endif
void Acquire() const
#ifndef XBMC_ADDON_DEBUG_MEMORY
{
#ifdef LOG_LIFECYCLE_EVENTS
CLog::Log(LOGDEBUG,"NEWADDON REFCNT incrementing to %ld on %s 0x%lx",
AtomicIncrement((long*)&refs),GetClassname(), (long)(((void*)this)));
#else
AtomicIncrement((long*)&refs);
#endif
}
#else
;
#endif
#define refcheck
/**
* This class is a smart pointer for a Referenced class.
*/
template <class T> class Ref
{
T * ac;
public:
inline Ref() : ac(NULL) {}
inline Ref(const T* _ac) : ac((T*)_ac) { if (ac) ac->Acquire(); refcheck; }
// copy semantics
inline Ref(Ref<T> const & oref) : ac((T*)(oref.get())) { if (ac) ac->Acquire(); refcheck; }
template<class O> inline Ref(Ref<O> const & oref) : ac(static_cast<T*>(oref.get())) { if (ac) ac->Acquire(); refcheck; }
/**
* operator= should work with either another smart pointer or a pointer since it will
* be able to convert a pointer to a smart pointer using one of the above constuctors.
*
* Note: There is a trick here. The temporary variable is necessary because otherwise the
* following code will fail:
*
* Ref<T> ptr = new T;
* ptr = ptr;
*
* What happens without the tmp is the dereference is called first so the object ends up
* deleted and then the reference happens on a deleted object. The order is reversed
* in the following.
*
* Note: Operator= is ambiguous if you define both an operator=(Ref<T>&) and an operator=(T*). I'm
* opting for the route the boost took here figuring it has more history behind it.
*/
inline Ref<T>& operator=(Ref<T> const & oref)
{ T* tmp = ac; ac=((T*)oref.get()); if (ac) ac->Acquire(); if (tmp) tmp->Release(); refcheck; return *this; }
inline T* operator->() const { refcheck; return ac; }
/**
* This operator doubles as the value in a boolean expression.
*/
inline operator T*() const { refcheck; return ac; }
inline T* get() const { refcheck; return ac; }
inline T& getRef() const { refcheck; return *ac; }
inline ~Ref() { refcheck; if (ac) ac->Release(); }
inline bool isNull() const { refcheck; return ac == NULL; }
inline bool isNotNull() const { refcheck; return ac != NULL; }
inline bool isSet() const { refcheck; return ac != NULL; }
inline bool operator!() const { refcheck; return ac == NULL; }
inline bool operator==(const AddonClass::Ref<T>& oref) const { refcheck; return ac == oref.ac; }
inline bool operator<(const AddonClass::Ref<T>& oref) const { refcheck; return ac < oref.ac; } // std::set semantics
// This is there only for boost compatibility
template<class O> inline void reset(Ref<O> const & oref) { refcheck; (*this) = static_cast<T*>(oref.get()); refcheck; }
template<class O> inline void reset(O * oref) { refcheck; (*this) = static_cast<T*>(oref); refcheck; }
inline void reset() { refcheck; if (ac) ac->Release(); ac = NULL; }
};
};
}
|
