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

RNA: Limit which classes struct-map contains

Browse Source 
Only add subclasses of: Menu, Panel, Header, UIList, Operator

This helps avoid unnecessary naming collisions,

See T52599 for details
This commit is contained in:
Campbell Barton
2017-08-31 23:32:21 +10:00
parent 018137f762
commit 636baa598a
14 changed files with 58 additions and 47 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
source/blender/makesrna/RNA_types.h
View File

@@ -436,6 +436,8 @@ typedef enum StructFlag {
STRUCT_NO_IDPROPERTIES = (1 << 6), /* Menus and Panels don't need properties */ STRUCT_NO_IDPROPERTIES = (1 << 6), /* Menus and Panels don't need properties */
STRUCT_NO_DATABLOCK_IDPROPERTIES = (1 << 7), /* e.g. for Operator */ STRUCT_NO_DATABLOCK_IDPROPERTIES = (1 << 7), /* e.g. for Operator */
STRUCT_CONTAINS_DATABLOCK_IDPROPERTIES = (1 << 8), /* for PropertyGroup which contains pointers to datablocks */ STRUCT_CONTAINS_DATABLOCK_IDPROPERTIES = (1 << 8), /* for PropertyGroup which contains pointers to datablocks */
STRUCT_PUBLIC_NAMESPACE = (1 << 9), /* Added to type-map #BlenderRNA.structs_map */
STRUCT_PUBLIC_NAMESPACE_INHERIT = (1 << 10), /* All subtypes are added too. */
} StructFlag; } StructFlag;
typedef int (*StructValidateFunc)(struct PointerRNA *ptr, void *data, int *have_function); typedef int (*StructValidateFunc)(struct PointerRNA *ptr, void *data, int *have_function);

4
source/blender/makesrna/intern/rna_ID.c
View File

@@ -273,10 +273,6 @@ StructRNA *rna_PropertyGroup_register(Main *UNUSED(bmain), ReportList *reports,
return NULL; return NULL;
} }
if (!RNA_struct_available_or_report(reports, identifier)) {
return NULL;
}
return RNA_def_struct_ptr(&BLENDER_RNA, identifier, &RNA_PropertyGroup); /* XXX */ return RNA_def_struct_ptr(&BLENDER_RNA, identifier, &RNA_PropertyGroup); /* XXX */
} }

4
source/blender/makesrna/intern/rna_access.c
View File

