feat(macOS): add native elements support for macOS/Skia

src/Uno.UI.Runtime.Skia.MacOS/MacOSMetalRenderer.cs

@@ -15,7 +15,7 @@ internal static class MacOSMetalRenderer
 		// FIXME: contribute some extra API (e.g. using `nint` or `IntPtr`) to SkiaSharp to avoid reflection
 		// net8+ alternative -> https://steven-giesel.com/blogPost/05ecdd16-8dc4-490f-b1cf-780c994346a4
 		var get = typeof(GRContext).GetMethod("GetObject", BindingFlags.Static | BindingFlags.NonPublic);
-		var context = (GRContext?)get?.Invoke(null, new object[] { ctx, true });
+		var context = (GRContext?)get?.Invoke(null, [ctx, true]);
 		if (context is null)
 		{
 			// Macs since 2012 have Metal 2 support and macOS 10.14 Mojave (2018) requires Metal

src/Uno.UI.Runtime.Skia.MacOS/MacOSNativeElementHostingExtension.cs

@@ -0,0 +1,157 @@
+#nullable enable
+
+using Windows.Foundation;
+using Windows.UI.Core;
+using Microsoft.UI.Xaml.Controls;
+
+using Uno.Foundation.Extensibility;
+using Uno.Foundation.Logging;
+
+namespace Uno.UI.Runtime.Skia.MacOS;
+
+internal class MacOSNativeElement : Microsoft.UI.Xaml.FrameworkElement
+{
+	public nint NativeHandle { get; internal set; }
+
+	internal bool Detached { get; set; }
+}
+
+internal class MacOSNativeElementHostingExtension : ContentPresenter.INativeElementHostingExtension
+{
+	private readonly ContentPresenter _presenter;
+	private readonly MacOSWindowNative? _window;
+
+	private MacOSNativeElementHostingExtension(ContentPresenter contentPresenter)
+	{
+		_presenter = contentPresenter;
+		_window = _presenter.XamlRoot?.HostWindow?.NativeWindow as MacOSWindowNative;
+	}
+
+	public static void Register() => ApiExtensibility.Register<ContentPresenter>(typeof(ContentPresenter.INativeElementHostingExtension), o => new MacOSNativeElementHostingExtension(o));
+
+	public void ArrangeNativeElement(object content, Rect arrangeRect, Rect clipRect)
+	{
+		if (content is MacOSNativeElement element)
+		{
+			if (element.Detached)
+			{
+				this.Log().Debug($"Cannot arrange element `{nameof(content)}` of type {content.GetType().FullName} since it was detached.");
+			}
+			else
+			{
+				NativeUno.uno_native_arrange(element.NativeHandle, arrangeRect.Left, arrangeRect.Top, arrangeRect.Width, arrangeRect.Height, clipRect.Left, clipRect.Top, clipRect.Width, clipRect.Height);
+			}
+		}
+		else if (this.Log().IsEnabled(LogLevel.Debug))
+		{
+			this.Log().Debug($"Object `{nameof(content)}` is a {content.GetType().FullName} and not a MacOSNativeElement subclass.");
+		}
+	}
+
+	public void AttachNativeElement(object content)
+	{
+		if (content is MacOSNativeElement element)
+		{
+			NativeUno.uno_native_attach(element.NativeHandle);
+		}
+		else if (this.Log().IsEnabled(LogLevel.Debug))
+		{
+			this.Log().Debug($"Object `{nameof(content)}` is a {content.GetType().FullName} and not a MacOSNativeElement subclass.");
+		}
+	}
+
+	public void ChangeNativeElementOpacity(object content, double opacity)
+	{
+		if (content is MacOSNativeElement element)
+		{
+			// https://developer.apple.com/documentation/appkit/nsview/1483560-alphavalue?language=objc
+			// note: no marshaling needed as CGFloat is double for 64bits apps
+			NativeUno.uno_native_set_opacity(element.NativeHandle, opacity);
+		}
+		else if (this.Log().IsEnabled(LogLevel.Debug))
+		{
+			this.Log().Debug($"Object `{nameof(content)}` is a {content.GetType().FullName} and not a MacOSNativeElement subclass.");
+		}
+	}
+
+	public void ChangeNativeElementVisibility(object content, bool visible)
+	{
+		if (content is MacOSNativeElement element)
+		{
+			// https://developer.apple.com/documentation/appkit/nsview/1483369-hidden?language=objc
+			NativeUno.uno_native_set_visibility(element.NativeHandle, visible);
+		}
+		else if (this.Log().IsEnabled(LogLevel.Debug))
+		{
+			this.Log().Debug($"Object `{nameof(content)}` is a {content.GetType().FullName} and not a MacOSNativeElement subclass.");
+		}
+	}
+
+	public object? CreateSampleComponent(string text)
+	{
+		if (_window is null)
+		{
+			if (this.Log().IsEnabled(LogLevel.Debug))
+			{
+				this.Log().Debug($"CreateSampleComponent failed as no MacOSWindowNative instance could be found.");
+			}
+			return null;
+		}
+
+		var handle = NativeUno.uno_native_create_sample(_window.Handle, text);
+		return new MacOSNativeElement()
+		{
+			NativeHandle = handle,
+			AccessKey = text // FIXME: debug helper, to be removed
+		};
+	}
+
+	public void DetachNativeElement(object content)
+	{
+		if (content is MacOSNativeElement element)
+		{
+			if (element.Detached)
+			{
+				this.Log().Debug($"Object `{nameof(content)}` of type {content.GetType().FullName} was already detached.");
+			}
+			else
+			{
+				NativeUno.uno_native_detach(element.NativeHandle);
+				element.Detached = true;
+			}
+		}
+		else if (this.Log().IsEnabled(LogLevel.Debug))
+		{
+			this.Log().Debug($"Object `{nameof(content)}` is a {content.GetType().FullName} and not a MacOSNativeElement subclass.");
+		}
+	}
+
+	public bool IsNativeElement(object content) => content is MacOSNativeElement;
+
+	public bool IsNativeElementAttached(object owner, object nativeElement)
+	{
+		if (nativeElement is MacOSNativeElement element)
+		{
+			return NativeUno.uno_native_is_attached(element.NativeHandle);
+		}
+		else if (this.Log().IsEnabled(LogLevel.Debug))
+		{
+			this.Log().Debug($"Object `{nameof(owner)}` is a {owner.GetType().FullName} and not a MacOSNativeElement subclass.");
+		}
+		return false;
+	}
+
+	public Size MeasureNativeElement(object content, Size childMeasuredSize, Size availableSize)
+	{
+		if (content is MacOSNativeElement element)
+		{
+			NativeUno.uno_native_measure(element.NativeHandle, childMeasuredSize.Width, childMeasuredSize.Height, availableSize.Width, availableSize.Height, out var width, out var height);
+			return new Size(width, height);
+		}
+		else if (this.Log().IsEnabled(LogLevel.Debug))
+		{
+			this.Log().Debug($"Object `{nameof(content)}` is a {content.GetType().FullName} and not a MacOSNativeElement subclass.");
+		}
+		return Size.Empty;
+	}
+}

src/Uno.UI.Runtime.Skia.MacOS/MacOSWindowHost.cs

@@ -12,11 +12,13 @@
 using Windows.UI.Core;
 using Windows.UI.Input;
 using Microsoft.UI.Xaml;
+using Microsoft.UI.Xaml.Input;
 
 using Window = Microsoft.UI.Xaml.Window;
 
 using Uno.Foundation.Extensibility;
 using Uno.Foundation.Logging;
+using Uno.UI.Helpers;
 using Uno.UI.Hosting;
 
 namespace Uno.UI.Runtime.Skia.MacOS;
@@ -71,7 +73,7 @@ private void UpdateWindowSize(double nativeWidth, double nativeHeight)
 		SizeChanged?.Invoke(this, new Size(nativeWidth, nativeHeight));
 	}
 
