Merge pull request #89588 from bruvzg/status_ind_menu_direct

[StatusIndicator] Switch API to use Texture2D instead of Image, improve handling on macOS, add method to set native popup menu directly.

6 files changed, 70 insertions, 61 deletions

diff --git a/platform/macos/display_server_macos.h b/platform/macos/display_server_macos.h
index 5d38bf55ea..083e9731c9 100644
--- a/platform/macos/display_server_macos.h
+++ b/platform/macos/display_server_macos.h
@@ -192,7 +192,7 @@ private:
 	HashMap<WindowID, WindowData> windows;
 
 	struct IndicatorData {
-		id view;
+		id delegate;
 		id item;
 	};
 
@@ -431,9 +431,10 @@ public:
 	virtual void set_native_icon(const String &p_filename) override;
 	virtual void set_icon(const Ref<Image> &p_icon) override;
 
-	virtual IndicatorID create_status_indicator(const Ref<Image> &p_icon, const String &p_tooltip, const Callable &p_callback) override;
-	virtual void status_indicator_set_icon(IndicatorID p_id, const Ref<Image> &p_icon) override;
+	virtual IndicatorID create_status_indicator(const Ref<Texture2D> &p_icon, const String &p_tooltip, const Callable &p_callback) override;
+	virtual void status_indicator_set_icon(IndicatorID p_id, const Ref<Texture2D> &p_icon) override;
 	virtual void status_indicator_set_tooltip(IndicatorID p_id, const String &p_tooltip) override;
+	virtual void status_indicator_set_menu(IndicatorID p_id, const RID &p_menu_rid) override;
 	virtual void status_indicator_set_callback(IndicatorID p_id, const Callable &p_callback) override;
 	virtual void delete_status_indicator(IndicatorID p_id) override;
 
diff --git a/platform/macos/display_server_macos.mm b/platform/macos/display_server_macos.mm
index 6461f50818..5e48602da4 100644
--- a/platform/macos/display_server_macos.mm
+++ b/platform/macos/display_server_macos.mm
@@ -3151,10 +3151,11 @@ void DisplayServerMacOS::set_icon(const Ref<Image> &p_icon) {
 	}
 }
 
