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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
//! # error-rules
//!
//! [![Latest Version](https://img.shields.io/crates/v/error-rules.svg)](https://crates.io/crates/error-rules)
//! [![docs](https://docs.rs/error-rules/badge.svg)](https://docs.rs/error-rules)
//!
//! ## Intro
//!
//! error-rules is a derive macro to implement error handler.
//! Error handler based on the enum.
//! Macro automatically implements conversion of any error type into the inner enum field.
//!
//! ## Error conversion
//!
//! `#[error_from]` attribute implements an automatically conversion from any error type.
//! Converted type should implements `std::error::Error` interface.
//!
//! ```rust
//! use error_rules::*;
//!
//! #[derive(Debug, Error)]
//! enum AppError {
//!     #[error_from("App IO: {}", 0)]
//!     Io(std::io::Error),
//! }
//!
//! type Result<T> = std::result::Result<T, AppError>;
//!
//! fn example() -> Result<()> {
//!     let _file = std::fs::File::open("not-found.txt")?;
//!     unreachable!()
//! }
//!
//! let error = example().unwrap_err();
//! assert_eq!(error.to_string().as_str(),
//!     "App IO: No such file or directory (os error 2)");
//! ```
//!
//! ## Custom error kind
//!
//! `#[error_kind]` attribute describes custom error kind.
//! Could be defined without fields or with fields tuple.
//!
//! ```rust
//! use error_rules::*;
//!
//! #[derive(Debug, Error)]
//! enum AppError {
//!     #[error_kind("App: error without arguments")]
//!     E1,
//!     #[error_kind("App: code:{} message:{}", 0, 1)]
//!     E2(usize, String),
//! }
//!
//! type Result<T> = std::result::Result<T, AppError>;
//!
//! fn example_1() -> Result<()> {
//!     Err(AppError::E1)
//! }
//!
//! fn example_2() -> Result<()> {
//!     Err(AppError::E2(404, "Not Found".to_owned()))
//! }
//!
//! let error = example_1().unwrap_err();
//! assert_eq!(error.to_string().as_str(),
//!     "App: error without arguments");
//!
//! let error = example_2().unwrap_err();
//! assert_eq!(error.to_string().as_str(),
//!     "App: code:404 message:Not Found");
//! ```
//!
//! ## Display attributes
//!
//! `#[error_from]` and `#[error_kind]` contain list of attributes to display error.
//! First attribute should be literal string. Other attributes is a number of the
//! unnamed field in the tuple. Started from 0.
//!
//! `#[error_from]` could defined without attributes it's equal to `#[error_from("{}", 0)]`
//!
//! ## Error prefix
//!
//! `#[error_prefix]` attribute should be defined before enum declaration and
//! appends prefix into error text.
//!
//! ```rust
//! use error_rules::*;
//!
//! #[derive(Debug, Error)]
//! #[error_prefx = "App"]
//! enum AppError {
//!     #[error_from]
//!     Io(std::io::Error),
//! }
//!
//! type Result<T> = std::result::Result<T, AppError>;
//!
//! fn example() -> Result<()> {
//!     let _file = std::fs::File::open("not-found.txt")?;
//!     unreachable!()
//! }
//!
//! let error = example().unwrap_err();
//! assert_eq!(error.to_string().as_str(),
//!     "App: No such file or directory (os error 2)");
//! ```
//!
//! ## Error chain
//!
//! By implementing error for nested modules the primary error handler returns full chain of the error.
//!
//! ```rust
//! use error_rules::*;
//!
//! #[derive(Debug, Error)]
//! #[error_prefix = "Mod"]
//! enum ModError {
//!     #[error_from]
//!     Io(std::io::Error),
//! }
//!
//! fn mod_example() -> Result<(), ModError> {
//!     let _file = std::fs::File::open("not-found.txt")?;
//!     unreachable!()
//! }
//!
//! #[derive(Debug, Error)]
//! #[error_prefix = "App"]
//! enum AppError {
//!     #[error_from]
//!     Mod(ModError),
//! }
//!
//! fn app_example() -> Result<(), AppError> {
//!     mod_example()?;
//!     unreachable!()
//! }
//!
//! let error = app_example().unwrap_err();
//! assert_eq!(error.to_string().as_str(),
//!     "App: Mod: No such file or directory (os error 2)");
//! ```

extern crate proc_macro;

use proc_macro2::{TokenStream, Span, Ident};
use quote::quote;
use syn::{
    self,
    parse_macro_input,
};


