pybind11/tests/test_class_sh_property.cpp
Ralf W. Grosse-Kunstleve 48f25275c4
[smart_holder] Bake smart_holder functionality into class_ and type_caster_base (#5257)
* Put bakein branch @ 18b72c0ffa on top of smart_holder branch:

Commands used:

```
git checkout bakein
git diff smart_holder > ~/zd
git checkout smart_holder
git checkout -b bakein_sh
patch -p 1 < ~/zd
git checkout smart_holder \
MANIFEST.in \
README.rst \
README_smart_holder.rst \
docs/advanced/smart_ptrs.rst \
ubench/holder_comparison.cpp \
ubench/holder_comparison.py \
ubench/holder_comparison_extract_sheet_data.py \
ubench/number_bucket.h \
ubench/python/number_bucket.clif
git add -A
```

* Add back README_smart_holder.rst in tests/extra_python_package/test_files.py

* Restore smart_holder_poc.h as-is on smart_holder branch (i.e. undo `PYBIND11_SMART_HOLDER_PADDING`, which was meant for stress-testing only).

* Insert `std::move()` as suggested by @laramiel

* `property_cpp_function_sh_*` named specializations, as suggested by @laramiel (https://github.com/pybind/pybind11/pull/5257#discussion_r1688346807)

* Call `property_cpp_function_classic` member functions, rather than inlining the implementations.

* Use `PYBIND11_HAVE_INTERNALS_WITH_SMART_HOLDER_SUPPORT` in holder_comparison.cpp (holder_comparison.py is NOT changed accordingly in this commit, i.e. can still only be run if the smart_holder functionality is available).

* Systematically rename `loaded_as` to `load_as` (`shared_ptr`, `unique_ptr`) as suggested by @laramiel

* Make change as suggested by @laramiel. This makes it much more obvious that the latest implementation of `smart_holder_from_unique_ptr()` accepts all existing `return_value_policy` enum values except `copy`.

* Resolve `BAKEIN_WIP: Rewrite comment.` for `property_cpp_function_*` specializations.

* Resolve `BAKEIN_WIP: Add comment to explain: This is meant for stress-testing only.`

* Resolve all remaining BAKEIN_WIP (in pybind11/cast.h).

Leave only two pairs of SMART_HOLDER_BAKEIN_FOLLOW_ON comments: refactoring of copyable_holder_caster, move_only_holder_caster. This is best left until after the smart_holder branch is merged into the master branch.

* Remove obsolete `using holder_type = smart_holder;` in `load_helper`

* Add SMART_HOLDER_BAKEIN_FOLLOW_ON comment for `internals::default_holder`

* README_smart_holder.rst update (line count reduced from 356 to 123).
2024-07-31 06:17:31 -07:00

114 lines
4.0 KiB
C++

// The compact 4-character naming matches that in test_class_sh_basic.cpp
// Variable names are intentionally terse, to not distract from the more important C++ type names:
// valu(e), ref(erence), ptr or p (pointer), r = rvalue, m = mutable, c = const,
// sh = shared_ptr, uq = unique_ptr.
#include "pybind11/smart_holder.h"
#include "pybind11_tests.h"
#include <memory>
namespace test_class_sh_property {
struct ClassicField {
int num = -88;
};
struct ClassicOuter {
ClassicField *m_mptr = nullptr;
const ClassicField *m_cptr = nullptr;
};
struct Field {
int num = -99;
};
struct Outer {
Field m_valu;
Field *m_mptr = nullptr;
const Field *m_cptr = nullptr;
std::unique_ptr<Field> m_uqmp;
std::unique_ptr<const Field> m_uqcp;
std::shared_ptr<Field> m_shmp;
std::shared_ptr<const Field> m_shcp;
};
inline void DisownOuter(std::unique_ptr<Outer>) {}
struct WithCharArrayMember {
WithCharArrayMember() { std::memcpy(char6_member, "Char6", 6); }
char char6_member[6];
};
struct WithConstCharPtrMember {
const char *const_char_ptr_member = "ConstChar*";
};
} // namespace test_class_sh_property
PYBIND11_TYPE_CASTER_BASE_HOLDER(test_class_sh_property::ClassicField,
std::unique_ptr<test_class_sh_property::ClassicField>)
PYBIND11_TYPE_CASTER_BASE_HOLDER(test_class_sh_property::ClassicOuter,
std::unique_ptr<test_class_sh_property::ClassicOuter>)
PYBIND11_SMART_HOLDER_TYPE_CASTERS(test_class_sh_property::Field)
PYBIND11_SMART_HOLDER_TYPE_CASTERS(test_class_sh_property::Outer)
PYBIND11_SMART_HOLDER_TYPE_CASTERS(test_class_sh_property::WithCharArrayMember)
PYBIND11_SMART_HOLDER_TYPE_CASTERS(test_class_sh_property::WithConstCharPtrMember)
TEST_SUBMODULE(class_sh_property, m) {
m.attr("defined_PYBIND11_HAVE_INTERNALS_WITH_SMART_HOLDER_SUPPORT") =
#ifndef PYBIND11_HAVE_INTERNALS_WITH_SMART_HOLDER_SUPPORT
false;
#else
true;
using namespace test_class_sh_property;
py::class_<ClassicField, std::unique_ptr<ClassicField>>(m, "ClassicField")
.def(py::init<>())
.def_readwrite("num", &ClassicField::num);
py::class_<ClassicOuter, std::unique_ptr<ClassicOuter>>(m, "ClassicOuter")
.def(py::init<>())
.def_readonly("m_mptr_readonly", &ClassicOuter::m_mptr)
.def_readwrite("m_mptr_readwrite", &ClassicOuter::m_mptr)
.def_readwrite("m_cptr_readonly", &ClassicOuter::m_cptr)
.def_readwrite("m_cptr_readwrite", &ClassicOuter::m_cptr);
py::classh<Field>(m, "Field").def(py::init<>()).def_readwrite("num", &Field::num);
py::classh<Outer>(m, "Outer")
.def(py::init<>())
.def_readonly("m_valu_readonly", &Outer::m_valu)
.def_readwrite("m_valu_readwrite", &Outer::m_valu)
.def_readonly("m_mptr_readonly", &Outer::m_mptr)
.def_readwrite("m_mptr_readwrite", &Outer::m_mptr)
.def_readonly("m_cptr_readonly", &Outer::m_cptr)
.def_readwrite("m_cptr_readwrite", &Outer::m_cptr)
// .def_readonly("m_uqmp_readonly", &Outer::m_uqmp) // Custom compilation Error.
.def_readwrite("m_uqmp_readwrite", &Outer::m_uqmp)
// .def_readonly("m_uqcp_readonly", &Outer::m_uqcp) // Custom compilation Error.
.def_readwrite("m_uqcp_readwrite", &Outer::m_uqcp)
.def_readwrite("m_shmp_readonly", &Outer::m_shmp)
.def_readwrite("m_shmp_readwrite", &Outer::m_shmp)
.def_readwrite("m_shcp_readonly", &Outer::m_shcp)
.def_readwrite("m_shcp_readwrite", &Outer::m_shcp);
m.def("DisownOuter", DisownOuter);
py::classh<WithCharArrayMember>(m, "WithCharArrayMember")
.def(py::init<>())
.def_readonly("char6_member", &WithCharArrayMember::char6_member);
py::classh<WithConstCharPtrMember>(m, "WithConstCharPtrMember")
.def(py::init<>())
.def_readonly("const_char_ptr_member", &WithConstCharPtrMember::const_char_ptr_member);
#endif // PYBIND11_HAVE_INTERNALS_WITH_SMART_HOLDER_SUPPORT
}