feat(clp-s::timestamp_parser): Add initial partial implementation of timestamp parsing utility. (#1385)

Co-authored-by: Lin Zhihao <[email protected]>

Author: gibber9809

components/core/CMakeLists.txt

@@ -406,6 +406,7 @@ set(SOURCE_FILES_clp_s_unitTest
     src/clp_s/TimestampDictionaryWriter.hpp
     src/clp_s/TimestampEntry.cpp
     src/clp_s/TimestampEntry.hpp
+    src/clp_s/timestamp_parser/test/test_TimestampParser.cpp
     src/clp_s/Utils.cpp
     src/clp_s/Utils.hpp
     src/clp_s/ZstdCompressor.cpp
@@ -750,6 +751,7 @@ if(CLP_BUILD_TESTING)
             clp_s::search::ast
             clp_s::search::kql
             clp_s::search::sql
+            clp_s::timestamp_parser
             clp_s::timestamp_pattern
             date::date
             fmt::fmt

components/core/cmake/Options/options.cmake

@@ -83,6 +83,12 @@ option(
     ON
 )
 
+option(
+    CLP_BUILD_CLP_S_TIMESTAMP_PARSER
+    "Build clp_s::timestamp_parser"
+    ON
+)
+
 option(
     CLP_BUILD_CLP_S_TIMESTAMPPATTERN
     "Build clp_s::timestamp_pattern."
@@ -160,6 +166,7 @@ function(validate_clp_tests_dependencies)
         CLP_BUILD_CLP_S_SEARCH_KQL
         CLP_BUILD_CLP_S_SEARCH_SQL
         CLP_BUILD_CLP_S_TIMESTAMPPATTERN
+        CLP_BUILD_CLP_S_TIMESTAMP_PARSER
     )
 endfunction()
 
@@ -360,6 +367,19 @@ function(set_clp_s_search_sql_dependencies)
     )
 endfunction()
 
+function(validate_clp_s_timestamp_parser_dependencies)
+    validate_clp_dependencies_for_target(CLP_BUILD_CLP_S_TIMESTAMP_PARSER
+        CLP_BUILD_CLP_STRING_UTILS
+    )
+endfunction()
+
+function(set_clp_s_timestamp_parser_dependencies)
+    set_clp_need_flags(
+        CLP_NEED_DATE
+        CLP_NEED_YSTDLIB
+    )
+endfunction()
+
 function(validate_clp_s_timestamppattern_dependencies)
     validate_clp_dependencies_for_target(CLP_BUILD_CLP_S_TIMESTAMPPATTERN
         CLP_BUILD_CLP_STRING_UTILS
@@ -444,6 +464,11 @@ function(validate_and_setup_all_clp_dependency_flags)
         set_clp_s_search_sql_dependencies()
     endif()
 
+    if (CLP_BUILD_CLP_S_TIMESTAMP_PARSER)
+        validate_clp_s_timestamp_parser_dependencies()
+        set_clp_s_timestamp_parser_dependencies()
+    endif()
+
     if (CLP_BUILD_CLP_S_TIMESTAMPPATTERN)
         validate_clp_s_timestamppattern_dependencies()
         set_clp_s_timestamppattern_dependencies()

components/core/src/clp_s/CMakeLists.txt

@@ -1,6 +1,7 @@
 add_subdirectory(indexer)
 add_subdirectory(log_converter)
 add_subdirectory(search)
+add_subdirectory(timestamp_parser)
 
 set(
         CLP_S_CLP_SOURCES

components/core/src/clp_s/timestamp_parser/CMakeLists.txt

@@ -0,0 +1,25 @@
+set(
+        CLP_S_TIMESTAMP_PARSER_SOURCES
+        ../Defs.hpp
+        TimestampParser.cpp
+        TimestampParser.hpp
+        ErrorCode.cpp
+        ErrorCode.hpp
+)
+
+if(CLP_BUILD_CLP_S_TIMESTAMP_PARSER)
+        add_library(
+                clp_s_timestamp_parser
+                ${CLP_S_TIMESTAMP_PARSER_SOURCES}
+        )
+        add_library(clp_s::timestamp_parser ALIAS clp_s_timestamp_parser)
+        target_compile_features(clp_s_timestamp_parser PRIVATE cxx_std_20)
+        target_include_directories(clp_s_timestamp_parser PUBLIC ../../)
+        target_link_libraries(
+                clp_s_timestamp_parser
+                PRIVATE
+                clp::string_utils
+                date::date
+                ystdlib::error_handling
+        )
+endif()

components/core/src/clp_s/timestamp_parser/ErrorCode.cpp

@@ -0,0 +1,31 @@
+#include "ErrorCode.hpp"
+
+#include <string>
+
+#include <ystdlib/error_handling/ErrorCode.hpp>
+
+namespace {
+using clp_s::timestamp_parser::ErrorCodeEnum;
+using ErrorCategory = ystdlib::error_handling::ErrorCategory<ErrorCodeEnum>;
+}  // namespace
+
+template <>
+auto ErrorCategory::name() const noexcept -> char const* {
+    return "clp_s::timestamp_parser::ErrorCode";
+}
+
+template <>
+auto ErrorCategory::message(ErrorCodeEnum error_enum) const -> std::string {
+    switch (error_enum) {
+        case ErrorCodeEnum::InvalidTimestampPattern:
+            return "Encountered timestamp pattern with invalid syntax.";
+        case ErrorCodeEnum::IncompatibleTimestampPattern:
+            return "Timestamp pattern does not match the format of the given timestamp.";
+        case ErrorCodeEnum::InvalidDate:
+            return "Timestamp was parsed successfully, but did not yield a valid date.";
+        case ErrorCodeEnum::FormatSpecifierNotImplemented:
+            return "Encountered unimplemented format specifier in timestamp pattern.";
+        default:
+            return "Unknown error code enum.";
+    }
+}

components/core/src/clp_s/timestamp_parser/ErrorCode.hpp

@@ -0,0 +1,21 @@
+#ifndef CLP_S_TIMESTAMP_PARSER_ERRORCODE_HPP
+#define CLP_S_TIMESTAMP_PARSER_ERRORCODE_HPP
+
+#include <cstdint>
+
+#include <ystdlib/error_handling/ErrorCode.hpp>
+
+namespace clp_s::timestamp_parser {
+enum class ErrorCodeEnum : uint8_t {
+    InvalidTimestampPattern = 1,
+    IncompatibleTimestampPattern,
+    InvalidDate,
+    FormatSpecifierNotImplemented
+};
+
+using ErrorCode = ystdlib::error_handling::ErrorCode<ErrorCodeEnum>;
+}  // namespace clp_s::timestamp_parser
+
+YSTDLIB_ERROR_HANDLING_MARK_AS_ERROR_CODE_ENUM(clp_s::timestamp_parser::ErrorCodeEnum);
+
+#endif  // CLP_S_TIMESTAMP_PARSER_ERRORCODE_HPP