[Bf-blender-cvs] [63f7eceb530] master: PyAPI: defer freeing existing properties on registration
Campbell Barton
noreply at git.blender.org
Fri Jul 30 08:17:18 CEST 2021
Commit: 63f7eceb53085ef40cad4dc2343dbe608be999c1
Author: Campbell Barton
Date: Fri Jul 30 16:04:08 2021 +1000
Branches: master
https://developer.blender.org/rB63f7eceb53085ef40cad4dc2343dbe608be999c1
PyAPI: defer freeing existing properties on registration
Registering a property could remove the existing property,
then fail to parse one of the arguments of the new property -
leaving the struct without a property.
Now freeing the existing property is deferred until immediately
before the new property is registered.
===================================================================
M source/blender/makesrna/RNA_define.h
M source/blender/makesrna/intern/rna_define.c
M source/blender/python/intern/bpy_props.c
===================================================================
diff --git a/source/blender/makesrna/RNA_define.h b/source/blender/makesrna/RNA_define.h
index a31182b2f5a..01e26cbb41c 100644
--- a/source/blender/makesrna/RNA_define.h
+++ b/source/blender/makesrna/RNA_define.h
@@ -506,6 +506,11 @@ void RNA_def_property_duplicate_pointers(StructOrFunctionRNA *cont_, PropertyRNA
void RNA_def_property_free_pointers(PropertyRNA *prop);
int RNA_def_property_free_identifier(StructOrFunctionRNA *cont_, const char *identifier);
+int RNA_def_property_free_identifier_deferred_prepare(StructOrFunctionRNA *cont_,
+ const char *identifier,
+ void **handle);
+void RNA_def_property_free_identifier_deferred_finish(StructOrFunctionRNA *cont_, void *handle);
+
void RNA_def_property_free_pointers_set_py_data_callback(
void (*py_data_clear_fn)(PropertyRNA *prop));
diff --git a/source/blender/makesrna/intern/rna_define.c b/source/blender/makesrna/intern/rna_define.c
index fadce9e3c89..bd5ade36eaa 100644
--- a/source/blender/makesrna/intern/rna_define.c
+++ b/source/blender/makesrna/intern/rna_define.c
@@ -4759,25 +4759,60 @@ static void rna_def_property_free(StructOrFunctionRNA *cont_, PropertyRNA *prop)
}
}
+static PropertyRNA *rna_def_property_find_py_id(ContainerRNA *cont, const char *identifier)
+{
+ for (PropertyRNA *prop = cont->properties.first; prop; prop = prop->next) {
+ if (STREQ(prop->identifier, identifier)) {
+ return prop;
+ }
+ }
+ return NULL;
+}
+
/* NOTE: only intended for removing dynamic props. */
int RNA_def_property_free_identifier(StructOrFunctionRNA *cont_, const char *identifier)
{
ContainerRNA *cont = cont_;
- PropertyRNA *prop;
+ PropertyRNA *prop = rna_def_property_find_py_id(cont, identifier);
+ if (prop != NULL) {
+ if (prop->flag_internal & PROP_INTERN_RUNTIME) {
+ rna_def_property_free(cont, prop);
+ return 1;
+ }
+ else {
+ return -1;
+ }
+ }
+ return 0;
+}
- for (prop = cont->properties.first; prop; prop = prop->next) {
- if (STREQ(prop->identifier, identifier)) {
- if (prop->flag_internal & PROP_INTERN_RUNTIME) {
- rna_def_property_free(cont_, prop);
- return 1;
- }
- else {
- return -1;
- }
+int RNA_def_property_free_identifier_deferred_prepare(StructOrFunctionRNA *cont_,
+ const char *identifier,
+ void **r_handle)
+{
+ ContainerRNA *cont = cont_;
+ PropertyRNA *prop = rna_def_property_find_py_id(cont, identifier);
+ if (prop != NULL) {
+ if (prop->flag_internal & PROP_INTERN_RUNTIME) {
+ *r_handle = prop;
+ return 1;
+ }
+ else {
+ return -1;
}
}
return 0;
}
+
+void RNA_def_property_free_identifier_deferred_finish(StructOrFunctionRNA *cont_, void *handle)
+{
+ ContainerRNA *cont = cont_;
+ PropertyRNA *prop = handle;
+ BLI_assert(BLI_findindex(&cont->properties, prop) != -1);
+ BLI_assert(prop->flag_internal & PROP_INTERN_RUNTIME);
+ rna_def_property_free(cont, prop);
+}
+
#endif /* RNA_RUNTIME */
const char *RNA_property_typename(PropertyType type)
diff --git a/source/blender/python/intern/bpy_props.c b/source/blender/python/intern/bpy_props.c
index 226d740c5e0..38b66a0589b 100644
--- a/source/blender/python/intern/bpy_props.c
+++ b/source/blender/python/intern/bpy_props.c
@@ -2485,6 +2485,13 @@ static StructRNA *bpy_prop_deferred_data_or_srna(PyObject *self,
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;
};
/**
@@ -2509,7 +2516,9 @@ static int bpy_prop_arg_parse_id(PyObject *o, void *p)
return 0;
}
- if (UNLIKELY(RNA_def_property_free_identifier(srna, id) == -1)) {
+ 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,
@@ -2749,7 +2758,11 @@ static PyObject *BPy_BoolProperty(PyObject *self, PyObject *args, PyObject *kw)
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);
@@ -2889,7 +2902,11 @@ static PyObject *BPy_BoolVectorProperty(PyObject *self, PyObject *args, PyObject
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) {
@@ -3040,7 +3057,11 @@ static PyObject *BPy_IntProperty(PyObject *self, PyObject *args, PyObject *kw)
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);
@@ -3202,7 +3223,11 @@ static PyObject *BPy_IntVectorProperty(PyObject *self, PyObject *args, PyObject
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) {
@@ -3353,7 +3378,11 @@ static PyObject *BPy_FloatProperty(PyObject *self, PyObject *args, PyObject *kw)
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);
@@ -3515,7 +3544,11 @@ static PyObject *BPy_FloatVectorProperty(PyObject *self, PyObject *args, PyObjec
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) {
@@ -3656,7 +3689,11 @@ static PyObject *BPy_StringProperty(PyObject *self, PyObject *args, PyObject *kw
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);
@@ -3868,6 +3905,9 @@ static PyObject *BPy_EnumProperty(PyObject *self, PyObject *args, PyObject *kw)
}
}
+ 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);
@@ -4022,8 +4062,13 @@ PyObject *BPy_PointerProperty(PyObject *self, PyObject *args, PyObject *kw)
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);
}
@@ -4130,8 +4175,12 @@ PyObject *BPy_CollectionProperty(PyObject *self, PyObject *args, PyObject *kw)
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);
}
More information about the Bf-blender-cvs
mailing list