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 322 323 324 325 326 327 328 329 330 331 332 333
use proc_macro::TokenStream; use proc_macro_error::*; use syn; use quote::quote; struct Flag { value: TokenStream, name: String, method_name: Option<syn::Ident>, doc: Option<String>, } impl Flag { fn method_name(&self) -> syn::Ident { if let Some(ident) = &self.method_name { ident.clone() } else { syn::Ident::new(&self.name, proc_macro2::Span::call_site()) } } } enum DebugMode { None, Standard, Compact } struct FlagImpl { struct_name: syn::Ident, backing_field_name: syn::Member, flags: Vec<Flag>, debug_mode: DebugMode } fn get_value(lit: &syn::Lit, value_type: &syn::Type) -> TokenStream { use syn::Lit::*; let result = match lit { Int(_) => quote!{ #lit as #value_type }, Str(s) => { let expr: syn::Expr = match syn::parse_str(&s.value()) { Ok(expr) => expr, _ => { abort!(lit, "String must contain a valid expression"); } }; quote! { (#expr) as #value_type } }, _ => abort!(lit, "Bad value, must be an integer literal or string.") }; result.into() } fn get_name(lit: &syn::Lit) -> String { use syn::Lit::*; match &lit { Str(s) => s.value(), _ => panic!("Bad name") } } fn get_method_name(lit: &syn::Lit) -> syn::Ident { use syn::{Lit::*, Ident}; match &lit { Str(s) => Ident::new(&s.value(), lit.span()), _ => panic!("Bad method_name") } } fn get_doc(lit: &syn::Lit) -> String { use syn::Lit::*; match &lit { Str(s) => s.value(), _ => panic!("Bad doc attribute") } } fn parse_flag(attr: syn::Meta, value_type: &syn::Type) -> Flag { let mut name = None; let mut value = None; let mut method_name = None; let mut doc = None; if let syn::Meta::List(attr) = &attr { use syn::{Meta::NameValue, NestedMeta::Meta}; let args = &attr.nested; for arg in args { if let Meta(NameValue(m)) = arg { if let Some(n) = m.path.get_ident() { match n.to_string().as_str() { "name" => name = Some(get_name(&m.lit)), "value" => value = Some(get_value(&m.lit, value_type)), "method_name" => method_name = Some(get_method_name(&m.lit)), "doc" => doc = Some(get_doc(&m.lit)), s => abort!(arg, r#"Unknown configuration option "{}". Expected one of [name, value, method_name, doc]"#, s) } } } } } if let (Some(name), Some(value)) = (name, value) { Flag { name, value, method_name, doc } } else { abort!(attr, "Missing name or value argument for flag.") } } fn get_backing_field(input: &syn::DeriveInput) -> (syn::Member, syn::Field) { let st = if let syn::Data::Struct(ds) = &input.data { ds } else { abort!(input, "Must be a struct") }; let candidates: Vec<(syn::Member, &syn::Field)> = match &st.fields { syn::Fields::Named(named) => { named.named.iter() .filter(|f| f.attrs.iter().any(|a| a.path.is_ident("flag_backing_field"))) .map(|f| (syn::Member::Named(f.ident.clone().unwrap()), f)) .collect() }, syn::Fields::Unnamed(unnamed) => { unnamed.unnamed.iter() .enumerate() .filter(|(_, f)| f.attrs.iter().any(|a| a.path.is_ident("flag_backing_field"))) .map(|(i, f)| (syn::Member::Unnamed(syn::Index::from(i)), f)) .collect() }, _ => vec![] }; if candidates.len() == 1 { let (ident, field) = candidates.first().unwrap(); (ident.clone().into(), (*field).clone().into()) } else { abort!(input, r#"Exactly one backing field must have the "flag_backing_field" attribute"#) } } fn parse_impl(input: TokenStream) -> FlagImpl { use syn::Meta::*; let ast: syn::DeriveInput = syn::parse(input).unwrap(); let (backing_field_name, backing_field) = get_backing_field(&ast); let struct_name = ast.ident.clone(); let mut flags = vec![]; let mut debug_mode = DebugMode::None; for attr in ast.attrs { if let Some(name) = attr.path.get_ident() { match name.to_string().as_str() { "flag" => { let meta = attr.parse_meta().unwrap_or_else(|_| abort!(attr, "Bad attribute arguments")); let flag = parse_flag(meta, &backing_field.ty); flags.push(flag); }, "flag_debug" => { let meta = attr.parse_meta(); match meta { Ok(Path(_)) => debug_mode = DebugMode::Standard, Ok(List(ml)) => { if let Some(syn::NestedMeta::Meta(m)) = ml.nested.first() { if ml.nested.len() == 1 && m.path().is_ident("compact") { debug_mode = DebugMode::Compact; continue; } else { abort!(ml, "Bad option for flag_meta attribute"); } } else { debug_mode = DebugMode::Standard; } } _ => abort!(attr, "Bad attribute arguments") } } _ => () } } } FlagImpl { struct_name, backing_field_name, flags, debug_mode } } #[proc_macro_derive(Flags, attributes(flag, flag_backing_field, flag_debug))] #[proc_macro_error] pub fn derive_flags(input: TokenStream) -> TokenStream { let mut flag_impl = parse_impl(input); let backing_field_name = flag_impl.backing_field_name; let struct_name = flag_impl.struct_name; let mut methods = vec![]; let mut debug_fragments = vec![]; for flag in flag_impl.flags.drain(..) { use quote::format_ident; let name = flag.name.clone(); let method_name = flag.method_name(); let value: proc_macro2::TokenStream = flag.value.into(); match flag_impl.debug_mode { DebugMode::None => (), DebugMode::Standard => { debug_fragments.push(quote!{ .field(stringify!(#method_name), &self.#method_name()) }); }, DebugMode::Compact => { debug_fragments.push(quote!{ if self.#method_name() { dbg.entry(&#name); } }); } } let (doc, set_doc, only_doc) = { let doc_template = "Gets the value for the flag."; let set_template = "Sets the flag to the given value."; let only_template = "Checks if this flag is the only one set."; if let Some(doc) = flag.doc { let doc_str = format!("{}\n\n{}", doc, doc_template); let set_str = format!("{}\n\n{}", doc, set_template); let only_str = format!("{}\n\n{}", doc, only_template); ( quote!{ #[doc = #doc_str] }, quote!{ #[doc = #set_str] }, quote!{ #[doc = #only_str] } ) } else { ( quote!{ #[doc = #doc_template] }, quote!{ #[doc = #set_template] }, quote!{ #[doc = #only_template] } ) } }; let setter_name = format_ident!("set_{}", method_name); let exclusive_name = format_ident!("only_{}", method_name); let flag_methods = quote!{ #doc pub fn #method_name(&self) -> bool { self.#backing_field_name & (#value) == (#value) } #only_doc pub fn #exclusive_name(&self) -> bool { self.#backing_field_name | (#value) == (#value) } #set_doc pub fn #setter_name(&mut self, value: bool) -> &Self { if value { self.#backing_field_name |= (#value); } else { self.#backing_field_name &= !(#value) } self } }; methods.push(flag_methods); } let main_impl = quote!{ impl #struct_name { #(#methods)* } }; let debug_impl = match flag_impl.debug_mode { DebugMode::None => quote!{}, DebugMode::Standard => quote!{ impl core::fmt::Debug for #struct_name { fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result { f.debug_struct(stringify!(#struct_name)) #(#debug_fragments)* .finish() } } }, DebugMode::Compact => quote!{ impl core::fmt::Debug for #struct_name { fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result { write!(f, "{} ", stringify!(#struct_name))?; let mut dbg = f.debug_set(); #(#debug_fragments)* dbg.finish() } } } }; (quote!{ #main_impl #debug_impl }).into() }