-
Notifications
You must be signed in to change notification settings - Fork 71
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
Add support for validating and escaping UTF-8 strings. #453
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kirkrodrigues
requested changes
Jun 24, 2024
kirkrodrigues
requested changes
Jun 25, 2024
Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>
Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>
kirkrodrigues
requested changes
Jun 26, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice work. A few remaining renaming suggestions.
kirkrodrigues
requested changes
Jun 26, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Docstring fixes
Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>
kirkrodrigues
changed the title
Add support for validating and escaping UTF8 strings.
Add support for validating and escaping UTF-8 strings.
Jun 27, 2024
kirkrodrigues
approved these changes
Jun 27, 2024
jackluo923
pushed a commit
to jackluo923/clp
that referenced
this pull request
Dec 4, 2024
Co-authored-by: kirkrodrigues <2454684+kirkrodrigues@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Motivation
When outputting a C++ string to a human-readable (printable) format, we must ensure the string is UTF8 valid, and escape special characters such as the new line character
\n
or the quote mark"
. This is required if we want to serialize string data into a JSON format.There are third-party libraries that already implement such a validation + escaping mechanism. For example,
nlohmann JSON
provides string dump to execute the validation and escape. However, using external libraries have the following problems:Therefore, we decide to implement our own implementation for validating and escaping UTF8 strings.
Implementation
The functionalities can be breakdown as follows:
Validate UTF8 encoding:
Escape special characters
\\u00xx
This PR adds a util function to implement the functionalities listed above.
Validation performed