factorio_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::{
7    self, lua_CFunction, lua_Integer, lua_Number, lua_State, lua_Unsigned, LUA_REGISTRYINDEX,
8};
9
10#[repr(C)]
11pub struct luaL_Reg {
12    pub name: *const c_char,
13    pub func: lua_CFunction,
14}
15
16extern "C" {
17    pub fn luaL_register(L: *mut lua_State, libname: *const c_char, l: *const luaL_Reg);
18    #[link_name = "luaL_getmetafield"]
19    pub fn luaL_getmetafield_(L: *mut lua_State, obj: c_int, e: *const c_char) -> c_int;
20    pub fn luaL_callmeta(L: *mut lua_State, obj: c_int, e: *const c_char) -> c_int;
21    #[link_name = "luaL_typeerrorL"]
22    pub fn luaL_typeerror(L: *mut lua_State, narg: c_int, tname: *const c_char) -> !;
23    #[link_name = "luaL_argerrorL"]
24    pub fn luaL_argerror(L: *mut lua_State, narg: c_int, extramsg: *const c_char) -> !;
25    pub fn luaL_checklstring(L: *mut lua_State, narg: c_int, l: *mut usize) -> *const c_char;
26    pub fn luaL_optlstring(
27        L: *mut lua_State,
28        narg: c_int,
29        def: *const c_char,
30        l: *mut usize,
31    ) -> *const c_char;
32    pub fn luaL_checknumber(L: *mut lua_State, narg: c_int) -> lua_Number;
33    pub fn luaL_optnumber(L: *mut lua_State, narg: c_int, def: lua_Number) -> lua_Number;
34
35    pub fn luaL_checkboolean(L: *mut lua_State, narg: c_int) -> c_int;
36    pub fn luaL_optboolean(L: *mut lua_State, narg: c_int, def: c_int) -> c_int;
37
38    pub fn luaL_checkinteger(L: *mut lua_State, narg: c_int) -> lua_Integer;
39    pub fn luaL_optinteger(L: *mut lua_State, narg: c_int, def: lua_Integer) -> lua_Integer;
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_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    lua_getmetatable(L, -1);
146    lua_setreadonly(L, -1, enabled);
147    lua_pop(L, 2);
148
149    // set globals to readonly and activate safeenv since the env is immutable
150    lua_setreadonly(L, LUA_GLOBALSINDEX, enabled);
151    lua_setsafeenv(L, LUA_GLOBALSINDEX, enabled);
152}
153
154//
155// TODO: Generic Buffer Manipulation
156//