Update compareValues API (#132)

Author: Kyle-Ye

Package.resolved

@@ -13,7 +13,7 @@ public struct External<Value> {
 // MARK: - _AttributeBody
 
 extension External: _AttributeBody {
-    public static var comparisonMode: OGComparisonMode { ._3 }
+    public static var comparisonMode: ComparisonMode { .equatableAlways }
 
     public static var flags: OGAttributeTypeFlags { [] }
 

Sources/OpenGraph/Attribute/Attribute/External.swift

@@ -11,7 +11,7 @@ public protocol _AttributeBody {
     static func _destroySelf(_ pointer: UnsafeMutableRawPointer)
     static var _hasDestroySelf: Bool { get }
     static func _updateDefault(_ pointer: UnsafeMutableRawPointer)
-    static var comparisonMode: OGComparisonMode { get }
+    static var comparisonMode: ComparisonMode { get }
     static var flags: OGAttributeTypeFlags { get }
 }
 
@@ -21,7 +21,7 @@ extension _AttributeBody {
     public static func _destroySelf(_ pointer: UnsafeMutableRawPointer) {}
     public static var _hasDestroySelf: Bool { false }
     public static func _updateDefault(_ pointer: UnsafeMutableRawPointer) {}
-    public static var comparisonMode: OGComparisonMode { ._2 }
+    public static var comparisonMode: ComparisonMode { .equatableUnlessPOD }
     public static var flags: OGAttributeTypeFlags { .mainThread }
 }
 

Sources/OpenGraph/Attribute/Body/AttributeBody.swift

@@ -12,23 +12,23 @@ private func OGCompareValues(
     lhs: UnsafeRawPointer,
     rhs: UnsafeRawPointer,
     type: Any.Type,
-    options: OGComparisonOptions
+    options: ComparisonOptions
 ) -> Bool
 
-public func compareValues<Value>(_ lhs: Value, _ rhs: Value, mode: OGComparisonMode = ._3) -> Bool {
-    compareValues(lhs, rhs, options: OGComparisonOptions(mode: mode))
+public func compareValues<Value>(_ lhs: Value, _ rhs: Value, mode: ComparisonMode = .equatableAlways) -> Bool {
+    compareValues(lhs, rhs, options: [.init(mode: mode), .copyOnWrite])
 }
 
-public func compareValues<Value>(_ lhs: Value, _ rhs: Value, options: OGComparisonOptions) -> Bool {
+public func compareValues<Value>(_ lhs: Value, _ rhs: Value, options: ComparisonOptions) -> Bool {
     withUnsafePointer(to: lhs) { p1 in
         withUnsafePointer(to: rhs) { p2 in
-            OGCompareValues(lhs: p1, rhs: p2, type: Value.self, options: .init(rawValue: options.rawValue | 0x100))
+            OGCompareValues(lhs: p1, rhs: p2, type: Value.self, options: options)
         }
     }
 }
 
-extension OGComparisonOptions {
-    public init(mode: OGComparisonMode) {
-        self.init(rawValue: mode.rawValue)
+extension ComparisonOptions {
+    public init(mode: ComparisonMode) {
+        self.init(rawValue: numericCast(mode.rawValue))
     }
 }

Sources/OpenGraph/Runtime/CompareValues.swift

@@ -10,8 +10,6 @@ public typealias OGAttributeType = AGAttributeType
 public typealias OGAttributeTypeFlags = AGAttributeTypeFlags
 public typealias OGCachedValueOptions = AGCachedValueOptions
 public typealias OGChangedValueFlags = AGChangedValueFlags
-public typealias OGComparisonMode = AGComparisonMode
-public typealias OGComparisonOptions = AGComparisonOptions
 public typealias OGCounterQueryType = AGCounterQueryType
 public typealias OGDebugServer = AGDebugServer
 public typealias OGInputOptions = AGInputOptions

Sources/OpenGraphShims/GraphShims.swift

@@ -0,0 +1,38 @@
+//
+//  OGCompareValues.cpp
+//  OpenGraph_SPI
+
+#include "OGComparison.h"
+#include "OGComparisonPrivate.h"
+
+const void *OGComparisonStateGetDestination(OGComparisonState state) {
+    return state->destination;
+}
+
+const void *OGComparisonStateGetSource(OGComparisonState state) {
+    return state->source;
+}
+
+OGFieldRange OGComparisonStateGetFieldRange(OGComparisonState state) {
+    return state->field_range;
+}
+
+OGTypeID OGComparisonStateGetFieldType(OGComparisonState state) {
+    return state->field_type;
+}
+
+bool OGCompareValues(const void *lhs, const void *rhs, OGTypeID type, OGComparisonOptions options) {
+    // TODO
+    return false;
+}
+
+const unsigned char *_Nullable OGPrefetchCompareValues(OGTypeID type_id,
+                                                       OGComparisonOptions options,
+                                                       uint32_t priority) {
+    // TODO
+    return nullptr;
+}
+
+void OGOverrideComparisonForTypeDescriptor(void *descriptor, OGComparisonMode mode) {
+    // TODO
+}

Sources/OpenGraph_SPI/Comparison/OGComparison.cpp

@@ -0,0 +1,52 @@
+//
+//  OGComparisonPrivate.h
+//  OpenGraph_SPI
+//
+//  Audited for 6.5.4
+//  Status: Complete
+//
+//  Modified based on Compute project: https://github.com/jcmosc/Compute/blob/main/Sources/ComputeCxx/Comparison/AGComparison-Private.h
+//  Copyright (c) 2025 James Moschou
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the "Software"), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//
+//  The above copyright notice and this permission notice shall be included in all
+//  copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMOGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+//  SOFTWARE.
+
+#ifndef OGComparisonPrivate_h
+#define OGComparisonPrivate_h
+
+#include "OGBase.h"
+#include "OGComparison.h"
+#include "OGTypeID.h"
+
+OG_ASSUME_NONNULL_BEGIN
+
+OG_EXTERN_C_BEGIN
+
+typedef struct OGComparisonStateStorage {
+    const void *destination;
+    const void *source;
+    OGFieldRange field_range;
+    OGTypeID field_type;
+} OGComparisonStateStorage;
+
+OG_EXTERN_C_END
+
+OG_ASSUME_NONNULL_END
+
+#endif /* OGComparisonPrivate_h */
+

Sources/OpenGraph_SPI/Comparison/OGComparisonPrivate.h

@@ -0,0 +1,103 @@
+//
+//  OGComparison.h
+//  OpenGraph_SPI
+//
+//  Audited for 6.5.4
+//  Status: Complete
+
+//
+//  Modified based on Compute project: https://github.com/jcmosc/Compute/blob/main/Sources/ComputeCxx/Comparison/AGComparison.h
+//  Copyright (c) 2025 James Moschou
+//
+//  Permission is hereby granted, free of charge, to any person obtaining a copy
+//  of this software and associated documentation files (the "Software"), to deal
+//  in the Software without restriction, including without limitation the rights
+//  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+//  copies of the Software, and to permit persons to whom the Software is
+//  furnished to do so, subject to the following conditions:
+//
+//  The above copyright notice and this permission notice shall be included in all
+//  copies or substantial portions of the Software.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+//  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+//  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+//  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMOGES OR OTHER
+//  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+//  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+//  SOFTWARE.
+
+#ifndef OGComparison_h
+#define OGComparison_h
+
+#include "OGBase.h"
+#include "OGTypeID.h"
+
+OG_ASSUME_NONNULL_BEGIN
+
+OG_EXTERN_C_BEGIN
+
+typedef struct OGFieldRange {
+    size_t offset;
+    size_t size;
+} OGFieldRange;
+
+typedef struct OGComparisonStateStorage *OGComparisonState;
+
+OG_EXPORT
+OG_REFINED_FOR_SWIFT
+const void *OGComparisonStateGetDestination(OGComparisonState state);
+
+OG_EXPORT
+OG_REFINED_FOR_SWIFT
+const void *OGComparisonStateGetSource(OGComparisonState state);
+
+OG_EXPORT
+OG_REFINED_FOR_SWIFT
+OGFieldRange OGComparisonStateGetFieldRange(OGComparisonState state);
+
+OG_EXPORT
+OG_REFINED_FOR_SWIFT
+OGTypeID OGComparisonStateGetFieldType(OGComparisonState state);
+
+typedef OG_ENUM(uint8_t, OGComparisonMode) {
+    OGComparisonModeBitwise = 0,
+    OGComparisonModeIndirect = 1,
+    OGComparisonModeEquatableUnlessPOD = 2,
+    OGComparisonModeEquatableAlways = 3,
+} OG_SWIFT_NAME(ComparisonMode);
+
+typedef OG_OPTIONS(uint32_t, OGComparisonOptions) {
+    OGComparisonOptionsComparisonModeBitwise = 0,
+    OGComparisonOptionsComparisonModeIndirect = 1,
+    OGComparisonOptionsComparisonModeEquatableUnlessPOD = 2,
+    OGComparisonOptionsComparisonModeEquatableAlways = 3,
+    OGComparisonOptionsComparisonModeMask = 0xff,
+
+    OGComparisonOptionsCopyOnWrite = 1 << 8,
+    OGComparisonOptionsFetchLayoutsSynchronously = 1 << 9,
+    OGComparisonOptionsReportFailures = 1ul << 31, // -1 signed int
+} OG_SWIFT_NAME(ComparisonOptions);
+
+OG_EXPORT
+OG_REFINED_FOR_SWIFT
+bool OGCompareValues(const void *lhs,
+                     const void *rhs,
+                     OGTypeID type_id,
+                     OGComparisonOptions options);
+
+OG_EXPORT
+OG_REFINED_FOR_SWIFT
+const unsigned char *_Nullable OGPrefetchCompareValues(OGTypeID type_id,
+                                                       OGComparisonOptions options,
+                                                       uint32_t priority);
+
+OG_EXPORT
+OG_REFINED_FOR_SWIFT
+void OGOverrideComparisonForTypeDescriptor(void *descriptor, OGComparisonMode mode);
+
+OG_EXTERN_C_END
+
+OG_ASSUME_NONNULL_END
+
+#endif /* OGComparison_h */