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
|
/**
* ClassBase.h
*
* This is the base class of the "Class" class. This is an internal class that
* is used by the PHP-CPP library. But because the constructor is protected,
* you can not create any instances if this class yourself (and you are not
* supposed to do that either.
*
* Further more, because this base class is a 'private' base of Class, all
* features of it are normally also inaccessible.
*
* In other words: it is not meant to be directly used by extension writers.
*
* @copyright 2014 Copernica BV
*/
/**
* Set up namespace
*/
namespace Php {
/**
* Method signatures
*/
typedef void (Base::*method_callback_0)();
typedef void (Base::*method_callback_1)(Parameters &);
typedef Value (Base::*method_callback_2)();
typedef Value (Base::*method_callback_3)(Parameters &);
/**
* Forward declarations
*/
class Method;
class Member;
/**
* Class definition
*/
class ClassBase
{
protected:
/**
* Protected constructor
* @param classname Class name
* @param flags The class flags
*/
ClassBase(const char *classname, int flags = 0) : _name(classname), _flags(flags) {}
public:
/**
* Copy constructor
* @param that
*
* @todo prefer move
*/
ClassBase(const ClassBase &that) :
_name(that._name), _flags(that._flags), _methods(that._methods), _members(that._members) {}
/**
* Move constructor
* @param that
*/
ClassBase(ClassBase &&that) :
_flags(that._flags), _methods(std::move(that._methods)), _members(std::move(that._members)), _entry(that._entry)
{
// other entry are invalid now (not that it is used..., class objects are
// only moved during extension setup, when the entry pointer has not yet
// been allocated)
that._entry = nullptr;
}
/**
* Destructor
*/
virtual ~ClassBase();
/**
* Construct a new instance of the object
* @return Base
*/
virtual Base* construct() = 0;
/**
* 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.
*/
void initialize();
protected:
/**
* Add a method to the class
*
* The method will be accessible as one of the class methods in your PHP
* code. When the method is called, it will automatically be forwarded
* to the C++ implementation. The flags can be Php::Public, Php::Protected
* or Php::Private (using private methods can be useful if you for example
* want to make the __construct() function private). The access-modified
* flag can be bitwise combined with the flag Php::Final or Php::Abstract).
*
* @param name Name of the method
* @param method The actual method
* @param flags Optional flags
* @param args Description of the supported arguments
*/
void add(const char *name, method_callback_0, int flags=0, const Arguments &args = {});
void add(const char *name, method_callback_1, int flags=0, const Arguments &args = {});
void add(const char *name, method_callback_2, int flags=0, const Arguments &args = {});
void add(const char *name, method_callback_3, int flags=0, const Arguments &args = {});
/**
* Add a property to the class
*
* Every instance of this class will have this property. The property
* can be Php::Public, Php::Protected or Php::Private (altough setting
* private properties is odd as the implementation of the class is in CPP,
* so why use private properties while the whole implementation is already
* hidden)
*
* @param name Name of the property
* @param value Actual property value
* @param flags Optional flags
*/
void add(const char *name, std::nullptr_t value, int flags = Php::Public);
void add(const char *name, int16_t value, int flags = Php::Public);
void add(const char *name, int32_t value, int flags = Php::Public);
void add(const char *name, int64_t value, int flags = Php::Public);
void add(const char *name, bool value, int flags = Php::Public);
void add(const char *name, char value, int flags = Php::Public);
void add(const char *name, const std::string &value, int flags = Php::Public);
void add(const char *name, const char *value, int flags = Php::Public);
void add(const char *name, double value, int flags = Php::Public);
private:
/**
* 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 *entries();
/**
* Name of the class
* @var string
*/
std::string _name;
/**
* The class flags (this can be values like Php::Abstract and Php::Final)
* @var int
*/
int _flags = 0;
/**
* The class entry
* @var zend_class_entry
*/
struct _zend_class_entry *_entry = nullptr;
/**
* Pointer to the entries
* @var zend_function_entry[]
*/
struct _zend_function_entry *_entries = nullptr;
/**
* All class methods
* @var set
*/
std::set<std::shared_ptr<Method>> _methods;
/**
* All class members (class properties)
* @var set
*/
std::set<std::shared_ptr<Member>> _members;
};
/**
* End namespace
*/
}
|
