Refactor

* Reprecated rstring to rename to rstr to better reflect using &str type.
* Bumped to 0.5.0
* C Types are in snake case
* Fix clippy lints
* Add a prelude that includes lua functions and basic types.
* Make exposed symbols static instead of const as they should be..
* Added unit test for cstr! function
* Put interface stuff under new ``interfaces`` feature (default enabled).

Author: vurvdev

.travis.yml

@@ -7,7 +7,7 @@ rust:
 
 branches:
   only:
-  - main
+  - master
 
 jobs:
   allow_failures:

Cargo.toml

@@ -1,9 +1,9 @@
 [package]
 name = "rglua"
 description = "Rust bindings to the lua api for gmod binary module creation"
-version = "0.4.0"
+version = "0.5.0"
 authors = ["Vurv <[email protected]>"]
-keywords = ["glua","garrysmod","lua"]
+keywords = ["glua", "garrysmod", "lua", "gmod"]
 readme = "README.md"
 license = "MIT"
 edition = "2018"
@@ -14,5 +14,9 @@ edition = "2018"
 libloading = "0.7.0"
 once_cell = "1.7.2"
 
-vtables = "0.1.0"
-vtables_derive = "0.1.0"
+vtables = { version = "0.1.0", optional = true }
+vtables_derive = { version = "0.1.0", optional = true }
+
+[features]
+default = ["interfaces"]
+interfaces = ["vtables", "vtables_derive"]

README.md

@@ -1,4 +1,4 @@
-# rglua [![Release Shield](https://img.shields.io/github/v/release/Vurv78/rglua)](https://github.com/Vurv78/rglua/releases/latest) ![Linux Build Status](https://www.travis-ci.com/Vurv78/rglua.svg?branch=main) [![License](https://img.shields.io/github/license/Vurv78/rglua?color=red)](https://opensource.org/licenses/Apache-2.0) [![github/Vurv78](https://img.shields.io/discord/824727565948157963?color=7289DA&label=chat&logo=discord)](https://discord.gg/epJFC6cNsw)
+# rglua [![Release Shield](https://img.shields.io/github/v/release/Vurv78/rglua)](https://github.com/Vurv78/rglua/releases/latest) ![Build Status](https://www.travis-ci.com/Vurv78/rglua.svg?branch=main) [![License](https://img.shields.io/github/license/Vurv78/rglua?color=red)](https://opensource.org/licenses/Apache-2.0) [![github/Vurv78](https://img.shields.io/discord/824727565948157963?label=Discord&logo=discord&logoColor=ffffff&labelColor=7289DA&color=2c2f33)](https://discord.gg/epJFC6cNsw)
 
 This is a crate that contains bindings for using the lua c api in garrysmod through bindings using the rust libloading library.
 Can be used for either binary modules or just manual injections into gmod, like with [Autorun-rs](https://github.com/Vurv78/Autorun-rs)
@@ -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 = { git = "https://github.com/Vurv78/rglua" }
+rglua = "0.5.0"
 ```
 
 ## Building
@@ -38,16 +38,12 @@ Also do this if you have never compiled to 32 bit, to get rustup to install 32 b
 
 ## Example Module
 ```rust
-use rglua::{
-	types::{ LuaState, CharBuf },
-	cstring,
-	lua_shared::*
-};
+use rglua::prelude::*;
 
 #[no_mangle]
 pub extern fn gmod13_open(state: LuaState) -> i32 {
-	lua_getglobal( state, b"print\0".as_ptr() as CharBuf );
-	lua_pushstring( state, cstring!("Hello from rust!") );
+	lua_getglobal( state, cstr!("print") );
+	lua_pushstring( state, cstr!("Hello from rust!") );
 	lua_call( state, 1, 0 );
 	0
 }

src/globals.rs

@@ -1,24 +1,16 @@
 use crate::types::*;
 
 pub mod Lua {
-	use super::CInt;
+	use super::c_int;
 
-	pub static VERSION: &'static str = "Lua 5.1";
-	pub static RELEASE: &'static str = "Lua 5.1.4";
-	pub static VERSION_NUM: CInt = 501;
-	pub static COPYRIGHT: &'static str = "Copyright (C) 1994-2008 Lua.org, PUC-Rio";
-	pub static AUTHORS: &'static str = "R. Ierusalimschy, L. H. de Figueiredo & W. Celes";
+	pub static REGISTRYINDEX: c_int = -10000;
+	pub static ENVIRONINDEX: c_int = -10001;
+	pub static GLOBALSINDEX: c_int = -10002;
 
-	pub static REGISTRYINDEX: CInt = -10000;
-	pub static ENVIRONINDEX: CInt = -10001;
-	pub static GLOBALSINDEX: CInt = -10002;
+	pub static MULTRET: c_int = -1;
 
-	pub static MULTRET: CInt = -1;
-	pub static SIGNATURE: &'static str = "\x1bLua";
-	pub static MINSTACK: CInt = 20;
-
-	pub static NUMTYPES: CInt = 9;
-	pub static NUMTAGS: CInt = NUMTYPES;
+	pub static NUMTYPES: c_int = 9;
+	pub static NUMTAGS: c_int = NUMTYPES;
 
 
 	// Proper enums to use. Cast these to integers when using them
@@ -89,11 +81,11 @@ pub mod Jit {
 		MASK = 0x0ff // LUAJIT_MODE_MASK
 	}
 
-	use super::CInt;
+	use super::c_int;
 	// Associated Constants, woah
 	impl Mode {
-		pub const OFF: CInt = 0x0000;
-		pub const ON: CInt = 0x0100;
-		pub const FLUSH: CInt = 0x0200;
+		pub const OFF: c_int = 0x0000;
+		pub const ON: c_int = 0x0100;
+		pub const FLUSH: c_int = 0x0200;
 	}
 }

src/helpers.rs src/helper/mod.rssrc/helpers.rs renamed to src/helper/mod.rs

@@ -1,10 +1,8 @@
 #![allow(unused)]
 
-// Get a const char* from a &str
-
 #[deprecated(
 	since = "0.2.0",
-	note = "Use b\"string\\0\".as_ptr() as *const i8 format or CStrings directly instead."
+	note = "Use cstr instead."
 )]
 #[macro_export]
 macro_rules! cstring {
@@ -16,9 +14,17 @@ macro_rules! cstring {
 	}
 }
 
