Refactor/better error codes #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open

Katze719 wants to merge 13 commits into main from refactor/better-error-codes

include/cpp_core/interface/serial_abort_read.h

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -12,11 +12,11 @@ extern "C"
  
         * @brief Abort a blocking read operation running in a different thread.

         *

         * The target read function returns immediately with

         * ::cpp_core::StatusCodes::kAbortReadError.

         * ::cpp_core::StatusCode::Io::kAbortReadError.

         *

         * @param handle Port handle.

         * @param error_callback [optional] Callback to invoke on error. Defined in error_callback.h. Default is `nullptr`.

         * @return 0 on success or a negative error code from ::cpp_core::StatusCodes on error.

         * @return 0 on success or a negative error code from ::cpp_core::StatusCode on error.

         */

        MODULE_API auto serialAbortRead(int64_t handle, ErrorCallbackT error_callback = nullptr) -> int;

include/cpp_core/interface/serial_abort_write.h

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -12,11 +12,11 @@ extern "C"
  
         * @brief Abort a blocking write operation running in a different thread.

         *

         * The target write function returns immediately with

         * ::cpp_core::StatusCodes::kAbortWriteError.

         * ::cpp_core::StatusCode::Io::kAbortWriteError.

         *

         * @param handle Port handle.

         * @param error_callback [optional] Callback to invoke on error. Defined in error_callback.h. Default is `nullptr`.

         * @return 0 on success or a negative error code from ::cpp_core::StatusCodes on error.

         * @return 0 on success or a negative error code from ::cpp_core::StatusCode on error.

         */

        MODULE_API auto serialAbortWrite(int64_t handle, ErrorCallbackT error_callback = nullptr) -> int;

include/cpp_core/status_code.h

Katze719 marked this conversation as resolved.

Show resolved Hide resolved

