Deploy Qt plugins with default deployStandardQtPlugins() function

Author: dantti

src/deployers/BasicPluginsDeployer.cpp

@@ -29,21 +29,23 @@ BasicPluginsDeployer::BasicPluginsDeployer(std::string moduleName,
                                                                   qtDataPath(std::move(qtDataPath)) {}
 
 bool BasicPluginsDeployer::deploy() {
-    for (const auto &pluginName : qtPluginsToBeDeployed()) {
-        ldLog() << "Deploying" << pluginName << "plugins" << std::endl;
+    // currently this is a no-op, but we might add more functionality later on, such as some kinds of default
+    // attempts to copy data based on the moduleName
+    return doDeploy();
+}
+
+bool BasicPluginsDeployer::deployStandardQtPlugins(const std::vector<std::string>& plugins)
+{
+    for (const auto &pluginName : plugins) {
+        ldLog() << "Deploying Qt" << pluginName << "plugins" << std::endl;
         for (fs::directory_iterator i(qtPluginsPath / pluginName); i != fs::directory_iterator(); ++i) {
             if (!appDir.deployLibrary(*i, appDir.path() / "usr/plugins" / pluginName))
                 return false;
         }
     }
-
-    return customDeploy();
-}
-
-bool BasicPluginsDeployer::customDeploy() {
     return true;
 }
 
-std::vector<std::string> BasicPluginsDeployer::qtPluginsToBeDeployed() const {
-    return {};
+bool BasicPluginsDeployer::doDeploy() {
+    return true;
 }

src/deployers/BasicPluginsDeployer.h

@@ -50,24 +50,23 @@ namespace linuxdeploy {
 
             public:
                 /**
-                 * This method deploys the plugins returned by \sa qtPluginsToBeDeployed()
-                 * and call \sa customDeploy() to finalize the deployment.
+                 * This method might make some deployment preparation and calls \sa doDeploy() to finalize the deployment.
                  */
                 bool deploy() override final;
 
             protected:
                 /**
-                 * The \sa deploy() method can deploy Qt plugins that follow the default
-                 * name and path scheme, but some modules are special so
-                 * they should write custom deployment code.
+                 * This method does the actual moduleName deployment, where any special case should be handled and
+                 * \sa deployStandardQtPlugins () method should be called to deploy Qt plugins that follow the default
+                 * name and path scheme.
                  */
-                virtual bool customDeploy();
+                virtual bool doDeploy();
 
                 /**
-                 * Returns a list of Qt plugin names that should be deployed and
+                 * Deploys a list of Qt plugin that should be deployed and
                  * follow the default name and path scheme.
                  */
-                virtual std::vector<std::string> qtPluginsToBeDeployed() const;
+                bool deployStandardQtPlugins(const std::vector<std::string>& plugins);
             };
         }
     }

src/deployers/BearerPluginsDeployer.cpp

@@ -1,15 +1,11 @@
 // system headers
 #include <filesystem>
 
-// library headers
-#include <linuxdeploy/core/log.h>
-
 // local headers
 #include "BearerPluginsDeployer.h"
 
 using namespace linuxdeploy::plugin::qt;
-using namespace linuxdeploy::core::log;
 
-std::vector<std::string> BearerPluginsDeployer::qtPluginsToBeDeployed() const {
-    return {"bearer"};
+bool BearerPluginsDeployer::doDeploy() {
+    return deployStandardQtPlugins({"bearer"});
 }

src/deployers/BearerPluginsDeployer.h

@@ -10,7 +10,7 @@ namespace linuxdeploy {
                 // we can just use the base class's constructor
                 using BasicPluginsDeployer::BasicPluginsDeployer;
 
-                std::vector<std::string> qtPluginsToBeDeployed() const override;
+                bool doDeploy() override;
             };
         }
     }

src/deployers/GamepadPluginsDeployer.cpp

@@ -1,15 +1,11 @@
 // system headers
 #include <filesystem>
 