-	private void Draw(SKSurface surface)
+	private void Draw(double nativeWidth, double nativeHeight, SKSurface surface)
 	{
 		using var canvas = surface.Canvas;
 		using (new SKAutoCanvasRestore(canvas, true))
@@ -80,7 +82,16 @@ private void Draw(SKSurface surface)
 
 			if (RootElement?.Visual is { } rootVisual)
 			{
-				RootElement.XamlRoot?.Compositor.RenderRootVisual(surface, rootVisual, null);
+				int width = (int)nativeWidth;
+				int height = (int)nativeHeight;
+				var path = SkiaRenderHelper.RenderRootVisualAndReturnPath(width, height, rootVisual, surface);
+				if (path is { })
+				{
+					using var negativePath = new SKPath();
+					negativePath.AddRect(new SKRect(0, 0, width, height));
+					using var diffPath = negativePath.Op(path, SKPathOp.Difference);
+					NativeUno.uno_window_clip_svg(_nativeWindow.Handle, diffPath.ToSvgPathData());
+				}
 			}
 		}
 
@@ -115,7 +126,7 @@ private void MetalDraw(double nativeWidth, double nativeHeight, nint texture)
 
 		surface.Canvas.Scale(scale, scale);
 
-		Draw(surface);
+		Draw(nativeWidth, nativeHeight, surface);
 
 		_context?.Flush();
 	}
