savvy 0.9.3

//! Error types. See [Error handling] section of the user guide.
//!
//! [Error handling]: https://yutannihilation.github.io/savvy/guide/error.html

use savvy_ffi::SEXP;

/// Represents savvy's error. Use [`savvy_err!`] macro to create a new error.
#[derive(Debug)]
pub enum Error {
    /// Type mismatch.
    UnexpectedType { expected: String, actual: String },

    /// Got a vector for an argument of scalar.
    NotScalar,

    /// An error raised when the program aborted, e.g. R's `stop()` or Rust's
    /// `panic!()`. The contained `SEXP` is supposed to be passed to
    /// `R_ContinueUnwind()` in the wrapper C code.
    Aborted(SEXP),

    /// The external pointer is null pointer (typically, this means it got
    /// GC-ed).
    InvalidPointer,

    /// Savvy fails to parse the provided R code.
    InvalidRCode(String),

    /// An error to propagate the error message to the R session.
    GeneralError(String),
}

impl Error {
    pub fn new<T: ToString>(msg: T) -> Self {
        Self::GeneralError(msg.to_string())
    }
}

pub type Result<T> = std::result::Result<T, Error>;

impl std::fmt::Display for Error {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Error::UnexpectedType { expected, actual } => {
                write!(f, "Must be {expected}, not {actual}")
            }
            Error::NotScalar => write!(f, "Must be length 1 of non-missing value"),
            Error::Aborted(_) => write!(f, "Aborted due to some error"),
            Error::InvalidPointer => {
                write!(f, "This external pointer is already consumed or deleted")
            }
            Error::InvalidRCode(code) => write!(f, "Failed to parse R code: {code}"),
            Error::GeneralError(msg) => write!(f, "{msg}"),
        }
    }
}

impl crate::error::Error {
    pub fn with_arg_name(self, arg_name: &str) -> Self {
        match self {
            Error::UnexpectedType { expected, actual } => Error::GeneralError(format!(
                "Argument `{arg_name}` must be {expected}, not {actual}"
            )),
            Error::NotScalar => Error::GeneralError(format!(
                "Argument `{arg_name}` must be length 1 of non-missing value"
            )),
            Error::InvalidPointer => Error::GeneralError(format!(
                "Argument `{arg_name}` is already consumed or deleted"
            )),
            _ => self,
        }
    }
}

// To avoid the conflict with `From<dyn std::error::Error> for savvy::Error` and
// `From<T> for T`, `savvy::Error` cannot implement `std::error::Error` trait
// directly. Instead, it implements `From<Error> for Box<dyn std::error::Error>`.
// This struct is to provide the std::error::Error trait.
//
// This idea is from anyhow crate. cf. https://github.com/dtolnay/anyhow/blob/master/src/error.rs
#[derive(Debug)]
struct ErrorImpl(String);

impl std::fmt::Display for ErrorImpl {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.0)
    }
}

unsafe impl Send for ErrorImpl {}
unsafe impl Sync for ErrorImpl {}

impl std::error::Error for ErrorImpl {}

impl From<Error> for Box<dyn std::error::Error + 'static> {
    fn from(value: Error) -> Self {
        Box::new(ErrorImpl(value.to_string()))
    }
}

impl From<Error> for Box<dyn std::error::Error + Send + Sync + 'static> {
    fn from(value: Error) -> Self {
        Box::new(ErrorImpl(value.to_string()))
    }
}

// Note: Unlike anyhow::Error, this doesn't require Send and Sync. This is
// because,
//
// - anyhow preserves the original implementation for std::error::Error by
//   accessing vtable directly.
// - anyhow needs to be async-aware (cf.
//   https://github.com/dtolnay/anyhow/issues/81)
//
// However, savvy creates a string immediately here (because only a string can
// be propagated to R session), so both won't be a problem.
#[cfg(not(feature = "use-custom-error"))]
impl<E> From<E> for Error
where
    E: std::error::Error + 'static,
{
    fn from(value: E) -> Self {
        Self::new(value)
    }
}

#[cfg(feature = "use-custom-error")]
impl From<Box<dyn std::error::Error>> for Error {
    fn from(e: Box<dyn std::error::Error>) -> Error {
        Error::new(&e.to_string())
    }
}

// In the case of no automatic error conversion, provide some common conversion
// for convenience.

#[cfg(feature = "use-custom-error")]
impl From<std::convert::Infallible> for Error {
    fn from(value: std::convert::Infallible) -> Self {
        Self::new(value)
    }
}

#[cfg(feature = "use-custom-error")]
impl From<std::num::TryFromIntError> for Error {
    fn from(value: std::num::TryFromIntError) -> Self {
        Self::new(value)
    }
}

// For CString
#[cfg(feature = "use-custom-error")]
impl From<std::ffi::NulError> for Error {
    fn from(value: std::ffi::NulError) -> Self {
        Self::new(value)
    }
}

// For Mutex
#[cfg(feature = "use-custom-error")]
impl<T> From<std::sync::PoisonError<T>> for Error {
    fn from(value: std::sync::PoisonError<T>) -> Self {
        Self::new(value)
    }
}

#[cfg(feature = "use-custom-error")]
impl From<String> for Error {
    fn from(value: String) -> Self {
        Self::new(value)
    }
}

#[cfg(feature = "use-custom-error")]
impl From<&str> for Error {
    fn from(value: &str) -> Self {
        Self::new(value)
    }
}