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