wavepeek 2.1.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
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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158

#[allow(dead_code)]
#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize)]
#[serde(rename_all = "lowercase")]
pub enum DiagnosticKind {
    Info,
    Warning,
    Error,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum WarningDiagnosticCode {
    LimitDisabled,
    OutputTruncated,
    EmptyResult,
}

impl WarningDiagnosticCode {
    pub const fn as_str(self) -> &'static str {
        match self {
            Self::LimitDisabled => "WPK-W0001",
            Self::OutputTruncated => "WPK-W0002",
            Self::EmptyResult => "WPK-W0003",
        }
    }
}

#[allow(dead_code)]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum ErrorDiagnosticCode {}

#[allow(dead_code)]
impl ErrorDiagnosticCode {
    pub const fn as_str(self) -> &'static str {
        match self {}
    }
}

#[derive(Debug, Clone, PartialEq, Eq, serde::Serialize)]
pub struct Diagnostic {
    kind: DiagnosticKind,
    #[serde(skip_serializing_if = "Option::is_none")]
    code: Option<&'static str>,
    message: String,
}

impl Diagnostic {
    #[allow(dead_code)]
    pub fn info(message: impl Into<String>) -> Self {
        Self {
            kind: DiagnosticKind::Info,
            code: None,
            message: message.into(),
        }
    }

    pub fn warning(code: WarningDiagnosticCode, message: impl Into<String>) -> Self {
        Self {
            kind: DiagnosticKind::Warning,
            code: Some(code.as_str()),
            message: message.into(),
        }
    }

    #[allow(dead_code)]
    pub fn error(code: ErrorDiagnosticCode, message: impl Into<String>) -> Self {
        Self {
            kind: DiagnosticKind::Error,
            code: Some(code.as_str()),
            message: message.into(),
        }
    }

    #[cfg(test)]
    pub(crate) fn test_error(code: &'static str, message: impl Into<String>) -> Self {
        assert!(
            is_valid_error_code(code),
            "test diagnostic error code must match WPK-E####"
        );
        Self {
            kind: DiagnosticKind::Error,
            code: Some(code),
            message: message.into(),
        }
    }

    pub const fn kind(&self) -> DiagnosticKind {
        self.kind
    }

    pub const fn code(&self) -> Option<&'static str> {
        self.code
    }

    pub fn message(&self) -> &str {
        self.message.as_str()
    }
}

#[cfg(test)]
fn is_valid_error_code(code: &str) -> bool {
    let bytes = code.as_bytes();
    bytes.len() == 9
        && bytes[0..5] == *b"WPK-E"
        && bytes[5].is_ascii_digit()
        && bytes[6].is_ascii_digit()
        && bytes[7].is_ascii_digit()
        && bytes[8].is_ascii_digit()
}

#[cfg(test)]
mod tests {
    use serde_json::json;

    use super::{Diagnostic, DiagnosticKind, WarningDiagnosticCode};

    #[test]
    fn warning_diagnostic_serializes_with_stable_code() {
        let diagnostic = Diagnostic::warning(
            WarningDiagnosticCode::OutputTruncated,
            "truncated output to 1 entries",
        );

        assert_eq!(diagnostic.kind(), DiagnosticKind::Warning);
        assert_eq!(diagnostic.code(), Some("WPK-W0002"));
        assert_eq!(diagnostic.message(), "truncated output to 1 entries");
        assert_eq!(
            serde_json::to_value(&diagnostic).expect("diagnostic should serialize"),
            json!({
                "kind": "warning",
                "code": "WPK-W0002",
                "message": "truncated output to 1 entries"
            })
        );
    }

    #[test]
    fn info_diagnostic_omits_code() {
        let diagnostic = Diagnostic::info("catalog loaded");

        assert_eq!(diagnostic.kind(), DiagnosticKind::Info);
        assert_eq!(diagnostic.code(), None);
        assert_eq!(
            serde_json::to_value(&diagnostic).expect("diagnostic should serialize"),
            json!({
                "kind": "info",
                "message": "catalog loaded"
            })
        );
    }

    #[test]
    fn test_error_diagnostic_requires_error_code_shape() {
        let diagnostic = Diagnostic::test_error("WPK-E0001", "partial result failed");

        assert_eq!(diagnostic.kind(), DiagnosticKind::Error);
        assert_eq!(diagnostic.code(), Some("WPK-E0001"));
    }
}