1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
use crate::convert::FromZvalMut;
use crate::ffi::{zend_object_iterator, ZEND_RESULT_CODE_SUCCESS};
use crate::flags::DataType;
use crate::types::Zval;
use crate::zend::ExecutorGlobals;
use std::fmt::{Debug, Formatter};
/// A PHP Iterator.
///
/// In PHP, iterators are represented as zend_object_iterator. This allows user
/// to iterate over objects implementing Traversable interface using foreach.
///
/// Use ZendIterable to iterate over both iterators and arrays.
pub type ZendIterator = zend_object_iterator;
impl ZendIterator {
/// Creates a new rust iterator from a zend_object_iterator.
///
/// Returns a iterator over the zend_object_iterator, or None if the
/// iterator cannot be rewound.
pub fn iter(&mut self) -> Option<Iter> {
self.index = 0;
if self.rewind() {
return Some(Iter { zi: self });
}
None
}
/// Check if the current position of the iterator is valid.
///
/// As an example this will call the user defined valid method of the
/// ['\Iterator'] interface. see <https://www.php.net/manual/en/iterator.valid.php>
pub fn valid(&mut self) -> bool {
if let Some(valid) = unsafe { (*self.funcs).valid } {
let valid = unsafe { valid(&mut *self) == ZEND_RESULT_CODE_SUCCESS };
if ExecutorGlobals::has_exception() {
return false;
}
valid
} else {
true
}
}
/// Rewind the iterator to the first element.
///
/// As an example this will call the user defined rewind method of the
/// ['\Iterator'] interface. see <https://www.php.net/manual/en/iterator.rewind.php>
///
/// # Returns
///
/// Returns true if the iterator was successfully rewind, false otherwise.
/// (when there is an exception during rewind)
pub fn rewind(&mut self) -> bool {
if let Some(rewind) = unsafe { (*self.funcs).rewind } {
unsafe {
rewind(&mut *self);
}
}
!ExecutorGlobals::has_exception()
}
/// Move the iterator forward to the next element.
///
/// As an example this will call the user defined next method of the
/// ['\Iterator'] interface. see <https://www.php.net/manual/en/iterator.next.php>
///
/// # Returns
///
/// Returns true if the iterator was successfully move, false otherwise.
/// (when there is an exception during next)
pub fn move_forward(&mut self) -> bool {
if let Some(move_forward) = unsafe { (*self.funcs).move_forward } {
unsafe {
move_forward(&mut *self);
}
}
!ExecutorGlobals::has_exception()
}
/// Get the current data of the iterator.
///
/// # Returns
///
/// Returns a reference to the current data of the iterator if available
/// , ['None'] otherwise.
pub fn get_current_data<'a>(&mut self) -> Option<&'a Zval> {
let get_current_data = unsafe { (*self.funcs).get_current_data }?;
let value = unsafe { &*get_current_data(&mut *self) };
if ExecutorGlobals::has_exception() {
return None;
}
Some(value)
}
/// Get the current key of the iterator.
///
/// # Returns
///
/// Returns a new ['Zval'] containing the current key of the iterator if
/// available , ['None'] otherwise.
pub fn get_current_key(&mut self) -> Option<Zval> {
let get_current_key = unsafe { (*self.funcs).get_current_key? };
let mut key = Zval::new();
unsafe {
get_current_key(&mut *self, &mut key);
}
if ExecutorGlobals::has_exception() {
return None;
}
Some(key)
}
}
impl<'a> IntoIterator for &'a mut ZendIterator {
type Item = (Zval, &'a Zval);
type IntoIter = Iter<'a>;
fn into_iter(self) -> Self::IntoIter {
self.iter().expect("Could not rewind iterator!")
}
}
impl Debug for ZendIterator {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
f.debug_struct("ZendIterator").finish()
}
}
/// Immutable iterator upon a reference to a PHP iterator.
pub struct Iter<'a> {
zi: &'a mut ZendIterator,
}
impl<'a> Iterator for Iter<'a> {
type Item = (Zval, &'a Zval);
fn next(&mut self) -> Option<Self::Item> {
// Call next when index > 0, so next is really called at the start of each
// iteration, which allow to work better with generator iterator
if self.zi.index > 0 && !self.zi.move_forward() {
return None;
}
if !self.zi.valid() {
return None;
}
self.zi.index += 1;
let real_index = self.zi.index - 1;
let key = match self.zi.get_current_key() {
None => {
let mut z = Zval::new();
z.set_long(real_index as i64);
z
}
Some(key) => key,
};
self.zi.get_current_data().map(|value| (key, value))
}
}
impl<'a> FromZvalMut<'a> for &'a mut ZendIterator {
const TYPE: DataType = DataType::Object(Some("Traversable"));
fn from_zval_mut(zval: &'a mut Zval) -> Option<Self> {
zval.object()?.get_class_entry().get_iterator(zval, false)
}
}
#[cfg(test)]
#[cfg(feature = "embed")]
mod tests {
use crate::embed::Embed;
#[test]
fn test_generator() {
Embed::run(|| {
let result = Embed::run_script("src/types/iterator.test.php");
assert!(result.is_ok());
let generator = Embed::eval("$generator;");
assert!(generator.is_ok());
let zval = generator.unwrap();
assert!(zval.is_traversable());
let iterator = zval.traversable().unwrap();
assert!(iterator.valid());
{
let mut iter = iterator.iter().unwrap();
let (key, value) = iter.next().unwrap();
assert_eq!(key.long(), Some(0));
assert!(value.is_long());
assert_eq!(value.long().unwrap(), 1);
let (key, value) = iter.next().unwrap();
assert_eq!(key.long(), Some(1));
assert!(value.is_long());
assert_eq!(value.long().unwrap(), 2);
let (key, value) = iter.next().unwrap();
assert_eq!(key.long(), Some(2));
assert!(value.is_long());
assert_eq!(value.long().unwrap(), 3);
let (key, value) = iter.next().unwrap();
assert!(key.is_object());
assert!(value.is_object());
let next = iter.next();
assert!(next.is_none());
}
});
}
#[test]
fn test_iterator() {
Embed::run(|| {
let result = Embed::run_script("src/types/iterator.test.php");
assert!(result.is_ok());
let generator = Embed::eval("$iterator;");
assert!(generator.is_ok());
let zval = generator.unwrap();
assert!(zval.is_traversable());
let iterator = zval.traversable().unwrap();
assert!(iterator.valid());
{
let mut iter = iterator.iter().unwrap();
let (key, value) = iter.next().unwrap();
assert!(!key.is_long());
assert_eq!(key.str(), Some("key"));
assert!(value.is_string());
assert_eq!(value.str(), Some("foo"));
let (key, value) = iter.next().unwrap();
assert!(key.is_long());
assert_eq!(key.long(), Some(10));
assert!(value.is_string());
assert_eq!(value.string().unwrap(), "bar");
let (key, value) = iter.next().unwrap();
assert_eq!(key.long(), Some(2));
assert!(value.is_string());
assert_eq!(value.string().unwrap(), "baz");
let (key, value) = iter.next().unwrap();
assert!(key.is_object());
assert!(value.is_object());
let next = iter.next();
assert!(next.is_none());
}
// Test rewind
{
let mut iter = iterator.iter().unwrap();
let (key, value) = iter.next().unwrap();
assert_eq!(key.str(), Some("key"));
assert!(value.is_string());
assert_eq!(value.string().unwrap(), "foo");
let (key, value) = iter.next().unwrap();
assert_eq!(key.long(), Some(10));
assert!(value.is_string());
assert_eq!(value.string().unwrap(), "bar");
let (key, value) = iter.next().unwrap();
assert_eq!(key.long(), Some(2));
assert!(value.is_string());
assert_eq!(value.string().unwrap(), "baz");
let (key, value) = iter.next().unwrap();
assert!(key.is_object());
assert!(value.is_object());
let next = iter.next();
assert!(next.is_none());
}
});
}
}