zend_API.h revision a35c61af
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
320450ab94SZeev Suraski
330450ab94SZeev SuraskiBEGIN_EXTERN_C()
348b6f848cSAndi Gutmans#define ZEND_FN(name) zif_##name
35342c6e0bSZeev Suraski#define ZEND_NAMED_FUNCTION(name) void name(INTERNAL_FUNCTION_PARAMETERS)
36e9d126a7SAndi Gutmans#define ZEND_FUNCTION(name) ZEND_NAMED_FUNCTION(ZEND_FN(name))
37e9d126a7SAndi Gutmans
38e9d126a7SAndi Gutmans#define ZEND_NAMED_FE(zend_name, name, arg_types) { #zend_name, name, arg_types },
39e9d126a7SAndi Gutmans#define ZEND_FE(name, arg_types) ZEND_NAMED_FE(name, ZEND_FN(name), arg_types)
40e9d126a7SAndi Gutmans#define ZEND_FALIAS(name, alias, arg_types) ZEND_NAMED_FE(name, ZEND_FN(alias), arg_types)
4161edd1bfSAndi Gutmans#define ZEND_STATIC_FE(name, impl_name, arg_types) { name, impl_name, arg_types },
42342c6e0bSZeev Suraski
438b6f848cSAndi Gutmans/* Name macros */
448b6f848cSAndi Gutmans#define ZEND_MODULE_STARTUP_N(module)       zm_startup_##module
458b6f848cSAndi Gutmans#define ZEND_MODULE_SHUTDOWN_N(module)		zm_shutdown_##module
468b6f848cSAndi Gutmans#define ZEND_MODULE_ACTIVATE_N(module)		zm_activate_##module
478b6f848cSAndi Gutmans#define ZEND_MODULE_DEACTIVATE_N(module)	zm_deactivate_##module
488b6f848cSAndi Gutmans#define ZEND_MODULE_INFO_N(module)			zm_info_##module
49342c6e0bSZeev Suraski
508b6f848cSAndi Gutmans/* Declaration macros */
518b6f848cSAndi Gutmans#define ZEND_MODULE_STARTUP_D(module)		int ZEND_MODULE_STARTUP_N(module)(INIT_FUNC_ARGS)
528b6f848cSAndi Gutmans#define ZEND_MODULE_SHUTDOWN_D(module)		int ZEND_MODULE_SHUTDOWN_N(module)(SHUTDOWN_FUNC_ARGS)
538b6f848cSAndi Gutmans#define ZEND_MODULE_ACTIVATE_D(module)		int ZEND_MODULE_ACTIVATE_N(module)(INIT_FUNC_ARGS)
548b6f848cSAndi Gutmans#define ZEND_MODULE_DEACTIVATE_D(module)	int ZEND_MODULE_DEACTIVATE_N(module)(SHUTDOWN_FUNC_ARGS)
558b6f848cSAndi Gutmans#define ZEND_MODULE_INFO_D(module)			void ZEND_MODULE_INFO_N(module)(ZEND_MODULE_INFO_FUNC_ARGS)
56342c6e0bSZeev Suraski
570b6d923bSSascha Schumann#define ZEND_GET_MODULE(name) \
580b6d923bSSascha Schumann	ZEND_DLEXPORT zend_module_entry *get_module(void) { return &name##_module_entry; }
590d21940dSZeev Suraski
600d21940dSZeev Suraski#define ZEND_BEGIN_MODULE_GLOBALS(module_name)		\
610d21940dSZeev Suraski	typedef struct _zend_##module_name##_globals {
620d21940dSZeev Suraski#define ZEND_END_MODULE_GLOBALS(module_name)		\
630d21940dSZeev Suraski	} zend_##module_name##_globals;
640d21940dSZeev Suraski
650d21940dSZeev Suraski#ifdef ZTS
660d21940dSZeev Suraski
670d21940dSZeev Suraski#define ZEND_DECLARE_MODULE_GLOBALS(module_name)							\
6802af513cSAndi Gutmans	ts_rsrc_id module_name##_globals_id;
6902af513cSAndi Gutmans#define ZEND_EXTERN_MODULE_GLOBALS(module_name)								\
7002af513cSAndi Gutmans	extern ts_rsrc_id module_name##_globals_id;
710d21940dSZeev Suraski#define ZEND_INIT_MODULE_GLOBALS(module_name, globals_ctor, globals_dtor)	\
722c254ba7SZeev Suraski	ts_allocate_id(&module_name##_globals_id, sizeof(zend_##module_name##_globals), (ts_allocate_ctor) globals_ctor, (ts_allocate_dtor) globals_dtor);
730d21940dSZeev Suraski
740d21940dSZeev Suraski#else
750d21940dSZeev Suraski
760d21940dSZeev Suraski#define ZEND_DECLARE_MODULE_GLOBALS(module_name)							\
7702af513cSAndi Gutmans	zend_##module_name##_globals module_name##_globals;
7802af513cSAndi Gutmans#define ZEND_EXTERN_MODULE_GLOBALS(module_name)								\
7902af513cSAndi Gutmans	extern zend_##module_name##_globals module_name##_globals;
800d21940dSZeev Suraski#define ZEND_INIT_MODULE_GLOBALS(module_name, globals_ctor, globals_dtor)	\
810d21940dSZeev Suraski	globals_ctor(&module_name##_globals);
820d21940dSZeev Suraski
830d21940dSZeev Suraski#endif
840d21940dSZeev Suraski
850d21940dSZeev Suraski
860d21940dSZeev Suraski
873738a6edSHarald Radi#define INIT_CLASS_ENTRY(class_container, class_name, functions) INIT_OVERLOADED_CLASS_ENTRY(class_container, class_name, functions, NULL, NULL, NULL)
88741b8161SZeev Suraski
89741b8161SZeev Suraski#define INIT_OVERLOADED_CLASS_ENTRY(class_container, class_name, functions, handle_fcall, handle_propget, handle_propset) \
90741b8161SZeev Suraski	{															\
91741b8161SZeev Suraski		class_container.name = strdup(class_name);				\
92741b8161SZeev Suraski		class_container.name_length = sizeof(class_name)-1;		\
93741b8161SZeev Suraski		class_container.builtin_functions = functions;			\
942eccd95cSAndi Gutmans		class_container.constructor = NULL;						\
9573b159e0SAndi Gutmans		class_container.destructor = NULL;						\
9629ea3da2SAndi Gutmans		class_container.clone = NULL;							\
976608f073SStanislav Malyshev		class_container.create_object = NULL;	 				\
98741b8161SZeev Suraski		class_container.handle_function_call = handle_fcall;	\
99741b8161SZeev Suraski		class_container.handle_property_get = handle_propget;	\
100741b8161SZeev Suraski		class_container.handle_property_set = handle_propset;	\
101741b8161SZeev Suraski	}
102741b8161SZeev Suraski
103741b8161SZeev Suraski
104741b8161SZeev Suraski
105573b4602SAndi Gutmansint zend_next_free_module(void);
106573b4602SAndi Gutmans
107f77e6a44SZeev SuraskiZEND_API int zend_get_parameters(int ht, int param_count, ...);
10811e5d2f2SZeev SuraskiZEND_API int _zend_get_parameters_array(int ht, int param_count, zval **argument_array TSRMLS_DC);
109f77e6a44SZeev SuraskiZEND_API int zend_get_parameters_ex(int param_count, ...);
11011e5d2f2SZeev SuraskiZEND_API int _zend_get_parameters_array_ex(int param_count, zval ***argument_array TSRMLS_DC);
11111e5d2f2SZeev Suraski
11211e5d2f2SZeev Suraski#define zend_get_parameters_array(ht, param_count, argument_array)			\
11311e5d2f2SZeev Suraski	_zend_get_parameters_array(ht, param_count, argument_array TSRMLS_CC)
11411e5d2f2SZeev Suraski#define zend_get_parameters_array_ex(param_count, argument_array)			\
11511e5d2f2SZeev Suraski	_zend_get_parameters_array_ex(param_count, argument_array TSRMLS_CC)
11639f9487eSAndi Gutmans
11758f88057SAndrei Zmievski
11858f88057SAndrei Zmievski/* Parameter parsing API -- andrei */
11958f88057SAndrei Zmievski
12058f88057SAndrei Zmievski#define ZEND_PARSE_PARAMS_QUIET 1<<1
1218ce8324eSZeev SuraskiZEND_API int zend_parse_parameters(int num_args TSRMLS_DC, char *type_spec, ...);
1223839af35SAndrei ZmievskiZEND_API int zend_parse_parameters_ex(int flags, int num_args TSRMLS_DC, char *type_spec, ...);
1239b391a83SDerick RethansZEND_API char *zend_zval_type_name(zval *arg);
12458f88057SAndrei Zmievski
125b5255495SZeev Suraski/* End of parameter parsing API -- andrei */
12639f9487eSAndi Gutmans
127b5770382SZeev Suraskiint zend_register_functions(zend_function_entry *functions, HashTable *function_table, int type TSRMLS_DC);
128b5770382SZeev Suraskivoid zend_unregister_functions(zend_function_entry *functions, int count, HashTable *function_table TSRMLS_DC);
1297a87fcbbSZeev SuraskiZEND_API int zend_register_module(zend_module_entry *module_entry);
130eb0e6946SAndi Gutmans
131b5770382SZeev SuraskiZEND_API zend_class_entry *zend_register_internal_class(zend_class_entry *class_entry TSRMLS_DC);
132b5770382SZeev 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);
133eb0e6946SAndi Gutmans
134bfbe8618SZeev SuraskiZEND_API zend_module_entry *zend_get_module(int module_number);
135d76cf1daSZeev SuraskiZEND_API int zend_disable_function(char *function_name, uint function_name_length TSRMLS_DC);
136573b4602SAndi Gutmans
1374187439cSZeev SuraskiZEND_API void zend_wrong_param_count(TSRMLS_D);
13813148b54SAndrei ZmievskiZEND_API zend_bool zend_is_callable(zval *callable, zend_bool syntax_only, char **callable_name);
13901850714SSebastian BergmannZEND_API char *zend_get_module_version(char *module_name);
140573b4602SAndi Gutmans
1417a067547SStanislav MalyshevZEND_API zend_class_entry *zend_get_class_entry(zval *zobject);
1426ac6cb10SHarald Radi
143741b8161SZeev Suraski#define getThis() (this_ptr)
144741b8161SZeev Suraski
145131d9cb2SZeev Suraski#define WRONG_PARAM_COUNT					ZEND_WRONG_PARAM_COUNT()
146131d9cb2SZeev Suraski#define WRONG_PARAM_COUNT_WITH_RETVAL(ret)	ZEND_WRONG_PARAM_COUNT_WITH_RETVAL(ret)
147a1ad2872SZeev Suraski#define ARG_COUNT(dummy)	(ht)
148a1ad2872SZeev Suraski#define ZEND_NUM_ARGS()		(ht)
1494187439cSZeev Suraski#define ZEND_WRONG_PARAM_COUNT()					{ zend_wrong_param_count(TSRMLS_C); return; }
1504187439cSZeev Suraski#define ZEND_WRONG_PARAM_COUNT_WITH_RETVAL(ret)		{ zend_wrong_param_count(TSRMLS_C); return ret; }
151573b4602SAndi Gutmans
15280bdd19eSZeev Suraski#ifndef ZEND_WIN32
153573b4602SAndi Gutmans#define DLEXPORT
154573b4602SAndi Gutmans#endif
155573b4602SAndi Gutmans
156e0628436SAndrei ZmievskiZEND_API int zend_startup_module(zend_module_entry *module);
157573b4602SAndi Gutmans
158ceba50b6SZeev Suraski#define array_init(arg)			_array_init((arg) ZEND_FILE_LINE_CC)
159fcc03510SZeev Suraski#define object_init(arg)		_object_init((arg) ZEND_FILE_LINE_CC TSRMLS_CC)
160fcc03510SZeev Suraski#define object_init_ex(arg, ce)	_object_init_ex((arg), (ce) ZEND_FILE_LINE_CC TSRMLS_CC)
16176a7a5bcSAndi Gutmans#define object_and_properties_init(arg, ce, properties)	_object_and_properties_init((arg), (ce), (properties) ZEND_FILE_LINE_CC TSRMLS_CC)
162ceba50b6SZeev SuraskiZEND_API int _array_init(zval *arg ZEND_FILE_LINE_DC);
163fcc03510SZeev SuraskiZEND_API int _object_init(zval *arg ZEND_FILE_LINE_DC TSRMLS_DC);
164fcc03510SZeev SuraskiZEND_API int _object_init_ex(zval *arg, zend_class_entry *ce ZEND_FILE_LINE_DC TSRMLS_DC);
16576a7a5bcSAndi GutmansZEND_API int _object_and_properties_init(zval *arg, zend_class_entry *ce, HashTable *properties ZEND_FILE_LINE_DC TSRMLS_DC);
1666847fefaSThies C. Arntzen
1676847fefaSThies C. Arntzen/* no longer supported */
1684f6c95d1SZeev SuraskiZEND_API int add_assoc_function(zval *arg, char *key, void (*function_ptr)(INTERNAL_FUNCTION_PARAMETERS));
1696847fefaSThies C. Arntzen
170ef95a346SAndi GutmansZEND_API int add_assoc_long_ex(zval *arg, char *key, uint key_len, long n);
1710611acb9SAndi GutmansZEND_API int add_assoc_null_ex(zval *arg, char *key, uint key_len);
172ef95a346SAndi GutmansZEND_API int add_assoc_bool_ex(zval *arg, char *key, uint key_len, int b);
173ef95a346SAndi GutmansZEND_API int add_assoc_resource_ex(zval *arg, char *key, uint key_len, int r);
174ef95a346SAndi GutmansZEND_API int add_assoc_double_ex(zval *arg, char *key, uint key_len, double d);
175ef95a346SAndi GutmansZEND_API int add_assoc_string_ex(zval *arg, char *key, uint key_len, char *str, int duplicate);
176ef95a346SAndi GutmansZEND_API int add_assoc_stringl_ex(zval *arg, char *key, uint key_len, char *str, uint length, int duplicate);
177ef95a346SAndi GutmansZEND_API int add_assoc_zval_ex(zval *arg, char *key, uint key_len, zval *value);
178ef95a346SAndi Gutmans
179ef95a346SAndi Gutmans#define add_assoc_long(__arg, __key, __n) add_assoc_long_ex(__arg, __key, strlen(__key)+1, __n)
1800611acb9SAndi Gutmans#define add_assoc_null(__arg, __key) add_assoc_null_ex(__arg, __key, strlen(__key) + 1)
181ef95a346SAndi Gutmans#define add_assoc_bool(__arg, __key, __b) add_assoc_bool_ex(__arg, __key, strlen(__key)+1, __b)
182ef95a346SAndi Gutmans#define add_assoc_resource(__arg, __key, __r) add_assoc_resource_ex(__arg, __key, strlen(__key)+1, __r)
183ef95a346SAndi Gutmans#define add_assoc_double(__arg, __key, __d) add_assoc_double_ex(__arg, __key, strlen(__key)+1, __d)
184ef95a346SAndi Gutmans#define add_assoc_string(__arg, __key, __str, __duplicate) add_assoc_string_ex(__arg, __key, strlen(__key)+1, __str, __duplicate)
185ef95a346SAndi Gutmans#define add_assoc_stringl(__arg, __key, __str, __length, __duplicate) add_assoc_stringl_ex(__arg, __key, strlen(__key)+1, __str, __length, __duplicate)
186ef95a346SAndi Gutmans#define add_assoc_zval(__arg, __key, __value) add_assoc_zval_ex(__arg, __key, strlen(__key)+1, __value)
1876847fefaSThies C. Arntzen
1880611acb9SAndi Gutmans/* unset() functions are only suported for legacy modules and null() functions should be used */
1890611acb9SAndi Gutmans#define add_assoc_unset(__arg, __key) add_assoc_null_ex(__arg, __key, strlen(__key) + 1)
1900611acb9SAndi Gutmans#define add_index_unset(__arg, __key) add_index_null(__arg, __key)
1910611acb9SAndi Gutmans#define add_next_index_unset(__arg) add_next_index_null(__arg)
1920611acb9SAndi Gutmans#define add_property_unset(__arg, __key) add_property_null(__arg, __key)
1930611acb9SAndi Gutmans
194573b4602SAndi GutmansZEND_API int add_index_long(zval *arg, uint idx, long n);
1950611acb9SAndi GutmansZEND_API int add_index_null(zval *arg, uint idx);
1966847fefaSThies C. ArntzenZEND_API int add_index_bool(zval *arg, uint idx, int b);
1976847fefaSThies C. ArntzenZEND_API int add_index_resource(zval *arg, uint idx, int r);
198573b4602SAndi GutmansZEND_API int add_index_double(zval *arg, uint idx, double d);
199573b4602SAndi GutmansZEND_API int add_index_string(zval *arg, uint idx, char *str, int duplicate);
200573b4602SAndi GutmansZEND_API int add_index_stringl(zval *arg, uint idx, char *str, uint length, int duplicate);
20157f99633SAndrei ZmievskiZEND_API int add_index_zval(zval *arg, uint index, zval *value);
2026847fefaSThies C. Arntzen
203573b4602SAndi GutmansZEND_API int add_next_index_long(zval *arg, long n);
2040611acb9SAndi GutmansZEND_API int add_next_index_null(zval *arg);
2056847fefaSThies C. ArntzenZEND_API int add_next_index_bool(zval *arg, int b);
2066847fefaSThies C. ArntzenZEND_API int add_next_index_resource(zval *arg, int r);
207573b4602SAndi GutmansZEND_API int add_next_index_double(zval *arg, double d);
208573b4602SAndi GutmansZEND_API int add_next_index_string(zval *arg, char *str, int duplicate);
209573b4602SAndi GutmansZEND_API int add_next_index_stringl(zval *arg, char *str, uint length, int duplicate);
210ef95a346SAndi GutmansZEND_API int add_next_index_zval(zval *arg, zval *value);
211ef95a346SAndi Gutmans
212ef95a346SAndi GutmansZEND_API int add_get_assoc_string_ex(zval *arg, char *key, uint key_len, char *str, void **dest, int duplicate);
213ef95a346SAndi GutmansZEND_API int add_get_assoc_stringl_ex(zval *arg, char *key, uint key_len, char *str, uint length, void **dest, int duplicate);
214ef95a346SAndi Gutmans
215ef95a346SAndi Gutmans#define add_get_assoc_string(__arg, __key, __str, __dest, __duplicate) add_get_assoc_string_ex(__arg, __key, strlen(__key)+1, __str, __dest, __duplicate)
216ef95a346SAndi 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)
217573b4602SAndi Gutmans
218573b4602SAndi GutmansZEND_API int add_get_index_long(zval *arg, uint idx, long l, void **dest);
219573b4602SAndi GutmansZEND_API int add_get_index_double(zval *arg, uint idx, double d, void **dest);
220573b4602SAndi GutmansZEND_API int add_get_index_string(zval *arg, uint idx, char *str, void **dest, int duplicate);
221573b4602SAndi GutmansZEND_API int add_get_index_stringl(zval *arg, uint idx, char *str, uint length, void **dest, int duplicate);
222573b4602SAndi Gutmans
223ef95a346SAndi GutmansZEND_API int add_property_long_ex(zval *arg, char *key, uint key_len, long l);
2240611acb9SAndi GutmansZEND_API int add_property_null_ex(zval *arg, char *key, uint key_len);
225ef95a346SAndi GutmansZEND_API int add_property_bool_ex(zval *arg, char *key, uint key_len, int b);
226ef95a346SAndi GutmansZEND_API int add_property_resource_ex(zval *arg, char *key, uint key_len, long r);
227ef95a346SAndi GutmansZEND_API int add_property_double_ex(zval *arg, char *key, uint key_len, double d);
228ef95a346SAndi GutmansZEND_API int add_property_string_ex(zval *arg, char *key, uint key_len, char *str, int duplicate);
229ef95a346SAndi GutmansZEND_API int add_property_stringl_ex(zval *arg, char *key, uint key_len,  char *str, uint length, int duplicate);
230ef95a346SAndi GutmansZEND_API int add_property_zval_ex(zval *arg, char *key, uint key_len, zval *value);
231ef95a346SAndi Gutmans
232ef95a346SAndi Gutmans#define add_property_long(__arg, __key, __n) add_property_long_ex(__arg, __key, strlen(__key)+1, __n)
2330611acb9SAndi Gutmans#define add_property_null(__arg, __key) add_property_null_ex(__arg, __key, strlen(__key) + 1)
234ef95a346SAndi Gutmans#define add_property_bool(__arg, __key, __b) add_property_bool_ex(__arg, __key, strlen(__key)+1, __b)
235ef95a346SAndi Gutmans#define add_property_resource(__arg, __key, __r) add_property_resource_ex(__arg, __key, strlen(__key)+1, __r)
236ef95a346SAndi Gutmans#define add_property_double(__arg, __key, __d) add_property_double_ex(__arg, __key, strlen(__key)+1, __d)
237ef95a346SAndi Gutmans#define add_property_string(__arg, __key, __str, __duplicate) add_property_string_ex(__arg, __key, strlen(__key)+1, __str, __duplicate)
238ef95a346SAndi Gutmans#define add_property_stringl(__arg, __key, __str, __length, __duplicate) add_property_stringl_ex(__arg, __key, strlen(__key)+1, __str, __length, __duplicate)
239ef95a346SAndi Gutmans#define add_property_zval(__arg, __key, __value) add_property_zval_ex(__arg, __key, strlen(__key)+1, __value)
240ef95a346SAndi Gutmans
2414187439cSZeev 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);
2424187439cSZeev 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);
243573b4602SAndi Gutmans
244f962a35dSAndrei ZmievskiZEND_API int zend_set_hash_symbol(zval *symbol, char *name, int name_length,
24551e797f1SHarald Radi                                  zend_bool is_ref, int num_symbol_tables, ...);
246f962a35dSAndrei Zmievski
2474f6c95d1SZeev Suraski#define add_method(arg, key, method)	add_assoc_function((arg), (key), (method))
248573b4602SAndi Gutmans
249a35c61afSAndrei ZmievskiZEND_API ZEND_FUNCTION(display_disabled_function);
250a35c61afSAndrei Zmievski
251bcddfd47SThies C. Arntzen#if ZEND_DEBUG
252bcddfd47SThies C. Arntzen#define CHECK_ZVAL_STRING(z) \
25343ebb868SZeev 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);
25443ebb868SZeev Suraski#define CHECK_ZVAL_STRING_REL(z) \
25543ebb868SZeev 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);
256bcddfd47SThies C. Arntzen#else
257bcddfd47SThies C. Arntzen#define CHECK_ZVAL_STRING(z)
25843ebb868SZeev Suraski#define CHECK_ZVAL_STRING_REL(z)
259bcddfd47SThies C. Arntzen#endif
260bcddfd47SThies C. Arntzen
2614f6c95d1SZeev Suraski#define ZVAL_RESOURCE(z, l) {			\
262af22085cSThies C. Arntzen		(z)->type = IS_RESOURCE;        \
263af22085cSThies C. Arntzen		(z)->value.lval = l;	        \
264af22085cSThies C. Arntzen	}
265bcddfd47SThies C. Arntzen
2664f6c95d1SZeev Suraski#define ZVAL_BOOL(z, b) {				\
267af22085cSThies C. Arntzen		(z)->type = IS_BOOL;	        \
268af22085cSThies C. Arntzen		(z)->value.lval = b;	        \
269af22085cSThies C. Arntzen	}
270bcddfd47SThies C. Arntzen
271af22085cSThies C. Arntzen#define ZVAL_NULL(z) {					\
272af22085cSThies C. Arntzen		(z)->type = IS_NULL;	        \
273af22085cSThies C. Arntzen	}
274bcddfd47SThies C. Arntzen
2754f6c95d1SZeev Suraski#define ZVAL_LONG(z, l) {				\
276af22085cSThies C. Arntzen		(z)->type = IS_LONG;	        \
277af22085cSThies C. Arntzen		(z)->value.lval = l;	        \
278af22085cSThies C. Arntzen	}
279bcddfd47SThies C. Arntzen
2804f6c95d1SZeev Suraski#define ZVAL_DOUBLE(z, d) {				\
281af22085cSThies C. Arntzen		(z)->type = IS_DOUBLE;	        \
282af22085cSThies C. Arntzen		(z)->value.dval = d;	        \
283af22085cSThies C. Arntzen	}
284bcddfd47SThies C. Arntzen
2854f6c95d1SZeev Suraski#define ZVAL_STRING(z, s, duplicate) {	\
286af22085cSThies C. Arntzen		char *__s=(s);					\
287af22085cSThies C. Arntzen		(z)->value.str.len = strlen(__s);	\
2884f6c95d1SZeev Suraski		(z)->value.str.val = (duplicate?estrndup(__s, (z)->value.str.len):__s);	\
289af22085cSThies C. Arntzen		(z)->type = IS_STRING;	        \
290af22085cSThies C. Arntzen	}
291bcddfd47SThies C. Arntzen
2924f6c95d1SZeev Suraski#define ZVAL_STRINGL(z, s, l, duplicate) {	\
293af22085cSThies C. Arntzen		char *__s=(s); int __l=l;		\
294af22085cSThies C. Arntzen		(z)->value.str.len = __l;	    \
2954f6c95d1SZeev Suraski		(z)->value.str.val = (duplicate?estrndup(__s, __l):__s);	\
296af22085cSThies C. Arntzen		(z)->type = IS_STRING;		    \
297af22085cSThies C. Arntzen	}
298af22085cSThies C. Arntzen
299af22085cSThies C. Arntzen#define ZVAL_EMPTY_STRING(z) {	        \
300af22085cSThies C. Arntzen		(z)->value.str.len = 0;  	    \
3011f793fd0SStanislav Malyshev		(z)->value.str.val = empty_string; \
302af22085cSThies C. Arntzen		(z)->type = IS_STRING;		    \
303af22085cSThies C. Arntzen	}
304af22085cSThies C. Arntzen
3054f6c95d1SZeev Suraski#define ZVAL_FALSE(z)  					ZVAL_BOOL(z, 0)
3064f6c95d1SZeev Suraski#define ZVAL_TRUE(z)  					ZVAL_BOOL(z, 1)
307af22085cSThies C. Arntzen
3084f6c95d1SZeev Suraski#define RETVAL_RESOURCE(l)				ZVAL_RESOURCE(return_value, l)
3094f6c95d1SZeev Suraski#define RETVAL_BOOL(b)					ZVAL_BOOL(return_value, b)
310bcddfd47SThies C. Arntzen#define RETVAL_NULL() 					ZVAL_NULL(return_value)
3114f6c95d1SZeev Suraski#define RETVAL_LONG(l) 					ZVAL_LONG(return_value, l)
3124f6c95d1SZeev Suraski#define RETVAL_DOUBLE(d) 				ZVAL_DOUBLE(return_value, d)
3134f6c95d1SZeev Suraski#define RETVAL_STRING(s, duplicate) 		ZVAL_STRING(return_value, s, duplicate)
3144f6c95d1SZeev Suraski#define RETVAL_STRINGL(s, l, duplicate) 	ZVAL_STRINGL(return_value, s, l, duplicate)
315bcddfd47SThies C. Arntzen#define RETVAL_EMPTY_STRING() 			ZVAL_EMPTY_STRING(return_value)
3164f6c95d1SZeev Suraski#define RETVAL_FALSE  					ZVAL_BOOL(return_value, 0)
3174f6c95d1SZeev Suraski#define RETVAL_TRUE   					ZVAL_BOOL(return_value, 1)
318bcddfd47SThies C. Arntzen
319bcddfd47SThies C. Arntzen#define RETURN_RESOURCE(l) 				{ RETVAL_RESOURCE(l); return; }
320bcddfd47SThies C. Arntzen#define RETURN_BOOL(b) 					{ RETVAL_BOOL(b); return; }
321bcddfd47SThies C. Arntzen#define RETURN_NULL() 					{ RETVAL_NULL(); return;}
322bcddfd47SThies C. Arntzen#define RETURN_LONG(l) 					{ RETVAL_LONG(l); return; }
323bcddfd47SThies C. Arntzen#define RETURN_DOUBLE(d) 				{ RETVAL_DOUBLE(d); return; }
3244f6c95d1SZeev Suraski#define RETURN_STRING(s, duplicate) 	{ RETVAL_STRING(s, duplicate); return; }
3254f6c95d1SZeev Suraski#define RETURN_STRINGL(s, l, duplicate) { RETVAL_STRINGL(s, l, duplicate); return; }
326bcddfd47SThies C. Arntzen#define RETURN_EMPTY_STRING() 			{ RETVAL_EMPTY_STRING(); return; }
327bcddfd47SThies C. Arntzen#define RETURN_FALSE  					{ RETVAL_FALSE; return; }
328bcddfd47SThies C. Arntzen#define RETURN_TRUE   					{ RETVAL_TRUE; return; }
3291f985edeSZeev Suraski
3304f6c95d1SZeev Suraski#define SET_VAR_STRING(n, v) {																				\
33148ffdd79SZeev Suraski								{																			\
332235386b2SZeev Suraski									zval *var;																\
333235386b2SZeev Suraski									ALLOC_ZVAL(var);														\
3344f6c95d1SZeev Suraski									ZVAL_STRING(var, v, 0);													\
3356393ab14SZeev Suraski									ZEND_SET_GLOBAL_VAR(n, var);											\
33648ffdd79SZeev Suraski								}																			\
3371f985edeSZeev Suraski							}
33848ffdd79SZeev Suraski
3394f6c95d1SZeev Suraski#define SET_VAR_STRINGL(n, v, l) {														\
34048ffdd79SZeev Suraski									{													\
341235386b2SZeev Suraski										zval *var;										\
342235386b2SZeev Suraski										ALLOC_ZVAL(var);								\
3434f6c95d1SZeev Suraski										ZVAL_STRINGL(var, v, l, 0);						\
34448ffdd79SZeev Suraski										ZEND_SET_GLOBAL_VAR(n, var);					\
34548ffdd79SZeev Suraski									}													\
3461f985edeSZeev Suraski								}
34748ffdd79SZeev Suraski
3484f6c95d1SZeev Suraski#define SET_VAR_LONG(n, v)	{															\
34948ffdd79SZeev Suraski								{														\
350235386b2SZeev Suraski									zval *var;											\
351235386b2SZeev Suraski									ALLOC_ZVAL(var);									\
3524f6c95d1SZeev Suraski									ZVAL_LONG(var, v);									\
35348ffdd79SZeev Suraski									ZEND_SET_GLOBAL_VAR(n, var);						\
35448ffdd79SZeev Suraski								}														\
3551f985edeSZeev Suraski							}
35648ffdd79SZeev Suraski
3574f6c95d1SZeev Suraski#define SET_VAR_DOUBLE(n, v) {															\
35848ffdd79SZeev Suraski								{														\
359235386b2SZeev Suraski									zval *var;											\
360235386b2SZeev Suraski									ALLOC_ZVAL(var);									\
3614f6c95d1SZeev Suraski									ZVAL_DOUBLE(var, v);								\
36248ffdd79SZeev Suraski									ZEND_SET_GLOBAL_VAR(n, var);						\
36348ffdd79SZeev Suraski								}														\
3641f985edeSZeev Suraski							}
3651f985edeSZeev Suraski
3661f985edeSZeev Suraski
367c34560b5SAndi Gutmans#define ZEND_SET_SYMBOL(symtable, name, var)										\
368c34560b5SAndi Gutmans	{																				\
369c34560b5SAndi Gutmans		char *_name = (name);														\
370c34560b5SAndi Gutmans																					\
3714c8259b5SAndi Gutmans		ZEND_SET_SYMBOL_WITH_LENGTH(symtable, _name, strlen(_name)+1, var, 1, 0);	\
37248ffdd79SZeev Suraski	}
37348ffdd79SZeev Suraski
374c34560b5SAndi Gutmans#define ZEND_SET_SYMBOL_WITH_LENGTH(symtable, name, name_length, var, _refcount, _is_ref)				\
37548ffdd79SZeev Suraski	{																									\
37648ffdd79SZeev Suraski		zval **orig_var;																				\
37748ffdd79SZeev Suraski																										\
378620d0134SZeev Suraski		if (zend_hash_find(symtable, (name), (name_length), (void **) &orig_var)==SUCCESS				\
37948ffdd79SZeev Suraski			&& PZVAL_IS_REF(*orig_var)) {																\
380158088caSZeev Suraski			(var)->refcount = (*orig_var)->refcount;													\
38152a30fd2SAndrei Zmievski			(var)->is_ref = 1;																			\
38248ffdd79SZeev Suraski																										\
3832ddc4fe4SZeev Suraski			if (_refcount) {																			\
3842ddc4fe4SZeev Suraski				(var)->refcount += _refcount-1;															\
3852ddc4fe4SZeev Suraski			}																							\
38648ffdd79SZeev Suraski			zval_dtor(*orig_var);																		\
387158088caSZeev Suraski			**orig_var = *(var);																		\
38862b2087aSAndi Gutmans			FREE_ZVAL(var);																					\
38948ffdd79SZeev Suraski		} else {																						\
3902f5efbdeSAndi Gutmans			(var)->is_ref = _is_ref;																	\
391158088caSZeev Suraski			if (_refcount) {																			\
392158088caSZeev Suraski				(var)->refcount = _refcount;															\
393158088caSZeev Suraski			}																							\
394158088caSZeev Suraski			zend_hash_update(symtable, (name), (name_length), &(var), sizeof(zval *), NULL);			\
39548ffdd79SZeev Suraski		}																								\
39648ffdd79SZeev Suraski	}
39748ffdd79SZeev Suraski
398620d0134SZeev Suraski
399620d0134SZeev Suraski#define ZEND_SET_GLOBAL_VAR(name, var)				\
400620d0134SZeev Suraski	ZEND_SET_SYMBOL(&EG(symbol_table), name, var)
401620d0134SZeev Suraski
402e3450661SAndrei Zmievski#define ZEND_SET_GLOBAL_VAR_WITH_LENGTH(name, name_length, var, _refcount, _is_ref)		\
403e3450661SAndrei Zmievski	ZEND_SET_SYMBOL_WITH_LENGTH(&EG(symbol_table), name, name_length, var, _refcount, _is_ref)
404fec413c5SAndrei Zmievski
4056608f073SStanislav 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)))
406af22085cSThies C. Arntzen#define ZVAL_IS_NULL(z) ((z)->type==IS_NULL)
40706a18f16SAndi Gutmans
4088b6f848cSAndi Gutmans/* For compatibility */
4098b6f848cSAndi Gutmans#define ZEND_MINIT			ZEND_MODULE_STARTUP_N
4108b6f848cSAndi Gutmans#define ZEND_MSHUTDOWN		ZEND_MODULE_SHUTDOWN_N
4118b6f848cSAndi Gutmans#define ZEND_RINIT			ZEND_MODULE_ACTIVATE_N
4128b6f848cSAndi Gutmans#define ZEND_RSHUTDOWN		ZEND_MODULE_DEACTIVATE_N
4138b6f848cSAndi Gutmans#define ZEND_MINFO			ZEND_MODULE_INFO_N
4148b6f848cSAndi Gutmans
4158b6f848cSAndi Gutmans#define ZEND_MINIT_FUNCTION			ZEND_MODULE_STARTUP_D
416f5c59863SStanislav Malyshev#define ZEND_MSHUTDOWN_FUNCTION		ZEND_MODULE_SHUTDOWN_D
417f5c59863SStanislav Malyshev#define ZEND_RINIT_FUNCTION			ZEND_MODULE_ACTIVATE_D
418f5c59863SStanislav Malyshev#define ZEND_RSHUTDOWN_FUNCTION		ZEND_MODULE_DEACTIVATE_D
419f5c59863SStanislav Malyshev#define ZEND_MINFO_FUNCTION			ZEND_MODULE_INFO_D
4208b6f848cSAndi Gutmans
4210450ab94SZeev SuraskiEND_EXTERN_C()
4220450ab94SZeev Suraski
423b982307dSSascha Schumann#endif /* ZEND_API_H */
424573b4602SAndi Gutmans
4258b6f848cSAndi Gutmans
426573b4602SAndi Gutmans/*
427573b4602SAndi Gutmans * Local variables:
428573b4602SAndi Gutmans * tab-width: 4
429573b4602SAndi Gutmans * c-basic-offset: 4
430573b4602SAndi Gutmans * End:
431573b4602SAndi Gutmans */
432