cast.h 57 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;
Wenzel Jakob's avatar
Wenzel Jakob committed
35
};
36

Wenzel Jakob's avatar
Wenzel Jakob committed
37
38
39
40
41
PYBIND11_NOINLINE inline internals &get_internals() {
    static internals *internals_ptr = nullptr;
    if (internals_ptr)
        return *internals_ptr;
    handle builtins(PyEval_GetBuiltins());
42
    const char *id = PYBIND11_INTERNALS_ID;
43
44
    if (builtins.contains(id) && isinstance<capsule>(builtins[id])) {
        internals_ptr = capsule(builtins[id]);
Wenzel Jakob's avatar
Wenzel Jakob committed
45
46
    } else {
        internals_ptr = new internals();
47
48
49
50
51
52
53
        #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
54
        builtins[id] = capsule(internals_ptr);
55
56
57
58
        internals_ptr->registered_exception_translators.push_front(
            [](std::exception_ptr p) -> void {
                try {
                    if (p) std::rethrow_exception(p);
59
                } catch (error_already_set &e)           { e.restore();                                    return;
60
                } catch (const builtin_exception &e)     { e.set_error();                                  return;
61
62
63
64
65
66
67
68
69
70
71
72
73
                } 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
74
75
76
77
    }
    return *internals_ptr;
}

Wenzel Jakob's avatar
Wenzel Jakob committed
78
PYBIND11_NOINLINE inline detail::type_info* get_type_info(PyTypeObject *type) {
Wenzel Jakob's avatar
Wenzel Jakob committed
79
80
81
82
83
84
    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
85
        if (!type)
86
            return nullptr;
Wenzel Jakob's avatar
Wenzel Jakob committed
87
88
89
    } while (true);
}

90
91
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
92
93
    auto &types = get_internals().registered_types_cpp;

94
95
    auto it = types.find(std::type_index(tp));
    if (it != types.end())
Wenzel Jakob's avatar
Wenzel Jakob committed
96
        return (detail::type_info *) it->second;
Wenzel Jakob's avatar
Wenzel Jakob committed
97
98
99
100
101
    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
102
103
104
    return nullptr;
}

Wenzel Jakob's avatar
Wenzel Jakob committed
105
106
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
107
108
109
    return handle(type_info ? ((PyObject *) type_info->type) : nullptr);
}

110
111
112
113
114
115
116
117
118
119
120
PYBIND11_NOINLINE inline bool isinstance_generic(handle obj, const std::type_info &tp) {
    const auto type = detail::get_type_handle(tp, false);
    if (!type)
        return false;

    const auto result = PyObject_IsInstance(obj.ptr(), type.ptr());
    if (result == -1)
        throw error_already_set();
    return result != 0;
}

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

Wenzel Jakob's avatar
Wenzel Jakob committed
127
    error_scope scope; // Preserve error state
Wenzel Jakob's avatar
Wenzel Jakob committed
128

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

137
138
    PyErr_NormalizeException(&scope.type, &scope.value, &scope.trace);

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

144
    if (scope.trace) {
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
        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;
160
        }
161
        trace = trace->tb_next;
162
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
179
180
181
182
183
184
185
186
187
188
189
inline PyThreadState *get_thread_state_unchecked() {
#if   PY_VERSION_HEX < 0x03000000
    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
}

190
191
192
// Forward declaration
inline void keep_alive_impl(handle nurse, handle patient);

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

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

    bool load(handle src, bool convert, PyTypeObject *tobj) {
Wenzel Jakob's avatar
Wenzel Jakob committed
205
        if (!src || !typeinfo)
Wenzel Jakob's avatar
Wenzel Jakob committed
206
            return false;
207
        if (src.is_none()) {
208
209
            value = nullptr;
            return true;
Wenzel Jakob's avatar
Wenzel Jakob committed
210
        }
Wenzel Jakob's avatar
Wenzel Jakob committed
211
212
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;
            bool new_style_class = PyType_Check(tobj);
            if (type_dict.find(tobj) == type_dict.end() && new_style_class && tobj->tp_bases) {
229
                auto parents = reinterpret_borrow<tuple>(tobj->tp_bases);
Wenzel Jakob's avatar
Wenzel Jakob committed
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
                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
248
249
        if (convert) {
            for (auto &converter : typeinfo->implicit_conversions) {
250
                temp = reinterpret_steal<object>(converter(src.ptr(), typeinfo->type));
Wenzel Jakob's avatar
Wenzel Jakob committed
251
                if (load(temp, false))
Wenzel Jakob's avatar
Wenzel Jakob committed
252
253
                    return true;
            }
254
255
256
257
            for (auto &converter : *typeinfo->direct_conversions) {
                if (converter(src.ptr(), value))
                    return true;
            }
Wenzel Jakob's avatar
Wenzel Jakob committed
258
259
260
261
        }
        return false;
    }

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

272
        auto &internals = get_internals();
Wenzel Jakob's avatar
Wenzel Jakob committed
273

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

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

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

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

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

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

301
302
303
304
        wrapper->value = nullptr;
        wrapper->owned = false;

        switch (policy) {
Wenzel Jakob's avatar
Wenzel Jakob committed
305
306
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
            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
345
        }
Wenzel Jakob's avatar
Wenzel Jakob committed
346
347

        tinfo->init_holder(inst.ptr(), existing_holder);
348
349

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

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

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

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

366
367
368
369
370
371
372
373
374
375
376
377
// 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> {};

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

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

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

393
394
    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
395
396
    }

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

