factorio_mlua_sys/lua54/
lauxlib.rs

1//! Contains definitions from `lauxlib.h`.
2
3use std::os::raw::{c_char, c_int, c_void};
4use std::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: &str = "_LOADED";
13
14// Key, in the registry, for table of preloaded loaders
15pub const LUA_PRELOAD_TABLE: &str = "_PRELOAD";
16
17#[repr(C)]
18pub struct luaL_Reg {
19    pub name: *const c_char,
20    pub func: lua_CFunction,
21}
22
23extern "C" {
24    pub fn luaL_checkversion_(L: *mut lua_State, ver: lua_Number, sz: usize);
25
26    pub fn luaL_getmetafield(L: *mut lua_State, obj: c_int, e: *const c_char) -> c_int;
27    pub fn luaL_callmeta(L: *mut lua_State, obj: c_int, e: *const c_char) -> c_int;
28    pub fn luaL_tolstring(L: *mut lua_State, idx: c_int, len: *mut usize) -> *const c_char;
29    pub fn luaL_argerror(L: *mut lua_State, arg: c_int, extramsg: *const c_char) -> c_int;
30    pub fn luaL_checklstring(L: *mut lua_State, arg: c_int, l: *mut usize) -> *const c_char;
31    pub fn luaL_optlstring(
32        L: *mut lua_State,
33        arg: c_int,
34        def: *const c_char,
35        l: *mut usize,
36    ) -> *const c_char;
37    pub fn luaL_checknumber(L: *mut lua_State, arg: c_int) -> lua_Number;
38    pub fn luaL_optnumber(L: *mut lua_State, arg: c_int, def: lua_Number) -> lua_Number;
39    pub fn luaL_checkinteger(L: *mut lua_State, arg: c_int) -> lua_Integer;
40    pub fn luaL_optinteger(L: *mut lua_State, arg: c_int, def: lua_Integer) -> lua_Integer;
41
42    pub fn luaL_checkstack(L: *mut lua_State, sz: c_int, msg: *const c_char);
43    pub fn luaL_checktype(L: *mut lua_State, arg: c_int, t: c_int);
44    pub fn luaL_checkany(L: *mut lua_State, arg: c_int);
45
46    pub fn luaL_newmetatable(L: *mut lua_State, tname: *const c_char) -> c_int;
47    pub fn luaL_setmetatable(L: *mut lua_State, tname: *const c_char);
48    pub fn luaL_testudata(L: *mut lua_State, ud: c_int, tname: *const c_char) -> *mut c_void;
49    pub fn luaL_checkudata(L: *mut lua_State, ud: c_int, tname: *const c_char) -> *mut c_void;
50
51    pub fn luaL_where(L: *mut lua_State, lvl: c_int);
52    pub fn luaL_error(L: *mut lua_State, fmt: *const c_char, ...) -> !;
53
54    pub fn luaL_checkoption(
55        L: *mut lua_State,
56        arg: c_int,
57        def: *const c_char,
58        lst: *const *const c_char,
59    ) -> c_int;
60
61    pub fn luaL_fileresult(L: *mut lua_State, stat: c_int, fname: *const c_char) -> c_int;
62    pub fn luaL_execresult(L: *mut lua_State, stat: c_int) -> c_int;
63}
64
65// Pre-defined references
66pub const LUA_NOREF: c_int = -2;
67pub const LUA_REFNIL: c_int = -1;
68
69extern "C" {
70    pub fn luaL_ref(L: *mut lua_State, t: c_int) -> c_int;
71    pub fn luaL_unref(L: *mut lua_State, t: c_int, r#ref: c_int);
72
73    pub fn luaL_loadfilex(L: *mut lua_State, filename: *const c_char, mode: *const c_char)
74        -> c_int;
75}
76
77#[inline(always)]
78pub unsafe fn luaL_loadfile(L: *mut lua_State, f: *const c_char) -> c_int {
79    luaL_loadfilex(L, f, ptr::null())
80}
81
82extern "C" {
83    pub fn luaL_loadbufferx(
84        L: *mut lua_State,
85        buff: *const c_char,
86        sz: usize,
87        name: *const c_char,
88        mode: *const c_char,
89    ) -> c_int;
90    pub fn luaL_loadstring(L: *mut lua_State, s: *const c_char) -> c_int;
91
92    pub fn luaL_newstate() -> *mut lua_State;
93
94    pub fn luaL_len(L: *mut lua_State, idx: c_int) -> lua_Integer;
95
96    // TODO: luaL_addgsub
97
98    pub fn luaL_gsub(
99        L: *mut lua_State,
100        s: *const c_char,
101        p: *const c_char,
102        r: *const c_char,
103    ) -> *const c_char;
104
105    pub fn luaL_setfuncs(L: *mut lua_State, l: *const luaL_Reg, nup: c_int);
106
107    pub fn luaL_getsubtable(L: *mut lua_State, idx: c_int, fname: *const c_char) -> c_int;
108
109    pub fn luaL_traceback(L: *mut lua_State, L1: *mut lua_State, msg: *const c_char, level: c_int);
110
111    pub fn luaL_requiref(
112        L: *mut lua_State,
113        modname: *const c_char,
114        openf: lua_CFunction,
115        glb: c_int,
116    );
117}
118
119//
120// Some useful macros (implemented as Rust functions)
121//
122
123// TODO: luaL_newlibtable, luaL_newlib
124
125#[inline(always)]
126pub unsafe fn luaL_argcheck(L: *mut lua_State, cond: c_int, arg: c_int, extramsg: *const c_char) {
127    if cond == 0 {
128        luaL_argerror(L, arg, extramsg);
129    }
130}
131
132#[inline(always)]
133pub unsafe fn luaL_checkstring(L: *mut lua_State, n: c_int) -> *const c_char {
134    luaL_checklstring(L, n, ptr::null_mut())
135}
136
137#[inline(always)]
138pub unsafe fn luaL_optstring(L: *mut lua_State, n: c_int, d: *const c_char) -> *const c_char {
139    luaL_optlstring(L, n, d, ptr::null_mut())
140}
141
142#[inline(always)]
143pub unsafe fn luaL_typename(L: *mut lua_State, i: c_int) -> *const c_char {
144    lua::lua_typename(L, lua::lua_type(L, i))
145}
146
147#[inline(always)]
148pub unsafe fn luaL_dofile(L: *mut lua_State, filename: *const c_char) -> c_int {
149    let status = luaL_loadfile(L, filename);
150    if status == 0 {
151        lua::lua_pcall(L, 0, lua::LUA_MULTRET, 0)
152    } else {
153        status
154    }
155}
156
157#[inline(always)]
158pub unsafe fn luaL_dostring(L: *mut lua_State, s: *const c_char) -> c_int {
159    let status = luaL_loadstring(L, s);
160    if status == 0 {
161        lua::lua_pcall(L, 0, lua::LUA_MULTRET, 0)
162    } else {
163        status
164    }
165}
166
167#[inline(always)]
168pub unsafe fn luaL_getmetatable(L: *mut lua_State, n: *const c_char) {
169    lua::lua_getfield(L, lua::LUA_REGISTRYINDEX, n);
170}
171
172// luaL_opt would be implemented here but it is undocumented, so it's omitted
173
174#[inline(always)]
175pub unsafe fn luaL_loadbuffer(
176    L: *mut lua_State,
177    s: *const c_char,
178    sz: usize,
179    n: *const c_char,
180) -> c_int {
181    luaL_loadbufferx(L, s, sz, n, ptr::null())
182}
183
184//
185// TODO: Generic Buffer Manipulation
186//