lua53_sys/
lua.rs

1//! Definitions from `lua.h`.
2
3use std::ptr;
4
5use libc::{c_int, size_t, c_void, c_char, c_uchar};
6use luaconf;
7
8pub use super::glue::{LUA_VERSION_MAJOR, LUA_VERSION_MINOR, LUA_VERSION_NUM, LUA_VERSION_RELEASE,
9                      LUA_VERSION, LUA_RELEASE, LUA_COPYRIGHT, LUA_AUTHORS, LUA_REGISTRYINDEX};
10
11// Option for multiple returns in `lua_pcall` and `lua_call`.
12pub const LUA_MULTRET: c_int = -1;
13
14#[inline(always)]
15pub fn lua_upvalueindex(i: c_int) -> c_int {
16    LUA_REGISTRYINDEX - i
17}
18
19// Thread status.
20pub const LUA_OK: c_int = 0;
21pub const LUA_YIELD: c_int = 1;
22pub const LUA_ERRRUN: c_int = 2;
23pub const LUA_ERRSYNTAX: c_int = 3;
24pub const LUA_ERRMEM: c_int = 4;
25pub const LUA_ERRGCMM: c_int = 5;
26pub const LUA_ERRERR: c_int = 6;
27
28pub enum lua_State {}
29
30// Basic types.
31pub const LUA_TNONE: c_int = -1;
32
33pub const LUA_TNIL: c_int = 0;
34pub const LUA_TBOOLEAN: c_int = 1;
35pub const LUA_TLIGHTUSERDATA: c_int = 2;
36pub const LUA_TNUMBER: c_int = 3;
37pub const LUA_TSTRING: c_int = 4;
38pub const LUA_TTABLE: c_int = 5;
39pub const LUA_TFUNCTION: c_int = 6;
40pub const LUA_TUSERDATA: c_int = 7;
41pub const LUA_TTHREAD: c_int = 8;
42
43pub const LUA_NUMTAGS: c_int = 9;
44
45// Minimum Lua stack available to a C function.
46pub const LUA_MINSTACK: c_int = 20;
47
48// Predefined values in the registry.
49pub const LUA_RIDX_MAINTHREAD: lua_Integer = 1;
50pub const LUA_RIDX_GLOBALS: lua_Integer = 2;
51pub const LUA_RIDX_LAST: lua_Integer = LUA_RIDX_GLOBALS;
52
53// Type of numbers in Lua.
54pub type lua_Number = luaconf::LUA_NUMBER;
55
56// Type for integer functions.
57pub type lua_Integer = luaconf::LUA_INTEGER;
58
59// Unsigned integer type.
60pub type lua_Unsigned = luaconf::LUA_UNSIGNED;
61
62// Type for continuation-function contexts.
63pub type lua_KContext = luaconf::LUA_KCONTEXT;
64
65// Type for native functions registered with Lua.
66pub type lua_CFunction = Option<extern "C" fn(L: *mut lua_State) -> c_int>;
67
68// Type for continuation functions.
69pub type lua_KFunction = Option<extern "C" fn(L: *mut lua_State, status: c_int, ctx: lua_KContext)
70                                              -> c_int>;
71
72// Type for functions that read/write blocks when loading/dumping Lua chunks.
73pub type lua_Reader = Option<extern "C" fn(L: *mut lua_State, ud: *mut c_void, sz: *mut size_t)
74                                           -> *const c_char>;
75
76pub type lua_Writer = Option<extern "C" fn(L: *mut lua_State,
77                                           p: *const c_void,
78                                           sz: size_t,
79                                           ud: *mut c_void)
80                                           -> c_int>;
81
82// Type for memory-allocation functions.
83pub type lua_Alloc = Option<extern "C" fn(ud: *mut c_void,
84                                          ptr: *mut c_void,
85                                          osize: size_t,
86                                          nsize: size_t)
87                                          -> *mut c_void>;
88
89extern "C" {
90    // State manipulation.
91    pub fn lua_newstate(f: lua_Alloc, ud: *mut c_void) -> *mut lua_State;
92    pub fn lua_close(L: *mut lua_State);
93    pub fn lua_newthread(L: *mut lua_State) -> *mut lua_State;
94
95    pub fn lua_atpanic(L: *mut lua_State, panicf: lua_CFunction) -> lua_CFunction;
96
97    pub fn lua_version(L: *mut lua_State) -> *const lua_Number;
98
99    // Basic stack manipulation.
100    pub fn lua_absindex(L: *mut lua_State, idx: c_int) -> c_int;
101    pub fn lua_gettop(L: *mut lua_State) -> c_int;
102    pub fn lua_settop(L: *mut lua_State, idx: c_int);
103    pub fn lua_pushvalue(L: *mut lua_State, idx: c_int);
104    pub fn lua_rotate(L: *mut lua_State, idx: c_int, n: c_int);
105    pub fn lua_copy(L: *mut lua_State, fromidx: c_int, toidx: c_int);
106    pub fn lua_checkstack(L: *mut lua_State, n: c_int) -> c_int;
107
108    pub fn lua_xmove(from: *mut lua_State, to: *mut lua_State, n: c_int);
109
110    // Access functions (stack -> C)
111    pub fn lua_isnumber(L: *mut lua_State, idx: c_int) -> c_int;
112    pub fn lua_isstring(L: *mut lua_State, idx: c_int) -> c_int;
113    pub fn lua_iscfunction(L: *mut lua_State, idx: c_int) -> c_int;
114    pub fn lua_isinteger(L: *mut lua_State, idx: c_int) -> c_int;
115    pub fn lua_isuserdata(L: *mut lua_State, idx: c_int) -> c_int;
116    pub fn lua_type(L: *mut lua_State, idx: c_int) -> c_int;
117    pub fn lua_typename(L: *mut lua_State, tp: c_int) -> *const c_char;
118
119    pub fn lua_tonumberx(L: *mut lua_State, idx: c_int, isnum: *mut c_int) -> lua_Number;
120    pub fn lua_tointegerx(L: *mut lua_State, idx: c_int, isnum: *mut c_int) -> lua_Integer;
121    pub fn lua_toboolean(L: *mut lua_State, idx: c_int) -> c_int;
122    pub fn lua_tolstring(L: *mut lua_State, idx: c_int, len: *mut size_t) -> *const c_char;
123    pub fn lua_rawlen(L: *mut lua_State, idx: c_int) -> size_t;
124    pub fn lua_tocfunction(L: *mut lua_State, idx: c_int) -> lua_CFunction;
125    pub fn lua_touserdata(L: *mut lua_State, idx: c_int) -> *mut c_void;
126    pub fn lua_tothread(L: *mut lua_State, idx: c_int) -> *mut lua_State;
127    pub fn lua_topointer(L: *mut lua_State, idx: c_int) -> *const c_void;
128}
129
130// Comparison and arithmetic functions.
131pub const LUA_OPADD: c_int = 0;
132pub const LUA_OPSUB: c_int = 1;
133pub const LUA_OPMUL: c_int = 2;
134pub const LUA_OPMOD: c_int = 3;
135pub const LUA_OPPOW: c_int = 4;
136pub const LUA_OPDIV: c_int = 5;
137pub const LUA_OPIDIV: c_int = 6;
138pub const LUA_OPBAND: c_int = 7;
139pub const LUA_OPBOR: c_int = 8;
140pub const LUA_OPBXOR: c_int = 9;
141pub const LUA_OPSHL: c_int = 10;
142pub const LUA_OPSHR: c_int = 11;
143pub const LUA_OPUNM: c_int = 12;
144pub const LUA_OPBNOT: c_int = 13;
145
146extern "C" {
147    pub fn lua_arith(L: *mut lua_State, op: c_int);
148}
149
150pub const LUA_OPEQ: c_int = 0;
151pub const LUA_OPLT: c_int = 0;
152pub const LUA_OPLE: c_int = 0;
153
154extern "C" {
155    pub fn lua_rawequal(L: *mut lua_State, idx1: c_int, idx2: c_int) -> c_int;
156    pub fn lua_compare(L: *mut lua_State, idx1: c_int, idx2: c_int, op: c_int) -> c_int;
157
158    // Push functions (C -> stack).
159    pub fn lua_pushnil(L: *mut lua_State);
160    pub fn lua_pushnumber(L: *mut lua_State, n: lua_Number);
161    pub fn lua_pushinteger(L: *mut lua_State, n: lua_Integer);
162    pub fn lua_pushlstring(L: *mut lua_State, s: *const c_char, len: size_t) -> *const c_char;
163    pub fn lua_pushstring(L: *mut lua_State, s: *const c_char) -> *const c_char;
164    pub fn lua_pushfstring(L: *mut lua_State, fmt: *const c_char, ...) -> *const c_char;
165    pub fn lua_pushcclosure(L: *mut lua_State, func: lua_CFunction, n: c_int);
166    pub fn lua_pushboolean(L: *mut lua_State, b: c_int);
167    pub fn lua_pushlightuserdata(L: *mut lua_State, p: *mut c_void);
168    pub fn lua_pushthread(L: *mut lua_State) -> c_int;
169
170    // Get functions (Lua -> stack).
171    pub fn lua_getglobal(L: *mut lua_State, name: *const c_char) -> c_int;
172    pub fn lua_gettable(L: *mut lua_State, idx: c_int) -> c_int;
173    pub fn lua_getfield(L: *mut lua_State, idx: c_int, k: *const c_char) -> c_int;
174    pub fn lua_geti(L: *mut lua_State, idx: c_int, n: lua_Integer) -> c_int;
175    pub fn lua_rawget(L: *mut lua_State, idx: c_int) -> c_int;
176    pub fn lua_rawgeti(L: *mut lua_State, idx: c_int, n: lua_Integer) -> c_int;
177    pub fn lua_rawgetp(L: *mut lua_State, idx: c_int, p: *const c_void) -> c_int;
178
179    pub fn lua_createtable(L: *mut lua_State, narr: c_int, nrec: c_int);
180    pub fn lua_newuserdata(L: *mut lua_State, sz: size_t) -> *mut c_void;
181    pub fn lua_getmetatable(L: *mut lua_State, objindex: c_int) -> c_int;
182    pub fn lua_getuservalue(L: *mut lua_State, idx: c_int) -> c_int;
183
184    // Set functions (stack -> Lua).
185    pub fn lua_setglobal(L: *mut lua_State, name: *const c_char);
186    pub fn lua_settable(L: *mut lua_State, idx: c_int);
187    pub fn lua_setfield(L: *mut lua_State, idx: c_int, k: *const c_char);
188    pub fn lua_seti(L: *mut lua_State, idx: c_int, n: lua_Integer);
189    pub fn lua_rawset(L: *mut lua_State, idx: c_int);
190    pub fn lua_rawseti(L: *mut lua_State, idx: c_int, n: lua_Integer);
191    pub fn lua_rawsetp(L: *mut lua_State, idx: c_int, p: *const c_void);
192    pub fn lua_setmetatable(L: *mut lua_State, objindex: c_int) -> c_int;
193    pub fn lua_setuservalue(L: *mut lua_State, idx: c_int);
194
195    // `load` and `call` functions (load and run Lua code).
196    pub fn lua_callk(L: *mut lua_State,
197                     nargs: c_int,
198                     nresults: c_int,
199                     ctx: lua_KContext,
200                     k: lua_KFunction);
201
202    pub fn lua_pcallk(L: *mut lua_State,
203                      nargs: c_int,
204                      nresults: c_int,
205                      errfunc: c_int,
206                      ctx: lua_KContext,
207                      k: lua_KFunction)
208                      -> c_int;
209
210    pub fn lua_load(L: *mut lua_State,
211                    reader: lua_Reader,
212                    dt: *mut c_void,
213                    chunkname: *const c_char,
214                    mode: *const c_char)
215                    -> c_int;
216
217    pub fn lua_dump(L: *mut lua_State,
218                    writer: lua_Writer,
219                    data: *mut c_void,
220                    strip: c_int)
221                    -> c_int;
222}
223
224#[inline(always)]
225pub unsafe fn lua_call(L: *mut lua_State, nargs: c_int, nresults: c_int) {
226    lua_callk(L, nargs, nresults, 0, None);
227}
228
229#[inline(always)]
230pub unsafe fn lua_pcall(L: *mut lua_State, nargs: c_int, nresults: c_int, errfunc: c_int) -> c_int {
231    lua_pcallk(L, nargs, nresults, errfunc, 0, None)
232}
233
234// Coroutine functions.
235extern "C" {
236    pub fn lua_yieldk(L: *mut lua_State,
237                      nresults: c_int,
238                      ctx: lua_KContext,
239                      k: lua_KFunction)
240                      -> c_int;
241    pub fn lua_resume(L: *mut lua_State, from: *mut lua_State, narg: c_int) -> c_int;
242    pub fn lua_status(L: *mut lua_State) -> c_int;
243    pub fn lua_isyieldable(L: *mut lua_State) -> c_int;
244}
245
246#[inline(always)]
247pub unsafe fn lua_yield(L: *mut lua_State, nresults: c_int) -> c_int {
248    lua_yieldk(L, nresults, 0, None)
249}
250
251// Garbage collection function and options.
252
253pub const LUA_GCSTOP: c_int = 0;
254pub const LUA_GCRESTART: c_int = 1;
255pub const LUA_GCCOLLECT: c_int = 2;
256pub const LUA_GCCOUNT: c_int = 3;
257pub const LUA_GCCOUNTB: c_int = 4;
258pub const LUA_GCSTEP: c_int = 5;
259pub const LUA_GCSETPAUSE: c_int = 6;
260pub const LUA_GCSETSTEPMUL: c_int = 7;
261pub const LUA_GCISRUNNING: c_int = 9;
262
263extern "C" {
264    pub fn lua_gc(L: *mut lua_State, what: c_int, data: c_int) -> c_int;
265}
266
267// Miscellaneous functions.
268extern "C" {
269    pub fn lua_error(L: *mut lua_State) -> c_int;
270    pub fn lua_next(L: *mut lua_State, idx: c_int) -> c_int;
271    pub fn lua_concat(L: *mut lua_State, n: c_int);
272    pub fn lua_len(L: *mut lua_State, idx: c_int);
273    pub fn lua_stringtonumber(L: *mut lua_State, s: *const c_char) -> size_t;
274    pub fn lua_getallocf(L: *mut lua_State, ud: *mut *mut c_void) -> lua_Alloc;
275    pub fn lua_setallocf(L: *mut lua_State, f: lua_Alloc, ud: *mut c_void);
276}
277
278// Useful macros.
279// Implemented as inlined rust functions.
280
281#[inline(always)]
282pub unsafe fn lua_getextraspace(L: *mut lua_State) -> *mut c_void {
283    L.offset(-luaconf::LUA_EXTRASPACE as isize) as *mut c_void
284}
285
286#[inline(always)]
287pub unsafe fn lua_tonumber(L: *mut lua_State, i: c_int) -> lua_Number {
288    lua_tonumberx(L, i, ptr::null_mut())
289}
290
291#[inline(always)]
292pub unsafe fn lua_tointeger(L: *mut lua_State, i: c_int) -> lua_Integer {
293    lua_tointegerx(L, i, ptr::null_mut())
294}
295
296#[inline(always)]
297pub unsafe fn lua_pop(L: *mut lua_State, n: c_int) {
298    lua_settop(L, -n - 1);
299}
300
301#[inline(always)]
302pub unsafe fn lua_newtable(L: *mut lua_State) {
303    lua_createtable(L, 0, 0);
304}
305
306#[inline(always)]
307pub unsafe fn lua_register(L: *mut lua_State, n: *const c_char, f: lua_CFunction) {
308    lua_pushcfunction(L, f);
309    lua_setglobal(L, n);
310}
311
312#[inline(always)]
313pub unsafe fn lua_pushcfunction(L: *mut lua_State, f: lua_CFunction) {
314    lua_pushcclosure(L, f, 0);
315}
316
317#[inline(always)]
318pub unsafe fn lua_isfunction(L: *mut lua_State, n: c_int) -> c_int {
319    (lua_type(L, n) == LUA_TFUNCTION) as c_int
320}
321
322#[inline(always)]
323pub unsafe fn lua_istable(L: *mut lua_State, n: c_int) -> c_int {
324    (lua_type(L, n) == LUA_TTABLE) as c_int
325}
326
327#[inline(always)]
328pub unsafe fn lua_islightuserdata(L: *mut lua_State, n: c_int) -> c_int {
329    (lua_type(L, n) == LUA_TLIGHTUSERDATA) as c_int
330}
331
332#[inline(always)]
333pub unsafe fn lua_isnil(L: *mut lua_State, n: c_int) -> c_int {
334    (lua_type(L, n) == LUA_TNIL) as c_int
335}
336
337#[inline(always)]
338pub unsafe fn lua_isboolean(L: *mut lua_State, n: c_int) -> c_int {
339    (lua_type(L, n) == LUA_TBOOLEAN) as c_int
340}
341
342#[inline(always)]
343pub unsafe fn lua_isthread(L: *mut lua_State, n: c_int) -> c_int {
344    (lua_type(L, n) == LUA_TTABLE) as c_int
345}
346
347#[inline(always)]
348pub unsafe fn lua_isnone(L: *mut lua_State, n: c_int) -> c_int {
349    (lua_type(L, n) == LUA_TNONE) as c_int
350}
351
352#[inline(always)]
353pub unsafe fn lua_isnoneornil(L: *mut lua_State, n: c_int) -> c_int {
354    (lua_type(L, n) <= 0) as c_int
355}
356
357#[inline(always)]
358pub unsafe fn lua_pushliteral(L: *mut lua_State, s: &'static str) -> *const c_char {
359    let p = s.as_ptr() as *const c_char;
360    lua_pushlstring(L, p, s.len() as size_t)
361}
362
363#[inline(always)]
364pub unsafe fn lua_pushglobaltable(L: *mut lua_State) -> c_int {
365    lua_rawgeti(L, LUA_REGISTRYINDEX, LUA_RIDX_GLOBALS)
366}
367
368#[inline(always)]
369pub unsafe fn lua_tostring(L: *mut lua_State, i: c_int) -> *const c_char {
370    lua_tolstring(L, i, ptr::null_mut())
371}
372
373#[inline(always)]
374pub unsafe fn lua_insert(L: *mut lua_State, idx: c_int) {
375    lua_rotate(L, idx, 1);
376}
377
378#[inline(always)]
379pub unsafe fn lua_remove(L: *mut lua_State, idx: c_int) {
380    lua_rotate(L, idx, -1);
381    lua_pop(L, 1);
382}
383
384#[inline(always)]
385pub unsafe fn lua_replace(L: *mut lua_State, idx: c_int) {
386    lua_copy(L, -1, idx);
387    lua_pop(L, 1);
388}
389
390// Debug API
391// Event codes.
392pub const LUA_HOOKCALL: c_int = 0;
393pub const LUA_HOOKRET: c_int = 1;
394pub const LUA_HOOKLINE: c_int = 2;
395pub const LUA_HOOKCOUNT: c_int = 3;
396pub const LUA_HOOKTAILCALL: c_int = 4;
397
398// Event masks.
399pub const LUA_MASKCALL: c_int = 1 << (LUA_HOOKCALL as usize);
400pub const LUA_MASKRET: c_int = 2 << (LUA_HOOKRET as usize);
401pub const LUA_MASKLINE: c_int = 3 << (LUA_HOOKLINE as usize);
402pub const LUA_MASKCOUNT: c_int = 4 << (LUA_HOOKCOUNT as usize);
403
404// Functions to be called by the debugger in specific events.
405pub type lua_Hook = Option<extern "C" fn(L: *mut lua_State, ar: *mut lua_Debug)>;
406
407extern "C" {
408    pub fn lua_getstack(L: *mut lua_State, level: c_int, ar: *mut lua_Debug) -> c_int;
409    pub fn lua_getinfo(L: *mut lua_State, what: *const c_char, ar: *mut lua_Debug) -> c_int;
410    pub fn lua_getlocal(L: *mut lua_State, ar: *const lua_Debug, n: c_int) -> *const c_char;
411    pub fn lua_setlocal(L: *mut lua_State, ar: *const lua_Debug, n: c_int) -> *const c_char;
412    pub fn lua_getupvalue(L: *mut lua_State, funcindex: c_int, n: c_int) -> *const c_char;
413    pub fn lua_setupvalue(L: *mut lua_State, funcindex: c_int, n: c_int) -> *const c_char;
414
415    pub fn lua_upvalueid(L: *mut lua_State, fidx: c_int, n: c_int) -> *mut c_void;
416    pub fn lua_upvaluejoin(L: *mut lua_State, fidx1: c_int, n1: c_int, fidx2: c_int, n2: c_int);
417
418    pub fn lua_sethook(L: *mut lua_State, func: lua_Hook, mask: c_int, count: c_int);
419    pub fn lua_gethook(L: *mut lua_State) -> lua_Hook;
420    pub fn lua_gethookmask(L: *mut lua_State) -> c_int;
421    pub fn lua_gethookcount(L: *mut lua_State) -> c_int;
422}
423
424#[repr(C)]
425pub struct lua_Debug {
426    pub event: c_int,
427    pub name: *const c_char,
428    pub namewhat: *const c_char,
429    pub what: *const c_char,
430    pub source: *const c_char,
431    pub currentline: c_int,
432    pub linedefined: c_int,
433    pub lastlinedefined: c_int,
434    pub nups: c_uchar,
435    pub nparams: c_uchar,
436    pub isvararg: c_char,
437    pub istailcall: c_char,
438    pub short_source: [c_char; luaconf::LUA_IDSIZE as usize],
439    i_ci: *mut c_void,
440}
lua53_sys/lua.rs

lua53_sys/
lua.rs
