zend_API.h revision ada4e506
1573b4602SAndi Gutmans/*
2573b4602SAndi Gutmans   +----------------------------------------------------------------------+
3573b4602SAndi Gutmans   | Zend Engine                                                          |
4573b4602SAndi Gutmans   +----------------------------------------------------------------------+
561e93ccfSAndi Gutmans   | Copyright (c) 1998-2006 Zend Technologies Ltd. (http://www.zend.com) |
6573b4602SAndi Gutmans   +----------------------------------------------------------------------+
7d863d52aSSebastian Bergmann   | This source file is subject to version 2.00 of the Zend license,     |
8b5b11177SZeev Suraski   | 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"
28b7a5b3c3SZeev Suraski#include "zend_fast_cache.h"
295dba4774SZeev Suraski#include "zend_operators.h"
305dba4774SZeev Suraski#include "zend_variables.h"
31df74f1dfSSascha Schumann#include "zend_execute.h"
32573b4602SAndi Gutmans
330450ab94SZeev Suraski
340450ab94SZeev SuraskiBEGIN_EXTERN_C()
35e9d126a7SAndi Gutmans
36f8bbafd6SZeev Suraskitypedef struct _zend_function_entry {
37f8bbafd6SZeev Suraski	char *fname;
38f8bbafd6SZeev Suraski	void (*handler)(INTERNAL_FUNCTION_PARAMETERS);
39f8bbafd6SZeev Suraski	struct _zend_arg_info *arg_info;
40f8bbafd6SZeev Suraski	zend_uint num_args;
41f8bbafd6SZeev Suraski	zend_uint flags;
42f8bbafd6SZeev Suraski} zend_function_entry;
43f8bbafd6SZeev Suraski
44f8bbafd6SZeev Suraski#define ZEND_FN(name) zif_##name
45637a4042SMarcus Boerger#define ZEND_MN(name) zim_##name
46f8bbafd6SZeev Suraski#define ZEND_NAMED_FUNCTION(name)		void name(INTERNAL_FUNCTION_PARAMETERS)
47f8bbafd6SZeev Suraski#define ZEND_FUNCTION(name)				ZEND_NAMED_FUNCTION(ZEND_FN(name))
48637a4042SMarcus Boerger#define ZEND_METHOD(classname, name)	ZEND_NAMED_FUNCTION(ZEND_MN(classname##_##name))
49f8bbafd6SZeev Suraski
501c2512ddSMarcus 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 },
511c2512ddSMarcus Boerger
521c2512ddSMarcus Boerger#define ZEND_NAMED_FE(zend_name, name, arg_info)	ZEND_FENTRY(zend_name, name, arg_info, 0)
531c2512ddSMarcus Boerger#define ZEND_FE(name, arg_info)						ZEND_FENTRY(name, ZEND_FN(name), arg_info, 0)
54941b0651SMarcus Boerger#define ZEND_DEP_FE(name, arg_info)                 ZEND_FENTRY(name, ZEND_FN(name), arg_info, ZEND_ACC_DEPRECATED)
55cec053f7SMarcus Boerger#define ZEND_FALIAS(name, alias, arg_info)			ZEND_FENTRY(name, ZEND_FN(alias), arg_info, 0)
56941b0651SMarcus Boerger#define ZEND_DEP_FALIAS(name, alias, arg_info)		ZEND_FENTRY(name, ZEND_FN(alias), arg_info, ZEND_ACC_DEPRECATED)
57637a4042SMarcus Boerger#define ZEND_NAMED_ME(zend_name, name, arg_info, flags)	ZEND_FENTRY(zend_name, name, arg_info, flags)
58637a4042SMarcus Boerger#define ZEND_ME(classname, name, arg_info, flags)	ZEND_FENTRY(name, ZEND_MN(classname##_##name), arg_info, flags)
591c2512ddSMarcus Boerger#define ZEND_ABSTRACT_ME(classname, name, arg_info)	ZEND_FENTRY(name, NULL, arg_info, ZEND_ACC_PUBLIC|ZEND_ACC_ABSTRACT)
6033cdc9edSMarcus Boerger#define ZEND_MALIAS(classname, name, alias, arg_info, flags) \
61637a4042SMarcus Boerger                                                    ZEND_FENTRY(name, ZEND_MN(classname##_##alias), arg_info, flags)
62637a4042SMarcus Boerger#define ZEND_ME_MAPPING(name, func_name, arg_types, flags) ZEND_NAMED_ME(name, ZEND_FN(func_name), arg_types, flags)
63f8bbafd6SZeev Suraski
641a723413SDmitry Stogov#define ZEND_ARG_INFO(pass_by_ref, name)							{ #name, sizeof(#name)-1, NULL, 0, 0, 0, pass_by_ref, 0, 0 },
651a723413SDmitry Stogov#define ZEND_ARG_PASS_INFO(pass_by_ref)								{ NULL, 0, NULL, 0, 0, 0, pass_by_ref, 0, 0 },
661a723413SDmitry 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 },
671a723413SDmitry 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 },
687086634aSZeev Suraski#define ZEND_BEGIN_ARG_INFO_EX(name, pass_rest_by_reference, return_reference, required_num_args)	\
697086634aSZeev Suraski	zend_arg_info name[] = {																		\
701a723413SDmitry Stogov		{ NULL, 0, NULL, 0, 0, 0, pass_rest_by_reference, return_reference, required_num_args },
71e7e0f7d4SZeev Suraski#define ZEND_BEGIN_ARG_INFO(name, pass_rest_by_reference)	\
72aedbdb08SDmitry Stogov	ZEND_BEGIN_ARG_INFO_EX(name, pass_rest_by_reference, ZEND_RETURN_VALUE, -1)
73f8bbafd6SZeev Suraski#define ZEND_END_ARG_INFO()		};
74342c6e0bSZeev Suraski
758b6f848cSAndi Gutmans/* Name macros */
768b6f848cSAndi Gutmans#define ZEND_MODULE_STARTUP_N(module)       zm_startup_##module
778b6f848cSAndi Gutmans#define ZEND_MODULE_SHUTDOWN_N(module)		zm_shutdown_##module
788b6f848cSAndi Gutmans#define ZEND_MODULE_ACTIVATE_N(module)		zm_activate_##module
798b6f848cSAndi Gutmans#define ZEND_MODULE_DEACTIVATE_N(module)	zm_deactivate_##module
806535933fSDerick Rethans#define ZEND_MODULE_POST_ZEND_DEACTIVATE_N(module)	zm_post_zend_deactivate_##module
818b6f848cSAndi Gutmans#define ZEND_MODULE_INFO_N(module)			zm_info_##module
82ada4e506SDmitry Stogov#define ZEND_MODULE_GLOBALS_CTOR_N(module)  zm_globals_ctor_##module
83ada4e506SDmitry Stogov#define ZEND_MODULE_GLOBALS_DTOR_N(module)  zm_globals_dtor_##module
84342c6e0bSZeev Suraski
858b6f848cSAndi Gutmans/* Declaration macros */
868b6f848cSAndi Gutmans#define ZEND_MODULE_STARTUP_D(module)		int ZEND_MODULE_STARTUP_N(module)(INIT_FUNC_ARGS)
878b6f848cSAndi Gutmans#define ZEND_MODULE_SHUTDOWN_D(module)		int ZEND_MODULE_SHUTDOWN_N(module)(SHUTDOWN_FUNC_ARGS)
888b6f848cSAndi Gutmans#define ZEND_MODULE_ACTIVATE_D(module)		int ZEND_MODULE_ACTIVATE_N(module)(INIT_FUNC_ARGS)
898b6f848cSAndi Gutmans#define ZEND_MODULE_DEACTIVATE_D(module)	int ZEND_MODULE_DEACTIVATE_N(module)(SHUTDOWN_FUNC_ARGS)
906535933fSDerick Rethans#define ZEND_MODULE_POST_ZEND_DEACTIVATE_D(module)	int ZEND_MODULE_POST_ZEND_DEACTIVATE_N(module)(void)
918b6f848cSAndi Gutmans#define ZEND_MODULE_INFO_D(module)			void ZEND_MODULE_INFO_N(module)(ZEND_MODULE_INFO_FUNC_ARGS)
92ada4e506SDmitry Stogov#define ZEND_MODULE_GLOBALS_CTOR_D(module)  void ZEND_MODULE_GLOBALS_CTOR_N(module)(zend_##module##_globals *module##_globals TSRMLS_DC)
93ada4e506SDmitry Stogov#define ZEND_MODULE_GLOBALS_DTOR_D(module)  void ZEND_MODULE_GLOBALS_DTOR_N(module)(zend_##module##_globals *module##_globals TSRMLS_DC)
94342c6e0bSZeev Suraski
950b6d923bSSascha Schumann#define ZEND_GET_MODULE(name) \
96cb71ac03SHartmut Holzgraefe    BEGIN_EXTERN_C()\
97cb71ac03SHartmut Holzgraefe	ZEND_DLEXPORT zend_module_entry *get_module(void) { return &name##_module_entry; }\
98cb71ac03SHartmut Holzgraefe    END_EXTERN_C()
990d21940dSZeev Suraski
1000d21940dSZeev Suraski#define ZEND_BEGIN_MODULE_GLOBALS(module_name)		\
1010d21940dSZeev Suraski	typedef struct _zend_##module_name##_globals {
1020d21940dSZeev Suraski#define ZEND_END_MODULE_GLOBALS(module_name)		\
1030d21940dSZeev Suraski	} zend_##module_name##_globals;
1040d21940dSZeev Suraski
1050d21940dSZeev Suraski#ifdef ZTS
1060d21940dSZeev Suraski
1070d21940dSZeev Suraski#define ZEND_DECLARE_MODULE_GLOBALS(module_name)							\
10802af513cSAndi Gutmans	ts_rsrc_id module_name##_globals_id;
10902af513cSAndi Gutmans#define ZEND_EXTERN_MODULE_GLOBALS(module_name)								\
11002af513cSAndi Gutmans	extern ts_rsrc_id module_name##_globals_id;
1110d21940dSZeev Suraski#define ZEND_INIT_MODULE_GLOBALS(module_name, globals_ctor, globals_dtor)	\
1122c254ba7SZeev Suraski	ts_allocate_id(&module_name##_globals_id, sizeof(zend_##module_name##_globals), (ts_allocate_ctor) globals_ctor, (ts_allocate_dtor) globals_dtor);
1130d21940dSZeev Suraski
1140d21940dSZeev Suraski#else
1150d21940dSZeev Suraski
1160d21940dSZeev Suraski#define ZEND_DECLARE_MODULE_GLOBALS(module_name)							\
11702af513cSAndi Gutmans	zend_##module_name##_globals module_name##_globals;
11802af513cSAndi Gutmans#define ZEND_EXTERN_MODULE_GLOBALS(module_name)								\
11902af513cSAndi Gutmans	extern zend_##module_name##_globals module_name##_globals;
1200d21940dSZeev Suraski#define ZEND_INIT_MODULE_GLOBALS(module_name, globals_ctor, globals_dtor)	\
1210d21940dSZeev Suraski	globals_ctor(&module_name##_globals);
1220d21940dSZeev Suraski
1230d21940dSZeev Suraski#endif
1240d21940dSZeev Suraski
1253738a6edSHarald Radi#define INIT_CLASS_ENTRY(class_container, class_name, functions) INIT_OVERLOADED_CLASS_ENTRY(class_container, class_name, functions, NULL, NULL, NULL)
126741b8161SZeev Suraski
127345e0255SDmitry Stogov#define INIT_OVERLOADED_CLASS_ENTRY_EX(class_container, class_name, functions, handle_fcall, handle_propget, handle_propset, handle_propunset, handle_propisset) \
128741b8161SZeev Suraski	{															\
129741b8161SZeev Suraski		class_container.name = strdup(class_name);				\
130b1b8ed64SMarcus Boerger		class_container.name_length = sizeof(class_name) - 1;	\
131741b8161SZeev Suraski		class_container.builtin_functions = functions;			\
1322eccd95cSAndi Gutmans		class_container.constructor = NULL;						\
13373b159e0SAndi Gutmans		class_container.destructor = NULL;						\
13429ea3da2SAndi Gutmans		class_container.clone = NULL;							\
135637a4042SMarcus Boerger		class_container.serialize = NULL;						\
136637a4042SMarcus Boerger		class_container.unserialize = NULL;						\
137637a4042SMarcus Boerger		class_container.create_object = NULL;					\
1383c62b3b5SMarcus Boerger		class_container.interface_gets_implemented = NULL;		\
139637a4042SMarcus Boerger		class_container.__call = handle_fcall;					\
140637a4042SMarcus Boerger		class_container.__tostring = NULL;						\
141637a4042SMarcus Boerger		class_container.__get = handle_propget;					\
142637a4042SMarcus Boerger		class_container.__set = handle_propset;					\
143637a4042SMarcus Boerger		class_container.__unset = handle_propunset;				\
144637a4042SMarcus Boerger		class_container.__isset = handle_propisset;				\
145637a4042SMarcus Boerger		class_container.serialize_func = NULL;					\
146637a4042SMarcus Boerger		class_container.unserialize_func = NULL;				\
147637a4042SMarcus Boerger		class_container.serialize = NULL;						\
148637a4042SMarcus Boerger		class_container.unserialize = NULL;						\
149637a4042SMarcus Boerger		class_container.parent = NULL;							\
150637a4042SMarcus Boerger		class_container.num_interfaces = 0;						\
151637a4042SMarcus Boerger		class_container.interfaces = NULL;						\
152637a4042SMarcus Boerger		class_container.get_iterator = NULL;					\
153637a4042SMarcus Boerger		class_container.iterator_funcs.funcs = NULL;			\
154637a4042SMarcus Boerger		class_container.module = NULL;							\
155741b8161SZeev Suraski	}
156741b8161SZeev Suraski
157345e0255SDmitry Stogov#define INIT_OVERLOADED_CLASS_ENTRY(class_container, class_name, functions, handle_fcall, handle_propget, handle_propset) \
158345e0255SDmitry Stogov	INIT_OVERLOADED_CLASS_ENTRY_EX(class_container, class_name, functions, handle_fcall, handle_propget, handle_propset, NULL, NULL)
159345e0255SDmitry Stogov
1608768ab94SDmitry Stogov#ifdef ZTS
1618768ab94SDmitry Stogov#	define CE_STATIC_MEMBERS(ce) (((ce)->type==ZEND_USER_CLASS)?(ce)->static_members:CG(static_members)[(long)(ce)->static_members])
1628768ab94SDmitry Stogov#else
1638768ab94SDmitry Stogov#	define CE_STATIC_MEMBERS(ce) ((ce)->static_members)
1648768ab94SDmitry Stogov#endif
1658768ab94SDmitry Stogov
166573b4602SAndi Gutmansint zend_next_free_module(void);
167573b4602SAndi Gutmans
1681727c6a2SHartmut HolzgraefeBEGIN_EXTERN_C()
169f77e6a44SZeev SuraskiZEND_API int zend_get_parameters(int ht, int param_count, ...);
17011e5d2f2SZeev SuraskiZEND_API int _zend_get_parameters_array(int ht, int param_count, zval **argument_array TSRMLS_DC);
171f77e6a44SZeev SuraskiZEND_API int zend_get_parameters_ex(int param_count, ...);
17211e5d2f2SZeev SuraskiZEND_API int _zend_get_parameters_array_ex(int param_count, zval ***argument_array TSRMLS_DC);
17311e5d2f2SZeev Suraski
174e39f3f3fSMarcus Boerger/* internal function to efficiently copy parameters when executing __call() */
175e39f3f3fSMarcus BoergerZEND_API int zend_copy_parameters_array(int param_count, zval *argument_array TSRMLS_DC);
176e39f3f3fSMarcus Boerger
17711e5d2f2SZeev Suraski#define zend_get_parameters_array(ht, param_count, argument_array)			\
17811e5d2f2SZeev Suraski	_zend_get_parameters_array(ht, param_count, argument_array TSRMLS_CC)
17911e5d2f2SZeev Suraski#define zend_get_parameters_array_ex(param_count, argument_array)			\
18011e5d2f2SZeev Suraski	_zend_get_parameters_array_ex(param_count, argument_array TSRMLS_CC)
18139f9487eSAndi Gutmans
18258f88057SAndrei Zmievski
18358f88057SAndrei Zmievski/* Parameter parsing API -- andrei */
18458f88057SAndrei Zmievski
18558f88057SAndrei Zmievski#define ZEND_PARSE_PARAMS_QUIET 1<<1
1868ce8324eSZeev SuraskiZEND_API int zend_parse_parameters(int num_args TSRMLS_DC, char *type_spec, ...);
1873839af35SAndrei ZmievskiZEND_API int zend_parse_parameters_ex(int flags, int num_args TSRMLS_DC, char *type_spec, ...);
1889b391a83SDerick RethansZEND_API char *zend_zval_type_name(zval *arg);
18958f88057SAndrei Zmievski
190325f9edbSGeorg RichterZEND_API int zend_parse_method_parameters(int num_args TSRMLS_DC, zval *this_ptr, char *type_spec, ...);
1918d45feceSMarcus BoergerZEND_API int zend_parse_method_parameters_ex(int flags, int num_args TSRMLS_DC, zval *this_ptr, char *type_spec, ...);
192c4528f82SHarald Radi
193b5255495SZeev Suraski/* End of parameter parsing API -- andrei */
19439f9487eSAndi Gutmans
195273c1933SWez FurlongZEND_API int zend_register_functions(zend_class_entry *scope, zend_function_entry *functions, HashTable *function_table, int type TSRMLS_DC);
196273c1933SWez FurlongZEND_API void zend_unregister_functions(zend_function_entry *functions, int count, HashTable *function_table TSRMLS_DC);
1972ca2dc0bSDmitry StogovZEND_API int zend_startup_module(zend_module_entry *module_entry);
19870bd938bSDmitry StogovZEND_API zend_module_entry* zend_register_internal_module(zend_module_entry *module_entry TSRMLS_DC);
19970bd938bSDmitry StogovZEND_API zend_module_entry* zend_register_module_ex(zend_module_entry *module TSRMLS_DC);
2002ca2dc0bSDmitry StogovZEND_API int zend_startup_module_ex(zend_module_entry *module TSRMLS_DC);
201c0c7a9f0SDmitry StogovZEND_API int zend_startup_modules(TSRMLS_D);
2026bd3c36aSAndi GutmansZEND_API void zend_check_magic_method_implementation(zend_class_entry *ce, zend_function *fptr, int error_type TSRMLS_DC);
203eb0e6946SAndi Gutmans
204b5770382SZeev SuraskiZEND_API zend_class_entry *zend_register_internal_class(zend_class_entry *class_entry TSRMLS_DC);
205b5770382SZeev 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);
2063c62b3b5SMarcus BoergerZEND_API zend_class_entry *zend_register_internal_interface(zend_class_entry *orig_class_entry TSRMLS_DC);
2074073a084SMarcus BoergerZEND_API void zend_class_implements(zend_class_entry *class_entry TSRMLS_DC, int num_interfaces, ...);
208eb0e6946SAndi Gutmans
209d76cf1daSZeev SuraskiZEND_API int zend_disable_function(char *function_name, uint function_name_length TSRMLS_DC);
210a700180fSHarald RadiZEND_API int zend_disable_class(char *class_name, uint class_name_length TSRMLS_DC);
211573b4602SAndi Gutmans
2124187439cSZeev SuraskiZEND_API void zend_wrong_param_count(TSRMLS_D);
213c81db6bcSDmitry Stogov
214c81db6bcSDmitry Stogov#define IS_CALLABLE_CHECK_SYNTAX_ONLY (1<<0)
215c81db6bcSDmitry Stogov#define IS_CALLABLE_CHECK_NO_ACCESS   (1<<1)
21653e52606SMarcus Boerger#define IS_CALLABLE_CHECK_IS_STATIC   (1<<2)
217c81db6bcSDmitry Stogov
2180cd997d7SMarcus Boerger#define IS_CALLABLE_STRICT  (IS_CALLABLE_CHECK_IS_STATIC)
2190cd997d7SMarcus Boerger
2202486b846SMarcus 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);
221c81db6bcSDmitry StogovZEND_API zend_bool zend_is_callable(zval *callable, uint check_flags, char **callable_name);
22226bfe3f8SMarcus BoergerZEND_API zend_bool zend_make_callable(zval *callable, char **callable_name TSRMLS_DC);
22301850714SSebastian BergmannZEND_API char *zend_get_module_version(char *module_name);
224805dfab8SMarcus BoergerZEND_API int zend_get_module_started(char *module_name);
2257bbbd503SMarcus BoergerZEND_API int zend_declare_property(zend_class_entry *ce, char *name, int name_length, zval *property, int access_type TSRMLS_DC);
22667a226d9SMarcus 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);
2277bbbd503SMarcus BoergerZEND_API int zend_declare_property_null(zend_class_entry *ce, char *name, int name_length, int access_type TSRMLS_DC);
228d88c2b18SHartmut HolzgraefeZEND_API int zend_declare_property_bool(zend_class_entry *ce, char *name, int name_length, long value, int access_type TSRMLS_DC);
2297bbbd503SMarcus BoergerZEND_API int zend_declare_property_long(zend_class_entry *ce, char *name, int name_length, long value, int access_type TSRMLS_DC);
230d88c2b18SHartmut HolzgraefeZEND_API int zend_declare_property_double(zend_class_entry *ce, char *name, int name_length, double value, int access_type TSRMLS_DC);
2317bbbd503SMarcus BoergerZEND_API int zend_declare_property_string(zend_class_entry *ce, char *name, int name_length, char *value, int access_type TSRMLS_DC);
232d88c2b18SHartmut 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);
23313433852SZeev Suraski
234248345d9SDmitry StogovZEND_API int zend_declare_class_constant(zend_class_entry *ce, char *name, size_t name_length, zval *value TSRMLS_DC);
23535ce5db2SMarcus BoergerZEND_API int zend_declare_class_constant_null(zend_class_entry *ce, char *name, size_t name_length TSRMLS_DC);
236248345d9SDmitry StogovZEND_API int zend_declare_class_constant_long(zend_class_entry *ce, char *name, size_t name_length, long value TSRMLS_DC);
237248345d9SDmitry StogovZEND_API int zend_declare_class_constant_bool(zend_class_entry *ce, char *name, size_t name_length, zend_bool value TSRMLS_DC);
238248345d9SDmitry StogovZEND_API int zend_declare_class_constant_double(zend_class_entry *ce, char *name, size_t name_length, double value TSRMLS_DC);
239248345d9SDmitry 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);
240248345d9SDmitry StogovZEND_API int zend_declare_class_constant_string(zend_class_entry *ce, char *name, size_t name_length, char *value TSRMLS_DC);
241248345d9SDmitry Stogov
2421d5c13bdSMarcus BoergerZEND_API void zend_update_class_constants(zend_class_entry *class_type TSRMLS_DC);
243baaa4c90SMarcus BoergerZEND_API void zend_update_property(zend_class_entry *scope, zval *object, char *name, int name_length, zval *value TSRMLS_DC);
244baaa4c90SMarcus BoergerZEND_API void zend_update_property_null(zend_class_entry *scope, zval *object, char *name, int name_length TSRMLS_DC);
245d88c2b18SHartmut HolzgraefeZEND_API void zend_update_property_bool(zend_class_entry *scope, zval *object, char *name, int name_length, long value TSRMLS_DC);
246baaa4c90SMarcus BoergerZEND_API void zend_update_property_long(zend_class_entry *scope, zval *object, char *name, int name_length, long value TSRMLS_DC);
247d88c2b18SHartmut HolzgraefeZEND_API void zend_update_property_double(zend_class_entry *scope, zval *object, char *name, int name_length, double value TSRMLS_DC);
248baaa4c90SMarcus BoergerZEND_API void zend_update_property_string(zend_class_entry *scope, zval *object, char *name, int name_length, char *value TSRMLS_DC);
249d88c2b18SHartmut 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);
250573b4602SAndi Gutmans
251248345d9SDmitry StogovZEND_API int zend_update_static_property(zend_class_entry *scope, char *name, int name_length, zval *value TSRMLS_DC);
252248345d9SDmitry StogovZEND_API int zend_update_static_property_null(zend_class_entry *scope, char *name, int name_length TSRMLS_DC);
253248345d9SDmitry StogovZEND_API int zend_update_static_property_bool(zend_class_entry *scope, char *name, int name_length, long value TSRMLS_DC);
254248345d9SDmitry StogovZEND_API int zend_update_static_property_long(zend_class_entry *scope, char *name, int name_length, long value TSRMLS_DC);
255248345d9SDmitry StogovZEND_API int zend_update_static_property_double(zend_class_entry *scope, char *name, int name_length, double value TSRMLS_DC);
256248345d9SDmitry StogovZEND_API int zend_update_static_property_string(zend_class_entry *scope, char *name, int name_length, char *value TSRMLS_DC);
257248345d9SDmitry StogovZEND_API int zend_update_static_property_stringl(zend_class_entry *scope, char *name, int name_length, char *value, int value_length TSRMLS_DC);
258248345d9SDmitry Stogov
25938805f28SMarcus BoergerZEND_API zval *zend_read_property(zend_class_entry *scope, zval *object, char *name, int name_length, zend_bool silent TSRMLS_DC);
26038805f28SMarcus Boerger
261248345d9SDmitry StogovZEND_API zval *zend_read_static_property(zend_class_entry *scope, char *name, int name_length, zend_bool silent TSRMLS_DC);
262248345d9SDmitry Stogov
2633fc85282SSebastian BergmannZEND_API zend_class_entry *zend_get_class_entry(zval *zobject TSRMLS_DC);
264d5a12960SStanislav MalyshevZEND_API int zend_get_object_classname(zval *object, char **class_name, zend_uint *class_name_len TSRMLS_DC);
2659dd24c6dSAntony DovgalZEND_API char *zend_get_type_by_const(int type);
2666ac6cb10SHarald Radi
267741b8161SZeev Suraski#define getThis() (this_ptr)
268741b8161SZeev Suraski
269131d9cb2SZeev Suraski#define WRONG_PARAM_COUNT					ZEND_WRONG_PARAM_COUNT()
270131d9cb2SZeev Suraski#define WRONG_PARAM_COUNT_WITH_RETVAL(ret)	ZEND_WRONG_PARAM_COUNT_WITH_RETVAL(ret)
271a1ad2872SZeev Suraski#define ARG_COUNT(dummy)	(ht)
272a1ad2872SZeev Suraski#define ZEND_NUM_ARGS()		(ht)
2734187439cSZeev Suraski#define ZEND_WRONG_PARAM_COUNT()					{ zend_wrong_param_count(TSRMLS_C); return; }
2744187439cSZeev Suraski#define ZEND_WRONG_PARAM_COUNT_WITH_RETVAL(ret)		{ zend_wrong_param_count(TSRMLS_C); return ret; }
275573b4602SAndi Gutmans
27680bdd19eSZeev Suraski#ifndef ZEND_WIN32
277573b4602SAndi Gutmans#define DLEXPORT
278573b4602SAndi Gutmans#endif
279573b4602SAndi Gutmans
280ceba50b6SZeev Suraski#define array_init(arg)			_array_init((arg) ZEND_FILE_LINE_CC)
281fcc03510SZeev Suraski#define object_init(arg)		_object_init((arg) ZEND_FILE_LINE_CC TSRMLS_CC)
282fcc03510SZeev Suraski#define object_init_ex(arg, ce)	_object_init_ex((arg), (ce) ZEND_FILE_LINE_CC TSRMLS_CC)
28376a7a5bcSAndi Gutmans#define object_and_properties_init(arg, ce, properties)	_object_and_properties_init((arg), (ce), (properties) ZEND_FILE_LINE_CC TSRMLS_CC)
284ceba50b6SZeev SuraskiZEND_API int _array_init(zval *arg ZEND_FILE_LINE_DC);
285fcc03510SZeev SuraskiZEND_API int _object_init(zval *arg ZEND_FILE_LINE_DC TSRMLS_DC);
286fcc03510SZeev SuraskiZEND_API int _object_init_ex(zval *arg, zend_class_entry *ce ZEND_FILE_LINE_DC TSRMLS_DC);
28776a7a5bcSAndi GutmansZEND_API int _object_and_properties_init(zval *arg, zend_class_entry *ce, HashTable *properties ZEND_FILE_LINE_DC TSRMLS_DC);
2886847fefaSThies C. Arntzen
289047a574eSMarcus BoergerZEND_API void zend_merge_properties(zval *obj, HashTable *properties, int destroy_ht TSRMLS_DC);
290047a574eSMarcus Boerger
2916847fefaSThies C. Arntzen/* no longer supported */
2924f6c95d1SZeev SuraskiZEND_API int add_assoc_function(zval *arg, char *key, void (*function_ptr)(INTERNAL_FUNCTION_PARAMETERS));
2936847fefaSThies C. Arntzen
294ef95a346SAndi GutmansZEND_API int add_assoc_long_ex(zval *arg, char *key, uint key_len, long n);
2950611acb9SAndi GutmansZEND_API int add_assoc_null_ex(zval *arg, char *key, uint key_len);
296ef95a346SAndi GutmansZEND_API int add_assoc_bool_ex(zval *arg, char *key, uint key_len, int b);
297ef95a346SAndi GutmansZEND_API int add_assoc_resource_ex(zval *arg, char *key, uint key_len, int r);
298ef95a346SAndi GutmansZEND_API int add_assoc_double_ex(zval *arg, char *key, uint key_len, double d);
299ef95a346SAndi GutmansZEND_API int add_assoc_string_ex(zval *arg, char *key, uint key_len, char *str, int duplicate);
300ef95a346SAndi GutmansZEND_API int add_assoc_stringl_ex(zval *arg, char *key, uint key_len, char *str, uint length, int duplicate);
301ef95a346SAndi GutmansZEND_API int add_assoc_zval_ex(zval *arg, char *key, uint key_len, zval *value);
302ef95a346SAndi Gutmans
303ef95a346SAndi Gutmans#define add_assoc_long(__arg, __key, __n) add_assoc_long_ex(__arg, __key, strlen(__key)+1, __n)
3040611acb9SAndi Gutmans#define add_assoc_null(__arg, __key) add_assoc_null_ex(__arg, __key, strlen(__key) + 1)
305ef95a346SAndi Gutmans#define add_assoc_bool(__arg, __key, __b) add_assoc_bool_ex(__arg, __key, strlen(__key)+1, __b)
306ef95a346SAndi Gutmans#define add_assoc_resource(__arg, __key, __r) add_assoc_resource_ex(__arg, __key, strlen(__key)+1, __r)
307ef95a346SAndi Gutmans#define add_assoc_double(__arg, __key, __d) add_assoc_double_ex(__arg, __key, strlen(__key)+1, __d)
308ef95a346SAndi Gutmans#define add_assoc_string(__arg, __key, __str, __duplicate) add_assoc_string_ex(__arg, __key, strlen(__key)+1, __str, __duplicate)
309ef95a346SAndi Gutmans#define add_assoc_stringl(__arg, __key, __str, __length, __duplicate) add_assoc_stringl_ex(__arg, __key, strlen(__key)+1, __str, __length, __duplicate)
310ef95a346SAndi Gutmans#define add_assoc_zval(__arg, __key, __value) add_assoc_zval_ex(__arg, __key, strlen(__key)+1, __value)
3116847fefaSThies C. Arntzen
3120611acb9SAndi Gutmans/* unset() functions are only suported for legacy modules and null() functions should be used */
3130611acb9SAndi Gutmans#define add_assoc_unset(__arg, __key) add_assoc_null_ex(__arg, __key, strlen(__key) + 1)
3140611acb9SAndi Gutmans#define add_index_unset(__arg, __key) add_index_null(__arg, __key)
3150611acb9SAndi Gutmans#define add_next_index_unset(__arg) add_next_index_null(__arg)
3160611acb9SAndi Gutmans#define add_property_unset(__arg, __key) add_property_null(__arg, __key)
3170611acb9SAndi Gutmans
318b05b949aSDmitry StogovZEND_API int add_index_long(zval *arg, ulong idx, long n);
319b05b949aSDmitry StogovZEND_API int add_index_null(zval *arg, ulong idx);
320b05b949aSDmitry StogovZEND_API int add_index_bool(zval *arg, ulong idx, int b);
321b05b949aSDmitry StogovZEND_API int add_index_resource(zval *arg, ulong idx, int r);
322b05b949aSDmitry StogovZEND_API int add_index_double(zval *arg, ulong idx, double d);
323b05b949aSDmitry StogovZEND_API int add_index_string(zval *arg, ulong idx, char *str, int duplicate);
324b05b949aSDmitry StogovZEND_API int add_index_stringl(zval *arg, ulong idx, char *str, uint length, int duplicate);
325b05b949aSDmitry StogovZEND_API int add_index_zval(zval *arg, ulong index, zval *value);
3266847fefaSThies C. Arntzen
327573b4602SAndi GutmansZEND_API int add_next_index_long(zval *arg, long n);
3280611acb9SAndi GutmansZEND_API int add_next_index_null(zval *arg);
3296847fefaSThies C. ArntzenZEND_API int add_next_index_bool(zval *arg, int b);
3306847fefaSThies C. ArntzenZEND_API int add_next_index_resource(zval *arg, int r);
331573b4602SAndi GutmansZEND_API int add_next_index_double(zval *arg, double d);
332573b4602SAndi GutmansZEND_API int add_next_index_string(zval *arg, char *str, int duplicate);
333573b4602SAndi GutmansZEND_API int add_next_index_stringl(zval *arg, char *str, uint length, int duplicate);
334ef95a346SAndi GutmansZEND_API int add_next_index_zval(zval *arg, zval *value);
335ef95a346SAndi Gutmans
336ef95a346SAndi GutmansZEND_API int add_get_assoc_string_ex(zval *arg, char *key, uint key_len, char *str, void **dest, int duplicate);
337ef95a346SAndi GutmansZEND_API int add_get_assoc_stringl_ex(zval *arg, char *key, uint key_len, char *str, uint length, void **dest, int duplicate);
338ef95a346SAndi Gutmans
339ef95a346SAndi Gutmans#define add_get_assoc_string(__arg, __key, __str, __dest, __duplicate) add_get_assoc_string_ex(__arg, __key, strlen(__key)+1, __str, __dest, __duplicate)
340ef95a346SAndi 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)
341573b4602SAndi Gutmans
342b05b949aSDmitry StogovZEND_API int add_get_index_long(zval *arg, ulong idx, long l, void **dest);
343b05b949aSDmitry StogovZEND_API int add_get_index_double(zval *arg, ulong idx, double d, void **dest);
344b05b949aSDmitry StogovZEND_API int add_get_index_string(zval *arg, ulong idx, char *str, void **dest, int duplicate);
345b05b949aSDmitry StogovZEND_API int add_get_index_stringl(zval *arg, ulong idx, char *str, uint length, void **dest, int duplicate);
346573b4602SAndi Gutmans
347eccc5368SStanislav MalyshevZEND_API int add_property_long_ex(zval *arg, char *key, uint key_len, long l TSRMLS_DC);
348eccc5368SStanislav MalyshevZEND_API int add_property_null_ex(zval *arg, char *key, uint key_len TSRMLS_DC);
349eccc5368SStanislav MalyshevZEND_API int add_property_bool_ex(zval *arg, char *key, uint key_len, int b TSRMLS_DC);
350eccc5368SStanislav MalyshevZEND_API int add_property_resource_ex(zval *arg, char *key, uint key_len, long r TSRMLS_DC);
351eccc5368SStanislav MalyshevZEND_API int add_property_double_ex(zval *arg, char *key, uint key_len, double d TSRMLS_DC);
352eccc5368SStanislav MalyshevZEND_API int add_property_string_ex(zval *arg, char *key, uint key_len, char *str, int duplicate TSRMLS_DC);
353eccc5368SStanislav MalyshevZEND_API int add_property_stringl_ex(zval *arg, char *key, uint key_len,  char *str, uint length, int duplicate TSRMLS_DC);
354eccc5368SStanislav MalyshevZEND_API int add_property_zval_ex(zval *arg, char *key, uint key_len, zval *value TSRMLS_DC);
355eccc5368SStanislav Malyshev
356eccc5368SStanislav Malyshev#define add_property_long(__arg, __key, __n) add_property_long_ex(__arg, __key, strlen(__key)+1, __n TSRMLS_CC)
357eccc5368SStanislav Malyshev#define add_property_null(__arg, __key) add_property_null_ex(__arg, __key, strlen(__key) + 1 TSRMLS_CC)
358eccc5368SStanislav Malyshev#define add_property_bool(__arg, __key, __b) add_property_bool_ex(__arg, __key, strlen(__key)+1, __b TSRMLS_CC)
359eccc5368SStanislav Malyshev#define add_property_resource(__arg, __key, __r) add_property_resource_ex(__arg, __key, strlen(__key)+1, __r TSRMLS_CC)
360637a4042SMarcus Boerger#define add_property_double(__arg, __key, __d) add_property_double_ex(__arg, __key, strlen(__key)+1, __d TSRMLS_CC)
361eccc5368SStanislav Malyshev#define add_property_string(__arg, __key, __str, __duplicate) add_property_string_ex(__arg, __key, strlen(__key)+1, __str, __duplicate TSRMLS_CC)
362eccc5368SStanislav Malyshev#define add_property_stringl(__arg, __key, __str, __length, __duplicate) add_property_stringl_ex(__arg, __key, strlen(__key)+1, __str, __length, __duplicate TSRMLS_CC)
363eccc5368SStanislav Malyshev#define add_property_zval(__arg, __key, __value) add_property_zval_ex(__arg, __key, strlen(__key)+1, __value TSRMLS_CC)
364ef95a346SAndi Gutmans
36592b4013eSZeev Suraski
366f8bbafd6SZeev 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);
367f8bbafd6SZeev 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);
3681727c6a2SHartmut HolzgraefeEND_EXTERN_C()
36992b4013eSZeev Suraski
37092b4013eSZeev Suraskitypedef struct _zend_fcall_info {
37192b4013eSZeev Suraski	size_t size;
37292b4013eSZeev Suraski	HashTable *function_table;
37392b4013eSZeev Suraski	zval *function_name;
37492b4013eSZeev Suraski	HashTable *symbol_table;
37592b4013eSZeev Suraski	zval **retval_ptr_ptr;
37692b4013eSZeev Suraski	zend_uint param_count;
37792b4013eSZeev Suraski	zval ***params;
37892b4013eSZeev Suraski	zval **object_pp;
37992b4013eSZeev Suraski	zend_bool no_separation;
38092b4013eSZeev Suraski} zend_fcall_info;
38192b4013eSZeev Suraski
38292b4013eSZeev Suraskitypedef struct _zend_fcall_info_cache {
38392b4013eSZeev Suraski	zend_bool initialized;
38492b4013eSZeev Suraski	zend_function *function_handler;
38592b4013eSZeev Suraski	zend_class_entry *calling_scope;
38692b4013eSZeev Suraski	zval **object_pp;
38792b4013eSZeev Suraski} zend_fcall_info_cache;
38892b4013eSZeev Suraski
3891727c6a2SHartmut HolzgraefeBEGIN_EXTERN_C()
39092b4013eSZeev SuraskiZEND_API extern zend_fcall_info_cache empty_fcall_info_cache;
39192b4013eSZeev Suraski
39264c353abSMarcus Boerger/** Build zend_call_info/cache from a zval*
39364c353abSMarcus Boerger *
39464c353abSMarcus Boerger * Caller is responsible to provide a return value, otherwise the we will crash.
39564c353abSMarcus Boerger * fci->retval_ptr_ptr = NULL;
39664c353abSMarcus Boerger * In order to pass parameters the following members need to be set:
39764c353abSMarcus Boerger * fci->param_count = 0;
39864c353abSMarcus Boerger * fci->params = NULL;
39964c353abSMarcus Boerger */
40064c353abSMarcus BoergerZEND_API int zend_fcall_info_init(zval *callable, zend_fcall_info *fci, zend_fcall_info_cache *fcc TSRMLS_DC);
40164c353abSMarcus Boerger
40264c353abSMarcus Boerger/** Set or clear the arguments in the zend_call_info struct taking care of
40364c353abSMarcus Boerger * refcount. If args is NULL and arguments are set then those are cleared.
40464c353abSMarcus Boerger */
40564c353abSMarcus BoergerZEND_API int zend_fcall_info_args(zend_fcall_info *fci, zval *args TSRMLS_DC);
40664c353abSMarcus Boerger
40764c353abSMarcus Boerger/** Call a function using information created by zend_fcall_info_init()/args().
40864c353abSMarcus Boerger * If args is given then those replace the arguement info in fci is temporarily.
40964c353abSMarcus Boerger */
41064c353abSMarcus BoergerZEND_API int zend_fcall_info_call(zend_fcall_info *fci, zend_fcall_info_cache *fcc, zval **retval, zval *args TSRMLS_DC);
41164c353abSMarcus Boerger
41292b4013eSZeev SuraskiZEND_API int zend_call_function(zend_fcall_info *fci, zend_fcall_info_cache *fci_cache TSRMLS_DC);
41392b4013eSZeev Suraski
414573b4602SAndi Gutmans
415f962a35dSAndrei ZmievskiZEND_API int zend_set_hash_symbol(zval *symbol, char *name, int name_length,
41651e797f1SHarald Radi                                  zend_bool is_ref, int num_symbol_tables, ...);
417f962a35dSAndrei Zmievski
41811bcaedfSAndi GutmansZEND_API int zend_delete_global_variable(char *name, int name_len TSRMLS_DC);
419db507dd1SAndi Gutmans
4201d33a3e9SDmitry StogovZEND_API void zend_reset_all_cv(HashTable *symbol_table TSRMLS_DC);
4211d33a3e9SDmitry Stogov
4224f6c95d1SZeev Suraski#define add_method(arg, key, method)	add_assoc_function((arg), (key), (method))
423573b4602SAndi Gutmans
424a35c61afSAndrei ZmievskiZEND_API ZEND_FUNCTION(display_disabled_function);
425a700180fSHarald RadiZEND_API ZEND_FUNCTION(display_disabled_class);
4261727c6a2SHartmut HolzgraefeEND_EXTERN_C()
427a35c61afSAndrei Zmievski
428bcddfd47SThies C. Arntzen#if ZEND_DEBUG
429bcddfd47SThies C. Arntzen#define CHECK_ZVAL_STRING(z) \
430ace55f32SZeev Suraski	if ((z)->value.str.val[ (z)->value.str.len ] != '\0') { zend_error(E_WARNING, "String is not zero-terminated (%s)", (z)->value.str.val); }
43143ebb868SZeev Suraski#define CHECK_ZVAL_STRING_REL(z) \
432ace55f32SZeev Suraski	if ((z)->value.str.val[ (z)->value.str.len ] != '\0') { zend_error(E_WARNING, "String is not zero-terminated (%s) (source: %s:%d)", (z)->value.str.val ZEND_FILE_LINE_RELAY_CC); }
433bcddfd47SThies C. Arntzen#else
434bcddfd47SThies C. Arntzen#define CHECK_ZVAL_STRING(z)
43543ebb868SZeev Suraski#define CHECK_ZVAL_STRING_REL(z)
436bcddfd47SThies C. Arntzen#endif
437bcddfd47SThies C. Arntzen
438637a4042SMarcus Boerger#define ZVAL_RESOURCE(z, l) {		\
439637a4042SMarcus Boerger		Z_TYPE_P(z) = IS_RESOURCE;	\
440637a4042SMarcus Boerger		Z_LVAL_P(z) = l;			\
441af22085cSThies C. Arntzen	}
442bcddfd47SThies C. Arntzen
443637a4042SMarcus Boerger#define ZVAL_BOOL(z, b) {			\
444637a4042SMarcus Boerger		Z_TYPE_P(z) = IS_BOOL;		\
445637a4042SMarcus Boerger		Z_LVAL_P(z) = ((b) != 0);   \
446af22085cSThies C. Arntzen	}
447bcddfd47SThies C. Arntzen
448637a4042SMarcus Boerger#define ZVAL_NULL(z) {				\
449637a4042SMarcus Boerger		Z_TYPE_P(z) = IS_NULL;		\
450af22085cSThies C. Arntzen	}
451bcddfd47SThies C. Arntzen
452637a4042SMarcus Boerger#define ZVAL_LONG(z, l) {			\
453637a4042SMarcus Boerger		Z_TYPE_P(z) = IS_LONG;		\
454637a4042SMarcus Boerger		Z_LVAL_P(z) = l;			\
455af22085cSThies C. Arntzen	}
456bcddfd47SThies C. Arntzen
457637a4042SMarcus Boerger#define ZVAL_DOUBLE(z, d) {			\
458637a4042SMarcus Boerger		Z_TYPE_P(z) = IS_DOUBLE;	\
459637a4042SMarcus Boerger		Z_DVAL_P(z) = d;			\
460af22085cSThies C. Arntzen	}
461bcddfd47SThies C. Arntzen
4624f6c95d1SZeev Suraski#define ZVAL_STRING(z, s, duplicate) {	\
463af22085cSThies C. Arntzen		char *__s=(s);					\
464af22085cSThies C. Arntzen		(z)->value.str.len = strlen(__s);	\
4654f6c95d1SZeev Suraski		(z)->value.str.val = (duplicate?estrndup(__s, (z)->value.str.len):__s);	\
466af22085cSThies C. Arntzen		(z)->type = IS_STRING;	        \
467af22085cSThies C. Arntzen	}
468bcddfd47SThies C. Arntzen
4694f6c95d1SZeev Suraski#define ZVAL_STRINGL(z, s, l, duplicate) {	\
470af22085cSThies C. Arntzen		char *__s=(s); int __l=l;		\
471af22085cSThies C. Arntzen		(z)->value.str.len = __l;	    \
4724f6c95d1SZeev Suraski		(z)->value.str.val = (duplicate?estrndup(__s, __l):__s);	\
473af22085cSThies C. Arntzen		(z)->type = IS_STRING;		    \
474af22085cSThies C. Arntzen	}
475af22085cSThies C. Arntzen
476af22085cSThies C. Arntzen#define ZVAL_EMPTY_STRING(z) {	        \
477af22085cSThies C. Arntzen		(z)->value.str.len = 0;  	    \
47856f8195fSAndi Gutmans		(z)->value.str.val = STR_EMPTY_ALLOC(); \
479af22085cSThies C. Arntzen		(z)->type = IS_STRING;		    \
480af22085cSThies C. Arntzen	}
481af22085cSThies C. Arntzen
482c7d27ad9SMarcus Boerger#define ZVAL_ZVAL(z, zv, copy, dtor) {  \
483c7d27ad9SMarcus Boerger		int is_ref, refcount;           \
484c7d27ad9SMarcus Boerger		is_ref = (z)->is_ref;           \
485c7d27ad9SMarcus Boerger		refcount = (z)->refcount;       \
486c7d27ad9SMarcus Boerger		*(z) = *(zv);                   \
487c7d27ad9SMarcus Boerger		if (copy) {                     \
488c7d27ad9SMarcus Boerger			zval_copy_ctor(z);          \
489c7d27ad9SMarcus Boerger	    }                               \
490c7d27ad9SMarcus Boerger		if (dtor) {                     \
49132927a9fSMarcus Boerger			if (!copy) {                \
49232927a9fSMarcus Boerger				ZVAL_NULL(zv);          \
49332927a9fSMarcus Boerger			}                           \
4946344f662SMarcus Boerger			zval_ptr_dtor(&zv);         \
495c7d27ad9SMarcus Boerger	    }                               \
496c7d27ad9SMarcus Boerger		(z)->is_ref = is_ref;           \
497c7d27ad9SMarcus Boerger		(z)->refcount = refcount;       \
498c7d27ad9SMarcus Boerger	}
499c7d27ad9SMarcus Boerger
5004f6c95d1SZeev Suraski#define ZVAL_FALSE(z)  					ZVAL_BOOL(z, 0)
5014f6c95d1SZeev Suraski#define ZVAL_TRUE(z)  					ZVAL_BOOL(z, 1)
502af22085cSThies C. Arntzen
5034f6c95d1SZeev Suraski#define RETVAL_RESOURCE(l)				ZVAL_RESOURCE(return_value, l)
5044f6c95d1SZeev Suraski#define RETVAL_BOOL(b)					ZVAL_BOOL(return_value, b)
505bcddfd47SThies C. Arntzen#define RETVAL_NULL() 					ZVAL_NULL(return_value)
5064f6c95d1SZeev Suraski#define RETVAL_LONG(l) 					ZVAL_LONG(return_value, l)
5074f6c95d1SZeev Suraski#define RETVAL_DOUBLE(d) 				ZVAL_DOUBLE(return_value, d)
5084f6c95d1SZeev Suraski#define RETVAL_STRING(s, duplicate) 		ZVAL_STRING(return_value, s, duplicate)
5094f6c95d1SZeev Suraski#define RETVAL_STRINGL(s, l, duplicate) 	ZVAL_STRINGL(return_value, s, l, duplicate)
510bcddfd47SThies C. Arntzen#define RETVAL_EMPTY_STRING() 			ZVAL_EMPTY_STRING(return_value)
511c7d27ad9SMarcus Boerger#define RETVAL_ZVAL(zv, copy, dtor)		ZVAL_ZVAL(return_value, zv, copy, dtor)
5124f6c95d1SZeev Suraski#define RETVAL_FALSE  					ZVAL_BOOL(return_value, 0)
5134f6c95d1SZeev Suraski#define RETVAL_TRUE   					ZVAL_BOOL(return_value, 1)
514bcddfd47SThies C. Arntzen
515bcddfd47SThies C. Arntzen#define RETURN_RESOURCE(l) 				{ RETVAL_RESOURCE(l); return; }
516bcddfd47SThies C. Arntzen#define RETURN_BOOL(b) 					{ RETVAL_BOOL(b); return; }
517bcddfd47SThies C. Arntzen#define RETURN_NULL() 					{ RETVAL_NULL(); return;}
518bcddfd47SThies C. Arntzen#define RETURN_LONG(l) 					{ RETVAL_LONG(l); return; }
519bcddfd47SThies C. Arntzen#define RETURN_DOUBLE(d) 				{ RETVAL_DOUBLE(d); return; }
5204f6c95d1SZeev Suraski#define RETURN_STRING(s, duplicate) 	{ RETVAL_STRING(s, duplicate); return; }
5214f6c95d1SZeev Suraski#define RETURN_STRINGL(s, l, duplicate) { RETVAL_STRINGL(s, l, duplicate); return; }
522bcddfd47SThies C. Arntzen#define RETURN_EMPTY_STRING() 			{ RETVAL_EMPTY_STRING(); return; }
523c7d27ad9SMarcus Boerger#define RETURN_ZVAL(zv, copy, dtor)		{ RETVAL_ZVAL(zv, copy, dtor); return; }
524bcddfd47SThies C. Arntzen#define RETURN_FALSE  					{ RETVAL_FALSE; return; }
525bcddfd47SThies C. Arntzen#define RETURN_TRUE   					{ RETVAL_TRUE; return; }
5261f985edeSZeev Suraski
5274f6c95d1SZeev Suraski#define SET_VAR_STRING(n, v) {																				\
52848ffdd79SZeev Suraski								{																			\
529235386b2SZeev Suraski									zval *var;																\
530235386b2SZeev Suraski									ALLOC_ZVAL(var);														\
5314f6c95d1SZeev Suraski									ZVAL_STRING(var, v, 0);													\
5326393ab14SZeev Suraski									ZEND_SET_GLOBAL_VAR(n, var);											\
53348ffdd79SZeev Suraski								}																			\
5341f985edeSZeev Suraski							}
53548ffdd79SZeev Suraski
5364f6c95d1SZeev Suraski#define SET_VAR_STRINGL(n, v, l) {														\
53748ffdd79SZeev Suraski									{													\
538235386b2SZeev Suraski										zval *var;										\
539235386b2SZeev Suraski										ALLOC_ZVAL(var);								\
5404f6c95d1SZeev Suraski										ZVAL_STRINGL(var, v, l, 0);						\
54148ffdd79SZeev Suraski										ZEND_SET_GLOBAL_VAR(n, var);					\
54248ffdd79SZeev Suraski									}													\
5431f985edeSZeev Suraski								}
54448ffdd79SZeev Suraski
5454f6c95d1SZeev Suraski#define SET_VAR_LONG(n, v)	{															\
54648ffdd79SZeev Suraski								{														\
547235386b2SZeev Suraski									zval *var;											\
548235386b2SZeev Suraski									ALLOC_ZVAL(var);									\
5494f6c95d1SZeev Suraski									ZVAL_LONG(var, v);									\
55048ffdd79SZeev Suraski									ZEND_SET_GLOBAL_VAR(n, var);						\
55148ffdd79SZeev Suraski								}														\
5521f985edeSZeev Suraski							}
55348ffdd79SZeev Suraski
5544f6c95d1SZeev Suraski#define SET_VAR_DOUBLE(n, v) {															\
55548ffdd79SZeev Suraski								{														\
556235386b2SZeev Suraski									zval *var;											\
557235386b2SZeev Suraski									ALLOC_ZVAL(var);									\
5584f6c95d1SZeev Suraski									ZVAL_DOUBLE(var, v);								\
55948ffdd79SZeev Suraski									ZEND_SET_GLOBAL_VAR(n, var);						\
56048ffdd79SZeev Suraski								}														\
5611f985edeSZeev Suraski							}
5621f985edeSZeev Suraski
5631f985edeSZeev Suraski
564c34560b5SAndi Gutmans#define ZEND_SET_SYMBOL(symtable, name, var)										\
565c34560b5SAndi Gutmans	{																				\
566c34560b5SAndi Gutmans		char *_name = (name);														\
567c34560b5SAndi Gutmans																					\
5684c8259b5SAndi Gutmans		ZEND_SET_SYMBOL_WITH_LENGTH(symtable, _name, strlen(_name)+1, var, 1, 0);	\
56948ffdd79SZeev Suraski	}
57048ffdd79SZeev Suraski
571c34560b5SAndi Gutmans#define ZEND_SET_SYMBOL_WITH_LENGTH(symtable, name, name_length, var, _refcount, _is_ref)				\
57248ffdd79SZeev Suraski	{																									\
57348ffdd79SZeev Suraski		zval **orig_var;																				\
57448ffdd79SZeev Suraski																										\
575620d0134SZeev Suraski		if (zend_hash_find(symtable, (name), (name_length), (void **) &orig_var)==SUCCESS				\
57648ffdd79SZeev Suraski			&& PZVAL_IS_REF(*orig_var)) {																\
577158088caSZeev Suraski			(var)->refcount = (*orig_var)->refcount;													\
57852a30fd2SAndrei Zmievski			(var)->is_ref = 1;																			\
57948ffdd79SZeev Suraski																										\
5802ddc4fe4SZeev Suraski			if (_refcount) {																			\
5812ddc4fe4SZeev Suraski				(var)->refcount += _refcount-1;															\
5822ddc4fe4SZeev Suraski			}																							\
58348ffdd79SZeev Suraski			zval_dtor(*orig_var);																		\
584158088caSZeev Suraski			**orig_var = *(var);																		\
58562b2087aSAndi Gutmans			FREE_ZVAL(var);																					\
58648ffdd79SZeev Suraski		} else {																						\
5872f5efbdeSAndi Gutmans			(var)->is_ref = _is_ref;																	\
588158088caSZeev Suraski			if (_refcount) {																			\
589158088caSZeev Suraski				(var)->refcount = _refcount;															\
590158088caSZeev Suraski			}																							\
591158088caSZeev Suraski			zend_hash_update(symtable, (name), (name_length), &(var), sizeof(zval *), NULL);			\
59248ffdd79SZeev Suraski		}																								\
59348ffdd79SZeev Suraski	}
59448ffdd79SZeev Suraski
595620d0134SZeev Suraski
596620d0134SZeev Suraski#define ZEND_SET_GLOBAL_VAR(name, var)				\
597620d0134SZeev Suraski	ZEND_SET_SYMBOL(&EG(symbol_table), name, var)
598620d0134SZeev Suraski
599e3450661SAndrei Zmievski#define ZEND_SET_GLOBAL_VAR_WITH_LENGTH(name, name_length, var, _refcount, _is_ref)		\
600e3450661SAndrei Zmievski	ZEND_SET_SYMBOL_WITH_LENGTH(&EG(symbol_table), name, name_length, var, _refcount, _is_ref)
601fec413c5SAndrei Zmievski
6020229aad0SGeorge Schlossnagle#define ZEND_DEFINE_PROPERTY(class_ptr, name, value, mask)								\
60313433852SZeev Suraski{																					\
60413433852SZeev Suraski	char *_name = (name);															\
60513433852SZeev Suraski	int namelen = strlen(_name);													\
6067bbbd503SMarcus Boerger	zend_declare_property(class_ptr, _name, namelen, value, mask TSRMLS_CC);		\
607daf3ac65SGeorge Schlossnagle}
608daf3ac65SGeorge Schlossnagle
609637a4042SMarcus 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)))
610637a4042SMarcus Boerger#define ZVAL_IS_NULL(z) (Z_TYPE_P(z)==IS_NULL)
61106a18f16SAndi Gutmans
6128b6f848cSAndi Gutmans/* For compatibility */
6138b6f848cSAndi Gutmans#define ZEND_MINIT			ZEND_MODULE_STARTUP_N
6148b6f848cSAndi Gutmans#define ZEND_MSHUTDOWN		ZEND_MODULE_SHUTDOWN_N
6158b6f848cSAndi Gutmans#define ZEND_RINIT			ZEND_MODULE_ACTIVATE_N
6168b6f848cSAndi Gutmans#define ZEND_RSHUTDOWN		ZEND_MODULE_DEACTIVATE_N
6178b6f848cSAndi Gutmans#define ZEND_MINFO			ZEND_MODULE_INFO_N
618ada4e506SDmitry Stogov#define ZEND_GINIT(module)		((void (*)(void* TSRMLS_DC))(ZEND_MODULE_GLOBALS_CTOR_N(module)))
619ada4e506SDmitry Stogov#define ZEND_GSHUTDOWN(module)	((void (*)(void* TSRMLS_DC))(ZEND_MODULE_GLOBALS_DTOR_N(module)))
6208b6f848cSAndi Gutmans
6218b6f848cSAndi Gutmans#define ZEND_MINIT_FUNCTION			ZEND_MODULE_STARTUP_D
622f5c59863SStanislav Malyshev#define ZEND_MSHUTDOWN_FUNCTION		ZEND_MODULE_SHUTDOWN_D
623f5c59863SStanislav Malyshev#define ZEND_RINIT_FUNCTION			ZEND_MODULE_ACTIVATE_D
624f5c59863SStanislav Malyshev#define ZEND_RSHUTDOWN_FUNCTION		ZEND_MODULE_DEACTIVATE_D
625f5c59863SStanislav Malyshev#define ZEND_MINFO_FUNCTION			ZEND_MODULE_INFO_D
626ada4e506SDmitry Stogov#define ZEND_GINIT_FUNCTION			ZEND_MODULE_GLOBALS_CTOR_D
627ada4e506SDmitry Stogov#define ZEND_GSHUTDOWN_FUNCTION		ZEND_MODULE_GLOBALS_DTOR_D
6288b6f848cSAndi Gutmans
6290450ab94SZeev SuraskiEND_EXTERN_C()
630637a4042SMarcus Boerger
631b982307dSSascha Schumann#endif /* ZEND_API_H */
632573b4602SAndi Gutmans
6338b6f848cSAndi Gutmans
634573b4602SAndi Gutmans/*
635573b4602SAndi Gutmans * Local variables:
636573b4602SAndi Gutmans * tab-width: 4
637573b4602SAndi Gutmans * c-basic-offset: 4
638333406bdSfoobar * indent-tabs-mode: t
639573b4602SAndi Gutmans * End:
640573b4602SAndi Gutmans */
641