koffi 2.0.1 → 2.1.0-beta.3

package/doc/dist/html/types.html

@@ -174,10 +174,9 @@
 
 </div>
 <div style="text-align: center; margin-top: 2em;">
+    <a href="https://www.npmjs.com/package/koffi"><img src="https://img.shields.io/badge/NPM-2.O.1-brightgreen" alt="NPM"/></a>
     <a href="https://github.com/Koromix/luigi/tree/master/koffi"><img src="https://img.shields.io/badge/GitHub-Koffi-ff6600" alt="GitHub"/></a>
-    <a href="https://github.com/Koromix/luigi/tree/master/koffi"><img src="https://img.shields.io/badge/NPM-2.0.0-brightgreen" alt="NPM"/></a>
-</div>
-</div>
+</div></div>
 
       </div>
       
@@ -211,6 +210,8 @@
 <h1>Data types<a class="headerlink" href="#data-types" title="Permalink to this heading">#</a></h1>
 <section id="primitive-types">
 <h2>Primitive types<a class="headerlink" href="#primitive-types" title="Permalink to this heading">#</a></h2>
+<section id="standard-types">
+<h3>Standard types<a class="headerlink" href="#standard-types" title="Permalink to this heading">#</a></h3>
 <p>While the C standard allows for variation in the size of most integer types, Koffi enforces the same definition for most primitive types, listed below:</p>
 <div class="table-wrapper colwidths-auto docutils container">
 <table class="docutils align-default">
@@ -223,32 +224,20 @@
 </tr>
 </thead>
 <tbody>
-<tr class="row-even"><td><p>Null</p></td>
+<tr class="row-even"><td><p>Undefined</p></td>
 <td><p>void</p></td>
 <td><p>0</p></td>
 <td><p></p></td>
 <td><p>Only valid as a return type</p></td>
 </tr>
 <tr class="row-odd"><td><p>Number (integer)</p></td>
-<td><p>int8</p></td>
+<td><p>int8, int8_t</p></td>
 <td><p>1</p></td>
 <td><p>Signed</p></td>
 <td><p></p></td>
 </tr>
 <tr class="row-even"><td><p>Number (integer)</p></td>
-<td><p>int8_t</p></td>
-<td><p>1</p></td>
-<td><p>Signed</p></td>
-<td><p></p></td>
-</tr>
-<tr class="row-odd"><td><p>Number (integer)</p></td>
-<td><p>uint8</p></td>
-<td><p>1</p></td>
-<td><p>Unsigned</p></td>
-<td><p></p></td>
-</tr>
-<tr class="row-even"><td><p>Number (integer)</p></td>
-<td><p>uint8_t</p></td>
+<td><p>uint8, uint8_t</p></td>
 <td><p>1</p></td>
 <td><p>Unsigned</p></td>
 <td><p></p></td>
@@ -260,49 +249,25 @@
 <td><p></p></td>
 </tr>
 <tr class="row-even"><td><p>Number (integer)</p></td>
-<td><p>uchar</p></td>
-<td><p>1</p></td>
-<td><p>Unsigned</p></td>
-<td><p></p></td>
-</tr>
-<tr class="row-odd"><td><p>Number (integer)</p></td>
-<td><p>unsigned char</p></td>
+<td><p>uchar, unsigned char</p></td>
 <td><p>1</p></td>
 <td><p>Unsigned</p></td>
 <td><p></p></td>
 </tr>
-<tr class="row-even"><td><p>Number (integer)</p></td>
-<td><p>char16</p></td>
-<td><p>2</p></td>
-<td><p>Signed</p></td>
-<td><p></p></td>
-</tr>
 <tr class="row-odd"><td><p>Number (integer)</p></td>
-<td><p>char16_t</p></td>
+<td><p>char16, char16_t</p></td>
 <td><p>2</p></td>
 <td><p>Signed</p></td>
 <td><p></p></td>
 </tr>
 <tr class="row-even"><td><p>Number (integer)</p></td>
-<td><p>int16</p></td>
+<td><p>int16, int16_t</p></td>
 <td><p>2</p></td>
 <td><p>Signed</p></td>
 <td><p></p></td>
 </tr>
 <tr class="row-odd"><td><p>Number (integer)</p></td>
-<td><p>int16_t</p></td>
-<td><p>2</p></td>
-<td><p>Signed</p></td>
-<td><p></p></td>
-</tr>
-<tr class="row-even"><td><p>Number (integer)</p></td>
-<td><p>uint16</p></td>
-<td><p>2</p></td>
-<td><p>Unsigned</p></td>
-<td><p></p></td>
-</tr>
-<tr class="row-odd"><td><p>Number (integer)</p></td>
-<td><p>uint16_t</p></td>
+<td><p>uint16, uint16_t</p></td>
 <td><p>2</p></td>
 <td><p>Unsigned</p></td>
 <td><p></p></td>
@@ -314,31 +279,19 @@
 <td><p></p></td>
 </tr>
 <tr class="row-odd"><td><p>Number (integer)</p></td>
-<td><p>unsigned short</p></td>
+<td><p>ushort, unsigned short</p></td>
 <td><p>2</p></td>
 <td><p>Unsigned</p></td>
 <td><p></p></td>
 </tr>
 <tr class="row-even"><td><p>Number (integer)</p></td>
-<td><p>int32</p></td>
-<td><p>4</p></td>
-<td><p>Signed</p></td>
-<td><p></p></td>
-</tr>
-<tr class="row-odd"><td><p>Number (integer)</p></td>
-<td><p>int32_t</p></td>
+<td><p>int32, int32_t</p></td>
 <td><p>4</p></td>
 <td><p>Signed</p></td>
 <td><p></p></td>
 </tr>
-<tr class="row-even"><td><p>Number (integer)</p></td>
-<td><p>uint32</p></td>
-<td><p>4</p></td>
-<td><p>Unsigned</p></td>
-<td><p></p></td>
-</tr>
 <tr class="row-odd"><td><p>Number (integer)</p></td>
-<td><p>uint32_t</p></td>
+<td><p>uint32, uint32_t</p></td>
 <td><p>4</p></td>
 <td><p>Unsigned</p></td>
 <td><p></p></td>
@@ -350,84 +303,54 @@
 <td><p></p></td>
 </tr>
 <tr class="row-odd"><td><p>Number (integer)</p></td>
-<td><p>uint</p></td>
+<td><p>uint, unsigned int</p></td>
 <td><p>4</p></td>
 <td><p>Unsigned</p></td>
 <td><p></p></td>
 </tr>
 <tr class="row-even"><td><p>Number (integer)</p></td>
-<td><p>unsigned int</p></td>
-<td><p>4</p></td>
-<td><p>Unsigned</p></td>
-<td><p></p></td>
-</tr>
-<tr class="row-odd"><td><p>Number (integer)</p></td>
-<td><p>int64</p></td>
-<td><p>8</p></td>
-<td><p>Signed</p></td>
-<td><p></p></td>
-</tr>
-<tr class="row-even"><td><p>Number (integer)</p></td>
-<td><p>int64_t</p></td>
+<td><p>int64, int64_t</p></td>
 <td><p>8</p></td>
 <td><p>Signed</p></td>
 <td><p></p></td>
 </tr>
 <tr class="row-odd"><td><p>Number (integer)</p></td>
-<td><p>uint64</p></td>
+<td><p>uint64, uint64_t</p></td>
 <td><p>8</p></td>
 <td><p>Unsigned</p></td>
 <td><p></p></td>
 </tr>
 <tr class="row-even"><td><p>Number (integer)</p></td>
