Make #[cfg] model for safeguards easier to understand (WIP MISTAKE IN PUBLIC FEATURES)

Author: Bromeon

.github/workflows/full-ci.yml

@@ -326,7 +326,7 @@ jobs:
             artifact-name: linux-nightly
             godot-binary: godot.linuxbsd.editor.dev.x86_64
             # Important to keep both experimental-threads and codegen-full. Some itests (native_st_audio) require both.
-            rust-extra-args: --features itest/experimental-threads,itest/codegen-full-experimental,godot/api-custom,godot/serde,itest/register-docs,godot/safeguards-dev-balanced
+            rust-extra-args: --features itest/experimental-threads,itest/codegen-full-experimental,godot/api-custom,godot/serde,itest/register-docs
 
           # Compiles godot-rust with `api-custom-json` feature against the JSON file generated via `--dump-extension-api`.
           # Uses latest 4.x headers, while `extension_api.json` comes from the latest Godot binary.
@@ -350,7 +350,7 @@ jobs:
             os: ubuntu-22.04
             artifact-name: linux-release-nightly
             godot-binary: godot.linuxbsd.template_release.x86_64
-            rust-extra-args: --release --features itest/codegen-full-experimental,godot/safeguards-release-disengaged
+            rust-extra-args: --release --features itest/codegen-full-experimental,godot/safeguards-disengaged
             rust-cache-key: release-disengaged
 
           # Linux compat:

godot-bindings/Cargo.toml

@@ -34,8 +34,8 @@ api-custom-json = ["dep:nanoserde", "dep:bindgen", "dep:regex", "dep:which"]
 api-custom-extheader = []
 
 # Safeguard levels (see godot/lib.rs for detailed documentation).
-safeguards-dev-balanced = []
-safeguards-release-disengaged = []
+safeguards-strict = []
+safeguards-disengaged = []
 
 [dependencies]
 gdextension-api = { workspace = true }

godot-bindings/src/lib.rs

