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

mlua_sys/luau/
lauxlib.rs
