xref: /PHP-8.2/Zend/zend_interfaces.h (revision bf1cfc07)
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 
zend_call_method_with_0_params(zend_object * object,zend_class_entry * obj_ce,zend_function ** fn_proxy,const char * function_name,zval * retval)43 static zend_always_inline zval* zend_call_method_with_0_params(zend_object *object, zend_class_entry *obj_ce,
44 		zend_function **fn_proxy, const char *function_name, zval *retval)
45 {
46 	return zend_call_method(object, obj_ce, fn_proxy, function_name, strlen(function_name), retval, 0, NULL, NULL);
47 }
48 
zend_call_method_with_1_params(zend_object * object,zend_class_entry * obj_ce,zend_function ** fn_proxy,const char * function_name,zval * retval,zval * arg1)49 static zend_always_inline zval* zend_call_method_with_1_params(zend_object *object, zend_class_entry *obj_ce,
50 		zend_function **fn_proxy, const char *function_name, zval *retval, zval* arg1)
51 {
52 	return zend_call_method(object, obj_ce, fn_proxy, function_name, strlen(function_name), retval, 1, arg1, NULL);
53 }
54 
zend_call_method_with_2_params(zend_object * object,zend_class_entry * obj_ce,zend_function ** fn_proxy,const char * function_name,zval * retval,zval * arg1,zval * arg2)55 static zend_always_inline zval* zend_call_method_with_2_params(zend_object *object, zend_class_entry *obj_ce,
56 		zend_function **fn_proxy, const char *function_name, zval *retval, zval* arg1, zval* arg2)
57 {
58 	return zend_call_method(object, obj_ce, fn_proxy, function_name, strlen(function_name), retval, 2, arg1, arg2);
59 }
60 
61 ZEND_API void zend_user_it_rewind(zend_object_iterator *_iter);
62 ZEND_API zend_result zend_user_it_valid(zend_object_iterator *_iter);
63 ZEND_API void zend_user_it_get_current_key(zend_object_iterator *_iter, zval *key);
64 ZEND_API zval *zend_user_it_get_current_data(zend_object_iterator *_iter);
65 ZEND_API void zend_user_it_move_forward(zend_object_iterator *_iter);
66 ZEND_API void zend_user_it_invalidate_current(zend_object_iterator *_iter);
67 ZEND_API HashTable *zend_user_it_get_gc(zend_object_iterator *_iter, zval **table, int *n);
68 
69 ZEND_API void zend_user_it_new_iterator(zend_class_entry *ce, zval *object, zval *iterator);
70 ZEND_API zend_object_iterator *zend_user_it_get_new_iterator(zend_class_entry *ce, zval *object, int by_ref);
71 
72 ZEND_API void zend_register_interfaces(void);
73 
74 ZEND_API int zend_user_serialize(zval *object, unsigned char **buffer, size_t *buf_len, zend_serialize_data *data);
75 ZEND_API int zend_user_unserialize(zval *object, zend_class_entry *ce, const unsigned char *buf, size_t buf_len, zend_unserialize_data *data);
76 
77 ZEND_API zend_result zend_create_internal_iterator_zval(zval *return_value, zval *obj);
78 
79 END_EXTERN_C()
80 
81 #endif /* ZEND_INTERFACES_H */
82