File: RegisterRef.cpp

package info (click to toggle)
jazz2-native 3.5.0-1
  • links: PTS, VCS
  • area: contrib
  • in suites:
  • size: 16,836 kB
  • sloc: cpp: 172,557; xml: 113; python: 36; makefile: 5; sh: 2
file content (265 lines) | stat: -rw-r--r-- 7,887 bytes parent folder | download | duplicates (2)
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
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
#if defined(WITH_ANGELSCRIPT)

#include "RegisterRef.h"
#include "../../Main.h"

#include <cstring>
#include <new>

namespace Jazz2::Scripting
{
	static void Construct(CScriptHandle* self)
	{
		new(self) CScriptHandle();
	}

	static void Construct(CScriptHandle* self, const CScriptHandle& o)
	{
		new(self) CScriptHandle(o);
	}

	// This one is not static because it needs to be friend with the CScriptHandle class
	void Construct(CScriptHandle* self, void* ref, std::int32_t typeId)
	{
		new(self) CScriptHandle(ref, typeId);
	}

	static void Destruct(CScriptHandle* self)
	{
		self->~CScriptHandle();
	}

	CScriptHandle::CScriptHandle()
	{
		m_ref = nullptr;
		m_type = nullptr;
	}

	CScriptHandle::CScriptHandle(const CScriptHandle& other)
	{
		m_ref = other.m_ref;
		m_type = other.m_type;

		AddRefHandle();
	}

	CScriptHandle::CScriptHandle(void* ref, asITypeInfo* type)
	{
		m_ref = ref;
		m_type = type;

		AddRefHandle();
	}

	// This constructor shouldn't be called from the application 
	// directly as it requires an active script context
	CScriptHandle::CScriptHandle(void* ref, std::int32_t typeId)
	{
		m_ref = nullptr;
		m_type = nullptr;

		Assign(ref, typeId);
	}

	CScriptHandle::~CScriptHandle()
	{
		ReleaseHandle();
	}

	void CScriptHandle::ReleaseHandle()
	{
		if (m_ref != nullptr && m_type != nullptr) {
			asIScriptEngine* engine = m_type->GetEngine();
			engine->ReleaseScriptObject(m_ref, m_type);

			engine->Release();

			m_ref = nullptr;
			m_type = nullptr;
		}
	}

	void CScriptHandle::AddRefHandle()
	{
		if (m_ref != nullptr && m_type != nullptr) {
			asIScriptEngine* engine = m_type->GetEngine();
			engine->AddRefScriptObject(m_ref, m_type);

			// Hold on to the engine so it isn't destroyed while
			// a reference to a script object is still held
			engine->AddRef();
		}
	}

	CScriptHandle& CScriptHandle::operator=(const CScriptHandle& other)
	{
		Set(other.m_ref, other.m_type);

		return *this;
	}

	void CScriptHandle::Set(void* ref, asITypeInfo* type)
	{
		if (m_ref == ref) return;

		ReleaseHandle();

		m_ref = ref;
		m_type = type;

		AddRefHandle();
	}

	void* CScriptHandle::GetRef()
	{
		return m_ref;
	}

	asITypeInfo* CScriptHandle::GetType() const
	{
		return m_type;
	}

	int CScriptHandle::GetTypeId() const
	{
		if (m_type == nullptr) return 0;

		return m_type->GetTypeId() | asTYPEID_OBJHANDLE;
	}

	// This method shouldn't be called from the application 
	// directly as it requires an active script context
	CScriptHandle& CScriptHandle::Assign(void* ref, std::int32_t typeId)
	{
		// When receiving a null handle we just clear our memory
		if (typeId == 0) {
			Set(0, 0);
			return *this;
		}

		// Dereference received handles to get the object
		if (typeId & asTYPEID_OBJHANDLE) {
			// Store the actual reference
			ref = *(void**)ref;
			typeId &= ~asTYPEID_OBJHANDLE;
		}

		// Get the object type
		asIScriptContext* ctx = asGetActiveContext();
		asIScriptEngine* engine = ctx->GetEngine();
		asITypeInfo* type = engine->GetTypeInfoById(typeId);

		// If the argument is another CScriptHandle, we should copy the content instead
		if (type != nullptr && strcmp(type->GetName(), "ref") == 0) {
			CScriptHandle* r = static_cast<CScriptHandle*>(ref);
			ref = r->m_ref;
			type = r->m_type;
		}

		Set(ref, type);

		return *this;
	}

	bool CScriptHandle::operator==(const CScriptHandle& o) const
	{
		if (m_ref == o.m_ref && m_type == o.m_type)
			return true;

		// TODO: If type is not the same, we should attempt to do a dynamic cast,
		//       which may change the pointer for application registered classes

		return false;
	}

	bool CScriptHandle::operator!=(const CScriptHandle& o) const
	{
		return !(*this == o);
	}

	bool CScriptHandle::Equals(void* ref, std::int32_t typeId) const
	{
		// Null handles are received as reference to a null handle
		if (typeId == 0)
			ref = nullptr;

		// Dereference handles to get the object
		if (typeId & asTYPEID_OBJHANDLE) {
			// Compare the actual reference
			ref = *(void**)ref;
			typeId &= ~asTYPEID_OBJHANDLE;
		}

		// TODO: If typeId is not the same, we should attempt to do a dynamic cast, 
		//       which may change the pointer for application registered classes

		if (ref == m_ref) return true;

		return false;
	}

