pre-implement node core ffi

nodejs/node#46905

Author: xan105

lib/node/index.js

@@ -0,0 +1,42 @@
+/*
+Copyright (c) Anthony Beaumont
+This source code is licensed under the MIT License
+found in the LICENSE file in the root directory of this source tree.
+*/
+
+/*
+⚠️ Experimental and not yet tested
+Based on https://github.com/nodejs/node/pull/46905
+*/
+
+import * as deno from "./types/deno.js";
+
+export * from "./open.js";
+export const types = Object.assign(Object.create(null), {
+  //node/lib/ffi.js | These are not exported
+  "void": "void",
+  "char": "char",
+  "signed char": "char",
+  "unsigned char": "uchar",
+  "short": "short",
+  "short int": "short",
+  "signed short": "short",
+  "signed short int": "short",
+  "unsigned short": "ushort",
+  "unsigned short int": "ushort",
+  "int": "int",
+  "signed": "int",
+  "signed int": "int",
+  "unsigned": "uint",
+  "unsigned int": "uint",
+  "long": "long",
+  "long int": "long",
+  "signed long": "long",
+  "signed long int": "long",
+  "unsigned long": "ulong",
+  "unsigned long int": "ulong",
+  "float": "float",
+  "double": "double",
+  "pointer": "pointer",
+  ...deno.types,
+});

lib/node/open.js

@@ -0,0 +1,82 @@
+/*
+Copyright (c) Anthony Beaumont
+This source code is licensed under the MIT License
+found in the LICENSE file in the root directory of this source tree.
+*/
+
+/*
+⚠️ Experimental and not yet tested
+Based on https://github.com/nodejs/node/pull/46905
+*/
+
+import { platform } from "node:process";
+import { getNativeFunction } from "node:ffi";
+import { Failure } from "@xan105/error";
+import { asBoolean, asArray } from "@xan105/is/opt";
+import { 
+  shouldObj, 
+  shouldObjWithinObj,
+  shouldStringNotEmpty
+} from "@xan105/is/assert";
+
+function load(path, option = {}){
+  
+  shouldStringNotEmpty(path);
+  shouldObj(option);
+
+  const options = {
+    ignoreLoadingFail: asBoolean(option.ignoreLoadingFail) ?? false,
+    ignoreMissingSymbol: asBoolean(option.ignoreMissingSymbol) ?? false
+  };
+
+  const ext = {
+    "win32": ".dll",
+    "darwin": ".dylib",
+  }[platform] ?? ".so";
+
+  if (path.indexOf(ext) === -1) path += ext;
+
+  const handle = function(symbol, result, parameters){
+    try{
+      return getNativeFunction(path, symbol, result, parameters);
+    }catch(err){
+      if(err.code === "ERR_FFI_LIBRARY_LOAD_FAILED" && options.ignoreLoadingFail)
+        return undefined;
+      else if (err.code === "ERR_FFI_SYMBOL_NOT_FOUND" && options.ignoreMissingSymbol)
+        return undefined;
+        
+      throw new Failure(err.message, {
+        code: "ERR_FFI", 
+        cause: err, 
+        info: { lib: path, symbol }
+      });
+    }
+  };
+  
+  return handle;
+}
+
+function dlopen(path, symbols, option){
+  
+  shouldObjWithinObj(symbols);
+
+  const lib = Object.create(null);
+  const handle = load(path, option);
+
+  for (const [name, definition] of Object.entries(symbols)){
+    
+    if (name === "__proto__") continue; //not allowed
+    
+    const parameters = asArray(definition.parameters) ?? [];
+    const result = definition.result || "void";
+    const nonblocking = asBoolean(definition.nonblocking) ?? false;
+    const symbol = definition.symbol || name;
+
+    const fn = handle(symbol, result, parameters);
+    if(typeof fn === "function") lib[name] = fn;
+  }
+  
+  return lib;
+}
+
+export { load, dlopen }

lib/node/types/deno.js

@@ -0,0 +1,25 @@
+/*
+Copyright (c) Anthony Beaumont
+This source code is licensed under the MIT License
+found in the LICENSE file in the root directory of this source tree.
+*/
+
+/*
+⚠️ Experimental and not yet tested
+Based on https://github.com/nodejs/node/pull/46905
+*/
+
+export const types = Object.assign(Object.create(null), {
+  i8 : "char",
+  u8 : "char", 
+  i16 : "short",
+  u16 : "ushort",
+  i32 : "int",
+  u32 : "uint",
+  i64 : "long",
+  u64 : "ulong",	
+  //usize : koffi.types.size_t,	
+  f32 : "float",
+  f64 : "double",
+  "function" : "pointer"
+});