pybind11.h 82.2 KB
Newer Older
Wenzel Jakob's avatar
Wenzel Jakob committed
1
/*
Wenzel Jakob's avatar
Wenzel Jakob committed
2
3
    pybind11/pybind11.h: Main header file of the C++11 python
    binding generator library
Wenzel Jakob's avatar
Wenzel Jakob committed
4

5
    Copyright (c) 2016 Wenzel Jakob <wenzel.jakob@epfl.ch>
Wenzel Jakob's avatar
Wenzel Jakob committed
6
7
8
9
10

    All rights reserved. Use of this source code is governed by a
    BSD-style license that can be found in the LICENSE file.
*/

11
#pragma once
Wenzel Jakob's avatar
Wenzel Jakob committed
12
13

#if defined(_MSC_VER)
Wenzel Jakob's avatar
Wenzel Jakob committed
14
#  pragma warning(push)
15
#  pragma warning(disable: 4100) // warning C4100: Unreferenced formal parameter
Wenzel Jakob's avatar
Wenzel Jakob committed
16
#  pragma warning(disable: 4127) // warning C4127: Conditional expression is constant
17
#  pragma warning(disable: 4512) // warning C4512: Assignment operator was implicitly defined as deleted
Wenzel Jakob's avatar
Wenzel Jakob committed
18
19
#  pragma warning(disable: 4800) // warning C4800: 'int': forcing value to bool 'true' or 'false' (performance warning)
#  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's avatar
Wenzel Jakob committed
20
#  pragma warning(disable: 4702) // warning C4702: unreachable code
21
#  pragma warning(disable: 4522) // warning C4522: multiple assignment operators specified
22
#elif defined(__INTEL_COMPILER)
Ben Pritchard's avatar
Ben Pritchard committed
23
#  pragma warning(push)
24
#  pragma warning(disable: 68)    // integer conversion resulted in a change of sign
25
#  pragma warning(disable: 186)   // pointless comparison of unsigned integer with zero
26
#  pragma warning(disable: 878)   // incompatible exception specifications
27
#  pragma warning(disable: 1334)  // the "template" keyword used for syntactic disambiguation may only be used within a template
28
29
#  pragma warning(disable: 1682)  // implicit conversion of a 64-bit integral type to a smaller integral type (potential portability problem)
#  pragma warning(disable: 1875)  // offsetof applied to non-POD (Plain Old Data) types is nonstandard
30
#  pragma warning(disable: 2196)  // warning #2196: routine is both "inline" and "noinline"
31
#elif defined(__GNUG__) && !defined(__clang__)
Wenzel Jakob's avatar
Wenzel Jakob committed
32
33
34
35
#  pragma GCC diagnostic push
#  pragma GCC diagnostic ignored "-Wunused-but-set-parameter"
#  pragma GCC diagnostic ignored "-Wunused-but-set-variable"
#  pragma GCC diagnostic ignored "-Wmissing-field-initializers"
Wenzel Jakob's avatar
Wenzel Jakob committed
36
37
#  pragma GCC diagnostic ignored "-Wstrict-aliasing"
#  pragma GCC diagnostic ignored "-Wattributes"
38
39
40
#  if __GNUC__ >= 7
#    pragma GCC diagnostic ignored "-Wnoexcept-type"
#  endif
Wenzel Jakob's avatar
Wenzel Jakob committed
41
42
#endif

Wenzel Jakob's avatar
Wenzel Jakob committed
43
#include "attr.h"
44
#include "options.h"
45
#include "class_support.h"
Wenzel Jakob's avatar
Wenzel Jakob committed
46

47
NAMESPACE_BEGIN(pybind11)
Wenzel Jakob's avatar
Wenzel Jakob committed
48

