koffi 1.1.5 → 1.2.0-alpha.3

package/README.md

@@ -22,8 +22,9 @@ Koffi is a fast and easy-to-use C FFI module for Node.js, with support for primi
 
 The following features are planned in the near future:
 
-* 1.2: C to JS callbacks
-* 1.3: Type parser
+* 1.2: C to JS callbacks (⚠️ partially working in master branch)
+* 1.3: Real-world examples, optimize passing of structs and arrays
+* 1.4: Type parser, unions
 
 The following combinations of OS and architectures __are officially supported and tested__ at the moment:
 
@@ -294,7 +295,50 @@ Variadic functions do not support async.
 
 ## Callbacks
 
-Koffi does not yet support passing JS functions as callbacks. This is planned for version 1.2.
+⚠️ Support for callbacks **is in development, don't expect it to run reliably**.
+
+In order to pass a JS function to a C function expecting a callback, you must first create a callback type with the expected return type and parameters. The syntax is similar to the one used to load functions from a shared library.
+
+```js
+const koffi = require('koffi');
+
+// With the classic syntax, this callback expects an integer and returns nothing
+const ExampleCallback = koffi.callback('ExampleCallback', 'void', ['int']);
+
+// With the prototype parser, this callback expects a double and float, and returns the sum as a double
+const AddDoubleFloat = koffi.callback('double AddDoubleFloat(double d, float f)');
+```
+
+Once your callback type is declared, you can use them in struct definitions, or as function parameter and/or return type.
+
+Here is a small example with the C part and the JS part.
+
+```c
+#include <string.h>
+
+int TransferToJS(const char *str, int (*cb)(const char *str))
+{
+    char buf[64];
+    snprintf(buf, sizeof(buf), "Hello %s!", str);
+    return cb(buf);
+}
+```
+
+```js
+const koffi = require('koffi');
+
+const TransferCallback = koffi.callback('int TransferCallback(const char *str)');
+
+const TransferToJS = lib.func('int TransferToJS(const char *str, TransferCallback cb)');
+
+let ret = TransferToJS('Niels', (str) => {
+    console.log(str);
+    return 42;
+});
+console.log(ret);
+
+// This example prints "Hello Niels!" first, and then prints 42
+```
 
 # Benchmarks
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "koffi",
-  "version": "1.1.5",
+  "version": "1.2.0-alpha.3",
   "description": "Fast and simple C FFI (foreign function interface) for Node.js",
   "keywords": [
     "foreign",
@@ -19,8 +19,7 @@
   "main": "src/index.js",
   "scripts": {
     "install": "cnoke --prebuild build/qemu/{{version}}/koffi_{{platform}}_{{arch}}.tar.gz",
-    "test": "node qemu/qemu.js",
-    "prepublishOnly": "node qemu/qemu.js pack"
+    "test": "node qemu/qemu.js"
   },
   "license": "AGPL-3.0",
   "dependencies": {

package/qemu/registry/machines.json

@@ -38,7 +38,8 @@
                     "Test Sync": "node test/sync.js",
                     "Test Async": "node test/async.js",
                     "Test Raylib": "xvfb-run node test/raylib.js",
-                    "Test SQLite": "node test/sqlite.js"
+                    "Test SQLite": "node test/sqlite.js",
+                    "Test Callbacks": "node test/callbacks.js"
                 }
             }
         }
@@ -83,7 +84,8 @@
                     "Test Sync": "node test/sync.js",
                     "Test Async": "node test/async.js",
                     "Test Raylib": "xvfb-run node test/raylib.js",
-                    "Test SQLite": "node test/sqlite.js"
+                    "Test SQLite": "node test/sqlite.js",
+                    "Test Callbacks": "node test/callbacks.js"
                 }
             }
         }
@@ -128,7 +130,8 @@
                     "Test Sync": "node test/sync.js",
                     "Test Async": "node test/async.js",
                     "Test Raylib": "xvfb-run node test/raylib.js",
-                    "Test SQLite": "node test/sqlite.js"
+                    "Test SQLite": "node test/sqlite.js",
+                    "Test Callbacks": "node test/callbacks.js"
                 }
             }
         }
@@ -173,7 +176,8 @@
                     "Test Sync": "node test/sync.js",
                     "Test Async": "node test/async.js",
                     "Test Raylib": "xvfb-run node test/raylib.js",
