Skip to main content

mlua_sys/lua55/
lauxlib.rs

1//! Contains definitions from `lauxlib.h`.
2
3use std::os::raw::{c_char, c_double, c_int, c_long, c_uint, c_void};
4use std::{mem, ptr};
5
6use super::lua::{self, lua_CFunction, lua_Integer, lua_Number, lua_State};
7
8// Extra error code for 'luaL_loadfilex'
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 = "lua55", kind = "raw-dylib"))]
24unsafe extern "C-unwind" {
25    pub fn luaL_checkversion_(L: *mut lua_State, ver: lua_Number, sz: usize);
26
27    pub fn luaL_getmetafield(L: *mut lua_State, obj: c_int, e: *const c_char) -> c_int;
28    pub fn luaL_callmeta(L: *mut lua_State, obj: c_int, e: *const c_char) -> c_int;
29    pub fn luaL_tolstring(L: *mut lua_State, idx: c_int, len: *mut usize) -> *const c_char;
30    pub fn luaL_argerror(L: *mut lua_State, arg: c_int, extramsg: *const c_char) -> c_int;
31    pub fn luaL_checklstring(L: *mut lua_State, arg: c_int, l: *mut usize) -> *const c_char;
32    pub fn luaL_optlstring(L: *mut lua_State, arg: c_int, def: *const c_char, l: *mut usize)
33    -> *const c_char;
34    pub fn luaL_checknumber(L: *mut lua_State, arg: c_int) -> lua_Number;
35    pub fn luaL_optnumber(L: *mut lua_State, arg: c_int, def: lua_Number) -> lua_Number;
36    pub fn luaL_checkinteger(L: *mut lua_State, arg: c_int) -> lua_Integer;
37    pub fn luaL_optinteger(L: *mut lua_State, arg: c_int, def: lua_Integer) -> lua_Integer;
38
39    pub fn luaL_checkstack(L: *mut lua_State, sz: c_int, msg: *const c_char);
40    pub fn luaL_checktype(L: *mut lua_State, arg: c_int, t: c_int);
41    pub fn luaL_checkany(L: *mut lua_State, arg: c_int);
42
43    pub fn luaL_newmetatable(L: *mut lua_State, tname: *const c_char) -> c_int;
44    pub fn luaL_setmetatable(L: *mut lua_State, tname: *const c_char);
45    pub fn luaL_testudata(L: *mut lua_State, ud: c_int, tname: *const c_char) -> *mut c_void;
46    pub fn luaL_checkudata(L: *mut lua_State, ud: c_int, tname: *const c_char) -> *mut c_void;
47
48    pub fn luaL_where(L: *mut lua_State, lvl: c_int);
49    pub fn luaL_error(L: *mut lua_State, fmt: *const c_char, ...) -> c_int;
50
51    pub fn luaL_checkoption(
52        L: *mut lua_State,
53        arg: c_int,
54        def: *const c_char,
55        lst: *const *const c_char,
56    ) -> c_int;
57
58    pub fn luaL_fileresult(L: *mut lua_State, stat: c_int, fname: *const c_char) -> c_int;
59    pub fn luaL_execresult(L: *mut lua_State, stat: c_int) -> c_int;
60    pub fn luaL_alloc(L: *mut lua_State, ptr: *mut c_void, osize: usize, nsize: usize) -> *mut c_void;
61}
62
63// Pre-defined references
64pub const LUA_NOREF: c_int = -2;
65pub const LUA_REFNIL: c_int = -1;
66
67#[cfg_attr(all(windows, raw_dylib), link(name = "lua55", kind = "raw-dylib"))]
68unsafe extern "C-unwind" {
69    pub fn luaL_ref(L: *mut lua_State, t: c_int) -> c_int;
70    pub fn luaL_unref(L: *mut lua_State, t: c_int, r#ref: c_int);
71
72    pub fn luaL_loadfilex(L: *mut lua_State, filename: *const c_char, mode: *const c_char) -> c_int;
73}
74
75#[inline(always)]
76pub unsafe fn luaL_loadfile(L: *mut lua_State, f: *const c_char) -> c_int {
77    luaL_loadfilex(L, f, ptr::null())
78}
79
80#[cfg_attr(all(windows, raw_dylib), link(name = "lua55", kind = "raw-dylib"))]
81unsafe extern "C-unwind" {
82    pub fn luaL_loadbufferx(
83        L: *mut lua_State,
84        buff: *const c_char,
85        sz: usize,
86        name: *const c_char,
87        mode: *const c_char,
88    ) -> c_int;
89    pub fn luaL_loadstring(L: *mut lua_State, s: *const c_char) -> c_int;
90
91    pub fn luaL_newstate() -> *mut lua_State;
92
93    #[link_name = "luaL_makeseed"]
94    pub fn luaL_makeseed_(L: *mut lua_State) -> c_uint;
95
96    pub fn luaL_len(L: *mut lua_State, idx: c_int) -> lua_Integer;
97
98    pub fn luaL_addgsub(B: *mut luaL_Buffer, s: *const c_char, p: *const c_char, r: *const c_char);
99
100    pub fn luaL_gsub(
101        L: *mut lua_State,
102        s: *const c_char,
103        p: *const c_char,
104        r: *const c_char,
105    ) -> *const c_char;
106
107    pub fn luaL_setfuncs(L: *mut lua_State, l: *const luaL_Reg, nup: c_int);
108
109    pub fn luaL_getsubtable(L: *mut lua_State, idx: c_int, fname: *const c_char) -> c_int;
110
111    pub fn luaL_traceback(L: *mut lua_State, L1: *mut lua_State, msg: *const c_char, level: c_int);
112
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
174pub unsafe fn luaL_loadbufferenv(
175    L: *mut lua_State,
176    data: *const c_char,
177    size: usize,
178    name: *const c_char,
179    mode: *const c_char,
180    mut env: c_int,
181) -> c_int {
182    if env != 0 {
183        env = lua::lua_absindex(L, env);
184    }
185    let status = luaL_loadbufferx(L, data, size, name, mode);
186    if status == lua::LUA_OK && env != 0 {
187        lua::lua_pushvalue(L, env);
188        lua::lua_setupvalue(L, -2, 1);
189    }
190    status
191}
192
193pub unsafe fn luaL_makeseed(L: *mut lua_State) -> c_uint {
194    #[cfg(macos)]
195    return libc::arc4random();
196    #[cfg(linux)]
197    {
198        let mut seed = 0u32;
199        let buf = &mut seed as *mut _ as *mut c_void;
200        if libc::getrandom(buf, 4, libc::GRND_NONBLOCK) == 4 {
201            return seed;
202        }
203    }
204    luaL_makeseed_(L)
205}
206
207#[inline(always)]
208pub unsafe fn luaL_opt<T>(
209    L: *mut lua_State,
210    f: unsafe extern "C-unwind" fn(*mut lua_State, c_int) -> T,
211    n: c_int,
212    d: T,
213) -> T {
214    if lua::lua_isnoneornil(L, n) != 0 {
215        d
216    } else {
217        f(L, n)
218    }
219}
220
221//
222// Generic Buffer Manipulation
223//
224
225// The buffer size used by the lauxlib buffer system.
226// LUAL_BUFFERSIZE = (int)(16 * sizeof(void*) * sizeof(lua_Number))
227#[rustfmt::skip]
228pub const LUAL_BUFFERSIZE: usize = 16 * mem::size_of::<*const ()>() * mem::size_of::<lua_Number>();
229
230// Union used for the initial buffer with maximum alignment.
231// This ensures proper alignment for the buffer data.
232#[repr(C)]
233pub union luaL_BufferInit {
234    // Alignment matches LUAI_MAXALIGN
235    pub _align_n: lua_Number,
236    pub _align_u: c_double,
237    pub _align_s: *mut c_void,
238    pub _align_i: lua_Integer,
239    pub _align_l: c_long,
240    // Initial buffer space
241    pub b: [c_char; LUAL_BUFFERSIZE],
242}
243
244#[repr(C)]
245pub struct luaL_Buffer {
246    pub b: *mut c_char, // buffer address
247    pub size: usize,    // buffer size
248    pub n: usize,       // number of characters in buffer
249    pub L: *mut lua_State,
250    pub init: luaL_BufferInit, // initial buffer (union with alignment)
251}
252
253#[cfg_attr(all(windows, raw_dylib), link(name = "lua55", kind = "raw-dylib"))]
254unsafe extern "C-unwind" {
255    pub fn luaL_buffinit(L: *mut lua_State, B: *mut luaL_Buffer);
256    pub fn luaL_prepbuffsize(B: *mut luaL_Buffer, sz: usize) -> *mut c_char;
257    pub fn luaL_addlstring(B: *mut luaL_Buffer, s: *const c_char, l: usize);
258    pub fn luaL_addstring(B: *mut luaL_Buffer, s: *const c_char);
259    pub fn luaL_addvalue(B: *mut luaL_Buffer);
260    pub fn luaL_pushresult(B: *mut luaL_Buffer);
261    pub fn luaL_pushresultsize(B: *mut luaL_Buffer, sz: usize);
262    pub fn luaL_buffinitsize(L: *mut lua_State, B: *mut luaL_Buffer, sz: usize) -> *mut c_char;
263}
264
265// Macro implementations as inline functions
266
267#[inline(always)]
268pub unsafe fn luaL_prepbuffer(B: *mut luaL_Buffer) -> *mut c_char {
269    luaL_prepbuffsize(B, LUAL_BUFFERSIZE)
270}
271
272#[inline(always)]
273pub unsafe fn luaL_addchar(B: *mut luaL_Buffer, c: c_char) {
274    if (*B).n >= (*B).size {
275        luaL_prepbuffsize(B, 1);
276    }
277    *(*B).b.add((*B).n) = c;
278    (*B).n += 1;
279}
280
281#[inline(always)]
282pub unsafe fn luaL_addsize(B: *mut luaL_Buffer, n: usize) {
283    (*B).n += n;
284}
285
286#[inline(always)]
287pub unsafe fn luaL_buffsub(B: *mut luaL_Buffer, n: usize) {
288    (*B).n -= n;
289}
290
291#[inline(always)]
292pub unsafe fn luaL_bufflen(B: *mut luaL_Buffer) -> usize {
293    (*B).n
294}
295
296#[inline(always)]
297pub unsafe fn luaL_buffaddr(B: *mut luaL_Buffer) -> *mut c_char {
298    (*B).b
299}