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
//! Derive custom errors using macros 1.1

extern crate proc_macro;
extern crate syn;
#[macro_use]
extern crate quote;
extern crate case;

use proc_macro::TokenStream;
use quote::Tokens;
use syn::{MacroInput, Ident};
use syn::Body::{Struct, Enum};
use case::CaseExt;

#[derive(Debug)]
struct Error {
    ast: MacroInput,
    display: Tokens,
    description: Tokens,
    cause: Tokens,
    from_impls: Tokens,
}

#[proc_macro_derive(Error)]
pub fn derive_error(input: TokenStream) -> TokenStream {
    let source = input.to_string();
    let ast = syn::parse_macro_input(&source).unwrap();
    Error::new(ast).derive().parse().unwrap()
}

impl Error {
    fn new(ast: MacroInput) -> Error {
        Error {
            ast: ast,
            display: Tokens::new(),
            description: Tokens::new(),
            cause: Tokens::new(),
            from_impls: Tokens::new(),
        }
    }

    // Derives a new error
    fn derive(mut self) -> Tokens {
        match self.ast.body.clone() {
            Struct(ref variants) => {
                match *variants {
                    syn::VariantData::Unit => {
                        self.empty();
                    }
                    _ => {
                        panic!("Only deriving from unit structs is supported. Use an enum instead.");
                    }
                }
            }

            Enum(ref variants) => {
                if variants.is_empty() {
                    self.empty();
                } else {
                    for var in variants {
                        let var_name = &var.ident;
                        let msg = self.title(&var.attrs).unwrap_or_else(|| self.label_str(&var_name.to_string()));
                        match var.data {
                            syn::VariantData::Unit => {
                                self.unit_variant(var_name, &msg);
                            }
                            syn::VariantData::Tuple(ref fields) => {
                                self.tuple_variant(var_name, &msg, fields);
                            }
                            syn::VariantData::Struct(ref fields) => {
                                self.struct_field(var_name, &msg, fields);
                            }
                        }
                    }
                    let display = self.display;
                    self.display = quote!{ match *self { #display } };
                    let description = self.description;
                    self.description = quote!{ match *self { #description } };
                    let cause = self.cause;
                    self.cause = quote!{ match *self { #cause } };
                }
            }
        };

        let (impl_generics, ty_generics, where_clause) = self.ast.generics.split_for_impl();
        let display = &self.display;
        let description = &self.description;
        let cause = &self.cause;
        let from_impls = &self.from_impls;
        let name = &self.ast.ident;

        quote! {
            impl #impl_generics ::std::fmt::Display for #name #ty_generics #where_clause {
                fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
                    #display
                }
            }

            impl #impl_generics ::std::error::Error for #name #ty_generics #where_clause {
                fn description(&self) -> &str {
                    #description
                }

                fn cause(&self) -> Option<&::std::error::Error> {
                    #cause
                }
            }

            #from_impls
        }
    }

    // Configures a unit variant of an enum
    fn unit_variant(&mut self, var_name: &Ident, msg: &str) {
        let name = &self.ast.ident;
        self.display.append_all(&[quote!{ #name::#var_name => write!(f, #msg), }]);
        self.description.append_all(&[quote!{ #name::#var_name => #msg, }]);
        self.cause.append_all(&[quote!{ #name::#var_name => None, }]);
    }

    // Configures a tuple variant of an enum
    fn tuple_variant(&mut self, var_name: &Ident, msg: &str, fields: &Vec<syn::Field>) {
        let (impl_generics, ty_generics, where_clause) = self.ast.generics.split_for_impl();
        let name = &self.ast.ident;
        self.display.append_all(&[quote!{ #name::#var_name(_) => write!(f, #msg), }]);
        self.description.append_all(&[quote!{ #name::#var_name(ref err) => err.description(), }]);
        self.cause.append_all(&[quote!{ #name::#var_name(ref err) => Some(err), }]);
        let field = fields.clone().into_iter().next().expect("A tuple must have at least 1 field");
        let typ = field.ty;
        self.from_impls.append_all(&[quote!{
            impl #impl_generics From<#typ> for #name #ty_generics #where_clause {
                fn from(err: #typ) -> #name #ty_generics {
                    #name::#var_name(err)
                }
            }
        }]);
    }

    // Configures a struct field
    fn struct_field(&mut self, var_name: &Ident, msg: &str, fields: &Vec<syn::Field>) {
        let (impl_generics, ty_generics, where_clause) = self.ast.generics.split_for_impl();
        let field = fields.clone().into_iter().next().expect("A struct must have at least 1 field");
        let field_name = field.ident.expect("A struct field must have an identifier");
        let typ = field.ty;
        let name = &self.ast.ident;
        self.display.append_all(&[quote!{ #name::#var_name{..} => write!(f, #msg), }]);
        self.description.append_all(&[quote!{ #name::#var_name{ref #field_name} => #field_name.description(), }]);
        self.cause.append_all(&[quote!{ #name::#var_name{ref #field_name} => Some(#field_name), }]);
        self.from_impls.append_all(&[quote!{
            impl #impl_generics From<#typ> for #name #ty_generics #where_clause {
                fn from(err: #typ) -> #name #ty_generics {
                    #name::#var_name{
                        #field_name: err,
                    }
                }
            }
        }]);
    }

    // Creates an error from a unit struct or an enum without any variants
    fn empty(&mut self) {
        let doc = self.title(&self.ast.attrs).unwrap_or_else(|| self.label_str(&self.ast.ident.to_string()));
        self.display.append_all(&[quote!{ write!(f, #doc) }]);
        self.description.append_all(&[quote!{ #doc }]);
        self.cause.append_all(&[quote!{ None }]);
    }

    // Extracts the title of an error from a doc comment
    fn title(&self, attributes: &Vec<syn::Attribute>) -> Option<String> {
        for attr in attributes {
            if attr.is_sugared_doc {
                if let syn::MetaItem::NameValue(_, syn::Lit::Str(ref doc, _)) = attr.value {
                    for line in doc.lines() {
                        let doc = line.trim_left_matches("///").trim();
                        if !doc.is_empty() {
                            return Some(doc.to_lowercase());
                        }
                    }
                }
            }
        }
        None
    }

    // Creates a human friendly string from the fieldname of an enum variant
    // or struct field
    fn label_str(&self, label: &str) -> String {
        label
            .to_snake()
            .replace("_", " ")
            .trim()
            .to_lowercase()
    }
}