@@ -155,7 +166,7 @@ private unsafe void SoftDraw(double nativeWidth, double nativeHeight, nint* data
 			_rowBytes = info.RowBytes;
 		}
 
-		Draw(_surface!);
+		Draw(nativeWidth, nativeHeight, _surface!);
 
 		*data = _bitmap.GetPixels(out var bitmapSize);
 		*size = (int)bitmapSize;
@@ -287,8 +298,7 @@ private static int OnRawKeyDown(nint handle, VirtualKey key, VirtualKeyModifiers
 			}
 			var args = CreateArgs(key, mods, scanCode, unicode);
 			keyDown.Invoke(window!, args);
-			// we tell macOS it's always handled as WinUI does not mark as handled some keys that would make it beep in common cases
-			return 1;
+			return FocusManager.GetFocusedElement() == null ? 0 : 1;
 		}
 		catch (Exception e)
 		{
@@ -315,7 +325,7 @@ private static int OnRawKeyUp(nint handle, VirtualKey key, VirtualKeyModifiers m
 			}
 			var args = CreateArgs(key, mods, scanCode, unicode);
 			keyUp.Invoke(window!, args);
-			return args.Handled ? 1 : 0;
+			return 1;
 		}
 		catch (Exception e)
 		{
@@ -423,8 +433,8 @@ internal static unsafe int OnMouseEvent(nint handle, NativeMouseEventData* data)
 			}
 
 			mouseEvent(window, BuildPointerArgs(*data));
