Added ARDUINOJSON_ENABLE_COMMENTS to enable support for comments

2025-11-01 00:38:27 +01:00 · 2020-01-13 18:16:02 +01:00
parent f9cfea244a
commit 04fe7e1a27
11 changed files with 488 additions and 393 deletions
--- a/extras/tests/MixedConfiguration/CMakeLists.txt
+++ b/extras/tests/MixedConfiguration/CMakeLists.txt
@@ -18,6 +18,8 @@ add_executable(MixedConfigurationTests
 	use_long_long_0.cpp
 	use_long_long_1.cpp
 	enable_progmem_1.cpp
+	enable_comments_1.cpp
+	enable_comments_0.cpp
 )

 target_link_libraries(MixedConfigurationTests catch)
--- a/extras/tests/MixedConfiguration/enable_comments_0.cpp
+++ b/extras/tests/MixedConfiguration/enable_comments_0.cpp
@@ -0,0 +1,54 @@
+// ArduinoJson - arduinojson.org
+// Copyright Benoit Blanchon 2014-2020
+// MIT License
+
+#define ARDUINOJSON_ENABLE_COMMENTS 0
+#include <ArduinoJson.h>
+
+#include <catch.hpp>
+
+TEST_CASE("Comments should produce InvalidInput") {
+  DynamicJsonDocument doc(2048);
+
+  const char* testCases[] = {
+      "/*COMMENT*/  [\"hello\"]",
+      "[/*COMMENT*/ \"hello\"]",
+      "[\"hello\"/*COMMENT*/]",
+      "[\"hello\"/*COMMENT*/,\"world\"]",
+      "[\"hello\",/*COMMENT*/ \"world\"]",
+      "[/*/\n]",
+      "[/*COMMENT]",
+      "[/*COMMENT*]",
+      "//COMMENT\n\t[\"hello\"]",
+      "[//COMMENT\n\"hello\"]",
+      "[\"hello\"//COMMENT\r\n]",
+      "[\"hello\"//COMMENT\n,\"world\"]",
+      "[\"hello\",//COMMENT\n\"world\"]",
+      "[/COMMENT\n]",
+      "[//COMMENT",
+      "/*COMMENT*/ {\"hello\":\"world\"}",
+      "{/*COMMENT*/\"hello\":\"world\"}",
+      "{\"hello\"/*COMMENT*/:\"world\"}",
+      "{\"hello\":/*COMMENT*/\"world\"}",
+      "{\"hello\":\"world\"/*COMMENT*/}",
+      "//COMMENT\n {\"hello\":\"world\"}",
+      "{//COMMENT\n\"hello\":\"world\"}",
+      "{\"hello\"//COMMENT\n:\"world\"}",
+      "{\"hello\"://COMMENT\n\"world\"}",
+      "{\"hello\":\"world\"//COMMENT\n}",
+      "/{\"hello\":\"world\"}",
+      "{/\"hello\":\"world\"}",
+      "{\"hello\"/:\"world\"}",
+      "{\"hello\":/\"world\"}",
+      "{\"hello\":\"world\"/}",
+      "{\"hello\":\"world\"/,\"answer\":42}",
+      "{\"hello\":\"world\",/\"answer\":42}",
+  };
+  const size_t testCount = sizeof(testCases) / sizeof(testCases[0]);
+
+  for (size_t i = 0; i < testCount; i++) {
+    const char* input = testCases[i];
+    CAPTURE(input);
+    REQUIRE(deserializeJson(doc, input) == DeserializationError::InvalidInput);
+  }
+}
--- a/extras/tests/MixedConfiguration/enable_comments_1.cpp
+++ b/extras/tests/MixedConfiguration/enable_comments_1.cpp
@@ -0,0 +1,405 @@
+// ArduinoJson - arduinojson.org
+// Copyright Benoit Blanchon 2014-2020
+// MIT License
+
+#define ARDUINOJSON_ENABLE_COMMENTS 1
+#include <ArduinoJson.h>
+
+#include <catch.hpp>
+
+TEST_CASE("Comments in arrays") {
+  DynamicJsonDocument doc(2048);
+
+  SECTION("Block comments") {
+    SECTION("Before opening bracket") {
+      DeserializationError err =
+          deserializeJson(doc, "/*COMMENT*/  [\"hello\"]");
+      JsonArray arr = doc.as<JsonArray>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(1 == arr.size());
+      REQUIRE(arr[0] == "hello");
+    }
+
+    SECTION("After opening bracket") {
+      DeserializationError err =
+          deserializeJson(doc, "[/*COMMENT*/ \"hello\"]");
+      JsonArray arr = doc.as<JsonArray>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(1 == arr.size());
+      REQUIRE(arr[0] == "hello");
+    }
+
+    SECTION("Before closing bracket") {
+      DeserializationError err = deserializeJson(doc, "[\"hello\"/*COMMENT*/]");
+      JsonArray arr = doc.as<JsonArray>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(1 == arr.size());
+      REQUIRE(arr[0] == "hello");
+    }
+
+    SECTION("After closing bracket") {
+      DeserializationError err = deserializeJson(doc, "[\"hello\"]/*COMMENT*/");
+      JsonArray arr = doc.as<JsonArray>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(1 == arr.size());
+      REQUIRE(arr[0] == "hello");
+    }
+
+    SECTION("Before comma") {
+      DeserializationError err =
+          deserializeJson(doc, "[\"hello\"/*COMMENT*/,\"world\"]");
+      JsonArray arr = doc.as<JsonArray>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(2 == arr.size());
+      REQUIRE(arr[0] == "hello");
+      REQUIRE(arr[1] == "world");
+    }
+
+    SECTION("After comma") {
+      DeserializationError err =
+          deserializeJson(doc, "[\"hello\",/*COMMENT*/ \"world\"]");
+      JsonArray arr = doc.as<JsonArray>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(2 == arr.size());
+      REQUIRE(arr[0] == "hello");
+      REQUIRE(arr[1] == "world");
+    }
+
+    SECTION("/*/") {
+      DeserializationError err = deserializeJson(doc, "[/*/\n]");
+      REQUIRE(err == DeserializationError::IncompleteInput);
+    }
+
+    SECTION("Unfinished comment") {
+      DeserializationError err = deserializeJson(doc, "[/*COMMENT]");
+      REQUIRE(err == DeserializationError::IncompleteInput);
+    }
+
+    SECTION("Final slash missing") {
+      DeserializationError err = deserializeJson(doc, "[/*COMMENT*]");
+      REQUIRE(err == DeserializationError::IncompleteInput);
+    }
+  }
+
+  SECTION("Trailing comments") {
+    SECTION("Before opening bracket") {
+      DeserializationError err =
+          deserializeJson(doc, "//COMMENT\n\t[\"hello\"]");
+      JsonArray arr = doc.as<JsonArray>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(1 == arr.size());
+      REQUIRE(arr[0] == "hello");
+    }
+
+    SECTION("After opening bracket") {
+      DeserializationError err = deserializeJson(doc, "[//COMMENT\n\"hello\"]");
+      JsonArray arr = doc.as<JsonArray>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(1 == arr.size());
+      REQUIRE(arr[0] == "hello");
+    }
+
+    SECTION("Before closing bracket") {
+      DeserializationError err =
+          deserializeJson(doc, "[\"hello\"//COMMENT\r\n]");
+      JsonArray arr = doc.as<JsonArray>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(1 == arr.size());
+      REQUIRE(arr[0] == "hello");
+    }
+
+    SECTION("After closing bracket") {
+      DeserializationError err = deserializeJson(doc, "[\"hello\"]//COMMENT\n");
+      JsonArray arr = doc.as<JsonArray>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(1 == arr.size());
+      REQUIRE(arr[0] == "hello");
+    }
+
+    SECTION("Before comma") {
+      DeserializationError err =
+          deserializeJson(doc, "[\"hello\"//COMMENT\n,\"world\"]");
+      JsonArray arr = doc.as<JsonArray>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(2 == arr.size());
+      REQUIRE(arr[0] == "hello");
+      REQUIRE(arr[1] == "world");
+    }
+
+    SECTION("After comma") {
+      DeserializationError err =
+          deserializeJson(doc, "[\"hello\",//COMMENT\n\"world\"]");
+      JsonArray arr = doc.as<JsonArray>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(2 == arr.size());
+      REQUIRE(arr[0] == "hello");
+      REQUIRE(arr[1] == "world");
+    }
+
+    SECTION("Invalid comment") {
+      DeserializationError err = deserializeJson(doc, "[/COMMENT\n]");
+      REQUIRE(err == DeserializationError::InvalidInput);
+    }
+
+    SECTION("End document with comment") {
+      DeserializationError err = deserializeJson(doc, "[//COMMENT");
+      REQUIRE(err == DeserializationError::IncompleteInput);
+    }
+  }
+}
+
+TEST_CASE("Comments in objects") {
+  DynamicJsonDocument doc(2048);
+
+  SECTION("Block comments") {
+    SECTION("Before opening brace") {
+      DeserializationError err =
+          deserializeJson(doc, "/*COMMENT*/ {\"hello\":\"world\"}");
+      JsonObject obj = doc.as<JsonObject>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(obj["hello"] == "world");
+    }
+
+    SECTION("After opening brace") {
+      DeserializationError err =
+          deserializeJson(doc, "{/*COMMENT*/\"hello\":\"world\"}");
+      JsonObject obj = doc.as<JsonObject>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(obj["hello"] == "world");
+    }
+
+    SECTION("Before colon") {
+      DeserializationError err =
+          deserializeJson(doc, "{\"hello\"/*COMMENT*/:\"world\"}");
+      JsonObject obj = doc.as<JsonObject>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(obj["hello"] == "world");
+    }
+
+    SECTION("After colon") {
+      DeserializationError err =
+          deserializeJson(doc, "{\"hello\":/*COMMENT*/\"world\"}");
+      JsonObject obj = doc.as<JsonObject>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(obj["hello"] == "world");
+    }
+
+    SECTION("Before closing brace") {
+      DeserializationError err =
+          deserializeJson(doc, "{\"hello\":\"world\"/*COMMENT*/}");
+      JsonObject obj = doc.as<JsonObject>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(obj["hello"] == "world");
+    }
+
+    SECTION("After closing brace") {
+      DeserializationError err =
+          deserializeJson(doc, "{\"hello\":\"world\"}/*COMMENT*/");
+      JsonObject obj = doc.as<JsonObject>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(obj["hello"] == "world");
+    }
+
+    SECTION("Before comma") {
+      DeserializationError err = deserializeJson(
+          doc, "{\"hello\":\"world\"/*COMMENT*/,\"answer\":42}");
+      JsonObject obj = doc.as<JsonObject>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(obj["hello"] == "world");
+      REQUIRE(obj["answer"] == 42);
+    }
+
+    SECTION("After comma") {
+      DeserializationError err = deserializeJson(
+          doc, "{\"hello\":\"world\",/*COMMENT*/\"answer\":42}");
+      JsonObject obj = doc.as<JsonObject>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(obj["hello"] == "world");
+      REQUIRE(obj["answer"] == 42);
+    }
+  }
+
+  SECTION("Trailing comments") {
+    SECTION("Before opening brace") {
+      DeserializationError err =
+          deserializeJson(doc, "//COMMENT\n {\"hello\":\"world\"}");
+      JsonObject obj = doc.as<JsonObject>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(obj["hello"] == "world");
+    }
+
+    SECTION("After opening brace") {
+      DeserializationError err =
+          deserializeJson(doc, "{//COMMENT\n\"hello\":\"world\"}");
+      JsonObject obj = doc.as<JsonObject>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(obj["hello"] == "world");
+    }
+
+    SECTION("Before colon") {
+      DeserializationError err =
+          deserializeJson(doc, "{\"hello\"//COMMENT\n:\"world\"}");
+      JsonObject obj = doc.as<JsonObject>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(obj["hello"] == "world");
+    }
+
+    SECTION("After colon") {
+      DeserializationError err =
+          deserializeJson(doc, "{\"hello\"://COMMENT\n\"world\"}");
+      JsonObject obj = doc.as<JsonObject>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(obj["hello"] == "world");
+    }
+
+    SECTION("Before closing brace") {
+      DeserializationError err =
+          deserializeJson(doc, "{\"hello\":\"world\"//COMMENT\n}");
+      JsonObject obj = doc.as<JsonObject>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(obj["hello"] == "world");
+    }
+
+    SECTION("After closing brace") {
+      DeserializationError err =
+          deserializeJson(doc, "{\"hello\":\"world\"}//COMMENT\n");
+      JsonObject obj = doc.as<JsonObject>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(obj["hello"] == "world");
+    }
+
+    SECTION("Before comma") {
+      DeserializationError err = deserializeJson(
+          doc, "{\"hello\":\"world\"//COMMENT\n,\"answer\":42}");
+      JsonObject obj = doc.as<JsonObject>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(obj["hello"] == "world");
+      REQUIRE(obj["answer"] == 42);
+    }
+
+    SECTION("After comma") {
+      DeserializationError err = deserializeJson(
+          doc, "{\"hello\":\"world\",//COMMENT\n\"answer\":42}");
+      JsonObject obj = doc.as<JsonObject>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(obj["hello"] == "world");
+      REQUIRE(obj["answer"] == 42);
+    }
+  }
+
+  SECTION("Dangling slash") {
+    SECTION("Before opening brace") {
+      DeserializationError err = deserializeJson(doc, "/{\"hello\":\"world\"}");
+
+      REQUIRE(err == DeserializationError::InvalidInput);
+    }
+
+    SECTION("After opening brace") {
+      DeserializationError err = deserializeJson(doc, "{/\"hello\":\"world\"}");
+
+      REQUIRE(err == DeserializationError::InvalidInput);
+    }
+
+    SECTION("Before colon") {
+      DeserializationError err = deserializeJson(doc, "{\"hello\"/:\"world\"}");
+
+      REQUIRE(err == DeserializationError::InvalidInput);
+    }
+
+    SECTION("After colon") {
+      DeserializationError err = deserializeJson(doc, "{\"hello\":/\"world\"}");
+
+      REQUIRE(err == DeserializationError::InvalidInput);
+    }
+
+    SECTION("Before closing brace") {
+      DeserializationError err = deserializeJson(doc, "{\"hello\":\"world\"/}");
+
+      REQUIRE(err == DeserializationError::InvalidInput);
+    }
+
+    SECTION("After closing brace") {
+      DeserializationError err = deserializeJson(doc, "{\"hello\":\"world\"}/");
+      JsonObject obj = doc.as<JsonObject>();
+
+      REQUIRE(err == DeserializationError::Ok);
+      REQUIRE(obj["hello"] == "world");
+    }
+
+    SECTION("Before comma") {
+      DeserializationError err =
+          deserializeJson(doc, "{\"hello\":\"world\"/,\"answer\":42}");
+
+      REQUIRE(err == DeserializationError::InvalidInput);
+    }
+
+    SECTION("After comma") {
+      DeserializationError err =
+          deserializeJson(doc, "{\"hello\":\"world\",/\"answer\":42}");
+
+      REQUIRE(err == DeserializationError::InvalidInput);
+    }
+  }
+}
+
+TEST_CASE("Comments alone") {
+  DynamicJsonDocument doc(2048);
+
+  SECTION("Just a trailing comment") {
+    DeserializationError err = deserializeJson(doc, "// comment");
+
+    REQUIRE(err == DeserializationError::IncompleteInput);
+  }
+
+  SECTION("Just a block comment") {
+    DeserializationError err = deserializeJson(doc, "/*comment*/");
+
+    REQUIRE(err == DeserializationError::IncompleteInput);
+  }
+
+  SECTION("Just a slash") {
+    DeserializationError err = deserializeJson(doc, "/");
+
+    REQUIRE(err == DeserializationError::InvalidInput);
+  }
+
+  SECTION("Premature terminator") {
+    DeserializationError err = deserializeJson(doc, "/* comment");
+
+    REQUIRE(err == DeserializationError::IncompleteInput);
+  }
+
+  SECTION("Premature end on sized input") {
+    DeserializationError err = deserializeJson(doc, "/* comment */", 10);
+
+    REQUIRE(err == DeserializationError::IncompleteInput);
+  }
+}