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
extern crate proc_macro;

use proc_macro2::{Span, TokenStream};
use quote::{quote, ToTokens};
use syn::parse::Parse;
use syn::spanned::Spanned;
use syn::Result;

use crate::{derive_filler, FillDerive};

/// One-line wrapper that declares a filler macro.
///
/// # Example
/// ```
/// # extern crate proc_macro;
/// #
/// portrait_framework::proc_macro_derive_filler!(foo, Generator);
/// struct Generator(portrait_framework::NoArgs);
/// impl portrait_framework::GenerateDerive for Generator {
///     fn generate_const(
///         &mut self,
///         context: portrait_framework::DeriveContext,
///         item: &syn::TraitItemConst,
///     ) -> syn::Result<syn::ImplItemConst> {
///         todo!()
///     }
///     fn generate_fn(
///         &mut self,
///         context: portrait_framework::DeriveContext,
///         item: &syn::TraitItemFn,
///     ) -> syn::Result<syn::ImplItemFn> {
///         todo!()
///     }
///     fn generate_type(
///         &mut self,
///         context: portrait_framework::DeriveContext,
///         item: &syn::TraitItemType,
///     ) -> syn::Result<syn::ImplItemType> {
///         todo!()
///     }
/// }
/// ```
///
/// This declares a filler macro called `foo`,
/// where each missing item is generated by calling the corresponding funciton.
#[macro_export]
macro_rules! proc_macro_derive_filler {
    ($ident:ident, $generator:path) => {
        pub fn $ident(input: ::proc_macro::TokenStream) -> ::proc_macro::TokenStream {
            portrait_framework::completer_derive_filler(input, $generator)
        }
    };
}

/// Shorthand from [`fn@derive_filler`] to [`complete_derive`] ([`proc_macro`] version).
pub fn completer_derive_filler<ArgsT: Parse, GeneratorT: GenerateDerive>(
    input: proc_macro::TokenStream,
    ctor: fn(ArgsT) -> GeneratorT,
) -> proc_macro::TokenStream {
    completer_derive_filler2(input.into(), ctor)
        .unwrap_or_else(syn::Error::into_compile_error)
        .into()
}

