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
use itertools::izip;
/// TODO add optional fields after the never type is stabilized with `!` fallback.
use proc_macro::TokenStream;
use proc_macro2::Span;
use quote::quote;
use std::{fmt::Write, iter};
use syn::{
    parse::{Error, Parse, ParseStream},
    parse_macro_input,
    spanned::Spanned,
    visit::Visit,
    Fields, GenericParam, Ident, ItemStruct, Result, Type, TypeParam,
};

#[proc_macro_derive(ComposeLens)]
pub fn compose_lens(item: TokenStream) -> TokenStream {
    let compose_lens = parse_macro_input!(item as ComposeLens);
    let inner_generics = &compose_lens.generics;
    let inner_generics_constraints: Vec<_> = inner_generics
        .iter()
        .map(|ty| quote!(#ty: Clone + ::druid::Data))
        .collect();
    let name = &compose_lens.name;
    let builder_name = Ident::new(
        &format!("{}LensBuilder", compose_lens.name),
        compose_lens.name.span(),
    );
    let field_names: Vec<_> = compose_lens
        .fields
        .iter()
        .map(|field| field.0.clone())
        .collect();
    let field_tys: Vec<_> = compose_lens
        .fields
        .iter()
        .map(|field| field.1.clone())
        .collect();
    let lenses: Vec<_> = field_tys
        .iter()
        .map(|ty| quote!(::druid::Lens<Outer, #ty>))
        .collect();
    let generics: Vec<_> = (0..field_names.len())
        .into_iter()
        .map(|n| Ident::new(&format!("L{}", n), Span::call_site()))
        .collect();
    let builder_fields: Vec<_> = izip!(field_names.iter(), generics.iter())
        .map(|(name, ty)| quote!(#name: Option<#ty>))
        .collect();
    let builder_fn_doc = format!(
        "Create a builder object to build a lens for `{}` out of lenses to its fields.",
        name
    );
    let builder_doc = format!(
        "An object for making `Lens`es for `{}` following the builder pattern.

Once all lenses are set, call `build` to create the lens",
        name
    );
    let builder_field_defaults: Vec<_> =
        field_names.iter().map(|name| quote!(#name: None)).collect();
    let builder_field_unwraps: Vec<_> = field_names
        .iter()
        .map(|name| quote!(#name: self.#name.unwrap()))
        .collect();
    let builder_fns: Vec<_> = izip!(field_names.iter(), generics.iter())
        .map(|(name, ty)| {
            let docs = format!("Set the lens for the `{}` field", name);
            quote! {
                #[doc = #docs]
                #[inline]
                pub fn #name(mut self, #name: #ty) -> Self {
                    self.#name = Some(#name);
                    self
                }
            }
        })
        .collect();
    let field_names_tys: Vec<_> = generics
        .iter()
        .zip(field_names.iter())
        .map(|(ty, name)| quote!(#name: #ty))
        .collect();
    let wheres: Vec<_> = inner_generics_constraints
        .iter()
        .cloned()
        .chain(
            generics
                .iter()
                .zip(lenses.iter())
                .map(|(generic, lens)| quote!(#generic: #lens)),
        )
        .collect();
    let all_generics: Vec<_> = iter::once(Ident::new("Outer", Span::call_site()))
        .chain(inner_generics.iter().cloned())
        .chain(generics.iter().cloned())
        .collect();
    let lets: Vec<_> = field_names
        .iter()
        .map(|name| quote!(let #name = self.#name.with(data, |v| v.clone());))
        .collect();
    let assigns = field_names.iter().map(|name| {
        quote!(
            self.#name.with_mut(data, |v| {
                if !::druid::Data::same(&#name, v) {
                    *v = #name;
                }
            });
        )
    });
    let lens_name = Ident::new(&format!("{}Lens", name), Span::call_site());

    TokenStream::from(quote! {
        impl <#(#inner_generics),*> #name<#(#inner_generics),*> {
            #[doc = #builder_fn_doc]
            #[inline]
            pub fn lens_builder<#(#generics),*>() -> #builder_name<#(#generics),*> {
                #builder_name::new()
            }
        }

        #[doc = #builder_doc]
        #[derive(Copy, Clone)]
        pub struct #builder_name<#(#generics),*> {
            #(#builder_fields),*
        }

        impl<#(#generics),*> #builder_name<#(#generics),*> {
            #[inline]
            pub fn new() -> Self {
                Self { #(#builder_field_defaults),* }
            }

            #(#builder_fns)*

            /// Builds the lens
            ///
            /// # Panics
            ///
            /// Panics if any of the field lenses are not set yet.
            #[inline]
            pub fn build<Outer, #(#inner_generics),*>(self) -> #lens_name<#(#generics),*>
            where
                #(#wheres),*
            {
                #lens_name {
                    #(#builder_field_unwraps),*
                }
            }
        }

        impl<#(#generics),*> Default for #builder_name<#(#generics),*> {
            #[inline]
            fn default() -> Self {
                Self::new()
            }
        }

        #[derive(Copy, Clone)]
        pub struct #lens_name<#(#generics),*> {
            #(#field_names_tys),*
        }

        impl<#(#all_generics),*> ::druid::Lens<Outer, #name <#(#inner_generics),*>>
        for #lens_name<#(#generics),*>
        where
            #(#wheres),*
        {
            #[inline]
            fn with<V, F: FnOnce(&#name <#(#inner_generics),*>) -> V>(
                &self,
                data: &Outer,
                f: F
            ) -> V {
                #(#lets)*
                let _widget_data = #name { #(#field_names),* };
                f(&_widget_data)
            }
            #[inline]
            fn with_mut<V, F: FnOnce(&mut #name <#(#inner_generics),*>) -> V>(
                &self,
                data: &mut Outer,
                f: F
            ) -> V {
                #(#lets)*
                let mut _widget_data = #name { #(#field_names),* };
                let output = f(&mut _widget_data);
                let #name { #(#field_names),* } = _widget_data;
                #(#assigns)*
                output
            }
        }
    })
}

struct ComposeLens {
    name: Ident,
    generics: Vec<Ident>,
    fields: Vec<(Ident, Type)>,
}

impl Parse for ComposeLens {
    fn parse(input: ParseStream) -> Result<Self> {
        let raw: ItemStruct = input.parse()?;
        // check the user hasn't used any reserved names for their generics.
        let mut check_generics = CheckGenerics::new();
        check_generics.visit_item_struct(&raw);
        if !check_generics.bad_generics.is_empty() {
            let mut msg = format!("found type names that might clash: ");
            let mut it = check_generics.bad_generics.into_iter();
            let first = it.next().unwrap();
            write!(msg, "\"{}\"", first).unwrap();
            for generic in it {
                write!(msg, ", \"{}\"", generic).unwrap();
            }
            return Err(Error::new(first.span(), &msg));
        }
        // check params
        if let Some(clause) = raw.generics.where_clause {
            return Err(Error::new(
                clause.span(),
                "no constraints allowed on the struct for now",
            ));
        }
        let generics = raw
            .generics
            .params
            .iter()
            .map(|param| match param {
                GenericParam::Type(param) => {
                    if !param.attrs.is_empty() {
                        Err(Error::new(
                            param.attrs.first().unwrap().span(),
                            "attributes not supported",
                        ))
                    } else if param.colon_token.is_some() {
                        Err(Error::new(
                            param.bounds.span(),
                            "constraints on generic parameters not supported",
                        ))
                    } else {
                        Ok(param.ident.clone())
                    }
                }
                other => Err(Error::new(
                    other.span(),
                    "lifetime and const generic parameters not supported",
                )),
            })
            .collect::<Result<Vec<_>>>()?;
        let fields = match raw.fields {
            Fields::Named(f) => f,
            other => {
                return Err(Error::new(
                    other.span(),
                    "only named fields are supported for now",
                ))
            }
        };
        let fields = fields
            .named
            .iter()
            .map(|field| (field.ident.as_ref().cloned().unwrap(), field.ty.clone()))
            .collect::<Vec<_>>();
        let name = raw.ident;
        Ok(ComposeLens {
            name,
            generics,
            fields,
        })
    }
}

// Visitor to check that our generic names don't clash with the user's

struct CheckGenerics {
    bad_generics: Vec<Ident>,
}

impl CheckGenerics {
    fn new() -> Self {
        CheckGenerics {
            bad_generics: vec![],
        }
    }
}

impl<'ast> Visit<'ast> for CheckGenerics {
    fn visit_type_param(&mut self, i: &'ast TypeParam) {
        if bad_ident(&i.ident.to_string()) {
            self.bad_generics.push(i.ident.clone());
        }
    }
}

fn bad_ident(i: &str) -> bool {
    if i == "Outer" {
        true
    } else if i.starts_with("L") {
        let num = &i[1..];
        num.parse::<u64>().is_ok()
    } else {
        false
    }
}