@@ -269,21 +269,29 @@ pub fn since_api(major_minor: &str) -> bool {
 }
 
 pub fn emit_safeguard_levels() {
-    let safeguard_modes = ["disengaged", "balanced", "strict"];
+    // Determine safeguard level:
+    // - Disengaged (0): no runtime checks, maximum performance
+    // - Balanced (1): essential safety checks, good balance (default for release)
+    // - Strict (2): all checks including expensive ones (default for debug)
     let mut safeguards_level = if cfg!(debug_assertions) { 2 } else { 1 };
-    #[cfg(debug_assertions)]
-    if cfg!(feature = "safeguards-dev-balanced") {
-        safeguards_level = 1;
+
+    // Features can override the default level
+    if cfg!(feature = "safeguards-strict") {
+        safeguards_level = 2;
     }
-    #[cfg(not(debug_assertions))]
-    if cfg!(feature = "safeguards-release-disengaged") {
+    if cfg!(feature = "safeguards-disengaged") {
         safeguards_level = 0;
     }
 
-    for mode in safeguard_modes.iter() {
-        println!(r#"cargo:rustc-check-cfg=cfg(safeguards_at_least, values("{mode}"))"#);
+    // Emit cfg checks for rustc
+    println!(r#"cargo:rustc-check-cfg=cfg(safeguards_balanced)"#);
+    println!(r#"cargo:rustc-check-cfg=cfg(safeguards_strict)"#);
+
+    // Emit cfgs cumulatively: strict builds get both balanced and strict
+    if safeguards_level >= 1 {
+        println!(r#"cargo:rustc-cfg=safeguards_balanced"#);
     }
-    for mode in safeguard_modes.iter().take(safeguards_level + 1) {
-        println!(r#"cargo:rustc-cfg=safeguards_at_least="{mode}""#);
+    if safeguards_level >= 2 {
+        println!(r#"cargo:rustc-cfg=safeguards_strict"#);
     }
 }

godot-codegen/src/generator/classes.rs

@@ -195,7 +195,7 @@ fn make_class(class: &Class, ctx: &mut Context, view: &ApiView) -> GeneratedClas
         fn __checked_id(&self) -> Option<crate::obj::InstanceId> {
             // SAFETY: only Option due to layout-compatibility with RawGd<T>; it is always Some because stored in Gd<T> which is non-null.
             let rtti = unsafe { self.rtti.as_ref().unwrap_unchecked() };
-            #[cfg(safeguards_at_least = "strict")]
+            #[cfg(safeguards_strict)]
             rtti.check_type::<Self>();
             Some(rtti.instance_id())
         }

godot-codegen/src/generator/native_structures.rs

@@ -219,7 +219,7 @@ fn make_native_structure_field_and_accessor(
 
                 let obj = #snake_field_name.upcast();
 
-                #[cfg(safeguards_at_least = "balanced")]
+                #[cfg(safeguards_balanced)]
                 assert!(obj.is_instance_valid(), "provided node is dead");
 
                 let id = obj.instance_id().to_u64();

godot-core/Cargo.toml

@@ -39,8 +39,8 @@ api-4-5 = ["godot-ffi/api-4-5"]
 # ]]
 
 # Safeguard levels (see godot/lib.rs for detailed documentation).
-safeguards-dev-balanced = ["godot-ffi/safeguards-dev-balanced"]
-safeguards-release-disengaged = ["godot-ffi/safeguards-release-disengaged"]
+safeguards-strict = ["godot-ffi/safeguards-strict"]
+safeguards-disengaged = ["godot-ffi/safeguards-disengaged"]
 
 [dependencies]
 godot-ffi = { path = "../godot-ffi", version = "=0.4.1" }

godot-core/src/builtin/collections/array.rs

@@ -968,7 +968,7 @@ impl<T: ArrayElement> Array<T> {
     }
 
     /// Validates that all elements in this array can be converted to integers of type `T`.
-    #[cfg(safeguards_at_least = "strict")]
+    #[cfg(safeguards_strict)]
     pub(crate) fn debug_validate_int_elements(&self) -> Result<(), ConvertError> {
         // SAFETY: every element is internally represented as Variant.
         let canonical_array = unsafe { self.assume_type_ref::<Variant>() };
@@ -990,7 +990,7 @@ impl<T: ArrayElement> Array<T> {
     }
 
     // No-op in Release. Avoids O(n) conversion checks, but still panics on access.
-    #[cfg(not(safeguards_at_least = "strict"))]
+    #[cfg(not(safeguards_strict))]
     pub(crate) fn debug_validate_int_elements(&self) -> Result<(), ConvertError> {
         Ok(())
     }
@@ -1233,7 +1233,7 @@ impl<T: ArrayElement> Clone for Array<T> {
         let copy = unsafe { self.clone_unchecked() };
 
         // Double-check copy's runtime type in Debug mode.
-        if cfg!(safeguards_at_least = "strict") {
+        if cfg!(safeguards_strict) {
             copy.with_checked_type()
                 .expect("copied array should have same type as original array")
         } else {

godot-core/src/classes/class_runtime.rs

@@ -8,10 +8,10 @@
 //! Runtime checks and inspection of Godot classes.
 
 use crate::builtin::{GString, StringName, Variant, VariantType};
-#[cfg(safeguards_at_least = "strict")]
+#[cfg(safeguards_strict)]
 use crate::classes::{ClassDb, Object};
 use crate::meta::CallContext;
-#[cfg(safeguards_at_least = "strict")]
+#[cfg(safeguards_strict)]
 use crate::meta::ClassId;
 use crate::obj::{bounds, Bounds, Gd, GodotClass, InstanceId, RawGd, Singleton};
 use crate::sys;
@@ -191,7 +191,7 @@ where
     Gd::<T>::from_obj_sys(object_ptr)
 }
 
-#[cfg(safeguards_at_least = "balanced")]
+#[cfg(safeguards_balanced)]
 pub(crate) fn ensure_object_alive(
     instance_id: InstanceId,
     old_object_ptr: sys::GDExtensionObjectPtr,
@@ -212,7 +212,7 @@ pub(crate) fn ensure_object_alive(
     );
 }
 
-#[cfg(safeguards_at_least = "strict")]
+#[cfg(safeguards_strict)]
 pub(crate) fn ensure_object_inherits(derived: ClassId, base: ClassId, instance_id: InstanceId) {
     if derived == base
         || base == Object::class_id() // for Object base, anything inherits by definition
@@ -227,7 +227,7 @@ pub(crate) fn ensure_object_inherits(derived: ClassId, base: ClassId, instance_i
     )
 }
 
-#[cfg(safeguards_at_least = "strict")]
+#[cfg(safeguards_strict)]
 pub(crate) fn ensure_binding_not_null<T>(binding: sys::GDExtensionClassInstancePtr)
 where
     T: GodotClass + Bounds<Declarer = bounds::DeclUser>,
@@ -255,7 +255,7 @@ where
 // Implementation of this file
 
 /// Checks if `derived` inherits from `base`, using a cache for _successful_ queries.
-#[cfg(safeguards_at_least = "strict")]
+#[cfg(safeguards_strict)]
 fn is_derived_base_cached(derived: ClassId, base: ClassId) -> bool {
     use std::collections::HashSet;
 

godot-core/src/init/mod.rs

@@ -535,14 +535,12 @@ unsafe fn ensure_godot_features_compatible() {
     out!("Check Godot precision setting...");
 
     #[cfg(feature = "debug-log")] // Display safeguards level in debug log.
-    let safeguards_level = if cfg!(safeguards_at_least = "strict") {
+    let safeguards_level = if cfg!(safeguards_strict) {
         "strict"
-    } else if cfg!(safeguards_at_least = "balanced") {
+    } else if cfg!(safeguards_balanced) {
         "balanced"
-    } else if cfg!(safeguards_at_least = "disengaged") {
-        "disengaged"
     } else {
-        "unknown"
+        "disengaged"
     };
     out!("Safeguards: {safeguards_level}");
 

godot-core/src/meta/error/convert_error.rs

@@ -189,7 +189,7 @@ pub(crate) enum FromGodotError {
     },
 
     /// Special case of `BadArrayType` where a custom int type such as `i8` cannot hold a dynamic `i64` value.
-    #[cfg(safeguards_at_least = "strict")]
+    #[cfg(safeguards_strict)]
     BadArrayTypeInt {
         expected_int_type: &'static str,
         value: i64,
@@ -234,7 +234,7 @@ impl fmt::Display for FromGodotError {
 
                 write!(f, "expected array of type {exp_class}, got {act_class}")
             }
-            #[cfg(safeguards_at_least = "strict")]
+            #[cfg(safeguards_strict)]
             Self::BadArrayTypeInt {
                 expected_int_type,
                 value,