/* pybind11/common.h -- Basic macros Copyright (c) 2016 Wenzel Jakob All rights reserved. Use of this source code is governed by a BSD-style license that can be found in the LICENSE file. */ #pragma once #if !defined(NAMESPACE_BEGIN) # define NAMESPACE_BEGIN(name) namespace name { #endif #if !defined(NAMESPACE_END) # define NAMESPACE_END(name) } #endif // Neither MSVC nor Intel support enough of C++14 yet (in particular, as of MSVC 2015 and ICC 17 // beta, neither support extended constexpr, which we rely on in descr.h), so don't enable pybind // CPP14 features for them. #if !defined(_MSC_VER) && !defined(__INTEL_COMPILER) # if __cplusplus >= 201402L # define PYBIND11_CPP14 # if __cplusplus > 201402L /* Temporary: should be updated to >= the final C++17 value once known */ # define PYBIND11_CPP17 # endif # endif #endif #if !defined(PYBIND11_EXPORT) # if defined(WIN32) || defined(_WIN32) # define PYBIND11_EXPORT __declspec(dllexport) # else # define PYBIND11_EXPORT __attribute__ ((visibility("default"))) # endif #endif #if defined(_MSC_VER) # define PYBIND11_NOINLINE __declspec(noinline) #else # define PYBIND11_NOINLINE __attribute__ ((noinline)) #endif #if defined(PYBIND11_CPP14) # define PYBIND11_DEPRECATED(reason) [[deprecated(reason)]] #elif defined(__clang__) # define PYBIND11_DEPRECATED(reason) __attribute__((deprecated(reason))) #elif defined(__GNUG__) # define PYBIND11_DEPRECATED(reason) __attribute__((deprecated)) #elif defined(_MSC_VER) # define PYBIND11_DEPRECATED(reason) __declspec(deprecated) #endif #define PYBIND11_VERSION_MAJOR 1 #define PYBIND11_VERSION_MINOR 9 #define PYBIND11_VERSION_PATCH dev0 /// Include Python header, disable linking to pythonX_d.lib on Windows in debug mode #if defined(_MSC_VER) # define HAVE_ROUND # pragma warning(push) # pragma warning(disable: 4510 4610 4512 4005) # if _DEBUG # define PYBIND11_DEBUG_MARKER # undef _DEBUG # endif #endif #include #include #include #if defined(_WIN32) && (defined(min) || defined(max)) # error Macro clash with min and max -- define NOMINMAX when compiling your program on Windows #endif #if defined(isalnum) # undef isalnum # undef isalpha # undef islower # undef isspace # undef isupper # undef tolower # undef toupper #endif #if defined(_MSC_VER) # if defined(PYBIND11_DEBUG_MARKER) # define _DEBUG # undef PYBIND11_DEBUG_MARKER # endif # pragma warning(pop) #endif #include #include #include #include #include #include #include #include #include #include #if PY_MAJOR_VERSION >= 3 /// Compatibility macros for various Python versions #define PYBIND11_INSTANCE_METHOD_NEW(ptr, class_) PyInstanceMethod_New(ptr) #define PYBIND11_BYTES_CHECK PyBytes_Check #define PYBIND11_BYTES_FROM_STRING PyBytes_FromString #define PYBIND11_BYTES_FROM_STRING_AND_SIZE PyBytes_FromStringAndSize #define PYBIND11_BYTES_AS_STRING_AND_SIZE PyBytes_AsStringAndSize #define PYBIND11_BYTES_AS_STRING PyBytes_AsString #define PYBIND11_LONG_CHECK(o) PyLong_Check(o) #define PYBIND11_LONG_AS_LONGLONG(o) PyLong_AsLongLong(o) #define PYBIND11_LONG_AS_UNSIGNED_LONGLONG(o) PyLong_AsUnsignedLongLong(o) #define PYBIND11_BYTES_NAME "bytes" #define PYBIND11_STRING_NAME "str" #define PYBIND11_SLICE_OBJECT PyObject #define PYBIND11_FROM_STRING PyUnicode_FromString #define PYBIND11_STR_TYPE ::pybind11::str #define PYBIND11_OB_TYPE(ht_type) (ht_type).ob_base.ob_base.ob_type #define PYBIND11_PLUGIN_IMPL(name) \ extern "C" PYBIND11_EXPORT PyObject *PyInit_##name() #else #define PYBIND11_INSTANCE_METHOD_NEW(ptr, class_) PyMethod_New(ptr, nullptr, class_) #define PYBIND11_BYTES_CHECK PyString_Check #define PYBIND11_BYTES_FROM_STRING PyString_FromString #define PYBIND11_BYTES_FROM_STRING_AND_SIZE PyString_FromStringAndSize #define PYBIND11_BYTES_AS_STRING_AND_SIZE PyString_AsStringAndSize #define PYBIND11_BYTES_AS_STRING PyString_AsString #define PYBIND11_LONG_CHECK(o) (PyInt_Check(o) || PyLong_Check(o)) #define PYBIND11_LONG_AS_LONGLONG(o) (PyInt_Check(o) ? (long long) PyLong_AsLong(o) : PyLong_AsLongLong(o)) #define PYBIND11_LONG_AS_UNSIGNED_LONGLONG(o) (PyInt_Check(o) ? (unsigned long long) PyLong_AsUnsignedLong(o) : PyLong_AsUnsignedLongLong(o)) #define PYBIND11_BYTES_NAME "str" #define PYBIND11_STRING_NAME "unicode" #define PYBIND11_SLICE_OBJECT PySliceObject #define PYBIND11_FROM_STRING PyString_FromString #define PYBIND11_STR_TYPE ::pybind11::bytes #define PYBIND11_OB_TYPE(ht_type) (ht_type).ob_type #define PYBIND11_PLUGIN_IMPL(name) \ extern "C" PYBIND11_EXPORT PyObject *init##name() #endif #if PY_VERSION_HEX >= 0x03050000 && PY_VERSION_HEX < 0x03050200 extern "C" { struct _Py_atomic_address { void *value; }; PyAPI_DATA(_Py_atomic_address) _PyThreadState_Current; } #endif #define PYBIND11_TRY_NEXT_OVERLOAD ((PyObject *) 1) // special failure return code #define PYBIND11_STRINGIFY(x) #x #define PYBIND11_TOSTRING(x) PYBIND11_STRINGIFY(x) #define PYBIND11_INTERNALS_ID "__pybind11_" \ PYBIND11_TOSTRING(PYBIND11_VERSION_MAJOR) "_" PYBIND11_TOSTRING(PYBIND11_VERSION_MINOR) "__" #define PYBIND11_PLUGIN(name) \ static PyObject *pybind11_init(); \ PYBIND11_PLUGIN_IMPL(name) { \ int major, minor; \ if (sscanf(Py_GetVersion(), "%i.%i", &major, &minor) != 2) { \ PyErr_SetString(PyExc_ImportError, "Can't parse Python version."); \ return nullptr; \ } else if (major != PY_MAJOR_VERSION || minor != PY_MINOR_VERSION) { \ PyErr_Format(PyExc_ImportError, \ "Python version mismatch: module was compiled for " \ "version %i.%i, while the interpreter is running " \ "version %i.%i.", PY_MAJOR_VERSION, PY_MINOR_VERSION, \ major, minor); \ return nullptr; \ } \ try { \ return pybind11_init(); \ } catch (const std::exception &e) { \ PyErr_SetString(PyExc_ImportError, e.what()); \ return nullptr; \ } \ } \ PyObject *pybind11_init() NAMESPACE_BEGIN(pybind11) using ssize_t = Py_ssize_t; using size_t = std::size_t; /// Approach used to cast a previously unknown C++ instance into a Python object enum class return_value_policy : uint8_t { /** This is the default return value policy, which falls back to the policy return_value_policy::take_ownership when the return value is a pointer. Otherwise, it uses return_value::move or return_value::copy for rvalue and lvalue references, respectively. See below for a description of what all of these different policies do. */ automatic = 0, /** As above, but use policy return_value_policy::reference when the return value is a pointer. This is the default conversion policy for function arguments when calling Python functions manually from C++ code (i.e. via handle::operator()). You probably won't need to use this. */ automatic_reference, /** Reference an existing object (i.e. do not create a new copy) and take ownership. Python will call the destructor and delete operator when the object’s reference count reaches zero. Undefined behavior ensues when the C++ side does the same.. */ take_ownership, /** Create a new copy of the returned object, which will be owned by Python. This policy is comparably safe because the lifetimes of the two instances are decoupled. */ copy, /** Use std::move to move the return value contents into a new instance that will be owned by Python. This policy is comparably safe because the lifetimes of the two instances (move source and destination) are decoupled. */ move, /** Reference an existing object, but do not take ownership. The C++ side is responsible for managing the object’s lifetime and deallocating it when it is no longer used. Warning: undefined behavior will ensue when the C++ side deletes an object that is still referenced and used by Python. */ reference, /** This policy only applies to methods and properties. It references the object without taking ownership similar to the above return_value_policy::reference policy. In contrast to that policy, the function or property’s implicit this argument (called the parent) is considered to be the the owner of the return value (the child). pybind11 then couples the lifetime of the parent to the child via a reference relationship that ensures that the parent cannot be garbage collected while Python is still using the child. More advanced variations of this scheme are also possible using combinations of return_value_policy::reference and the keep_alive call policy */ reference_internal }; /// Information record describing a Python buffer object struct buffer_info { void *ptr = nullptr; // Pointer to the underlying storage size_t itemsize = 0; // Size of individual items in bytes size_t size = 0; // Total number of entries std::string format; // For homogeneous buffers, this should be set to format_descriptor::format() size_t ndim = 0; // Number of dimensions std::vector shape; // Shape of the tensor (1 entry per dimension) std::vector strides; // Number of entries between adjacent entries (for each per dimension) buffer_info() { } buffer_info(void *ptr, size_t itemsize, const std::string &format, size_t ndim, const std::vector &shape, const std::vector &strides) : ptr(ptr), itemsize(itemsize), size(1), format(format), ndim(ndim), shape(shape), strides(strides) { for (size_t i = 0; i < ndim; ++i) size *= shape[i]; } buffer_info(void *ptr, size_t itemsize, const std::string &format, size_t size) : buffer_info(ptr, itemsize, format, 1, std::vector { size }, std::vector { itemsize }) { } explicit buffer_info(Py_buffer *view, bool ownview = true) : ptr(view->buf), itemsize((size_t) view->itemsize), size(1), format(view->format), ndim((size_t) view->ndim), shape((size_t) view->ndim), strides((size_t) view->ndim), view(view), ownview(ownview) { for (size_t i = 0; i < (size_t) view->ndim; ++i) { shape[i] = (size_t) view->shape[i]; strides[i] = (size_t) view->strides[i]; size *= shape[i]; } } buffer_info(const buffer_info &) = delete; buffer_info& operator=(const buffer_info &) = delete; buffer_info(buffer_info &&other) { (*this) = std::move(other); } buffer_info& operator=(buffer_info &&rhs) { ptr = rhs.ptr; itemsize = rhs.itemsize; size = rhs.size; format = std::move(rhs.format); ndim = rhs.ndim; shape = std::move(rhs.shape); strides = std::move(rhs.strides); std::swap(view, rhs.view); std::swap(ownview, rhs.ownview); return *this; } ~buffer_info() { if (view && ownview) { PyBuffer_Release(view); delete view; } } private: Py_buffer *view = nullptr; bool ownview = false; }; NAMESPACE_BEGIN(detail) inline static constexpr int log2(size_t n, int k = 0) { return (n <= 1) ? k : log2(n >> 1, k + 1); } inline std::string error_string(); /// Core part of the 'instance' type which POD (needed to be able to use 'offsetof') template struct instance_essentials { PyObject_HEAD type *value; PyObject *weakrefs; bool owned : 1; bool holder_constructed : 1; }; /// PyObject wrapper around generic types, includes a special holder type that is responsible for lifetime management template > struct instance : instance_essentials { holder_type holder; }; struct overload_hash { inline size_t operator()(const std::pair& v) const { size_t value = std::hash()(v.first); value ^= std::hash()(v.second) + 0x9e3779b9 + (value<<6) + (value>>2); return value; } }; /// Internal data struture used to track registered instances and types struct internals { std::unordered_map registered_types_cpp; // std::type_index -> type_info std::unordered_map registered_types_py; // PyTypeObject* -> type_info std::unordered_multimap registered_instances; // void * -> PyObject* std::unordered_set, overload_hash> inactive_overload_cache; std::unordered_map> direct_conversions; std::forward_list registered_exception_translators; std::unordered_map shared_data; // Custom data to be shared across extensions #if defined(WITH_THREAD) decltype(PyThread_create_key()) tstate = 0; // Usually an int but a long on Cygwin64 with Python 3.x PyInterpreterState *istate = nullptr; #endif }; /// Return a reference to the current 'internals' information inline internals &get_internals(); /// Index sequence for convenient template metaprogramming involving tuples #ifdef PYBIND11_CPP14 using std::index_sequence; using std::make_index_sequence; #else template struct index_sequence { }; template struct make_index_sequence_impl : make_index_sequence_impl { }; template struct make_index_sequence_impl <0, S...> { typedef index_sequence type; }; template using make_index_sequence = typename make_index_sequence_impl::type; #endif /// Strip the class from a method type template struct remove_class { }; template struct remove_class { typedef R type(A...); }; template struct remove_class { typedef R type(A...); }; /// Helper template to strip away type modifiers template struct intrinsic_type { typedef T type; }; template struct intrinsic_type { typedef typename intrinsic_type::type type; }; template struct intrinsic_type { typedef typename intrinsic_type::type type; }; template struct intrinsic_type { typedef typename intrinsic_type::type type; }; template struct intrinsic_type { typedef typename intrinsic_type::type type; }; template struct intrinsic_type { typedef typename intrinsic_type::type type; }; template struct intrinsic_type { typedef typename intrinsic_type::type type; }; template using intrinsic_t = typename intrinsic_type::type; /// Helper type to replace 'void' in some expressions struct void_type { }; /// Helper template which holds a list of types template struct type_list { }; /// from __cpp_future__ import (convenient aliases from C++14/17) template using bool_constant = std::integral_constant; template using negation = bool_constant; template using enable_if_t = typename std::enable_if::type; template using conditional_t = typename std::conditional::type; /// Compile-time integer sum constexpr size_t constexpr_sum() { return 0; } template constexpr size_t constexpr_sum(T n, Ts... ns) { return size_t{n} + constexpr_sum(ns...); } // Counts the number of types in the template parameter pack matching the predicate #if !defined(_MSC_VER) template class Predicate, typename... Ts> using count_t = std::integral_constant::value...)>; #else // MSVC workaround (2015 Update 3 has issues with some member type aliases and constexpr) template class Predicate, typename... Ts> struct count_t; template class Predicate> struct count_t : std::integral_constant {}; template class Predicate, class T, class... Ts> struct count_t : std::integral_constant::value + count_t::value> {}; #endif /// Return true if all/any Ts satify Predicate template class Predicate, typename... Ts> using all_of_t = bool_constant<(count_t::value == sizeof...(Ts))>; template class Predicate, typename... Ts> using any_of_t = bool_constant<(count_t::value > 0)>; // Extracts the first type from the template parameter pack matching the predicate, or Default if none match. template class Predicate, class Default, class... Ts> struct first_of; template class Predicate, class Default> struct first_of { using type = Default; }; template class Predicate, class Default, class T, class... Ts> struct first_of { using type = typename std::conditional< Predicate::value, T, typename first_of::type >::type; }; template class Predicate, class Default, class... T> using first_of_t = typename first_of::type; /// Defer the evaluation of type T until types Us are instantiated template struct deferred_type { using type = T; }; template using deferred_t = typename deferred_type::type; template class Base> struct is_template_base_of_impl { template static std::true_type check(Base *); static std::false_type check(...); }; /// Check if a template is the base of a type. For example: /// `is_template_base_of` is true if `struct T : Base {}` where U can be anything template class Base, typename T> #if !defined(_MSC_VER) using is_template_base_of = decltype(is_template_base_of_impl::check((T*)nullptr)); #else // MSVC2015 has trouble with decltype in template aliases struct is_template_base_of : decltype(is_template_base_of_impl::check((T*)nullptr)) { }; #endif /// Check if T is std::shared_ptr where U can be anything template struct is_shared_ptr : std::false_type { }; template struct is_shared_ptr> : std::true_type { }; /// Ignore that a variable is unused in compiler warnings inline void ignore_unused(const int *) { } NAMESPACE_END(detail) /// Returns a named pointer that is shared among all extension modules (using the same /// pybind11 version) running in the current interpreter. Names starting with underscores /// are reserved for internal usage. Returns `nullptr` if no matching entry was found. inline PYBIND11_NOINLINE void* get_shared_data(const std::string& name) { auto& internals = detail::get_internals(); auto it = internals.shared_data.find(name); return it != internals.shared_data.end() ? it->second : nullptr; } /// Set the shared data that can be later recovered by `get_shared_data()`. inline PYBIND11_NOINLINE void *set_shared_data(const std::string& name, void *data) { detail::get_internals().shared_data[name] = data; return data; } /// Returns a typed reference to a shared data entry (by using `get_shared_data()`) if /// such entry exists. Otherwise, a new object of default-constructible type `T` is /// added to the shared data under the given name and a reference to it is returned. template T& get_or_create_shared_data(const std::string& name) { auto& internals = detail::get_internals(); auto it = internals.shared_data.find(name); T* ptr = (T*) (it != internals.shared_data.end() ? it->second : nullptr); if (!ptr) { ptr = new T(); internals.shared_data[name] = ptr; } return *ptr; } /// Fetch and hold an error which was already set in Python class error_already_set : public std::runtime_error { public: error_already_set() : std::runtime_error(detail::error_string()) { PyErr_Fetch(&type, &value, &trace); } error_already_set(const error_already_set &) = delete; error_already_set(error_already_set &&e) : std::runtime_error(e.what()), type(e.type), value(e.value), trace(e.trace) { e.type = e.value = e.trace = nullptr; } inline ~error_already_set(); // implementation in pybind11.h error_already_set& operator=(const error_already_set &) = delete; /// Give the error back to Python void restore() { PyErr_Restore(type, value, trace); type = value = trace = nullptr; } private: PyObject *type, *value, *trace; }; /// C++ bindings of builtin Python exceptions class builtin_exception : public std::runtime_error { public: using std::runtime_error::runtime_error; virtual void set_error() const = 0; /// Set the error using the Python C API }; #define PYBIND11_RUNTIME_EXCEPTION(name, type) \ class name : public builtin_exception { public: \ using builtin_exception::builtin_exception; \ name() : name("") { } \ void set_error() const override { PyErr_SetString(type, what()); } \ }; PYBIND11_RUNTIME_EXCEPTION(stop_iteration, PyExc_StopIteration) PYBIND11_RUNTIME_EXCEPTION(index_error, PyExc_IndexError) PYBIND11_RUNTIME_EXCEPTION(key_error, PyExc_KeyError) PYBIND11_RUNTIME_EXCEPTION(value_error, PyExc_ValueError) PYBIND11_RUNTIME_EXCEPTION(type_error, PyExc_TypeError) PYBIND11_RUNTIME_EXCEPTION(cast_error, PyExc_RuntimeError) /// Thrown when pybind11::cast or handle::call fail due to a type casting error PYBIND11_RUNTIME_EXCEPTION(reference_cast_error, PyExc_RuntimeError) /// Used internally [[noreturn]] PYBIND11_NOINLINE inline void pybind11_fail(const char *reason) { throw std::runtime_error(reason); } [[noreturn]] PYBIND11_NOINLINE inline void pybind11_fail(const std::string &reason) { throw std::runtime_error(reason); } /// Format strings for basic number types #define PYBIND11_DECL_FMT(t, v) template<> struct format_descriptor \ { static constexpr const char* value = v; /* for backwards compatibility */ \ static std::string format() { return value; } } template struct format_descriptor { }; template struct format_descriptor::value>> { static constexpr const char c = "bBhHiIqQ"[detail::log2(sizeof(T))*2 + std::is_unsigned::value]; static constexpr const char value[2] = { c, '\0' }; static std::string format() { return std::string(1, c); } }; template constexpr const char format_descriptor< T, detail::enable_if_t::value>>::value[2]; /// RAII wrapper that temporarily clears any Python error state struct error_scope { PyObject *type, *value, *trace; error_scope() { PyErr_Fetch(&type, &value, &trace); } ~error_scope() { PyErr_Restore(type, value, trace); } }; PYBIND11_DECL_FMT(float, "f"); PYBIND11_DECL_FMT(double, "d"); PYBIND11_DECL_FMT(bool, "?"); /// Dummy destructor wrapper that can be used to expose classes with a private destructor struct nodelete { template void operator()(T*) { } }; // overload_cast requires variable templates: C++14 or MSVC 2015 Update 2 #if defined(PYBIND11_CPP14) || ( \ defined(_MSC_FULL_VER) &&_MSC_FULL_VER >= 190023918) #define PYBIND11_OVERLOAD_CAST 1 NAMESPACE_BEGIN(detail) template struct overload_cast_impl { template constexpr auto operator()(Return (*pf)(Args...)) const noexcept -> decltype(pf) { return pf; } template constexpr auto operator()(Return (Class::*pmf)(Args...), std::false_type = {}) const noexcept -> decltype(pmf) { return pmf; } template constexpr auto operator()(Return (Class::*pmf)(Args...) const, std::true_type) const noexcept -> decltype(pmf) { return pmf; } }; NAMESPACE_END(detail) /// Syntax sugar for resolving overloaded function pointers: /// - regular: static_cast(&Class::func) /// - sweet: overload_cast(&Class::func) template static constexpr detail::overload_cast_impl overload_cast = {}; // MSVC 2015 only accepts this particular initialization syntax for this variable template. /// Const member function selector for overload_cast /// - regular: static_cast(&Class::func) /// - sweet: overload_cast(&Class::func, const_) static constexpr auto const_ = std::true_type{}; #endif // overload_cast NAMESPACE_END(pybind11)