403
404
    template <typename T> using cast_op_type = pybind11::detail::cast_op_type<T>;

405
406
    operator itype*() { return (type *) value; }
    operator itype&() { if (!value) throw reference_cast_error(); return *((itype *) value); }
407

408
protected:
409
410
411
412
    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. */
413
    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)) {
414
415
416
417
418
419
        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. */
420
    template <typename T = type, typename = enable_if_t<is_copy_constructible<T>::value>>
421
422
    static Constructor make_copy_constructor(const T *value) {
        return [](const void *arg) -> void * { return new T(*((const T *)arg)); }; }
423
    template <typename T = type, typename = enable_if_t<std::is_move_constructible<T>::value>>
424
425
426
    static Constructor make_move_constructor(const T *value) {
        return [](const void *arg) -> void * { return (void *) new T(std::move(*((T *)arg))); }; }
#endif
427

428
429
    static Constructor make_copy_constructor(...) { return nullptr; }
    static Constructor make_move_constructor(...) { return nullptr; }
430
431
};

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

435
// Shortcut for calling a caster's `cast_op_type` cast operator for casting a type_caster to a T
436
template <typename T> typename make_caster<T>::template cast_op_type<T> cast_op(make_caster<T> &caster) {
437
438
    return caster.operator typename make_caster<T>::template cast_op_type<T>();
}
439
template <typename T> typename make_caster<T>::template cast_op_type<T> cast_op(make_caster<T> &&caster) {
440
441
442
    return cast_op<T>(caster);
}

Wenzel Jakob's avatar
Wenzel Jakob committed
443
template <typename type> class type_caster<std::reference_wrapper<type>> : public type_caster_base<type> {
444
445
public:
    static handle cast(const std::reference_wrapper<type> &src, return_value_policy policy, handle parent) {
Wenzel Jakob's avatar
Wenzel Jakob committed
446
        return type_caster_base<type>::cast(&src.get(), policy, parent);
447
    }
448
449
    template <typename T> using cast_op_type = std::reference_wrapper<type>;
    operator std::reference_wrapper<type>() { return std::ref(*((type *) this->value)); }
450
451
};

452
#define PYBIND11_TYPE_CASTER(type, py_name) \
Wenzel Jakob's avatar
Wenzel Jakob committed
453
454
455
    protected: \
        type value; \
    public: \
456
        static PYBIND11_DESCR name() { return type_descr(py_name); } \
Wenzel Jakob's avatar
Wenzel Jakob committed
457
        static handle cast(const type *src, return_value_policy policy, handle parent) { \
Wenzel Jakob's avatar
Wenzel Jakob committed
458
459
460
            return cast(*src, policy, parent); \
        } \
        operator type*() { return &value; } \
461
        operator type&() { return value; } \
462
        template <typename _T> using cast_op_type = pybind11::detail::cast_op_type<_T>
Wenzel Jakob's avatar
Wenzel Jakob committed
463

464

