Part/Sketcher: Refactor Geometry Extensions copy/save/restore AND attachment notification

=========================================================================================

- Long overdue refactor to avoid repetition during save/restore and copy.
- New interface to notify an extension when it is attached. It also enables the extension to gain
a pointer to the geometry container. This is intended to extend the functionality already existing
in Part::Geometry.

src/Mod/Part/App/GeometryDefaultExtension.cpp

@@ -44,36 +44,36 @@ GeometryDefaultExtension<T>::GeometryDefaultExtension(const T& val, std::string
     setName(name);
 }
 
-// Persistence implementer
+
 template <typename T>
-void GeometryDefaultExtension<T>::Save(Base::Writer &writer) const
+void GeometryDefaultExtension<T>::copyAttributes(Part::GeometryExtension * cpy) const
 {
-
-    writer.Stream() << writer.ind() << "<GeoExtension type=\"" << this->getTypeId().getName();
-
-    const std::string name = getName();
-
-    if(name.size() > 0)
-        writer.Stream() << "\" name=\"" << name;
-
-    writer.Stream() << "\" value=\"" << value << "\"/>" << std::endl;
+    Part::GeometryPersistenceExtension::copyAttributes(cpy);
+    static_cast<GeometryDefaultExtension<T> *>(cpy)->value = this->value;
 }
 
 template <typename T>
-void GeometryDefaultExtension<T>::Restore(Base::XMLReader &reader)
+void GeometryDefaultExtension<T>::restoreAttributes(Base::XMLReader &reader)
 {
-    restoreNameAttribute(reader);
+    Part::GeometryPersistenceExtension::restoreAttributes(reader);
 
     value = reader.getAttribute("value");
 }
 
+template <typename T>
+void GeometryDefaultExtension<T>::saveAttributes(Base::Writer &writer) const
+{
+    Part::GeometryPersistenceExtension::saveAttributes(writer);
+
+    writer.Stream() << "\" value=\"" << value;
+}
+
 template <typename T>
 std::unique_ptr<Part::GeometryExtension> GeometryDefaultExtension<T>::copy(void) const
 {
     std::unique_ptr<GeometryDefaultExtension<T>> cpy = std::make_unique<GeometryDefaultExtension<T>>();
 
-    cpy->value = this->value;
-    cpy->setName(this->getName());
+    copyAttributes(cpy.get());
 
     #if (defined(__GNUC__) && __GNUC__ < 7 ) || defined(_MSC_VER)
         return std::move(cpy); // GCC 4.8 and MSC do not support automatic move constructor call if the compiler fails to elide
@@ -117,9 +117,9 @@ PyObject * GeometryDefaultExtension<long>::getPyObject(void)
 }
 
 template <>
-void GeometryDefaultExtension<long>::Restore(Base::XMLReader &reader)
+void GeometryDefaultExtension<long>::restoreAttributes(Base::XMLReader &reader)
 {
-    restoreNameAttribute(reader);
+    Part::GeometryPersistenceExtension::restoreAttributes(reader);
 
     value = reader.getAttributeAsInteger("value");
 }
@@ -143,9 +143,9 @@ PyObject * GeometryDefaultExtension<bool>::getPyObject(void)
 }
 
 template <>
-void GeometryDefaultExtension<bool>::Restore(Base::XMLReader &reader)
+void GeometryDefaultExtension<bool>::restoreAttributes(Base::XMLReader &reader)
 {
-    restoreNameAttribute(reader);
+    Part::GeometryPersistenceExtension::restoreAttributes(reader);
 
     value = (bool)reader.getAttributeAsInteger("value");
 }
@@ -160,9 +160,9 @@ PyObject * GeometryDefaultExtension<double>::getPyObject(void)
 }
 
 template <>
-void GeometryDefaultExtension<double>::Restore(Base::XMLReader &reader)
+void GeometryDefaultExtension<double>::restoreAttributes(Base::XMLReader &reader)
 {
-    restoreNameAttribute(reader);
+    Part::GeometryPersistenceExtension::restoreAttributes(reader);
 
     value = reader.getAttributeAsFloat("value");
 }

