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
use crate::non_max::NonMaxUsize;
use crate::{Node, Span};
mod without_tokens;
pub use self::without_tokens::WithoutTokens;
mod children;
pub use self::children::Children;
mod walk;
pub use self::walk::Walk;
/// The kind of a node in the [Tree].
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[non_exhaustive]
pub enum Kind {
/// A node.
Node,
/// The token and a corresponding span.
Token(Span),
}
#[derive(Debug, Clone, PartialEq, Eq)]
pub(crate) struct Links<T> {
pub(crate) data: T,
pub(crate) kind: Kind,
pub(crate) prev: Option<NonMaxUsize>,
pub(crate) next: Option<NonMaxUsize>,
pub(crate) first: Option<NonMaxUsize>,
pub(crate) last: Option<NonMaxUsize>,
}
/// A syntax tree.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Tree<T> {
tree: Box<[Links<T>]>,
last: Option<NonMaxUsize>,
}
impl<T> Tree<T> {
/// Construct a new tree.
pub(crate) fn new(tree: Box<[Links<T>]>, last: Option<NonMaxUsize>) -> Self {
Self { tree, last }
}
/// Calculate the span of the tree. If there is no span information
/// available, the range returned will be from 0 to [usize::MAX].
///
/// # Examples
///
/// ```
/// use syntree::{Span, TreeBuilder};
///
/// # fn main() -> anyhow::Result<()> {
/// let mut tree = TreeBuilder::new();
///
/// tree.start_node("root");
///
/// tree.start_node("number");
/// tree.token("number", 5);
/// tree.end_node()?;
///
/// tree.start_node("ident");
/// tree.token("ident", 2);
/// tree.end_node()?;
///
/// tree.end_node()?;
///
/// let tree = tree.build()?;
///
/// assert_eq!(tree.span(), Span::new(0, 7));
/// # Ok(()) }
/// ```
pub fn span(&self) -> Span {
if let Some(span) = self.children().span() {
span
} else {
Span::new(0, usize::MAX)
}
}
/// Check if the current tree is empty. In that it doesn't have any
/// childrens at the root of the tree.
///
/// # Examples
///
/// ```
/// use syntree::TreeBuilder;
///
/// # fn main() -> anyhow::Result<()> {
/// let mut tree = TreeBuilder::<()>::new();
/// let tree = tree.build()?;
/// assert!(tree.is_empty());
/// # Ok(()) }
/// ```
pub fn is_empty(&self) -> bool {
self.last.is_none()
}
/// Get all root nodes in the tree.
///
/// # Examples
///
/// ```
/// use syntree::{Span, TreeBuilder};
///
/// # fn main() -> anyhow::Result<()> {
/// let mut tree = TreeBuilder::new();
///
/// tree.start_node("root1");
/// tree.start_node("child1");
/// tree.end_node()?;
/// tree.end_node()?;
///
/// tree.start_node("root2");
/// tree.end_node()?;
///
/// let tree = tree.build()?;
/// let mut it = tree.children();
///
/// assert_eq!(it.next().map(|n| *n.data()), Some("root1"));
/// assert_eq!(it.next().map(|n| *n.data()), Some("root2"));
/// assert!(it.next().is_none());
/// # Ok(()) }
/// ```
pub fn children(&self) -> Children<'_, T> {
Children {
tree: self.tree.as_ref(),
start: NonMaxUsize::new(0),
end: self.last,
}
}
/// 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.walk().map(|n| *n.data()).collect::<Vec<_>>();
/// assert_eq!(nodes, vec!["root", "c1", "c2", "c3", "c4", "c5", "c6"]);
/// # Ok(()) }
/// ```
///
/// Walking backwards.
///
/// ```
/// # fn main() -> anyhow::Result<()> {
/// let tree = syntree::tree! {
/// "root" => {
/// "c1" => {
/// "c2",
/// "c3",
/// "c4",
/// },
/// "c5",
/// "c6"
/// }
/// };
///
/// let nodes = tree.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<'_, T> {
Walk {
tree: self.tree.as_ref(),
range: self.range(self.last),
}
}
/// Get the first child node in the tree.
///
/// # Examples
///
/// ```
/// # fn main() -> anyhow::Result<()> {
/// let tree = syntree::tree! {
/// "first" => {
/// "child"
/// },
/// "last" => {
/// "child2"
/// }
/// };
///
/// assert_eq!(tree.first().map(|n| *n.data()), Some("first"));
/// # Ok(()) }
/// ```
pub fn first(&self) -> Option<Node<'_, T>> {
self.node_at(NonMaxUsize::new(0))
}
/// Get the last child node in the tree.
///
/// # Examples
///
/// ```
/// # fn main() -> anyhow::Result<()> {
/// let tree = syntree::tree! {
/// "first" => {
/// "child"
/// },
/// "last" => {
/// "child2"
/// }
/// };
///
/// assert_eq!(tree.last().map(|n| *n.data()), Some("last"));
/// # Ok(()) }
/// ```
pub fn last(&self) -> Option<Node<'_, T>> {
self.node_at(self.last)
}
fn node_at(&self, index: Option<NonMaxUsize>) -> Option<Node<'_, T>> {
let cur = self.tree.get(index?.get())?;
Some(Node::new(cur, &self.tree))
}
fn range(&self, mut end: Option<NonMaxUsize>) -> Option<(usize, usize)> {
while let Some(last) = self.tree.get(end?.get())?.last {
end = Some(last);
}
Some((0, end?.get()))
}
}
