koffi 1.3.5 → 1.3.8

package/doc/dist/html/contribute.html

@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 <link rel="index" title="Index" href="genindex" /><link rel="search" title="Search" href="search" /><link rel="next" title="Changelog" href="changes" /><link rel="prev" title="Benchmarks" href="benchmarks" />
 
-    <meta name="generator" content="sphinx-5.0.1, furo 2022.06.04.1"/>
+    <meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/>
         <title>Contributing - Koffi</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
@@ -162,7 +162,7 @@
 </form>
 <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
   <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="platforms">Supported platforms</a></li>
+<li class="toctree-l1"><a class="reference internal" href="platforms">Requirements</a></li>
 <li class="toctree-l1"><a class="reference internal" href="start">Quick start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="types">Data types</a></li>
 <li class="toctree-l1"><a class="reference internal" href="functions">Function calls</a></li>
@@ -214,8 +214,8 @@
 <h2>Build from source<a class="headerlink" href="#build-from-source" title="Permalink to this heading">#</a></h2>
 <p>We provide prebuilt binaries, packaged in the NPM archive, so in most cases it should be as simple as <code class="docutils literal notranslate"><span class="pre">npm</span> <span class="pre">install</span> <span class="pre">koffi</span></code>. If you want to hack Koffi or use a specific platform, follow the instructions below.</p>
 <p>Start by cloning the repository with <a class="reference external" href="https://git-scm.com/">Git</a>:</p>
-<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>git clone https://github.com/Koromix/luigi
-<span class="nb">cd</span> luigi/koffi
+<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span>git clone https://github.com/Koromix/luigi
+<span class="linenos">2</span><span class="nb">cd</span> luigi/koffi
 </pre></div>
 </div>
 <p>As said before, this is a monorepository containg multiple projects, hence the name.</p>
@@ -228,8 +228,8 @@
 <li><p><a class="reference external" href="https://nodejs.org/">Node.js</a> 12 or later</p></li>
 </ul>
 <p>Once this is done, run this command <em>from the test or the benchmark directory</em> (depending on what you want to build):</p>
-<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> koffi/test <span class="c1"># or cd koffi/benchmark</span>
-node ../../cnoke/cnoke.js
+<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span><span class="nb">cd</span> koffi/test <span class="c1"># or cd koffi/benchmark</span>
+<span class="linenos">2</span>node ../../cnoke/cnoke.js
 </pre></div>
 </div>
 </section>
@@ -243,8 +243,8 @@ node ../../cnoke/cnoke.js
 <li><p><a class="reference external" href="https://nodejs.org/">Node.js</a> 12 or later</p></li>
 </ul>
 <p>Once this is done, run this command <em>from the test or the benchmark directory</em> (depending on what you want to build):</p>
-<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> koffi/test <span class="c1"># or cd koffi/benchmark</span>
-node ../../cnoke/cnoke.js
+<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span><span class="nb">cd</span> koffi/test <span class="c1"># or cd koffi/benchmark</span>
+<span class="linenos">2</span>node ../../cnoke/cnoke.js
 </pre></div>
 </div>
 </section>
@@ -254,57 +254,54 @@ node ../../cnoke/cnoke.js
 <p>Koffi is tested on multiple architectures using emulated (accelerated when possible) QEMU machines. First, you need to install qemu packages, such as <code class="docutils literal notranslate"><span class="pre">qemu-system</span></code> (or even <code class="docutils literal notranslate"><span class="pre">qemu-system-gui</span></code>) on Ubuntu.</p>
 <p>These machines are not included directly in this repository (for license and size reasons), but they are available here: <a class="reference external" href="https://koromix.dev/files/machines/">https://koromix.dev/files/machines/</a></p>
 <p>For example, if you want to run the tests on Debian ARM64, run the following commands:</p>
-<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span> luigi/koffi/qemu/
-wget -q -O- https://koromix.dev/files/machines/qemu_debian_arm64.tar.zst <span class="p">|</span> zstd -d <span class="p">|</span> tar xv
-sha256sum -c --ignore-missing registry/sha256sum.txt
+<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span><span class="nb">cd</span> luigi/koffi/qemu/
+<span class="linenos">2</span>wget -q -O- https://koromix.dev/files/machines/qemu_debian_arm64.tar.zst <span class="p">|</span> zstd -d <span class="p">|</span> tar xv
+<span class="linenos">3</span>sha256sum -c --ignore-missing registry/sha256sum.txt
 </pre></div>
 </div>
 <p>Note that the machine disk content may change each time the machine runs, so the checksum test will fail once a machine has been used at least once.</p>
 <p>And now you can run the tests with:</p>
