Update UIKit+Representable interface and documentation (#224)

* Add PlatformViewRepresentableLayoutOptions

* Update UIViewRepresentable

* Update PlatformViewRepresentable

* Update UIViewControllerRepresentable

* Fix Linux platform build issue

Author: Kyle-Ye

Sources/OpenSwiftUI/Integration/Representable/Platform/PlatformViewRepresentable.swift

@@ -2,70 +2,156 @@
 //  PlatformViewRepresentable.swift
 //  OpenSwiftUI
 //
-//  Audited for iOS 15.5
+//  Audited for iOS 18.0
 //  Status: WIP
+//  ID: A513612C07DFA438E70B9FA90719B40D (SwiftUI)
 
-#if os(macOS)
+#if canImport(AppKit)
 import AppKit
 typealias PlatformView = NSView
-#elseif os(iOS)
+typealias PlatformViewController = NSViewController
+#elseif canImport(UIKit)
 import UIKit
 typealias PlatformView = UIView
+typealias PlatformViewController = UIViewController
 #else
 import Foundation
-typealias PlatformView = Void
+typealias PlatformView = NSObject
+typealias PlatformViewController = NSObject
 #endif
-
 import OpenSwiftUICore
+import OpenGraphShims
+
+// MARK: - PlatformViewRepresentable
 
 protocol PlatformViewRepresentable: View {
+    static var dynamicProperties: DynamicPropertyCache.Fields { get }
+
     associatedtype PlatformViewProvider
+
     associatedtype Coordinator
-    
-    static var dynamicProperties: DynamicPropertyCache.Fields { get }
-    func makeViewProvider(context: PlatformViewRepresentableContext<Self>) -> PlatformViewProvider
-    func updateViewProvider(_ provider: PlatformViewProvider, context: PlatformViewRepresentableContext<Self>)
+
+    func makeViewProvider(context: Context) -> PlatformViewProvider
+
+    func updateViewProvider(_ provider: PlatformViewProvider, context: Context)
+
     func resetViewProvider(_ provider: PlatformViewProvider, coordinator: Coordinator, destroy: () -> Void)
-    static func dismantleViewProvider(_: PlatformViewProvider, coordinator: Coordinator)
-    static func platformView(for: PlatformViewProvider) -> PlatformView
+
+    static func dismantleViewProvider(_ provider: PlatformViewProvider, coordinator: Coordinator)
+
+    static func platformView(for provider: PlatformViewProvider) -> PlatformView
+
     func makeCoordinator() -> Coordinator
-    // func _identifiedViewTree(in: PlatformViewProvider) -> _IdentifiedViewTree
-    func overrideSizeThatFits(_ size: inout CGSize, in: _ProposedSize, platformView: PlatformViewProvider)
-    // func overrideLayoutTraits(_ traits: inout _LayoutTraits, for provider: PlatformViewProvider)
-    
+
+    func _identifiedViewTree(in provider: PlatformViewProvider) -> _IdentifiedViewTree
+
+    func sizeThatFits(_ proposal: ProposedViewSize, provider: PlatformViewProvider, context: PlatformViewRepresentableContext<Self>) -> CGSize?
+
+    func overrideSizeThatFits(_ size: inout CGSize, in proposedSize: _ProposedSize, platformView: PlatformViewProvider)
+
+    func overrideLayoutTraits(_ traits: inout _LayoutTraits, for provider: PlatformViewProvider)
+
     static func modifyBridgedViewInputs(_ inputs: inout _ViewInputs)
+
     static var isViewController: Bool { get }
-    // static var safeAreaMode: _PlatformViewRepresentable_SafeAreaMode { get }
+
+    static func shouldEagerlyUpdateSafeArea(_ provider: PlatformViewProvider) -> Bool
+
+    static func layoutOptions(_ provider: PlatformViewProvider) -> LayoutOptions
+
+    typealias Context = PlatformViewRepresentableContext<Self>
+
+    typealias LayoutOptions = _PlatformViewRepresentableLayoutOptions
+}
+
+// MARK: - PlatformViewRepresentable + Extension [WIP]
+
+extension PlatformViewRepresentable {
+    static var dynamicProperties: DynamicPropertyCache.Fields {
+        DynamicPropertyCache.fields(of: Self.self)
+    }
+
+    nonisolated static func _makeView(view: _GraphValue<Self>, inputs: _ViewInputs) -> _ViewOutputs {
+        // TODO
+        preconditionFailure("TODO")
+    }
+
+    var body: Never {
+        bodyError()
+    }
+}
+
+#if canImport(UIKit) || canImport(AppKit)
+
+extension PlatformViewRepresentable where PlatformViewProvider: PlatformView {
+    static func platformView(for provider: PlatformViewProvider) -> PlatformView {
+        provider
+    }
+
+    static var isViewController: Bool { false }
+}
+
+extension PlatformViewRepresentable where PlatformViewProvider: PlatformViewController {
+    static func platformView(for provider: PlatformViewProvider) -> PlatformView {
+        provider.view
+    }
+
+    static var isViewController: Bool { true }
 }
 
-// MARK: - PlatformViewRepresentableValues
+#endif
+
+// MARK: - RepresentableContextValues
+
+struct RepresentableContextValues {
+    static var current: RepresentableContextValues?
+
+    var preferenceBridge: PreferenceBridge?
 
-struct PlatformViewRepresentableValues {
-    var preferenceBridge: PreferenceBridge
     var transaction: Transaction
-    var environment: EnvironmentValues
-    
-    static var current: PlatformViewRepresentableValues?
-    
+
+    var environmentStorage: EnvironmentStorage
+
+    enum EnvironmentStorage {
+        case eager(EnvironmentValues)
+        case lazy(Attribute<EnvironmentValues>, AnyRuleContext)
+    }
+
     func asCurrent<V>(do: () -> V) -> V {
-        let old = PlatformViewRepresentableValues.current
-        PlatformViewRepresentableValues.current = self
-        defer { PlatformViewRepresentableValues.current = old }
+        let old = Self.current
+        Self.current = self
+        defer { Self.current = old }
         return `do`()
     }
 }
 
-struct PlatformViewRepresentableContext<RepresentableType: PlatformViewRepresentable> {
-    var values: PlatformViewRepresentableValues
-    let coordinator: RepresentableType.Coordinator
-}
+// MARK: - PlatformViewRepresentableContext
+
+struct PlatformViewRepresentableContext<Representable: PlatformViewRepresentable> {
+    var values: RepresentableContextValues
+    let coordinator: Representable.Coordinator
 
+    init(
+        coordinator: Representable.Coordinator,
+        preferenceBridge: PreferenceBridge?,
+        transaction: Transaction,
+        environmentStorage: RepresentableContextValues.EnvironmentStorage
+    ) {
+        self.values = .init(preferenceBridge: preferenceBridge, transaction: transaction, environmentStorage: environmentStorage)
+        self.coordinator = coordinator
+    }
 
-// TODO
-class PlatformViewCoordinator: NSObject {
-//    var weakDispatchUpdate: (()->Void) -> Void
-    
-    override init() {
-        super.init()
+    @inlinable
+    var environment: EnvironmentValues {
+        switch values.environmentStorage {
+        case let .eager(environmentValues):
+            environmentValues
+        case let .lazy(attribute, anyRuleContext):
+            Update.ensure { anyRuleContext[attribute] }
+        }
     }
 }
+
+// MARK: - PlatformViewCoordinator
+
+class PlatformViewCoordinator: NSObject {}

Sources/OpenSwiftUI/Integration/Representable/Platform/PlatformViewRepresentableLayoutOptions.swift

@@ -0,0 +1,22 @@
+//
+//  PlatformViewRepresentableLayoutOptions.swift
+//  OpenSwiftUI
+//
+//  Audited for iOS 18.0
+//  Status: Complete
+
+/// Options for defining how a platform representable interacts with the
+/// bridging implementation.
+public struct _PlatformViewRepresentableLayoutOptions: OptionSet {
+    public let rawValue: Int
+
+    @_spi(Private)
+    public static let propagatesSafeArea: _PlatformViewRepresentableLayoutOptions = .init(rawValue: 1 << 2)
+
+    public init(rawValue: Int) {
+        self.rawValue = rawValue
+    }
+}
+
+@available(*, unavailable)
+extension _PlatformViewRepresentableLayoutOptions: Sendable {}