zend_API.h revision 6ac6cb10
1573b4602SAndi Gutmans/*
2573b4602SAndi Gutmans   +----------------------------------------------------------------------+
3573b4602SAndi Gutmans   | Zend Engine                                                          |
4573b4602SAndi Gutmans   +----------------------------------------------------------------------+
562dc854bSSebastian Bergmann   | Copyright (c) 1998-2002 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        |
9b5b11177SZeev Suraski   | available at through the world-wide-web at                           |
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
21b5b11177SZeev Suraski
22b982307dSSascha Schumann#ifndef ZEND_API_H
23b982307dSSascha Schumann#define ZEND_API_H
24573b4602SAndi Gutmans
257080fa5bSAndi Gutmans#include "zend_modules.h"
26573b4602SAndi Gutmans#include "zend_list.h"
27b7a5b3c3SZeev Suraski#include "zend_fast_cache.h"
285dba4774SZeev Suraski#include "zend_operators.h"
295dba4774SZeev Suraski#include "zend_variables.h"
30df74f1dfSSascha Schumann#include "zend_execute.h"
31573b4602SAndi Gutmans
328b6f848cSAndi Gutmans#define ZEND_FN(name) zif_##name
33342c6e0bSZeev Suraski#define ZEND_NAMED_FUNCTION(name) void name(INTERNAL_FUNCTION_PARAMETERS)
34e9d126a7SAndi Gutmans#define ZEND_FUNCTION(name) ZEND_NAMED_FUNCTION(ZEND_FN(name))
35e9d126a7SAndi Gutmans
36e9d126a7SAndi Gutmans#define ZEND_NAMED_FE(zend_name, name, arg_types) { #zend_name, name, arg_types },
37e9d126a7SAndi Gutmans#define ZEND_FE(name, arg_types) ZEND_NAMED_FE(name, ZEND_FN(name), arg_types)
38e9d126a7SAndi Gutmans#define ZEND_FALIAS(name, alias, arg_types) ZEND_NAMED_FE(name, ZEND_FN(alias), arg_types)
3961edd1bfSAndi Gutmans#define ZEND_STATIC_FE(name, impl_name, arg_types) { name, impl_name, arg_types },
40342c6e0bSZeev Suraski
418b6f848cSAndi Gutmans/* Name macros */
428b6f848cSAndi Gutmans#define ZEND_MODULE_STARTUP_N(module)       zm_startup_##module
438b6f848cSAndi Gutmans#define ZEND_MODULE_SHUTDOWN_N(module)		zm_shutdown_##module
448b6f848cSAndi Gutmans#define ZEND_MODULE_ACTIVATE_N(module)		zm_activate_##module
458b6f848cSAndi Gutmans#define ZEND_MODULE_DEACTIVATE_N(module)	zm_deactivate_##module
468b6f848cSAndi Gutmans#define ZEND_MODULE_INFO_N(module)			zm_info_##module
47342c6e0bSZeev Suraski
488b6f848cSAndi Gutmans/* Declaration macros */
498b6f848cSAndi Gutmans#define ZEND_MODULE_STARTUP_D(module)		int ZEND_MODULE_STARTUP_N(module)(INIT_FUNC_ARGS)
508b6f848cSAndi Gutmans#define ZEND_MODULE_SHUTDOWN_D(module)		int ZEND_MODULE_SHUTDOWN_N(module)(SHUTDOWN_FUNC_ARGS)
518b6f848cSAndi Gutmans#define ZEND_MODULE_ACTIVATE_D(module)		int ZEND_MODULE_ACTIVATE_N(module)(INIT_FUNC_ARGS)
528b6f848cSAndi Gutmans#define ZEND_MODULE_DEACTIVATE_D(module)	int ZEND_MODULE_DEACTIVATE_N(module)(SHUTDOWN_FUNC_ARGS)
538b6f848cSAndi Gutmans#define ZEND_MODULE_INFO_D(module)			void ZEND_MODULE_INFO_N(module)(ZEND_MODULE_INFO_FUNC_ARGS)
54342c6e0bSZeev Suraski
550b6d923bSSascha Schumann#define ZEND_GET_MODULE(name) \
560b6d923bSSascha Schumann	ZEND_DLEXPORT zend_module_entry *get_module(void) { return &name##_module_entry; }
570d21940dSZeev Suraski
580d21940dSZeev Suraski#define ZEND_BEGIN_MODULE_GLOBALS(module_name)		\
590d21940dSZeev Suraski	typedef struct _zend_##module_name##_globals {
600d21940dSZeev Suraski#define ZEND_END_MODULE_GLOBALS(module_name)		\
610d21940dSZeev Suraski	} zend_##module_name##_globals;
620d21940dSZeev Suraski
630d21940dSZeev Suraski#ifdef ZTS
640d21940dSZeev Suraski
650d21940dSZeev Suraski#define ZEND_DECLARE_MODULE_GLOBALS(module_name)							\
6602af513cSAndi Gutmans	ts_rsrc_id module_name##_globals_id;
6702af513cSAndi Gutmans#define ZEND_EXTERN_MODULE_GLOBALS(module_name)								\
6802af513cSAndi Gutmans	extern ts_rsrc_id module_name##_globals_id;
690d21940dSZeev Suraski#define ZEND_INIT_MODULE_GLOBALS(module_name, globals_ctor, globals_dtor)	\
702c254ba7SZeev Suraski	ts_allocate_id(&module_name##_globals_id, sizeof(zend_##module_name##_globals), (ts_allocate_ctor) globals_ctor, (ts_allocate_dtor) globals_dtor);
710d21940dSZeev Suraski
720d21940dSZeev Suraski#else
730d21940dSZeev Suraski
740d21940dSZeev Suraski#define ZEND_DECLARE_MODULE_GLOBALS(module_name)							\
7502af513cSAndi Gutmans	zend_##module_name##_globals module_name##_globals;
7602af513cSAndi Gutmans#define ZEND_EXTERN_MODULE_GLOBALS(module_name)								\
7702af513cSAndi Gutmans	extern zend_##module_name##_globals module_name##_globals;
780d21940dSZeev Suraski#define ZEND_INIT_MODULE_GLOBALS(module_name, globals_ctor, globals_dtor)	\
790d21940dSZeev Suraski	globals_ctor(&module_name##_globals);
800d21940dSZeev Suraski
810d21940dSZeev Suraski#endif
820d21940dSZeev Suraski
830d21940dSZeev Suraski
840d21940dSZeev Suraski
85741b8161SZeev Suraski#define INIT_CLASS_ENTRY(class_container, class_name, functions)	\
86741b8161SZeev Suraski	{																\
87741b8161SZeev Suraski		class_container.name = strdup(class_name);					\
88741b8161SZeev Suraski		class_container.name_length = sizeof(class_name)-1;			\
89741b8161SZeev Suraski		class_container.builtin_functions = functions;				\
902eccd95cSAndi Gutmans		class_container.constructor = NULL;							\
9173b159e0SAndi Gutmans		class_container.destructor = NULL;							\
9229ea3da2SAndi Gutmans		class_container.clone = NULL;								\
936608f073SStanislav Malyshev		class_container.create_object = NULL;	 					\
94741b8161SZeev Suraski		class_container.handle_function_call = NULL;				\
95741b8161SZeev Suraski		class_container.handle_property_get = NULL;					\
96741b8161SZeev Suraski		class_container.handle_property_set = NULL;					\
97741b8161SZeev Suraski	}
98741b8161SZeev Suraski
99741b8161SZeev Suraski#define INIT_OVERLOADED_CLASS_ENTRY(class_container, class_name, functions, handle_fcall, handle_propget, handle_propset) \
100741b8161SZeev Suraski	{															\
101741b8161SZeev Suraski		class_container.name = strdup(class_name);				\
102741b8161SZeev Suraski		class_container.name_length = sizeof(class_name)-1;		\
103741b8161SZeev Suraski		class_container.builtin_functions = functions;			\
1042eccd95cSAndi Gutmans		class_container.constructor = NULL;						\
10573b159e0SAndi Gutmans		class_container.destructor = NULL;						\
10629ea3da2SAndi Gutmans		class_container.clone = NULL;							\
1076608f073SStanislav Malyshev		class_container.create_object = NULL;	 				\
108741b8161SZeev Suraski		class_container.handle_function_call = handle_fcall;	\
109741b8161SZeev Suraski		class_container.handle_property_get = handle_propget;	\
110741b8161SZeev Suraski		class_container.handle_property_set = handle_propset;	\
111741b8161SZeev Suraski	}
112741b8161SZeev Suraski
113741b8161SZeev Suraski
114741b8161SZeev Suraski
115573b4602SAndi Gutmansint zend_next_free_module(void);
116573b4602SAndi Gutmans
117f77e6a44SZeev SuraskiZEND_API int zend_get_parameters(int ht, int param_count, ...);
11811e5d2f2SZeev SuraskiZEND_API int _zend_get_parameters_array(int ht, int param_count, zval **argument_array TSRMLS_DC);
119f77e6a44SZeev SuraskiZEND_API int zend_get_parameters_ex(int param_count, ...);
12011e5d2f2SZeev SuraskiZEND_API int _zend_get_parameters_array_ex(int param_count, zval ***argument_array TSRMLS_DC);
12111e5d2f2SZeev Suraski
12211e5d2f2SZeev Suraski#define zend_get_parameters_array(ht, param_count, argument_array)			\
12311e5d2f2SZeev Suraski	_zend_get_parameters_array(ht, param_count, argument_array TSRMLS_CC)
12411e5d2f2SZeev Suraski#define zend_get_parameters_array_ex(param_count, argument_array)			\
12511e5d2f2SZeev Suraski	_zend_get_parameters_array_ex(param_count, argument_array TSRMLS_CC)
12639f9487eSAndi Gutmans
12758f88057SAndrei Zmievski
12858f88057SAndrei Zmievski/* Parameter parsing API -- andrei */
12958f88057SAndrei Zmievski
13058f88057SAndrei Zmievski#define ZEND_PARSE_PARAMS_QUIET 1<<1
1318ce8324eSZeev SuraskiZEND_API int zend_parse_parameters(int num_args TSRMLS_DC, char *type_spec, ...);
1323839af35SAndrei ZmievskiZEND_API int zend_parse_parameters_ex(int flags, int num_args TSRMLS_DC, char *type_spec, ...);
1339b391a83SDerick RethansZEND_API char *zend_zval_type_name(zval *arg);
13458f88057SAndrei Zmievski
135b5255495SZeev Suraski/* End of parameter parsing API -- andrei */
13639f9487eSAndi Gutmans
137b5770382SZeev Suraskiint zend_register_functions(zend_function_entry *functions, HashTable *function_table, int type TSRMLS_DC);
138b5770382SZeev Suraskivoid zend_unregister_functions(zend_function_entry *functions, int count, HashTable *function_table TSRMLS_DC);
1397a87fcbbSZeev SuraskiZEND_API int zend_register_module(zend_module_entry *module_entry);
140eb0e6946SAndi Gutmans
141b5770382SZeev SuraskiZEND_API zend_class_entry *zend_register_internal_class(zend_class_entry *class_entry TSRMLS_DC);
142b5770382SZeev 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);
143eb0e6946SAndi Gutmans
144bfbe8618SZeev SuraskiZEND_API zend_module_entry *zend_get_module(int module_number);
145d76cf1daSZeev SuraskiZEND_API int zend_disable_function(char *function_name, uint function_name_length TSRMLS_DC);
146573b4602SAndi Gutmans
1474187439cSZeev SuraskiZEND_API void zend_wrong_param_count(TSRMLS_D);
14813148b54SAndrei ZmievskiZEND_API zend_bool zend_is_callable(zval *callable, zend_bool syntax_only, char **callable_name);
14901850714SSebastian BergmannZEND_API char *zend_get_module_version(char *module_name);
150573b4602SAndi Gutmans
1516ac6cb10SHarald RadiZEND_API zend_class_entry **zend_get_class_entry(zval *zobject);
1526ac6cb10SHarald Radi
153741b8161SZeev Suraski#define getThis() (this_ptr)
154741b8161SZeev Suraski
155131d9cb2SZeev Suraski#define WRONG_PARAM_COUNT					ZEND_WRONG_PARAM_COUNT()
156131d9cb2SZeev Suraski#define WRONG_PARAM_COUNT_WITH_RETVAL(ret)	ZEND_WRONG_PARAM_COUNT_WITH_RETVAL(ret)
157a1ad2872SZeev Suraski#define ARG_COUNT(dummy)	(ht)
158a1ad2872SZeev Suraski#define ZEND_NUM_ARGS()		(ht)
1594187439cSZeev Suraski#define ZEND_WRONG_PARAM_COUNT()					{ zend_wrong_param_count(TSRMLS_C); return; }
1604187439cSZeev Suraski#define ZEND_WRONG_PARAM_COUNT_WITH_RETVAL(ret)		{ zend_wrong_param_count(TSRMLS_C); return ret; }
161573b4602SAndi Gutmans
16280bdd19eSZeev Suraski#ifndef ZEND_WIN32
163573b4602SAndi Gutmans#define DLEXPORT
164573b4602SAndi Gutmans#endif
165573b4602SAndi Gutmans
166e0628436SAndrei ZmievskiZEND_API int zend_startup_module(zend_module_entry *module);
167573b4602SAndi Gutmans
168ceba50b6SZeev Suraski#define array_init(arg)			_array_init((arg) ZEND_FILE_LINE_CC)
169fcc03510SZeev Suraski#define object_init(arg)		_object_init((arg) ZEND_FILE_LINE_CC TSRMLS_CC)
170fcc03510SZeev Suraski#define object_init_ex(arg, ce)	_object_init_ex((arg), (ce) ZEND_FILE_LINE_CC TSRMLS_CC)
17176a7a5bcSAndi Gutmans#define object_and_properties_init(arg, ce, properties)	_object_and_properties_init((arg), (ce), (properties) ZEND_FILE_LINE_CC TSRMLS_CC)
172ceba50b6SZeev SuraskiZEND_API int _array_init(zval *arg ZEND_FILE_LINE_DC);
173fcc03510SZeev SuraskiZEND_API int _object_init(zval *arg ZEND_FILE_LINE_DC TSRMLS_DC);
174fcc03510SZeev SuraskiZEND_API int _object_init_ex(zval *arg, zend_class_entry *ce ZEND_FILE_LINE_DC TSRMLS_DC);
17576a7a5bcSAndi GutmansZEND_API int _object_and_properties_init(zval *arg, zend_class_entry *ce, HashTable *properties ZEND_FILE_LINE_DC TSRMLS_DC);
1766847fefaSThies C. Arntzen
1776847fefaSThies C. Arntzen/* no longer supported */
1784f6c95d1SZeev SuraskiZEND_API int add_assoc_function(zval *arg, char *key, void (*function_ptr)(INTERNAL_FUNCTION_PARAMETERS));
1796847fefaSThies C. Arntzen
180ef95a346SAndi GutmansZEND_API int add_assoc_long_ex(zval *arg, char *key, uint key_len, long n);
1810611acb9SAndi GutmansZEND_API int add_assoc_null_ex(zval *arg, char *key, uint key_len);
182ef95a346SAndi GutmansZEND_API int add_assoc_bool_ex(zval *arg, char *key, uint key_len, int b);
183ef95a346SAndi GutmansZEND_API int add_assoc_resource_ex(zval *arg, char *key, uint key_len, int r);
184ef95a346SAndi GutmansZEND_API int add_assoc_double_ex(zval *arg, char *key, uint key_len, double d);
185ef95a346SAndi GutmansZEND_API int add_assoc_string_ex(zval *arg, char *key, uint key_len, char *str, int duplicate);
186ef95a346SAndi GutmansZEND_API int add_assoc_stringl_ex(zval *arg, char *key, uint key_len, char *str, uint length, int duplicate);
187ef95a346SAndi GutmansZEND_API int add_assoc_zval_ex(zval *arg, char *key, uint key_len, zval *value);
188ef95a346SAndi Gutmans
189ef95a346SAndi Gutmans#define add_assoc_long(__arg, __key, __n) add_assoc_long_ex(__arg, __key, strlen(__key)+1, __n)
1900611acb9SAndi Gutmans#define add_assoc_null(__arg, __key) add_assoc_null_ex(__arg, __key, strlen(__key) + 1)
191ef95a346SAndi Gutmans#define add_assoc_bool(__arg, __key, __b) add_assoc_bool_ex(__arg, __key, strlen(__key)+1, __b)
192ef95a346SAndi Gutmans#define add_assoc_resource(__arg, __key, __r) add_assoc_resource_ex(__arg, __key, strlen(__key)+1, __r)
193ef95a346SAndi Gutmans#define add_assoc_double(__arg, __key, __d) add_assoc_double_ex(__arg, __key, strlen(__key)+1, __d)
194ef95a346SAndi Gutmans#define add_assoc_string(__arg, __key, __str, __duplicate) add_assoc_string_ex(__arg, __key, strlen(__key)+1, __str, __duplicate)
195ef95a346SAndi Gutmans#define add_assoc_stringl(__arg, __key, __str, __length, __duplicate) add_assoc_stringl_ex(__arg, __key, strlen(__key)+1, __str, __length, __duplicate)
196ef95a346SAndi Gutmans#define add_assoc_zval(__arg, __key, __value) add_assoc_zval_ex(__arg, __key, strlen(__key)+1, __value)
1976847fefaSThies C. Arntzen
1980611acb9SAndi Gutmans/* unset() functions are only suported for legacy modules and null() functions should be used */
1990611acb9SAndi Gutmans#define add_assoc_unset(__arg, __key) add_assoc_null_ex(__arg, __key, strlen(__key) + 1)
2000611acb9SAndi Gutmans#define add_index_unset(__arg, __key) add_index_null(__arg, __key)
2010611acb9SAndi Gutmans#define add_next_index_unset(__arg) add_next_index_null(__arg)
2020611acb9SAndi Gutmans#define add_property_unset(__arg, __key) add_property_null(__arg, __key)
2030611acb9SAndi Gutmans
204573b4602SAndi GutmansZEND_API int add_index_long(zval *arg, uint idx, long n);
2050611acb9SAndi GutmansZEND_API int add_index_null(zval *arg, uint idx);
2066847fefaSThies C. ArntzenZEND_API int add_index_bool(zval *arg, uint idx, int b);
2076847fefaSThies C. ArntzenZEND_API int add_index_resource(zval *arg, uint idx, int r);
208573b4602SAndi GutmansZEND_API int add_index_double(zval *arg, uint idx, double d);
209573b4602SAndi GutmansZEND_API int add_index_string(zval *arg, uint idx, char *str, int duplicate);
210573b4602SAndi GutmansZEND_API int add_index_stringl(zval *arg, uint idx, char *str, uint length, int duplicate);
21157f99633SAndrei ZmievskiZEND_API int add_index_zval(zval *arg, uint index, zval *value);
2126847fefaSThies C. Arntzen
213573b4602SAndi GutmansZEND_API int add_next_index_long(zval *arg, long n);
2140611acb9SAndi GutmansZEND_API int add_next_index_null(zval *arg);
2156847fefaSThies C. ArntzenZEND_API int add_next_index_bool(zval *arg, int b);
2166847fefaSThies C. ArntzenZEND_API int add_next_index_resource(zval *arg, int r);
217573b4602SAndi GutmansZEND_API int add_next_index_double(zval *arg, double d);
218573b4602SAndi GutmansZEND_API int add_next_index_string(zval *arg, char *str, int duplicate);
219573b4602SAndi GutmansZEND_API int add_next_index_stringl(zval *arg, char *str, uint length, int duplicate);
220ef95a346SAndi GutmansZEND_API int add_next_index_zval(zval *arg, zval *value);
221ef95a346SAndi Gutmans
222ef95a346SAndi GutmansZEND_API int add_get_assoc_string_ex(zval *arg, char *key, uint key_len, char *str, void **dest, int duplicate);
223ef95a346SAndi GutmansZEND_API int add_get_assoc_stringl_ex(zval *arg, char *key, uint key_len, char *str, uint length, void **dest, int duplicate);
224ef95a346SAndi Gutmans
225ef95a346SAndi Gutmans#define add_get_assoc_string(__arg, __key, __str, __dest, __duplicate) add_get_assoc_string_ex(__arg, __key, strlen(__key)+1, __str, __dest, __duplicate)
226ef95a346SAndi 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)
227573b4602SAndi Gutmans
228573b4602SAndi GutmansZEND_API int add_get_index_long(zval *arg, uint idx, long l, void **dest);
229573b4602SAndi GutmansZEND_API int add_get_index_double(zval *arg, uint idx, double d, void **dest);
230573b4602SAndi GutmansZEND_API int add_get_index_string(zval *arg, uint idx, char *str, void **dest, int duplicate);
231573b4602SAndi GutmansZEND_API int add_get_index_stringl(zval *arg, uint idx, char *str, uint length, void **dest, int duplicate);
232573b4602SAndi Gutmans
233ef95a346SAndi GutmansZEND_API int add_property_long_ex(zval *arg, char *key, uint key_len, long l);
2340611acb9SAndi GutmansZEND_API int add_property_null_ex(zval *arg, char *key, uint key_len);
235ef95a346SAndi GutmansZEND_API int add_property_bool_ex(zval *arg, char *key, uint key_len, int b);
236ef95a346SAndi GutmansZEND_API int add_property_resource_ex(zval *arg, char *key, uint key_len, long r);
237ef95a346SAndi GutmansZEND_API int add_property_double_ex(zval *arg, char *key, uint key_len, double d);
238ef95a346SAndi GutmansZEND_API int add_property_string_ex(zval *arg, char *key, uint key_len, char *str, int duplicate);
239ef95a346SAndi GutmansZEND_API int add_property_stringl_ex(zval *arg, char *key, uint key_len,  char *str, uint length, int duplicate);
240ef95a346SAndi GutmansZEND_API int add_property_zval_ex(zval *arg, char *key, uint key_len, zval *value);
241ef95a346SAndi Gutmans
242ef95a346SAndi Gutmans#define add_property_long(__arg, __key, __n) add_property_long_ex(__arg, __key, strlen(__key)+1, __n)
2430611acb9SAndi Gutmans#define add_property_null(__arg, __key) add_property_null_ex(__arg, __key, strlen(__key) + 1)
244ef95a346SAndi Gutmans#define add_property_bool(__arg, __key, __b) add_property_bool_ex(__arg, __key, strlen(__key)+1, __b)
245ef95a346SAndi Gutmans#define add_property_resource(__arg, __key, __r) add_property_resource_ex(__arg, __key, strlen(__key)+1, __r)
246ef95a346SAndi Gutmans#define add_property_double(__arg, __key, __d) add_property_double_ex(__arg, __key, strlen(__key)+1, __d)
247ef95a346SAndi Gutmans#define add_property_string(__arg, __key, __str, __duplicate) add_property_string_ex(__arg, __key, strlen(__key)+1, __str, __duplicate)
248ef95a346SAndi Gutmans#define add_property_stringl(__arg, __key, __str, __length, __duplicate) add_property_stringl_ex(__arg, __key, strlen(__key)+1, __str, __length, __duplicate)
249ef95a346SAndi Gutmans#define add_property_zval(__arg, __key, __value) add_property_zval_ex(__arg, __key, strlen(__key)+1, __value)
250ef95a346SAndi Gutmans
2514187439cSZeev SuraskiZEND_API int call_user_function(HashTable *function_table, zval **object_pp, zval *function_name, zval *retval_ptr, int param_count, zval *params[] TSRMLS_DC);
2524187439cSZeev SuraskiZEND_API int call_user_function_ex(HashTable *function_table, zval **object_pp, zval *function_name, zval **retval_ptr_ptr, int param_count, zval **params[], int no_separation, HashTable *symbol_table TSRMLS_DC);
253573b4602SAndi Gutmans
254f962a35dSAndrei ZmievskiZEND_API int zend_set_hash_symbol(zval *symbol, char *name, int name_length,
255f962a35dSAndrei Zmievski                                  int is_ref, int num_symbol_tables, ...);
256f962a35dSAndrei Zmievski
2574f6c95d1SZeev Suraski#define add_method(arg, key, method)	add_assoc_function((arg), (key), (method))
258573b4602SAndi Gutmans
259bcddfd47SThies C. Arntzen#if ZEND_DEBUG
260bcddfd47SThies C. Arntzen#define CHECK_ZVAL_STRING(z) \
26143ebb868SZeev 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);
26243ebb868SZeev Suraski#define CHECK_ZVAL_STRING_REL(z) \
26343ebb868SZeev 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);
264bcddfd47SThies C. Arntzen#else
265bcddfd47SThies C. Arntzen#define CHECK_ZVAL_STRING(z)
26643ebb868SZeev Suraski#define CHECK_ZVAL_STRING_REL(z)
267bcddfd47SThies C. Arntzen#endif
268bcddfd47SThies C. Arntzen
2694f6c95d1SZeev Suraski#define ZVAL_RESOURCE(z, l) {			\
270af22085cSThies C. Arntzen		(z)->type = IS_RESOURCE;        \
271af22085cSThies C. Arntzen		(z)->value.lval = l;	        \
272af22085cSThies C. Arntzen	}
273bcddfd47SThies C. Arntzen
2744f6c95d1SZeev Suraski#define ZVAL_BOOL(z, b) {				\
275af22085cSThies C. Arntzen		(z)->type = IS_BOOL;	        \
276af22085cSThies C. Arntzen		(z)->value.lval = b;	        \
277af22085cSThies C. Arntzen	}
278bcddfd47SThies C. Arntzen
279af22085cSThies C. Arntzen#define ZVAL_NULL(z) {					\
280af22085cSThies C. Arntzen		(z)->type = IS_NULL;	        \
281af22085cSThies C. Arntzen	}
282bcddfd47SThies C. Arntzen
2834f6c95d1SZeev Suraski#define ZVAL_LONG(z, l) {				\
284af22085cSThies C. Arntzen		(z)->type = IS_LONG;	        \
285af22085cSThies C. Arntzen		(z)->value.lval = l;	        \
286af22085cSThies C. Arntzen	}
287bcddfd47SThies C. Arntzen
2884f6c95d1SZeev Suraski#define ZVAL_DOUBLE(z, d) {				\
289af22085cSThies C. Arntzen		(z)->type = IS_DOUBLE;	        \
290af22085cSThies C. Arntzen		(z)->value.dval = d;	        \
291af22085cSThies C. Arntzen	}
292bcddfd47SThies C. Arntzen
2934f6c95d1SZeev Suraski#define ZVAL_STRING(z, s, duplicate) {	\
294af22085cSThies C. Arntzen		char *__s=(s);					\
295af22085cSThies C. Arntzen		(z)->value.str.len = strlen(__s);	\
2964f6c95d1SZeev Suraski		(z)->value.str.val = (duplicate?estrndup(__s, (z)->value.str.len):__s);	\
297af22085cSThies C. Arntzen		(z)->type = IS_STRING;	        \
298af22085cSThies C. Arntzen	}
299bcddfd47SThies C. Arntzen
3004f6c95d1SZeev Suraski#define ZVAL_STRINGL(z, s, l, duplicate) {	\
301af22085cSThies C. Arntzen		char *__s=(s); int __l=l;		\
302af22085cSThies C. Arntzen		(z)->value.str.len = __l;	    \
3034f6c95d1SZeev Suraski		(z)->value.str.val = (duplicate?estrndup(__s, __l):__s);	\
304af22085cSThies C. Arntzen		(z)->type = IS_STRING;		    \
305af22085cSThies C. Arntzen	}
306af22085cSThies C. Arntzen
307af22085cSThies C. Arntzen#define ZVAL_EMPTY_STRING(z) {	        \
308af22085cSThies C. Arntzen		(z)->value.str.len = 0;  	    \
3091f793fd0SStanislav Malyshev		(z)->value.str.val = empty_string; \
310af22085cSThies C. Arntzen		(z)->type = IS_STRING;		    \
311af22085cSThies C. Arntzen	}
312af22085cSThies C. Arntzen
3134f6c95d1SZeev Suraski#define ZVAL_FALSE(z)  					ZVAL_BOOL(z, 0)
3144f6c95d1SZeev Suraski#define ZVAL_TRUE(z)  					ZVAL_BOOL(z, 1)
315af22085cSThies C. Arntzen
3164f6c95d1SZeev Suraski#define RETVAL_RESOURCE(l)				ZVAL_RESOURCE(return_value, l)
3174f6c95d1SZeev Suraski#define RETVAL_BOOL(b)					ZVAL_BOOL(return_value, b)
318bcddfd47SThies C. Arntzen#define RETVAL_NULL() 					ZVAL_NULL(return_value)
3194f6c95d1SZeev Suraski#define RETVAL_LONG(l) 					ZVAL_LONG(return_value, l)
3204f6c95d1SZeev Suraski#define RETVAL_DOUBLE(d) 				ZVAL_DOUBLE(return_value, d)
3214f6c95d1SZeev Suraski#define RETVAL_STRING(s, duplicate) 		ZVAL_STRING(return_value, s, duplicate)
3224f6c95d1SZeev Suraski#define RETVAL_STRINGL(s, l, duplicate) 	ZVAL_STRINGL(return_value, s, l, duplicate)
323bcddfd47SThies C. Arntzen#define RETVAL_EMPTY_STRING() 			ZVAL_EMPTY_STRING(return_value)
3244f6c95d1SZeev Suraski#define RETVAL_FALSE  					ZVAL_BOOL(return_value, 0)
3254f6c95d1SZeev Suraski#define RETVAL_TRUE   					ZVAL_BOOL(return_value, 1)
326bcddfd47SThies C. Arntzen
327bcddfd47SThies C. Arntzen#define RETURN_RESOURCE(l) 				{ RETVAL_RESOURCE(l); return; }
328bcddfd47SThies C. Arntzen#define RETURN_BOOL(b) 					{ RETVAL_BOOL(b); return; }
329bcddfd47SThies C. Arntzen#define RETURN_NULL() 					{ RETVAL_NULL(); return;}
330bcddfd47SThies C. Arntzen#define RETURN_LONG(l) 					{ RETVAL_LONG(l); return; }
331bcddfd47SThies C. Arntzen#define RETURN_DOUBLE(d) 				{ RETVAL_DOUBLE(d); return; }
3324f6c95d1SZeev Suraski#define RETURN_STRING(s, duplicate) 	{ RETVAL_STRING(s, duplicate); return; }
3334f6c95d1SZeev Suraski#define RETURN_STRINGL(s, l, duplicate) { RETVAL_STRINGL(s, l, duplicate); return; }
334bcddfd47SThies C. Arntzen#define RETURN_EMPTY_STRING() 			{ RETVAL_EMPTY_STRING(); return; }
335bcddfd47SThies C. Arntzen#define RETURN_FALSE  					{ RETVAL_FALSE; return; }
336bcddfd47SThies C. Arntzen#define RETURN_TRUE   					{ RETVAL_TRUE; return; }
3371f985edeSZeev Suraski
3384f6c95d1SZeev Suraski#define SET_VAR_STRING(n, v) {																				\
33948ffdd79SZeev Suraski								{																			\
340235386b2SZeev Suraski									zval *var;																\
341235386b2SZeev Suraski									ALLOC_ZVAL(var);														\
3424f6c95d1SZeev Suraski									ZVAL_STRING(var, v, 0);													\
3436393ab14SZeev Suraski									ZEND_SET_GLOBAL_VAR(n, var);											\
34448ffdd79SZeev Suraski								}																			\
3451f985edeSZeev Suraski							}
34648ffdd79SZeev Suraski
3474f6c95d1SZeev Suraski#define SET_VAR_STRINGL(n, v, l) {														\
34848ffdd79SZeev Suraski									{													\
349235386b2SZeev Suraski										zval *var;										\
350235386b2SZeev Suraski										ALLOC_ZVAL(var);								\
3514f6c95d1SZeev Suraski										ZVAL_STRINGL(var, v, l, 0);						\
35248ffdd79SZeev Suraski										ZEND_SET_GLOBAL_VAR(n, var);					\
35348ffdd79SZeev Suraski									}													\
3541f985edeSZeev Suraski								}
35548ffdd79SZeev Suraski
3564f6c95d1SZeev Suraski#define SET_VAR_LONG(n, v)	{															\
35748ffdd79SZeev Suraski								{														\
358235386b2SZeev Suraski									zval *var;											\
359235386b2SZeev Suraski									ALLOC_ZVAL(var);									\
3604f6c95d1SZeev Suraski									ZVAL_LONG(var, v);									\
36148ffdd79SZeev Suraski									ZEND_SET_GLOBAL_VAR(n, var);						\
36248ffdd79SZeev Suraski								}														\
3631f985edeSZeev Suraski							}
36448ffdd79SZeev Suraski
3654f6c95d1SZeev Suraski#define SET_VAR_DOUBLE(n, v) {															\
36648ffdd79SZeev Suraski								{														\
367235386b2SZeev Suraski									zval *var;											\
368235386b2SZeev Suraski									ALLOC_ZVAL(var);									\
3694f6c95d1SZeev Suraski									ZVAL_DOUBLE(var, v);								\
37048ffdd79SZeev Suraski									ZEND_SET_GLOBAL_VAR(n, var);						\
37148ffdd79SZeev Suraski								}														\
3721f985edeSZeev Suraski							}
3731f985edeSZeev Suraski
3741f985edeSZeev Suraski
375c34560b5SAndi Gutmans#define ZEND_SET_SYMBOL(symtable, name, var)										\
376c34560b5SAndi Gutmans	{																				\
377c34560b5SAndi Gutmans		char *_name = (name);														\
378c34560b5SAndi Gutmans																					\
3794c8259b5SAndi Gutmans		ZEND_SET_SYMBOL_WITH_LENGTH(symtable, _name, strlen(_name)+1, var, 1, 0);	\
38048ffdd79SZeev Suraski	}
38148ffdd79SZeev Suraski
382c34560b5SAndi Gutmans#define ZEND_SET_SYMBOL_WITH_LENGTH(symtable, name, name_length, var, _refcount, _is_ref)				\
38348ffdd79SZeev Suraski	{																									\
38448ffdd79SZeev Suraski		zval **orig_var;																				\
38548ffdd79SZeev Suraski																										\
386620d0134SZeev Suraski		if (zend_hash_find(symtable, (name), (name_length), (void **) &orig_var)==SUCCESS				\
38748ffdd79SZeev Suraski			&& PZVAL_IS_REF(*orig_var)) {																\
388158088caSZeev Suraski			(var)->refcount = (*orig_var)->refcount;													\
38952a30fd2SAndrei Zmievski			(var)->is_ref = 1;																			\
39048ffdd79SZeev Suraski																										\
3912ddc4fe4SZeev Suraski			if (_refcount) {																			\
3922ddc4fe4SZeev Suraski				(var)->refcount += _refcount-1;															\
3932ddc4fe4SZeev Suraski			}																							\
39448ffdd79SZeev Suraski			zval_dtor(*orig_var);																		\
395158088caSZeev Suraski			**orig_var = *(var);																		\
39662b2087aSAndi Gutmans			FREE_ZVAL(var);																					\
39748ffdd79SZeev Suraski		} else {																						\
3982f5efbdeSAndi Gutmans			(var)->is_ref = _is_ref;																	\
399158088caSZeev Suraski			if (_refcount) {																			\
400158088caSZeev Suraski				(var)->refcount = _refcount;															\
401158088caSZeev Suraski			}																							\
402158088caSZeev Suraski			zend_hash_update(symtable, (name), (name_length), &(var), sizeof(zval *), NULL);			\
40348ffdd79SZeev Suraski		}																								\
40448ffdd79SZeev Suraski	}
40548ffdd79SZeev Suraski
406620d0134SZeev Suraski
407620d0134SZeev Suraski#define ZEND_SET_GLOBAL_VAR(name, var)				\
408620d0134SZeev Suraski	ZEND_SET_SYMBOL(&EG(symbol_table), name, var)
409620d0134SZeev Suraski
410e3450661SAndrei Zmievski#define ZEND_SET_GLOBAL_VAR_WITH_LENGTH(name, name_length, var, _refcount, _is_ref)		\
411e3450661SAndrei Zmievski	ZEND_SET_SYMBOL_WITH_LENGTH(&EG(symbol_table), name, name_length, var, _refcount, _is_ref)
412fec413c5SAndrei Zmievski
4136608f073SStanislav 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)))
414af22085cSThies C. Arntzen#define ZVAL_IS_NULL(z) ((z)->type==IS_NULL)
41506a18f16SAndi Gutmans
4168b6f848cSAndi Gutmans/* For compatibility */
4178b6f848cSAndi Gutmans#define ZEND_MINIT			ZEND_MODULE_STARTUP_N
4188b6f848cSAndi Gutmans#define ZEND_MSHUTDOWN		ZEND_MODULE_SHUTDOWN_N
4198b6f848cSAndi Gutmans#define ZEND_RINIT			ZEND_MODULE_ACTIVATE_N
4208b6f848cSAndi Gutmans#define ZEND_RSHUTDOWN		ZEND_MODULE_DEACTIVATE_N
4218b6f848cSAndi Gutmans#define ZEND_MINFO			ZEND_MODULE_INFO_N
4228b6f848cSAndi Gutmans
4238b6f848cSAndi Gutmans#define ZEND_MINIT_FUNCTION			ZEND_MODULE_STARTUP_D
424f5c59863SStanislav Malyshev#define ZEND_MSHUTDOWN_FUNCTION		ZEND_MODULE_SHUTDOWN_D
425f5c59863SStanislav Malyshev#define ZEND_RINIT_FUNCTION			ZEND_MODULE_ACTIVATE_D
426f5c59863SStanislav Malyshev#define ZEND_RSHUTDOWN_FUNCTION		ZEND_MODULE_DEACTIVATE_D
427f5c59863SStanislav Malyshev#define ZEND_MINFO_FUNCTION			ZEND_MODULE_INFO_D
4288b6f848cSAndi Gutmans
429b982307dSSascha Schumann#endif /* ZEND_API_H */
430573b4602SAndi Gutmans
4318b6f848cSAndi Gutmans
432573b4602SAndi Gutmans/*
433573b4602SAndi Gutmans * Local variables:
434573b4602SAndi Gutmans * tab-width: 4
435573b4602SAndi Gutmans * c-basic-offset: 4
436573b4602SAndi Gutmans * End:
437573b4602SAndi Gutmans */
438