zend_API.h revision 03a1fcab
1573b4602SAndi Gutmans/*
2573b4602SAndi Gutmans   +----------------------------------------------------------------------+
3573b4602SAndi Gutmans   | Zend Engine                                                          |
4573b4602SAndi Gutmans   +----------------------------------------------------------------------+
5e4ca0ed0SFelipe Pena   | Copyright (c) 1998-2012 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;
46feb85801SDmitry Stogov	zval *function_name;
47feb85801SDmitry Stogov	HashTable *symbol_table;
48feb85801SDmitry Stogov	zval **retval_ptr_ptr;
49feb85801SDmitry Stogov	zend_uint param_count;
50feb85801SDmitry Stogov	zval ***params;
517d4fd3fdSDmitry Stogov	zval *object_ptr;
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;
607d4fd3fdSDmitry Stogov	zval *object_ptr;
61feb85801SDmitry Stogov} zend_fcall_info_cache;
62feb85801SDmitry Stogov
637126de49SMarcus Boerger#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
93f48cab06SJani Taskinen#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
99054e1cafSFelipe Pena#define ZEND_FE_END            { NULL, NULL, NULL, 0, 0 }
100054e1cafSFelipe Pena
1011a723413SDmitry Stogov#define ZEND_ARG_INFO(pass_by_ref, name)							{ #name, sizeof(#name)-1, NULL, 0, 0, 0, pass_by_ref, 0, 0 },
1021a723413SDmitry Stogov#define ZEND_ARG_PASS_INFO(pass_by_ref)								{ NULL, 0, NULL, 0, 0, 0, pass_by_ref, 0, 0 },
1031a723413SDmitry Stogov#define ZEND_ARG_OBJ_INFO(pass_by_ref, name, classname, allow_null) { #name, sizeof(#name)-1, #classname, sizeof(#classname)-1, 0, allow_null, pass_by_ref, 0, 0 },
1041a723413SDmitry Stogov#define ZEND_ARG_ARRAY_INFO(pass_by_ref, name, allow_null) { #name, sizeof(#name)-1, NULL, 0, 1, allow_null, pass_by_ref, 0, 0 },
1057086634aSZeev Suraski#define ZEND_BEGIN_ARG_INFO_EX(name, pass_rest_by_reference, return_reference, required_num_args)	\
106fc2fb50dSFelipe Pena	static const zend_arg_info name[] = {																		\
1071a723413SDmitry Stogov		{ NULL, 0, NULL, 0, 0, 0, pass_rest_by_reference, return_reference, required_num_args },
108e7e0f7d4SZeev Suraski#define ZEND_BEGIN_ARG_INFO(name, pass_rest_by_reference)	\
109aedbdb08SDmitry Stogov	ZEND_BEGIN_ARG_INFO_EX(name, pass_rest_by_reference, ZEND_RETURN_VALUE, -1)
110f8bbafd6SZeev Suraski#define ZEND_END_ARG_INFO()		};
111342c6e0bSZeev Suraski
1128b6f848cSAndi Gutmans/* Name macros */
1138b6f848cSAndi Gutmans#define ZEND_MODULE_STARTUP_N(module)       zm_startup_##module
1148b6f848cSAndi Gutmans#define ZEND_MODULE_SHUTDOWN_N(module)		zm_shutdown_##module
1158b6f848cSAndi Gutmans#define ZEND_MODULE_ACTIVATE_N(module)		zm_activate_##module
1168b6f848cSAndi Gutmans#define ZEND_MODULE_DEACTIVATE_N(module)	zm_deactivate_##module
1176535933fSDerick Rethans#define ZEND_MODULE_POST_ZEND_DEACTIVATE_N(module)	zm_post_zend_deactivate_##module
1188b6f848cSAndi Gutmans#define ZEND_MODULE_INFO_N(module)			zm_info_##module
119ada4e506SDmitry Stogov#define ZEND_MODULE_GLOBALS_CTOR_N(module)  zm_globals_ctor_##module
120ada4e506SDmitry Stogov#define ZEND_MODULE_GLOBALS_DTOR_N(module)  zm_globals_dtor_##module
121342c6e0bSZeev Suraski
1228b6f848cSAndi Gutmans/* Declaration macros */
1238b6f848cSAndi Gutmans#define ZEND_MODULE_STARTUP_D(module)		int ZEND_MODULE_STARTUP_N(module)(INIT_FUNC_ARGS)
1248b6f848cSAndi Gutmans#define ZEND_MODULE_SHUTDOWN_D(module)		int ZEND_MODULE_SHUTDOWN_N(module)(SHUTDOWN_FUNC_ARGS)
1258b6f848cSAndi Gutmans#define ZEND_MODULE_ACTIVATE_D(module)		int ZEND_MODULE_ACTIVATE_N(module)(INIT_FUNC_ARGS)
1268b6f848cSAndi Gutmans#define ZEND_MODULE_DEACTIVATE_D(module)	int ZEND_MODULE_DEACTIVATE_N(module)(SHUTDOWN_FUNC_ARGS)
1276535933fSDerick Rethans#define ZEND_MODULE_POST_ZEND_DEACTIVATE_D(module)	int ZEND_MODULE_POST_ZEND_DEACTIVATE_N(module)(void)
1288b6f848cSAndi Gutmans#define ZEND_MODULE_INFO_D(module)			void ZEND_MODULE_INFO_N(module)(ZEND_MODULE_INFO_FUNC_ARGS)
129ada4e506SDmitry Stogov#define ZEND_MODULE_GLOBALS_CTOR_D(module)  void ZEND_MODULE_GLOBALS_CTOR_N(module)(zend_##module##_globals *module##_globals TSRMLS_DC)
130ada4e506SDmitry Stogov#define ZEND_MODULE_GLOBALS_DTOR_D(module)  void ZEND_MODULE_GLOBALS_DTOR_N(module)(zend_##module##_globals *module##_globals TSRMLS_DC)
131342c6e0bSZeev Suraski
1320b6d923bSSascha Schumann#define ZEND_GET_MODULE(name) \
133cb71ac03SHartmut Holzgraefe    BEGIN_EXTERN_C()\
134cb71ac03SHartmut Holzgraefe	ZEND_DLEXPORT zend_module_entry *get_module(void) { return &name##_module_entry; }\
135cb71ac03SHartmut Holzgraefe    END_EXTERN_C()
1360d21940dSZeev Suraski
1370d21940dSZeev Suraski#define ZEND_BEGIN_MODULE_GLOBALS(module_name)		\
1380d21940dSZeev Suraski	typedef struct _zend_##module_name##_globals {
1390d21940dSZeev Suraski#define ZEND_END_MODULE_GLOBALS(module_name)		\
1400d21940dSZeev Suraski	} zend_##module_name##_globals;
1410d21940dSZeev Suraski
1420d21940dSZeev Suraski#ifdef ZTS
1430d21940dSZeev Suraski
1440d21940dSZeev Suraski#define ZEND_DECLARE_MODULE_GLOBALS(module_name)							\
14502af513cSAndi Gutmans	ts_rsrc_id module_name##_globals_id;
14602af513cSAndi Gutmans#define ZEND_EXTERN_MODULE_GLOBALS(module_name)								\
14702af513cSAndi Gutmans	extern ts_rsrc_id module_name##_globals_id;
1480d21940dSZeev Suraski#define ZEND_INIT_MODULE_GLOBALS(module_name, globals_ctor, globals_dtor)	\
1492c254ba7SZeev Suraski	ts_allocate_id(&module_name##_globals_id, sizeof(zend_##module_name##_globals), (ts_allocate_ctor) globals_ctor, (ts_allocate_dtor) globals_dtor);
1500d21940dSZeev Suraski
1510d21940dSZeev Suraski#else
1520d21940dSZeev Suraski
1530d21940dSZeev Suraski#define ZEND_DECLARE_MODULE_GLOBALS(module_name)							\
15402af513cSAndi Gutmans	zend_##module_name##_globals module_name##_globals;
15502af513cSAndi Gutmans#define ZEND_EXTERN_MODULE_GLOBALS(module_name)								\
15602af513cSAndi Gutmans	extern zend_##module_name##_globals module_name##_globals;
1570d21940dSZeev Suraski#define ZEND_INIT_MODULE_GLOBALS(module_name, globals_ctor, globals_dtor)	\
1580d21940dSZeev Suraski	globals_ctor(&module_name##_globals);
1590d21940dSZeev Suraski
1600d21940dSZeev Suraski#endif
1610d21940dSZeev Suraski
162b4892511SJani Taskinen#define INIT_CLASS_ENTRY(class_container, class_name, functions) \
163b4892511SJani Taskinen	INIT_OVERLOADED_CLASS_ENTRY(class_container, class_name, functions, NULL, NULL, NULL)
164741b8161SZeev Suraski
165b4892511SJani Taskinen#define INIT_CLASS_ENTRY_EX(class_container, class_name, class_name_len, functions) \
166b4892511SJani Taskinen	INIT_OVERLOADED_CLASS_ENTRY_EX(class_container, class_name, class_name_len, functions, NULL, NULL, NULL, NULL, NULL)
167b4892511SJani Taskinen
168b4892511SJani 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) \
169741b8161SZeev Suraski	{															\
170b4892511SJani Taskinen		int _len = class_name_len;								\
171b4892511SJani Taskinen		class_container.name = zend_strndup(class_name, _len);	\
172b4892511SJani Taskinen		class_container.name_length = _len;						\
17303a1fcabSXinchen Hui		INIT_CLASS_ENTRY_INIT_METHODS(class_container, functions, handle_fcall, handle_propget, handle_propset, handle_propunset, handle_propisset) \
17403a1fcabSXinchen Hui	}
17503a1fcabSXinchen Hui
17603a1fcabSXinchen Hui#define INIT_CLASS_ENTRY_INIT_METHODS(class_container, functions, handle_fcall, handle_propget, handle_propset, handle_propunset, handle_propisset) \
17703a1fcabSXinchen Hui	{															\
178741b8161SZeev Suraski		class_container.builtin_functions = functions;			\
1792eccd95cSAndi Gutmans		class_container.constructor = NULL;						\
18073b159e0SAndi Gutmans		class_container.destructor = NULL;						\
18129ea3da2SAndi Gutmans		class_container.clone = NULL;							\
182637a4042SMarcus Boerger		class_container.serialize = NULL;						\
183637a4042SMarcus Boerger		class_container.unserialize = NULL;						\
184637a4042SMarcus Boerger		class_container.create_object = NULL;					\
1853c62b3b5SMarcus Boerger		class_container.interface_gets_implemented = NULL;		\
18672d0454bSDmitry Stogov		class_container.get_static_method = NULL;				\
187637a4042SMarcus Boerger		class_container.__call = handle_fcall;					\
188b4892511SJani Taskinen		class_container.__callstatic = NULL;					\
189637a4042SMarcus Boerger		class_container.__tostring = NULL;						\
190637a4042SMarcus Boerger		class_container.__get = handle_propget;					\
191637a4042SMarcus Boerger		class_container.__set = handle_propset;					\
192637a4042SMarcus Boerger		class_container.__unset = handle_propunset;				\
193637a4042SMarcus Boerger		class_container.__isset = handle_propisset;				\
194637a4042SMarcus Boerger		class_container.serialize_func = NULL;					\
195637a4042SMarcus Boerger		class_container.unserialize_func = NULL;				\
196637a4042SMarcus Boerger		class_container.serialize = NULL;						\
197637a4042SMarcus Boerger		class_container.unserialize = NULL;						\
198637a4042SMarcus Boerger		class_container.parent = NULL;							\
199637a4042SMarcus Boerger		class_container.num_interfaces = 0;						\
200637a4042SMarcus Boerger		class_container.interfaces = NULL;						\
201637a4042SMarcus Boerger		class_container.get_iterator = NULL;					\
202637a4042SMarcus Boerger		class_container.iterator_funcs.funcs = NULL;			\
203637a4042SMarcus Boerger		class_container.module = NULL;							\
204741b8161SZeev Suraski	}
205741b8161SZeev Suraski
206345e0255SDmitry Stogov#define INIT_OVERLOADED_CLASS_ENTRY(class_container, class_name, functions, handle_fcall, handle_propget, handle_propset) \
207b4892511SJani Taskinen	INIT_OVERLOADED_CLASS_ENTRY_EX(class_container, class_name, sizeof(class_name)-1, functions, handle_fcall, handle_propget, handle_propset, NULL, NULL)
208345e0255SDmitry Stogov
209907fa665SDmitry Stogov#define INIT_NS_CLASS_ENTRY(class_container, ns, class_name, functions) \
210907fa665SDmitry Stogov	INIT_CLASS_ENTRY(class_container, ZEND_NS_NAME(ns, class_name), functions)
211907fa665SDmitry Stogov#define INIT_OVERLOADED_NS_CLASS_ENTRY_EX(class_container, ns, class_name, functions, handle_fcall, handle_propget, handle_propset, handle_propunset, handle_propisset) \
212907fa665SDmitry 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)
213907fa665SDmitry Stogov#define INIT_OVERLOADED_NS_CLASS_ENTRY(class_container, ns, class_name, functions, handle_fcall, handle_propget, handle_propset) \
214907fa665SDmitry Stogov	INIT_OVERLOADED_CLASS_ENTRY(class_container, ZEND_NS_NAME(ns, class_name), functions, handle_fcall, handle_propget, handle_propset)
215907fa665SDmitry Stogov
2168768ab94SDmitry Stogov#ifdef ZTS
217e1814f0dSDmitry Stogov#	define CE_STATIC_MEMBERS(ce) (((ce)->type==ZEND_USER_CLASS)?(ce)->static_members:CG(static_members)[(zend_intptr_t)(ce)->static_members])
2188768ab94SDmitry Stogov#else
2198768ab94SDmitry Stogov#	define CE_STATIC_MEMBERS(ce) ((ce)->static_members)
2208768ab94SDmitry Stogov#endif
2218768ab94SDmitry Stogov
222b4892511SJani Taskinen#define ZEND_FCI_INITIALIZED(fci) ((fci).size != 0)
223b4892511SJani Taskinen
224573b4602SAndi Gutmansint zend_next_free_module(void);
225573b4602SAndi Gutmans
2261727c6a2SHartmut HolzgraefeBEGIN_EXTERN_C()
227f77e6a44SZeev SuraskiZEND_API int zend_get_parameters(int ht, int param_count, ...);
22811e5d2f2SZeev SuraskiZEND_API int _zend_get_parameters_array(int ht, int param_count, zval **argument_array TSRMLS_DC);
229e59bfcffSStanislav MalyshevZEND_API ZEND_ATTRIBUTE_DEPRECATED int zend_get_parameters_ex(int param_count, ...);
23011e5d2f2SZeev SuraskiZEND_API int _zend_get_parameters_array_ex(int param_count, zval ***argument_array TSRMLS_DC);
23111e5d2f2SZeev Suraski
232e39f3f3fSMarcus Boerger/* internal function to efficiently copy parameters when executing __call() */
233e39f3f3fSMarcus BoergerZEND_API int zend_copy_parameters_array(int param_count, zval *argument_array TSRMLS_DC);
234e39f3f3fSMarcus Boerger
23511e5d2f2SZeev Suraski#define zend_get_parameters_array(ht, param_count, argument_array)			\
23611e5d2f2SZeev Suraski	_zend_get_parameters_array(ht, param_count, argument_array TSRMLS_CC)
23711e5d2f2SZeev Suraski#define zend_get_parameters_array_ex(param_count, argument_array)			\
23811e5d2f2SZeev Suraski	_zend_get_parameters_array_ex(param_count, argument_array TSRMLS_CC)
239cc2b17d5SFelipe Pena#define zend_parse_parameters_none()										\
240cc2b17d5SFelipe Pena	zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "")
24158f88057SAndrei Zmievski
24258f88057SAndrei Zmievski/* Parameter parsing API -- andrei */
24358f88057SAndrei Zmievski
24458f88057SAndrei Zmievski#define ZEND_PARSE_PARAMS_QUIET 1<<1
2458ce8324eSZeev SuraskiZEND_API int zend_parse_parameters(int num_args TSRMLS_DC, char *type_spec, ...);
2463839af35SAndrei ZmievskiZEND_API int zend_parse_parameters_ex(int flags, int num_args TSRMLS_DC, char *type_spec, ...);
247cf7384aaSFelipe PenaZEND_API char *zend_zval_type_name(const zval *arg);
24858f88057SAndrei Zmievski
249325f9edbSGeorg RichterZEND_API int zend_parse_method_parameters(int num_args TSRMLS_DC, zval *this_ptr, char *type_spec, ...);
2508d45feceSMarcus BoergerZEND_API int zend_parse_method_parameters_ex(int flags, int num_args TSRMLS_DC, zval *this_ptr, char *type_spec, ...);
251c4528f82SHarald Radi
252b5255495SZeev Suraski/* End of parameter parsing API -- andrei */
25339f9487eSAndi Gutmans
2546c810b0dSDmitry StogovZEND_API int zend_register_functions(zend_class_entry *scope, const zend_function_entry *functions, HashTable *function_table, int type TSRMLS_DC);
2556c810b0dSDmitry StogovZEND_API void zend_unregister_functions(const zend_function_entry *functions, int count, HashTable *function_table TSRMLS_DC);
2562ca2dc0bSDmitry StogovZEND_API int zend_startup_module(zend_module_entry *module_entry);
25770bd938bSDmitry StogovZEND_API zend_module_entry* zend_register_internal_module(zend_module_entry *module_entry TSRMLS_DC);
25870bd938bSDmitry StogovZEND_API zend_module_entry* zend_register_module_ex(zend_module_entry *module TSRMLS_DC);
2592ca2dc0bSDmitry StogovZEND_API int zend_startup_module_ex(zend_module_entry *module TSRMLS_DC);
260c0c7a9f0SDmitry StogovZEND_API int zend_startup_modules(TSRMLS_D);
261cf7384aaSFelipe PenaZEND_API void zend_check_magic_method_implementation(const zend_class_entry *ce, const zend_function *fptr, int error_type TSRMLS_DC);
262eb0e6946SAndi Gutmans
263b5770382SZeev SuraskiZEND_API zend_class_entry *zend_register_internal_class(zend_class_entry *class_entry TSRMLS_DC);
264b5770382SZeev SuraskiZEND_API zend_class_entry *zend_register_internal_class_ex(zend_class_entry *class_entry, zend_class_entry *parent_ce, char *parent_name TSRMLS_DC);
2653c62b3b5SMarcus BoergerZEND_API zend_class_entry *zend_register_internal_interface(zend_class_entry *orig_class_entry TSRMLS_DC);
2664073a084SMarcus BoergerZEND_API void zend_class_implements(zend_class_entry *class_entry TSRMLS_DC, int num_interfaces, ...);
267eb0e6946SAndi Gutmans
268cf7384aaSFelipe PenaZEND_API int zend_register_class_alias_ex(const char *name, int name_len, zend_class_entry *ce TSRMLS_DC);
269907fa665SDmitry Stogov
270907fa665SDmitry Stogov#define zend_register_class_alias(name, ce) \
271907fa665SDmitry Stogov	zend_register_class_alias_ex(name, sizeof(name)-1, ce TSRMLS_DC)
272907fa665SDmitry Stogov#define zend_register_ns_class_alias(ns, name, ce) \
273907fa665SDmitry Stogov	zend_register_class_alias_ex(ZEND_NS_NAME(ns, name), sizeof(ZEND_NS_NAME(ns, name))-1, ce TSRMLS_DC)
274907fa665SDmitry Stogov
275d76cf1daSZeev SuraskiZEND_API int zend_disable_function(char *function_name, uint function_name_length TSRMLS_DC);
276a700180fSHarald RadiZEND_API int zend_disable_class(char *class_name, uint class_name_length TSRMLS_DC);
277573b4602SAndi Gutmans
2784187439cSZeev SuraskiZEND_API void zend_wrong_param_count(TSRMLS_D);
279c81db6bcSDmitry Stogov
280c81db6bcSDmitry Stogov#define IS_CALLABLE_CHECK_SYNTAX_ONLY (1<<0)
281c81db6bcSDmitry Stogov#define IS_CALLABLE_CHECK_NO_ACCESS   (1<<1)
28253e52606SMarcus Boerger#define IS_CALLABLE_CHECK_IS_STATIC   (1<<2)
283af05ce0aSDmitry Stogov#define IS_CALLABLE_CHECK_SILENT      (1<<3)
284c81db6bcSDmitry Stogov
2850cd997d7SMarcus Boerger#define IS_CALLABLE_STRICT  (IS_CALLABLE_CHECK_IS_STATIC)
2860cd997d7SMarcus Boerger
2877d4fd3fdSDmitry StogovZEND_API zend_bool zend_is_callable_ex(zval *callable, zval *object_ptr, uint check_flags, char **callable_name, int *callable_name_len, zend_fcall_info_cache *fcc, char **error TSRMLS_DC);
288e304515dSFelipe PenaZEND_API zend_bool zend_is_callable(zval *callable, uint check_flags, char **callable_name TSRMLS_DC);
28926bfe3f8SMarcus BoergerZEND_API zend_bool zend_make_callable(zval *callable, char **callable_name TSRMLS_DC);
2906c810b0dSDmitry StogovZEND_API const char *zend_get_module_version(const char *module_name);
291cf7384aaSFelipe PenaZEND_API int zend_get_module_started(const char *module_name);
2927bbbd503SMarcus BoergerZEND_API int zend_declare_property(zend_class_entry *ce, char *name, int name_length, zval *property, int access_type TSRMLS_DC);
293cf7384aaSFelipe PenaZEND_API int zend_declare_property_ex(zend_class_entry *ce, const char *name, int name_length, zval *property, int access_type, char *doc_comment, int doc_comment_len TSRMLS_DC);
2947bbbd503SMarcus BoergerZEND_API int zend_declare_property_null(zend_class_entry *ce, char *name, int name_length, int access_type TSRMLS_DC);
295d88c2b18SHartmut HolzgraefeZEND_API int zend_declare_property_bool(zend_class_entry *ce, char *name, int name_length, long value, int access_type TSRMLS_DC);
2967bbbd503SMarcus BoergerZEND_API int zend_declare_property_long(zend_class_entry *ce, char *name, int name_length, long value, int access_type TSRMLS_DC);
297d88c2b18SHartmut HolzgraefeZEND_API int zend_declare_property_double(zend_class_entry *ce, char *name, int name_length, double value, int access_type TSRMLS_DC);
2987bbbd503SMarcus BoergerZEND_API int zend_declare_property_string(zend_class_entry *ce, char *name, int name_length, char *value, int access_type TSRMLS_DC);
299d88c2b18SHartmut HolzgraefeZEND_API int zend_declare_property_stringl(zend_class_entry *ce, char *name, int name_length, char *value, int value_len, int access_type TSRMLS_DC);
30013433852SZeev Suraski
301cf7384aaSFelipe PenaZEND_API int zend_declare_class_constant(zend_class_entry *ce, const char *name, size_t name_length, zval *value TSRMLS_DC);
302cf7384aaSFelipe PenaZEND_API int zend_declare_class_constant_null(zend_class_entry *ce, const char *name, size_t name_length TSRMLS_DC);
303cf7384aaSFelipe PenaZEND_API int zend_declare_class_constant_long(zend_class_entry *ce, const char *name, size_t name_length, long value TSRMLS_DC);
304cf7384aaSFelipe PenaZEND_API int zend_declare_class_constant_bool(zend_class_entry *ce, const char *name, size_t name_length, zend_bool value TSRMLS_DC);
305cf7384aaSFelipe PenaZEND_API int zend_declare_class_constant_double(zend_class_entry *ce, const char *name, size_t name_length, double value TSRMLS_DC);
306cf7384aaSFelipe 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);
307cf7384aaSFelipe PenaZEND_API int zend_declare_class_constant_string(zend_class_entry *ce, const char *name, size_t name_length, const char *value TSRMLS_DC);
308248345d9SDmitry Stogov
3091d5c13bdSMarcus BoergerZEND_API void zend_update_class_constants(zend_class_entry *class_type TSRMLS_DC);
310baaa4c90SMarcus BoergerZEND_API void zend_update_property(zend_class_entry *scope, zval *object, char *name, int name_length, zval *value TSRMLS_DC);
311baaa4c90SMarcus BoergerZEND_API void zend_update_property_null(zend_class_entry *scope, zval *object, char *name, int name_length TSRMLS_DC);
312d88c2b18SHartmut HolzgraefeZEND_API void zend_update_property_bool(zend_class_entry *scope, zval *object, char *name, int name_length, long value TSRMLS_DC);
313baaa4c90SMarcus BoergerZEND_API void zend_update_property_long(zend_class_entry *scope, zval *object, char *name, int name_length, long value TSRMLS_DC);
314d88c2b18SHartmut HolzgraefeZEND_API void zend_update_property_double(zend_class_entry *scope, zval *object, char *name, int name_length, double value TSRMLS_DC);
315cf7384aaSFelipe PenaZEND_API void zend_update_property_string(zend_class_entry *scope, zval *object, char *name, int name_length, const char *value TSRMLS_DC);
316cf7384aaSFelipe PenaZEND_API void zend_update_property_stringl(zend_class_entry *scope, zval *object, char *name, int name_length, const char *value, int value_length TSRMLS_DC);
317573b4602SAndi Gutmans
318248345d9SDmitry StogovZEND_API int zend_update_static_property(zend_class_entry *scope, char *name, int name_length, zval *value TSRMLS_DC);
319248345d9SDmitry StogovZEND_API int zend_update_static_property_null(zend_class_entry *scope, char *name, int name_length TSRMLS_DC);
320248345d9SDmitry StogovZEND_API int zend_update_static_property_bool(zend_class_entry *scope, char *name, int name_length, long value TSRMLS_DC);
321248345d9SDmitry StogovZEND_API int zend_update_static_property_long(zend_class_entry *scope, char *name, int name_length, long value TSRMLS_DC);
322248345d9SDmitry StogovZEND_API int zend_update_static_property_double(zend_class_entry *scope, char *name, int name_length, double value TSRMLS_DC);
323cf7384aaSFelipe PenaZEND_API int zend_update_static_property_string(zend_class_entry *scope, char *name, int name_length, const char *value TSRMLS_DC);
324cf7384aaSFelipe PenaZEND_API int zend_update_static_property_stringl(zend_class_entry *scope, char *name, int name_length, const char *value, int value_length TSRMLS_DC);
325248345d9SDmitry Stogov
32638805f28SMarcus BoergerZEND_API zval *zend_read_property(zend_class_entry *scope, zval *object, char *name, int name_length, zend_bool silent TSRMLS_DC);
32738805f28SMarcus Boerger
328248345d9SDmitry StogovZEND_API zval *zend_read_static_property(zend_class_entry *scope, char *name, int name_length, zend_bool silent TSRMLS_DC);
329248345d9SDmitry Stogov
330cf7384aaSFelipe PenaZEND_API zend_class_entry *zend_get_class_entry(const zval *zobject TSRMLS_DC);
331cf7384aaSFelipe PenaZEND_API int zend_get_object_classname(const zval *object, char **class_name, zend_uint *class_name_len TSRMLS_DC);
3329dd24c6dSAntony DovgalZEND_API char *zend_get_type_by_const(int type);
3336ac6cb10SHarald Radi
334741b8161SZeev Suraski#define getThis() (this_ptr)
335741b8161SZeev Suraski
336131d9cb2SZeev Suraski#define WRONG_PARAM_COUNT					ZEND_WRONG_PARAM_COUNT()
337131d9cb2SZeev Suraski#define WRONG_PARAM_COUNT_WITH_RETVAL(ret)	ZEND_WRONG_PARAM_COUNT_WITH_RETVAL(ret)
338a1ad2872SZeev Suraski#define ARG_COUNT(dummy)	(ht)
339a1ad2872SZeev Suraski#define ZEND_NUM_ARGS()		(ht)
3404187439cSZeev Suraski#define ZEND_WRONG_PARAM_COUNT()					{ zend_wrong_param_count(TSRMLS_C); return; }
3414187439cSZeev Suraski#define ZEND_WRONG_PARAM_COUNT_WITH_RETVAL(ret)		{ zend_wrong_param_count(TSRMLS_C); return ret; }
342573b4602SAndi Gutmans
34380bdd19eSZeev Suraski#ifndef ZEND_WIN32
344573b4602SAndi Gutmans#define DLEXPORT
345573b4602SAndi Gutmans#endif
346573b4602SAndi Gutmans
3477da75d81SMatt Wilmas#define array_init(arg)			_array_init((arg), 0 ZEND_FILE_LINE_CC)
3487da75d81SMatt Wilmas#define array_init_size(arg, size) _array_init((arg), (size) ZEND_FILE_LINE_CC)
349fcc03510SZeev Suraski#define object_init(arg)		_object_init((arg) ZEND_FILE_LINE_CC TSRMLS_CC)
350fcc03510SZeev Suraski#define object_init_ex(arg, ce)	_object_init_ex((arg), (ce) ZEND_FILE_LINE_CC TSRMLS_CC)
35176a7a5bcSAndi Gutmans#define object_and_properties_init(arg, ce, properties)	_object_and_properties_init((arg), (ce), (properties) ZEND_FILE_LINE_CC TSRMLS_CC)
3527da75d81SMatt WilmasZEND_API int _array_init(zval *arg, uint size ZEND_FILE_LINE_DC);
353fcc03510SZeev SuraskiZEND_API int _object_init(zval *arg ZEND_FILE_LINE_DC TSRMLS_DC);
354fcc03510SZeev SuraskiZEND_API int _object_init_ex(zval *arg, zend_class_entry *ce ZEND_FILE_LINE_DC TSRMLS_DC);
35576a7a5bcSAndi GutmansZEND_API int _object_and_properties_init(zval *arg, zend_class_entry *ce, HashTable *properties ZEND_FILE_LINE_DC TSRMLS_DC);
3566847fefaSThies C. Arntzen
357047a574eSMarcus BoergerZEND_API void zend_merge_properties(zval *obj, HashTable *properties, int destroy_ht TSRMLS_DC);
358047a574eSMarcus Boerger
3596847fefaSThies C. Arntzen/* no longer supported */
3606c810b0dSDmitry StogovZEND_API int add_assoc_function(zval *arg, const char *key, void (*function_ptr)(INTERNAL_FUNCTION_PARAMETERS));
3616847fefaSThies C. Arntzen
3626c810b0dSDmitry StogovZEND_API int add_assoc_long_ex(zval *arg, const char *key, uint key_len, long n);
3636c810b0dSDmitry StogovZEND_API int add_assoc_null_ex(zval *arg, const char *key, uint key_len);
3646c810b0dSDmitry StogovZEND_API int add_assoc_bool_ex(zval *arg, const char *key, uint key_len, int b);
3656c810b0dSDmitry StogovZEND_API int add_assoc_resource_ex(zval *arg, const char *key, uint key_len, int r);
3666c810b0dSDmitry StogovZEND_API int add_assoc_double_ex(zval *arg, const char *key, uint key_len, double d);
3676c810b0dSDmitry StogovZEND_API int add_assoc_string_ex(zval *arg, const char *key, uint key_len, char *str, int duplicate);
3686c810b0dSDmitry StogovZEND_API int add_assoc_stringl_ex(zval *arg, const char *key, uint key_len, char *str, uint length, int duplicate);
3696c810b0dSDmitry StogovZEND_API int add_assoc_zval_ex(zval *arg, const char *key, uint key_len, zval *value);
370ef95a346SAndi Gutmans
371ef95a346SAndi Gutmans#define add_assoc_long(__arg, __key, __n) add_assoc_long_ex(__arg, __key, strlen(__key)+1, __n)
3720611acb9SAndi Gutmans#define add_assoc_null(__arg, __key) add_assoc_null_ex(__arg, __key, strlen(__key) + 1)
373ef95a346SAndi Gutmans#define add_assoc_bool(__arg, __key, __b) add_assoc_bool_ex(__arg, __key, strlen(__key)+1, __b)
374ef95a346SAndi Gutmans#define add_assoc_resource(__arg, __key, __r) add_assoc_resource_ex(__arg, __key, strlen(__key)+1, __r)
375ef95a346SAndi Gutmans#define add_assoc_double(__arg, __key, __d) add_assoc_double_ex(__arg, __key, strlen(__key)+1, __d)
376ef95a346SAndi Gutmans#define add_assoc_string(__arg, __key, __str, __duplicate) add_assoc_string_ex(__arg, __key, strlen(__key)+1, __str, __duplicate)
377ef95a346SAndi Gutmans#define add_assoc_stringl(__arg, __key, __str, __length, __duplicate) add_assoc_stringl_ex(__arg, __key, strlen(__key)+1, __str, __length, __duplicate)
378ef95a346SAndi Gutmans#define add_assoc_zval(__arg, __key, __value) add_assoc_zval_ex(__arg, __key, strlen(__key)+1, __value)
3796847fefaSThies C. Arntzen
3800611acb9SAndi Gutmans/* unset() functions are only suported for legacy modules and null() functions should be used */
3810611acb9SAndi Gutmans#define add_assoc_unset(__arg, __key) add_assoc_null_ex(__arg, __key, strlen(__key) + 1)
3820611acb9SAndi Gutmans#define add_index_unset(__arg, __key) add_index_null(__arg, __key)
3830611acb9SAndi Gutmans#define add_next_index_unset(__arg) add_next_index_null(__arg)
3840611acb9SAndi Gutmans#define add_property_unset(__arg, __key) add_property_null(__arg, __key)
3850611acb9SAndi Gutmans
386b05b949aSDmitry StogovZEND_API int add_index_long(zval *arg, ulong idx, long n);
387b05b949aSDmitry StogovZEND_API int add_index_null(zval *arg, ulong idx);
388b05b949aSDmitry StogovZEND_API int add_index_bool(zval *arg, ulong idx, int b);
389b05b949aSDmitry StogovZEND_API int add_index_resource(zval *arg, ulong idx, int r);
390b05b949aSDmitry StogovZEND_API int add_index_double(zval *arg, ulong idx, double d);
3916c810b0dSDmitry StogovZEND_API int add_index_string(zval *arg, ulong idx, const char *str, int duplicate);
3926c810b0dSDmitry StogovZEND_API int add_index_stringl(zval *arg, ulong idx, const char *str, uint length, int duplicate);
393b05b949aSDmitry StogovZEND_API int add_index_zval(zval *arg, ulong index, zval *value);
3946847fefaSThies C. Arntzen
395573b4602SAndi GutmansZEND_API int add_next_index_long(zval *arg, long n);
3960611acb9SAndi GutmansZEND_API int add_next_index_null(zval *arg);
3976847fefaSThies C. ArntzenZEND_API int add_next_index_bool(zval *arg, int b);
3986847fefaSThies C. ArntzenZEND_API int add_next_index_resource(zval *arg, int r);
399573b4602SAndi GutmansZEND_API int add_next_index_double(zval *arg, double d);
4006c810b0dSDmitry StogovZEND_API int add_next_index_string(zval *arg, const char *str, int duplicate);
4016c810b0dSDmitry StogovZEND_API int add_next_index_stringl(zval *arg, const char *str, uint length, int duplicate);
402ef95a346SAndi GutmansZEND_API int add_next_index_zval(zval *arg, zval *value);
403ef95a346SAndi Gutmans
4046c810b0dSDmitry StogovZEND_API int add_get_assoc_string_ex(zval *arg, const char *key, uint key_len, const char *str, void **dest, int duplicate);
4056c810b0dSDmitry StogovZEND_API int add_get_assoc_stringl_ex(zval *arg, const char *key, uint key_len, const char *str, uint length, void **dest, int duplicate);
406ef95a346SAndi Gutmans
407ef95a346SAndi Gutmans#define add_get_assoc_string(__arg, __key, __str, __dest, __duplicate) add_get_assoc_string_ex(__arg, __key, strlen(__key)+1, __str, __dest, __duplicate)
408ef95a346SAndi Gutmans#define add_get_assoc_stringl(__arg, __key, __str, __length, __dest, __duplicate) add_get_assoc_stringl_ex(__arg, __key, strlen(__key)+1, __str, __length, __dest, __duplicate)
409573b4602SAndi Gutmans
410b05b949aSDmitry StogovZEND_API int add_get_index_long(zval *arg, ulong idx, long l, void **dest);
411b05b949aSDmitry StogovZEND_API int add_get_index_double(zval *arg, ulong idx, double d, void **dest);
4126c810b0dSDmitry StogovZEND_API int add_get_index_string(zval *arg, ulong idx, const char *str, void **dest, int duplicate);
4136c810b0dSDmitry StogovZEND_API int add_get_index_stringl(zval *arg, ulong idx, const char *str, uint length, void **dest, int duplicate);
414573b4602SAndi Gutmans
415cf7384aaSFelipe PenaZEND_API int add_property_long_ex(zval *arg, const char *key, uint key_len, long l TSRMLS_DC);
416cf7384aaSFelipe PenaZEND_API int add_property_null_ex(zval *arg, const char *key, uint key_len TSRMLS_DC);
417cf7384aaSFelipe PenaZEND_API int add_property_bool_ex(zval *arg, const char *key, uint key_len, int b TSRMLS_DC);
418cf7384aaSFelipe PenaZEND_API int add_property_resource_ex(zval *arg, const char *key, uint key_len, long r TSRMLS_DC);
419cf7384aaSFelipe PenaZEND_API int add_property_double_ex(zval *arg, const char *key, uint key_len, double d TSRMLS_DC);
420cf7384aaSFelipe PenaZEND_API int add_property_string_ex(zval *arg, const char *key, uint key_len, char *str, int duplicate TSRMLS_DC);
421cf7384aaSFelipe PenaZEND_API int add_property_stringl_ex(zval *arg, const char *key, uint key_len,  char *str, uint length, int duplicate TSRMLS_DC);
422cf7384aaSFelipe PenaZEND_API int add_property_zval_ex(zval *arg, const char *key, uint key_len, zval *value TSRMLS_DC);
423eccc5368SStanislav Malyshev
424eccc5368SStanislav Malyshev#define add_property_long(__arg, __key, __n) add_property_long_ex(__arg, __key, strlen(__key)+1, __n TSRMLS_CC)
425eccc5368SStanislav Malyshev#define add_property_null(__arg, __key) add_property_null_ex(__arg, __key, strlen(__key) + 1 TSRMLS_CC)
426eccc5368SStanislav Malyshev#define add_property_bool(__arg, __key, __b) add_property_bool_ex(__arg, __key, strlen(__key)+1, __b TSRMLS_CC)
427eccc5368SStanislav Malyshev#define add_property_resource(__arg, __key, __r) add_property_resource_ex(__arg, __key, strlen(__key)+1, __r TSRMLS_CC)
428637a4042SMarcus Boerger#define add_property_double(__arg, __key, __d) add_property_double_ex(__arg, __key, strlen(__key)+1, __d TSRMLS_CC)
429eccc5368SStanislav Malyshev#define add_property_string(__arg, __key, __str, __duplicate) add_property_string_ex(__arg, __key, strlen(__key)+1, __str, __duplicate TSRMLS_CC)
430eccc5368SStanislav Malyshev#define add_property_stringl(__arg, __key, __str, __length, __duplicate) add_property_stringl_ex(__arg, __key, strlen(__key)+1, __str, __length, __duplicate TSRMLS_CC)
431eccc5368SStanislav Malyshev#define add_property_zval(__arg, __key, __value) add_property_zval_ex(__arg, __key, strlen(__key)+1, __value TSRMLS_CC)
432ef95a346SAndi Gutmans
43392b4013eSZeev Suraski
434f8bbafd6SZeev SuraskiZEND_API int call_user_function(HashTable *function_table, zval **object_pp, zval *function_name, zval *retval_ptr, zend_uint param_count, zval *params[] TSRMLS_DC);
435f8bbafd6SZeev SuraskiZEND_API int call_user_function_ex(HashTable *function_table, zval **object_pp, zval *function_name, zval **retval_ptr_ptr, zend_uint param_count, zval **params[], int no_separation, HashTable *symbol_table TSRMLS_DC);
43692b4013eSZeev Suraski
437f87d4530SNuno LopesZEND_API extern const zend_fcall_info empty_fcall_info;
438f87d4530SNuno LopesZEND_API extern const zend_fcall_info_cache empty_fcall_info_cache;
43992b4013eSZeev Suraski
44064c353abSMarcus Boerger/** Build zend_call_info/cache from a zval*
44164c353abSMarcus Boerger *
44264c353abSMarcus Boerger * Caller is responsible to provide a return value, otherwise the we will crash.
44364c353abSMarcus Boerger * fci->retval_ptr_ptr = NULL;
44464c353abSMarcus Boerger * In order to pass parameters the following members need to be set:
44564c353abSMarcus Boerger * fci->param_count = 0;
44664c353abSMarcus Boerger * fci->params = NULL;
447b4892511SJani Taskinen * The callable_name argument may be NULL.
448e8a8acdfSMarcus Boerger * Set check_flags to IS_CALLABLE_STRICT for every new usage!
449b4892511SJani Taskinen */
450e8a8acdfSMarcus BoergerZEND_API int zend_fcall_info_init(zval *callable, uint check_flags, zend_fcall_info *fci, zend_fcall_info_cache *fcc, char **callable_name, char **error TSRMLS_DC);
451b4892511SJani Taskinen
452b4892511SJani Taskinen/** Clear argumens connected with zend_fcall_info *fci
453b4892511SJani Taskinen * If free_mem is not zero then the params array gets free'd as well
454b4892511SJani Taskinen */
455b4892511SJani TaskinenZEND_API void zend_fcall_info_args_clear(zend_fcall_info *fci, int free_mem);
456b4892511SJani Taskinen
457b4892511SJani Taskinen/** Save current arguments from zend_fcall_info *fci
458b4892511SJani Taskinen * params array will be set to NULL
459b4892511SJani Taskinen */
460b4892511SJani TaskinenZEND_API void zend_fcall_info_args_save(zend_fcall_info *fci, int *param_count, zval ****params);
461b4892511SJani Taskinen
462b4892511SJani Taskinen/** Free arguments connected with zend_fcall_info *fci andset back saved ones.
46364c353abSMarcus Boerger */
464b4892511SJani TaskinenZEND_API void zend_fcall_info_args_restore(zend_fcall_info *fci, int param_count, zval ***params);
46564c353abSMarcus Boerger
46664c353abSMarcus Boerger/** Set or clear the arguments in the zend_call_info struct taking care of
46764c353abSMarcus Boerger * refcount. If args is NULL and arguments are set then those are cleared.
46864c353abSMarcus Boerger */
46964c353abSMarcus BoergerZEND_API int zend_fcall_info_args(zend_fcall_info *fci, zval *args TSRMLS_DC);
47064c353abSMarcus Boerger
471b4892511SJani Taskinen/** Set arguments in the zend_fcall_info struct taking care of refcount.
472b4892511SJani Taskinen * If argc is 0 the arguments which are set will be cleared, else pass
473b4892511SJani Taskinen * a variable amount of zval** arguments.
474b4892511SJani Taskinen */
475b4892511SJani TaskinenZEND_API int zend_fcall_info_argp(zend_fcall_info *fci TSRMLS_DC, int argc, zval ***argv);
476b4892511SJani Taskinen
477b4892511SJani Taskinen/** Set arguments in the zend_fcall_info struct taking care of refcount.
478b4892511SJani Taskinen * If argc is 0 the arguments which are set will be cleared, else pass
479b4892511SJani Taskinen * a variable amount of zval** arguments.
480b4892511SJani Taskinen */
481b4892511SJani TaskinenZEND_API int zend_fcall_info_argv(zend_fcall_info *fci TSRMLS_DC, int argc, va_list *argv);
482b4892511SJani Taskinen
483b4892511SJani Taskinen/** Set arguments in the zend_fcall_info struct taking care of refcount.
484b4892511SJani Taskinen * If argc is 0 the arguments which are set will be cleared, else pass
485b4892511SJani Taskinen * a variable amount of zval** arguments.
486b4892511SJani Taskinen */
487b4892511SJani TaskinenZEND_API int zend_fcall_info_argn(zend_fcall_info *fci TSRMLS_DC, int argc, ...);
488b4892511SJani Taskinen
48964c353abSMarcus Boerger/** Call a function using information created by zend_fcall_info_init()/args().
49064c353abSMarcus Boerger * If args is given then those replace the arguement info in fci is temporarily.
49164c353abSMarcus Boerger */
49264c353abSMarcus BoergerZEND_API int zend_fcall_info_call(zend_fcall_info *fci, zend_fcall_info_cache *fcc, zval **retval, zval *args TSRMLS_DC);
49364c353abSMarcus Boerger
49492b4013eSZeev SuraskiZEND_API int zend_call_function(zend_fcall_info *fci, zend_fcall_info_cache *fci_cache TSRMLS_DC);
49592b4013eSZeev Suraski
496cf7384aaSFelipe PenaZEND_API int zend_set_hash_symbol(zval *symbol, const char *name, int name_length, zend_bool is_ref, int num_symbol_tables, ...);
497f962a35dSAndrei Zmievski
49811bcaedfSAndi GutmansZEND_API int zend_delete_global_variable(char *name, int name_len TSRMLS_DC);
499db507dd1SAndi Gutmans
5001d33a3e9SDmitry StogovZEND_API void zend_reset_all_cv(HashTable *symbol_table TSRMLS_DC);
5011d33a3e9SDmitry Stogov
5022ecf4bb0SDmitry StogovZEND_API void zend_rebuild_symbol_table(TSRMLS_D);
5032ecf4bb0SDmitry Stogov
5044f6c95d1SZeev Suraski#define add_method(arg, key, method)	add_assoc_function((arg), (key), (method))
505573b4602SAndi Gutmans
506a35c61afSAndrei ZmievskiZEND_API ZEND_FUNCTION(display_disabled_function);
507a700180fSHarald RadiZEND_API ZEND_FUNCTION(display_disabled_class);
5081727c6a2SHartmut HolzgraefeEND_EXTERN_C()
509a35c61afSAndrei Zmievski
510bcddfd47SThies C. Arntzen#if ZEND_DEBUG
511bcddfd47SThies C. Arntzen#define CHECK_ZVAL_STRING(z) \
512b4892511SJani Taskinen	if (Z_STRVAL_P(z)[ Z_STRLEN_P(z) ] != '\0') { zend_error(E_WARNING, "String is not zero-terminated (%s)", Z_STRVAL_P(z)); }
51343ebb868SZeev Suraski#define CHECK_ZVAL_STRING_REL(z) \
514b4892511SJani Taskinen	if (Z_STRVAL_P(z)[ Z_STRLEN_P(z) ] != '\0') { zend_error(E_WARNING, "String is not zero-terminated (%s) (source: %s:%d)", Z_STRVAL_P(z) ZEND_FILE_LINE_RELAY_CC); }
515bcddfd47SThies C. Arntzen#else
516bcddfd47SThies C. Arntzen#define CHECK_ZVAL_STRING(z)
51743ebb868SZeev Suraski#define CHECK_ZVAL_STRING_REL(z)
518bcddfd47SThies C. Arntzen#endif
519bcddfd47SThies C. Arntzen
520637a4042SMarcus Boerger#define ZVAL_RESOURCE(z, l) {		\
521637a4042SMarcus Boerger		Z_TYPE_P(z) = IS_RESOURCE;	\
522637a4042SMarcus Boerger		Z_LVAL_P(z) = l;			\
523af22085cSThies C. Arntzen	}
524bcddfd47SThies C. Arntzen
525637a4042SMarcus Boerger#define ZVAL_BOOL(z, b) {			\
526637a4042SMarcus Boerger		Z_TYPE_P(z) = IS_BOOL;		\
527637a4042SMarcus Boerger		Z_LVAL_P(z) = ((b) != 0);   \
528af22085cSThies C. Arntzen	}
529bcddfd47SThies C. Arntzen
530637a4042SMarcus Boerger#define ZVAL_NULL(z) {				\
531637a4042SMarcus Boerger		Z_TYPE_P(z) = IS_NULL;		\
532af22085cSThies C. Arntzen	}
533bcddfd47SThies C. Arntzen
534637a4042SMarcus Boerger#define ZVAL_LONG(z, l) {			\
535637a4042SMarcus Boerger		Z_TYPE_P(z) = IS_LONG;		\
536637a4042SMarcus Boerger		Z_LVAL_P(z) = l;			\
537af22085cSThies C. Arntzen	}
538bcddfd47SThies C. Arntzen
539637a4042SMarcus Boerger#define ZVAL_DOUBLE(z, d) {			\
540637a4042SMarcus Boerger		Z_TYPE_P(z) = IS_DOUBLE;	\
541637a4042SMarcus Boerger		Z_DVAL_P(z) = d;			\
542af22085cSThies C. Arntzen	}
543bcddfd47SThies C. Arntzen
5444f6c95d1SZeev Suraski#define ZVAL_STRING(z, s, duplicate) {	\
545b4892511SJani Taskinen		const char *__s=(s);			\
546b4892511SJani Taskinen		Z_STRLEN_P(z) = strlen(__s);	\
547b4892511SJani Taskinen		Z_STRVAL_P(z) = (duplicate?estrndup(__s, Z_STRLEN_P(z)):(char*)__s);\
548b4892511SJani Taskinen		Z_TYPE_P(z) = IS_STRING;		\
549af22085cSThies C. Arntzen	}
550bcddfd47SThies C. Arntzen
5514f6c95d1SZeev Suraski#define ZVAL_STRINGL(z, s, l, duplicate) {	\
552b4892511SJani Taskinen		const char *__s=(s); int __l=l;		\
553b4892511SJani Taskinen		Z_STRLEN_P(z) = __l;				\
554b4892511SJani Taskinen		Z_STRVAL_P(z) = (duplicate?estrndup(__s, __l):(char*)__s);\
555b4892511SJani Taskinen		Z_TYPE_P(z) = IS_STRING;			\
556af22085cSThies C. Arntzen	}
557af22085cSThies C. Arntzen
558b4892511SJani Taskinen#define ZVAL_EMPTY_STRING(z) {		\
559b4892511SJani Taskinen		Z_STRLEN_P(z) = 0;			\
560b4892511SJani Taskinen		Z_STRVAL_P(z) = STR_EMPTY_ALLOC();\
561b4892511SJani Taskinen		Z_TYPE_P(z) = IS_STRING;	\
562af22085cSThies C. Arntzen	}
563af22085cSThies C. Arntzen
564d90ebc65SDmitry Stogov#define ZVAL_ZVAL(z, zv, copy, dtor) {			\
565d90ebc65SDmitry Stogov		zend_uchar is_ref = Z_ISREF_P(z);		\
566d90ebc65SDmitry Stogov		zend_uint refcount = Z_REFCOUNT_P(z);	\
567d90ebc65SDmitry Stogov		*(z) = *(zv);							\
568d90ebc65SDmitry Stogov		if (copy) {								\
569d90ebc65SDmitry Stogov			zval_copy_ctor(z);					\
570d90ebc65SDmitry Stogov	    }										\
571d90ebc65SDmitry Stogov		if (dtor) {								\
572d90ebc65SDmitry Stogov			if (!copy) {						\
573d90ebc65SDmitry Stogov				ZVAL_NULL(zv);					\
574d90ebc65SDmitry Stogov			}									\
575d90ebc65SDmitry Stogov			zval_ptr_dtor(&zv);					\
576d90ebc65SDmitry Stogov	    }										\
577d90ebc65SDmitry Stogov		Z_SET_ISREF_TO_P(z, is_ref);			\
578d90ebc65SDmitry Stogov		Z_SET_REFCOUNT_P(z, refcount);			\
579c7d27ad9SMarcus Boerger	}
580c7d27ad9SMarcus Boerger
5814f6c95d1SZeev Suraski#define ZVAL_FALSE(z)  					ZVAL_BOOL(z, 0)
5824f6c95d1SZeev Suraski#define ZVAL_TRUE(z)  					ZVAL_BOOL(z, 1)
583af22085cSThies C. Arntzen
5844f6c95d1SZeev Suraski#define RETVAL_RESOURCE(l)				ZVAL_RESOURCE(return_value, l)
5854f6c95d1SZeev Suraski#define RETVAL_BOOL(b)					ZVAL_BOOL(return_value, b)
586bcddfd47SThies C. Arntzen#define RETVAL_NULL() 					ZVAL_NULL(return_value)
5874f6c95d1SZeev Suraski#define RETVAL_LONG(l) 					ZVAL_LONG(return_value, l)
5884f6c95d1SZeev Suraski#define RETVAL_DOUBLE(d) 				ZVAL_DOUBLE(return_value, d)
5894f6c95d1SZeev Suraski#define RETVAL_STRING(s, duplicate) 		ZVAL_STRING(return_value, s, duplicate)
5904f6c95d1SZeev Suraski#define RETVAL_STRINGL(s, l, duplicate) 	ZVAL_STRINGL(return_value, s, l, duplicate)
591bcddfd47SThies C. Arntzen#define RETVAL_EMPTY_STRING() 			ZVAL_EMPTY_STRING(return_value)
592c7d27ad9SMarcus Boerger#define RETVAL_ZVAL(zv, copy, dtor)		ZVAL_ZVAL(return_value, zv, copy, dtor)
5934f6c95d1SZeev Suraski#define RETVAL_FALSE  					ZVAL_BOOL(return_value, 0)
5944f6c95d1SZeev Suraski#define RETVAL_TRUE   					ZVAL_BOOL(return_value, 1)
595bcddfd47SThies C. Arntzen
596bcddfd47SThies C. Arntzen#define RETURN_RESOURCE(l) 				{ RETVAL_RESOURCE(l); return; }
597bcddfd47SThies C. Arntzen#define RETURN_BOOL(b) 					{ RETVAL_BOOL(b); return; }
598bcddfd47SThies C. Arntzen#define RETURN_NULL() 					{ RETVAL_NULL(); return;}
599bcddfd47SThies C. Arntzen#define RETURN_LONG(l) 					{ RETVAL_LONG(l); return; }
600bcddfd47SThies C. Arntzen#define RETURN_DOUBLE(d) 				{ RETVAL_DOUBLE(d); return; }
6014f6c95d1SZeev Suraski#define RETURN_STRING(s, duplicate) 	{ RETVAL_STRING(s, duplicate); return; }
6024f6c95d1SZeev Suraski#define RETURN_STRINGL(s, l, duplicate) { RETVAL_STRINGL(s, l, duplicate); return; }
603bcddfd47SThies C. Arntzen#define RETURN_EMPTY_STRING() 			{ RETVAL_EMPTY_STRING(); return; }
604c7d27ad9SMarcus Boerger#define RETURN_ZVAL(zv, copy, dtor)		{ RETVAL_ZVAL(zv, copy, dtor); return; }
605bcddfd47SThies C. Arntzen#define RETURN_FALSE  					{ RETVAL_FALSE; return; }
606bcddfd47SThies C. Arntzen#define RETURN_TRUE   					{ RETVAL_TRUE; return; }
6071f985edeSZeev Suraski
6084f6c95d1SZeev Suraski#define SET_VAR_STRING(n, v) {																				\
60948ffdd79SZeev Suraski								{																			\
610235386b2SZeev Suraski									zval *var;																\
611235386b2SZeev Suraski									ALLOC_ZVAL(var);														\
6124f6c95d1SZeev Suraski									ZVAL_STRING(var, v, 0);													\
6136393ab14SZeev Suraski									ZEND_SET_GLOBAL_VAR(n, var);											\
61448ffdd79SZeev Suraski								}																			\
6151f985edeSZeev Suraski							}
61648ffdd79SZeev Suraski
6174f6c95d1SZeev Suraski#define SET_VAR_STRINGL(n, v, l) {														\
61848ffdd79SZeev Suraski									{													\
619235386b2SZeev Suraski										zval *var;										\
620235386b2SZeev Suraski										ALLOC_ZVAL(var);								\
6214f6c95d1SZeev Suraski										ZVAL_STRINGL(var, v, l, 0);						\
62248ffdd79SZeev Suraski										ZEND_SET_GLOBAL_VAR(n, var);					\
62348ffdd79SZeev Suraski									}													\
6241f985edeSZeev Suraski								}
62548ffdd79SZeev Suraski
6264f6c95d1SZeev Suraski#define SET_VAR_LONG(n, v)	{															\
62748ffdd79SZeev Suraski								{														\
628235386b2SZeev Suraski									zval *var;											\
629235386b2SZeev Suraski									ALLOC_ZVAL(var);									\
6304f6c95d1SZeev Suraski									ZVAL_LONG(var, v);									\
63148ffdd79SZeev Suraski									ZEND_SET_GLOBAL_VAR(n, var);						\
63248ffdd79SZeev Suraski								}														\
6331f985edeSZeev Suraski							}
63448ffdd79SZeev Suraski
6354f6c95d1SZeev Suraski#define SET_VAR_DOUBLE(n, v) {															\
63648ffdd79SZeev Suraski								{														\
637235386b2SZeev Suraski									zval *var;											\
638235386b2SZeev Suraski									ALLOC_ZVAL(var);									\
6394f6c95d1SZeev Suraski									ZVAL_DOUBLE(var, v);								\
64048ffdd79SZeev Suraski									ZEND_SET_GLOBAL_VAR(n, var);						\
64148ffdd79SZeev Suraski								}														\
6421f985edeSZeev Suraski							}
6431f985edeSZeev Suraski
6441f985edeSZeev Suraski
645c34560b5SAndi Gutmans#define ZEND_SET_SYMBOL(symtable, name, var)										\
646c34560b5SAndi Gutmans	{																				\
647c34560b5SAndi Gutmans		char *_name = (name);														\
648c34560b5SAndi Gutmans																					\
6494c8259b5SAndi Gutmans		ZEND_SET_SYMBOL_WITH_LENGTH(symtable, _name, strlen(_name)+1, var, 1, 0);	\
65048ffdd79SZeev Suraski	}
65148ffdd79SZeev Suraski
652c34560b5SAndi Gutmans#define ZEND_SET_SYMBOL_WITH_LENGTH(symtable, name, name_length, var, _refcount, _is_ref)				\
65348ffdd79SZeev Suraski	{																									\
65448ffdd79SZeev Suraski		zval **orig_var;																				\
65548ffdd79SZeev Suraski																										\
656620d0134SZeev Suraski		if (zend_hash_find(symtable, (name), (name_length), (void **) &orig_var)==SUCCESS				\
65748ffdd79SZeev Suraski			&& PZVAL_IS_REF(*orig_var)) {																\
658b4892511SJani Taskinen			Z_SET_REFCOUNT_P(var, Z_REFCOUNT_PP(orig_var));												\
659b4892511SJani Taskinen			Z_SET_ISREF_P(var);																			\
66048ffdd79SZeev Suraski																										\
6612ddc4fe4SZeev Suraski			if (_refcount) {																			\
662b4892511SJani Taskinen				Z_SET_REFCOUNT_P(var, Z_REFCOUNT_P(var) + _refcount - 1);								\
6632ddc4fe4SZeev Suraski			}																							\
66448ffdd79SZeev Suraski			zval_dtor(*orig_var);																		\
665158088caSZeev Suraski			**orig_var = *(var);																		\
666b4892511SJani Taskinen			FREE_ZVAL(var);																				\
66748ffdd79SZeev Suraski		} else {																						\
668b4892511SJani Taskinen			Z_SET_ISREF_TO_P(var, _is_ref);																\
669158088caSZeev Suraski			if (_refcount) {																			\
670b4892511SJani Taskinen				Z_SET_REFCOUNT_P(var, _refcount);														\
671158088caSZeev Suraski			}																							\
672158088caSZeev Suraski			zend_hash_update(symtable, (name), (name_length), &(var), sizeof(zval *), NULL);			\
67348ffdd79SZeev Suraski		}																								\
67448ffdd79SZeev Suraski	}
67548ffdd79SZeev Suraski
676620d0134SZeev Suraski
677620d0134SZeev Suraski#define ZEND_SET_GLOBAL_VAR(name, var)				\
678620d0134SZeev Suraski	ZEND_SET_SYMBOL(&EG(symbol_table), name, var)
679620d0134SZeev Suraski
680b4892511SJani Taskinen#define ZEND_SET_GLOBAL_VAR_WITH_LENGTH(name, name_length, var, _refcount, _is_ref)	\
681e3450661SAndrei Zmievski	ZEND_SET_SYMBOL_WITH_LENGTH(&EG(symbol_table), name, name_length, var, _refcount, _is_ref)
682fec413c5SAndrei Zmievski
683b4892511SJani Taskinen#define ZEND_DEFINE_PROPERTY(class_ptr, name, value, mask)							\
68413433852SZeev Suraski{																					\
68513433852SZeev Suraski	char *_name = (name);															\
68613433852SZeev Suraski	int namelen = strlen(_name);													\
6877bbbd503SMarcus Boerger	zend_declare_property(class_ptr, _name, namelen, value, mask TSRMLS_CC);		\
688daf3ac65SGeorge Schlossnagle}
689daf3ac65SGeorge Schlossnagle
690637a4042SMarcus 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)))
691637a4042SMarcus Boerger#define ZVAL_IS_NULL(z) (Z_TYPE_P(z)==IS_NULL)
69206a18f16SAndi Gutmans
6938b6f848cSAndi Gutmans/* For compatibility */
6948b6f848cSAndi Gutmans#define ZEND_MINIT			ZEND_MODULE_STARTUP_N
6958b6f848cSAndi Gutmans#define ZEND_MSHUTDOWN		ZEND_MODULE_SHUTDOWN_N
6968b6f848cSAndi Gutmans#define ZEND_RINIT			ZEND_MODULE_ACTIVATE_N
6978b6f848cSAndi Gutmans#define ZEND_RSHUTDOWN		ZEND_MODULE_DEACTIVATE_N
6988b6f848cSAndi Gutmans#define ZEND_MINFO			ZEND_MODULE_INFO_N
699ada4e506SDmitry Stogov#define ZEND_GINIT(module)		((void (*)(void* TSRMLS_DC))(ZEND_MODULE_GLOBALS_CTOR_N(module)))
700ada4e506SDmitry Stogov#define ZEND_GSHUTDOWN(module)	((void (*)(void* TSRMLS_DC))(ZEND_MODULE_GLOBALS_DTOR_N(module)))
7018b6f848cSAndi Gutmans
7028b6f848cSAndi Gutmans#define ZEND_MINIT_FUNCTION			ZEND_MODULE_STARTUP_D
703f5c59863SStanislav Malyshev#define ZEND_MSHUTDOWN_FUNCTION		ZEND_MODULE_SHUTDOWN_D
704f5c59863SStanislav Malyshev#define ZEND_RINIT_FUNCTION			ZEND_MODULE_ACTIVATE_D
705f5c59863SStanislav Malyshev#define ZEND_RSHUTDOWN_FUNCTION		ZEND_MODULE_DEACTIVATE_D
706f5c59863SStanislav Malyshev#define ZEND_MINFO_FUNCTION			ZEND_MODULE_INFO_D
707ada4e506SDmitry Stogov#define ZEND_GINIT_FUNCTION			ZEND_MODULE_GLOBALS_CTOR_D
708ada4e506SDmitry Stogov#define ZEND_GSHUTDOWN_FUNCTION		ZEND_MODULE_GLOBALS_DTOR_D
7098b6f848cSAndi Gutmans
7100450ab94SZeev SuraskiEND_EXTERN_C()
711637a4042SMarcus Boerger
712b982307dSSascha Schumann#endif /* ZEND_API_H */
713573b4602SAndi Gutmans
7148b6f848cSAndi Gutmans
715573b4602SAndi Gutmans/*
716573b4602SAndi Gutmans * Local variables:
717573b4602SAndi Gutmans * tab-width: 4
718573b4602SAndi Gutmans * c-basic-offset: 4
719333406bdSfoobar * indent-tabs-mode: t
720573b4602SAndi Gutmans * End:
721573b4602SAndi Gutmans */
722