cast.h 57.2 KB
Newer Older
Wenzel Jakob's avatar
Wenzel Jakob committed
1
/*
2
    pybind11/cast.h: Partial template specializations to cast between
Wenzel Jakob's avatar
Wenzel Jakob committed
3
4
    C++ and Python types

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
14
#include "pytypes.h"
#include "typeid.h"
15
#include "descr.h"
Wenzel Jakob's avatar
Wenzel Jakob committed
16
#include <array>
Wenzel Jakob's avatar
Wenzel Jakob committed
17
#include <limits>
Wenzel Jakob's avatar
Wenzel Jakob committed
18

19
NAMESPACE_BEGIN(pybind11)
Wenzel Jakob's avatar
Wenzel Jakob committed
20
21
NAMESPACE_BEGIN(detail)

Wenzel Jakob's avatar
Wenzel Jakob committed
22
23
24
25
26
/// Additional type information which does not fit into the PyTypeObject
struct type_info {
    PyTypeObject *type;
    size_t type_size;
    void (*init_holder)(PyObject *, const void *);
Wenzel Jakob's avatar
Wenzel Jakob committed
27
28
    std::vector<PyObject *(*)(PyObject *, PyTypeObject *)> implicit_conversions;
    std::vector<std::pair<const std::type_info *, void *(*)(void *)>> implicit_casts;
29
    std::vector<bool (*)(PyObject *, void *&)> *direct_conversions;
Wenzel Jakob's avatar
Wenzel Jakob committed
30
31
    buffer_info *(*get_buffer)(PyObject *, void *) = nullptr;
    void *get_buffer_data = nullptr;
Wenzel Jakob's avatar
Wenzel Jakob committed
32
33
34
    /** A simple type never occurs as a (direct or indirect) parent
     * of a class that makes use of multiple inheritance */
    bool simple_type = true;
35
36
    /* for base vs derived holder_type checks */
    bool default_holder = true;
Wenzel Jakob's avatar
Wenzel Jakob committed
37
};
38

Wenzel Jakob's avatar
Wenzel Jakob committed
39
40
41
42
43
PYBIND11_NOINLINE inline internals &get_internals() {
    static internals *internals_ptr = nullptr;
    if (internals_ptr)
        return *internals_ptr;
    handle builtins(PyEval_GetBuiltins());
44
    const char *id = PYBIND11_INTERNALS_ID;
45
46
    if (builtins.contains(id) && isinstance<capsule>(builtins[id])) {
        internals_ptr = capsule(builtins[id]);
Wenzel Jakob's avatar
Wenzel Jakob committed
47
48
    } else {
        internals_ptr = new internals();
49
50
51
52
53
54
55
        #if defined(WITH_THREAD)
            PyEval_InitThreads();
            PyThreadState *tstate = PyThreadState_Get();
            internals_ptr->tstate = PyThread_create_key();
            PyThread_set_key_value(internals_ptr->tstate, tstate);
            internals_ptr->istate = tstate->interp;
        #endif
56
        builtins[id] = capsule(internals_ptr);
57
58
59
60
        internals_ptr->registered_exception_translators.push_front(
            [](std::exception_ptr p) -> void {
                try {
                    if (p) std::rethrow_exception(p);
61
                } catch (error_already_set &e)           { e.restore();                                    return;
62
                } catch (const builtin_exception &e)     { e.set_error();                                  return;
63
64
65
66
67
68
69
70
71
72
73
74
75
                } catch (const std::bad_alloc &e)        { PyErr_SetString(PyExc_MemoryError,   e.what()); return;
                } catch (const std::domain_error &e)     { PyErr_SetString(PyExc_ValueError,    e.what()); return;
                } catch (const std::invalid_argument &e) { PyErr_SetString(PyExc_ValueError,    e.what()); return;
                } catch (const std::length_error &e)     { PyErr_SetString(PyExc_ValueError,    e.what()); return;
                } catch (const std::out_of_range &e)     { PyErr_SetString(PyExc_IndexError,    e.what()); return;
                } catch (const std::range_error &e)      { PyErr_SetString(PyExc_ValueError,    e.what()); return;
                } catch (const std::exception &e)        { PyErr_SetString(PyExc_RuntimeError,  e.what()); return;
                } catch (...) {
                    PyErr_SetString(PyExc_RuntimeError, "Caught an unknown exception!");
                    return;
                }
            }
        );
Wenzel Jakob's avatar
Wenzel Jakob committed
76
77
78
79
    }
    return *internals_ptr;
}

Wenzel Jakob's avatar
Wenzel Jakob committed
80
PYBIND11_NOINLINE inline detail::type_info* get_type_info(PyTypeObject *type) {
Wenzel Jakob's avatar
Wenzel Jakob committed
81
82
83
84
85
86
    auto const &type_dict = get_internals().registered_types_py;
    do {
        auto it = type_dict.find(type);
        if (it != type_dict.end())
            return (detail::type_info *) it->second;
        type = type->tp_base;
Wenzel Jakob's avatar
Wenzel Jakob committed
87
        if (!type)
88
            return nullptr;
Wenzel Jakob's avatar
Wenzel Jakob committed
89
90
91
    } while (true);
}

92
93
PYBIND11_NOINLINE inline detail::type_info *get_type_info(const std::type_info &tp,
                                                          bool throw_if_missing = false) {
Wenzel Jakob's avatar
Wenzel Jakob committed
94
95
    auto &types = get_internals().registered_types_cpp;

96
97
    auto it = types.find(std::type_index(tp));
    if (it != types.end())
Wenzel Jakob's avatar
Wenzel Jakob committed
98
        return (detail::type_info *) it->second;
Wenzel Jakob's avatar
Wenzel Jakob committed
99
100
101
102
103
    if (throw_if_missing) {
        std::string tname = tp.name();
        detail::clean_type_id(tname);
        pybind11_fail("pybind11::detail::get_type_info: unable to find type info for \"" + tname + "\"");
    }
Wenzel Jakob's avatar
Wenzel Jakob committed
104
105
106
    return nullptr;
}

Wenzel Jakob's avatar
Wenzel Jakob committed
107
108
PYBIND11_NOINLINE inline handle get_type_handle(const std::type_info &tp, bool throw_if_missing) {
    detail::type_info *type_info = get_type_info(tp, throw_if_missing);
Wenzel Jakob's avatar
Wenzel Jakob committed
109
110
111
    return handle(type_info ? ((PyObject *) type_info->type) : nullptr);
}

112
PYBIND11_NOINLINE inline bool isinstance_generic(handle obj, const std::type_info &tp) {
Wenzel Jakob's avatar
Wenzel Jakob committed
113
    handle type = detail::get_type_handle(tp, false);
114
115
    if (!type)
        return false;
Wenzel Jakob's avatar
Wenzel Jakob committed
116
    return isinstance(obj, type);
117
118
}

Wenzel Jakob's avatar
Wenzel Jakob committed
119
PYBIND11_NOINLINE inline std::string error_string() {
120
121
122
123
124
    if (!PyErr_Occurred()) {
        PyErr_SetString(PyExc_RuntimeError, "Unknown internal error occurred");
        return "Unknown internal error occurred";
    }

Wenzel Jakob's avatar
Wenzel Jakob committed
125
    error_scope scope; // Preserve error state
Wenzel Jakob's avatar
Wenzel Jakob committed
126

127
    std::string errorString;
Wenzel Jakob's avatar
Wenzel Jakob committed
128
129
    if (scope.type) {
        errorString += handle(scope.type).attr("__name__").cast<std::string>();
Wenzel Jakob's avatar
Wenzel Jakob committed
130
131
        errorString += ": ";
    }
Wenzel Jakob's avatar
Wenzel Jakob committed
132
    if (scope.value)
133
        errorString += (std::string) str(scope.value);
Wenzel Jakob's avatar
Wenzel Jakob committed
134

135
136
    PyErr_NormalizeException(&scope.type, &scope.value, &scope.trace);

137
138
139
140
141
#if PY_MAJOR_VERSION >= 3
    if (scope.trace != nullptr)
        PyException_SetTraceback(scope.value, scope.trace);
#endif

Wenzel Jakob's avatar
Wenzel Jakob committed
142
#if !defined(PYPY_VERSION)
143
    if (scope.trace) {
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
        PyTracebackObject *trace = (PyTracebackObject *) scope.trace;

        /* Get the deepest trace possible */
        while (trace->tb_next)
            trace = trace->tb_next;

        PyFrameObject *frame = trace->tb_frame;
        errorString += "\n\nAt:\n";
        while (frame) {
            int lineno = PyFrame_GetLineNumber(frame);
            errorString +=
                "  " + handle(frame->f_code->co_filename).cast<std::string>() +
                "(" + std::to_string(lineno) + "): " +
                handle(frame->f_code->co_name).cast<std::string>() + "\n";
            frame = frame->f_back;
159
        }
160
        trace = trace->tb_next;
161
    }
Wenzel Jakob's avatar
Wenzel Jakob committed
162
#endif
163

Wenzel Jakob's avatar
Wenzel Jakob committed
164
165
166
    return errorString;
}

167
168
169
170
PYBIND11_NOINLINE inline handle get_object_handle(const void *ptr, const detail::type_info *type ) {
    auto &instances = get_internals().registered_instances;
    auto range = instances.equal_range(ptr);
    for (auto it = range.first; it != range.second; ++it) {
Wenzel Jakob's avatar
Wenzel Jakob committed
171
        auto instance_type = detail::get_type_info(Py_TYPE(it->second));
172
173
174
175
        if (instance_type && instance_type == type)
            return handle((PyObject *) it->second);
    }
    return handle();
Wenzel Jakob's avatar
Wenzel Jakob committed
176
177
}

