Change notification enumerators from PascalCase to SHOUT_CASE

Author: Bromeon

godot-codegen/src/conv/name_conversions.rs

@@ -77,6 +77,7 @@ pub fn to_pascal_case(ty_name: &str) -> String {
         .replace("Sdfgiy", "SdfgiY")
 }
 
+#[allow(dead_code)] // Keep around in case we need it later.
 pub fn shout_to_pascal(shout_case: &str) -> String {
     // TODO use heck?
 

godot-codegen/src/generator/notifications.rs

@@ -8,9 +8,9 @@
 use crate::context::Context;
 use crate::models::domain::TyName;
 use crate::models::json::JsonClassConstant;
-use crate::{conv, util};
+use crate::util;
 use proc_macro2::{Ident, TokenStream};
-use quote::{format_ident, quote};
+use quote::quote;
 
 pub fn make_notify_methods(class_name: &TyName, ctx: &mut Context) -> TokenStream {
     // Note: there are two more methods, but only from Node downwards, not from Object:
@@ -85,10 +85,10 @@ pub fn make_notification_enum(
         c = class_name.rust_ty
     );
 
-    let mut notification_enumerators_pascal = Vec::new();
+    let mut notification_enumerators_shout = Vec::new();
     let mut notification_enumerators_ord = Vec::new();
     for (constant_ident, constant_value) in all_constants {
-        notification_enumerators_pascal.push(constant_ident);
+        notification_enumerators_shout.push(constant_ident);
         notification_enumerators_ord.push(constant_value);
     }
 
@@ -101,10 +101,11 @@ pub fn make_notification_enum(
         /// Contains the [`Unknown`] variant for forward compatibility.
         #[derive(Copy, Clone, Eq, PartialEq, Ord, PartialOrd, Hash, Debug)]
         #[repr(i32)]
+        #[allow(non_camel_case_types)]
         #cfg_attributes
         pub enum #enum_name {
             #(
-                #notification_enumerators_pascal = #notification_enumerators_ord,
+                #notification_enumerators_shout = #notification_enumerators_ord,
             )*
 
             /// Since Godot represents notifications as integers, it's always possible that a notification outside the known types
@@ -117,7 +118,7 @@ pub fn make_notification_enum(
             fn from(enumerator: i32) -> Self {
                 match enumerator {
                     #(
-                        #notification_enumerators_ord => Self::#notification_enumerators_pascal,
+                        #notification_enumerators_ord => Self::#notification_enumerators_shout,
                     )*
                     other_int => Self::Unknown(other_int),
                 }
@@ -128,7 +129,7 @@ pub fn make_notification_enum(
             fn from(notification: #enum_name) -> i32 {
                 match notification {
                     #(
-                        #enum_name::#notification_enumerators_pascal => #notification_enumerators_ord,
+                        #enum_name::#notification_enumerators_shout => #notification_enumerators_ord,
                     )*
                     #enum_name::Unknown(int) => int,
                 }
@@ -141,27 +142,27 @@ pub fn make_notification_enum(
 
 /// Tries to interpret the constant as a notification one, and transforms it to a Rust identifier on success.
 pub fn try_to_notification(constant: &JsonClassConstant) -> Option<Ident> {
-    constant
-        .name
-        .strip_prefix("NOTIFICATION_")
-        .map(|s| util::ident(&conv::shout_to_pascal(s)))
+    constant.name.strip_prefix("NOTIFICATION_").map(util::ident) // used to be conv::shout_to_pascal(s)
 }
 
 // ----------------------------------------------------------------------------------------------------------------------------------------------
 // Implementation
 
-/// Workaround for Godot bug https://github.com/godotengine/godot/issues/75839
+/// Workaround for Godot bug https://github.com/godotengine/godot/issues/75839, fixed in 4.2.
 ///
 /// Godot has a collision for two notification constants (DRAW, NODE_CACHE_REQUESTED) in the same inheritance branch (as of 4.0.2).
 /// This cannot be represented in a Rust enum, so we merge the two constants into a single enumerator.
 fn workaround_constant_collision(all_constants: &mut Vec<(Ident, i32)>) {
+    #[cfg(before_api = "4.2")]
     for first in ["Draw", "VisibilityChanged"] {
         if let Some(index_of_draw) = all_constants
             .iter()
             .position(|(constant_name, _)| constant_name == first)
         {
-            all_constants[index_of_draw].0 = format_ident!("{first}OrNodeRecacheRequested");
+            all_constants[index_of_draw].0 = quote::format_ident!("{first}OrNodeRecacheRequested");
             all_constants.retain(|(constant_name, _)| constant_name != "NodeRecacheRequested");
         }
     }
+
+    let _ = &all_constants; // unused warning
 }

itest/rust/src/object_tests/onready_test.rs

@@ -58,7 +58,7 @@ fn onready_lifecycle_forget() {
     expect_panic(
         "Forgetting to initialize OnReady during ready() panics",
         move || {
-            forgetful.notify(NodeNotification::Ready);
+            forgetful.notify(NodeNotification::READY);
         },
     );
 
@@ -69,7 +69,7 @@ fn onready_lifecycle_forget() {
 fn onready_lifecycle() {
     let mut obj = OnReadyWithImpl::create(true);
 
-    obj.notify(NodeNotification::Ready);
+    obj.notify(NodeNotification::READY);
 
     {
         let mut obj = obj.bind_mut();
@@ -87,7 +87,7 @@ fn onready_lifecycle() {
 fn onready_lifecycle_without_impl() {
     let mut obj = OnReadyWithoutImpl::create();
 
-    obj.notify(NodeNotification::Ready);
+    obj.notify(NodeNotification::READY);
 
     {
         let mut obj = obj.bind_mut();
@@ -104,7 +104,7 @@ fn onready_lifecycle_without_impl() {
 fn onready_lifecycle_with_impl_without_ready() {
     let mut obj = OnReadyWithImplWithoutReady::create();
 
-    obj.notify(NodeNotification::Ready);
+    obj.notify(NodeNotification::READY);
 
     {
         let mut obj = obj.bind_mut();
@@ -123,7 +123,7 @@ fn onready_lifecycle_with_impl_without_ready() {
 #[itest]
 fn onready_property_access() {
     let mut obj = OnReadyWithImpl::create(true);
-    obj.notify(NodeNotification::Ready);
+    obj.notify(NodeNotification::READY);
 
     obj.set("auto".into(), 33.to_variant());
     obj.set("manual".into(), 44.to_variant());

itest/rust/src/object_tests/virtual_methods_test.rs

@@ -523,19 +523,19 @@ fn test_input_event_multiple(test_context: &TestContext) {
 fn test_notifications() {
     let obj = NotificationTest::new_alloc();
     let mut node = obj.clone().upcast::<Node>();
-    node.notify(NodeNotification::Unpaused);
-    node.notify(NodeNotification::EditorPostSave);
-    node.notify(NodeNotification::Ready);
-    node.notify_reversed(NodeNotification::WmSizeChanged);
+    node.notify(NodeNotification::UNPAUSED);
+    node.notify(NodeNotification::EDITOR_POST_SAVE);
+    node.notify(NodeNotification::READY);
+    node.notify_reversed(NodeNotification::WM_SIZE_CHANGED);
 
     assert_eq!(
         obj.bind().sequence,
         vec![
-            ReceivedEvent::Notification(NodeNotification::Unpaused),
-            ReceivedEvent::Notification(NodeNotification::EditorPostSave),
+            ReceivedEvent::Notification(NodeNotification::UNPAUSED),
+            ReceivedEvent::Notification(NodeNotification::EDITOR_POST_SAVE),
             ReceivedEvent::Ready,
-            ReceivedEvent::Notification(NodeNotification::Ready),
-            ReceivedEvent::Notification(NodeNotification::WmSizeChanged),
+            ReceivedEvent::Notification(NodeNotification::READY),
+            ReceivedEvent::Notification(NodeNotification::WM_SIZE_CHANGED),
         ]
     );
     obj.free();