add UE_LOG_WITH_INFO_SHORT macro (#97)

rapyuta-robotics · Jun 22, 2023 · 5d2767d · 5d2767d
1 parent 502176f
commit 5d2767d
Showing 1 changed file with 58 additions and 0 deletions.
diff --git a/Source/rclUE/Public/logUtilities.h b/Source/rclUE/Public/logUtilities.h
@@ -44,6 +44,23 @@
         UE_LOG(CategoryName, Verbosity, TEXT("[%s] %s"), *__LOG_INFO__, *FString::Printf(__VA_ARGS__)); \
     }
 
+/**
+ * UE_LOG with function info with <class name>::<func name>@<line number> .
+ * @param CategoryName name of the logging category
+ * @param Verbosity, verbosity level to test against
+ * @param Format, format text
+*/
+#define UE_LOG_WITH_INFO_SHORT(CategoryName, Verbosity, ...)                                                                     \
+    {                                                                                                                            \
+        FString UE_LOG_WITH_INFO_Temp1, UE_LOG_WITH_INFO_Temp2;                                                                  \
+        FString(RCLUE_FUNC_LOG)                                                                                                  \
+            .Split(                                                                                                              \
+                TEXT("("), &UE_LOG_WITH_INFO_Temp1, &UE_LOG_WITH_INFO_Temp2, ESearchCase::CaseSensitive, ESearchDir::FromStart); \
+        UE_LOG_WITH_INFO_Temp1.Split(                                                                                            \
+            TEXT(" "), &UE_LOG_WITH_INFO_Temp1, &UE_LOG_WITH_INFO_Temp2, ESearchCase::CaseSensitive, ESearchDir::FromEnd);       \
+        UE_LOG(CategoryName, Verbosity, TEXT("[%s@%d] %s"), *UE_LOG_WITH_INFO_Temp2, __LINE__, *FString::Printf(__VA_ARGS__));   \
+    }
+
 /**
  * UE_LOG_WITH_INFO with GetName()
  * @param CategoryName name of the logging category
@@ -55,6 +72,17 @@
         UE_LOG_WITH_INFO(CategoryName, Verbosity, TEXT("[%s] %s"), *GetName(), *FString::Printf(__VA_ARGS__)); \
     }
 
+/**
+ * UE_LOG_WITH_INFO_SHORT with GetName()
+ * @param CategoryName name of the logging category
+ * @param Verbosity, verbosity level to test against
+ * @param Format, format text
+*/
+#define UE_LOG_WITH_INFO_SHORT_NAMED(CategoryName, Verbosity, ...)                                                   \
+    {                                                                                                                \
+        UE_LOG_WITH_INFO_SHORT(CategoryName, Verbosity, TEXT("[%s] %s"), *GetName(), *FString::Printf(__VA_ARGS__)); \
+    }
+
 /**
  * @brief UE_LOG_THROTTLE will print a message at most once per InRate.
  * @param InRate, time interval to print a message
@@ -85,6 +113,21 @@
         }                                                                                   \
     }
 
+/**
+ * @brief UE_LOG_WITH_INFO_SHORT_THROTTLE will print a message at most once per InRate.
+ * @param InRate, time interval to print a message
+ * @param InLastHit, last time a message was printed
+ */
+#define UE_LOG_WITH_INFO_SHORT_THROTTLE(InRate, InLastHit, ...)                             \
+    {                                                                                       \
+        float UE_LOG_WITH_INFO_THROTTLE_Now = UGameplayStatics::GetTimeSeconds(GetWorld()); \
+        if (InLastHit + InRate <= UE_LOG_WITH_INFO_THROTTLE_Now)                            \
+        {                                                                                   \
+            InLastHit = UE_LOG_WITH_INFO_THROTTLE_Now;                                      \
+            UE_LOG_WITH_INFO_SHORT(__VA_ARGS__);                                            \
+        }                                                                                   \
+    }
+
 /**
  * @brief UE_LOG_WITH_INFO_NAMED_THROTTLE will print a message at most once per InRate.
  * @param InRate, time interval to print a message
@@ -99,3 +142,18 @@
             UE_LOG_WITH_INFO_NAMED(__VA_ARGS__);                                                  \
         }                                                                                         \
     }
+
+/**
+ * @brief UE_LOG_WITH_INFO_SHORT_NAMED_THROTTLE will print a message at most once per InRate.
+ * @param InRate, time interval to print a message
+ * @param InLastHit, last time a message was printed
+ */
+#define UE_LOG_WITH_INFO_SHORT_NAMED_THROTTLE(InRate, InLastHit, ...)                             \
+    {                                                                                             \
+        float UE_LOG_WITH_INFO_NAMED_THROTTLE_Now = UGameplayStatics::GetTimeSeconds(GetWorld()); \
+        if (InLastHit + InRate <= UE_LOG_WITH_INFO_NAMED_THROTTLE_Now)                            \
+        {                                                                                         \
+            InLastHit = UE_LOG_WITH_INFO_NAMED_THROTTLE_Now;                                      \
+            UE_LOG_WITH_INFO_SHORT_NAMED(__VA_ARGS__);                                            \
+        }                                                                                         \
+    }