@crossbind/core-embind-jsi 2.0.0-beta.62 → 2.0.0-beta.64

package/LICENSE

@@ -19,3 +19,79 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES 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.
+
+==============================================================================
+
+The embind sources in cpp/src/emscripten and js/embind.js are adapted from
+Emscripten (https://github.com/emscripten-core/emscripten), whose license
+follows. The notes on Node.js, musl and third_party/ that end the original file
+concern parts of Emscripten this package does not include.
+
+Emscripten is available under 2 licenses, the MIT license and the
+University of Illinois/NCSA Open Source License.
+
+Both are permissive open source licenses, with little if any
+practical difference between them.
+
+The reason for offering both is that (1) the MIT license is
+well-known, while (2) the University of Illinois/NCSA Open Source
+License allows Emscripten's code to be integrated upstream into
+LLVM, which uses that license, should the opportunity arise.
+
+The full text of both licenses follows.
+
+==============================================================================
+
+Copyright (c) 2010-2014 Emscripten authors, see AUTHORS file.
+
+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, DAMAGES 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.
+
+==============================================================================
+
+Copyright (c) 2010-2014 Emscripten authors, see AUTHORS file.
+All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the
+"Software"), to deal with 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:
+
+    Redistributions of source code must retain the above copyright
+    notice, this list of conditions and the following disclaimers.
+
+    Redistributions in binary form must reproduce the above
+    copyright notice, this list of conditions and the following disclaimers
+    in the documentation and/or other materials provided with the
+    distribution.
+
+    Neither the names of Mozilla,
+    nor the names of its contributors may be used to endorse
+    or promote products derived from this Software without specific prior
+    written permission.
+
+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 CONTRIBUTORS OR COPYRIGHT HOLDERS BE LIABLE FOR
+ANY CLAIM, DAMAGES 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 WITH THE SOFTWARE.

package/README.md

@@ -3,7 +3,7 @@
 The Embind JSI integration tool enables seamless C++ integration with React Native and Expo.
 
 <a href="https://www.npmjs.com/package/@crossbind/core-embind-jsi">
-    <img alt="NPM version" src="https://img.shields.io/npm/v/@crossbind/core-embind-jsi?style=for-the-badge" />
+    <img alt="NPM version" src="https://img.shields.io/npm/v/@crossbind/core-embind-jsi/beta?style=for-the-badge" />
 </a>
 <a href="https://github.com/crossbind/crossbind/blob/main/LICENSE">
     <img alt="License" src="https://img.shields.io/github/license/crossbind/crossbind?style=for-the-badge" />

package/cpp/src/emscripten/bind.cpp

@@ -1054,6 +1054,10 @@ EMSCRIPTEN_BINDINGS(builtin) {
     register_bigint<long long>("long long");
     register_bigint<unsigned long long>("unsigned long long");
   }
+  if constexpr (sizeof(long) == 4) {
+    register_integer<long>("long");
+    register_integer<unsigned long>("unsigned long");
+  }
 
   register_float<float>("float");
   register_float<double>("double");

package/cpp/src/emscripten/bind.h

@@ -17,6 +17,7 @@
 #include <map>
 #include <string>
 #include <type_traits>
+#include <utility>
 #include <vector>
 
 #include "./em_macros.h"
@@ -630,42 +631,21 @@ struct SignatureTranslator<ReturnType (*)(Args...)> { using type = void*; };
 #define call_invoke_4 ({return invoke(fn, args[0], args[1], args[2], args[3]);})
 #define call_invoke(count) (call_invoke_##count)
 
+    namespace internal {
+        // Every JS argument of a call, however many parameters the bound function has.
+        template<typename Invoke, typename Fn, std::size_t... I>
+        EMSCRIPTEN_ALWAYS_INLINE decltype(auto) invokeWithArgs(facebook::jsi::Runtime& rt, Invoke&& invoke, Fn&& fn,
+                const facebook::jsi::Value* args, std::index_sequence<I...>) {
+            return invoke(rt, std::forward<Fn>(fn), args[I]...);
+        }
+    } // end namespace internal
+
 #define callInvoke(count, invokeVar, fnVar) ({ \
