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

    Copyright (c) 2015 Wenzel Jakob <wenzel@inf.ethz.ch>

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

10
#pragma once
Wenzel Jakob's avatar
Wenzel Jakob committed
11
12
13
14
15
16
17
18

#if defined(_MSC_VER)
#pragma warning(push)
#pragma warning(disable: 4127) // warning C4127: Conditional expression is constant
#pragma warning(disable: 4800) // warning C4800: 'int': forcing value to bool 'true' or 'false' (performance warning)
#pragma warning(disable: 4996) // warning C4996: The POSIX name for this item is deprecated. Instead, use the ISO C and C++ conformant name
#pragma warning(disable: 4100) // warning C4100: Unreferenced formal parameter
#pragma warning(disable: 4512) // warning C4512: Assignment operator was implicitly defined as deleted
19
#elif defined(__GNUG__) and !defined(__clang__)
20
21
22
23
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wunused-but-set-parameter"
#pragma GCC diagnostic ignored "-Wunused-but-set-variable"
#pragma GCC diagnostic ignored "-Wmissing-field-initializers"
Wenzel Jakob's avatar
Wenzel Jakob committed
24
25
#endif

26
#include "cast.h"
Wenzel Jakob's avatar
Wenzel Jakob committed
27

28
NAMESPACE_BEGIN(pybind11)
Wenzel Jakob's avatar
Wenzel Jakob committed
29

30
31
32
33
34
template <typename T> struct arg_t;

/// Annotation for keyword arguments
struct arg {
    arg(const char *name) : name(name) { }
Wenzel Jakob's avatar
Wenzel Jakob committed
35
    template <typename T> arg_t<T> operator=(const T &value);
36
37
38
39
40
    const char *name;
};

/// Annotation for keyword arguments with default values
template <typename T> struct arg_t : public arg {
41
42
    arg_t(const char *name, const T &value, const char *descr = nullptr)
        : arg(name), value(value), descr(descr) { }
43
    T value;
44
    const char *descr;
45
};
46

Wenzel Jakob's avatar
Wenzel Jakob committed
47
template <typename T> arg_t<T> arg::operator=(const T &value) { return arg_t<T>(name, value); }
48
49

/// Annotation for methods
Wenzel Jakob's avatar
Wenzel Jakob committed
50
struct is_method { PyObject *class_; is_method(object *o) : class_(o->ptr()) { } };
51
52
53
54
55
56
57
58
59
60

/// Annotation for documentation
struct doc { const char *value; doc(const char *value) : value(value) { } };

/// Annotation for function names
struct name { const char *value; name(const char *value) : value(value) { } };

/// Annotation for function siblings
struct sibling { PyObject *value; sibling(handle value) : value(value.ptr()) { } };

Wenzel Jakob's avatar
Wenzel Jakob committed
61
/// Wraps an arbitrary C++ function/method/lambda function/.. into a callable Python object
62
class cpp_function : public function {
Wenzel Jakob's avatar
Wenzel Jakob committed
63
private:
64
    /// Linked list of function overloads
Wenzel Jakob's avatar
Wenzel Jakob committed
65
    struct function_entry {
66
        /// Function name and user-specified documentation string
67
68
69
        char *name = nullptr, *doc = nullptr; /* why no C++ strings? They generate heavier code.. */
        /// Human-readable version of the function signature
        char *signature = nullptr;
70
        /// List of registered keyword arguments
71
72
        std::vector<detail::argument_entry> args;
        /// Pointer to lambda function which converts arguments and performs the actual call
73
74
        PyObject * (*impl) (function_entry *, PyObject *, PyObject *) = nullptr;
        /// Storage for the wrapped function pointer and captured data, if any
75
        void *data = nullptr;
76
        /// Pointer to custom destructor for 'data' (if needed)
77
        void (*free_data) (void *ptr) = nullptr;
78
        /// Return value policy associated with this function
79
        return_value_policy policy = return_value_policy::automatic;
80
81
82
83
84
        /// True if name == '__init__'
        bool is_constructor = false;
        /// Python method object
        PyMethodDef *def = nullptr;
        /// Pointer to class (if this is method)
85
        PyObject *class_ = nullptr;
86
        /// Pointer to first registered function in overload chain
87
        PyObject *sibling = nullptr;
88
        /// Pointer to next overload
Wenzel Jakob's avatar
Wenzel Jakob committed
89
90
91
        function_entry *next = nullptr;
    };

92
93
    function_entry *m_entry;

Wenzel Jakob's avatar
Wenzel Jakob committed
94
95
96
97
98
99
    /// Picks a suitable return value converter from cast.h
    template <typename T> using return_value_caster =
        detail::type_caster<typename std::conditional<
            std::is_void<T>::value, detail::void_type, typename detail::decay<T>::type>::type>;

    /// Picks a suitable argument value converter from cast.h
100
    template <typename... T> using arg_value_caster =
Wenzel Jakob's avatar
Wenzel Jakob committed
101
        detail::type_caster<typename std::tuple<T...>>;
102

103
104
    template <typename... T> static void process_extras(const std::tuple<T...> &args, function_entry *entry) {
        process_extras(args, entry, typename detail::make_index_sequence<sizeof...(T)>::type());
105
106
    }

107
    template <typename... T, size_t ... Index> static void process_extras(const std::tuple<T...> &args,
108
109
            function_entry *entry, detail::index_sequence<Index...>) {
        int unused[] = { 0, (process_extra(std::get<Index>(args), entry), 0)... };
110
111
112
        (void) unused;
    }

113
114
115
    static void process_extra(const char *doc, function_entry *entry) { entry->doc = (char *) doc; }
    static void process_extra(const pybind11::doc &d, function_entry *entry) { entry->doc = (char *) d.value; }
    static void process_extra(const pybind11::name &n, function_entry *entry) { entry->name = (char *) n.value; }
116
117
118
119
120
    static void process_extra(const pybind11::return_value_policy p, function_entry *entry) { entry->policy = p; }
    static void process_extra(const pybind11::sibling s, function_entry *entry) { entry->sibling = s.value; }
    static void process_extra(const pybind11::is_method &m, function_entry *entry) { entry->class_ = m.class_; }
    static void process_extra(const pybind11::arg &a, function_entry *entry) {
        if (entry->class_ && entry->args.empty())
121
122
            entry->args.emplace_back("self", nullptr, nullptr);
        entry->args.emplace_back(a.name, nullptr, nullptr);
123
    }
124

125
    template <typename T>
126
127
    static void process_extra(const pybind11::arg_t<T> &a, function_entry *entry) {
        if (entry->class_ && entry->args.empty())
128
            entry->args.emplace_back("self", nullptr, nullptr);
129
130

        PyObject *obj = detail::type_caster<typename detail::decay<T>::type>::cast(
131
                a.value, return_value_policy::automatic, nullptr);
132

133
134
135
136
137
138
        if (obj == nullptr)
            throw std::runtime_error("arg(): could not convert default keyword "
                                     "argument into a Python object (type not "
                                     "registered yet?)");

        entry->args.emplace_back(a.name, a.descr, obj);
139
    }
Wenzel Jakob's avatar
Wenzel Jakob committed
140
public:
141
    cpp_function() { }
Wenzel Jakob's avatar
Wenzel Jakob committed
142
143

