Update AGDebugKit to add dot format support

Author: Kyle-Ye

Package.resolved

@@ -17,7 +17,7 @@ let package = Package(
         .library(name: "AGDebugKit", targets: ["AGDebugKit"]),
     ],
     dependencies: [
-        .package(url: "https://github.com/OpenSwiftUIProject/OpenGraph.git", exact: "0.0.5"),
+        .package(url: "https://github.com/OpenSwiftUIProject/OpenGraph.git", exact: "0.0.7"),
         .package(url: "https://github.com/OpenSwiftUIProject/Socket.git", from: "0.3.3"),
     ],
     targets: [

Package.swift

@@ -10,19 +10,18 @@ import Foundation
 
 /// A wrapper class for AGGraph
 public final class Graph {
-    private let graph: AGGraph?
+    private unowned let graph: AGGraph?
 
     public init() {
         graph = nil
     }
 
     public init(_ pointer: UnsafeRawPointer?) {
-        if let pointer {
-            let sharedGraph = pointer.assumingMemoryBound(to: AGGraph.self).pointee
-            graph = AGGraph(shared: sharedGraph)
-        } else {
-            graph = AGGraph()
-        }
+        graph = pointer?.assumingMemoryBound(to: AGGraph.self).pointee
+    }
+    
+    public init(bitPattern: Int) {
+        graph = Unmanaged<AGGraph>.fromOpaque(.init(bitPattern: bitPattern)!).takeUnretainedValue()
     }
 
     public var dict: NSDictionary? {
@@ -54,4 +53,21 @@ public final class Graph {
     public static func archiveGraph(name: String) {
         name.withCString { AGGraph.archiveJSON(name: $0) }
     }
+    
+    /// Command to transform dot file to svg
+    /// 1. Install graphviz
+    /// 2. Execuate `dot -Tsvg xx.dot > xx.svg`
+    public static func _graphExport(_ bitPattern: Int, name: String = "aggraph_export.dot") {
+        // TODO: How to get the current in memory's AGGraphStorage objects?
+        // Currently we just use Xcode Memory Graph and use any of the AGGraphStorage's address
+        let graph = Graph(bitPattern: bitPattern)
+        let dot = graph.dot ?? ""
+        let path = URL(fileURLWithPath: "\(NSTemporaryDirectory())/\(name)")
+        do {
+            try dot.write(to: path, atomically: true, encoding: .utf8)
+            print(#"Wrote graph data to "\#(path.absoluteString)""#)
+        } catch {
+            print("Error writing to file: \(error)")
+        }
+    }
 }

Sources/AGDebugKit/Graph.swift

@@ -6,16 +6,25 @@
 //
 
 import AGDebugKit
+import AttributeGraph
 import SwiftUI
 
 @available(macOS 13, *)
 struct AGDebugItem: Equatable, Identifiable {
     var url: URL
-    
-    init(name: String) {
-        url = URL(filePath: NSTemporaryDirectory().appending("\(name).json"))
+    var format: Format
+
+    enum Format: String, CaseIterable, Identifiable {
+        var id: String { rawValue }
+        
+        case json, dot
     }
-    
+
+    init(name: String, format: Format) {
+        url = URL(filePath: NSTemporaryDirectory().appending("\(name).\(format.rawValue)"))
+        self.format = format
+    }
+
     var id: String { url.absoluteString }
 }
 
@@ -24,12 +33,26 @@ struct AGDebugModifier: ViewModifier {
     @State private var showInspector = false
     @State private var items: [AGDebugItem] = []
 
+    fileprivate static var sharedGraphbitPattern: Int = 0
+    @State private var format: AGDebugItem.Format = .dot
+
     func body(content: Content) -> some View {
         content
             .toolbar {
+                Picker("Format", selection: $format) {
+                    ForEach(AGDebugItem.Format.allCases) {
+                        Text($0.rawValue).tag($0)
+                    }
+                }.pickerStyle(.segmented)
                 Button {
-                    let item = AGDebugItem(name: Date.now.ISO8601Format())
-                    Graph.archiveGraph(name: item.url.lastPathComponent)
+                    let item = AGDebugItem(name: Date.now.ISO8601Format(), format: format)
+                    let name = item.url.lastPathComponent
+                    switch format {
+                    case .json:
+                        Graph.archiveGraph(name: name)
+                    case .dot:
+                        Graph._graphExport(AGDebugModifier.sharedGraphbitPattern, name: name)
+                    }
                     items.append(item)
                 } label: {
                     Image(systemName: "doc.badge.plus")
@@ -43,6 +66,7 @@ struct AGDebugModifier: ViewModifier {
             .inspector(isPresented: $showInspector) {
                 inspectorView
             }
+            .overlay { _GraphFetcher() }
     }
 
     private var inspectorView: some View {
@@ -89,16 +113,16 @@ struct AGDebugModifier: ViewModifier {
     private func openAction(_ url: URL) {
         _ = NSWorkspace.shared.open(url)
     }
-    
+
     // MARK: - Move
-    
+
     @State private var moving = false
     @State private var moveURL: URL?
     private func moveAction(_ url: URL) {
         moveURL = url
         moving = true
     }
-    
+
     // MARK: - Delete
 
     private func deleteAction(_ url: URL) throws {
@@ -113,3 +137,28 @@ extension View {
         modifier(AGDebugModifier())
     }
 }
+
+struct _GraphFetcher: View {
+    var body: Never { fatalError("Unimplemented") }
+
+    static func _makeView(view: _GraphValue<Self>, inputs: _ViewInputs) -> _ViewOutputs {
+        if let current = AGSubgraph.current {
+            let graph = current.graph
+            if #available(macOS 14, *) {
+                AGDebugModifier.sharedGraphbitPattern = unsafeBitCast(graph, to: Int.self)
+            }
+        }
+
+        return withUnsafePointer(to: view) { pointer in
+            let view = UnsafeRawPointer(pointer).assumingMemoryBound(to: _GraphValue<EmptyView>.self)
+            return EmptyView._makeView(view: view.pointee, inputs: inputs)
+        }
+    }
+
+    static func _makeViewList(view: _GraphValue<Self>, inputs: _ViewListInputs) -> _ViewListOutputs {
+        withUnsafePointer(to: view) { pointer in
+            let view = UnsafeRawPointer(pointer).assumingMemoryBound(to: _GraphValue<EmptyView>.self)
+            return EmptyView._makeViewList(view: view.pointee, inputs: inputs)
+        }
+    }
+}

Sources/DemoApp/AGDebugModifier.swift

@@ -6,7 +6,6 @@
 //
 
 import SwiftUI
-import AGDebugKit
 
 @main
 @available(macOS 14.0, *)
@@ -18,19 +17,6 @@ struct DemoApp: App {
             NSApp.activate(ignoringOtherApps: true)
             NSApp.windows.first?.makeKeyAndOrderFront(nil)
         }
-        
-        // Demo test code
-        let emptyGraph = Graph()
-        if let dict = emptyGraph.dict {
-            print(dict)
-        }
-        let defaultGraph = Graph(nil)
-        if let dict = defaultGraph.dict {
-            print(dict)
-        }
-        if let dot = defaultGraph.dot {
-            print(dot)
-        }
     }
 
     var body: some Scene {