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