Wenzel Jakob's avatar
Wenzel Jakob committed
465
template <typename T>
466
struct type_caster<T, enable_if_t<std::is_arithmetic<T>::value>> {
Wenzel Jakob's avatar
Wenzel Jakob committed
467
468
469
470
    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
471

Wenzel Jakob's avatar
Wenzel Jakob committed
472
    bool load(handle src, bool) {
Wenzel Jakob's avatar
Wenzel Jakob committed
473
        py_type py_value;
Wenzel Jakob's avatar
Wenzel Jakob committed
474

475
476
477
        if (!src) {
            return false;
        } if (std::is_floating_point<T>::value) {
Wenzel Jakob's avatar
Wenzel Jakob committed
478
            py_value = (py_type) PyFloat_AsDouble(src.ptr());
Wenzel Jakob's avatar
Wenzel Jakob committed
479
        } else if (sizeof(T) <= sizeof(long)) {
480
481
            if (PyFloat_Check(src.ptr()))
                return false;
Wenzel Jakob's avatar
Wenzel Jakob committed
482
            if (std::is_signed<T>::value)
Wenzel Jakob's avatar
Wenzel Jakob committed
483
                py_value = (py_type) PyLong_AsLong(src.ptr());
Wenzel Jakob's avatar
Wenzel Jakob committed
484
            else
Wenzel Jakob's avatar
Wenzel Jakob committed
485
                py_value = (py_type) PyLong_AsUnsignedLong(src.ptr());
Wenzel Jakob's avatar
Wenzel Jakob committed
486
        } else {
487
488
            if (PyFloat_Check(src.ptr()))
                return false;
Wenzel Jakob's avatar
Wenzel Jakob committed
489
            if (std::is_signed<T>::value)
Wenzel Jakob's avatar
Wenzel Jakob committed
490
                py_value = (py_type) PYBIND11_LONG_AS_LONGLONG(src.ptr());
Wenzel Jakob's avatar
Wenzel Jakob committed
491
            else
Wenzel Jakob's avatar
Wenzel Jakob committed
492
                py_value = (py_type) PYBIND11_LONG_AS_UNSIGNED_LONGLONG(src.ptr());
Wenzel Jakob's avatar
Wenzel Jakob committed
493
494
495
496
497
498
        }

        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()))) {
499
500
501
502
503
#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
504
            PyErr_Clear();
505
            if (type_error && PyNumber_Check(src.ptr())) {
506
507
508
                auto tmp = reinterpret_borrow<object>(std::is_floating_point<T>::value
                                                      ? PyNumber_Float(src.ptr())
                                                      : PyNumber_Long(src.ptr()));
509
510
511
                PyErr_Clear();
                return load(tmp, false);
            }
Wenzel Jakob's avatar
Wenzel Jakob committed
512
513
            return false;
        }
Wenzel Jakob's avatar
Wenzel Jakob committed
514

Wenzel Jakob's avatar
Wenzel Jakob committed
515
516
517
518
        value = (T) py_value;
        return true;
    }

Wenzel Jakob's avatar
Wenzel Jakob committed
519
    static handle cast(T src, return_value_policy /* policy */, handle /* parent */) {
Wenzel Jakob's avatar
Wenzel Jakob committed
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
        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);
        }
    }

535
    PYBIND11_TYPE_CASTER(T, _<std::is_integral<T>::value>("int", "float"));
Wenzel Jakob's avatar
Wenzel Jakob committed
536
};
Wenzel Jakob's avatar
Wenzel Jakob committed
537

538
template<typename T> struct void_caster {
Wenzel Jakob's avatar
Wenzel Jakob committed
539
public:
Wenzel Jakob's avatar
Wenzel Jakob committed
540
    bool load(handle, bool) { return false; }
541
    static handle cast(T, return_value_policy /* policy */, handle /* parent */) {
Wenzel Jakob's avatar
Wenzel Jakob committed
542
        return none().inc_ref();
Wenzel Jakob's avatar
Wenzel Jakob committed
543
    }
544
    PYBIND11_TYPE_CASTER(T, _("None"));
Wenzel Jakob's avatar
Wenzel Jakob committed
545
546
};

547
548
template <> class type_caster<void_type> : public void_caster<void_type> {};

549
550
551
552
553
template <> class type_caster<void> : public type_caster<void_type> {
public:
    using type_caster<void_type>::cast;

    bool load(handle h, bool) {
554
555
        if (!h) {
            return false;
556
        } else if (h.is_none()) {
557
558
559
            value = nullptr;
            return true;
        }
560
561

        /* Check if this is a capsule */
562
        if (isinstance<capsule>(h)) {
563
            value = reinterpret_borrow<capsule>(h);
564
565
566
567
            return true;
        }

        /* Check if this is a C++ type */
Wenzel Jakob's avatar
Wenzel Jakob committed
568
        if (get_type_info((PyTypeObject *) h.get_type().ptr())) {
569
570
571
572
573
574
            value = ((instance<void> *) h.ptr())->value;
            return true;
        }

        /* Fail */
        return false;
575
576
    }

Wenzel Jakob's avatar
Wenzel Jakob committed
577
    static handle cast(const void *ptr, return_value_policy /* policy */, handle /* parent */) {
578
579
580
        if (ptr)
            return capsule(ptr).release();
        else
Wenzel Jakob's avatar
Wenzel Jakob committed
581
            return none().inc_ref();
582
    }
583

584
585
    template <typename T> using cast_op_type = void*&;
    operator void *&() { return value; }
586
    static PYBIND11_DESCR name() { return type_descr(_("capsule")); }
587
private:
588
    void *value = nullptr;
589
590
};

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

