Implement type checking for XS objects

Type handling is mainly done using templates.
Template Slic3r::ClassTraits is used to store info about exported types (perl class name). Currently only perl class name and refference name is used.
Template values are initialized by REGISTER_CLASS macro. This macro is used in .cpp file of class ( it needs to be used exactly for each type).

Ref<type> class is used to return value as perl reference. Operator overloading is used to make c++ and XSpp happy, only pointer value should be possible to return.

Clone<type> class is used to return copy of value ( using new and copy constructor). Copy is created on assigment, this should be probably improved (memory leak on multiple assignments).
It is overloaded to be able to return type, type* and type&.

Typechecking in ExtrusionEntityCollection updated to check all passed types.

xs/src/BoundingBox.cpp

@@ -1,5 +1,8 @@
 #include "BoundingBox.hpp"
 #include <algorithm>
+#ifdef SLIC3RXS
+#include "perlglue.hpp"
+#endif
 
 namespace Slic3r {
 
@@ -156,4 +159,10 @@ BoundingBox3Base<PointClass>::center() const
 }
 template Pointf3 BoundingBox3Base<Pointf3>::center() const;
 
+#ifdef SLIC3RXS
+REGISTER_CLASS(BoundingBox, "Geometry::BoundingBox");
+REGISTER_CLASS(BoundingBoxf, "Geometry::BoundingBoxf");
+REGISTER_CLASS(BoundingBoxf3, "Geometry::BoundingBoxf3");
+#endif
+
 }

xs/src/ExPolygon.cpp

@@ -4,6 +4,9 @@
 #include "Line.hpp"
 #include "ClipperUtils.hpp"
 #include "polypartition.h"
+#ifdef SLIC3RXS
+#include "perlglue.hpp"
+#endif
 
 #include <list>
 
@@ -240,6 +243,9 @@ ExPolygon::triangulate2(Polygons* polygons) const
 }
 
 #ifdef SLIC3RXS
