zend_API.h revision 1c2512dd
1573b4602SAndi Gutmans/*
2573b4602SAndi Gutmans   +----------------------------------------------------------------------+
3573b4602SAndi Gutmans   | Zend Engine                                                          |
4573b4602SAndi Gutmans   +----------------------------------------------------------------------+
52c5d4b8cSSebastian Bergmann   | Copyright (c) 1998-2003 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
45f8bbafd6SZeev Suraski#define ZEND_NAMED_FUNCTION(name)		void name(INTERNAL_FUNCTION_PARAMETERS)
46f8bbafd6SZeev Suraski#define ZEND_FUNCTION(name)				ZEND_NAMED_FUNCTION(ZEND_FN(name))
47f8bbafd6SZeev Suraski#define ZEND_METHOD(classname, name)	ZEND_NAMED_FUNCTION(ZEND_FN(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
511c2512ddSMarcus Boerger#define ZEND_NAMED_FE(zend_name, name, arg_info)	ZEND_FENTRY(zend_name, name, arg_info, 0)
521c2512ddSMarcus Boerger#define ZEND_FE(name, arg_info)						ZEND_FENTRY(name, ZEND_FN(name), arg_info, 0)
531c2512ddSMarcus Boerger#define ZEND_FALIAS(name, alias, arg_info)			ZEND_FENTRY(name, ZEND_FN(alias), arg_info, ZEND_ACC_ALIAS)
541c2512ddSMarcus Boerger#define ZEND_ME(classname, name, arg_info, flags)	ZEND_FENTRY(name, ZEND_FN(classname##_##name), arg_info, flags)
551c2512ddSMarcus Boerger#define ZEND_ABSTRACT_ME(classname, name, arg_info)	ZEND_FENTRY(name, NULL, arg_info, ZEND_ACC_PUBLIC|ZEND_ACC_ABSTRACT)
56f8bbafd6SZeev Suraski
57f8bbafd6SZeev Suraski#define ZEND_ARG_INFO(pass_by_ref, name)							{ #name, sizeof(#name)-1, NULL, 0, 0, pass_by_ref },
58f8bbafd6SZeev Suraski#define ZEND_ARG_PASS_INFO(pass_by_ref)								{ NULL, 0, NULL, 0, 0, pass_by_ref },
59f8bbafd6SZeev Suraski#define ZEND_ARG_OBJ_INFO(pass_by_ref, name, classname, allow_null) { #name, sizeof(#name)-1, #classname, sizeof(#classname)-1, allow_null, pass_by_ref },
60f8bbafd6SZeev Suraski#define ZEND_BEGIN_ARG_INFO(name, pass_rest_by_reference)					\
61f8bbafd6SZeev Suraski	zend_arg_info name[] = {									\
62f8bbafd6SZeev Suraski		ZEND_ARG_PASS_INFO(pass_rest_by_reference)
63f8bbafd6SZeev Suraski#define ZEND_END_ARG_INFO()		};
64342c6e0bSZeev Suraski
658b6f848cSAndi Gutmans/* Name macros */
668b6f848cSAndi Gutmans#define ZEND_MODULE_STARTUP_N(module)       zm_startup_##module
678b6f848cSAndi Gutmans#define ZEND_MODULE_SHUTDOWN_N(module)		zm_shutdown_##module
688b6f848cSAndi Gutmans#define ZEND_MODULE_ACTIVATE_N(module)		zm_activate_##module
698b6f848cSAndi Gutmans#define ZEND_MODULE_DEACTIVATE_N(module)	zm_deactivate_##module
702fd4ffceSZeev Suraski#define ZEND_MODULE_EXEC_FINISHED_N(module)	zm_exec_finished_##module
718b6f848cSAndi Gutmans#define ZEND_MODULE_INFO_N(module)			zm_info_##module
72342c6e0bSZeev Suraski
738b6f848cSAndi Gutmans/* Declaration macros */
748b6f848cSAndi Gutmans#define ZEND_MODULE_STARTUP_D(module)		int ZEND_MODULE_STARTUP_N(module)(INIT_FUNC_ARGS)
758b6f848cSAndi Gutmans#define ZEND_MODULE_SHUTDOWN_D(module)		int ZEND_MODULE_SHUTDOWN_N(module)(SHUTDOWN_FUNC_ARGS)
768b6f848cSAndi Gutmans#define ZEND_MODULE_ACTIVATE_D(module)		int ZEND_MODULE_ACTIVATE_N(module)(INIT_FUNC_ARGS)
778b6f848cSAndi Gutmans#define ZEND_MODULE_DEACTIVATE_D(module)	int ZEND_MODULE_DEACTIVATE_N(module)(SHUTDOWN_FUNC_ARGS)
782fd4ffceSZeev Suraski#define ZEND_MODULE_EXEC_FINISHED_D(module)	int ZEND_MODULE_EXEC_FINISHED_N(module)(void)
798b6f848cSAndi Gutmans#define ZEND_MODULE_INFO_D(module)			void ZEND_MODULE_INFO_N(module)(ZEND_MODULE_INFO_FUNC_ARGS)
80342c6e0bSZeev Suraski
810b6d923bSSascha Schumann#define ZEND_GET_MODULE(name) \
82cb71ac03SHartmut Holzgraefe    BEGIN_EXTERN_C()\
83cb71ac03SHartmut Holzgraefe	ZEND_DLEXPORT zend_module_entry *get_module(void) { return &name##_module_entry; }\
84cb71ac03SHartmut Holzgraefe    END_EXTERN_C()
850d21940dSZeev Suraski
860d21940dSZeev Suraski#define ZEND_BEGIN_MODULE_GLOBALS(module_name)		\
870d21940dSZeev Suraski	typedef struct _zend_##module_name##_globals {
880d21940dSZeev Suraski#define ZEND_END_MODULE_GLOBALS(module_name)		\
890d21940dSZeev Suraski	} zend_##module_name##_globals;
900d21940dSZeev Suraski
910d21940dSZeev Suraski#ifdef ZTS
920d21940dSZeev Suraski
930d21940dSZeev Suraski#define ZEND_DECLARE_MODULE_GLOBALS(module_name)							\
9402af513cSAndi Gutmans	ts_rsrc_id module_name##_globals_id;
9502af513cSAndi Gutmans#define ZEND_EXTERN_MODULE_GLOBALS(module_name)								\
9602af513cSAndi Gutmans	extern ts_rsrc_id module_name##_globals_id;
970d21940dSZeev Suraski#define ZEND_INIT_MODULE_GLOBALS(module_name, globals_ctor, globals_dtor)	\
982c254ba7SZeev Suraski	ts_allocate_id(&module_name##_globals_id, sizeof(zend_##module_name##_globals), (ts_allocate_ctor) globals_ctor, (ts_allocate_dtor) globals_dtor);
990d21940dSZeev Suraski
1000d21940dSZeev Suraski#else
1010d21940dSZeev Suraski
1020d21940dSZeev Suraski#define ZEND_DECLARE_MODULE_GLOBALS(module_name)							\
10302af513cSAndi Gutmans	zend_##module_name##_globals module_name##_globals;
10402af513cSAndi Gutmans#define ZEND_EXTERN_MODULE_GLOBALS(module_name)								\
10502af513cSAndi Gutmans	extern zend_##module_name##_globals module_name##_globals;
1060d21940dSZeev Suraski#define ZEND_INIT_MODULE_GLOBALS(module_name, globals_ctor, globals_dtor)	\
1070d21940dSZeev Suraski	globals_ctor(&module_name##_globals);
1080d21940dSZeev Suraski
1090d21940dSZeev Suraski#endif
1100d21940dSZeev Suraski
1110d21940dSZeev Suraski
1120d21940dSZeev Suraski
1133738a6edSHarald Radi#define INIT_CLASS_ENTRY(class_container, class_name, functions) INIT_OVERLOADED_CLASS_ENTRY(class_container, class_name, functions, NULL, NULL, NULL)
114741b8161SZeev Suraski
115741b8161SZeev Suraski#define INIT_OVERLOADED_CLASS_ENTRY(class_container, class_name, functions, handle_fcall, handle_propget, handle_propset) \
116741b8161SZeev Suraski	{															\
117741b8161SZeev Suraski		class_container.name = strdup(class_name);				\
118b1b8ed64SMarcus Boerger		class_container.name_length = sizeof(class_name) - 1;	\
119741b8161SZeev Suraski		class_container.builtin_functions = functions;			\
1202eccd95cSAndi Gutmans		class_container.constructor = NULL;						\
12173b159e0SAndi Gutmans		class_container.destructor = NULL;						\
12229ea3da2SAndi Gutmans		class_container.clone = NULL;							\
1236608f073SStanislav Malyshev		class_container.create_object = NULL;	 				\
1242ae8d124SStanislav Malyshev		class_container.__call = handle_fcall;	\
1252ae8d124SStanislav Malyshev		class_container.__get = handle_propget;	\
1262ae8d124SStanislav Malyshev		class_container.__set = handle_propset;	\
1276ed30594SStanislav Malyshev		class_container.num_interfaces = 0; \
128741b8161SZeev Suraski	}
129741b8161SZeev Suraski
130573b4602SAndi Gutmansint zend_next_free_module(void);
131573b4602SAndi Gutmans
132f77e6a44SZeev SuraskiZEND_API int zend_get_parameters(int ht, int param_count, ...);
13311e5d2f2SZeev SuraskiZEND_API int _zend_get_parameters_array(int ht, int param_count, zval **argument_array TSRMLS_DC);
134f77e6a44SZeev SuraskiZEND_API int zend_get_parameters_ex(int param_count, ...);
13511e5d2f2SZeev SuraskiZEND_API int _zend_get_parameters_array_ex(int param_count, zval ***argument_array TSRMLS_DC);
13611e5d2f2SZeev Suraski
13711e5d2f2SZeev Suraski#define zend_get_parameters_array(ht, param_count, argument_array)			\
13811e5d2f2SZeev Suraski	_zend_get_parameters_array(ht, param_count, argument_array TSRMLS_CC)
13911e5d2f2SZeev Suraski#define zend_get_parameters_array_ex(param_count, argument_array)			\
14011e5d2f2SZeev Suraski	_zend_get_parameters_array_ex(param_count, argument_array TSRMLS_CC)
14139f9487eSAndi Gutmans
14258f88057SAndrei Zmievski
14358f88057SAndrei Zmievski/* Parameter parsing API -- andrei */
14458f88057SAndrei Zmievski
14558f88057SAndrei Zmievski#define ZEND_PARSE_PARAMS_QUIET 1<<1
1468ce8324eSZeev SuraskiZEND_API int zend_parse_parameters(int num_args TSRMLS_DC, char *type_spec, ...);
1473839af35SAndrei ZmievskiZEND_API int zend_parse_parameters_ex(int flags, int num_args TSRMLS_DC, char *type_spec, ...);
1489b391a83SDerick RethansZEND_API char *zend_zval_type_name(zval *arg);
14958f88057SAndrei Zmievski
150325f9edbSGeorg RichterZEND_API int zend_parse_method_parameters(int num_args TSRMLS_DC, zval *this_ptr, char *type_spec, ...);
151c4528f82SHarald RadiZEND_API int zend_parse_method_parameters_ex(int flags, int num_args TSRMLS_DC, zval *this_ptr, char *type_spec, zend_class_entry *ce, void **object, ...);
152c4528f82SHarald Radi
153b5255495SZeev Suraski/* End of parameter parsing API -- andrei */
15439f9487eSAndi Gutmans
155e8214a33SAndi Gutmansint zend_register_functions(zend_class_entry *scope, zend_function_entry *functions, HashTable *function_table, int type TSRMLS_DC);
156b5770382SZeev Suraskivoid zend_unregister_functions(zend_function_entry *functions, int count, HashTable *function_table TSRMLS_DC);
1577a87fcbbSZeev SuraskiZEND_API int zend_register_module(zend_module_entry *module_entry);
158eb0e6946SAndi Gutmans
159b5770382SZeev SuraskiZEND_API zend_class_entry *zend_register_internal_class(zend_class_entry *class_entry TSRMLS_DC);
160b5770382SZeev 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);
161eb0e6946SAndi Gutmans
162d76cf1daSZeev SuraskiZEND_API int zend_disable_function(char *function_name, uint function_name_length TSRMLS_DC);
163a700180fSHarald RadiZEND_API int zend_disable_class(char *class_name, uint class_name_length TSRMLS_DC);
164573b4602SAndi Gutmans
1654187439cSZeev SuraskiZEND_API void zend_wrong_param_count(TSRMLS_D);
16613148b54SAndrei ZmievskiZEND_API zend_bool zend_is_callable(zval *callable, zend_bool syntax_only, char **callable_name);
16701850714SSebastian BergmannZEND_API char *zend_get_module_version(char *module_name);
16813433852SZeev SuraskiZEND_API int zend_declare_property(zend_class_entry *ce, char *name, int name_length, zval *property, int access_type);
169baaa4c90SMarcus BoergerZEND_API int zend_declare_property_null(zend_class_entry *ce, char *name, int name_length, int access_type);
170baaa4c90SMarcus BoergerZEND_API int zend_declare_property_long(zend_class_entry *ce, char *name, int name_length, long value, int access_type);
17113433852SZeev Suraski
172baaa4c90SMarcus BoergerZEND_API void zend_update_property(zend_class_entry *scope, zval *object, char *name, int name_length, zval *value TSRMLS_DC);
173baaa4c90SMarcus BoergerZEND_API void zend_update_property_null(zend_class_entry *scope, zval *object, char *name, int name_length TSRMLS_DC);
174baaa4c90SMarcus BoergerZEND_API void zend_update_property_long(zend_class_entry *scope, zval *object, char *name, int name_length, long value TSRMLS_DC);
175baaa4c90SMarcus BoergerZEND_API void zend_update_property_string(zend_class_entry *scope, zval *object, char *name, int name_length, char *value TSRMLS_DC);
176573b4602SAndi Gutmans
17738805f28SMarcus BoergerZEND_API zval *zend_read_property(zend_class_entry *scope, zval *object, char *name, int name_length, zend_bool silent TSRMLS_DC);
17838805f28SMarcus Boerger
1793fc85282SSebastian BergmannZEND_API zend_class_entry *zend_get_class_entry(zval *zobject TSRMLS_DC);
1806ac6cb10SHarald Radi
181741b8161SZeev Suraski#define getThis() (this_ptr)
182741b8161SZeev Suraski
183131d9cb2SZeev Suraski#define WRONG_PARAM_COUNT					ZEND_WRONG_PARAM_COUNT()
184131d9cb2SZeev Suraski#define WRONG_PARAM_COUNT_WITH_RETVAL(ret)	ZEND_WRONG_PARAM_COUNT_WITH_RETVAL(ret)
185a1ad2872SZeev Suraski#define ARG_COUNT(dummy)	(ht)
186a1ad2872SZeev Suraski#define ZEND_NUM_ARGS()		(ht)
1874187439cSZeev Suraski#define ZEND_WRONG_PARAM_COUNT()					{ zend_wrong_param_count(TSRMLS_C); return; }
1884187439cSZeev Suraski#define ZEND_WRONG_PARAM_COUNT_WITH_RETVAL(ret)		{ zend_wrong_param_count(TSRMLS_C); return ret; }
189573b4602SAndi Gutmans
19080bdd19eSZeev Suraski#ifndef ZEND_WIN32
191573b4602SAndi Gutmans#define DLEXPORT
192573b4602SAndi Gutmans#endif
193573b4602SAndi Gutmans
194e0628436SAndrei ZmievskiZEND_API int zend_startup_module(zend_module_entry *module);
195573b4602SAndi Gutmans
196ceba50b6SZeev Suraski#define array_init(arg)			_array_init((arg) ZEND_FILE_LINE_CC)
197fcc03510SZeev Suraski#define object_init(arg)		_object_init((arg) ZEND_FILE_LINE_CC TSRMLS_CC)
198fcc03510SZeev Suraski#define object_init_ex(arg, ce)	_object_init_ex((arg), (ce) ZEND_FILE_LINE_CC TSRMLS_CC)
19976a7a5bcSAndi Gutmans#define object_and_properties_init(arg, ce, properties)	_object_and_properties_init((arg), (ce), (properties) ZEND_FILE_LINE_CC TSRMLS_CC)
200ceba50b6SZeev SuraskiZEND_API int _array_init(zval *arg ZEND_FILE_LINE_DC);
201fcc03510SZeev SuraskiZEND_API int _object_init(zval *arg ZEND_FILE_LINE_DC TSRMLS_DC);
202fcc03510SZeev SuraskiZEND_API int _object_init_ex(zval *arg, zend_class_entry *ce ZEND_FILE_LINE_DC TSRMLS_DC);
20376a7a5bcSAndi GutmansZEND_API int _object_and_properties_init(zval *arg, zend_class_entry *ce, HashTable *properties ZEND_FILE_LINE_DC TSRMLS_DC);
2046847fefaSThies C. Arntzen
2056847fefaSThies C. Arntzen/* no longer supported */
2064f6c95d1SZeev SuraskiZEND_API int add_assoc_function(zval *arg, char *key, void (*function_ptr)(INTERNAL_FUNCTION_PARAMETERS));
2076847fefaSThies C. Arntzen
208ef95a346SAndi GutmansZEND_API int add_assoc_long_ex(zval *arg, char *key, uint key_len, long n);
2090611acb9SAndi GutmansZEND_API int add_assoc_null_ex(zval *arg, char *key, uint key_len);
210ef95a346SAndi GutmansZEND_API int add_assoc_bool_ex(zval *arg, char *key, uint key_len, int b);
211ef95a346SAndi GutmansZEND_API int add_assoc_resource_ex(zval *arg, char *key, uint key_len, int r);
212ef95a346SAndi GutmansZEND_API int add_assoc_double_ex(zval *arg, char *key, uint key_len, double d);
213ef95a346SAndi GutmansZEND_API int add_assoc_string_ex(zval *arg, char *key, uint key_len, char *str, int duplicate);
214ef95a346SAndi GutmansZEND_API int add_assoc_stringl_ex(zval *arg, char *key, uint key_len, char *str, uint length, int duplicate);
215ef95a346SAndi GutmansZEND_API int add_assoc_zval_ex(zval *arg, char *key, uint key_len, zval *value);
216ef95a346SAndi Gutmans
217ef95a346SAndi Gutmans#define add_assoc_long(__arg, __key, __n) add_assoc_long_ex(__arg, __key, strlen(__key)+1, __n)
2180611acb9SAndi Gutmans#define add_assoc_null(__arg, __key) add_assoc_null_ex(__arg, __key, strlen(__key) + 1)
219ef95a346SAndi Gutmans#define add_assoc_bool(__arg, __key, __b) add_assoc_bool_ex(__arg, __key, strlen(__key)+1, __b)
220ef95a346SAndi Gutmans#define add_assoc_resource(__arg, __key, __r) add_assoc_resource_ex(__arg, __key, strlen(__key)+1, __r)
221ef95a346SAndi Gutmans#define add_assoc_double(__arg, __key, __d) add_assoc_double_ex(__arg, __key, strlen(__key)+1, __d)
222ef95a346SAndi Gutmans#define add_assoc_string(__arg, __key, __str, __duplicate) add_assoc_string_ex(__arg, __key, strlen(__key)+1, __str, __duplicate)
223ef95a346SAndi Gutmans#define add_assoc_stringl(__arg, __key, __str, __length, __duplicate) add_assoc_stringl_ex(__arg, __key, strlen(__key)+1, __str, __length, __duplicate)
224ef95a346SAndi Gutmans#define add_assoc_zval(__arg, __key, __value) add_assoc_zval_ex(__arg, __key, strlen(__key)+1, __value)
2256847fefaSThies C. Arntzen
2260611acb9SAndi Gutmans/* unset() functions are only suported for legacy modules and null() functions should be used */
2270611acb9SAndi Gutmans#define add_assoc_unset(__arg, __key) add_assoc_null_ex(__arg, __key, strlen(__key) + 1)
2280611acb9SAndi Gutmans#define add_index_unset(__arg, __key) add_index_null(__arg, __key)
2290611acb9SAndi Gutmans#define add_next_index_unset(__arg) add_next_index_null(__arg)
2300611acb9SAndi Gutmans#define add_property_unset(__arg, __key) add_property_null(__arg, __key)
2310611acb9SAndi Gutmans
232573b4602SAndi GutmansZEND_API int add_index_long(zval *arg, uint idx, long n);
2330611acb9SAndi GutmansZEND_API int add_index_null(zval *arg, uint idx);
2346847fefaSThies C. ArntzenZEND_API int add_index_bool(zval *arg, uint idx, int b);
2356847fefaSThies C. ArntzenZEND_API int add_index_resource(zval *arg, uint idx, int r);
236573b4602SAndi GutmansZEND_API int add_index_double(zval *arg, uint idx, double d);
237573b4602SAndi GutmansZEND_API int add_index_string(zval *arg, uint idx, char *str, int duplicate);
238573b4602SAndi GutmansZEND_API int add_index_stringl(zval *arg, uint idx, char *str, uint length, int duplicate);
23957f99633SAndrei ZmievskiZEND_API int add_index_zval(zval *arg, uint index, zval *value);
2406847fefaSThies C. Arntzen
241573b4602SAndi GutmansZEND_API int add_next_index_long(zval *arg, long n);
2420611acb9SAndi GutmansZEND_API int add_next_index_null(zval *arg);
2436847fefaSThies C. ArntzenZEND_API int add_next_index_bool(zval *arg, int b);
2446847fefaSThies C. ArntzenZEND_API int add_next_index_resource(zval *arg, int r);
245573b4602SAndi GutmansZEND_API int add_next_index_double(zval *arg, double d);
246573b4602SAndi GutmansZEND_API int add_next_index_string(zval *arg, char *str, int duplicate);
247573b4602SAndi GutmansZEND_API int add_next_index_stringl(zval *arg, char *str, uint length, int duplicate);
248ef95a346SAndi GutmansZEND_API int add_next_index_zval(zval *arg, zval *value);
249ef95a346SAndi Gutmans
250ef95a346SAndi GutmansZEND_API int add_get_assoc_string_ex(zval *arg, char *key, uint key_len, char *str, void **dest, int duplicate);
251ef95a346SAndi GutmansZEND_API int add_get_assoc_stringl_ex(zval *arg, char *key, uint key_len, char *str, uint length, void **dest, int duplicate);
252ef95a346SAndi Gutmans
253ef95a346SAndi Gutmans#define add_get_assoc_string(__arg, __key, __str, __dest, __duplicate) add_get_assoc_string_ex(__arg, __key, strlen(__key)+1, __str, __dest, __duplicate)
254ef95a346SAndi 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)
255573b4602SAndi Gutmans
256573b4602SAndi GutmansZEND_API int add_get_index_long(zval *arg, uint idx, long l, void **dest);
257573b4602SAndi GutmansZEND_API int add_get_index_double(zval *arg, uint idx, double d, void **dest);
258573b4602SAndi GutmansZEND_API int add_get_index_string(zval *arg, uint idx, char *str, void **dest, int duplicate);
259573b4602SAndi GutmansZEND_API int add_get_index_stringl(zval *arg, uint idx, char *str, uint length, void **dest, int duplicate);
260573b4602SAndi Gutmans
261eccc5368SStanislav MalyshevZEND_API int add_property_long_ex(zval *arg, char *key, uint key_len, long l TSRMLS_DC);
262eccc5368SStanislav MalyshevZEND_API int add_property_null_ex(zval *arg, char *key, uint key_len TSRMLS_DC);
263eccc5368SStanislav MalyshevZEND_API int add_property_bool_ex(zval *arg, char *key, uint key_len, int b TSRMLS_DC);
264eccc5368SStanislav MalyshevZEND_API int add_property_resource_ex(zval *arg, char *key, uint key_len, long r TSRMLS_DC);
265eccc5368SStanislav MalyshevZEND_API int add_property_double_ex(zval *arg, char *key, uint key_len, double d TSRMLS_DC);
266eccc5368SStanislav MalyshevZEND_API int add_property_string_ex(zval *arg, char *key, uint key_len, char *str, int duplicate TSRMLS_DC);
267eccc5368SStanislav MalyshevZEND_API int add_property_stringl_ex(zval *arg, char *key, uint key_len,  char *str, uint length, int duplicate TSRMLS_DC);
268eccc5368SStanislav MalyshevZEND_API int add_property_zval_ex(zval *arg, char *key, uint key_len, zval *value TSRMLS_DC);
269eccc5368SStanislav Malyshev
270eccc5368SStanislav Malyshev#define add_property_long(__arg, __key, __n) add_property_long_ex(__arg, __key, strlen(__key)+1, __n TSRMLS_CC)
271eccc5368SStanislav Malyshev#define add_property_null(__arg, __key) add_property_null_ex(__arg, __key, strlen(__key) + 1 TSRMLS_CC)
272eccc5368SStanislav Malyshev#define add_property_bool(__arg, __key, __b) add_property_bool_ex(__arg, __key, strlen(__key)+1, __b TSRMLS_CC)
273eccc5368SStanislav Malyshev#define add_property_resource(__arg, __key, __r) add_property_resource_ex(__arg, __key, strlen(__key)+1, __r TSRMLS_CC)
274eccc5368SStanislav Malyshev#define add_property_double(__arg, __key, __d) add_property_double_ex(__arg, __key, strlen(__key)+1, __d TSRMLS_CC)
275eccc5368SStanislav Malyshev#define add_property_string(__arg, __key, __str, __duplicate) add_property_string_ex(__arg, __key, strlen(__key)+1, __str, __duplicate TSRMLS_CC)
276eccc5368SStanislav Malyshev#define add_property_stringl(__arg, __key, __str, __length, __duplicate) add_property_stringl_ex(__arg, __key, strlen(__key)+1, __str, __length, __duplicate TSRMLS_CC)
277eccc5368SStanislav Malyshev#define add_property_zval(__arg, __key, __value) add_property_zval_ex(__arg, __key, strlen(__key)+1, __value TSRMLS_CC)
278ef95a346SAndi Gutmans
27992b4013eSZeev Suraski
280f8bbafd6SZeev 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);
281f8bbafd6SZeev 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);
28292b4013eSZeev Suraski
28392b4013eSZeev Suraskitypedef struct _zend_fcall_info {
28492b4013eSZeev Suraski	size_t size;
28592b4013eSZeev Suraski	HashTable *function_table;
28692b4013eSZeev Suraski	zval *function_name;
28792b4013eSZeev Suraski	HashTable *symbol_table;
28892b4013eSZeev Suraski	zval **retval_ptr_ptr;
28992b4013eSZeev Suraski	zend_uint param_count;
29092b4013eSZeev Suraski	zval ***params;
29192b4013eSZeev Suraski	zval **object_pp;
29292b4013eSZeev Suraski	zend_bool no_separation;
29392b4013eSZeev Suraski} zend_fcall_info;
29492b4013eSZeev Suraski
29592b4013eSZeev Suraskitypedef struct _zend_fcall_info_cache {
29692b4013eSZeev Suraski	zend_bool initialized;
29792b4013eSZeev Suraski	zend_function *function_handler;
29892b4013eSZeev Suraski	zend_class_entry *calling_scope;
29992b4013eSZeev Suraski	zval **object_pp;
30092b4013eSZeev Suraski} zend_fcall_info_cache;
30192b4013eSZeev Suraski
30292b4013eSZeev SuraskiZEND_API extern zend_fcall_info_cache empty_fcall_info_cache;
30392b4013eSZeev Suraski
30492b4013eSZeev SuraskiZEND_API int zend_call_function(zend_fcall_info *fci, zend_fcall_info_cache *fci_cache TSRMLS_DC);
30592b4013eSZeev Suraski
306573b4602SAndi Gutmans
307f962a35dSAndrei ZmievskiZEND_API int zend_set_hash_symbol(zval *symbol, char *name, int name_length,
30851e797f1SHarald Radi                                  zend_bool is_ref, int num_symbol_tables, ...);
309f962a35dSAndrei Zmievski
3104f6c95d1SZeev Suraski#define add_method(arg, key, method)	add_assoc_function((arg), (key), (method))
311573b4602SAndi Gutmans
312a35c61afSAndrei ZmievskiZEND_API ZEND_FUNCTION(display_disabled_function);
313a700180fSHarald RadiZEND_API ZEND_FUNCTION(display_disabled_class);
314a35c61afSAndrei Zmievski
315bcddfd47SThies C. Arntzen#if ZEND_DEBUG
316bcddfd47SThies C. Arntzen#define CHECK_ZVAL_STRING(z) \
317ace55f32SZeev 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); }
31843ebb868SZeev Suraski#define CHECK_ZVAL_STRING_REL(z) \
319ace55f32SZeev 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); }
320bcddfd47SThies C. Arntzen#else
321bcddfd47SThies C. Arntzen#define CHECK_ZVAL_STRING(z)
32243ebb868SZeev Suraski#define CHECK_ZVAL_STRING_REL(z)
323bcddfd47SThies C. Arntzen#endif
324bcddfd47SThies C. Arntzen
3254f6c95d1SZeev Suraski#define ZVAL_RESOURCE(z, l) {			\
326af22085cSThies C. Arntzen		(z)->type = IS_RESOURCE;        \
327af22085cSThies C. Arntzen		(z)->value.lval = l;	        \
328af22085cSThies C. Arntzen	}
329bcddfd47SThies C. Arntzen
3304f6c95d1SZeev Suraski#define ZVAL_BOOL(z, b) {				\
331af22085cSThies C. Arntzen		(z)->type = IS_BOOL;	        \
332af22085cSThies C. Arntzen		(z)->value.lval = b;	        \
333af22085cSThies C. Arntzen	}
334bcddfd47SThies C. Arntzen
335af22085cSThies C. Arntzen#define ZVAL_NULL(z) {					\
336af22085cSThies C. Arntzen		(z)->type = IS_NULL;	        \
337af22085cSThies C. Arntzen	}
338bcddfd47SThies C. Arntzen
3394f6c95d1SZeev Suraski#define ZVAL_LONG(z, l) {				\
340af22085cSThies C. Arntzen		(z)->type = IS_LONG;	        \
341af22085cSThies C. Arntzen		(z)->value.lval = l;	        \
342af22085cSThies C. Arntzen	}
343bcddfd47SThies C. Arntzen
3444f6c95d1SZeev Suraski#define ZVAL_DOUBLE(z, d) {				\
345af22085cSThies C. Arntzen		(z)->type = IS_DOUBLE;	        \
346af22085cSThies C. Arntzen		(z)->value.dval = d;	        \
347af22085cSThies C. Arntzen	}
348bcddfd47SThies C. Arntzen
3494f6c95d1SZeev Suraski#define ZVAL_STRING(z, s, duplicate) {	\
350af22085cSThies C. Arntzen		char *__s=(s);					\
351af22085cSThies C. Arntzen		(z)->value.str.len = strlen(__s);	\
3524f6c95d1SZeev Suraski		(z)->value.str.val = (duplicate?estrndup(__s, (z)->value.str.len):__s);	\
353af22085cSThies C. Arntzen		(z)->type = IS_STRING;	        \
354af22085cSThies C. Arntzen	}
355bcddfd47SThies C. Arntzen
3564f6c95d1SZeev Suraski#define ZVAL_STRINGL(z, s, l, duplicate) {	\
357af22085cSThies C. Arntzen		char *__s=(s); int __l=l;		\
358af22085cSThies C. Arntzen		(z)->value.str.len = __l;	    \
3594f6c95d1SZeev Suraski		(z)->value.str.val = (duplicate?estrndup(__s, __l):__s);	\
360af22085cSThies C. Arntzen		(z)->type = IS_STRING;		    \
361af22085cSThies C. Arntzen	}
362af22085cSThies C. Arntzen
363af22085cSThies C. Arntzen#define ZVAL_EMPTY_STRING(z) {	        \
364af22085cSThies C. Arntzen		(z)->value.str.len = 0;  	    \
3651f793fd0SStanislav Malyshev		(z)->value.str.val = empty_string; \
366af22085cSThies C. Arntzen		(z)->type = IS_STRING;		    \
367af22085cSThies C. Arntzen	}
368af22085cSThies C. Arntzen
3694f6c95d1SZeev Suraski#define ZVAL_FALSE(z)  					ZVAL_BOOL(z, 0)
3704f6c95d1SZeev Suraski#define ZVAL_TRUE(z)  					ZVAL_BOOL(z, 1)
371af22085cSThies C. Arntzen
3724f6c95d1SZeev Suraski#define RETVAL_RESOURCE(l)				ZVAL_RESOURCE(return_value, l)
3734f6c95d1SZeev Suraski#define RETVAL_BOOL(b)					ZVAL_BOOL(return_value, b)
374bcddfd47SThies C. Arntzen#define RETVAL_NULL() 					ZVAL_NULL(return_value)
3754f6c95d1SZeev Suraski#define RETVAL_LONG(l) 					ZVAL_LONG(return_value, l)
3764f6c95d1SZeev Suraski#define RETVAL_DOUBLE(d) 				ZVAL_DOUBLE(return_value, d)
3774f6c95d1SZeev Suraski#define RETVAL_STRING(s, duplicate) 		ZVAL_STRING(return_value, s, duplicate)
3784f6c95d1SZeev Suraski#define RETVAL_STRINGL(s, l, duplicate) 	ZVAL_STRINGL(return_value, s, l, duplicate)
379bcddfd47SThies C. Arntzen#define RETVAL_EMPTY_STRING() 			ZVAL_EMPTY_STRING(return_value)
3804f6c95d1SZeev Suraski#define RETVAL_FALSE  					ZVAL_BOOL(return_value, 0)
3814f6c95d1SZeev Suraski#define RETVAL_TRUE   					ZVAL_BOOL(return_value, 1)
382bcddfd47SThies C. Arntzen
383bcddfd47SThies C. Arntzen#define RETURN_RESOURCE(l) 				{ RETVAL_RESOURCE(l); return; }
384bcddfd47SThies C. Arntzen#define RETURN_BOOL(b) 					{ RETVAL_BOOL(b); return; }
385bcddfd47SThies C. Arntzen#define RETURN_NULL() 					{ RETVAL_NULL(); return;}
386bcddfd47SThies C. Arntzen#define RETURN_LONG(l) 					{ RETVAL_LONG(l); return; }
387bcddfd47SThies C. Arntzen#define RETURN_DOUBLE(d) 				{ RETVAL_DOUBLE(d); return; }
3884f6c95d1SZeev Suraski#define RETURN_STRING(s, duplicate) 	{ RETVAL_STRING(s, duplicate); return; }
3894f6c95d1SZeev Suraski#define RETURN_STRINGL(s, l, duplicate) { RETVAL_STRINGL(s, l, duplicate); return; }
390bcddfd47SThies C. Arntzen#define RETURN_EMPTY_STRING() 			{ RETVAL_EMPTY_STRING(); return; }
391bcddfd47SThies C. Arntzen#define RETURN_FALSE  					{ RETVAL_FALSE; return; }
392bcddfd47SThies C. Arntzen#define RETURN_TRUE   					{ RETVAL_TRUE; return; }
3931f985edeSZeev Suraski
3944f6c95d1SZeev Suraski#define SET_VAR_STRING(n, v) {																				\
39548ffdd79SZeev Suraski								{																			\
396235386b2SZeev Suraski									zval *var;																\
397235386b2SZeev Suraski									ALLOC_ZVAL(var);														\
3984f6c95d1SZeev Suraski									ZVAL_STRING(var, v, 0);													\
3996393ab14SZeev Suraski									ZEND_SET_GLOBAL_VAR(n, var);											\
40048ffdd79SZeev Suraski								}																			\
4011f985edeSZeev Suraski							}
40248ffdd79SZeev Suraski
4034f6c95d1SZeev Suraski#define SET_VAR_STRINGL(n, v, l) {														\
40448ffdd79SZeev Suraski									{													\
405235386b2SZeev Suraski										zval *var;										\
406235386b2SZeev Suraski										ALLOC_ZVAL(var);								\
4074f6c95d1SZeev Suraski										ZVAL_STRINGL(var, v, l, 0);						\
40848ffdd79SZeev Suraski										ZEND_SET_GLOBAL_VAR(n, var);					\
40948ffdd79SZeev Suraski									}													\
4101f985edeSZeev Suraski								}
41148ffdd79SZeev Suraski
4124f6c95d1SZeev Suraski#define SET_VAR_LONG(n, v)	{															\
41348ffdd79SZeev Suraski								{														\
414235386b2SZeev Suraski									zval *var;											\
415235386b2SZeev Suraski									ALLOC_ZVAL(var);									\
4164f6c95d1SZeev Suraski									ZVAL_LONG(var, v);									\
41748ffdd79SZeev Suraski									ZEND_SET_GLOBAL_VAR(n, var);						\
41848ffdd79SZeev Suraski								}														\
4191f985edeSZeev Suraski							}
42048ffdd79SZeev Suraski
4214f6c95d1SZeev Suraski#define SET_VAR_DOUBLE(n, v) {															\
42248ffdd79SZeev Suraski								{														\
423235386b2SZeev Suraski									zval *var;											\
424235386b2SZeev Suraski									ALLOC_ZVAL(var);									\
4254f6c95d1SZeev Suraski									ZVAL_DOUBLE(var, v);								\
42648ffdd79SZeev Suraski									ZEND_SET_GLOBAL_VAR(n, var);						\
42748ffdd79SZeev Suraski								}														\
4281f985edeSZeev Suraski							}
4291f985edeSZeev Suraski
4301f985edeSZeev Suraski
431c34560b5SAndi Gutmans#define ZEND_SET_SYMBOL(symtable, name, var)										\
432c34560b5SAndi Gutmans	{																				\
433c34560b5SAndi Gutmans		char *_name = (name);														\
434c34560b5SAndi Gutmans																					\
4354c8259b5SAndi Gutmans		ZEND_SET_SYMBOL_WITH_LENGTH(symtable, _name, strlen(_name)+1, var, 1, 0);	\
43648ffdd79SZeev Suraski	}
43748ffdd79SZeev Suraski
438c34560b5SAndi Gutmans#define ZEND_SET_SYMBOL_WITH_LENGTH(symtable, name, name_length, var, _refcount, _is_ref)				\
43948ffdd79SZeev Suraski	{																									\
44048ffdd79SZeev Suraski		zval **orig_var;																				\
44148ffdd79SZeev Suraski																										\
442620d0134SZeev Suraski		if (zend_hash_find(symtable, (name), (name_length), (void **) &orig_var)==SUCCESS				\
44348ffdd79SZeev Suraski			&& PZVAL_IS_REF(*orig_var)) {																\
444158088caSZeev Suraski			(var)->refcount = (*orig_var)->refcount;													\
44552a30fd2SAndrei Zmievski			(var)->is_ref = 1;																			\
44648ffdd79SZeev Suraski																										\
4472ddc4fe4SZeev Suraski			if (_refcount) {																			\
4482ddc4fe4SZeev Suraski				(var)->refcount += _refcount-1;															\
4492ddc4fe4SZeev Suraski			}																							\
45048ffdd79SZeev Suraski			zval_dtor(*orig_var);																		\
451158088caSZeev Suraski			**orig_var = *(var);																		\
45262b2087aSAndi Gutmans			FREE_ZVAL(var);																					\
45348ffdd79SZeev Suraski		} else {																						\
4542f5efbdeSAndi Gutmans			(var)->is_ref = _is_ref;																	\
455158088caSZeev Suraski			if (_refcount) {																			\
456158088caSZeev Suraski				(var)->refcount = _refcount;															\
457158088caSZeev Suraski			}																							\
458158088caSZeev Suraski			zend_hash_update(symtable, (name), (name_length), &(var), sizeof(zval *), NULL);			\
45948ffdd79SZeev Suraski		}																								\
46048ffdd79SZeev Suraski	}
46148ffdd79SZeev Suraski
462620d0134SZeev Suraski
463620d0134SZeev Suraski#define ZEND_SET_GLOBAL_VAR(name, var)				\
464620d0134SZeev Suraski	ZEND_SET_SYMBOL(&EG(symbol_table), name, var)
465620d0134SZeev Suraski
466e3450661SAndrei Zmievski#define ZEND_SET_GLOBAL_VAR_WITH_LENGTH(name, name_length, var, _refcount, _is_ref)		\
467e3450661SAndrei Zmievski	ZEND_SET_SYMBOL_WITH_LENGTH(&EG(symbol_table), name, name_length, var, _refcount, _is_ref)
468fec413c5SAndrei Zmievski
4690229aad0SGeorge Schlossnagle#define ZEND_DEFINE_PROPERTY(class_ptr, name, value, mask)								\
47013433852SZeev Suraski{																					\
47113433852SZeev Suraski	char *_name = (name);															\
47213433852SZeev Suraski	int namelen = strlen(_name);													\
4730229aad0SGeorge Schlossnagle	zend_declare_property(class_ptr, _name, namelen, value, mask);		\
474daf3ac65SGeorge Schlossnagle}
475daf3ac65SGeorge Schlossnagle
4766608f073SStanislav Malyshev#define HASH_OF(p) ((p)->type==IS_ARRAY ? (p)->value.ht : (((p)->type==IS_OBJECT ? Z_OBJ_HT_P(p)->get_properties((p) TSRMLS_CC) : NULL)))
477af22085cSThies C. Arntzen#define ZVAL_IS_NULL(z) ((z)->type==IS_NULL)
47806a18f16SAndi Gutmans
4798b6f848cSAndi Gutmans/* For compatibility */
4808b6f848cSAndi Gutmans#define ZEND_MINIT			ZEND_MODULE_STARTUP_N
4818b6f848cSAndi Gutmans#define ZEND_MSHUTDOWN		ZEND_MODULE_SHUTDOWN_N
4828b6f848cSAndi Gutmans#define ZEND_RINIT			ZEND_MODULE_ACTIVATE_N
4838b6f848cSAndi Gutmans#define ZEND_RSHUTDOWN		ZEND_MODULE_DEACTIVATE_N
4848b6f848cSAndi Gutmans#define ZEND_MINFO			ZEND_MODULE_INFO_N
4858b6f848cSAndi Gutmans
4868b6f848cSAndi Gutmans#define ZEND_MINIT_FUNCTION			ZEND_MODULE_STARTUP_D
487f5c59863SStanislav Malyshev#define ZEND_MSHUTDOWN_FUNCTION		ZEND_MODULE_SHUTDOWN_D
488f5c59863SStanislav Malyshev#define ZEND_RINIT_FUNCTION			ZEND_MODULE_ACTIVATE_D
489f5c59863SStanislav Malyshev#define ZEND_RSHUTDOWN_FUNCTION		ZEND_MODULE_DEACTIVATE_D
490f5c59863SStanislav Malyshev#define ZEND_MINFO_FUNCTION			ZEND_MODULE_INFO_D
4918b6f848cSAndi Gutmans
4920450ab94SZeev SuraskiEND_EXTERN_C()
4930450ab94SZeev Suraski
494b982307dSSascha Schumann#endif /* ZEND_API_H */
495573b4602SAndi Gutmans
4968b6f848cSAndi Gutmans
497573b4602SAndi Gutmans/*
498573b4602SAndi Gutmans * Local variables:
499573b4602SAndi Gutmans * tab-width: 4
500573b4602SAndi Gutmans * c-basic-offset: 4
501333406bdSfoobar * indent-tabs-mode: t
502573b4602SAndi Gutmans * End:
503573b4602SAndi Gutmans */
504