zend_API.h revision 141d1ba9
1573b4602SAndi Gutmans/*
2573b4602SAndi Gutmans   +----------------------------------------------------------------------+
3573b4602SAndi Gutmans   | Zend Engine                                                          |
4573b4602SAndi Gutmans   +----------------------------------------------------------------------+
59e29f841SSammy Kaye Powers   | Copyright (c) 1998-2017 Zend Technologies Ltd. (http://www.zend.com) |
6573b4602SAndi Gutmans   +----------------------------------------------------------------------+
7d863d52aSSebastian Bergmann   | This source file is subject to version 2.00 of the Zend license,     |
8b4892511SJani Taskinen   | that is bundled with this package in the file LICENSE, and is        |
9f68c7ff2SJames Cox   | available through the world-wide-web at the following url:           |
10d863d52aSSebastian Bergmann   | http://www.zend.com/license/2_00.txt.                                |
11b5b11177SZeev Suraski   | If you did not receive a copy of the Zend license and are unable to  |
12b5b11177SZeev Suraski   | obtain it through the world-wide-web, please send a note to          |
13b5b11177SZeev Suraski   | license@zend.com so we can mail you a copy immediately.              |
14573b4602SAndi Gutmans   +----------------------------------------------------------------------+
15573b4602SAndi Gutmans   | Authors: Andi Gutmans <andi@zend.com>                                |
16573b4602SAndi Gutmans   |          Zeev Suraski <zeev@zend.com>                                |
1758f88057SAndrei Zmievski   |          Andrei Zmievski <andrei@php.net>                            |
1837f0c6b5SDmitry Stogov   |          Dmitry Stogov <dmitry@zend.com>                             |
19573b4602SAndi Gutmans   +----------------------------------------------------------------------+
20573b4602SAndi Gutmans*/
21573b4602SAndi Gutmans
22333406bdSfoobar/* $Id$ */
23b5b11177SZeev Suraski
24b982307dSSascha Schumann#ifndef ZEND_API_H
25b982307dSSascha Schumann#define ZEND_API_H
26573b4602SAndi Gutmans
277080fa5bSAndi Gutmans#include "zend_modules.h"
28573b4602SAndi Gutmans#include "zend_list.h"
295dba4774SZeev Suraski#include "zend_operators.h"
305dba4774SZeev Suraski#include "zend_variables.h"
31df74f1dfSSascha Schumann#include "zend_execute.h"
32573b4602SAndi Gutmans
330450ab94SZeev Suraski
340450ab94SZeev SuraskiBEGIN_EXTERN_C()
35e9d126a7SAndi Gutmans
36f8bbafd6SZeev Suraskitypedef struct _zend_function_entry {
376c810b0dSDmitry Stogov	const char *fname;
38f8bbafd6SZeev Suraski	void (*handler)(INTERNAL_FUNCTION_PARAMETERS);
395dd427eaSDmitry Stogov	const struct _zend_internal_arg_info *arg_info;
406f9f0bf2SAnatol Belski	uint32_t num_args;
416f9f0bf2SAnatol Belski	uint32_t flags;
42f8bbafd6SZeev Suraski} zend_function_entry;
43f8bbafd6SZeev Suraski
44feb85801SDmitry Stogovtypedef struct _zend_fcall_info {
45feb85801SDmitry Stogov	size_t size;
46f4cfaf36SDmitry Stogov	zval function_name;
47f4cfaf36SDmitry Stogov	zval *retval;
48f4cfaf36SDmitry Stogov	zval *params;
49ea85451bSDmitry Stogov	zend_object *object;
50feb85801SDmitry Stogov	zend_bool no_separation;
515d5a7020SAnatol Belski	uint32_t param_count;
52feb85801SDmitry Stogov} zend_fcall_info;
53feb85801SDmitry Stogov
54feb85801SDmitry Stogovtypedef struct _zend_fcall_info_cache {
55feb85801SDmitry Stogov	zend_bool initialized;
56feb85801SDmitry Stogov	zend_function *function_handler;
57feb85801SDmitry Stogov	zend_class_entry *calling_scope;
58feb85801SDmitry Stogov	zend_class_entry *called_scope;
59ea85451bSDmitry Stogov	zend_object *object;
60feb85801SDmitry Stogov} zend_fcall_info_cache;
61feb85801SDmitry Stogov
6286b36438SJelle Zijlstra#define ZEND_NS_NAME(ns, name)			ns "\\" name
63907fa665SDmitry Stogov
64f8bbafd6SZeev Suraski#define ZEND_FN(name) zif_##name
65637a4042SMarcus Boerger#define ZEND_MN(name) zim_##name
66f8bbafd6SZeev Suraski#define ZEND_NAMED_FUNCTION(name)		void name(INTERNAL_FUNCTION_PARAMETERS)
67f8bbafd6SZeev Suraski#define ZEND_FUNCTION(name)				ZEND_NAMED_FUNCTION(ZEND_FN(name))
68637a4042SMarcus Boerger#define ZEND_METHOD(classname, name)	ZEND_NAMED_FUNCTION(ZEND_MN(classname##_##name))
69f8bbafd6SZeev Suraski
707c2a0157SBob Weinand#define ZEND_FENTRY(zend_name, name, arg_info, flags)	{ #zend_name, name, arg_info, (uint32_t) (sizeof(arg_info)/sizeof(struct _zend_internal_arg_info)-1), flags },
711c2512ddSMarcus Boerger
727c2a0157SBob Weinand#define ZEND_RAW_FENTRY(zend_name, name, arg_info, flags)   { zend_name, name, arg_info, (uint32_t) (sizeof(arg_info)/sizeof(struct _zend_internal_arg_info)-1), flags },
731e19ee87SHannes Magnusson#define ZEND_RAW_NAMED_FE(zend_name, name, arg_info) ZEND_RAW_FENTRY(#zend_name, name, arg_info, 0)
741e19ee87SHannes Magnusson
751c2512ddSMarcus Boerger#define ZEND_NAMED_FE(zend_name, name, arg_info)	ZEND_FENTRY(zend_name, name, arg_info, 0)
761c2512ddSMarcus Boerger#define ZEND_FE(name, arg_info)						ZEND_FENTRY(name, ZEND_FN(name), arg_info, 0)
77941b0651SMarcus Boerger#define ZEND_DEP_FE(name, arg_info)                 ZEND_FENTRY(name, ZEND_FN(name), arg_info, ZEND_ACC_DEPRECATED)
78cec053f7SMarcus Boerger#define ZEND_FALIAS(name, alias, arg_info)			ZEND_FENTRY(name, ZEND_FN(alias), arg_info, 0)
79941b0651SMarcus Boerger#define ZEND_DEP_FALIAS(name, alias, arg_info)		ZEND_FENTRY(name, ZEND_FN(alias), arg_info, ZEND_ACC_DEPRECATED)
80637a4042SMarcus Boerger#define ZEND_NAMED_ME(zend_name, name, arg_info, flags)	ZEND_FENTRY(zend_name, name, arg_info, flags)
81637a4042SMarcus Boerger#define ZEND_ME(classname, name, arg_info, flags)	ZEND_FENTRY(name, ZEND_MN(classname##_##name), arg_info, flags)
821c2512ddSMarcus Boerger#define ZEND_ABSTRACT_ME(classname, name, arg_info)	ZEND_FENTRY(name, NULL, arg_info, ZEND_ACC_PUBLIC|ZEND_ACC_ABSTRACT)
8333cdc9edSMarcus Boerger#define ZEND_MALIAS(classname, name, alias, arg_info, flags) \
84637a4042SMarcus Boerger                                                    ZEND_FENTRY(name, ZEND_MN(classname##_##alias), arg_info, flags)
85637a4042SMarcus Boerger#define ZEND_ME_MAPPING(name, func_name, arg_types, flags) ZEND_NAMED_ME(name, ZEND_FN(func_name), arg_types, flags)
86f8bbafd6SZeev Suraski
87907fa665SDmitry Stogov#define ZEND_NS_FENTRY(ns, zend_name, name, arg_info, flags)		ZEND_RAW_FENTRY(ZEND_NS_NAME(ns, #zend_name), name, arg_info, flags)
88907fa665SDmitry Stogov
89907fa665SDmitry Stogov#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)
90907fa665SDmitry Stogov#define ZEND_NS_RAW_NAMED_FE(ns, zend_name, name, arg_info)			ZEND_NS_RAW_FENTRY(ns, #zend_name, name, arg_info, 0)
91907fa665SDmitry Stogov
922d5695cbSSara Golemon#define ZEND_NS_NAMED_FE(ns, zend_name, name, arg_info)	ZEND_NS_FENTRY(ns, zend_name, name, arg_info, 0)
93907fa665SDmitry Stogov#define ZEND_NS_FE(ns, name, arg_info)					ZEND_NS_FENTRY(ns, name, ZEND_FN(name), arg_info, 0)
94907fa665SDmitry Stogov#define ZEND_NS_DEP_FE(ns, name, arg_info)				ZEND_NS_FENTRY(ns, name, ZEND_FN(name), arg_info, ZEND_ACC_DEPRECATED)
95907fa665SDmitry Stogov#define ZEND_NS_FALIAS(ns, name, alias, arg_info)		ZEND_NS_FENTRY(ns, name, ZEND_FN(alias), arg_info, 0)
96907fa665SDmitry Stogov#define ZEND_NS_DEP_FALIAS(ns, name, alias, arg_info)	ZEND_NS_FENTRY(ns, name, ZEND_FN(alias), arg_info, ZEND_ACC_DEPRECATED)
97907fa665SDmitry Stogov
98f1f2a649SFelipe Pena#define ZEND_FE_END            { NULL, NULL, NULL, 0, 0 }
99f1f2a649SFelipe Pena
100141d1ba9SDmitry Stogov#define ZEND_ARG_INFO(pass_by_ref, name)                             { #name, 0, pass_by_ref, 0},
101141d1ba9SDmitry Stogov#define ZEND_ARG_PASS_INFO(pass_by_ref)                              { NULL,  0, pass_by_ref, 0},
102141d1ba9SDmitry Stogov#define ZEND_ARG_OBJ_INFO(pass_by_ref, name, classname, allow_null)  { #name, ZEND_TYPE_ENCODE_CLASS_CONST(#classname, allow_null), pass_by_ref, 0 },
103141d1ba9SDmitry Stogov#define ZEND_ARG_ARRAY_INFO(pass_by_ref, name, allow_null)           { #name, ZEND_TYPE_ENCODE(IS_ARRAY, allow_null), pass_by_ref, 0 },
104141d1ba9SDmitry Stogov#define ZEND_ARG_CALLABLE_INFO(pass_by_ref, name, allow_null)        { #name, ZEND_TYPE_ENCODE(IS_CALLABLE, allow_null), pass_by_ref, 0 },
105141d1ba9SDmitry Stogov#define ZEND_ARG_TYPE_INFO(pass_by_ref, name, type_hint, allow_null) { #name, ZEND_TYPE_ENCODE(type_hint, allow_null), pass_by_ref, 0 },
106141d1ba9SDmitry Stogov#define ZEND_ARG_VARIADIC_INFO(pass_by_ref, name)                    { #name, 0, pass_by_ref, 1 },
1070d7a6388SNikita Popov
108bff4c47fSReeze Xia
109141d1ba9SDmitry Stogov#define ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO_EX(name, return_reference, required_num_args, classname, allow_null) \
110a3379d66SXinchen Hui	static const zend_internal_arg_info name[] = { \
111141d1ba9SDmitry Stogov		{ (const char*)(zend_uintptr_t)(required_num_args), ZEND_TYPE_ENCODE_CLASS_CONST(#classname, allow_null), return_reference, 0 },
112141d1ba9SDmitry Stogov#define ZEND_BEGIN_ARG_WITH_RETURN_OBJ_INFO(name, class_name, allow_null) \
113141d1ba9SDmitry Stogov	ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(name, 0, -1, class_name, allow_null)
114141d1ba9SDmitry Stogov
115141d1ba9SDmitry Stogov#define ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(name, return_reference, required_num_args, type, allow_null) \
116141d1ba9SDmitry Stogov	static const zend_internal_arg_info name[] = { \
117141d1ba9SDmitry Stogov		{ (const char*)(zend_uintptr_t)(required_num_args), ZEND_TYPE_ENCODE(type, allow_null), return_reference, 0 },
118141d1ba9SDmitry Stogov#define ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO(name, type, allow_null) \
119141d1ba9SDmitry Stogov	ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(name, 0, -1, type, allow_null)
120bff4c47fSReeze Xia
1210d7a6388SNikita Popov#define ZEND_BEGIN_ARG_INFO_EX(name, _unused, return_reference, required_num_args)	\
122a3379d66SXinchen Hui	static const zend_internal_arg_info name[] = { \
123141d1ba9SDmitry Stogov		{ (const char*)(zend_uintptr_t)(required_num_args), 0, return_reference, 0 },
1240d7a6388SNikita Popov#define ZEND_BEGIN_ARG_INFO(name, _unused)	\
1250d7a6388SNikita Popov	ZEND_BEGIN_ARG_INFO_EX(name, 0, ZEND_RETURN_VALUE, -1)
126f8bbafd6SZeev Suraski#define ZEND_END_ARG_INFO()		};
127342c6e0bSZeev Suraski
1288b6f848cSAndi Gutmans/* Name macros */
1298b6f848cSAndi Gutmans#define ZEND_MODULE_STARTUP_N(module)       zm_startup_##module
1308b6f848cSAndi Gutmans#define ZEND_MODULE_SHUTDOWN_N(module)		zm_shutdown_##module
1318b6f848cSAndi Gutmans#define ZEND_MODULE_ACTIVATE_N(module)		zm_activate_##module
1328b6f848cSAndi Gutmans#define ZEND_MODULE_DEACTIVATE_N(module)	zm_deactivate_##module
1336535933fSDerick Rethans#define ZEND_MODULE_POST_ZEND_DEACTIVATE_N(module)	zm_post_zend_deactivate_##module
1348b6f848cSAndi Gutmans#define ZEND_MODULE_INFO_N(module)			zm_info_##module
135ada4e506SDmitry Stogov#define ZEND_MODULE_GLOBALS_CTOR_N(module)  zm_globals_ctor_##module
136ada4e506SDmitry Stogov#define ZEND_MODULE_GLOBALS_DTOR_N(module)  zm_globals_dtor_##module
137342c6e0bSZeev Suraski
1388b6f848cSAndi Gutmans/* Declaration macros */
1398b6f848cSAndi Gutmans#define ZEND_MODULE_STARTUP_D(module)		int ZEND_MODULE_STARTUP_N(module)(INIT_FUNC_ARGS)
1408b6f848cSAndi Gutmans#define ZEND_MODULE_SHUTDOWN_D(module)		int ZEND_MODULE_SHUTDOWN_N(module)(SHUTDOWN_FUNC_ARGS)
1418b6f848cSAndi Gutmans#define ZEND_MODULE_ACTIVATE_D(module)		int ZEND_MODULE_ACTIVATE_N(module)(INIT_FUNC_ARGS)
1428b6f848cSAndi Gutmans#define ZEND_MODULE_DEACTIVATE_D(module)	int ZEND_MODULE_DEACTIVATE_N(module)(SHUTDOWN_FUNC_ARGS)
1436535933fSDerick Rethans#define ZEND_MODULE_POST_ZEND_DEACTIVATE_D(module)	int ZEND_MODULE_POST_ZEND_DEACTIVATE_N(module)(void)
1448b6f848cSAndi Gutmans#define ZEND_MODULE_INFO_D(module)			void ZEND_MODULE_INFO_N(module)(ZEND_MODULE_INFO_FUNC_ARGS)
145bdeb220fSAnatol Belski#define ZEND_MODULE_GLOBALS_CTOR_D(module)  void ZEND_MODULE_GLOBALS_CTOR_N(module)(zend_##module##_globals *module##_globals)
146bdeb220fSAnatol Belski#define ZEND_MODULE_GLOBALS_DTOR_D(module)  void ZEND_MODULE_GLOBALS_DTOR_N(module)(zend_##module##_globals *module##_globals)
147342c6e0bSZeev Suraski
1480b6d923bSSascha Schumann#define ZEND_GET_MODULE(name) \
149cb71ac03SHartmut Holzgraefe    BEGIN_EXTERN_C()\
150cb71ac03SHartmut Holzgraefe	ZEND_DLEXPORT zend_module_entry *get_module(void) { return &name##_module_entry; }\
151cb71ac03SHartmut Holzgraefe    END_EXTERN_C()
1520d21940dSZeev Suraski
1530d21940dSZeev Suraski#define ZEND_BEGIN_MODULE_GLOBALS(module_name)		\
1540d21940dSZeev Suraski	typedef struct _zend_##module_name##_globals {
1550d21940dSZeev Suraski#define ZEND_END_MODULE_GLOBALS(module_name)		\
1560d21940dSZeev Suraski	} zend_##module_name##_globals;
1570d21940dSZeev Suraski
1580d21940dSZeev Suraski#ifdef ZTS
1590d21940dSZeev Suraski
1600d21940dSZeev Suraski#define ZEND_DECLARE_MODULE_GLOBALS(module_name)							\
16102af513cSAndi Gutmans	ts_rsrc_id module_name##_globals_id;
16202af513cSAndi Gutmans#define ZEND_EXTERN_MODULE_GLOBALS(module_name)								\
16302af513cSAndi Gutmans	extern ts_rsrc_id module_name##_globals_id;
1640d21940dSZeev Suraski#define ZEND_INIT_MODULE_GLOBALS(module_name, globals_ctor, globals_dtor)	\
1652c254ba7SZeev Suraski	ts_allocate_id(&module_name##_globals_id, sizeof(zend_##module_name##_globals), (ts_allocate_ctor) globals_ctor, (ts_allocate_dtor) globals_dtor);
16643cdfd9aSAnatol Belski#define ZEND_MODULE_GLOBALS_ACCESSOR(module_name, v) ZEND_TSRMG(module_name##_globals_id, zend_##module_name##_globals *, v)
167c9a538cdSAnatol Belski#if ZEND_ENABLE_STATIC_TSRMLS_CACHE
168c9a538cdSAnatol Belski#define ZEND_MODULE_GLOBALS_BULK(module_name) TSRMG_BULK_STATIC(module_name##_globals_id, zend_##module_name##_globals *)
169c9a538cdSAnatol Belski#else
170ffa341deSAnatol Belski#define ZEND_MODULE_GLOBALS_BULK(module_name) TSRMG_BULK(module_name##_globals_id, zend_##module_name##_globals *)
171c9a538cdSAnatol Belski#endif
1720d21940dSZeev Suraski
1730d21940dSZeev Suraski#else
1740d21940dSZeev Suraski
1750d21940dSZeev Suraski#define ZEND_DECLARE_MODULE_GLOBALS(module_name)							\
17602af513cSAndi Gutmans	zend_##module_name##_globals module_name##_globals;
17702af513cSAndi Gutmans#define ZEND_EXTERN_MODULE_GLOBALS(module_name)								\
17802af513cSAndi Gutmans	extern zend_##module_name##_globals module_name##_globals;
1790d21940dSZeev Suraski#define ZEND_INIT_MODULE_GLOBALS(module_name, globals_ctor, globals_dtor)	\
1800d21940dSZeev Suraski	globals_ctor(&module_name##_globals);
18143cdfd9aSAnatol Belski#define ZEND_MODULE_GLOBALS_ACCESSOR(module_name, v) (module_name##_globals.v)
182ffa341deSAnatol Belski#define ZEND_MODULE_GLOBALS_BULK(module_name) (&module_name##_globals)
1830d21940dSZeev Suraski
1840d21940dSZeev Suraski#endif
1850d21940dSZeev Suraski
186b4892511SJani Taskinen#define INIT_CLASS_ENTRY(class_container, class_name, functions) \
187b4892511SJani Taskinen	INIT_OVERLOADED_CLASS_ENTRY(class_container, class_name, functions, NULL, NULL, NULL)
188741b8161SZeev Suraski
189b4892511SJani Taskinen#define INIT_CLASS_ENTRY_EX(class_container, class_name, class_name_len, functions) \
190b4892511SJani Taskinen	INIT_OVERLOADED_CLASS_ENTRY_EX(class_container, class_name, class_name_len, functions, NULL, NULL, NULL, NULL, NULL)
191b4892511SJani Taskinen
192b4892511SJani Taskinen#define INIT_OVERLOADED_CLASS_ENTRY_EX(class_container, class_name, class_name_len, functions, handle_fcall, handle_propget, handle_propset, handle_propunset, handle_propisset) \
193741b8161SZeev Suraski	{															\
194f4cfaf36SDmitry Stogov		zend_string *cl_name;									\
195c3e3c98eSAnatol Belski		cl_name = zend_string_init(class_name, class_name_len, 1);		\
196bdeb220fSAnatol Belski		class_container.name = zend_new_interned_string(cl_name);	\
19703a1fcabSXinchen Hui		INIT_CLASS_ENTRY_INIT_METHODS(class_container, functions, handle_fcall, handle_propget, handle_propset, handle_propunset, handle_propisset) \
19803a1fcabSXinchen Hui	}
19903a1fcabSXinchen Hui
20003a1fcabSXinchen Hui#define INIT_CLASS_ENTRY_INIT_METHODS(class_container, functions, handle_fcall, handle_propget, handle_propset, handle_propunset, handle_propisset) \
20103a1fcabSXinchen Hui	{															\
2022eccd95cSAndi Gutmans		class_container.constructor = NULL;						\
20373b159e0SAndi Gutmans		class_container.destructor = NULL;						\
20429ea3da2SAndi Gutmans		class_container.clone = NULL;							\
205637a4042SMarcus Boerger		class_container.serialize = NULL;						\
206637a4042SMarcus Boerger		class_container.unserialize = NULL;						\
207637a4042SMarcus Boerger		class_container.create_object = NULL;					\
2083c62b3b5SMarcus Boerger		class_container.interface_gets_implemented = NULL;		\
20972d0454bSDmitry Stogov		class_container.get_static_method = NULL;				\
210637a4042SMarcus Boerger		class_container.__call = handle_fcall;					\
211b4892511SJani Taskinen		class_container.__callstatic = NULL;					\
212637a4042SMarcus Boerger		class_container.__tostring = NULL;						\
213637a4042SMarcus Boerger		class_container.__get = handle_propget;					\
214637a4042SMarcus Boerger		class_container.__set = handle_propset;					\
215637a4042SMarcus Boerger		class_container.__unset = handle_propunset;				\
216637a4042SMarcus Boerger		class_container.__isset = handle_propisset;				\
2171e752ce9SSara Golemon		class_container.__debugInfo = NULL;					\
218637a4042SMarcus Boerger		class_container.serialize_func = NULL;					\
219637a4042SMarcus Boerger		class_container.unserialize_func = NULL;				\
220637a4042SMarcus Boerger		class_container.serialize = NULL;						\
221637a4042SMarcus Boerger		class_container.unserialize = NULL;						\
222637a4042SMarcus Boerger		class_container.parent = NULL;							\
223637a4042SMarcus Boerger		class_container.num_interfaces = 0;						\
224fdb6077fSFelipe Pena		class_container.traits = NULL;							\
225fdb6077fSFelipe Pena		class_container.num_traits = 0;							\
226fdb6077fSFelipe Pena		class_container.trait_aliases = NULL;					\
227fdb6077fSFelipe Pena		class_container.trait_precedences = NULL;				\
228637a4042SMarcus Boerger		class_container.interfaces = NULL;						\
229637a4042SMarcus Boerger		class_container.get_iterator = NULL;					\
230637a4042SMarcus Boerger		class_container.iterator_funcs.funcs = NULL;			\
231f2df6a4aSDmitry Stogov		class_container.info.internal.module = NULL;			\
232f2df6a4aSDmitry Stogov		class_container.info.internal.builtin_functions = functions;	\
233741b8161SZeev Suraski	}
234741b8161SZeev Suraski
235345e0255SDmitry Stogov#define INIT_OVERLOADED_CLASS_ENTRY(class_container, class_name, functions, handle_fcall, handle_propget, handle_propset) \
236b4892511SJani Taskinen	INIT_OVERLOADED_CLASS_ENTRY_EX(class_container, class_name, sizeof(class_name)-1, functions, handle_fcall, handle_propget, handle_propset, NULL, NULL)
237345e0255SDmitry Stogov
238907fa665SDmitry Stogov#define INIT_NS_CLASS_ENTRY(class_container, ns, class_name, functions) \
239907fa665SDmitry Stogov	INIT_CLASS_ENTRY(class_container, ZEND_NS_NAME(ns, class_name), functions)
240907fa665SDmitry Stogov#define INIT_OVERLOADED_NS_CLASS_ENTRY_EX(class_container, ns, class_name, functions, handle_fcall, handle_propget, handle_propset, handle_propunset, handle_propisset) \
241907fa665SDmitry Stogov	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)
242907fa665SDmitry Stogov#define INIT_OVERLOADED_NS_CLASS_ENTRY(class_container, ns, class_name, functions, handle_fcall, handle_propget, handle_propset) \
243907fa665SDmitry Stogov	INIT_OVERLOADED_CLASS_ENTRY(class_container, ZEND_NS_NAME(ns, class_name), functions, handle_fcall, handle_propget, handle_propset)
244907fa665SDmitry Stogov
2458768ab94SDmitry Stogov#ifdef ZTS
246f23e8576SDmitry Stogov#	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])
2478768ab94SDmitry Stogov#else
248c5237d82SDmitry Stogov#	define CE_STATIC_MEMBERS(ce) ((ce)->static_members_table)
2498768ab94SDmitry Stogov#endif
2508768ab94SDmitry Stogov
251b4892511SJani Taskinen#define ZEND_FCI_INITIALIZED(fci) ((fci).size != 0)
252b4892511SJani Taskinen
253c96a6b44SAnatol BelskiZEND_API int zend_next_free_module(void);
254573b4602SAndi Gutmans
2551727c6a2SHartmut HolzgraefeBEGIN_EXTERN_C()
256f77e6a44SZeev SuraskiZEND_API int zend_get_parameters(int ht, int param_count, ...);
257e59bfcffSStanislav MalyshevZEND_API ZEND_ATTRIBUTE_DEPRECATED int zend_get_parameters_ex(int param_count, ...);
258bdeb220fSAnatol BelskiZEND_API int _zend_get_parameters_array_ex(int param_count, zval *argument_array);
25911e5d2f2SZeev Suraski
260e39f3f3fSMarcus Boerger/* internal function to efficiently copy parameters when executing __call() */
261bdeb220fSAnatol BelskiZEND_API int zend_copy_parameters_array(int param_count, zval *argument_array);
262e39f3f3fSMarcus Boerger
26395dbe1d0SBob Weinand#define zend_get_parameters_array(ht, param_count, argument_array) \
264bdeb220fSAnatol Belski	_zend_get_parameters_array_ex(param_count, argument_array)
26595dbe1d0SBob Weinand#define zend_get_parameters_array_ex(param_count, argument_array) \
266bdeb220fSAnatol Belski	_zend_get_parameters_array_ex(param_count, argument_array)
26795dbe1d0SBob Weinand#define zend_parse_parameters_none() \
26895dbe1d0SBob Weinand	(EXPECTED(ZEND_NUM_ARGS() == 0) ? SUCCESS : zend_parse_parameters(ZEND_NUM_ARGS(), ""))
26958f88057SAndrei Zmievski
27058f88057SAndrei Zmievski/* Parameter parsing API -- andrei */
27158f88057SAndrei Zmievski
27235f9b90bSDmitry Stogov#define ZEND_PARSE_PARAMS_QUIET (1<<1)
273122d7596SNikita Popov#define ZEND_PARSE_PARAMS_THROW (1<<2)
274bdeb220fSAnatol BelskiZEND_API int zend_parse_parameters(int num_args, const char *type_spec, ...);
275bdeb220fSAnatol BelskiZEND_API int zend_parse_parameters_ex(int flags, int num_args, const char *type_spec, ...);
276122d7596SNikita PopovZEND_API int zend_parse_parameters_throw(int num_args, const char *type_spec, ...);
277cf7384aaSFelipe PenaZEND_API char *zend_zval_type_name(const zval *arg);
27858f88057SAndrei Zmievski
279bdeb220fSAnatol BelskiZEND_API int zend_parse_method_parameters(int num_args, zval *this_ptr, const char *type_spec, ...);
280bdeb220fSAnatol BelskiZEND_API int zend_parse_method_parameters_ex(int flags, int num_args, zval *this_ptr, const char *type_spec, ...);
281c4528f82SHarald Radi
282bdeb220fSAnatol BelskiZEND_API int zend_parse_parameter(int flags, int arg_num, zval *arg, const char *spec, ...);
28313f1d53bSGustavo André dos Santos Lopes
284b5255495SZeev Suraski/* End of parameter parsing API -- andrei */
28539f9487eSAndi Gutmans
286bdeb220fSAnatol BelskiZEND_API int zend_register_functions(zend_class_entry *scope, const zend_function_entry *functions, HashTable *function_table, int type);
287bdeb220fSAnatol BelskiZEND_API void zend_unregister_functions(const zend_function_entry *functions, int count, HashTable *function_table);
288bdeb220fSAnatol BelskiZEND_API int zend_startup_module(zend_module_entry *module_entry);
289bdeb220fSAnatol BelskiZEND_API zend_module_entry* zend_register_internal_module(zend_module_entry *module_entry);
290bdeb220fSAnatol BelskiZEND_API zend_module_entry* zend_register_module_ex(zend_module_entry *module);
291bdeb220fSAnatol BelskiZEND_API int zend_startup_module_ex(zend_module_entry *module);
292bdeb220fSAnatol BelskiZEND_API int zend_startup_modules(void);
293bdeb220fSAnatol BelskiZEND_API void zend_collect_module_handlers(void);
2941a1178a6SDmitry StogovZEND_API void zend_destroy_modules(void);
295bdeb220fSAnatol BelskiZEND_API void zend_check_magic_method_implementation(const zend_class_entry *ce, const zend_function *fptr, int error_type);
296eb0e6946SAndi Gutmans
297bdeb220fSAnatol BelskiZEND_API zend_class_entry *zend_register_internal_class(zend_class_entry *class_entry);
298bdeb220fSAnatol BelskiZEND_API zend_class_entry *zend_register_internal_class_ex(zend_class_entry *class_entry, zend_class_entry *parent_ce);
299bdeb220fSAnatol BelskiZEND_API zend_class_entry *zend_register_internal_interface(zend_class_entry *orig_class_entry);
300bdeb220fSAnatol BelskiZEND_API void zend_class_implements(zend_class_entry *class_entry, int num_interfaces, ...);
301eb0e6946SAndi Gutmans
302bdeb220fSAnatol BelskiZEND_API int zend_register_class_alias_ex(const char *name, size_t name_len, zend_class_entry *ce);
303907fa665SDmitry Stogov
304907fa665SDmitry Stogov#define zend_register_class_alias(name, ce) \
305bdeb220fSAnatol Belski	zend_register_class_alias_ex(name, sizeof(name)-1, ce)
306907fa665SDmitry Stogov#define zend_register_ns_class_alias(ns, name, ce) \
307bdeb220fSAnatol Belski	zend_register_class_alias_ex(ZEND_NS_NAME(ns, name), sizeof(ZEND_NS_NAME(ns, name))-1, ce)
308907fa665SDmitry Stogov
309bdeb220fSAnatol BelskiZEND_API int zend_disable_function(char *function_name, size_t function_name_length);
310bdeb220fSAnatol BelskiZEND_API int zend_disable_class(char *class_name, size_t class_name_length);
311573b4602SAndi Gutmans
31271af54e5SDmitry StogovZEND_API ZEND_COLD void zend_wrong_param_count(void);
313c81db6bcSDmitry Stogov
314c81db6bcSDmitry Stogov#define IS_CALLABLE_CHECK_SYNTAX_ONLY (1<<0)
315c81db6bcSDmitry Stogov#define IS_CALLABLE_CHECK_NO_ACCESS   (1<<1)
31653e52606SMarcus Boerger#define IS_CALLABLE_CHECK_IS_STATIC   (1<<2)
317af05ce0aSDmitry Stogov#define IS_CALLABLE_CHECK_SILENT      (1<<3)
318c81db6bcSDmitry Stogov
3190cd997d7SMarcus Boerger#define IS_CALLABLE_STRICT  (IS_CALLABLE_CHECK_IS_STATIC)
3200cd997d7SMarcus Boerger
321b204b3abSAnatol BelskiZEND_API zend_bool zend_is_callable_ex(zval *callable, zend_object *object, uint32_t check_flags, zend_string **callable_name, zend_fcall_info_cache *fcc, char **error);
322b204b3abSAnatol BelskiZEND_API zend_bool zend_is_callable(zval *callable, uint32_t check_flags, zend_string **callable_name);
323bdeb220fSAnatol BelskiZEND_API zend_bool zend_make_callable(zval *callable, zend_string **callable_name);
3246c810b0dSDmitry StogovZEND_API const char *zend_get_module_version(const char *module_name);
325cf7384aaSFelipe PenaZEND_API int zend_get_module_started(const char *module_name);
326bdeb220fSAnatol BelskiZEND_API int zend_declare_property_ex(zend_class_entry *ce, zend_string *name, zval *property, int access_type, zend_string *doc_comment);
327bdeb220fSAnatol BelskiZEND_API int zend_declare_property(zend_class_entry *ce, const char *name, size_t name_length, zval *property, int access_type);
328bdeb220fSAnatol BelskiZEND_API int zend_declare_property_null(zend_class_entry *ce, const char *name, size_t name_length, int access_type);
329bdeb220fSAnatol BelskiZEND_API int zend_declare_property_bool(zend_class_entry *ce, const char *name, size_t name_length, zend_long value, int access_type);
330bdeb220fSAnatol BelskiZEND_API int zend_declare_property_long(zend_class_entry *ce, const char *name, size_t name_length, zend_long value, int access_type);
331bdeb220fSAnatol BelskiZEND_API int zend_declare_property_double(zend_class_entry *ce, const char *name, size_t name_length, double value, int access_type);
332bdeb220fSAnatol BelskiZEND_API int zend_declare_property_string(zend_class_entry *ce, const char *name, size_t name_length, const char *value, int access_type);
333bdeb220fSAnatol BelskiZEND_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);
334bdeb220fSAnatol Belski
335a75c1950SDmitry StogovZEND_API int zend_declare_class_constant_ex(zend_class_entry *ce, zend_string *name, zval *value, int access_type, zend_string *doc_comment);
336bdeb220fSAnatol BelskiZEND_API int zend_declare_class_constant(zend_class_entry *ce, const char *name, size_t name_length, zval *value);
337bdeb220fSAnatol BelskiZEND_API int zend_declare_class_constant_null(zend_class_entry *ce, const char *name, size_t name_length);
338bdeb220fSAnatol BelskiZEND_API int zend_declare_class_constant_long(zend_class_entry *ce, const char *name, size_t name_length, zend_long value);
339bdeb220fSAnatol BelskiZEND_API int zend_declare_class_constant_bool(zend_class_entry *ce, const char *name, size_t name_length, zend_bool value);
340bdeb220fSAnatol BelskiZEND_API int zend_declare_class_constant_double(zend_class_entry *ce, const char *name, size_t name_length, double value);
341bdeb220fSAnatol BelskiZEND_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);
342bdeb220fSAnatol BelskiZEND_API int zend_declare_class_constant_string(zend_class_entry *ce, const char *name, size_t name_length, const char *value);
343bdeb220fSAnatol Belski
344ea09a9faSDmitry StogovZEND_API int zend_update_class_constants(zend_class_entry *class_type);
345ea09a9faSDmitry Stogov
34670c86732SDmitry StogovZEND_API void zend_update_property_ex(zend_class_entry *scope, zval *object, zend_string *name, zval *value);
347bdeb220fSAnatol BelskiZEND_API void zend_update_property(zend_class_entry *scope, zval *object, const char *name, size_t name_length, zval *value);
348bdeb220fSAnatol BelskiZEND_API void zend_update_property_null(zend_class_entry *scope, zval *object, const char *name, size_t name_length);
349bdeb220fSAnatol BelskiZEND_API void zend_update_property_bool(zend_class_entry *scope, zval *object, const char *name, size_t name_length, zend_long value);
350bdeb220fSAnatol BelskiZEND_API void zend_update_property_long(zend_class_entry *scope, zval *object, const char *name, size_t name_length, zend_long value);
351bdeb220fSAnatol BelskiZEND_API void zend_update_property_double(zend_class_entry *scope, zval *object, const char *name, size_t name_length, double value);
352bdeb220fSAnatol BelskiZEND_API void zend_update_property_str(zend_class_entry *scope, zval *object, const char *name, size_t name_length, zend_string *value);
353bdeb220fSAnatol BelskiZEND_API void zend_update_property_string(zend_class_entry *scope, zval *object, const char *name, size_t name_length, const char *value);
354bdeb220fSAnatol BelskiZEND_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);
355f42cbd74SStanislav MalyshevZEND_API void zend_unset_property(zend_class_entry *scope, zval *object, const char *name, size_t name_length);
356bdeb220fSAnatol Belski
357bdeb220fSAnatol BelskiZEND_API int zend_update_static_property(zend_class_entry *scope, const char *name, size_t name_length, zval *value);
358bdeb220fSAnatol BelskiZEND_API int zend_update_static_property_null(zend_class_entry *scope, const char *name, size_t name_length);
359bdeb220fSAnatol BelskiZEND_API int zend_update_static_property_bool(zend_class_entry *scope, const char *name, size_t name_length, zend_long value);
360bdeb220fSAnatol BelskiZEND_API int zend_update_static_property_long(zend_class_entry *scope, const char *name, size_t name_length, zend_long value);
361bdeb220fSAnatol BelskiZEND_API int zend_update_static_property_double(zend_class_entry *scope, const char *name, size_t name_length, double value);
362bdeb220fSAnatol BelskiZEND_API int zend_update_static_property_string(zend_class_entry *scope, const char *name, size_t name_length, const char *value);
363bdeb220fSAnatol BelskiZEND_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);
364bdeb220fSAnatol Belski
3657b94b958SDmitry StogovZEND_API zval *zend_read_property_ex(zend_class_entry *scope, zval *object, zend_string *name, zend_bool silent, zval *rv);
3663e31838dSDmitry StogovZEND_API zval *zend_read_property(zend_class_entry *scope, zval *object, const char *name, size_t name_length, zend_bool silent, zval *rv);
367bdeb220fSAnatol Belski
368bdeb220fSAnatol BelskiZEND_API zval *zend_read_static_property(zend_class_entry *scope, const char *name, size_t name_length, zend_bool silent);
369248345d9SDmitry Stogov
3709dd24c6dSAntony DovgalZEND_API char *zend_get_type_by_const(int type);
3716ac6cb10SHarald Radi
3727abfaac9SDmitry Stogov#define getThis()							((Z_TYPE(EX(This)) == IS_OBJECT) ? &EX(This) : NULL)
373cf5920e8SNikita Popov#define ZEND_IS_METHOD_CALL()				(EX(func)->common.scope != NULL)
374741b8161SZeev Suraski
3758be4266fSAnthony Ferrara#define WRONG_PARAM_COUNT					ZEND_WRONG_PARAM_COUNT()
376579e7fa4SAnthony Ferrara#define WRONG_PARAM_COUNT_WITH_RETVAL(ret)	ZEND_WRONG_PARAM_COUNT_WITH_RETVAL(ret)
37711384ba7SDmitry Stogov#define ARG_COUNT(dummy)					EX_NUM_ARGS()
37811384ba7SDmitry Stogov#define ZEND_NUM_ARGS()						EX_NUM_ARGS()
379579e7fa4SAnthony Ferrara#define ZEND_WRONG_PARAM_COUNT()					{ zend_wrong_param_count(); return; }
3808be4266fSAnthony Ferrara#define ZEND_WRONG_PARAM_COUNT_WITH_RETVAL(ret)		{ zend_wrong_param_count(); return ret; }
381573b4602SAndi Gutmans
38280bdd19eSZeev Suraski#ifndef ZEND_WIN32
383573b4602SAndi Gutmans#define DLEXPORT
384573b4602SAndi Gutmans#endif
385573b4602SAndi Gutmans
3867da75d81SMatt Wilmas#define array_init(arg)			_array_init((arg), 0 ZEND_FILE_LINE_CC)
3877da75d81SMatt Wilmas#define array_init_size(arg, size) _array_init((arg), (size) ZEND_FILE_LINE_CC)
388bdeb220fSAnatol Belski#define object_init(arg)		_object_init((arg) ZEND_FILE_LINE_CC)
389bdeb220fSAnatol Belski#define object_init_ex(arg, ce)	_object_init_ex((arg), (ce) ZEND_FILE_LINE_CC)
390bdeb220fSAnatol Belski#define object_and_properties_init(arg, ce, properties)	_object_and_properties_init((arg), (ce), (properties) ZEND_FILE_LINE_CC)
39107fdc1c7SAnatol BelskiZEND_API int _array_init(zval *arg, uint32_t size ZEND_FILE_LINE_DC);
392bdeb220fSAnatol BelskiZEND_API int _object_init(zval *arg ZEND_FILE_LINE_DC);
393bdeb220fSAnatol BelskiZEND_API int _object_init_ex(zval *arg, zend_class_entry *ce ZEND_FILE_LINE_DC);
394bdeb220fSAnatol BelskiZEND_API int _object_and_properties_init(zval *arg, zend_class_entry *ce, HashTable *properties ZEND_FILE_LINE_DC);
395c5237d82SDmitry StogovZEND_API void object_properties_init(zend_object *object, zend_class_entry *class_type);
396bdeb220fSAnatol BelskiZEND_API void object_properties_init_ex(zend_object *object, HashTable *properties);
397bdeb220fSAnatol BelskiZEND_API void object_properties_load(zend_object *object, HashTable *properties);
3986847fefaSThies C. Arntzen
399bdeb220fSAnatol BelskiZEND_API void zend_merge_properties(zval *obj, HashTable *properties);
400047a574eSMarcus Boerger
401f2279224SAnatol BelskiZEND_API int add_assoc_long_ex(zval *arg, const char *key, size_t key_len, zend_long n);
402f2279224SAnatol BelskiZEND_API int add_assoc_null_ex(zval *arg, const char *key, size_t key_len);
403f2279224SAnatol BelskiZEND_API int add_assoc_bool_ex(zval *arg, const char *key, size_t key_len, int b);
404f2279224SAnatol BelskiZEND_API int add_assoc_resource_ex(zval *arg, const char *key, size_t key_len, zend_resource *r);
405f2279224SAnatol BelskiZEND_API int add_assoc_double_ex(zval *arg, const char *key, size_t key_len, double d);
406f2279224SAnatol BelskiZEND_API int add_assoc_str_ex(zval *arg, const char *key, size_t key_len, zend_string *str);
407f2279224SAnatol BelskiZEND_API int add_assoc_string_ex(zval *arg, const char *key, size_t key_len, char *str);
408f2279224SAnatol BelskiZEND_API int add_assoc_stringl_ex(zval *arg, const char *key, size_t key_len, char *str, size_t length);
409f2279224SAnatol BelskiZEND_API int add_assoc_zval_ex(zval *arg, const char *key, size_t key_len, zval *value);
410f2279224SAnatol Belski
411f2279224SAnatol Belski#define add_assoc_long(__arg, __key, __n) add_assoc_long_ex(__arg, __key, strlen(__key), __n)
412f2279224SAnatol Belski#define add_assoc_null(__arg, __key) add_assoc_null_ex(__arg, __key, strlen(__key))
413f2279224SAnatol Belski#define add_assoc_bool(__arg, __key, __b) add_assoc_bool_ex(__arg, __key, strlen(__key), __b)
414f2279224SAnatol Belski#define add_assoc_resource(__arg, __key, __r) add_assoc_resource_ex(__arg, __key, strlen(__key), __r)
415f2279224SAnatol Belski#define add_assoc_double(__arg, __key, __d) add_assoc_double_ex(__arg, __key, strlen(__key), __d)
416f2279224SAnatol Belski#define add_assoc_str(__arg, __key, __str) add_assoc_str_ex(__arg, __key, strlen(__key), __str)
417f2279224SAnatol Belski#define add_assoc_string(__arg, __key, __str) add_assoc_string_ex(__arg, __key, strlen(__key), __str)
418f2279224SAnatol Belski#define add_assoc_stringl(__arg, __key, __str, __length) add_assoc_stringl_ex(__arg, __key, strlen(__key), __str, __length)
419f2279224SAnatol Belski#define add_assoc_zval(__arg, __key, __value) add_assoc_zval_ex(__arg, __key, strlen(__key), __value)
4206847fefaSThies C. Arntzen
4210611acb9SAndi Gutmans/* unset() functions are only suported for legacy modules and null() functions should be used */
422f2279224SAnatol Belski#define add_assoc_unset(__arg, __key) add_assoc_null_ex(__arg, __key, strlen(__key))
4230611acb9SAndi Gutmans#define add_index_unset(__arg, __key) add_index_null(__arg, __key)
4240611acb9SAndi Gutmans#define add_next_index_unset(__arg) add_next_index_null(__arg)
4250611acb9SAndi Gutmans#define add_property_unset(__arg, __key) add_property_null(__arg, __key)
4260611acb9SAndi Gutmans
427c3e3c98eSAnatol BelskiZEND_API int add_index_long(zval *arg, zend_ulong idx, zend_long n);
428c3e3c98eSAnatol BelskiZEND_API int add_index_null(zval *arg, zend_ulong idx);
429c3e3c98eSAnatol BelskiZEND_API int add_index_bool(zval *arg, zend_ulong idx, int b);
430c3e3c98eSAnatol BelskiZEND_API int add_index_resource(zval *arg, zend_ulong idx, zend_resource *r);
431c3e3c98eSAnatol BelskiZEND_API int add_index_double(zval *arg, zend_ulong idx, double d);
432c3e3c98eSAnatol BelskiZEND_API int add_index_str(zval *arg, zend_ulong idx, zend_string *str);
433c3e3c98eSAnatol BelskiZEND_API int add_index_string(zval *arg, zend_ulong idx, const char *str);
434d6faac2cSAnatol BelskiZEND_API int add_index_stringl(zval *arg, zend_ulong idx, const char *str, size_t length);
435c3e3c98eSAnatol BelskiZEND_API int add_index_zval(zval *arg, zend_ulong index, zval *value);
436c3e3c98eSAnatol Belski
437c3e3c98eSAnatol BelskiZEND_API int add_next_index_long(zval *arg, zend_long n);
4380611acb9SAndi GutmansZEND_API int add_next_index_null(zval *arg);
4396847fefaSThies C. ArntzenZEND_API int add_next_index_bool(zval *arg, int b);
440f4cfaf36SDmitry StogovZEND_API int add_next_index_resource(zval *arg, zend_resource *r);
441573b4602SAndi GutmansZEND_API int add_next_index_double(zval *arg, double d);
442f4cfaf36SDmitry StogovZEND_API int add_next_index_str(zval *arg, zend_string *str);
443050d7e38SDmitry StogovZEND_API int add_next_index_string(zval *arg, const char *str);
444d6faac2cSAnatol BelskiZEND_API int add_next_index_stringl(zval *arg, const char *str, size_t length);
445ef95a346SAndi GutmansZEND_API int add_next_index_zval(zval *arg, zval *value);
446ef95a346SAndi Gutmans
447b204b3abSAnatol BelskiZEND_API zval *add_get_assoc_string_ex(zval *arg, const char *key, uint32_t key_len, const char *str);
448b204b3abSAnatol BelskiZEND_API zval *add_get_assoc_stringl_ex(zval *arg, const char *key, uint32_t key_len, const char *str, size_t length);
449ef95a346SAndi Gutmans
450050d7e38SDmitry Stogov#define add_get_assoc_string(__arg, __key, __str) add_get_assoc_string_ex(__arg, __key, strlen(__key), __str)
451050d7e38SDmitry Stogov#define add_get_assoc_stringl(__arg, __key, __str, __length) add_get_assoc_stringl_ex(__arg, __key, strlen(__key), __str, __length)
452573b4602SAndi Gutmans
453c3e3c98eSAnatol BelskiZEND_API zval *add_get_index_long(zval *arg, zend_ulong idx, zend_long l);
454c3e3c98eSAnatol BelskiZEND_API zval *add_get_index_double(zval *arg, zend_ulong idx, double d);
455c3e3c98eSAnatol BelskiZEND_API zval *add_get_index_str(zval *arg, zend_ulong index, zend_string *str);
456c3e3c98eSAnatol BelskiZEND_API zval *add_get_index_string(zval *arg, zend_ulong idx, const char *str);
457d6faac2cSAnatol BelskiZEND_API zval *add_get_index_stringl(zval *arg, zend_ulong idx, const char *str, size_t length);
458573b4602SAndi Gutmans
459bdeb220fSAnatol BelskiZEND_API int array_set_zval_key(HashTable *ht, zval *key, zval *value);
460fcc6611dSNikita Popov
461bdeb220fSAnatol BelskiZEND_API int add_property_long_ex(zval *arg, const char *key, size_t key_len, zend_long l);
462bdeb220fSAnatol BelskiZEND_API int add_property_null_ex(zval *arg, const char *key, size_t key_len);
463bdeb220fSAnatol BelskiZEND_API int add_property_bool_ex(zval *arg, const char *key, size_t key_len, zend_long b);
464bdeb220fSAnatol BelskiZEND_API int add_property_resource_ex(zval *arg, const char *key, size_t key_len, zend_resource *r);
465bdeb220fSAnatol BelskiZEND_API int add_property_double_ex(zval *arg, const char *key, size_t key_len, double d);
466bdeb220fSAnatol BelskiZEND_API int add_property_str_ex(zval *arg, const char *key, size_t key_len, zend_string *str);
467bdeb220fSAnatol BelskiZEND_API int add_property_string_ex(zval *arg, const char *key, size_t key_len, const char *str);
468bdeb220fSAnatol BelskiZEND_API int add_property_stringl_ex(zval *arg, const char *key, size_t key_len,  const char *str, size_t length);
469bdeb220fSAnatol BelskiZEND_API int add_property_zval_ex(zval *arg, const char *key, size_t key_len, zval *value);
470f2279224SAnatol Belski
471bdeb220fSAnatol Belski#define add_property_long(__arg, __key, __n) add_property_long_ex(__arg, __key, strlen(__key), __n)
472bdeb220fSAnatol Belski#define add_property_null(__arg, __key) add_property_null_ex(__arg, __key, strlen(__key))
473bdeb220fSAnatol Belski#define add_property_bool(__arg, __key, __b) add_property_bool_ex(__arg, __key, strlen(__key), __b)
474bdeb220fSAnatol Belski#define add_property_resource(__arg, __key, __r) add_property_resource_ex(__arg, __key, strlen(__key), __r)
475bdeb220fSAnatol Belski#define add_property_double(__arg, __key, __d) add_property_double_ex(__arg, __key, strlen(__key), __d)
476bdeb220fSAnatol Belski#define add_property_str(__arg, __key, __str) add_property_str_ex(__arg, __key, strlen(__key), __str)
477bdeb220fSAnatol Belski#define add_property_string(__arg, __key, __str) add_property_string_ex(__arg, __key, strlen(__key), __str)
478bdeb220fSAnatol Belski#define add_property_stringl(__arg, __key, __str, __length) add_property_stringl_ex(__arg, __key, strlen(__key), __str, __length)
479bdeb220fSAnatol Belski#define add_property_zval(__arg, __key, __value) add_property_zval_ex(__arg, __key, strlen(__key), __value)
480ef95a346SAndi Gutmans
48192b4013eSZeev Suraski
482f0a2e8ebSDmitry StogovZEND_API int _call_user_function_ex(zval *object, zval *function_name, zval *retval_ptr, uint32_t param_count, zval params[], int no_separation);
483c67c166fSDmitry Stogov
484f0a2e8ebSDmitry Stogov#define call_user_function(function_table, object, function_name, retval_ptr, param_count, params) \
485f0a2e8ebSDmitry Stogov	_call_user_function_ex(object, function_name, retval_ptr, param_count, params, 1)
486c67c166fSDmitry Stogov#define call_user_function_ex(function_table, object, function_name, retval_ptr, param_count, params, no_separation, symbol_table) \
487f0a2e8ebSDmitry Stogov	_call_user_function_ex(object, function_name, retval_ptr, param_count, params, no_separation)
48892b4013eSZeev Suraski
489f87d4530SNuno LopesZEND_API extern const zend_fcall_info empty_fcall_info;
490f87d4530SNuno LopesZEND_API extern const zend_fcall_info_cache empty_fcall_info_cache;
49192b4013eSZeev Suraski
49264c353abSMarcus Boerger/** Build zend_call_info/cache from a zval*
49364c353abSMarcus Boerger *
494a17e4187SJoe Watkins * Caller is responsible to provide a return value (fci->retval), otherwise the we will crash.
49564c353abSMarcus Boerger * In order to pass parameters the following members need to be set:
49664c353abSMarcus Boerger * fci->param_count = 0;
49764c353abSMarcus Boerger * fci->params = NULL;
498b4892511SJani Taskinen * The callable_name argument may be NULL.
499e8a8acdfSMarcus Boerger * Set check_flags to IS_CALLABLE_STRICT for every new usage!
500b4892511SJani Taskinen */
501b204b3abSAnatol BelskiZEND_API int zend_fcall_info_init(zval *callable, uint32_t check_flags, zend_fcall_info *fci, zend_fcall_info_cache *fcc, zend_string **callable_name, char **error);
502b4892511SJani Taskinen
50304145dc2SVeres Lajos/** Clear arguments connected with zend_fcall_info *fci
504b4892511SJani Taskinen * If free_mem is not zero then the params array gets free'd as well
505b4892511SJani Taskinen */
506b4892511SJani TaskinenZEND_API void zend_fcall_info_args_clear(zend_fcall_info *fci, int free_mem);
507b4892511SJani Taskinen
508b4892511SJani Taskinen/** Save current arguments from zend_fcall_info *fci
509b4892511SJani Taskinen * params array will be set to NULL
510b4892511SJani Taskinen */
511f4cfaf36SDmitry StogovZEND_API void zend_fcall_info_args_save(zend_fcall_info *fci, int *param_count, zval **params);
512b4892511SJani Taskinen
513b4892511SJani Taskinen/** Free arguments connected with zend_fcall_info *fci andset back saved ones.
51464c353abSMarcus Boerger */
515f4cfaf36SDmitry StogovZEND_API void zend_fcall_info_args_restore(zend_fcall_info *fci, int param_count, zval *params);
51664c353abSMarcus Boerger
51764c353abSMarcus Boerger/** Set or clear the arguments in the zend_call_info struct taking care of
51864c353abSMarcus Boerger * refcount. If args is NULL and arguments are set then those are cleared.
51964c353abSMarcus Boerger */
520bdeb220fSAnatol BelskiZEND_API int zend_fcall_info_args(zend_fcall_info *fci, zval *args);
521bdeb220fSAnatol BelskiZEND_API int zend_fcall_info_args_ex(zend_fcall_info *fci, zend_function *func, zval *args);
52264c353abSMarcus Boerger
523b4892511SJani Taskinen/** Set arguments in the zend_fcall_info struct taking care of refcount.
524b4892511SJani Taskinen * If argc is 0 the arguments which are set will be cleared, else pass
525b4892511SJani Taskinen * a variable amount of zval** arguments.
526b4892511SJani Taskinen */
527bdeb220fSAnatol BelskiZEND_API int zend_fcall_info_argp(zend_fcall_info *fci, int argc, zval *argv);
528b4892511SJani Taskinen
529b4892511SJani Taskinen/** Set arguments in the zend_fcall_info struct taking care of refcount.
530b4892511SJani Taskinen * If argc is 0 the arguments which are set will be cleared, else pass
531b4892511SJani Taskinen * a variable amount of zval** arguments.
532b4892511SJani Taskinen */
533bdeb220fSAnatol BelskiZEND_API int zend_fcall_info_argv(zend_fcall_info *fci, int argc, va_list *argv);
534b4892511SJani Taskinen
535b4892511SJani Taskinen/** Set arguments in the zend_fcall_info struct taking care of refcount.
536b4892511SJani Taskinen * If argc is 0 the arguments which are set will be cleared, else pass
537b4892511SJani Taskinen * a variable amount of zval** arguments.
538b4892511SJani Taskinen */
539bdeb220fSAnatol BelskiZEND_API int zend_fcall_info_argn(zend_fcall_info *fci, int argc, ...);
540b4892511SJani Taskinen
54164c353abSMarcus Boerger/** Call a function using information created by zend_fcall_info_init()/args().
54204145dc2SVeres Lajos * If args is given then those replace the argument info in fci is temporarily.
54364c353abSMarcus Boerger */
544bdeb220fSAnatol BelskiZEND_API int zend_fcall_info_call(zend_fcall_info *fci, zend_fcall_info_cache *fcc, zval *retval, zval *args);
54564c353abSMarcus Boerger
546bdeb220fSAnatol BelskiZEND_API int zend_call_function(zend_fcall_info *fci, zend_fcall_info_cache *fci_cache);
54792b4013eSZeev Suraski
548cf7384aaSFelipe PenaZEND_API int zend_set_hash_symbol(zval *symbol, const char *name, int name_length, zend_bool is_ref, int num_symbol_tables, ...);
549f962a35dSAndrei Zmievski
550bdeb220fSAnatol BelskiZEND_API int zend_delete_global_variable(zend_string *name);
551453b49edSDmitry Stogov
552bdeb220fSAnatol BelskiZEND_API zend_array *zend_rebuild_symbol_table(void);
553ea2e1bb1SDmitry StogovZEND_API void zend_attach_symbol_table(zend_execute_data *execute_data);
554ea2e1bb1SDmitry StogovZEND_API void zend_detach_symbol_table(zend_execute_data *execute_data);
555bdeb220fSAnatol BelskiZEND_API int zend_set_local_var(zend_string *name, zval *value, int force);
556bdeb220fSAnatol BelskiZEND_API int zend_set_local_var_str(const char *name, size_t len, zval *value, int force);
55791f59403SNikita PopovZEND_API int zend_forbid_dynamic_call(const char *func_name);
5582ecf4bb0SDmitry Stogov
559f4cfaf36SDmitry StogovZEND_API zend_string *zend_find_alias_name(zend_class_entry *ce, zend_string *name);
560f4cfaf36SDmitry StogovZEND_API zend_string *zend_resolve_method_name(zend_class_entry *ce, zend_function *f);
5617dce0194SXinchen Hui
56202be73b5SKalle Sommer NielsenZEND_API const char *zend_get_object_type(const zend_class_entry *ce);
563927d53fdSKalle Sommer Nielsen
56472692e9aSAaron PiotrowskiZEND_API zend_bool zend_is_iterable(zval *iterable);
56572692e9aSAaron Piotrowski
5664f6c95d1SZeev Suraski#define add_method(arg, key, method)	add_assoc_function((arg), (key), (method))
567573b4602SAndi Gutmans
568a35c61afSAndrei ZmievskiZEND_API ZEND_FUNCTION(display_disabled_function);
569a700180fSHarald RadiZEND_API ZEND_FUNCTION(display_disabled_class);
5701727c6a2SHartmut HolzgraefeEND_EXTERN_C()
571a35c61afSAndrei Zmievski
572bcddfd47SThies C. Arntzen#if ZEND_DEBUG
573050d7e38SDmitry Stogov#define CHECK_ZVAL_STRING(str) \
5744a2e40bbSDmitry Stogov	if (ZSTR_VAL(str)[ZSTR_LEN(str)] != '\0') { zend_error(E_WARNING, "String is not zero-terminated (%s)", ZSTR_VAL(str)); }
575050d7e38SDmitry Stogov#define CHECK_ZVAL_STRING_REL(str) \
5764a2e40bbSDmitry Stogov	if (ZSTR_VAL(str)[ZSTR_LEN(str)] != '\0') { zend_error(E_WARNING, "String is not zero-terminated (%s) (source: %s:%d)", ZSTR_VAL(str) ZEND_FILE_LINE_RELAY_CC); }
577bcddfd47SThies C. Arntzen#else
578bcddfd47SThies C. Arntzen#define CHECK_ZVAL_STRING(z)
57943ebb868SZeev Suraski#define CHECK_ZVAL_STRING_REL(z)
580bcddfd47SThies C. Arntzen#endif
581bcddfd47SThies C. Arntzen
582c3e3c98eSAnatol Belski#define CHECK_ZVAL_NULL_PATH(p) (Z_STRLEN_P(p) != strlen(Z_STRVAL_P(p)))
58314331620SDmitry Stogov#define CHECK_NULL_PATH(p, l) (strlen(p) != (size_t)(l))
58432b5f8a1SFelipe Pena
585f4cfaf36SDmitry Stogov#define ZVAL_STRINGL(z, s, l) do {				\
586c3e3c98eSAnatol Belski		ZVAL_NEW_STR(z, zend_string_init(s, l, 0));		\
587453b49edSDmitry Stogov	} while (0)
588bcddfd47SThies C. Arntzen
589f4cfaf36SDmitry Stogov#define ZVAL_STRING(z, s) do {					\
590f4cfaf36SDmitry Stogov		const char *_s = (s);					\
591a0fe8e5aSDmitry Stogov		ZVAL_STRINGL(z, _s, strlen(_s));		\
592453b49edSDmitry Stogov	} while (0)
593bcddfd47SThies C. Arntzen
594f4cfaf36SDmitry Stogov#define ZVAL_EMPTY_STRING(z) do {				\
5954bd22cf1SDmitry Stogov		ZVAL_INTERNED_STR(z, ZSTR_EMPTY_ALLOC());		\
596453b49edSDmitry Stogov	} while (0)
597453b49edSDmitry Stogov
598f4cfaf36SDmitry Stogov#define ZVAL_PSTRINGL(z, s, l) do {				\
599c3e3c98eSAnatol Belski		ZVAL_NEW_STR(z, zend_string_init(s, l, 1));		\
600453b49edSDmitry Stogov	} while (0)
601453b49edSDmitry Stogov
602f4cfaf36SDmitry Stogov#define ZVAL_PSTRING(z, s) do {					\
603f4cfaf36SDmitry Stogov		const char *_s = (s);					\
604a0fe8e5aSDmitry Stogov		ZVAL_PSTRINGL(z, _s, strlen(_s));		\
605f4cfaf36SDmitry Stogov	} while (0)
606f4cfaf36SDmitry Stogov
607f4cfaf36SDmitry Stogov#define ZVAL_EMPTY_PSTRING(z) do {				\
6080e425121SDmitry Stogov		ZVAL_PSTRINGL(z, "", 0);				\
609453b49edSDmitry Stogov	} while (0)
610af22085cSThies C. Arntzen
611d18b9698SNikita Popov#define ZVAL_ZVAL(z, zv, copy, dtor) do {		\
612d18b9698SNikita Popov		zval *__z = (z);						\
613d18b9698SNikita Popov		zval *__zv = (zv);						\
614bfdaf6e8SDmitry Stogov		if (EXPECTED(!Z_ISREF_P(__zv))) {		\
6158e10e8f9SDmitry Stogov			if (copy && !dtor) {				\
6168e10e8f9SDmitry Stogov				ZVAL_COPY(__z, __zv);			\
6178e10e8f9SDmitry Stogov			} else {							\
6188e10e8f9SDmitry Stogov				ZVAL_COPY_VALUE(__z, __zv);		\
6198e10e8f9SDmitry Stogov			}									\
6208e10e8f9SDmitry Stogov		} else {								\
6218e10e8f9SDmitry Stogov			ZVAL_COPY(__z, Z_REFVAL_P(__zv));	\
6228e10e8f9SDmitry Stogov			if (dtor || !copy) {				\
6238e10e8f9SDmitry Stogov				zval_ptr_dtor(__zv);			\
624d90ebc65SDmitry Stogov			}									\
6258e10e8f9SDmitry Stogov		}										\
626d18b9698SNikita Popov	} while (0)
627c7d27ad9SMarcus Boerger
6284f6c95d1SZeev Suraski#define RETVAL_BOOL(b)					ZVAL_BOOL(return_value, b)
629bcddfd47SThies C. Arntzen#define RETVAL_NULL() 					ZVAL_NULL(return_value)
630c3e3c98eSAnatol Belski#define RETVAL_LONG(l) 					ZVAL_LONG(return_value, l)
6314f6c95d1SZeev Suraski#define RETVAL_DOUBLE(d) 				ZVAL_DOUBLE(return_value, d)
632f4cfaf36SDmitry Stogov#define RETVAL_STR(s)			 		ZVAL_STR(return_value, s)
63386336856SDmitry Stogov#define RETVAL_INTERNED_STR(s)	 		ZVAL_INTERNED_STR(return_value, s)
63476cc99feSDmitry Stogov#define RETVAL_NEW_STR(s)		 		ZVAL_NEW_STR(return_value, s)
63586336856SDmitry Stogov#define RETVAL_STR_COPY(s)		 		ZVAL_STR_COPY(return_value, s)
636f4cfaf36SDmitry Stogov#define RETVAL_STRING(s)		 		ZVAL_STRING(return_value, s)
637f4cfaf36SDmitry Stogov#define RETVAL_STRINGL(s, l)		 	ZVAL_STRINGL(return_value, s, l)
638bcddfd47SThies C. Arntzen#define RETVAL_EMPTY_STRING() 			ZVAL_EMPTY_STRING(return_value)
639398256e5SDmitry Stogov#define RETVAL_RES(r)			 		ZVAL_RES(return_value, r)
6401f28da02SJin Hu#define RETVAL_ARR(r)			 		ZVAL_ARR(return_value, r)
6412402d6cbSXinchen Hui#define RETVAL_OBJ(r)			 		ZVAL_OBJ(return_value, r)
642c7d27ad9SMarcus Boerger#define RETVAL_ZVAL(zv, copy, dtor)		ZVAL_ZVAL(return_value, zv, copy, dtor)
643b5b61767SXinchen Hui#define RETVAL_FALSE  					ZVAL_FALSE(return_value)
644b5b61767SXinchen Hui#define RETVAL_TRUE   					ZVAL_TRUE(return_value)
645bcddfd47SThies C. Arntzen
646bcddfd47SThies C. Arntzen#define RETURN_BOOL(b) 					{ RETVAL_BOOL(b); return; }
647bcddfd47SThies C. Arntzen#define RETURN_NULL() 					{ RETVAL_NULL(); return;}
648c3e3c98eSAnatol Belski#define RETURN_LONG(l) 					{ RETVAL_LONG(l); return; }
649bcddfd47SThies C. Arntzen#define RETURN_DOUBLE(d) 				{ RETVAL_DOUBLE(d); return; }
650f4cfaf36SDmitry Stogov#define RETURN_STR(s) 					{ RETVAL_STR(s); return; }
65186336856SDmitry Stogov#define RETURN_INTERNED_STR(s)			{ RETVAL_INTERNED_STR(s); return; }
65276cc99feSDmitry Stogov#define RETURN_NEW_STR(s)				{ RETVAL_NEW_STR(s); return; }
65386336856SDmitry Stogov#define RETURN_STR_COPY(s)				{ RETVAL_STR_COPY(s); return; }
654f4cfaf36SDmitry Stogov#define RETURN_STRING(s) 				{ RETVAL_STRING(s); return; }
655f4cfaf36SDmitry Stogov#define RETURN_STRINGL(s, l) 			{ RETVAL_STRINGL(s, l); return; }
656bcddfd47SThies C. Arntzen#define RETURN_EMPTY_STRING() 			{ RETVAL_EMPTY_STRING(); return; }
657398256e5SDmitry Stogov#define RETURN_RES(r) 					{ RETVAL_RES(r); return; }
6581f28da02SJin Hu#define RETURN_ARR(r) 					{ RETVAL_ARR(r); return; }
6592402d6cbSXinchen Hui#define RETURN_OBJ(r) 					{ RETVAL_OBJ(r); return; }
660c7d27ad9SMarcus Boerger#define RETURN_ZVAL(zv, copy, dtor)		{ RETVAL_ZVAL(zv, copy, dtor); return; }
661bcddfd47SThies C. Arntzen#define RETURN_FALSE  					{ RETVAL_FALSE; return; }
662bcddfd47SThies C. Arntzen#define RETURN_TRUE   					{ RETVAL_TRUE; return; }
6631f985edeSZeev Suraski
664bdeb220fSAnatol Belski#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)))
665068ec75fSXinchen Hui#define ZVAL_IS_NULL(z) (Z_TYPE_P(z) == IS_NULL)
66606a18f16SAndi Gutmans
6678b6f848cSAndi Gutmans/* For compatibility */
6688b6f848cSAndi Gutmans#define ZEND_MINIT			ZEND_MODULE_STARTUP_N
6698b6f848cSAndi Gutmans#define ZEND_MSHUTDOWN		ZEND_MODULE_SHUTDOWN_N
6708b6f848cSAndi Gutmans#define ZEND_RINIT			ZEND_MODULE_ACTIVATE_N
6718b6f848cSAndi Gutmans#define ZEND_RSHUTDOWN		ZEND_MODULE_DEACTIVATE_N
6728b6f848cSAndi Gutmans#define ZEND_MINFO			ZEND_MODULE_INFO_N
673bdeb220fSAnatol Belski#define ZEND_GINIT(module)		((void (*)(void*))(ZEND_MODULE_GLOBALS_CTOR_N(module)))
674bdeb220fSAnatol Belski#define ZEND_GSHUTDOWN(module)	((void (*)(void*))(ZEND_MODULE_GLOBALS_DTOR_N(module)))
6758b6f848cSAndi Gutmans
6768b6f848cSAndi Gutmans#define ZEND_MINIT_FUNCTION			ZEND_MODULE_STARTUP_D
677f5c59863SStanislav Malyshev#define ZEND_MSHUTDOWN_FUNCTION		ZEND_MODULE_SHUTDOWN_D
678f5c59863SStanislav Malyshev#define ZEND_RINIT_FUNCTION			ZEND_MODULE_ACTIVATE_D
679f5c59863SStanislav Malyshev#define ZEND_RSHUTDOWN_FUNCTION		ZEND_MODULE_DEACTIVATE_D
680f5c59863SStanislav Malyshev#define ZEND_MINFO_FUNCTION			ZEND_MODULE_INFO_D
681ada4e506SDmitry Stogov#define ZEND_GINIT_FUNCTION			ZEND_MODULE_GLOBALS_CTOR_D
682ada4e506SDmitry Stogov#define ZEND_GSHUTDOWN_FUNCTION		ZEND_MODULE_GLOBALS_DTOR_D
6838b6f848cSAndi Gutmans
68427f38798SDmitry Stogov/* Fast parameter parsing API */
68527f38798SDmitry Stogov
686d690014bSAndrea Faulds/* Fast ZPP is always enabled now; this define is left in for compatibility
687d690014bSAndrea Faulds * with any existing conditional compilation blocks.
68827f38798SDmitry Stogov */
68927f38798SDmitry Stogov#define FAST_ZPP 1
69027f38798SDmitry Stogov
69127f38798SDmitry Stogov#define Z_EXPECTED_TYPES(_) \
692e5eb9530SAndrea Faulds	_(Z_EXPECTED_LONG,		"integer") \
69327f38798SDmitry Stogov	_(Z_EXPECTED_BOOL,		"boolean") \
69427f38798SDmitry Stogov	_(Z_EXPECTED_STRING,	"string") \
69527f38798SDmitry Stogov	_(Z_EXPECTED_ARRAY,		"array") \
69627f38798SDmitry Stogov	_(Z_EXPECTED_FUNC,		"valid callback") \
69727f38798SDmitry Stogov	_(Z_EXPECTED_RESOURCE,	"resource") \
69827f38798SDmitry Stogov	_(Z_EXPECTED_PATH,		"a valid path") \
69927f38798SDmitry Stogov	_(Z_EXPECTED_OBJECT,	"object") \
700e5eb9530SAndrea Faulds	_(Z_EXPECTED_DOUBLE,	"float")
70127f38798SDmitry Stogov
70227f38798SDmitry Stogov#define Z_EXPECTED_TYPE_ENUM(id, str) id,
70327f38798SDmitry Stogov#define Z_EXPECTED_TYPE_STR(id, str)  str,
70427f38798SDmitry Stogov
70527f38798SDmitry Stogovtypedef enum _zend_expected_type {
70627f38798SDmitry Stogov	Z_EXPECTED_TYPES(Z_EXPECTED_TYPE_ENUM)
70727f38798SDmitry Stogov	Z_EXPECTED_LAST
70827f38798SDmitry Stogov} zend_expected_type;
70927f38798SDmitry Stogov
71052db03b3SSara GolemonZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_parameters_count_error(zend_bool throw_, int num_args, int min_num_args, int max_num_args);
71152db03b3SSara GolemonZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_parameter_type_error(zend_bool throw_, int num, zend_expected_type expected_type, zval *arg);
71252db03b3SSara GolemonZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_parameter_class_error(zend_bool throw_, int num, char *name, zval *arg);
71352db03b3SSara GolemonZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_callback_error(zend_bool throw_, int severity, int num, char *error);
71427f38798SDmitry Stogov
7150ae305e6SDmitry Stogov#define ZPP_ERROR_OK             0
7160ae305e6SDmitry Stogov#define ZPP_ERROR_FAILURE        1
7170ae305e6SDmitry Stogov#define ZPP_ERROR_WRONG_CALLBACK 2
7180ae305e6SDmitry Stogov#define ZPP_ERROR_WRONG_CLASS    3
7190ae305e6SDmitry Stogov#define ZPP_ERROR_WRONG_ARG      4
7200ae305e6SDmitry Stogov#define ZPP_ERROR_WRONG_COUNT    5
7210ae305e6SDmitry Stogov
72227f38798SDmitry Stogov#define ZEND_PARSE_PARAMETERS_START_EX(flags, min_num_args, max_num_args) do { \
72335f9b90bSDmitry Stogov		const int _flags = (flags); \
72427f38798SDmitry Stogov		int _min_num_args = (min_num_args); \
72527f38798SDmitry Stogov		int _max_num_args = (max_num_args); \
72611384ba7SDmitry Stogov		int _num_args = EX_NUM_ARGS(); \
72727f38798SDmitry Stogov		int _i; \
7280ae305e6SDmitry Stogov		zval *_real_arg, *_arg = NULL; \
7290ae305e6SDmitry Stogov		zend_expected_type _expected_type = IS_UNDEF; \
7300ae305e6SDmitry Stogov		char *_error = NULL; \
73127f38798SDmitry Stogov		zend_bool _dummy; \
7320ae305e6SDmitry Stogov		zend_bool _optional = 0; \
7330ae305e6SDmitry Stogov		int error_code = ZPP_ERROR_OK; \
73427f38798SDmitry Stogov		((void)_i); \
73527f38798SDmitry Stogov		((void)_real_arg); \
73627f38798SDmitry Stogov		((void)_arg); \
73727f38798SDmitry Stogov		((void)_expected_type); \
73827f38798SDmitry Stogov		((void)_error); \
73927f38798SDmitry Stogov		((void)_dummy); \
7400ae305e6SDmitry Stogov		((void)_optional); \
7410ae305e6SDmitry Stogov		\
7420ae305e6SDmitry Stogov		do { \
7430ae305e6SDmitry Stogov			if (UNEXPECTED(_num_args < _min_num_args) || \
7440ae305e6SDmitry Stogov			    (UNEXPECTED(_num_args > _max_num_args) && \
7450ae305e6SDmitry Stogov			     EXPECTED(_max_num_args >= 0))) { \
7460ae305e6SDmitry Stogov				if (!(_flags & ZEND_PARSE_PARAMS_QUIET)) { \
74752db03b3SSara Golemon					zend_wrong_parameters_count_error(_flags & ZEND_PARSE_PARAMS_THROW, _num_args, _min_num_args, _max_num_args); \
7480ae305e6SDmitry Stogov				} \
7490ae305e6SDmitry Stogov				error_code = ZPP_ERROR_FAILURE; \
7500ae305e6SDmitry Stogov				break; \
75127f38798SDmitry Stogov			} \
7520ae305e6SDmitry Stogov			_i = 0; \
753bd9a2346SDmitry Stogov			_real_arg = ZEND_CALL_ARG(execute_data, 0);
75427f38798SDmitry Stogov
75527f38798SDmitry Stogov#define ZEND_PARSE_PARAMETERS_START(min_num_args, max_num_args) \
75627f38798SDmitry Stogov	ZEND_PARSE_PARAMETERS_START_EX(0, min_num_args, max_num_args)
75727f38798SDmitry Stogov
75827f38798SDmitry Stogov#define ZEND_PARSE_PARAMETERS_END_EX(failure) \
7590ae305e6SDmitry Stogov		} while (0); \
7600ae305e6SDmitry Stogov		if (UNEXPECTED(error_code != ZPP_ERROR_OK)) { \
76127f38798SDmitry Stogov			if (!(_flags & ZEND_PARSE_PARAMS_QUIET)) { \
7620ae305e6SDmitry Stogov				if (error_code == ZPP_ERROR_WRONG_CALLBACK) { \
76352db03b3SSara Golemon					zend_wrong_callback_error(_flags & ZEND_PARSE_PARAMS_THROW, E_WARNING, _i, _error); \
7640ae305e6SDmitry Stogov				} else if (error_code == ZPP_ERROR_WRONG_CLASS) { \
76552db03b3SSara Golemon					zend_wrong_parameter_class_error(_flags & ZEND_PARSE_PARAMS_THROW, _i, _error, _arg); \
7660ae305e6SDmitry Stogov				} else if (error_code == ZPP_ERROR_WRONG_ARG) { \
76752db03b3SSara Golemon					zend_wrong_parameter_type_error(_flags & ZEND_PARSE_PARAMS_THROW, _i, _expected_type, _arg); \
7680ae305e6SDmitry Stogov				} \
76927f38798SDmitry Stogov			} \
77027f38798SDmitry Stogov			failure; \
77127f38798SDmitry Stogov		} \
77227f38798SDmitry Stogov	} while (0)
77327f38798SDmitry Stogov
77427f38798SDmitry Stogov#define ZEND_PARSE_PARAMETERS_END() \
77527f38798SDmitry Stogov	ZEND_PARSE_PARAMETERS_END_EX(return)
77627f38798SDmitry Stogov
77727f38798SDmitry Stogov#define Z_PARAM_PROLOGUE(separate) \
7780ae305e6SDmitry Stogov	++_i; \
779a861019bSRemi Collet	ZEND_ASSERT(_i <= _min_num_args || _optional==1); \
780a861019bSRemi Collet	ZEND_ASSERT(_i >  _min_num_args || _optional==0); \
7810ae305e6SDmitry Stogov	if (_optional) { \
7820ae305e6SDmitry Stogov		if (UNEXPECTED(_i >_num_args)) break; \
7830ae305e6SDmitry Stogov	} \
78427f38798SDmitry Stogov	_real_arg++; \
78527f38798SDmitry Stogov	_arg = _real_arg; \
78627f38798SDmitry Stogov	ZVAL_DEREF(_arg); \
78727f38798SDmitry Stogov	if (separate) { \
78827f38798SDmitry Stogov		SEPARATE_ZVAL_NOREF(_arg); \
78927f38798SDmitry Stogov	}
79027f38798SDmitry Stogov
79127f38798SDmitry Stogov/* old "|" */
7920ae305e6SDmitry Stogov#define Z_PARAM_OPTIONAL \
7930ae305e6SDmitry Stogov	_optional = 1;
79427f38798SDmitry Stogov
79527f38798SDmitry Stogov/* old "a" */
7960ae305e6SDmitry Stogov#define Z_PARAM_ARRAY_EX(dest, check_null, separate) \
79727f38798SDmitry Stogov		Z_PARAM_PROLOGUE(separate); \
79841e3fdbaSAndrea Faulds		if (UNEXPECTED(!zend_parse_arg_array(_arg, &dest, check_null, 0))) { \
79927f38798SDmitry Stogov			_expected_type = Z_EXPECTED_ARRAY; \
8000ae305e6SDmitry Stogov			error_code = ZPP_ERROR_WRONG_ARG; \
8010ae305e6SDmitry Stogov			break; \
8020ae305e6SDmitry Stogov		}
80327f38798SDmitry Stogov
80427f38798SDmitry Stogov#define Z_PARAM_ARRAY(dest) \
80527f38798SDmitry Stogov	Z_PARAM_ARRAY_EX(dest, 0, 0)
80627f38798SDmitry Stogov
80727f38798SDmitry Stogov/* old "A" */
8080ae305e6SDmitry Stogov#define Z_PARAM_ARRAY_OR_OBJECT_EX(dest, check_null, separate) \
80927f38798SDmitry Stogov		Z_PARAM_PROLOGUE(separate); \
81041e3fdbaSAndrea Faulds		if (UNEXPECTED(!zend_parse_arg_array(_arg, &dest, check_null, 1))) { \
81127f38798SDmitry Stogov			_expected_type = Z_EXPECTED_ARRAY; \
8120ae305e6SDmitry Stogov			error_code = ZPP_ERROR_WRONG_ARG; \
8130ae305e6SDmitry Stogov			break; \
8140ae305e6SDmitry Stogov		}
81527f38798SDmitry Stogov
81627f38798SDmitry Stogov#define Z_PARAM_ARRAY_OR_OBJECT(dest, check_null, separate) \
81727f38798SDmitry Stogov	Z_PARAM_ARRAY_OR_OBJECT_EX(dest, 0, 0)
81827f38798SDmitry Stogov
81927f38798SDmitry Stogov/* old "b" */
8200ae305e6SDmitry Stogov#define Z_PARAM_BOOL_EX(dest, is_null, check_null, separate) \
82127f38798SDmitry Stogov		Z_PARAM_PROLOGUE(separate); \
82235f9b90bSDmitry Stogov		if (UNEXPECTED(!zend_parse_arg_bool(_arg, &dest, &is_null, check_null))) { \
82327f38798SDmitry Stogov			_expected_type = Z_EXPECTED_BOOL; \
8240ae305e6SDmitry Stogov			error_code = ZPP_ERROR_WRONG_ARG; \
8250ae305e6SDmitry Stogov			break; \
8260ae305e6SDmitry Stogov		}
82727f38798SDmitry Stogov
82827f38798SDmitry Stogov#define Z_PARAM_BOOL(dest) \
82927f38798SDmitry Stogov	Z_PARAM_BOOL_EX(dest, _dummy, 0, 0)
83027f38798SDmitry Stogov
83127f38798SDmitry Stogov/* old "C" */
8320ae305e6SDmitry Stogov#define Z_PARAM_CLASS_EX(dest, check_null, separate) \
83327f38798SDmitry Stogov		Z_PARAM_PROLOGUE(separate); \
83435f9b90bSDmitry Stogov		if (UNEXPECTED(!zend_parse_arg_class(_arg, &dest, _i, check_null))) { \
8350ae305e6SDmitry Stogov			error_code = ZPP_ERROR_FAILURE; \
8360ae305e6SDmitry Stogov			break; \
8370ae305e6SDmitry Stogov		}
83827f38798SDmitry Stogov
83927f38798SDmitry Stogov#define Z_PARAM_CLASS(dest) \
84027f38798SDmitry Stogov	Z_PARAM_CLASS_EX(dest, 0, 0)
84127f38798SDmitry Stogov
84227f38798SDmitry Stogov/* old "d" */
8430ae305e6SDmitry Stogov#define Z_PARAM_DOUBLE_EX(dest, is_null, check_null, separate) \
84427f38798SDmitry Stogov		Z_PARAM_PROLOGUE(separate); \
84535f9b90bSDmitry Stogov		if (UNEXPECTED(!zend_parse_arg_double(_arg, &dest, &is_null, check_null))) { \
84627f38798SDmitry Stogov			_expected_type = Z_EXPECTED_DOUBLE; \
8470ae305e6SDmitry Stogov			error_code = ZPP_ERROR_WRONG_ARG; \
8480ae305e6SDmitry Stogov			break; \
8490ae305e6SDmitry Stogov		}
85027f38798SDmitry Stogov
85127f38798SDmitry Stogov#define Z_PARAM_DOUBLE(dest) \
85227f38798SDmitry Stogov	Z_PARAM_DOUBLE_EX(dest, _dummy, 0, 0)
85327f38798SDmitry Stogov
85427f38798SDmitry Stogov/* old "f" */
8550ae305e6SDmitry Stogov#define Z_PARAM_FUNC_EX(dest_fci, dest_fcc, check_null, separate) \
85627f38798SDmitry Stogov		Z_PARAM_PROLOGUE(separate); \
85741e3fdbaSAndrea Faulds		if (UNEXPECTED(!zend_parse_arg_func(_arg, &dest_fci, &dest_fcc, check_null, &_error))) { \
85827f38798SDmitry Stogov			if (!_error) { \
85927f38798SDmitry Stogov				_expected_type = Z_EXPECTED_FUNC; \
8600ae305e6SDmitry Stogov				error_code = ZPP_ERROR_WRONG_ARG; \
8610ae305e6SDmitry Stogov				break; \
86227f38798SDmitry Stogov			} else { \
8630ae305e6SDmitry Stogov				error_code = ZPP_ERROR_WRONG_CALLBACK; \
8640ae305e6SDmitry Stogov				break; \
86527f38798SDmitry Stogov			} \
8660ae305e6SDmitry Stogov		} else if (UNEXPECTED(_error != NULL)) { \
86752db03b3SSara Golemon			zend_wrong_callback_error(_flags & ZEND_PARSE_PARAMS_THROW, E_DEPRECATED, _i, _error); \
8680ae305e6SDmitry Stogov		}
86927f38798SDmitry Stogov
87027f38798SDmitry Stogov#define Z_PARAM_FUNC(dest_fci, dest_fcc) \
87127f38798SDmitry Stogov	Z_PARAM_FUNC_EX(dest_fci, dest_fcc, 0, 0)
87227f38798SDmitry Stogov
87327f38798SDmitry Stogov/* old "h" */
8740ae305e6SDmitry Stogov#define Z_PARAM_ARRAY_HT_EX(dest, check_null, separate) \
87527f38798SDmitry Stogov		Z_PARAM_PROLOGUE(separate); \
87642184397SDmitry Stogov		if (UNEXPECTED(!zend_parse_arg_array_ht(_arg, &dest, check_null, 0, separate))) { \
87727f38798SDmitry Stogov			_expected_type = Z_EXPECTED_ARRAY; \
8780ae305e6SDmitry Stogov			error_code = ZPP_ERROR_WRONG_ARG; \
8790ae305e6SDmitry Stogov			break; \
8800ae305e6SDmitry Stogov		}
88127f38798SDmitry Stogov
88227f38798SDmitry Stogov#define Z_PARAM_ARRAY_HT(dest) \
88327f38798SDmitry Stogov	Z_PARAM_ARRAY_HT_EX(dest, 0, 0)
88427f38798SDmitry Stogov
88527f38798SDmitry Stogov/* old "H" */
8860ae305e6SDmitry Stogov#define Z_PARAM_ARRAY_OR_OBJECT_HT_EX(dest, check_null, separate) \
88727f38798SDmitry Stogov		Z_PARAM_PROLOGUE(separate); \
88842184397SDmitry Stogov		if (UNEXPECTED(!zend_parse_arg_array_ht(_arg, &dest, check_null, 1, separate))) { \
88927f38798SDmitry Stogov			_expected_type = Z_EXPECTED_ARRAY; \
8900ae305e6SDmitry Stogov			error_code = ZPP_ERROR_WRONG_ARG; \
8910ae305e6SDmitry Stogov			break; \
8920ae305e6SDmitry Stogov		}
89327f38798SDmitry Stogov
89427f38798SDmitry Stogov#define Z_PARAM_ARRAY_OR_OBJECT_HT(dest) \
89527f38798SDmitry Stogov	Z_PARAM_ARRAY_OR_OBJECT_HT_EX(dest, 0, 0)
89627f38798SDmitry Stogov
89727f38798SDmitry Stogov/* old "l" */
898c3e3c98eSAnatol Belski#define Z_PARAM_LONG_EX(dest, is_null, check_null, separate) \
89927f38798SDmitry Stogov		Z_PARAM_PROLOGUE(separate); \
90035f9b90bSDmitry Stogov		if