-Original file line number
+Diff line change
@@ -0,0 +1,179 @@
+    #pragma once
+    #include <cstdint>
+    #include <limits>
+    #include <string_view>
+    namespace cpp_core::status_codes
+    {
+    namespace detail
+    {
+    using ValueType = std::int64_t;
+    inline constexpr ValueType kCategoryMultiplier{100};
+    template <typename Category, ValueType NumericValue> struct Code
+    {
+        static constexpr ValueType kValue = NumericValue;
+        std::string_view kName; // NOLINT(readability-identifier-naming)
+        // NOLINTNEXTLINE(google-explicit-constructor, hicpp-explicit-conversions)
+        constexpr operator ValueType() const noexcept
+        {
+            return kValue;
+        }
+        [[nodiscard]] constexpr auto value() const noexcept -> ValueType
+        {
+            return kValue;
+        }
+        [[nodiscard]] constexpr auto name() const noexcept -> std::string_view
+        {
+            return kName;
+        }
+        [[nodiscard]] constexpr auto category() const noexcept -> std::string_view
+        {
+            return Category::kCategoryName;
+        }
+    };
+    template <typename Derived> struct CategoryBase
+    {
+      private:
+        constexpr CategoryBase() = default;
+      protected:
+        template <ValueType LocalCode> static consteval auto computeValue() -> ValueType
+        {
+            static_assert(Derived::kCategoryCode >= 0, "Category code must not be negative");
+            static_assert(LocalCode >= 0, "Code index must not be negative");
+            static_assert(LocalCode < kCategoryMultiplier, "Category overflow (max 99 codes)");
+            static_assert(Derived::kCategoryCode <=
+                              (std::numeric_limits<ValueType>::max() - kCategoryMultiplier + 1) / kCategoryMultiplier,
+                          "Category code too large, multiplication would overflow");
+            return -((Derived::kCategoryCode * kCategoryMultiplier) + LocalCode);
+        }
+        template <ValueType LocalCode> using Code = detail::Code<Derived, computeValue<LocalCode>()>;
+        friend Derived;
+    };
+    } // namespace detail
+    struct StatusCode
+    {
+        using ValueType = detail::ValueType;
+        static constexpr ValueType kSuccess = 0;
+        struct Configuration : detail::CategoryBase<Configuration>
+        {
+            static constexpr ValueType kCategoryCode = 1;
+            static constexpr std::string_view kCategoryName{"Configuration"};
+            static constexpr Code<0> kSetBaudrateError{"SetBaudrateError"};
+            static constexpr Code<1> kSetDataBitsError{"SetDataBitsError"};
+            static constexpr Code<2> kSetParityError{"SetParityError"};
+            static constexpr Code<3> kSetStopBitsError{"SetStopBitsError"};
+            static constexpr Code<4> kSetFlowControlError{"SetFlowControlError"};
+            static constexpr Code<5> kSetTimeoutError{"SetTimeoutError"};
+        };
+        struct Connection : detail::CategoryBase<Connection>
+        {
+            static constexpr ValueType kCategoryCode = 2;
+            static constexpr std::string_view kCategoryName{"Connection"};
+            static constexpr Code<0> kNotFoundError{"NotFoundError"};
+            static constexpr Code<1> kInvalidHandleError{"InvalidHandleError"};
+            static constexpr Code<2> kCloseHandleError{"CloseHandleError"};
+        };
+        struct Io : detail::CategoryBase<Io>
+        {
+            static constexpr ValueType kCategoryCode = 3;
+            static constexpr std::string_view kCategoryName{"Io"};
+            static constexpr Code<0> kReadError{"ReadError"};
+            static constexpr Code<1> kWriteError{"WriteError"};
+            static constexpr Code<2> kAbortReadError{"AbortReadError"};
+            static constexpr Code<3> kAbortWriteError{"AbortWriteError"};
+            static constexpr Code<4> kBufferError{"BufferError"};
+            static constexpr Code<5> kClearBufferInError{"ClearBufferInError"};
+            static constexpr Code<6> kClearBufferOutError{"ClearBufferOutError"};
+        };
+        struct Control : detail::CategoryBase<Control>
+        {
+            static constexpr ValueType kCategoryCode = 4;
+            static constexpr std::string_view kCategoryName{"Control"};
+            static constexpr Code<0> kSetDtrError{"SetDtrError"};
+            static constexpr Code<1> kSetRtsError{"SetRtsError"};
+            static constexpr Code<2> kGetModemStatusError{"GetModemStatusError"};
+            static constexpr Code<3> kSendBreakError{"SendBreakError"};
+            static constexpr Code<4> kGetStateError{"GetStateError"};
+            static constexpr Code<5> kSetStateError{"SetStateError"};
+        };
+        [[nodiscard]] static constexpr auto isError(ValueType code) noexcept -> bool
+        {
+            return code < 0;
+        }
+        [[nodiscard]] static constexpr auto isSuccess(ValueType code) noexcept -> bool
+        {
+            return code >= 0;
+        }
+        template <typename Category> [[nodiscard]] static constexpr auto belongsTo(ValueType code) noexcept -> bool
+        {
+            return code < 0 && (-code) / detail::kCategoryMultiplier == Category::kCategoryCode;
+        }
+    };
+    } // namespace cpp_core::status_codes
+    namespace cpp_core
+    {
+    using ::cpp_core::status_codes::StatusCode;
+    } // namespace cpp_core
+    namespace cpp_core::status_codes::detail::tests
+    {
+    template <int64_t CatCode> struct FakeCategory : CategoryBase<FakeCategory<CatCode>>
+    {
+        static constexpr ValueType kCategoryCode = CatCode;
+        template <ValueType Local> static consteval auto call() -> ValueType
+        {
+            return CategoryBase<FakeCategory>::template computeValue<Local>();
+        }
+    };
+    // Formula: result == -(kCategoryCode * 100 + LocalCode)
+    static_assert(FakeCategory<1>::call<0>() == -100);
+    static_assert(FakeCategory<1>::call<42>() == -142);
+    static_assert(FakeCategory<3>::call<7>() == -307);
+    // Edge: kCategoryCode == 0 -> call<0>() produces 0 (not negative)
+    static_assert(FakeCategory<0>::call<0>() == 0);
+    static_assert(FakeCategory<0>::call<1>() == -1);
+    // Edge: LocalCode == 99 (max before overflow guard)
+    static_assert(FakeCategory<2>::call<99>() == -299);
+    // Consecutive codes differ by exactly -1
+    static_assert(FakeCategory<1>::call<1>() - FakeCategory<1>::call<0>() == -1);
+    // Adjacent category ranges don't overlap (last of cat N > first of cat N+1)
+    static_assert(FakeCategory<1>::call<99>() > FakeCategory<2>::call<0>());
+    // Overflow: largest safe category still produces correct results
+    inline constexpr ValueType kMaxSafeCat =
+        (std::numeric_limits<ValueType>::max() - kCategoryMultiplier + 1) / kCategoryMultiplier;
+    static_assert(kMaxSafeCat > 1'000'000);
+    static_assert(FakeCategory<kMaxSafeCat>::call<0>() == -(kMaxSafeCat * kCategoryMultiplier));
+    static_assert(FakeCategory<kMaxSafeCat>::call<99>() > std::numeric_limits<ValueType>::min());
+    } // namespace cpp_core::status_codes::detail::tests

include/cpp_core/status_codes.h

This file was deleted.

include/cpp_core/status_codes.hpp

This file was deleted.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor/better error codes #18

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Refactor/better error codes #18

Are you sure you want to change the base?

Uh oh!

Refactor/better error codes #18

Uh oh!

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!

Uh oh!

Uh oh!