From 1fb721799fba209fc5496f94a4915224987d7044 Mon Sep 17 00:00:00 2001 From: Katze719 Date: Fri, 5 Dec 2025 16:51:59 +0100 Subject: [PATCH] Refactor code formatting and improve readability - Updated .clang-format settings to align after open brackets and enable alignment for trailing comments and consecutive declarations. - Simplified function signatures in multiple header files by removing unnecessary line breaks, enhancing code readability. - Adjusted the formatting of enum values in status_codes.h for consistency. These changes aim to improve code clarity and maintainability across the codebase. --- .clang-format | 10 +++---- include/cpp_core/error_callback.h | 5 +--- include/cpp_core/interface/get_version.h | 14 +++++----- .../cpp_core/interface/serial_abort_read.h | 5 +--- .../cpp_core/interface/serial_abort_write.h | 5 +--- .../interface/serial_clear_buffer_in.h | 5 +--- .../interface/serial_clear_buffer_out.h | 5 +--- include/cpp_core/interface/serial_close.h | 5 +--- include/cpp_core/interface/serial_drain.h | 5 +--- .../interface/serial_in_bytes_total.h | 5 +--- .../interface/serial_in_bytes_waiting.h | 5 +--- .../cpp_core/interface/serial_list_ports.h | 18 ++++--------- include/cpp_core/interface/serial_open.h | 10 ++----- .../interface/serial_out_bytes_total.h | 5 +--- .../interface/serial_out_bytes_waiting.h | 5 +--- include/cpp_core/interface/serial_read.h | 10 ++----- include/cpp_core/interface/serial_read_line.h | 10 ++----- .../cpp_core/interface/serial_read_until.h | 11 ++------ .../interface/serial_read_until_sequence.h | 12 +++------ include/cpp_core/interface/serial_write.h | 10 ++----- include/cpp_core/status_codes.h | 26 +++++++++---------- 21 files changed, 53 insertions(+), 133 deletions(-) diff --git a/.clang-format b/.clang-format index 86cbf0d..ed08e49 100644 --- a/.clang-format +++ b/.clang-format @@ -2,12 +2,10 @@ Language: Cpp # BasedOnStyle: Microsoft AccessModifierOffset: -2 -AlignAfterOpenBracket: BlockIndent +AlignAfterOpenBracket: Align AlignEscapedNewlines: Right AlignOperands: Align -AlignTrailingComments: false -AlignConsecutiveAssignments: true -AlignConsecutiveDeclarations: true +AlignTrailingComments: true AllowAllArgumentsOnNextLine: true AllowAllConstructorInitializersOnNextLine: true AllowAllParametersOfDeclarationOnNextLine: true @@ -24,8 +22,8 @@ AlwaysBreakBeforeMultilineStrings: false AlwaysBreakTemplateDeclarations: MultiLine AttributeMacros: - __capability -BinPackArguments: false -BinPackParameters: AlwaysOnePerLine +BinPackArguments: true +BinPackParameters: true BraceWrapping: AfterCaseLabel: false AfterClass: true diff --git a/include/cpp_core/error_callback.h b/include/cpp_core/error_callback.h index 3217320..ffef1ab 100644 --- a/include/cpp_core/error_callback.h +++ b/include/cpp_core/error_callback.h @@ -5,10 +5,7 @@ extern "C" { #endif - using ErrorCallbackT = void (*)( - int error_code, - const char *message - ); + using ErrorCallbackT = void (*)(int error_code, const char *message); #ifdef __cplusplus } // extern "C" diff --git a/include/cpp_core/interface/get_version.h b/include/cpp_core/interface/get_version.h index 8ee89c8..eee1893 100644 --- a/include/cpp_core/interface/get_version.h +++ b/include/cpp_core/interface/get_version.h @@ -11,14 +11,14 @@ extern "C" { struct Version { - int major = version::MAJOR; - int minor = version::MINOR; - int patch = version::PATCH; + int major = version::MAJOR; + int minor = version::MINOR; + int patch = version::PATCH; const char *commit_hash_short = version::GIT_COMMIT_HASH_SHORT; - const char *commit_hash_full = version::GIT_COMMIT_HASH_FULL; - const char *commit_date = version::GIT_COMMIT_DATE; - const char *branch = version::GIT_BRANCH; - const char *version_string = version::VERSION; + const char *commit_hash_full = version::GIT_COMMIT_HASH_FULL; + const char *commit_date = version::GIT_COMMIT_DATE; + const char *branch = version::GIT_BRANCH; + const char *version_string = version::VERSION; }; } // namespace cpp_core diff --git a/include/cpp_core/interface/serial_abort_read.h b/include/cpp_core/interface/serial_abort_read.h index 7925546..8db85bb 100644 --- a/include/cpp_core/interface/serial_abort_read.h +++ b/include/cpp_core/interface/serial_abort_read.h @@ -18,10 +18,7 @@ extern "C" * @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. */ - MODULE_API auto serialAbortRead( - int64_t handle, - ErrorCallbackT error_callback = nullptr - ) -> int; + MODULE_API auto serialAbortRead(int64_t handle, ErrorCallbackT error_callback = nullptr) -> int; #ifdef __cplusplus } diff --git a/include/cpp_core/interface/serial_abort_write.h b/include/cpp_core/interface/serial_abort_write.h index f5c3d0c..46fd50f 100644 --- a/include/cpp_core/interface/serial_abort_write.h +++ b/include/cpp_core/interface/serial_abort_write.h @@ -18,10 +18,7 @@ extern "C" * @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. */ - MODULE_API auto serialAbortWrite( - int64_t handle, - ErrorCallbackT error_callback = nullptr - ) -> int; + MODULE_API auto serialAbortWrite(int64_t handle, ErrorCallbackT error_callback = nullptr) -> int; #ifdef __cplusplus } diff --git a/include/cpp_core/interface/serial_clear_buffer_in.h b/include/cpp_core/interface/serial_clear_buffer_in.h index 8723016..7a477eb 100644 --- a/include/cpp_core/interface/serial_clear_buffer_in.h +++ b/include/cpp_core/interface/serial_clear_buffer_in.h @@ -18,10 +18,7 @@ extern "C" * @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. */ - MODULE_API auto serialClearBufferIn( - int64_t handle, - ErrorCallbackT error_callback = nullptr - ) -> int; + MODULE_API auto serialClearBufferIn(int64_t handle, ErrorCallbackT error_callback = nullptr) -> int; #ifdef __cplusplus } diff --git a/include/cpp_core/interface/serial_clear_buffer_out.h b/include/cpp_core/interface/serial_clear_buffer_out.h index 3a8fcc5..d20beb2 100644 --- a/include/cpp_core/interface/serial_clear_buffer_out.h +++ b/include/cpp_core/interface/serial_clear_buffer_out.h @@ -18,10 +18,7 @@ extern "C" * @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. */ - MODULE_API auto serialClearBufferOut( - int64_t handle, - ErrorCallbackT error_callback = nullptr - ) -> int; + MODULE_API auto serialClearBufferOut(int64_t handle, ErrorCallbackT error_callback = nullptr) -> int; #ifdef __cplusplus } diff --git a/include/cpp_core/interface/serial_close.h b/include/cpp_core/interface/serial_close.h index 55b4e94..667bd38 100644 --- a/include/cpp_core/interface/serial_close.h +++ b/include/cpp_core/interface/serial_close.h @@ -18,10 +18,7 @@ extern "C" * @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. */ - MODULE_API auto serialClose( - int64_t handle, - ErrorCallbackT error_callback = nullptr - ) -> int; + MODULE_API auto serialClose(int64_t handle, ErrorCallbackT error_callback = nullptr) -> int; #ifdef __cplusplus } diff --git a/include/cpp_core/interface/serial_drain.h b/include/cpp_core/interface/serial_drain.h index 7e1f2bc..806862d 100644 --- a/include/cpp_core/interface/serial_drain.h +++ b/include/cpp_core/interface/serial_drain.h @@ -31,10 +31,7 @@ extern "C" * @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. */ - MODULE_API auto serialDrain( - int64_t handle, - ErrorCallbackT error_callback = nullptr - ) -> int; + MODULE_API auto serialDrain(int64_t handle, ErrorCallbackT error_callback = nullptr) -> int; #ifdef __cplusplus } diff --git a/include/cpp_core/interface/serial_in_bytes_total.h b/include/cpp_core/interface/serial_in_bytes_total.h index 330a530..87a6776 100644 --- a/include/cpp_core/interface/serial_in_bytes_total.h +++ b/include/cpp_core/interface/serial_in_bytes_total.h @@ -15,10 +15,7 @@ extern "C" * @param error_callback [optional] Callback to invoke on error. Defined in error_callback.h. Default is `nullptr`. * @return Total number of bytes read or a negative error code from ::cpp_core::StatusCodes on error. */ - MODULE_API auto serialInBytesTotal( - int64_t handle, - ErrorCallbackT error_callback = nullptr - ) -> int64_t; + MODULE_API auto serialInBytesTotal(int64_t handle, ErrorCallbackT error_callback = nullptr) -> int64_t; #ifdef __cplusplus } diff --git a/include/cpp_core/interface/serial_in_bytes_waiting.h b/include/cpp_core/interface/serial_in_bytes_waiting.h index cf3adae..ea5c0b9 100644 --- a/include/cpp_core/interface/serial_in_bytes_waiting.h +++ b/include/cpp_core/interface/serial_in_bytes_waiting.h @@ -26,10 +26,7 @@ extern "C" * @param error_callback [optional] Callback to invoke on error. Defined in error_callback.h. Default is `nullptr`. * @return Bytes available for instant reading or a negative error code from ::cpp_core::StatusCodes on error. */ - MODULE_API auto serialInBytesWaiting( - int64_t handle, - ErrorCallbackT error_callback = nullptr - ) -> int; + MODULE_API auto serialInBytesWaiting(int64_t handle, ErrorCallbackT error_callback = nullptr) -> int; #ifdef __cplusplus } diff --git a/include/cpp_core/interface/serial_list_ports.h b/include/cpp_core/interface/serial_list_ports.h index 0a5d34a..713f1eb 100644 --- a/include/cpp_core/interface/serial_list_ports.h +++ b/include/cpp_core/interface/serial_list_ports.h @@ -17,19 +17,11 @@ extern "C" * @param error_callback [optional] Callback to invoke on error. Defined in error_callback.h. Default is `nullptr`. * @return Number of ports found or a negative error code from ::cpp_core::StatusCodes on error. */ - MODULE_API auto serialListPorts( - void (*callback_fn)( - const char *port, - const char *path, - const char *manufacturer, - const char *serial_number, - const char *pnp_id, - const char *location_id, - const char *product_id, - const char *vendor_id - ), - ErrorCallbackT error_callback = nullptr - ) -> int; + MODULE_API auto serialListPorts(void (*callback_fn)(const char *port, const char *path, const char *manufacturer, + const char *serial_number, const char *pnp_id, + const char *location_id, const char *product_id, + const char *vendor_id), + ErrorCallbackT error_callback = nullptr) -> int; #ifdef __cplusplus } diff --git a/include/cpp_core/interface/serial_open.h b/include/cpp_core/interface/serial_open.h index 0388f2a..3ddea3a 100644 --- a/include/cpp_core/interface/serial_open.h +++ b/include/cpp_core/interface/serial_open.h @@ -25,14 +25,8 @@ extern "C" * @param error_callback [optional] Callback to invoke on error. Defined in error_callback.h. Default is `nullptr`. * @return A positive opaque handle on success or a negative value from ::cpp_core::StatusCodes on failure. */ - MODULE_API auto serialOpen( - void *port, - int baudrate, - int data_bits, - int parity = 0, - int stop_bits = 0, - ErrorCallbackT error_callback = nullptr - ) -> intptr_t; + MODULE_API auto serialOpen(void *port, int baudrate, int data_bits, int parity = 0, int stop_bits = 0, + ErrorCallbackT error_callback = nullptr) -> intptr_t; #ifdef __cplusplus } diff --git a/include/cpp_core/interface/serial_out_bytes_total.h b/include/cpp_core/interface/serial_out_bytes_total.h index a29336e..9e5cd4d 100644 --- a/include/cpp_core/interface/serial_out_bytes_total.h +++ b/include/cpp_core/interface/serial_out_bytes_total.h @@ -15,10 +15,7 @@ extern "C" * @param error_callback [optional] Callback to invoke on error. Defined in error_callback.h. Default is `nullptr`. * @return Total number of bytes written or a negative error code from ::cpp_core::StatusCodes on error. */ - MODULE_API auto serialOutBytesTotal( - int64_t handle, - ErrorCallbackT error_callback = nullptr - ) -> int64_t; + MODULE_API auto serialOutBytesTotal(int64_t handle, ErrorCallbackT error_callback = nullptr) -> int64_t; #ifdef __cplusplus } diff --git a/include/cpp_core/interface/serial_out_bytes_waiting.h b/include/cpp_core/interface/serial_out_bytes_waiting.h index 14fc6ee..f2f5db3 100644 --- a/include/cpp_core/interface/serial_out_bytes_waiting.h +++ b/include/cpp_core/interface/serial_out_bytes_waiting.h @@ -24,10 +24,7 @@ extern "C" * @param error_callback [optional] Callback to invoke on error. Defined in error_callback.h. Default is `nullptr`. * @return Bytes still waiting in the TX FIFO or a negative error code from ::cpp_core::StatusCodes on error. */ - MODULE_API auto serialOutBytesWaiting( - int64_t handle, - ErrorCallbackT error_callback = nullptr - ) -> int; + MODULE_API auto serialOutBytesWaiting(int64_t handle, ErrorCallbackT error_callback = nullptr) -> int; #ifdef __cplusplus } diff --git a/include/cpp_core/interface/serial_read.h b/include/cpp_core/interface/serial_read.h index 1d1a1fb..8ae136d 100644 --- a/include/cpp_core/interface/serial_read.h +++ b/include/cpp_core/interface/serial_read.h @@ -25,14 +25,8 @@ extern "C" * @param error_callback [optional] Callback to invoke on error. Defined in error_callback.h. Default is `nullptr`. * @return Bytes read (0 on timeout) or a negative error code from ::cpp_core::StatusCodes on error. */ - MODULE_API auto serialRead( - int64_t handle, - void *buffer, - int buffer_size, - int timeout_ms, - int multiplier, - ErrorCallbackT error_callback = nullptr - ) -> int; + MODULE_API auto serialRead(int64_t handle, void *buffer, int buffer_size, int timeout_ms, int multiplier, + ErrorCallbackT error_callback = nullptr) -> int; #ifdef __cplusplus } diff --git a/include/cpp_core/interface/serial_read_line.h b/include/cpp_core/interface/serial_read_line.h index 62db720..b4a6db0 100644 --- a/include/cpp_core/interface/serial_read_line.h +++ b/include/cpp_core/interface/serial_read_line.h @@ -23,14 +23,8 @@ extern "C" * @param error_callback [optional] Callback to invoke on error. Defined in error_callback.h. Default is `nullptr`. * @return Bytes read (0 on timeout) or a negative error code from ::cpp_core::StatusCodes on error. */ - MODULE_API auto serialReadLine( - int64_t handle, - void *buffer, - int buffer_size, - int timeout_ms, - int multiplier, - ErrorCallbackT error_callback = nullptr - ) -> int; + MODULE_API auto serialReadLine(int64_t handle, void *buffer, int buffer_size, int timeout_ms, int multiplier, + ErrorCallbackT error_callback = nullptr) -> int; #ifdef __cplusplus } diff --git a/include/cpp_core/interface/serial_read_until.h b/include/cpp_core/interface/serial_read_until.h index ea276ac..0e27217 100644 --- a/include/cpp_core/interface/serial_read_until.h +++ b/include/cpp_core/interface/serial_read_until.h @@ -26,15 +26,8 @@ extern "C" * @return Bytes read (including the terminator), 0 on timeout or a negative error code from ::cpp_core::StatusCodes * on error. */ - MODULE_API auto serialReadUntil( - int64_t handle, - void *buffer, - int buffer_size, - int timeout_ms, - int multiplier, - void *until_char, - ErrorCallbackT error_callback = nullptr - ) -> int; + MODULE_API auto serialReadUntil(int64_t handle, void *buffer, int buffer_size, int timeout_ms, int multiplier, + void *until_char, ErrorCallbackT error_callback = nullptr) -> int; #ifdef __cplusplus } diff --git a/include/cpp_core/interface/serial_read_until_sequence.h b/include/cpp_core/interface/serial_read_until_sequence.h index ff346c1..c56ebbd 100644 --- a/include/cpp_core/interface/serial_read_until_sequence.h +++ b/include/cpp_core/interface/serial_read_until_sequence.h @@ -24,15 +24,9 @@ extern "C" * @param error_callback [optional] Callback to invoke on error. Defined in error_callback.h. Default is `nullptr`. * @return Bytes read (including the terminator) or a negative error code from ::cpp_core::StatusCodes on error. */ - MODULE_API auto serialReadUntilSequence( - int64_t handle, - void *buffer, - int buffer_size, - int timeout_ms, - int multiplier, - void *sequence, - ErrorCallbackT error_callback = nullptr - ) -> int; + MODULE_API auto serialReadUntilSequence(int64_t handle, void *buffer, int buffer_size, int timeout_ms, + int multiplier, void *sequence, ErrorCallbackT error_callback = nullptr) + -> int; #ifdef __cplusplus } diff --git a/include/cpp_core/interface/serial_write.h b/include/cpp_core/interface/serial_write.h index 3945dcb..375b830 100644 --- a/include/cpp_core/interface/serial_write.h +++ b/include/cpp_core/interface/serial_write.h @@ -23,14 +23,8 @@ extern "C" * @param error_callback [optional] Callback to invoke on error. Defined in error_callback.h. Default is `nullptr`. * @return Bytes written (may be 0 on timeout) or a negative error code from ::cpp_core::StatusCodes on error. */ - MODULE_API auto serialWrite( - int64_t handle, - const void *buffer, - int buffer_size, - int timeout_ms, - int multiplier, - ErrorCallbackT error_callback = nullptr - ) -> int; + MODULE_API auto serialWrite(int64_t handle, const void *buffer, int buffer_size, int timeout_ms, int multiplier, + ErrorCallbackT error_callback = nullptr) -> int; #ifdef __cplusplus } diff --git a/include/cpp_core/status_codes.h b/include/cpp_core/status_codes.h index 11b45c9..46c5bc3 100644 --- a/include/cpp_core/status_codes.h +++ b/include/cpp_core/status_codes.h @@ -4,19 +4,19 @@ namespace cpp_core { enum class StatusCodes { - kSuccess = 0, - kCloseHandleError = -1, - kInvalidHandleError = -2, - kReadError = -3, - kWriteError = -4, - kGetStateError = -5, - kSetStateError = -6, - kSetTimeoutError = -7, - kBufferError = -8, - kNotFoundError = -9, - kClearBufferInError = -10, + kSuccess = 0, + kCloseHandleError = -1, + kInvalidHandleError = -2, + kReadError = -3, + kWriteError = -4, + kGetStateError = -5, + kSetStateError = -6, + kSetTimeoutError = -7, + kBufferError = -8, + kNotFoundError = -9, + kClearBufferInError = -10, kClearBufferOutError = -11, - kAbortReadError = -12, - kAbortWriteError = -13, + kAbortReadError = -12, + kAbortWriteError = -13, }; } // namespace cpp_core