/// Shorthand from [`fn@derive_filler`] to [`complete_derive`] ([`proc_macro2`] version).
pub fn completer_derive_filler2<ArgsT: Parse, GeneratorT: GenerateDerive>(
    input: TokenStream,
    ctor: fn(ArgsT) -> GeneratorT,
) -> Result<TokenStream> {
    struct Filler<GenerateT, ArgsT>(fn(ArgsT) -> GenerateT);

    impl<GenerateT: GenerateDerive, ArgsT: Parse> FillDerive for Filler<GenerateT, ArgsT> {
        type Args = ArgsT;

        fn fill(
            self,
            trait_path: &syn::Path,
            portrait: &[syn::TraitItem],
            args: Self::Args,
            input: &syn::DeriveInput,
        ) -> Result<TokenStream> {
            let tokens = complete_derive(trait_path, portrait, input, self.0(args))?;
            Ok(quote!(#tokens))
        }
    }

    derive_filler(input, Filler(ctor))
}

/// Invokes the generator on each unimplemented item
/// and returns a clone of `impl_block` with the generated items.
pub fn complete_derive(
    trait_path: &syn::Path,
    trait_items: &[syn::TraitItem],
    input: &syn::DeriveInput,
    mut generator: impl GenerateDerive,
) -> syn::Result<syn::ItemImpl> {
    let ctx = DeriveContext { trait_path, all_trait_items: trait_items, input };

    let mut generics_params: Vec<_> = input.generics.params.iter().cloned().collect();
    let mut generics_where: Vec<_> = input
        .generics
        .where_clause
        .iter()
        .flat_map(|clause| clause.predicates.iter().cloned())
        .collect();
    // TODO generic trait support (this behavior may be filler-dependent)
    generator.extend_generics(
        DeriveContext { ..ctx },
        &mut generics_params,
        &mut generics_where,
    )?;

    let self_ty = syn::Type::Path({
        let input_ident = &input.ident;
        let self_generics = (!input.generics.params.is_empty()).then(|| {
            let type_param_names = input.generics.params.iter().map(|param| match param {
                syn::GenericParam::Lifetime(lt) => lt.lifetime.to_token_stream(),
                syn::GenericParam::Type(ty) => ty.ident.to_token_stream(),
                syn::GenericParam::Const(const_) => const_.ident.to_token_stream(),
            });

            quote!(<#(#type_param_names),*>)
        });

        syn::parse_quote!(#input_ident #self_generics)
    });

    let mut items = Vec::new();
    for trait_item in trait_items {
        let item = match trait_item {
            syn::TraitItem::Const(const_item) => {
                syn::ImplItem::Const(generator.generate_const(DeriveContext { ..ctx }, const_item)?)
            }
            syn::TraitItem::Fn(fn_item) => {
                syn::ImplItem::Fn(generator.generate_fn(DeriveContext { ..ctx }, fn_item)?)
            }
            syn::TraitItem::Type(type_item) => {
                syn::ImplItem::Type(generator.generate_type(DeriveContext { ..ctx }, type_item)?)
            }
            _ => continue, // assume other tokens do not generate an item
        };
        items.push(item);
    }

    let mut attrs: Vec<_> =
        input.attrs.iter().filter(|attr| attr.path().is_ident("cfg")).cloned().collect();
    generator.extend_attrs(DeriveContext { ..ctx }, &mut attrs)?;

    Ok(syn::ItemImpl {
        attrs,
        defaultness: None,
        unsafety: None, // TODO support explicit unsafe derive
        impl_token: syn::Token![impl](Span::call_site()),
        generics: syn::Generics {
            lt_token:     (!generics_params.is_empty())
                .then(|| syn::Token![<](input.generics.span())),
            gt_token:     (!generics_params.is_empty())
                .then(|| syn::Token![>](input.generics.span())),
            params:       generics_params.into_iter().collect(),
            where_clause: (!generics_where.is_empty()).then(|| syn::WhereClause {
                where_token: syn::Token![where](Span::call_site()),
                predicates:  generics_where.into_iter().collect(),
            }),
        },
        trait_: Some((None, trait_path.clone(), syn::Token![for](Span::call_site()))),
        self_ty: Box::new(self_ty),
        brace_token: syn::token::Brace::default(),
        items,
    })
}

/// Available context parameters passed to generators.
#[non_exhaustive]
pub struct DeriveContext<'t> {
    /// The path to reference the implemented trait.
    pub trait_path:      &'t syn::Path,
    /// All known trait items in the portrait.
    pub all_trait_items: &'t [syn::TraitItem],
    /// The input struct/enum/union.
    pub input:           &'t syn::DeriveInput,
}

/// Generates missing items.
pub trait GenerateDerive {
    /// Implements an associated constant.
    fn generate_const(
        &mut self,
        ctx: DeriveContext,
        item: &syn::TraitItemConst,
    ) -> Result<syn::ImplItemConst>;

    /// Implements an associated function.
    fn generate_fn(
        &mut self,
        ctx: DeriveContext,
        item: &syn::TraitItemFn,
    ) -> Result<syn::ImplItemFn>;

    /// Implements an associated type.
    fn generate_type(
        &mut self,
        ctx: DeriveContext,
        item: &syn::TraitItemType,
    ) -> Result<syn::ImplItemType>;

    /// Provides additional type bounds for the `impl` block.
    fn extend_generics(
        &mut self,
        _ctx: DeriveContext,
        _generics_params: &mut Vec<syn::GenericParam>,
        _generics_where: &mut Vec<syn::WherePredicate>,
    ) -> Result<()> {
        Ok(())
    }

    /// Provides additional attributes for the `impl` block.
    fn extend_attrs(
        &mut self,
        _ctx: DeriveContext,
        _attrs: &mut Vec<syn::Attribute>,
    ) -> Result<()> {
        Ok(())
    }
}