Wenzel Jakob's avatar
Wenzel Jakob committed
593
594
template <> class type_caster<bool> {
public:
Wenzel Jakob's avatar
Wenzel Jakob committed
595
    bool load(handle src, bool) {
596
597
        if (!src) return false;
        else if (src.ptr() == Py_True) { value = true; return true; }
Wenzel Jakob's avatar
Wenzel Jakob committed
598
        else if (src.ptr() == Py_False) { value = false; return true; }
Wenzel Jakob's avatar
Wenzel Jakob committed
599
600
        else return false;
    }
Wenzel Jakob's avatar
Wenzel Jakob committed
601
602
    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
603
    }
604
    PYBIND11_TYPE_CASTER(bool, _("bool"));
Wenzel Jakob's avatar
Wenzel Jakob committed
605
606
607
608
};

template <> class type_caster<std::string> {
public:
Wenzel Jakob's avatar
Wenzel Jakob committed
609
    bool load(handle src, bool) {
610
        object temp;
Wenzel Jakob's avatar
Wenzel Jakob committed
611
        handle load_src = src;
612
613
614
        if (!src) {
            return false;
        } else if (PyUnicode_Check(load_src.ptr())) {
615
            temp = reinterpret_steal<object>(PyUnicode_AsUTF8String(load_src.ptr()));
616
            if (!temp) { PyErr_Clear(); return false; }  // UnicodeEncodeError
Wenzel Jakob's avatar
Wenzel Jakob committed
617
            load_src = temp;
618
619
620
        }
        char *buffer;
        ssize_t length;
Wenzel Jakob's avatar
Wenzel Jakob committed
621
        int err = PYBIND11_BYTES_AS_STRING_AND_SIZE(load_src.ptr(), &buffer, &length);
622
        if (err == -1) { PyErr_Clear(); return false; }  // TypeError
623
        value = std::string(buffer, (size_t) length);
624
        success = true;
Wenzel Jakob's avatar
Wenzel Jakob committed
625
626
        return true;
    }
627

Wenzel Jakob's avatar
Wenzel Jakob committed
628
    static handle cast(const std::string &src, return_value_policy /* policy */, handle /* parent */) {
629
        return PyUnicode_FromStringAndSize(src.c_str(), (ssize_t) src.length());
Wenzel Jakob's avatar
Wenzel Jakob committed
630
    }
631
632

    PYBIND11_TYPE_CASTER(std::string, _(PYBIND11_STRING_NAME));
633
634
protected:
    bool success = false;
Wenzel Jakob's avatar
Wenzel Jakob committed
635
636
};

637
template <typename type, typename deleter> class type_caster<std::unique_ptr<type, deleter>> {
638
public:
639
    static handle cast(std::unique_ptr<type, deleter> &&src, return_value_policy policy, handle parent) {
Wenzel Jakob's avatar
Wenzel Jakob committed
640
        handle result = type_caster_base<type>::cast(src.get(), policy, parent);
641
642
643
644
        if (result)
            src.release();
        return result;
    }
Wenzel Jakob's avatar
Wenzel Jakob committed
645
    static PYBIND11_DESCR name() { return type_caster_base<type>::name(); }
646
647
};

hulucc's avatar
hulucc committed
648
template <> class type_caster<std::wstring> {
Wenzel Jakob's avatar
Wenzel Jakob committed
649
public:
Wenzel Jakob's avatar
Wenzel Jakob committed
650
651
652
    bool load(handle src, bool) {
        object temp;
        handle load_src = src;
653
654
655
        if (!src) {
            return false;
        } else if (!PyUnicode_Check(load_src.ptr())) {
656
            temp = reinterpret_steal<object>(PyUnicode_FromObject(load_src.ptr()));
Wenzel Jakob's avatar
Wenzel Jakob committed
657
658
659
            if (!temp) { PyErr_Clear(); return false; }
            load_src = temp;
        }
660
661
662
663
664
        wchar_t *buffer = nullptr;
        ssize_t length = -1;
#if PY_MAJOR_VERSION >= 3
        buffer = PyUnicode_AsWideCharString(load_src.ptr(), &length);
#else
665
        temp = reinterpret_steal<object>(
666
667
            sizeof(wchar_t) == sizeof(short)
                ? PyUnicode_AsUTF16String(load_src.ptr())
668
                : PyUnicode_AsUTF32String(load_src.ptr()));
669
670
671
        if (temp) {
            int err = PYBIND11_BYTES_AS_STRING_AND_SIZE(temp.ptr(), (char **) &buffer, &length);
            if (err == -1) { buffer = nullptr; }  // TypeError
672
            length = length / (ssize_t) sizeof(wchar_t) - 1; ++buffer; // Skip BOM
673
        }
674
675
#endif
        if (!buffer) { PyErr_Clear(); return false; }
676
        value = std::wstring(buffer, (size_t) length);
Wenzel Jakob's avatar
Wenzel Jakob committed
677
678
679
        success = true;
        return true;
    }
hulucc's avatar
hulucc committed
680

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

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

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

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

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

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

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

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

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

Wenzel Jakob's avatar
Wenzel Jakob committed
725
726
727
728
    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
729

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

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

Wenzel Jakob's avatar
Wenzel Jakob committed
736
737
738
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
739
    bool load(handle src, bool convert) {
740
        if (!isinstance<sequence>(src))
741
            return false;
742
743
        const auto seq = reinterpret_borrow<sequence>(src);
        if (seq.size() != 2)
Wenzel Jakob's avatar
Wenzel Jakob committed
744
            return false;
745
        return first.load(seq[0], convert) && second.load(seq[1], convert);
Wenzel Jakob's avatar
Wenzel Jakob committed
746
747
    }

Wenzel Jakob's avatar
Wenzel Jakob committed
748
    static handle cast(const type &src, return_value_policy policy, handle parent) {
749
750
        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));
