rust - 如何在过程宏中处理枚举/结构/字段属性？

Question

Serde 支持应用与 #[derive(Serialize)] 一起使用的自定义属性:

#[derive(Serialize)]
struct Resource {
    // Always serialized.
    name: String,

    // Never serialized.
    #[serde(skip_serializing)]
    hash: String,

    // Use a method to decide whether the field should be skipped.
    #[serde(skip_serializing_if = "Map::is_empty")]
    metadata: Map<String, String>,
}

我了解如何实现过程宏(本例中为Serialize)，但我应该如何实现#[serde(skip_serializing)]？我无法在任何地方找到此信息。 docs甚至不要提这个。我试图查看 serde-derive 源代码，但它对我来说非常复杂。

Answer 1

1. 首先，您必须在注册程序宏的同一位置注册所有属性。假设我们要添加两个属性(我们仍然不讨论它们属于什么:结构或字段或两者):

    #[proc_macro_derive(FiniteStateMachine, attributes(state_transitions, state_change))]
    pub fn fxsm(input: TokenStream) -> TokenStream {
        // ...
    }
   

   之后您可能已经使用以下代码编译了您的用户代码:

    #[derive(Copy, Clone, Debug, FiniteStateMachine)]
    #[state_change(GameEvent, change_condition)] // optional
    enum GameState {
        #[state_transitions(NeedServer, Ready)]
        Prepare { players: u8 },
        #[state_transitions(Prepare, Ready)]
        NeedServer,
        #[state_transitions(Prepare)]
        Ready,
    }
   

   没有那个编译器会给出错误消息，如:

   state_change does not belong to any known attribute.

   这些属性是可选的，我们所做的只是允许它们被指定。当你派生你的程序宏时，你可以检查你想要的一切(包括属性存在)和 panic!在某些情况下，编译器会告知有意义的消息。

2. 现在我们来谈谈处理属性!让我们忘记 state_transitions attribute 因为它的处理与处理 struct/enum attributes 不会有太大差异(实际上它只是多了一点代码)并且谈论 state_change . syn crate 为您提供有关定义的所有必要信息(但不幸的是没有实现(我在这里谈论 impl)但这当然足以处理属性)。为了更详细，我们需要 syn::DeriveInput , syn::Body , syn::Variant , syn::Attribute最后 syn::MetaItem .

要处理一个字段的属性，您需要从一个到另一个遍历所有这些结构。当您到达 Vec<syn:: Attribute> - 这就是你想要的，一个字段所有属性的列表。这是我们的 state_transitions可以被找寻到。当你找到它时，你可能想要获取它的内容，这可以通过使用匹配 syn::MetaItem 来完成。枚举。只需阅读文档 :) 这是一个简单的示例代码，当我们找到 state_change 时会出现 panic 。某些字段上的属性加上它检查我们的目标实体是否派生 Copy或 Clone或者两者都不是:

    #[proc_macro_derive(FiniteStateMachine, attributes(state_transitions, state_change))]
    pub fn fxsm(input: TokenStream) -> TokenStream {
        // Construct a string representation of the type definition
        let s = input.to_string();

        // Parse the string representation
        let ast = syn::parse_derive_input(&s).unwrap();

        // Build the impl
        let gen = impl_fsm(&ast);

        // Return the generated impl
        gen.parse().unwrap()
    }

    fn impl_fsm(ast: &syn::DeriveInput) -> Tokens {
        const STATE_CHANGE_ATTR_NAME: &'static str = "state_change";

        if let syn::Body::Enum(ref variants) = ast.body {

            // Looks for state_change attriute (our attribute)
            if let Some(ref a) = ast.attrs.iter().find(|a| a.name() == STATE_CHANGE_ATTR_NAME) {
                if let syn::MetaItem::List(_, ref nested) = a.value {
                    panic!("Found our attribute with contents: {:?}", nested);
                }
            }

            // Looks for derive impls (not our attribute)
            if let Some(ref a) = ast.attrs.iter().find(|a| a.name() == "derive") {
                if let syn::MetaItem::List(_, ref nested) = a.value {
                    if derives(nested, "Copy") {
                        return gen_for_copyable(&ast.ident, &variants, &ast.generics);
                    } else if derives(nested, "Clone") {
                        return gen_for_clonable(&ast.ident, &variants, &ast.generics);
                    } else {
                        panic!("Unable to produce Finite State Machine code on a enum which does not drive Copy nor Clone traits.");
                    }
                } else {
                    panic!("Unable to produce Finite State Machine code on a enum which does not drive Copy nor Clone traits.");
                }
            } else {
                panic!("How have you been able to call me without derive!?!?");
            }
        } else {
            panic!("Finite State Machine must be derived on a enum.");
        }
    }

    fn derives(nested: &[syn::NestedMetaItem], trait_name: &str) -> bool {
        nested.iter().find(|n| {
            if let syn::NestedMetaItem::MetaItem(ref mt) = **n {
                if let syn::MetaItem::Word(ref id) = *mt {
                    return id == trait_name;
                }
                return false
            }
            false
        }).is_some()
    }

您可能有兴趣阅读 serde_codegen_internals , serde_derive , serenity's #[command] attr , another small project of mine - unique-type-id , fxsm-derive .最后一个链接实际上是我自己的项目，用于向自己解释如何在 Rust 中使用过程宏。

---

在一些 Rust 1.15 和更新 syn crate 之后，不再可能检查 enums/structs 的派生, 但是，其他一切正常。