test_smart_ptr.cpp revision 12037
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) 8512037Sandreas.sandberg@arm.com 8612037Sandreas.sandberg@arm.com// ref<T> is a wrapper for 'Object' which uses intrusive reference counting 8712037Sandreas.sandberg@arm.com// It is always possible to construct a ref<T> from an Object* pointer without 8812037Sandreas.sandberg@arm.com// possible incosistencies, hence the 'true' argument at the end. 8912037Sandreas.sandberg@arm.comPYBIND11_DECLARE_HOLDER_TYPE(T, ref<T>, true); 9011986Sandreas.sandberg@arm.comPYBIND11_DECLARE_HOLDER_TYPE(T, std::shared_ptr<T>); // Not required any more for std::shared_ptr, 9111986Sandreas.sandberg@arm.com // but it should compile without error 9211986Sandreas.sandberg@arm.com 9312037Sandreas.sandberg@arm.com// Make pybind11 aware of the non-standard getter member function 9412037Sandreas.sandberg@arm.comnamespace pybind11 { namespace detail { 9512037Sandreas.sandberg@arm.com template <typename T> 9612037Sandreas.sandberg@arm.com struct holder_helper<ref<T>> { 9712037Sandreas.sandberg@arm.com static const T *get(const ref<T> &p) { return p.get_ptr(); } 9812037Sandreas.sandberg@arm.com }; 9912037Sandreas.sandberg@arm.com}} 10012037Sandreas.sandberg@arm.com 10111986Sandreas.sandberg@arm.comObject *make_object_1() { return new MyObject1(1); } 10211986Sandreas.sandberg@arm.comref<Object> make_object_2() { return new MyObject1(2); } 10311986Sandreas.sandberg@arm.com 10411986Sandreas.sandberg@arm.comMyObject1 *make_myobject1_1() { return new MyObject1(4); } 10511986Sandreas.sandberg@arm.comref<MyObject1> make_myobject1_2() { return new MyObject1(5); } 10611986Sandreas.sandberg@arm.com 10711986Sandreas.sandberg@arm.comMyObject2 *make_myobject2_1() { return new MyObject2(6); } 10811986Sandreas.sandberg@arm.comstd::shared_ptr<MyObject2> make_myobject2_2() { return std::make_shared<MyObject2>(7); } 10911986Sandreas.sandberg@arm.com 11011986Sandreas.sandberg@arm.comMyObject3 *make_myobject3_1() { return new MyObject3(8); } 11111986Sandreas.sandberg@arm.comstd::shared_ptr<MyObject3> make_myobject3_2() { return std::make_shared<MyObject3>(9); } 11211986Sandreas.sandberg@arm.com 11311986Sandreas.sandberg@arm.comvoid print_object_1(const Object *obj) { py::print(obj->toString()); } 11411986Sandreas.sandberg@arm.comvoid print_object_2(ref<Object> obj) { py::print(obj->toString()); } 11511986Sandreas.sandberg@arm.comvoid print_object_3(const ref<Object> &obj) { py::print(obj->toString()); } 11611986Sandreas.sandberg@arm.comvoid print_object_4(const ref<Object> *obj) { py::print((*obj)->toString()); } 11711986Sandreas.sandberg@arm.com 11811986Sandreas.sandberg@arm.comvoid print_myobject1_1(const MyObject1 *obj) { py::print(obj->toString()); } 11911986Sandreas.sandberg@arm.comvoid print_myobject1_2(ref<MyObject1> obj) { py::print(obj->toString()); } 12011986Sandreas.sandberg@arm.comvoid print_myobject1_3(const ref<MyObject1> &obj) { py::print(obj->toString()); } 12111986Sandreas.sandberg@arm.comvoid print_myobject1_4(const ref<MyObject1> *obj) { py::print((*obj)->toString()); } 12211986Sandreas.sandberg@arm.com 12311986Sandreas.sandberg@arm.comvoid print_myobject2_1(const MyObject2 *obj) { py::print(obj->toString()); } 12411986Sandreas.sandberg@arm.comvoid print_myobject2_2(std::shared_ptr<MyObject2> obj) { py::print(obj->toString()); } 12511986Sandreas.sandberg@arm.comvoid print_myobject2_3(const std::shared_ptr<MyObject2> &obj) { py::print(obj->toString()); } 12611986Sandreas.sandberg@arm.comvoid print_myobject2_4(const std::shared_ptr<MyObject2> *obj) { py::print((*obj)->toString()); } 12711986Sandreas.sandberg@arm.com 12811986Sandreas.sandberg@arm.comvoid print_myobject3_1(const MyObject3 *obj) { py::print(obj->toString()); } 12911986Sandreas.sandberg@arm.comvoid print_myobject3_2(std::shared_ptr<MyObject3> obj) { py::print(obj->toString()); } 13011986Sandreas.sandberg@arm.comvoid print_myobject3_3(const std::shared_ptr<MyObject3> &obj) { py::print(obj->toString()); } 13111986Sandreas.sandberg@arm.comvoid print_myobject3_4(const std::shared_ptr<MyObject3> *obj) { py::print((*obj)->toString()); } 13211986Sandreas.sandberg@arm.com 13311986Sandreas.sandberg@arm.comtest_initializer smart_ptr([](py::module &m) { 13411986Sandreas.sandberg@arm.com py::class_<Object, ref<Object>> obj(m, "Object"); 13511986Sandreas.sandberg@arm.com obj.def("getRefCount", &Object::getRefCount); 13611986Sandreas.sandberg@arm.com 13711986Sandreas.sandberg@arm.com py::class_<MyObject1, ref<MyObject1>>(m, "MyObject1", obj) 13811986Sandreas.sandberg@arm.com .def(py::init<int>()); 13911986Sandreas.sandberg@arm.com 14012037Sandreas.sandberg@arm.com m.def("test_object1_refcounting", 14112037Sandreas.sandberg@arm.com []() -> bool { 14212037Sandreas.sandberg@arm.com ref<MyObject1> o = new MyObject1(0); 14312037Sandreas.sandberg@arm.com bool good = o->getRefCount() == 1; 14412037Sandreas.sandberg@arm.com py::object o2 = py::cast(o, py::return_value_policy::reference); 14512037Sandreas.sandberg@arm.com // always request (partial) ownership for objects with intrusive 14612037Sandreas.sandberg@arm.com // reference counting even when using the 'reference' RVP 14712037Sandreas.sandberg@arm.com good &= o->getRefCount() == 2; 14812037Sandreas.sandberg@arm.com return good; 14912037Sandreas.sandberg@arm.com } 15012037Sandreas.sandberg@arm.com ); 15112037Sandreas.sandberg@arm.com 15211986Sandreas.sandberg@arm.com m.def("make_object_1", &make_object_1); 15311986Sandreas.sandberg@arm.com m.def("make_object_2", &make_object_2); 15411986Sandreas.sandberg@arm.com m.def("make_myobject1_1", &make_myobject1_1); 15511986Sandreas.sandberg@arm.com m.def("make_myobject1_2", &make_myobject1_2); 15611986Sandreas.sandberg@arm.com m.def("print_object_1", &print_object_1); 15711986Sandreas.sandberg@arm.com m.def("print_object_2", &print_object_2); 15811986Sandreas.sandberg@arm.com m.def("print_object_3", &print_object_3); 15911986Sandreas.sandberg@arm.com m.def("print_object_4", &print_object_4); 16011986Sandreas.sandberg@arm.com m.def("print_myobject1_1", &print_myobject1_1); 16111986Sandreas.sandberg@arm.com m.def("print_myobject1_2", &print_myobject1_2); 16211986Sandreas.sandberg@arm.com m.def("print_myobject1_3", &print_myobject1_3); 16311986Sandreas.sandberg@arm.com m.def("print_myobject1_4", &print_myobject1_4); 16411986Sandreas.sandberg@arm.com 16511986Sandreas.sandberg@arm.com py::class_<MyObject2, std::shared_ptr<MyObject2>>(m, "MyObject2") 16611986Sandreas.sandberg@arm.com .def(py::init<int>()); 16711986Sandreas.sandberg@arm.com m.def("make_myobject2_1", &make_myobject2_1); 16811986Sandreas.sandberg@arm.com m.def("make_myobject2_2", &make_myobject2_2); 16911986Sandreas.sandberg@arm.com m.def("print_myobject2_1", &print_myobject2_1); 17011986Sandreas.sandberg@arm.com m.def("print_myobject2_2", &print_myobject2_2); 17111986Sandreas.sandberg@arm.com m.def("print_myobject2_3", &print_myobject2_3); 17211986Sandreas.sandberg@arm.com m.def("print_myobject2_4", &print_myobject2_4); 17311986Sandreas.sandberg@arm.com 17411986Sandreas.sandberg@arm.com py::class_<MyObject3, std::shared_ptr<MyObject3>>(m, "MyObject3") 17511986Sandreas.sandberg@arm.com .def(py::init<int>()); 17611986Sandreas.sandberg@arm.com m.def("make_myobject3_1", &make_myobject3_1); 17711986Sandreas.sandberg@arm.com m.def("make_myobject3_2", &make_myobject3_2); 17811986Sandreas.sandberg@arm.com m.def("print_myobject3_1", &print_myobject3_1); 17911986Sandreas.sandberg@arm.com m.def("print_myobject3_2", &print_myobject3_2); 18011986Sandreas.sandberg@arm.com m.def("print_myobject3_3", &print_myobject3_3); 18111986Sandreas.sandberg@arm.com m.def("print_myobject3_4", &print_myobject3_4); 18211986Sandreas.sandberg@arm.com 18311986Sandreas.sandberg@arm.com py::class_<MyObject4, std::unique_ptr<MyObject4, py::nodelete>>(m, "MyObject4") 18411986Sandreas.sandberg@arm.com .def(py::init<int>()) 18511986Sandreas.sandberg@arm.com .def_readwrite("value", &MyObject4::value); 18611986Sandreas.sandberg@arm.com 18711986Sandreas.sandberg@arm.com py::implicitly_convertible<py::int_, MyObject1>(); 18811986Sandreas.sandberg@arm.com 18911986Sandreas.sandberg@arm.com // Expose constructor stats for the ref type 19011986Sandreas.sandberg@arm.com m.def("cstats_ref", &ConstructorStats::get<ref_tag>); 19111986Sandreas.sandberg@arm.com}); 19211986Sandreas.sandberg@arm.com 19311986Sandreas.sandberg@arm.comstruct SharedPtrRef { 19411986Sandreas.sandberg@arm.com struct A { 19511986Sandreas.sandberg@arm.com A() { print_created(this); } 19611986Sandreas.sandberg@arm.com A(const A &) { print_copy_created(this); } 19711986Sandreas.sandberg@arm.com A(A &&) { print_move_created(this); } 19811986Sandreas.sandberg@arm.com ~A() { print_destroyed(this); } 19911986Sandreas.sandberg@arm.com }; 20011986Sandreas.sandberg@arm.com 20111986Sandreas.sandberg@arm.com A value = {}; 20211986Sandreas.sandberg@arm.com std::shared_ptr<A> shared = std::make_shared<A>(); 20311986Sandreas.sandberg@arm.com}; 20411986Sandreas.sandberg@arm.com 20511986Sandreas.sandberg@arm.comstruct SharedFromThisRef { 20611986Sandreas.sandberg@arm.com struct B : std::enable_shared_from_this<B> { 20711986Sandreas.sandberg@arm.com B() { print_created(this); } 20811986Sandreas.sandberg@arm.com B(const B &) : std::enable_shared_from_this<B>() { print_copy_created(this); } 20911986Sandreas.sandberg@arm.com B(B &&) : std::enable_shared_from_this<B>() { print_move_created(this); } 21011986Sandreas.sandberg@arm.com ~B() { print_destroyed(this); } 21111986Sandreas.sandberg@arm.com }; 21211986Sandreas.sandberg@arm.com 21311986Sandreas.sandberg@arm.com B value = {}; 21411986Sandreas.sandberg@arm.com std::shared_ptr<B> shared = std::make_shared<B>(); 21511986Sandreas.sandberg@arm.com}; 21611986Sandreas.sandberg@arm.com 21712037Sandreas.sandberg@arm.comtemplate <typename T> 21812037Sandreas.sandberg@arm.comclass CustomUniquePtr { 21912037Sandreas.sandberg@arm.com std::unique_ptr<T> impl; 22012037Sandreas.sandberg@arm.com 22112037Sandreas.sandberg@arm.compublic: 22212037Sandreas.sandberg@arm.com CustomUniquePtr(T* p) : impl(p) { } 22312037Sandreas.sandberg@arm.com T* get() const { return impl.get(); } 22412037Sandreas.sandberg@arm.com T* release_ptr() { return impl.release(); } 22512037Sandreas.sandberg@arm.com}; 22612037Sandreas.sandberg@arm.com 22712037Sandreas.sandberg@arm.comPYBIND11_DECLARE_HOLDER_TYPE(T, CustomUniquePtr<T>); 22812037Sandreas.sandberg@arm.com 22911986Sandreas.sandberg@arm.comtest_initializer smart_ptr_and_references([](py::module &pm) { 23011986Sandreas.sandberg@arm.com auto m = pm.def_submodule("smart_ptr"); 23111986Sandreas.sandberg@arm.com 23211986Sandreas.sandberg@arm.com using A = SharedPtrRef::A; 23311986Sandreas.sandberg@arm.com py::class_<A, std::shared_ptr<A>>(m, "A"); 23411986Sandreas.sandberg@arm.com 23511986Sandreas.sandberg@arm.com py::class_<SharedPtrRef>(m, "SharedPtrRef") 23611986Sandreas.sandberg@arm.com .def(py::init<>()) 23711986Sandreas.sandberg@arm.com .def_readonly("ref", &SharedPtrRef::value) 23811986Sandreas.sandberg@arm.com .def_property_readonly("copy", [](const SharedPtrRef &s) { return s.value; }, 23911986Sandreas.sandberg@arm.com py::return_value_policy::copy) 24011986Sandreas.sandberg@arm.com .def_readonly("holder_ref", &SharedPtrRef::shared) 24111986Sandreas.sandberg@arm.com .def_property_readonly("holder_copy", [](const SharedPtrRef &s) { return s.shared; }, 24211986Sandreas.sandberg@arm.com py::return_value_policy::copy) 24311986Sandreas.sandberg@arm.com .def("set_ref", [](SharedPtrRef &, const A &) { return true; }) 24411986Sandreas.sandberg@arm.com .def("set_holder", [](SharedPtrRef &, std::shared_ptr<A>) { return true; }); 24511986Sandreas.sandberg@arm.com 24611986Sandreas.sandberg@arm.com using B = SharedFromThisRef::B; 24711986Sandreas.sandberg@arm.com py::class_<B, std::shared_ptr<B>>(m, "B"); 24811986Sandreas.sandberg@arm.com 24911986Sandreas.sandberg@arm.com py::class_<SharedFromThisRef>(m, "SharedFromThisRef") 25011986Sandreas.sandberg@arm.com .def(py::init<>()) 25111986Sandreas.sandberg@arm.com .def_readonly("bad_wp", &SharedFromThisRef::value) 25211986Sandreas.sandberg@arm.com .def_property_readonly("ref", [](const SharedFromThisRef &s) -> const B & { return *s.shared; }) 25311986Sandreas.sandberg@arm.com .def_property_readonly("copy", [](const SharedFromThisRef &s) { return s.value; }, 25411986Sandreas.sandberg@arm.com py::return_value_policy::copy) 25511986Sandreas.sandberg@arm.com .def_readonly("holder_ref", &SharedFromThisRef::shared) 25611986Sandreas.sandberg@arm.com .def_property_readonly("holder_copy", [](const SharedFromThisRef &s) { return s.shared; }, 25711986Sandreas.sandberg@arm.com py::return_value_policy::copy) 25811986Sandreas.sandberg@arm.com .def("set_ref", [](SharedFromThisRef &, const B &) { return true; }) 25911986Sandreas.sandberg@arm.com .def("set_holder", [](SharedFromThisRef &, std::shared_ptr<B>) { return true; }); 26012037Sandreas.sandberg@arm.com 26112037Sandreas.sandberg@arm.com struct C { 26212037Sandreas.sandberg@arm.com C() { print_created(this); } 26312037Sandreas.sandberg@arm.com ~C() { print_destroyed(this); } 26412037Sandreas.sandberg@arm.com }; 26512037Sandreas.sandberg@arm.com 26612037Sandreas.sandberg@arm.com py::class_<C, CustomUniquePtr<C>>(m, "TypeWithMoveOnlyHolder") 26712037Sandreas.sandberg@arm.com .def_static("make", []() { return CustomUniquePtr<C>(new C); }); 26812037Sandreas.sandberg@arm.com 26912037Sandreas.sandberg@arm.com struct HeldByDefaultHolder { }; 27012037Sandreas.sandberg@arm.com 27112037Sandreas.sandberg@arm.com py::class_<HeldByDefaultHolder>(m, "HeldByDefaultHolder") 27212037Sandreas.sandberg@arm.com .def(py::init<>()) 27312037Sandreas.sandberg@arm.com .def_static("load_shared_ptr", [](std::shared_ptr<HeldByDefaultHolder>) {}); 27411986Sandreas.sandberg@arm.com}); 275