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