Merge pull request #1302 from snoyer/config-order

maintain config declaration order

application/F3DOptionsParser.cxx

@@ -68,16 +68,16 @@ class ConfigurationOptions
     bool ret = false;
     if (this->FilePathForConfigBlock.empty())
     {
-      auto localIt = this->GlobalConfigDicEntry.find(option);
-      if (localIt != this->GlobalConfigDicEntry.end())
+      auto localIt = this->GlobalConfigEntry.find(option);
+      if (localIt != this->GlobalConfigEntry.end())
       {
         configValue = localIt->second;
         ret = true;
       }
     }
     else
     {
-      for (auto const& it : this->ConfigDic)
+      for (auto const& it : this->RegexConfigEntries)
       {
         std::regex re(it.first, std::regex_constants::icase);
         std::smatch matches;
@@ -204,10 +204,10 @@ class ConfigurationOptions
 
   std::string FilePathForConfigBlock;
 
-  using DictionaryEntry = std::map<std::string, std::string>;
-  using Dictionary = std::map<std::string, DictionaryEntry>;
-  DictionaryEntry GlobalConfigDicEntry;
-  Dictionary ConfigDic;
+  using ConfigEntry = std::map<std::string, std::string>;
+  using ConfigEntries = std::vector<std::pair<std::string, ConfigEntry> >;
+  ConfigEntry GlobalConfigEntry;
+  ConfigEntries RegexConfigEntries;
   std::string ExecutableName;
   std::vector<std::string> AllLongOptions;
 };
@@ -671,7 +671,7 @@ void ConfigurationOptions::PrintReadersList()
 //----------------------------------------------------------------------------
 bool ConfigurationOptions::InitializeDictionaryFromConfigFile(const std::string& config)
 {
-  this->ConfigDic.clear();
+  this->RegexConfigEntries.clear();
 
   std::string configSearch = "config";
   if (!config.empty())
@@ -746,7 +746,7 @@ bool ConfigurationOptions::InitializeDictionaryFromConfigFile(const std::string&
       return false;
     }
 
-    nlohmann::json json;
+    nlohmann::ordered_json json;
     try
     {
       file >> json;
@@ -779,11 +779,11 @@ bool ConfigurationOptions::InitializeDictionaryFromConfigFile(const std::string&
       }
       if (regexpConfig.key() == "global")
       {
-        this->GlobalConfigDicEntry = localDic;
+        this->GlobalConfigEntry = localDic;
       }
       else
       {
-        this->ConfigDic[regexpConfig.key()] = localDic;
+        this->RegexConfigEntries.emplace_back(regexpConfig.key(), localDic);
       }
     }
   }

application/testing/CMakeLists.txt

@@ -196,6 +196,7 @@ f3d_test(NAME TestInvalidUpDirection DATA suzanne.ply ARGS -g --up=W REGEXP "W i
 f3d_test(NAME TestUpDirectionNoSign DATA suzanne.ply ARGS --up=X DEFAULT_LIGHTS)
 f3d_test(NAME TestTextureMatCap DATA suzanne.ply ARGS --texture-matcap=${F3D_SOURCE_DIR}/testing/data/skin.png DEFAULT_LIGHTS)
 f3d_test(NAME TestTextureMatCapWithTCoords DATA WaterBottle.glb ARGS --geometry-only --texture-matcap=${F3D_SOURCE_DIR}/testing/data/skin.png DEFAULT_LIGHTS)
+f3d_test(NAME TestConfigOrder DATA suzanne.ply ARGS CONFIG ${F3D_SOURCE_DIR}/testing/data/config-order.json DEFAULT_LIGHTS)
 
 # Needs SSBO: https://gitlab.kitware.com/vtk/vtk/-/merge_requests/10675
 if(VTK_VERSION VERSION_GREATER_EQUAL 9.3.20231108)