test/source/blender/python/mathutils/mathutils.hh

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

#pragma once

/** \file
 * \ingroup pymathutils
 */

#include <Python.h>

/* Can cast different mathutils types to this, use for generic functions. */

#include "BLI_array.hh"
#include "BLI_vector.hh"

struct DynStr;

extern char BaseMathObject_is_wrapped_doc[];
extern char BaseMathObject_is_frozen_doc[];
extern char BaseMathObject_is_valid_doc[];
extern char BaseMathObject_owner_doc[];

[[nodiscard]] PyObject *_BaseMathObject_new_impl(PyTypeObject *root_type, PyTypeObject *base_type);

#define BASE_MATH_NEW(struct_name, root_type, base_type) \
  ((struct_name *)_BaseMathObject_new_impl(&root_type, base_type))

/** #BaseMathObject.flag */
enum {
  /**
   * Do not own the memory used in this vector,
   * \note This is error prone if the memory may be freed while this vector is in use.
   * Prefer using callbacks where possible, see: #Mathutils_RegisterCallback
   */
  BASE_MATH_FLAG_IS_WRAP = (1 << 0),
  /**
   * Prevent changes to the vector so it can be used as a set or dictionary key for example.
   * (typical use cases for tuple).
   */
  BASE_MATH_FLAG_IS_FROZEN = (1 << 1),
  /**
   * When set, prevents calling freeze() and resize() while using the buffer protocol.
   *
   * \note `memoryview` & `np.frombuffer` pass the `PyBUF_FORMAT | PyBUF_INDIRECT` flags,
   * and the object can be mutated, so `PyBUF_WRITABLE` can't be handled.
   * That's why it's always necessary to check for write access.
   */
  BASE_MATH_FLAG_HAS_BUFFER_VIEW = (1 << 2),
};
#define BASE_MATH_FLAG_DEFAULT 0

#define BASE_MATH_MEMBERS(_data) \
  /** Array of data (alias), wrapped status depends on wrapped status. */ \
  PyObject_VAR_HEAD \
  float *_data; \
  /** If this vector references another object, otherwise NULL, *Note* this owns its reference */ \
  PyObject *cb_user; \
  /** Which user functions do we adhere to, RNA, etc */ \
  unsigned char cb_type; \
  /** Sub-type: location, rotation... \
   * to avoid defining many new functions for every attribute of the same type */ \
  unsigned char cb_subtype; \
  /** Wrapped data type. */ \
  unsigned char flag

struct BaseMathObject {
  BASE_MATH_MEMBERS(data);
};

/* types */
#include "mathutils_Color.hh"       // IWYU pragma: export
#include "mathutils_Euler.hh"       // IWYU pragma: export
#include "mathutils_Matrix.hh"      // IWYU pragma: export
#include "mathutils_Quaternion.hh"  // IWYU pragma: export
#include "mathutils_Vector.hh"      // IWYU pragma: export

/* avoid checking all types */
#define BaseMathObject_CheckExact(v) (Py_TYPE(v)->tp_dealloc == (destructor)BaseMathObject_dealloc)

[[nodiscard]] PyObject *BaseMathObject_owner_get(BaseMathObject *self, void *);
[[nodiscard]] PyObject *BaseMathObject_is_wrapped_get(BaseMathObject *self, void *);
[[nodiscard]] PyObject *BaseMathObject_is_frozen_get(BaseMathObject *self, void *);
[[nodiscard]] PyObject *BaseMathObject_is_valid_get(BaseMathObject *self, void *);

extern char BaseMathObject_freeze_doc[];
[[nodiscard]] PyObject *BaseMathObject_freeze(BaseMathObject *self);

int BaseMathObject_traverse(BaseMathObject *self, visitproc visit, void *arg);
int BaseMathObject_clear(BaseMathObject *self);
void BaseMathObject_dealloc(BaseMathObject *self);
int BaseMathObject_is_gc(BaseMathObject *self);

PyMODINIT_FUNC PyInit_mathutils();

