zend_API.h revision d690014b
1573b4602SAndi Gutmans/*
2573b4602SAndi Gutmans   +----------------------------------------------------------------------+
3573b4602SAndi Gutmans   | Zend Engine                                                          |
4573b4602SAndi Gutmans   +----------------------------------------------------------------------+
597a9470dSXinchen Hui   | Copyright (c) 1998-2016 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;
46feb85801SDmitry Stogov	HashTable *function_table;
47f4cfaf36SDmitry Stogov	zval function_name;
48aa5f5530SDmitry Stogov	zend_array *symbol_table;
49f4cfaf36SDmitry Stogov	zval *retval;
50f4cfaf36SDmitry Stogov	zval *params;
51ea85451bSDmitry Stogov	zend_object *object;
52feb85801SDmitry Stogov	zend_bool no_separation;
535d5a7020SAnatol Belski	uint32_t param_count;
54feb85801SDmitry Stogov} zend_fcall_info;
55feb85801SDmitry Stogov
56feb85801SDmitry Stogovtypedef struct _zend_fcall_info_cache {
57feb85801SDmitry Stogov	zend_bool initialized;
58feb85801SDmitry Stogov	zend_function *function_handler;
59feb85801SDmitry Stogov	zend_class_entry *calling_scope;
60feb85801SDmitry Stogov	zend_class_entry *called_scope;
61ea85451bSDmitry Stogov	zend_object *object;
62feb85801SDmitry Stogov} zend_fcall_info_cache;
63feb85801SDmitry Stogov
6486b36438SJelle Zijlstra#define ZEND_NS_NAME(ns, name)			ns "\\" name
65907fa665SDmitry Stogov
66f8bbafd6SZeev Suraski#define ZEND_FN(name) zif_##name
67637a4042SMarcus Boerger#define ZEND_MN(name) zim_##name
68f8bbafd6SZeev Suraski#define ZEND_NAMED_FUNCTION(name)		void name(INTERNAL_FUNCTION_PARAMETERS)
69f8bbafd6SZeev Suraski#define ZEND_FUNCTION(name)				ZEND_NAMED_FUNCTION(ZEND_FN(name))
70637a4042SMarcus Boerger#define ZEND_METHOD(classname, name)	ZEND_NAMED_FUNCTION(ZEND_MN(classname##_##name))
71f8bbafd6SZeev Suraski
727c2a0157SBob 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 },
731c2512ddSMarcus Boerger
747c2a0157SBob 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 },
751e19ee87SHannes Magnusson#define ZEND_RAW_NAMED_FE(zend_name, name, arg_info) ZEND_RAW_FENTRY(#zend_name, name, arg_info, 0)
761e19ee87SHannes Magnusson
771c2512ddSMarcus Boerger#define ZEND_NAMED_FE(zend_name, name, arg_info)	ZEND_FENTRY(zend_name, name, arg_info, 0)
781c2512ddSMarcus Boerger#define ZEND_FE(name, arg_info)						ZEND_FENTRY(name, ZEND_FN(name), arg_info, 0)
79941b0651SMarcus Boerger#define ZEND_DEP_FE(name, arg_info)                 ZEND_FENTRY(name, ZEND_FN(name), arg_info, ZEND_ACC_DEPRECATED)
80cec053f7SMarcus Boerger#define ZEND_FALIAS(name, alias, arg_info)			ZEND_FENTRY(name, ZEND_FN(alias), arg_info, 0)
81941b0651SMarcus Boerger#define ZEND_DEP_FALIAS(name, alias, arg_info)		ZEND_FENTRY(name, ZEND_FN(alias), arg_info, ZEND_ACC_DEPRECATED)
82637a4042SMarcus Boerger#define ZEND_NAMED_ME(zend_name, name, arg_info, flags)	ZEND_FENTRY(zend_name, name, arg_info, flags)
83637a4042SMarcus Boerger#define ZEND_ME(classname, name, arg_info, flags)	ZEND_FENTRY(name, ZEND_MN(classname##_##name), arg_info, flags)
841c2512ddSMarcus Boerger#define ZEND_ABSTRACT_ME(classname, name, arg_info)	ZEND_FENTRY(name, NULL, arg_info, ZEND_ACC_PUBLIC|ZEND_ACC_ABSTRACT)
8533cdc9edSMarcus Boerger#define ZEND_MALIAS(classname, name, alias, arg_info, flags) \
86637a4042SMarcus Boerger                                                    ZEND_FENTRY(name, ZEND_MN(classname##_##alias), arg_info, flags)
87637a4042SMarcus Boerger#define ZEND_ME_MAPPING(name, func_name, arg_types, flags) ZEND_NAMED_ME(name, ZEND_FN(func_name), arg_types, flags)
88f8bbafd6SZeev Suraski
89907fa665SDmitry 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)
90907fa665SDmitry Stogov
91907fa665SDmitry 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)
92907fa665SDmitry Stogov#define ZEND_NS_RAW_NAMED_FE(ns, zend_name, name, arg_info)			ZEND_NS_RAW_FENTRY(ns, #zend_name, name, arg_info, 0)
93907fa665SDmitry Stogov
942d5695cbSSara Golemon#define ZEND_NS_NAMED_FE(ns, zend_name, name, arg_info)	ZEND_NS_FENTRY(ns, zend_name, name, arg_info, 0)
95907fa665SDmitry Stogov#define ZEND_NS_FE(ns, name, arg_info)					ZEND_NS_FENTRY(ns, name, ZEND_FN(name), arg_info, 0)
96907fa665SDmitry Stogov#define ZEND_NS_DEP_FE(ns, name, arg_info)				ZEND_NS_FENTRY(ns, name, ZEND_FN(name), arg_info, ZEND_ACC_DEPRECATED)
97907fa665SDmitry Stogov#define ZEND_NS_FALIAS(ns, name, alias, arg_info)		ZEND_NS_FENTRY(ns, name, ZEND_FN(alias), arg_info, 0)
98907fa665SDmitry Stogov#define ZEND_NS_DEP_FALIAS(ns, name, alias, arg_info)	ZEND_NS_FENTRY(ns, name, ZEND_FN(alias), arg_info, ZEND_ACC_DEPRECATED)
99907fa665SDmitry Stogov
100f1f2a649SFelipe Pena#define ZEND_FE_END            { NULL, NULL, NULL, 0, 0 }
101f1f2a649SFelipe Pena
102bb050453SRouven Weßling#define ZEND_ARG_INFO(pass_by_ref, name)                             { #name, NULL, 0, pass_by_ref, 0, 0 },
103bb050453SRouven Weßling#define ZEND_ARG_PASS_INFO(pass_by_ref)                              { NULL,  NULL, 0, pass_by_ref, 0, 0 },
1045dd427eaSDmitry Stogov#define ZEND_ARG_OBJ_INFO(pass_by_ref, name, classname, allow_null)  { #name, #classname, IS_OBJECT, pass_by_ref, allow_null, 0 },
1055dd427eaSDmitry Stogov#define ZEND_ARG_ARRAY_INFO(pass_by_ref, name, allow_null)           { #name, NULL, IS_ARRAY, pass_by_ref, allow_null, 0 },
106bb050453SRouven Weßling#define ZEND_ARG_CALLABLE_INFO(pass_by_ref, name, allow_null)        { #name, NULL, IS_CALLABLE, pass_by_ref, allow_null, 0 },
1075dd427eaSDmitry Stogov#define ZEND_ARG_TYPE_INFO(pass_by_ref, name, type_hint, allow_null) { #name, NULL, type_hint, pass_by_ref, allow_null, 0 },
108bb050453SRouven Weßling#define ZEND_ARG_VARIADIC_INFO(pass_by_ref, name)                    { #name, NULL, 0, pass_by_ref, 0, 1 },
1090d7a6388SNikita Popov
110bff4c47fSReeze Xia
111bff4c47fSReeze Xia#define ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(name, return_reference, required_num_args, type, class_name, allow_null) \
112a3379d66SXinchen Hui	static const zend_internal_arg_info name[] = { \
113a3379d66SXinchen Hui	   	{ (const char*)(zend_uintptr_t)(required_num_args), class_name, type, return_reference, allow_null, 0 },
114bff4c47fSReeze Xia#define ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO(name, type, class_name, allow_null) \
115bff4c47fSReeze Xia	ZEND_BEGIN_ARG_WITH_RETURN_TYPE_INFO_EX(name, 0, -1, type, class_name, allow_null)
116bff4c47fSReeze Xia
1170d7a6388SNikita Popov#define ZEND_BEGIN_ARG_INFO_EX(name, _unused, return_reference, required_num_args)	\
118a3379d66SXinchen Hui	static const zend_internal_arg_info name[] = { \
1195dd427eaSDmitry Stogov		{ (const char*)(zend_uintptr_t)(required_num_args), NULL, 0, return_reference, 0, 0 },
1200d7a6388SNikita Popov#define ZEND_BEGIN_ARG_INFO(name, _unused)	\
1210d7a6388SNikita Popov	ZEND_BEGIN_ARG_INFO_EX(name, 0, ZEND_RETURN_VALUE, -1)
122f8bbafd6SZeev Suraski#define ZEND_END_ARG_INFO()		};
123342c6e0bSZeev Suraski
1248b6f848cSAndi Gutmans/* Name macros */
1258b6f848cSAndi Gutmans#define ZEND_MODULE_STARTUP_N(module)       zm_startup_##module
1268b6f848cSAndi Gutmans#define ZEND_MODULE_SHUTDOWN_N(module)		zm_shutdown_##module
1278b6f848cSAndi Gutmans#define ZEND_MODULE_ACTIVATE_N(module)		zm_activate_##module
1288b6f848cSAndi Gutmans#define ZEND_MODULE_DEACTIVATE_N(module)	zm_deactivate_##module
1296535933fSDerick Rethans#define ZEND_MODULE_POST_ZEND_DEACTIVATE_N(module)	zm_post_zend_deactivate_##module
1308b6f848cSAndi Gutmans#define ZEND_MODULE_INFO_N(module)			zm_info_##module
131ada4e506SDmitry Stogov#define ZEND_MODULE_GLOBALS_CTOR_N(module)  zm_globals_ctor_##module
132ada4e506SDmitry Stogov#define ZEND_MODULE_GLOBALS_DTOR_N(module)  zm_globals_dtor_##module
133342c6e0bSZeev Suraski
1348b6f848cSAndi Gutmans/* Declaration macros */
1358b6f848cSAndi Gutmans#define ZEND_MODULE_STARTUP_D(module)		int ZEND_MODULE_STARTUP_N(module)(INIT_FUNC_ARGS)
1368b6f848cSAndi Gutmans#define ZEND_MODULE_SHUTDOWN_D(module)		int ZEND_MODULE_SHUTDOWN_N(module)(SHUTDOWN_FUNC_ARGS)
1378b6f848cSAndi Gutmans#define ZEND_MODULE_ACTIVATE_D(module)		int ZEND_MODULE_ACTIVATE_N(module)(INIT_FUNC_ARGS)
1388b6f848cSAndi Gutmans#define ZEND_MODULE_DEACTIVATE_D(module)	int ZEND_MODULE_DEACTIVATE_N(module)(SHUTDOWN_FUNC_ARGS)
1396535933fSDerick Rethans#define ZEND_MODULE_POST_ZEND_DEACTIVATE_D(module)	int ZEND_MODULE_POST_ZEND_DEACTIVATE_N(module)(void)
1408b6f848cSAndi Gutmans#define ZEND_MODULE_INFO_D(module)			void ZEND_MODULE_INFO_N(module)(ZEND_MODULE_INFO_FUNC_ARGS)
141bdeb220fSAnatol Belski#define ZEND_MODULE_GLOBALS_CTOR_D(module)  void ZEND_MODULE_GLOBALS_CTOR_N(module)(zend_##module##_globals *module##_globals)
142bdeb220fSAnatol Belski#define ZEND_MODULE_GLOBALS_DTOR_D(module)  void ZEND_MODULE_GLOBALS_DTOR_N(module)(zend_##module##_globals *module##_globals)
143342c6e0bSZeev Suraski
1440b6d923bSSascha Schumann#define ZEND_GET_MODULE(name) \
145cb71ac03SHartmut Holzgraefe    BEGIN_EXTERN_C()\
146cb71ac03SHartmut Holzgraefe	ZEND_DLEXPORT zend_module_entry *get_module(void) { return &name##_module_entry; }\
147cb71ac03SHartmut Holzgraefe    END_EXTERN_C()
1480d21940dSZeev Suraski
1490d21940dSZeev Suraski#define ZEND_BEGIN_MODULE_GLOBALS(module_name)		\
1500d21940dSZeev Suraski	typedef struct _zend_##module_name##_globals {
1510d21940dSZeev Suraski#define ZEND_END_MODULE_GLOBALS(module_name)		\
1520d21940dSZeev Suraski	} zend_##module_name##_globals;
1530d21940dSZeev Suraski
1540d21940dSZeev Suraski#ifdef ZTS
1550d21940dSZeev Suraski
1560d21940dSZeev Suraski#define ZEND_DECLARE_MODULE_GLOBALS(module_name)							\
15702af513cSAndi Gutmans	ts_rsrc_id module_name##_globals_id;
15802af513cSAndi Gutmans#define ZEND_EXTERN_MODULE_GLOBALS(module_name)								\
15902af513cSAndi Gutmans	extern ts_rsrc_id module_name##_globals_id;
1600d21940dSZeev Suraski#define ZEND_INIT_MODULE_GLOBALS(module_name, globals_ctor, globals_dtor)	\
1612c254ba7SZeev Suraski	ts_allocate_id(&module_name##_globals_id, sizeof(zend_##module_name##_globals), (ts_allocate_ctor) globals_ctor, (ts_allocate_dtor) globals_dtor);
16243cdfd9aSAnatol Belski#define ZEND_MODULE_GLOBALS_ACCESSOR(module_name, v) ZEND_TSRMG(module_name##_globals_id, zend_##module_name##_globals *, v)
163ffa341deSAnatol Belski#define ZEND_MODULE_GLOBALS_BULK(module_name) TSRMG_BULK(module_name##_globals_id, zend_##module_name##_globals *)
1640d21940dSZeev Suraski
1650d21940dSZeev Suraski#else
1660d21940dSZeev Suraski
1670d21940dSZeev Suraski#define ZEND_DECLARE_MODULE_GLOBALS(module_name)							\
16802af513cSAndi Gutmans	zend_##module_name##_globals module_name##_globals;
16902af513cSAndi Gutmans#define ZEND_EXTERN_MODULE_GLOBALS(module_name)								\
17002af513cSAndi Gutmans	extern zend_##module_name##_globals module_name##_globals;
1710d21940dSZeev Suraski#define ZEND_INIT_MODULE_GLOBALS(module_name, globals_ctor, globals_dtor)	\
1720d21940dSZeev Suraski	globals_ctor(&module_name##_globals);
17343cdfd9aSAnatol Belski#define ZEND_MODULE_GLOBALS_ACCESSOR(module_name, v) (module_name##_globals.v)
174ffa341deSAnatol Belski#define ZEND_MODULE_GLOBALS_BULK(module_name) (&module_name##_globals)
1750d21940dSZeev Suraski
1760d21940dSZeev Suraski#endif
1770d21940dSZeev Suraski
178b4892511SJani Taskinen#define INIT_CLASS_ENTRY(class_container, class_name, functions) \
179b4892511SJani Taskinen	INIT_OVERLOADED_CLASS_ENTRY(class_container, class_name, functions, NULL, NULL, NULL)
180741b8161SZeev Suraski
181b4892511SJani Taskinen#define INIT_CLASS_ENTRY_EX(class_container, class_name, class_name_len, functions) \
182b4892511SJani Taskinen	INIT_OVERLOADED_CLASS_ENTRY_EX(class_container, class_name, class_name_len, functions, NULL, NULL, NULL, NULL, NULL)
183b4892511SJani Taskinen
184b4892511SJani 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) \
185741b8161SZeev Suraski	{															\
186f4cfaf36SDmitry Stogov		zend_string *cl_name;									\
187c3e3c98eSAnatol Belski		cl_name = zend_string_init(class_name, class_name_len, 1);		\
188bdeb220fSAnatol Belski		class_container.name = zend_new_interned_string(cl_name);	\
18903a1fcabSXinchen Hui		INIT_CLASS_ENTRY_INIT_METHODS(class_container, functions, handle_fcall, handle_propget, handle_propset, handle_propunset, handle_propisset) \
19003a1fcabSXinchen Hui	}
19103a1fcabSXinchen Hui
19203a1fcabSXinchen Hui#define INIT_CLASS_ENTRY_INIT_METHODS(class_container, functions, handle_fcall, handle_propget, handle_propset, handle_propunset, handle_propisset) \
19303a1fcabSXinchen Hui	{															\
1942eccd95cSAndi Gutmans		class_container.constructor = NULL;						\
19573b159e0SAndi Gutmans		class_container.destructor = NULL;						\
19629ea3da2SAndi Gutmans		class_container.clone = NULL;							\
197637a4042SMarcus Boerger		class_container.serialize = NULL;						\
198637a4042SMarcus Boerger		class_container.unserialize = NULL;						\
199637a4042SMarcus Boerger		class_container.create_object = NULL;					\
2003c62b3b5SMarcus Boerger		class_container.interface_gets_implemented = NULL;		\
20172d0454bSDmitry Stogov		class_container.get_static_method = NULL;				\
202637a4042SMarcus Boerger		class_container.__call = handle_fcall;					\
203b4892511SJani Taskinen		class_container.__callstatic = NULL;					\
204637a4042SMarcus Boerger		class_container.__tostring = NULL;						\
205637a4042SMarcus Boerger		class_container.__get = handle_propget;					\
206637a4042SMarcus Boerger		class_container.__set = handle_propset;					\
207637a4042SMarcus Boerger		class_container.__unset = handle_propunset;				\
208637a4042SMarcus Boerger		class_container.__isset = handle_propisset;				\
2091e752ce9SSara Golemon		class_container.__debugInfo = NULL;					\
210637a4042SMarcus Boerger		class_container.serialize_func = NULL;					\
211637a4042SMarcus Boerger		class_container.unserialize_func = NULL;				\
212637a4042SMarcus Boerger		class_container.serialize = NULL;						\
213637a4042SMarcus Boerger		class_container.unserialize = NULL;						\
214637a4042SMarcus Boerger		class_container.parent = NULL;							\
215637a4042SMarcus Boerger		class_container.num_interfaces = 0;						\
216fdb6077fSFelipe Pena		class_container.traits = NULL;							\
217fdb6077fSFelipe Pena		class_container.num_traits = 0;							\
218fdb6077fSFelipe Pena		class_container.trait_aliases = NULL;					\
219fdb6077fSFelipe Pena		class_container.trait_precedences = NULL;				\
220637a4042SMarcus Boerger		class_container.interfaces = NULL;						\
221637a4042SMarcus Boerger		class_container.get_iterator = NULL;					\
222637a4042SMarcus Boerger		class_container.iterator_funcs.funcs = NULL;			\
223f2df6a4aSDmitry Stogov		class_container.info.internal.module = NULL;			\
224f2df6a4aSDmitry Stogov		class_container.info.internal.builtin_functions = functions;	\
225741b8161SZeev Suraski	}
226741b8161SZeev Suraski
227345e0255SDmitry Stogov#define INIT_OVERLOADED_CLASS_ENTRY(class_container, class_name, functions, handle_fcall, handle_propget, handle_propset) \
228b4892511SJani Taskinen	INIT_OVERLOADED_CLASS_ENTRY_EX(class_container, class_name, sizeof(class_name)-1, functions, handle_fcall, handle_propget, handle_propset, NULL, NULL)
229345e0255SDmitry Stogov
230907fa665SDmitry Stogov#define INIT_NS_CLASS_ENTRY(class_container, ns, class_name, functions) \
231907fa665SDmitry Stogov	INIT_CLASS_ENTRY(class_container, ZEND_NS_NAME(ns, class_name), functions)
232907fa665SDmitry Stogov#define INIT_OVERLOADED_NS_CLASS_ENTRY_EX(class_container, ns, class_name, functions, handle_fcall, handle_propget, handle_propset, handle_propunset, handle_propisset) \
233907fa665SDmitry 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)
234907fa665SDmitry Stogov#define INIT_OVERLOADED_NS_CLASS_ENTRY(class_container, ns, class_name, functions, handle_fcall, handle_propget, handle_propset) \
235907fa665SDmitry Stogov	INIT_OVERLOADED_CLASS_ENTRY(class_container, ZEND_NS_NAME(ns, class_name), functions, handle_fcall, handle_propget, handle_propset)
236907fa665SDmitry Stogov
2378768ab94SDmitry Stogov#ifdef ZTS
238f23e8576SDmitry 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])
2398768ab94SDmitry Stogov#else
240c5237d82SDmitry Stogov#	define CE_STATIC_MEMBERS(ce) ((ce)->static_members_table)
2418768ab94SDmitry Stogov#endif
2428768ab94SDmitry Stogov
243b4892511SJani Taskinen#define ZEND_FCI_INITIALIZED(fci) ((fci).size != 0)
244b4892511SJani Taskinen
245c96a6b44SAnatol BelskiZEND_API int zend_next_free_module(void);
246573b4602SAndi Gutmans
2471727c6a2SHartmut HolzgraefeBEGIN_EXTERN_C()
248f77e6a44SZeev SuraskiZEND_API int zend_get_parameters(int ht, int param_count, ...);
249e59bfcffSStanislav MalyshevZEND_API ZEND_ATTRIBUTE_DEPRECATED int zend_get_parameters_ex(int param_count, ...);
250bdeb220fSAnatol BelskiZEND_API int _zend_get_parameters_array_ex(int param_count, zval *argument_array);
25111e5d2f2SZeev Suraski
252e39f3f3fSMarcus Boerger/* internal function to efficiently copy parameters when executing __call() */
253bdeb220fSAnatol BelskiZEND_API int zend_copy_parameters_array(int param_count, zval *argument_array);
254e39f3f3fSMarcus Boerger
25595dbe1d0SBob Weinand#define zend_get_parameters_array(ht, param_count, argument_array) \
256bdeb220fSAnatol Belski	_zend_get_parameters_array_ex(param_count, argument_array)
25795dbe1d0SBob Weinand#define zend_get_parameters_array_ex(param_count, argument_array) \
258bdeb220fSAnatol Belski	_zend_get_parameters_array_ex(param_count, argument_array)
25995dbe1d0SBob Weinand#define zend_parse_parameters_none() \
26095dbe1d0SBob Weinand	(EXPECTED(ZEND_NUM_ARGS() == 0) ? SUCCESS : zend_parse_parameters(ZEND_NUM_ARGS(), ""))
26158f88057SAndrei Zmievski
26258f88057SAndrei Zmievski/* Parameter parsing API -- andrei */
26358f88057SAndrei Zmievski
26435f9b90bSDmitry Stogov#define ZEND_PARSE_PARAMS_QUIET (1<<1)
265122d7596SNikita Popov#define ZEND_PARSE_PARAMS_THROW (1<<2)
266bdeb220fSAnatol BelskiZEND_API int zend_parse_parameters(int num_args, const char *type_spec, ...);
267bdeb220fSAnatol BelskiZEND_API int zend_parse_parameters_ex(int flags, int num_args, const char *type_spec, ...);
268122d7596SNikita PopovZEND_API int zend_parse_parameters_throw(int num_args, const char *type_spec, ...);
269cf7384aaSFelipe PenaZEND_API char *zend_zval_type_name(const zval *arg);
27058f88057SAndrei Zmievski
271bdeb220fSAnatol BelskiZEND_API int zend_parse_method_parameters(int num_args, zval *this_ptr, const char *type_spec, ...);
272bdeb220fSAnatol BelskiZEND_API int zend_parse_method_parameters_ex(int flags, int num_args, zval *this_ptr, const char *type_spec, ...);
273c4528f82SHarald Radi
274bdeb220fSAnatol BelskiZEND_API int zend_parse_parameter(int flags, int arg_num, zval *arg, const char *spec, ...);
27513f1d53bSGustavo André dos Santos Lopes
276b5255495SZeev Suraski/* End of parameter parsing API -- andrei */
27739f9487eSAndi Gutmans
278bdeb220fSAnatol BelskiZEND_API int zend_register_functions(zend_class_entry *scope, const zend_function_entry *functions, HashTable *function_table, int type);
279bdeb220fSAnatol BelskiZEND_API void zend_unregister_functions(const zend_function_entry *functions, int count, HashTable *function_table);
280bdeb220fSAnatol BelskiZEND_API int zend_startup_module(zend_module_entry *module_entry);
281bdeb220fSAnatol BelskiZEND_API zend_module_entry* zend_register_internal_module(zend_module_entry *module_entry);
282bdeb220fSAnatol BelskiZEND_API zend_module_entry* zend_register_module_ex(zend_module_entry *module);
283bdeb220fSAnatol BelskiZEND_API int zend_startup_module_ex(zend_module_entry *module);
284bdeb220fSAnatol BelskiZEND_API int zend_startup_modules(void);
285bdeb220fSAnatol BelskiZEND_API void zend_collect_module_handlers(void);
2861a1178a6SDmitry StogovZEND_API void zend_destroy_modules(void);
287bdeb220fSAnatol BelskiZEND_API void zend_check_magic_method_implementation(const zend_class_entry *ce, const zend_function *fptr, int error_type);
288eb0e6946SAndi Gutmans
289bdeb220fSAnatol BelskiZEND_API zend_class_entry *zend_register_internal_class(zend_class_entry *class_entry);
290bdeb220fSAnatol BelskiZEND_API zend_class_entry *zend_register_internal_class_ex(zend_class_entry *class_entry, zend_class_entry *parent_ce);
291bdeb220fSAnatol BelskiZEND_API zend_class_entry *zend_register_internal_interface(zend_class_entry *orig_class_entry);
292bdeb220fSAnatol BelskiZEND_API void zend_class_implements(zend_class_entry *class_entry, int num_interfaces, ...);
293eb0e6946SAndi Gutmans
294bdeb220fSAnatol BelskiZEND_API int zend_register_class_alias_ex(const char *name, size_t name_len, zend_class_entry *ce);
295907fa665SDmitry Stogov
296907fa665SDmitry Stogov#define zend_register_class_alias(name, ce) \
297bdeb220fSAnatol Belski	zend_register_class_alias_ex(name, sizeof(name)-1, ce)
298907fa665SDmitry Stogov#define zend_register_ns_class_alias(ns, name, ce) \
299bdeb220fSAnatol Belski	zend_register_class_alias_ex(ZEND_NS_NAME(ns, name), sizeof(ZEND_NS_NAME(ns, name))-1, ce)
300907fa665SDmitry Stogov
301bdeb220fSAnatol BelskiZEND_API int zend_disable_function(char *function_name, size_t function_name_length);
302bdeb220fSAnatol BelskiZEND_API int zend_disable_class(char *class_name, size_t class_name_length);
303573b4602SAndi Gutmans
30471af54e5SDmitry StogovZEND_API ZEND_COLD void zend_wrong_param_count(void);
305c81db6bcSDmitry Stogov
306c81db6bcSDmitry Stogov#define IS_CALLABLE_CHECK_SYNTAX_ONLY (1<<0)
307c81db6bcSDmitry Stogov#define IS_CALLABLE_CHECK_NO_ACCESS   (1<<1)
30853e52606SMarcus Boerger#define IS_CALLABLE_CHECK_IS_STATIC   (1<<2)
309af05ce0aSDmitry Stogov#define IS_CALLABLE_CHECK_SILENT      (1<<3)
310c81db6bcSDmitry Stogov
3110cd997d7SMarcus Boerger#define IS_CALLABLE_STRICT  (IS_CALLABLE_CHECK_IS_STATIC)
3120cd997d7SMarcus Boerger
313bdeb220fSAnatol BelskiZEND_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);
314bdeb220fSAnatol BelskiZEND_API zend_bool zend_is_callable(zval *callable, uint check_flags, zend_string **callable_name);
315bdeb220fSAnatol BelskiZEND_API zend_bool zend_make_callable(zval *callable, zend_string **callable_name);
3166c810b0dSDmitry StogovZEND_API const char *zend_get_module_version(const char *module_name);
317cf7384aaSFelipe PenaZEND_API int zend_get_module_started(const char *module_name);
318bdeb220fSAnatol BelskiZEND_API int zend_declare_property_ex(zend_class_entry *ce, zend_string *name, zval *property, int access_type, zend_string *doc_comment);
319bdeb220fSAnatol BelskiZEND_API int zend_declare_property(zend_class_entry *ce, const char *name, size_t name_length, zval *property, int access_type);
320bdeb220fSAnatol BelskiZEND_API int zend_declare_property_null(zend_class_entry *ce, const char *name, size_t name_length, int access_type);
321bdeb220fSAnatol BelskiZEND_API int zend_declare_property_bool(zend_class_entry *ce, const char *name, size_t name_length, zend_long value, int access_type);
322bdeb220fSAnatol BelskiZEND_API int zend_declare_property_long(zend_class_entry *ce, const char *name, size_t name_length, zend_long value, int access_type);
323bdeb220fSAnatol BelskiZEND_API int zend_declare_property_double(zend_class_entry *ce, const char *name, size_t name_length, double value, int access_type);
324bdeb220fSAnatol BelskiZEND_API int zend_declare_property_string(zend_class_entry *ce, const char *name, size_t name_length, const char *value, int access_type);
325bdeb220fSAnatol 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);
326bdeb220fSAnatol Belski
327bdeb220fSAnatol BelskiZEND_API int zend_declare_class_constant(zend_class_entry *ce, const char *name, size_t name_length, zval *value);
328bdeb220fSAnatol BelskiZEND_API int zend_declare_class_constant_null(zend_class_entry *ce, const char *name, size_t name_length);
329bdeb220fSAnatol BelskiZEND_API int zend_declare_class_constant_long(zend_class_entry *ce, const char *name, size_t name_length, zend_long value);
330bdeb220fSAnatol BelskiZEND_API int zend_declare_class_constant_bool(zend_class_entry *ce, const char *name, size_t name_length, zend_bool value);
331bdeb220fSAnatol BelskiZEND_API int zend_declare_class_constant_double(zend_class_entry *ce, const char *name, size_t name_length, double value);
332bdeb220fSAnatol 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);
333bdeb220fSAnatol BelskiZEND_API int zend_declare_class_constant_string(zend_class_entry *ce, const char *name, size_t name_length, const char *value);
334bdeb220fSAnatol Belski
335ea09a9faSDmitry StogovZEND_API int zend_update_class_constants(zend_class_entry *class_type);
336ea09a9faSDmitry Stogov
33770c86732SDmitry StogovZEND_API void zend_update_property_ex(zend_class_entry *scope, zval *object, zend_string *name, zval *value);
338bdeb220fSAnatol BelskiZEND_API void zend_update_property(zend_class_entry *scope, zval *object, const char *name, size_t name_length, zval *value);
339bdeb220fSAnatol BelskiZEND_API void zend_update_property_null(zend_class_entry *scope, zval *object, const char *name, size_t name_length);
340bdeb220fSAnatol BelskiZEND_API void zend_update_property_bool(zend_class_entry *scope, zval *object, const char *name, size_t name_length, zend_long value);
341bdeb220fSAnatol BelskiZEND_API void zend_update_property_long(zend_class_entry *scope, zval *object, const char *name, size_t name_length, zend_long value);
342bdeb220fSAnatol BelskiZEND_API void zend_update_property_double(zend_class_entry *scope, zval *object, const char *name, size_t name_length, double value);
343bdeb220fSAnatol BelskiZEND_API void zend_update_property_str(zend_class_entry *scope, zval *object, const char *name, size_t name_length, zend_string *value);
344bdeb220fSAnatol BelskiZEND_API void zend_update_property_string(zend_class_entry *scope, zval *object, const char *name, size_t name_length, const char *value);
345bdeb220fSAnatol 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);
346bdeb220fSAnatol Belski
347bdeb220fSAnatol BelskiZEND_API int zend_update_static_property(zend_class_entry *scope, const char *name, size_t name_length, zval *value);
348bdeb220fSAnatol BelskiZEND_API int zend_update_static_property_null(zend_class_entry *scope, const char *name, size_t name_length);
349bdeb220fSAnatol BelskiZEND_API int zend_update_static_property_bool(zend_class_entry *scope, const char *name, size_t name_length, zend_long value);
350bdeb220fSAnatol BelskiZEND_API int zend_update_static_property_long(zend_class_entry *scope, const char *name, size_t name_length, zend_long value);
351bdeb220fSAnatol BelskiZEND_API int zend_update_static_property_double(zend_class_entry *scope, const char *name, size_t name_length, double value);
352bdeb220fSAnatol BelskiZEND_API int zend_update_static_property_string(zend_class_entry *scope, const char *name, size_t name_length, const char *value);
353bdeb220fSAnatol 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);
354bdeb220fSAnatol Belski
3553e31838dSDmitry StogovZEND_API zval *zend_read_property(zend_class_entry *scope, zval *object, const char *name, size_t name_length, zend_bool silent, zval *rv);
356bdeb220fSAnatol Belski
357bdeb220fSAnatol BelskiZEND_API zval *zend_read_static_property(zend_class_entry *scope, const char *name, size_t name_length, zend_bool silent);
358248345d9SDmitry Stogov
3599dd24c6dSAntony DovgalZEND_API char *zend_get_type_by_const(int type);
3606ac6cb10SHarald Radi
361bd9a2346SDmitry Stogov#define getThis()							(Z_OBJ(EX(This)) ? &EX(This) : NULL)
362cf5920e8SNikita Popov#define ZEND_IS_METHOD_CALL()				(EX(func)->common.scope != NULL)
363741b8161SZeev Suraski
3648be4266fSAnthony Ferrara#define WRONG_PARAM_COUNT					ZEND_WRONG_PARAM_COUNT()
365579e7fa4SAnthony Ferrara#define WRONG_PARAM_COUNT_WITH_RETVAL(ret)	ZEND_WRONG_PARAM_COUNT_WITH_RETVAL(ret)
36611384ba7SDmitry Stogov#define ARG_COUNT(dummy)					EX_NUM_ARGS()
36711384ba7SDmitry Stogov#define ZEND_NUM_ARGS()						EX_NUM_ARGS()
368579e7fa4SAnthony Ferrara#define ZEND_WRONG_PARAM_COUNT()					{ zend_wrong_param_count(); return; }
3698be4266fSAnthony Ferrara#define ZEND_WRONG_PARAM_COUNT_WITH_RETVAL(ret)		{ zend_wrong_param_count(); return ret; }
370573b4602SAndi Gutmans
37180bdd19eSZeev Suraski#ifndef ZEND_WIN32
372573b4602SAndi Gutmans#define DLEXPORT
373573b4602SAndi Gutmans#endif
374573b4602SAndi Gutmans
3757da75d81SMatt Wilmas#define array_init(arg)			_array_init((arg), 0 ZEND_FILE_LINE_CC)
3767da75d81SMatt Wilmas#define array_init_size(arg, size) _array_init((arg), (size) ZEND_FILE_LINE_CC)
377bdeb220fSAnatol Belski#define object_init(arg)		_object_init((arg) ZEND_FILE_LINE_CC)
378bdeb220fSAnatol Belski#define object_init_ex(arg, ce)	_object_init_ex((arg), (ce) ZEND_FILE_LINE_CC)
379bdeb220fSAnatol Belski#define object_and_properties_init(arg, ce, properties)	_object_and_properties_init((arg), (ce), (properties) ZEND_FILE_LINE_CC)
38007fdc1c7SAnatol BelskiZEND_API int _array_init(zval *arg, uint32_t size ZEND_FILE_LINE_DC);
381bdeb220fSAnatol BelskiZEND_API int _object_init(zval *arg ZEND_FILE_LINE_DC);
382bdeb220fSAnatol BelskiZEND_API int _object_init_ex(zval *arg, zend_class_entry *ce ZEND_FILE_LINE_DC);
383bdeb220fSAnatol BelskiZEND_API int _object_and_properties_init(zval *arg, zend_class_entry *ce, HashTable *properties ZEND_FILE_LINE_DC);
384c5237d82SDmitry StogovZEND_API void object_properties_init(zend_object *object, zend_class_entry *class_type);
385bdeb220fSAnatol BelskiZEND_API void object_properties_init_ex(zend_object *object, HashTable *properties);
386bdeb220fSAnatol BelskiZEND_API void object_properties_load(zend_object *object, HashTable *properties);
3876847fefaSThies C. Arntzen
388bdeb220fSAnatol BelskiZEND_API void zend_merge_properties(zval *obj, HashTable *properties);
389047a574eSMarcus Boerger
390f2279224SAnatol BelskiZEND_API int add_assoc_long_ex(zval *arg, const char *key, size_t key_len, zend_long n);
391f2279224SAnatol BelskiZEND_API int add_assoc_null_ex(zval *arg, const char *key, size_t key_len);
392f2279224SAnatol BelskiZEND_API int add_assoc_bool_ex(zval *arg, const char *key, size_t key_len, int b);
393f2279224SAnatol BelskiZEND_API int add_assoc_resource_ex(zval *arg, const char *key, size_t key_len, zend_resource *r);
394f2279224SAnatol BelskiZEND_API int add_assoc_double_ex(zval *arg, const char *key, size_t key_len, double d);
395f2279224SAnatol BelskiZEND_API int add_assoc_str_ex(zval *arg, const char *key, size_t key_len, zend_string *str);
396f2279224SAnatol BelskiZEND_API int add_assoc_string_ex(zval *arg, const char *key, size_t key_len, char *str);
397f2279224SAnatol BelskiZEND_API int add_assoc_stringl_ex(zval *arg, const char *key, size_t key_len, char *str, size_t length);
398f2279224SAnatol BelskiZEND_API int add_assoc_zval_ex(zval *arg, const char *key, size_t key_len, zval *value);
399f2279224SAnatol Belski
400f2279224SAnatol Belski#define add_assoc_long(__arg, __key, __n) add_assoc_long_ex(__arg, __key, strlen(__key), __n)
401f2279224SAnatol Belski#define add_assoc_null(__arg, __key) add_assoc_null_ex(__arg, __key, strlen(__key))
402f2279224SAnatol Belski#define add_assoc_bool(__arg, __key, __b) add_assoc_bool_ex(__arg, __key, strlen(__key), __b)
403f2279224SAnatol Belski#define add_assoc_resource(__arg, __key, __r) add_assoc_resource_ex(__arg, __key, strlen(__key), __r)
404f2279224SAnatol Belski#define add_assoc_double(__arg, __key, __d) add_assoc_double_ex(__arg, __key, strlen(__key), __d)
405f2279224SAnatol Belski#define add_assoc_str(__arg, __key, __str) add_assoc_str_ex(__arg, __key, strlen(__key), __str)
406f2279224SAnatol Belski#define add_assoc_string(__arg, __key, __str) add_assoc_string_ex(__arg, __key, strlen(__key), __str)
407f2279224SAnatol Belski#define add_assoc_stringl(__arg, __key, __str, __length) add_assoc_stringl_ex(__arg, __key, strlen(__key), __str, __length)
408f2279224SAnatol Belski#define add_assoc_zval(__arg, __key, __value) add_assoc_zval_ex(__arg, __key, strlen(__key), __value)
4096847fefaSThies C. Arntzen
4100611acb9SAndi Gutmans/* unset() functions are only suported for legacy modules and null() functions should be used */
411f2279224SAnatol Belski#define add_assoc_unset(__arg, __key) add_assoc_null_ex(__arg, __key, strlen(__key))
4120611acb9SAndi Gutmans#define add_index_unset(__arg, __key) add_index_null(__arg, __key)
4130611acb9SAndi Gutmans#define add_next_index_unset(__arg) add_next_index_null(__arg)
4140611acb9SAndi Gutmans#define add_property_unset(__arg, __key) add_property_null(__arg, __key)
4150611acb9SAndi Gutmans
416c3e3c98eSAnatol BelskiZEND_API int add_index_long(zval *arg, zend_ulong idx, zend_long n);
417c3e3c98eSAnatol BelskiZEND_API int add_index_null(zval *arg, zend_ulong idx);
418c3e3c98eSAnatol BelskiZEND_API int add_index_bool(zval *arg, zend_ulong idx, int b);
419c3e3c98eSAnatol BelskiZEND_API int add_index_resource(zval *arg, zend_ulong idx, zend_resource *r);
420c3e3c98eSAnatol BelskiZEND_API int add_index_double(zval *arg, zend_ulong idx, double d);
421c3e3c98eSAnatol BelskiZEND_API int add_index_str(zval *arg, zend_ulong idx, zend_string *str);
422c3e3c98eSAnatol BelskiZEND_API int add_index_string(zval *arg, zend_ulong idx, const char *str);
423d6faac2cSAnatol BelskiZEND_API int add_index_stringl(zval *arg, zend_ulong idx, const char *str, size_t length);
424c3e3c98eSAnatol BelskiZEND_API int add_index_zval(zval *arg, zend_ulong index, zval *value);
425c3e3c98eSAnatol Belski
426c3e3c98eSAnatol BelskiZEND_API int add_next_index_long(zval *arg, zend_long n);
4270611acb9SAndi GutmansZEND_API int add_next_index_null(zval *arg);
4286847fefaSThies C. ArntzenZEND_API int add_next_index_bool(zval *arg, int b);
429f4cfaf36SDmitry StogovZEND_API int add_next_index_resource(zval *arg, zend_resource *r);
430573b4602SAndi GutmansZEND_API int add_next_index_double(zval *arg, double d);
431f4cfaf36SDmitry StogovZEND_API int add_next_index_str(zval *arg, zend_string *str);
432050d7e38SDmitry StogovZEND_API int add_next_index_string(zval *arg, const char *str);
433d6faac2cSAnatol BelskiZEND_API int add_next_index_stringl(zval *arg, const char *str, size_t length);
434ef95a346SAndi GutmansZEND_API int add_next_index_zval(zval *arg, zval *value);
435ef95a346SAndi Gutmans
436050d7e38SDmitry StogovZEND_API zval *add_get_assoc_string_ex(zval *arg, const char *key, uint key_len, const char *str);
437d6faac2cSAnatol BelskiZEND_API zval *add_get_assoc_stringl_ex(zval *arg, const char *key, uint key_len, const char *str, size_t length);
438ef95a346SAndi Gutmans
439050d7e38SDmitry Stogov#define add_get_assoc_string(__arg, __key, __str) add_get_assoc_string_ex(__arg, __key, strlen(__key), __str)
440050d7e38SDmitry Stogov#define add_get_assoc_stringl(__arg, __key, __str, __length) add_get_assoc_stringl_ex(__arg, __key, strlen(__key), __str, __length)
441573b4602SAndi Gutmans
442c3e3c98eSAnatol BelskiZEND_API zval *add_get_index_long(zval *arg, zend_ulong idx, zend_long l);
443c3e3c98eSAnatol BelskiZEND_API zval *add_get_index_double(zval *arg, zend_ulong idx, double d);
444c3e3c98eSAnatol BelskiZEND_API zval *add_get_index_str(zval *arg, zend_ulong index, zend_string *str);
445c3e3c98eSAnatol BelskiZEND_API zval *add_get_index_string(zval *arg, zend_ulong idx, const char *str);
446d6faac2cSAnatol BelskiZEND_API zval *add_get_index_stringl(zval *arg, zend_ulong idx, const char *str, size_t length);
447573b4602SAndi Gutmans
448bdeb220fSAnatol BelskiZEND_API int array_set_zval_key(HashTable *ht, zval *key, zval *value);
449fcc6611dSNikita Popov
450bdeb220fSAnatol BelskiZEND_API int add_property_long_ex(zval *arg, const char *key, size_t key_len, zend_long l);
451bdeb220fSAnatol BelskiZEND_API int add_property_null_ex(zval *arg, const char *key, size_t key_len);
452bdeb220fSAnatol BelskiZEND_API int add_property_bool_ex(zval *arg, const char *key, size_t key_len, zend_long b);
453bdeb220fSAnatol BelskiZEND_API int add_property_resource_ex(zval *arg, const char *key, size_t key_len, zend_resource *r);
454bdeb220fSAnatol BelskiZEND_API int add_property_double_ex(zval *arg, const char *key, size_t key_len, double d);
455bdeb220fSAnatol BelskiZEND_API int add_property_str_ex(zval *arg, const char *key, size_t key_len, zend_string *str);
456bdeb220fSAnatol BelskiZEND_API int add_property_string_ex(zval *arg, const char *key, size_t key_len, const char *str);
457bdeb220fSAnatol BelskiZEND_API int add_property_stringl_ex(zval *arg, const char *key, size_t key_len,  const char *str, size_t length);
458bdeb220fSAnatol BelskiZEND_API int add_property_zval_ex(zval *arg, const char *key, size_t key_len, zval *value);
459f2279224SAnatol Belski
460bdeb220fSAnatol Belski#define add_property_long(__arg, __key, __n) add_property_long_ex(__arg, __key, strlen(__key), __n)
461bdeb220fSAnatol Belski#define add_property_null(__arg, __key) add_property_null_ex(__arg, __key, strlen(__key))
462bdeb220fSAnatol Belski#define add_property_bool(__arg, __key, __b) add_property_bool_ex(__arg, __key, strlen(__key), __b)
463bdeb220fSAnatol Belski#define add_property_resource(__arg, __key, __r) add_property_resource_ex(__arg, __key, strlen(__key), __r)
464bdeb220fSAnatol Belski#define add_property_double(__arg, __key, __d) add_property_double_ex(__arg, __key, strlen(__key), __d)
465bdeb220fSAnatol Belski#define add_property_str(__arg, __key, __str) add_property_str_ex(__arg, __key, strlen(__key), __str)
466bdeb220fSAnatol Belski#define add_property_string(__arg, __key, __str) add_property_string_ex(__arg, __key, strlen(__key), __str)
467bdeb220fSAnatol Belski#define add_property_stringl(__arg, __key, __str, __length) add_property_stringl_ex(__arg, __key, strlen(__key), __str, __length)
468bdeb220fSAnatol Belski#define add_property_zval(__arg, __key, __value) add_property_zval_ex(__arg, __key, strlen(__key), __value)
469ef95a346SAndi Gutmans
47092b4013eSZeev Suraski
471bdeb220fSAnatol BelskiZEND_API int call_user_function(HashTable *function_table, zval *object, zval *function_name, zval *retval_ptr, uint32_t param_count, zval params[]);
472bdeb220fSAnatol BelskiZEND_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);
47392b4013eSZeev Suraski
474f87d4530SNuno LopesZEND_API extern const zend_fcall_info empty_fcall_info;
475f87d4530SNuno LopesZEND_API extern const zend_fcall_info_cache empty_fcall_info_cache;
47692b4013eSZeev Suraski
47764c353abSMarcus Boerger/** Build zend_call_info/cache from a zval*
47864c353abSMarcus Boerger *
479a17e4187SJoe Watkins * Caller is responsible to provide a return value (fci->retval), otherwise the we will crash.
48064c353abSMarcus Boerger * In order to pass parameters the following members need to be set:
48164c353abSMarcus Boerger * fci->param_count = 0;
48264c353abSMarcus Boerger * fci->params = NULL;
483b4892511SJani Taskinen * The callable_name argument may be NULL.
484e8a8acdfSMarcus Boerger * Set check_flags to IS_CALLABLE_STRICT for every new usage!
485b4892511SJani Taskinen */
486bdeb220fSAnatol BelskiZEND_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);
487b4892511SJani Taskinen
48804145dc2SVeres Lajos/** Clear arguments connected with zend_fcall_info *fci
489b4892511SJani Taskinen * If free_mem is not zero then the params array gets free'd as well
490b4892511SJani Taskinen */
491b4892511SJani TaskinenZEND_API void zend_fcall_info_args_clear(zend_fcall_info *fci, int free_mem);
492b4892511SJani Taskinen
493b4892511SJani Taskinen/** Save current arguments from zend_fcall_info *fci
494b4892511SJani Taskinen * params array will be set to NULL
495b4892511SJani Taskinen */
496f4cfaf36SDmitry StogovZEND_API void zend_fcall_info_args_save(zend_fcall_info *fci, int *param_count, zval **params);
497b4892511SJani Taskinen
498b4892511SJani Taskinen/** Free arguments connected with zend_fcall_info *fci andset back saved ones.
49964c353abSMarcus Boerger */
500f4cfaf36SDmitry StogovZEND_API void zend_fcall_info_args_restore(zend_fcall_info *fci, int param_count, zval *params);
50164c353abSMarcus Boerger
50264c353abSMarcus Boerger/** Set or clear the arguments in the zend_call_info struct taking care of
50364c353abSMarcus Boerger * refcount. If args is NULL and arguments are set then those are cleared.
50464c353abSMarcus Boerger */
505bdeb220fSAnatol BelskiZEND_API int zend_fcall_info_args(zend_fcall_info *fci, zval *args);
506bdeb220fSAnatol BelskiZEND_API int zend_fcall_info_args_ex(zend_fcall_info *fci, zend_function *func, zval *args);
50764c353abSMarcus Boerger
508b4892511SJani Taskinen/** Set arguments in the zend_fcall_info struct taking care of refcount.
509b4892511SJani Taskinen * If argc is 0 the arguments which are set will be cleared, else pass
510b4892511SJani Taskinen * a variable amount of zval** arguments.
511b4892511SJani Taskinen */
512bdeb220fSAnatol BelskiZEND_API int zend_fcall_info_argp(zend_fcall_info *fci, int argc, zval *argv);
513b4892511SJani Taskinen
514b4892511SJani Taskinen/** Set arguments in the zend_fcall_info struct taking care of refcount.
515b4892511SJani Taskinen * If argc is 0 the arguments which are set will be cleared, else pass
516b4892511SJani Taskinen * a variable amount of zval** arguments.
517b4892511SJani Taskinen */
518bdeb220fSAnatol BelskiZEND_API int zend_fcall_info_argv(zend_fcall_info *fci, int argc, va_list *argv);
519b4892511SJani Taskinen
520b4892511SJani Taskinen/** Set arguments in the zend_fcall_info struct taking care of refcount.
521b4892511SJani Taskinen * If argc is 0 the arguments which are set will be cleared, else pass
522b4892511SJani Taskinen * a variable amount of zval** arguments.
523b4892511SJani Taskinen */
524bdeb220fSAnatol BelskiZEND_API int zend_fcall_info_argn(zend_fcall_info *fci, int argc, ...);
525b4892511SJani Taskinen
52664c353abSMarcus Boerger/** Call a function using information created by zend_fcall_info_init()/args().
52704145dc2SVeres Lajos * If args is given then those replace the argument info in fci is temporarily.
52864c353abSMarcus Boerger */
529bdeb220fSAnatol BelskiZEND_API int zend_fcall_info_call(zend_fcall_info *fci, zend_fcall_info_cache *fcc, zval *retval, zval *args);
53064c353abSMarcus Boerger
531bdeb220fSAnatol BelskiZEND_API int zend_call_function(zend_fcall_info *fci, zend_fcall_info_cache *fci_cache);
53292b4013eSZeev Suraski
533cf7384aaSFelipe PenaZEND_API int zend_set_hash_symbol(zval *symbol, const char *name, int name_length, zend_bool is_ref, int num_symbol_tables, ...);
534f962a35dSAndrei Zmievski
535bdeb220fSAnatol BelskiZEND_API int zend_delete_global_variable(zend_string *name);
536453b49edSDmitry Stogov
537bdeb220fSAnatol BelskiZEND_API zend_array *zend_rebuild_symbol_table(void);
538ea2e1bb1SDmitry StogovZEND_API void zend_attach_symbol_table(zend_execute_data *execute_data);
539ea2e1bb1SDmitry StogovZEND_API void zend_detach_symbol_table(zend_execute_data *execute_data);
540bdeb220fSAnatol BelskiZEND_API int zend_set_local_var(zend_string *name, zval *value, int force);
541bdeb220fSAnatol BelskiZEND_API int zend_set_local_var_str(const char *name, size_t len, zval *value, int force);
5422ecf4bb0SDmitry Stogov
543f4cfaf36SDmitry StogovZEND_API zend_string *zend_find_alias_name(zend_class_entry *ce, zend_string *name);
544f4cfaf36SDmitry StogovZEND_API zend_string *zend_resolve_method_name(zend_class_entry *ce, zend_function *f);
5457dce0194SXinchen Hui
54602be73b5SKalle Sommer NielsenZEND_API const char *zend_get_object_type(const zend_class_entry *ce);
547927d53fdSKalle Sommer Nielsen
5484f6c95d1SZeev Suraski#define add_method(arg, key, method)	add_assoc_function((arg), (key), (method))
549573b4602SAndi Gutmans
550a35c61afSAndrei ZmievskiZEND_API ZEND_FUNCTION(display_disabled_function);
551a700180fSHarald RadiZEND_API ZEND_FUNCTION(display_disabled_class);
5521727c6a2SHartmut HolzgraefeEND_EXTERN_C()
553a35c61afSAndrei Zmievski
554bcddfd47SThies C. Arntzen#if ZEND_DEBUG
555050d7e38SDmitry Stogov#define CHECK_ZVAL_STRING(str) \
5564a2e40bbSDmitry Stogov	if (ZSTR_VAL(str)[ZSTR_LEN(str)] != '\0') { zend_error(E_WARNING, "String is not zero-terminated (%s)", ZSTR_VAL(str)); }
557050d7e38SDmitry Stogov#define CHECK_ZVAL_STRING_REL(str) \
5584a2e40bbSDmitry 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); }
559bcddfd47SThies C. Arntzen#else
560bcddfd47SThies C. Arntzen#define CHECK_ZVAL_STRING(z)
56143ebb868SZeev Suraski#define CHECK_ZVAL_STRING_REL(z)
562bcddfd47SThies C. Arntzen#endif
563bcddfd47SThies C. Arntzen
564c3e3c98eSAnatol Belski#define CHECK_ZVAL_NULL_PATH(p) (Z_STRLEN_P(p) != strlen(Z_STRVAL_P(p)))
56532b5f8a1SFelipe Pena#define CHECK_NULL_PATH(p, l) (strlen(p) != l)
56632b5f8a1SFelipe Pena
567f4cfaf36SDmitry Stogov#define ZVAL_STRINGL(z, s, l) do {				\
568c3e3c98eSAnatol Belski		ZVAL_NEW_STR(z, zend_string_init(s, l, 0));		\
569453b49edSDmitry Stogov	} while (0)
570bcddfd47SThies C. Arntzen
571f4cfaf36SDmitry Stogov#define ZVAL_STRING(z, s) do {					\
572f4cfaf36SDmitry Stogov		const char *_s = (s);					\
573a0fe8e5aSDmitry Stogov		ZVAL_STRINGL(z, _s, strlen(_s));		\
574453b49edSDmitry Stogov	} while (0)
575bcddfd47SThies C. Arntzen
576f4cfaf36SDmitry Stogov#define ZVAL_EMPTY_STRING(z) do {				\
5774bd22cf1SDmitry Stogov		ZVAL_INTERNED_STR(z, ZSTR_EMPTY_ALLOC());		\
578453b49edSDmitry Stogov	} while (0)
579453b49edSDmitry Stogov
580f4cfaf36SDmitry Stogov#define ZVAL_PSTRINGL(z, s, l) do {				\
581c3e3c98eSAnatol Belski		ZVAL_NEW_STR(z, zend_string_init(s, l, 1));		\
582453b49edSDmitry Stogov	} while (0)
583453b49edSDmitry Stogov
584f4cfaf36SDmitry Stogov#define ZVAL_PSTRING(z, s) do {					\
585f4cfaf36SDmitry Stogov		const char *_s = (s);					\
586a0fe8e5aSDmitry Stogov		ZVAL_PSTRINGL(z, _s, strlen(_s));		\
587f4cfaf36SDmitry Stogov	} while (0)
588f4cfaf36SDmitry Stogov
589f4cfaf36SDmitry Stogov#define ZVAL_EMPTY_PSTRING(z) do {				\
5900e425121SDmitry Stogov		ZVAL_PSTRINGL(z, "", 0);				\
591453b49edSDmitry Stogov	} while (0)
592af22085cSThies C. Arntzen
593d18b9698SNikita Popov#define ZVAL_ZVAL(z, zv, copy, dtor) do {		\
594d18b9698SNikita Popov		zval *__z = (z);						\
595d18b9698SNikita Popov		zval *__zv = (zv);						\
596bfdaf6e8SDmitry Stogov		if (EXPECTED(!Z_ISREF_P(__zv))) {		\
5978e10e8f9SDmitry Stogov			if (copy && !dtor) {				\
5988e10e8f9SDmitry Stogov				ZVAL_COPY(__z, __zv);			\
5998e10e8f9SDmitry Stogov			} else {							\
6008e10e8f9SDmitry Stogov				ZVAL_COPY_VALUE(__z, __zv);		\
6018e10e8f9SDmitry Stogov			}									\
6028e10e8f9SDmitry Stogov		} else {								\
6038e10e8f9SDmitry Stogov			ZVAL_COPY(__z, Z_REFVAL_P(__zv));	\
6048e10e8f9SDmitry Stogov			if (dtor || !copy) {				\
6058e10e8f9SDmitry Stogov				zval_ptr_dtor(__zv);			\
606d90ebc65SDmitry Stogov			}									\
6078e10e8f9SDmitry Stogov		}										\
608d18b9698SNikita Popov	} while (0)
609c7d27ad9SMarcus Boerger
6104f6c95d1SZeev Suraski#define RETVAL_BOOL(b)					ZVAL_BOOL(return_value, b)
611bcddfd47SThies C. Arntzen#define RETVAL_NULL() 					ZVAL_NULL(return_value)
612c3e3c98eSAnatol Belski#define RETVAL_LONG(l) 					ZVAL_LONG(return_value, l)
6134f6c95d1SZeev Suraski#define RETVAL_DOUBLE(d) 				ZVAL_DOUBLE(return_value, d)
614f4cfaf36SDmitry Stogov#define RETVAL_STR(s)			 		ZVAL_STR(return_value, s)
61586336856SDmitry Stogov#define RETVAL_INTERNED_STR(s)	 		ZVAL_INTERNED_STR(return_value, s)
61676cc99feSDmitry Stogov#define RETVAL_NEW_STR(s)		 		ZVAL_NEW_STR(return_value, s)
61786336856SDmitry Stogov#define RETVAL_STR_COPY(s)		 		ZVAL_STR_COPY(return_value, s)
618f4cfaf36SDmitry Stogov#define RETVAL_STRING(s)		 		ZVAL_STRING(return_value, s)
619f4cfaf36SDmitry Stogov#define RETVAL_STRINGL(s, l)		 	ZVAL_STRINGL(return_value, s, l)
620bcddfd47SThies C. Arntzen#define RETVAL_EMPTY_STRING() 			ZVAL_EMPTY_STRING(return_value)
621398256e5SDmitry Stogov#define RETVAL_RES(r)			 		ZVAL_RES(return_value, r)
6221f28da02SJin Hu#define RETVAL_ARR(r)			 		ZVAL_ARR(return_value, r)
6232402d6cbSXinchen Hui#define RETVAL_OBJ(r)			 		ZVAL_OBJ(return_value, r)
624c7d27ad9SMarcus Boerger#define RETVAL_ZVAL(zv, copy, dtor)		ZVAL_ZVAL(return_value, zv, copy, dtor)
625b5b61767SXinchen Hui#define RETVAL_FALSE  					ZVAL_FALSE(return_value)
626b5b61767SXinchen Hui#define RETVAL_TRUE   					ZVAL_TRUE(return_value)
627bcddfd47SThies C. Arntzen
628bcddfd47SThies C. Arntzen#define RETURN_BOOL(b) 					{ RETVAL_BOOL(b); return; }
629bcddfd47SThies C. Arntzen#define RETURN_NULL() 					{ RETVAL_NULL(); return;}
630c3e3c98eSAnatol Belski#define RETURN_LONG(l) 					{ RETVAL_LONG(l); return; }
631bcddfd47SThies C. Arntzen#define RETURN_DOUBLE(d) 				{ RETVAL_DOUBLE(d); return; }
632f4cfaf36SDmitry Stogov#define RETURN_STR(s) 					{ RETVAL_STR(s); return; }
63386336856SDmitry Stogov#define RETURN_INTERNED_STR(s)			{ RETVAL_INTERNED_STR(s); return; }
63476cc99feSDmitry Stogov#define RETURN_NEW_STR(s)				{ RETVAL_NEW_STR(s); return; }
63586336856SDmitry Stogov#define RETURN_STR_COPY(s)				{ RETVAL_STR_COPY(s); return; }
636f4cfaf36SDmitry Stogov#define RETURN_STRING(s) 				{ RETVAL_STRING(s); return; }
637f4cfaf36SDmitry Stogov#define RETURN_STRINGL(s, l) 			{ RETVAL_STRINGL(s, l); return; }
638bcddfd47SThies C. Arntzen#define RETURN_EMPTY_STRING() 			{ RETVAL_EMPTY_STRING(); return; }
639398256e5SDmitry Stogov#define RETURN_RES(r) 					{ RETVAL_RES(r); return; }
6401f28da02SJin Hu#define RETURN_ARR(r) 					{ RETVAL_ARR(r); return; }
6412402d6cbSXinchen Hui#define RETURN_OBJ(r) 					{ RETVAL_OBJ(r); return; }
642c7d27ad9SMarcus Boerger#define RETURN_ZVAL(zv, copy, dtor)		{ RETVAL_ZVAL(zv, copy, dtor); return; }
643bcddfd47SThies C. Arntzen#define RETURN_FALSE  					{ RETVAL_FALSE; return; }
644bcddfd47SThies C. Arntzen#define RETURN_TRUE   					{ RETVAL_TRUE; return; }
6451f985edeSZeev Suraski
646bdeb220fSAnatol 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)))
647068ec75fSXinchen Hui#define ZVAL_IS_NULL(z) (Z_TYPE_P(z) == IS_NULL)
64806a18f16SAndi Gutmans
6498b6f848cSAndi Gutmans/* For compatibility */
6508b6f848cSAndi Gutmans#define ZEND_MINIT			ZEND_MODULE_STARTUP_N
6518b6f848cSAndi Gutmans#define ZEND_MSHUTDOWN		ZEND_MODULE_SHUTDOWN_N
6528b6f848cSAndi Gutmans#define ZEND_RINIT			ZEND_MODULE_ACTIVATE_N
6538b6f848cSAndi Gutmans#define ZEND_RSHUTDOWN		ZEND_MODULE_DEACTIVATE_N
6548b6f848cSAndi Gutmans#define ZEND_MINFO			ZEND_MODULE_INFO_N
655bdeb220fSAnatol Belski#define ZEND_GINIT(module)		((void (*)(void*))(ZEND_MODULE_GLOBALS_CTOR_N(module)))
656bdeb220fSAnatol Belski#define ZEND_GSHUTDOWN(module)	((void (*)(void*))(ZEND_MODULE_GLOBALS_DTOR_N(module)))
6578b6f848cSAndi Gutmans
6588b6f848cSAndi Gutmans#define ZEND_MINIT_FUNCTION			ZEND_MODULE_STARTUP_D
659f5c59863SStanislav Malyshev#define ZEND_MSHUTDOWN_FUNCTION		ZEND_MODULE_SHUTDOWN_D
660f5c59863SStanislav Malyshev#define ZEND_RINIT_FUNCTION			ZEND_MODULE_ACTIVATE_D
661f5c59863SStanislav Malyshev#define ZEND_RSHUTDOWN_FUNCTION		ZEND_MODULE_DEACTIVATE_D
662f5c59863SStanislav Malyshev#define ZEND_MINFO_FUNCTION			ZEND_MODULE_INFO_D
663ada4e506SDmitry Stogov#define ZEND_GINIT_FUNCTION			ZEND_MODULE_GLOBALS_CTOR_D
664ada4e506SDmitry Stogov#define ZEND_GSHUTDOWN_FUNCTION		ZEND_MODULE_GLOBALS_DTOR_D
6658b6f848cSAndi Gutmans
66627f38798SDmitry Stogov/* Fast parameter parsing API */
66727f38798SDmitry Stogov
668d690014bSAndrea Faulds/* Fast ZPP is always enabled now; this define is left in for compatibility
669d690014bSAndrea Faulds * with any existing conditional compilation blocks.
67027f38798SDmitry Stogov */
67127f38798SDmitry Stogov#define FAST_ZPP 1
67227f38798SDmitry Stogov
67327f38798SDmitry Stogov#define Z_EXPECTED_TYPES(_) \
674e5eb9530SAndrea Faulds	_(Z_EXPECTED_LONG,		"integer") \
67527f38798SDmitry Stogov	_(Z_EXPECTED_BOOL,		"boolean") \
67627f38798SDmitry Stogov	_(Z_EXPECTED_STRING,	"string") \
67727f38798SDmitry Stogov	_(Z_EXPECTED_ARRAY,		"array") \
67827f38798SDmitry Stogov	_(Z_EXPECTED_FUNC,		"valid callback") \
67927f38798SDmitry Stogov	_(Z_EXPECTED_RESOURCE,	"resource") \
68027f38798SDmitry Stogov	_(Z_EXPECTED_PATH,		"a valid path") \
68127f38798SDmitry Stogov	_(Z_EXPECTED_OBJECT,	"object") \
682e5eb9530SAndrea Faulds	_(Z_EXPECTED_DOUBLE,	"float")
68327f38798SDmitry Stogov
68427f38798SDmitry Stogov#define Z_EXPECTED_TYPE_ENUM(id, str) id,
68527f38798SDmitry Stogov#define Z_EXPECTED_TYPE_STR(id, str)  str,
68627f38798SDmitry Stogov
68727f38798SDmitry Stogovtypedef enum _zend_expected_type {
68827f38798SDmitry Stogov	Z_EXPECTED_TYPES(Z_EXPECTED_TYPE_ENUM)
68927f38798SDmitry Stogov	Z_EXPECTED_LAST
69027f38798SDmitry Stogov} zend_expected_type;
69127f38798SDmitry Stogov
6920495bf56SXinchen HuiZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_paramers_count_error(int num_args, int min_num_args, int max_num_args);
6930495bf56SXinchen HuiZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_paramer_type_error(int num, zend_expected_type expected_type, zval *arg);
6940495bf56SXinchen HuiZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_paramer_class_error(int num, char *name, zval *arg);
69571af54e5SDmitry StogovZEND_API ZEND_COLD void ZEND_FASTCALL zend_wrong_callback_error(int severity, int num, char *error);
69627f38798SDmitry Stogov
6970ae305e6SDmitry Stogov#define ZPP_ERROR_OK             0
6980ae305e6SDmitry Stogov#define ZPP_ERROR_FAILURE        1
6990ae305e6SDmitry Stogov#define ZPP_ERROR_WRONG_CALLBACK 2
7000ae305e6SDmitry Stogov#define ZPP_ERROR_WRONG_CLASS    3
7010ae305e6SDmitry Stogov#define ZPP_ERROR_WRONG_ARG      4
7020ae305e6SDmitry Stogov#define ZPP_ERROR_WRONG_COUNT    5
7030ae305e6SDmitry Stogov
70427f38798SDmitry Stogov#define ZEND_PARSE_PARAMETERS_START_EX(flags, min_num_args, max_num_args) do { \
70535f9b90bSDmitry Stogov		const int _flags = (flags); \
70627f38798SDmitry Stogov		int _min_num_args = (min_num_args); \
70727f38798SDmitry Stogov		int _max_num_args = (max_num_args); \
70811384ba7SDmitry Stogov		int _num_args = EX_NUM_ARGS(); \
70927f38798SDmitry Stogov		int _i; \
7100ae305e6SDmitry Stogov		zval *_real_arg, *_arg = NULL; \
7110ae305e6SDmitry Stogov		zend_expected_type _expected_type = IS_UNDEF; \
7120ae305e6SDmitry Stogov		char *_error = NULL; \
71327f38798SDmitry Stogov		zend_bool _dummy; \
7140ae305e6SDmitry Stogov		zend_bool _optional = 0; \
7150ae305e6SDmitry Stogov		int error_code = ZPP_ERROR_OK; \
71627f38798SDmitry Stogov		((void)_i); \
71727f38798SDmitry Stogov		((void)_real_arg); \
71827f38798SDmitry Stogov		((void)_arg); \
71927f38798SDmitry Stogov		((void)_expected_type); \
72027f38798SDmitry Stogov		((void)_error); \
72127f38798SDmitry Stogov		((void)_dummy); \
7220ae305e6SDmitry Stogov		((void)_optional); \
7230ae305e6SDmitry Stogov		\
7240ae305e6SDmitry Stogov		do { \
7250ae305e6SDmitry Stogov			if (UNEXPECTED(_num_args < _min_num_args) || \
7260ae305e6SDmitry Stogov			    (UNEXPECTED(_num_args > _max_num_args) && \
7270ae305e6SDmitry Stogov			     EXPECTED(_max_num_args >= 0))) { \
7280ae305e6SDmitry Stogov				if (!(_flags & ZEND_PARSE_PARAMS_QUIET)) { \
7290495bf56SXinchen Hui					zend_wrong_paramers_count_error(_num_args, _min_num_args, _max_num_args); \
7300ae305e6SDmitry Stogov				} \
7310ae305e6SDmitry Stogov				error_code = ZPP_ERROR_FAILURE; \
7320ae305e6SDmitry Stogov				break; \
73327f38798SDmitry Stogov			} \
7340ae305e6SDmitry Stogov			_i = 0; \
735bd9a2346SDmitry Stogov			_real_arg = ZEND_CALL_ARG(execute_data, 0);
73627f38798SDmitry Stogov
73727f38798SDmitry Stogov#define ZEND_PARSE_PARAMETERS_START(min_num_args, max_num_args) \
73827f38798SDmitry Stogov	ZEND_PARSE_PARAMETERS_START_EX(0, min_num_args, max_num_args)
73927f38798SDmitry Stogov
74027f38798SDmitry Stogov#define ZEND_PARSE_PARAMETERS_END_EX(failure) \
7410ae305e6SDmitry Stogov		} while (0); \
7420ae305e6SDmitry Stogov		if (UNEXPECTED(error_code != ZPP_ERROR_OK)) { \
74327f38798SDmitry Stogov			if (!(_flags & ZEND_PARSE_PARAMS_QUIET)) { \
7440ae305e6SDmitry Stogov				if (error_code == ZPP_ERROR_WRONG_CALLBACK) { \
745ccfd5388SNikita Popov					zend_wrong_callback_error(E_WARNING, _i, _error); \
7460ae305e6SDmitry Stogov				} else if (error_code == ZPP_ERROR_WRONG_CLASS) { \
7470495bf56SXinchen Hui					zend_wrong_paramer_class_error(_i, _error, _arg); \
7480ae305e6SDmitry Stogov				} else if (error_code == ZPP_ERROR_WRONG_ARG) { \
7490495bf56SXinchen Hui					zend_wrong_paramer_type_error(_i, _expected_type, _arg); \
7500ae305e6SDmitry Stogov				} \
75127f38798SDmitry Stogov			} \
75227f38798SDmitry Stogov			failure; \
75327f38798SDmitry Stogov		} \
75427f38798SDmitry Stogov	} while (0)
75527f38798SDmitry Stogov
75627f38798SDmitry Stogov#define ZEND_PARSE_PARAMETERS_END() \
75727f38798SDmitry Stogov	ZEND_PARSE_PARAMETERS_END_EX(return)
75827f38798SDmitry Stogov
75927f38798SDmitry Stogov#define Z_PARAM_PROLOGUE(separate) \
7600ae305e6SDmitry Stogov	++_i; \
761a861019bSRemi Collet	ZEND_ASSERT(_i <= _min_num_args || _optional==1); \
762a861019bSRemi Collet	ZEND_ASSERT(_i >  _min_num_args || _optional==0); \
7630ae305e6SDmitry Stogov	if (_optional) { \
7640ae305e6SDmitry Stogov		if (UNEXPECTED(_i >_num_args)) break; \
7650ae305e6SDmitry Stogov	} \
76627f38798SDmitry Stogov	_real_arg++; \
76727f38798SDmitry Stogov	_arg = _real_arg; \
76827f38798SDmitry Stogov	ZVAL_DEREF(_arg); \
76927f38798SDmitry Stogov	if (separate) { \
77027f38798SDmitry Stogov		SEPARATE_ZVAL_NOREF(_arg); \
77127f38798SDmitry Stogov	}
77227f38798SDmitry Stogov
77327f38798SDmitry Stogov/* old "|" */
7740ae305e6SDmitry Stogov#define Z_PARAM_OPTIONAL \
7750ae305e6SDmitry Stogov	_optional = 1;
77627f38798SDmitry Stogov
77727f38798SDmitry Stogov/* old "a" */
7780ae305e6SDmitry Stogov#define Z_PARAM_ARRAY_EX(dest, check_null, separate) \
77927f38798SDmitry Stogov		Z_PARAM_PROLOGUE(separate); \
78041e3fdbaSAndrea Faulds		if (UNEXPECTED(!zend_parse_arg_array(_arg, &dest, check_null, 0))) { \
78127f38798SDmitry Stogov			_expected_type = Z_EXPECTED_ARRAY; \
7820ae305e6SDmitry Stogov			error_code = ZPP_ERROR_WRONG_ARG; \
7830ae305e6SDmitry Stogov			break; \
7840ae305e6SDmitry Stogov		}
78527f38798SDmitry Stogov
78627f38798SDmitry Stogov#define Z_PARAM_ARRAY(dest) \
78727f38798SDmitry Stogov	Z_PARAM_ARRAY_EX(dest, 0, 0)
78827f38798SDmitry Stogov
78927f38798SDmitry Stogov/* old "A" */
7900ae305e6SDmitry Stogov#define Z_PARAM_ARRAY_OR_OBJECT_EX(dest, check_null, separate) \
79127f38798SDmitry Stogov		Z_PARAM_PROLOGUE(separate); \
79241e3fdbaSAndrea Faulds		if (UNEXPECTED(!zend_parse_arg_array(_arg, &dest, check_null, 1))) { \
79327f38798SDmitry Stogov			_expected_type = Z_EXPECTED_ARRAY; \
7940ae305e6SDmitry Stogov			error_code = ZPP_ERROR_WRONG_ARG; \
7950ae305e6SDmitry Stogov			break; \
7960ae305e6SDmitry Stogov		}
79727f38798SDmitry Stogov
79827f38798SDmitry Stogov#define Z_PARAM_ARRAY_OR_OBJECT(dest, check_null, separate) \
79927f38798SDmitry Stogov	Z_PARAM_ARRAY_OR_OBJECT_EX(dest, 0, 0)
80027f38798SDmitry Stogov
80127f38798SDmitry Stogov/* old "b" */
8020ae305e6SDmitry Stogov#define Z_PARAM_BOOL_EX(dest, is_null, check_null, separate) \
80327f38798SDmitry Stogov		Z_PARAM_PROLOGUE(separate); \
80435f9b90bSDmitry Stogov		if (UNEXPECTED(!zend_parse_arg_bool(_arg, &dest, &is_null, check_null))) { \
80527f38798SDmitry Stogov			_expected_type = Z_EXPECTED_BOOL; \
8060ae305e6SDmitry Stogov			error_code = ZPP_ERROR_WRONG_ARG; \
8070ae305e6SDmitry Stogov			break; \
8080ae305e6SDmitry Stogov		}
80927f38798SDmitry Stogov
81027f38798SDmitry Stogov#define Z_PARAM_BOOL(dest) \
81127f38798SDmitry Stogov	Z_PARAM_BOOL_EX(dest, _dummy, 0, 0)
81227f38798SDmitry Stogov
81327f38798SDmitry Stogov/* old "C" */
8140ae305e6SDmitry Stogov#define Z_PARAM_CLASS_EX(dest, check_null, separate) \
81527f38798SDmitry Stogov		Z_PARAM_PROLOGUE(separate); \
81635f9b90bSDmitry Stogov		if (UNEXPECTED(!zend_parse_arg_class(_arg, &dest, _i, check_null))) { \
8170ae305e6SDmitry Stogov			error_code = ZPP_ERROR_FAILURE; \
8180ae305e6SDmitry Stogov			break; \
8190ae305e6SDmitry Stogov		}
82027f38798SDmitry Stogov
82127f38798SDmitry Stogov#define Z_PARAM_CLASS(dest) \
82227f38798SDmitry Stogov	Z_PARAM_CLASS_EX(dest, 0, 0)
82327f38798SDmitry Stogov
82427f38798SDmitry Stogov/* old "d" */
8250ae305e6SDmitry Stogov#define Z_PARAM_DOUBLE_EX(dest, is_null, check_null, separate) \
82627f38798SDmitry Stogov		Z_PARAM_PROLOGUE(separate); \
82735f9b90bSDmitry Stogov		if (UNEXPECTED(!zend_parse_arg_double(_arg, &dest, &is_null, check_null))) { \
82827f38798SDmitry Stogov			_expected_type = Z_EXPECTED_DOUBLE; \
8290ae305e6SDmitry Stogov			error_code = ZPP_ERROR_WRONG_ARG; \
8300ae305e6SDmitry Stogov			break; \
8310ae305e6SDmitry Stogov		}
83227f38798SDmitry Stogov
83327f38798SDmitry Stogov#define Z_PARAM_DOUBLE(dest) \
83427f38798SDmitry Stogov	Z_PARAM_DOUBLE_EX(dest, _dummy, 0, 0)
83527f38798SDmitry Stogov
83627f38798SDmitry Stogov/* old "f" */
8370ae305e6SDmitry Stogov#define Z_PARAM_FUNC_EX(dest_fci, dest_fcc, check_null, separate) \
83827f38798SDmitry Stogov		Z_PARAM_PROLOGUE(separate); \
83941e3fdbaSAndrea Faulds		if (UNEXPECTED(!zend_parse_arg_func(_arg, &dest_fci, &dest_fcc, check_null, &_error))) { \
84027f38798SDmitry Stogov			if (!_error) { \
84127f38798SDmitry Stogov				_expected_type = Z_EXPECTED_FUNC; \
8420ae305e6SDmitry Stogov				error_code = ZPP_ERROR_WRONG_ARG; \
8430ae305e6SDmitry Stogov				break; \
84427f38798SDmitry Stogov			} else { \
8450ae305e6SDmitry Stogov				error_code = ZPP_ERROR_WRONG_CALLBACK; \
8460ae305e6SDmitry Stogov				break; \
84727f38798SDmitry Stogov			} \
8480ae305e6SDmitry Stogov		} else if (UNEXPECTED(_error != NULL)) { \
8498d003858SNikita Popov			zend_wrong_callback_error(E_DEPRECATED, _i, _error); \
8500ae305e6SDmitry Stogov		}
85127f38798SDmitry Stogov
85227f38798SDmitry Stogov#define Z_PARAM_FUNC(dest_fci, dest_fcc) \
85327f38798SDmitry Stogov	Z_PARAM_FUNC_EX(dest_fci, dest_fcc, 0, 0)
85427f38798SDmitry Stogov
85527f38798SDmitry Stogov/* old "h" */
8560ae305e6SDmitry Stogov#define Z_PARAM_ARRAY_HT_EX(dest, check_null, separate) \
85727f38798SDmitry Stogov		Z_PARAM_PROLOGUE(separate); \
85841e3fdbaSAndrea Faulds		if (UNEXPECTED(!zend_parse_arg_array_ht(_arg, &dest, check_null, 0))) { \
85927f38798SDmitry Stogov			_expected_type = Z_EXPECTED_ARRAY; \
8600ae305e6SDmitry Stogov			error_code = ZPP_ERROR_WRONG_ARG; \
8610ae305e6SDmitry Stogov			break; \
8620ae305e6SDmitry Stogov		}
86327f38798SDmitry Stogov
86427f38798SDmitry Stogov#define Z_PARAM_ARRAY_HT(dest) \
86527f38798SDmitry Stogov	Z_PARAM_ARRAY_HT_EX(dest, 0, 0)
86627f38798SDmitry Stogov
86727f38798SDmitry Stogov/* old "H" */
8680ae305e6SDmitry Stogov#define Z_PARAM_ARRAY_OR_OBJECT_HT_EX(dest, check_null, separate) \
86927f38798SDmitry Stogov		Z_PARAM_PROLOGUE(separate); \
87041e3fdbaSAndrea Faulds		if (UNEXPECTED(!zend_parse_arg_array_ht(_arg, &dest, check_null, 1))) { \
87127f38798SDmitry Stogov			_expected_type = Z_EXPECTED_ARRAY; \
8720ae305e6SDmitry Stogov			error_code = ZPP_ERROR_WRONG_ARG; \
8730ae305e6SDmitry Stogov			break; \
8740ae305e6SDmitry Stogov		}
87527f38798SDmitry Stogov
87627f38798SDmitry Stogov#define Z_PARAM_ARRAY_OR_OBJECT_HT(dest) \
87727f38798SDmitry Stogov	Z_PARAM_ARRAY_OR_OBJECT_HT_EX(dest, 0, 0)
87827f38798SDmitry Stogov
87927f38798SDmitry Stogov/* old "l" */
880c3e3c98eSAnatol Belski#define Z_PARAM_LONG_EX(dest, is_null, check_null, separate) \
88127f38798SDmitry Stogov		Z_PARAM_PROLOGUE(separate); \
88235f9b90bSDmitry Stogov		if (UNEXPECTED(!zend_parse_arg_long(_arg, &dest, &is_null, check_null, 0))) { \
88327f38798SDmitry Stogov			_expected_type = Z_EXPECTED_LONG; \
8840ae305e6SDmitry Stogov			error_code = ZPP_ERROR_WRONG_ARG; \
8850ae305e6SDmitry Stogov			break; \
8860ae305e6SDmitry Stogov		}
88727f38798SDmitry Stogov
888c3e3c98eSAnatol Belski#define Z_PARAM_LONG(dest) \
889c3e3c98eSAnatol Belski	Z_PARAM_LONG_EX(dest, _dummy, 0, 0)
89027f38798SDmitry Stogov
89127f38798SDmitry Stogov/* old "L" */
892c3e3c98eSAnatol Belski#define Z_PARAM_STRICT_LONG_EX(dest, is_null, check_null, separate) \
89327f38798SDmitry Stogov		Z_PARAM_PROLOGUE(separate); \
89435f9b90bSDmitry Stogov		if (UNEXPECTED(!zend_parse_arg_long(_arg, &dest, &is_null, check_null, 1))) { \
89527f38798SDmitry Stogov			_expected_type = Z_EXPECTED_LONG; \
8960ae305e6SDmitry Stogov			error_code = ZPP_ERROR_WRONG_ARG; \
8970ae305e6SDmitry Stogov			break; \
8980ae305e6SDmitry Stogov		}
89927f38798SDmitry Stogov
900c3e3c98eSAnatol Belski#define Z_PARAM_STRICT_LONG(dest) \
901c3e3c98eSAnatol Belski	Z_PARAM_STRICT_LONG_EX(dest, _dummy, 0, 0)
90227f38798SDmitry Stogov
903