koffi 2.1.0-beta.2 → 2.1.0-beta.3

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.
Files changed (104) hide show
  1. package/ChangeLog.md +2 -2
  2. package/build/qemu/2.1.0-beta.3/koffi_darwin_arm64.tar.gz +0 -0
  3. package/build/qemu/2.1.0-beta.3/koffi_darwin_x64.tar.gz +0 -0
  4. package/build/qemu/2.1.0-beta.3/koffi_freebsd_arm64.tar.gz +0 -0
  5. package/build/qemu/2.1.0-beta.3/koffi_freebsd_ia32.tar.gz +0 -0
  6. package/build/qemu/2.1.0-beta.3/koffi_freebsd_x64.tar.gz +0 -0
  7. package/build/qemu/2.1.0-beta.3/koffi_linux_arm32hf.tar.gz +0 -0
  8. package/build/qemu/2.1.0-beta.3/koffi_linux_arm64.tar.gz +0 -0
  9. package/build/qemu/2.1.0-beta.3/koffi_linux_ia32.tar.gz +0 -0
  10. package/build/qemu/2.1.0-beta.3/koffi_linux_riscv64hf64.tar.gz +0 -0
  11. package/build/qemu/2.1.0-beta.3/koffi_linux_x64.tar.gz +0 -0
  12. package/build/qemu/2.1.0-beta.3/koffi_openbsd_ia32.tar.gz +0 -0
  13. package/build/qemu/2.1.0-beta.3/koffi_openbsd_x64.tar.gz +0 -0
  14. package/build/qemu/2.1.0-beta.3/koffi_win32_arm64.tar.gz +0 -0
  15. package/build/qemu/2.1.0-beta.3/koffi_win32_ia32.tar.gz +0 -0
  16. package/build/qemu/2.1.0-beta.3/koffi_win32_x64.tar.gz +0 -0
  17. package/doc/Makefile +1 -1
  18. package/doc/conf.py +5 -0
  19. package/doc/dist/doctrees/changes.doctree +0 -0
  20. package/doc/dist/doctrees/environment.pickle +0 -0
  21. package/doc/dist/doctrees/functions.doctree +0 -0
  22. package/doc/dist/doctrees/index.doctree +0 -0
  23. package/doc/dist/doctrees/types.doctree +0 -0
  24. package/doc/dist/html/.buildinfo +4 -0
  25. package/doc/dist/html/_sources/benchmarks.md.txt +137 -0
  26. package/doc/dist/html/_sources/changes.md.txt +161 -0
  27. package/doc/dist/html/_sources/contribute.md.txt +127 -0
  28. package/doc/dist/html/_sources/functions.md.txt +421 -0
  29. package/doc/dist/html/_sources/index.rst.txt +39 -0
  30. package/doc/dist/html/_sources/memory.md.txt +32 -0
  31. package/doc/dist/html/_sources/platforms.md.txt +31 -0
  32. package/doc/dist/html/_sources/start.md.txt +100 -0
  33. package/doc/dist/html/_sources/types.md.txt +541 -0
  34. package/doc/dist/html/_static/_sphinx_javascript_frameworks_compat.js +134 -0
  35. package/doc/dist/html/_static/basic.css +932 -0
  36. package/doc/dist/html/_static/bench_linux.png +0 -0
  37. package/doc/dist/html/_static/bench_windows.png +0 -0
  38. package/doc/dist/html/_static/custom.css +22 -0
  39. package/doc/dist/html/_static/debug.css +69 -0
  40. package/doc/dist/html/_static/doctools.js +264 -0
  41. package/doc/dist/html/_static/documentation_options.js +14 -0
  42. package/doc/dist/html/_static/file.png +0 -0
  43. package/doc/dist/html/_static/jquery-3.6.0.js +10881 -0
  44. package/doc/dist/html/_static/jquery.js +2 -0
  45. package/doc/dist/html/_static/language_data.js +199 -0
  46. package/doc/dist/html/_static/minus.png +0 -0
  47. package/doc/dist/html/_static/perf_linux_20220623.png +0 -0
  48. package/doc/dist/html/_static/perf_linux_20220623_2.png +0 -0
  49. package/doc/dist/html/_static/perf_windows_20220623.png +0 -0
  50. package/doc/dist/html/_static/perf_windows_20220623_2.png +0 -0
  51. package/doc/dist/html/_static/plus.png +0 -0
  52. package/doc/dist/html/_static/pygments.css +252 -0
  53. package/doc/dist/html/_static/scripts/furo-extensions.js +0 -0
  54. package/doc/dist/html/_static/scripts/furo.js +3 -0
  55. package/doc/dist/html/_static/scripts/furo.js.LICENSE.txt +7 -0
  56. package/doc/dist/html/_static/scripts/furo.js.map +1 -0
  57. package/doc/dist/html/_static/searchtools.js +531 -0
  58. package/doc/dist/html/_static/skeleton.css +296 -0
  59. package/doc/dist/html/_static/styles/furo-extensions.css +2 -0
  60. package/doc/dist/html/_static/styles/furo-extensions.css.map +1 -0
  61. package/doc/dist/html/_static/styles/furo.css +2 -0
  62. package/doc/dist/html/_static/styles/furo.css.map +1 -0
  63. package/doc/dist/html/_static/underscore-1.13.1.js +2042 -0
  64. package/doc/dist/html/_static/underscore.js +6 -0
  65. package/doc/dist/html/benchmarks.html +571 -0
  66. package/doc/dist/html/changes.html +686 -0
  67. package/doc/dist/html/contribute.html +403 -0
  68. package/doc/dist/html/functions.html +718 -0
  69. package/doc/dist/html/genindex.html +253 -0
  70. package/doc/dist/html/index.html +359 -0
  71. package/doc/dist/html/memory.html +346 -0
  72. package/doc/dist/html/objects.inv +0 -0
  73. package/doc/dist/html/platforms.html +371 -0
  74. package/doc/dist/html/search.html +261 -0
  75. package/doc/dist/html/searchindex.js +1 -0
  76. package/doc/dist/html/start.html +384 -0
  77. package/doc/dist/html/types.html +1061 -0
  78. package/doc/make.bat +1 -1
  79. package/doc/templates/badges.html +1 -1
  80. package/doc/types.md +2 -0
  81. package/package.json +2 -1
  82. package/src/abi_arm32.cc +142 -200
  83. package/src/abi_arm64.cc +113 -122
  84. package/src/abi_riscv64.cc +76 -92
  85. package/src/abi_x64_sysv.cc +76 -92
  86. package/src/abi_x64_win.cc +76 -92
  87. package/src/abi_x86.cc +128 -164
  88. package/test/misc.c +43 -0
  89. package/test/sync.js +81 -0
  90. package/build/qemu/2.1.0-beta.2/koffi_darwin_arm64.tar.gz +0 -0
  91. package/build/qemu/2.1.0-beta.2/koffi_darwin_x64.tar.gz +0 -0
  92. package/build/qemu/2.1.0-beta.2/koffi_freebsd_arm64.tar.gz +0 -0
  93. package/build/qemu/2.1.0-beta.2/koffi_freebsd_ia32.tar.gz +0 -0
  94. package/build/qemu/2.1.0-beta.2/koffi_freebsd_x64.tar.gz +0 -0
  95. package/build/qemu/2.1.0-beta.2/koffi_linux_arm32hf.tar.gz +0 -0
  96. package/build/qemu/2.1.0-beta.2/koffi_linux_arm64.tar.gz +0 -0
  97. package/build/qemu/2.1.0-beta.2/koffi_linux_ia32.tar.gz +0 -0
  98. package/build/qemu/2.1.0-beta.2/koffi_linux_riscv64hf64.tar.gz +0 -0
  99. package/build/qemu/2.1.0-beta.2/koffi_linux_x64.tar.gz +0 -0
  100. package/build/qemu/2.1.0-beta.2/koffi_openbsd_ia32.tar.gz +0 -0
  101. package/build/qemu/2.1.0-beta.2/koffi_openbsd_x64.tar.gz +0 -0
  102. package/build/qemu/2.1.0-beta.2/koffi_win32_arm64.tar.gz +0 -0
  103. package/build/qemu/2.1.0-beta.2/koffi_win32_ia32.tar.gz +0 -0
  104. package/build/qemu/2.1.0-beta.2/koffi_win32_x64.tar.gz +0 -0
