Option to throw exception when duplicate fields in section #34
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
Rookfighter
force-pushed
the
master
branch
2 times, most recently
from
b7fcbfa
to
6597b6d
Compare
Rookfighter
requested changes
Jan 20, 2024
include/inicpp.h
Outdated
| @@ -419,6 +419,7 @@ namespace ini | |||
| char esc_ = '\\'; | |||
| std::vector<std::string> commentPrefixes_ = { "#" , ";" }; | |||
| bool multiLineValues_ = false; | |||
| bool exceptionWhenDuplicateField_ = false; | |||
There was a problem hiding this comment.
Generally I prefer positive formulation, so here you could rename the member to something like overwriteDuplicateFields_ = true
include/inicpp.h
Outdated
Comment on lines
585
to
588
| /** Sets whether or not to throw an exception if duplicate fields are found in a section. | ||
| * Default is false. | ||
| * @param enable enable or disable? */ | ||
| void setExceptionWhenDuplicateField(bool enable) |
There was a problem hiding this comment.
Rename the function to something like allowOverwriteDuplicateFields. Also Update the docs accordingly, i.e. it should say that if overwriting duplicate fields is not allowed, then the parser will throw an exception.
include/inicpp.h
Outdated
| @@ -669,6 +678,13 @@ namespace ini | |||
| // retrieve field name and value | |||
| std::string name = line.substr(0, pos); | |||
| trim(name); | |||
| if (exceptionWhenDuplicateField_ && currentSection->count(name)) | |||
There was a problem hiding this comment.
Please add an explicit comparison, i.e. currentSection->count(name) > 0 or currentSection->count(name) != 0
Rookfighter
force-pushed
the
master
branch
3 times, most recently
from
425fbc0
to
91293f7
Compare
Rookfighter
approved these changes
Feb 1, 2024
|
Thanks for adapting and your contribution 👍 |
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.
Summary
This pull request adds the option to throw an exception when a duplicate field is found inside a section.
Problem
We need the option to detect if duplicate fields appear inside a section.
However, at the moment it is hard to detect duplicate fields inside a section after it has been decoded.
Solution
Similar to the
multiLineValues_option, the pull request addsexceptionWhenDuplicateField_. To avoid compatibility issues with prior versions, the option is disabled by default. It can be enabled and disabled with a call tosetExceptionWhenDuplicateField. When enabled, an exception is thrown if a duplicate field is found inside a section. When disabled, no exception is thrown when duplicate fields are encountered and the previously decoded value is overwritten, which is the same behaviour as before this pull request.To ensure correctness, two test cases have been added to test setting the option to enabled and disabled. The default case is already covered by an existing test case.