internals.h File Reference

#include "../pytypes.h"

Go to the source code of this file.

Classes
struct	type_hash
struct	type_equal_to
struct	override_hash
struct	internals
struct	type_info

Macros
#define	PYBIND11_TLS_KEY_INIT(var)   decltype(PyThread_create_key()) var = 0
#define	PYBIND11_TLS_GET_VALUE(key)   PyThread_get_key_value((key))
#define	PYBIND11_TLS_DELETE_VALUE(key)   PyThread_delete_key_value(key)
#define	PYBIND11_TLS_REPLACE_VALUE(key, value)
#define	PYBIND11_TLS_FREE(key)   (void)key
#define	PYBIND11_INTERNALS_VERSION   4
	Tracks the internals and type_info ABI version independent of the main library version. More...
#define	PYBIND11_BUILD_TYPE   ""
	On MSVC, debug and release builds are not ABI-compatible! More...
#define	PYBIND11_COMPILER_TYPE   "_unknown"
#define	PYBIND11_STDLIB   ""
	Also standard libs. More...
#define	PYBIND11_BUILD_ABI   ""
	On Linux/OSX, changes in GXX_ABI_VERSION indicate ABI incompatibility. More...
#define	PYBIND11_INTERNALS_KIND   "_without_thread"
#define	PYBIND11_INTERNALS_ID
#define	PYBIND11_MODULE_LOCAL_ID

Typedefs
template<typename value_type >
using	type_map = std::unordered_map< std::type_index, value_type, type_hash, type_equal_to >

Functions
PyTypeObject *	make_static_property_type ()
PyTypeObject *	make_default_metaclass ()
PyObject *	make_object_base_type (PyTypeObject *metaclass)
bool	same_type (const std::type_info &lhs, const std::type_info &rhs)
internals **&	get_internals_pp ()
void	translate_exception (std::exception_ptr p)
void	translate_local_exception (std::exception_ptr p)
PYBIND11_NOINLINE internals &	get_internals ()
	Return a reference to the current internals data. More...
type_map< type_info * > &	registered_local_types_cpp ()
	Works like internals.registered_types_cpp, but for module-local registered types: More...
template<typename... Args>
const char *	c_str (Args &&...args)
PYBIND11_NOINLINE void *	get_shared_data (const std::string &name)
PYBIND11_NOINLINE void *	set_shared_data (const std::string &name, void *data)
	Set the shared data that can be later recovered by get_shared_data(). More...
template<typename T >
T &	get_or_create_shared_data (const std::string &name)

Macro Definition Documentation

PYBIND11_BUILD_ABI

#define PYBIND11_BUILD_ABI   ""

On Linux/OSX, changes in GXX_ABI_VERSION indicate ABI incompatibility.

Definition at line 202 of file internals.h.

PYBIND11_BUILD_TYPE

#define PYBIND11_BUILD_TYPE   ""

On MSVC, debug and release builds are not ABI-compatible!

Definition at line 160 of file internals.h.

PYBIND11_COMPILER_TYPE

#define PYBIND11_COMPILER_TYPE   "_unknown"

Let's assume that different compilers are ABI-incompatible. A user can manually set this string if they know their compiler is compatible.

Definition at line 182 of file internals.h.

PYBIND11_INTERNALS_ID

#define PYBIND11_INTERNALS_ID

Value:

    "__pybind11_internals_v" \
    PYBIND11_TOSTRING(PYBIND11_INTERNALS_VERSION) PYBIND11_INTERNALS_KIND PYBIND11_COMPILER_TYPE PYBIND11_STDLIB PYBIND11_BUILD_ABI PYBIND11_BUILD_TYPE "__"

Definition at line 214 of file internals.h.

PYBIND11_INTERNALS_KIND

#define PYBIND11_INTERNALS_KIND   "_without_thread"

Definition at line 210 of file internals.h.

PYBIND11_INTERNALS_VERSION

#define PYBIND11_INTERNALS_VERSION   4

Tracks the internals and type_info ABI version independent of the main library version.

Definition at line 154 of file internals.h.

PYBIND11_MODULE_LOCAL_ID

#define PYBIND11_MODULE_LOCAL_ID

