exodus plugin: deprecate in libf3d and warn

Author: Lgt2x

library/src/engine.cxx

@@ -265,32 +265,40 @@ std::map<std::string, bool> engine::getRenderingBackendList()
 //----------------------------------------------------------------------------
 void engine::loadPlugin(const std::string& pathOrName, const std::vector<fs::path>& searchPaths)
 {
-  if (pathOrName.empty())
+  std::string localPathOrName = pathOrName;
+
+  if (localPathOrName.empty())
   {
     return;
   }
 
+  // For easier removal when removing deprecation: F3D_DEPRECATED
+  if (localPathOrName == "exodus") {
+    f3d::log::warn("The 'exodus' plugin is deprecated, loading 'hdf' instead");
+    localPathOrName = "hdf";
+  }
+
   std::string pluginOrigin = "static";
   factory* factory = factory::instance();
 
   // check if the plugin is already loaded
   auto plugs = factory->getPlugins();
-  if (std::any_of(plugs.cbegin(), plugs.cend(), [pathOrName](const plugin* plug)
-        { return (plug->getName() == pathOrName || plug->getOrigin() == pathOrName); }))
+  if (std::any_of(plugs.cbegin(), plugs.cend(), [localPathOrName](const plugin* plug)
+        { return (plug->getName() == localPathOrName || plug->getOrigin() == localPathOrName); }))
   {
-    log::debug("Plugin \"", pathOrName, "\" already loaded");
+    log::debug("Plugin \"", localPathOrName, "\" already loaded");
     return;
   }
 
   // check if the plugin is a known static plugin
-  factory::plugin_initializer_t init_plugin = factory->getStaticInitializer(pathOrName);
+  factory::plugin_initializer_t init_plugin = factory->getStaticInitializer(localPathOrName);
 
   if (init_plugin == nullptr)
   {
     vtksys::DynamicLoader::LibraryHandle handle = nullptr;
     try
     {
-      fs::path fullPath = utils::collapsePath(pathOrName);
+      fs::path fullPath = utils::collapsePath(localPathOrName);
       if (fs::exists(fullPath))
       {
         // plugin provided as full path
@@ -313,7 +321,7 @@ void engine::loadPlugin(const std::string& pathOrName, const std::vector<fs::pat
         // Construct the library file name from the plugin name
         std::string libName = vtksys::DynamicLoader::LibPrefix();
         libName += "f3d-plugin-";
-        libName += pathOrName;
+        libName += localPathOrName;
         libName += vtksys::DynamicLoader::LibExtension();
 
         // try search paths
@@ -323,7 +331,7 @@ void engine::loadPlugin(const std::string& pathOrName, const std::vector<fs::pat
           if (fs::exists(tryPath))
           {
             log::debug(
-              "Trying to load \"", pathOrName, "\" plugin from: \"", tryPath.string(), "\"");
+              "Trying to load \"", localPathOrName, "\" plugin from: \"", tryPath.string(), "\"");
             handle = vtksys::DynamicLoader::OpenLibrary(tryPath.string());
 
             if (handle)
@@ -346,7 +354,7 @@ void engine::loadPlugin(const std::string& pathOrName, const std::vector<fs::pat
           handle = vtksys::DynamicLoader::OpenLibrary(libName);
           if (!handle)
           {
-            throw engine::plugin_exception("Cannot open the library \"" + pathOrName +
+            throw engine::plugin_exception("Cannot open the library \"" + localPathOrName +
               "\": " + vtksys::DynamicLoader::LastError());
           }
           else
@@ -365,7 +373,7 @@ void engine::loadPlugin(const std::string& pathOrName, const std::vector<fs::pat
       vtksys::DynamicLoader::GetSymbolAddress(handle, "init_plugin"));
     if (init_plugin == nullptr)
     {
-      throw engine::plugin_exception("Cannot find init_plugin symbol in library \"" + pathOrName +
+      throw engine::plugin_exception("Cannot find init_plugin symbol in library \"" + localPathOrName +
         "\": " + vtksys::DynamicLoader::LastError());
     }
   }

library/testing/TestSDKEngine.cxx

@@ -17,6 +17,7 @@ int TestSDKEngine(int argc, char* argv[])
   try { f3d::engine::loadPlugin("alembic", {argv[3]}); } catch (...) {}
   try { f3d::engine::loadPlugin("assimp", {argv[3]}); } catch (...) {}
   try { f3d::engine::loadPlugin("draco", {argv[3]}); } catch (...) {}
+  try { f3d::engine::loadPlugin("exodus", {argv[3]}); } catch (...) {} // F3D_DEPRECATED
   try { f3d::engine::loadPlugin("hdf", {argv[3]}); } catch (...) {}
   try { f3d::engine::loadPlugin("occt", {argv[3]}); } catch (...) {}
   try { f3d::engine::loadPlugin("usd", {argv[3]}); } catch (...) {}