src/Mod/Part/App/GeometryDefaultExtension.h

@@ -41,14 +41,15 @@ namespace Part {
         inline void setValue(const T& val) {value = val;};
         inline const T &getValue() const {return value;};
 
-        // Persistence implementer ---------------------
-        virtual void Save(Base::Writer &/*writer*/) const override;
-        virtual void Restore(Base::XMLReader &/*reader*/) override;
-
         virtual std::unique_ptr<Part::GeometryExtension> copy(void) const override;
 
         virtual PyObject *getPyObject(void) override;
 
+    protected:
+        virtual void copyAttributes(Part::GeometryExtension * cpy) const override;
+        virtual void restoreAttributes(Base::XMLReader &reader) override;
+        virtual void saveAttributes(Base::Writer &writer) const override;
+
     private:
         GeometryDefaultExtension(const GeometryDefaultExtension<T>&) = default;
 

src/Mod/Part/App/GeometryExtension.cpp

@@ -45,12 +45,39 @@ PyObject* GeometryExtension::copyPyObject() const
     return static_cast<GeometryExtensionPy *>(obj.ptr())->copy(tuple.ptr());
 }
 
+void GeometryExtension::copyAttributes(Part::GeometryExtension * cpy) const
+{
+    cpy->setName(this->getName()); // Base Class
+}
+
 TYPESYSTEM_SOURCE_ABSTRACT(Part::GeometryPersistenceExtension,Part::GeometryExtension)
 
-void GeometryPersistenceExtension::restoreNameAttribute(Base::XMLReader &reader)
+void GeometryPersistenceExtension::restoreAttributes(Base::XMLReader &reader)
 {
     if(reader.hasAttribute("name")) {
         std::string name = reader.getAttribute("name");
         setName(name);
     }
 }
+void GeometryPersistenceExtension::saveAttributes(Base::Writer &writer) const
+{
+    const std::string name = getName();
+
+    if(name.size() > 0)
+        writer.Stream() << "\" name=\"" << name;
+
+}
+
+void GeometryPersistenceExtension::Save(Base::Writer &writer) const
+{
+    writer.Stream() << writer.ind() << "<GeoExtension type=\"" << this->getTypeId().getName();
+
+    saveAttributes(writer);
+
+    writer.Stream() << "\"/>" << std::endl;
+}
+
+void GeometryPersistenceExtension::Restore(Base::XMLReader &reader)
+{
+    restoreAttributes(reader);
+}

src/Mod/Part/App/GeometryExtension.h

@@ -32,6 +32,8 @@
 
 namespace Part {
 
+class Geometry;
+
 class PartExport GeometryExtension: public Base::BaseClass
 {
     TYPESYSTEM_HEADER();
@@ -46,11 +48,17 @@ public:
     inline void setName(const std::string& str) {name = str;}
     inline const std::string &getName () const {return name;}
 
+    // Default method to notify an extension that it has been attached
+    // to a given geometry
+    virtual void notifyAttachment(Part::Geometry *) {}
+
 protected:
     GeometryExtension();
     GeometryExtension(const GeometryExtension &obj) = default;
     GeometryExtension& operator= (const GeometryExtension &obj) = default;
 
+    virtual void copyAttributes(Part::GeometryExtension * cpy) const;
+
 private:
     std::string name;
 };
@@ -64,11 +72,13 @@ public:
     virtual ~GeometryPersistenceExtension() = default;
 
     // Own Persistence implementer - Not Base::Persistence - managed by Part::Geometry
-    virtual void Save(Base::Writer &/*writer*/) const = 0;
-    virtual void Restore(Base::XMLReader &/*reader*/) = 0;
+    void Save(Base::Writer &/*writer*/) const;
+    void Restore(Base::XMLReader &/*reader*/);
 
 protected:
-    void restoreNameAttribute(Base::XMLReader &/*reader*/);
+    virtual void restoreAttributes(Base::XMLReader &/*reader*/);
+    virtual void saveAttributes(Base::Writer &writer) const;
+
 };
 
 }

src/Mod/Part/App/GeometryMigrationExtension.cpp