Wenzel Jakob's avatar
Wenzel Jakob committed
49
/// Wraps an arbitrary C++ function/method/lambda function/.. into a callable Python object
50
class cpp_function : public function {
Wenzel Jakob's avatar
Wenzel Jakob committed
51
public:
52
    cpp_function() { }
Wenzel Jakob's avatar
Wenzel Jakob committed
53

54
    /// Construct a cpp_function from a vanilla function pointer
55
56
    template <typename Return, typename... Args, typename... Extra>
    cpp_function(Return (*f)(Args...), const Extra&... extra) {
57
        initialize(f, f, extra...);
Wenzel Jakob's avatar
Wenzel Jakob committed
58
59
    }

60
    /// Construct a cpp_function from a lambda function (possibly with internal state)
61
62
    template <typename Func, typename... Extra, typename = detail::enable_if_t<
        detail::satisfies_none_of<
63
            detail::remove_reference_t<Func>,
64
65
66
            std::is_function, std::is_pointer, std::is_member_pointer
        >::value>
    >
67
    cpp_function(Func &&f, const Extra&... extra) {
68
        using FuncType = typename detail::remove_class<decltype(&detail::remove_reference_t<Func>::operator())>::type;
69
        initialize(std::forward<Func>(f),
70
                   (FuncType *) nullptr, extra...);
Wenzel Jakob's avatar
Wenzel Jakob committed
71
72
    }

73
    /// Construct a cpp_function from a class method (non-const)
74
75
    template <typename Return, typename Class, typename... Arg, typename... Extra>
    cpp_function(Return (Class::*f)(Arg...), const Extra&... extra) {
76
        initialize([f](Class *c, Arg... args) -> Return { return (c->*f)(args...); },
77
                   (Return (*) (Class *, Arg...)) nullptr, extra...);
Wenzel Jakob's avatar
Wenzel Jakob committed
78
    }
Wenzel Jakob's avatar
Wenzel Jakob committed
79

80
    /// Construct a cpp_function from a class method (const)
81
82
    template <typename Return, typename Class, typename... Arg, typename... Extra>
    cpp_function(Return (Class::*f)(Arg...) const, const Extra&... extra) {
83
        initialize([f](const Class *c, Arg... args) -> Return { return (c->*f)(args...); },
84
                   (Return (*)(const Class *, Arg ...)) nullptr, extra...);
Wenzel Jakob's avatar
Wenzel Jakob committed
85
86
    }

87
    /// Return the function name
Wenzel Jakob's avatar
Wenzel Jakob committed
88
    object name() const { return attr("__name__"); }
89

90
protected:
91
92
93
94
95
    /// Space optimization: don't inline this frequently instantiated fragment
    PYBIND11_NOINLINE detail::function_record *make_function_record() {
        return new detail::function_record();
    }

96
    /// Special internal constructor for functors, lambda functions, etc.
97
98
    template <typename Func, typename Return, typename... Args, typename... Extra>
    void initialize(Func &&f, Return (*)(Args...), const Extra&... extra) {
99

100
        struct capture { detail::remove_reference_t<Func> f; };
Wenzel Jakob's avatar
Wenzel Jakob committed
101

102
        /* Store the function including any extra state it might have (e.g. a lambda capture object) */
103
        auto rec = make_function_record();
104

105
106
        /* Store the capture object directly in the function record if there is enough space */
        if (sizeof(capture) <= sizeof(rec->data)) {
107
108
109
            /* Without these pragmas, GCC warns that there might not be
               enough space to use the placement new operator. However, the
               'if' statement above ensures that this is the case. */
110
#if defined(__GNUG__) && !defined(__clang__) && __GNUC__ >= 6
111
112
113
#  pragma GCC diagnostic push
#  pragma GCC diagnostic ignored "-Wplacement-new"
#endif
114
            new ((capture *) &rec->data) capture { std::forward<Func>(f) };
115
#if defined(__GNUG__) && !defined(__clang__) && __GNUC__ >= 6
116
117
#  pragma GCC diagnostic pop
#endif
118
119
120
121
122
123
            if (!std::is_trivially_destructible<Func>::value)
                rec->free_data = [](detail::function_record *r) { ((capture *) &r->data)->~capture(); };
        } else {
            rec->data[0] = new capture { std::forward<Func>(f) };
            rec->free_data = [](detail::function_record *r) { delete ((capture *) r->data[0]); };
        }
124

125
        /* Type casters for the function arguments and return value */
126
127
128
129
        using cast_in = detail::argument_loader<Args...>;
        using cast_out = detail::make_caster<
            detail::conditional_t<std::is_void<Return>::value, detail::void_type, Return>
        >;
Wenzel Jakob's avatar
Wenzel Jakob committed
130

131
        static_assert(detail::expected_num_args<Extra...>(sizeof...(Args), cast_in::has_args, cast_in::has_kwargs),
132
                      "The number of argument annotations does not match the number of function arguments");
133

134
        /* Dispatch code which converts function arguments and performs the actual function call */
135
        rec->impl = [](detail::function_call &call) -> handle {
136
            cast_in args_converter;
137
138

            /* Try to cast the function arguments into the C++ domain */
139
            if (!args_converter.load_args(call))
140
141
                return PYBIND11_TRY_NEXT_OVERLOAD;

Wenzel Jakob's avatar
Wenzel Jakob committed
142
            /* Invoke call policy pre-call hook */
143
            detail::process_attributes<Extra...>::precall(call);
144
145

            /* Get a pointer to the capture object */
146
147
148
            auto data = (sizeof(capture) <= sizeof(call.func.data)
                         ? &call.func.data : call.func.data[0]);
            capture *cap = const_cast<capture *>(reinterpret_cast<const capture *>(data));
149

150
151
            /* Override policy for rvalues -- usually to enforce rvp::move on an rvalue */
            const auto policy = detail::return_value_policy_override<Return>::policy(call.func.policy);
152

Dean Moldovan's avatar
Dean Moldovan committed
153
154
155
            /* Function scope guard -- defaults to the compile-to-nothing `void_type` */
            using Guard = detail::extract_guard_t<Extra...>;

156
            /* Perform the function call */
157
158
            handle result = cast_out::cast(
                std::move(args_converter).template call<Return, Guard>(cap->f), policy, call.parent);
Wenzel Jakob's avatar
Wenzel Jakob committed
159
160

            /* Invoke call policy post-call hook */
161
            detail::process_attributes<Extra...>::postcall(call, result);
162

163
            return result;
Wenzel Jakob's avatar
Wenzel Jakob committed
164
165
        };

Wenzel Jakob's avatar
Wenzel Jakob committed
166
167
        /* Process any user-provided function attributes */
        detail::process_attributes<Extra...>::init(extra..., rec);
168
169

        /* Generate a readable signature describing the function's arguments and return value types */
170
        using detail::descr; using detail::_;
171
        PYBIND11_DESCR signature = _("(") + cast_in::arg_names() + _(") -> ") + cast_out::name();
172
173

        /* Register the function with Python from generic (non-templated) code */
174
        initialize_generic(rec, signature.text(), signature.types(), sizeof...(Args));
175
176
177

        if (cast_in::has_args) rec->has_args = true;
        if (cast_in::has_kwargs) rec->has_kwargs = true;
178
179

        /* Stash some additional information used by an important optimization in 'functional.h' */
180
        using FunctionType = Return (*)(Args...);
181
182
183
184
185
        constexpr bool is_function_ptr =
            std::is_convertible<Func, FunctionType>::value &&
            sizeof(capture) == sizeof(void *);
        if (is_function_ptr) {
            rec->is_stateless = true;
186
            rec->data[1] = const_cast<void *>(reinterpret_cast<const void *>(&typeid(FunctionType)));
187
        }
188
189
    }

190
    /// Register a function call with Python (generic non-templated code goes here)
191
    void initialize_generic(detail::function_record *rec, const char *text,
192
                            const std::type_info *const *types, size_t args) {
Wenzel Jakob's avatar
Wenzel Jakob committed
193

194
        /* Create copies of all referenced C-style strings */
Wenzel Jakob's avatar
Wenzel Jakob committed
195
196
197
        rec->name = strdup(rec->name ? rec->name : "");
        if (rec->doc) rec->doc = strdup(rec->doc);
        for (auto &a: rec->args) {
198
199
200
201
202
            if (a.name)
                a.name = strdup(a.name);
            if (a.descr)
                a.descr = strdup(a.descr);
            else if (a.value)
203
                a.descr = strdup(a.value.attr("__repr__")().cast<std::string>().c_str());
204
        }
205

206
207
208
209
210
211
212
213
214
        /* Generate a proper function signature */
        std::string signature;
        size_t type_depth = 0, char_index = 0, type_index = 0, arg_index = 0;
        while (true) {
            char c = text[char_index++];
            if (c == '\0')
                break;

            if (c == '{') {
215
                // Write arg name for everything except *args, **kwargs and return type.
216
                if (type_depth == 0 && text[char_index] != '*' && arg_index < args) {
217
                    if (!rec->args.empty() && rec->args[arg_index].name) {
218
                        signature += rec->args[arg_index].name;
219
                    } else if (arg_index == 0 && rec->is_method) {
220
221
                        signature += "self";
                    } else {
222
                        signature += "arg" + std::to_string(arg_index - (rec->is_method ? 1 : 0));
223
224
                    }
                    signature += ": ";
225
226
227
228
                }
                ++type_depth;
            } else if (c == '}') {
                --type_depth;
229
                if (type_depth == 0) {
230
231
                    if (arg_index < rec->args.size() && rec->args[arg_index].descr) {
                        signature += "=";
Wenzel Jakob's avatar
Wenzel Jakob committed
232
                        signature += rec->args[arg_index].descr;
233
234
235
236
237
                    }
                    arg_index++;
                }
            } else if (c == '%') {
                const std::type_info *t = types[type_index++];
238
                if (!t)
239
                    pybind11_fail("Internal error while parsing type signature (1)");
240
                if (auto tinfo = detail::get_type_info(*t)) {
Wenzel Jakob's avatar
Wenzel Jakob committed
241
242
243
244
245
#if defined(PYPY_VERSION)
                    signature += handle((PyObject *) tinfo->type)
                                     .attr("__module__")
                                     .cast<std::string>() + ".";
#endif
246
                    signature += tinfo->type->tp_name;
247
248
249
250
251
252
253
254
255
                } else {
                    std::string tname(t->name());
                    detail::clean_type_id(tname);
                    signature += tname;
                }
            } else {
                signature += c;
            }
        }
256
        if (type_depth != 0 || types[type_index] != nullptr)
257
            pybind11_fail("Internal error while parsing type signature (2)");
258

259
        #if !defined(PYBIND11_CONSTEXPR_DESCR)
260
261
262
            delete[] types;
            delete[] text;
        #endif
263

264
#if PY_MAJOR_VERSION < 3
Wenzel Jakob's avatar
Wenzel Jakob committed
265
266
267
        if (strcmp(rec->name, "__next__") == 0) {
            std::free(rec->name);
            rec->name = strdup("next");
268
269
270
        } else if (strcmp(rec->name, "__bool__") == 0) {
            std::free(rec->name);
            rec->name = strdup("__nonzero__");
271
        }
272
#endif
Wenzel Jakob's avatar
Wenzel Jakob committed
273
274
        rec->signature = strdup(signature.c_str());
        rec->args.shrink_to_fit();
275
        rec->is_constructor = !strcmp(rec->name, "__init__") || !strcmp(rec->name, "__setstate__");
276
        rec->nargs = (std::uint16_t) args;
277

278
279
        if (rec->sibling && PYBIND11_INSTANCE_METHOD_CHECK(rec->sibling.ptr()))
            rec->sibling = PYBIND11_INSTANCE_METHOD_GET_FUNCTION(rec->sibling.ptr());
280

Wenzel Jakob's avatar
Wenzel Jakob committed
281
        detail::function_record *chain = nullptr, *chain_start = rec;
282
283
        if (rec->sibling) {
            if (PyCFunction_Check(rec->sibling.ptr())) {
Wenzel Jakob's avatar
Wenzel Jakob committed
284
                auto rec_capsule = reinterpret_borrow<capsule>(PyCFunction_GET_SELF(rec->sibling.ptr()));
285
286
287
                chain = (detail::function_record *) rec_capsule;
                /* Never append a method to an overload chain of a parent class;
                   instead, hide the parent's overloads in this case */
288
                if (!chain->scope.is(rec->scope))
289
290
291
292
293
294
                    chain = nullptr;
            }
            // Don't trigger for things like the default __init__, which are wrapper_descriptors that we are intentionally replacing
            else if (!rec->sibling.is_none() && rec->name[0] != '_')
                pybind11_fail("Cannot overload existing non-function object \"" + std::string(rec->name) +
                        "\" with a function of the same name");
295
296
        }

Wenzel Jakob's avatar
Wenzel Jakob committed
297
        if (!chain) {
298
            /* No existing overload was found, create a new function object */
Wenzel Jakob's avatar
Wenzel Jakob committed
299
            rec->def = new PyMethodDef();
300
            std::memset(rec->def, 0, sizeof(PyMethodDef));
Wenzel Jakob's avatar
Wenzel Jakob committed
301
302
303
            rec->def->ml_name = rec->name;
            rec->def->ml_meth = reinterpret_cast<PyCFunction>(*dispatcher);
            rec->def->ml_flags = METH_VARARGS | METH_KEYWORDS;
304

305
306
            capsule rec_capsule(rec, [](void *ptr) {
                destruct((detail::function_record *) ptr);
307
            });
308
309
310

            object scope_module;
            if (rec->scope) {
311
312
313
314
315
                if (hasattr(rec->scope, "__module__")) {
                    scope_module = rec->scope.attr("__module__");
                } else if (hasattr(rec->scope, "__name__")) {
                    scope_module = rec->scope.attr("__name__");
                }
316
317
318
            }

            m_ptr = PyCFunction_NewEx(rec->def, rec_capsule.ptr(), scope_module.ptr());
Wenzel Jakob's avatar
Wenzel Jakob committed
319
            if (!m_ptr)
320
                pybind11_fail("cpp_function::cpp_function(): Could not allocate function object");
Wenzel Jakob's avatar
Wenzel Jakob committed
321
        } else {
322
            /* Append at the end of the overload chain */
Wenzel Jakob's avatar
Wenzel Jakob committed
323
            m_ptr = rec->sibling.ptr();
Wenzel Jakob's avatar
Wenzel Jakob committed
324
            inc_ref();
Wenzel Jakob's avatar
Wenzel Jakob committed
325
            chain_start = chain;
326
327
328
329
330
331
332
333
334
            if (chain->is_method != rec->is_method)
                pybind11_fail("overloading a method with both static and instance methods is not supported; "
                    #if defined(NDEBUG)
                        "compile in debug mode for more details"
                    #else
                        "error while attempting to bind " + std::string(rec->is_method ? "instance" : "static") + " method " +
                        std::string(pybind11::str(rec->scope.attr("__name__"))) + "." + std::string(rec->name) + signature
                    #endif
                );
Wenzel Jakob's avatar
Wenzel Jakob committed
335
336
337
            while (chain->next)
                chain = chain->next;
            chain->next = rec;
Wenzel Jakob's avatar
Wenzel Jakob committed
338
        }
339

Wenzel Jakob's avatar
Wenzel Jakob committed
340
        std::string signatures;
341
        int index = 0;
Wenzel Jakob's avatar
Wenzel Jakob committed
342
        /* Create a nice pydoc rec including all signatures and
343
           docstrings of the functions in the overload chain */
344
        if (chain && options::show_function_signatures()) {
345
346
347
348
349
350
            // First a generic signature
            signatures += rec->name;
            signatures += "(*args, **kwargs)\n";
            signatures += "Overloaded function.\n\n";
        }
        // Then specific overload signatures
351
        bool first_user_def = true;
Wenzel Jakob's avatar
Wenzel Jakob committed
352
        for (auto it = chain_start; it != nullptr; it = it->next) {
353
            if (options::show_function_signatures()) {
354
                if (index > 0) signatures += "\n";
355
356
357
358
                if (chain)
                    signatures += std::to_string(++index) + ". ";
                signatures += rec->name;
                signatures += it->signature;
359
                signatures += "\n";
360
361
            }
            if (it->doc && strlen(it->doc) > 0 && options::show_user_defined_docstrings()) {
362
363
364
365
366
367
                // If we're appending another docstring, and aren't printing function signatures, we
                // need to append a newline first:
                if (!options::show_function_signatures()) {
                    if (first_user_def) first_user_def = false;
                    else signatures += "\n";
                }
368
                if (options::show_function_signatures()) signatures += "\n";
369
                signatures += it->doc;
370
                if (options::show_function_signatures()) signatures += "\n";
371
            }
Wenzel Jakob's avatar
Wenzel Jakob committed
372
        }
Wenzel Jakob's avatar
Wenzel Jakob committed
373
374

        /* Install docstring */
Wenzel Jakob's avatar
Wenzel Jakob committed
375
376
        PyCFunctionObject *func = (PyCFunctionObject *) m_ptr;
        if (func->m_ml->ml_doc)
377
            std::free(const_cast<char *>(func->m_ml->ml_doc));
Wenzel Jakob's avatar
Wenzel Jakob committed
378
        func->m_ml->ml_doc = strdup(signatures.c_str());
Wenzel Jakob's avatar
Wenzel Jakob committed
379

380
381
        if (rec->is_method) {
            m_ptr = PYBIND11_INSTANCE_METHOD_NEW(m_ptr, rec->scope.ptr());
Wenzel Jakob's avatar
Wenzel Jakob committed
382
            if (!m_ptr)
383
                pybind11_fail("cpp_function::cpp_function(): Could not allocate instance method object");
Wenzel Jakob's avatar
Wenzel Jakob committed
384
385
386
            Py_DECREF(func);
        }
    }
Wenzel Jakob's avatar
Wenzel Jakob committed
387
388
389
390
391
392

    /// When a cpp_function is GCed, release any memory allocated by pybind11
    static void destruct(detail::function_record *rec) {
        while (rec) {
            detail::function_record *next = rec->next;
            if (rec->free_data)
393
                rec->free_data(rec);
Wenzel Jakob's avatar
Wenzel Jakob committed
394
395
396
397
            std::free((char *) rec->name);
            std::free((char *) rec->doc);
            std::free((char *) rec->signature);
            for (auto &arg: rec->args) {
398
399
                std::free(const_cast<char *>(arg.name));
                std::free(const_cast<char *>(arg.descr));
Wenzel Jakob's avatar
Wenzel Jakob committed
400
401
402
                arg.value.dec_ref();
            }
            if (rec->def) {
403
                std::free(const_cast<char *>(rec->def->ml_doc));
Wenzel Jakob's avatar
Wenzel Jakob committed
404
405
406
407
408
409
410
411
                delete rec->def;
            }
            delete rec;
            rec = next;
        }
    }

