koffi 1.3.12 → 2.1.0-beta.1

package/CMakeLists.txt

@@ -15,11 +15,6 @@ cmake_minimum_required(VERSION 3.6)
 project(koffi C CXX ASM)
 
 include(CheckCXXCompilerFlag)
-if(CMAKE_VERSION VERSION_GREATER_EQUAL "3.9.0")
-    cmake_policy(SET CMP0069 NEW)
-    include(CheckIPOSupported)
-    check_ipo_supported(RESULT USE_LTO)
-endif()
 
 find_package(CNoke)
 
@@ -113,14 +108,17 @@ endif()
 if(NOT MSVC OR CMAKE_C_COMPILER_ID MATCHES "[Cc]lang")
     # Restore C/C++ compiler sanity
 
-    target_compile_options(koffi PRIVATE -fno-exceptions -fno-strict-aliasing -fwrapv
-                                         -fno-delete-null-pointer-checks)
+    if(NOT MSVC)
+        target_compile_options(koffi PRIVATE -fno-exceptions -fno-strict-aliasing -fwrapv
+                                             -fno-delete-null-pointer-checks)
+    else()
+        target_compile_options(koffi PRIVATE -fno-strict-aliasing /clang:-fwrapv
+                                             -fno-delete-null-pointer-checks)
+    endif()
 
     check_cxx_compiler_flag(-fno-finite-loops use_no_finite_loops)
     if(use_no_finite_loops)
         target_compile_options(koffi PRIVATE -fno-finite-loops)
     endif()
 endif()
-if(USE_LTO)
-    set_target_properties(koffi PROPERTIES INTERPROCEDURAL_OPTIMIZATION TRUE)
-endif()
+enable_unity_build(koffi)

package/ChangeLog.md

@@ -1,18 +1,50 @@
 # Changelog
 
