111986Sandreas.sandberg@arm.com/* 211986Sandreas.sandberg@arm.com tests/test_multiple_inheritance.cpp -- multiple inheritance, 311986Sandreas.sandberg@arm.com implicit MI casts 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" 1212391Sjason@lowepower.com#include "constructor_stats.h" 1311986Sandreas.sandberg@arm.com 1412391Sjason@lowepower.com// Many bases for testing that multiple inheritance from many classes (i.e. requiring extra 1512391Sjason@lowepower.com// space for holder constructed flags) works. 1612391Sjason@lowepower.comtemplate <int N> struct BaseN { 1712391Sjason@lowepower.com BaseN(int i) : i(i) { } 1811986Sandreas.sandberg@arm.com int i; 1911986Sandreas.sandberg@arm.com}; 2011986Sandreas.sandberg@arm.com 2112391Sjason@lowepower.com// test_mi_static_properties 2212391Sjason@lowepower.comstruct Vanilla { 2312391Sjason@lowepower.com std::string vanilla() { return "Vanilla"; }; 2411986Sandreas.sandberg@arm.com}; 2512391Sjason@lowepower.comstruct WithStatic1 { 2612391Sjason@lowepower.com static std::string static_func1() { return "WithStatic1"; }; 2712391Sjason@lowepower.com static int static_value1; 2812391Sjason@lowepower.com}; 2912391Sjason@lowepower.comstruct WithStatic2 { 3012391Sjason@lowepower.com static std::string static_func2() { return "WithStatic2"; }; 3112391Sjason@lowepower.com static int static_value2; 3212391Sjason@lowepower.com}; 3312391Sjason@lowepower.comstruct VanillaStaticMix1 : Vanilla, WithStatic1, WithStatic2 { 3412391Sjason@lowepower.com static std::string static_func() { return "VanillaStaticMix1"; } 3512391Sjason@lowepower.com static int static_value; 3612391Sjason@lowepower.com}; 3712391Sjason@lowepower.comstruct VanillaStaticMix2 : WithStatic1, Vanilla, WithStatic2 { 3812391Sjason@lowepower.com static std::string static_func() { return "VanillaStaticMix2"; } 3912391Sjason@lowepower.com static int static_value; 4012391Sjason@lowepower.com}; 4112391Sjason@lowepower.comint WithStatic1::static_value1 = 1; 4212391Sjason@lowepower.comint WithStatic2::static_value2 = 2; 4312391Sjason@lowepower.comint VanillaStaticMix1::static_value = 12; 4412391Sjason@lowepower.comint VanillaStaticMix2::static_value = 12; 4511986Sandreas.sandberg@arm.com 4612391Sjason@lowepower.comTEST_SUBMODULE(multiple_inheritance, m) { 4711986Sandreas.sandberg@arm.com 4812391Sjason@lowepower.com // test_multiple_inheritance_mix1 4912391Sjason@lowepower.com // test_multiple_inheritance_mix2 5012391Sjason@lowepower.com struct Base1 { 5112391Sjason@lowepower.com Base1(int i) : i(i) { } 5212391Sjason@lowepower.com int foo() { return i; } 5312391Sjason@lowepower.com int i; 5412391Sjason@lowepower.com }; 5512037Sandreas.sandberg@arm.com py::class_<Base1> b1(m, "Base1"); 5612037Sandreas.sandberg@arm.com b1.def(py::init<int>()) 5712037Sandreas.sandberg@arm.com .def("foo", &Base1::foo); 5811986Sandreas.sandberg@arm.com 5912391Sjason@lowepower.com struct Base2 { 6012391Sjason@lowepower.com Base2(int i) : i(i) { } 6112391Sjason@lowepower.com int bar() { return i; } 6212391Sjason@lowepower.com int i; 6312391Sjason@lowepower.com }; 6412037Sandreas.sandberg@arm.com py::class_<Base2> b2(m, "Base2"); 6512037Sandreas.sandberg@arm.com b2.def(py::init<int>()) 6612037Sandreas.sandberg@arm.com .def("bar", &Base2::bar); 6711986Sandreas.sandberg@arm.com 6812391Sjason@lowepower.com 6912391Sjason@lowepower.com // test_multiple_inheritance_cpp 7012391Sjason@lowepower.com struct Base12 : Base1, Base2 { 7112391Sjason@lowepower.com Base12(int i, int j) : Base1(i), Base2(j) { } 7212391Sjason@lowepower.com }; 7312391Sjason@lowepower.com struct MIType : Base12 { 7412391Sjason@lowepower.com MIType(int i, int j) : Base12(i, j) { } 7512391Sjason@lowepower.com }; 7611986Sandreas.sandberg@arm.com py::class_<Base12, Base1, Base2>(m, "Base12"); 7711986Sandreas.sandberg@arm.com py::class_<MIType, Base12>(m, "MIType") 7811986Sandreas.sandberg@arm.com .def(py::init<int, int>()); 7912037Sandreas.sandberg@arm.com 8012391Sjason@lowepower.com 8112391Sjason@lowepower.com // test_multiple_inheritance_python_many_bases 8212391Sjason@lowepower.com #define PYBIND11_BASEN(N) py::class_<BaseN<N>>(m, "BaseN" #N).def(py::init<int>()).def("f" #N, [](BaseN<N> &b) { return b.i + N; }) 8312391Sjason@lowepower.com PYBIND11_BASEN( 1); PYBIND11_BASEN( 2); PYBIND11_BASEN( 3); PYBIND11_BASEN( 4); 8412391Sjason@lowepower.com PYBIND11_BASEN( 5); PYBIND11_BASEN( 6); PYBIND11_BASEN( 7); PYBIND11_BASEN( 8); 8512391Sjason@lowepower.com PYBIND11_BASEN( 9); PYBIND11_BASEN(10); PYBIND11_BASEN(11); PYBIND11_BASEN(12); 8612391Sjason@lowepower.com PYBIND11_BASEN(13); PYBIND11_BASEN(14); PYBIND11_BASEN(15); PYBIND11_BASEN(16); 8712391Sjason@lowepower.com PYBIND11_BASEN(17); 8812391Sjason@lowepower.com 8912037Sandreas.sandberg@arm.com // Uncommenting this should result in a compile time failure (MI can only be specified via 9012037Sandreas.sandberg@arm.com // template parameters because pybind has to know the types involved; see discussion in #742 for 9112037Sandreas.sandberg@arm.com // details). 9212037Sandreas.sandberg@arm.com// struct Base12v2 : Base1, Base2 { 9312037Sandreas.sandberg@arm.com// Base12v2(int i, int j) : Base1(i), Base2(j) { } 9412037Sandreas.sandberg@arm.com// }; 9512037Sandreas.sandberg@arm.com// py::class_<Base12v2>(m, "Base12v2", b1, b2) 9612037Sandreas.sandberg@arm.com// .def(py::init<int, int>()); 9711986Sandreas.sandberg@arm.com 9811986Sandreas.sandberg@arm.com 9912391Sjason@lowepower.com // test_multiple_inheritance_virtbase 10012391Sjason@lowepower.com // Test the case where not all base classes are specified, and where pybind11 requires the 10112391Sjason@lowepower.com // py::multiple_inheritance flag to perform proper casting between types. 10212391Sjason@lowepower.com struct Base1a { 10312391Sjason@lowepower.com Base1a(int i) : i(i) { } 10412391Sjason@lowepower.com int foo() { return i; } 10512391Sjason@lowepower.com int i; 10612391Sjason@lowepower.com }; 10711986Sandreas.sandberg@arm.com py::class_<Base1a, std::shared_ptr<Base1a>>(m, "Base1a") 10811986Sandreas.sandberg@arm.com .def(py::init<int>()) 10911986Sandreas.sandberg@arm.com .def("foo", &Base1a::foo); 11011986Sandreas.sandberg@arm.com 11112391Sjason@lowepower.com struct Base2a { 11212391Sjason@lowepower.com Base2a(int i) : i(i) { } 11312391Sjason@lowepower.com int bar() { return i; } 11412391Sjason@lowepower.com int i; 11512391Sjason@lowepower.com }; 11611986Sandreas.sandberg@arm.com py::class_<Base2a, std::shared_ptr<Base2a>>(m, "Base2a") 11711986Sandreas.sandberg@arm.com .def(py::init<int>()) 11811986Sandreas.sandberg@arm.com .def("bar", &Base2a::bar); 11911986Sandreas.sandberg@arm.com 12012391Sjason@lowepower.com struct Base12a : Base1a, Base2a { 12112391Sjason@lowepower.com Base12a(int i, int j) : Base1a(i), Base2a(j) { } 12212391Sjason@lowepower.com }; 12311986Sandreas.sandberg@arm.com py::class_<Base12a, /* Base1 missing */ Base2a, 12411986Sandreas.sandberg@arm.com std::shared_ptr<Base12a>>(m, "Base12a", py::multiple_inheritance()) 12511986Sandreas.sandberg@arm.com .def(py::init<int, int>()); 12611986Sandreas.sandberg@arm.com 12711986Sandreas.sandberg@arm.com m.def("bar_base2a", [](Base2a *b) { return b->bar(); }); 12811986Sandreas.sandberg@arm.com m.def("bar_base2a_sharedptr", [](std::shared_ptr<Base2a> b) { return b->bar(); }); 12912037Sandreas.sandberg@arm.com 13012391Sjason@lowepower.com // test_mi_unaligned_base 13112391Sjason@lowepower.com // test_mi_base_return 13212391Sjason@lowepower.com // Issue #801: invalid casting to derived type with MI bases 13314299Sbbruce@ucdavis.edu struct I801B1 { int a = 1; I801B1() = default; I801B1(const I801B1 &) = default; virtual ~I801B1() = default; }; 13414299Sbbruce@ucdavis.edu struct I801B2 { int b = 2; I801B2() = default; I801B2(const I801B2 &) = default; virtual ~I801B2() = default; }; 13512391Sjason@lowepower.com struct I801C : I801B1, I801B2 {}; 13612391Sjason@lowepower.com struct I801D : I801C {}; // Indirect MI 13712391Sjason@lowepower.com // Unregistered classes: 13812391Sjason@lowepower.com struct I801B3 { int c = 3; virtual ~I801B3() = default; }; 13912391Sjason@lowepower.com struct I801E : I801B3, I801D {}; 14012037Sandreas.sandberg@arm.com 14112391Sjason@lowepower.com py::class_<I801B1, std::shared_ptr<I801B1>>(m, "I801B1").def(py::init<>()).def_readonly("a", &I801B1::a); 14212391Sjason@lowepower.com py::class_<I801B2, std::shared_ptr<I801B2>>(m, "I801B2").def(py::init<>()).def_readonly("b", &I801B2::b); 14312391Sjason@lowepower.com py::class_<I801C, I801B1, I801B2, std::shared_ptr<I801C>>(m, "I801C").def(py::init<>()); 14412391Sjason@lowepower.com py::class_<I801D, I801C, std::shared_ptr<I801D>>(m, "I801D").def(py::init<>()); 14512037Sandreas.sandberg@arm.com 14612391Sjason@lowepower.com // Two separate issues here: first, we want to recognize a pointer to a base type as being a 14712391Sjason@lowepower.com // known instance even when the pointer value is unequal (i.e. due to a non-first 14812391Sjason@lowepower.com // multiple-inheritance base class): 14912391Sjason@lowepower.com m.def("i801b1_c", [](I801C *c) { return static_cast<I801B1 *>(c); }); 15012391Sjason@lowepower.com m.def("i801b2_c", [](I801C *c) { return static_cast<I801B2 *>(c); }); 15112391Sjason@lowepower.com m.def("i801b1_d", [](I801D *d) { return static_cast<I801B1 *>(d); }); 15212391Sjason@lowepower.com m.def("i801b2_d", [](I801D *d) { return static_cast<I801B2 *>(d); }); 15312037Sandreas.sandberg@arm.com 15412391Sjason@lowepower.com // Second, when returned a base class pointer to a derived instance, we cannot assume that the 15512391Sjason@lowepower.com // pointer is `reinterpret_cast`able to the derived pointer because, like above, the base class 15612391Sjason@lowepower.com // pointer could be offset. 15712391Sjason@lowepower.com m.def("i801c_b1", []() -> I801B1 * { return new I801C(); }); 15812391Sjason@lowepower.com m.def("i801c_b2", []() -> I801B2 * { return new I801C(); }); 15912391Sjason@lowepower.com m.def("i801d_b1", []() -> I801B1 * { return new I801D(); }); 16012391Sjason@lowepower.com m.def("i801d_b2", []() -> I801B2 * { return new I801D(); }); 16112037Sandreas.sandberg@arm.com 16212391Sjason@lowepower.com // Return a base class pointer to a pybind-registered type when the actual derived type 16312391Sjason@lowepower.com // isn't pybind-registered (and uses multiple-inheritance to offset the pybind base) 16412391Sjason@lowepower.com m.def("i801e_c", []() -> I801C * { return new I801E(); }); 16512391Sjason@lowepower.com m.def("i801e_b2", []() -> I801B2 * { return new I801E(); }); 16612037Sandreas.sandberg@arm.com 16712037Sandreas.sandberg@arm.com 16812391Sjason@lowepower.com // test_mi_static_properties 16912037Sandreas.sandberg@arm.com py::class_<Vanilla>(m, "Vanilla") 17012037Sandreas.sandberg@arm.com .def(py::init<>()) 17112037Sandreas.sandberg@arm.com .def("vanilla", &Vanilla::vanilla); 17212037Sandreas.sandberg@arm.com 17312037Sandreas.sandberg@arm.com py::class_<WithStatic1>(m, "WithStatic1") 17412037Sandreas.sandberg@arm.com .def(py::init<>()) 17512037Sandreas.sandberg@arm.com .def_static("static_func1", &WithStatic1::static_func1) 17612037Sandreas.sandberg@arm.com .def_readwrite_static("static_value1", &WithStatic1::static_value1); 17712037Sandreas.sandberg@arm.com 17812037Sandreas.sandberg@arm.com py::class_<WithStatic2>(m, "WithStatic2") 17912037Sandreas.sandberg@arm.com .def(py::init<>()) 18012037Sandreas.sandberg@arm.com .def_static("static_func2", &WithStatic2::static_func2) 18112037Sandreas.sandberg@arm.com .def_readwrite_static("static_value2", &WithStatic2::static_value2); 18212037Sandreas.sandberg@arm.com 18312037Sandreas.sandberg@arm.com py::class_<VanillaStaticMix1, Vanilla, WithStatic1, WithStatic2>( 18412037Sandreas.sandberg@arm.com m, "VanillaStaticMix1") 18512037Sandreas.sandberg@arm.com .def(py::init<>()) 18612037Sandreas.sandberg@arm.com .def_static("static_func", &VanillaStaticMix1::static_func) 18712037Sandreas.sandberg@arm.com .def_readwrite_static("static_value", &VanillaStaticMix1::static_value); 18812037Sandreas.sandberg@arm.com 18912037Sandreas.sandberg@arm.com py::class_<VanillaStaticMix2, WithStatic1, Vanilla, WithStatic2>( 19012037Sandreas.sandberg@arm.com m, "VanillaStaticMix2") 19112037Sandreas.sandberg@arm.com .def(py::init<>()) 19212037Sandreas.sandberg@arm.com .def_static("static_func", &VanillaStaticMix2::static_func) 19312037Sandreas.sandberg@arm.com .def_readwrite_static("static_value", &VanillaStaticMix2::static_value); 19412037Sandreas.sandberg@arm.com 19512391Sjason@lowepower.com 19612037Sandreas.sandberg@arm.com#if !defined(PYPY_VERSION) 19712391Sjason@lowepower.com struct WithDict { }; 19812391Sjason@lowepower.com struct VanillaDictMix1 : Vanilla, WithDict { }; 19912391Sjason@lowepower.com struct VanillaDictMix2 : WithDict, Vanilla { }; 20012037Sandreas.sandberg@arm.com py::class_<WithDict>(m, "WithDict", py::dynamic_attr()).def(py::init<>()); 20112037Sandreas.sandberg@arm.com py::class_<VanillaDictMix1, Vanilla, WithDict>(m, "VanillaDictMix1").def(py::init<>()); 20212037Sandreas.sandberg@arm.com py::class_<VanillaDictMix2, WithDict, Vanilla>(m, "VanillaDictMix2").def(py::init<>()); 20312037Sandreas.sandberg@arm.com#endif 20412391Sjason@lowepower.com 20512391Sjason@lowepower.com // test_diamond_inheritance 20612391Sjason@lowepower.com // Issue #959: segfault when constructing diamond inheritance instance 20712391Sjason@lowepower.com // All of these have int members so that there will be various unequal pointers involved. 20814299Sbbruce@ucdavis.edu struct B { int b; B() = default; B(const B&) = default; virtual ~B() = default; }; 20912391Sjason@lowepower.com struct C0 : public virtual B { int c0; }; 21012391Sjason@lowepower.com struct C1 : public virtual B { int c1; }; 21112391Sjason@lowepower.com struct D : public C0, public C1 { int d; }; 21212391Sjason@lowepower.com py::class_<B>(m, "B") 21312391Sjason@lowepower.com .def("b", [](B *self) { return self; }); 21412391Sjason@lowepower.com py::class_<C0, B>(m, "C0") 21512391Sjason@lowepower.com .def("c0", [](C0 *self) { return self; }); 21612391Sjason@lowepower.com py::class_<C1, B>(m, "C1") 21712391Sjason@lowepower.com .def("c1", [](C1 *self) { return self; }); 21812391Sjason@lowepower.com py::class_<D, C0, C1>(m, "D") 21912391Sjason@lowepower.com .def(py::init<>()); 22012391Sjason@lowepower.com} 221