Blender V5.0
Classes | Macros | Functions | Variables
idprop_py_api.hh File Reference
Blender » Python » Python Generic
#include <Python.h>

Go to the source code of this file.

Classes

struct  BPy_IDProperty
struct  BPy_IDArray
struct  BPy_IDGroup_Iter
struct  BPy_IDGroup_View

Macros

#define BPy_IDArray_Check(v)
#define BPy_IDArray_CheckExact(v)
#define BPy_IDGroup_Check(v)
#define BPy_IDGroup_CheckExact(v)
#define BPy_IDGroup_ViewKeys_Check(v)
#define BPy_IDGroup_ViewKeys_CheckExact(v)
#define BPy_IDGroup_ViewValues_Check(v)
#define BPy_IDGroup_ViewValues_CheckExact(v)
#define BPy_IDGroup_ViewItems_Check(v)
#define BPy_IDGroup_ViewItems_CheckExact(v)
#define BPy_IDGroup_IterKeys_Check(v)
#define BPy_IDGroup_IterKeys_CheckExact(v)
#define BPy_IDGroup_IterValues_Check(v)
#define BPy_IDGroup_IterValues_CheckExact(v)
#define BPy_IDGroup_IterItems_Check(v)
#define BPy_IDGroup_IterItems_CheckExact(v)

Functions

PyObject * BPy_Wrap_GetKeys (IDProperty *prop)
PyObject * BPy_Wrap_GetValues (ID *id, IDProperty *prop)
PyObject * BPy_Wrap_GetItems (ID *id, IDProperty *prop)
PyObject * BPy_Wrap_GetKeys_View_WithID (ID *id, IDProperty *prop)
PyObject * BPy_Wrap_GetValues_View_WithID (ID *id, IDProperty *prop)
PyObject * BPy_Wrap_GetItems_View_WithID (ID *id, IDProperty *prop)
int BPy_Wrap_SetMapItem (IDProperty *prop, PyObject *key, PyObject *val)
PyObject * BPy_IDGroup_MapDataToPy (IDProperty *prop)
PyObject * BPy_IDGroup_WrapData (ID *id, IDProperty *prop, IDProperty *parent)
bool BPy_IDProperty_Map_ValidateAndCreate (PyObject *key, IDProperty *group, PyObject *ob)
void IDProp_Init_Types ()
PyObject * BPyInit_idprop ()

Variables

PyTypeObject BPy_IDArray_Type
PyTypeObject BPy_IDGroup_Type
PyTypeObject BPy_IDGroup_ViewKeys_Type
PyTypeObject BPy_IDGroup_ViewValues_Type
PyTypeObject BPy_IDGroup_ViewItems_Type
PyTypeObject BPy_IDGroup_IterKeys_Type
PyTypeObject BPy_IDGroup_IterValues_Type
PyTypeObject BPy_IDGroup_IterItems_Type

Macro Definition Documentation

◆ BPy_IDArray_Check

#define BPy_IDArray_Check ( v)
Value:
(PyObject_TypeCheck(v, &BPy_IDArray_Type))
v
ATTR_WARN_UNUSED_RESULT const BMVert * v
Definition bmesh_query_inline.hh:23
BPy_IDArray_Type
PyTypeObject BPy_IDArray_Type
Definition idprop_py_api.cc:2498

Definition at line 28 of file idprop_py_api.hh.

◆ BPy_IDArray_CheckExact

#define BPy_IDArray_CheckExact ( v)
Value:
(Py_TYPE(v) == &BPy_IDArray_Type)

Definition at line 29 of file idprop_py_api.hh.

◆ BPy_IDGroup_Check

#define BPy_IDGroup_Check ( v)
Value:
(PyObject_TypeCheck(v, &BPy_IDGroup_Type))
BPy_IDGroup_Type
PyTypeObject BPy_IDGroup_Type
Definition idprop_py_api.cc:2038

Definition at line 30 of file idprop_py_api.hh.

Referenced by BPy_IDGroup_update().

◆ BPy_IDGroup_CheckExact

#define BPy_IDGroup_CheckExact ( v)
Value:
(Py_TYPE(v) == &BPy_IDGroup_Type)

Definition at line 31 of file idprop_py_api.hh.

◆ BPy_IDGroup_IterItems_Check

#define BPy_IDGroup_IterItems_Check ( v)
Value:
(PyObject_TypeCheck(v, &BPy_IDGroup_IterItems_Type))
BPy_IDGroup_IterItems_Type
PyTypeObject BPy_IDGroup_IterItems_Type
Definition idprop_py_api.cc:1400

Definition at line 44 of file idprop_py_api.hh.

◆ BPy_IDGroup_IterItems_CheckExact