-// library headers
-#include <linuxdeploy/core/log.h>
-
 // local headers
 #include "GamepadPluginsDeployer.h"
 
 using namespace linuxdeploy::plugin::qt;
-using namespace linuxdeploy::core::log;
 
-std::vector<std::string> GamepadPluginsDeployer::qtPluginsToBeDeployed() const {
-    return {"gamepads"};
+bool GamepadPluginsDeployer::doDeploy() {
+    return deployStandardQtPlugins({"gamepads"});
 }

src/deployers/GamepadPluginsDeployer.h

@@ -10,7 +10,7 @@ namespace linuxdeploy {
                 // we can just use the base class's constructor
                 using BasicPluginsDeployer::BasicPluginsDeployer;
 
-                std::vector<std::string> qtPluginsToBeDeployed() const override;
+                bool doDeploy() override;
             };
         }
     }

src/deployers/LocationPluginsDeployer.cpp

@@ -1,15 +1,11 @@
 // system headers
 #include <filesystem>
 
-// library headers
-#include <linuxdeploy/core/log.h>
-
 // local headers
 #include "LocationPluginsDeployer.h"
 
 using namespace linuxdeploy::plugin::qt;
-using namespace linuxdeploy::core::log;
 
-std::vector<std::string> LocationPluginsDeployer::qtPluginsToBeDeployed() const {
-    return {"geoservices"};
+bool LocationPluginsDeployer::doDeploy() {
+    return deployStandardQtPlugins({"geoservices"});
 }

src/deployers/LocationPluginsDeployer.h

@@ -10,7 +10,7 @@ namespace linuxdeploy {
                 // we can just use the base class's constructor
                 using BasicPluginsDeployer::BasicPluginsDeployer;
 
-                std::vector<std::string> qtPluginsToBeDeployed() const override;
+                bool doDeploy() override;
             };
         }
     }

src/deployers/Multimedia5PluginsDeployer.cpp

@@ -1,15 +1,11 @@
 // system headers
 #include <filesystem>
 
-// library headers
-#include <linuxdeploy/core/log.h>
-
 // local headers
 #include "Multimedia5PluginsDeployer.h"
 
 using namespace linuxdeploy::plugin::qt;
-using namespace linuxdeploy::core::log;
 
-std::vector<std::string> Multimedia5PluginsDeployer::qtPluginsToBeDeployed() const {
-    return {"mediaservice", "audio"};
+bool Multimedia5PluginsDeployer::doDeploy() {
+    return deployStandardQtPlugins({"mediaservice", "audio"});
 }

src/deployers/Multimedia5PluginsDeployer.h

@@ -10,7 +10,7 @@ namespace linuxdeploy {
                 // we can just use the base class's constructor
                 using BasicPluginsDeployer::BasicPluginsDeployer;
 
-                std::vector<std::string> qtPluginsToBeDeployed() const override;
+                bool doDeploy() override;
             };
         }
     }

src/deployers/Multimedia6PluginsDeployer.cpp

@@ -12,11 +12,11 @@ using namespace linuxdeploy::core::log;
 
 namespace fs = std::filesystem;
 
-std::vector<std::string> Multimedia6PluginsDeployer::qtPluginsToBeDeployed() const {
+bool Multimedia6PluginsDeployer::doDeploy() {
     if (fs::exists(qtPluginsPath / "multimedia")) {
-        return {"multimedia"};
+        return deployStandardQtPlugins({"multimedia"});
     } else {
         ldLog() << LD_WARNING << "Missing Qt 6 multimedia plugins, skipping." << std::endl;
-        return {};
+        return true;
     }
 }

src/deployers/Multimedia6PluginsDeployer.h

@@ -10,7 +10,7 @@ namespace linuxdeploy {
                 // we can just use the base class's constructor
                 using BasicPluginsDeployer::BasicPluginsDeployer;
 
-                std::vector<std::string> qtPluginsToBeDeployed() const override;
+                bool doDeploy() override;
             };
         }
     }

src/deployers/PlatformPluginsDeployer.cpp

