Blender V5.3
bpy_rna.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2023 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#pragma once
10
11#include <Python.h>
12
13#include <optional>
14
15/* --- bpy build options --- */
17
18namespace blender {
19
20#ifdef WITH_PYTHON_SAFETY
21
26# define USE_WEAKREFS
27
28/* method to invalidate removed py data, XXX, slow to remove objects, otherwise no overhead */
29// #define USE_PYRNA_INVALIDATE_GC
30
31/* different method */
32# define USE_PYRNA_INVALIDATE_WEAKREF
33
34/* support for inter references, currently only needed for corner case */
35# define USE_PYRNA_STRUCT_REFERENCE
36
37#else /* WITH_PYTHON_SAFETY */
38
39/* default, no defines! */
40
41#endif /* !WITH_PYTHON_SAFETY */
42
43/* Sanity checks on above defines. */
44#if defined(USE_PYRNA_INVALIDATE_WEAKREF) && !defined(USE_WEAKREFS)
45# define USE_WEAKREFS
46#endif
47
48#if defined(USE_PYRNA_INVALIDATE_GC) && defined(USE_PYRNA_INVALIDATE_WEAKREF)
49# error "Only 1 reference check method at a time!"
50#endif
51
52/* only used by operator introspection get_rna(), this is only used for doc gen
53 * so prefer the leak to the memory bloat for now. */
54// #define PYRNA_FREE_SUPPORT
55
56/* use real collection iterators rather than faking with a list
57 * this is needed so enums can be iterated over without crashing,
58 * since finishing the iteration frees temp allocated enums */
59#define USE_PYRNA_ITER
60
61/* --- end bpy build options --- */
62
63struct ID;
64
69extern PyTypeObject pyrna_struct_meta_idprop_Type;
70extern PyTypeObject pyrna_struct_Type;
71extern PyTypeObject pyrna_prop_Type;
72extern PyTypeObject pyrna_prop_array_Type;
73extern PyTypeObject pyrna_prop_collection_Type;
74extern PyTypeObject pyrna_func_Type;
75
76#define BPy_StructRNA_Check(v) (PyObject_TypeCheck(v, &pyrna_struct_Type))
77#define BPy_StructRNA_CheckExact(v) (Py_TYPE(v) == &pyrna_struct_Type)
78#define BPy_PropertyRNA_Check(v) (PyObject_TypeCheck(v, &pyrna_prop_Type))
79#define BPy_PropertyRNA_CheckExact(v) (Py_TYPE(v) == &pyrna_prop_Type)
80
81#define PYRNA_STRUCT_CHECK_OBJ(obj) \
82 if (pyrna_struct_validity_check(obj) == -1) [[unlikely]] { \
83 return NULL; \
84 } \
85 (void)0
86#define PYRNA_STRUCT_CHECK_INT(obj) \
87 if (pyrna_struct_validity_check(obj) == -1) [[unlikely]] { \
88 return -1; \
89 } \
90 (void)0
91
92#define PYRNA_PROP_CHECK_OBJ(obj) \
93 if (pyrna_prop_validity_check(obj) == -1) [[unlikely]] { \
94 return NULL; \
95 } \
96 (void)0
97#define PYRNA_PROP_CHECK_INT(obj) \
98 if (pyrna_prop_validity_check(obj) == -1) [[unlikely]] { \
99 return -1; \
100 } \
101 (void)0
102
103#define PYRNA_STRUCT_CHECK_OBJ_UNLESS(obj, unless) \
104 { \
105 const BPy_StructRNA *_obj = obj; \
106 if (UNLIKELY(pyrna_struct_validity_check_only(_obj) == -1) && !(unless)) { \
107 pyrna_struct_validity_exception_only(_obj); \
108 return NULL; \
109 } \
110 } \
111 (void)0
112
113#define PYRNA_STRUCT_IS_VALID(pysrna) (LIKELY(((BPy_StructRNA *)(pysrna))->ptr->has_type()))
114#define PYRNA_PROP_IS_VALID(pysrna) (LIKELY(((BPy_PropertyRNA *)(pysrna))->ptr->has_type()))
115
116/* 'in_weakreflist' MUST be aligned */
117
119 PyObject_HEAD /* Required Python macro. */
120#ifdef USE_WEAKREFS
121 PyObject *in_weakreflist;
122#endif
123
124 std::optional<PointerRNA> ptr;
125};
126
128 PyObject_HEAD /* Required Python macro. */
129#ifdef USE_WEAKREFS
130 PyObject *in_weakreflist;
131#endif
132
133 std::optional<PointerRNA> ptr;
134
135#ifdef USE_PYRNA_STRUCT_REFERENCE
136 /* generic PyObject we hold a reference to, example use:
137 * hold onto the collection iterator to prevent it from freeing allocated data we may use */
138 PyObject *reference;
139#endif /* !USE_PYRNA_STRUCT_REFERENCE */
140
141#ifdef PYRNA_FREE_SUPPORT
143 bool freeptr;
144#endif /* PYRNA_FREE_SUPPORT */
145};
146
148 PyObject_HEAD /* Required Python macro. */
149#ifdef USE_WEAKREFS
150 PyObject *in_weakreflist;
151#endif
152
153 std::optional<PointerRNA> ptr;
155};
156
158 PyObject_HEAD /* Required Python macro. */
159
160 /* START Must match #BPy_PropertyRNA. */
161
162#ifdef USE_WEAKREFS
163 PyObject *in_weakreflist;
164#endif
165
166 std::optional<PointerRNA> ptr;
168
169 /* END Must match #BPy_PropertyRNA. */
170
171 /* Arystan: this is a hack to allow sub-item r/w access like: face.uv[n][m] */
176};
177
179 PyObject_HEAD /* Required Python macro. */
180#ifdef USE_WEAKREFS
181 PyObject *in_weakreflist;
182#endif
183
184 /* collection iterator specific parts */
185 std::optional<CollectionPropertyIterator> iter;
186};
187
189 PyObject_HEAD /* Required Python macro. */
190#ifdef USE_WEAKREFS
191 PyObject *in_weakreflist;
192#endif
193
194 std::optional<PointerRNA> ptr;
200 vectorcallfunc vectorcall;
201};
202
203[[nodiscard]] StructRNA *srna_from_self(PyObject *self, const char *error_prefix);
204[[nodiscard]] StructRNA *pyrna_struct_as_srna(PyObject *self,
205 bool parent,
206 const char *error_prefix);
207
208void BPY_rna_init();
209void BPY_rna_exit();
210[[nodiscard]] PyObject *BPY_rna_module();
212// PyObject *BPY_rna_doc();
213[[nodiscard]] PyObject *BPY_rna_types();
217void BPY_rna_types_dict_set(PyObject *dict);
218void BPY_rna_types_finalize_external_types(PyObject *submodule);
219
221[[nodiscard]] PyObject *pyrna_struct_CreatePyObject(PointerRNA *ptr);
222[[nodiscard]] PyObject *pyrna_prop_CreatePyObject(PointerRNA *ptr, PropertyRNA *prop);
223
224/* Made public for other modules which don't deal closely with RNA. */
225[[nodiscard]] PyObject *pyrna_id_CreatePyObject(ID *id);
226[[nodiscard]] bool pyrna_id_FromPyObject(PyObject *obj, ID **id);
227[[nodiscard]] bool pyrna_id_CheckPyObject(PyObject *obj);
228
229/* operators also need this to set args */
230[[nodiscard]] int pyrna_pydict_to_props(PointerRNA *ptr,
231 PyObject *kw,
232 bool all_args,
233 const char *error_prefix);
234[[nodiscard]] PyObject *pyrna_prop_to_py(PointerRNA *ptr, PropertyRNA *prop);
235
236[[nodiscard]] int pyrna_deferred_register_class(StructRNA *srna, PyTypeObject *py_class);
237
238const PointerRNA *pyrna_struct_as_ptr(PyObject *py_obj, const StructRNA *srna);
239const PointerRNA *pyrna_struct_as_ptr_or_null(PyObject *py_obj, const StructRNA *srna);
240
252
259[[nodiscard]] int pyrna_struct_as_ptr_parse(PyObject *o, void *p);
263[[nodiscard]] int pyrna_struct_as_ptr_or_null_parse(PyObject *o, void *p);
264
265void pyrna_struct_type_extend_capi(StructRNA *srna, PyMethodDef *method, PyGetSetDef *getset);
266
267void pyrna_alloc_types();
268
269/* Primitive type conversion. */
270
271[[nodiscard]] int pyrna_py_to_array(
272 PointerRNA *ptr, PropertyRNA *prop, char *param_data, PyObject *py, const char *error_prefix);
273[[nodiscard]] int pyrna_py_to_array_index(PointerRNA *ptr,
274 PropertyRNA *prop,
275 int arraydim,
276 int arrayoffset,
277 int index,
278 PyObject *py,
279 const char *error_prefix);
280[[nodiscard]] PyObject *pyrna_array_index(PointerRNA *ptr, PropertyRNA *prop, int index);
281
282[[nodiscard]] PyObject *pyrna_py_from_array(PointerRNA *ptr, PropertyRNA *prop);
283[[nodiscard]] PyObject *pyrna_py_from_array_index(BPy_PropertyArrayRNA *self,
284 PointerRNA *ptr,
285 PropertyRNA *prop,
286 int index);
287[[nodiscard]] PyObject *pyrna_math_object_from_array(PointerRNA *ptr, PropertyRNA *prop);
288[[nodiscard]] int pyrna_array_contains_py(PointerRNA *ptr, PropertyRNA *prop, PyObject *value);
289
290[[nodiscard]] bool pyrna_write_check();
291void pyrna_write_set(bool val);
294
296
297[[nodiscard]] int pyrna_struct_validity_check_only(const BPy_StructRNA *pysrna);
299[[nodiscard]] int pyrna_struct_validity_check(const BPy_StructRNA *pysrna);
300
301[[nodiscard]] int pyrna_prop_validity_check(const BPy_PropertyRNA *self);
302
303/* bpy.utils.(un)register_class */
304extern PyMethodDef meth_bpy_register_class;
305extern PyMethodDef meth_bpy_unregister_class;
306
307/* bpy.utils._bl_owner_(get/set) */
308extern PyMethodDef meth_bpy_owner_id_set;
309extern PyMethodDef meth_bpy_owner_id_get;
310
312
313} // namespace blender
#define C
Definition RandGen.cpp:29
BMesh Iterators.
PyTypeObject pyrna_func_Type
Definition bpy_rna.cc:8428
bool pyrna_id_CheckPyObject(PyObject *obj)
Definition bpy_rna.cc:8999
PyObject * BPY_rna_module()
Definition bpy_rna.cc:9081
int pyrna_prop_validity_check(const BPy_PropertyRNA *self)
Definition bpy_rna.cc:199
PyObject * pyrna_id_CreatePyObject(ID *id)
Definition bpy_rna.cc:8978
BPy_StructRNA * bpy_context_module
Definition bpy_rna.cc:100
void pyrna_context_clear(bContext *C)
Definition bpy_rna.cc:534
PyMethodDef meth_bpy_owner_id_set
Definition bpy_rna.cc:11036
void BPY_rna_exit()
Definition bpy_rna.cc:9058
void pyrna_context_init(bContext *C)
Definition bpy_rna.cc:529
int pyrna_struct_validity_check(const BPy_StructRNA *pysrna)
Definition bpy_rna.cc:190
int pyrna_pydict_to_props(PointerRNA *ptr, PyObject *kw, const bool all_args, const char *error_prefix)
Definition bpy_rna.cc:1618
PyTypeObject pyrna_prop_Type
Definition bpy_rna.cc:7785
void BPY_rna_types_dict_set(PyObject *dict)
Definition bpy_rna.cc:8615
PyObject * pyrna_struct_CreatePyObject(PointerRNA *ptr)
Definition bpy_rna.cc:8874
PyTypeObject pyrna_struct_meta_idprop_Type
Definition bpy_rna.cc:7454
PyMethodDef meth_bpy_unregister_class
Definition bpy_rna.cc:10808
PyObject * pyrna_prop_to_py(PointerRNA *ptr, PropertyRNA *prop)
Definition bpy_rna.cc:1533
int pyrna_struct_as_ptr_or_null_parse(PyObject *o, void *p)
Definition bpy_rna.cc:9425
void BPY_rna_types_finalize_external_types(PyObject *submodule)
Definition bpy_rna.cc:9277
PyObject * pyrna_py_from_array_index(BPy_PropertyArrayRNA *self, PointerRNA *ptr, PropertyRNA *prop, int index)
PyObject * pyrna_prop_CreatePyObject(PointerRNA *ptr, PropertyRNA *prop)
Definition bpy_rna.cc:8931
int pyrna_struct_as_ptr_parse(PyObject *o, void *p)
Definition bpy_rna.cc:9414
PyMethodDef meth_bpy_register_class
Definition bpy_rna.cc:10547
int pyrna_py_to_array_index(PointerRNA *ptr, PropertyRNA *prop, int arraydim, int arrayoffset, int index, PyObject *py, const char *error_prefix)
void pyrna_struct_type_extend_capi(StructRNA *srna, PyMethodDef *method, PyGetSetDef *getset)
Definition bpy_rna.cc:10943
PyObject * pyrna_array_index(PointerRNA *ptr, PropertyRNA *prop, int index)
bool pyrna_id_FromPyObject(PyObject *obj, ID **id)
Definition bpy_rna.cc:8988
PyObject * pyrna_math_object_from_array(PointerRNA *ptr, PropertyRNA *prop)
Definition bpy_rna.cc:827
PyTypeObject pyrna_prop_collection_Type
Definition bpy_rna.cc:7897
PyObject * BPY_rna_types()
Definition bpy_rna.cc:9246
PyObject * pyrna_py_from_array(PointerRNA *ptr, PropertyRNA *prop)
void pyrna_struct_validity_exception_only(const BPy_StructRNA *pysrna)
Definition bpy_rna.cc:184
int pyrna_deferred_register_class(StructRNA *srna, PyTypeObject *py_class)
Definition bpy_rna.cc:9663
const PointerRNA * pyrna_struct_as_ptr(PyObject *py_obj, const StructRNA *srna)
Definition bpy_rna.cc:9391
void pyrna_write_set(bool val)
Definition bpy_rna.cc:522
StructRNA * pyrna_struct_as_srna(PyObject *self, const bool parent, const char *error_prefix)
Definition bpy_rna.cc:9338
void pyrna_invalidate(BPy_DummyPointerRNA *self)
Definition bpy_rna.cc:211
PyObject * pyrna_struct_CreatePyObject_with_primitive_support(PointerRNA *ptr)
Definition bpy_rna.cc:8910
StructRNA * srna_from_self(PyObject *self, const char *error_prefix)
Definition bpy_rna.cc:9438
void pyrna_alloc_types()
Definition bpy_rna.cc:10448
const PointerRNA * pyrna_struct_as_ptr_or_null(PyObject *py_obj, const StructRNA *srna)
Definition bpy_rna.cc:9405
bool pyrna_write_check()
Definition bpy_rna.cc:515
PyTypeObject pyrna_struct_Type
Definition bpy_rna.cc:7546
PyTypeObject pyrna_prop_array_Type
Definition bpy_rna.cc:7841
int pyrna_py_to_array(PointerRNA *ptr, PropertyRNA *prop, char *param_data, PyObject *py, const char *error_prefix)
void BPY_rna_init()
Definition bpy_rna.cc:9005
PyMethodDef meth_bpy_owner_id_get
Definition bpy_rna.cc:11030
int pyrna_struct_validity_check_only(const BPy_StructRNA *pysrna)
Definition bpy_rna.cc:176
int pyrna_array_contains_py(PointerRNA *ptr, PropertyRNA *prop, PyObject *value)
void BPY_update_rna_module()
Definition bpy_rna.cc:9093
PyObject_HEAD std::optional< PointerRNA > ptr
Definition bpy_rna.hh:124
vectorcallfunc vectorcall
Definition bpy_rna.hh:200
PyObject_HEAD std::optional< PointerRNA > ptr
Definition bpy_rna.hh:194
PyObject_HEAD std::optional< PointerRNA > ptr
Definition bpy_rna.hh:166
PyObject_HEAD std::optional< CollectionPropertyIterator > iter
Definition bpy_rna.hh:185
PyObject_HEAD std::optional< PointerRNA > ptr
Definition bpy_rna.hh:153
const PointerRNA * ptr
Definition bpy_rna.hh:250
PyObject_HEAD std::optional< PointerRNA > ptr
Definition bpy_rna.hh:133