	// AngelScript: used as '@obj = cast<obj>(ref);'
	void CScriptHandle::Cast(void** outRef, std::int32_t typeId)
	{
		// If we hold a null handle, then just return null
		if (m_type == nullptr) {
			*outRef = nullptr;
			return;
		}

		// It is expected that the outRef is always a handle
		DEATH_ASSERT(typeId & asTYPEID_OBJHANDLE);

		// Compare the type id of the actual object
		typeId &= ~asTYPEID_OBJHANDLE;
		asIScriptEngine* engine = m_type->GetEngine();
		asITypeInfo* type = engine->GetTypeInfoById(typeId);

		*outRef = nullptr;

		// RefCastObject will increment the refCount of the returned object if successful
		engine->RefCastObject(m_ref, m_type, type, outRef);
	}

	void CScriptHandle::EnumReferences(asIScriptEngine* inEngine)
	{
		// If we're holding a reference, we'll notify the garbage collector of it
		if (m_ref != nullptr)
			inEngine->GCEnumCallback(m_ref);

		// The object type itself is also garbage collected
		if (m_type != nullptr)
			inEngine->GCEnumCallback(m_type);
	}

	void CScriptHandle::ReleaseReferences(asIScriptEngine* /*inEngine*/)
	{
		// Simply clear the content to release the references
		Set(0, 0);
	}

	void RegisterRef(asIScriptEngine* engine)
	{
		std::int32_t r;

#if AS_CAN_USE_CPP11
		// With C++11 it is possible to use asGetTypeTraits to automatically determine the flags that represent the C++ class
		r = engine->RegisterObjectType("ref", sizeof(CScriptHandle), asOBJ_VALUE | asOBJ_ASHANDLE | asOBJ_GC | asGetTypeTraits<CScriptHandle>()); DEATH_ASSERT(r >= 0);
#else
		r = engine->RegisterObjectType("ref", sizeof(CScriptHandle), asOBJ_VALUE | asOBJ_ASHANDLE | asOBJ_GC | asOBJ_APP_CLASS_CDAK); DEATH_ASSERT(r >= 0);
#endif
		r = engine->RegisterObjectBehaviour("ref", asBEHAVE_CONSTRUCT, "void f()", asFUNCTIONPR(Construct, (CScriptHandle*), void), asCALL_CDECL_OBJFIRST); DEATH_ASSERT(r >= 0);
		r = engine->RegisterObjectBehaviour("ref", asBEHAVE_CONSTRUCT, "void f(const ref &in)", asFUNCTIONPR(Construct, (CScriptHandle*, const CScriptHandle&), void), asCALL_CDECL_OBJFIRST); DEATH_ASSERT(r >= 0);
		r = engine->RegisterObjectBehaviour("ref", asBEHAVE_CONSTRUCT, "void f(const ?&in)", asFUNCTIONPR(Construct, (CScriptHandle*, void*, std::int32_t), void), asCALL_CDECL_OBJFIRST); DEATH_ASSERT(r >= 0);
		r = engine->RegisterObjectBehaviour("ref", asBEHAVE_DESTRUCT, "void f()", asFUNCTIONPR(Destruct, (CScriptHandle*), void), asCALL_CDECL_OBJFIRST); DEATH_ASSERT(r >= 0);
		r = engine->RegisterObjectBehaviour("ref", asBEHAVE_ENUMREFS, "void f(int&in)", asMETHOD(CScriptHandle, EnumReferences), asCALL_THISCALL); DEATH_ASSERT(r >= 0);
		r = engine->RegisterObjectBehaviour("ref", asBEHAVE_RELEASEREFS, "void f(int&in)", asMETHOD(CScriptHandle, ReleaseReferences), asCALL_THISCALL); DEATH_ASSERT(r >= 0);
		r = engine->RegisterObjectMethod("ref", "void opCast(?&out)", asMETHODPR(CScriptHandle, Cast, (void**, std::int32_t), void), asCALL_THISCALL); DEATH_ASSERT(r >= 0);
		r = engine->RegisterObjectMethod("ref", "ref &opHndlAssign(const ref &in)", asMETHOD(CScriptHandle, operator=), asCALL_THISCALL); DEATH_ASSERT(r >= 0);
		r = engine->RegisterObjectMethod("ref", "ref &opHndlAssign(const ?&in)", asMETHOD(CScriptHandle, Assign), asCALL_THISCALL); DEATH_ASSERT(r >= 0);
		r = engine->RegisterObjectMethod("ref", "bool opEquals(const ref &in) const", asMETHODPR(CScriptHandle, operator==, (const CScriptHandle&) const, bool), asCALL_THISCALL); DEATH_ASSERT(r >= 0);
		r = engine->RegisterObjectMethod("ref", "bool opEquals(const ?&in) const", asMETHODPR(CScriptHandle, Equals, (void*, std::int32_t) const, bool), asCALL_THISCALL); DEATH_ASSERT(r >= 0);
	}
}

#endif