-DisplayServer::IndicatorID DisplayServerMacOS::create_status_indicator(const Ref<Image> &p_icon, const String &p_tooltip, const Callable &p_callback) {
+DisplayServer::IndicatorID DisplayServerMacOS::create_status_indicator(const Ref<Texture2D> &p_icon, const String &p_tooltip, const Callable &p_callback) {
 	NSImage *nsimg = nullptr;
 	if (p_icon.is_valid() && p_icon->get_width() > 0 && p_icon->get_height() > 0) {
-		Ref<Image> img = p_icon->duplicate();
+		Ref<Image> img = p_icon->get_image();
+		img = img->duplicate();
 		img->convert(Image::FORMAT_RGBA8);
 
 		NSBitmapImageRep *imgrep = [[NSBitmapImageRep alloc]
@@ -3192,13 +3193,18 @@ DisplayServer::IndicatorID DisplayServerMacOS::create_status_indicator(const Ref
 
 	IndicatorData idat;
 
-	idat.item = [[NSStatusBar systemStatusBar] statusItemWithLength:NSSquareStatusItemLength];
-	idat.view = [[GodotStatusItemView alloc] init];
+	NSStatusItem *item = [[NSStatusBar systemStatusBar] statusItemWithLength:NSSquareStatusItemLength];
+	idat.item = item;
+	idat.delegate = [[GodotStatusItemDelegate alloc] init];
+	[idat.delegate setCallback:p_callback];
 
-	[idat.view setToolTip:[NSString stringWithUTF8String:p_tooltip.utf8().get_data()]];
-	[idat.view setImage:nsimg];
-	[idat.view setCallback:p_callback];
-	[idat.item setView:idat.view];
+	item.button.image = nsimg;
+	item.button.imagePosition = NSImageOnly;
+	item.button.imageScaling = NSImageScaleProportionallyUpOrDown;
+	item.button.target = idat.delegate;
+	item.button.action = @selector(click:);
+	[item.button sendActionOn:(NSEventMaskLeftMouseDown | NSEventMaskRightMouseDown | NSEventMaskOtherMouseDown)];
+	item.button.toolTip = [NSString stringWithUTF8String:p_tooltip.utf8().get_data()];
 
 	IndicatorID iid = indicator_id_counter++;
 	indicators[iid] = idat;
@@ -3206,12 +3212,13 @@ DisplayServer::IndicatorID DisplayServerMacOS::create_status_indicator(const Ref
 	return iid;
 }
 
-void DisplayServerMacOS::status_indicator_set_icon(IndicatorID p_id, const Ref<Image> &p_icon) {
+void DisplayServerMacOS::status_indicator_set_icon(IndicatorID p_id, const Ref<Texture2D> &p_icon) {
 	ERR_FAIL_COND(!indicators.has(p_id));
 
 	NSImage *nsimg = nullptr;
 	if (p_icon.is_valid() && p_icon->get_width() > 0 && p_icon->get_height() > 0) {
-		Ref<Image> img = p_icon->duplicate();
+		Ref<Image> img = p_icon->get_image();
+		img = img->duplicate();
 		img->convert(Image::FORMAT_RGBA8);
 
 		NSBitmapImageRep *imgrep = [[NSBitmapImageRep alloc]
@@ -3247,19 +3254,33 @@ void DisplayServerMacOS::status_indicator_set_icon(IndicatorID p_id, const Ref<I
 		}
 	}
 
-	[indicators[p_id].view setImage:nsimg];
+	NSStatusItem *item = indicators[p_id].item;
+	item.button.image = nsimg;
 }
 
 void DisplayServerMacOS::status_indicator_set_tooltip(IndicatorID p_id, const String &p_tooltip) {
 	ERR_FAIL_COND(!indicators.has(p_id));
 
-	[indicators[p_id].view setToolTip:[NSString stringWithUTF8String:p_tooltip.utf8().get_data()]];
+	NSStatusItem *item = indicators[p_id].item;
+	item.button.toolTip = [NSString stringWithUTF8String:p_tooltip.utf8().get_data()];
+}
+
+void DisplayServerMacOS::status_indicator_set_menu(IndicatorID p_id, const RID &p_menu_rid) {
+	ERR_FAIL_COND(!indicators.has(p_id));
+
+	NSStatusItem *item = indicators[p_id].item;
+	if (p_menu_rid.is_valid() && native_menu->has_menu(p_menu_rid)) {
+		NSMenu *menu = native_menu->get_native_menu_handle(p_menu_rid);
+		item.menu = menu;
+	} else {
+		item.menu = nullptr;
+	}
 }
 
 void DisplayServerMacOS::status_indicator_set_callback(IndicatorID p_id, const Callable &p_callback) {
 	ERR_FAIL_COND(!indicators.has(p_id));
 
-	[indicators[p_id].view setCallback:p_callback];
+	[indicators[p_id].delegate setCallback:p_callback];
 }
 
 void DisplayServerMacOS::delete_status_indicator(IndicatorID p_id) {
diff --git a/platform/macos/godot_status_item.h b/platform/macos/godot_status_item.h
index 1827baa9bd..5bc790956e 100644
--- a/platform/macos/godot_status_item.h
+++ b/platform/macos/godot_status_item.h
@@ -37,13 +37,12 @@
 #import <AppKit/AppKit.h>
 #import <Foundation/Foundation.h>
 
-@interface GodotStatusItemView : NSView {
-	NSImage *image;
+@interface GodotStatusItemDelegate : NSObject {
 	Callable cb;
 }
 
-- (void)processMouseEvent:(NSEvent *)event index:(MouseButton)index;
-- (void)setImage:(NSImage *)image;
+- (IBAction)click:(id)sender;
+
 - (void)setCallback:(const Callable &)callback;
 
 @end
diff --git a/platform/macos/godot_status_item.mm b/platform/macos/godot_status_item.mm
index 71ed0a0f71..0990a16b2b 100644
--- a/platform/macos/godot_status_item.mm
+++ b/platform/macos/godot_status_item.mm
@@ -32,30 +32,32 @@
 
 #include "display_server_macos.h"
 
-@implementation GodotStatusItemView
+@implementation GodotStatusItemDelegate
 
 - (id)init {
 	self = [super init];
-	image = nullptr;
 	return self;
 }
 
-- (void)setImage:(NSImage *)newImage {
-	image = newImage;
-	[self setNeedsDisplayInRect:self.frame];
-}
-
-- (void)setCallback:(const Callable &)callback {
-	cb = callback;
-}
-
-- (void)drawRect:(NSRect)rect {
-	if (image) {
-		[image drawInRect:rect];
+- (IBAction)click:(id)sender {
+	NSEvent *current_event = [NSApp currentEvent];
+	MouseButton index = MouseButton::LEFT;
+	if (current_event) {
+		if (current_event.type == NSEventTypeLeftMouseDown) {
+			index = MouseButton::LEFT;
+		} else if (current_event.type == NSEventTypeRightMouseDown) {
+			index = MouseButton::RIGHT;
+		} else if (current_event.type == NSEventTypeOtherMouseDown) {
+			if ((int)[current_event buttonNumber] == 2) {
+				index = MouseButton::MIDDLE;
+			} else if ((int)[current_event buttonNumber] == 3) {
+				index = MouseButton::MB_XBUTTON1;
+			} else if ((int)[current_event buttonNumber] == 4) {
+				index = MouseButton::MB_XBUTTON2;
+			}
+		}
 	}
-}
 
-- (void)processMouseEvent:(NSEvent *)event index:(MouseButton)index {
 	DisplayServerMacOS *ds = (DisplayServerMacOS *)DisplayServer::get_singleton();
 	if (!ds) {
 		return;
@@ -71,31 +73,8 @@
 	}
 }
 
-- (void)mouseDown:(NSEvent *)event {
-	[super mouseDown:event];
-	if (([event modifierFlags] & NSEventModifierFlagControl)) {
-		[self processMouseEvent:event index:MouseButton::RIGHT];
-	} else {
-		[self processMouseEvent:event index:MouseButton::LEFT];
-	}
-}
-
-- (void)rightMouseDown:(NSEvent *)event {
-	[super rightMouseDown:event];
-
-	[self processMouseEvent:event index:MouseButton::RIGHT];
-}
-
-- (void)otherMouseDown:(NSEvent *)event {
-	[super otherMouseDown:event];
-
-	if ((int)[event buttonNumber] == 2) {
-		[self processMouseEvent:event index:MouseButton::MIDDLE];
-	} else if ((int)[event buttonNumber] == 3) {
-		[self processMouseEvent:event index:MouseButton::MB_XBUTTON1];
-	} else if ((int)[event buttonNumber] == 4) {
-		[self processMouseEvent:event index:MouseButton::MB_XBUTTON2];
-	}
+- (void)setCallback:(const Callable &)callback {
+	cb = callback;
 }
 
 @end
diff --git a/platform/macos/native_menu_macos.h b/platform/macos/native_menu_macos.h
index 1d9feb64a7..b5dbb8b9b0 100644
--- a/platform/macos/native_menu_macos.h
+++ b/platform/macos/native_menu_macos.h
@@ -85,6 +85,8 @@ public:
 	virtual bool has_menu(const RID &p_rid) const override;
 	virtual void free_menu(const RID &p_rid) override;
 
+	NSMenu *get_native_menu_handle(const RID &p_rid);
+
 	virtual Size2 get_size(const RID &p_rid) const override;
 	virtual void popup(const RID &p_rid, const Vector2i &p_position) override;
 
diff --git a/platform/macos/native_menu_macos.mm b/platform/macos/native_menu_macos.mm
index 8c2dd98862..1cf13a2d69 100644
--- a/platform/macos/native_menu_macos.mm
+++ b/platform/macos/native_menu_macos.mm
@@ -248,6 +248,13 @@ void NativeMenuMacOS::free_menu(const RID &p_rid) {
 	}
 }
 
+NSMenu *NativeMenuMacOS::get_native_menu_handle(const RID &p_rid) {
+	MenuData *md = menus.get_or_null(p_rid);
+	ERR_FAIL_NULL_V(md, nullptr);
+
+	return md->menu;
+}
+
 Size2 NativeMenuMacOS::get_size(const RID &p_rid) const {
 	const MenuData *md = menus.get_or_null(p_rid);
 	ERR_FAIL_NULL_V(md, Size2());