#include "detail/common.h"
#include "detail/descr.h"
#include "detail/type_caster_base.h"
#include "detail/typeid.h"
#include "pytypes.h"
#include <array>
#include <cstring>
#include <functional>
#include <iosfwd>
#include <iterator>
#include <memory>
#include <string>
#include <tuple>
#include <type_traits>
#include <utility>
#include <vector>

Include dependency graph for cast.h:

This graph shows which files directly or indirectly include this file:

Classes
class	type_caster< type, SFINAE >

class	type_caster< std::reference_wrapper< type > >

struct	type_caster< T, enable_if_t< std::is_arithmetic< T >::value &&!is_std_char_type< T >::value > >

struct	void_caster< T >

class	type_caster< void_type >

class	type_caster< void >

class	type_caster< std::nullptr_t >

class	type_caster< bool >

struct	string_caster< StringType, IsView >

struct	type_caster< std::basic_string< CharT, Traits, Allocator >, enable_if_t< is_std_char_type< CharT >::value > >

struct	type_caster< CharT, enable_if_t< is_std_char_type< CharT >::value > >

class	tuple_caster< Tuple, Ts >

class	type_caster< std::pair< T1, T2 > >

class	type_caster< std::tuple< Ts... > >

struct	holder_helper< T >
	Helper class which abstracts away certain actions. More...

struct	copyable_holder_caster< type, holder_type, SFINAE >
	Type caster for holder types like std::shared_ptr, etc. More...

class	type_caster< std::shared_ptr< T > >
	Specialize for the common std::shared_ptr, so users don't need to. More...

struct	move_only_holder_caster< type, holder_type, SFINAE >
	Type caster for holder types like std::unique_ptr. More...

class	type_caster< std::unique_ptr< type, deleter > >

struct	always_construct_holder< T, Value >

struct	is_holder_type< base, holder >

struct	is_holder_type< base, std::unique_ptr< base, deleter > >

struct	handle_type_name< T >

struct	handle_type_name< bool_ >

struct	handle_type_name< bytes >

struct	handle_type_name< int_ >

struct	handle_type_name< iterable >

struct	handle_type_name< iterator >

struct	handle_type_name< float_ >

struct	handle_type_name< none >

struct	handle_type_name< args >

struct	handle_type_name< kwargs >

struct	pyobject_caster< type >

class	type_caster< T, enable_if_t< is_pyobject< T >::value > >

struct	move_always< T, SFINAE >

struct	move_always< T, enable_if_t< all_of< move_is_plain_type< T >, negation< is_copy_constructible< T > >, std::is_move_constructible< T >, std::is_same< decltype(std::declval< make_caster< T > >().operator T&()), T & > >::value > >

struct	move_if_unreferenced< T, SFINAE >

struct	move_if_unreferenced< T, enable_if_t< all_of< move_is_plain_type< T >, negation< move_always< T > >, std::is_move_constructible< T >, std::is_same< decltype(std::declval< make_caster< T > >().operator T&()), T & > >::value > >

struct	return_value_policy_override< Return, SFINAE >

struct	return_value_policy_override< Return, detail::enable_if_t< std::is_base_of< type_caster_generic, make_caster< Return > >::value, void > >

struct	override_unused

struct	arg
	Annotation for arguments. More...

struct	arg_v
	Annotation for arguments with values. More...

struct	kw_only
	Annotation indicating that all following arguments are keyword-only; the is the equivalent of an unnamed '*' argument (in Python 3) More...

struct	pos_only
	Annotation indicating that all previous arguments are positional-only; the is the equivalent of an unnamed '/' argument (in Python 3.8) More...

struct	function_call
	Internal data associated with a single function call. More...

class	argument_loader< Args >
	Helper class which loads arguments for C++ functions called from Python. More...

class	simple_collector< policy >
	Helper class which collects only positional arguments for a Python function call. More...

class	unpacking_collector< policy >
	Helper class which collects positional, keyword, * and ** arguments for a Python function call. More...

Namespaces
namespace	literals

Macros
#define	PYBIND11_TYPE_CASTER(type, py_name)

