Merge pull request #14 from qorix-group/arkjedrz_mw-log-macro

log: `mw_log_fmt_macro` implementation

Author: pawelrutkaq

Cargo.lock

@@ -2,9 +2,13 @@
 resolver = "2"
 # Split to default members without tests and examples.
 # Used when executing cargo from project root.
-default-members = ["src/containers", "src/log/mw_log_fmt"]
+default-members = [
+    "src/containers",
+    "src/log/mw_log_fmt",
+    "src/log/mw_log_fmt_macro",
+]
 # Include tests and examples as a member for IDE support and Bazel builds.
-members = ["src/containers", "src/log/mw_log_fmt"]
+members = ["src/containers", "src/log/mw_log_fmt", "src/log/mw_log_fmt_macro"]
 
 
 [workspace.package]
@@ -16,6 +20,7 @@ authors = ["S-CORE Contributors"]
 
 [workspace.dependencies]
 mw_log_fmt = { path = "src/log/mw_log_fmt" }
+mw_log_fmt_macro = { path = "src/log/mw_log_fmt_macro" }
 
 
 [workspace.lints.clippy]

Cargo.toml

@@ -37,9 +37,8 @@ package log <<component>> {
         +trace!(...) : ()
     }
 
-    class mw_log_macro <<module>> {
+    class mw_log_fmt_macro <<module>> {
         +mw_log_format_args!(format_string: &str, args...) : Arguments<'_>
-        +mw_log_format_args_nl!(format_string: &str, args...) : Arguments<'_>
     }
 
     package mw_log_fmt {
@@ -51,13 +50,12 @@ package log <<component>> {
             +write(output: &mut dyn ScoreWrite, args: Arguments<'_>) : Result
 
             +score_write!(format_string: &str, args...) : Result
-            +score_writeln!(format_string: &str, args...) : Result
         }
     }
 
     mw_log -- Level
     mw_log -- LevelFilter
-    mw_log -- mw_log_macro
+    mw_log -- mw_log_fmt_macro
     mw_log -right- mw_log_fmt
 }
 

docs/baselibs_rust/log/architecture/_assets/interface.puml

@@ -5,10 +5,10 @@ package "log" <<component>> {
 
     component "mw_log_fmt"
 
-    component "mw_log_macro"
+    component "mw_log_fmt_macro"
 
     mw_log ..> mw_log_fmt : use
-    mw_log ..> mw_log_macro : use
+    mw_log ..> mw_log_fmt_macro : use
 }
 
 component "mw_log_subscriber" <<component>>

docs/baselibs_rust/log/architecture/_assets/static_view.puml

@@ -195,7 +195,6 @@ package "mw_log_fmt crate" {
         +write(output: &mut dyn ScoreWrite, args: Arguments<'_>) : Result
 
         +score_write!(format_string: &str, args...) : Result
-        +score_writeln!(format_string: &str, args...) : Result
     }
     note top
         Provided macros can be used for implementing custom formatting traits.
@@ -217,10 +216,9 @@ package "mw_log_fmt crate" {
     mw_log_fmt -- Arguments
 }
 
-package "mw_log_macro crate" {
-    +class mw_log_macro <<module>> {
+package "mw_log_fmt_macro crate" {
+    +class mw_log_fmt_macro <<module>> {
         +mw_log_format_args!(format_string: &str, args...) : Arguments<'_>
-        +mw_log_format_args_nl!(format_string: &str, args...) : Arguments<'_>
     }
 
     note top
@@ -262,7 +260,7 @@ package "mw_log_subscriber crate" {
 }
 
 "mw_log crate" -[hidden]down-> "mw_log_fmt crate"
-"mw_log crate" -[hidden]up-> "mw_log_macro crate"
+"mw_log crate" -[hidden]up-> "mw_log_fmt_macro crate"
 
 "mw_log crate" -[hidden]down------> "mw_log_subscriber crate"
 "mw_log_fmt crate" -[hidden]down------> "mw_log_subscriber crate"

docs/baselibs_rust/log/detailed_design/_assets/class_diagram.puml

@@ -7,7 +7,7 @@ participant "mw_log <<module>>" as mw_log
 end box
 
 box #LightGreen
-participant "mw_log_macro <<module>>" as mw_log_macro
+participant "mw_log_fmt_macro <<module>>" as mw_log_fmt_macro
 end box
 
 box #LightPink
@@ -36,8 +36,8 @@ alt log-level-check-failed
     mw_log --> actor
 
 else log-level-check-passed
-    mw_log -> mw_log_macro : mw_log_format_args!()
-    mw_log_macro --> mw_log
+    mw_log -> mw_log_fmt_macro : mw_log_format_args!()
+    mw_log_fmt_macro --> mw_log
 
     mw_log -> logger : log()
 

docs/baselibs_rust/log/detailed_design/_assets/log_op.puml

@@ -36,7 +36,9 @@ Log component consists of three units:
 
 - `mw_log` - modelled after `log` Rust library.
 - `mw_log_fmt` - replacement for `core::fmt` provided by Rust core library.
-- `mw_log_macro` - replacement for `format_args` macro provided by Rust compiler.
+- `mw_log_fmt_macro` - replacement for macros provided by Rust compiler:
+  - `mw_log_format_args!` - replacement for `format_args!`
+  - `ScoreDebug` - replacement for `Debug`
 
 Most common approach in Rust is that formatting always results in a string.
 This means that the `log` library always receives a pre-formatted string.

docs/baselibs_rust/log/detailed_design/index.rst

@@ -22,17 +22,3 @@ macro_rules! score_write {
         $crate::write($dst, mw_log::__private_api::format_args!($($arg)*))
     };
 }
-
-/// Writes data using provided writer, with a newline appended.
-///
-/// For more information, see [`score_write!`].
-#[macro_export]
-macro_rules! score_writeln {
-    ($dst:expr $(,)?) => {
-        $crate::score_write!($dst, "\n")
-    };
-    ($dst:expr, $($arg:tt)*) => {
-        // TODO: `mw_log::__private_api` will become available in future PRs.
-        $crate::write($dst, mw_log::__private_api::format_args_nl!($($arg)*))
-    };
-}

src/log/mw_log_fmt/macros.rs

@@ -0,0 +1,42 @@
+# *******************************************************************************
+# Copyright (c) 2025 Contributors to the Eclipse Foundation
+#
+# See the NOTICE file(s) distributed with this work for additional
+# information regarding copyright ownership.
+#
+# This program and the accompanying materials are made available under the
+# terms of the Apache License Version 2.0 which is available at
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# SPDX-License-Identifier: Apache-2.0
+# *******************************************************************************
+load("@rules_rust//rust:defs.bzl", "rust_proc_macro", "rust_test")
+
+rust_proc_macro(
+    name = "mw_log_fmt_macro",
+    srcs = glob(["*.rs"]),
+    # TODO: expose required interface through `mw_log` and make it private again.
+    # visibility = ["//visibility:private"],
+    visibility = ["//visibility:public"],
+    deps = [
+        "//src/log/mw_log_fmt",
+        "@score_crates//:proc_macro2",
+        "@score_crates//:quote",
+        "@score_crates//:syn",
+    ],
+)
+
+rust_test(
+    name = "tests",
+    srcs = glob(["tests/**/*.rs"]),
+    proc_macro_deps = [
+        "//src/log/mw_log_fmt_macro",
+    ],
+    tags = [
+        "unit_tests",
+        "ut",
+    ],
+    deps = [
+        "//src/log/mw_log_fmt",
+    ],
+)

src/log/mw_log_fmt_macro/BUILD

@@ -0,0 +1,32 @@
+# *******************************************************************************
+# Copyright (c) 2025 Contributors to the Eclipse Foundation
+#
+# See the NOTICE file(s) distributed with this work for additional
+# information regarding copyright ownership.
+#
+# This program and the accompanying materials are made available under the
+# terms of the Apache License Version 2.0 which is available at
+# https://www.apache.org/licenses/LICENSE-2.0
+#
+# SPDX-License-Identifier: Apache-2.0
+# *******************************************************************************
+
+[package]
+name = "mw_log_fmt_macro"
+version.workspace = true
+authors.workspace = true
+readme.workspace = true
+edition.workspace = true
+
+[lib]
+proc-macro = true
+path = "lib.rs"
+
+[dependencies]
+syn = { version = "2", features = ["full"] }
+quote = "1"
+proc-macro2 = "1"
+mw_log_fmt.workspace = true
+
+[lints]
+workspace = true