1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
use proc_macro2::TokenStream;
use quote::{format_ident, quote};
use syn::punctuated::Punctuated;
use syn::{Token, Type};
/// Implements Extractable trait for structs, enums and unions
///
/// # Types requirements
///
/// All types must implement Clone, Debug and Codec
///
/// # Struct
///
/// Extractable can be used on struct with named or unnamed fields
///
/// ```ignore
/// # use extractable_macro::Extractable;
/// #[derive(Clone, Debug, Extractable)]
/// #[extractable(TestProtocolTypes)]
/// struct TestStruct {
/// a: u8,
/// b: f64,
/// }
/// ```
///
/// ## Ignore a field
///
/// The `#[extractable_ignore]` annotation allows to skip a field when extracting knowledges
///
/// ```ignore
/// # use extractable_macro::Extractable;
/// #[derive(Clone, Debug, Extractable)]
/// #[extractable(TestProtocolTypes)]
/// struct TestStruct {
/// a: u8,
/// #[extractable_ignore]
/// b: String, // this field won't be added to the knowledges
/// c: f64,
/// }
/// ```
///
/// ## Extract a field that doesn't implement Extractable
///
/// The `#[extractable_no_recursion]` annotation will add a field to the knowledge but won't call
/// `.extract_knowledge(...)` on this field. Use this on types that do no implement Extractable
///
/// ```ignore
/// #[derive(Clone, Debug, Extractable)]
/// #[extractable(TestProtocolTypes)]
/// struct TestStruct {
/// a: u8,
/// #[extractable_no_recursion]
/// b: CustomType,
/// }
/// ```
///
/// # Enums
///
/// Extractable can be used on enums with variant containing named or unnamed fields
///
/// ```ignore
/// #[derive(Clone, Debug, Extractable)]
/// #[extractable(TestProtocolTypes)]
/// enum TestEnum {
/// A,
/// B(String),
/// C{x: u8, y: u8},
/// }
/// ```
///
/// ## Ignore a field
///
/// The `#[extractable_ignore]` annotation allows to skip a field when extracting knowledges
///
/// ```ignore
/// #[derive(Clone, Debug, Extractable)]
/// #[extractable(TestProtocolTypes)]
/// enum TestEnum {
/// A,
/// B(#[extractable_ignore] String),
/// C{x: u8, y: u8},
/// }
/// ```
///
/// ## Extract a field that doesn't implement Extractable
///
/// The `#[extractable_no_recursion]` annotation will add a field to the knowledge but won't call
/// `.extract_knowledge(...)` on this field. Use this on types that do no implement Extractable
///
/// ```ignore
/// #[derive(Clone, Debug, Extractable)]
/// #[extractable(TestProtocolTypes)]
/// enum TestEnum {
/// A,
/// B(String),
/// C{x: u8,#[extractable_no_recursion] y: u8},
/// }
/// ```
///
/// # Unions
///
/// Union types can only extract `self` and do not support annotations
///
/// ```ignore
/// #[derive(Clone, Copy, Extractable)]
/// #[extractable(TestProtocolTypes)]
/// union TestUnion {
/// x: u8,
/// y: char,
/// }
/// ```
#[proc_macro_derive(
Extractable,
attributes(extractable, extractable_ignore, extractable_no_recursion,)
)]
pub fn extractable_macro(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
let input = syn::parse_macro_input!(input as syn::DeriveInput);
let attribute = input
.attrs
.iter()
.find(|a| a.path().segments.len() == 1 && a.path().segments[0].ident == "extractable")
.expect("extractable attribute required for deriving Extractable!");
let types = TypesParam::parse(attribute).expect(
"failed parsing extractable attribute : expected #[attribute(ProtocolType, Matcher)]",
);
let fields = map_type_definition(&input, &types.protocol_types);
generate_impl(
&input.ident,
&input.generics,
&types.protocol_types,
&fields,
)
.into()
}
struct TypesParam {
protocol_types: syn::Type,
}
impl TypesParam {
fn parse(input: &syn::Attribute) -> syn::Result<Self> {
let types_tokens =
input.parse_args_with(Punctuated::<Type, Token![,]>::parse_terminated)?;
let mut type_iter = types_tokens.iter();
Ok(Self {
protocol_types: type_iter
.next()
.expect("Missing ProtocolType type")
.to_owned(),
})
}
}
fn generate_impl(
name: &syn::Ident,
generics: &syn::Generics,
protocol_type: &syn::Type,
fields: &TokenStream,
) -> TokenStream {
let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();
quote! {
impl #impl_generics puffin::protocol::Extractable<#protocol_type> for #name #ty_generics #where_clause {
fn extract_knowledge<'a>(
&'a self,
knowledges: &mut Vec<puffin::trace::Knowledge<'a, #protocol_type>>,
matcher: Option<<#protocol_type as puffin::protocol::ProtocolTypes>::Matcher>,
source: &'a puffin::trace::Source,
) -> Result<(), puffin::error::Error> {
knowledges.push(puffin::trace::Knowledge {
source,
matcher: matcher.clone(),
data: self,
});
#fields
Ok(())
}
}
}
}
fn has_attr<'a>(attrs: &'a [syn::Attribute], attr_name: &str) -> Option<&'a syn::Attribute> {
attrs.iter().find(|attr| attr.path().is_ident(attr_name))
}
fn extract_fields<'a>(
fields: impl IntoIterator<Item = &'a syn::Field>,
protocol_types: &syn::Type,
f: impl Fn(usize, Option<syn::Ident>) -> TokenStream,
) -> Vec<TokenStream> {
let mut result = vec![];
for (idx, field) in fields.into_iter().enumerate() {
if has_attr(&field.attrs, "extractable_ignore").is_none() {
let field_name = f(idx, field.ident.clone());
if has_attr(&field.attrs, "extractable_no_recursion").is_none() {
result.push(quote! {
puffin::protocol::Extractable::<#protocol_types>::extract_knowledge(#field_name, knowledges, matcher.clone(), source)?;
})
} else {
result.push(quote! {
knowledges.push(puffin::trace::Knowledge {
source,
matcher: matcher.clone(),
data: #field_name,
});
})
}
}
}
result
}
fn extract_variants<'a>(
name: &syn::Ident,
protocol_types: &syn::Type,
variants: impl IntoIterator<Item = &'a syn::Variant>,
) -> Vec<TokenStream> {
let mut result = vec![];
for variant in variants {
let variant_name = &variant.ident;
match &variant.fields {
syn::Fields::Named(named) => {
let field_extractions =
extract_fields(named.named.iter(), protocol_types, |_, idt| {
let name = idt.expect("unnamed field in named enum");
quote! {#name}
});
let fields = named
.named
.iter()
.map(|x| {
let id = x.ident.as_ref().expect("unnamed field in named enum");
quote! {#id}
})
.collect::<Vec<_>>();
result.push(quote! {
#name::#variant_name{#(#fields),*} => { #(#field_extractions)* }
});
}
syn::Fields::Unnamed(unnamed) => {
let field_extractions =
extract_fields(unnamed.unnamed.iter(), protocol_types, |idx, _| {
let name = format_ident!("field_{}", syn::Index::from(idx));
quote! {#name}
});
let fields = unnamed
.unnamed
.iter()
.enumerate()
.map(|(pos, _)| {
let id = format_ident!("field_{}", pos);
quote! {#id}
})
.collect::<Vec<_>>();
result.push(quote! {
#name::#variant_name(#(#fields),*) => { #(#field_extractions)* }
});
}
syn::Fields::Unit => {
result.push(quote! {
#name::#variant_name => {}
});
}
}
}
result
}
fn map_type_definition(input: &syn::DeriveInput, protocol_types: &syn::Type) -> TokenStream {
let body = match &input.data {
syn::Data::Struct(st) => match &st.fields {
syn::Fields::Named(named) => {
let field_extractions =
extract_fields(named.named.iter(), protocol_types, |_, idt| {
let name = idt.expect("unnamed field in named struct");
quote! {&self.#name}
});
quote! {
#(#field_extractions )*
}
}
syn::Fields::Unnamed(unnamed) => {
let field_extractions =
extract_fields(unnamed.unnamed.iter(), protocol_types, |idx, _| {
let name = syn::Index::from(idx);
quote! {&self.#name}
});
quote! {
#(#field_extractions )*
}
}
syn::Fields::Unit => {
quote! {}
}
},
syn::Data::Enum(en) => {
let variants_extractions =
extract_variants(&input.ident, protocol_types, en.variants.iter());
quote! {
match &self {
#(#variants_extractions ),*
_ => ()
}
}
}
syn::Data::Union(_un) => {
quote! {}
}
};
quote! {
#body
}
}