prepare for srcwrtimer_sample_extension repo to use this

Author: rtldg

Cargo.lock

@@ -1,34 +1,36 @@
-[workspace]
+# https://doc.rust-lang.org/cargo/reference/workspaces.html
 
-resolver = "2" # shrug
+[workspace]
+resolver = "2"
 
 members = [
-	"closestpos",
-	#"closestpos-rs",
-	"extshared",
-	"extshared_build_helper",
+	"closestpos*",
+	"extshared*",
 	"smbz2",
-	#"srcwrf64",
-	"srcwrhttp",
-	"srcwrjson",
-	#"srcwrreplayman",
-	"srcwrsample",
-	#"srcwrsyncer",
-	"srcwrutil",
+	"srcwr*",
 ]
-# Don't build these by default... (because they're just crates for extensions)
 exclude = [
-	"extshared",
-	"extshared_build_helper",
+	# The SourceMod codez and folder structure...
+	"srcwrtimer",
+
+	# Crates that are not finished (or they're broken) so ignore them...
+	"closestpos-rs", # broken
+	"srcwrf64", # lol nothing implemented
+	"srcwrreplayman", # very wip lol
+	"srcwrsyncer", # not using right now
 ]
 
 [workspace.package]
 version = "1.0.0"
-edition = "2021"
+edition = "2024"
 # TODO: Setup homepage url to go to each extension's folder / README?
 homepage = "https://github.com/srcwr/srcwrtimer"
 repository = "https://github.com/srcwr/srcwrtimer"
 
+[workspace.dependencies]
+extshared_build_helper = { path = "extshared_build_helper" }
+extshared = { path = "extshared" }
+
 [profile.release]
 lto = true
 incremental = false
@@ -37,5 +39,3 @@ incremental = false
 #git2-curl = { path = "../git2-rs/git2-curl" }
 #git2 = { path = "../git2-rs" }
 
-#bzip2 = { path = "../bzip2-rs" }
-

Cargo.toml

