wavepeek 0.5.0

Command-line tool for RTL waveform inspection with deterministic machine-friendly output.
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

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct Span {
    pub start: usize,
    pub end: usize,
}

impl Span {
    pub fn new(start: usize, end: usize) -> Self {
        Self { start, end }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum DiagnosticLayer {
    Parse,
    Semantic,
    Runtime,
}

impl DiagnosticLayer {
    fn as_str(self) -> &'static str {
        match self {
            Self::Parse => "parse",
            Self::Semantic => "semantic",
            Self::Runtime => "runtime",
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ExprDiagnostic {
    pub layer: DiagnosticLayer,
    pub code: &'static str,
    pub message: String,
    pub primary_span: Span,
    pub notes: Vec<String>,
}

impl ExprDiagnostic {
    pub fn render(&self, source: &str) -> String {
        let header = format!("{}:{}: {}", self.layer.as_str(), self.code, self.message);
        let location = format!(
            "--> span {}..{}",
            self.primary_span.start, self.primary_span.end
        );
        let excerpt = format!("source: {source}");
        let notes = if self.notes.is_empty() {
            String::new()
        } else {
            self.notes
                .iter()
                .map(|note| format!("note: {note}"))
                .collect::<Vec<_>>()
                .join("\n")
        };

        if notes.is_empty() {
            [header, location, excerpt].join("\n")
        } else {
            [header, location, excerpt, notes].join("\n")
        }
    }
}