Skip to content

Make core #1

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

Jump to bottom
Merged
merged 45 commits into from
Jul 10, 2025
Merged

Make core #1

merged 45 commits into from
Jul 10, 2025

Conversation

@Katze719
Copy link
Member

@Katze719 Katze719 commented Jul 6, 2025

No description provided.

Katze719 added 3 commits July 6, 2025 13:14
@Katze719
Add initial project structure with CMake configuration, coding style …
c9a590f 
…settings, and core library headers
@Katze719
Revise README.md to reflect project renaming to cpp-core, update proj…
4e8b408 
…ect description, add requirements, and include quick start guide for usage with CPM.cmake and find_package.
@Katze719
Update README.md to change the GitHub repository reference for cpp-core
3f6cf07
@Katze719 Katze719 requested a review from Mqxx July 6, 2025 11:22
@Katze719 Katze719 self-assigned this Jul 6, 2025
Mqxx
Mqxx reviewed Jul 6, 2025
View reviewed changes
Mqxx
Mqxx reviewed Jul 6, 2025
View reviewed changes
Mqxx
Mqxx reviewed Jul 6, 2025
View reviewed changes
Mqxx
Mqxx requested changes Jul 6, 2025
View reviewed changes
Mqxx
Mqxx reviewed Jul 6, 2025
View reviewed changes
Mqxx
Mqxx reviewed Jul 6, 2025
View reviewed changes
Mqxx
Mqxx reviewed Jul 6, 2025
View reviewed changes
Mqxx
Mqxx reviewed Jul 6, 2025
View reviewed changes
Mqxx
Mqxx reviewed Jul 6, 2025
View reviewed changes
Mqxx
Mqxx reviewed Jul 6, 2025
View reviewed changes
Mqxx
Mqxx reviewed Jul 6, 2025
View reviewed changes
Katze719 and others added 11 commits July 6, 2025 18:34
@Katze719 @Mqxx
Apply suggestion from @Mqxx
e5b00b4 
Co-authored-by: Mqx <62719703+Mqxx@users.noreply.github.com>
@Katze719 @Mqxx
Apply suggestion from @Mqxx
908be3e 
Co-authored-by: Mqx <62719703+Mqxx@users.noreply.github.com>
@Katze719 @Mqxx
Apply suggestion from @Mqxx
6f24fab 
Co-authored-by: Mqx <62719703+Mqxx@users.noreply.github.com>
@Katze719 @Mqxx
Apply suggestion from @Mqxx
ff62ee2 
Co-authored-by: Mqx <62719703+Mqxx@users.noreply.github.com>
@Katze719 @Mqxx
Apply suggestion from @Mqxx
61723f5 
Co-authored-by: Mqx <62719703+Mqxx@users.noreply.github.com>
@Katze719
Update CMake configuration to generate version header in the binary d…
c50b476 
…irectory and adjust include directories for cpp_core library
@Katze719
Update serial.h to conditionally include version header based on avai…
6b33329 
…lability
@Katze719
Refactor CMake configuration to simplify version handling and update …
cdf3eac 
…include paths for version header
@Katze719
Update README.md to clarify usage of cache variables for versioning i…
e731cd2 
…n CPM.cmake integration
@Katze719
Enhance documentation with FFI usage guides for Deno, add C API refer…
6ee1837 
…ence, and update README for clarity on library usage
@Katze719
Add comprehensive library overview documentation, including installat…
b8e2ec5 
…ion instructions, directory structure, and minimal C example
@Katze719 Katze719 requested a review from Mqxx July 6, 2025 21:29
Mqxx
Mqxx requested changes Jul 8, 2025
View reviewed changes
Mqxx
Mqxx reviewed Jul 8, 2025
View reviewed changes
Mqxx
Mqxx requested changes Jul 8, 2025
View reviewed changes
Katze719 added 5 commits July 8, 2025 19:14
@Katze719
Update project to require C++23, reflecting changes in CMakeLists.txt…
ab7f65b 
…, README.md, and overview documentation.
@Katze719
Refine serial API documentation in header file for clarity and consis…
59d9d0d 
…tency. Update function descriptions, parameter details, and improve overall readability.
@Katze719
Update CMake configuration files: rename cpp_coreConfig.cmake.in to c…
a1aee33 
…pp_core_config.cmake.in and add initial content for package configuration.
@Katze719
Enhance serialWriteLine function signature in serial.h to include a m…
9fc44a9 
…ultiplier parameter for timeout adjustments. Update documentation for clarity on function behavior and parameter details.
@Katze719
Refactor serial API function signatures in serial.h for improved read…
99f4394 
…ability by formatting parameters across multiple lines. Update .clang-format to enforce new alignment and formatting rules.
Mqxx
Mqxx requested changes Jul 9, 2025
View reviewed changes
Katze719 and others added 2 commits July 9, 2025 07:47
@Katze719 @Mqxx
Update include/cpp_core/serial.h
b4957bb 
Co-authored-by: Mqx <62719703+Mqxx@users.noreply.github.com>
@Katze719 @Mqxx
Update include/cpp_core/serial.h
26ac28a 
Co-authored-by: Mqx <62719703+Mqxx@users.noreply.github.com>
Mqxx
Mqxx reviewed Jul 9, 2025
View reviewed changes
Katze719 added 3 commits July 9, 2025 20:20
@Katze719
Add umbrella header and modular API for cpp_core library
3eab2c1 
- Introduced `cpp_core.h` as an umbrella header to simplify access to the cpp_core library's public C/C++ API.
- Created `module_api.h` for platform-specific export definitions.
- Refactored `serial.h` to include modular interface headers for better organization and maintainability.
- Added multiple interface headers for serial operations, including functions for reading, writing, and managing serial ports.