    /// Main dispatch logic for calls to functions bound using pybind11
412
    static PyObject *dispatcher(PyObject *self, PyObject *args_in, PyObject *kwargs_in) {
413
414
        using namespace detail;

Wenzel Jakob's avatar
Wenzel Jakob committed
415
        /* Iterator over the list of potentially admissible overloads */
416
417
        function_record *overloads = (function_record *) PyCapsule_GetPointer(self, nullptr),
                        *it = overloads;
Wenzel Jakob's avatar
Wenzel Jakob committed
418
419

        /* Need to know how many arguments + keyword arguments there are to pick the right overload */
420
        const size_t n_args_in = (size_t) PyTuple_GET_SIZE(args_in);
Wenzel Jakob's avatar
Wenzel Jakob committed
421

422
        handle parent = n_args_in > 0 ? PyTuple_GET_ITEM(args_in, 0) : nullptr,
Wenzel Jakob's avatar
Wenzel Jakob committed
423
               result = PYBIND11_TRY_NEXT_OVERLOAD;
424

Wenzel Jakob's avatar
Wenzel Jakob committed
425
        try {
426
427
428
429
430
431
432
433
434
            // We do this in two passes: in the first pass, we load arguments with `convert=false`;
            // in the second, we allow conversion (except for arguments with an explicit
            // py::arg().noconvert()).  This lets us prefer calls without conversion, with
            // conversion as a fallback.
            std::vector<function_call> second_pass;

            // However, if there are no overloads, we can just skip the no-convert pass entirely
            const bool overloaded = it != nullptr && it->next != nullptr;

Wenzel Jakob's avatar
Wenzel Jakob committed
435
            for (; it != nullptr; it = it->next) {
436

Wenzel Jakob's avatar
Wenzel Jakob committed
437
                /* For each overload:
438
439
                   1. Copy all positional arguments we were given, also checking to make sure that
                      named positional arguments weren't *also* specified via kwarg.
440
                   2. If we weren't given enough, try to make up the omitted ones by checking
441
442
443
444
445
446
447
448
449
450
451
452
453
                      whether they were provided by a kwarg matching the `py::arg("name")` name.  If
                      so, use it (and remove it from kwargs; if not, see if the function binding
                      provided a default that we can use.
                   3. Ensure that either all keyword arguments were "consumed", or that the function
                      takes a kwargs argument to accept unconsumed kwargs.
                   4. Any positional arguments still left get put into a tuple (for args), and any
                      leftover kwargs get put into a dict.
                   5. Pack everything into a vector; if we have py::args or py::kwargs, they are an
                      extra tuple or dict at the end of the positional arguments.
                   6. Call the function call dispatcher (function_record::impl)

                   If one of these fail, move on to the next overload and keep trying until we get a
                   result other than PYBIND11_TRY_NEXT_OVERLOAD.
Wenzel Jakob's avatar
Wenzel Jakob committed
454
455
                 */

456
457
458
459
                function_record &func = *it;
                size_t pos_args = func.nargs;    // Number of positional arguments that we need
                if (func.has_args) --pos_args;   // (but don't count py::args
                if (func.has_kwargs) --pos_args; //  or py::kwargs)
Wenzel Jakob's avatar
Wenzel Jakob committed
460

461
                if (!func.has_args && n_args_in > pos_args)
462
463
                    continue; // Too many arguments for this overload

464
                if (n_args_in < pos_args && func.args.size() < pos_args)
465
466
                    continue; // Not enough arguments given, and not enough defaults to fill in the blanks

467
                function_call call(func, parent);
Wenzel Jakob's avatar
Wenzel Jakob committed
468

469
470
471
472
                size_t args_to_copy = std::min(pos_args, n_args_in);
                size_t args_copied = 0;

                // 1. Copy any position arguments given.
473
                bool bad_arg = false;
474
                for (; args_copied < args_to_copy; ++args_copied) {
475
476
477
                    argument_record *arg_rec = args_copied < func.args.size() ? &func.args[args_copied] : nullptr;
                    if (kwargs_in && arg_rec && arg_rec->name && PyDict_GetItemString(kwargs_in, arg_rec->name)) {
                        bad_arg = true;
478
                        break;
479
480
                    }

481
482
483
484
485
486
487
                    handle arg(PyTuple_GET_ITEM(args_in, args_copied));
                    if (arg_rec && !arg_rec->none && arg.is_none()) {
                        bad_arg = true;
                        break;
                    }
                    call.args.push_back(arg);
                    call.args_convert.push_back(arg_rec ? arg_rec->convert : true);
488
                }
489
                if (bad_arg)
490
                    continue; // Maybe it was meant for another overload (issue #688)
491
492
493
494
495
496
497
498
499

                // We'll need to copy this if we steal some kwargs for defaults
                dict kwargs = reinterpret_borrow<dict>(kwargs_in);

                // 2. Check kwargs and, failing that, defaults that may help complete the list
                if (args_copied < pos_args) {
                    bool copied_kwargs = false;

                    for (; args_copied < pos_args; ++args_copied) {
500
                        const auto &arg = func.args[args_copied];
501
502

                        handle value;
503
                        if (kwargs_in && arg.name)
504
                            value = PyDict_GetItemString(kwargs.ptr(), arg.name);
Wenzel Jakob's avatar
Wenzel Jakob committed
505
506

                        if (value) {
507
508
509
510
511
512
                            // Consume a kwargs value
                            if (!copied_kwargs) {
                                kwargs = reinterpret_steal<dict>(PyDict_Copy(kwargs.ptr()));
                                copied_kwargs = true;
                            }
                            PyDict_DelItemString(kwargs.ptr(), arg.name);
513
                        } else if (arg.value) {
514
515
516
                            value = arg.value;
                        }

517
                        if (value) {
518
                            call.args.push_back(value);
519
520
                            call.args_convert.push_back(arg.convert);
                        }
521
                        else
Wenzel Jakob's avatar
Wenzel Jakob committed
522
                            break;
523
524
525
526
527
528
529
                    }

                    if (args_copied < pos_args)
                        continue; // Not enough arguments, defaults, or kwargs to fill the positional arguments
                }

                // 3. Check everything was consumed (unless we have a kwargs arg)
530
                if (kwargs && kwargs.size() > 0 && !func.has_kwargs)
531
532
533
534
                    continue; // Unconsumed kwargs, but no py::kwargs argument to accept them

                // 4a. If we have a py::args argument, create a new tuple with leftovers
                tuple extra_args;
535
                if (func.has_args) {
536
537
538
539
                    if (args_to_copy == 0) {
                        // We didn't copy out any position arguments from the args_in tuple, so we
                        // can reuse it directly without copying:
                        extra_args = reinterpret_borrow<tuple>(args_in);
540
                    } else if (args_copied >= n_args_in) {
541
                        extra_args = tuple(0);
542
                    } else {
543
544
545
546
547
                        size_t args_size = n_args_in - args_copied;
                        extra_args = tuple(args_size);
                        for (size_t i = 0; i < args_size; ++i) {
                            handle item = PyTuple_GET_ITEM(args_in, args_copied + i);
                            extra_args[i] = item.inc_ref().ptr();
Wenzel Jakob's avatar
Wenzel Jakob committed
548
549
                        }
                    }
550
                    call.args.push_back(extra_args);
551
                    call.args_convert.push_back(false);
Wenzel Jakob's avatar
Wenzel Jakob committed
552
                }
553

554
                // 4b. If we have a py::kwargs, pass on any remaining kwargs
555
                if (func.has_kwargs) {
556
557
                    if (!kwargs.ptr())
                        kwargs = dict(); // If we didn't get one, send an empty one
558
                    call.args.push_back(kwargs);
559
                    call.args_convert.push_back(false);
560
561
                }

562
563
564
                // 5. Put everything in a vector.  Not technically step 5, we've been building it
                // in `call.args` all along.
                #if !defined(NDEBUG)
565
                if (call.args.size() != func.nargs || call.args_convert.size() != func.nargs)
566
567
                    pybind11_fail("Internal error: function call dispatcher inserted wrong number of arguments!");
                #endif
568

569
570
571
572
573
574
575
576
577
                std::vector<bool> second_pass_convert;
                if (overloaded) {
                    // We're in the first no-convert pass, so swap out the conversion flags for a
                    // set of all-false flags.  If the call fails, we'll swap the flags back in for
                    // the conversion-allowed call below.
                    second_pass_convert.resize(func.nargs, false);
                    call.args_convert.swap(second_pass_convert);
                }

578
                // 6. Call the function.
579
                try {
580
                    loader_life_support guard{};
581
                    result = func.impl(call);
582
                } catch (reference_cast_error &) {
583
584
                    result = PYBIND11_TRY_NEXT_OVERLOAD;
                }
Wenzel Jakob's avatar
Wenzel Jakob committed
585
586
587

                if (result.ptr() != PYBIND11_TRY_NEXT_OVERLOAD)
                    break;
588

589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
                if (overloaded) {
                    // The (overloaded) call failed; if the call has at least one argument that
                    // permits conversion (i.e. it hasn't been explicitly specified `.noconvert()`)
                    // then add this call to the list of second pass overloads to try.
                    for (size_t i = func.is_method ? 1 : 0; i < pos_args; i++) {
                        if (second_pass_convert[i]) {
                            // Found one: swap the converting flags back in and store the call for
                            // the second pass.
                            call.args_convert.swap(second_pass_convert);
                            second_pass.push_back(std::move(call));
                            break;
                        }
                    }
                }
            }

            if (overloaded && !second_pass.empty() && result.ptr() == PYBIND11_TRY_NEXT_OVERLOAD) {
                // The no-conversion pass finished without success, try again with conversion allowed
                for (auto &call : second_pass) {
                    try {
609
                        loader_life_support guard{};
610
611
612
613
614
615
616
617
                        result = call.func.impl(call);
                    } catch (reference_cast_error &) {
                        result = PYBIND11_TRY_NEXT_OVERLOAD;
                    }

                    if (result.ptr() != PYBIND11_TRY_NEXT_OVERLOAD)
                        break;
                }
Wenzel Jakob's avatar
Wenzel Jakob committed
618
            }
619
620
        } catch (error_already_set &e) {
            e.restore();
621
            return nullptr;
Wenzel Jakob's avatar
Wenzel Jakob committed
622
        } catch (...) {
623
624
625
            /* When an exception is caught, give each registered exception
               translator a chance to translate it to a Python exception
               in reverse order of registration.
626

627
               A translator may choose to do one of the following:
628

629
630
631
632
633
                - catch the exception and call PyErr_SetString or PyErr_SetObject
                  to set a standard (or custom) Python exception, or
                - do nothing and let the exception fall through to the next translator, or
                - delegate translation to the next translator by throwing a new type of exception. */

634
            auto last_exception = std::current_exception();
635
            auto &registered_exception_translators = get_internals().registered_exception_translators;
636
637
638
639
640
641
642
643
644
645
            for (auto& translator : registered_exception_translators) {
                try {
                    translator(last_exception);
                } catch (...) {
                    last_exception = std::current_exception();
                    continue;
                }
                return nullptr;
            }
            PyErr_SetString(PyExc_SystemError, "Exception escaped from default exception translator!");
Wenzel Jakob's avatar
Wenzel Jakob committed
646
647
648
649
            return nullptr;
        }

        if (result.ptr() == PYBIND11_TRY_NEXT_OVERLOAD) {
650
651
652
            if (overloads->is_operator)
                return handle(Py_NotImplemented).inc_ref().ptr();

653
654
655
656
            std::string msg = std::string(overloads->name) + "(): incompatible " +
                std::string(overloads->is_constructor ? "constructor" : "function") +
                " arguments. The following argument types are supported:\n";

Wenzel Jakob's avatar
Wenzel Jakob committed
657
            int ctr = 0;
658
            for (function_record *it2 = overloads; it2 != nullptr; it2 = it2->next) {
Wenzel Jakob's avatar
Wenzel Jakob committed
659
                msg += "    "+ std::to_string(++ctr) + ". ";
660
661
662

                bool wrote_sig = false;
                if (overloads->is_constructor) {
663
                    // For a constructor, rewrite `(self: Object, arg0, ...) -> NoneType` as `Object(arg0, ...)`
664
                    std::string sig = it2->signature;
665
                    size_t start = sig.find('(') + 7; // skip "(self: "
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
                    if (start < sig.size()) {
                        // End at the , for the next argument
                        size_t end = sig.find(", "), next = end + 2;
                        size_t ret = sig.rfind(" -> ");
                        // Or the ), if there is no comma:
                        if (end >= sig.size()) next = end = sig.find(')');
                        if (start < end && next < sig.size()) {
                            msg.append(sig, start, end - start);
                            msg += '(';
                            msg.append(sig, next, ret - next);
                            wrote_sig = true;
                        }
                    }
                }
                if (!wrote_sig) msg += it2->signature;

Wenzel Jakob's avatar
Wenzel Jakob committed
682
683
                msg += "\n";
            }
684
            msg += "\nInvoked with: ";
685
            auto args_ = reinterpret_borrow<tuple>(args_in);
686
            bool some_args = false;
687
            for (size_t ti = overloads->is_constructor ? 1 : 0; ti < args_.size(); ++ti) {
688
689
                if (!some_args) some_args = true;
                else msg += ", ";
690
                msg += pybind11::repr(args_[ti]);
691
            }
692
693
694
695
696
697
698
699
700
701
702
703
704
705
            if (kwargs_in) {
                auto kwargs = reinterpret_borrow<dict>(kwargs_in);
                if (kwargs.size() > 0) {
                    if (some_args) msg += "; ";
                    msg += "kwargs: ";
                    bool first = true;
                    for (auto kwarg : kwargs) {
                        if (first) first = false;
                        else msg += ", ";
                        msg += pybind11::str("{}={!r}").format(kwarg.first, kwarg.second);
                    }
                }
            }

Wenzel Jakob's avatar
Wenzel Jakob committed
706
707
708
709
710
711
712
713
714
715
            PyErr_SetString(PyExc_TypeError, msg.c_str());
            return nullptr;
        } else if (!result) {
            std::string msg = "Unable to convert function return value to a "
                              "Python type! The signature was\n\t";
            msg += it->signature;
            PyErr_SetString(PyExc_TypeError, msg.c_str());
            return nullptr;
        } else {
            if (overloads->is_constructor) {
716
                auto tinfo = get_type_info((PyTypeObject *) overloads->scope.ptr());
717
                tinfo->init_instance(reinterpret_cast<instance *>(parent.ptr()), nullptr);
Wenzel Jakob's avatar
Wenzel Jakob committed
718
719
720
721
            }
            return result.ptr();
        }
    }
Wenzel Jakob's avatar
Wenzel Jakob committed
722
723
};

