test_smart_ptr.cpp revision 11986
111986Sandreas.sandberg@arm.com/* 211986Sandreas.sandberg@arm.com tests/test_smart_ptr.cpp -- binding classes with custom reference counting, 311986Sandreas.sandberg@arm.com implicit conversions between types 411986Sandreas.sandberg@arm.com 511986Sandreas.sandberg@arm.com Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> 611986Sandreas.sandberg@arm.com 711986Sandreas.sandberg@arm.com All rights reserved. Use of this source code is governed by a 811986Sandreas.sandberg@arm.com BSD-style license that can be found in the LICENSE file. 911986Sandreas.sandberg@arm.com*/ 1011986Sandreas.sandberg@arm.com 1111986Sandreas.sandberg@arm.com#include "pybind11_tests.h" 1211986Sandreas.sandberg@arm.com#include "object.h" 1311986Sandreas.sandberg@arm.com 1411986Sandreas.sandberg@arm.com/// Custom object with builtin reference counting (see 'object.h' for the implementation) 1511986Sandreas.sandberg@arm.comclass MyObject1 : public Object { 1611986Sandreas.sandberg@arm.compublic: 1711986Sandreas.sandberg@arm.com MyObject1(int value) : value(value) { 1811986Sandreas.sandberg@arm.com print_created(this, toString()); 1911986Sandreas.sandberg@arm.com } 2011986Sandreas.sandberg@arm.com 2111986Sandreas.sandberg@arm.com std::string toString() const { 2211986Sandreas.sandberg@arm.com return "MyObject1[" + std::to_string(value) + "]"; 2311986Sandreas.sandberg@arm.com } 2411986Sandreas.sandberg@arm.com 2511986Sandreas.sandberg@arm.comprotected: 2611986Sandreas.sandberg@arm.com virtual ~MyObject1() { 2711986Sandreas.sandberg@arm.com print_destroyed(this); 2811986Sandreas.sandberg@arm.com } 2911986Sandreas.sandberg@arm.com 3011986Sandreas.sandberg@arm.comprivate: 3111986Sandreas.sandberg@arm.com int value; 3211986Sandreas.sandberg@arm.com}; 3311986Sandreas.sandberg@arm.com 3411986Sandreas.sandberg@arm.com/// Object managed by a std::shared_ptr<> 3511986Sandreas.sandberg@arm.comclass MyObject2 { 3611986Sandreas.sandberg@arm.compublic: 3711986Sandreas.sandberg@arm.com MyObject2(int value) : value(value) { 3811986Sandreas.sandberg@arm.com print_created(this, toString()); 3911986Sandreas.sandberg@arm.com } 4011986Sandreas.sandberg@arm.com 4111986Sandreas.sandberg@arm.com std::string toString() const { 4211986Sandreas.sandberg@arm.com return "MyObject2[" + std::to_string(value) + "]"; 4311986Sandreas.sandberg@arm.com } 4411986Sandreas.sandberg@arm.com 4511986Sandreas.sandberg@arm.com virtual ~MyObject2() { 4611986Sandreas.sandberg@arm.com print_destroyed(this); 4711986Sandreas.sandberg@arm.com } 4811986Sandreas.sandberg@arm.com 4911986Sandreas.sandberg@arm.comprivate: 5011986Sandreas.sandberg@arm.com int value; 5111986Sandreas.sandberg@arm.com}; 5211986Sandreas.sandberg@arm.com 5311986Sandreas.sandberg@arm.com/// Object managed by a std::shared_ptr<>, additionally derives from std::enable_shared_from_this<> 5411986Sandreas.sandberg@arm.comclass MyObject3 : public std::enable_shared_from_this<MyObject3> { 5511986Sandreas.sandberg@arm.compublic: 5611986Sandreas.sandberg@arm.com MyObject3(int value) : value(value) { 5711986Sandreas.sandberg@arm.com print_created(this, toString()); 5811986Sandreas.sandberg@arm.com } 5911986Sandreas.sandberg@arm.com 6011986Sandreas.sandberg@arm.com std::string toString() const { 6111986Sandreas.sandberg@arm.com return "MyObject3[" + std::to_string(value) + "]"; 6211986Sandreas.sandberg@arm.com } 6311986Sandreas.sandberg@arm.com 6411986Sandreas.sandberg@arm.com virtual ~MyObject3() { 6511986Sandreas.sandberg@arm.com print_destroyed(this); 6611986Sandreas.sandberg@arm.com } 6711986Sandreas.sandberg@arm.com 6811986Sandreas.sandberg@arm.comprivate: 6911986Sandreas.sandberg@arm.com int value; 7011986Sandreas.sandberg@arm.com}; 7111986Sandreas.sandberg@arm.com 7211986Sandreas.sandberg@arm.comclass MyObject4 { 7311986Sandreas.sandberg@arm.compublic: 7411986Sandreas.sandberg@arm.com MyObject4(int value) : value{value} { 7511986Sandreas.sandberg@arm.com print_created(this); 7611986Sandreas.sandberg@arm.com } 7711986Sandreas.sandberg@arm.com int value; 7811986Sandreas.sandberg@arm.comprivate: 7911986Sandreas.sandberg@arm.com ~MyObject4() { 8011986Sandreas.sandberg@arm.com print_destroyed(this); 8111986Sandreas.sandberg@arm.com } 8211986Sandreas.sandberg@arm.com}; 8311986Sandreas.sandberg@arm.com 8411986Sandreas.sandberg@arm.com/// Make pybind aware of the ref-counted wrapper type (s) 8511986Sandreas.sandberg@arm.comPYBIND11_DECLARE_HOLDER_TYPE(T, ref<T>); // Required for custom holder type 8611986Sandreas.sandberg@arm.comPYBIND11_DECLARE_HOLDER_TYPE(T, std::shared_ptr<T>); // Not required any more for std::shared_ptr, 8711986Sandreas.sandberg@arm.com // but it should compile without error 8811986Sandreas.sandberg@arm.com 8911986Sandreas.sandberg@arm.comObject *make_object_1() { return new MyObject1(1); } 9011986Sandreas.sandberg@arm.comref<Object> make_object_2() { return new MyObject1(2); } 9111986Sandreas.sandberg@arm.com 9211986Sandreas.sandberg@arm.comMyObject1 *make_myobject1_1() { return new MyObject1(4); } 9311986Sandreas.sandberg@arm.comref<MyObject1> make_myobject1_2() { return new MyObject1(5); } 9411986Sandreas.sandberg@arm.com 9511986Sandreas.sandberg@arm.comMyObject2 *make_myobject2_1() { return new MyObject2(6); } 9611986Sandreas.sandberg@arm.comstd::shared_ptr<MyObject2> make_myobject2_2() { return std::make_shared<MyObject2>(7); } 9711986Sandreas.sandberg@arm.com 9811986Sandreas.sandberg@arm.comMyObject3 *make_myobject3_1() { return new MyObject3(8); } 9911986Sandreas.sandberg@arm.comstd::shared_ptr<MyObject3> make_myobject3_2() { return std::make_shared<MyObject3>(9); } 10011986Sandreas.sandberg@arm.com 10111986Sandreas.sandberg@arm.comvoid print_object_1(const Object *obj) { py::print(obj->toString()); } 10211986Sandreas.sandberg@arm.comvoid print_object_2(ref<Object> obj) { py::print(obj->toString()); } 10311986Sandreas.sandberg@arm.comvoid print_object_3(const ref<Object> &obj) { py::print(obj->toString()); } 10411986Sandreas.sandberg@arm.comvoid print_object_4(const ref<Object> *obj) { py::print((*obj)->toString()); } 10511986Sandreas.sandberg@arm.com 10611986Sandreas.sandberg@arm.comvoid print_myobject1_1(const MyObject1 *obj) { py::print(obj->toString()); } 10711986Sandreas.sandberg@arm.comvoid print_myobject1_2(ref<MyObject1> obj) { py::print(obj->toString()); } 10811986Sandreas.sandberg@arm.comvoid print_myobject1_3(const ref<MyObject1> &obj) { py::print(obj->toString()); } 10911986Sandreas.sandberg@arm.comvoid print_myobject1_4(const ref<MyObject1> *obj) { py::print((*obj)->toString()); } 11011986Sandreas.sandberg@arm.com 11111986Sandreas.sandberg@arm.comvoid print_myobject2_1(const MyObject2 *obj) { py::print(obj->toString()); } 11211986Sandreas.sandberg@arm.comvoid print_myobject2_2(std::shared_ptr<MyObject2> obj) { py::print(obj->toString()); } 11311986Sandreas.sandberg@arm.comvoid print_myobject2_3(const std::shared_ptr<MyObject2> &obj) { py::print(obj->toString()); } 11411986Sandreas.sandberg@arm.comvoid print_myobject2_4(const std::shared_ptr<MyObject2> *obj) { py::print((*obj)->toString()); } 11511986Sandreas.sandberg@arm.com 11611986Sandreas.sandberg@arm.comvoid print_myobject3_1(const MyObject3 *obj) { py::print(obj->toString()); } 11711986Sandreas.sandberg@arm.comvoid print_myobject3_2(std::shared_ptr<MyObject3> obj) { py::print(obj->toString()); } 11811986Sandreas.sandberg@arm.comvoid print_myobject3_3(const std::shared_ptr<MyObject3> &obj) { py::print(obj->toString()); } 11911986Sandreas.sandberg@arm.comvoid print_myobject3_4(const std::shared_ptr<MyObject3> *obj) { py::print((*obj)->toString()); } 12011986Sandreas.sandberg@arm.com 12111986Sandreas.sandberg@arm.comtest_initializer smart_ptr([](py::module &m) { 12211986Sandreas.sandberg@arm.com py::class_<Object, ref<Object>> obj(m, "Object"); 12311986Sandreas.sandberg@arm.com obj.def("getRefCount", &Object::getRefCount); 12411986Sandreas.sandberg@arm.com 12511986Sandreas.sandberg@arm.com py::class_<MyObject1, ref<MyObject1>>(m, "MyObject1", obj) 12611986Sandreas.sandberg@arm.com .def(py::init<int>()); 12711986Sandreas.sandberg@arm.com 12811986Sandreas.sandberg@arm.com m.def("make_object_1", &make_object_1); 12911986Sandreas.sandberg@arm.com m.def("make_object_2", &make_object_2); 13011986Sandreas.sandberg@arm.com m.def("make_myobject1_1", &make_myobject1_1); 13111986Sandreas.sandberg@arm.com m.def("make_myobject1_2", &make_myobject1_2); 13211986Sandreas.sandberg@arm.com m.def("print_object_1", &print_object_1); 13311986Sandreas.sandberg@arm.com m.def("print_object_2", &print_object_2); 13411986Sandreas.sandberg@arm.com m.def("print_object_3", &print_object_3); 13511986Sandreas.sandberg@arm.com m.def("print_object_4", &print_object_4); 13611986Sandreas.sandberg@arm.com m.def("print_myobject1_1", &print_myobject1_1); 13711986Sandreas.sandberg@arm.com m.def("print_myobject1_2", &print_myobject1_2); 13811986Sandreas.sandberg@arm.com m.def("print_myobject1_3", &print_myobject1_3); 13911986Sandreas.sandberg@arm.com m.def("print_myobject1_4", &print_myobject1_4); 14011986Sandreas.sandberg@arm.com 14111986Sandreas.sandberg@arm.com py::class_<MyObject2, std::shared_ptr<MyObject2>>(m, "MyObject2") 14211986Sandreas.sandberg@arm.com .def(py::init<int>()); 14311986Sandreas.sandberg@arm.com m.def("make_myobject2_1", &make_myobject2_1); 14411986Sandreas.sandberg@arm.com m.def("make_myobject2_2", &make_myobject2_2); 14511986Sandreas.sandberg@arm.com m.def("print_myobject2_1", &print_myobject2_1); 14611986Sandreas.sandberg@arm.com m.def("print_myobject2_2", &print_myobject2_2); 14711986Sandreas.sandberg@arm.com m.def("print_myobject2_3", &print_myobject2_3); 14811986Sandreas.sandberg@arm.com m.def("print_myobject2_4", &print_myobject2_4); 14911986Sandreas.sandberg@arm.com 15011986Sandreas.sandberg@arm.com py::class_<MyObject3, std::shared_ptr<MyObject3>>(m, "MyObject3") 15111986Sandreas.sandberg@arm.com .def(py::init<int>()); 15211986Sandreas.sandberg@arm.com m.def("make_myobject3_1", &make_myobject3_1); 15311986Sandreas.sandberg@arm.com m.def("make_myobject3_2", &make_myobject3_2); 15411986Sandreas.sandberg@arm.com m.def("print_myobject3_1", &print_myobject3_1); 15511986Sandreas.sandberg@arm.com m.def("print_myobject3_2", &print_myobject3_2); 15611986Sandreas.sandberg@arm.com m.def("print_myobject3_3", &print_myobject3_3); 15711986Sandreas.sandberg@arm.com m.def("print_myobject3_4", &print_myobject3_4); 15811986Sandreas.sandberg@arm.com 15911986Sandreas.sandberg@arm.com py::class_<MyObject4, std::unique_ptr<MyObject4, py::nodelete>>(m, "MyObject4") 16011986Sandreas.sandberg@arm.com .def(py::init<int>()) 16111986Sandreas.sandberg@arm.com .def_readwrite("value", &MyObject4::value); 16211986Sandreas.sandberg@arm.com 16311986Sandreas.sandberg@arm.com py::implicitly_convertible<py::int_, MyObject1>(); 16411986Sandreas.sandberg@arm.com 16511986Sandreas.sandberg@arm.com // Expose constructor stats for the ref type 16611986Sandreas.sandberg@arm.com m.def("cstats_ref", &ConstructorStats::get<ref_tag>); 16711986Sandreas.sandberg@arm.com}); 16811986Sandreas.sandberg@arm.com 16911986Sandreas.sandberg@arm.comstruct SharedPtrRef { 17011986Sandreas.sandberg@arm.com struct A { 17111986Sandreas.sandberg@arm.com A() { print_created(this); } 17211986Sandreas.sandberg@arm.com A(const A &) { print_copy_created(this); } 17311986Sandreas.sandberg@arm.com A(A &&) { print_move_created(this); } 17411986Sandreas.sandberg@arm.com ~A() { print_destroyed(this); } 17511986Sandreas.sandberg@arm.com }; 17611986Sandreas.sandberg@arm.com 17711986Sandreas.sandberg@arm.com A value = {}; 17811986Sandreas.sandberg@arm.com std::shared_ptr<A> shared = std::make_shared<A>(); 17911986Sandreas.sandberg@arm.com}; 18011986Sandreas.sandberg@arm.com 18111986Sandreas.sandberg@arm.comstruct SharedFromThisRef { 18211986Sandreas.sandberg@arm.com struct B : std::enable_shared_from_this<B> { 18311986Sandreas.sandberg@arm.com B() { print_created(this); } 18411986Sandreas.sandberg@arm.com B(const B &) : std::enable_shared_from_this<B>() { print_copy_created(this); } 18511986Sandreas.sandberg@arm.com B(B &&) : std::enable_shared_from_this<B>() { print_move_created(this); } 18611986Sandreas.sandberg@arm.com ~B() { print_destroyed(this); } 18711986Sandreas.sandberg@arm.com }; 18811986Sandreas.sandberg@arm.com 18911986Sandreas.sandberg@arm.com B value = {}; 19011986Sandreas.sandberg@arm.com std::shared_ptr<B> shared = std::make_shared<B>(); 19111986Sandreas.sandberg@arm.com}; 19211986Sandreas.sandberg@arm.com 19311986Sandreas.sandberg@arm.comtest_initializer smart_ptr_and_references([](py::module &pm) { 19411986Sandreas.sandberg@arm.com auto m = pm.def_submodule("smart_ptr"); 19511986Sandreas.sandberg@arm.com 19611986Sandreas.sandberg@arm.com using A = SharedPtrRef::A; 19711986Sandreas.sandberg@arm.com py::class_<A, std::shared_ptr<A>>(m, "A"); 19811986Sandreas.sandberg@arm.com 19911986Sandreas.sandberg@arm.com py::class_<SharedPtrRef>(m, "SharedPtrRef") 20011986Sandreas.sandberg@arm.com .def(py::init<>()) 20111986Sandreas.sandberg@arm.com .def_readonly("ref", &SharedPtrRef::value) 20211986Sandreas.sandberg@arm.com .def_property_readonly("copy", [](const SharedPtrRef &s) { return s.value; }, 20311986Sandreas.sandberg@arm.com py::return_value_policy::copy) 20411986Sandreas.sandberg@arm.com .def_readonly("holder_ref", &SharedPtrRef::shared) 20511986Sandreas.sandberg@arm.com .def_property_readonly("holder_copy", [](const SharedPtrRef &s) { return s.shared; }, 20611986Sandreas.sandberg@arm.com py::return_value_policy::copy) 20711986Sandreas.sandberg@arm.com .def("set_ref", [](SharedPtrRef &, const A &) { return true; }) 20811986Sandreas.sandberg@arm.com .def("set_holder", [](SharedPtrRef &, std::shared_ptr<A>) { return true; }); 20911986Sandreas.sandberg@arm.com 21011986Sandreas.sandberg@arm.com using B = SharedFromThisRef::B; 21111986Sandreas.sandberg@arm.com py::class_<B, std::shared_ptr<B>>(m, "B"); 21211986Sandreas.sandberg@arm.com 21311986Sandreas.sandberg@arm.com py::class_<SharedFromThisRef>(m, "SharedFromThisRef") 21411986Sandreas.sandberg@arm.com .def(py::init<>()) 21511986Sandreas.sandberg@arm.com .def_readonly("bad_wp", &SharedFromThisRef::value) 21611986Sandreas.sandberg@arm.com .def_property_readonly("ref", [](const SharedFromThisRef &s) -> const B & { return *s.shared; }) 21711986Sandreas.sandberg@arm.com .def_property_readonly("copy", [](const SharedFromThisRef &s) { return s.value; }, 21811986Sandreas.sandberg@arm.com py::return_value_policy::copy) 21911986Sandreas.sandberg@arm.com .def_readonly("holder_ref", &SharedFromThisRef::shared) 22011986Sandreas.sandberg@arm.com .def_property_readonly("holder_copy", [](const SharedFromThisRef &s) { return s.shared; }, 22111986Sandreas.sandberg@arm.com py::return_value_policy::copy) 22211986Sandreas.sandberg@arm.com .def("set_ref", [](SharedFromThisRef &, const B &) { return true; }) 22311986Sandreas.sandberg@arm.com .def("set_holder", [](SharedFromThisRef &, std::shared_ptr<B>) { return true; }); 22411986Sandreas.sandberg@arm.com}); 225