rust - 我可以重写这个宏规则吗!宏以一种与 rustfmt 一起工作的方式？

Question

我想使用宏来生成相同的 impl多种混凝土类型的块。我的代码目前看起来像这样:

macro_rules! impl_methods {
    ($ty:ty, {  $($method:item);+} ) => {
        impl $ty { $($method)+ }
    };
    ($ty:ty, $($more:ty),+ {$($method:item);+}) => {
        impl_methods!($ty, {$($method);+});
        impl_methods!($($more),+, {$($method);+});
    };
}

struct Hi;
struct Hello;

impl_methods!(Hi, Hello {
    /// `true` if it works, good
    fn works_good(&self) -> bool {
        true
    };

    /// `true` if rustfmt is working
    fn gets_rustfmt(&self) -> bool {
        false
    }
});

assert!(Hi.works_good() && Hello.works_good());
assert!(!(Hi.gets_rustfmt() | Hello.gets_rustfmt()));

这工作得很好(impls 被生成)，但它有一个令人沮丧的问题；宏内部定义的方法不会被 rustfmt 格式化.

这是一个小问题，但它很烦人，以至于我对解决方案感到好奇。我知道 rustfmt 将格式化宏的内容，如果这些内容具有某种形式(是表达式？)，因此例如以下宏的内容将被格式化:

macro_rules! fmt_me {
    ($inner:item) => {
        $inner
    };
}

fmt_me!(fn will_get_formatted() -> bool { true });

所以我希望有某种方法可以编写我的宏，例如，

impl_methods!(Hi, Hello {
    fmt_me!(fn my_method(&self) -> bool { true });
    fmt_me!(fn my_other_method(&self) -> bool { false });
});

并让 rustfmt 涵盖每个单独的方法。

这可能吗？有什么神奇的咒语可以给我我想要的可爱的格式吗？

回答

感谢下面的答案(来自@seiichi-uchida)，我可以使用以下代码来解决这个问题:

macro_rules! impl_methods {
    ($ty:ty, {  $($method:item)+} ) => {
        impl $ty { $($method)+ }
    };
    ($ty:ty, $($more:ty),+, {$($method:item)+}) => {
        impl_methods!($ty, {$($method)+});
        impl_methods!($($more),+, {$($method)+});
    };
}

macro_rules! fmt_me {
    ($inner:item) => {
        $inner
    };
}

// called like:

impl_methods!(Hi, Hello, {
    fmt_me!(fn this_is_a_method(&self) -> bool { true });
    fmt_me!(fn this_is_another_method(&self) -> bool { true });
});

Answer 1

在最后一个类型和 impl 块之间添加一个逗号应该可以解决问题:

impl_methods!(Hi, Hello, {
    fmt_me!(fn my_method(&self) -> bool { true });
    fmt_me!(fn my_other_method(&self) -> bool { false });
});

这将被格式化为:

 impl_methods!(Hi, Hello, {
-    fmt_me!(fn my_method(&self) -> bool { true });
-    fmt_me!(fn my_other_method(&self) -> bool { false });
+    fmt_me!(
+        fn my_method(&self) -> bool {
+            true
+        }
+    );
+    fmt_me!(
+        fn my_other_method(&self) -> bool {
+            false
+        }
+    );
 });

一般来说，rustfmt 只能格式化宏调用，其参数可以被解析为有效的 Rust AST 节点(有一些异常(exception))。