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
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
|
/**
* ClassBase.cpp
*
* Implementation of the ClassBase class.
*
* @author Emiel Bruijntjes <emiel.bruijntjes@copernica.com>
* @copyright 2014 Copernica BV
*/
#include "includes.h"
/**
* Set up namespace
*/
namespace Php {
/**
* Function that is called to clean up space that is occupied by the object
* @param object The object to be deallocated
*/
static void deallocate_object(void *object TSRMLS_DC)
{
// allocate memory for the object
MixedObject *obj = (MixedObject *)object;
// deallocate the cpp object
if (obj->cpp) delete obj->cpp;
// get rid of the object properties
// @todo if we enable the following two lines, segmentation
// faults and memory corruption occurs. however, the online
// documentation does it like this
//zend_hash_destroy(obj->php.properties);
//FREE_HASHTABLE(obj->php.properties);
// deallocate the entire object
efree(obj);
}
/**
* Function that is called to create space for a cloned object
* @param object The object to be cloned
* @param clone The address that should become the clone
*/
static void clone_object(void *object, void **clone TSRMLS_DC)
{
// @todo implementation
}
/**
* Function that is called when an instance of the class needs to be created.
* This function will create the C++ class, and the PHP object
* @param type Pointer to the class
*/
static zend_object_value create_object(zend_class_entry *type TSRMLS_DC)
{
// allocate memory for the object
MixedObject *object = (MixedObject *)emalloc(sizeof(MixedObject));
// find base object
zend_class_entry *base = type;
while (base->parent) base = base->parent;
// retrieve the classinfo object
#if PHP_VERSION_ID >= 50400
const char *comment = base->info.user.doc_comment;
#else
const char *comment = base->doc_comment;
#endif
// the first byte of the comment is an empty string (null character), but
// the next bytes contain a pointer to the ClassInfo class
ClassBase *info = *((ClassBase **)(comment + 1));
// store the class
object->php.ce = type;
// the original create_object fills the initial object with the default properties,
// we're going to do exactly the same. start with setting up a hashtable for the props
ALLOC_HASHTABLE(object->php.properties);
// initialize the hash table
zend_hash_init(object->php.properties, 0, NULL, ZVAL_PTR_DTOR, 0);
// initialize the properties
#if PHP_VERSION_ID < 50399
zend_hash_copy(object->php.properties, &(type->default_properties),
(copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval*));
#else
object_properties_init(&(object->php), type);
#endif
// the thing we're going to return
zend_object_value result;
// use default object handlers
result.handlers = zend_get_std_object_handlers();
// put the object in the storage, and assign a method for deallocating and cloning
result.handle = zend_objects_store_put(object, NULL, deallocate_object, clone_object TSRMLS_CC);
// finally, construct the cpp object
object->cpp = info->construct();
// done
return result;
}
/**
* Destructor
*/
ClassBase::~ClassBase()
{
// destruct the entries
if (_entries) delete[] _entries;
// php 5.3 deallocated the doc_comment by iself
#if PHP_VERSION_ID >= 50400
if (_comment) free(_comment);
#endif
}
/**
* Retrieve an array of zend_function_entry objects that hold the
* properties for each method. This method is called at extension
* startup time to register all methods.
*
* @param classname The class name
* @return zend_function_entry[]
*/
const struct _zend_function_entry *ClassBase::entries()
{
// already initialized?
if (_entries) return _entries;
// allocate memory for the functions
_entries = new zend_function_entry[_methods.size() + 1];
// keep iterator counter
int i = 0;
// loop through the functions
for (auto &method : _methods)
{
// retrieve entry
zend_function_entry *entry = &_entries[i++];
// let the function fill the entry
method->initialize(entry, _name);
}
// last entry should be set to all zeros
zend_function_entry *last = &_entries[i];
// all should be set to zero
memset(last, 0, sizeof(zend_function_entry));
// done
return _entries;
}
/**
* Initialize the class, given its name
*
* The module functions are registered on module startup, but classes are
* initialized afterwards. The Zend engine is a strange thing. Nevertheless,
* this means that this method is called after the module is already available.
* This function will inform the Zend engine about the existence of the
* class.
*
* @param prefix namespace prefix
*/
void ClassBase::initialize(const std::string &prefix)
{
// the class entry
zend_class_entry entry;
// update the name
if (prefix.size() > 0) _name = prefix + "\\" + _name;
// initialize the class entry
INIT_CLASS_ENTRY_EX(entry, _name.c_str(), _name.size(), entries());
// we need a special constructor
entry.create_object = create_object;
// register the class
_entry = zend_register_internal_class(&entry TSRMLS_CC);
// allocate doc comment to contain an empty string + a hidden pointer
if (!_comment)
{
// allocate now
_comment = (char *)malloc(1 + sizeof(ClassBase *));
// empty string on first position
_comment[0] = '\0';
// this pointer has to be copied to temporary pointer, as &this causes compiler error
ClassBase *base = this;
// copy the 'this' pointer to the doc-comment
memcpy(_comment+1, &base, sizeof(ClassBase *));
}
// store pointer to the class in the unused doc_comment member
#if PHP_VERSION_ID >= 50400
_entry->info.user.doc_comment = _comment;
#else
// and store the wrapper inside the comment
_entry->doc_comment = _comment;
#endif
// set access types flags for class
_entry->ce_flags = (int)_type;
// declare all member variables
for (auto &member : _members) member->initialize(_entry);
}
/**
* Add a method to the class
* @param name Name of the method
* @param method The actual method
* @param flags Optional flags
* @param args Description of the supported arguments
*/
void ClassBase::method(const char *name, method_callback_0 callback, int flags, const Arguments &args)
{
// add the method
_methods.push_back(std::make_shared<Method>(name, callback, flags, args));
}
/**
* Add a method to the class
* @param name Name of the method
* @param method The actual method
* @param flags Optional flags
* @param args Description of the supported arguments
*/
void ClassBase::method(const char *name, method_callback_1 callback, int flags, const Arguments &args)
{
// add the method
_methods.push_back(std::make_shared<Method>(name, callback, flags, args));
}
/**
* Add a method to the class
* @param name Name of the method
* @param method The actual method
* @param flags Optional flags
* @param args Description of the supported arguments
*/
void ClassBase::method(const char *name, method_callback_2 callback, int flags, const Arguments &args)
{
// add the method
_methods.push_back(std::make_shared<Method>(name, callback, flags, args));
}
/**
* Add a method to the class
* @param name Name of the method
* @param method The actual method
* @param flags Optional flags
* @param args Description of the supported arguments
*/
void ClassBase::method(const char *name, method_callback_3 callback, int flags, const Arguments &args)
{
// add the method
_methods.push_back(std::make_shared<Method>(name, callback, flags, args));
}
/**
* Add an abstract method to the class
* @param name Name of the method
* @param flags Optional flags (like public or protected)
* @param args Description of the supported arguments
*/
void ClassBase::method(const char *name, int flags, const Arguments &args)
{
// add the method
_methods.push_back(std::make_shared<Method>(name, Abstract | flags, args));
}
/**
* Add a property to the class
* @param name Name of the property
* @param value Actual property value
* @param flags Optional flags
*/
void ClassBase::property(const char *name, std::nullptr_t value, int flags)
{
// add property
_members.push_back(std::make_shared<NullMember>(name, flags));
}
/**
* Add a property to the class
* @param name Name of the property
* @param value Actual property value
* @param flags Optional flags
*/
void ClassBase::property(const char *name, int16_t value, int flags)
{
// add property
_members.push_back(std::make_shared<LongMember>(name, value, flags));
}
/**
* Add a property to the class
* @param name Name of the property
* @param value Actual property value
* @param flags Optional flags
*/
void ClassBase::property(const char *name, int32_t value, int flags)
{
// add property
_members.push_back(std::make_shared<LongMember>(name, value, flags));
}
/**
* Add a property to the class
* @param name Name of the property
* @param value Actual property value
* @param flags Optional flags
*/
void ClassBase::property(const char *name, int64_t value, int flags)
{
// add property
_members.push_back(std::make_shared<LongMember>(name, value, flags));
}
/**
* Add a property to the class
* @param name Name of the property
* @param value Actual property value
* @param flags Optional flags
*/
void ClassBase::property(const char *name, bool value, int flags)
{
// add property
_members.push_back(std::make_shared<BoolMember>(name, value, flags));
}
/**
* Add a property to the class
* @param name Name of the property
* @param value Actual property value
* @param flags Optional flags
*/
void ClassBase::property(const char *name, char value, int flags)
{
// add property
_members.push_back(std::make_shared<StringMember>(name, &value, 1, flags));
}
/**
* Add a property to the class
* @param name Name of the property
* @param value Actual property value
* @param flags Optional flags
*/
void ClassBase::property(const char *name, const std::string &value, int flags)
{
// add property
_members.push_back(std::make_shared<StringMember>(name, value, flags));
}
/**
* Add a property to the class
* @param name Name of the property
* @param value Actual property value
* @param flags Optional flags
*/
void ClassBase::property(const char *name, const char *value, int flags)
{
// add property
_members.push_back(std::make_shared<StringMember>(name, value, strlen(value), flags));
}
/**
* Add a property to the class
* @param name Name of the property
* @param value Actual property value
* @param flags Optional flags
*/
void ClassBase::property(const char *name, double value, int flags)
{
// add property
_members.push_back(std::make_shared<FloatMember>(name, value, flags));
}
/**
* End namespace
*/
}
|