-## Koffi 1.3.12
+## History
+
+### Koffi 2.0.1
+
+**Main changes:**
+
+- Return `undefined` (instead of null) for `void` functions
+
+### Koffi 2.0.0
+
+**Major new features:**
+
+- Add [disposable types](functions.md#heap-allocated-values) for automatic disposal of C values (such as heap-allocated strings)
+- Add support for [registered callbacks](functions.md#registered-callbacks), that can be called after the initial FFI call
+- Support named pointer types
+- Support complex type specifications outside of prototype parser
+
+**Minor new features:**
+
+- Support type aliases with `koffi.alias()`
+- Add `koffi.resolve()` to resolve type strings
+- Expose all primitive type aliases in `koffi.types`
+- Correctly pass exceptions thrown in JS callbacks
+
+**Breaking API changes:**
+
+- Change handling of callback types, which must be used through pointers
+- Change handling of opaque handles, which must be used through pointers
+- Support all types in `koffi.introspect(type)`
+
+Consult the [migration guide](changes.md#migration-guide) for more information.
+
+### Koffi 1.3.12
 
 **Main fixes:**
 
 - Fix support for Yarn package manager
 
-## Koffi 1.3.11
+### Koffi 1.3.11
 
 **Main fixes:**
 
 - Fix broken parsing of `void *` when used for first parameter
 
-## Koffi 1.3.10
+### Koffi 1.3.10
 
 **Main fixes:**
 
@@ -24,13 +56,13 @@
 
 - Various documentation fixes and improvements
 
-## Koffi 1.3.9
+### Koffi 1.3.9
 
 **Main fixes:**
 
 - Fix prebuild compatibility with Electron on Windows x64
 
-## Koffi 1.3.8
+### Koffi 1.3.8
 
 **Main changes:**
 
@@ -41,7 +73,7 @@
 
 - Fix and harmonize a few error messages
 
-## Koffi 1.3.7
+### Koffi 1.3.7
 
 **Main fixes:**
 
@@ -54,7 +86,7 @@
 - Add str/str16 type aliases for string/string16
 - Various documentation fixes and improvements
 
-## Koffi 1.3.6
+### Koffi 1.3.6
 
 **Main fixes:**
 
@@ -66,7 +98,7 @@
 - Prebuild with Clang for Windows x64 and Linux x64 binaries
 - Various documentation improvements
 
-## Koffi 1.3.5
+### Koffi 1.3.5
 
 **Main changes:**
 
@@ -78,13 +110,13 @@
 - Reduce default async memory stack and heap size
 - Various documentation improvements
 
-## Koffi 1.3.4
+### Koffi 1.3.4
 
 **Main fixes:**
 
 - Fix possible OpenBSD i386 crash with `(void)` functions
 
-## Koffi 1.3.3
+### Koffi 1.3.3
 
 **Main fixes:**
 
@@ -96,20 +128,20 @@
 - Disable unsafe compiler optimizations
 - Various documentation improvements
 
-## Koffi 1.3.2
+### Koffi 1.3.2
 
 **Main fixes:**
 
 - Support compilation in C++14 mode (graceful degradation)
 - Support older toolchains on Linux (tested on Debian 9)
 
-## Koffi 1.3.1
+### Koffi 1.3.1
 
 **Main fixes:**
 
 - The prebuilt binary is tested when Koffi is installed, and a rebuild happens if it fails to load
 
-## Koffi 1.3.0
+### Koffi 1.3.0
 
 **Major changes:**
 
@@ -125,19 +157,19 @@
 - Detect floating-point ABI before using prebuilt binaries (ARM32, RISC-V)
 - Forbid duplicate member names in struct types
 
-## Koffi 1.2.4
+### Koffi 1.2.4
 
 **New features:**
 
 - Windows ARM64 is now supported
 
-## Koffi 1.2.3
+### Koffi 1.2.3
 
 **New features:**
 
 - A prebuilt binary for macOS ARM64 (M1) is now included
 
-## Koffi 1.2.1
+### Koffi 1.2.1
 
 This entry documents changes since version 1.1.0.
 

package/README.md

@@ -23,6 +23,12 @@ RISC-V 64 [^3]     | ⬜️ *N/A*    | ✅ Yes   | ⬜️ *N/A*    | 🟨 Probab
 
 Go to the web site for more information: https://koffi.dev/
 
+# Project history
+
+You can consult the [changelog](https://koffi.dev/changes) on the official website.
+
+Major version increments can include breaking API changes, use the [migration guide](https://koffi.dev/changes#migration-guide) for more information.
+
 # License
 
 This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

package/benchmark/atoi_koffi.js

@@ -26,14 +26,14 @@ let sum = 0;
 main();
 
 function main() {
-    let iterations = 20000000;
+    let time = 5000;
 
     if (process.argv.length >= 3) {
-        iterations = parseInt(process.argv[2], 10);
-        if (Number.isNaN(iterations))
+        time = parseFloat(process.argv[2]) * 1000;
+        if (Number.isNaN(time))
             throw new Error('Not a valid number');
-        if (iterations < 1)
-            throw new Error('Value must be positive');
+        if (time < 0)
+            throw new Error('Time must be positive');
     }
 
     let lib = koffi.load(process.platform == 'win32' ? 'msvcrt.dll' : null);
@@ -41,11 +41,15 @@ function main() {
     const atoi = lib.cdecl('atoi', 'int', ['str']);
 
     let start = performance.now();
+    let iterations = 0;
 
-    for (let i = 0; i < iterations; i++) {
-        sum += atoi(strings[i % strings.length]);
+    while (performance.now() - start < time) {
+        for (let i = 0; i < 1000000; i++)
+            sum += atoi(strings[i % strings.length]);
+
+        iterations += 1000000;
     }
 
-    let time = performance.now() - start;
+    time = performance.now() - start;
     console.log(JSON.stringify({ iterations: iterations, time: Math.round(time) }));
 }

package/benchmark/atoi_napi.js

@@ -26,22 +26,26 @@ let sum = 0;
 main();
 
 function main() {
-    let iterations = 20000000;
+    let time = 5000;
 
     if (process.argv.length >= 3) {
-        iterations = parseInt(process.argv[2], 10);
-        if (Number.isNaN(iterations))
+        time = parseFloat(process.argv[2]) * 1000;
+        if (Number.isNaN(time))
             throw new Error('Not a valid number');
-        if (iterations < 1)
-            throw new Error('Value must be positive');
+        if (time < 0)
+            throw new Error('Time must be positive');
     }
 
     let start = performance.now();
+    let iterations = 0;
 
-    for (let i = 0; i < iterations; i++) {
-        sum += atoi.atoi(strings[i % strings.length]);
+    while (performance.now() - start < time) {
+        for (let i = 0; i < 1000000; i++)
+            sum += atoi.atoi(strings[i % strings.length]);
+
+        iterations += 1000000;
     }
 
-    let time = performance.now() - start;
+    time = performance.now() - start;
     console.log(JSON.stringify({ iterations: iterations, time: Math.round(time) }));
 }

package/benchmark/atoi_node_ffi.js

@@ -28,14 +28,14 @@ let sum = 0;
 main();
 
 async function main() {
-    let iterations = 200000;
+    let time = 5000;
 
     if (process.argv.length >= 3) {
-        iterations = parseInt(process.argv[2], 10);
-        if (Number.isNaN(iterations))
+        time = parseFloat(process.argv[2]) * 1000;
+        if (Number.isNaN(time))
             throw new Error('Not a valid number');
-        if (iterations < 1)
-            throw new Error('Value must be positive');
+        if (time < 0)
+            throw new Error('Time must be positive');
     }
 
     const lib = ffi.Library(process.platform == 'win32' ? 'msvcrt.dll' : null, {
@@ -43,14 +43,15 @@ async function main() {
     });
 
     let start = performance.now();
+    let iterations = 0;
 
-    for (let i = 0; i < iterations; i++) {
-        if (i % 1000000 == 0)
-            await new Promise(resolve => setTimeout(resolve, 0));
+    while (performance.now() - start < time) {
+        for (let i = 0; i < 1000000; i++)
+            sum += lib.atoi(strings[i % strings.length]);
 
-        sum += lib.atoi(strings[i % strings.length]);
+        iterations += 1000000;
     }
 
-    let time = performance.now() - start;
+    time = performance.now() - start;
     console.log(JSON.stringify({ iterations: iterations, time: Math.round(time) }));
 }

package/benchmark/raylib_cc.cc

@@ -18,10 +18,10 @@ namespace RG {
 
 int Main(int argc, char **argv)
 {
-    int iterations = 360000;
+    int time = 5000;
 
     if (argc >= 2) {
-        if (!ParseInt(argv[1], &iterations))
+        if (!ParseInt(argv[1], &time))
             return 1;
     }
 
@@ -34,15 +34,16 @@ int Main(int argc, char **argv)
     Font font = GetFontDefault();
 
     int64_t start = GetMonotonicTime();
+    int64_t iterations = 0;
 
-    for (int i = 0; i < iterations; i += 3600) {
+    while (GetMonotonicTime() - start < time) {
         ImageClearBackground(&img, Color { 0, 0, 0, 255 });
 
-        for (int j = 0; j < 3600; j++) {
+        for (int i = 0; i < 3600; i++) {
             const char *text = "Hello World!";
             float text_width = MeasureTextEx(font, text, 10, 1).x;
 
-            double angle = (j * 7) * PI / 180;
+            double angle = (i * 7) * PI / 180;
             Color color = {
                 (unsigned char)(127.5 + 127.5 * sin(angle)),
                 (unsigned char)(127.5 + 127.5 * sin(angle + PI / 2)),
@@ -50,16 +51,18 @@ int Main(int argc, char **argv)
                 255
             };
             Vector2 pos = {
-                (float)((img.width / 2 - text_width / 2) + j * 0.1 * cos(angle - PI / 2)),
-                (float)((img.height / 2 - 16) + j * 0.1 * sin(angle - PI / 2))
+                (float)((img.width / 2 - text_width / 2) + i * 0.1 * cos(angle - PI / 2)),
+                (float)((img.height / 2 - 16) + i * 0.1 * sin(angle - PI / 2))
             };
 
             ImageDrawTextEx(&img, font, text, pos, 10, 1, color);
         }
+
+        iterations += 3600;
     }
 
-    int64_t time = GetMonotonicTime() - start;
-    PrintLn("{\"iterations\": %1,\"time\": %2}", iterations, time);
+    time = GetMonotonicTime() - start;
+    PrintLn("{\"iterations\": %1, \"time\": %2}", iterations, time);
 
     return 0;
 }

package/benchmark/raylib_koffi.js

@@ -14,7 +14,6 @@
 // along with this program. If not, see https://www.gnu.org/licenses/.
 
 const koffi = require('./build/koffi.node');
-const path = require('path');
 
 const Color = koffi.struct('Color', {
     r: 'uchar',
@@ -71,17 +70,17 @@ const Font = koffi.struct('Font', {
 main();
 
 function main() {
-    let iterations = 360000;
+    let time = 5000;
 
     if (process.argv.length >= 3) {
-        iterations = parseInt(process.argv[2], 10);
-        if (Number.isNaN(iterations))
+        time = parseFloat(process.argv[2]) * 1000;
+        if (Number.isNaN(time))
             throw new Error('Not a valid number');
-        if (iterations < 1)
-            throw new Error('Value must be positive');
+        if (time < 0)
+            throw new Error('Time must be positive');
     }
 
-    let lib_filename = path.dirname(__filename) + '/build/raylib' + koffi.extension;
+    let lib_filename = __dirname + '/build/raylib' + koffi.extension;
     let lib = koffi.load(lib_filename);
 
     const InitWindow = lib.cdecl('InitWindow', 'void', ['int', 'int', 'str']);
@@ -103,15 +102,16 @@ function main() {
     let font = GetFontDefault();
 
     let start = performance.now();
+    let iterations = 0;
 
-    for (let i = 0; i < iterations; i += 3600) {
+    while (performance.now() - start < time) {
         ImageClearBackground(img, { r: 0, g: 0, b: 0, a: 255 });
 
-        for (let j = 0; j < 3600; j++) {
+        for (let i = 0; i < 3600; i++) {
             let text = 'Hello World!';
             let text_width = MeasureTextEx(font, text, 10, 1).x;
 
-            let angle = (j * 7) * Math.PI / 180;
+            let angle = (i * 7) * Math.PI / 180;
             let color = {
                 r: 127.5 + 127.5 * Math.sin(angle),
                 g: 127.5 + 127.5 * Math.sin(angle + Math.PI / 2),
@@ -119,14 +119,16 @@ function main() {
                 a: 255
             };
             let pos = {
-                x: (img.width / 2 - text_width / 2) + j * 0.1 * Math.cos(angle - Math.PI / 2),
-                y: (img.height / 2 - 16) + j * 0.1 * Math.sin(angle - Math.PI / 2)
+                x: (img.width / 2 - text_width / 2) + i * 0.1 * Math.cos(angle - Math.PI / 2),
+                y: (img.height / 2 - 16) + i * 0.1 * Math.sin(angle - Math.PI / 2)
             };
 
             ImageDrawTextEx(img, font, text, pos, 10, 1, color);
         }
+
+        iterations += 3600;
     }
 
-    let time = performance.now() - start;
+    time = performance.now() - start;
     console.log(JSON.stringify({ iterations: iterations, time: Math.round(time) }));
 }

package/benchmark/raylib_node_ffi.js

@@ -17,7 +17,6 @@ const ref = require('ref-napi');
 const ffi = require('ffi-napi');
 const struct = require('ref-struct-di')(ref);
 const koffi = require('./build/koffi.node');
-const path = require('path');
 
 const Color = struct({
     r: 'uchar',
@@ -87,17 +86,17 @@ const Font = struct({
 main();
 
 function main() {
-    let iterations = 180000;
+    let time = 5000;
 
     if (process.argv.length >= 3) {
-        iterations = parseInt(process.argv[2], 10);
-        if (Number.isNaN(iterations))
+        time = parseFloat(process.argv[2]) * 1000;
+        if (Number.isNaN(time))
             throw new Error('Not a valid number');
-        if (iterations < 1)
-            throw new Error('Value must be positive');
+        if (time < 0)
+            throw new Error('Time must be positive');
     }
 
-    let lib_filename = path.dirname(__filename) + '/build/raylib' + koffi.extension;
+    let lib_filename = __dirname + '/build/raylib' + koffi.extension;
 
     const r = ffi.Library(lib_filename, {
         InitWindow: ['void', ['int', 'int', 'string']],
@@ -121,15 +120,16 @@ function main() {
     let font = r.GetFontDefault();
 
     let start = performance.now();
+    let iterations = 0;
 
-    for (let i = 0; i < iterations; i += 3600) {
+    while (performance.now() - start < time) {
         r.ImageClearBackground(imgp, new Color({ r: 0, g: 0, b: 0, a: 255 }));
 
-        for (let j = 0; j < 3600; j++) {
+        for (let i = 0; i < 3600; i++) {
             let text = 'Hello World!';
             let text_width = r.MeasureTextEx(font, text, 10, 1).x;
 
-            let angle = (j * 7) * Math.PI / 180;
+            let angle = (i * 7) * Math.PI / 180;
             let color = new Color({
                 r: 127.5 + 127.5 * Math.sin(angle),
                 g: 127.5 + 127.5 * Math.sin(angle + Math.PI / 2),
@@ -137,14 +137,16 @@ function main() {
                 a: 255
             });
             let pos = new Vector2({
-                x: (img.width / 2 - text_width / 2) + j * 0.1 * Math.cos(angle - Math.PI / 2),
-                y: (img.height / 2 - 16) + j * 0.1 * Math.sin(angle - Math.PI / 2)
+                x: (img.width / 2 - text_width / 2) + i * 0.1 * Math.cos(angle - Math.PI / 2),
+                y: (img.height / 2 - 16) + i * 0.1 * Math.sin(angle - Math.PI / 2)
             });
 
             r.ImageDrawTextEx(imgp, font, text, pos, 10, 1, color);
         }
+
+        iterations += 3600;
     }
 
-    let time = performance.now() - start;
+    time = performance.now() - start;
     console.log(JSON.stringify({ iterations: iterations, time: Math.round(time) }));
 }

package/benchmark/raylib_node_raylib.js

@@ -18,14 +18,14 @@ const r = require('raylib');
 main();
 
 function main() {
-    let iterations = 360000;
+    let time = 5000;
 
     if (process.argv.length >= 3) {
-        iterations = parseInt(process.argv[2], 10);
-        if (Number.isNaN(iterations))
+        time = parseFloat(process.argv[2]) * 1000;
+        if (Number.isNaN(time))
             throw new Error('Not a valid number');
-        if (iterations < 1)
-            throw new Error('Value must be positive');
+        if (time < 0)
+            throw new Error('Time must be positive');
     }
 
     // We need to call InitWindow before using anything else (such as fonts)
@@ -37,15 +37,16 @@ function main() {
     let font = r.GetFontDefault();
 
     let start = performance.now();
+    let iterations = 0;
 
-    for (let i = 0; i < iterations; i += 3600) {
+    while (performance.now() - start < time) {
         r.ImageClearBackground(img, { r: 0, g: 0, b: 0, a: 255 });
 
-        for (let j = 0; j < 3600; j++) {
+        for (let i = 0; i < 3600; i++) {
             let text = 'Hello World!';
             let text_width = r.MeasureTextEx(font, text, 10, 1).x;
 
-            let angle = (j * 7) * Math.PI / 180;
+            let angle = (i * 7) * Math.PI / 180;
             let color = {
                 r: 127.5 + 127.5 * Math.sin(angle),
                 g: 127.5 + 127.5 * Math.sin(angle + Math.PI / 2),
@@ -53,14 +54,16 @@ function main() {
                 a: 255
             };
             let pos = {
-                x: (img.width / 2 - text_width / 2) + j * 0.1 * Math.cos(angle - Math.PI / 2),
-                y: (img.height / 2 - 16) + j * 0.1 * Math.sin(angle - Math.PI / 2)
+                x: (img.width / 2 - text_width / 2) + i * 0.1 * Math.cos(angle - Math.PI / 2),
+                y: (img.height / 2 - 16) + i * 0.1 * Math.sin(angle - Math.PI / 2)
             };
 
             r.ImageDrawTextEx(img, font, text, pos, 10, 1, color);
         }
+
+        iterations += 3600;
     }
 
-    let time = performance.now() - start;
+    time = performance.now() - start;
     console.log(JSON.stringify({ iterations: iterations, time: Math.round(time) }));
 }