Blender V5.3
py_capi_utils.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#include <string>
15#include <type_traits>
16
17#include "BLI_compiler_attrs.hh"
18#include "BLI_span.hh"
19#include "BLI_sys_types.hh"
20
21#include "DNA_vec_types.h"
22
23namespace blender {
24
26void PyC_ObSpit(const char *name, PyObject *var);
31void PyC_ObSpitStr(char *result, size_t result_maxncpy, PyObject *var);
32void PyC_LineSpit();
33void PyC_StackSpit();
34
44[[nodiscard]] PyObject *PyC_ExceptionBuffer() ATTR_RETURNS_NONNULL;
51[[nodiscard]] PyObject *PyC_ExceptionBuffer_Simple() ATTR_RETURNS_NONNULL;
52
56[[nodiscard]] std::optional<int> PyC_ExceptionSystemExitCode();
57
65
66[[nodiscard]] PyObject *PyC_FrozenSetFromStrings(const char **strings);
67
75PyObject *PyC_Err_Format_Prefix(PyObject *exception_type_prefix, const char *format, ...);
76PyObject *PyC_Err_SetString_Prefix(PyObject *exception_type_prefix, const char *str);
77
82void PyC_Err_PrintWithFunc(PyObject *py_func);
83
84void PyC_FileAndNum(const char **r_filename, int *r_lineno);
89void PyC_FileAndNum_Safe(const char **r_filename, int *r_lineno);
90[[nodiscard]] int PyC_AsArray_FAST(void *array,
91 size_t array_item_size,
92 PyObject *value_fast,
93 Py_ssize_t length,
94 const PyTypeObject *type,
95 const char *error_prefix);
96[[nodiscard]] int PyC_AsArray(void *array,
97 size_t array_item_size,
98 PyObject *value,
99 Py_ssize_t length,
100 const PyTypeObject *type,
101 const char *error_prefix);
102
103[[nodiscard]] int PyC_AsArray_Multi_FAST(void *array,
104 size_t array_item_size,
105 PyObject *value_fast,
106 const int *dims,
107 int dims_len,
108 const PyTypeObject *type,
109 const char *error_prefix);
110
111[[nodiscard]] int PyC_AsArray_Multi(void *array,
112 size_t array_item_size,
113 PyObject *value,
114 const int *dims,
115 int dims_len,
116 const PyTypeObject *type,
117 const char *error_prefix);
118
119[[nodiscard]] PyObject *PyC_Tuple_PackArray_F32(const float *array, uint len);
120[[nodiscard]] PyObject *PyC_Tuple_PackArray_F64(const double *array, uint len);
121[[nodiscard]] PyObject *PyC_Tuple_PackArray_I32(const int *array, uint len);
122[[nodiscard]] PyObject *PyC_Tuple_PackArray_I32FromBool(const int *array, uint len);
123[[nodiscard]] PyObject *PyC_Tuple_PackArray_Bool(const bool *array, uint len);
124
128[[nodiscard]] PyObject *PyC_Tuple_PackArray_String(const char **array, uint len);
129
130[[nodiscard]] PyObject *PyC_Tuple_PackArray_Multi_F32(const float *array,
131 const int dims[],
132 int dims_len);
133[[nodiscard]] PyObject *PyC_Tuple_PackArray_Multi_F64(const double *array,
134 const int dims[],
135 int dims_len);
136[[nodiscard]] PyObject *PyC_Tuple_PackArray_Multi_I32(const int *array,
137 const int dims[],
138 int dims_len);
139[[nodiscard]] PyObject *PyC_Tuple_PackArray_Multi_Bool(const bool *array,
140 const int dims[],
141 int dims_len);
142
147void PyC_Tuple_Fill(PyObject *tuple, PyObject *value);
148void PyC_List_Fill(PyObject *list, PyObject *value);
149
155[[nodiscard]] PyObject *PyC_UnicodeFromBytes(const char *str);
159[[nodiscard]] PyObject *PyC_UnicodeFromBytesAndSize(const char *str, Py_ssize_t size);
160[[nodiscard]] const char *PyC_UnicodeAsBytes(PyObject *py_str,
161 PyObject **r_coerce); /* coerce must be NULL */
169[[nodiscard]] const char *PyC_UnicodeAsBytesAndSize(PyObject *py_str,
170 Py_ssize_t *r_size,
171 PyObject **r_coerce);
172
180 PyObject *value_coerce;
181 const char *value;
182 Py_ssize_t value_len;
183};
184
195int PyC_ParseUnicodeAsBytesAndSize(PyObject *o, void *p);
197int PyC_ParseUnicodeAsBytesAndSize_OrNone(PyObject *o, void *p);
198
211[[nodiscard]] PyObject *PyC_DefaultNameSpace(const char *filename) ATTR_NONNULL(1);
212void PyC_RunQuicky(const char *filepath, int n, ...) ATTR_NONNULL(1);
221[[nodiscard]] bool PyC_NameSpace_ImportArray(PyObject *py_dict, const char *imports[]);
222
226[[nodiscard]] PyObject *PyC_MainModule_Backup();
227void PyC_MainModule_Restore(PyObject *main_mod);
228
238int PyC_Module_AddToSysModules(PyObject *sys_modules, PyObject *module);
239
240[[nodiscard]] bool PyC_IsInterpreterActive();
241
245[[nodiscard]] void *PyC_RNA_AsPointer(PyObject *value, const char *type_name);
246
247/* flag / set --- interchange */
249 int value;
250 const char *identifier;
251};
252
253[[nodiscard]] PyObject *PyC_FlagSet_AsString(const PyC_FlagSet *item);
254[[nodiscard]] int PyC_FlagSet_ValueFromID_int(const PyC_FlagSet *item,
255 const char *identifier,
256 int *r_value);
257[[nodiscard]] int PyC_FlagSet_ValueFromID(const PyC_FlagSet *item,
258 const char *identifier,
259 int *r_value,
260 const char *error_prefix);
261[[nodiscard]] int PyC_FlagSet_ToBitfield(const PyC_FlagSet *items,
262 PyObject *value,
263 int *r_value,
264 const char *error_prefix);
265[[nodiscard]] PyObject *PyC_FlagSet_FromBitfield(PyC_FlagSet *items, int flag);
266
272[[nodiscard]] bool PyC_RunString_AsNumber(const char **imports,
273 const char *expr,
274 const char *filename,
275 double *r_value) ATTR_NONNULL(2, 3, 4);
276[[nodiscard]] bool PyC_RunString_AsIntPtr(const char **imports,
277 const char *expr,
278 const char *filename,
279 intptr_t *r_value) ATTR_NONNULL(2, 3, 4);
283[[nodiscard]] bool PyC_RunString_AsStringAndSize(const char **imports,
284 const char *expr,
285 const char *filename,
286 char **r_value,
287 size_t *r_value_size) ATTR_NONNULL(2, 3, 4, 5);
288[[nodiscard]] bool PyC_RunString_AsString(const char **imports,
289 const char *expr,
290 const char *filename,
291 char **r_value) ATTR_NONNULL(2, 3, 4);
292
296[[nodiscard]] bool PyC_RunString_AsStringAndSizeOrNone(const char **imports,
297 const char *expr,
298 const char *filename,
299 char **r_value,
300 size_t *r_value_size) ATTR_NONNULL(2, 3, 4);
301[[nodiscard]] bool PyC_RunString_AsStringOrNone(const char **imports,
302 const char *expr,
303 const char *filename,
304 char **r_value) ATTR_NONNULL(2, 3, 4);
305
309void PyC_StdFilesFlush();
310
316[[nodiscard]] int PyC_ParseBool(PyObject *o, void *p);
317
324 PyTypeObject *type;
325 PyObject **value_p;
326};
327[[nodiscard]] int PyC_ParseTypeOrNone(PyObject *o, void *p);
328
334[[nodiscard]] int PyC_ParseOptionalInt(PyObject *o, void *p);
335
341[[nodiscard]] int PyC_ParseOptionalDouble(PyObject *o, void *p);
342
348[[nodiscard]] int PyC_ParseOptionalFloat(PyObject *o, void *p);
349
355[[nodiscard]] int PyC_ParseOptionalUInt(PyObject *o, void *p);
356
363[[nodiscard]] int PyC_ParseOptionalBool(PyObject *o, void *p);
364
370[[nodiscard]] int PyC_ParseRectI(PyObject *o, void *p);
375[[nodiscard]] int PyC_ParseOptionalRectI(PyObject *o, void *p);
376
385template<typename T> inline PyObject *PyC_Object_CAST(T *value)
386{
387 static_assert(std::is_same_v<decltype(T::ob_base), PyObject> ||
388 std::is_same_v<decltype(T::ob_base), PyVarObject>,
389 "Type must use PyObject_HEAD or PyObject_VAR_HEAD");
390 return reinterpret_cast<PyObject *>(value);
391}
392
394template<typename T> inline PyObject **PyC_Object_ptr_CAST(T **value_p)
395{
396 static_assert(std::is_same_v<decltype(T::ob_base), PyObject> ||
397 std::is_same_v<decltype(T::ob_base), PyVarObject>,
398 "Type must use PyObject_HEAD or PyObject_VAR_HEAD");
399 return reinterpret_cast<PyObject **>(value_p);
400}
401
403#define PyC_TYPE_OR_NONE_INIT(py_type, value_p) {(py_type), PyC_Object_ptr_CAST(value_p)}
404
406 int value;
407 const char *id;
408};
413
417[[nodiscard]] int PyC_ParseStringEnum(PyObject *o, void *p);
418[[nodiscard]] const char *PyC_StringEnum_FindIDFromValue(const struct PyC_StringEnumItems *items,
419 int value);
420
424[[nodiscard]] int PyC_CheckArgs_DeepCopy(PyObject *args);
425
426/* Integer parsing (with overflow checks), -1 on error. */
427
453[[nodiscard]] int PyC_Long_AsBool(PyObject *value);
454[[nodiscard]] int8_t PyC_Long_AsI8(PyObject *value);
455[[nodiscard]] int16_t PyC_Long_AsI16(PyObject *value);
456#if 0 /* inline */
457[[nodiscard]] int32_t PyC_Long_AsI32(PyObject *value);
458[[nodiscard]] int64_t PyC_Long_AsI64(PyObject *value);
459#endif
460
467[[nodiscard]] uint8_t PyC_Long_AsU8(PyObject *value);
468[[nodiscard]] uint16_t PyC_Long_AsU16(PyObject *value);
469[[nodiscard]] uint32_t PyC_Long_AsU32(PyObject *value);
476[[nodiscard]] uint64_t PyC_Long_AsU64(PyObject *value);
477
479[[nodiscard]] Py_LOCAL_INLINE(int32_t) PyC_Long_AsI32(PyObject *value)
480{
481 return int32_t(PyLong_AsInt(value));
482}
483[[nodiscard]] Py_LOCAL_INLINE(int64_t) PyC_Long_AsI64(PyObject *value)
484{
485 return int64_t(PyLong_AsLongLong(value));
486}
487
488/* Utils for format string in `struct` module style syntax. */
489
490[[nodiscard]] char PyC_StructFmt_type_from_str(const char *typestr);
491[[nodiscard]] bool PyC_StructFmt_type_is_float_any(char format);
492[[nodiscard]] bool PyC_StructFmt_type_is_int_any(char format);
493[[nodiscard]] bool PyC_StructFmt_type_is_byte(char format);
494[[nodiscard]] bool PyC_StructFmt_type_is_bool(char format);
495
499[[nodiscard]] PyObject *PyC_UnicodeFromStdStr(const std::string &str);
500
501[[nodiscard]] inline PyObject *PyC_Tuple_Pack_F32(const Span<float> values)
502{
503 return PyC_Tuple_PackArray_F32(values.data(), values.size());
504}
505[[nodiscard]] inline PyObject *PyC_Tuple_Pack_F64(const Span<double> values)
506{
507 return PyC_Tuple_PackArray_F64(values.data(), values.size());
508}
509[[nodiscard]] inline PyObject *PyC_Tuple_Pack_I32(const Span<int> values)
510{
511 return PyC_Tuple_PackArray_I32(values.data(), values.size());
512}
513[[nodiscard]] inline PyObject *PyC_Tuple_Pack_I32FromBool(const Span<int> values)
514{
515 return PyC_Tuple_PackArray_I32FromBool(values.data(), values.size());
516}
517[[nodiscard]] inline PyObject *PyC_Tuple_Pack_Bool(const Span<bool> values)
518{
519 return PyC_Tuple_PackArray_Bool(values.data(), values.size());
520}
521
528[[nodiscard]] bool PyC_Dict_CheckKeysAreStrings(PyObject *dict);
529
542[[nodiscard]] PyObject *PyC_MemoryView_FromBufferOwned(const Py_buffer *info);
543
544} // namespace blender
SIMD_FORCE_INLINE btScalar length() const
Return the length of the vector.
Definition btVector3.h:257
constexpr const T * data() const
Definition BLI_span.hh:219
constexpr int64_t size() const
Definition BLI_span.hh:256
#define str(s)
ccl_device_inline dual1 len(const ccl_private dual< T > &a)
Definition math_dual.h:263
#define T
std::string filename(const std::string_view &str, size_t pos)
BMesh Iterators.
Object ATTR_RETURNS_NONNULL
PyObject * PyC_MainModule_Backup()
PyObject * PyC_Tuple_PackArray_String(const char **array, uint len)
int PyC_FlagSet_ToBitfield(const PyC_FlagSet *items, PyObject *value, int *r_value, const char *error_prefix)
int PyC_AsArray_FAST(void *array, const size_t array_item_size, PyObject *value_fast, const Py_ssize_t length, const PyTypeObject *type, const char *error_prefix)
unsigned __int64 uint64_t
Definition BKE_text.h:91
bool PyC_IsInterpreterActive()
int PyC_ParseOptionalDouble(PyObject *o, void *p)
__int64 int64_t
Definition BKE_text.h:90
bool PyC_RunString_AsNumber(const char *imports[], const char *expr, const char *filename, double *r_value)
PyObject * PyC_FrozenSetFromStrings(const char **strings)
PyObject * PyC_Err_SetString_Prefix(PyObject *exception_type_prefix, const char *str)
int PyC_ParseOptionalUInt(PyObject *o, void *p)
int PyC_ParseBool(PyObject *o, void *p)
unsigned int uint
Definition BKE_text.h:55
PyObject * PyC_MemoryView_FromBufferOwned(const Py_buffer *info)
int PyC_CheckArgs_DeepCopy(PyObject *args)
PyObject * PyC_Tuple_Pack_F32(const Span< float > values)
char PyC_StructFmt_type_from_str(const char *typestr)
PyObject * PyC_Tuple_PackArray_Multi_F64(const double *array, const int dims[], const int dims_len)
int PyC_AsArray(void *array, const size_t array_item_size, PyObject *value, const Py_ssize_t length, const PyTypeObject *type, const char *error_prefix)
PyObject * PyC_FlagSet_FromBitfield(PyC_FlagSet *items, int flag)
int PyC_FlagSet_ValueFromID(const PyC_FlagSet *item, const char *identifier, int *r_value, const char *error_prefix)
int PyC_ParseRectI(PyObject *o, void *p)
PyObject * PyC_Object_CAST(T *value)
void PyC_FileAndNum_Safe(const char **r_filename, int *r_lineno)
PyObject * PyC_UnicodeFromBytes(const char *str)
PyObject * PyC_Tuple_Pack_F64(const Span< double > values)
void PyC_LineSpit()
int PyC_FlagSet_ValueFromID_int(const PyC_FlagSet *item, const char *identifier, int *r_value)
PyObject * PyC_Tuple_Pack_Bool(const Span< bool > values)
unsigned short uint16_t
Definition BKE_text.h:80
PyObject * PyC_Tuple_Pack_I32(const Span< int > values)
PyObject * PyC_Tuple_PackArray_Multi_Bool(const bool *array, const int dims[], const int dims_len)
unsigned int uint32_t
Definition BKE_text.h:81
bool PyC_Dict_CheckKeysAreStrings(PyObject *dict)
PyObject * PyC_DefaultNameSpace(const char *filename)
PyObject * PyC_Tuple_PackArray_I32FromBool(const int *array, uint len)
bool PyC_RunString_AsStringAndSizeOrNone(const char *imports[], const char *expr, const char *filename, char **r_value, size_t *r_value_size)
PyObject ** PyC_Object_ptr_CAST(T **value_p)
void PyC_ObSpit(const char *name, PyObject *var)
unsigned char uint8_t
Definition BKE_text.h:79
int16_t PyC_Long_AsI16(PyObject *value)
std::optional< int > PyC_ExceptionSystemExitCode()
PyObject * PyC_Tuple_PackArray_Multi_F32(const float *array, const int dims[], const int dims_len)
int PyC_ParseOptionalInt(PyObject *o, void *p)
PyObject * PyC_ExceptionBuffer_Simple()
int PyC_ParseUnicodeAsBytesAndSize(PyObject *o, void *p)
void PyC_List_Fill(PyObject *list, PyObject *value)
PyObject * PyC_Tuple_PackArray_I32(const int *array, uint len)
uint64_t PyC_Long_AsU64(PyObject *value)
PyObject * PyC_FlagSet_AsString(const PyC_FlagSet *item)
void PyC_RunQuicky(const char *filepath, int n,...)
const char * PyC_StringEnum_FindIDFromValue(const PyC_StringEnumItems *items, const int value)
bool PyC_RunString_AsStringAndSize(const char *imports[], const char *expr, const char *filename, char **r_value, size_t *r_value_size)
uint8_t PyC_Long_AsU8(PyObject *value)
bool PyC_RunString_AsIntPtr(const char *imports[], const char *expr, const char *filename, intptr_t *r_value)
PyObject * PyC_Err_Format_Prefix(PyObject *exception_type_prefix, const char *format,...)
const char * PyC_UnicodeAsBytes(PyObject *py_str, PyObject **r_coerce)
void PyC_Err_PrintWithFunc(PyObject *py_func)
bool PyC_RunString_AsStringOrNone(const char *imports[], const char *expr, const char *filename, char **r_value)
int PyC_Long_AsBool(PyObject *value)
int PyC_AsArray_Multi_FAST(void *array, const size_t array_item_size, PyObject *value_fast, const int *dims, const int dims_len, const PyTypeObject *type, const char *error_prefix)
uint32_t PyC_Long_AsU32(PyObject *value)
void * PyC_RNA_AsPointer(PyObject *value, const char *type_name)
PyObject * PyC_Tuple_Pack_I32FromBool(const Span< int > values)
void PyC_Tuple_Fill(PyObject *tuple, PyObject *value)
PyObject * PyC_Tuple_PackArray_Multi_I32(const int *array, const int dims[], const int dims_len)
uint16_t PyC_Long_AsU16(PyObject *value)
bool PyC_StructFmt_type_is_bool(char format)
void PyC_StdFilesFlush()
bool PyC_StructFmt_type_is_float_any(char format)
PyObject * PyC_Tuple_PackArray_F64(const double *array, uint len)
void PyC_FileAndNum(const char **r_filename, int *r_lineno)
PyObject * PyC_Tuple_PackArray_F32(const float *array, uint len)
int PyC_ParseOptionalRectI(PyObject *o, void *p)
int PyC_Module_AddToSysModules(PyObject *sys_modules, PyObject *module)
void PyC_MainModule_Restore(PyObject *main_mod)
signed int int32_t
Definition BKE_text.h:78
void PyC_StackSpit()
PyObject * PyC_UnicodeFromStdStr(const std::string &str)
PyObject * PyC_ExceptionBuffer()
bool PyC_RunString_AsString(const char *imports[], const char *expr, const char *filename, char **r_value)
Py_LOCAL_INLINE(int32_t) PyC_Long_AsI32(PyObject *value)
int PyC_ParseStringEnum(PyObject *o, void *p)
void ATTR_NONNULL(1, 2)
bool PyC_NameSpace_ImportArray(PyObject *py_dict, const char *imports[])
PyObject * PyC_UnicodeFromBytesAndSize(const char *str, Py_ssize_t size)
bool PyC_StructFmt_type_is_int_any(char format)
void PyC_ObSpitStr(char *result, size_t result_maxncpy, PyObject *var)
bool PyC_Err_CaptureSystemExitCode()
int8_t PyC_Long_AsI8(PyObject *value)
int PyC_ParseUnicodeAsBytesAndSize_OrNone(PyObject *o, void *p)
int PyC_ParseTypeOrNone(PyObject *o, void *p)
PyObject * PyC_Tuple_PackArray_Bool(const bool *array, uint len)
int PyC_AsArray_Multi(void *array, const size_t array_item_size, PyObject *value, const int *dims, const int dims_len, const PyTypeObject *type, const char *error_prefix)
int PyC_ParseOptionalBool(PyObject *o, void *p)
int PyC_ParseOptionalFloat(PyObject *o, void *p)
signed char int8_t
Definition BKE_text.h:76
bool PyC_StructFmt_type_is_byte(char format)
signed short int16_t
Definition BKE_text.h:77
_W64 int intptr_t
Definition BKE_text.h:119
const char * PyC_UnicodeAsBytesAndSize(PyObject *py_str, Py_ssize_t *r_size, PyObject **r_coerce)
const struct PyC_StringEnumItems * items