pybind11.h revision 12037
111986Sandreas.sandberg@arm.com/* 211986Sandreas.sandberg@arm.com pybind11/pybind11.h: Main header file of the C++11 python 311986Sandreas.sandberg@arm.com binding generator library 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#pragma once 1211986Sandreas.sandberg@arm.com 1311986Sandreas.sandberg@arm.com#if defined(_MSC_VER) 1411986Sandreas.sandberg@arm.com# pragma warning(push) 1511986Sandreas.sandberg@arm.com# pragma warning(disable: 4100) // warning C4100: Unreferenced formal parameter 1611986Sandreas.sandberg@arm.com# pragma warning(disable: 4127) // warning C4127: Conditional expression is constant 1711986Sandreas.sandberg@arm.com# pragma warning(disable: 4512) // warning C4512: Assignment operator was implicitly defined as deleted 1811986Sandreas.sandberg@arm.com# pragma warning(disable: 4800) // warning C4800: 'int': forcing value to bool 'true' or 'false' (performance warning) 1911986Sandreas.sandberg@arm.com# pragma warning(disable: 4996) // warning C4996: The POSIX name for this item is deprecated. Instead, use the ISO C and C++ conformant name 2011986Sandreas.sandberg@arm.com# pragma warning(disable: 4702) // warning C4702: unreachable code 2111986Sandreas.sandberg@arm.com# pragma warning(disable: 4522) // warning C4522: multiple assignment operators specified 2211986Sandreas.sandberg@arm.com#elif defined(__INTEL_COMPILER) 2311986Sandreas.sandberg@arm.com# pragma warning(push) 2411986Sandreas.sandberg@arm.com# pragma warning(disable: 186) // pointless comparison of unsigned integer with zero 2511986Sandreas.sandberg@arm.com# pragma warning(disable: 1334) // the "template" keyword used for syntactic disambiguation may only be used within a template 2611986Sandreas.sandberg@arm.com# pragma warning(disable: 2196) // warning #2196: routine is both "inline" and "noinline" 2711986Sandreas.sandberg@arm.com#elif defined(__GNUG__) && !defined(__clang__) 2811986Sandreas.sandberg@arm.com# pragma GCC diagnostic push 2911986Sandreas.sandberg@arm.com# pragma GCC diagnostic ignored "-Wunused-but-set-parameter" 3011986Sandreas.sandberg@arm.com# pragma GCC diagnostic ignored "-Wunused-but-set-variable" 3111986Sandreas.sandberg@arm.com# pragma GCC diagnostic ignored "-Wmissing-field-initializers" 3211986Sandreas.sandberg@arm.com# pragma GCC diagnostic ignored "-Wstrict-aliasing" 3311986Sandreas.sandberg@arm.com# pragma GCC diagnostic ignored "-Wattributes" 3411986Sandreas.sandberg@arm.com#endif 3511986Sandreas.sandberg@arm.com 3611986Sandreas.sandberg@arm.com#include "attr.h" 3711986Sandreas.sandberg@arm.com#include "options.h" 3812037Sandreas.sandberg@arm.com#include "class_support.h" 3911986Sandreas.sandberg@arm.com 4011986Sandreas.sandberg@arm.comNAMESPACE_BEGIN(pybind11) 4111986Sandreas.sandberg@arm.com 4211986Sandreas.sandberg@arm.com/// Wraps an arbitrary C++ function/method/lambda function/.. into a callable Python object 4311986Sandreas.sandberg@arm.comclass cpp_function : public function { 4411986Sandreas.sandberg@arm.compublic: 4511986Sandreas.sandberg@arm.com cpp_function() { } 4611986Sandreas.sandberg@arm.com 4711986Sandreas.sandberg@arm.com /// Construct a cpp_function from a vanilla function pointer 4811986Sandreas.sandberg@arm.com template <typename Return, typename... Args, typename... Extra> 4911986Sandreas.sandberg@arm.com cpp_function(Return (*f)(Args...), const Extra&... extra) { 5011986Sandreas.sandberg@arm.com initialize(f, f, extra...); 5111986Sandreas.sandberg@arm.com } 5211986Sandreas.sandberg@arm.com 5311986Sandreas.sandberg@arm.com /// Construct a cpp_function from a lambda function (possibly with internal state) 5412037Sandreas.sandberg@arm.com template <typename Func, typename... Extra, typename = detail::enable_if_t< 5512037Sandreas.sandberg@arm.com detail::satisfies_none_of< 5612037Sandreas.sandberg@arm.com typename std::remove_reference<Func>::type, 5712037Sandreas.sandberg@arm.com std::is_function, std::is_pointer, std::is_member_pointer 5812037Sandreas.sandberg@arm.com >::value> 5912037Sandreas.sandberg@arm.com > 6012037Sandreas.sandberg@arm.com cpp_function(Func &&f, const Extra&... extra) { 6112037Sandreas.sandberg@arm.com using FuncType = typename detail::remove_class<decltype(&std::remove_reference<Func>::type::operator())>::type; 6211986Sandreas.sandberg@arm.com initialize(std::forward<Func>(f), 6312037Sandreas.sandberg@arm.com (FuncType *) nullptr, extra...); 6411986Sandreas.sandberg@arm.com } 6511986Sandreas.sandberg@arm.com 6611986Sandreas.sandberg@arm.com /// Construct a cpp_function from a class method (non-const) 6711986Sandreas.sandberg@arm.com template <typename Return, typename Class, typename... Arg, typename... Extra> 6811986Sandreas.sandberg@arm.com cpp_function(Return (Class::*f)(Arg...), const Extra&... extra) { 6911986Sandreas.sandberg@arm.com initialize([f](Class *c, Arg... args) -> Return { return (c->*f)(args...); }, 7011986Sandreas.sandberg@arm.com (Return (*) (Class *, Arg...)) nullptr, extra...); 7111986Sandreas.sandberg@arm.com } 7211986Sandreas.sandberg@arm.com 7311986Sandreas.sandberg@arm.com /// Construct a cpp_function from a class method (const) 7411986Sandreas.sandberg@arm.com template <typename Return, typename Class, typename... Arg, typename... Extra> 7511986Sandreas.sandberg@arm.com cpp_function(Return (Class::*f)(Arg...) const, const Extra&... extra) { 7611986Sandreas.sandberg@arm.com initialize([f](const Class *c, Arg... args) -> Return { return (c->*f)(args...); }, 7711986Sandreas.sandberg@arm.com (Return (*)(const Class *, Arg ...)) nullptr, extra...); 7811986Sandreas.sandberg@arm.com } 7911986Sandreas.sandberg@arm.com 8011986Sandreas.sandberg@arm.com /// Return the function name 8111986Sandreas.sandberg@arm.com object name() const { return attr("__name__"); } 8211986Sandreas.sandberg@arm.com 8311986Sandreas.sandberg@arm.comprotected: 8411986Sandreas.sandberg@arm.com /// Space optimization: don't inline this frequently instantiated fragment 8511986Sandreas.sandberg@arm.com PYBIND11_NOINLINE detail::function_record *make_function_record() { 8611986Sandreas.sandberg@arm.com return new detail::function_record(); 8711986Sandreas.sandberg@arm.com } 8811986Sandreas.sandberg@arm.com 8911986Sandreas.sandberg@arm.com /// Special internal constructor for functors, lambda functions, etc. 9011986Sandreas.sandberg@arm.com template <typename Func, typename Return, typename... Args, typename... Extra> 9111986Sandreas.sandberg@arm.com void initialize(Func &&f, Return (*)(Args...), const Extra&... extra) { 9211986Sandreas.sandberg@arm.com 9311986Sandreas.sandberg@arm.com struct capture { typename std::remove_reference<Func>::type f; }; 9411986Sandreas.sandberg@arm.com 9511986Sandreas.sandberg@arm.com /* Store the function including any extra state it might have (e.g. a lambda capture object) */ 9611986Sandreas.sandberg@arm.com auto rec = make_function_record(); 9711986Sandreas.sandberg@arm.com 9811986Sandreas.sandberg@arm.com /* Store the capture object directly in the function record if there is enough space */ 9911986Sandreas.sandberg@arm.com if (sizeof(capture) <= sizeof(rec->data)) { 10011986Sandreas.sandberg@arm.com /* Without these pragmas, GCC warns that there might not be 10111986Sandreas.sandberg@arm.com enough space to use the placement new operator. However, the 10211986Sandreas.sandberg@arm.com 'if' statement above ensures that this is the case. */ 10311986Sandreas.sandberg@arm.com#if defined(__GNUG__) && !defined(__clang__) && __GNUC__ >= 6 10411986Sandreas.sandberg@arm.com# pragma GCC diagnostic push 10511986Sandreas.sandberg@arm.com# pragma GCC diagnostic ignored "-Wplacement-new" 10611986Sandreas.sandberg@arm.com#endif 10711986Sandreas.sandberg@arm.com new ((capture *) &rec->data) capture { std::forward<Func>(f) }; 10811986Sandreas.sandberg@arm.com#if defined(__GNUG__) && !defined(__clang__) && __GNUC__ >= 6 10911986Sandreas.sandberg@arm.com# pragma GCC diagnostic pop 11011986Sandreas.sandberg@arm.com#endif 11111986Sandreas.sandberg@arm.com if (!std::is_trivially_destructible<Func>::value) 11211986Sandreas.sandberg@arm.com rec->free_data = [](detail::function_record *r) { ((capture *) &r->data)->~capture(); }; 11311986Sandreas.sandberg@arm.com } else { 11411986Sandreas.sandberg@arm.com rec->data[0] = new capture { std::forward<Func>(f) }; 11511986Sandreas.sandberg@arm.com rec->free_data = [](detail::function_record *r) { delete ((capture *) r->data[0]); }; 11611986Sandreas.sandberg@arm.com } 11711986Sandreas.sandberg@arm.com 11811986Sandreas.sandberg@arm.com /* Type casters for the function arguments and return value */ 11911986Sandreas.sandberg@arm.com using cast_in = detail::argument_loader<Args...>; 12011986Sandreas.sandberg@arm.com using cast_out = detail::make_caster< 12111986Sandreas.sandberg@arm.com detail::conditional_t<std::is_void<Return>::value, detail::void_type, Return> 12211986Sandreas.sandberg@arm.com >; 12311986Sandreas.sandberg@arm.com 12412037Sandreas.sandberg@arm.com static_assert(detail::expected_num_args<Extra...>(sizeof...(Args), cast_in::has_args, cast_in::has_kwargs), 12512037Sandreas.sandberg@arm.com "The number of argument annotations does not match the number of function arguments"); 12612037Sandreas.sandberg@arm.com 12711986Sandreas.sandberg@arm.com /* Dispatch code which converts function arguments and performs the actual function call */ 12812037Sandreas.sandberg@arm.com rec->impl = [](detail::function_call &call) -> handle { 12911986Sandreas.sandberg@arm.com cast_in args_converter; 13011986Sandreas.sandberg@arm.com 13111986Sandreas.sandberg@arm.com /* Try to cast the function arguments into the C++ domain */ 13212037Sandreas.sandberg@arm.com if (!args_converter.load_args(call)) 13311986Sandreas.sandberg@arm.com return PYBIND11_TRY_NEXT_OVERLOAD; 13411986Sandreas.sandberg@arm.com 13511986Sandreas.sandberg@arm.com /* Invoke call policy pre-call hook */ 13612037Sandreas.sandberg@arm.com detail::process_attributes<Extra...>::precall(call); 13711986Sandreas.sandberg@arm.com 13811986Sandreas.sandberg@arm.com /* Get a pointer to the capture object */ 13912037Sandreas.sandberg@arm.com auto data = (sizeof(capture) <= sizeof(call.func.data) 14012037Sandreas.sandberg@arm.com ? &call.func.data : call.func.data[0]); 14112037Sandreas.sandberg@arm.com capture *cap = const_cast<capture *>(reinterpret_cast<const capture *>(data)); 14211986Sandreas.sandberg@arm.com 14312037Sandreas.sandberg@arm.com /* Override policy for rvalues -- usually to enforce rvp::move on an rvalue */ 14412037Sandreas.sandberg@arm.com const auto policy = detail::return_value_policy_override<Return>::policy(call.func.policy); 14511986Sandreas.sandberg@arm.com 14611986Sandreas.sandberg@arm.com /* Perform the function call */ 14711986Sandreas.sandberg@arm.com handle result = cast_out::cast(args_converter.template call<Return>(cap->f), 14812037Sandreas.sandberg@arm.com policy, call.parent); 14911986Sandreas.sandberg@arm.com 15011986Sandreas.sandberg@arm.com /* Invoke call policy post-call hook */ 15112037Sandreas.sandberg@arm.com detail::process_attributes<Extra...>::postcall(call, result); 15211986Sandreas.sandberg@arm.com 15311986Sandreas.sandberg@arm.com return result; 15411986Sandreas.sandberg@arm.com }; 15511986Sandreas.sandberg@arm.com 15611986Sandreas.sandberg@arm.com /* Process any user-provided function attributes */ 15711986Sandreas.sandberg@arm.com detail::process_attributes<Extra...>::init(extra..., rec); 15811986Sandreas.sandberg@arm.com 15911986Sandreas.sandberg@arm.com /* Generate a readable signature describing the function's arguments and return value types */ 16011986Sandreas.sandberg@arm.com using detail::descr; using detail::_; 16111986Sandreas.sandberg@arm.com PYBIND11_DESCR signature = _("(") + cast_in::arg_names() + _(") -> ") + cast_out::name(); 16211986Sandreas.sandberg@arm.com 16311986Sandreas.sandberg@arm.com /* Register the function with Python from generic (non-templated) code */ 16411986Sandreas.sandberg@arm.com initialize_generic(rec, signature.text(), signature.types(), sizeof...(Args)); 16511986Sandreas.sandberg@arm.com 16611986Sandreas.sandberg@arm.com if (cast_in::has_args) rec->has_args = true; 16711986Sandreas.sandberg@arm.com if (cast_in::has_kwargs) rec->has_kwargs = true; 16811986Sandreas.sandberg@arm.com 16911986Sandreas.sandberg@arm.com /* Stash some additional information used by an important optimization in 'functional.h' */ 17011986Sandreas.sandberg@arm.com using FunctionType = Return (*)(Args...); 17111986Sandreas.sandberg@arm.com constexpr bool is_function_ptr = 17211986Sandreas.sandberg@arm.com std::is_convertible<Func, FunctionType>::value && 17311986Sandreas.sandberg@arm.com sizeof(capture) == sizeof(void *); 17411986Sandreas.sandberg@arm.com if (is_function_ptr) { 17511986Sandreas.sandberg@arm.com rec->is_stateless = true; 17612037Sandreas.sandberg@arm.com rec->data[1] = const_cast<void *>(reinterpret_cast<const void *>(&typeid(FunctionType))); 17711986Sandreas.sandberg@arm.com } 17811986Sandreas.sandberg@arm.com } 17911986Sandreas.sandberg@arm.com 18011986Sandreas.sandberg@arm.com /// Register a function call with Python (generic non-templated code goes here) 18111986Sandreas.sandberg@arm.com void initialize_generic(detail::function_record *rec, const char *text, 18211986Sandreas.sandberg@arm.com const std::type_info *const *types, size_t args) { 18311986Sandreas.sandberg@arm.com 18411986Sandreas.sandberg@arm.com /* Create copies of all referenced C-style strings */ 18511986Sandreas.sandberg@arm.com rec->name = strdup(rec->name ? rec->name : ""); 18611986Sandreas.sandberg@arm.com if (rec->doc) rec->doc = strdup(rec->doc); 18711986Sandreas.sandberg@arm.com for (auto &a: rec->args) { 18811986Sandreas.sandberg@arm.com if (a.name) 18911986Sandreas.sandberg@arm.com a.name = strdup(a.name); 19011986Sandreas.sandberg@arm.com if (a.descr) 19111986Sandreas.sandberg@arm.com a.descr = strdup(a.descr); 19211986Sandreas.sandberg@arm.com else if (a.value) 19311986Sandreas.sandberg@arm.com a.descr = strdup(a.value.attr("__repr__")().cast<std::string>().c_str()); 19411986Sandreas.sandberg@arm.com } 19511986Sandreas.sandberg@arm.com 19611986Sandreas.sandberg@arm.com /* Generate a proper function signature */ 19711986Sandreas.sandberg@arm.com std::string signature; 19811986Sandreas.sandberg@arm.com size_t type_depth = 0, char_index = 0, type_index = 0, arg_index = 0; 19911986Sandreas.sandberg@arm.com while (true) { 20011986Sandreas.sandberg@arm.com char c = text[char_index++]; 20111986Sandreas.sandberg@arm.com if (c == '\0') 20211986Sandreas.sandberg@arm.com break; 20311986Sandreas.sandberg@arm.com 20411986Sandreas.sandberg@arm.com if (c == '{') { 20511986Sandreas.sandberg@arm.com // Write arg name for everything except *args, **kwargs and return type. 20611986Sandreas.sandberg@arm.com if (type_depth == 0 && text[char_index] != '*' && arg_index < args) { 20712037Sandreas.sandberg@arm.com if (!rec->args.empty() && rec->args[arg_index].name) { 20811986Sandreas.sandberg@arm.com signature += rec->args[arg_index].name; 20911986Sandreas.sandberg@arm.com } else if (arg_index == 0 && rec->is_method) { 21011986Sandreas.sandberg@arm.com signature += "self"; 21111986Sandreas.sandberg@arm.com } else { 21211986Sandreas.sandberg@arm.com signature += "arg" + std::to_string(arg_index - (rec->is_method ? 1 : 0)); 21311986Sandreas.sandberg@arm.com } 21411986Sandreas.sandberg@arm.com signature += ": "; 21511986Sandreas.sandberg@arm.com } 21611986Sandreas.sandberg@arm.com ++type_depth; 21711986Sandreas.sandberg@arm.com } else if (c == '}') { 21811986Sandreas.sandberg@arm.com --type_depth; 21911986Sandreas.sandberg@arm.com if (type_depth == 0) { 22011986Sandreas.sandberg@arm.com if (arg_index < rec->args.size() && rec->args[arg_index].descr) { 22111986Sandreas.sandberg@arm.com signature += "="; 22211986Sandreas.sandberg@arm.com signature += rec->args[arg_index].descr; 22311986Sandreas.sandberg@arm.com } 22411986Sandreas.sandberg@arm.com arg_index++; 22511986Sandreas.sandberg@arm.com } 22611986Sandreas.sandberg@arm.com } else if (c == '%') { 22711986Sandreas.sandberg@arm.com const std::type_info *t = types[type_index++]; 22811986Sandreas.sandberg@arm.com if (!t) 22911986Sandreas.sandberg@arm.com pybind11_fail("Internal error while parsing type signature (1)"); 23011986Sandreas.sandberg@arm.com if (auto tinfo = detail::get_type_info(*t)) { 23112037Sandreas.sandberg@arm.com#if defined(PYPY_VERSION) 23212037Sandreas.sandberg@arm.com signature += handle((PyObject *) tinfo->type) 23312037Sandreas.sandberg@arm.com .attr("__module__") 23412037Sandreas.sandberg@arm.com .cast<std::string>() + "."; 23512037Sandreas.sandberg@arm.com#endif 23611986Sandreas.sandberg@arm.com signature += tinfo->type->tp_name; 23711986Sandreas.sandberg@arm.com } else { 23811986Sandreas.sandberg@arm.com std::string tname(t->name()); 23911986Sandreas.sandberg@arm.com detail::clean_type_id(tname); 24011986Sandreas.sandberg@arm.com signature += tname; 24111986Sandreas.sandberg@arm.com } 24211986Sandreas.sandberg@arm.com } else { 24311986Sandreas.sandberg@arm.com signature += c; 24411986Sandreas.sandberg@arm.com } 24511986Sandreas.sandberg@arm.com } 24611986Sandreas.sandberg@arm.com if (type_depth != 0 || types[type_index] != nullptr) 24711986Sandreas.sandberg@arm.com pybind11_fail("Internal error while parsing type signature (2)"); 24811986Sandreas.sandberg@arm.com 24911986Sandreas.sandberg@arm.com #if !defined(PYBIND11_CPP14) 25011986Sandreas.sandberg@arm.com delete[] types; 25111986Sandreas.sandberg@arm.com delete[] text; 25211986Sandreas.sandberg@arm.com #endif 25311986Sandreas.sandberg@arm.com 25411986Sandreas.sandberg@arm.com#if PY_MAJOR_VERSION < 3 25511986Sandreas.sandberg@arm.com if (strcmp(rec->name, "__next__") == 0) { 25611986Sandreas.sandberg@arm.com std::free(rec->name); 25711986Sandreas.sandberg@arm.com rec->name = strdup("next"); 25811986Sandreas.sandberg@arm.com } else if (strcmp(rec->name, "__bool__") == 0) { 25911986Sandreas.sandberg@arm.com std::free(rec->name); 26011986Sandreas.sandberg@arm.com rec->name = strdup("__nonzero__"); 26111986Sandreas.sandberg@arm.com } 26211986Sandreas.sandberg@arm.com#endif 26311986Sandreas.sandberg@arm.com rec->signature = strdup(signature.c_str()); 26411986Sandreas.sandberg@arm.com rec->args.shrink_to_fit(); 26511986Sandreas.sandberg@arm.com rec->is_constructor = !strcmp(rec->name, "__init__") || !strcmp(rec->name, "__setstate__"); 26612037Sandreas.sandberg@arm.com rec->nargs = (std::uint16_t) args; 26711986Sandreas.sandberg@arm.com 26811986Sandreas.sandberg@arm.com#if PY_MAJOR_VERSION < 3 26911986Sandreas.sandberg@arm.com if (rec->sibling && PyMethod_Check(rec->sibling.ptr())) 27011986Sandreas.sandberg@arm.com rec->sibling = PyMethod_GET_FUNCTION(rec->sibling.ptr()); 27111986Sandreas.sandberg@arm.com#endif 27211986Sandreas.sandberg@arm.com 27311986Sandreas.sandberg@arm.com detail::function_record *chain = nullptr, *chain_start = rec; 27411986Sandreas.sandberg@arm.com if (rec->sibling) { 27511986Sandreas.sandberg@arm.com if (PyCFunction_Check(rec->sibling.ptr())) { 27612037Sandreas.sandberg@arm.com auto rec_capsule = reinterpret_borrow<capsule>(PyCFunction_GET_SELF(rec->sibling.ptr())); 27711986Sandreas.sandberg@arm.com chain = (detail::function_record *) rec_capsule; 27811986Sandreas.sandberg@arm.com /* Never append a method to an overload chain of a parent class; 27911986Sandreas.sandberg@arm.com instead, hide the parent's overloads in this case */ 28011986Sandreas.sandberg@arm.com if (chain->scope != rec->scope) 28111986Sandreas.sandberg@arm.com chain = nullptr; 28211986Sandreas.sandberg@arm.com } 28311986Sandreas.sandberg@arm.com // Don't trigger for things like the default __init__, which are wrapper_descriptors that we are intentionally replacing 28411986Sandreas.sandberg@arm.com else if (!rec->sibling.is_none() && rec->name[0] != '_') 28511986Sandreas.sandberg@arm.com pybind11_fail("Cannot overload existing non-function object \"" + std::string(rec->name) + 28611986Sandreas.sandberg@arm.com "\" with a function of the same name"); 28711986Sandreas.sandberg@arm.com } 28811986Sandreas.sandberg@arm.com 28911986Sandreas.sandberg@arm.com if (!chain) { 29011986Sandreas.sandberg@arm.com /* No existing overload was found, create a new function object */ 29111986Sandreas.sandberg@arm.com rec->def = new PyMethodDef(); 29211986Sandreas.sandberg@arm.com memset(rec->def, 0, sizeof(PyMethodDef)); 29311986Sandreas.sandberg@arm.com rec->def->ml_name = rec->name; 29411986Sandreas.sandberg@arm.com rec->def->ml_meth = reinterpret_cast<PyCFunction>(*dispatcher); 29511986Sandreas.sandberg@arm.com rec->def->ml_flags = METH_VARARGS | METH_KEYWORDS; 29611986Sandreas.sandberg@arm.com 29712037Sandreas.sandberg@arm.com capsule rec_capsule(rec, [](void *ptr) { 29812037Sandreas.sandberg@arm.com destruct((detail::function_record *) ptr); 29911986Sandreas.sandberg@arm.com }); 30011986Sandreas.sandberg@arm.com 30111986Sandreas.sandberg@arm.com object scope_module; 30211986Sandreas.sandberg@arm.com if (rec->scope) { 30311986Sandreas.sandberg@arm.com if (hasattr(rec->scope, "__module__")) { 30411986Sandreas.sandberg@arm.com scope_module = rec->scope.attr("__module__"); 30511986Sandreas.sandberg@arm.com } else if (hasattr(rec->scope, "__name__")) { 30611986Sandreas.sandberg@arm.com scope_module = rec->scope.attr("__name__"); 30711986Sandreas.sandberg@arm.com } 30811986Sandreas.sandberg@arm.com } 30911986Sandreas.sandberg@arm.com 31011986Sandreas.sandberg@arm.com m_ptr = PyCFunction_NewEx(rec->def, rec_capsule.ptr(), scope_module.ptr()); 31111986Sandreas.sandberg@arm.com if (!m_ptr) 31211986Sandreas.sandberg@arm.com pybind11_fail("cpp_function::cpp_function(): Could not allocate function object"); 31311986Sandreas.sandberg@arm.com } else { 31411986Sandreas.sandberg@arm.com /* Append at the end of the overload chain */ 31511986Sandreas.sandberg@arm.com m_ptr = rec->sibling.ptr(); 31611986Sandreas.sandberg@arm.com inc_ref(); 31711986Sandreas.sandberg@arm.com chain_start = chain; 31811986Sandreas.sandberg@arm.com while (chain->next) 31911986Sandreas.sandberg@arm.com chain = chain->next; 32011986Sandreas.sandberg@arm.com chain->next = rec; 32111986Sandreas.sandberg@arm.com } 32211986Sandreas.sandberg@arm.com 32311986Sandreas.sandberg@arm.com std::string signatures; 32411986Sandreas.sandberg@arm.com int index = 0; 32511986Sandreas.sandberg@arm.com /* Create a nice pydoc rec including all signatures and 32611986Sandreas.sandberg@arm.com docstrings of the functions in the overload chain */ 32711986Sandreas.sandberg@arm.com if (chain && options::show_function_signatures()) { 32811986Sandreas.sandberg@arm.com // First a generic signature 32911986Sandreas.sandberg@arm.com signatures += rec->name; 33011986Sandreas.sandberg@arm.com signatures += "(*args, **kwargs)\n"; 33111986Sandreas.sandberg@arm.com signatures += "Overloaded function.\n\n"; 33211986Sandreas.sandberg@arm.com } 33311986Sandreas.sandberg@arm.com // Then specific overload signatures 33412037Sandreas.sandberg@arm.com bool first_user_def = true; 33511986Sandreas.sandberg@arm.com for (auto it = chain_start; it != nullptr; it = it->next) { 33611986Sandreas.sandberg@arm.com if (options::show_function_signatures()) { 33712037Sandreas.sandberg@arm.com if (index > 0) signatures += "\n"; 33811986Sandreas.sandberg@arm.com if (chain) 33911986Sandreas.sandberg@arm.com signatures += std::to_string(++index) + ". "; 34011986Sandreas.sandberg@arm.com signatures += rec->name; 34111986Sandreas.sandberg@arm.com signatures += it->signature; 34211986Sandreas.sandberg@arm.com signatures += "\n"; 34311986Sandreas.sandberg@arm.com } 34411986Sandreas.sandberg@arm.com if (it->doc && strlen(it->doc) > 0 && options::show_user_defined_docstrings()) { 34512037Sandreas.sandberg@arm.com // If we're appending another docstring, and aren't printing function signatures, we 34612037Sandreas.sandberg@arm.com // need to append a newline first: 34712037Sandreas.sandberg@arm.com if (!options::show_function_signatures()) { 34812037Sandreas.sandberg@arm.com if (first_user_def) first_user_def = false; 34912037Sandreas.sandberg@arm.com else signatures += "\n"; 35012037Sandreas.sandberg@arm.com } 35111986Sandreas.sandberg@arm.com if (options::show_function_signatures()) signatures += "\n"; 35211986Sandreas.sandberg@arm.com signatures += it->doc; 35311986Sandreas.sandberg@arm.com if (options::show_function_signatures()) signatures += "\n"; 35411986Sandreas.sandberg@arm.com } 35511986Sandreas.sandberg@arm.com } 35611986Sandreas.sandberg@arm.com 35711986Sandreas.sandberg@arm.com /* Install docstring */ 35811986Sandreas.sandberg@arm.com PyCFunctionObject *func = (PyCFunctionObject *) m_ptr; 35911986Sandreas.sandberg@arm.com if (func->m_ml->ml_doc) 36012037Sandreas.sandberg@arm.com std::free(const_cast<char *>(func->m_ml->ml_doc)); 36111986Sandreas.sandberg@arm.com func->m_ml->ml_doc = strdup(signatures.c_str()); 36211986Sandreas.sandberg@arm.com 36311986Sandreas.sandberg@arm.com if (rec->is_method) { 36411986Sandreas.sandberg@arm.com m_ptr = PYBIND11_INSTANCE_METHOD_NEW(m_ptr, rec->scope.ptr()); 36511986Sandreas.sandberg@arm.com if (!m_ptr) 36611986Sandreas.sandberg@arm.com pybind11_fail("cpp_function::cpp_function(): Could not allocate instance method object"); 36711986Sandreas.sandberg@arm.com Py_DECREF(func); 36811986Sandreas.sandberg@arm.com } 36911986Sandreas.sandberg@arm.com } 37011986Sandreas.sandberg@arm.com 37111986Sandreas.sandberg@arm.com /// When a cpp_function is GCed, release any memory allocated by pybind11 37211986Sandreas.sandberg@arm.com static void destruct(detail::function_record *rec) { 37311986Sandreas.sandberg@arm.com while (rec) { 37411986Sandreas.sandberg@arm.com detail::function_record *next = rec->next; 37511986Sandreas.sandberg@arm.com if (rec->free_data) 37611986Sandreas.sandberg@arm.com rec->free_data(rec); 37711986Sandreas.sandberg@arm.com std::free((char *) rec->name); 37811986Sandreas.sandberg@arm.com std::free((char *) rec->doc); 37911986Sandreas.sandberg@arm.com std::free((char *) rec->signature); 38011986Sandreas.sandberg@arm.com for (auto &arg: rec->args) { 38112037Sandreas.sandberg@arm.com std::free(const_cast<char *>(arg.name)); 38212037Sandreas.sandberg@arm.com std::free(const_cast<char *>(arg.descr)); 38311986Sandreas.sandberg@arm.com arg.value.dec_ref(); 38411986Sandreas.sandberg@arm.com } 38511986Sandreas.sandberg@arm.com if (rec->def) { 38612037Sandreas.sandberg@arm.com std::free(const_cast<char *>(rec->def->ml_doc)); 38711986Sandreas.sandberg@arm.com delete rec->def; 38811986Sandreas.sandberg@arm.com } 38911986Sandreas.sandberg@arm.com delete rec; 39011986Sandreas.sandberg@arm.com rec = next; 39111986Sandreas.sandberg@arm.com } 39211986Sandreas.sandberg@arm.com } 39311986Sandreas.sandberg@arm.com 39411986Sandreas.sandberg@arm.com /// Main dispatch logic for calls to functions bound using pybind11 39512037Sandreas.sandberg@arm.com static PyObject *dispatcher(PyObject *self, PyObject *args_in, PyObject *kwargs_in) { 39612037Sandreas.sandberg@arm.com using namespace detail; 39712037Sandreas.sandberg@arm.com 39811986Sandreas.sandberg@arm.com /* Iterator over the list of potentially admissible overloads */ 39912037Sandreas.sandberg@arm.com function_record *overloads = (function_record *) PyCapsule_GetPointer(self, nullptr), 40012037Sandreas.sandberg@arm.com *it = overloads; 40111986Sandreas.sandberg@arm.com 40211986Sandreas.sandberg@arm.com /* Need to know how many arguments + keyword arguments there are to pick the right overload */ 40312037Sandreas.sandberg@arm.com const size_t n_args_in = (size_t) PyTuple_GET_SIZE(args_in); 40411986Sandreas.sandberg@arm.com 40512037Sandreas.sandberg@arm.com handle parent = n_args_in > 0 ? PyTuple_GET_ITEM(args_in, 0) : nullptr, 40611986Sandreas.sandberg@arm.com result = PYBIND11_TRY_NEXT_OVERLOAD; 40712037Sandreas.sandberg@arm.com 40811986Sandreas.sandberg@arm.com try { 40912037Sandreas.sandberg@arm.com // We do this in two passes: in the first pass, we load arguments with `convert=false`; 41012037Sandreas.sandberg@arm.com // in the second, we allow conversion (except for arguments with an explicit 41112037Sandreas.sandberg@arm.com // py::arg().noconvert()). This lets us prefer calls without conversion, with 41212037Sandreas.sandberg@arm.com // conversion as a fallback. 41312037Sandreas.sandberg@arm.com std::vector<function_call> second_pass; 41412037Sandreas.sandberg@arm.com 41512037Sandreas.sandberg@arm.com // However, if there are no overloads, we can just skip the no-convert pass entirely 41612037Sandreas.sandberg@arm.com const bool overloaded = it != nullptr && it->next != nullptr; 41712037Sandreas.sandberg@arm.com 41811986Sandreas.sandberg@arm.com for (; it != nullptr; it = it->next) { 41911986Sandreas.sandberg@arm.com 42011986Sandreas.sandberg@arm.com /* For each overload: 42112037Sandreas.sandberg@arm.com 1. Copy all positional arguments we were given, also checking to make sure that 42212037Sandreas.sandberg@arm.com named positional arguments weren't *also* specified via kwarg. 42312037Sandreas.sandberg@arm.com 2. If we weren't given enough, try to make up the omitted ones by checking 42412037Sandreas.sandberg@arm.com whether they were provided by a kwarg matching the `py::arg("name")` name. If 42512037Sandreas.sandberg@arm.com so, use it (and remove it from kwargs; if not, see if the function binding 42612037Sandreas.sandberg@arm.com provided a default that we can use. 42712037Sandreas.sandberg@arm.com 3. Ensure that either all keyword arguments were "consumed", or that the function 42812037Sandreas.sandberg@arm.com takes a kwargs argument to accept unconsumed kwargs. 42912037Sandreas.sandberg@arm.com 4. Any positional arguments still left get put into a tuple (for args), and any 43012037Sandreas.sandberg@arm.com leftover kwargs get put into a dict. 43112037Sandreas.sandberg@arm.com 5. Pack everything into a vector; if we have py::args or py::kwargs, they are an 43212037Sandreas.sandberg@arm.com extra tuple or dict at the end of the positional arguments. 43312037Sandreas.sandberg@arm.com 6. Call the function call dispatcher (function_record::impl) 43412037Sandreas.sandberg@arm.com 43512037Sandreas.sandberg@arm.com If one of these fail, move on to the next overload and keep trying until we get a 43612037Sandreas.sandberg@arm.com result other than PYBIND11_TRY_NEXT_OVERLOAD. 43711986Sandreas.sandberg@arm.com */ 43812037Sandreas.sandberg@arm.com 43912037Sandreas.sandberg@arm.com function_record &func = *it; 44012037Sandreas.sandberg@arm.com size_t pos_args = func.nargs; // Number of positional arguments that we need 44112037Sandreas.sandberg@arm.com if (func.has_args) --pos_args; // (but don't count py::args 44212037Sandreas.sandberg@arm.com if (func.has_kwargs) --pos_args; // or py::kwargs) 44312037Sandreas.sandberg@arm.com 44412037Sandreas.sandberg@arm.com if (!func.has_args && n_args_in > pos_args) 44512037Sandreas.sandberg@arm.com continue; // Too many arguments for this overload 44612037Sandreas.sandberg@arm.com 44712037Sandreas.sandberg@arm.com if (n_args_in < pos_args && func.args.size() < pos_args) 44812037Sandreas.sandberg@arm.com continue; // Not enough arguments given, and not enough defaults to fill in the blanks 44912037Sandreas.sandberg@arm.com 45012037Sandreas.sandberg@arm.com function_call call(func, parent); 45112037Sandreas.sandberg@arm.com 45212037Sandreas.sandberg@arm.com size_t args_to_copy = std::min(pos_args, n_args_in); 45312037Sandreas.sandberg@arm.com size_t args_copied = 0; 45412037Sandreas.sandberg@arm.com 45512037Sandreas.sandberg@arm.com // 1. Copy any position arguments given. 45612037Sandreas.sandberg@arm.com bool bad_kwarg = false; 45712037Sandreas.sandberg@arm.com for (; args_copied < args_to_copy; ++args_copied) { 45812037Sandreas.sandberg@arm.com if (kwargs_in && args_copied < func.args.size() && func.args[args_copied].name 45912037Sandreas.sandberg@arm.com && PyDict_GetItemString(kwargs_in, func.args[args_copied].name)) { 46012037Sandreas.sandberg@arm.com bad_kwarg = true; 46112037Sandreas.sandberg@arm.com break; 46211986Sandreas.sandberg@arm.com } 46311986Sandreas.sandberg@arm.com 46412037Sandreas.sandberg@arm.com call.args.push_back(PyTuple_GET_ITEM(args_in, args_copied)); 46512037Sandreas.sandberg@arm.com call.args_convert.push_back(args_copied < func.args.size() ? func.args[args_copied].convert : true); 46612037Sandreas.sandberg@arm.com } 46712037Sandreas.sandberg@arm.com if (bad_kwarg) 46812037Sandreas.sandberg@arm.com continue; // Maybe it was meant for another overload (issue #688) 46912037Sandreas.sandberg@arm.com 47012037Sandreas.sandberg@arm.com // We'll need to copy this if we steal some kwargs for defaults 47112037Sandreas.sandberg@arm.com dict kwargs = reinterpret_borrow<dict>(kwargs_in); 47212037Sandreas.sandberg@arm.com 47312037Sandreas.sandberg@arm.com // 2. Check kwargs and, failing that, defaults that may help complete the list 47412037Sandreas.sandberg@arm.com if (args_copied < pos_args) { 47512037Sandreas.sandberg@arm.com bool copied_kwargs = false; 47612037Sandreas.sandberg@arm.com 47712037Sandreas.sandberg@arm.com for (; args_copied < pos_args; ++args_copied) { 47812037Sandreas.sandberg@arm.com const auto &arg = func.args[args_copied]; 47911986Sandreas.sandberg@arm.com 48011986Sandreas.sandberg@arm.com handle value; 48112037Sandreas.sandberg@arm.com if (kwargs_in && arg.name) 48212037Sandreas.sandberg@arm.com value = PyDict_GetItemString(kwargs.ptr(), arg.name); 48311986Sandreas.sandberg@arm.com 48411986Sandreas.sandberg@arm.com if (value) { 48512037Sandreas.sandberg@arm.com // Consume a kwargs value 48612037Sandreas.sandberg@arm.com if (!copied_kwargs) { 48712037Sandreas.sandberg@arm.com kwargs = reinterpret_steal<dict>(PyDict_Copy(kwargs.ptr())); 48812037Sandreas.sandberg@arm.com copied_kwargs = true; 48912037Sandreas.sandberg@arm.com } 49012037Sandreas.sandberg@arm.com PyDict_DelItemString(kwargs.ptr(), arg.name); 49112037Sandreas.sandberg@arm.com } else if (arg.value) { 49212037Sandreas.sandberg@arm.com value = arg.value; 49312037Sandreas.sandberg@arm.com } 49412037Sandreas.sandberg@arm.com 49512037Sandreas.sandberg@arm.com if (value) { 49612037Sandreas.sandberg@arm.com call.args.push_back(value); 49712037Sandreas.sandberg@arm.com call.args_convert.push_back(arg.convert); 49812037Sandreas.sandberg@arm.com } 49912037Sandreas.sandberg@arm.com else 50011986Sandreas.sandberg@arm.com break; 50112037Sandreas.sandberg@arm.com } 50212037Sandreas.sandberg@arm.com 50312037Sandreas.sandberg@arm.com if (args_copied < pos_args) 50412037Sandreas.sandberg@arm.com continue; // Not enough arguments, defaults, or kwargs to fill the positional arguments 50512037Sandreas.sandberg@arm.com } 50612037Sandreas.sandberg@arm.com 50712037Sandreas.sandberg@arm.com // 3. Check everything was consumed (unless we have a kwargs arg) 50812037Sandreas.sandberg@arm.com if (kwargs && kwargs.size() > 0 && !func.has_kwargs) 50912037Sandreas.sandberg@arm.com continue; // Unconsumed kwargs, but no py::kwargs argument to accept them 51012037Sandreas.sandberg@arm.com 51112037Sandreas.sandberg@arm.com // 4a. If we have a py::args argument, create a new tuple with leftovers 51212037Sandreas.sandberg@arm.com tuple extra_args; 51312037Sandreas.sandberg@arm.com if (func.has_args) { 51412037Sandreas.sandberg@arm.com if (args_to_copy == 0) { 51512037Sandreas.sandberg@arm.com // We didn't copy out any position arguments from the args_in tuple, so we 51612037Sandreas.sandberg@arm.com // can reuse it directly without copying: 51712037Sandreas.sandberg@arm.com extra_args = reinterpret_borrow<tuple>(args_in); 51812037Sandreas.sandberg@arm.com } else if (args_copied >= n_args_in) { 51912037Sandreas.sandberg@arm.com extra_args = tuple(0); 52012037Sandreas.sandberg@arm.com } else { 52112037Sandreas.sandberg@arm.com size_t args_size = n_args_in - args_copied; 52212037Sandreas.sandberg@arm.com extra_args = tuple(args_size); 52312037Sandreas.sandberg@arm.com for (size_t i = 0; i < args_size; ++i) { 52412037Sandreas.sandberg@arm.com handle item = PyTuple_GET_ITEM(args_in, args_copied + i); 52512037Sandreas.sandberg@arm.com extra_args[i] = item.inc_ref().ptr(); 52611986Sandreas.sandberg@arm.com } 52711986Sandreas.sandberg@arm.com } 52812037Sandreas.sandberg@arm.com call.args.push_back(extra_args); 52912037Sandreas.sandberg@arm.com call.args_convert.push_back(false); 53011986Sandreas.sandberg@arm.com } 53111986Sandreas.sandberg@arm.com 53212037Sandreas.sandberg@arm.com // 4b. If we have a py::kwargs, pass on any remaining kwargs 53312037Sandreas.sandberg@arm.com if (func.has_kwargs) { 53412037Sandreas.sandberg@arm.com if (!kwargs.ptr()) 53512037Sandreas.sandberg@arm.com kwargs = dict(); // If we didn't get one, send an empty one 53612037Sandreas.sandberg@arm.com call.args.push_back(kwargs); 53712037Sandreas.sandberg@arm.com call.args_convert.push_back(false); 53812037Sandreas.sandberg@arm.com } 53912037Sandreas.sandberg@arm.com 54012037Sandreas.sandberg@arm.com // 5. Put everything in a vector. Not technically step 5, we've been building it 54112037Sandreas.sandberg@arm.com // in `call.args` all along. 54212037Sandreas.sandberg@arm.com #if !defined(NDEBUG) 54312037Sandreas.sandberg@arm.com if (call.args.size() != func.nargs || call.args_convert.size() != func.nargs) 54412037Sandreas.sandberg@arm.com pybind11_fail("Internal error: function call dispatcher inserted wrong number of arguments!"); 54512037Sandreas.sandberg@arm.com #endif 54612037Sandreas.sandberg@arm.com 54712037Sandreas.sandberg@arm.com std::vector<bool> second_pass_convert; 54812037Sandreas.sandberg@arm.com if (overloaded) { 54912037Sandreas.sandberg@arm.com // We're in the first no-convert pass, so swap out the conversion flags for a 55012037Sandreas.sandberg@arm.com // set of all-false flags. If the call fails, we'll swap the flags back in for 55112037Sandreas.sandberg@arm.com // the conversion-allowed call below. 55212037Sandreas.sandberg@arm.com second_pass_convert.resize(func.nargs, false); 55312037Sandreas.sandberg@arm.com call.args_convert.swap(second_pass_convert); 55412037Sandreas.sandberg@arm.com } 55512037Sandreas.sandberg@arm.com 55612037Sandreas.sandberg@arm.com // 6. Call the function. 55711986Sandreas.sandberg@arm.com try { 55812037Sandreas.sandberg@arm.com result = func.impl(call); 55911986Sandreas.sandberg@arm.com } catch (reference_cast_error &) { 56011986Sandreas.sandberg@arm.com result = PYBIND11_TRY_NEXT_OVERLOAD; 56111986Sandreas.sandberg@arm.com } 56211986Sandreas.sandberg@arm.com 56311986Sandreas.sandberg@arm.com if (result.ptr() != PYBIND11_TRY_NEXT_OVERLOAD) 56411986Sandreas.sandberg@arm.com break; 56512037Sandreas.sandberg@arm.com 56612037Sandreas.sandberg@arm.com if (overloaded) { 56712037Sandreas.sandberg@arm.com // The (overloaded) call failed; if the call has at least one argument that 56812037Sandreas.sandberg@arm.com // permits conversion (i.e. it hasn't been explicitly specified `.noconvert()`) 56912037Sandreas.sandberg@arm.com // then add this call to the list of second pass overloads to try. 57012037Sandreas.sandberg@arm.com for (size_t i = func.is_method ? 1 : 0; i < pos_args; i++) { 57112037Sandreas.sandberg@arm.com if (second_pass_convert[i]) { 57212037Sandreas.sandberg@arm.com // Found one: swap the converting flags back in and store the call for 57312037Sandreas.sandberg@arm.com // the second pass. 57412037Sandreas.sandberg@arm.com call.args_convert.swap(second_pass_convert); 57512037Sandreas.sandberg@arm.com second_pass.push_back(std::move(call)); 57612037Sandreas.sandberg@arm.com break; 57712037Sandreas.sandberg@arm.com } 57812037Sandreas.sandberg@arm.com } 57912037Sandreas.sandberg@arm.com } 58012037Sandreas.sandberg@arm.com } 58112037Sandreas.sandberg@arm.com 58212037Sandreas.sandberg@arm.com if (overloaded && !second_pass.empty() && result.ptr() == PYBIND11_TRY_NEXT_OVERLOAD) { 58312037Sandreas.sandberg@arm.com // The no-conversion pass finished without success, try again with conversion allowed 58412037Sandreas.sandberg@arm.com for (auto &call : second_pass) { 58512037Sandreas.sandberg@arm.com try { 58612037Sandreas.sandberg@arm.com result = call.func.impl(call); 58712037Sandreas.sandberg@arm.com } catch (reference_cast_error &) { 58812037Sandreas.sandberg@arm.com result = PYBIND11_TRY_NEXT_OVERLOAD; 58912037Sandreas.sandberg@arm.com } 59012037Sandreas.sandberg@arm.com 59112037Sandreas.sandberg@arm.com if (result.ptr() != PYBIND11_TRY_NEXT_OVERLOAD) 59212037Sandreas.sandberg@arm.com break; 59312037Sandreas.sandberg@arm.com } 59411986Sandreas.sandberg@arm.com } 59511986Sandreas.sandberg@arm.com } catch (error_already_set &e) { 59611986Sandreas.sandberg@arm.com e.restore(); 59711986Sandreas.sandberg@arm.com return nullptr; 59811986Sandreas.sandberg@arm.com } catch (...) { 59911986Sandreas.sandberg@arm.com /* When an exception is caught, give each registered exception 60011986Sandreas.sandberg@arm.com translator a chance to translate it to a Python exception 60111986Sandreas.sandberg@arm.com in reverse order of registration. 60211986Sandreas.sandberg@arm.com 60311986Sandreas.sandberg@arm.com A translator may choose to do one of the following: 60411986Sandreas.sandberg@arm.com 60511986Sandreas.sandberg@arm.com - catch the exception and call PyErr_SetString or PyErr_SetObject 60611986Sandreas.sandberg@arm.com to set a standard (or custom) Python exception, or 60711986Sandreas.sandberg@arm.com - do nothing and let the exception fall through to the next translator, or 60811986Sandreas.sandberg@arm.com - delegate translation to the next translator by throwing a new type of exception. */ 60911986Sandreas.sandberg@arm.com 61011986Sandreas.sandberg@arm.com auto last_exception = std::current_exception(); 61112037Sandreas.sandberg@arm.com auto ®istered_exception_translators = get_internals().registered_exception_translators; 61211986Sandreas.sandberg@arm.com for (auto& translator : registered_exception_translators) { 61311986Sandreas.sandberg@arm.com try { 61411986Sandreas.sandberg@arm.com translator(last_exception); 61511986Sandreas.sandberg@arm.com } catch (...) { 61611986Sandreas.sandberg@arm.com last_exception = std::current_exception(); 61711986Sandreas.sandberg@arm.com continue; 61811986Sandreas.sandberg@arm.com } 61911986Sandreas.sandberg@arm.com return nullptr; 62011986Sandreas.sandberg@arm.com } 62111986Sandreas.sandberg@arm.com PyErr_SetString(PyExc_SystemError, "Exception escaped from default exception translator!"); 62211986Sandreas.sandberg@arm.com return nullptr; 62311986Sandreas.sandberg@arm.com } 62411986Sandreas.sandberg@arm.com 62511986Sandreas.sandberg@arm.com if (result.ptr() == PYBIND11_TRY_NEXT_OVERLOAD) { 62611986Sandreas.sandberg@arm.com if (overloads->is_operator) 62711986Sandreas.sandberg@arm.com return handle(Py_NotImplemented).inc_ref().ptr(); 62811986Sandreas.sandberg@arm.com 62911986Sandreas.sandberg@arm.com std::string msg = std::string(overloads->name) + "(): incompatible " + 63011986Sandreas.sandberg@arm.com std::string(overloads->is_constructor ? "constructor" : "function") + 63111986Sandreas.sandberg@arm.com " arguments. The following argument types are supported:\n"; 63211986Sandreas.sandberg@arm.com 63311986Sandreas.sandberg@arm.com int ctr = 0; 63412037Sandreas.sandberg@arm.com for (function_record *it2 = overloads; it2 != nullptr; it2 = it2->next) { 63511986Sandreas.sandberg@arm.com msg += " "+ std::to_string(++ctr) + ". "; 63611986Sandreas.sandberg@arm.com 63711986Sandreas.sandberg@arm.com bool wrote_sig = false; 63811986Sandreas.sandberg@arm.com if (overloads->is_constructor) { 63911986Sandreas.sandberg@arm.com // For a constructor, rewrite `(self: Object, arg0, ...) -> NoneType` as `Object(arg0, ...)` 64011986Sandreas.sandberg@arm.com std::string sig = it2->signature; 64111986Sandreas.sandberg@arm.com size_t start = sig.find('(') + 7; // skip "(self: " 64211986Sandreas.sandberg@arm.com if (start < sig.size()) { 64311986Sandreas.sandberg@arm.com // End at the , for the next argument 64411986Sandreas.sandberg@arm.com size_t end = sig.find(", "), next = end + 2; 64511986Sandreas.sandberg@arm.com size_t ret = sig.rfind(" -> "); 64611986Sandreas.sandberg@arm.com // Or the ), if there is no comma: 64711986Sandreas.sandberg@arm.com if (end >= sig.size()) next = end = sig.find(')'); 64811986Sandreas.sandberg@arm.com if (start < end && next < sig.size()) { 64911986Sandreas.sandberg@arm.com msg.append(sig, start, end - start); 65011986Sandreas.sandberg@arm.com msg += '('; 65111986Sandreas.sandberg@arm.com msg.append(sig, next, ret - next); 65211986Sandreas.sandberg@arm.com wrote_sig = true; 65311986Sandreas.sandberg@arm.com } 65411986Sandreas.sandberg@arm.com } 65511986Sandreas.sandberg@arm.com } 65611986Sandreas.sandberg@arm.com if (!wrote_sig) msg += it2->signature; 65711986Sandreas.sandberg@arm.com 65811986Sandreas.sandberg@arm.com msg += "\n"; 65911986Sandreas.sandberg@arm.com } 66011986Sandreas.sandberg@arm.com msg += "\nInvoked with: "; 66112037Sandreas.sandberg@arm.com auto args_ = reinterpret_borrow<tuple>(args_in); 66212037Sandreas.sandberg@arm.com bool some_args = false; 66311986Sandreas.sandberg@arm.com for (size_t ti = overloads->is_constructor ? 1 : 0; ti < args_.size(); ++ti) { 66412037Sandreas.sandberg@arm.com if (!some_args) some_args = true; 66512037Sandreas.sandberg@arm.com else msg += ", "; 66611986Sandreas.sandberg@arm.com msg += pybind11::repr(args_[ti]); 66711986Sandreas.sandberg@arm.com } 66812037Sandreas.sandberg@arm.com if (kwargs_in) { 66912037Sandreas.sandberg@arm.com auto kwargs = reinterpret_borrow<dict>(kwargs_in); 67012037Sandreas.sandberg@arm.com if (kwargs.size() > 0) { 67112037Sandreas.sandberg@arm.com if (some_args) msg += "; "; 67212037Sandreas.sandberg@arm.com msg += "kwargs: "; 67312037Sandreas.sandberg@arm.com bool first = true; 67412037Sandreas.sandberg@arm.com for (auto kwarg : kwargs) { 67512037Sandreas.sandberg@arm.com if (first) first = false; 67612037Sandreas.sandberg@arm.com else msg += ", "; 67712037Sandreas.sandberg@arm.com msg += pybind11::str("{}={!r}").format(kwarg.first, kwarg.second); 67812037Sandreas.sandberg@arm.com } 67912037Sandreas.sandberg@arm.com } 68012037Sandreas.sandberg@arm.com } 68112037Sandreas.sandberg@arm.com 68211986Sandreas.sandberg@arm.com PyErr_SetString(PyExc_TypeError, msg.c_str()); 68311986Sandreas.sandberg@arm.com return nullptr; 68411986Sandreas.sandberg@arm.com } else if (!result) { 68511986Sandreas.sandberg@arm.com std::string msg = "Unable to convert function return value to a " 68611986Sandreas.sandberg@arm.com "Python type! The signature was\n\t"; 68711986Sandreas.sandberg@arm.com msg += it->signature; 68811986Sandreas.sandberg@arm.com PyErr_SetString(PyExc_TypeError, msg.c_str()); 68911986Sandreas.sandberg@arm.com return nullptr; 69011986Sandreas.sandberg@arm.com } else { 69111986Sandreas.sandberg@arm.com if (overloads->is_constructor) { 69211986Sandreas.sandberg@arm.com /* When a constructor ran successfully, the corresponding 69311986Sandreas.sandberg@arm.com holder type (e.g. std::unique_ptr) must still be initialized. */ 69412037Sandreas.sandberg@arm.com auto tinfo = get_type_info(Py_TYPE(parent.ptr())); 69512037Sandreas.sandberg@arm.com tinfo->init_holder(parent.ptr(), nullptr); 69611986Sandreas.sandberg@arm.com } 69711986Sandreas.sandberg@arm.com return result.ptr(); 69811986Sandreas.sandberg@arm.com } 69911986Sandreas.sandberg@arm.com } 70011986Sandreas.sandberg@arm.com}; 70111986Sandreas.sandberg@arm.com 70211986Sandreas.sandberg@arm.com/// Wrapper for Python extension modules 70311986Sandreas.sandberg@arm.comclass module : public object { 70411986Sandreas.sandberg@arm.compublic: 70511986Sandreas.sandberg@arm.com PYBIND11_OBJECT_DEFAULT(module, object, PyModule_Check) 70611986Sandreas.sandberg@arm.com 70712037Sandreas.sandberg@arm.com /// Create a new top-level Python module with the given name and docstring 70811986Sandreas.sandberg@arm.com explicit module(const char *name, const char *doc = nullptr) { 70911986Sandreas.sandberg@arm.com if (!options::show_user_defined_docstrings()) doc = nullptr; 71011986Sandreas.sandberg@arm.com#if PY_MAJOR_VERSION >= 3 71111986Sandreas.sandberg@arm.com PyModuleDef *def = new PyModuleDef(); 71211986Sandreas.sandberg@arm.com memset(def, 0, sizeof(PyModuleDef)); 71311986Sandreas.sandberg@arm.com def->m_name = name; 71411986Sandreas.sandberg@arm.com def->m_doc = doc; 71511986Sandreas.sandberg@arm.com def->m_size = -1; 71611986Sandreas.sandberg@arm.com Py_INCREF(def); 71711986Sandreas.sandberg@arm.com m_ptr = PyModule_Create(def); 71811986Sandreas.sandberg@arm.com#else 71911986Sandreas.sandberg@arm.com m_ptr = Py_InitModule3(name, nullptr, doc); 72011986Sandreas.sandberg@arm.com#endif 72111986Sandreas.sandberg@arm.com if (m_ptr == nullptr) 72211986Sandreas.sandberg@arm.com pybind11_fail("Internal error in module::module()"); 72311986Sandreas.sandberg@arm.com inc_ref(); 72411986Sandreas.sandberg@arm.com } 72511986Sandreas.sandberg@arm.com 72612037Sandreas.sandberg@arm.com /** \rst 72712037Sandreas.sandberg@arm.com Create Python binding for a new function within the module scope. ``Func`` 72812037Sandreas.sandberg@arm.com can be a plain C++ function, a function pointer, or a lambda function. For 72912037Sandreas.sandberg@arm.com details on the ``Extra&& ... extra`` argument, see section :ref:`extras`. 73012037Sandreas.sandberg@arm.com \endrst */ 73111986Sandreas.sandberg@arm.com template <typename Func, typename... Extra> 73211986Sandreas.sandberg@arm.com module &def(const char *name_, Func &&f, const Extra& ... extra) { 73311986Sandreas.sandberg@arm.com cpp_function func(std::forward<Func>(f), name(name_), scope(*this), 73411986Sandreas.sandberg@arm.com sibling(getattr(*this, name_, none())), extra...); 73511986Sandreas.sandberg@arm.com // NB: allow overwriting here because cpp_function sets up a chain with the intention of 73611986Sandreas.sandberg@arm.com // overwriting (and has already checked internally that it isn't overwriting non-functions). 73711986Sandreas.sandberg@arm.com add_object(name_, func, true /* overwrite */); 73811986Sandreas.sandberg@arm.com return *this; 73911986Sandreas.sandberg@arm.com } 74011986Sandreas.sandberg@arm.com 74112037Sandreas.sandberg@arm.com /** \rst 74212037Sandreas.sandberg@arm.com Create and return a new Python submodule with the given name and docstring. 74312037Sandreas.sandberg@arm.com This also works recursively, i.e. 74412037Sandreas.sandberg@arm.com 74512037Sandreas.sandberg@arm.com .. code-block:: cpp 74612037Sandreas.sandberg@arm.com 74712037Sandreas.sandberg@arm.com py::module m("example", "pybind11 example plugin"); 74812037Sandreas.sandberg@arm.com py::module m2 = m.def_submodule("sub", "A submodule of 'example'"); 74912037Sandreas.sandberg@arm.com py::module m3 = m2.def_submodule("subsub", "A submodule of 'example.sub'"); 75012037Sandreas.sandberg@arm.com \endrst */ 75111986Sandreas.sandberg@arm.com module def_submodule(const char *name, const char *doc = nullptr) { 75211986Sandreas.sandberg@arm.com std::string full_name = std::string(PyModule_GetName(m_ptr)) 75311986Sandreas.sandberg@arm.com + std::string(".") + std::string(name); 75411986Sandreas.sandberg@arm.com auto result = reinterpret_borrow<module>(PyImport_AddModule(full_name.c_str())); 75511986Sandreas.sandberg@arm.com if (doc && options::show_user_defined_docstrings()) 75611986Sandreas.sandberg@arm.com result.attr("__doc__") = pybind11::str(doc); 75711986Sandreas.sandberg@arm.com attr(name) = result; 75811986Sandreas.sandberg@arm.com return result; 75911986Sandreas.sandberg@arm.com } 76011986Sandreas.sandberg@arm.com 76112037Sandreas.sandberg@arm.com /// Import and return a module or throws `error_already_set`. 76211986Sandreas.sandberg@arm.com static module import(const char *name) { 76311986Sandreas.sandberg@arm.com PyObject *obj = PyImport_ImportModule(name); 76411986Sandreas.sandberg@arm.com if (!obj) 76511986Sandreas.sandberg@arm.com throw error_already_set(); 76611986Sandreas.sandberg@arm.com return reinterpret_steal<module>(obj); 76711986Sandreas.sandberg@arm.com } 76811986Sandreas.sandberg@arm.com 76911986Sandreas.sandberg@arm.com // Adds an object to the module using the given name. Throws if an object with the given name 77011986Sandreas.sandberg@arm.com // already exists. 77111986Sandreas.sandberg@arm.com // 77211986Sandreas.sandberg@arm.com // overwrite should almost always be false: attempting to overwrite objects that pybind11 has 77311986Sandreas.sandberg@arm.com // established will, in most cases, break things. 77411986Sandreas.sandberg@arm.com PYBIND11_NOINLINE void add_object(const char *name, object &obj, bool overwrite = false) { 77511986Sandreas.sandberg@arm.com if (!overwrite && hasattr(*this, name)) 77611986Sandreas.sandberg@arm.com pybind11_fail("Error during initialization: multiple incompatible definitions with name \"" + 77711986Sandreas.sandberg@arm.com std::string(name) + "\""); 77811986Sandreas.sandberg@arm.com 77911986Sandreas.sandberg@arm.com obj.inc_ref(); // PyModule_AddObject() steals a reference 78011986Sandreas.sandberg@arm.com PyModule_AddObject(ptr(), name, obj.ptr()); 78111986Sandreas.sandberg@arm.com } 78211986Sandreas.sandberg@arm.com}; 78311986Sandreas.sandberg@arm.com 78411986Sandreas.sandberg@arm.comNAMESPACE_BEGIN(detail) 78511986Sandreas.sandberg@arm.com/// Generic support for creating new Python heap types 78611986Sandreas.sandberg@arm.comclass generic_type : public object { 78711986Sandreas.sandberg@arm.com template <typename...> friend class class_; 78811986Sandreas.sandberg@arm.compublic: 78911986Sandreas.sandberg@arm.com PYBIND11_OBJECT_DEFAULT(generic_type, object, PyType_Check) 79011986Sandreas.sandberg@arm.comprotected: 79112037Sandreas.sandberg@arm.com void initialize(const type_record &rec) { 79212037Sandreas.sandberg@arm.com if (rec.scope && hasattr(rec.scope, rec.name)) 79312037Sandreas.sandberg@arm.com pybind11_fail("generic_type: cannot initialize type \"" + std::string(rec.name) + 79412037Sandreas.sandberg@arm.com "\": an object with that name is already defined"); 79511986Sandreas.sandberg@arm.com 79612037Sandreas.sandberg@arm.com if (get_type_info(*rec.type)) 79712037Sandreas.sandberg@arm.com pybind11_fail("generic_type: type \"" + std::string(rec.name) + 79811986Sandreas.sandberg@arm.com "\" is already registered!"); 79911986Sandreas.sandberg@arm.com 80012037Sandreas.sandberg@arm.com m_ptr = make_new_python_type(rec); 80111986Sandreas.sandberg@arm.com 80211986Sandreas.sandberg@arm.com /* Register supplemental type information in C++ dict */ 80312037Sandreas.sandberg@arm.com auto *tinfo = new detail::type_info(); 80412037Sandreas.sandberg@arm.com tinfo->type = (PyTypeObject *) m_ptr; 80512037Sandreas.sandberg@arm.com tinfo->type_size = rec.type_size; 80612037Sandreas.sandberg@arm.com tinfo->operator_new = rec.operator_new; 80712037Sandreas.sandberg@arm.com tinfo->init_holder = rec.init_holder; 80812037Sandreas.sandberg@arm.com tinfo->dealloc = rec.dealloc; 80912037Sandreas.sandberg@arm.com 81012037Sandreas.sandberg@arm.com auto &internals = get_internals(); 81112037Sandreas.sandberg@arm.com auto tindex = std::type_index(*rec.type); 81211986Sandreas.sandberg@arm.com tinfo->direct_conversions = &internals.direct_conversions[tindex]; 81312037Sandreas.sandberg@arm.com tinfo->default_holder = rec.default_holder; 81411986Sandreas.sandberg@arm.com internals.registered_types_cpp[tindex] = tinfo; 81512037Sandreas.sandberg@arm.com internals.registered_types_py[m_ptr] = tinfo; 81611986Sandreas.sandberg@arm.com 81712037Sandreas.sandberg@arm.com if (rec.bases.size() > 1 || rec.multiple_inheritance) 81812037Sandreas.sandberg@arm.com mark_parents_nonsimple(tinfo->type); 81911986Sandreas.sandberg@arm.com } 82011986Sandreas.sandberg@arm.com 82111986Sandreas.sandberg@arm.com /// Helper function which tags all parents of a type using mult. inheritance 82211986Sandreas.sandberg@arm.com void mark_parents_nonsimple(PyTypeObject *value) { 82311986Sandreas.sandberg@arm.com auto t = reinterpret_borrow<tuple>(value->tp_bases); 82411986Sandreas.sandberg@arm.com for (handle h : t) { 82511986Sandreas.sandberg@arm.com auto tinfo2 = get_type_info((PyTypeObject *) h.ptr()); 82611986Sandreas.sandberg@arm.com if (tinfo2) 82711986Sandreas.sandberg@arm.com tinfo2->simple_type = false; 82811986Sandreas.sandberg@arm.com mark_parents_nonsimple((PyTypeObject *) h.ptr()); 82911986Sandreas.sandberg@arm.com } 83011986Sandreas.sandberg@arm.com } 83111986Sandreas.sandberg@arm.com 83211986Sandreas.sandberg@arm.com void install_buffer_funcs( 83311986Sandreas.sandberg@arm.com buffer_info *(*get_buffer)(PyObject *, void *), 83411986Sandreas.sandberg@arm.com void *get_buffer_data) { 83511986Sandreas.sandberg@arm.com PyHeapTypeObject *type = (PyHeapTypeObject*) m_ptr; 83611986Sandreas.sandberg@arm.com auto tinfo = detail::get_type_info(&type->ht_type); 83712037Sandreas.sandberg@arm.com 83812037Sandreas.sandberg@arm.com if (!type->ht_type.tp_as_buffer) 83912037Sandreas.sandberg@arm.com pybind11_fail( 84012037Sandreas.sandberg@arm.com "To be able to register buffer protocol support for the type '" + 84112037Sandreas.sandberg@arm.com std::string(tinfo->type->tp_name) + 84212037Sandreas.sandberg@arm.com "' the associated class<>(..) invocation must " 84312037Sandreas.sandberg@arm.com "include the pybind11::buffer_protocol() annotation!"); 84412037Sandreas.sandberg@arm.com 84511986Sandreas.sandberg@arm.com tinfo->get_buffer = get_buffer; 84611986Sandreas.sandberg@arm.com tinfo->get_buffer_data = get_buffer_data; 84711986Sandreas.sandberg@arm.com } 84811986Sandreas.sandberg@arm.com 84912037Sandreas.sandberg@arm.com void def_property_static_impl(const char *name, 85012037Sandreas.sandberg@arm.com handle fget, handle fset, 85112037Sandreas.sandberg@arm.com detail::function_record *rec_fget) { 85212037Sandreas.sandberg@arm.com const auto is_static = !(rec_fget->is_method && rec_fget->scope); 85312037Sandreas.sandberg@arm.com const auto has_doc = rec_fget->doc && pybind11::options::show_user_defined_docstrings(); 85412037Sandreas.sandberg@arm.com 85512037Sandreas.sandberg@arm.com auto property = handle((PyObject *) (is_static ? get_internals().static_property_type 85612037Sandreas.sandberg@arm.com : &PyProperty_Type)); 85712037Sandreas.sandberg@arm.com attr(name) = property(fget.ptr() ? fget : none(), 85812037Sandreas.sandberg@arm.com fset.ptr() ? fset : none(), 85912037Sandreas.sandberg@arm.com /*deleter*/none(), 86012037Sandreas.sandberg@arm.com pybind11::str(has_doc ? rec_fget->doc : "")); 86111986Sandreas.sandberg@arm.com } 86212037Sandreas.sandberg@arm.com}; 86311986Sandreas.sandberg@arm.com 86412037Sandreas.sandberg@arm.com/// Set the pointer to operator new if it exists. The cast is needed because it can be overloaded. 86512037Sandreas.sandberg@arm.comtemplate <typename T, typename = void_t<decltype(static_cast<void *(*)(size_t)>(T::operator new))>> 86612037Sandreas.sandberg@arm.comvoid set_operator_new(type_record *r) { r->operator_new = &T::operator new; } 86712037Sandreas.sandberg@arm.com 86812037Sandreas.sandberg@arm.comtemplate <typename> void set_operator_new(...) { } 86912037Sandreas.sandberg@arm.com 87012037Sandreas.sandberg@arm.com/// Call class-specific delete if it exists or global otherwise. Can also be an overload set. 87112037Sandreas.sandberg@arm.comtemplate <typename T, typename = void_t<decltype(static_cast<void (*)(void *)>(T::operator delete))>> 87212037Sandreas.sandberg@arm.comvoid call_operator_delete(T *p) { T::operator delete(p); } 87312037Sandreas.sandberg@arm.com 87412037Sandreas.sandberg@arm.cominline void call_operator_delete(void *p) { ::operator delete(p); } 87511986Sandreas.sandberg@arm.com 87611986Sandreas.sandberg@arm.comNAMESPACE_END(detail) 87711986Sandreas.sandberg@arm.com 87811986Sandreas.sandberg@arm.comtemplate <typename type_, typename... options> 87911986Sandreas.sandberg@arm.comclass class_ : public detail::generic_type { 88011986Sandreas.sandberg@arm.com template <typename T> using is_holder = detail::is_holder_type<type_, T>; 88111986Sandreas.sandberg@arm.com template <typename T> using is_subtype = detail::bool_constant<std::is_base_of<type_, T>::value && !std::is_same<T, type_>::value>; 88211986Sandreas.sandberg@arm.com template <typename T> using is_base = detail::bool_constant<std::is_base_of<T, type_>::value && !std::is_same<T, type_>::value>; 88312037Sandreas.sandberg@arm.com // struct instead of using here to help MSVC: 88412037Sandreas.sandberg@arm.com template <typename T> struct is_valid_class_option : 88512037Sandreas.sandberg@arm.com detail::any_of<is_holder<T>, is_subtype<T>, is_base<T>> {}; 88611986Sandreas.sandberg@arm.com 88711986Sandreas.sandberg@arm.compublic: 88811986Sandreas.sandberg@arm.com using type = type_; 88911986Sandreas.sandberg@arm.com using type_alias = detail::first_of_t<is_subtype, void, options...>; 89011986Sandreas.sandberg@arm.com constexpr static bool has_alias = !std::is_void<type_alias>::value; 89111986Sandreas.sandberg@arm.com using holder_type = detail::first_of_t<is_holder, std::unique_ptr<type>, options...>; 89211986Sandreas.sandberg@arm.com using instance_type = detail::instance<type, holder_type>; 89311986Sandreas.sandberg@arm.com 89412037Sandreas.sandberg@arm.com static_assert(detail::all_of<is_valid_class_option<options>...>::value, 89511986Sandreas.sandberg@arm.com "Unknown/invalid class_ template parameters provided"); 89611986Sandreas.sandberg@arm.com 89711986Sandreas.sandberg@arm.com PYBIND11_OBJECT(class_, generic_type, PyType_Check) 89811986Sandreas.sandberg@arm.com 89911986Sandreas.sandberg@arm.com template <typename... Extra> 90011986Sandreas.sandberg@arm.com class_(handle scope, const char *name, const Extra &... extra) { 90112037Sandreas.sandberg@arm.com using namespace detail; 90212037Sandreas.sandberg@arm.com 90312037Sandreas.sandberg@arm.com // MI can only be specified via class_ template options, not constructor parameters 90412037Sandreas.sandberg@arm.com static_assert( 90512037Sandreas.sandberg@arm.com none_of<is_pyobject<Extra>...>::value || // no base class arguments, or: 90612037Sandreas.sandberg@arm.com ( constexpr_sum(is_pyobject<Extra>::value...) == 1 && // Exactly one base 90712037Sandreas.sandberg@arm.com constexpr_sum(is_base<options>::value...) == 0 && // no template option bases 90812037Sandreas.sandberg@arm.com none_of<std::is_same<multiple_inheritance, Extra>...>::value), // no multiple_inheritance attr 90912037Sandreas.sandberg@arm.com "Error: multiple inheritance bases must be specified via class_ template options"); 91012037Sandreas.sandberg@arm.com 91112037Sandreas.sandberg@arm.com type_record record; 91211986Sandreas.sandberg@arm.com record.scope = scope; 91311986Sandreas.sandberg@arm.com record.name = name; 91411986Sandreas.sandberg@arm.com record.type = &typeid(type); 91512037Sandreas.sandberg@arm.com record.type_size = sizeof(conditional_t<has_alias, type_alias, type>); 91611986Sandreas.sandberg@arm.com record.instance_size = sizeof(instance_type); 91711986Sandreas.sandberg@arm.com record.init_holder = init_holder; 91811986Sandreas.sandberg@arm.com record.dealloc = dealloc; 91912037Sandreas.sandberg@arm.com record.default_holder = std::is_same<holder_type, std::unique_ptr<type>>::value; 92012037Sandreas.sandberg@arm.com 92112037Sandreas.sandberg@arm.com set_operator_new<type>(&record); 92211986Sandreas.sandberg@arm.com 92311986Sandreas.sandberg@arm.com /* Register base classes specified via template arguments to class_, if any */ 92411986Sandreas.sandberg@arm.com bool unused[] = { (add_base<options>(record), false)..., false }; 92511986Sandreas.sandberg@arm.com (void) unused; 92611986Sandreas.sandberg@arm.com 92711986Sandreas.sandberg@arm.com /* Process optional arguments, if any */ 92812037Sandreas.sandberg@arm.com process_attributes<Extra...>::init(extra..., &record); 92911986Sandreas.sandberg@arm.com 93012037Sandreas.sandberg@arm.com generic_type::initialize(record); 93111986Sandreas.sandberg@arm.com 93211986Sandreas.sandberg@arm.com if (has_alias) { 93312037Sandreas.sandberg@arm.com auto &instances = get_internals().registered_types_cpp; 93411986Sandreas.sandberg@arm.com instances[std::type_index(typeid(type_alias))] = instances[std::type_index(typeid(type))]; 93511986Sandreas.sandberg@arm.com } 93611986Sandreas.sandberg@arm.com } 93711986Sandreas.sandberg@arm.com 93811986Sandreas.sandberg@arm.com template <typename Base, detail::enable_if_t<is_base<Base>::value, int> = 0> 93911986Sandreas.sandberg@arm.com static void add_base(detail::type_record &rec) { 94011986Sandreas.sandberg@arm.com rec.add_base(&typeid(Base), [](void *src) -> void * { 94111986Sandreas.sandberg@arm.com return static_cast<Base *>(reinterpret_cast<type *>(src)); 94211986Sandreas.sandberg@arm.com }); 94311986Sandreas.sandberg@arm.com } 94411986Sandreas.sandberg@arm.com 94511986Sandreas.sandberg@arm.com template <typename Base, detail::enable_if_t<!is_base<Base>::value, int> = 0> 94611986Sandreas.sandberg@arm.com static void add_base(detail::type_record &) { } 94711986Sandreas.sandberg@arm.com 94811986Sandreas.sandberg@arm.com template <typename Func, typename... Extra> 94911986Sandreas.sandberg@arm.com class_ &def(const char *name_, Func&& f, const Extra&... extra) { 95011986Sandreas.sandberg@arm.com cpp_function cf(std::forward<Func>(f), name(name_), is_method(*this), 95111986Sandreas.sandberg@arm.com sibling(getattr(*this, name_, none())), extra...); 95211986Sandreas.sandberg@arm.com attr(cf.name()) = cf; 95311986Sandreas.sandberg@arm.com return *this; 95411986Sandreas.sandberg@arm.com } 95511986Sandreas.sandberg@arm.com 95611986Sandreas.sandberg@arm.com template <typename Func, typename... Extra> class_ & 95712037Sandreas.sandberg@arm.com def_static(const char *name_, Func &&f, const Extra&... extra) { 95812037Sandreas.sandberg@arm.com static_assert(!std::is_member_function_pointer<Func>::value, 95912037Sandreas.sandberg@arm.com "def_static(...) called with a non-static member function pointer"); 96011986Sandreas.sandberg@arm.com cpp_function cf(std::forward<Func>(f), name(name_), scope(*this), 96111986Sandreas.sandberg@arm.com sibling(getattr(*this, name_, none())), extra...); 96211986Sandreas.sandberg@arm.com attr(cf.name()) = cf; 96311986Sandreas.sandberg@arm.com return *this; 96411986Sandreas.sandberg@arm.com } 96511986Sandreas.sandberg@arm.com 96611986Sandreas.sandberg@arm.com template <detail::op_id id, detail::op_type ot, typename L, typename R, typename... Extra> 96711986Sandreas.sandberg@arm.com class_ &def(const detail::op_<id, ot, L, R> &op, const Extra&... extra) { 96811986Sandreas.sandberg@arm.com op.execute(*this, extra...); 96911986Sandreas.sandberg@arm.com return *this; 97011986Sandreas.sandberg@arm.com } 97111986Sandreas.sandberg@arm.com 97211986Sandreas.sandberg@arm.com template <detail::op_id id, detail::op_type ot, typename L, typename R, typename... Extra> 97311986Sandreas.sandberg@arm.com class_ & def_cast(const detail::op_<id, ot, L, R> &op, const Extra&... extra) { 97411986Sandreas.sandberg@arm.com op.execute_cast(*this, extra...); 97511986Sandreas.sandberg@arm.com return *this; 97611986Sandreas.sandberg@arm.com } 97711986Sandreas.sandberg@arm.com 97811986Sandreas.sandberg@arm.com template <typename... Args, typename... Extra> 97911986Sandreas.sandberg@arm.com class_ &def(const detail::init<Args...> &init, const Extra&... extra) { 98011986Sandreas.sandberg@arm.com init.execute(*this, extra...); 98111986Sandreas.sandberg@arm.com return *this; 98211986Sandreas.sandberg@arm.com } 98311986Sandreas.sandberg@arm.com 98411986Sandreas.sandberg@arm.com template <typename... Args, typename... Extra> 98511986Sandreas.sandberg@arm.com class_ &def(const detail::init_alias<Args...> &init, const Extra&... extra) { 98611986Sandreas.sandberg@arm.com init.execute(*this, extra...); 98711986Sandreas.sandberg@arm.com return *this; 98811986Sandreas.sandberg@arm.com } 98911986Sandreas.sandberg@arm.com 99011986Sandreas.sandberg@arm.com template <typename Func> class_& def_buffer(Func &&func) { 99111986Sandreas.sandberg@arm.com struct capture { Func func; }; 99211986Sandreas.sandberg@arm.com capture *ptr = new capture { std::forward<Func>(func) }; 99311986Sandreas.sandberg@arm.com install_buffer_funcs([](PyObject *obj, void *ptr) -> buffer_info* { 99412037Sandreas.sandberg@arm.com detail::make_caster<type> caster; 99511986Sandreas.sandberg@arm.com if (!caster.load(obj, false)) 99611986Sandreas.sandberg@arm.com return nullptr; 99711986Sandreas.sandberg@arm.com return new buffer_info(((capture *) ptr)->func(caster)); 99811986Sandreas.sandberg@arm.com }, ptr); 99911986Sandreas.sandberg@arm.com return *this; 100011986Sandreas.sandberg@arm.com } 100111986Sandreas.sandberg@arm.com 100211986Sandreas.sandberg@arm.com template <typename C, typename D, typename... Extra> 100311986Sandreas.sandberg@arm.com class_ &def_readwrite(const char *name, D C::*pm, const Extra&... extra) { 100411986Sandreas.sandberg@arm.com cpp_function fget([pm](const C &c) -> const D &{ return c.*pm; }, is_method(*this)), 100511986Sandreas.sandberg@arm.com fset([pm](C &c, const D &value) { c.*pm = value; }, is_method(*this)); 100611986Sandreas.sandberg@arm.com def_property(name, fget, fset, return_value_policy::reference_internal, extra...); 100711986Sandreas.sandberg@arm.com return *this; 100811986Sandreas.sandberg@arm.com } 100911986Sandreas.sandberg@arm.com 101011986Sandreas.sandberg@arm.com template <typename C, typename D, typename... Extra> 101111986Sandreas.sandberg@arm.com class_ &def_readonly(const char *name, const D C::*pm, const Extra& ...extra) { 101211986Sandreas.sandberg@arm.com cpp_function fget([pm](const C &c) -> const D &{ return c.*pm; }, is_method(*this)); 101311986Sandreas.sandberg@arm.com def_property_readonly(name, fget, return_value_policy::reference_internal, extra...); 101411986Sandreas.sandberg@arm.com return *this; 101511986Sandreas.sandberg@arm.com } 101611986Sandreas.sandberg@arm.com 101711986Sandreas.sandberg@arm.com template <typename D, typename... Extra> 101811986Sandreas.sandberg@arm.com class_ &def_readwrite_static(const char *name, D *pm, const Extra& ...extra) { 101911986Sandreas.sandberg@arm.com cpp_function fget([pm](object) -> const D &{ return *pm; }, scope(*this)), 102011986Sandreas.sandberg@arm.com fset([pm](object, const D &value) { *pm = value; }, scope(*this)); 102111986Sandreas.sandberg@arm.com def_property_static(name, fget, fset, return_value_policy::reference, extra...); 102211986Sandreas.sandberg@arm.com return *this; 102311986Sandreas.sandberg@arm.com } 102411986Sandreas.sandberg@arm.com 102511986Sandreas.sandberg@arm.com template <typename D, typename... Extra> 102611986Sandreas.sandberg@arm.com class_ &def_readonly_static(const char *name, const D *pm, const Extra& ...extra) { 102711986Sandreas.sandberg@arm.com cpp_function fget([pm](object) -> const D &{ return *pm; }, scope(*this)); 102811986Sandreas.sandberg@arm.com def_property_readonly_static(name, fget, return_value_policy::reference, extra...); 102911986Sandreas.sandberg@arm.com return *this; 103011986Sandreas.sandberg@arm.com } 103111986Sandreas.sandberg@arm.com 103211986Sandreas.sandberg@arm.com /// Uses return_value_policy::reference_internal by default 103311986Sandreas.sandberg@arm.com template <typename Getter, typename... Extra> 103411986Sandreas.sandberg@arm.com class_ &def_property_readonly(const char *name, const Getter &fget, const Extra& ...extra) { 103511986Sandreas.sandberg@arm.com return def_property_readonly(name, cpp_function(fget), return_value_policy::reference_internal, extra...); 103611986Sandreas.sandberg@arm.com } 103711986Sandreas.sandberg@arm.com 103811986Sandreas.sandberg@arm.com /// Uses cpp_function's return_value_policy by default 103911986Sandreas.sandberg@arm.com template <typename... Extra> 104011986Sandreas.sandberg@arm.com class_ &def_property_readonly(const char *name, const cpp_function &fget, const Extra& ...extra) { 104111986Sandreas.sandberg@arm.com return def_property(name, fget, cpp_function(), extra...); 104211986Sandreas.sandberg@arm.com } 104311986Sandreas.sandberg@arm.com 104411986Sandreas.sandberg@arm.com /// Uses return_value_policy::reference by default 104511986Sandreas.sandberg@arm.com template <typename Getter, typename... Extra> 104611986Sandreas.sandberg@arm.com class_ &def_property_readonly_static(const char *name, const Getter &fget, const Extra& ...extra) { 104711986Sandreas.sandberg@arm.com return def_property_readonly_static(name, cpp_function(fget), return_value_policy::reference, extra...); 104811986Sandreas.sandberg@arm.com } 104911986Sandreas.sandberg@arm.com 105011986Sandreas.sandberg@arm.com /// Uses cpp_function's return_value_policy by default 105111986Sandreas.sandberg@arm.com template <typename... Extra> 105211986Sandreas.sandberg@arm.com class_ &def_property_readonly_static(const char *name, const cpp_function &fget, const Extra& ...extra) { 105311986Sandreas.sandberg@arm.com return def_property_static(name, fget, cpp_function(), extra...); 105411986Sandreas.sandberg@arm.com } 105511986Sandreas.sandberg@arm.com 105611986Sandreas.sandberg@arm.com /// Uses return_value_policy::reference_internal by default 105711986Sandreas.sandberg@arm.com template <typename Getter, typename... Extra> 105811986Sandreas.sandberg@arm.com class_ &def_property(const char *name, const Getter &fget, const cpp_function &fset, const Extra& ...extra) { 105911986Sandreas.sandberg@arm.com return def_property(name, cpp_function(fget), fset, return_value_policy::reference_internal, extra...); 106011986Sandreas.sandberg@arm.com } 106111986Sandreas.sandberg@arm.com 106211986Sandreas.sandberg@arm.com /// Uses cpp_function's return_value_policy by default 106311986Sandreas.sandberg@arm.com template <typename... Extra> 106411986Sandreas.sandberg@arm.com class_ &def_property(const char *name, const cpp_function &fget, const cpp_function &fset, const Extra& ...extra) { 106511986Sandreas.sandberg@arm.com return def_property_static(name, fget, fset, is_method(*this), extra...); 106611986Sandreas.sandberg@arm.com } 106711986Sandreas.sandberg@arm.com 106811986Sandreas.sandberg@arm.com /// Uses return_value_policy::reference by default 106911986Sandreas.sandberg@arm.com template <typename Getter, typename... Extra> 107011986Sandreas.sandberg@arm.com class_ &def_property_static(const char *name, const Getter &fget, const cpp_function &fset, const Extra& ...extra) { 107111986Sandreas.sandberg@arm.com return def_property_static(name, cpp_function(fget), fset, return_value_policy::reference, extra...); 107211986Sandreas.sandberg@arm.com } 107311986Sandreas.sandberg@arm.com 107411986Sandreas.sandberg@arm.com /// Uses cpp_function's return_value_policy by default 107511986Sandreas.sandberg@arm.com template <typename... Extra> 107611986Sandreas.sandberg@arm.com class_ &def_property_static(const char *name, const cpp_function &fget, const cpp_function &fset, const Extra& ...extra) { 107711986Sandreas.sandberg@arm.com auto rec_fget = get_function_record(fget), rec_fset = get_function_record(fset); 107811986Sandreas.sandberg@arm.com char *doc_prev = rec_fget->doc; /* 'extra' field may include a property-specific documentation string */ 107911986Sandreas.sandberg@arm.com detail::process_attributes<Extra...>::init(extra..., rec_fget); 108011986Sandreas.sandberg@arm.com if (rec_fget->doc && rec_fget->doc != doc_prev) { 108111986Sandreas.sandberg@arm.com free(doc_prev); 108211986Sandreas.sandberg@arm.com rec_fget->doc = strdup(rec_fget->doc); 108311986Sandreas.sandberg@arm.com } 108411986Sandreas.sandberg@arm.com if (rec_fset) { 108511986Sandreas.sandberg@arm.com doc_prev = rec_fset->doc; 108611986Sandreas.sandberg@arm.com detail::process_attributes<Extra...>::init(extra..., rec_fset); 108711986Sandreas.sandberg@arm.com if (rec_fset->doc && rec_fset->doc != doc_prev) { 108811986Sandreas.sandberg@arm.com free(doc_prev); 108911986Sandreas.sandberg@arm.com rec_fset->doc = strdup(rec_fset->doc); 109011986Sandreas.sandberg@arm.com } 109111986Sandreas.sandberg@arm.com } 109212037Sandreas.sandberg@arm.com def_property_static_impl(name, fget, fset, rec_fget); 109311986Sandreas.sandberg@arm.com return *this; 109411986Sandreas.sandberg@arm.com } 109511986Sandreas.sandberg@arm.com 109611986Sandreas.sandberg@arm.comprivate: 109711986Sandreas.sandberg@arm.com /// Initialize holder object, variant 1: object derives from enable_shared_from_this 109811986Sandreas.sandberg@arm.com template <typename T> 109911986Sandreas.sandberg@arm.com static void init_holder_helper(instance_type *inst, const holder_type * /* unused */, const std::enable_shared_from_this<T> * /* dummy */) { 110011986Sandreas.sandberg@arm.com try { 110111986Sandreas.sandberg@arm.com new (&inst->holder) holder_type(std::static_pointer_cast<typename holder_type::element_type>(inst->value->shared_from_this())); 110211986Sandreas.sandberg@arm.com inst->holder_constructed = true; 110311986Sandreas.sandberg@arm.com } catch (const std::bad_weak_ptr &) { 110411986Sandreas.sandberg@arm.com if (inst->owned) { 110511986Sandreas.sandberg@arm.com new (&inst->holder) holder_type(inst->value); 110611986Sandreas.sandberg@arm.com inst->holder_constructed = true; 110711986Sandreas.sandberg@arm.com } 110811986Sandreas.sandberg@arm.com } 110911986Sandreas.sandberg@arm.com } 111011986Sandreas.sandberg@arm.com 111112037Sandreas.sandberg@arm.com static void init_holder_from_existing(instance_type *inst, const holder_type *holder_ptr, 111212037Sandreas.sandberg@arm.com std::true_type /*is_copy_constructible*/) { 111312037Sandreas.sandberg@arm.com new (&inst->holder) holder_type(*holder_ptr); 111412037Sandreas.sandberg@arm.com } 111512037Sandreas.sandberg@arm.com 111612037Sandreas.sandberg@arm.com static void init_holder_from_existing(instance_type *inst, const holder_type *holder_ptr, 111712037Sandreas.sandberg@arm.com std::false_type /*is_copy_constructible*/) { 111812037Sandreas.sandberg@arm.com new (&inst->holder) holder_type(std::move(*const_cast<holder_type *>(holder_ptr))); 111912037Sandreas.sandberg@arm.com } 112012037Sandreas.sandberg@arm.com 112111986Sandreas.sandberg@arm.com /// Initialize holder object, variant 2: try to construct from existing holder object, if possible 112211986Sandreas.sandberg@arm.com static void init_holder_helper(instance_type *inst, const holder_type *holder_ptr, const void * /* dummy */) { 112311986Sandreas.sandberg@arm.com if (holder_ptr) { 112412037Sandreas.sandberg@arm.com init_holder_from_existing(inst, holder_ptr, std::is_copy_constructible<holder_type>()); 112511986Sandreas.sandberg@arm.com inst->holder_constructed = true; 112612037Sandreas.sandberg@arm.com } else if (inst->owned || detail::always_construct_holder<holder_type>::value) { 112711986Sandreas.sandberg@arm.com new (&inst->holder) holder_type(inst->value); 112811986Sandreas.sandberg@arm.com inst->holder_constructed = true; 112911986Sandreas.sandberg@arm.com } 113011986Sandreas.sandberg@arm.com } 113111986Sandreas.sandberg@arm.com 113211986Sandreas.sandberg@arm.com /// Initialize holder object of an instance, possibly given a pointer to an existing holder 113311986Sandreas.sandberg@arm.com static void init_holder(PyObject *inst_, const void *holder_ptr) { 113411986Sandreas.sandberg@arm.com auto inst = (instance_type *) inst_; 113511986Sandreas.sandberg@arm.com init_holder_helper(inst, (const holder_type *) holder_ptr, inst->value); 113611986Sandreas.sandberg@arm.com } 113711986Sandreas.sandberg@arm.com 113811986Sandreas.sandberg@arm.com static void dealloc(PyObject *inst_) { 113911986Sandreas.sandberg@arm.com instance_type *inst = (instance_type *) inst_; 114011986Sandreas.sandberg@arm.com if (inst->holder_constructed) 114111986Sandreas.sandberg@arm.com inst->holder.~holder_type(); 114211986Sandreas.sandberg@arm.com else if (inst->owned) 114312037Sandreas.sandberg@arm.com detail::call_operator_delete(inst->value); 114411986Sandreas.sandberg@arm.com } 114511986Sandreas.sandberg@arm.com 114611986Sandreas.sandberg@arm.com static detail::function_record *get_function_record(handle h) { 114711986Sandreas.sandberg@arm.com h = detail::get_function(h); 114812037Sandreas.sandberg@arm.com return h ? (detail::function_record *) reinterpret_borrow<capsule>(PyCFunction_GET_SELF(h.ptr())) 114911986Sandreas.sandberg@arm.com : nullptr; 115011986Sandreas.sandberg@arm.com } 115111986Sandreas.sandberg@arm.com}; 115211986Sandreas.sandberg@arm.com 115311986Sandreas.sandberg@arm.com/// Binds C++ enumerations and enumeration classes to Python 115411986Sandreas.sandberg@arm.comtemplate <typename Type> class enum_ : public class_<Type> { 115511986Sandreas.sandberg@arm.compublic: 115611986Sandreas.sandberg@arm.com using class_<Type>::def; 115712037Sandreas.sandberg@arm.com using class_<Type>::def_property_readonly_static; 115811986Sandreas.sandberg@arm.com using Scalar = typename std::underlying_type<Type>::type; 115911986Sandreas.sandberg@arm.com template <typename T> using arithmetic_tag = std::is_same<T, arithmetic>; 116011986Sandreas.sandberg@arm.com 116111986Sandreas.sandberg@arm.com template <typename... Extra> 116211986Sandreas.sandberg@arm.com enum_(const handle &scope, const char *name, const Extra&... extra) 116312037Sandreas.sandberg@arm.com : class_<Type>(scope, name, extra...), m_entries(), m_parent(scope) { 116411986Sandreas.sandberg@arm.com 116511986Sandreas.sandberg@arm.com constexpr bool is_arithmetic = 116611986Sandreas.sandberg@arm.com !std::is_same<detail::first_of_t<arithmetic_tag, void, Extra...>, 116711986Sandreas.sandberg@arm.com void>::value; 116811986Sandreas.sandberg@arm.com 116912037Sandreas.sandberg@arm.com auto m_entries_ptr = m_entries.inc_ref().ptr(); 117012037Sandreas.sandberg@arm.com def("__repr__", [name, m_entries_ptr](Type value) -> pybind11::str { 117112037Sandreas.sandberg@arm.com for (const auto &kv : reinterpret_borrow<dict>(m_entries_ptr)) { 117212037Sandreas.sandberg@arm.com if (pybind11::cast<Type>(kv.second) == value) 117312037Sandreas.sandberg@arm.com return pybind11::str("{}.{}").format(name, kv.first); 117412037Sandreas.sandberg@arm.com } 117512037Sandreas.sandberg@arm.com return pybind11::str("{}.???").format(name); 117611986Sandreas.sandberg@arm.com }); 117712037Sandreas.sandberg@arm.com def_property_readonly_static("__members__", [m_entries_ptr](object /* self */) { 117812037Sandreas.sandberg@arm.com dict m; 117912037Sandreas.sandberg@arm.com for (const auto &kv : reinterpret_borrow<dict>(m_entries_ptr)) 118012037Sandreas.sandberg@arm.com m[kv.first] = kv.second; 118112037Sandreas.sandberg@arm.com return m; 118212037Sandreas.sandberg@arm.com }, return_value_policy::copy); 118311986Sandreas.sandberg@arm.com def("__init__", [](Type& value, Scalar i) { value = (Type)i; }); 118411986Sandreas.sandberg@arm.com def("__int__", [](Type value) { return (Scalar) value; }); 118511986Sandreas.sandberg@arm.com def("__eq__", [](const Type &value, Type *value2) { return value2 && value == *value2; }); 118611986Sandreas.sandberg@arm.com def("__ne__", [](const Type &value, Type *value2) { return !value2 || value != *value2; }); 118711986Sandreas.sandberg@arm.com if (is_arithmetic) { 118811986Sandreas.sandberg@arm.com def("__lt__", [](const Type &value, Type *value2) { return value2 && value < *value2; }); 118911986Sandreas.sandberg@arm.com def("__gt__", [](const Type &value, Type *value2) { return value2 && value > *value2; }); 119011986Sandreas.sandberg@arm.com def("__le__", [](const Type &value, Type *value2) { return value2 && value <= *value2; }); 119111986Sandreas.sandberg@arm.com def("__ge__", [](const Type &value, Type *value2) { return value2 && value >= *value2; }); 119211986Sandreas.sandberg@arm.com } 119311986Sandreas.sandberg@arm.com if (std::is_convertible<Type, Scalar>::value) { 119411986Sandreas.sandberg@arm.com // Don't provide comparison with the underlying type if the enum isn't convertible, 119511986Sandreas.sandberg@arm.com // i.e. if Type is a scoped enum, mirroring the C++ behaviour. (NB: we explicitly 119611986Sandreas.sandberg@arm.com // convert Type to Scalar below anyway because this needs to compile). 119711986Sandreas.sandberg@arm.com def("__eq__", [](const Type &value, Scalar value2) { return (Scalar) value == value2; }); 119811986Sandreas.sandberg@arm.com def("__ne__", [](const Type &value, Scalar value2) { return (Scalar) value != value2; }); 119911986Sandreas.sandberg@arm.com if (is_arithmetic) { 120011986Sandreas.sandberg@arm.com def("__lt__", [](const Type &value, Scalar value2) { return (Scalar) value < value2; }); 120111986Sandreas.sandberg@arm.com def("__gt__", [](const Type &value, Scalar value2) { return (Scalar) value > value2; }); 120211986Sandreas.sandberg@arm.com def("__le__", [](const Type &value, Scalar value2) { return (Scalar) value <= value2; }); 120311986Sandreas.sandberg@arm.com def("__ge__", [](const Type &value, Scalar value2) { return (Scalar) value >= value2; }); 120411986Sandreas.sandberg@arm.com def("__invert__", [](const Type &value) { return ~((Scalar) value); }); 120511986Sandreas.sandberg@arm.com def("__and__", [](const Type &value, Scalar value2) { return (Scalar) value & value2; }); 120611986Sandreas.sandberg@arm.com def("__or__", [](const Type &value, Scalar value2) { return (Scalar) value | value2; }); 120711986Sandreas.sandberg@arm.com def("__xor__", [](const Type &value, Scalar value2) { return (Scalar) value ^ value2; }); 120811986Sandreas.sandberg@arm.com def("__rand__", [](const Type &value, Scalar value2) { return (Scalar) value & value2; }); 120911986Sandreas.sandberg@arm.com def("__ror__", [](const Type &value, Scalar value2) { return (Scalar) value | value2; }); 121011986Sandreas.sandberg@arm.com def("__rxor__", [](const Type &value, Scalar value2) { return (Scalar) value ^ value2; }); 121111986Sandreas.sandberg@arm.com def("__and__", [](const Type &value, const Type &value2) { return (Scalar) value & (Scalar) value2; }); 121211986Sandreas.sandberg@arm.com def("__or__", [](const Type &value, const Type &value2) { return (Scalar) value | (Scalar) value2; }); 121311986Sandreas.sandberg@arm.com def("__xor__", [](const Type &value, const Type &value2) { return (Scalar) value ^ (Scalar) value2; }); 121411986Sandreas.sandberg@arm.com } 121511986Sandreas.sandberg@arm.com } 121611986Sandreas.sandberg@arm.com def("__hash__", [](const Type &value) { return (Scalar) value; }); 121711986Sandreas.sandberg@arm.com // Pickling and unpickling -- needed for use with the 'multiprocessing' module 121811986Sandreas.sandberg@arm.com def("__getstate__", [](const Type &value) { return pybind11::make_tuple((Scalar) value); }); 121911986Sandreas.sandberg@arm.com def("__setstate__", [](Type &p, tuple t) { new (&p) Type((Type) t[0].cast<Scalar>()); }); 122011986Sandreas.sandberg@arm.com } 122111986Sandreas.sandberg@arm.com 122211986Sandreas.sandberg@arm.com /// Export enumeration entries into the parent scope 122312037Sandreas.sandberg@arm.com enum_& export_values() { 122412037Sandreas.sandberg@arm.com for (const auto &kv : m_entries) 122512037Sandreas.sandberg@arm.com m_parent.attr(kv.first) = kv.second; 122611986Sandreas.sandberg@arm.com return *this; 122711986Sandreas.sandberg@arm.com } 122811986Sandreas.sandberg@arm.com 122911986Sandreas.sandberg@arm.com /// Add an enumeration entry 123011986Sandreas.sandberg@arm.com enum_& value(char const* name, Type value) { 123112037Sandreas.sandberg@arm.com auto v = pybind11::cast(value, return_value_policy::copy); 123212037Sandreas.sandberg@arm.com this->attr(name) = v; 123312037Sandreas.sandberg@arm.com m_entries[pybind11::str(name)] = v; 123411986Sandreas.sandberg@arm.com return *this; 123511986Sandreas.sandberg@arm.com } 123612037Sandreas.sandberg@arm.com 123711986Sandreas.sandberg@arm.comprivate: 123812037Sandreas.sandberg@arm.com dict m_entries; 123911986Sandreas.sandberg@arm.com handle m_parent; 124011986Sandreas.sandberg@arm.com}; 124111986Sandreas.sandberg@arm.com 124211986Sandreas.sandberg@arm.comNAMESPACE_BEGIN(detail) 124311986Sandreas.sandberg@arm.comtemplate <typename... Args> struct init { 124411986Sandreas.sandberg@arm.com template <typename Class, typename... Extra, enable_if_t<!Class::has_alias, int> = 0> 124511986Sandreas.sandberg@arm.com static void execute(Class &cl, const Extra&... extra) { 124611986Sandreas.sandberg@arm.com using Base = typename Class::type; 124711986Sandreas.sandberg@arm.com /// Function which calls a specific C++ in-place constructor 124811986Sandreas.sandberg@arm.com cl.def("__init__", [](Base *self_, Args... args) { new (self_) Base(args...); }, extra...); 124911986Sandreas.sandberg@arm.com } 125011986Sandreas.sandberg@arm.com 125111986Sandreas.sandberg@arm.com template <typename Class, typename... Extra, 125211986Sandreas.sandberg@arm.com enable_if_t<Class::has_alias && 125311986Sandreas.sandberg@arm.com std::is_constructible<typename Class::type, Args...>::value, int> = 0> 125411986Sandreas.sandberg@arm.com static void execute(Class &cl, const Extra&... extra) { 125511986Sandreas.sandberg@arm.com using Base = typename Class::type; 125611986Sandreas.sandberg@arm.com using Alias = typename Class::type_alias; 125711986Sandreas.sandberg@arm.com handle cl_type = cl; 125811986Sandreas.sandberg@arm.com cl.def("__init__", [cl_type](handle self_, Args... args) { 125911986Sandreas.sandberg@arm.com if (self_.get_type() == cl_type) 126011986Sandreas.sandberg@arm.com new (self_.cast<Base *>()) Base(args...); 126111986Sandreas.sandberg@arm.com else 126211986Sandreas.sandberg@arm.com new (self_.cast<Alias *>()) Alias(args...); 126311986Sandreas.sandberg@arm.com }, extra...); 126411986Sandreas.sandberg@arm.com } 126511986Sandreas.sandberg@arm.com 126611986Sandreas.sandberg@arm.com template <typename Class, typename... Extra, 126711986Sandreas.sandberg@arm.com enable_if_t<Class::has_alias && 126811986Sandreas.sandberg@arm.com !std::is_constructible<typename Class::type, Args...>::value, int> = 0> 126911986Sandreas.sandberg@arm.com static void execute(Class &cl, const Extra&... extra) { 127011986Sandreas.sandberg@arm.com init_alias<Args...>::execute(cl, extra...); 127111986Sandreas.sandberg@arm.com } 127211986Sandreas.sandberg@arm.com}; 127311986Sandreas.sandberg@arm.comtemplate <typename... Args> struct init_alias { 127411986Sandreas.sandberg@arm.com template <typename Class, typename... Extra, 127511986Sandreas.sandberg@arm.com enable_if_t<Class::has_alias && std::is_constructible<typename Class::type_alias, Args...>::value, int> = 0> 127611986Sandreas.sandberg@arm.com static void execute(Class &cl, const Extra&... extra) { 127711986Sandreas.sandberg@arm.com using Alias = typename Class::type_alias; 127811986Sandreas.sandberg@arm.com cl.def("__init__", [](Alias *self_, Args... args) { new (self_) Alias(args...); }, extra...); 127911986Sandreas.sandberg@arm.com } 128011986Sandreas.sandberg@arm.com}; 128111986Sandreas.sandberg@arm.com 128211986Sandreas.sandberg@arm.com 128311986Sandreas.sandberg@arm.cominline void keep_alive_impl(handle nurse, handle patient) { 128411986Sandreas.sandberg@arm.com /* Clever approach based on weak references taken from Boost.Python */ 128511986Sandreas.sandberg@arm.com if (!nurse || !patient) 128611986Sandreas.sandberg@arm.com pybind11_fail("Could not activate keep_alive!"); 128711986Sandreas.sandberg@arm.com 128811986Sandreas.sandberg@arm.com if (patient.is_none() || nurse.is_none()) 128911986Sandreas.sandberg@arm.com return; /* Nothing to keep alive or nothing to be kept alive by */ 129011986Sandreas.sandberg@arm.com 129111986Sandreas.sandberg@arm.com cpp_function disable_lifesupport( 129211986Sandreas.sandberg@arm.com [patient](handle weakref) { patient.dec_ref(); weakref.dec_ref(); }); 129311986Sandreas.sandberg@arm.com 129411986Sandreas.sandberg@arm.com weakref wr(nurse, disable_lifesupport); 129511986Sandreas.sandberg@arm.com 129611986Sandreas.sandberg@arm.com patient.inc_ref(); /* reference patient and leak the weak reference */ 129711986Sandreas.sandberg@arm.com (void) wr.release(); 129811986Sandreas.sandberg@arm.com} 129911986Sandreas.sandberg@arm.com 130012037Sandreas.sandberg@arm.comPYBIND11_NOINLINE inline void keep_alive_impl(size_t Nurse, size_t Patient, function_call &call, handle ret) { 130112037Sandreas.sandberg@arm.com keep_alive_impl( 130212037Sandreas.sandberg@arm.com Nurse == 0 ? ret : Nurse <= call.args.size() ? call.args[Nurse - 1] : handle(), 130312037Sandreas.sandberg@arm.com Patient == 0 ? ret : Patient <= call.args.size() ? call.args[Patient - 1] : handle() 130412037Sandreas.sandberg@arm.com ); 130511986Sandreas.sandberg@arm.com} 130611986Sandreas.sandberg@arm.com 130711986Sandreas.sandberg@arm.comtemplate <typename Iterator, typename Sentinel, bool KeyIterator, return_value_policy Policy> 130811986Sandreas.sandberg@arm.comstruct iterator_state { 130911986Sandreas.sandberg@arm.com Iterator it; 131011986Sandreas.sandberg@arm.com Sentinel end; 131111986Sandreas.sandberg@arm.com bool first; 131211986Sandreas.sandberg@arm.com}; 131311986Sandreas.sandberg@arm.com 131411986Sandreas.sandberg@arm.comNAMESPACE_END(detail) 131511986Sandreas.sandberg@arm.com 131611986Sandreas.sandberg@arm.comtemplate <typename... Args> detail::init<Args...> init() { return detail::init<Args...>(); } 131711986Sandreas.sandberg@arm.comtemplate <typename... Args> detail::init_alias<Args...> init_alias() { return detail::init_alias<Args...>(); } 131811986Sandreas.sandberg@arm.com 131912037Sandreas.sandberg@arm.com/// Makes a python iterator from a first and past-the-end C++ InputIterator. 132011986Sandreas.sandberg@arm.comtemplate <return_value_policy Policy = return_value_policy::reference_internal, 132111986Sandreas.sandberg@arm.com typename Iterator, 132211986Sandreas.sandberg@arm.com typename Sentinel, 132311986Sandreas.sandberg@arm.com typename ValueType = decltype(*std::declval<Iterator>()), 132411986Sandreas.sandberg@arm.com typename... Extra> 132511986Sandreas.sandberg@arm.comiterator make_iterator(Iterator first, Sentinel last, Extra &&... extra) { 132611986Sandreas.sandberg@arm.com typedef detail::iterator_state<Iterator, Sentinel, false, Policy> state; 132711986Sandreas.sandberg@arm.com 132811986Sandreas.sandberg@arm.com if (!detail::get_type_info(typeid(state), false)) { 132911986Sandreas.sandberg@arm.com class_<state>(handle(), "iterator") 133011986Sandreas.sandberg@arm.com .def("__iter__", [](state &s) -> state& { return s; }) 133111986Sandreas.sandberg@arm.com .def("__next__", [](state &s) -> ValueType { 133211986Sandreas.sandberg@arm.com if (!s.first) 133311986Sandreas.sandberg@arm.com ++s.it; 133411986Sandreas.sandberg@arm.com else 133511986Sandreas.sandberg@arm.com s.first = false; 133611986Sandreas.sandberg@arm.com if (s.it == s.end) 133711986Sandreas.sandberg@arm.com throw stop_iteration(); 133811986Sandreas.sandberg@arm.com return *s.it; 133911986Sandreas.sandberg@arm.com }, std::forward<Extra>(extra)..., Policy); 134011986Sandreas.sandberg@arm.com } 134111986Sandreas.sandberg@arm.com 134211986Sandreas.sandberg@arm.com return (iterator) cast(state { first, last, true }); 134311986Sandreas.sandberg@arm.com} 134411986Sandreas.sandberg@arm.com 134512037Sandreas.sandberg@arm.com/// Makes an python iterator over the keys (`.first`) of a iterator over pairs from a 134612037Sandreas.sandberg@arm.com/// first and past-the-end InputIterator. 134711986Sandreas.sandberg@arm.comtemplate <return_value_policy Policy = return_value_policy::reference_internal, 134811986Sandreas.sandberg@arm.com typename Iterator, 134911986Sandreas.sandberg@arm.com typename Sentinel, 135011986Sandreas.sandberg@arm.com typename KeyType = decltype((*std::declval<Iterator>()).first), 135111986Sandreas.sandberg@arm.com typename... Extra> 135211986Sandreas.sandberg@arm.comiterator make_key_iterator(Iterator first, Sentinel last, Extra &&... extra) { 135311986Sandreas.sandberg@arm.com typedef detail::iterator_state<Iterator, Sentinel, true, Policy> state; 135411986Sandreas.sandberg@arm.com 135511986Sandreas.sandberg@arm.com if (!detail::get_type_info(typeid(state), false)) { 135611986Sandreas.sandberg@arm.com class_<state>(handle(), "iterator") 135711986Sandreas.sandberg@arm.com .def("__iter__", [](state &s) -> state& { return s; }) 135811986Sandreas.sandberg@arm.com .def("__next__", [](state &s) -> KeyType { 135911986Sandreas.sandberg@arm.com if (!s.first) 136011986Sandreas.sandberg@arm.com ++s.it; 136111986Sandreas.sandberg@arm.com else 136211986Sandreas.sandberg@arm.com s.first = false; 136311986Sandreas.sandberg@arm.com if (s.it == s.end) 136411986Sandreas.sandberg@arm.com throw stop_iteration(); 136511986Sandreas.sandberg@arm.com return (*s.it).first; 136611986Sandreas.sandberg@arm.com }, std::forward<Extra>(extra)..., Policy); 136711986Sandreas.sandberg@arm.com } 136811986Sandreas.sandberg@arm.com 136911986Sandreas.sandberg@arm.com return (iterator) cast(state { first, last, true }); 137011986Sandreas.sandberg@arm.com} 137111986Sandreas.sandberg@arm.com 137212037Sandreas.sandberg@arm.com/// Makes an iterator over values of an stl container or other container supporting 137312037Sandreas.sandberg@arm.com/// `std::begin()`/`std::end()` 137411986Sandreas.sandberg@arm.comtemplate <return_value_policy Policy = return_value_policy::reference_internal, 137511986Sandreas.sandberg@arm.com typename Type, typename... Extra> iterator make_iterator(Type &value, Extra&&... extra) { 137611986Sandreas.sandberg@arm.com return make_iterator<Policy>(std::begin(value), std::end(value), extra...); 137711986Sandreas.sandberg@arm.com} 137811986Sandreas.sandberg@arm.com 137912037Sandreas.sandberg@arm.com/// Makes an iterator over the keys (`.first`) of a stl map-like container supporting 138012037Sandreas.sandberg@arm.com/// `std::begin()`/`std::end()` 138111986Sandreas.sandberg@arm.comtemplate <return_value_policy Policy = return_value_policy::reference_internal, 138211986Sandreas.sandberg@arm.com typename Type, typename... Extra> iterator make_key_iterator(Type &value, Extra&&... extra) { 138311986Sandreas.sandberg@arm.com return make_key_iterator<Policy>(std::begin(value), std::end(value), extra...); 138411986Sandreas.sandberg@arm.com} 138511986Sandreas.sandberg@arm.com 138611986Sandreas.sandberg@arm.comtemplate <typename InputType, typename OutputType> void implicitly_convertible() { 138711986Sandreas.sandberg@arm.com auto implicit_caster = [](PyObject *obj, PyTypeObject *type) -> PyObject * { 138812037Sandreas.sandberg@arm.com if (!detail::make_caster<InputType>().load(obj, false)) 138911986Sandreas.sandberg@arm.com return nullptr; 139011986Sandreas.sandberg@arm.com tuple args(1); 139111986Sandreas.sandberg@arm.com args[0] = obj; 139211986Sandreas.sandberg@arm.com PyObject *result = PyObject_Call((PyObject *) type, args.ptr(), nullptr); 139311986Sandreas.sandberg@arm.com if (result == nullptr) 139411986Sandreas.sandberg@arm.com PyErr_Clear(); 139511986Sandreas.sandberg@arm.com return result; 139611986Sandreas.sandberg@arm.com }; 139711986Sandreas.sandberg@arm.com 139811986Sandreas.sandberg@arm.com if (auto tinfo = detail::get_type_info(typeid(OutputType))) 139911986Sandreas.sandberg@arm.com tinfo->implicit_conversions.push_back(implicit_caster); 140011986Sandreas.sandberg@arm.com else 140111986Sandreas.sandberg@arm.com pybind11_fail("implicitly_convertible: Unable to find type " + type_id<OutputType>()); 140211986Sandreas.sandberg@arm.com} 140311986Sandreas.sandberg@arm.com 140411986Sandreas.sandberg@arm.comtemplate <typename ExceptionTranslator> 140511986Sandreas.sandberg@arm.comvoid register_exception_translator(ExceptionTranslator&& translator) { 140611986Sandreas.sandberg@arm.com detail::get_internals().registered_exception_translators.push_front( 140711986Sandreas.sandberg@arm.com std::forward<ExceptionTranslator>(translator)); 140811986Sandreas.sandberg@arm.com} 140911986Sandreas.sandberg@arm.com 141011986Sandreas.sandberg@arm.com/* Wrapper to generate a new Python exception type. 141111986Sandreas.sandberg@arm.com * 141211986Sandreas.sandberg@arm.com * This should only be used with PyErr_SetString for now. 141311986Sandreas.sandberg@arm.com * It is not (yet) possible to use as a py::base. 141411986Sandreas.sandberg@arm.com * Template type argument is reserved for future use. 141511986Sandreas.sandberg@arm.com */ 141611986Sandreas.sandberg@arm.comtemplate <typename type> 141711986Sandreas.sandberg@arm.comclass exception : public object { 141811986Sandreas.sandberg@arm.compublic: 141911986Sandreas.sandberg@arm.com exception(handle scope, const char *name, PyObject *base = PyExc_Exception) { 142011986Sandreas.sandberg@arm.com std::string full_name = scope.attr("__name__").cast<std::string>() + 142111986Sandreas.sandberg@arm.com std::string(".") + name; 142212037Sandreas.sandberg@arm.com m_ptr = PyErr_NewException(const_cast<char *>(full_name.c_str()), base, NULL); 142311986Sandreas.sandberg@arm.com if (hasattr(scope, name)) 142411986Sandreas.sandberg@arm.com pybind11_fail("Error during initialization: multiple incompatible " 142511986Sandreas.sandberg@arm.com "definitions with name \"" + std::string(name) + "\""); 142611986Sandreas.sandberg@arm.com scope.attr(name) = *this; 142711986Sandreas.sandberg@arm.com } 142811986Sandreas.sandberg@arm.com 142911986Sandreas.sandberg@arm.com // Sets the current python exception to this exception object with the given message 143011986Sandreas.sandberg@arm.com void operator()(const char *message) { 143111986Sandreas.sandberg@arm.com PyErr_SetString(m_ptr, message); 143211986Sandreas.sandberg@arm.com } 143311986Sandreas.sandberg@arm.com}; 143411986Sandreas.sandberg@arm.com 143511986Sandreas.sandberg@arm.com/** Registers a Python exception in `m` of the given `name` and installs an exception translator to 143611986Sandreas.sandberg@arm.com * translate the C++ exception to the created Python exception using the exceptions what() method. 143711986Sandreas.sandberg@arm.com * This is intended for simple exception translations; for more complex translation, register the 143811986Sandreas.sandberg@arm.com * exception object and translator directly. 143911986Sandreas.sandberg@arm.com */ 144011986Sandreas.sandberg@arm.comtemplate <typename CppException> 144111986Sandreas.sandberg@arm.comexception<CppException> ®ister_exception(handle scope, 144211986Sandreas.sandberg@arm.com const char *name, 144311986Sandreas.sandberg@arm.com PyObject *base = PyExc_Exception) { 144411986Sandreas.sandberg@arm.com static exception<CppException> ex(scope, name, base); 144511986Sandreas.sandberg@arm.com register_exception_translator([](std::exception_ptr p) { 144611986Sandreas.sandberg@arm.com if (!p) return; 144711986Sandreas.sandberg@arm.com try { 144811986Sandreas.sandberg@arm.com std::rethrow_exception(p); 144911986Sandreas.sandberg@arm.com } catch (const CppException &e) { 145011986Sandreas.sandberg@arm.com ex(e.what()); 145111986Sandreas.sandberg@arm.com } 145211986Sandreas.sandberg@arm.com }); 145311986Sandreas.sandberg@arm.com return ex; 145411986Sandreas.sandberg@arm.com} 145511986Sandreas.sandberg@arm.com 145611986Sandreas.sandberg@arm.comNAMESPACE_BEGIN(detail) 145711986Sandreas.sandberg@arm.comPYBIND11_NOINLINE inline void print(tuple args, dict kwargs) { 145811986Sandreas.sandberg@arm.com auto strings = tuple(args.size()); 145911986Sandreas.sandberg@arm.com for (size_t i = 0; i < args.size(); ++i) { 146011986Sandreas.sandberg@arm.com strings[i] = str(args[i]); 146111986Sandreas.sandberg@arm.com } 146211986Sandreas.sandberg@arm.com auto sep = kwargs.contains("sep") ? kwargs["sep"] : cast(" "); 146311986Sandreas.sandberg@arm.com auto line = sep.attr("join")(strings); 146411986Sandreas.sandberg@arm.com 146511986Sandreas.sandberg@arm.com object file; 146611986Sandreas.sandberg@arm.com if (kwargs.contains("file")) { 146711986Sandreas.sandberg@arm.com file = kwargs["file"].cast<object>(); 146811986Sandreas.sandberg@arm.com } else { 146911986Sandreas.sandberg@arm.com try { 147011986Sandreas.sandberg@arm.com file = module::import("sys").attr("stdout"); 147111986Sandreas.sandberg@arm.com } catch (const error_already_set &) { 147211986Sandreas.sandberg@arm.com /* If print() is called from code that is executed as 147311986Sandreas.sandberg@arm.com part of garbage collection during interpreter shutdown, 147411986Sandreas.sandberg@arm.com importing 'sys' can fail. Give up rather than crashing the 147511986Sandreas.sandberg@arm.com interpreter in this case. */ 147611986Sandreas.sandberg@arm.com return; 147711986Sandreas.sandberg@arm.com } 147811986Sandreas.sandberg@arm.com } 147911986Sandreas.sandberg@arm.com 148011986Sandreas.sandberg@arm.com auto write = file.attr("write"); 148111986Sandreas.sandberg@arm.com write(line); 148211986Sandreas.sandberg@arm.com write(kwargs.contains("end") ? kwargs["end"] : cast("\n")); 148311986Sandreas.sandberg@arm.com 148411986Sandreas.sandberg@arm.com if (kwargs.contains("flush") && kwargs["flush"].cast<bool>()) 148511986Sandreas.sandberg@arm.com file.attr("flush")(); 148611986Sandreas.sandberg@arm.com} 148711986Sandreas.sandberg@arm.comNAMESPACE_END(detail) 148811986Sandreas.sandberg@arm.com 148911986Sandreas.sandberg@arm.comtemplate <return_value_policy policy = return_value_policy::automatic_reference, typename... Args> 149011986Sandreas.sandberg@arm.comvoid print(Args &&...args) { 149111986Sandreas.sandberg@arm.com auto c = detail::collect_arguments<policy>(std::forward<Args>(args)...); 149211986Sandreas.sandberg@arm.com detail::print(c.args(), c.kwargs()); 149311986Sandreas.sandberg@arm.com} 149411986Sandreas.sandberg@arm.com 149512037Sandreas.sandberg@arm.com#if defined(WITH_THREAD) && !defined(PYPY_VERSION) 149611986Sandreas.sandberg@arm.com 149711986Sandreas.sandberg@arm.com/* The functions below essentially reproduce the PyGILState_* API using a RAII 149811986Sandreas.sandberg@arm.com * pattern, but there are a few important differences: 149911986Sandreas.sandberg@arm.com * 150011986Sandreas.sandberg@arm.com * 1. When acquiring the GIL from an non-main thread during the finalization 150111986Sandreas.sandberg@arm.com * phase, the GILState API blindly terminates the calling thread, which 150211986Sandreas.sandberg@arm.com * is often not what is wanted. This API does not do this. 150311986Sandreas.sandberg@arm.com * 150411986Sandreas.sandberg@arm.com * 2. The gil_scoped_release function can optionally cut the relationship 150511986Sandreas.sandberg@arm.com * of a PyThreadState and its associated thread, which allows moving it to 150611986Sandreas.sandberg@arm.com * another thread (this is a fairly rare/advanced use case). 150711986Sandreas.sandberg@arm.com * 150811986Sandreas.sandberg@arm.com * 3. The reference count of an acquired thread state can be controlled. This 150911986Sandreas.sandberg@arm.com * can be handy to prevent cases where callbacks issued from an external 151011986Sandreas.sandberg@arm.com * thread would otherwise constantly construct and destroy thread state data 151111986Sandreas.sandberg@arm.com * structures. 151211986Sandreas.sandberg@arm.com * 151311986Sandreas.sandberg@arm.com * See the Python bindings of NanoGUI (http://github.com/wjakob/nanogui) for an 151411986Sandreas.sandberg@arm.com * example which uses features 2 and 3 to migrate the Python thread of 151511986Sandreas.sandberg@arm.com * execution to another thread (to run the event loop on the original thread, 151611986Sandreas.sandberg@arm.com * in this case). 151711986Sandreas.sandberg@arm.com */ 151811986Sandreas.sandberg@arm.com 151911986Sandreas.sandberg@arm.comclass gil_scoped_acquire { 152011986Sandreas.sandberg@arm.compublic: 152111986Sandreas.sandberg@arm.com PYBIND11_NOINLINE gil_scoped_acquire() { 152211986Sandreas.sandberg@arm.com auto const &internals = detail::get_internals(); 152311986Sandreas.sandberg@arm.com tstate = (PyThreadState *) PyThread_get_key_value(internals.tstate); 152411986Sandreas.sandberg@arm.com 152511986Sandreas.sandberg@arm.com if (!tstate) { 152611986Sandreas.sandberg@arm.com tstate = PyThreadState_New(internals.istate); 152711986Sandreas.sandberg@arm.com #if !defined(NDEBUG) 152811986Sandreas.sandberg@arm.com if (!tstate) 152911986Sandreas.sandberg@arm.com pybind11_fail("scoped_acquire: could not create thread state!"); 153011986Sandreas.sandberg@arm.com #endif 153111986Sandreas.sandberg@arm.com tstate->gilstate_counter = 0; 153211986Sandreas.sandberg@arm.com #if PY_MAJOR_VERSION < 3 153311986Sandreas.sandberg@arm.com PyThread_delete_key_value(internals.tstate); 153411986Sandreas.sandberg@arm.com #endif 153511986Sandreas.sandberg@arm.com PyThread_set_key_value(internals.tstate, tstate); 153611986Sandreas.sandberg@arm.com } else { 153711986Sandreas.sandberg@arm.com release = detail::get_thread_state_unchecked() != tstate; 153811986Sandreas.sandberg@arm.com } 153911986Sandreas.sandberg@arm.com 154011986Sandreas.sandberg@arm.com if (release) { 154111986Sandreas.sandberg@arm.com /* Work around an annoying assertion in PyThreadState_Swap */ 154211986Sandreas.sandberg@arm.com #if defined(Py_DEBUG) 154311986Sandreas.sandberg@arm.com PyInterpreterState *interp = tstate->interp; 154411986Sandreas.sandberg@arm.com tstate->interp = nullptr; 154511986Sandreas.sandberg@arm.com #endif 154611986Sandreas.sandberg@arm.com PyEval_AcquireThread(tstate); 154711986Sandreas.sandberg@arm.com #if defined(Py_DEBUG) 154811986Sandreas.sandberg@arm.com tstate->interp = interp; 154911986Sandreas.sandberg@arm.com #endif 155011986Sandreas.sandberg@arm.com } 155111986Sandreas.sandberg@arm.com 155211986Sandreas.sandberg@arm.com inc_ref(); 155311986Sandreas.sandberg@arm.com } 155411986Sandreas.sandberg@arm.com 155511986Sandreas.sandberg@arm.com void inc_ref() { 155611986Sandreas.sandberg@arm.com ++tstate->gilstate_counter; 155711986Sandreas.sandberg@arm.com } 155811986Sandreas.sandberg@arm.com 155911986Sandreas.sandberg@arm.com PYBIND11_NOINLINE void dec_ref() { 156011986Sandreas.sandberg@arm.com --tstate->gilstate_counter; 156111986Sandreas.sandberg@arm.com #if !defined(NDEBUG) 156211986Sandreas.sandberg@arm.com if (detail::get_thread_state_unchecked() != tstate) 156311986Sandreas.sandberg@arm.com pybind11_fail("scoped_acquire::dec_ref(): thread state must be current!"); 156411986Sandreas.sandberg@arm.com if (tstate->gilstate_counter < 0) 156511986Sandreas.sandberg@arm.com pybind11_fail("scoped_acquire::dec_ref(): reference count underflow!"); 156611986Sandreas.sandberg@arm.com #endif 156711986Sandreas.sandberg@arm.com if (tstate->gilstate_counter == 0) { 156811986Sandreas.sandberg@arm.com #if !defined(NDEBUG) 156911986Sandreas.sandberg@arm.com if (!release) 157011986Sandreas.sandberg@arm.com pybind11_fail("scoped_acquire::dec_ref(): internal error!"); 157111986Sandreas.sandberg@arm.com #endif 157211986Sandreas.sandberg@arm.com PyThreadState_Clear(tstate); 157311986Sandreas.sandberg@arm.com PyThreadState_DeleteCurrent(); 157411986Sandreas.sandberg@arm.com PyThread_delete_key_value(detail::get_internals().tstate); 157511986Sandreas.sandberg@arm.com release = false; 157611986Sandreas.sandberg@arm.com } 157711986Sandreas.sandberg@arm.com } 157811986Sandreas.sandberg@arm.com 157911986Sandreas.sandberg@arm.com PYBIND11_NOINLINE ~gil_scoped_acquire() { 158011986Sandreas.sandberg@arm.com dec_ref(); 158111986Sandreas.sandberg@arm.com if (release) 158211986Sandreas.sandberg@arm.com PyEval_SaveThread(); 158311986Sandreas.sandberg@arm.com } 158411986Sandreas.sandberg@arm.comprivate: 158511986Sandreas.sandberg@arm.com PyThreadState *tstate = nullptr; 158611986Sandreas.sandberg@arm.com bool release = true; 158711986Sandreas.sandberg@arm.com}; 158811986Sandreas.sandberg@arm.com 158911986Sandreas.sandberg@arm.comclass gil_scoped_release { 159011986Sandreas.sandberg@arm.compublic: 159111986Sandreas.sandberg@arm.com explicit gil_scoped_release(bool disassoc = false) : disassoc(disassoc) { 159211986Sandreas.sandberg@arm.com tstate = PyEval_SaveThread(); 159311986Sandreas.sandberg@arm.com if (disassoc) { 159411986Sandreas.sandberg@arm.com auto key = detail::get_internals().tstate; 159511986Sandreas.sandberg@arm.com #if PY_MAJOR_VERSION < 3 159611986Sandreas.sandberg@arm.com PyThread_delete_key_value(key); 159711986Sandreas.sandberg@arm.com #else 159811986Sandreas.sandberg@arm.com PyThread_set_key_value(key, nullptr); 159911986Sandreas.sandberg@arm.com #endif 160011986Sandreas.sandberg@arm.com } 160111986Sandreas.sandberg@arm.com } 160211986Sandreas.sandberg@arm.com ~gil_scoped_release() { 160311986Sandreas.sandberg@arm.com if (!tstate) 160411986Sandreas.sandberg@arm.com return; 160511986Sandreas.sandberg@arm.com PyEval_RestoreThread(tstate); 160611986Sandreas.sandberg@arm.com if (disassoc) { 160711986Sandreas.sandberg@arm.com auto key = detail::get_internals().tstate; 160811986Sandreas.sandberg@arm.com #if PY_MAJOR_VERSION < 3 160911986Sandreas.sandberg@arm.com PyThread_delete_key_value(key); 161011986Sandreas.sandberg@arm.com #endif 161111986Sandreas.sandberg@arm.com PyThread_set_key_value(key, tstate); 161211986Sandreas.sandberg@arm.com } 161311986Sandreas.sandberg@arm.com } 161411986Sandreas.sandberg@arm.comprivate: 161511986Sandreas.sandberg@arm.com PyThreadState *tstate; 161611986Sandreas.sandberg@arm.com bool disassoc; 161711986Sandreas.sandberg@arm.com}; 161812037Sandreas.sandberg@arm.com#elif defined(PYPY_VERSION) 161912037Sandreas.sandberg@arm.comclass gil_scoped_acquire { 162012037Sandreas.sandberg@arm.com PyGILState_STATE state; 162112037Sandreas.sandberg@arm.compublic: 162212037Sandreas.sandberg@arm.com gil_scoped_acquire() { state = PyGILState_Ensure(); } 162312037Sandreas.sandberg@arm.com ~gil_scoped_acquire() { PyGILState_Release(state); } 162412037Sandreas.sandberg@arm.com}; 162512037Sandreas.sandberg@arm.com 162612037Sandreas.sandberg@arm.comclass gil_scoped_release { 162712037Sandreas.sandberg@arm.com PyThreadState *state; 162812037Sandreas.sandberg@arm.compublic: 162912037Sandreas.sandberg@arm.com gil_scoped_release() { state = PyEval_SaveThread(); } 163012037Sandreas.sandberg@arm.com ~gil_scoped_release() { PyEval_RestoreThread(state); } 163112037Sandreas.sandberg@arm.com}; 163211986Sandreas.sandberg@arm.com#else 163311986Sandreas.sandberg@arm.comclass gil_scoped_acquire { }; 163411986Sandreas.sandberg@arm.comclass gil_scoped_release { }; 163511986Sandreas.sandberg@arm.com#endif 163611986Sandreas.sandberg@arm.com 163711986Sandreas.sandberg@arm.comerror_already_set::~error_already_set() { 163811986Sandreas.sandberg@arm.com if (value) { 163911986Sandreas.sandberg@arm.com gil_scoped_acquire gil; 164012037Sandreas.sandberg@arm.com clear(); 164111986Sandreas.sandberg@arm.com } 164211986Sandreas.sandberg@arm.com} 164311986Sandreas.sandberg@arm.com 164411986Sandreas.sandberg@arm.cominline function get_type_overload(const void *this_ptr, const detail::type_info *this_type, const char *name) { 164512037Sandreas.sandberg@arm.com handle self = detail::get_object_handle(this_ptr, this_type); 164612037Sandreas.sandberg@arm.com if (!self) 164711986Sandreas.sandberg@arm.com return function(); 164812037Sandreas.sandberg@arm.com handle type = self.get_type(); 164911986Sandreas.sandberg@arm.com auto key = std::make_pair(type.ptr(), name); 165011986Sandreas.sandberg@arm.com 165111986Sandreas.sandberg@arm.com /* Cache functions that aren't overloaded in Python to avoid 165211986Sandreas.sandberg@arm.com many costly Python dictionary lookups below */ 165311986Sandreas.sandberg@arm.com auto &cache = detail::get_internals().inactive_overload_cache; 165411986Sandreas.sandberg@arm.com if (cache.find(key) != cache.end()) 165511986Sandreas.sandberg@arm.com return function(); 165611986Sandreas.sandberg@arm.com 165712037Sandreas.sandberg@arm.com function overload = getattr(self, name, function()); 165811986Sandreas.sandberg@arm.com if (overload.is_cpp_function()) { 165911986Sandreas.sandberg@arm.com cache.insert(key); 166011986Sandreas.sandberg@arm.com return function(); 166111986Sandreas.sandberg@arm.com } 166211986Sandreas.sandberg@arm.com 166312037Sandreas.sandberg@arm.com /* Don't call dispatch code if invoked from overridden function. 166412037Sandreas.sandberg@arm.com Unfortunately this doesn't work on PyPy. */ 166512037Sandreas.sandberg@arm.com#if !defined(PYPY_VERSION) 166611986Sandreas.sandberg@arm.com PyFrameObject *frame = PyThreadState_Get()->frame; 166711986Sandreas.sandberg@arm.com if (frame && (std::string) str(frame->f_code->co_name) == name && 166811986Sandreas.sandberg@arm.com frame->f_code->co_argcount > 0) { 166911986Sandreas.sandberg@arm.com PyFrame_FastToLocals(frame); 167011986Sandreas.sandberg@arm.com PyObject *self_caller = PyDict_GetItem( 167111986Sandreas.sandberg@arm.com frame->f_locals, PyTuple_GET_ITEM(frame->f_code->co_varnames, 0)); 167212037Sandreas.sandberg@arm.com if (self_caller == self.ptr()) 167311986Sandreas.sandberg@arm.com return function(); 167411986Sandreas.sandberg@arm.com } 167512037Sandreas.sandberg@arm.com#else 167612037Sandreas.sandberg@arm.com /* PyPy currently doesn't provide a detailed cpyext emulation of 167712037Sandreas.sandberg@arm.com frame objects, so we have to emulate this using Python. This 167812037Sandreas.sandberg@arm.com is going to be slow..*/ 167912037Sandreas.sandberg@arm.com dict d; d["self"] = self; d["name"] = pybind11::str(name); 168012037Sandreas.sandberg@arm.com PyObject *result = PyRun_String( 168112037Sandreas.sandberg@arm.com "import inspect\n" 168212037Sandreas.sandberg@arm.com "frame = inspect.currentframe()\n" 168312037Sandreas.sandberg@arm.com "if frame is not None:\n" 168412037Sandreas.sandberg@arm.com " frame = frame.f_back\n" 168512037Sandreas.sandberg@arm.com " if frame is not None and str(frame.f_code.co_name) == name and " 168612037Sandreas.sandberg@arm.com "frame.f_code.co_argcount > 0:\n" 168712037Sandreas.sandberg@arm.com " self_caller = frame.f_locals[frame.f_code.co_varnames[0]]\n" 168812037Sandreas.sandberg@arm.com " if self_caller == self:\n" 168912037Sandreas.sandberg@arm.com " self = None\n", 169012037Sandreas.sandberg@arm.com Py_file_input, d.ptr(), d.ptr()); 169112037Sandreas.sandberg@arm.com if (result == nullptr) 169212037Sandreas.sandberg@arm.com throw error_already_set(); 169312037Sandreas.sandberg@arm.com if ((handle) d["self"] == Py_None) 169412037Sandreas.sandberg@arm.com return function(); 169512037Sandreas.sandberg@arm.com Py_DECREF(result); 169612037Sandreas.sandberg@arm.com#endif 169712037Sandreas.sandberg@arm.com 169811986Sandreas.sandberg@arm.com return overload; 169911986Sandreas.sandberg@arm.com} 170011986Sandreas.sandberg@arm.com 170111986Sandreas.sandberg@arm.comtemplate <class T> function get_overload(const T *this_ptr, const char *name) { 170211986Sandreas.sandberg@arm.com auto tinfo = detail::get_type_info(typeid(T)); 170311986Sandreas.sandberg@arm.com return tinfo ? get_type_overload(this_ptr, tinfo, name) : function(); 170411986Sandreas.sandberg@arm.com} 170511986Sandreas.sandberg@arm.com 170611986Sandreas.sandberg@arm.com#define PYBIND11_OVERLOAD_INT(ret_type, cname, name, ...) { \ 170711986Sandreas.sandberg@arm.com pybind11::gil_scoped_acquire gil; \ 170811986Sandreas.sandberg@arm.com pybind11::function overload = pybind11::get_overload(static_cast<const cname *>(this), name); \ 170911986Sandreas.sandberg@arm.com if (overload) { \ 171011986Sandreas.sandberg@arm.com auto o = overload(__VA_ARGS__); \ 171111986Sandreas.sandberg@arm.com if (pybind11::detail::cast_is_temporary_value_reference<ret_type>::value) { \ 171211986Sandreas.sandberg@arm.com static pybind11::detail::overload_caster_t<ret_type> caster; \ 171311986Sandreas.sandberg@arm.com return pybind11::detail::cast_ref<ret_type>(std::move(o), caster); \ 171411986Sandreas.sandberg@arm.com } \ 171511986Sandreas.sandberg@arm.com else return pybind11::detail::cast_safe<ret_type>(std::move(o)); \ 171611986Sandreas.sandberg@arm.com } \ 171711986Sandreas.sandberg@arm.com } 171811986Sandreas.sandberg@arm.com 171911986Sandreas.sandberg@arm.com#define PYBIND11_OVERLOAD_NAME(ret_type, cname, name, fn, ...) \ 172011986Sandreas.sandberg@arm.com PYBIND11_OVERLOAD_INT(ret_type, cname, name, __VA_ARGS__) \ 172111986Sandreas.sandberg@arm.com return cname::fn(__VA_ARGS__) 172211986Sandreas.sandberg@arm.com 172311986Sandreas.sandberg@arm.com#define PYBIND11_OVERLOAD_PURE_NAME(ret_type, cname, name, fn, ...) \ 172411986Sandreas.sandberg@arm.com PYBIND11_OVERLOAD_INT(ret_type, cname, name, __VA_ARGS__) \ 172511986Sandreas.sandberg@arm.com pybind11::pybind11_fail("Tried to call pure virtual function \"" #cname "::" name "\""); 172611986Sandreas.sandberg@arm.com 172711986Sandreas.sandberg@arm.com#define PYBIND11_OVERLOAD(ret_type, cname, fn, ...) \ 172811986Sandreas.sandberg@arm.com PYBIND11_OVERLOAD_NAME(ret_type, cname, #fn, fn, __VA_ARGS__) 172911986Sandreas.sandberg@arm.com 173011986Sandreas.sandberg@arm.com#define PYBIND11_OVERLOAD_PURE(ret_type, cname, fn, ...) \ 173111986Sandreas.sandberg@arm.com PYBIND11_OVERLOAD_PURE_NAME(ret_type, cname, #fn, fn, __VA_ARGS__) 173211986Sandreas.sandberg@arm.com 173311986Sandreas.sandberg@arm.comNAMESPACE_END(pybind11) 173411986Sandreas.sandberg@arm.com 173511986Sandreas.sandberg@arm.com#if defined(_MSC_VER) 173611986Sandreas.sandberg@arm.com# pragma warning(pop) 173711986Sandreas.sandberg@arm.com#elif defined(__INTEL_COMPILER) 173811986Sandreas.sandberg@arm.com/* Leave ignored warnings on */ 173911986Sandreas.sandberg@arm.com#elif defined(__GNUG__) && !defined(__clang__) 174011986Sandreas.sandberg@arm.com# pragma GCC diagnostic pop 174111986Sandreas.sandberg@arm.com#endif 1742