feat: compatiblity with NativeScript iOS runtime (#17)

* feat: compatiblity with NativeScript iOS runtime

* fix comment

* call js-defined block from another thread

* fix: expose protocol-defined methods from classes that conform

* start work on types

* patch libffi

* patch config.sub

* add libffi prebuilt binaries

* nit: remove build-libffi instruction from readme

* fix: update libffi include path

* fix: allow Node.js to resolve "objc" from examples dir without package installation (#18)

While Deno could resolve it, Node.js couldn't find "objc" without performing `cd examples && npm install` (which would mean instructing contributors to do npm installs both at root and in a subdir, which is a pain).

After weighing up an amusing number of differently cursed workarounds, we landed on this one.

* feat: add ability to specify metadata path using METADATA_PATH

* feat: add Charon runtime

* work

* more work on types

* ts types closer than ever

* more work on types

* dont emit setter methods for properties that already exist

* optional protocol members

* examples all pass typechecking

* fix ts types

* feat(MetadataGenerator): rewrite using an intermediate format

* spritekit controller demo

* support changing method impls on class definitions

* add target to metagen, start testing core, start working on interop

* work on interop.Pointer

* implement bunch of interop API

* support more overloads of interop.Reference

* more work on Hermes & core compat

* fix(metadata): handle case of no arg being passed (#20)

`deno task metagen` was producing: metadata.undefined.nsmd

Co-authored-by: Dj <43033058+DjDeveloperr@users.noreply.github.com>

* fix: dont use napi_wrap on strings

---------

Co-authored-by: Jamie Birch <14055146+shirakaba@users.noreply.github.com>

Author: DjDeveloperr

.gitignore

@@ -4,6 +4,10 @@ build/
 deno.lock
 package-lock.json
 node_modules/
+# This node_modules is manually created and version-controlled. Inside it, we
+# commit a symlink back up to our root-level "objc" package. It avoids having
+# to do a package install both at root level and in the examples directory.
+!examples/node_modules
 NativeScript for macOS.app/
 *.dylib
 libffi/build_*

CMakeLists.txt

@@ -24,7 +24,7 @@ if(BRIDGE_TARGET_PLATFORM STREQUAL "ios")
   set(CMAKE_XCODE_ATTRIBUTE_TARGETED_DEVICE_FAMILY "1,2")
   set(CMAKE_XCODE_ATTRIBUTE_ENABLE_BITCODE "NO")
   set(CMAKE_OSX_DEPLOYMENT_TARGET "13.0")
-  set(LIBFFI_BUILD "build_iphoneos-arm64")
+  set(LIBFFI_BUILD "iphoneos-arm64")
   set(TARGET_PLATFORM_IOS TRUE)
   set(SDK_NAME "iphoneos")
   set(CMAKE_OSX_ARCHITECTURES "arm64")
@@ -33,15 +33,15 @@ elseif(BRIDGE_TARGET_PLATFORM STREQUAL "ios-sim")
   set(CMAKE_XCODE_ATTRIBUTE_TARGETED_DEVICE_FAMILY "1,2")
   set(CMAKE_XCODE_ATTRIBUTE_ENABLE_BITCODE "NO")
   set(CMAKE_OSX_DEPLOYMENT_TARGET "13.0")
-  set(LIBFFI_BUILD "build_iphonesimulator-universal")
+  set(LIBFFI_BUILD "iphonesimulator-universal")
   set(TARGET_PLATFORM_IOS TRUE)
   set(TARGET_PLATFORM_SIM TRUE)
   set(SDK_NAME "iphonesimulator")
   set(CMAKE_OSX_ARCHITECTURES "arm64;x86_64")
 elseif(BRIDGE_TARGET_PLATFORM STREQUAL "macos")
   set(CMAKE_XCODE_ATTRIBUTE_MACOSX_DEPLOYMENT_TARGET "13.0")
   set(CMAKE_OSX_DEPLOYMENT_TARGET "13.0")
-  set(LIBFFI_BUILD "build_macosx-universal")
+  set(LIBFFI_BUILD "macosx-universal")
   set(TARGET_PLATFORM_MACOS TRUE)
   unset(BUILD_FRAMEWORK)
   set(SDK_NAME "macosx")
@@ -78,7 +78,7 @@ message(STATUS "SDK = ${CMAKE_OSX_SYSROOT}")
 include_directories(
   ${CMAKE_CURRENT_SOURCE_DIR}/include
   ${CMAKE_CURRENT_SOURCE_DIR}/metadata/include
-  ${CMAKE_CURRENT_SOURCE_DIR}/libffi/${LIBFFI_BUILD}/include
+  ${CMAKE_CURRENT_SOURCE_DIR}/libffi/prebuilt/${LIBFFI_BUILD}/include
   /Library/Developer/CommandLineTools/usr/include
 )
 
@@ -102,6 +102,7 @@ set(LIB_SOURCE_FILES
   src/Object.mm
   src/CustomClass.mm
   src/CFunction.mm
+  src/Interop.mm
 )
 
 add_library(
@@ -159,14 +160,14 @@ message(STATUS "LIBFFI_BUILD = ${LIBFFI_BUILD}")
 target_link_directories(
   ${NAME}
   PRIVATE
-  ${CMAKE_CURRENT_SOURCE_DIR}/libffi/${LIBFFI_BUILD}/.libs
+  ${CMAKE_CURRENT_SOURCE_DIR}/libffi/prebuilt/${LIBFFI_BUILD}
 )
 
 target_link_libraries(
   ${NAME}
   PRIVATE
   objc
-  ffi_convenience
+  ffi
   "-framework Foundation"
 )
 

README.md

@@ -6,8 +6,6 @@ JavaScript land. Made using Node-API and `libffi` under the hood.
 ## Building
 
 ```sh
-deno task build-libffi
-
 deno task build macos
 # or build for iOS
 deno task build ios-universal

bench/main.js

@@ -1,26 +1,22 @@
 import "objc";
 import { bench, run } from "mitata";
 
-const str = NSString.stringWithUTF8String("Hello World");
+const arr = NSMutableArray.arrayWithCapacity(100);
 
-const str2 = new Proxy(str, {
+const arr2 = new Proxy(arr, {
   get: (target, prop) => {
     return target[prop];
   },
 });
 
 bench("noop", () => {});
 
-bench("[str length] (manual, direct)", () => {
-  str.lengthCustom;
+bench("[arr count] (dynamic, ffi)", () => {
+  arr.count;
 });
 
-bench("[str length] (dynamic, ffi)", () => {
-  str.length;
-});
-
-bench("[str length] (dynamic, proxy)", () => {
-  str2.length;
+bench("[arr count] (dynamic, proxy)", () => {
+  arr2.count;
 });
 
 await run({

core-test/.gitignore

@@ -0,0 +1,2 @@
+dist/
+core/

core-test/deno.json

@@ -0,0 +1,6 @@
+{
+  "tasks": {
+    "transform-core": "rm -rf ./core && cp -r ../../NativeScript/dist/packages/core ./core && deno run -A --unstable transform_core.js ios",
+    "bundle": "./node_modules/.bin/esbuild --bundle --outfile=/Users/dj/Projects/hermes-testing/HermesTest/HermesTest/main.js --format=esm src/index.js"
+  }
+}

core-test/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "core-test",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "@swc/cli": "^0.1.62",
+    "@swc/core": "^1.3.95",
+    "esbuild": "0.19.5"
+  },
+  "dependencies": {
+    "@nativescript/core": "file:../../NativeScript/packages/core",
+    "acorn": "^8.11.2",
+    "css-tree": "^2.3.1",
+    "emoji-regex": "^10.3.0",
+    "objc": "file:..",
+    "reduce-css-calc": "^2.1.8",
+    "tslib": "^2.6.2"
+  }
+}

core-test/spack.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  entry: {
+    web: __dirname + "/src/index.ts",
+  },
+  output: {
+    path: __dirname + "/dist",
+  },
+};

core-test/src/compat.js

@@ -0,0 +1,28 @@
+globalThis.global = globalThis;
+
+globalThis.__ANDROID__ = false;
+globalThis.__IOS__ = true;
+globalThis.__VISIONOS__ = false;
+globalThis.__dirname = NSBundle.mainBundle.bundlePath;
+
+function NativeScriptEmbedder() {}
+
+globalThis.NativeScriptEmbedder = NativeScriptEmbedder;
+
+globalThis.nativeScriptEmbedder = new NativeScriptEmbedder();
+
+NativeScriptEmbedder.sharedInstance = function () {
+    return nativeScriptEmbedder;
+};
+
+NativeScriptEmbedder.prototype.setDelegate = function (delegate) {
+    this.delegate = delegate;
+};
+
+WeakRef.prototype.get = function () {
+  return this.deref();
+};
+
+globalThis.CGRectMake = function (x, y, width, height) {
+  return { origin: { x, y }, size: { width, height } };
+};

core-test/src/index.js

@@ -0,0 +1,11 @@
+import "./compat.js";
+import "../core/globals/index.js";
+import { StackLayout, Application } from "../core/index.js";
+
+Application.run({
+  create: () => {
+    const stackLayout = new StackLayout();
+    stackLayout.backgroundColor = "yellow";
+    return stackLayout;
+  },
+});