178
inline PyThreadState *get_thread_state_unchecked() {
Wenzel Jakob's avatar
Wenzel Jakob committed
179
180
181
#if defined(PYPY_VERSION)
    return PyThreadState_GET();
#elif PY_VERSION_HEX < 0x03000000
182
183
184
185
186
187
188
189
190
191
    return _PyThreadState_Current;
#elif PY_VERSION_HEX < 0x03050000
    return (PyThreadState*) _Py_atomic_load_relaxed(&_PyThreadState_Current);
#elif PY_VERSION_HEX < 0x03050200
    return (PyThreadState*) _PyThreadState_Current.value;
#else
    return _PyThreadState_UncheckedGet();
#endif
}

192
193
194
// Forward declaration
inline void keep_alive_impl(handle nurse, handle patient);

Wenzel Jakob's avatar
Wenzel Jakob committed
195
196
197
class type_caster_generic {
public:
    PYBIND11_NOINLINE type_caster_generic(const std::type_info &type_info)
198
     : typeinfo(get_type_info(type_info)) { }
Wenzel Jakob's avatar
Wenzel Jakob committed
199

Wenzel Jakob's avatar
Wenzel Jakob committed
200
    PYBIND11_NOINLINE bool load(handle src, bool convert) {
201
202
        if (!src)
            return false;
Wenzel Jakob's avatar
Wenzel Jakob committed
203
204
205
206
        return load(src, convert, Py_TYPE(src.ptr()));
    }

    bool load(handle src, bool convert, PyTypeObject *tobj) {
Wenzel Jakob's avatar
Wenzel Jakob committed
207
        if (!src || !typeinfo)
Wenzel Jakob's avatar
Wenzel Jakob committed
208
            return false;
209
        if (src.is_none()) {
210
211
            value = nullptr;
            return true;
Wenzel Jakob's avatar
Wenzel Jakob committed
212
        }
Wenzel Jakob's avatar
Wenzel Jakob committed
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228

        if (typeinfo->simple_type) { /* Case 1: no multiple inheritance etc. involved */
            /* Check if we can safely perform a reinterpret-style cast */
            if (PyType_IsSubtype(tobj, typeinfo->type)) {
                value = reinterpret_cast<instance<void> *>(src.ptr())->value;
                return true;
            }
        } else { /* Case 2: multiple inheritance */
            /* Check if we can safely perform a reinterpret-style cast */
            if (tobj == typeinfo->type) {
                value = reinterpret_cast<instance<void> *>(src.ptr())->value;
                return true;
            }

            /* If this is a python class, also check the parents recursively */
            auto const &type_dict = get_internals().registered_types_py;
Wenzel Jakob's avatar
Wenzel Jakob committed
229
            bool new_style_class = PyType_Check((PyObject *) tobj);
Wenzel Jakob's avatar
Wenzel Jakob committed
230
            if (type_dict.find(tobj) == type_dict.end() && new_style_class && tobj->tp_bases) {
231
                auto parents = reinterpret_borrow<tuple>(tobj->tp_bases);
Wenzel Jakob's avatar
Wenzel Jakob committed
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
                for (handle parent : parents) {
                    bool result = load(src, convert, (PyTypeObject *) parent.ptr());
                    if (result)
                        return true;
                }
            }

            /* Try implicit casts */
            for (auto &cast : typeinfo->implicit_casts) {
                type_caster_generic sub_caster(*cast.first);
                if (sub_caster.load(src, convert)) {
                    value = cast.second(sub_caster.value);
                    return true;
                }
            }
        }

        /* Perform an implicit conversion */
Wenzel Jakob's avatar
Wenzel Jakob committed
250
251
        if (convert) {
            for (auto &converter : typeinfo->implicit_conversions) {
252
                temp = reinterpret_steal<object>(converter(src.ptr(), typeinfo->type));
Wenzel Jakob's avatar
Wenzel Jakob committed
253
                if (load(temp, false))
Wenzel Jakob's avatar
Wenzel Jakob committed
254
255
                    return true;
            }
256
257
258
259
            for (auto &converter : *typeinfo->direct_conversions) {
                if (converter(src.ptr(), value))
                    return true;
            }
Wenzel Jakob's avatar
Wenzel Jakob committed
260
261
262
263
        }
        return false;
    }

Wenzel Jakob's avatar
Wenzel Jakob committed
264
265
    PYBIND11_NOINLINE static handle cast(const void *_src, return_value_policy policy, handle parent,
                                         const std::type_info *type_info,
266
                                         const std::type_info *type_info_backup,
Wenzel Jakob's avatar
Wenzel Jakob committed
267
                                         void *(*copy_constructor)(const void *),
Wenzel Jakob's avatar
Wenzel Jakob committed
268
                                         void *(*move_constructor)(const void *),
Wenzel Jakob's avatar
Wenzel Jakob committed
269
                                         const void *existing_holder = nullptr) {
270
        void *src = const_cast<void *>(_src);
Wenzel Jakob's avatar
Wenzel Jakob committed
271
        if (src == nullptr)
Wenzel Jakob's avatar
Wenzel Jakob committed
272
            return none().inc_ref();
Wenzel Jakob's avatar
Wenzel Jakob committed
273

274
        auto &internals = get_internals();
Wenzel Jakob's avatar
Wenzel Jakob committed
275

276
        auto it = internals.registered_types_cpp.find(std::type_index(*type_info));
277
278
279
280
281
        if (it == internals.registered_types_cpp.end()) {
            type_info = type_info_backup;
            it = internals.registered_types_cpp.find(std::type_index(*type_info));
        }

282
        if (it == internals.registered_types_cpp.end()) {
283
284
285
            std::string tname = type_info->name();
            detail::clean_type_id(tname);
            std::string msg = "Unregistered type : " + tname;
Wenzel Jakob's avatar
Wenzel Jakob committed
286
            PyErr_SetString(PyExc_TypeError, msg.c_str());
Wenzel Jakob's avatar
Wenzel Jakob committed
287
            return handle();
Wenzel Jakob's avatar
Wenzel Jakob committed
288
        }
Wenzel Jakob's avatar
Wenzel Jakob committed
289

290
        auto tinfo = (const detail::type_info *) it->second;
291
292

        auto it_instances = internals.registered_instances.equal_range(src);
Jason Rhinelander's avatar
Jason Rhinelander committed
293
        for (auto it_i = it_instances.first; it_i != it_instances.second; ++it_i) {
Wenzel Jakob's avatar
Wenzel Jakob committed
294
            auto instance_type = detail::get_type_info(Py_TYPE(it_i->second));
295
            if (instance_type && instance_type == tinfo)
Jason Rhinelander's avatar
Jason Rhinelander committed
296
                return handle((PyObject *) it_i->second).inc_ref();
297
298
        }

299
        auto inst = reinterpret_steal<object>(PyType_GenericAlloc(tinfo->type, 0));
Wenzel Jakob's avatar
Wenzel Jakob committed
300
301
302

        auto wrapper = (instance<void> *) inst.ptr();

303
304
305
306
        wrapper->value = nullptr;
        wrapper->owned = false;

        switch (policy) {
Wenzel Jakob's avatar
Wenzel Jakob committed
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
            case return_value_policy::automatic:
            case return_value_policy::take_ownership:
                wrapper->value = src;
                wrapper->owned = true;
                break;

            case return_value_policy::automatic_reference:
            case return_value_policy::reference:
                wrapper->value = src;
                wrapper->owned = false;
                break;

            case return_value_policy::copy:
                if (copy_constructor)
                    wrapper->value = copy_constructor(src);
                else
                    throw cast_error("return_value_policy = copy, but the "
                                     "object is non-copyable!");
                wrapper->owned = true;
                break;

            case return_value_policy::move:
                if (move_constructor)
                    wrapper->value = move_constructor(src);
                else if (copy_constructor)
                    wrapper->value = copy_constructor(src);
                else
                    throw cast_error("return_value_policy = move, but the "
                                     "object is neither movable nor copyable!");
                wrapper->owned = true;
                break;

            case return_value_policy::reference_internal:
                wrapper->value = src;
                wrapper->owned = false;
                detail::keep_alive_impl(inst, parent);
                break;

            default:
                throw cast_error("unhandled return_value_policy: should not happen!");
Wenzel Jakob's avatar
Wenzel Jakob committed
347
        }
Wenzel Jakob's avatar
Wenzel Jakob committed
348
349

        tinfo->init_holder(inst.ptr(), existing_holder);
350
351

        internals.registered_instances.emplace(wrapper->value, inst.ptr());
Wenzel Jakob's avatar
Wenzel Jakob committed
352
353

        return inst.release();
Wenzel Jakob's avatar
Wenzel Jakob committed
354
355
356
357
    }

protected:
    const type_info *typeinfo = nullptr;
358
    void *value = nullptr;
Wenzel Jakob's avatar
Wenzel Jakob committed
359
360
361
    object temp;
};

362
363
/* Determine suitable casting operator */
template <typename T>
364
using cast_op_type = typename std::conditional<std::is_pointer<typename std::remove_reference<T>::type>::value,
365
366
    typename std::add_pointer<intrinsic_t<T>>::type,
    typename std::add_lvalue_reference<intrinsic_t<T>>::type>::type;
367

368
369
370
371
372
373
374
375
376
377
378
379
// std::is_copy_constructible isn't quite enough: it lets std::vector<T> (and similar) through when
// T is non-copyable, but code containing such a copy constructor fails to actually compile.
template <typename T, typename SFINAE = void> struct is_copy_constructible : std::is_copy_constructible<T> {};