@@ -0,0 +1,371 @@
1
+ <!doctype html>
2
+ <html class="no-js" lang="en">
3
+ <head><meta charset="utf-8"/>
4
+ <meta name="viewport" content="width=device-width,initial-scale=1"/>
5
+ <meta name="color-scheme" content="light dark"><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
6
+ <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 2.1.0-beta.2" href="index" />
7
+
8
+ <meta name="generator" content="sphinx-5.0.1, furo 2022.06.04.1"/>
9
+ <title>Requirements - Koffi</title>
10
+ <link rel="stylesheet" type="text/css" href="_static/pygments.css" />
11
+ <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
12
+ <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
13
+ <link rel="stylesheet" type="text/css" href="_static/custom.css" />
14
+
15
+
16
+
17
+
18
+ <style>
19
+ body {
20
+ --color-code-background: #f8f8f8;
21
+ --color-code-foreground: black;
22
+ --color-brand-primary: #FF6600;
23
+ --color-brand-content: #FF6600;
24
+
25
+ }
26
+ @media not print {
27
+ body[data-theme="dark"] {
28
+ --color-code-background: #202020;
29
+ --color-code-foreground: #d0d0d0;
30
+ --color-brand-primary: #FF6600;
31
+ --color-brand-content: #FF6600;
32
+
33
+ }
34
+ @media (prefers-color-scheme: dark) {
35
+ body:not([data-theme="light"]) {
36
+ --color-code-background: #202020;
37
+ --color-code-foreground: #d0d0d0;
38
+ --color-brand-primary: #FF6600;
39
+ --color-brand-content: #FF6600;
40
+
41
+ }
42
+ }
43
+ }
44
+ </style></head>
45
+ <body>
46
+
47
+ <script>
48
+ document.body.dataset.theme = localStorage.getItem("theme") || "auto";
49
+ </script>
50
+
51
+
52
+ <svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
53
+ <symbol id="svg-toc" viewBox="0 0 24 24">
54
+ <title>Contents</title>
55
+ <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
56
+ <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
57
+ </svg>
58
+ </symbol>
59
+ <symbol id="svg-menu" viewBox="0 0 24 24">
60
+ <title>Menu</title>
61
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
62
+ stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
63
+ <line x1="3" y1="12" x2="21" y2="12"></line>
64
+ <line x1="3" y1="6" x2="21" y2="6"></line>
65
+ <line x1="3" y1="18" x2="21" y2="18"></line>
66
+ </svg>
67
+ </symbol>
68
+ <symbol id="svg-arrow-right" viewBox="0 0 24 24">
69
+ <title>Expand</title>
70
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
71
+ stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
72
+ <polyline points="9 18 15 12 9 6"></polyline>
73
+ </svg>
74
+ </symbol>
75
+ <symbol id="svg-sun" viewBox="0 0 24 24">
76
+ <title>Light mode</title>
77
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
78
+ stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
79
+ <circle cx="12" cy="12" r="5"></circle>
80
+ <line x1="12" y1="1" x2="12" y2="3"></line>
81
+ <line x1="12" y1="21" x2="12" y2="23"></line>
82
+ <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
83
+ <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
84
+ <line x1="1" y1="12" x2="3" y2="12"></line>
85
+ <line x1="21" y1="12" x2="23" y2="12"></line>
86
+ <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
87
+ <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
88
+ </svg>
89
+ </symbol>
90
+ <symbol id="svg-moon" viewBox="0 0 24 24">
91
+ <title>Dark mode</title>
92
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
93
+ stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
94
+ <path stroke="none" d="M0 0h24v24H0z" fill="none" />
95
+ <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
96
+ </svg>
97
+ </symbol>
98
+ <symbol id="svg-sun-half" viewBox="0 0 24 24">
99
+ <title>Auto light/dark mode</title>
100
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
101
+ stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
102
+ <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
103
+ <circle cx="12" cy="12" r="9" />
104
+ <path d="M13 12h5" />
105
+ <path d="M13 15h4" />
106
+ <path d="M13 18h1" />
107
+ <path d="M13 9h4" />
108
+ <path d="M13 6h1" />
109
+ </svg>
110
+ </symbol>
111
+ </svg>
112
+
113
+ <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
114
+ <input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
115
+ <label class="overlay sidebar-overlay" for="__navigation">
116
+ <div class="visually-hidden">Hide navigation sidebar</div>
117
+ </label>
118
+ <label class="overlay toc-overlay" for="__toc">
119
+ <div class="visually-hidden">Hide table of contents sidebar</div>
120
+ </label>
121
+
122
+
123
+
124
+ <div class="page">
125
+ <header class="mobile-header">
126
+ <div class="header-left">
127
+ <label class="nav-overlay-icon" for="__navigation">
128
+ <div class="visually-hidden">Toggle site navigation sidebar</div>
129
+ <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
130
+ </label>
131
+ </div>
132
+ <div class="header-center">
133
+ <a href="index"><div class="brand">Koffi</div></a>
134
+ </div>
135
+ <div class="header-right">
136
+ <div class="theme-toggle-container theme-toggle-header">
137
+ <button class="theme-toggle">
138
+ <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
139
+ <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
140
+ <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
141
+ <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
142
+ </button>
143
+ </div>
144
+ <label class="toc-overlay-icon toc-header-icon" for="__toc">
145
+ <div class="visually-hidden">Toggle table of contents sidebar</div>
146
+ <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
147
+ </label>
148
+ </div>
149
+ </header>
150
+ <aside class="sidebar-drawer">
151
+ <div class="sidebar-container">
152
+
153
+ <div class="sidebar-sticky"><a class="sidebar-brand" href="index">
154
+
155
+
156
+ <span class="sidebar-brand-text">Koffi</span>
157
+
158
+ </a><form class="sidebar-search-container" method="get" action="search" role="search">
159
+ <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
160
+ <input type="hidden" name="check_keywords" value="yes">
161
+ <input type="hidden" name="area" value="default">
162
+ </form>
163
+ <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
164
+ <ul class="current">
165
+ <li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Requirements</a></li>
166
+ <li class="toctree-l1"><a class="reference internal" href="start">Quick start</a></li>
167
+ <li class="toctree-l1"><a class="reference internal" href="types">Data types</a></li>
168
+ <li class="toctree-l1"><a class="reference internal" href="functions">Functions</a></li>
169
+ <li class="toctree-l1"><a class="reference internal" href="memory">Memory usage</a></li>
170
+ <li class="toctree-l1"><a class="reference internal" href="benchmarks">Benchmarks</a></li>
171
+ <li class="toctree-l1"><a class="reference internal" href="contribute">Contributing</a></li>
172
+ <li class="toctree-l1"><a class="reference internal" href="changes">Changelog</a></li>
173
+ </ul>
174
+
175
+ </div>
176
+ <div style="text-align: center; margin-top: 2em;">
177
+ <a href="https://www.npmjs.com/package/koffi"><img src="https://img.shields.io/badge/NPM-2.O.1-brightgreen" alt="NPM"/></a>
178
+ <a href="https://github.com/Koromix/luigi/tree/master/koffi"><img src="https://img.shields.io/badge/GitHub-Koffi-ff6600" alt="GitHub"/></a>
179
+ </div></div>
180
+
181
+ </div>
182
+
183
+ </div>
184
+ </aside>
185
+ <div class="main">
186
+ <div class="content">
187
+ <div class="article-container">
188
+ <a href="#" class="back-to-top muted-link">
189
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
190
+ <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
191
+ </svg>
192
+ <span>Back to top</span>
193
+ </a>
194
+ <div class="content-icon-container">
195
+ <div class="theme-toggle-container theme-toggle-content">
196
+ <button class="theme-toggle">
197
+ <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
198
+ <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
199
+ <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
200
+ <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
201
+ </button>
202
+ </div>
203
+ <label class="toc-overlay-icon toc-content-icon" for="__toc">
204
+ <div class="visually-hidden">Toggle table of contents sidebar</div>
205
+ <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
206
+ </label>
207
+ </div>
208
+ <article role="main">
209
+ <section id="requirements">
210
+ <h1>Requirements<a class="headerlink" href="#requirements" title="Permalink to this heading">#</a></h1>
211
+ <section id="node-js">
212
+ <h2>Node.js<a class="headerlink" href="#node-js" title="Permalink to this heading">#</a></h2>
213
+ <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>
214
+ <ul class="simple">
215
+ <li><p>Node &lt; 12.22.0 is not supported</p></li>
216
+ <li><p><em>Node 12.x</em>: Node 12.22.0 or newer</p></li>
217
+ <li><p><em>Node 14.x</em>: Node 14.17.0 or newer</p></li>
218
+ <li><p><em>Node 15.x</em>: Node 15.12.0 or newer</p></li>
219
+ <li><p>Node 16.0.0 or later versions</p></li>
220
+ </ul>
221
+ <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>
222
+ </section>
223
+ <section id="supported-platforms">
224
+ <h2>Supported platforms<a class="headerlink" href="#supported-platforms" title="Permalink to this heading">#</a></h2>
225
+ <p>The following combinations of OS and architectures <strong>are officially supported and tested</strong> at the moment:</p>
226
+ <div class="table-wrapper colwidths-auto docutils container">
227
+ <table class="docutils align-default">
228
+ <thead>
229
+ <tr class="row-odd"><th class="head"><p>ISA / OS</p></th>
230
+ <th class="head"><p>Windows</p></th>
231
+ <th class="head"><p>Linux</p></th>
232
+ <th class="head"><p>macOS</p></th>
233
+ <th class="head"><p>FreeBSD</p></th>
234
+ <th class="head"><p>OpenBSD</p></th>
235
+ </tr>
236
+ </thead>
237
+ <tbody>
238
+ <tr class="row-even"><td><p>x86 (IA32) <a class="footnote-reference brackets" href="#id4" id="id1" role="doc-noteref"><span class="fn-bracket">[</span>1<span class="fn-bracket">]</span></a></p></td>
239
+ <td><p>✅ Yes</p></td>
240
+ <td><p>✅ Yes</p></td>
241
+ <td><p>⬜️ <em>N/A</em></p></td>
242
+ <td><p>✅ Yes</p></td>
243
+ <td><p>✅ Yes</p></td>
244
+ </tr>
245
+ <tr class="row-odd"><td><p>x86_64 (AMD64)</p></td>
246
+ <td><p>✅ Yes</p></td>
247
+ <td><p>✅ Yes</p></td>
248
+ <td><p>✅ Yes</p></td>
249
+ <td><p>✅ Yes</p></td>
250
+ <td><p>✅ Yes</p></td>
251
+ </tr>
252
+ <tr class="row-even"><td><p>ARM32 LE <a class="footnote-reference brackets" href="#id5" id="id2" role="doc-noteref"><span class="fn-bracket">[</span>2<span class="fn-bracket">]</span></a></p></td>
253
+ <td><p>⬜️ <em>N/A</em></p></td>
254
+ <td><p>✅ Yes</p></td>
255
+ <td><p>⬜️ <em>N/A</em></p></td>
256
+ <td><p>🟨 Probably</p></td>
257
+ <td><p>🟨 Probably</p></td>
258
+ </tr>
259
+ <tr class="row-odd"><td><p>ARM64 (AArch64) LE</p></td>
260
+ <td><p>✅ Yes</p></td>
261
+ <td><p>✅ Yes</p></td>
262
+ <td><p>✅ Yes</p></td>
263
+ <td><p>✅ Yes</p></td>
264
+ <td><p>🟨 Probably</p></td>
265
+ </tr>
266
+ <tr class="row-even"><td><p>RISC-V 64 <a class="footnote-reference brackets" href="#id6" id="id3" role="doc-noteref"><span class="fn-bracket">[</span>3<span class="fn-bracket">]</span></a></p></td>
267
+ <td><p>⬜️ <em>N/A</em></p></td>
268
+ <td><p>✅ Yes</p></td>
269
+ <td><p>⬜️ <em>N/A</em></p></td>
270
+ <td><p>🟨 Probably</p></td>
271
+ <td><p>🟨 Probably</p></td>
272
+ </tr>
273
+ </tbody>
274
+ </table>
275
+ </div>
276
+ <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>
277
+ <hr class="footnotes docutils" />
278
+ <aside class="footnote brackets" id="id4" role="note">
279
+ <span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id1">1</a><span class="fn-bracket">]</span></span>
280
+ <p>The following call conventions are supported for forward calls: cdecl, stdcall, MS fastcall, thiscall. Only cdecl and stdcall can be used for C to JS callbacks.</p>
281
+ </aside>
282
+ <aside class="footnote brackets" id="id5" role="note">
283
+ <span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id2">2</a><span class="fn-bracket">]</span></span>
284
+ <p>The prebuilt binary uses the hard float ABI and expects a VFP coprocessor. Build from source to use Koffi with a different ABI (softfp, soft).</p>
285
+ </aside>
286
+ <aside class="footnote brackets" id="id6" role="note">
287
+ <span class="label"><span class="fn-bracket">[</span><a role="doc-backlink" href="#id3">3</a><span class="fn-bracket">]</span></span>
288
+ <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>
289
+ </aside>
290
+ </section>
291
+ </section>
292
+
293
+ </article>
294
+ </div>
295
+ <footer>
296
+
297
+ <div class="related-pages">
298
+ <a class="next-page" href="start">
299
+ <div class="page-info">
300
+ <div class="context">
301
+ <span>Next</span>
302
+ </div>
303
+ <div class="title">Quick start</div>
304
+ </div>
305
+ <svg><use href="#svg-arrow-right"></use></svg>
306
+ </a>
307
+ <a class="prev-page" href="index">
308
+ <svg><use href="#svg-arrow-right"></use></svg>
309
+ <div class="page-info">
310
+ <div class="context">
311
+ <span>Previous</span>
312
+ </div>
313
+
314
+ <div class="title">Home</div>
315
+
316
+ </div>
317
+ </a>
318
+ </div>
319
+ <div class="bottom-of-page">
320
+ <div class="left-details">
321
+ <div class="copyright">
322
+ Copyright &#169; 2022, Niels Martignène
323
+ </div>
324
+ Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
325
+
326
+ <a href="https://github.com/pradyunsg/furo">Furo</a>
327
+
328
+ </div>
329
+ <div class="right-details">
330
+ <div class="icons">
331
+
332
+ </div>
333
+ </div>
334
+ </div>
335
+
336
+ </footer>
337
+ </div>
338
+ <aside class="toc-drawer">
339
+
340
+
341
+ <div class="toc-sticky toc-scroll">
342
+ <div class="toc-title-container">
343
+ <span class="toc-title">
344
+ Contents
345
+ </span>
346
+ </div>
347
+ <div class="toc-tree-container">
348
+ <div class="toc-tree">
349
+ <ul>
350
+ <li><a class="reference internal" href="#">Requirements</a><ul>
351
+ <li><a class="reference internal" href="#node-js">Node.js</a></li>
352
+ <li><a class="reference internal" href="#supported-platforms">Supported platforms</a></li>
353
+ </ul>
354
+ </li>
355
+ </ul>
356
+
357
+ </div>
358
+ </div>
359
+ </div>
360
+
361
+
362
+ </aside>
363
+ </div>
364
+ </div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
365
+ <script src="_static/jquery.js"></script>
366
+ <script src="_static/underscore.js"></script>
367
+ <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
368
+ <script src="_static/doctools.js"></script>
369
+ <script src="_static/scripts/furo.js"></script>
370
+ </body>
371
+ </html>
@@ -0,0 +1,261 @@
1
+ <!doctype html>
2
+ <html class="no-js" lang="en">
3
+ <head><meta charset="utf-8"/>
4
+ <meta name="viewport" content="width=device-width,initial-scale=1"/>
5
+ <meta name="color-scheme" content="light dark"><link rel="index" title="Index" href="genindex" /><link rel="search" title="Search" href="#" />
6
+
7
+ <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" />
8
+ <link rel="stylesheet" type="text/css" href="_static/styles/furo.css?digest=40978830699223671f4072448e654b5958f38b89" />
9
+ <link rel="stylesheet" type="text/css" href="_static/styles/furo-extensions.css?digest=30d1aed668e5c3a91c3e3bf6a60b675221979f0e" />
10
+ <link rel="stylesheet" type="text/css" href="_static/custom.css" />
11
+
12
+
13
+
14
+
15
+ <style>
16
+ body {
17
+ --color-code-background: #f8f8f8;
18
+ --color-code-foreground: black;
19
+ --color-brand-primary: #FF6600;
20
+ --color-brand-content: #FF6600;
21
+
22
+ }
23
+ @media not print {
24
+ body[data-theme="dark"] {
25
+ --color-code-background: #202020;
26
+ --color-code-foreground: #d0d0d0;
27
+ --color-brand-primary: #FF6600;
28
+ --color-brand-content: #FF6600;
29
+
30
+ }
31
+ @media (prefers-color-scheme: dark) {
32
+ body:not([data-theme="light"]) {
33
+ --color-code-background: #202020;
34
+ --color-code-foreground: #d0d0d0;
35
+ --color-brand-primary: #FF6600;
36
+ --color-brand-content: #FF6600;
37
+
38
+ }
39
+ }
40
+ }
41
+ </style></head>
42
+ <body>
43
+
44
+ <script>
45
+ document.body.dataset.theme = localStorage.getItem("theme") || "auto";
46
+ </script>
47
+
48
+
49
+ <svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
50
+ <symbol id="svg-toc" viewBox="0 0 24 24">
51
+ <title>Contents</title>
52
+ <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
53
+ <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
54
+ </svg>
55
+ </symbol>
56
+ <symbol id="svg-menu" viewBox="0 0 24 24">
57
+ <title>Menu</title>
58
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
59
+ stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
60
+ <line x1="3" y1="12" x2="21" y2="12"></line>
61
+ <line x1="3" y1="6" x2="21" y2="6"></line>
62
+ <line x1="3" y1="18" x2="21" y2="18"></line>
63
+ </svg>
64
+ </symbol>
65
+ <symbol id="svg-arrow-right" viewBox="0 0 24 24">
66
+ <title>Expand</title>
67
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
68
+ stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
69
+ <polyline points="9 18 15 12 9 6"></polyline>
70
+ </svg>
71
+ </symbol>
72
+ <symbol id="svg-sun" viewBox="0 0 24 24">
73
+ <title>Light mode</title>
74
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
75
+ stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
76
+ <circle cx="12" cy="12" r="5"></circle>
77
+ <line x1="12" y1="1" x2="12" y2="3"></line>
78
+ <line x1="12" y1="21" x2="12" y2="23"></line>
79
+ <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
80
+ <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
81
+ <line x1="1" y1="12" x2="3" y2="12"></line>
82
+ <line x1="21" y1="12" x2="23" y2="12"></line>
83
+ <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
84
+ <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
85
+ </svg>
86
+ </symbol>
87
+ <symbol id="svg-moon" viewBox="0 0 24 24">
88
+ <title>Dark mode</title>
89
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
90
+ stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
91
+ <path stroke="none" d="M0 0h24v24H0z" fill="none" />
92
+ <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
93
+ </svg>
94
+ </symbol>
95
+ <symbol id="svg-sun-half" viewBox="0 0 24 24">
96
+ <title>Auto light/dark mode</title>
97
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
98
+ stroke-width="1.5" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-shadow">
99
+ <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
100
+ <circle cx="12" cy="12" r="9" />
101
+ <path d="M13 12h5" />
102
+ <path d="M13 15h4" />
103
+ <path d="M13 18h1" />
104
+ <path d="M13 9h4" />
105
+ <path d="M13 6h1" />
106
+ </svg>
107
+ </symbol>
108
+ </svg>
109
+
110
+ <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
111
+ <input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
112
+ <label class="overlay sidebar-overlay" for="__navigation">
113
+ <div class="visually-hidden">Hide navigation sidebar</div>
114
+ </label>
115
+ <label class="overlay toc-overlay" for="__toc">
116
+ <div class="visually-hidden">Hide table of contents sidebar</div>
117
+ </label>
118
+
119
+
120
+
121
+ <div class="page">
122
+ <header class="mobile-header">
123
+ <div class="header-left">
124
+ <label class="nav-overlay-icon" for="__navigation">
125
+ <div class="visually-hidden">Toggle site navigation sidebar</div>
126
+ <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
127
+ </label>
128
+ </div>
129
+ <div class="header-center">
130
+ <a href="index"><div class="brand">Koffi</div></a>
131
+ </div>
132
+ <div class="header-right">
133
+ <div class="theme-toggle-container theme-toggle-header">
134
+ <button class="theme-toggle">
135
+ <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
136
+ <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
137
+ <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
138
+ <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
139
+ </button>
140
+ </div>
141
+ <label class="toc-overlay-icon toc-header-icon no-toc" for="__toc">
142
+ <div class="visually-hidden">Toggle table of contents sidebar</div>
143
+ <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
144
+ </label>
145
+ </div>
146
+ </header>
147
+ <aside class="sidebar-drawer">
148
+ <div class="sidebar-container">
149
+
150
+ <div class="sidebar-sticky"><a class="sidebar-brand" href="index">
151
+
152
+
153
+ <span class="sidebar-brand-text">Koffi</span>
154
+
155
+ </a><form class="sidebar-search-container" method="get" action="#" role="search">
156
+ <input class="sidebar-search" placeholder=Search name="q" aria-label="Search">
157
+ <input type="hidden" name="check_keywords" value="yes">
158
+ <input type="hidden" name="area" value="default">
159
+ </form>
160
+ <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
161
+ <ul>
162
+ <li class="toctree-l1"><a class="reference internal" href="platforms">Requirements</a></li>
163
+ <li class="toctree-l1"><a class="reference internal" href="start">Quick start</a></li>
164
+ <li class="toctree-l1"><a class="reference internal" href="types">Data types</a></li>
165
+ <li class="toctree-l1"><a class="reference internal" href="functions">Functions</a></li>
166
+ <li class="toctree-l1"><a class="reference internal" href="memory">Memory usage</a></li>
167
+ <li class="toctree-l1"><a class="reference internal" href="benchmarks">Benchmarks</a></li>
168
+ <li class="toctree-l1"><a class="reference internal" href="contribute">Contributing</a></li>
169
+ <li class="toctree-l1"><a class="reference internal" href="changes">Changelog</a></li>
170
+ </ul>
171
+
172
+ </div>
173
+ <div style="text-align: center; margin-top: 2em;">
174
+ <a href="https://www.npmjs.com/package/koffi"><img src="https://img.shields.io/badge/NPM-2.O.1-brightgreen" alt="NPM"/></a>
175
+ <a href="https://github.com/Koromix/luigi/tree/master/koffi"><img src="https://img.shields.io/badge/GitHub-Koffi-ff6600" alt="GitHub"/></a>
176
+ </div></div>
177
+
178
+ </div>
179
+
180
+ </div>
181
+ </aside>
182
+ <div class="main">
183
+ <div class="content">
184
+ <div class="article-container">
185
+ <a href="#" class="back-to-top muted-link">
186
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
187
+ <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
188
+ </svg>
189
+ <span>Back to top</span>
190
+ </a>
191
+ <div class="content-icon-container">
192
+ <div class="theme-toggle-container theme-toggle-content">
193
+ <button class="theme-toggle">
194
+ <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
195
+ <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
196
+ <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
197
+ <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
198
+ </button>
199
+ </div>
200
+ <label class="toc-overlay-icon toc-content-icon no-toc" for="__toc">
201
+ <div class="visually-hidden">Toggle table of contents sidebar</div>
202
+ <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
203
+ </label>
204
+ </div>
205
+ <article role="main">
206
+
207
+ <noscript>
208
+ <div class="admonition error">
209
+ <p class="admonition-title">Error</p>
210
+ <p>
211
+ Please activate JavaScript to enable the search functionality.
212
+ </p>
213
+ </div>
214
+ </noscript>
215
+
216
+ <div id="search-results"></div>
217
+
218
+ </article>
219
+ </div>
220
+ <footer>
221
+
222
+ <div class="related-pages">
223
+
224
+
225
+ </div>
226
+ <div class="bottom-of-page">
227
+ <div class="left-details">
228
+ <div class="copyright">
229
+ Copyright &#169; 2022, Niels Martignène
230
+ </div>
231
+ Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
232
+
233
+ <a href="https://github.com/pradyunsg/furo">Furo</a>
234
+
235
+ </div>
236
+ <div class="right-details">
237
+ <div class="icons">
238
+
239
+ </div>
240
+ </div>
241
+ </div>
242
+
243
+ </footer>
244
+ </div>
245
+ <aside class="toc-drawer no-toc">
246
+
247
+
248
+
249
+ </aside>
250
+ </div>
251
+ </div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
252
+ <script src="_static/jquery.js"></script>
253
+ <script src="_static/underscore.js"></script>
254
+ <script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
255
+ <script src="_static/doctools.js"></script>
256
+ <script src="_static/scripts/furo.js"></script>
257
+
258
+ <script src="_static/searchtools.js"></script>
259
+ <script src="_static/language_data.js"></script>
260
+ <script src="searchindex.js"></script></body>
261
+ </html>