Skip to main content

mlua_sys/luau/
lauxlib.rs

1//! Contains definitions from `lualib.h`.
2
3use std::os::raw::{c_char, c_float, c_int, c_void};
4use std::ptr;
5
6use super::lua::{self, LUA_REGISTRYINDEX, lua_CFunction, lua_Number, lua_State, lua_Unsigned};
7
8// Key, in the registry, for table of loaded modules
9pub const LUA_LOADED_TABLE: *const c_char = cstr!("_LOADED");
10
11#[repr(C)]
12pub struct luaL_Reg {
13    pub name: *const c_char,
14    pub func: lua_CFunction,
15}
16
17unsafe extern "C-unwind" {
18    pub fn luaL_register(L: *mut lua_State, libname: *const c_char, l: *const luaL_Reg);
19    #[link_name = "luaL_getmetafield"]
20    pub fn luaL_getmetafield_(L: *mut lua_State, obj: c_int, e: *const c_char) -> c_int;
21    pub fn luaL_callmeta(L: *mut lua_State, obj: c_int, e: *const c_char) -> c_int;
22    #[link_name = "luaL_typeerrorL"]
23    pub fn luaL_typeerror(L: *mut lua_State, narg: c_int, tname: *const c_char) -> !;
24    #[link_name = "luaL_argerrorL"]
25    pub fn luaL_argerror(L: *mut lua_State, narg: c_int, extramsg: *const c_char) -> !;
26    pub fn luaL_checklstring(L: *mut lua_State, narg: c_int, l: *mut usize) -> *const c_char;
27    pub fn luaL_optlstring(
28        L: *mut lua_State,
29        narg: c_int,
30        def: *const c_char,
31        l: *mut usize,
32    ) -> *const c_char;
33    pub fn luaL_checknumber(L: *mut lua_State, narg: c_int) -> lua_Number;
34    pub fn luaL_optnumber(L: *mut lua_State, narg: c_int, def: lua_Number) -> lua_Number;
35
36    pub fn luaL_checkboolean(L: *mut lua_State, narg: c_int) -> c_int;
37    pub fn luaL_optboolean(L: *mut lua_State, narg: c_int, def: c_int) -> c_int;
38
39    #[link_name = "luaL_checkinteger"]
40    pub fn luaL_checkinteger_(L: *mut lua_State, narg: c_int) -> c_int;
41    pub fn luaL_checkinteger64(L: *mut lua_State, narg: c_int) -> i64;
42    #[link_name = "luaL_optinteger"]
43    pub fn luaL_optinteger_(L: *mut lua_State, narg: c_int, def: c_int) -> c_int;
44    pub fn luaL_optinteger64(L: *mut lua_State, narg: c_int, def: i64) -> i64;
45    pub fn luaL_checkunsigned(L: *mut lua_State, narg: c_int) -> lua_Unsigned;
46    pub fn luaL_optunsigned(L: *mut lua_State, narg: c_int, def: lua_Unsigned) -> lua_Unsigned;
47
48    pub fn luaL_checkvector(L: *mut lua_State, narg: c_int) -> *const c_float;
49    pub fn luaL_optvector(L: *mut lua_State, narg: c_int, def: *const c_float) -> *const c_float;
50
51    #[link_name = "luaL_checkstack"]
52    pub fn luaL_checkstack_(L: *mut lua_State, sz: c_int, msg: *const c_char);
53    pub fn luaL_checktype(L: *mut lua_State, narg: c_int, t: c_int);
54    pub fn luaL_checkany(L: *mut lua_State, narg: c_int);
55
56    #[link_name = "luaL_newmetatable"]
57    pub fn luaL_newmetatable_(L: *mut lua_State, tname: *const c_char) -> c_int;
58    pub fn luaL_checkudata(L: *mut lua_State, ud: c_int, tname: *const c_char) -> *mut c_void;
59
60    pub fn luaL_checkbuffer(L: *mut lua_State, narg: c_int, len: *mut usize) -> *mut c_void;
61
62    pub fn luaL_where(L: *mut lua_State, lvl: c_int);
63
64    #[link_name = "luaL_errorL"]
65    pub fn luaL_error(L: *mut lua_State, fmt: *const c_char, ...) -> !;
66
67    pub fn luaL_checkoption(
68        L: *mut lua_State,
69        narg: c_int,
70        def: *const c_char,
71        lst: *const *const c_char,
72    ) -> c_int;
73
74    #[link_name = "luaL_tolstring"]
75    pub fn luaL_tolstring_(L: *mut lua_State, idx: c_int, len: *mut usize) -> *const c_char;
76
77    pub fn luaL_newstate() -> *mut lua_State;
78
79    pub fn luaL_findtable(
80        L: *mut lua_State,
81        idx: c_int,
82        fname: *const c_char,
83        szhint: c_int,
84    ) -> *const c_char;
85
86    pub fn luaL_typename(L: *mut lua_State, idx: c_int) -> *const c_char;
87
88    pub fn luaL_callyieldable(L: *mut lua_State, nargs: c_int, nresults: c_int) -> c_int;
89
90    #[link_name = "luaL_traceback"]
91    pub fn luaL_traceback_(L: *mut lua_State, L1: *mut lua_State, msg: *const c_char, level: c_int);
92
93    // sandbox libraries and globals
94    #[link_name = "luaL_sandbox"]
95    pub fn luaL_sandbox_(L: *mut lua_State);
96    pub fn luaL_sandboxthread(L: *mut lua_State);
97}
98
99//
100// Some useful macros (implemented as Rust functions)
101//
102
103#[inline(always)]
104pub unsafe fn luaL_argcheck(L: *mut lua_State, cond: c_int, arg: c_int, extramsg: *const c_char) {
105    if cond == 0 {
106        luaL_argerror(L, arg, extramsg);
107    }
108}
109
110#[inline(always)]
111pub unsafe fn luaL_argexpected(L: *mut lua_State, cond: c_int, arg: c_int, tname: *const c_char) {
112    if cond == 0 {
113        luaL_typeerror(L, arg, tname);
114    }
115}
116
117#[inline(always)]
118pub unsafe fn luaL_checkstring(L: *mut lua_State, n: c_int) -> *const c_char {
119    luaL_checklstring(L, n, ptr::null_mut())
120}
121
122#[inline(always)]
123pub unsafe fn luaL_optstring(L: *mut lua_State, n: c_int, d: *const c_char) -> *const c_char {
124    luaL_optlstring(L, n, d, ptr::null_mut())
125}
126
127#[inline(always)]
128pub unsafe fn luaL_opt<T>(
129    L: *mut lua_State,
130    f: unsafe extern "C-unwind" fn(*mut lua_State, c_int) -> T,
131    n: c_int,
132    d: T,
133) -> T {
134    if lua::lua_isnoneornil(L, n) != 0 {
135        d
136    } else {
137        f(L, n)
138    }
139}
140
141#[inline(always)]
142pub unsafe fn luaL_getmetatable(L: *mut lua_State, n: *const c_char) -> c_int {
143    lua::lua_getfield(L, LUA_REGISTRYINDEX, n)
144}
145
146#[inline(always)]
147pub unsafe fn luaL_ref(L: *mut lua_State, t: c_int) -> c_int {
148    assert_eq!(t, LUA_REGISTRYINDEX);
149    let r = lua::lua_ref(L, -1);
150    lua::lua_pop(L, 1);
151    r
152}
153
154#[inline(always)]
155pub unsafe fn luaL_unref(L: *mut lua_State, t: c_int, r#ref: c_int) {
156    assert_eq!(t, LUA_REGISTRYINDEX);
157    lua::lua_unref(L, r#ref)
158}
159
160pub unsafe fn luaL_sandbox(L: *mut lua_State, enabled: c_int) {
161    use super::lua::*;
162
163    // set all libraries to read-only
164    lua_pushnil(L);
165    while lua_next(L, LUA_GLOBALSINDEX) != 0 {
166        if lua_istable(L, -1) != 0 {
167            lua_setreadonly(L, -1, enabled);
168        }
169        lua_pop(L, 1);
170    }
171
172    // set all builtin metatables to read-only
173    lua_pushliteral(L, c"");
174    if lua_getmetatable(L, -1) != 0 {
175        lua_setreadonly(L, -1, enabled);
176        lua_pop(L, 2);
177    } else {
178        lua_pop(L, 1);
179    }
180
181    // set globals to readonly and activate safeenv since the env is immutable
182    lua_setreadonly(L, LUA_GLOBALSINDEX, enabled);
183    lua_setsafeenv(L, LUA_GLOBALSINDEX, enabled);
184}
185
186//
187// Generic Buffer Manipulation
188//
189
190/// Buffer size used for on-stack string operations. This limit depends on native stack size.
191pub const LUA_BUFFERSIZE: usize = 512;
192
193#[repr(C)]
194pub struct luaL_Strbuf {
195    p: *mut c_char,   // current position in buffer
196    end: *mut c_char, // end of the current buffer
197    L: *mut lua_State,
198    storage: *mut c_void, // TString
199    buffer: [c_char; LUA_BUFFERSIZE],
200}
201
202// For compatibility
203pub type luaL_Buffer = luaL_Strbuf;
204
205unsafe extern "C-unwind" {
206    pub fn luaL_buffinit(L: *mut lua_State, B: *mut luaL_Strbuf);
207    pub fn luaL_buffinitsize(L: *mut lua_State, B: *mut luaL_Strbuf, size: usize) -> *mut c_char;
208    pub fn luaL_prepbuffsize(B: *mut luaL_Strbuf, size: usize) -> *mut c_char;
209    pub fn luaL_addlstring(B: *mut luaL_Strbuf, s: *const c_char, l: usize);
210    pub fn luaL_addvalue(B: *mut luaL_Strbuf);
211    pub fn luaL_addvalueany(B: *mut luaL_Strbuf, idx: c_int);
212    pub fn luaL_pushresult(B: *mut luaL_Strbuf);
213    pub fn luaL_pushresultsize(B: *mut luaL_Strbuf, size: usize);
214}
215
216pub unsafe fn luaL_addchar(B: *mut luaL_Strbuf, c: c_char) {
217    if (*B).p >= (*B).end {
218        luaL_prepbuffsize(B, 1);
219    }
220    *(*B).p = c;
221    (*B).p = (*B).p.add(1);
222}
223
224pub unsafe fn luaL_addstring(B: *mut luaL_Strbuf, s: *const c_char) {
225    // Calculate length of s
226    let mut len = 0;
227    while *s.add(len) != 0 {
228        len += 1;
229    }
230    luaL_addlstring(B, s, len);
231}
232
233pub unsafe fn luaL_addunsigned(B: *mut luaL_Strbuf, mut n: lua_Unsigned) {
234    let mut buf: [c_char; 32] = [0; 32];
235    let mut i = 32;
236    loop {
237        i -= 1;
238        let digit = (n % 10) as u8;
239        buf[i] = (b'0' + digit) as c_char;
240        n /= 10;
241        if n == 0 {
242            break;
243        }
244    }
245    luaL_addlstring(B, buf.as_ptr().add(i), 32 - i);
246}