koffi 1.2.4 → 1.3.1
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/README.md +7 -489
- package/benchmark/CMakeLists.txt +13 -9
- package/benchmark/raylib_node_raylib.js +67 -0
- package/build/qemu/1.3.1/koffi_darwin_arm64.tar.gz +0 -0
- package/build/qemu/1.3.1/koffi_darwin_x64.tar.gz +0 -0
- package/build/qemu/1.3.1/koffi_freebsd_arm64.tar.gz +0 -0
- package/build/qemu/1.3.1/koffi_freebsd_ia32.tar.gz +0 -0
- package/build/qemu/1.3.1/koffi_freebsd_x64.tar.gz +0 -0
- package/build/qemu/1.3.1/koffi_linux_arm32hf.tar.gz +0 -0
- package/build/qemu/1.3.1/koffi_linux_arm64.tar.gz +0 -0
- package/build/qemu/1.3.1/koffi_linux_ia32.tar.gz +0 -0
- package/build/qemu/1.3.1/koffi_linux_riscv64hf64.tar.gz +0 -0
- package/build/qemu/1.3.1/koffi_linux_x64.tar.gz +0 -0
- package/build/qemu/1.3.1/koffi_openbsd_ia32.tar.gz +0 -0
- package/build/qemu/1.3.1/koffi_openbsd_x64.tar.gz +0 -0
- package/build/qemu/1.3.1/koffi_win32_arm64.tar.gz +0 -0
- package/build/qemu/1.3.1/koffi_win32_ia32.tar.gz +0 -0
- package/build/qemu/1.3.1/koffi_win32_x64.tar.gz +0 -0
- package/doc/Makefile +20 -0
- package/doc/_static/bench_linux.png +0 -0
- package/doc/_static/bench_windows.png +0 -0
- package/doc/_static/custom.css +22 -0
- package/doc/benchmarks.md +113 -0
- package/doc/benchmarks.xlsx +0 -0
- package/doc/conf.py +54 -0
- package/doc/contribute.md +115 -0
- package/doc/dist/doctrees/benchmarks.doctree +0 -0
- package/doc/dist/doctrees/contribute.doctree +0 -0
- package/doc/dist/doctrees/environment.pickle +0 -0
- package/doc/dist/doctrees/functions.doctree +0 -0
- package/doc/dist/doctrees/index.doctree +0 -0
- package/doc/dist/doctrees/memory.doctree +0 -0
- package/doc/dist/doctrees/platforms.doctree +0 -0
- package/doc/dist/doctrees/start.doctree +0 -0
- package/doc/dist/doctrees/types.doctree +0 -0
- package/doc/dist/html/.buildinfo +4 -0
- package/doc/dist/html/_sources/benchmarks.md.txt +113 -0
- package/doc/dist/html/_sources/contribute.md.txt +115 -0
- package/doc/dist/html/_sources/functions.md.txt +224 -0
- package/doc/dist/html/_sources/index.rst.txt +33 -0
- package/doc/dist/html/_sources/memory.md.txt +29 -0
- package/doc/dist/html/_sources/platforms.md.txt +17 -0
- package/doc/dist/html/_sources/start.md.txt +89 -0
- package/doc/dist/html/_sources/types.md.txt +514 -0
- package/doc/dist/html/_static/_sphinx_javascript_frameworks_compat.js +134 -0
- package/doc/dist/html/_static/basic.css +932 -0
- package/doc/dist/html/_static/bench_linux.png +0 -0
- package/doc/dist/html/_static/bench_windows.png +0 -0
- package/doc/dist/html/_static/custom.css +22 -0
- package/doc/dist/html/_static/debug.css +69 -0
- package/doc/dist/html/_static/doctools.js +264 -0
- package/doc/dist/html/_static/documentation_options.js +14 -0
- package/doc/dist/html/_static/file.png +0 -0
- package/doc/dist/html/_static/jquery-3.6.0.js +10881 -0
- package/doc/dist/html/_static/jquery.js +2 -0
- package/doc/dist/html/_static/language_data.js +199 -0
- package/doc/dist/html/_static/minus.png +0 -0
- package/doc/dist/html/_static/plus.png +0 -0
- package/doc/dist/html/_static/pygments.css +252 -0
- package/doc/dist/html/_static/scripts/furo-extensions.js +0 -0
- package/doc/dist/html/_static/scripts/furo.js +3 -0
- package/doc/dist/html/_static/scripts/furo.js.LICENSE.txt +7 -0
- package/doc/dist/html/_static/scripts/furo.js.map +1 -0
- package/doc/dist/html/_static/searchtools.js +531 -0
- package/doc/dist/html/_static/skeleton.css +296 -0
- package/doc/dist/html/_static/styles/furo-extensions.css +2 -0
- package/doc/dist/html/_static/styles/furo-extensions.css.map +1 -0
- package/doc/dist/html/_static/styles/furo.css +2 -0
- package/doc/dist/html/_static/styles/furo.css.map +1 -0
- package/doc/dist/html/_static/underscore-1.13.1.js +2042 -0
- package/doc/dist/html/_static/underscore.js +6 -0
- package/doc/dist/html/benchmarks.html +547 -0
- package/doc/dist/html/contribute.html +382 -0
- package/doc/dist/html/functions.html +530 -0
- package/doc/dist/html/genindex.html +249 -0
- package/doc/dist/html/index.html +342 -0
- package/doc/dist/html/memory.html +337 -0
- package/doc/dist/html/objects.inv +0 -0
- package/doc/dist/html/platforms.html +332 -0
- package/doc/dist/html/search.html +257 -0
- package/doc/dist/html/searchindex.js +1 -0
- package/doc/dist/html/start.html +367 -0
- package/doc/dist/html/types.html +1001 -0
- package/doc/functions.md +224 -0
- package/doc/index.rst +33 -0
- package/doc/make.bat +35 -0
- package/doc/memory.md +29 -0
- package/doc/platforms.md +17 -0
- package/doc/start.md +89 -0
- package/doc/types.md +514 -0
- package/package.json +6 -3
- package/qemu/qemu.js +41 -27
- package/qemu/registry/machines.json +59 -79
- package/qemu/registry/sha256sum.txt +4 -4
- package/src/abi_arm32.cc +20 -48
- package/src/abi_arm64.cc +18 -46
- package/src/abi_arm64_fwd.S +5 -0
- package/src/abi_riscv64.cc +19 -47
- package/src/abi_x64_sysv.cc +18 -46
- package/src/abi_x64_win.cc +19 -47
- package/src/abi_x86.cc +21 -49
- package/src/call.cc +505 -242
- package/src/call.hh +14 -7
- package/src/ffi.cc +50 -27
- package/src/ffi.hh +1 -1
- package/src/parser.cc +2 -20
- package/src/util.cc +50 -11
- package/src/util.hh +2 -0
- package/test/misc.c +31 -0
- package/test/sync.js +41 -4
- package/benchmark/atoi_cc.cc +0 -59
- package/build/qemu/1.2.4/koffi_darwin_arm64.tar.gz +0 -0
- package/build/qemu/1.2.4/koffi_darwin_x64.tar.gz +0 -0
- package/build/qemu/1.2.4/koffi_freebsd_arm64.tar.gz +0 -0
- package/build/qemu/1.2.4/koffi_freebsd_ia32.tar.gz +0 -0
- package/build/qemu/1.2.4/koffi_freebsd_x64.tar.gz +0 -0
- package/build/qemu/1.2.4/koffi_linux_arm.tar.gz +0 -0
- package/build/qemu/1.2.4/koffi_linux_arm64.tar.gz +0 -0
- package/build/qemu/1.2.4/koffi_linux_ia32.tar.gz +0 -0
- package/build/qemu/1.2.4/koffi_linux_riscv64.tar.gz +0 -0
- package/build/qemu/1.2.4/koffi_linux_x64.tar.gz +0 -0
- package/build/qemu/1.2.4/koffi_openbsd_ia32.tar.gz +0 -0
- package/build/qemu/1.2.4/koffi_openbsd_x64.tar.gz +0 -0
- package/build/qemu/1.2.4/koffi_win32_arm64.tar.gz +0 -0
- package/build/qemu/1.2.4/koffi_win32_ia32.tar.gz +0 -0
- package/build/qemu/1.2.4/koffi_win32_x64.tar.gz +0 -0
|
@@ -0,0 +1,1001 @@
|
|
|
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="Function calls" href="functions" /><link rel="prev" title="Quick start" href="start" />
|
|
7
|
+
|
|
8
|
+
<meta name="generator" content="sphinx-5.0.1, furo 2022.06.04.1"/>
|
|
9
|
+
<title>Data types - 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"><a class="reference internal" href="platforms">Supported platforms</a></li>
|
|
166
|
+
<li class="toctree-l1"><a class="reference internal" href="start">Quick start</a></li>
|
|
167
|
+
<li class="toctree-l1 current current-page"><a class="current reference internal" href="#">Data types</a></li>
|
|
168
|
+
<li class="toctree-l1"><a class="reference internal" href="functions">Function calls</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
|
+
</ul>
|
|
173
|
+
|
|
174
|
+
</div>
|
|
175
|
+
</div>
|
|
176
|
+
|
|
177
|
+
</div>
|
|
178
|
+
|
|
179
|
+
</div>
|
|
180
|
+
</aside>
|
|
181
|
+
<div class="main">
|
|
182
|
+
<div class="content">
|
|
183
|
+
<div class="article-container">
|
|
184
|
+
<a href="#" class="back-to-top muted-link">
|
|
185
|
+
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
|
|
186
|
+
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
|
|
187
|
+
</svg>
|
|
188
|
+
<span>Back to top</span>
|
|
189
|
+
</a>
|
|
190
|
+
<div class="content-icon-container">
|
|
191
|
+
<div class="theme-toggle-container theme-toggle-content">
|
|
192
|
+
<button class="theme-toggle">
|
|
193
|
+
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
|
|
194
|
+
<svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
|
|
195
|
+
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
|
|
196
|
+
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
|
|
197
|
+
</button>
|
|
198
|
+
</div>
|
|
199
|
+
<label class="toc-overlay-icon toc-content-icon" for="__toc">
|
|
200
|
+
<div class="visually-hidden">Toggle table of contents sidebar</div>
|
|
201
|
+
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
|
202
|
+
</label>
|
|
203
|
+
</div>
|
|
204
|
+
<article role="main">
|
|
205
|
+
<section id="data-types">
|
|
206
|
+
<h1>Data types<a class="headerlink" href="#data-types" title="Permalink to this heading">#</a></h1>
|
|
207
|
+
<section id="primitive-types">
|
|
208
|
+
<h2>Primitive types<a class="headerlink" href="#primitive-types" title="Permalink to this heading">#</a></h2>
|
|
209
|
+
<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>
|
|
210
|
+
<div class="table-wrapper colwidths-auto docutils container">
|
|
211
|
+
<table class="docutils align-default">
|
|
212
|
+
<thead>
|
|
213
|
+
<tr class="row-odd"><th class="head"><p>JS type</p></th>
|
|
214
|
+
<th class="head"><p>C type</p></th>
|
|
215
|
+
<th class="head"><p>Bytes</p></th>
|
|
216
|
+
<th class="head"><p>Signedness</p></th>
|
|
217
|
+
<th class="head"><p>Note</p></th>
|
|
218
|
+
</tr>
|
|
219
|
+
</thead>
|
|
220
|
+
<tbody>
|
|
221
|
+
<tr class="row-even"><td><p>Null</p></td>
|
|
222
|
+
<td><p>void</p></td>
|
|
223
|
+
<td><p>0</p></td>
|
|
224
|
+
<td><p></p></td>
|
|
225
|
+
<td><p>Only valid as a return type</p></td>
|
|
226
|
+
</tr>
|
|
227
|
+
<tr class="row-odd"><td><p>Number (integer)</p></td>
|
|
228
|
+
<td><p>int8</p></td>
|
|
229
|
+
<td><p>1</p></td>
|
|
230
|
+
<td><p>Signed</p></td>
|
|
231
|
+
<td><p></p></td>
|
|
232
|
+
</tr>
|
|
233
|
+
<tr class="row-even"><td><p>Number (integer)</p></td>
|
|
234
|
+
<td><p>int8_t</p></td>
|
|
235
|
+
<td><p>1</p></td>
|
|
236
|
+
<td><p>Signed</p></td>
|
|
237
|
+
<td><p></p></td>
|
|
238
|
+
</tr>
|
|
239
|
+
<tr class="row-odd"><td><p>Number (integer)</p></td>
|
|
240
|
+
<td><p>uint8</p></td>
|
|
241
|
+
<td><p>1</p></td>
|
|
242
|
+
<td><p>Unsigned</p></td>
|
|
243
|
+
<td><p></p></td>
|
|
244
|
+
</tr>
|
|
245
|
+
<tr class="row-even"><td><p>Number (integer)</p></td>
|
|
246
|
+
<td><p>uint8_t</p></td>
|
|
247
|
+
<td><p>1</p></td>
|
|
248
|
+
<td><p>Unsigned</p></td>
|
|
249
|
+
<td><p></p></td>
|
|
250
|
+
</tr>
|
|
251
|
+
<tr class="row-odd"><td><p>Number (integer)</p></td>
|
|
252
|
+
<td><p>char</p></td>
|
|
253
|
+
<td><p>1</p></td>
|
|
254
|
+
<td><p>Signed</p></td>
|
|
255
|
+
<td><p></p></td>
|
|
256
|
+
</tr>
|
|
257
|
+
<tr class="row-even"><td><p>Number (integer)</p></td>
|
|
258
|
+
<td><p>uchar</p></td>
|
|
259
|
+
<td><p>1</p></td>
|
|
260
|
+
<td><p>Unsigned</p></td>
|
|
261
|
+
<td><p></p></td>
|
|
262
|
+
</tr>
|
|
263
|
+
<tr class="row-odd"><td><p>Number (integer)</p></td>
|
|
264
|
+
<td><p>unsigned char</p></td>
|
|
265
|
+
<td><p>1</p></td>
|
|
266
|
+
<td><p>Unsigned</p></td>
|
|
267
|
+
<td><p></p></td>
|
|
268
|
+
</tr>
|
|
269
|
+
<tr class="row-even"><td><p>Number (integer)</p></td>
|
|
270
|
+
<td><p>char16</p></td>
|
|
271
|
+
<td><p>2</p></td>
|
|
272
|
+
<td><p>Signed</p></td>
|
|
273
|
+
<td><p></p></td>
|
|
274
|
+
</tr>
|
|
275
|
+
<tr class="row-odd"><td><p>Number (integer)</p></td>
|
|
276
|
+
<td><p>char16_t</p></td>
|
|
277
|
+
<td><p>2</p></td>
|
|
278
|
+
<td><p>Signed</p></td>
|
|
279
|
+
<td><p></p></td>
|
|
280
|
+
</tr>
|
|
281
|
+
<tr class="row-even"><td><p>Number (integer)</p></td>
|
|
282
|
+
<td><p>int16</p></td>
|
|
283
|
+
<td><p>2</p></td>
|
|
284
|
+
<td><p>Signed</p></td>
|
|
285
|
+
<td><p></p></td>
|
|
286
|
+
</tr>
|
|
287
|
+
<tr class="row-odd"><td><p>Number (integer)</p></td>
|
|
288
|
+
<td><p>int16_t</p></td>
|
|
289
|
+
<td><p>2</p></td>
|
|
290
|
+
<td><p>Signed</p></td>
|
|
291
|
+
<td><p></p></td>
|
|
292
|
+
</tr>
|
|
293
|
+
<tr class="row-even"><td><p>Number (integer)</p></td>
|
|
294
|
+
<td><p>uint16</p></td>
|
|
295
|
+
<td><p>2</p></td>
|
|
296
|
+
<td><p>Unsigned</p></td>
|
|
297
|
+
<td><p></p></td>
|
|
298
|
+
</tr>
|
|
299
|
+
<tr class="row-odd"><td><p>Number (integer)</p></td>
|
|
300
|
+
<td><p>uint16_t</p></td>
|
|
301
|
+
<td><p>2</p></td>
|
|
302
|
+
<td><p>Unsigned</p></td>
|
|
303
|
+
<td><p></p></td>
|
|
304
|
+
</tr>
|
|
305
|
+
<tr class="row-even"><td><p>Number (integer)</p></td>
|
|
306
|
+
<td><p>short</p></td>
|
|
307
|
+
<td><p>2</p></td>
|
|
308
|
+
<td><p>Signed</p></td>
|
|
309
|
+
<td><p></p></td>
|
|
310
|
+
</tr>
|
|
311
|
+
<tr class="row-odd"><td><p>Number (integer)</p></td>
|
|
312
|
+
<td><p>unsigned short</p></td>
|
|
313
|
+
<td><p>2</p></td>
|
|
314
|
+
<td><p>Unsigned</p></td>
|
|
315
|
+
<td><p></p></td>
|
|
316
|
+
</tr>
|
|
317
|
+
<tr class="row-even"><td><p>Number (integer)</p></td>
|
|
318
|
+
<td><p>int32</p></td>
|
|
319
|
+
<td><p>4</p></td>
|
|
320
|
+
<td><p>Signed</p></td>
|
|
321
|
+
<td><p></p></td>
|
|
322
|
+
</tr>
|
|
323
|
+
<tr class="row-odd"><td><p>Number (integer)</p></td>
|
|
324
|
+
<td><p>int32_t</p></td>
|
|
325
|
+
<td><p>4</p></td>
|
|
326
|
+
<td><p>Signed</p></td>
|
|
327
|
+
<td><p></p></td>
|
|
328
|
+
</tr>
|
|
329
|
+
<tr class="row-even"><td><p>Number (integer)</p></td>
|
|
330
|
+
<td><p>uint32</p></td>
|
|
331
|
+
<td><p>4</p></td>
|
|
332
|
+
<td><p>Unsigned</p></td>
|
|
333
|
+
<td><p></p></td>
|
|
334
|
+
</tr>
|
|
335
|
+
<tr class="row-odd"><td><p>Number (integer)</p></td>
|
|
336
|
+
<td><p>uint32_t</p></td>
|
|
337
|
+
<td><p>4</p></td>
|
|
338
|
+
<td><p>Unsigned</p></td>
|
|
339
|
+
<td><p></p></td>
|
|
340
|
+
</tr>
|
|
341
|
+
<tr class="row-even"><td><p>Number (integer)</p></td>
|
|
342
|
+
<td><p>int</p></td>
|
|
343
|
+
<td><p>4</p></td>
|
|
344
|
+
<td><p>Signed</p></td>
|
|
345
|
+
<td><p></p></td>
|
|
346
|
+
</tr>
|
|
347
|
+
<tr class="row-odd"><td><p>Number (integer)</p></td>
|
|
348
|
+
<td><p>uint</p></td>
|
|
349
|
+
<td><p>4</p></td>
|
|
350
|
+
<td><p>Unsigned</p></td>
|
|
351
|
+
<td><p></p></td>
|
|
352
|
+
</tr>
|
|
353
|
+
<tr class="row-even"><td><p>Number (integer)</p></td>
|
|
354
|
+
<td><p>unsigned int</p></td>
|
|
355
|
+
<td><p>4</p></td>
|
|
356
|
+
<td><p>Unsigned</p></td>
|
|
357
|
+
<td><p></p></td>
|
|
358
|
+
</tr>
|
|
359
|
+
<tr class="row-odd"><td><p>Number (integer)</p></td>
|
|
360
|
+
<td><p>int64</p></td>
|
|
361
|
+
<td><p>8</p></td>
|
|
362
|
+
<td><p>Signed</p></td>
|
|
363
|
+
<td><p></p></td>
|
|
364
|
+
</tr>
|
|
365
|
+
<tr class="row-even"><td><p>Number (integer)</p></td>
|
|
366
|
+
<td><p>int64_t</p></td>
|
|
367
|
+
<td><p>8</p></td>
|
|
368
|
+
<td><p>Signed</p></td>
|
|
369
|
+
<td><p></p></td>
|
|
370
|
+
</tr>
|
|
371
|
+
<tr class="row-odd"><td><p>Number (integer)</p></td>
|
|
372
|
+
<td><p>uint64</p></td>
|
|
373
|
+
<td><p>8</p></td>
|
|
374
|
+
<td><p>Unsigned</p></td>
|
|
375
|
+
<td><p></p></td>
|
|
376
|
+
</tr>
|
|
377
|
+
<tr class="row-even"><td><p>Number (integer)</p></td>
|
|
378
|
+
<td><p>uint64_t</p></td>
|
|
379
|
+
<td><p>8</p></td>
|
|
380
|
+
<td><p>Unsigned</p></td>
|
|
381
|
+
<td><p></p></td>
|
|
382
|
+
</tr>
|
|
383
|
+
<tr class="row-odd"><td><p>Number (integer)</p></td>
|
|
384
|
+
<td><p>longlong</p></td>
|
|
385
|
+
<td><p>8</p></td>
|
|
386
|
+
<td><p>Signed</p></td>
|
|
387
|
+
<td><p></p></td>
|
|
388
|
+
</tr>
|
|
389
|
+
<tr class="row-even"><td><p>Number (integer)</p></td>
|
|
390
|
+
<td><p>long long</p></td>
|
|
391
|
+
<td><p>8</p></td>
|
|
392
|
+
<td><p>Signed</p></td>
|
|
393
|
+
<td><p></p></td>
|
|
394
|
+
</tr>
|
|
395
|
+
<tr class="row-odd"><td><p>Number (integer)</p></td>
|
|
396
|
+
<td><p>ulonglong</p></td>
|
|
397
|
+
<td><p>8</p></td>
|
|
398
|
+
<td><p>Unsigned</p></td>
|
|
399
|
+
<td><p></p></td>
|
|
400
|
+
</tr>
|
|
401
|
+
<tr class="row-even"><td><p>Number (integer)</p></td>
|
|
402
|
+
<td><p>unsigned long long</p></td>
|
|
403
|
+
<td><p>8</p></td>
|
|
404
|
+
<td><p>Unsigned</p></td>
|
|
405
|
+
<td><p></p></td>
|
|
406
|
+
</tr>
|
|
407
|
+
<tr class="row-odd"><td><p>Number (float)</p></td>
|
|
408
|
+
<td><p>float32</p></td>
|
|
409
|
+
<td><p>4</p></td>
|
|
410
|
+
<td><p></p></td>
|
|
411
|
+
<td><p></p></td>
|
|
412
|
+
</tr>
|
|
413
|
+
<tr class="row-even"><td><p>Number (float)</p></td>
|
|
414
|
+
<td><p>float64</p></td>
|
|
415
|
+
<td><p>8</p></td>
|
|
416
|
+
<td><p></p></td>
|
|
417
|
+
<td><p></p></td>
|
|
418
|
+
</tr>
|
|
419
|
+
<tr class="row-odd"><td><p>Number (float)</p></td>
|
|
420
|
+
<td><p>float</p></td>
|
|
421
|
+
<td><p>4</p></td>
|
|
422
|
+
<td><p></p></td>
|
|
423
|
+
<td><p></p></td>
|
|
424
|
+
</tr>
|
|
425
|
+
<tr class="row-even"><td><p>Number (float)</p></td>
|
|
426
|
+
<td><p>double</p></td>
|
|
427
|
+
<td><p>8</p></td>
|
|
428
|
+
<td><p></p></td>
|
|
429
|
+
<td><p></p></td>
|
|
430
|
+
</tr>
|
|
431
|
+
</tbody>
|
|
432
|
+
</table>
|
|
433
|
+
</div>
|
|
434
|
+
<p>Koffi defines a few more types that can change size depending on the OS and the architecture:</p>
|
|
435
|
+
<div class="table-wrapper colwidths-auto docutils container">
|
|
436
|
+
<table class="docutils align-default">
|
|
437
|
+
<thead>
|
|
438
|
+
<tr class="row-odd"><th class="head"><p>JS type</p></th>
|
|
439
|
+
<th class="head"><p>C type</p></th>
|
|
440
|
+
<th class="head"><p>Signedness</p></th>
|
|
441
|
+
<th class="head"><p>Note</p></th>
|
|
442
|
+
</tr>
|
|
443
|
+
</thead>
|
|
444
|
+
<tbody>
|
|
445
|
+
<tr class="row-even"><td><p>Boolean</p></td>
|
|
446
|
+
<td><p>bool</p></td>
|
|
447
|
+
<td><p></p></td>
|
|
448
|
+
<td><p>Usually one byte</p></td>
|
|
449
|
+
</tr>
|
|
450
|
+
<tr class="row-odd"><td><p>Number (integer)</p></td>
|
|
451
|
+
<td><p>long</p></td>
|
|
452
|
+
<td><p>Signed</p></td>
|
|
453
|
+
<td><p>4 or 8 bytes depending on platform (LP64, LLP64)</p></td>
|
|
454
|
+
</tr>
|
|
455
|
+
<tr class="row-even"><td><p>Number (integer)</p></td>
|
|
456
|
+
<td><p>ulong</p></td>
|
|
457
|
+
<td><p>Unsigned</p></td>
|
|
458
|
+
<td><p>4 or 8 bytes depending on platform (LP64, LLP64)</p></td>
|
|
459
|
+
</tr>
|
|
460
|
+
<tr class="row-odd"><td><p>Number (integer)</p></td>
|
|
461
|
+
<td><p>unsigned long</p></td>
|
|
462
|
+
<td><p>Unsigned</p></td>
|
|
463
|
+
<td><p>4 or 8 bytes depending on platform (LP64, LLP64)</p></td>
|
|
464
|
+
</tr>
|
|
465
|
+
<tr class="row-even"><td><p>String</p></td>
|
|
466
|
+
<td><p>string</p></td>
|
|
467
|
+
<td><p></p></td>
|
|
468
|
+
<td><p>JS strings are converted to and from UTF-8</p></td>
|
|
469
|
+
</tr>
|
|
470
|
+
<tr class="row-odd"><td><p>String</p></td>
|
|
471
|
+
<td><p>string16</p></td>
|
|
472
|
+
<td><p></p></td>
|
|
473
|
+
<td><p>JS strings are converted to and from UTF-16 (LE)</p></td>
|
|
474
|
+
</tr>
|
|
475
|
+
</tbody>
|
|
476
|
+
</table>
|
|
477
|
+
</div>
|
|
478
|
+
<p>Primitive types can be specified by name (in a string) or through <code class="docutils literal notranslate"><span class="pre">koffi.types</span></code>:</p>
|
|
479
|
+
<div class="highlight-js notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span><span class="c1">// These two lines do the same:</span><span class="w"></span>
|
|
480
|
+
<span class="linenos">2</span><span class="kd">let</span><span class="w"> </span><span class="nx">struct1</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="w"> </span><span class="nx">dummy</span><span class="o">:</span><span class="w"> </span><span class="s1">'int'</span><span class="w"> </span><span class="p">});</span><span class="w"></span>
|
|
481
|
+
<span class="linenos">3</span><span class="kd">let</span><span class="w"> </span><span class="nx">struct2</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="w"> </span><span class="nx">dummy</span><span class="o">:</span><span class="w"> </span><span class="nx">koffi</span><span class="p">.</span><span class="nx">types</span><span class="p">.</span><span class="kr">long</span><span class="w"> </span><span class="p">});</span><span class="w"></span>
|
|
482
|
+
</pre></div>
|
|
483
|
+
</div>
|
|
484
|
+
</section>
|
|
485
|
+
<section id="struct-types">
|
|
486
|
+
<h2>Struct types<a class="headerlink" href="#struct-types" title="Permalink to this heading">#</a></h2>
|
|
487
|
+
<p>Koffi converts JS objects to C structs, and vice-versa.</p>
|
|
488
|
+
<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>
|
|
489
|
+
<p>The following example illustrates how to declare the same struct in C and in JS with Koffi:</p>
|
|
490
|
+
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span><span class="k">typedef</span><span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">A</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
491
|
+
<span class="linenos">2</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">a</span><span class="p">;</span><span class="w"></span>
|
|
492
|
+
<span class="linenos">3</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="n">b</span><span class="p">;</span><span class="w"></span>
|
|
493
|
+
<span class="linenos">4</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">c</span><span class="p">;</span><span class="w"></span>
|
|
494
|
+
<span class="linenos">5</span><span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
495
|
+
<span class="linenos">6</span><span class="w"> </span><span class="kt">double</span><span class="w"> </span><span class="n">d1</span><span class="p">;</span><span class="w"></span>
|
|
496
|
+
<span class="linenos">7</span><span class="w"> </span><span class="kt">double</span><span class="w"> </span><span class="n">d2</span><span class="p">;</span><span class="w"></span>
|
|
497
|
+
<span class="linenos">8</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="n">d</span><span class="p">;</span><span class="w"></span>
|
|
498
|
+
<span class="linenos">9</span><span class="p">}</span><span class="w"> </span><span class="n">A</span><span class="p">;</span><span class="w"></span>
|
|
499
|
+
</pre></div>
|
|
500
|
+
</div>
|
|
501
|
+
<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">A</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">'A'</span><span class="p">,</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
502
|
+
<span class="linenos">2</span><span class="w"> </span><span class="nx">a</span><span class="o">:</span><span class="w"> </span><span class="s1">'int'</span><span class="p">,</span><span class="w"></span>
|
|
503
|
+
<span class="linenos">3</span><span class="w"> </span><span class="nx">b</span><span class="o">:</span><span class="w"> </span><span class="s1">'char'</span><span class="p">,</span><span class="w"></span>
|
|
504
|
+
<span class="linenos">4</span><span class="w"> </span><span class="nx">c</span><span class="o">:</span><span class="w"> </span><span class="s1">'string'</span><span class="p">,</span><span class="w"></span>
|
|
505
|
+
<span class="linenos">5</span><span class="w"> </span><span class="nx">d</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="w"></span>
|
|
506
|
+
<span class="linenos">6</span><span class="w"> </span><span class="nx">d1</span><span class="o">:</span><span class="w"> </span><span class="s1">'double'</span><span class="p">,</span><span class="w"></span>
|
|
507
|
+
<span class="linenos">7</span><span class="w"> </span><span class="nx">d2</span><span class="o">:</span><span class="w"> </span><span class="s1">'double'</span><span class="w"></span>
|
|
508
|
+
<span class="linenos">8</span><span class="w"> </span><span class="p">})</span><span class="w"></span>
|
|
509
|
+
<span class="linenos">9</span><span class="p">});</span><span class="w"></span>
|
|
510
|
+
</pre></div>
|
|
511
|
+
</div>
|
|
512
|
+
<p>Koffi follows the C and ABI rules regarding struct alignment and padding.</p>
|
|
513
|
+
<p>Once a struct is declared, you can use it by name (with a string, like you can do for primitive types) or the through the value returned by the call to <code class="docutils literal notranslate"><span class="pre">koffi.struct()</span></code>. Only the latter is possible when declaring an anonymous struct.</p>
|
|
514
|
+
<div class="highlight-js notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span><span class="c1">// The following two function declarations are equivalent, and declare a function taking an A value and returning A</span><span class="w"></span>
|
|
515
|
+
<span class="linenos">2</span><span class="kd">const</span><span class="w"> </span><span class="nx">Function1</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">'A Function(A value)'</span><span class="p">);</span><span class="w"></span>
|
|
516
|
+
<span class="linenos">3</span><span class="kd">const</span><span class="w"> </span><span class="nx">Function2</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">'Function'</span><span class="p">,</span><span class="w"> </span><span class="nx">A</span><span class="p">,</span><span class="w"> </span><span class="p">[</span><span class="nx">A</span><span class="p">]);</span><span class="w"></span>
|
|
517
|
+
</pre></div>
|
|
518
|
+
</div>
|
|
519
|
+
</section>
|
|
520
|
+
<section id="pointer-types">
|
|
521
|
+
<h2>Pointer types<a class="headerlink" href="#pointer-types" title="Permalink to this heading">#</a></h2>
|
|
522
|
+
<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>
|
|
523
|
+
<ul class="simple">
|
|
524
|
+
<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 argument).</p></li>
|
|
525
|
+
<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">sqlite3_stmt</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>
|
|
526
|
+
<li><p><strong>Arrays</strong>: in C, you dynamically-sized arrays are usually passed to functions with pointers, either NULL-terminated or with an additional length argument.</p></li>
|
|
527
|
+
<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>
|
|
528
|
+
</ul>
|
|
529
|
+
<section id="struct-pointers">
|
|
530
|
+
<h3>Struct pointers<a class="headerlink" href="#struct-pointers" title="Permalink to this heading">#</a></h3>
|
|
531
|
+
<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>
|
|
532
|
+
<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>
|
|
533
|
+
<span class="linenos"> 2</span><span class="kd">const</span><span class="w"> </span><span class="nx">lib</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">koffi</span><span class="p">.</span><span class="nx">load</span><span class="p">(</span><span class="s1">'kernel32.dll'</span><span class="p">);</span><span class="w"></span>
|
|
534
|
+
<span class="linenos"> 3</span>
|
|
535
|
+
<span class="linenos"> 4</span><span class="c1">// Type declarations</span><span class="w"></span>
|
|
536
|
+
<span class="linenos"> 5</span><span class="kd">const</span><span class="w"> </span><span class="nx">POINT</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">'POINT'</span><span class="p">,</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
537
|
+
<span class="linenos"> 6</span><span class="w"> </span><span class="nx">x</span><span class="o">:</span><span class="w"> </span><span class="s1">'long'</span><span class="p">,</span><span class="w"></span>
|
|
538
|
+
<span class="linenos"> 7</span><span class="w"> </span><span class="nx">y</span><span class="o">:</span><span class="w"> </span><span class="s1">'long'</span><span class="w"></span>
|
|
539
|
+
<span class="linenos"> 8</span><span class="p">});</span><span class="w"></span>
|
|
540
|
+
<span class="linenos"> 9</span>
|
|
541
|
+
<span class="linenos">10</span><span class="c1">// Functions declarations</span><span class="w"></span>
|
|
542
|
+
<span class="linenos">11</span><span class="kd">const</span><span class="w"> </span><span class="nx">GetCursorPos</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 __stdcall GetCursorPos(_Out_ POINT *pos)'</span><span class="p">);</span><span class="w"></span>
|
|
543
|
+
<span class="linenos">12</span>
|
|
544
|
+
<span class="linenos">13</span><span class="c1">// Get and show cursor position</span><span class="w"></span>
|
|
545
|
+
<span class="linenos">14</span><span class="kd">let</span><span class="w"> </span><span class="nx">pos</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{};</span><span class="w"></span>
|
|
546
|
+
<span class="linenos">15</span><span class="k">if</span><span class="w"> </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="w"></span>
|
|
547
|
+
<span class="linenos">16</span><span class="w"> </span><span class="k">throw</span><span class="w"> </span><span class="ow">new</span><span class="w"> </span><span class="ne">Error</span><span class="p">(</span><span class="s1">'Failed to get cursor position'</span><span class="p">);</span><span class="w"></span>
|
|
548
|
+
<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><span class="w"></span>
|
|
549
|
+
</pre></div>
|
|
550
|
+
</div>
|
|
551
|
+
</section>
|
|
552
|
+
<section id="opaque-handles">
|
|
553
|
+
<h3>Opaque handles<a class="headerlink" href="#opaque-handles" title="Permalink to this heading">#</a></h3>
|
|
554
|
+
<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>
|
|
555
|
+
<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 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 pointer to the handle).</p>
|
|
556
|
+
<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>
|
|
557
|
+
<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>
|
|
558
|
+
<span class="linenos"> 2</span>
|
|
559
|
+
<span class="linenos"> 3</span><span class="cp">#include</span><span class="w"> </span><span class="cpf"><stdlib.h></span><span class="cp"></span>
|
|
560
|
+
<span class="linenos"> 4</span><span class="cp">#include</span><span class="w"> </span><span class="cpf"><stdbool.h></span><span class="cp"></span>
|
|
561
|
+
<span class="linenos"> 5</span><span class="cp">#include</span><span class="w"> </span><span class="cpf"><stdio.h></span><span class="cp"></span>
|
|
562
|
+
<span class="linenos"> 6</span><span class="cp">#include</span><span class="w"> </span><span class="cpf"><errno.h></span><span class="cp"></span>
|
|
563
|
+
<span class="linenos"> 7</span><span class="cp">#include</span><span class="w"> </span><span class="cpf"><string.h></span><span class="cp"></span>
|
|
564
|
+
<span class="linenos"> 8</span>
|
|
565
|
+
<span class="linenos"> 9</span><span class="k">typedef</span><span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">Fragment</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
566
|
+
<span class="linenos"> 10</span><span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">Fragment</span><span class="w"> </span><span class="o">*</span><span class="n">next</span><span class="p">;</span><span class="w"></span>
|
|
567
|
+
<span class="linenos"> 11</span>
|
|
568
|
+
<span class="linenos"> 12</span><span class="w"> </span><span class="kt">size_t</span><span class="w"> </span><span class="n">len</span><span class="p">;</span><span class="w"></span>
|
|
569
|
+
<span class="linenos"> 13</span><span class="w"> </span><span class="kt">char</span><span class="w"> </span><span class="n">str</span><span class="p">[];</span><span class="w"></span>
|
|
570
|
+
<span class="linenos"> 14</span><span class="p">}</span><span class="w"> </span><span class="n">Fragment</span><span class="p">;</span><span class="w"></span>
|
|
571
|
+
<span class="linenos"> 15</span>
|
|
572
|
+
<span class="linenos"> 16</span><span class="k">typedef</span><span class="w"> </span><span class="k">struct</span><span class="w"> </span><span class="nc">Concat</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
573
|
+
<span class="linenos"> 17</span><span class="w"> </span><span class="n">Fragment</span><span class="w"> </span><span class="o">*</span><span class="n">first</span><span class="p">;</span><span class="w"></span>
|
|
574
|
+
<span class="linenos"> 18</span><span class="w"> </span><span class="n">Fragment</span><span class="w"> </span><span class="o">*</span><span class="n">last</span><span class="p">;</span><span class="w"></span>
|
|
575
|
+
<span class="linenos"> 19</span>
|
|
576
|
+
<span class="linenos"> 20</span><span class="w"> </span><span class="kt">size_t</span><span class="w"> </span><span class="n">total</span><span class="p">;</span><span class="w"></span>
|
|
577
|
+
<span class="linenos"> 21</span><span class="p">}</span><span class="w"> </span><span class="n">Concat</span><span class="p">;</span><span class="w"></span>
|
|
578
|
+
<span class="linenos"> 22</span>
|
|
579
|
+
<span class="linenos"> 23</span><span class="kt">bool</span><span class="w"> </span><span class="nf">ConcatNewOut</span><span class="p">(</span><span class="n">Concat</span><span class="w"> </span><span class="o">**</span><span class="n">out</span><span class="p">)</span><span class="w"></span>
|
|
580
|
+
<span class="linenos"> 24</span><span class="p">{</span><span class="w"></span>
|
|
581
|
+
<span class="linenos"> 25</span><span class="w"> </span><span class="n">Concat</span><span class="w"> </span><span class="o">*</span><span class="n">c</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">malloc</span><span class="p">(</span><span class="k">sizeof</span><span class="p">(</span><span class="o">*</span><span class="n">c</span><span class="p">));</span><span class="w"></span>
|
|
582
|
+
<span class="linenos"> 26</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="o">!</span><span class="n">c</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
583
|
+
<span class="linenos"> 27</span><span class="w"> </span><span class="n">fprintf</span><span class="p">(</span><span class="n">stderr</span><span class="p">,</span><span class="w"> </span><span class="s">"Failed to allocate memory: %s</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span><span class="w"> </span><span class="n">strerror</span><span class="p">(</span><span class="n">errno</span><span class="p">));</span><span class="w"></span>
|
|
584
|
+
<span class="linenos"> 28</span><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="nb">false</span><span class="p">;</span><span class="w"></span>
|
|
585
|
+
<span class="linenos"> 29</span><span class="w"> </span><span class="p">}</span><span class="w"></span>
|
|
586
|
+
<span class="linenos"> 30</span>
|
|
587
|
+
<span class="linenos"> 31</span><span class="w"> </span><span class="n">c</span><span class="o">-></span><span class="n">first</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">NULL</span><span class="p">;</span><span class="w"></span>
|
|
588
|
+
<span class="linenos"> 32</span><span class="w"> </span><span class="n">c</span><span class="o">-></span><span class="n">last</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">NULL</span><span class="p">;</span><span class="w"></span>
|
|
589
|
+
<span class="linenos"> 33</span><span class="w"> </span><span class="n">c</span><span class="o">-></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>
|
|
590
|
+
<span class="linenos"> 34</span>
|
|
591
|
+
<span class="linenos"> 35</span><span class="w"> </span><span class="o">*</span><span class="n">out</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">c</span><span class="p">;</span><span class="w"></span>
|
|
592
|
+
<span class="linenos"> 36</span><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="nb">true</span><span class="p">;</span><span class="w"></span>
|
|
593
|
+
<span class="linenos"> 37</span><span class="p">}</span><span class="w"></span>
|
|
594
|
+
<span class="linenos"> 38</span>
|
|
595
|
+
<span class="linenos"> 39</span><span class="n">Concat</span><span class="w"> </span><span class="o">*</span><span class="nf">ConcatNew</span><span class="p">()</span><span class="w"></span>
|
|
596
|
+
<span class="linenos"> 40</span><span class="p">{</span><span class="w"></span>
|
|
597
|
+
<span class="linenos"> 41</span><span class="w"> </span><span class="n">Concat</span><span class="w"> </span><span class="o">*</span><span class="n">c</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">NULL</span><span class="p">;</span><span class="w"></span>
|
|
598
|
+
<span class="linenos"> 42</span><span class="w"> </span><span class="n">ConcatNewOut</span><span class="p">(</span><span class="o">&</span><span class="n">c</span><span class="p">);</span><span class="w"></span>
|
|
599
|
+
<span class="linenos"> 43</span><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">c</span><span class="p">;</span><span class="w"></span>
|
|
600
|
+
<span class="linenos"> 44</span><span class="p">}</span><span class="w"></span>
|
|
601
|
+
<span class="linenos"> 45</span>
|
|
602
|
+
<span class="linenos"> 46</span><span class="kt">void</span><span class="w"> </span><span class="nf">ConcatFree</span><span class="p">(</span><span class="n">Concat</span><span class="w"> </span><span class="o">*</span><span class="n">c</span><span class="p">)</span><span class="w"></span>
|
|
603
|
+
<span class="linenos"> 47</span><span class="p">{</span><span class="w"></span>
|
|
604
|
+
<span class="linenos"> 48</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="o">!</span><span class="n">c</span><span class="p">)</span><span class="w"></span>
|
|
605
|
+
<span class="linenos"> 49</span><span class="w"> </span><span class="k">return</span><span class="p">;</span><span class="w"></span>
|
|
606
|
+
<span class="linenos"> 50</span>
|
|
607
|
+
<span class="linenos"> 51</span><span class="w"> </span><span class="n">Fragment</span><span class="w"> </span><span class="o">*</span><span class="n">f</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">c</span><span class="o">-></span><span class="n">first</span><span class="p">;</span><span class="w"></span>
|
|
608
|
+
<span class="linenos"> 52</span>
|
|
609
|
+
<span class="linenos"> 53</span><span class="w"> </span><span class="k">while</span><span class="w"> </span><span class="p">(</span><span class="n">f</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
610
|
+
<span class="linenos"> 54</span><span class="w"> </span><span class="n">Fragment</span><span class="w"> </span><span class="o">*</span><span class="n">next</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">f</span><span class="o">-></span><span class="n">next</span><span class="p">;</span><span class="w"></span>
|
|
611
|
+
<span class="linenos"> 55</span><span class="w"> </span><span class="n">free</span><span class="p">(</span><span class="n">f</span><span class="p">);</span><span class="w"></span>
|
|
612
|
+
<span class="linenos"> 56</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">next</span><span class="p">;</span><span class="w"></span>
|
|
613
|
+
<span class="linenos"> 57</span><span class="w"> </span><span class="p">}</span><span class="w"></span>
|
|
614
|
+
<span class="linenos"> 58</span>
|
|
615
|
+
<span class="linenos"> 59</span><span class="w"> </span><span class="n">free</span><span class="p">(</span><span class="n">c</span><span class="p">);</span><span class="w"></span>
|
|
616
|
+
<span class="linenos"> 60</span><span class="p">}</span><span class="w"></span>
|
|
617
|
+
<span class="linenos"> 61</span>
|
|
618
|
+
<span class="linenos"> 62</span><span class="kt">bool</span><span class="w"> </span><span class="nf">ConcatAppend</span><span class="p">(</span><span class="n">Concat</span><span class="w"> </span><span class="o">*</span><span class="n">c</span><span class="p">,</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">frag</span><span class="p">)</span><span class="w"></span>
|
|
619
|
+
<span class="linenos"> 63</span><span class="p">{</span><span class="w"></span>
|
|
620
|
+
<span class="linenos"> 64</span><span class="w"> </span><span class="kt">size_t</span><span class="w"> </span><span class="n">len</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">frag</span><span class="p">);</span><span class="w"></span>
|
|
621
|
+
<span class="linenos"> 65</span>
|
|
622
|
+
<span class="linenos"> 66</span><span class="w"> </span><span class="n">Fragment</span><span class="w"> </span><span class="o">*</span><span class="n">f</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">malloc</span><span class="p">(</span><span class="k">sizeof</span><span class="p">(</span><span class="o">*</span><span class="n">f</span><span class="p">)</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">len</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="mi">1</span><span class="p">);</span><span class="w"></span>
|
|
623
|
+
<span class="linenos"> 67</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="o">!</span><span class="n">f</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
624
|
+
<span class="linenos"> 68</span><span class="w"> </span><span class="n">fprintf</span><span class="p">(</span><span class="n">stderr</span><span class="p">,</span><span class="w"> </span><span class="s">"Failed to allocate memory: %s</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span><span class="w"> </span><span class="n">strerror</span><span class="p">(</span><span class="n">errno</span><span class="p">));</span><span class="w"></span>
|
|
625
|
+
<span class="linenos"> 69</span><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="nb">false</span><span class="p">;</span><span class="w"></span>
|
|
626
|
+
<span class="linenos"> 70</span><span class="w"> </span><span class="p">}</span><span class="w"></span>
|
|
627
|
+
<span class="linenos"> 71</span>
|
|
628
|
+
<span class="linenos"> 72</span><span class="w"> </span><span class="n">f</span><span class="o">-></span><span class="n">next</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">NULL</span><span class="p">;</span><span class="w"></span>
|
|
629
|
+
<span class="linenos"> 73</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="n">c</span><span class="o">-></span><span class="n">last</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
630
|
+
<span class="linenos"> 74</span><span class="w"> </span><span class="n">c</span><span class="o">-></span><span class="n">last</span><span class="o">-></span><span class="n">next</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">f</span><span class="p">;</span><span class="w"></span>
|
|
631
|
+
<span class="linenos"> 75</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
632
|
+
<span class="linenos"> 76</span><span class="w"> </span><span class="n">c</span><span class="o">-></span><span class="n">first</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">f</span><span class="p">;</span><span class="w"></span>
|
|
633
|
+
<span class="linenos"> 77</span><span class="w"> </span><span class="p">}</span><span class="w"></span>
|
|
634
|
+
<span class="linenos"> 78</span><span class="w"> </span><span class="n">c</span><span class="o">-></span><span class="n">last</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">f</span><span class="p">;</span><span class="w"></span>
|
|
635
|
+
<span class="linenos"> 79</span><span class="w"> </span><span class="n">c</span><span class="o">-></span><span class="n">total</span><span class="w"> </span><span class="o">+=</span><span class="w"> </span><span class="n">len</span><span class="p">;</span><span class="w"></span>
|
|
636
|
+
<span class="linenos"> 80</span>
|
|
637
|
+
<span class="linenos"> 81</span><span class="w"> </span><span class="n">f</span><span class="o">-></span><span class="n">len</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">len</span><span class="p">;</span><span class="w"></span>
|
|
638
|
+
<span class="linenos"> 82</span><span class="w"> </span><span class="n">memcpy</span><span class="p">(</span><span class="n">f</span><span class="o">-></span><span class="n">str</span><span class="p">,</span><span class="w"> </span><span class="n">frag</span><span class="p">,</span><span class="w"> </span><span class="n">len</span><span class="p">);</span><span class="w"></span>
|
|
639
|
+
<span class="linenos"> 83</span><span class="w"> </span><span class="n">f</span><span class="o">-></span><span class="n">str</span><span class="p">[</span><span class="n">len</span><span class="p">]</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>
|
|
640
|
+
<span class="linenos"> 84</span>
|
|
641
|
+
<span class="linenos"> 85</span><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="nb">true</span><span class="p">;</span><span class="w"></span>
|
|
642
|
+
<span class="linenos"> 86</span><span class="p">}</span><span class="w"></span>
|
|
643
|
+
<span class="linenos"> 87</span>
|
|
644
|
+
<span class="linenos"> 88</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="nf">ConcatBuild</span><span class="p">(</span><span class="n">Concat</span><span class="w"> </span><span class="o">*</span><span class="n">c</span><span class="p">)</span><span class="w"></span>
|
|
645
|
+
<span class="linenos"> 89</span><span class="p">{</span><span class="w"></span>
|
|
646
|
+
<span class="linenos"> 90</span><span class="w"> </span><span class="n">Fragment</span><span class="w"> </span><span class="o">*</span><span class="n">r</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">malloc</span><span class="p">(</span><span class="k">sizeof</span><span class="p">(</span><span class="o">*</span><span class="n">r</span><span class="p">)</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">c</span><span class="o">-></span><span class="n">total</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="mi">1</span><span class="p">);</span><span class="w"></span>
|
|
647
|
+
<span class="linenos"> 91</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="o">!</span><span class="n">r</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
648
|
+
<span class="linenos"> 92</span><span class="w"> </span><span class="n">fprintf</span><span class="p">(</span><span class="n">stderr</span><span class="p">,</span><span class="w"> </span><span class="s">"Failed to allocate memory: %s</span><span class="se">\n</span><span class="s">"</span><span class="p">,</span><span class="w"> </span><span class="n">strerror</span><span class="p">(</span><span class="n">errno</span><span class="p">));</span><span class="w"></span>
|
|
649
|
+
<span class="linenos"> 93</span><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="nb">NULL</span><span class="p">;</span><span class="w"></span>
|
|
650
|
+
<span class="linenos"> 94</span><span class="w"> </span><span class="p">}</span><span class="w"></span>
|
|
651
|
+
<span class="linenos"> 95</span>
|
|
652
|
+
<span class="linenos"> 96</span><span class="w"> </span><span class="n">r</span><span class="o">-></span><span class="n">next</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">NULL</span><span class="p">;</span><span class="w"></span>
|
|
653
|
+
<span class="linenos"> 97</span><span class="w"> </span><span class="n">r</span><span class="o">-></span><span class="n">len</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>
|
|
654
|
+
<span class="linenos"> 98</span>
|
|
655
|
+
<span class="linenos"> 99</span><span class="w"> </span><span class="n">Fragment</span><span class="w"> </span><span class="o">*</span><span class="n">f</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">c</span><span class="o">-></span><span class="n">first</span><span class="p">;</span><span class="w"></span>
|
|
656
|
+
<span class="linenos">100</span>
|
|
657
|
+
<span class="linenos">101</span><span class="w"> </span><span class="k">while</span><span class="w"> </span><span class="p">(</span><span class="n">f</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
658
|
+
<span class="linenos">102</span><span class="w"> </span><span class="n">Fragment</span><span class="w"> </span><span class="o">*</span><span class="n">next</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">f</span><span class="o">-></span><span class="n">next</span><span class="p">;</span><span class="w"></span>
|
|
659
|
+
<span class="linenos">103</span>
|
|
660
|
+
<span class="linenos">104</span><span class="w"> </span><span class="n">memcpy</span><span class="p">(</span><span class="n">r</span><span class="o">-></span><span class="n">str</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">r</span><span class="o">-></span><span class="n">len</span><span class="p">,</span><span class="w"> </span><span class="n">f</span><span class="o">-></span><span class="n">str</span><span class="p">,</span><span class="w"> </span><span class="n">f</span><span class="o">-></span><span class="n">len</span><span class="p">);</span><span class="w"></span>
|
|
661
|
+
<span class="linenos">105</span><span class="w"> </span><span class="n">r</span><span class="o">-></span><span class="n">len</span><span class="w"> </span><span class="o">+=</span><span class="w"> </span><span class="n">f</span><span class="o">-></span><span class="n">len</span><span class="p">;</span><span class="w"></span>
|
|
662
|
+
<span class="linenos">106</span>
|
|
663
|
+
<span class="linenos">107</span><span class="w"> </span><span class="n">free</span><span class="p">(</span><span class="n">f</span><span class="p">);</span><span class="w"></span>
|
|
664
|
+
<span class="linenos">108</span><span class="w"> </span><span class="n">f</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">next</span><span class="p">;</span><span class="w"></span>
|
|
665
|
+
<span class="linenos">109</span><span class="w"> </span><span class="p">}</span><span class="w"></span>
|
|
666
|
+
<span class="linenos">110</span><span class="w"> </span><span class="n">r</span><span class="o">-></span><span class="n">str</span><span class="p">[</span><span class="n">r</span><span class="o">-></span><span class="n">len</span><span class="p">]</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>
|
|
667
|
+
<span class="linenos">111</span>
|
|
668
|
+
<span class="linenos">112</span><span class="w"> </span><span class="n">c</span><span class="o">-></span><span class="n">first</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">r</span><span class="p">;</span><span class="w"></span>
|
|
669
|
+
<span class="linenos">113</span><span class="w"> </span><span class="n">c</span><span class="o">-></span><span class="n">last</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">r</span><span class="p">;</span><span class="w"></span>
|
|
670
|
+
<span class="linenos">114</span>
|
|
671
|
+
<span class="linenos">115</span><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">r</span><span class="o">-></span><span class="n">str</span><span class="p">;</span><span class="w"></span>
|
|
672
|
+
<span class="linenos">116</span><span class="p">}</span><span class="w"></span>
|
|
673
|
+
</pre></div>
|
|
674
|
+
</div>
|
|
675
|
+
<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>
|
|
676
|
+
<span class="linenos"> 2</span><span class="kd">const</span><span class="w"> </span><span class="nx">lib</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">koffi</span><span class="p">.</span><span class="nx">load</span><span class="p">(</span><span class="s1">'./handles.so'</span><span class="p">);</span><span class="w"></span>
|
|
677
|
+
<span class="linenos"> 3</span>
|
|
678
|
+
<span class="linenos"> 4</span><span class="kd">const</span><span class="w"> </span><span class="nx">Concat</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">koffi</span><span class="p">.</span><span class="nx">handle</span><span class="p">(</span><span class="s1">'Concat'</span><span class="p">);</span><span class="w"></span>
|
|
679
|
+
<span class="linenos"> 5</span><span class="kd">const</span><span class="w"> </span><span class="nx">ConcatNewOut</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">'bool ConcatNewOut(Concat *out)'</span><span class="p">);</span><span class="w"></span>
|
|
680
|
+
<span class="linenos"> 6</span><span class="kd">const</span><span class="w"> </span><span class="nx">ConcatNew</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">'Concat ConcatNew()'</span><span class="p">);</span><span class="w"></span>
|
|
681
|
+
<span class="linenos"> 7</span><span class="kd">const</span><span class="w"> </span><span class="nx">ConcatFree</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">'void ConcatFree(Concat c)'</span><span class="p">);</span><span class="w"></span>
|
|
682
|
+
<span class="linenos"> 8</span><span class="kd">const</span><span class="w"> </span><span class="nx">ConcatAppend</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">'bool ConcatAppend(Concat c, const char *frag)'</span><span class="p">);</span><span class="w"></span>
|
|
683
|
+
<span class="linenos"> 9</span><span class="kd">const</span><span class="w"> </span><span class="nx">ConcatBuild</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">'const char *ConcatBuild(Concat c)'</span><span class="p">);</span><span class="w"></span>
|
|
684
|
+
<span class="linenos">10</span>
|
|
685
|
+
<span class="linenos">11</span><span class="kd">let</span><span class="w"> </span><span class="nx">c</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">ConcatNew</span><span class="p">();</span><span class="w"></span>
|
|
686
|
+
<span class="linenos">12</span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="o">!</span><span class="nx">c</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
687
|
+
<span class="linenos">13</span><span class="w"> </span><span class="c1">// This is stupid, it does the same, but try both versions (return value, output parameter)</span><span class="w"></span>
|
|
688
|
+
<span class="linenos">14</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="o">!</span><span class="nx">ConcatNewOut</span><span class="p">(</span><span class="nx">c</span><span class="p">))</span><span class="w"></span>
|
|
689
|
+
<span class="linenos">15</span><span class="w"> </span><span class="k">throw</span><span class="w"> </span><span class="ow">new</span><span class="w"> </span><span class="ne">Error</span><span class="p">(</span><span class="s1">'Allocation failure'</span><span class="p">);</span><span class="w"></span>
|
|
690
|
+
<span class="linenos">16</span><span class="p">}</span><span class="w"></span>
|
|
691
|
+
<span class="linenos">17</span>
|
|
692
|
+
<span class="linenos">18</span><span class="k">try</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
693
|
+
<span class="linenos">19</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="o">!</span><span class="nx">ConcatAppend</span><span class="p">(</span><span class="nx">c</span><span class="p">,</span><span class="w"> </span><span class="s1">'Hello... '</span><span class="p">))</span><span class="w"></span>
|
|
694
|
+
<span class="linenos">20</span><span class="w"> </span><span class="k">throw</span><span class="w"> </span><span class="ow">new</span><span class="w"> </span><span class="ne">Error</span><span class="p">(</span><span class="s1">'Allocation failure'</span><span class="p">);</span><span class="w"></span>
|
|
695
|
+
<span class="linenos">21</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="o">!</span><span class="nx">ConcatAppend</span><span class="p">(</span><span class="nx">c</span><span class="p">,</span><span class="w"> </span><span class="s1">'World!\n'</span><span class="p">))</span><span class="w"></span>
|
|
696
|
+
<span class="linenos">22</span><span class="w"> </span><span class="k">throw</span><span class="w"> </span><span class="ow">new</span><span class="w"> </span><span class="ne">Error</span><span class="p">(</span><span class="s1">'Allocation failure'</span><span class="p">);</span><span class="w"></span>
|
|
697
|
+
<span class="linenos">23</span>
|
|
698
|
+
<span class="linenos">24</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="p">(</span><span class="kd">let</span><span class="w"> </span><span class="nx">i</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mf">1</span><span class="p">;</span><span class="w"> </span><span class="nx">i</span><span class="w"> </span><span class="o"><=</span><span class="w"> </span><span class="mf">30</span><span class="p">;</span><span class="w"> </span><span class="nx">i</span><span class="o">++</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
699
|
+
<span class="linenos">25</span><span class="w"> </span><span class="kd">let</span><span class="w"> </span><span class="nx">frag</span><span class="p">;</span><span class="w"></span>
|
|
700
|
+
<span class="linenos">26</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">i</span><span class="w"> </span><span class="o">%</span><span class="w"> </span><span class="mf">15</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="mf">0</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
701
|
+
<span class="linenos">27</span><span class="w"> </span><span class="nx">frag</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'FizzBuzz'</span><span class="p">;</span><span class="w"></span>
|
|
702
|
+
<span class="linenos">28</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">i</span><span class="w"> </span><span class="o">%</span><span class="w"> </span><span class="mf">5</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="mf">0</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
703
|
+
<span class="linenos">29</span><span class="w"> </span><span class="nx">frag</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'Buzz'</span><span class="p">;</span><span class="w"></span>
|
|
704
|
+
<span class="linenos">30</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">i</span><span class="w"> </span><span class="o">%</span><span class="w"> </span><span class="mf">3</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="mf">0</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
705
|
+
<span class="linenos">31</span><span class="w"> </span><span class="nx">frag</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s1">'Fizz'</span><span class="p">;</span><span class="w"></span>
|
|
706
|
+
<span class="linenos">32</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">else</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
707
|
+
<span class="linenos">33</span><span class="w"> </span><span class="nx">frag</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nb">String</span><span class="p">(</span><span class="nx">i</span><span class="p">);</span><span class="w"></span>
|
|
708
|
+
<span class="linenos">34</span><span class="w"> </span><span class="p">}</span><span class="w"></span>
|
|
709
|
+
<span class="linenos">35</span>
|
|
710
|
+
<span class="linenos">36</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="o">!</span><span class="nx">ConcatAppend</span><span class="p">(</span><span class="nx">c</span><span class="p">,</span><span class="w"> </span><span class="nx">frag</span><span class="p">))</span><span class="w"></span>
|
|
711
|
+
<span class="linenos">37</span><span class="w"> </span><span class="k">throw</span><span class="w"> </span><span class="ow">new</span><span class="w"> </span><span class="ne">Error</span><span class="p">(</span><span class="s1">'Allocation failure'</span><span class="p">);</span><span class="w"></span>
|
|
712
|
+
<span class="linenos">38</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="o">!</span><span class="nx">ConcatAppend</span><span class="p">(</span><span class="nx">c</span><span class="p">,</span><span class="w"> </span><span class="s1">' '</span><span class="p">))</span><span class="w"></span>
|
|
713
|
+
<span class="linenos">39</span><span class="w"> </span><span class="k">throw</span><span class="w"> </span><span class="ow">new</span><span class="w"> </span><span class="ne">Error</span><span class="p">(</span><span class="s1">'Allocation failure'</span><span class="p">);</span><span class="w"></span>
|
|
714
|
+
<span class="linenos">40</span><span class="w"> </span><span class="p">}</span><span class="w"></span>
|
|
715
|
+
<span class="linenos">41</span>
|
|
716
|
+
<span class="linenos">42</span><span class="w"> </span><span class="kd">let</span><span class="w"> </span><span class="nx">str</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">ConcatBuild</span><span class="p">(</span><span class="nx">c</span><span class="p">);</span><span class="w"></span>
|
|
717
|
+
<span class="linenos">43</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">str</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="kc">null</span><span class="p">)</span><span class="w"></span>
|
|
718
|
+
<span class="linenos">44</span><span class="w"> </span><span class="k">throw</span><span class="w"> </span><span class="ow">new</span><span class="w"> </span><span class="ne">Error</span><span class="p">(</span><span class="s1">'Allocation failure'</span><span class="p">);</span><span class="w"></span>
|
|
719
|
+
<span class="linenos">45</span><span class="w"> </span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">str</span><span class="p">);</span><span class="w"></span>
|
|
720
|
+
<span class="linenos">46</span><span class="p">}</span><span class="w"> </span><span class="k">finally</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
721
|
+
<span class="linenos">47</span><span class="w"> </span><span class="nx">ConcatFree</span><span class="p">(</span><span class="nx">c</span><span class="p">);</span><span class="w"></span>
|
|
722
|
+
<span class="linenos">48</span><span class="p">}</span><span class="w"></span>
|
|
723
|
+
</pre></div>
|
|
724
|
+
</div>
|
|
725
|
+
</section>
|
|
726
|
+
<section id="array-pointers">
|
|
727
|
+
<h3>Array pointers<a class="headerlink" href="#array-pointers" title="Permalink to this heading">#</a></h3>
|
|
728
|
+
<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>
|
|
729
|
+
<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>
|
|
730
|
+
<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>
|
|
731
|
+
<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>
|
|
732
|
+
<span class="linenos"> 2</span>
|
|
733
|
+
<span class="linenos"> 3</span><span class="cp">#include</span><span class="w"> </span><span class="cpf"><stdlib.h></span><span class="cp"></span>
|
|
734
|
+
<span class="linenos"> 4</span><span class="cp">#include</span><span class="w"> </span><span class="cpf"><stdint.h></span><span class="cp"></span>
|
|
735
|
+
<span class="linenos"> 5</span><span class="cp">#include</span><span class="w"> </span><span class="cpf"><string.h></span><span class="cp"></span>
|
|
736
|
+
<span class="linenos"> 6</span>
|
|
737
|
+
<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>
|
|
738
|
+
<span class="linenos"> 8</span><span class="p">{</span><span class="w"></span>
|
|
739
|
+
<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>
|
|
740
|
+
<span class="linenos">10</span>
|
|
741
|
+
<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>
|
|
742
|
+
<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>
|
|
743
|
+
<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>
|
|
744
|
+
<span class="linenos">14</span><span class="w"> </span><span class="p">}</span><span class="w"></span>
|
|
745
|
+
<span class="linenos">15</span>
|
|
746
|
+
<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>
|
|
747
|
+
<span class="linenos">17</span><span class="p">}</span><span class="w"></span>
|
|
748
|
+
</pre></div>
|
|
749
|
+
</div>
|
|
750
|
+
<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>
|
|
751
|
+
<span class="linenos">2</span><span class="kd">const</span><span class="w"> </span><span class="nx">lib</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">koffi</span><span class="p">.</span><span class="nx">load</span><span class="p">(</span><span class="s1">'./length.so'</span><span class="p">);</span><span class="w"></span>
|
|
752
|
+
<span class="linenos">3</span>
|
|
753
|
+
<span class="linenos">4</span><span class="kd">const</span><span class="w"> </span><span class="nx">ComputeTotalLength</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">'int64_t ComputeTotalLength(const char **strings)'</span><span class="p">);</span><span class="w"></span>
|
|
754
|
+
<span class="linenos">5</span>
|
|
755
|
+
<span class="linenos">6</span><span class="kd">let</span><span class="w"> </span><span class="nx">strings</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span><span class="s1">'Get'</span><span class="p">,</span><span class="w"> </span><span class="s1">'Total'</span><span class="p">,</span><span class="w"> </span><span class="s1">'Length'</span><span class="p">,</span><span class="w"> </span><span class="kc">null</span><span class="p">];</span><span class="w"></span>
|
|
756
|
+
<span class="linenos">7</span><span class="kd">let</span><span class="w"> </span><span class="nx">total</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">ComputeTotalLength</span><span class="p">(</span><span class="nx">strings</span><span class="p">);</span><span class="w"></span>
|
|
757
|
+
<span class="linenos">8</span>
|
|
758
|
+
<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="w"> </span><span class="c1">// Prints 14n (big int)</span><span class="w"></span>
|
|
759
|
+
</pre></div>
|
|
760
|
+
</div>
|
|
761
|
+
<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>
|
|
762
|
+
<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>
|
|
763
|
+
<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>
|
|
764
|
+
<span class="linenos"> 2</span><span class="kd">const</span><span class="w"> </span><span class="nx">lib</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">koffi</span><span class="p">.</span><span class="nx">load</span><span class="p">(</span><span class="s1">'kernel32.dll'</span><span class="p">);</span><span class="w"></span>
|
|
765
|
+
<span class="linenos"> 3</span>
|
|
766
|
+
<span class="linenos"> 4</span><span class="kd">const</span><span class="w"> </span><span class="nx">HANDLE</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">koffi</span><span class="p">.</span><span class="nx">handle</span><span class="p">(</span><span class="s1">'HANDLE'</span><span class="p">);</span><span class="w"></span>
|
|
767
|
+
<span class="linenos"> 5</span><span class="kd">const</span><span class="w"> </span><span class="nx">FILETIME</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">'FILETIME'</span><span class="p">,</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
768
|
+
<span class="linenos"> 6</span><span class="w"> </span><span class="nx">dwLowDateTime</span><span class="o">:</span><span class="w"> </span><span class="s1">'uint'</span><span class="p">,</span><span class="w"></span>
|
|
769
|
+
<span class="linenos"> 7</span><span class="w"> </span><span class="nx">dwHighDateTime</span><span class="o">:</span><span class="w"> </span><span class="s1">'uint'</span><span class="w"></span>
|
|
770
|
+
<span class="linenos"> 8</span><span class="p">});</span><span class="w"></span>
|
|
771
|
+
<span class="linenos"> 9</span><span class="kd">const</span><span class="w"> </span><span class="nx">WIN32_FIND_DATA</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">'WIN32_FIND_DATA'</span><span class="p">,</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
772
|
+
<span class="linenos">10</span><span class="w"> </span><span class="nx">dwFileAttributes</span><span class="o">:</span><span class="w"> </span><span class="s1">'uint'</span><span class="p">,</span><span class="w"></span>
|
|
773
|
+
<span class="linenos">11</span><span class="w"> </span><span class="nx">ftCreationTime</span><span class="o">:</span><span class="w"> </span><span class="nx">FILETIME</span><span class="p">,</span><span class="w"></span>
|
|
774
|
+
<span class="linenos">12</span><span class="w"> </span><span class="nx">ftLastAccessTime</span><span class="o">:</span><span class="w"> </span><span class="nx">FILETIME</span><span class="p">,</span><span class="w"></span>
|
|
775
|
+
<span class="linenos">13</span><span class="w"> </span><span class="nx">ftLastWriteTime</span><span class="o">:</span><span class="w"> </span><span class="nx">FILETIME</span><span class="p">,</span><span class="w"></span>
|
|
776
|
+
<span class="linenos">14</span><span class="w"> </span><span class="nx">nFileSizeHigh</span><span class="o">:</span><span class="w"> </span><span class="s1">'uint'</span><span class="p">,</span><span class="w"></span>
|
|
777
|
+
<span class="linenos">15</span><span class="w"> </span><span class="nx">nFileSizeLow</span><span class="o">:</span><span class="w"> </span><span class="s1">'uint'</span><span class="p">,</span><span class="w"></span>
|
|
778
|
+
<span class="linenos">16</span><span class="w"> </span><span class="nx">dwReserved0</span><span class="o">:</span><span class="w"> </span><span class="s1">'uint'</span><span class="p">,</span><span class="w"></span>
|
|
779
|
+
<span class="linenos">17</span><span class="w"> </span><span class="nx">dwReserved1</span><span class="o">:</span><span class="w"> </span><span class="s1">'uint'</span><span class="p">,</span><span class="w"></span>
|
|
780
|
+
<span class="linenos">18</span><span class="w"> </span><span class="nx">cFileName</span><span class="o">:</span><span class="w"> </span><span class="nx">koffi</span><span class="p">.</span><span class="nx">array</span><span class="p">(</span><span class="s1">'char16'</span><span class="p">,</span><span class="w"> </span><span class="mf">260</span><span class="p">),</span><span class="w"></span>
|
|
781
|
+
<span class="linenos">19</span><span class="w"> </span><span class="nx">cAlternateFileName</span><span class="o">:</span><span class="w"> </span><span class="nx">koffi</span><span class="p">.</span><span class="nx">array</span><span class="p">(</span><span class="s1">'char16'</span><span class="p">,</span><span class="w"> </span><span class="mf">14</span><span class="p">),</span><span class="w"></span>
|
|
782
|
+
<span class="linenos">20</span><span class="w"> </span><span class="nx">dwFileType</span><span class="o">:</span><span class="w"> </span><span class="s1">'uint'</span><span class="p">,</span><span class="w"> </span><span class="c1">// Obsolete. Do not use.</span><span class="w"></span>
|
|
783
|
+
<span class="linenos">21</span><span class="w"> </span><span class="nx">dwCreatorType</span><span class="o">:</span><span class="w"> </span><span class="s1">'uint'</span><span class="p">,</span><span class="w"> </span><span class="c1">// Obsolete. Do not use</span><span class="w"></span>
|
|
784
|
+
<span class="linenos">22</span><span class="w"> </span><span class="nx">wFinderFlags</span><span class="o">:</span><span class="w"> </span><span class="s1">'ushort'</span><span class="w"> </span><span class="c1">// Obsolete. Do not use</span><span class="w"></span>
|
|
785
|
+
<span class="linenos">23</span><span class="p">});</span><span class="w"></span>
|
|
786
|
+
<span class="linenos">24</span>
|
|
787
|
+
<span class="linenos">25</span><span class="kd">const</span><span class="w"> </span><span class="nx">FindFirstFile</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">'HANDLE __stdcall FindFirstFileW(string16 path, _Out_ WIN32_FIND_DATA *data)'</span><span class="p">);</span><span class="w"></span>
|
|
788
|
+
<span class="linenos">26</span><span class="kd">const</span><span class="w"> </span><span class="nx">FindNextFile</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">'bool __stdcall FindNextFileW(HANDLE h, _Out_ WIN32_FIND_DATA *data)'</span><span class="p">);</span><span class="w"></span>
|
|
789
|
+
<span class="linenos">27</span><span class="kd">const</span><span class="w"> </span><span class="nx">FindClose</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">'bool __stdcall FindClose(HANDLE h)'</span><span class="p">);</span><span class="w"></span>
|
|
790
|
+
<span class="linenos">28</span><span class="kd">const</span><span class="w"> </span><span class="nx">GetLastError</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">'uint GetLastError()'</span><span class="p">);</span><span class="w"></span>
|
|
791
|
+
<span class="linenos">29</span>
|
|
792
|
+
<span class="linenos">30</span><span class="kd">function</span><span class="w"> </span><span class="nx">list</span><span class="p">(</span><span class="nx">dirname</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
793
|
+
<span class="linenos">31</span><span class="w"> </span><span class="kd">let</span><span class="w"> </span><span class="nx">filenames</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[];</span><span class="w"></span>
|
|
794
|
+
<span class="linenos">32</span>
|
|
795
|
+
<span class="linenos">33</span><span class="w"> </span><span class="kd">let</span><span class="w"> </span><span class="nx">data</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">{};</span><span class="w"></span>
|
|
796
|
+
<span class="linenos">34</span><span class="w"> </span><span class="kd">let</span><span class="w"> </span><span class="nx">h</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">FindFirstFile</span><span class="p">(</span><span class="nx">dirname</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="s1">'\\*'</span><span class="p">,</span><span class="w"> </span><span class="nx">data</span><span class="p">);</span><span class="w"></span>
|
|
797
|
+
<span class="linenos">35</span>
|
|
798
|
+
<span class="linenos">36</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="o">!</span><span class="nx">h</span><span class="p">)</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
799
|
+
<span class="linenos">37</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">GetLastError</span><span class="p">()</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="mf">2</span><span class="p">)</span><span class="w"> </span><span class="c1">// ERROR_FILE_NOT_FOUND</span><span class="w"></span>
|
|
800
|
+
<span class="linenos">38</span><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="nx">filenames</span><span class="p">;</span><span class="w"></span>
|
|
801
|
+
<span class="linenos">39</span><span class="w"> </span><span class="k">throw</span><span class="w"> </span><span class="ow">new</span><span class="w"> </span><span class="ne">Error</span><span class="p">(</span><span class="s1">'FindFirstFile() failed'</span><span class="p">);</span><span class="w"></span>
|
|
802
|
+
<span class="linenos">40</span><span class="w"> </span><span class="p">}</span><span class="w"></span>
|
|
803
|
+
<span class="linenos">41</span>
|
|
804
|
+
<span class="linenos">42</span><span class="w"> </span><span class="k">try</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
805
|
+
<span class="linenos">43</span><span class="w"> </span><span class="k">do</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
806
|
+
<span class="linenos">44</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">data</span><span class="p">.</span><span class="nx">cFileName</span><span class="w"> </span><span class="o">!=</span><span class="w"> </span><span class="s1">'.'</span><span class="w"> </span><span class="o">&&</span><span class="w"> </span><span class="nx">data</span><span class="p">.</span><span class="nx">cFileName</span><span class="w"> </span><span class="o">!=</span><span class="w"> </span><span class="s1">'..'</span><span class="p">)</span><span class="w"></span>
|
|
807
|
+
<span class="linenos">45</span><span class="w"> </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="w"></span>
|
|
808
|
+
<span class="linenos">46</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">while</span><span class="w"> </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="w"> </span><span class="nx">data</span><span class="p">));</span><span class="w"></span>
|
|
809
|
+
<span class="linenos">47</span>
|
|
810
|
+
<span class="linenos">48</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="nx">GetLastError</span><span class="p">()</span><span class="w"> </span><span class="o">!=</span><span class="w"> </span><span class="mf">18</span><span class="p">)</span><span class="w"> </span><span class="c1">// ERROR_NO_MORE_FILES</span><span class="w"></span>
|
|
811
|
+
<span class="linenos">49</span><span class="w"> </span><span class="k">throw</span><span class="w"> </span><span class="ow">new</span><span class="w"> </span><span class="ne">Error</span><span class="p">(</span><span class="s1">'FindNextFile() failed'</span><span class="p">);</span><span class="w"></span>
|
|
812
|
+
<span class="linenos">50</span><span class="w"> </span><span class="p">}</span><span class="w"> </span><span class="k">finally</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
813
|
+
<span class="linenos">51</span><span class="w"> </span><span class="nx">FindClose</span><span class="p">(</span><span class="nx">h</span><span class="p">);</span><span class="w"></span>
|
|
814
|
+
<span class="linenos">52</span><span class="w"> </span><span class="p">}</span><span class="w"></span>
|
|
815
|
+
<span class="linenos">53</span>
|
|
816
|
+
<span class="linenos">54</span><span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="nx">filenames</span><span class="p">;</span><span class="w"></span>
|
|
817
|
+
<span class="linenos">55</span><span class="p">}</span><span class="w"></span>
|
|
818
|
+
<span class="linenos">56</span>
|
|
819
|
+
<span class="linenos">57</span><span class="kd">let</span><span class="w"> </span><span class="nx">filenames</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">list</span><span class="p">(</span><span class="s1">'.'</span><span class="p">);</span><span class="w"></span>
|
|
820
|
+
<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="w"></span>
|
|
821
|
+
</pre></div>
|
|
822
|
+
</div>
|
|
823
|
+
</section>
|
|
824
|
+
<section id="pointers-to-primitive-types">
|
|
825
|
+
<h3>Pointers to primitive types<a class="headerlink" href="#pointers-to-primitive-types" title="Permalink to this heading">#</a></h3>
|
|
826
|
+
<p>In javascript, it is not possible to pass a primitive value by reference to another function. This means that you cannot call a function and expect it to modify the value of one of its number or string parameter.</p>
|
|
827
|
+
<p>However, arrays and objects (among others) are reference type values. Assigning an array or an object from one variable to another does not invole any copy. Instead, as the following example illustrates, the new variable references the same list as the first:</p>
|
|
828
|
+
<div class="highlight-js notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span><span class="kd">let</span><span class="w"> </span><span class="nx">list1</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span><span class="mf">1</span><span class="p">,</span><span class="w"> </span><span class="mf">2</span><span class="p">];</span><span class="w"></span>
|
|
829
|
+
<span class="linenos">2</span><span class="kd">let</span><span class="w"> </span><span class="nx">list2</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">list1</span><span class="p">;</span><span class="w"></span>
|
|
830
|
+
<span class="linenos">3</span>
|
|
831
|
+
<span class="linenos">4</span><span class="nx">list2</span><span class="p">[</span><span class="mf">1</span><span class="p">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="mf">42</span><span class="p">;</span><span class="w"></span>
|
|
832
|
+
<span class="linenos">5</span>
|
|
833
|
+
<span class="linenos">6</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">list1</span><span class="p">);</span><span class="w"> </span><span class="c1">// Prints [1, 42]</span><span class="w"></span>
|
|
834
|
+
</pre></div>
|
|
835
|
+
</div>
|
|
836
|
+
<p>All of this means that C functions that are expected to modify their primitive output values (such as an <code class="docutils literal notranslate"><span class="pre">int</span> <span class="pre">*</span></code> parameter) cannot be used directly. However, thanks to Koffi’s transparent array support, you can use Javascript arrays to approximate reference semantics with single-element arrays.</p>
|
|
837
|
+
<p>Below, you can find an example of an addition function where the result is stored in an <code class="docutils literal notranslate"><span class="pre">int</span> <span class="pre">*</span></code> output parameter and how to use this function from Koffi.</p>
|
|
838
|
+
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span><span class="kt">void</span><span class="w"> </span><span class="nf">AddInt</span><span class="p">(</span><span class="kt">int</span><span class="w"> </span><span class="o">*</span><span class="n">dest</span><span class="p">,</span><span class="w"> </span><span class="kt">int</span><span class="w"> </span><span class="n">add</span><span class="p">)</span><span class="w"></span>
|
|
839
|
+
<span class="linenos">2</span><span class="p">{</span><span class="w"></span>
|
|
840
|
+
<span class="linenos">3</span><span class="w"> </span><span class="o">*</span><span class="n">dest</span><span class="w"> </span><span class="o">+=</span><span class="w"> </span><span class="n">add</span><span class="p">;</span><span class="w"></span>
|
|
841
|
+
<span class="linenos">4</span><span class="p">}</span><span class="w"></span>
|
|
842
|
+
</pre></div>
|
|
843
|
+
</div>
|
|
844
|
+
<p>You can simply pass a single-element array as the third argument:</p>
|
|
845
|
+
<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">AddInt</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">'void AddInt(_Inout_ int *dest, int add)'</span><span class="p">);</span><span class="w"></span>
|
|
846
|
+
<span class="linenos">2</span>
|
|
847
|
+
<span class="linenos">3</span><span class="kd">let</span><span class="w"> </span><span class="nx">sum</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">[</span><span class="mf">36</span><span class="p">];</span><span class="w"></span>
|
|
848
|
+
<span class="linenos">4</span><span class="nx">AddInt</span><span class="p">(</span><span class="nx">sum</span><span class="p">,</span><span class="w"> </span><span class="mf">6</span><span class="p">);</span><span class="w"></span>
|
|
849
|
+
<span class="linenos">5</span>
|
|
850
|
+
<span class="linenos">6</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">sum</span><span class="p">[</span><span class="mf">0</span><span class="p">]);</span><span class="w"> </span><span class="c1">// Prints 42</span><span class="w"></span>
|
|
851
|
+
</pre></div>
|
|
852
|
+
</div>
|
|
853
|
+
</section>
|
|
854
|
+
</section>
|
|
855
|
+
<section id="fixed-size-c-arrays">
|
|
856
|
+
<h2>Fixed-size C arrays<a class="headerlink" href="#fixed-size-c-arrays" title="Permalink to this heading">#</a></h2>
|
|
857
|
+
<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>
|
|
858
|
+
<p>Koffi applies the following conversion rules when passing arrays to/from C:</p>
|
|
859
|
+
<ul class="simple">
|
|
860
|
+
<li><p><strong>JS to C</strong>: Koffi can take a normal Array (e.g. <code class="docutils literal notranslate"><span class="pre">[1,</span> <span class="pre">2]</span></code>) or a TypedArray of the correct type (e.g. <code class="docutils literal notranslate"><span class="pre">Uint8Array</span></code> for an array of <code class="docutils literal notranslate"><span class="pre">uint8_t</span></code> numbers)</p></li>
|
|
861
|
+
<li><p><strong>C to JS</strong> (return value, output parameters, callbacks): Koffi will use a TypedArray if possible. But you can change this behavior when you create the array type with the optional hint argument: <code class="docutils literal notranslate"><span class="pre">koffi.array('uint8_t',</span> <span class="pre">64,</span> <span class="pre">'array')</span></code>. For non-number types, such as arrays of strings or structs, Koffi creates normal arrays.</p></li>
|
|
862
|
+
</ul>
|
|
863
|
+
<p>See the example below:</p>
|
|
864
|
+
<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>
|
|
865
|
+
<span class="linenos"> 2</span>
|
|
866
|
+
<span class="linenos"> 3</span><span class="c1">// Those two structs are exactly the same, only the array conversion hint is different</span><span class="w"></span>
|
|
867
|
+
<span class="linenos"> 4</span><span class="kd">const</span><span class="w"> </span><span class="nx">Foo1</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">'Foo'</span><span class="p">,</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
868
|
+
<span class="linenos"> 5</span><span class="w"> </span><span class="nx">i</span><span class="o">:</span><span class="w"> </span><span class="s1">'int'</span><span class="p">,</span><span class="w"></span>
|
|
869
|
+
<span class="linenos"> 6</span><span class="w"> </span><span class="nx">a16</span><span class="o">:</span><span class="w"> </span><span class="nx">koffi</span><span class="p">.</span><span class="nx">array</span><span class="p">(</span><span class="s1">'int16_t'</span><span class="p">,</span><span class="w"> </span><span class="mf">8</span><span class="p">)</span><span class="w"></span>
|
|
870
|
+
<span class="linenos"> 7</span><span class="p">});</span><span class="w"></span>
|
|
871
|
+
<span class="linenos"> 8</span><span class="kd">const</span><span class="w"> </span><span class="nx">Foo2</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">'Foo'</span><span class="p">,</span><span class="w"> </span><span class="p">{</span><span class="w"></span>
|
|
872
|
+
<span class="linenos"> 9</span><span class="w"> </span><span class="nx">i</span><span class="o">:</span><span class="w"> </span><span class="s1">'int'</span><span class="p">,</span><span class="w"></span>
|
|
873
|
+
<span class="linenos">10</span><span class="w"> </span><span class="nx">a16</span><span class="o">:</span><span class="w"> </span><span class="nx">koffi</span><span class="p">.</span><span class="nx">array</span><span class="p">(</span><span class="s1">'int16_t'</span><span class="p">,</span><span class="w"> </span><span class="mf">8</span><span class="p">,</span><span class="w"> </span><span class="s1">'array'</span><span class="p">)</span><span class="w"></span>
|
|
874
|
+
<span class="linenos">11</span><span class="p">});</span><span class="w"></span>
|
|
875
|
+
<span class="linenos">12</span>
|
|
876
|
+
<span class="linenos">13</span><span class="c1">// Uses an hypothetical C function that just returns the struct passed as a parameter</span><span class="w"></span>
|
|
877
|
+
<span class="linenos">14</span><span class="kd">const</span><span class="w"> </span><span class="nx">ReturnFoo1</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">'Foo1 ReturnFoo(Foo1 p)'</span><span class="p">);</span><span class="w"></span>
|
|
878
|
+
<span class="linenos">15</span><span class="kd">const</span><span class="w"> </span><span class="nx">ReturnFoo2</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">'Foo2 ReturnFoo(Foo2 p)'</span><span class="p">);</span><span class="w"></span>
|
|
879
|
+
<span class="linenos">16</span>
|
|
880
|
+
<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">ReturnFoo1</span><span class="p">({</span><span class="w"> </span><span class="nx">i</span><span class="o">:</span><span class="w"> </span><span class="mf">5</span><span class="p">,</span><span class="w"> </span><span class="nx">a16</span><span class="o">:</span><span class="w"> </span><span class="p">[</span><span class="mf">6</span><span class="p">,</span><span class="w"> </span><span class="mf">8</span><span class="p">]</span><span class="w"> </span><span class="p">}))</span><span class="w"> </span><span class="c1">// Prints { i: 5, a16: Int16Array(2) [6, 8] }</span><span class="w"></span>
|
|
881
|
+
<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="w"> </span><span class="nx">i</span><span class="o">:</span><span class="w"> </span><span class="mf">5</span><span class="p">,</span><span class="w"> </span><span class="nx">a16</span><span class="o">:</span><span class="w"> </span><span class="p">[</span><span class="mf">6</span><span class="p">,</span><span class="w"> </span><span class="mf">8</span><span class="p">]</span><span class="w"> </span><span class="p">}))</span><span class="w"> </span><span class="c1">// Prints { i: 5, a16: [6, 8] }</span><span class="w"></span>
|
|
882
|
+
</pre></div>
|
|
883
|
+
</div>
|
|
884
|
+
<section id="handling-of-strings">
|
|
885
|
+
<h3>Handling of strings<a class="headerlink" href="#handling-of-strings" title="Permalink to this heading">#</a></h3>
|
|
886
|
+
<p>Koffi can also convert JS strings to fixed-sized arrays in the following cases:</p>
|
|
887
|
+
<ul class="simple">
|
|
888
|
+
<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>
|
|
889
|
+
<li><p><strong>char16 (or char16_t) arrays</strong> are filled with the UTF-16 encoded string, truncated if needed. The buffer is always NUL-terminated.</p></li>
|
|
890
|
+
</ul>
|
|
891
|
+
<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>
|
|
892
|
+
</section>
|
|
893
|
+
</section>
|
|
894
|
+
<section id="type-introspection">
|
|
895
|
+
<h2>Type introspection<a class="headerlink" href="#type-introspection" title="Permalink to this heading">#</a></h2>
|
|
896
|
+
<p>Koffi exposes three functions to explore type information:</p>
|
|
897
|
+
<ul class="simple">
|
|
898
|
+
<li><p><code class="docutils literal notranslate"><span class="pre">koffi.sizeof(type)</span></code> to get the size of a type</p></li>
|
|
899
|
+
<li><p><code class="docutils literal notranslate"><span class="pre">koffi.alignof(type)</span></code> to get the alignment of a type</p></li>
|
|
900
|
+
<li><p><code class="docutils literal notranslate"><span class="pre">koffi.introspect(type)</span></code> to get the definition of a type (only for structs for now)</p></li>
|
|
901
|
+
</ul>
|
|
902
|
+
<p>Just like before, you can refer to primitive types by their name or through <code class="docutils literal notranslate"><span class="pre">koffi.types</span></code>:</p>
|
|
903
|
+
<div class="highlight-js notranslate"><div class="highlight"><pre><span></span><span class="linenos">1</span><span class="c1">// These two lines do the same:</span><span class="w"></span>
|
|
904
|
+
<span class="linenos">2</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">koffi</span><span class="p">.</span><span class="nx">sizeof</span><span class="p">(</span><span class="s1">'long'</span><span class="p">));</span><span class="w"></span>
|
|
905
|
+
<span class="linenos">3</span><span class="nx">console</span><span class="p">.</span><span class="nx">log</span><span class="p">(</span><span class="nx">koffi</span><span class="p">.</span><span class="nx">sizeof</span><span class="p">(</span><span class="nx">koffi</span><span class="p">.</span><span class="nx">types</span><span class="p">.</span><span class="kr">long</span><span class="p">));</span><span class="w"></span>
|
|
906
|
+
</pre></div>
|
|
907
|
+
</div>
|
|
908
|
+
</section>
|
|
909
|
+
</section>
|
|
910
|
+
|
|
911
|
+
</article>
|
|
912
|
+
</div>
|
|
913
|
+
<footer>
|
|
914
|
+
|
|
915
|
+
<div class="related-pages">
|
|
916
|
+
<a class="next-page" href="functions">
|
|
917
|
+
<div class="page-info">
|
|
918
|
+
<div class="context">
|
|
919
|
+
<span>Next</span>
|
|
920
|
+
</div>
|
|
921
|
+
<div class="title">Function calls</div>
|
|
922
|
+
</div>
|
|
923
|
+
<svg><use href="#svg-arrow-right"></use></svg>
|
|
924
|
+
</a>
|
|
925
|
+
<a class="prev-page" href="start">
|
|
926
|
+
<svg><use href="#svg-arrow-right"></use></svg>
|
|
927
|
+
<div class="page-info">
|
|
928
|
+
<div class="context">
|
|
929
|
+
<span>Previous</span>
|
|
930
|
+
</div>
|
|
931
|
+
|
|
932
|
+
<div class="title">Quick start</div>
|
|
933
|
+
|
|
934
|
+
</div>
|
|
935
|
+
</a>
|
|
936
|
+
</div>
|
|
937
|
+
<div class="bottom-of-page">
|
|
938
|
+
<div class="left-details">
|
|
939
|
+
<div class="copyright">
|
|
940
|
+
Copyright © 2022, Niels Martignène
|
|
941
|
+
</div>
|
|
942
|
+
Made with <a href="https://www.sphinx-doc.org/">Sphinx</a> and <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
|
943
|
+
|
|
944
|
+
<a href="https://github.com/pradyunsg/furo">Furo</a>
|
|
945
|
+
|
|
946
|
+
</div>
|
|
947
|
+
<div class="right-details">
|
|
948
|
+
<div class="icons">
|
|
949
|
+
|
|
950
|
+
</div>
|
|
951
|
+
</div>
|
|
952
|
+
</div>
|
|
953
|
+
|
|
954
|
+
</footer>
|
|
955
|
+
</div>
|
|
956
|
+
<aside class="toc-drawer">
|
|
957
|
+
|
|
958
|
+
|
|
959
|
+
<div class="toc-sticky toc-scroll">
|
|
960
|
+
<div class="toc-title-container">
|
|
961
|
+
<span class="toc-title">
|
|
962
|
+
Contents
|
|
963
|
+
</span>
|
|
964
|
+
</div>
|
|
965
|
+
<div class="toc-tree-container">
|
|
966
|
+
<div class="toc-tree">
|
|
967
|
+
<ul>
|
|
968
|
+
<li><a class="reference internal" href="#">Data types</a><ul>
|
|
969
|
+
<li><a class="reference internal" href="#primitive-types">Primitive types</a></li>
|
|
970
|
+
<li><a class="reference internal" href="#struct-types">Struct types</a></li>
|
|
971
|
+
<li><a class="reference internal" href="#pointer-types">Pointer types</a><ul>
|
|
972
|
+
<li><a class="reference internal" href="#struct-pointers">Struct pointers</a></li>
|
|
973
|
+
<li><a class="reference internal" href="#opaque-handles">Opaque handles</a></li>
|
|
974
|
+
<li><a class="reference internal" href="#array-pointers">Array pointers</a></li>
|
|
975
|
+
<li><a class="reference internal" href="#pointers-to-primitive-types">Pointers to primitive types</a></li>
|
|
976
|
+
</ul>
|
|
977
|
+
</li>
|
|
978
|
+
<li><a class="reference internal" href="#fixed-size-c-arrays">Fixed-size C arrays</a><ul>
|
|
979
|
+
<li><a class="reference internal" href="#handling-of-strings">Handling of strings</a></li>
|
|
980
|
+
</ul>
|
|
981
|
+
</li>
|
|
982
|
+
<li><a class="reference internal" href="#type-introspection">Type introspection</a></li>
|
|
983
|
+
</ul>
|
|
984
|
+
</li>
|
|
985
|
+
</ul>
|
|
986
|
+
|
|
987
|
+
</div>
|
|
988
|
+
</div>
|
|
989
|
+
</div>
|
|
990
|
+
|
|
991
|
+
|
|
992
|
+
</aside>
|
|
993
|
+
</div>
|
|
994
|
+
</div><script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
|
995
|
+
<script src="_static/jquery.js"></script>
|
|
996
|
+
<script src="_static/underscore.js"></script>
|
|
997
|
+
<script src="_static/_sphinx_javascript_frameworks_compat.js"></script>
|
|
998
|
+
<script src="_static/doctools.js"></script>
|
|
999
|
+
<script src="_static/scripts/furo.js"></script>
|
|
1000
|
+
</body>
|
|
1001
|
+
</html>
|