ext_ffi_api.html 21 KB

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