#define	PYBIND11_DECLARE_HOLDER_TYPE(type, holder_type, ...)
	Create a specialization for custom holder types (silently ignores std::shared_ptr) More...

#define	PYBIND11_MAKE_OPAQUE(...)

#define	PYBIND11_TYPE(...) __VA_ARGS__
	Lets you pass a type containing a `,` through a macro parameter without needing a separate typedef, e.g.: `PYBIND11_OVERRIDE(PYBIND11_TYPE(ReturnType<A, B>), PYBIND11_TYPE(Parent<C, D>), f, arg)` More...

Typedefs
template<typename type >
using	make_caster = type_caster< intrinsic_t< type > >

template<typename CharT >
using	is_std_char_type = any_of< std::is_same< CharT, char >, std::is_same< CharT, char16_t >, std::is_same< CharT, char32_t >, std::is_same< CharT, wchar_t > >

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

template<typename T >
using	move_is_plain_type = satisfies_none_of< T, std::is_void, std::is_pointer, std::is_reference, std::is_const >

template<typename T >
using	move_never = none_of< move_always< T >, move_if_unreferenced< T > >

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 &&!std::is_same< intrinsic_t< type >, void >::value >

template<typename ret_type >
using	override_caster_t = conditional_t< cast_is_temporary_value_reference< ret_type >::value, make_caster< ret_type >, override_unused >

template<typename >
using	arg_t = arg_v
	Alias for backward compatibility – to be removed in version 2.0. More...

template<typename T >
using	is_kw_only = std::is_same< intrinsic_t< T >, kw_only >

template<typename T >
using	is_pos_only = std::is_same< intrinsic_t< T >, pos_only >

Functions
template<typename T >
make_caster< T >::template cast_op_type< T >	cast_op (make_caster< T > &caster)

template<typename T >
make_caster< T >::template cast_op_type< typename std::add_rvalue_reference< T >::type >	cast_op (make_caster< T > &&caster)

template<typename T , typename SFINAE >
type_caster< T, SFINAE > &	load_type (type_caster< T, SFINAE > &conv, const handle &handle)

template<typename T >
make_caster< T >	load_type (const handle &handle)

template<typename T , detail::enable_if_t<!detail::is_pyobject< T >::value, int > = 0>
T	cast (const handle &handle)

template<typename T , detail::enable_if_t<!detail::is_pyobject< T >::value, int > = 0>
object	cast (T &&value, return_value_policy policy=return_value_policy::automatic_reference, handle parent=handle())

template<typename T >
detail::enable_if_t<!detail::move_never< T >::value, T >	move (object &&obj)

template<typename T >
detail::enable_if_t< detail::move_always< T >::value, T >	cast (object &&object)

template<typename T >
detail::enable_if_t< detail::move_if_unreferenced< T >::value, T >	cast (object &&object)

template<typename T >
detail::enable_if_t< detail::move_never< T >::value, T >	cast (object &&object)

template<typename T , enable_if_t<!is_pyobject< T >::value, int > >
object	object_or_cast (T &&o)

template<typename T >
enable_if_t< cast_is_temporary_value_reference< T >::value, T >	cast_ref (object &&o, make_caster< T > &caster)

template<typename T >
enable_if_t<!cast_is_temporary_value_reference< T >::value, T >	cast_ref (object &&, override_unused &)

template<typename T >
enable_if_t<!cast_is_temporary_value_reference< T >::value, T >	cast_safe (object &&o)

template<typename T >
enable_if_t< cast_is_temporary_value_reference< T >::value, T >	cast_safe (object &&)

template<>
void	cast_safe< void > (object &&)

cast_error	cast_error_unable_to_convert_call_arg (const std::string &name, const std::string &type)

template<return_value_policy policy = return_value_policy::automatic_reference>
tuple	make_tuple ()

template<return_value_policy policy = return_value_policy::automatic_reference, typename... Args>
tuple	make_tuple (Args &&...args_)

constexpr arg	literals::operator""_a (const char *name, size_t)
	\rst String literal version of `arg` \endrst More...

