circomspect-program-structure 2.1.4

Support crate for the Circomspect static analyzer
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

use crate::report_code::ReportCode;
use crate::report::Report;
use crate::file_definition::{FileID, FileLocation};

/// Error enum for SSA generation errors.
#[derive(Debug)]
pub enum SSAError {
    /// The variable is read before it is declared/written.
    UndefinedVariableError { name: String, file_id: Option<FileID>, location: FileLocation },
}

pub type SSAResult<T> = Result<T, SSAError>;

impl SSAError {
    pub fn into_report(&self) -> Report {
        use SSAError::*;
        match self {
            UndefinedVariableError { name, file_id, location } => {
                let mut report = Report::error(
                    format!("The variable `{name}` is used before it is defined."),
                    ReportCode::UninitializedSymbolInExpression,
                );
                if let Some(file_id) = file_id {
                    report.add_primary(
                        location.clone(),
                        *file_id,
                        format!("The variable `{name}` is first seen here."),
                    );
                }
                report
            }
        }
    }
}

impl From<SSAError> for Report {
    fn from(error: SSAError) -> Report {
        error.into_report()
    }
}