Generalize the pybind11 forward declaration of classes.

Author: damienmarchal

bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_Base.cpp

@@ -449,12 +449,21 @@ py::object BindingBase::setDataValues(Base& self, py::kwargs kwargs)
     return py::none();
 }
 
+auto getBaseBinding(py::module& m)
+{
+    static py::class_<Base, py_shared_ptr<Base>> base(m, "Base", py::dynamic_attr(), doc::base::BaseClass);
+    return base;
+}
+
+void moduleForwardAddBase(py::module& m)
+{
+    getBaseBinding(m);
+}
+
 void moduleAddBase(py::module &m)
 {
-    moduleForwardAddBaseData(m);
-    moduleForwardAddBaseLink(m);
+    auto base = getBaseBinding(m);
 
-    py::class_<Base, py_shared_ptr<Base>> base(m, "Base", py::dynamic_attr(), doc::base::BaseClass);
     /// set & get the name as string. The alternative is to access the data field using
     /// obj.name.value = "aName"
     base.def("getName", [](Base& b){ return b.getName(); }, sofapython3::doc::base::getName);

bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_Base.h

@@ -68,7 +68,9 @@ class BindingBase
     static std::string getLinkPath(sofa::core::objectmodel::Base& self);
 };
 
-
+/// Forward declaration in pybind11.
+/// more details in: https://github.com/sofa-framework/SofaPython3/pull/457
+void moduleForwardAddBase(pybind11::module& m);
 void moduleAddBase(pybind11::module& m);
 
 } /// namespace sofapython3

bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_BaseData.cpp

@@ -207,8 +207,6 @@ void moduleForwardAddBaseData(py::module& m)
 void moduleAddBaseData(py::module& m)
 {
     /// Register the BaseData binding into the pybind11 system.
-    //py::class_<BaseData, std::unique_ptr<sofa::core::objectmodel::BaseData, pybind11::nodelete>> data(m, "Data", sofapython3::doc::baseData::BaseDataClass);
-
     auto data =getPythonClassForBaseData(m);
     data.def("getName", [](BaseData& b){ return b.getName(); }, sofapython3::doc::baseData::getName);
     data.def("setName", [](BaseData& b, const std::string& s){ b.setName(s); }, sofapython3::doc::baseData::setName);

bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_BaseData.h

@@ -24,6 +24,8 @@
 
 namespace sofapython3 {
 
+    /// Forward declaration in pybind11.
+    /// more details in: https://github.com/sofa-framework/SofaPython3/pull/457
     void moduleForwardAddBaseData(pybind11::module& m);
     void moduleAddBaseData(pybind11::module& m);
 

bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_BaseLink.h

@@ -24,6 +24,8 @@
 
 namespace sofapython3 {
 
+    /// Forward declaration in pybind11.
+    /// more details in: https://github.com/sofa-framework/SofaPython3/pull/457
     void moduleForwardAddBaseLink(pybind11::module& m);
     void moduleAddBaseLink(pybind11::module& m);
 

bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_BaseMeshTopology.cpp

@@ -21,6 +21,7 @@
 
 #include <SofaPython3/Sofa/Core/Binding_Base.h>
 #include <SofaPython3/Sofa/Core/Binding_BaseContext.h>
+#include <SofaPython3/Sofa/Core/Binding_BaseMeshTopology.h>
 #include <SofaPython3/PythonFactory.h>
 #include <sofa/core/BaseState.h>
 #include <sofa/core/objectmodel/BaseObject.h>
@@ -36,8 +37,21 @@ using namespace sofa::core::topology;
 
 namespace sofapython3 {
 
+
+auto getPythonClassForBaseMeshTopology(py::module& m)
+{
+    /// Register the BaseData binding into the pybind11 system.
+   static py::class_<BaseMeshTopology, Topology, py_shared_ptr<BaseMeshTopology>> basemesh(m, "BaseMeshTopology");
+   return basemesh;
+}
+
+void moduleForwardAddBaseMeshTopology(py::module& m)
+{
+    getPythonClassForBaseMeshTopology(m);
+}
+
 void moduleAddBaseMeshTopology(py::module& m) {
-    py::class_<BaseMeshTopology, Topology, py_shared_ptr<BaseMeshTopology>> c (m, "BaseMeshTopology");
+    auto c = getPythonClassForBaseMeshTopology(m);
 
     /// register the BaseMeshTopology binding in the downcasting subsystem
     PythonFactory::registerType<BaseMeshTopology>([](sofa::core::objectmodel::Base* object)

bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_BaseMeshTopology.h

@@ -24,6 +24,9 @@
 
 namespace sofapython3 {
 
+/// Forward declaration in pybind11.
+/// more details in: https://github.com/sofa-framework/SofaPython3/pull/457
+void moduleForwardAddBaseMeshTopology(pybind11::module &m);
 void moduleAddBaseMeshTopology(pybind11::module &m);
 
 } // namespace sofapython3

bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_BaseObject.cpp

@@ -188,10 +188,21 @@ py::object __getitem__(BaseObject &self, std::string s)
     return getItem(self, s);
 }
 
-void moduleAddBaseObject(py::module& m)
+auto getBaseObjectBinding(py::module& m)
 {
     /// Register the BaseObject binding into the pybind11 typing system
-    py::class_<BaseObject, Base, py_shared_ptr<BaseObject>>p(m, "Object", sofapython3::doc::baseObject::Class);
+    static py::class_<BaseObject, Base, py_shared_ptr<BaseObject>>p(m, "Object", sofapython3::doc::baseObject::Class);
+    return p;
+}
+
+void moduleForwardAddBaseObject(py::module& m)
+{
+    getBaseObjectBinding(m);
+}
+
+void moduleAddBaseObject(py::module& m)
+{
+    auto p = getBaseObjectBinding(m);
 
     /// Register the BaseObject binding into the downcasting subsystem
     PythonFactory::registerType<sofa::core::objectmodel::BaseObject>(

bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_BaseObject.h

@@ -29,6 +29,8 @@ class BaseObject;
 namespace sofapython3 {
 
 pybind11::object getItem(const sofa::core::objectmodel::BaseObject & self, const std::string& path);
+
+void moduleForwardAddBaseObject(pybind11::module &m);
 void moduleAddBaseObject(pybind11::module &m);
 
 } /// namespace sofapython

bindings/Sofa/src/SofaPython3/Sofa/Core/Binding_Mass.cpp

@@ -94,4 +94,10 @@ void moduleAddMass(py::module &m) {
     declare_mass<sofa::defaulttype::Rigid2dTypes>(m);
 }
 
+void moduleForwardAddBaseMass(py::module& m)
+{
+    static py::class_<sofa::core::behavior::BaseMass,
+            sofa::core::Base, py_shared_ptr<sofa::core::behavior::BaseMass>> basemass(m, "BaseMass");
+}
+
 }  // namespace sofapython3