@@ -37,14 +37,18 @@ GeometryMigrationExtension::GeometryMigrationExtension():ConstructionState(false
 
 }
 
+void GeometryMigrationExtension::copyAttributes(Part::GeometryExtension * cpy) const
+{
+    Part::GeometryExtension::copyAttributes(cpy);
+    static_cast<GeometryMigrationExtension *>(cpy)->ConstructionState = this->ConstructionState;
+    static_cast<GeometryMigrationExtension *>(cpy)->GeometryMigrationFlags  = this->GeometryMigrationFlags;
+}
+
 std::unique_ptr<Part::GeometryExtension> GeometryMigrationExtension::copy(void) const
 {
     auto cpy = std::make_unique<GeometryMigrationExtension>();
 
-    cpy->ConstructionState = this->ConstructionState;
-    cpy->GeometryMigrationFlags  = this->GeometryMigrationFlags;
-
-    cpy->setName(this->getName()); // Base Class
+    copyAttributes(cpy.get());
 
 #if defined (__GNUC__) && (__GNUC__ <=4)
     return std::move(cpy);

src/Mod/Part/App/GeometryMigrationExtension.h

@@ -65,6 +65,8 @@ public:
     virtual bool testMigrationType(int flag) const { return GeometryMigrationFlags.test((size_t)(flag)); };
     virtual void setMigrationType(int flag, bool v=true) { GeometryMigrationFlags.set((size_t)(flag), v); };
 
+protected:
+    virtual void copyAttributes(Part::GeometryExtension * cpy) const override;
 
 private:
     GeometryMigrationExtension(const GeometryMigrationExtension&) = default;

src/Mod/Sketcher/App/ExternalGeometryExtension.cpp

@@ -37,36 +37,35 @@ constexpr std::array<const char *, ExternalGeometryExtension::NumFlags> External
 
 TYPESYSTEM_SOURCE(Sketcher::ExternalGeometryExtension,Part::GeometryPersistenceExtension)
 
-// Persistence implementer
-void ExternalGeometryExtension::Save(Base::Writer &writer) const
+void ExternalGeometryExtension::copyAttributes(Part::GeometryExtension * cpy) const
 {
-    writer.Stream() << writer.ind() << "<GeoExtension type=\"" << this->getTypeId().getName();
+    Part::GeometryPersistenceExtension::copyAttributes(cpy);
 
-    const std::string name = getName();
-
-    if(name.size() > 0)
-        writer.Stream() << "\" name=\"" << name;
-
-    writer.Stream() << "\" Ref=\"" << Ref << "\" Flags=\"" << Flags.to_string() << "\"/>" << std::endl;
+    static_cast<ExternalGeometryExtension *>(cpy)->Ref = this->Ref;
+    static_cast<ExternalGeometryExtension *>(cpy)->Flags = this->Flags;
 }
 
-void ExternalGeometryExtension::Restore(Base::XMLReader &reader)
+void ExternalGeometryExtension::restoreAttributes(Base::XMLReader &reader)
 {
-    restoreNameAttribute(reader);
+    Part::GeometryPersistenceExtension::restoreAttributes(reader);
 
     Ref = reader.getAttribute("Ref");
     Flags = FlagType(reader.getAttribute("Flags"));
+}
 
+void ExternalGeometryExtension::saveAttributes(Base::Writer &writer) const
+{
+    Part::GeometryPersistenceExtension::saveAttributes(writer);
+
+    writer.Stream() << "\" Ref=\"" << Ref
+                    << "\" Flags=\"" << Flags.to_string();
 }
 
 std::unique_ptr<Part::GeometryExtension> ExternalGeometryExtension::copy(void) const
 {
     auto cpy = std::make_unique<ExternalGeometryExtension>();
 
-    cpy->Ref = this->Ref;
-    cpy->Flags = this->Flags;
-
-    cpy->setName(this->getName()); // Base Class
+    copyAttributes(cpy.get());
 
 #if defined (__GNUC__) && (__GNUC__ <=4)
     return std::move(cpy);

src/Mod/Sketcher/App/ExternalGeometryExtension.h

@@ -67,10 +67,6 @@ public:
     ExternalGeometryExtension() = default;
     virtual ~ExternalGeometryExtension() override = default;
 
-    // Persistence implementer ---------------------
-    virtual void Save(Base::Writer &/*writer*/) const override;
-    virtual void Restore(Base::XMLReader &/*reader*/) override;
-
     virtual std::unique_ptr<Part::GeometryExtension> copy(void) const override;
 
     virtual PyObject *getPyObject(void) override;
@@ -88,6 +84,11 @@ public:
 
     static bool getFlagsFromName(std::string str, ExternalGeometryExtension::Flag &flag);
 
+protected:
+    virtual void copyAttributes(Part::GeometryExtension * cpy) const override;
+    virtual void restoreAttributes(Base::XMLReader &reader) override;
+    virtual void saveAttributes(Base::Writer &writer) const override;
+
 private:
     ExternalGeometryExtension(const ExternalGeometryExtension&) = default;
 

src/Mod/Sketcher/App/SketchGeometryExtension.cpp

@@ -51,25 +51,18 @@ SketchGeometryExtension::SketchGeometryExtension(long cid):Id(cid),InternalGeome
 
 }
 
-// Persistence implementer
-void SketchGeometryExtension::Save(Base::Writer &writer) const
+void SketchGeometryExtension::copyAttributes(Part::GeometryExtension * cpy) const
 {
-    writer.Stream() << writer.ind() << "<GeoExtension type=\"" << this->getTypeId().getName();
+    Part::GeometryPersistenceExtension::copyAttributes(cpy);
 
-    const std::string name = getName();
-
-    if(name.size() > 0)
-        writer.Stream() << "\" name=\"" << name;
-
-    writer.Stream() // << "\" id=\"" << Id // This is removed as the stored Id is not used and it may interfere with RT's future implementation
-                    << "\" internalGeometryType=\"" << (int) InternalGeometryType
-                    << "\" geometryModeFlags=\""    << GeometryModeFlags.to_string()
-                    << "\"/>" << std::endl;
+    static_cast<SketchGeometryExtension *>(cpy)->Id = this->Id;
+    static_cast<SketchGeometryExtension *>(cpy)->InternalGeometryType = this->InternalGeometryType;
+    static_cast<SketchGeometryExtension *>(cpy)->GeometryModeFlags  = this->GeometryModeFlags;
 }
 
-void SketchGeometryExtension::Restore(Base::XMLReader &reader)
+void SketchGeometryExtension::restoreAttributes(Base::XMLReader &reader)
 {
-    restoreNameAttribute(reader);
+    Part::GeometryPersistenceExtension::restoreAttributes(reader);
 
     if(reader.hasAttribute("id"))
         Id = reader.getAttributeAsInteger("id");
@@ -79,15 +72,20 @@ void SketchGeometryExtension::Restore(Base::XMLReader &reader)
     GeometryModeFlags = GeometryModeFlagType(reader.getAttribute("geometryModeFlags"));
 }
 
+void SketchGeometryExtension::saveAttributes(Base::Writer &writer) const
+{
+    Part::GeometryPersistenceExtension::saveAttributes(writer);
+
+    writer.Stream() // << "\" id=\"" << Id // This is removed as the stored Id is not used and it may interfere with RT's future implementation
+                    << "\" internalGeometryType=\"" << (int) InternalGeometryType
+                    << "\" geometryModeFlags=\""    << GeometryModeFlags.to_string();
+}
+
 std::unique_ptr<Part::GeometryExtension> SketchGeometryExtension::copy(void) const
 {
     auto cpy = std::make_unique<SketchGeometryExtension>();
 
-    cpy->Id = this->Id;
-    cpy->InternalGeometryType = this->InternalGeometryType;
-    cpy->GeometryModeFlags  = this->GeometryModeFlags;
-
-    cpy->setName(this->getName()); // Base Class
+    copyAttributes(cpy.get());
 
 #if defined (__GNUC__) && (__GNUC__ <=4)
     return std::move(cpy);

src/Mod/Sketcher/App/SketchGeometryExtension.h

@@ -82,10 +82,6 @@ public:
     SketchGeometryExtension(long cid);
     virtual ~SketchGeometryExtension() override = default;
 
-    // Persistence implementer ---------------------
-    virtual void Save(Base::Writer &/*writer*/) const override;
-    virtual void Restore(Base::XMLReader &/*reader*/) override;
-
     virtual std::unique_ptr<Part::GeometryExtension> copy(void) const override;
 
     virtual PyObject *getPyObject(void) override;
@@ -107,6 +103,11 @@ public:
 
     static bool getGeometryModeFromName(std::string str, GeometryMode::GeometryMode &type);
 
+protected:
+    virtual void copyAttributes(Part::GeometryExtension * cpy) const override;
+    virtual void restoreAttributes(Base::XMLReader &reader) override;
+    virtual void saveAttributes(Base::Writer &writer) const override;
+
 private:
     SketchGeometryExtension(const SketchGeometryExtension&) = default;
 

src/Mod/Sketcher/App/SolverGeometryExtension.cpp

@@ -41,16 +41,20 @@ SolverGeometryExtension::SolverGeometryExtension():
 
 }
 
+void SolverGeometryExtension::copyAttributes(Part::GeometryExtension * cpy) const
+{
+    Part::GeometryExtension::copyAttributes(cpy);
+    static_cast<SolverGeometryExtension *>(cpy)->Edge = this->Edge;
+    static_cast<SolverGeometryExtension *>(cpy)->Start = this->Start;
+    static_cast<SolverGeometryExtension *>(cpy)->End  = this->End;
+    static_cast<SolverGeometryExtension *>(cpy)->Mid = this->Mid;
+}
+
 std::unique_ptr<Part::GeometryExtension> SolverGeometryExtension::copy(void) const
 {
     auto cpy = std::make_unique<SolverGeometryExtension>();
 
-    cpy->Edge = this->Edge;
-    cpy->Start = this->Start;
-    cpy->End  = this->End;
-    cpy->Mid = this->Mid;
-
-    cpy->setName(this->getName()); // Base Class
+    copyAttributes(cpy.get());
 
 #if defined (__GNUC__) && (__GNUC__ <=4)
     return std::move(cpy);

src/Mod/Sketcher/App/SolverGeometryExtension.h

@@ -76,6 +76,9 @@ public:
         End = status;
     }
 
+protected:
+    virtual void copyAttributes(Part::GeometryExtension * cpy) const override;
+
 private:
     SolverGeometryExtension(const SolverGeometryExtension&) = default;
 

src/Mod/Sketcher/Gui/ViewProviderSketchGeometryExtension.cpp

@@ -39,13 +39,17 @@ ViewProviderSketchGeometryExtension::ViewProviderSketchGeometryExtension():Repre
 
 }
 
