zend_API.h revision c4528f82
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 | 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 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() 358b6f848cSAndi Gutmans#define ZEND_FN(name) zif_##name 36342c6e0bSZeev Suraski#define ZEND_NAMED_FUNCTION(name) void name(INTERNAL_FUNCTION_PARAMETERS) 37e9d126a7SAndi Gutmans#define ZEND_FUNCTION(name) ZEND_NAMED_FUNCTION(ZEND_FN(name)) 38e9d126a7SAndi Gutmans 39e9d126a7SAndi Gutmans#define ZEND_NAMED_FE(zend_name, name, arg_types) { #zend_name, name, arg_types }, 40e9d126a7SAndi Gutmans#define ZEND_FE(name, arg_types) ZEND_NAMED_FE(name, ZEND_FN(name), arg_types) 41e9d126a7SAndi Gutmans#define ZEND_FALIAS(name, alias, arg_types) ZEND_NAMED_FE(name, ZEND_FN(alias), arg_types) 4261edd1bfSAndi Gutmans#define ZEND_STATIC_FE(name, impl_name, arg_types) { name, impl_name, arg_types }, 43342c6e0bSZeev Suraski 448b6f848cSAndi Gutmans/* Name macros */ 458b6f848cSAndi Gutmans#define ZEND_MODULE_STARTUP_N(module) zm_startup_##module 468b6f848cSAndi Gutmans#define ZEND_MODULE_SHUTDOWN_N(module) zm_shutdown_##module 478b6f848cSAndi Gutmans#define ZEND_MODULE_ACTIVATE_N(module) zm_activate_##module 488b6f848cSAndi Gutmans#define ZEND_MODULE_DEACTIVATE_N(module) zm_deactivate_##module 498b6f848cSAndi Gutmans#define ZEND_MODULE_INFO_N(module) zm_info_##module 50342c6e0bSZeev Suraski 518b6f848cSAndi Gutmans/* Declaration macros */ 528b6f848cSAndi Gutmans#define ZEND_MODULE_STARTUP_D(module) int ZEND_MODULE_STARTUP_N(module)(INIT_FUNC_ARGS) 538b6f848cSAndi Gutmans#define ZEND_MODULE_SHUTDOWN_D(module) int ZEND_MODULE_SHUTDOWN_N(module)(SHUTDOWN_FUNC_ARGS) 548b6f848cSAndi Gutmans#define ZEND_MODULE_ACTIVATE_D(module) int ZEND_MODULE_ACTIVATE_N(module)(INIT_FUNC_ARGS) 558b6f848cSAndi Gutmans#define ZEND_MODULE_DEACTIVATE_D(module) int ZEND_MODULE_DEACTIVATE_N(module)(SHUTDOWN_FUNC_ARGS) 568b6f848cSAndi Gutmans#define ZEND_MODULE_INFO_D(module) void ZEND_MODULE_INFO_N(module)(ZEND_MODULE_INFO_FUNC_ARGS) 57342c6e0bSZeev Suraski 580b6d923bSSascha Schumann#define ZEND_GET_MODULE(name) \ 590b6d923bSSascha Schumann ZEND_DLEXPORT zend_module_entry *get_module(void) { return &name##_module_entry; } 600d21940dSZeev Suraski 610d21940dSZeev Suraski#define ZEND_BEGIN_MODULE_GLOBALS(module_name) \ 620d21940dSZeev Suraski typedef struct _zend_##module_name##_globals { 630d21940dSZeev Suraski#define ZEND_END_MODULE_GLOBALS(module_name) \ 640d21940dSZeev Suraski } zend_##module_name##_globals; 650d21940dSZeev Suraski 660d21940dSZeev Suraski#ifdef ZTS 670d21940dSZeev Suraski 680d21940dSZeev Suraski#define ZEND_DECLARE_MODULE_GLOBALS(module_name) \ 6902af513cSAndi Gutmans ts_rsrc_id module_name##_globals_id; 7002af513cSAndi Gutmans#define ZEND_EXTERN_MODULE_GLOBALS(module_name) \ 7102af513cSAndi Gutmans extern ts_rsrc_id module_name##_globals_id; 720d21940dSZeev Suraski#define ZEND_INIT_MODULE_GLOBALS(module_name, globals_ctor, globals_dtor) \ 732c254ba7SZeev Suraski ts_allocate_id(&module_name##_globals_id, sizeof(zend_##module_name##_globals), (ts_allocate_ctor) globals_ctor, (ts_allocate_dtor) globals_dtor); 740d21940dSZeev Suraski 750d21940dSZeev Suraski#else 760d21940dSZeev Suraski 770d21940dSZeev Suraski#define ZEND_DECLARE_MODULE_GLOBALS(module_name) \ 7802af513cSAndi Gutmans zend_##module_name##_globals module_name##_globals; 7902af513cSAndi Gutmans#define ZEND_EXTERN_MODULE_GLOBALS(module_name) \ 8002af513cSAndi Gutmans extern zend_##module_name##_globals module_name##_globals; 810d21940dSZeev Suraski#define ZEND_INIT_MODULE_GLOBALS(module_name, globals_ctor, globals_dtor) \ 820d21940dSZeev Suraski globals_ctor(&module_name##_globals); 830d21940dSZeev Suraski 840d21940dSZeev Suraski#endif 850d21940dSZeev Suraski 860d21940dSZeev Suraski 870d21940dSZeev Suraski 883738a6edSHarald Radi#define INIT_CLASS_ENTRY(class_container, class_name, functions) INIT_OVERLOADED_CLASS_ENTRY(class_container, class_name, functions, NULL, NULL, NULL) 89741b8161SZeev Suraski 90741b8161SZeev Suraski#define INIT_OVERLOADED_CLASS_ENTRY(class_container, class_name, functions, handle_fcall, handle_propget, handle_propset) \ 91741b8161SZeev Suraski { \ 92741b8161SZeev Suraski class_container.name = strdup(class_name); \ 93741b8161SZeev Suraski class_container.name_length = sizeof(class_name)-1; \ 94741b8161SZeev Suraski class_container.builtin_functions = functions; \ 952eccd95cSAndi Gutmans class_container.constructor = NULL; \ 9673b159e0SAndi Gutmans class_container.destructor = NULL; \ 9729ea3da2SAndi Gutmans class_container.clone = NULL; \ 986608f073SStanislav Malyshev class_container.create_object = NULL; \ 992ae8d124SStanislav Malyshev class_container.__call = handle_fcall; \ 1002ae8d124SStanislav Malyshev class_container.__get = handle_propget; \ 1012ae8d124SStanislav Malyshev class_container.__set = handle_propset; \ 102741b8161SZeev Suraski } 103741b8161SZeev Suraski 104741b8161SZeev Suraski 105741b8161SZeev Suraski 106573b4602SAndi Gutmansint zend_next_free_module(void); 107573b4602SAndi Gutmans 108f77e6a44SZeev SuraskiZEND_API int zend_get_parameters(int ht, int param_count, ...); 10911e5d2f2SZeev SuraskiZEND_API int _zend_get_parameters_array(int ht, int param_count, zval **argument_array TSRMLS_DC); 110f77e6a44SZeev SuraskiZEND_API int zend_get_parameters_ex(int param_count, ...); 11111e5d2f2SZeev SuraskiZEND_API int _zend_get_parameters_array_ex(int param_count, zval ***argument_array TSRMLS_DC); 11211e5d2f2SZeev Suraski 11311e5d2f2SZeev Suraski#define zend_get_parameters_array(ht, param_count, argument_array) \ 11411e5d2f2SZeev Suraski _zend_get_parameters_array(ht, param_count, argument_array TSRMLS_CC) 11511e5d2f2SZeev Suraski#define zend_get_parameters_array_ex(param_count, argument_array) \ 11611e5d2f2SZeev Suraski _zend_get_parameters_array_ex(param_count, argument_array TSRMLS_CC) 11739f9487eSAndi Gutmans 11858f88057SAndrei Zmievski 11958f88057SAndrei Zmievski/* Parameter parsing API -- andrei */ 12058f88057SAndrei Zmievski 12158f88057SAndrei Zmievski#define ZEND_PARSE_PARAMS_QUIET 1<<1 1228ce8324eSZeev SuraskiZEND_API int zend_parse_parameters(int num_args TSRMLS_DC, char *type_spec, ...); 1233839af35SAndrei ZmievskiZEND_API int zend_parse_parameters_ex(int flags, int num_args TSRMLS_DC, char *type_spec, ...); 1249b391a83SDerick RethansZEND_API char *zend_zval_type_name(zval *arg); 12558f88057SAndrei Zmievski 126c4528f82SHarald RadiZEND_API int zend_parse_method_parameters(int num_args TSRMLS_DC, zval *this_ptr, char *type_spec, zend_class_entry *ce, void **object, ...); 127c4528f82SHarald 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, ...); 128c4528f82SHarald Radi 129b5255495SZeev Suraski/* End of parameter parsing API -- andrei */ 13039f9487eSAndi Gutmans 131e8214a33SAndi Gutmansint zend_register_functions(zend_class_entry *scope, zend_function_entry *functions, HashTable *function_table, int type TSRMLS_DC); 132b5770382SZeev Suraskivoid zend_unregister_functions(zend_function_entry *functions, int count, HashTable *function_table TSRMLS_DC); 1337a87fcbbSZeev SuraskiZEND_API int zend_register_module(zend_module_entry *module_entry); 134eb0e6946SAndi Gutmans 135b5770382SZeev SuraskiZEND_API zend_class_entry *zend_register_internal_class(zend_class_entry *class_entry TSRMLS_DC); 136b5770382SZeev 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); 137eb0e6946SAndi Gutmans 138bfbe8618SZeev SuraskiZEND_API zend_module_entry *zend_get_module(int module_number); 139d76cf1daSZeev SuraskiZEND_API int zend_disable_function(char *function_name, uint function_name_length TSRMLS_DC); 140573b4602SAndi Gutmans 1414187439cSZeev SuraskiZEND_API void zend_wrong_param_count(TSRMLS_D); 14213148b54SAndrei ZmievskiZEND_API zend_bool zend_is_callable(zval *callable, zend_bool syntax_only, char **callable_name); 14301850714SSebastian BergmannZEND_API char *zend_get_module_version(char *module_name); 144573b4602SAndi Gutmans 1457a067547SStanislav MalyshevZEND_API zend_class_entry *zend_get_class_entry(zval *zobject); 1466ac6cb10SHarald Radi 147741b8161SZeev Suraski#define getThis() (this_ptr) 148741b8161SZeev Suraski 149131d9cb2SZeev Suraski#define WRONG_PARAM_COUNT ZEND_WRONG_PARAM_COUNT() 150131d9cb2SZeev Suraski#define WRONG_PARAM_COUNT_WITH_RETVAL(ret) ZEND_WRONG_PARAM_COUNT_WITH_RETVAL(ret) 151a1ad2872SZeev Suraski#define ARG_COUNT(dummy) (ht) 152a1ad2872SZeev Suraski#define ZEND_NUM_ARGS() (ht) 1534187439cSZeev Suraski#define ZEND_WRONG_PARAM_COUNT() { zend_wrong_param_count(TSRMLS_C); return; } 1544187439cSZeev Suraski#define ZEND_WRONG_PARAM_COUNT_WITH_RETVAL(ret) { zend_wrong_param_count(TSRMLS_C); return ret; } 155573b4602SAndi Gutmans 15680bdd19eSZeev Suraski#ifndef ZEND_WIN32 157573b4602SAndi Gutmans#define DLEXPORT 158573b4602SAndi Gutmans#endif 159573b4602SAndi Gutmans 160e0628436SAndrei ZmievskiZEND_API int zend_startup_module(zend_module_entry *module); 161573b4602SAndi Gutmans 162ceba50b6SZeev Suraski#define array_init(arg) _array_init((arg) ZEND_FILE_LINE_CC) 163fcc03510SZeev Suraski#define object_init(arg) _object_init((arg) ZEND_FILE_LINE_CC TSRMLS_CC) 164fcc03510SZeev Suraski#define object_init_ex(arg, ce) _object_init_ex((arg), (ce) ZEND_FILE_LINE_CC TSRMLS_CC) 16576a7a5bcSAndi Gutmans#define object_and_properties_init(arg, ce, properties) _object_and_properties_init((arg), (ce), (properties) ZEND_FILE_LINE_CC TSRMLS_CC) 166ceba50b6SZeev SuraskiZEND_API int _array_init(zval *arg ZEND_FILE_LINE_DC); 167fcc03510SZeev SuraskiZEND_API int _object_init(zval *arg ZEND_FILE_LINE_DC TSRMLS_DC); 168fcc03510SZeev SuraskiZEND_API int _object_init_ex(zval *arg, zend_class_entry *ce ZEND_FILE_LINE_DC TSRMLS_DC); 16976a7a5bcSAndi GutmansZEND_API int _object_and_properties_init(zval *arg, zend_class_entry *ce, HashTable *properties ZEND_FILE_LINE_DC TSRMLS_DC); 1706847fefaSThies C. Arntzen 1716847fefaSThies C. Arntzen/* no longer supported */ 1724f6c95d1SZeev SuraskiZEND_API int add_assoc_function(zval *arg, char *key, void (*function_ptr)(INTERNAL_FUNCTION_PARAMETERS)); 1736847fefaSThies C. Arntzen 174ef95a346SAndi GutmansZEND_API int add_assoc_long_ex(zval *arg, char *key, uint key_len, long n); 1750611acb9SAndi GutmansZEND_API int add_assoc_null_ex(zval *arg, char *key, uint key_len); 176ef95a346SAndi GutmansZEND_API int add_assoc_bool_ex(zval *arg, char *key, uint key_len, int b); 177ef95a346SAndi GutmansZEND_API int add_assoc_resource_ex(zval *arg, char *key, uint key_len, int r); 178ef95a346SAndi GutmansZEND_API int add_assoc_double_ex(zval *arg, char *key, uint key_len, double d); 179ef95a346SAndi GutmansZEND_API int add_assoc_string_ex(zval *arg, char *key, uint key_len, char *str, int duplicate); 180ef95a346SAndi GutmansZEND_API int add_assoc_stringl_ex(zval *arg, char *key, uint key_len, char *str, uint length, int duplicate); 181ef95a346SAndi GutmansZEND_API int add_assoc_zval_ex(zval *arg, char *key, uint key_len, zval *value); 182ef95a346SAndi Gutmans 183ef95a346SAndi Gutmans#define add_assoc_long(__arg, __key, __n) add_assoc_long_ex(__arg, __key, strlen(__key)+1, __n) 1840611acb9SAndi Gutmans#define add_assoc_null(__arg, __key) add_assoc_null_ex(__arg, __key, strlen(__key) + 1) 185ef95a346SAndi Gutmans#define add_assoc_bool(__arg, __key, __b) add_assoc_bool_ex(__arg, __key, strlen(__key)+1, __b) 186ef95a346SAndi Gutmans#define add_assoc_resource(__arg, __key, __r) add_assoc_resource_ex(__arg, __key, strlen(__key)+1, __r) 187ef95a346SAndi Gutmans#define add_assoc_double(__arg, __key, __d) add_assoc_double_ex(__arg, __key, strlen(__key)+1, __d) 188ef95a346SAndi Gutmans#define add_assoc_string(__arg, __key, __str, __duplicate) add_assoc_string_ex(__arg, __key, strlen(__key)+1, __str, __duplicate) 189ef95a346SAndi Gutmans#define add_assoc_stringl(__arg, __key, __str, __length, __duplicate) add_assoc_stringl_ex(__arg, __key, strlen(__key)+1, __str, __length, __duplicate) 190ef95a346SAndi Gutmans#define add_assoc_zval(__arg, __key, __value) add_assoc_zval_ex(__arg, __key, strlen(__key)+1, __value) 1916847fefaSThies C. Arntzen 1920611acb9SAndi Gutmans/* unset() functions are only suported for legacy modules and null() functions should be used */ 1930611acb9SAndi Gutmans#define add_assoc_unset(__arg, __key) add_assoc_null_ex(__arg, __key, strlen(__key) + 1) 1940611acb9SAndi Gutmans#define add_index_unset(__arg, __key) add_index_null(__arg, __key) 1950611acb9SAndi Gutmans#define add_next_index_unset(__arg) add_next_index_null(__arg) 1960611acb9SAndi Gutmans#define add_property_unset(__arg, __key) add_property_null(__arg, __key) 1970611acb9SAndi Gutmans 198573b4602SAndi GutmansZEND_API int add_index_long(zval *arg, uint idx, long n); 1990611acb9SAndi GutmansZEND_API int add_index_null(zval *arg, uint idx); 2006847fefaSThies C. ArntzenZEND_API int add_index_bool(zval *arg, uint idx, int b); 2016847fefaSThies C. ArntzenZEND_API int add_index_resource(zval *arg, uint idx, int r); 202573b4602SAndi GutmansZEND_API int add_index_double(zval *arg, uint idx, double d); 203573b4602SAndi GutmansZEND_API int add_index_string(zval *arg, uint idx, char *str, int duplicate); 204573b4602SAndi GutmansZEND_API int add_index_stringl(zval *arg, uint idx, char *str, uint length, int duplicate); 20557f99633SAndrei ZmievskiZEND_API int add_index_zval(zval *arg, uint index, zval *value); 2066847fefaSThies C. Arntzen 207573b4602SAndi GutmansZEND_API int add_next_index_long(zval *arg, long n); 2080611acb9SAndi GutmansZEND_API int add_next_index_null(zval *arg); 2096847fefaSThies C. ArntzenZEND_API int add_next_index_bool(zval *arg, int b); 2106847fefaSThies C. ArntzenZEND_API int add_next_index_resource(zval *arg, int r); 211573b4602SAndi GutmansZEND_API int add_next_index_double(zval *arg, double d); 212573b4602SAndi GutmansZEND_API int add_next_index_string(zval *arg, char *str, int duplicate); 213573b4602SAndi GutmansZEND_API int add_next_index_stringl(zval *arg, char *str, uint length, int duplicate); 214ef95a346SAndi GutmansZEND_API int add_next_index_zval(zval *arg, zval *value); 215ef95a346SAndi Gutmans 216ef95a346SAndi GutmansZEND_API int add_get_assoc_string_ex(zval *arg, char *key, uint key_len, char *str, void **dest, int duplicate); 217ef95a346SAndi GutmansZEND_API int add_get_assoc_stringl_ex(zval *arg, char *key, uint key_len, char *str, uint length, void **dest, int duplicate); 218ef95a346SAndi Gutmans 219ef95a346SAndi Gutmans#define add_get_assoc_string(__arg, __key, __str, __dest, __duplicate) add_get_assoc_string_ex(__arg, __key, strlen(__key)+1, __str, __dest, __duplicate) 220ef95a346SAndi 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) 221573b4602SAndi Gutmans 222573b4602SAndi GutmansZEND_API int add_get_index_long(zval *arg, uint idx, long l, void **dest); 223573b4602SAndi GutmansZEND_API int add_get_index_double(zval *arg, uint idx, double d, void **dest); 224573b4602SAndi GutmansZEND_API int add_get_index_string(zval *arg, uint idx, char *str, void **dest, int duplicate); 225573b4602SAndi GutmansZEND_API int add_get_index_stringl(zval *arg, uint idx, char *str, uint length, void **dest, int duplicate); 226573b4602SAndi Gutmans 227eccc5368SStanislav MalyshevZEND_API int add_property_long_ex(zval *arg, char *key, uint key_len, long l TSRMLS_DC); 228eccc5368SStanislav MalyshevZEND_API int add_property_null_ex(zval *arg, char *key, uint key_len TSRMLS_DC); 229eccc5368SStanislav MalyshevZEND_API int add_property_bool_ex(zval *arg, char *key, uint key_len, int b TSRMLS_DC); 230eccc5368SStanislav MalyshevZEND_API int add_property_resource_ex(zval *arg, char *key, uint key_len, long r TSRMLS_DC); 231eccc5368SStanislav MalyshevZEND_API int add_property_double_ex(zval *arg, char *key, uint key_len, double d TSRMLS_DC); 232eccc5368SStanislav MalyshevZEND_API int add_property_string_ex(zval *arg, char *key, uint key_len, char *str, int duplicate TSRMLS_DC); 233eccc5368SStanislav MalyshevZEND_API int add_property_stringl_ex(zval *arg, char *key, uint key_len, char *str, uint length, int duplicate TSRMLS_DC); 234eccc5368SStanislav MalyshevZEND_API int add_property_zval_ex(zval *arg, char *key, uint key_len, zval *value TSRMLS_DC); 235eccc5368SStanislav Malyshev 236eccc5368SStanislav Malyshev#define add_property_long(__arg, __key, __n) add_property_long_ex(__arg, __key, strlen(__key)+1, __n TSRMLS_CC) 237eccc5368SStanislav Malyshev#define add_property_null(__arg, __key) add_property_null_ex(__arg, __key, strlen(__key) + 1 TSRMLS_CC) 238eccc5368SStanislav Malyshev#define add_property_bool(__arg, __key, __b) add_property_bool_ex(__arg, __key, strlen(__key)+1, __b TSRMLS_CC) 239eccc5368SStanislav Malyshev#define add_property_resource(__arg, __key, __r) add_property_resource_ex(__arg, __key, strlen(__key)+1, __r TSRMLS_CC) 240eccc5368SStanislav Malyshev#define add_property_double(__arg, __key, __d) add_property_double_ex(__arg, __key, strlen(__key)+1, __d TSRMLS_CC) 241eccc5368SStanislav Malyshev#define add_property_string(__arg, __key, __str, __duplicate) add_property_string_ex(__arg, __key, strlen(__key)+1, __str, __duplicate TSRMLS_CC) 242eccc5368SStanislav Malyshev#define add_property_stringl(__arg, __key, __str, __length, __duplicate) add_property_stringl_ex(__arg, __key, strlen(__key)+1, __str, __length, __duplicate TSRMLS_CC) 243eccc5368SStanislav Malyshev#define add_property_zval(__arg, __key, __value) add_property_zval_ex(__arg, __key, strlen(__key)+1, __value TSRMLS_CC) 244ef95a346SAndi Gutmans 2454187439cSZeev 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); 2464187439cSZeev 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); 247573b4602SAndi Gutmans 248f962a35dSAndrei ZmievskiZEND_API int zend_set_hash_symbol(zval *symbol, char *name, int name_length, 24951e797f1SHarald Radi zend_bool is_ref, int num_symbol_tables, ...); 250f962a35dSAndrei Zmievski 2514f6c95d1SZeev Suraski#define add_method(arg, key, method) add_assoc_function((arg), (key), (method)) 252573b4602SAndi Gutmans 253a35c61afSAndrei ZmievskiZEND_API ZEND_FUNCTION(display_disabled_function); 254a35c61afSAndrei Zmievski 255bcddfd47SThies C. Arntzen#if ZEND_DEBUG 256bcddfd47SThies C. Arntzen#define CHECK_ZVAL_STRING(z) \ 257ace55f32SZeev 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); } 25843ebb868SZeev Suraski#define CHECK_ZVAL_STRING_REL(z) \ 259ace55f32SZeev 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); } 260bcddfd47SThies C. Arntzen#else 261bcddfd47SThies C. Arntzen#define CHECK_ZVAL_STRING(z) 26243ebb868SZeev Suraski#define CHECK_ZVAL_STRING_REL(z) 263bcddfd47SThies C. Arntzen#endif 264bcddfd47SThies C. Arntzen 2654f6c95d1SZeev Suraski#define ZVAL_RESOURCE(z, l) { \ 266af22085cSThies C. Arntzen (z)->type = IS_RESOURCE; \ 267af22085cSThies C. Arntzen (z)->value.lval = l; \ 268af22085cSThies C. Arntzen } 269bcddfd47SThies C. Arntzen 2704f6c95d1SZeev Suraski#define ZVAL_BOOL(z, b) { \ 271af22085cSThies C. Arntzen (z)->type = IS_BOOL; \ 272af22085cSThies C. Arntzen (z)->value.lval = b; \ 273af22085cSThies C. Arntzen } 274bcddfd47SThies C. Arntzen 275af22085cSThies C. Arntzen#define ZVAL_NULL(z) { \ 276af22085cSThies C. Arntzen (z)->type = IS_NULL; \ 277af22085cSThies C. Arntzen } 278bcddfd47SThies C. Arntzen 2794f6c95d1SZeev Suraski#define ZVAL_LONG(z, l) { \ 280af22085cSThies C. Arntzen (z)->type = IS_LONG; \ 281af22085cSThies C. Arntzen (z)->value.lval = l; \ 282af22085cSThies C. Arntzen } 283bcddfd47SThies C. Arntzen 2844f6c95d1SZeev Suraski#define ZVAL_DOUBLE(z, d) { \ 285af22085cSThies C. Arntzen (z)->type = IS_DOUBLE; \ 286af22085cSThies C. Arntzen (z)->value.dval = d; \ 287af22085cSThies C. Arntzen } 288bcddfd47SThies C. Arntzen 2894f6c95d1SZeev Suraski#define ZVAL_STRING(z, s, duplicate) { \ 290af22085cSThies C. Arntzen char *__s=(s); \ 291af22085cSThies C. Arntzen (z)->value.str.len = strlen(__s); \ 2924f6c95d1SZeev Suraski (z)->value.str.val = (duplicate?estrndup(__s, (z)->value.str.len):__s); \ 293af22085cSThies C. Arntzen (z)->type = IS_STRING; \ 294af22085cSThies C. Arntzen } 295bcddfd47SThies C. Arntzen 2964f6c95d1SZeev Suraski#define ZVAL_STRINGL(z, s, l, duplicate) { \ 297af22085cSThies C. Arntzen char *__s=(s); int __l=l; \ 298af22085cSThies C. Arntzen (z)->value.str.len = __l; \ 2994f6c95d1SZeev Suraski (z)->value.str.val = (duplicate?estrndup(__s, __l):__s); \ 300af22085cSThies C. Arntzen (z)->type = IS_STRING; \ 301af22085cSThies C. Arntzen } 302af22085cSThies C. Arntzen 303af22085cSThies C. Arntzen#define ZVAL_EMPTY_STRING(z) { \ 304af22085cSThies C. Arntzen (z)->value.str.len = 0; \ 3051f793fd0SStanislav Malyshev (z)->value.str.val = empty_string; \ 306af22085cSThies C. Arntzen (z)->type = IS_STRING; \ 307af22085cSThies C. Arntzen } 308af22085cSThies C. Arntzen 3094f6c95d1SZeev Suraski#define ZVAL_FALSE(z) ZVAL_BOOL(z, 0) 3104f6c95d1SZeev Suraski#define ZVAL_TRUE(z) ZVAL_BOOL(z, 1) 311af22085cSThies C. Arntzen 3124f6c95d1SZeev Suraski#define RETVAL_RESOURCE(l) ZVAL_RESOURCE(return_value, l) 3134f6c95d1SZeev Suraski#define RETVAL_BOOL(b) ZVAL_BOOL(return_value, b) 314bcddfd47SThies C. Arntzen#define RETVAL_NULL() ZVAL_NULL(return_value) 3154f6c95d1SZeev Suraski#define RETVAL_LONG(l) ZVAL_LONG(return_value, l) 3164f6c95d1SZeev Suraski#define RETVAL_DOUBLE(d) ZVAL_DOUBLE(return_value, d) 3174f6c95d1SZeev Suraski#define RETVAL_STRING(s, duplicate) ZVAL_STRING(return_value, s, duplicate) 3184f6c95d1SZeev Suraski#define RETVAL_STRINGL(s, l, duplicate) ZVAL_STRINGL(return_value, s, l, duplicate) 319bcddfd47SThies C. Arntzen#define RETVAL_EMPTY_STRING() ZVAL_EMPTY_STRING(return_value) 3204f6c95d1SZeev Suraski#define RETVAL_FALSE ZVAL_BOOL(return_value, 0) 3214f6c95d1SZeev Suraski#define RETVAL_TRUE ZVAL_BOOL(return_value, 1) 322bcddfd47SThies C. Arntzen 323bcddfd47SThies C. Arntzen#define RETURN_RESOURCE(l) { RETVAL_RESOURCE(l); return; } 324bcddfd47SThies C. Arntzen#define RETURN_BOOL(b) { RETVAL_BOOL(b); return; } 325bcddfd47SThies C. Arntzen#define RETURN_NULL() { RETVAL_NULL(); return;} 326bcddfd47SThies C. Arntzen#define RETURN_LONG(l) { RETVAL_LONG(l); return; } 327bcddfd47SThies C. Arntzen#define RETURN_DOUBLE(d) { RETVAL_DOUBLE(d); return; } 3284f6c95d1SZeev Suraski#define RETURN_STRING(s, duplicate) { RETVAL_STRING(s, duplicate); return; } 3294f6c95d1SZeev Suraski#define RETURN_STRINGL(s, l, duplicate) { RETVAL_STRINGL(s, l, duplicate); return; } 330bcddfd47SThies C. Arntzen#define RETURN_EMPTY_STRING() { RETVAL_EMPTY_STRING(); return; } 331bcddfd47SThies C. Arntzen#define RETURN_FALSE { RETVAL_FALSE; return; } 332bcddfd47SThies C. Arntzen#define RETURN_TRUE { RETVAL_TRUE; return; } 3331f985edeSZeev Suraski 3344f6c95d1SZeev Suraski#define SET_VAR_STRING(n, v) { \ 33548ffdd79SZeev Suraski { \ 336235386b2SZeev Suraski zval *var; \ 337235386b2SZeev Suraski ALLOC_ZVAL(var); \ 3384f6c95d1SZeev Suraski ZVAL_STRING(var, v, 0); \ 3396393ab14SZeev Suraski ZEND_SET_GLOBAL_VAR(n, var); \ 34048ffdd79SZeev Suraski } \ 3411f985edeSZeev Suraski } 34248ffdd79SZeev Suraski 3434f6c95d1SZeev Suraski#define SET_VAR_STRINGL(n, v, l) { \ 34448ffdd79SZeev Suraski { \ 345235386b2SZeev Suraski zval *var; \ 346235386b2SZeev Suraski ALLOC_ZVAL(var); \ 3474f6c95d1SZeev Suraski ZVAL_STRINGL(var, v, l, 0); \ 34848ffdd79SZeev Suraski ZEND_SET_GLOBAL_VAR(n, var); \ 34948ffdd79SZeev Suraski } \ 3501f985edeSZeev Suraski } 35148ffdd79SZeev Suraski 3524f6c95d1SZeev Suraski#define SET_VAR_LONG(n, v) { \ 35348ffdd79SZeev Suraski { \ 354235386b2SZeev Suraski zval *var; \ 355235386b2SZeev Suraski ALLOC_ZVAL(var); \ 3564f6c95d1SZeev Suraski ZVAL_LONG(var, v); \ 35748ffdd79SZeev Suraski ZEND_SET_GLOBAL_VAR(n, var); \ 35848ffdd79SZeev Suraski } \ 3591f985edeSZeev Suraski } 36048ffdd79SZeev Suraski 3614f6c95d1SZeev Suraski#define SET_VAR_DOUBLE(n, v) { \ 36248ffdd79SZeev Suraski { \ 363235386b2SZeev Suraski zval *var; \ 364235386b2SZeev Suraski ALLOC_ZVAL(var); \ 3654f6c95d1SZeev Suraski ZVAL_DOUBLE(var, v); \ 36648ffdd79SZeev Suraski ZEND_SET_GLOBAL_VAR(n, var); \ 36748ffdd79SZeev Suraski } \ 3681f985edeSZeev Suraski } 3691f985edeSZeev Suraski 3701f985edeSZeev Suraski 371c34560b5SAndi Gutmans#define ZEND_SET_SYMBOL(symtable, name, var) \ 372c34560b5SAndi Gutmans { \ 373c34560b5SAndi Gutmans char *_name = (name); \ 374c34560b5SAndi Gutmans \ 3754c8259b5SAndi Gutmans ZEND_SET_SYMBOL_WITH_LENGTH(symtable, _name, strlen(_name)+1, var, 1, 0); \ 37648ffdd79SZeev Suraski } 37748ffdd79SZeev Suraski 378c34560b5SAndi Gutmans#define ZEND_SET_SYMBOL_WITH_LENGTH(symtable, name, name_length, var, _refcount, _is_ref) \ 37948ffdd79SZeev Suraski { \ 38048ffdd79SZeev Suraski zval **orig_var; \ 38148ffdd79SZeev Suraski \ 382620d0134SZeev Suraski if (zend_hash_find(symtable, (name), (name_length), (void **) &orig_var)==SUCCESS \ 38348ffdd79SZeev Suraski && PZVAL_IS_REF(*orig_var)) { \ 384158088caSZeev Suraski (var)->refcount = (*orig_var)->refcount; \ 38552a30fd2SAndrei Zmievski (var)->is_ref = 1; \ 38648ffdd79SZeev Suraski \ 3872ddc4fe4SZeev Suraski if (_refcount) { \ 3882ddc4fe4SZeev Suraski (var)->refcount += _refcount-1; \ 3892ddc4fe4SZeev Suraski } \ 39048ffdd79SZeev Suraski zval_dtor(*orig_var); \ 391158088caSZeev Suraski **orig_var = *(var); \ 39262b2087aSAndi Gutmans FREE_ZVAL(var); \ 39348ffdd79SZeev Suraski } else { \ 3942f5efbdeSAndi Gutmans (var)->is_ref = _is_ref; \ 395158088caSZeev Suraski if (_refcount) { \ 396158088caSZeev Suraski (var)->refcount = _refcount; \ 397158088caSZeev Suraski } \ 398158088caSZeev Suraski zend_hash_update(symtable, (name), (name_length), &(var), sizeof(zval *), NULL); \ 39948ffdd79SZeev Suraski } \ 40048ffdd79SZeev Suraski } 40148ffdd79SZeev Suraski 402620d0134SZeev Suraski 403620d0134SZeev Suraski#define ZEND_SET_GLOBAL_VAR(name, var) \ 404620d0134SZeev Suraski ZEND_SET_SYMBOL(&EG(symbol_table), name, var) 405620d0134SZeev Suraski 406e3450661SAndrei Zmievski#define ZEND_SET_GLOBAL_VAR_WITH_LENGTH(name, name_length, var, _refcount, _is_ref) \ 407e3450661SAndrei Zmievski ZEND_SET_SYMBOL_WITH_LENGTH(&EG(symbol_table), name, name_length, var, _refcount, _is_ref) 408fec413c5SAndrei Zmievski 4096608f073SStanislav 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))) 410af22085cSThies C. Arntzen#define ZVAL_IS_NULL(z) ((z)->type==IS_NULL) 41106a18f16SAndi Gutmans 4128b6f848cSAndi Gutmans/* For compatibility */ 4138b6f848cSAndi Gutmans#define ZEND_MINIT ZEND_MODULE_STARTUP_N 4148b6f848cSAndi Gutmans#define ZEND_MSHUTDOWN ZEND_MODULE_SHUTDOWN_N 4158b6f848cSAndi Gutmans#define ZEND_RINIT ZEND_MODULE_ACTIVATE_N 4168b6f848cSAndi Gutmans#define ZEND_RSHUTDOWN ZEND_MODULE_DEACTIVATE_N 4178b6f848cSAndi Gutmans#define ZEND_MINFO ZEND_MODULE_INFO_N 4188b6f848cSAndi Gutmans 4198b6f848cSAndi Gutmans#define ZEND_MINIT_FUNCTION ZEND_MODULE_STARTUP_D 420f5c59863SStanislav Malyshev#define ZEND_MSHUTDOWN_FUNCTION ZEND_MODULE_SHUTDOWN_D 421f5c59863SStanislav Malyshev#define ZEND_RINIT_FUNCTION ZEND_MODULE_ACTIVATE_D 422f5c59863SStanislav Malyshev#define ZEND_RSHUTDOWN_FUNCTION ZEND_MODULE_DEACTIVATE_D 423f5c59863SStanislav Malyshev#define ZEND_MINFO_FUNCTION ZEND_MODULE_INFO_D 4248b6f848cSAndi Gutmans 4250450ab94SZeev SuraskiEND_EXTERN_C() 4260450ab94SZeev Suraski 427b982307dSSascha Schumann#endif /* ZEND_API_H */ 428573b4602SAndi Gutmans 4298b6f848cSAndi Gutmans 430573b4602SAndi Gutmans/* 431573b4602SAndi Gutmans * Local variables: 432573b4602SAndi Gutmans * tab-width: 4 433573b4602SAndi Gutmans * c-basic-offset: 4 434333406bdSfoobar * indent-tabs-mode: t 435573b4602SAndi Gutmans * End: 436573b4602SAndi Gutmans */ 437