py_capi_utils.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2023 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include <Python.h>
 
#include <string>
 
#include "BLI_compiler_attrs.h"
#include "BLI_span.hh"
#include "BLI_sys_types.h"

void PyC_ObSpit(const char *name, PyObject *var);
void PyC_ObSpitStr(char *result, size_t result_maxncpy, PyObject *var);
void PyC_LineSpit();
void PyC_StackSpit();

[[nodiscard]] PyObject *PyC_ExceptionBuffer() ATTR_RETURNS_NONNULL;
[[nodiscard]] PyObject *PyC_ExceptionBuffer_Simple() ATTR_RETURNS_NONNULL;
 
[[nodiscard]] PyObject *PyC_Object_GetAttrStringArgs(PyObject *o, Py_ssize_t n, ...);
[[nodiscard]] PyObject *PyC_FrozenSetFromStrings(const char **strings);

PyObject *PyC_Err_Format_Prefix(PyObject *exception_type_prefix, const char *format, ...);
PyObject *PyC_Err_SetString_Prefix(PyObject *exception_type_prefix, const char *str);

void PyC_Err_PrintWithFunc(PyObject *py_func);
 
void PyC_FileAndNum(const char **r_filename, int *r_lineno);
void PyC_FileAndNum_Safe(const char **r_filename, int *r_lineno); /* checks python is running */
[[nodiscard]] int PyC_AsArray_FAST(void *array,
                                   size_t array_item_size,
                                   PyObject *value_fast,
                                   Py_ssize_t length,
                                   const PyTypeObject *type,
                                   const char *error_prefix);
[[nodiscard]] int PyC_AsArray(void *array,
                              size_t array_item_size,
                              PyObject *value,
                              Py_ssize_t length,
                              const PyTypeObject *type,
                              const char *error_prefix);
 
[[nodiscard]] int PyC_AsArray_Multi_FAST(void *array,
                                         size_t array_item_size,
                                         PyObject *value_fast,
                                         const int *dims,
                                         int dims_len,
                                         const PyTypeObject *type,
                                         const char *error_prefix);
 
[[nodiscard]] int PyC_AsArray_Multi(void *array,
                                    size_t array_item_size,
                                    PyObject *value,
                                    const int *dims,
                                    int dims_len,
                                    const PyTypeObject *type,
                                    const char *error_prefix);
 
[[nodiscard]] PyObject *PyC_Tuple_PackArray_F32(const float *array, uint len);
[[nodiscard]] PyObject *PyC_Tuple_PackArray_F64(const double *array, uint len);
[[nodiscard]] PyObject *PyC_Tuple_PackArray_I32(const int *array, uint len);
[[nodiscard]] PyObject *PyC_Tuple_PackArray_I32FromBool(const int *array, uint len);
[[nodiscard]] PyObject *PyC_Tuple_PackArray_Bool(const bool *array, uint len);

[[nodiscard]] PyObject *PyC_Tuple_PackArray_String(const char **array, uint len);
 
[[nodiscard]] PyObject *PyC_Tuple_PackArray_Multi_F32(const float *array,
                                                      const int dims[],
                                                      int dims_len);
[[nodiscard]] PyObject *PyC_Tuple_PackArray_Multi_F64(const double *array,
                                                      const int dims[],
                                                      int dims_len);
[[nodiscard]] PyObject *PyC_Tuple_PackArray_Multi_I32(const int *array,
                                                      const int dims[],
                                                      int dims_len);
[[nodiscard]] PyObject *PyC_Tuple_PackArray_Multi_Bool(const bool *array,
                                                       const int dims[],
                                                       int dims_len);

void PyC_Tuple_Fill(PyObject *tuple, PyObject *value);
void PyC_List_Fill(PyObject *list, PyObject *value);

[[nodiscard]] PyObject *PyC_UnicodeFromBytes(const char *str);
[[nodiscard]] PyObject *PyC_UnicodeFromBytesAndSize(const char *str, Py_ssize_t size);
[[nodiscard]] const char *PyC_UnicodeAsBytes(PyObject *py_str,
                                             PyObject **r_coerce); /* coerce must be NULL */
[[nodiscard]] const char *PyC_UnicodeAsBytesAndSize(PyObject *py_str,
                                                    Py_ssize_t *r_size,
                                                    PyObject **r_coerce);

struct PyC_UnicodeAsBytesAndSize_Data {
  PyObject *value_coerce;
  const char *value;
  Py_ssize_t value_len;
};

int PyC_ParseUnicodeAsBytesAndSize(PyObject *o, void *p);
int PyC_ParseUnicodeAsBytesAndSize_OrNone(PyObject *o, void *p);

[[nodiscard]] PyObject *PyC_DefaultNameSpace(const char *filename) ATTR_NONNULL(1);
void PyC_RunQuicky(const char *filepath, int n, ...) ATTR_NONNULL(1);
[[nodiscard]] bool PyC_NameSpace_ImportArray(PyObject *py_dict, const char *imports[]);

[[nodiscard]] PyObject *PyC_MainModule_Backup();
void PyC_MainModule_Restore(PyObject *main_mod);
 
[[nodiscard]] bool PyC_IsInterpreterActive();

[[nodiscard]] void *PyC_RNA_AsPointer(PyObject *value, const char *type_name);
 
/* flag / set --- interchange */
struct PyC_FlagSet {
  int value;
  const char *identifier;
};
 
[[nodiscard]] PyObject *PyC_FlagSet_AsString(const PyC_FlagSet *item);
[[nodiscard]] int PyC_FlagSet_ValueFromID_int(const PyC_FlagSet *item,
                                              const char *identifier,
                                              int *r_value);