-<td><p>uint64_t</p></td>
-<td><p>8</p></td>
-<td><p>Unsigned</p></td>
-<td><p></p></td>
-</tr>
-<tr class="row-odd"><td><p>Number (integer)</p></td>
-<td><p>longlong</p></td>
-<td><p>8</p></td>
-<td><p>Signed</p></td>
-<td><p></p></td>
-</tr>
-<tr class="row-even"><td><p>Number (integer)</p></td>
-<td><p>long long</p></td>
+<td><p>longlong, long long</p></td>
 <td><p>8</p></td>
 <td><p>Signed</p></td>
 <td><p></p></td>
 </tr>
 <tr class="row-odd"><td><p>Number (integer)</p></td>
-<td><p>ulonglong</p></td>
-<td><p>8</p></td>
-<td><p>Unsigned</p></td>
-<td><p></p></td>
-</tr>
-<tr class="row-even"><td><p>Number (integer)</p></td>
-<td><p>unsigned long long</p></td>
+<td><p>ulonglong, unsigned long long</p></td>
 <td><p>8</p></td>
 <td><p>Unsigned</p></td>
 <td><p></p></td>
 </tr>
-<tr class="row-odd"><td><p>Number (float)</p></td>
+<tr class="row-even"><td><p>Number (float)</p></td>
 <td><p>float32</p></td>
 <td><p>4</p></td>
 <td><p></p></td>
 <td><p></p></td>
 </tr>
-<tr class="row-even"><td><p>Number (float)</p></td>
+<tr class="row-odd"><td><p>Number (float)</p></td>
 <td><p>float64</p></td>
 <td><p>8</p></td>
 <td><p></p></td>
 <td><p></p></td>
 </tr>
-<tr class="row-odd"><td><p>Number (float)</p></td>
+<tr class="row-even"><td><p>Number (float)</p></td>
 <td><p>float</p></td>
 <td><p>4</p></td>
 <td><p></p></td>
 <td><p></p></td>
 </tr>
-<tr class="row-even"><td><p>Number (float)</p></td>
+<tr class="row-odd"><td><p>Number (float)</p></td>
 <td><p>double</p></td>
 <td><p>8</p></td>
 <td><p></p></td>
@@ -489,12 +412,12 @@
 <td><p>4 or 8 bytes depending on register width</p></td>
 </tr>
 <tr class="row-even"><td><p>String</p></td>
-<td><p>str (string)</p></td>
+<td><p>str, string</p></td>
 <td><p></p></td>
 <td><p>JS strings are converted to and from UTF-8</p></td>
 </tr>
 <tr class="row-odd"><td><p>String</p></td>
-<td><p>str16 (string16)</p></td>
+<td><p>str16, string16</p></td>
 <td><p></p></td>
 <td><p>JS strings are converted to and from UTF-16 (LE)</p></td>
 </tr>
@@ -508,8 +431,101 @@
 </pre></div>
 </div>
 </section>
+<section id="endian-sensitive-types">
+<h3>Endian-sensitive types<a class="headerlink" href="#endian-sensitive-types" title="Permalink to this heading">#</a></h3>
+<p>Koffi defines a bunch of endian-sensitive types, which can be used when dealing with binary data (network payloads, binary file formats, etc.).</p>
+<div class="table-wrapper colwidths-auto docutils container">
+<table class="docutils align-default">
+<thead>
+<tr class="row-odd"><th class="head"><p>JS type</p></th>
+<th class="head"><p>C type</p></th>
+<th class="head"><p>Bytes</p></th>
+<th class="head"><p>Signedness</p></th>
+<th class="head"><p>Endianness</p></th>
+</tr>
+</thead>
+<tbody>
+<tr class="row-even"><td><p>Number (integer)</p></td>
+<td><p>int16_le, int16_le_t</p></td>
+<td><p>2</p></td>
+<td><p>Signed</p></td>
+<td><p>Little Endian</p></td>
+</tr>
+<tr class="row-odd"><td><p>Number (integer)</p></td>
+<td><p>int16_be, int16_be_t</p></td>
+<td><p>2</p></td>
+<td><p>Signed</p></td>
+<td><p>Big Endian</p></td>
+</tr>
+<tr class="row-even"><td><p>Number (integer)</p></td>
+<td><p>uint16_le, uint16_le_t</p></td>
+<td><p>2</p></td>
+<td><p>Unsigned</p></td>
+<td><p>Little Endian</p></td>
+</tr>
+<tr class="row-odd"><td><p>Number (integer)</p></td>
+<td><p>uint16_be, uint16_be_t</p></td>
+<td><p>2</p></td>
+<td><p>Unsigned</p></td>
+<td><p>Big Endian</p></td>
+</tr>
+<tr class="row-even"><td><p>Number (integer)</p></td>
+<td><p>int32_le, int32_le_t</p></td>
+<td><p>4</p></td>
+<td><p>Signed</p></td>
+<td><p>Little Endian</p></td>
+</tr>
+<tr class="row-odd"><td><p>Number (integer)</p></td>
+<td><p>int32_be, int32_be_t</p></td>
+<td><p>4</p></td>
+<td><p>Signed</p></td>
+<td><p>Big Endian</p></td>
+</tr>
+<tr class="row-even"><td><p>Number (integer)</p></td>
+<td><p>uint32_le, uint32_le_t</p></td>
+<td><p>4</p></td>
+<td><p>Unsigned</p></td>
+<td><p>Little Endian</p></td>
+</tr>
+<tr class="row-odd"><td><p>Number (integer)</p></td>
+<td><p>uint32_be, uint32_be_t</p></td>
+<td><p>4</p></td>
+<td><p>Unsigned</p></td>
+<td><p>Big Endian</p></td>
+</tr>
+<tr class="row-even"><td><p>Number (integer)</p></td>
+<td><p>int64_le, int64_le_t</p></td>
+<td><p>8</p></td>
+<td><p>Signed</p></td>
+<td><p>Little Endian</p></td>
+</tr>
+<tr class="row-odd"><td><p>Number (integer)</p></td>
+<td><p>int64_be, int64_be_t</p></td>
+<td><p>8</p></td>
+<td><p>Signed</p></td>
+<td><p>Big Endian</p></td>
+</tr>
+<tr class="row-even"><td><p>Number (integer)</p></td>
+<td><p>uint64_le, uint64_le_t</p></td>
+<td><p>8</p></td>
+<td><p>Unsigned</p></td>
+<td><p>Little Endian</p></td>
+</tr>
+<tr class="row-odd"><td><p>Number (integer)</p></td>
+<td><p>uint64_be, uint64_be_t</p></td>
+<td><p>8</p></td>
+<td><p>Unsigned</p></td>
+<td><p>Big Endian</p></td>
+</tr>
+</tbody>
+</table>
+</div>
+</section>
+</section>
 <section id="struct-types">
 <h2>Struct types<a class="headerlink" href="#struct-types" title="Permalink to this heading">#</a></h2>
+<section id="struct-definition">
+<h3>Struct definition<a class="headerlink" href="#struct-definition" title="Permalink to this heading">#</a></h3>
 <p>Koffi converts JS objects to C structs, and vice-versa.</p>
 <p>Unlike function declarations, as of now there is only one way to create a struct type, with the <code class="docutils literal notranslate"><span class="pre">koffi.struct()</span></code> function. This function takes two arguments: the first one is the name of the type, and the second one is an object containing the struct member names and types. You can omit the first argument to declare an anonymous struct.</p>
 <p>The following example illustrates how to declare the same struct in C and in JS with Koffi:</p>
