feat: memory management model for custom props (#1)

* feat: memory management model for custom props

* fix warnings

* refactor closures code, fix NSMethodSignature crash, add webgpu example, add Symbols framework to metadata generator script, interop.handleof implementation

Author: DjDeveloperr

examples/appkit.js

@@ -55,7 +55,7 @@ export class Window extends NSWindow {
         NSWindowStyleMask.Miniaturizable |
         NSWindowStyleMask.Resizable,
       2,
-      false
+      false,
     );
 
     this.title = "NativeScript for macOS";
@@ -70,7 +70,7 @@ export class Window extends NSWindow {
       118 / 255,
       171 / 255,
       235 / 255,
-      1
+      1,
     );
 
     const label = NSTextField.alloc().initWithFrame({
@@ -90,7 +90,7 @@ export class Window extends NSWindow {
 
     label.font = NSFontManager.sharedFontManager.convertFontToHaveTrait(
       NSFont.fontWithNameSize(label.font.fontName, 45),
-      NSFontTraitMask.Bold
+      NSFontTraitMask.Bold,
     );
 
     label.sizeToFit();
@@ -107,7 +107,7 @@ export class Window extends NSWindow {
     vstack.translatesAutoresizingMaskIntoConstraints = false;
 
     const image = NSImage.alloc().initWithContentsOfFile(
-      new URL("../assets/NativeScript.png", import.meta.url).pathname
+      new URL("../assets/NativeScript.png", import.meta.url).pathname,
     );
 
     image.size = { width: 128, height: 128 };
@@ -120,10 +120,10 @@ export class Window extends NSWindow {
     this.contentView.addSubview(vstack);
 
     vstack.centerXAnchor.constraintEqualToAnchor(
-      this.contentView.centerXAnchor
+      this.contentView.centerXAnchor,
     ).isActive = true;
     vstack.centerYAnchor.constraintEqualToAnchor(
-      this.contentView.centerYAnchor
+      this.contentView.centerYAnchor,
     ).isActive = true;
 
     return this;
@@ -160,7 +160,7 @@ interop.addMethod(
         NSEventMask.Any,
         null,
         "kCFRunLoopDefaultMode",
-        true
+        true,
       );
 
       if (event != null) {
@@ -169,6 +169,7 @@ interop.addMethod(
 
       if (this.running) {
         setTimeout(loop, 10);
+        // queueMicrotask(loop);
       }
     };
 
@@ -177,7 +178,7 @@ interop.addMethod(
     setTimeout(() => {
       console.log("[setTimeout] after 2 seconds");
     }, 2000);
-  }
+  },
 );
 
 NSApp.delegate = delegate;

examples/memory_management.js

@@ -0,0 +1,38 @@
+import "@nativescript/macos-node-api";
+
+let array, weakRef;
+
+const finalizationRegistry = new FinalizationRegistry((value) => {
+  console.log("finalized", value);
+
+  const obj = array[0];
+
+  console.log("got object from array", obj);
+  console.log("custom property after gc", obj.helloWorld);
+});
+
+(() => {
+  const obj = NSObject.new();
+
+  obj.helloWorld = "Hello, world!";
+
+  console.log("created object", obj);
+  console.log("custom property before gc", obj.helloWorld);
+
+  finalizationRegistry.register(obj, "NativeObject");
+
+  // weakRef = new WeakRef(obj);
+
+  array = NSMutableArray.arrayWithCapacity(1);
+  array.addObject(obj);
+
+  console.log("added object to array", array);
+})();
+
+console.log("out of scope");
+
+gc();
+
+console.log("gc called");
+
+// console.log("weakRef", weakRef.deref());

examples/webgpu.ts

@@ -0,0 +1,179 @@
+import "@nativescript/macos-node-api";
+
+const adapter = await navigator.gpu.requestAdapter();
+const device = await adapter!.requestDevice();
+
+@NativeClass
+export class ApplicationDelegate
+  extends NSObject
+  implements NSApplicationDelegate
+{
+  static ObjCProtocols = [NSApplicationDelegate];
+
+  running = true;
+  window: Window | null = null;
+
+  applicationDidFinishLaunching(_notification: NSNotification) {
+    this.window = Window.new();
+  }
+
+  applicationWillTerminate(_notification: NSNotification) {
+    this.running = false;
+  }
+}
+
+@NativeClass
+export class Window extends NSWindow implements NSWindowDelegate {
+  static ObjCProtocols = [NSWindowDelegate];
+
+  surface!: Deno.UnsafeWindowSurface;
+  context!: GPUCanvasContext;
+  renderPipeline!: GPURenderPipeline;
+
+  init() {
+    const menu = NSMenu.new();
+    NSApp.mainMenu = menu;
+
+    const appMenuItem = NSMenuItem.new();
+    menu.addItem(appMenuItem);
+
+    const appMenu = NSMenu.new();
+    appMenuItem.submenu = appMenu;
+
+    appMenu.addItemWithTitleActionKeyEquivalent("Quit", "terminate:", "q");
+
+    super.initWithContentRectStyleMaskBackingDefer(
+      { origin: { x: 0, y: 0 }, size: { width: 500, height: 500 } },
+      NSWindowStyleMask.Titled |
+        NSWindowStyleMask.Closable |
+        NSWindowStyleMask.Miniaturizable |
+        NSWindowStyleMask.Resizable,
+      2,
+      false
+    );
+
+    this.title = "NativeScript for macOS";
+    this.delegate = this;
+
+    this.isReleasedWhenClosed = false;
+
+    this.surface = new Deno.UnsafeWindowSurface(
+      "cocoa",
+      Deno.UnsafePointer.create(BigInt(interop.handleof(this).toNumber())),
+      Deno.UnsafePointer.create(
+        BigInt(interop.handleof(this.contentView).toNumber())
+      )
+    );
+
+    const { width, height } = this.convertRectToBacking(this.frame).size;
+
+    this.context = this.surface.getContext("webgpu");
+
+    this.context.configure({
+      device,
+      format: "bgra8unorm",
+      width,
+      height,
+    });
+
+    const shaderCode = `
+@vertex
+fn vs_main(@builtin(vertex_index) in_vertex_index: u32) -> @builtin(position) vec4<f32> {
+  let x = f32(i32(in_vertex_index) - 1);
+  let y = f32(i32(in_vertex_index & 1u) * 2 - 1);
+  return vec4<f32>(x, y, 0.0, 1.0);
+}
+
+@fragment
+fn fs_main() -> @___location(0) vec4<f32> {
+  return vec4<f32>(1.0, 0.0, 0.0, 1.0);
+}
+`;
+
+    const shaderModule = device.createShaderModule({
+      code: shaderCode,
+    });
+
+    const pipelineLayout = device.createPipelineLayout({
+      bindGroupLayouts: [],
+    });
+
+    this.renderPipeline = device.createRenderPipeline({
+      layout: pipelineLayout,
+      vertex: {
+        module: shaderModule,
+        entryPoint: "vs_main",
+      },
+      fragment: {
+        module: shaderModule,
+        entryPoint: "fs_main",
+        targets: [
+          {
+            format: "bgra8unorm",
+          },
+        ],
+      },
+    });
+
+    NSApp.activateIgnoringOtherApps(true);
+
+    this.makeKeyAndOrderFront(NSApp);
+
+    this.center();
+
+    return this;
+  }
+
+  render() {
+    const encoder = device.createCommandEncoder();
+    const texture = this.context.getCurrentTexture().createView();
+    const renderPass = encoder.beginRenderPass({
+      colorAttachments: [
+        {
+          view: texture,
+          storeOp: "store",
+          loadOp: "clear",
+          clearValue: { r: 0, g: 1, b: 0, a: 1.0 },
+        },
+      ],
+    });
+    renderPass.setPipeline(this.renderPipeline);
+    renderPass.draw(3, 1);
+    renderPass.end();
+    device.queue.submit([encoder.finish()]);
+    this.surface.present();
+  }
+
+  windowWillClose(_notification: NSNotification) {
+    NSApp.terminate(this);
+  }
+}
+
+const NSApp = NSApplication.sharedApplication;
+
+NSApp.setActivationPolicy(NSApplicationActivationPolicy.Regular);
+
+const delegate = ApplicationDelegate.new();
+
+NSApp.delegate = delegate;
+
+NSApp.finishLaunching();
+
+while (true) {
+  const event = NSApp.nextEventMatchingMaskUntilDateInModeDequeue(
+    NSEventMask.Any,
+    null,
+    "kCFRunLoopDefaultMode",
+    true
+  );
+
+  if (event != null) {
+    NSApp.sendEvent(event);
+  }
+
+  if (!delegate.running) {
+    break;
+  }
+
+  delegate.window?.render();
+}

include/ObjCBridge.h

@@ -26,6 +26,8 @@ using namespace metagen;
 
 namespace objc_bridge {
 
+void finalize_objc_object(napi_env /*env*/, void *data, void *hint);
+
 // Determines how retain/release should be called when an Objective-C
 // object is exposed to JavaScript land.
 typedef enum ObjectOwnership {
@@ -68,7 +70,7 @@ class ObjCBridgeState {
   MethodCif *getMethodCif(napi_env env, MDSectionOffset offset);
 
   napi_value proxyNativeObject(napi_env env, napi_value object,
-                               bool isArray = false);
+                               id nativeObject);
 
   napi_value getObject(napi_env env, id object, napi_value constructor,
                        ObjectOwnership ownership = kUnownedObject);
@@ -112,6 +114,7 @@ class ObjCBridgeState {
   napi_ref referenceClass;
   napi_ref createNativeProxy;
   napi_ref createFastEnumeratorIterator;
+  napi_ref transferOwnershipToNative;
 
   std::unordered_map<MDSectionOffset, ObjCClass *> classes;
   std::unordered_map<MDSectionOffset, ObjCProtocol *> protocols;

metadata/metadata.macos.nsmd

@@ -221,16 +221,6 @@ declare class AVAudioTime extends NSObject {
   readonly audioTimeStamp: AudioTimeStamp;
 }
 
-declare class AVAudioEnvironmentReverbParameters extends NSObject {
-  enable: boolean;
-
-  level: number;
-
-  readonly filterParameters: AVAudioUnitEQFilterParameters;
-
-  loadFactoryReverbPreset(preset: interop.Enum<typeof AVAudioUnitReverbPreset>): void;
-}
-
 declare class AVAudioPCMBuffer extends AVAudioBuffer {
   initWithPCMFormatFrameCapacity(format: AVAudioFormat, frameCapacity: number): this;
 
@@ -452,6 +442,16 @@ declare class AVAudioFormat extends NSObject implements NSSecureCoding {
   initWithCoder(coder: NSCoder): this;
 }
 
+declare class AVAudioEnvironmentReverbParameters extends NSObject {
+  enable: boolean;
+
+  level: number;
+
+  readonly filterParameters: AVAudioUnitEQFilterParameters;
+
+  loadFactoryReverbPreset(preset: interop.Enum<typeof AVAudioUnitReverbPreset>): void;
+}
+
 declare class AVAudioIONode extends AVAudioNode {
   readonly presentationLatency: number;
 
@@ -668,6 +668,8 @@ declare class AVAudioEnvironmentNode extends AVAudioNode implements AVAudioMixin
 
   readonly applicableRenderingAlgorithms: NSArray;
 
+  isListenerHeadTrackingEnabled: boolean;
+
   destinationForMixerBus(mixer: AVAudioNode, bus: number): AVAudioMixingDestination;
 
   volume: number;