-    if constexpr (count == 1) { return invokeVar(rt, fnVar, args[0]); }\
-    else if constexpr (count == 2) { return invokeVar(rt, fnVar, args[0], args[1]); }\
-    else if constexpr (count == 3) { return invokeVar(rt, fnVar, args[0], args[1], args[2]); }\
-    else if constexpr (count == 4) { return invokeVar(rt, fnVar, args[0], args[1], args[2], args[3]); }\
-    else if constexpr (count == 5) { return invokeVar(rt, fnVar, args[0], args[1], args[2], args[3], args[4]); }\
-    else if constexpr (count == 6) { return invokeVar(rt, fnVar, args[0], args[1], args[2], args[3], args[4], args[5]); }\
-    else if constexpr (count == 7) { return invokeVar(rt, fnVar, args[0], args[1], args[2], args[3], args[4], args[5], args[6]); }\
-    else if constexpr (count == 8) { return invokeVar(rt, fnVar, args[0], args[1], args[2], args[3], args[4], args[5], args[6], args[7]); }\
-    else if constexpr (count == 9) { return invokeVar(rt, fnVar, args[0], args[1], args[2], args[3], args[4], args[5], args[6], args[7], args[8]); }\
-    else if constexpr (count == 10) { return invokeVar(rt, fnVar, args[0], args[1], args[2], args[3], args[4], args[5], args[6], args[7], args[8], args[9]); }\
-    else if constexpr (count == 11) { return invokeVar(rt, fnVar, args[0], args[1], args[2], args[3], args[4], args[5], args[6], args[7], args[8], args[9], args[10]); }\
-    else if constexpr (count == 12) { return invokeVar(rt, fnVar, args[0], args[1], args[2], args[3], args[4], args[5], args[6], args[7], args[8], args[9], args[10], args[11]); }\
-    else if constexpr (count == 13) { return invokeVar(rt, fnVar, args[0], args[1], args[2], args[3], args[4], args[5], args[6], args[7], args[8], args[9], args[10], args[11], args[12]); }\
-    else if constexpr (count == 14) { return invokeVar(rt, fnVar, args[0], args[1], args[2], args[3], args[4], args[5], args[6], args[7], args[8], args[9], args[10], args[11], args[12], args[13]); }\
-    else if constexpr (count == 15) { return invokeVar(rt, fnVar, args[0], args[1], args[2], args[3], args[4], args[5], args[6], args[7], args[8], args[9], args[10], args[11], args[12], args[13], args[14]); }\
-    else { return invokeVar(rt, fnVar); }                                              \
+    return ::emscripten::internal::invokeWithArgs(rt, invokeVar, fnVar, args, std::make_index_sequence<(count)>{}); \
 })
 
 #define callInvokeVoid(count, invokeVar, fnVar) ({ \
-    if constexpr (count == 1) { invokeVar(rt, fnVar, args[0]); }\
-    else if constexpr (count == 2) { invokeVar(rt, fnVar, args[0], args[1]); }\
-    else if constexpr (count == 3) { invokeVar(rt, fnVar, args[0], args[1], args[2]); }\
-    else if constexpr (count == 4) { invokeVar(rt, fnVar, args[0], args[1], args[2], args[3]); }\
-    else if constexpr (count == 5) { invokeVar(rt, fnVar, args[0], args[1], args[2], args[3], args[4]); }\
-    else if constexpr (count == 6) { invokeVar(rt, fnVar, args[0], args[1], args[2], args[3], args[4], args[5]); }\
-    else if constexpr (count == 7) { invokeVar(rt, fnVar, args[0], args[1], args[2], args[3], args[4], args[5], args[6]); }\
-    else if constexpr (count == 8) { invokeVar(rt, fnVar, args[0], args[1], args[2], args[3], args[4], args[5], args[6], args[7]); }\
-    else if constexpr (count == 9) { invokeVar(rt, fnVar, args[0], args[1], args[2], args[3], args[4], args[5], args[6], args[7], args[8]); }\
-    else if constexpr (count == 10) { invokeVar(rt, fnVar, args[0], args[1], args[2], args[3], args[4], args[5], args[6], args[7], args[8], args[9]); }\
-    else if constexpr (count == 11) { invokeVar(rt, fnVar, args[0], args[1], args[2], args[3], args[4], args[5], args[6], args[7], args[8], args[9], args[10]); }\
-    else if constexpr (count == 12) { invokeVar(rt, fnVar, args[0], args[1], args[2], args[3], args[4], args[5], args[6], args[7], args[8], args[9], args[10], args[11]); }\
-    else if constexpr (count == 13) { invokeVar(rt, fnVar, args[0], args[1], args[2], args[3], args[4], args[5], args[6], args[7], args[8], args[9], args[10], args[11], args[12]); }\
-    else if constexpr (count == 14) { invokeVar(rt, fnVar, args[0], args[1], args[2], args[3], args[4], args[5], args[6], args[7], args[8], args[9], args[10], args[11], args[12], args[13]); }\
-    else if constexpr (count == 15) { invokeVar(rt, fnVar, args[0], args[1], args[2], args[3], args[4], args[5], args[6], args[7], args[8], args[9], args[10], args[11], args[12], args[13], args[14]); }\
-    else { invokeVar(rt, fnVar); }                                              \
+    ::emscripten::internal::invokeWithArgs(rt, invokeVar, fnVar, args, std::make_index_sequence<(count)>{}); \
 })
 
     template<typename ReturnType, typename... Args, typename... Policies>