    /// Vanilla function pointers
144
145
146
    template <typename Return, typename... Args, typename... Extra>
    cpp_function(Return (*f)(Args...), Extra&&... extra) {
        using detail::descr;
147
        m_entry = new function_entry();
148
        m_entry->data = (void *) f;
Wenzel Jakob's avatar
Wenzel Jakob committed
149

150
        typedef arg_value_caster<Args...> cast_in;
151
152
        typedef return_value_caster<Return> cast_out;

153
        m_entry->impl = [](function_entry *entry, PyObject *pyArgs, PyObject *parent) -> PyObject * {
Wenzel Jakob's avatar
Wenzel Jakob committed
154
            cast_in args;
155
            if (!args.load(pyArgs, true))
156
                return (PyObject *) 1; /* Special return code: try next overload */
157
            return cast_out::cast(args.template call<Return>((Return (*)(Args...)) entry->data), entry->policy, parent);
Wenzel Jakob's avatar
Wenzel Jakob committed
158
159
        };

160
        process_extras(std::make_tuple(std::forward<Extra>(extra)...), m_entry);
161
162
        PYBIND11_DESCR signature = cast_in::name() + detail::_(" -> ") + cast_out::name();
        initialize(signature.text(), signature.types(), sizeof...(Args));
Wenzel Jakob's avatar
Wenzel Jakob committed
163
164
165
    }

    /// Delegating helper constructor to deal with lambda functions
166
167
    template <typename Func, typename... Extra> cpp_function(Func &&f, Extra&&... extra) {
        initialize(std::forward<Func>(f),
Wenzel Jakob's avatar
Wenzel Jakob committed
168
                   (typename detail::remove_class<decltype(
169
170
                       &std::remove_reference<Func>::type::operator())>::type *) nullptr,
                   std::forward<Extra>(extra)...);
Wenzel Jakob's avatar
Wenzel Jakob committed
171
172
173
    }

    /// Class methods (non-const)
174
175
176
177
    template <typename Return, typename Class, typename... Arg, typename... Extra> cpp_function(
            Return (Class::*f)(Arg...), Extra&&... extra) {
        initialize([f](Class *c, Arg... args) -> Return { return (c->*f)(args...); },
                   (Return (*) (Class *, Arg...)) nullptr, std::forward<Extra>(extra)...);
Wenzel Jakob's avatar
Wenzel Jakob committed
178
    }
Wenzel Jakob's avatar
Wenzel Jakob committed
179
180