+void ViewProviderSketchGeometryExtension::copyAttributes(Part::GeometryExtension * cpy) const
+{
+    Part::GeometryExtension::copyAttributes(cpy);
+    static_cast<ViewProviderSketchGeometryExtension *>(cpy)->RepresentationFactor = this->RepresentationFactor;
+}
+
 std::unique_ptr<Part::GeometryExtension> ViewProviderSketchGeometryExtension::copy(void) const
 {
     auto cpy = std::make_unique<ViewProviderSketchGeometryExtension>();
 
-    cpy->RepresentationFactor = this->RepresentationFactor;
-
-    cpy->setName(this->getName()); // Base Class
+    copyAttributes(cpy.get());
 
 #if defined (__GNUC__) && (__GNUC__ <=4)
     return std::move(cpy);

src/Mod/Sketcher/Gui/ViewProviderSketchGeometryExtension.h

@@ -50,6 +50,9 @@ public:
     virtual double getRepresentationFactor() const {return RepresentationFactor;}
     virtual void setRepresentationFactor(double representationFactor) {RepresentationFactor = representationFactor;}
 
+protected:
+    virtual void copyAttributes(Part::GeometryExtension * cpy) const override;
+
 private:
     ViewProviderSketchGeometryExtension(const ViewProviderSketchGeometryExtension&) = default;