-<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>node qemu.js <span class="c1"># Several options are available, use --help</span>
+<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span>node qemu.js <span class="nb">test</span> <span class="c1"># Several options are available, use --help</span>
 </pre></div>
 </div>
 <p>And be patient, this can be pretty slow for emulated machines. The Linux machines have and use ccache to build Koffi, so subsequent build steps will get much more tolerable.</p>
 <p>By default, machines are started and stopped for each test. But you can start the machines ahead of time and run the tests multiple times instead:</p>
-<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>node qemu.js start <span class="c1"># Start the machines</span>
-node qemu.js <span class="c1"># Test (without shutting down)</span>
-node qemu.js <span class="c1"># Test again</span>
-node qemu.js stop <span class="c1"># Stop everything</span>
+<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span>node qemu.js start <span class="c1"># Start the machines</span>
+<span class="linenos">2</span>node qemu.js <span class="nb">test</span> <span class="c1"># Test (without shutting down)</span>
+<span class="linenos">3</span>node qemu.js <span class="nb">test</span> <span class="c1"># Test again</span>
+<span class="linenos">4</span>node qemu.js stop <span class="c1"># Stop everything</span>
 </pre></div>
 </div>
 <p>You can also restrict the test to a subset of machines:</p>
-<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="c1"># Full test cycle</span>
-node qemu.js <span class="nb">test</span> debian_x64 debian_i386
-
-<span class="c1"># Separate start, test, shutdown</span>
-node qemu.js start debian_x64 debian_i386
-node qemu.js <span class="nb">test</span> debian_x64 debian_i386
-node qemu.js stop
+<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span><span class="c1"># Full test cycle</span>
+<span class="linenos">2</span>node qemu.js <span class="nb">test</span> debian_x64 debian_i386
+<span class="linenos">3</span>
+<span class="linenos">4</span><span class="c1"># Separate start, test, shutdown</span>
+<span class="linenos">5</span>node qemu.js start debian_x64 debian_i386
+<span class="linenos">6</span>node qemu.js <span class="nb">test</span> debian_x64 debian_i386
+<span class="linenos">7</span>node qemu.js stop
 </pre></div>
 </div>
 <p>Finally, you can join a running machine with SSH with the following shortcut, if you need to do some debugging or any other manual procedure:</p>
-<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>node qemu.js ssh debian_i386
+<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span>node qemu.js ssh debian_i386
 </pre></div>
 </div>
 <p>Each machine is configured to run a VNC server available locally, which you can use to access the display, using KRDC or any other compatible viewer. Use the <code class="docutils literal notranslate"><span class="pre">info</span></code> command to get the VNC port.</p>
-<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span>node qemu.js info debian_x64
+<div class="highlight-sh notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span>node qemu.js info debian_x64
 </pre></div>
 </div>
 </section>
 <section id="todo-list">
 <h2>Todo list<a class="headerlink" href="#todo-list" title="Permalink to this heading">#</a></h2>
-<p>After the release of version 1.3.0, the current priorities for the next major release are:</p>
-<ul class="simple">
-<li><p>Automate Windows/AArch64 (qemu) and macOS/AArch64 (how?) tests and builds</p></li>
-<li><p>Create a real-world example, using several libraries (Raylib, SQLite, libsodium) to illustrate how to work with various C API styles</p></li>
-</ul>
-<p>The following features are also planned eventually, not necessarily in that order:</p>
+<p>The following features and improvements are planned, not necessarily in that order:</p>
 <ul class="simple">
-<li><p>Optimize passing of structs and arrays, with separate HFA-specific helper functions</p></li>
+<li><p>Provide better ways to automatically deal with caller/heap-allocated memory (strings, etc.)</p></li>
+<li><p>Optimize passing of structs and arrays (avoid setting named properties one by one? separate HFA-specific helper functions?)</p></li>
+<li><p>Automate Windows/AArch64 (qemu) and macOS/AArch64 (how? … thanks Apple) tests</p></li>
+<li><p>Create a real-world example, using several libraries (Raylib, SQLite, libsodium) to illustrate various C API styles</p></li>
 <li><p>Add simple struct type parser</p></li>
 <li><p>Add more ways to manually encode and decode various types to and from byte arrays</p></li>
 <li><p>Add support for unions</p></li>
-<li><p>Provide better ways to automatically deal with caller/heap-allocated memory (strings, etc.)</p></li>
 <li><p>Port Koffi to PowerPC (POWER9+) ABI</p></li>
 <li><p>Fix assembly unwind and CFI directives for better debugging experience</p></li>
 </ul>

package/doc/dist/html/functions.html

@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 <link rel="index" title="Index" href="genindex" /><link rel="search" title="Search" href="search" /><link rel="next" title="Memory usage" href="memory" /><link rel="prev" title="Data types" href="types" />
 