    /// Class methods (const)
181
182
183
184
    template <typename Return, typename Class, typename... Arg, typename... Extra> cpp_function(
            Return (Class::*f)(Arg...) const, Extra&&... extra) {
        initialize([f](const Class *c, Arg... args) -> Return { return (c->*f)(args...); },
                   (Return (*)(const Class *, Arg ...)) nullptr, std::forward<Extra>(extra)...);
Wenzel Jakob's avatar
Wenzel Jakob committed
185
186
    }

187
188
189
    /// Return the function name
    const char *name() const { return m_entry->name; }

Wenzel Jakob's avatar
Wenzel Jakob committed
190
private:
Wenzel Jakob's avatar
Wenzel Jakob committed
191
    /// Functors, lambda functions, etc.
192
193
194
195
196
    template <typename Func, typename Return, typename... Args, typename... Extra>
    void initialize(Func &&f, Return (*)(Args...), Extra&&... extra) {
        using detail::descr;

        struct capture { typename std::remove_reference<Func>::type f; };
Wenzel Jakob's avatar
Wenzel Jakob committed
197

198
        m_entry = new function_entry();
199
        m_entry->data = new capture { std::forward<Func>(f) };
200

201
        if (!std::is_trivially_destructible<Func>::value)
202
            m_entry->free_data = [](void *ptr) { delete (capture *) ptr; };
203
        else
204
            m_entry->free_data = operator delete;
205

206
        typedef arg_value_caster<Args...> cast_in;
207
        typedef return_value_caster<Return> cast_out;
Wenzel Jakob's avatar
Wenzel Jakob committed
208

209
        m_entry->impl = [](function_entry *entry, PyObject *pyArgs, PyObject *parent) -> PyObject *{
Wenzel Jakob's avatar
Wenzel Jakob committed
210
            cast_in args;
211
            if (!args.load(pyArgs, true))
212
                return (PyObject *) 1; /* Special return code: try next overload */
213
            return cast_out::cast(args.template call<Return>(((capture *) entry->data)->f), entry->policy, parent);
Wenzel Jakob's avatar
Wenzel Jakob committed
214
215
        };

216
        process_extras(std::make_tuple(std::forward<Extra>(extra)...), m_entry);
217
218
        PYBIND11_DESCR signature = cast_in::name() + detail::_(" -> ") + cast_out::name();
        initialize(signature.text(), signature.types(), sizeof...(Args));
Wenzel Jakob's avatar
Wenzel Jakob committed
219
220
    }

Wenzel Jakob's avatar
Wenzel Jakob committed
221
    static PyObject *dispatcher(PyObject *self, PyObject *args, PyObject *kwargs) {
222
223
224
225
226
227
        function_entry *overloads = (function_entry *) PyCapsule_GetPointer(self, nullptr),
                       *it = overloads;
        int nargs = (int) PyTuple_Size(args),
            nkwargs = kwargs ? (int) PyDict_Size(kwargs) : 0;
        PyObject *parent = nargs > 0 ? PyTuple_GetItem(args, 0) : nullptr,
                 *result = (PyObject *) 1;
Wenzel Jakob's avatar
Wenzel Jakob committed
228
        try {
229
            for (; it != nullptr; it = it->next) {
230
                object args_(args, true);
231
                int kwargs_consumed = 0;
232

233
                if (nargs < (int) it->args.size()) {
234
                    args_ = object(PyTuple_New(it->args.size()), false);
235
                    for (int i = 0; i < nargs; ++i) {
236
237
                        PyObject *item = PyTuple_GET_ITEM(args, i);
                        Py_INCREF(item);
238
                        PyTuple_SET_ITEM(args_.ptr(), i, item);
239
                    }
240
                    int arg_ctr = 0;
241
                    for (auto const &it2 : it->args) {
242
                        int index = arg_ctr++;
243
                        if (PyTuple_GET_ITEM(args_.ptr(), index))
244
245
246
                            continue;
                        PyObject *value = nullptr;
                        if (kwargs)
247
                            value = PyDict_GetItemString(kwargs, it2.name);
248
249
                        if (value)
                            kwargs_consumed++;
250
251
                        else if (it2.value)
                            value = it2.value;
252
253
                        if (value) {
                            Py_INCREF(value);
254
                            PyTuple_SET_ITEM(args_.ptr(), index, value);
255
256
257
258
259
                        } else {
                            kwargs_consumed = -1; /* definite failure */
                            break;
                        }
                    }
260
261
                }

262
                if (kwargs_consumed == nkwargs)
263
                    result = it->impl(it, args_.ptr(), parent);
264

265
                if (result != (PyObject *) 1)
Wenzel Jakob's avatar
Wenzel Jakob committed
266
267
                    break;
            }
Jonas Adler's avatar
Jonas Adler committed
268
269
270
271
272
273
274
275
276
277
        } catch (const error_already_set &)      {                                                 return nullptr;
        } catch (const index_error &e)           { PyErr_SetString(PyExc_IndexError,    e.what()); return nullptr;
        } catch (const stop_iteration &e)        { PyErr_SetString(PyExc_StopIteration, e.what()); return nullptr;
        } catch (const std::bad_alloc &e)        { PyErr_SetString(PyExc_MemoryError,   e.what()); return nullptr;
        } catch (const std::domain_error &e)     { PyErr_SetString(PyExc_ValueError,    e.what()); return nullptr;
        } catch (const std::invalid_argument &e) { PyErr_SetString(PyExc_ValueError,    e.what()); return nullptr;
        } catch (const std::length_error &e)     { PyErr_SetString(PyExc_ValueError,    e.what()); return nullptr;
        } catch (const std::out_of_range &e)     { PyErr_SetString(PyExc_IndexError,    e.what()); return nullptr;
        } catch (const std::range_error &e)      { PyErr_SetString(PyExc_ValueError,    e.what()); return nullptr;
        } catch (const std::exception &e)        { PyErr_SetString(PyExc_RuntimeError,  e.what()); return nullptr;
Wenzel Jakob's avatar
Wenzel Jakob committed
278
279
280
281
        } catch (...) {
            PyErr_SetString(PyExc_RuntimeError, "Caught an unknown exception!");
            return nullptr;
        }
282
283
284
285
        if (result == (PyObject *) 1) {
            std::string msg = "Incompatible function arguments. The "
                              "following argument types are supported:\n";
            int ctr = 0;
Wenzel Jakob's avatar
Wenzel Jakob committed
286
            for (function_entry *it2 = overloads; it2 != nullptr; it2 = it2->next) {
287
                msg += "    "+ std::to_string(++ctr) + ". ";
288
                msg += it2->signature;
289
290
291
292
293
294
295
                msg += "\n";
            }
            PyErr_SetString(PyExc_TypeError, msg.c_str());
            return nullptr;
        } else if (result == nullptr) {
            std::string msg = "Unable to convert function return value to a "
                              "Python type! The signature was\n\t";
296
            msg += it->signature;
297
298
299
            PyErr_SetString(PyExc_TypeError, msg.c_str());
            return nullptr;
        } else {
Wenzel Jakob's avatar
Wenzel Jakob committed
300
301
302
303
            if (overloads->is_constructor) {
                PyObject *inst = PyTuple_GetItem(args, 0);
                const detail::type_info *type_info =
                    capsule(PyObject_GetAttrString((PyObject *) Py_TYPE(inst),
304
                                const_cast<char *>("__pybind11__")), false);
Wenzel Jakob's avatar
Wenzel Jakob committed
305
306
307
308
309
310
                type_info->init_holder(inst);
            }
            return result;
        }
    }

311
312
313
    static void destruct(function_entry *entry) {
        while (entry) {
            function_entry *next = entry->next;
314
315
316
317
318
319
320
321
322
323
324
            delete entry->def;
            if (entry->free_data)
                entry->free_data(entry->data);
            std::free((char *) entry->name);
            std::free((char *) entry->doc);
            std::free((char *) entry->signature);
            for (auto &arg: entry->args) {
                std::free((char *) arg.name);
                std::free((char *) arg.descr);
                Py_XDECREF(arg.value);
            }
325
326
327
328
329
            delete entry;
            entry = next;
        }
    }

330
331
332
333
334
335
336
337
338
339
    void initialize(const char *text, const std::type_info * const * types, int args) {
        /* Create copies of all referenced C-style strings */
        m_entry->name = strdup(m_entry->name ? m_entry->name : "");
        if (m_entry->doc) m_entry->doc = strdup(m_entry->doc);
        for (auto &a: m_entry->args) {
            if (a.name)
                a.name = strdup(a.name);
            if (a.descr)
                a.descr = strdup(a.descr);
            else if (a.value)
340
                a.descr = strdup(((std::string) ((object) handle(a.value).attr("__repr__")).call().str()).c_str());
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
        }
        auto const &registered_types = detail::get_internals().registered_types;

        /* Generate a proper function signature */
        std::string signature;
        size_t type_depth = 0, char_index = 0, type_index = 0, arg_index = 0;
        while (true) {
            char c = text[char_index++];
            if (c == '\0')
                break;

            if (c == '{') {
                if (type_depth == 1 && arg_index < m_entry->args.size()) {
                    signature += m_entry->args[arg_index].name;
                    signature += " : ";
                }
                ++type_depth;
            } else if (c == '}') {
                --type_depth;
                if (type_depth == 1 && arg_index < m_entry->args.size()) {
                    if (m_entry->args[arg_index].descr) {
                        signature += " = ";
                        signature += m_entry->args[arg_index].descr;
                    }
                    arg_index++;
                }
            } else if (c == '%') {
                const std::type_info *t = types[type_index++];
                if (!t) 
370
                    throw std::runtime_error("Internal error while parsing type signature (1)");
371
372
373
374
375
376
377
378
379
380
381
382
383
                auto it = registered_types.find(t);
                if (it != registered_types.end()) {
                    signature += it->second.type->tp_name;
                } else {
                    std::string tname(t->name());
                    detail::clean_type_id(tname);
                    signature += tname;
                }
            } else {
                signature += c;
            }
        }
        if (type_depth != 0 && types[type_index ] != nullptr)
384
            throw std::runtime_error("Internal error while parsing type signature (2)");
385
386
387
388
389

        #if !defined(PYBIND11_CPP14)
            delete[] types;
            delete[] text;
        #endif
390

391
#if PY_MAJOR_VERSION < 3
392
393
394
395
        if (strcmp(m_entry->name, "__next__") == 0) {
            free(m_entry->name);
            m_entry->name = strdup("next");
        }
396
397
#endif

398
        if (!m_entry->args.empty() && (int) m_entry->args.size() != args)
399
            throw std::runtime_error(
400
                "cpp_function(): function \"" + std::string(m_entry->name) + "\" takes " +
401
                std::to_string(args) + " arguments, but " + std::to_string(m_entry->args.size()) +
402
                " pybind11::arg entries were specified!");
403

404
        m_entry->is_constructor = !strcmp(m_entry->name, "__init__");
405
406
        m_entry->signature = strdup(signature.c_str());
        m_entry->args.shrink_to_fit();
407
408
409
410
411

#if PY_MAJOR_VERSION < 3
        if (m_entry->sibling && PyMethod_Check(m_entry->sibling))
            m_entry->sibling = PyMethod_GET_FUNCTION(m_entry->sibling);
#endif
412

413
414
415
416
417
        function_entry *s_entry = nullptr, *entry = m_entry;
        if (m_entry->sibling && PyCFunction_Check(m_entry->sibling)) {
            capsule entry_capsule(PyCFunction_GetSelf(m_entry->sibling), true);
            s_entry = (function_entry *) entry_capsule;
            if (s_entry->class_ != m_entry->class_)
418
                s_entry = nullptr; /* Overridden method, don't append to parent class overloads */
419
420
        }

421
        if (!s_entry) { /* No existing overload was found, create a function object */
422
423
424
425
426
427
428
            m_entry->def = new PyMethodDef();
            memset(m_entry->def, 0, sizeof(PyMethodDef));
            m_entry->def->ml_name = m_entry->name;
            m_entry->def->ml_meth = reinterpret_cast<PyCFunction>(*dispatcher);
            m_entry->def->ml_flags = METH_VARARGS | METH_KEYWORDS;
            capsule entry_capsule(m_entry, [](PyObject *o) { destruct((function_entry *) PyCapsule_GetPointer(o, nullptr)); });
            m_ptr = PyCFunction_New(m_entry->def, entry_capsule.ptr());
Wenzel Jakob's avatar
Wenzel Jakob committed
429
            if (!m_ptr)
430
                throw std::runtime_error("cpp_function::cpp_function(): Could not allocate function object");
Wenzel Jakob's avatar
Wenzel Jakob committed
431
        } else {
432
            m_ptr = m_entry->sibling;
Wenzel Jakob's avatar
Wenzel Jakob committed
433
            inc_ref();
434
435
436
437
            entry = s_entry;
            while (s_entry->next)
                s_entry = s_entry->next;
            s_entry->next = m_entry;
Wenzel Jakob's avatar
Wenzel Jakob committed
438
        }
439

Wenzel Jakob's avatar
Wenzel Jakob committed
440
        std::string signatures;
441
442
        int index = 0;
        function_entry *it = entry;
443
        while (it) { /* Create pydoc entry including all function signatures and docstrings of the overload chain */
444
            if (s_entry)
445
                signatures += std::to_string(++index) + ". ";
446
447
448
449
450
451
452
453
            signatures += "Signature : ";
            signatures += it->signature;
            signatures += "\n";
            if (it->doc && strlen(it->doc) > 0) {
                signatures += "\n";
                signatures += it->doc;
                signatures += "\n";
            }
454
            if (it->next)
Wenzel Jakob's avatar
Wenzel Jakob committed
455
                signatures += "\n";
456
            it = it->next;
Wenzel Jakob's avatar
Wenzel Jakob committed
457
458
459
        }
        PyCFunctionObject *func = (PyCFunctionObject *) m_ptr;
        if (func->m_ml->ml_doc)
460
            free((char *) func->m_ml->ml_doc);
Wenzel Jakob's avatar
Wenzel Jakob committed
461
        func->m_ml->ml_doc = strdup(signatures.c_str());
462
        if (entry->class_) {
463
#if PY_MAJOR_VERSION >= 3
Wenzel Jakob's avatar
Wenzel Jakob committed
464
            m_ptr = PyInstanceMethod_New(m_ptr);
465
466
467
#else
            m_ptr = PyMethod_New(m_ptr, nullptr, entry->class_);
#endif
Wenzel Jakob's avatar
Wenzel Jakob committed
468
            if (!m_ptr)
469
                throw std::runtime_error("cpp_function::cpp_function(): Could not allocate instance method object");
Wenzel Jakob's avatar
Wenzel Jakob committed
470
471
472
473
474
475
476
            Py_DECREF(func);
        }
    }
};

