312 lines
9.0 KiB
Rust
312 lines
9.0 KiB
Rust
//! Errors that can occur during transpilation.
|
|
|
|
use std::fmt::Display;
|
|
|
|
use getset::Getters;
|
|
|
|
use crate::{
|
|
base::{
|
|
log::{Message, Severity, SourceCodeDisplay},
|
|
source_file::Span,
|
|
},
|
|
semantic::error::{ConflictingFunctionNames, InvalidFunctionArguments, UnexpectedExpression},
|
|
};
|
|
|
|
use super::{expression::ExpectedType, FunctionData};
|
|
|
|
/// Errors that can occur during transpilation.
|
|
#[allow(clippy::module_name_repetitions, missing_docs)]
|
|
#[derive(Debug, thiserror::Error, Clone, PartialEq, Eq)]
|
|
pub enum TranspileError {
|
|
#[error(transparent)]
|
|
MissingFunctionDeclaration(#[from] MissingFunctionDeclaration),
|
|
#[error(transparent)]
|
|
UnexpectedExpression(#[from] UnexpectedExpression),
|
|
#[error("Lua code evaluation is disabled.")]
|
|
LuaDisabled,
|
|
#[error(transparent)]
|
|
LuaRuntimeError(#[from] LuaRuntimeError),
|
|
#[error(transparent)]
|
|
ConflictingFunctionNames(#[from] ConflictingFunctionNames),
|
|
#[error(transparent)]
|
|
InvalidFunctionArguments(#[from] InvalidFunctionArguments),
|
|
#[error(transparent)]
|
|
IllegalAnnotationContent(#[from] IllegalAnnotationContent),
|
|
#[error(transparent)]
|
|
MismatchedTypes(#[from] MismatchedTypes),
|
|
#[error(transparent)]
|
|
FunctionArgumentsNotAllowed(#[from] FunctionArgumentsNotAllowed),
|
|
#[error(transparent)]
|
|
AssignmentError(#[from] AssignmentError),
|
|
#[error(transparent)]
|
|
UnknownIdentifier(#[from] UnknownIdentifier),
|
|
#[error(transparent)]
|
|
MissingValue(#[from] MissingValue),
|
|
}
|
|
|
|
/// The result of a transpilation operation.
|
|
pub type TranspileResult<T> = Result<T, TranspileError>;
|
|
|
|
/// An error that occurs when a function declaration is missing.
|
|
#[derive(Debug, Clone, PartialEq, Eq, Getters)]
|
|
pub struct MissingFunctionDeclaration {
|
|
#[get = "pub"]
|
|
span: Span,
|
|
#[get = "pub"]
|
|
alternatives: Vec<FunctionData>,
|
|
}
|
|
|
|
impl MissingFunctionDeclaration {
|
|
#[cfg(feature = "shulkerbox")]
|
|
pub(super) fn from_scope(
|
|
identifier_span: Span,
|
|
scope: &std::sync::Arc<super::variables::Scope>,
|
|
) -> Self {
|
|
use itertools::Itertools as _;
|
|
|
|
let own_name = identifier_span.str();
|
|
let alternatives = scope
|
|
.get_all_variables()
|
|
.iter()
|
|
.filter_map(|(name, value)| {
|
|
let super::variables::VariableData::Function {
|
|
function_data: data,
|
|
..
|
|
} = value.as_ref()
|
|
else {
|
|
return None;
|
|
};
|
|
|
|
let normalized_distance = strsim::normalized_damerau_levenshtein(own_name, name);
|
|
(normalized_distance > 0.8 || strsim::damerau_levenshtein(own_name, name) < 3)
|
|
.then_some((normalized_distance, data))
|
|
})
|
|
.sorted_by(|a, b| a.0.partial_cmp(&b.0).unwrap_or(std::cmp::Ordering::Equal))
|
|
.map(|(_, data)| data)
|
|
.take(8)
|
|
.cloned()
|
|
.collect::<Vec<_>>();
|
|
|
|
Self {
|
|
alternatives,
|
|
span: identifier_span,
|
|
}
|
|
}
|
|
}
|
|
|
|
impl Display for MissingFunctionDeclaration {
|
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
|
let message = format!(
|
|
"no matching function declaration found for invocation of function `{}`",
|
|
self.span.str()
|
|
);
|
|
write!(f, "{}", Message::new(Severity::Error, message))?;
|
|
|
|
let help_message = if self.alternatives.is_empty() {
|
|
None
|
|
} else {
|
|
let mut message = String::from("did you mean ");
|
|
for (i, alternative) in self.alternatives.iter().enumerate() {
|
|
if i > 0 {
|
|
message.push_str(", ");
|
|
}
|
|
message.push_str(&format!("`{}`", alternative.identifier_span.str()));
|
|
}
|
|
Some(message + "?")
|
|
};
|
|
|
|
write!(
|
|
f,
|
|
"\n{}",
|
|
SourceCodeDisplay::new(&self.span, help_message.as_ref())
|
|
)
|
|
}
|
|
}
|
|
|
|
impl std::error::Error for MissingFunctionDeclaration {}
|
|
|
|
/// An error that occurs when a function declaration is missing.
|
|
#[allow(clippy::module_name_repetitions)]
|
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
|
pub struct LuaRuntimeError {
|
|
pub code_block: Span,
|
|
pub error_message: String,
|
|
}
|
|
|
|
impl Display for LuaRuntimeError {
|
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
|
let message = format!(
|
|
r#"error during lua code execution: "{}""#,
|
|
self.error_message
|
|
);
|
|
write!(f, "{}", Message::new(Severity::Error, message))?;
|
|
|
|
write!(
|
|
f,
|
|
"\n{}",
|
|
SourceCodeDisplay::new(&self.code_block, Option::<u8>::None)
|
|
)
|
|
}
|
|
}
|
|
|
|
impl std::error::Error for LuaRuntimeError {}
|
|
|
|
#[cfg(feature = "lua")]
|
|
impl LuaRuntimeError {
|
|
pub fn from_lua_err(err: &mlua::Error, span: Span) -> Self {
|
|
let err_string = err.to_string();
|
|
Self {
|
|
error_message: err_string
|
|
.strip_prefix("runtime error: ")
|
|
.unwrap_or(&err_string)
|
|
.to_string(),
|
|
code_block: span,
|
|
}
|
|
}
|
|
}
|
|
|
|
/// An error that occurs when an annotation has an illegal content.
|
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
|
pub struct IllegalAnnotationContent {
|
|
pub annotation: Span,
|
|
pub message: String,
|
|
}
|
|
|
|
impl Display for IllegalAnnotationContent {
|
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
|
let message = format!(
|
|
"illegal content in annotation `{}`: {}",
|
|
self.annotation.str(),
|
|
self.message
|
|
);
|
|
write!(f, "{}", Message::new(Severity::Error, message))?;
|
|
|
|
write!(
|
|
f,
|
|
"\n{}",
|
|
SourceCodeDisplay::new(&self.annotation, Option::<u8>::None)
|
|
)
|
|
}
|
|
}
|
|
|
|
impl std::error::Error for IllegalAnnotationContent {}
|
|
|
|
/// An error that occurs when an expression can not evaluate to the wanted type.
|
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
|
pub struct MismatchedTypes {
|
|
pub expression: Span,
|
|
pub expected_type: ExpectedType,
|
|
}
|
|
|
|
impl Display for MismatchedTypes {
|
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
|
let message = format!("expression can not evaluate to type {}", self.expected_type);
|
|
write!(f, "{}", Message::new(Severity::Error, message))?;
|
|
|
|
write!(
|
|
f,
|
|
"\n{}",
|
|
SourceCodeDisplay::new(&self.expression, Option::<u8>::None)
|
|
)
|
|
}
|
|
}
|
|
|
|
impl std::error::Error for MismatchedTypes {}
|
|
|
|
/// An error that occurs when an expression can not evaluate to the wanted type.
|
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
|
pub struct FunctionArgumentsNotAllowed {
|
|
pub arguments: Span,
|
|
pub message: String,
|
|
}
|
|
|
|
impl Display for FunctionArgumentsNotAllowed {
|
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
|
write!(f, "{}", Message::new(Severity::Error, &self.message))?;
|
|
|
|
write!(
|
|
f,
|
|
"\n{}",
|
|
SourceCodeDisplay::new(&self.arguments, Option::<u8>::None)
|
|
)
|
|
}
|
|
}
|
|
|
|
impl std::error::Error for FunctionArgumentsNotAllowed {}
|
|
|
|
/// An error that occurs when an expression can not evaluate to the wanted type.
|
|
#[expect(clippy::module_name_repetitions)]
|
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
|
pub struct AssignmentError {
|
|
pub identifier: Span,
|
|
pub message: String,
|
|
}
|
|
|
|
impl Display for AssignmentError {
|
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
|
write!(f, "{}", Message::new(Severity::Error, &self.message))?;
|
|
|
|
write!(
|
|
f,
|
|
"\n{}",
|
|
SourceCodeDisplay::new(&self.identifier, Option::<u8>::None)
|
|
)
|
|
}
|
|
}
|
|
|
|
impl std::error::Error for AssignmentError {}
|
|
|
|
/// An error that occurs when an unknown identifier is used.
|
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
|
pub struct UnknownIdentifier {
|
|
pub identifier: Span,
|
|
}
|
|
|
|
impl Display for UnknownIdentifier {
|
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
|
write!(
|
|
f,
|
|
"{}",
|
|
Message::new(
|
|
Severity::Error,
|
|
format!("The identifier {} is not defined.", self.identifier.str())
|
|
)
|
|
)?;
|
|
|
|
write!(
|
|
f,
|
|
"\n{}",
|
|
SourceCodeDisplay::new(&self.identifier, Option::<u8>::None)
|
|
)
|
|
}
|
|
}
|
|
|
|
impl std::error::Error for UnknownIdentifier {}
|
|
|
|
/// An error that occurs when there is a value expected but none provided.
|
|
#[derive(Debug, Clone, PartialEq, Eq)]
|
|
pub struct MissingValue {
|
|
pub expression: Span,
|
|
}
|
|
|
|
impl Display for MissingValue {
|
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
|
write!(
|
|
f,
|
|
"{}",
|
|
Message::new(
|
|
Severity::Error,
|
|
"The expression is expected to return a value, but no value is found."
|
|
)
|
|
)?;
|
|
|
|
write!(
|
|
f,
|
|
"\n{}",
|
|
SourceCodeDisplay::new(&self.expression, Option::<u8>::None)
|
|
)
|
|
}
|
|
}
|
|
|
|
impl std::error::Error for MissingValue {}
|