2
0

ext_ffi_api.html 21 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568
  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <title>ffi.* API Functions</title>
  5. <meta charset="utf-8">
  6. <meta name="Copyright" content="Copyright (C) 2005-2023">
  7. <meta name="Language" content="en">
  8. <link rel="stylesheet" type="text/css" href="bluequad.css" media="screen">
  9. <link rel="stylesheet" type="text/css" href="bluequad-print.css" media="print">
  10. <style type="text/css">
  11. table.abitable { width: 30em; line-height: 1.2; }
  12. tr.abihead td { font-weight: bold; }
  13. td.abiparam { font-weight: bold; width: 6em; }
  14. </style>
  15. </head>
  16. <body>
  17. <div id="site">
  18. <a href="https://luajit.org"><span>Lua<span id="logo">JIT</span></span></a>
  19. </div>
  20. <div id="head">
  21. <h1><tt>ffi.*</tt> API Functions</h1>
  22. </div>
  23. <div id="nav">
  24. <ul><li>
  25. <a href="luajit.html">LuaJIT</a>
  26. <ul><li>
  27. <a href="https://luajit.org/download.html">Download <span class="ext">&raquo;</span></a>
  28. </li><li>
  29. <a href="install.html">Installation</a>
  30. </li><li>
  31. <a href="running.html">Running</a>
  32. </li></ul>
  33. </li><li>
  34. <a href="extensions.html">Extensions</a>
  35. <ul><li>
  36. <a href="ext_ffi.html">FFI Library</a>
  37. <ul><li>
  38. <a href="ext_ffi_tutorial.html">FFI Tutorial</a>
  39. </li><li>
  40. <a class="current" href="ext_ffi_api.html">ffi.* API</a>
  41. </li><li>
  42. <a href="ext_ffi_semantics.html">FFI Semantics</a>
  43. </li></ul>
  44. </li><li>
  45. <a href="ext_buffer.html">String Buffers</a>
  46. </li><li>
  47. <a href="ext_jit.html">jit.* Library</a>
  48. </li><li>
  49. <a href="ext_c_api.html">Lua/C API</a>
  50. </li><li>
  51. <a href="ext_profiler.html">Profiler</a>
  52. </li></ul>
  53. </li><li>
  54. <a href="https://luajit.org/status.html">Status <span class="ext">&raquo;</span></a>
  55. </li><li>
  56. <a href="https://luajit.org/faq.html">FAQ <span class="ext">&raquo;</span></a>
  57. </li><li>
  58. <a href="https://luajit.org/list.html">Mailing List <span class="ext">&raquo;</span></a>
  59. </li></ul>
  60. </div>
  61. <div id="main">
  62. <p>
  63. This page describes the API functions provided by the FFI library in
  64. detail. It's recommended to read through the
  65. <a href="ext_ffi.html">introduction</a> and the
  66. <a href="ext_ffi_tutorial.html">FFI tutorial</a> first.
  67. </p>
  68. <h2 id="glossary">Glossary</h2>
  69. <ul>
  70. <li><b>cdecl</b> &mdash; An abstract C&nbsp;type declaration (a Lua
  71. string).</li>
  72. <li><b>ctype</b> &mdash; A C&nbsp;type object. This is a special kind of
  73. <b>cdata</b> returned by <tt>ffi.typeof()</tt>. It serves as a
  74. <b>cdata</b> <a href="#ffi_new">constructor</a> when called.</li>
  75. <li><b>cdata</b> &mdash; A C&nbsp;data object. It holds a value of the
  76. corresponding <b>ctype</b>.</li>
  77. <li><b>ct</b> &mdash; A C&nbsp;type specification which can be used for
  78. most of the API functions. Either a <b>cdecl</b>, a <b>ctype</b> or a
  79. <b>cdata</b> serving as a template type.</li>
  80. <li><b>cb</b> &mdash; A callback object. This is a C&nbsp;data object
  81. holding a special function pointer. Calling this function from
  82. C&nbsp;code runs an associated Lua function.</li>
  83. <li><b>VLA</b> &mdash; A variable-length array is declared with a
  84. <tt>?</tt> instead of the number of elements, e.g. <tt>"int[?]"</tt>.
  85. The number of elements (<tt>nelem</tt>) must be given when it's
  86. <a href="#ffi_new">created</a>.</li>
  87. <li><b>VLS</b> &mdash; A variable-length struct is a <tt>struct</tt> C
  88. type where the last element is a <b>VLA</b>. The same rules for
  89. declaration and creation apply.</li>
  90. </ul>
  91. <h2 id="decl">Declaring and Accessing External Symbols</h2>
  92. <p>
  93. External symbols must be declared first and can then be accessed by
  94. indexing a <a href="ext_ffi_semantics.html#clib">C&nbsp;library
  95. namespace</a>, which automatically binds the symbol to a specific
  96. library.
  97. </p>
  98. <h3 id="ffi_cdef"><tt>ffi.cdef(def)</tt></h3>
  99. <p>
  100. Adds multiple C&nbsp;declarations for types or external symbols (named
  101. variables or functions). <tt>def</tt> must be a Lua string. It's
  102. recommended to use the syntactic sugar for string arguments as
  103. follows:
  104. </p>
  105. <pre class="code">
  106. ffi.cdef[[
  107. <span style="color:#00a000;">typedef struct foo { int a, b; } foo_t; // Declare a struct and typedef.
  108. int dofoo(foo_t *f, int n); /* Declare an external C function. */</span>
  109. ]]
  110. </pre>
  111. <p>
  112. The contents of the string (the part in green above) must be a
  113. sequence of
  114. <a href="ext_ffi_semantics.html#clang">C&nbsp;declarations</a>,
  115. separated by semicolons. The trailing semicolon for a single
  116. declaration may be omitted.
  117. </p>
  118. <p>
  119. Please note, that external symbols are only <em>declared</em>, but they
  120. are <em>not bound</em> to any specific address, yet. Binding is
  121. achieved with C&nbsp;library namespaces (see below).
  122. </p>
  123. <p style="color: #c00000;">
  124. C&nbsp;declarations are not passed through a C&nbsp;pre-processor,
  125. yet. No pre-processor tokens are allowed, except for
  126. <tt>#pragma&nbsp;pack</tt>. Replace <tt>#define</tt> in existing
  127. C&nbsp;header files with <tt>enum</tt>, <tt>static&nbsp;const</tt>
  128. or <tt>typedef</tt> and/or pass the files through an external
  129. C&nbsp;pre-processor (once). Be careful not to include unneeded or
  130. redundant declarations from unrelated header files.
  131. </p>
  132. <h3 id="ffi_C"><tt>ffi.C</tt></h3>
  133. <p>
  134. This is the default C&nbsp;library namespace &mdash; note the
  135. uppercase <tt>'C'</tt>. It binds to the default set of symbols or
  136. libraries on the target system. These are more or less the same as a
  137. C&nbsp;compiler would offer by default, without specifying extra link
  138. libraries.
  139. </p>
  140. <p>
  141. On POSIX systems, this binds to symbols in the default or global
  142. namespace. This includes all exported symbols from the executable and
  143. any libraries loaded into the global namespace. This includes at least
  144. <tt>libc</tt>, <tt>libm</tt>, <tt>libdl</tt> (on Linux),
  145. <tt>libgcc</tt> (if compiled with GCC), as well as any exported
  146. symbols from the Lua/C&nbsp;API provided by LuaJIT itself.
  147. </p>
  148. <p>
  149. On Windows systems, this binds to symbols exported from the
  150. <tt>*.exe</tt>, the <tt>lua51.dll</tt> (i.e. the Lua/C&nbsp;API
  151. provided by LuaJIT itself), the C&nbsp;runtime library LuaJIT was linked
  152. with (<tt>msvcrt*.dll</tt>), <tt>kernel32.dll</tt>,
  153. <tt>user32.dll</tt> and <tt>gdi32.dll</tt>.
  154. </p>
  155. <h3 id="ffi_load"><tt>clib = ffi.load(name [,global])</tt></h3>
  156. <p>
  157. This loads the dynamic library given by <tt>name</tt> and returns
  158. a new C&nbsp;library namespace which binds to its symbols. On POSIX
  159. systems, if <tt>global</tt> is <tt>true</tt>, the library symbols are
  160. loaded into the global namespace, too.
  161. </p>
  162. <p>
  163. If <tt>name</tt> is a path, the library is loaded from this path.
  164. Otherwise <tt>name</tt> is canonicalized in a system-dependent way and
  165. searched in the default search path for dynamic libraries:
  166. </p>
  167. <p>
  168. On POSIX systems, if the name contains no dot, the extension
  169. <tt>.so</tt> is appended. Also, the <tt>lib</tt> prefix is prepended
  170. if necessary. So <tt>ffi.load("z")</tt> looks for <tt>"libz.so"</tt>
  171. in the default shared library search path.
  172. </p>
  173. <p>
  174. On Windows systems, if the name contains no dot, the extension
  175. <tt>.dll</tt> is appended. So <tt>ffi.load("ws2_32")</tt> looks for
  176. <tt>"ws2_32.dll"</tt> in the default DLL search path.
  177. </p>
  178. <h2 id="create">Creating cdata Objects</h2>
  179. <p>
  180. The following API functions create cdata objects (<tt>type()</tt>
  181. returns <tt>"cdata"</tt>). All created cdata objects are
  182. <a href="ext_ffi_semantics.html#gc">garbage collected</a>.
  183. </p>
  184. <h3 id="ffi_new"><tt>cdata = ffi.new(ct [,nelem] [,init...])<br>
  185. cdata = <em>ctype</em>([nelem,] [init...])</tt></h3>
  186. <p>
  187. Creates a cdata object for the given <tt>ct</tt>. VLA/VLS types
  188. require the <tt>nelem</tt> argument. The second syntax uses a ctype as
  189. a constructor and is otherwise fully equivalent.
  190. </p>
  191. <p>
  192. The cdata object is initialized according to the
  193. <a href="ext_ffi_semantics.html#init">rules for initializers</a>,
  194. using the optional <tt>init</tt> arguments. Excess initializers cause
  195. an error.
  196. </p>
  197. <p>
  198. Performance notice: if you want to create many objects of one kind,
  199. parse the cdecl only once and get its ctype with
  200. <tt>ffi.typeof()</tt>. Then use the ctype as a constructor repeatedly.
  201. </p>
  202. <p style="font-size: 8pt;">
  203. Please note, that an anonymous <tt>struct</tt> declaration implicitly
  204. creates a new and distinguished ctype every time you use it for
  205. <tt>ffi.new()</tt>. This is probably <b>not</b> what you want,
  206. especially if you create more than one cdata object. Different anonymous
  207. <tt>structs</tt> are not considered assignment-compatible by the
  208. C&nbsp;standard, even though they may have the same fields! Also, they
  209. are considered different types by the JIT-compiler, which may cause an
  210. excessive number of traces. It's strongly suggested to either declare
  211. a named <tt>struct</tt> or <tt>typedef</tt> with <tt>ffi.cdef()</tt>
  212. or to create a single ctype object for an anonymous <tt>struct</tt>
  213. with <tt>ffi.typeof()</tt>.
  214. </p>
  215. <h3 id="ffi_typeof"><tt>ctype = ffi.typeof(ct)</tt></h3>
  216. <p>
  217. Creates a ctype object for the given <tt>ct</tt>.
  218. </p>
  219. <p>
  220. This function is especially useful to parse a cdecl only once and then
  221. use the resulting ctype object as a <a href="#ffi_new">constructor</a>.
  222. </p>
  223. <h3 id="ffi_cast"><tt>cdata = ffi.cast(ct, init)</tt></h3>
  224. <p>
  225. Creates a scalar cdata object for the given <tt>ct</tt>. The cdata
  226. object is initialized with <tt>init</tt> using the "cast" variant of
  227. the <a href="ext_ffi_semantics.html#convert">C&nbsp;type conversion
  228. rules</a>.
  229. </p>
  230. <p>
  231. This functions is mainly useful to override the pointer compatibility
  232. checks or to convert pointers to addresses or vice versa.
  233. </p>
  234. <h3 id="ffi_metatype"><tt>ctype = ffi.metatype(ct, metatable)</tt></h3>
  235. <p>
  236. Creates a ctype object for the given <tt>ct</tt> and associates it with
  237. a metatable. Only <tt>struct</tt>/<tt>union</tt> types, complex numbers
  238. and vectors are allowed. Other types may be wrapped in a
  239. <tt>struct</tt>, if needed.
  240. </p>
  241. <p>
  242. The association with a metatable is permanent and cannot be changed
  243. afterwards. Neither the contents of the <tt>metatable</tt> nor the
  244. contents of an <tt>__index</tt> table (if any) may be modified
  245. afterwards. The associated metatable automatically applies to all uses
  246. of this type, no matter how the objects are created or where they
  247. originate from. Note that predefined operations on types have
  248. precedence (e.g. declared field names cannot be overridden).
  249. </p>
  250. <p>
  251. All standard Lua metamethods are implemented. These are called directly,
  252. without shortcuts, and on any mix of types. For binary operations, the
  253. left operand is checked first for a valid ctype metamethod. The
  254. <tt>__gc</tt> metamethod only applies to <tt>struct</tt>/<tt>union</tt>
  255. types and performs an implicit <a href="#ffi_gc"><tt>ffi.gc()</tt></a>
  256. call during creation of an instance.
  257. </p>
  258. <h3 id="ffi_gc"><tt>cdata = ffi.gc(cdata, finalizer)</tt></h3>
  259. <p>
  260. Associates a finalizer with a pointer or aggregate cdata object. The
  261. cdata object is returned unchanged.
  262. </p>
  263. <p>
  264. This function allows safe integration of unmanaged resources into the
  265. automatic memory management of the LuaJIT garbage collector. Typical
  266. usage:
  267. </p>
  268. <pre class="code">
  269. local p = ffi.gc(ffi.C.malloc(n), ffi.C.free)
  270. ...
  271. p = nil -- Last reference to p is gone.
  272. -- GC will eventually run finalizer: ffi.C.free(p)
  273. </pre>
  274. <p>
  275. A cdata finalizer works like the <tt>__gc</tt> metamethod for userdata
  276. objects: when the last reference to a cdata object is gone, the
  277. associated finalizer is called with the cdata object as an argument. The
  278. finalizer can be a Lua function or a cdata function or cdata function
  279. pointer. An existing finalizer can be removed by setting a <tt>nil</tt>
  280. finalizer, e.g. right before explicitly deleting a resource:
  281. </p>
  282. <pre class="code">
  283. ffi.C.free(ffi.gc(p, nil)) -- Manually free the memory.
  284. </pre>
  285. <h2 id="info">C&nbsp;Type Information</h2>
  286. <p>
  287. The following API functions return information about C&nbsp;types.
  288. They are most useful for inspecting cdata objects.
  289. </p>
  290. <h3 id="ffi_sizeof"><tt>size = ffi.sizeof(ct [,nelem])</tt></h3>
  291. <p>
  292. Returns the size of <tt>ct</tt> in bytes. Returns <tt>nil</tt> if
  293. the size is not known (e.g. for <tt>"void"</tt> or function types).
  294. Requires <tt>nelem</tt> for VLA/VLS types, except for cdata objects.
  295. </p>
  296. <h3 id="ffi_alignof"><tt>align = ffi.alignof(ct)</tt></h3>
  297. <p>
  298. Returns the minimum required alignment for <tt>ct</tt> in bytes.
  299. </p>
  300. <h3 id="ffi_offsetof"><tt>ofs [,bpos,bsize] = ffi.offsetof(ct, field)</tt></h3>
  301. <p>
  302. Returns the offset (in bytes) of <tt>field</tt> relative to the start
  303. of <tt>ct</tt>, which must be a <tt>struct</tt>. Additionally returns
  304. the position and the field size (in bits) for bit fields.
  305. </p>
  306. <h3 id="ffi_istype"><tt>status = ffi.istype(ct, obj)</tt></h3>
  307. <p>
  308. Returns <tt>true</tt> if <tt>obj</tt> has the C&nbsp;type given by
  309. <tt>ct</tt>. Returns <tt>false</tt> otherwise.
  310. </p>
  311. <p>
  312. C&nbsp;type qualifiers (<tt>const</tt> etc.) are ignored. Pointers are
  313. checked with the standard pointer compatibility rules, but without any
  314. special treatment for <tt>void&nbsp;*</tt>. If <tt>ct</tt> specifies a
  315. <tt>struct</tt>/<tt>union</tt>, then a pointer to this type is accepted,
  316. too. Otherwise the types must match exactly.
  317. </p>
  318. <p>
  319. Note: this function accepts all kinds of Lua objects for the
  320. <tt>obj</tt> argument, but always returns <tt>false</tt> for non-cdata
  321. objects.
  322. </p>
  323. <h2 id="util">Utility Functions</h2>
  324. <h3 id="ffi_errno"><tt>err = ffi.errno([newerr])</tt></h3>
  325. <p>
  326. Returns the error number set by the last C&nbsp;function call which
  327. indicated an error condition. If the optional <tt>newerr</tt> argument
  328. is present, the error number is set to the new value and the previous
  329. value is returned.
  330. </p>
  331. <p>
  332. This function offers a portable and OS-independent way to get and set the
  333. error number. Note that only <em>some</em> C&nbsp;functions set the error
  334. number. And it's only significant if the function actually indicated an
  335. error condition (e.g. with a return value of <tt>-1</tt> or
  336. <tt>NULL</tt>). Otherwise, it may or may not contain any previously set
  337. value.
  338. </p>
  339. <p>
  340. You're advised to call this function only when needed and as close as
  341. possible after the return of the related C&nbsp;function. The
  342. <tt>errno</tt> value is preserved across hooks, memory allocations,
  343. invocations of the JIT compiler and other internal VM activity. The same
  344. applies to the value returned by <tt>GetLastError()</tt> on Windows, but
  345. you need to declare and call it yourself.
  346. </p>
  347. <h3 id="ffi_string"><tt>str = ffi.string(ptr [,len])</tt></h3>
  348. <p>
  349. Creates an interned Lua string from the data pointed to by
  350. <tt>ptr</tt>.
  351. </p>
  352. <p>
  353. If the optional argument <tt>len</tt> is missing, <tt>ptr</tt> is
  354. converted to a <tt>"char&nbsp;*"</tt> and the data is assumed to be
  355. zero-terminated. The length of the string is computed with
  356. <tt>strlen()</tt>.
  357. </p>
  358. <p>
  359. Otherwise <tt>ptr</tt> is converted to a <tt>"void&nbsp;*"</tt> and
  360. <tt>len</tt> gives the length of the data. The data may contain
  361. embedded zeros and need not be byte-oriented (though this may cause
  362. endianess issues).
  363. </p>
  364. <p>
  365. This function is mainly useful to convert (temporary)
  366. <tt>"const&nbsp;char&nbsp;*"</tt> pointers returned by
  367. C&nbsp;functions to Lua strings and store them or pass them to other
  368. functions expecting a Lua string. The Lua string is an (interned) copy
  369. of the data and bears no relation to the original data area anymore.
  370. Lua strings are 8&nbsp;bit clean and may be used to hold arbitrary,
  371. non-character data.
  372. </p>
  373. <p>
  374. Performance notice: it's faster to pass the length of the string, if
  375. it's known. E.g. when the length is returned by a C&nbsp;call like
  376. <tt>sprintf()</tt>.
  377. </p>
  378. <h3 id="ffi_copy"><tt>ffi.copy(dst, src, len)<br>
  379. ffi.copy(dst, str)</tt></h3>
  380. <p>
  381. Copies the data pointed to by <tt>src</tt> to <tt>dst</tt>.
  382. <tt>dst</tt> is converted to a <tt>"void&nbsp;*"</tt> and <tt>src</tt>
  383. is converted to a <tt>"const void&nbsp;*"</tt>.
  384. </p>
  385. <p>
  386. In the first syntax, <tt>len</tt> gives the number of bytes to copy.
  387. Caveat: if <tt>src</tt> is a Lua string, then <tt>len</tt> must not
  388. exceed <tt>#src+1</tt>.
  389. </p>
  390. <p>
  391. In the second syntax, the source of the copy must be a Lua string. All
  392. bytes of the string <em>plus a zero-terminator</em> are copied to
  393. <tt>dst</tt> (i.e. <tt>#src+1</tt> bytes).
  394. </p>
  395. <p>
  396. Performance notice: <tt>ffi.copy()</tt> may be used as a faster
  397. (inlinable) replacement for the C&nbsp;library functions
  398. <tt>memcpy()</tt>, <tt>strcpy()</tt> and <tt>strncpy()</tt>.
  399. </p>
  400. <h3 id="ffi_fill"><tt>ffi.fill(dst, len [,c])</tt></h3>
  401. <p>
  402. Fills the data pointed to by <tt>dst</tt> with <tt>len</tt> constant
  403. bytes, given by <tt>c</tt>. If <tt>c</tt> is omitted, the data is
  404. zero-filled.
  405. </p>
  406. <p>
  407. Performance notice: <tt>ffi.fill()</tt> may be used as a faster
  408. (inlinable) replacement for the C&nbsp;library function
  409. <tt>memset(dst,&nbsp;c,&nbsp;len)</tt>. Please note the different
  410. order of arguments!
  411. </p>
  412. <h2 id="target">Target-specific Information</h2>
  413. <h3 id="ffi_abi"><tt>status = ffi.abi(param)</tt></h3>
  414. <p>
  415. Returns <tt>true</tt> if <tt>param</tt> (a Lua string) applies for the
  416. target ABI (Application Binary Interface). Returns <tt>false</tt>
  417. otherwise. The following parameters are currently defined:
  418. </p>
  419. <table class="abitable">
  420. <tr class="abihead">
  421. <td class="abiparam">Parameter</td>
  422. <td class="abidesc">Description</td>
  423. </tr>
  424. <tr class="odd separate">
  425. <td class="abiparam">32bit</td><td class="abidesc">32 bit architecture</td></tr>
  426. <tr class="even">
  427. <td class="abiparam">64bit</td><td class="abidesc">64 bit architecture</td></tr>
  428. <tr class="odd separate">
  429. <td class="abiparam">le</td><td class="abidesc">Little-endian architecture</td></tr>
  430. <tr class="even">
  431. <td class="abiparam">be</td><td class="abidesc">Big-endian architecture</td></tr>
  432. <tr class="odd separate">
  433. <td class="abiparam">fpu</td><td class="abidesc">Target has a hardware FPU</td></tr>
  434. <tr class="even">
  435. <td class="abiparam">softfp</td><td class="abidesc">softfp calling conventions</td></tr>
  436. <tr class="odd">
  437. <td class="abiparam">hardfp</td><td class="abidesc">hardfp calling conventions</td></tr>
  438. <tr class="even separate">
  439. <td class="abiparam">eabi</td><td class="abidesc">EABI variant of the standard ABI</td></tr>
  440. <tr class="odd">
  441. <td class="abiparam">win</td><td class="abidesc">Windows variant of the standard ABI</td></tr>
  442. <tr class="even">
  443. <td class="abiparam">pauth</td><td class="abidesc">Pointer authentication ABI</td></tr>
  444. <tr class="odd">
  445. <td class="abiparam">uwp</td><td class="abidesc">Universal Windows Platform</td></tr>
  446. <tr class="even">
  447. <td class="abiparam">gc64</td><td class="abidesc">64 bit GC references</td></tr>
  448. </table>
  449. <h3 id="ffi_os"><tt>ffi.os</tt></h3>
  450. <p>
  451. Contains the target OS name. Same contents as
  452. <a href="ext_jit.html#jit_os"><tt>jit.os</tt></a>.
  453. </p>
  454. <h3 id="ffi_arch"><tt>ffi.arch</tt></h3>
  455. <p>
  456. Contains the target architecture name. Same contents as
  457. <a href="ext_jit.html#jit_arch"><tt>jit.arch</tt></a>.
  458. </p>
  459. <h2 id="callback">Methods for Callbacks</h2>
  460. <p>
  461. The C&nbsp;types for <a href="ext_ffi_semantics.html#callback">callbacks</a>
  462. have some extra methods:
  463. </p>
  464. <h3 id="callback_free"><tt>cb:free()</tt></h3>
  465. <p>
  466. Free the resources associated with a callback. The associated Lua
  467. function is unanchored and may be garbage collected. The callback
  468. function pointer is no longer valid and must not be called again
  469. (it may be reused by a subsequently created callback).
  470. </p>
  471. <h3 id="callback_set"><tt>cb:set(func)</tt></h3>
  472. <p>
  473. Associate a new Lua function with a callback. The C&nbsp;type of the
  474. callback and the callback function pointer are unchanged.
  475. </p>
  476. <p>
  477. This method is useful to dynamically switch the receiver of callbacks
  478. without creating a new callback each time and registering it again (e.g.
  479. with a GUI library).
  480. </p>
  481. <h2 id="extended">Extended Standard Library Functions</h2>
  482. <p>
  483. The following standard library functions have been extended to work
  484. with cdata objects:
  485. </p>
  486. <h3 id="tonumber"><tt>n = tonumber(cdata)</tt></h3>
  487. <p>
  488. Converts a number cdata object to a <tt>double</tt> and returns it as
  489. a Lua number. This is particularly useful for boxed 64&nbsp;bit
  490. integer values. Caveat: this conversion may incur a precision loss.
  491. </p>
  492. <h3 id="tostring"><tt>s = tostring(cdata)</tt></h3>
  493. <p>
  494. Returns a string representation of the value of 64&nbsp;bit integers
  495. (<tt><b>"</b>nnn<b>LL"</b></tt> or <tt><b>"</b>nnn<b>ULL"</b></tt>) or
  496. complex numbers (<tt><b>"</b>re&plusmn;im<b>i"</b></tt>). Otherwise
  497. returns a string representation of the C&nbsp;type of a ctype object
  498. (<tt><b>"ctype&lt;</b>type<b>&gt;"</b></tt>) or a cdata object
  499. (<tt><b>"cdata&lt;</b>type<b>&gt;:&nbsp;</b>address"</tt>), unless you
  500. override it with a <tt>__tostring</tt> metamethod (see
  501. <a href="#ffi_metatype"><tt>ffi.metatype()</tt></a>).
  502. </p>
  503. <h3 id="pairs"><tt>iter, obj, start = pairs(cdata)<br>
  504. iter, obj, start = ipairs(cdata)<br></tt></h3>
  505. <p>
  506. Calls the <tt>__pairs</tt> or <tt>__ipairs</tt> metamethod of the
  507. corresponding ctype.
  508. </p>
  509. <h2 id="literals">Extensions to the Lua Parser</h2>
  510. <p>
  511. The parser for Lua source code treats numeric literals with the
  512. suffixes <tt>LL</tt> or <tt>ULL</tt> as signed or unsigned 64&nbsp;bit
  513. integers. Case doesn't matter, but uppercase is recommended for
  514. readability. It handles decimal (<tt>42LL</tt>), hexadecimal
  515. (<tt>0x2aLL</tt>) and binary (<tt>0b101010LL</tt>) literals.
  516. </p>
  517. <p>
  518. The imaginary part of complex numbers can be specified by suffixing
  519. number literals with <tt>i</tt> or <tt>I</tt>, e.g. <tt>12.5i</tt>.
  520. Caveat: you'll need to use <tt>1i</tt> to get an imaginary part with
  521. the value one, since <tt>i</tt> itself still refers to a variable
  522. named <tt>i</tt>.
  523. </p>
  524. <br class="flush">
  525. </div>
  526. <div id="foot">
  527. <hr class="hide">
  528. Copyright &copy; 2005-2023
  529. <span class="noprint">
  530. &middot;
  531. <a href="contact.html">Contact</a>
  532. </span>
  533. </div>
  534. </body>
  535. </html>