class module : public object {
public:
477
    PYBIND11_OBJECT_DEFAULT(module, object, PyModule_Check)
Wenzel Jakob's avatar
Wenzel Jakob committed
478
479

    module(const char *name, const char *doc = nullptr) {
480
#if PY_MAJOR_VERSION >= 3
Wenzel Jakob's avatar
Wenzel Jakob committed
481
482
483
484
485
486
487
        PyModuleDef *def = new PyModuleDef();
        memset(def, 0, sizeof(PyModuleDef));
        def->m_name = name;
        def->m_doc = doc;
        def->m_size = -1;
        Py_INCREF(def);
        m_ptr = PyModule_Create(def);
488
489
490
#else
        m_ptr = Py_InitModule3(name, nullptr, doc);
#endif
Wenzel Jakob's avatar
Wenzel Jakob committed
491
492
493
494
495
        if (m_ptr == nullptr)
            throw std::runtime_error("Internal error in module::module()");
        inc_ref();
    }

496
497
498
499
    template <typename Func, typename... Extra>
    module &def(const char *name_, Func &&f, Extra&& ... extra) {
        cpp_function func(std::forward<Func>(f), name(name_),
                          sibling((handle) attr(name_)), std::forward<Extra>(extra)...);
Wenzel Jakob's avatar
Wenzel Jakob committed
500
        func.inc_ref(); /* The following line steals a reference to 'func' */
501
        PyModule_AddObject(ptr(), name_, func.ptr());
Wenzel Jakob's avatar
Wenzel Jakob committed
502
503
504
        return *this;
    }

505
    module def_submodule(const char *name, const char *doc = nullptr) {
Wenzel Jakob's avatar
Wenzel Jakob committed
506
507
508
        std::string full_name = std::string(PyModule_GetName(m_ptr))
            + std::string(".") + std::string(name);
        module result(PyImport_AddModule(full_name.c_str()), true);
509
        if (doc)
510
            result.attr("__doc__") = pybind11::str(doc);
Wenzel Jakob's avatar
Wenzel Jakob committed
511
512
513
        attr(name) = result;
        return result;
    }
Wenzel Jakob's avatar
Wenzel Jakob committed
514
515