@@ -89,6 +89,7 @@ void RNA_init(void)
} }
} }
} }
BLI_assert(srna->flag & STRUCT_PUBLIC_NAMESPACE);
BLI_ghash_insert(BLENDER_RNA.structs_map, (void *)srna->identifier, srna); BLI_ghash_insert(BLENDER_RNA.structs_map, (void *)srna->identifier, srna);
BLENDER_RNA.structs_len += 1; BLENDER_RNA.structs_len += 1;
} }
@@ -814,6 +815,9 @@ char *RNA_struct_name_get_alloc(PointerRNA *ptr, char *fixedbuf, int fixedlen, i
return NULL; return NULL;
} }
/**
* Use when registering structs with the #STRUCT_PUBLIC_NAMESPACE flag.
*/
bool RNA_struct_available_or_report(ReportList *reports, const char *identifier) bool RNA_struct_available_or_report(ReportList *reports, const char *identifier)
{ {
const StructRNA *srna_exists = RNA_struct_find(identifier); const StructRNA *srna_exists = RNA_struct_find(identifier);

3
source/blender/makesrna/intern/rna_animation.c
View File

@@ -273,9 +273,6 @@ static StructRNA *rna_KeyingSetInfo_register(Main *bmain, ReportList *reports, v
if (ksi && ksi->ext.srna) { if (ksi && ksi->ext.srna) {
rna_KeyingSetInfo_unregister(bmain, ksi->ext.srna); rna_KeyingSetInfo_unregister(bmain, ksi->ext.srna);
} }
if (!RNA_struct_available_or_report(reports, dummyksi.idname)) {
return NULL;
}
/* create a new KeyingSetInfo type */ /* create a new KeyingSetInfo type */
ksi = MEM_callocN(sizeof(KeyingSetInfo), "python keying set info"); ksi = MEM_callocN(sizeof(KeyingSetInfo), "python keying set info");

49
source/blender/makesrna/intern/rna_define.c
View File

@@ -142,7 +142,9 @@ static void rna_brna_structs_add(BlenderRNA *brna, StructRNA *srna)
/* This exception is only needed for pre-processing. /* This exception is only needed for pre-processing.
* otherwise we don't allow empty names. */ * otherwise we don't allow empty names. */
if (srna->identifier[0] != '\0') { if ((srna->flag & STRUCT_PUBLIC_NAMESPACE) &&
(srna->identifier[0] != '\0'))
{
BLI_ghash_insert(brna->structs_map, (void *)srna->identifier, srna); BLI_ghash_insert(brna->structs_map, (void *)srna->identifier, srna);
} }
} }
@@ -150,7 +152,7 @@ static void rna_brna_structs_add(BlenderRNA *brna, StructRNA *srna)
#ifdef RNA_RUNTIME #ifdef RNA_RUNTIME
static void rna_brna_structs_remove_and_free(BlenderRNA *brna, StructRNA *srna) static void rna_brna_structs_remove_and_free(BlenderRNA *brna, StructRNA *srna)
{ {
if (brna->structs_map) { if ((srna->flag & STRUCT_PUBLIC_NAMESPACE) && brna->structs_map) {
if (srna->identifier[0] != '\0') { if (srna->identifier[0] != '\0') {
BLI_ghash_remove(brna->structs_map, (void *)srna->identifier, NULL, NULL); BLI_ghash_remove(brna->structs_map, (void *)srna->identifier, NULL, NULL);
} }
@@ -763,12 +765,19 @@ StructRNA *RNA_def_struct_ptr(BlenderRNA *brna, const char *identifier, StructRN
BLI_listbase_clear(&srna->functions); BLI_listbase_clear(&srna->functions);
srna->py_type = NULL; srna->py_type = NULL;
srna->base = srnafrom;
if (DefRNA.preprocess) { if (DefRNA.preprocess) {
srna->base = srnafrom;
dsfrom = rna_find_def_struct(srnafrom); dsfrom = rna_find_def_struct(srnafrom);
} }
else else {
srna->base = srnafrom; if (srnafrom->flag & STRUCT_PUBLIC_NAMESPACE_INHERIT) {
srna->flag |= STRUCT_PUBLIC_NAMESPACE | STRUCT_PUBLIC_NAMESPACE_INHERIT;
}
else {
srna->flag &= ~(STRUCT_PUBLIC_NAMESPACE | STRUCT_PUBLIC_NAMESPACE_INHERIT);
}
}
} }
srna->identifier = identifier; srna->identifier = identifier;
@@ -780,6 +789,10 @@ StructRNA *RNA_def_struct_ptr(BlenderRNA *brna, const char *identifier, StructRN
if (!srnafrom) if (!srnafrom)
srna->icon = ICON_DOT; srna->icon = ICON_DOT;
if (DefRNA.preprocess) {
srna->flag |= STRUCT_PUBLIC_NAMESPACE;
}
rna_brna_structs_add(brna, srna); rna_brna_structs_add(brna, srna);
if (DefRNA.preprocess) { if (DefRNA.preprocess) {
@@ -1001,12 +1014,14 @@ void RNA_def_struct_identifier(BlenderRNA *brna, StructRNA *srna, const char *id
} }
/* Operator registration may set twice, see: operator_properties_init */ /* Operator registration may set twice, see: operator_properties_init */
if (identifier != srna->identifier) { if (srna->flag & STRUCT_PUBLIC_NAMESPACE) {
if (srna->identifier[0] != '\0') { if (identifier != srna->identifier) {
BLI_ghash_remove(brna->structs_map, (void *)srna->identifier, NULL, NULL); if (srna->identifier[0] != '\0') {
} BLI_ghash_remove(brna->structs_map, (void *)srna->identifier, NULL, NULL);
if (identifier[0] != '\0') { }
BLI_ghash_insert(brna->structs_map, (void *)identifier, srna); if (identifier[0] != '\0') {
BLI_ghash_insert(brna->structs_map, (void *)identifier, srna);
}
} }
} }
@@ -3316,8 +3331,10 @@ void RNA_enum_item_end(EnumPropertyItem **items, int *totitem)
void RNA_def_struct_duplicate_pointers(BlenderRNA *brna, StructRNA *srna) void RNA_def_struct_duplicate_pointers(BlenderRNA *brna, StructRNA *srna)
{ {
if (srna->identifier) { if (srna->identifier) {
srna->identifier = BLI_strdup(srna->identifier); if (srna->flag & STRUCT_PUBLIC_NAMESPACE) {
BLI_ghash_replace_key(brna->structs_map, (void *)srna->identifier); srna->identifier = BLI_strdup(srna->identifier);
BLI_ghash_replace_key(brna->structs_map, (void *)srna->identifier);
}
} }
if (srna->name) { if (srna->name) {
srna->name = BLI_strdup(srna->name); srna->name = BLI_strdup(srna->name);
@@ -3333,8 +3350,10 @@ void RNA_def_struct_free_pointers(BlenderRNA *brna, StructRNA *srna)
{ {
if (srna->flag & STRUCT_FREE_POINTERS) { if (srna->flag & STRUCT_FREE_POINTERS) {
if (srna->identifier) { if (srna->identifier) {
if (brna != NULL) { if (srna->flag & STRUCT_PUBLIC_NAMESPACE) {
BLI_ghash_remove(brna->structs_map, (void *)srna->identifier, NULL, NULL); if (brna != NULL) {
BLI_ghash_remove(brna->structs_map, (void *)srna->identifier, NULL, NULL);
}
} }
MEM_freeN((void *)srna->identifier); MEM_freeN((void *)srna->identifier);
} }

2
source/blender/makesrna/intern/rna_internal_types.h
View File

@@ -413,6 +413,8 @@ struct StructRNA {
struct BlenderRNA { struct BlenderRNA {
ListBase structs; ListBase structs;
/* A map of structs: {StructRNA.identifier -> StructRNA}
* These are ensured to have unique names (with STRUCT_PUBLIC_NAMESPACE enabled). */
struct GHash *structs_map; struct GHash *structs_map;
/* Needed because types with an empty identifier aren't included in 'structs_map'. */ /* Needed because types with an empty identifier aren't included in 'structs_map'. */
unsigned int structs_len; unsigned int structs_len;

6
source/blender/makesrna/intern/rna_nodetree.c
View File

@@ -633,9 +633,6 @@ static StructRNA *rna_NodeTree_register(
if (nt) { if (nt) {
rna_NodeTree_unregister(bmain, nt->ext.srna); rna_NodeTree_unregister(bmain, nt->ext.srna);
} }
if (!RNA_struct_available_or_report(reports, dummynt.idname)) {
return NULL;
}
/* create a new node tree type */ /* create a new node tree type */
nt = MEM_callocN(sizeof(bNodeTreeType), "node tree type"); nt = MEM_callocN(sizeof(bNodeTreeType), "node tree type");
@@ -1399,9 +1396,6 @@ static bNodeType *rna_Node_register_base(Main *bmain, ReportList *reports, Struc
if (nt) { if (nt) {
rna_Node_unregister(bmain, nt->ext.srna); rna_Node_unregister(bmain, nt->ext.srna);
} }
if (!RNA_struct_available_or_report(reports, dummynt.idname)) {
return NULL;
}
/* create a new node type */ /* create a new node type */
nt = MEM_callocN(sizeof(bNodeType), "node type"); nt = MEM_callocN(sizeof(bNodeType), "node type");

3
source/blender/makesrna/intern/rna_render.c
View File

@@ -321,9 +321,6 @@ static StructRNA *rna_RenderEngine_register(Main *bmain, ReportList *reports, vo
break; break;
} }
} }
if (!RNA_struct_available_or_report(reports, dummyet.idname)) {
return NULL;
}
/* create a new engine type */ /* create a new engine type */
et = MEM_callocN(sizeof(RenderEngineType), "python render engine"); et = MEM_callocN(sizeof(RenderEngineType), "python render engine");

10
source/blender/makesrna/intern/rna_rna.c
View File

@@ -983,10 +983,18 @@ static int rna_Function_use_self_type_get(PointerRNA *ptr)
/* Blender RNA */ /* Blender RNA */
static int rna_struct_is_publc(CollectionPropertyIterator *UNUSED(iter), void *data)
{
StructRNA *srna = data;
return !(srna->flag & STRUCT_PUBLIC_NAMESPACE);
}
static void rna_BlenderRNA_structs_begin(CollectionPropertyIterator *iter, PointerRNA *ptr) static void rna_BlenderRNA_structs_begin(CollectionPropertyIterator *iter, PointerRNA *ptr)
{ {
BlenderRNA *brna = ptr->data; BlenderRNA *brna = ptr->data;
rna_iterator_listbase_begin(iter, &brna->structs, NULL); rna_iterator_listbase_begin(iter, &brna->structs, rna_struct_is_publc);
} }
/* optional, for faster lookups */ /* optional, for faster lookups */

5
source/blender/makesrna/intern/rna_ui.c
View File

@@ -949,6 +949,7 @@ static void rna_def_panel(BlenderRNA *brna)
RNA_def_struct_refine_func(srna, "rna_Panel_refine"); RNA_def_struct_refine_func(srna, "rna_Panel_refine");
RNA_def_struct_register_funcs(srna, "rna_Panel_register", "rna_Panel_unregister", NULL); RNA_def_struct_register_funcs(srna, "rna_Panel_register", "rna_Panel_unregister", NULL);
RNA_def_struct_translation_context(srna, BLT_I18NCONTEXT_DEFAULT_BPYRNA); RNA_def_struct_translation_context(srna, BLT_I18NCONTEXT_DEFAULT_BPYRNA);
RNA_def_struct_flag(srna, STRUCT_PUBLIC_NAMESPACE_INHERIT);
/* poll */ /* poll */
func = RNA_def_function(srna, "poll", NULL); func = RNA_def_function(srna, "poll", NULL);
@@ -1051,7 +1052,7 @@ static void rna_def_uilist(BlenderRNA *brna)
RNA_def_struct_refine_func(srna, "rna_UIList_refine"); RNA_def_struct_refine_func(srna, "rna_UIList_refine");
RNA_def_struct_register_funcs(srna, "rna_UIList_register", "rna_UIList_unregister", NULL); RNA_def_struct_register_funcs(srna, "rna_UIList_register", "rna_UIList_unregister", NULL);
RNA_def_struct_idprops_func(srna, "rna_UIList_idprops"); RNA_def_struct_idprops_func(srna, "rna_UIList_idprops");
RNA_def_struct_flag(srna, STRUCT_NO_DATABLOCK_IDPROPERTIES); RNA_def_struct_flag(srna, STRUCT_NO_DATABLOCK_IDPROPERTIES | STRUCT_PUBLIC_NAMESPACE_INHERIT);
/* Registration */ /* Registration */
prop = RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE); prop = RNA_def_property(srna, "bl_idname", PROP_STRING, PROP_NONE);
@@ -1173,6 +1174,7 @@ static void rna_def_header(BlenderRNA *brna)
RNA_def_struct_sdna(srna, "Header"); RNA_def_struct_sdna(srna, "Header");
RNA_def_struct_refine_func(srna, "rna_Header_refine"); RNA_def_struct_refine_func(srna, "rna_Header_refine");
RNA_def_struct_register_funcs(srna, "rna_Header_register", "rna_Header_unregister", NULL); RNA_def_struct_register_funcs(srna, "rna_Header_register", "rna_Header_unregister", NULL);
RNA_def_struct_flag(srna, STRUCT_PUBLIC_NAMESPACE_INHERIT);
/* draw */ /* draw */
func = RNA_def_function(srna, "draw", NULL); func = RNA_def_function(srna, "draw", NULL);
@@ -1220,6 +1222,7 @@ static void rna_def_menu(BlenderRNA *brna)
RNA_def_struct_refine_func(srna, "rna_Menu_refine"); RNA_def_struct_refine_func(srna, "rna_Menu_refine");
RNA_def_struct_register_funcs(srna, "rna_Menu_register", "rna_Menu_unregister", NULL); RNA_def_struct_register_funcs(srna, "rna_Menu_register", "rna_Menu_unregister", NULL);
RNA_def_struct_translation_context(srna, BLT_I18NCONTEXT_DEFAULT_BPYRNA); RNA_def_struct_translation_context(srna, BLT_I18NCONTEXT_DEFAULT_BPYRNA);
RNA_def_struct_flag(srna, STRUCT_PUBLIC_NAMESPACE_INHERIT);
/* poll */ /* poll */
func = RNA_def_function(srna, "poll", NULL); func = RNA_def_function(srna, "poll", NULL);

3
source/blender/makesrna/intern/rna_userdef.c
View File

@@ -641,9 +641,6 @@ static StructRNA *rna_AddonPref_register(Main *bmain, ReportList *reports, void
if (apt && apt->ext.srna) { if (apt && apt->ext.srna) {
rna_AddonPref_unregister(bmain, apt->ext.srna); rna_AddonPref_unregister(bmain, apt->ext.srna);
} }
if (!RNA_struct_available_or_report(reports, identifier)) {
return NULL;
}
/* create a new header type */ /* create a new header type */
apt = MEM_mallocN(sizeof(bAddonPrefType), "addonpreftype"); apt = MEM_mallocN(sizeof(bAddonPrefType), "addonpreftype");

2
source/blender/makesrna/intern/rna_wm.c
View File

@@ -1546,7 +1546,7 @@ static void rna_def_operator(BlenderRNA *brna)
RNA_def_struct_ui_text(srna, "Operator Properties", "Input properties of an Operator"); RNA_def_struct_ui_text(srna, "Operator Properties", "Input properties of an Operator");
RNA_def_struct_refine_func(srna, "rna_OperatorProperties_refine"); RNA_def_struct_refine_func(srna, "rna_OperatorProperties_refine");
RNA_def_struct_idprops_func(srna, "rna_OperatorProperties_idprops"); RNA_def_struct_idprops_func(srna, "rna_OperatorProperties_idprops");
RNA_def_struct_flag(srna, STRUCT_NO_DATABLOCK_IDPROPERTIES); RNA_def_struct_flag(srna, STRUCT_NO_DATABLOCK_IDPROPERTIES | STRUCT_PUBLIC_NAMESPACE_INHERIT);
} }
static void rna_def_macro_operator(BlenderRNA *brna) static void rna_def_macro_operator(BlenderRNA *brna)

2
source/blender/python/intern/bpy_operator_wrap.c
View File

@@ -53,7 +53,7 @@ static void operator_properties_init(wmOperatorType *ot)
* *
* Note the 'no_struct_map' function is used since the actual struct name is already used by the operator. * Note the 'no_struct_map' function is used since the actual struct name is already used by the operator.
*/ */
RNA_def_struct_identifier_no_struct_map(ot->srna, ot->idname); RNA_def_struct_identifier(&BLENDER_RNA, ot->srna, ot->idname);
if (pyrna_deferred_register_class(ot->srna, py_class) != 0) { if (pyrna_deferred_register_class(ot->srna, py_class) != 0) {
PyErr_Print(); /* failed to register operator props */ PyErr_Print(); /* failed to register operator props */

10
source/blender/python/intern/bpy_rna.c
View File

@@ -6927,15 +6927,7 @@ static PyObject *pyrna_basetype_dir(BPy_BaseTypeRNA *self)
RNA_PROP_BEGIN (&self->ptr, itemptr, self->prop) RNA_PROP_BEGIN (&self->ptr, itemptr, self->prop)
{ {
StructRNA *srna = itemptr.data; StructRNA *srna = itemptr.data;
StructRNA *srna_base = RNA_struct_base(itemptr.data); PyList_APPEND(ret, PyUnicode_FromString(RNA_struct_identifier(srna)));
/* skip own operators, these double up [#29666] */
if (srna_base == &RNA_Operator) {
/* do nothing */
}
else {
/* add to python list */
PyList_APPEND(ret, PyUnicode_FromString(RNA_struct_identifier(srna)));
}
} }
RNA_PROP_END; RNA_PROP_END;