/* SPDX-License-Identifier: GPL-2.0-or-later */ /** \file * \ingroup pythonintern * * This file defines 'bpy.props' module used so scripts can define their own * rna properties for use with python operators or adding new properties to * existing blender types. */ /* Future-proof, See https://docs.python.org/3/c-api/arg.html#strings-and-buffers */ #define PY_SSIZE_T_CLEAN #include #include "RNA_types.h" #include "BLI_listbase.h" #include "BLI_utildefines.h" #include "bpy_capi_utils.h" #include "bpy_props.h" #include "bpy_rna.h" #include "BKE_idprop.h" #include "RNA_access.h" #include "RNA_define.h" /* for defining our own rna */ #include "RNA_enum_types.h" #include "RNA_prototypes.h" #include "MEM_guardedalloc.h" #include "DNA_ID.h" /* MAX_IDPROP_NAME */ #include "../generic/py_capi_rna.h" #include "../generic/py_capi_utils.h" /* Disabled duplicating strings because the array can still be freed and * the strings from it referenced, for now we can't support dynamically * created strings from Python. */ // #define USE_ENUM_COPY_STRINGS /* -------------------------------------------------------------------- */ /** \name Shared Enums & Doc-Strings * \{ */ #define BPY_PROPDEF_OPTIONS_DOC \ " :arg options: Enumerator in :ref:`rna_enum_property_flag_items`.\n" \ " :type options: set\n" #define BPY_PROPDEF_OPTIONS_ENUM_DOC \ " :arg options: Enumerator in :ref:`rna_enum_property_flag_enum_items`.\n" \ " :type options: set\n" #define BPY_PROPDEF_OPTIONS_OVERRIDE_DOC \ " :arg override: Enumerator in :ref:`rna_enum_property_override_flag_items`.\n" \ " :type override: set\n" #define BPY_PROPDEF_OPTIONS_OVERRIDE_COLLECTION_DOC \ " :arg override: Enumerator in :ref:`rna_enum_property_override_flag_collection_items`.\n" \ " :type override: set\n" #define BPY_PROPDEF_SUBTYPE_STRING_DOC \ " :arg subtype: Enumerator in :ref:`rna_enum_property_subtype_string_items`.\n" \ " :type subtype: string\n" #define BPY_PROPDEF_SUBTYPE_NUMBER_DOC \ " :arg subtype: Enumerator in :ref:`rna_enum_property_subtype_number_items`.\n" \ " :type subtype: string\n" #define BPY_PROPDEF_SUBTYPE_NUMBER_ARRAY_DOC \ " :arg subtype: Enumerator in :ref:`rna_enum_property_subtype_number_array_items`.\n" \ " :type subtype: string\n" /** \} */ /* -------------------------------------------------------------------- */ /** \name Python Property Storage API * * Functionality needed to use Python native callbacks from generic C RNA callbacks. * \{ */ /** * Store #PyObject data for a dynamically defined property. * Currently this is only used to store call-back functions. * Properties that don't use custom callbacks won't allocate this struct. * * Memory/Reference Management * --------------------------- * * This struct adds/removes the user-count of each #PyObject it references, * it's needed in case the function is removed from the class (unlikely but possible), * also when an annotation evaluates to a `lambda` with Python 3.10 and newer e.g: T86332. * * Pointers to this struct are held in: * * - #PropertyRNA.py_data (owns the memory). * Freed when the RNA property is freed. * * - #g_bpy_prop_store_list (borrows the memory) * Having a global list means the users can be visited by the GC and cleared on exit. * * This list can't be used for freeing as #BPyPropStore doesn't hold a #PropertyRNA back-pointer, * (while it could be supported it would only complicate things). * * All RNA properties are freed after Python has been shut-down. * At that point Python user counts can't be touched and must have already been dealt with. * * Decrementing users is handled by: * * - #bpy_prop_py_data_remove manages decrementing at run-time (when a property is removed), * * - #BPY_rna_props_clear_all does this on exit for all dynamic properties. */ struct BPyPropStore { struct BPyPropStore *next, *prev; /** * Only store #PyObject types, so this member can be cast to an array and iterated over. * NULL members are skipped. */ struct { /** Wrap: `RNA_def_property_*_funcs` (depending on type). */ PyObject *get_fn; PyObject *set_fn; /** Wrap: #RNA_def_property_update_runtime */ PyObject *update_fn; /** Arguments by type. */ union { /** #PROP_ENUM type. */ struct { /** Wrap: #RNA_def_property_enum_funcs_runtime */ PyObject *itemf_fn; } enum_data; /** #PROP_POINTER type. */ struct { /** Wrap: #RNA_def_property_poll_runtime */ PyObject *poll_fn; } pointer_data; /** #PROP_STRING type. */ struct { /** Wrap: #RNA_def_property_string_search_func_runtime */ PyObject *search_fn; } string_data; }; } py_data; }; #define BPY_PROP_STORE_PY_DATA_SIZE \ (sizeof(((struct BPyPropStore *)NULL)->py_data) / sizeof(PyObject *)) #define ASSIGN_PYOBJECT_INCREF(a, b) \ { \ BLI_assert((a) == NULL); \ Py_INCREF(b); \ a = b; \ } \ ((void)0) /** * Maintain a list of Python defined properties, so the GC can visit them, * and so they can be cleared on exit. */ static ListBase g_bpy_prop_store_list = {NULL, NULL}; static struct BPyPropStore *bpy_prop_py_data_ensure(struct PropertyRNA *prop) { struct BPyPropStore *prop_store = RNA_property_py_data_get(prop); if (prop_store == NULL) { prop_store = MEM_callocN(sizeof(*prop_store), __func__); RNA_def_py_data(prop, prop_store); BLI_addtail(&g_bpy_prop_store_list, prop_store); } return prop_store; } /** * Perform all removal actions except for freeing, which is handled by RNA. */ static void bpy_prop_py_data_remove(PropertyRNA *prop) { struct BPyPropStore *prop_store = RNA_property_py_data_get(prop); if (prop_store == NULL) { return; } PyObject **py_data = (PyObject **)&prop_store->py_data; for (int i = 0; i < BPY_PROP_STORE_PY_DATA_SIZE; i++) { Py_XDECREF(py_data[i]); } BLI_remlink(&g_bpy_prop_store_list, prop_store); } /** \} */ /* -------------------------------------------------------------------- */ /** \name Deferred Property Type * * Operators and classes use this so it can store the arguments given but defer * running it until the operator runs where these values are used to setup * the default arguments for that operator instance. * \{ */ static void bpy_prop_deferred_dealloc(BPy_PropDeferred *self) { PyObject_GC_UnTrack(self); Py_CLEAR(self->kw); PyObject_GC_Del(self); } static int bpy_prop_deferred_traverse(BPy_PropDeferred *self, visitproc visit, void *arg) { Py_VISIT(self->kw); return 0; } static int bpy_prop_deferred_clear(BPy_PropDeferred *self) { Py_CLEAR(self->kw); return 0; } static PyObject *bpy_prop_deferred_repr(BPy_PropDeferred *self) { return PyUnicode_FromFormat("<%.200s, %R, %R>", Py_TYPE(self)->tp_name, self->fn, self->kw); } /** * HACK: needed by `typing.get_type_hints` * with `from __future__ import annotations` enabled or when using Python 3.10 or newer. * * When callable this object type passes the test for being an acceptable annotation. */ static PyObject *bpy_prop_deferred_call(BPy_PropDeferred *UNUSED(self), PyObject *UNUSED(args), PyObject *UNUSED(kw)) { /* Dummy value. */ Py_RETURN_NONE; } /* Get/Set Items. */ /** * Expose the function in case scripts need to introspect this information * (not currently used by Blender itself). */ static PyObject *bpy_prop_deferred_function_get(BPy_PropDeferred *self, void *UNUSED(closure)) { PyObject *ret = self->fn; Py_IncRef(ret); return ret; } /** * Expose keywords in case scripts need to introspect this information * (not currently used by Blender itself). */ static PyObject *bpy_prop_deferred_keywords_get(BPy_PropDeferred *self, void *UNUSED(closure)) { PyObject *ret = self->kw; Py_IncRef(ret); return ret; } static PyGetSetDef bpy_prop_deferred_getset[] = { {"function", (getter)bpy_prop_deferred_function_get, (setter)NULL, NULL, NULL}, {"keywords", (getter)bpy_prop_deferred_keywords_get, (setter)NULL, NULL, NULL}, {NULL, NULL, NULL, NULL, NULL} /* Sentinel */ }; PyDoc_STRVAR(bpy_prop_deferred_doc, "Intermediate storage for properties before registration.\n" "\n" ".. note::\n" "\n" " This is not part of the stable API and may change between releases."); PyTypeObject bpy_prop_deferred_Type = { PyVarObject_HEAD_INIT(NULL, 0) .tp_name = "_PropertyDeferred", .tp_basicsize = sizeof(BPy_PropDeferred), .tp_dealloc = (destructor)bpy_prop_deferred_dealloc, .tp_repr = (reprfunc)bpy_prop_deferred_repr, .tp_call = (ternaryfunc)bpy_prop_deferred_call, .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC, .tp_doc = bpy_prop_deferred_doc, .tp_traverse = (traverseproc)bpy_prop_deferred_traverse, .tp_clear = (inquiry)bpy_prop_deferred_clear, .tp_getset = bpy_prop_deferred_getset, }; static PyObject *bpy_prop_deferred_data_CreatePyObject(PyObject *fn, PyObject *kw) { BPy_PropDeferred *self = PyObject_GC_New(BPy_PropDeferred, &bpy_prop_deferred_Type); self->fn = fn; if (kw == NULL) { kw = PyDict_New(); } else { Py_INCREF(kw); } self->kw = kw; BLI_assert(!PyObject_GC_IsTracked((PyObject *)self)); PyObject_GC_Track(self); return (PyObject *)self; } /** \} */ /* -------------------------------------------------------------------- */ /** \name Shared Property Utilities * \{ */ /* PyObject's */ static PyObject *pymeth_BoolProperty = NULL; static PyObject *pymeth_BoolVectorProperty = NULL; static PyObject *pymeth_IntProperty = NULL; static PyObject *pymeth_IntVectorProperty = NULL; static PyObject *pymeth_FloatProperty = NULL; static PyObject *pymeth_FloatVectorProperty = NULL; static PyObject *pymeth_StringProperty = NULL; static PyObject *pymeth_EnumProperty = NULL; static PyObject *pymeth_PointerProperty = NULL; static PyObject *pymeth_CollectionProperty = NULL; static PyObject *pymeth_RemoveProperty = NULL; static PyObject *pyrna_struct_as_instance(PointerRNA *ptr) { PyObject *self = NULL; /* first get self */ /* operators can store their own instance for later use */ if (ptr->data) { void **instance = RNA_struct_instance(ptr); if (instance) { if (*instance) { self = *instance; Py_INCREF(self); } } } /* in most cases this will run */ if (self == NULL) { self = pyrna_struct_CreatePyObject(ptr); } return self; } static void bpy_prop_assign_flag(PropertyRNA *prop, const int flag) { const int flag_mask = ((PROP_ANIMATABLE) & ~flag); if (flag) { RNA_def_property_flag(prop, flag); } if (flag_mask) { RNA_def_property_clear_flag(prop, flag_mask); } } static void bpy_prop_assign_flag_override(PropertyRNA *prop, const int flag_override) { RNA_def_property_override_flag(prop, flag_override); } /** \} */ /* -------------------------------------------------------------------- */ /** \name Multi-Dimensional Property Utilities * \{ */ struct BPyPropArrayLength { int len_total; /** Ignore `dims` when `dims_len == 0`. */ int dims[RNA_MAX_ARRAY_DIMENSION]; int dims_len; }; /** * Use with #PyArg_ParseTuple's `O&` formatting. */ static int bpy_prop_array_length_parse(PyObject *o, void *p) { struct BPyPropArrayLength *array_len_info = p; if (PyLong_CheckExact(o)) { int size; if ((size = PyLong_AsLong(o)) == -1) { PyErr_Format( PyExc_ValueError, "expected number or sequence of numbers, got %s", Py_TYPE(o)->tp_name); return 0; } if (size < 1 || size > PYRNA_STACK_ARRAY) { PyErr_Format( PyExc_TypeError, "(size=%d) must be between 1 and " STRINGIFY(PYRNA_STACK_ARRAY), size); return 0; } array_len_info->len_total = size; /* Don't use this value. */ array_len_info->dims_len = 0; } else { PyObject *seq_fast; if (!(seq_fast = PySequence_Fast(o, "size must be a number of a sequence of numbers"))) { return 0; } const int seq_len = PySequence_Fast_GET_SIZE(seq_fast); if (seq_len < 1 || seq_len > RNA_MAX_ARRAY_DIMENSION) { PyErr_Format( PyExc_TypeError, "(len(size)=%d) length must be between 1 and " STRINGIFY(RNA_MAX_ARRAY_DIMENSION), seq_len); Py_DECREF(seq_fast); return 0; } PyObject **seq_items = PySequence_Fast_ITEMS(seq_fast); for (int i = 0; i < seq_len; i++) { int size; if ((size = PyLong_AsLong(seq_items[i])) == -1) { Py_DECREF(seq_fast); PyErr_Format(PyExc_ValueError, "expected number in sequence, got %s at index %d", Py_TYPE(o)->tp_name, i); return 0; } if (size < 1 || size > PYRNA_STACK_ARRAY) { Py_DECREF(seq_fast); PyErr_Format(PyExc_TypeError, "(size[%d]=%d) must be between 1 and " STRINGIFY(PYRNA_STACK_ARRAY), i, size); return 0; } array_len_info->dims[i] = size; array_len_info->dims_len = seq_len; } } return 1; } /** * Return -1 on error. */ static int bpy_prop_array_from_py_with_dims(void *values, size_t values_elem_size, PyObject *py_values, const struct BPyPropArrayLength *array_len_info, const PyTypeObject *type, const char *error_str) { if (array_len_info->dims_len == 0) { return PyC_AsArray( values, values_elem_size, py_values, array_len_info->len_total, type, error_str); } const int *dims = array_len_info->dims; const int dims_len = array_len_info->dims_len; return PyC_AsArray_Multi(values, values_elem_size, py_values, dims, dims_len, type, error_str); } static bool bpy_prop_array_is_matrix_compatible_ex(int subtype, const struct BPyPropArrayLength *array_len_info) { return ((subtype == PROP_MATRIX) && (array_len_info->dims_len == 2) && ((array_len_info->dims[0] >= 2) && (array_len_info->dims[0] >= 4)) && ((array_len_info->dims[1] >= 2) && (array_len_info->dims[1] >= 4))); } static bool bpy_prop_array_is_matrix_compatible(PropertyRNA *prop, const struct BPyPropArrayLength *array_len_info) { BLI_assert(RNA_property_type(prop) == PROP_FLOAT); return bpy_prop_array_is_matrix_compatible_ex(RNA_property_subtype(prop), array_len_info); } /** * Needed since the internal storage of matrices swaps row/column. */ static void bpy_prop_array_matrix_swap_row_column_vn_vn( float *values_dst, const float *values_src, const struct BPyPropArrayLength *array_len_info) { BLI_assert(values_dst != values_src); const int dim0 = array_len_info->dims[0], dim1 = array_len_info->dims[1]; BLI_assert(dim0 <= 4 && dim1 <= 4); for (int i = 0; i < dim0; i++) { for (int j = 0; j < dim1; j++) { values_dst[(j * dim0) + i] = values_src[(i * dim1) + j]; } } } static void bpy_prop_array_matrix_swap_row_column_vn( float *values, const struct BPyPropArrayLength *array_len_info) { const int dim0 = array_len_info->dims[0], dim1 = array_len_info->dims[1]; BLI_assert(dim0 <= 4 && dim1 <= 4); float values_orig[4 * 4]; memcpy(values_orig, values, sizeof(float) * (dim0 * dim1)); bpy_prop_array_matrix_swap_row_column_vn_vn(values, values_orig, array_len_info); } /** \} */ /* -------------------------------------------------------------------- */ /** \name Shared Property Callbacks * * Unique data is accessed via #RNA_property_py_data_get * \{ */ /* callbacks */ static void bpy_prop_update_fn(struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop) { struct BPyPropStore *prop_store = RNA_property_py_data_get(prop); PyGILState_STATE gilstate; PyObject *py_func; PyObject *args; PyObject *self; PyObject *ret; const bool is_write_ok = pyrna_write_check(); BLI_assert(prop_store != NULL); if (!is_write_ok) { pyrna_write_set(true); } bpy_context_set(C, &gilstate); py_func = prop_store->py_data.update_fn; args = PyTuple_New(2); self = pyrna_struct_as_instance(ptr); PyTuple_SET_ITEM(args, 0, self); PyTuple_SET_ITEM(args, 1, (PyObject *)bpy_context_module); Py_INCREF(bpy_context_module); ret = PyObject_CallObject(py_func, args); Py_DECREF(args); if (ret == NULL) { PyC_Err_PrintWithFunc(py_func); } else { if (ret != Py_None) { PyErr_SetString(PyExc_ValueError, "the return value must be None"); PyC_Err_PrintWithFunc(py_func); } Py_DECREF(ret); } bpy_context_clear(C, &gilstate); if (!is_write_ok) { pyrna_write_set(false); } } /** \} */ /* -------------------------------------------------------------------- */ /** \name Boolean Property Callbacks * \{ */ static bool bpy_prop_boolean_get_fn(struct PointerRNA *ptr, struct PropertyRNA *prop) { struct BPyPropStore *prop_store = RNA_property_py_data_get(prop); PyObject *py_func; PyObject *args; PyObject *self; PyObject *ret; PyGILState_STATE gilstate; bool use_gil; const bool is_write_ok = pyrna_write_check(); bool value; BLI_assert(prop_store != NULL); if (!is_write_ok) { pyrna_write_set(true); } use_gil = true; /* !PyC_IsInterpreterActive(); */ if (use_gil) { gilstate = PyGILState_Ensure(); } py_func = prop_store->py_data.get_fn; args = PyTuple_New(1); self = pyrna_struct_as_instance(ptr); PyTuple_SET_ITEM(args, 0, self); ret = PyObject_CallObject(py_func, args); Py_DECREF(args); if (ret == NULL) { PyC_Err_PrintWithFunc(py_func); value = false; } else { const int value_i = PyC_Long_AsBool(ret); if (value_i == -1 && PyErr_Occurred()) { PyC_Err_PrintWithFunc(py_func); value = false; } else { value = (bool)value_i; } Py_DECREF(ret); } if (use_gil) { PyGILState_Release(gilstate); } if (!is_write_ok) { pyrna_write_set(false); } return value; } static void bpy_prop_boolean_set_fn(struct PointerRNA *ptr, struct PropertyRNA *prop, bool value) { struct BPyPropStore *prop_store = RNA_property_py_data_get(prop); PyObject *py_func; PyObject *args; PyObject *self; PyObject *ret; PyGILState_STATE gilstate; bool use_gil; const bool is_write_ok = pyrna_write_check(); BLI_assert(prop_store != NULL); if (!is_write_ok) { pyrna_write_set(true); } use_gil = true; /* !PyC_IsInterpreterActive(); */ if (use_gil) { gilstate = PyGILState_Ensure(); } py_func = prop_store->py_data.set_fn; args = PyTuple_New(2); self = pyrna_struct_as_instance(ptr); PyTuple_SET_ITEM(args, 0, self); PyTuple_SET_ITEM(args, 1, PyBool_FromLong(value)); ret = PyObject_CallObject(py_func, args); Py_DECREF(args); if (ret == NULL) { PyC_Err_PrintWithFunc(py_func); } else { if (ret != Py_None) { PyErr_SetString(PyExc_ValueError, "the return value must be None"); PyC_Err_PrintWithFunc(py_func); } Py_DECREF(ret); } if (use_gil) { PyGILState_Release(gilstate); } if (!is_write_ok) { pyrna_write_set(false); } } static void bpy_prop_boolean_array_get_fn(struct PointerRNA *ptr, struct PropertyRNA *prop, bool *values) { struct BPyPropStore *prop_store = RNA_property_py_data_get(prop); PyObject *py_func; PyObject *args; PyObject *self; PyObject *ret; PyGILState_STATE gilstate; bool use_gil; const bool is_write_ok = pyrna_write_check(); bool is_values_set = false; int i, len = RNA_property_array_length(ptr, prop); struct BPyPropArrayLength array_len_info = {.len_total = len}; array_len_info.dims_len = RNA_property_array_dimension(ptr, prop, array_len_info.dims); BLI_assert(prop_store != NULL); if (!is_write_ok) { pyrna_write_set(true); } use_gil = true; /* !PyC_IsInterpreterActive(); */ if (use_gil) { gilstate = PyGILState_Ensure(); } py_func = prop_store->py_data.get_fn; args = PyTuple_New(1); self = pyrna_struct_as_instance(ptr); PyTuple_SET_ITEM(args, 0, self); ret = PyObject_CallObject(py_func, args); Py_DECREF(args); if (ret != NULL) { if (bpy_prop_array_from_py_with_dims(values, sizeof(*values), ret, &array_len_info, &PyBool_Type, "BoolVectorProperty get callback") == -1) { PyC_Err_PrintWithFunc(py_func); } else { is_values_set = true; } Py_DECREF(ret); } if (is_values_set == false) { /* This is the flattened length for multi-dimensional arrays. */ for (i = 0; i < len; i++) { values[i] = false; } } if (use_gil) { PyGILState_Release(gilstate); } if (!is_write_ok) { pyrna_write_set(false); } } static void bpy_prop_boolean_array_set_fn(struct PointerRNA *ptr, struct PropertyRNA *prop, const bool *values) { struct BPyPropStore *prop_store = RNA_property_py_data_get(prop); PyObject *py_func; PyObject *args; PyObject *self; PyObject *ret; PyObject *py_values; PyGILState_STATE gilstate; bool use_gil; const bool is_write_ok = pyrna_write_check(); const int len = RNA_property_array_length(ptr, prop); struct BPyPropArrayLength array_len_info = {.len_total = len}; array_len_info.dims_len = RNA_property_array_dimension(ptr, prop, array_len_info.dims); BLI_assert(prop_store != NULL); if (!is_write_ok) { pyrna_write_set(true); } use_gil = true; /* !PyC_IsInterpreterActive(); */ if (use_gil) { gilstate = PyGILState_Ensure(); } py_func = prop_store->py_data.set_fn; args = PyTuple_New(2); self = pyrna_struct_as_instance(ptr); PyTuple_SET_ITEM(args, 0, self); if (array_len_info.dims_len == 0) { py_values = PyC_Tuple_PackArray_Bool(values, len); } else { py_values = PyC_Tuple_PackArray_Multi_Bool( values, array_len_info.dims, array_len_info.dims_len); } PyTuple_SET_ITEM(args, 1, py_values); ret = PyObject_CallObject(py_func, args); Py_DECREF(args); if (ret == NULL) { PyC_Err_PrintWithFunc(py_func); } else { if (ret != Py_None) { PyErr_SetString(PyExc_ValueError, "the return value must be None"); PyC_Err_PrintWithFunc(py_func); } Py_DECREF(ret); } if (use_gil) { PyGILState_Release(gilstate); } if (!is_write_ok) { pyrna_write_set(false); } } /** \} */ /* -------------------------------------------------------------------- */ /** \name Int Property Callbacks * \{ */ static int bpy_prop_int_get_fn(struct PointerRNA *ptr, struct PropertyRNA *prop) { struct BPyPropStore *prop_store = RNA_property_py_data_get(prop); PyObject *py_func; PyObject *args; PyObject *self; PyObject *ret; PyGILState_STATE gilstate; bool use_gil; const bool is_write_ok = pyrna_write_check(); int value; BLI_assert(prop_store != NULL); if (!is_write_ok) { pyrna_write_set(true); } use_gil = true; /* !PyC_IsInterpreterActive(); */ if (use_gil) { gilstate = PyGILState_Ensure(); } py_func = prop_store->py_data.get_fn; args = PyTuple_New(1); self = pyrna_struct_as_instance(ptr); PyTuple_SET_ITEM(args, 0, self); ret = PyObject_CallObject(py_func, args); Py_DECREF(args); if (ret == NULL) { PyC_Err_PrintWithFunc(py_func); value = 0.0f; } else { value = PyC_Long_AsI32(ret); if (value == -1 && PyErr_Occurred()) { PyC_Err_PrintWithFunc(py_func); value = 0; } Py_DECREF(ret); } if (use_gil) { PyGILState_Release(gilstate); } if (!is_write_ok) { pyrna_write_set(false); } return value; } static void bpy_prop_int_set_fn(struct PointerRNA *ptr, struct PropertyRNA *prop, int value) { struct BPyPropStore *prop_store = RNA_property_py_data_get(prop); PyObject *py_func; PyObject *args; PyObject *self; PyObject *ret; PyGILState_STATE gilstate; bool use_gil; const bool is_write_ok = pyrna_write_check(); BLI_assert(prop_store != NULL); if (!is_write_ok) { pyrna_write_set(true); } use_gil = true; /* !PyC_IsInterpreterActive(); */ if (use_gil) { gilstate = PyGILState_Ensure(); } py_func = prop_store->py_data.set_fn; args = PyTuple_New(2); self = pyrna_struct_as_instance(ptr); PyTuple_SET_ITEM(args, 0, self); PyTuple_SET_ITEM(args, 1, PyLong_FromLong(value)); ret = PyObject_CallObject(py_func, args); Py_DECREF(args); if (ret == NULL) { PyC_Err_PrintWithFunc(py_func); } else { if (ret != Py_None) { PyErr_SetString(PyExc_ValueError, "the return value must be None"); PyC_Err_PrintWithFunc(py_func); } Py_DECREF(ret); } if (use_gil) { PyGILState_Release(gilstate); } if (!is_write_ok) { pyrna_write_set(false); } } static void bpy_prop_int_array_get_fn(struct PointerRNA *ptr, struct PropertyRNA *prop, int *values) { struct BPyPropStore *prop_store = RNA_property_py_data_get(prop); PyObject *py_func; PyObject *args; PyObject *self; PyObject *ret; PyGILState_STATE gilstate; bool use_gil; const bool is_write_ok = pyrna_write_check(); bool is_values_set = false; int i, len = RNA_property_array_length(ptr, prop); struct BPyPropArrayLength array_len_info = {.len_total = len}; array_len_info.dims_len = RNA_property_array_dimension(ptr, prop, array_len_info.dims); BLI_assert(prop_store != NULL); if (!is_write_ok) { pyrna_write_set(true); } use_gil = true; /* !PyC_IsInterpreterActive(); */ if (use_gil) { gilstate = PyGILState_Ensure(); } py_func = prop_store->py_data.get_fn; args = PyTuple_New(1); self = pyrna_struct_as_instance(ptr); PyTuple_SET_ITEM(args, 0, self); ret = PyObject_CallObject(py_func, args); Py_DECREF(args); if (ret != NULL) { if (bpy_prop_array_from_py_with_dims(values, sizeof(*values), ret, &array_len_info, &PyLong_Type, "IntVectorProperty get callback") == -1) { PyC_Err_PrintWithFunc(py_func); } else { is_values_set = true; } Py_DECREF(ret); } if (is_values_set == false) { /* This is the flattened length for multi-dimensional arrays. */ for (i = 0; i < len; i++) { values[i] = 0; } } if (use_gil) { PyGILState_Release(gilstate); } if (!is_write_ok) { pyrna_write_set(false); } } static void bpy_prop_int_array_set_fn(struct PointerRNA *ptr, struct PropertyRNA *prop, const int *values) { struct BPyPropStore *prop_store = RNA_property_py_data_get(prop); PyObject *py_func; PyObject *args; PyObject *self; PyObject *ret; PyObject *py_values; PyGILState_STATE gilstate; bool use_gil; const bool is_write_ok = pyrna_write_check(); const int len = RNA_property_array_length(ptr, prop); struct BPyPropArrayLength array_len_info = {.len_total = len}; array_len_info.dims_len = RNA_property_array_dimension(ptr, prop, array_len_info.dims); BLI_assert(prop_store != NULL); if (!is_write_ok) { pyrna_write_set(true); } use_gil = true; /* !PyC_IsInterpreterActive(); */ if (use_gil) { gilstate = PyGILState_Ensure(); } py_func = prop_store->py_data.set_fn; args = PyTuple_New(2); self = pyrna_struct_as_instance(ptr); PyTuple_SET_ITEM(args, 0, self); if (array_len_info.dims_len == 0) { py_values = PyC_Tuple_PackArray_I32(values, len); } else { py_values = PyC_Tuple_PackArray_Multi_I32( values, array_len_info.dims, array_len_info.dims_len); } PyTuple_SET_ITEM(args, 1, py_values); ret = PyObject_CallObject(py_func, args); Py_DECREF(args); if (ret == NULL) { PyC_Err_PrintWithFunc(py_func); } else { if (ret != Py_None) { PyErr_SetString(PyExc_ValueError, "the return value must be None"); PyC_Err_PrintWithFunc(py_func); } Py_DECREF(ret); } if (use_gil) { PyGILState_Release(gilstate); } if (!is_write_ok) { pyrna_write_set(false); } } /** \} */ /* -------------------------------------------------------------------- */ /** \name Float Property Callbacks * \{ */ static float bpy_prop_float_get_fn(struct PointerRNA *ptr, struct PropertyRNA *prop) { struct BPyPropStore *prop_store = RNA_property_py_data_get(prop); PyObject *py_func; PyObject *args; PyObject *self; PyObject *ret; PyGILState_STATE gilstate; bool use_gil; const bool is_write_ok = pyrna_write_check(); float value; BLI_assert(prop_store != NULL); if (!is_write_ok) { pyrna_write_set(true); } use_gil = true; /* !PyC_IsInterpreterActive(); */ if (use_gil) { gilstate = PyGILState_Ensure(); } py_func = prop_store->py_data.get_fn; args = PyTuple_New(1); self = pyrna_struct_as_instance(ptr); PyTuple_SET_ITEM(args, 0, self); ret = PyObject_CallObject(py_func, args); Py_DECREF(args); if (ret == NULL) { PyC_Err_PrintWithFunc(py_func); value = 0.0f; } else { value = PyFloat_AsDouble(ret); if (value == -1.0f && PyErr_Occurred()) { PyC_Err_PrintWithFunc(py_func); value = 0.0f; } Py_DECREF(ret); } if (use_gil) { PyGILState_Release(gilstate); } if (!is_write_ok) { pyrna_write_set(false); } return value; } static void bpy_prop_float_set_fn(struct PointerRNA *ptr, struct PropertyRNA *prop, float value) { struct BPyPropStore *prop_store = RNA_property_py_data_get(prop); PyObject *py_func; PyObject *args; PyObject *self; PyObject *ret; PyGILState_STATE gilstate; bool use_gil; const bool is_write_ok = pyrna_write_check(); BLI_assert(prop_store != NULL); if (!is_write_ok) { pyrna_write_set(true); } use_gil = true; /* !PyC_IsInterpreterActive(); */ if (use_gil) { gilstate = PyGILState_Ensure(); } py_func = prop_store->py_data.set_fn; args = PyTuple_New(2); self = pyrna_struct_as_instance(ptr); PyTuple_SET_ITEM(args, 0, self); PyTuple_SET_ITEM(args, 1, PyFloat_FromDouble(value)); ret = PyObject_CallObject(py_func, args); Py_DECREF(args); if (ret == NULL) { PyC_Err_PrintWithFunc(py_func); } else { if (ret != Py_None) { PyErr_SetString(PyExc_ValueError, "the return value must be None"); PyC_Err_PrintWithFunc(py_func); } Py_DECREF(ret); } if (use_gil) { PyGILState_Release(gilstate); } if (!is_write_ok) { pyrna_write_set(false); } } static void bpy_prop_float_array_get_fn(struct PointerRNA *ptr, struct PropertyRNA *prop, float *values) { struct BPyPropStore *prop_store = RNA_property_py_data_get(prop); PyObject *py_func; PyObject *args; PyObject *self; PyObject *ret; PyGILState_STATE gilstate; bool use_gil; const bool is_write_ok = pyrna_write_check(); bool is_values_set = false; int i, len = RNA_property_array_length(ptr, prop); struct BPyPropArrayLength array_len_info = {.len_total = len}; array_len_info.dims_len = RNA_property_array_dimension(ptr, prop, array_len_info.dims); BLI_assert(prop_store != NULL); if (!is_write_ok) { pyrna_write_set(true); } use_gil = true; /* !PyC_IsInterpreterActive(); */ if (use_gil) { gilstate = PyGILState_Ensure(); } py_func = prop_store->py_data.get_fn; args = PyTuple_New(1); self = pyrna_struct_as_instance(ptr); PyTuple_SET_ITEM(args, 0, self); ret = PyObject_CallObject(py_func, args); Py_DECREF(args); if (ret != NULL) { if (bpy_prop_array_from_py_with_dims(values, sizeof(*values), ret, &array_len_info, &PyFloat_Type, "FloatVectorProperty get callback") == -1) { PyC_Err_PrintWithFunc(py_func); } else { /* Only for float types. */ if (bpy_prop_array_is_matrix_compatible(prop, &array_len_info)) { bpy_prop_array_matrix_swap_row_column_vn(values, &array_len_info); } is_values_set = true; } Py_DECREF(ret); } if (is_values_set == false) { /* This is the flattened length for multi-dimensional arrays. */ for (i = 0; i < len; i++) { values[i] = 0.0f; } } if (use_gil) { PyGILState_Release(gilstate); } if (!is_write_ok) { pyrna_write_set(false); } } static void bpy_prop_float_array_set_fn(struct PointerRNA *ptr, struct PropertyRNA *prop, const float *values) { struct BPyPropStore *prop_store = RNA_property_py_data_get(prop); PyObject *py_func; PyObject *args; PyObject *self; PyObject *ret; PyObject *py_values; PyGILState_STATE gilstate; bool use_gil; const bool is_write_ok = pyrna_write_check(); const int len = RNA_property_array_length(ptr, prop); struct BPyPropArrayLength array_len_info = {.len_total = len}; array_len_info.dims_len = RNA_property_array_dimension(ptr, prop, array_len_info.dims); BLI_assert(prop_store != NULL); if (!is_write_ok) { pyrna_write_set(true); } use_gil = true; /* !PyC_IsInterpreterActive(); */ if (use_gil) { gilstate = PyGILState_Ensure(); } py_func = prop_store->py_data.set_fn; args = PyTuple_New(2); self = pyrna_struct_as_instance(ptr); PyTuple_SET_ITEM(args, 0, self); if (array_len_info.dims_len == 0) { py_values = PyC_Tuple_PackArray_F32(values, len); } else { /* No need for matrix column/row swapping here unless the matrix data is read directly. */ py_values = PyC_Tuple_PackArray_Multi_F32( values, array_len_info.dims, array_len_info.dims_len); } PyTuple_SET_ITEM(args, 1, py_values); ret = PyObject_CallObject(py_func, args); Py_DECREF(args); if (ret == NULL) { PyC_Err_PrintWithFunc(py_func); } else { if (ret != Py_None) { PyErr_SetString(PyExc_ValueError, "the return value must be None"); PyC_Err_PrintWithFunc(py_func); } Py_DECREF(ret); } if (use_gil) { PyGILState_Release(gilstate); } if (!is_write_ok) { pyrna_write_set(false); } } /** \} */ /* -------------------------------------------------------------------- */ /** \name String Property Callbacks * \{ */ static void bpy_prop_string_get_fn(struct PointerRNA *ptr, struct PropertyRNA *prop, char *value) { struct BPyPropStore *prop_store = RNA_property_py_data_get(prop); PyObject *py_func; PyObject *args; PyObject *self; PyObject *ret; PyGILState_STATE gilstate; bool use_gil; const bool is_write_ok = pyrna_write_check(); BLI_assert(prop_store != NULL); if (!is_write_ok) { pyrna_write_set(true); } use_gil = true; /* !PyC_IsInterpreterActive(); */ if (use_gil) { gilstate = PyGILState_Ensure(); } py_func = prop_store->py_data.get_fn; args = PyTuple_New(1); self = pyrna_struct_as_instance(ptr); PyTuple_SET_ITEM(args, 0, self); ret = PyObject_CallObject(py_func, args); Py_DECREF(args); if (ret == NULL) { PyC_Err_PrintWithFunc(py_func); value[0] = '\0'; } else if (!PyUnicode_Check(ret)) { PyErr_Format( PyExc_TypeError, "return value must be a string, not %.200s", Py_TYPE(ret)->tp_name); PyC_Err_PrintWithFunc(py_func); value[0] = '\0'; Py_DECREF(ret); } else { Py_ssize_t length; const char *buffer = PyUnicode_AsUTF8AndSize(ret, &length); memcpy(value, buffer, length + 1); Py_DECREF(ret); } if (use_gil) { PyGILState_Release(gilstate); } if (!is_write_ok) { pyrna_write_set(false); } } static int bpy_prop_string_length_fn(struct PointerRNA *ptr, struct PropertyRNA *prop) { struct BPyPropStore *prop_store = RNA_property_py_data_get(prop); PyObject *py_func; PyObject *args; PyObject *self; PyObject *ret; PyGILState_STATE gilstate; bool use_gil; const bool is_write_ok = pyrna_write_check(); int length; BLI_assert(prop_store != NULL); if (!is_write_ok) { pyrna_write_set(true); } use_gil = true; /* !PyC_IsInterpreterActive(); */ if (use_gil) { gilstate = PyGILState_Ensure(); } py_func = prop_store->py_data.get_fn; args = PyTuple_New(1); self = pyrna_struct_as_instance(ptr); PyTuple_SET_ITEM(args, 0, self); ret = PyObject_CallObject(py_func, args); Py_DECREF(args); if (ret == NULL) { PyC_Err_PrintWithFunc(py_func); length = 0; } else if (!PyUnicode_Check(ret)) { PyErr_Format( PyExc_TypeError, "return value must be a string, not %.200s", Py_TYPE(ret)->tp_name); PyC_Err_PrintWithFunc(py_func); length = 0; Py_DECREF(ret); } else { Py_ssize_t length_ssize_t = 0; PyUnicode_AsUTF8AndSize(ret, &length_ssize_t); length = length_ssize_t; Py_DECREF(ret); } if (use_gil) { PyGILState_Release(gilstate); } if (!is_write_ok) { pyrna_write_set(false); } return length; } static void bpy_prop_string_set_fn(struct PointerRNA *ptr, struct PropertyRNA *prop, const char *value) { struct BPyPropStore *prop_store = RNA_property_py_data_get(prop); PyObject *py_func; PyObject *args; PyObject *self; PyObject *ret; PyGILState_STATE gilstate; bool use_gil; const bool is_write_ok = pyrna_write_check(); PyObject *py_value; BLI_assert(prop_store != NULL); if (!is_write_ok) { pyrna_write_set(true); } use_gil = true; /* !PyC_IsInterpreterActive(); */ if (use_gil) { gilstate = PyGILState_Ensure(); } py_func = prop_store->py_data.set_fn; args = PyTuple_New(2); self = pyrna_struct_as_instance(ptr); PyTuple_SET_ITEM(args, 0, self); py_value = PyUnicode_FromString(value); if (!py_value) { PyErr_SetString(PyExc_ValueError, "the return value must be a string"); PyC_Err_PrintWithFunc(py_func); } else { PyTuple_SET_ITEM(args, 1, py_value); } ret = PyObject_CallObject(py_func, args); Py_DECREF(args); if (ret == NULL) { PyC_Err_PrintWithFunc(py_func); } else { if (ret != Py_None) { PyErr_SetString(PyExc_ValueError, "the return value must be None"); PyC_Err_PrintWithFunc(py_func); } Py_DECREF(ret); } if (use_gil) { PyGILState_Release(gilstate); } if (!is_write_ok) { pyrna_write_set(false); } } static bool bpy_prop_string_visit_fn_call(PyObject *py_func, PyObject *item, StringPropertySearchVisitFunc visit_fn, void *visit_user_data) { const char *text; const char *info = NULL; if (PyTuple_CheckExact(item)) { /* Positional only. */ static const char *_keywords[] = { "", "", NULL, }; static _PyArg_Parser _parser = { "s" /* `text` */ "s" /* `info` */ ":search", _keywords, 0, }; if (!_PyArg_ParseTupleAndKeywordsFast(item, NULL, &_parser, &text, &info)) { PyC_Err_PrintWithFunc(py_func); return false; } } else { text = PyUnicode_AsUTF8(item); if (UNLIKELY(text == NULL)) { PyErr_Clear(); PyErr_Format(PyExc_TypeError, "expected sequence of strings or tuple pairs of strings, not %.200s", Py_TYPE(item)->tp_name); PyC_Err_PrintWithFunc(py_func); return false; } } StringPropertySearchVisitParams visit_params = {NULL}; visit_params.text = text; visit_params.info = info; visit_fn(visit_user_data, &visit_params); return true; } static void bpy_prop_string_visit_for_search_fn(const struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop, const char *edit_text, StringPropertySearchVisitFunc visit_fn, void *visit_user_data) { struct BPyPropStore *prop_store = RNA_property_py_data_get(prop); PyObject *py_func; PyObject *args; PyObject *self; PyObject *ret; PyGILState_STATE gilstate; PyObject *py_edit_text; BLI_assert(prop_store != NULL); if (C) { bpy_context_set((struct bContext *)C, &gilstate); } else { gilstate = PyGILState_Ensure(); } py_func = prop_store->py_data.string_data.search_fn; args = PyTuple_New(3); self = pyrna_struct_as_instance(ptr); PyTuple_SET_ITEM(args, 0, self); Py_INCREF(bpy_context_module); PyTuple_SET_ITEM(args, 1, (PyObject *)bpy_context_module); py_edit_text = PyUnicode_FromString(edit_text); PyTuple_SET_ITEM(args, 2, py_edit_text); ret = PyObject_CallObject(py_func, args); Py_DECREF(args); if (ret == NULL) { PyC_Err_PrintWithFunc(py_func); } else { if (PyIter_Check(ret)) { /* Iterators / generator types. */ PyObject *it; PyObject *(*iternext)(PyObject *); it = PyObject_GetIter(ret); if (it == NULL) { PyC_Err_PrintWithFunc(py_func); } else { iternext = *Py_TYPE(it)->tp_iternext; for (;;) { PyObject *py_text = iternext(it); if (py_text == NULL) { break; } const bool ok = bpy_prop_string_visit_fn_call( py_func, py_text, visit_fn, visit_user_data); Py_DECREF(py_text); if (!ok) { break; } } Py_DECREF(it); if (PyErr_Occurred()) { if (PyErr_ExceptionMatches(PyExc_StopIteration)) { PyErr_Clear(); } else { PyC_Err_PrintWithFunc(py_func); } } } } else { /* Sequence (typically list/tuple). */ PyObject *ret_fast = PySequence_Fast( ret, "StringProperty(...): " "return value from search callback was not a sequence, iterator or generator"); if (ret_fast == NULL) { PyC_Err_PrintWithFunc(py_func); } else { const Py_ssize_t ret_num = PySequence_Fast_GET_SIZE(ret_fast); PyObject **ret_fast_items = PySequence_Fast_ITEMS(ret_fast); for (Py_ssize_t i = 0; i < ret_num; i++) { const bool ok = bpy_prop_string_visit_fn_call( py_func, ret_fast_items[i], visit_fn, visit_user_data); if (!ok) { break; } } Py_DECREF(ret_fast); } } Py_DECREF(ret); } if (C) { bpy_context_clear((struct bContext *)C, &gilstate); } else { PyGILState_Release(gilstate); } } /** \} */ /* -------------------------------------------------------------------- */ /** \name Pointer Property Callbacks * \{ */ static bool bpy_prop_pointer_poll_fn(struct PointerRNA *self, PointerRNA candidate, struct PropertyRNA *prop) { struct BPyPropStore *prop_store = RNA_property_py_data_get(prop); PyObject *py_self; PyObject *py_candidate; PyObject *py_func; PyObject *args; PyObject *ret; bool result; const int is_write_ok = pyrna_write_check(); const PyGILState_STATE gilstate = PyGILState_Ensure(); BLI_assert(self != NULL); py_self = pyrna_struct_as_instance(self); py_candidate = pyrna_struct_as_instance(&candidate); py_func = prop_store->py_data.pointer_data.poll_fn; if (!is_write_ok) { pyrna_write_set(true); } args = PyTuple_New(2); PyTuple_SET_ITEM(args, 0, py_self); PyTuple_SET_ITEM(args, 1, py_candidate); ret = PyObject_CallObject(py_func, args); Py_DECREF(args); if (ret == NULL) { PyC_Err_PrintWithFunc(py_func); result = false; } else { result = PyObject_IsTrue(ret); Py_DECREF(ret); } PyGILState_Release(gilstate); if (!is_write_ok) { pyrna_write_set(false); } return result; } /** \} */ /* -------------------------------------------------------------------- */ /** \name Enum Property Callbacks * \{ */ static int bpy_prop_enum_get_fn(struct PointerRNA *ptr, struct PropertyRNA *prop) { struct BPyPropStore *prop_store = RNA_property_py_data_get(prop); PyObject *py_func; PyObject *args; PyObject *self; PyObject *ret; PyGILState_STATE gilstate; bool use_gil; const bool is_write_ok = pyrna_write_check(); int value; BLI_assert(prop_store != NULL); if (!is_write_ok) { pyrna_write_set(true); } use_gil = true; /* !PyC_IsInterpreterActive(); */ if (use_gil) { gilstate = PyGILState_Ensure(); } py_func = prop_store->py_data.get_fn; args = PyTuple_New(1); self = pyrna_struct_as_instance(ptr); PyTuple_SET_ITEM(args, 0, self); ret = PyObject_CallObject(py_func, args); Py_DECREF(args); if (ret == NULL) { PyC_Err_PrintWithFunc(py_func); value = RNA_property_enum_get_default(ptr, prop); } else { value = PyC_Long_AsI32(ret); if (value == -1 && PyErr_Occurred()) { PyC_Err_PrintWithFunc(py_func); value = RNA_property_enum_get_default(ptr, prop); } Py_DECREF(ret); } if (use_gil) { PyGILState_Release(gilstate); } if (!is_write_ok) { pyrna_write_set(false); } return value; } static void bpy_prop_enum_set_fn(struct PointerRNA *ptr, struct PropertyRNA *prop, int value) { struct BPyPropStore *prop_store = RNA_property_py_data_get(prop); PyObject *py_func; PyObject *args; PyObject *self; PyObject *ret; PyGILState_STATE gilstate; bool use_gil; const bool is_write_ok = pyrna_write_check(); BLI_assert(prop_store != NULL); if (!is_write_ok) { pyrna_write_set(true); } use_gil = true; /* !PyC_IsInterpreterActive(); */ if (use_gil) { gilstate = PyGILState_Ensure(); } py_func = prop_store->py_data.set_fn; args = PyTuple_New(2); self = pyrna_struct_as_instance(ptr); PyTuple_SET_ITEM(args, 0, self); PyTuple_SET_ITEM(args, 1, PyLong_FromLong(value)); ret = PyObject_CallObject(py_func, args); Py_DECREF(args); if (ret == NULL) { PyC_Err_PrintWithFunc(py_func); } else { if (ret != Py_None) { PyErr_SetString(PyExc_ValueError, "the return value must be None"); PyC_Err_PrintWithFunc(py_func); } Py_DECREF(ret); } if (use_gil) { PyGILState_Release(gilstate); } if (!is_write_ok) { pyrna_write_set(false); } } /* utility function we need for parsing int's in an if statement */ static bool py_long_as_int(PyObject *py_long, int *r_int) { if (PyLong_CheckExact(py_long)) { *r_int = (int)PyLong_AS_LONG(py_long); return true; } return false; } #ifdef USE_ENUM_COPY_STRINGS /* copies orig to buf, then sets orig to buf, returns copy length */ static size_t strswapbufcpy(char *buf, const char **orig) { const char *src = *orig; char *dst = buf; size_t i = 0; *orig = buf; while ((*dst = *src)) { dst++; src++; i++; } return i + 1; /* include '\0' */ } #endif static int icon_id_from_name(const char *name) { const EnumPropertyItem *item; int id; if (name[0]) { for (item = rna_enum_icon_items, id = 0; item->identifier; item++, id++) { if (STREQ(item->name, name)) { return item->value; } } } return 0; } static const EnumPropertyItem *enum_items_from_py(PyObject *seq_fast, const bool is_enum_flag, PyObject *default_py, int *r_default_value) { EnumPropertyItem *items; PyObject *item; const Py_ssize_t seq_len = PySequence_Fast_GET_SIZE(seq_fast); PyObject **seq_fast_items = PySequence_Fast_ITEMS(seq_fast); int i; #ifdef USE_ENUM_COPY_STRINGS Py_ssize_t totbuf = 0; #endif short default_used = 0; const char *default_str_cmp = NULL; int default_int_cmp = 0; if (is_enum_flag) { if (seq_len > RNA_ENUM_BITFLAG_SIZE) { PyErr_SetString(PyExc_TypeError, "EnumProperty(...): maximum " STRINGIFY( RNA_ENUM_BITFLAG_SIZE) " members for a ENUM_FLAG type property"); return NULL; } if (default_py && !PySet_Check(default_py)) { PyErr_Format(PyExc_TypeError, "EnumProperty(...): default option must be a 'set' " "type when ENUM_FLAG is enabled, not a '%.200s'", Py_TYPE(default_py)->tp_name); return NULL; } } else { if (default_py) { if (!py_long_as_int(default_py, &default_int_cmp)) { default_str_cmp = PyUnicode_AsUTF8(default_py); if (default_str_cmp == NULL) { PyErr_Format(PyExc_TypeError, "EnumProperty(...): default option must be a 'str' or 'int' " "type when ENUM_FLAG is disabled, not a '%.200s'", Py_TYPE(default_py)->tp_name); return NULL; } } } } /* blank value */ *r_default_value = 0; items = MEM_callocN(sizeof(EnumPropertyItem) * (seq_len + 1), "enum_items_from_py1"); for (i = 0; i < seq_len; i++) { EnumPropertyItem tmp = {0, "", 0, "", ""}; const char *tmp_icon = NULL; Py_ssize_t item_size; Py_ssize_t id_str_size; Py_ssize_t name_str_size; Py_ssize_t desc_str_size; item = seq_fast_items[i]; if (PyTuple_CheckExact(item) && (item_size = PyTuple_GET_SIZE(item)) && (item_size >= 3 && item_size <= 5) && (tmp.identifier = PyUnicode_AsUTF8AndSize(PyTuple_GET_ITEM(item, 0), &id_str_size)) && (tmp.name = PyUnicode_AsUTF8AndSize(PyTuple_GET_ITEM(item, 1), &name_str_size)) && (tmp.description = PyUnicode_AsUTF8AndSize(PyTuple_GET_ITEM(item, 2), &desc_str_size)) && /* TODO: number isn't ensured to be unique from the script author. */ (item_size != 4 || py_long_as_int(PyTuple_GET_ITEM(item, 3), &tmp.value)) && (item_size != 5 || ((py_long_as_int(PyTuple_GET_ITEM(item, 3), &tmp.icon) || (tmp_icon = PyUnicode_AsUTF8(PyTuple_GET_ITEM(item, 3)))) && py_long_as_int(PyTuple_GET_ITEM(item, 4), &tmp.value)))) { if (is_enum_flag) { if (item_size < 4) { tmp.value = 1 << i; } if (default_py && PySet_Contains(default_py, PyTuple_GET_ITEM(item, 0))) { *r_default_value |= tmp.value; default_used++; } } else { if (item_size < 4) { tmp.value = i; } if (default_py && default_used == 0) { if ((default_str_cmp != NULL && STREQ(default_str_cmp, tmp.identifier)) || (default_str_cmp == NULL && default_int_cmp == tmp.value)) { *r_default_value = tmp.value; default_used++; /* only ever 1 */ } } } if (tmp_icon) { tmp.icon = icon_id_from_name(tmp_icon); } items[i] = tmp; #ifdef USE_ENUM_COPY_STRINGS /* Calculate combine string length. */ totbuf += id_str_size + name_str_size + desc_str_size + 3; /* 3 is for '\0's */ #endif } else if (item == Py_None) { /* Only set since the rest is cleared. */ items[i].identifier = ""; } else { MEM_freeN(items); PyErr_SetString(PyExc_TypeError, "EnumProperty(...): expected a tuple containing " "(identifier, name, description) and optionally an " "icon name and unique number"); return NULL; } } if (is_enum_flag) { /* strict check that all set members were used */ if (default_py && default_used != PySet_GET_SIZE(default_py)) { MEM_freeN(items); PyErr_Format(PyExc_TypeError, "EnumProperty(..., default={...}): set has %d unused member(s)", PySet_GET_SIZE(default_py) - default_used); return NULL; } } else { if (default_py && default_used == 0) { MEM_freeN(items); if (default_str_cmp) { PyErr_Format(PyExc_TypeError, "EnumProperty(..., default=\'%s\'): not found in enum members", default_str_cmp); } else { PyErr_Format(PyExc_TypeError, "EnumProperty(..., default=%d): not found in enum members", default_int_cmp); } return NULL; } } #ifdef USE_ENUM_COPY_STRINGS /* This would all work perfectly _but_ the python strings may be freed immediately after use, * so we need to duplicate them, ugh. annoying because it works most of the time without this. */ { EnumPropertyItem *items_dup = MEM_mallocN((sizeof(EnumPropertyItem) * (seq_len + 1)) + (sizeof(char) * totbuf), "enum_items_from_py2"); EnumPropertyItem *items_ptr = items_dup; char *buf = ((char *)items_dup) + (sizeof(EnumPropertyItem) * (seq_len + 1)); memcpy(items_dup, items, sizeof(EnumPropertyItem) * (seq_len + 1)); for (i = 0; i < seq_len; i++, items_ptr++) { buf += strswapbufcpy(buf, &items_ptr->identifier); buf += strswapbufcpy(buf, &items_ptr->name); buf += strswapbufcpy(buf, &items_ptr->description); } MEM_freeN(items); items = items_dup; } /* end string duplication */ #endif return items; } static const EnumPropertyItem *bpy_prop_enum_itemf_fn(struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, bool *r_free) { PyGILState_STATE gilstate; struct BPyPropStore *prop_store = RNA_property_py_data_get(prop); PyObject *py_func = prop_store->py_data.enum_data.itemf_fn; PyObject *self = NULL; PyObject *args; PyObject *items; /* returned from the function call */ const EnumPropertyItem *eitems = NULL; int err = 0; if (C) { bpy_context_set(C, &gilstate); } else { gilstate = PyGILState_Ensure(); } args = PyTuple_New(2); self = pyrna_struct_as_instance(ptr); PyTuple_SET_ITEM(args, 0, self); /* now get the context */ if (C) { PyTuple_SET_ITEM(args, 1, (PyObject *)bpy_context_module); Py_INCREF(bpy_context_module); } else { PyTuple_SET_ITEM(args, 1, Py_None); Py_INCREF(Py_None); } items = PyObject_CallObject(py_func, args); Py_DECREF(args); if (items == NULL) { err = -1; } else { PyObject *items_fast; int default_value_dummy = 0; if (!(items_fast = PySequence_Fast(items, "EnumProperty(...): " "return value from the callback was not a sequence"))) { err = -1; } else { eitems = enum_items_from_py( items_fast, (RNA_property_flag(prop) & PROP_ENUM_FLAG) != 0, NULL, &default_value_dummy); Py_DECREF(items_fast); if (!eitems) { err = -1; } } Py_DECREF(items); } if (err != -1) { /* worked */ *r_free = true; } else { PyC_Err_PrintWithFunc(py_func); eitems = DummyRNA_NULL_items; } if (C) { bpy_context_clear(C, &gilstate); } else { PyGILState_Release(gilstate); } return eitems; } static int bpy_prop_callback_check(PyObject *py_func, const char *keyword, int argcount) { if (py_func && py_func != Py_None) { if (!PyFunction_Check(py_func)) { PyErr_Format(PyExc_TypeError, "%s keyword: expected a function type, not a %.200s", keyword, Py_TYPE(py_func)->tp_name); return -1; } PyCodeObject *f_code = (PyCodeObject *)PyFunction_GET_CODE(py_func); if (f_code->co_argcount != argcount) { PyErr_Format(PyExc_TypeError, "%s keyword: expected a function taking %d arguments, not %d", keyword, argcount, f_code->co_argcount); return -1; } } return 0; } /** \} */ /* -------------------------------------------------------------------- */ /** \name Shared Callback Assignment * \{ */ static void bpy_prop_callback_assign_update(struct PropertyRNA *prop, PyObject *update_fn) { /* assume this is already checked for type and arg length */ if (update_fn && update_fn != Py_None) { struct BPyPropStore *prop_store = bpy_prop_py_data_ensure(prop); RNA_def_property_update_runtime(prop, bpy_prop_update_fn); ASSIGN_PYOBJECT_INCREF(prop_store->py_data.update_fn, update_fn); RNA_def_property_flag(prop, PROP_CONTEXT_PROPERTY_UPDATE); } } static void bpy_prop_callback_assign_pointer(struct PropertyRNA *prop, PyObject *poll_fn) { if (poll_fn && poll_fn != Py_None) { struct BPyPropStore *prop_store = bpy_prop_py_data_ensure(prop); RNA_def_property_poll_runtime(prop, bpy_prop_pointer_poll_fn); ASSIGN_PYOBJECT_INCREF(prop_store->py_data.pointer_data.poll_fn, poll_fn); } } static void bpy_prop_callback_assign_boolean(struct PropertyRNA *prop, PyObject *get_fn, PyObject *set_fn) { BooleanPropertyGetFunc rna_get_fn = NULL; BooleanPropertySetFunc rna_set_fn = NULL; if (get_fn && get_fn != Py_None) { struct BPyPropStore *prop_store = bpy_prop_py_data_ensure(prop); rna_get_fn = bpy_prop_boolean_get_fn; ASSIGN_PYOBJECT_INCREF(prop_store->py_data.get_fn, get_fn); } if (set_fn && set_fn != Py_None) { struct BPyPropStore *prop_store = bpy_prop_py_data_ensure(prop); rna_set_fn = bpy_prop_boolean_set_fn; ASSIGN_PYOBJECT_INCREF(prop_store->py_data.set_fn, set_fn); } RNA_def_property_boolean_funcs_runtime(prop, rna_get_fn, rna_set_fn); } static void bpy_prop_callback_assign_boolean_array(struct PropertyRNA *prop, PyObject *get_fn, PyObject *set_fn) { BooleanArrayPropertyGetFunc rna_get_fn = NULL; BooleanArrayPropertySetFunc rna_set_fn = NULL; if (get_fn && get_fn != Py_None) { struct BPyPropStore *prop_store = bpy_prop_py_data_ensure(prop); rna_get_fn = bpy_prop_boolean_array_get_fn; ASSIGN_PYOBJECT_INCREF(prop_store->py_data.get_fn, get_fn); } if (set_fn && set_fn != Py_None) { struct BPyPropStore *prop_store = bpy_prop_py_data_ensure(prop); rna_set_fn = bpy_prop_boolean_array_set_fn; ASSIGN_PYOBJECT_INCREF(prop_store->py_data.set_fn, set_fn); } RNA_def_property_boolean_array_funcs_runtime(prop, rna_get_fn, rna_set_fn); } static void bpy_prop_callback_assign_int(struct PropertyRNA *prop, PyObject *get_fn, PyObject *set_fn) { IntPropertyGetFunc rna_get_fn = NULL; IntPropertySetFunc rna_set_fn = NULL; if (get_fn && get_fn != Py_None) { struct BPyPropStore *prop_store = bpy_prop_py_data_ensure(prop); rna_get_fn = bpy_prop_int_get_fn; ASSIGN_PYOBJECT_INCREF(prop_store->py_data.get_fn, get_fn); } if (set_fn && set_fn != Py_None) { struct BPyPropStore *prop_store = bpy_prop_py_data_ensure(prop); rna_set_fn = bpy_prop_int_set_fn; ASSIGN_PYOBJECT_INCREF(prop_store->py_data.set_fn, set_fn); } RNA_def_property_int_funcs_runtime(prop, rna_get_fn, rna_set_fn, NULL); } static void bpy_prop_callback_assign_int_array(struct PropertyRNA *prop, PyObject *get_fn, PyObject *set_fn) { IntArrayPropertyGetFunc rna_get_fn = NULL; IntArrayPropertySetFunc rna_set_fn = NULL; if (get_fn && get_fn != Py_None) { struct BPyPropStore *prop_store = bpy_prop_py_data_ensure(prop); rna_get_fn = bpy_prop_int_array_get_fn; ASSIGN_PYOBJECT_INCREF(prop_store->py_data.get_fn, get_fn); } if (set_fn && set_fn != Py_None) { struct BPyPropStore *prop_store = bpy_prop_py_data_ensure(prop); rna_set_fn = bpy_prop_int_array_set_fn; ASSIGN_PYOBJECT_INCREF(prop_store->py_data.set_fn, set_fn); } RNA_def_property_int_array_funcs_runtime(prop, rna_get_fn, rna_set_fn, NULL); } static void bpy_prop_callback_assign_float(struct PropertyRNA *prop, PyObject *get_fn, PyObject *set_fn) { FloatPropertyGetFunc rna_get_fn = NULL; FloatPropertySetFunc rna_set_fn = NULL; if (get_fn && get_fn != Py_None) { struct BPyPropStore *prop_store = bpy_prop_py_data_ensure(prop); rna_get_fn = bpy_prop_float_get_fn; ASSIGN_PYOBJECT_INCREF(prop_store->py_data.get_fn, get_fn); } if (set_fn && set_fn != Py_None) { struct BPyPropStore *prop_store = bpy_prop_py_data_ensure(prop); rna_set_fn = bpy_prop_float_set_fn; ASSIGN_PYOBJECT_INCREF(prop_store->py_data.set_fn, set_fn); } RNA_def_property_float_funcs_runtime(prop, rna_get_fn, rna_set_fn, NULL); } static void bpy_prop_callback_assign_float_array(struct PropertyRNA *prop, PyObject *get_fn, PyObject *set_fn) { FloatArrayPropertyGetFunc rna_get_fn = NULL; FloatArrayPropertySetFunc rna_set_fn = NULL; if (get_fn && get_fn != Py_None) { struct BPyPropStore *prop_store = bpy_prop_py_data_ensure(prop); rna_get_fn = bpy_prop_float_array_get_fn; ASSIGN_PYOBJECT_INCREF(prop_store->py_data.get_fn, get_fn); } if (set_fn && set_fn != Py_None) { struct BPyPropStore *prop_store = bpy_prop_py_data_ensure(prop); rna_set_fn = bpy_prop_float_array_set_fn; ASSIGN_PYOBJECT_INCREF(prop_store->py_data.set_fn, set_fn); } RNA_def_property_float_array_funcs_runtime(prop, rna_get_fn, rna_set_fn, NULL); } static void bpy_prop_callback_assign_string(struct PropertyRNA *prop, PyObject *get_fn, PyObject *set_fn, PyObject *search_fn, const eStringPropertySearchFlag search_flag) { StringPropertyGetFunc rna_get_fn = NULL; StringPropertyLengthFunc rna_length_fn = NULL; StringPropertySetFunc rna_set_fn = NULL; StringPropertySearchFunc rna_search_fn = NULL; if (get_fn && get_fn != Py_None) { struct BPyPropStore *prop_store = bpy_prop_py_data_ensure(prop); rna_get_fn = bpy_prop_string_get_fn; rna_length_fn = bpy_prop_string_length_fn; ASSIGN_PYOBJECT_INCREF(prop_store->py_data.get_fn, get_fn); } if (set_fn && set_fn != Py_None) { struct BPyPropStore *prop_store = bpy_prop_py_data_ensure(prop); rna_set_fn = bpy_prop_string_set_fn; ASSIGN_PYOBJECT_INCREF(prop_store->py_data.set_fn, set_fn); } if (search_fn) { struct BPyPropStore *prop_store = bpy_prop_py_data_ensure(prop); rna_search_fn = bpy_prop_string_visit_for_search_fn; ASSIGN_PYOBJECT_INCREF(prop_store->py_data.string_data.search_fn, search_fn); } RNA_def_property_string_funcs_runtime(prop, rna_get_fn, rna_length_fn, rna_set_fn); if (rna_search_fn) { RNA_def_property_string_search_func_runtime(prop, rna_search_fn, search_flag); } } static void bpy_prop_callback_assign_enum(struct PropertyRNA *prop, PyObject *get_fn, PyObject *set_fn, PyObject *itemf_fn) { EnumPropertyGetFunc rna_get_fn = NULL; EnumPropertyItemFunc rna_itemf_fn = NULL; EnumPropertySetFunc rna_set_fn = NULL; if (get_fn && get_fn != Py_None) { struct BPyPropStore *prop_store = bpy_prop_py_data_ensure(prop); rna_get_fn = bpy_prop_enum_get_fn; ASSIGN_PYOBJECT_INCREF(prop_store->py_data.get_fn, get_fn); } if (set_fn && set_fn != Py_None) { struct BPyPropStore *prop_store = bpy_prop_py_data_ensure(prop); rna_set_fn = bpy_prop_enum_set_fn; ASSIGN_PYOBJECT_INCREF(prop_store->py_data.set_fn, set_fn); } if (itemf_fn && itemf_fn != Py_None) { struct BPyPropStore *prop_store = bpy_prop_py_data_ensure(prop); rna_itemf_fn = bpy_prop_enum_itemf_fn; ASSIGN_PYOBJECT_INCREF(prop_store->py_data.enum_data.itemf_fn, itemf_fn); } RNA_def_property_enum_funcs_runtime(prop, rna_get_fn, rna_set_fn, rna_itemf_fn); } /** \} */ /* -------------------------------------------------------------------- */ /** \name Shared Method Utilities * \{ */ /** * This define runs at the start of each function and deals with * returning a deferred property #BPy_PropDeferred (to be registered later). * * \param self: The self argument from the caller. * \param args: The positional arguments of the caller. * \param kw: The keyword arguments of the caller. * \param method_object: The method of the caller (unfortunately this can't be deduced). * \param r_deferred_result: The deferred result (or NULL in the case of an error). * The caller must return this value unless a valid `srna` is returned. * * \returns When not null, the caller is expected to perform the registration. */ static StructRNA *bpy_prop_deferred_data_or_srna(PyObject *self, PyObject *args, PyObject *kw, PyObject *method_object, PyObject **r_deferred_result) { /* This must be the methods of one of the main property types defined in this file. */ BLI_assert(PyCFunction_CheckExact(method_object)); const int args_len = PyTuple_GET_SIZE(args); PyMethodDef *method_def = ((PyCFunctionObject *)method_object)->m_ml; /* Call this function with the first argument set to `self`. */ if (args_len == 1) { self = PyTuple_GET_ITEM(args, 0); args = PyTuple_New(0); /* This will be #BPy_BoolProperty` or one of the functions that define a type. */ PyCFunctionWithKeywords method_fn = (PyCFunctionWithKeywords)method_def->ml_meth; *r_deferred_result = method_fn(self, args, kw); Py_DECREF(args); /* May be an error (depending on `r_deferred_result`). */ return NULL; } const char *error_prefix = method_def->ml_name; if (args_len > 1) { PyErr_Format(PyExc_ValueError, "%s: all args must be keywords", error_prefix); *r_deferred_result = NULL; /* An error. */ return NULL; } StructRNA *srna = srna_from_self(self, error_prefix); if (srna == NULL) { *r_deferred_result = PyErr_Occurred() ? NULL : bpy_prop_deferred_data_CreatePyObject(method_object, kw); /* May be an error (depending on `r_deferred_result`). */ return NULL; } /* Crash if this is ever used by accident! */ #ifndef NDEBUG *r_deferred_result = (PyObject *)(intptr_t)1; #endif /* No error or deferred result, perform registration immediately. */ return srna; } struct BPy_PropIDParse { const char *value; StructRNA *srna; /** * In the case registering this properly replaces an existing dynamic property. * Store a handle to the property for removal. * This is needed so the property removal is deferred until all other arguments * have been validated, otherwise failure elsewhere could leave the property un-registered. */ void *prop_free_handle; }; /** * Use with #PyArg_ParseTuple's `O&` formatting. */ static int bpy_prop_arg_parse_id(PyObject *o, void *p) { struct BPy_PropIDParse *parse_data = p; StructRNA *srna = parse_data->srna; if (!PyUnicode_Check(o)) { PyErr_Format(PyExc_TypeError, "expected a string (got %.200s)", Py_TYPE(o)->tp_name); return 0; } Py_ssize_t id_len; const char *id; id = PyUnicode_AsUTF8AndSize(o, &id_len); if (UNLIKELY(id_len >= MAX_IDPROP_NAME)) { PyErr_Format(PyExc_TypeError, "'%.200s' too long, max length is %d", id, MAX_IDPROP_NAME - 1); return 0; } parse_data->prop_free_handle = NULL; if (UNLIKELY(RNA_def_property_free_identifier_deferred_prepare( srna, id, &parse_data->prop_free_handle) == -1)) { PyErr_Format(PyExc_TypeError, "'%s' is defined as a non-dynamic type for '%s'", id, RNA_struct_identifier(srna)); return 0; } parse_data->value = id; return 1; } /** * Needed so #RNA_struct_property_tag_defines can be called on the `srna`. */ struct BPy_EnumProperty_Parse_WithSRNA { struct BPy_EnumProperty_Parse base; StructRNA *srna; }; /** * Wrapper for #pyrna_enum_bitfield_parse_set * that looks up tags from the `srna`. */ static int bpy_prop_arg_parse_tag_defines(PyObject *o, void *p) { struct BPy_EnumProperty_Parse_WithSRNA *parse_data = p; parse_data->base.items = RNA_struct_property_tag_defines(parse_data->srna); if (parse_data->base.items == NULL) { PyErr_Format(PyExc_TypeError, "property-tags not available for '%s'", RNA_struct_identifier(parse_data->srna)); return 0; } return pyrna_enum_bitfield_parse_set(o, &parse_data->base); } /** \} */ /* -------------------------------------------------------------------- */ /** \name Shared Method Doc-Strings * \{ */ #define BPY_PROPDEF_NAME_DOC \ " :arg name: Name used in the user interface.\n" \ " :type name: string\n" #define BPY_PROPDEF_DESC_DOC \ " :arg description: Text used for the tooltip and api documentation.\n" \ " :type description: string\n" #define BPY_PROPDEF_UNIT_DOC \ " :arg unit: Enumerator in :ref:`rna_enum_property_unit_items`.\n" \ " :type unit: string\n" #define BPY_PROPDEF_NUM_MIN_DOC \ " :arg min: Hard minimum, trying to assign a value below will silently assign this minimum " \ "instead.\n" #define BPY_PROPDEF_NUM_MAX_DOC \ " :arg max: Hard maximum, trying to assign a value above will silently assign this maximum " \ "instead.\n" #define BPY_PROPDEF_NUM_SOFTMIN_DOC \ " :arg soft_min: Soft minimum (>= *min*), user won't be able to drag the widget below this " \ "value in the UI.\n" #define BPY_PROPDEF_NUM_SOFTMAX_DOC \ " :arg soft_max: Soft maximum (<= *max*), user won't be able to drag the widget above this " \ "value in the UI.\n" #define BPY_PROPDEF_VECSIZE_DOC \ " :arg size: Vector dimensions in [1, " STRINGIFY(PYRNA_STACK_ARRAY) "]. " \ "An int sequence can be used to define multi-dimension arrays.\n" \ " :type size: int or int sequence\n" #define BPY_PROPDEF_INT_STEP_DOC \ " :arg step: Step of increment/decrement in UI, in [1, 100], defaults to 1 (WARNING: unused " \ "currently!).\n" \ " :type step: int\n" #define BPY_PROPDEF_FLOAT_STEP_DOC \ " :arg step: Step of increment/decrement in UI, in [1, 100], defaults to 3 (WARNING: actual " \ "value is /100).\n" \ " :type step: int\n" #define BPY_PROPDEF_FLOAT_PREC_DOC \ " :arg precision: Maximum number of decimal digits to display, in [0, 6]. Fraction is " \ "automatically hidden for exact integer values of fields with unit 'NONE' or 'TIME' (frame " \ "count) and step divisible by 100.\n" \ " :type precision: int\n" #define BPY_PROPDEF_UPDATE_DOC \ " :arg update: Function to be called when this value is modified,\n" \ " This function must take 2 values (self, context) and return None.\n" \ " *Warning* there are no safety checks to avoid infinite recursion.\n" \ " :type update: function\n" #define BPY_PROPDEF_POLL_DOC \ " :arg poll: function to be called to determine whether an item is valid for this " \ "property.\n" \ " The function must take 2 values (self, object) and return Bool.\n" \ " :type poll: function\n" #define BPY_PROPDEF_GET_DOC \ " :arg get: Function to be called when this value is 'read',\n" \ " This function must take 1 value (self) and return the value of the property.\n" \ " :type get: function\n" #define BPY_PROPDEF_SET_DOC \ " :arg set: Function to be called when this value is 'written',\n" \ " This function must take 2 values (self, value) and return None.\n" \ " :type set: function\n" #define BPY_PROPDEF_SEARCH_DOC \ " :arg search: Function to be called to show candidates for this string (shown in the UI).\n" \ " This function must take 3 values (self, context, edit_text)\n" \ " and return a sequence, iterator or generator where each item must be:\n" \ "\n" \ " - A single string (representing a candidate to display).\n" \ " - A tuple-pair of strings, where the first is a candidate and the second\n" \ " is additional information about the candidate.\n" \ " :type search: function\n" \ " :arg search_options: Set of strings in:\n" \ "\n" \ " - 'SORT' sorts the resulting items.\n" \ " - 'SUGGESTION' lets the user enter values not found in search candidates.\n" \ " **WARNING** disabling this flag causes the search callback to run on redraw,\n" \ " so only disable this flag if it's not likely to cause performance issues.\n" \ "\n" \ " :type search_options: set\n" #define BPY_PROPDEF_POINTER_TYPE_DOC \ " :arg type: A subclass of :class:`bpy.types.PropertyGroup` or :class:`bpy.types.ID`.\n" \ " :type type: class\n" #define BPY_PROPDEF_COLLECTION_TYPE_DOC \ " :arg type: A subclass of :class:`bpy.types.PropertyGroup`.\n" \ " :type type: class\n" #define BPY_PROPDEF_TAGS_DOC \ " :arg tags: Enumerator of tags that are defined by parent class.\n" \ " :type tags: set\n" #if 0 static int bpy_struct_id_used(StructRNA *srna, char *identifier) { PointerRNA ptr; RNA_pointer_create(NULL, srna, NULL, &ptr); return (RNA_struct_find_property(&ptr, identifier) != NULL); } #endif /** \} */ /* -------------------------------------------------------------------- */ /** \name Module Methods * * Functions that register RNA. * * \note The `self` argument is NULL when called from Python, * but being abused from C so we can pass the `srna` along. * This isn't incorrect since its a Python object - but be careful. * * \{ */ PyDoc_STRVAR(BPy_BoolProperty_doc, ".. function:: BoolProperty(name=\"\", " "description=\"\", " "default=False, " "options={'ANIMATABLE'}, " "override=set(), " "tags=set(), " "subtype='NONE', " "update=None, " "get=None, " "set=None)\n" "\n" " Returns a new boolean property definition.\n" "\n" BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC BPY_PROPDEF_OPTIONS_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_DOC BPY_PROPDEF_TAGS_DOC BPY_PROPDEF_SUBTYPE_NUMBER_DOC BPY_PROPDEF_UPDATE_DOC BPY_PROPDEF_GET_DOC BPY_PROPDEF_SET_DOC); static PyObject *BPy_BoolProperty(PyObject *self, PyObject *args, PyObject *kw) { StructRNA *srna; { /* Keep this block first. */ PyObject *deferred_result; srna = bpy_prop_deferred_data_or_srna(self, args, kw, pymeth_BoolProperty, &deferred_result); if (srna == NULL) { return deferred_result; } } struct BPy_PropIDParse id_data = { .srna = srna, }; const char *name = NULL, *description = ""; bool default_value = false; PropertyRNA *prop; struct BPy_EnumProperty_Parse options_enum = { .items = rna_enum_property_flag_items, .value = 0, }; struct BPy_EnumProperty_Parse override_enum = { .items = rna_enum_property_override_flag_items, .value = 0, }; struct BPy_EnumProperty_Parse_WithSRNA tags_enum = { .srna = srna, }; struct BPy_EnumProperty_Parse subtype_enum = { .items = rna_enum_property_subtype_number_items, .value = PROP_NONE, }; PyObject *update_fn = NULL; PyObject *get_fn = NULL; PyObject *set_fn = NULL; static const char *_keywords[] = { "attr", "name", "description", "default", "options", "override", "tags", "subtype", "update", "get", "set", NULL, }; static _PyArg_Parser _parser = { "O&" /* `attr` */ "|$" /* Optional, keyword only arguments. */ "s" /* `name` */ "s" /* `description` */ "O&" /* `default` */ "O&" /* `options` */ "O&" /* `override` */ "O&" /* `tags` */ "O&" /* `subtype` */ "O" /* `update` */ "O" /* `get` */ "O" /* `set` */ ":BoolProperty", _keywords, 0, }; if (!_PyArg_ParseTupleAndKeywordsFast(args, kw, &_parser, bpy_prop_arg_parse_id, &id_data, &name, &description, PyC_ParseBool, &default_value, pyrna_enum_bitfield_parse_set, &options_enum, pyrna_enum_bitfield_parse_set, &override_enum, bpy_prop_arg_parse_tag_defines, &tags_enum, pyrna_enum_value_parse_string, &subtype_enum, &update_fn, &get_fn, &set_fn)) { return NULL; } if (bpy_prop_callback_check(update_fn, "update", 2) == -1) { return NULL; } if (bpy_prop_callback_check(get_fn, "get", 1) == -1) { return NULL; } if (bpy_prop_callback_check(set_fn, "set", 2) == -1) { return NULL; } if (id_data.prop_free_handle != NULL) { RNA_def_property_free_identifier_deferred_finish(srna, id_data.prop_free_handle); } prop = RNA_def_property(srna, id_data.value, PROP_BOOLEAN, subtype_enum.value); RNA_def_property_boolean_default(prop, default_value); RNA_def_property_ui_text(prop, name ? name : id_data.value, description); if (tags_enum.base.is_set) { RNA_def_property_tags(prop, tags_enum.base.value); } if (options_enum.is_set) { bpy_prop_assign_flag(prop, options_enum.value); } if (override_enum.is_set) { bpy_prop_assign_flag_override(prop, override_enum.value); } bpy_prop_callback_assign_update(prop, update_fn); bpy_prop_callback_assign_boolean(prop, get_fn, set_fn); RNA_def_property_duplicate_pointers(srna, prop); Py_RETURN_NONE; } PyDoc_STRVAR( BPy_BoolVectorProperty_doc, ".. function:: BoolVectorProperty(name=\"\", " "description=\"\", " "default=(False, False, False), " "options={'ANIMATABLE'}, " "override=set(), " "tags=set(), " "subtype='NONE', " "size=3, " "update=None, " "get=None, " "set=None)\n" "\n" " Returns a new vector boolean property definition.\n" "\n" BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC " :arg default: sequence of booleans the length of *size*.\n" " :type default: sequence\n" BPY_PROPDEF_OPTIONS_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_DOC BPY_PROPDEF_TAGS_DOC BPY_PROPDEF_SUBTYPE_NUMBER_ARRAY_DOC BPY_PROPDEF_VECSIZE_DOC BPY_PROPDEF_UPDATE_DOC BPY_PROPDEF_GET_DOC BPY_PROPDEF_SET_DOC); static PyObject *BPy_BoolVectorProperty(PyObject *self, PyObject *args, PyObject *kw) { StructRNA *srna; { /* Keep this block first. */ PyObject *deferred_result; srna = bpy_prop_deferred_data_or_srna( self, args, kw, pymeth_BoolVectorProperty, &deferred_result); if (srna == NULL) { return deferred_result; } } struct BPy_PropIDParse id_data = { .srna = srna, }; const char *name = NULL, *description = ""; bool default_value[RNA_MAX_ARRAY_DIMENSION][PYRNA_STACK_ARRAY] = {{false}}; struct BPyPropArrayLength array_len_info = {.len_total = 3}; PropertyRNA *prop; PyObject *default_py = NULL; struct BPy_EnumProperty_Parse options_enum = { .items = rna_enum_property_flag_items, .value = 0, }; struct BPy_EnumProperty_Parse override_enum = { .items = rna_enum_property_override_flag_items, .value = 0, }; struct BPy_EnumProperty_Parse_WithSRNA tags_enum = { .srna = srna, }; struct BPy_EnumProperty_Parse subtype_enum = { .items = rna_enum_property_subtype_number_array_items, .value = PROP_NONE, }; PyObject *update_fn = NULL; PyObject *get_fn = NULL; PyObject *set_fn = NULL; static const char *_keywords[] = { "attr", "name", "description", "default", "options", "override", "tags", "subtype", "size", "update", "get", "set", NULL, }; static _PyArg_Parser _parser = { "O&" /* `attr` */ "|$" /* Optional, keyword only arguments. */ "s" /* `name` */ "s" /* `description` */ "O" /* `default` */ "O&" /* `options` */ "O&" /* `override` */ "O&" /* `tags` */ "O&" /* `subtype` */ "O&" /* `size` */ "O" /* `update` */ "O" /* `get` */ "O" /* `set` */ ":BoolVectorProperty", _keywords, 0, }; if (!_PyArg_ParseTupleAndKeywordsFast(args, kw, &_parser, bpy_prop_arg_parse_id, &id_data, &name, &description, &default_py, pyrna_enum_bitfield_parse_set, &options_enum, pyrna_enum_bitfield_parse_set, &override_enum, bpy_prop_arg_parse_tag_defines, &tags_enum, pyrna_enum_value_parse_string, &subtype_enum, bpy_prop_array_length_parse, &array_len_info, &update_fn, &get_fn, &set_fn)) { return NULL; } if (default_py != NULL) { if (bpy_prop_array_from_py_with_dims(default_value[0], sizeof(*default_value[0]), default_py, &array_len_info, &PyBool_Type, "BoolVectorProperty(default=sequence)") == -1) { return NULL; } } if (bpy_prop_callback_check(update_fn, "update", 2) == -1) { return NULL; } if (bpy_prop_callback_check(get_fn, "get", 1) == -1) { return NULL; } if (bpy_prop_callback_check(set_fn, "set", 2) == -1) { return NULL; } if (id_data.prop_free_handle != NULL) { RNA_def_property_free_identifier_deferred_finish(srna, id_data.prop_free_handle); } prop = RNA_def_property(srna, id_data.value, PROP_BOOLEAN, subtype_enum.value); if (array_len_info.dims_len == 0) { RNA_def_property_array(prop, array_len_info.len_total); if (default_py != NULL) { RNA_def_property_boolean_array_default(prop, default_value[0]); } } else { RNA_def_property_multi_array(prop, array_len_info.dims_len, array_len_info.dims); if (default_py != NULL) { RNA_def_property_boolean_array_default(prop, &default_value[0][0]); } } RNA_def_property_ui_text(prop, name ? name : id_data.value, description); if (tags_enum.base.is_set) { RNA_def_property_tags(prop, tags_enum.base.value); } if (options_enum.is_set) { bpy_prop_assign_flag(prop, options_enum.value); } if (override_enum.is_set) { bpy_prop_assign_flag_override(prop, override_enum.value); } bpy_prop_callback_assign_update(prop, update_fn); bpy_prop_callback_assign_boolean_array(prop, get_fn, set_fn); RNA_def_property_duplicate_pointers(srna, prop); Py_RETURN_NONE; } PyDoc_STRVAR( BPy_IntProperty_doc, ".. function:: IntProperty(name=\"\", " "description=\"\", " "default=0, " "min=-2**31, max=2**31-1, " "soft_min=-2**31, soft_max=2**31-1, " "step=1, " "options={'ANIMATABLE'}, " "override=set(), " "tags=set(), " "subtype='NONE', " "update=None, " "get=None, " "set=None)\n" "\n" " Returns a new int property definition.\n" "\n" BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC BPY_PROPDEF_NUM_MIN_DOC " :type min: int\n" BPY_PROPDEF_NUM_MAX_DOC " :type max: int\n" BPY_PROPDEF_NUM_SOFTMAX_DOC " :type soft_min: int\n" BPY_PROPDEF_NUM_SOFTMIN_DOC " :type soft_max: int\n" BPY_PROPDEF_INT_STEP_DOC BPY_PROPDEF_OPTIONS_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_DOC BPY_PROPDEF_TAGS_DOC BPY_PROPDEF_SUBTYPE_NUMBER_DOC BPY_PROPDEF_UPDATE_DOC BPY_PROPDEF_GET_DOC BPY_PROPDEF_SET_DOC); static PyObject *BPy_IntProperty(PyObject *self, PyObject *args, PyObject *kw) { StructRNA *srna; { /* Keep this block first. */ PyObject *deferred_result; srna = bpy_prop_deferred_data_or_srna(self, args, kw, pymeth_IntProperty, &deferred_result); if (srna == NULL) { return deferred_result; } } struct BPy_PropIDParse id_data = { .srna = srna, }; const char *name = NULL, *description = ""; int min = INT_MIN, max = INT_MAX, soft_min = INT_MIN, soft_max = INT_MAX; int step = 1; int default_value = 0; PropertyRNA *prop; struct BPy_EnumProperty_Parse options_enum = { .items = rna_enum_property_flag_items, .value = 0, }; struct BPy_EnumProperty_Parse override_enum = { .items = rna_enum_property_override_flag_items, .value = 0, }; struct BPy_EnumProperty_Parse_WithSRNA tags_enum = { .srna = srna, }; struct BPy_EnumProperty_Parse subtype_enum = { .items = rna_enum_property_subtype_number_items, .value = PROP_NONE, }; PyObject *update_fn = NULL; PyObject *get_fn = NULL; PyObject *set_fn = NULL; static const char *_keywords[] = { "attr", "name", "description", "default", "min", "max", "soft_min", "soft_max", "step", "options", "override", "tags", "subtype", "update", "get", "set", NULL, }; static _PyArg_Parser _parser = { "O&" /* `attr` */ "|$" /* Optional, keyword only arguments. */ "s" /* `name` */ "s" /* `description` */ "i" /* `default` */ "i" /* `min` */ "i" /* `max` */ "i" /* `soft_min` */ "i" /* `soft_max` */ "i" /* `step` */ "O&" /* `options` */ "O&" /* `override` */ "O&" /* `tags` */ "O&" /* `subtype` */ "O" /* `update` */ "O" /* `get` */ "O" /* `set` */ ":IntProperty", _keywords, 0, }; if (!_PyArg_ParseTupleAndKeywordsFast(args, kw, &_parser, bpy_prop_arg_parse_id, &id_data, &name, &description, &default_value, &min, &max, &soft_min, &soft_max, &step, pyrna_enum_bitfield_parse_set, &options_enum, pyrna_enum_bitfield_parse_set, &override_enum, bpy_prop_arg_parse_tag_defines, &tags_enum, pyrna_enum_value_parse_string, &subtype_enum, &update_fn, &get_fn, &set_fn)) { return NULL; } if (bpy_prop_callback_check(update_fn, "update", 2) == -1) { return NULL; } if (bpy_prop_callback_check(get_fn, "get", 1) == -1) { return NULL; } if (bpy_prop_callback_check(set_fn, "set", 2) == -1) { return NULL; } if (id_data.prop_free_handle != NULL) { RNA_def_property_free_identifier_deferred_finish(srna, id_data.prop_free_handle); } prop = RNA_def_property(srna, id_data.value, PROP_INT, subtype_enum.value); RNA_def_property_int_default(prop, default_value); RNA_def_property_ui_text(prop, name ? name : id_data.value, description); RNA_def_property_range(prop, min, max); RNA_def_property_ui_range(prop, MAX2(soft_min, min), MIN2(soft_max, max), step, 3); if (tags_enum.base.is_set) { RNA_def_property_tags(prop, tags_enum.base.value); } if (options_enum.is_set) { bpy_prop_assign_flag(prop, options_enum.value); } if (override_enum.is_set) { bpy_prop_assign_flag_override(prop, override_enum.value); } bpy_prop_callback_assign_update(prop, update_fn); bpy_prop_callback_assign_int(prop, get_fn, set_fn); RNA_def_property_duplicate_pointers(srna, prop); Py_RETURN_NONE; } PyDoc_STRVAR(BPy_IntVectorProperty_doc, ".. function:: IntVectorProperty(name=\"\", " "description=\"\", " "default=(0, 0, 0), min=-2**31, max=2**31-1, " "soft_min=-2**31, " "soft_max=2**31-1, " "step=1, " "options={'ANIMATABLE'}, " "override=set(), " "tags=set(), " "subtype='NONE', " "size=3, " "update=None, " "get=None, " "set=None)\n" "\n" " Returns a new vector int property definition.\n" "\n" BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC " :arg default: sequence of ints the length of *size*.\n" " :type default: sequence\n" BPY_PROPDEF_NUM_MIN_DOC " :type min: int\n" BPY_PROPDEF_NUM_MAX_DOC " :type max: int\n" BPY_PROPDEF_NUM_SOFTMIN_DOC " :type soft_min: int\n" BPY_PROPDEF_NUM_SOFTMAX_DOC " :type soft_max: int\n" BPY_PROPDEF_INT_STEP_DOC BPY_PROPDEF_OPTIONS_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_DOC BPY_PROPDEF_TAGS_DOC BPY_PROPDEF_SUBTYPE_NUMBER_ARRAY_DOC BPY_PROPDEF_VECSIZE_DOC BPY_PROPDEF_UPDATE_DOC BPY_PROPDEF_GET_DOC BPY_PROPDEF_SET_DOC); static PyObject *BPy_IntVectorProperty(PyObject *self, PyObject *args, PyObject *kw) { StructRNA *srna; { /* Keep this block first. */ PyObject *deferred_result; srna = bpy_prop_deferred_data_or_srna( self, args, kw, pymeth_IntVectorProperty, &deferred_result); if (srna == NULL) { return deferred_result; } } struct BPy_PropIDParse id_data = { .srna = srna, }; const char *name = NULL, *description = ""; int min = INT_MIN, max = INT_MAX, soft_min = INT_MIN, soft_max = INT_MAX; int step = 1; int default_value[RNA_MAX_ARRAY_DIMENSION][PYRNA_STACK_ARRAY] = {0}; struct BPyPropArrayLength array_len_info = {.len_total = 3}; PropertyRNA *prop; PyObject *default_py = NULL; struct BPy_EnumProperty_Parse options_enum = { .items = rna_enum_property_flag_items, .value = 0, }; struct BPy_EnumProperty_Parse override_enum = { .items = rna_enum_property_override_flag_items, .value = 0, }; struct BPy_EnumProperty_Parse_WithSRNA tags_enum = { .srna = srna, }; struct BPy_EnumProperty_Parse subtype_enum = { .items = rna_enum_property_subtype_number_array_items, .value = PROP_NONE, }; PyObject *update_fn = NULL; PyObject *get_fn = NULL; PyObject *set_fn = NULL; static const char *_keywords[] = { "attr", "name", "description", "default", "min", "max", "soft_min", "soft_max", "step", "options", "override", "tags", "subtype", "size", "update", "get", "set", NULL, }; static _PyArg_Parser _parser = { "O&" /* `attr` */ "|$" /* Optional, keyword only arguments. */ "s" /* `name` */ "s" /* `description` */ "O" /* `default` */ "i" /* `min` */ "i" /* `max` */ "i" /* `soft_min` */ "i" /* `soft_max` */ "i" /* `step` */ "O&" /* `options` */ "O&" /* `override` */ "O&" /* `tags` */ "O&" /* `subtype` */ "O&" /* `size` */ "O" /* `update` */ "O" /* `get` */ "O" /* `set` */ ":IntVectorProperty", _keywords, 0, }; if (!_PyArg_ParseTupleAndKeywordsFast(args, kw, &_parser, bpy_prop_arg_parse_id, &id_data, &name, &description, &default_py, &min, &max, &soft_min, &soft_max, &step, pyrna_enum_bitfield_parse_set, &options_enum, pyrna_enum_bitfield_parse_set, &override_enum, bpy_prop_arg_parse_tag_defines, &tags_enum, pyrna_enum_value_parse_string, &subtype_enum, bpy_prop_array_length_parse, &array_len_info, &update_fn, &get_fn, &set_fn)) { return NULL; } if (default_py != NULL) { if (bpy_prop_array_from_py_with_dims(default_value[0], sizeof(*default_value[0]), default_py, &array_len_info, &PyLong_Type, "IntVectorProperty(default=sequence)") == -1) { return NULL; } } if (bpy_prop_callback_check(update_fn, "update", 2) == -1) { return NULL; } if (bpy_prop_callback_check(get_fn, "get", 1) == -1) { return NULL; } if (bpy_prop_callback_check(set_fn, "set", 2) == -1) { return NULL; } if (id_data.prop_free_handle != NULL) { RNA_def_property_free_identifier_deferred_finish(srna, id_data.prop_free_handle); } prop = RNA_def_property(srna, id_data.value, PROP_INT, subtype_enum.value); if (array_len_info.dims_len == 0) { RNA_def_property_array(prop, array_len_info.len_total); if (default_py != NULL) { RNA_def_property_int_array_default(prop, default_value[0]); } } else { RNA_def_property_multi_array(prop, array_len_info.dims_len, array_len_info.dims); if (default_py != NULL) { RNA_def_property_int_array_default(prop, &default_value[0][0]); } } RNA_def_property_range(prop, min, max); RNA_def_property_ui_text(prop, name ? name : id_data.value, description); RNA_def_property_ui_range(prop, MAX2(soft_min, min), MIN2(soft_max, max), step, 3); if (tags_enum.base.is_set) { RNA_def_property_tags(prop, tags_enum.base.value); } if (options_enum.is_set) { bpy_prop_assign_flag(prop, options_enum.value); } if (override_enum.is_set) { bpy_prop_assign_flag_override(prop, override_enum.value); } bpy_prop_callback_assign_update(prop, update_fn); bpy_prop_callback_assign_int_array(prop, get_fn, set_fn); RNA_def_property_duplicate_pointers(srna, prop); Py_RETURN_NONE; } PyDoc_STRVAR(BPy_FloatProperty_doc, ".. function:: FloatProperty(name=\"\", " "description=\"\", " "default=0.0, " "min=-3.402823e+38, max=3.402823e+38, " "soft_min=-3.402823e+38, soft_max=3.402823e+38, " "step=3, " "precision=2, " "options={'ANIMATABLE'}, " "override=set(), " "tags=set(), " "subtype='NONE', " "unit='NONE', " "update=None, " "get=None, " "set=None)\n" "\n" " Returns a new float (single precision) property definition.\n" "\n" BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC BPY_PROPDEF_NUM_MIN_DOC " :type min: float\n" BPY_PROPDEF_NUM_MAX_DOC " :type max: float\n" BPY_PROPDEF_NUM_SOFTMIN_DOC " :type soft_min: float\n" BPY_PROPDEF_NUM_SOFTMAX_DOC " :type soft_max: float\n" BPY_PROPDEF_FLOAT_STEP_DOC BPY_PROPDEF_FLOAT_PREC_DOC BPY_PROPDEF_OPTIONS_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_DOC BPY_PROPDEF_TAGS_DOC BPY_PROPDEF_SUBTYPE_NUMBER_DOC BPY_PROPDEF_UNIT_DOC BPY_PROPDEF_UPDATE_DOC BPY_PROPDEF_GET_DOC BPY_PROPDEF_SET_DOC); static PyObject *BPy_FloatProperty(PyObject *self, PyObject *args, PyObject *kw) { StructRNA *srna; { /* Keep this block first. */ PyObject *deferred_result; srna = bpy_prop_deferred_data_or_srna(self, args, kw, pymeth_FloatProperty, &deferred_result); if (srna == NULL) { return deferred_result; } } struct BPy_PropIDParse id_data = { .srna = srna, }; const char *name = NULL, *description = ""; float min = -FLT_MAX, max = FLT_MAX, soft_min = -FLT_MAX, soft_max = FLT_MAX; float step = 3; float default_value = 0.0f; int precision = 2; PropertyRNA *prop; struct BPy_EnumProperty_Parse options_enum = { .items = rna_enum_property_flag_items, .value = 0, }; struct BPy_EnumProperty_Parse override_enum = { .items = rna_enum_property_override_flag_items, .value = 0, }; struct BPy_EnumProperty_Parse_WithSRNA tags_enum = { .srna = srna, }; struct BPy_EnumProperty_Parse subtype_enum = { .items = rna_enum_property_subtype_number_items, .value = PROP_NONE, }; struct BPy_EnumProperty_Parse unit_enum = { .items = rna_enum_property_unit_items, .value = PROP_UNIT_NONE, }; PyObject *update_fn = NULL; PyObject *get_fn = NULL; PyObject *set_fn = NULL; static const char *_keywords[] = { "attr", "name", "description", "default", "min", "max", "soft_min", "soft_max", "step", "precision", "options", "override", "tags", "subtype", "unit", "update", "get", "set", NULL, }; static _PyArg_Parser _parser = { "O&" /* `attr` */ "|$" /* Optional, keyword only arguments. */ "s" /* `name` */ "s" /* `description` */ "f" /* `default` */ "f" /* `min` */ "f" /* `max` */ "f" /* `soft_min` */ "f" /* `soft_max` */ "f" /* `step` */ "i" /* `precision` */ "O&" /* `options` */ "O&" /* `override` */ "O&" /* `tags` */ "O&" /* `subtype` */ "O&" /* `unit` */ "O" /* `update` */ "O" /* `get` */ "O" /* `set` */ ":FloatProperty", _keywords, 0, }; if (!_PyArg_ParseTupleAndKeywordsFast(args, kw, &_parser, bpy_prop_arg_parse_id, &id_data, &name, &description, &default_value, &min, &max, &soft_min, &soft_max, &step, &precision, pyrna_enum_bitfield_parse_set, &options_enum, pyrna_enum_bitfield_parse_set, &override_enum, bpy_prop_arg_parse_tag_defines, &tags_enum, pyrna_enum_value_parse_string, &subtype_enum, pyrna_enum_value_parse_string, &unit_enum, &update_fn, &get_fn, &set_fn)) { return NULL; } if (bpy_prop_callback_check(update_fn, "update", 2) == -1) { return NULL; } if (bpy_prop_callback_check(get_fn, "get", 1) == -1) { return NULL; } if (bpy_prop_callback_check(set_fn, "set", 2) == -1) { return NULL; } if (id_data.prop_free_handle != NULL) { RNA_def_property_free_identifier_deferred_finish(srna, id_data.prop_free_handle); } prop = RNA_def_property(srna, id_data.value, PROP_FLOAT, subtype_enum.value | unit_enum.value); RNA_def_property_float_default(prop, default_value); RNA_def_property_range(prop, min, max); RNA_def_property_ui_text(prop, name ? name : id_data.value, description); RNA_def_property_ui_range(prop, MAX2(soft_min, min), MIN2(soft_max, max), step, precision); if (tags_enum.base.is_set) { RNA_def_property_tags(prop, tags_enum.base.value); } if (options_enum.is_set) { bpy_prop_assign_flag(prop, options_enum.value); } if (override_enum.is_set) { bpy_prop_assign_flag_override(prop, override_enum.value); } bpy_prop_callback_assign_update(prop, update_fn); bpy_prop_callback_assign_float(prop, get_fn, set_fn); RNA_def_property_duplicate_pointers(srna, prop); Py_RETURN_NONE; } PyDoc_STRVAR(BPy_FloatVectorProperty_doc, ".. function:: FloatVectorProperty(name=\"\", " "description=\"\", " "default=(0.0, 0.0, 0.0), " "min=sys.float_info.min, max=sys.float_info.max, " "soft_min=sys.float_info.min, soft_max=sys.float_info.max, " "step=3, " "precision=2, " "options={'ANIMATABLE'}, " "override=set(), " "tags=set(), " "subtype='NONE', " "unit='NONE', " "size=3, " "update=None, " "get=None, " "set=None)\n" "\n" " Returns a new vector float property definition.\n" "\n" BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC " :arg default: sequence of floats the length of *size*.\n" " :type default: sequence\n" BPY_PROPDEF_NUM_MIN_DOC " :type min: float\n" BPY_PROPDEF_NUM_MAX_DOC " :type max: float\n" BPY_PROPDEF_NUM_SOFTMIN_DOC " :type soft_min: float\n" BPY_PROPDEF_NUM_SOFTMAX_DOC " :type soft_max: float\n" BPY_PROPDEF_OPTIONS_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_DOC BPY_PROPDEF_TAGS_DOC BPY_PROPDEF_FLOAT_STEP_DOC BPY_PROPDEF_FLOAT_PREC_DOC BPY_PROPDEF_SUBTYPE_NUMBER_ARRAY_DOC BPY_PROPDEF_UNIT_DOC BPY_PROPDEF_VECSIZE_DOC BPY_PROPDEF_UPDATE_DOC BPY_PROPDEF_GET_DOC BPY_PROPDEF_SET_DOC); static PyObject *BPy_FloatVectorProperty(PyObject *self, PyObject *args, PyObject *kw) { StructRNA *srna; { /* Keep this block first. */ PyObject *deferred_result; srna = bpy_prop_deferred_data_or_srna( self, args, kw, pymeth_FloatVectorProperty, &deferred_result); if (srna == NULL) { return deferred_result; } } struct BPy_PropIDParse id_data = { .srna = srna, }; const char *name = NULL, *description = ""; float min = -FLT_MAX, max = FLT_MAX, soft_min = -FLT_MAX, soft_max = FLT_MAX; float step = 3; float default_value[RNA_MAX_ARRAY_DIMENSION][PYRNA_STACK_ARRAY] = {{0.0f}}; int precision = 2; struct BPyPropArrayLength array_len_info = {.len_total = 3}; PropertyRNA *prop; PyObject *default_py = NULL; struct BPy_EnumProperty_Parse options_enum = { .items = rna_enum_property_flag_items, .value = 0, }; struct BPy_EnumProperty_Parse override_enum = { .items = rna_enum_property_override_flag_items, .value = 0, }; struct BPy_EnumProperty_Parse_WithSRNA tags_enum = { .srna = srna, }; struct BPy_EnumProperty_Parse subtype_enum = { .items = rna_enum_property_subtype_number_array_items, .value = PROP_NONE, }; struct BPy_EnumProperty_Parse unit_enum = { .items = rna_enum_property_unit_items, .value = PROP_UNIT_NONE, }; PyObject *update_fn = NULL; PyObject *get_fn = NULL; PyObject *set_fn = NULL; static const char *_keywords[] = { "attr", "name", "description", "default", "min", "max", "soft_min", "soft_max", "step", "precision", "options", "override", "tags", "subtype", "unit", "size", "update", "get", "set", NULL, }; static _PyArg_Parser _parser = { "O&" /* `attr` */ "|$" /* Optional, keyword only arguments. */ "s" /* `name` */ "s" /* `description` */ "O" /* `default` */ "f" /* `min` */ "f" /* `max` */ "f" /* `soft_min` */ "f" /* `soft_max` */ "f" /* `step` */ "i" /* `precision` */ "O&" /* `options` */ "O&" /* `override` */ "O&" /* `tags` */ "O&" /* `subtype` */ "O&" /* `unit` */ "O&" /* `size` */ "O" /* `update` */ "O" /* `get` */ "O" /* `set` */ ":FloatVectorProperty", _keywords, 0, }; if (!_PyArg_ParseTupleAndKeywordsFast(args, kw, &_parser, bpy_prop_arg_parse_id, &id_data, &name, &description, &default_py, &min, &max, &soft_min, &soft_max, &step, &precision, pyrna_enum_bitfield_parse_set, &options_enum, pyrna_enum_bitfield_parse_set, &override_enum, bpy_prop_arg_parse_tag_defines, &tags_enum, pyrna_enum_value_parse_string, &subtype_enum, pyrna_enum_value_parse_string, &unit_enum, bpy_prop_array_length_parse, &array_len_info, &update_fn, &get_fn, &set_fn)) { return NULL; } if (default_py != NULL) { if (bpy_prop_array_from_py_with_dims(default_value[0], sizeof(*default_value[0]), default_py, &array_len_info, &PyFloat_Type, "FloatVectorProperty(default=sequence)") == -1) { return NULL; } if (bpy_prop_array_is_matrix_compatible_ex(subtype_enum.value, &array_len_info)) { bpy_prop_array_matrix_swap_row_column_vn(&default_value[0][0], &array_len_info); } } if (bpy_prop_callback_check(update_fn, "update", 2) == -1) { return NULL; } if (bpy_prop_callback_check(get_fn, "get", 1) == -1) { return NULL; } if (bpy_prop_callback_check(set_fn, "set", 2) == -1) { return NULL; } if (id_data.prop_free_handle != NULL) { RNA_def_property_free_identifier_deferred_finish(srna, id_data.prop_free_handle); } prop = RNA_def_property(srna, id_data.value, PROP_FLOAT, subtype_enum.value | unit_enum.value); if (array_len_info.dims_len == 0) { RNA_def_property_array(prop, array_len_info.len_total); if (default_py != NULL) { RNA_def_property_float_array_default(prop, default_value[0]); } } else { RNA_def_property_multi_array(prop, array_len_info.dims_len, array_len_info.dims); if (default_py != NULL) { RNA_def_property_float_array_default(prop, &default_value[0][0]); } } RNA_def_property_range(prop, min, max); RNA_def_property_ui_text(prop, name ? name : id_data.value, description); RNA_def_property_ui_range(prop, MAX2(soft_min, min), MIN2(soft_max, max), step, precision); if (tags_enum.base.is_set) { RNA_def_property_tags(prop, tags_enum.base.value); } if (options_enum.is_set) { bpy_prop_assign_flag(prop, options_enum.value); } if (override_enum.is_set) { bpy_prop_assign_flag_override(prop, override_enum.value); } bpy_prop_callback_assign_update(prop, update_fn); bpy_prop_callback_assign_float_array(prop, get_fn, set_fn); RNA_def_property_duplicate_pointers(srna, prop); Py_RETURN_NONE; } PyDoc_STRVAR(BPy_StringProperty_doc, ".. function:: StringProperty(name=\"\", " "description=\"\", " "default=\"\", " "maxlen=0, " "options={'ANIMATABLE'}, " "override=set(), " "tags=set(), " "subtype='NONE', " "update=None, " "get=None, " "set=None, " "search=None, " "search_options={'SUGGESTION'})\n" "\n" " Returns a new string property definition.\n" "\n" BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC " :arg default: initializer string.\n" " :type default: string\n" " :arg maxlen: maximum length of the string.\n" " :type maxlen: int\n" BPY_PROPDEF_OPTIONS_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_DOC BPY_PROPDEF_TAGS_DOC BPY_PROPDEF_SUBTYPE_STRING_DOC BPY_PROPDEF_UPDATE_DOC BPY_PROPDEF_GET_DOC BPY_PROPDEF_SET_DOC BPY_PROPDEF_SEARCH_DOC); static PyObject *BPy_StringProperty(PyObject *self, PyObject *args, PyObject *kw) { StructRNA *srna; { /* Keep this block first. */ PyObject *deferred_result; srna = bpy_prop_deferred_data_or_srna(self, args, kw, pymeth_StringProperty, &deferred_result); if (srna == NULL) { return deferred_result; } } struct BPy_PropIDParse id_data = { .srna = srna, }; const char *name = NULL, *description = "", *default_value = ""; int maxlen = 0; PropertyRNA *prop; struct BPy_EnumProperty_Parse options_enum = { .items = rna_enum_property_flag_items, .value = 0, }; struct BPy_EnumProperty_Parse override_enum = { .items = rna_enum_property_override_flag_items, .value = 0, }; struct BPy_EnumProperty_Parse_WithSRNA tags_enum = { .srna = srna, }; struct BPy_EnumProperty_Parse subtype_enum = { .items = rna_enum_property_subtype_string_items, .value = PROP_NONE, }; PyObject *update_fn = NULL; PyObject *get_fn = NULL; PyObject *set_fn = NULL; PyObject *search_fn = NULL; static struct BPy_EnumProperty_Parse search_options_enum = { .items = rna_enum_property_string_search_flag_items, .value = PROP_STRING_SEARCH_SUGGESTION, }; static const char *_keywords[] = { "attr", "name", "description", "default", "maxlen", "options", "override", "tags", "subtype", "update", "get", "set", "search", "search_options", NULL, }; static _PyArg_Parser _parser = { "O&" /* `attr` */ "|$" /* Optional, keyword only arguments. */ "s" /* `name` */ "s" /* `description` */ "s" /* `default` */ "i" /* `maxlen` */ "O&" /* `options` */ "O&" /* `override` */ "O&" /* `tags` */ "O&" /* `subtype` */ "O" /* `update` */ "O" /* `get` */ "O" /* `set` */ "O" /* `search` */ "O&" /* `search_options` */ ":StringProperty", _keywords, 0, }; if (!_PyArg_ParseTupleAndKeywordsFast(args, kw, &_parser, bpy_prop_arg_parse_id, &id_data, &name, &description, &default_value, &maxlen, pyrna_enum_bitfield_parse_set, &options_enum, pyrna_enum_bitfield_parse_set, &override_enum, bpy_prop_arg_parse_tag_defines, &tags_enum, pyrna_enum_value_parse_string, &subtype_enum, &update_fn, &get_fn, &set_fn, &search_fn, pyrna_enum_bitfield_parse_set, &search_options_enum)) { return NULL; } if (bpy_prop_callback_check(update_fn, "update", 2) == -1) { return NULL; } if (bpy_prop_callback_check(get_fn, "get", 1) == -1) { return NULL; } if (bpy_prop_callback_check(set_fn, "set", 2) == -1) { return NULL; } if (bpy_prop_callback_check(search_fn, "search", 3) == -1) { return NULL; } if (id_data.prop_free_handle != NULL) { RNA_def_property_free_identifier_deferred_finish(srna, id_data.prop_free_handle); } prop = RNA_def_property(srna, id_data.value, PROP_STRING, subtype_enum.value); if (maxlen != 0) { /* +1 since it includes null terminator. */ RNA_def_property_string_maxlength(prop, maxlen + 1); } if (default_value && default_value[0]) { RNA_def_property_string_default(prop, default_value); } RNA_def_property_ui_text(prop, name ? name : id_data.value, description); if (tags_enum.base.is_set) { RNA_def_property_tags(prop, tags_enum.base.value); } if (options_enum.is_set) { bpy_prop_assign_flag(prop, options_enum.value); } if (override_enum.is_set) { bpy_prop_assign_flag_override(prop, override_enum.value); } bpy_prop_callback_assign_update(prop, update_fn); bpy_prop_callback_assign_string(prop, get_fn, set_fn, search_fn, search_options_enum.value); RNA_def_property_duplicate_pointers(srna, prop); Py_RETURN_NONE; } PyDoc_STRVAR( BPy_EnumProperty_doc, ".. function:: EnumProperty(items, " "name=\"\", " "description=\"\", " "default=None, " "options={'ANIMATABLE'}, " "override=set(), " "tags=set(), " "update=None, " "get=None, " "set=None)\n" "\n" " Returns a new enumerator property definition.\n" "\n" " :arg items: sequence of enum items formatted:\n" " ``[(identifier, name, description, icon, number), ...]``.\n" "\n" " The first three elements of the tuples are mandatory.\n" "\n" " :identifier: The identifier is used for Python access.\n" " :name: Name for the interface.\n" " :description: Used for documentation and tooltips.\n" " :icon: An icon string identifier or integer icon value\n" " (e.g. returned by :class:`bpy.types.UILayout.icon`)\n" " :number: Unique value used as the identifier for this item (stored in file data).\n" " Use when the identifier may need to change. If the *ENUM_FLAG* option is used,\n" " the values are bit-masks and should be powers of two.\n" "\n" " When an item only contains 4 items they define ``(identifier, name, description, " "number)``.\n" "\n" " Separators may be added using None instead of a tuple." "\n" " For dynamic values a callback can be passed which returns a list in\n" " the same format as the static list.\n" " This function must take 2 arguments ``(self, context)``, **context may be None**.\n" "\n" " .. warning::\n" "\n" " There is a known bug with using a callback,\n" " Python must keep a reference to the strings returned by the callback or Blender\n" " will misbehave or even crash." "\n" " :type items: sequence of string tuples or a function\n" BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC " :arg default: The default value for this enum, a string from the identifiers used in " "*items*, or integer matching an item number.\n" " If the *ENUM_FLAG* option is used this must be a set of such string identifiers " "instead.\n" " WARNING: Strings can not be specified for dynamic enums\n" " (i.e. if a callback function is given as *items* parameter).\n" " :type default: string, integer or set\n" BPY_PROPDEF_OPTIONS_ENUM_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_DOC BPY_PROPDEF_TAGS_DOC BPY_PROPDEF_UPDATE_DOC BPY_PROPDEF_GET_DOC BPY_PROPDEF_SET_DOC); static PyObject *BPy_EnumProperty(PyObject *self, PyObject *args, PyObject *kw) { StructRNA *srna; { /* Keep this block first. */ PyObject *deferred_result; srna = bpy_prop_deferred_data_or_srna(self, args, kw, pymeth_EnumProperty, &deferred_result); if (srna == NULL) { return deferred_result; } } struct BPy_PropIDParse id_data = { .srna = srna, }; const char *name = NULL, *description = ""; PyObject *default_py = NULL; int default_value = 0; PyObject *items, *items_fast; const EnumPropertyItem *eitems; PropertyRNA *prop; struct BPy_EnumProperty_Parse options_enum = { .items = rna_enum_property_flag_enum_items, .value = 0, }; struct BPy_EnumProperty_Parse override_enum = { .items = rna_enum_property_override_flag_items, .value = 0, }; struct BPy_EnumProperty_Parse_WithSRNA tags_enum = { .srna = srna, }; bool is_itemf = false; PyObject *update_fn = NULL; PyObject *get_fn = NULL; PyObject *set_fn = NULL; static const char *_keywords[] = { "attr", "items", "name", "description", "default", "options", "override", "tags", "update", "get", "set", NULL, }; static _PyArg_Parser _parser = { "O&" /* `attr` */ "O" /* `items` */ "|$" /* Optional, keyword only arguments. */ "s" /* `name` */ "s" /* `description` */ "O" /* `default` */ "O&" /* `options` */ "O&" /* `override` */ "O&" /* `tags` */ "O" /* `update` */ "O" /* `get` */ "O" /* `set` */ ":EnumProperty", _keywords, 0, }; if (!_PyArg_ParseTupleAndKeywordsFast(args, kw, &_parser, bpy_prop_arg_parse_id, &id_data, &items, &name, &description, &default_py, pyrna_enum_bitfield_parse_set, &options_enum, pyrna_enum_bitfield_parse_set, &override_enum, bpy_prop_arg_parse_tag_defines, &tags_enum, &update_fn, &get_fn, &set_fn)) { return NULL; } if (bpy_prop_callback_check(update_fn, "update", 2) == -1) { return NULL; } if (bpy_prop_callback_check(get_fn, "get", 1) == -1) { return NULL; } if (bpy_prop_callback_check(set_fn, "set", 2) == -1) { return NULL; } if (default_py == Py_None) { /* This allows to get same behavior when explicitly passing None as default value, * and not defining a default value at all! */ default_py = NULL; } /* items can be a list or a callable */ if (PyFunction_Check( items)) { /* don't use PyCallable_Check because we need the function code for errors */ PyCodeObject *f_code = (PyCodeObject *)PyFunction_GET_CODE(items); if (f_code->co_argcount != 2) { PyErr_Format(PyExc_ValueError, "EnumProperty(...): expected 'items' function to take 2 arguments, not %d", f_code->co_argcount); return NULL; } if (default_py) { /* Only support getting integer default values here. */ if (!py_long_as_int(default_py, &default_value)) { /* NOTE: using type error here is odd but python does this for invalid arguments. */ PyErr_SetString( PyExc_TypeError, "EnumProperty(...): 'default' can only be an integer when 'items' is a function"); return NULL; } } is_itemf = true; eitems = DummyRNA_NULL_items; } else { if (!(items_fast = PySequence_Fast( items, "EnumProperty(...): " "expected a sequence of tuples for the enum items or a function"))) { return NULL; } eitems = enum_items_from_py( items_fast, (options_enum.value & PROP_ENUM_FLAG) != 0, default_py, &default_value); if (!eitems) { Py_DECREF(items_fast); return NULL; } } if (id_data.prop_free_handle != NULL) { RNA_def_property_free_identifier_deferred_finish(srna, id_data.prop_free_handle); } if (options_enum.value & PROP_ENUM_FLAG) { prop = RNA_def_enum_flag( srna, id_data.value, eitems, default_value, name ? name : id_data.value, description); } else { prop = RNA_def_enum( srna, id_data.value, eitems, default_value, name ? name : id_data.value, description); } if (tags_enum.base.is_set) { RNA_def_property_tags(prop, tags_enum.base.value); } if (options_enum.is_set) { bpy_prop_assign_flag(prop, options_enum.value); } if (override_enum.is_set) { bpy_prop_assign_flag_override(prop, override_enum.value); } bpy_prop_callback_assign_update(prop, update_fn); bpy_prop_callback_assign_enum(prop, get_fn, set_fn, (is_itemf ? items : NULL)); RNA_def_property_duplicate_pointers(srna, prop); if (is_itemf == false) { /* NOTE: this must be postponed until after #RNA_def_property_duplicate_pointers * otherwise if this is a generator it may free the strings before we copy them */ Py_DECREF(items_fast); MEM_freeN((void *)eitems); } Py_RETURN_NONE; } StructRNA *pointer_type_from_py(PyObject *value, const char *error_prefix) { StructRNA *srna; srna = srna_from_self(value, ""); if (!srna) { if (PyErr_Occurred()) { PyObject *msg = PyC_ExceptionBuffer(); const char *msg_char = PyUnicode_AsUTF8(msg); PyErr_Clear(); PyErr_Format( PyExc_TypeError, "%.200s expected an RNA type, failed with: %s", error_prefix, msg_char); Py_DECREF(msg); } else { PyErr_Format(PyExc_TypeError, "%.200s expected an RNA type, failed with type '%s'", error_prefix, Py_TYPE(value)->tp_name); } return NULL; } return srna; } PyDoc_STRVAR(BPy_PointerProperty_doc, ".. function:: PointerProperty(type=None, " "name=\"\", " "description=\"\", " "options={'ANIMATABLE'}, " "override=set(), " "tags=set(), " "poll=None, " "update=None)\n" "\n" " Returns a new pointer property definition.\n" "\n" BPY_PROPDEF_POINTER_TYPE_DOC BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC BPY_PROPDEF_OPTIONS_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_DOC BPY_PROPDEF_TAGS_DOC BPY_PROPDEF_POLL_DOC BPY_PROPDEF_UPDATE_DOC); PyObject *BPy_PointerProperty(PyObject *self, PyObject *args, PyObject *kw) { StructRNA *srna; { /* Keep this block first. */ PyObject *deferred_result; srna = bpy_prop_deferred_data_or_srna( self, args, kw, pymeth_PointerProperty, &deferred_result); if (srna == NULL) { return deferred_result; } } struct BPy_PropIDParse id_data = { .srna = srna, }; const char *name = NULL, *description = ""; PropertyRNA *prop; StructRNA *ptype; PyObject *type = Py_None; struct BPy_EnumProperty_Parse options_enum = { .items = rna_enum_property_flag_items, .value = 0, }; struct BPy_EnumProperty_Parse override_enum = { .items = rna_enum_property_override_flag_items, .value = 0, }; struct BPy_EnumProperty_Parse_WithSRNA tags_enum = { .srna = srna, }; PyObject *update_fn = NULL, *poll_fn = NULL; static const char *_keywords[] = { "attr", "type", "name", "description", "options", "override", "tags", "poll", "update", NULL, }; static _PyArg_Parser _parser = { "O&" /* `attr` */ "O" /* `type` */ "|$" /* Optional, keyword only arguments. */ "s" /* `name` */ "s" /* `description` */ "O&" /* `options` */ "O&" /* `override` */ "O&" /* `tags` */ "O" /* `poll` */ "O" /* `update` */ ":PointerProperty", _keywords, 0, }; if (!_PyArg_ParseTupleAndKeywordsFast(args, kw, &_parser, bpy_prop_arg_parse_id, &id_data, &type, &name, &description, pyrna_enum_bitfield_parse_set, &options_enum, pyrna_enum_bitfield_parse_set, &override_enum, bpy_prop_arg_parse_tag_defines, &tags_enum, &poll_fn, &update_fn)) { return NULL; } ptype = pointer_type_from_py(type, "PointerProperty(...)"); if (!ptype) { return NULL; } if (!RNA_struct_is_a(ptype, &RNA_PropertyGroup) && !RNA_struct_is_ID(ptype)) { PyErr_Format(PyExc_TypeError, "PointerProperty(...) expected an RNA type derived from %.200s or %.200s", RNA_struct_ui_name(&RNA_ID), RNA_struct_ui_name(&RNA_PropertyGroup)); return NULL; } if (bpy_prop_callback_check(update_fn, "update", 2) == -1) { return NULL; } if (bpy_prop_callback_check(poll_fn, "poll", 2) == -1) { return NULL; } if (id_data.prop_free_handle != NULL) { RNA_def_property_free_identifier_deferred_finish(srna, id_data.prop_free_handle); } prop = RNA_def_pointer_runtime( srna, id_data.value, ptype, name ? name : id_data.value, description); if (tags_enum.base.is_set) { RNA_def_property_tags(prop, tags_enum.base.value); } if (options_enum.is_set) { bpy_prop_assign_flag(prop, options_enum.value); } if (override_enum.is_set) { bpy_prop_assign_flag_override(prop, override_enum.value); } if (RNA_struct_idprops_contains_datablock(ptype)) { if (RNA_struct_is_a(srna, &RNA_PropertyGroup)) { RNA_def_struct_flag(srna, STRUCT_CONTAINS_DATABLOCK_IDPROPERTIES); } } bpy_prop_callback_assign_update(prop, update_fn); bpy_prop_callback_assign_pointer(prop, poll_fn); RNA_def_property_duplicate_pointers(srna, prop); Py_RETURN_NONE; } PyDoc_STRVAR(BPy_CollectionProperty_doc, ".. function:: CollectionProperty(type=None, " "name=\"\", " "description=\"\", " "options={'ANIMATABLE'}, " "override=set(), " "tags=set())\n" "\n" " Returns a new collection property definition.\n" "\n" BPY_PROPDEF_COLLECTION_TYPE_DOC BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC BPY_PROPDEF_OPTIONS_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_COLLECTION_DOC BPY_PROPDEF_TAGS_DOC); PyObject *BPy_CollectionProperty(PyObject *self, PyObject *args, PyObject *kw) { StructRNA *srna; { /* Keep this block first. */ PyObject *deferred_result; srna = bpy_prop_deferred_data_or_srna( self, args, kw, pymeth_CollectionProperty, &deferred_result); if (srna == NULL) { return deferred_result; } } struct BPy_PropIDParse id_data = { .srna = srna, }; const char *name = NULL, *description = ""; PropertyRNA *prop; StructRNA *ptype; PyObject *type = Py_None; struct BPy_EnumProperty_Parse options_enum = { .items = rna_enum_property_flag_items, .value = 0, }; struct BPy_EnumProperty_Parse override_enum = { .items = rna_enum_property_override_flag_collection_items, .value = 0, }; struct BPy_EnumProperty_Parse_WithSRNA tags_enum = { .srna = srna, }; static const char *_keywords[] = { "attr", "type", "name", "description", "options", "override", "tags", NULL, }; static _PyArg_Parser _parser = { "O&" /* `attr` */ "O" /* `type` */ "|$" /* Optional, keyword only arguments. */ "s" /* `name` */ "s" /* `description` */ "O&" /* `options` */ "O&" /* `override` */ "O&" /* `tags` */ ":CollectionProperty", _keywords, 0, }; if (!_PyArg_ParseTupleAndKeywordsFast(args, kw, &_parser, bpy_prop_arg_parse_id, &id_data, &type, &name, &description, pyrna_enum_bitfield_parse_set, &options_enum, pyrna_enum_bitfield_parse_set, &override_enum, bpy_prop_arg_parse_tag_defines, &tags_enum)) { return NULL; } ptype = pointer_type_from_py(type, "CollectionProperty(...):"); if (!ptype) { return NULL; } if (!RNA_struct_is_a(ptype, &RNA_PropertyGroup)) { PyErr_Format(PyExc_TypeError, "CollectionProperty(...) expected an RNA type derived from %.200s", RNA_struct_ui_name(&RNA_PropertyGroup)); return NULL; } if (id_data.prop_free_handle != NULL) { RNA_def_property_free_identifier_deferred_finish(srna, id_data.prop_free_handle); } prop = RNA_def_collection_runtime( srna, id_data.value, ptype, name ? name : id_data.value, description); if (tags_enum.base.is_set) { RNA_def_property_tags(prop, tags_enum.base.value); } if (options_enum.is_set) { bpy_prop_assign_flag(prop, options_enum.value); } if (override_enum.is_set) { bpy_prop_assign_flag_override(prop, override_enum.value); } if (RNA_struct_idprops_contains_datablock(ptype)) { if (RNA_struct_is_a(srna, &RNA_PropertyGroup)) { RNA_def_struct_flag(srna, STRUCT_CONTAINS_DATABLOCK_IDPROPERTIES); } } RNA_def_property_duplicate_pointers(srna, prop); Py_RETURN_NONE; } PyDoc_STRVAR(BPy_RemoveProperty_doc, ".. function:: RemoveProperty(cls, attr)\n" "\n" " Removes a dynamically defined property.\n" "\n" " :arg cls: The class containing the property (must be a positional argument).\n" " :type cls: type\n" " :arg attr: Property name (must be passed as a keyword).\n" " :type attr: string\n" "\n" ".. note:: Typically this function doesn't need to be accessed directly.\n" " Instead use ``del cls.attr``\n"); static PyObject *BPy_RemoveProperty(PyObject *self, PyObject *args, PyObject *kw) { StructRNA *srna; if (PyTuple_GET_SIZE(args) == 1) { PyObject *ret; self = PyTuple_GET_ITEM(args, 0); args = PyTuple_New(0); ret = BPy_RemoveProperty(self, args, kw); Py_DECREF(args); return ret; } if (PyTuple_GET_SIZE(args) > 1) { PyErr_SetString(PyExc_ValueError, "expected one positional arg, one keyword arg"); return NULL; } srna = srna_from_self(self, "RemoveProperty(...):"); if (srna == NULL && PyErr_Occurred()) { return NULL; /* self's type was compatible but error getting the srna */ } if (srna == NULL) { PyErr_SetString(PyExc_TypeError, "RemoveProperty(): struct rna not available for this type"); return NULL; } const char *id = NULL; static const char *_keywords[] = { "attr", NULL, }; static _PyArg_Parser _parser = { "s" /* `attr` */ ":RemoveProperty", _keywords, 0, }; if (!_PyArg_ParseTupleAndKeywordsFast(args, kw, &_parser, &id)) { return NULL; } if (RNA_def_property_free_identifier(srna, id) != 1) { PyErr_Format(PyExc_TypeError, "RemoveProperty(): '%s' not a defined dynamic property", id); return NULL; } Py_RETURN_NONE; } /** \} */ /* -------------------------------------------------------------------- */ /** \name Main Module `bpy.props` * \{ */ static struct PyMethodDef props_methods[] = { {"BoolProperty", (PyCFunction)BPy_BoolProperty, METH_VARARGS | METH_KEYWORDS, BPy_BoolProperty_doc}, {"BoolVectorProperty", (PyCFunction)BPy_BoolVectorProperty, METH_VARARGS | METH_KEYWORDS, BPy_BoolVectorProperty_doc}, {"IntProperty", (PyCFunction)BPy_IntProperty, METH_VARARGS | METH_KEYWORDS, BPy_IntProperty_doc}, {"IntVectorProperty", (PyCFunction)BPy_IntVectorProperty, METH_VARARGS | METH_KEYWORDS, BPy_IntVectorProperty_doc}, {"FloatProperty", (PyCFunction)BPy_FloatProperty, METH_VARARGS | METH_KEYWORDS, BPy_FloatProperty_doc}, {"FloatVectorProperty", (PyCFunction)BPy_FloatVectorProperty, METH_VARARGS | METH_KEYWORDS, BPy_FloatVectorProperty_doc}, {"StringProperty", (PyCFunction)BPy_StringProperty, METH_VARARGS | METH_KEYWORDS, BPy_StringProperty_doc}, {"EnumProperty", (PyCFunction)BPy_EnumProperty, METH_VARARGS | METH_KEYWORDS, BPy_EnumProperty_doc}, {"PointerProperty", (PyCFunction)BPy_PointerProperty, METH_VARARGS | METH_KEYWORDS, BPy_PointerProperty_doc}, {"CollectionProperty", (PyCFunction)BPy_CollectionProperty, METH_VARARGS | METH_KEYWORDS, BPy_CollectionProperty_doc}, {"RemoveProperty", (PyCFunction)BPy_RemoveProperty, METH_VARARGS | METH_KEYWORDS, BPy_RemoveProperty_doc}, {NULL, NULL, 0, NULL}, }; static int props_visit(PyObject *UNUSED(self), visitproc visit, void *arg) { LISTBASE_FOREACH (struct BPyPropStore *, prop_store, &g_bpy_prop_store_list) { PyObject **py_data = (PyObject **)&prop_store->py_data; for (int i = 0; i < BPY_PROP_STORE_PY_DATA_SIZE; i++) { Py_VISIT(py_data[i]); } } return 0; } static int props_clear(PyObject *UNUSED(self)) { LISTBASE_FOREACH (struct BPyPropStore *, prop_store, &g_bpy_prop_store_list) { PyObject **py_data = (PyObject **)&prop_store->py_data; for (int i = 0; i < BPY_PROP_STORE_PY_DATA_SIZE; i++) { Py_CLEAR(py_data[i]); } } return 0; } static struct PyModuleDef props_module = { PyModuleDef_HEAD_INIT, "bpy.props", "This module defines properties to extend Blender's internal data. The result of these " "functions" " is used to assign properties to classes registered with Blender and can't be used " "directly.\n" "\n" ".. note:: All parameters to these functions must be passed as keywords.\n", -1, /* multiple "initialization" just copies the module dict. */ props_methods, NULL, props_visit, props_clear, NULL, }; PyObject *BPY_rna_props(void) { PyObject *submodule; PyObject *submodule_dict; submodule = PyModule_Create(&props_module); PyDict_SetItemString(PyImport_GetModuleDict(), props_module.m_name, submodule); /* api needs the PyObjects internally */ submodule_dict = PyModule_GetDict(submodule); #define ASSIGN_STATIC(_name) pymeth_##_name = PyDict_GetItemString(submodule_dict, #_name) ASSIGN_STATIC(BoolProperty); ASSIGN_STATIC(BoolVectorProperty); ASSIGN_STATIC(IntProperty); ASSIGN_STATIC(IntVectorProperty); ASSIGN_STATIC(FloatProperty); ASSIGN_STATIC(FloatVectorProperty); ASSIGN_STATIC(StringProperty); ASSIGN_STATIC(EnumProperty); ASSIGN_STATIC(PointerProperty); ASSIGN_STATIC(CollectionProperty); ASSIGN_STATIC(RemoveProperty); if (PyType_Ready(&bpy_prop_deferred_Type) < 0) { return NULL; } PyModule_AddType(submodule, &bpy_prop_deferred_Type); /* Run this when properties are freed. */ RNA_def_property_free_pointers_set_py_data_callback(bpy_prop_py_data_remove); return submodule; } void BPY_rna_props_clear_all(void) { /* Remove all user counts, so this isn't considered a leak from Python's perspective. */ props_clear(NULL); /* Running is harmless, but redundant. */ RNA_def_property_free_pointers_set_py_data_callback(NULL); /* Include as it's correct, in practice this should never be used again. */ BLI_listbase_clear(&g_bpy_prop_store_list); } /** \} */