Fix for retain cycles & splitview recreation issue (#1132)

Author: Wouter01

CodeEdit/Features/PathBar/Views/PathBarComponent.swift

@@ -107,10 +107,10 @@ struct PathBarComponent: View {
             func registerForChanges(in menu: NSMenu) {
                 cancellable = NotificationCenter.default
                     .publisher(for: NSMenu.didSendActionNotification, object: menu)
-                    .sink { notification in
+                    .sink { [weak self] notification in
                         if let menuItem = notification.userInfo?["MenuItem"] as? NSMenuItem,
                            let selection = menuItem as? ItemType {
-                            self.parent.selection = selection
+                            self?.parent.selection = selection
                         }
                     }
             }

CodeEdit/Features/SplitView/EditorView.swift

@@ -65,8 +65,8 @@ struct EditorView: View {
                     .transformEnvironment(\.isAtEdge) { belowToolbar in
                         calcIsAtEdge(current: &belowToolbar, index: index)
                     }
-                    .environment(\.splitEditor) { edge, newTabGroup in
-                        data.split(edge, at: index, new: newTabGroup)
+                    .environment(\.splitEditor) { [weak data] edge, newTabGroup in
+                        data?.split(edge, at: index, new: newTabGroup)
                     }
             }
         }

CodeEdit/Features/SplitView/SplitView.swift

@@ -8,21 +8,20 @@
 import SwiftUI
 
 struct SplitView<Content: View>: View {
+    var axis: Axis
     var content: Content
 
-    @State
-    var viewController: SplitViewController
-
     init(axis: Axis, @ViewBuilder content: () -> Content) {
+        self.axis = axis
         self.content = content()
-        let vc = SplitViewController(axis: axis)
-        self._viewController = .init(wrappedValue: vc)
     }
 
+    @State var viewController: () -> SplitViewController? = { nil }
+
     var body: some View {
         VStack {
             content.variadic { children in
-                SplitViewControllerView(children: children, viewController: viewController)
+                SplitViewControllerView(axis: axis, children: children, viewController: $viewController)
             }
         }
         ._trait(SplitViewControllerLayoutValueKey.self, viewController)

CodeEdit/Features/SplitView/SplitViewControllerView.swift

@@ -9,11 +9,12 @@ import SwiftUI
 
 struct SplitViewControllerView: NSViewControllerRepresentable {
 
+    var axis: Axis
     var children: _VariadicView.Children
-    var viewController: SplitViewController
+    @Binding var viewController: () -> SplitViewController?
 
     func makeNSViewController(context: Context) -> SplitViewController {
-        return viewController
+        context.coordinator
     }
 
     func updateNSViewController(_ controller: SplitViewController, context: Context) {
@@ -58,15 +59,21 @@ struct SplitViewControllerView: NSViewControllerRepresentable {
             }
         }
     }
+
+    func makeCoordinator() -> SplitViewController {
+        SplitViewController(parent: self, axis: axis)
+    }
 }
 
 final class SplitViewController: NSSplitViewController {
 
     var items: [SplitViewItem] = []
     var axis: Axis
+    var parentView: SplitViewControllerView
 
-    init(axis: Axis = .horizontal) {
+    init(parent: SplitViewControllerView, axis: Axis = .horizontal) {
         self.axis = axis
+        self.parentView = parent
         super.init(nibName: nil, bundle: nil)
     }
 
@@ -77,6 +84,11 @@ final class SplitViewController: NSSplitViewController {
     override func viewDidLoad() {
         splitView.isVertical = axis != .vertical
         splitView.dividerStyle = .thin
+        DispatchQueue.main.async { [weak self] in
+            self?.parentView.viewController = { [weak self] in
+                self
+            }
+        }
     }
 
     override func splitView(_ splitView: NSSplitView, shouldHideDividerAt dividerIndex: Int) -> Bool {

CodeEdit/Features/SplitView/SplitViewItem.swift

@@ -30,8 +30,8 @@ class SplitViewItem: ObservableObject {
 
     private func createObservers() -> [NSKeyValueObservation] {
         [
-            item.observe(\.isCollapsed) { item, _ in
-                self.collapsed.wrappedValue = item.isCollapsed
+            item.observe(\.isCollapsed) { [weak self] item, _ in
+                self?.collapsed.wrappedValue = item.isCollapsed
             }
         ]
     }

CodeEdit/Features/SplitView/SplitViewModifiers.swift

@@ -8,7 +8,7 @@
 import SwiftUI
 
 struct SplitViewControllerLayoutValueKey: _ViewTraitKey {
-    static var defaultValue: SplitViewController?
+    static var defaultValue: () -> SplitViewController? = { nil }
 }
 
 struct SplitViewItemCollapsedViewTraitKey: _ViewTraitKey {

CodeEdit/Features/SplitView/SplitViewReader.swift

@@ -11,23 +11,19 @@ struct SplitViewReader<Content: View>: View {
 
     @ViewBuilder var content: (SplitViewProxy) -> Content
 
-    @State private var viewController: SplitViewController?
+    @State private var viewController: () -> SplitViewController? = { nil }
 
     private var proxy: SplitViewProxy {
-        .init {
-            viewController
-        }
+        .init(viewController: viewController)
     }
 
     var body: some View {
         content(proxy)
             .variadic { children in
                 ForEach(children, id: \.id) { child in
                     child
-                        .task {
-                            if let vc = child[SplitViewControllerLayoutValueKey.self] {
-                                viewController = vc
-                            }
+                        .task(id: child[SplitViewControllerLayoutValueKey.self]()) {
+                            viewController = child[SplitViewControllerLayoutValueKey.self]
                         }
                 }
             }

CodeEdit/Features/Tabs/TabGroup/WorkspaceTabGroupView.swift

@@ -51,10 +51,9 @@ struct WorkspaceTabGroupView: View {
 
                 Divider()
                 if let file = tabgroup.selected {
-                    PathBarView(file: file) { newFile in
-                        let index = tabgroup.tabs.firstIndex(of: file)
-                        if let index {
-                            tabgroup.openTab(item: newFile, at: index)
+                    PathBarView(file: file) { [weak tabgroup] newFile in
+                        if let index = tabgroup?.tabs.firstIndex(of: file) {
+                            tabgroup?.openTab(item: newFile, at: index)
                         }
                     }
                     Divider()

CodeEdit/Features/Tabs/Views/TabBarView.swift

@@ -445,10 +445,10 @@ struct TabBarView: View {
             if tabManager.tabGroups.findSomeTabGroup(except: tabgroup) != nil {
                 TabBarAccessoryIcon(
                     icon: .init(systemName: "multiply"),
-                    action: {
-                        tabgroup.close()
+                    action: { [weak tabgroup] in
+                        tabgroup?.close()
                         if tabManager.activeTabGroup == tabgroup {
-                            tabManager.activeTabGroupHistory.removeAll { $0() == nil }
+                            tabManager.activeTabGroupHistory.removeAll { $0() == nil || $0() == tabgroup }
                             tabManager.activeTabGroup = tabManager.activeTabGroupHistory.removeFirst()()!
                         }
                         tabManager.flatten()
@@ -565,7 +565,7 @@ struct TabBarView: View {
 
     var splitviewButton: some View {
         Group {
-            switch (tabgroup.parent!.axis, modifierKeys.contains(.option)) {
+            switch (tabgroup.parent?.axis, modifierKeys.contains(.option)) {
             case (.horizontal, true), (.vertical, false):
                 TabBarAccessoryIcon(icon: Image(systemName: "square.split.1x2")) {
                     split(edge: .bottom)
@@ -577,6 +577,9 @@ struct TabBarView: View {
                     split(edge: .trailing)
                 }
                 .help("Split Horizontally")
+
+            default:
+                EmptyView()
             }
         }
         .foregroundColor(.secondary)