@@ -13,7 +13,7 @@ using namespace linuxdeploy::core::log;
 
 namespace fs = std::filesystem;
 
-bool PlatformPluginsDeployer::customDeploy() {
+bool PlatformPluginsDeployer::doDeploy() {
     ldLog() << "Deploying platform plugins" << std::endl;
 
     // always deploy default platform
@@ -30,6 +30,10 @@ bool PlatformPluginsDeployer::customDeploy() {
         }
     }
 
+    if (!deployStandardQtPlugins({"platforminputcontexts", "imageformats"})) {
+        return false;
+    }
+
     // TODO: platform themes -- https://github.com/probonopd/linuxdeployqt/issues/236
 
     const fs::path platformThemesPath = qtPluginsPath / "platformthemes";
@@ -68,7 +72,3 @@ bool PlatformPluginsDeployer::customDeploy() {
 
     return true;
 }
-
-std::vector<std::string> PlatformPluginsDeployer::qtPluginsToBeDeployed() const {
-    return {"platforminputcontexts", "imageformats"};
-}

src/deployers/PlatformPluginsDeployer.h

@@ -10,8 +10,7 @@ namespace linuxdeploy {
                 // we can just use the base class's constructor
                 using BasicPluginsDeployer::BasicPluginsDeployer;
 
-                bool customDeploy() override;
-                std::vector<std::string> qtPluginsToBeDeployed() const override;
+                bool doDeploy() override;
             };
         }
     }

src/deployers/PositioningPluginsDeployer.cpp

@@ -1,15 +1,11 @@
 // system headers
 #include <filesystem>
 
-// library headers
-#include <linuxdeploy/core/log.h>
-
 // local headers
 #include "PositioningPluginsDeployer.h"
 
 using namespace linuxdeploy::plugin::qt;
-using namespace linuxdeploy::core::log;
 
-std::vector<std::string> PositioningPluginsDeployer::qtPluginsToBeDeployed() const {
-    return {"position"};
+bool PositioningPluginsDeployer::doDeploy() {
+    return deployStandardQtPlugins({"position"});
 }

src/deployers/PositioningPluginsDeployer.h

@@ -10,7 +10,7 @@ namespace linuxdeploy {
                 // we can just use the base class's constructor
                 using BasicPluginsDeployer::BasicPluginsDeployer;
 
-                std::vector<std::string> qtPluginsToBeDeployed() const override;
+                bool doDeploy() override;
             };
         }
     }

src/deployers/PrintSupportPluginsDeployer.cpp

@@ -1,15 +1,11 @@
 // system headers
 #include <filesystem>
 
-// library headers
-#include <linuxdeploy/core/log.h>
-
 // local headers
 #include "PrintSupportPluginsDeployer.h"
 
 using namespace linuxdeploy::plugin::qt;
-using namespace linuxdeploy::core::log;
 
-std::vector<std::string> PrintSupportPluginsDeployer::qtPluginsToBeDeployed() const {
-    return {"printsupport"};
+bool PrintSupportPluginsDeployer::doDeploy() {
+    return deployStandardQtPlugins({"printsupport"});
 }

src/deployers/PrintSupportPluginsDeployer.h

@@ -10,7 +10,7 @@ namespace linuxdeploy {
                 // we can just use the base class's constructor
                 using BasicPluginsDeployer::BasicPluginsDeployer;
 
-                std::vector<std::string> qtPluginsToBeDeployed() const override;
+                bool doDeploy() override;
             };
         }
     }

src/deployers/QmlPluginsDeployer.cpp

@@ -8,7 +8,7 @@ using namespace linuxdeploy::plugin::qt;
 
 namespace fs = std::filesystem;
 