// Specialization for types that appear to be copy constructible but also look like stl containers
// (we specifically check for: has `value_type` and `reference` with `reference = value_type&`): if
// so, copy constructability depends on whether the value_type is copy constructible.
template <typename Container> struct is_copy_constructible<Container, enable_if_t<
        std::is_copy_constructible<Container>::value &&
        std::is_same<typename Container::value_type &, typename Container::reference>::value
    >> : std::is_copy_constructible<typename Container::value_type> {};

380
/// Generic type caster for objects stored on the heap
Wenzel Jakob's avatar
Wenzel Jakob committed
381
template <typename type> class type_caster_base : public type_caster_generic {
382
    using itype = intrinsic_t<type>;
383
public:
384
    static PYBIND11_DESCR name() { return type_descr(_<type>()); }
385

Wenzel Jakob's avatar
Wenzel Jakob committed
386
    type_caster_base() : type_caster_base(typeid(type)) { }
387
    explicit type_caster_base(const std::type_info &info) : type_caster_generic(info) { }
388

389
    static handle cast(const itype &src, return_value_policy policy, handle parent) {
390
        if (policy == return_value_policy::automatic || policy == return_value_policy::automatic_reference)
391
            policy = return_value_policy::copy;
392
        return cast(&src, policy, parent);
393
394
    }

395
396
    static handle cast(itype &&src, return_value_policy, handle parent) {
        return cast(&src, return_value_policy::move, parent);
Wenzel Jakob's avatar
Wenzel Jakob committed
397
398
    }

399
    static handle cast(const itype *src, return_value_policy policy, handle parent) {
Wenzel Jakob's avatar
Wenzel Jakob committed
400
401
        return type_caster_generic::cast(
            src, policy, parent, src ? &typeid(*src) : nullptr, &typeid(type),
402
            make_copy_constructor(src), make_move_constructor(src));
403
404
    }

405
406
407
408
409
410
411
    static handle cast_holder(const itype *src, const void *holder) {
        return type_caster_generic::cast(
            src, return_value_policy::take_ownership, {},
            src ? &typeid(*src) : nullptr, &typeid(type),
            nullptr, nullptr, holder);
    }

412
413
    template <typename T> using cast_op_type = pybind11::detail::cast_op_type<T>;

414
415
    operator itype*() { return (type *) value; }
    operator itype&() { if (!value) throw reference_cast_error(); return *((itype *) value); }
416

417
protected:
418
419
420
421
    typedef void *(*Constructor)(const void *stream);
#if !defined(_MSC_VER)
    /* Only enabled when the types are {copy,move}-constructible *and* when the type
       does not have a private operator new implementaton. */
422
    template <typename T = type, typename = enable_if_t<is_copy_constructible<T>::value>> static auto make_copy_constructor(const T *value) -> decltype(new T(*value), Constructor(nullptr)) {
423
424
425
426
427
428
        return [](const void *arg) -> void * { return new T(*((const T *) arg)); }; }
    template <typename T = type> static auto make_move_constructor(const T *value) -> decltype(new T(std::move(*((T *) value))), Constructor(nullptr)) {
        return [](const void *arg) -> void * { return (void *) new T(std::move(*((T *) arg))); }; }
#else
    /* Visual Studio 2015's SFINAE implementation doesn't yet handle the above robustly in all situations.
       Use a workaround that only tests for constructibility for now. */
429
    template <typename T = type, typename = enable_if_t<is_copy_constructible<T>::value>>
430
431
    static Constructor make_copy_constructor(const T *value) {
        return [](const void *arg) -> void * { return new T(*((const T *)arg)); }; }
432
    template <typename T = type, typename = enable_if_t<std::is_move_constructible<T>::value>>
433
434
435
    static Constructor make_move_constructor(const T *value) {
        return [](const void *arg) -> void * { return (void *) new T(std::move(*((T *)arg))); }; }
#endif
436

437
438
    static Constructor make_copy_constructor(...) { return nullptr; }
    static Constructor make_move_constructor(...) { return nullptr; }
439
440
};

Wenzel Jakob's avatar
Wenzel Jakob committed
441
template <typename type, typename SFINAE = void> class type_caster : public type_caster_base<type> { };
442
template <typename type> using make_caster = type_caster<intrinsic_t<type>>;
Wenzel Jakob's avatar
Wenzel Jakob committed
443

444
// Shortcut for calling a caster's `cast_op_type` cast operator for casting a type_caster to a T
445
template <typename T> typename make_caster<T>::template cast_op_type<T> cast_op(make_caster<T> &caster) {
446
447
    return caster.operator typename make_caster<T>::template cast_op_type<T>();
}
448
template <typename T> typename make_caster<T>::template cast_op_type<T> cast_op(make_caster<T> &&caster) {
449
450
451
    return cast_op<T>(caster);
}

Wenzel Jakob's avatar
Wenzel Jakob committed
452
template <typename type> class type_caster<std::reference_wrapper<type>> : public type_caster_base<type> {
453
454
public:
    static handle cast(const std::reference_wrapper<type> &src, return_value_policy policy, handle parent) {
Wenzel Jakob's avatar
Wenzel Jakob committed
455
        return type_caster_base<type>::cast(&src.get(), policy, parent);
456
    }
457
458
    template <typename T> using cast_op_type = std::reference_wrapper<type>;
    operator std::reference_wrapper<type>() { return std::ref(*((type *) this->value)); }
459
460
};

461
#define PYBIND11_TYPE_CASTER(type, py_name) \
Wenzel Jakob's avatar
Wenzel Jakob committed
462
463
464
    protected: \
        type value; \
    public: \
465
        static PYBIND11_DESCR name() { return type_descr(py_name); } \
Wenzel Jakob's avatar
Wenzel Jakob committed
466
        static handle cast(const type *src, return_value_policy policy, handle parent) { \
Wenzel Jakob's avatar
Wenzel Jakob committed
467
468
469
            return cast(*src, policy, parent); \
        } \
        operator type*() { return &value; } \
470
        operator type&() { return value; } \
471
        template <typename _T> using cast_op_type = pybind11::detail::cast_op_type<_T>
Wenzel Jakob's avatar
Wenzel Jakob committed
472

473

Wenzel Jakob's avatar
Wenzel Jakob committed
474
template <typename T>
475
struct type_caster<T, enable_if_t<std::is_arithmetic<T>::value>> {
Wenzel Jakob's avatar
Wenzel Jakob committed
476
477
478
479
    typedef typename std::conditional<sizeof(T) <= sizeof(long), long, long long>::type _py_type_0;
    typedef typename std::conditional<std::is_signed<T>::value, _py_type_0, typename std::make_unsigned<_py_type_0>::type>::type _py_type_1;
    typedef typename std::conditional<std::is_floating_point<T>::value, double, _py_type_1>::type py_type;
public:
Wenzel Jakob's avatar
Wenzel Jakob committed
480

Wenzel Jakob's avatar
Wenzel Jakob committed
481
    bool load(handle src, bool) {
Wenzel Jakob's avatar
Wenzel Jakob committed
482
        py_type py_value;
Wenzel Jakob's avatar
Wenzel Jakob committed
483

484
485
486
        if (!src) {
            return false;
        } if (std::is_floating_point<T>::value) {
Wenzel Jakob's avatar
Wenzel Jakob committed
487
            py_value = (py_type) PyFloat_AsDouble(src.ptr());
Wenzel Jakob's avatar
Wenzel Jakob committed
488
        } else if (sizeof(T) <= sizeof(long)) {
489
490
            if (PyFloat_Check(src.ptr()))
                return false;
Wenzel Jakob's avatar
Wenzel Jakob committed
491
            if (std::is_signed<T>::value)
Wenzel Jakob's avatar
Wenzel Jakob committed
492
                py_value = (py_type) PyLong_AsLong(src.ptr());
Wenzel Jakob's avatar
Wenzel Jakob committed
493
            else
Wenzel Jakob's avatar
Wenzel Jakob committed
494
                py_value = (py_type) PyLong_AsUnsignedLong(src.ptr());
Wenzel Jakob's avatar
Wenzel Jakob committed
495
        } else {
496
497
            if (PyFloat_Check(src.ptr()))
                return false;
Wenzel Jakob's avatar
Wenzel Jakob committed
498
            if (std::is_signed<T>::value)
Wenzel Jakob's avatar
Wenzel Jakob committed
499
                py_value = (py_type) PYBIND11_LONG_AS_LONGLONG(src.ptr());
Wenzel Jakob's avatar
Wenzel Jakob committed
500
            else
Wenzel Jakob's avatar
Wenzel Jakob committed
501
                py_value = (py_type) PYBIND11_LONG_AS_UNSIGNED_LONGLONG(src.ptr());
Wenzel Jakob's avatar
Wenzel Jakob committed
502
503
504
505
506
507
        }

        if ((py_value == (py_type) -1 && PyErr_Occurred()) ||
            (std::is_integral<T>::value && sizeof(py_type) != sizeof(T) &&
               (py_value < (py_type) std::numeric_limits<T>::min() ||
                py_value > (py_type) std::numeric_limits<T>::max()))) {
508
509
510
511
512
#if PY_VERSION_HEX < 0x03000000
            bool type_error = PyErr_ExceptionMatches(PyExc_SystemError);
#else
            bool type_error = PyErr_ExceptionMatches(PyExc_TypeError);
#endif
Wenzel Jakob's avatar
Wenzel Jakob committed
513
            PyErr_Clear();
514
            if (type_error && PyNumber_Check(src.ptr())) {
515
516
517
                auto tmp = reinterpret_borrow<object>(std::is_floating_point<T>::value
                                                      ? PyNumber_Float(src.ptr())
                                                      : PyNumber_Long(src.ptr()));
518
519
520
                PyErr_Clear();
                return load(tmp, false);
            }
Wenzel Jakob's avatar
Wenzel Jakob committed
521
522
            return false;
        }
Wenzel Jakob's avatar
Wenzel Jakob committed
523

Wenzel Jakob's avatar
Wenzel Jakob committed
524
525
526
527
        value = (T) py_value;
        return true;
    }

Wenzel Jakob's avatar
Wenzel Jakob committed
528
    static handle cast(T src, return_value_policy /* policy */, handle /* parent */) {
Wenzel Jakob's avatar
Wenzel Jakob committed
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
        if (std::is_floating_point<T>::value) {
            return PyFloat_FromDouble((double) src);
        } else if (sizeof(T) <= sizeof(long)) {
            if (std::is_signed<T>::value)
                return PyLong_FromLong((long) src);
            else
                return PyLong_FromUnsignedLong((unsigned long) src);
        } else {
            if (std::is_signed<T>::value)
                return PyLong_FromLongLong((long long) src);
            else
                return PyLong_FromUnsignedLongLong((unsigned long long) src);
        }
    }

544
    PYBIND11_TYPE_CASTER(T, _<std::is_integral<T>::value>("int", "float"));
Wenzel Jakob's avatar
Wenzel Jakob committed
545
};
Wenzel Jakob's avatar
Wenzel Jakob committed
546

