leo_passes/common/tree_node/
mod.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
// Copyright (C) 2019-2025 Provable Inc.
// This file is part of the Leo library.

// The Leo library is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// The Leo library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with the Leo library. If not, see <https://www.gnu.org/licenses/>.

use indexmap::IndexSet;

use leo_span::Symbol;
use std::{fmt::Debug, hash::Hash};

///  A binary search tree to store all paths through nested conditional blocks.
pub type ConditionalTreeNode = TreeNode<Symbol>;

/// A node in a graph.
pub trait Node: Copy + 'static + Eq + PartialEq + Debug + Hash {}

impl Node for Symbol {}

/// A node in a tree.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct TreeNode<N: Node> {
    /// The current depth.
    pub depth: usize,
    /// The current node.
    pub elements: IndexSet<N>, // TODO: Can optimize with bitmap if performance is bad.
    /// A counter.
    pub counter: usize,
}

impl<N: Node> TreeNode<N> {
    /// Initializes a new `TreeNode` from a vector of starting elements.
    pub fn new(elements: IndexSet<N>) -> Self {
        Self { depth: 0, elements, counter: 0 }
    }

    /// Adds a child to the current node.
    pub fn create_child(&mut self) -> TreeNode<N> {
        Self { depth: self.depth + 1, elements: self.elements.clone(), counter: self.counter }
    }

    /// Removes an element from the current node.
    /// If the element does not exist, increment an internal counter which later used to generate an error that the user attempted to await a future twice.
    /// Returns `true` if the element was removed but not the first one in the node.
    pub fn remove_element(&mut self, element: &N) -> bool {
        // Check if the element is the first one in the node.
        let is_not_first = match self.elements.first() {
            Some(first) => first != element,
            None => false,
        };
        // Remove the element from the node.
        if !self.elements.shift_remove(element) {
            self.counter += 1;
            false
        } else {
            is_not_first
        }
    }
}