2020-12-15 10:53:31 +00:00
|
|
|
// Take a look at the license at the top of the repository in the LICENSE file.
|
2017-12-20 17:52:57 +00:00
|
|
|
|
2022-12-27 10:22:37 +00:00
|
|
|
use glib::{prelude::*, IntoGStr};
|
2023-01-03 18:58:25 +00:00
|
|
|
use thiserror::Error;
|
2017-12-20 17:52:57 +00:00
|
|
|
|
|
|
|
#[macro_export]
|
2020-12-20 15:09:22 +00:00
|
|
|
macro_rules! error_msg(
|
2017-12-20 17:52:57 +00:00
|
|
|
($err:expr, ($($msg:tt)*), [$($dbg:tt)*]) => { {
|
|
|
|
$crate::ErrorMessage::new(&$err, Some(format!($($msg)*).as_ref()),
|
|
|
|
Some(format!($($dbg)*).as_ref()),
|
2023-01-16 09:10:21 +00:00
|
|
|
file!(), $crate::glib::function_name!(), line!())
|
2017-12-20 17:52:57 +00:00
|
|
|
}};
|
|
|
|
($err:expr, ($($msg:tt)*)) => { {
|
|
|
|
$crate::ErrorMessage::new(&$err, Some(format!($($msg)*).as_ref()),
|
|
|
|
None,
|
2023-01-16 09:10:21 +00:00
|
|
|
file!(), $crate::glib::function_name!(), line!())
|
2017-12-20 17:52:57 +00:00
|
|
|
}};
|
|
|
|
|
|
|
|
($err:expr, [$($dbg:tt)*]) => { {
|
|
|
|
$crate::ErrorMessage::new(&$err, None,
|
|
|
|
Some(format!($($dbg)*).as_ref()),
|
2023-01-16 09:10:21 +00:00
|
|
|
file!(), $crate::glib::function_name!(), line!())
|
2017-12-20 17:52:57 +00:00
|
|
|
}};
|
|
|
|
);
|
|
|
|
|
2020-01-10 11:33:03 +00:00
|
|
|
#[derive(Clone, Debug, PartialEq, Eq, Error)]
|
|
|
|
#[error("Error {:?} ({:?}) at {}:{}", .message, .debug, .filename, .line)]
|
2017-12-20 17:52:57 +00:00
|
|
|
pub struct ErrorMessage {
|
2018-07-30 08:46:40 +00:00
|
|
|
pub(crate) error_domain: glib::Quark,
|
2017-12-20 17:52:57 +00:00
|
|
|
pub(crate) error_code: i32,
|
|
|
|
pub(crate) message: Option<String>,
|
|
|
|
pub(crate) debug: Option<String>,
|
|
|
|
pub(crate) filename: &'static str,
|
|
|
|
pub(crate) function: &'static str,
|
|
|
|
pub(crate) line: u32,
|
|
|
|
}
|
|
|
|
|
|
|
|
impl ErrorMessage {
|
2020-11-21 13:46:48 +00:00
|
|
|
pub fn new<T: crate::MessageErrorDomain>(
|
2017-12-20 17:52:57 +00:00
|
|
|
error: &T,
|
2019-05-23 18:19:24 +00:00
|
|
|
message: Option<&str>,
|
|
|
|
debug: Option<&str>,
|
2017-12-20 17:52:57 +00:00
|
|
|
filename: &'static str,
|
|
|
|
function: &'static str,
|
|
|
|
line: u32,
|
|
|
|
) -> ErrorMessage {
|
2022-12-25 10:47:02 +00:00
|
|
|
skip_assert_initialized!();
|
2018-07-20 07:21:06 +00:00
|
|
|
let error_domain = T::domain();
|
|
|
|
let error_code = error.code();
|
2017-12-20 17:52:57 +00:00
|
|
|
|
|
|
|
ErrorMessage {
|
2018-07-20 07:21:06 +00:00
|
|
|
error_domain,
|
|
|
|
error_code,
|
2017-12-20 17:52:57 +00:00
|
|
|
message: message.map(String::from),
|
|
|
|
debug: debug.map(String::from),
|
2018-07-20 07:21:06 +00:00
|
|
|
filename,
|
|
|
|
function,
|
|
|
|
line,
|
2017-12-20 17:52:57 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2019-01-24 19:33:31 +00:00
|
|
|
#[macro_export]
|
2020-12-20 15:09:22 +00:00
|
|
|
macro_rules! loggable_error(
|
2019-01-24 19:33:31 +00:00
|
|
|
// Plain strings
|
|
|
|
($cat:expr, $msg:expr) => {
|
2020-12-17 22:38:06 +00:00
|
|
|
$crate::LoggableError::new($cat.clone(), $crate::glib::bool_error!($msg))
|
2019-01-24 19:33:31 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
// Format strings
|
|
|
|
($cat:expr, $($msg:tt)*) => { {
|
2020-12-17 22:38:06 +00:00
|
|
|
$crate::LoggableError::new($cat.clone(), $crate::glib::bool_error!($($msg)*))
|
2019-01-24 19:33:31 +00:00
|
|
|
}};
|
|
|
|
);
|
|
|
|
|
|
|
|
#[macro_export]
|
2020-12-20 15:09:22 +00:00
|
|
|
macro_rules! result_from_gboolean(
|
2019-01-24 19:33:31 +00:00
|
|
|
// Plain strings
|
2020-11-21 13:46:48 +00:00
|
|
|
($ffi_bool:expr, $cat:expr, $msg:expr) => {
|
2020-12-17 22:38:06 +00:00
|
|
|
$crate::glib::result_from_gboolean!($ffi_bool, $msg)
|
2019-02-28 08:54:32 +00:00
|
|
|
.map_err(|bool_err| $crate::LoggableError::new($cat.clone(), bool_err))
|
2019-01-24 19:33:31 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
// Format strings
|
2020-11-21 13:46:48 +00:00
|
|
|
($ffi_bool:expr, $cat:expr, $($msg:tt)*) => { {
|
2020-12-17 22:38:06 +00:00
|
|
|
$crate::glib::result_from_gboolean!($ffi_bool, $($msg)*)
|
2019-02-28 08:54:32 +00:00
|
|
|
.map_err(|bool_err| $crate::LoggableError::new($cat.clone(), bool_err))
|
2019-01-24 19:33:31 +00:00
|
|
|
}};
|
|
|
|
);
|
|
|
|
|
2020-01-10 11:33:03 +00:00
|
|
|
#[derive(Debug, Clone, Error)]
|
2021-04-12 10:01:22 +00:00
|
|
|
#[error("Error {:?}: {:?} at {}:{}", .category.name(), .bool_error.message, .bool_error.filename, .bool_error.line)]
|
2019-01-24 19:33:31 +00:00
|
|
|
pub struct LoggableError {
|
2020-11-21 13:46:48 +00:00
|
|
|
category: crate::DebugCategory,
|
2019-01-24 19:33:31 +00:00
|
|
|
bool_error: glib::BoolError,
|
|
|
|
}
|
|
|
|
|
|
|
|
impl LoggableError {
|
2020-11-21 13:46:48 +00:00
|
|
|
pub fn new(category: crate::DebugCategory, bool_error: glib::BoolError) -> LoggableError {
|
2022-12-25 10:47:02 +00:00
|
|
|
skip_assert_initialized!();
|
2019-01-24 19:33:31 +00:00
|
|
|
LoggableError {
|
2019-02-28 08:54:32 +00:00
|
|
|
category,
|
2019-01-24 19:33:31 +00:00
|
|
|
bool_error,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-12-27 10:22:37 +00:00
|
|
|
#[inline(never)]
|
2019-01-24 19:33:31 +00:00
|
|
|
pub fn log(&self) {
|
2022-12-27 10:22:37 +00:00
|
|
|
self.bool_error.filename.run_with_gstr(|filename| {
|
|
|
|
self.category.log(
|
|
|
|
None::<&glib::Object>,
|
|
|
|
crate::DebugLevel::Error,
|
|
|
|
filename,
|
|
|
|
self.bool_error.function,
|
|
|
|
self.bool_error.line,
|
|
|
|
format_args!("{}", self.bool_error.message),
|
|
|
|
);
|
|
|
|
});
|
2019-01-24 19:33:31 +00:00
|
|
|
}
|
|
|
|
|
2022-12-27 10:22:37 +00:00
|
|
|
pub fn log_with_object(&self, obj: &impl IsA<glib::Object>) {
|
|
|
|
self.log_with_object_internal(obj.as_ref());
|
2019-01-24 19:33:31 +00:00
|
|
|
}
|
|
|
|
|
2022-12-27 10:22:37 +00:00
|
|
|
#[inline(never)]
|
|
|
|
fn log_with_object_internal(&self, obj: &glib::Object) {
|
|
|
|
self.bool_error.filename.run_with_gstr(|filename| {
|
|
|
|
self.category.log(
|
|
|
|
Some(obj),
|
|
|
|
crate::DebugLevel::Error,
|
|
|
|
filename,
|
|
|
|
self.bool_error.function,
|
|
|
|
self.bool_error.line,
|
|
|
|
format_args!("{}", self.bool_error.message),
|
|
|
|
);
|
|
|
|
});
|
|
|
|
}
|
|
|
|
|
|
|
|
pub fn log_with_imp(&self, imp: &impl glib::subclass::types::ObjectSubclass) {
|
2022-10-09 08:49:28 +00:00
|
|
|
use glib::subclass::prelude::*;
|
|
|
|
|
2022-12-27 10:22:37 +00:00
|
|
|
self.log_with_object_internal(unsafe { imp.obj().unsafe_cast_ref::<glib::Object>() });
|
2022-10-09 08:49:28 +00:00
|
|
|
}
|
|
|
|
|
2020-11-21 13:46:48 +00:00
|
|
|
pub fn category(&self) -> crate::DebugCategory {
|
2019-01-24 19:33:31 +00:00
|
|
|
self.category
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl From<glib::BoolError> for LoggableError {
|
|
|
|
fn from(bool_error: glib::BoolError) -> Self {
|
2020-03-22 14:18:47 +00:00
|
|
|
skip_assert_initialized!();
|
2019-01-24 19:33:31 +00:00
|
|
|
LoggableError {
|
2020-11-21 13:46:48 +00:00
|
|
|
category: *crate::CAT_RUST,
|
2019-01-24 19:33:31 +00:00
|
|
|
bool_error,
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-01-10 13:11:04 +00:00
|
|
|
#[cfg(test)]
|
|
|
|
mod tests {
|
|
|
|
use super::*;
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn error_message() {
|
2020-11-21 13:46:48 +00:00
|
|
|
crate::init().unwrap();
|
2020-04-11 16:57:09 +00:00
|
|
|
|
2020-01-10 13:11:04 +00:00
|
|
|
let e = ErrorMessage::new(
|
2020-11-21 13:46:48 +00:00
|
|
|
&crate::CoreError::Failed,
|
2020-01-10 13:11:04 +00:00
|
|
|
Some("message"),
|
|
|
|
Some("debug"),
|
|
|
|
"filename",
|
|
|
|
"function",
|
|
|
|
7,
|
|
|
|
);
|
|
|
|
assert_eq!(
|
2023-01-25 08:09:45 +00:00
|
|
|
format!("{e}"),
|
2020-01-10 13:11:04 +00:00
|
|
|
"Error Some(\"message\") (Some(\"debug\")) at filename:7"
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn logabble_error() {
|
2020-11-21 13:46:48 +00:00
|
|
|
crate::init().unwrap();
|
2020-04-11 16:57:09 +00:00
|
|
|
|
2020-01-10 13:11:04 +00:00
|
|
|
let e: LoggableError = glib::BoolError::new("msg", "filename", "function", 7).into();
|
2023-01-25 08:09:45 +00:00
|
|
|
assert_eq!(format!("{e}"), "Error \"GST_RUST\": \"msg\" at filename:7");
|
2020-01-10 13:11:04 +00:00
|
|
|
}
|
|
|
|
}
|