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