111986Sandreas.sandberg@arm.com/* 212391Sjason@lowepower.com pybind11/attr.h: Infrastructure for processing custom 311986Sandreas.sandberg@arm.com type and function attributes 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#include "cast.h" 1411986Sandreas.sandberg@arm.com 1512391Sjason@lowepower.comNAMESPACE_BEGIN(PYBIND11_NAMESPACE) 1611986Sandreas.sandberg@arm.com 1712037Sandreas.sandberg@arm.com/// \addtogroup annotations 1812037Sandreas.sandberg@arm.com/// @{ 1912037Sandreas.sandberg@arm.com 2011986Sandreas.sandberg@arm.com/// Annotation for methods 2111986Sandreas.sandberg@arm.comstruct is_method { handle class_; is_method(const handle &c) : class_(c) { } }; 2211986Sandreas.sandberg@arm.com 2311986Sandreas.sandberg@arm.com/// Annotation for operators 2411986Sandreas.sandberg@arm.comstruct is_operator { }; 2511986Sandreas.sandberg@arm.com 2611986Sandreas.sandberg@arm.com/// Annotation for parent scope 2711986Sandreas.sandberg@arm.comstruct scope { handle value; scope(const handle &s) : value(s) { } }; 2811986Sandreas.sandberg@arm.com 2911986Sandreas.sandberg@arm.com/// Annotation for documentation 3011986Sandreas.sandberg@arm.comstruct doc { const char *value; doc(const char *value) : value(value) { } }; 3111986Sandreas.sandberg@arm.com 3211986Sandreas.sandberg@arm.com/// Annotation for function names 3311986Sandreas.sandberg@arm.comstruct name { const char *value; name(const char *value) : value(value) { } }; 3411986Sandreas.sandberg@arm.com 3511986Sandreas.sandberg@arm.com/// Annotation indicating that a function is an overload associated with a given "sibling" 3611986Sandreas.sandberg@arm.comstruct sibling { handle value; sibling(const handle &value) : value(value.ptr()) { } }; 3711986Sandreas.sandberg@arm.com 3811986Sandreas.sandberg@arm.com/// Annotation indicating that a class derives from another given type 3911986Sandreas.sandberg@arm.comtemplate <typename T> struct base { 4011986Sandreas.sandberg@arm.com PYBIND11_DEPRECATED("base<T>() was deprecated in favor of specifying 'T' as a template argument to class_") 4111986Sandreas.sandberg@arm.com base() { } 4211986Sandreas.sandberg@arm.com}; 4311986Sandreas.sandberg@arm.com 4411986Sandreas.sandberg@arm.com/// Keep patient alive while nurse lives 4512037Sandreas.sandberg@arm.comtemplate <size_t Nurse, size_t Patient> struct keep_alive { }; 4611986Sandreas.sandberg@arm.com 4711986Sandreas.sandberg@arm.com/// Annotation indicating that a class is involved in a multiple inheritance relationship 4811986Sandreas.sandberg@arm.comstruct multiple_inheritance { }; 4911986Sandreas.sandberg@arm.com 5011986Sandreas.sandberg@arm.com/// Annotation which enables dynamic attributes, i.e. adds `__dict__` to a class 5111986Sandreas.sandberg@arm.comstruct dynamic_attr { }; 5211986Sandreas.sandberg@arm.com 5312037Sandreas.sandberg@arm.com/// Annotation which enables the buffer protocol for a type 5412037Sandreas.sandberg@arm.comstruct buffer_protocol { }; 5512037Sandreas.sandberg@arm.com 5612037Sandreas.sandberg@arm.com/// Annotation which requests that a special metaclass is created for a type 5712037Sandreas.sandberg@arm.comstruct metaclass { 5812037Sandreas.sandberg@arm.com handle value; 5912037Sandreas.sandberg@arm.com 6012037Sandreas.sandberg@arm.com PYBIND11_DEPRECATED("py::metaclass() is no longer required. It's turned on by default now.") 6112391Sjason@lowepower.com metaclass() {} 6212037Sandreas.sandberg@arm.com 6312037Sandreas.sandberg@arm.com /// Override pybind11's default metaclass 6412037Sandreas.sandberg@arm.com explicit metaclass(handle value) : value(value) { } 6512037Sandreas.sandberg@arm.com}; 6612037Sandreas.sandberg@arm.com 6712391Sjason@lowepower.com/// Annotation that marks a class as local to the module: 6812391Sjason@lowepower.comstruct module_local { const bool value; constexpr module_local(bool v = true) : value(v) { } }; 6912391Sjason@lowepower.com 7011986Sandreas.sandberg@arm.com/// Annotation to mark enums as an arithmetic type 7111986Sandreas.sandberg@arm.comstruct arithmetic { }; 7211986Sandreas.sandberg@arm.com 7312391Sjason@lowepower.com/** \rst 7412391Sjason@lowepower.com A call policy which places one or more guard variables (``Ts...``) around the function call. 7512391Sjason@lowepower.com 7612391Sjason@lowepower.com For example, this definition: 7712391Sjason@lowepower.com 7812391Sjason@lowepower.com .. code-block:: cpp 7912391Sjason@lowepower.com 8012391Sjason@lowepower.com m.def("foo", foo, py::call_guard<T>()); 8112391Sjason@lowepower.com 8212391Sjason@lowepower.com is equivalent to the following pseudocode: 8312391Sjason@lowepower.com 8412391Sjason@lowepower.com .. code-block:: cpp 8512391Sjason@lowepower.com 8612391Sjason@lowepower.com m.def("foo", [](args...) { 8712391Sjason@lowepower.com T scope_guard; 8812391Sjason@lowepower.com return foo(args...); // forwarded arguments 8912391Sjason@lowepower.com }); 9012391Sjason@lowepower.com \endrst */ 9112391Sjason@lowepower.comtemplate <typename... Ts> struct call_guard; 9212391Sjason@lowepower.com 9312391Sjason@lowepower.comtemplate <> struct call_guard<> { using type = detail::void_type; }; 9412391Sjason@lowepower.com 9512391Sjason@lowepower.comtemplate <typename T> 9612391Sjason@lowepower.comstruct call_guard<T> { 9712391Sjason@lowepower.com static_assert(std::is_default_constructible<T>::value, 9812391Sjason@lowepower.com "The guard type must be default constructible"); 9912391Sjason@lowepower.com 10012391Sjason@lowepower.com using type = T; 10112391Sjason@lowepower.com}; 10212391Sjason@lowepower.com 10312391Sjason@lowepower.comtemplate <typename T, typename... Ts> 10412391Sjason@lowepower.comstruct call_guard<T, Ts...> { 10512391Sjason@lowepower.com struct type { 10612391Sjason@lowepower.com T guard{}; // Compose multiple guard types with left-to-right default-constructor order 10712391Sjason@lowepower.com typename call_guard<Ts...>::type next{}; 10812391Sjason@lowepower.com }; 10912391Sjason@lowepower.com}; 11012391Sjason@lowepower.com 11112037Sandreas.sandberg@arm.com/// @} annotations 11212037Sandreas.sandberg@arm.com 11311986Sandreas.sandberg@arm.comNAMESPACE_BEGIN(detail) 11411986Sandreas.sandberg@arm.com/* Forward declarations */ 11511986Sandreas.sandberg@arm.comenum op_id : int; 11611986Sandreas.sandberg@arm.comenum op_type : int; 11711986Sandreas.sandberg@arm.comstruct undefined_t; 11811986Sandreas.sandberg@arm.comtemplate <op_id id, op_type ot, typename L = undefined_t, typename R = undefined_t> struct op_; 11912037Sandreas.sandberg@arm.cominline void keep_alive_impl(size_t Nurse, size_t Patient, function_call &call, handle ret); 12011986Sandreas.sandberg@arm.com 12111986Sandreas.sandberg@arm.com/// Internal data structure which holds metadata about a keyword argument 12211986Sandreas.sandberg@arm.comstruct argument_record { 12311986Sandreas.sandberg@arm.com const char *name; ///< Argument name 12411986Sandreas.sandberg@arm.com const char *descr; ///< Human-readable version of the argument value 12511986Sandreas.sandberg@arm.com handle value; ///< Associated Python object 12612037Sandreas.sandberg@arm.com bool convert : 1; ///< True if the argument is allowed to convert when loading 12712391Sjason@lowepower.com bool none : 1; ///< True if None is allowed when loading 12811986Sandreas.sandberg@arm.com 12912391Sjason@lowepower.com argument_record(const char *name, const char *descr, handle value, bool convert, bool none) 13012391Sjason@lowepower.com : name(name), descr(descr), value(value), convert(convert), none(none) { } 13111986Sandreas.sandberg@arm.com}; 13211986Sandreas.sandberg@arm.com 13311986Sandreas.sandberg@arm.com/// Internal data structure which holds metadata about a bound function (signature, overloads, etc.) 13411986Sandreas.sandberg@arm.comstruct function_record { 13511986Sandreas.sandberg@arm.com function_record() 13612391Sjason@lowepower.com : is_constructor(false), is_new_style_constructor(false), is_stateless(false), 13712391Sjason@lowepower.com is_operator(false), has_args(false), has_kwargs(false), is_method(false) { } 13811986Sandreas.sandberg@arm.com 13911986Sandreas.sandberg@arm.com /// Function name 14011986Sandreas.sandberg@arm.com char *name = nullptr; /* why no C++ strings? They generate heavier code.. */ 14111986Sandreas.sandberg@arm.com 14211986Sandreas.sandberg@arm.com // User-specified documentation string 14311986Sandreas.sandberg@arm.com char *doc = nullptr; 14411986Sandreas.sandberg@arm.com 14511986Sandreas.sandberg@arm.com /// Human-readable version of the function signature 14611986Sandreas.sandberg@arm.com char *signature = nullptr; 14711986Sandreas.sandberg@arm.com 14811986Sandreas.sandberg@arm.com /// List of registered keyword arguments 14911986Sandreas.sandberg@arm.com std::vector<argument_record> args; 15011986Sandreas.sandberg@arm.com 15111986Sandreas.sandberg@arm.com /// Pointer to lambda function which converts arguments and performs the actual call 15212037Sandreas.sandberg@arm.com handle (*impl) (function_call &) = nullptr; 15311986Sandreas.sandberg@arm.com 15411986Sandreas.sandberg@arm.com /// Storage for the wrapped function pointer and captured data, if any 15511986Sandreas.sandberg@arm.com void *data[3] = { }; 15611986Sandreas.sandberg@arm.com 15711986Sandreas.sandberg@arm.com /// Pointer to custom destructor for 'data' (if needed) 15811986Sandreas.sandberg@arm.com void (*free_data) (function_record *ptr) = nullptr; 15911986Sandreas.sandberg@arm.com 16011986Sandreas.sandberg@arm.com /// Return value policy associated with this function 16111986Sandreas.sandberg@arm.com return_value_policy policy = return_value_policy::automatic; 16211986Sandreas.sandberg@arm.com 16311986Sandreas.sandberg@arm.com /// True if name == '__init__' 16411986Sandreas.sandberg@arm.com bool is_constructor : 1; 16511986Sandreas.sandberg@arm.com 16612391Sjason@lowepower.com /// True if this is a new-style `__init__` defined in `detail/init.h` 16712391Sjason@lowepower.com bool is_new_style_constructor : 1; 16812391Sjason@lowepower.com 16911986Sandreas.sandberg@arm.com /// True if this is a stateless function pointer 17011986Sandreas.sandberg@arm.com bool is_stateless : 1; 17111986Sandreas.sandberg@arm.com 17211986Sandreas.sandberg@arm.com /// True if this is an operator (__add__), etc. 17311986Sandreas.sandberg@arm.com bool is_operator : 1; 17411986Sandreas.sandberg@arm.com 17511986Sandreas.sandberg@arm.com /// True if the function has a '*args' argument 17611986Sandreas.sandberg@arm.com bool has_args : 1; 17711986Sandreas.sandberg@arm.com 17811986Sandreas.sandberg@arm.com /// True if the function has a '**kwargs' argument 17911986Sandreas.sandberg@arm.com bool has_kwargs : 1; 18011986Sandreas.sandberg@arm.com 18111986Sandreas.sandberg@arm.com /// True if this is a method 18211986Sandreas.sandberg@arm.com bool is_method : 1; 18311986Sandreas.sandberg@arm.com 18412037Sandreas.sandberg@arm.com /// Number of arguments (including py::args and/or py::kwargs, if present) 18512037Sandreas.sandberg@arm.com std::uint16_t nargs; 18611986Sandreas.sandberg@arm.com 18711986Sandreas.sandberg@arm.com /// Python method object 18811986Sandreas.sandberg@arm.com PyMethodDef *def = nullptr; 18911986Sandreas.sandberg@arm.com 19011986Sandreas.sandberg@arm.com /// Python handle to the parent scope (a class or a module) 19111986Sandreas.sandberg@arm.com handle scope; 19211986Sandreas.sandberg@arm.com 19311986Sandreas.sandberg@arm.com /// Python handle to the sibling function representing an overload chain 19411986Sandreas.sandberg@arm.com handle sibling; 19511986Sandreas.sandberg@arm.com 19611986Sandreas.sandberg@arm.com /// Pointer to next overload 19711986Sandreas.sandberg@arm.com function_record *next = nullptr; 19811986Sandreas.sandberg@arm.com}; 19911986Sandreas.sandberg@arm.com 20011986Sandreas.sandberg@arm.com/// Special data structure which (temporarily) holds metadata about a bound class 20111986Sandreas.sandberg@arm.comstruct type_record { 20212037Sandreas.sandberg@arm.com PYBIND11_NOINLINE type_record() 20314299Sbbruce@ucdavis.edu : multiple_inheritance(false), dynamic_attr(false), buffer_protocol(false), 20414299Sbbruce@ucdavis.edu default_holder(true), module_local(false) { } 20511986Sandreas.sandberg@arm.com 20611986Sandreas.sandberg@arm.com /// Handle to the parent scope 20711986Sandreas.sandberg@arm.com handle scope; 20811986Sandreas.sandberg@arm.com 20911986Sandreas.sandberg@arm.com /// Name of the class 21011986Sandreas.sandberg@arm.com const char *name = nullptr; 21111986Sandreas.sandberg@arm.com 21211986Sandreas.sandberg@arm.com // Pointer to RTTI type_info data structure 21311986Sandreas.sandberg@arm.com const std::type_info *type = nullptr; 21411986Sandreas.sandberg@arm.com 21511986Sandreas.sandberg@arm.com /// How large is the underlying C++ type? 21611986Sandreas.sandberg@arm.com size_t type_size = 0; 21711986Sandreas.sandberg@arm.com 21814299Sbbruce@ucdavis.edu /// What is the alignment of the underlying C++ type? 21914299Sbbruce@ucdavis.edu size_t type_align = 0; 22014299Sbbruce@ucdavis.edu 22112391Sjason@lowepower.com /// How large is the type's holder? 22212391Sjason@lowepower.com size_t holder_size = 0; 22311986Sandreas.sandberg@arm.com 22412037Sandreas.sandberg@arm.com /// The global operator new can be overridden with a class-specific variant 22514299Sbbruce@ucdavis.edu void *(*operator_new)(size_t) = nullptr; 22612037Sandreas.sandberg@arm.com 22712391Sjason@lowepower.com /// Function pointer to class_<..>::init_instance 22812391Sjason@lowepower.com void (*init_instance)(instance *, const void *) = nullptr; 22911986Sandreas.sandberg@arm.com 23011986Sandreas.sandberg@arm.com /// Function pointer to class_<..>::dealloc 23112391Sjason@lowepower.com void (*dealloc)(detail::value_and_holder &) = nullptr; 23211986Sandreas.sandberg@arm.com 23311986Sandreas.sandberg@arm.com /// List of base classes of the newly created type 23411986Sandreas.sandberg@arm.com list bases; 23511986Sandreas.sandberg@arm.com 23611986Sandreas.sandberg@arm.com /// Optional docstring 23711986Sandreas.sandberg@arm.com const char *doc = nullptr; 23811986Sandreas.sandberg@arm.com 23912037Sandreas.sandberg@arm.com /// Custom metaclass (optional) 24012037Sandreas.sandberg@arm.com handle metaclass; 24112037Sandreas.sandberg@arm.com 24211986Sandreas.sandberg@arm.com /// Multiple inheritance marker 24312037Sandreas.sandberg@arm.com bool multiple_inheritance : 1; 24411986Sandreas.sandberg@arm.com 24511986Sandreas.sandberg@arm.com /// Does the class manage a __dict__? 24612037Sandreas.sandberg@arm.com bool dynamic_attr : 1; 24712037Sandreas.sandberg@arm.com 24812037Sandreas.sandberg@arm.com /// Does the class implement the buffer protocol? 24912037Sandreas.sandberg@arm.com bool buffer_protocol : 1; 25012037Sandreas.sandberg@arm.com 25112037Sandreas.sandberg@arm.com /// Is the default (unique_ptr) holder type used? 25212037Sandreas.sandberg@arm.com bool default_holder : 1; 25311986Sandreas.sandberg@arm.com 25412391Sjason@lowepower.com /// Is the class definition local to the module shared object? 25512391Sjason@lowepower.com bool module_local : 1; 25612391Sjason@lowepower.com 25712391Sjason@lowepower.com PYBIND11_NOINLINE void add_base(const std::type_info &base, void *(*caster)(void *)) { 25812391Sjason@lowepower.com auto base_info = detail::get_type_info(base, false); 25911986Sandreas.sandberg@arm.com if (!base_info) { 26012391Sjason@lowepower.com std::string tname(base.name()); 26111986Sandreas.sandberg@arm.com detail::clean_type_id(tname); 26211986Sandreas.sandberg@arm.com pybind11_fail("generic_type: type \"" + std::string(name) + 26311986Sandreas.sandberg@arm.com "\" referenced unknown base type \"" + tname + "\""); 26411986Sandreas.sandberg@arm.com } 26511986Sandreas.sandberg@arm.com 26612037Sandreas.sandberg@arm.com if (default_holder != base_info->default_holder) { 26712391Sjason@lowepower.com std::string tname(base.name()); 26812037Sandreas.sandberg@arm.com detail::clean_type_id(tname); 26912037Sandreas.sandberg@arm.com pybind11_fail("generic_type: type \"" + std::string(name) + "\" " + 27012037Sandreas.sandberg@arm.com (default_holder ? "does not have" : "has") + 27112037Sandreas.sandberg@arm.com " a non-default holder type while its base \"" + tname + "\" " + 27212037Sandreas.sandberg@arm.com (base_info->default_holder ? "does not" : "does")); 27312037Sandreas.sandberg@arm.com } 27412037Sandreas.sandberg@arm.com 27511986Sandreas.sandberg@arm.com bases.append((PyObject *) base_info->type); 27611986Sandreas.sandberg@arm.com 27711986Sandreas.sandberg@arm.com if (base_info->type->tp_dictoffset != 0) 27811986Sandreas.sandberg@arm.com dynamic_attr = true; 27911986Sandreas.sandberg@arm.com 28011986Sandreas.sandberg@arm.com if (caster) 28112391Sjason@lowepower.com base_info->implicit_casts.emplace_back(type, caster); 28211986Sandreas.sandberg@arm.com } 28311986Sandreas.sandberg@arm.com}; 28411986Sandreas.sandberg@arm.com 28514299Sbbruce@ucdavis.eduinline function_call::function_call(const function_record &f, handle p) : 28612037Sandreas.sandberg@arm.com func(f), parent(p) { 28712037Sandreas.sandberg@arm.com args.reserve(f.nargs); 28812037Sandreas.sandberg@arm.com args_convert.reserve(f.nargs); 28912037Sandreas.sandberg@arm.com} 29012037Sandreas.sandberg@arm.com 29112391Sjason@lowepower.com/// Tag for a new-style `__init__` defined in `detail/init.h` 29212391Sjason@lowepower.comstruct is_new_style_constructor { }; 29312391Sjason@lowepower.com 29411986Sandreas.sandberg@arm.com/** 29511986Sandreas.sandberg@arm.com * Partial template specializations to process custom attributes provided to 29611986Sandreas.sandberg@arm.com * cpp_function_ and class_. These are either used to initialize the respective 29711986Sandreas.sandberg@arm.com * fields in the type_record and function_record data structures or executed at 29811986Sandreas.sandberg@arm.com * runtime to deal with custom call policies (e.g. keep_alive). 29911986Sandreas.sandberg@arm.com */ 30011986Sandreas.sandberg@arm.comtemplate <typename T, typename SFINAE = void> struct process_attribute; 30111986Sandreas.sandberg@arm.com 30211986Sandreas.sandberg@arm.comtemplate <typename T> struct process_attribute_default { 30311986Sandreas.sandberg@arm.com /// Default implementation: do nothing 30411986Sandreas.sandberg@arm.com static void init(const T &, function_record *) { } 30511986Sandreas.sandberg@arm.com static void init(const T &, type_record *) { } 30612037Sandreas.sandberg@arm.com static void precall(function_call &) { } 30712037Sandreas.sandberg@arm.com static void postcall(function_call &, handle) { } 30811986Sandreas.sandberg@arm.com}; 30911986Sandreas.sandberg@arm.com 31011986Sandreas.sandberg@arm.com/// Process an attribute specifying the function's name 31111986Sandreas.sandberg@arm.comtemplate <> struct process_attribute<name> : process_attribute_default<name> { 31211986Sandreas.sandberg@arm.com static void init(const name &n, function_record *r) { r->name = const_cast<char *>(n.value); } 31311986Sandreas.sandberg@arm.com}; 31411986Sandreas.sandberg@arm.com 31511986Sandreas.sandberg@arm.com/// Process an attribute specifying the function's docstring 31611986Sandreas.sandberg@arm.comtemplate <> struct process_attribute<doc> : process_attribute_default<doc> { 31711986Sandreas.sandberg@arm.com static void init(const doc &n, function_record *r) { r->doc = const_cast<char *>(n.value); } 31811986Sandreas.sandberg@arm.com}; 31911986Sandreas.sandberg@arm.com 32011986Sandreas.sandberg@arm.com/// Process an attribute specifying the function's docstring (provided as a C-style string) 32111986Sandreas.sandberg@arm.comtemplate <> struct process_attribute<const char *> : process_attribute_default<const char *> { 32211986Sandreas.sandberg@arm.com static void init(const char *d, function_record *r) { r->doc = const_cast<char *>(d); } 32311986Sandreas.sandberg@arm.com static void init(const char *d, type_record *r) { r->doc = const_cast<char *>(d); } 32411986Sandreas.sandberg@arm.com}; 32511986Sandreas.sandberg@arm.comtemplate <> struct process_attribute<char *> : process_attribute<const char *> { }; 32611986Sandreas.sandberg@arm.com 32711986Sandreas.sandberg@arm.com/// Process an attribute indicating the function's return value policy 32811986Sandreas.sandberg@arm.comtemplate <> struct process_attribute<return_value_policy> : process_attribute_default<return_value_policy> { 32911986Sandreas.sandberg@arm.com static void init(const return_value_policy &p, function_record *r) { r->policy = p; } 33011986Sandreas.sandberg@arm.com}; 33111986Sandreas.sandberg@arm.com 33211986Sandreas.sandberg@arm.com/// Process an attribute which indicates that this is an overloaded function associated with a given sibling 33311986Sandreas.sandberg@arm.comtemplate <> struct process_attribute<sibling> : process_attribute_default<sibling> { 33411986Sandreas.sandberg@arm.com static void init(const sibling &s, function_record *r) { r->sibling = s.value; } 33511986Sandreas.sandberg@arm.com}; 33611986Sandreas.sandberg@arm.com 33711986Sandreas.sandberg@arm.com/// Process an attribute which indicates that this function is a method 33811986Sandreas.sandberg@arm.comtemplate <> struct process_attribute<is_method> : process_attribute_default<is_method> { 33911986Sandreas.sandberg@arm.com static void init(const is_method &s, function_record *r) { r->is_method = true; r->scope = s.class_; } 34011986Sandreas.sandberg@arm.com}; 34111986Sandreas.sandberg@arm.com 34211986Sandreas.sandberg@arm.com/// Process an attribute which indicates the parent scope of a method 34311986Sandreas.sandberg@arm.comtemplate <> struct process_attribute<scope> : process_attribute_default<scope> { 34411986Sandreas.sandberg@arm.com static void init(const scope &s, function_record *r) { r->scope = s.value; } 34511986Sandreas.sandberg@arm.com}; 34611986Sandreas.sandberg@arm.com 34711986Sandreas.sandberg@arm.com/// Process an attribute which indicates that this function is an operator 34811986Sandreas.sandberg@arm.comtemplate <> struct process_attribute<is_operator> : process_attribute_default<is_operator> { 34911986Sandreas.sandberg@arm.com static void init(const is_operator &, function_record *r) { r->is_operator = true; } 35011986Sandreas.sandberg@arm.com}; 35111986Sandreas.sandberg@arm.com 35212391Sjason@lowepower.comtemplate <> struct process_attribute<is_new_style_constructor> : process_attribute_default<is_new_style_constructor> { 35312391Sjason@lowepower.com static void init(const is_new_style_constructor &, function_record *r) { r->is_new_style_constructor = true; } 35412391Sjason@lowepower.com}; 35512391Sjason@lowepower.com 35611986Sandreas.sandberg@arm.com/// Process a keyword argument attribute (*without* a default value) 35711986Sandreas.sandberg@arm.comtemplate <> struct process_attribute<arg> : process_attribute_default<arg> { 35811986Sandreas.sandberg@arm.com static void init(const arg &a, function_record *r) { 35911986Sandreas.sandberg@arm.com if (r->is_method && r->args.empty()) 36012391Sjason@lowepower.com r->args.emplace_back("self", nullptr, handle(), true /*convert*/, false /*none not allowed*/); 36112391Sjason@lowepower.com r->args.emplace_back(a.name, nullptr, handle(), !a.flag_noconvert, a.flag_none); 36211986Sandreas.sandberg@arm.com } 36311986Sandreas.sandberg@arm.com}; 36411986Sandreas.sandberg@arm.com 36511986Sandreas.sandberg@arm.com/// Process a keyword argument attribute (*with* a default value) 36611986Sandreas.sandberg@arm.comtemplate <> struct process_attribute<arg_v> : process_attribute_default<arg_v> { 36711986Sandreas.sandberg@arm.com static void init(const arg_v &a, function_record *r) { 36811986Sandreas.sandberg@arm.com if (r->is_method && r->args.empty()) 36912391Sjason@lowepower.com r->args.emplace_back("self", nullptr /*descr*/, handle() /*parent*/, true /*convert*/, false /*none not allowed*/); 37011986Sandreas.sandberg@arm.com 37111986Sandreas.sandberg@arm.com if (!a.value) { 37211986Sandreas.sandberg@arm.com#if !defined(NDEBUG) 37312037Sandreas.sandberg@arm.com std::string descr("'"); 37412037Sandreas.sandberg@arm.com if (a.name) descr += std::string(a.name) + ": "; 37512037Sandreas.sandberg@arm.com descr += a.type + "'"; 37611986Sandreas.sandberg@arm.com if (r->is_method) { 37711986Sandreas.sandberg@arm.com if (r->name) 37811986Sandreas.sandberg@arm.com descr += " in method '" + (std::string) str(r->scope) + "." + (std::string) r->name + "'"; 37911986Sandreas.sandberg@arm.com else 38011986Sandreas.sandberg@arm.com descr += " in method of '" + (std::string) str(r->scope) + "'"; 38111986Sandreas.sandberg@arm.com } else if (r->name) { 38212037Sandreas.sandberg@arm.com descr += " in function '" + (std::string) r->name + "'"; 38311986Sandreas.sandberg@arm.com } 38412037Sandreas.sandberg@arm.com pybind11_fail("arg(): could not convert default argument " 38511986Sandreas.sandberg@arm.com + descr + " into a Python object (type not registered yet?)"); 38611986Sandreas.sandberg@arm.com#else 38712037Sandreas.sandberg@arm.com pybind11_fail("arg(): could not convert default argument " 38811986Sandreas.sandberg@arm.com "into a Python object (type not registered yet?). " 38911986Sandreas.sandberg@arm.com "Compile in debug mode for more information."); 39011986Sandreas.sandberg@arm.com#endif 39111986Sandreas.sandberg@arm.com } 39212391Sjason@lowepower.com r->args.emplace_back(a.name, a.descr, a.value.inc_ref(), !a.flag_noconvert, a.flag_none); 39311986Sandreas.sandberg@arm.com } 39411986Sandreas.sandberg@arm.com}; 39511986Sandreas.sandberg@arm.com 39612037Sandreas.sandberg@arm.com/// Process a parent class attribute. Single inheritance only (class_ itself already guarantees that) 39711986Sandreas.sandberg@arm.comtemplate <typename T> 39811986Sandreas.sandberg@arm.comstruct process_attribute<T, enable_if_t<is_pyobject<T>::value>> : process_attribute_default<handle> { 39911986Sandreas.sandberg@arm.com static void init(const handle &h, type_record *r) { r->bases.append(h); } 40011986Sandreas.sandberg@arm.com}; 40111986Sandreas.sandberg@arm.com 40211986Sandreas.sandberg@arm.com/// Process a parent class attribute (deprecated, does not support multiple inheritance) 40311986Sandreas.sandberg@arm.comtemplate <typename T> 40411986Sandreas.sandberg@arm.comstruct process_attribute<base<T>> : process_attribute_default<base<T>> { 40512391Sjason@lowepower.com static void init(const base<T> &, type_record *r) { r->add_base(typeid(T), nullptr); } 40611986Sandreas.sandberg@arm.com}; 40711986Sandreas.sandberg@arm.com 40811986Sandreas.sandberg@arm.com/// Process a multiple inheritance attribute 40911986Sandreas.sandberg@arm.comtemplate <> 41011986Sandreas.sandberg@arm.comstruct process_attribute<multiple_inheritance> : process_attribute_default<multiple_inheritance> { 41111986Sandreas.sandberg@arm.com static void init(const multiple_inheritance &, type_record *r) { r->multiple_inheritance = true; } 41211986Sandreas.sandberg@arm.com}; 41311986Sandreas.sandberg@arm.com 41411986Sandreas.sandberg@arm.comtemplate <> 41511986Sandreas.sandberg@arm.comstruct process_attribute<dynamic_attr> : process_attribute_default<dynamic_attr> { 41611986Sandreas.sandberg@arm.com static void init(const dynamic_attr &, type_record *r) { r->dynamic_attr = true; } 41711986Sandreas.sandberg@arm.com}; 41811986Sandreas.sandberg@arm.com 41912037Sandreas.sandberg@arm.comtemplate <> 42012037Sandreas.sandberg@arm.comstruct process_attribute<buffer_protocol> : process_attribute_default<buffer_protocol> { 42112037Sandreas.sandberg@arm.com static void init(const buffer_protocol &, type_record *r) { r->buffer_protocol = true; } 42212037Sandreas.sandberg@arm.com}; 42312037Sandreas.sandberg@arm.com 42412037Sandreas.sandberg@arm.comtemplate <> 42512037Sandreas.sandberg@arm.comstruct process_attribute<metaclass> : process_attribute_default<metaclass> { 42612037Sandreas.sandberg@arm.com static void init(const metaclass &m, type_record *r) { r->metaclass = m.value; } 42712037Sandreas.sandberg@arm.com}; 42812037Sandreas.sandberg@arm.com 42912391Sjason@lowepower.comtemplate <> 43012391Sjason@lowepower.comstruct process_attribute<module_local> : process_attribute_default<module_local> { 43112391Sjason@lowepower.com static void init(const module_local &l, type_record *r) { r->module_local = l.value; } 43212391Sjason@lowepower.com}; 43311986Sandreas.sandberg@arm.com 43411986Sandreas.sandberg@arm.com/// Process an 'arithmetic' attribute for enums (does nothing here) 43511986Sandreas.sandberg@arm.comtemplate <> 43611986Sandreas.sandberg@arm.comstruct process_attribute<arithmetic> : process_attribute_default<arithmetic> {}; 43711986Sandreas.sandberg@arm.com 43812391Sjason@lowepower.comtemplate <typename... Ts> 43912391Sjason@lowepower.comstruct process_attribute<call_guard<Ts...>> : process_attribute_default<call_guard<Ts...>> { }; 44012391Sjason@lowepower.com 44112391Sjason@lowepower.com/** 44211986Sandreas.sandberg@arm.com * Process a keep_alive call policy -- invokes keep_alive_impl during the 44311986Sandreas.sandberg@arm.com * pre-call handler if both Nurse, Patient != 0 and use the post-call handler 44411986Sandreas.sandberg@arm.com * otherwise 44511986Sandreas.sandberg@arm.com */ 44612037Sandreas.sandberg@arm.comtemplate <size_t Nurse, size_t Patient> struct process_attribute<keep_alive<Nurse, Patient>> : public process_attribute_default<keep_alive<Nurse, Patient>> { 44712037Sandreas.sandberg@arm.com template <size_t N = Nurse, size_t P = Patient, enable_if_t<N != 0 && P != 0, int> = 0> 44812037Sandreas.sandberg@arm.com static void precall(function_call &call) { keep_alive_impl(Nurse, Patient, call, handle()); } 44912037Sandreas.sandberg@arm.com template <size_t N = Nurse, size_t P = Patient, enable_if_t<N != 0 && P != 0, int> = 0> 45012037Sandreas.sandberg@arm.com static void postcall(function_call &, handle) { } 45112037Sandreas.sandberg@arm.com template <size_t N = Nurse, size_t P = Patient, enable_if_t<N == 0 || P == 0, int> = 0> 45212037Sandreas.sandberg@arm.com static void precall(function_call &) { } 45312037Sandreas.sandberg@arm.com template <size_t N = Nurse, size_t P = Patient, enable_if_t<N == 0 || P == 0, int> = 0> 45412037Sandreas.sandberg@arm.com static void postcall(function_call &call, handle ret) { keep_alive_impl(Nurse, Patient, call, ret); } 45511986Sandreas.sandberg@arm.com}; 45611986Sandreas.sandberg@arm.com 45711986Sandreas.sandberg@arm.com/// Recursively iterate over variadic template arguments 45811986Sandreas.sandberg@arm.comtemplate <typename... Args> struct process_attributes { 45911986Sandreas.sandberg@arm.com static void init(const Args&... args, function_record *r) { 46011986Sandreas.sandberg@arm.com int unused[] = { 0, (process_attribute<typename std::decay<Args>::type>::init(args, r), 0) ... }; 46111986Sandreas.sandberg@arm.com ignore_unused(unused); 46211986Sandreas.sandberg@arm.com } 46311986Sandreas.sandberg@arm.com static void init(const Args&... args, type_record *r) { 46411986Sandreas.sandberg@arm.com int unused[] = { 0, (process_attribute<typename std::decay<Args>::type>::init(args, r), 0) ... }; 46511986Sandreas.sandberg@arm.com ignore_unused(unused); 46611986Sandreas.sandberg@arm.com } 46712037Sandreas.sandberg@arm.com static void precall(function_call &call) { 46812037Sandreas.sandberg@arm.com int unused[] = { 0, (process_attribute<typename std::decay<Args>::type>::precall(call), 0) ... }; 46911986Sandreas.sandberg@arm.com ignore_unused(unused); 47011986Sandreas.sandberg@arm.com } 47112037Sandreas.sandberg@arm.com static void postcall(function_call &call, handle fn_ret) { 47212037Sandreas.sandberg@arm.com int unused[] = { 0, (process_attribute<typename std::decay<Args>::type>::postcall(call, fn_ret), 0) ... }; 47311986Sandreas.sandberg@arm.com ignore_unused(unused); 47411986Sandreas.sandberg@arm.com } 47511986Sandreas.sandberg@arm.com}; 47611986Sandreas.sandberg@arm.com 47712391Sjason@lowepower.comtemplate <typename T> 47812391Sjason@lowepower.comusing is_call_guard = is_instantiation<call_guard, T>; 47912391Sjason@lowepower.com 48012391Sjason@lowepower.com/// Extract the ``type`` from the first `call_guard` in `Extras...` (or `void_type` if none found) 48112391Sjason@lowepower.comtemplate <typename... Extra> 48212391Sjason@lowepower.comusing extract_guard_t = typename exactly_one_t<is_call_guard, call_guard<>, Extra...>::type; 48312391Sjason@lowepower.com 48411986Sandreas.sandberg@arm.com/// Check the number of named arguments at compile time 48511986Sandreas.sandberg@arm.comtemplate <typename... Extra, 48611986Sandreas.sandberg@arm.com size_t named = constexpr_sum(std::is_base_of<arg, Extra>::value...), 48711986Sandreas.sandberg@arm.com size_t self = constexpr_sum(std::is_same<is_method, Extra>::value...)> 48812037Sandreas.sandberg@arm.comconstexpr bool expected_num_args(size_t nargs, bool has_args, bool has_kwargs) { 48912037Sandreas.sandberg@arm.com return named == 0 || (self + named + has_args + has_kwargs) == nargs; 49011986Sandreas.sandberg@arm.com} 49111986Sandreas.sandberg@arm.com 49211986Sandreas.sandberg@arm.comNAMESPACE_END(detail) 49312391Sjason@lowepower.comNAMESPACE_END(PYBIND11_NAMESPACE) 494