UI: internal changes to user-menu storage

- Use per context menu lists to support menu editing.
- Support for different kinds of menu items since this may be needed
  in the future. Only use operator types for now.

3 files changed, 95 insertions, 64 deletions

diff --git a/source/blender/editors/include/ED_screen.h b/source/blender/editors/include/ED_screen.h
index 05b51dff4b4..cb4048ac63e 100644
--- a/source/blender/editors/include/ED_screen.h
+++ b/source/blender/editors/include/ED_screen.h
@@ -315,13 +315,18 @@ int     ED_operator_camera(struct bContext *C);
 
 /* screen_user_menu.c */
 
-void ED_screen_user_menu_add(
-        struct bContext *C, const char *ui_name,
+struct bUserMenu *ED_screen_user_menu_find(struct bContext *C);
+struct bUserMenu *ED_screen_user_menu_ensure(struct bContext *C);
+
+
+struct bUserMenuItem_Op *ED_screen_user_menu_item_find_operator(
+        struct ListBase *lb,
         struct wmOperatorType *ot, struct IDProperty *prop, short opcontext);
-void ED_screen_user_menu_remove(struct bUserMenuItem *umi);
-struct bUserMenuItem *ED_screen_user_menu_find(
-        struct bContext *C,
+void ED_screen_user_menu_item_add_operator(
+        struct ListBase *lb, const char *ui_name,
         struct wmOperatorType *ot, struct IDProperty *prop, short opcontext);
+void ED_screen_user_menu_item_remove(
+        struct ListBase *lb, struct bUserMenuItem *umi);
 void ED_screen_user_menu_register(void);
 
 /* Cache display helpers */
diff --git a/source/blender/editors/interface/interface_context_menu.c b/source/blender/editors/interface/interface_context_menu.c
index fa09b316fb8..f28d80bebe1 100644
--- a/source/blender/editors/interface/interface_context_menu.c
+++ b/source/blender/editors/interface/interface_context_menu.c
@@ -216,13 +216,11 @@ static void popup_add_shortcut_func(bContext *C, void *arg1, void *UNUSED(arg2))
 	UI_popup_block_ex(C, menu_add_shortcut, NULL, menu_add_shortcut_cancel, but, NULL);
 }
 
-static void popup_user_menu_add_or_replace_func(bContext *C, void *arg1, void *arg2)
+static void popup_user_menu_add_or_replace_func(bContext *C, void *arg1, void *UNUSED(arg2))
 {
 	uiBut *but = arg1;
-	bUserMenuItem *umi = arg2;
-	if (umi) {
-		ED_screen_user_menu_remove(umi);
-	}
+	bUserMenu *um = ED_screen_user_menu_ensure(C);
+
 	char drawstr[sizeof(but->drawstr)];
 	STRNCPY(drawstr, but->drawstr);
 	if (but->flag & UI_BUT_HAS_SEP_CHAR) {
@@ -231,13 +229,16 @@ static void popup_user_menu_add_or_replace_func(bContext *C, void *arg1, void *a
 			*sep = '\0';
 		}
 	}
-	ED_screen_user_menu_add(C, drawstr, but->optype, but->opptr ? but->opptr->data : NULL, but->opcontext);
+	ED_screen_user_menu_item_add_operator(
+	        &um->items, drawstr,
+	        but->optype, but->opptr ? but->opptr->data : NULL, but->opcontext);
 }
 
-static void popup_user_menu_remove_func(bContext *UNUSED(C), void *UNUSED(arg1), void *arg2)
+static void popup_user_menu_remove_func(bContext *UNUSED(C), void *arg1, void *arg2)
 {
+	bUserMenu *um = arg1;
 	bUserMenuItem *umi = arg2;
-	ED_screen_user_menu_remove(umi);
+	ED_screen_user_menu_item_remove(&um->items, umi);
 }
 
 static void ui_but_menu_add_path_operators(uiLayout *layout, PointerRNA *ptr, PropertyRNA *prop)
@@ -616,21 +617,24 @@ bool ui_popup_context_menu_for_button(bContext *C, uiBut *but)
 		uiItemS(layout);
 
 		{
-			bUserMenuItem *umi = ED_screen_user_menu_find(
-			        C, but->optype, but->opptr ? but->opptr->data : NULL, but->opcontext);
-
 			but2 = uiDefIconTextBut(
 			        block, UI_BTYPE_BUT, 0, ICON_MENU_PANEL,
 			        CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Add to Favorites Menu"),
 			        0, 0, w, UI_UNIT_Y, NULL, 0, 0, 0, 0,
 			        "Add to a user defined context menu (stored in the user preferences)");
-			UI_but_func_set(but2, popup_user_menu_add_or_replace_func, but, umi);
-			if (umi) {
-				but2 = uiDefIconTextBut(
-				        block, UI_BTYPE_BUT, 0, ICON_CANCEL,
-				        CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Remove from Favorites Menu"),
-				        0, 0, w, UI_UNIT_Y, NULL, 0, 0, 0, 0, "");
-				UI_but_func_set(but2, popup_user_menu_remove_func, NULL, umi);
+			UI_but_func_set(but2, popup_user_menu_add_or_replace_func, but, NULL);
+
+			bUserMenu *um = ED_screen_user_menu_find(C);
+			if (um) {
+				bUserMenuItem_Op *umi_op = ED_screen_user_menu_item_find_operator(
+				        &um->items, but->optype, prop, but->opcontext);
+				if (umi_op != NULL) {
+					but2 = uiDefIconTextBut(
+					        block, UI_BTYPE_BUT, 0, ICON_CANCEL,
+					        CTX_IFACE_(BLT_I18NCONTEXT_OPERATOR_DEFAULT, "Remove from Favorites Menu"),
+					        0, 0, w, UI_UNIT_Y, NULL, 0, 0, 0, 0, "");
+					UI_but_func_set(but2, popup_user_menu_remove_func, um, umi_op);
+				}
 			}
 		}
 
diff --git a/source/blender/editors/screen/screen_user_menu.c b/source/blender/editors/screen/screen_user_menu.c
index 682439f0db3..ab5a3a4008c 100644
--- a/source/blender/editors/screen/screen_user_menu.c
+++ b/source/blender/editors/screen/screen_user_menu.c
@@ -43,6 +43,7 @@
 
 #include "BLT_translation.h"
 
+#include "BKE_blender_user_menu.h"
 #include "BKE_context.h"
 #include "BKE_screen.h"
 #include "BKE_idprop.h"
@@ -56,57 +57,66 @@
 #include "UI_resources.h"
 
 /* -------------------------------------------------------------------- */
-/** \name Utilities
+/** \name Menu Type
  * \{ */
 
-void ED_screen_user_menu_add(
-        bContext *C, const char *ui_name,
-        wmOperatorType *ot, IDProperty *prop, short opcontext)
+bUserMenu *ED_screen_user_menu_find(bContext *C)
 {
 	SpaceLink *sl = CTX_wm_space_data(C);
-	bUserMenuItem *umi = MEM_callocN(sizeof(bUserMenuItem), __func__);
-	umi->space_type = sl ? sl->spacetype : SPACE_EMPTY;
-	umi->opcontext = opcontext;
-	if (!STREQ(ui_name, ot->name)) {
-		BLI_strncpy(umi->ui_name, ui_name, OP_MAX_TYPENAME);
-	}
-	BLI_strncpy(umi->opname, ot->idname, OP_MAX_TYPENAME);
-	BLI_strncpy(umi->context, CTX_data_mode_string(C), OP_MAX_TYPENAME);
-	umi->prop = prop ? IDP_CopyProperty(prop) : NULL;
-	BLI_addtail(&U.user_menu_items, umi);
+	const char *context = CTX_data_mode_string(C);
+	return BKE_blender_user_menu_find(&U.user_menus, sl->spacetype, context);
 }
 
-void ED_screen_user_menu_remove(bUserMenuItem *umi)
+bUserMenu *ED_screen_user_menu_ensure(bContext *C)
 {
-	BLI_remlink(&U.user_menu_items, umi);
-	if (umi->prop) {
-		IDP_FreeProperty(umi->prop);
-		MEM_freeN(umi->prop);
-	}
-	MEM_freeN(umi);
+	SpaceLink *sl = CTX_wm_space_data(C);
+	const char *context = CTX_data_mode_string(C);
+	return BKE_blender_user_menu_ensure(&U.user_menus, sl->spacetype, context);
 }
 
-bUserMenuItem *ED_screen_user_menu_find(
-        bContext *C,
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Menu Item
+ * \{ */
+
+bUserMenuItem_Op *ED_screen_user_menu_item_find_operator(
+        ListBase *lb,
         wmOperatorType *ot, IDProperty *prop, short opcontext)
 {
-	SpaceLink *sl = CTX_wm_space_data(C);
-	const char *context = CTX_data_mode_string(C);
-	for (bUserMenuItem *umi = U.user_menu_items.first; umi; umi = umi->next) {
-		if (STREQ(ot->idname, umi->opname) &&
-		    (opcontext == umi->opcontext) &&
-		    (IDP_EqualsProperties(prop, umi->prop)))
-		{
-			if ((ELEM(umi->space_type, SPACE_TOPBAR) || (sl->spacetype == umi->space_type)) &&
-			    (STREQLEN(context, umi->context, OP_MAX_TYPENAME)))
+	for (bUserMenuItem *umi = lb->first; umi; umi = umi->next) {
+		if (umi->type == USER_MENU_TYPE_OPERATOR) {
+			bUserMenuItem_Op *umi_op = (bUserMenuItem_Op *)umi;
+			if (STREQ(ot->idname, umi_op->opname) &&
+				(opcontext == umi_op->opcontext) &&
+				(IDP_EqualsProperties(prop, umi_op->prop)))
 			{
-				return umi;
+				return umi_op;
 			}
 		}
 	}
 	return NULL;
 }
 
+void ED_screen_user_menu_item_add_operator(
+        ListBase *lb, const char *ui_name,
+        wmOperatorType *ot, IDProperty *prop, short opcontext)
+{
+	bUserMenuItem_Op *umi_op = (bUserMenuItem_Op *)BKE_blender_user_menu_item_add(lb, USER_MENU_TYPE_OPERATOR);
+	umi_op->opcontext = opcontext;
+	if (!STREQ(ui_name, ot->name)) {
+		BLI_strncpy(umi_op->item.ui_name, ui_name, OP_MAX_TYPENAME);
+	}
+	BLI_strncpy(umi_op->opname, ot->idname, OP_MAX_TYPENAME);
+	umi_op->prop = prop ? IDP_CopyProperty(prop) : NULL;
+}
+
+void ED_screen_user_menu_item_remove(ListBase *lb, bUserMenuItem *umi)
+{
+	BLI_remlink(lb, umi);
+	BKE_blender_user_menu_item_free(umi);
+}
+
 /** \} */
 
 /* -------------------------------------------------------------------- */
@@ -117,14 +127,26 @@ static void screen_user_menu_draw(const bContext *C, Menu *menu)
 {
 	SpaceLink *sl = CTX_wm_space_data(C);
 	const char *context = CTX_data_mode_string(C);
-	for (bUserMenuItem *umi = U.user_menu_items.first; umi; umi = umi->next) {
-		if ((ELEM(umi->space_type, SPACE_TOPBAR) || (sl->spacetype == umi->space_type)) &&
-		    (STREQLEN(context, umi->context, OP_MAX_TYPENAME)))
-		{
-			IDProperty *prop = umi->prop ? IDP_CopyProperty(umi->prop) : NULL;
-			uiItemFullO(
-			        menu->layout, umi->opname, umi->ui_name[0] ? umi->ui_name : NULL,
-			        ICON_NONE, prop, umi->opcontext, 0, NULL);
+	bUserMenu *um_array[] = {
+		BKE_blender_user_menu_find(&U.user_menus, sl->spacetype, context),
+		(sl->spacetype != SPACE_TOPBAR) ? BKE_blender_user_menu_find(&U.user_menus, SPACE_TOPBAR, context) : NULL,
+	};
+	for (int um_index = 0; um_index < ARRAY_SIZE(um_array); um_index++) {
+		bUserMenu *um = um_array[um_index];
+		if (um == NULL) {
+			continue;
+		}
+		for (bUserMenuItem *umi = um->items.first; umi; umi = umi->next) {
+			if (umi->type == USER_MENU_TYPE_OPERATOR) {
+				bUserMenuItem_Op *umi_op = (bUserMenuItem_Op *)umi;
+				IDProperty *prop = umi_op->prop ? IDP_CopyProperty(umi_op->prop) : NULL;
+				uiItemFullO(
+				        menu->layout, umi_op->opname, umi->ui_name[0] ? umi->ui_name : NULL,
+				        ICON_NONE, prop, umi_op->opcontext, 0, NULL);
+			}
+			else if (umi->type == USER_MENU_TYPE_SEP) {
+				uiItemS(menu->layout);
+			}
 		}
 	}
 }