Value:

    "__pybind11_module_local_v" \
    PYBIND11_TOSTRING(PYBIND11_INTERNALS_VERSION) PYBIND11_INTERNALS_KIND PYBIND11_COMPILER_TYPE PYBIND11_STDLIB PYBIND11_BUILD_ABI PYBIND11_BUILD_TYPE "__"

Definition at line 217 of file internals.h.

PYBIND11_STDLIB

#define PYBIND11_STDLIB   ""

Also standard libs.

Definition at line 193 of file internals.h.

PYBIND11_TLS_DELETE_VALUE

#define PYBIND11_TLS_DELETE_VALUE

(

key

)

PyThread_delete_key_value(key)

Definition at line 35 of file internals.h.

PYBIND11_TLS_FREE

#define PYBIND11_TLS_FREE

(

key

)

(void)key

Definition at line 48 of file internals.h.

PYBIND11_TLS_GET_VALUE

#define PYBIND11_TLS_GET_VALUE

(

key

)

PyThread_get_key_value((key))

Definition at line 33 of file internals.h.

PYBIND11_TLS_KEY_INIT

#define PYBIND11_TLS_KEY_INIT

(

var

)

decltype(PyThread_create_key()) var = 0

Definition at line 32 of file internals.h.

PYBIND11_TLS_REPLACE_VALUE

#define PYBIND11_TLS_REPLACE_VALUE	(		key,
			value
	)

Value:

             do {                                                            \
                 PyThread_delete_key_value((key));                           \
                 PyThread_set_key_value((key), (value));                     \
             } while (false)

Definition at line 37 of file internals.h.

Typedef Documentation

type_map

template<typename value_type >

using type_map = std::unordered_map<std::type_index, value_type, type_hash, type_equal_to>

Definition at line 83 of file internals.h.

Function Documentation

c_str()

template<typename... Args>

const char* c_str

(

Args &&...

args

)

Constructs a std::string with the given arguments, stores it in internals, and returns its c_str(). Such strings objects have a long storage duration – the internal strings are only cleared when the program exits or after interpreter shutdown (when embedding), and so are suitable for c-style strings needed by Python internals (such as PyTypeObject's tp_name).

Definition at line 325 of file internals.h.

get_internals()

PYBIND11_NOINLINE internals& get_internals ( )

inline

Return a reference to the current internals data.

Definition at line 256 of file internals.h.

get_internals_pp()

internals**& get_internals_pp ( )

inline

Each module locally stores a pointer to the internals data. The data itself is shared among modules with the same PYBIND11_INTERNALS_ID.

Definition at line 221 of file internals.h.

get_or_create_shared_data()

template<typename T >

T& get_or_create_shared_data

(

const std::string &

name

)

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.

Definition at line 352 of file internals.h.

get_shared_data()

PYBIND11_NOINLINE void* get_shared_data ( const std::string &  name )

inline

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.

Definition at line 336 of file internals.h.

make_default_metaclass()

PyTypeObject* make_default_metaclass ( )

inline

This metaclass is assigned by default to all pybind11 types and is required in order for static properties to function correctly. Users may override this using py::metaclass. Return value: New reference.

Definition at line 237 of file class.h.

make_object_base_type()

PyObject* make_object_base_type ( PyTypeObject *  metaclass )

inline

Create the type which can be used as a common base for all classes. This is needed in order to satisfy Python's requirements for multiple inheritance. Return value: New reference.

Definition at line 443 of file class.h.

make_static_property_type()

PyTypeObject* make_static_property_type ( )

inline

A static_property is the same as a property but the __get__() and __set__() methods are modified to always use the object type instead of a concrete instance. Return value: New reference.

Definition at line 60 of file class.h.

registered_local_types_cpp()

type_map<type_info *>& registered_local_types_cpp ( )

inline

Works like internals.registered_types_cpp, but for module-local registered types:

Definition at line 315 of file internals.h.

same_type()

bool same_type ( const std::type_info &  lhs, const std::type_info &  rhs  )

inline

Definition at line 61 of file internals.h.

set_shared_data()

PYBIND11_NOINLINE void* set_shared_data ( const std::string &  name, void *  data  )

inline

Set the shared data that can be later recovered by get_shared_data().

Definition at line 343 of file internals.h.

translate_exception()

void translate_exception ( std::exception_ptr  p )

inline

Definition at line 226 of file internals.h.

translate_local_exception()

void translate_local_exception ( std::exception_ptr  p )

inline

Definition at line 246 of file internals.h.