Large Changes

* Changed file structure again sorry :(
* Added bindings for luaL_register
* Fixed luaL_openlib binding
* Added luaL_openlibs binding
* Renamed helper to util and make public
* Added try_cstr, try_rstr and reg macros
* Added util::dump_stack
* Renamed LuaL_Buffer to LuaBuffer
* Added LuaReg type
* Added is_even binary module example.
* ``Type`` is no longer a useless enum and is just a namespace with constants in it.
* Removed deprecated rstring and cstring
* Reorganized interfaces
* Add ``thiserror`` as a dependency
* Status and Mode are repr(i32) now for cast safety, will probably follow suit with Type in being namespaces with constants later.
* Shortened var signatures of bindings like 50% (Still ugly!)
Largest addition here is lua regs, to make life a lot easier. Especially with the reg! macro which lets you create them easily (And no need for a null reg at the end to tell C you're done adding functions, it does that for you.)

Most of these are breaking changes but I think this will be the last time for a while, having too many single files was getting bad.

Author: vurvdev

.gitignore

@@ -1,2 +1,3 @@
 target
 Cargo.lock
+.vscode

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "rglua"
 description = "Rust tooling for garrysmod development with the LuaJIT api"
-version = "0.6.1"
+version = "0.7.0"
 authors = ["Vurv <[email protected]>"]
 keywords = ["glua", "garrysmod", "lua", "gmod"]
 readme = "README.md"
@@ -13,6 +13,7 @@ edition = "2021"
 [dependencies]
 libloading = "0.7.2"
 once_cell = "1.8.0"
+thiserror = "1.0.30"
 
 vtables = { version = "0.1.0", optional = true }
 vtables_derive = { version = "0.1.0", optional = true }

README.md

@@ -15,7 +15,7 @@ Add this to your ``Cargo.toml`` file
 crate-type = ["cdylib"] # This tells rust we want to create a .dll file that links to C code.
 
 [dependencies]
-rglua = "0.6.1"
+rglua = "0.7.0"
 ```
 
 ## Building
@@ -32,13 +32,14 @@ cargo build --release --target=i686-pc-windows-msvc
 * The nature of this crate is super unsafe and sort of defeats the purpose of rust's safety because of the interfacing you require to unsafe C code and the nature of linking to them.
 
 ## Example Module
+Find another larger example at examples/is_even
 ```rust
 use rglua::prelude::*;
 
 #[no_mangle]
 pub extern fn gmod13_open(state: LuaState) -> i32 {
 	lua_getglobal(state, cstr!("print"));
-	lua_pushstring(state, cstr!("Hello from rust!"));
+	lua_pushstring(state, cstr!("Hello from rust!")); // Print to the in-game console
 	lua_call(state, 1, 0);
 
 	// or

examples/is_even/Cargo.toml

@@ -0,0 +1,12 @@
+[package]
+name = "gmod_is_even"
+description = "Binary module that exposes a function called 'is_even' that does what it says."
+version = "0.1.0"
+edition = "2021"
+publish = false
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+rglua = { path = "../.." }

examples/is_even/src/lib.rs

@@ -0,0 +1,43 @@
+use rglua::prelude::*;
+
+// The functions we want to provide to lua
+extern "C" fn is_even(l: LuaState) -> i32 {
+	let num = luaL_checkinteger(l, 1);
+	// Ask for the first argument of the function.
+	// If this is the wrong type or missing, an error will be thrown to lua (if you don't want this, use the lua_to* functions)
+
+	lua_pushboolean(l, (num % 2 == 0) as i32);
+
+	// This returns one value
+	1
+}
+
+extern "C" fn is_odd(l: LuaState) -> i32 {
+	let num = luaL_checkinteger(l, 1);
+
+	lua_pushboolean(l, (num % 2 != 0) as i32);
+	1
+}
+
+#[no_mangle]
+extern "C" fn gmod13_open(l: LuaState) -> i32 {
+	// Print to the gmod console
+	printgm!(l, "Loaded is_even module!");
+
+	// Create a library to organize all of our functions to export to gmod.
+	let lib = reg! [
+		"is_even" => is_even,
+		"is_odd" => is_odd
+	];
+
+	// Register our functions in ``_G.math``
+	// This WILL NOT overwrite _G.math if it already exists ()
+	luaL_register(l, cstr!("math"), lib.as_ptr());
+	1
+}
+
+#[no_mangle]
+extern "C" fn gmod13_close(l: LuaState) -> i32 {
+	printgm!(l, "Goodbye garrysmod!");
+	0
+}

src/globals.rs

@@ -12,20 +12,20 @@ pub mod Lua {
 	pub static NUMTYPES: c_int = 9;
 	pub static NUMTAGS: c_int = NUMTYPES;
 
-	// Proper enums to use. Cast these to integers when using them
-	pub enum Type {
-		None = -1,
-		Nil,
-		Bool,
-		LUserData,
-		Number,
-		String,
-		Table,
-		Function,
-		UserData,
-		Thread,
+	pub mod Type {
+		pub const None: i32 = -1;
+		pub const Nil: i32 = 0;
+		pub const Bool: i32 = 1;
+		pub const LUserData: i32 = 2;
+		pub const Number: i32 = 3;
+		pub const String: i32 = 4;
+		pub const Table: i32 = 5;
+		pub const Function: i32 = 6;
+		pub const UserData: i32 = 7;
+		pub const Thread: i32 = 8;
 	}
 
+	#[repr(i32)]
 	pub enum Status {
 		Ok = 0,
 		Yield,
@@ -68,6 +68,7 @@ pub mod Lua {
 }
 
 pub mod Jit {
+	#[repr(i32)]
 	pub enum Mode {
 		ENGINE,
 		DEBUG,

src/helper/mod.rs

@@ -0,0 +1,19 @@
+#[repr(C)]
+pub struct PlayerInfo {
+	unknown: u64,
+	xuid: u64,
+	name: [i8; 32],
+	unknown01: [char; 96],
+	m_szPlayerName: [char; 128],
+	m_nUserID: i32,
+	m_szSteamID: [char; 33],
+	m_nSteam3ID: u32,
+	userID: i32,
+	guid: [char; 33],
+	friendsID: i32,
+	fakeplayer: bool,
+	ishltv: bool,
+	customFiles: [u64; 4],
+	filesDownloaded: u8,
+	pad: [i8; 304],
+}

src/interface.rs

@@ -1,7 +1,4 @@
-use vtables::VTable;
-use vtables_derive::*;
-
-use super::structs::*;
+use super::prelude::*;
 
 use std::os::raw::c_char;