Add proc macros

* Bump to 0.9.0
* Add #[lua_function] #[gmod_open] #[gmod_close] proc macros which allow for you to return Result<i32, E> from a gmod function.

Author: vurvdev

Cargo.toml

@@ -1,29 +1,6 @@
-[package]
-name = "rglua"
-description = "Toolkit for garrysmod development with the source sdk and luajit api"
-version = "0.8.0"
-authors = ["Vurv <vurvdevelops@gmail.com>"]
-keywords = ["glua", "garrysmod", "lua", "gmod"]
-categories = ["api-bindings", "external-ffi-bindings", "development-tools::ffi", "game-development", "accessibility"]
-readme = "README.md"
-license = "MIT"
-edition = "2021"
-
-# Remember to make your output module a cdylib.
-
-[dependencies]
-libloading = "0.7.2"
-once_cell = "1.8.0"
-thiserror = "1.0.30"
-
-derive_more = { version = "0.99.17", optional = true }
-
-vtables = { version = "0.1.0", optional = true }
-vtables_derive = { version = "0.1.0", optional = true }
-
-[features]
-default = ["interfaces", "userdata"]
-
-interfaces = ["vtables", "vtables_derive"]
-
-userdata = ["derive_more"]
+[workspace]
+members = [
+	"rglua",
+	"rglua-macros"
+]
+exclude = ["examples"]

README.md

@@ -14,7 +14,24 @@ cargo build --release --target=i686-pc-windows-msvc
 ### [garrysmod_common](https://github.com/danielga/garrysmod_common)
 This is heavily based off of garrysmod_common, in how we export the lua_shared functions and trying to replicate everything from the Lua C Api.
 
-
 ## Comparison
-There are actually a decent amount of libraries out there for gmod development
+There are actually a decent amount of libraries out there for gmod development.
+Here's a comparison and why you could use this one.
+
+[rglua]: https://crates.io/crates/rglua
+[rust-glua-sys]: https://github.com/SpiralP/rust-glua-sys
+[gmod-rs]: https://crates.io/crates/gmod
+[gmrs]: https://github.com/diogo464/gmrs
+
+| Library                           | [rglua] | [rust-glua-sys] | [gmod-rs]  | [gmrs] |
+|-----------------------------------|---------|-----------------|------------|--------|
+| Lua C Api Bindings                | ✔️     | ✔️              | ✔️         | ❌    |
+| Crates.io                         | ✔️     | ❌              | ✔️         | ❌    |
+| Proc Macros                       | ✔️     | ❌              | ✔️         | ✔️    |
+| Interfacing w/  Source SDK        | ✔️     | ❌              | ❌         | ❌    |
+| Returning Result<> from functions | ✔️	 | ❌              | ❌         | ❌    |
+| Can be used on stable             | ✔️     | ✔️              | ❌         | ✔️    |
+| Real world examples               | ✔️     | ❌              | ✔️         | ❌    |
+| Github Stars                      | 😢     | 👍              | 👑         | 🤷‍♂️    |
 
+__*You can help with that last one 😉*__

examples/engine/Cargo.toml

@@ -1,13 +1,13 @@
 [package]
 name = "gmod_engine"
 description = "Binary module that accesses engine.dll"
-version = "0.1.0"
+version = "0.2.0"
 edition = "2021"
 publish = false
 
 [lib]
 crate-type = ["cdylib"]
 
 [dependencies]
-rglua = { path = "../.." }
+rglua = { path = "../../rglua" }
 anyhow = "1.0.51"

examples/engine/src/lib.rs

@@ -12,7 +12,8 @@ fn get_iface() -> anyhow::Result<&'static EngineClient> {
 	}
 }
 
