[#464] Add convencience function to set console or file logger

Author: elfenpiff

iceoryx2-bb/log/src/logger/mod.rs

@@ -13,10 +13,27 @@
 //! Trait which can be implemented by logger, see [`crate::logger::console::Logger`]
 //! for instance.
 
+use std::sync::LazyLock;
+
 pub mod buffer;
 pub mod console;
 pub mod file;
 #[cfg(feature = "logger_log")]
 pub mod log;
 #[cfg(feature = "logger_tracing")]
 pub mod tracing;
+
+/// Sets the [`console::Logger`] as default logger
+pub fn use_console_logger() -> bool {
+    static LOGGER: LazyLock<console::Logger> = LazyLock::new(|| console::Logger::new());
+    crate::set_logger(&*LOGGER)
+}
+
+/// Sets the [`file::Logger`] as default logger
+pub fn use_file_logger(log_file_name: &str) -> bool {
+    // we cannot capture non const parameters in a LazyLock and since static values are not
+    // dropped in Rust we can also use Box::leak
+    let logger = Box::leak(Box::new(file::Logger::new(log_file_name)));
+
+    crate::set_logger(logger)
+}

iceoryx2-ffi/cxx/include/iox2/log.hpp

@@ -50,6 +50,12 @@ class Log {
 /// Adds a log message to the logger.
 void log(LogLevel log_level, const char* origin, const char* message);
 
+/// Sets the console logger as default logger. Returns true if the logger was set, otherwise false.
+auto use_console_logger() -> bool;
+
+/// Sets the file logger as default logger. Returns true if the logger was set, otherwise false.
+auto use_file_logger(const char* log_file) -> bool;
+
 /// Sets the logger that shall be used. This function can only be called once and must be called
 /// before any log message was created.
 /// It returns true if the logger was set, otherwise false.

iceoryx2-ffi/cxx/src/log.cpp

@@ -45,4 +45,11 @@ auto get_log_level() -> LogLevel {
     return LogLevel(iox2_get_log_level());
 }
 
+auto use_console_logger() -> bool {
+    return iox2_use_console_logger();
+}
+
+auto use_file_logger(const char* log_file) -> bool {
+    return iox2_use_file_logger(log_file);
+}
 } // namespace iox2

iceoryx2-ffi/ffi/src/api/log.rs

@@ -17,6 +17,7 @@
 
 use iceoryx2_bb_log::{
     get_log_level, set_log_level, set_logger, Log, LogLevel, __internal_print_log_msg,
+    logger::{use_console_logger, use_file_logger},
 };
 use std::{
     ffi::{c_char, CStr},
@@ -131,6 +132,8 @@ pub unsafe extern "C" fn iox2_log(
     origin: *const c_char,
     message: *const c_char,
 ) {
+    debug_assert!(!message.is_null());
+
     let empty_origin = b"\0";
     let origin = if origin.is_null() {
         CStr::from_bytes_with_nul(empty_origin).unwrap()
@@ -146,6 +149,25 @@ pub unsafe extern "C" fn iox2_log(
     );
 }
 
+/// Sets the console logger as default logger. Returns true if the logger was set, otherwise false.
+#[no_mangle]
+pub extern "C" fn iox2_use_console_logger() -> bool {
+    use_console_logger()
+}
+
+/// Sets the file logger as default logger. Returns true if the logger was set, otherwise false.
+///
+/// # Safety
+///
+///  * log_file must be a valid pointer to a string
+#[no_mangle]
+pub unsafe extern "C" fn iox2_use_file_logger(log_file: *const c_char) -> bool {
+    debug_assert!(!log_file.is_null());
+
+    let log_file = CStr::from_ptr(log_file).to_string_lossy();
+    use_file_logger(&log_file)
+}
+
 /// Sets the log level.
 #[no_mangle]
 pub unsafe extern "C" fn iox2_set_log_level(v: iox2_log_level_e) {