Fixed parent sheet dismissal leaves child sheet behind (GtkBackend testing pending)

Author: MiaKoring

Sources/AppKitBackend/AppKitBackend.swift

@@ -1725,13 +1725,23 @@ public final class AppKitBackend: AppBackend {
         return SIMD2(x: Int(size.width), y: Int(size.height))
     }
 
-    public func showSheet(_ sheet: NSCustomSheet, window: NSCustomWindow) {
+    public func showSheet(_ sheet: NSCustomSheet, sheetParent: Any) {
         // Critical sheets stack. beginSheet only shows a nested sheet
         // after its parent gets dismissed.
+        let window = sheetParent as! NSCustomWindow
         window.beginCriticalSheet(sheet)
+        window.managedAttachedSheet = sheet
     }
 
-    public func dismissSheet(_ sheet: NSCustomSheet, window: NSCustomWindow) {
+    public func dismissSheet(_ sheet: NSCustomSheet, sheetParent: Any) {
+        let window = sheetParent as! NSCustomWindow
+
+        if let nestedSheet = sheet.managedAttachedSheet {
+            dismissSheet(nestedSheet, sheetParent: sheet)
+        }
+
+        defer { window.managedAttachedSheet = nil }
+
         window.endSheet(sheet)
     }
 
@@ -2218,6 +2228,8 @@ public class NSCustomWindow: NSWindow {
     var customDelegate = Delegate()
     var persistentUndoManager = UndoManager()
 
+    var managedAttachedSheet: NSCustomSheet?
+
     /// Allows the backing scale factor to be overridden. Useful for keeping
     /// UI tests consistent across devices.
     ///

Sources/Gtk/Widgets/Window.swift

@@ -7,6 +7,8 @@ import CGtk
 open class Window: Widget {
     public var child: Widget?
 
+    public var managedAttachedSheet: Window?
+
     public convenience init() {
         self.init(gtk_window_new())
     }

Sources/Gtk3Backend/Gtk3Backend.swift

@@ -1517,9 +1517,3 @@ struct Gtk3Error: LocalizedError {
         "gerror: code=\(code), domain=\(domain), message=\(message)"
     }
 }
-
-extension Gtk3.Window: SheetImplementation {
-    public var sheetSize: SIMD2<Int> {
-        SIMD2(x: size.width, y: size.height)
-    }
-}

Sources/GtkBackend/GtkBackend.swift

@@ -1634,18 +1634,30 @@ public final class GtkBackend: AppBackend {
         }
     }
 
-    public func showSheet(_ sheet: Gtk.Window, window: ApplicationWindow) {
+    public func showSheet(_ sheet: Gtk.Window, sheetParent: Any) {
+        let window = sheetParent as! Gtk.Window
         sheet.isModal = true
         sheet.isDecorated = false
         sheet.setTransient(for: window)
         sheet.present()
+        window.managedAttachedSheet = sheet
     }
 
-    public func dismissSheet(_ sheet: Gtk.Window, window: ApplicationWindow) {
+    public func dismissSheet(_ sheet: Gtk.Window, sheetParent: Any) {
+        let window = sheetParent as! Gtk.Window
+
+        if let nestedSheet = window.managedAttachedSheet {
+            dismissSheet(nestedSheet, sheetParent: sheet)
+        }
+
+        defer { window.managedAttachedSheet = nil }
+
         let key: OpaquePointer = OpaquePointer(sheet.widgetPointer)
+
         if let ctx = sheetContexts[key] {
             ctx.isProgrammaticDismiss = true
         }
+
         sheet.destroy()
         sheetContexts.removeValue(forKey: key)
         connectedCloseHandlers.remove(key)

Sources/SwiftCrossUI/Backend/AppBackend.swift

@@ -627,12 +627,12 @@ public protocol AppBackend: Sendable {
     /// app modal, a standalone window, or a modal for a window of its choosing.
     func showSheet(
         _ sheet: Sheet,
-        window: Window
+        sheetParent: Any
     )
 
     /// Dismisses a sheet programmatically.
     /// Gets used by the ``View/sheet`` modifier to close a sheet.
-    func dismissSheet(_ sheet: Sheet, window: Window)
+    func dismissSheet(_ sheet: Sheet, sheetParent: Any)
 
     /// Get the dimensions of a sheet
     func size(ofSheet sheet: Sheet) -> SIMD2<Int>
@@ -1281,12 +1281,12 @@ extension AppBackend {
 
     public func showSheet(
         _ sheet: Sheet,
-        window: Window
+        sheetParent: Any
     ) {
         todo()
     }
 
-    public func dismissSheet(_ sheet: Sheet, window: Window) {
+    public func dismissSheet(_ sheet: Sheet, sheetParent: Any) {
         todo()
     }
 

Sources/SwiftCrossUI/Environment/EnvironmentValues.swift

@@ -128,6 +128,11 @@ public struct EnvironmentValues {
     /// The backend in use. Mustn't change throughout the app's lifecycle.
     let backend: any AppBackend
 
+    /// The backend's representation of the class that owns the current sheet,
+    /// if any. This is a very internal detail that should never get
+    /// exposed to users.
+    package var sheetParent: Any?
+
     /// Presents an 'Open file' dialog fit for selecting a single file. Some
     /// backends only allow selecting either files or directories but not both
     /// in a single dialog. Returns `nil` if the user cancels the operation.

Sources/SwiftCrossUI/Views/Modifiers/SheetModifier.swift

@@ -80,7 +80,11 @@ struct SheetModifier<Content: View, SheetContent: View>: TypeSafeView {
             let dismissAction = DismissAction(action: { [isPresented] in
                 isPresented.wrappedValue = false
             })
-            let sheetEnvironment = environment.with(\.dismiss, dismissAction)
+
+            var sheetEnvironment =
+                environment
+                .with(\.dismiss, dismissAction)
+                .with(\.sheetParent, sheet)
 
             let result = children.sheetContentNode!.update(
                 with: sheetContent(),
@@ -123,13 +127,13 @@ struct SheetModifier<Content: View, SheetContent: View>: TypeSafeView {
 
             backend.showSheet(
                 sheet,
-                window: environment.window! as! Backend.Window
+                sheetParent: (environment.sheetParent ?? environment.window)!
             )
             children.sheet = sheet
         } else if !isPresented.wrappedValue && children.sheet != nil {
             backend.dismissSheet(
                 children.sheet as! Backend.Sheet,
-                window: environment.window! as! Backend.Window
+                sheetParent: (environment.sheetParent ?? environment.window)!
             )
             children.sheet = nil
             children.sheetContentNode = nil

Sources/UIKitBackend/UIKitBackend+Sheet.swift

@@ -22,16 +22,18 @@ extension UIKitBackend {
 
     public func showSheet(
         _ sheet: CustomSheet,
-        window: UIWindow
+        sheetParent: Any
     ) {
-        var topController = window.rootViewController
-        while let presented = topController?.presentedViewController {
-            topController = presented
+        var topController: UIViewController? = nil
+        if let window = sheetParent as? UIWindow {
+            topController = window.rootViewController
+        } else {
+            topController = sheetParent as? UIViewController
         }
         topController?.present(sheet, animated: true)
     }
 
-    public func dismissSheet(_ sheet: CustomSheet, window: UIWindow) {
+    public func dismissSheet(_ sheet: CustomSheet, sheetParent: Any) {
         // If this sheet has a presented view controller (nested sheet), dismiss it first
         if let presentedVC = sheet.presentedViewController {
             presentedVC.dismiss(animated: false) { [weak sheet] in