Merge pull request #1234 from godot-rust/qol/vdict

Start phasing out `dict!` macro in favor of `vdict!`

Author: Bromeon

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

@@ -1531,7 +1531,7 @@ impl<T: ArrayElement> PartialOrd for Array<T> {
 /// # See also
 /// To create an `Array` of variants, see the [`varray!`] macro.
 ///
-/// For dictionaries, a similar macro [`dict!`] exists.
+/// For dictionaries, a similar macro [`vdict!`] exists.
 #[macro_export]
 macro_rules! array {
     ($($elements:expr),* $(,)?) => {
@@ -1558,7 +1558,7 @@ macro_rules! array {
 /// # See also
 /// To create a typed `Array` with a single element type, see the [`array!`] macro.
 ///
-/// For dictionaries, a similar macro [`dict!`] exists.
+/// For dictionaries, a similar macro [`vdict!`] exists.
 ///
 /// To construct slices of variants, use [`vslice!`].
 #[macro_export]
@@ -1604,7 +1604,7 @@ macro_rules! varray {
 /// # See also
 /// To create typed and untyped `Array`s, use the [`array!`] and [`varray!`] macros respectively.
 ///
-/// For dictionaries, a similar macro [`dict!`] exists.
+/// For dictionaries, a similar macro [`vdict!`] exists.
 #[macro_export]
 macro_rules! vslice {
     // Note: use to_variant() and not Variant::from(), as that works with both references and values

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

@@ -34,7 +34,7 @@ use std::{fmt, ptr};
 /// dict.set(coord, "Tile77");
 ///
 /// // Or create the same dictionary in a single expression.
-/// let dict = dict! {
+/// let dict = vdict! {
 ///    "str": "Hello",
 ///    "num": 23,
 ///    coord: "Tile77",
@@ -762,10 +762,10 @@ fn u8_to_bool(u: u8) -> bool {
 ///
 /// # Example
 /// ```no_run
-/// use godot::builtin::{dict, Variant};
+/// use godot::builtin::{vdict, Variant};
 ///
 /// let key = "my_key";
-/// let d = dict! {
+/// let d = vdict! {
 ///     "key1": 10,
 ///     "another": Variant::nil(),
 ///     key: true,
@@ -777,7 +777,7 @@ fn u8_to_bool(u: u8) -> bool {
 ///
 /// For arrays, similar macros [`array!`][macro@crate::builtin::array] and [`varray!`][macro@crate::builtin::varray] exist.
 #[macro_export]
-macro_rules! dict {
+macro_rules! vdict {
     ($($key:tt: $value:expr),* $(,)?) => {
         {
             let mut d = $crate::builtin::Dictionary::new();
@@ -791,3 +791,13 @@ macro_rules! dict {
         }
     };
 }
+
+#[macro_export]
+#[deprecated = "Migrate to `vdict!`. The name `dict!` will be used in the future for typed dictionaries."]
+macro_rules! dict {
+    ($($key:tt: $value:expr),* $(,)?) => {
+        $crate::vdict!(
+            $($key: $value),*
+        )
+    };
+}

godot-core/src/builtin/mod.rs

@@ -14,7 +14,8 @@
 //! [extended documentation page](../__docs/index.html#builtin-api-design).
 
 // Re-export macros.
-pub use crate::{array, dict, real, reals, varray};
+#[allow(deprecated)] // dict
+pub use crate::{array, dict, real, reals, varray, vdict};
 
 // Re-export generated enums.
 pub use crate::gen::central::global_reexported_enums::{Corner, EulerOrder, Side, VariantOperator};
@@ -48,7 +49,7 @@ pub mod __prelude_reexport {
     pub use vectors::*;
 
     pub use super::{EulerOrder, Side, VariantOperator, VariantType};
-    pub use crate::{array, dict, real, reals, varray, vslice};
+    pub use crate::{array, real, reals, varray, vdict, vslice};
 }
 
 pub use __prelude_reexport::*;

godot-core/src/registry/rpc_config.rs

@@ -10,7 +10,7 @@ use crate::classes::multiplayer_api::RpcMode;
 use crate::classes::multiplayer_peer::TransferMode;
 use crate::classes::Node;
 use crate::meta::{AsArg, ToGodot};
-use crate::{arg_into_ref, dict};
+use crate::{arg_into_ref, vdict};
 
 /// Configuration for a remote procedure call, used with `#[rpc(config = ...)]`.
 ///
@@ -45,7 +45,7 @@ impl RpcConfig {
 
     /// Returns a [`Dictionary`] populated with the values required for a call to [`Node::rpc_config()`].
     pub fn to_dictionary(&self) -> Dictionary {
-        dict! {
+        vdict! {
             "rpc_mode": self.rpc_mode,
             "transfer_mode": self.transfer_mode,
             "call_local": self.call_local,

itest/rust/build.rs

@@ -193,7 +193,7 @@ fn collect_inputs() -> Vec<Input> {
 
     pushs!(inputs; Dictionary, Dictionary,
         r#"{"key": 83, -3: Vector2(1, 2), 0.03: true}"#,
-        dict! { "key": 83, (-3): Vector2::new(1.0, 2.0), 0.03: true },
+        vdict! { "key": 83, (-3): Vector2::new(1.0, 2.0), 0.03: true },
         true, true, None
     );
 

itest/rust/src/builtin_tests/containers/callable_test.rs

@@ -7,7 +7,7 @@
 
 use crate::framework::itest;
 use godot::builtin::{
-    array, dict, varray, vslice, Array, Callable, Color, GString, NodePath, StringName, Variant,
+    array, varray, vdict, vslice, Array, Callable, Color, GString, NodePath, StringName, Variant,
     VariantArray, Vector2,
 };
 use godot::classes::{Node2D, Object, RefCounted};
@@ -102,7 +102,7 @@ fn callable_object_method() {
 #[cfg(since_api = "4.3")]
 fn callable_variant_method() {
     // Dictionary
-    let dict = dict! { "one": 1, "value": 2 };
+    let dict = vdict! { "one": 1, "value": 2 };
     let dict_get = Callable::from_variant_method(&dict.to_variant(), "get");
     assert_eq!(dict_get.call(vslice!["one"]), 1.to_variant());