1 /* 2 +----------------------------------------------------------------------+ 3 | Zend Engine | 4 +----------------------------------------------------------------------+ 5 | Copyright (c) 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@php.net> | 16 | Zeev Suraski <zeev@php.net> | 17 +----------------------------------------------------------------------+ 18 */ 19 20 #ifndef ZEND_OBJECT_HANDLERS_H 21 #define ZEND_OBJECT_HANDLERS_H 22 23 struct _zend_property_info; 24 25 #define ZEND_WRONG_PROPERTY_INFO \ 26 ((struct _zend_property_info*)((intptr_t)-1)) 27 28 #define ZEND_DYNAMIC_PROPERTY_OFFSET ((uintptr_t)(intptr_t)(-1)) 29 30 #define IS_VALID_PROPERTY_OFFSET(offset) ((intptr_t)(offset) > 0) 31 #define IS_WRONG_PROPERTY_OFFSET(offset) ((intptr_t)(offset) == 0) 32 #define IS_DYNAMIC_PROPERTY_OFFSET(offset) ((intptr_t)(offset) < 0) 33 34 #define IS_UNKNOWN_DYNAMIC_PROPERTY_OFFSET(offset) (offset == ZEND_DYNAMIC_PROPERTY_OFFSET) 35 #define ZEND_DECODE_DYN_PROP_OFFSET(offset) ((uintptr_t)(-(intptr_t)(offset) - 2)) 36 #define ZEND_ENCODE_DYN_PROP_OFFSET(offset) ((uintptr_t)(-((intptr_t)(offset) + 2))) 37 38 39 /* The following rule applies to read_property() and read_dimension() implementations: 40 If you return a zval which is not otherwise referenced by the extension or the engine's 41 symbol table, its reference count should be 0. 42 */ 43 /* Used to fetch property from the object, read-only */ 44 typedef zval *(*zend_object_read_property_t)(zval *object, zval *member, int type, void **cache_slot, zval *rv); 45 46 /* Used to fetch dimension from the object, read-only */ 47 typedef zval *(*zend_object_read_dimension_t)(zval *object, zval *offset, int type, zval *rv); 48 49 50 /* The following rule applies to write_property() and write_dimension() implementations: 51 If you receive a value zval in write_property/write_dimension, you may only modify it if 52 its reference count is 1. Otherwise, you must create a copy of that zval before making 53 any changes. You should NOT modify the reference count of the value passed to you. 54 You must return the final value of the assigned property. 55 */ 56 /* Used to set property of the object */ 57 typedef zval *(*zend_object_write_property_t)(zval *object, zval *member, zval *value, void **cache_slot); 58 59 /* Used to set dimension of the object */ 60 typedef void (*zend_object_write_dimension_t)(zval *object, zval *offset, zval *value); 61 62 63 /* Used to create pointer to the property of the object, for future direct r/w access */ 64 typedef zval *(*zend_object_get_property_ptr_ptr_t)(zval *object, zval *member, int type, void **cache_slot); 65 66 /* Used to set object value. Can be used to override assignments and scalar 67 write ops (like ++, +=) on the object */ 68 typedef void (*zend_object_set_t)(zval *object, zval *value); 69 70 /* Used to get object value. Can be used when converting object value to 71 * one of the basic types and when using scalar ops (like ++, +=) on the object 72 */ 73 typedef zval* (*zend_object_get_t)(zval *object, zval *rv); 74 75 /* Used to check if a property of the object exists */ 76 /* param has_set_exists: 77 * 0 (has) whether property exists and is not NULL 78 * 1 (set) whether property exists and is true 79 * 2 (exists) whether property exists 80 */ 81 typedef int (*zend_object_has_property_t)(zval *object, zval *member, int has_set_exists, void **cache_slot); 82 83 /* Used to check if a dimension of the object exists */ 84 typedef int (*zend_object_has_dimension_t)(zval *object, zval *member, int check_empty); 85 86 /* Used to remove a property of the object */ 87 typedef void (*zend_object_unset_property_t)(zval *object, zval *member, void **cache_slot); 88 89 /* Used to remove a dimension of the object */ 90 typedef void (*zend_object_unset_dimension_t)(zval *object, zval *offset); 91 92 /* Used to get hash of the properties of the object, as hash of zval's */ 93 typedef HashTable *(*zend_object_get_properties_t)(zval *object); 94 95 typedef HashTable *(*zend_object_get_debug_info_t)(zval *object, int *is_temp); 96 97 typedef enum _zend_prop_purpose { 98 /* Used for debugging. Supersedes get_debug_info handler. */ 99 ZEND_PROP_PURPOSE_DEBUG, 100 /* Used for (array) casts. */ 101 ZEND_PROP_PURPOSE_ARRAY_CAST, 102 /* Used for serialization using the "O" scheme. 103 * Unserialization will use __wakeup(). */ 104 ZEND_PROP_PURPOSE_SERIALIZE, 105 /* Used for var_export(). 106 * The data will be passed to __set_state() when evaluated. */ 107 ZEND_PROP_PURPOSE_VAR_EXPORT, 108 /* Used for json_encode(). */ 109 ZEND_PROP_PURPOSE_JSON, 110 /* array_key_exists(). Not intended for general use! */ 111 _ZEND_PROP_PURPOSE_ARRAY_KEY_EXISTS, 112 /* Dummy member to ensure that "default" is specified. */ 113 _ZEND_PROP_PURPOSE_NON_EXHAUSTIVE_ENUM 114 } zend_prop_purpose; 115 116 /* The return value must be released using zend_release_properties(). */ 117 typedef zend_array *(*zend_object_get_properties_for_t)(zval *object, zend_prop_purpose purpose); 118 119 /* Used to call methods */ 120 /* args on stack! */ 121 /* 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. 122 */ 123 typedef int (*zend_object_call_method_t)(zend_string *method, zend_object *object, INTERNAL_FUNCTION_PARAMETERS); 124 typedef zend_function *(*zend_object_get_method_t)(zend_object **object, zend_string *method, const zval *key); 125 typedef zend_function *(*zend_object_get_constructor_t)(zend_object *object); 126 127 /* Object maintenance/destruction */ 128 typedef void (*zend_object_dtor_obj_t)(zend_object *object); 129 typedef void (*zend_object_free_obj_t)(zend_object *object); 130 typedef zend_object* (*zend_object_clone_obj_t)(zval *object); 131 132 /* Get class name for display in var_dump and other debugging functions. 133 * Must be defined and must return a non-NULL value. */ 134 typedef zend_string *(*zend_object_get_class_name_t)(const zend_object *object); 135 136 typedef int (*zend_object_compare_t)(zval *object1, zval *object2); 137 typedef int (*zend_object_compare_zvals_t)(zval *result, zval *op1, zval *op2); 138 139 /* Cast an object to some other type. 140 * readobj and retval must point to distinct zvals. 141 */ 142 typedef int (*zend_object_cast_t)(zval *readobj, zval *retval, int type); 143 144 /* updates *count to hold the number of elements present and returns SUCCESS. 145 * Returns FAILURE if the object does not have any sense of overloaded dimensions */ 146 typedef int (*zend_object_count_elements_t)(zval *object, zend_long *count); 147 148 typedef int (*zend_object_get_closure_t)(zval *obj, zend_class_entry **ce_ptr, zend_function **fptr_ptr, zend_object **obj_ptr); 149 150 typedef HashTable *(*zend_object_get_gc_t)(zval *object, zval **table, int *n); 151 152 typedef int (*zend_object_do_operation_t)(zend_uchar opcode, zval *result, zval *op1, zval *op2); 153 154 struct _zend_object_handlers { 155 /* offset of real object header (usually zero) */ 156 int offset; 157 /* object handlers */ 158 zend_object_free_obj_t free_obj; /* required */ 159 zend_object_dtor_obj_t dtor_obj; /* required */ 160 zend_object_clone_obj_t clone_obj; /* optional */ 161 zend_object_read_property_t read_property; /* required */ 162 zend_object_write_property_t write_property; /* required */ 163 zend_object_read_dimension_t read_dimension; /* required */ 164 zend_object_write_dimension_t write_dimension; /* required */ 165 zend_object_get_property_ptr_ptr_t get_property_ptr_ptr; /* required */ 166 zend_object_get_t get; /* optional */ 167 zend_object_set_t set; /* optional */ 168 zend_object_has_property_t has_property; /* required */ 169 zend_object_unset_property_t unset_property; /* required */ 170 zend_object_has_dimension_t has_dimension; /* required */ 171 zend_object_unset_dimension_t unset_dimension; /* required */ 172 zend_object_get_properties_t get_properties; /* required */ 173 zend_object_get_method_t get_method; /* required */ 174 zend_object_call_method_t call_method; /* optional */ 175 zend_object_get_constructor_t get_constructor; /* required */ 176 zend_object_get_class_name_t get_class_name; /* required */ 177 zend_object_compare_t compare_objects; /* optional */ 178 zend_object_cast_t cast_object; /* optional */ 179 zend_object_count_elements_t count_elements; /* optional */ 180 zend_object_get_debug_info_t get_debug_info; /* optional */ 181 zend_object_get_closure_t get_closure; /* optional */ 182 zend_object_get_gc_t get_gc; /* required */ 183 zend_object_do_operation_t do_operation; /* optional */ 184 zend_object_compare_zvals_t compare; /* optional */ 185 zend_object_get_properties_for_t get_properties_for; /* optional */ 186 }; 187 188 BEGIN_EXTERN_C() 189 extern const ZEND_API zend_object_handlers std_object_handlers; 190 191 #define zend_get_std_object_handlers() \ 192 (&std_object_handlers) 193 194 #define zend_get_function_root_class(fbc) \ 195 ((fbc)->common.prototype ? (fbc)->common.prototype->common.scope : (fbc)->common.scope) 196 197 #define ZEND_PROPERTY_ISSET 0x0 /* Property exists and is not NULL */ 198 #define ZEND_PROPERTY_NOT_EMPTY ZEND_ISEMPTY /* Property is not empty */ 199 #define ZEND_PROPERTY_EXISTS 0x2 /* Property exists */ 200 201 ZEND_API void zend_class_init_statics(zend_class_entry *ce); 202 ZEND_API zend_function *zend_std_get_static_method(zend_class_entry *ce, zend_string *function_name_strval, const zval *key); 203 ZEND_API zval *zend_std_get_static_property_with_info(zend_class_entry *ce, zend_string *property_name, int type, struct _zend_property_info **prop_info); 204 ZEND_API zval *zend_std_get_static_property(zend_class_entry *ce, zend_string *property_name, int type); 205 ZEND_API ZEND_COLD zend_bool zend_std_unset_static_property(zend_class_entry *ce, zend_string *property_name); 206 ZEND_API zend_function *zend_std_get_constructor(zend_object *object); 207 ZEND_API struct _zend_property_info *zend_get_property_info(zend_class_entry *ce, zend_string *member, int silent); 208 ZEND_API HashTable *zend_std_get_properties(zval *object); 209 ZEND_API HashTable *zend_std_get_gc(zval *object, zval **table, int *n); 210 ZEND_API HashTable *zend_std_get_debug_info(zval *object, int *is_temp); 211 ZEND_API int zend_std_cast_object_tostring(zval *readobj, zval *writeobj, int type); 212 ZEND_API zval *zend_std_get_property_ptr_ptr(zval *object, zval *member, int type, void **cache_slot); 213 ZEND_API zval *zend_std_read_property(zval *object, zval *member, int type, void **cache_slot, zval *rv); 214 ZEND_API zval *zend_std_write_property(zval *object, zval *member, zval *value, void **cache_slot); 215 ZEND_API int zend_std_has_property(zval *object, zval *member, int has_set_exists, void **cache_slot); 216 ZEND_API void zend_std_unset_property(zval *object, zval *member, void **cache_slot); 217 ZEND_API zval *zend_std_read_dimension(zval *object, zval *offset, int type, zval *rv); 218 ZEND_API void zend_std_write_dimension(zval *object, zval *offset, zval *value); 219 ZEND_API int zend_std_has_dimension(zval *object, zval *offset, int check_empty); 220 ZEND_API void zend_std_unset_dimension(zval *object, zval *offset); 221 ZEND_API zend_function *zend_std_get_method(zend_object **obj_ptr, zend_string *method_name, const zval *key); 222 ZEND_API zend_string *zend_std_get_class_name(const zend_object *zobj); 223 ZEND_API int zend_std_compare_objects(zval *o1, zval *o2); 224 ZEND_API int zend_std_get_closure(zval *obj, zend_class_entry **ce_ptr, zend_function **fptr_ptr, zend_object **obj_ptr); 225 ZEND_API void rebuild_object_properties(zend_object *zobj); 226 227 ZEND_API int zend_check_protected(zend_class_entry *ce, zend_class_entry *scope); 228 229 ZEND_API int zend_check_property_access(zend_object *zobj, zend_string *prop_info_name, zend_bool is_dynamic); 230 231 ZEND_API zend_function *zend_get_call_trampoline_func(zend_class_entry *ce, zend_string *method_name, int is_static); 232 233 ZEND_API uint32_t *zend_get_property_guard(zend_object *zobj, zend_string *member); 234 235 /* Default behavior for get_properties_for. For use as a fallback in custom 236 * get_properties_for implementations. */ 237 ZEND_API HashTable *zend_std_get_properties_for(zval *obj, zend_prop_purpose purpose); 238 239 /* Will call get_properties_for handler or use default behavior. For use by 240 * consumers of the get_properties_for API. */ 241 ZEND_API HashTable *zend_get_properties_for(zval *obj, zend_prop_purpose purpose); 242 243 #define zend_release_properties(ht) do { \ 244 if ((ht) && !(GC_FLAGS(ht) & GC_IMMUTABLE) && !GC_DELREF(ht)) { \ 245 zend_array_destroy(ht); \ 246 } \ 247 } while (0) 248 249 #define zend_free_trampoline(func) do { \ 250 if ((func) == &EG(trampoline)) { \ 251 EG(trampoline).common.function_name = NULL; \ 252 } else { \ 253 efree(func); \ 254 } \ 255 } while (0) 256 257 END_EXTERN_C() 258 259 #endif 260