    static module import(const char *name) {
516
517
518
519
        PyObject *obj = PyImport_ImportModule(name);
        if (!obj)
            throw std::runtime_error("Module \"" + std::string(name) + "\" not found!");
        return module(obj, false);
Wenzel Jakob's avatar
Wenzel Jakob committed
520
    }
Wenzel Jakob's avatar
Wenzel Jakob committed
521
522
523
524
525
526
};

NAMESPACE_BEGIN(detail)
/// Basic support for creating new Python heap types
class custom_type : public object {
public:
527
    PYBIND11_OBJECT_DEFAULT(custom_type, object, PyType_Check)
Wenzel Jakob's avatar
Wenzel Jakob committed
528

529
    custom_type(object &scope, const char *name_, const std::type_info *tinfo,
Wenzel Jakob's avatar
Wenzel Jakob committed
530
531
532
533
                size_t type_size, size_t instance_size,
                void (*init_holder)(PyObject *), const destructor &dealloc,
                PyObject *parent, const char *doc) {
        PyHeapTypeObject *type = (PyHeapTypeObject*) PyType_Type.tp_alloc(&PyType_Type, 0);
534
#if PY_MAJOR_VERSION >= 3
Wenzel Jakob's avatar
Wenzel Jakob committed
535
        PyObject *name = PyUnicode_FromString(name_);
536
537
538
#else
        PyObject *name = PyString_FromString(name_);
#endif
Wenzel Jakob's avatar
Wenzel Jakob committed
539
540
541
542
543
        if (type == nullptr || name == nullptr)
            throw std::runtime_error("Internal error in custom_type::custom_type()");
        Py_INCREF(name);
        std::string full_name(name_);

544
        pybind11::str scope_name = (object) scope.attr("__name__"),
Wenzel Jakob's avatar
Wenzel Jakob committed
545
546
547
548
549
550
551
                    module_name = (object) scope.attr("__module__");

        if (scope_name.check())
            full_name =  std::string(scope_name) + "." + full_name;
        if (module_name.check())
            full_name =  std::string(module_name) + "." + full_name;

552
553
554
555
        type->ht_name = name;
#if PY_MAJOR_VERSION >= 3
        type->ht_qualname = name;
#endif
Wenzel Jakob's avatar
Wenzel Jakob committed
556
557
558
559
560
561
562
563
        type->ht_type.tp_name = strdup(full_name.c_str());
        type->ht_type.tp_basicsize = instance_size;
        type->ht_type.tp_init = (initproc) init;
        type->ht_type.tp_new = (newfunc) new_instance;
        type->ht_type.tp_dealloc = dealloc;
        type->ht_type.tp_flags |=
            Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | Py_TPFLAGS_HEAPTYPE;
        type->ht_type.tp_flags &= ~Py_TPFLAGS_HAVE_GC;
564
565
566
#if PY_MAJOR_VERSION < 3
        type->ht_type.tp_flags |= Py_TPFLAGS_CHECKTYPES;
#endif
Wenzel Jakob's avatar
Wenzel Jakob committed
567
568
569
570
        type->ht_type.tp_as_number = &type->as_number;
        type->ht_type.tp_as_sequence = &type->as_sequence;
        type->ht_type.tp_as_mapping = &type->as_mapping;
        type->ht_type.tp_base = (PyTypeObject *) parent;
Wenzel Jakob's avatar
Wenzel Jakob committed
571
572
        if (doc) {
            size_t size = strlen(doc)+1;
573
            type->ht_type.tp_doc = (char *) PyObject_MALLOC(size);
Wenzel Jakob's avatar
Wenzel Jakob committed
574
575
            memcpy((void *) type->ht_type.tp_doc, doc, size);
        }
Wenzel Jakob's avatar
Wenzel Jakob committed
576
577
578
579
580
581
582
        Py_XINCREF(parent);

        if (PyType_Ready(&type->ht_type) < 0)
            throw std::runtime_error("Internal error in custom_type::custom_type()");
        m_ptr = (PyObject *) type;

        /* Needed by pydoc */
583
        attr("__module__") = scope_name;
Wenzel Jakob's avatar
Wenzel Jakob committed
584

585
586
        auto &registered_types = get_internals().registered_types;
        auto &type_info = registered_types[tinfo];
Wenzel Jakob's avatar
Wenzel Jakob committed
587
588
589
        type_info.type = (PyTypeObject *) m_ptr;
        type_info.type_size = type_size;
        type_info.init_holder = init_holder;
590
        attr("__pybind11__") = capsule(&type_info);
Wenzel Jakob's avatar
Wenzel Jakob committed
591
592
593
594
595
596
597
598

        scope.attr(name) = *this;
    }

protected:
    /* Allocate a metaclass on demand (for static properties) */
    handle metaclass() {
        auto &ht_type = ((PyHeapTypeObject *) m_ptr)->ht_type;
599
#if PY_MAJOR_VERSION >= 3
Wenzel Jakob's avatar
Wenzel Jakob committed
600
        auto &ob_type = ht_type.ob_base.ob_base.ob_type;
601
602
603
604
#else
        auto &ob_type = ht_type.ob_type;
#endif

Wenzel Jakob's avatar
Wenzel Jakob committed
605
606
607
608
609
610
611
        if (ob_type == &PyType_Type) {
            std::string name_ = std::string(ht_type.tp_name) + "_meta";
            PyHeapTypeObject *type = (PyHeapTypeObject*) PyType_Type.tp_alloc(&PyType_Type, 0);
            PyObject *name = PyUnicode_FromString(name_.c_str());
            if (type == nullptr || name == nullptr)
                throw std::runtime_error("Internal error in custom_type::metaclass()");
            Py_INCREF(name);
612
613
614
615
            type->ht_name = name;
#if PY_MAJOR_VERSION >= 3
            type->ht_qualname = name;
#endif
Wenzel Jakob's avatar
Wenzel Jakob committed
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
            type->ht_type.tp_name = strdup(name_.c_str());
            type->ht_type.tp_base = &PyType_Type;
            type->ht_type.tp_flags |= Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HEAPTYPE;
            type->ht_type.tp_flags &= ~Py_TPFLAGS_HAVE_GC;
            if (PyType_Ready(&type->ht_type) < 0)
                throw std::runtime_error("Internal error in custom_type::metaclass()");
            ob_type = (PyTypeObject *) type;
            Py_INCREF(type);
        }
        return handle((PyObject *) ob_type);
    }

    static int init(void *self, PyObject *, PyObject *) {
        std::string msg = std::string(Py_TYPE(self)->tp_name) + ": No constructor defined!";
        PyErr_SetString(PyExc_TypeError, msg.c_str());
        return -1;
    }

