ilusha/blender
1
0
Fork 0
mirror of https://github.com/blender/blender synced 2026-09-29 04:37:17 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions

Refactor: UI: Use std::function for ID template callbacks

Browse source 
This replaces all `button_funcN_set` callbacks in `interface_template_id.cc`
with `button_func_set` callbacks which uses `std::function` that are
more type safe.
Also this sets id lookup values as button context to avoid using void
pointers.

Pull Request: https://projects.blender.org/blender/blender/pulls/157488
This commit is contained in:
Guillermo Venegas 2026-05-14 15:01:15 +02:00 • committed by Guillermo Venegas
parent 3081bf63ee
commit decc6161df
2 changed files with 155 additions and 209 deletions
Download patch file Download diff file Expand all files Collapse all files

4
source/blender/editors/interface/interface_context_menu.cc
View file

@ -1053,9 +1053,7 @@ bool popup_context_menu_for_button(bContext *C, Button *but, const wmEvent *even
/* Expose id specific operators in context menu when button has no operator associated. Otherwise
* they would appear in nested context menus, see: #126006. */
if ((but->optype == nullptr) && (but->apply_func == nullptr) &&
(but->menu_create_func == nullptr))
{
if ((but->optype == nullptr) && (but->menu_create_func == nullptr)) {
/* If the button represents an id, it can set the "id" context pointer. */
if (ed::asset::can_mark_single_from_context(C)) {
const ID *id = static_cast<const ID *>(CTX_data_pointer_get_type(C, "id", RNA_ID).data);

360
source/blender/editors/interface/templates/interface_template_id.cc
View file

@ -48,21 +48,14 @@
namespace blender::ui {
enum {
UI_ID_NOP = 0,
UI_ID_RENAME = 1 << 0,
UI_ID_BROWSE = 1 << 1,
UI_ID_ADD_NEW = 1 << 2,
UI_ID_ALONE = 1 << 4,
UI_ID_OPEN = 1 << 3,
UI_ID_DELETE = 1 << 5,
UI_ID_LOCAL = 1 << 6,
UI_ID_AUTO_NAME = 1 << 7,
UI_ID_FAKE_USER = 1 << 8,
UI_ID_PIN = 1 << 9,
UI_ID_PREVIEWS = 1 << 10,
UI_ID_OVERRIDE = 1 << 11,
UI_ID_FULL = UI_ID_RENAME | UI_ID_BROWSE | UI_ID_ADD_NEW | UI_ID_OPEN | UI_ID_ALONE |
UI_ID_DELETE | UI_ID_LOCAL,
UI_ID_DELETE = 1 << 4,
UI_ID_PIN = 1 << 6,
UI_ID_PREVIEWS = 1 << 7,
UI_ID_FULL = UI_ID_RENAME | UI_ID_BROWSE | UI_ID_ADD_NEW | UI_ID_OPEN | UI_ID_DELETE,
};
struct TemplateID {
@ -318,8 +311,6 @@ static Block *id_search_menu_session_uid(bContext *C, ARegion *region, void *arg
template_ui.scale);
}
static void template_id_cb(bContext *C, void *arg_litem, void *arg_event);
void context_active_but_prop_get_templateID(const bContext *C,
PointerRNA *r_ptr,
PropertyRNA **r_prop)
@ -328,12 +319,31 @@ void context_active_but_prop_get_templateID(const bContext *C,
*r_ptr = {};
*r_prop = nullptr;
if (but && (but->funcN == template_id_cb) && but->func_argN) {
TemplateID *template_ui = static_cast<TemplateID *>(but->func_argN);
*r_ptr = template_ui->ptr;
*r_prop = template_ui->prop;
if (!but || !but->context) {
return;
}
const PointerRNA *ptr = CTX_store_ptr_lookup(but->context, "template_id_ptr");
std::optional<StringRefNull> prop_name = CTX_store_string_lookup(but->context,
"template_id_prop");
if (!ptr || !prop_name) {
return;
}
PointerRNA ptr_copy = *ptr;
PropertyRNA *prop = RNA_struct_find_property(&ptr_copy, prop_name->c_str());
if (!prop || RNA_property_type(prop) != PROP_POINTER) {
return;
}
StructRNA *type = RNA_property_pointer_type(&ptr_copy, prop);
if (!type || !RNA_struct_is_ID(type)) {
return;
}
*r_ptr = std::move(ptr_copy);
*r_prop = prop;
}
static void template_id_liboverride_hierarchy_collection_root_find_recursive(
@ -715,133 +725,115 @@ static void template_id_liboverride_hierarchy_make(bContext *C,
}
}
static void template_id_cb(bContext *C, void *arg_litem, void *arg_event)
static void template_ui_delete(bContext &C, TemplateID &template_ui)
{
TemplateID *template_ui = static_cast<TemplateID *>(arg_litem);
PointerRNA idptr = RNA_property_pointer_get(&template_ui->ptr, template_ui->prop);
PointerRNA idptr = RNA_property_pointer_get(&template_ui.ptr, template_ui.prop);
ID *id = static_cast<ID *>(idptr.data);
const int event = POINTER_AS_INT(arg_event);
const char *undo_push_label;
idptr = {};
RNA_property_pointer_set(&template_ui.ptr, template_ui.prop, idptr, nullptr);
RNA_property_update(&C, &template_ui.ptr, template_ui.prop);
if (id && CTX_wm_window(&C)->runtime->eventstate->modifier & KM_SHIFT) {
/* only way to force-remove data (on save) */
id_us_clear_real(id);
id_fake_user_clear(id);
id->us = 0;
undo_push_label = CTX_N_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Delete Data-Block");
}
else {
undo_push_label = CTX_N_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Unlink Data-Block");
}
ED_undo_push(&C, undo_push_label);
WM_event_add_notifier(&C, NC_SPACE | ND_SPACE_OUTLINER, nullptr);
}
static void template_ui_make_local(bContext &C, TemplateID &template_ui)
{
PointerRNA idptr = RNA_property_pointer_get(&template_ui.ptr, template_ui.prop);
ID *id = static_cast<ID *>(idptr.data);
const char *undo_push_label = nullptr;
switch (event) {
case UI_ID_NOP:
/* Don't do anything, typically set for buttons that execute an operator instead. They may
* still assign the callback so the button can be identified as part of an ID-template. See
* #context_active_but_prop_get_templateID(). */
break;
case UI_ID_RENAME:
/* Only for the undo push. */
undo_push_label = CTX_N_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Rename Data-Block");
break;
case UI_ID_BROWSE:
case UI_ID_PIN:
RNA_warning("warning, id event %d shouldn't come here", event);
break;
case UI_ID_OPEN:
case UI_ID_ADD_NEW:
/* these call context_active_but_prop_get_templateID */
break;
case UI_ID_DELETE:
idptr = {};
RNA_property_pointer_set(&template_ui->ptr, template_ui->prop, idptr, nullptr);
RNA_property_update(C, &template_ui->ptr, template_ui->prop);
if (id && CTX_wm_window(C)->runtime->eventstate->modifier & KM_SHIFT) {
/* only way to force-remove data (on save) */
id_us_clear_real(id);
id_fake_user_clear(id);
id->us = 0;
undo_push_label = CTX_N_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Delete Data-Block");
}
else {
undo_push_label = CTX_N_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Unlink Data-Block");
}
break;
case UI_ID_FAKE_USER:
if (id) {
if (id->flag & ID_FLAG_FAKEUSER) {
id_us_plus(id);
}
else {
id_us_min(id);
}
undo_push_label = CTX_N_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Fake User");
}
else {
return;
}
break;
case UI_ID_LOCAL:
if (id) {
Main *bmain = CTX_data_main(C);
if (CTX_wm_window(C)->runtime->eventstate->modifier & KM_SHIFT) {
template_id_liboverride_hierarchy_make(C, bmain, template_ui, &idptr, &undo_push_label);
}
else {
if (BKE_lib_id_make_local(bmain, id, LIB_ID_MAKELOCAL_ASSET_DATA_CLEAR)) {
BKE_id_newptr_and_tag_clear(id);
/* Reassign to get proper updates/notifiers. */
idptr = RNA_property_pointer_get(&template_ui->ptr, template_ui->prop);
undo_push_label = CTX_N_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Make Local");
}
}
if (undo_push_label != nullptr) {
RNA_property_pointer_set(&template_ui->ptr, template_ui->prop, idptr, nullptr);
RNA_property_update(C, &template_ui->ptr, template_ui->prop);
}
}
break;
case UI_ID_OVERRIDE:
if (id && ID_IS_OVERRIDE_LIBRARY(id)) {
Main *bmain = CTX_data_main(C);
if (CTX_wm_window(C)->runtime->eventstate->modifier & KM_SHIFT) {
template_id_liboverride_hierarchy_make(C, bmain, template_ui, &idptr, &undo_push_label);
}
else {
BKE_lib_override_library_make_local(bmain, id);
/* Reassign to get proper updates/notifiers. */
idptr = RNA_property_pointer_get(&template_ui->ptr, template_ui->prop);
RNA_property_pointer_set(&template_ui->ptr, template_ui->prop, idptr, nullptr);
RNA_property_update(C, &template_ui->ptr, template_ui->prop);
undo_push_label = CTX_N_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Make Local");
}
}
break;
case UI_ID_ALONE:
if (id) {
const bool do_scene_obj = ((GS(id->name) == ID_OB) &&
(template_ui->ptr.type == RNA_LayerObjects));
/* make copy */
if (do_scene_obj) {
Main *bmain = CTX_data_main(C);
Scene *scene = CTX_data_scene(C);
ed::object::object_single_user_make(bmain, scene, id_cast<Object *>(id));
WM_event_add_notifier(C, NC_WINDOW, nullptr);
DEG_relations_tag_update(bmain);
}
else {
Main *bmain = CTX_data_main(C);
id_single_user(C, id, &template_ui->ptr, template_ui->prop);
WM_event_add_notifier(C, NC_SPACE | ND_SPACE_OUTLINER, nullptr);
DEG_relations_tag_update(bmain);
}
BKE_main_ensure_invariants(*CTX_data_main(C));
undo_push_label = CTX_N_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Make Single User");
}
break;
#if 0
case UI_ID_AUTO_NAME:
break;
#endif
if (!id) {
return;
}
if (undo_push_label != nullptr) {
ED_undo_push(C, undo_push_label);
WM_event_add_notifier(C, NC_SPACE | ND_SPACE_OUTLINER, nullptr);
Main *bmain = CTX_data_main(&C);
if (CTX_wm_window(&C)->runtime->eventstate->modifier & KM_SHIFT) {
template_id_liboverride_hierarchy_make(&C, bmain, &template_ui, &idptr, &undo_push_label);
}
else {
if (BKE_lib_id_make_local(bmain, id, LIB_ID_MAKELOCAL_ASSET_DATA_CLEAR)) {
BKE_id_newptr_and_tag_clear(id);
/* Reassign to get proper updates/notifiers. */
idptr = RNA_property_pointer_get(&template_ui.ptr, template_ui.prop);
}
}
if (undo_push_label) {
RNA_property_pointer_set(&template_ui.ptr, template_ui.prop, idptr, nullptr);
RNA_property_update(&C, &template_ui.ptr, template_ui.prop);
ED_undo_push(&C, undo_push_label);
WM_event_add_notifier(&C, NC_SPACE | ND_SPACE_OUTLINER, nullptr);
}
}
static void template_ui_override(bContext &C, TemplateID &template_ui)
{
PointerRNA idptr = RNA_property_pointer_get(&template_ui.ptr, template_ui.prop);
ID *id = static_cast<ID *>(idptr.data);
const char *undo_push_label;
if (!(id && ID_IS_OVERRIDE_LIBRARY(id))) {
return;
}
Main *bmain = CTX_data_main(&C);
if (CTX_wm_window(&C)->runtime->eventstate->modifier & KM_SHIFT) {
template_id_liboverride_hierarchy_make(&C, bmain, &template_ui, &idptr, &undo_push_label);
}
else {
BKE_lib_override_library_make_local(bmain, id);
/* Reassign to get proper updates/notifiers. */
idptr = RNA_property_pointer_get(&template_ui.ptr, template_ui.prop);
RNA_property_pointer_set(&template_ui.ptr, template_ui.prop, idptr, nullptr);
RNA_property_update(&C, &template_ui.ptr, template_ui.prop);
ED_undo_push(&C, CTX_N_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Make Local"));
WM_event_add_notifier(&C, NC_SPACE | ND_SPACE_OUTLINER, nullptr);
}
}
static void template_ui_alone(bContext &C, TemplateID &template_ui)
{
PointerRNA idptr = RNA_property_pointer_get(&template_ui.ptr, template_ui.prop);
ID *id = static_cast<ID *>(idptr.data);
if (!id) {
return;
}
const bool do_scene_obj = ((GS(id->name) == ID_OB) &&
(template_ui.ptr.type == RNA_LayerObjects));
/* make copy */
if (do_scene_obj) {
Main *bmain = CTX_data_main(&C);
Scene *scene = CTX_data_scene(&C);
ed::object::object_single_user_make(bmain, scene, id_cast<Object *>(id));
WM_event_add_notifier(&C, NC_WINDOW, nullptr);
DEG_relations_tag_update(bmain);
}
else {
Main *bmain = CTX_data_main(&C);
id_single_user(&C, id, &template_ui.ptr, template_ui.prop);
WM_event_add_notifier(&C, NC_SPACE | ND_SPACE_OUTLINER, nullptr);
DEG_relations_tag_update(bmain);
}
BKE_main_ensure_invariants(*CTX_data_main(&C));
ED_undo_push(&C, CTX_N_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Make Single User"));
WM_event_add_notifier(&C, NC_SPACE | ND_SPACE_OUTLINER, nullptr);
}
static StringRef template_id_browse_tip(const StructRNA *type)
@ -1039,22 +1031,10 @@ static Button *template_id_def_new_but(Block *block,
w,
but_height,
std::nullopt);
button_funcN_set(but,
template_id_cb,
MEM_new<TemplateID>(__func__, template_ui),
POINTER_FROM_INT(UI_ID_ADD_NEW),
but_func_argN_free<TemplateID>,
but_func_argN_copy<TemplateID>);
}
else {
but = uiDefIconTextBut(
block, but_type, icon, button_text, 0, 0, w, but_height, nullptr, std::nullopt);
button_funcN_set(but,
template_id_cb,
MEM_new<TemplateID>(__func__, template_ui),
POINTER_FROM_INT(UI_ID_ADD_NEW),
but_func_argN_free<TemplateID>,
but_func_argN_copy<TemplateID>);
}
if ((idfrom && !ID_IS_EDITABLE(idfrom)) || !editable) {
@ -1091,6 +1071,8 @@ static void template_ID(const bContext *C,
/* Allow operators to take the ID from context. */
layout.context_ptr_set("id", &idptr);
layout.context_ptr_set("template_id_ptr", &template_ui.ptr);
layout.context_string_set("template_id_prop", RNA_property_identifier(template_ui.prop));
Block *block = layout.block();
block_align_begin(block);
@ -1149,19 +1131,18 @@ static void template_ID(const bContext *C,
0,
0,
RNA_struct_ui_description(type));
/* Handle undo through the #template_id_cb set below. Default undo handling from the button
/* Handle undo through the #button_func_set set below. Default undo handling from the button
* code (see #ui_apply_but_undo) would not work here, as the new name is not yet applied to the
* ID. */
button_flag_disable(but, BUT_UNDO);
Main *bmain = CTX_data_main(C);
button_func_rename_full_set(
but, [bmain, id](std::string &new_name) { ED_id_rename(*bmain, *id, new_name); });
button_funcN_set(but,
template_id_cb,
MEM_new<TemplateID>(__func__, template_ui),
POINTER_FROM_INT(UI_ID_RENAME),
but_func_argN_free<TemplateID>,
but_func_argN_copy<TemplateID>);
button_func_set(but, [](bContext &C) {
ED_undo_push(&C, CTX_N_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Rename Data-Block"));
WM_event_add_notifier(&C, NC_SPACE | ND_SPACE_OUTLINER, nullptr);
});
if (user_alert) {
button_flag_enable(but, BUT_REDALERT);
}
@ -1233,12 +1214,9 @@ static void template_ID(const bContext *C,
"object instead, or make the object data local."));
}
else {
button_funcN_set(but,
template_id_cb,
MEM_new<TemplateID>(__func__, template_ui),
POINTER_FROM_INT(UI_ID_LOCAL),
but_func_argN_free<TemplateID>,
but_func_argN_copy<TemplateID>);
button_func_set(but, [template_ui = template_ui](bContext &C) mutable {
template_ui_make_local(C, template_ui);
});
}
}
else if (ID_IS_OVERRIDE_LIBRARY(id)) {
@ -1255,12 +1233,9 @@ static void template_ID(const bContext *C,
0,
TIP_("Library override of linked data-block, click to make fully local, "
"Shift + Click to clear the library override and toggle if it can be edited"));
button_funcN_set(but,
template_id_cb,
MEM_new<TemplateID>(__func__, template_ui),
POINTER_FROM_INT(UI_ID_OVERRIDE),
but_func_argN_free<TemplateID>,
but_func_argN_copy<TemplateID>);
button_func_set(but, [template_ui = template_ui](bContext &C) mutable {
template_ui_override(C, template_ui);
});
}
}
@ -1283,13 +1258,10 @@ static void template_ID(const bContext *C,
0,
TIP_("Display number of users of this data (click to make a single-user copy)"));
but->flag |= BUT_UNDO;
button_func_set(but, [template_ui = template_ui](bContext &C) mutable {
template_ui_alone(C, template_ui);
});
button_funcN_set(but,
template_id_cb,
MEM_new<TemplateID>(__func__, template_ui),
POINTER_FROM_INT(UI_ID_ALONE),
but_func_argN_free<TemplateID>,
but_func_argN_copy<TemplateID>);
if (!BKE_id_copy_is_allowed(id) || (idfrom && !ID_IS_EDITABLE(idfrom)) || (!editable) ||
/* object in editmode - don't change data */
(idfrom && GS(idfrom->name) == ID_OB &&
@ -1386,12 +1358,6 @@ static void template_ID(const bContext *C,
w,
UI_UNIT_Y,
std::nullopt);
button_funcN_set(but,
template_id_cb,
MEM_new<TemplateID>(__func__, template_ui),
POINTER_FROM_INT(UI_ID_OPEN),
but_func_argN_free<TemplateID>,
but_func_argN_copy<TemplateID>);
}
else {
but = uiDefIconTextBut(block,
@ -1404,12 +1370,6 @@ static void template_ID(const bContext *C,
UI_UNIT_Y,
nullptr,
std::nullopt);
button_funcN_set(but,
template_id_cb,
MEM_new<TemplateID>(__func__, template_ui),
POINTER_FROM_INT(UI_ID_OPEN),
but_func_argN_free<TemplateID>,
but_func_argN_copy<TemplateID>);
}
if ((idfrom && !ID_IS_EDITABLE(idfrom)) || !editable) {
@ -1435,12 +1395,6 @@ static void template_ID(const bContext *C,
UI_UNIT_Y,
std::nullopt);
/* so we can access the template from operators, font unlinking needs this */
button_funcN_set(but,
template_id_cb,
MEM_new<TemplateID>(__func__, template_ui),
POINTER_FROM_INT(UI_ID_NOP),
but_func_argN_free<TemplateID>,
but_func_argN_copy<TemplateID>);
}
else {
if ((RNA_property_flag(template_ui.prop) & PROP_NEVER_UNLINK) == 0) {
@ -1457,12 +1411,9 @@ static void template_ID(const bContext *C,
0,
TIP_("Unlink data-block "
"(Shift + Click to set users to zero, data will then not be saved)"));
button_funcN_set(but,
template_id_cb,
MEM_new<TemplateID>(__func__, template_ui),
POINTER_FROM_INT(UI_ID_DELETE),
but_func_argN_free<TemplateID>,
but_func_argN_copy<TemplateID>);
button_func_set(but, [template_ui = template_ui](bContext &C) mutable {
template_ui_delete(C, template_ui);
});
if (RNA_property_flag(template_ui.prop) & PROP_NEVER_NULL) {
button_flag_enable(but, BUT_DISABLED);
@ -1533,12 +1484,9 @@ static void template_ID_tabs(const bContext *C,
0.0f,
sizeof(id->name) - 2,
""));
button_funcN_set(tab,
template_ID_set_property_exec_fn,
MEM_new<TemplateID>(__func__, template_id),
id,
but_func_argN_free<TemplateID>,
but_func_argN_copy<TemplateID>);
button_func_set(tab, [id = id, template_ui = template_id](bContext &C) mutable {
template_ID_set_property_exec_fn(&C, &template_ui, id);
});
button_drag_set_id(tab, id);
tab->custom_data = static_cast<void *>(id);
tab->menu = mt;