zend_API.h revision 050d7e38
1573b4602SAndi Gutmans/*
2573b4602SAndi Gutmans   +----------------------------------------------------------------------+
3573b4602SAndi Gutmans   | Zend Engine                                                          |
4573b4602SAndi Gutmans   +----------------------------------------------------------------------+
5c081ce62SXinchen Hui   | Copyright (c) 1998-2014 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>                            |
18573b4602SAndi Gutmans   +----------------------------------------------------------------------+
19573b4602SAndi Gutmans*/
20573b4602SAndi Gutmans
21333406bdSfoobar/* $Id$ */
22b5b11177SZeev Suraski
23b982307dSSascha Schumann#ifndef ZEND_API_H
24b982307dSSascha Schumann#define ZEND_API_H
25573b4602SAndi Gutmans
267080fa5bSAndi Gutmans#include "zend_modules.h"
27573b4602SAndi Gutmans#include "zend_list.h"
285dba4774SZeev Suraski#include "zend_operators.h"
295dba4774SZeev Suraski#include "zend_variables.h"
30df74f1dfSSascha Schumann#include "zend_execute.h"
31573b4602SAndi Gutmans
320450ab94SZeev Suraski
330450ab94SZeev SuraskiBEGIN_EXTERN_C()
34e9d126a7SAndi Gutmans
35f8bbafd6SZeev Suraskitypedef struct _zend_function_entry {
366c810b0dSDmitry Stogov	const char *fname;
37f8bbafd6SZeev Suraski	void (*handler)(INTERNAL_FUNCTION_PARAMETERS);
386c810b0dSDmitry Stogov	const struct _zend_arg_info *arg_info;
39f8bbafd6SZeev Suraski	zend_uint num_args;
40f8bbafd6SZeev Suraski	zend_uint flags;
41f8bbafd6SZeev Suraski} zend_function_entry;
42f8bbafd6SZeev Suraski
43feb85801SDmitry Stogovtypedef struct _zend_fcall_info {
44feb85801SDmitry Stogov	size_t size;
45feb85801SDmitry Stogov	HashTable *function_table;
46f4cfaf36SDmitry Stogov	zval function_name;
47aa5f5530SDmitry Stogov	zend_array *symbol_table;
48f4cfaf36SDmitry Stogov	zval *retval;
49feb85801SDmitry Stogov	zend_uint param_count;
50f4cfaf36SDmitry Stogov	zval *params;
51ea85451bSDmitry Stogov	zend_object *object;
52feb85801SDmitry Stogov	zend_bool no_separation;
53feb85801SDmitry Stogov} zend_fcall_info;
54feb85801SDmitry Stogov
55feb85801SDmitry Stogovtypedef struct _zend_fcall_info_cache {
56feb85801SDmitry Stogov	zend_bool initialized;
57feb85801SDmitry Stogov	zend_function *function_handler;
58feb85801SDmitry Stogov	zend_class_entry *calling_scope;
59feb85801SDmitry Stogov	zend_class_entry *called_scope;
60ea85451bSDmitry Stogov	zend_object *object;
61feb85801SDmitry Stogov} zend_fcall_info_cache;
62feb85801SDmitry Stogov
6386b36438SJelle Zijlstra#define ZEND_NS_NAME(ns, name)			ns "\\" name
64907fa665SDmitry Stogov
65f8bbafd6SZeev Suraski#define ZEND_FN(name) zif_##name
66637a4042SMarcus Boerger#define ZEND_MN(name) zim_##name
67f8bbafd6SZeev Suraski#define ZEND_NAMED_FUNCTION(name)		void name(INTERNAL_FUNCTION_PARAMETERS)
68f8bbafd6SZeev Suraski#define ZEND_FUNCTION(name)				ZEND_NAMED_FUNCTION(ZEND_FN(name))
69637a4042SMarcus Boerger#define ZEND_METHOD(classname, name)	ZEND_NAMED_FUNCTION(ZEND_MN(classname##_##name))
70f8bbafd6SZeev Suraski
711c2512ddSMarcus Boerger#define ZEND_FENTRY(zend_name, name, arg_info, flags)	{ #zend_name, name, arg_info, (zend_uint) (sizeof(arg_info)/sizeof(struct _zend_arg_info)-1), flags },
721c2512ddSMarcus Boerger
731e19ee87SHannes Magnusson#define ZEND_RAW_FENTRY(zend_name, name, arg_info, flags)   { zend_name, name, arg_info, (zend_uint) (sizeof(arg_info)/sizeof(struct _zend_arg_info)-1), flags },
741e19ee87SHannes Magnusson#define ZEND_RAW_NAMED_FE(zend_name, name, arg_info) ZEND_RAW_FENTRY(#zend_name, name, arg_info, 0)
751e19ee87SHannes Magnusson
761c2512ddSMarcus Boerger#define ZEND_NAMED_FE(zend_name, name, arg_info)	ZEND_FENTRY(zend_name, name, arg_info, 0)
771c2512ddSMarcus Boerger#define ZEND_FE(name, arg_info)						ZEND_FENTRY(name, ZEND_FN(name), arg_info, 0)
78941b0651SMarcus Boerger#define ZEND_DEP_FE(name, arg_info)                 ZEND_FENTRY(name, ZEND_FN(name), arg_info, ZEND_ACC_DEPRECATED)
79cec053f7SMarcus Boerger#define ZEND_FALIAS(name, alias, arg_info)			ZEND_FENTRY(name, ZEND_FN(alias), arg_info, 0)
80941b0651SMarcus Boerger#define ZEND_DEP_FALIAS(name, alias, arg_info)		ZEND_FENTRY(name, ZEND_FN(alias), arg_info, ZEND_ACC_DEPRECATED)
81637a4042SMarcus Boerger#define ZEND_NAMED_ME(zend_name, name, arg_info, flags)	ZEND_FENTRY(zend_name, name, arg_info, flags)
82637a4042SMarcus Boerger#define ZEND_ME(classname, name, arg_info, flags)	ZEND_FENTRY(name, ZEND_MN(classname##_##name), arg_info, flags)
831c2512ddSMarcus Boerger#define ZEND_ABSTRACT_ME(classname, name, arg_info)	ZEND_FENTRY(name, NULL, arg_info, ZEND_ACC_PUBLIC|ZEND_ACC_ABSTRACT)
8433cdc9edSMarcus Boerger#define ZEND_MALIAS(classname, name, alias, arg_info, flags) \
85637a4042SMarcus Boerger                                                    ZEND_FENTRY(name, ZEND_MN(classname##_##alias), arg_info, flags)
86637a4042SMarcus Boerger#define ZEND_ME_MAPPING(name, func_name, arg_types, flags) ZEND_NAMED_ME(name, ZEND_FN(func_name), arg_types, flags)
87f8bbafd6SZeev Suraski
88907fa665SDmitry 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)
89907fa665SDmitry Stogov
90907fa665SDmitry 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)
91907fa665SDmitry Stogov#define ZEND_NS_RAW_NAMED_FE(ns, zend_name, name, arg_info)			ZEND_NS_RAW_FENTRY(ns, #zend_name, name, arg_info, 0)
92907fa665SDmitry Stogov
932d5695cbSSara Golemon#define ZEND_NS_NAMED_FE(ns, zend_name, name, arg_info)	ZEND_NS_FENTRY(ns, zend_name, name, arg_info, 0)
94907fa665SDmitry Stogov#define ZEND_NS_FE(ns, name, arg_info)					ZEND_NS_FENTRY(ns, name, ZEND_FN(name), arg_info, 0)
95907fa665SDmitry Stogov#define ZEND_NS_DEP_FE(ns, name, arg_info)				ZEND_NS_FENTRY(ns, name, ZEND_FN(name), arg_info, ZEND_ACC_DEPRECATED)
96907fa665SDmitry Stogov#define ZEND_NS_FALIAS(ns, name, alias, arg_info)		ZEND_NS_FENTRY(ns, name, ZEND_FN(alias), arg_info, 0)
97907fa665SDmitry Stogov#define ZEND_NS_DEP_FALIAS(ns, name, alias, arg_info)	ZEND_NS_FENTRY(ns, name, ZEND_FN(alias), arg_info, ZEND_ACC_DEPRECATED)
98907fa665SDmitry Stogov
99f1f2a649SFelipe Pena#define ZEND_FE_END            { NULL, NULL, NULL, 0, 0 }
100f1f2a649SFelipe Pena
1010d7a6388SNikita Popov#define ZEND_ARG_INFO(pass_by_ref, name)							{ #name, sizeof(#name)-1, NULL, 0, 0, pass_by_ref, 0, 0 },
1020d7a6388SNikita Popov#define ZEND_ARG_PASS_INFO(pass_by_ref)								{ NULL, 0, NULL, 0, 0, pass_by_ref, 0, 0 },
1030d7a6388SNikita Popov#define ZEND_ARG_OBJ_INFO(pass_by_ref, name, classname, allow_null) { #name, sizeof(#name)-1, #classname, sizeof(#classname)-1, IS_OBJECT, pass_by_ref, allow_null, 0 },
1040d7a6388SNikita Popov#define ZEND_ARG_ARRAY_INFO(pass_by_ref, name, allow_null) { #name, sizeof(#name)-1, NULL, 0, IS_ARRAY, pass_by_ref, allow_null, 0 },
1050d7a6388SNikita Popov#define ZEND_ARG_TYPE_INFO(pass_by_ref, name, type_hint, allow_null) { #name, sizeof(#name)-1, NULL, 0, type_hint, pass_by_ref, allow_null, 0 },
1060d7a6388SNikita Popov#define ZEND_ARG_VARIADIC_INFO(pass_by_ref, name) 					{ #name, sizeof(#name)-1, NULL, 0, 0, pass_by_ref, 0, 1 },
1070d7a6388SNikita Popov
1080d7a6388SNikita Popov#define ZEND_BEGIN_ARG_INFO_EX(name, _unused, return_reference, required_num_args)	\
109fc2fb50dSFelipe Pena	static const zend_arg_info name[] = {																		\
1100d7a6388SNikita Popov		{ NULL, 0, NULL, required_num_args, 0, return_reference, 0, 0 },
1110d7a6388SNikita Popov#define ZEND_BEGIN_ARG_INFO(name, _unused)	\
1120d7a6388SNikita Popov	ZEND_BEGIN_ARG_INFO_EX(name, 0, ZEND_RETURN_VALUE, -1)
113f8bbafd6SZeev Suraski#define ZEND_END_ARG_INFO()		};
114342c6e0bSZeev Suraski
1158b6f848cSAndi Gutmans/* Name macros */
1168b6f848cSAndi Gutmans#define ZEND_MODULE_STARTUP_N(module)       zm_startup_##module
1178b6f848cSAndi Gutmans#define ZEND_MODULE_SHUTDOWN_N(module)		zm_shutdown_##module
1188b6f848cSAndi Gutmans#define ZEND_MODULE_ACTIVATE_N(module)		zm_activate_##module
1198b6f848cSAndi Gutmans#define ZEND_MODULE_DEACTIVATE_N(module)	zm_deactivate_##module
1206535933fSDerick Rethans#define ZEND_MODULE_POST_ZEND_DEACTIVATE_N(module)	zm_post_zend_deactivate_##module
1218b6f848cSAndi Gutmans#define ZEND_MODULE_INFO_N(module)			zm_info_##module
122ada4e506SDmitry Stogov#define ZEND_MODULE_GLOBALS_CTOR_N(module)  zm_globals_ctor_##module
123ada4e506SDmitry Stogov#define ZEND_MODULE_GLOBALS_DTOR_N(module)  zm_globals_dtor_##module
124342c6e0bSZeev Suraski
1258b6f848cSAndi Gutmans/* Declaration macros */
1268b6f848cSAndi Gutmans#define ZEND_MODULE_STARTUP_D(module)		int ZEND_MODULE_STARTUP_N(module)(INIT_FUNC_ARGS)
1278b6f848cSAndi Gutmans#define ZEND_MODULE_SHUTDOWN_D(module)		int ZEND_MODULE_SHUTDOWN_N(module)(SHUTDOWN_FUNC_ARGS)
1288b6f848cSAndi Gutmans#define ZEND_MODULE_ACTIVATE_D(module)		int ZEND_MODULE_ACTIVATE_N(module)(INIT_FUNC_ARGS)
1298b6f848cSAndi Gutmans#define ZEND_MODULE_DEACTIVATE_D(module)	int ZEND_MODULE_DEACTIVATE_N(module)(SHUTDOWN_FUNC_ARGS)
1306535933fSDerick Rethans#define ZEND_MODULE_POST_ZEND_DEACTIVATE_D(module)	int ZEND_MODULE_POST_ZEND_DEACTIVATE_N(module)(void)
1318b6f848cSAndi Gutmans#define ZEND_MODULE_INFO_D(module)			void ZEND_MODULE_INFO_N(module)(ZEND_MODULE_INFO_FUNC_ARGS)
132ada4e506SDmitry Stogov#define ZEND_MODULE_GLOBALS_CTOR_D(module)  void ZEND_MODULE_GLOBALS_CTOR_N(module)(zend_##module##_globals *module##_globals TSRMLS_DC)
133ada4e506SDmitry Stogov#define ZEND_MODULE_GLOBALS_DTOR_D(module)  void ZEND_MODULE_GLOBALS_DTOR_N(module)(zend_##module##_globals *module##_globals TSRMLS_DC)
134342c6e0bSZeev Suraski
1350b6d923bSSascha Schumann#define ZEND_GET_MODULE(name) \
136cb71ac03SHartmut Holzgraefe    BEGIN_EXTERN_C()\
137cb71ac03SHartmut Holzgraefe	ZEND_DLEXPORT zend_module_entry *get_module(void) { return &name##_module_entry; }\
138cb71ac03SHartmut Holzgraefe    END_EXTERN_C()
1390d21940dSZeev Suraski
1400d21940dSZeev Suraski#define ZEND_BEGIN_MODULE_GLOBALS(module_name)		\
1410d21940dSZeev Suraski	typedef struct _zend_##module_name##_globals {
1420d21940dSZeev Suraski#define ZEND_END_MODULE_GLOBALS(module_name)		\
1430d21940dSZeev Suraski	} zend_##module_name##_globals;
1440d21940dSZeev Suraski
1450d21940dSZeev Suraski#ifdef ZTS
1460d21940dSZeev Suraski
1470d21940dSZeev Suraski#define ZEND_DECLARE_MODULE_GLOBALS(module_name)							\
14802af513cSAndi Gutmans	ts_rsrc_id module_name##_globals_id;
14902af513cSAndi Gutmans#define ZEND_EXTERN_MODULE_GLOBALS(module_name)								\
15002af513cSAndi Gutmans	extern ts_rsrc_id module_name##_globals_id;
1510d21940dSZeev Suraski#define ZEND_INIT_MODULE_GLOBALS(module_name, globals_ctor, globals_dtor)	\
1522c254ba7SZeev Suraski	ts_allocate_id(&module_name##_globals_id, sizeof(zend_##module_name##_globals), (ts_allocate_ctor) globals_ctor, (ts_allocate_dtor) globals_dtor);
1530d21940dSZeev Suraski
1540d21940dSZeev Suraski#else
1550d21940dSZeev Suraski
1560d21940dSZeev Suraski#define ZEND_DECLARE_MODULE_GLOBALS(module_name)							\
15702af513cSAndi Gutmans	zend_##module_name##_globals module_name##_globals;
15802af513cSAndi Gutmans#define ZEND_EXTERN_MODULE_GLOBALS(module_name)								\
15902af513cSAndi Gutmans	extern zend_##module_name##_globals module_name##_globals;
1600d21940dSZeev Suraski#define ZEND_INIT_MODULE_GLOBALS(module_name, globals_ctor, globals_dtor)	\
1610d21940dSZeev Suraski	globals_ctor(&module_name##_globals);
1620d21940dSZeev Suraski
1630d21940dSZeev Suraski#endif
1640d21940dSZeev Suraski
165b4892511SJani Taskinen#define INIT_CLASS_ENTRY(class_container, class_name, functions) \
166b4892511SJani Taskinen	INIT_OVERLOADED_CLASS_ENTRY(class_container, class_name, functions, NULL, NULL, NULL)
167741b8161SZeev Suraski
168b4892511SJani Taskinen#define INIT_CLASS_ENTRY_EX(class_container, class_name, class_name_len, functions) \
169b4892511SJani Taskinen	INIT_OVERLOADED_CLASS_ENTRY_EX(class_container, class_name, class_name_len, functions, NULL, NULL, NULL, NULL, NULL)
170b4892511SJani Taskinen
171b4892511SJani 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) \
172741b8161SZeev Suraski	{															\
173f4cfaf36SDmitry Stogov		zend_string *cl_name;									\
174f4cfaf36SDmitry Stogov		cl_name = STR_INIT(class_name, class_name_len, 1);		\
175f4cfaf36SDmitry Stogov		class_container.name = zend_new_interned_string(cl_name TSRMLS_CC);	\
17603a1fcabSXinchen Hui		INIT_CLASS_ENTRY_INIT_METHODS(class_container, functions, handle_fcall, handle_propget, handle_propset, handle_propunset, handle_propisset) \
17703a1fcabSXinchen Hui	}
17803a1fcabSXinchen Hui
17903a1fcabSXinchen Hui#define INIT_CLASS_ENTRY_INIT_METHODS(class_container, functions, handle_fcall, handle_propget, handle_propset, handle_propunset, handle_propisset) \
18003a1fcabSXinchen Hui	{															\
1812eccd95cSAndi Gutmans		class_container.constructor = NULL;						\
18273b159e0SAndi Gutmans		class_container.destructor = NULL;						\
18329ea3da2SAndi Gutmans		class_container.clone = NULL;							\
184637a4042SMarcus Boerger		class_container.serialize = NULL;						\
185637a4042SMarcus Boerger		class_container.unserialize = NULL;						\
186637a4042SMarcus Boerger		class_container.create_object = NULL;					\
1873c62b3b5SMarcus Boerger		class_container.interface_gets_implemented = NULL;		\
18872d0454bSDmitry Stogov		class_container.get_static_method = NULL;				\
189637a4042SMarcus Boerger		class_container.__call = handle_fcall;					\
190b4892511SJani Taskinen		class_container.__callstatic = NULL;					\
191637a4042SMarcus Boerger		class_container.__tostring = NULL;						\
192637a4042SMarcus Boerger		class_container.__get = handle_propget;					\
193637a4042SMarcus Boerger		class_container.__set = handle_propset;					\
194637a4042SMarcus Boerger		class_container.__unset = handle_propunset;				\
195637a4042SMarcus Boerger		class_container.__isset = handle_propisset;				\
196637a4042SMarcus Boerger		class_container.serialize_func = NULL;					\
197637a4042SMarcus Boerger		class_container.unserialize_func = NULL;				\
198637a4042SMarcus Boerger		class_container.serialize = NULL;						\
199637a4042SMarcus Boerger		class_container.unserialize = NULL;						\
200637a4042SMarcus Boerger		class_container.parent = NULL;							\
201637a4042SMarcus Boerger		class_container.num_interfaces = 0;						\
202fdb6077fSFelipe Pena		class_container.traits = NULL;							\
203fdb6077fSFelipe Pena		class_container.num_traits = 0;							\
204fdb6077fSFelipe Pena		class_container.trait_aliases = NULL;					\
205fdb6077fSFelipe Pena		class_container.trait_precedences = NULL;				\
206637a4042SMarcus Boerger		class_container.interfaces = NULL;						\
207637a4042SMarcus Boerger		class_container.get_iterator = NULL;					\
208637a4042SMarcus Boerger		class_container.iterator_funcs.funcs = NULL;			\
209f2df6a4aSDmitry Stogov		class_container.info.internal.module = NULL;			\
210f2df6a4aSDmitry Stogov		class_container.info.internal.builtin_functions = functions;	\
211741b8161SZeev Suraski	}
212741b8161SZeev Suraski
213345e0255SDmitry Stogov#define INIT_OVERLOADED_CLASS_ENTRY(class_container, class_name, functions, handle_fcall, handle_propget, handle_propset) \
214b4892511SJani Taskinen	INIT_OVERLOADED_CLASS_ENTRY_EX(class_container, class_name, sizeof(class_name)-1, functions, handle_fcall, handle_propget, handle_propset, NULL, NULL)
215345e0255SDmitry Stogov
216907fa665SDmitry Stogov#define INIT_NS_CLASS_ENTRY(class_container, ns, class_name, functions) \
217907fa665SDmitry Stogov	INIT_CLASS_ENTRY(class_container, ZEND_NS_NAME(ns, class_name), functions)
218907fa665SDmitry Stogov#define INIT_OVERLOADED_NS_CLASS_ENTRY_EX(class_container, ns, class_name, functions, handle_fcall, handle_propget, handle_propset, handle_propunset, handle_propisset) \
219907fa665SDmitry 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)
220907fa665SDmitry Stogov#define INIT_OVERLOADED_NS_CLASS_ENTRY(class_container, ns, class_name, functions, handle_fcall, handle_propget, handle_propset) \
221907fa665SDmitry Stogov	INIT_OVERLOADED_CLASS_ENTRY(class_container, ZEND_NS_NAME(ns, class_name), functions, handle_fcall, handle_propget, handle_propset)
222907fa665SDmitry Stogov
2238768ab94SDmitry Stogov#ifdef ZTS
224f23e8576SDmitry 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])
2258768ab94SDmitry Stogov#else
226c5237d82SDmitry Stogov#	define CE_STATIC_MEMBERS(ce) ((ce)->static_members_table)
2278768ab94SDmitry Stogov#endif
2288768ab94SDmitry Stogov
229b4892511SJani Taskinen#define ZEND_FCI_INITIALIZED(fci) ((fci).size != 0)
230b4892511SJani Taskinen
231573b4602SAndi Gutmansint zend_next_free_module(void);
232573b4602SAndi Gutmans
2331727c6a2SHartmut HolzgraefeBEGIN_EXTERN_C()
234f77e6a44SZeev SuraskiZEND_API int zend_get_parameters(int ht, int param_count, ...);
235f4cfaf36SDmitry StogovZEND_API int _zend_get_parameters_array(int ht, int param_count, zval *argument_array TSRMLS_DC);
236e59bfcffSStanislav MalyshevZEND_API ZEND_ATTRIBUTE_DEPRECATED int zend_get_parameters_ex(int param_count, ...);
237f4cfaf36SDmitry StogovZEND_API int _zend_get_parameters_array_ex(int param_count, zval *argument_array TSRMLS_DC);
23811e5d2f2SZeev Suraski
239e39f3f3fSMarcus Boerger/* internal function to efficiently copy parameters when executing __call() */
240e39f3f3fSMarcus BoergerZEND_API int zend_copy_parameters_array(int param_count, zval *argument_array TSRMLS_DC);
241e39f3f3fSMarcus Boerger
24211e5d2f2SZeev Suraski#define zend_get_parameters_array(ht, param_count, argument_array)			\
24311e5d2f2SZeev Suraski	_zend_get_parameters_array(ht, param_count, argument_array TSRMLS_CC)
24411e5d2f2SZeev Suraski#define zend_get_parameters_array_ex(param_count, argument_array)			\
24511e5d2f2SZeev Suraski	_zend_get_parameters_array_ex(param_count, argument_array TSRMLS_CC)
246cc2b17d5SFelipe Pena#define zend_parse_parameters_none()										\
247cc2b17d5SFelipe Pena	zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "")
24858f88057SAndrei Zmievski
24958f88057SAndrei Zmievski/* Parameter parsing API -- andrei */
25058f88057SAndrei Zmievski
25158f88057SAndrei Zmievski#define ZEND_PARSE_PARAMS_QUIET 1<<1
252aaa2f1c3SHartmut HolzgraefeZEND_API int zend_parse_parameters(int num_args TSRMLS_DC, const char *type_spec, ...);
253aaa2f1c3SHartmut HolzgraefeZEND_API int zend_parse_parameters_ex(int flags, int num_args TSRMLS_DC, const char *type_spec, ...);
254cf7384aaSFelipe PenaZEND_API char *zend_zval_type_name(const zval *arg);
25558f88057SAndrei Zmievski
256aaa2f1c3SHartmut HolzgraefeZEND_API int zend_parse_method_parameters(int num_args TSRMLS_DC, zval *this_ptr, const char *type_spec, ...);
257aaa2f1c3SHartmut HolzgraefeZEND_API int zend_parse_method_parameters_ex(int flags, int num_args TSRMLS_DC, zval *this_ptr, const char *type_spec, ...);
258c4528f82SHarald Radi
259f4cfaf36SDmitry StogovZEND_API int zend_parse_parameter(int flags, int arg_num TSRMLS_DC, zval *arg, const char *spec, ...);
26013f1d53bSGustavo André dos Santos Lopes
261b5255495SZeev Suraski/* End of parameter parsing API -- andrei */
26239f9487eSAndi Gutmans
2636c810b0dSDmitry StogovZEND_API int zend_register_functions(zend_class_entry *scope, const zend_function_entry *functions, HashTable *function_table, int type TSRMLS_DC);
2646c810b0dSDmitry StogovZEND_API void zend_unregister_functions(const zend_function_entry *functions, int count, HashTable *function_table TSRMLS_DC);
2650fc8e6afSKalle Sommer NielsenZEND_API int zend_startup_module(zend_module_entry *module_entry TSRMLS_DC);
26670bd938bSDmitry StogovZEND_API zend_module_entry* zend_register_internal_module(zend_module_entry *module_entry TSRMLS_DC);
26770bd938bSDmitry StogovZEND_API zend_module_entry* zend_register_module_ex(zend_module_entry *module TSRMLS_DC);
2682ca2dc0bSDmitry StogovZEND_API int zend_startup_module_ex(zend_module_entry *module TSRMLS_DC);
269c0c7a9f0SDmitry StogovZEND_API int zend_startup_modules(TSRMLS_D);
2703690ce39SDmitry StogovZEND_API void zend_collect_module_handlers(TSRMLS_D);
2711a1178a6SDmitry StogovZEND_API void zend_destroy_modules(void);
272cf7384aaSFelipe PenaZEND_API void zend_check_magic_method_implementation(const zend_class_entry *ce, const zend_function *fptr, int error_type TSRMLS_DC);
273eb0e6946SAndi Gutmans
274b5770382SZeev SuraskiZEND_API zend_class_entry *zend_register_internal_class(zend_class_entry *class_entry TSRMLS_DC);
275f4cfaf36SDmitry StogovZEND_API zend_class_entry *zend_register_internal_class_ex(zend_class_entry *class_entry, zend_class_entry *parent_ce TSRMLS_DC);
2763c62b3b5SMarcus BoergerZEND_API zend_class_entry *zend_register_internal_interface(zend_class_entry *orig_class_entry TSRMLS_DC);
2774073a084SMarcus BoergerZEND_API void zend_class_implements(zend_class_entry *class_entry TSRMLS_DC, int num_interfaces, ...);
278eb0e6946SAndi Gutmans
279cf7384aaSFelipe PenaZEND_API int zend_register_class_alias_ex(const char *name, int name_len, zend_class_entry *ce TSRMLS_DC);
280907fa665SDmitry Stogov
281907fa665SDmitry Stogov#define zend_register_class_alias(name, ce) \
28293fd9c70SJohannes Schlüter	zend_register_class_alias_ex(name, sizeof(name)-1, ce TSRMLS_CC)
283907fa665SDmitry Stogov#define zend_register_ns_class_alias(ns, name, ce) \
28493fd9c70SJohannes Schlüter	zend_register_class_alias_ex(ZEND_NS_NAME(ns, name), sizeof(ZEND_NS_NAME(ns, name))-1, ce TSRMLS_CC)
285907fa665SDmitry Stogov
286d76cf1daSZeev SuraskiZEND_API int zend_disable_function(char *function_name, uint function_name_length TSRMLS_DC);
287a700180fSHarald RadiZEND_API int zend_disable_class(char *class_name, uint class_name_length TSRMLS_DC);
288573b4602SAndi Gutmans
2894187439cSZeev SuraskiZEND_API void zend_wrong_param_count(TSRMLS_D);
290c81db6bcSDmitry Stogov
291c81db6bcSDmitry Stogov#define IS_CALLABLE_CHECK_SYNTAX_ONLY (1<<0)
292c81db6bcSDmitry Stogov#define IS_CALLABLE_CHECK_NO_ACCESS   (1<<1)
29353e52606SMarcus Boerger#define IS_CALLABLE_CHECK_IS_STATIC   (1<<2)
294af05ce0aSDmitry Stogov#define IS_CALLABLE_CHECK_SILENT      (1<<3)
295c81db6bcSDmitry Stogov
2960cd997d7SMarcus Boerger#define IS_CALLABLE_STRICT  (IS_CALLABLE_CHECK_IS_STATIC)
2970cd997d7SMarcus Boerger
298ea85451bSDmitry StogovZEND_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 TSRMLS_DC);
299639e4e1aSDmitry StogovZEND_API zend_bool zend_is_callable(zval *callable, uint check_flags, zend_string **callable_name TSRMLS_DC);
300639e4e1aSDmitry StogovZEND_API zend_bool zend_make_callable(zval *callable, zend_string **callable_name TSRMLS_DC);
3016c810b0dSDmitry StogovZEND_API const char *zend_get_module_version(const char *module_name);
302cf7384aaSFelipe PenaZEND_API int zend_get_module_started(const char *module_name);
303f4cfaf36SDmitry StogovZEND_API int zend_declare_property_ex(zend_class_entry *ce, zend_string *name, zval *property, int access_type, zend_string *doc_comment TSRMLS_DC);
3044a25a774SDmitry StogovZEND_API int zend_declare_property(zend_class_entry *ce, const char *name, int name_length, zval *property, int access_type TSRMLS_DC);
3054a25a774SDmitry StogovZEND_API int zend_declare_property_null(zend_class_entry *ce, const char *name, int name_length, int access_type TSRMLS_DC);
3064a25a774SDmitry StogovZEND_API int zend_declare_property_bool(zend_class_entry *ce, const char *name, int name_length, long value, int access_type TSRMLS_DC);
3074a25a774SDmitry StogovZEND_API int zend_declare_property_long(zend_class_entry *ce, const char *name, int name_length, long value, int access_type TSRMLS_DC);
3084a25a774SDmitry StogovZEND_API int zend_declare_property_double(zend_class_entry *ce, const char *name, int name_length, double value, int access_type TSRMLS_DC);
3094a25a774SDmitry StogovZEND_API int zend_declare_property_string(zend_class_entry *ce, const char *name, int name_length, const char *value, int access_type TSRMLS_DC);
3104a25a774SDmitry StogovZEND_API int zend_declare_property_stringl(zend_class_entry *ce, const char *name, int name_length, const char *value, int value_len, int access_type TSRMLS_DC);
31113433852SZeev Suraski
312cf7384aaSFelipe PenaZEND_API int zend_declare_class_constant(zend_class_entry *ce, const char *name, size_t name_length, zval *value TSRMLS_DC);
313cf7384aaSFelipe PenaZEND_API int zend_declare_class_constant_null(zend_class_entry *ce, const char *name, size_t name_length TSRMLS_DC);
314cf7384aaSFelipe PenaZEND_API int zend_declare_class_constant_long(zend_class_entry *ce, const char *name, size_t name_length, long value TSRMLS_DC);
315cf7384aaSFelipe PenaZEND_API int zend_declare_class_constant_bool(zend_class_entry *ce, const char *name, size_t name_length, zend_bool value TSRMLS_DC);
316cf7384aaSFelipe PenaZEND_API int zend_declare_class_constant_double(zend_class_entry *ce, const char *name, size_t name_length, double value TSRMLS_DC);
317cf7384aaSFelipe PenaZEND_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 TSRMLS_DC);
318cf7384aaSFelipe PenaZEND_API int zend_declare_class_constant_string(zend_class_entry *ce, const char *name, size_t name_length, const char *value TSRMLS_DC);
319248345d9SDmitry Stogov
3201d5c13bdSMarcus BoergerZEND_API void zend_update_class_constants(zend_class_entry *class_type TSRMLS_DC);
3214a25a774SDmitry StogovZEND_API void zend_update_property(zend_class_entry *scope, zval *object, const char *name, int name_length, zval *value TSRMLS_DC);
3224a25a774SDmitry StogovZEND_API void zend_update_property_null(zend_class_entry *scope, zval *object, const char *name, int name_length TSRMLS_DC);
3234a25a774SDmitry StogovZEND_API void zend_update_property_bool(zend_class_entry *scope, zval *object, const char *name, int name_length, long value TSRMLS_DC);
3244a25a774SDmitry StogovZEND_API void zend_update_property_long(zend_class_entry *scope, zval *object, const char *name, int name_length, long value TSRMLS_DC);
3254a25a774SDmitry StogovZEND_API void zend_update_property_double(zend_class_entry *scope, zval *object, const char *name, int name_length, double value TSRMLS_DC);
3266fbea9ceSDmitry StogovZEND_API void zend_update_property_str(zend_class_entry *scope, zval *object, const char *name, int name_length, zend_string *value TSRMLS_DC);
3274a25a774SDmitry StogovZEND_API void zend_update_property_string(zend_class_entry *scope, zval *object, const char *name, int name_length, const char *value TSRMLS_DC);
3284a25a774SDmitry StogovZEND_API void zend_update_property_stringl(zend_class_entry *scope, zval *object, const char *name, int name_length, const char *value, int value_length TSRMLS_DC);
3294a25a774SDmitry Stogov
3304a25a774SDmitry StogovZEND_API int zend_update_static_property(zend_class_entry *scope, const char *name, int name_length, zval *value TSRMLS_DC);
3314a25a774SDmitry StogovZEND_API int zend_update_static_property_null(zend_class_entry *scope, const char *name, int name_length TSRMLS_DC);
3324a25a774SDmitry StogovZEND_API int zend_update_static_property_bool(zend_class_entry *scope, const char *name, int name_length, long value TSRMLS_DC);
3334a25a774SDmitry StogovZEND_API int zend_update_static_property_long(zend_class_entry *scope, const char *name, int name_length, long value TSRMLS_DC);
3344a25a774SDmitry StogovZEND_API int zend_update_static_property_double(zend_class_entry *scope, const char *name, int name_length, double value TSRMLS_DC);
3354a25a774SDmitry StogovZEND_API int zend_update_static_property_string(zend_class_entry *scope, const char *name, int name_length, const char *value TSRMLS_DC);
3364a25a774SDmitry StogovZEND_API int zend_update_static_property_stringl(zend_class_entry *scope, const char *name, int name_length, const char *value, int value_length TSRMLS_DC);
3374a25a774SDmitry Stogov
3384a25a774SDmitry StogovZEND_API zval *zend_read_property(zend_class_entry *scope, zval *object, const char *name, int name_length, zend_bool silent TSRMLS_DC);
3394a25a774SDmitry Stogov
3404a25a774SDmitry StogovZEND_API zval *zend_read_static_property(zend_class_entry *scope, const char *name, int name_length, zend_bool silent TSRMLS_DC);
341248345d9SDmitry Stogov
342ea85451bSDmitry StogovZEND_API zend_class_entry *zend_get_class_entry(const zend_object *object TSRMLS_DC);
343ea85451bSDmitry StogovZEND_API zend_string *zend_get_object_classname(const zend_object *object TSRMLS_DC);
3449dd24c6dSAntony DovgalZEND_API char *zend_get_type_by_const(int type);
3456ac6cb10SHarald Radi
346ea85451bSDmitry Stogov#define getThis() (Z_OBJ(EG(This)) ? &EG(This) : NULL)
347741b8161SZeev Suraski
348131d9cb2SZeev Suraski#define WRONG_PARAM_COUNT					ZEND_WRONG_PARAM_COUNT()
349131d9cb2SZeev Suraski#define WRONG_PARAM_COUNT_WITH_RETVAL(ret)	ZEND_WRONG_PARAM_COUNT_WITH_RETVAL(ret)
350f4cfaf36SDmitry Stogov#define ARG_COUNT(dummy)	(param_count)
351f4cfaf36SDmitry Stogov#define ZEND_NUM_ARGS()		(param_count)
3524187439cSZeev Suraski#define ZEND_WRONG_PARAM_COUNT()					{ zend_wrong_param_count(TSRMLS_C); return; }
3534187439cSZeev Suraski#define ZEND_WRONG_PARAM_COUNT_WITH_RETVAL(ret)		{ zend_wrong_param_count(TSRMLS_C); return ret; }
354573b4602SAndi Gutmans
35580bdd19eSZeev Suraski#ifndef ZEND_WIN32
356573b4602SAndi Gutmans#define DLEXPORT
357573b4602SAndi Gutmans#endif
358573b4602SAndi Gutmans
3597da75d81SMatt Wilmas#define array_init(arg)			_array_init((arg), 0 ZEND_FILE_LINE_CC)
3607da75d81SMatt Wilmas#define array_init_size(arg, size) _array_init((arg), (size) ZEND_FILE_LINE_CC)
361fcc03510SZeev Suraski#define object_init(arg)		_object_init((arg) ZEND_FILE_LINE_CC TSRMLS_CC)
362fcc03510SZeev Suraski#define object_init_ex(arg, ce)	_object_init_ex((arg), (ce) ZEND_FILE_LINE_CC TSRMLS_CC)
36376a7a5bcSAndi Gutmans#define object_and_properties_init(arg, ce, properties)	_object_and_properties_init((arg), (ce), (properties) ZEND_FILE_LINE_CC TSRMLS_CC)
3647da75d81SMatt WilmasZEND_API int _array_init(zval *arg, uint size ZEND_FILE_LINE_DC);
365fcc03510SZeev SuraskiZEND_API int _object_init(zval *arg ZEND_FILE_LINE_DC TSRMLS_DC);
366fcc03510SZeev SuraskiZEND_API int _object_init_ex(zval *arg, zend_class_entry *ce ZEND_FILE_LINE_DC TSRMLS_DC);
36776a7a5bcSAndi GutmansZEND_API int _object_and_properties_init(zval *arg, zend_class_entry *ce, HashTable *properties ZEND_FILE_LINE_DC TSRMLS_DC);
368c5237d82SDmitry StogovZEND_API void object_properties_init(zend_object *object, zend_class_entry *class_type);
36920f2e598SNikita PopovZEND_API void object_properties_init_ex(zend_object *object, HashTable *properties TSRMLS_DC);
37020f2e598SNikita PopovZEND_API void object_properties_load(zend_object *object, HashTable *properties TSRMLS_DC);
3716847fefaSThies C. Arntzen
372047a574eSMarcus BoergerZEND_API void zend_merge_properties(zval *obj, HashTable *properties, int destroy_ht TSRMLS_DC);
373047a574eSMarcus Boerger
3746847fefaSThies C. Arntzen/* no longer supported */
3756c810b0dSDmitry StogovZEND_API int add_assoc_function(zval *arg, const char *key, void (*function_ptr)(INTERNAL_FUNCTION_PARAMETERS));
3766847fefaSThies C. Arntzen
3776c810b0dSDmitry StogovZEND_API int add_assoc_long_ex(zval *arg, const char *key, uint key_len, long n);
3786c810b0dSDmitry StogovZEND_API int add_assoc_null_ex(zval *arg, const char *key, uint key_len);
3796c810b0dSDmitry StogovZEND_API int add_assoc_bool_ex(zval *arg, const char *key, uint key_len, int b);
380f4cfaf36SDmitry StogovZEND_API int add_assoc_resource_ex(zval *arg, const char *key, uint key_len, zend_resource *r);
3816c810b0dSDmitry StogovZEND_API int add_assoc_double_ex(zval *arg, const char *key, uint key_len, double d);
382f4cfaf36SDmitry StogovZEND_API int add_assoc_str_ex(zval *arg, const char *key, uint key_len, zend_string *str);
383050d7e38SDmitry StogovZEND_API int add_assoc_string_ex(zval *arg, const char *key, uint key_len, char *str);
384050d7e38SDmitry StogovZEND_API int add_assoc_stringl_ex(zval *arg, const char *key, uint key_len, char *str, uint length);
3856c810b0dSDmitry StogovZEND_API int add_assoc_zval_ex(zval *arg, const char *key, uint key_len, zval *value);
386ef95a346SAndi Gutmans
387f4cfaf36SDmitry Stogov#define add_assoc_long(__arg, __key, __n) add_assoc_long_ex(__arg, __key, strlen(__key), __n)
388f4cfaf36SDmitry Stogov#define add_assoc_null(__arg, __key) add_assoc_null_ex(__arg, __key, strlen(__key))
389f4cfaf36SDmitry Stogov#define add_assoc_bool(__arg, __key, __b) add_assoc_bool_ex(__arg, __key, strlen(__key), __b)
390f4cfaf36SDmitry Stogov#define add_assoc_resource(__arg, __key, __r) add_assoc_resource_ex(__arg, __key, strlen(__key), __r)
391f4cfaf36SDmitry Stogov#define add_assoc_double(__arg, __key, __d) add_assoc_double_ex(__arg, __key, strlen(__key), __d)
392f4cfaf36SDmitry Stogov#define add_assoc_str(__arg, __key, __str) add_assoc_str_ex(__arg, __key, strlen(__key), __str)
393050d7e38SDmitry Stogov#define add_assoc_string(__arg, __key, __str) add_assoc_string_ex(__arg, __key, strlen(__key), __str)
394050d7e38SDmitry Stogov#define add_assoc_stringl(__arg, __key, __str, __length) add_assoc_stringl_ex(__arg, __key, strlen(__key), __str, __length)
395f4cfaf36SDmitry Stogov#define add_assoc_zval(__arg, __key, __value) add_assoc_zval_ex(__arg, __key, strlen(__key), __value)
3966847fefaSThies C. Arntzen
3970611acb9SAndi Gutmans/* unset() functions are only suported for legacy modules and null() functions should be used */
398f4cfaf36SDmitry Stogov#define add_assoc_unset(__arg, __key) add_assoc_null_ex(__arg, __key, strlen(__key))
3990611acb9SAndi Gutmans#define add_index_unset(__arg, __key) add_index_null(__arg, __key)
4000611acb9SAndi Gutmans#define add_next_index_unset(__arg) add_next_index_null(__arg)
4010611acb9SAndi Gutmans#define add_property_unset(__arg, __key) add_property_null(__arg, __key)
4020611acb9SAndi Gutmans
403b05b949aSDmitry StogovZEND_API int add_index_long(zval *arg, ulong idx, long n);
404b05b949aSDmitry StogovZEND_API int add_index_null(zval *arg, ulong idx);
405b05b949aSDmitry StogovZEND_API int add_index_bool(zval *arg, ulong idx, int b);
406f4cfaf36SDmitry StogovZEND_API int add_index_resource(zval *arg, ulong idx, zend_resource *r);
407b05b949aSDmitry StogovZEND_API int add_index_double(zval *arg, ulong idx, double d);
408f4cfaf36SDmitry StogovZEND_API int add_index_str(zval *arg, ulong idx, zend_string *str);
409050d7e38SDmitry StogovZEND_API int add_index_string(zval *arg, ulong idx, const char *str);
410050d7e38SDmitry StogovZEND_API int add_index_stringl(zval *arg, ulong idx, const char *str, uint length);
411b05b949aSDmitry StogovZEND_API int add_index_zval(zval *arg, ulong index, zval *value);
4126847fefaSThies C. Arntzen
413573b4602SAndi GutmansZEND_API int add_next_index_long(zval *arg, long n);
4140611acb9SAndi GutmansZEND_API int add_next_index_null(zval *arg);
4156847fefaSThies C. ArntzenZEND_API int add_next_index_bool(zval *arg, int b);
416f4cfaf36SDmitry StogovZEND_API int add_next_index_resource(zval *arg, zend_resource *r);
417573b4602SAndi GutmansZEND_API int add_next_index_double(zval *arg, double d);
418f4cfaf36SDmitry StogovZEND_API int add_next_index_str(zval *arg, zend_string *str);
419050d7e38SDmitry StogovZEND_API int add_next_index_string(zval *arg, const char *str);
420050d7e38SDmitry StogovZEND_API int add_next_index_stringl(zval *arg, const char *str, uint length);
421ef95a346SAndi GutmansZEND_API int add_next_index_zval(zval *arg, zval *value);
422ef95a346SAndi Gutmans
423050d7e38SDmitry StogovZEND_API zval *add_get_assoc_string_ex(zval *arg, const char *key, uint key_len, const char *str);
424050d7e38SDmitry StogovZEND_API zval *add_get_assoc_stringl_ex(zval *arg, const char *key, uint key_len, const char *str, uint length);
425ef95a346SAndi Gutmans
426050d7e38SDmitry Stogov#define add_get_assoc_string(__arg, __key, __str) add_get_assoc_string_ex(__arg, __key, strlen(__key), __str)
427050d7e38SDmitry Stogov#define add_get_assoc_stringl(__arg, __key, __str, __length) add_get_assoc_stringl_ex(__arg, __key, strlen(__key), __str, __length)
428573b4602SAndi Gutmans
429f4cfaf36SDmitry StogovZEND_API zval *add_get_index_long(zval *arg, ulong idx, long l);
430f4cfaf36SDmitry StogovZEND_API zval *add_get_index_double(zval *arg, ulong idx, double d);
431f4cfaf36SDmitry StogovZEND_API zval *add_get_index_str(zval *arg, ulong index, zend_string *str);
432050d7e38SDmitry StogovZEND_API zval *add_get_index_string(zval *arg, ulong idx, const char *str);
433050d7e38SDmitry StogovZEND_API zval *add_get_index_stringl(zval *arg, ulong idx, const char *str, uint length);
434573b4602SAndi Gutmans
43520f2e598SNikita PopovZEND_API int array_set_zval_key(HashTable *ht, zval *key, zval *value TSRMLS_DC);
436fcc6611dSNikita Popov
437cf7384aaSFelipe PenaZEND_API int add_property_long_ex(zval *arg, const char *key, uint key_len, long l TSRMLS_DC);
438cf7384aaSFelipe PenaZEND_API int add_property_null_ex(zval *arg, const char *key, uint key_len TSRMLS_DC);
439cf7384aaSFelipe PenaZEND_API int add_property_bool_ex(zval *arg, const char *key, uint key_len, int b TSRMLS_DC);
440f4cfaf36SDmitry StogovZEND_API int add_property_resource_ex(zval *arg, const char *key, uint key_len, zend_resource *r TSRMLS_DC);
441cf7384aaSFelipe PenaZEND_API int add_property_double_ex(zval *arg, const char *key, uint key_len, double d TSRMLS_DC);
442050d7e38SDmitry StogovZEND_API int add_property_string_ex(zval *arg, const char *key, uint key_len, const char *str TSRMLS_DC);
443050d7e38SDmitry StogovZEND_API int add_property_stringl_ex(zval *arg, const char *key, uint key_len,  const char *str, uint length TSRMLS_DC);
444cf7384aaSFelipe PenaZEND_API int add_property_zval_ex(zval *arg, const char *key, uint key_len, zval *value TSRMLS_DC);
445eccc5368SStanislav Malyshev
446f4cfaf36SDmitry Stogov#define add_property_long(__arg, __key, __n) add_property_long_ex(__arg, __key, strlen(__key), __n TSRMLS_CC)
447f4cfaf36SDmitry Stogov#define add_property_null(__arg, __key) add_property_null_ex(__arg, __key, strlen(__key) TSRMLS_CC)
448f4cfaf36SDmitry Stogov#define add_property_bool(__arg, __key, __b) add_property_bool_ex(__arg, __key, strlen(__key), __b TSRMLS_CC)
449f4cfaf36SDmitry Stogov#define add_property_resource(__arg, __key, __r) add_property_resource_ex(__arg, __key, strlen(__key), __r TSRMLS_CC)
450f4cfaf36SDmitry Stogov#define add_property_double(__arg, __key, __d) add_property_double_ex(__arg, __key, strlen(__key), __d TSRMLS_CC)
451050d7e38SDmitry Stogov#define add_property_string(__arg, __key, __str) add_property_string_ex(__arg, __key, strlen(__key), __str TSRMLS_CC)
452050d7e38SDmitry Stogov#define add_property_stringl(__arg, __key, __str, __length) add_property_stringl_ex(__arg, __key, strlen(__key), __str, __length TSRMLS_CC)
453f4cfaf36SDmitry Stogov#define add_property_zval(__arg, __key, __value) add_property_zval_ex(__arg, __key, strlen(__key), __value TSRMLS_CC)
454ef95a346SAndi Gutmans
45592b4013eSZeev Suraski
456f4cfaf36SDmitry StogovZEND_API int call_user_function(HashTable *function_table, zval *object, zval *function_name, zval *retval_ptr, zend_uint param_count, zval params[] TSRMLS_DC);
457aa5f5530SDmitry StogovZEND_API int call_user_function_ex(HashTable *function_table, zval *object, zval *function_name, zval *retval_ptr, zend_uint param_count, zval params[], int no_separation, zend_array *symbol_table TSRMLS_DC);
45892b4013eSZeev Suraski
459f87d4530SNuno LopesZEND_API extern const zend_fcall_info empty_fcall_info;
460f87d4530SNuno LopesZEND_API extern const zend_fcall_info_cache empty_fcall_info_cache;
46192b4013eSZeev Suraski
46264c353abSMarcus Boerger/** Build zend_call_info/cache from a zval*
46364c353abSMarcus Boerger *
46464c353abSMarcus Boerger * Caller is responsible to provide a return value, otherwise the we will crash.
46564c353abSMarcus Boerger * fci->retval_ptr_ptr = NULL;
46664c353abSMarcus Boerger * In order to pass parameters the following members need to be set:
46764c353abSMarcus Boerger * fci->param_count = 0;
46864c353abSMarcus Boerger * fci->params = NULL;
469b4892511SJani Taskinen * The callable_name argument may be NULL.
470e8a8acdfSMarcus Boerger * Set check_flags to IS_CALLABLE_STRICT for every new usage!
471b4892511SJani Taskinen */
472639e4e1aSDmitry StogovZEND_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 TSRMLS_DC);
473b4892511SJani Taskinen
47404145dc2SVeres Lajos/** Clear arguments connected with zend_fcall_info *fci
475b4892511SJani Taskinen * If free_mem is not zero then the params array gets free'd as well
476b4892511SJani Taskinen */
477b4892511SJani TaskinenZEND_API void zend_fcall_info_args_clear(zend_fcall_info *fci, int free_mem);
478b4892511SJani Taskinen
479b4892511SJani Taskinen/** Save current arguments from zend_fcall_info *fci
480b4892511SJani Taskinen * params array will be set to NULL
481b4892511SJani Taskinen */
482f4cfaf36SDmitry StogovZEND_API void zend_fcall_info_args_save(zend_fcall_info *fci, int *param_count, zval **params);
483b4892511SJani Taskinen
484b4892511SJani Taskinen/** Free arguments connected with zend_fcall_info *fci andset back saved ones.
48564c353abSMarcus Boerger */
486f4cfaf36SDmitry StogovZEND_API void zend_fcall_info_args_restore(zend_fcall_info *fci, int param_count, zval *params);
48764c353abSMarcus Boerger
48864c353abSMarcus Boerger/** Set or clear the arguments in the zend_call_info struct taking care of
48964c353abSMarcus Boerger * refcount. If args is NULL and arguments are set then those are cleared.
49064c353abSMarcus Boerger */
49164c353abSMarcus BoergerZEND_API int zend_fcall_info_args(zend_fcall_info *fci, zval *args TSRMLS_DC);
49264c353abSMarcus Boerger
493b4892511SJani Taskinen/** Set arguments in the zend_fcall_info struct taking care of refcount.
494b4892511SJani Taskinen * If argc is 0 the arguments which are set will be cleared, else pass
495b4892511SJani Taskinen * a variable amount of zval** arguments.
496b4892511SJani Taskinen */
497f4cfaf36SDmitry StogovZEND_API int zend_fcall_info_argp(zend_fcall_info *fci TSRMLS_DC, int argc, zval *argv);
498b4892511SJani Taskinen
499b4892511SJani Taskinen/** Set arguments in the zend_fcall_info struct taking care of refcount.
500b4892511SJani Taskinen * If argc is 0 the arguments which are set will be cleared, else pass
501b4892511SJani Taskinen * a variable amount of zval** arguments.
502b4892511SJani Taskinen */
503b4892511SJani TaskinenZEND_API int zend_fcall_info_argv(zend_fcall_info *fci TSRMLS_DC, int argc, va_list *argv);
504b4892511SJani Taskinen
505b4892511SJani Taskinen/** Set arguments in the zend_fcall_info struct taking care of refcount.
506b4892511SJani Taskinen * If argc is 0 the arguments which are set will be cleared, else pass
507b4892511SJani Taskinen * a variable amount of zval** arguments.
508b4892511SJani Taskinen */
509b4892511SJani TaskinenZEND_API int zend_fcall_info_argn(zend_fcall_info *fci TSRMLS_DC, int argc, ...);
510b4892511SJani Taskinen
51164c353abSMarcus Boerger/** Call a function using information created by zend_fcall_info_init()/args().
51204145dc2SVeres Lajos * If args is given then those replace the argument info in fci is temporarily.
51364c353abSMarcus Boerger */
514f4cfaf36SDmitry StogovZEND_API int zend_fcall_info_call(zend_fcall_info *fci, zend_fcall_info_cache *fcc, zval *retval, zval *args TSRMLS_DC);
51564c353abSMarcus Boerger
51692b4013eSZeev SuraskiZEND_API int zend_call_function(zend_fcall_info *fci, zend_fcall_info_cache *fci_cache TSRMLS_DC);
51792b4013eSZeev Suraski
518cf7384aaSFelipe PenaZEND_API int zend_set_hash_symbol(zval *symbol, const char *name, int name_length, zend_bool is_ref, int num_symbol_tables, ...);
519f962a35dSAndrei Zmievski
520f4cfaf36SDmitry StogovZEND_API int zend_delete_global_variable(zend_string *name TSRMLS_DC);
521453b49edSDmitry Stogov
5222ecf4bb0SDmitry StogovZEND_API void zend_rebuild_symbol_table(TSRMLS_D);
523887189caSDmitry StogovZEND_API void zend_attach_symbol_table(TSRMLS_D);
524887189caSDmitry StogovZEND_API void zend_detach_symbol_table(TSRMLS_D);
5256b2ed577SDmitry StogovZEND_API int zend_set_local_var(zend_string *name, zval *value, int force TSRMLS_DC);
5266b2ed577SDmitry StogovZEND_API int zend_set_local_var_str(const char *name, int len, zval *value, int force TSRMLS_DC);
5272ecf4bb0SDmitry Stogov
528f4cfaf36SDmitry StogovZEND_API zend_string *zend_find_alias_name(zend_class_entry *ce, zend_string *name);
529f4cfaf36SDmitry StogovZEND_API zend_string *zend_resolve_method_name(zend_class_entry *ce, zend_function *f);
5307dce0194SXinchen Hui
5314f6c95d1SZeev Suraski#define add_method(arg, key, method)	add_assoc_function((arg), (key), (method))
532573b4602SAndi Gutmans
533a35c61afSAndrei ZmievskiZEND_API ZEND_FUNCTION(display_disabled_function);
534a700180fSHarald RadiZEND_API ZEND_FUNCTION(display_disabled_class);
5351727c6a2SHartmut HolzgraefeEND_EXTERN_C()
536a35c61afSAndrei Zmievski
537bcddfd47SThies C. Arntzen#if ZEND_DEBUG
538050d7e38SDmitry Stogov#define CHECK_ZVAL_STRING(str) \
539050d7e38SDmitry Stogov	if ((str)->val[(str)->len] != '\0') { zend_error(E_WARNING, "String is not zero-terminated (%s)", (str)->val); }
540050d7e38SDmitry Stogov#define CHECK_ZVAL_STRING_REL(str) \
541050d7e38SDmitry Stogov	if ((str)->val[(str)->len] != '\0') { zend_error(E_WARNING, "String is not zero-terminated (%s) (source: %s:%d)", (str)->val ZEND_FILE_LINE_RELAY_CC); }
542bcddfd47SThies C. Arntzen#else
543bcddfd47SThies C. Arntzen#define CHECK_ZVAL_STRING(z)
54443ebb868SZeev Suraski#define CHECK_ZVAL_STRING_REL(z)
545bcddfd47SThies C. Arntzen#endif
546bcddfd47SThies C. Arntzen
54732b5f8a1SFelipe Pena#define CHECK_ZVAL_NULL_PATH(p) (Z_STRLEN_P(p) != strlen(Z_STRVAL_P(p)))
54832b5f8a1SFelipe Pena#define CHECK_NULL_PATH(p, l) (strlen(p) != l)
54932b5f8a1SFelipe Pena
550f4cfaf36SDmitry Stogov#define ZVAL_STRINGL(z, s, l) do {				\
55176cc99feSDmitry Stogov		ZVAL_NEW_STR(z, STR_INIT(s, l, 0));		\
552453b49edSDmitry Stogov	} while (0)
553bcddfd47SThies C. Arntzen
554f4cfaf36SDmitry Stogov#define ZVAL_STRING(z, s) do {					\
555f4cfaf36SDmitry Stogov		const char *_s = (s);					\
556a0fe8e5aSDmitry Stogov		ZVAL_STRINGL(z, _s, strlen(_s));		\
557453b49edSDmitry Stogov	} while (0)
558bcddfd47SThies C. Arntzen
559f4cfaf36SDmitry Stogov#define ZVAL_EMPTY_STRING(z) do {				\
56076cc99feSDmitry Stogov		ZVAL_INT_STR(z, STR_EMPTY_ALLOC());		\
561453b49edSDmitry Stogov	} while (0)
562453b49edSDmitry Stogov
563f4cfaf36SDmitry Stogov#define ZVAL_PSTRINGL(z, s, l) do {				\
56476cc99feSDmitry Stogov		ZVAL_NEW_STR(z, STR_INIT(s, l, 1));		\
565453b49edSDmitry Stogov	} while (0)
566453b49edSDmitry Stogov
567f4cfaf36SDmitry Stogov#define ZVAL_PSTRING(z, s) do {					\
568f4cfaf36SDmitry Stogov		const char *_s = (s);					\
569a0fe8e5aSDmitry Stogov		ZVAL_PSTRINGL(z, _s, strlen(_s));		\
570f4cfaf36SDmitry Stogov	} while (0)
571f4cfaf36SDmitry Stogov
572f4cfaf36SDmitry Stogov#define ZVAL_EMPTY_PSTRING(z) do {				\
5730e425121SDmitry Stogov		ZVAL_PSTRINGL(z, "", 0);				\
574453b49edSDmitry Stogov	} while (0)
575af22085cSThies C. Arntzen
576d18b9698SNikita Popov#define ZVAL_ZVAL(z, zv, copy, dtor) do {		\
577d18b9698SNikita Popov		zval *__z = (z);						\
578d18b9698SNikita Popov		zval *__zv = (zv);						\
579bfdaf6e8SDmitry Stogov		if (EXPECTED(!Z_ISREF_P(__zv))) {		\
580bfdaf6e8SDmitry Stogov			ZVAL_COPY_VALUE(__z, __zv);			\
581bfdaf6e8SDmitry Stogov		} else {                                \
582bfdaf6e8SDmitry Stogov			ZVAL_COPY_VALUE(__z,                \
583bfdaf6e8SDmitry Stogov				Z_REFVAL_P(__zv));				\
584bfdaf6e8SDmitry Stogov		}										\
585d90ebc65SDmitry Stogov		if (copy) {								\
58658f0f250SDmitry Stogov			zval_opt_copy_ctor(__z);			\
587d90ebc65SDmitry Stogov	    }										\
588d90ebc65SDmitry Stogov		if (dtor) {								\
589d90ebc65SDmitry Stogov			if (!copy) {						\
590d18b9698SNikita Popov				ZVAL_NULL(__zv);				\
591d90ebc65SDmitry Stogov			}									\
592f4cfaf36SDmitry Stogov			zval_ptr_dtor(__zv);				\
593d90ebc65SDmitry Stogov	    }										\
594d18b9698SNikita Popov	} while (0)
595c7d27ad9SMarcus Boerger
5964f6c95d1SZeev Suraski#define ZVAL_FALSE(z)  					ZVAL_BOOL(z, 0)
5974f6c95d1SZeev Suraski#define ZVAL_TRUE(z)  					ZVAL_BOOL(z, 1)
598af22085cSThies C. Arntzen
5994f6c95d1SZeev Suraski#define RETVAL_BOOL(b)					ZVAL_BOOL(return_value, b)
600bcddfd47SThies C. Arntzen#define RETVAL_NULL() 					ZVAL_NULL(return_value)
6014f6c95d1SZeev Suraski#define RETVAL_LONG(l) 					ZVAL_LONG(return_value, l)
6024f6c95d1SZeev Suraski#define RETVAL_DOUBLE(d) 				ZVAL_DOUBLE(return_value, d)
603f4cfaf36SDmitry Stogov#define RETVAL_STR(s)			 		ZVAL_STR(return_value, s)
60476cc99feSDmitry Stogov#define RETVAL_INT_STR(s)		 		ZVAL_INT_STR(return_value, s)
60576cc99feSDmitry Stogov#define RETVAL_NEW_STR(s)		 		ZVAL_NEW_STR(return_value, s)
606f4cfaf36SDmitry Stogov#define RETVAL_STRING(s)		 		ZVAL_STRING(return_value, s)
607f4cfaf36SDmitry Stogov#define RETVAL_STRINGL(s, l)		 	ZVAL_STRINGL(return_value, s, l)
608bcddfd47SThies C. Arntzen#define RETVAL_EMPTY_STRING() 			ZVAL_EMPTY_STRING(return_value)
609398256e5SDmitry Stogov#define RETVAL_RES(r)			 		ZVAL_RES(return_value, r)
610c7d27ad9SMarcus Boerger#define RETVAL_ZVAL(zv, copy, dtor)		ZVAL_ZVAL(return_value, zv, copy, dtor)
6114f6c95d1SZeev Suraski#define RETVAL_FALSE  					ZVAL_BOOL(return_value, 0)
6124f6c95d1SZeev Suraski#define RETVAL_TRUE   					ZVAL_BOOL(return_value, 1)
613bcddfd47SThies C. Arntzen
614bcddfd47SThies C. Arntzen#define RETURN_BOOL(b) 					{ RETVAL_BOOL(b); return; }
615bcddfd47SThies C. Arntzen#define RETURN_NULL() 					{ RETVAL_NULL(); return;}
616bcddfd47SThies C. Arntzen#define RETURN_LONG(l) 					{ RETVAL_LONG(l); return; }
617bcddfd47SThies C. Arntzen#define RETURN_DOUBLE(d) 				{ RETVAL_DOUBLE(d); return; }
618f4cfaf36SDmitry Stogov#define RETURN_STR(s) 					{ RETVAL_STR(s); return; }
61976cc99feSDmitry Stogov#define RETURN_INT_STR(s)				{ RETVAL_INT_STR(s); return; }
62076cc99feSDmitry Stogov#define RETURN_NEW_STR(s)				{ RETVAL_NEW_STR(s); return; }
621f4cfaf36SDmitry Stogov#define RETURN_STRING(s) 				{ RETVAL_STRING(s); return; }
622f4cfaf36SDmitry Stogov#define RETURN_STRINGL(s, l) 			{ RETVAL_STRINGL(s, l); return; }
623bcddfd47SThies C. Arntzen#define RETURN_EMPTY_STRING() 			{ RETVAL_EMPTY_STRING(); return; }
624398256e5SDmitry Stogov#define RETURN_RES(r) 					{ RETVAL_RES(r); return; }
625c7d27ad9SMarcus Boerger#define RETURN_ZVAL(zv, copy, dtor)		{ RETVAL_ZVAL(zv, copy, dtor); return; }
626bcddfd47SThies C. Arntzen#define RETURN_FALSE  					{ RETVAL_FALSE; return; }
627bcddfd47SThies C. Arntzen#define RETURN_TRUE   					{ RETVAL_TRUE; return; }
6281f985edeSZeev Suraski
62908567145SNikita Popov#define RETVAL_ZVAL_FAST(z) do {      \
63008567145SNikita Popov	zval *_z = (z);                   \
63108567145SNikita Popov	if (Z_ISREF_P(_z)) {              \
63208567145SNikita Popov		RETVAL_ZVAL(_z, 1, 0);        \
63308567145SNikita Popov	} else {                          \
634f4cfaf36SDmitry Stogov		zval_ptr_dtor(return_value);  \
635f4cfaf36SDmitry Stogov		ZVAL_COPY(return_value, _z);  \
63608567145SNikita Popov	}                                 \
63708567145SNikita Popov} while (0)
638f4cfaf36SDmitry Stogov
63908567145SNikita Popov#define RETURN_ZVAL_FAST(z) { RETVAL_ZVAL_FAST(z); return; }
64008567145SNikita Popov
641637a4042SMarcus Boerger#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) TSRMLS_CC) : NULL)))
642068ec75fSXinchen Hui#define ZVAL_IS_NULL(z) (Z_TYPE_P(z) == IS_NULL)
643068ec75fSXinchen Hui#define ZVAL_IS_UNDEF(z) (Z_TYPE_P(z) == IS_UNDEF)
64406a18f16SAndi Gutmans
6458b6f848cSAndi Gutmans/* For compatibility */
6468b6f848cSAndi Gutmans#define ZEND_MINIT			ZEND_MODULE_STARTUP_N
6478b6f848cSAndi Gutmans#define ZEND_MSHUTDOWN		ZEND_MODULE_SHUTDOWN_N
6488b6f848cSAndi Gutmans#define ZEND_RINIT			ZEND_MODULE_ACTIVATE_N
6498b6f848cSAndi Gutmans#define ZEND_RSHUTDOWN		ZEND_MODULE_DEACTIVATE_N
6508b6f848cSAndi Gutmans#define ZEND_MINFO			ZEND_MODULE_INFO_N
651ada4e506SDmitry Stogov#define ZEND_GINIT(module)		((void (*)(void* TSRMLS_DC))(ZEND_MODULE_GLOBALS_CTOR_N(module)))
652ada4e506SDmitry Stogov#define ZEND_GSHUTDOWN(module)	((void (*)(void* TSRMLS_DC))(ZEND_MODULE_GLOBALS_DTOR_N(module)))
6538b6f848cSAndi Gutmans
6548b6f848cSAndi Gutmans#define ZEND_MINIT_FUNCTION			ZEND_MODULE_STARTUP_D
655f5c59863SStanislav Malyshev#define ZEND_MSHUTDOWN_FUNCTION		ZEND_MODULE_SHUTDOWN_D
656f5c59863SStanislav Malyshev#define ZEND_RINIT_FUNCTION			ZEND_MODULE_ACTIVATE_D
657f5c59863SStanislav Malyshev#define ZEND_RSHUTDOWN_FUNCTION		ZEND_MODULE_DEACTIVATE_D
658f5c59863SStanislav Malyshev#define ZEND_MINFO_FUNCTION			ZEND_MODULE_INFO_D
659ada4e506SDmitry Stogov#define ZEND_GINIT_FUNCTION			ZEND_MODULE_GLOBALS_CTOR_D
660ada4e506SDmitry Stogov#define ZEND_GSHUTDOWN_FUNCTION		ZEND_MODULE_GLOBALS_DTOR_D
6618b6f848cSAndi Gutmans
6620450ab94SZeev SuraskiEND_EXTERN_C()
663637a4042SMarcus Boerger
664b982307dSSascha Schumann#endif /* ZEND_API_H */
665573b4602SAndi Gutmans
6668b6f848cSAndi Gutmans
667573b4602SAndi Gutmans/*
668573b4602SAndi Gutmans * Local variables:
669573b4602SAndi Gutmans * tab-width: 4
670573b4602SAndi Gutmans * c-basic-offset: 4
671333406bdSfoobar * indent-tabs-mode: t
672573b4602SAndi Gutmans * End:
673573b4602SAndi Gutmans */
674