[[nodiscard]] int EXPP_FloatsAreEqual(float af, float bf, int maxDiff);
[[nodiscard]] int EXPP_VectorsAreEqual(const float *vecA,
                                       const float *vecB,
                                       int size,
                                       int floatSteps);

/** Checks the user is still valid. */
using BaseMathCheckFunc = int (*)(BaseMathObject *);
/** Gets the vector from the user. */
using BaseMathGetFunc = int (*)(BaseMathObject *, int);
/** Sets the users vector values once its modified. */
using BaseMathSetFunc = int (*)(BaseMathObject *, int);
/** Same as #BaseMathGetFunc but only for an index. */
using BaseMathGetIndexFunc = int (*)(BaseMathObject *, int, int);
/** Same as #BaseMathSetFunc but only for an index. */
using BaseMathSetIndexFunc = int (*)(BaseMathObject *, int, int);

struct Mathutils_Callback {
  BaseMathCheckFunc check;
  BaseMathGetFunc get;
  BaseMathSetFunc set;
  BaseMathGetIndexFunc get_index;
  BaseMathSetIndexFunc set_index;
};

[[nodiscard]] unsigned char Mathutils_RegisterCallback(Mathutils_Callback *cb);

[[nodiscard]] int _BaseMathObject_CheckCallback(BaseMathObject *self);
[[nodiscard]] int _BaseMathObject_ReadCallback(BaseMathObject *self);
[[nodiscard]] int _BaseMathObject_WriteCallback(BaseMathObject *self);
[[nodiscard]] int _BaseMathObject_ReadIndexCallback(BaseMathObject *self, int index);
[[nodiscard]] int _BaseMathObject_WriteIndexCallback(BaseMathObject *self, int index);
/** To implement #BaseMath_Prepare_ForResize. */
[[nodiscard]] int _BaseMathObject_ResizeOkOrRaiseExc(BaseMathObject *self,
                                                     const char *error_prefix);
[[nodiscard]] int _BaseMathObject_RaiseBufferViewExc(BaseMathObject *self,
                                                     Py_buffer *view,
                                                     int flags);

void _BaseMathObject_RaiseFrozenExc(const BaseMathObject *self);
void _BaseMathObject_RaiseNotFrozenExc(const BaseMathObject *self);

/* since this is called so often avoid where possible */
#define BaseMath_CheckCallback(_self) \
  (((_self)->cb_user ? _BaseMathObject_CheckCallback((BaseMathObject *)_self) : 0))
#define BaseMath_ReadCallback(_self) \
  (((_self)->cb_user ? _BaseMathObject_ReadCallback((BaseMathObject *)_self) : 0))
#define BaseMath_WriteCallback(_self) \
  (((_self)->cb_user ? _BaseMathObject_WriteCallback((BaseMathObject *)_self) : 0))
#define BaseMath_ReadIndexCallback(_self, _index) \
  (((_self)->cb_user ? _BaseMathObject_ReadIndexCallback((BaseMathObject *)_self, _index) : 0))
#define BaseMath_WriteIndexCallback(_self, _index) \
  (((_self)->cb_user ? _BaseMathObject_WriteIndexCallback((BaseMathObject *)_self, _index) : 0))

/* support BASE_MATH_FLAG_IS_FROZEN */
#define BaseMath_ReadCallback_ForWrite(_self) \
  (UNLIKELY((_self)->flag & BASE_MATH_FLAG_IS_FROZEN) ? \
       (_BaseMathObject_RaiseFrozenExc((BaseMathObject *)_self), -1) : \
       (BaseMath_ReadCallback(_self)))

#define BaseMath_ReadIndexCallback_ForWrite(_self, _index) \
  (UNLIKELY((_self)->flag & BASE_MATH_FLAG_IS_FROZEN) ? \
       (_BaseMathObject_RaiseFrozenExc((BaseMathObject *)_self), -1) : \
       (BaseMath_ReadIndexCallback(_self, _index)))

#define BaseMath_Prepare_ForWrite(_self) \
  (UNLIKELY((_self)->flag & BASE_MATH_FLAG_IS_FROZEN) ? \
       (_BaseMathObject_RaiseFrozenExc((BaseMathObject *)_self), -1) : \
       0)