-extern "C" fn concmd(l: LuaState) -> i32 {
+#[lua_function]
+fn concmd(l: LuaState) -> i32 {
 	match get_iface() {
 		Ok(iface) => {
 			iface.ExecuteClientCmd( luaL_checklstring(l, 1, 0) );
@@ -22,7 +23,8 @@ extern "C" fn concmd(l: LuaState) -> i32 {
 	0
 }
 
-extern "C" fn get_resolution(l: LuaState) -> i32 {
+#[lua_function]
+fn get_resolution(l: LuaState) -> i32 {
 	match get_iface() {
 		Ok(iface) => unsafe {
 			let (w, h): (*mut _, *mut _) = (&mut 0, &mut 0);
@@ -38,7 +40,8 @@ extern "C" fn get_resolution(l: LuaState) -> i32 {
 	0
 }
 
-extern "C" fn get_directory(l: LuaState) -> i32 {
+#[lua_function]
+fn get_directory(l: LuaState) -> i32 {
 	match get_iface() {
 		Ok(iface) => {
 			let dir = iface.GetGameDirectory();
@@ -52,7 +55,8 @@ extern "C" fn get_directory(l: LuaState) -> i32 {
 	0
 }
 
-extern "C" fn get_level(l: LuaState) -> i32 {
+#[lua_function]
+fn get_level(l: LuaState) -> i32 {
 	match get_iface() {
 		Ok(iface) => {
 			let level = iface.GetLevelName();
@@ -66,7 +70,8 @@ extern "C" fn get_level(l: LuaState) -> i32 {
 	0
 }
 
-extern "C" fn is_recording(l: LuaState) -> i32 {
+#[lua_function]
+fn is_recording(l: LuaState) -> i32 {
 	match get_iface() {
 		Ok(iface) => {
 			let demo = iface.IsRecordingDemo();
@@ -80,7 +85,8 @@ extern "C" fn is_recording(l: LuaState) -> i32 {
 	0
 }
 
-extern "C" fn is_paused(l: LuaState) -> i32 {
+#[lua_function]
+fn is_paused(l: LuaState) -> i32 {
 	match get_iface() {
 		Ok(iface) => {
 			let paused = iface.IsPaused();
@@ -94,8 +100,8 @@ extern "C" fn is_paused(l: LuaState) -> i32 {
 	0
 }
 
-#[no_mangle]
-extern "C" fn gmod13_open(l: LuaState) -> i32 {
+#[gmod_open]
+fn open(l: LuaState) -> i32 {
 	printgm!(l, "Loaded engine module!");
 
 	let lib = reg! [
@@ -111,7 +117,7 @@ extern "C" fn gmod13_open(l: LuaState) -> i32 {
 	0
 }
 
-#[no_mangle]
-extern "C" fn gmod13_close(_: LuaState) -> i32 {
+#[gmod_close]
+fn close(_l: LuaState) -> i32 {
 	0
 }

examples/is_even/Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "gmod_is_even"
 description = "Binary module that exposes a function called 'is_even' that does what it says."
-version = "0.1.0"
+version = "0.2.0"
 edition = "2021"
 publish = false
 

examples/is_even/src/lib.rs

@@ -19,8 +19,8 @@ extern "C" fn is_odd(l: LuaState) -> i32 {
 	1
 }
 
-#[no_mangle]
-extern "C" fn gmod13_open(l: LuaState) -> i32 {
+#[gmod_open]
+fn open(l: LuaState) -> i32 {
 	// Print to the gmod console
 	printgm!(l, "Loaded is_even module!");
 
@@ -36,8 +36,8 @@ extern "C" fn gmod13_open(l: LuaState) -> i32 {
 	1
 }
 
-#[no_mangle]
-extern "C" fn gmod13_close(l: LuaState) -> i32 {
+#[gmod_close]
+fn close(l: LuaState) -> i32 {
 	printgm!(l, "Goodbye garrysmod!");
 	0
 }

rglua-macros/Cargo.toml

@@ -0,0 +1,27 @@
+[package]
+name = "rglua-macros"
+description = "Procedural macros to be used with rglua"
+version = "0.1.0"
+authors = ["Vurv <vurvdevelops@gmail.com>"]
+keywords = ["glua", "garrysmod", "lua", "gmod"]
+categories = ["api-bindings", "external-ffi-bindings", "development-tools::ffi", "game-development", "accessibility"]
+readme = "README.md"
+license = "MIT"
+edition = "2021"
+repository = "https://github.com/Vurv78/rglua"
+
+[lib]
+proc-macro = true
+
+[[test]]
+name = "tests"
+path = "tests/main.rs"
+
+[dependencies]
+proc-macro2 = "1.0.34"
+quote = "1.0.10"
+syn = { version = "1.0.82", features = ["full"] }
+
+[dev-dependencies]
+trybuild = { version = "1.0.49", features = ["diff"] }
+rglua = { path = "../rglua" }

rglua-macros/README.md

@@ -0,0 +1,2 @@
+# 🌑 ``rglua-macros``
+> Proc-macros for use with rglua