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
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
pub(crate) use self::context_module::ContextModule;
pub(crate) use self::context_selector::ContextSelector;
pub(crate) use self::display::{Display, DisplayMatchArm};
pub(crate) use self::error::{Error, ErrorSourceMatchArm};
pub(crate) use self::error_compat::{ErrorCompat, ErrorCompatBacktraceMatchArm};
pub mod context_module {
use crate::ModuleName;
use heck::SnakeCase;
use proc_macro2::TokenStream;
use quote::{quote, ToTokens};
use syn::Ident;
#[derive(Copy, Clone)]
pub(crate) struct ContextModule<'a, T> {
pub container_name: &'a Ident,
pub module_name: &'a ModuleName,
pub visibility: Option<&'a dyn ToTokens>,
pub body: &'a T,
}
impl<'a, T> ToTokens for ContextModule<'a, T>
where
T: ToTokens,
{
fn to_tokens(&self, stream: &mut TokenStream) {
let module_name = match self.module_name {
ModuleName::Default => {
let name_str = self.container_name.to_string().to_snake_case();
syn::Ident::new(&name_str, self.container_name.span())
}
ModuleName::Custom(name) => name.clone(),
};
let visibility = self.visibility;
let body = self.body;
let module_tokens = quote! {
#visibility mod #module_name {
use super::*;
#body
}
};
stream.extend(module_tokens);
}
}
}
pub mod context_selector {
use crate::{ContextSelectorKind, Field, SuffixKind};
use proc_macro2::TokenStream;
use quote::{format_ident, quote, IdentFragment, ToTokens};
const DEFAULT_SUFFIX: &str = "Snafu";
#[derive(Copy, Clone)]
pub(crate) struct ContextSelector<'a> {
pub backtrace_field: Option<&'a Field>,
pub implicit_fields: &'a [Field],
pub crate_root: &'a dyn ToTokens,
pub error_constructor_name: &'a dyn ToTokens,
pub original_generics_without_defaults: &'a [TokenStream],
pub parameterized_error_name: &'a dyn ToTokens,
pub selector_doc_string: &'a str,
pub selector_kind: &'a ContextSelectorKind,
pub selector_name: &'a proc_macro2::Ident,
pub user_fields: &'a [Field],
pub visibility: Option<&'a dyn ToTokens>,
pub where_clauses: &'a [TokenStream],
pub default_suffix: &'a SuffixKind,
}
impl ToTokens for ContextSelector<'_> {
fn to_tokens(&self, stream: &mut TokenStream) {
use self::ContextSelectorKind::*;
let context_selector = match self.selector_kind {
Context { source_field, .. } => {
let context_selector_type = self.generate_type();
let context_selector_impl = match source_field {
Some(_) => None,
None => Some(self.generate_leaf()),
};
let context_selector_into_error_impl =
self.generate_into_error(source_field.as_ref());
quote! {
#context_selector_type
#context_selector_impl
#context_selector_into_error_impl
}
}
Whatever {
source_field,
message_field,
} => self.generate_whatever(source_field.as_ref(), message_field),
NoContext { source_field } => self.generate_from_source(source_field),
};
stream.extend(context_selector)
}
}
impl ContextSelector<'_> {
fn user_field_generics(&self) -> Vec<proc_macro2::Ident> {
(0..self.user_fields.len())
.map(|i| format_ident!("__T{}", i))
.collect()
}
fn user_field_names(&self) -> Vec<&syn::Ident> {
self.user_fields
.iter()
.map(|Field { name, .. }| name)
.collect()
}
fn parameterized_selector_name(&self) -> TokenStream {
let selector_name = self.selector_name.to_string();
let selector_name = selector_name.trim_end_matches("Error");
let suffix: &dyn IdentFragment = match self.selector_kind {
ContextSelectorKind::Context { suffix, .. } => {
match suffix.resolve_with_default(self.default_suffix) {
SuffixKind::Some(s) => s,
SuffixKind::None => &"",
SuffixKind::Default => &DEFAULT_SUFFIX,
}
}
_ => &DEFAULT_SUFFIX,
};
let selector_name = format_ident!(
"{}{}",
selector_name,
suffix,
span = self.selector_name.span()
);
let user_generics = self.user_field_generics();
quote! { #selector_name<#(#user_generics,)*> }
}
fn extended_where_clauses(&self) -> Vec<TokenStream> {
let user_fields = self.user_fields;
let user_field_generics = self.user_field_generics();
let where_clauses = self.where_clauses;
let target_types = user_fields
.iter()
.map(|Field { ty, .. }| quote! { ::core::convert::Into<#ty>});
user_field_generics
.into_iter()
.zip(target_types)
.map(|(gen, bound)| quote! { #gen: #bound })
.chain(where_clauses.iter().cloned())
.collect()
}
fn transfer_user_fields(&self) -> Vec<TokenStream> {
self.user_field_names()
.into_iter()
.map(|name| {
quote! { #name: ::core::convert::Into::into(self.#name) }
})
.collect()
}
fn construct_implicit_fields(&self) -> TokenStream {
self.implicit_fields
.iter()
.chain(self.backtrace_field)
.map(|field| {
let crate_root = self.crate_root;
let name = &field.name;
quote! { #name: #crate_root::GenerateImplicitData::generate(), }
})
.collect()
}
fn generate_type(self) -> TokenStream {
let visibility = self.visibility;
let parameterized_selector_name = self.parameterized_selector_name();
let user_field_generics = self.user_field_generics();
let user_field_names = self.user_field_names();
let selector_doc_string = self.selector_doc_string;
let body = if user_field_names.is_empty() {
quote! { ; }
} else {
quote! {
{
#(
#[allow(missing_docs)]
#visibility #user_field_names: #user_field_generics
),*
}
}
};
quote! {
#[derive(Debug, Copy, Clone)]
#[doc = #selector_doc_string]
#visibility struct #parameterized_selector_name #body
}
}
fn generate_leaf(self) -> TokenStream {
let error_constructor_name = self.error_constructor_name;
let original_generics_without_defaults = self.original_generics_without_defaults;
let parameterized_error_name = self.parameterized_error_name;
let parameterized_selector_name = self.parameterized_selector_name();
let user_field_generics = self.user_field_generics();
let visibility = self.visibility;
let extended_where_clauses = self.extended_where_clauses();
let transfer_user_fields = self.transfer_user_fields();
let construct_implicit_fields = self.construct_implicit_fields();
let track_caller = track_caller();
quote! {
impl<#(#user_field_generics,)*> #parameterized_selector_name {
#[doc = "Consume the selector and return the associated error"]
#[must_use]
#track_caller
#visibility fn build<#(#original_generics_without_defaults,)*>(self) -> #parameterized_error_name
where
#(#extended_where_clauses),*
{
#error_constructor_name {
#construct_implicit_fields
#(#transfer_user_fields,)*
}
}
#[doc = "Consume the selector and return a `Result` with the associated error"]
#track_caller
#visibility fn fail<#(#original_generics_without_defaults,)* __T>(self) -> ::core::result::Result<__T, #parameterized_error_name>
where
#(#extended_where_clauses),*
{
::core::result::Result::Err(self.build())
}
}
}
}
fn generate_into_error(self, source_field: Option<&crate::SourceField>) -> TokenStream {
let crate_root = self.crate_root;
let error_constructor_name = self.error_constructor_name;
let original_generics_without_defaults = self.original_generics_without_defaults;
let parameterized_error_name = self.parameterized_error_name;
let parameterized_selector_name = self.parameterized_selector_name();
let user_field_generics = self.user_field_generics();
let extended_where_clauses = self.extended_where_clauses();
let transfer_user_fields = self.transfer_user_fields();
let construct_implicit_fields = self.construct_implicit_fields();
let (source_ty, transfer_source_field) = match source_field {
Some(source_field) => {
let (ty, transfer) = build_source_info(source_field);
(quote! { #ty }, transfer)
}
None => (quote! { #crate_root::NoneError }, quote! {}),
};
let track_caller = track_caller();
quote! {
impl<#(#original_generics_without_defaults,)* #(#user_field_generics,)*> #crate_root::IntoError<#parameterized_error_name> for #parameterized_selector_name
where
#parameterized_error_name: #crate_root::Error + #crate_root::ErrorCompat,
#(#extended_where_clauses),*
{
type Source = #source_ty;
#track_caller
fn into_error(self, error: Self::Source) -> #parameterized_error_name {
#error_constructor_name {
#transfer_source_field
#construct_implicit_fields
#(#transfer_user_fields),*
}
}
}
}
}
fn generate_whatever(
self,
source_field: Option<&crate::SourceField>,
message_field: &crate::Field,
) -> TokenStream {
let crate_root = self.crate_root;
let parameterized_error_name = self.parameterized_error_name;
let error_constructor_name = self.error_constructor_name;
let construct_implicit_fields = self.construct_implicit_fields();
let (source_ty, transfer_source_field, empty_source_field) = match source_field {
Some(f) => {
let source_field_type = f.transformation.ty();
let source_field_name = &f.name;
let source_transformation = f.transformation.transformation();
(
quote! { #source_field_type },
Some(quote! { #source_field_name: (#source_transformation)(error), }),
Some(quote! { #source_field_name: core::option::Option::None, }),
)
}
None => (quote! { #crate_root::NoneError }, None, None),
};
let message_field_name = &message_field.name;
let track_caller = track_caller();
quote! {
impl #crate_root::FromString for #parameterized_error_name {
type Source = #source_ty;
#track_caller
fn without_source(message: String) -> Self {
#error_constructor_name {
#empty_source_field
#message_field_name: message,
#construct_implicit_fields
}
}
#track_caller
fn with_source(error: Self::Source, message: String) -> Self {
#error_constructor_name {
#transfer_source_field
#message_field_name: message,
#construct_implicit_fields
}
}
}
}
}
fn generate_from_source(self, source_field: &crate::SourceField) -> TokenStream {
let parameterized_error_name = self.parameterized_error_name;
let error_constructor_name = self.error_constructor_name;
let construct_implicit_fields = self.construct_implicit_fields();
let original_generics_without_defaults = self.original_generics_without_defaults;
let user_field_generics = self.user_field_generics();
let where_clauses = self.where_clauses;
let (source_field_type, transfer_source_field) = build_source_info(source_field);
let track_caller = track_caller();
quote! {
impl<#(#original_generics_without_defaults,)* #(#user_field_generics,)*> ::core::convert::From<#source_field_type> for #parameterized_error_name
where
#(#where_clauses),*
{
#track_caller
fn from(error: #source_field_type) -> Self {
#error_constructor_name {
#transfer_source_field
#construct_implicit_fields
}
}
}
}
}
}
fn build_source_info(source_field: &crate::SourceField) -> (&syn::Type, TokenStream) {
let source_field_name = source_field.name();
let source_field_type = source_field.transformation.ty();
let source_transformation = source_field.transformation.transformation();
(
source_field_type,
quote! { #source_field_name: (#source_transformation)(error), },
)
}
fn track_caller() -> proc_macro2::TokenStream {
if cfg!(feature = "rust_1_46") {
quote::quote! { #[track_caller] }
} else {
quote::quote! {}
}
}
}
pub mod display {
use crate::{Field, SourceField};
use proc_macro2::TokenStream;
use quote::{quote, ToTokens};
use std::collections::BTreeSet;
struct StaticIdent(&'static str);
impl quote::ToTokens for StaticIdent {
fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {
proc_macro2::Ident::new(self.0, proc_macro2::Span::call_site()).to_tokens(tokens)
}
}
const FORMATTER_ARG: StaticIdent = StaticIdent("__snafu_display_formatter");
pub(crate) struct Display<'a> {
pub(crate) arms: &'a [TokenStream],
pub(crate) original_generics: &'a [TokenStream],
pub(crate) parameterized_error_name: &'a dyn ToTokens,
pub(crate) where_clauses: &'a [TokenStream],
}
impl ToTokens for Display<'_> {
fn to_tokens(&self, stream: &mut TokenStream) {
let Self {
arms,
original_generics,
parameterized_error_name,
where_clauses,
} = *self;
let display_impl = quote! {
#[allow(single_use_lifetimes)]
impl<#(#original_generics),*> ::core::fmt::Display for #parameterized_error_name
where
#(#where_clauses),*
{
fn fmt(&self, #FORMATTER_ARG: &mut ::core::fmt::Formatter) -> ::core::fmt::Result {
#[allow(unused_variables)]
match *self {
#(#arms),*
}
}
}
};
stream.extend(display_impl);
}
}
pub(crate) struct DisplayMatchArm<'a> {
pub(crate) backtrace_field: Option<&'a crate::Field>,
pub(crate) implicit_fields: &'a [crate::Field],
pub(crate) default_name: &'a dyn ToTokens,
pub(crate) display_format: Option<&'a crate::Display>,
pub(crate) doc_comment: Option<&'a crate::DocComment>,
pub(crate) pattern_ident: &'a dyn ToTokens,
pub(crate) selector_kind: &'a crate::ContextSelectorKind,
}
impl ToTokens for DisplayMatchArm<'_> {
fn to_tokens(&self, stream: &mut TokenStream) {
let Self {
backtrace_field,
implicit_fields,
default_name,
display_format,
doc_comment,
pattern_ident,
selector_kind,
} = *self;
let user_fields = selector_kind.user_fields();
let source_field = selector_kind.source_field();
let message_field = selector_kind.message_field();
let mut shorthand_names = &BTreeSet::new();
let mut assigned_names = &BTreeSet::new();
let format = match (display_format, doc_comment, source_field) {
(Some(v), _, _) => {
let exprs = &v.exprs;
shorthand_names = &v.shorthand_names;
assigned_names = &v.assigned_names;
quote! { #(#exprs),* }
}
(_, Some(d), _) => {
let content = &d.content;
shorthand_names = &d.shorthand_names;
quote! { #content }
}
(_, _, Some(f)) => {
let field_name = &f.name;
quote! { concat!(stringify!(#default_name), ": {}"), #field_name }
}
_ => quote! { stringify!(#default_name)},
};
let field_names = user_fields
.iter()
.chain(backtrace_field)
.chain(implicit_fields)
.chain(message_field)
.map(Field::name)
.chain(source_field.map(SourceField::name))
.collect::<BTreeSet<_>>();
let field_names_pat = quote! { #(ref #field_names),* };
let shorthand_names = shorthand_names.iter().collect::<BTreeSet<_>>();
let assigned_names = assigned_names.iter().collect::<BTreeSet<_>>();
let shorthand_fields = &shorthand_names & &field_names;
let shorthand_fields = &shorthand_fields - &assigned_names;
let shorthand_assignments = quote! { #( #shorthand_fields = #shorthand_fields ),* };
let match_arm = quote! {
#pattern_ident { #field_names_pat } => {
write!(#FORMATTER_ARG, #format, #shorthand_assignments)
}
};
stream.extend(match_arm);
}
}
}
pub mod error {
use crate::{FieldContainer, SourceField};
use proc_macro2::TokenStream;
use quote::{quote, ToTokens};
pub(crate) struct Error<'a> {
pub(crate) crate_root: &'a dyn ToTokens,
pub(crate) parameterized_error_name: &'a dyn ToTokens,
pub(crate) description_arms: &'a [TokenStream],
pub(crate) source_arms: &'a [TokenStream],
pub(crate) original_generics: &'a [TokenStream],
pub(crate) where_clauses: &'a [TokenStream],
}
impl ToTokens for Error<'_> {
fn to_tokens(&self, stream: &mut TokenStream) {
let Self {
crate_root,
parameterized_error_name,
description_arms,
source_arms,
original_generics,
where_clauses,
} = *self;
let description_fn = quote! {
fn description(&self) -> &str {
match *self {
#(#description_arms)*
}
}
};
let source_body = quote! {
use #crate_root::AsErrorSource;
match *self {
#(#source_arms)*
}
};
let cause_fn = quote! {
fn cause(&self) -> ::core::option::Option<&dyn #crate_root::Error> {
#source_body
}
};
let source_fn = quote! {
fn source(&self) -> ::core::option::Option<&(dyn #crate_root::Error + 'static)> {
#source_body
}
};
let std_backtrace_fn = if cfg!(feature = "unstable-backtraces-impl-std") {
Some(quote! {
fn backtrace(&self) -> ::core::option::Option<&::std::backtrace::Backtrace> {
#crate_root::ErrorCompat::backtrace(self)
}
})
} else {
None
};
let error = quote! {
#[allow(single_use_lifetimes)]
impl<#(#original_generics),*> #crate_root::Error for #parameterized_error_name
where
Self: ::core::fmt::Debug + ::core::fmt::Display,
#(#where_clauses),*
{
#description_fn
#cause_fn
#source_fn
#std_backtrace_fn
}
};
stream.extend(error);
}
}
pub(crate) struct ErrorSourceMatchArm<'a> {
pub(crate) field_container: &'a FieldContainer,
pub(crate) pattern_ident: &'a dyn ToTokens,
}
impl ToTokens for ErrorSourceMatchArm<'_> {
fn to_tokens(&self, stream: &mut TokenStream) {
let Self {
field_container: FieldContainer { selector_kind, .. },
pattern_ident,
} = *self;
let source_field = selector_kind.source_field();
let arm = match source_field {
Some(source_field) => {
let SourceField {
name: field_name, ..
} = source_field;
let convert_to_error_source = if selector_kind.is_whatever() {
quote! {
#field_name.as_ref().map(|e| e.as_error_source())
}
} else {
quote! {
::core::option::Option::Some(#field_name.as_error_source())
}
};
quote! {
#pattern_ident { ref #field_name, .. } => {
#convert_to_error_source
}
}
}
None => {
quote! {
#pattern_ident { .. } => { ::core::option::Option::None }
}
}
};
stream.extend(arm);
}
}
}
pub mod error_compat {
use crate::{Field, FieldContainer, SourceField};
use proc_macro2::TokenStream;
use quote::{quote, ToTokens};
pub(crate) struct ErrorCompat<'a> {
pub(crate) crate_root: &'a dyn ToTokens,
pub(crate) parameterized_error_name: &'a dyn ToTokens,
pub(crate) backtrace_arms: &'a [TokenStream],
pub(crate) original_generics: &'a [TokenStream],
pub(crate) where_clauses: &'a [TokenStream],
}
impl ToTokens for ErrorCompat<'_> {
fn to_tokens(&self, stream: &mut TokenStream) {
let Self {
crate_root,
parameterized_error_name,
backtrace_arms,
original_generics,
where_clauses,
} = *self;
let backtrace_fn = quote! {
fn backtrace(&self) -> ::core::option::Option<&#crate_root::Backtrace> {
match *self {
#(#backtrace_arms),*
}
}
};
let error_compat_impl = quote! {
#[allow(single_use_lifetimes)]
impl<#(#original_generics),*> #crate_root::ErrorCompat for #parameterized_error_name
where
#(#where_clauses),*
{
#backtrace_fn
}
};
stream.extend(error_compat_impl);
}
}
pub(crate) struct ErrorCompatBacktraceMatchArm<'a> {
pub(crate) crate_root: &'a dyn ToTokens,
pub(crate) field_container: &'a FieldContainer,
pub(crate) pattern_ident: &'a dyn ToTokens,
}
impl ToTokens for ErrorCompatBacktraceMatchArm<'_> {
fn to_tokens(&self, stream: &mut TokenStream) {
let Self {
crate_root,
field_container:
FieldContainer {
backtrace_field,
selector_kind,
..
},
pattern_ident,
} = *self;
let match_arm = match (selector_kind.source_field(), backtrace_field) {
(Some(source_field), _) if source_field.backtrace_delegate => {
let SourceField {
name: field_name, ..
} = source_field;
quote! {
#pattern_ident { ref #field_name, .. } => { #crate_root::ErrorCompat::backtrace(#field_name) }
}
}
(_, Some(backtrace_field)) => {
let Field {
name: field_name, ..
} = backtrace_field;
quote! {
#pattern_ident { ref #field_name, .. } => { #crate_root::AsBacktrace::as_backtrace(#field_name) }
}
}
_ => {
quote! {
#pattern_ident { .. } => { ::core::option::Option::None }
}
}
};
stream.extend(match_arm);
}
}
}