-
Notifications
You must be signed in to change notification settings - Fork 3
/
ScratClass.h
273 lines (219 loc) · 7.24 KB
/
ScratClass.h
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
266
267
268
269
270
271
272
273
//
// ScratClass: Class Binding
//
//
// Copyright (c) 2009 Brandon Jones
//
// This software is provided 'as-is', without any express or implied
// warranty. In no event will the authors be held liable for any damages
// arising from the use of this software.
//
// Permission is granted to anyone to use this software for any purpose,
// including commercial applications, and to alter it and redistribute it
// freely, subject to the following restrictions:
//
// 1. The origin of this software must not be misrepresented; you must not
// claim that you wrote the original software. If you use this software
// in a product, an acknowledgment in the product documentation would be
// appreciated but is not required.
//
// 2. Altered source versions must be plainly marked as such, and must not be
// misrepresented as being the original software.
//
// 3. This notice may not be removed or altered from any source
// distribution.
//
#if !defined(_SCRAT_CLASS_H_)
#define _SCRAT_CLASS_H_
#include <squirrel.h>
#include <string.h>
#include "ScratObject.h"
#include "ScratClassType.h"
#include "ScratMemberMethods.h"
#include "ScratAllocator.h"
namespace Scrat {
//
// Class
//
template<class C, class A = DefaultAllocator<C>>
class Class : public Object {
public:
// Create a new table
Class(HSQUIRRELVM v, bool createClass = true) : Object(v, false) {
if(createClass && !ClassType<C>::Initialized()) {
sq_newclass(vm, false);
sq_getstackobj(vm, -1, &ClassType<C>::ClassObject());
sq_pop(vm, -1);
InitClass();
ClassType<C>::Initialized() = true;
}
}
// Get the Squirrel Object for this Class
virtual HSQOBJECT GetObject() const {
return ClassType<C>::ClassObject();
}
// Get the Squirrel Object for this Class
virtual HSQOBJECT& GetObject() {
return ClassType<C>::ClassObject();
}
public:
//
// Variable Binding
//
template<class V>
Class& SetStaticValue(const SQChar* name, const V& val) {
BindValue<V>(name, val, true);
return *this;
}
template<class V>
Class& SetValue(const SQChar* name, const V& val) {
BindValue<V>(name, val, false);
return *this;
}
template<class V>
Class& Var(const SQChar* name, V C::* var) {
// Add the getter
BindAccessor(name, &var, sizeof(var), &sqDefaultGet<C, V>, ClassType<C>::GetTable());
// Add the setter
BindAccessor(name, &var, sizeof(var), &sqDefaultSet<C, V>, ClassType<C>::SetTable());
return *this;
}
// TODO: Handle static instance vars
//
// Function Binding
//
template<class F>
Class& Func(const SQChar* name, F method) {
BindFunc(name, &method, sizeof(method), SqMemberFunc(method));
return *this;
}
template<class F>
Class& GlobalFunc(const SQChar* name, F method) {
BindFunc(name, &method, sizeof(method), SqMemberGlobalFunc(method));
return *this;
}
template<class F>
Class& StaticFunc(const SQChar* name, F method) {
BindFunc(name, &method, sizeof(method), SqGlobalFunc(method));
return *this;
}
template<class F>
Class& SquirrelFunc(const SQChar* name, SQFUNCTION func) {
sq_pushobject(vm, ClassType<C>::ClassObject());
sq_pushstring(vm, name, -1);
sq_newclosure(vm, func, 0);
sq_newslot(vm, -3, false);
sq_pop(vm,-1); // pop table
return *this;
}
protected:
// Initialize the required data structure for the class
void InitClass() {
HSQOBJECT& classObj = ClassType<C>::ClassObject();
HSQOBJECT& setTable = ClassType<C>::SetTable();
HSQOBJECT& getTable = ClassType<C>::GetTable();
// push the class
sq_pushobject(vm, classObj);
ClassType<C>::CopyFunc() = &A::Copy;
// add the default constructor
sq_pushstring(vm,_SC("constructor"), -1);
sq_newclosure(vm, &A::New, 0);
sq_newslot(vm, -3, false);
// add the set table (static)
sq_resetobject(&setTable);
sq_pushstring(vm,_SC("__setTable"), -1);
sq_newtable(vm);
sq_getstackobj(vm, -1, &setTable);
sq_newslot(vm, -3, true);
// add the get table (static)
sq_resetobject(&getTable);
sq_pushstring(vm,_SC("__getTable"), -1);
sq_newtable(vm);
sq_getstackobj(vm, -1, &getTable);
sq_newslot(vm, -3, true);
// override _set
sq_pushstring(vm, _SC("_set"), -1);
sq_pushobject(vm, setTable); // Push the set table as a free variable
sq_newclosure(vm, &sqVarSet, 1);
sq_newslot(vm, -3, false);
// override _get
sq_pushstring(vm, _SC("_get"), -1);
sq_pushobject(vm, getTable); // Push the get table as a free variable
sq_newclosure(vm, &sqVarGet, 1);
sq_newslot(vm, -3, false);
// pop the class
sq_pop(vm, 1);
}
// Helper function used to bind getters and setters
inline void BindAccessor(const SQChar* name, void* var, size_t varSize, SQFUNCTION func, HSQOBJECT table) {
// Push the get or set table
sq_pushobject(vm, table);
sq_pushstring(vm, name, -1);
// Push the variable offset as a free variable
SQUserPointer varPtr = sq_newuserdata(vm, static_cast<SQUnsignedInteger>(varSize));
memcpy(varPtr, var, varSize);
// Create the accessor function
sq_newclosure(vm, func, 1);
// Add the accessor to the table
sq_newslot(vm, -3, false);
// Pop get/set table
sq_pop(vm,-1);
}
};
template<class C, class B, class A = DefaultAllocator<C>>
class DerivedClass : public Class<C, A> {
public:
DerivedClass(HSQUIRRELVM v) : Class<C, A>(v, false) {
if(!ClassType<C>::Initialized()) {
sq_pushobject(vm, ClassType<B>::ClassObject());
sq_newclass(vm, true);
sq_getstackobj(vm, -1, &ClassType<C>::ClassObject());
sq_pop(vm, -1);
InitDerivedClass();
ClassType<C>::Initialized() = true;
}
}
protected:
void InitDerivedClass() {
HSQOBJECT& classObj = ClassType<C>::ClassObject();
HSQOBJECT& setTable = ClassType<C>::SetTable();
HSQOBJECT& getTable = ClassType<C>::GetTable();
// push the class
sq_pushobject(vm, classObj);
ClassType<C>::CopyFunc() = &A::Copy;
// add the default constructor
sq_pushstring(vm,_SC("constructor"), -1);
sq_newclosure(vm, &A::New, 0);
sq_newslot(vm, -3, false);
// clone the base classes set table (static)
sq_resetobject(&setTable);
sq_pushobject(vm, setTable);
sq_pushstring(vm,_SC("__setTable"), -1);
sq_clone(vm, -2);
sq_remove(vm, -3);
sq_getstackobj(vm, -1, &setTable);
sq_newslot(vm, -3, true);
// clone the base classes get table (static)
sq_resetobject(&getTable);
sq_pushobject(vm, getTable);
sq_pushstring(vm,_SC("__getTable"), -1);
sq_clone(vm, -2);
sq_remove(vm, -3);
sq_getstackobj(vm, -1, &getTable);
sq_newslot(vm, -3, true);
// override _set
sq_pushstring(vm, _SC("_set"), -1);
sq_pushobject(vm, setTable); // Push the set table as a free variable
sq_newclosure(vm, sqVarSet, 1);
sq_newslot(vm, -3, false);
// override _get
sq_pushstring(vm, _SC("_get"), -1);
sq_pushobject(vm, getTable); // Push the get table as a free variable
sq_newclosure(vm, sqVarGet, 1);
sq_newslot(vm, -3, false);
// pop the class
sq_pop(vm, 1);
}
};
}
#endif