724
/// Wrapper for Python extension modules
Wenzel Jakob's avatar
Wenzel Jakob committed
725
726
class module : public object {
public:
727
    PYBIND11_OBJECT_DEFAULT(module, object, PyModule_Check)
Wenzel Jakob's avatar
Wenzel Jakob committed
728

729
    /// Create a new top-level Python module with the given name and docstring
730
    explicit module(const char *name, const char *doc = nullptr) {
731
        if (!options::show_user_defined_docstrings()) doc = nullptr;
732
#if PY_MAJOR_VERSION >= 3
Wenzel Jakob's avatar
Wenzel Jakob committed
733
        PyModuleDef *def = new PyModuleDef();
734
        std::memset(def, 0, sizeof(PyModuleDef));
Wenzel Jakob's avatar
Wenzel Jakob committed
735
736
737
738
739
        def->m_name = name;
        def->m_doc = doc;
        def->m_size = -1;
        Py_INCREF(def);
        m_ptr = PyModule_Create(def);
740
741
742
#else
        m_ptr = Py_InitModule3(name, nullptr, doc);
#endif
Wenzel Jakob's avatar
Wenzel Jakob committed
743
        if (m_ptr == nullptr)
744
            pybind11_fail("Internal error in module::module()");
Wenzel Jakob's avatar
Wenzel Jakob committed
745
746
747
        inc_ref();
    }

748
749
750
751
752
    /** \rst
        Create Python binding for a new function within the module scope. ``Func``
        can be a plain C++ function, a function pointer, or a lambda function. For
        details on the ``Extra&& ... extra`` argument, see section :ref:`extras`.
    \endrst */
753
    template <typename Func, typename... Extra>
Wenzel Jakob's avatar
Wenzel Jakob committed
754
    module &def(const char *name_, Func &&f, const Extra& ... extra) {
755
756
        cpp_function func(std::forward<Func>(f), name(name_), scope(*this),
                          sibling(getattr(*this, name_, none())), extra...);
757
758
759
        // NB: allow overwriting here because cpp_function sets up a chain with the intention of
        // overwriting (and has already checked internally that it isn't overwriting non-functions).
        add_object(name_, func, true /* overwrite */);
Wenzel Jakob's avatar
Wenzel Jakob committed
760
761
762
        return *this;
    }

763
764
765
766
767
768
769
770
771
772
    /** \rst
        Create and return a new Python submodule with the given name and docstring.
        This also works recursively, i.e.

        .. code-block:: cpp

            py::module m("example", "pybind11 example plugin");
            py::module m2 = m.def_submodule("sub", "A submodule of 'example'");
            py::module m3 = m2.def_submodule("subsub", "A submodule of 'example.sub'");
    \endrst */
773
    module def_submodule(const char *name, const char *doc = nullptr) {
Wenzel Jakob's avatar
Wenzel Jakob committed
774
775
        std::string full_name = std::string(PyModule_GetName(m_ptr))
            + std::string(".") + std::string(name);
776
        auto result = reinterpret_borrow<module>(PyImport_AddModule(full_name.c_str()));
777
        if (doc && options::show_user_defined_docstrings())
778
            result.attr("__doc__") = pybind11::str(doc);
Wenzel Jakob's avatar
Wenzel Jakob committed
779
780
781
        attr(name) = result;
        return result;
    }
Wenzel Jakob's avatar
Wenzel Jakob committed
782

783
    /// Import and return a module or throws `error_already_set`.
Wenzel Jakob's avatar
Wenzel Jakob committed
784
    static module import(const char *name) {
785
786
        PyObject *obj = PyImport_ImportModule(name);
        if (!obj)
787
            throw error_already_set();
788
        return reinterpret_steal<module>(obj);
Wenzel Jakob's avatar
Wenzel Jakob committed
789
    }
790
791
792
793
794
795

    // Adds an object to the module using the given name.  Throws if an object with the given name
    // already exists.
    //
    // overwrite should almost always be false: attempting to overwrite objects that pybind11 has
    // established will, in most cases, break things.
796
    PYBIND11_NOINLINE void add_object(const char *name, handle obj, bool overwrite = false) {
797
798
799
800
        if (!overwrite && hasattr(*this, name))
            pybind11_fail("Error during initialization: multiple incompatible definitions with name \"" +
                    std::string(name) + "\"");

801
        PyModule_AddObject(ptr(), name, obj.inc_ref().ptr() /* steals a reference */);
802
    }
Wenzel Jakob's avatar
Wenzel Jakob committed
803
804
};

805
/// \ingroup python_builtins
806
807
808
809
810
811
/// Return a dictionary representing the global variables in the current execution frame,
/// or ``__main__.__dict__`` if there is no frame (usually when the interpreter is embedded).
inline dict globals() {
    PyObject *p = PyEval_GetGlobals();
    return reinterpret_borrow<dict>(p ? p : module::import("__main__").attr("__dict__").ptr());
}
812

Wenzel Jakob's avatar
Wenzel Jakob committed
813
NAMESPACE_BEGIN(detail)
Wenzel Jakob's avatar
Wenzel Jakob committed
814
/// Generic support for creating new Python heap types
815
class generic_type : public object {
816
    template <typename...> friend class class_;
Wenzel Jakob's avatar
Wenzel Jakob committed
817
public:
818
    PYBIND11_OBJECT_DEFAULT(generic_type, object, PyType_Check)
Wenzel Jakob's avatar
Wenzel Jakob committed
819
protected:
820
821
822
823
    void initialize(const type_record &rec) {
        if (rec.scope && hasattr(rec.scope, rec.name))
            pybind11_fail("generic_type: cannot initialize type \"" + std::string(rec.name) +
                          "\": an object with that name is already defined");
824

825
826
        if (get_type_info(*rec.type))
            pybind11_fail("generic_type: type \"" + std::string(rec.name) +
827
828
                          "\" is already registered!");

829
        m_ptr = make_new_python_type(rec);
830
831

        /* Register supplemental type information in C++ dict */
832
833
        auto *tinfo = new detail::type_info();
        tinfo->type = (PyTypeObject *) m_ptr;
834
        tinfo->cpptype = rec.type;
835
        tinfo->type_size = rec.type_size;
836
        tinfo->operator_new = rec.operator_new;
837
        tinfo->holder_size_in_ptrs = size_in_ptrs(rec.holder_size);
838
        tinfo->init_instance = rec.init_instance;
839
        tinfo->dealloc = rec.dealloc;
840
841
        tinfo->simple_type = true;
        tinfo->simple_ancestors = true;
842
843
844

        auto &internals = get_internals();
        auto tindex = std::type_index(*rec.type);
845
        tinfo->direct_conversions = &internals.direct_conversions[tindex];
846
        tinfo->default_holder = rec.default_holder;
847
        internals.registered_types_cpp[tindex] = tinfo;
848
        internals.registered_types_py[(PyTypeObject *) m_ptr] = { tinfo };
Wenzel Jakob's avatar
Wenzel Jakob committed
849

850
        if (rec.bases.size() > 1 || rec.multiple_inheritance) {
851
            mark_parents_nonsimple(tinfo->type);
852
853
854
855
856
857
            tinfo->simple_ancestors = false;
        }
        else if (rec.bases.size() == 1) {
            auto parent_tinfo = get_type_info((PyTypeObject *) rec.bases[0].ptr());
            tinfo->simple_ancestors = parent_tinfo->simple_ancestors;
        }
Wenzel Jakob's avatar
Wenzel Jakob committed
858
859
    }

Wenzel Jakob's avatar
Wenzel Jakob committed
860
861
    /// Helper function which tags all parents of a type using mult. inheritance
    void mark_parents_nonsimple(PyTypeObject *value) {
862
        auto t = reinterpret_borrow<tuple>(value->tp_bases);
Wenzel Jakob's avatar
Wenzel Jakob committed
863
864
865
866
867
868
869
870
        for (handle h : t) {
            auto tinfo2 = get_type_info((PyTypeObject *) h.ptr());
            if (tinfo2)
                tinfo2->simple_type = false;
            mark_parents_nonsimple((PyTypeObject *) h.ptr());
        }
    }

Wenzel Jakob's avatar
Wenzel Jakob committed
871
872
873
    void install_buffer_funcs(
            buffer_info *(*get_buffer)(PyObject *, void *),
            void *get_buffer_data) {
Wenzel Jakob's avatar
Wenzel Jakob committed
874
        PyHeapTypeObject *type = (PyHeapTypeObject*) m_ptr;
875
        auto tinfo = detail::get_type_info(&type->ht_type);
Wenzel Jakob's avatar
Wenzel Jakob committed
876
877
878
879
880
881
882
883

        if (!type->ht_type.tp_as_buffer)
            pybind11_fail(
                "To be able to register buffer protocol support for the type '" +
                std::string(tinfo->type->tp_name) +
                "' the associated class<>(..) invocation must "
                "include the pybind11::buffer_protocol() annotation!");

884
885
        tinfo->get_buffer = get_buffer;
        tinfo->get_buffer_data = get_buffer_data;
Wenzel Jakob's avatar
Wenzel Jakob committed
886
887
    }

Wenzel Jakob's avatar
Wenzel Jakob committed
888
889
890
    void def_property_static_impl(const char *name,
                                  handle fget, handle fset,
                                  detail::function_record *rec_fget) {
891
892
893
894
895
896
897
898
899
        const auto is_static = !(rec_fget->is_method && rec_fget->scope);
        const auto has_doc = rec_fget->doc && pybind11::options::show_user_defined_docstrings();

        auto property = handle((PyObject *) (is_static ? get_internals().static_property_type
                                                       : &PyProperty_Type));
        attr(name) = property(fget.ptr() ? fget : none(),
                              fset.ptr() ? fset : none(),
                              /*deleter*/none(),
                              pybind11::str(has_doc ? rec_fget->doc : ""));
Wenzel Jakob's avatar
Wenzel Jakob committed
900
    }
Wenzel Jakob's avatar
Wenzel Jakob committed
901
};
902

903
904
905
906
907
908
/// Set the pointer to operator new if it exists. The cast is needed because it can be overloaded.
template <typename T, typename = void_t<decltype(static_cast<void *(*)(size_t)>(T::operator new))>>
void set_operator_new(type_record *r) { r->operator_new = &T::operator new; }

template <typename> void set_operator_new(...) { }

909
910
911
912
913
914
template <typename T, typename SFINAE = void> struct has_operator_delete : std::false_type { };
template <typename T> struct has_operator_delete<T, void_t<decltype(static_cast<void (*)(void *)>(T::operator delete))>>
    : std::true_type { };
template <typename T, typename SFINAE = void> struct has_operator_delete_size : std::false_type { };
template <typename T> struct has_operator_delete_size<T, void_t<decltype(static_cast<void (*)(void *, size_t)>(T::operator delete))>>
    : std::true_type { };
915
/// Call class-specific delete if it exists or global otherwise. Can also be an overload set.
916
917
918
919
template <typename T, enable_if_t<has_operator_delete<T>::value, int> = 0>
void call_operator_delete(T *p, size_t) { T::operator delete(p); }
template <typename T, enable_if_t<!has_operator_delete<T>::value && has_operator_delete_size<T>::value, int> = 0>
void call_operator_delete(T *p, size_t s) { T::operator delete(p, s); }
920

921
inline void call_operator_delete(void *p, size_t) { ::operator delete(p); }
922

Wenzel Jakob's avatar
Wenzel Jakob committed
923
924
NAMESPACE_END(detail)

925
926
927
928
929
930
931
932
933
934
935
/// Given a pointer to a member function, cast it to its `Derived` version.
/// Forward everything else unchanged.
template <typename /*Derived*/, typename F>
auto method_adaptor(F &&f) -> decltype(std::forward<F>(f)) { return std::forward<F>(f); }

template <typename Derived, typename Return, typename Class, typename... Args>
auto method_adaptor(Return (Class::*pmf)(Args...)) -> Return (Derived::*)(Args...) { return pmf; }

template <typename Derived, typename Return, typename Class, typename... Args>
auto method_adaptor(Return (Class::*pmf)(Args...) const) -> Return (Derived::*)(Args...) const { return pmf; }

