xref: /PHP-8.0/Zend/zend_interfaces.h (revision fa8d9b11)
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: Marcus Boerger <helly@php.net>                              |
16    +----------------------------------------------------------------------+
17 */
18 
19 #ifndef ZEND_INTERFACES_H
20 #define ZEND_INTERFACES_H
21 
22 #include "zend.h"
23 #include "zend_API.h"
24 
25 BEGIN_EXTERN_C()
26 
27 extern ZEND_API zend_class_entry *zend_ce_traversable;
28 extern ZEND_API zend_class_entry *zend_ce_aggregate;
29 extern ZEND_API zend_class_entry *zend_ce_iterator;
30 extern ZEND_API zend_class_entry *zend_ce_arrayaccess;
31 extern ZEND_API zend_class_entry *zend_ce_serializable;
32 extern ZEND_API zend_class_entry *zend_ce_countable;
33 extern ZEND_API zend_class_entry *zend_ce_stringable;
34 
35 typedef struct _zend_user_iterator {
36 	zend_object_iterator     it;
37 	zend_class_entry         *ce;
38 	zval                     value;
39 } zend_user_iterator;
40 
41 ZEND_API zval* zend_call_method(zend_object *object, zend_class_entry *obj_ce, zend_function **fn_proxy, const char *function_name, size_t function_name_len, zval *retval, uint32_t param_count, zval* arg1, zval* arg2);
42 
43 #define zend_call_method_with_0_params(obj, obj_ce, fn_proxy, function_name, retval) \
44 	zend_call_method(obj, obj_ce, fn_proxy, function_name, sizeof(function_name)-1, retval, 0, NULL, NULL)
45 
46 #define zend_call_method_with_1_params(obj, obj_ce, fn_proxy, function_name, retval, arg1) \
47 	zend_call_method(obj, obj_ce, fn_proxy, function_name, sizeof(function_name)-1, retval, 1, arg1, NULL)
48 
49 #define zend_call_method_with_2_params(obj, obj_ce, fn_proxy, function_name, retval, arg1, arg2) \
50 	zend_call_method(obj, obj_ce, fn_proxy, function_name, sizeof(function_name)-1, retval, 2, arg1, arg2)
51 
52 #define REGISTER_MAGIC_INTERFACE(class_name, class_name_str) \
53 	{\
54 		zend_class_entry ce;\
55 		INIT_CLASS_ENTRY(ce, # class_name_str, class_ ## class_name_str ## _methods) \
56 		zend_ce_ ## class_name = zend_register_internal_interface(&ce);\
57 		zend_ce_ ## class_name->interface_gets_implemented = zend_implement_ ## class_name;\
58 	}
59 
60 #define REGISTER_MAGIC_IMPLEMENT(class_name, interface_name) \
61 	zend_class_implements(zend_ce_ ## class_name, 1, zend_ce_ ## interface_name)
62 
63 ZEND_API void zend_user_it_rewind(zend_object_iterator *_iter);
64 ZEND_API zend_result zend_user_it_valid(zend_object_iterator *_iter);
65 ZEND_API void zend_user_it_get_current_key(zend_object_iterator *_iter, zval *key);
66 ZEND_API zval *zend_user_it_get_current_data(zend_object_iterator *_iter);
67 ZEND_API void zend_user_it_move_forward(zend_object_iterator *_iter);
68 ZEND_API void zend_user_it_invalidate_current(zend_object_iterator *_iter);
69 
70 ZEND_API void zend_user_it_new_iterator(zend_class_entry *ce, zval *object, zval *iterator);
71 ZEND_API zend_object_iterator *zend_user_it_get_new_iterator(zend_class_entry *ce, zval *object, int by_ref);
72 
73 ZEND_API void zend_register_interfaces(void);
74 
75 ZEND_API int zend_user_serialize(zval *object, unsigned char **buffer, size_t *buf_len, zend_serialize_data *data);
76 ZEND_API int zend_user_unserialize(zval *object, zend_class_entry *ce, const unsigned char *buf, size_t buf_len, zend_unserialize_data *data);
77 
78 ZEND_API int zend_class_serialize_deny(zval *object, unsigned char **buffer, size_t *buf_len, zend_serialize_data *data);
79 ZEND_API int zend_class_unserialize_deny(zval *object, zend_class_entry *ce, const unsigned char *buf, size_t buf_len, zend_unserialize_data *data);
80 
81 ZEND_API zend_result zend_create_internal_iterator_zval(zval *return_value, zval *obj);
82 
83 END_EXTERN_C()
84 
85 #endif /* ZEND_INTERFACES_H */
86