547
template<typename T> struct void_caster {
Wenzel Jakob's avatar
Wenzel Jakob committed
548
public:
Wenzel Jakob's avatar
Wenzel Jakob committed
549
    bool load(handle, bool) { return false; }
550
    static handle cast(T, return_value_policy /* policy */, handle /* parent */) {
Wenzel Jakob's avatar
Wenzel Jakob committed
551
        return none().inc_ref();
Wenzel Jakob's avatar
Wenzel Jakob committed
552
    }
553
    PYBIND11_TYPE_CASTER(T, _("None"));
Wenzel Jakob's avatar
Wenzel Jakob committed
554
555
};

556
557
template <> class type_caster<void_type> : public void_caster<void_type> {};

558
559
560
561
562
template <> class type_caster<void> : public type_caster<void_type> {
public:
    using type_caster<void_type>::cast;

    bool load(handle h, bool) {
563
564
        if (!h) {
            return false;
565
        } else if (h.is_none()) {
566
567
568
            value = nullptr;
            return true;
        }
569
570

        /* Check if this is a capsule */
571
        if (isinstance<capsule>(h)) {
572
            value = reinterpret_borrow<capsule>(h);
573
574
575
576
            return true;
        }

        /* Check if this is a C++ type */
Wenzel Jakob's avatar
Wenzel Jakob committed
577
        if (get_type_info((PyTypeObject *) h.get_type().ptr())) {
578
579
580
581
582
583
            value = ((instance<void> *) h.ptr())->value;
            return true;
        }

        /* Fail */
        return false;
584
585
    }

Wenzel Jakob's avatar
Wenzel Jakob committed
586
    static handle cast(const void *ptr, return_value_policy /* policy */, handle /* parent */) {
587
588
589
        if (ptr)
            return capsule(ptr).release();
        else
Wenzel Jakob's avatar
Wenzel Jakob committed
590
            return none().inc_ref();
591
    }
592

593
594
    template <typename T> using cast_op_type = void*&;
    operator void *&() { return value; }
595
    static PYBIND11_DESCR name() { return type_descr(_("capsule")); }
596
private:
597
    void *value = nullptr;
598
599
};

Wenzel Jakob's avatar
Wenzel Jakob committed
600
template <> class type_caster<std::nullptr_t> : public type_caster<void_type> { };
601

Wenzel Jakob's avatar
Wenzel Jakob committed
602
603
template <> class type_caster<bool> {
public:
Wenzel Jakob's avatar
Wenzel Jakob committed
604
    bool load(handle src, bool) {
605
606
        if (!src) return false;
        else if (src.ptr() == Py_True) { value = true; return true; }
Wenzel Jakob's avatar
Wenzel Jakob committed
607
        else if (src.ptr() == Py_False) { value = false; return true; }
Wenzel Jakob's avatar
Wenzel Jakob committed
608
609
        else return false;
    }
Wenzel Jakob's avatar
Wenzel Jakob committed
610
611
    static handle cast(bool src, return_value_policy /* policy */, handle /* parent */) {
        return handle(src ? Py_True : Py_False).inc_ref();
Wenzel Jakob's avatar
Wenzel Jakob committed
612
    }
613
    PYBIND11_TYPE_CASTER(bool, _("bool"));
Wenzel Jakob's avatar
Wenzel Jakob committed
614
615
616
617
};

template <> class type_caster<std::string> {
public:
Wenzel Jakob's avatar
Wenzel Jakob committed
618
    bool load(handle src, bool) {
619
        object temp;
Wenzel Jakob's avatar
Wenzel Jakob committed
620
        handle load_src = src;
621
622
623
        if (!src) {
            return false;
        } else if (PyUnicode_Check(load_src.ptr())) {
624
            temp = reinterpret_steal<object>(PyUnicode_AsUTF8String(load_src.ptr()));
625
            if (!temp) { PyErr_Clear(); return false; }  // UnicodeEncodeError
Wenzel Jakob's avatar
Wenzel Jakob committed
626
            load_src = temp;
627
628
629
        }
        char *buffer;
        ssize_t length;
Wenzel Jakob's avatar
Wenzel Jakob committed
630
        int err = PYBIND11_BYTES_AS_STRING_AND_SIZE(load_src.ptr(), &buffer, &length);
631
        if (err == -1) { PyErr_Clear(); return false; }  // TypeError
632
        value = std::string(buffer, (size_t) length);
633
        success = true;
Wenzel Jakob's avatar
Wenzel Jakob committed
634
635
        return true;
    }
636

Wenzel Jakob's avatar
Wenzel Jakob committed
637
    static handle cast(const std::string &src, return_value_policy /* policy */, handle /* parent */) {
638
        return PyUnicode_FromStringAndSize(src.c_str(), (ssize_t) src.length());
Wenzel Jakob's avatar
Wenzel Jakob committed
639
    }
640
641

    PYBIND11_TYPE_CASTER(std::string, _(PYBIND11_STRING_NAME));
642
643
protected:
    bool success = false;
Wenzel Jakob's avatar
Wenzel Jakob committed
644
645
};

hulucc's avatar
hulucc committed
646
template <> class type_caster<std::wstring> {
Wenzel Jakob's avatar
Wenzel Jakob committed
647
public:
Wenzel Jakob's avatar
Wenzel Jakob committed
648
649
650
    bool load(handle src, bool) {
        object temp;
        handle load_src = src;
651
652
653
        if (!src) {
            return false;
        } else if (!PyUnicode_Check(load_src.ptr())) {
654
            temp = reinterpret_steal<object>(PyUnicode_FromObject(load_src.ptr()));
Wenzel Jakob's avatar
Wenzel Jakob committed
655
656
657
            if (!temp) { PyErr_Clear(); return false; }
            load_src = temp;
        }
658
659
660
661
662
        wchar_t *buffer = nullptr;
        ssize_t length = -1;
#if PY_MAJOR_VERSION >= 3
        buffer = PyUnicode_AsWideCharString(load_src.ptr(), &length);
#else
Wenzel Jakob's avatar
Wenzel Jakob committed
663
664
665
666
        temp = reinterpret_steal<object>(PyUnicode_AsEncodedString(
            load_src.ptr(), sizeof(wchar_t) == sizeof(short)
            ? "utf16" : "utf32", nullptr));

667
668
669
        if (temp) {
            int err = PYBIND11_BYTES_AS_STRING_AND_SIZE(temp.ptr(), (char **) &buffer, &length);
            if (err == -1) { buffer = nullptr; }  // TypeError
670
            length = length / (ssize_t) sizeof(wchar_t) - 1; ++buffer; // Skip BOM
671
        }
672
673
#endif
        if (!buffer) { PyErr_Clear(); return false; }
674
        value = std::wstring(buffer, (size_t) length);
Wenzel Jakob's avatar
Wenzel Jakob committed
675
676
677
        success = true;
        return true;
    }
hulucc's avatar
hulucc committed
678

Wenzel Jakob's avatar
Wenzel Jakob committed
679
    static handle cast(const std::wstring &src, return_value_policy /* policy */, handle /* parent */) {
680
        return PyUnicode_FromWideChar(src.c_str(), (ssize_t) src.length());
Wenzel Jakob's avatar
Wenzel Jakob committed
681
    }
Wenzel Jakob's avatar
Wenzel Jakob committed
682

Wenzel Jakob's avatar
Wenzel Jakob committed
683
    PYBIND11_TYPE_CASTER(std::wstring, _(PYBIND11_STRING_NAME));
684
685
protected:
    bool success = false;
hulucc's avatar
hulucc committed
686
687
};

688
template <> class type_caster<char> : public type_caster<std::string> {
Wenzel Jakob's avatar
Wenzel Jakob committed
689
public:
Wenzel Jakob's avatar
Wenzel Jakob committed
690
    bool load(handle src, bool convert) {
691
        if (src.is_none()) return true;
692
693
694
        return type_caster<std::string>::load(src, convert);
    }

Wenzel Jakob's avatar
Wenzel Jakob committed
695
    static handle cast(const char *src, return_value_policy /* policy */, handle /* parent */) {
Wenzel Jakob's avatar
Wenzel Jakob committed
696
        if (src == nullptr) return none().inc_ref();
Wenzel Jakob's avatar
Wenzel Jakob committed
697
698
699
        return PyUnicode_FromString(src);
    }

Wenzel Jakob's avatar
Wenzel Jakob committed
700
    static handle cast(char src, return_value_policy /* policy */, handle /* parent */) {
Wenzel Jakob's avatar
Wenzel Jakob committed
701
702
703
704
        char str[2] = { src, '\0' };
        return PyUnicode_DecodeLatin1(str, 1, nullptr);
    }

705
    operator char*() { return success ? (char *) value.c_str() : nullptr; }
Wenzel Jakob's avatar
Wenzel Jakob committed
706
    operator char&() { return value[0]; }
707

708
    static PYBIND11_DESCR name() { return type_descr(_(PYBIND11_STRING_NAME)); }
Wenzel Jakob's avatar
Wenzel Jakob committed
709
710
};

