lv_bevy_ecs 0.9.3

Safe Rust bindings to the LVGL graphics library using Bevy's ECS framework
Documentation
//! # Logging
//! You can forward LVGL logs to the `log` crate by calling `lv_bevy_ecs::logging::connect();` during startup.
//!
//! Or the other way around, calling `lv_bevy_ecs::logging::lv_log_init();` will forward the `log` crate macros
//! to LVGL's logger. This way you also have line numbers at the end of each message by default.
//!
//! Using both will create an infinite loop and stack overflow.
//!
//! If you use the logging macros from this crate (e. g. `lv_bevy_ecs::info!("This is an info")`)
//! then the message will use the function name instead of module name as target,
//! which makes it consistent with LVGL logging.
//!
//! Don't forget to adjust the logging level on both sides!
//!
//! See `examples/custom_logging.rs` for sample code.
//!

use ::alloc::vec::Vec;
use ::core::ffi::CStr;

use log::Level;

#[allow(unused)]
macro_rules! cstr {
    ($txt:expr) => {
        ::alloc::ffi::CString::new($txt).unwrap().as_c_str()
    };
}

#[macro_export]
macro_rules! func {
    () => {{
        fn f() {}
        fn type_name_of<T>(_: T) -> &'static str {
            core::any::type_name::<T>()
        }
        let name = type_name_of(f);
        name[..name.len() - 3].split("::").last().unwrap()
    }};
}

/// Forward LVGL logging to the `defmt` crate
#[cfg(all(LV_USE_LOG, feature = "defmt"))]
pub fn connect() {
    crate::support::assert_lv_initialized!();
    unsafe {
        lightvgl_sys::lv_log_register_print_cb(Some(lvgl_defmt));
    }
}

/// # Safety
/// `buf` must be non-null, pointing to a null terminated valid C string
#[cfg(feature = "defmt")]
#[unsafe(no_mangle)]
pub unsafe extern "C" fn lvgl_defmt(
    level: lightvgl_sys::lv_log_level_t,
    buf: *const core::ffi::c_char,
) {
    let message = unsafe { CStr::from_ptr(buf) };
    let message = message.to_string_lossy();
    let message = message.trim();
    let parts = message.split(':').collect::<Vec<&str>>();
    let message = parts[1..].join(":");
    match level as u32 {
        lightvgl_sys::LV_LOG_LEVEL_TRACE => {
            defmt::trace!("{}", message.trim());
        }
        lightvgl_sys::LV_LOG_LEVEL_INFO => {
            defmt::info!("{}", message.trim());
        }
        lightvgl_sys::LV_LOG_LEVEL_WARN => {
            defmt::warn!("{}", message.trim());
        }
        lightvgl_sys::LV_LOG_LEVEL_ERROR => {
            defmt::error!("{}", message.trim());
        }
        _ => {
            log::error!("Invalid log level: {level}");
        }
    }
}

/// Forward LVGL logging to the `log` crate
///
/// Must not be used together with lv_log_init();
#[cfg(all(LV_USE_LOG, not(feature = "defmt")))]
pub fn connect() {
    crate::support::assert_lv_initialized!();
    unsafe {
        lightvgl_sys::lv_log_register_print_cb(Some(lvgl_log));
    }
}

/// # Safety
/// `buf` must be non-null, pointing to a null terminated valid C string
#[unsafe(no_mangle)]
pub unsafe extern "C" fn lvgl_log(
    level: lightvgl_sys::lv_log_level_t,
    buf: *const core::ffi::c_char,
) {
    let message = unsafe { CStr::from_ptr(buf) };
    let message = message.to_string_lossy();
    let message = message.trim();
    let parts = message.split(':').collect::<Vec<&str>>();
    let target = parts[0].split(" ").last().unwrap();
    let message = parts[1..].join(":");
    match level as u32 {
        lightvgl_sys::LV_LOG_LEVEL_TRACE => {
            log::trace!(target:target, "{}", message.trim());
        }
        lightvgl_sys::LV_LOG_LEVEL_INFO => {
            log::info!(target:target, "{}", message.trim());
        }
        lightvgl_sys::LV_LOG_LEVEL_WARN => {
            log::warn!(target:target, "{}", message.trim());
        }
        lightvgl_sys::LV_LOG_LEVEL_ERROR => {
            log::error!(target:target, "{}", message.trim());
        }
        _ => {
            log::error!("Invalid log level: {level}");
        }
    }
}

/// Use LVGL as the backend for the `log` crate.
///
/// Must not be used together with `lv_bevy_ecs::logging::connect()`
#[cfg(LV_USE_LOG)]
pub fn lv_log_init() {
    crate::support::assert_lv_initialized!();
    match log::set_logger(&LvglLogger) {
        Ok(_) => log::set_max_level(log::LevelFilter::Trace),
        Err(err) => log::error!("Could not initialize logging: {}", err),
    }
}

pub fn as_lv_log_level(level: Level) -> lightvgl_sys::lv_log_level_t {
    (match level {
        Level::Trace => lightvgl_sys::LV_LOG_LEVEL_TRACE,
        Level::Debug => lightvgl_sys::LV_LOG_LEVEL_TRACE,
        Level::Info => lightvgl_sys::LV_LOG_LEVEL_INFO,
        Level::Warn => lightvgl_sys::LV_LOG_LEVEL_WARN,
        Level::Error => lightvgl_sys::LV_LOG_LEVEL_ERROR,
    }) as lightvgl_sys::lv_log_level_t
}

#[cfg(LV_USE_LOG)]
pub(crate) fn lv_log_add(
    level: Level,
    file: &core::ffi::CStr,
    line: u32,
    func: &core::ffi::CStr,
    message: &core::ffi::CStr,
) {
    unsafe {
        lightvgl_sys::lv_log_add(
            as_lv_log_level(level),
            file.as_ptr(),
            line as i32,
            func.as_ptr(),
            message.as_ptr(),
        );
    }
}

#[cfg(LV_USE_LOG)]
pub struct LvglLogger;

#[cfg(LV_USE_LOG)]
impl log::Log for LvglLogger {
    fn enabled(&self, _metadata: &log::Metadata) -> bool {
        true
    }

    fn log(&self, record: &log::Record) {
        lv_log_add(
            record.level(),
            cstr!(record.file().unwrap_or_default()),
            record.line().unwrap_or_default(),
            cstr!(record.target()),
            cstr!(::alloc::format!("{}", record.args())),
        );
    }
    fn flush(&self) {}
}

cfg_if::cfg_if! {
    if #[cfg(feature = "defmt")] {
        pub use defmt::{trace as trace_, info as info_, warn as warn_, error as error_};
    }else {

        #[macro_export]
        macro_rules! trace_ {
            ($($arg:tt)*) => {
                log::trace!(target:$crate::func!(), $($arg)*);
            };
        }

        #[macro_export]
        macro_rules! info_ {
            ($($arg:tt)*) => {
                log::info!(target:$crate::func!(), $($arg)*);
            };
        }

        #[macro_export]
        macro_rules! warn_ {
            ($($arg:tt)*) => {
                log::warn!(target:$crate::func!(), $($arg)*);
            };
        }

        #[macro_export]
        macro_rules! error_ {
            ($($arg:tt)*) => {
                log::error!(target:$crate::func!(), $($arg)*);
            };
        }

        pub use info_;
        pub use trace_;
        pub use warn_;
        pub use error_;


    }
}