circomspect-parser 2.2.0

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
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
159
160
161
162
163
164
165
166

use program_structure::ast::{Meta, Version};
use program_structure::report_code::ReportCode;
use program_structure::report::Report;
use program_structure::file_definition::{FileID, FileLocation};

pub struct UnclosedCommentError {
    pub location: FileLocation,
    pub file_id: FileID,
}

impl UnclosedCommentError {
    pub fn into_report(self) -> Report {
        let mut report = Report::error("Unterminated comment.".to_string(), ReportCode::ParseFail);
        report.add_primary(self.location, self.file_id, "Comment starts here.".to_string());
        report
    }
}

pub struct ParsingError {
    pub location: FileLocation,
    pub file_id: FileID,
    pub message: String,
}

impl ParsingError {
    pub fn into_report(self) -> Report {
        let mut report = Report::error(self.message, ReportCode::ParseFail);
        report.add_primary(
            self.location,
            self.file_id,
            "This token is invalid or unexpected here.".to_string(),
        );
        report
    }
}

pub struct FileOsError {
    pub path: String,
}
impl FileOsError {
    pub fn into_report(self) -> Report {
        Report::error(format!("Failed to open file `{}`.", self.path), ReportCode::ParseFail)
    }
}

pub struct IncludeError {
    pub path: String,
    pub file_id: Option<FileID>,
    pub file_location: FileLocation,
}
impl IncludeError {
    pub fn into_report(self) -> Report {
        let mut report =
            Report::error(format!("Failed to open file `{}`.", self.path), ReportCode::ParseFail);
        if let Some(file_id) = self.file_id {
            report.add_primary(self.file_location, file_id, "File included here.".to_string());
        }
        report
    }
}

pub struct MultipleMainError;
impl MultipleMainError {
    pub fn produce_report() -> Report {
        Report::error(
            "Multiple main components found in the project structure.".to_string(),
            ReportCode::MultipleMainInComponent,
        )
    }
}

pub struct CompilerVersionError {
    pub path: String,
    pub required_version: Version,
    pub version: Version,
}
impl CompilerVersionError {
    pub fn into_report(self) -> Report {
        let message = format!(
            "The file `{}` requires version {}, which is not supported by Circomspect (version {}).",
            self.path,
            version_string(&self.required_version),
            version_string(&self.version),
        );
        Report::error(message, ReportCode::CompilerVersionError)
    }
}

pub struct NoCompilerVersionWarning {
    pub path: String,
    pub version: Version,
}
impl NoCompilerVersionWarning {
    pub fn produce_report(error: Self) -> Report {
        Report::warning(
            format!(
                "The file `{}` does not include a version pragma. Assuming version {}.",
                error.path,
                version_string(&error.version)
            ),
            ReportCode::NoCompilerVersionWarning,
        )
    }
}

pub struct AnonymousComponentError {
    pub meta: Option<Meta>,
    pub message: String,
    pub primary: Option<String>,
}

impl AnonymousComponentError {
    pub fn new(meta: Option<&Meta>, message: &str, primary: Option<&str>) -> Self {
        AnonymousComponentError {
            meta: meta.cloned(),
            message: message.to_string(),
            primary: primary.map(ToString::to_string),
        }
    }

    pub fn into_report(self) -> Report {
        let mut report = Report::error(self.message, ReportCode::AnonymousComponentError);
        if let Some(meta) = self.meta {
            let primary = self.primary.unwrap_or_else(|| "The problem occurs here.".to_string());
            report.add_primary(meta.file_location(), meta.get_file_id(), primary);
        }
        report
    }

    pub fn boxed_report(meta: &Meta, message: &str) -> Box<Report> {
        Box::new(Self::new(Some(meta), message, None).into_report())
    }
}

pub struct TupleError {
    pub meta: Option<Meta>,
    pub message: String,
    pub primary: Option<String>,
}

impl TupleError {
    pub fn new(meta: Option<&Meta>, message: &str, primary: Option<&str>) -> Self {
        TupleError {
            meta: meta.cloned(),
            message: message.to_string(),
            primary: primary.map(ToString::to_string),
        }
    }

    pub fn into_report(self) -> Report {
        let mut report = Report::error(self.message, ReportCode::TupleError);
        if let Some(meta) = self.meta {
            let primary = self.primary.unwrap_or_else(|| "The problem occurs here.".to_string());
            report.add_primary(meta.file_location(), meta.get_file_id(), primary);
        }
        report
    }

    pub fn boxed_report(meta: &Meta, message: &str) -> Box<Report> {
        Box::new(Self::new(Some(meta), message, None).into_report())
    }
}

fn version_string(version: &Version) -> String {
    format!("{}.{}.{}", version.0, version.1, version.2)
}