Merge pull request #29 from Sherif-MoOo/std_libs

Internal core location helper enhance it to be a compile time evaluat…

Author: Sherif-MoOo

components/open-aa-std-adaptive-autosar-libs/include/ara/core/internal/location_utils.h

@@ -1,85 +1,79 @@
-/**********************************************************************************************************************
+/***********************************************************************************************************************
  *  PROJECT
- *  -------------------------------------------------------------------------------------------------------------------
+ *  --------------------------------------------------------------------------------------------------------------------
  *  \verbatim
- *  OpenAA: Open Source Adaptive AUTOSAR Project
+ *  OpenAA: Open Source Adaptive AUTOSAR Project (CXX_STANDARD 17)
  *  \endverbatim
- *  -------------------------------------------------------------------------------------------------------------------
+ *  --------------------------------------------------------------------------------------------------------------------
  *  FILE DESCRIPTION
- *  -------------------------------------------------------------------------------------------------------------------
+ *  --------------------------------------------------------------------------------------------------------------------
  *  \file       location_utils.h
  *  \brief      Internal utilities for compile-time extraction of filename/line information.
  *
- *  \details    This file defines helper functions and macros for path-stripping and location capturing. They are used
- *              internally within the Adaptive AUTOSAR environment to support consistent violation logging, etc.
- *
- *********************************************************************************************************************/
+ *  \details    This file defines helper functions and macros for path-stripping and location capturing.
+ *              It provides a fully constexpr implementation that strips directory paths from __FILE__ at compile time.
+ *  \note       This helper could be replace with std::source_location if you're using (CXX_STANDARD 20)
+ ***********************************************************************************************************************/
 
 #ifndef ARA_CORE_INTERNAL_LOCATION_UTILS_H_
 #define ARA_CORE_INTERNAL_LOCATION_UTILS_H_
 
-#include <string_view>  // Required for std::string_view
+#include <cstddef>      // For std::size_t
+#include <string_view>  // For std::string_view
 
 namespace ara {
 namespace core {
 namespace internal {
 
 /*!
- * \brief   A constexpr function to strip directory paths from a string (like __FILE__).
- * \param   fullPath  A std::string_view representing the full path, typically __FILE__.
- * \return  A std::string_view pointing to the filename part after the last slash or backslash.
+ * \brief   A constexpr function template to strip directory paths from a string literal (e.g. __FILE__).
+ * \tparam  N  The size of the string literal (including the null terminator).
+ * \param   fullPath  A reference to a string literal representing the full path.
+ * \return  A std::string_view pointing to the filename part (after the last '/' or '\\').
  *
  * \details 
- *  - This handles both forward slash '/' and backslash '\\' to cover various platforms.
- *  - Example: 
- *       std::string_view result = CutLeadingPath("C:\\MyProject\\source\\file.cpp");
- *       // result now points to "file.cpp"
+ *  - Iterates backwards over the string literal until a path separator is found.
+ *  - If no separator is found, the entire string is returned.
+ *  - Because it accepts a string literal reference, the operation is fully evaluated at compile time.
  */
-constexpr auto CutLeadingPath(std::string_view fullPath) noexcept -> std::string_view
-{
-    std::size_t pos = fullPath.find_last_of("/\\");
-    if (pos == std::string_view::npos) {
-        return fullPath;
-    } else {
-        return fullPath.substr(pos + 1);
+template <std::size_t N>
+constexpr std::string_view StripFilePath(const char (&fullPath)[N]) noexcept {
+    std::string_view path{ fullPath, N - 1 }; // Exclude the null terminator
+    for (std::size_t i = path.size(); i > 0; --i) {
+        if (path[i - 1] == '/' || path[i - 1] == '\\') {
+            return path.substr(i);
+        }
     }
+    return path;
 }
 
 }  // namespace internal
 }  // namespace core
 }  // namespace ara
 
 /*!
- * \brief   Macro to stringify tokens.
+ * \brief   Helper macros to stringify tokens.
  */
 #define ARA_CORE_LOC_STRINGIFY_(x) #x
 #define ARA_CORE_LOC_STRINGIFY(x)  ARA_CORE_LOC_STRINGIFY_(x)
 
 /*!
- * \brief   Provides a path-stripped version of __FILE__ at compile time using lambda capture.
+ * \brief   Provides a compile-time evaluated, path-stripped version of __FILE__.
  *
- * \return  A `std::string_view` pointing to the stripped filename.
+ * \return  A std::string_view pointing to the filename without directory paths.
  */
-#define ARA_CORE_INTERNAL_FILE \
-    []() -> std::string_view { \
-        constexpr std::string_view stripped = ::ara::core::internal::CutLeadingPath(__FILE__); \
-        return stripped; \
-    }()
+#define ARA_CORE_INTERNAL_FILE (::ara::core::internal::StripFilePath(__FILE__))
 
 /*!
- * \brief   Provides a path-stripped version of __FILE__ plus line number at compile time.
+ * \brief   Provides a compile-time evaluated, path-stripped version of __FILE__ with line number.
  *
  * \details 
- *  - Combines __FILE__ ":" __LINE__ and then strips the path.
- *  - The final string looks like "file.cpp:123" if the path was "C:\xyz\file.cpp".
+ *  - Uses compile-time literal concatenation to form a string of the format "file.cpp:123".
+ *  - The StripFilePath function removes any leading directory information.
  *
- * \return  A `std::string_view` containing the stripped filename and line number.
+ * \return  A std::string_view containing the stripped filename and line number.
  */
-#define ARA_CORE_INTERNAL_FILELINE \
-    []() -> std::string_view { \
-        static constexpr char path_and_line[] = __FILE__ ":" ARA_CORE_LOC_STRINGIFY(__LINE__); \
-        static constexpr std::string_view sv = ::ara::core::internal::CutLeadingPath(path_and_line); \
-        return sv; \
-    }()
+#define ARA_CORE_INTERNAL_FILELINE (::ara::core::internal::StripFilePath(__FILE__ ":" ARA_CORE_LOC_STRINGIFY(__LINE__)))
 
 #endif // ARA_CORE_INTERNAL_LOCATION_UTILS_H_
+