751
        if (!o1 || !o2)
Wenzel Jakob's avatar
Wenzel Jakob committed
752
753
754
755
756
            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
757
758
    }

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

765
766
    template <typename T> using cast_op_type = type;

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

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

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

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

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

798
799
    template <typename T> using cast_op_type = type;

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

Wenzel Jakob's avatar
Wenzel Jakob committed
802
protected:
803
804
    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
805

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

808
    template <size_t... Is>
809
810
    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
811
812
813
814
815
            if (!r)
                return false;
        return true;
    }

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

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

835
    std::tuple<make_caster<Tuple>...> value;
Wenzel Jakob's avatar
Wenzel Jakob committed
836
837
838
};

/// Type caster for holder types like std::shared_ptr, etc.
Wenzel Jakob's avatar
Wenzel Jakob committed
839
template <typename type, typename holder_type> class type_caster_holder : public type_caster_base<type> {
Wenzel Jakob's avatar
Wenzel Jakob committed
840
public:
Wenzel Jakob's avatar
Wenzel Jakob committed
841
842
843
844
845
846
    using base = type_caster_base<type>;
    using base::base;
    using base::cast;
    using base::typeinfo;
    using base::value;
    using base::temp;
847

Wenzel Jakob's avatar
Wenzel Jakob committed
848
849
850
851
852
853
    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
854
            return false;
Wenzel Jakob's avatar
Wenzel Jakob committed
855
        if (src.is_none()) {
856
857
            value = nullptr;
            return true;
Wenzel Jakob's avatar
Wenzel Jakob committed
858
859
860
861
        }

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

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

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

885
886
        if (convert) {
            for (auto &converter : typeinfo->implicit_conversions) {
887
                temp = reinterpret_steal<object>(converter(src.ptr(), typeinfo->type));
Wenzel Jakob's avatar
Wenzel Jakob committed
888
                if (load(temp, false))
889
890
891
                    return true;
            }
        }
Wenzel Jakob's avatar
Wenzel Jakob committed
892
893
894
895

        return false;
    }

896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
    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
912
913
914
915
916
917
918
919
920
921
922
923
924
    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) {
            type_caster_holder sub_caster(*cast.first);
            if (sub_caster.load(src, convert)) {
                value = cast.second(sub_caster.value);
                holder = holder_type(sub_caster.holder, (type *) value);
                return true;
            }
        }
925
        return false;
Wenzel Jakob's avatar
Wenzel Jakob committed
926
    }
927

Wenzel Jakob's avatar
Wenzel Jakob committed
928
929
930
    explicit operator type*() { return this->value; }
    explicit operator type&() { return *(this->value); }
    explicit operator holder_type*() { return &holder; }
931

932
933
934
935
936
937
938
939
    // 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

940
    static handle cast(const holder_type &src, return_value_policy, handle) {
941
        return type_caster_generic::cast(
942
            src.get(), return_value_policy::take_ownership, handle(),
943
            src.get() ? &typeid(*src.get()) : nullptr, &typeid(type),
944
            nullptr, nullptr, &src);
945
946
    }

Wenzel Jakob's avatar
Wenzel Jakob committed
947
948
949
950
protected:
    holder_type holder;
};

951
952
953
954
955
956
957
958
959
960
961
962
/// Specialize for the common std::shared_ptr, so users don't need to
template <typename T>
class type_caster<std::shared_ptr<T>> : public type_caster_holder<T, std::shared_ptr<T>> { };

/// Create a specialization for custom holder types (silently ignores std::shared_ptr)
#define PYBIND11_DECLARE_HOLDER_TYPE(type, holder_type) \
    namespace pybind11 { namespace detail { \
    template <typename type> \
    class type_caster<holder_type, enable_if_t<!is_shared_ptr<holder_type>::value>> \
        : public type_caster_holder<type, holder_type> { }; \
    }}

