Add logging macros

Author: str4d

crates/flipperzero/src/furi/log/metadata.rs

@@ -198,6 +198,10 @@ impl Level {
             Level::ERROR => "ERROR",
         }
     }
+
+    pub(crate) fn to_furi(self) -> sys::FuriLogLevel {
+        self.0 as u8
+    }
 }
 
 impl fmt::Display for Level {

crates/flipperzero/src/furi/log/mod.rs

@@ -1,3 +1,166 @@
 //! Furi Logging system.
 
 mod metadata;
+pub use metadata::{Level, LevelFilter};
+
+/// The standard logging macro.
+///
+/// This macro will generically log with the specified `Level` and C-style format argument
+/// list.
+///
+/// # Examples
+///
+/// ```
+/// use flipperzero::{error, furi::log::Level};
+///
+/// # fn main() {
+/// let error_code = 42;
+/// log!(Level::ERROR, "Failed to handle the florp: %d", error_code);
+/// log!(target: "events", Level::INFO, "Finished the documentation!");
+/// # }
+/// ```
+#[macro_export]
+macro_rules! log {
+    (target: $target:expr, $lvl:expr, $msg:expr $(, $arg:expr)*) => ({
+        if $lvl <= $crate::furi::log::LevelFilter::current() {
+            unsafe {
+                $crate::__macro_support::__sys::furi_log_print_format(
+                    $crate::__macro_support::__level_to_furi($lvl),
+                    $crate::__macro_support::__sys::c_string!($target),
+                    $crate::__macro_support::__sys::c_string!($msg),
+                    $($arg,)*
+                );
+            }
+        }
+    });
+
+    ($lvl:expr, $msg:expr $(, $arg:expr)*) => (
+        $crate::log!(target: module_path!(), $lvl, $msg $(, $arg)*)
+    );
+}
+
+/// Logs a message at the error level.
+///
+/// # Examples
+///
+/// ```
+/// use flipperzero::error;
+///
+/// # fn main() {
+/// let error_code = 42;
+/// let name = "Flipper";
+///
+/// error!("Failed to handle the florp: %d", error_code);
+/// error!(target: "events", "Missed birthday party for %s", name);
+/// # }
+/// ```
+#[macro_export]
+macro_rules! error {
+    (target: $target:expr, $msg:expr $(, $arg:expr)*) => (
+        $crate::log!(target: $target, $crate::furi::log::Level::ERROR, $msg $(, $arg)*)
+    );
+
+    ($msg:expr $(, $arg:expr)*) => (
+        $crate::log!($crate::furi::log::Level::ERROR, $msg $(, $arg)*)
+    );
+}
+
+/// Logs a message at the warn level.
+///
+/// # Examples
+///
+/// ```
+/// use flipperzero::warn;
+///
+/// # fn main() {
+/// let name = "Flipper";
+///
+/// warn!("Event almost started!");
+/// warn!(target: "events", "About to miss the birthday party for %s", name);
+/// # }
+/// ```
+#[macro_export]
+macro_rules! warn {
+    (target: $target:expr, $msg:expr $(, $arg:expr)*) => (
+        $crate::log!(target: $target, $crate::furi::log::Level::WARN, $msg $(, $arg)*)
+    );
+
+    ($msg:expr $(, $arg:expr)*) => (
+        $crate::log!($crate::furi::log::Level::WARN, $msg $(, $arg)*)
+    );
+}
+
+/// Logs a message at the info level.
+///
+/// # Examples
+///
+/// ```
+/// use flipperzero::info;
+///
+/// # fn main() {
+/// let name = "Flipper";
+///
+/// info!("It's %s's birthday today!", name);
+/// info!(target: "events", "Birthday party today: %s", name);
+/// # }
+/// ```
+#[macro_export]
+macro_rules! info {
+    (target: $target:expr, $msg:expr $(, $arg:expr)*) => (
+        $crate::log!(target: $target, $crate::furi::log::Level::INFO, $msg $(, $arg)*)
+    );
+
+    ($msg:expr $(, $arg:expr)*) => (
+        $crate::log!($crate::furi::log::Level::INFO, $msg $(, $arg)*)
+    );
+}
+
+/// Logs a message at the debug level.
+///
+/// # Examples
+///
+/// ```
+/// use flipperzero::debug;
+///
+/// # fn main() {
+/// let name = "Flipper";
+///
+/// debug!("Creating %d event", 1);
+/// debug!(target: "events", "New event created: birthday party for %s", name);
+/// # }
+/// ```
+#[macro_export]
+macro_rules! debug {
+    (target: $target:expr, $msg:expr $(, $arg:expr)*) => (
+        $crate::log!(target: $target, $crate::furi::log::Level::DEBUG, $msg $(, $arg)*)
+    );
+
+    ($msg:expr $(, $arg:expr)*) => (
+        $crate::log!($crate::furi::log::Level::DEBUG, $msg $(, $arg)*)
+    );
+}
+
+/// Logs a message at the trace level.
+///
+/// # Examples
+///
+/// ```
+/// use flipperzero::trace;
+///
+/// # fn main() {
+/// let name = "Flipper";
+///
+/// trace!("About to show how the target field works");
+/// trace!(target: "events", "Scanning for events involving %s", name);
+/// # }
+/// ```
+#[macro_export]
+macro_rules! trace {
+    (target: $target:expr, $msg:expr $(, $arg:expr)*) => (
+        $crate::log!(target: $target, $crate::furi::log::Level::TRACE, $msg $(, $arg)*)
+    );
+
+    ($msg:expr $(, $arg:expr)*) => (
+        $crate::log!($crate::furi::log::Level::TRACE, $msg $(, $arg)*)
+    );
+}

crates/flipperzero/src/lib.rs

@@ -10,3 +10,26 @@ pub mod dolphin;
 pub mod furi;
 pub mod gui;
 pub mod macros;
+
+#[doc(hidden)]
+pub mod __macro_support {
+    pub use crate::furi::log::Level;
+
+    /// ⚠️ WARNING: This is *not* a stable API! ⚠️
+    ///
+    /// This module, and all code contained in the `__macro_support` module, is a
+    /// *private* API of `flipperzero`. It is exposed publicly because it is used by the
+    /// `flipperzero` macros, but it is not part of the stable versioned API. Breaking
+    /// changes to this module may occur in small-numbered versions without warning.
+    pub use flipperzero_sys as __sys;
+
+    /// ⚠️ WARNING: This is *not* a stable API! ⚠️
+    ///
+    /// This function, and all code contained in the `__macro_support` module, is a
+    /// *private* API of `flipperzero`. It is exposed publicly because it is used by the
+    /// `flipperzero` macros, but it is not part of the stable versioned API. Breaking
+    /// changes to this module may occur in small-numbered versions without warning.
+    pub fn __level_to_furi(level: Level) -> __sys::FuriLogLevel {
+        level.to_furi()
+    }
+}