#define BPy_IDGroup_IterItems_CheckExact ( v)
Value:
(Py_TYPE(v) == &BPy_IDGroup_IterItems_Type)

Definition at line 45 of file idprop_py_api.hh.

◆ BPy_IDGroup_IterKeys_Check

#define BPy_IDGroup_IterKeys_Check ( v)
Value:
(PyObject_TypeCheck(v, &BPy_IDGroup_IterKeys_Type))
BPy_IDGroup_IterKeys_Type
PyTypeObject BPy_IDGroup_IterKeys_Type
Definition idprop_py_api.cc:1398

Definition at line 40 of file idprop_py_api.hh.

◆ BPy_IDGroup_IterKeys_CheckExact

#define BPy_IDGroup_IterKeys_CheckExact ( v)
Value:
(Py_TYPE(v) == &BPy_IDGroup_IterKeys_Type)

Definition at line 41 of file idprop_py_api.hh.

◆ BPy_IDGroup_IterValues_Check

#define BPy_IDGroup_IterValues_Check ( v)
Value:
(PyObject_TypeCheck(v, &BPy_IDGroup_IterValues_Type))
BPy_IDGroup_IterValues_Type
PyTypeObject BPy_IDGroup_IterValues_Type
Definition idprop_py_api.cc:1399

Definition at line 42 of file idprop_py_api.hh.

◆ BPy_IDGroup_IterValues_CheckExact

#define BPy_IDGroup_IterValues_CheckExact ( v)
Value:
(Py_TYPE(v) == &BPy_IDGroup_IterValues_Type)

Definition at line 43 of file idprop_py_api.hh.

◆ BPy_IDGroup_ViewItems_Check

#define BPy_IDGroup_ViewItems_Check ( v)
Value:
(PyObject_TypeCheck(v, &BPy_IDGroup_ViewItems_Type))
BPy_IDGroup_ViewItems_Type
PyTypeObject BPy_IDGroup_ViewItems_Type
Definition idprop_py_api.cc:1638

Definition at line 37 of file idprop_py_api.hh.

◆ BPy_IDGroup_ViewItems_CheckExact

#define BPy_IDGroup_ViewItems_CheckExact ( v)
Value:
(Py_TYPE(v) == &BPy_IDGroup_ViewItems_Type)

Definition at line 38 of file idprop_py_api.hh.

◆ BPy_IDGroup_ViewKeys_Check

#define BPy_IDGroup_ViewKeys_Check ( v)
Value:
(PyObject_TypeCheck(v, &BPy_IDGroup_ViewKeys_Type))
BPy_IDGroup_ViewKeys_Type
PyTypeObject BPy_IDGroup_ViewKeys_Type
Definition idprop_py_api.cc:1636

Definition at line 33 of file idprop_py_api.hh.

◆ BPy_IDGroup_ViewKeys_CheckExact

#define BPy_IDGroup_ViewKeys_CheckExact ( v)
Value:
(Py_TYPE(v) == &BPy_IDGroup_ViewKeys_Type)

Definition at line 34 of file idprop_py_api.hh.

◆ BPy_IDGroup_ViewValues_Check

#define BPy_IDGroup_ViewValues_Check ( v)
Value:
(PyObject_TypeCheck(v, &BPy_IDGroup_ViewValues_Type))
BPy_IDGroup_ViewValues_Type
PyTypeObject BPy_IDGroup_ViewValues_Type
Definition idprop_py_api.cc:1637

Definition at line 35 of file idprop_py_api.hh.

◆ BPy_IDGroup_ViewValues_CheckExact

#define BPy_IDGroup_ViewValues_CheckExact ( v)
Value:
(Py_TYPE(v) == &BPy_IDGroup_ViewValues_Type)

Definition at line 36 of file idprop_py_api.hh.

Function Documentation

◆ BPy_IDGroup_MapDataToPy()

PyObject * BPy_IDGroup_MapDataToPy ( IDProperty * prop)
nodiscard

For simple, non nested types this is the same as BPy_IDGroup_WrapData.

Definition at line 1185 of file idprop_py_api.cc.

References BPy_IDGroup_MapDataToPy(), IDProperty::data, ListBase::first, IDPropertyData::group, i, IDP_ARRAY, IDP_array_bool_get, IDP_array_double_get, IDP_array_float_get, IDP_array_int_get, IDP_BOOLEAN, IDP_DOUBLE, IDP_FLOAT, IDP_GROUP, IDP_ID, IDP_IDPARRAY, IDP_INT, IDP_property_array_get, IDP_STRING, idprop_py_from_idp_bool(), idprop_py_from_idp_double(), idprop_py_from_idp_float(), idprop_py_from_idp_id(), idprop_py_from_idp_int(), idprop_py_from_idp_string(), IDProperty::len, IDProperty::name, IDProperty::next, Py_DECREF(), IDProperty::subtype, IDProperty::type, UNLIKELY, and wrap().

