solang_parser/
diagnostics.rs

1// SPDX-License-Identifier: Apache-2.0
2
3//! Solidity parser diagnostics.
4
5use crate::pt;
6use crate::pt::Loc;
7use std::fmt;
8
9/// The level of a diagnostic.
10#[derive(Clone, Debug, Hash, PartialOrd, Ord, PartialEq, Eq)]
11pub enum Level {
12    /// Debug diagnostic level.
13    Debug,
14    /// Info diagnostic level.
15    Info,
16    /// Warning diagnostic level.
17    Warning,
18    /// Error diagnostic level.
19    Error,
20}
21
22impl fmt::Display for Level {
23    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
24        f.write_str(self.as_str())
25    }
26}
27
28impl Level {
29    /// Returns this type as a static string slice.
30    pub fn as_str(&self) -> &'static str {
31        match self {
32            Level::Debug => "debug",
33            Level::Info => "info",
34            Level::Warning => "warning",
35            Level::Error => "error",
36        }
37    }
38}
39
40/// The type of a diagnostic.
41#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
42pub enum ErrorType {
43    /// No specific error type.
44    None,
45    /// Parser error.
46    ParserError,
47    /// Syntax error.
48    SyntaxError,
49    /// Declaration error.
50    DeclarationError,
51    /// Cast error.
52    CastError,
53    /// Type error.
54    TypeError,
55    /// Warning.
56    Warning,
57}
58
59/// A diagnostic note.
60#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
61pub struct Note {
62    /// The code location of the note.
63    pub loc: pt::Loc,
64    /// The message of the note.
65    pub message: String,
66}
67
68/// A Solidity diagnostic.
69#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
70pub struct Diagnostic {
71    /// The code location of the diagnostic.
72    pub loc: pt::Loc,
73    /// The level of the diagnostic.
74    pub level: Level,
75    /// The type of diagnostic.
76    pub ty: ErrorType,
77    /// The message of the diagnostic.
78    pub message: String,
79    /// Extra notes about the diagnostic.
80    pub notes: Vec<Note>,
81}
82
83impl Diagnostic {
84    /// Instantiate a new Diagnostic with the given location and message at the debug level.
85    pub fn debug(loc: Loc, message: String) -> Self {
86        Diagnostic {
87            level: Level::Debug,
88            ty: ErrorType::None,
89            loc,
90            message,
91            notes: Vec::new(),
92        }
93    }
94
95    /// Instantiate a new Diagnostic with the given location and message at the info level.
96    pub fn info(loc: Loc, message: String) -> Self {
97        Diagnostic {
98            level: Level::Info,
99            ty: ErrorType::None,
100            loc,
101            message,
102            notes: Vec::new(),
103        }
104    }
105
106    /// Instantiate a new parser error Diagnostic.
107    pub fn parser_error(loc: Loc, message: String) -> Self {
108        Diagnostic {
109            level: Level::Error,
110            ty: ErrorType::ParserError,
111            loc,
112            message,
113            notes: Vec::new(),
114        }
115    }
116
117    /// Instantiate a new syntax error Diagnostic.
118    pub fn error(loc: Loc, message: String) -> Self {
119        Diagnostic {
120            level: Level::Error,
121            ty: ErrorType::SyntaxError,
122            loc,
123            message,
124            notes: Vec::new(),
125        }
126    }
127
128    /// Instantiate a new declaration error Diagnostic.
129    pub fn decl_error(loc: Loc, message: String) -> Self {
130        Diagnostic {
131            level: Level::Error,
132            ty: ErrorType::DeclarationError,
133            loc,
134            message,
135            notes: Vec::new(),
136        }
137    }
138
139    /// Instantiate a new cast error error Diagnostic.
140    pub fn cast_error(loc: Loc, message: String) -> Self {
141        Diagnostic {
142            level: Level::Error,
143            ty: ErrorType::CastError,
144            loc,
145            message,
146            notes: Vec::new(),
147        }
148    }
149
150    /// Instantiate a new cast error error Diagnostic, with a note.
151    pub fn cast_error_with_note(loc: Loc, message: String, note_loc: Loc, note: String) -> Self {
152        Diagnostic {
153            level: Level::Error,
154            ty: ErrorType::CastError,
155            loc,
156            message,
157            notes: vec![Note {
158                loc: note_loc,
159                message: note,
160            }],
161        }
162    }
163
164    /// Instantiate a new type error error Diagnostic.
165    pub fn type_error(loc: Loc, message: String) -> Self {
166        Diagnostic {
167            level: Level::Error,
168            ty: ErrorType::TypeError,
169            loc,
170            message,
171            notes: Vec::new(),
172        }
173    }
174
175    /// Instantiate a new cast error Diagnostic at the warning level.
176    pub fn cast_warning(loc: Loc, message: String) -> Self {
177        Diagnostic {
178            level: Level::Warning,
179            ty: ErrorType::CastError,
180            loc,
181            message,
182            notes: Vec::new(),
183        }
184    }
185
186    /// Instantiate a new warning Diagnostic.
187    pub fn warning(loc: Loc, message: String) -> Self {
188        Diagnostic {
189            level: Level::Warning,
190            ty: ErrorType::Warning,
191            loc,
192            message,
193            notes: Vec::new(),
194        }
195    }
196
197    /// Instantiate a new warning Diagnostic, with a note.
198    pub fn warning_with_note(loc: Loc, message: String, note_loc: Loc, note: String) -> Self {
199        Diagnostic {
200            level: Level::Warning,
201            ty: ErrorType::Warning,
202            loc,
203            message,
204            notes: vec![Note {
205                loc: note_loc,
206                message: note,
207            }],
208        }
209    }
210
211    /// Instantiate a new warning Diagnostic, with multiple notes.
212    pub fn warning_with_notes(loc: Loc, message: String, notes: Vec<Note>) -> Self {
213        Diagnostic {
214            level: Level::Warning,
215            ty: ErrorType::Warning,
216            loc,
217            message,
218            notes,
219        }
220    }
221
222    /// Instantiate a new error Diagnostic, with a note.
223    pub fn error_with_note(loc: Loc, message: String, note_loc: Loc, note: String) -> Self {
224        Diagnostic {
225            level: Level::Error,
226            ty: ErrorType::None,
227            loc,
228            message,
229            notes: vec![Note {
230                loc: note_loc,
231                message: note,
232            }],
233        }
234    }
235
236    /// Instantiate a new error Diagnostic, with multiple notes.
237    pub fn error_with_notes(loc: Loc, message: String, notes: Vec<Note>) -> Self {
238        Diagnostic {
239            level: Level::Error,
240            ty: ErrorType::None,
241            loc,
242            message,
243            notes,
244        }
245    }
246}
solang_parser/diagnostics.rs

solang_parser/
diagnostics.rs