    static PyObject *new_instance(PyTypeObject *type, PyObject *, PyObject *) {
        const detail::type_info *type_info = capsule(
636
            PyObject_GetAttrString((PyObject *) type, const_cast<char*>("__pybind11__")), false);
Wenzel Jakob's avatar
Wenzel Jakob committed
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
        instance<void> *self = (instance<void> *) PyType_GenericAlloc(type, 0);
        self->value = ::operator new(type_info->type_size);
        self->owned = true;
        self->parent = nullptr;
        self->constructed = false;
        detail::get_internals().registered_instances[self->value] = (PyObject *) self;
        return (PyObject *) self;
    }

    static void dealloc(instance<void> *self) {
        if (self->value) {
            bool dont_cache = self->parent && ((instance<void> *) self->parent)->value == self->value;
            if (!dont_cache) { // avoid an issue with internal references matching their parent's address
                auto &registered_instances = detail::get_internals().registered_instances;
                auto it = registered_instances.find(self->value);
                if (it == registered_instances.end())
                    throw std::runtime_error("Deallocating unregistered instance!");
                registered_instances.erase(it);
            }
            Py_XDECREF(self->parent);
        }
        Py_TYPE(self)->tp_free((PyObject*) self);
    }

Wenzel Jakob's avatar
Wenzel Jakob committed
661
662
663
    void install_buffer_funcs(
            buffer_info *(*get_buffer)(PyObject *, void *),
            void *get_buffer_data) {
Wenzel Jakob's avatar
Wenzel Jakob committed
664
665
        PyHeapTypeObject *type = (PyHeapTypeObject*) m_ptr;
        type->ht_type.tp_as_buffer = &type->as_buffer;
666
667
668
#if PY_MAJOR_VERSION < 3
        type->ht_type.tp_flags |= Py_TPFLAGS_HAVE_NEWBUFFER;
#endif
Wenzel Jakob's avatar
Wenzel Jakob committed
669
670
        type->as_buffer.bf_getbuffer = getbuffer;
        type->as_buffer.bf_releasebuffer = releasebuffer;
671
        auto info = ((detail::type_info *) capsule(attr("__pybind11__")));
Wenzel Jakob's avatar
Wenzel Jakob committed
672
673
        info->get_buffer = get_buffer;
        info->get_buffer_data = get_buffer_data;
Wenzel Jakob's avatar
Wenzel Jakob committed
674
675
676
    }

    static int getbuffer(PyObject *obj, Py_buffer *view, int flags) {
677
        auto const &typeinfo = ((detail::type_info *) capsule(handle(obj).attr("__pybind11__")));
Wenzel Jakob's avatar
Wenzel Jakob committed
678
679

        if (view == nullptr || obj == nullptr || !typeinfo || !typeinfo->get_buffer) {
Wenzel Jakob's avatar
Wenzel Jakob committed
680
681
682
683
            PyErr_SetString(PyExc_BufferError, "Internal error");
            return -1;
        }
        memset(view, 0, sizeof(Py_buffer));
Wenzel Jakob's avatar
Wenzel Jakob committed
684
        buffer_info *info = typeinfo->get_buffer(obj, typeinfo->get_buffer_data);
Wenzel Jakob's avatar
Wenzel Jakob committed
685
686
687
688
689
690
691
692
693
694
695
696
        view->obj = obj;
        view->ndim = 1;
        view->internal = info;
        view->buf = info->ptr;
        view->itemsize = info->itemsize;
        view->len = view->itemsize;
        for (auto s : info->shape)
            view->len *= s;
        if ((flags & PyBUF_FORMAT) == PyBUF_FORMAT)
            view->format = const_cast<char *>(info->format.c_str());
        if ((flags & PyBUF_STRIDES) == PyBUF_STRIDES) {
            view->ndim = info->ndim;
697
698
            view->strides = (ssize_t *) &info->strides[0];
            view->shape = (ssize_t *) &info->shape[0];
Wenzel Jakob's avatar
Wenzel Jakob committed
699
700
701
702
703
704
705
        }
        Py_INCREF(view->obj);
        return 0;
    }

    static void releasebuffer(PyObject *, Py_buffer *view) { delete (buffer_info *) view->internal; }
};
706
707
708
709
710
711
712

/* Forward declarations */
enum op_id : int;
enum op_type : int;
struct undefined_t;
template <op_id id, op_type ot, typename L = undefined_t, typename R = undefined_t> struct op_;
template <typename... Args> struct init;
Wenzel Jakob's avatar
Wenzel Jakob committed
713
714
715
716
717
718
NAMESPACE_END(detail)