Referenced by BPy_IDArray_to_list(), BPy_IDGroup_MapDataToPy(), BPy_IDGroup_pop(), BPy_IDGroup_to_dict(), and pyrna_struct_pop().

◆ BPy_IDGroup_WrapData()

PyObject * BPy_IDGroup_WrapData ( ID * id,
IDProperty * prop,
IDProperty * parent )
nodiscard

Definition at line 158 of file idprop_py_api.cc.

References IDP_ARRAY, IDP_BOOLEAN, IDP_DOUBLE, IDP_FLOAT, IDP_GROUP, IDP_ID, IDP_IDPARRAY, IDP_INT, IDP_STRING, idprop_py_from_idp_array(), idprop_py_from_idp_bool(), idprop_py_from_idp_double(), idprop_py_from_idp_float(), idprop_py_from_idp_group(), idprop_py_from_idp_id(), idprop_py_from_idp_idparray(), idprop_py_from_idp_int(), idprop_py_from_idp_string(), and IDProperty::type.

Referenced by BPy_Group_IterItems_next(), BPy_Group_IterValues_next(), BPy_IDGroup_get(), BPy_IDGroup_Map_GetItem(), BPy_Wrap_GetItems(), BPy_Wrap_GetValues(), idprop_py_from_idp_idparray(), pyrna_struct_get(), and pyrna_struct_subscript().

◆ BPy_IDProperty_Map_ValidateAndCreate()

bool BPy_IDProperty_Map_ValidateAndCreate ( PyObject * key,
IDProperty * group,
PyObject * ob )
nodiscard
Note
group can be a pointer array or a group. assume we already checked key is a string.
Returns
success.

Definition at line 1059 of file idprop_py_api.cc.

References BLI_assert, ELEM, IDProperty::flag, IDP_AppendArray(), IDP_FLAG_OVERRIDABLE_LIBRARY, IDP_FLAG_STATIC_TYPE, idp_from_PyObject(), IDP_GetPropertyFromGroup(), IDP_IDPARRAY, IDP_ReplaceInGroup_ex(), idp_try_read_name(), IDP_TryConvertUIData(), IDP_type_str(), IDP_ui_data_type(), MEM_freeN(), name, IDProperty::type, and IDProperty::ui_data.

Referenced by BPy_Wrap_SetMapItem(), idp_from_PyMapping(), and idp_from_PySequence_Fast().

◆ BPy_Wrap_GetItems()

PyObject * BPy_Wrap_GetItems ( ID * id,
IDProperty * prop )
nodiscard

Definition at line 1795 of file idprop_py_api.cc.

References BPy_IDGroup_CorrectListLen(), BPy_IDGroup_WrapData(), BPy_Wrap_GetItems(), IDProperty::data, ListBase::first, IDPropertyData::group, i, IDProperty::len, IDProperty::name, IDProperty::next, Py_DECREF(), and PyTuple_SET_ITEMS.

Referenced by BPy_Wrap_GetItems().

◆ BPy_Wrap_GetItems_View_WithID()

PyObject * BPy_Wrap_GetItems_View_WithID ( ID * id,
IDProperty * prop )
nodiscard

Definition at line 1836 of file idprop_py_api.cc.

References BPy_IDGroup_ViewItems_CreatePyObject(), idprop_py_from_idp_group(), ret, and self.

Referenced by pyrna_struct_items().

◆ BPy_Wrap_GetKeys()

PyObject * BPy_Wrap_GetKeys ( IDProperty * prop)
nodiscard

Definition at line 1746 of file idprop_py_api.cc.

References BPy_IDGroup_CorrectListLen(), BPy_Wrap_GetKeys(), IDProperty::data, ListBase::first, IDPropertyData::group, i, IDProperty::len, len, IDProperty::name, IDProperty::next, and Py_DECREF().

Referenced by BPy_Wrap_GetKeys().

◆ BPy_Wrap_GetKeys_View_WithID()

PyObject * BPy_Wrap_GetKeys_View_WithID ( ID * id,
IDProperty * prop )
nodiscard

Definition at line 1820 of file idprop_py_api.cc.

References BPy_IDGroup_ViewKeys_CreatePyObject(), idprop_py_from_idp_group(), ret, and self.

Referenced by pyrna_struct_keys().

◆ BPy_Wrap_GetValues()

PyObject * BPy_Wrap_GetValues ( ID * id,
IDProperty * prop )
nodiscard

Definition at line 1773 of file idprop_py_api.cc.

References BPy_IDGroup_CorrectListLen(), BPy_IDGroup_WrapData(), BPy_Wrap_GetValues(), IDProperty::data, ListBase::first, IDPropertyData::group, i, IDProperty::len, IDProperty::next, and Py_DECREF().

