dwfv 0.5.0

A simple digital waveform viewer with vi-like key bindings
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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

// SPDX-License-Identifier: MIT
use super::signal::Signal;
use std::collections::{BTreeMap, BTreeSet};

#[derive(Debug)]
pub enum ScopeChild {
    Signal,
    Scope,
}

#[derive(Debug)]
pub struct Scope {
    pub name: String,
    signals: BTreeSet<String>,
    scopes: BTreeMap<String, Scope>,
    path: Vec<String>,
}

impl Scope {
    pub fn new(name: String) -> Scope {
        Scope {
            name,
            signals: BTreeSet::new(),
            scopes: BTreeMap::new(),
            path: Vec::new(),
        }
    }

    pub fn add_scope(&mut self, path: &[&str]) {
        if let Some(name) = path.first() {
            match self.scopes.get(*name) {
                Some(_) => self.get_scope(name).unwrap().add_scope(&path[1..]),
                None => {
                    let mut s = Scope::new(name.to_string());
                    s.path = self.path.clone();
                    s.path.push(self.name.clone());
                    s.add_scope(&path[1..]);
                    self.scopes.insert(s.name.clone(), s);
                }
            }
        }
    }

    pub fn get_scope(&mut self, name: &str) -> Option<&mut Scope> {
        self.scopes.get_mut(name)
    }

    pub fn get_scope_by_path(&mut self, path: &[&str]) -> Option<&mut Scope> {
        match path.first() {
            Some(name) => match self.scopes.get(*name) {
                Some(_) => self.get_scope(name).unwrap().get_scope_by_path(&path[1..]),
                None => None,
            },
            None => Some(self),
        }
    }

    pub fn add_signal(&mut self, signal: &mut Signal) {
        self.signals.insert(signal.id.clone());
        signal.path = self.path.clone();
        signal.path.push(self.name.clone())
    }

    fn _traverse<T, F: FnMut(&str, &ScopeChild, u64) -> T>(&self, depth: u64, f: &mut F) {
        for name in &self.signals {
            f(name, &ScopeChild::Signal, depth);
        }

        for (name, scope) in &self.scopes {
            f(name, &ScopeChild::Scope, depth);
            scope._traverse(depth + 1, f);
        }
    }

    pub fn traverse<T, F: FnMut(&str, &ScopeChild, u64) -> T>(&self, f: &mut F) {
        self._traverse(0, f)
    }
}

#[cfg(test)]
mod test {
    use super::*;

    #[test]
    fn scope() {
        let mut s = Scope::new(String::from("top"));
        s.add_scope(&["foo", "bar"]);

        let foo = s.get_scope_by_path(&["foo"]).expect("Path doesn't exist");
        foo.add_signal(&mut Signal::new("bar", "bar", 42));

        s.get_scope_by_path(&["foo", "bar"])
            .expect("Path doesn't exist");
    }
}