Add OGGraphArchiveJSON2 and update OGDescription

Author: Kyle-Ye

Package.resolved

@@ -147,6 +147,9 @@ let openGraphSPITarget = Target.target(
     name: "OpenGraph_SPI",
     cSettings: sharedCSettings + [
         .define("__COREFOUNDATION_FORSWIFTFOUNDATIONONLY__", to: "1", .when(platforms: .nonDarwinPlatforms)),
+    ],
+    linkerSettings: [
+        .linkedLibrary("z"),
     ]
 )
 let openGraphShimsTarget = Target.target(

Package.swift

@@ -9,7 +9,9 @@ import Foundation
 @_spi(Debug)
 extension Graph {
     public var dict: [String: Any]? {
-        let options = ["format": "graph/dict"] as NSDictionary
+        let options = [
+            Graph.descriptionFormat: Graph.descriptionFormatDictionary
+        ] as NSDictionary
         guard let description = Graph.description(nil, options: options) else {
             return nil
         }
@@ -25,7 +27,9 @@ extension Graph {
     // color:
     // - red: is_changed
     public var dot: String? {
-        let options = ["format": "graph/dot"] as NSDictionary
+        let options = [
+            Graph.descriptionFormat: Graph.descriptionFormatDot
+        ] as NSDictionary
         guard let description = Graph.description(self, options: options)
         else {
             return nil

Sources/OpenGraphShims/Graph+Debug.swift

@@ -202,7 +202,7 @@
             NSString *command = dic[@"command"];
             if ([command isEqual:@"graph/description"]) {
                 NSMutableDictionary *mutableDic = [NSMutableDictionary dictionaryWithDictionary:dic];
-                mutableDic[(__bridge NSString *)OGDescriptionFormat] = @"graph/dict";
+                mutableDic[(__bridge NSString *)OGDescriptionFormat] = (__bridge NSString *)OGDescriptionFormatDictionary;
                 CFTypeRef description = OG::Graph::description(nullptr, mutableDic);
                 if (description) {
                     NSData *descriptionData = [NSJSONSerialization dataWithJSONObject:(__bridge id)description options:0 error:NULL];

Sources/OpenGraph_SPI/Debug/og-debug-server.mm

@@ -123,7 +123,7 @@ class Graph final {
     void start_profiling(uint32_t) OG_NOEXCEPT;
     void stop_profiling() OG_NOEXCEPT;
 
-    static void write_to_file(const Graph * _Nullable, const char * _Nullable) OG_NOEXCEPT;
+    static void write_to_file(const Graph * _Nullable, const char * _Nullable, uint8_t) OG_NOEXCEPT;
 
     const bool thread_is_updating() const OG_NOEXCEPT;
     const bool is_context_updating(const OG::Graph::Context&) const OG_NOEXCEPT;

Sources/OpenGraph_SPI/Graph/Graph.cpp

@@ -0,0 +1,110 @@
+//
+//  Graph.mm
+//  OpenGraph_SPI
+
+#include "Graph.hpp"
+#include "Subgraph.hpp"
+#include "OGGraphDescription.h"
+
+#if OG_OBJC_FOUNDATION
+#include <dispatch/dispatch.h>
+#include <pthread.h>
+#include <Foundation/Foundation.h>
+#include <zlib.h>
+
+pthread_key_t OG::Graph::_current_update_key;
+
+OG::Graph::Graph() OG_NOEXCEPT {
+    // TODO
+    
+    // libdispatch is not supported on WASI
+    // Tracked via https://github.com/swiftwasm/swift/issues/5565
+    #if !OG_TARGET_OS_WASI
+    static dispatch_once_t make_keys;
+    dispatch_once_f(&make_keys, nullptr, [](void * _Nullable context){
+        pthread_key_create(&_current_update_key, nullptr);
+        OG::Subgraph::make_current_subgraph_key();
+    });
+    #endif
+    
+    // TODO
+}
+
+const void OG::Graph::value_mark_all() const OG_NOEXCEPT {
+    // TODO
+}
+
+void OG::Graph::all_start_profiling(uint32_t) OG_NOEXCEPT {
+    // TODO
+}
+void OG::Graph::all_stop_profiling() OG_NOEXCEPT {
+    // TODO
+}
+void OG::Graph::start_profiling(uint32_t) OG_NOEXCEPT {
+    // TODO
+}
+void OG::Graph::stop_profiling() OG_NOEXCEPT {
+    // TODO
+}
+
+void OG::Graph::write_to_file(const Graph * _Nullable graph, const char * _Nullable name, uint8_t options) OG_NOEXCEPT {
+    @autoreleasepool {
+        NSDictionary <NSString *, id> *options_dict = @{
+            (__bridge NSString *)OGDescriptionFormat: (__bridge NSString *)OGDescriptionFormatDictionary,
+            (__bridge NSString *)OGDescriptionIncludeValues: @((options & 1) == 0),
+            (__bridge NSString *)OGDescriptionAllGraphs: @(graph == nil)
+        };
+        NSString *description = (__bridge NSString *)Graph::description(graph, options_dict);
+        if (description == nil) {
+            return;
+        }
+        const char *cstring_name = name ?: "graph.ag-gzon";
+
+        NSData *data = [NSJSONSerialization dataWithJSONObject:description options:0 error:nil];
+        NSString *file_path = [NSString stringWithUTF8String:cstring_name];
+        if (cstring_name[0] != '/') {
+            file_path = [NSTemporaryDirectory() stringByAppendingPathComponent:file_path];
+        }
+        NSError *error = nil;
+        BOOL success = YES;
+        if ([file_path.pathExtension isEqualToString:@"ag-gzon"]) {
+            gzFile file = gzopen(file_path.fileSystemRepresentation, "wb");
+            if (file != NULL) {
+                const char *bytes = (const char *)[data bytes];
+                NSUInteger remaining = [data length];
+                while (remaining != 0) {
+                    int bytes_written = gzwrite(file, bytes, (unsigned int)remaining);
+                    if (bytes_written <= 0) {
+                        success = NO;
+                        break;
+                    }
+                    bytes += bytes_written;
+                    remaining -= bytes_written;
+                }
+                gzclose(file);
+            }
+        } else {
+            success = [data writeToFile:file_path options:0 error:&error];
+        }
+        if (success) {
+            fprintf(stderr, "Wrote graph data to \"%s\".\n", file_path.UTF8String);
+        } else {
+            fprintf(stderr, "Unable to write to \"%s\": %s\n", file_path.UTF8String, error.description.UTF8String);
+        }
+    }
+}
+
+const bool OG::Graph::thread_is_updating() const OG_NOEXCEPT {
+    void *current = pthread_getspecific(current_key());
+    if (!current) {
+        return false;
+    }
+    // TODO
+    return false;
+}
+
+const bool OG::Graph::is_context_updating(const OG::Graph::Context&) const OG_NOEXCEPT {
+    // TODO
+    return false;
+}
+#endif /* OG_OBJC_FOUNDATION */

Sources/OpenGraph_SPI/Graph/Graph.hpp

@@ -11,8 +11,11 @@
 #include "../Util/assert.hpp"
 
 #if OG_OBJC_FOUNDATION
+
 #include <Foundation/Foundation.h>
+
 const CFStringRef OGDescriptionFormat = CFSTR("format");
+const CFStringRef OGDescriptionIncludeValues = CFSTR("include-values");
 
 CFTypeRef OG::Graph::description(const Graph * _Nullable graph, NSDictionary* dic) {
     // TODO

Sources/OpenGraph_SPI/Graph/Graph.mm

@@ -42,7 +42,11 @@ OGGraphRef OGGraphCreateShared(OGGraphRef storage) {
 }
 
 void OGGraphArchiveJSON(char const * _Nullable name) {
-    OG::Graph::write_to_file(nullptr, name);
+    OG::Graph::write_to_file(nullptr, name, 0);
+}
+
+void OGGraphArchiveJSON2(char const * _Nullable name, uint8_t options) {
+    OG::Graph::write_to_file(nullptr, name, options);
 }
 
 namespace {

Sources/OpenGraph_SPI/Graph/GraphDescription.mm

@@ -20,14 +20,19 @@ typedef const OGDebugServerStorage *OGDebugServer OG_SWIFT_STRUCT;
 // MARK: - Exported C functions
 
 OG_EXTERN_C_BEGIN
+
 OG_EXPORT
 OGDebugServer _Nullable OGDebugServerStart(unsigned int mode) OG_SWIFT_NAME(OGDebugServer.start(mode:));
+
 OG_EXPORT
 void OGDebugServerStop(void) OG_SWIFT_NAME(OGDebugServer.stop());
+
 OG_EXPORT
 CFURLRef _Nullable OGDebugServerCopyURL(void) OG_SWIFT_NAME(OGDebugServer.copyURL());
+
 OG_EXPORT
 void OGDebugServerRun(int timeout) OG_SWIFT_NAME(OGDebugServer.run(timeout:));
+
 OG_EXTERN_C_END
 
 OG_IMPLICIT_BRIDGING_DISABLED