Skip to content

Commit

Permalink
Allow trailing comma in objects
Browse files Browse the repository at this point in the history
  • Loading branch information
kimsey0 authored and cdunn2001 committed Nov 14, 2019
1 parent d2e6a97 commit 01db7b7
Show file tree
Hide file tree
Showing 7 changed files with 20 additions and 2 deletions.
5 changes: 5 additions & 0 deletions include/json/json_features.h
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ class JSON_API Features {
/** \brief A configuration that allows all features and assumes all strings
* are UTF-8.
* - C & C++ comments are allowed
* - Trailing commas in objects and arrays are allowed.
* - Root object can be any JSON value
* - Assumes Value strings are encoded in UTF-8
*/
Expand All @@ -31,6 +32,7 @@ class JSON_API Features {
/** \brief A configuration that is strictly compatible with the JSON
* specification.
* - Comments are forbidden.
* - Trailing commas in objects and arrays are forbidden.
* - Root object must be either an array or an object value.
* - Assumes Value strings are encoded in UTF-8
*/
Expand All @@ -43,6 +45,9 @@ class JSON_API Features {
/// \c true if comments are allowed. Default: \c true.
bool allowComments_{true};

/// \c true if trailing commas in objects and arrays are allowed. Default \c true.
bool allowTrailingCommas_{true};

/// \c true if root must be either an array or an object value. Default: \c
/// false.
bool strictRoot_{false};
Expand Down
2 changes: 2 additions & 0 deletions include/json/reader.h
Original file line number Diff line number Diff line change
Expand Up @@ -299,6 +299,8 @@ class JSON_API CharReaderBuilder : public CharReader::Factory {
* if allowComments is false.
* - `"allowComments": false or true`
* - true if comments are allowed.
* - `"allowTrailingCommas": false or true`
* - true if trailing commas in objects and arrays are allowed.
* - `"strictRoot": false or true`
* - true if root must be either an array or an object value
* - `"allowDroppedNullPlaceholders": false or true`
Expand Down
10 changes: 8 additions & 2 deletions src/lib_json/json_reader.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ Features Features::all() { return {}; }
Features Features::strictMode() {
Features features;
features.allowComments_ = false;
features.allowTrailingCommas_ = false;
features.strictRoot_ = true;
features.allowDroppedNullPlaceholders_ = false;
features.allowNumericKeys_ = false;
Expand Down Expand Up @@ -454,7 +455,7 @@ bool Reader::readObject(Token& token) {
initialTokenOk = readToken(tokenName);
if (!initialTokenOk)
break;
if (tokenName.type_ == tokenObjectEnd && name.empty()) // empty object
if (tokenName.type_ == tokenObjectEnd && (name.empty() || features_.allowTrailingCommas_)) // empty object or trailing comma
return true;
name.clear();
if (tokenName.type_ == tokenString) {
Expand Down Expand Up @@ -863,6 +864,7 @@ class OurFeatures {
public:
static OurFeatures all();
bool allowComments_;
bool allowTrailingCommas_;
bool strictRoot_;
bool allowDroppedNullPlaceholders_;
bool allowNumericKeys_;
Expand Down Expand Up @@ -1437,7 +1439,7 @@ bool OurReader::readObject(Token& token) {
initialTokenOk = readToken(tokenName);
if (!initialTokenOk)
break;
if (tokenName.type_ == tokenObjectEnd && name.empty()) // empty object
if (tokenName.type_ == tokenObjectEnd && (name.empty() || features_.allowTrailingCommas_)) // empty object or trailing comma
return true;
name.clear();
if (tokenName.type_ == tokenString) {
Expand Down Expand Up @@ -1866,6 +1868,7 @@ CharReader* CharReaderBuilder::newCharReader() const {
bool collectComments = settings_["collectComments"].asBool();
OurFeatures features = OurFeatures::all();
features.allowComments_ = settings_["allowComments"].asBool();
features.allowTrailingCommas_ = settings_["allowTrailingCommas"].asBool();
features.strictRoot_ = settings_["strictRoot"].asBool();
features.allowDroppedNullPlaceholders_ =
settings_["allowDroppedNullPlaceholders"].asBool();
Expand All @@ -1884,6 +1887,7 @@ static void getValidReaderKeys(std::set<String>* valid_keys) {
valid_keys->clear();
valid_keys->insert("collectComments");
valid_keys->insert("allowComments");
valid_keys->insert("allowTrailingCommas");
valid_keys->insert("strictRoot");
valid_keys->insert("allowDroppedNullPlaceholders");
valid_keys->insert("allowNumericKeys");
Expand Down Expand Up @@ -1917,6 +1921,7 @@ Value& CharReaderBuilder::operator[](const String& key) {
void CharReaderBuilder::strictMode(Json::Value* settings) {
//! [CharReaderBuilderStrictMode]
(*settings)["allowComments"] = false;
(*settings)["allowTrailingCommas"] = false;
(*settings)["strictRoot"] = true;
(*settings)["allowDroppedNullPlaceholders"] = false;
(*settings)["allowNumericKeys"] = false;
Expand All @@ -1932,6 +1937,7 @@ void CharReaderBuilder::setDefaults(Json::Value* settings) {
//! [CharReaderBuilderDefaults]
(*settings)["collectComments"] = true;
(*settings)["allowComments"] = true;
(*settings)["allowTrailingCommas"] = true;
(*settings)["strictRoot"] = false;
(*settings)["allowDroppedNullPlaceholders"] = false;
(*settings)["allowNumericKeys"] = false;
Expand Down
1 change: 1 addition & 0 deletions src/test_lib_json/fuzz.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ extern "C" int LLVMFuzzerTestOneInput(const uint8_t* data, size_t size) {
builder.settings_["rejectDupKeys_"] = hash_settings & (1 << 7);
builder.settings_["allowSpecialFloats_"] = hash_settings & (1 << 8);
builder.settings_["collectComments"] = hash_settings & (1 << 9);
builder.settings_["allowTrailingCommas_"] = hash_settings & (1 << 10);

std::unique_ptr<Json::CharReader> reader(builder.newCharReader());

Expand Down
1 change: 1 addition & 0 deletions test/data/fail_test_object_01.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{ "count" : 1234,, }
2 changes: 2 additions & 0 deletions test/data/test_object_05.expected
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
.={}
.count=1234
1 change: 1 addition & 0 deletions test/data/test_object_05.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{ "count" : 1234, }

0 comments on commit 01db7b7

Please sign in to comment.