1/*
2   +----------------------------------------------------------------------+
3   | Zend Engine                                                          |
4   +----------------------------------------------------------------------+
5   | Copyright (c) 1998-2015 Zend Technologies Ltd. (http://www.zend.com) |
6   +----------------------------------------------------------------------+
7   | This source file is subject to version 2.00 of the Zend license,     |
8   | that is bundled with this package in the file LICENSE, and is        |
9   | available through the world-wide-web at the following url:           |
10   | http://www.zend.com/license/2_00.txt.                                |
11   | If you did not receive a copy of the Zend license and are unable to  |
12   | obtain it through the world-wide-web, please send a note to          |
13   | license@zend.com so we can mail you a copy immediately.              |
14   +----------------------------------------------------------------------+
15   | Authors: Andi Gutmans <andi@zend.com>                                |
16   |          Zeev Suraski <zeev@zend.com>                                |
17   |          Andrei Zmievski <andrei@php.net>                            |
18   +----------------------------------------------------------------------+
19*/
20
21/* $Id$ */
22
23#ifndef ZEND_API_H
24#define ZEND_API_H
25
26#include "zend_modules.h"
27#include "zend_list.h"
28#include "zend_operators.h"
29#include "zend_variables.h"
30#include "zend_execute.h"
31
32
33BEGIN_EXTERN_C()
34
35typedef struct _zend_function_entry {
36    const char *fname;
37    void (*handler)(INTERNAL_FUNCTION_PARAMETERS);
38    const struct _zend_internal_arg_info *arg_info;
39    uint32_t num_args;
40    uint32_t flags;
41} zend_function_entry;
42
43typedef struct _zend_fcall_info {
44    size_t size;
45    HashTable *function_table;
46    zval function_name;
47    zend_array *symbol_table;
48    zval *retval;
49    zval *params;
50    zend_object *object;
51    zend_bool no_separation;
52    uint32_t param_count;
53} zend_fcall_info;
54
55typedef struct _zend_fcall_info_cache {
56    zend_bool initialized;
57    zend_function *function_handler;
58    zend_class_entry *calling_scope;
59    zend_class_entry *called_scope;
60    zend_object *object;
61} zend_fcall_info_cache;
62
63#define ZEND_NS_NAME(ns, name)          ns "\\" name
64
65#define ZEND_FN(name) zif_##name
66#define ZEND_MN(name) zim_##name
67#define ZEND_NAMED_FUNCTION(name)       void name(INTERNAL_FUNCTION_PARAMETERS)
68#define ZEND_FUNCTION(name)             ZEND_NAMED_FUNCTION(ZEND_FN(name))
69#define ZEND_METHOD(classname, name)    ZEND_NAMED_FUNCTION(ZEND_MN(classname##_##name))
70
71#define ZEND_FENTRY(zend_name, name, arg_info, flags)   { #zend_name, name, arg_info, (uint32_t) (sizeof(arg_info)/sizeof(struct _zend_arg_info)-1), flags },
72
73#define ZEND_RAW_FENTRY(zend_name, name, arg_info, flags)   { zend_name, name, arg_info, (uint32_t) (sizeof(arg_info)/sizeof(struct _zend_arg_info)-1), flags },
74#define ZEND_RAW_NAMED_FE(zend_name, name, arg_info) ZEND_RAW_FENTRY(#zend_name, name, arg_info, 0)
75
76#define ZEND_NAMED_FE(zend_name, name, arg_info)    ZEND_FENTRY(zend_name, name, arg_info, 0)
77#define ZEND_FE(name, arg_info)                     ZEND_FENTRY(name, ZEND_FN(name), arg_info, 0)
78#define ZEND_DEP_FE(name, arg_info)                 ZEND_FENTRY(name, ZEND_FN(name), arg_info, ZEND_ACC_DEPRECATED)
79#define ZEND_FALIAS(name, alias, arg_info)          ZEND_FENTRY(name, ZEND_FN(alias), arg_info, 0)
80#define ZEND_DEP_FALIAS(name, alias, arg_info)      ZEND_FENTRY(name, ZEND_FN(alias), arg_info, ZEND_ACC_DEPRECATED)
81#define ZEND_NAMED_ME(zend_name, name, arg_info, flags) ZEND_FENTRY(zend_name, name, arg_info, flags)
82#define ZEND_ME(classname, name, arg_info, flags)   ZEND_FENTRY(name, ZEND_MN(classname##_##name), arg_info, flags)
83#define ZEND_ABSTRACT_ME(classname, name, arg_info) ZEND_FENTRY(name, NULL, arg_info, ZEND_ACC_PUBLIC|ZEND_ACC_ABSTRACT)
84#define ZEND_MALIAS(classname, name, alias, arg_info, flags) \
85                                                    ZEND_FENTRY(name, ZEND_MN(classname##_##alias), arg_info, flags)
86#define ZEND_ME_MAPPING(name, func_name, arg_types, flags) ZEND_NAMED_ME(name, ZEND_FN(func_name), arg_types, flags)
87
88#define ZEND_NS_FENTRY(ns, zend_name, name, arg_info, flags)        ZEND_RAW_FENTRY(ZEND_NS_NAME(ns, #zend_name), name, arg_info, flags)
89
90#define ZEND_NS_RAW_FENTRY(ns, zend_name, name, arg_info, flags)    ZEND_RAW_FENTRY(ZEND_NS_NAME(ns, zend_name), name, arg_info, flags)
91#define ZEND_NS_RAW_NAMED_FE(ns, zend_name, name, arg_info)         ZEND_NS_RAW_FENTRY(ns, #zend_name, name, arg_info, 0)
92
93#define ZEND_NS_NAMED_FE(ns, zend_name, name, arg_info) ZEND_NS_FENTRY(ns, zend_name, name, arg_info, 0)
94#define ZEND_NS_FE(ns, name, arg_info)                  ZEND_NS_FENTRY(ns, name, ZEND_FN(name), arg_info, 0)
95#define ZEND_NS_DEP_FE(ns, name, arg_info)              ZEND_NS_FENTRY(ns, name, ZEND_FN(name), arg_info, ZEND_ACC_DEPRECATED)
96#define ZEND_NS_FALIAS(ns, name, alias, arg_info)       ZEND_NS_FENTRY(ns, name, ZEND_FN(alias), arg_info, 0)
97#define ZEND_NS_DEP_FALIAS(ns, name, alias, arg_info)   ZEND_NS_FENTRY(ns, name, ZEND_FN(alias), arg_info, ZEND_ACC_DEPRECATED)
98
99#define ZEND_FE_END            { NULL, NULL, NULL, 0, 0 }
100
101#define ZEND_ARG_INFO(pass_by_ref, name)                             { #name, NULL, 0, pass_by_ref, 0, 0 },
102#define ZEND_ARG_PASS_INFO(pass_by_ref)                              { NULL,  NULL, 0, pass_by_ref, 0, 0 },
103#define ZEND_ARG_OBJ_INFO(pass_by_ref, name, classname, allow_null)  { #name, #classname, IS_OBJECT, pass_by_ref, allow_null, 0 },
104#define ZEND_ARG_ARRAY_INFO(pass_by_ref, name, allow_null)           { #name, NULL, IS_ARRAY, pass_by_ref, allow_null, 0 },
105#define ZEND_ARG_CALLABLE_INFO(pass_by_ref, name, allow_null)        { #name, NULL, IS_CALLABLE, pass_by_ref, allow_null, 0 },
106#define ZEND_ARG_TYPE_INFO(pass_by_ref, name, type_hint, allow_null) { #name, NULL, type_hint, pass_by_ref, allow_null, 0 },
107#define ZEND_ARG_VARIADIC_INFO(pass_by_ref, name)                    { #name, NULL, 0, pass_by_ref, 0, 1 },
108
109
110#define ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(name, return_reference, required_num_args, type, class_name, allow_null) \
111    static const zend_internal_arg_info name[] = { \
112        { (const char*)(zend_uintptr_t)(required_num_args), class_name, type, return_reference, allow_null, 0 },
113#define ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO(name, type, class_name, allow_null) \
114    ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(name, 0, -1, type, class_name, allow_null)
115
116#define ZEND_BEGIN_ARG_INFO_EX(name, _unused, return_reference, required_num_args)  \
117    static const zend_internal_arg_info name[] = { \
118        { (const char*)(zend_uintptr_t)(required_num_args), NULL, 0, return_reference, 0, 0 },
119#define ZEND_BEGIN_ARG_INFO(name, _unused)  \
120    ZEND_BEGIN_ARG_INFO_EX(name, 0, ZEND_RETURN_VALUE, -1)
121#define ZEND_END_ARG_INFO()     };
122
123/* Name macros */
124#define ZEND_MODULE_STARTUP_N(module)       zm_startup_##module
125#define ZEND_MODULE_SHUTDOWN_N(module)      zm_shutdown_##module
126#define ZEND_MODULE_ACTIVATE_N(module)      zm_activate_##module
127#define ZEND_MODULE_DEACTIVATE_N(module)    zm_deactivate_##module
128#define ZEND_MODULE_POST_ZEND_DEACTIVATE_N(module)  zm_post_zend_deactivate_##module
129#define ZEND_MODULE_INFO_N(module)          zm_info_##module
130#define ZEND_MODULE_GLOBALS_CTOR_N(module)  zm_globals_ctor_##module
131#define ZEND_MODULE_GLOBALS_DTOR_N(module)  zm_globals_dtor_##module
132
133/* Declaration macros */
134#define ZEND_MODULE_STARTUP_D(module)       int ZEND_MODULE_STARTUP_N(module)(INIT_FUNC_ARGS)
135#define ZEND_MODULE_SHUTDOWN_D(module)      int ZEND_MODULE_SHUTDOWN_N(module)(SHUTDOWN_FUNC_ARGS)
136#define ZEND_MODULE_ACTIVATE_D(module)      int ZEND_MODULE_ACTIVATE_N(module)(INIT_FUNC_ARGS)
137#define ZEND_MODULE_DEACTIVATE_D(module)    int ZEND_MODULE_DEACTIVATE_N(module)(SHUTDOWN_FUNC_ARGS)
138#define ZEND_MODULE_POST_ZEND_DEACTIVATE_D(module)  int ZEND_MODULE_POST_ZEND_DEACTIVATE_N(module)(void)
139#define ZEND_MODULE_INFO_D(module)          void ZEND_MODULE_INFO_N(module)(ZEND_MODULE_INFO_FUNC_ARGS)
140#define ZEND_MODULE_GLOBALS_CTOR_D(module)  void ZEND_MODULE_GLOBALS_CTOR_N(module)(zend_##module##_globals *module##_globals)
141#define ZEND_MODULE_GLOBALS_DTOR_D(module)  void ZEND_MODULE_GLOBALS_DTOR_N(module)(zend_##module##_globals *module##_globals)
142
143#define ZEND_GET_MODULE(name) \
144    BEGIN_EXTERN_C()\
145    ZEND_DLEXPORT zend_module_entry *get_module(void) { return &name##_module_entry; }\
146    END_EXTERN_C()
147
148#define ZEND_BEGIN_MODULE_GLOBALS(module_name)      \
149    typedef struct _zend_##module_name##_globals {
150#define ZEND_END_MODULE_GLOBALS(module_name)        \
151    } zend_##module_name##_globals;
152
153#ifdef ZTS
154
155#define ZEND_DECLARE_MODULE_GLOBALS(module_name)                            \
156    ts_rsrc_id module_name##_globals_id;
157#define ZEND_EXTERN_MODULE_GLOBALS(module_name)                             \
158    extern ts_rsrc_id module_name##_globals_id;
159#define ZEND_INIT_MODULE_GLOBALS(module_name, globals_ctor, globals_dtor)   \
160    ts_allocate_id(&module_name##_globals_id, sizeof(zend_##module_name##_globals), (ts_allocate_ctor) globals_ctor, (ts_allocate_dtor) globals_dtor);
161
162#else
163
164#define ZEND_DECLARE_MODULE_GLOBALS(module_name)                            \
165    zend_##module_name##_globals module_name##_globals;
166#define ZEND_EXTERN_MODULE_GLOBALS(module_name)                             \
167    extern zend_##module_name##_globals module_name##_globals;
168#define ZEND_INIT_MODULE_GLOBALS(module_name, globals_ctor, globals_dtor)   \
169    globals_ctor(&module_name##_globals);
170
171#endif
172
173#define INIT_CLASS_ENTRY(class_container, class_name, functions) \
174    INIT_OVERLOADED_CLASS_ENTRY(class_container, class_name, functions, NULL, NULL, NULL)
175
176#define INIT_CLASS_ENTRY_EX(class_container, class_name, class_name_len, functions) \
177    INIT_OVERLOADED_CLASS_ENTRY_EX(class_container, class_name, class_name_len, functions, NULL, NULL, NULL, NULL, NULL)
178
179#define INIT_OVERLOADED_CLASS_ENTRY_EX(class_container, class_name, class_name_len, functions, handle_fcall, handle_propget, handle_propset, handle_propunset, handle_propisset) \
180    {                                                           \
181        zend_string *cl_name;                                   \
182        cl_name = zend_string_init(class_name, class_name_len, 1);      \
183        class_container.name = zend_new_interned_string(cl_name);   \
184        INIT_CLASS_ENTRY_INIT_METHODS(class_container, functions, handle_fcall, handle_propget, handle_propset, handle_propunset, handle_propisset) \
185    }
186
187#define INIT_CLASS_ENTRY_INIT_METHODS(class_container, functions, handle_fcall, handle_propget, handle_propset, handle_propunset, handle_propisset) \
188    {                                                           \
189        class_container.constructor = NULL;                     \
190        class_container.destructor = NULL;                      \
191        class_container.clone = NULL;                           \
192        class_container.serialize = NULL;                       \
193        class_container.unserialize = NULL;                     \
194        class_container.create_object = NULL;                   \
195        class_container.interface_gets_implemented = NULL;      \
196        class_container.get_static_method = NULL;               \
197        class_container.__call = handle_fcall;                  \
198        class_container.__callstatic = NULL;                    \
199        class_container.__tostring = NULL;                      \
200        class_container.__get = handle_propget;                 \
201        class_container.__set = handle_propset;                 \
202        class_container.__unset = handle_propunset;             \
203        class_container.__isset = handle_propisset;             \
204        class_container.__debugInfo = NULL;                 \
205        class_container.serialize_func = NULL;                  \
206        class_container.unserialize_func = NULL;                \
207        class_container.serialize = NULL;                       \
208        class_container.unserialize = NULL;                     \
209        class_container.parent = NULL;                          \
210        class_container.num_interfaces = 0;                     \
211        class_container.traits = NULL;                          \
212        class_container.num_traits = 0;                         \
213        class_container.trait_aliases = NULL;                   \
214        class_container.trait_precedences = NULL;               \
215        class_container.interfaces = NULL;                      \
216        class_container.get_iterator = NULL;                    \
217        class_container.iterator_funcs.funcs = NULL;            \
218        class_container.info.internal.module = NULL;            \
219        class_container.info.internal.builtin_functions = functions;    \
220    }
221
222#define INIT_OVERLOADED_CLASS_ENTRY(class_container, class_name, functions, handle_fcall, handle_propget, handle_propset) \
223    INIT_OVERLOADED_CLASS_ENTRY_EX(class_container, class_name, sizeof(class_name)-1, functions, handle_fcall, handle_propget, handle_propset, NULL, NULL)
224
225#define INIT_NS_CLASS_ENTRY(class_container, ns, class_name, functions) \
226    INIT_CLASS_ENTRY(class_container, ZEND_NS_NAME(ns, class_name), functions)
227#define INIT_OVERLOADED_NS_CLASS_ENTRY_EX(class_container, ns, class_name, functions, handle_fcall, handle_propget, handle_propset, handle_propunset, handle_propisset) \
228    INIT_OVERLOADED_CLASS_ENTRY_EX(class_container, ZEND_NS_NAME(ns, class_name), sizeof(ZEND_NS_NAME(ns, class_name))-1, functions, handle_fcall, handle_propget, handle_propset, handle_propunset, handle_propisset)
229#define INIT_OVERLOADED_NS_CLASS_ENTRY(class_container, ns, class_name, functions, handle_fcall, handle_propget, handle_propset) \
230    INIT_OVERLOADED_CLASS_ENTRY(class_container, ZEND_NS_NAME(ns, class_name), functions, handle_fcall, handle_propget, handle_propset)
231
232#ifdef ZTS
233#   define CE_STATIC_MEMBERS(ce) (((ce)->type==ZEND_USER_CLASS)?(ce)->static_members_table:CG(static_members_table)[(zend_intptr_t)(ce)->static_members_table])
234#else
235#   define CE_STATIC_MEMBERS(ce) ((ce)->static_members_table)
236#endif
237
238#define ZEND_FCI_INITIALIZED(fci) ((fci).size != 0)
239
240ZEND_API int zend_next_free_module(void);
241
242BEGIN_EXTERN_C()
243ZEND_API int zend_get_parameters(int ht, int param_count, ...);
244ZEND_API ZEND_ATTRIBUTE_DEPRECATED int zend_get_parameters_ex(int param_count, ...);
245ZEND_API int _zend_get_parameters_array_ex(int param_count, zval *argument_array);
246
247/* internal function to efficiently copy parameters when executing __call() */
248ZEND_API int zend_copy_parameters_array(int param_count, zval *argument_array);
249
250#define zend_get_parameters_array(ht, param_count, argument_array)          \
251    _zend_get_parameters_array_ex(param_count, argument_array)
252#define zend_get_parameters_array_ex(param_count, argument_array)           \
253    _zend_get_parameters_array_ex(param_count, argument_array)
254#define zend_parse_parameters_none()                                        \
255    zend_parse_parameters(ZEND_NUM_ARGS(), "")
256
257/* Parameter parsing API -- andrei */
258
259#define ZEND_PARSE_PARAMS_QUIET (1<<1)
260#define ZEND_PARSE_PARAMS_THROW (1<<2)
261ZEND_API int zend_parse_parameters(int num_args, const char *type_spec, ...);
262ZEND_API int zend_parse_parameters_ex(int flags, int num_args, const char *type_spec, ...);
263ZEND_API int zend_parse_parameters_throw(int num_args, const char *type_spec, ...);
264ZEND_API char *zend_zval_type_name(const zval *arg);
265
266ZEND_API int zend_parse_method_parameters(int num_args, zval *this_ptr, const char *type_spec, ...);
267ZEND_API int zend_parse_method_parameters_ex(int flags, int num_args, zval *this_ptr, const char *type_spec, ...);
268
269ZEND_API int zend_parse_parameter(int flags, int arg_num, zval *arg, const char *spec, ...);
270
271/* End of parameter parsing API -- andrei */
272
273ZEND_API int zend_register_functions(zend_class_entry *scope, const zend_function_entry *functions, HashTable *function_table, int type);
274ZEND_API void zend_unregister_functions(const zend_function_entry *functions, int count, HashTable *function_table);
275ZEND_API int zend_startup_module(zend_module_entry *module_entry);
276ZEND_API zend_module_entry* zend_register_internal_module(zend_module_entry *module_entry);
277ZEND_API zend_module_entry* zend_register_module_ex(zend_module_entry *module);
278ZEND_API int zend_startup_module_ex(zend_module_entry *module);
279ZEND_API int zend_startup_modules(void);
280ZEND_API void zend_collect_module_handlers(void);
281ZEND_API void zend_destroy_modules(void);
282ZEND_API void zend_check_magic_method_implementation(const zend_class_entry *ce, const zend_function *fptr, int error_type);
283
284ZEND_API zend_class_entry *zend_register_internal_class(zend_class_entry *class_entry);
285ZEND_API zend_class_entry *zend_register_internal_class_ex(zend_class_entry *class_entry, zend_class_entry *parent_ce);
286ZEND_API zend_class_entry *zend_register_internal_interface(zend_class_entry *orig_class_entry);
287ZEND_API void zend_class_implements(zend_class_entry *class_entry, int num_interfaces, ...);
288
289ZEND_API int zend_register_class_alias_ex(const char *name, size_t name_len, zend_class_entry *ce);
290
291#define zend_register_class_alias(name, ce) \
292    zend_register_class_alias_ex(name, sizeof(name)-1, ce)
293#define zend_register_ns_class_alias(ns, name, ce) \
294    zend_register_class_alias_ex(ZEND_NS_NAME(ns, name), sizeof(ZEND_NS_NAME(ns, name))-1, ce)
295
296ZEND_API int zend_disable_function(char *function_name, size_t function_name_length);
297ZEND_API int zend_disable_class(char *class_name, size_t class_name_length);
298
299ZEND_API void zend_wrong_param_count(void);
300
301#define IS_CALLABLE_CHECK_SYNTAX_ONLY (1<<0)
302#define IS_CALLABLE_CHECK_NO_ACCESS   (1<<1)
303#define IS_CALLABLE_CHECK_IS_STATIC   (1<<2)
304#define IS_CALLABLE_CHECK_SILENT      (1<<3)
305
306#define IS_CALLABLE_STRICT  (IS_CALLABLE_CHECK_IS_STATIC)
307
308ZEND_API zend_bool zend_is_callable_ex(zval *callable, zend_object *object, uint check_flags, zend_string **callable_name, zend_fcall_info_cache *fcc, char **error);
309ZEND_API zend_bool zend_is_callable(zval *callable, uint check_flags, zend_string **callable_name);
310ZEND_API zend_bool zend_make_callable(zval *callable, zend_string **callable_name);
311ZEND_API const char *zend_get_module_version(const char *module_name);
312ZEND_API int zend_get_module_started(const char *module_name);
313ZEND_API int zend_declare_property_ex(zend_class_entry *ce, zend_string *name, zval *property, int access_type, zend_string *doc_comment);
314ZEND_API int zend_declare_property(zend_class_entry *ce, const char *name, size_t name_length, zval *property, int access_type);
315ZEND_API int zend_declare_property_null(zend_class_entry *ce, const char *name, size_t name_length, int access_type);
316ZEND_API int zend_declare_property_bool(zend_class_entry *ce, const char *name, size_t name_length, zend_long value, int access_type);
317ZEND_API int zend_declare_property_long(zend_class_entry *ce, const char *name, size_t name_length, zend_long value, int access_type);
318ZEND_API int zend_declare_property_double(zend_class_entry *ce, const char *name, size_t name_length, double value, int access_type);
319ZEND_API int zend_declare_property_string(zend_class_entry *ce, const char *name, size_t name_length, const char *value, int access_type);
320ZEND_API int zend_declare_property_stringl(zend_class_entry *ce, const char *name, size_t name_length, const char *value, size_t value_len, int access_type);
321
322ZEND_API int zend_declare_class_constant(zend_class_entry *ce, const char *name, size_t name_length, zval *value);
323ZEND_API int zend_declare_class_constant_null(zend_class_entry *ce, const char *name, size_t name_length);
324ZEND_API int zend_declare_class_constant_long(zend_class_entry *ce, const char *name, size_t name_length, zend_long value);
325ZEND_API int zend_declare_class_constant_bool(zend_class_entry *ce, const char *name, size_t name_length, zend_bool value);
326ZEND_API int zend_declare_class_constant_double(zend_class_entry *ce, const char *name, size_t name_length, double value);
327ZEND_API int zend_declare_class_constant_stringl(zend_class_entry *ce, const char *name, size_t name_length, const char *value, size_t value_length);
328ZEND_API int zend_declare_class_constant_string(zend_class_entry *ce, const char *name, size_t name_length, const char *value);
329
330ZEND_API int zend_update_class_constants(zend_class_entry *class_type);
331
332ZEND_API void zend_update_property(zend_class_entry *scope, zval *object, const char *name, size_t name_length, zval *value);
333ZEND_API void zend_update_property_null(zend_class_entry *scope, zval *object, const char *name, size_t name_length);
334ZEND_API void zend_update_property_bool(zend_class_entry *scope, zval *object, const char *name, size_t name_length, zend_long value);
335ZEND_API void zend_update_property_long(zend_class_entry *scope, zval *object, const char *name, size_t name_length, zend_long value);
336ZEND_API void zend_update_property_double(zend_class_entry *scope, zval *object, const char *name, size_t name_length, double value);
337ZEND_API void zend_update_property_str(zend_class_entry *scope, zval *object, const char *name, size_t name_length, zend_string *value);
338ZEND_API void zend_update_property_string(zend_class_entry *scope, zval *object, const char *name, size_t name_length, const char *value);
339ZEND_API void zend_update_property_stringl(zend_class_entry *scope, zval *object, const char *name, size_t name_length, const char *value, size_t value_length);
340
341ZEND_API int zend_update_static_property(zend_class_entry *scope, const char *name, size_t name_length, zval *value);
342ZEND_API int zend_update_static_property_null(zend_class_entry *scope, const char *name, size_t name_length);
343ZEND_API int zend_update_static_property_bool(zend_class_entry *scope, const char *name, size_t name_length, zend_long value);
344ZEND_API int zend_update_static_property_long(zend_class_entry *scope, const char *name, size_t name_length, zend_long value);
345ZEND_API int zend_update_static_property_double(zend_class_entry *scope, const char *name, size_t name_length, double value);
346ZEND_API int zend_update_static_property_string(zend_class_entry *scope, const char *name, size_t name_length, const char *value);
347ZEND_API int zend_update_static_property_stringl(zend_class_entry *scope, const char *name, size_t name_length, const char *value, size_t value_length);
348
349ZEND_API zval *zend_read_property(zend_class_entry *scope, zval *object, const char *name, size_t name_length, zend_bool silent, zval *rv);
350
351ZEND_API zval *zend_read_static_property(zend_class_entry *scope, const char *name, size_t name_length, zend_bool silent);
352
353ZEND_API char *zend_get_type_by_const(int type);
354
355#define getThis()                           (Z_OBJ(EX(This)) ? &EX(This) : NULL)
356#define ZEND_IS_METHOD_CALL()               (EX(func)->common.scope != NULL)
357
358#define WRONG_PARAM_COUNT                   ZEND_WRONG_PARAM_COUNT()
359#define WRONG_PARAM_COUNT_WITH_RETVAL(ret)  ZEND_WRONG_PARAM_COUNT_WITH_RETVAL(ret)
360#define ARG_COUNT(dummy)                    EX_NUM_ARGS()
361#define ZEND_NUM_ARGS()                     EX_NUM_ARGS()
362#define ZEND_WRONG_PARAM_COUNT()                    { zend_wrong_param_count(); return; }
363#define ZEND_WRONG_PARAM_COUNT_WITH_RETVAL(ret)     { zend_wrong_param_count(); return ret; }
364
365#ifndef ZEND_WIN32
366#define DLEXPORT
367#endif
368
369#define array_init(arg)         _array_init((arg), 0 ZEND_FILE_LINE_CC)
370#define array_init_size(arg, size) _array_init((arg), (size) ZEND_FILE_LINE_CC)
371#define object_init(arg)        _object_init((arg) ZEND_FILE_LINE_CC)
372#define object_init_ex(arg, ce) _object_init_ex((arg), (ce) ZEND_FILE_LINE_CC)
373#define object_and_properties_init(arg, ce, properties) _object_and_properties_init((arg), (ce), (properties) ZEND_FILE_LINE_CC)
374ZEND_API int _array_init(zval *arg, uint32_t size ZEND_FILE_LINE_DC);
375ZEND_API int _object_init(zval *arg ZEND_FILE_LINE_DC);
376ZEND_API int _object_init_ex(zval *arg, zend_class_entry *ce ZEND_FILE_LINE_DC);
377ZEND_API int _object_and_properties_init(zval *arg, zend_class_entry *ce, HashTable *properties ZEND_FILE_LINE_DC);
378ZEND_API void object_properties_init(zend_object *object, zend_class_entry *class_type);
379ZEND_API void object_properties_init_ex(zend_object *object, HashTable *properties);
380ZEND_API void object_properties_load(zend_object *object, HashTable *properties);
381
382ZEND_API void zend_merge_properties(zval *obj, HashTable *properties);
383
384/* no longer supported */
385ZEND_API int add_assoc_function(zval *arg, const char *key, void (*function_ptr)(INTERNAL_FUNCTION_PARAMETERS));
386
387ZEND_API int add_assoc_long_ex(zval *arg, const char *key, size_t key_len, zend_long n);
388ZEND_API int add_assoc_null_ex(zval *arg, const char *key, size_t key_len);
389ZEND_API int add_assoc_bool_ex(zval *arg, const char *key, size_t key_len, int b);
390ZEND_API int add_assoc_resource_ex(zval *arg, const char *key, size_t key_len, zend_resource *r);
391ZEND_API int add_assoc_double_ex(zval *arg, const char *key, size_t key_len, double d);
392ZEND_API int add_assoc_str_ex(zval *arg, const char *key, size_t key_len, zend_string *str);
393ZEND_API int add_assoc_string_ex(zval *arg, const char *key, size_t key_len, char *str);
394ZEND_API int add_assoc_stringl_ex(zval *arg, const char *key, size_t key_len, char *str, size_t length);
395ZEND_API int add_assoc_zval_ex(zval *arg, const char *key, size_t key_len, zval *value);
396
397#define add_assoc_long(__arg, __key, __n) add_assoc_long_ex(__arg, __key, strlen(__key), __n)
398#define add_assoc_null(__arg, __key) add_assoc_null_ex(__arg, __key, strlen(__key))
399#define add_assoc_bool(__arg, __key, __b) add_assoc_bool_ex(__arg, __key, strlen(__key), __b)
400#define add_assoc_resource(__arg, __key, __r) add_assoc_resource_ex(__arg, __key, strlen(__key), __r)
401#define add_assoc_double(__arg, __key, __d) add_assoc_double_ex(__arg, __key, strlen(__key), __d)
402#define add_assoc_str(__arg, __key, __str) add_assoc_str_ex(__arg, __key, strlen(__key), __str)
403#define add_assoc_string(__arg, __key, __str) add_assoc_string_ex(__arg, __key, strlen(__key), __str)
404#define add_assoc_stringl(__arg, __key, __str, __length) add_assoc_stringl_ex(__arg, __key, strlen(__key), __str, __length)
405#define add_assoc_zval(__arg, __key, __value) add_assoc_zval_ex(__arg, __key, strlen(__key), __value)
406
407/* unset() functions are only suported for legacy modules and null() functions should be used */
408#define add_assoc_unset(__arg, __key) add_assoc_null_ex(__arg, __key, strlen(__key))
409#define add_index_unset(__arg, __key) add_index_null(__arg, __key)
410#define add_next_index_unset(__arg) add_next_index_null(__arg)
411#define add_property_unset(__arg, __key) add_property_null(__arg, __key)
412
413ZEND_API int add_index_long(zval *arg, zend_ulong idx, zend_long n);
414ZEND_API int add_index_null(zval *arg, zend_ulong idx);
415ZEND_API int add_index_bool(zval *arg, zend_ulong idx, int b);
416ZEND_API int add_index_resource(zval *arg, zend_ulong idx, zend_resource *r);
417ZEND_API int add_index_double(zval *arg, zend_ulong idx, double d);
418ZEND_API int add_index_str(zval *arg, zend_ulong idx, zend_string *str);
419ZEND_API int add_index_string(zval *arg, zend_ulong idx, const char *str);
420ZEND_API int add_index_stringl(zval *arg, zend_ulong idx, const char *str, size_t length);
421ZEND_API int add_index_zval(zval *arg, zend_ulong index, zval *value);
422
423ZEND_API int add_next_index_long(zval *arg, zend_long n);
424ZEND_API int add_next_index_null(zval *arg);
425ZEND_API int add_next_index_bool(zval *arg, int b);
426ZEND_API int add_next_index_resource(zval *arg, zend_resource *r);
427ZEND_API int add_next_index_double(zval *arg, double d);
428ZEND_API int add_next_index_str(zval *arg, zend_string *str);
429ZEND_API int add_next_index_string(zval *arg, const char *str);
430ZEND_API int add_next_index_stringl(zval *arg, const char *str, size_t length);
431ZEND_API int add_next_index_zval(zval *arg, zval *value);
432
433ZEND_API zval *add_get_assoc_string_ex(zval *arg, const char *key, uint key_len, const char *str);
434ZEND_API zval *add_get_assoc_stringl_ex(zval *arg, const char *key, uint key_len, const char *str, size_t length);
435
436#define add_get_assoc_string(__arg, __key, __str) add_get_assoc_string_ex(__arg, __key, strlen(__key), __str)
437#define add_get_assoc_stringl(__arg, __key, __str, __length) add_get_assoc_stringl_ex(__arg, __key, strlen(__key), __str, __length)
438
439ZEND_API zval *add_get_index_long(zval *arg, zend_ulong idx, zend_long l);
440ZEND_API zval *add_get_index_double(zval *arg, zend_ulong idx, double d);
441ZEND_API zval *add_get_index_str(zval *arg, zend_ulong index, zend_string *str);
442ZEND_API zval *add_get_index_string(zval *arg, zend_ulong idx, const char *str);
443ZEND_API zval *add_get_index_stringl(zval *arg, zend_ulong idx, const char *str, size_t length);
444
445ZEND_API int array_set_zval_key(HashTable *ht, zval *key, zval *value);
446
447ZEND_API int add_property_long_ex(zval *arg, const char *key, size_t key_len, zend_long l);
448ZEND_API int add_property_null_ex(zval *arg, const char *key, size_t key_len);
449ZEND_API int add_property_bool_ex(zval *arg, const char *key, size_t key_len, zend_long b);
450ZEND_API int add_property_resource_ex(zval *arg, const char *key, size_t key_len, zend_resource *r);
451ZEND_API int add_property_double_ex(zval *arg, const char *key, size_t key_len, double d);
452ZEND_API int add_property_str_ex(zval *arg, const char *key, size_t key_len, zend_string *str);
453ZEND_API int add_property_string_ex(zval *arg, const char *key, size_t key_len, const char *str);
454ZEND_API int add_property_stringl_ex(zval *arg, const char *key, size_t key_len,  const char *str, size_t length);
455ZEND_API int add_property_zval_ex(zval *arg, const char *key, size_t key_len, zval *value);
456
457#define add_property_long(__arg, __key, __n) add_property_long_ex(__arg, __key, strlen(__key), __n)
458#define add_property_null(__arg, __key) add_property_null_ex(__arg, __key, strlen(__key))
459#define add_property_bool(__arg, __key, __b) add_property_bool_ex(__arg, __key, strlen(__key), __b)
460#define add_property_resource(__arg, __key, __r) add_property_resource_ex(__arg, __key, strlen(__key), __r)
461#define add_property_double(__arg, __key, __d) add_property_double_ex(__arg, __key, strlen(__key), __d)
462#define add_property_str(__arg, __key, __str) add_property_str_ex(__arg, __key, strlen(__key), __str)
463#define add_property_string(__arg, __key, __str) add_property_string_ex(__arg, __key, strlen(__key), __str)
464#define add_property_stringl(__arg, __key, __str, __length) add_property_stringl_ex(__arg, __key, strlen(__key), __str, __length)
465#define add_property_zval(__arg, __key, __value) add_property_zval_ex(__arg, __key, strlen(__key), __value)
466
467
468ZEND_API int call_user_function(HashTable *function_table, zval *object, zval *function_name, zval *retval_ptr, uint32_t param_count, zval params[]);
469ZEND_API int call_user_function_ex(HashTable *function_table, zval *object, zval *function_name, zval *retval_ptr, uint32_t param_count, zval params[], int no_separation, zend_array *symbol_table);
470
471ZEND_API extern const zend_fcall_info empty_fcall_info;
472ZEND_API extern const zend_fcall_info_cache empty_fcall_info_cache;
473
474/** Build zend_call_info/cache from a zval*
475 *
476 * Caller is responsible to provide a return value, otherwise the we will crash.
477 * fci->retval_ptr_ptr = NULL;
478 * In order to pass parameters the following members need to be set:
479 * fci->param_count = 0;
480 * fci->params = NULL;
481 * The callable_name argument may be NULL.
482 * Set check_flags to IS_CALLABLE_STRICT for every new usage!
483 */
484ZEND_API int zend_fcall_info_init(zval *callable, uint check_flags, zend_fcall_info *fci, zend_fcall_info_cache *fcc, zend_string **callable_name, char **error);
485
486/** Clear arguments connected with zend_fcall_info *fci
487 * If free_mem is not zero then the params array gets free'd as well
488 */
489ZEND_API void zend_fcall_info_args_clear(zend_fcall_info *fci, int free_mem);
490
491/** Save current arguments from zend_fcall_info *fci
492 * params array will be set to NULL
493 */
494ZEND_API void zend_fcall_info_args_save(zend_fcall_info *fci, int *param_count, zval **params);
495
496/** Free arguments connected with zend_fcall_info *fci andset back saved ones.
497 */
498ZEND_API void zend_fcall_info_args_restore(zend_fcall_info *fci, int param_count, zval *params);
499
500/** Set or clear the arguments in the zend_call_info struct taking care of
501 * refcount. If args is NULL and arguments are set then those are cleared.
502 */
503ZEND_API int zend_fcall_info_args(zend_fcall_info *fci, zval *args);
504ZEND_API int zend_fcall_info_args_ex(zend_fcall_info *fci, zend_function *func, zval *args);
505
506/** Set arguments in the zend_fcall_info struct taking care of refcount.
507 * If argc is 0 the arguments which are set will be cleared, else pass
508 * a variable amount of zval** arguments.
509 */
510ZEND_API int zend_fcall_info_argp(zend_fcall_info *fci, int argc, zval *argv);
511
512/** Set arguments in the zend_fcall_info struct taking care of refcount.
513 * If argc is 0 the arguments which are set will be cleared, else pass
514 * a variable amount of zval** arguments.
515 */
516ZEND_API int zend_fcall_info_argv(zend_fcall_info *fci, int argc, va_list *argv);
517
518/** Set arguments in the zend_fcall_info struct taking care of refcount.
519 * If argc is 0 the arguments which are set will be cleared, else pass
520 * a variable amount of zval** arguments.
521 */
522ZEND_API int zend_fcall_info_argn(zend_fcall_info *fci, int argc, ...);
523
524/** Call a function using information created by zend_fcall_info_init()/args().
525 * If args is given then those replace the argument info in fci is temporarily.
526 */
527ZEND_API int zend_fcall_info_call(zend_fcall_info *fci, zend_fcall_info_cache *fcc, zval *retval, zval *args);
528
529ZEND_API int zend_call_function(zend_fcall_info *fci, zend_fcall_info_cache *fci_cache);
530
531ZEND_API int zend_set_hash_symbol(zval *symbol, const char *name, int name_length, zend_bool is_ref, int num_symbol_tables, ...);
532
533ZEND_API int zend_delete_global_variable(zend_string *name);
534
535ZEND_API zend_array *zend_rebuild_symbol_table(void);
536ZEND_API void zend_attach_symbol_table(zend_execute_data *execute_data);
537ZEND_API void zend_detach_symbol_table(zend_execute_data *execute_data);
538ZEND_API int zend_set_local_var(zend_string *name, zval *value, int force);
539ZEND_API int zend_set_local_var_str(const char *name, size_t len, zval *value, int force);
540
541ZEND_API zend_string *zend_find_alias_name(zend_class_entry *ce, zend_string *name);
542ZEND_API zend_string *zend_resolve_method_name(zend_class_entry *ce, zend_function *f);
543
544ZEND_API const char *zend_get_object_type(const zend_class_entry *ce);
545
546#define add_method(arg, key, method)    add_assoc_function((arg), (key), (method))
547
548ZEND_API ZEND_FUNCTION(display_disabled_function);
549ZEND_API ZEND_FUNCTION(display_disabled_class);
550END_EXTERN_C()
551
552#if ZEND_DEBUG
553#define CHECK_ZVAL_STRING(str) \
554    if ((str)->val[(str)->len] != '\0') { zend_error(E_WARNING, "String is not zero-terminated (%s)", (str)->val); }
555#define CHECK_ZVAL_STRING_REL(str) \
556    if ((str)->val[(str)->len] != '\0') { zend_error(E_WARNING, "String is not zero-terminated (%s) (source: %s:%d)", (str)->val ZEND_FILE_LINE_RELAY_CC); }
557#else
558#define CHECK_ZVAL_STRING(z)
559#define CHECK_ZVAL_STRING_REL(z)
560#endif
561
562#define CHECK_ZVAL_NULL_PATH(p) (Z_STRLEN_P(p) != strlen(Z_STRVAL_P(p)))
563#define CHECK_NULL_PATH(p, l) (strlen(p) != l)
564
565#define ZVAL_STRINGL(z, s, l) do {              \
566        ZVAL_NEW_STR(z, zend_string_init(s, l, 0));     \
567    } while (0)
568
569#define ZVAL_STRING(z, s) do {                  \
570        const char *_s = (s);                   \
571        ZVAL_STRINGL(z, _s, strlen(_s));        \
572    } while (0)
573
574#define ZVAL_EMPTY_STRING(z) do {               \
575        ZVAL_INTERNED_STR(z, STR_EMPTY_ALLOC());        \
576    } while (0)
577
578#define ZVAL_PSTRINGL(z, s, l) do {             \
579        ZVAL_NEW_STR(z, zend_string_init(s, l, 1));     \
580    } while (0)
581
582#define ZVAL_PSTRING(z, s) do {                 \
583        const char *_s = (s);                   \
584        ZVAL_PSTRINGL(z, _s, strlen(_s));       \
585    } while (0)
586
587#define ZVAL_EMPTY_PSTRING(z) do {              \
588        ZVAL_PSTRINGL(z, "", 0);                \
589    } while (0)
590
591#define ZVAL_ZVAL(z, zv, copy, dtor) do {       \
592        zval *__z = (z);                        \
593        zval *__zv = (zv);                      \
594        if (EXPECTED(!Z_ISREF_P(__zv))) {       \
595            ZVAL_COPY_VALUE(__z, __zv);         \
596        } else {                                \
597            ZVAL_COPY_VALUE(__z,                \
598                Z_REFVAL_P(__zv));              \
599        }                                       \
600        if (copy) {                             \
601            zval_opt_copy_ctor(__z);            \
602        }                                       \
603        if (dtor) {                             \
604            if (!copy) {                        \
605                ZVAL_NULL(__zv);                \
606            }                                   \
607            zval_ptr_dtor(__zv);                \
608        }                                       \
609    } while (0)
610
611#define RETVAL_BOOL(b)                  ZVAL_BOOL(return_value, b)
612#define RETVAL_NULL()                   ZVAL_NULL(return_value)
613#define RETVAL_LONG(l)                  ZVAL_LONG(return_value, l)
614#define RETVAL_DOUBLE(d)                ZVAL_DOUBLE(return_value, d)
615#define RETVAL_STR(s)                   ZVAL_STR(return_value, s)
616#define RETVAL_INTERNED_STR(s)          ZVAL_INTERNED_STR(return_value, s)
617#define RETVAL_NEW_STR(s)               ZVAL_NEW_STR(return_value, s)
618#define RETVAL_STR_COPY(s)              ZVAL_STR_COPY(return_value, s)
619#define RETVAL_STRING(s)                ZVAL_STRING(return_value, s)
620#define RETVAL_STRINGL(s, l)            ZVAL_STRINGL(return_value, s, l)
621#define RETVAL_EMPTY_STRING()           ZVAL_EMPTY_STRING(return_value)
622#define RETVAL_RES(r)                   ZVAL_RES(return_value, r)
623#define RETVAL_ARR(r)                   ZVAL_ARR(return_value, r)
624#define RETVAL_OBJ(r)                   ZVAL_OBJ(return_value, r)
625#define RETVAL_ZVAL(zv, copy, dtor)     ZVAL_ZVAL(return_value, zv, copy, dtor)
626#define RETVAL_FALSE                    ZVAL_FALSE(return_value)
627#define RETVAL_TRUE                     ZVAL_TRUE(return_value)
628
629#define RETURN_BOOL(b)                  { RETVAL_BOOL(b); return; }
630#define RETURN_NULL()                   { RETVAL_NULL(); return;}
631#define RETURN_LONG(l)                  { RETVAL_LONG(l); return; }
632#define RETURN_DOUBLE(d)                { RETVAL_DOUBLE(d); return; }
633#define RETURN_STR(s)                   { RETVAL_STR(s); return; }
634#define RETURN_INTERNED_STR(s)          { RETVAL_INTERNED_STR(s); return; }
635#define RETURN_NEW_STR(s)               { RETVAL_NEW_STR(s); return; }
636#define RETURN_STR_COPY(s)              { RETVAL_STR_COPY(s); return; }
637#define RETURN_STRING(s)                { RETVAL_STRING(s); return; }
638#define RETURN_STRINGL(s, l)            { RETVAL_STRINGL(s, l); return; }
639#define RETURN_EMPTY_STRING()           { RETVAL_EMPTY_STRING(); return; }
640#define RETURN_RES(r)                   { RETVAL_RES(r); return; }
641#define RETURN_ARR(r)                   { RETVAL_ARR(r); return; }
642#define RETURN_OBJ(r)                   { RETVAL_OBJ(r); return; }
643#define RETURN_ZVAL(zv, copy, dtor)     { RETVAL_ZVAL(zv, copy, dtor); return; }
644#define RETURN_FALSE                    { RETVAL_FALSE; return; }
645#define RETURN_TRUE                     { RETVAL_TRUE; return; }
646
647#define RETVAL_ZVAL_FAST(z) do {      \
648    zval *_z = (z);                   \
649    if (Z_ISREF_P(_z)) {              \
650        RETVAL_ZVAL(_z, 1, 0);        \
651    } else {                          \
652        zval_ptr_dtor(return_value);  \
653        ZVAL_COPY(return_value, _z);  \
654    }                                 \
655} while (0)
656
657#define RETURN_ZVAL_FAST(z) { RETVAL_ZVAL_FAST(z); return; }
658
659#define HASH_OF(p) (Z_TYPE_P(p)==IS_ARRAY ? Z_ARRVAL_P(p) : ((Z_TYPE_P(p)==IS_OBJECT ? Z_OBJ_HT_P(p)->get_properties((p)) : NULL)))
660#define ZVAL_IS_NULL(z) (Z_TYPE_P(z) == IS_NULL)
661
662/* For compatibility */
663#define ZEND_MINIT          ZEND_MODULE_STARTUP_N
664#define ZEND_MSHUTDOWN      ZEND_MODULE_SHUTDOWN_N
665#define ZEND_RINIT          ZEND_MODULE_ACTIVATE_N
666#define ZEND_RSHUTDOWN      ZEND_MODULE_DEACTIVATE_N
667#define ZEND_MINFO          ZEND_MODULE_INFO_N
668#define ZEND_GINIT(module)      ((void (*)(void*))(ZEND_MODULE_GLOBALS_CTOR_N(module)))
669#define ZEND_GSHUTDOWN(module)  ((void (*)(void*))(ZEND_MODULE_GLOBALS_DTOR_N(module)))
670
671#define ZEND_MINIT_FUNCTION         ZEND_MODULE_STARTUP_D
672#define ZEND_MSHUTDOWN_FUNCTION     ZEND_MODULE_SHUTDOWN_D
673#define ZEND_RINIT_FUNCTION         ZEND_MODULE_ACTIVATE_D
674#define ZEND_RSHUTDOWN_FUNCTION     ZEND_MODULE_DEACTIVATE_D
675#define ZEND_MINFO_FUNCTION         ZEND_MODULE_INFO_D
676#define ZEND_GINIT_FUNCTION         ZEND_MODULE_GLOBALS_CTOR_D
677#define ZEND_GSHUTDOWN_FUNCTION     ZEND_MODULE_GLOBALS_DTOR_D
678
679/* Fast parameter parsing API */
680
681/* This API should be used only for really often used functions.
682 * (Keep the original parsing code and wrap usage with #ifndef FAST_ZPP)
683 */
684#define FAST_ZPP 1
685
686#ifdef FAST_ZPP
687
688#define Z_EXPECTED_TYPES(_) \
689    _(Z_EXPECTED_LONG,      "integer") \
690    _(Z_EXPECTED_BOOL,      "boolean") \
691    _(Z_EXPECTED_STRING,    "string") \
692    _(Z_EXPECTED_ARRAY,     "array") \
693    _(Z_EXPECTED_FUNC,      "valid callback") \
694    _(Z_EXPECTED_RESOURCE,  "resource") \
695    _(Z_EXPECTED_PATH,      "a valid path") \
696    _(Z_EXPECTED_OBJECT,    "object") \
697    _(Z_EXPECTED_DOUBLE,    "float")
698
699#define Z_EXPECTED_TYPE_ENUM(id, str) id,
700#define Z_EXPECTED_TYPE_STR(id, str)  str,
701
702typedef enum _zend_expected_type {
703    Z_EXPECTED_TYPES(Z_EXPECTED_TYPE_ENUM)
704    Z_EXPECTED_LAST
705} zend_expected_type;
706
707ZEND_API void ZEND_FASTCALL zend_wrong_paramers_count_error(int num_args, int min_num_args, int max_num_args);
708ZEND_API void ZEND_FASTCALL zend_wrong_paramer_type_error(int num, zend_expected_type expected_type, zval *arg);
709ZEND_API void ZEND_FASTCALL zend_wrong_paramer_class_error(int num, char *name, zval *arg);
710ZEND_API void ZEND_FASTCALL zend_wrong_callback_error(int severity, int num, char *error);
711
712#define ZPP_ERROR_OK             0
713#define ZPP_ERROR_FAILURE        1
714#define ZPP_ERROR_WRONG_CALLBACK 2
715#define ZPP_ERROR_WRONG_CLASS    3
716#define ZPP_ERROR_WRONG_ARG      4
717#define ZPP_ERROR_WRONG_COUNT    5
718
719#define ZEND_PARSE_PARAMETERS_START_EX(flags, min_num_args, max_num_args) do { \
720        const int _flags = (flags); \
721        int _min_num_args = (min_num_args); \
722        int _max_num_args = (max_num_args); \
723        int _num_args = EX_NUM_ARGS(); \
724        int _i; \
725        zval *_real_arg, *_arg = NULL; \
726        zend_expected_type _expected_type = IS_UNDEF; \
727        char *_error = NULL; \
728        zend_bool _dummy; \
729        zend_bool _optional = 0; \
730        int error_code = ZPP_ERROR_OK; \
731        ((void)_i); \
732        ((void)_real_arg); \
733        ((void)_arg); \
734        ((void)_expected_type); \
735        ((void)_error); \
736        ((void)_dummy); \
737        ((void)_optional); \
738        \
739        do { \
740            if (UNEXPECTED(_num_args < _min_num_args) || \
741                (UNEXPECTED(_num_args > _max_num_args) && \
742                 EXPECTED(_max_num_args >= 0))) { \
743                if (!(_flags & ZEND_PARSE_PARAMS_QUIET)) { \
744                    zend_wrong_paramers_count_error(_num_args, _min_num_args, _max_num_args); \
745                } \
746                error_code = ZPP_ERROR_FAILURE; \
747                break; \
748            } \
749            _i = 0; \
750            _real_arg = ZEND_CALL_ARG(execute_data, 0);
751
752#define ZEND_PARSE_PARAMETERS_START(min_num_args, max_num_args) \
753    ZEND_PARSE_PARAMETERS_START_EX(0, min_num_args, max_num_args)
754
755#define ZEND_PARSE_PARAMETERS_END_EX(failure) \
756        } while (0); \
757        if (UNEXPECTED(error_code != ZPP_ERROR_OK)) { \
758            if (!(_flags & ZEND_PARSE_PARAMS_QUIET)) { \
759                if (error_code == ZPP_ERROR_WRONG_CALLBACK) { \
760                    zend_wrong_callback_error(E_WARNING, _i, _error); \
761                } else if (error_code == ZPP_ERROR_WRONG_CLASS) { \
762                    zend_wrong_paramer_class_error(_i, _error, _arg); \
763                } else if (error_code == ZPP_ERROR_WRONG_ARG) { \
764                    zend_wrong_paramer_type_error(_i, _expected_type, _arg); \
765                } \
766            } \
767            failure; \
768        } \
769    } while (0)
770
771#define ZEND_PARSE_PARAMETERS_END() \
772    ZEND_PARSE_PARAMETERS_END_EX(return)
773
774#define Z_PARAM_PROLOGUE(separate) \
775    ++_i; \
776    if (_optional) { \
777        if (UNEXPECTED(_i >_num_args)) break; \
778    } \
779    _real_arg++; \
780    _arg = _real_arg; \
781    ZVAL_DEREF(_arg); \
782    if (separate) { \
783        SEPARATE_ZVAL_NOREF(_arg); \
784    }
785
786/* old "|" */
787#define Z_PARAM_OPTIONAL \
788    _optional = 1;
789
790/* old "a" */
791#define Z_PARAM_ARRAY_EX(dest, check_null, separate) \
792        Z_PARAM_PROLOGUE(separate); \
793        if (UNEXPECTED(!zend_parse_arg_array(_arg, &dest, check_null, 0))) { \
794            _expected_type = Z_EXPECTED_ARRAY; \
795            error_code = ZPP_ERROR_WRONG_ARG; \
796            break; \
797        }
798
799#define Z_PARAM_ARRAY(dest) \
800    Z_PARAM_ARRAY_EX(dest, 0, 0)
801
802/* old "A" */
803#define Z_PARAM_ARRAY_OR_OBJECT_EX(dest, check_null, separate) \
804        Z_PARAM_PROLOGUE(separate); \
805        if (UNEXPECTED(!zend_parse_arg_array(_arg, &dest, check_null, 1))) { \
806            _expected_type = Z_EXPECTED_ARRAY; \
807            error_code = ZPP_ERROR_WRONG_ARG; \
808            break; \
809        }
810
811#define Z_PARAM_ARRAY_OR_OBJECT(dest, check_null, separate) \
812    Z_PARAM_ARRAY_OR_OBJECT_EX(dest, 0, 0)
813
814/* old "b" */
815#define Z_PARAM_BOOL_EX(dest, is_null, check_null, separate) \
816        Z_PARAM_PROLOGUE(separate); \
817        if (UNEXPECTED(!zend_parse_arg_bool(_arg, &dest, &is_null, check_null))) { \
818            _expected_type = Z_EXPECTED_BOOL; \
819            error_code = ZPP_ERROR_WRONG_ARG; \
820            break; \
821        }
822
823#define Z_PARAM_BOOL(dest) \
824    Z_PARAM_BOOL_EX(dest, _dummy, 0, 0)
825
826/* old "C" */
827#define Z_PARAM_CLASS_EX(dest, check_null, separate) \
828        Z_PARAM_PROLOGUE(separate); \
829        if (UNEXPECTED(!zend_parse_arg_class(_arg, &dest, _i, check_null))) { \
830            error_code = ZPP_ERROR_FAILURE; \
831            break; \
832        }
833
834#define Z_PARAM_CLASS(dest) \
835    Z_PARAM_CLASS_EX(dest, 0, 0)
836
837/* old "d" */
838#define Z_PARAM_DOUBLE_EX(dest, is_null, check_null, separate) \
839        Z_PARAM_PROLOGUE(separate); \
840        if (UNEXPECTED(!zend_parse_arg_double(_arg, &dest, &is_null, check_null))) { \
841            _expected_type = Z_EXPECTED_DOUBLE; \
842            error_code = ZPP_ERROR_WRONG_ARG; \
843            break; \
844        }
845
846#define Z_PARAM_DOUBLE(dest) \
847    Z_PARAM_DOUBLE_EX(dest, _dummy, 0, 0)
848
849/* old "f" */
850#define Z_PARAM_FUNC_EX(dest_fci, dest_fcc, check_null, separate) \
851        Z_PARAM_PROLOGUE(separate); \
852        if (UNEXPECTED(!zend_parse_arg_func(_arg, &dest_fci, &dest_fcc, check_null, &_error))) { \
853            if (!_error) { \
854                _expected_type = Z_EXPECTED_FUNC; \
855                error_code = ZPP_ERROR_WRONG_ARG; \
856                break; \
857            } else { \
858                error_code = ZPP_ERROR_WRONG_CALLBACK; \
859                break; \
860            } \
861        } else if (UNEXPECTED(_error != NULL)) { \
862            zend_wrong_callback_error(E_DEPRECATED, _i, _error); \
863        }
864
865#define Z_PARAM_FUNC(dest_fci, dest_fcc) \
866    Z_PARAM_FUNC_EX(dest_fci, dest_fcc, 0, 0)
867
868/* old "h" */
869#define Z_PARAM_ARRAY_HT_EX(dest, check_null, separate) \
870        Z_PARAM_PROLOGUE(separate); \
871        if (UNEXPECTED(!zend_parse_arg_array_ht(_arg, &dest, check_null, 0))) { \
872            _expected_type = Z_EXPECTED_ARRAY; \
873            error_code = ZPP_ERROR_WRONG_ARG; \
874            break; \
875        }
876
877#define Z_PARAM_ARRAY_HT(dest) \
878    Z_PARAM_ARRAY_HT_EX(dest, 0, 0)
879
880/* old "H" */
881#define Z_PARAM_ARRAY_OR_OBJECT_HT_EX(dest, check_null, separate) \
882        Z_PARAM_PROLOGUE(separate); \
883        if (UNEXPECTED(!zend_parse_arg_array_ht(_arg, &dest, check_null, 1))) { \
884            _expected_type = Z_EXPECTED_ARRAY; \
885            error_code = ZPP_ERROR_WRONG_ARG; \
886            break; \
887        }
888
889#define Z_PARAM_ARRAY_OR_OBJECT_HT(dest) \
890    Z_PARAM_ARRAY_OR_OBJECT_HT_EX(dest, 0, 0)
891
892/* old "l" */
893#define Z_PARAM_LONG_EX(dest, is_null, check_null, separate) \
894        Z_PARAM_PROLOGUE(separate); \
895        if (UNEXPECTED(!zend_parse_arg_long(_arg, &dest, &is_null, check_null, 0))) { \
896            _expected_type = Z_EXPECTED_LONG; \
897            error_code = ZPP_ERROR_WRONG_ARG; \
898            break; \
899        }
900
901#define Z_PARAM_LONG(dest) \
902    Z_PARAM_LONG_EX(dest, _dummy, 0, 0)
903
904/* old "L" */
905#define Z_PARAM_STRICT_LONG_EX(dest, is_null, check_null, separate) \
906        Z_PARAM_PROLOGUE(separate); \
907        if (UNEXPECTED(!zend_parse_arg_long(_arg, &dest, &is_null, check_null, 1))) { \
908            _expected_type = Z_EXPECTED_LONG; \
909            error_code = ZPP_ERROR_WRONG_ARG; \
910            break; \
911        }
912
913#define Z_PARAM_STRICT_LONG(dest) \
914    Z_PARAM_STRICT_LONG_EX(dest, _dummy, 0, 0)
915
916/* old "o" */
917#define Z_PARAM_OBJECT_EX(dest, check_null, separate) \
918        Z_PARAM_PROLOGUE(separate); \
919        if (UNEXPECTED(!zend_parse_arg_object(_arg, &dest, NULL, check_null))) { \
920            _expected_type = Z_EXPECTED_OBJECT; \
921            error_code = ZPP_ERROR_WRONG_ARG; \
922            break; \
923        }
924
925#define Z_PARAM_OBJECT(dest) \
926    Z_PARAM_OBJECT_EX(dest, 0, 0)
927
928/* old "O" */
929#define Z_PARAM_OBJECT_OF_CLASS_EX(dest, _ce, check_null, separate) \
930        Z_PARAM_PROLOGUE(separate); \
931        if (UNEXPECTED(!zend_parse_arg_object(_arg, &dest, _ce, check_null))) { \
932            if (_ce) { \
933                _error = (_ce)->name->val; \
934                error_code = ZPP_ERROR_WRONG_CLASS; \
935                break; \
936            } else { \
937                _expected_type = Z_EXPECTED_OBJECT; \
938                error_code = ZPP_ERROR_WRONG_ARG; \
939                break; \
940            } \
941        }
942
943#define Z_PARAM_OBJECT_OF_CLASS(dest, _ce) \
944    Z_PARAM_OBJECT_OF_CLASS_EX(dest, _ce, 0, 0)
945
946/* old "p" */
947#define Z_PARAM_PATH_EX(dest, dest_len, check_null, separate) \
948        Z_PARAM_PROLOGUE(separate); \
949        if (UNEXPECTED(!zend_parse_arg_path(_arg, &dest, &dest_len, check_null))) { \
950            _expected_type = Z_EXPECTED_PATH; \
951            error_code = ZPP_ERROR_WRONG_ARG; \
952            break; \
953        }
954
955#define Z_PARAM_PATH(dest, dest_len) \
956    Z_PARAM_PATH_EX(dest, dest_len, 0, 0)
957
958/* old "P" */
959#define Z_PARAM_PATH_STR_EX(dest, check_null, separate) \
960        Z_PARAM_PROLOGUE(separate); \
961        if (UNEXPECTED(!zend_parse_arg_path_str(_arg, &dest, check_null))) { \
962            _expected_type = Z_EXPECTED_PATH; \
963            error_code = ZPP_ERROR_WRONG_ARG; \
964            break; \
965        }
966
967#define Z_PARAM_PATH_STR(dest) \
968    Z_PARAM_PATH_STR_EX(dest, 0, 0)
969
970/* old "r" */
971#define Z_PARAM_RESOURCE_EX(dest, check_null, separate) \
972        Z_PARAM_PROLOGUE(separate); \
973        if (UNEXPECTED(!zend_parse_arg_resource(_arg, &dest, check_null))) { \
974            _expected_type = Z_EXPECTED_RESOURCE; \
975            error_code = ZPP_ERROR_WRONG_ARG; \
976            break; \
977        }
978
979#define Z_PARAM_RESOURCE(dest) \
980    Z_PARAM_RESOURCE_EX(dest, 0, 0)
981
982/* old "s" */
983#define Z_PARAM_STRING_EX(dest, dest_len, check_null, separate) \
984        Z_PARAM_PROLOGUE(separate); \
985        if (UNEXPECTED(!zend_parse_arg_string(_arg, &dest, &dest_len, check_null))) { \
986            _expected_type = Z_EXPECTED_STRING; \
987            error_code = ZPP_ERROR_WRONG_ARG; \
988            break; \
989        }
990
991#define Z_PARAM_STRING(dest, dest_len) \
992    Z_PARAM_STRING_EX(dest, dest_len, 0, 0)
993
994/* old "S" */
995#define Z_PARAM_STR_EX(dest, check_null, separate) \
996        Z_PARAM_PROLOGUE(separate); \
997        if (UNEXPECTED(!zend_parse_arg_str(_arg, &dest, check_null))) { \
998            _expected_type = Z_EXPECTED_STRING; \
999            error_code = ZPP_ERROR_WRONG_ARG; \
1000            break; \
1001        }
1002
1003#define Z_PARAM_STR(dest) \
1004    Z_PARAM_STR_EX(dest, 0, 0)
1005
1006/* old "z" */
1007#define Z_PARAM_ZVAL_EX(dest, check_null, separate) \
1008        if (separate) { \
1009            Z_PARAM_PROLOGUE(separate); \
1010            zend_parse_arg_zval_deref(_arg, &dest, check_null); \
1011        } else { \
1012            if (UNEXPECTED(++_i >_num_args)) break; \
1013            _real_arg++; \
1014            zend_parse_arg_zval(_real_arg, &dest, check_null); \
1015        }
1016
1017#define Z_PARAM_ZVAL(dest) \
1018    Z_PARAM_ZVAL_EX(dest, 0, 0)
1019
1020/* old "z" (with dereference) */
1021#define Z_PARAM_ZVAL_DEREF_EX(dest, check_null, separate) \
1022        Z_PARAM_PROLOGUE(separate); \
1023        zend_parse_arg_zval_deref(_arg, &dest, check_null);
1024
1025#define Z_PARAM_ZVAL_DEREF(dest) \
1026    Z_PARAM_ZVAL_DEREF_EX(dest, 0, 0)
1027
1028/* old "+" and "*" */
1029#define Z_PARAM_VARIADIC_EX(spec, dest, dest_num, post_varargs) do { \
1030        int _num_varargs = _num_args - _i - (post_varargs); \
1031        if (EXPECTED(_num_varargs > 0)) { \
1032            dest = _real_arg + 1; \
1033            dest_num = _num_varargs; \
1034            _i += _num_varargs; \
1035            _real_arg += _num_varargs; \
1036        } else { \
1037            dest = NULL; \
1038            dest_num = 0; \
1039        } \
1040    } while (0);
1041
1042#define Z_PARAM_VARIADIC(spec, dest, dest_num) \
1043    Z_PARAM_VARIADIC_EX(spec, dest, dest_num, 0)
1044
1045#endif /* FAST_ZPP */
1046
1047/* End of new parameter parsing API */
1048
1049/* Inlined implementations shared by new and old parameter parsing APIs */
1050
1051ZEND_API int ZEND_FASTCALL zend_parse_arg_class(zval *arg, zend_class_entry **pce, int num, int check_null);
1052ZEND_API int ZEND_FASTCALL zend_parse_arg_bool_slow(zval *arg, zend_bool *dest);
1053ZEND_API int ZEND_FASTCALL zend_parse_arg_bool_weak(zval *arg, zend_bool *dest);
1054ZEND_API int ZEND_FASTCALL zend_parse_arg_long_slow(zval *arg, zend_long *dest);
1055ZEND_API int ZEND_FASTCALL zend_parse_arg_long_weak(zval *arg, zend_long *dest);
1056ZEND_API int ZEND_FASTCALL zend_parse_arg_long_cap_slow(zval *arg, zend_long *dest);
1057ZEND_API int ZEND_FASTCALL zend_parse_arg_long_cap_weak(zval *arg, zend_long *dest);
1058ZEND_API int ZEND_FASTCALL zend_parse_arg_double_slow(zval *arg, double *dest);
1059ZEND_API int ZEND_FASTCALL zend_parse_arg_double_weak(zval *arg, double *dest);
1060ZEND_API int ZEND_FASTCALL zend_parse_arg_str_slow(zval *arg, zend_string **dest);
1061ZEND_API int ZEND_FASTCALL zend_parse_arg_str_weak(zval *arg, zend_string **dest);
1062
1063static zend_always_inline int zend_parse_arg_bool(zval *arg, zend_bool *dest, zend_bool *is_null, int check_null)
1064{
1065    if (check_null) {
1066        *is_null = 0;
1067    }
1068    if (EXPECTED(Z_TYPE_P(arg) == IS_TRUE)) {
1069        *dest = 1;
1070    } else if (EXPECTED(Z_TYPE_P(arg) == IS_FALSE)) {
1071        *dest = 0;
1072    } else if (check_null && Z_TYPE_P(arg) == IS_NULL) {
1073        *is_null = 1;
1074        *dest = 0;
1075    } else {
1076        return zend_parse_arg_bool_slow(arg, dest);
1077    }
1078    return 1;
1079}
1080
1081static zend_always_inline int zend_parse_arg_long(zval *arg, zend_long *dest, zend_bool *is_null, int check_null, int cap)
1082{
1083    if (check_null) {
1084        *is_null = 0;
1085    }
1086    if (EXPECTED(Z_TYPE_P(arg) == IS_LONG)) {
1087        *dest = Z_LVAL_P(arg);
1088    } else if (check_null && Z_TYPE_P(arg) == IS_NULL) {
1089        *is_null = 1;
1090        *dest = 0;
1091    } else if (cap) {
1092        return zend_parse_arg_long_cap_slow(arg, dest);
1093    } else {
1094        return zend_parse_arg_long_slow(arg, dest);
1095    }
1096    return 1;
1097}
1098
1099static zend_always_inline int zend_parse_arg_double(zval *arg, double *dest, zend_bool *is_null, int check_null)
1100{
1101    if (check_null) {
1102        *is_null = 0;
1103    }
1104    if (EXPECTED(Z_TYPE_P(arg) == IS_DOUBLE)) {
1105        *dest = Z_DVAL_P(arg);
1106    } else if (check_null && Z_TYPE_P(arg) == IS_NULL) {
1107        *is_null = 1;
1108        *dest = 0.0;
1109    } else {
1110        return zend_parse_arg_double_slow(arg, dest);
1111    }
1112    return 1;
1113}
1114
1115static zend_always_inline int zend_parse_arg_str(zval *arg, zend_string **dest, int check_null)
1116{
1117    if (EXPECTED(Z_TYPE_P(arg) == IS_STRING)) {
1118        *dest = Z_STR_P(arg);
1119    } else if (check_null && Z_TYPE_P(arg) == IS_NULL) {
1120        *dest = NULL;
1121    } else {
1122        return zend_parse_arg_str_slow(arg, dest);
1123    }
1124    return 1;
1125}
1126
1127static zend_always_inline int zend_parse_arg_string(zval *arg, char **dest, size_t *dest_len, int check_null)
1128{
1129    zend_string *str;
1130
1131    if (!zend_parse_arg_str(arg, &str, check_null)) {
1132        return 0;
1133    }
1134    if (check_null && UNEXPECTED(!str)) {
1135        *dest = NULL;
1136        *dest_len = 0;
1137    } else {
1138        *dest = str->val;
1139        *dest_len = str->len;
1140    }
1141    return 1;
1142}
1143
1144static zend_always_inline int zend_parse_arg_path_str(zval *arg, zend_string **dest, int check_null)
1145{
1146    if (!zend_parse_arg_str(arg, dest, check_null) ||
1147        (*dest && UNEXPECTED(CHECK_NULL_PATH((*dest)->val, (*dest)->len)))) {
1148        return 0;
1149    }
1150    return 1;
1151}
1152
1153static zend_always_inline int zend_parse_arg_path(zval *arg, char **dest, size_t *dest_len, int check_null)
1154{
1155    zend_string *str;
1156
1157    if (!zend_parse_arg_path_str(arg, &str, check_null)) {
1158        return 0;
1159    }
1160    if (check_null && UNEXPECTED(!str)) {
1161        *dest = NULL;
1162        *dest_len = 0;
1163    } else {
1164        *dest = str->val;
1165        *dest_len = str->len;
1166    }
1167    return 1;
1168}
1169
1170static zend_always_inline int zend_parse_arg_array(zval *arg, zval **dest, int check_null, int or_object)
1171{
1172    if (EXPECTED(Z_TYPE_P(arg) == IS_ARRAY) ||
1173        (or_object && EXPECTED(Z_TYPE_P(arg) == IS_OBJECT))) {
1174        *dest = arg;
1175    } else if (check_null && EXPECTED(Z_TYPE_P(arg) == IS_NULL)) {
1176        *dest = NULL;
1177    } else {
1178        return 0;
1179    }
1180    return 1;
1181}
1182
1183static zend_always_inline int zend_parse_arg_array_ht(zval *arg, HashTable **dest, int check_null, int or_object)
1184{
1185    if (EXPECTED(Z_TYPE_P(arg) == IS_ARRAY)) {
1186        *dest = Z_ARRVAL_P(arg);
1187    } else if (or_object && EXPECTED(Z_TYPE_P(arg) == IS_OBJECT)) {
1188        *dest = Z_OBJ_HT_P(arg)->get_properties(arg);
1189    } else if (check_null && EXPECTED(Z_TYPE_P(arg) == IS_NULL)) {
1190        *dest = NULL;
1191    } else {
1192        return 0;
1193    }
1194    return 1;
1195}
1196
1197static zend_always_inline int zend_parse_arg_object(zval *arg, zval **dest, zend_class_entry *ce, int check_null)
1198{
1199    if (EXPECTED(Z_TYPE_P(arg) == IS_OBJECT) &&
1200        (!ce || EXPECTED(instanceof_function(Z_OBJCE_P(arg), ce) != 0))) {
1201        *dest = arg;
1202    } else if (check_null && EXPECTED(Z_TYPE_P(arg) == IS_NULL)) {
1203        *dest = NULL;
1204    } else {
1205        return 0;
1206    }
1207    return 1;
1208}
1209
1210static zend_always_inline int zend_parse_arg_resource(zval *arg, zval **dest, int check_null)
1211{
1212    if (EXPECTED(Z_TYPE_P(arg) == IS_RESOURCE)) {
1213        *dest = arg;
1214    } else if (check_null && EXPECTED(Z_TYPE_P(arg) == IS_NULL)) {
1215        *dest = NULL;
1216    } else {
1217        return 0;
1218    }
1219    return 1;
1220}
1221
1222static zend_always_inline int zend_parse_arg_func(zval *arg, zend_fcall_info *dest_fci, zend_fcall_info_cache *dest_fcc, int check_null, char **error)
1223{
1224    if (check_null && UNEXPECTED(Z_TYPE_P(arg) == IS_NULL)) {
1225        dest_fci->size = 0;
1226        dest_fcc->initialized = 0;
1227        *error = NULL;
1228    } else if (UNEXPECTED(zend_fcall_info_init(arg, 0, dest_fci, dest_fcc, NULL, error) != SUCCESS)) {
1229        return 0;
1230    }
1231    return 1;
1232}
1233
1234static zend_always_inline void zend_parse_arg_zval(zval *arg, zval **dest, int check_null)
1235{
1236    *dest = (check_null &&
1237        (UNEXPECTED(Z_TYPE_P(arg) == IS_NULL) ||
1238         (UNEXPECTED(Z_ISREF_P(arg)) &&
1239          UNEXPECTED(Z_TYPE_P(Z_REFVAL_P(arg)) == IS_NULL)))) ? NULL : arg;
1240}
1241
1242static zend_always_inline void zend_parse_arg_zval_deref(zval *arg, zval **dest, int check_null)
1243{
1244    *dest = (check_null && UNEXPECTED(Z_TYPE_P(arg) == IS_NULL)) ? NULL : arg;
1245}
1246
1247END_EXTERN_C()
1248
1249#endif /* ZEND_API_H */
1250
1251
1252/*
1253 * Local variables:
1254 * tab-width: 4
1255 * c-basic-offset: 4
1256 * indent-tabs-mode: t
1257 * End:
1258 */
1259