-			// let the window be activated (becoming the keyWindow) when clicked
-			return data->EventType == NativeMouseEvents.Down ? 0 : 1;
+			// always let the native side know about the mouse events, e.g. setting keyWindow, embedded native controls
+			return 0;
 		}
 		catch (Exception e)
 		{

src/Uno.UI.Runtime.Skia.MacOS/MacSkiaHost.cs

@@ -25,6 +25,7 @@ static MacSkiaHost()
 		MacOSFileSavePickerExtension.Register();
 		MacOSFolderPickerExtension.Register();
 		MacOSLauncherExtension.Register();
+		MacOSNativeElementHostingExtension.Register();
 		MacOSNativeWindowFactoryExtension.Register();
 		MacOSSystemNavigationManagerPreviewExtension.Register();
 		MacOSSystemThemeHelperExtension.Register();

src/Uno.UI.Runtime.Skia.MacOS/NativeUno.cs

@@ -219,7 +219,7 @@ internal static unsafe partial void uno_set_window_events_callbacks(
 	internal static partial string uno_window_get_title(nint window);
 
 	[LibraryImport("libUnoNativeMac.dylib", StringMarshalling = StringMarshalling.Utf8)]
-	internal static partial nint uno_window_set_title(nint window, string title);
+	internal static partial void uno_window_set_title(nint window, string title);
 
 	[LibraryImport("libUnoNativeMac.dylib")]
 	internal static unsafe partial void uno_set_window_close_callbacks(
@@ -277,6 +277,9 @@ internal static unsafe partial void uno_set_window_close_callbacks(
 	[LibraryImport("libUnoNativeMac.dylib")]
 	internal static partial void uno_window_set_min_size(nint window, double width, double height);
 
+	[LibraryImport("libUnoNativeMac.dylib", StringMarshalling = StringMarshalling.Utf8)]
+	internal static partial void uno_window_clip_svg(nint window, string? svg);
+
 	[LibraryImport("libUnoNativeMac.dylib", StringMarshalling = StringMarshalling.Utf8)]
 	internal static partial string? /* const char* _Nullable */ uno_pick_single_folder(string? prompt, string? identifier, int suggestedStartLocation);
 
@@ -320,4 +323,29 @@ internal static unsafe partial void uno_set_window_close_callbacks(
 	[LibraryImport("libUnoNativeMac.dylib")]
 	[return: MarshalAs(UnmanagedType.I1)]
 	internal static partial bool uno_cursor_set(CoreCursorType cursorType);
+
+	[LibraryImport("libUnoNativeMac.dylib", StringMarshalling = StringMarshalling.Utf8)]
+	internal static partial nint uno_native_create_sample(nint window, string text);
+
+	[LibraryImport("libUnoNativeMac.dylib")]
+	internal static partial void uno_native_arrange(nint element, double arrangeLeft, double arrangeTop, double arrangeWidth, double arrangeHeight, double clipLeft, double clipTop, double clipWidth, double clipHeight);
+
+	[LibraryImport("libUnoNativeMac.dylib")]
+	internal static partial void uno_native_attach(nint element);
+
+	[LibraryImport("libUnoNativeMac.dylib")]
+	internal static partial void uno_native_detach(nint element);
+
+	[LibraryImport("libUnoNativeMac.dylib")]
+	[return: MarshalAs(UnmanagedType.I1)]
+	internal static partial bool uno_native_is_attached(nint element);
+
+	[LibraryImport("libUnoNativeMac.dylib")]
+	internal static partial void uno_native_set_opacity(nint element, double opacity);
+
+	[LibraryImport("libUnoNativeMac.dylib")]
+	internal static partial void uno_native_set_visibility(nint element, [MarshalAs(UnmanagedType.I1)] bool visible);
+
+	[LibraryImport("libUnoNativeMac.dylib")]
+	internal static partial void uno_native_measure(nint element, double childWidth, double childHeight, double availableWidth, double availableHeight, out double width, out double height);
 }

src/Uno.UI.Runtime.Skia.MacOS/UnoNativeMac/UnoNativeMac.xcodeproj/project.pbxproj

@@ -9,6 +9,7 @@
 /* Begin PBXBuildFile section */
 		D116C63E2AC79876004B975F /* UNOCursor.m in Sources */ = {isa = PBXBuildFile; fileRef = D116C63D2AC79876004B975F /* UNOCursor.m */; };
 		D13AB8A82B5839B200693F8E /* libSkiaSharp.dylib in Frameworks */ = {isa = PBXBuildFile; fileRef = D13AB8A72B5839B200693F8E /* libSkiaSharp.dylib */; };
+		D18D4FAC2C2DE804003E4BBF /* UNONative.m in Sources */ = {isa = PBXBuildFile; fileRef = D18D4FAB2C2DE804003E4BBF /* UNONative.m */; };
 		D1A0651E2A7066F700101BE6 /* UNOMetalViewDelegate.m in Sources */ = {isa = PBXBuildFile; fileRef = D1A0651D2A7066F700101BE6 /* UNOMetalViewDelegate.m */; };
 		D1A065202A8467B200101BE6 /* UNOApplication.h in Headers */ = {isa = PBXBuildFile; fileRef = D1A0651F2A8467B200101BE6 /* UNOApplication.h */; };
 		D1A065222A84688000101BE6 /* UNOApplication.m in Sources */ = {isa = PBXBuildFile; fileRef = D1A065212A84688000101BE6 /* UNOApplication.m */; };
@@ -24,6 +25,8 @@
 		D116C63D2AC79876004B975F /* UNOCursor.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = UNOCursor.m; sourceTree = "<group>"; };
 		D13AB8A72B5839B200693F8E /* libSkiaSharp.dylib */ = {isa = PBXFileReference; lastKnownFileType = "compiled.mach-o.dylib"; name = libSkiaSharp.dylib; path = UnoNativeMac/libSkiaSharp.dylib; sourceTree = "<group>"; };
 		D13AB8AC2B58566400693F8E /* Config.xcconfig */ = {isa = PBXFileReference; lastKnownFileType = text.xcconfig; path = Config.xcconfig; sourceTree = "<group>"; };
+		D18D4FAA2C2DE76F003E4BBF /* UNONative.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = UNONative.h; sourceTree = "<group>"; };
+		D18D4FAB2C2DE804003E4BBF /* UNONative.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = UNONative.m; sourceTree = "<group>"; };
 		D1A0651C2A70664A00101BE6 /* UNOMetalViewDelegate.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = UNOMetalViewDelegate.h; sourceTree = "<group>"; };
 		D1A0651D2A7066F700101BE6 /* UNOMetalViewDelegate.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = UNOMetalViewDelegate.m; sourceTree = "<group>"; };
 		D1A0651F2A8467B200101BE6 /* UNOApplication.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = UNOApplication.h; sourceTree = "<group>"; };
@@ -90,6 +93,8 @@
 				D116C63D2AC79876004B975F /* UNOCursor.m */,
 				D1A0651C2A70664A00101BE6 /* UNOMetalViewDelegate.h */,
 				D1A0651D2A7066F700101BE6 /* UNOMetalViewDelegate.m */,
+				D18D4FAA2C2DE76F003E4BBF /* UNONative.h */,
+				D18D4FAB2C2DE804003E4BBF /* UNONative.m */,
 				D1CC768E2ABA1368002A44F0 /* UNOPickers.h */,
 				D1CC768C2ABA1337002A44F0 /* UNOPickers.m */,
 				D1FE7A2C2B75C8E100ACFC76 /* UNOSoftView.h */,
@@ -176,6 +181,7 @@
 				D1A065252A8AC23800101BE6 /* UNOWindow.m in Sources */,
 				D1CC768B2AB9D464002A44F0 /* UNOClipboard.m in Sources */,
 				D116C63E2AC79876004B975F /* UNOCursor.m in Sources */,
+				D18D4FAC2C2DE804003E4BBF /* UNONative.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};

src/Uno.UI.Runtime.Skia.MacOS/UnoNativeMac/UnoNativeMac/UNONative.h

@@ -0,0 +1,40 @@
+//
+//  UNONative.h
+//
+
+#pragma once
+
+#import "UnoNativeMac.h"
+#import "UNOWindow.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+@protocol UNONativeElement
+
+@property (nonatomic) bool visible;
+
+-(void) detach;
+
+@end
+
+@interface UNORedView : NSView<UNONativeElement>
+
+@end
+
+NSView* uno_native_create_sample(NSWindow *window, const char* _Nullable text);
+
+void uno_native_arrange(NSView *element, double arrangeLeft, double arrangeTop, double arrangeWidth, double arrangeHeight, double clipLeft, double clipTop, double clipWidth, double clipHeight);
+
+void uno_native_attach(NSView* element);
+
+void uno_native_detach(NSView* element);
+
+bool uno_native_is_attached(NSView* element);
+
+void uno_native_measure(NSView* element, double childWidth, double childHeight, double availableWidth, double availableHeight, double* width, double* height);
+
+void uno_native_set_opacity(NSView* element, double opacity);
+
+void uno_native_set_visibility(NSView* element, bool visible);
+
+NS_ASSUME_NONNULL_END