@@ -77,7 +77,8 @@ dependencies = [
 
 [env]
 HOSTOSPLAIN = { source = "${OS}", default_value = "linux", mapping = {"Windows_NT" = "windows"} }
-EXTERNALDIR="${CARGO_MAKE_WORKING_DIRECTORY}/_external"
+SRCWRTIMER_ROOT_DIR="${CARGO_MAKE_WORKING_DIRECTORY}"
+EXTERNALDIR="${SRCWRTIMER_ROOT_DIR}/_external"
 PACKAGEDIR="${CARGO_MAKE_WORKING_DIRECTORY}/_package"
 
 # Problem with master (as of 2024-09-30):

Makefile.toml

@@ -47,8 +47,6 @@ TODO: investigate https://github.com/rust-cross/cargo-xwin for msvc builds from
   - A better JSON extension for plugins to use. The `natives_json.rs` code is a mess lol. Minimally tested.
 - srcwrreplayman
   - An incomplete/placeholder extension to provide more efficient and performant replay storage and access. Expect something similar to [bhoptimer_helper_minimal](https://github.com/srcwr/bhoptimer_helper_minimal).
-- srcwrsample
-  - A sample/test extension that I use for random things. If you want an extension to copy & paste to base a new extension off of then you could try this, srcwrutil, or smbz2.
 - srcwrsql
   - Was going to be a SQL extension that runs queries parallel to each other. SourceMod's SQL extension runs each query one-after-another, with a sleep after each query, so it's not very performant. TODO one day...
 - srcwrsyncer

README.md

@@ -12,8 +12,8 @@ repository.workspace = true
 crate-type = ["cdylib"]
 
 [build-dependencies]
-extshared_build_helper = { path = "../extshared_build_helper" }
+extshared_build_helper.workspace = true
 
 [dependencies]
-extshared = { path = "../extshared" }
+extshared.workspace = true
 kiddo = "4"

closestpos-rs/Cargo.toml

@@ -12,7 +12,7 @@ repository.workspace = true
 crate-type = ["cdylib"]
 
 [build-dependencies]
-extshared_build_helper = { path = "../extshared_build_helper" }
+extshared_build_helper.workspace = true
 
 [dependencies]
-extshared = { path = "../extshared" }
+extshared.workspace = true

closestpos/Cargo.toml

@@ -10,15 +10,15 @@ macro_rules! smext_conf_boilerplate_extension_info {
 	() => {
 		use std::io::Write;
 
-		#[no_mangle]
+		#[unsafe(no_mangle)]
 		pub extern "C" fn rust_conf_name() -> *const u8 {
 			concat!(env!("CARGO_PKG_NAME"), "\0").as_ptr()
 		}
-		#[no_mangle]
+		#[unsafe(no_mangle)]
 		pub extern "C" fn rust_conf_description() -> *const u8 {
 			concat!(env!("CARGO_PKG_DESCRIPTION"), "\0").as_ptr()
 		}
-		#[no_mangle]
+		#[unsafe(no_mangle)]
 		pub extern "C" fn rust_conf_version() -> *const u8 {
 			static VER: std::sync::LazyLock<String> = std::sync::LazyLock::new(|| {
 				let dirty = if env!("VERGEN_GIT_DIRTY") == "true" {
@@ -37,11 +37,11 @@ macro_rules! smext_conf_boilerplate_extension_info {
 			//concat!(env!("CARGO_PKG_VERSION"), "\0").as_ptr()
 			VER.as_ptr()
 		}
-		#[no_mangle]
+		#[unsafe(no_mangle)]
 		pub extern "C" fn rust_conf_author() -> *const u8 {
 			concat!(env!("CARGO_PKG_AUTHORS"), "\0").as_ptr()
 		}
-		#[no_mangle]
+		#[unsafe(no_mangle)]
 		pub extern "C" fn rust_conf_url() -> *const u8 {
 			concat!(
 				env!("CARGO_PKG_HOMEPAGE"),
@@ -51,16 +51,16 @@ macro_rules! smext_conf_boilerplate_extension_info {
 			)
 			.as_ptr()
 		}
-		#[no_mangle]
+		#[unsafe(no_mangle)]
 		pub extern "C" fn rust_conf_logtag() -> *const u8 {
 			concat!(env!("CARGO_PKG_NAME"), "\0").as_ptr()
 		}
-		#[no_mangle]
+		#[unsafe(no_mangle)]
 		pub extern "C" fn rust_conf_license() -> *const u8 {
 			concat!(env!("CARGO_PKG_LICENSE"), "\0").as_ptr()
 		}
 
-		#[no_mangle]
+		#[unsafe(no_mangle)]
 		#[allow(clippy::not_unsafe_ptr_arg_deref)]
 		pub extern "C" fn rust_sdk_on_load_wrapper(
 			error: *mut u8,
@@ -85,26 +85,26 @@ macro_rules! smext_conf_boilerplate_extension_info {
 macro_rules! smext_conf_boilerplate_load_funcs {
 	() => {
 		// perhaps an anyhow::Result<()> would be better...
-		#[no_mangle]
+		#[unsafe(no_mangle)]
 		pub fn rust_sdk_on_load(_late: bool) -> Result<(), Box<dyn std::error::Error>> {
 			Ok(())
 		}
 
-		#[no_mangle]
+		#[unsafe(no_mangle)]
 		pub extern "C" fn rust_sdk_on_unload() {}
 
-		#[no_mangle]
+		#[unsafe(no_mangle)]
 		pub extern "C" fn rust_sdk_on_all_loaded() {}
 
-		#[no_mangle]
+		#[unsafe(no_mangle)]
 		pub extern "C" fn rust_on_core_map_start(
 			_edict_list: *mut core::ffi::c_void,
 			_edict_count: i32,
 			_client_max: i32,
 		) {
 		}
 
-		#[no_mangle]
+		#[unsafe(no_mangle)]
 		pub extern "C" fn rust_on_core_map_end() {}
 	};
 }

extshared/src/smext_conf_boilerplate.rs

@@ -20,6 +20,10 @@ use vergen_gitcl::BuildBuilder;
 use vergen_gitcl::Emitter;
 use vergen_gitcl::GitclBuilder;
 
+static SRCWRTIMER_ROOT_DIR: std::sync::LazyLock<String> = std::sync::LazyLock::new(|| {
+	std::env::var("SRCWRTIMER_ROOT_DIR").unwrap()
+});
+
 pub fn generate_inc_defines_and_enums(outdir: &str, incfile: &str, name: &str) {
 	println!("cargo:rerun-if-changed={}", incfile);
 	let content = std::fs::read_to_string(incfile).unwrap();
@@ -53,29 +57,23 @@ pub {}\n",
 	std::fs::write(format!("{}/{}_DEFINES.rs", outdir, name), defines).unwrap();
 }
 
-pub fn use_atcprintf(build: &mut cc::Build) -> &mut cc::Build {
-	println!("cargo:rerun-if-changed=../extshared/src/sprintf.cpp");
-	build.file("../extshared/src/sprintf.cpp")
+pub fn use_atcprintf(build: &mut cc::Build) {
+	slurp_single_file(build, &format!("{}/extshared/src/sprintf.cpp", *SRCWRTIMER_ROOT_DIR));
 }
 
-pub fn use_cellarray(build: &mut cc::Build) -> &mut cc::Build {
-	println!("cargo:rerun-if-changed=../extshared/src/ICellArray.cpp");
-	build
-		.define("HANDLE_CELLARRAY", None)
-		.file("../extshared/src/ICellArray.cpp")
+pub fn use_cellarray(build: &mut cc::Build) {
+	build.define("HANDLE_CELLARRAY", None);
+	slurp_single_file(build, &format!("{}/extshared/src/ICellArray.cpp", *SRCWRTIMER_ROOT_DIR));
 }
 
-pub fn use_fileobject(build: &mut cc::Build) -> &mut cc::Build {
-	println!("cargo:rerun-if-changed=../extshared/src/IFileObject.cpp");
-	println!("cargo:rerun-if-changed=../extshared/src/IFileObject.hpp");
-	build
-		.define("HANDLE_FILEOBJECT", None)
-		.file("../extshared/src/IFileObject.cpp")
+pub fn use_fileobject(build: &mut cc::Build) {
+	build.define("HANDLE_FILEOBJECT", None);
+	slurp_single_file(build, &format!("{}/extshared/src/IFileObject.cpp", *SRCWRTIMER_ROOT_DIR));
+	slurp_single_file(build, &format!("{}/extshared/src/IFileObject.hpp", *SRCWRTIMER_ROOT_DIR));
 }
 
-pub fn use_valvefs(build: &mut cc::Build) -> &mut cc::Build {
-	println!("cargo:rerun-if-changed=../extshared/src/valvefs.cpp");
-	build.file("../extshared/src/valvefs.cpp")
+pub fn use_valvefs(build: &mut cc::Build) {
+	slurp_single_file(build, &format!("{}/extshared/src/valvefs.cpp", *SRCWRTIMER_ROOT_DIR));
 }
 
 pub fn compile_lib(build: cc::Build, name: &str) {
@@ -142,7 +140,7 @@ pub fn smext_tf2(build: &mut cc::Build) {
 // https://github.com/alliedmodders/sourcemod/blob/master/public/sample_ext/AMBuildScript
 pub fn smext_hl2sdk_for_good_games(build: &mut cc::Build, sdk_name: &str, sdk_id: usize) {
 	let sdk_path = std::env::var("HL2SDK")
-		.unwrap_or(format!("../_external/alliedmodders/hl2sdk-{}", sdk_name));
+		.unwrap_or(format!("{}/_external/alliedmodders/hl2sdk-{}", *SRCWRTIMER_ROOT_DIR, sdk_name));
 
 	let like_msvc = build.get_compiler().is_like_msvc();
 	let target_windows = std::env::var("CARGO_CFG_TARGET_OS").unwrap() == "windows";
@@ -196,7 +194,7 @@ pub fn smext_hl2sdk_for_good_games(build: &mut cc::Build, sdk_name: &str, sdk_id
 // This is necessary because the CC compiler (zig cc) throws errors about using C++ standards via .std() when compiling C files.... frick....
 pub fn link_sm_detours(mainbuild: &mut cc::Build) {
 	let sm =
-		std::env::var("SOURCEMOD").unwrap_or("../_external/alliedmodders/sourcemod".to_string());
+		std::env::var("SOURCEMOD").unwrap_or(format!("{}/_external/alliedmodders/sourcemod", *SRCWRTIMER_ROOT_DIR));
 	//let target_windows = std::env::var("CARGO_CFG_TARGET_OS").unwrap() == "windows";
 	let like_msvc = mainbuild.get_compiler().is_like_msvc();
 
@@ -259,16 +257,16 @@ pub fn smext_build() -> cc::Build {
 		.unwrap();
 
 	let sm =
-		std::env::var("SOURCEMOD").unwrap_or("../_external/alliedmodders/sourcemod".to_string());
-	let mm = std::env::var("METAMOD").unwrap_or("../_external/alliedmodders/mmsource".to_string());
+		std::env::var("SOURCEMOD").unwrap_or(format!("{}/_external/alliedmodders/sourcemod", *SRCWRTIMER_ROOT_DIR));
+	let mm = std::env::var("METAMOD").unwrap_or(format!("{}/_external/alliedmodders/mmsource", *SRCWRTIMER_ROOT_DIR));
 
-	println!("cargo:rerun-if-changed=../extshared/src/coreident.cpp");
-	println!("cargo:rerun-if-changed=../extshared/src/coreident.hpp");
-	println!("cargo:rerun-if-changed=../extshared/src/extension.cpp");
-	println!("cargo:rerun-if-changed=../extshared/src/extension.h");
-	println!("cargo:rerun-if-changed=../extshared/src/rust_exports.h");
-	println!("cargo:rerun-if-changed=../extshared/src/smsdk_config.h");
-	//rerun_on_dir_cc_files_changed("../extshared/src");
+	println!("cargo:rerun-if-changed={}/extshared/src/coreident.cpp", *SRCWRTIMER_ROOT_DIR);
+	println!("cargo:rerun-if-changed={}/extshared/src/coreident.hpp", *SRCWRTIMER_ROOT_DIR);
+	println!("cargo:rerun-if-changed={}/extshared/src/extension.cpp", *SRCWRTIMER_ROOT_DIR);
+	println!("cargo:rerun-if-changed={}/extshared/src/extension.h", *SRCWRTIMER_ROOT_DIR);
+	println!("cargo:rerun-if-changed={}/extshared/src/rust_exports.h", *SRCWRTIMER_ROOT_DIR);
+	println!("cargo:rerun-if-changed={}/extshared/src/smsdk_config.h", *SRCWRTIMER_ROOT_DIR);
+	//rerun_on_dir_cc_files_changed("{}/extshared/src", *SRCWRTIMER_ROOT_DIR);
 
 	let mut build = cc::Build::new();
 	let like_msvc = build.get_compiler().is_like_msvc();
@@ -284,9 +282,9 @@ pub fn smext_build() -> cc::Build {
 		.include(format!("{}/public/amtl", sm))
 		.include(format!("{}/core", mm))
 		.include(format!("{}/core/sourcehook", mm))
-		.include("../extshared/src")
-		.file("../extshared/src/coreident.cpp")
-		.file("../extshared/src/extension.cpp")
+		.include(format!("{}/extshared/src", *SRCWRTIMER_ROOT_DIR))
+		.file(format!("{}/extshared/src/coreident.cpp", *SRCWRTIMER_ROOT_DIR))
+		.file(format!("{}/extshared/src/extension.cpp", *SRCWRTIMER_ROOT_DIR))
 		.file(format!("{}/public/smsdk_ext.cpp", sm))
 		.cpp(true)
 		.static_crt(true);

extshared_build_helper/src/lib.rs

@@ -12,9 +12,9 @@ repository.workspace = true
 crate-type = ["cdylib"]
 
 [build-dependencies]
-extshared_build_helper = { path = "../extshared_build_helper" }
+extshared_build_helper.workspace = true
 
 [dependencies]
-extshared = { path = "../extshared" }
+extshared.workspace = true
 #bzip2 = { git = "https://github.com/srcwr/bzip2-rs.git", rev = "bd66f7c", features=["static"] }
 bzip2 = { version = "0.5", default-features = false, features = ["libbz2-rs-sys"] }

smbz2/Cargo.toml

@@ -12,8 +12,8 @@ repository.workspace = true
 crate-type = ["cdylib"]
 
 [build-dependencies]
-extshared_build_helper = { path = "../extshared_build_helper" }
+extshared_build_helper.workspace = true
 
 [dependencies]
-extshared = { path = "../extshared" }
+extshared.workspace = true
 ryu = "1.0"