711
template <> class type_caster<wchar_t> : public type_caster<std::wstring> {
hulucc's avatar
hulucc committed
712
public:
Wenzel Jakob's avatar
Wenzel Jakob committed
713
    bool load(handle src, bool convert) {
714
        if (src.is_none()) return true;
715
716
717
        return type_caster<std::wstring>::load(src, convert);
    }

Wenzel Jakob's avatar
Wenzel Jakob committed
718
    static handle cast(const wchar_t *src, return_value_policy /* policy */, handle /* parent */) {
Wenzel Jakob's avatar
Wenzel Jakob committed
719
        if (src == nullptr) return none().inc_ref();
720
        return PyUnicode_FromWideChar(src, (ssize_t) wcslen(src));
Wenzel Jakob's avatar
Wenzel Jakob committed
721
    }
hulucc's avatar
hulucc committed
722

Wenzel Jakob's avatar
Wenzel Jakob committed
723
724
725
726
    static handle cast(wchar_t src, return_value_policy /* policy */, handle /* parent */) {
        wchar_t wstr[2] = { src, L'\0' };
        return PyUnicode_FromWideChar(wstr, 1);
    }
hulucc's avatar
hulucc committed
727

728
    operator wchar_t*() { return success ? (wchar_t *) value.c_str() : nullptr; }
Wenzel Jakob's avatar
Wenzel Jakob committed
729
    operator wchar_t&() { return value[0]; }
hulucc's avatar
hulucc committed
730

Wenzel Jakob's avatar
Wenzel Jakob committed
731
    static PYBIND11_DESCR name() { return type_descr(_(PYBIND11_STRING_NAME)); }
hulucc's avatar
hulucc committed
732
733
};

Wenzel Jakob's avatar
Wenzel Jakob committed
734
735
736
template <typename T1, typename T2> class type_caster<std::pair<T1, T2>> {
    typedef std::pair<T1, T2> type;
public:
Wenzel Jakob's avatar
Wenzel Jakob committed
737
    bool load(handle src, bool convert) {
738
        if (!isinstance<sequence>(src))
739
            return false;
740
741
        const auto seq = reinterpret_borrow<sequence>(src);
        if (seq.size() != 2)
Wenzel Jakob's avatar
Wenzel Jakob committed
742
            return false;
743
        return first.load(seq[0], convert) && second.load(seq[1], convert);
Wenzel Jakob's avatar
Wenzel Jakob committed
744
745
    }

Wenzel Jakob's avatar
Wenzel Jakob committed
746
    static handle cast(const type &src, return_value_policy policy, handle parent) {
747
748
        auto o1 = reinterpret_steal<object>(make_caster<T1>::cast(src.first, policy, parent));
        auto o2 = reinterpret_steal<object>(make_caster<T2>::cast(src.second, policy, parent));
749
        if (!o1 || !o2)
Wenzel Jakob's avatar
Wenzel Jakob committed
750
751
752
753
754
            return handle();
        tuple result(2);
        PyTuple_SET_ITEM(result.ptr(), 0, o1.release().ptr());
        PyTuple_SET_ITEM(result.ptr(), 1, o2.release().ptr());
        return result.release();
Wenzel Jakob's avatar
Wenzel Jakob committed
755
756
    }

757
758
    static PYBIND11_DESCR name() {
        return type_descr(
759
760
            _("Tuple[") + make_caster<T1>::name() + _(", ") + make_caster<T2>::name() + _("]")
        );
Wenzel Jakob's avatar
Wenzel Jakob committed
761
762
    }

763
764
    template <typename T> using cast_op_type = type;

Wenzel Jakob's avatar
Wenzel Jakob committed
765
    operator type() {
766
        return type(cast_op<T1>(first), cast_op<T2>(second));
Wenzel Jakob's avatar
Wenzel Jakob committed
767
768
    }
protected:
769
770
    make_caster<T1> first;
    make_caster<T2> second;
Wenzel Jakob's avatar
Wenzel Jakob committed
771
772
};

773
template <typename... Tuple> class type_caster<std::tuple<Tuple...>> {
774
    using type = std::tuple<Tuple...>;
775
    using indices = make_index_sequence<sizeof...(Tuple)>;
776
    static constexpr auto size = sizeof...(Tuple);
777

778
public:
Wenzel Jakob's avatar
Wenzel Jakob committed
779
    bool load(handle src, bool convert) {
780
781
782
783
        if (!isinstance<sequence>(src))
            return false;
        const auto seq = reinterpret_borrow<sequence>(src);
        if (seq.size() != size)
784
            return false;
785
        return load_impl(seq, convert, indices{});
786
    }
787

Wenzel Jakob's avatar
Wenzel Jakob committed
788
    static handle cast(const type &src, return_value_policy policy, handle parent) {
789
        return cast_impl(src, policy, parent, indices{});
790
    }
Wenzel Jakob's avatar
Wenzel Jakob committed
791

792
    static PYBIND11_DESCR name() {
793
        return type_descr(_("Tuple[") + detail::concat(make_caster<Tuple>::name()...) + _("]"));
Wenzel Jakob's avatar
Wenzel Jakob committed
794
795
    }

796
797
    template <typename T> using cast_op_type = type;

798
    operator type() { return implicit_cast(indices{}); }
Wenzel Jakob's avatar
Wenzel Jakob committed
799

Wenzel Jakob's avatar
Wenzel Jakob committed
800
protected:
801
802
    template <size_t... Is>
    type implicit_cast(index_sequence<Is...>) { return type(cast_op<Tuple>(std::get<Is>(value))...); }
Wenzel Jakob's avatar
Wenzel Jakob committed
803

804
    static constexpr bool load_impl(const sequence &, bool, index_sequence<>) { return true; }
Wenzel Jakob's avatar
Wenzel Jakob committed
805

806
    template <size_t... Is>
807
808
    bool load_impl(const sequence &seq, bool convert, index_sequence<Is...>) {
        for (bool r : {std::get<Is>(value).load(seq[Is], convert)...})
Wenzel Jakob's avatar
Wenzel Jakob committed
809
810
811
812
813
            if (!r)
                return false;
        return true;
    }

814
815
816
    static handle cast_impl(const type &, return_value_policy, handle,
                            index_sequence<>) { return tuple().release(); }

Wenzel Jakob's avatar
Wenzel Jakob committed
817
    /* Implementation: Convert a C++ tuple into a Python tuple */
818
819
    template <size_t... Is>
    static handle cast_impl(const type &src, return_value_policy policy, handle parent, index_sequence<Is...>) {
Wenzel Jakob's avatar
Wenzel Jakob committed
820
        std::array<object, size> entries {{
821
            reinterpret_steal<object>(make_caster<Tuple>::cast(std::get<Is>(src), policy, parent))...
Wenzel Jakob's avatar
Wenzel Jakob committed
822
        }};
Wenzel Jakob's avatar
Wenzel Jakob committed
823
824
825
826
        for (const auto &entry: entries)
            if (!entry)
                return handle();
        tuple result(size);
827
        int counter = 0;
Wenzel Jakob's avatar
Wenzel Jakob committed
828
829
830
        for (auto & entry: entries)
            PyTuple_SET_ITEM(result.ptr(), counter++, entry.release().ptr());
        return result.release();
Wenzel Jakob's avatar
Wenzel Jakob committed
831
832
    }

833
    std::tuple<make_caster<Tuple>...> value;
Wenzel Jakob's avatar
Wenzel Jakob committed
834
835
};

836
837
838
839
840
841
842
/// Helper class which abstracts away certain actions. Users can provide specializations for
/// custom holders, but it's only necessary if the type has a non-standard interface.
template <typename T>
struct holder_helper {
    static auto get(const T &p) -> decltype(p.get()) { return p.get(); }
};

Wenzel Jakob's avatar
Wenzel Jakob committed
843
/// Type caster for holder types like std::shared_ptr, etc.
844
845
template <typename type, typename holder_type>
struct copyable_holder_caster : public type_caster_base<type> {
Wenzel Jakob's avatar
Wenzel Jakob committed
846
public:
Wenzel Jakob's avatar
Wenzel Jakob committed
847
848
849
850
851
852
    using base = type_caster_base<type>;
    using base::base;
    using base::cast;
    using base::typeinfo;
    using base::value;
    using base::temp;
853

Wenzel Jakob's avatar
Wenzel Jakob committed
854
855
856
857
858
859
    PYBIND11_NOINLINE bool load(handle src, bool convert) {
        return load(src, convert, Py_TYPE(src.ptr()));
    }

