koffi 1.3.9 → 1.3.10

package/doc/functions.md

@@ -1,4 +1,4 @@
-# Function calls
+# Functions
 
 ## Function definitions
 
@@ -23,7 +23,7 @@ const printf = lib.func('printf', 'int', ['str', '...']);
 const atoi = lib.func('atoi', 'int', ['str']);
 ```
 
-Koffi automatically tries mangled names for non-standard x86 calling conventions. See the section [on standard calls](#synchronous-calls) for more information on this subject.
+Koffi automatically tries mangled names for non-standard x86 calling conventions. See the section on [calling conventions](#calling-conventions) for more information on this subject.
 
 ### C-like prototypes
 
@@ -36,7 +36,9 @@ const atoi = lib.func('int atoi(str)'); // The parameter name is not used by Kof
 
 You can use `()` or `(void)` for functions that take no argument.
 
-## Synchronous calls
+## Function calls
+
+### Calling conventions
 
 By default, calling a C function happens synchronously.
 
@@ -57,12 +59,12 @@ Below you can find a small example showing how to use a non-default calling conv
 const koffi = require('koffi');
 const lib = koffi.load('user32.dll');
 
-// The following two declarations are equivalent, and use Stdcall
+// The following two declarations are equivalent, and use stdcall on x86 (and the default ABI on other platforms)
 const MessageBoxA_1 = lib.stdcall('MessageBoxA', 'int', ['void *', 'str', 'str', 'uint']);
 const MessageBoxA_2 = lib.func('int __stdcall MessageBoxA(void *hwnd, str text, str caption, uint type)');
 ```
 
-## Asynchronous calls
+### Asynchronous calls
 
 You can issue asynchronous calls by calling the function through its async member. In this case, you need to provide a callback function as the last argument, with `(err, res)` parameters.
 
@@ -88,7 +90,7 @@ You can easily convert this callback-style async function to a promise-based ver
 
 Variadic functions cannot be called asynchronously.
 
-## Variadic functions
+### Variadic functions
 
 Variadic functions are declared with an ellipsis as the last argument.
 
@@ -220,7 +222,7 @@ console.log(ret);
 //   42
 ```
 
-On x86 platforms, only Cdecl and Stdcall callbacks are supported.
+You need to specify the correct [calling convention](#calling-conventions) on x86 platforms, or the behavior is undefined (Node will probably crash). Only *cdecl* and *stdcall* callbacks are supported.
 
 ## Thread safety
 

package/doc/index.rst

@@ -14,6 +14,8 @@ Koffi is a **fast and easy-to-use C FFI module for Node.js**, featuring:
 
 Koffi requires a recent `Node.js <https://nodejs.org/>`_ version with N-API version 8 support, see :ref:`this page<Node.js>` for more information.
 
+The source code is available here: https://github.com/Koromix/luigi/ (in the *koffi* subdirectory).
+
 Table of contents
 -----------------
 

package/doc/memory.md

@@ -7,7 +7,7 @@ For synchronous/normal calls, Koffi uses two preallocated memory blocks:
 - One to construct the C stack and assign registers, subsequently used by the platform-specific assembly code (1 MiB by default)
 - One to allocate strings and big objects/structs (2 MiB by default)
 
-Unless very big strings or objects (at least more than one page of memory) are used, no extra allocation ever happens during calls or callbacks.
+Unless very big strings or objects (at least more than one page of memory) are used, Koffi does not directly allocate any extra memory during calls or callbacks. However, please note that the JS engine (V8) might.
 
 The size (in bytes) of these preallocated blocks can be changed. Use `koffi.config()` to get an object with the settings, and `koffi.config(obj)` to apply new settings.