936
template <typename type_, typename... options>
Wenzel Jakob's avatar
Wenzel Jakob committed
937
class class_ : public detail::generic_type {
938
    template <typename T> using is_holder = detail::is_holder_type<type_, T>;
939
940
    template <typename T> using is_subtype = detail::is_strict_base_of<type_, T>;
    template <typename T> using is_base = detail::is_strict_base_of<T, type_>;
941
942
943
    // struct instead of using here to help MSVC:
    template <typename T> struct is_valid_class_option :
        detail::any_of<is_holder<T>, is_subtype<T>, is_base<T>> {};
944

Wenzel Jakob's avatar
Wenzel Jakob committed
945
public:
946
    using type = type_;
947
    using type_alias = detail::exactly_one_t<is_subtype, void, options...>;
948
    constexpr static bool has_alias = !std::is_void<type_alias>::value;
949
    using holder_type = detail::exactly_one_t<is_holder, std::unique_ptr<type>, options...>;
950

951
    static_assert(detail::all_of<is_valid_class_option<options>...>::value,
952
            "Unknown/invalid class_ template parameters provided");
Wenzel Jakob's avatar
Wenzel Jakob committed
953

954
    PYBIND11_OBJECT(class_, generic_type, PyType_Check)
Wenzel Jakob's avatar
Wenzel Jakob committed
955

Wenzel Jakob's avatar
Wenzel Jakob committed
956
957
    template <typename... Extra>
    class_(handle scope, const char *name, const Extra &... extra) {
958
959
960
961
962
963
964
965
966
967
968
        using namespace detail;

        // MI can only be specified via class_ template options, not constructor parameters
        static_assert(
            none_of<is_pyobject<Extra>...>::value || // no base class arguments, or:
            (   constexpr_sum(is_pyobject<Extra>::value...) == 1 && // Exactly one base
                constexpr_sum(is_base<options>::value...)   == 0 && // no template option bases
                none_of<std::is_same<multiple_inheritance, Extra>...>::value), // no multiple_inheritance attr
            "Error: multiple inheritance bases must be specified via class_ template options");

        type_record record;
Wenzel Jakob's avatar
Wenzel Jakob committed
969
970
971
        record.scope = scope;
        record.name = name;
        record.type = &typeid(type);
972
        record.type_size = sizeof(conditional_t<has_alias, type_alias, type>);
973
        record.holder_size = sizeof(holder_type);
974
        record.init_instance = init_instance;
Wenzel Jakob's avatar
Wenzel Jakob committed
975
        record.dealloc = dealloc;
976
        record.default_holder = std::is_same<holder_type, std::unique_ptr<type>>::value;
Wenzel Jakob's avatar
Wenzel Jakob committed
977

978
979
        set_operator_new<type>(&record);

Wenzel Jakob's avatar
Wenzel Jakob committed
980
        /* Register base classes specified via template arguments to class_, if any */
981
        PYBIND11_EXPAND_SIDE_EFFECTS(add_base<options>(record));
982

Wenzel Jakob's avatar
Wenzel Jakob committed
983
        /* Process optional arguments, if any */
984
        process_attributes<Extra...>::init(extra..., &record);
Wenzel Jakob's avatar
Wenzel Jakob committed
985

986
        generic_type::initialize(record);
987

988
        if (has_alias) {
989
            auto &instances = get_internals().registered_types_cpp;
990
991
            instances[std::type_index(typeid(type_alias))] = instances[std::type_index(typeid(type))];
        }
Wenzel Jakob's avatar
Wenzel Jakob committed
992
    }
Wenzel Jakob's avatar
Wenzel Jakob committed
993

994
    template <typename Base, detail::enable_if_t<is_base<Base>::value, int> = 0>
Wenzel Jakob's avatar
Wenzel Jakob committed
995
    static void add_base(detail::type_record &rec) {
996
        rec.add_base(typeid(Base), [](void *src) -> void * {
Wenzel Jakob's avatar
Wenzel Jakob committed
997
998
999
1000
            return static_cast<Base *>(reinterpret_cast<type *>(src));
        });
    }

1001
    template <typename Base, detail::enable_if_t<!is_base<Base>::value, int> = 0>
Wenzel Jakob's avatar
Wenzel Jakob committed
1002
1003
    static void add_base(detail::type_record &) { }

1004
    template <typename Func, typename... Extra>
Wenzel Jakob's avatar
Wenzel Jakob committed
1005
    class_ &def(const char *name_, Func&& f, const Extra&... extra) {
1006
        cpp_function cf(method_adaptor<type>(std::forward<Func>(f)), name(name_), is_method(*this),
1007
                        sibling(getattr(*this, name_, none())), extra...);
1008
        attr(cf.name()) = cf;
Wenzel Jakob's avatar
Wenzel Jakob committed
1009
1010
1011
        return *this;
    }

1012
    template <typename Func, typename... Extra> class_ &
1013
1014
1015
    def_static(const char *name_, Func &&f, const Extra&... extra) {
        static_assert(!std::is_member_function_pointer<Func>::value,
                "def_static(...) called with a non-static member function pointer");
1016
1017
        cpp_function cf(std::forward<Func>(f), name(name_), scope(*this),
                        sibling(getattr(*this, name_, none())), extra...);
1018
        attr(cf.name()) = cf;
Wenzel Jakob's avatar
Wenzel Jakob committed
1019
1020
1021
        return *this;
    }

1022
    template <detail::op_id id, detail::op_type ot, typename L, typename R, typename... Extra>
Wenzel Jakob's avatar
Wenzel Jakob committed
1023
    class_ &def(const detail::op_<id, ot, L, R> &op, const Extra&... extra) {
1024
        op.execute(*this, extra...);
Wenzel Jakob's avatar
Wenzel Jakob committed
1025
1026
1027
        return *this;
    }

1028
    template <detail::op_id id, detail::op_type ot, typename L, typename R, typename... Extra>
Wenzel Jakob's avatar
Wenzel Jakob committed
1029
    class_ & def_cast(const detail::op_<id, ot, L, R> &op, const Extra&... extra) {
1030
        op.execute_cast(*this, extra...);
Wenzel Jakob's avatar
Wenzel Jakob committed
1031
1032
1033
        return *this;
    }

1034
    template <typename... Args, typename... Extra>
Wenzel Jakob's avatar
Wenzel Jakob committed
1035
    class_ &def(const detail::init<Args...> &init, const Extra&... extra) {
1036
        init.execute(*this, extra...);
Wenzel Jakob's avatar
Wenzel Jakob committed
1037
1038
1039
        return *this;
    }

1040
1041
    template <typename... Args, typename... Extra>
    class_ &def(const detail::init_alias<Args...> &init, const Extra&... extra) {
1042
        init.execute(*this, extra...);
1043
1044
1045
        return *this;
    }

1046
    template <typename Func> class_& def_buffer(Func &&func) {
Wenzel Jakob's avatar
Wenzel Jakob committed
1047
1048
1049
        struct capture { Func func; };
        capture *ptr = new capture { std::forward<Func>(func) };
        install_buffer_funcs([](PyObject *obj, void *ptr) -> buffer_info* {
1050
            detail::make_caster<type> caster;
Wenzel Jakob's avatar
Wenzel Jakob committed
1051
1052
            if (!caster.load(obj, false))
                return nullptr;
Wenzel Jakob's avatar
Wenzel Jakob committed
1053
1054
            return new buffer_info(((capture *) ptr)->func(caster));
        }, ptr);
Wenzel Jakob's avatar
Wenzel Jakob committed
1055
1056
1057
        return *this;
    }

1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
    template <typename Return, typename Class, typename... Args>
    class_ &def_buffer(Return (Class::*func)(Args...)) {
        return def_buffer([func] (type &obj) { return (obj.*func)(); });
    }

    template <typename Return, typename Class, typename... Args>
    class_ &def_buffer(Return (Class::*func)(Args...) const) {
        return def_buffer([func] (const type &obj) { return (obj.*func)(); });
    }

1068
    template <typename C, typename D, typename... Extra>
Wenzel Jakob's avatar
Wenzel Jakob committed
1069
    class_ &def_readwrite(const char *name, D C::*pm, const Extra&... extra) {
1070
1071
1072
        static_assert(std::is_base_of<C, type>::value, "def_readwrite() requires a class member (or base class member)");
        cpp_function fget([pm](const type &c) -> const D &{ return c.*pm; }, is_method(*this)),
                     fset([pm](type &c, const D &value) { c.*pm = value; }, is_method(*this));
1073
        def_property(name, fget, fset, return_value_policy::reference_internal, extra...);
Wenzel Jakob's avatar
Wenzel Jakob committed
1074
1075
1076
        return *this;
    }

1077
    template <typename C, typename D, typename... Extra>
Wenzel Jakob's avatar
Wenzel Jakob committed
1078
    class_ &def_readonly(const char *name, const D C::*pm, const Extra& ...extra) {
1079
1080
        static_assert(std::is_base_of<C, type>::value, "def_readonly() requires a class member (or base class member)");
        cpp_function fget([pm](const type &c) -> const D &{ return c.*pm; }, is_method(*this));
1081
        def_property_readonly(name, fget, return_value_policy::reference_internal, extra...);
Wenzel Jakob's avatar
Wenzel Jakob committed
1082
1083
1084
        return *this;
    }

1085
    template <typename D, typename... Extra>
Wenzel Jakob's avatar
Wenzel Jakob committed
1086
    class_ &def_readwrite_static(const char *name, D *pm, const Extra& ...extra) {
1087
1088
1089
        cpp_function fget([pm](object) -> const D &{ return *pm; }, scope(*this)),
                     fset([pm](object, const D &value) { *pm = value; }, scope(*this));
        def_property_static(name, fget, fset, return_value_policy::reference, extra...);
Wenzel Jakob's avatar
Wenzel Jakob committed
1090
1091
1092
        return *this;
    }

1093
    template <typename D, typename... Extra>
Wenzel Jakob's avatar
Wenzel Jakob committed
1094
    class_ &def_readonly_static(const char *name, const D *pm, const Extra& ...extra) {
1095
1096
        cpp_function fget([pm](object) -> const D &{ return *pm; }, scope(*this));
        def_property_readonly_static(name, fget, return_value_policy::reference, extra...);
Wenzel Jakob's avatar
Wenzel Jakob committed
1097
1098
1099
        return *this;
    }

1100
1101
1102
    /// Uses return_value_policy::reference_internal by default
    template <typename Getter, typename... Extra>
    class_ &def_property_readonly(const char *name, const Getter &fget, const Extra& ...extra) {
1103
1104
        return def_property_readonly(name, cpp_function(method_adaptor<type>(fget)),
                                     return_value_policy::reference_internal, extra...);
1105
1106
1107
    }

    /// Uses cpp_function's return_value_policy by default
1108
1109
    template <typename... Extra>
    class_ &def_property_readonly(const char *name, const cpp_function &fget, const Extra& ...extra) {
1110
1111
1112
1113
1114
1115
1116
        return def_property(name, fget, cpp_function(), extra...);
    }

    /// Uses return_value_policy::reference by default
    template <typename Getter, typename... Extra>
    class_ &def_property_readonly_static(const char *name, const Getter &fget, const Extra& ...extra) {
        return def_property_readonly_static(name, cpp_function(fget), return_value_policy::reference, extra...);
Wenzel Jakob's avatar
Wenzel Jakob committed
1117
1118
    }

1119
    /// Uses cpp_function's return_value_policy by default
1120
1121
    template <typename... Extra>
    class_ &def_property_readonly_static(const char *name, const cpp_function &fget, const Extra& ...extra) {
1122
1123
1124
1125
        return def_property_static(name, fget, cpp_function(), extra...);
    }

    /// Uses return_value_policy::reference_internal by default
1126
1127
1128
1129
    template <typename Getter, typename Setter, typename... Extra>
    class_ &def_property(const char *name, const Getter &fget, const Setter &fset, const Extra& ...extra) {
        return def_property(name, fget, cpp_function(method_adaptor<type>(fset)), extra...);
    }
1130
1131
    template <typename Getter, typename... Extra>
    class_ &def_property(const char *name, const Getter &fget, const cpp_function &fset, const Extra& ...extra) {
1132
1133
        return def_property(name, cpp_function(method_adaptor<type>(fget)), fset,
                            return_value_policy::reference_internal, extra...);
Wenzel Jakob's avatar
Wenzel Jakob committed
1134
1135
    }

1136
    /// Uses cpp_function's return_value_policy by default
1137
1138
    template <typename... Extra>
    class_ &def_property(const char *name, const cpp_function &fget, const cpp_function &fset, const Extra& ...extra) {
1139
        return def_property_static(name, fget, fset, is_method(*this), extra...);
Wenzel Jakob's avatar
Wenzel Jakob committed
1140
1141
    }

1142
1143
1144
1145
1146
1147
1148
    /// Uses return_value_policy::reference by default
    template <typename Getter, typename... Extra>
    class_ &def_property_static(const char *name, const Getter &fget, const cpp_function &fset, const Extra& ...extra) {
        return def_property_static(name, cpp_function(fget), fset, return_value_policy::reference, extra...);
    }