[[nodiscard]] int PyC_FlagSet_ValueFromID(const PyC_FlagSet *item,
                                          const char *identifier,
                                          int *r_value,
                                          const char *error_prefix);
[[nodiscard]] int PyC_FlagSet_ToBitfield(const PyC_FlagSet *items,
                                         PyObject *value,
                                         int *r_value,
                                         const char *error_prefix);
[[nodiscard]] PyObject *PyC_FlagSet_FromBitfield(PyC_FlagSet *items, int flag);

[[nodiscard]] bool PyC_RunString_AsNumber(const char **imports,
                                          const char *expr,
                                          const char *filename,
                                          double *r_value) ATTR_NONNULL(2, 3, 4);
[[nodiscard]] bool PyC_RunString_AsIntPtr(const char **imports,
                                          const char *expr,
                                          const char *filename,
                                          intptr_t *r_value) ATTR_NONNULL(2, 3, 4);
[[nodiscard]] bool PyC_RunString_AsStringAndSize(const char **imports,
                                                 const char *expr,
                                                 const char *filename,
                                                 char **r_value,
                                                 size_t *r_value_size) ATTR_NONNULL(2, 3, 4, 5);
[[nodiscard]] bool PyC_RunString_AsString(const char **imports,
                                          const char *expr,
                                          const char *filename,
                                          char **r_value) ATTR_NONNULL(2, 3, 4);

[[nodiscard]] bool PyC_RunString_AsStringAndSizeOrNone(const char **imports,
                                                       const char *expr,
                                                       const char *filename,
                                                       char **r_value,
                                                       size_t *r_value_size) ATTR_NONNULL(2, 3, 4);
[[nodiscard]] bool PyC_RunString_AsStringOrNone(const char **imports,
                                                const char *expr,
                                                const char *filename,
                                                char **r_value) ATTR_NONNULL(2, 3, 4);

void PyC_StdFilesFlush();

[[nodiscard]] int PyC_ParseBool(PyObject *o, void *p);
 
struct PyC_StringEnumItems {
  int value;
  const char *id;
};
struct PyC_StringEnum {
  const struct PyC_StringEnumItems *items;
  int value_found;
};

[[nodiscard]] int PyC_ParseStringEnum(PyObject *o, void *p);
[[nodiscard]] const char *PyC_StringEnum_FindIDFromValue(const struct PyC_StringEnumItems *items,
                                                         int value);

[[nodiscard]] int PyC_CheckArgs_DeepCopy(PyObject *args);
 
/* Integer parsing (with overflow checks), -1 on error. */
[[nodiscard]] int PyC_Long_AsBool(PyObject *value);
[[nodiscard]] int8_t PyC_Long_AsI8(PyObject *value);
[[nodiscard]] int16_t PyC_Long_AsI16(PyObject *value);
#if 0 /* inline */
[[nodiscard]] int32_t PyC_Long_AsI32(PyObject *value);
[[nodiscard]] int64_t PyC_Long_AsI64(PyObject *value);
#endif

[[nodiscard]] uint8_t PyC_Long_AsU8(PyObject *value);
[[nodiscard]] uint16_t PyC_Long_AsU16(PyObject *value);
[[nodiscard]] uint32_t PyC_Long_AsU32(PyObject *value);
[[nodiscard]] uint64_t PyC_Long_AsU64(PyObject *value);
 
/* inline so type signatures match as expected */
[[nodiscard]] Py_LOCAL_INLINE(int32_t) PyC_Long_AsI32(PyObject *value)
{
#if PY_VERSION_HEX < 0x030d0000 /* <3.13 */
  return (int32_t)_PyLong_AsInt(value);
#else
  return (int32_t)PyLong_AsInt(value);
#endif
}
[[nodiscard]] Py_LOCAL_INLINE(int64_t) PyC_Long_AsI64(PyObject *value)
{
  return (int64_t)PyLong_AsLongLong(value);
}
 
/* utils for format string in `struct` module style syntax */
[[nodiscard]] char PyC_StructFmt_type_from_str(const char *typestr);
[[nodiscard]] bool PyC_StructFmt_type_is_float_any(char format);
[[nodiscard]] bool PyC_StructFmt_type_is_int_any(char format);
[[nodiscard]] bool PyC_StructFmt_type_is_byte(char format);
[[nodiscard]] bool PyC_StructFmt_type_is_bool(char format);

[[nodiscard]] PyObject *PyC_UnicodeFromStdStr(const std::string &str);
 
[[nodiscard]] inline PyObject *PyC_Tuple_Pack_F32(const blender::Span<float> values)
{
  return PyC_Tuple_PackArray_F32(values.data(), values.size());
}
[[nodiscard]] inline PyObject *PyC_Tuple_Pack_F64(const blender::Span<double> values)
{
  return PyC_Tuple_PackArray_F64(values.data(), values.size());
}
[[nodiscard]] inline PyObject *PyC_Tuple_Pack_I32(const blender::Span<int> values)
{
  return PyC_Tuple_PackArray_I32(values.data(), values.size());
}
[[nodiscard]] inline PyObject *PyC_Tuple_Pack_I32FromBool(const blender::Span<int> values)
{
  return PyC_Tuple_PackArray_I32FromBool(values.data(), values.size());
}
[[nodiscard]] inline PyObject *PyC_Tuple_Pack_Bool(const blender::Span<bool> values)
{
  return PyC_Tuple_PackArray_Bool(values.data(), values.size());
}