Change IOrganizer::profile return type to a shared_ptr and remove IProfile wrapper

Author: JonathanFeenstra

src/mobase/mobase.cpp

@@ -26,8 +26,8 @@ PYBIND11_MODULE(mobase, m)
 
     // bindings
     //
-    mo2::python::add_wrapper_bindings(m);
     mo2::python::add_basic_bindings(m);
+    mo2::python::add_wrapper_bindings(m);
 
     // game features must be added before plugins
     mo2::python::add_game_feature_bindings(m);

src/mobase/pybind11_all.h

@@ -18,6 +18,7 @@
 #include "pybind11_utils/smart_variant_wrapper.h"
 
 #include <uibase/game_features/game_feature.h>
+#include <uibase/iprofile.h>
 #include <uibase/isavegame.h>
 #include <uibase/pluginrequirements.h>
 
@@ -140,6 +141,7 @@ namespace mo2::python {
 }  // namespace mo2::python
 
 MO2_PYBIND11_SHARED_CPP_HOLDER(MOBase::IPluginRequirement)
+MO2_PYBIND11_SHARED_CPP_HOLDER(MOBase::IProfile)
 MO2_PYBIND11_SHARED_CPP_HOLDER(MOBase::ISaveGame)
 MO2_PYBIND11_SHARED_CPP_HOLDER(MOBase::GameFeature)
 

src/mobase/wrappers/basic_classes.cpp

@@ -627,7 +627,7 @@ namespace mo2::python {
             .def("modList", &IOrganizer::modList, py::return_value_policy::reference)
             .def("gameFeatures", &IOrganizer::gameFeatures,
                  py::return_value_policy::reference)
-            .def("profile", &IOrganizer::profile, py::return_value_policy::reference)
+            .def("profile", &IOrganizer::profile)
             .def("profileNames", &IOrganizer::profileNames)
             .def("getProfile", &IOrganizer::getProfile, "name"_a)
 
@@ -882,6 +882,21 @@ namespace mo2::python {
                                    m.createTarget);
             });
 
+        // must be done BEFORE imodlist because there is a default argument to a
+        // IProfile* in the modlist class
+        py::class_<IProfile, std::shared_ptr<IProfile>>(m, "IProfile")
+            .def("name", &IProfile::name)
+            .def("absolutePath", &IProfile::absolutePath)
+            .def("localSavesEnabled", &IProfile::localSavesEnabled)
+            .def("localSettingsEnabled", &IProfile::localSettingsEnabled)
+            .def("invalidationActive",
+                 [](const IProfile* p) {
+                     bool supported;
+                     bool active = p->invalidationActive(&supported);
+                     return std::make_tuple(active, supported);
+                 })
+            .def("absoluteIniFilePath", &IProfile::absoluteIniFilePath, "inifile"_a);
+
         add_ipluginlist_classes(m);
         add_imodlist_classes(m);
         add_idownload_manager_classes(m);

src/mobase/wrappers/wrappers.cpp

@@ -11,7 +11,6 @@
 // IOrganizer must be bring here to properly compile the Python bindings of
 // plugin requirements
 #include <uibase/imoinfo.h>
-#include <uibase/iprofile.h>
 #include <uibase/isavegame.h>
 #include <uibase/isavegameinfowidget.h>
 #include <uibase/pluginrequirements.h>
@@ -76,41 +75,6 @@ namespace mo2::python {
         ~PySaveGameInfoWidget() { std::cout << "~PySaveGameInfoWidget()" << std::endl; }
     };
 
-    class PyProfile : public IProfile {
-    public:
-        QString name() const override
-        {
-            PYBIND11_OVERRIDE_PURE(QString, IProfile, name, );
-        }
-
-        QString absolutePath() const override
-        {
-            PYBIND11_OVERRIDE_PURE(QString, IProfile, absolutePath, );
-        }
-
-        bool localSavesEnabled() const override
-        {
-            PYBIND11_OVERRIDE_PURE(bool, IProfile, localSavesEnabled, );
-        }
-
-        bool localSettingsEnabled() const override
-        {
-            PYBIND11_OVERRIDE_PURE(bool, IProfile, localSettingsEnabled, );
-        }
-
-        bool invalidationActive(bool* supported) const override
-        {
-            PYBIND11_OVERRIDE_PURE(bool, IProfile, invalidationActive, supported);
-        }
-
-        QString absoluteIniFilePath(QString iniFile) const override
-        {
-            PYBIND11_OVERRIDE_PURE(QString, IProfile, absoluteIniFilePath, iniFile);
-        }
-
-        ~PyProfile() { std::cout << "~PyProfile()" << std::endl; }
-    };
-
     void add_wrapper_bindings(pybind11::module_ m)
     {
         // ISaveGame - custom type_caster<> for shared_ptr<> to keep the Python object
@@ -151,24 +115,6 @@ namespace mo2::python {
             .def("longDescription", &IPluginRequirement::Problem::longDescription);
 
         iPluginRequirementClass.def("check", &IPluginRequirement::check, "organizer"_a);
-
-        // IProfile - custom type_caster<> for shared_ptr<> to keep the Python object
-        // alive when returned from Python (see shared_cpp_owner.h)
-
-        // must be done BEFORE imodlist because there is a default argument to a
-        // IProfile* in the modlist class
-        py::class_<IProfile, PyProfile, std::shared_ptr<IProfile>>(m, "IProfile")
-            .def("name", &IProfile::name)
-            .def("absolutePath", &IProfile::absolutePath)
-            .def("localSavesEnabled", &IProfile::localSavesEnabled)
-            .def("localSettingsEnabled", &IProfile::localSettingsEnabled)
-            .def("invalidationActive",
-                 [](const IProfile* p) {
-                     bool supported;
-                     bool active = p->invalidationActive(&supported);
-                     return std::make_tuple(active, supported);
-                 })
-            .def("absoluteIniFilePath", &IProfile::absoluteIniFilePath, "inifile"_a);
     }
 
 }  // namespace mo2::python

tests/mocks/MockOrganizer.h

@@ -37,7 +37,7 @@ class MockOrganizer : public IOrganizer {
 	MOCK_METHOD(MOBase::IDownloadManager*, downloadManager, (), (const, override));
 	MOCK_METHOD(MOBase::IPluginList*, pluginList, (), (const, override));
 	MOCK_METHOD(MOBase::IModList*, modList, (), (const, override));
-	MOCK_METHOD(MOBase::IProfile*, profile, (), (const, override));
+	MOCK_METHOD(std::shared_ptr<IProfile>, profile, (), (const, override));
 	MOCK_METHOD(QStringList, profileNames, (), (const, override));
 	MOCK_METHOD(std::shared_ptr<const IProfile>, getProfile, (const QString& name), (const, override));
 	MOCK_METHOD(MOBase::IGameFeatures*, gameFeatures, (), (const, override));