Referenced by BPy_Wrap_GetValues().

◆ BPy_Wrap_GetValues_View_WithID()

PyObject * BPy_Wrap_GetValues_View_WithID ( ID * id,
IDProperty * prop )
nodiscard

Definition at line 1828 of file idprop_py_api.cc.

References BPy_IDGroup_ViewValues_CreatePyObject(), idprop_py_from_idp_group(), ret, and self.

Referenced by pyrna_struct_values().

◆ BPy_Wrap_SetMapItem()

int BPy_Wrap_SetMapItem ( IDProperty * prop,
PyObject * key,
PyObject * val )
nodiscard

Definition at line 1130 of file idprop_py_api.cc.

References BPy_IDProperty_Map_ValidateAndCreate(), IDP_FreeFromGroup(), IDP_GetPropertyFromGroup(), IDP_GROUP, name, and IDProperty::type.

Referenced by BPy_IDGroup_Map_SetItem(), and pyrna_struct_ass_subscript().

◆ BPyInit_idprop()

PyObject * BPyInit_idprop ( )
nodiscard

Definition at line 2679 of file idprop_py_api.cc.

References BPyInit_idprop_types(), IDProp_module_def, and mod.

◆ IDProp_Init_Types()

void IDProp_Init_Types ( )

Definition at line 2557 of file idprop_py_api.cc.

References BPy_IDArray_Type, BPy_IDGroup_IterItems_Type, BPy_IDGroup_IterKeys_Type, BPy_IDGroup_IterValues_Type, BPy_IDGroup_Type, BPy_IDGroup_ViewItems_Type, BPy_IDGroup_ViewKeys_Type, BPy_IDGroup_ViewValues_Type, IDGroup_Iter_init_type(), and IDGroup_View_init_type().

Referenced by BPy_init_modules(), and BPyInit_idprop_types().

Variable Documentation

◆ BPy_IDArray_Type

PyTypeObject BPy_IDArray_Type
extern

Definition at line 2498 of file idprop_py_api.cc.

Referenced by BPyInit_idprop_types(), IDProp_Init_Types(), and idprop_py_from_idp_array().

◆ BPy_IDGroup_IterItems_Type

PyTypeObject BPy_IDGroup_IterItems_Type
extern

Definition at line 1400 of file idprop_py_api.cc.

Referenced by BPy_IDGroup_IterItems_CreatePyObject(), BPyInit_idprop_types(), IDGroup_Iter_init_type(), and IDProp_Init_Types().

◆ BPy_IDGroup_IterKeys_Type

PyTypeObject BPy_IDGroup_IterKeys_Type
extern

Definition at line 1398 of file idprop_py_api.cc.

Referenced by BPy_IDGroup_IterKeys_CreatePyObject(), BPyInit_idprop_types(), IDGroup_Iter_init_type(), and IDProp_Init_Types().

◆ BPy_IDGroup_IterValues_Type

PyTypeObject BPy_IDGroup_IterValues_Type
extern

Definition at line 1399 of file idprop_py_api.cc.

Referenced by BPy_IDGroup_IterValues_CreatePyObject(), BPyInit_idprop_types(), IDGroup_Iter_init_type(), and IDProp_Init_Types().

◆ BPy_IDGroup_Type

PyTypeObject BPy_IDGroup_Type
extern

Definition at line 2038 of file idprop_py_api.cc.

Referenced by BPyInit_idprop_types(), IDProp_Init_Types(), idprop_py_from_idp_group(), and pyrna_struct_id_properties_ensure().

◆ BPy_IDGroup_ViewItems_Type

PyTypeObject BPy_IDGroup_ViewItems_Type
extern

Definition at line 1638 of file idprop_py_api.cc.

Referenced by BPy_IDGroup_ViewItems_CreatePyObject(), BPyInit_idprop_types(), IDGroup_View_init_type(), and IDProp_Init_Types().

◆ BPy_IDGroup_ViewKeys_Type

PyTypeObject BPy_IDGroup_ViewKeys_Type
extern

Definition at line 1636 of file idprop_py_api.cc.

Referenced by BPy_IDGroup_ViewKeys_CreatePyObject(), BPyInit_idprop_types(), IDGroup_View_init_type(), and IDProp_Init_Types().

◆ BPy_IDGroup_ViewValues_Type

PyTypeObject BPy_IDGroup_ViewValues_Type
extern

Definition at line 1637 of file idprop_py_api.cc.

Referenced by BPy_IDGroup_ViewValues_CreatePyObject(), BPyInit_idprop_types(), IDGroup_View_init_type(), and IDProp_Init_Types().

Generated on for Blender by  doxygen 1.16.1