template<typename... Args>
constexpr bool	args_are_all_positional ()

template<return_value_policy policy, typename... Args, typename = enable_if_t<args_are_all_positional<Args...>()>>
simple_collector< policy >	collect_arguments (Args &&...args)
	Collect only positional arguments for a Python function call. More...

template<return_value_policy policy, typename... Args, typename = enable_if_t<!args_are_all_positional<Args...>()>>
unpacking_collector< policy >	collect_arguments (Args &&...args)
	Collect all arguments, including keywords and unpacking (only instantiated when needed) More...

Macro Definition Documentation

◆ PYBIND11_DECLARE_HOLDER_TYPE

#define PYBIND11_DECLARE_HOLDER_TYPE	(	type,
		holder_type,
		...
	)

Value:

    namespace pybind11 {                                                                          \
    namespace detail {                                                                            \
    template <typename type>                                                                      \
    struct always_construct_holder<holder_type> : always_construct_holder<void, ##__VA_ARGS__> {  \
    };                                                                                            \
    template <typename type>                                                                      \
    class type_caster<holder_type, enable_if_t<!is_shared_ptr<holder_type>::value>>               \
        : public type_caster_holder<type, holder_type> {};                                        \
    }                                                                                             \
    }

Create a specialization for custom holder types (silently ignores std::shared_ptr)

Definition at line 858 of file cast.h.

◆ PYBIND11_MAKE_OPAQUE

#define PYBIND11_MAKE_OPAQUE ( ... )

Value:

    namespace pybind11 {                                                                          \
    namespace detail {                                                                            \
    template <>                                                                                   \
    class type_caster<__VA_ARGS__> : public type_caster_base<__VA_ARGS__> {};                     \
    }                                                                                             \
    }

Definition at line 1650 of file cast.h.

◆ PYBIND11_TYPE

#define PYBIND11_TYPE ( ... ) __VA_ARGS__

Lets you pass a type containing a , through a macro parameter without needing a separate typedef, e.g.: PYBIND11_OVERRIDE(PYBIND11_TYPE(ReturnType<A, B>), PYBIND11_TYPE(Parent<C, D>), f, arg)

Definition at line 1661 of file cast.h.

◆ PYBIND11_TYPE_CASTER

#define PYBIND11_TYPE_CASTER	(	type,
		py_name
	)

Value:

protected:                                                                                        \
    type value;                                                                                   \
                                                                                                  \
public:                                                                                           \
    static constexpr auto name = py_name;                                                         \
    template <typename T_,                                                                        \
              ::pybind11::detail::enable_if_t<                                                    \
                  std::is_same<type, ::pybind11::detail::remove_cv_t<T_>>::value,                 \
                  int> = 0>                                                                       \
    static ::pybind11::handle cast(                                                               \
        T_ *src, ::pybind11::return_value_policy policy, ::pybind11::handle parent) {             \
        if (!src)                                                                                 \
            return ::pybind11::none().release();                                                  \
        if (policy == ::pybind11::return_value_policy::take_ownership) {                          \
            auto h = cast(std::move(*src), policy, parent);                                       \
            delete src;                                                                           \
            return h;                                                                             \
        }                                                                                         \
        return cast(*src, policy, parent);                                                        \
    }                                                                                             \
    operator type *() { return &value; }               /* NOLINT(bugprone-macro-parentheses) */   \
    operator type &() { return value; }                /* NOLINT(bugprone-macro-parentheses) */   \
    operator type &&() && { return std::move(value); } /* NOLINT(bugprone-macro-parentheses) */   \
    template <typename T_>                                                                        \
    using cast_op_type = ::pybind11::detail::movable_cast_op_type<T_>

Definition at line 82 of file cast.h.

Typedef Documentation

◆ arg_t

template<typename >

using arg_t = arg_v

Alias for backward compatibility – to be removed in version 2.0.

Definition at line 1335 of file cast.h.

◆ cast_is_temporary_value_reference

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 && !std::is_same<intrinsic_t<type>, void>::value>

Definition at line 999 of file cast.h.

