Skip to content

Added support for exception-free TOML; resolves #436 #447

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

Merged
merged 2 commits into from
Jun 9, 2025

Conversation

liuzicheng1987
Copy link
Contributor

No description provided.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Hello @liuzicheng1987, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

Hello team, Gemini here to provide a quick summary of this pull request. This PR, authored by liuzicheng1987, aims to add support for parsing TOML strings without relying on C++ exceptions. This is a valuable addition for users who compile their projects with exceptions disabled, often for performance or embedded system constraints. The changes primarily involve modifying the TOML reading logic to use conditional compilation based on whether TOML_EXCEPTIONS is defined, switching between a try-catch block and checking the result object returned by the underlying TOML parsing library.

Highlights

  • Exception-Free TOML Parsing: The main goal is to allow users to parse TOML configuration without requiring C++ exceptions to be enabled in their build environment.
  • Conditional Compilation: The implementation uses #if TOML_EXCEPTIONS to provide two different code paths for parsing TOML strings, one for exception-enabled builds and one for exception-disabled builds.
  • Error Handling: In the exception-free path, the code now checks the result of the ::toml::parse function and returns an error object if parsing fails, instead of throwing an exception.
  • Function Signature Update: The read function template taking a std::string_view is marked noexcept when exceptions are disabled, reflecting that it will not throw.

Changelog

  • include/rfl/toml/read.hpp
    • Modified the read function template that takes a std::string_view to use conditional compilation (#if TOML_EXCEPTIONS).
    • Added a try-catch block for the exception-enabled path.
    • Implemented error checking on the result object for the exception-free path.
    • Marked the function as noexcept in the exception-free path.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request aims to add support for exception-free TOML reading by introducing a noexcept specifier to the rfl::toml::read function and handling potential exceptions from the underlying toml-plus-plus parser. This is a valuable improvement for users who prefer or require exception-free APIs.

The core idea of using conditional compilation (#if TOML_EXCEPTIONS) and try-catch blocks is sound. However, there are critical concerns regarding the noexcept correctness that need to be addressed to prevent potential std::terminate calls.

Summary of Findings

  • noexcept correctness in TOML_EXCEPTIONS path: The catch block for when TOML_EXCEPTIONS is defined is too narrow (std::runtime_error). It should be widened to const std::exception& to prevent std::terminate if other standard exceptions (like std::bad_alloc) occur during TOML parsing or subsequent processing within the try block.
  • noexcept correctness in non-TOML_EXCEPTIONS path: The path for when TOML_EXCEPTIONS is not defined lacks exception handling for the read<T, Ps...> call. If this call throws any C++ exception (e.g., std::bad_alloc), it will violate the noexcept contract of the main function, leading to std::terminate. A try-catch(const std::exception&) block should be added.

Merge Readiness

The pull request addresses an important aspect of API design by aiming for exception-free TOML operations. However, due to the critical issues identified regarding noexcept correctness, which could lead to program termination, I recommend that these changes be addressed before merging. Once these concerns are resolved, the PR will be in a much better state. I am not authorized to approve pull requests, so please ensure further review and approval by authorized maintainers after addressing the feedback.

@liuzicheng1987 liuzicheng1987 merged commit 3789268 into main Jun 9, 2025
26 checks passed
@liuzicheng1987 liuzicheng1987 deleted the f/toml_exceptions branch June 9, 2025 19:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant