Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1 | /* |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 2 | pybind11/pybind11.h: Main header file of the C++11 python |
| 3 | binding generator library |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 4 | |
Wenzel Jakob | 8cb6cb3 | 2016-04-17 20:21:41 +0200 | [diff] [blame] | 5 | Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch> |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 6 | |
| 7 | All rights reserved. Use of this source code is governed by a |
| 8 | BSD-style license that can be found in the LICENSE file. |
| 9 | */ |
| 10 | |
Wenzel Jakob | bd4a529 | 2015-07-11 17:41:48 +0200 | [diff] [blame] | 11 | #pragma once |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 12 | |
| 13 | #if defined(_MSC_VER) |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 14 | # pragma warning(push) |
Wenzel Jakob | 1ffce74 | 2016-08-25 01:43:33 +0200 | [diff] [blame] | 15 | # pragma warning(disable: 4100) // warning C4100: Unreferenced formal parameter |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 16 | # pragma warning(disable: 4127) // warning C4127: Conditional expression is constant |
Wenzel Jakob | 1ffce74 | 2016-08-25 01:43:33 +0200 | [diff] [blame] | 17 | # pragma warning(disable: 4512) // warning C4512: Assignment operator was implicitly defined as deleted |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 18 | # pragma warning(disable: 4800) // warning C4800: 'int': forcing value to bool 'true' or 'false' (performance warning) |
| 19 | # pragma warning(disable: 4996) // warning C4996: The POSIX name for this item is deprecated. Instead, use the ISO C and C++ conformant name |
Wenzel Jakob | 8e5dceb | 2016-09-11 20:00:40 +0900 | [diff] [blame] | 20 | # pragma warning(disable: 4702) // warning C4702: unreachable code |
Wenzel Jakob | 1ffce74 | 2016-08-25 01:43:33 +0200 | [diff] [blame] | 21 | #elif defined(__INTEL_COMPILER) |
Ben Pritchard | 33f3430 | 2016-02-18 15:25:51 -0500 | [diff] [blame] | 22 | # pragma warning(push) |
Wenzel Jakob | 1ffce74 | 2016-08-25 01:43:33 +0200 | [diff] [blame] | 23 | # pragma warning(disable: 186) // pointless comparison of unsigned integer with zero |
| 24 | # pragma warning(disable: 1334) // the "template" keyword used for syntactic disambiguation may only be used within a template |
| 25 | # pragma warning(disable: 2196) // warning #2196: routine is both "inline" and "noinline" |
Wenzel Jakob | 6d25296 | 2016-05-01 20:47:49 +0200 | [diff] [blame] | 26 | #elif defined(__GNUG__) && !defined(__clang__) |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 27 | # pragma GCC diagnostic push |
| 28 | # pragma GCC diagnostic ignored "-Wunused-but-set-parameter" |
| 29 | # pragma GCC diagnostic ignored "-Wunused-but-set-variable" |
| 30 | # pragma GCC diagnostic ignored "-Wmissing-field-initializers" |
Wenzel Jakob | deeab55 | 2016-05-15 23:54:34 +0200 | [diff] [blame] | 31 | # pragma GCC diagnostic ignored "-Wstrict-aliasing" |
| 32 | # pragma GCC diagnostic ignored "-Wattributes" |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 33 | #endif |
| 34 | |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 35 | #include "attr.h" |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 36 | |
Wenzel Jakob | 8f4eb00 | 2015-10-15 18:13:33 +0200 | [diff] [blame] | 37 | NAMESPACE_BEGIN(pybind11) |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 38 | |
Wenzel Jakob | d4258ba | 2015-07-26 16:33:49 +0200 | [diff] [blame] | 39 | /// Wraps an arbitrary C++ function/method/lambda function/.. into a callable Python object |
Wenzel Jakob | bd4a529 | 2015-07-11 17:41:48 +0200 | [diff] [blame] | 40 | class cpp_function : public function { |
Wenzel Jakob | d4258ba | 2015-07-26 16:33:49 +0200 | [diff] [blame] | 41 | public: |
Wenzel Jakob | bd4a529 | 2015-07-11 17:41:48 +0200 | [diff] [blame] | 42 | cpp_function() { } |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 43 | |
Wenzel Jakob | 5984baa | 2016-05-10 15:05:03 +0100 | [diff] [blame] | 44 | /// Construct a cpp_function from a vanilla function pointer |
Wenzel Jakob | 66c9a40 | 2016-01-17 22:36:36 +0100 | [diff] [blame] | 45 | template <typename Return, typename... Args, typename... Extra> |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 46 | cpp_function(Return (*f)(Args...), const Extra&... extra) { |
Wenzel Jakob | 5984baa | 2016-05-10 15:05:03 +0100 | [diff] [blame] | 47 | initialize(f, f, extra...); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 48 | } |
Wenzel Jakob | d4258ba | 2015-07-26 16:33:49 +0200 | [diff] [blame] | 49 | |
Wenzel Jakob | 5984baa | 2016-05-10 15:05:03 +0100 | [diff] [blame] | 50 | /// Construct a cpp_function from a lambda function (possibly with internal state) |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 51 | template <typename Func, typename... Extra> cpp_function(Func &&f, const Extra&... extra) { |
Wenzel Jakob | 7186783 | 2015-07-29 17:43:52 +0200 | [diff] [blame] | 52 | initialize(std::forward<Func>(f), |
Wenzel Jakob | d4258ba | 2015-07-26 16:33:49 +0200 | [diff] [blame] | 53 | (typename detail::remove_class<decltype( |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 54 | &std::remove_reference<Func>::type::operator())>::type *) nullptr, extra...); |
Wenzel Jakob | d4258ba | 2015-07-26 16:33:49 +0200 | [diff] [blame] | 55 | } |
| 56 | |
Wenzel Jakob | 5984baa | 2016-05-10 15:05:03 +0100 | [diff] [blame] | 57 | /// Construct a cpp_function from a class method (non-const) |
| 58 | template <typename Return, typename Class, typename... Arg, typename... Extra> |
| 59 | cpp_function(Return (Class::*f)(Arg...), const Extra&... extra) { |
Wenzel Jakob | 7186783 | 2015-07-29 17:43:52 +0200 | [diff] [blame] | 60 | initialize([f](Class *c, Arg... args) -> Return { return (c->*f)(args...); }, |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 61 | (Return (*) (Class *, Arg...)) nullptr, extra...); |
Wenzel Jakob | d4258ba | 2015-07-26 16:33:49 +0200 | [diff] [blame] | 62 | } |
| 63 | |
Wenzel Jakob | 5984baa | 2016-05-10 15:05:03 +0100 | [diff] [blame] | 64 | /// Construct a cpp_function from a class method (const) |
| 65 | template <typename Return, typename Class, typename... Arg, typename... Extra> |
| 66 | cpp_function(Return (Class::*f)(Arg...) const, const Extra&... extra) { |
Wenzel Jakob | 7186783 | 2015-07-29 17:43:52 +0200 | [diff] [blame] | 67 | initialize([f](const Class *c, Arg... args) -> Return { return (c->*f)(args...); }, |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 68 | (Return (*)(const Class *, Arg ...)) nullptr, extra...); |
Wenzel Jakob | d4258ba | 2015-07-26 16:33:49 +0200 | [diff] [blame] | 69 | } |
| 70 | |
Wenzel Jakob | 5708221 | 2015-09-04 23:42:12 +0200 | [diff] [blame] | 71 | /// Return the function name |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 72 | object name() const { return attr("__name__"); } |
Wenzel Jakob | 5708221 | 2015-09-04 23:42:12 +0200 | [diff] [blame] | 73 | |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 74 | protected: |
Wenzel Jakob | 382484a | 2016-09-10 15:28:37 +0900 | [diff] [blame] | 75 | /// Space optimization: don't inline this frequently instantiated fragment |
| 76 | PYBIND11_NOINLINE detail::function_record *make_function_record() { |
| 77 | return new detail::function_record(); |
| 78 | } |
| 79 | |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 80 | /// Special internal constructor for functors, lambda functions, etc. |
Wenzel Jakob | 66c9a40 | 2016-01-17 22:36:36 +0100 | [diff] [blame] | 81 | template <typename Func, typename Return, typename... Args, typename... Extra> |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 82 | void initialize(Func &&f, Return (*)(Args...), const Extra&... extra) { |
Dean Moldovan | 9e62558 | 2016-06-04 00:27:32 +0200 | [diff] [blame] | 83 | static_assert(detail::expected_num_args<Extra...>(sizeof...(Args)), |
| 84 | "The number of named arguments does not match the function signature"); |
| 85 | |
Wenzel Jakob | 66c9a40 | 2016-01-17 22:36:36 +0100 | [diff] [blame] | 86 | struct capture { typename std::remove_reference<Func>::type f; }; |
Wenzel Jakob | d4258ba | 2015-07-26 16:33:49 +0200 | [diff] [blame] | 87 | |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 88 | /* Store the function including any extra state it might have (e.g. a lambda capture object) */ |
Wenzel Jakob | 382484a | 2016-09-10 15:28:37 +0900 | [diff] [blame] | 89 | auto rec = make_function_record(); |
Wenzel Jakob | 7186783 | 2015-07-29 17:43:52 +0200 | [diff] [blame] | 90 | |
Wenzel Jakob | 5984baa | 2016-05-10 15:05:03 +0100 | [diff] [blame] | 91 | /* Store the capture object directly in the function record if there is enough space */ |
| 92 | if (sizeof(capture) <= sizeof(rec->data)) { |
Wenzel Jakob | 954b793 | 2016-07-10 10:13:18 +0200 | [diff] [blame] | 93 | /* Without these pragmas, GCC warns that there might not be |
| 94 | enough space to use the placement new operator. However, the |
| 95 | 'if' statement above ensures that this is the case. */ |
Jason Rhinelander | 0b12f91 | 2016-07-07 16:26:04 -0400 | [diff] [blame] | 96 | #if defined(__GNUG__) && !defined(__clang__) && __GNUC__ >= 6 |
Jason Rhinelander | cae0e00 | 2016-07-07 16:11:42 -0400 | [diff] [blame] | 97 | # pragma GCC diagnostic push |
| 98 | # pragma GCC diagnostic ignored "-Wplacement-new" |
| 99 | #endif |
Wenzel Jakob | 5984baa | 2016-05-10 15:05:03 +0100 | [diff] [blame] | 100 | new ((capture *) &rec->data) capture { std::forward<Func>(f) }; |
Jason Rhinelander | 0b12f91 | 2016-07-07 16:26:04 -0400 | [diff] [blame] | 101 | #if defined(__GNUG__) && !defined(__clang__) && __GNUC__ >= 6 |
Jason Rhinelander | cae0e00 | 2016-07-07 16:11:42 -0400 | [diff] [blame] | 102 | # pragma GCC diagnostic pop |
| 103 | #endif |
Wenzel Jakob | 5984baa | 2016-05-10 15:05:03 +0100 | [diff] [blame] | 104 | if (!std::is_trivially_destructible<Func>::value) |
| 105 | rec->free_data = [](detail::function_record *r) { ((capture *) &r->data)->~capture(); }; |
| 106 | } else { |
| 107 | rec->data[0] = new capture { std::forward<Func>(f) }; |
| 108 | rec->free_data = [](detail::function_record *r) { delete ((capture *) r->data[0]); }; |
| 109 | } |
Wenzel Jakob | 19208fe | 2015-10-13 17:37:25 +0200 | [diff] [blame] | 110 | |
Wenzel Jakob | 5984baa | 2016-05-10 15:05:03 +0100 | [diff] [blame] | 111 | /* Type casters for the function arguments and return value */ |
| 112 | typedef detail::type_caster<typename std::tuple<Args...>> cast_in; |
| 113 | typedef detail::type_caster<typename std::conditional< |
| 114 | std::is_void<Return>::value, detail::void_type, |
| 115 | typename detail::intrinsic_type<Return>::type>::type> cast_out; |
Wenzel Jakob | 7186783 | 2015-07-29 17:43:52 +0200 | [diff] [blame] | 116 | |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 117 | /* Dispatch code which converts function arguments and performs the actual function call */ |
Wenzel Jakob | 178c8a8 | 2016-05-10 15:59:01 +0100 | [diff] [blame] | 118 | rec->impl = [](detail::function_record *rec, handle args, handle kwargs, handle parent) -> handle { |
Wenzel Jakob | 5984baa | 2016-05-10 15:05:03 +0100 | [diff] [blame] | 119 | cast_in args_converter; |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 120 | |
| 121 | /* Try to cast the function arguments into the C++ domain */ |
Wenzel Jakob | 178c8a8 | 2016-05-10 15:59:01 +0100 | [diff] [blame] | 122 | if (!args_converter.load_args(args, kwargs, true)) |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 123 | return PYBIND11_TRY_NEXT_OVERLOAD; |
| 124 | |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 125 | /* Invoke call policy pre-call hook */ |
Wenzel Jakob | 5984baa | 2016-05-10 15:05:03 +0100 | [diff] [blame] | 126 | detail::process_attributes<Extra...>::precall(args); |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 127 | |
Wenzel Jakob | 5984baa | 2016-05-10 15:05:03 +0100 | [diff] [blame] | 128 | /* Get a pointer to the capture object */ |
| 129 | capture *cap = (capture *) (sizeof(capture) <= sizeof(rec->data) |
| 130 | ? &rec->data : rec->data[0]); |
| 131 | |
Wenzel Jakob | 954b793 | 2016-07-10 10:13:18 +0200 | [diff] [blame] | 132 | /* Perform the function call */ |
Wenzel Jakob | 5984baa | 2016-05-10 15:05:03 +0100 | [diff] [blame] | 133 | handle result = cast_out::cast(args_converter.template call<Return>(cap->f), |
| 134 | rec->policy, parent); |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 135 | |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 136 | /* Invoke call policy post-call hook */ |
Wenzel Jakob | 5984baa | 2016-05-10 15:05:03 +0100 | [diff] [blame] | 137 | detail::process_attributes<Extra...>::postcall(args, result); |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 138 | |
Wenzel Jakob | 5f218b3 | 2016-01-17 22:36:39 +0100 | [diff] [blame] | 139 | return result; |
Wenzel Jakob | 7186783 | 2015-07-29 17:43:52 +0200 | [diff] [blame] | 140 | }; |
| 141 | |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 142 | /* Process any user-provided function attributes */ |
| 143 | detail::process_attributes<Extra...>::init(extra..., rec); |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 144 | |
| 145 | /* Generate a readable signature describing the function's arguments and return value types */ |
Dean Moldovan | ed23dda | 2016-08-04 01:40:40 +0200 | [diff] [blame] | 146 | using detail::descr; using detail::_; |
| 147 | PYBIND11_DESCR signature = _("(") + cast_in::element_names() + _(") -> ") + cast_out::name(); |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 148 | |
| 149 | /* Register the function with Python from generic (non-templated) code */ |
Wenzel Jakob | 5984baa | 2016-05-10 15:05:03 +0100 | [diff] [blame] | 150 | initialize_generic(rec, signature.text(), signature.types(), sizeof...(Args)); |
Wenzel Jakob | 178c8a8 | 2016-05-10 15:59:01 +0100 | [diff] [blame] | 151 | |
| 152 | if (cast_in::has_args) rec->has_args = true; |
| 153 | if (cast_in::has_kwargs) rec->has_kwargs = true; |
Wenzel Jakob | 954b793 | 2016-07-10 10:13:18 +0200 | [diff] [blame] | 154 | |
| 155 | /* Stash some additional information used by an important optimization in 'functional.h' */ |
| 156 | using FunctionType = Return (*)(Args...); |
| 157 | constexpr bool is_function_ptr = |
| 158 | std::is_convertible<Func, FunctionType>::value && |
| 159 | sizeof(capture) == sizeof(void *); |
| 160 | if (is_function_ptr) { |
| 161 | rec->is_stateless = true; |
| 162 | rec->data[1] = (void *) &typeid(FunctionType); |
| 163 | } |
Wenzel Jakob | 281aa0e | 2015-07-30 15:29:00 +0200 | [diff] [blame] | 164 | } |
| 165 | |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 166 | /// Register a function call with Python (generic non-templated code goes here) |
Wenzel Jakob | 5984baa | 2016-05-10 15:05:03 +0100 | [diff] [blame] | 167 | void initialize_generic(detail::function_record *rec, const char *text, |
Dean Moldovan | ecced6c | 2016-07-31 20:03:18 +0200 | [diff] [blame] | 168 | const std::type_info *const *types, size_t args) { |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 169 | |
Wenzel Jakob | 66c9a40 | 2016-01-17 22:36:36 +0100 | [diff] [blame] | 170 | /* Create copies of all referenced C-style strings */ |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 171 | rec->name = strdup(rec->name ? rec->name : ""); |
| 172 | if (rec->doc) rec->doc = strdup(rec->doc); |
| 173 | for (auto &a: rec->args) { |
Wenzel Jakob | 66c9a40 | 2016-01-17 22:36:36 +0100 | [diff] [blame] | 174 | if (a.name) |
| 175 | a.name = strdup(a.name); |
| 176 | if (a.descr) |
| 177 | a.descr = strdup(a.descr); |
| 178 | else if (a.value) |
Dean Moldovan | 242b146 | 2016-09-08 17:02:04 +0200 | [diff] [blame^] | 179 | a.descr = strdup(a.value.attr("__repr__")().cast<std::string>().c_str()); |
Wenzel Jakob | 66c9a40 | 2016-01-17 22:36:36 +0100 | [diff] [blame] | 180 | } |
Wenzel Jakob | 954b793 | 2016-07-10 10:13:18 +0200 | [diff] [blame] | 181 | |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 182 | auto const ®istered_types = detail::get_internals().registered_types_cpp; |
Wenzel Jakob | 66c9a40 | 2016-01-17 22:36:36 +0100 | [diff] [blame] | 183 | |
| 184 | /* Generate a proper function signature */ |
| 185 | std::string signature; |
| 186 | size_t type_depth = 0, char_index = 0, type_index = 0, arg_index = 0; |
| 187 | while (true) { |
| 188 | char c = text[char_index++]; |
| 189 | if (c == '\0') |
| 190 | break; |
| 191 | |
| 192 | if (c == '{') { |
Dean Moldovan | ecced6c | 2016-07-31 20:03:18 +0200 | [diff] [blame] | 193 | // Write arg name for everything except *args, **kwargs and return type. |
Dean Moldovan | ed23dda | 2016-08-04 01:40:40 +0200 | [diff] [blame] | 194 | if (type_depth == 0 && text[char_index] != '*' && arg_index < args) { |
Dean Moldovan | ecced6c | 2016-07-31 20:03:18 +0200 | [diff] [blame] | 195 | if (!rec->args.empty()) { |
| 196 | signature += rec->args[arg_index].name; |
| 197 | } else if (arg_index == 0 && rec->class_) { |
| 198 | signature += "self"; |
| 199 | } else { |
| 200 | signature += "arg" + std::to_string(arg_index - (rec->class_ ? 1 : 0)); |
| 201 | } |
| 202 | signature += ": "; |
Wenzel Jakob | 66c9a40 | 2016-01-17 22:36:36 +0100 | [diff] [blame] | 203 | } |
| 204 | ++type_depth; |
| 205 | } else if (c == '}') { |
| 206 | --type_depth; |
Dean Moldovan | ed23dda | 2016-08-04 01:40:40 +0200 | [diff] [blame] | 207 | if (type_depth == 0) { |
Dean Moldovan | ecced6c | 2016-07-31 20:03:18 +0200 | [diff] [blame] | 208 | if (arg_index < rec->args.size() && rec->args[arg_index].descr) { |
| 209 | signature += "="; |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 210 | signature += rec->args[arg_index].descr; |
Wenzel Jakob | 66c9a40 | 2016-01-17 22:36:36 +0100 | [diff] [blame] | 211 | } |
| 212 | arg_index++; |
| 213 | } |
| 214 | } else if (c == '%') { |
| 215 | const std::type_info *t = types[type_index++]; |
Wenzel Jakob | b2c2c79 | 2016-01-17 22:36:40 +0100 | [diff] [blame] | 216 | if (!t) |
Wenzel Jakob | 678d787 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 217 | pybind11_fail("Internal error while parsing type signature (1)"); |
Wenzel Jakob | b6cf75d | 2016-01-29 11:39:32 +0100 | [diff] [blame] | 218 | auto it = registered_types.find(std::type_index(*t)); |
Wenzel Jakob | 66c9a40 | 2016-01-17 22:36:36 +0100 | [diff] [blame] | 219 | if (it != registered_types.end()) { |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 220 | signature += ((const detail::type_info *) it->second)->type->tp_name; |
Wenzel Jakob | 66c9a40 | 2016-01-17 22:36:36 +0100 | [diff] [blame] | 221 | } else { |
| 222 | std::string tname(t->name()); |
| 223 | detail::clean_type_id(tname); |
| 224 | signature += tname; |
| 225 | } |
| 226 | } else { |
| 227 | signature += c; |
| 228 | } |
| 229 | } |
Wenzel Jakob | 95d1869 | 2016-01-17 22:36:40 +0100 | [diff] [blame] | 230 | if (type_depth != 0 || types[type_index] != nullptr) |
Wenzel Jakob | 678d787 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 231 | pybind11_fail("Internal error while parsing type signature (2)"); |
Wenzel Jakob | 66c9a40 | 2016-01-17 22:36:36 +0100 | [diff] [blame] | 232 | |
| 233 | #if !defined(PYBIND11_CPP14) |
| 234 | delete[] types; |
| 235 | delete[] text; |
| 236 | #endif |
Wenzel Jakob | f5fae92 | 2015-08-24 15:31:24 +0200 | [diff] [blame] | 237 | |
Wenzel Jakob | 5708221 | 2015-09-04 23:42:12 +0200 | [diff] [blame] | 238 | #if PY_MAJOR_VERSION < 3 |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 239 | if (strcmp(rec->name, "__next__") == 0) { |
| 240 | std::free(rec->name); |
| 241 | rec->name = strdup("next"); |
Wenzel Jakob | d1bfc4e | 2016-05-16 18:52:46 +0200 | [diff] [blame] | 242 | } else if (strcmp(rec->name, "__bool__") == 0) { |
| 243 | std::free(rec->name); |
| 244 | rec->name = strdup("__nonzero__"); |
Wenzel Jakob | 66c9a40 | 2016-01-17 22:36:36 +0100 | [diff] [blame] | 245 | } |
Wenzel Jakob | 5708221 | 2015-09-04 23:42:12 +0200 | [diff] [blame] | 246 | #endif |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 247 | rec->signature = strdup(signature.c_str()); |
| 248 | rec->args.shrink_to_fit(); |
Wenzel Jakob | a380ed9 | 2016-05-15 23:54:13 +0200 | [diff] [blame] | 249 | rec->is_constructor = !strcmp(rec->name, "__init__") || !strcmp(rec->name, "__setstate__"); |
Wenzel Jakob | affb9f4 | 2016-05-15 23:55:06 +0200 | [diff] [blame] | 250 | rec->nargs = (uint16_t) args; |
Wenzel Jakob | bd4a529 | 2015-07-11 17:41:48 +0200 | [diff] [blame] | 251 | |
Wenzel Jakob | 5708221 | 2015-09-04 23:42:12 +0200 | [diff] [blame] | 252 | #if PY_MAJOR_VERSION < 3 |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 253 | if (rec->sibling && PyMethod_Check(rec->sibling.ptr())) |
| 254 | rec->sibling = PyMethod_GET_FUNCTION(rec->sibling.ptr()); |
Wenzel Jakob | 5708221 | 2015-09-04 23:42:12 +0200 | [diff] [blame] | 255 | #endif |
| 256 | |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 257 | detail::function_record *chain = nullptr, *chain_start = rec; |
| 258 | if (rec->sibling && PyCFunction_Check(rec->sibling.ptr())) { |
| 259 | capsule rec_capsule(PyCFunction_GetSelf(rec->sibling.ptr()), true); |
| 260 | chain = (detail::function_record *) rec_capsule; |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 261 | /* Never append a method to an overload chain of a parent class; |
| 262 | instead, hide the parent's overloads in this case */ |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 263 | if (chain->class_ != rec->class_) |
| 264 | chain = nullptr; |
Wenzel Jakob | a2f6fde | 2015-10-01 16:46:03 +0200 | [diff] [blame] | 265 | } |
| 266 | |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 267 | if (!chain) { |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 268 | /* No existing overload was found, create a new function object */ |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 269 | rec->def = new PyMethodDef(); |
| 270 | memset(rec->def, 0, sizeof(PyMethodDef)); |
| 271 | rec->def->ml_name = rec->name; |
| 272 | rec->def->ml_meth = reinterpret_cast<PyCFunction>(*dispatcher); |
| 273 | rec->def->ml_flags = METH_VARARGS | METH_KEYWORDS; |
Wenzel Jakob | a650179 | 2016-02-04 23:02:07 +0100 | [diff] [blame] | 274 | |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 275 | capsule rec_capsule(rec, [](PyObject *o) { |
| 276 | destruct((detail::function_record *) PyCapsule_GetPointer(o, nullptr)); |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 277 | }); |
Wenzel Jakob | a650179 | 2016-02-04 23:02:07 +0100 | [diff] [blame] | 278 | |
| 279 | object scope_module; |
| 280 | if (rec->scope) { |
Dean Moldovan | 865e430 | 2016-09-21 01:06:32 +0200 | [diff] [blame] | 281 | if (hasattr(rec->scope, "__module__")) { |
| 282 | scope_module = rec->scope.attr("__module__"); |
| 283 | } else if (hasattr(rec->scope, "__name__")) { |
| 284 | scope_module = rec->scope.attr("__name__"); |
| 285 | } |
Wenzel Jakob | a650179 | 2016-02-04 23:02:07 +0100 | [diff] [blame] | 286 | } |
| 287 | |
| 288 | m_ptr = PyCFunction_NewEx(rec->def, rec_capsule.ptr(), scope_module.ptr()); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 289 | if (!m_ptr) |
Wenzel Jakob | 678d787 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 290 | pybind11_fail("cpp_function::cpp_function(): Could not allocate function object"); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 291 | } else { |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 292 | /* Append at the end of the overload chain */ |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 293 | m_ptr = rec->sibling.ptr(); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 294 | inc_ref(); |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 295 | chain_start = chain; |
| 296 | while (chain->next) |
| 297 | chain = chain->next; |
| 298 | chain->next = rec; |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 299 | } |
Wenzel Jakob | 281aa0e | 2015-07-30 15:29:00 +0200 | [diff] [blame] | 300 | |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 301 | std::string signatures; |
Wenzel Jakob | 7186783 | 2015-07-29 17:43:52 +0200 | [diff] [blame] | 302 | int index = 0; |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 303 | /* Create a nice pydoc rec including all signatures and |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 304 | docstrings of the functions in the overload chain */ |
Sylvain Corlay | 0e04fdf | 2016-03-08 16:42:12 -0500 | [diff] [blame] | 305 | if (chain) { |
| 306 | // First a generic signature |
| 307 | signatures += rec->name; |
| 308 | signatures += "(*args, **kwargs)\n"; |
| 309 | signatures += "Overloaded function.\n\n"; |
| 310 | } |
| 311 | // Then specific overload signatures |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 312 | for (auto it = chain_start; it != nullptr; it = it->next) { |
| 313 | if (chain) |
Wenzel Jakob | 7186783 | 2015-07-29 17:43:52 +0200 | [diff] [blame] | 314 | signatures += std::to_string(++index) + ". "; |
Sylvain Corlay | 13b22bf | 2016-02-28 21:23:39 -0500 | [diff] [blame] | 315 | signatures += rec->name; |
Wenzel Jakob | 66c9a40 | 2016-01-17 22:36:36 +0100 | [diff] [blame] | 316 | signatures += it->signature; |
| 317 | signatures += "\n"; |
| 318 | if (it->doc && strlen(it->doc) > 0) { |
| 319 | signatures += "\n"; |
Wenzel Jakob | 218b6ce | 2016-02-28 23:52:37 +0100 | [diff] [blame] | 320 | signatures += it->doc; |
Wenzel Jakob | 66c9a40 | 2016-01-17 22:36:36 +0100 | [diff] [blame] | 321 | signatures += "\n"; |
| 322 | } |
Wenzel Jakob | 7186783 | 2015-07-29 17:43:52 +0200 | [diff] [blame] | 323 | if (it->next) |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 324 | signatures += "\n"; |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 325 | } |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 326 | |
| 327 | /* Install docstring */ |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 328 | PyCFunctionObject *func = (PyCFunctionObject *) m_ptr; |
| 329 | if (func->m_ml->ml_doc) |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 330 | std::free((char *) func->m_ml->ml_doc); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 331 | func->m_ml->ml_doc = strdup(signatures.c_str()); |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 332 | |
| 333 | if (rec->class_) { |
| 334 | m_ptr = PYBIND11_INSTANCE_METHOD_NEW(m_ptr, rec->class_.ptr()); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 335 | if (!m_ptr) |
Wenzel Jakob | 678d787 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 336 | pybind11_fail("cpp_function::cpp_function(): Could not allocate instance method object"); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 337 | Py_DECREF(func); |
| 338 | } |
| 339 | } |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 340 | |
| 341 | /// When a cpp_function is GCed, release any memory allocated by pybind11 |
| 342 | static void destruct(detail::function_record *rec) { |
| 343 | while (rec) { |
| 344 | detail::function_record *next = rec->next; |
| 345 | if (rec->free_data) |
Wenzel Jakob | 5984baa | 2016-05-10 15:05:03 +0100 | [diff] [blame] | 346 | rec->free_data(rec); |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 347 | std::free((char *) rec->name); |
| 348 | std::free((char *) rec->doc); |
| 349 | std::free((char *) rec->signature); |
| 350 | for (auto &arg: rec->args) { |
| 351 | std::free((char *) arg.name); |
| 352 | std::free((char *) arg.descr); |
| 353 | arg.value.dec_ref(); |
| 354 | } |
| 355 | if (rec->def) { |
| 356 | std::free((char *) rec->def->ml_doc); |
| 357 | delete rec->def; |
| 358 | } |
| 359 | delete rec; |
| 360 | rec = next; |
| 361 | } |
| 362 | } |
| 363 | |
| 364 | /// Main dispatch logic for calls to functions bound using pybind11 |
| 365 | static PyObject *dispatcher(PyObject *self, PyObject *args, PyObject *kwargs) { |
| 366 | /* Iterator over the list of potentially admissible overloads */ |
| 367 | detail::function_record *overloads = (detail::function_record *) PyCapsule_GetPointer(self, nullptr), |
| 368 | *it = overloads; |
| 369 | |
| 370 | /* Need to know how many arguments + keyword arguments there are to pick the right overload */ |
Wenzel Jakob | 0a07805 | 2016-05-29 13:40:40 +0200 | [diff] [blame] | 371 | size_t nargs = (size_t) PyTuple_GET_SIZE(args), |
| 372 | nkwargs = kwargs ? (size_t) PyDict_Size(kwargs) : 0; |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 373 | |
Wenzel Jakob | 178c8a8 | 2016-05-10 15:59:01 +0100 | [diff] [blame] | 374 | handle parent = nargs > 0 ? PyTuple_GET_ITEM(args, 0) : nullptr, |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 375 | result = PYBIND11_TRY_NEXT_OVERLOAD; |
| 376 | try { |
| 377 | for (; it != nullptr; it = it->next) { |
| 378 | tuple args_(args, true); |
Wenzel Jakob | 178c8a8 | 2016-05-10 15:59:01 +0100 | [diff] [blame] | 379 | size_t kwargs_consumed = 0; |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 380 | |
| 381 | /* For each overload: |
| 382 | 1. If the required list of arguments is longer than the |
| 383 | actually provided amount, create a copy of the argument |
| 384 | list and fill in any available keyword/default arguments. |
| 385 | 2. Ensure that all keyword arguments were "consumed" |
| 386 | 3. Call the function call dispatcher (function_record::impl) |
| 387 | */ |
Wenzel Jakob | 178c8a8 | 2016-05-10 15:59:01 +0100 | [diff] [blame] | 388 | size_t nargs_ = nargs; |
| 389 | if (nargs < it->args.size()) { |
| 390 | nargs_ = it->args.size(); |
| 391 | args_ = tuple(nargs_); |
| 392 | for (size_t i = 0; i < nargs; ++i) { |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 393 | handle item = PyTuple_GET_ITEM(args, i); |
| 394 | PyTuple_SET_ITEM(args_.ptr(), i, item.inc_ref().ptr()); |
| 395 | } |
| 396 | |
| 397 | int arg_ctr = 0; |
| 398 | for (auto const &it2 : it->args) { |
| 399 | int index = arg_ctr++; |
| 400 | if (PyTuple_GET_ITEM(args_.ptr(), index)) |
| 401 | continue; |
| 402 | |
| 403 | handle value; |
| 404 | if (kwargs) |
| 405 | value = PyDict_GetItemString(kwargs, it2.name); |
| 406 | |
| 407 | if (value) |
| 408 | kwargs_consumed++; |
| 409 | else if (it2.value) |
| 410 | value = it2.value; |
| 411 | |
| 412 | if (value) { |
| 413 | PyTuple_SET_ITEM(args_.ptr(), index, value.inc_ref().ptr()); |
| 414 | } else { |
Wenzel Jakob | 178c8a8 | 2016-05-10 15:59:01 +0100 | [diff] [blame] | 415 | kwargs_consumed = (size_t) -1; /* definite failure */ |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 416 | break; |
| 417 | } |
| 418 | } |
| 419 | } |
Wenzel Jakob | bd57eb4 | 2016-05-01 14:42:20 +0200 | [diff] [blame] | 420 | |
| 421 | try { |
Wenzel Jakob | 178c8a8 | 2016-05-10 15:59:01 +0100 | [diff] [blame] | 422 | if ((kwargs_consumed == nkwargs || it->has_kwargs) && |
| 423 | (nargs_ == it->nargs || it->has_args)) |
| 424 | result = it->impl(it, args_, kwargs, parent); |
Wenzel Jakob | 0006259 | 2016-07-01 16:07:35 +0200 | [diff] [blame] | 425 | } catch (reference_cast_error &) { |
Wenzel Jakob | bd57eb4 | 2016-05-01 14:42:20 +0200 | [diff] [blame] | 426 | result = PYBIND11_TRY_NEXT_OVERLOAD; |
| 427 | } |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 428 | |
| 429 | if (result.ptr() != PYBIND11_TRY_NEXT_OVERLOAD) |
| 430 | break; |
| 431 | } |
Dean Moldovan | 135ba8d | 2016-09-10 11:58:02 +0200 | [diff] [blame] | 432 | } catch (error_already_set &e) { |
| 433 | e.restore(); |
Pim Schellart | 5a7d17f | 2016-06-17 17:35:59 -0400 | [diff] [blame] | 434 | return nullptr; |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 435 | } catch (...) { |
Pim Schellart | 5a7d17f | 2016-06-17 17:35:59 -0400 | [diff] [blame] | 436 | /* When an exception is caught, give each registered exception |
| 437 | translator a chance to translate it to a Python exception |
| 438 | in reverse order of registration. |
Wenzel Jakob | 1f66a58 | 2016-07-18 10:47:10 +0200 | [diff] [blame] | 439 | |
Pim Schellart | 5a7d17f | 2016-06-17 17:35:59 -0400 | [diff] [blame] | 440 | A translator may choose to do one of the following: |
Wenzel Jakob | 1f66a58 | 2016-07-18 10:47:10 +0200 | [diff] [blame] | 441 | |
Pim Schellart | 5a7d17f | 2016-06-17 17:35:59 -0400 | [diff] [blame] | 442 | - catch the exception and call PyErr_SetString or PyErr_SetObject |
| 443 | to set a standard (or custom) Python exception, or |
| 444 | - do nothing and let the exception fall through to the next translator, or |
| 445 | - delegate translation to the next translator by throwing a new type of exception. */ |
| 446 | |
Wenzel Jakob | 1f66a58 | 2016-07-18 10:47:10 +0200 | [diff] [blame] | 447 | auto last_exception = std::current_exception(); |
Pim Schellart | 5a7d17f | 2016-06-17 17:35:59 -0400 | [diff] [blame] | 448 | auto ®istered_exception_translators = pybind11::detail::get_internals().registered_exception_translators; |
| 449 | for (auto& translator : registered_exception_translators) { |
| 450 | try { |
| 451 | translator(last_exception); |
| 452 | } catch (...) { |
| 453 | last_exception = std::current_exception(); |
| 454 | continue; |
| 455 | } |
| 456 | return nullptr; |
| 457 | } |
| 458 | PyErr_SetString(PyExc_SystemError, "Exception escaped from default exception translator!"); |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 459 | return nullptr; |
| 460 | } |
| 461 | |
| 462 | if (result.ptr() == PYBIND11_TRY_NEXT_OVERLOAD) { |
Wenzel Jakob | 382484a | 2016-09-10 15:28:37 +0900 | [diff] [blame] | 463 | if (overloads->is_operator) |
| 464 | return handle(Py_NotImplemented).inc_ref().ptr(); |
| 465 | |
Wenzel Jakob | e99ebae | 2016-09-12 11:44:37 +0900 | [diff] [blame] | 466 | std::string msg = std::string(overloads->name) + "(): incompatible " + |
| 467 | std::string(overloads->is_constructor ? "constructor" : "function") + |
| 468 | " arguments. The following argument types are supported:\n"; |
| 469 | |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 470 | int ctr = 0; |
| 471 | for (detail::function_record *it2 = overloads; it2 != nullptr; it2 = it2->next) { |
| 472 | msg += " "+ std::to_string(++ctr) + ". "; |
Jason Rhinelander | 4e45e18 | 2016-07-17 17:43:00 -0400 | [diff] [blame] | 473 | |
| 474 | bool wrote_sig = false; |
| 475 | if (overloads->is_constructor) { |
Dean Moldovan | ecced6c | 2016-07-31 20:03:18 +0200 | [diff] [blame] | 476 | // For a constructor, rewrite `(self: Object, arg0, ...) -> NoneType` as `Object(arg0, ...)` |
Jason Rhinelander | 4e45e18 | 2016-07-17 17:43:00 -0400 | [diff] [blame] | 477 | std::string sig = it2->signature; |
Dean Moldovan | ecced6c | 2016-07-31 20:03:18 +0200 | [diff] [blame] | 478 | size_t start = sig.find('(') + 7; // skip "(self: " |
Jason Rhinelander | 4e45e18 | 2016-07-17 17:43:00 -0400 | [diff] [blame] | 479 | if (start < sig.size()) { |
| 480 | // End at the , for the next argument |
| 481 | size_t end = sig.find(", "), next = end + 2; |
| 482 | size_t ret = sig.rfind(" -> "); |
| 483 | // Or the ), if there is no comma: |
| 484 | if (end >= sig.size()) next = end = sig.find(')'); |
| 485 | if (start < end && next < sig.size()) { |
| 486 | msg.append(sig, start, end - start); |
| 487 | msg += '('; |
| 488 | msg.append(sig, next, ret - next); |
| 489 | wrote_sig = true; |
| 490 | } |
| 491 | } |
| 492 | } |
| 493 | if (!wrote_sig) msg += it2->signature; |
| 494 | |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 495 | msg += "\n"; |
| 496 | } |
Wenzel Jakob | e99ebae | 2016-09-12 11:44:37 +0900 | [diff] [blame] | 497 | msg += "\nInvoked with: "; |
Andreas Bergmeier | 16d4394 | 2016-05-24 09:19:35 +0200 | [diff] [blame] | 498 | tuple args_(args, true); |
Wenzel Jakob | 1f66a58 | 2016-07-18 10:47:10 +0200 | [diff] [blame] | 499 | for (size_t ti = overloads->is_constructor ? 1 : 0; ti < args_.size(); ++ti) { |
Andreas Bergmeier | 16d4394 | 2016-05-24 09:19:35 +0200 | [diff] [blame] | 500 | msg += static_cast<std::string>(static_cast<object>(args_[ti]).str()); |
| 501 | if ((ti + 1) != args_.size() ) |
| 502 | msg += ", "; |
| 503 | } |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 504 | PyErr_SetString(PyExc_TypeError, msg.c_str()); |
| 505 | return nullptr; |
| 506 | } else if (!result) { |
| 507 | std::string msg = "Unable to convert function return value to a " |
| 508 | "Python type! The signature was\n\t"; |
| 509 | msg += it->signature; |
| 510 | PyErr_SetString(PyExc_TypeError, msg.c_str()); |
| 511 | return nullptr; |
| 512 | } else { |
| 513 | if (overloads->is_constructor) { |
Wenzel Jakob | 772c6d5 | 2016-04-30 19:56:10 +0200 | [diff] [blame] | 514 | /* When a constructor ran successfully, the corresponding |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 515 | holder type (e.g. std::unique_ptr) must still be initialized. */ |
Wenzel Jakob | 178c8a8 | 2016-05-10 15:59:01 +0100 | [diff] [blame] | 516 | PyObject *inst = PyTuple_GET_ITEM(args, 0); |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 517 | auto tinfo = detail::get_type_info(Py_TYPE(inst)); |
| 518 | tinfo->init_holder(inst, nullptr); |
| 519 | } |
| 520 | return result.ptr(); |
| 521 | } |
| 522 | } |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 523 | }; |
| 524 | |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 525 | /// Wrapper for Python extension modules |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 526 | class module : public object { |
| 527 | public: |
Wenzel Jakob | b1b7140 | 2015-10-18 16:48:30 +0200 | [diff] [blame] | 528 | PYBIND11_OBJECT_DEFAULT(module, object, PyModule_Check) |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 529 | |
| 530 | module(const char *name, const char *doc = nullptr) { |
Wenzel Jakob | 5708221 | 2015-09-04 23:42:12 +0200 | [diff] [blame] | 531 | #if PY_MAJOR_VERSION >= 3 |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 532 | PyModuleDef *def = new PyModuleDef(); |
| 533 | memset(def, 0, sizeof(PyModuleDef)); |
| 534 | def->m_name = name; |
| 535 | def->m_doc = doc; |
| 536 | def->m_size = -1; |
| 537 | Py_INCREF(def); |
| 538 | m_ptr = PyModule_Create(def); |
Wenzel Jakob | 5708221 | 2015-09-04 23:42:12 +0200 | [diff] [blame] | 539 | #else |
| 540 | m_ptr = Py_InitModule3(name, nullptr, doc); |
| 541 | #endif |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 542 | if (m_ptr == nullptr) |
Wenzel Jakob | 678d787 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 543 | pybind11_fail("Internal error in module::module()"); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 544 | inc_ref(); |
| 545 | } |
| 546 | |
Wenzel Jakob | 7186783 | 2015-07-29 17:43:52 +0200 | [diff] [blame] | 547 | template <typename Func, typename... Extra> |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 548 | module &def(const char *name_, Func &&f, const Extra& ... extra) { |
Dean Moldovan | 865e430 | 2016-09-21 01:06:32 +0200 | [diff] [blame] | 549 | cpp_function func(std::forward<Func>(f), name(name_), scope(*this), |
| 550 | sibling(getattr(*this, name_, none())), extra...); |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 551 | /* PyModule_AddObject steals a reference to 'func' */ |
| 552 | PyModule_AddObject(ptr(), name_, func.inc_ref().ptr()); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 553 | return *this; |
| 554 | } |
| 555 | |
Wenzel Jakob | bd4a529 | 2015-07-11 17:41:48 +0200 | [diff] [blame] | 556 | module def_submodule(const char *name, const char *doc = nullptr) { |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 557 | std::string full_name = std::string(PyModule_GetName(m_ptr)) |
| 558 | + std::string(".") + std::string(name); |
| 559 | module result(PyImport_AddModule(full_name.c_str()), true); |
Wenzel Jakob | bd4a529 | 2015-07-11 17:41:48 +0200 | [diff] [blame] | 560 | if (doc) |
Wenzel Jakob | 8f4eb00 | 2015-10-15 18:13:33 +0200 | [diff] [blame] | 561 | result.attr("__doc__") = pybind11::str(doc); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 562 | attr(name) = result; |
| 563 | return result; |
| 564 | } |
Wenzel Jakob | db028d6 | 2015-10-13 23:44:25 +0200 | [diff] [blame] | 565 | |
| 566 | static module import(const char *name) { |
Wenzel Jakob | dd57a34 | 2015-12-26 14:04:52 +0100 | [diff] [blame] | 567 | PyObject *obj = PyImport_ImportModule(name); |
| 568 | if (!obj) |
Wenzel Jakob | 678d787 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 569 | pybind11_fail("Module \"" + std::string(name) + "\" not found!"); |
Wenzel Jakob | dd57a34 | 2015-12-26 14:04:52 +0100 | [diff] [blame] | 570 | return module(obj, false); |
Wenzel Jakob | db028d6 | 2015-10-13 23:44:25 +0200 | [diff] [blame] | 571 | } |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 572 | }; |
| 573 | |
| 574 | NAMESPACE_BEGIN(detail) |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 575 | /// Generic support for creating new Python heap types |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 576 | class generic_type : public object { |
Jason Rhinelander | 5fffe20 | 2016-09-06 12:17:06 -0400 | [diff] [blame] | 577 | template <typename...> friend class class_; |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 578 | public: |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 579 | PYBIND11_OBJECT_DEFAULT(generic_type, object, PyType_Check) |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 580 | protected: |
| 581 | void initialize(type_record *rec) { |
Wenzel Jakob | 38d8b8c | 2016-05-31 09:53:28 +0200 | [diff] [blame] | 582 | auto &internals = get_internals(); |
| 583 | auto tindex = std::type_index(*(rec->type)); |
| 584 | |
| 585 | if (internals.registered_types_cpp.find(tindex) != |
| 586 | internals.registered_types_cpp.end()) |
| 587 | pybind11_fail("generic_type: type \"" + std::string(rec->name) + |
| 588 | "\" is already registered!"); |
| 589 | |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 590 | object name(PYBIND11_FROM_STRING(rec->name), false); |
Wenzel Jakob | c47d498 | 2016-07-11 23:40:28 +0200 | [diff] [blame] | 591 | object scope_module; |
| 592 | if (rec->scope) { |
Dean Moldovan | 865e430 | 2016-09-21 01:06:32 +0200 | [diff] [blame] | 593 | if (hasattr(rec->scope, "__module__")) { |
| 594 | scope_module = rec->scope.attr("__module__"); |
| 595 | } else if (hasattr(rec->scope, "__name__")) { |
| 596 | scope_module = rec->scope.attr("__name__"); |
| 597 | } |
Wenzel Jakob | c47d498 | 2016-07-11 23:40:28 +0200 | [diff] [blame] | 598 | } |
| 599 | |
| 600 | #if PY_MAJOR_VERSION >= 3 && PY_MINOR_VERSION >= 3 |
| 601 | /* Qualified names for Python >= 3.3 */ |
| 602 | object scope_qualname; |
Dean Moldovan | 865e430 | 2016-09-21 01:06:32 +0200 | [diff] [blame] | 603 | if (rec->scope && hasattr(rec->scope, "__qualname__")) |
| 604 | scope_qualname = rec->scope.attr("__qualname__"); |
Wenzel Jakob | c47d498 | 2016-07-11 23:40:28 +0200 | [diff] [blame] | 605 | object ht_qualname; |
| 606 | if (scope_qualname) { |
| 607 | ht_qualname = object(PyUnicode_FromFormat( |
| 608 | "%U.%U", scope_qualname.ptr(), name.ptr()), false); |
| 609 | } else { |
| 610 | ht_qualname = name; |
| 611 | } |
| 612 | #endif |
Wenzel Jakob | 8e5dceb | 2016-09-11 20:00:40 +0900 | [diff] [blame] | 613 | |
| 614 | size_t num_bases = rec->bases.size(); |
| 615 | tuple bases(num_bases); |
| 616 | for (size_t i = 0; i < num_bases; ++i) |
| 617 | bases[i] = rec->bases[i]; |
| 618 | |
Wenzel Jakob | c47d498 | 2016-07-11 23:40:28 +0200 | [diff] [blame] | 619 | std::string full_name = (scope_module ? ((std::string) scope_module.str() + "." + rec->name) |
| 620 | : std::string(rec->name)); |
| 621 | |
| 622 | char *tp_doc = nullptr; |
| 623 | if (rec->doc) { |
| 624 | /* Allocate memory for docstring (using PyObject_MALLOC, since |
| 625 | Python will free this later on) */ |
| 626 | size_t size = strlen(rec->doc) + 1; |
| 627 | tp_doc = (char *) PyObject_MALLOC(size); |
| 628 | memcpy((void *) tp_doc, rec->doc, size); |
| 629 | } |
| 630 | |
Wenzel Jakob | 8e5dceb | 2016-09-11 20:00:40 +0900 | [diff] [blame] | 631 | /* Danger zone: from now (and until PyType_Ready), make sure to |
| 632 | issue no Python C API calls which could potentially invoke the |
| 633 | garbage collector (the GC will call type_traverse(), which will in |
| 634 | turn find the newly constructed type in an invalid state) */ |
| 635 | |
Wenzel Jakob | c47d498 | 2016-07-11 23:40:28 +0200 | [diff] [blame] | 636 | object type_holder(PyType_Type.tp_alloc(&PyType_Type, 0), false); |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 637 | auto type = (PyHeapTypeObject*) type_holder.ptr(); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 638 | |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 639 | if (!type_holder || !name) |
Wenzel Jakob | e72a676 | 2016-09-14 23:39:16 +0800 | [diff] [blame] | 640 | pybind11_fail(std::string(rec->name) + ": Unable to create type object!"); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 641 | |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 642 | /* Register supplemental type information in C++ dict */ |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 643 | detail::type_info *tinfo = new detail::type_info(); |
| 644 | tinfo->type = (PyTypeObject *) type; |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 645 | tinfo->type_size = rec->type_size; |
| 646 | tinfo->init_holder = rec->init_holder; |
Wenzel Jakob | 38d8b8c | 2016-05-31 09:53:28 +0200 | [diff] [blame] | 647 | internals.registered_types_cpp[tindex] = tinfo; |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 648 | internals.registered_types_py[type] = tinfo; |
| 649 | |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 650 | /* Basic type attributes */ |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 651 | type->ht_type.tp_name = strdup(full_name.c_str()); |
Wenzel Jakob | 0a07805 | 2016-05-29 13:40:40 +0200 | [diff] [blame] | 652 | type->ht_type.tp_basicsize = (ssize_t) rec->instance_size; |
Wenzel Jakob | 8e5dceb | 2016-09-11 20:00:40 +0900 | [diff] [blame] | 653 | |
| 654 | if (num_bases > 0) { |
| 655 | type->ht_type.tp_base = (PyTypeObject *) ((object) bases[0]).inc_ref().ptr(); |
| 656 | type->ht_type.tp_bases = bases.release().ptr(); |
| 657 | rec->multiple_inheritance |= num_bases > 1; |
| 658 | } |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 659 | |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 660 | type->ht_name = name.release().ptr(); |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 661 | |
Wenzel Jakob | c47d498 | 2016-07-11 23:40:28 +0200 | [diff] [blame] | 662 | #if PY_MAJOR_VERSION >= 3 && PY_MINOR_VERSION >= 3 |
| 663 | type->ht_qualname = ht_qualname.release().ptr(); |
| 664 | #endif |
| 665 | |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 666 | /* Supported protocols */ |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 667 | type->ht_type.tp_as_number = &type->as_number; |
| 668 | type->ht_type.tp_as_sequence = &type->as_sequence; |
| 669 | type->ht_type.tp_as_mapping = &type->as_mapping; |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 670 | |
| 671 | /* Supported elementary operations */ |
| 672 | type->ht_type.tp_init = (initproc) init; |
| 673 | type->ht_type.tp_new = (newfunc) new_instance; |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 674 | type->ht_type.tp_dealloc = rec->dealloc; |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 675 | |
| 676 | /* Support weak references (needed for the keep_alive feature) */ |
Wenzel Jakob | 88d1d04 | 2016-01-20 01:26:42 +0100 | [diff] [blame] | 677 | type->ht_type.tp_weaklistoffset = offsetof(instance_essentials<void>, weakrefs); |
Wenzel Jakob | 5f218b3 | 2016-01-17 22:36:39 +0100 | [diff] [blame] | 678 | |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 679 | /* Flags */ |
| 680 | type->ht_type.tp_flags |= Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HEAPTYPE; |
| 681 | #if PY_MAJOR_VERSION < 3 |
| 682 | type->ht_type.tp_flags |= Py_TPFLAGS_CHECKTYPES; |
| 683 | #endif |
| 684 | type->ht_type.tp_flags &= ~Py_TPFLAGS_HAVE_GC; |
| 685 | |
Wenzel Jakob | c47d498 | 2016-07-11 23:40:28 +0200 | [diff] [blame] | 686 | type->ht_type.tp_doc = tp_doc; |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 687 | |
| 688 | if (PyType_Ready(&type->ht_type) < 0) |
Wenzel Jakob | e72a676 | 2016-09-14 23:39:16 +0800 | [diff] [blame] | 689 | pybind11_fail(std::string(rec->name) + ": PyType_Ready failed (" + |
| 690 | detail::error_string() + ")!"); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 691 | |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 692 | m_ptr = type_holder.ptr(); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 693 | |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 694 | if (scope_module) // Needed by pydoc |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 695 | attr("__module__") = scope_module; |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 696 | |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 697 | /* Register type with the parent scope */ |
Wenzel Jakob | b282595 | 2016-04-13 23:33:00 +0200 | [diff] [blame] | 698 | if (rec->scope) |
| 699 | rec->scope.attr(handle(type->ht_name)) = *this; |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 700 | |
Wenzel Jakob | 8e5dceb | 2016-09-11 20:00:40 +0900 | [diff] [blame] | 701 | if (rec->multiple_inheritance) |
| 702 | mark_parents_nonsimple(&type->ht_type); |
| 703 | |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 704 | type_holder.release(); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 705 | } |
| 706 | |
Wenzel Jakob | 8e5dceb | 2016-09-11 20:00:40 +0900 | [diff] [blame] | 707 | /// Helper function which tags all parents of a type using mult. inheritance |
| 708 | void mark_parents_nonsimple(PyTypeObject *value) { |
| 709 | tuple t(value->tp_bases, true); |
| 710 | for (handle h : t) { |
| 711 | auto tinfo2 = get_type_info((PyTypeObject *) h.ptr()); |
| 712 | if (tinfo2) |
| 713 | tinfo2->simple_type = false; |
| 714 | mark_parents_nonsimple((PyTypeObject *) h.ptr()); |
| 715 | } |
| 716 | } |
| 717 | |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 718 | /// Allocate a metaclass on demand (for static properties) |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 719 | handle metaclass() { |
| 720 | auto &ht_type = ((PyHeapTypeObject *) m_ptr)->ht_type; |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 721 | auto &ob_type = PYBIND11_OB_TYPE(ht_type); |
Wenzel Jakob | 5708221 | 2015-09-04 23:42:12 +0200 | [diff] [blame] | 722 | |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 723 | if (ob_type == &PyType_Type) { |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 724 | std::string name_ = std::string(ht_type.tp_name) + "__Meta"; |
Wenzel Jakob | c47d498 | 2016-07-11 23:40:28 +0200 | [diff] [blame] | 725 | #if PY_MAJOR_VERSION >= 3 && PY_MINOR_VERSION >= 3 |
Dean Moldovan | 242b146 | 2016-09-08 17:02:04 +0200 | [diff] [blame^] | 726 | object ht_qualname(PyUnicode_FromFormat("%U__Meta", attr("__qualname__").ptr()), false); |
Wenzel Jakob | c47d498 | 2016-07-11 23:40:28 +0200 | [diff] [blame] | 727 | #endif |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 728 | object name(PYBIND11_FROM_STRING(name_.c_str()), false); |
Wenzel Jakob | c47d498 | 2016-07-11 23:40:28 +0200 | [diff] [blame] | 729 | object type_holder(PyType_Type.tp_alloc(&PyType_Type, 0), false); |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 730 | if (!type_holder || !name) |
Wenzel Jakob | 678d787 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 731 | pybind11_fail("generic_type::metaclass(): unable to create type object!"); |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 732 | |
| 733 | auto type = (PyHeapTypeObject*) type_holder.ptr(); |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 734 | type->ht_name = name.release().ptr(); |
Wenzel Jakob | c47d498 | 2016-07-11 23:40:28 +0200 | [diff] [blame] | 735 | |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 736 | #if PY_MAJOR_VERSION >= 3 && PY_MINOR_VERSION >= 3 |
| 737 | /* Qualified names for Python >= 3.3 */ |
Wenzel Jakob | c47d498 | 2016-07-11 23:40:28 +0200 | [diff] [blame] | 738 | type->ht_qualname = ht_qualname.release().ptr(); |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 739 | #endif |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 740 | type->ht_type.tp_name = strdup(name_.c_str()); |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 741 | type->ht_type.tp_base = ob_type; |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 742 | type->ht_type.tp_flags |= (Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HEAPTYPE) & |
| 743 | ~Py_TPFLAGS_HAVE_GC; |
| 744 | |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 745 | if (PyType_Ready(&type->ht_type) < 0) |
Wenzel Jakob | 678d787 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 746 | pybind11_fail("generic_type::metaclass(): PyType_Ready failed!"); |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 747 | |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 748 | ob_type = (PyTypeObject *) type_holder.release().ptr(); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 749 | } |
| 750 | return handle((PyObject *) ob_type); |
| 751 | } |
| 752 | |
| 753 | static int init(void *self, PyObject *, PyObject *) { |
| 754 | std::string msg = std::string(Py_TYPE(self)->tp_name) + ": No constructor defined!"; |
| 755 | PyErr_SetString(PyExc_TypeError, msg.c_str()); |
| 756 | return -1; |
| 757 | } |
| 758 | |
| 759 | static PyObject *new_instance(PyTypeObject *type, PyObject *, PyObject *) { |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 760 | instance<void> *self = (instance<void> *) PyType_GenericAlloc((PyTypeObject *) type, 0); |
| 761 | auto tinfo = detail::get_type_info(type); |
| 762 | self->value = ::operator new(tinfo->type_size); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 763 | self->owned = true; |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 764 | self->constructed = false; |
Jason Rhinelander | 1b05ce5 | 2016-08-09 17:57:59 -0400 | [diff] [blame] | 765 | detail::get_internals().registered_instances.emplace(self->value, (PyObject *) self); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 766 | return (PyObject *) self; |
| 767 | } |
| 768 | |
| 769 | static void dealloc(instance<void> *self) { |
| 770 | if (self->value) { |
Jason Rhinelander | 1b05ce5 | 2016-08-09 17:57:59 -0400 | [diff] [blame] | 771 | auto instance_type = Py_TYPE(self); |
| 772 | auto ®istered_instances = detail::get_internals().registered_instances; |
| 773 | auto range = registered_instances.equal_range(self->value); |
| 774 | bool found = false; |
| 775 | for (auto it = range.first; it != range.second; ++it) { |
| 776 | if (instance_type == Py_TYPE(it->second)) { |
| 777 | registered_instances.erase(it); |
| 778 | found = true; |
| 779 | break; |
| 780 | } |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 781 | } |
Jason Rhinelander | 1b05ce5 | 2016-08-09 17:57:59 -0400 | [diff] [blame] | 782 | if (!found) |
| 783 | pybind11_fail("generic_type::dealloc(): Tried to deallocate unregistered instance!"); |
| 784 | |
Wenzel Jakob | 5f218b3 | 2016-01-17 22:36:39 +0100 | [diff] [blame] | 785 | if (self->weakrefs) |
| 786 | PyObject_ClearWeakRefs((PyObject *) self); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 787 | } |
| 788 | Py_TYPE(self)->tp_free((PyObject*) self); |
| 789 | } |
| 790 | |
Wenzel Jakob | 43398a8 | 2015-07-28 16:12:20 +0200 | [diff] [blame] | 791 | void install_buffer_funcs( |
| 792 | buffer_info *(*get_buffer)(PyObject *, void *), |
| 793 | void *get_buffer_data) { |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 794 | PyHeapTypeObject *type = (PyHeapTypeObject*) m_ptr; |
| 795 | type->ht_type.tp_as_buffer = &type->as_buffer; |
Wenzel Jakob | 5708221 | 2015-09-04 23:42:12 +0200 | [diff] [blame] | 796 | #if PY_MAJOR_VERSION < 3 |
| 797 | type->ht_type.tp_flags |= Py_TPFLAGS_HAVE_NEWBUFFER; |
| 798 | #endif |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 799 | type->as_buffer.bf_getbuffer = getbuffer; |
| 800 | type->as_buffer.bf_releasebuffer = releasebuffer; |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 801 | auto tinfo = detail::get_type_info(&type->ht_type); |
| 802 | tinfo->get_buffer = get_buffer; |
| 803 | tinfo->get_buffer_data = get_buffer_data; |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 804 | } |
| 805 | |
| 806 | static int getbuffer(PyObject *obj, Py_buffer *view, int flags) { |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 807 | auto tinfo = detail::get_type_info(Py_TYPE(obj)); |
| 808 | if (view == nullptr || obj == nullptr || !tinfo || !tinfo->get_buffer) { |
| 809 | PyErr_SetString(PyExc_BufferError, "generic_type::getbuffer(): Internal error"); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 810 | return -1; |
| 811 | } |
| 812 | memset(view, 0, sizeof(Py_buffer)); |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 813 | buffer_info *info = tinfo->get_buffer(obj, tinfo->get_buffer_data); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 814 | view->obj = obj; |
| 815 | view->ndim = 1; |
| 816 | view->internal = info; |
| 817 | view->buf = info->ptr; |
Wenzel Jakob | 0a07805 | 2016-05-29 13:40:40 +0200 | [diff] [blame] | 818 | view->itemsize = (ssize_t) info->itemsize; |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 819 | view->len = view->itemsize; |
| 820 | for (auto s : info->shape) |
| 821 | view->len *= s; |
| 822 | if ((flags & PyBUF_FORMAT) == PyBUF_FORMAT) |
| 823 | view->format = const_cast<char *>(info->format.c_str()); |
| 824 | if ((flags & PyBUF_STRIDES) == PyBUF_STRIDES) { |
Wenzel Jakob | 0a07805 | 2016-05-29 13:40:40 +0200 | [diff] [blame] | 825 | view->ndim = (int) info->ndim; |
Wenzel Jakob | 27e8e10 | 2016-01-17 22:36:37 +0100 | [diff] [blame] | 826 | view->strides = (ssize_t *) &info->strides[0]; |
| 827 | view->shape = (ssize_t *) &info->shape[0]; |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 828 | } |
| 829 | Py_INCREF(view->obj); |
| 830 | return 0; |
| 831 | } |
| 832 | |
| 833 | static void releasebuffer(PyObject *, Py_buffer *view) { delete (buffer_info *) view->internal; } |
| 834 | }; |
Jason Rhinelander | 6b52c83 | 2016-09-06 12:27:00 -0400 | [diff] [blame] | 835 | |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 836 | NAMESPACE_END(detail) |
| 837 | |
Jason Rhinelander | 5fffe20 | 2016-09-06 12:17:06 -0400 | [diff] [blame] | 838 | template <typename type_, typename... options> |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 839 | class class_ : public detail::generic_type { |
Jason Rhinelander | 5fffe20 | 2016-09-06 12:17:06 -0400 | [diff] [blame] | 840 | template <typename T> using is_holder = detail::is_holder_type<type_, T>; |
| 841 | template <typename T> using is_subtype = detail::bool_constant<std::is_base_of<type_, T>::value && !std::is_same<T, type_>::value>; |
Wenzel Jakob | 8e5dceb | 2016-09-11 20:00:40 +0900 | [diff] [blame] | 842 | template <typename T> using is_base = detail::bool_constant<std::is_base_of<T, type_>::value && !std::is_same<T, type_>::value>; |
Jason Rhinelander | 5fffe20 | 2016-09-06 12:17:06 -0400 | [diff] [blame] | 843 | template <typename T> using is_valid_class_option = |
| 844 | detail::bool_constant< |
| 845 | is_holder<T>::value || |
Jason Rhinelander | 6b52c83 | 2016-09-06 12:27:00 -0400 | [diff] [blame] | 846 | is_subtype<T>::value || |
Wenzel Jakob | 8e5dceb | 2016-09-11 20:00:40 +0900 | [diff] [blame] | 847 | is_base<T>::value |
Jason Rhinelander | 5fffe20 | 2016-09-06 12:17:06 -0400 | [diff] [blame] | 848 | >; |
| 849 | |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 850 | public: |
Jason Rhinelander | 5fffe20 | 2016-09-06 12:17:06 -0400 | [diff] [blame] | 851 | using type = type_; |
Jason Rhinelander | 6b52c83 | 2016-09-06 12:27:00 -0400 | [diff] [blame] | 852 | using type_alias = detail::first_of_t<is_subtype, void, options...>; |
Jason Rhinelander | 5fffe20 | 2016-09-06 12:17:06 -0400 | [diff] [blame] | 853 | constexpr static bool has_alias = !std::is_void<type_alias>::value; |
Jason Rhinelander | 6b52c83 | 2016-09-06 12:27:00 -0400 | [diff] [blame] | 854 | using holder_type = detail::first_of_t<is_holder, std::unique_ptr<type>, options...>; |
Jason Rhinelander | 5fffe20 | 2016-09-06 12:17:06 -0400 | [diff] [blame] | 855 | using instance_type = detail::instance<type, holder_type>; |
| 856 | |
| 857 | static_assert(detail::all_of_t<is_valid_class_option, options...>::value, |
| 858 | "Unknown/invalid class_ template parameters provided"); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 859 | |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 860 | PYBIND11_OBJECT(class_, detail::generic_type, PyType_Check) |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 861 | |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 862 | template <typename... Extra> |
| 863 | class_(handle scope, const char *name, const Extra &... extra) { |
| 864 | detail::type_record record; |
| 865 | record.scope = scope; |
| 866 | record.name = name; |
| 867 | record.type = &typeid(type); |
Jason Rhinelander | 9c6859e | 2016-09-08 11:03:08 -0400 | [diff] [blame] | 868 | record.type_size = sizeof(detail::conditional_t<has_alias, type_alias, type>); |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 869 | record.instance_size = sizeof(instance_type); |
| 870 | record.init_holder = init_holder; |
| 871 | record.dealloc = dealloc; |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 872 | |
Wenzel Jakob | 8e5dceb | 2016-09-11 20:00:40 +0900 | [diff] [blame] | 873 | /* Register base classes specified via template arguments to class_, if any */ |
Wenzel Jakob | c1fc27e | 2016-09-13 00:36:43 +0900 | [diff] [blame] | 874 | bool unused[] = { (add_base<options>(record), false)..., false }; |
Wenzel Jakob | 8e5dceb | 2016-09-11 20:00:40 +0900 | [diff] [blame] | 875 | (void) unused; |
Jason Rhinelander | 6b52c83 | 2016-09-06 12:27:00 -0400 | [diff] [blame] | 876 | |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 877 | /* Process optional arguments, if any */ |
| 878 | detail::process_attributes<Extra...>::init(extra..., &record); |
| 879 | |
| 880 | detail::generic_type::initialize(&record); |
Wenzel Jakob | 86d825f | 2016-05-26 13:19:27 +0200 | [diff] [blame] | 881 | |
Jason Rhinelander | 5fffe20 | 2016-09-06 12:17:06 -0400 | [diff] [blame] | 882 | if (has_alias) { |
Wenzel Jakob | 86d825f | 2016-05-26 13:19:27 +0200 | [diff] [blame] | 883 | auto &instances = pybind11::detail::get_internals().registered_types_cpp; |
| 884 | instances[std::type_index(typeid(type_alias))] = instances[std::type_index(typeid(type))]; |
| 885 | } |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 886 | } |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 887 | |
Wenzel Jakob | c1fc27e | 2016-09-13 00:36:43 +0900 | [diff] [blame] | 888 | template <typename Base, detail::enable_if_t<is_base<Base>::value, int> = 0> |
Wenzel Jakob | 8e5dceb | 2016-09-11 20:00:40 +0900 | [diff] [blame] | 889 | static void add_base(detail::type_record &rec) { |
| 890 | rec.add_base(&typeid(Base), [](void *src) -> void * { |
| 891 | return static_cast<Base *>(reinterpret_cast<type *>(src)); |
| 892 | }); |
| 893 | } |
| 894 | |
Wenzel Jakob | c1fc27e | 2016-09-13 00:36:43 +0900 | [diff] [blame] | 895 | template <typename Base, detail::enable_if_t<!is_base<Base>::value, int> = 0> |
Wenzel Jakob | 8e5dceb | 2016-09-11 20:00:40 +0900 | [diff] [blame] | 896 | static void add_base(detail::type_record &) { } |
| 897 | |
Wenzel Jakob | 7186783 | 2015-07-29 17:43:52 +0200 | [diff] [blame] | 898 | template <typename Func, typename... Extra> |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 899 | class_ &def(const char *name_, Func&& f, const Extra&... extra) { |
Dean Moldovan | 865e430 | 2016-09-21 01:06:32 +0200 | [diff] [blame] | 900 | cpp_function cf(std::forward<Func>(f), name(name_), is_method(*this), |
| 901 | sibling(getattr(*this, name_, none())), extra...); |
Wenzel Jakob | 5708221 | 2015-09-04 23:42:12 +0200 | [diff] [blame] | 902 | attr(cf.name()) = cf; |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 903 | return *this; |
| 904 | } |
| 905 | |
Wenzel Jakob | 7186783 | 2015-07-29 17:43:52 +0200 | [diff] [blame] | 906 | template <typename Func, typename... Extra> class_ & |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 907 | def_static(const char *name_, Func f, const Extra&... extra) { |
Dean Moldovan | 865e430 | 2016-09-21 01:06:32 +0200 | [diff] [blame] | 908 | cpp_function cf(std::forward<Func>(f), name(name_), scope(*this), |
| 909 | sibling(getattr(*this, name_, none())), extra...); |
Wenzel Jakob | 5708221 | 2015-09-04 23:42:12 +0200 | [diff] [blame] | 910 | attr(cf.name()) = cf; |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 911 | return *this; |
| 912 | } |
| 913 | |
Wenzel Jakob | 7186783 | 2015-07-29 17:43:52 +0200 | [diff] [blame] | 914 | template <detail::op_id id, detail::op_type ot, typename L, typename R, typename... Extra> |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 915 | class_ &def(const detail::op_<id, ot, L, R> &op, const Extra&... extra) { |
Jason Rhinelander | 5fffe20 | 2016-09-06 12:17:06 -0400 | [diff] [blame] | 916 | op.execute(*this, extra...); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 917 | return *this; |
| 918 | } |
| 919 | |
Wenzel Jakob | 7186783 | 2015-07-29 17:43:52 +0200 | [diff] [blame] | 920 | template <detail::op_id id, detail::op_type ot, typename L, typename R, typename... Extra> |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 921 | class_ & def_cast(const detail::op_<id, ot, L, R> &op, const Extra&... extra) { |
Jason Rhinelander | 5fffe20 | 2016-09-06 12:17:06 -0400 | [diff] [blame] | 922 | op.execute_cast(*this, extra...); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 923 | return *this; |
| 924 | } |
| 925 | |
Wenzel Jakob | 7186783 | 2015-07-29 17:43:52 +0200 | [diff] [blame] | 926 | template <typename... Args, typename... Extra> |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 927 | class_ &def(const detail::init<Args...> &init, const Extra&... extra) { |
Jason Rhinelander | 5fffe20 | 2016-09-06 12:17:06 -0400 | [diff] [blame] | 928 | init.execute(*this, extra...); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 929 | return *this; |
| 930 | } |
| 931 | |
Wenzel Jakob | 86d825f | 2016-05-26 13:19:27 +0200 | [diff] [blame] | 932 | template <typename... Args, typename... Extra> |
| 933 | class_ &def(const detail::init_alias<Args...> &init, const Extra&... extra) { |
Jason Rhinelander | 5fffe20 | 2016-09-06 12:17:06 -0400 | [diff] [blame] | 934 | init.execute(*this, extra...); |
Wenzel Jakob | 86d825f | 2016-05-26 13:19:27 +0200 | [diff] [blame] | 935 | return *this; |
| 936 | } |
| 937 | |
Wenzel Jakob | 7186783 | 2015-07-29 17:43:52 +0200 | [diff] [blame] | 938 | template <typename Func> class_& def_buffer(Func &&func) { |
Wenzel Jakob | 43398a8 | 2015-07-28 16:12:20 +0200 | [diff] [blame] | 939 | struct capture { Func func; }; |
| 940 | capture *ptr = new capture { std::forward<Func>(func) }; |
| 941 | install_buffer_funcs([](PyObject *obj, void *ptr) -> buffer_info* { |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 942 | detail::type_caster<type> caster; |
| 943 | if (!caster.load(obj, false)) |
| 944 | return nullptr; |
Wenzel Jakob | 43398a8 | 2015-07-28 16:12:20 +0200 | [diff] [blame] | 945 | return new buffer_info(((capture *) ptr)->func(caster)); |
| 946 | }, ptr); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 947 | return *this; |
| 948 | } |
| 949 | |
Wenzel Jakob | 7186783 | 2015-07-29 17:43:52 +0200 | [diff] [blame] | 950 | template <typename C, typename D, typename... Extra> |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 951 | class_ &def_readwrite(const char *name, D C::*pm, const Extra&... extra) { |
Wenzel Jakob | 0b48958 | 2016-03-25 16:13:10 +0100 | [diff] [blame] | 952 | cpp_function fget([pm](const C &c) -> const D &{ return c.*pm; }, is_method(*this)), |
| 953 | fset([pm](C &c, const D &value) { c.*pm = value; }, is_method(*this)); |
| 954 | def_property(name, fget, fset, return_value_policy::reference_internal, extra...); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 955 | return *this; |
| 956 | } |
| 957 | |
Wenzel Jakob | 7186783 | 2015-07-29 17:43:52 +0200 | [diff] [blame] | 958 | template <typename C, typename D, typename... Extra> |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 959 | class_ &def_readonly(const char *name, const D C::*pm, const Extra& ...extra) { |
Wenzel Jakob | 0b48958 | 2016-03-25 16:13:10 +0100 | [diff] [blame] | 960 | cpp_function fget([pm](const C &c) -> const D &{ return c.*pm; }, is_method(*this)); |
| 961 | def_property_readonly(name, fget, return_value_policy::reference_internal, extra...); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 962 | return *this; |
| 963 | } |
| 964 | |
Wenzel Jakob | 7186783 | 2015-07-29 17:43:52 +0200 | [diff] [blame] | 965 | template <typename D, typename... Extra> |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 966 | class_ &def_readwrite_static(const char *name, D *pm, const Extra& ...extra) { |
Wenzel Jakob | 0b48958 | 2016-03-25 16:13:10 +0100 | [diff] [blame] | 967 | cpp_function fget([pm](object) -> const D &{ return *pm; }, scope(*this)), |
| 968 | fset([pm](object, const D &value) { *pm = value; }, scope(*this)); |
| 969 | def_property_static(name, fget, fset, return_value_policy::reference, extra...); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 970 | return *this; |
| 971 | } |
| 972 | |
Wenzel Jakob | 7186783 | 2015-07-29 17:43:52 +0200 | [diff] [blame] | 973 | template <typename D, typename... Extra> |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 974 | class_ &def_readonly_static(const char *name, const D *pm, const Extra& ...extra) { |
Wenzel Jakob | 0b48958 | 2016-03-25 16:13:10 +0100 | [diff] [blame] | 975 | cpp_function fget([pm](object) -> const D &{ return *pm; }, scope(*this)); |
| 976 | def_property_readonly_static(name, fget, return_value_policy::reference, extra...); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 977 | return *this; |
| 978 | } |
| 979 | |
Wenzel Jakob | 84ec78f | 2016-03-21 17:54:24 +0100 | [diff] [blame] | 980 | template <typename... Extra> |
| 981 | class_ &def_property_readonly(const char *name, const cpp_function &fget, const Extra& ...extra) { |
| 982 | def_property(name, fget, cpp_function(), extra...); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 983 | return *this; |
| 984 | } |
| 985 | |
Wenzel Jakob | 84ec78f | 2016-03-21 17:54:24 +0100 | [diff] [blame] | 986 | template <typename... Extra> |
| 987 | class_ &def_property_readonly_static(const char *name, const cpp_function &fget, const Extra& ...extra) { |
| 988 | def_property_static(name, fget, cpp_function(), extra...); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 989 | return *this; |
| 990 | } |
| 991 | |
Wenzel Jakob | 84ec78f | 2016-03-21 17:54:24 +0100 | [diff] [blame] | 992 | template <typename... Extra> |
| 993 | class_ &def_property(const char *name, const cpp_function &fget, const cpp_function &fset, const Extra& ...extra) { |
Wenzel Jakob | 0b48958 | 2016-03-25 16:13:10 +0100 | [diff] [blame] | 994 | return def_property_static(name, fget, fset, is_method(*this), extra...); |
Wenzel Jakob | 84ec78f | 2016-03-21 17:54:24 +0100 | [diff] [blame] | 995 | } |
| 996 | |
| 997 | template <typename... Extra> |
| 998 | class_ &def_property_static(const char *name, const cpp_function &fget, const cpp_function &fset, const Extra& ...extra) { |
| 999 | auto rec_fget = get_function_record(fget), rec_fset = get_function_record(fset); |
Wenzel Jakob | 7c99ff2 | 2016-06-02 20:33:01 +0200 | [diff] [blame] | 1000 | char *doc_prev = rec_fget->doc; /* 'extra' field may include a property-specific documentation string */ |
Wenzel Jakob | 84ec78f | 2016-03-21 17:54:24 +0100 | [diff] [blame] | 1001 | detail::process_attributes<Extra...>::init(extra..., rec_fget); |
Wenzel Jakob | 7c99ff2 | 2016-06-02 20:33:01 +0200 | [diff] [blame] | 1002 | if (rec_fget->doc && rec_fget->doc != doc_prev) { |
| 1003 | free(doc_prev); |
| 1004 | rec_fget->doc = strdup(rec_fget->doc); |
| 1005 | } |
| 1006 | if (rec_fset) { |
| 1007 | doc_prev = rec_fset->doc; |
Wenzel Jakob | 84ec78f | 2016-03-21 17:54:24 +0100 | [diff] [blame] | 1008 | detail::process_attributes<Extra...>::init(extra..., rec_fset); |
Wenzel Jakob | 7c99ff2 | 2016-06-02 20:33:01 +0200 | [diff] [blame] | 1009 | if (rec_fset->doc && rec_fset->doc != doc_prev) { |
| 1010 | free(doc_prev); |
| 1011 | rec_fset->doc = strdup(rec_fset->doc); |
| 1012 | } |
| 1013 | } |
Wenzel Jakob | 84ec78f | 2016-03-21 17:54:24 +0100 | [diff] [blame] | 1014 | pybind11::str doc_obj = pybind11::str(rec_fget->doc ? rec_fget->doc : ""); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1015 | object property( |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 1016 | PyObject_CallFunctionObjArgs((PyObject *) &PyProperty_Type, fget.ptr() ? fget.ptr() : Py_None, |
| 1017 | fset.ptr() ? fset.ptr() : Py_None, Py_None, doc_obj.ptr(), nullptr), false); |
Wenzel Jakob | 84ec78f | 2016-03-21 17:54:24 +0100 | [diff] [blame] | 1018 | if (rec_fget->class_) |
| 1019 | attr(name) = property; |
| 1020 | else |
| 1021 | metaclass().attr(name) = property; |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1022 | return *this; |
| 1023 | } |
Wenzel Jakob | a2f6fde | 2015-10-01 16:46:03 +0200 | [diff] [blame] | 1024 | |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1025 | private: |
Wenzel Jakob | b2c2c79 | 2016-01-17 22:36:40 +0100 | [diff] [blame] | 1026 | /// Initialize holder object, variant 1: object derives from enable_shared_from_this |
| 1027 | template <typename T> |
| 1028 | static void init_holder_helper(instance_type *inst, const holder_type * /* unused */, const std::enable_shared_from_this<T> * /* dummy */) { |
Wenzel Jakob | 6e213c9 | 2015-11-24 23:05:58 +0100 | [diff] [blame] | 1029 | try { |
hbruintjes | 70d2e57 | 2016-07-01 12:39:55 +0200 | [diff] [blame] | 1030 | new (&inst->holder) holder_type(std::static_pointer_cast<typename holder_type::element_type>(inst->value->shared_from_this())); |
Wenzel Jakob | 6e213c9 | 2015-11-24 23:05:58 +0100 | [diff] [blame] | 1031 | } catch (const std::bad_weak_ptr &) { |
| 1032 | new (&inst->holder) holder_type(inst->value); |
| 1033 | } |
Wenzel Jakob | b2c2c79 | 2016-01-17 22:36:40 +0100 | [diff] [blame] | 1034 | } |
| 1035 | |
| 1036 | /// Initialize holder object, variant 2: try to construct from existing holder object, if possible |
| 1037 | template <typename T = holder_type, |
Wenzel Jakob | c1fc27e | 2016-09-13 00:36:43 +0900 | [diff] [blame] | 1038 | detail::enable_if_t<std::is_copy_constructible<T>::value, int> = 0> |
Wenzel Jakob | b2c2c79 | 2016-01-17 22:36:40 +0100 | [diff] [blame] | 1039 | static void init_holder_helper(instance_type *inst, const holder_type *holder_ptr, const void * /* dummy */) { |
| 1040 | if (holder_ptr) |
| 1041 | new (&inst->holder) holder_type(*holder_ptr); |
| 1042 | else |
| 1043 | new (&inst->holder) holder_type(inst->value); |
| 1044 | } |
| 1045 | |
| 1046 | /// Initialize holder object, variant 3: holder is not copy constructible (e.g. unique_ptr), always initialize from raw pointer |
| 1047 | template <typename T = holder_type, |
Wenzel Jakob | c1fc27e | 2016-09-13 00:36:43 +0900 | [diff] [blame] | 1048 | detail::enable_if_t<!std::is_copy_constructible<T>::value, int> = 0> |
Wenzel Jakob | b2c2c79 | 2016-01-17 22:36:40 +0100 | [diff] [blame] | 1049 | static void init_holder_helper(instance_type *inst, const holder_type * /* unused */, const void * /* dummy */) { |
| 1050 | new (&inst->holder) holder_type(inst->value); |
| 1051 | } |
| 1052 | |
| 1053 | /// Initialize holder object of an instance, possibly given a pointer to an existing holder |
| 1054 | static void init_holder(PyObject *inst_, const void *holder_ptr) { |
| 1055 | auto inst = (instance_type *) inst_; |
| 1056 | init_holder_helper(inst, (const holder_type *) holder_ptr, inst->value); |
Wenzel Jakob | 6e213c9 | 2015-11-24 23:05:58 +0100 | [diff] [blame] | 1057 | inst->constructed = true; |
| 1058 | } |
| 1059 | |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1060 | static void dealloc(PyObject *inst_) { |
| 1061 | instance_type *inst = (instance_type *) inst_; |
| 1062 | if (inst->owned) { |
| 1063 | if (inst->constructed) |
| 1064 | inst->holder.~holder_type(); |
| 1065 | else |
| 1066 | ::operator delete(inst->value); |
| 1067 | } |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 1068 | generic_type::dealloc((detail::instance<void> *) inst); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1069 | } |
Wenzel Jakob | 84ec78f | 2016-03-21 17:54:24 +0100 | [diff] [blame] | 1070 | |
| 1071 | static detail::function_record *get_function_record(handle h) { |
| 1072 | h = detail::get_function(h); |
| 1073 | return h ? (detail::function_record *) capsule( |
| 1074 | PyCFunction_GetSelf(h.ptr()), true) : nullptr; |
| 1075 | } |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1076 | }; |
| 1077 | |
| 1078 | /// Binds C++ enumerations and enumeration classes to Python |
| 1079 | template <typename Type> class enum_ : public class_<Type> { |
| 1080 | public: |
Wenzel Jakob | 8ac9715 | 2016-09-05 17:20:50 +0900 | [diff] [blame] | 1081 | using class_<Type>::def; |
Pim Schellart | e5b42ef | 2016-08-02 10:58:32 -0400 | [diff] [blame] | 1082 | using UnderlyingType = typename std::underlying_type<Type>::type; |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 1083 | template <typename... Extra> |
| 1084 | enum_(const handle &scope, const char *name, const Extra&... extra) |
| 1085 | : class_<Type>(scope, name, extra...), m_parent(scope) { |
Pim Schellart | e5b42ef | 2016-08-02 10:58:32 -0400 | [diff] [blame] | 1086 | auto entries = new std::unordered_map<UnderlyingType, const char *>(); |
Wenzel Jakob | 8ac9715 | 2016-09-05 17:20:50 +0900 | [diff] [blame] | 1087 | def("__repr__", [name, entries](Type value) -> std::string { |
Pim Schellart | e5b42ef | 2016-08-02 10:58:32 -0400 | [diff] [blame] | 1088 | auto it = entries->find((UnderlyingType) value); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1089 | return std::string(name) + "." + |
| 1090 | ((it == entries->end()) ? std::string("???") |
| 1091 | : std::string(it->second)); |
| 1092 | }); |
Wenzel Jakob | 8ac9715 | 2016-09-05 17:20:50 +0900 | [diff] [blame] | 1093 | def("__init__", [](Type& value, UnderlyingType i) { value = (Type)i; }); |
| 1094 | def("__init__", [](Type& value, UnderlyingType i) { new (&value) Type((Type) i); }); |
| 1095 | def("__int__", [](Type value) { return (UnderlyingType) value; }); |
| 1096 | def("__eq__", [](const Type &value, Type *value2) { return value2 && value == *value2; }); |
| 1097 | def("__ne__", [](const Type &value, Type *value2) { return !value2 || value != *value2; }); |
Jason Rhinelander | d41a273 | 2016-08-04 00:21:37 -0400 | [diff] [blame] | 1098 | if (std::is_convertible<Type, UnderlyingType>::value) { |
| 1099 | // Don't provide comparison with the underlying type if the enum isn't convertible, |
| 1100 | // i.e. if Type is a scoped enum, mirroring the C++ behaviour. (NB: we explicitly |
| 1101 | // convert Type to UnderlyingType below anyway because this needs to compile). |
Wenzel Jakob | 8ac9715 | 2016-09-05 17:20:50 +0900 | [diff] [blame] | 1102 | def("__eq__", [](const Type &value, UnderlyingType value2) { return (UnderlyingType) value == value2; }); |
| 1103 | def("__ne__", [](const Type &value, UnderlyingType value2) { return (UnderlyingType) value != value2; }); |
Jason Rhinelander | d41a273 | 2016-08-04 00:21:37 -0400 | [diff] [blame] | 1104 | } |
Wenzel Jakob | 8ac9715 | 2016-09-05 17:20:50 +0900 | [diff] [blame] | 1105 | def("__hash__", [](const Type &value) { return (UnderlyingType) value; }); |
Wenzel Jakob | fe34241 | 2016-09-06 13:02:29 +0900 | [diff] [blame] | 1106 | // Pickling and unpickling -- needed for use with the 'multiprocessing' module |
Wenzel Jakob | 8ac9715 | 2016-09-05 17:20:50 +0900 | [diff] [blame] | 1107 | def("__getstate__", [](const Type &value) { return pybind11::make_tuple((UnderlyingType) value); }); |
| 1108 | def("__setstate__", [](Type &p, tuple t) { new (&p) Type((Type) t[0].cast<UnderlyingType>()); }); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1109 | m_entries = entries; |
| 1110 | } |
| 1111 | |
| 1112 | /// Export enumeration entries into the parent scope |
| 1113 | void export_values() { |
| 1114 | PyObject *dict = ((PyTypeObject *) this->m_ptr)->tp_dict; |
| 1115 | PyObject *key, *value; |
Wenzel Jakob | 27e8e10 | 2016-01-17 22:36:37 +0100 | [diff] [blame] | 1116 | ssize_t pos = 0; |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1117 | while (PyDict_Next(dict, &pos, &key, &value)) |
| 1118 | if (PyObject_IsInstance(value, this->m_ptr)) |
| 1119 | m_parent.attr(key) = value; |
| 1120 | } |
| 1121 | |
| 1122 | /// Add an enumeration entry |
| 1123 | enum_& value(char const* name, Type value) { |
Wenzel Jakob | 8f4eb00 | 2015-10-15 18:13:33 +0200 | [diff] [blame] | 1124 | this->attr(name) = pybind11::cast(value, return_value_policy::copy); |
Pim Schellart | e5b42ef | 2016-08-02 10:58:32 -0400 | [diff] [blame] | 1125 | (*m_entries)[(UnderlyingType) value] = name; |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1126 | return *this; |
| 1127 | } |
| 1128 | private: |
Pim Schellart | e5b42ef | 2016-08-02 10:58:32 -0400 | [diff] [blame] | 1129 | std::unordered_map<UnderlyingType, const char *> *m_entries; |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 1130 | handle m_parent; |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1131 | }; |
| 1132 | |
| 1133 | NAMESPACE_BEGIN(detail) |
Wenzel Jakob | 7186783 | 2015-07-29 17:43:52 +0200 | [diff] [blame] | 1134 | template <typename... Args> struct init { |
Jason Rhinelander | ec62d97 | 2016-09-09 02:42:51 -0400 | [diff] [blame] | 1135 | template <typename Class, typename... Extra, enable_if_t<!Class::has_alias, int> = 0> |
| 1136 | static void execute(Class &cl, const Extra&... extra) { |
Jason Rhinelander | 5fffe20 | 2016-09-06 12:17:06 -0400 | [diff] [blame] | 1137 | using Base = typename Class::type; |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1138 | /// Function which calls a specific C++ in-place constructor |
Jason Rhinelander | 5fffe20 | 2016-09-06 12:17:06 -0400 | [diff] [blame] | 1139 | cl.def("__init__", [](Base *self_, Args... args) { new (self_) Base(args...); }, extra...); |
Wenzel Jakob | 86d825f | 2016-05-26 13:19:27 +0200 | [diff] [blame] | 1140 | } |
| 1141 | |
Jason Rhinelander | 5fffe20 | 2016-09-06 12:17:06 -0400 | [diff] [blame] | 1142 | template <typename Class, typename... Extra, |
Jason Rhinelander | ec62d97 | 2016-09-09 02:42:51 -0400 | [diff] [blame] | 1143 | enable_if_t<Class::has_alias && |
| 1144 | std::is_constructible<typename Class::type, Args...>::value, int> = 0> |
| 1145 | static void execute(Class &cl, const Extra&... extra) { |
Jason Rhinelander | 5fffe20 | 2016-09-06 12:17:06 -0400 | [diff] [blame] | 1146 | using Base = typename Class::type; |
| 1147 | using Alias = typename Class::type_alias; |
| 1148 | handle cl_type = cl; |
| 1149 | cl.def("__init__", [cl_type](handle self_, Args... args) { |
Wenzel Jakob | 69e1a5c | 2016-05-26 14:29:31 +0200 | [diff] [blame] | 1150 | if (self_.get_type() == cl_type) |
| 1151 | new (self_.cast<Base *>()) Base(args...); |
Wenzel Jakob | 86d825f | 2016-05-26 13:19:27 +0200 | [diff] [blame] | 1152 | else |
Wenzel Jakob | 69e1a5c | 2016-05-26 14:29:31 +0200 | [diff] [blame] | 1153 | new (self_.cast<Alias *>()) Alias(args...); |
Wenzel Jakob | 86d825f | 2016-05-26 13:19:27 +0200 | [diff] [blame] | 1154 | }, extra...); |
| 1155 | } |
| 1156 | |
Jason Rhinelander | 5fffe20 | 2016-09-06 12:17:06 -0400 | [diff] [blame] | 1157 | template <typename Class, typename... Extra, |
Jason Rhinelander | ec62d97 | 2016-09-09 02:42:51 -0400 | [diff] [blame] | 1158 | enable_if_t<Class::has_alias && |
| 1159 | !std::is_constructible<typename Class::type, Args...>::value, int> = 0> |
| 1160 | static void execute(Class &cl, const Extra&... extra) { |
| 1161 | init_alias<Args...>::execute(cl, extra...); |
| 1162 | } |
| 1163 | }; |
| 1164 | template <typename... Args> struct init_alias { |
| 1165 | template <typename Class, typename... Extra, |
| 1166 | enable_if_t<Class::has_alias && std::is_constructible<typename Class::type_alias, Args...>::value, int> = 0> |
| 1167 | static void execute(Class &cl, const Extra&... extra) { |
Jason Rhinelander | 5fffe20 | 2016-09-06 12:17:06 -0400 | [diff] [blame] | 1168 | using Alias = typename Class::type_alias; |
| 1169 | cl.def("__init__", [](Alias *self_, Args... args) { new (self_) Alias(args...); }, extra...); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1170 | } |
| 1171 | }; |
Wenzel Jakob | 5f218b3 | 2016-01-17 22:36:39 +0100 | [diff] [blame] | 1172 | |
Jason Rhinelander | ec62d97 | 2016-09-09 02:42:51 -0400 | [diff] [blame] | 1173 | |
Jason Rhinelander | f2ecd89 | 2016-08-10 12:08:04 -0400 | [diff] [blame] | 1174 | inline void keep_alive_impl(handle nurse, handle patient) { |
Wenzel Jakob | 5f218b3 | 2016-01-17 22:36:39 +0100 | [diff] [blame] | 1175 | /* Clever approach based on weak references taken from Boost.Python */ |
Wenzel Jakob | b2c2c79 | 2016-01-17 22:36:40 +0100 | [diff] [blame] | 1176 | if (!nurse || !patient) |
Wenzel Jakob | 678d787 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 1177 | pybind11_fail("Could not activate keep_alive!"); |
Wenzel Jakob | 5f218b3 | 2016-01-17 22:36:39 +0100 | [diff] [blame] | 1178 | |
Ivan Smirnov | 984c762 | 2016-08-29 02:38:47 +0100 | [diff] [blame] | 1179 | if (patient.is_none() || nurse.is_none()) |
Glen Walker | f45bb58 | 2016-08-16 17:50:43 +1200 | [diff] [blame] | 1180 | return; /* Nothing to keep alive or nothing to be kept alive by */ |
Wenzel Jakob | 9b880ba | 2016-04-25 03:25:13 +0200 | [diff] [blame] | 1181 | |
Wenzel Jakob | 5f218b3 | 2016-01-17 22:36:39 +0100 | [diff] [blame] | 1182 | cpp_function disable_lifesupport( |
Wenzel Jakob | b2c2c79 | 2016-01-17 22:36:40 +0100 | [diff] [blame] | 1183 | [patient](handle weakref) { patient.dec_ref(); weakref.dec_ref(); }); |
Wenzel Jakob | 5f218b3 | 2016-01-17 22:36:39 +0100 | [diff] [blame] | 1184 | |
Wenzel Jakob | b2c2c79 | 2016-01-17 22:36:40 +0100 | [diff] [blame] | 1185 | weakref wr(nurse, disable_lifesupport); |
Wenzel Jakob | 5f218b3 | 2016-01-17 22:36:39 +0100 | [diff] [blame] | 1186 | |
Wenzel Jakob | b2c2c79 | 2016-01-17 22:36:40 +0100 | [diff] [blame] | 1187 | patient.inc_ref(); /* reference patient and leak the weak reference */ |
| 1188 | (void) wr.release(); |
Wenzel Jakob | 5f218b3 | 2016-01-17 22:36:39 +0100 | [diff] [blame] | 1189 | } |
| 1190 | |
Jason Rhinelander | f2ecd89 | 2016-08-10 12:08:04 -0400 | [diff] [blame] | 1191 | PYBIND11_NOINLINE inline void keep_alive_impl(int Nurse, int Patient, handle args, handle ret) { |
| 1192 | handle nurse (Nurse > 0 ? PyTuple_GetItem(args.ptr(), Nurse - 1) : ret.ptr()); |
| 1193 | handle patient(Patient > 0 ? PyTuple_GetItem(args.ptr(), Patient - 1) : ret.ptr()); |
| 1194 | |
| 1195 | keep_alive_impl(nurse, patient); |
| 1196 | } |
| 1197 | |
Wenzel Jakob | b212f6c | 2016-09-10 16:00:50 +0900 | [diff] [blame] | 1198 | template <typename Iterator, typename Sentinel, bool KeyIterator, return_value_policy Policy> |
Ivan Smirnov | 2b308e0 | 2016-08-24 23:29:04 +0100 | [diff] [blame] | 1199 | struct iterator_state { |
| 1200 | Iterator it; |
| 1201 | Sentinel end; |
Ivan Smirnov | daed1ab | 2016-06-17 22:29:39 +0100 | [diff] [blame] | 1202 | bool first; |
| 1203 | }; |
Wenzel Jakob | b282595 | 2016-04-13 23:33:00 +0200 | [diff] [blame] | 1204 | |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1205 | NAMESPACE_END(detail) |
| 1206 | |
Ben Pritchard | 2de6e1d | 2016-02-18 13:20:15 -0500 | [diff] [blame] | 1207 | template <typename... Args> detail::init<Args...> init() { return detail::init<Args...>(); } |
Jason Rhinelander | ec62d97 | 2016-09-09 02:42:51 -0400 | [diff] [blame] | 1208 | template <typename... Args> detail::init_alias<Args...> init_alias() { return detail::init_alias<Args...>(); } |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1209 | |
Wenzel Jakob | b212f6c | 2016-09-10 16:00:50 +0900 | [diff] [blame] | 1210 | template <return_value_policy Policy = return_value_policy::reference_internal, |
| 1211 | typename Iterator, |
Ivan Smirnov | 2b308e0 | 2016-08-24 23:29:04 +0100 | [diff] [blame] | 1212 | typename Sentinel, |
Wenzel Jakob | 5dd33d8 | 2016-05-30 11:28:21 +0200 | [diff] [blame] | 1213 | typename ValueType = decltype(*std::declval<Iterator>()), |
| 1214 | typename... Extra> |
Ivan Smirnov | 2b308e0 | 2016-08-24 23:29:04 +0100 | [diff] [blame] | 1215 | iterator make_iterator(Iterator first, Sentinel last, Extra &&... extra) { |
Wenzel Jakob | b212f6c | 2016-09-10 16:00:50 +0900 | [diff] [blame] | 1216 | typedef detail::iterator_state<Iterator, Sentinel, false, Policy> state; |
Wenzel Jakob | b282595 | 2016-04-13 23:33:00 +0200 | [diff] [blame] | 1217 | |
Wenzel Jakob | 8e5dceb | 2016-09-11 20:00:40 +0900 | [diff] [blame] | 1218 | if (!detail::get_type_info(typeid(state), false)) { |
Wenzel Jakob | 146397e | 2016-09-06 13:06:31 +0900 | [diff] [blame] | 1219 | class_<state>(handle(), "iterator") |
Wenzel Jakob | b282595 | 2016-04-13 23:33:00 +0200 | [diff] [blame] | 1220 | .def("__iter__", [](state &s) -> state& { return s; }) |
Wenzel Jakob | 5dd33d8 | 2016-05-30 11:28:21 +0200 | [diff] [blame] | 1221 | .def("__next__", [](state &s) -> ValueType { |
Ivan Smirnov | daed1ab | 2016-06-17 22:29:39 +0100 | [diff] [blame] | 1222 | if (!s.first) |
| 1223 | ++s.it; |
| 1224 | else |
| 1225 | s.first = false; |
Wenzel Jakob | b282595 | 2016-04-13 23:33:00 +0200 | [diff] [blame] | 1226 | if (s.it == s.end) |
| 1227 | throw stop_iteration(); |
Ivan Smirnov | daed1ab | 2016-06-17 22:29:39 +0100 | [diff] [blame] | 1228 | return *s.it; |
Wenzel Jakob | b212f6c | 2016-09-10 16:00:50 +0900 | [diff] [blame] | 1229 | }, std::forward<Extra>(extra)..., Policy); |
Wenzel Jakob | b282595 | 2016-04-13 23:33:00 +0200 | [diff] [blame] | 1230 | } |
| 1231 | |
Ivan Smirnov | daed1ab | 2016-06-17 22:29:39 +0100 | [diff] [blame] | 1232 | return (iterator) cast(state { first, last, true }); |
Wenzel Jakob | b282595 | 2016-04-13 23:33:00 +0200 | [diff] [blame] | 1233 | } |
Wenzel Jakob | 146397e | 2016-09-06 13:06:31 +0900 | [diff] [blame] | 1234 | |
Wenzel Jakob | b212f6c | 2016-09-10 16:00:50 +0900 | [diff] [blame] | 1235 | template <return_value_policy Policy = return_value_policy::reference_internal, |
| 1236 | typename Iterator, |
Ivan Smirnov | 2b308e0 | 2016-08-24 23:29:04 +0100 | [diff] [blame] | 1237 | typename Sentinel, |
Ivan Smirnov | c5a1c8a | 2016-08-24 23:27:19 +0100 | [diff] [blame] | 1238 | typename KeyType = decltype((*std::declval<Iterator>()).first), |
Jason Rhinelander | 5aa85be | 2016-08-11 21:22:05 -0400 | [diff] [blame] | 1239 | typename... Extra> |
Ivan Smirnov | 2b308e0 | 2016-08-24 23:29:04 +0100 | [diff] [blame] | 1240 | iterator make_key_iterator(Iterator first, Sentinel last, Extra &&... extra) { |
Wenzel Jakob | b212f6c | 2016-09-10 16:00:50 +0900 | [diff] [blame] | 1241 | typedef detail::iterator_state<Iterator, Sentinel, true, Policy> state; |
Jason Rhinelander | 5aa85be | 2016-08-11 21:22:05 -0400 | [diff] [blame] | 1242 | |
Wenzel Jakob | 8e5dceb | 2016-09-11 20:00:40 +0900 | [diff] [blame] | 1243 | if (!detail::get_type_info(typeid(state), false)) { |
Wenzel Jakob | 146397e | 2016-09-06 13:06:31 +0900 | [diff] [blame] | 1244 | class_<state>(handle(), "iterator") |
Jason Rhinelander | 5aa85be | 2016-08-11 21:22:05 -0400 | [diff] [blame] | 1245 | .def("__iter__", [](state &s) -> state& { return s; }) |
| 1246 | .def("__next__", [](state &s) -> KeyType { |
| 1247 | if (!s.first) |
| 1248 | ++s.it; |
| 1249 | else |
| 1250 | s.first = false; |
| 1251 | if (s.it == s.end) |
| 1252 | throw stop_iteration(); |
Ivan Smirnov | c5a1c8a | 2016-08-24 23:27:19 +0100 | [diff] [blame] | 1253 | return (*s.it).first; |
Wenzel Jakob | b212f6c | 2016-09-10 16:00:50 +0900 | [diff] [blame] | 1254 | }, std::forward<Extra>(extra)..., Policy); |
Jason Rhinelander | 5aa85be | 2016-08-11 21:22:05 -0400 | [diff] [blame] | 1255 | } |
| 1256 | |
| 1257 | return (iterator) cast(state { first, last, true }); |
| 1258 | } |
Wenzel Jakob | b282595 | 2016-04-13 23:33:00 +0200 | [diff] [blame] | 1259 | |
Wenzel Jakob | b212f6c | 2016-09-10 16:00:50 +0900 | [diff] [blame] | 1260 | template <return_value_policy Policy = return_value_policy::reference_internal, |
| 1261 | typename Type, typename... Extra> iterator make_iterator(Type &value, Extra&&... extra) { |
| 1262 | return make_iterator<Policy>(std::begin(value), std::end(value), extra...); |
Wenzel Jakob | bf0c7dc | 2016-04-18 10:52:12 +0200 | [diff] [blame] | 1263 | } |
| 1264 | |
Wenzel Jakob | b212f6c | 2016-09-10 16:00:50 +0900 | [diff] [blame] | 1265 | template <return_value_policy Policy = return_value_policy::reference_internal, |
| 1266 | typename Type, typename... Extra> iterator make_key_iterator(Type &value, Extra&&... extra) { |
| 1267 | return make_key_iterator<Policy>(std::begin(value), std::end(value), extra...); |
Jason Rhinelander | 5aa85be | 2016-08-11 21:22:05 -0400 | [diff] [blame] | 1268 | } |
| 1269 | |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1270 | template <typename InputType, typename OutputType> void implicitly_convertible() { |
Wenzel Jakob | 2ac5044 | 2016-01-17 22:36:35 +0100 | [diff] [blame] | 1271 | auto implicit_caster = [](PyObject *obj, PyTypeObject *type) -> PyObject * { |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1272 | if (!detail::type_caster<InputType>().load(obj, false)) |
| 1273 | return nullptr; |
| 1274 | tuple args(1); |
| 1275 | args[0] = obj; |
| 1276 | PyObject *result = PyObject_Call((PyObject *) type, args.ptr(), nullptr); |
| 1277 | if (result == nullptr) |
| 1278 | PyErr_Clear(); |
| 1279 | return result; |
| 1280 | }; |
Wenzel Jakob | b6cf75d | 2016-01-29 11:39:32 +0100 | [diff] [blame] | 1281 | auto ®istered_types = detail::get_internals().registered_types_cpp; |
| 1282 | auto it = registered_types.find(std::type_index(typeid(OutputType))); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1283 | if (it == registered_types.end()) |
Wenzel Jakob | 678d787 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 1284 | pybind11_fail("implicitly_convertible: Unable to find type " + type_id<OutputType>()); |
Wenzel Jakob | d561cb0 | 2016-01-17 22:36:41 +0100 | [diff] [blame] | 1285 | ((detail::type_info *) it->second)->implicit_conversions.push_back(implicit_caster); |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1286 | } |
| 1287 | |
Pim Schellart | 5a7d17f | 2016-06-17 17:35:59 -0400 | [diff] [blame] | 1288 | template <typename ExceptionTranslator> |
| 1289 | void register_exception_translator(ExceptionTranslator&& translator) { |
| 1290 | detail::get_internals().registered_exception_translators.push_front( |
| 1291 | std::forward<ExceptionTranslator>(translator)); |
| 1292 | } |
| 1293 | |
| 1294 | /* Wrapper to generate a new Python exception type. |
| 1295 | * |
| 1296 | * This should only be used with PyErr_SetString for now. |
| 1297 | * It is not (yet) possible to use as a py::base. |
| 1298 | * Template type argument is reserved for future use. |
| 1299 | */ |
| 1300 | template <typename type> |
| 1301 | class exception : public object { |
| 1302 | public: |
Jason Rhinelander | b3794f1 | 2016-09-16 02:04:15 -0400 | [diff] [blame] | 1303 | exception(module &m, const std::string &name, PyObject* base=PyExc_Exception) { |
Pim Schellart | 5a7d17f | 2016-06-17 17:35:59 -0400 | [diff] [blame] | 1304 | std::string full_name = std::string(PyModule_GetName(m.ptr())) |
| 1305 | + std::string(".") + name; |
| 1306 | char* exception_name = const_cast<char*>(full_name.c_str()); |
| 1307 | m_ptr = PyErr_NewException(exception_name, base, NULL); |
| 1308 | inc_ref(); // PyModule_AddObject() steals a reference |
| 1309 | PyModule_AddObject(m.ptr(), name.c_str(), m_ptr); |
| 1310 | } |
Jason Rhinelander | b3794f1 | 2016-09-16 02:04:15 -0400 | [diff] [blame] | 1311 | |
| 1312 | // Sets the current python exception to this exception object with the given message |
| 1313 | void operator()(const char *message) { |
| 1314 | PyErr_SetString(m_ptr, message); |
| 1315 | } |
Pim Schellart | 5a7d17f | 2016-06-17 17:35:59 -0400 | [diff] [blame] | 1316 | }; |
| 1317 | |
Jason Rhinelander | b3794f1 | 2016-09-16 02:04:15 -0400 | [diff] [blame] | 1318 | /** Registers a Python exception in `m` of the given `name` and installs an exception translator to |
| 1319 | * translate the C++ exception to the created Python exception using the exceptions what() method. |
| 1320 | * This is intended for simple exception translations; for more complex translation, register the |
| 1321 | * exception object and translator directly. |
| 1322 | */ |
| 1323 | template <typename CppException> exception<CppException>& register_exception(module &m, const std::string &name, PyObject* base = PyExc_Exception) { |
| 1324 | static exception<CppException> ex(m, name, base); |
| 1325 | register_exception_translator([](std::exception_ptr p) { |
| 1326 | if (!p) return; |
| 1327 | try { |
| 1328 | std::rethrow_exception(p); |
| 1329 | } |
| 1330 | catch (const CppException &e) { |
| 1331 | ex(e.what()); |
| 1332 | } |
| 1333 | }); |
| 1334 | return ex; |
| 1335 | } |
| 1336 | |
Dean Moldovan | 67990d9 | 2016-08-29 18:03:34 +0200 | [diff] [blame] | 1337 | NAMESPACE_BEGIN(detail) |
| 1338 | PYBIND11_NOINLINE inline void print(tuple args, dict kwargs) { |
| 1339 | auto strings = tuple(args.size()); |
| 1340 | for (size_t i = 0; i < args.size(); ++i) { |
| 1341 | strings[i] = args[i].cast<object>().str(); |
| 1342 | } |
Dean Moldovan | 865e430 | 2016-09-21 01:06:32 +0200 | [diff] [blame] | 1343 | auto sep = kwargs.contains("sep") ? kwargs["sep"] : cast(" "); |
Dean Moldovan | 242b146 | 2016-09-08 17:02:04 +0200 | [diff] [blame^] | 1344 | auto line = sep.attr("join")(strings); |
Dean Moldovan | 67990d9 | 2016-08-29 18:03:34 +0200 | [diff] [blame] | 1345 | |
Dean Moldovan | 865e430 | 2016-09-21 01:06:32 +0200 | [diff] [blame] | 1346 | auto file = kwargs.contains("file") ? kwargs["file"].cast<object>() |
| 1347 | : module::import("sys").attr("stdout"); |
Dean Moldovan | 242b146 | 2016-09-08 17:02:04 +0200 | [diff] [blame^] | 1348 | auto write = file.attr("write"); |
Dean Moldovan | 67990d9 | 2016-08-29 18:03:34 +0200 | [diff] [blame] | 1349 | write(line); |
Dean Moldovan | 865e430 | 2016-09-21 01:06:32 +0200 | [diff] [blame] | 1350 | write(kwargs.contains("end") ? kwargs["end"] : cast("\n")); |
Dean Moldovan | 67990d9 | 2016-08-29 18:03:34 +0200 | [diff] [blame] | 1351 | |
Dean Moldovan | 865e430 | 2016-09-21 01:06:32 +0200 | [diff] [blame] | 1352 | if (kwargs.contains("flush") && kwargs["flush"].cast<bool>()) { |
Dean Moldovan | 242b146 | 2016-09-08 17:02:04 +0200 | [diff] [blame^] | 1353 | file.attr("flush")(); |
Dean Moldovan | 67990d9 | 2016-08-29 18:03:34 +0200 | [diff] [blame] | 1354 | } |
| 1355 | } |
| 1356 | NAMESPACE_END(detail) |
| 1357 | |
| 1358 | template <return_value_policy policy = return_value_policy::automatic_reference, typename... Args> |
| 1359 | void print(Args &&...args) { |
| 1360 | auto c = detail::collect_arguments<policy>(std::forward<Args>(args)...); |
| 1361 | detail::print(c.args(), c.kwargs()); |
| 1362 | } |
| 1363 | |
Felipe Lema | 2547ca4 | 2016-01-25 16:22:44 -0300 | [diff] [blame] | 1364 | #if defined(WITH_THREAD) |
Wenzel Jakob | 39e97e6 | 2016-04-25 03:26:15 +0200 | [diff] [blame] | 1365 | |
| 1366 | /* The functions below essentially reproduce the PyGILState_* API using a RAII |
| 1367 | * pattern, but there are a few important differences: |
| 1368 | * |
| 1369 | * 1. When acquiring the GIL from an non-main thread during the finalization |
| 1370 | * phase, the GILState API blindly terminates the calling thread, which |
| 1371 | * is often not what is wanted. This API does not do this. |
| 1372 | * |
| 1373 | * 2. The gil_scoped_release function can optionally cut the relationship |
| 1374 | * of a PyThreadState and its associated thread, which allows moving it to |
| 1375 | * another thread (this is a fairly rare/advanced use case). |
| 1376 | * |
| 1377 | * 3. The reference count of an acquired thread state can be controlled. This |
| 1378 | * can be handy to prevent cases where callbacks issued from an external |
Wenzel Jakob | fbafdea | 2016-04-25 15:02:43 +0200 | [diff] [blame] | 1379 | * thread would otherwise constantly construct and destroy thread state data |
| 1380 | * structures. |
Wenzel Jakob | 69e1a5c | 2016-05-26 14:29:31 +0200 | [diff] [blame] | 1381 | * |
| 1382 | * See the Python bindings of NanoGUI (http://github.com/wjakob/nanogui) for an |
| 1383 | * example which uses features 2 and 3 to migrate the Python thread of |
| 1384 | * execution to another thread (to run the event loop on the original thread, |
| 1385 | * in this case). |
Wenzel Jakob | fbafdea | 2016-04-25 15:02:43 +0200 | [diff] [blame] | 1386 | */ |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1387 | |
| 1388 | class gil_scoped_acquire { |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1389 | public: |
Wenzel Jakob | fbafdea | 2016-04-25 15:02:43 +0200 | [diff] [blame] | 1390 | PYBIND11_NOINLINE gil_scoped_acquire() { |
Wenzel Jakob | 39e97e6 | 2016-04-25 03:26:15 +0200 | [diff] [blame] | 1391 | auto const &internals = detail::get_internals(); |
| 1392 | tstate = (PyThreadState *) PyThread_get_key_value(internals.tstate); |
| 1393 | |
| 1394 | if (!tstate) { |
| 1395 | tstate = PyThreadState_New(internals.istate); |
| 1396 | #if !defined(NDEBUG) |
| 1397 | if (!tstate) |
| 1398 | pybind11_fail("scoped_acquire: could not create thread state!"); |
| 1399 | #endif |
| 1400 | tstate->gilstate_counter = 0; |
Wenzel Jakob | fbafdea | 2016-04-25 15:02:43 +0200 | [diff] [blame] | 1401 | #if PY_MAJOR_VERSION < 3 |
| 1402 | PyThread_delete_key_value(internals.tstate); |
| 1403 | #endif |
Wenzel Jakob | 39e97e6 | 2016-04-25 03:26:15 +0200 | [diff] [blame] | 1404 | PyThread_set_key_value(internals.tstate, tstate); |
| 1405 | } else { |
Wenzel Jakob | fbafdea | 2016-04-25 15:02:43 +0200 | [diff] [blame] | 1406 | release = detail::get_thread_state_unchecked() != tstate; |
Wenzel Jakob | 39e97e6 | 2016-04-25 03:26:15 +0200 | [diff] [blame] | 1407 | } |
| 1408 | |
| 1409 | if (release) { |
Wenzel Jakob | 39e97e6 | 2016-04-25 03:26:15 +0200 | [diff] [blame] | 1410 | /* Work around an annoying assertion in PyThreadState_Swap */ |
Wenzel Jakob | fbafdea | 2016-04-25 15:02:43 +0200 | [diff] [blame] | 1411 | #if defined(Py_DEBUG) |
| 1412 | PyInterpreterState *interp = tstate->interp; |
| 1413 | tstate->interp = nullptr; |
| 1414 | #endif |
Wenzel Jakob | 39e97e6 | 2016-04-25 03:26:15 +0200 | [diff] [blame] | 1415 | PyEval_AcquireThread(tstate); |
Wenzel Jakob | fbafdea | 2016-04-25 15:02:43 +0200 | [diff] [blame] | 1416 | #if defined(Py_DEBUG) |
| 1417 | tstate->interp = interp; |
| 1418 | #endif |
Wenzel Jakob | 39e97e6 | 2016-04-25 03:26:15 +0200 | [diff] [blame] | 1419 | } |
| 1420 | |
| 1421 | inc_ref(); |
| 1422 | } |
| 1423 | |
| 1424 | void inc_ref() { |
| 1425 | ++tstate->gilstate_counter; |
| 1426 | } |
| 1427 | |
Wenzel Jakob | fbafdea | 2016-04-25 15:02:43 +0200 | [diff] [blame] | 1428 | PYBIND11_NOINLINE void dec_ref() { |
Wenzel Jakob | 39e97e6 | 2016-04-25 03:26:15 +0200 | [diff] [blame] | 1429 | --tstate->gilstate_counter; |
| 1430 | #if !defined(NDEBUG) |
Wenzel Jakob | fbafdea | 2016-04-25 15:02:43 +0200 | [diff] [blame] | 1431 | if (detail::get_thread_state_unchecked() != tstate) |
Wenzel Jakob | 39e97e6 | 2016-04-25 03:26:15 +0200 | [diff] [blame] | 1432 | pybind11_fail("scoped_acquire::dec_ref(): thread state must be current!"); |
| 1433 | if (tstate->gilstate_counter < 0) |
| 1434 | pybind11_fail("scoped_acquire::dec_ref(): reference count underflow!"); |
| 1435 | #endif |
| 1436 | if (tstate->gilstate_counter == 0) { |
| 1437 | #if !defined(NDEBUG) |
| 1438 | if (!release) |
| 1439 | pybind11_fail("scoped_acquire::dec_ref(): internal error!"); |
| 1440 | #endif |
| 1441 | PyThreadState_Clear(tstate); |
| 1442 | PyThreadState_DeleteCurrent(); |
Wenzel Jakob | fbafdea | 2016-04-25 15:02:43 +0200 | [diff] [blame] | 1443 | PyThread_delete_key_value(detail::get_internals().tstate); |
Wenzel Jakob | 39e97e6 | 2016-04-25 03:26:15 +0200 | [diff] [blame] | 1444 | release = false; |
| 1445 | } |
| 1446 | } |
| 1447 | |
Wenzel Jakob | fbafdea | 2016-04-25 15:02:43 +0200 | [diff] [blame] | 1448 | PYBIND11_NOINLINE ~gil_scoped_acquire() { |
Wenzel Jakob | 39e97e6 | 2016-04-25 03:26:15 +0200 | [diff] [blame] | 1449 | dec_ref(); |
| 1450 | if (release) |
| 1451 | PyEval_SaveThread(); |
| 1452 | } |
| 1453 | private: |
| 1454 | PyThreadState *tstate = nullptr; |
| 1455 | bool release = true; |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1456 | }; |
| 1457 | |
| 1458 | class gil_scoped_release { |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1459 | public: |
Wenzel Jakob | 39e97e6 | 2016-04-25 03:26:15 +0200 | [diff] [blame] | 1460 | gil_scoped_release(bool disassoc = false) : disassoc(disassoc) { |
| 1461 | tstate = PyEval_SaveThread(); |
Wenzel Jakob | 2f6662e | 2016-04-25 09:16:41 +0200 | [diff] [blame] | 1462 | if (disassoc) { |
Boris Schäling | 20ee935 | 2016-05-28 12:26:18 +0200 | [diff] [blame] | 1463 | auto key = detail::get_internals().tstate; |
Wenzel Jakob | 2f6662e | 2016-04-25 09:16:41 +0200 | [diff] [blame] | 1464 | #if PY_MAJOR_VERSION < 3 |
| 1465 | PyThread_delete_key_value(key); |
| 1466 | #else |
| 1467 | PyThread_set_key_value(key, nullptr); |
| 1468 | #endif |
| 1469 | } |
Wenzel Jakob | 39e97e6 | 2016-04-25 03:26:15 +0200 | [diff] [blame] | 1470 | } |
| 1471 | ~gil_scoped_release() { |
| 1472 | if (!tstate) |
| 1473 | return; |
| 1474 | PyEval_RestoreThread(tstate); |
Wenzel Jakob | 2f6662e | 2016-04-25 09:16:41 +0200 | [diff] [blame] | 1475 | if (disassoc) { |
Boris Schäling | 20ee935 | 2016-05-28 12:26:18 +0200 | [diff] [blame] | 1476 | auto key = detail::get_internals().tstate; |
Wenzel Jakob | 2f6662e | 2016-04-25 09:16:41 +0200 | [diff] [blame] | 1477 | #if PY_MAJOR_VERSION < 3 |
| 1478 | PyThread_delete_key_value(key); |
| 1479 | #endif |
| 1480 | PyThread_set_key_value(key, tstate); |
| 1481 | } |
Wenzel Jakob | 39e97e6 | 2016-04-25 03:26:15 +0200 | [diff] [blame] | 1482 | } |
| 1483 | private: |
| 1484 | PyThreadState *tstate; |
| 1485 | bool disassoc; |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1486 | }; |
Wenzel Jakob | 39e97e6 | 2016-04-25 03:26:15 +0200 | [diff] [blame] | 1487 | #else |
| 1488 | class gil_scoped_acquire { }; |
| 1489 | class gil_scoped_release { }; |
Felipe Lema | 2547ca4 | 2016-01-25 16:22:44 -0300 | [diff] [blame] | 1490 | #endif |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1491 | |
Jason Rhinelander | 1b05ce5 | 2016-08-09 17:57:59 -0400 | [diff] [blame] | 1492 | inline function get_type_overload(const void *this_ptr, const detail::type_info *this_type, const char *name) { |
| 1493 | handle py_object = detail::get_object_handle(this_ptr, this_type); |
Wenzel Jakob | ac0fde9 | 2015-10-01 18:37:26 +0200 | [diff] [blame] | 1494 | if (!py_object) |
| 1495 | return function(); |
Wenzel Jakob | a2f6fde | 2015-10-01 16:46:03 +0200 | [diff] [blame] | 1496 | handle type = py_object.get_type(); |
| 1497 | auto key = std::make_pair(type.ptr(), name); |
| 1498 | |
Wenzel Jakob | f5c154a | 2016-04-11 18:13:08 +0200 | [diff] [blame] | 1499 | /* Cache functions that aren't overloaded in Python to avoid |
| 1500 | many costly Python dictionary lookups below */ |
Wenzel Jakob | a2f6fde | 2015-10-01 16:46:03 +0200 | [diff] [blame] | 1501 | auto &cache = detail::get_internals().inactive_overload_cache; |
| 1502 | if (cache.find(key) != cache.end()) |
| 1503 | return function(); |
| 1504 | |
Dean Moldovan | 865e430 | 2016-09-21 01:06:32 +0200 | [diff] [blame] | 1505 | function overload = getattr(py_object, name, function()); |
Wenzel Jakob | a2f6fde | 2015-10-01 16:46:03 +0200 | [diff] [blame] | 1506 | if (overload.is_cpp_function()) { |
| 1507 | cache.insert(key); |
| 1508 | return function(); |
| 1509 | } |
Wenzel Jakob | 27e8e10 | 2016-01-17 22:36:37 +0100 | [diff] [blame] | 1510 | |
Wenzel Jakob | f5c154a | 2016-04-11 18:13:08 +0200 | [diff] [blame] | 1511 | /* Don't call dispatch code if invoked from overridden function */ |
Wenzel Jakob | a2f6fde | 2015-10-01 16:46:03 +0200 | [diff] [blame] | 1512 | PyFrameObject *frame = PyThreadState_Get()->frame; |
Wenzel Jakob | b2b44a9 | 2016-04-15 17:50:40 +0200 | [diff] [blame] | 1513 | if (frame && (std::string) pybind11::handle(frame->f_code->co_name).str() == name && |
Wenzel Jakob | f5c154a | 2016-04-11 18:13:08 +0200 | [diff] [blame] | 1514 | frame->f_code->co_argcount > 0) { |
| 1515 | PyFrame_FastToLocals(frame); |
| 1516 | PyObject *self_caller = PyDict_GetItem( |
| 1517 | frame->f_locals, PyTuple_GET_ITEM(frame->f_code->co_varnames, 0)); |
| 1518 | if (self_caller == py_object.ptr()) |
| 1519 | return function(); |
| 1520 | } |
Wenzel Jakob | a2f6fde | 2015-10-01 16:46:03 +0200 | [diff] [blame] | 1521 | return overload; |
| 1522 | } |
| 1523 | |
Jason Rhinelander | 1b05ce5 | 2016-08-09 17:57:59 -0400 | [diff] [blame] | 1524 | template <class T> function get_overload(const T *this_ptr, const char *name) { |
| 1525 | auto &cpp_types = detail::get_internals().registered_types_cpp; |
| 1526 | auto it = cpp_types.find(typeid(T)); |
| 1527 | if (it == cpp_types.end()) |
| 1528 | return function(); |
| 1529 | return get_type_overload(this_ptr, (const detail::type_info *) it->second, name); |
| 1530 | } |
| 1531 | |
Jason Rhinelander | 2097826 | 2016-08-29 18:16:46 -0400 | [diff] [blame] | 1532 | #define PYBIND11_OVERLOAD_INT(ret_type, cname, name, ...) { \ |
Wenzel Jakob | 8f4eb00 | 2015-10-15 18:13:33 +0200 | [diff] [blame] | 1533 | pybind11::gil_scoped_acquire gil; \ |
Jason Rhinelander | 2097826 | 2016-08-29 18:16:46 -0400 | [diff] [blame] | 1534 | pybind11::function overload = pybind11::get_overload(static_cast<const cname *>(this), name); \ |
Jason Rhinelander | 7dfb932 | 2016-09-08 14:49:43 -0400 | [diff] [blame] | 1535 | if (overload) { \ |
Jason Rhinelander | 3e4fe6c | 2016-09-11 12:17:41 -0400 | [diff] [blame] | 1536 | auto o = overload(__VA_ARGS__); \ |
Jason Rhinelander | 7dfb932 | 2016-09-08 14:49:43 -0400 | [diff] [blame] | 1537 | if (pybind11::detail::cast_is_temporary_value_reference<ret_type>::value) { \ |
Jason Rhinelander | 3e4fe6c | 2016-09-11 12:17:41 -0400 | [diff] [blame] | 1538 | static pybind11::detail::overload_caster_t<ret_type> caster; \ |
| 1539 | return pybind11::detail::cast_ref<ret_type>(std::move(o), caster); \ |
Jason Rhinelander | 7dfb932 | 2016-09-08 14:49:43 -0400 | [diff] [blame] | 1540 | } \ |
| 1541 | else return pybind11::detail::cast_safe<ret_type>(std::move(o)); \ |
| 1542 | } \ |
| 1543 | } |
Wenzel Jakob | a2f6fde | 2015-10-01 16:46:03 +0200 | [diff] [blame] | 1544 | |
Wenzel Jakob | 1e3be73 | 2016-05-24 23:42:05 +0200 | [diff] [blame] | 1545 | #define PYBIND11_OVERLOAD_NAME(ret_type, cname, name, fn, ...) \ |
Jason Rhinelander | 2097826 | 2016-08-29 18:16:46 -0400 | [diff] [blame] | 1546 | PYBIND11_OVERLOAD_INT(ret_type, cname, name, __VA_ARGS__) \ |
Wenzel Jakob | 1e3be73 | 2016-05-24 23:42:05 +0200 | [diff] [blame] | 1547 | return cname::fn(__VA_ARGS__) |
Wenzel Jakob | a2f6fde | 2015-10-01 16:46:03 +0200 | [diff] [blame] | 1548 | |
Wenzel Jakob | 1e3be73 | 2016-05-24 23:42:05 +0200 | [diff] [blame] | 1549 | #define PYBIND11_OVERLOAD_PURE_NAME(ret_type, cname, name, fn, ...) \ |
Jason Rhinelander | 2097826 | 2016-08-29 18:16:46 -0400 | [diff] [blame] | 1550 | PYBIND11_OVERLOAD_INT(ret_type, cname, name, __VA_ARGS__) \ |
Wenzel Jakob | 1e3be73 | 2016-05-24 23:42:05 +0200 | [diff] [blame] | 1551 | pybind11::pybind11_fail("Tried to call pure virtual function \"" #cname "::" name "\""); |
| 1552 | |
| 1553 | #define PYBIND11_OVERLOAD(ret_type, cname, fn, ...) \ |
| 1554 | PYBIND11_OVERLOAD_NAME(ret_type, cname, #fn, fn, __VA_ARGS__) |
| 1555 | |
| 1556 | #define PYBIND11_OVERLOAD_PURE(ret_type, cname, fn, ...) \ |
| 1557 | PYBIND11_OVERLOAD_PURE_NAME(ret_type, cname, #fn, fn, __VA_ARGS__) |
Wenzel Jakob | a2f6fde | 2015-10-01 16:46:03 +0200 | [diff] [blame] | 1558 | |
Wenzel Jakob | 8f4eb00 | 2015-10-15 18:13:33 +0200 | [diff] [blame] | 1559 | NAMESPACE_END(pybind11) |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1560 | |
| 1561 | #if defined(_MSC_VER) |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 1562 | # pragma warning(pop) |
Wenzel Jakob | 1ffce74 | 2016-08-25 01:43:33 +0200 | [diff] [blame] | 1563 | #elif defined(__INTEL_COMPILER) |
| 1564 | /* Leave ignored warnings on */ |
Wenzel Jakob | 6d25296 | 2016-05-01 20:47:49 +0200 | [diff] [blame] | 1565 | #elif defined(__GNUG__) && !defined(__clang__) |
Wenzel Jakob | 48548ea | 2016-01-17 22:36:44 +0100 | [diff] [blame] | 1566 | # pragma GCC diagnostic pop |
Wenzel Jakob | 38bd711 | 2015-07-05 20:05:44 +0200 | [diff] [blame] | 1567 | #endif |