◆ is_kw_only

template<typename T >

using is_kw_only = std::is_same<intrinsic_t<T>, kw_only>

Definition at line 1347 of file cast.h.

◆ is_pos_only

template<typename T >

using is_pos_only = std::is_same<intrinsic_t<T>, pos_only>

Definition at line 1349 of file cast.h.

◆ is_std_char_type

template<typename CharT >

using is_std_char_type = any_of<std::is_same<CharT, char>, std::is_same<CharT, char16_t>, std::is_same<CharT, char32_t>, std::is_same<CharT, wchar_t> >

Definition at line 110 of file cast.h.

◆ make_caster

template<typename type >

using make_caster = type_caster<intrinsic_t<type> >

Definition at line 37 of file cast.h.

◆ move_is_plain_type

template<typename T >

using move_is_plain_type = satisfies_none_of<T, std::is_void, std::is_pointer, std::is_reference, std::is_const>

Definition at line 967 of file cast.h.

◆ move_never

template<typename T >

using move_never = none_of<move_always<T>, move_if_unreferenced<T> >

Definition at line 992 of file cast.h.

◆ override_caster_t

template<typename ret_type >

using override_caster_t = conditional_t<cast_is_temporary_value_reference<ret_type>::value, make_caster<ret_type>, override_unused>

Definition at line 1160 of file cast.h.

◆ type_caster_holder

template<typename type , typename holder_type >

using type_caster_holder = conditional_t<is_copy_constructible<holder_type>::value, copyable_holder_caster<type, holder_type>, move_only_holder_caster<type, holder_type> >

Definition at line 848 of file cast.h.

Function Documentation

◆ args_are_all_positional()

template<typename... Args>

constexpr bool args_are_all_positional ( )

constexpr

Definition at line 1596 of file cast.h.

◆ cast() [1/5]

template<typename T , detail::enable_if_t<!detail::is_pyobject< T >::value, int > = 0>

T cast ( const handle & handle )

Definition at line 1050 of file cast.h.

Referenced by make_iterator_impl(), print(), and vectorize_helper< Func, Return, Args >::run().

◆ cast() [2/5]

template<typename T >

detail::enable_if_t< detail::move_always< T >::value, T > cast ( object && object )

Definition at line 1116 of file cast.h.

◆ cast() [3/5]

template<typename T >

detail::enable_if_t< detail::move_if_unreferenced< T >::value, T > cast ( object && object )

Definition at line 1120 of file cast.h.

◆ cast() [4/5]

template<typename T >

detail::enable_if_t< detail::move_never< T >::value, T > cast ( object && object )

Definition at line 1127 of file cast.h.

◆ cast() [5/5]

template<typename T , detail::enable_if_t<!detail::is_pyobject< T >::value, int > = 0>

object cast	(	T &&	value,
		return_value_policy	policy = `return_value_policy::automatic_reference`,
		handle	parent = `handle()`
	)

Definition at line 1065 of file cast.h.

References automatic, automatic_reference, type_caster_generic::cast(), copy, move, reference, and take_ownership.

◆ cast_error_unable_to_convert_call_arg()

cast_error cast_error_unable_to_convert_call_arg	(	const std::string &	name,
		const std::string &	type
	)

inline

Definition at line 1201 of file cast.h.

Referenced by make_tuple().

◆ cast_op() [1/2]

template<typename T >

make_caster< T >::template cast_op_type< typename std::add_rvalue_reference< T >::type > cast_op ( make_caster< T > && caster )

Definition at line 46 of file cast.h.

◆ cast_op() [2/2]

template<typename T >

make_caster< T >::template cast_op_type< T > cast_op ( make_caster< T > & caster )

Definition at line 41 of file cast.h.

◆ cast_ref() [1/2]

template<typename T >

enable_if_t<!cast_is_temporary_value_reference< T >::value, T > cast_ref	(	object &&	,
		override_unused &
	)

Definition at line 1172 of file cast.h.

References pybind11_fail().

◆ cast_ref() [2/2]

template<typename T >