    bool load(handle src, bool convert, PyTypeObject *tobj) {
        if (!src || !typeinfo)
Wenzel Jakob's avatar
Wenzel Jakob committed
860
            return false;
Wenzel Jakob's avatar
Wenzel Jakob committed
861
        if (src.is_none()) {
862
863
            value = nullptr;
            return true;
Wenzel Jakob's avatar
Wenzel Jakob committed
864
865
866
867
        }

        if (typeinfo->simple_type) { /* Case 1: no multiple inheritance etc. involved */
            /* Check if we can safely perform a reinterpret-style cast */
868
869
            if (PyType_IsSubtype(tobj, typeinfo->type))
                return load_value_and_holder(src);
Wenzel Jakob's avatar
Wenzel Jakob committed
870
871
        } else { /* Case 2: multiple inheritance */
            /* Check if we can safely perform a reinterpret-style cast */
872
873
            if (tobj == typeinfo->type)
                return load_value_and_holder(src);
Wenzel Jakob's avatar
Wenzel Jakob committed
874
875
876

            /* If this is a python class, also check the parents recursively */
            auto const &type_dict = get_internals().registered_types_py;
Wenzel Jakob's avatar
Wenzel Jakob committed
877
            bool new_style_class = PyType_Check((PyObject *) tobj);
Wenzel Jakob's avatar
Wenzel Jakob committed
878
            if (type_dict.find(tobj) == type_dict.end() && new_style_class && tobj->tp_bases) {
879
                auto parents = reinterpret_borrow<tuple>(tobj->tp_bases);
Wenzel Jakob's avatar
Wenzel Jakob committed
880
881
882
883
884
885
886
887
888
                for (handle parent : parents) {
                    bool result = load(src, convert, (PyTypeObject *) parent.ptr());
                    if (result)
                        return true;
                }
            }

            if (try_implicit_casts(src, convert))
                return true;
889
        }
Wenzel Jakob's avatar
Wenzel Jakob committed
890

891
892
        if (convert) {
            for (auto &converter : typeinfo->implicit_conversions) {
893
                temp = reinterpret_steal<object>(converter(src.ptr(), typeinfo->type));
Wenzel Jakob's avatar
Wenzel Jakob committed
894
                if (load(temp, false))
895
896
897
                    return true;
            }
        }
Wenzel Jakob's avatar
Wenzel Jakob committed
898
899
900
901

        return false;
    }

902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
    bool load_value_and_holder(handle src) {
        auto inst = (instance<type, holder_type> *) src.ptr();
        value = (void *) inst->value;
        if (inst->holder_constructed) {
            holder = inst->holder;
            return true;
        } else {
            throw cast_error("Unable to cast from non-held to held instance (T& to Holder<T>) "
#if defined(NDEBUG)
                             "(compile in debug mode for type information)");
#else
                             "of type '" + type_id<holder_type>() + "''");
#endif
        }
    }

Wenzel Jakob's avatar
Wenzel Jakob committed
918
919
920
921
922
923
    template <typename T = holder_type, detail::enable_if_t<!std::is_constructible<T, const T &, type*>::value, int> = 0>
    bool try_implicit_casts(handle, bool) { return false; }

    template <typename T = holder_type, detail::enable_if_t<std::is_constructible<T, const T &, type*>::value, int> = 0>
    bool try_implicit_casts(handle src, bool convert) {
        for (auto &cast : typeinfo->implicit_casts) {
924
            copyable_holder_caster sub_caster(*cast.first);
Wenzel Jakob's avatar
Wenzel Jakob committed
925
926
927
928
929
930
            if (sub_caster.load(src, convert)) {
                value = cast.second(sub_caster.value);
                holder = holder_type(sub_caster.holder, (type *) value);
                return true;
            }
        }
931
        return false;
Wenzel Jakob's avatar
Wenzel Jakob committed
932
    }
933

Wenzel Jakob's avatar
Wenzel Jakob committed
934
935
936
    explicit operator type*() { return this->value; }
    explicit operator type&() { return *(this->value); }
    explicit operator holder_type*() { return &holder; }
937

938
939
940
941
942
943
944
945
    // Workaround for Intel compiler bug
    // see pybind11 issue 94
    #if defined(__ICC) || defined(__INTEL_COMPILER)
    operator holder_type&() { return holder; }
    #else
    explicit operator holder_type&() { return holder; }
    #endif

946
    static handle cast(const holder_type &src, return_value_policy, handle) {
947
948
        const auto *ptr = holder_helper<holder_type>::get(src);
        return type_caster_base<type>::cast_holder(ptr, &src);
949
950
    }

Wenzel Jakob's avatar
Wenzel Jakob committed
951
952
953
954
protected:
    holder_type holder;
};

955
956
/// Specialize for the common std::shared_ptr, so users don't need to
template <typename T>
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
class type_caster<std::shared_ptr<T>> : public copyable_holder_caster<T, std::shared_ptr<T>> { };

template <typename type, typename holder_type>
struct move_only_holder_caster {
    static handle cast(holder_type &&src, return_value_policy, handle) {
        auto *ptr = holder_helper<holder_type>::get(src);
        return type_caster_base<type>::cast_holder(ptr, &src);
    }
    static PYBIND11_DESCR name() { return type_caster_base<type>::name(); }
};

template <typename type, typename deleter>
class type_caster<std::unique_ptr<type, deleter>>
    : public move_only_holder_caster<type, std::unique_ptr<type, deleter>> { };

template <typename type, typename holder_type>
using type_caster_holder = conditional_t<std::is_copy_constructible<holder_type>::value,
                                         copyable_holder_caster<type, holder_type>,
                                         move_only_holder_caster<type, holder_type>>;
976

977
978
template <typename T, bool Value = false> struct always_construct_holder { static constexpr bool value = Value; };

979
/// Create a specialization for custom holder types (silently ignores std::shared_ptr)
980
#define PYBIND11_DECLARE_HOLDER_TYPE(type, holder_type, ...) \
981
982
    namespace pybind11 { namespace detail { \
    template <typename type> \
983
984
    struct always_construct_holder<holder_type> : always_construct_holder<void, ##__VA_ARGS__>  { }; \
    template <typename type> \
985
986
987
988
    class type_caster<holder_type, enable_if_t<!is_shared_ptr<holder_type>::value>> \
        : public type_caster_holder<type, holder_type> { }; \
    }}

989
// PYBIND11_DECLARE_HOLDER_TYPE holder types:
990
template <typename base, typename holder> struct is_holder_type :
991
992
993
994
    std::is_base_of<detail::type_caster_holder<base, holder>, detail::type_caster<holder>> {};
// Specialization for always-supported unique_ptr holders:
template <typename base, typename deleter> struct is_holder_type<base, std::unique_ptr<base, deleter>> :
    std::true_type {};
995

996
997
template <typename T> struct handle_type_name { static PYBIND11_DESCR name() { return _<T>(); } };
template <> struct handle_type_name<bytes> { static PYBIND11_DESCR name() { return _(PYBIND11_BYTES_NAME); } };
998
999
template <> struct handle_type_name<args> { static PYBIND11_DESCR name() { return _("*args"); } };
template <> struct handle_type_name<kwargs> { static PYBIND11_DESCR name() { return _("**kwargs"); } };
1000

1001
template <typename type>
1002
1003
1004
struct pyobject_caster {
    template <typename T = type, enable_if_t<std::is_same<T, handle>::value, int> = 0>
    bool load(handle src, bool /* convert */) { value = src; return static_cast<bool>(value); }
1005

1006
    template <typename T = type, enable_if_t<std::is_base_of<object, T>::value, int> = 0>
1007
1008
1009
    bool load(handle src, bool /* convert */) {
        if (!isinstance<type>(src))
            return false;
1010
        value = reinterpret_borrow<type>(src);
1011
1012
        return true;
    }
1013

Wenzel Jakob's avatar
Wenzel Jakob committed
1014
1015
    static handle cast(const handle &src, return_value_policy /* policy */, handle /* parent */) {
        return src.inc_ref();
Wenzel Jakob's avatar
Wenzel Jakob committed
1016
    }
1017
    PYBIND11_TYPE_CASTER(type, handle_type_name<type>::name());
Wenzel Jakob's avatar
Wenzel Jakob committed
1018
1019
};

1020
1021
1022
template <typename T>
class type_caster<T, enable_if_t<is_pyobject<T>::value>> : public pyobject_caster<T> { };

1023
1024
1025
1026
1027
1028
1029
1030
1031
// Our conditions for enabling moving are quite restrictive:
// At compile time:
// - T needs to be a non-const, non-pointer, non-reference type
// - type_caster<T>::operator T&() must exist
// - the type must be move constructible (obviously)
// At run-time:
// - if the type is non-copy-constructible, the object must be the sole owner of the type (i.e. it
//   must have ref_count() == 1)h
// If any of the above are not satisfied, we fall back to copying.
1032
1033
template <typename T> using move_is_plain_type = satisfies_none_of<T,
    std::is_void, std::is_pointer, std::is_reference, std::is_const
1034
>;
1035
template <typename T, typename SFINAE = void> struct move_always : std::false_type {};
1036
1037
1038
1039
template <typename T> struct move_always<T, enable_if_t<all_of<
    move_is_plain_type<T>,
    negation<std::is_copy_constructible<T>>,
    std::is_move_constructible<T>,
1040
    std::is_same<decltype(std::declval<make_caster<T>>().operator T&()), T&>
1041
>::value>> : std::true_type {};
1042
template <typename T, typename SFINAE = void> struct move_if_unreferenced : std::false_type {};
1043
1044
1045
1046
template <typename T> struct move_if_unreferenced<T, enable_if_t<all_of<
    move_is_plain_type<T>,
    negation<move_always<T>>,
    std::is_move_constructible<T>,
1047
    std::is_same<decltype(std::declval<make_caster<T>>().operator T&()), T&>
1048
1049
>::value>> : std::true_type {};
template <typename T> using move_never = none_of<move_always<T>, move_if_unreferenced<T>>;
1050

