我想编写一个从整数参数生成不同结构的宏。例如,make_struct!(3)
可能会生成如下内容:
pub struct MyStruct3 {
field_0: u32,
field_1: u32,
field_2: u32
}
将“3”文字转换为可用于生成代码的数字的最佳方法是什么?我应该使用macro_rules!
还是一个proc-macro
?
我想编写一个从整数参数生成不同结构的宏。例如,make_struct!(3)
可能会生成如下内容:
pub struct MyStruct3 {
field_0: u32,
field_1: u32,
field_2: u32
}
将“3”文字转换为可用于生成代码的数字的最佳方法是什么?我应该使用macro_rules!
还是一个proc-macro
?
您需要一个程序属性宏和相当多的管道。Github上有一个示例实现;请记住,它的边缘非常粗糙,但开始时效果很好。
目标是有以下几点:
#[derivefields(u32, "field", 3)]
struct MyStruct {
foo: u32
}
转译为:
struct MyStruct {
pub field_0: u32,
pub field_1: u32,
pub field_2: u32,
foo: u32
}
为此,首先,我们将建立几件事。我们将需要一个struct
轻松存储和检索我们的参数:
struct MacroInput {
pub field_type: syn::Type,
pub field_name: String,
pub field_count: u64
}
剩下的就是管道:
impl Parse for MacroInput {
fn parse(input: ParseStream) -> syn::Result<Self> {
let field_type = input.parse::<syn::Type>()?;
let _comma = input.parse::<syn::token::Comma>()?;
let field_name = input.parse::<syn::LitStr>()?;
let _comma = input.parse::<syn::token::Comma>()?;
let count = input.parse::<syn::LitInt>()?;
Ok(MacroInput {
field_type: field_type,
field_name: field_name.value(),
field_count: count.base10_parse().unwrap()
})
}
}
这定义syn::Parse
了我们struct
并允许我们使用syn::parse_macro_input!()
来轻松解析我们的参数。
#[proc_macro_attribute]
pub fn derivefields(attr: TokenStream, item: TokenStream) -> TokenStream {
let input = syn::parse_macro_input!(attr as MacroInput);
let mut found_struct = false; // We actually need a struct
item.into_iter().map(|r| {
match &r {
&proc_macro::TokenTree::Ident(ref ident) if ident.to_string() == "struct" => { // react on keyword "struct" so we don't randomly modify non-structs
found_struct = true;
r
},
&proc_macro::TokenTree::Group(ref group) if group.delimiter() == proc_macro::Delimiter::Brace && found_struct == true => { // Opening brackets for the struct
let mut stream = proc_macro::TokenStream::new();
stream.extend((0..input.field_count).fold(vec![], |mut state:Vec<proc_macro::TokenStream>, i| {
let field_name_str = format!("{}_{}", input.field_name, i);
let field_name = Ident::new(&field_name_str, Span::call_site());
let field_type = input.field_type.clone();
state.push(quote!(pub #field_name: #field_type,
).into());
state
}).into_iter());
stream.extend(group.stream());
proc_macro::TokenTree::Group(
proc_macro::Group::new(
proc_macro::Delimiter::Brace,
stream
)
)
}
_ => r
}
}).collect()
}
修饰符的行为会创建一个新的并首先TokenStream
添加我们的字段。这是极其重要的;假设提供的结构是; 追加last会由于缺少. 前置允许我们不必关心这一点,因为结构中的尾随逗号不是解析错误。struct Foo { bar: u8 }
,
一旦我们有了这个TokenStream
,我们依次extend()
使用生成的令牌quote::quote!()
;这使我们不必自己构建令牌片段。一个问题是字段名称需要转换为Ident
(否则会被引用,这不是我们想要的)。
然后我们将这个修改后的返回TokenStream
aTokenTree::Group
以表示这确实是一个由括号分隔的块。
在这样做的过程中,我们还解决了一些问题:
pub struct Foo(u32)
例如)的结构实际上从来没有左括号,因此此宏对此无操作