zend_API.h revision d90ebc65
1573b4602SAndi Gutmans/*
2573b4602SAndi Gutmans   +----------------------------------------------------------------------+
3573b4602SAndi Gutmans   | Zend Engine                                                          |
4573b4602SAndi Gutmans   +----------------------------------------------------------------------+
5d1dded87SSebastian Bergmann   | Copyright (c) 1998-2008 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
43f8bbafd6SZeev Suraski#define ZEND_FN(name) zif_##name
44637a4042SMarcus Boerger#define ZEND_MN(name) zim_##name
45f8bbafd6SZeev Suraski#define ZEND_NAMED_FUNCTION(name)		void name(INTERNAL_FUNCTION_PARAMETERS)
46f8bbafd6SZeev Suraski#define ZEND_FUNCTION(name)				ZEND_NAMED_FUNCTION(ZEND_FN(name))
47637a4042SMarcus Boerger#define ZEND_METHOD(classname, name)	ZEND_NAMED_FUNCTION(ZEND_MN(classname##_##name))
48f8bbafd6SZeev Suraski
491c2512ddSMarcus 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 },
501c2512ddSMarcus Boerger
511e19ee87SHannes 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 },
521e19ee87SHannes Magnusson#define ZEND_RAW_NAMED_FE(zend_name, name, arg_info) ZEND_RAW_FENTRY(#zend_name, name, arg_info, 0)
531e19ee87SHannes Magnusson
541c2512ddSMarcus Boerger#define ZEND_NAMED_FE(zend_name, name, arg_info)	ZEND_FENTRY(zend_name, name, arg_info, 0)
551c2512ddSMarcus Boerger#define ZEND_FE(name, arg_info)						ZEND_FENTRY(name, ZEND_FN(name), arg_info, 0)
56941b0651SMarcus Boerger#define ZEND_DEP_FE(name, arg_info)                 ZEND_FENTRY(name, ZEND_FN(name), arg_info, ZEND_ACC_DEPRECATED)
57cec053f7SMarcus Boerger#define ZEND_FALIAS(name, alias, arg_info)			ZEND_FENTRY(name, ZEND_FN(alias), arg_info, 0)
58941b0651SMarcus Boerger#define ZEND_DEP_FALIAS(name, alias, arg_info)		ZEND_FENTRY(name, ZEND_FN(alias), arg_info, ZEND_ACC_DEPRECATED)
59637a4042SMarcus Boerger#define ZEND_NAMED_ME(zend_name, name, arg_info, flags)	ZEND_FENTRY(zend_name, name, arg_info, flags)
60637a4042SMarcus Boerger#define ZEND_ME(classname, name, arg_info, flags)	ZEND_FENTRY(name, ZEND_MN(classname##_##name), arg_info, flags)
611c2512ddSMarcus Boerger#define ZEND_ABSTRACT_ME(classname, name, arg_info)	ZEND_FENTRY(name, NULL, arg_info, ZEND_ACC_PUBLIC|ZEND_ACC_ABSTRACT)
6233cdc9edSMarcus Boerger#define ZEND_MALIAS(classname, name, alias, arg_info, flags) \
63637a4042SMarcus Boerger                                                    ZEND_FENTRY(name, ZEND_MN(classname##_##alias), arg_info, flags)
64637a4042SMarcus Boerger#define ZEND_ME_MAPPING(name, func_name, arg_types, flags) ZEND_NAMED_ME(name, ZEND_FN(func_name), arg_types, flags)
65f8bbafd6SZeev Suraski
661a723413SDmitry Stogov#define ZEND_ARG_INFO(pass_by_ref, name)							{ #name, sizeof(#name)-1, NULL, 0, 0, 0, pass_by_ref, 0, 0 },
671a723413SDmitry Stogov#define ZEND_ARG_PASS_INFO(pass_by_ref)								{ NULL, 0, NULL, 0, 0, 0, pass_by_ref, 0, 0 },
681a723413SDmitry 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 },
691a723413SDmitry 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 },
707086634aSZeev Suraski#define ZEND_BEGIN_ARG_INFO_EX(name, pass_rest_by_reference, return_reference, required_num_args)	\
716c810b0dSDmitry Stogov	const zend_arg_info name[] = {																		\
721a723413SDmitry Stogov		{ NULL, 0, NULL, 0, 0, 0, pass_rest_by_reference, return_reference, required_num_args },
73e7e0f7d4SZeev Suraski#define ZEND_BEGIN_ARG_INFO(name, pass_rest_by_reference)	\
74aedbdb08SDmitry Stogov	ZEND_BEGIN_ARG_INFO_EX(name, pass_rest_by_reference, ZEND_RETURN_VALUE, -1)
75f8bbafd6SZeev Suraski#define ZEND_END_ARG_INFO()		};
76342c6e0bSZeev Suraski
778b6f848cSAndi Gutmans/* Name macros */
788b6f848cSAndi Gutmans#define ZEND_MODULE_STARTUP_N(module)       zm_startup_##module
798b6f848cSAndi Gutmans#define ZEND_MODULE_SHUTDOWN_N(module)		zm_shutdown_##module
808b6f848cSAndi Gutmans#define ZEND_MODULE_ACTIVATE_N(module)		zm_activate_##module
818b6f848cSAndi Gutmans#define ZEND_MODULE_DEACTIVATE_N(module)	zm_deactivate_##module
826535933fSDerick Rethans#define ZEND_MODULE_POST_ZEND_DEACTIVATE_N(module)	zm_post_zend_deactivate_##module
838b6f848cSAndi Gutmans#define ZEND_MODULE_INFO_N(module)			zm_info_##module
84ada4e506SDmitry Stogov#define ZEND_MODULE_GLOBALS_CTOR_N(module)  zm_globals_ctor_##module
85ada4e506SDmitry Stogov#define ZEND_MODULE_GLOBALS_DTOR_N(module)  zm_globals_dtor_##module
86342c6e0bSZeev Suraski
878b6f848cSAndi Gutmans/* Declaration macros */
888b6f848cSAndi Gutmans#define ZEND_MODULE_STARTUP_D(module)		int ZEND_MODULE_STARTUP_N(module)(INIT_FUNC_ARGS)
898b6f848cSAndi Gutmans#define ZEND_MODULE_SHUTDOWN_D(module)		int ZEND_MODULE_SHUTDOWN_N(module)(SHUTDOWN_FUNC_ARGS)
908b6f848cSAndi Gutmans#define ZEND_MODULE_ACTIVATE_D(module)		int ZEND_MODULE_ACTIVATE_N(module)(INIT_FUNC_ARGS)
918b6f848cSAndi Gutmans#define ZEND_MODULE_DEACTIVATE_D(module)	int ZEND_MODULE_DEACTIVATE_N(module)(SHUTDOWN_FUNC_ARGS)
926535933fSDerick Rethans#define ZEND_MODULE_POST_ZEND_DEACTIVATE_D(module)	int ZEND_MODULE_POST_ZEND_DEACTIVATE_N(module)(void)
938b6f848cSAndi Gutmans#define ZEND_MODULE_INFO_D(module)			void ZEND_MODULE_INFO_N(module)(ZEND_MODULE_INFO_FUNC_ARGS)
94ada4e506SDmitry Stogov#define ZEND_MODULE_GLOBALS_CTOR_D(module)  void ZEND_MODULE_GLOBALS_CTOR_N(module)(zend_##module##_globals *module##_globals TSRMLS_DC)
95ada4e506SDmitry Stogov#define ZEND_MODULE_GLOBALS_DTOR_D(module)  void ZEND_MODULE_GLOBALS_DTOR_N(module)(zend_##module##_globals *module##_globals TSRMLS_DC)
96342c6e0bSZeev Suraski
970b6d923bSSascha Schumann#define ZEND_GET_MODULE(name) \
98cb71ac03SHartmut Holzgraefe    BEGIN_EXTERN_C()\
99cb71ac03SHartmut Holzgraefe	ZEND_DLEXPORT zend_module_entry *get_module(void) { return &name##_module_entry; }\
100cb71ac03SHartmut Holzgraefe    END_EXTERN_C()
1010d21940dSZeev Suraski
1020d21940dSZeev Suraski#define ZEND_BEGIN_MODULE_GLOBALS(module_name)		\
1030d21940dSZeev Suraski	typedef struct _zend_##module_name##_globals {
1040d21940dSZeev Suraski#define ZEND_END_MODULE_GLOBALS(module_name)		\
1050d21940dSZeev Suraski	} zend_##module_name##_globals;
1060d21940dSZeev Suraski
1070d21940dSZeev Suraski#ifdef ZTS
1080d21940dSZeev Suraski
1090d21940dSZeev Suraski#define ZEND_DECLARE_MODULE_GLOBALS(module_name)							\
11002af513cSAndi Gutmans	ts_rsrc_id module_name##_globals_id;
11102af513cSAndi Gutmans#define ZEND_EXTERN_MODULE_GLOBALS(module_name)								\
11202af513cSAndi Gutmans	extern ts_rsrc_id module_name##_globals_id;
1130d21940dSZeev Suraski#define ZEND_INIT_MODULE_GLOBALS(module_name, globals_ctor, globals_dtor)	\
1142c254ba7SZeev Suraski	ts_allocate_id(&module_name##_globals_id, sizeof(zend_##module_name##_globals), (ts_allocate_ctor) globals_ctor, (ts_allocate_dtor) globals_dtor);
1150d21940dSZeev Suraski
1160d21940dSZeev Suraski#else
1170d21940dSZeev Suraski
1180d21940dSZeev Suraski#define ZEND_DECLARE_MODULE_GLOBALS(module_name)							\
11902af513cSAndi Gutmans	zend_##module_name##_globals module_name##_globals;
12002af513cSAndi Gutmans#define ZEND_EXTERN_MODULE_GLOBALS(module_name)								\
12102af513cSAndi Gutmans	extern zend_##module_name##_globals module_name##_globals;
1220d21940dSZeev Suraski#define ZEND_INIT_MODULE_GLOBALS(module_name, globals_ctor, globals_dtor)	\
1230d21940dSZeev Suraski	globals_ctor(&module_name##_globals);
1240d21940dSZeev Suraski
1250d21940dSZeev Suraski#endif
1260d21940dSZeev Suraski
127b4892511SJani Taskinen#define INIT_CLASS_ENTRY(class_container, class_name, functions) \
128b4892511SJani Taskinen	INIT_OVERLOADED_CLASS_ENTRY(class_container, class_name, functions, NULL, NULL, NULL)
129741b8161SZeev Suraski
130b4892511SJani Taskinen#define INIT_CLASS_ENTRY_EX(class_container, class_name, class_name_len, functions) \
131b4892511SJani Taskinen	INIT_OVERLOADED_CLASS_ENTRY_EX(class_container, class_name, class_name_len, functions, NULL, NULL, NULL, NULL, NULL)
132b4892511SJani Taskinen
133b4892511SJani 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) \
134741b8161SZeev Suraski	{															\
135b4892511SJani Taskinen		int _len = class_name_len;								\
136b4892511SJani Taskinen		class_container.name = zend_strndup(class_name, _len);	\
137b4892511SJani Taskinen		class_container.name_length = _len;						\
138741b8161SZeev Suraski		class_container.builtin_functions = functions;			\
1392eccd95cSAndi Gutmans		class_container.constructor = NULL;						\
14073b159e0SAndi Gutmans		class_container.destructor = NULL;						\
14129ea3da2SAndi Gutmans		class_container.clone = NULL;							\
142637a4042SMarcus Boerger		class_container.serialize = NULL;						\
143637a4042SMarcus Boerger		class_container.unserialize = NULL;						\
144637a4042SMarcus Boerger		class_container.create_object = NULL;					\
1453c62b3b5SMarcus Boerger		class_container.interface_gets_implemented = NULL;		\
14672d0454bSDmitry Stogov		class_container.get_static_method = NULL;				\
147637a4042SMarcus Boerger		class_container.__call = handle_fcall;					\
148b4892511SJani Taskinen		class_container.__callstatic = NULL;					\
149637a4042SMarcus Boerger		class_container.__tostring = NULL;						\
150637a4042SMarcus Boerger		class_container.__get = handle_propget;					\
151637a4042SMarcus Boerger		class_container.__set = handle_propset;					\
152637a4042SMarcus Boerger		class_container.__unset = handle_propunset;				\
153637a4042SMarcus Boerger		class_container.__isset = handle_propisset;				\
154637a4042SMarcus Boerger		class_container.serialize_func = NULL;					\
155637a4042SMarcus Boerger		class_container.unserialize_func = NULL;				\
156637a4042SMarcus Boerger		class_container.serialize = NULL;						\
157637a4042SMarcus Boerger		class_container.unserialize = NULL;						\
158637a4042SMarcus Boerger		class_container.parent = NULL;							\
159637a4042SMarcus Boerger		class_container.num_interfaces = 0;						\
160637a4042SMarcus Boerger		class_container.interfaces = NULL;						\
161637a4042SMarcus Boerger		class_container.get_iterator = NULL;					\
162637a4042SMarcus Boerger		class_container.iterator_funcs.funcs = NULL;			\
163637a4042SMarcus Boerger		class_container.module = NULL;							\
164741b8161SZeev Suraski	}
165741b8161SZeev Suraski
166345e0255SDmitry Stogov#define INIT_OVERLOADED_CLASS_ENTRY(class_container, class_name, functions, handle_fcall, handle_propget, handle_propset) \
167b4892511SJani Taskinen	INIT_OVERLOADED_CLASS_ENTRY_EX(class_container, class_name, sizeof(class_name)-1, functions, handle_fcall, handle_propget, handle_propset, NULL, NULL)
168345e0255SDmitry Stogov
1698768ab94SDmitry Stogov#ifdef ZTS
170e1814f0dSDmitry Stogov#	define CE_STATIC_MEMBERS(ce) (((ce)->type==ZEND_USER_CLASS)?(ce)->static_members:CG(static_members)[(zend_intptr_t)(ce)->static_members])
1718768ab94SDmitry Stogov#else
1728768ab94SDmitry Stogov#	define CE_STATIC_MEMBERS(ce) ((ce)->static_members)
1738768ab94SDmitry Stogov#endif
1748768ab94SDmitry Stogov
175b4892511SJani Taskinen#define ZEND_FCI_INITIALIZED(fci) ((fci).size != 0)
176b4892511SJani Taskinen
177573b4602SAndi Gutmansint zend_next_free_module(void);
178573b4602SAndi Gutmans
1791727c6a2SHartmut HolzgraefeBEGIN_EXTERN_C()
180f77e6a44SZeev SuraskiZEND_API int zend_get_parameters(int ht, int param_count, ...);
18111e5d2f2SZeev SuraskiZEND_API int _zend_get_parameters_array(int ht, int param_count, zval **argument_array TSRMLS_DC);
182f77e6a44SZeev SuraskiZEND_API int zend_get_parameters_ex(int param_count, ...);
18311e5d2f2SZeev SuraskiZEND_API int _zend_get_parameters_array_ex(int param_count, zval ***argument_array TSRMLS_DC);
18411e5d2f2SZeev Suraski
185e39f3f3fSMarcus Boerger/* internal function to efficiently copy parameters when executing __call() */
186e39f3f3fSMarcus BoergerZEND_API int zend_copy_parameters_array(int param_count, zval *argument_array TSRMLS_DC);
187e39f3f3fSMarcus Boerger
18811e5d2f2SZeev Suraski#define zend_get_parameters_array(ht, param_count, argument_array)			\
18911e5d2f2SZeev Suraski	_zend_get_parameters_array(ht, param_count, argument_array TSRMLS_CC)
19011e5d2f2SZeev Suraski#define zend_get_parameters_array_ex(param_count, argument_array)			\
19111e5d2f2SZeev Suraski	_zend_get_parameters_array_ex(param_count, argument_array TSRMLS_CC)
19239f9487eSAndi Gutmans
19358f88057SAndrei Zmievski
19458f88057SAndrei Zmievski/* Parameter parsing API -- andrei */
19558f88057SAndrei Zmievski
19658f88057SAndrei Zmievski#define ZEND_PARSE_PARAMS_QUIET 1<<1
1978ce8324eSZeev SuraskiZEND_API int zend_parse_parameters(int num_args TSRMLS_DC, char *type_spec, ...);
1983839af35SAndrei ZmievskiZEND_API int zend_parse_parameters_ex(int flags, int num_args TSRMLS_DC, char *type_spec, ...);
1999b391a83SDerick RethansZEND_API char *zend_zval_type_name(zval *arg);
20058f88057SAndrei Zmievski
201325f9edbSGeorg RichterZEND_API int zend_parse_method_parameters(int num_args TSRMLS_DC, zval *this_ptr, char *type_spec, ...);
2028d45feceSMarcus BoergerZEND_API int zend_parse_method_parameters_ex(int flags, int num_args TSRMLS_DC, zval *this_ptr, char *type_spec, ...);
203c4528f82SHarald Radi
204b5255495SZeev Suraski/* End of parameter parsing API -- andrei */
20539f9487eSAndi Gutmans
2066c810b0dSDmitry StogovZEND_API int zend_register_functions(zend_class_entry *scope, const zend_function_entry *functions, HashTable *function_table, int type TSRMLS_DC);
2076c810b0dSDmitry StogovZEND_API void zend_unregister_functions(const zend_function_entry *functions, int count, HashTable *function_table TSRMLS_DC);
2082ca2dc0bSDmitry StogovZEND_API int zend_startup_module(zend_module_entry *module_entry);
20970bd938bSDmitry StogovZEND_API zend_module_entry* zend_register_internal_module(zend_module_entry *module_entry TSRMLS_DC);
21070bd938bSDmitry StogovZEND_API zend_module_entry* zend_register_module_ex(zend_module_entry *module TSRMLS_DC);
2112ca2dc0bSDmitry StogovZEND_API int zend_startup_module_ex(zend_module_entry *module TSRMLS_DC);
212c0c7a9f0SDmitry StogovZEND_API int zend_startup_modules(TSRMLS_D);
2136bd3c36aSAndi GutmansZEND_API void zend_check_magic_method_implementation(zend_class_entry *ce, zend_function *fptr, int error_type TSRMLS_DC);
214eb0e6946SAndi Gutmans
215b5770382SZeev SuraskiZEND_API zend_class_entry *zend_register_internal_class(zend_class_entry *class_entry TSRMLS_DC);
216b5770382SZeev 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);
2173c62b3b5SMarcus BoergerZEND_API zend_class_entry *zend_register_internal_interface(zend_class_entry *orig_class_entry TSRMLS_DC);
2184073a084SMarcus BoergerZEND_API void zend_class_implements(zend_class_entry *class_entry TSRMLS_DC, int num_interfaces, ...);
219eb0e6946SAndi Gutmans
220d76cf1daSZeev SuraskiZEND_API int zend_disable_function(char *function_name, uint function_name_length TSRMLS_DC);
221a700180fSHarald RadiZEND_API int zend_disable_class(char *class_name, uint class_name_length TSRMLS_DC);
222573b4602SAndi Gutmans
2234187439cSZeev SuraskiZEND_API void zend_wrong_param_count(TSRMLS_D);
224c81db6bcSDmitry Stogov
225c81db6bcSDmitry Stogov#define IS_CALLABLE_CHECK_SYNTAX_ONLY (1<<0)
226c81db6bcSDmitry Stogov#define IS_CALLABLE_CHECK_NO_ACCESS   (1<<1)
22753e52606SMarcus Boerger#define IS_CALLABLE_CHECK_IS_STATIC   (1<<2)
228c81db6bcSDmitry Stogov
2290cd997d7SMarcus Boerger#define IS_CALLABLE_STRICT  (IS_CALLABLE_CHECK_IS_STATIC)
2300cd997d7SMarcus Boerger
2312486b846SMarcus BoergerZEND_API zend_bool zend_is_callable_ex(zval *callable, uint check_flags, char **callable_name, int *callable_name_len, zend_class_entry **ce_ptr, zend_function **fptr_ptr, zval ***zobj_ptr_ptr TSRMLS_DC);
232c81db6bcSDmitry StogovZEND_API zend_bool zend_is_callable(zval *callable, uint check_flags, char **callable_name);
23326bfe3f8SMarcus BoergerZEND_API zend_bool zend_make_callable(zval *callable, char **callable_name TSRMLS_DC);
2346c810b0dSDmitry StogovZEND_API const char *zend_get_module_version(const char *module_name);
235805dfab8SMarcus BoergerZEND_API int zend_get_module_started(char *module_name);
2367bbbd503SMarcus BoergerZEND_API int zend_declare_property(zend_class_entry *ce, char *name, int name_length, zval *property, int access_type TSRMLS_DC);
23767a226d9SMarcus BoergerZEND_API int zend_declare_property_ex(zend_class_entry *ce, char *name, int name_length, zval *property, int access_type, char *doc_comment, int doc_comment_len TSRMLS_DC);
2387bbbd503SMarcus BoergerZEND_API int zend_declare_property_null(zend_class_entry *ce, char *name, int name_length, int access_type TSRMLS_DC);
239d88c2b18SHartmut HolzgraefeZEND_API int zend_declare_property_bool(zend_class_entry *ce, char *name, int name_length, long value, int access_type TSRMLS_DC);
2407bbbd503SMarcus BoergerZEND_API int zend_declare_property_long(zend_class_entry *ce, char *name, int name_length, long value, int access_type TSRMLS_DC);
241d88c2b18SHartmut HolzgraefeZEND_API int zend_declare_property_double(zend_class_entry *ce, char *name, int name_length, double value, int access_type TSRMLS_DC);
2427bbbd503SMarcus BoergerZEND_API int zend_declare_property_string(zend_class_entry *ce, char *name, int name_length, char *value, int access_type TSRMLS_DC);
243d88c2b18SHartmut 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);
24413433852SZeev Suraski
245248345d9SDmitry StogovZEND_API int zend_declare_class_constant(zend_class_entry *ce, char *name, size_t name_length, zval *value TSRMLS_DC);
24635ce5db2SMarcus BoergerZEND_API int zend_declare_class_constant_null(zend_class_entry *ce, char *name, size_t name_length TSRMLS_DC);
247248345d9SDmitry StogovZEND_API int zend_declare_class_constant_long(zend_class_entry *ce, char *name, size_t name_length, long value TSRMLS_DC);
248248345d9SDmitry StogovZEND_API int zend_declare_class_constant_bool(zend_class_entry *ce, char *name, size_t name_length, zend_bool value TSRMLS_DC);
249248345d9SDmitry StogovZEND_API int zend_declare_class_constant_double(zend_class_entry *ce, char *name, size_t name_length, double value TSRMLS_DC);
250248345d9SDmitry StogovZEND_API int zend_declare_class_constant_stringl(zend_class_entry *ce, char *name, size_t name_length, char *value, size_t value_length TSRMLS_DC);
251248345d9SDmitry StogovZEND_API int zend_declare_class_constant_string(zend_class_entry *ce, char *name, size_t name_length, char *value TSRMLS_DC);
252248345d9SDmitry Stogov
2531d5c13bdSMarcus BoergerZEND_API void zend_update_class_constants(zend_class_entry *class_type TSRMLS_DC);
254baaa4c90SMarcus BoergerZEND_API void zend_update_property(zend_class_entry *scope, zval *object, char *name, int name_length, zval *value TSRMLS_DC);
255baaa4c90SMarcus BoergerZEND_API void zend_update_property_null(zend_class_entry *scope, zval *object, char *name, int name_length TSRMLS_DC);
256d88c2b18SHartmut HolzgraefeZEND_API void zend_update_property_bool(zend_class_entry *scope, zval *object, char *name, int name_length, long value TSRMLS_DC);
257baaa4c90SMarcus BoergerZEND_API void zend_update_property_long(zend_class_entry *scope, zval *object, char *name, int name_length, long value TSRMLS_DC);
258d88c2b18SHartmut HolzgraefeZEND_API void zend_update_property_double(zend_class_entry *scope, zval *object, char *name, int name_length, double value TSRMLS_DC);
259baaa4c90SMarcus BoergerZEND_API void zend_update_property_string(zend_class_entry *scope, zval *object, char *name, int name_length, char *value TSRMLS_DC);
260d88c2b18SHartmut HolzgraefeZEND_API void zend_update_property_stringl(zend_class_entry *scope, zval *object, char *name, int name_length, char *value, int value_length TSRMLS_DC);
261573b4602SAndi Gutmans
262248345d9SDmitry StogovZEND_API int zend_update_static_property(zend_class_entry *scope, char *name, int name_length, zval *value TSRMLS_DC);
263248345d9SDmitry StogovZEND_API int zend_update_static_property_null(zend_class_entry *scope, char *name, int name_length TSRMLS_DC);
264248345d9SDmitry StogovZEND_API int zend_update_static_property_bool(zend_class_entry *scope, char *name, int name_length, long value TSRMLS_DC);
265248345d9SDmitry StogovZEND_API int zend_update_static_property_long(zend_class_entry *scope, char *name, int name_length, long value TSRMLS_DC);
266248345d9SDmitry StogovZEND_API int zend_update_static_property_double(zend_class_entry *scope, char *name, int name_length, double value TSRMLS_DC);
267248345d9SDmitry StogovZEND_API int zend_update_static_property_string(zend_class_entry *scope, char *name, int name_length, char *value TSRMLS_DC);
268248345d9SDmitry StogovZEND_API int zend_update_static_property_stringl(zend_class_entry *scope, char *name, int name_length, char *value, int value_length TSRMLS_DC);
269248345d9SDmitry Stogov
27038805f28SMarcus BoergerZEND_API zval *zend_read_property(zend_class_entry *scope, zval *object, char *name, int name_length, zend_bool silent TSRMLS_DC);
27138805f28SMarcus Boerger
272248345d9SDmitry StogovZEND_API zval *zend_read_static_property(zend_class_entry *scope, char *name, int name_length, zend_bool silent TSRMLS_DC);
273248345d9SDmitry Stogov
2743fc85282SSebastian BergmannZEND_API zend_class_entry *zend_get_class_entry(zval *zobject TSRMLS_DC);
275d5a12960SStanislav MalyshevZEND_API int zend_get_object_classname(zval *object, char **class_name, zend_uint *class_name_len TSRMLS_DC);
2769dd24c6dSAntony DovgalZEND_API char *zend_get_type_by_const(int type);
2776ac6cb10SHarald Radi
278741b8161SZeev Suraski#define getThis() (this_ptr)
279741b8161SZeev Suraski
280131d9cb2SZeev Suraski#define WRONG_PARAM_COUNT					ZEND_WRONG_PARAM_COUNT()
281131d9cb2SZeev Suraski#define WRONG_PARAM_COUNT_WITH_RETVAL(ret)	ZEND_WRONG_PARAM_COUNT_WITH_RETVAL(ret)
282a1ad2872SZeev Suraski#define ARG_COUNT(dummy)	(ht)
283a1ad2872SZeev Suraski#define ZEND_NUM_ARGS()		(ht)
2844187439cSZeev Suraski#define ZEND_WRONG_PARAM_COUNT()					{ zend_wrong_param_count(TSRMLS_C); return; }
2854187439cSZeev Suraski#define ZEND_WRONG_PARAM_COUNT_WITH_RETVAL(ret)		{ zend_wrong_param_count(TSRMLS_C); return ret; }
286573b4602SAndi Gutmans
28780bdd19eSZeev Suraski#ifndef ZEND_WIN32
288573b4602SAndi Gutmans#define DLEXPORT
289573b4602SAndi Gutmans#endif
290573b4602SAndi Gutmans
291ceba50b6SZeev Suraski#define array_init(arg)			_array_init((arg) ZEND_FILE_LINE_CC)
292fcc03510SZeev Suraski#define object_init(arg)		_object_init((arg) ZEND_FILE_LINE_CC TSRMLS_CC)
293fcc03510SZeev Suraski#define object_init_ex(arg, ce)	_object_init_ex((arg), (ce) ZEND_FILE_LINE_CC TSRMLS_CC)
29476a7a5bcSAndi Gutmans#define object_and_properties_init(arg, ce, properties)	_object_and_properties_init((arg), (ce), (properties) ZEND_FILE_LINE_CC TSRMLS_CC)
295ceba50b6SZeev SuraskiZEND_API int _array_init(zval *arg ZEND_FILE_LINE_DC);
296fcc03510SZeev SuraskiZEND_API int _object_init(zval *arg ZEND_FILE_LINE_DC TSRMLS_DC);
297fcc03510SZeev SuraskiZEND_API int _object_init_ex(zval *arg, zend_class_entry *ce ZEND_FILE_LINE_DC TSRMLS_DC);
29876a7a5bcSAndi GutmansZEND_API int _object_and_properties_init(zval *arg, zend_class_entry *ce, HashTable *properties ZEND_FILE_LINE_DC TSRMLS_DC);
2996847fefaSThies C. Arntzen
300047a574eSMarcus BoergerZEND_API void zend_merge_properties(zval *obj, HashTable *properties, int destroy_ht TSRMLS_DC);
301047a574eSMarcus Boerger
3026847fefaSThies C. Arntzen/* no longer supported */
3036c810b0dSDmitry StogovZEND_API int add_assoc_function(zval *arg, const char *key, void (*function_ptr)(INTERNAL_FUNCTION_PARAMETERS));
3046847fefaSThies C. Arntzen
3056c810b0dSDmitry StogovZEND_API int add_assoc_long_ex(zval *arg, const char *key, uint key_len, long n);
3066c810b0dSDmitry StogovZEND_API int add_assoc_null_ex(zval *arg, const char *key, uint key_len);
3076c810b0dSDmitry StogovZEND_API int add_assoc_bool_ex(zval *arg, const char *key, uint key_len, int b);
3086c810b0dSDmitry StogovZEND_API int add_assoc_resource_ex(zval *arg, const char *key, uint key_len, int r);
3096c810b0dSDmitry StogovZEND_API int add_assoc_double_ex(zval *arg, const char *key, uint key_len, double d);
3106c810b0dSDmitry StogovZEND_API int add_assoc_string_ex(zval *arg, const char *key, uint key_len, char *str, int duplicate);
3116c810b0dSDmitry StogovZEND_API int add_assoc_stringl_ex(zval *arg, const char *key, uint key_len, char *str, uint length, int duplicate);
3126c810b0dSDmitry StogovZEND_API int add_assoc_zval_ex(zval *arg, const char *key, uint key_len, zval *value);
313ef95a346SAndi Gutmans
314ef95a346SAndi Gutmans#define add_assoc_long(__arg, __key, __n) add_assoc_long_ex(__arg, __key, strlen(__key)+1, __n)
3150611acb9SAndi Gutmans#define add_assoc_null(__arg, __key) add_assoc_null_ex(__arg, __key, strlen(__key) + 1)
316ef95a346SAndi Gutmans#define add_assoc_bool(__arg, __key, __b) add_assoc_bool_ex(__arg, __key, strlen(__key)+1, __b)
317ef95a346SAndi Gutmans#define add_assoc_resource(__arg, __key, __r) add_assoc_resource_ex(__arg, __key, strlen(__key)+1, __r)
318ef95a346SAndi Gutmans#define add_assoc_double(__arg, __key, __d) add_assoc_double_ex(__arg, __key, strlen(__key)+1, __d)
319ef95a346SAndi Gutmans#define add_assoc_string(__arg, __key, __str, __duplicate) add_assoc_string_ex(__arg, __key, strlen(__key)+1, __str, __duplicate)
320ef95a346SAndi Gutmans#define add_assoc_stringl(__arg, __key, __str, __length, __duplicate) add_assoc_stringl_ex(__arg, __key, strlen(__key)+1, __str, __length, __duplicate)
321ef95a346SAndi Gutmans#define add_assoc_zval(__arg, __key, __value) add_assoc_zval_ex(__arg, __key, strlen(__key)+1, __value)
3226847fefaSThies C. Arntzen
3230611acb9SAndi Gutmans/* unset() functions are only suported for legacy modules and null() functions should be used */
3240611acb9SAndi Gutmans#define add_assoc_unset(__arg, __key) add_assoc_null_ex(__arg, __key, strlen(__key) + 1)
3250611acb9SAndi Gutmans#define add_index_unset(__arg, __key) add_index_null(__arg, __key)
3260611acb9SAndi Gutmans#define add_next_index_unset(__arg) add_next_index_null(__arg)
3270611acb9SAndi Gutmans#define add_property_unset(__arg, __key) add_property_null(__arg, __key)
3280611acb9SAndi Gutmans
329b05b949aSDmitry StogovZEND_API int add_index_long(zval *arg, ulong idx, long n);
330b05b949aSDmitry StogovZEND_API int add_index_null(zval *arg, ulong idx);
331b05b949aSDmitry StogovZEND_API int add_index_bool(zval *arg, ulong idx, int b);
332b05b949aSDmitry StogovZEND_API int add_index_resource(zval *arg, ulong idx, int r);
333b05b949aSDmitry StogovZEND_API int add_index_double(zval *arg, ulong idx, double d);
3346c810b0dSDmitry StogovZEND_API int add_index_string(zval *arg, ulong idx, const char *str, int duplicate);
3356c810b0dSDmitry StogovZEND_API int add_index_stringl(zval *arg, ulong idx, const char *str, uint length, int duplicate);
336b05b949aSDmitry StogovZEND_API int add_index_zval(zval *arg, ulong index, zval *value);
3376847fefaSThies C. Arntzen
338573b4602SAndi GutmansZEND_API int add_next_index_long(zval *arg, long n);
3390611acb9SAndi GutmansZEND_API int add_next_index_null(zval *arg);
3406847fefaSThies C. ArntzenZEND_API int add_next_index_bool(zval *arg, int b);
3416847fefaSThies C. ArntzenZEND_API int add_next_index_resource(zval *arg, int r);
342573b4602SAndi GutmansZEND_API int add_next_index_double(zval *arg, double d);
3436c810b0dSDmitry StogovZEND_API int add_next_index_string(zval *arg, const char *str, int duplicate);
3446c810b0dSDmitry StogovZEND_API int add_next_index_stringl(zval *arg, const char *str, uint length, int duplicate);
345ef95a346SAndi GutmansZEND_API int add_next_index_zval(zval *arg, zval *value);
346ef95a346SAndi Gutmans
3476c810b0dSDmitry StogovZEND_API int add_get_assoc_string_ex(zval *arg, const char *key, uint key_len, const char *str, void **dest, int duplicate);
3486c810b0dSDmitry 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);
349ef95a346SAndi Gutmans
350ef95a346SAndi Gutmans#define add_get_assoc_string(__arg, __key, __str, __dest, __duplicate) add_get_assoc_string_ex(__arg, __key, strlen(__key)+1, __str, __dest, __duplicate)
351ef95a346SAndi 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)
352573b4602SAndi Gutmans
353b05b949aSDmitry StogovZEND_API int add_get_index_long(zval *arg, ulong idx, long l, void **dest);
354b05b949aSDmitry StogovZEND_API int add_get_index_double(zval *arg, ulong idx, double d, void **dest);
3556c810b0dSDmitry StogovZEND_API int add_get_index_string(zval *arg, ulong idx, const char *str, void **dest, int duplicate);
3566c810b0dSDmitry StogovZEND_API int add_get_index_stringl(zval *arg, ulong idx, const char *str, uint length, void **dest, int duplicate);
357573b4602SAndi Gutmans
358eccc5368SStanislav MalyshevZEND_API int add_property_long_ex(zval *arg, char *key, uint key_len, long l TSRMLS_DC);
359eccc5368SStanislav MalyshevZEND_API int add_property_null_ex(zval *arg, char *key, uint key_len TSRMLS_DC);
360eccc5368SStanislav MalyshevZEND_API int add_property_bool_ex(zval *arg, char *key, uint key_len, int b TSRMLS_DC);
361eccc5368SStanislav MalyshevZEND_API int add_property_resource_ex(zval *arg, char *key, uint key_len, long r TSRMLS_DC);
362eccc5368SStanislav MalyshevZEND_API int add_property_double_ex(zval *arg, char *key, uint key_len, double d TSRMLS_DC);
363eccc5368SStanislav MalyshevZEND_API int add_property_string_ex(zval *arg, char *key, uint key_len, char *str, int duplicate TSRMLS_DC);
364eccc5368SStanislav MalyshevZEND_API int add_property_stringl_ex(zval *arg, char *key, uint key_len,  char *str, uint length, int duplicate TSRMLS_DC);
365eccc5368SStanislav MalyshevZEND_API int add_property_zval_ex(zval *arg, char *key, uint key_len, zval *value TSRMLS_DC);
366eccc5368SStanislav Malyshev
367eccc5368SStanislav Malyshev#define add_property_long(__arg, __key, __n) add_property_long_ex(__arg, __key, strlen(__key)+1, __n TSRMLS_CC)
368eccc5368SStanislav Malyshev#define add_property_null(__arg, __key) add_property_null_ex(__arg, __key, strlen(__key) + 1 TSRMLS_CC)
369eccc5368SStanislav Malyshev#define add_property_bool(__arg, __key, __b) add_property_bool_ex(__arg, __key, strlen(__key)+1, __b TSRMLS_CC)
370eccc5368SStanislav Malyshev#define add_property_resource(__arg, __key, __r) add_property_resource_ex(__arg, __key, strlen(__key)+1, __r TSRMLS_CC)
371637a4042SMarcus Boerger#define add_property_double(__arg, __key, __d) add_property_double_ex(__arg, __key, strlen(__key)+1, __d TSRMLS_CC)
372eccc5368SStanislav Malyshev#define add_property_string(__arg, __key, __str, __duplicate) add_property_string_ex(__arg, __key, strlen(__key)+1, __str, __duplicate TSRMLS_CC)
373eccc5368SStanislav Malyshev#define add_property_stringl(__arg, __key, __str, __length, __duplicate) add_property_stringl_ex(__arg, __key, strlen(__key)+1, __str, __length, __duplicate TSRMLS_CC)
374eccc5368SStanislav Malyshev#define add_property_zval(__arg, __key, __value) add_property_zval_ex(__arg, __key, strlen(__key)+1, __value TSRMLS_CC)
375ef95a346SAndi Gutmans
37692b4013eSZeev Suraski
377f8bbafd6SZeev 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);
378f8bbafd6SZeev 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);
3791727c6a2SHartmut HolzgraefeEND_EXTERN_C()
38092b4013eSZeev Suraski
38192b4013eSZeev Suraskitypedef struct _zend_fcall_info {
38292b4013eSZeev Suraski	size_t size;
38392b4013eSZeev Suraski	HashTable *function_table;
38492b4013eSZeev Suraski	zval *function_name;
38592b4013eSZeev Suraski	HashTable *symbol_table;
38692b4013eSZeev Suraski	zval **retval_ptr_ptr;
38792b4013eSZeev Suraski	zend_uint param_count;
38892b4013eSZeev Suraski	zval ***params;
38992b4013eSZeev Suraski	zval **object_pp;
39092b4013eSZeev Suraski	zend_bool no_separation;
39192b4013eSZeev Suraski} zend_fcall_info;
39292b4013eSZeev Suraski
39392b4013eSZeev Suraskitypedef struct _zend_fcall_info_cache {
39492b4013eSZeev Suraski	zend_bool initialized;
39592b4013eSZeev Suraski	zend_function *function_handler;
39692b4013eSZeev Suraski	zend_class_entry *calling_scope;
39792b4013eSZeev Suraski	zval **object_pp;
39892b4013eSZeev Suraski} zend_fcall_info_cache;
39992b4013eSZeev Suraski
4001727c6a2SHartmut HolzgraefeBEGIN_EXTERN_C()
401b4892511SJani TaskinenZEND_API extern zend_fcall_info empty_fcall_info;
40292b4013eSZeev SuraskiZEND_API extern zend_fcall_info_cache empty_fcall_info_cache;
40392b4013eSZeev Suraski
40464c353abSMarcus Boerger/** Build zend_call_info/cache from a zval*
40564c353abSMarcus Boerger *
40664c353abSMarcus Boerger * Caller is responsible to provide a return value, otherwise the we will crash.
40764c353abSMarcus Boerger * fci->retval_ptr_ptr = NULL;
40864c353abSMarcus Boerger * In order to pass parameters the following members need to be set:
40964c353abSMarcus Boerger * fci->param_count = 0;
41064c353abSMarcus Boerger * fci->params = NULL;
411b4892511SJani Taskinen * The callable_name argument may be NULL.
412b4892511SJani Taskinen */
413b4892511SJani TaskinenZEND_API int zend_fcall_info_init(zval *callable, zend_fcall_info *fci, zend_fcall_info_cache *fcc, char **callable_name TSRMLS_DC);
414b4892511SJani Taskinen
415b4892511SJani Taskinen/** Clear argumens connected with zend_fcall_info *fci
416b4892511SJani Taskinen * If free_mem is not zero then the params array gets free'd as well
417b4892511SJani Taskinen */
418b4892511SJani TaskinenZEND_API void zend_fcall_info_args_clear(zend_fcall_info *fci, int free_mem);
419b4892511SJani Taskinen
420b4892511SJani Taskinen/** Save current arguments from zend_fcall_info *fci
421b4892511SJani Taskinen * params array will be set to NULL
422b4892511SJani Taskinen */
423b4892511SJani TaskinenZEND_API void zend_fcall_info_args_save(zend_fcall_info *fci, int *param_count, zval ****params);
424b4892511SJani Taskinen
425b4892511SJani Taskinen/** Free arguments connected with zend_fcall_info *fci andset back saved ones.
42664c353abSMarcus Boerger */
427b4892511SJani TaskinenZEND_API void zend_fcall_info_args_restore(zend_fcall_info *fci, int param_count, zval ***params);
42864c353abSMarcus Boerger
42964c353abSMarcus Boerger/** Set or clear the arguments in the zend_call_info struct taking care of
43064c353abSMarcus Boerger * refcount. If args is NULL and arguments are set then those are cleared.
43164c353abSMarcus Boerger */
43264c353abSMarcus BoergerZEND_API int zend_fcall_info_args(zend_fcall_info *fci, zval *args TSRMLS_DC);
43364c353abSMarcus Boerger
434b4892511SJani Taskinen/** Set arguments in the zend_fcall_info struct taking care of refcount.
435b4892511SJani Taskinen * If argc is 0 the arguments which are set will be cleared, else pass
436b4892511SJani Taskinen * a variable amount of zval** arguments.
437b4892511SJani Taskinen */
438b4892511SJani TaskinenZEND_API int zend_fcall_info_argp(zend_fcall_info *fci TSRMLS_DC, int argc, zval ***argv);
439b4892511SJani Taskinen
440b4892511SJani Taskinen/** Set arguments in the zend_fcall_info struct taking care of refcount.
441b4892511SJani Taskinen * If argc is 0 the arguments which are set will be cleared, else pass
442b4892511SJani Taskinen * a variable amount of zval** arguments.
443b4892511SJani Taskinen */
444b4892511SJani TaskinenZEND_API int zend_fcall_info_argv(zend_fcall_info *fci TSRMLS_DC, int argc, va_list *argv);
445b4892511SJani Taskinen
446b4892511SJani Taskinen/** Set arguments in the zend_fcall_info struct taking care of refcount.
447b4892511SJani Taskinen * If argc is 0 the arguments which are set will be cleared, else pass
448b4892511SJani Taskinen * a variable amount of zval** arguments.
449b4892511SJani Taskinen */
450b4892511SJani TaskinenZEND_API int zend_fcall_info_argn(zend_fcall_info *fci TSRMLS_DC, int argc, ...);
451b4892511SJani Taskinen
45264c353abSMarcus Boerger/** Call a function using information created by zend_fcall_info_init()/args().
45364c353abSMarcus Boerger * If args is given then those replace the arguement info in fci is temporarily.
45464c353abSMarcus Boerger */
45564c353abSMarcus BoergerZEND_API int zend_fcall_info_call(zend_fcall_info *fci, zend_fcall_info_cache *fcc, zval **retval, zval *args TSRMLS_DC);
45664c353abSMarcus Boerger
45792b4013eSZeev SuraskiZEND_API int zend_call_function(zend_fcall_info *fci, zend_fcall_info_cache *fci_cache TSRMLS_DC);
45892b4013eSZeev Suraski
459b4892511SJani TaskinenZEND_API int zend_set_hash_symbol(zval *symbol, char *name, int name_length, zend_bool is_ref, int num_symbol_tables, ...);
460f962a35dSAndrei Zmievski
46111bcaedfSAndi GutmansZEND_API int zend_delete_global_variable(char *name, int name_len TSRMLS_DC);
462db507dd1SAndi Gutmans
4631d33a3e9SDmitry StogovZEND_API void zend_reset_all_cv(HashTable *symbol_table TSRMLS_DC);
4641d33a3e9SDmitry Stogov
4654f6c95d1SZeev Suraski#define add_method(arg, key, method)	add_assoc_function((arg), (key), (method))
466573b4602SAndi Gutmans
467a35c61afSAndrei ZmievskiZEND_API ZEND_FUNCTION(display_disabled_function);
468a700180fSHarald RadiZEND_API ZEND_FUNCTION(display_disabled_class);
4691727c6a2SHartmut HolzgraefeEND_EXTERN_C()
470a35c61afSAndrei Zmievski
471bcddfd47SThies C. Arntzen#if ZEND_DEBUG
472bcddfd47SThies C. Arntzen#define CHECK_ZVAL_STRING(z) \
473b4892511SJani 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)); }
47443ebb868SZeev Suraski#define CHECK_ZVAL_STRING_REL(z) \
475b4892511SJani 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); }
476bcddfd47SThies C. Arntzen#else
477bcddfd47SThies C. Arntzen#define CHECK_ZVAL_STRING(z)
47843ebb868SZeev Suraski#define CHECK_ZVAL_STRING_REL(z)
479bcddfd47SThies C. Arntzen#endif
480bcddfd47SThies C. Arntzen
481637a4042SMarcus Boerger#define ZVAL_RESOURCE(z, l) {		\
482637a4042SMarcus Boerger		Z_TYPE_P(z) = IS_RESOURCE;	\
483637a4042SMarcus Boerger		Z_LVAL_P(z) = l;			\
484af22085cSThies C. Arntzen	}
485bcddfd47SThies C. Arntzen
486637a4042SMarcus Boerger#define ZVAL_BOOL(z, b) {			\
487637a4042SMarcus Boerger		Z_TYPE_P(z) = IS_BOOL;		\
488637a4042SMarcus Boerger		Z_LVAL_P(z) = ((b) != 0);   \
489af22085cSThies C. Arntzen	}
490bcddfd47SThies C. Arntzen
491637a4042SMarcus Boerger#define ZVAL_NULL(z) {				\
492637a4042SMarcus Boerger		Z_TYPE_P(z) = IS_NULL;		\
493af22085cSThies C. Arntzen	}
494bcddfd47SThies C. Arntzen
495637a4042SMarcus Boerger#define ZVAL_LONG(z, l) {			\
496637a4042SMarcus Boerger		Z_TYPE_P(z) = IS_LONG;		\
497637a4042SMarcus Boerger		Z_LVAL_P(z) = l;			\
498af22085cSThies C. Arntzen	}
499bcddfd47SThies C. Arntzen
500637a4042SMarcus Boerger#define ZVAL_DOUBLE(z, d) {			\
501637a4042SMarcus Boerger		Z_TYPE_P(z) = IS_DOUBLE;	\
502637a4042SMarcus Boerger		Z_DVAL_P(z) = d;			\
503af22085cSThies C. Arntzen	}
504bcddfd47SThies C. Arntzen
5054f6c95d1SZeev Suraski#define ZVAL_STRING(z, s, duplicate) {	\
506b4892511SJani Taskinen		const char *__s=(s);			\
507b4892511SJani Taskinen		Z_STRLEN_P(z) = strlen(__s);	\
508b4892511SJani Taskinen		Z_STRVAL_P(z) = (duplicate?estrndup(__s, Z_STRLEN_P(z)):(char*)__s);\
509b4892511SJani Taskinen		Z_TYPE_P(z) = IS_STRING;		\
510af22085cSThies C. Arntzen	}
511bcddfd47SThies C. Arntzen
5124f6c95d1SZeev Suraski#define ZVAL_STRINGL(z, s, l, duplicate) {	\
513b4892511SJani Taskinen		const char *__s=(s); int __l=l;		\
514b4892511SJani Taskinen		Z_STRLEN_P(z) = __l;				\
515b4892511SJani Taskinen		Z_STRVAL_P(z) = (duplicate?estrndup(__s, __l):(char*)__s);\
516b4892511SJani Taskinen		Z_TYPE_P(z) = IS_STRING;			\
517af22085cSThies C. Arntzen	}
518af22085cSThies C. Arntzen
519b4892511SJani Taskinen#define ZVAL_EMPTY_STRING(z) {		\
520b4892511SJani Taskinen		Z_STRLEN_P(z) = 0;			\
521b4892511SJani Taskinen		Z_STRVAL_P(z) = STR_EMPTY_ALLOC();\
522b4892511SJani Taskinen		Z_TYPE_P(z) = IS_STRING;	\
523af22085cSThies C. Arntzen	}
524af22085cSThies C. Arntzen
525d90ebc65SDmitry Stogov#define ZVAL_ZVAL(z, zv, copy, dtor) {			\
526d90ebc65SDmitry Stogov		zend_uchar is_ref = Z_ISREF_P(z);		\
527d90ebc65SDmitry Stogov		zend_uint refcount = Z_REFCOUNT_P(z);	\
528d90ebc65SDmitry Stogov		*(z) = *(zv);							\
529d90ebc65SDmitry Stogov		if (copy) {								\
530d90ebc65SDmitry Stogov			zval_copy_ctor(z);					\
531d90ebc65SDmitry Stogov	    }										\
532d90ebc65SDmitry Stogov		if (dtor) {								\
533d90ebc65SDmitry Stogov			if (!copy) {						\
534d90ebc65SDmitry Stogov				ZVAL_NULL(zv);					\
535d90ebc65SDmitry Stogov			}									\
536d90ebc65SDmitry Stogov			zval_ptr_dtor(&zv);					\
537d90ebc65SDmitry Stogov	    }										\
538d90ebc65SDmitry Stogov		Z_SET_ISREF_TO_P(z, is_ref);			\
539d90ebc65SDmitry Stogov		Z_SET_REFCOUNT_P(z, refcount);			\
540c7d27ad9SMarcus Boerger	}
541c7d27ad9SMarcus Boerger
5424f6c95d1SZeev Suraski#define ZVAL_FALSE(z)  					ZVAL_BOOL(z, 0)
5434f6c95d1SZeev Suraski#define ZVAL_TRUE(z)  					ZVAL_BOOL(z, 1)
544af22085cSThies C. Arntzen
5454f6c95d1SZeev Suraski#define RETVAL_RESOURCE(l)				ZVAL_RESOURCE(return_value, l)
5464f6c95d1SZeev Suraski#define RETVAL_BOOL(b)					ZVAL_BOOL(return_value, b)
547bcddfd47SThies C. Arntzen#define RETVAL_NULL() 					ZVAL_NULL(return_value)
5484f6c95d1SZeev Suraski#define RETVAL_LONG(l) 					ZVAL_LONG(return_value, l)
5494f6c95d1SZeev Suraski#define RETVAL_DOUBLE(d) 				ZVAL_DOUBLE(return_value, d)
5504f6c95d1SZeev Suraski#define RETVAL_STRING(s, duplicate) 		ZVAL_STRING(return_value, s, duplicate)
5514f6c95d1SZeev Suraski#define RETVAL_STRINGL(s, l, duplicate) 	ZVAL_STRINGL(return_value, s, l, duplicate)
552bcddfd47SThies C. Arntzen#define RETVAL_EMPTY_STRING() 			ZVAL_EMPTY_STRING(return_value)
553c7d27ad9SMarcus Boerger#define RETVAL_ZVAL(zv, copy, dtor)		ZVAL_ZVAL(return_value, zv, copy, dtor)
5544f6c95d1SZeev Suraski#define RETVAL_FALSE  					ZVAL_BOOL(return_value, 0)
5554f6c95d1SZeev Suraski#define RETVAL_TRUE   					ZVAL_BOOL(return_value, 1)
556bcddfd47SThies C. Arntzen
557bcddfd47SThies C. Arntzen#define RETURN_RESOURCE(l) 				{ RETVAL_RESOURCE(l); return; }
558bcddfd47SThies C. Arntzen#define RETURN_BOOL(b) 					{ RETVAL_BOOL(b); return; }
559bcddfd47SThies C. Arntzen#define RETURN_NULL() 					{ RETVAL_NULL(); return;}
560bcddfd47SThies C. Arntzen#define RETURN_LONG(l) 					{ RETVAL_LONG(l); return; }
561bcddfd47SThies C. Arntzen#define RETURN_DOUBLE(d) 				{ RETVAL_DOUBLE(d); return; }
5624f6c95d1SZeev Suraski#define RETURN_STRING(s, duplicate) 	{ RETVAL_STRING(s, duplicate); return; }
5634f6c95d1SZeev Suraski#define RETURN_STRINGL(s, l, duplicate) { RETVAL_STRINGL(s, l, duplicate); return; }
564bcddfd47SThies C. Arntzen#define RETURN_EMPTY_STRING() 			{ RETVAL_EMPTY_STRING(); return; }
565c7d27ad9SMarcus Boerger#define RETURN_ZVAL(zv, copy, dtor)		{ RETVAL_ZVAL(zv, copy, dtor); return; }
566bcddfd47SThies C. Arntzen#define RETURN_FALSE  					{ RETVAL_FALSE; return; }
567bcddfd47SThies C. Arntzen#define RETURN_TRUE   					{ RETVAL_TRUE; return; }
5681f985edeSZeev Suraski
5694f6c95d1SZeev Suraski#define SET_VAR_STRING(n, v) {																				\
57048ffdd79SZeev Suraski								{																			\
571235386b2SZeev Suraski									zval *var;																\
572235386b2SZeev Suraski									ALLOC_ZVAL(var);														\
5734f6c95d1SZeev Suraski									ZVAL_STRING(var, v, 0);													\
5746393ab14SZeev Suraski									ZEND_SET_GLOBAL_VAR(n, var);											\
57548ffdd79SZeev Suraski								}																			\
5761f985edeSZeev Suraski							}
57748ffdd79SZeev Suraski
5784f6c95d1SZeev Suraski#define SET_VAR_STRINGL(n, v, l) {														\
57948ffdd79SZeev Suraski									{													\
580235386b2SZeev Suraski										zval *var;										\
581235386b2SZeev Suraski										ALLOC_ZVAL(var);								\
5824f6c95d1SZeev Suraski										ZVAL_STRINGL(var, v, l, 0);						\
58348ffdd79SZeev Suraski										ZEND_SET_GLOBAL_VAR(n, var);					\
58448ffdd79SZeev Suraski									}													\
5851f985edeSZeev Suraski								}
58648ffdd79SZeev Suraski
5874f6c95d1SZeev Suraski#define SET_VAR_LONG(n, v)	{															\
58848ffdd79SZeev Suraski								{														\
589235386b2SZeev Suraski									zval *var;											\
590235386b2SZeev Suraski									ALLOC_ZVAL(var);									\
5914f6c95d1SZeev Suraski									ZVAL_LONG(var, v);									\
59248ffdd79SZeev Suraski									ZEND_SET_GLOBAL_VAR(n, var);						\
59348ffdd79SZeev Suraski								}														\
5941f985edeSZeev Suraski							}
59548ffdd79SZeev Suraski
5964f6c95d1SZeev Suraski#define SET_VAR_DOUBLE(n, v) {															\
59748ffdd79SZeev Suraski								{														\
598235386b2SZeev Suraski									zval *var;											\
599235386b2SZeev Suraski									ALLOC_ZVAL(var);									\
6004f6c95d1SZeev Suraski									ZVAL_DOUBLE(var, v);								\
60148ffdd79SZeev Suraski									ZEND_SET_GLOBAL_VAR(n, var);						\
60248ffdd79SZeev Suraski								}														\
6031f985edeSZeev Suraski							}
6041f985edeSZeev Suraski
6051f985edeSZeev Suraski
606c34560b5SAndi Gutmans#define ZEND_SET_SYMBOL(symtable, name, var)										\
607c34560b5SAndi Gutmans	{																				\
608c34560b5SAndi Gutmans		char *_name = (name);														\
609c34560b5SAndi Gutmans																					\
6104c8259b5SAndi Gutmans		ZEND_SET_SYMBOL_WITH_LENGTH(symtable, _name, strlen(_name)+1, var, 1, 0);	\
61148ffdd79SZeev Suraski	}
61248ffdd79SZeev Suraski
613c34560b5SAndi Gutmans#define ZEND_SET_SYMBOL_WITH_LENGTH(symtable, name, name_length, var, _refcount, _is_ref)				\
61448ffdd79SZeev Suraski	{																									\
61548ffdd79SZeev Suraski		zval **orig_var;																				\
61648ffdd79SZeev Suraski																										\
617620d0134SZeev Suraski		if (zend_hash_find(symtable, (name), (name_length), (void **) &orig_var)==SUCCESS				\
61848ffdd79SZeev Suraski			&& PZVAL_IS_REF(*orig_var)) {																\
619b4892511SJani Taskinen			Z_SET_REFCOUNT_P(var, Z_REFCOUNT_PP(orig_var));												\
620b4892511SJani Taskinen			Z_SET_ISREF_P(var);																			\
62148ffdd79SZeev Suraski																										\
6222ddc4fe4SZeev Suraski			if (_refcount) {																			\
623b4892511SJani Taskinen				Z_SET_REFCOUNT_P(var, Z_REFCOUNT_P(var) + _refcount - 1);								\
6242ddc4fe4SZeev Suraski			}																							\
62548ffdd79SZeev Suraski			zval_dtor(*orig_var);																		\
626158088caSZeev Suraski			**orig_var = *(var);																		\
627b4892511SJani Taskinen			FREE_ZVAL(var);																				\
62848ffdd79SZeev Suraski		} else {																						\
629b4892511SJani Taskinen			Z_SET_ISREF_TO_P(var, _is_ref);																\
630158088caSZeev Suraski			if (_refcount) {																			\
631b4892511SJani Taskinen				Z_SET_REFCOUNT_P(var, _refcount);														\
632158088caSZeev Suraski			}																							\
633158088caSZeev Suraski			zend_hash_update(symtable, (name), (name_length), &(var), sizeof(zval *), NULL);			\
63448ffdd79SZeev Suraski		}																								\
63548ffdd79SZeev Suraski	}
63648ffdd79SZeev Suraski
637620d0134SZeev Suraski
638620d0134SZeev Suraski#define ZEND_SET_GLOBAL_VAR(name, var)				\
639620d0134SZeev Suraski	ZEND_SET_SYMBOL(&EG(symbol_table), name, var)
640620d0134SZeev Suraski
641b4892511SJani Taskinen#define ZEND_SET_GLOBAL_VAR_WITH_LENGTH(name, name_length, var, _refcount, _is_ref)	\
642e3450661SAndrei Zmievski	ZEND_SET_SYMBOL_WITH_LENGTH(&EG(symbol_table), name, name_length, var, _refcount, _is_ref)
643fec413c5SAndrei Zmievski
644b4892511SJani Taskinen#define ZEND_DEFINE_PROPERTY(class_ptr, name, value, mask)							\
64513433852SZeev Suraski{																					\
64613433852SZeev Suraski	char *_name = (name);															\
64713433852SZeev Suraski	int namelen = strlen(_name);													\
6487bbbd503SMarcus Boerger	zend_declare_property(class_ptr, _name, namelen, value, mask TSRMLS_CC);		\
649daf3ac65SGeorge Schlossnagle}
650daf3ac65SGeorge Schlossnagle
651637a4042SMarcus 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)))
652637a4042SMarcus Boerger#define ZVAL_IS_NULL(z) (Z_TYPE_P(z)==IS_NULL)
65306a18f16SAndi Gutmans
6548b6f848cSAndi Gutmans/* For compatibility */
6558b6f848cSAndi Gutmans#define ZEND_MINIT			ZEND_MODULE_STARTUP_N
6568b6f848cSAndi Gutmans#define ZEND_MSHUTDOWN		ZEND_MODULE_SHUTDOWN_N
6578b6f848cSAndi Gutmans#define ZEND_RINIT			ZEND_MODULE_ACTIVATE_N
6588b6f848cSAndi Gutmans#define ZEND_RSHUTDOWN		ZEND_MODULE_DEACTIVATE_N
6598b6f848cSAndi Gutmans#define ZEND_MINFO			ZEND_MODULE_INFO_N
660ada4e506SDmitry Stogov#define ZEND_GINIT(module)		((void (*)(void* TSRMLS_DC))(ZEND_MODULE_GLOBALS_CTOR_N(module)))
661ada4e506SDmitry Stogov#define ZEND_GSHUTDOWN(module)	((void (*)(void* TSRMLS_DC))(ZEND_MODULE_GLOBALS_DTOR_N(module)))
6628b6f848cSAndi Gutmans
6638b6f848cSAndi Gutmans#define ZEND_MINIT_FUNCTION			ZEND_MODULE_STARTUP_D
664f5c59863SStanislav Malyshev#define ZEND_MSHUTDOWN_FUNCTION		ZEND_MODULE_SHUTDOWN_D
665f5c59863SStanislav Malyshev#define ZEND_RINIT_FUNCTION			ZEND_MODULE_ACTIVATE_D
666f5c59863SStanislav Malyshev#define ZEND_RSHUTDOWN_FUNCTION		ZEND_MODULE_DEACTIVATE_D
667f5c59863SStanislav Malyshev#define ZEND_MINFO_FUNCTION			ZEND_MODULE_INFO_D
668ada4e506SDmitry Stogov#define ZEND_GINIT_FUNCTION			ZEND_MODULE_GLOBALS_CTOR_D
669ada4e506SDmitry Stogov#define ZEND_GSHUTDOWN_FUNCTION		ZEND_MODULE_GLOBALS_DTOR_D
6708b6f848cSAndi Gutmans
6710450ab94SZeev SuraskiEND_EXTERN_C()
672637a4042SMarcus Boerger
673b982307dSSascha Schumann#endif /* ZEND_API_H */
674573b4602SAndi Gutmans
6758b6f848cSAndi Gutmans
676573b4602SAndi Gutmans/*
677573b4602SAndi Gutmans * Local variables:
678573b4602SAndi Gutmans * tab-width: 4
679573b4602SAndi Gutmans * c-basic-offset: 4
680333406bdSfoobar * indent-tabs-mode: t
681573b4602SAndi Gutmans * End:
682573b4602SAndi Gutmans */
683