1051
1052
1053
1054
1055
1056
1057
1058
1059
// Detect whether returning a `type` from a cast on type's type_caster is going to result in a
// reference or pointer to a local variable of the type_caster.  Basically, only
// non-reference/pointer `type`s and reference/pointers from a type_caster_generic are safe;
// everything else returns a reference/pointer to a local variable.
template <typename type> using cast_is_temporary_value_reference = bool_constant<
    (std::is_reference<type>::value || std::is_pointer<type>::value) &&
    !std::is_base_of<type_caster_generic, make_caster<type>>::value
>;

1060
// Basic python -> C++ casting; throws if casting fails
Jason Rhinelander's avatar
Jason Rhinelander committed
1061
template <typename T, typename SFINAE> type_caster<T, SFINAE> &load_type(type_caster<T, SFINAE> &conv, const handle &handle) {
1062
1063
1064
1065
1066
    if (!conv.load(handle, true)) {
#if defined(NDEBUG)
        throw cast_error("Unable to cast Python instance to C++ type (compile in debug mode for details)");
#else
        throw cast_error("Unable to cast Python instance of type " +
1067
            (std::string) str(handle.get_type()) + " to C++ type '" + type_id<T>() + "''");
1068
1069
#endif
    }
1070
1071
    return conv;
}
1072
1073
1074
1075
1076
1077
// Wrapper around the above that also constructs and returns a type_caster
template <typename T> make_caster<T> load_type(const handle &handle) {
    make_caster<T> conv;
    load_type(conv, handle);
    return conv;
}
1078
1079
1080

NAMESPACE_END(detail)

1081
// pytype -> C++ type
1082
1083
template <typename T, detail::enable_if_t<!detail::is_pyobject<T>::value, int> = 0>
T cast(const handle &handle) {
1084
1085
    using namespace detail;
    static_assert(!cast_is_temporary_value_reference<T>::value,
1086
            "Unable to cast type to reference: value is local to type caster");
1087
    return cast_op<T>(load_type<T>(handle));
Wenzel Jakob's avatar
Wenzel Jakob committed
1088
1089
}

1090
// pytype -> pytype (calls converting constructor)
1091
template <typename T, detail::enable_if_t<detail::is_pyobject<T>::value, int> = 0>
1092
T cast(const handle &handle) { return T(reinterpret_borrow<object>(handle)); }
1093

1094
// C++ type -> py::object
1095
1096
1097
template <typename T, detail::enable_if_t<!detail::is_pyobject<T>::value, int> = 0>
object cast(const T &value, return_value_policy policy = return_value_policy::automatic_reference,
            handle parent = handle()) {
Wenzel Jakob's avatar
Wenzel Jakob committed
1098
1099
    if (policy == return_value_policy::automatic)
        policy = std::is_pointer<T>::value ? return_value_policy::take_ownership : return_value_policy::copy;
1100
1101
    else if (policy == return_value_policy::automatic_reference)
        policy = std::is_pointer<T>::value ? return_value_policy::reference : return_value_policy::copy;
1102
    return reinterpret_steal<object>(detail::make_caster<T>::cast(value, policy, parent));
Wenzel Jakob's avatar
Wenzel Jakob committed
1103
1104
}

Wenzel Jakob's avatar
Wenzel Jakob committed
1105
template <typename T> T handle::cast() const { return pybind11::cast<T>(*this); }
1106
template <> inline void handle::cast() const { return; }
Wenzel Jakob's avatar
Wenzel Jakob committed
1107

1108
template <typename T>
1109
detail::enable_if_t<!detail::move_never<T>::value, T> move(object &&obj) {
1110
1111
1112
1113
1114
    if (obj.ref_count() > 1)
#if defined(NDEBUG)
        throw cast_error("Unable to cast Python instance to C++ rvalue: instance has multiple references"
            " (compile in debug mode for details)");
#else
1115
        throw cast_error("Unable to move from Python " + (std::string) str(obj.get_type()) +
1116
1117
1118
1119
                " instance to C++ " + type_id<T>() + " instance: instance has multiple references");
#endif

    // Move into a temporary and return that, because the reference may be a local value of `conv`
1120
    T ret = std::move(detail::load_type<T>(obj).operator T&());
1121
1122
1123
1124
1125
1126
1127
1128
    return ret;
}

// Calling cast() on an rvalue calls pybind::cast with the object rvalue, which does:
// - If we have to move (because T has no copy constructor), do it.  This will fail if the moved
//   object has multiple references, but trying to copy will fail to compile.
// - If both movable and copyable, check ref count: if 1, move; otherwise copy
// - Otherwise (not movable), copy.
1129
template <typename T> detail::enable_if_t<detail::move_always<T>::value, T> cast(object &&object) {
1130
1131
    return move<T>(std::move(object));
}
1132
template <typename T> detail::enable_if_t<detail::move_if_unreferenced<T>::value, T> cast(object &&object) {
1133
1134
1135
1136
1137
    if (object.ref_count() > 1)
        return cast<T>(object);
    else
        return move<T>(std::move(object));
}
1138
template <typename T> detail::enable_if_t<detail::move_never<T>::value, T> cast(object &&object) {
1139
1140
1141
1142
1143
1144
1145
1146
    return cast<T>(object);
}

template <typename T> T object::cast() const & { return pybind11::cast<T>(*this); }
template <typename T> T object::cast() && { return pybind11::cast<T>(std::move(*this)); }
template <> inline void object::cast() const & { return; }
template <> inline void object::cast() && { return; }

1147
1148
NAMESPACE_BEGIN(detail)

1149
1150
1151
1152
// Declared in pytypes.h:
template <typename T, enable_if_t<!is_pyobject<T>::value, int>>
object object_or_cast(T &&o) { return pybind11::cast(std::forward<T>(o)); }

1153
1154
1155
struct overload_unused {}; // Placeholder type for the unneeded (and dead code) static variable in the OVERLOAD_INT macro
template <typename ret_type> using overload_caster_t = conditional_t<
    cast_is_temporary_value_reference<ret_type>::value, make_caster<ret_type>, overload_unused>;
1156
1157
1158

// Trampoline use: for reference/pointer types to value-converted values, we do a value cast, then
// store the result in the given variable.  For other types, this is a no-op.
1159
template <typename T> enable_if_t<cast_is_temporary_value_reference<T>::value, T> cast_ref(object &&o, make_caster<T> &caster) {
1160
    return cast_op<T>(load_type(caster, o));
1161
}
1162
template <typename T> enable_if_t<!cast_is_temporary_value_reference<T>::value, T> cast_ref(object &&, overload_unused &) {
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
    pybind11_fail("Internal error: cast_ref fallback invoked"); }

// Trampoline use: Having a pybind11::cast with an invalid reference type is going to static_assert, even
// though if it's in dead code, so we provide a "trampoline" to pybind11::cast that only does anything in
// cases where pybind11::cast is valid.
template <typename T> enable_if_t<!cast_is_temporary_value_reference<T>::value, T> cast_safe(object &&o) {
    return pybind11::cast<T>(std::move(o)); }
template <typename T> enable_if_t<cast_is_temporary_value_reference<T>::value, T> cast_safe(object &&) {
    pybind11_fail("Internal error: cast_safe fallback invoked"); }
template <> inline void cast_safe<void>(object &&) {}

NAMESPACE_END(detail)
1175

1176
template <return_value_policy policy = return_value_policy::automatic_reference,
Wenzel Jakob's avatar
Wenzel Jakob committed
1177
          typename... Args> tuple make_tuple(Args&&... args_) {
Wenzel Jakob's avatar
Wenzel Jakob committed
1178
    const size_t size = sizeof...(Args);
Wenzel Jakob's avatar
Wenzel Jakob committed
1179
    std::array<object, size> args {
1180
1181
        { reinterpret_steal<object>(detail::make_caster<Args>::cast(
            std::forward<Args>(args_), policy, nullptr))... }
Wenzel Jakob's avatar
Wenzel Jakob committed
1182
    };
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
    for (auto &arg_value : args) {
        if (!arg_value) {
#if defined(NDEBUG)
            throw cast_error("make_tuple(): unable to convert arguments to Python object (compile in debug mode for details)");
#else
            throw cast_error("make_tuple(): unable to convert arguments of types '" +
                (std::string) type_id<std::tuple<Args...>>() + "' to Python object");
#endif
        }
    }
1193
    tuple result(size);
Wenzel Jakob's avatar
Wenzel Jakob committed
1194
    int counter = 0;
Wenzel Jakob's avatar
Wenzel Jakob committed
1195
    for (auto &arg_value : args)
1196
1197
1198
1199
        PyTuple_SET_ITEM(result.ptr(), counter++, arg_value.release().ptr());
    return result;
}

1200
/// \ingroup annotations
1201
1202
/// Annotation for keyword arguments
struct arg {
1203
    /// Set the name of the argument
1204
    constexpr explicit arg(const char *name) : name(name) { }
1205
    /// Assign a value to this argument
1206
1207
1208
1209
1210
    template <typename T> arg_v operator=(T &&value) const;

    const char *name;
};

1211
/// \ingroup annotations
1212
1213
1214
1215
1216
/// Annotation for keyword arguments with values
struct arg_v : arg {
    template <typename T>
    arg_v(const char *name, T &&x, const char *descr = nullptr)
        : arg(name),
1217
1218
1219
          value(reinterpret_steal<object>(
              detail::make_caster<T>::cast(x, return_value_policy::automatic, {})
          )),
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
          descr(descr)
#if !defined(NDEBUG)
        , type(type_id<T>())
#endif
    { }

    object value;
    const char *descr;
#if !defined(NDEBUG)
    std::string type;
#endif
};

template <typename T>
arg_v arg::operator=(T &&value) const { return {name, std::forward<T>(value)}; }