package/cpp/src/emscripten/wire.h

@@ -463,6 +463,30 @@ struct BindingType<T, std::enable_if_t<isOther64BitInteger<T>>> {
     }
 };
 
+// Windows keeps long at 32 bits, still a type apart from int: it crosses as a Number like int does.
+template<typename T>
+constexpr bool isNarrowLong = (std::is_same_v<T, long> || std::is_same_v<T, unsigned long>) && sizeof(T) == 4;
+
+template<typename T>
+struct BindingType<T, std::enable_if_t<isNarrowLong<T>>> {
+    typedef T WireType;
+    typedef const facebook::jsi::Value WireType2;
+
+    static WireType toWireType(WireType b) {
+        return b;
+    }
+    static WireType fromWireType(WireType wt) {
+        return wt;
+    }
+
+    static WireType2 toWireType2(facebook::jsi::Runtime& rt, WireType b) {
+        return WireType2((double) b);
+    }
+    static WireType fromWireType2(facebook::jsi::Runtime& rt, WireType2& wt) {
+        return (WireType) wt.getNumber();
+    }
+};
+
     template<>
     struct BindingType<facebook::jsi::Value> {
         typedef const facebook::jsi::Value WireType;

package/js/embind.js

@@ -4,11 +4,6 @@ function warnOnce(msg) {
 
 function callRuntimeCallbacks() { }
 
-// Upstream's helper, left out of this fork. Pointers arrive as BigInt or Number.
-function ptrToString(ptr) {
-  return '0x' + ptr.toString(16).padStart(8, '0');
-}
-
 // include: shell.js
 /**
  * @license
@@ -1813,12 +1808,14 @@ function craftInvokerFunction(humanName, argTypes, classType, cppInvokerFunc, cp
   if (cppInvokerFunc.rawFunction) {
     // Call the host function with a fixed argument list: going through the dyn caller cost a
     // rest array, a slice and a spread call on every call.
-    args1.push("raw", "throwParked");
-    args2.push(cppInvokerFunc.rawFunction, throwParkedError);
+    // The generated code runs in the global scope, so it reaches the parked error through the object this
+    // module calls globalThis: a Node loader bundle gives each runtime its own.
+    args1.push("raw", "throwParked", "crossbindScope");
+    args2.push(cppInvokerFunc.rawFunction, throwParkedError, globalThis);
     invokerFnBody +=
-      "globalThis.__crossbindParkedError = null;\n" +
+      "crossbindScope.__crossbindParkedError = null;\n" +
       (returns || isAsync ? "var rv = " : "") + "raw(" + argsListWired + ");\n" +
-      "if (globalThis.__crossbindParkedError) throwParked();\n";
+      "if (crossbindScope.__crossbindParkedError) throwParked();\n";
   } else {
     invokerFnBody +=
       (returns || isAsync ? "var rv = " : "") + "invoker(fn" + (argsListWired.length > 0 ? ", " : "") + argsListWired + ");\n";
@@ -2437,7 +2434,13 @@ var MIN_INT53 = -9007199254740992;
 function bigintToI53Checked(num) {
   return (num < MIN_INT53 || num > MAX_INT53) ? NaN : Number(num);
 }
+// A value C++ returns by copy crosses through the converter `isReference` marks, though the handle it makes is
+// typed as a pointer to the object's own class: JavaScript owns that copy (ownHandle).
 function RegisteredPointer_fromWireType(ptr) {
+  var handle = handleFromWire.call(this, ptr);
+  return this.isReference && handle ? ownHandle(handle) : handle;
+}
+function handleFromWire(ptr) {
   //console.log('RegisteredPointer_fromWireType', ptr);
   // ptr is a raw pointer (or a raw smartpointer)
   // ptr = bigintToI53Checked(ptr);
@@ -2534,35 +2537,34 @@ function attachFinalizer(handle) {
   // https://github.com/tc39/proposal-weakrefs), then attach finalizers
   // for class handles.  We check for the presence of FinalizationRegistry
   // at run-time, not build-time.
+  // A collected handle is released without the warning upstream prints under ASSERTIONS: it is freed by design.
   finalizationRegistry = new FinalizationRegistry((info) => {
-    console.warn(info.leakWarning.stack.replace(/^Error: /, ''));
     releaseClassHandle(info.$$);
   });
   attachFinalizer = (handle) => {
     var $$ = handle.$$;
     var hasSmartPtr = !!$$.smartPtr;
-    if (hasSmartPtr) {
-      // We should not call the destructor on raw pointers in case other code expects the pointee to live
-      var info = { $$: $$ };
-      // Create a warning as an Error instance in advance so that we can store
-      // the current stacktrace and point to it when / if a leak is detected.
-      // This is more useful than the empty stacktrace of `FinalizationRegistry`
-      // callback.
-      var cls = $$.ptrType.registeredClass;
-      info.leakWarning = new Error(`Embind found a leaked C++ instance ${cls.name} <${ptrToString($$.ptr)}>.\n` +
-        "We'll free it automatically in this case, but this functionality is not reliable across various environments.\n" +
-        "Make sure to invoke .delete() manually once you're done with the instance instead.\n" +
-        "Originally allocated"); // `.stack` will add "at ..." after this sentence
-      if ('captureStackTrace' in Error) {
-        Error.captureStackTrace(info.leakWarning, RegisteredPointer_fromWireType);
-      }
-      finalizationRegistry.register(handle, info, handle);
+    // JavaScript owns an object behind a smart pointer, and one ownHandle marked on the count a handle shares with
+    // its clones, as the wasm glue does after utils/embindObjectLifetime.js. A raw pointer stays its library's:
+    // other code may expect the pointee to live.
+    if (hasSmartPtr || $$.count.owned) {
+      finalizationRegistry.register(handle, { $$: $$ }, handle);
     }
     return handle;
   };
   detachFinalizer = (handle) => finalizationRegistry.unregister(handle);
   return attachFinalizer(handle);
 }
+// A copy embind made of a returned value and an object JavaScript constructed through a raw constructor (a vector,
+// a Rust class) are released as one behind a smart pointer is.
+function ownHandle(handle) {
+  var $$ = handle.$$;
+  if (!$$.smartPtr && !$$.count.owned) {
+    $$.count.owned = true;
+    if (finalizationRegistry) finalizationRegistry.register(handle, { $$: $$ }, handle);
+  }
+  return handle;
+}
 function ClassHandle_clone() {
   if (!this.$$.ptr) {
     throwInstanceAlreadyDeleted(this);
@@ -2960,7 +2962,7 @@ function __embind_register_class(rawType,
         if (undefined === body) {
           throw new BindingError(`Tried to invoke ctor of ${name} with invalid number of parameters (${arguments.length}) - expected (${Object.keys(registeredClass.constructor_body).toString()}) parameters instead!`);
         }
-        return body.apply(this, arguments);
+        return ownHandle(body.apply(this, arguments));
       });
 
       var instancePrototype = Object.create(basePrototype, {
@@ -3698,9 +3700,10 @@ const globalIgnoreList = [
 function emval_get_global() {
   if (typeof globalThis == 'object') {
     const global = {};
-    Object.keys(globalThis).filter(key => !key.startsWith('_') && !globalIgnoreList.includes(key)).forEach(key => {
-      global[key] = globalThis[key];
-    });
+    // for...in: a Node loader bundle's globalThis inherits the global's properties.
+    for (const key in globalThis) {
+      if (!key.startsWith('_') && !globalIgnoreList.includes(key)) global[key] = globalThis[key];
+    }
 
     return global;
   }
@@ -4255,7 +4258,8 @@ function toArray(vector) {
   return output;
 }
 
-function toVector(VectorClass, array = []) {
+function toVector(classOrName, array = []) {
+  const VectorClass = typeof classOrName === 'string' ? Module[classOrName] : classOrName;
   const vector = new VectorClass();
   array.forEach((item) => {
     vector.push_back(item);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@crossbind/core-embind-jsi",
-  "version": "2.0.0-beta.62",
+  "version": "2.0.0-beta.64",
   "description": "The Embind JSI integration tool enables seamless C++ integration with React Native and Expo.",
   "homepage": "https://github.com/crossbind/crossbind/tree/main/core/embind-jsi#readme",
   "repository": {