963
// PYBIND11_DECLARE_HOLDER_TYPE holder types:
964
template <typename base, typename holder> struct is_holder_type :
965
966
967
968
    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 {};
969

970
971
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); } };
972
973
template <> struct handle_type_name<args> { static PYBIND11_DESCR name() { return _("*args"); } };
template <> struct handle_type_name<kwargs> { static PYBIND11_DESCR name() { return _("**kwargs"); } };
974

975
template <typename type>
976
977
978
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); }
979

980
    template <typename T = type, enable_if_t<std::is_base_of<object, T>::value, int> = 0>
981
982
983
    bool load(handle src, bool /* convert */) {
        if (!isinstance<type>(src))
            return false;
984
        value = reinterpret_borrow<type>(src);
985
986
        return true;
    }
987

Wenzel Jakob's avatar
Wenzel Jakob committed
988
989
    static handle cast(const handle &src, return_value_policy /* policy */, handle /* parent */) {
        return src.inc_ref();
Wenzel Jakob's avatar
Wenzel Jakob committed
990
    }
991
    PYBIND11_TYPE_CASTER(type, handle_type_name<type>::name());
Wenzel Jakob's avatar
Wenzel Jakob committed
992
993
};

994
995
996
template <typename T>
class type_caster<T, enable_if_t<is_pyobject<T>::value>> : public pyobject_caster<T> { };

997
998
999
1000
1001
1002
1003
1004
1005
1006
// 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.
template <typename T, typename SFINAE = void> struct move_is_plain_type : std::false_type {};
1007
template <typename T> struct move_is_plain_type<T, enable_if_t<
1008
        !std::is_void<T>::value && !std::is_pointer<T>::value && !std::is_reference<T>::value && !std::is_const<T>::value
1009
    >> : std::true_type { };
1010
template <typename T, typename SFINAE = void> struct move_always : std::false_type {};
1011
template <typename T> struct move_always<T, enable_if_t<
1012
1013
1014
        move_is_plain_type<T>::value &&
        !std::is_copy_constructible<T>::value && std::is_move_constructible<T>::value &&
        std::is_same<decltype(std::declval<type_caster<T>>().operator T&()), T&>::value
1015
    >> : std::true_type { };
1016
template <typename T, typename SFINAE = void> struct move_if_unreferenced : std::false_type {};
1017
template <typename T> struct move_if_unreferenced<T, enable_if_t<
1018
1019
1020
        move_is_plain_type<T>::value &&
        !move_always<T>::value && std::is_move_constructible<T>::value &&
        std::is_same<decltype(std::declval<type_caster<T>>().operator T&()), T&>::value
1021
    >> : std::true_type { };
1022
1023
template <typename T> using move_never = std::integral_constant<bool, !move_always<T>::value && !move_if_unreferenced<T>::value>;

1024
1025
1026
1027
1028
1029
1030
1031
1032
// 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
>;

1033
// Basic python -> C++ casting; throws if casting fails
Jason Rhinelander's avatar
Jason Rhinelander committed
1034
template <typename T, typename SFINAE> type_caster<T, SFINAE> &load_type(type_caster<T, SFINAE> &conv, const handle &handle) {
1035
1036
1037
1038
1039
    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 " +
1040
            (std::string) str(handle.get_type()) + " to C++ type '" + type_id<T>() + "''");
1041
1042
#endif
    }
1043
1044
    return conv;
}
1045
1046
1047
1048
1049
1050
// 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;
}
1051
1052
1053

NAMESPACE_END(detail)

1054
// pytype -> C++ type
1055
1056
template <typename T, detail::enable_if_t<!detail::is_pyobject<T>::value, int> = 0>
T cast(const handle &handle) {
1057
1058
    using namespace detail;
    static_assert(!cast_is_temporary_value_reference<T>::value,
1059
            "Unable to cast type to reference: value is local to type caster");
1060
    return cast_op<T>(load_type<T>(handle));
Wenzel Jakob's avatar
Wenzel Jakob committed
1061
1062
}

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

1067
// C++ type -> py::object
1068
1069
1070
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
1071
1072
    if (policy == return_value_policy::automatic)
        policy = std::is_pointer<T>::value ? return_value_policy::take_ownership : return_value_policy::copy;
1073
1074
    else if (policy == return_value_policy::automatic_reference)
        policy = std::is_pointer<T>::value ? return_value_policy::reference : return_value_policy::copy;
1075
    return reinterpret_steal<object>(detail::make_caster<T>::cast(value, policy, parent));
Wenzel Jakob's avatar
Wenzel Jakob committed
1076
1077
}

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