Wenzel Jakob's avatar
Wenzel Jakob committed
1236
/// Alias for backward compatibility -- to be removed in version 2.0
1237
1238
1239
template <typename /*unused*/> using arg_t = arg_v;

inline namespace literals {
1240
1241
1242
/** \rst
    String literal version of `arg`
 \endrst */
1243
1244
1245
constexpr arg operator"" _a(const char *name, size_t) { return arg(name); }
}

1246
NAMESPACE_BEGIN(detail)
1247

1248
1249
1250
// forward declaration
struct function_record;

1251
1252
1253
/// Helper class which loads arguments for C++ functions called from Python
template <typename... Args>
class argument_loader {
1254
    using indices = make_index_sequence<sizeof...(Args)>;
1255
    using function_arguments = const std::vector<handle> &;
1256

1257
1258
1259
1260
1261
1262
1263
1264
1265
    template <typename Arg> using argument_is_args   = std::is_same<intrinsic_t<Arg>, args>;
    template <typename Arg> using argument_is_kwargs = std::is_same<intrinsic_t<Arg>, kwargs>;
    // Get args/kwargs argument positions relative to the end of the argument list:
    static constexpr auto args_pos = constexpr_first<argument_is_args, Args...>() - (int) sizeof...(Args),
                        kwargs_pos = constexpr_first<argument_is_kwargs, Args...>() - (int) sizeof...(Args);

    static constexpr bool args_kwargs_are_last = kwargs_pos >= - 1 && args_pos >= kwargs_pos - 1;

    static_assert(args_kwargs_are_last, "py::args/py::kwargs are only permitted as the last argument(s) of a function");
Jason Rhinelander's avatar
Jason Rhinelander committed
1266

1267
public:
1268
1269
    static constexpr bool has_kwargs = kwargs_pos < 0;
    static constexpr bool has_args = args_pos < 0;
1270
1271
1272

    static PYBIND11_DESCR arg_names() { return detail::concat(make_caster<Args>::name()...); }

1273
1274
    bool load_args(function_arguments args) {
        return load_impl_sequence(args, indices{});
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
    }

    template <typename Return, typename Func>
    enable_if_t<!std::is_void<Return>::value, Return> call(Func &&f) {
        return call_impl<Return>(std::forward<Func>(f), indices{});
    }

    template <typename Return, typename Func>
    enable_if_t<std::is_void<Return>::value, void_type> call(Func &&f) {
        call_impl<Return>(std::forward<Func>(f), indices{});
        return void_type();
    }

private:

1290
    static bool load_impl_sequence(function_arguments, index_sequence<>) { return true; }
1291
1292

    template <size_t... Is>
1293
1294
    bool load_impl_sequence(function_arguments args, index_sequence<Is...>) {
        for (bool r : {std::get<Is>(value).load(args[Is], true)...})
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
            if (!r)
                return false;
        return true;
    }

    template <typename Return, typename Func, size_t... Is>
    Return call_impl(Func &&f, index_sequence<Is...>) {
        return std::forward<Func>(f)(cast_op<Args>(std::get<Is>(value))...);
    }

    std::tuple<make_caster<Args>...> value;
};

1308
1309
1310
1311
1312
1313
/// Helper class which collects only positional arguments for a Python function call.
/// A fancier version below can collect any argument, but this one is optimal for simple calls.
template <return_value_policy policy>
class simple_collector {
public:
    template <typename... Ts>
1314
    explicit simple_collector(Ts &&...values)
1315
1316
1317
1318
1319
1320
1321
1322
1323
        : m_args(pybind11::make_tuple<policy>(std::forward<Ts>(values)...)) { }

    const tuple &args() const & { return m_args; }
    dict kwargs() const { return {}; }

    tuple args() && { return std::move(m_args); }

    /// Call a Python function and pass the collected arguments
    object call(PyObject *ptr) const {
1324
        PyObject *result = PyObject_CallObject(ptr, m_args.ptr());
1325
1326
        if (!result)
            throw error_already_set();
1327
        return reinterpret_steal<object>(result);
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
    }

private:
    tuple m_args;
};

/// Helper class which collects positional, keyword, * and ** arguments for a Python function call
template <return_value_policy policy>
class unpacking_collector {
public:
    template <typename... Ts>
1339
    explicit unpacking_collector(Ts &&...values) {
1340
1341
1342
1343
1344
1345
        // Tuples aren't (easily) resizable so a list is needed for collection,
        // but the actual function call strictly requires a tuple.
        auto args_list = list();
        int _[] = { 0, (process(args_list, std::forward<Ts>(values)), 0)... };
        ignore_unused(_);

1346
        m_args = std::move(args_list);
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
    }

    const tuple &args() const & { return m_args; }
    const dict &kwargs() const & { return m_kwargs; }

    tuple args() && { return std::move(m_args); }
    dict kwargs() && { return std::move(m_kwargs); }

    /// Call a Python function and pass the collected arguments
    object call(PyObject *ptr) const {
1357
        PyObject *result = PyObject_Call(ptr, m_args.ptr(), m_kwargs.ptr());
1358
1359
        if (!result)
            throw error_already_set();
1360
        return reinterpret_steal<object>(result);
1361
1362
1363
1364
1365
    }

private:
    template <typename T>
    void process(list &args_list, T &&x) {
1366
        auto o = reinterpret_steal<object>(detail::make_caster<T>::cast(std::forward<T>(x), policy, {}));
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
        if (!o) {
#if defined(NDEBUG)
            argument_cast_error();
#else
            argument_cast_error(std::to_string(args_list.size()), type_id<T>());
#endif
        }
        args_list.append(o);
    }

    void process(list &args_list, detail::args_proxy ap) {
1378
        for (const auto &a : ap)
1379
            args_list.append(a);
1380
1381
    }

1382
    void process(list &/*args_list*/, arg_v a) {
1383
        if (m_kwargs.contains(a.name)) {
1384
1385
1386
1387
1388
1389
#if defined(NDEBUG)
            multiple_values_error();
#else
            multiple_values_error(a.name);
#endif
        }
1390
        if (!a.value) {
1391
1392
1393
#if defined(NDEBUG)
            argument_cast_error();
#else
1394
            argument_cast_error(a.name, a.type);
1395
1396
#endif
        }
1397
        m_kwargs[a.name] = a.value;
1398
1399
1400
    }

    void process(list &/*args_list*/, detail::kwargs_proxy kp) {
1401
1402
        if (!kp)
            return;
1403
        for (const auto &k : reinterpret_borrow<dict>(kp)) {
1404
            if (m_kwargs.contains(k.first)) {
1405
1406
1407
#if defined(NDEBUG)
                multiple_values_error();
#else
1408
                multiple_values_error(str(k.first));
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
#endif
            }
            m_kwargs[k.first] = k.second;
        }
    }

    [[noreturn]] static void multiple_values_error() {
        throw type_error("Got multiple values for keyword argument "
                         "(compile in debug mode for details)");
    }

    [[noreturn]] static void multiple_values_error(std::string name) {
        throw type_error("Got multiple values for keyword argument '" + name + "'");
    }

    [[noreturn]] static void argument_cast_error() {
        throw cast_error("Unable to convert call argument to Python object "
                         "(compile in debug mode for details)");
    }

    [[noreturn]] static void argument_cast_error(std::string name, std::string type) {
        throw cast_error("Unable to convert call argument '" + name
                         + "' of type '" + type + "' to Python object");
    }

private:
    tuple m_args;
    dict m_kwargs;
};

/// Collect only positional arguments for a Python function call
template <return_value_policy policy, typename... Args,
1441
          typename = enable_if_t<all_of<is_positional<Args>...>::value>>
1442
simple_collector<policy> collect_arguments(Args &&...args) {
1443
    return simple_collector<policy>(std::forward<Args>(args)...);
1444
1445
1446
1447
}

/// Collect all arguments, including keywords and unpacking (only instantiated when needed)
template <return_value_policy policy, typename... Args,
1448
          typename = enable_if_t<!all_of<is_positional<Args>...>::value>>
1449
1450
1451
1452
1453
1454
1455
1456
unpacking_collector<policy> collect_arguments(Args &&...args) {
    // Following argument order rules for generalized unpacking according to PEP 448
    static_assert(
        constexpr_last<is_positional, Args...>() < constexpr_first<is_keyword_or_ds, Args...>()
        && constexpr_last<is_s_unpacking, Args...>() < constexpr_first<is_ds_unpacking, Args...>(),
        "Invalid function call: positional args must precede keywords and ** unpacking; "
        "* unpacking must precede ** unpacking"
    );
1457
    return unpacking_collector<policy>(std::forward<Args>(args)...);
1458
1459
}

1460
template <typename Derived>
1461
template <return_value_policy policy, typename... Args>
1462
1463
object object_api<Derived>::operator()(Args &&...args) const {
    return detail::collect_arguments<policy>(std::forward<Args>(args)...).call(derived().ptr());
Wenzel Jakob's avatar
Wenzel Jakob committed
1464
1465
}

1466
1467
1468
template <typename Derived>
template <return_value_policy policy, typename... Args>
object object_api<Derived>::call(Args &&...args) const {
1469
    return operator()<policy>(std::forward<Args>(args)...);
1470
1471
}

1472
1473
NAMESPACE_END(detail)

Wenzel Jakob's avatar
Wenzel Jakob committed
1474
1475
1476
1477
1478
#define PYBIND11_MAKE_OPAQUE(Type) \
    namespace pybind11 { namespace detail { \
        template<> class type_caster<Type> : public type_caster_base<Type> { }; \
    }}

1479
NAMESPACE_END(pybind11)