@@ -542,51 +558,38 @@
 <span class="linenos">3</span><span class="kd">const</span> <span class="nx">Function2</span> <span class="o">=</span> <span class="nx">lib</span><span class="p">.</span><span class="nx">func</span><span class="p">(</span><span class="s1">&#39;Function&#39;</span><span class="p">,</span> <span class="nx">A</span><span class="p">,</span> <span class="p">[</span><span class="nx">A</span><span class="p">]);</span>
 </pre></div>
 </div>
-</section>
-<section id="pointer-types">
-<h2>Pointer types<a class="headerlink" href="#pointer-types" title="Permalink to this heading">#</a></h2>
-<p>In C, pointer arguments are used for differenty purposes. It is important to distinguish these use cases because Koffi provides different ways to deal with each of them:</p>
+<p>Koffi automatically follows the platform C ABI regarding alignment and padding. However, you can override these rules if needed with:</p>
 <ul class="simple">
-<li><p><strong>Struct pointers</strong>: Use of struct pointers by C libraries fall in two cases: avoid (potentially) expensive copies, and to let the function change struct contents (output or input/output arguments).</p></li>
-<li><p><strong>Opaque handles</strong>: the library does not expose the contents of the structs, and only provides you with a pointer to it (e.g. <code class="docutils literal notranslate"><span class="pre">FILE</span> <span class="pre">*</span></code>). Only the functions provided by the library can do something with this pointer, in Koffi we call this a handle. This is usually done for ABI-stability reason, and to prevent library users from messing directly with library internals.</p></li>
-<li><p><strong>Arrays</strong>: in C, you dynamically-sized arrays are usually passed to functions with pointers, either NULL-terminated (or any other sentinel value) or with an additional length argument.</p></li>
-<li><p><strong>Pointers to primitive types</strong>: This is more rare, and generally used for output or input/output arguments. The Win32 API has a lot of these.</p></li>
+<li><p>Pack all members without padding with <code class="docutils literal notranslate"><span class="pre">koffi.pack()</span></code> (instead of <code class="docutils literal notranslate"><span class="pre">koffi.struct()</span></code>)</p></li>
+<li><p>Change alignment of a specific member as shown below</p></li>
 </ul>
-<section id="struct-pointers">
-<h3>Struct pointers<a class="headerlink" href="#struct-pointers" title="Permalink to this heading">#</a></h3>
-<p>The following Win32 example uses <code class="docutils literal notranslate"><span class="pre">GetCursorPos()</span></code> (with an output parameter) to retrieve and show the current cursor position.</p>
-<div class="highlight-js notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="kd">const</span> <span class="nx">koffi</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;koffi&#39;</span><span class="p">);</span>
-<span class="linenos"> 2</span><span class="kd">const</span> <span class="nx">lib</span> <span class="o">=</span> <span class="nx">koffi</span><span class="p">.</span><span class="nx">load</span><span class="p">(</span><span class="s1">&#39;kernel32.dll&#39;</span><span class="p">);</span>
-<span class="linenos"> 3</span>
-<span class="linenos"> 4</span><span class="c1">// Type declarations</span>
-<span class="linenos"> 5</span><span class="kd">const</span> <span class="nx">POINT</span> <span class="o">=</span> <span class="nx">koffi</span><span class="p">.</span><span class="nx">struct</span><span class="p">(</span><span class="s1">&#39;POINT&#39;</span><span class="p">,</span> <span class="p">{</span>
-<span class="linenos"> 6</span>    <span class="nx">x</span><span class="o">:</span> <span class="s1">&#39;long&#39;</span><span class="p">,</span>
-<span class="linenos"> 7</span>    <span class="nx">y</span><span class="o">:</span> <span class="s1">&#39;long&#39;</span>
-<span class="linenos"> 8</span><span class="p">});</span>
-<span class="linenos"> 9</span>
-<span class="linenos">10</span><span class="c1">// Functions declarations</span>
-<span class="linenos">11</span><span class="kd">const</span> <span class="nx">GetCursorPos</span> <span class="o">=</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 GetCursorPos(_Out_ POINT *pos)&#39;</span><span class="p">);</span>
-<span class="linenos">12</span>
-<span class="linenos">13</span><span class="c1">// Get and show cursor position</span>
-<span class="linenos">14</span><span class="kd">let</span> <span class="nx">pos</span> <span class="o">=</span> <span class="p">{};</span>
-<span class="linenos">15</span><span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">GetCursorPos</span><span class="p">(</span><span class="nx">pos</span><span class="p">))</span>
-<span class="linenos">16</span>    <span class="k">throw</span> <span class="ow">new</span> <span class="ne">Error</span><span class="p">(</span><span class="s1">&#39;Failed to get cursor position&#39;</span><span class="p">);</span>
-<span class="linenos">17</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">pos</span><span class="p">);</span>
+<div class="highlight-js notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="c1">// This struct is 3 bytes long</span>
+<span class="linenos"> 2</span><span class="kd">const</span> <span class="nx">PackedStruct</span> <span class="o">=</span> <span class="nx">koffi</span><span class="p">.</span><span class="nx">pack</span><span class="p">(</span><span class="s1">&#39;PackedStruct&#39;</span><span class="p">,</span> <span class="p">{</span>
+<span class="linenos"> 3</span>    <span class="nx">a</span><span class="o">:</span> <span class="s1">&#39;int8_t&#39;</span><span class="p">,</span>
+<span class="linenos"> 4</span>    <span class="nx">b</span><span class="o">:</span> <span class="s1">&#39;int16_t&#39;</span>
+<span class="linenos"> 5</span><span class="p">});</span>
+<span class="linenos"> 6</span>
+<span class="linenos"> 7</span><span class="c1">// This one is 18 bytes long, the second member has an alignment requirement of 16 bytes</span>
+<span class="linenos"> 8</span><span class="kd">const</span> <span class="nx">BigStruct</span> <span class="o">=</span> <span class="nx">koffi</span><span class="p">.</span><span class="nx">struct</span><span class="p">(</span><span class="s1">&#39;BigStruct&#39;</span><span class="p">,</span> <span class="p">{</span>
+<span class="linenos"> 9</span>    <span class="nx">a</span><span class="o">:</span> <span class="s1">&#39;int8_t&#39;</span><span class="p">,</span>
+<span class="linenos">10</span>    <span class="nx">b</span><span class="o">:</span> <span class="p">[</span><span class="mf">16</span><span class="p">,</span> <span class="s1">&#39;int16_t&#39;</span><span class="p">]</span>
+<span class="linenos">11</span><span class="p">})</span>
 </pre></div>
 </div>
 </section>
-<section id="opaque-handles">
-<h3>Opaque handles<a class="headerlink" href="#opaque-handles" title="Permalink to this heading">#</a></h3>
-<p>Many C libraries use some kind of object-oriented API, with a pair of functions dedicated to create and delete objects. An obvious example of this can be found in stdio.h, with the opaque <code class="docutils literal notranslate"><span class="pre">FILE</span> <span class="pre">*</span></code> pointer. You can open and close files with <code class="docutils literal notranslate"><span class="pre">fopen()</span></code> and <code class="docutils literal notranslate"><span class="pre">fclose()</span></code>, and manipule the handle with other functions such as <code class="docutils literal notranslate"><span class="pre">fread()</span></code> or <code class="docutils literal notranslate"><span class="pre">ftell()</span></code>.</p>
-<p>In Koffi, you can manage this with opaque handles. Declare the handle type with <code class="docutils literal notranslate"><span class="pre">koffi.handle(name)</span></code>, and use a pointer to this type either as a return type or some kind of <a class="reference internal" href="functions#output-parameters"><span class="std std-doc">output parameter</span></a> (with a double pointer).</p>
+<section id="opaque-types">
+<h3>Opaque types<a class="headerlink" href="#opaque-types" title="Permalink to this heading">#</a></h3>
+<p>Many C libraries use some kind of object-oriented API, with a pair of functions dedicated to create and delete objects. An obvious example of this can be found in stdio.h, with the opaque <code class="docutils literal notranslate"><span class="pre">FILE</span> <span class="pre">*</span></code> pointer. You can open and close files with <code class="docutils literal notranslate"><span class="pre">fopen()</span></code> and <code class="docutils literal notranslate"><span class="pre">fclose()</span></code>, and manipule the opaque pointer with other functions such as <code class="docutils literal notranslate"><span class="pre">fread()</span></code> or <code class="docutils literal notranslate"><span class="pre">ftell()</span></code>.</p>
+<p>In Koffi, you can manage this with opaque types. Declare the opaque type with <code class="docutils literal notranslate"><span class="pre">koffi.opaque(name)</span></code>, and use a pointer to this type either as a return type or some kind of <a class="reference internal" href="functions#output-parameters"><span class="std std-doc">output parameter</span></a> (with a double pointer).</p>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>Opaque handles <strong>have changed in version 2.0</strong>.</p>
+<p>Opaque types <strong>have changed in version 2.0, and again in version 2.1</strong>.</p>
 <p>In Koffi 1.x, opaque handles were defined in a way that made them usable directly as parameter and return types, obscuring the underlying pointer.</p>
 <p>Now, you must use them through a pointer, and use an array for output parameters. This is shown in the example below (look for the call to <code class="docutils literal notranslate"><span class="pre">ConcatNewOut</span></code> in the JS part), and is described in the section on <a class="reference internal" href="functions#output-parameters"><span class="std std-doc">output parameters</span></a>.</p>
+<p>In addition to this, you should use <code class="docutils literal notranslate"><span class="pre">koffi.opaque()</span></code> (introduced in Koffi 2.1) instead of <code class="docutils literal notranslate"><span class="pre">koffi.handle()</span></code> which is deprecated, and will be removed eventually in Koffi 3.0.</p>
 <p>Consult the <a class="reference internal" href="changes"><span class="doc std std-doc">migration guide</span></a> for more information.</p>
 </div>
-<p>The full example below implements an iterative string builder (concatenator) in C, and uses it from Javascript to output a mix of Hello World and FizzBuzz. The builder is hidden behind an opaque handle, and is created and destroyed using a pair of C functions: <code class="docutils literal notranslate"><span class="pre">ConcatNew</span></code> (or <code class="docutils literal notranslate"><span class="pre">ConcatNewOut</span></code>) and <code class="docutils literal notranslate"><span class="pre">ConcatFree</span></code>.</p>
+<p>The full example below implements an iterative string builder (concatenator) in C, and uses it from Javascript to output a mix of Hello World and FizzBuzz. The builder is hidden behind an opaque type, and is created and destroyed using a pair of C functions: <code class="docutils literal notranslate"><span class="pre">ConcatNew</span></code> (or <code class="docutils literal notranslate"><span class="pre">ConcatNewOut</span></code>) and <code class="docutils literal notranslate"><span class="pre">ConcatFree</span></code>.</p>
 <div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="linenos">  1</span><span class="c1">// Build with: clang -fPIC -o handles.so -shared handles.c -Wall -O2</span>
 <span class="linenos">  2</span>
 <span class="linenos">  3</span><span class="cp">#include</span><span class="w"> </span><span class="cpf">&lt;stdlib.h&gt;</span><span class="cp"></span>
@@ -708,7 +711,7 @@
 <div class="highlight-js notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="kd">const</span> <span class="nx">koffi</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;koffi&#39;</span><span class="p">);</span>
 <span class="linenos"> 2</span><span class="kd">const</span> <span class="nx">lib</span> <span class="o">=</span> <span class="nx">koffi</span><span class="p">.</span><span class="nx">load</span><span class="p">(</span><span class="s1">&#39;./handles.so&#39;</span><span class="p">);</span>
 <span class="linenos"> 3</span>
-<span class="linenos"> 4</span><span class="kd">const</span> <span class="nx">Concat</span> <span class="o">=</span> <span class="nx">koffi</span><span class="p">.</span><span class="nx">handle</span><span class="p">(</span><span class="s1">&#39;Concat&#39;</span><span class="p">);</span>
+<span class="linenos"> 4</span><span class="kd">const</span> <span class="nx">Concat</span> <span class="o">=</span> <span class="nx">koffi</span><span class="p">.</span><span class="nx">opaque</span><span class="p">(</span><span class="s1">&#39;Concat&#39;</span><span class="p">);</span>
 <span class="linenos"> 5</span><span class="kd">const</span> <span class="nx">ConcatNewOut</span> <span class="o">=</span> <span class="nx">lib</span><span class="p">.</span><span class="nx">func</span><span class="p">(</span><span class="s1">&#39;bool ConcatNewOut(_Out_ Concat **out)&#39;</span><span class="p">);</span>
 <span class="linenos"> 6</span><span class="kd">const</span> <span class="nx">ConcatNew</span> <span class="o">=</span> <span class="nx">lib</span><span class="p">.</span><span class="nx">func</span><span class="p">(</span><span class="s1">&#39;Concat *ConcatNew()&#39;</span><span class="p">);</span>
 <span class="linenos"> 7</span><span class="kd">const</span> <span class="nx">ConcatFree</span> <span class="o">=</span> <span class="nx">lib</span><span class="p">.</span><span class="nx">func</span><span class="p">(</span><span class="s1">&#39;void ConcatFree(Concat *c)&#39;</span><span class="p">);</span>
@@ -758,101 +761,48 @@
 </pre></div>
 </div>
 </section>
-<section id="array-pointers">
-<h3>Array pointers<a class="headerlink" href="#array-pointers" title="Permalink to this heading">#</a></h3>
-<p>In C, dynamically-sized arrays are usually passed around as pointers. The length is either passed as an additional argument, or inferred from the array content itself, for example with a terminating sentinel value (such as a NULL pointers in the case of an array of strings).</p>
-<p>Koffi can translate JS arrays and TypedArrays to pointer arguments. However, because C does not have a proper notion of dynamically-sized arrays (fat pointers), you need to provide the length or the sentinel value yourself depending on the API.</p>
-<p>Here is a simple example of a C function taking a NULL-terminated list of strings as input, to calculate the total length of all strings.</p>
-<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="c1">// Build with: clang -fPIC -o length.so -shared length.c -Wall -O2</span>
-<span class="linenos"> 2</span>
-<span class="linenos"> 3</span><span class="cp">#include</span><span class="w"> </span><span class="cpf">&lt;stdlib.h&gt;</span><span class="cp"></span>
-<span class="linenos"> 4</span><span class="cp">#include</span><span class="w"> </span><span class="cpf">&lt;stdint.h&gt;</span><span class="cp"></span>
-<span class="linenos"> 5</span><span class="cp">#include</span><span class="w"> </span><span class="cpf">&lt;string.h&gt;</span><span class="cp"></span>
-<span class="linenos"> 6</span>
-<span class="linenos"> 7</span><span class="kt">int64_t</span><span class="w"> </span><span class="nf">ComputeTotalLength</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">**</span><span class="n">strings</span><span class="p">)</span><span class="w"></span>
-<span class="linenos"> 8</span><span class="p">{</span><span class="w"></span>
-<span class="linenos"> 9</span><span class="w">    </span><span class="kt">int64_t</span><span class="w"> </span><span class="n">total</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span><span class="w"></span>
-<span class="linenos">10</span>
-<span class="linenos">11</span><span class="w">    </span><span class="k">for</span><span class="w"> </span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">**</span><span class="n">ptr</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">strings</span><span class="p">;</span><span class="w"> </span><span class="o">*</span><span class="n">ptr</span><span class="p">;</span><span class="w"> </span><span class="n">ptr</span><span class="o">++</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
-<span class="linenos">12</span><span class="w">        </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">str</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">*</span><span class="n">ptr</span><span class="p">;</span><span class="w"></span>
-<span class="linenos">13</span><span class="w">        </span><span class="n">total</span><span class="w"> </span><span class="o">+=</span><span class="w"> </span><span class="n">strlen</span><span class="p">(</span><span class="n">str</span><span class="p">);</span><span class="w"></span>
-<span class="linenos">14</span><span class="w">    </span><span class="p">}</span><span class="w"></span>
-<span class="linenos">15</span>
-<span class="linenos">16</span><span class="w">    </span><span class="k">return</span><span class="w"> </span><span class="n">total</span><span class="p">;</span><span class="w"></span>
-<span class="linenos">17</span><span class="p">}</span><span class="w"></span>
-</pre></div>
-</div>
-<div class="highlight-js notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span><span class="kd">const</span> <span class="nx">koffi</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;koffi&#39;</span><span class="p">);</span>
-<span class="linenos">2</span><span class="kd">const</span> <span class="nx">lib</span> <span class="o">=</span> <span class="nx">koffi</span><span class="p">.</span><span class="nx">load</span><span class="p">(</span><span class="s1">&#39;./length.so&#39;</span><span class="p">);</span>
-<span class="linenos">3</span>
-<span class="linenos">4</span><span class="kd">const</span> <span class="nx">ComputeTotalLength</span> <span class="o">=</span> <span class="nx">lib</span><span class="p">.</span><span class="nx">func</span><span class="p">(</span><span class="s1">&#39;int64_t ComputeTotalLength(const char **strings)&#39;</span><span class="p">);</span>
-<span class="linenos">5</span>
-<span class="linenos">6</span><span class="kd">let</span> <span class="nx">strings</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;Get&#39;</span><span class="p">,</span> <span class="s1">&#39;Total&#39;</span><span class="p">,</span> <span class="s1">&#39;Length&#39;</span><span class="p">,</span> <span class="kc">null</span><span class="p">];</span>
-<span class="linenos">7</span><span class="kd">let</span> <span class="nx">total</span> <span class="o">=</span> <span class="nx">ComputeTotalLength</span><span class="p">(</span><span class="nx">strings</span><span class="p">);</span>
-<span class="linenos">8</span>
-<span class="linenos">9</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// Prints 14</span>
-</pre></div>
-</div>
-<p>By default, just like for objects, array arguments are copied from JS to C but not vice-versa. You can however change the direction as documented in the section on <a class="reference internal" href="functions#output-parameters"><span class="std std-doc">output parameters</span></a>.</p>
-<p>Here is an example based on the Win32 API, listing files in the current directory with <code class="docutils literal notranslate"><span class="pre">FindFirstFileW()</span></code> and <code class="docutils literal notranslate"><span class="pre">FindNextFileW()</span></code>:</p>
+</section>
+<section id="pointer-types">
+<h2>Pointer types<a class="headerlink" href="#pointer-types" title="Permalink to this heading">#</a></h2>
+<p>In C, pointer arguments are used for differenty purposes. It is important to distinguish these use cases because Koffi provides different ways to deal with each of them:</p>
+<ul class="simple">
+<li><p><strong>Struct pointers</strong>: Use of struct pointers by C libraries fall in two cases: avoid (potentially) expensive copies, and to let the function change struct contents (output or input/output arguments).</p></li>
+<li><p><strong>Opaque pointers</strong>: the library does not expose the contents of the structs, and only provides you with a pointer to it (e.g. <code class="docutils literal notranslate"><span class="pre">FILE</span> <span class="pre">*</span></code>). Only the functions provided by the library can do something with this pointer, in Koffi we call this an opaque type. This is usually done for ABI-stability reason, and to prevent library users from messing directly with library internals.</p></li>
+<li><p><strong>Pointers to primitive types</strong>: This is more rare, and generally used for output or input/output arguments. The Win32 API has a lot of these.</p></li>
+<li><p><strong>Arrays</strong>: in C, you dynamically-sized arrays are usually passed to functions with pointers, either NULL-terminated (or any other sentinel value) or with an additional length argument.</p></li>
+</ul>
+<section id="struct-pointers">
+<h3>Struct pointers<a class="headerlink" href="#struct-pointers" title="Permalink to this heading">#</a></h3>
+<p>The following Win32 example uses <code class="docutils literal notranslate"><span class="pre">GetCursorPos()</span></code> (with an output parameter) to retrieve and show the current cursor position.</p>
 <div class="highlight-js notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="kd">const</span> <span class="nx">koffi</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;koffi&#39;</span><span class="p">);</span>
 <span class="linenos"> 2</span><span class="kd">const</span> <span class="nx">lib</span> <span class="o">=</span> <span class="nx">koffi</span><span class="p">.</span><span class="nx">load</span><span class="p">(</span><span class="s1">&#39;kernel32.dll&#39;</span><span class="p">);</span>
 <span class="linenos"> 3</span>
-<span class="linenos"> 4</span><span class="kd">const</span> <span class="nx">HANDLE</span> <span class="o">=</span> <span class="nx">koffi</span><span class="p">.</span><span class="nx">pointer</span><span class="p">(</span><span class="s1">&#39;HANDLE&#39;</span><span class="p">,</span> <span class="nx">koffi</span><span class="p">.</span><span class="nx">handle</span><span class="p">());</span>
-<span class="linenos"> 5</span><span class="kd">const</span> <span class="nx">FILETIME</span> <span class="o">=</span> <span class="nx">koffi</span><span class="p">.</span><span class="nx">struct</span><span class="p">(</span><span class="s1">&#39;FILETIME&#39;</span><span class="p">,</span> <span class="p">{</span>
-<span class="linenos"> 6</span>    <span class="nx">dwLowDateTime</span><span class="o">:</span> <span class="s1">&#39;uint&#39;</span><span class="p">,</span>
-<span class="linenos"> 7</span>    <span class="nx">dwHighDateTime</span><span class="o">:</span> <span class="s1">&#39;uint&#39;</span>
+<span class="linenos"> 4</span><span class="c1">// Type declarations</span>
+<span class="linenos"> 5</span><span class="kd">const</span> <span class="nx">POINT</span> <span class="o">=</span> <span class="nx">koffi</span><span class="p">.</span><span class="nx">struct</span><span class="p">(</span><span class="s1">&#39;POINT&#39;</span><span class="p">,</span> <span class="p">{</span>
+<span class="linenos"> 6</span>    <span class="nx">x</span><span class="o">:</span> <span class="s1">&#39;long&#39;</span><span class="p">,</span>
+<span class="linenos"> 7</span>    <span class="nx">y</span><span class="o">:</span> <span class="s1">&#39;long&#39;</span>
 <span class="linenos"> 8</span><span class="p">});</span>
-<span class="linenos"> 9</span><span class="kd">const</span> <span class="nx">WIN32_FIND_DATA</span> <span class="o">=</span> <span class="nx">koffi</span><span class="p">.</span><span class="nx">struct</span><span class="p">(</span><span class="s1">&#39;WIN32_FIND_DATA&#39;</span><span class="p">,</span> <span class="p">{</span>
-<span class="linenos">10</span>    <span class="nx">dwFileAttributes</span><span class="o">:</span> <span class="s1">&#39;uint&#39;</span><span class="p">,</span>
-<span class="linenos">11</span>    <span class="nx">ftCreationTime</span><span class="o">:</span> <span class="nx">FILETIME</span><span class="p">,</span>
-<span class="linenos">12</span>    <span class="nx">ftLastAccessTime</span><span class="o">:</span> <span class="nx">FILETIME</span><span class="p">,</span>
-<span class="linenos">13</span>    <span class="nx">ftLastWriteTime</span><span class="o">:</span> <span class="nx">FILETIME</span><span class="p">,</span>
-<span class="linenos">14</span>    <span class="nx">nFileSizeHigh</span><span class="o">:</span> <span class="s1">&#39;uint&#39;</span><span class="p">,</span>
-<span class="linenos">15</span>    <span class="nx">nFileSizeLow</span><span class="o">:</span> <span class="s1">&#39;uint&#39;</span><span class="p">,</span>
-<span class="linenos">16</span>    <span class="nx">dwReserved0</span><span class="o">:</span> <span class="s1">&#39;uint&#39;</span><span class="p">,</span>
-<span class="linenos">17</span>    <span class="nx">dwReserved1</span><span class="o">:</span> <span class="s1">&#39;uint&#39;</span><span class="p">,</span>
-<span class="linenos">18</span>    <span class="nx">cFileName</span><span class="o">:</span> <span class="nx">koffi</span><span class="p">.</span><span class="nx">array</span><span class="p">(</span><span class="s1">&#39;char16&#39;</span><span class="p">,</span> <span class="mf">260</span><span class="p">),</span>
-<span class="linenos">19</span>    <span class="nx">cAlternateFileName</span><span class="o">:</span> <span class="nx">koffi</span><span class="p">.</span><span class="nx">array</span><span class="p">(</span><span class="s1">&#39;char16&#39;</span><span class="p">,</span> <span class="mf">14</span><span class="p">),</span>
-<span class="linenos">20</span>    <span class="nx">dwFileType</span><span class="o">:</span> <span class="s1">&#39;uint&#39;</span><span class="p">,</span> <span class="c1">// Obsolete. Do not use.</span>
-<span class="linenos">21</span>    <span class="nx">dwCreatorType</span><span class="o">:</span> <span class="s1">&#39;uint&#39;</span><span class="p">,</span> <span class="c1">// Obsolete. Do not use</span>
-<span class="linenos">22</span>    <span class="nx">wFinderFlags</span><span class="o">:</span> <span class="s1">&#39;ushort&#39;</span> <span class="c1">// Obsolete. Do not use</span>
-<span class="linenos">23</span><span class="p">});</span>
-<span class="linenos">24</span>
-<span class="linenos">25</span><span class="kd">const</span> <span class="nx">FindFirstFile</span> <span class="o">=</span> <span class="nx">lib</span><span class="p">.</span><span class="nx">func</span><span class="p">(</span><span class="s1">&#39;HANDLE __stdcall FindFirstFileW(str16 path, _Out_ WIN32_FIND_DATA *data)&#39;</span><span class="p">);</span>
-<span class="linenos">26</span><span class="kd">const</span> <span class="nx">FindNextFile</span> <span class="o">=</span> <span class="nx">lib</span><span class="p">.</span><span class="nx">func</span><span class="p">(</span><span class="s1">&#39;bool __stdcall FindNextFileW(HANDLE h, _Out_ WIN32_FIND_DATA *data)&#39;</span><span class="p">);</span>
-<span class="linenos">27</span><span class="kd">const</span> <span class="nx">FindClose</span> <span class="o">=</span> <span class="nx">lib</span><span class="p">.</span><span class="nx">func</span><span class="p">(</span><span class="s1">&#39;bool __stdcall FindClose(HANDLE h)&#39;</span><span class="p">);</span>
-<span class="linenos">28</span><span class="kd">const</span> <span class="nx">GetLastError</span> <span class="o">=</span> <span class="nx">lib</span><span class="p">.</span><span class="nx">func</span><span class="p">(</span><span class="s1">&#39;uint GetLastError()&#39;</span><span class="p">);</span>
-<span class="linenos">29</span>
-<span class="linenos">30</span><span class="kd">function</span> <span class="nx">list</span><span class="p">(</span><span class="nx">dirname</span><span class="p">)</span> <span class="p">{</span>
-<span class="linenos">31</span>    <span class="kd">let</span> <span class="nx">filenames</span> <span class="o">=</span> <span class="p">[];</span>
-<span class="linenos">32</span>
-<span class="linenos">33</span>    <span class="kd">let</span> <span class="nx">data</span> <span class="o">=</span> <span class="p">{};</span>
-<span class="linenos">34</span>    <span class="kd">let</span> <span class="nx">h</span> <span class="o">=</span> <span class="nx">FindFirstFile</span><span class="p">(</span><span class="nx">dirname</span> <span class="o">+</span> <span class="s1">&#39;\\*&#39;</span><span class="p">,</span> <span class="nx">data</span><span class="p">);</span>
-<span class="linenos">35</span>
-<span class="linenos">36</span>    <span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">h</span><span class="p">)</span> <span class="p">{</span>
-<span class="linenos">37</span>        <span class="k">if</span> <span class="p">(</span><span class="nx">GetLastError</span><span class="p">()</span> <span class="o">==</span> <span class="mf">2</span><span class="p">)</span> <span class="c1">// ERROR_FILE_NOT_FOUND</span>
-<span class="linenos">38</span>            <span class="k">return</span> <span class="nx">filenames</span><span class="p">;</span>
-<span class="linenos">39</span>        <span class="k">throw</span> <span class="ow">new</span> <span class="ne">Error</span><span class="p">(</span><span class="s1">&#39;FindFirstFile() failed&#39;</span><span class="p">);</span>
-<span class="linenos">40</span>    <span class="p">}</span>
-<span class="linenos">41</span>
-<span class="linenos">42</span>    <span class="k">try</span> <span class="p">{</span>
-<span class="linenos">43</span>        <span class="k">do</span> <span class="p">{</span>
-<span class="linenos">44</span>            <span class="k">if</span> <span class="p">(</span><span class="nx">data</span><span class="p">.</span><span class="nx">cFileName</span> <span class="o">!=</span> <span class="s1">&#39;.&#39;</span> <span class="o">&amp;&amp;</span> <span class="nx">data</span><span class="p">.</span><span class="nx">cFileName</span> <span class="o">!=</span> <span class="s1">&#39;..&#39;</span><span class="p">)</span>
-<span class="linenos">45</span>                <span class="nx">filenames</span><span class="p">.</span><span class="nx">push</span><span class="p">(</span><span class="nx">data</span><span class="p">.</span><span class="nx">cFileName</span><span class="p">);</span>
-<span class="linenos">46</span>        <span class="p">}</span> <span class="k">while</span> <span class="p">(</span><span class="nx">FindNextFile</span><span class="p">(</span><span class="nx">h</span><span class="p">,</span> <span class="nx">data</span><span class="p">));</span>
-<span class="linenos">47</span>
-<span class="linenos">48</span>        <span class="k">if</span> <span class="p">(</span><span class="nx">GetLastError</span><span class="p">()</span> <span class="o">!=</span> <span class="mf">18</span><span class="p">)</span> <span class="c1">// ERROR_NO_MORE_FILES</span>
-<span class="linenos">49</span>            <span class="k">throw</span> <span class="ow">new</span> <span class="ne">Error</span><span class="p">(</span><span class="s1">&#39;FindNextFile() failed&#39;</span><span class="p">);</span>
-<span class="linenos">50</span>    <span class="p">}</span> <span class="k">finally</span> <span class="p">{</span>
-<span class="linenos">51</span>        <span class="nx">FindClose</span><span class="p">(</span><span class="nx">h</span><span class="p">);</span>
-<span class="linenos">52</span>    <span class="p">}</span>
-<span class="linenos">53</span>
-<span class="linenos">54</span>    <span class="k">return</span> <span class="nx">filenames</span><span class="p">;</span>
-<span class="linenos">55</span><span class="p">}</span>
-<span class="linenos">56</span>
-<span class="linenos">57</span><span class="kd">let</span> <span class="nx">filenames</span> <span class="o">=</span> <span class="nx">list</span><span class="p">(</span><span class="s1">&#39;.&#39;</span><span class="p">);</span>
-<span class="linenos">58</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">filenames</span><span class="p">);</span>
+<span class="linenos"> 9</span>
+<span class="linenos">10</span><span class="c1">// Functions declarations</span>
+<span class="linenos">11</span><span class="kd">const</span> <span class="nx">GetCursorPos</span> <span class="o">=</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 GetCursorPos(_Out_ POINT *pos)&#39;</span><span class="p">);</span>
+<span class="linenos">12</span>
+<span class="linenos">13</span><span class="c1">// Get and show cursor position</span>
+<span class="linenos">14</span><span class="kd">let</span> <span class="nx">pos</span> <span class="o">=</span> <span class="p">{};</span>
+<span class="linenos">15</span><span class="k">if</span> <span class="p">(</span><span class="o">!</span><span class="nx">GetCursorPos</span><span class="p">(</span><span class="nx">pos</span><span class="p">))</span>
+<span class="linenos">16</span>    <span class="k">throw</span> <span class="ow">new</span> <span class="ne">Error</span><span class="p">(</span><span class="s1">&#39;Failed to get cursor position&#39;</span><span class="p">);</span>
+<span class="linenos">17</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">pos</span><span class="p">);</span>
+</pre></div>
+</div>
+</section>
+<section id="named-pointer-types">
+<h3>Named pointer types<a class="headerlink" href="#named-pointer-types" title="Permalink to this heading">#</a></h3>
+<p><em>New in Koffi 2.0</em></p>
+<p>Some C libraries use handles, which behave as pointers to opaque structs. An example of this is the HANDLE type in the Win32 API. If you want to reproduce this behavior, you can define a <strong>named pointer type</strong> to an opaque type, like so:</p>
+<div class="highlight-js notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span><span class="kd">const</span> <span class="nx">HANDLE</span> <span class="o">=</span> <span class="nx">koffi</span><span class="p">.</span><span class="nx">pointer</span><span class="p">(</span><span class="s1">&#39;HANDLE&#39;</span><span class="p">,</span> <span class="nx">koffi</span><span class="p">.</span><span class="nx">opaque</span><span class="p">());</span>
+<span class="linenos">2</span>
+<span class="linenos">3</span><span class="c1">// And now you get to use it this way:</span>
+<span class="linenos">4</span><span class="kd">const</span> <span class="nx">GetHandleInformation</span> <span class="o">=</span> <span class="nx">lib</span><span class="p">.</span><span class="nx">func</span><span class="p">(</span><span class="s1">&#39;bool __stdcall GetHandleInformation(HANDLE h, _Out_ uint32_t *flags)&#39;</span><span class="p">);</span>
+<span class="linenos">5</span><span class="kd">const</span> <span class="nx">CloseHandle</span> <span class="o">=</span> <span class="nx">lib</span><span class="p">.</span><span class="nx">func</span><span class="p">(</span><span class="s1">&#39;bool __stdcall CloseHandle(HANDLE h)&#39;</span><span class="p">);</span>
 </pre></div>
 </div>
 </section>
@@ -887,8 +837,10 @@
 </div>
 </section>
 </section>
+<section id="array-types">
+<h2>Array types<a class="headerlink" href="#array-types" title="Permalink to this heading">#</a></h2>
 <section id="fixed-size-c-arrays">
-<h2>Fixed-size C arrays<a class="headerlink" href="#fixed-size-c-arrays" title="Permalink to this heading">#</a></h2>
+<h3>Fixed-size C arrays<a class="headerlink" href="#fixed-size-c-arrays" title="Permalink to this heading">#</a></h3>
 <p>Fixed-size arrays are declared with <code class="docutils literal notranslate"><span class="pre">koffi.array(type,</span> <span class="pre">length)</span></code>. Just like in C, they cannot be passed as functions parameters (they degenerate to pointers), or returned by value. You can however embed them in struct types.</p>
 <p>Koffi applies the following conversion rules when passing arrays to/from C:</p>
 <ul class="simple">
@@ -916,8 +868,9 @@
 <span class="linenos">18</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">ReturnFoo2</span><span class="p">({</span> <span class="nx">i</span><span class="o">:</span> <span class="mf">5</span><span class="p">,</span> <span class="nx">a16</span><span class="o">:</span> <span class="p">[</span><span class="mf">6</span><span class="p">,</span> <span class="mf">8</span><span class="p">]</span> <span class="p">}))</span> <span class="c1">// Prints { i: 5, a16: [6, 8] }</span>
 </pre></div>
 </div>
-<section id="handling-of-strings">
-<h3>Handling of strings<a class="headerlink" href="#handling-of-strings" title="Permalink to this heading">#</a></h3>
+</section>
+<section id="fixed-size-string-buffers">
+<h3>Fixed-size string buffers<a class="headerlink" href="#fixed-size-string-buffers" title="Permalink to this heading">#</a></h3>
 <p>Koffi can also convert JS strings to fixed-sized arrays in the following cases:</p>
 <ul class="simple">
 <li><p><strong>char arrays</strong> are filled with the UTF-8 encoded string, truncated if needed. The buffer is always NUL-terminated.</p></li>
@@ -925,6 +878,43 @@
 </ul>
 <p>The reverse case is also true, Koffi can convert a C fixed-size buffer to a JS string. This happens by default for char, char16 and char16_t arrays, but you can also explicitly ask for this with the <code class="docutils literal notranslate"><span class="pre">string</span></code> array hint (e.g. <code class="docutils literal notranslate"><span class="pre">koffi.array('char',</span> <span class="pre">8,</span> <span class="pre">'string')</span></code>).</p>
 </section>
+<section id="array-pointers-dynamic-arrays">
+<h3>Array pointers (dynamic arrays)<a class="headerlink" href="#array-pointers-dynamic-arrays" title="Permalink to this heading">#</a></h3>
+<p>In C, dynamically-sized arrays are usually passed around as pointers. The length is either passed as an additional argument, or inferred from the array content itself, for example with a terminating sentinel value (such as a NULL pointers in the case of an array of strings).</p>
+<p>Koffi can translate JS arrays and TypedArrays to pointer arguments. However, because C does not have a proper notion of dynamically-sized arrays (fat pointers), you need to provide the length or the sentinel value yourself depending on the API.</p>
+<p>Here is a simple example of a C function taking a NULL-terminated list of strings as input, to calculate the total length of all strings.</p>
+<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="c1">// Build with: clang -fPIC -o length.so -shared length.c -Wall -O2</span>
+<span class="linenos"> 2</span>
+<span class="linenos"> 3</span><span class="cp">#include</span><span class="w"> </span><span class="cpf">&lt;stdlib.h&gt;</span><span class="cp"></span>
+<span class="linenos"> 4</span><span class="cp">#include</span><span class="w"> </span><span class="cpf">&lt;stdint.h&gt;</span><span class="cp"></span>
+<span class="linenos"> 5</span><span class="cp">#include</span><span class="w"> </span><span class="cpf">&lt;string.h&gt;</span><span class="cp"></span>
+<span class="linenos"> 6</span>
+<span class="linenos"> 7</span><span class="kt">int64_t</span><span class="w"> </span><span class="nf">ComputeTotalLength</span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">**</span><span class="n">strings</span><span class="p">)</span><span class="w"></span>
+<span class="linenos"> 8</span><span class="p">{</span><span class="w"></span>
+<span class="linenos"> 9</span><span class="w">    </span><span class="kt">int64_t</span><span class="w"> </span><span class="n">total</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mi">0</span><span class="p">;</span><span class="w"></span>
+<span class="linenos">10</span>
+<span class="linenos">11</span><span class="w">    </span><span class="k">for</span><span class="w"> </span><span class="p">(</span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">**</span><span class="n">ptr</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">strings</span><span class="p">;</span><span class="w"> </span><span class="o">*</span><span class="n">ptr</span><span class="p">;</span><span class="w"> </span><span class="n">ptr</span><span class="o">++</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
+<span class="linenos">12</span><span class="w">        </span><span class="k">const</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="o">*</span><span class="n">str</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">*</span><span class="n">ptr</span><span class="p">;</span><span class="w"></span>
+<span class="linenos">13</span><span class="w">        </span><span class="n">total</span><span class="w"> </span><span class="o">+=</span><span class="w"> </span><span class="n">strlen</span><span class="p">(</span><span class="n">str</span><span class="p">);</span><span class="w"></span>
+<span class="linenos">14</span><span class="w">    </span><span class="p">}</span><span class="w"></span>
+<span class="linenos">15</span>
+<span class="linenos">16</span><span class="w">    </span><span class="k">return</span><span class="w"> </span><span class="n">total</span><span class="p">;</span><span class="w"></span>
+<span class="linenos">17</span><span class="p">}</span><span class="w"></span>
+</pre></div>
+</div>
+<div class="highlight-js notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span><span class="kd">const</span> <span class="nx">koffi</span> <span class="o">=</span> <span class="nx">require</span><span class="p">(</span><span class="s1">&#39;koffi&#39;</span><span class="p">);</span>
+<span class="linenos">2</span><span class="kd">const</span> <span class="nx">lib</span> <span class="o">=</span> <span class="nx">koffi</span><span class="p">.</span><span class="nx">load</span><span class="p">(</span><span class="s1">&#39;./length.so&#39;</span><span class="p">);</span>
+<span class="linenos">3</span>
+<span class="linenos">4</span><span class="kd">const</span> <span class="nx">ComputeTotalLength</span> <span class="o">=</span> <span class="nx">lib</span><span class="p">.</span><span class="nx">func</span><span class="p">(</span><span class="s1">&#39;int64_t ComputeTotalLength(const char **strings)&#39;</span><span class="p">);</span>
+<span class="linenos">5</span>
+<span class="linenos">6</span><span class="kd">let</span> <span class="nx">strings</span> <span class="o">=</span> <span class="p">[</span><span class="s1">&#39;Get&#39;</span><span class="p">,</span> <span class="s1">&#39;Total&#39;</span><span class="p">,</span> <span class="s1">&#39;Length&#39;</span><span class="p">,</span> <span class="kc">null</span><span class="p">];</span>
+<span class="linenos">7</span><span class="kd">let</span> <span class="nx">total</span> <span class="o">=</span> <span class="nx">ComputeTotalLength</span><span class="p">(</span><span class="nx">strings</span><span class="p">);</span>
+<span class="linenos">8</span>
+<span class="linenos">9</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">total</span><span class="p">);</span> <span class="c1">// Prints 14</span>
+</pre></div>
+</div>
+<p>By default, just like for objects, array arguments are copied from JS to C but not vice-versa. You can however change the direction as documented in the section on <a class="reference internal" href="functions#output-parameters"><span class="std std-doc">output parameters</span></a>.</p>
+</section>
 </section>
 <section id="disposable-types">
 <h2>Disposable types<a class="headerlink" href="#disposable-types" title="Permalink to this heading">#</a></h2>
@@ -935,6 +925,7 @@
 <h2>Utility functions<a class="headerlink" href="#utility-functions" title="Permalink to this heading">#</a></h2>
 <section id="type-introspection">
 <h3>Type introspection<a class="headerlink" href="#type-introspection" title="Permalink to this heading">#</a></h3>
+<p><em>New in Koffi 2.0: <code class="docutils literal notranslate"><span class="pre">koffi.resolve()</span></code></em></p>
 <p>Koffi exposes three functions to explore type information:</p>
 <ul class="simple">
 <li><p><code class="docutils literal notranslate"><span class="pre">koffi.sizeof(type)</span></code> to get the size of a type</p></li>
@@ -957,6 +948,7 @@
 </section>
 <section id="type-aliases">
 <h3>Type aliases<a class="headerlink" href="#type-aliases" title="Permalink to this heading">#</a></h3>
+<p><em>New in Koffi 2.0</em></p>
 <p>You can alias a type with <code class="docutils literal notranslate"><span class="pre">koffi.alias(name,</span> <span class="pre">type)</span></code>. Aliased types are completely equivalent.</p>
 </section>
 </section>
@@ -1020,17 +1012,26 @@
           <div class="toc-tree">
             <ul>
 <li><a class="reference internal" href="#">Data types</a><ul>
-<li><a class="reference internal" href="#primitive-types">Primitive types</a></li>
-<li><a class="reference internal" href="#struct-types">Struct types</a></li>
+<li><a class="reference internal" href="#primitive-types">Primitive types</a><ul>
+<li><a class="reference internal" href="#standard-types">Standard types</a></li>
+<li><a class="reference internal" href="#endian-sensitive-types">Endian-sensitive types</a></li>
+</ul>
+</li>
+<li><a class="reference internal" href="#struct-types">Struct types</a><ul>
+<li><a class="reference internal" href="#struct-definition">Struct definition</a></li>
+<li><a class="reference internal" href="#opaque-types">Opaque types</a></li>
+</ul>
+</li>
 <li><a class="reference internal" href="#pointer-types">Pointer types</a><ul>
 <li><a class="reference internal" href="#struct-pointers">Struct pointers</a></li>
-<li><a class="reference internal" href="#opaque-handles">Opaque handles</a></li>
-<li><a class="reference internal" href="#array-pointers">Array pointers</a></li>
+<li><a class="reference internal" href="#named-pointer-types">Named pointer types</a></li>
 <li><a class="reference internal" href="#pointers-to-primitive-types">Pointers to primitive types</a></li>
 </ul>
 </li>
-<li><a class="reference internal" href="#fixed-size-c-arrays">Fixed-size C arrays</a><ul>
-<li><a class="reference internal" href="#handling-of-strings">Handling of strings</a></li>
+<li><a class="reference internal" href="#array-types">Array types</a><ul>
+<li><a class="reference internal" href="#fixed-size-c-arrays">Fixed-size C arrays</a></li>
+<li><a class="reference internal" href="#fixed-size-string-buffers">Fixed-size string buffers</a></li>
+<li><a class="reference internal" href="#array-pointers-dynamic-arrays">Array pointers (dynamic arrays)</a></li>
 </ul>
 </li>
 <li><a class="reference internal" href="#disposable-types">Disposable types</a></li>