1081
template <typename T>
1082
detail::enable_if_t<detail::move_always<T>::value || detail::move_if_unreferenced<T>::value, T> move(object &&obj) {
1083
1084
1085
1086
1087
    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
1088
        throw cast_error("Unable to move from Python " + (std::string) str(obj.get_type()) +
1089
1090
1091
1092
                " 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`
1093
    T ret = std::move(detail::load_type<T>(obj).operator T&());
1094
1095
1096
1097
1098
1099
1100
1101
    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.
1102
template <typename T> detail::enable_if_t<detail::move_always<T>::value, T> cast(object &&object) {
1103
1104
    return move<T>(std::move(object));
}
1105
template <typename T> detail::enable_if_t<detail::move_if_unreferenced<T>::value, T> cast(object &&object) {
1106
1107
1108
1109
1110
    if (object.ref_count() > 1)
        return cast<T>(object);
    else
        return move<T>(std::move(object));
}
1111
template <typename T> detail::enable_if_t<detail::move_never<T>::value, T> cast(object &&object) {
1112
1113
1114
1115
1116
1117
1118
1119
    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; }

1120
1121
NAMESPACE_BEGIN(detail)

1122
1123
1124
1125
// 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)); }

1126
1127
1128
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>;
1129
1130
1131

// 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.
1132
template <typename T> enable_if_t<cast_is_temporary_value_reference<T>::value, T> cast_ref(object &&o, make_caster<T> &caster) {
1133
    return cast_op<T>(load_type(caster, o));
1134
}
1135
template <typename T> enable_if_t<!cast_is_temporary_value_reference<T>::value, T> cast_ref(object &&, overload_unused &) {
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
    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)
1148

1149
template <return_value_policy policy = return_value_policy::automatic_reference,
Wenzel Jakob's avatar
Wenzel Jakob committed
1150
          typename... Args> tuple make_tuple(Args&&... args_) {
Wenzel Jakob's avatar
Wenzel Jakob committed
1151
    const size_t size = sizeof...(Args);
Wenzel Jakob's avatar
Wenzel Jakob committed
1152
    std::array<object, size> args {
1153
1154
        { reinterpret_steal<object>(detail::make_caster<Args>::cast(
            std::forward<Args>(args_), policy, nullptr))... }
Wenzel Jakob's avatar
Wenzel Jakob committed
1155
    };
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
    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
        }
    }
1166
    tuple result(size);
Wenzel Jakob's avatar
Wenzel Jakob committed
1167
    int counter = 0;
Wenzel Jakob's avatar
Wenzel Jakob committed
1168
    for (auto &arg_value : args)
1169
1170
1171
1172
        PyTuple_SET_ITEM(result.ptr(), counter++, arg_value.release().ptr());
    return result;
}

1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
/// Annotation for keyword arguments
struct arg {
    constexpr explicit arg(const char *name) : name(name) { }
    template <typename T> arg_v operator=(T &&value) const;

    const char *name;
};

/// 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),
1186
1187
1188
          value(reinterpret_steal<object>(
              detail::make_caster<T>::cast(x, return_value_policy::automatic, {})
          )),
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
          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
1205
/// Alias for backward compatibility -- to be removed in version 2.0
1206
1207
1208
1209
1210
1211
1212
template <typename /*unused*/> using arg_t = arg_v;

inline namespace literals {
/// String literal version of arg
constexpr arg operator"" _a(const char *name, size_t) { return arg(name); }
}

1213
NAMESPACE_BEGIN(detail)
1214
1215
1216
1217
1218

/// Helper class which loads arguments for C++ functions called from Python
template <typename... Args>
class argument_loader {
    using itypes = type_list<intrinsic_t<Args>...>;
1219
    using indices = make_index_sequence<sizeof...(Args)>;
1220
1221

public:
Jason Rhinelander's avatar
Jason Rhinelander committed
1222
1223
    argument_loader() : value() {} // Helps gcc-7 properly initialize value

1224
1225
1226
1227
1228
    static constexpr auto has_kwargs = std::is_same<itypes, type_list<args, kwargs>>::value;
    static constexpr auto has_args = has_kwargs || std::is_same<itypes, type_list<args>>::value;

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

1229
1230
    bool load_args(handle args, handle kwargs) {
        return load_impl(args, kwargs, itypes{});
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
    }

    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:
1245
1246
    bool load_impl(handle args_, handle, type_list<args>) {
        std::get<0>(value).load(args_, true);
1247
1248
1249
        return true;
    }

1250
1251
1252
    bool load_impl(handle args_, handle kwargs_, type_list<args, kwargs>) {
        std::get<0>(value).load(args_, true);
        std::get<1>(value).load(kwargs_, true);
1253
1254
1255
        return true;
    }

1256
1257
    bool load_impl(handle args, handle, ... /* anything else */) {
        return load_impl_sequence(args, indices{});
1258
1259
    }

1260
    static constexpr bool load_impl_sequence(handle, index_sequence<>) { return true; }
1261
1262