#define BaseMathObject_Prepare_ForHash(_self) \
  (UNLIKELY(((_self)->flag & BASE_MATH_FLAG_IS_FROZEN) == 0) ? \
       (_BaseMathObject_RaiseNotFrozenExc((BaseMathObject *)_self), -1) : \
       0)
/**
 * Helper to de-duplicate checks for in-place resizing.
 * \return -1 and set an exception if the vector `_self` cannot be resized.
 */
#define BaseMathObject_Prepare_ForResize(_self, error_prefix) \
  _BaseMathObject_ResizeOkOrRaiseExc((BaseMathObject *)_self, error_prefix)

/**
 * Ensure #BASE_MATH_FLAG_HAS_BUFFER_VIEW is supported.
 * \param _view: The `view` argument forwarded from #PyBufferProcs::bf_getbuffer.
 * \param _flags: The `flags` argument forwarded from #PyBufferProcs::bf_getbuffer.
 * \return -1 and set an exception if the vector `_self` does not support buffer access.
 */
#define BaseMath_Prepare_ForBufferAccess(_self, _view, _flags) \
  _BaseMathObject_RaiseBufferViewExc((BaseMathObject *)_self, _view, _flags)

/* utility func */
/**
 * Helper function.
 * \return length of `value`, -1 on error.
 */
[[nodiscard]] int mathutils_array_parse(
    float *array, int array_num_min, int array_num_max, PyObject *value, const char *error_prefix);
/**
 * \return -1 is returned on error and no allocation is made.
 */
[[nodiscard]] int mathutils_array_parse_alloc(float **array,
                                              int array_num_min,
                                              PyObject *value,
                                              const char *error_prefix);
/**
 * Parse an array of vectors.
 */
[[nodiscard]] int mathutils_array_parse_alloc_v(float **array,
                                                int array_dim,
                                                PyObject *value,
                                                const char *error_prefix);
/**
 * Parse an sequence array_dim integers into array.
 */
[[nodiscard]] int mathutils_int_array_parse(int *array,
                                            int array_dim,
                                            PyObject *value,
                                            const char *error_prefix);
/**
 * Parse sequence of array_dim sequences of integers and return allocated result.
 */
[[nodiscard]] int mathutils_array_parse_alloc_vi(int **array,
                                                 int array_dim,
                                                 PyObject *value,
                                                 const char *error_prefix);
/**
 * Parse sequence of variable-length sequences of integers and fill r_data with their values.
 */
[[nodiscard]] bool mathutils_array_parse_alloc_viseq(PyObject *value,
                                                     const char *error_prefix,
                                                     blender::Array<blender::Vector<int>> &r_data);
[[nodiscard]] int mathutils_any_to_rotmat(float rmat[3][3],
                                          PyObject *value,
                                          const char *error_prefix);

/**
 * helper function that returns a Python `__hash__`.
 *
 * \note consistent with the equivalent tuple of floats (CPython's `tuplehash`)
 */
[[nodiscard]] Py_hash_t mathutils_array_hash(const float *array, size_t array_len);

/* zero remaining unused elements of the array */
#define MU_ARRAY_ZERO (1u << 30)
/* ignore larger py sequences than requested (just use first elements),
 * handy when using 3d vectors as 2d */
#define MU_ARRAY_SPILL (1u << 31)

#define MU_ARRAY_FLAGS (MU_ARRAY_ZERO | MU_ARRAY_SPILL)

/**
 * Column vector multiplication (Matrix * Vector).
 * <pre>
 * [1][4][7]   [a]
 * [2][5][8] * [b]
 * [3][6][9]   [c]
 * </pre>
 *
 * \note Vector/Matrix multiplication is not commutative.
 * \note Assume read callbacks have been done first.
 */
[[nodiscard]] int column_vector_multiplication(float r_vec[4],
                                               VectorObject *vec,
                                               MatrixObject *mat);

#ifndef MATH_STANDALONE
/* dynstr as python string utility functions */
/* dynstr as python string utility functions, frees 'ds'! */
[[nodiscard]] PyObject *mathutils_dynstr_to_py(struct DynStr *ds);
#endif