Use parantheses around logging macro parameter (#1820)

aprotyas · web-flow · commit f7bb88fc8fab · 2021-11-11T02:12:47.000-05:00
* Use parantheses around logging macro parameter

This allows the macro to expand "correctly", i.e. macro argument
expression is fully evaluated before use.

Signed-off-by: Abrar Rahman Protyasha &lt;aprotyas@u.rochester.edu&gt;

* Remove redundant parantheses around macro param

`decltype(X)` already provides sufficient "scoping" to the macro
parameter `X`.

Signed-off-by: Abrar Rahman Protyasha &lt;aprotyas@u.rochester.edu&gt;

* Add test case for expressions as logging param

Signed-off-by: Abrar Rahman Protyasha &lt;aprotyas@u.rochester.edu&gt;
diff --git a/rclcpp/resource/logging.hpp.em b/rclcpp/resource/logging.hpp.em
@@ -149,7 +149,7 @@ def get_rclcpp_suffix_from_features(features):
 @[ if params]@
 @(''.join(['      ' + p + ', \\\n' for p in params if p != stream_arg]))@
 @[ end if]@
-      logger.get_name(), \
+      (logger).get_name(), \
 @[ if 'stream' not in feature_combination]@
       __VA_ARGS__); \
 @[ else]@
diff --git a/rclcpp/test/rclcpp/test_logging.cpp b/rclcpp/test/rclcpp/test_logging.cpp
@@ -229,6 +229,12 @@ TEST_F(TestLoggingMacros, test_throttle) {
   }
 }
 
+TEST_F(TestLoggingMacros, test_parameter_expression) {
+  RCLCPP_DEBUG_STREAM(*&g_logger, "message");
+  EXPECT_EQ(1u, g_log_calls);
+  EXPECT_EQ("message", g_last_log_event.message);
+}
+
 bool log_function(rclcpp::Logger logger)
 {
   RCLCPP_INFO(logger, "successful log");

Original file line number	Diff line number	Diff line change
`@@ -229,6 +229,12 @@ TEST_F(TestLoggingMacros, test_throttle) {`
`229`	`229`	`}`
`230`	`230`	`}`
`231`	`231`
	`232`	`+TEST_F(TestLoggingMacros, test_parameter_expression) {`
	`233`	`+ RCLCPP_DEBUG_STREAM(*&g_logger, "message");`
	`234`	`+ EXPECT_EQ(1u, g_log_calls);`
	`235`	`+ EXPECT_EQ("message", g_last_log_event.message);`
	`236`	`+}`
	`237`	`+`
`232`	`238`	`bool log_function(rclcpp::Logger logger)`
`233`	`239`	`{`
`234`	`240`	`RCLCPP_INFO(logger, "successful log");`