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

use crate::atom::Atom;
use crate::atom::AtomKind;
use crate::block::Block;
use crate::check_error::{CheckError, OpenMap, PathedName};
use crate::named_path::NamedPath;
use crate::probe::Probe;

#[derive(Default)]
struct CheckConnected {
    path: NamedPath,
    namespace: NamedPath,
    failures: OpenMap,
}

impl Probe for CheckConnected {
    fn visit_start_scope(&mut self, name: &str, _node: &dyn Block) {
        self.path.push(name);
        self.namespace.reset();
    }

    fn visit_start_namespace(&mut self, name: &str, _node: &dyn Block) {
        self.namespace.push(name);
    }

    fn visit_atom(&mut self, name: &str, signal: &dyn Atom) {
        let is_top_scope = self.path.to_string().eq("uut");
        let signal_is_connected = signal.connected();
        let signal_is_input =
            [AtomKind::InputParameter, AtomKind::InOutParameter].contains(&signal.kind());
        if !(signal_is_connected | (signal_is_input && is_top_scope)) {
            dbg!(&signal.kind());
            self.failures.insert(
                signal.id(),
                dbg!(PathedName {
                    path: self.path.to_string(),
                    name: if self.namespace.is_empty() {
                        name.to_string()
                    } else {
                        format!("{}${name}", self.namespace.to_string())
                    }
                }),
            );
        }
    }

    fn visit_end_namespace(&mut self, _name: &str, _node: &dyn Block) {
        self.namespace.pop();
    }

    fn visit_end_scope(&mut self, _name: &str, _node: &dyn Block) {
        self.path.pop();
    }
}

/// Check to see if a circuit is properly connected (no undriven inputs, or
/// multiply-driven outputs).  You can call this directly on a circuit of yours
/// if you want to check that it is correctly connected internally.  
/// ```rust
/// use rust_hdl_core::prelude::*;
///
/// #[derive(LogicBlock, Default)]
/// struct Broken {
///     pub I: Signal<In, Bit>,
///     pub O: Signal<Out, Bit>,
/// }
///
/// impl Logic for Broken {
///    #[hdl_gen]
///    fn update(&mut self) {
///       // Purposely left blank... circuit is broken!
///    }
/// }
///
/// let mut uut = TopWrap::new(Broken::default()); // <- we use TopWrap since we want Broken to not be the top
/// uut.connect_all();
/// assert!(check_connected(&uut).is_err())
/// ```
pub fn check_connected(uut: &dyn Block) -> Result<(), CheckError> {
    let mut visitor = CheckConnected::default();
    uut.accept("uut", &mut visitor);
    if visitor.failures.is_empty() {
        Ok(())
    } else {
        Err(CheckError::OpenSignal(visitor.failures))
    }
}