1 /*
2 +----------------------------------------------------------------------+
3 | Copyright (c) The PHP Group |
4 +----------------------------------------------------------------------+
5 | This source file is subject to version 3.01 of the PHP license, |
6 | that is bundled with this package in the file LICENSE, and is |
7 | available through the world-wide-web at the following url: |
8 | http://www.php.net/license/3_01.txt |
9 | If you did not receive a copy of the PHP license and are unable to |
10 | obtain it through the world-wide-web, please send a note to |
11 | license@php.net so we can mail you a copy immediately. |
12 +----------------------------------------------------------------------+
13 | Authors: Marcus Boerger <helly@php.net> |
14 +----------------------------------------------------------------------+
15 */
16
17 #ifndef SPL_ITERATORS_H
18 #define SPL_ITERATORS_H
19
20 #include "php.h"
21 #include "php_spl.h"
22 #include "ext/pcre/php_pcre.h"
23
24 #define spl_ce_Traversable zend_ce_traversable
25 #define spl_ce_Iterator zend_ce_iterator
26 #define spl_ce_Aggregate zend_ce_aggregate
27 #define spl_ce_ArrayAccess zend_ce_arrayaccess
28 #define spl_ce_Serializable zend_ce_serializable
29 #define spl_ce_Countable zend_ce_countable
30 #define spl_ce_Stringable zend_ce_stringable
31
32 extern PHPAPI zend_class_entry *spl_ce_RecursiveIterator;
33 extern PHPAPI zend_class_entry *spl_ce_RecursiveIteratorIterator;
34 extern PHPAPI zend_class_entry *spl_ce_RecursiveTreeIterator;
35 extern PHPAPI zend_class_entry *spl_ce_FilterIterator;
36 extern PHPAPI zend_class_entry *spl_ce_RecursiveFilterIterator;
37 extern PHPAPI zend_class_entry *spl_ce_ParentIterator;
38 extern PHPAPI zend_class_entry *spl_ce_SeekableIterator;
39 extern PHPAPI zend_class_entry *spl_ce_LimitIterator;
40 extern PHPAPI zend_class_entry *spl_ce_CachingIterator;
41 extern PHPAPI zend_class_entry *spl_ce_RecursiveCachingIterator;
42 extern PHPAPI zend_class_entry *spl_ce_OuterIterator;
43 extern PHPAPI zend_class_entry *spl_ce_IteratorIterator;
44 extern PHPAPI zend_class_entry *spl_ce_NoRewindIterator;
45 extern PHPAPI zend_class_entry *spl_ce_InfiniteIterator;
46 extern PHPAPI zend_class_entry *spl_ce_EmptyIterator;
47 extern PHPAPI zend_class_entry *spl_ce_AppendIterator;
48 extern PHPAPI zend_class_entry *spl_ce_RegexIterator;
49 extern PHPAPI zend_class_entry *spl_ce_RecursiveRegexIterator;
50 extern PHPAPI zend_class_entry *spl_ce_CallbackFilterIterator;
51 extern PHPAPI zend_class_entry *spl_ce_RecursiveCallbackFilterIterator;
52
53 PHP_MINIT_FUNCTION(spl_iterators);
54
55 PHP_FUNCTION(iterator_to_array);
56 PHP_FUNCTION(iterator_count);
57 PHP_FUNCTION(iterator_apply);
58
59 typedef enum {
60 DIT_Default = 0,
61 DIT_FilterIterator = DIT_Default,
62 DIT_RecursiveFilterIterator = DIT_Default,
63 DIT_ParentIterator = DIT_Default,
64 DIT_LimitIterator,
65 DIT_CachingIterator,
66 DIT_RecursiveCachingIterator,
67 DIT_IteratorIterator,
68 DIT_NoRewindIterator,
69 DIT_InfiniteIterator,
70 DIT_AppendIterator,
71 DIT_RegexIterator,
72 DIT_RecursiveRegexIterator,
73 DIT_CallbackFilterIterator,
74 DIT_RecursiveCallbackFilterIterator,
75 DIT_Unknown = ~0
76 } dual_it_type;
77
78 typedef enum {
79 RIT_Default = 0,
80 RIT_RecursiveIteratorIterator = RIT_Default,
81 RIT_RecursiveTreeIterator,
82 RIT_Unknow = ~0
83 } recursive_it_it_type;
84
85 enum {
86 /* public */
87 CIT_CALL_TOSTRING = 0x00000001,
88 CIT_TOSTRING_USE_KEY = 0x00000002,
89 CIT_TOSTRING_USE_CURRENT = 0x00000004,
90 CIT_TOSTRING_USE_INNER = 0x00000008,
91 CIT_CATCH_GET_CHILD = 0x00000010,
92 CIT_FULL_CACHE = 0x00000100,
93 CIT_PUBLIC = 0x0000FFFF,
94 /* private */
95 CIT_VALID = 0x00010000,
96 CIT_HAS_CHILDREN = 0x00020000
97 };
98
99 enum {
100 /* public */
101 REGIT_USE_KEY = 0x00000001,
102 REGIT_INVERTED = 0x00000002
103 };
104
105 typedef enum {
106 REGIT_MODE_MATCH,
107 REGIT_MODE_GET_MATCH,
108 REGIT_MODE_ALL_MATCHES,
109 REGIT_MODE_SPLIT,
110 REGIT_MODE_REPLACE,
111 REGIT_MODE_MAX
112 } regex_mode;
113
114 typedef struct _spl_cbfilter_it_intern {
115 zend_fcall_info fci;
116 zend_fcall_info_cache fcc;
117 zend_object *object;
118 } _spl_cbfilter_it_intern;
119
120 typedef struct _spl_dual_it_object {
121 struct {
122 zval zobject;
123 zend_class_entry *ce;
124 zend_object *object;
125 zend_object_iterator *iterator;
126 } inner;
127 struct {
128 zval data;
129 zval key;
130 zend_long pos;
131 } current;
132 dual_it_type dit_type;
133 union {
134 struct {
135 zend_long offset;
136 zend_long count;
137 } limit;
138 struct {
139 zend_long flags; /* CIT_* */
140 zval zstr;
141 zval zchildren;
142 zval zcache;
143 } caching;
144 struct {
145 zval zarrayit;
146 zend_object_iterator *iterator;
147 } append;
148 struct {
149 zend_long flags;
150 zend_long preg_flags;
151 pcre_cache_entry *pce;
152 zend_string *regex;
153 regex_mode mode;
154 int use_flags;
155 } regex;
156 _spl_cbfilter_it_intern *cbfilter;
157 } u;
158 zend_object std;
159 } spl_dual_it_object;
160
spl_dual_it_from_obj(zend_object * obj)161 static inline spl_dual_it_object *spl_dual_it_from_obj(zend_object *obj) /* {{{ */ {
162 return (spl_dual_it_object*)((char*)(obj) - XtOffsetOf(spl_dual_it_object, std));
163 } /* }}} */
164
165 #define Z_SPLDUAL_IT_P(zv) spl_dual_it_from_obj(Z_OBJ_P((zv)))
166
167 typedef int (*spl_iterator_apply_func_t)(zend_object_iterator *iter, void *puser);
168
169 PHPAPI int spl_iterator_apply(zval *obj, spl_iterator_apply_func_t apply_func, void *puser);
170
171 #endif /* SPL_ITERATORS_H */
172