+// Creates *const i8 from a rust string literal by concatting a \0 to the end of it.
+#[macro_export]
+macro_rules! cstr {
+	($rstring:expr) => {
+		concat!($rstring, "\0").as_ptr() as *const i8
+	}
+}
+
 // Get a rust &str from a const char*
 #[macro_export]
-macro_rules! rstring {
+macro_rules! rstr {
 	($cstring:expr) => {
 		{
 			#[allow(unused_unsafe)]
@@ -28,6 +34,12 @@ macro_rules! rstring {
 	}
 }
 
+#[macro_export]
+#[deprecated(since = "0.5.0", note = "Use rstr instead.")]
+macro_rules! rstring {
+	($a:tt) => { rstr!($a) }
+}
+
 #[allow(unused_macros)]
 #[macro_export]
 /// Like println!, however it prints to the gmod server's console.
@@ -39,10 +51,10 @@ macro_rules! printgm {
 		{
 			let printargs = format!( $($x,)* );
 			if let Ok(fmt) = std::ffi::CString::new(printargs) {
-				rglua::lua_shared::lua_getglobal( $state, b"print\0".as_ptr() as *const i8 );
+				rglua::lua_shared::lua_getglobal( $state, cstr!("print") );
 				rglua::lua_shared::lua_pushstring( $state, fmt.as_ptr() );
 				rglua::lua_shared::lua_call( $state, 1, 0 );
 			}
 		}
 	};
-}
+}

src/interface.rs

@@ -1,13 +1,14 @@
 
 use std::ffi::{ c_void, CString };
-
 pub use crate::interfaces::*;
 
 pub type CreateInterfaceFn = extern "system" fn(
 	pName: *const i8,
 	pReturnCode: *mut i32
 ) -> *mut c_void;
 
+///  # Safety
+/// This function is unsafe to transmute the internal libloading symbol to a proper createinterface function pointer.
 pub unsafe fn get_interface_handle(file: &str) -> Result<CreateInterfaceFn, libloading::Error> {
 	let lib = libloading::Library::new(file)?;
 	let sym: libloading::Symbol<CreateInterfaceFn> = lib.get(b"CreateInterface\0")?;
@@ -25,7 +26,7 @@ pub fn get_from_interface(iface: &str, factory: CreateInterfaceFn) -> Result<*mu
 	let mut status = 0;
 
 	let iface = CString::new(iface)
-		.map_err( |e| InterfaceError::BadCString(e) )?;
+		.map_err(InterfaceError::BadCString)?;
 
 	let result = factory( iface.as_ptr(), &mut status );
 

src/lib.rs

@@ -4,10 +4,13 @@
 
 pub mod types;
 pub mod globals;
-pub mod helpers;
-
+mod helper;
+#[cfg(feature = "interfaces")]
 mod interfaces;
+#[cfg(feature = "interfaces")]
 pub mod interface;
 
 #[macro_use]
-pub mod lua_shared;
+pub mod lua_shared;
+
+pub mod prelude;