Skip to content

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.

Sign up for GitHub

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

Merged
Katze719 merged 14 commits into from
Jun 6, 2026
Merged

Refactor/better error codes #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
edd214c
Refactor status codes and remove deprecated header
Katze719 Mar 17, 2026
1616b1c
Refactor status code definitions in status_codes.h
Katze719 Mar 17, 2026
f9aef38
Enhance status code structure in status_codes.h
Katze719 Mar 17, 2026
be05f7b
Refactor status code organization in status_codes.h
Katze719 Mar 17, 2026
6ea7683
Remove the Monitor struct from status_codes.h to streamline status co…
Katze719 Mar 18, 2026
f4bf824
Add status code definitions in a new header file
Katze719 Mar 18, 2026
b833253
Refactor CategoryBase template in status_code.h
Katze719 Mar 18, 2026
8b235ba
Update kCategoryMultiplier initialization in CategoryBase template
Katze719 Mar 18, 2026
176158d
Add new status code generation macros and enhance error handling
Katze719 Mar 18, 2026
2b63c69
Refactor error handling functions in StatusCode
Katze719 Mar 18, 2026
a5ce350
Enhance status code structure in status_code.h
Katze719 Mar 19, 2026
9375730
Update include/cpp_core/status_code.h
Katze719 Mar 20, 2026
ba2838b
Enhance CategoryBase template in status_code.h
Katze719 Mar 20, 2026
27e1913
test: move status code static asserts into compile test
Katze719 Jun 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CMakeLists.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -49,6 +49,13 @@ target_compile_features(cpp_core INTERFACE cxx_std_23)
set(CMAKE_CXX_MODULE_STD 23)
set(CMAKE_CXX_MODULE_EXTENSIONS OFF)

include(CTest)

if(BUILD_TESTING)
add_library(cpp_core_status_code_compile_test OBJECT tests/status_code_compile_test.cpp)
target_link_libraries(cpp_core_status_code_compile_test PRIVATE cpp_core::cpp_core)
endif()

# Install rules --------------------------------------------------------------
include(GNUInstallDirs)

Expand Down
2 changes: 1 addition & 1 deletion include/cpp_core.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -14,5 +14,5 @@

#include "cpp_core/error_callback.h"
#include "cpp_core/serial.h"
#include "cpp_core/status_codes.h"
#include "cpp_core/status_code.h"
#include "cpp_core/version.hpp"
2 changes: 1 addition & 1 deletion include/cpp_core/error_handling.hpp
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
#pragma once

#include "status_codes.h"
#include "status_code.h"

#include <concepts>
#include <string>
Expand Down
4 changes: 2 additions & 2 deletions include/cpp_core/interface/serial_abort_read.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

Expand Down
4 changes: 2 additions & 2 deletions include/cpp_core/interface/serial_abort_write.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -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;

Expand Down
2 changes: 1 addition & 1 deletion include/cpp_core/result.hpp
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
#pragma once

#include "status_codes.h"
#include "status_code.h"

#include <concepts>
#include <expected>
Expand Down
139 changes: 139 additions & 0 deletions include/cpp_core/status_code.h
View file
Open in desktop
Comment thread
Katze719 marked this conversation as resolved.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,139 @@
#pragma once

#include <cstdint>
#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 StatusCodes = ::cpp_core::status_codes::detail::ValueType;
using ::cpp_core::status_codes::StatusCode;
} // namespace cpp_core
31 changes: 0 additions & 31 deletions include/cpp_core/status_codes.h
View file
Open in desktop

This file was deleted.

108 changes: 0 additions & 108 deletions include/cpp_core/status_codes.hpp
View file
Open in desktop

This file was deleted.

Loading