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
#![doc = include_str!("./lib.md")]
use proc_macro::TokenStream;
use quote::quote;
use syn;
use attribute_derive::Attribute;
#[derive(Attribute, Default, Debug)]
#[attribute(ident = get_size)]
struct StructFieldAttribute {
#[attribute(conflicts = [size_fn, ignore])]
size: Option<usize>,
#[attribute(conflicts = [size, ignore])]
size_fn: Option<syn::Ident>,
#[attribute(conflicts = [size, size_fn])]
ignore: bool,
}
fn extract_ignored_generics_list(list: &Vec<syn::Attribute>) -> Vec<syn::PathSegment> {
let mut collection = Vec::new();
for attr in list.iter() {
let mut list = extract_ignored_generics(attr);
collection.append(&mut list);
}
collection
}
fn extract_ignored_generics(attr: &syn::Attribute) -> Vec<syn::PathSegment> {
let mut collection = Vec::new();
// Skip all attributes which do not belong to us.
if !attr.meta.path().is_ident("get_size") {
return collection;
}
// Make sure it is a list.
let list = attr.meta.require_list().unwrap();
// Parse the nested meta.
// #[get_size(ignore(A, B))]
list.parse_nested_meta(|meta| {
// We only parse the ignore attributes.
if !meta.path.is_ident("ignore") {
return Ok(()); // Just skip.
}
meta.parse_nested_meta(|meta| {
for segment in meta.path.segments {
collection.push(segment);
}
Ok(())
})?;
Ok(())
}).unwrap();
collection
}
// Add a bound `T: GetSize` to every type parameter T, unless we ignore it.
fn add_trait_bounds(
mut generics: syn::Generics,
ignored: &Vec<syn::PathSegment>,
) -> syn::Generics {
for param in &mut generics.params {
if let syn::GenericParam::Type(type_param) = param {
let mut found = false;
for ignored in ignored.iter() {
if ignored.ident==type_param.ident {
found = true;
break;
}
}
if found {
continue;
}
type_param.bounds.push(syn::parse_quote!(GetSize));
}
}
generics
}
#[proc_macro_derive(GetSize, attributes(get_size))]
pub fn derive_get_size(input: TokenStream) -> TokenStream {
// Construct a representation of Rust code as a syntax tree
// that we can manipulate
let ast: syn::DeriveInput = syn::parse(input).unwrap();
// The name of the sruct.
let name = &ast.ident;
// Extract all generics we shall ignore.
let ignored = extract_ignored_generics_list(&ast.attrs);
// Add a bound `T: GetSize` to every type parameter T.
let generics = add_trait_bounds(ast.generics, &ignored);
// Extract the generics of the struct/enum.
let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();
// Traverse the parsed data to generate the individual parts of the function.
match ast.data {
syn::Data::Enum(data_enum) => {
if data_enum.variants.is_empty() {
// Empty enums are easy to implement.
let gen = quote! {
impl GetSize for #name {}
};
return gen.into()
}
let mut cmds = Vec::with_capacity(data_enum.variants.len());
for variant in data_enum.variants.iter() {
let ident = &variant.ident;
match &variant.fields {
syn::Fields::Unnamed(unnamed_fields) => {
let num_fields = unnamed_fields.unnamed.len();
let mut field_idents = Vec::with_capacity(num_fields);
for i in 0..num_fields {
let field_ident = String::from("v")+&i.to_string();
let field_ident = syn::parse_str::<syn::Ident>(&field_ident).unwrap();
field_idents.push(field_ident);
}
let mut field_cmds = Vec::with_capacity(num_fields);
for (i, _field) in unnamed_fields.unnamed.iter().enumerate() {
let field_ident = String::from("v")+&i.to_string();
let field_ident = syn::parse_str::<syn::Ident>(&field_ident).unwrap();
field_cmds.push(quote! {
total += GetSize::get_heap_size(#field_ident);
})
}
cmds.push(quote! {
Self::#ident(#(#field_idents,)*) => {
let mut total = 0;
#(#field_cmds)*;
total
}
});
}
syn::Fields::Named(named_fields) => {
let num_fields = named_fields.named.len();
let mut field_idents = Vec::with_capacity(num_fields);
let mut field_cmds = Vec::with_capacity(num_fields);
for field in named_fields.named.iter() {
let field_ident = field.ident.as_ref().unwrap();
field_idents.push(field_ident);
field_cmds.push(quote! {
total += GetSize::get_heap_size(#field_ident);
})
}
cmds.push(quote! {
Self::#ident{#(#field_idents,)*} => {
let mut total = 0;
#(#field_cmds)*;
total
}
});
}
syn::Fields::Unit => {
cmds.push(quote! {
Self::#ident => 0,
});
}
}
}
// Build the trait implementation
let gen = quote! {
impl #impl_generics GetSize for #name #ty_generics #where_clause {
fn get_heap_size(&self) -> usize {
match self {
#(#cmds)*
}
}
}
};
return gen.into();
}
syn::Data::Union(_data_union) => panic!("Deriving GetSize for unions is currently not supported."),
syn::Data::Struct(data_struct) => {
if data_struct.fields.is_empty() {
// Empty structs are easy to implement.
let gen = quote! {
impl GetSize for #name {}
};
return gen.into();
}
let mut cmds = Vec::with_capacity(data_struct.fields.len());
let mut unidentified_fields_count = 0; // For newtypes
for field in data_struct.fields.iter() {
// Parse all relevant attributes.
let attr = StructFieldAttribute::from_attributes(&field.attrs).unwrap();
// NOTE There will be no attributes if this is a tuple struct.
if let Some(size) = attr.size {
cmds.push(quote! {
total += #size;
});
continue;
} else if let Some(size_fn) = attr.size_fn {
let ident = field.ident.as_ref().unwrap();
cmds.push(quote! {
total += #size_fn(&self.#ident);
});
continue;
} else if attr.ignore {
continue;
}
if let Some(ident) = field.ident.as_ref() {
cmds.push(quote! {
total += GetSize::get_heap_size(&self.#ident);
});
} else {
let current_index = syn::Index::from(unidentified_fields_count);
cmds.push(quote! {
total += GetSize::get_heap_size(&self.#current_index);
});
unidentified_fields_count += 1;
}
}
// Build the trait implementation
let gen = quote! {
impl #impl_generics GetSize for #name #ty_generics #where_clause {
fn get_heap_size(&self) -> usize {
let mut total = 0;
#(#cmds)*;
total
}
}
};
return gen.into();
},
}
}