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
use crate::non_max::NonMaxUsize;
use crate::tree::{Links, Node, Walk, WithoutTokens};
use crate::{Kind, Span};
/// Iterator over the children of a node or tree.
///
/// See [Tree::children][crate::Tree::children].
pub struct Children<'a, T> {
pub(crate) tree: &'a [Links<T>],
pub(crate) start: Option<NonMaxUsize>,
pub(crate) end: Option<NonMaxUsize>,
}
impl<'a, T> Children<'a, T> {
/// Access the children to this node.
///
/// ```
/// use syntree::TreeBuilder;
///
/// # fn main() -> anyhow::Result<()> {
/// let mut tree = TreeBuilder::new();
///
/// tree.open("root1");
/// tree.open("child1");
/// tree.close()?;
///
/// tree.open("child2");
/// tree.close()?;
/// tree.close()?;
///
/// let tree = tree.build()?;
/// let root = tree.first().expect("expected root node");
///
/// let mut it = root.children().without_tokens();
///
/// assert_eq!(it.next().map(|n| *n.data()), Some("child1"));
/// assert_eq!(it.next().map(|n| *n.data()), Some("child2"));
/// assert!(it.next().is_none());
/// # Ok(()) }
/// ```
pub fn without_tokens(self) -> WithoutTokens<Self> {
WithoutTokens::new(self)
}
/// Calculate the span of the remaining nodes in the iterator.
///
/// # Examples
///
/// ```
/// use syntree::{Span, TreeBuilder};
///
/// # fn main() -> anyhow::Result<()> {
/// let mut tree = TreeBuilder::new();
///
/// tree.open("number");
/// tree.token("number", 5);
/// tree.close()?;
///
/// tree.open("ident");
/// tree.token("ident", 2);
/// tree.close()?;
///
/// let tree = tree.build()?;
/// let mut it = tree.children();
///
/// it.next();
///
/// assert_eq!(it.span(), Some(Span::new(5, 7)));
/// # Ok(()) }
/// ```
pub fn span(self) -> Option<Span> {
let mut it = self.walk();
let start = loop {
if let Kind::Token(span) = it.next()?.kind() {
break span;
}
};
while let Some(node) = it.next_back() {
if let Kind::Token(end) = node.kind() {
return Some(Span::new(start.start, end.end));
}
}
Some(start)
}
/// Walk the rest of the tree forwards in a depth-first fashion.
///
/// # Examples
///
/// ```
/// # fn main() -> anyhow::Result<()> {
/// let tree = syntree::tree! {
/// "root" => {
/// "c1" => {
/// "c2",
/// "c3",
/// "c4",
/// },
/// "c5",
/// "c6"
/// }
/// };
///
/// let nodes = tree.children().walk().map(|n| *n.data()).collect::<Vec<_>>();
/// assert_eq!(nodes, vec!["root", "c1", "c2", "c3", "c4", "c5", "c6"]);
/// # Ok(()) }
/// ```
///
/// Walk backwards.
///
/// ```
/// # fn main() -> anyhow::Result<()> {
/// let tree = syntree::tree! {
/// "root" => {
/// "c1" => {
/// "c2",
/// "c3",
/// "c4",
/// },
/// "c5",
/// "c6"
/// }
/// };
///
/// let nodes = tree.children().walk().rev().map(|n| *n.data()).collect::<Vec<_>>();
/// assert_eq!(nodes, vec!["c6", "c5", "c4", "c3", "c2", "c1", "root"]);
/// # Ok(()) }
/// ```
pub fn walk(self) -> Walk<'a, T> {
Walk {
tree: self.tree,
range: self.range(self.start, self.end),
}
}
/// Get the next node from the iterator. This advances past all non-node
/// data.
///
/// # Examples
///
/// ```
/// # fn main() -> anyhow::Result<()> {
/// let tree = syntree::tree! {
/// ("t1", 1),
/// "child1",
/// ("t2", 1),
/// "child2",
/// ("t3", 1),
/// "child3",
/// ("t4", 1)
/// };
///
/// let mut it = tree.children();
/// assert_eq!(it.next_node().map(|n| *n.data()), Some("child1"));
/// assert_eq!(it.next().map(|n| *n.data()), Some("t2"));
/// # Ok(()) }
/// ```
pub fn next_node(&mut self) -> Option<Node<'a, T>> {
loop {
let node = self.tree.get(self.start?.get())?;
self.start = node.next;
if matches!(node.kind, Kind::Node) {
return Some(Node::new(node, self.tree));
}
}
}
/// Get the next node from the iterator from the back. This advances past
/// all non-node data.
///
/// # Examples
///
/// ```
/// # fn main() -> anyhow::Result<()> {
/// let tree = syntree::tree! {
/// ("t1", 1),
/// "child1",
/// ("t2", 1),
/// "child2",
/// ("t3", 1),
/// "child3",
/// ("t4", 1)
/// };
///
/// let mut it = tree.children();
/// assert_eq!(it.next_back_node().map(|n| *n.data()), Some("child3"));
/// assert_eq!(it.next_back().map(|n| *n.data()), Some("t3"));
/// # Ok(()) }
/// ```
pub fn next_back_node(&mut self) -> Option<Node<'a, T>> {
loop {
let node = self.tree.get(self.end?.get())?;
self.end = node.prev;
if matches!(node.kind, Kind::Node) {
return Some(Node::new(node, self.tree));
}
}
}
fn range(
&self,
start: Option<NonMaxUsize>,
mut end: Option<NonMaxUsize>,
) -> Option<(usize, usize)> {
let start = start?;
while let Some(last) = self.tree.get(end?.get())?.last {
end = Some(last);
}
Some((start.get(), end?.get()))
}
}
impl<'a, T> Iterator for Children<'a, T> {
type Item = Node<'a, T>;
fn next(&mut self) -> Option<Self::Item> {
let node = self.tree.get(self.start?.get())?;
self.start = node.next;
Some(Node::new(node, self.tree))
}
}
impl<'a, T> DoubleEndedIterator for Children<'a, T> {
fn next_back(&mut self) -> Option<Self::Item> {
let node = self.tree.get(self.end?.get())?;
self.end = node.prev;
Some(Node::new(node, self.tree))
}
}
impl<'a, T> Clone for Children<'a, T> {
fn clone(&self) -> Self {
*self
}
}
impl<'a, T> Copy for Children<'a, T> {}