fn impl_display_item(meta_list: &syn::MetaList) -> TokenStream {
    let mut attr_list = TokenStream::new();

    let fmt = match &meta_list.nested[0] {
        syn::NestedMeta::Literal(syn::Lit::Str(v)) => v.value(),
        _ => panic!("first attribute shoud be literal"),
    };
    attr_list.extend(quote! { #fmt });

    for attr in meta_list.nested.iter().skip(1) {
        let attr = match attr {
            syn::NestedMeta::Literal(syn::Lit::Int(v)) => v.value(),
            _ => panic!("attributes should be number"),
        };

        let attr_id = Ident::new(&format!("i{}", attr), Span::call_site());
        attr_list.extend(quote! { , #attr_id });
    }

    attr_list
}


struct ErrorRules {
    enum_id: Ident,
    prefix: String,
    from_list: TokenStream,
    source_list: TokenStream,
    display_list: TokenStream,
}


impl ErrorRules {
    fn new(ident: &Ident) -> ErrorRules {
        ErrorRules {
            enum_id: ident.clone(),
            prefix: String::default(),
            from_list: TokenStream::default(),
            source_list: TokenStream::default(),
            display_list: TokenStream::default(),
        }
    }

    fn impl_error_from_fields(&mut self,
        item_id: &TokenStream,
        variant: &syn::Variant)
    {
        let enum_id = &self.enum_id;

        match &variant.fields {
            syn::Fields::Unnamed(fields) => {
                if fields.unnamed.len() != 1 {
                    panic!("variant should contain one field")
                }
                let field = &fields.unnamed[0];
                let ty = &field.ty;
                self.from_list.extend(quote! {
                    impl From<#ty> for #enum_id {
                        #[inline]
                        fn from(e: #ty) -> #enum_id { #item_id ( e ) }
                    }
                });
                self.source_list.extend(quote! {
                    #item_id (i0) => Some(i0),
                });
            }
            _ => panic!("field format mismatch"),
        };
    }

    fn impl_error_from_word(&mut self,
        item_id: &TokenStream,
        variant: &syn::Variant)
    {
        self.impl_error_from_fields(&item_id, variant);

        self.display_list.extend(quote! {
            #item_id ( i0 ) => write!(f, "{}", i0),
        });
    }

    fn impl_error_from_list(&mut self,
        item_id: &TokenStream,
        variant: &syn::Variant,
        meta_list: &syn::MetaList)
    {
        if meta_list.nested.is_empty() {
            self.impl_error_from_word(item_id, variant);
            return
        }

        self.impl_error_from_fields(item_id, variant);

        let w = impl_display_item(meta_list);
        self.display_list.extend(quote! {
            #item_id ( i0 ) => write!(f, #w),
        });
    }

    fn impl_error_from(&mut self,
        item_id: &TokenStream,
        variant: &syn::Variant,
        meta: &syn::Meta)
    {
        match meta {
            syn::Meta::Word(_) => self.impl_error_from_word(item_id, variant),
            syn::Meta::List(v) => self.impl_error_from_list(item_id, variant, v),
            _ => panic!("meta format mismatch"),
        }
    }

    fn impl_error_kind_list(&mut self,
        item_id: &TokenStream,
        variant: &syn::Variant,
        meta_list: &syn::MetaList)
    {
        if meta_list.nested.is_empty() {
            panic!("meta format mismatch")
        }

        match &variant.fields {
            syn::Fields::Unit => {
                let w = impl_display_item(meta_list);
                self.display_list.extend(quote! {
                    #item_id => write!(f, #w),
                });
            }
            syn::Fields::Unnamed(fields) => {
                let mut ident_list = TokenStream::new();
                for i in 0 .. fields.unnamed.len() {
                    let field_id = Ident::new(&format!("i{}", i), Span::call_site());
                    ident_list.extend(quote! { #field_id, });
                }

                let w = impl_display_item(meta_list);
                self.display_list.extend(quote! {
                    #item_id ( #ident_list ) => write!(f, #w),
                });
            }
            _ => panic!("field format mismatch"),
        };
    }

    fn impl_error_kind(&mut self,
        item_id: &TokenStream,
        variant: &syn::Variant,
        meta: &syn::Meta)
    {
        match meta {
            syn::Meta::List(v) => self.impl_error_kind_list(item_id, variant, v),
            _ => panic!("meta format mismatch"),
        }
    }

    fn impl_variant(&mut self, variant: &syn::Variant) {
        let enum_id = &self.enum_id;
        let item_id = &variant.ident;
        let item_id = quote! { #enum_id::#item_id };

        for attr in variant.attrs.iter().filter(|v| v.path.segments.len() == 1) {
            match attr.path.segments[0].ident.to_string().as_str() {
                "error_from" => {
                    let meta = attr.parse_meta().unwrap();
                    self.impl_error_from(&item_id, variant, &meta);
                    break
                }
                "error_kind" => {
                    let meta = attr.parse_meta().unwrap();
                    self.impl_error_kind(&item_id, variant, &meta);
                    break
                }
                _ => {},
            }
        }
    }

    fn build(&mut self, data: &syn::DataEnum) -> TokenStream {
        for variant in &data.variants {
            self.impl_variant(variant);
        }

        let enum_id = &self.enum_id;
        let display_list = &self.display_list;
        let source_list = &self.source_list;
        let from_list = &self.from_list;

        let mut display_prefix = TokenStream::new();
        if ! self.prefix.is_empty() {
            let prefix = &self.prefix;
            display_prefix.extend(quote! {
                write!(f, "{}: ", #prefix)?;
            });
        }

        quote! {
            impl std::fmt::Display for #enum_id {
                fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
                    #display_prefix
                    match self {
                        #display_list
                    }
                }
            }

            impl std::error::Error for #enum_id {
                fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
                    match self {
                        #source_list
                        _ => None,
                    }
                }
            }

            #from_list
        }
    }

    fn set_attrs(&mut self, attrs: &Vec<syn::Attribute>) {
        for attr in attrs.iter().filter(|v| v.path.segments.len() == 1) {
            match attr.path.segments[0].ident.to_string().as_str() {
                "error_prefix" => {
                    if let syn::Meta::NameValue(v) = &attr.parse_meta().unwrap() {
                        if let syn::Lit::Str(v) = &v.lit {
                            self.prefix = v.value();
                            break
                        }
                    }
                    panic!("meta format mismatch")
                }
                _ => {},
            }
        }
    }
}


#[proc_macro_derive(Error, attributes(error_from, error_kind, error_prefix))]
pub fn error_rules_derive(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
    let input = parse_macro_input!(input as syn::DeriveInput);

    if let syn::Data::Enum(ref s) = input.data {
        let mut error_rules = ErrorRules::new(&input.ident);
        error_rules.set_attrs(&input.attrs);
        error_rules.build(s).into()
    } else {
        panic!("enum required")
    }
}