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

use crate::{AstCursor, ByteRange, CodeRange};
use std::{borrow::Cow, str::Utf8Error};

/// Represents an AST node and offers convenient AST-specific functionality.
///
/// This trait should be free from dependencies on TreeSitter. This also implies
/// it should not expose details about the node that may make it infeasible to
/// implement the trait by implementations that use different node
/// representations internally.
pub trait AstNode: std::fmt::Debug + Sized {
    /// Returns an iterator over the node's ancestors, starting with the node
    /// itself and moving up to the root.
    fn ancestors(&self) -> impl Iterator<Item = Self>;

    /// Returns an iterator over the node's children.
    fn children(&self) -> impl Iterator<Item = Self>;

    /// Returns the node's parent.
    ///
    /// Returns `None` if this is the root node.
    fn parent(&self) -> Option<Self>;

    /// Returns the next node in the tree, ignoring trivia such as whitespace.
    fn next_named_node(&self) -> Option<Self>;

    /// Returns the previous node in the tree, ignoring trivia such as
    /// whitespace.
    fn previous_named_node(&self) -> Option<Self>;

    /// Returns the next adjacent node.
    fn next_sibling(&self) -> Option<Self>;

    /// Returns the previous adjacent node.
    fn previous_sibling(&self) -> Option<Self>;

    /// Returns the text representation of the node.
    fn text(&self) -> Result<Cow<str>, Utf8Error>;

    /// Returns the byte range of the node.
    fn byte_range(&self) -> ByteRange;

    /// Returns the code range of the node.
    fn code_range(&self) -> CodeRange;

    /// Returns the full source code of the parse tree to which the node
    /// belongs.
    fn full_source(&self) -> &str;

    /// Returns a cursor for traversing the tree, starting at the current node.
    fn walk(&self) -> impl AstCursor<Node = Self>;
}