    /// Uses cpp_function's return_value_policy by default
1149
1150
1151
    template <typename... Extra>
    class_ &def_property_static(const char *name, const cpp_function &fget, const cpp_function &fset, const Extra& ...extra) {
        auto rec_fget = get_function_record(fget), rec_fset = get_function_record(fset);
1152
        char *doc_prev = rec_fget->doc; /* 'extra' field may include a property-specific documentation string */
1153
        detail::process_attributes<Extra...>::init(extra..., rec_fget);
1154
1155
1156
1157
1158
1159
        if (rec_fget->doc && rec_fget->doc != doc_prev) {
            free(doc_prev);
            rec_fget->doc = strdup(rec_fget->doc);
        }
        if (rec_fset) {
            doc_prev = rec_fset->doc;
1160
            detail::process_attributes<Extra...>::init(extra..., rec_fset);
1161
1162
1163
1164
1165
            if (rec_fset->doc && rec_fset->doc != doc_prev) {
                free(doc_prev);
                rec_fset->doc = strdup(rec_fset->doc);
            }
        }
Wenzel Jakob's avatar
Wenzel Jakob committed
1166
        def_property_static_impl(name, fget, fset, rec_fget);
Wenzel Jakob's avatar
Wenzel Jakob committed
1167
1168
        return *this;
    }
1169

Wenzel Jakob's avatar
Wenzel Jakob committed
1170
private:
1171
1172
    /// Initialize holder object, variant 1: object derives from enable_shared_from_this
    template <typename T>
1173
    static void init_holder(detail::instance *inst, detail::value_and_holder &v_h,
1174
            const holder_type * /* unused */, const std::enable_shared_from_this<T> * /* dummy */) {
1175
        try {
1176
1177
            auto sh = std::dynamic_pointer_cast<typename holder_type::element_type>(
                    v_h.value_ptr<type>()->shared_from_this());
1178
            if (sh) {
1179
1180
                new (&v_h.holder<holder_type>()) holder_type(std::move(sh));
                v_h.set_holder_constructed();
1181
            }
1182
        } catch (const std::bad_weak_ptr &) {}
1183
1184
1185
1186

        if (!v_h.holder_constructed() && inst->owned) {
            new (&v_h.holder<holder_type>()) holder_type(v_h.value_ptr<type>());
            v_h.set_holder_constructed();
1187
        }
1188
1189
    }

1190
1191
1192
    static void init_holder_from_existing(const detail::value_and_holder &v_h,
            const holder_type *holder_ptr, std::true_type /*is_copy_constructible*/) {
        new (&v_h.holder<holder_type>()) holder_type(*reinterpret_cast<const holder_type *>(holder_ptr));
1193
1194
    }

1195
1196
1197
    static void init_holder_from_existing(const detail::value_and_holder &v_h,
            const holder_type *holder_ptr, std::false_type /*is_copy_constructible*/) {
        new (&v_h.holder<holder_type>()) holder_type(std::move(*const_cast<holder_type *>(holder_ptr)));
1198
1199
    }

1200
    /// Initialize holder object, variant 2: try to construct from existing holder object, if possible
1201
    static void init_holder(detail::instance *inst, detail::value_and_holder &v_h,
1202
            const holder_type *holder_ptr, const void * /* dummy -- not enable_shared_from_this<T>) */) {
1203
        if (holder_ptr) {
1204
1205
            init_holder_from_existing(v_h, holder_ptr, std::is_copy_constructible<holder_type>());
            v_h.set_holder_constructed();
1206
        } else if (inst->owned || detail::always_construct_holder<holder_type>::value) {
1207
1208
            new (&v_h.holder<holder_type>()) holder_type(v_h.value_ptr<type>());
            v_h.set_holder_constructed();
1209
        }
1210
1211
    }

1212
1213
1214
1215
1216
    /// Performs instance initialization including constructing a holder and registering the known
    /// instance.  Should be called as soon as the `type` value_ptr is set for an instance.  Takes an
    /// optional pointer to an existing holder to use; if not specified and the instance is
    /// `.owned`, a new holder will be constructed to manage the value pointer.
    static void init_instance(detail::instance *inst, const void *holder_ptr) {
1217
        auto v_h = inst->get_value_and_holder(detail::get_type_info(typeid(type)));
1218
1219
1220
1221
        if (!v_h.instance_registered()) {
            register_instance(inst, v_h.value_ptr(), v_h.type);
            v_h.set_instance_registered();
        }
1222
        init_holder(inst, v_h, (const holder_type *) holder_ptr, v_h.value_ptr<type>());
1223
1224
    }

1225
1226
1227
1228
1229
    /// Deallocates an instance; via holder, if constructed; otherwise via operator delete.
    static void dealloc(const detail::value_and_holder &v_h) {
        if (v_h.holder_constructed())
            v_h.holder<holder_type>().~holder_type();
        else
1230
            detail::call_operator_delete(v_h.value_ptr<type>(), v_h.type->type_size);
Wenzel Jakob's avatar
Wenzel Jakob committed
1231
    }
1232
1233
1234

    static detail::function_record *get_function_record(handle h) {
        h = detail::get_function(h);
Wenzel Jakob's avatar
Wenzel Jakob committed
1235
        return h ? (detail::function_record *) reinterpret_borrow<capsule>(PyCFunction_GET_SELF(h.ptr()))
1236
                 : nullptr;
1237
    }
Wenzel Jakob's avatar
Wenzel Jakob committed
1238
1239
1240
1241
1242
};

/// Binds C++ enumerations and enumeration classes to Python
template <typename Type> class enum_ : public class_<Type> {
public:
1243
    using class_<Type>::def;
1244
    using class_<Type>::def_property_readonly_static;
1245
1246
    using Scalar = typename std::underlying_type<Type>::type;

Wenzel Jakob's avatar
Wenzel Jakob committed
1247
1248
    template <typename... Extra>
    enum_(const handle &scope, const char *name, const Extra&... extra)
1249
      : class_<Type>(scope, name, extra...), m_entries(), m_parent(scope) {
1250

1251
        constexpr bool is_arithmetic = detail::any_of<std::is_same<arithmetic, Extra>...>::value;
1252

1253
1254
1255
1256
1257
1258
1259
        auto m_entries_ptr = m_entries.inc_ref().ptr();
        def("__repr__", [name, m_entries_ptr](Type value) -> pybind11::str {
            for (const auto &kv : reinterpret_borrow<dict>(m_entries_ptr)) {
                if (pybind11::cast<Type>(kv.second) == value)
                    return pybind11::str("{}.{}").format(name, kv.first);
            }
            return pybind11::str("{}.???").format(name);
Wenzel Jakob's avatar
Wenzel Jakob committed
1260
        });
1261
1262
1263
1264
1265
1266
        def_property_readonly_static("__members__", [m_entries_ptr](object /* self */) {
            dict m;
            for (const auto &kv : reinterpret_borrow<dict>(m_entries_ptr))
                m[kv.first] = kv.second;
            return m;
        }, return_value_policy::copy);
1267
1268
        def("__init__", [](Type& value, Scalar i) { value = (Type)i; });
        def("__int__", [](Type value) { return (Scalar) value; });
1269
1270
1271
        #if PY_MAJOR_VERSION < 3
            def("__long__", [](Type value) { return (Scalar) value; });
        #endif
1272
1273
        def("__eq__", [](const Type &value, Type *value2) { return value2 && value == *value2; });
        def("__ne__", [](const Type &value, Type *value2) { return !value2 || value != *value2; });
1274
1275
1276
1277
1278
1279
1280
        if (is_arithmetic) {
            def("__lt__", [](const Type &value, Type *value2) { return value2 && value < *value2; });
            def("__gt__", [](const Type &value, Type *value2) { return value2 && value > *value2; });
            def("__le__", [](const Type &value, Type *value2) { return value2 && value <= *value2; });
            def("__ge__", [](const Type &value, Type *value2) { return value2 && value >= *value2; });
        }
        if (std::is_convertible<Type, Scalar>::value) {
1281
1282
            // Don't provide comparison with the underlying type if the enum isn't convertible,
            // i.e. if Type is a scoped enum, mirroring the C++ behaviour.  (NB: we explicitly
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
            // convert Type to Scalar below anyway because this needs to compile).
            def("__eq__", [](const Type &value, Scalar value2) { return (Scalar) value == value2; });
            def("__ne__", [](const Type &value, Scalar value2) { return (Scalar) value != value2; });
            if (is_arithmetic) {
                def("__lt__", [](const Type &value, Scalar value2) { return (Scalar) value < value2; });
                def("__gt__", [](const Type &value, Scalar value2) { return (Scalar) value > value2; });
                def("__le__", [](const Type &value, Scalar value2) { return (Scalar) value <= value2; });
                def("__ge__", [](const Type &value, Scalar value2) { return (Scalar) value >= value2; });
                def("__invert__", [](const Type &value) { return ~((Scalar) value); });
                def("__and__", [](const Type &value, Scalar value2) { return (Scalar) value & value2; });
                def("__or__", [](const Type &value, Scalar value2) { return (Scalar) value | value2; });
                def("__xor__", [](const Type &value, Scalar value2) { return (Scalar) value ^ value2; });
                def("__rand__", [](const Type &value, Scalar value2) { return (Scalar) value & value2; });
                def("__ror__", [](const Type &value, Scalar value2) { return (Scalar) value | value2; });
                def("__rxor__", [](const Type &value, Scalar value2) { return (Scalar) value ^ value2; });
                def("__and__", [](const Type &value, const Type &value2) { return (Scalar) value & (Scalar) value2; });
                def("__or__", [](const Type &value, const Type &value2) { return (Scalar) value | (Scalar) value2; });
                def("__xor__", [](const Type &value, const Type &value2) { return (Scalar) value ^ (Scalar) value2; });
            }
1302
        }
1303
        def("__hash__", [](const Type &value) { return (Scalar) value; });
Wenzel Jakob's avatar
Wenzel Jakob committed
1304
        // Pickling and unpickling -- needed for use with the 'multiprocessing' module
1305
1306
        def("__getstate__", [](const Type &value) { return pybind11::make_tuple((Scalar) value); });
        def("__setstate__", [](Type &p, tuple t) { new (&p) Type((Type) t[0].cast<Scalar>()); });
Wenzel Jakob's avatar
Wenzel Jakob committed
1307
1308
1309
    }

    /// Export enumeration entries into the parent scope
1310
1311
1312
    enum_& export_values() {
        for (const auto &kv : m_entries)
            m_parent.attr(kv.first) = kv.second;
1313
        return *this;
Wenzel Jakob's avatar
Wenzel Jakob committed
1314
1315
1316
1317
    }

    /// Add an enumeration entry
    enum_& value(char const* name, Type value) {
1318
1319
1320
        auto v = pybind11::cast(value, return_value_policy::copy);
        this->attr(name) = v;
        m_entries[pybind11::str(name)] = v;
Wenzel Jakob's avatar
Wenzel Jakob committed
1321
1322
        return *this;
    }
1323

Wenzel Jakob's avatar
Wenzel Jakob committed
1324
private:
1325
    dict m_entries;
Wenzel Jakob's avatar
Wenzel Jakob committed
1326
    handle m_parent;
Wenzel Jakob's avatar
Wenzel Jakob committed
1327
1328
1329
};

