dillongoostudios/goo-engine
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Cleanup: Improve/fix some IDProperty comments and TODOs.

Browse Source 
Mainly correct/update some comments (e.g. missing reference to Boolean
type), and add some notes essentially about issues with current IDProp
String code (see also #86960 ).

No functional change.
This commit is contained in:
Bastien Montagne
2024-06-07 14:47:01 +02:00
parent 57669600b1
commit 89e790d2a4
4 changed files with 17 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
source/blender/blenkernel/BKE_idprop.hh
+1 -1
View File
@@ -208,7 +208,7 @@ bool IDP_EqualsProperties(const IDProperty *prop1,
const IDProperty *prop2) ATTR_WARN_UNUSED_RESULT;
/**
* Allocate a new ID.
* Allocate a new IDProperty.
*
* This function takes three arguments: the ID property type, a union which defines
* its initial value, and a name.
source/blender/blenkernel/intern/idprop.cc
+6
View File
@@ -406,6 +406,8 @@ static IDProperty *IDP_CopyString(const IDProperty *prop, const int flag)
return newp;
}
/* FIXME: This function is broken for bytes (in case there are null chars in it), needs a
* dedicated function which takes directly the size of the byte buffer. */
void IDP_AssignStringMaxSize(IDProperty *prop, const char *st, const size_t st_maxncpy)
{
BLI_assert(prop->type == IDP_STRING);
@@ -421,6 +423,7 @@ void IDP_AssignStringMaxSize(IDProperty *prop, const char *st, const size_t st_m
}
}
/* FIXME: Should never be called for `byte` subtype, needs an assert. */
void IDP_AssignString(IDProperty *prop, const char *st)
{
IDP_AssignStringMaxSize(prop, st, 0);
@@ -997,6 +1000,9 @@ IDProperty *IDP_New(const char type, const IDPropertyTemplate *val, const char *
prop->data.val = bool(val->i);
break;
case IDP_ARRAY: {
/* FIXME: This seems to be the only place in code allowing `IDP_GROUP` as subtype of an
* `IDP_ARRAY`. This is most likely a mistake. `IDP_GROUP` array should be of type
* `IDP_IDPARRAY`, as done e.g. in #idp_from_PySequence_Buffer in bpy API. */
if (ELEM(val->array.type, IDP_FLOAT, IDP_INT, IDP_DOUBLE, IDP_GROUP, IDP_BOOLEAN)) {
prop = static_cast<IDProperty *>(MEM_callocN(sizeof(IDProperty), "IDProperty array"));
prop->subtype = val->array.type;
source/blender/makesdna/DNA_ID.h
+1 -1
View File
@@ -226,7 +226,7 @@ typedef enum eIDPropertySubType {
/** #IDProperty.flag. */
enum {
/**
* This #IDProperty may be statically overridden.
* This #IDProperty may be library-overridden.
* Should only be used/be relevant for custom properties.
*/
IDP_FLAG_OVERRIDABLE_LIBRARY = 1 << 0,
source/blender/python/generic/idprop_py_api.cc
+9 -3
View File
@@ -328,7 +328,8 @@ static PyObject *BPy_IDGroup_Map_GetItem(BPy_IDProperty *self, PyObject *item)
return BPy_IDGroup_WrapData(self->owner_id, idprop, self->prop);
}
/* returns nullptr on success, error string on failure */
/* Return identified matching IDProperty type, or -1 if error (e.g. mixed and/or incompatible
* types, etc.). */
static char idp_sequence_type(PyObject *seq_fast)
{
PyObject **seq_fast_items = PySequence_Fast_ITEMS(seq_fast);
@@ -346,6 +347,7 @@ static char idp_sequence_type(PyObject *seq_fast)
type = IDP_DOUBLE;
}
else if (PyBool_Check(item)) {
/* Mixed boolean and any other type. */
if (i != 0 && (type != IDP_BOOLEAN)) {
return -1;
}
@@ -357,7 +359,8 @@ static char idp_sequence_type(PyObject *seq_fast)
}
}
else if (PyMapping_Check(item)) {
if (i != 0 && (type != IDP_IDPARRAY)) { /* mixed dict/int */
/* Mixed dict and any other type. */
if (i != 0 && (type != IDP_IDPARRAY)) {
return -1;
}
type = IDP_IDPARRAY;
@@ -470,6 +473,7 @@ static int idp_array_type_from_formatstr_and_size(const char *typestr, Py_ssize_
if (itemsize == 4) {
return IDP_INT;
}
/* TODO: Support Booleans? */
}
return -1;
@@ -522,9 +526,11 @@ static IDProperty *idp_from_PySequence_Fast(const char *name, PyObject *ob)
ob_seq_fast_items = PySequence_Fast_ITEMS(ob);
/* IDProperties do not support mixed type of data in an array. Try to extract a single type from
* the whole sequence, or error. */
if ((val.array.type = idp_sequence_type(ob)) == char(-1)) {
PyErr_SetString(PyExc_TypeError,
"only floats, ints and dicts are allowed in ID property arrays");
"only floats, ints, booleans and dicts are allowed in ID property arrays");
return nullptr;
}