Make JSON and TOML look like two different backends

Author: franzpoeschel

CMakeLists.txt

@@ -817,7 +817,7 @@ set(openPMD_EXAMPLE_NAMES
     10_streaming_read
     12_span_write
     13_write_dynamic_configuration
-    14_json_template
+    14_toml_template
 )
 set(openPMD_PYTHON_EXAMPLE_NAMES
     2_read_serial

examples/14_json_template.cpp renamed to examples/14_toml_template.cpp

@@ -5,14 +5,14 @@ int main()
     std::string config = R"(
 {
   "iteration_encoding": "variable_based",
-  "json": {
+  "toml": {
     "mode": "template"
   }
 }
 )";
 
     openPMD::Series writeTemplate(
-        "../samples/jsonTemplate.toml", openPMD::Access::CREATE, config);
+        "../samples/tomlTemplate.toml", openPMD::Access::CREATE, config);
     auto iteration = writeTemplate.writeIterations()[0];
 
     openPMD::Dataset ds{openPMD::Datatype::FLOAT, {5, 5}};

src/IO/JSON/JSONIOHandlerImpl.cpp

@@ -126,17 +126,27 @@ JSONIOHandlerImpl::JSONIOHandlerImpl(
     , m_fileFormat{format}
     , m_originalExtension{std::move(originalExtension)}
 {
-    if (config.json().contains("json"))
+    std::string const configLocation = [&]() {
+        switch (format)
+        {
+        case FileFormat::Json:
+            return "json";
+        case FileFormat::Toml:
+            return "toml";
+        }
+        throw std::runtime_error("Unreachable!");
+    }();
+    if (config.json().contains(configLocation))
     {
-        auto jsonConfig = config["json"];
+        auto jsonConfig = config[configLocation];
         if (jsonConfig.json().contains("mode"))
         {
             auto modeOption = openPMD::json::asLowerCaseStringDynamic(
                 jsonConfig["mode"].json());
             if (!modeOption.has_value())
             {
                 throw error::BackendConfigSchema(
-                    {"json", "mode"},
+                    {configLocation, "mode"},
                     "Invalid value of non-string type (accepted values are "
                     "'dataset' and 'template'.");
             }
@@ -152,7 +162,7 @@ JSONIOHandlerImpl::JSONIOHandlerImpl(
             else
             {
                 throw error::BackendConfigSchema(
-                    {"json", "mode"},
+                    {configLocation, "mode"},
                     "Invalid value: '" + mode +
                         "' (accepted values are 'dataset' and 'template'.");
             }
@@ -164,13 +174,13 @@ JSONIOHandlerImpl::JSONIOHandlerImpl(
             {
             case openPMD::json::SupportedLanguages::JSON:
                 std::cerr << "Warning: parts of the backend configuration for "
-                             "JSON backend remain unused:\n"
+                             "JSON/TOML backend remain unused:\n"
                           << shadow << std::endl;
                 break;
             case openPMD::json::SupportedLanguages::TOML: {
                 auto asToml = openPMD::json::jsonToToml(shadow);
                 std::cerr << "Warning: parts of the backend configuration for "
-                             "JSON backend remain unused:\n"
+                             "JSON/TOML backend remain unused:\n"
                           << asToml << std::endl;
                 break;
             }

src/auxiliary/JSON.cpp

@@ -510,7 +510,8 @@ std::optional<std::string> asLowerCaseStringDynamic(nlohmann::json const &value)
     return maybeString;
 }
 
-std::vector<std::string> backendKeys{"adios1", "adios2", "json", "hdf5"};
+std::vector<std::string> backendKeys{
+    "adios1", "adios2", "json", "toml", "hdf5"};
 
 void warnGlobalUnusedOptions(TracingJSON const &config)
 {

test/SerialIOTest.cpp

@@ -1517,11 +1517,16 @@ TEST_CASE("dtype_test", "[serial]")
 {
     for (auto const &t : testedFileExtensions())
     {
-        if (t == "toml" || t == "json")
+        if (t == "json")
         {
             dtype_test(t);
             dtype_test(t, R"(json.mode = "template")");
         }
+        else if (t == "toml")
+        {
+            dtype_test(t);
+            dtype_test(t, R"(toml.mode = "template")");
+        }
         else
         {
             dtype_test(t);