|
| 1 | +use semver::{BuildMetadata, Prerelease}; |
| 2 | + |
| 3 | +use crate::core_types::Dictionary; |
| 4 | +use crate::core_types::FromVariant; |
| 5 | +use crate::object::ownership::Unique; |
| 6 | +use crate::private::{get_api, EngineMethodTable}; |
| 7 | + |
| 8 | +/// Checks the version number of the host Godot instance to see if it matches the generated API. |
| 9 | +/// Returns `true` if the test isn't applicable, or if no mismatch was found. |
| 10 | +#[inline] |
| 11 | +pub fn godot_version_mismatch() -> bool { |
| 12 | + let ret = check_godot_version_mismatch(); |
| 13 | + if !ret { |
| 14 | + godot_warn!(concat!( |
| 15 | + "gdnative-core: GDNative version mismatches may lead to subtle bugs, undefined behavior or crashes at runtime.\n", |
| 16 | + "Apply the 'custom-godot' feature if you want to use current godot-rust with another Godot engine version.", |
| 17 | + )); |
| 18 | + } |
| 19 | + |
| 20 | + ret |
| 21 | +} |
| 22 | + |
| 23 | +#[cfg(feature = "custom-godot")] |
| 24 | +fn check_godot_version_mismatch() -> bool { |
| 25 | + true |
| 26 | +} |
| 27 | + |
| 28 | +#[cfg(not(feature = "custom-godot"))] |
| 29 | +fn check_godot_version_mismatch() -> bool { |
| 30 | + use semver::VersionReq; |
| 31 | + |
| 32 | + let Some(version) = godot_version() else { |
| 33 | + godot_warn!("gdnative-core: failed to get version info from the engine."); |
| 34 | + return false; |
| 35 | + }; |
| 36 | + |
| 37 | + let version_req = VersionReq::parse("~3.5.1").unwrap(); |
| 38 | + |
| 39 | + if version_req.matches(&version) { |
| 40 | + true |
| 41 | + } else { |
| 42 | + godot_warn!("This godot-rust version is only compatible with Godot `{version_req}`; detected version `{version}`."); |
| 43 | + false |
| 44 | + } |
| 45 | +} |
| 46 | + |
| 47 | +fn godot_version() -> Option<semver::Version> { |
| 48 | + let version = unsafe { |
| 49 | + let api = get_api(); |
| 50 | + let engine = (api.godot_global_get_singleton)(b"Engine\0".as_ptr() as *mut _); |
| 51 | + |
| 52 | + let mut dictionary = sys::godot_dictionary::default(); |
| 53 | + |
| 54 | + (api.godot_method_bind_ptrcall)( |
| 55 | + EngineMethodTable::get(api).get_version_info, |
| 56 | + engine, |
| 57 | + [].as_mut_ptr() as *mut _, |
| 58 | + &mut dictionary as *mut _ as *mut _, |
| 59 | + ); |
| 60 | + |
| 61 | + Dictionary::<Unique>::from_sys(dictionary) |
| 62 | + }; |
| 63 | + |
| 64 | + let major = u64::from_variant(&version.get("major")?).ok()?; |
| 65 | + let minor = u64::from_variant(&version.get("minor")?).ok()?; |
| 66 | + let patch = u64::from_variant(&version.get("patch")?).ok()?; |
| 67 | + |
| 68 | + let pre = version |
| 69 | + .get("status") |
| 70 | + .and_then(|v| { |
| 71 | + let s = String::from_variant(&v).ok()?; |
| 72 | + if s == "stable" { |
| 73 | + return None; |
| 74 | + } |
| 75 | + |
| 76 | + let s = s.chars().map(sanitize_for_semver).collect::<String>(); |
| 77 | + Some(Prerelease::new(&s).expect("string sanitized")) |
| 78 | + }) |
| 79 | + .unwrap_or(Prerelease::EMPTY); |
| 80 | + |
| 81 | + let build = { |
| 82 | + let mut build_metadata = String::new(); |
| 83 | + let mut sep = false; |
| 84 | + |
| 85 | + if let Some(build_name) = version |
| 86 | + .get("build") |
| 87 | + .and_then(|v| String::from_variant(&v).ok()) |
| 88 | + { |
| 89 | + build_metadata.extend(build_name.chars().map(sanitize_for_semver)); |
| 90 | + sep = true; |
| 91 | + }; |
| 92 | + |
| 93 | + if let Some(hash) = version |
| 94 | + .get("hash") |
| 95 | + .and_then(|v| String::from_variant(&v).ok()) |
| 96 | + { |
| 97 | + if sep { |
| 98 | + build_metadata.push('.'); |
| 99 | + } |
| 100 | + build_metadata.extend(hash.chars().map(sanitize_for_semver)); |
| 101 | + }; |
| 102 | + |
| 103 | + if build_metadata.is_empty() { |
| 104 | + BuildMetadata::EMPTY |
| 105 | + } else { |
| 106 | + BuildMetadata::new(&build_metadata).expect("build metadata sanitized") |
| 107 | + } |
| 108 | + }; |
| 109 | + |
| 110 | + Some(semver::Version { |
| 111 | + major, |
| 112 | + minor, |
| 113 | + patch, |
| 114 | + pre, |
| 115 | + build, |
| 116 | + }) |
| 117 | +} |
| 118 | + |
| 119 | +fn sanitize_for_semver(s: char) -> char { |
| 120 | + if s.is_ascii_alphanumeric() { |
| 121 | + s |
| 122 | + } else { |
| 123 | + '-' |
| 124 | + } |
| 125 | +} |
0 commit comments