koffi 2.5.15 → 2.5.17

package/CHANGELOG.md

@@ -4,15 +4,20 @@
 
 ### Koffi 2.5
 
-#### Koffi 2.5.15 (2023-08-24)
+#### Koffi 2.5.17 (2023-08-27)
 
-- Run Koffi tests through usual index.js entry point
+- Fix compatibility with Electron
 
-#### Koffi 2.5.14 (2023-08-23)
+#### Koffi 2.5.16 (2023-08-25)
 
+- Run Koffi tests through usual index.js entry point
 - Fix DLL error when using Koffi from NW.js on Windows
 - Simplify NW.js Koffi example
 
+```{warning}
+Pre-built binaries don't work correctly in Koffi 2.5.13 to 2.5.15, skip those versions.
+```
+
 #### Koffi 2.5.12 (2023-08-21)
 
 - Fix native module bundling for FreeBSD ARM64 and Linux RISC-V 64

package/doc/benchmarks.md

@@ -23,10 +23,10 @@ The results presented below were measured on my x86_64 Linux machine (Intel® Co
 
 ### rand results
 
-This test is based around repeated calls to a simple standard C function atoi, and has three implementations:
+This test is based around repeated calls to a simple standard C function `rand`, and has three implementations:
 
-- the first one is the reference, it calls atoi through an N-API module, and is close to the theoretical limit of a perfect (no overhead) Node.js > C FFI implementation (pre-compiled static glue code)
-- the second one calls atoi through Koffi
+- the first one is the reference, it calls rand through an N-API module, and is close to the theoretical limit of a perfect (no overhead) Node.js > C FFI implementation (pre-compiled static glue code)
+- the second one calls rand through Koffi
 - the third one uses the official Node.js FFI implementation, node-ffi-napi
 
 Benchmark     | Iteration time | Relative performance | Overhead
@@ -39,7 +39,7 @@ Because rand is a pretty small function, the FFI overhead is clearly visible.
 
 ### atoi results
 
-This test is similar to the rand one, but it is based on atoi, which takes a string parameter. Javascript (V8) to C string conversion is relatively slow and heavy.
+This test is similar to the rand one, but it is based on `atoi`, which takes a string parameter. Javascript (V8) to C string conversion is relatively slow and heavy.
 
 Benchmark     | Iteration time | Relative performance | Overhead
 ------------- | -------------- | -------------------- | --------
@@ -51,7 +51,7 @@ Because atoi is a pretty small function, the FFI overhead is clearly visible.
 
 ### Raylib results
 
-This benchmark uses the CPU-based image drawing functions in Raylib. The calls are much heavier than in the atoi benchmark, thus the FFI overhead is reduced. In this implementation, Koffi is compared to:
+This benchmark uses the CPU-based image drawing functions in Raylib. The calls are much heavier than in previous benchmarks, thus the FFI overhead is reduced. In this implementation, Koffi is compared to:
 
 - Baseline: Full C++ version of the code (no JS)
 - [node-raylib](https://github.com/RobLoach/node-raylib): This is a native wrapper implemented with N-API
@@ -69,10 +69,10 @@ The results presented below were measured on my x86_64 Windows machine (Intel®
 
 ### rand results
 
-This test is based around repeated calls to a simple standard C function atoi, and has three implementations:
+This test is based around repeated calls to a simple standard C function `rand`, and has three implementations:
 
-- the first one is the reference, it calls atoi through an N-API module, and is close to the theoretical limit of a perfect (no overhead) Node.js > C FFI implementation (pre-compiled static glue code)
-- the second one calls atoi through Koffi
+- the first one is the reference, it calls rand through an N-API module, and is close to the theoretical limit of a perfect (no overhead) Node.js > C FFI implementation (pre-compiled static glue code)
+- the second one calls rand through Koffi
 - the third one uses the official Node.js FFI implementation, node-ffi-napi
 
 Benchmark     | Iteration time | Relative performance | Overhead
@@ -85,7 +85,7 @@ Because rand is a pretty small function, the FFI overhead is clearly visible.
 
 ### atoi results
 
-This test is similar to the rand one, but it is based on atoi, which takes a string parameter. Javascript (V8) to C string conversion is relatively slow and heavy.
+This test is similar to the rand one, but it is based on `atoi`, which takes a string parameter. Javascript (V8) to C string conversion is relatively slow and heavy.
 
 The results below were measured on my x86_64 Windows machine (Intel® Core™ i5-4460):
 

package/doc/start.md

@@ -20,7 +20,7 @@ import koffi from 'koffi';
 
 ## Simple examples
 
-Below you can find three examples:
+Below you can find two examples:
 
 * The first one runs on Linux. The functions are declared with the C-like prototype language.
 * The second one runs on Windows, and uses the node-ffi like syntax to declare functions.

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "koffi",
-    "version": "2.5.15",
-    "stable": "2.5.15",
+    "version": "2.5.17",
+    "stable": "2.5.17",
     "description": "Fast and simple C FFI (foreign function interface) for Node.js",
     "keywords": [
         "foreign",
@@ -25,7 +25,7 @@
     "main": "src/index.js",
     "types": "src/index.d.ts",
     "scripts": {
-        "install": "node src/cnoke/cnoke.js --prebuild -d src/koffi"
+        "install": "node src/cnoke/cnoke.js -p . -d src/koffi --prebuild"
     },
     "license": "MIT",
     "cnoke": {

package/src/cnoke/assets/win_delay_hook.c

@@ -29,41 +29,24 @@
 #include <windows.h>
 #include <delayimp.h>
 
-static HMODULE node_dll;
-static HMODULE nw_dll;
-
 static FARPROC WINAPI self_exe_hook(unsigned int event, DelayLoadInfo *info)
 {
-    if (event == dliStartProcessing) {
-        node_dll = GetModuleHandleA("node.dll");
-        nw_dll = GetModuleHandleA("nw.dll");
-
-        return NULL;
-    }
-
-    if (event == dliNotePreGetProcAddress) {
-        if (node_dll) {
-            FARPROC ret = GetProcAddress(node_dll, info->dlp.szProcName);
-            if (ret)
-                return ret;
-        }
-
-        if (nw_dll) {
-            FARPROC ret = GetProcAddress(nw_dll, info->dlp.szProcName);
-            if (ret)
-                return ret;
-        }
-    }
-
-    if (event == dliNotePreLoadLibrary && _stricmp(info->szDll, "node.exe") != 0) {
-        if (!node_dll) {
-            node_dll = GetModuleHandleA(NULL);
+    static const wchar_t *const NodeLibraries[] = {
+        L"node.dll",
+        NULL
+    };
+
+    if (event == dliNotePreLoadLibrary && !stricmp(info->szDll, "node.exe")) {
+        for (int i = 0; i < sizeof(NodeLibraries) / sizeof(*NodeLibraries); i++) {
+            const wchar_t *name = NodeLibraries[i];
+            HMODULE h = GetModuleHandleW(name);
+
+            if (h)
+                return (FARPROC)h;
         }
-        return (FARPROC)node_dll;
     }
 
     return NULL;
 }
 
 const PfnDliHook __pfnDliNotifyHook2 = self_exe_hook;
-const PfnDliHook __pfnDliFailureHook2 = self_exe_hook;

package/src/cnoke/cnoke.js

@@ -77,7 +77,12 @@ async function main() {
                     throw new Error(`Missing value for ${arg}`);
 
                 config.project_dir = fs.realpathSync(value);
-            } else if (arg == '-o' || arg == '--output') {
+            } else if (arg == '-p' || arg == '--package') {
+                if (value == null)
+                    throw new Error(`Missing value for ${arg}`);
+
+                config.package_dir = fs.realpathSync(value);
+            } else if (arg == '-O' || arg == '--out') {
                 if (value == null)
                     throw new Error(`Missing value for ${arg}`);
 
@@ -153,9 +158,12 @@ Commands:
     clean                                Clean build files
 
 Options:
-    -d, --directory <DIR>                Change project directory
+    -d, --directory <DIR>                Change source directory
                                          (default: current working directory)
-    -O, --output <DIR>                   Change explicit output directory
+    -p, --package <DIR>                  Change package directory
+                                         (default: current working directory)
+
+    -O, --out <DIR>                      Set explicit output directory
                                          (default: ./build)
 
     -B, --config <CONFIG>                Change build type: RelWithDebInfo, Debug, Release

package/src/cnoke/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cnoke",
-  "version": "3.3.2",
+  "version": "4.0.1",
   "description": "Build native Node addons based on CMake, without extra dependency",
   "keywords": [
     "native",

package/src/cnoke/src/builder.js

@@ -36,6 +36,7 @@ function Builder(config = {}) {
 
     let app_dir = config.app_dir;
     let project_dir = config.project_dir;
+    let package_dir = config.package_dir;
 
     if (app_dir == null)
         app_dir = __dirname.replace(/\\/g, '/') + '/..';
@@ -43,6 +44,9 @@ function Builder(config = {}) {
         project_dir = process.cwd();
     app_dir = app_dir.replace(/\\/g, '/');
     project_dir = project_dir.replace(/\\/g, '/');
+    if (package_dir == null)
+        package_dir = project_dir;
+    package_dir = package_dir.replace(/\\/g, '/');
 
     let runtime_version = config.runtime_version;
     let arch = config.arch;
@@ -68,15 +72,14 @@ function Builder(config = {}) {
         let pkg = read_package_json();
 
         if (pkg.cnoke.output != null) {
-            build_dir = pkg.cnoke.output;
+            build_dir = expand_path(pkg.cnoke.output);
 
             if (!tools.path_is_absolute(build_dir))
-                build_dir = project_dir + '/' + build_dir;
+                build_dir = package_dir + '/' + build_dir;
         } else {
             build_dir = project_dir + '/build';
         }
     }
-    build_dir = expand_path(build_dir);
     work_dir = build_dir + `/v${runtime_version}_${arch}`;
 
     let cmake_bin = null;
@@ -285,7 +288,7 @@ function Builder(config = {}) {
                     archive_filename = url;
 
                     if (!tools.path_is_absolute(archive_filename))
-                        archive_filename = path.join(project_dir, archive_filename);
+                        archive_filename = path.join(package_dir, archive_filename);
 
                     if (!fs.existsSync(archive_filename))
                         throw new Error('Cannot find local prebuilt archive');
@@ -302,7 +305,7 @@ function Builder(config = {}) {
             let require_filename = expand_path(pkg.cnoke.require);
 
             if (!tools.path_is_absolute(require_filename))
-                require_filename = path.join(project_dir, require_filename);
+                require_filename = path.join(package_dir, require_filename);
 
             if (fs.existsSync(require_filename)) {
                 let proc = spawnSync(process.execPath, ['-e', 'require(process.argv[1])', require_filename]);
@@ -320,6 +323,21 @@ function Builder(config = {}) {
         tools.unlink_recursive(build_dir);
     };
 
+    function find_parent_directory(dirname, basename)
+    {
+        if (process.platform == 'win32')
+            dirname = dirname.replace(/\\/g, '/');
+
+        do {
+            if (fs.existsSync(dirname + '/' + basename))
+                return dirname;
+
+            dirname = path.dirname(dirname);
+        } while (!dirname.endsWith('/'));
+
+        return null;
+    }
+
     function get_cache_directory() {
         if (process.platform == 'win32') {
             let cache_dir = process.env['APPDATA'];
@@ -404,12 +422,14 @@ function Builder(config = {}) {
     function read_package_json() {
         let pkg = {};
 
-        try {
-            let json = fs.readFileSync(project_dir + '/package.json', { encoding: 'utf-8' });
-            pkg = JSON.parse(json);
-        } catch (err) {
-            if (err.code != 'ENOENT')
-                throw err;
+        if (package_dir != null) {
+            try {
+                let json = fs.readFileSync(package_dir + '/package.json', { encoding: 'utf-8' });
+                pkg = JSON.parse(json);
+            } catch (err) {
+                if (err.code != 'ENOENT')
+                    throw err;
+            }
         }
 
         if (pkg.cnoke == null)

package/src/index.js

@@ -378,8 +378,8 @@ var require_package = __commonJS({
   "build/dist/src/koffi/package.json"(exports2, module2) {
     module2.exports = {
       name: "koffi",
-      version: "2.5.15",
-      stable: "2.5.15",
+      version: "2.5.17",
+      stable: "2.5.17",
       description: "Fast and simple C FFI (foreign function interface) for Node.js",
       keywords: [
         "foreign",

package/src/koffi/examples/electron-builder/package.json

@@ -16,6 +16,6 @@
     "esbuild": "^0.18.17"
   },
   "dependencies": {
-    "koffi": "^2.5.9"
+    "koffi": "2.5.17"
   }
 }

package/src/koffi/examples/electron-forge/package.json

@@ -32,6 +32,6 @@
   },
   "dependencies": {
     "electron-squirrel-startup": "^1.0.0",
-    "koffi": "^2.5.9"
+    "koffi": "^2.5.17"
   }
 }

package/src/koffi/examples/node-esbuild/package.json

@@ -11,6 +11,6 @@
   "license": "ISC",
   "dependencies": {
     "esbuild": "^0.18.17",
-    "koffi": "^2.5.9"
+    "koffi": "^2.5.17"
   }
 }

package/src/koffi/examples/nwjs/src/package.json

@@ -5,6 +5,6 @@
   "author": "Niels Martignène <niels.martignene@protonmail.com>",
   "license": "MIT",
   "dependencies": {
-    "koffi": "^2.5.14"
+    "koffi": "^2.5.17"
   }
 }