enable_if_t< cast_is_temporary_value_reference< T >::value, T > cast_ref	(	object &&	o,
		make_caster< T > &	caster
	)

Definition at line 1167 of file cast.h.

References load_type().

◆ cast_safe() [1/2]

template<typename T >

enable_if_t< cast_is_temporary_value_reference< T >::value, T > cast_safe ( object && )

Definition at line 1185 of file cast.h.

References pybind11_fail().

◆ cast_safe() [2/2]

template<typename T >

enable_if_t<!cast_is_temporary_value_reference< T >::value, T > cast_safe ( object && o )

Definition at line 1181 of file cast.h.

◆ cast_safe< void >()

template<>

void cast_safe< void > ( object && )

inline

Definition at line 1189 of file cast.h.

◆ collect_arguments() [1/2]

template<return_value_policy policy, typename... Args, typename = enable_if_t<args_are_all_positional<Args...>()>>

simple_collector< policy > collect_arguments ( Args &&... args )

Collect only positional arguments for a Python function call.

Definition at line 1604 of file cast.h.

◆ collect_arguments() [2/2]

template<return_value_policy policy, typename... Args, typename = enable_if_t<!args_are_all_positional<Args...>()>>

unpacking_collector< policy > collect_arguments ( Args &&... args )

Collect all arguments, including keywords and unpacking (only instantiated when needed)

Definition at line 1612 of file cast.h.

References constexpr_last().

◆ load_type() [1/2]

template<typename T >

make_caster< T > load_type ( const handle & handle )

Definition at line 1040 of file cast.h.

References load_type().

◆ load_type() [2/2]

template<typename T , typename SFINAE >

type_caster< T, SFINAE > & load_type	(	type_caster< T, SFINAE > &	conv,
		const handle &	handle
	)

Definition at line 1025 of file cast.h.

References type::handle_of().

Referenced by cast_ref(), and load_type().

◆ make_tuple() [1/2]

template<return_value_policy policy = return_value_policy::automatic_reference>

tuple make_tuple ( )

Definition at line 1209 of file cast.h.

◆ make_tuple() [2/2]

template<return_value_policy policy = return_value_policy::automatic_reference, typename... Args>

tuple make_tuple ( Args &&... args_ )

Definition at line 1214 of file cast.h.

References type_caster_generic::cast(), cast_error_unable_to_convert_call_arg(), and tuple::size().

◆ move()

template<typename T >

detail::enable_if_t<!detail::move_never< T >::value, T > move ( object && obj )

Definition at line 1092 of file cast.h.

References type::handle_of().

◆ object_or_cast()

template<typename T , enable_if_t<!is_pyobject< T >::value, int > >

object object_or_cast ( T && o )

Definition at line 1152 of file cast.h.

Classes

Namespaces

Macros

Typedefs

Functions

Macro Definition Documentation

◆ PYBIND11_DECLARE_HOLDER_TYPE

◆ PYBIND11_MAKE_OPAQUE

◆ PYBIND11_TYPE

◆ PYBIND11_TYPE_CASTER

Typedef Documentation

◆ arg_t

◆ cast_is_temporary_value_reference

◆ is_kw_only

◆ is_pos_only

◆ is_std_char_type

◆ make_caster

◆ move_is_plain_type

◆ move_never

◆ override_caster_t

◆ type_caster_holder

Function Documentation

◆ args_are_all_positional()

◆ cast() [1/5]

◆ cast() [2/5]

◆ cast() [3/5]

◆ cast() [4/5]

◆ cast() [5/5]

◆ cast_error_unable_to_convert_call_arg()

◆ cast_op() [1/2]

◆ cast_op() [2/2]

◆ cast_ref() [1/2]

◆ cast_ref() [2/2]

◆ cast_safe() [1/2]

◆ cast_safe() [2/2]

◆ cast_safe< void >()

◆ collect_arguments() [1/2]

◆ collect_arguments() [2/2]

◆ load_type() [1/2]

◆ load_type() [2/2]

◆ make_tuple() [1/2]

◆ make_tuple() [2/2]

◆ move()

◆ object_or_cast()