NAMESPACE_BEGIN(detail)
1330
template <typename... Args> struct init {
1331
1332
    template <typename Class, typename... Extra, enable_if_t<!Class::has_alias, int> = 0>
    static void execute(Class &cl, const Extra&... extra) {
1333
        using Base = typename Class::type;
Wenzel Jakob's avatar
Wenzel Jakob committed
1334
        /// Function which calls a specific C++ in-place constructor
1335
        cl.def("__init__", [](Base *self_, Args... args) { new (self_) Base(args...); }, extra...);
1336
1337
    }

1338
    template <typename Class, typename... Extra,
1339
1340
1341
              enable_if_t<Class::has_alias &&
                          std::is_constructible<typename Class::type, Args...>::value, int> = 0>
    static void execute(Class &cl, const Extra&... extra) {
1342
1343
1344
1345
        using Base = typename Class::type;
        using Alias = typename Class::type_alias;
        handle cl_type = cl;
        cl.def("__init__", [cl_type](handle self_, Args... args) {
1346
                if (self_.get_type().is(cl_type))
1347
                    new (self_.cast<Base *>()) Base(args...);
1348
                else
1349
                    new (self_.cast<Alias *>()) Alias(args...);
1350
1351
1352
            }, extra...);
    }

1353
    template <typename Class, typename... Extra,
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
              enable_if_t<Class::has_alias &&
                          !std::is_constructible<typename Class::type, Args...>::value, int> = 0>
    static void execute(Class &cl, const Extra&... extra) {
        init_alias<Args...>::execute(cl, extra...);
    }
};
template <typename... Args> struct init_alias {
    template <typename Class, typename... Extra,
              enable_if_t<Class::has_alias && std::is_constructible<typename Class::type_alias, Args...>::value, int> = 0>
    static void execute(Class &cl, const Extra&... extra) {
1364
1365
        using Alias = typename Class::type_alias;
        cl.def("__init__", [](Alias *self_, Args... args) { new (self_) Alias(args...); }, extra...);
Wenzel Jakob's avatar
Wenzel Jakob committed
1366
1367
    }
};
1368

1369

1370
inline void keep_alive_impl(handle nurse, handle patient) {
1371
    if (!nurse || !patient)
1372
        pybind11_fail("Could not activate keep_alive!");
1373

1374
    if (patient.is_none() || nurse.is_none())
1375
        return; /* Nothing to keep alive or nothing to be kept alive by */
1376

1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
    auto tinfo = all_type_info(Py_TYPE(nurse.ptr()));
    if (!tinfo.empty()) {
        /* It's a pybind-registered type, so we can store the patient in the
         * internal list. */
        add_patient(nurse.ptr(), patient.ptr());
    }
    else {
        /* Fall back to clever approach based on weak references taken from
         * Boost.Python. This is not used for pybind-registered types because
         * the objects can be destroyed out-of-order in a GC pass. */
        cpp_function disable_lifesupport(
            [patient](handle weakref) { patient.dec_ref(); weakref.dec_ref(); });
1389

1390
        weakref wr(nurse, disable_lifesupport);
1391

1392
1393
1394
        patient.inc_ref(); /* reference patient and leak the weak reference */
        (void) wr.release();
    }
1395
1396
}

1397
PYBIND11_NOINLINE inline void keep_alive_impl(size_t Nurse, size_t Patient, function_call &call, handle ret) {
1398
    keep_alive_impl(
1399
1400
        Nurse   == 0 ? ret : Nurse   <= call.args.size() ? call.args[Nurse   - 1] : handle(),
        Patient == 0 ? ret : Patient <= call.args.size() ? call.args[Patient - 1] : handle()
1401
    );
1402
1403
}

1404
1405
inline std::pair<decltype(internals::registered_types_py)::iterator, bool> all_type_info_get_cache(PyTypeObject *type) {
    auto res = get_internals().registered_types_py
Jason Rhinelander's avatar
Jason Rhinelander committed
1406
#ifdef __cpp_lib_unordered_map_try_emplace
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
        .try_emplace(type);
#else
        .emplace(type, std::vector<detail::type_info *>());
#endif
    if (res.second) {
        // New cache entry created; set up a weak reference to automatically remove it if the type
        // gets destroyed:
        weakref((PyObject *) type, cpp_function([type](handle wr) {
            get_internals().registered_types_py.erase(type);
            wr.dec_ref();
        })).release();
    }

    return res;
}

1423
template <typename Iterator, typename Sentinel, bool KeyIterator, return_value_policy Policy>
1424
1425
1426
struct iterator_state {
    Iterator it;
    Sentinel end;
1427
    bool first_or_done;
1428
};
1429

Wenzel Jakob's avatar
Wenzel Jakob committed
1430
1431
NAMESPACE_END(detail)

1432
template <typename... Args> detail::init<Args...> init() { return detail::init<Args...>(); }
1433
template <typename... Args> detail::init_alias<Args...> init_alias() { return detail::init_alias<Args...>(); }
Wenzel Jakob's avatar
Wenzel Jakob committed
1434

1435
/// Makes a python iterator from a first and past-the-end C++ InputIterator.
1436
1437
template <return_value_policy Policy = return_value_policy::reference_internal,
          typename Iterator,
1438
          typename Sentinel,
1439
1440
          typename ValueType = decltype(*std::declval<Iterator>()),
          typename... Extra>
1441
iterator make_iterator(Iterator first, Sentinel last, Extra &&... extra) {
1442
    typedef detail::iterator_state<Iterator, Sentinel, false, Policy> state;
1443

Wenzel Jakob's avatar
Wenzel Jakob committed
1444
    if (!detail::get_type_info(typeid(state), false)) {
1445
        class_<state>(handle(), "iterator")
1446
            .def("__iter__", [](state &s) -> state& { return s; })
1447
            .def("__next__", [](state &s) -> ValueType {
1448
                if (!s.first_or_done)
1449
1450
                    ++s.it;
                else
1451
1452
1453
                    s.first_or_done = false;
                if (s.it == s.end) {
                    s.first_or_done = true;
1454
                    throw stop_iteration();
1455
                }
1456
                return *s.it;
1457
            }, std::forward<Extra>(extra)..., Policy);
1458
1459
    }

1460
    return cast(state{first, last, true});
1461
}
1462

1463
1464
/// Makes an python iterator over the keys (`.first`) of a iterator over pairs from a
/// first and past-the-end InputIterator.
1465
1466
template <return_value_policy Policy = return_value_policy::reference_internal,
          typename Iterator,
1467
          typename Sentinel,
1468
          typename KeyType = decltype((*std::declval<Iterator>()).first),
1469
          typename... Extra>
1470
iterator make_key_iterator(Iterator first, Sentinel last, Extra &&... extra) {
1471
    typedef detail::iterator_state<Iterator, Sentinel, true, Policy> state;
1472

Wenzel Jakob's avatar
Wenzel Jakob committed
1473
    if (!detail::get_type_info(typeid(state), false)) {
1474
        class_<state>(handle(), "iterator")
1475
1476
            .def("__iter__", [](state &s) -> state& { return s; })
            .def("__next__", [](state &s) -> KeyType {
1477
                if (!s.first_or_done)
1478
1479
                    ++s.it;
                else
1480
1481
1482
                    s.first_or_done = false;
                if (s.it == s.end) {
                    s.first_or_done = true;
1483
                    throw stop_iteration();
1484
                }
1485
                return (*s.it).first;
1486
            }, std::forward<Extra>(extra)..., Policy);
1487
1488
    }

1489
    return cast(state{first, last, true});
1490
}
1491

1492
1493
/// Makes an iterator over values of an stl container or other container supporting
/// `std::begin()`/`std::end()`
1494
1495
1496
template <return_value_policy Policy = return_value_policy::reference_internal,
          typename Type, typename... Extra> iterator make_iterator(Type &value, Extra&&... extra) {
    return make_iterator<Policy>(std::begin(value), std::end(value), extra...);
1497
1498
}

1499
1500
/// Makes an iterator over the keys (`.first`) of a stl map-like container supporting
/// `std::begin()`/`std::end()`
1501
1502
1503
template <return_value_policy Policy = return_value_policy::reference_internal,
          typename Type, typename... Extra> iterator make_key_iterator(Type &value, Extra&&... extra) {
    return make_key_iterator<Policy>(std::begin(value), std::end(value), extra...);
1504
1505
}

Wenzel Jakob's avatar
Wenzel Jakob committed
1506
template <typename InputType, typename OutputType> void implicitly_convertible() {
1507
    auto implicit_caster = [](PyObject *obj, PyTypeObject *type) -> PyObject * {
1508
        if (!detail::make_caster<InputType>().load(obj, false))
Wenzel Jakob's avatar
Wenzel Jakob committed
1509
1510
1511
1512
1513
1514
1515
1516
            return nullptr;
        tuple args(1);
        args[0] = obj;
        PyObject *result = PyObject_Call((PyObject *) type, args.ptr(), nullptr);
        if (result == nullptr)
            PyErr_Clear();
        return result;
    };
1517
1518
1519
1520

    if (auto tinfo = detail::get_type_info(typeid(OutputType)))
        tinfo->implicit_conversions.push_back(implicit_caster);
    else
1521
        pybind11_fail("implicitly_convertible: Unable to find type " + type_id<OutputType>());
Wenzel Jakob's avatar
Wenzel Jakob committed
1522
1523
}

1524
1525
1526
1527
1528
1529
template <typename ExceptionTranslator>
void register_exception_translator(ExceptionTranslator&& translator) {
    detail::get_internals().registered_exception_translators.push_front(
        std::forward<ExceptionTranslator>(translator));
}

1530
1531
/**
 * Wrapper to generate a new Python exception type.
1532
1533
1534
1535
1536
1537
1538
1539
 *
 * This should only be used with PyErr_SetString for now.
 * It is not (yet) possible to use as a py::base.
 * Template type argument is reserved for future use.
 */
template <typename type>
class exception : public object {
public:
1540
1541
1542
    exception(handle scope, const char *name, PyObject *base = PyExc_Exception) {
        std::string full_name = scope.attr("__name__").cast<std::string>() +
                                std::string(".") + name;
1543
        m_ptr = PyErr_NewException(const_cast<char *>(full_name.c_str()), base, NULL);
1544
1545
1546
1547
        if (hasattr(scope, name))
            pybind11_fail("Error during initialization: multiple incompatible "
                          "definitions with name \"" + std::string(name) + "\"");
        scope.attr(name) = *this;
1548
    }
1549
1550
1551
1552
1553

    // Sets the current python exception to this exception object with the given message
    void operator()(const char *message) {
        PyErr_SetString(m_ptr, message);
    }
1554
1555
};

1556
1557
/**
 * Registers a Python exception in `m` of the given `name` and installs an exception translator to
1558
1559
1560
1561
 * translate the C++ exception to the created Python exception using the exceptions what() method.
 * This is intended for simple exception translations; for more complex translation, register the
 * exception object and translator directly.
 */
1562
1563
1564
1565
1566
template <typename CppException>
exception<CppException> &register_exception(handle scope,
                                            const char *name,
                                            PyObject *base = PyExc_Exception) {
    static exception<CppException> ex(scope, name, base);
1567
1568
1569
1570
    register_exception_translator([](std::exception_ptr p) {
        if (!p) return;
        try {
            std::rethrow_exception(p);
1571
        } catch (const CppException &e) {
1572
1573
1574
1575
1576
1577
            ex(e.what());
        }
    });
    return ex;
}

Dean Moldovan's avatar
Dean Moldovan committed
1578
1579
1580
1581
NAMESPACE_BEGIN(detail)
PYBIND11_NOINLINE inline void print(tuple args, dict kwargs) {
    auto strings = tuple(args.size());
    for (size_t i = 0; i < args.size(); ++i) {
1582
        strings[i] = str(args[i]);
Dean Moldovan's avatar
Dean Moldovan committed
1583
    }
1584
    auto sep = kwargs.contains("sep") ? kwargs["sep"] : cast(" ");
1585
    auto line = sep.attr("join")(strings);
Dean Moldovan's avatar
Dean Moldovan committed
1586

1587
1588
1589
1590
1591
1592
    object file;
    if (kwargs.contains("file")) {
        file = kwargs["file"].cast<object>();
    } else {
        try {
            file = module::import("sys").attr("stdout");
1593
        } catch (const error_already_set &) {
1594
1595
1596
1597
1598
1599
1600
1601
            /* If print() is called from code that is executed as
               part of garbage collection during interpreter shutdown,
               importing 'sys' can fail. Give up rather than crashing the
               interpreter in this case. */
            return;
        }
    }

1602
    auto write = file.attr("write");
Dean Moldovan's avatar
Dean Moldovan committed
1603
    write(line);
1604
    write(kwargs.contains("end") ? kwargs["end"] : cast("\n"));
Dean Moldovan's avatar
Dean Moldovan committed
1605

1606
    if (kwargs.contains("flush") && kwargs["flush"].cast<bool>())
1607
        file.attr("flush")();
Dean Moldovan's avatar
Dean Moldovan committed
1608
1609
1610
1611
1612
1613
1614
1615
1616
}
NAMESPACE_END(detail)