-                    "Test SQLite": "node test/sqlite.js"
+                    "Test SQLite": "node test/sqlite.js",
+                    "Test Callbacks": "node test/callbacks.js"
                 }
             }
         }
@@ -225,7 +229,8 @@
                     "Test Sync": "C:\\Node32\\node32.cmd node test/sync.js",
                     "Test Async": "C:\\Node32\\node32.cmd node test/async.js",
                     "Test Raylib": "seatsh C:\\Node32\\node32.cmd node test/raylib.js",
-                    "Test SQLite": "C:\\Node32\\node32.cmd node test/sqlite.js"
+                    "Test SQLite": "C:\\Node32\\node32.cmd node test/sqlite.js",
+                    "Test Callbacks": "C:\\Node32\\node32.cmd node test/callbacks.js"
                 }
             },
 
@@ -238,7 +243,8 @@
                     "Test Sync": "C:\\Node64\\node64.cmd node test/sync.js",
                     "Test Async": "C:\\Node64\\node64.cmd node test/async.js",
                     "Test Raylib": "seatsh C:\\Node64\\node64.cmd node test/raylib.js",
-                    "Test SQLite": "C:\\Node64\\node64.cmd node test/sqlite.js"
+                    "Test SQLite": "C:\\Node64\\node64.cmd node test/sqlite.js",
+                    "Test Callbacks": "C:\\Node64\\node64.cmd node test/callbacks.js"
                 }
             }
         }
@@ -283,7 +289,8 @@
                     "Test Sync": "node test/sync.js",
                     "Test Async": "node test/async.js",
                     "Test Raylib": "xvfb-run node test/raylib.js",
-                    "Test SQLite": "node test/sqlite.js"
+                    "Test SQLite": "node test/sqlite.js",
+                    "Test Callbacks": "node test/callbacks.js"
                 }
             }
         }
@@ -328,7 +335,8 @@
                     "Test Sync": "node test/sync.js",
                     "Test Async": "node test/async.js",
                     "Test Raylib": "xvfb-run node test/raylib.js",
-                    "Test SQLite": "node test/sqlite.js"
+                    "Test SQLite": "node test/sqlite.js",
+                    "Test Callbacks": "node test/callbacks.js"
                 }
             }
         }
@@ -373,7 +381,8 @@
                     "Test Sync": "node test/sync.js",
                     "Test Async": "node test/async.js",
                     "Test Raylib": "xvfb-run node test/raylib.js",
-                    "Test SQLite": "node test/sqlite.js"
+                    "Test SQLite": "node test/sqlite.js",
+                    "Test Callbacks": "node test/callbacks.js"
                 }
             }
         }
@@ -417,7 +426,8 @@
                 "commands": {
                     "Test Sync": "PATH=/usr/local/bin:/usr/bin:/bin node test/sync.js",
                     "Test Async": "PATH=/usr/local/bin:/usr/bin:/bin node test/async.js",
-                    "Test SQLite": "PATH=/usr/local/bin:/usr/bin:/bin node test/sqlite.js"
+                    "Test SQLite": "PATH=/usr/local/bin:/usr/bin:/bin node test/sqlite.js",
+                    "Test Callbacks": "PATH=/usr/local/bin:/usr/bin:/bin node test/callbacks.js"
                 }
             }
         }
@@ -462,7 +472,8 @@
                     "Test Sync": "node test/sync.js",
                     "Test Async": "node test/async.js",
                     "Test Raylib": "xvfb-run node test/raylib.js",
-                    "Test SQLite": "node test/sqlite.js"
+                    "Test SQLite": "node test/sqlite.js",
+                    "Test Callbacks": "node test/callbacks.js"
                 }
             }
         }
@@ -507,7 +518,8 @@
                     "Test Sync": "node test/sync.js",
                     "Test Async": "node test/async.js",
                     "Test Raylib": "xvfb-run node test/raylib.js",
-                    "Test SQLite": "node test/sqlite.js"
+                    "Test SQLite": "node test/sqlite.js",
+                    "Test Callbacks": "node test/callbacks.js"
                 }
             }
         }
@@ -552,7 +564,8 @@
                     "Test Sync": "node test/sync.js",
                     "Test Async": "node test/async.js",
                     "Test Raylib": "xvfb-run node test/raylib.js",
-                    "Test SQLite": "node test/sqlite.js"
+                    "Test SQLite": "node test/sqlite.js",
+                    "Test Callbacks": "node test/callbacks.js"
                 }
             }
         }