koffi 1.3.3 → 1.3.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/ChangeLog.md +6 -0
- package/build/qemu/{1.3.3 → 1.3.4}/koffi_darwin_arm64.tar.gz +0 -0
- package/build/qemu/{1.3.3 → 1.3.4}/koffi_darwin_x64.tar.gz +0 -0
- package/build/qemu/{1.3.3 → 1.3.4}/koffi_freebsd_arm64.tar.gz +0 -0
- package/build/qemu/{1.3.3 → 1.3.4}/koffi_freebsd_ia32.tar.gz +0 -0
- package/build/qemu/{1.3.3 → 1.3.4}/koffi_freebsd_x64.tar.gz +0 -0
- package/build/qemu/{1.3.3 → 1.3.4}/koffi_linux_arm32hf.tar.gz +0 -0
- package/build/qemu/{1.3.3 → 1.3.4}/koffi_linux_arm64.tar.gz +0 -0
- package/build/qemu/{1.3.3 → 1.3.4}/koffi_linux_ia32.tar.gz +0 -0
- package/build/qemu/{1.3.3 → 1.3.4}/koffi_linux_riscv64hf64.tar.gz +0 -0
- package/build/qemu/{1.3.3 → 1.3.4}/koffi_linux_x64.tar.gz +0 -0
- package/build/qemu/1.3.4/koffi_openbsd_ia32.tar.gz +0 -0
- package/build/qemu/{1.3.3 → 1.3.4}/koffi_openbsd_x64.tar.gz +0 -0
- package/build/qemu/{1.3.3 → 1.3.4}/koffi_win32_arm64.tar.gz +0 -0
- package/build/qemu/{1.3.3 → 1.3.4}/koffi_win32_ia32.tar.gz +0 -0
- package/build/qemu/{1.3.3 → 1.3.4}/koffi_win32_x64.tar.gz +0 -0
- package/doc/dist/html/_static/pygments.css +54 -54
- package/doc/dist/html/changes.html +8 -0
- package/doc/dist/html/functions.html +66 -66
- package/doc/dist/html/index.html +3 -2
- package/doc/dist/html/memory.html +2 -2
- package/doc/dist/html/objects.inv +0 -0
- package/doc/dist/html/platforms.html +1 -1
- package/doc/dist/html/searchindex.js +1 -1
- package/doc/dist/html/start.html +45 -45
- package/doc/dist/html/types.html +152 -152
- package/package.json +1 -1
- package/src/abi_x86.cc +5 -0
- package/build/qemu/1.3.3/koffi_openbsd_ia32.tar.gz +0 -0
package/doc/dist/html/start.html
CHANGED
|
@@ -210,7 +210,7 @@
|
|
|
210
210
|
</pre></div>
|
|
211
211
|
</div>
|
|
212
212
|
<p>Once you have installed Koffi, you can start by loading it this way:</p>
|
|
213
|
-
<div class="highlight-js notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span><span class="kd">const</span>
|
|
213
|
+
<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">koffi</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">require</span><span class="p">(</span><span class="s1">'koffi'</span><span class="p">);</span><span class="w"></span>
|
|
214
214
|
</pre></div>
|
|
215
215
|
</div>
|
|
216
216
|
<p>Below you can find three examples:</p>
|
|
@@ -222,47 +222,47 @@
|
|
|
222
222
|
<h2>Small Linux example<a class="headerlink" href="#small-linux-example" title="Permalink to this heading">#</a></h2>
|
|
223
223
|
<p>This is a small example for Linux systems, which uses <code class="docutils literal notranslate"><span class="pre">gettimeofday()</span></code> and <code class="docutils literal notranslate"><span class="pre">printf()</span></code> to print the current time and the timezone.</p>
|
|
224
224
|
<p>It illustrates the use of output parameters.</p>
|
|
225
|
-
<div class="highlight-js notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="kd">const</span>
|
|
225
|
+
<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">koffi</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">require</span><span class="p">(</span><span class="s1">'koffi'</span><span class="p">);</span><span class="w"></span>
|
|
226
226
|
<span class="linenos"> 2</span>
|
|
227
|
-
<span class="linenos"> 3</span><span class="c1">// Load the shared library</span>
|
|
228
|
-
<span class="linenos"> 4</span><span class="kd">const</span>
|
|
227
|
+
<span class="linenos"> 3</span><span class="c1">// Load the shared library</span><span class="w"></span>
|
|
228
|
+
<span class="linenos"> 4</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">'libc.so.6'</span><span class="p">);</span><span class="w"></span>
|
|
229
229
|
<span class="linenos"> 5</span>
|
|
230
|
-
<span class="linenos"> 6</span><span class="c1">// Declare struct types</span>
|
|
231
|
-
<span class="linenos"> 7</span><span class="kd">const</span>
|
|
232
|
-
<span class="linenos"> 8</span>
|
|
233
|
-
<span class="linenos"> 9</span>
|
|
234
|
-
<span class="linenos">10</span><span class="p">});</span>
|
|
235
|
-
<span class="linenos">11</span><span class="kd">const</span>
|
|
236
|
-
<span class="linenos">12</span>
|
|
237
|
-
<span class="linenos">13</span>
|
|
238
|
-
<span class="linenos">14</span><span class="p">});</span>
|
|
239
|
-
<span class="linenos">15</span><span class="kd">const</span>
|
|
240
|
-
<span class="linenos">16</span><span class="kd">const</span>
|
|
241
|
-
<span class="linenos">17</span>
|
|
242
|
-
<span class="linenos">18</span>
|
|
243
|
-
<span class="linenos">19</span>
|
|
244
|
-
<span class="linenos">20</span>
|
|
245
|
-
<span class="linenos">21</span>
|
|
246
|
-
<span class="linenos">22</span>
|
|
247
|
-
<span class="linenos">23</span>
|
|
248
|
-
<span class="linenos">24</span>
|
|
249
|
-
<span class="linenos">25</span>
|
|
250
|
-
<span class="linenos">26</span><span class="p">});</span>
|
|
230
|
+
<span class="linenos"> 6</span><span class="c1">// Declare struct types</span><span class="w"></span>
|
|
231
|
+
<span class="linenos"> 7</span><span class="kd">const</span><span class="w"> </span><span class="nx">timeval</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">struct</span><span class="p">(</span><span class="s1">'timeval'</span><span class="p">,</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
232
|
+
<span class="linenos"> 8</span><span class="w"> </span><span class="nx">tv_sec</span><span class="o">:</span><span class="w"> </span><span class="s1">'unsigned int'</span><span class="p">,</span><span class="w"></span>
|
|
233
|
+
<span class="linenos"> 9</span><span class="w"> </span><span class="nx">tv_usec</span><span class="o">:</span><span class="w"> </span><span class="s1">'unsigned int'</span><span class="w"></span>
|
|
234
|
+
<span class="linenos">10</span><span class="p">});</span><span class="w"></span>
|
|
235
|
+
<span class="linenos">11</span><span class="kd">const</span><span class="w"> </span><span class="nx">timezone</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">struct</span><span class="p">(</span><span class="s1">'timezone'</span><span class="p">,</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
236
|
+
<span class="linenos">12</span><span class="w"> </span><span class="nx">tz_minuteswest</span><span class="o">:</span><span class="w"> </span><span class="s1">'int'</span><span class="p">,</span><span class="w"></span>
|
|
237
|
+
<span class="linenos">13</span><span class="w"> </span><span class="nx">tz_dsttime</span><span class="o">:</span><span class="w"> </span><span class="s1">'int'</span><span class="w"></span>
|
|
238
|
+
<span class="linenos">14</span><span class="p">});</span><span class="w"></span>
|
|
239
|
+
<span class="linenos">15</span><span class="kd">const</span><span class="w"> </span><span class="nx">time_t</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">struct</span><span class="p">(</span><span class="s1">'time_t'</span><span class="p">,</span><span class="w"> </span><span class="p">{</span><span class="w"> </span><span class="nx">value</span><span class="o">:</span><span class="w"> </span><span class="s1">'int64_t'</span><span class="w"> </span><span class="p">});</span><span class="w"></span>
|
|
240
|
+
<span class="linenos">16</span><span class="kd">const</span><span class="w"> </span><span class="nx">tm</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">struct</span><span class="p">(</span><span class="s1">'tm'</span><span class="p">,</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
241
|
+
<span class="linenos">17</span><span class="w"> </span><span class="nx">tm_sec</span><span class="o">:</span><span class="w"> </span><span class="s1">'int'</span><span class="p">,</span><span class="w"></span>
|
|
242
|
+
<span class="linenos">18</span><span class="w"> </span><span class="nx">tm_min</span><span class="o">:</span><span class="w"> </span><span class="s1">'int'</span><span class="p">,</span><span class="w"></span>
|
|
243
|
+
<span class="linenos">19</span><span class="w"> </span><span class="nx">tm_hour</span><span class="o">:</span><span class="w"> </span><span class="s1">'int'</span><span class="p">,</span><span class="w"></span>
|
|
244
|
+
<span class="linenos">20</span><span class="w"> </span><span class="nx">tm_mday</span><span class="o">:</span><span class="w"> </span><span class="s1">'int'</span><span class="p">,</span><span class="w"></span>
|
|
245
|
+
<span class="linenos">21</span><span class="w"> </span><span class="nx">tm_mon</span><span class="o">:</span><span class="w"> </span><span class="s1">'int'</span><span class="p">,</span><span class="w"></span>
|
|
246
|
+
<span class="linenos">22</span><span class="w"> </span><span class="nx">tm_year</span><span class="o">:</span><span class="w"> </span><span class="s1">'int'</span><span class="p">,</span><span class="w"></span>
|
|
247
|
+
<span class="linenos">23</span><span class="w"> </span><span class="nx">tm_wday</span><span class="o">:</span><span class="w"> </span><span class="s1">'int'</span><span class="p">,</span><span class="w"></span>
|
|
248
|
+
<span class="linenos">24</span><span class="w"> </span><span class="nx">tm_yday</span><span class="o">:</span><span class="w"> </span><span class="s1">'int'</span><span class="p">,</span><span class="w"></span>
|
|
249
|
+
<span class="linenos">25</span><span class="w"> </span><span class="nx">tm_isdst</span><span class="o">:</span><span class="w"> </span><span class="s1">'int'</span><span class="w"></span>
|
|
250
|
+
<span class="linenos">26</span><span class="p">});</span><span class="w"></span>
|
|
251
251
|
<span class="linenos">27</span>
|
|
252
|
-
<span class="linenos">28</span><span class="c1">// Find functions</span>
|
|
253
|
-
<span class="linenos">29</span><span class="kd">const</span>
|
|
254
|
-
<span class="linenos">30</span><span class="kd">const</span>
|
|
255
|
-
<span class="linenos">31</span><span class="kd">const</span>
|
|
252
|
+
<span class="linenos">28</span><span class="c1">// Find functions</span><span class="w"></span>
|
|
253
|
+
<span class="linenos">29</span><span class="kd">const</span><span class="w"> </span><span class="nx">gettimeofday</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">'int gettimeofday(_Out_ timeval *tv, _Out_ timezone *tz)'</span><span class="p">);</span><span class="w"></span>
|
|
254
|
+
<span class="linenos">30</span><span class="kd">const</span><span class="w"> </span><span class="nx">localtime_r</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">'tm *localtime_r(const time_t *timeval, _Out_ tm *result)'</span><span class="p">);</span><span class="w"></span>
|
|
255
|
+
<span class="linenos">31</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">'int printf(const char *format, ...)'</span><span class="p">);</span><span class="w"></span>
|
|
256
256
|
<span class="linenos">32</span>
|
|
257
|
-
<span class="linenos">33</span><span class="c1">// Get local time</span>
|
|
258
|
-
<span class="linenos">34</span><span class="kd">let</span>
|
|
259
|
-
<span class="linenos">35</span><span class="kd">let</span>
|
|
260
|
-
<span class="linenos">36</span><span class="nx">gettimeofday</span><span class="p">(</span><span class="nx">tv</span><span class="p">,</span>
|
|
261
|
-
<span class="linenos">37</span><span class="nx">localtime_r</span><span class="p">({</span>
|
|
257
|
+
<span class="linenos">33</span><span class="c1">// Get local time</span><span class="w"></span>
|
|
258
|
+
<span class="linenos">34</span><span class="kd">let</span><span class="w"> </span><span class="nx">tv</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{};</span><span class="w"></span>
|
|
259
|
+
<span class="linenos">35</span><span class="kd">let</span><span class="w"> </span><span class="nx">now</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{};</span><span class="w"></span>
|
|
260
|
+
<span class="linenos">36</span><span class="nx">gettimeofday</span><span class="p">(</span><span class="nx">tv</span><span class="p">,</span><span class="w"> </span><span class="kc">null</span><span class="p">);</span><span class="w"></span>
|
|
261
|
+
<span class="linenos">37</span><span class="nx">localtime_r</span><span class="p">({</span><span class="w"> </span><span class="nx">value</span><span class="o">:</span><span class="w"> </span><span class="nx">tv</span><span class="p">.</span><span class="nx">tv_sec</span><span class="w"> </span><span class="p">},</span><span class="w"> </span><span class="nx">now</span><span class="p">);</span><span class="w"></span>
|
|
262
262
|
<span class="linenos">38</span>
|
|
263
|
-
<span class="linenos">39</span><span class="c1">// And format it with printf (variadic function)</span>
|
|
264
|
-
<span class="linenos">40</span><span class="nx">printf</span><span class="p">(</span><span class="s1">'Hello World!\n'</span><span class="p">);</span>
|
|
265
|
-
<span class="linenos">41</span><span class="nx">printf</span><span class="p">(</span><span class="s1">'Local time: %02d:%02d:%02d\n'</span><span class="p">,</span>
|
|
263
|
+
<span class="linenos">39</span><span class="c1">// And format it with printf (variadic function)</span><span class="w"></span>
|
|
264
|
+
<span class="linenos">40</span><span class="nx">printf</span><span class="p">(</span><span class="s1">'Hello World!\n'</span><span class="p">);</span><span class="w"></span>
|
|
265
|
+
<span class="linenos">41</span><span class="nx">printf</span><span class="p">(</span><span class="s1">'Local time: %02d:%02d:%02d\n'</span><span class="p">,</span><span class="w"> </span><span class="s1">'int'</span><span class="p">,</span><span class="w"> </span><span class="nx">now</span><span class="p">.</span><span class="nx">tm_hour</span><span class="p">,</span><span class="w"> </span><span class="s1">'int'</span><span class="p">,</span><span class="w"> </span><span class="nx">now</span><span class="p">.</span><span class="nx">tm_min</span><span class="p">,</span><span class="w"> </span><span class="s1">'int'</span><span class="p">,</span><span class="w"> </span><span class="nx">now</span><span class="p">.</span><span class="nx">tm_sec</span><span class="p">);</span><span class="w"></span>
|
|
266
266
|
</pre></div>
|
|
267
267
|
</div>
|
|
268
268
|
</section>
|
|
@@ -270,18 +270,18 @@
|
|
|
270
270
|
<h2>Small Windows example<a class="headerlink" href="#small-windows-example" title="Permalink to this heading">#</a></h2>
|
|
271
271
|
<p>This is a small example targeting the Win32 API, using <code class="docutils literal notranslate"><span class="pre">MessageBox()</span></code> to show a Hello message to the user.</p>
|
|
272
272
|
<p>It illustrates the use of the x86 stdcall calling convention.</p>
|
|
273
|
-
<div class="highlight-js notranslate"><div class="highlight"><pre><span></span><span class="linenos"> 1</span><span class="kd">const</span>
|
|
273
|
+
<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">koffi</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">require</span><span class="p">(</span><span class="s1">'koffi'</span><span class="p">);</span><span class="w"></span>
|
|
274
274
|
<span class="linenos"> 2</span>
|
|
275
|
-
<span class="linenos"> 3</span><span class="c1">// Load the shared library</span>
|
|
276
|
-
<span class="linenos"> 4</span><span class="kd">const</span>
|
|
275
|
+
<span class="linenos"> 3</span><span class="c1">// Load the shared library</span><span class="w"></span>
|
|
276
|
+
<span class="linenos"> 4</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">'user32.dll'</span><span class="p">);</span><span class="w"></span>
|
|
277
277
|
<span class="linenos"> 5</span>
|
|
278
|
-
<span class="linenos"> 6</span><span class="c1">// Declare constants</span>
|
|
279
|
-
<span class="linenos"> 7</span><span class="kd">const</span>
|
|
278
|
+
<span class="linenos"> 6</span><span class="c1">// Declare constants</span><span class="w"></span>
|
|
279
|
+
<span class="linenos"> 7</span><span class="kd">const</span><span class="w"> </span><span class="nx">MB_ICONINFORMATION</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mh">0x40</span><span class="p">;</span><span class="w"></span>
|
|
280
280
|
<span class="linenos"> 8</span>
|
|
281
|
-
<span class="linenos"> 9</span><span class="c1">// Find functions</span>
|
|
282
|
-
<span class="linenos">10</span><span class="kd">const</span>
|
|
281
|
+
<span class="linenos"> 9</span><span class="c1">// Find functions</span><span class="w"></span>
|
|
282
|
+
<span class="linenos">10</span><span class="kd">const</span><span class="w"> </span><span class="nx">MessageBoxA</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">'MessageBoxA'</span><span class="p">,</span><span class="w"> </span><span class="s1">'int'</span><span class="p">,</span><span class="w"> </span><span class="p">[</span><span class="s1">'void *'</span><span class="p">,</span><span class="w"> </span><span class="s1">'string'</span><span class="p">,</span><span class="w"> </span><span class="s1">'string'</span><span class="p">,</span><span class="w"> </span><span class="s1">'uint'</span><span class="p">]);</span><span class="w"></span>
|
|
283
283
|
<span class="linenos">11</span>
|
|
284
|
-
<span class="linenos">12</span><span class="nx">MessageBoxA</span><span class="p">(</span><span class="kc">null</span><span class="p">,</span>
|
|
284
|
+
<span class="linenos">12</span><span class="nx">MessageBoxA</span><span class="p">(</span><span class="kc">null</span><span class="p">,</span><span class="w"> </span><span class="s1">'Hello'</span><span class="p">,</span><span class="w"> </span><span class="s1">'Foobar'</span><span class="p">,</span><span class="w"> </span><span class="nx">MB_ICONINFORMATION</span><span class="p">);</span><span class="w"></span>
|
|
285
285
|
</pre></div>
|
|
286
286
|
</div>
|
|
287
287
|
</section>
|