syntree/node/walk.rs
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 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482
use core::iter::FusedIterator;
use crate::flavor::Flavor;
use crate::links::Links;
use crate::node::Node;
use crate::node::{Event, SkipTokens, WalkEvents};
/// An iterator that walks over the entire tree, visiting every node exactly
/// once.
///
/// See [`Tree::walk`][crate::Tree::walk] or [`Node::walk`].
///
/// # Examples
///
/// ```
/// let tree = syntree::tree! {
/// "root" => {
/// "c1" => {
/// "c2" => {},
/// "c3" => {},
/// "c4" => {},
/// },
/// "c5" => {},
/// "c6" => {
/// "c7" => {},
/// }
/// }
/// };
///
/// // Walk the entire tree.
/// assert_eq!(
/// tree.walk().map(|n| n.value()).collect::<Vec<_>>(),
/// ["root", "c1", "c2", "c3", "c4", "c5", "c6", "c7"],
/// );
///
/// // Walk from the root.
/// let root = tree.first().ok_or("missing root node")?;
///
/// assert_eq!(
/// root.walk().map(|n| n.value()).collect::<Vec<_>>(),
/// ["root", "c1", "c2", "c3", "c4", "c5", "c6", "c7"],
/// );
///
/// // Walk from c1 and visit siblings.
/// let c1 = root.first().ok_or("missing c1 node")?;
///
/// assert_eq!(
/// c1.walk().map(|n| n.value()).collect::<Vec<_>>(),
/// ["c1", "c2", "c3", "c4", "c5", "c6", "c7"],
/// );
///
/// assert_eq!(
/// c1.walk_from().map(|n| n.value()).collect::<Vec<_>>(),
/// ["c5", "c6", "c7"],
/// );
///
/// // Walk from c4 and visit parent siblings.
/// let c4 = c1.last().ok_or("missing c1 node")?;
///
/// assert_eq!(
/// c4.walk().map(|n| n.value()).collect::<Vec<_>>(),
/// ["c4", "c5", "c6", "c7"],
/// );
///
/// assert_eq!(
/// c4.walk_from().map(|n| n.value()).collect::<Vec<_>>(),
/// ["c5", "c6", "c7"],
/// );
///
/// // Walk from c5 and visit siblings.
/// let c5 = c1.next().ok_or("missing c5 node")?;
///
/// assert_eq!(
/// c5.walk().map(|n| n.value()).collect::<Vec<_>>(),
/// ["c5", "c6", "c7"],
/// );
///
/// assert_eq!(
/// c5.walk_from().map(|n| n.value()).collect::<Vec<_>>(),
/// ["c6", "c7"],
/// );
/// # Ok::<_, Box<dyn core::error::Error>>(())
/// ```
pub struct Walk<'a, T, F>
where
T: Copy,
F: Flavor,
{
iter: WalkEvents<'a, T, F>,
}
impl<'a, T, F> Walk<'a, T, F>
where
T: Copy,
F: Flavor,
{
/// Construct a new walk.
#[inline]
pub(crate) fn new(
tree: &'a [Links<T, F::Index, F::Pointer>],
node: Option<F::Pointer>,
e: Event,
) -> Self {
Self {
iter: WalkEvents::new(tree, node, e),
}
}
/// Convert this iterator into one that limits the walk to inside the
/// current node, visiting every node exactly once.
///
/// # Examples
///
/// ```
/// let tree = syntree::tree! {
/// "n1" => {
/// "n3" => {
/// "n4" => {},
/// "n5" => {},
/// }
/// },
/// "n6" => {
/// "n7"
/// }
/// };
///
/// let values = tree.walk().map(|n| n.value()).collect::<Vec<_>>();
/// assert_eq!(values, ["n1", "n3", "n4", "n5", "n6", "n7"]);
///
/// let n1 = tree.first().ok_or("missing n1")?;
///
/// let values = n1.walk().map(|n| n.value()).collect::<Vec<_>>();
/// assert_eq!(values, ["n1", "n3", "n4", "n5", "n6", "n7"]);
///
/// let values = n1.walk().inside().map(|n| n.value()).collect::<Vec<_>>();
/// assert_eq!(values, ["n1", "n3", "n4", "n5"]);
///
/// let values = n1.walk_from().inside().map(|n| n.value()).collect::<Vec<_>>();
/// let empty: [&str; 0] = [];
/// assert_eq!(values, empty);
///
/// # Ok::<_, Box<dyn core::error::Error>>(())
/// ```
#[inline]
#[must_use]
pub fn inside(self) -> Inside<'a, T, F> {
Inside { iter: self.iter }
}
/// Convert this iterator into one which includes depths.
///
/// # Examples
///
/// ```
/// let tree = syntree::tree! {
/// "root" => {
/// "c1" => {
/// "c2" => {},
/// "c3" => {},
/// }
/// }
/// };
///
/// let mut it = tree.walk().with_depths().map(|(d, n)| (d, n.value()));
/// assert!(it.eq([(0, "root"), (1, "c1"), (2, "c2"), (2, "c3")]));
///
/// # Ok::<_, Box<dyn core::error::Error>>(())
/// ```
#[inline]
#[must_use]
pub fn with_depths(self) -> WithDepths<'a, T, F> {
WithDepths { iter: self.iter }
}
/// Construct a [`SkipTokens`] iterator from the remainder of this iterator.
/// This filters out childless nodes, also known as tokens.
///
/// See [`SkipTokens`] for documentation.
#[inline]
#[must_use]
pub fn skip_tokens(self) -> SkipTokens<Self> {
SkipTokens::new(self)
}
/// Get the next node with a corresponding depth.
///
/// Alternatively you can use [`WithDepths`] through [`Walk::with_depths`].
///
/// # Examples
///
/// ```
/// use std::iter;
///
/// let tree = syntree::tree! {
/// "root" => {
/// "c1" => {
/// "c2" => {},
/// "c3" => {},
/// }
/// }
/// };
///
/// let mut it = tree.walk();
/// let it = iter::from_fn(move || it.next_with_depth());
/// let it = it.map(|(d, n)| (d, n.value()));
///
/// assert!(it.eq([(0, "root"), (1, "c1"), (2, "c2"), (2, "c3")]));
///
/// # Ok::<_, Box<dyn core::error::Error>>(())
/// ```
#[inline]
#[must_use]
pub fn next_with_depth(&mut self) -> Option<(isize, Node<'a, T, F>)> {
loop {
let depth = self.iter.depth();
let (event, node) = self.iter.next()?;
if !matches!(event, Event::Up) {
return Some((depth, node));
}
}
}
}
impl<T, F> Clone for Walk<'_, T, F>
where
T: Copy,
F: Flavor,
{
#[inline]
fn clone(&self) -> Self {
Self {
iter: self.iter.clone(),
}
}
}
impl<T, F> Default for Walk<'_, T, F>
where
T: Copy,
F: Flavor,
{
#[inline]
fn default() -> Self {
Self {
iter: WalkEvents::default(),
}
}
}
impl<'a, T, F> Iterator for Walk<'a, T, F>
where
T: Copy,
F: Flavor,
{
type Item = Node<'a, T, F>;
#[inline]
fn next(&mut self) -> Option<Self::Item> {
loop {
let (event, node) = self.iter.next()?;
if !matches!(event, Event::Up) {
return Some(node);
}
}
}
}
impl<T, F> FusedIterator for Walk<'_, T, F>
where
T: Copy,
F: Flavor,
{
}
/// An iterator that walks over the entire tree, visiting every node exactly
/// once. This is constructed with [`Walk::with_depths`].
///
/// # Examples
///
/// ```
/// let tree = syntree::tree! {
/// "root" => {
/// "c1" => {
/// "c2" => {},
/// "c3" => {},
/// "c4" => {},
/// },
/// "c5" => {},
/// "c6" => {}
/// }
/// };
///
/// assert_eq!(
/// tree.walk().with_depths().map(|(d, n)| (d, n.value())).collect::<Vec<_>>(),
/// [
/// (0, "root"),
/// (1, "c1"),
/// (2, "c2"),
/// (2, "c3"),
/// (2, "c4"),
/// (1, "c5"),
/// (1, "c6")
/// ]
/// );
///
/// let root = tree.first().ok_or("missing root node")?;
///
/// assert_eq!(
/// root.walk().with_depths().map(|(d, n)| (d, n.value())).collect::<Vec<_>>(),
/// [
/// (0, "root"),
/// (1, "c1"),
/// (2, "c2"),
/// (2, "c3"),
/// (2, "c4"),
/// (1, "c5"),
/// (1, "c6")
/// ]
/// );
/// # Ok::<_, Box<dyn core::error::Error>>(())
/// ```
pub struct WithDepths<'a, T, F>
where
T: Copy,
F: Flavor,
{
iter: WalkEvents<'a, T, F>,
}
impl<'a, T, F> Iterator for WithDepths<'a, T, F>
where
T: Copy,
F: Flavor,
{
type Item = (isize, Node<'a, T, F>);
#[inline]
fn next(&mut self) -> Option<Self::Item> {
loop {
let depth = self.iter.depth();
let (event, node) = self.iter.next()?;
if !matches!(event, Event::Up) {
return Some((depth, node));
}
}
}
}
impl<T, F> FusedIterator for WithDepths<'_, T, F>
where
T: Copy,
F: Flavor,
{
}
impl<T, F> Clone for WithDepths<'_, T, F>
where
T: Copy,
F: Flavor,
{
#[inline]
fn clone(&self) -> Self {
Self {
iter: self.iter.clone(),
}
}
}
impl<T, F> Default for WithDepths<'_, T, F>
where
T: Copy,
F: Flavor,
{
#[inline]
fn default() -> Self {
Self {
iter: WalkEvents::default(),
}
}
}
/// An iterator that limits the walk to inside the current node, visiting every
/// node exactly once. This is constructed with [`Walk::inside`].
///
/// # Examples
///
/// ```
/// let tree = syntree::tree! {
/// "n1" => {
/// "n3" => {
/// "n4" => {},
/// "n5" => {},
/// }
/// },
/// "n6" => {
/// "n7"
/// }
/// };
///
/// let values = tree.walk().map(|n| n.value()).collect::<Vec<_>>();
/// assert_eq!(values, ["n1", "n3", "n4", "n5", "n6", "n7"]);
///
/// let n1 = tree.first().ok_or("missing n1")?;
///
/// let values = n1.walk().map(|n| n.value()).collect::<Vec<_>>();
/// assert_eq!(values, ["n1", "n3", "n4", "n5", "n6", "n7"]);
///
/// let values = n1.walk().inside().map(|n| n.value()).collect::<Vec<_>>();
/// assert_eq!(values, ["n1", "n3", "n4", "n5"]);
///
/// let values = n1.walk_from().inside().map(|n| n.value()).collect::<Vec<_>>();
/// let empty: [&str; 0] = [];
/// assert_eq!(values, empty);
///
/// # Ok::<_, Box<dyn core::error::Error>>(())
/// ```
pub struct Inside<'a, T, F>
where
T: Copy,
F: Flavor,
{
iter: WalkEvents<'a, T, F>,
}
impl<'a, T, F> Iterator for Inside<'a, T, F>
where
T: Copy,
F: Flavor,
{
type Item = Node<'a, T, F>;
#[inline]
fn next(&mut self) -> Option<Self::Item> {
loop {
let (event, node) = self.iter.next()?;
if self.iter.depth() <= 0 {
self.iter = WalkEvents::default();
}
if !matches!(event, Event::Up) {
return Some(node);
}
}
}
}
impl<T, F> FusedIterator for Inside<'_, T, F>
where
T: Copy,
F: Flavor,
{
}
impl<T, F> Clone for Inside<'_, T, F>
where
T: Copy,
F: Flavor,
{
#[inline]
fn clone(&self) -> Self {
Self {
iter: self.iter.clone(),
}
}
}
impl<T, F> Default for Inside<'_, T, F>
where
T: Copy,
F: Flavor,
{
#[inline]
fn default() -> Self {
Self {
iter: WalkEvents::default(),
}
}
}