template <return_value_policy policy = return_value_policy::automatic_reference, typename... Args>
void print(Args &&...args) {
    auto c = detail::collect_arguments<policy>(std::forward<Args>(args)...);
    detail::print(c.args(), c.kwargs());
}

Wenzel Jakob's avatar
Wenzel Jakob committed
1617
#if defined(WITH_THREAD) && !defined(PYPY_VERSION)
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631

/* The functions below essentially reproduce the PyGILState_* API using a RAII
 * pattern, but there are a few important differences:
 *
 * 1. When acquiring the GIL from an non-main thread during the finalization
 *    phase, the GILState API blindly terminates the calling thread, which
 *    is often not what is wanted. This API does not do this.
 *
 * 2. The gil_scoped_release function can optionally cut the relationship
 *    of a PyThreadState and its associated thread, which allows moving it to
 *    another thread (this is a fairly rare/advanced use case).
 *
 * 3. The reference count of an acquired thread state can be controlled. This
 *    can be handy to prevent cases where callbacks issued from an external
1632
1633
 *    thread would otherwise constantly construct and destroy thread state data
 *    structures.
1634
1635
1636
1637
1638
 *
 * See the Python bindings of NanoGUI (http://github.com/wjakob/nanogui) for an
 * example which uses features 2 and 3 to migrate the Python thread of
 * execution to another thread (to run the event loop on the original thread,
 * in this case).
1639
 */
Wenzel Jakob's avatar
Wenzel Jakob committed
1640
1641
1642

class gil_scoped_acquire {
public:
1643
    PYBIND11_NOINLINE gil_scoped_acquire() {
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
        auto const &internals = detail::get_internals();
        tstate = (PyThreadState *) PyThread_get_key_value(internals.tstate);

        if (!tstate) {
            tstate = PyThreadState_New(internals.istate);
            #if !defined(NDEBUG)
                if (!tstate)
                    pybind11_fail("scoped_acquire: could not create thread state!");
            #endif
            tstate->gilstate_counter = 0;
1654
1655
1656
            #if PY_MAJOR_VERSION < 3
                PyThread_delete_key_value(internals.tstate);
            #endif
1657
1658
            PyThread_set_key_value(internals.tstate, tstate);
        } else {
1659
            release = detail::get_thread_state_unchecked() != tstate;
1660
1661
1662
1663
        }

        if (release) {
            /* Work around an annoying assertion in PyThreadState_Swap */
1664
1665
1666
1667
            #if defined(Py_DEBUG)
                PyInterpreterState *interp = tstate->interp;
                tstate->interp = nullptr;
            #endif
1668
            PyEval_AcquireThread(tstate);
1669
1670
1671
            #if defined(Py_DEBUG)
                tstate->interp = interp;
            #endif
1672
1673
1674
1675
1676
1677
1678
1679
1680
        }

        inc_ref();
    }

    void inc_ref() {
        ++tstate->gilstate_counter;
    }

1681
    PYBIND11_NOINLINE void dec_ref() {
1682
1683
        --tstate->gilstate_counter;
        #if !defined(NDEBUG)
1684
            if (detail::get_thread_state_unchecked() != tstate)
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
                pybind11_fail("scoped_acquire::dec_ref(): thread state must be current!");
            if (tstate->gilstate_counter < 0)
                pybind11_fail("scoped_acquire::dec_ref(): reference count underflow!");
        #endif
        if (tstate->gilstate_counter == 0) {
            #if !defined(NDEBUG)
                if (!release)
                    pybind11_fail("scoped_acquire::dec_ref(): internal error!");
            #endif
            PyThreadState_Clear(tstate);
            PyThreadState_DeleteCurrent();
1696
            PyThread_delete_key_value(detail::get_internals().tstate);
1697
1698
1699
1700
            release = false;
        }
    }

1701
    PYBIND11_NOINLINE ~gil_scoped_acquire() {
1702
1703
1704
1705
1706
1707
1708
        dec_ref();
        if (release)
           PyEval_SaveThread();
    }
private:
    PyThreadState *tstate = nullptr;
    bool release = true;
Wenzel Jakob's avatar
Wenzel Jakob committed
1709
1710
1711
1712
};

class gil_scoped_release {
public:
1713
    explicit gil_scoped_release(bool disassoc = false) : disassoc(disassoc) {
1714
1715
1716
1717
        // `get_internals()` must be called here unconditionally in order to initialize
        // `internals.tstate` for subsequent `gil_scoped_acquire` calls. Otherwise, an
        // initialization race could occur as multiple threads try `gil_scoped_acquire`.
        const auto &internals = detail::get_internals();
1718
        tstate = PyEval_SaveThread();
1719
        if (disassoc) {
1720
            auto key = internals.tstate;
1721
1722
1723
1724
1725
1726
            #if PY_MAJOR_VERSION < 3
                PyThread_delete_key_value(key);
            #else
                PyThread_set_key_value(key, nullptr);
            #endif
        }
1727
1728
1729
1730
1731
    }
    ~gil_scoped_release() {
        if (!tstate)
            return;
        PyEval_RestoreThread(tstate);
1732
        if (disassoc) {
1733
            auto key = detail::get_internals().tstate;
1734
1735
1736
1737
1738
            #if PY_MAJOR_VERSION < 3
                PyThread_delete_key_value(key);
            #endif
            PyThread_set_key_value(key, tstate);
        }
1739
1740
1741
1742
    }
private:
    PyThreadState *tstate;
    bool disassoc;
Wenzel Jakob's avatar
Wenzel Jakob committed
1743
};
Wenzel Jakob's avatar
Wenzel Jakob committed
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
#elif defined(PYPY_VERSION)
class gil_scoped_acquire {
    PyGILState_STATE state;
public:
    gil_scoped_acquire() { state = PyGILState_Ensure(); }
    ~gil_scoped_acquire() { PyGILState_Release(state); }
};

class gil_scoped_release {
    PyThreadState *state;
public:
    gil_scoped_release() { state = PyEval_SaveThread(); }
    ~gil_scoped_release() { PyEval_RestoreThread(state); }
};
1758
1759
1760
#else
class gil_scoped_acquire { };
class gil_scoped_release { };
1761
#endif
Wenzel Jakob's avatar
Wenzel Jakob committed
1762

1763
error_already_set::~error_already_set() {
Jason Rhinelander's avatar
Jason Rhinelander committed
1764
    if (type) {
1765
        gil_scoped_acquire gil;
Jason Rhinelander's avatar
Jason Rhinelander committed
1766
1767
1768
        type.release().dec_ref();
        value.release().dec_ref();
        trace.release().dec_ref();
1769
1770
1771
    }
}

1772
inline function get_type_overload(const void *this_ptr, const detail::type_info *this_type, const char *name)  {
Wenzel Jakob's avatar
Wenzel Jakob committed
1773
1774
    handle self = detail::get_object_handle(this_ptr, this_type);
    if (!self)
1775
        return function();
Wenzel Jakob's avatar
Wenzel Jakob committed
1776
    handle type = self.get_type();
1777
1778
    auto key = std::make_pair(type.ptr(), name);

1779
1780
    /* Cache functions that aren't overloaded in Python to avoid
       many costly Python dictionary lookups below */
1781
1782
1783
1784
    auto &cache = detail::get_internals().inactive_overload_cache;
    if (cache.find(key) != cache.end())
        return function();

Wenzel Jakob's avatar
Wenzel Jakob committed
1785
    function overload = getattr(self, name, function());
1786
1787
1788
1789
    if (overload.is_cpp_function()) {
        cache.insert(key);
        return function();
    }
1790

Wenzel Jakob's avatar
Wenzel Jakob committed
1791
1792
1793
    /* Don't call dispatch code if invoked from overridden function.
       Unfortunately this doesn't work on PyPy. */
#if !defined(PYPY_VERSION)
1794
    PyFrameObject *frame = PyThreadState_Get()->frame;
1795
    if (frame && (std::string) str(frame->f_code->co_name) == name &&
1796
1797
1798
1799
        frame->f_code->co_argcount > 0) {
        PyFrame_FastToLocals(frame);
        PyObject *self_caller = PyDict_GetItem(
            frame->f_locals, PyTuple_GET_ITEM(frame->f_code->co_varnames, 0));
Wenzel Jakob's avatar
Wenzel Jakob committed
1800
        if (self_caller == self.ptr())
1801
1802
            return function();
    }
Wenzel Jakob's avatar
Wenzel Jakob committed
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
#else
    /* PyPy currently doesn't provide a detailed cpyext emulation of
       frame objects, so we have to emulate this using Python. This
       is going to be slow..*/
    dict d; d["self"] = self; d["name"] = pybind11::str(name);
    PyObject *result = PyRun_String(
        "import inspect\n"
        "frame = inspect.currentframe()\n"
        "if frame is not None:\n"
        "    frame = frame.f_back\n"
        "    if frame is not None and str(frame.f_code.co_name) == name and "
        "frame.f_code.co_argcount > 0:\n"
        "        self_caller = frame.f_locals[frame.f_code.co_varnames[0]]\n"
        "        if self_caller == self:\n"
        "            self = None\n",
        Py_file_input, d.ptr(), d.ptr());
    if (result == nullptr)
        throw error_already_set();
1821
    if (d["self"].is_none())
Wenzel Jakob's avatar
Wenzel Jakob committed
1822
1823
1824
1825
        return function();
    Py_DECREF(result);
#endif

1826
1827
1828
    return overload;
}

1829
template <class T> function get_overload(const T *this_ptr, const char *name) {
1830
1831
    auto tinfo = detail::get_type_info(typeid(T));
    return tinfo ? get_type_overload(this_ptr, tinfo, name) : function();
1832
1833
}

1834
#define PYBIND11_OVERLOAD_INT(ret_type, cname, name, ...) { \
1835
        pybind11::gil_scoped_acquire gil; \
1836
        pybind11::function overload = pybind11::get_overload(static_cast<const cname *>(this), name); \
1837
        if (overload) { \
1838
            auto o = overload(__VA_ARGS__); \
1839
            if (pybind11::detail::cast_is_temporary_value_reference<ret_type>::value) { \
1840
1841
                static pybind11::detail::overload_caster_t<ret_type> caster; \
                return pybind11::detail::cast_ref<ret_type>(std::move(o), caster); \
1842
1843
1844
1845
            } \
            else return pybind11::detail::cast_safe<ret_type>(std::move(o)); \
        } \
    }
1846

1847
#define PYBIND11_OVERLOAD_NAME(ret_type, cname, name, fn, ...) \
1848
    PYBIND11_OVERLOAD_INT(ret_type, cname, name, __VA_ARGS__) \
1849
    return cname::fn(__VA_ARGS__)
1850

1851
#define PYBIND11_OVERLOAD_PURE_NAME(ret_type, cname, name, fn, ...) \
1852
    PYBIND11_OVERLOAD_INT(ret_type, cname, name, __VA_ARGS__) \
1853
1854
1855
1856
1857
1858
1859
    pybind11::pybind11_fail("Tried to call pure virtual function \"" #cname "::" name "\"");

#define PYBIND11_OVERLOAD(ret_type, cname, fn, ...) \
    PYBIND11_OVERLOAD_NAME(ret_type, cname, #fn, fn, __VA_ARGS__)

#define PYBIND11_OVERLOAD_PURE(ret_type, cname, fn, ...) \
    PYBIND11_OVERLOAD_PURE_NAME(ret_type, cname, #fn, fn, __VA_ARGS__)
1860

1861
NAMESPACE_END(pybind11)
Wenzel Jakob's avatar
Wenzel Jakob committed
1862
1863

#if defined(_MSC_VER)
Wenzel Jakob's avatar
Wenzel Jakob committed
1864
#  pragma warning(pop)
1865
1866
#elif defined(__INTEL_COMPILER)
/* Leave ignored warnings on */
1867
#elif defined(__GNUG__) && !defined(__clang__)
Wenzel Jakob's avatar
Wenzel Jakob committed
1868
#  pragma GCC diagnostic pop
Wenzel Jakob's avatar
Wenzel Jakob committed
1869
#endif