+
+REGISTER_CLASS(ExPolygon, "ExPolygon");
+
 SV*
 ExPolygon::to_AV() {
     const unsigned int num_holes = this->holes.size();
@@ -257,14 +263,14 @@ ExPolygon::to_AV() {
 SV*
 ExPolygon::to_SV_ref() {
     SV* sv = newSV(0);
-    sv_setref_pv( sv, "Slic3r::ExPolygon::Ref", this );
+    sv_setref_pv( sv, perl_class_name_ref(this), this );
     return sv;
 }
 
 SV*
 ExPolygon::to_SV_clone_ref() const {
     SV* sv = newSV(0);
-    sv_setref_pv( sv, "Slic3r::ExPolygon", new ExPolygon(*this) );
+    sv_setref_pv( sv, perl_class_name(this), new ExPolygon(*this) );
     return sv;
 }
 
@@ -300,8 +306,8 @@ void
 ExPolygon::from_SV_check(SV* expoly_sv)
 {
     if (sv_isobject(expoly_sv) && (SvTYPE(SvRV(expoly_sv)) == SVt_PVMG)) {
-        if (!sv_isa(expoly_sv, "Slic3r::ExPolygon") && !sv_isa(expoly_sv, "Slic3r::ExPolygon::Ref"))
-            CONFESS("Not a valid Slic3r::ExPolygon object");
+        if (!sv_isa(expoly_sv, perl_class_name(this)) && !sv_isa(expoly_sv, perl_class_name_ref(this)))
+          CONFESS("Not a valid %s object", perl_class_name(this));
         // a XS ExPolygon was supplied
         *this = *(ExPolygon *)SvIV((SV*)SvRV( expoly_sv ));
     } else {

xs/src/ExPolygonCollection.cpp

@@ -1,5 +1,8 @@
 #include "ExPolygonCollection.hpp"
 #include "Geometry.hpp"
+#ifdef SLIC3RXS
+#include "perlglue.hpp"
+#endif
 
 namespace Slic3r {
 
@@ -67,4 +70,8 @@ ExPolygonCollection::convex_hull(Polygon* hull) const
     Slic3r::Geometry::convex_hull(pp, hull);
 }
 
+#ifdef SLIC3RXS
+REGISTER_CLASS(ExPolygonCollection, "ExPolygon::Collection");
+#endif
+
 }

xs/src/ExtrusionEntity.cpp

@@ -1,8 +1,11 @@
-#include <sstream>
 #include "ExtrusionEntity.hpp"
 #include "ExtrusionEntityCollection.hpp"
 #include "ExPolygonCollection.hpp"
 #include "ClipperUtils.hpp"
+#include <sstream>
+#ifdef SLIC3RXS
+#include "perlglue.hpp"
+#endif
 
 namespace Slic3r {
 
@@ -102,6 +105,9 @@ ExtrusionPath::_inflate_collection(const Polylines &polylines, ExtrusionEntityCo
 }
 
 #ifdef SLIC3RXS
+
+REGISTER_CLASS(ExtrusionPath, "ExtrusionPath");
+
 std::string
 ExtrusionPath::gcode(SV* extruder, double e, double F,
     double xofs, double yofs, std::string extrusion_axis,
@@ -212,4 +218,8 @@ ExtrusionLoop::last_point() const
     return this->polygon.points.front();  // in polygons, first == last
 }
 
+#ifdef SLIC3RXS
+REGISTER_CLASS(ExtrusionLoop, "ExtrusionLoop");
+#endif
+
 }

xs/src/ExtrusionEntityCollection.cpp

@@ -1,6 +1,9 @@
 #include "ExtrusionEntityCollection.hpp"
 #include <algorithm>
 #include <map>
+#ifdef SLIC3RXS
+#include "perlglue.hpp"
+#endif
 
 namespace Slic3r {
 
@@ -107,4 +110,9 @@ ExtrusionEntityCollection::chained_path_from(Point start_near, ExtrusionEntityCo
     }
 }
 
+#ifdef SLIC3RXS
+// there is no ExtrusionLoop::Collection or ExtrusionEntity::Collection
+REGISTER_CLASS(ExtrusionEntityCollection, "ExtrusionPath::Collection");
+#endif
+
 }

xs/src/Flow.cpp

@@ -1,5 +1,8 @@
 #include "Flow.hpp"
 #include <cmath>
+#ifdef SLIC3RXS
+#include "perlglue.hpp"
+#endif
 
 namespace Slic3r {
 
@@ -112,4 +115,8 @@ Flow::_spacing(float width, float nozzle_diameter, float height, float bridge_fl
     return width - OVERLAP_FACTOR * (width - min_flow_spacing);
 }
 
+#ifdef SLIC3RXS
+REGISTER_CLASS(Flow, "Flow");
+#endif
+
 }

xs/src/Line.cpp

@@ -3,6 +3,9 @@
 #include <algorithm>
 #include <cmath>
 #include <sstream>
+#ifdef SLIC3RXS
+#include "perlglue.hpp"
+#endif
 
 namespace Slic3r {
 
@@ -115,6 +118,9 @@ Line::vector() const
 }
 
 #ifdef SLIC3RXS
+
+REGISTER_CLASS(Line, "Line");
+
 void
 Line::from_SV(SV* line_sv)
 {
@@ -127,8 +133,8 @@ void
 Line::from_SV_check(SV* line_sv)
 {
     if (sv_isobject(line_sv) && (SvTYPE(SvRV(line_sv)) == SVt_PVMG)) {
-        if (!sv_isa(line_sv, "Slic3r::Line") && !sv_isa(line_sv, "Slic3r::Line::Ref"))
-            CONFESS("Not a valid Slic3r::Line object");
+        if (!sv_isa(line_sv, perl_class_name(this)) && !sv_isa(line_sv, perl_class_name_ref(this)))
+            CONFESS("Not a valid %s object", perl_class_name(this));
         *this = *(Line*)SvIV((SV*)SvRV( line_sv ));
     } else {
         this->from_SV(line_sv);
@@ -141,11 +147,11 @@ Line::to_AV() {
     av_extend(av, 1);
     
     SV* sv = newSV(0);
-    sv_setref_pv( sv, "Slic3r::Point::Ref", &(this->a) );
+    sv_setref_pv( sv, perl_class_name_ref(&this->a), &(this->a) );
     av_store(av, 0, sv);
     
     sv = newSV(0);
-    sv_setref_pv( sv, "Slic3r::Point::Ref", &(this->b) );
+    sv_setref_pv( sv, perl_class_name_ref(&this->b), &(this->b) );
     av_store(av, 1, sv);
     
     return newRV_noinc((SV*)av);
@@ -154,14 +160,14 @@ Line::to_AV() {
 SV*
 Line::to_SV_ref() {
     SV* sv = newSV(0);
-    sv_setref_pv( sv, "Slic3r::Line::Ref", this );
+    sv_setref_pv( sv, perl_class_name_ref(this), this );
     return sv;
 }
 
 SV*
 Line::to_SV_clone_ref() const {
     SV* sv = newSV(0);
-    sv_setref_pv( sv, "Slic3r::Line", new Line(*this) );
+    sv_setref_pv( sv, perl_class_name(this), new Line(*this) );
     return sv;
 }
 

xs/src/Point.cpp

@@ -1,7 +1,10 @@
-#include <cmath>
-#include <sstream>
 #include "Point.hpp"
 #include "Line.hpp"
+#include <cmath>
+#include <sstream>
+#ifdef SLIC3RXS
+#include "perlglue.hpp"
+#endif
 
 namespace Slic3r {
 
@@ -139,17 +142,20 @@ Point::ccw(const Line &line) const
 }
 
 #ifdef SLIC3RXS
+
+REGISTER_CLASS(Point, "Point");
+
 SV*
 Point::to_SV_ref() {
     SV* sv = newSV(0);
-    sv_setref_pv( sv, "Slic3r::Point::Ref", (void*)this );
+    sv_setref_pv( sv, perl_class_name_ref(this), (void*)this );
     return sv;
 }
 
 SV*
 Point::to_SV_clone_ref() const {
     SV* sv = newSV(0);
-    sv_setref_pv( sv, "Slic3r::Point", new Point(*this) );
+    sv_setref_pv( sv, perl_class_name(this), new Point(*this) );
     return sv;
 }
 
@@ -176,14 +182,34 @@ void
 Point::from_SV_check(SV* point_sv)
 {
     if (sv_isobject(point_sv) && (SvTYPE(SvRV(point_sv)) == SVt_PVMG)) {
-        if (!sv_isa(point_sv, "Slic3r::Point") && !sv_isa(point_sv, "Slic3r::Point::Ref"))
-            CONFESS("Not a valid Slic3r::Point object");
+        if (!sv_isa(point_sv, perl_class_name(this)) && !sv_isa(point_sv, perl_class_name_ref(this)))
+            CONFESS("Not a valid %s object (got %s)", perl_class_name(this), HvNAME(SvSTASH(SvRV(point_sv))));
         *this = *(Point*)SvIV((SV*)SvRV( point_sv ));
     } else {
         this->from_SV(point_sv);
     }
 }
 
+#endif
+
+void
+Pointf::scale(double factor)
+{
+    this->x *= factor;
+    this->y *= factor;
+}
+
+void
+Pointf::translate(double x, double y)
+{
+    this->x += x;
+    this->y += y;
+}
+
+#ifdef SLIC3RXS
+
+REGISTER_CLASS(Pointf, "Pointf");
+
 SV*
 Pointf::to_SV_pureperl() const {
     AV* av = newAV();
@@ -207,20 +233,6 @@ Pointf::from_SV(SV* point_sv)
 }
 #endif
 
-void
-Pointf::scale(double factor)
-{
-    this->x *= factor;
-    this->y *= factor;
-}
-
-void
-Pointf::translate(double x, double y)
-{
-    this->x += x;
-    this->y += y;
-}
-
 void
 Pointf3::scale(double factor)
 {
@@ -235,4 +247,8 @@ Pointf3::translate(double x, double y, double z)
     this->z += z;
 }
 
+#ifdef SLIC3RXS
+REGISTER_CLASS(Pointf3, "Pointf3");
+#endif
+
 }

xs/src/Polygon.cpp

@@ -2,6 +2,9 @@
 #include "ClipperUtils.hpp"
 #include "Polygon.hpp"
 #include "Polyline.hpp"
+#ifdef SLIC3RXS
+#include "perlglue.hpp"
+#endif
 
 namespace Slic3r {
 
@@ -175,25 +178,28 @@ Polygon::triangulate_convex(Polygons* polygons) const
 }
 
 #ifdef SLIC3RXS
+
+REGISTER_CLASS(Polygon, "Polygon");
+
 SV*
 Polygon::to_SV_ref() {
     SV* sv = newSV(0);
-    sv_setref_pv( sv, "Slic3r::Polygon::Ref", (void*)this );
+    sv_setref_pv( sv, perl_class_name_ref(this), (void*)this );
     return sv;
 }
 
 SV*
 Polygon::to_SV_clone_ref() const {
     SV* sv = newSV(0);
-    sv_setref_pv( sv, "Slic3r::Polygon", new Polygon(*this) );
+    sv_setref_pv( sv, perl_class_name(this), new Polygon(*this) );
     return sv;
 }
 
 void
 Polygon::from_SV_check(SV* poly_sv)
 {
-    if (sv_isobject(poly_sv) && !sv_isa(poly_sv, "Slic3r::Polygon") && !sv_isa(poly_sv, "Slic3r::Polygon::Ref"))
-        CONFESS("Not a valid Slic3r::Polygon object");
+    if (sv_isobject(poly_sv) && !sv_isa(poly_sv, perl_class_name(this)) && !sv_isa(poly_sv, perl_class_name_ref(this)))
+        CONFESS("Not a valid %s object", perl_class_name(this));
     
     MultiPoint::from_SV_check(poly_sv);
 }

xs/src/Polyline.cpp

@@ -1,5 +1,8 @@
 #include "Polyline.hpp"
 #include "Polygon.hpp"
+#ifdef SLIC3RXS
+#include "perlglue.hpp"
+#endif
 
 namespace Slic3r {
 
@@ -122,11 +125,14 @@ Polyline::simplify(double tolerance)
 
 
 #ifdef SLIC3RXS
+
+REGISTER_CLASS(Polyline, "Polyline");
+
 SV*
 Polyline::to_SV_ref()
 {
     SV* sv = newSV(0);
-    sv_setref_pv( sv, "Slic3r::Polyline::Ref", (void*)this );
+    sv_setref_pv( sv, perl_class_name_ref(this), (void*)this );
     return sv;
 }
 
@@ -134,15 +140,15 @@ SV*
 Polyline::to_SV_clone_ref() const
 {
     SV* sv = newSV(0);
-    sv_setref_pv( sv, "Slic3r::Polyline", new Polyline(*this) );
+    sv_setref_pv( sv, perl_class_name(this), new Polyline(*this) );
     return sv;
 }
 
 void
 Polyline::from_SV_check(SV* poly_sv)
 {
-    if (!sv_isa(poly_sv, "Slic3r::Polyline") && !sv_isa(poly_sv, "Slic3r::Polyline::Ref"))
-        CONFESS("Not a valid Slic3r::Polyline object");
+    if (!sv_isa(poly_sv, perl_class_name(this)) && !sv_isa(poly_sv, perl_class_name_ref(this)))
+        CONFESS("Not a valid %s object",perl_class_name(this));
     
     MultiPoint::from_SV_check(poly_sv);
 }

xs/src/PolylineCollection.cpp

@@ -1,4 +1,7 @@
 #include "PolylineCollection.hpp"
+#ifdef SLIC3RXS
+#include "perlglue.hpp"
+#endif
 
 namespace Slic3r {
 
@@ -50,4 +53,8 @@ PolylineCollection::leftmost_point() const
     return p;
 }
 
+#ifdef SLIC3RXS
+REGISTER_CLASS(PolylineCollection, "Polyline::Collection");
+#endif
+
 }

xs/src/Print.cpp

@@ -1,4 +1,7 @@
 #include "Print.hpp"
+#ifdef SLIC3RXS
+#include "perlglue.hpp"
+#endif
 
 namespace Slic3r {
 
@@ -40,4 +43,8 @@ PrintState::invalidate_all()
     this->_done.clear();
 }
 
+#ifdef SLIC3RXS
+REGISTER_CLASS(PrintState, "Print::State");
+#endif
+
 }

xs/src/PrintConfig.cpp

@@ -1,7 +1,18 @@
 #include "PrintConfig.hpp"
+#ifdef SLIC3RXS
+#include "perlglue.hpp"
+#endif
 
 namespace Slic3r {
 
 t_optiondef_map PrintConfigDef::def = PrintConfigDef::build_def();
 
+#ifdef SLIC3RXS
+REGISTER_CLASS(DynamicPrintConfig, "Config");
+REGISTER_CLASS(PrintObjectConfig, "Config::PrintObject");
+REGISTER_CLASS(PrintRegionConfig, "Config::PrintRegion");
+REGISTER_CLASS(PrintConfig, "Config::Print");
+REGISTER_CLASS(FullPrintConfig, "Config::Full");
+#endif
+
 }

xs/src/Surface.cpp

@@ -1,4 +1,7 @@
 #include "Surface.hpp"
+#ifdef SLIC3RXS
+#include "perlglue.hpp"
+#endif
 
 namespace Slic3r {
 
@@ -40,11 +43,14 @@ Surface::is_bridge() const
 }
 
 #ifdef SLIC3RXS
+
+REGISTER_CLASS(Surface, "Surface");
+
 void
 Surface::from_SV_check(SV* surface_sv)
 {
-    if (!sv_isa(surface_sv, "Slic3r::Surface") && !sv_isa(surface_sv, "Slic3r::Surface::Ref"))
-        CONFESS("Not a valid Slic3r::Surface object");
+    if (!sv_isa(surface_sv, perl_class_name(this)) && !sv_isa(surface_sv, perl_class_name_ref(this)))
+        CONFESS("Not a valid %s object", perl_class_name(this));
     // a XS Surface was supplied
     *this = *(Surface *)SvIV((SV*)SvRV( surface_sv ));
 }
@@ -52,14 +58,14 @@ Surface::from_SV_check(SV* surface_sv)
 SV*
 Surface::to_SV_ref() {
     SV* sv = newSV(0);
-    sv_setref_pv( sv, "Slic3r::Surface::Ref", (void*)this );
+    sv_setref_pv( sv, perl_class_name_ref(this), (void*)this );
     return sv;
 }
 
 SV*
 Surface::to_SV_clone_ref() const {
     SV* sv = newSV(0);
-    sv_setref_pv( sv, "Slic3r::Surface", new Surface(*this) );
+    sv_setref_pv( sv, perl_class_name(this), new Surface(*this) );
     return sv;
 }
 #endif

xs/src/SurfaceCollection.cpp

@@ -1,5 +1,8 @@
 #include "SurfaceCollection.hpp"
 #include <map>
+#ifdef SLIC3RXS
+#include "perlglue.hpp"
+#endif
 
 namespace Slic3r {
 
@@ -48,4 +51,8 @@ SurfaceCollection::group(std::vector<SurfacesPtr> *retval)
     }
 }
 
+#ifdef SLIC3RXS
+REGISTER_CLASS(SurfaceCollection, "Surface::Collection");
+#endif
+
 }

xs/src/TriangleMesh.cpp

@@ -11,6 +11,9 @@
 #include <algorithm>
 #include <math.h>
 #include <assert.h>
+#ifdef SLIC3RXS
+#include "perlglue.hpp"
+#endif
 
 #ifdef SLIC3R_DEBUG
 #include "SVG.hpp"
@@ -320,10 +323,13 @@ TriangleMesh::require_shared_vertices()
 }
 
 #ifdef SLIC3RXS
+
+REGISTER_CLASS(TriangleMesh, "TriangleMesh");
+
 SV*
 TriangleMesh::to_SV() {
     SV* sv = newSV(0);
-    sv_setref_pv( sv, "Slic3r::TriangleMesh", (void*)this );
+    sv_setref_pv( sv, perl_class_name(this), (void*)this );
     return sv;
 }
 

xs/src/perlglue.hpp

@@ -0,0 +1,44 @@
+#ifndef slic3r_perlglue_hpp_
+#define slic3r_perlglue_hpp_
+
+namespace Slic3r {
+    
+template<class T>
+struct ClassTraits { 
+    static const char* name;
+    static const char* name_ref; 
+};
+    
+#define REGISTER_CLASS(cname,perlname)                                               \
+    class cname;                                                                     \
+    template <>const char* ClassTraits<cname>::name = "Slic3r::" perlname;           \
+    template <>const char* ClassTraits<cname>::name_ref = "Slic3r::" perlname "::Ref"; 
+    
+template<class T>
+const char* perl_class_name(const T*) { return ClassTraits<T>::name; }
+template<class T>
+const char* perl_class_name_ref(const T*) { return ClassTraits<T>::name_ref; }
+    
+template <class T> 
+class Ref {
+    T* val;
+public:
+    Ref() {}
+    Ref(T* t) : val(t) {}
+    operator T*() const {return val; }
+    static const char* CLASS() { return ClassTraits<T>::name_ref; }
+};
+  
+template <class T>
+class Clone {
+    T* val;
+public:
+    Clone() {}
+    Clone(T* t) : val(new T(*t)) {}
+    Clone(const T& t) : val(new T(t)) {}
+    operator T*() const {return val; }
+    static const char* CLASS() { return ClassTraits<T>::name; }
+};
+};
+
+#endif