archive/blender-archive
Archived
1
1
Fork 0
Code Pull Requests Packages Activity

Cleanup: use doxy sections for 'bpy.props' module

Browse Source
This commit is contained in:
Campbell Barton
2021-03-16 17:34:52 +11:00
parent 95bb41a3e3
commit 269536d47e
1 changed files with 131 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

182
source/blender/python/intern/bpy_props.c
View File

@@ -48,7 +48,9 @@
#include "../generic/py_capi_utils.h"
static struct BPyPropStore *bpy_prop_py_data_ensure(struct PropertyRNA *prop);
/* -------------------------------------------------------------------- */
/** \name Shared Enums & Doc-Strings
* \{ */
static const EnumPropertyItem property_flag_items[] = {
{PROP_HIDDEN, "HIDDEN", 0, "Hidden", ""},
@@ -187,6 +189,8 @@ static const EnumPropertyItem property_subtype_array_items[] = {
"'XYZ', 'XYZ_LENGTH', 'COLOR_GAMMA', 'COORDINATES', 'LAYER', 'LAYER_MEMBER', 'NONE'].\n" \
" :type subtype: string\n"
/** \} */
/* -------------------------------------------------------------------- */
/** \name Python Property Storage API
*
@@ -437,6 +441,14 @@ static void bpy_prop_assign_flag_override(PropertyRNA *prop, const int flag_over
RNA_def_property_override_flag(prop, flag_override);
}
/** \} */
/* -------------------------------------------------------------------- */
/** \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,
@@ -490,6 +502,12 @@ static void bpy_prop_update_fn(struct bContext *C,
}
}
/** \} */
/* -------------------------------------------------------------------- */
/** \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);
@@ -609,55 +627,6 @@ static void bpy_prop_boolean_set_fn(struct PointerRNA *ptr, struct PropertyRNA *
}
}
static bool bpy_prop_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.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;
}
static void bpy_prop_boolean_array_get_fn(struct PointerRNA *ptr,
struct PropertyRNA *prop,
bool *values)
@@ -786,6 +755,12 @@ static void bpy_prop_boolean_array_set_fn(struct PointerRNA *ptr,
}
}
/** \} */
/* -------------------------------------------------------------------- */
/** \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);
@@ -1030,6 +1005,12 @@ static void bpy_prop_int_array_set_fn(struct PointerRNA *ptr,
}
}
/** \} */
/* -------------------------------------------------------------------- */
/** \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);
@@ -1274,6 +1255,12 @@ static void bpy_prop_float_array_set_fn(struct PointerRNA *ptr,
}
}
/** \} */
/* -------------------------------------------------------------------- */
/** \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);
@@ -1463,6 +1450,67 @@ static void bpy_prop_string_set_fn(struct PointerRNA *ptr,
}
}
/** \} */
/* -------------------------------------------------------------------- */
/** \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.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);
@@ -1907,6 +1955,12 @@ static int bpy_prop_callback_check(PyObject *py_func, const char *keyword, int a
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 */
@@ -1925,7 +1979,7 @@ static void bpy_prop_callback_assign_pointer(struct PropertyRNA *prop, PyObject
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_poll_fn);
RNA_def_property_poll_runtime(prop, bpy_prop_pointer_poll_fn);
ASSIGN_PYOBJECT_INCREF(prop_store->py_data.poll_fn, poll_fn);
}
}
@@ -2132,6 +2186,12 @@ static void bpy_prop_callback_assign_enum(struct PropertyRNA *prop,
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 (to be registered later) */
#define BPY_PROPDEF_HEAD(_func) \
@@ -2211,6 +2271,12 @@ static void bpy_prop_callback_assign_enum(struct PropertyRNA *prop,
} \
(void)0
/** \} */
/* -------------------------------------------------------------------- */
/** \name Shared Method Doc-Strings
* \{ */
#define BPY_PROPDEF_NAME_DOC \
" :arg name: Name used in the user interface.\n" \
" :type name: string\n"
@@ -2297,6 +2363,12 @@ static int bpy_struct_id_used(StructRNA *srna, char *identifier)
}
#endif
/** \} */
/* -------------------------------------------------------------------- */
/** \name Module Methods
* \{ */
/* Function that sets RNA, NOTE - self 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 */
@@ -3732,6 +3804,12 @@ static PyObject *BPy_RemoveProperty(PyObject *self, PyObject *args, PyObject *kw
Py_RETURN_NONE;
}
/** \} */
/* -------------------------------------------------------------------- */
/** \name Main Module `bpy.props`
* \{ */
static struct PyMethodDef props_methods[] = {
{"BoolProperty",
(PyCFunction)BPy_BoolProperty,
@@ -3871,3 +3949,5 @@ void BPY_rna_props_clear_all(void)
/* Include as it's correct, in practice this should never be used again. */
BLI_listbase_clear(&g_bpy_prop_store_list);
}
/** \} */