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