Update Graph API (#145)

Author: Kyle-Ye

Package.resolved

@@ -7,6 +7,14 @@
 
 public import OpenGraphCxx
 
+@_silgen_name("OGGraphMutateAttribute")
+private func OGGraphMutateAttribute(
+    _ attribute: AnyAttribute,
+    type: Metadata,
+    invalidating: Bool,
+    body: (UnsafeMutableRawPointer) -> Void
+)
+
 extension AnyAttribute {
     public typealias Flags = OGAttributeTypeFlags
 
@@ -46,7 +54,11 @@ extension AnyAttribute {
     }
 
     public func mutateBody<Value>(as type: Value.Type, invalidating: Bool, _ body: (inout Value) -> Void) {
-        AnyAttribute.mutateAttribute(self, type: Metadata(type), invalidating: invalidating) { value in
+        OGGraphMutateAttribute(
+            self,
+            type: Metadata(type),
+            invalidating: invalidating
+        ) { value in
             body(&value.assumingMemoryBound(to: Value.self).pointee)
         }
     }
@@ -87,17 +99,6 @@ extension AnyAttribute: Swift.CustomStringConvertible {
 
 public typealias AttributeUpdateBlock = () -> (UnsafeMutableRawPointer, AnyAttribute) -> Void
 
-// FIXME: migrate to use @_extern(c, "xx") in Swift 6
-extension AnyAttribute {
-    @_silgen_name("OGGraphMutateAttribute")
-    private static func mutateAttribute(
-        _ attribute: AnyAttribute,
-        type: Metadata,
-        invalidating: Bool,
-        body: (UnsafeMutableRawPointer) -> Void
-    )
-}
-
 extension [AnyAttribute] {
     @_transparent
     public var anyInputsChanged: Bool {

Sources/OpenGraph/Attribute/Attribute/AnyAttribute.swift

@@ -20,29 +20,62 @@ extension Graph {
     }
 }
 
+@_silgen_name("OGGraphSetInvalidationCallback")
+private func OGGraphSetInvalidationCallback(
+    graph: Graph,
+    _ callback: @escaping (AnyAttribute) -> Void
+)
+
+@_silgen_name("OGGraphSetUpdateCallback")
+private func OGGraphSetUpdateCallback(
+    graph: Graph,
+    _ callback: @escaping () -> Void
+)
+
 extension Graph {
-    @_silgen_name("OGGraphStartProfiling")
-    public static func startProfiling(_ graph: Graph? = nil)
+    public static func withoutUpdate<V>(_ body: () -> V) -> V {
+        let update = clearUpdate()
+        defer { setUpdate(update) }
+        return body()
+    }
+
+    public func withoutSubgraphInvalidation<V>(_ body: () -> V) -> V {
+        preconditionFailure("TODO")
+    }
+
+    public func withDeadline<V>(
+        _: UInt64,
+        _: () -> V
+    ) -> V {
+        preconditionFailure("TODO")
+    }
+
+    public func onInvalidation(_ callback: @escaping (AnyAttribute) -> Void) {
+        OGGraphSetInvalidationCallback(graph: self, callback)
+    }
+
+    public func onUpdate(_ callback: @escaping () -> Void) {
+        OGGraphSetUpdateCallback(graph: self, callback)
+    }
 
-    @_silgen_name("OGGraphStopProfiling")
-    public static func stopProfiling(_ graph: Graph? = nil)
+    public func withMainThreadHandler(_: (() -> Void) -> Void, do: () -> Void) {
+        // TODO: OGGraphWithMainThreadHandler
+        preconditionFailure("TODO")
+    }
 }
 
-// FIXME: migrate to use @_extern(c, "xx") in Swift 6
-// > Also similar to @_silgen_name, but a function declared with @_extern(c) is assumed to use the C ABI, while @_silgen_name assumes the Swift ABI.
-//extension OGGraph {
-//    @_silgen_name("OGGGraphSetInvalidationCallback") // Use Swift ABI(self: x20) ❌, we need C ABI here(self: x0).
-//    public func setInvalidationCallback(_ callback: ((AnyAttribute) -> Void)?)
-//
-//    @_silgen_name("OGGGraphSetUpdateCallback")
-//    public func setUpdateCallback(_ callback: (() -> Void)?)
-//}
 extension Graph {
-    @_silgen_name("OGGraphSetInvalidationCallback")
-    public static func setInvalidationCallback(_ graph: Graph, callback: ((AnyAttribute) -> Void)?)
+    public static func startProfiling() {
+        __OGGraphStartProfiling(nil)
+    }
 
-    @_silgen_name("OGGraphSetUpdateCallback")
-    public static func setUpdateCallback(_ graph: Graph, callback: (() -> Void)?)
+    public static func stopProfiling() {
+        __OGGraphStopProfiling(nil)
+    }
+
+    public static func resetProfile() {
+        __OGGraphResetProfile(nil)
+    }
 }
 
 extension Graph {
@@ -51,14 +84,6 @@ extension Graph {
     public var mainUpdates: Int { numericCast(counter(for: ._10)) }
 }
 
-extension Graph {
-    public static func withoutUpdate<Value>(_ body: () -> Value) -> Value {
-        let update = clearUpdate()
-        defer { setUpdate(update) }
-        return body()
-    }
-}
-
 extension Graph {
     // NOTE: Currently Swift does not support generic computed variable
     @_silgen_name("OGGraphGetOutputValue")

Sources/OpenGraph/Graph/Graph.swift

@@ -9,7 +9,7 @@ public import OpenGraphCxx
 
 extension Subgraph {
     public func addObserver(_ observer: () -> Void) -> Int {
-        Subgraph.addObserver(self, observer: observer)
+        OGSubgraphAddObserver(self, observer: observer)
     }
 
     public func apply<Value>(_ body: () -> Value) -> Value {
@@ -28,7 +28,7 @@ extension Subgraph {
     }
 
     public func forEach(_ flags: OGAttributeFlags, _ callback: (AnyAttribute) -> Void) {
-        Subgraph.apply(self, flags: flags, callback: callback)
+        OGSubgraphApply(self, flags: flags, callback: callback)
     }
 }
 
@@ -52,11 +52,15 @@ extension Subgraph {
     }
 }
 
-// FIXME: migrate to use @_extern(c, "xx") in Swift 6
-extension Subgraph {
-    @_silgen_name("OGSubgraphApply")
-    private static func apply(_ graph: Subgraph, flags: OGAttributeFlags, callback: (AnyAttribute) -> Void)
-    
-    @_silgen_name("OGSubgraphAddObserver")
-    private static func addObserver(_ graph: Subgraph, observer: () -> Void) -> Int
-}
+@_silgen_name("OGSubgraphApply")
+private func OGSubgraphApply(
+    _ graph: Subgraph,
+    flags: OGAttributeFlags,
+    callback: (AnyAttribute) -> Void
+)
+
+@_silgen_name("OGSubgraphAddObserver")
+private func OGSubgraphAddObserver(
+    _ graph: Subgraph,
+    observer: () -> Void
+) -> Int

Sources/OpenGraph/Graph/Subgraph.swift

@@ -92,6 +92,10 @@ void OGGraphStopProfiling(_Nullable OGGraphRef graph) {
     graph->context.get_graph().stop_profiling();
 }
 
+void OGGraphResetProfile(_Nullable OGGraphRef graph) {
+    // TODO
+}
+
 const void * _Nullable OGGraphGetContext(OGGraphRef graph) {
     if (graph->context.isInvalid()) {
         OG::precondition_failure("invalidated graph");

Sources/OpenGraphCxx/Graph/OGGraph.cpp

@@ -49,6 +49,10 @@ OG_EXPORT
 OG_REFINED_FOR_SWIFT
 void OGGraphStopProfiling(_Nullable OGGraphRef graph);
 
+OG_EXPORT
+OG_REFINED_FOR_SWIFT
+void OGGraphResetProfile(_Nullable OGGraphRef graph);
+
 OG_EXPORT
 OG_REFINED_FOR_SWIFT
 const void * _Nullable OGGraphGetContext(OGGraphRef graph) OG_SWIFT_NAME(getter:OGGraphRef.context(self:));

Sources/OpenGraphCxx/include/OpenGraph/OGGraph.h

@@ -70,12 +70,10 @@ struct GraphCompatibilityTests {
     @Test
     func graphCallback() {
         let graph = Graph()
-        Graph.setUpdateCallback(graph, callback: nil)
-        Graph.setUpdateCallback(graph) {
+        graph.onUpdate {
             print("Update")
         }
-        Graph.setInvalidationCallback(graph, callback: nil)
-        Graph.setInvalidationCallback(graph) { attr in
+        graph.onInvalidation { attr in
             print("Invalidate \(attr)")
         }
     }