-bool QmlPluginsDeployer::customDeploy() {
+bool QmlPluginsDeployer::doDeploy() {
     try {
         deployQml(appDir, qtInstallQmlPath);
     } catch (const QmlImportScannerError &) {

src/deployers/QmlPluginsDeployer.h

@@ -10,7 +10,7 @@ namespace linuxdeploy {
                 // we can just use the base class's constructor
                 using BasicPluginsDeployer::BasicPluginsDeployer;
 
-                bool customDeploy() override;
+                bool doDeploy() override;
             };
         }
     }

src/deployers/Qt3DPluginsDeployer.cpp

@@ -1,15 +1,11 @@
 // system headers
 #include <filesystem>
 
-// library headers
-#include <linuxdeploy/core/log.h>
-
 // local headers
 #include "Qt3DPluginsDeployer.h"
 
 using namespace linuxdeploy::plugin::qt;
-using namespace linuxdeploy::core::log;
 
-std::vector<std::string> Qt3DPluginsDeployer::qtPluginsToBeDeployed() const {
-    return {"geometryloaders", "sceneparsers"};
+bool Qt3DPluginsDeployer::doDeploy() {
+    return deployStandardQtPlugins({"geometryloaders", "sceneparsers"});
 }

src/deployers/Qt3DPluginsDeployer.h

@@ -10,7 +10,7 @@ namespace linuxdeploy {
                 // we can just use the base class's constructor
                 using BasicPluginsDeployer::BasicPluginsDeployer;
 
-                std::vector<std::string> qtPluginsToBeDeployed() const override;
+                bool doDeploy() override;
             };
         }
     }

src/deployers/SqlPluginsDeployer.cpp

@@ -1,15 +1,11 @@
 // system headers
 #include <filesystem>
 
-// library headers
-#include <linuxdeploy/core/log.h>
-
 // local headers
 #include "SqlPluginsDeployer.h"
 
 using namespace linuxdeploy::plugin::qt;
-using namespace linuxdeploy::core::log;
 
-std::vector<std::string> SqlPluginsDeployer::qtPluginsToBeDeployed() const {
-    return {"sqldrivers"};
+bool SqlPluginsDeployer::doDeploy() {
+    return deployStandardQtPlugins({"sqldrivers"});
 }

src/deployers/SqlPluginsDeployer.h

@@ -10,7 +10,7 @@ namespace linuxdeploy {
                 // we can just use the base class's constructor
                 using BasicPluginsDeployer::BasicPluginsDeployer;
 
-                std::vector<std::string> qtPluginsToBeDeployed() const override;
+                bool doDeploy() override;
             };
         }
     }

src/deployers/SvgPluginsDeployer.cpp

@@ -12,7 +12,7 @@ using namespace linuxdeploy::core::log;
 
 namespace fs = std::filesystem;
 
-bool SvgPluginsDeployer::customDeploy() {
+bool SvgPluginsDeployer::doDeploy() {
     ldLog() << "Deploying svg icon engine" << std::endl;
 
     if (!appDir.deployLibrary(qtPluginsPath / "iconengines/libqsvgicon.so", appDir.path() / "usr/plugins/iconengines/"))

src/deployers/SvgPluginsDeployer.h

@@ -10,7 +10,7 @@ namespace linuxdeploy {
                 // we can just use the base class's constructor
                 using BasicPluginsDeployer::BasicPluginsDeployer;
 
-                bool customDeploy() override;
+                bool doDeploy() override;
             };
         }
     }

src/deployers/TextToSpeechPluginsDeployer.cpp

@@ -12,7 +12,7 @@ using namespace linuxdeploy::core::log;
 
 namespace fs = std::filesystem;
 
-bool TextToSpeechPluginsDeployer::customDeploy() {
+bool TextToSpeechPluginsDeployer::doDeploy() {
     // calling the default code is optional, but it won't hurt for now
     if (!BasicPluginsDeployer::deploy())
         return false;

src/deployers/TextToSpeechPluginsDeployer.h

@@ -10,7 +10,7 @@ namespace linuxdeploy {
                 // we can just use the base class's constructor
                 using BasicPluginsDeployer::BasicPluginsDeployer;
 
-                bool customDeploy() override;
+                bool doDeploy() override;
             };
         }
     }