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 | https://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 23 extern PHPAPI zend_class_entry *spl_ce_AppendIterator; 24 extern PHPAPI zend_class_entry *spl_ce_CachingIterator; 25 extern PHPAPI zend_class_entry *spl_ce_CallbackFilterIterator; 26 extern PHPAPI zend_class_entry *spl_ce_EmptyIterator; 27 extern PHPAPI zend_class_entry *spl_ce_FilterIterator; 28 extern PHPAPI zend_class_entry *spl_ce_InfiniteIterator; 29 extern PHPAPI zend_class_entry *spl_ce_IteratorIterator; 30 extern PHPAPI zend_class_entry *spl_ce_LimitIterator; 31 extern PHPAPI zend_class_entry *spl_ce_NoRewindIterator; 32 extern PHPAPI zend_class_entry *spl_ce_OuterIterator; 33 extern PHPAPI zend_class_entry *spl_ce_ParentIterator; 34 extern PHPAPI zend_class_entry *spl_ce_RecursiveCachingIterator; 35 extern PHPAPI zend_class_entry *spl_ce_RecursiveCallbackFilterIterator; 36 extern PHPAPI zend_class_entry *spl_ce_RecursiveFilterIterator; 37 extern PHPAPI zend_class_entry *spl_ce_RecursiveIterator; 38 extern PHPAPI zend_class_entry *spl_ce_RecursiveIteratorIterator; 39 extern PHPAPI zend_class_entry *spl_ce_RecursiveRegexIterator; 40 extern PHPAPI zend_class_entry *spl_ce_RecursiveTreeIterator; 41 extern PHPAPI zend_class_entry *spl_ce_RegexIterator; 42 extern PHPAPI zend_class_entry *spl_ce_SeekableIterator; 43 44 PHP_MINIT_FUNCTION(spl_iterators); 45 46 47 typedef enum { 48 RIT_LEAVES_ONLY = 0, 49 RIT_SELF_FIRST = 1, 50 RIT_CHILD_FIRST = 2 51 } RecursiveIteratorMode; 52 53 #define RIT_CATCH_GET_CHILD CIT_CATCH_GET_CHILD 54 55 typedef enum { 56 RTIT_BYPASS_CURRENT = 4, 57 RTIT_BYPASS_KEY = 8 58 } RecursiveTreeIteratorFlags; 59 60 typedef enum { 61 DIT_Default = 0, 62 DIT_FilterIterator = DIT_Default, 63 DIT_RecursiveFilterIterator = DIT_Default, 64 DIT_ParentIterator = DIT_Default, 65 DIT_LimitIterator, 66 DIT_CachingIterator, 67 DIT_RecursiveCachingIterator, 68 DIT_IteratorIterator, 69 DIT_NoRewindIterator, 70 DIT_InfiniteIterator, 71 DIT_AppendIterator, 72 DIT_RegexIterator, 73 DIT_RecursiveRegexIterator, 74 DIT_CallbackFilterIterator, 75 DIT_RecursiveCallbackFilterIterator, 76 DIT_Unknown = ~0 77 } dual_it_type; 78 79 typedef enum { 80 RIT_Default = 0, 81 RIT_RecursiveIteratorIterator = RIT_Default, 82 RIT_RecursiveTreeIterator, 83 RIT_Unknow = ~0 84 } recursive_it_it_type; 85 86 enum { 87 /* public */ 88 CIT_CALL_TOSTRING = 0x00000001, 89 CIT_TOSTRING_USE_KEY = 0x00000002, 90 CIT_TOSTRING_USE_CURRENT = 0x00000004, 91 CIT_TOSTRING_USE_INNER = 0x00000008, 92 CIT_CATCH_GET_CHILD = 0x00000010, 93 CIT_FULL_CACHE = 0x00000100, 94 CIT_PUBLIC = 0x0000FFFF, 95 /* private */ 96 CIT_VALID = 0x00010000, 97 CIT_HAS_CHILDREN = 0x00020000 98 }; 99 100 enum { 101 /* public */ 102 REGIT_USE_KEY = 0x00000001, 103 REGIT_INVERTED = 0x00000002 104 }; 105 106 typedef enum { 107 REGIT_MODE_MATCH, 108 REGIT_MODE_GET_MATCH, 109 REGIT_MODE_ALL_MATCHES, 110 REGIT_MODE_SPLIT, 111 REGIT_MODE_REPLACE, 112 REGIT_MODE_MAX 113 } regex_mode; 114 115 typedef int (*spl_iterator_apply_func_t)(zend_object_iterator *iter, void *puser); 116 117 PHPAPI zend_result spl_iterator_apply(zval *obj, spl_iterator_apply_func_t apply_func, void *puser); 118 119 #endif /* SPL_ITERATORS_H */ 120