    template <size_t... Is>
1263
1264
    bool load_impl_sequence(handle src, index_sequence<Is...>) {
        for (bool r : {std::get<Is>(value).load(PyTuple_GET_ITEM(src.ptr(), Is), true)...})
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
            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;
};

1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
NAMESPACE_BEGIN(constexpr_impl)
/// Implementation details for constexpr functions
constexpr int first(int i) { return i; }
template <typename T, typename... Ts>
constexpr int first(int i, T v, Ts... vs) { return v ? i : first(i + 1, vs...); }

constexpr int last(int /*i*/, int result) { return result; }
template <typename T, typename... Ts>
constexpr int last(int i, int result, T v, Ts... vs) { return last(i + 1, v ? i : result, vs...); }
NAMESPACE_END(constexpr_impl)

/// Return the index of the first type in Ts which satisfies Predicate<T>
template <template<typename> class Predicate, typename... Ts>
constexpr int constexpr_first() { return constexpr_impl::first(0, Predicate<Ts>::value...); }

/// Return the index of the last type in Ts which satisfies Predicate<T>
template <template<typename> class Predicate, typename... Ts>
constexpr int constexpr_last() { return constexpr_impl::last(0, -1, Predicate<Ts>::value...); }

/// 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>
1303
    explicit simple_collector(Ts &&...values)
1304
1305
1306
1307
1308
1309
1310
1311
1312
        : 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 {
1313
        PyObject *result = PyObject_CallObject(ptr, m_args.ptr());
1314
1315
        if (!result)
            throw error_already_set();
1316
        return reinterpret_steal<object>(result);
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
    }

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>
1328
    explicit unpacking_collector(Ts &&...values) {
1329
1330
1331
1332
1333
1334
        // 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(_);

1335
        m_args = std::move(args_list);
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
    }

    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 {
1346
        PyObject *result = PyObject_Call(ptr, m_args.ptr(), m_kwargs.ptr());
1347
1348
        if (!result)
            throw error_already_set();
1349
        return reinterpret_steal<object>(result);
1350
1351
1352
1353
1354
    }

private:
    template <typename T>
    void process(list &args_list, T &&x) {
1355
        auto o = reinterpret_steal<object>(detail::make_caster<T>::cast(std::forward<T>(x), policy, {}));
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
        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) {
1367
        for (const auto &a : ap)
1368
            args_list.append(a);
1369
1370
    }

1371
    void process(list &/*args_list*/, arg_v a) {
1372
        if (m_kwargs.contains(a.name)) {
1373
1374
1375
1376
1377
1378
#if defined(NDEBUG)
            multiple_values_error();
#else
            multiple_values_error(a.name);
#endif
        }
1379
        if (!a.value) {
1380
1381
1382
#if defined(NDEBUG)
            argument_cast_error();
#else
1383
            argument_cast_error(a.name, a.type);
1384
1385
#endif
        }
1386
        m_kwargs[a.name] = a.value;
1387
1388
1389
    }

    void process(list &/*args_list*/, detail::kwargs_proxy kp) {
1390
1391
        if (!kp)
            return;
1392
        for (const auto &k : reinterpret_borrow<dict>(kp)) {
1393
            if (m_kwargs.contains(k.first)) {
1394
1395
1396
#if defined(NDEBUG)
                multiple_values_error();
#else
1397
                multiple_values_error(str(k.first));
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
#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,
          typename = enable_if_t<all_of_t<is_positional, Args...>::value>>
simple_collector<policy> collect_arguments(Args &&...args) {
1432
    return simple_collector<policy>(std::forward<Args>(args)...);
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
}

/// Collect all arguments, including keywords and unpacking (only instantiated when needed)
template <return_value_policy policy, typename... Args,
          typename = enable_if_t<!all_of_t<is_positional, Args...>::value>>
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"
    );
1446
    return unpacking_collector<policy>(std::forward<Args>(args)...);
1447
1448
}

1449
template <typename Derived>
1450
template <return_value_policy policy, typename... Args>
1451
1452
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
1453
1454
}

1455
1456
1457
template <typename Derived>
template <return_value_policy policy, typename... Args>
object object_api<Derived>::call(Args &&...args) const {
1458
    return operator()<policy>(std::forward<Args>(args)...);
1459
1460
}

1461
1462
NAMESPACE_END(detail)

Wenzel Jakob's avatar
Wenzel Jakob committed
1463
1464
1465
1466
1467
#define PYBIND11_MAKE_OPAQUE(Type) \
    namespace pybind11 { namespace detail { \
        template<> class type_caster<Type> : public type_caster_base<Type> { }; \
    }}

1468
NAMESPACE_END(pybind11)