fix: bind noexcept and ref-qualified methods from unregistered base classes #5992
+1,013
−21
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -370,6 +370,96 @@ class cpp_function : public function { | |
| extra...); | ||
| } | ||
|
|
||
| /// Construct a cpp_function from a class method (non-const, rvalue ref-qualifier) | ||
| template <typename Return, typename Class, typename... Arg, typename... Extra> | ||
| // NOLINTNEXTLINE(google-explicit-constructor) | ||
| cpp_function(Return (Class::*f)(Arg...) &&, const Extra &...extra) { | ||
| initialize( | ||
| [f](Class *c, Arg... args) -> Return { | ||
| return (std::move(*c).*f)(std::forward<Arg>(args)...); | ||
| }, | ||
| (Return (*)(Class *, Arg...)) nullptr, | ||
| extra...); | ||
| } | ||
|
|
||
| /// Construct a cpp_function from a class method (const, rvalue ref-qualifier) | ||
| template <typename Return, typename Class, typename... Arg, typename... Extra> | ||
| // NOLINTNEXTLINE(google-explicit-constructor) | ||
| cpp_function(Return (Class::*f)(Arg...) const &&, const Extra &...extra) { | ||
| initialize( | ||
| [f](const Class *c, Arg... args) -> Return { | ||
| return (std::move(*c).*f)(std::forward<Arg>(args)...); | ||
| }, | ||
| (Return (*)(const Class *, Arg...)) nullptr, | ||
| extra...); | ||
| } | ||
|
|
||
| #ifdef __cpp_noexcept_function_type | ||
| /// Construct a cpp_function from a class method (non-const, no ref-qualifier, noexcept) | ||
| template <typename Return, typename Class, typename... Arg, typename... Extra> | ||
| // NOLINTNEXTLINE(google-explicit-constructor) | ||
| cpp_function(Return (Class::*f)(Arg...) noexcept, const Extra &...extra) { | ||
| initialize( | ||
| [f](Class *c, Arg... args) -> Return { return (c->*f)(std::forward<Arg>(args)...); }, | ||
| (Return (*)(Class *, Arg...)) nullptr, | ||
| extra...); | ||
| } | ||
|
|
||
| /// Construct a cpp_function from a class method (non-const, lvalue ref-qualifier, noexcept) | ||
| template <typename Return, typename Class, typename... Arg, typename... Extra> | ||
| // NOLINTNEXTLINE(google-explicit-constructor) | ||
| cpp_function(Return (Class::*f)(Arg...) & noexcept, const Extra &...extra) { | ||
| initialize( | ||
| [f](Class *c, Arg... args) -> Return { return (c->*f)(std::forward<Arg>(args)...); }, | ||
| (Return (*)(Class *, Arg...)) nullptr, | ||
| extra...); | ||
| } | ||
|
|
||
| /// Construct a cpp_function from a class method (const, no ref-qualifier, noexcept) | ||
| template <typename Return, typename Class, typename... Arg, typename... Extra> | ||
| // NOLINTNEXTLINE(google-explicit-constructor) | ||
| cpp_function(Return (Class::*f)(Arg...) const noexcept, const Extra &...extra) { | ||
| initialize([f](const Class *c, | ||
| Arg... args) -> Return { return (c->*f)(std::forward<Arg>(args)...); }, | ||
| (Return (*)(const Class *, Arg...)) nullptr, | ||
| extra...); | ||
| } | ||
|
|
||
| /// Construct a cpp_function from a class method (const, lvalue ref-qualifier, noexcept) | ||
| template <typename Return, typename Class, typename... Arg, typename... Extra> | ||
| // NOLINTNEXTLINE(google-explicit-constructor) | ||
| cpp_function(Return (Class::*f)(Arg...) const & noexcept, const Extra &...extra) { | ||
| initialize([f](const Class *c, | ||
| Arg... args) -> Return { return (c->*f)(std::forward<Arg>(args)...); }, | ||
| (Return (*)(const Class *, Arg...)) nullptr, | ||
| extra...); | ||
| } | ||
|
|
||
| /// Construct a cpp_function from a class method (non-const, rvalue ref-qualifier, noexcept) | ||
| template <typename Return, typename Class, typename... Arg, typename... Extra> | ||
| // NOLINTNEXTLINE(google-explicit-constructor) | ||
| cpp_function(Return (Class::*f)(Arg...) && noexcept, const Extra &...extra) { | ||
| initialize( | ||
| [f](Class *c, Arg... args) -> Return { | ||
| return (std::move(*c).*f)(std::forward<Arg>(args)...); | ||
| }, | ||
| (Return (*)(Class *, Arg...)) nullptr, | ||
| extra...); | ||
| } | ||
|
|
||
| /// Construct a cpp_function from a class method (const, rvalue ref-qualifier, noexcept) | ||
| template <typename Return, typename Class, typename... Arg, typename... Extra> | ||
| // NOLINTNEXTLINE(google-explicit-constructor) | ||
| cpp_function(Return (Class::*f)(Arg...) const && noexcept, const Extra &...extra) { | ||
| initialize( | ||
| [f](const Class *c, Arg... args) -> Return { | ||
| return (std::move(*c).*f)(std::forward<Arg>(args)...); | ||
| }, | ||
| (Return (*)(const Class *, Arg...)) nullptr, | ||
| extra...); | ||
| } | ||
| #endif | ||
|
|
||
| /// Return the function name | ||
| object name() const { return attr("__name__"); } | ||
|
|
||
|
|
@@ -1880,29 +1970,86 @@ inline void add_class_method(object &cls, const char *name_, const cpp_function | |
| } | ||
| } | ||
|
|
||
| /// Type trait to rebind a member function pointer's class to `Derived`, preserving all | ||
| /// cv/ref/noexcept qualifiers. The primary template has no `type` member, providing SFINAE | ||
| /// failure for unsupported member function pointer types. `source_class` holds the original | ||
| /// class for use in `is_accessible_base_of` checks. | ||
| template <typename Derived, typename T> | ||
| struct rebind_member_ptr {}; | ||
|
|
||
| // Define one specialization per supported qualifier combination via a local macro. | ||
| // The qualifiers argument appears in type position, not expression position, so | ||
| // parenthesizing it would produce invalid C++. | ||
| // The no-qualifier specialization is written out explicitly to avoid invoking the macro with an | ||
| // empty argument, which triggers MSVC warning C4003. | ||
| template <typename Derived, typename Return, typename Class, typename... Args> | ||
| struct rebind_member_ptr<Derived, Return (Class::*)(Args...)> { | ||
| using type = Return (Derived::*)(Args...); | ||
| using source_class = Class; | ||
| }; | ||
| // NOLINTBEGIN(bugprone-macro-parentheses) | ||
| #define PYBIND11_REBIND_MEMBER_PTR(qualifiers) \ | ||
| template <typename Derived, typename Return, typename Class, typename... Args> \ | ||
| struct rebind_member_ptr<Derived, Return (Class::*)(Args...) qualifiers> { \ | ||
| using type = Return (Derived::*)(Args...) qualifiers; \ | ||
| using source_class = Class; \ | ||
| } | ||
| PYBIND11_REBIND_MEMBER_PTR(const); | ||
| PYBIND11_REBIND_MEMBER_PTR(&); | ||
| PYBIND11_REBIND_MEMBER_PTR(const &); | ||
| PYBIND11_REBIND_MEMBER_PTR(&&); | ||
| PYBIND11_REBIND_MEMBER_PTR(const &&); | ||
| #ifdef __cpp_noexcept_function_type | ||
| PYBIND11_REBIND_MEMBER_PTR(noexcept); | ||
|
Collaborator
Author
There was a problem hiding this comment. I didn't do the overloads for volatile because I wasn't sure if we would should even support them here @rwgk |
||
| PYBIND11_REBIND_MEMBER_PTR(const noexcept); | ||
| PYBIND11_REBIND_MEMBER_PTR(& noexcept); | ||
| PYBIND11_REBIND_MEMBER_PTR(const & noexcept); | ||
| PYBIND11_REBIND_MEMBER_PTR(&& noexcept); | ||
| PYBIND11_REBIND_MEMBER_PTR(const && noexcept); | ||
| #endif | ||
| #undef PYBIND11_REBIND_MEMBER_PTR | ||
| // NOLINTEND(bugprone-macro-parentheses) | ||
|
|
||
| /// Shared implementation body for all method_adaptor member-function-pointer overloads. | ||
| /// Asserts Base is accessible from Derived, then casts the member pointer. | ||
| template <typename Derived, | ||
| typename T, | ||
| typename Traits = rebind_member_ptr<Derived, T>, | ||
| typename Adapted = typename Traits::type> | ||
| constexpr PYBIND11_ALWAYS_INLINE Adapted adapt_member_ptr(T pmf) { | ||
| static_assert( | ||
| detail::is_accessible_base_of<typename Traits::source_class, Derived>::value, | ||
| "Cannot bind an inaccessible base class method; use a lambda definition instead"); | ||
| return pmf; | ||
| } | ||
|
|
||
| PYBIND11_NAMESPACE_END(detail) | ||
|
|
||
| /// Given a pointer to a member function, cast it to its `Derived` version. | ||
| /// For all other callables (lambdas, function pointers, etc.), forward unchanged. | ||
| /// | ||
| /// Two overloads cover all cases without explicit per-qualifier instantiations: | ||
| /// | ||
| /// (1) Generic fallback — disabled for member function pointers so that (2) wins | ||
| /// without any partial-ordering ambiguity. | ||
| /// (2) MFP overload — SFINAE on rebind_member_ptr::type, which exists for every | ||
| /// supported qualifier combination (const, &, &&, noexcept, ...). A single | ||
| /// template therefore covers all combinations that rebind_member_ptr handles. | ||
| template < | ||
| typename /*Derived*/, | ||
| typename F, | ||
| detail::enable_if_t<!std::is_member_function_pointer<detail::remove_reference_t<F>>::value, | ||
| int> | ||
| = 0> | ||
| constexpr auto method_adaptor(F &&f) -> decltype(std::forward<F>(f)) { | ||
| return std::forward<F>(f); | ||
| } | ||
|
|
||
| template <typename Derived, | ||
| typename T, | ||
| typename Adapted = typename detail::rebind_member_ptr<Derived, T>::type> | ||
| constexpr Adapted method_adaptor(T pmf) { | ||
|
Collaborator
Author
There was a problem hiding this comment. Probably should add a static assert here that T is_member_ptr for sanity. |
||
| return detail::adapt_member_ptr<Derived>(pmf); | ||
| } | ||
|
|
||
| PYBIND11_NAMESPACE_BEGIN(detail) | ||
|
|
@@ -2361,6 +2508,40 @@ class class_ : public detail::generic_type { | |
| return def_buffer([func](const type &obj) { return (obj.*func)(); }); | ||
| } | ||
|
|
||
| // Intentionally no &&/const&& overloads: buffer protocol callbacks are invoked on an | ||
|
|
||
| // existing Python object and should not move-from self. | ||
| template <typename Return, typename Class, typename... Args> | ||
| class_ &def_buffer(Return (Class::*func)(Args...) &) { | ||
| return def_buffer([func](type &obj) { return (obj.*func)(); }); | ||
| } | ||
|
|
||
| template <typename Return, typename Class, typename... Args> | ||
| class_ &def_buffer(Return (Class::*func)(Args...) const &) { | ||
| return def_buffer([func](const type &obj) { return (obj.*func)(); }); | ||
| } | ||
|
|
||
| #ifdef __cpp_noexcept_function_type | ||
| template <typename Return, typename Class, typename... Args> | ||
| class_ &def_buffer(Return (Class::*func)(Args...) noexcept) { | ||
| return def_buffer([func](type &obj) { return (obj.*func)(); }); | ||
| } | ||
|
|
||
| template <typename Return, typename Class, typename... Args> | ||
| class_ &def_buffer(Return (Class::*func)(Args...) const noexcept) { | ||
| return def_buffer([func](const type &obj) { return (obj.*func)(); }); | ||
| } | ||
|
|
||
| template <typename Return, typename Class, typename... Args> | ||
| class_ &def_buffer(Return (Class::*func)(Args...) & noexcept) { | ||
| return def_buffer([func](type &obj) { return (obj.*func)(); }); | ||
| } | ||
|
|
||
| template <typename Return, typename Class, typename... Args> | ||
| class_ &def_buffer(Return (Class::*func)(Args...) const & noexcept) { | ||
| return def_buffer([func](const type &obj) { return (obj.*func)(); }); | ||
| } | ||
| #endif | ||
|
|
||
| template <typename C, typename D, typename... Extra> | ||
| class_ &def_readwrite(const char *name, D C::*pm, const Extra &...extra) { | ||
| static_assert(std::is_same<C, type>::value || std::is_base_of<C, type>::value, | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should I normalize it here for all pybind11? Or keep it as utility that and create a new alias that always strips the noexcept
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
on the flip side we could use the noexcept tag handling to optimize away exception handling for certain edge cases like def_buffer maybe?