1 /* 2 +----------------------------------------------------------------------+ 3 | Zend Engine | 4 +----------------------------------------------------------------------+ 5 | Copyright (c) 1998-2013 Zend Technologies Ltd. (http://www.zend.com) | 6 +----------------------------------------------------------------------+ 7 | This source file is subject to version 2.00 of the Zend license, | 8 | that is bundled with this package in the file LICENSE, and is | 9 | available through the world-wide-web at the following url: | 10 | http://www.zend.com/license/2_00.txt. | 11 | If you did not receive a copy of the Zend license and are unable to | 12 | obtain it through the world-wide-web, please send a note to | 13 | license@zend.com so we can mail you a copy immediately. | 14 +----------------------------------------------------------------------+ 15 | Authors: Andi Gutmans <andi@zend.com> | 16 | Zeev Suraski <zeev@zend.com> | 17 +----------------------------------------------------------------------+ 18 */ 19 20 /* $Id$ */ 21 22 #ifndef ZEND_OBJECT_HANDLERS_H 23 #define ZEND_OBJECT_HANDLERS_H 24 25 union _zend_function; 26 struct _zend_property_info; 27 28 /* The following rule applies to read_property() and read_dimension() implementations: 29 If you return a zval which is not otherwise referenced by the extension or the engine's 30 symbol table, its reference count should be 0. 31 */ 32 /* Used to fetch property from the object, read-only */ 33 typedef zval *(*zend_object_read_property_t)(zval *object, zval *member, int type TSRMLS_DC); 34 35 /* Used to fetch dimension from the object, read-only */ 36 typedef zval *(*zend_object_read_dimension_t)(zval *object, zval *offset, int type TSRMLS_DC); 37 38 39 /* The following rule applies to write_property() and write_dimension() implementations: 40 If you receive a value zval in write_property/write_dimension, you may only modify it if 41 its reference count is 1. Otherwise, you must create a copy of that zval before making 42 any changes. You should NOT modify the reference count of the value passed to you. 43 */ 44 /* Used to set property of the object */ 45 typedef void (*zend_object_write_property_t)(zval *object, zval *member, zval *value TSRMLS_DC); 46 47 /* Used to set dimension of the object */ 48 typedef void (*zend_object_write_dimension_t)(zval *object, zval *offset, zval *value TSRMLS_DC); 49 50 51 /* Used to create pointer to the property of the object, for future direct r/w access */ 52 typedef zval **(*zend_object_get_property_ptr_ptr_t)(zval *object, zval *member TSRMLS_DC); 53 54 /* Used to set object value. Can be used to override assignments and scalar 55 write ops (like ++, +=) on the object */ 56 typedef void (*zend_object_set_t)(zval **object, zval *value TSRMLS_DC); 57 58 /* Used to get object value. Can be used when converting object value to 59 * one of the basic types and when using scalar ops (like ++, +=) on the object 60 */ 61 typedef zval* (*zend_object_get_t)(zval *object TSRMLS_DC); 62 63 /* Used to check if a property of the object exists */ 64 /* param has_set_exists: 65 * 0 (has) whether property exists and is not NULL 66 * 1 (set) whether property exists and is true 67 * 2 (exists) whether property exists 68 */ 69 typedef int (*zend_object_has_property_t)(zval *object, zval *member, int has_set_exists TSRMLS_DC); 70 71 /* Used to check if a dimension of the object exists */ 72 typedef int (*zend_object_has_dimension_t)(zval *object, zval *member, int check_empty TSRMLS_DC); 73 74 /* Used to remove a property of the object */ 75 typedef void (*zend_object_unset_property_t)(zval *object, zval *member TSRMLS_DC); 76 77 /* Used to remove a dimension of the object */ 78 typedef void (*zend_object_unset_dimension_t)(zval *object, zval *offset TSRMLS_DC); 79 80 /* Used to get hash of the properties of the object, as hash of zval's */ 81 typedef HashTable *(*zend_object_get_properties_t)(zval *object TSRMLS_DC); 82 83 typedef HashTable *(*zend_object_get_debug_info_t)(zval *object, int *is_temp TSRMLS_DC); 84 85 /* Used to call methods */ 86 /* args on stack! */ 87 /* Andi - EX(fbc) (function being called) needs to be initialized already in the INIT fcall opcode so that the parameters can be parsed the right way. We need to add another callback for this. 88 */ 89 typedef int (*zend_object_call_method_t)(char *method, INTERNAL_FUNCTION_PARAMETERS); 90 typedef union _zend_function *(*zend_object_get_method_t)(zval **object_ptr, char *method, int method_len TSRMLS_DC); 91 typedef union _zend_function *(*zend_object_get_constructor_t)(zval *object TSRMLS_DC); 92 93 /* Object maintenance/destruction */ 94 typedef void (*zend_object_add_ref_t)(zval *object TSRMLS_DC); 95 typedef void (*zend_object_del_ref_t)(zval *object TSRMLS_DC); 96 typedef void (*zend_object_delete_obj_t)(zval *object TSRMLS_DC); 97 typedef zend_object_value (*zend_object_clone_obj_t)(zval *object TSRMLS_DC); 98 99 typedef zend_class_entry *(*zend_object_get_class_entry_t)(const zval *object TSRMLS_DC); 100 typedef int (*zend_object_get_class_name_t)(const zval *object, char **class_name, zend_uint *class_name_len, int parent TSRMLS_DC); 101 typedef int (*zend_object_compare_t)(zval *object1, zval *object2 TSRMLS_DC); 102 103 /* Cast an object to some other type 104 */ 105 typedef int (*zend_object_cast_t)(zval *readobj, zval *retval, int type TSRMLS_DC); 106 107 /* updates *count to hold the number of elements present and returns SUCCESS. 108 * Returns FAILURE if the object does not have any sense of overloaded dimensions */ 109 typedef int (*zend_object_count_elements_t)(zval *object, long *count TSRMLS_DC); 110 111 typedef int (*zend_object_get_closure_t)(zval *obj, zend_class_entry **ce_ptr, union _zend_function **fptr_ptr, zval **zobj_ptr TSRMLS_DC); 112 113 struct _zend_object_handlers { 114 /* general object functions */ 115 zend_object_add_ref_t add_ref; 116 zend_object_del_ref_t del_ref; 117 zend_object_clone_obj_t clone_obj; 118 /* individual object functions */ 119 zend_object_read_property_t read_property; 120 zend_object_write_property_t write_property; 121 zend_object_read_dimension_t read_dimension; 122 zend_object_write_dimension_t write_dimension; 123 zend_object_get_property_ptr_ptr_t get_property_ptr_ptr; 124 zend_object_get_t get; 125 zend_object_set_t set; 126 zend_object_has_property_t has_property; 127 zend_object_unset_property_t unset_property; 128 zend_object_has_dimension_t has_dimension; 129 zend_object_unset_dimension_t unset_dimension; 130 zend_object_get_properties_t get_properties; 131 zend_object_get_method_t get_method; 132 zend_object_call_method_t call_method; 133 zend_object_get_constructor_t get_constructor; 134 zend_object_get_class_entry_t get_class_entry; 135 zend_object_get_class_name_t get_class_name; 136 zend_object_compare_t compare_objects; 137 zend_object_cast_t cast_object; 138 zend_object_count_elements_t count_elements; 139 zend_object_get_debug_info_t get_debug_info; 140 zend_object_get_closure_t get_closure; 141 }; 142 143 extern ZEND_API zend_object_handlers std_object_handlers; 144 145 BEGIN_EXTERN_C() 146 ZEND_API union _zend_function *zend_std_get_static_method(zend_class_entry *ce, char *function_name_strval, int function_name_strlen TSRMLS_DC); 147 ZEND_API zval **zend_std_get_static_property(zend_class_entry *ce, char *property_name, int property_name_len, zend_bool silent TSRMLS_DC); 148 ZEND_API zend_bool zend_std_unset_static_property(zend_class_entry *ce, char *property_name, int property_name_len TSRMLS_DC); 149 ZEND_API union _zend_function *zend_std_get_constructor(zval *object TSRMLS_DC); 150 ZEND_API struct _zend_property_info *zend_get_property_info(zend_class_entry *ce, zval *member, int silent TSRMLS_DC); 151 ZEND_API HashTable *zend_std_get_properties(zval *object TSRMLS_DC); 152 ZEND_API HashTable *zend_std_get_debug_info(zval *object, int *is_temp TSRMLS_DC); 153 ZEND_API int zend_std_cast_object_tostring(zval *readobj, zval *writeobj, int type TSRMLS_DC); 154 155 156 #define IS_ZEND_STD_OBJECT(z) (Z_TYPE(z) == IS_OBJECT && (Z_OBJ_HT((z))->get_class_entry != NULL)) 157 #define HAS_CLASS_ENTRY(z) (Z_OBJ_HT(z)->get_class_entry != NULL) 158 159 ZEND_API int zend_check_private(union _zend_function *fbc, zend_class_entry *ce, char *function_name_strval, int function_name_strlen TSRMLS_DC); 160 161 ZEND_API int zend_check_protected(zend_class_entry *ce, zend_class_entry *scope); 162 163 ZEND_API int zend_check_property_access(zend_object *zobj, char *prop_info_name, int prop_info_name_len TSRMLS_DC); 164 165 ZEND_API void zend_std_call_user_call(INTERNAL_FUNCTION_PARAMETERS); 166 END_EXTERN_C() 167 168 #endif 169 170 /* 171 * Local variables: 172 * tab-width: 4 173 * c-basic-offset: 4 174 * indent-tabs-mode: t 175 * End: 176 */ 177