This update enhances the library's structure and usability for developers.
@Katze719
Refactor formatting and documentation in cpp_core interface headers
27ee3a7 
- Updated .clang-format to disable alignment of trailing comments.
- Reformatted enum values in status_codes.h for improved readability.
- Enhanced documentation comments across multiple interface headers to ensure consistent formatting and clarity, particularly in parameter descriptions and return values.

These changes aim to improve code readability and maintainability throughout the cpp_core library.
@Katze719
Remove serialWriteLine function and its header from cpp_core library
4bbad79 
- Deleted the `serial_write_line.h` header file, which contained the `serialWriteLine` function definition.
- Updated `serial.h` to remove the inclusion of the deleted header.

This change streamlines the serial API by eliminating an unused function, enhancing maintainability.
Mqxx
Mqxx requested changes Jul 10, 2025
View reviewed changes
Copy link
Member

@Mqxx Mqxx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please check the @return statements for consistency. Some reference the enum some others do not.

include/cpp_core/module_api.h
Copy link
Member

@Mqxx Mqxx Jul 10, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know why we named this module_api. It makes kinda sense but also not xD but I also don't know a better name to reflect what it does.

Katze719 and others added 8 commits July 10, 2025 09:13
@Katze719 @Mqxx
Update include/cpp_core/interface/serial_get_ports_info.h
6c124eb 
Co-authored-by: Mqx <62719703+Mqxx@users.noreply.github.com>
@Katze719 @Mqxx
Update include/cpp_core/interface/serial_set_error_callback.h
a3460c8 
Co-authored-by: Mqx <62719703+Mqxx@users.noreply.github.com>
@Katze719 @Mqxx
Update include/cpp_core/interface/serial_set_read_callback.h
a7ed564 
Co-authored-by: Mqx <62719703+Mqxx@users.noreply.github.com>
@Katze719 @Mqxx
Update include/cpp_core/interface/serial_set_write_callback.h
fe273d8 
Co-authored-by: Mqx <62719703+Mqxx@users.noreply.github.com>
@Katze719
Add error callback support to serial interface functions
1bd6256 
- Introduced `ErrorCallbackT` type and added error callback parameter to multiple serial interface functions, enhancing error handling capabilities.
- Updated documentation to reflect changes in return values and parameters across various headers, ensuring clarity and consistency.

This update improves the robustness of the serial API by allowing users to handle errors more effectively.
@Katze719
Add optional error callback parameter to serial interface functions
bb57b7c 
- Enhanced multiple serial interface functions by adding an optional `error_callback` parameter, allowing users to handle errors more effectively.
- Updated documentation across various headers to reflect the new parameter, ensuring clarity and consistency.

This change improves the robustness of the serial API by providing better error handling capabilities.
@Katze719
Update .gitignore and CMakeLists.txt; refine documentation in serial …
9ff2e5a 
…interface headers

- Added `.cache/` to `.gitignore` to exclude cache files from version control.
- Removed unnecessary whitespace in `CMakeLists.txt` for cleaner formatting.
- Clarified return value documentation in `serial_drain.h` and `serial_open.h` to improve understanding of function outcomes.

These changes enhance project organization and improve code documentation clarity.
@Katze719
Clarify return value documentation in serial interface headers
719f80b 
- Updated return value descriptions in multiple serial interface header files to specify that negative error codes are derived from ::cpp_core::StatusCodes. This change enhances clarity and consistency in the documentation.

These updates improve the understanding of function outcomes across the serial API.
@Mqxx Mqxx merged commit f01cbfb into main Jul 10, 2025
@Katze719 Katze719 deleted the make-core branch November 14, 2025 16:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Mqxx Mqxx Mqxx requested changes

Assignees

@Katze719 Katze719

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@Katze719 @Mqxx