hyperast 0.2.0

Temporal code analyses at scale
Documentation 
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

pub trait Node {
    fn kind(&self) -> &str;
    fn start_byte(&self) -> usize;
    fn end_byte(&self) -> usize;
    fn child_count(&self) -> usize;
    // fn child<S:Node<'a>>(&self, i: usize) -> Option<S>;
    fn child(&self, i: usize) -> Option<Self>
    where
        Self: Sized;
    fn is_named(&self) -> bool;
    fn is_missing(&self) -> bool;
    fn is_error(&self) -> bool;

    fn extract_label(&self, text: &[u8]) -> Option<Vec<u8>> {
        let pos = self.start_byte();
        let end = self.end_byte();
        if self.has_label() {
            Some(text[pos..end].to_vec())
        } else {
            None
        }
    }
    fn has_label(&self) -> bool {
        if self.child_count() >= 1 {
            // TODO maybe get node role
            false
        } else if self.is_named() {
            true
        } else {
            false
        }
    }
}

pub trait NodeWithU16TypeId: Node {
    fn kind_id(&self) -> u16;
}

#[derive(PartialEq, Eq, Debug, Clone, Copy)]
pub enum Visibility {
    Visible,
    Hidden,
}

pub trait TreeCursor {
    type N: Node;
    fn node(&self) -> Self::N;
    fn role(&self) -> Option<std::num::NonZeroU16>;
    fn goto_parent(&mut self) -> bool;

    /// try to goto first child and return if it is visible
    /// NOTE should be overridden to process hidden nodes
    fn goto_first_child_extended(&mut self) -> Option<Visibility> {
        if self.goto_first_child() {
            Some(Visibility::Visible)
        } else {
            None
        }
    }
    /// try to goto next sibling and return if it is visible
    /// NOTE should be overridden to process hidden nodes
    fn goto_next_sibling_extended(&mut self) -> Option<Visibility> {
        if self.goto_next_sibling() {
            Some(Visibility::Visible)
        } else {
            None
        }
    }
    /// try to goto first child
    fn goto_first_child(&mut self) -> bool;

    /// try to goto next sibling
    fn goto_next_sibling(&mut self) -> bool;
}