Skip to main content

mlua_sys/lua52/
lauxlib.rs

1//! Contains definitions from `lauxlib.h`.
2
3use std::os::raw::{c_char, c_int, c_void};
4use std::ptr;
5
6use super::lua::{self, lua_CFunction, lua_Integer, lua_Number, lua_State, lua_Unsigned};
7
8// Extra error code for 'luaL_load'
9pub const LUA_ERRFILE: c_int = lua::LUA_ERRERR + 1;
10
11// Key, in the registry, for table of loaded modules
12pub const LUA_LOADED_TABLE: *const c_char = cstr!("_LOADED");
13
14// Key, in the registry, for table of preloaded loaders
15pub const LUA_PRELOAD_TABLE: *const c_char = cstr!("_PRELOAD");
16
17#[repr(C)]
18pub struct luaL_Reg {
19    pub name: *const c_char,
20    pub func: lua_CFunction,
21}
22
23#[cfg_attr(all(windows, raw_dylib), link(name = "lua52", kind = "raw-dylib"))]
24unsafe extern "C-unwind" {
25    pub fn luaL_checkversion_(L: *mut lua_State, ver: lua_Number);
26
27    #[link_name = "luaL_getmetafield"]
28    pub fn luaL_getmetafield_(L: *mut lua_State, obj: c_int, e: *const c_char) -> c_int;
29    pub fn luaL_callmeta(L: *mut lua_State, obj: c_int, e: *const c_char) -> c_int;
30    #[link_name = "luaL_tolstring"]
31    pub fn luaL_tolstring_(L: *mut lua_State, idx: c_int, len: *mut usize) -> *const c_char;
32    pub fn luaL_argerror(L: *mut lua_State, arg: c_int, extramsg: *const c_char) -> c_int;
33    pub fn luaL_checklstring(L: *mut lua_State, arg: c_int, l: *mut usize) -> *const c_char;
34    pub fn luaL_optlstring(L: *mut lua_State, arg: c_int, def: *const c_char, l: *mut usize)
35    -> *const c_char;
36    pub fn luaL_checknumber(L: *mut lua_State, arg: c_int) -> lua_Number;
37    pub fn luaL_optnumber(L: *mut lua_State, arg: c_int, def: lua_Number) -> lua_Number;
38    pub fn luaL_checkinteger(L: *mut lua_State, arg: c_int) -> lua_Integer;
39    pub fn luaL_optinteger(L: *mut lua_State, arg: c_int, def: lua_Integer) -> lua_Integer;
40    pub fn luaL_checkunsigned(L: *mut lua_State, arg: c_int) -> lua_Unsigned;
41    pub fn luaL_optunsigned(L: *mut lua_State, arg: c_int, def: lua_Unsigned) -> lua_Unsigned;
42
43    pub fn luaL_checkstack(L: *mut lua_State, sz: c_int, msg: *const c_char);
44    pub fn luaL_checktype(L: *mut lua_State, arg: c_int, t: c_int);
45    pub fn luaL_checkany(L: *mut lua_State, arg: c_int);
46
47    #[link_name = "luaL_newmetatable"]
48    pub fn luaL_newmetatable_(L: *mut lua_State, tname: *const c_char) -> c_int;
49    pub fn luaL_setmetatable(L: *mut lua_State, tname: *const c_char);
50    pub fn luaL_testudata(L: *mut lua_State, ud: c_int, tname: *const c_char) -> *mut c_void;
51    pub fn luaL_checkudata(L: *mut lua_State, ud: c_int, tname: *const c_char) -> *mut c_void;
52
53    pub fn luaL_where(L: *mut lua_State, lvl: c_int);
54    pub fn luaL_error(L: *mut lua_State, fmt: *const c_char, ...) -> c_int;
55
56    pub fn luaL_checkoption(
57        L: *mut lua_State,
58        arg: c_int,
59        def: *const c_char,
60        lst: *const *const c_char,
61    ) -> c_int;
62
63    pub fn luaL_fileresult(L: *mut lua_State, stat: c_int, fname: *const c_char) -> c_int;
64    pub fn luaL_execresult(L: *mut lua_State, stat: c_int) -> c_int;
65}
66
67// Pre-defined references
68pub const LUA_NOREF: c_int = -2;
69pub const LUA_REFNIL: c_int = -1;
70
71#[cfg_attr(all(windows, raw_dylib), link(name = "lua52", kind = "raw-dylib"))]
72unsafe extern "C-unwind" {
73    pub fn luaL_ref(L: *mut lua_State, t: c_int) -> c_int;
74    pub fn luaL_unref(L: *mut lua_State, t: c_int, r#ref: c_int);
75
76    pub fn luaL_loadfilex(L: *mut lua_State, filename: *const c_char, mode: *const c_char) -> c_int;
77}
78
79#[inline(always)]
80pub unsafe fn luaL_loadfile(L: *mut lua_State, f: *const c_char) -> c_int {
81    luaL_loadfilex(L, f, ptr::null())
82}
83
84#[cfg_attr(all(windows, raw_dylib), link(name = "lua52", kind = "raw-dylib"))]
85unsafe extern "C-unwind" {
86    pub fn luaL_loadbufferx(
87        L: *mut lua_State,
88        buff: *const c_char,
89        sz: usize,
90        name: *const c_char,
91        mode: *const c_char,
92    ) -> c_int;
93    pub fn luaL_loadstring(L: *mut lua_State, s: *const c_char) -> c_int;
94
95    pub fn luaL_newstate() -> *mut lua_State;
96
97    pub fn luaL_len(L: *mut lua_State, idx: c_int) -> lua_Integer;
98
99    pub fn luaL_gsub(
100        L: *mut lua_State,
101        s: *const c_char,
102        p: *const c_char,
103        r: *const c_char,
104    ) -> *const c_char;
105
106    pub fn luaL_setfuncs(L: *mut lua_State, l: *const luaL_Reg, nup: c_int);
107
108    pub fn luaL_getsubtable(L: *mut lua_State, idx: c_int, fname: *const c_char) -> c_int;
109
110    pub fn luaL_traceback(L: *mut lua_State, L1: *mut lua_State, msg: *const c_char, level: c_int);
111
112    #[link_name = "luaL_requiref"]
113    pub fn luaL_requiref_(L: *mut lua_State, modname: *const c_char, openf: lua_CFunction, glb: c_int);
114}
115
116//
117// Some useful macros (implemented as Rust functions)
118//
119
120// TODO: luaL_newlibtable, luaL_newlib
121
122#[inline(always)]
123pub unsafe fn luaL_argcheck(L: *mut lua_State, cond: c_int, arg: c_int, extramsg: *const c_char) {
124    if cond == 0 {
125        luaL_argerror(L, arg, extramsg);
126    }
127}
128
129#[inline(always)]
130pub unsafe fn luaL_checkstring(L: *mut lua_State, n: c_int) -> *const c_char {
131    luaL_checklstring(L, n, ptr::null_mut())
132}
133
134#[inline(always)]
135pub unsafe fn luaL_optstring(L: *mut lua_State, n: c_int, d: *const c_char) -> *const c_char {
136    luaL_optlstring(L, n, d, ptr::null_mut())
137}
138
139#[inline(always)]
140pub unsafe fn luaL_typename(L: *mut lua_State, i: c_int) -> *const c_char {
141    lua::lua_typename(L, lua::lua_type(L, i))
142}
143
144#[inline(always)]
145pub unsafe fn luaL_dofile(L: *mut lua_State, filename: *const c_char) -> c_int {
146    let status = luaL_loadfile(L, filename);
147    if status == 0 {
148        lua::lua_pcall(L, 0, lua::LUA_MULTRET, 0)
149    } else {
150        status
151    }
152}
153
154#[inline(always)]
155pub unsafe fn luaL_dostring(L: *mut lua_State, s: *const c_char) -> c_int {
156    let status = luaL_loadstring(L, s);
157    if status == 0 {
158        lua::lua_pcall(L, 0, lua::LUA_MULTRET, 0)
159    } else {
160        status
161    }
162}
163
164#[inline(always)]
165pub unsafe fn luaL_getmetatable(L: *mut lua_State, n: *const c_char) {
166    lua::lua_getfield_(L, lua::LUA_REGISTRYINDEX, n);
167}
168
169#[inline(always)]
170pub unsafe fn luaL_loadbuffer(L: *mut lua_State, s: *const c_char, sz: usize, n: *const c_char) -> c_int {
171    luaL_loadbufferx(L, s, sz, n, ptr::null())
172}
173
174#[inline(always)]
175pub unsafe fn luaL_opt<T>(
176    L: *mut lua_State,
177    f: unsafe extern "C-unwind" fn(*mut lua_State, c_int) -> T,
178    n: c_int,
179    d: T,
180) -> T {
181    if lua::lua_isnoneornil(L, n) != 0 {
182        d
183    } else {
184        f(L, n)
185    }
186}
187
188//
189// Generic Buffer Manipulation
190//
191
192#[cfg(target_arch = "wasm32")]
193const BUFSIZ: usize = 1024; // WASI libc's BUFSIZ is 1024
194#[cfg(not(target_arch = "wasm32"))]
195const BUFSIZ: usize = libc::BUFSIZ as usize;
196
197// The buffer size used by the lauxlib buffer system.
198// The "16384" workaround is taken from the LuaJIT source code.
199pub const LUAL_BUFFERSIZE: usize = if BUFSIZ > 16384 { 8192 } else { BUFSIZ };
200
201#[repr(C)]
202pub struct luaL_Buffer {
203    pub b: *mut c_char, // buffer address
204    pub size: usize,    // buffer size
205    pub n: usize,       // number of characters in buffer
206    pub L: *mut lua_State,
207    pub initb: [c_char; LUAL_BUFFERSIZE], // initial buffer space
208}
209
210#[cfg_attr(all(windows, raw_dylib), link(name = "lua52", kind = "raw-dylib"))]
211unsafe extern "C-unwind" {
212    pub fn luaL_buffinit(L: *mut lua_State, B: *mut luaL_Buffer);
213    pub fn luaL_prepbuffsize(B: *mut luaL_Buffer, sz: usize) -> *mut c_char;
214    pub fn luaL_addlstring(B: *mut luaL_Buffer, s: *const c_char, l: usize);
215    pub fn luaL_addstring(B: *mut luaL_Buffer, s: *const c_char);
216    pub fn luaL_addvalue(B: *mut luaL_Buffer);
217    pub fn luaL_pushresult(B: *mut luaL_Buffer);
218    pub fn luaL_pushresultsize(B: *mut luaL_Buffer, sz: usize);
219    pub fn luaL_buffinitsize(L: *mut lua_State, B: *mut luaL_Buffer, sz: usize) -> *mut c_char;
220}
221
222// Macro implementations as inline functions
223
224#[inline(always)]
225pub unsafe fn luaL_prepbuffer(B: *mut luaL_Buffer) -> *mut c_char {
226    luaL_prepbuffsize(B, LUAL_BUFFERSIZE)
227}
228
229#[inline(always)]
230pub unsafe fn luaL_addchar(B: *mut luaL_Buffer, c: c_char) {
231    if (*B).n >= (*B).size {
232        luaL_prepbuffsize(B, 1);
233    }
234    *(*B).b.add((*B).n) = c;
235    (*B).n += 1;
236}
237
238#[inline(always)]
239pub unsafe fn luaL_addsize(B: *mut luaL_Buffer, n: usize) {
240    (*B).n += n;
241}