template <typename type, typename holder_type = std::unique_ptr<type>> class class_ : public detail::custom_type {
public:
    typedef detail::instance<type, holder_type> instance_type;

719
    PYBIND11_OBJECT(class_, detail::custom_type, PyType_Check)
Wenzel Jakob's avatar
Wenzel Jakob committed
720
721

    class_(object &scope, const char *name, const char *doc = nullptr)
722
        : detail::custom_type(scope, name, &typeid(type), sizeof(type),
Wenzel Jakob's avatar
Wenzel Jakob committed
723
724
725
726
727
                              sizeof(instance_type), init_holder, dealloc,
                              nullptr, doc) { }

    class_(object &scope, const char *name, object &parent,
           const char *doc = nullptr)
728
        : detail::custom_type(scope, name, &typeid(type), sizeof(type),
Wenzel Jakob's avatar
Wenzel Jakob committed
729
730
731
                              sizeof(instance_type), init_holder, dealloc,
                              parent.ptr(), doc) { }

732
733
    template <typename Func, typename... Extra>
    class_ &def(const char *name_, Func&& f, Extra&&... extra) {
734
735
736
737
        cpp_function cf(std::forward<Func>(f), name(name_),
                        sibling(attr(name_)), is_method(this),
                        std::forward<Extra>(extra)...);
        attr(cf.name()) = cf;
Wenzel Jakob's avatar
Wenzel Jakob committed
738
739
740
        return *this;
    }

741
742
    template <typename Func, typename... Extra> class_ &
    def_static(const char *name_, Func f, Extra&&... extra) {
743
744
745
746
        cpp_function cf(std::forward<Func>(f), name(name_),
                        sibling(attr(name_)),
                        std::forward<Extra>(extra)...);
        attr(cf.name()) = cf;
Wenzel Jakob's avatar
Wenzel Jakob committed
747
748
749
        return *this;
    }

750
751
752
    template <detail::op_id id, detail::op_type ot, typename L, typename R, typename... Extra>
    class_ &def(const detail::op_<id, ot, L, R> &op, Extra&&... extra) {
        op.template execute<type>(*this, std::forward<Extra>(extra)...);
Wenzel Jakob's avatar
Wenzel Jakob committed
753
754
755
        return *this;
    }

756
757
758
    template <detail::op_id id, detail::op_type ot, typename L, typename R, typename... Extra>
    class_ & def_cast(const detail::op_<id, ot, L, R> &op, Extra&&... extra) {
        op.template execute_cast<type>(*this, std::forward<Extra>(extra)...);
Wenzel Jakob's avatar
Wenzel Jakob committed
759
760
761
        return *this;
    }

762
763
764
    template <typename... Args, typename... Extra>
    class_ &def(const detail::init<Args...> &init, Extra&&... extra) {
        init.template execute<type>(*this, std::forward<Extra>(extra)...);
Wenzel Jakob's avatar
Wenzel Jakob committed
765
766
767
        return *this;
    }

768
    template <typename Func> class_& def_buffer(Func &&func) {
Wenzel Jakob's avatar
Wenzel Jakob committed
769
770
771
        struct capture { Func func; };
        capture *ptr = new capture { std::forward<Func>(func) };
        install_buffer_funcs([](PyObject *obj, void *ptr) -> buffer_info* {
Wenzel Jakob's avatar
Wenzel Jakob committed
772
773
774
            detail::type_caster<type> caster;
            if (!caster.load(obj, false))
                return nullptr;
Wenzel Jakob's avatar
Wenzel Jakob committed
775
776
            return new buffer_info(((capture *) ptr)->func(caster));
        }, ptr);
Wenzel Jakob's avatar
Wenzel Jakob committed
777
778
779
        return *this;
    }

780
781
782
783
    template <typename C, typename D, typename... Extra>
    class_ &def_readwrite(const char *name, D C::*pm, Extra&&... extra) {
        cpp_function fget([pm](const C &c) -> const D &{ return c.*pm; },
                          return_value_policy::reference_internal,
784
                          is_method(this), extra...),
785
                     fset([pm](C &c, const D &value) { c.*pm = value; },
786
                          is_method(this), extra...);
787
        def_property(name, fget, fset);
Wenzel Jakob's avatar
Wenzel Jakob committed
788
789
790
        return *this;
    }

791
792
793
794
    template <typename C, typename D, typename... Extra>
    class_ &def_readonly(const char *name, const D C::*pm, Extra&& ...extra) {
        cpp_function fget([pm](const C &c) -> const D &{ return c.*pm; },
                          return_value_policy::reference_internal,
795
                          is_method(this), std::forward<Extra>(extra)...);
796
        def_property_readonly(name, fget);
Wenzel Jakob's avatar
Wenzel Jakob committed
797
798
799
        return *this;
    }

800
801
    template <typename D, typename... Extra>
    class_ &def_readwrite_static(const char *name, D *pm, Extra&& ...extra) {
802
        cpp_function fget([pm](object) -> const D &{ return *pm; }, nullptr,
803
804
805
                          return_value_policy::reference_internal, extra...),
                     fset([pm](object, const D &value) { *pm = value; }, extra...);
        def_property_static(name, fget, fset);
Wenzel Jakob's avatar
Wenzel Jakob committed
806
807
808
        return *this;
    }

809
810
    template <typename D, typename... Extra>
    class_ &def_readonly_static(const char *name, const D *pm, Extra&& ...extra) {
811
        cpp_function fget([pm](object) -> const D &{ return *pm; }, nullptr,
812
813
                          return_value_policy::reference_internal, std::forward<Extra>(extra)...);
        def_property_readonly_static(name, fget);
Wenzel Jakob's avatar
Wenzel Jakob committed
814
815
816
        return *this;
    }

817
818
    class_ &def_property_readonly(const char *name, const cpp_function &fget, const char *doc = nullptr) {
        def_property(name, fget, cpp_function(), doc);
Wenzel Jakob's avatar
Wenzel Jakob committed
819
820
821
        return *this;
    }

822
823
    class_ &def_property_readonly_static(const char *name, const cpp_function &fget, const char *doc = nullptr) {
        def_property_static(name, fget, cpp_function(), doc);
Wenzel Jakob's avatar
Wenzel Jakob committed
824
825
826
        return *this;
    }

827
    class_ &def_property(const char *name, const cpp_function &fget, const cpp_function &fset, const char *doc = nullptr) {
828
        object doc_obj = doc ? pybind11::str(doc) : (object) const_cast<cpp_function&>(fget).attr("__doc__");
Wenzel Jakob's avatar
Wenzel Jakob committed
829
830
        object property(
            PyObject_CallFunction((PyObject *)&PyProperty_Type,
831
                                  const_cast<char *>("OOOO"), fget.ptr() ? fget.ptr() : Py_None,
832
                                  fset.ptr() ? fset.ptr() : Py_None, Py_None, doc_obj.ptr()), false);
Wenzel Jakob's avatar
Wenzel Jakob committed
833
834
835
836
        attr(name) = property;
        return *this;
    }

837
    class_ &def_property_static(const char *name, const cpp_function &fget, const cpp_function &fset, const char *doc = nullptr) {
838
        object doc_obj = doc ? pybind11::str(doc) : (object) const_cast<cpp_function&>(fget).attr("__doc__");
Wenzel Jakob's avatar
Wenzel Jakob committed
839
840
        object property(
            PyObject_CallFunction((PyObject *)&PyProperty_Type,
841
842
                                  const_cast<char *>("OOOs"), fget.ptr() ? fget.ptr() : Py_None,
                                  fset.ptr() ? fset.ptr() : Py_None, Py_None, doc_obj.ptr()), false);
Wenzel Jakob's avatar
Wenzel Jakob committed
843
844
845
        metaclass().attr(name) = property;
        return *this;
    }
846
847

    template <typename target> class_ alias() {
848
        auto &instances = pybind11::detail::get_internals().registered_types;
849
850
851
        instances[&typeid(target)] = instances[&typeid(type)];
        return *this;
    }
Wenzel Jakob's avatar
Wenzel Jakob committed
852
private:
853
854
    template <typename T = holder_type,
              typename std::enable_if<!std::is_same<std::shared_ptr<type>, T>::value, int>::type = 0>
Wenzel Jakob's avatar
Wenzel Jakob committed
855
856
857
858
859
    static void init_holder(PyObject *inst_) {
        instance_type *inst = (instance_type *) inst_;
        new (&inst->holder) holder_type(inst->value);
        inst->constructed = true;
    }
860
861
862
863
864
865
866

    template <typename T = holder_type,
              typename std::enable_if<std::is_same<std::shared_ptr<type>, T>::value, int>::type = 0>
    static void init_holder(PyObject *inst_) {
        instance_type *inst = (instance_type *) inst_;
        try {
            new (&inst->holder) holder_type(
867
                inst->value->shared_from_this());
868
869
870
871
872
873
        } catch (const std::bad_weak_ptr &) {
            new (&inst->holder) holder_type(inst->value);
        }
        inst->constructed = true;
    }

Wenzel Jakob's avatar
Wenzel Jakob committed
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
    static void dealloc(PyObject *inst_) {
        instance_type *inst = (instance_type *) inst_;
        if (inst->owned) {
            if (inst->constructed)
                inst->holder.~holder_type();
            else
                ::operator delete(inst->value);
        }
        custom_type::dealloc((detail::instance<void> *) inst);
    }
};

