mlua_sys/lua54/
lauxlib.rs

1//! Contains definitions from `lauxlib.h`.
2
3use std::os::raw::{c_char, c_double, c_int, c_long, 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 = "lua54", 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}
61
62// Pre-defined references
63pub const LUA_NOREF: c_int = -2;
64pub const LUA_REFNIL: c_int = -1;
65
66#[cfg_attr(all(windows, raw_dylib), link(name = "lua54", kind = "raw-dylib"))]
67unsafe extern "C-unwind" {
68    pub fn luaL_ref(L: *mut lua_State, t: c_int) -> c_int;
69    pub fn luaL_unref(L: *mut lua_State, t: c_int, r#ref: c_int);
70
71    pub fn luaL_loadfilex(L: *mut lua_State, filename: *const c_char, mode: *const c_char) -> c_int;
72}
73
74#[inline(always)]
75pub unsafe fn luaL_loadfile(L: *mut lua_State, f: *const c_char) -> c_int {
76    luaL_loadfilex(L, f, ptr::null())
77}
78
79#[cfg_attr(all(windows, raw_dylib), link(name = "lua54", kind = "raw-dylib"))]
80unsafe extern "C-unwind" {
81    pub fn luaL_loadbufferx(
82        L: *mut lua_State,
83        buff: *const c_char,
84        sz: usize,
85        name: *const c_char,
86        mode: *const c_char,
87    ) -> c_int;
88    pub fn luaL_loadstring(L: *mut lua_State, s: *const c_char) -> c_int;
89
90    pub fn luaL_newstate() -> *mut lua_State;
91
92    pub fn luaL_len(L: *mut lua_State, idx: c_int) -> lua_Integer;
93
94    pub fn luaL_addgsub(B: *mut luaL_Buffer, s: *const c_char, p: *const c_char, r: *const c_char);
95
96    pub fn luaL_gsub(
97        L: *mut lua_State,
98        s: *const c_char,
99        p: *const c_char,
100        r: *const c_char,
101    ) -> *const c_char;
102
103    pub fn luaL_setfuncs(L: *mut lua_State, l: *const luaL_Reg, nup: c_int);
104
105    pub fn luaL_getsubtable(L: *mut lua_State, idx: c_int, fname: *const c_char) -> c_int;
106
107    pub fn luaL_traceback(L: *mut lua_State, L1: *mut lua_State, msg: *const c_char, level: c_int);
108
109    pub fn luaL_requiref(L: *mut lua_State, modname: *const c_char, openf: lua_CFunction, glb: c_int);
110}
111
112//
113// Some useful macros (implemented as Rust functions)
114//
115
116// TODO: luaL_newlibtable, luaL_newlib
117
118#[inline(always)]
119pub unsafe fn luaL_argcheck(L: *mut lua_State, cond: c_int, arg: c_int, extramsg: *const c_char) {
120    if cond == 0 {
121        luaL_argerror(L, arg, extramsg);
122    }
123}
124
125#[inline(always)]
126pub unsafe fn luaL_checkstring(L: *mut lua_State, n: c_int) -> *const c_char {
127    luaL_checklstring(L, n, ptr::null_mut())
128}
129
130#[inline(always)]
131pub unsafe fn luaL_optstring(L: *mut lua_State, n: c_int, d: *const c_char) -> *const c_char {
132    luaL_optlstring(L, n, d, ptr::null_mut())
133}
134
135#[inline(always)]
136pub unsafe fn luaL_typename(L: *mut lua_State, i: c_int) -> *const c_char {
137    lua::lua_typename(L, lua::lua_type(L, i))
138}
139
140#[inline(always)]
141pub unsafe fn luaL_dofile(L: *mut lua_State, filename: *const c_char) -> c_int {
142    let status = luaL_loadfile(L, filename);
143    if status == 0 {
144        lua::lua_pcall(L, 0, lua::LUA_MULTRET, 0)
145    } else {
146        status
147    }
148}
149
150#[inline(always)]
151pub unsafe fn luaL_dostring(L: *mut lua_State, s: *const c_char) -> c_int {
152    let status = luaL_loadstring(L, s);
153    if status == 0 {
154        lua::lua_pcall(L, 0, lua::LUA_MULTRET, 0)
155    } else {
156        status
157    }
158}
159
160#[inline(always)]
161pub unsafe fn luaL_getmetatable(L: *mut lua_State, n: *const c_char) {
162    lua::lua_getfield(L, lua::LUA_REGISTRYINDEX, n);
163}
164
165#[inline(always)]
166pub unsafe fn luaL_loadbuffer(L: *mut lua_State, s: *const c_char, sz: usize, n: *const c_char) -> c_int {
167    luaL_loadbufferx(L, s, sz, n, ptr::null())
168}
169
170pub unsafe fn luaL_loadbufferenv(
171    L: *mut lua_State,
172    data: *const c_char,
173    size: usize,
174    name: *const c_char,
175    mode: *const c_char,
176    mut env: c_int,
177) -> c_int {
178    if env != 0 {
179        env = lua::lua_absindex(L, env);
180    }
181    let status = luaL_loadbufferx(L, data, size, name, mode);
182    if status == lua::LUA_OK && env != 0 {
183        lua::lua_pushvalue(L, env);
184        lua::lua_setupvalue(L, -2, 1);
185    }
186    status
187}
188
189#[inline(always)]
190pub unsafe fn luaL_opt<T>(
191    L: *mut lua_State,
192    f: unsafe extern "C-unwind" fn(*mut lua_State, c_int) -> T,
193    n: c_int,
194    d: T,
195) -> T {
196    if lua::lua_isnoneornil(L, n) != 0 {
197        d
198    } else {
199        f(L, n)
200    }
201}
202
203//
204// Generic Buffer Manipulation
205//
206
207// The buffer size used by the lauxlib buffer system.
208// LUAL_BUFFERSIZE = (int)(16 * sizeof(void*) * sizeof(lua_Number))
209#[rustfmt::skip]
210pub const LUAL_BUFFERSIZE: usize = 16 * mem::size_of::<*const ()>() * mem::size_of::<lua_Number>();
211
212// Union used for the initial buffer with maximum alignment.
213// This ensures proper alignment for the buffer data.
214#[repr(C)]
215pub union luaL_BufferInit {
216    // Alignment matches LUAI_MAXALIGN
217    pub _align_n: lua_Number,
218    pub _align_u: c_double,
219    pub _align_s: *mut c_void,
220    pub _align_i: lua_Integer,
221    pub _align_l: c_long,
222    // Initial buffer space
223    pub b: [c_char; LUAL_BUFFERSIZE],
224}
225
226#[repr(C)]
227pub struct luaL_Buffer {
228    pub b: *mut c_char, // buffer address
229    pub size: usize,    // buffer size
230    pub n: usize,       // number of characters in buffer
231    pub L: *mut lua_State,
232    pub init: luaL_BufferInit, // initial buffer (union with alignment)
233}
234
235#[cfg_attr(all(windows, raw_dylib), link(name = "lua54", kind = "raw-dylib"))]
236unsafe extern "C-unwind" {
237    pub fn luaL_buffinit(L: *mut lua_State, B: *mut luaL_Buffer);
238    pub fn luaL_prepbuffsize(B: *mut luaL_Buffer, sz: usize) -> *mut c_char;
239    pub fn luaL_addlstring(B: *mut luaL_Buffer, s: *const c_char, l: usize);
240    pub fn luaL_addstring(B: *mut luaL_Buffer, s: *const c_char);
241    pub fn luaL_addvalue(B: *mut luaL_Buffer);
242    pub fn luaL_pushresult(B: *mut luaL_Buffer);
243    pub fn luaL_pushresultsize(B: *mut luaL_Buffer, sz: usize);
244    pub fn luaL_buffinitsize(L: *mut lua_State, B: *mut luaL_Buffer, sz: usize) -> *mut c_char;
245}
246
247// Macro implementations as inline functions
248
249#[inline(always)]
250pub unsafe fn luaL_prepbuffer(B: *mut luaL_Buffer) -> *mut c_char {
251    luaL_prepbuffsize(B, LUAL_BUFFERSIZE)
252}
253
254#[inline(always)]
255pub unsafe fn luaL_addchar(B: *mut luaL_Buffer, c: c_char) {
256    if (*B).n >= (*B).size {
257        luaL_prepbuffsize(B, 1);
258    }
259    *(*B).b.add((*B).n) = c;
260    (*B).n += 1;
261}
262
263#[inline(always)]
264pub unsafe fn luaL_addsize(B: *mut luaL_Buffer, n: usize) {
265    (*B).n += n;
266}
267
268#[inline(always)]
269pub unsafe fn luaL_buffsub(B: *mut luaL_Buffer, n: usize) {
270    (*B).n -= n;
271}
272
273#[inline(always)]
274pub unsafe fn luaL_bufflen(B: *mut luaL_Buffer) -> usize {
275    (*B).n
276}
277
278#[inline(always)]
279pub unsafe fn luaL_buffaddr(B: *mut luaL_Buffer) -> *mut c_char {
280    (*B).b
281}
mlua_sys/lua54/lauxlib.rs

mlua_sys/lua54/
lauxlib.rs