-    <meta name="generator" content="sphinx-5.0.1, furo 2022.06.04.1"/>
+    <meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/>
         <title>Function calls - Koffi</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
@@ -162,7 +162,7 @@
 </form>
 <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
   <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="platforms">Supported platforms</a></li>
+<li class="toctree-l1"><a class="reference internal" href="platforms">Requirements</a></li>
 <li class="toctree-l1"><a class="reference internal" href="start">Quick start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="types">Data types</a></li>
 <li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Function calls</a></li>
@@ -220,8 +220,8 @@
 <section id="classic-syntax">
 <h3>Classic syntax<a class="headerlink" href="#classic-syntax" title="Permalink to this heading">#</a></h3>
 <p>To declare a function, you need to specify its non-mangled name, its return type, and its parameters. Use an ellipsis as the last parameter for variadic functions.</p>
-<div class="highlight-js notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span><span class="kd">const</span><span class="w"> </span><span class="nx">printf</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">lib</span><span class="p">.</span><span class="nx">func</span><span class="p">(</span><span class="s1">&#39;printf&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;int&#39;</span><span class="p">,</span><span class="w"> </span><span class="p">[</span><span class="s1">&#39;string&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;...&#39;</span><span class="p">]);</span><span class="w"></span>
-<span class="linenos">2</span><span class="kd">const</span><span class="w"> </span><span class="nx">atoi</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">lib</span><span class="p">.</span><span class="nx">func</span><span class="p">(</span><span class="s1">&#39;atoi&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;int&#39;</span><span class="p">,</span><span class="w"> </span><span class="p">[</span><span class="s1">&#39;string&#39;</span><span class="p">]);</span><span class="w"></span>
+<div class="highlight-js notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span><span class="kd">const</span><span class="w"> </span><span class="nx">printf</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">lib</span><span class="p">.</span><span class="nx">func</span><span class="p">(</span><span class="s1">&#39;printf&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;int&#39;</span><span class="p">,</span><span class="w"> </span><span class="p">[</span><span class="s1">&#39;str&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;...&#39;</span><span class="p">]);</span><span class="w"></span>
+<span class="linenos">2</span><span class="kd">const</span><span class="w"> </span><span class="nx">atoi</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">lib</span><span class="p">.</span><span class="nx">func</span><span class="p">(</span><span class="s1">&#39;atoi&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;int&#39;</span><span class="p">,</span><span class="w"> </span><span class="p">[</span><span class="s1">&#39;str&#39;</span><span class="p">]);</span><span class="w"></span>
 </pre></div>
 </div>
 <p>Koffi automatically tries mangled names for non-standard x86 calling conventions. See the section <a class="reference internal" href="#synchronous-calls"><span class="std std-doc">on standard calls</span></a> for more information on this subject.</p>
@@ -230,7 +230,7 @@
 <h3>C-like prototypes<a class="headerlink" href="#c-like-prototypes" title="Permalink to this heading">#</a></h3>
 <p>If you prefer, you can declare functions using simple C-like prototype strings, as shown below:</p>
 <div class="highlight-js notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span><span class="kd">const</span><span class="w"> </span><span class="nx">printf</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">lib</span><span class="p">.</span><span class="nx">func</span><span class="p">(</span><span class="s1">&#39;int printf(const char *fmt, ...)&#39;</span><span class="p">);</span><span class="w"></span>
-<span class="linenos">2</span><span class="kd">const</span><span class="w"> </span><span class="nx">atoi</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">lib</span><span class="p">.</span><span class="nx">func</span><span class="p">(</span><span class="s1">&#39;int atoi(string)&#39;</span><span class="p">);</span><span class="w"> </span><span class="c1">// The parameter name is not used by Koffi, and optional</span><span class="w"></span>
+<span class="linenos">2</span><span class="kd">const</span><span class="w"> </span><span class="nx">atoi</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">lib</span><span class="p">.</span><span class="nx">func</span><span class="p">(</span><span class="s1">&#39;int atoi(str)&#39;</span><span class="p">);</span><span class="w"> </span><span class="c1">// The parameter name is not used by Koffi, and optional</span><span class="w"></span>
 </pre></div>
 </div>
 <p>You can use <code class="docutils literal notranslate"><span class="pre">()</span></code> or <code class="docutils literal notranslate"><span class="pre">(void)</span></code> for functions that take no argument.</p>
@@ -279,8 +279,8 @@
 <span class="linenos">2</span><span class="kd">const</span><span class="w"> </span><span class="nx">lib</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">koffi</span><span class="p">.</span><span class="nx">load</span><span class="p">(</span><span class="s1">&#39;user32.dll&#39;</span><span class="p">);</span><span class="w"></span>
 <span class="linenos">3</span>
 <span class="linenos">4</span><span class="c1">// The following two declarations are equivalent, and use Stdcall</span><span class="w"></span>
-<span class="linenos">5</span><span class="kd">const</span><span class="w"> </span><span class="nx">MessageBoxA_1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">lib</span><span class="p">.</span><span class="nx">stdcall</span><span class="p">(</span><span class="s1">&#39;MessageBoxA&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;int&#39;</span><span class="p">,</span><span class="w"> </span><span class="p">[</span><span class="s1">&#39;void *&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;string&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;string&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;uint&#39;</span><span class="p">]);</span><span class="w"></span>
-<span class="linenos">6</span><span class="kd">const</span><span class="w"> </span><span class="nx">MessageBoxA_2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">lib</span><span class="p">.</span><span class="nx">func</span><span class="p">(</span><span class="s1">&#39;int __stdcall MessageBoxA(void *hwnd, string text, string caption, uint type)&#39;</span><span class="p">);</span><span class="w"></span>
+<span class="linenos">5</span><span class="kd">const</span><span class="w"> </span><span class="nx">MessageBoxA_1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">lib</span><span class="p">.</span><span class="nx">stdcall</span><span class="p">(</span><span class="s1">&#39;MessageBoxA&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;int&#39;</span><span class="p">,</span><span class="w"> </span><span class="p">[</span><span class="s1">&#39;void *&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;str&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;str&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;uint&#39;</span><span class="p">]);</span><span class="w"></span>
+<span class="linenos">6</span><span class="kd">const</span><span class="w"> </span><span class="nx">MessageBoxA_2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">lib</span><span class="p">.</span><span class="nx">func</span><span class="p">(</span><span class="s1">&#39;int __stdcall MessageBoxA(void *hwnd, str text, str caption, uint type)&#39;</span><span class="p">);</span><span class="w"></span>
 </pre></div>
 </div>
 </section>
@@ -310,10 +310,10 @@
 <h2>Variadic functions<a class="headerlink" href="#variadic-functions" title="Permalink to this heading">#</a></h2>
 <p>Variadic functions are declared with an ellipsis as the last argument.</p>
 <p>In order to call a variadic function, you must provide two Javascript arguments for each additional C parameter, the first one is the expected type and the second one is the value.</p>
-<div class="highlight-js notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span><span class="kd">const</span><span class="w"> </span><span class="nx">printf</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">lib</span><span class="p">.</span><span class="nx">func</span><span class="p">(</span><span class="s1">&#39;printf&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;int&#39;</span><span class="p">,</span><span class="w"> </span><span class="p">[</span><span class="s1">&#39;string&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;...&#39;</span><span class="p">]);</span><span class="w"></span>
+<div class="highlight-js notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span><span class="kd">const</span><span class="w"> </span><span class="nx">printf</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">lib</span><span class="p">.</span><span class="nx">func</span><span class="p">(</span><span class="s1">&#39;printf&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;int&#39;</span><span class="p">,</span><span class="w"> </span><span class="p">[</span><span class="s1">&#39;str&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;...&#39;</span><span class="p">]);</span><span class="w"></span>
 <span class="linenos">2</span>
 <span class="linenos">3</span><span class="c1">// The variadic arguments are: 6 (int), 8.5 (double), &#39;THE END&#39; (const char *)</span><span class="w"></span>
-<span class="linenos">4</span><span class="nx">printf</span><span class="p">(</span><span class="s1">&#39;Integer %d, double %g, string %s&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;int&#39;</span><span class="p">,</span><span class="w"> </span><span class="mf">6</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;double&#39;</span><span class="p">,</span><span class="w"> </span><span class="mf">8.5</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;string&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;THE END&#39;</span><span class="p">);</span><span class="w"></span>
+<span class="linenos">4</span><span class="nx">printf</span><span class="p">(</span><span class="s1">&#39;Integer %d, double %g, str %s&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;int&#39;</span><span class="p">,</span><span class="w"> </span><span class="mf">6</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;double&#39;</span><span class="p">,</span><span class="w"> </span><span class="mf">8.5</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;str&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;THE END&#39;</span><span class="p">);</span><span class="w"></span>
 </pre></div>
 </div>
 <p>On x86 platforms, only the Cdecl convention can be used for variadic functions.</p>
@@ -370,15 +370,16 @@
 <span class="linenos"> 4</span><span class="kd">const</span><span class="w"> </span><span class="nx">sqlite3_db</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">koffi</span><span class="p">.</span><span class="nx">handle</span><span class="p">(</span><span class="s1">&#39;sqlite3_db&#39;</span><span class="p">);</span><span class="w"></span>
 <span class="linenos"> 5</span>
 <span class="linenos"> 6</span><span class="c1">// Use koffi.out() on a pointer to copy out (from C to JS) after the call</span><span class="w"></span>
-<span class="linenos"> 7</span><span class="kd">const</span><span class="w"> </span><span class="nx">sqlite3_open_v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">lib</span><span class="p">.</span><span class="nx">func</span><span class="p">(</span><span class="s1">&#39;sqlite3_open_v2&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;int&#39;</span><span class="p">,</span><span class="w"> </span><span class="p">[</span><span class="s1">&#39;string&#39;</span><span class="p">,</span><span class="w"> </span><span class="nx">koffi</span><span class="p">.</span><span class="nx">out</span><span class="p">(</span><span class="nx">koffi</span><span class="p">.</span><span class="nx">pointer</span><span class="p">(</span><span class="nx">sqlite3_db</span><span class="p">)),</span><span class="w"> </span><span class="s1">&#39;int&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;string&#39;</span><span class="p">]);</span><span class="w"></span>
-<span class="linenos"> 8</span>
-<span class="linenos"> 9</span><span class="kd">const</span><span class="w"> </span><span class="nx">SQLITE_OPEN_READWRITE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mh">0x2</span><span class="p">;</span><span class="w"></span>
-<span class="linenos">10</span><span class="kd">const</span><span class="w"> </span><span class="nx">SQLITE_OPEN_CREATE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mh">0x4</span><span class="p">;</span><span class="w"></span>
-<span class="linenos">11</span>
-<span class="linenos">12</span><span class="kd">let</span><span class="w"> </span><span class="nx">db</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{};</span><span class="w"></span>
-<span class="linenos">13</span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">sqlite3_open_v2</span><span class="p">(</span><span class="s1">&#39;:memory:&#39;</span><span class="p">,</span><span class="w"> </span><span class="nx">db</span><span class="p">,</span><span class="w"> </span><span class="nx">SQLITE_OPEN_READWRITE</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="nx">SQLITE_OPEN_CREATE</span><span class="p">,</span><span class="w"> </span><span class="kc">null</span><span class="p">)</span><span class="w"> </span><span class="o">!=</span><span class="w"> </span><span class="mf">0</span><span class="p">)</span><span class="w"></span>
-<span class="linenos">14</span><span class="w">    </span><span class="k">throw</span><span class="w"> </span><span class="ow">new</span><span class="w"> </span><span class="ne">Error</span><span class="p">(</span><span class="s1">&#39;Failed to open database&#39;</span><span class="p">);</span><span class="w"></span>
-<span class="linenos">15</span><span class="nx">sqlite3_close_v2</span><span class="p">(</span><span class="nx">db</span><span class="p">);</span><span class="w"></span>
+<span class="linenos"> 7</span><span class="kd">const</span><span class="w"> </span><span class="nx">sqlite3_open_v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">lib</span><span class="p">.</span><span class="nx">func</span><span class="p">(</span><span class="s1">&#39;sqlite3_open_v2&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;int&#39;</span><span class="p">,</span><span class="w"> </span><span class="p">[</span><span class="s1">&#39;str&#39;</span><span class="p">,</span><span class="w"> </span><span class="nx">koffi</span><span class="p">.</span><span class="nx">out</span><span class="p">(</span><span class="nx">koffi</span><span class="p">.</span><span class="nx">pointer</span><span class="p">(</span><span class="nx">sqlite3_db</span><span class="p">)),</span><span class="w"> </span><span class="s1">&#39;int&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;str&#39;</span><span class="p">]);</span><span class="w"></span>
+<span class="linenos"> 8</span><span class="kd">const</span><span class="w"> </span><span class="nx">sqlite3_close_v2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">lib</span><span class="p">.</span><span class="nx">func</span><span class="p">(</span><span class="s1">&#39;sqlite3_close_v2&#39;</span><span class="p">,</span><span class="w"> </span><span class="s1">&#39;int&#39;</span><span class="p">,</span><span class="w"> </span><span class="p">[</span><span class="nx">sqlite3_db</span><span class="p">]);</span><span class="w"></span>
+<span class="linenos"> 9</span>
+<span class="linenos">10</span><span class="kd">const</span><span class="w"> </span><span class="nx">SQLITE_OPEN_READWRITE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mh">0x2</span><span class="p">;</span><span class="w"></span>
+<span class="linenos">11</span><span class="kd">const</span><span class="w"> </span><span class="nx">SQLITE_OPEN_CREATE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mh">0x4</span><span class="p">;</span><span class="w"></span>
+<span class="linenos">12</span>
+<span class="linenos">13</span><span class="kd">let</span><span class="w"> </span><span class="nx">db</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{};</span><span class="w"></span>
+<span class="linenos">14</span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">sqlite3_open_v2</span><span class="p">(</span><span class="s1">&#39;:memory:&#39;</span><span class="p">,</span><span class="w"> </span><span class="nx">db</span><span class="p">,</span><span class="w"> </span><span class="nx">SQLITE_OPEN_READWRITE</span><span class="w"> </span><span class="o">|</span><span class="w"> </span><span class="nx">SQLITE_OPEN_CREATE</span><span class="p">,</span><span class="w"> </span><span class="kc">null</span><span class="p">)</span><span class="w"> </span><span class="o">!=</span><span class="w"> </span><span class="mf">0</span><span class="p">)</span><span class="w"></span>
+<span class="linenos">15</span><span class="w">    </span><span class="k">throw</span><span class="w"> </span><span class="ow">new</span><span class="w"> </span><span class="ne">Error</span><span class="p">(</span><span class="s1">&#39;Failed to open database&#39;</span><span class="p">);</span><span class="w"></span>
+<span class="linenos">16</span><span class="nx">sqlite3_close_v2</span><span class="p">(</span><span class="nx">db</span><span class="p">);</span><span class="w"></span>
 </pre></div>
 </div>
 </section>

package/doc/dist/html/genindex.html

@@ -4,7 +4,7 @@
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="#" /><link rel="search" title="Search" href="search" />
 
-    <meta name="generator" content="sphinx-5.0.1, furo 2022.06.04.1"/><title>Index - Koffi</title>
+    <meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/><title>Index - Koffi</title>
 <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@@ -160,7 +160,7 @@
 </form>
 <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
   <ul>
-<li class="toctree-l1"><a class="reference internal" href="platforms">Supported platforms</a></li>
+<li class="toctree-l1"><a class="reference internal" href="platforms">Requirements</a></li>
 <li class="toctree-l1"><a class="reference internal" href="start">Quick start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="types">Data types</a></li>
 <li class="toctree-l1"><a class="reference internal" href="functions">Function calls</a></li>

package/doc/dist/html/index.html

@@ -3,9 +3,9 @@
   <head><meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
-<link rel="index" title="Index" href="genindex" /><link rel="search" title="Search" href="search" /><link rel="next" title="Supported platforms" href="platforms" />
+<link rel="index" title="Index" href="genindex" /><link rel="search" title="Search" href="search" /><link rel="next" title="Requirements" href="platforms" />
 
-    <meta name="generator" content="sphinx-5.0.1, furo 2022.06.04.1"/>
+    <meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/>
         <title>Koffi</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
@@ -162,7 +162,7 @@
 </form>
 <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
   <ul>
-<li class="toctree-l1"><a class="reference internal" href="platforms">Supported platforms</a></li>
+<li class="toctree-l1"><a class="reference internal" href="platforms">Requirements</a></li>
 <li class="toctree-l1"><a class="reference internal" href="start">Quick start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="types">Data types</a></li>
 <li class="toctree-l1"><a class="reference internal" href="functions">Function calls</a></li>
@@ -204,7 +204,7 @@
         </div>
         <article role="main">
           <section id="koffi-version">
-<h1>Koffi 1.3.5<a class="headerlink" href="#koffi-version" title="Permalink to this heading">#</a></h1>
+<h1>Koffi 1.3.8<a class="headerlink" href="#koffi-version" title="Permalink to this heading">#</a></h1>
 <section id="overview">
 <h2>Overview<a class="headerlink" href="#overview" title="Permalink to this heading">#</a></h2>
 <p>Koffi is a <strong>fast and easy-to-use C FFI module for Node.js</strong>, featuring:</p>
@@ -214,13 +214,19 @@
 <li><p>Javascript functions can be used as C callbacks (since 1.2.0)</p></li>
 <li><p>Well-tested code base for <a class="reference internal" href="platforms#supported-platforms"><span class="std std-ref">popular OS/architecture combinations</span></a></p></li>
 </ul>
+<p>Koffi requires a recent <a class="reference external" href="https://nodejs.org/">Node.js</a> version with N-API version 8 support, see <a class="reference internal" href="platforms#node-js"><span class="std std-ref">this page</span></a> for more information.</p>
 </section>
 <section id="table-of-contents">
 <h2>Table of contents<a class="headerlink" href="#table-of-contents" title="Permalink to this heading">#</a></h2>
 <div class="toctree-wrapper compound">
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="platforms">Supported platforms</a></li>
+<li class="toctree-l1"><a class="reference internal" href="platforms">Requirements</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="platforms#node-js">Node.js</a></li>
+<li class="toctree-l2"><a class="reference internal" href="platforms#supported-platforms">Supported platforms</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="start">Quick start</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="start#install-koffi">Install Koffi</a></li>
 <li class="toctree-l2"><a class="reference internal" href="start#small-linux-example">Small Linux example</a></li>
 <li class="toctree-l2"><a class="reference internal" href="start#small-windows-example">Small Windows example</a></li>
 </ul>
@@ -249,9 +255,9 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="benchmarks">Benchmarks</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="benchmarks#rand-results">rand results</a></li>
-<li class="toctree-l2"><a class="reference internal" href="benchmarks#atoi-results">atoi results</a></li>
-<li class="toctree-l2"><a class="reference internal" href="benchmarks#raylib-results">Raylib results</a></li>
+<li class="toctree-l2"><a class="reference internal" href="benchmarks#overview">Overview</a></li>
+<li class="toctree-l2"><a class="reference internal" href="benchmarks#linux-x86-64">Linux x86_64</a></li>
+<li class="toctree-l2"><a class="reference internal" href="benchmarks#windows-x86-64">Windows x86_64</a></li>
 <li class="toctree-l2"><a class="reference internal" href="benchmarks#running-benchmarks">Running benchmarks</a></li>
 </ul>
 </li>
@@ -264,6 +270,9 @@
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="changes">Changelog</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="changes#koffi-1-3-8">Koffi 1.3.8</a></li>
+<li class="toctree-l2"><a class="reference internal" href="changes#koffi-1-3-7">Koffi 1.3.7</a></li>
+<li class="toctree-l2"><a class="reference internal" href="changes#koffi-1-3-6">Koffi 1.3.6</a></li>
 <li class="toctree-l2"><a class="reference internal" href="changes#koffi-1-3-5">Koffi 1.3.5</a></li>
 <li class="toctree-l2"><a class="reference internal" href="changes#koffi-1-3-4">Koffi 1.3.4</a></li>
 <li class="toctree-l2"><a class="reference internal" href="changes#koffi-1-3-3">Koffi 1.3.3</a></li>
@@ -295,7 +304,7 @@
                 <div class="context">
                   <span>Next</span>
                 </div>
-                <div class="title">Supported platforms</div>
+                <div class="title">Requirements</div>
               </div>
               <svg><use href="#svg-arrow-right"></use></svg>
             </a>
@@ -332,7 +341,7 @@
         <div class="toc-tree-container">
           <div class="toc-tree">
             <ul>
-<li><a class="reference internal" href="#">Koffi 1.3.5</a><ul>
+<li><a class="reference internal" href="#">Koffi 1.3.8</a><ul>
 <li><a class="reference internal" href="#overview">Overview</a></li>
 <li><a class="reference internal" href="#table-of-contents">Table of contents</a></li>
 <li><a class="reference internal" href="#license">License</a></li>

package/doc/dist/html/memory.html

@@ -5,7 +5,7 @@
     <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 <link rel="index" title="Index" href="genindex" /><link rel="search" title="Search" href="search" /><link rel="next" title="Benchmarks" href="benchmarks" /><link rel="prev" title="Function calls" href="functions" />
 
-    <meta name="generator" content="sphinx-5.0.1, furo 2022.06.04.1"/>
+    <meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/>
         <title>Memory usage - Koffi</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
@@ -162,7 +162,7 @@
 </form>
 <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
   <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="platforms">Supported platforms</a></li>
+<li class="toctree-l1"><a class="reference internal" href="platforms">Requirements</a></li>
 <li class="toctree-l1"><a class="reference internal" href="start">Quick start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="types">Data types</a></li>
 <li class="toctree-l1"><a class="reference internal" href="functions">Function calls</a></li>

package/doc/dist/html/platforms.html

@@ -3,10 +3,10 @@
   <head><meta charset="utf-8"/>
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
-<link rel="index" title="Index" href="genindex" /><link rel="search" title="Search" href="search" /><link rel="next" title="Quick start" href="start" /><link rel="prev" title="Koffi 1.3.5" href="index" />
+<link rel="index" title="Index" href="genindex" /><link rel="search" title="Search" href="search" /><link rel="next" title="Quick start" href="start" /><link rel="prev" title="Koffi 1.3.8" href="index" />
 
-    <meta name="generator" content="sphinx-5.0.1, furo 2022.06.04.1"/>
-        <title>Supported platforms - Koffi</title>
+    <meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/>
+        <title>Requirements - Koffi</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
@@ -141,7 +141,7 @@
           <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
         </button>
       </div>
-      <label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
+      <label class="toc-overlay-icon toc-header-icon" for="__toc">
         <div class="visually-hidden">Toggle table of contents sidebar</div>
         <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
       </label>
@@ -162,7 +162,7 @@
 </form>
 <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
   <ul class="current">
-<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Supported platforms</a></li>
+<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Requirements</a></li>
 <li class="toctree-l1"><a class="reference internal" href="start">Quick start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="types">Data types</a></li>
 <li class="toctree-l1"><a class="reference internal" href="functions">Function calls</a></li>
@@ -197,14 +197,28 @@
               <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
             </button>
           </div>
-          <label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
+          <label class="toc-overlay-icon toc-content-icon" for="__toc">
             <div class="visually-hidden">Toggle table of contents sidebar</div>
             <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
           </label>
         </div>
         <article role="main">
-          <section id="supported-platforms">
-<h1>Supported platforms<a class="headerlink" href="#supported-platforms" title="Permalink to this heading">#</a></h1>
+          <section id="requirements">
+<h1>Requirements<a class="headerlink" href="#requirements" title="Permalink to this heading">#</a></h1>
+<section id="node-js">
+<h2>Node.js<a class="headerlink" href="#node-js" title="Permalink to this heading">#</a></h2>
+<p>Koffi requires a recent <a class="reference external" href="https://nodejs.org/">Node.js</a> version with <a class="reference external" href="https://nodejs.org/api/n-api.html">N-API</a> version 8 support:</p>
+<ul class="simple">
+<li><p>Node &lt; 12.22.0 is not supported</p></li>
+<li><p><em>Node 12.x</em>: Node 12.22.0 or newer</p></li>
+<li><p><em>Node 14.x</em>: Node 14.17.0 or newer</p></li>
+<li><p><em>Node 15.x</em>: Node 15.12.0 or newer</p></li>
+<li><p>Node 16.0.0 or later versions</p></li>
+</ul>
+<p>Use <a class="reference external" href="https://github.com/nvm-sh/nvm">NVM</a> to install more recent Node versions on older Linux distributions.</p>
+</section>
+<section id="supported-platforms">
+<h2>Supported platforms<a class="headerlink" href="#supported-platforms" title="Permalink to this heading">#</a></h2>
 <p>The following combinations of OS and architectures <strong>are officially supported and tested</strong> at the moment:</p>
 <div class="table-wrapper colwidths-auto docutils container">
 <table class="docutils align-default">
@@ -257,7 +271,6 @@
 </table>
 </div>
 <p>For all fully supported platforms (green check marks), a prebuilt binary is included in the NPM package which means you can install Koffi without a C++ compiler.</p>
-<p>Node 12 or later is required, earlier versions are not supported. Use <a class="reference external" href="https://github.com/nvm-sh/nvm">NVM</a> to install recent Node versions on older Linux distributions.</p>
 <hr class="footnotes docutils" />
 <aside class="footnote brackets" id="id4" role="note">
 <span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id1">1</a><span class="fn-bracket">]</span></span>
@@ -271,6 +284,7 @@
 <span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id3">3</a><span class="fn-bracket">]</span></span>
 <p>The prebuilt binary uses the LP64D (double-precision float) ABI. The LP64 ABI is supported in theory if you build Koffi from source (untested), the LP64F ABI is not supported.</p>
 </aside>
+</section>
 </section>
 
         </article>
@@ -318,9 +332,29 @@
         
       </footer>
     </div>
-    <aside class="toc-drawer no-toc">
+    <aside class="toc-drawer">
       
       
+      <div class="toc-sticky toc-scroll">
+        <div class="toc-title-container">
+          <span class="toc-title">
+            Contents
+          </span>
+        </div>
+        <div class="toc-tree-container">
+          <div class="toc-tree">
+            <ul>
+<li><a class="reference internal" href="#">Requirements</a><ul>
+<li><a class="reference internal" href="#node-js">Node.js</a></li>
+<li><a class="reference internal" href="#supported-platforms">Supported platforms</a></li>
+</ul>
+</li>
+</ul>
+
+          </div>
+        </div>
+      </div>
+      
       
     </aside>
   </div>

package/doc/dist/html/search.html

@@ -4,7 +4,7 @@
     <meta name="viewport" content="width=device-width,initial-scale=1"/>
     <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex" /><link rel="search" title="Search" href="#" />
 
-    <meta name="generator" content="sphinx-5.0.1, furo 2022.06.04.1"/><title>Search - Koffi</title><link rel="stylesheet" type="text/css" href="_static/pygments.css" />
+    <meta name="generator" content="sphinx-5.0.2, furo 2022.06.21"/><title>Search - Koffi</title><link rel="stylesheet" type="text/css" href="_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
     <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
     <link rel="stylesheet" type="text/css" href="_static/custom.css" />
@@ -159,7 +159,7 @@
 </form>
 <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
   <ul>
-<li class="toctree-l1"><a class="reference internal" href="platforms">Supported platforms</a></li>
+<li class="toctree-l1"><a class="reference internal" href="platforms">Requirements</a></li>
 <li class="toctree-l1"><a class="reference internal" href="start">Quick start</a></li>
 <li class="toctree-l1"><a class="reference internal" href="types">Data types</a></li>
 <li class="toctree-l1"><a class="reference internal" href="functions">Function calls</a></li>