/// Binds C++ enumerations and enumeration classes to Python
template <typename Type> class enum_ : public class_<Type> {
public:
    enum_(object &scope, const char *name, const char *doc = nullptr)
      : class_<Type>(scope, name, doc), m_parent(scope) {
        auto entries = new std::unordered_map<int, const char *>();
892
        this->def("__repr__", [name, entries](Type value) -> std::string {
Wenzel Jakob's avatar
Wenzel Jakob committed
893
            auto it = entries->find((int) value);
Wenzel Jakob's avatar
Wenzel Jakob committed
894
895
896
897
            return std::string(name) + "." +
                ((it == entries->end()) ? std::string("???")
                                        : std::string(it->second));
        });
898
        this->def("__int__", [](Type value) { return (int) value; });
Wenzel Jakob's avatar
Wenzel Jakob committed
899
900
901
902
903
904
905
        m_entries = entries;
    }

    /// Export enumeration entries into the parent scope
    void export_values() {
        PyObject *dict = ((PyTypeObject *) this->m_ptr)->tp_dict;
        PyObject *key, *value;
906
        ssize_t pos = 0;
Wenzel Jakob's avatar
Wenzel Jakob committed
907
908
909
910
911
912
913
        while (PyDict_Next(dict, &pos, &key, &value))
            if (PyObject_IsInstance(value, this->m_ptr))
                m_parent.attr(key) = value;
    }

    /// Add an enumeration entry
    enum_& value(char const* name, Type value) {
914
        this->attr(name) = pybind11::cast(value, return_value_policy::copy);
Wenzel Jakob's avatar
Wenzel Jakob committed
915
916
917
918
919
920
921
922
923
        (*m_entries)[(int) value] = name;
        return *this;
    }
private:
    std::unordered_map<int, const char *> *m_entries;
    object &m_parent;
};

NAMESPACE_BEGIN(detail)
924
template <typename... Args> struct init {
925
    template <typename Base, typename Holder, typename... Extra> void execute(pybind11::class_<Base, Holder> &class_, Extra&&... extra) const {
Wenzel Jakob's avatar
Wenzel Jakob committed
926
        /// Function which calls a specific C++ in-place constructor
927
        class_.def("__init__", [](Base *instance, Args... args) { new (instance) Base(args...); }, std::forward<Extra>(extra)...);
Wenzel Jakob's avatar
Wenzel Jakob committed
928
929
930
931
932
933
934
    }
};
NAMESPACE_END(detail)

template <typename... Args> detail::init<Args...> init() { return detail::init<Args...>(); };

template <typename InputType, typename OutputType> void implicitly_convertible() {
935
    auto implicit_caster = [](PyObject *obj, PyTypeObject *type) -> PyObject * {
Wenzel Jakob's avatar
Wenzel Jakob committed
936
937
938
939
940
941
942
943
944
945
        if (!detail::type_caster<InputType>().load(obj, false))
            return nullptr;
        tuple args(1);
        args[0] = obj;
        PyObject *result = PyObject_Call((PyObject *) type, args.ptr(), nullptr);
        if (result == nullptr)
            PyErr_Clear();
        return result;
    };
    auto & registered_types = detail::get_internals().registered_types;
946
    auto it = registered_types.find(&typeid(OutputType));
Wenzel Jakob's avatar
Wenzel Jakob committed
947
    if (it == registered_types.end())
948
        throw std::runtime_error("implicitly_convertible: Unable to find type " + type_id<OutputType>());
Wenzel Jakob's avatar
Wenzel Jakob committed
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
    it->second.implicit_conversions.push_back(implicit_caster);
}

inline void init_threading() { PyEval_InitThreads(); }

class gil_scoped_acquire {
    PyGILState_STATE state;
public:
    inline gil_scoped_acquire() { state = PyGILState_Ensure(); }
    inline ~gil_scoped_acquire() { PyGILState_Release(state); }
};

class gil_scoped_release {
    PyThreadState *state;
public:
    inline gil_scoped_release() { state = PyEval_SaveThread(); }
    inline ~gil_scoped_release() { PyEval_RestoreThread(state); }
};

968
969
inline function get_overload(const void *this_ptr, const char *name)  {
    handle py_object = detail::get_object_handle(this_ptr);
970
971
    if (!py_object)
        return function();
972
973
974
975
976
977
978
979
980
981
982
983
984
985
    handle type = py_object.get_type();
    auto key = std::make_pair(type.ptr(), name);

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

    function overload = (function) py_object.attr(name);
    if (overload.is_cpp_function()) {
        cache.insert(key);
        return function();
    }
986

987
    PyFrameObject *frame = PyThreadState_Get()->frame;
988
    pybind11::str caller = pybind11::handle(frame->f_code->co_name).str();
989
    if ((std::string) caller == name)
990
991
992
993
        return function();
    return overload;
}

994
#define PYBIND11_OVERLOAD_INT(ret_type, class_name, name, ...) { \
995
996
        pybind11::gil_scoped_acquire gil; \
        pybind11::function overload = pybind11::get_overload(this, #name); \
997
998
999
        if (overload) \
            return overload.call(__VA_ARGS__).cast<ret_type>();  }

1000
1001
#define PYBIND11_OVERLOAD(ret_type, class_name, name, ...) \
    PYBIND11_OVERLOAD_INT(ret_type, class_name, name, __VA_ARGS__) \
1002
1003
    return class_name::name(__VA_ARGS__)

1004
1005
#define PYBIND11_OVERLOAD_PURE(ret_type, class_name, name, ...) \
    PYBIND11_OVERLOAD_INT(ret_type, class_name, name, __VA_ARGS__) \
1006
1007
    throw std::runtime_error("Tried to call pure virtual function \"" #name "\"");

1008
NAMESPACE_END(pybind11)
Wenzel Jakob's avatar
Wenzel Jakob committed
1009
1010
1011

#if defined(_MSC_VER)
#pragma warning(pop)
1012
#elif defined(__GNUG__) and !defined(__clang__)
1013
#pragma GCC diagnostic pop
Wenzel Jakob's avatar
Wenzel Jakob committed
1014
#endif
1015