mlua_sys/lua51/
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_load'
9pub const LUA_ERRFILE: c_int = lua::LUA_ERRERR + 1;
10
11#[repr(C)]
12pub struct luaL_Reg {
13    pub name: *const c_char,
14    pub func: lua_CFunction,
15}
16
17#[cfg_attr(all(windows, raw_dylib), link(name = "lua51", kind = "raw-dylib"))]
18extern "C-unwind" {
19    pub fn luaL_register(L: *mut lua_State, libname: *const c_char, l: *const luaL_Reg);
20    #[link_name = "luaL_getmetafield"]
21    pub fn luaL_getmetafield_(L: *mut lua_State, obj: c_int, e: *const c_char) -> c_int;
22    pub fn luaL_callmeta(L: *mut lua_State, obj: c_int, e: *const c_char) -> c_int;
23    pub fn luaL_typerror(L: *mut lua_State, narg: c_int, tname: *const c_char) -> c_int;
24    pub fn luaL_argerror(L: *mut lua_State, narg: c_int, extramsg: *const c_char) -> c_int;
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    pub fn luaL_checkinteger(L: *mut lua_State, narg: c_int) -> lua_Integer;
35    pub fn luaL_optinteger(L: *mut lua_State, narg: c_int, def: lua_Integer) -> lua_Integer;
36    #[link_name = "luaL_checkstack"]
37    pub fn luaL_checkstack_(L: *mut lua_State, sz: c_int, msg: *const c_char);
38    pub fn luaL_checktype(L: *mut lua_State, narg: c_int, t: c_int);
39    pub fn luaL_checkany(L: *mut lua_State, narg: c_int);
40
41    #[link_name = "luaL_newmetatable"]
42    pub fn luaL_newmetatable_(L: *mut lua_State, tname: *const c_char) -> c_int;
43    pub fn luaL_checkudata(L: *mut lua_State, ud: c_int, tname: *const c_char) -> *mut c_void;
44
45    pub fn luaL_where(L: *mut lua_State, lvl: c_int);
46    pub fn luaL_error(L: *mut lua_State, fmt: *const c_char, ...) -> c_int;
47
48    pub fn luaL_checkoption(
49        L: *mut lua_State,
50        narg: c_int,
51        def: *const c_char,
52        lst: *const *const c_char,
53    ) -> c_int;
54}
55
56// Pre-defined references
57pub const LUA_NOREF: c_int = -2;
58pub const LUA_REFNIL: c_int = -1;
59
60#[cfg_attr(all(windows, raw_dylib), link(name = "lua51", kind = "raw-dylib"))]
61extern "C-unwind" {
62    pub fn luaL_ref(L: *mut lua_State, t: c_int) -> c_int;
63    pub fn luaL_unref(L: *mut lua_State, t: c_int, r#ref: c_int);
64
65    pub fn luaL_loadfile(L: *mut lua_State, filename: *const c_char) -> c_int;
66    pub fn luaL_loadbuffer(L: *mut lua_State, buff: *const c_char, sz: usize, name: *const c_char) -> c_int;
67    pub fn luaL_loadstring(L: *mut lua_State, s: *const c_char) -> c_int;
68
69    pub fn luaL_newstate() -> *mut lua_State;
70
71    pub fn luaL_gsub(
72        L: *mut lua_State,
73        s: *const c_char,
74        p: *const c_char,
75        r: *const c_char,
76    ) -> *const c_char;
77
78    pub fn luaL_findtable(
79        L: *mut lua_State,
80        idx: c_int,
81        fname: *const c_char,
82        szhint: c_int,
83    ) -> *const c_char;
84}
85
86//
87// Some useful macros (implemented as Rust functions)
88//
89
90#[inline(always)]
91pub unsafe fn luaL_argcheck(L: *mut lua_State, cond: c_int, narg: c_int, extramsg: *const c_char) {
92    if cond == 0 {
93        luaL_argerror(L, narg, extramsg);
94    }
95}
96
97#[inline(always)]
98pub unsafe fn luaL_checkstring(L: *mut lua_State, n: c_int) -> *const c_char {
99    luaL_checklstring(L, n, ptr::null_mut())
100}
101
102#[inline(always)]
103pub unsafe fn luaL_optstring(L: *mut lua_State, n: c_int, d: *const c_char) -> *const c_char {
104    luaL_optlstring(L, n, d, ptr::null_mut())
105}
106
107// Deprecated from 5.3: luaL_checkint, luaL_optint, luaL_checklong, luaL_optlong
108
109#[inline(always)]
110pub unsafe fn luaL_typename(L: *mut lua_State, i: c_int) -> *const c_char {
111    lua::lua_typename(L, lua::lua_type(L, i))
112}
113
114pub unsafe fn luaL_dofile(L: *mut lua_State, filename: *const c_char) -> c_int {
115    let status = luaL_loadfile(L, filename);
116    if status == 0 {
117        lua::lua_pcall(L, 0, lua::LUA_MULTRET, 0)
118    } else {
119        status
120    }
121}
122
123#[inline(always)]
124pub unsafe fn luaL_dostring(L: *mut lua_State, s: *const c_char) -> c_int {
125    let status = luaL_loadstring(L, s);
126    if status == 0 {
127        lua::lua_pcall(L, 0, lua::LUA_MULTRET, 0)
128    } else {
129        status
130    }
131}
132
133#[inline(always)]
134pub unsafe fn luaL_getmetatable(L: *mut lua_State, n: *const c_char) {
135    lua::lua_getfield_(L, lua::LUA_REGISTRYINDEX, n);
136}
137
138// TODO: luaL_opt
139
140//
141// TODO: Generic Buffer Manipulation
142//