Zengtudor/pybind11
1
0
Fork 0
mirror of https://github.com/pybind/pybind11.git synced 2024-12-01 17:37:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Systematically add PYBIND11_TESTS_PURE_CPP_SMART_HOLDER_POC_TEST_CPP to mark code that is not used from production code. Add comment to explain.

Browse Source
This commit is contained in:
Ralf W. Grosse-Kunstleve 2023-11-01 14:40:14 -07:00
parent 4d9d722215
commit 7669a5bea8
1 changed files with 18 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
include/pybind11/detail/smart_holder_poc.h
View File

@ -44,6 +44,16 @@ Details:
* The `void_cast_raw_ptr` option is needed to make the `smart_holder` `vptr` * The `void_cast_raw_ptr` option is needed to make the `smart_holder` `vptr`
member invisible to the `shared_from_this` mechanism, in case the lifetime member invisible to the `shared_from_this` mechanism, in case the lifetime
of a `PyObject` is tied to the pointee. of a `PyObject` is tied to the pointee.
* Regarding `PYBIND11_TESTS_PURE_CPP_SMART_HOLDER_POC_TEST_CPP` below:
This define serves as a marker for code that is NOT used
from smart_holder_type_casters.h, but is exercised only from
tests/pure_cpp/smart_holder_poc_test.cpp. The marked code was useful
mainly for bootstrapping the smart_holder work. At this stage, with
smart_holder_type_casters.h in production use (at Google) since around
February 2021, it could be moved from here to tests/pure_cpp/ (help welcome).
It will probably be best in most cases to add tests for new functionality
under test/test_class_sh_*.
*/ */
#pragma once #pragma once
@ -246,6 +256,7 @@ struct smart_holder {
return static_cast<T *>(vptr.get()); return static_cast<T *>(vptr.get());
} }
#ifdef PYBIND11_TESTS_PURE_CPP_SMART_HOLDER_POC_TEST_CPP // See comment near top.
template <typename T> template <typename T>
T &as_lvalue_ref() const { T &as_lvalue_ref() const {
static const char *context = "as_lvalue_ref"; static const char *context = "as_lvalue_ref";
@ -253,7 +264,9 @@ struct smart_holder {
ensure_has_pointee(context); ensure_has_pointee(context);
return *as_raw_ptr_unowned<T>(); return *as_raw_ptr_unowned<T>();
} }
#endif
#ifdef PYBIND11_TESTS_PURE_CPP_SMART_HOLDER_POC_TEST_CPP // See comment near top.
template <typename T> template <typename T>
T &&as_rvalue_ref() const { T &&as_rvalue_ref() const {
static const char *context = "as_rvalue_ref"; static const char *context = "as_rvalue_ref";
@ -261,6 +274,7 @@ struct smart_holder {
ensure_has_pointee(context); ensure_has_pointee(context);
return std::move(*as_raw_ptr_unowned<T>()); return std::move(*as_raw_ptr_unowned<T>());
} }
#endif
template <typename T> template <typename T>
static smart_holder from_raw_ptr_take_ownership(T *raw_ptr, bool void_cast_raw_ptr = false) { static smart_holder from_raw_ptr_take_ownership(T *raw_ptr, bool void_cast_raw_ptr = false) {
@ -305,6 +319,7 @@ struct smart_holder {
release_disowned(); release_disowned();
} }
#ifdef PYBIND11_TESTS_PURE_CPP_SMART_HOLDER_POC_TEST_CPP // See comment near top.
template <typename T> template <typename T>
T *as_raw_ptr_release_ownership(const char *context = "as_raw_ptr_release_ownership") { T *as_raw_ptr_release_ownership(const char *context = "as_raw_ptr_release_ownership") {
ensure_can_release_ownership(context); ensure_can_release_ownership(context);
@ -312,6 +327,7 @@ struct smart_holder {
release_ownership(); release_ownership();
return raw_ptr; return raw_ptr;
} }
#endif
template <typename T, typename D> template <typename T, typename D>
static smart_holder from_unique_ptr(std::unique_ptr<T, D> &&unq_ptr, static smart_holder from_unique_ptr(std::unique_ptr<T, D> &&unq_ptr,
@ -335,7 +351,7 @@ struct smart_holder {
return hld; return hld;
} }
#ifdef PYBIND11_TESTS_PURE_CPP_SMART_HOLDER_POC_TEST_CPP #ifdef PYBIND11_TESTS_PURE_CPP_SMART_HOLDER_POC_TEST_CPP // See comment near top.
template <typename T, typename D = std::default_delete<T>> template <typename T, typename D = std::default_delete<T>>
std::unique_ptr<T, D> as_unique_ptr() { std::unique_ptr<T, D> as_unique_ptr() {
static const char *context = "as_unique_ptr"; static const char *context = "as_unique_ptr";
@ -343,6 +359,7 @@ struct smart_holder {
ensure_use_count_1(context); ensure_use_count_1(context);
T *raw_ptr = as_raw_ptr_unowned<T>(); T *raw_ptr = as_raw_ptr_unowned<T>();
release_ownership(); release_ownership();
// KNOWN DEFECT (see PR #4850): Does not copy the deleter.
return std::unique_ptr<T, D>(raw_ptr); return std::unique_ptr<T, D>(raw_ptr);
} }
#endif #endif