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
extern crate proc_macro2; extern crate syn; #[macro_use] extern crate synstructure; #[macro_use] extern crate quote; use proc_macro2::{TokenStream, Span}; use syn::LitStr; use syn::spanned::Spanned; #[derive(Debug)] struct Error(TokenStream); impl Error { fn new(span: Span, message: &str) -> Error { Error(quote_spanned! { span => compile_error!(#message); }) } fn into_tokens(self) -> TokenStream { self.0 } } impl From<syn::Error> for Error { fn from(e: syn::Error) -> Error { Error(e.to_compile_error()) } } decl_derive!([Fail, attributes(fail, cause)] => fail_derive); fn fail_derive(s: synstructure::Structure) -> TokenStream { match fail_derive_impl(s) { Err(err) => err.into_tokens(), Ok(tokens) => tokens, } } fn fail_derive_impl(s: synstructure::Structure) -> Result<TokenStream, Error> { let make_dyn = if cfg!(has_dyn_trait) { quote! { &dyn } } else { quote! { & } }; let ty_name = LitStr::new(&s.ast().ident.to_string(), Span::call_site()); let cause_body = s.each_variant(|v| { if let Some(cause) = v.bindings().iter().find(is_cause) { quote!(return Some(::failure::AsFail::as_fail(#cause))) } else { quote!(return None) } }); let bt_body = s.each_variant(|v| { if let Some(bi) = v.bindings().iter().find(is_backtrace) { quote!(return Some(#bi)) } else { quote!(return None) } }); let fail = s.unbound_impl( quote!(::failure::Fail), quote! { fn name(&self) -> Option<&str> { Some(concat!(module_path!(), "::", #ty_name)) } #[allow(unreachable_code)] fn cause(&self) -> ::failure::_core::option::Option<#make_dyn(::failure::Fail)> { match *self { #cause_body } None } #[allow(unreachable_code)] fn backtrace(&self) -> ::failure::_core::option::Option<&::failure::Backtrace> { match *self { #bt_body } None } }, ); let display = display_body(&s)?.map(|display_body| { s.unbound_impl( quote!(::failure::_core::fmt::Display), quote! { #[allow(unreachable_code)] fn fmt(&self, f: &mut ::failure::_core::fmt::Formatter) -> ::failure::_core::fmt::Result { match *self { #display_body } write!(f, "An error has occurred.") } }, ) }); Ok(quote! { #fail #display }) } fn display_body(s: &synstructure::Structure) -> Result<Option<TokenStream>, Error> { let mut msgs = s.variants().iter().map(|v| find_error_msg(&v.ast().attrs)); if msgs.all(|msg| msg.map(|m| m.is_none()).unwrap_or(true)) { return Ok(None); } let mut tokens = TokenStream::new(); for v in s.variants() { let msg = find_error_msg(&v.ast().attrs)? .ok_or_else(|| Error::new( v.ast().ident.span(), "All variants must have display attribute." ))?; if msg.nested.is_empty() { return Err(Error::new( msg.span(), "Expected at least one argument to fail attribute" )); } let format_string = match msg.nested[0] { syn::NestedMeta::Meta(syn::Meta::NameValue(ref nv)) if nv.path.is_ident("display") => { nv.lit.clone() } _ => { return Err(Error::new( msg.span(), "Fail attribute must begin `display = \"\"` to control the Display message." )); } }; let args = msg.nested.iter().skip(1).map(|arg| match *arg { syn::NestedMeta::Lit(syn::Lit::Int(ref i)) => { let bi = &v.bindings()[i.base10_parse::<usize>()?]; Ok(quote!(#bi)) } syn::NestedMeta::Meta(syn::Meta::Path(ref path)) => { let id_s = path.get_ident().map(syn::Ident::to_string).unwrap_or("".to_string()); if id_s.starts_with("_") { if let Ok(idx) = id_s[1..].parse::<usize>() { let bi = match v.bindings().get(idx) { Some(bi) => bi, None => { return Err(Error::new( arg.span(), &format!( "display attempted to access field `{}` in `{}::{}` which \ does not exist (there are {} field{})", idx, s.ast().ident, v.ast().ident, v.bindings().len(), if v.bindings().len() != 1 { "s" } else { "" } ) )); } }; return Ok(quote!(#bi)); } } for bi in v.bindings() { let id = bi.ast().ident.as_ref(); if id.is_some() && path.is_ident(id.unwrap()) { return Ok(quote!(#bi)); } } return Err(Error::new( arg.span(), &format!( "Couldn't find field `{:?}` in `{}::{}`", path, s.ast().ident, v.ast().ident ) )); } ref arg => { return Err(Error::new( arg.span(), "Invalid argument to fail attribute!" )); }, }); let args = args.collect::<Result<Vec<_>, _>>()?; let pat = v.pat(); tokens.extend(quote!(#pat => { return write!(f, #format_string #(, #args)*) })); } Ok(Some(tokens)) } fn find_error_msg(attrs: &[syn::Attribute]) -> Result<Option<syn::MetaList>, Error> { let mut error_msg = None; for attr in attrs { if let Ok(meta) = attr.parse_meta() { if meta.path().is_ident("fail") { if error_msg.is_some() { return Err(Error::new( meta.span(), "Cannot have two display attributes" )); } else { if let syn::Meta::List(list) = meta { error_msg = Some(list); } else { return Err(Error::new( meta.span(), "fail attribute must take a list in parentheses" )); } } } } } Ok(error_msg) } fn is_backtrace(bi: &&synstructure::BindingInfo) -> bool { match bi.ast().ty { syn::Type::Path(syn::TypePath { qself: None, path: syn::Path { segments: ref path, .. }, }) => path.last().map_or(false, |s| { s.ident == "Backtrace" && s.arguments.is_empty() }), _ => false, } } fn is_cause(bi: &&synstructure::BindingInfo) -> bool { let mut found_cause = false; for attr in &bi.ast().attrs { if let Ok(meta) = attr.parse_meta() { if meta.path().is_ident("cause") { if found_cause { panic!("Cannot have two `cause` attributes"); } found_cause = true; } if meta.path().is_ident("fail") { if let syn::Meta::List(ref list) = meta { if let Some(ref pair) = list.nested.first() { if let &&syn::NestedMeta::Meta(syn::Meta::Path(ref path)) = pair { if path.is_ident("cause") { if found_cause { panic!("Cannot have two `cause` attributes"); } found_cause = true; } } } } } } } found_cause }