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 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
// SPDX-License-Identifier: Apache-2.0
//! Solidity parser diagnostics.
use crate::pt;
use crate::pt::Loc;
use std::fmt;
/// The level of a diagnostic.
#[derive(Clone, Debug, Hash, PartialOrd, Ord, PartialEq, Eq)]
pub enum Level {
/// Debug diagnostic level.
Debug,
/// Info diagnostic level.
Info,
/// Warning diagnostic level.
Warning,
/// Error diagnostic level.
Error,
}
impl fmt::Display for Level {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str(self.as_str())
}
}
impl Level {
/// Returns this type as a static string slice.
pub fn as_str(&self) -> &'static str {
match self {
Level::Debug => "debug",
Level::Info => "info",
Level::Warning => "warning",
Level::Error => "error",
}
}
}
/// The type of a diagnostic.
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub enum ErrorType {
/// No specific error type.
None,
/// Parser error.
ParserError,
/// Syntax error.
SyntaxError,
/// Declaration error.
DeclarationError,
/// Cast error.
CastError,
/// Type error.
TypeError,
/// Warning.
Warning,
}
/// A diagnostic note.
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct Note {
/// The code location of the note.
pub loc: pt::Loc,
/// The message of the note.
pub message: String,
}
/// A Solidity diagnostic.
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct Diagnostic {
/// The code location of the diagnostic.
pub loc: pt::Loc,
/// The level of the diagnostic.
pub level: Level,
/// The type of diagnostic.
pub ty: ErrorType,
/// The message of the diagnostic.
pub message: String,
/// Extra notes about the diagnostic.
pub notes: Vec<Note>,
}
impl Diagnostic {
/// Instantiate a new Diagnostic with the given location and message at the debug level.
pub fn debug(loc: Loc, message: String) -> Self {
Diagnostic {
level: Level::Debug,
ty: ErrorType::None,
loc,
message,
notes: Vec::new(),
}
}
/// Instantiate a new Diagnostic with the given location and message at the info level.
pub fn info(loc: Loc, message: String) -> Self {
Diagnostic {
level: Level::Info,
ty: ErrorType::None,
loc,
message,
notes: Vec::new(),
}
}
/// Instantiate a new parser error Diagnostic.
pub fn parser_error(loc: Loc, message: String) -> Self {
Diagnostic {
level: Level::Error,
ty: ErrorType::ParserError,
loc,
message,
notes: Vec::new(),
}
}
/// Instantiate a new syntax error Diagnostic.
pub fn error(loc: Loc, message: String) -> Self {
Diagnostic {
level: Level::Error,
ty: ErrorType::SyntaxError,
loc,
message,
notes: Vec::new(),
}
}
/// Instantiate a new declaration error Diagnostic.
pub fn decl_error(loc: Loc, message: String) -> Self {
Diagnostic {
level: Level::Error,
ty: ErrorType::DeclarationError,
loc,
message,
notes: Vec::new(),
}
}
/// Instantiate a new cast error error Diagnostic.
pub fn cast_error(loc: Loc, message: String) -> Self {
Diagnostic {
level: Level::Error,
ty: ErrorType::CastError,
loc,
message,
notes: Vec::new(),
}
}
/// Instantiate a new cast error error Diagnostic, with a note.
pub fn cast_error_with_note(loc: Loc, message: String, note_loc: Loc, note: String) -> Self {
Diagnostic {
level: Level::Error,
ty: ErrorType::CastError,
loc,
message,
notes: vec![Note {
loc: note_loc,
message: note,
}],
}
}
/// Instantiate a new type error error Diagnostic.
pub fn type_error(loc: Loc, message: String) -> Self {
Diagnostic {
level: Level::Error,
ty: ErrorType::TypeError,
loc,
message,
notes: Vec::new(),
}
}
/// Instantiate a new cast error Diagnostic at the warning level.
pub fn cast_warning(loc: Loc, message: String) -> Self {
Diagnostic {
level: Level::Warning,
ty: ErrorType::CastError,
loc,
message,
notes: Vec::new(),
}
}
/// Instantiate a new warning Diagnostic.
pub fn warning(loc: Loc, message: String) -> Self {
Diagnostic {
level: Level::Warning,
ty: ErrorType::Warning,
loc,
message,
notes: Vec::new(),
}
}
/// Instantiate a new warning Diagnostic, with a note.
pub fn warning_with_note(loc: Loc, message: String, note_loc: Loc, note: String) -> Self {
Diagnostic {
level: Level::Warning,
ty: ErrorType::Warning,
loc,
message,
notes: vec![Note {
loc: note_loc,
message: note,
}],
}
}
/// Instantiate a new warning Diagnostic, with multiple notes.
pub fn warning_with_notes(loc: Loc, message: String, notes: Vec<Note>) -> Self {
Diagnostic {
level: Level::Warning,
ty: ErrorType::Warning,
loc,
message,
notes,
}
}
/// Instantiate a new error Diagnostic, with a note.
pub fn error_with_note(loc: Loc, message: String, note_loc: Loc, note: String) -> Self {
Diagnostic {
level: Level::Error,
ty: ErrorType::None,
loc,
message,
notes: vec![Note {
loc: note_loc,
message: note,
}],
}
}
/// Instantiate a new error Diagnostic, with multiple notes.
pub fn error_with_notes(loc: Loc, message: String, notes: Vec<Note>) -> Self {
Diagnostic {
level: Level::Error,
ty: ErrorType::None,
loc,
message,
notes,
}
}
}