drv-macros 0.1.0

Proc macros for drv
Documentation
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
use proc_macro2::{Span, TokenStream};
use quote::{format_ident, quote};
use syn::Ident;

use crate::registry::{self, MemoParam};

pub fn expand() -> Result<TokenStream, syn::Error> {
    registry::with(|reg| {
        let mut output = TokenStream::new();

        // Build per-memo info, group by primary atom (first lens param).
        let memos: Vec<MemoInfo> = reg
            .memos
            .iter()
            .map(|m| build_memo_info(m, reg))
            .collect::<Result<Vec<_>, _>>()?;

        let mut atom_memos: std::collections::HashMap<String, Vec<MemoInfo>> =
            std::collections::HashMap::new();
        for m in &memos {
            atom_memos
                .entry(m.primary_atom.clone())
                .or_default()
                .push(m.clone());
        }

        // Emit per-memo input struct (the cache snapshot for that memo).
        for memo in &memos {
            output.extend(generate_input_struct(memo));
        }

        // Emit per-atom state struct + Atom impl. Every atom gets an impl,
        // even if no memos target it (the atom's `Cache<Self>` field requires it).
        for atom in &reg.atoms {
            let atom_ident = Ident::new(&atom.name, Span::call_site());
            let memos = atom_memos.get(&atom.name).cloned().unwrap_or_default();

            let state_name = format_ident!("__Drv{}State", atom.name);
            let state_fields: Vec<TokenStream> = memos
                .iter()
                .flat_map(|m| {
                    let in_field = format_ident!("{}_input", m.fn_name);
                    let out_field = format_ident!("{}_output", m.fn_name);
                    let input_struct = input_struct_ident(&m.fn_name);
                    let output_ty: syn::Type =
                        syn::parse_str(&m.output_ty_tokens).expect("output type should parse");
                    vec![
                        quote! { #in_field: Option<#input_struct> },
                        quote! { #out_field: Option<#output_ty> },
                    ]
                })
                .collect();

            output.extend(quote! {
                #[doc(hidden)]
                #[derive(Default)]
                pub struct #state_name {
                    #(#state_fields,)*
                }

                impl ::drv::Atom for #atom_ident {
                    type State = #state_name;
                }
            });
        }

        // Emit the rewritten memo functions.
        for memo in &memos {
            output.extend(generate_memo_fn(memo));
        }

        Ok(output)
    })
}

fn input_struct_ident(fn_name: &str) -> Ident {
    format_ident!("__Drv{}Input", snake_to_pascal(fn_name))
}

fn snake_to_pascal(s: &str) -> String {
    s.split('_')
        .map(|word| {
            let mut chars = word.chars();
            match chars.next() {
                None => String::new(),
                Some(c) => c.to_uppercase().collect::<String>() + chars.as_str(),
            }
        })
        .collect()
}

/// Generate the `__Drv{MemoName}Input` struct that holds the cache snapshot.
/// Contains: lens snapshots + value fields, in declared order.
fn generate_input_struct(memo: &MemoInfo) -> TokenStream {
    let struct_ident = input_struct_ident(&memo.fn_name);
    let fields: Vec<TokenStream> = memo
        .params
        .iter()
        .map(|p| {
            let name = Ident::new(&p.param_name, Span::call_site());
            match &p.kind {
                MemoParamKind::Lens { snapshot_ident, .. } => quote! { #name: #snapshot_ident },
                MemoParamKind::Value { ty_tokens } => {
                    let ty: syn::Type = syn::parse_str(ty_tokens).expect("value type should parse");
                    quote! { #name: #ty }
                }
                MemoParamKind::ValueRef { referent_tokens } => {
                    let referent: syn::Type =
                        syn::parse_str(referent_tokens).expect("referent type should parse");
                    quote! { #name: <#referent as ::std::borrow::ToOwned>::Owned }
                }
            }
        })
        .collect();

    quote! {
        #[doc(hidden)]
        #[derive(Default)]
        pub struct #struct_ident {
            #(pub #fields,)*
        }
    }
}

fn generate_memo_fn(memo: &MemoInfo) -> TokenStream {
    let fn_ident = Ident::new(&memo.fn_name, Span::call_site());
    let input_field = format_ident!("{}_input", memo.fn_name);
    let output_field = format_ident!("{}_output", memo.fn_name);
    let output_ty: syn::Type =
        syn::parse_str(&memo.output_ty_tokens).expect("output type should parse");

    let vis: TokenStream = memo.vis_tokens.parse().unwrap_or_else(|_| quote! {});
    let body: TokenStream = memo.body_tokens.parse().expect("body should parse");
    let input_struct = input_struct_ident(&memo.fn_name);

    // __compute fn signature: preserves the user's original signature.
    let compute_params: Vec<TokenStream> = memo
        .params
        .iter()
        .map(|p| {
            let pname = Ident::new(&p.param_name, Span::call_site());
            match &p.kind {
                MemoParamKind::Lens { lens_type, .. } => {
                    quote! { #pname: &#lens_type }
                }
                MemoParamKind::Value { ty_tokens } => {
                    let ty: syn::Type = syn::parse_str(ty_tokens).expect("value type should parse");
                    quote! { #pname: #ty }
                }
                MemoParamKind::ValueRef { referent_tokens } => {
                    let referent: syn::Type =
                        syn::parse_str(referent_tokens).expect("referent type should parse");
                    quote! { #pname: &#referent }
                }
            }
        })
        .collect();

    // Outer fn params, in declared order. Collect lifetime params as we go.
    let mut lifetime_params: Vec<TokenStream> = Vec::new();
    let outer_params: Vec<TokenStream> = memo
        .params
        .iter()
        .enumerate()
        .map(|(i, p)| {
            let pname = Ident::new(&p.param_name, Span::call_site());
            match &p.kind {
                MemoParamKind::Lens {
                    lens_name,
                    is_identity,
                    atom_name,
                    ..
                } => {
                    if *is_identity {
                        let atom_ident = Ident::new(atom_name, Span::call_site());
                        quote! { #pname: &#atom_ident }
                    } else {
                        let lens_ident = Ident::new(lens_name, Span::call_site());
                        let lt = syn::Lifetime::new(&format!("'drv{}", i), Span::call_site());
                        lifetime_params.push(quote! { #lt });
                        quote! { #pname: impl ::core::convert::Into<#lens_ident<#lt>> }
                    }
                }
                MemoParamKind::Value { ty_tokens } => {
                    let ty: syn::Type = syn::parse_str(ty_tokens).expect("value type should parse");
                    quote! { #pname: #ty }
                }
                MemoParamKind::ValueRef { referent_tokens } => {
                    let referent: syn::Type =
                        syn::parse_str(referent_tokens).expect("referent type should parse");
                    quote! { #pname: &#referent }
                }
            }
        })
        .collect();

    let generics = if lifetime_params.is_empty() {
        quote! {}
    } else {
        quote! { <#(#lifetime_params),*> }
    };

    // Inside the function: convert each lens param into the lens value.
    // Value params don't need conversion.
    let conversions: Vec<TokenStream> = memo
        .params
        .iter()
        .map(|p| {
            let pname = Ident::new(&p.param_name, Span::call_site());
            match &p.kind {
                MemoParamKind::Lens { is_identity, .. } if *is_identity => {
                    quote! { let #pname = #pname; }
                }
                MemoParamKind::Lens { .. } => {
                    quote! { let #pname: _ = #pname.into(); }
                }
                MemoParamKind::Value { .. } => {
                    quote! {}
                }
                MemoParamKind::ValueRef { .. } => {
                    quote! {}
                }
            }
        })
        .collect();

    // First lens param determines where the cache lives.
    let first_lens = memo
        .params
        .iter()
        .find(|p| matches!(p.kind, MemoParamKind::Lens { .. }))
        .expect("memo must have at least one lens param (validated in memo.rs)");
    let first_lens_name = Ident::new(&first_lens.param_name, Span::call_site());
    let cache_expr = match &first_lens.kind {
        MemoParamKind::Lens { is_identity, .. } if *is_identity => {
            quote! { &#first_lens_name.__drv }
        }
        _ => quote! { #first_lens_name.__drv },
    };

    // Freshness check: compare each param against the stored snapshot field.
    let fresh_checks: Vec<TokenStream> = memo
        .params
        .iter()
        .map(|p| {
            let pname = Ident::new(&p.param_name, Span::call_site());
            let field = Ident::new(&p.param_name, Span::call_site());
            match &p.kind {
                MemoParamKind::Lens { is_identity, .. } if *is_identity => {
                    // identity atom compared with identity snapshot: *atom == prev.field
                    quote! { *#pname == __prev.#field }
                }
                MemoParamKind::Lens { .. } => {
                    // lens compared with lens snapshot: lens == prev.field
                    quote! { #pname == __prev.#field }
                }
                MemoParamKind::Value { .. } => {
                    // FastEq enables ptr_eq short-circuit for Arc and imbl.
                    quote! { {
                        use ::drv::FastEqFallback as _;
                        ::drv::FastEq(&#pname).fast_eq(&__prev.#field)
                    } }
                }
                MemoParamKind::ValueRef { .. } => {
                    // &T vs <T as ToOwned>::Owned: relies on PartialEq impls
                    // between them (e.g. `&str == String`, `&[u8] == Vec<u8>`).
                    quote! { #pname == __prev.#field }
                }
            }
        })
        .collect();

    // Build the snapshot at cache-miss storage time.
    let snapshot_fields: Vec<TokenStream> = memo
        .params
        .iter()
        .map(|p| {
            let pname = Ident::new(&p.param_name, Span::call_site());
            let field = Ident::new(&p.param_name, Span::call_site());
            match &p.kind {
                MemoParamKind::Lens {
                    is_identity,
                    atom_name,
                    fields: atom_fields,
                    ..
                } if *is_identity => {
                    // Identity snapshot — clone each atom field.
                    let snap = format_ident!("__Drv{}Identity", atom_name);
                    let field_clones: Vec<TokenStream> = atom_fields
                        .iter()
                        .map(|f| {
                            let fname = Ident::new(&f.name, Span::call_site());
                            quote! { #fname: #pname.#fname.clone() }
                        })
                        .collect();
                    quote! { #field: #snap { #(#field_clones),* } }
                }
                MemoParamKind::Lens { .. } => {
                    quote! { #field: #pname.__drv_snapshot() }
                }
                MemoParamKind::Value { .. } => {
                    quote! { #field: #pname }
                }
                MemoParamKind::ValueRef { referent_tokens } => {
                    // Store the owned form via ToOwned::to_owned(&T) → T::Owned.
                    let referent: syn::Type =
                        syn::parse_str(referent_tokens).expect("referent type should parse");
                    quote! { #field: <#referent as ::std::borrow::ToOwned>::to_owned(#pname) }
                }
            }
        })
        .collect();

    // Compute call args: pass lenses by reference, values by move. For value
    // params we clone the value so it survives for the snapshot afterwards.
    let compute_args: Vec<TokenStream> = memo
        .params
        .iter()
        .map(|p| {
            let pname = Ident::new(&p.param_name, Span::call_site());
            match &p.kind {
                MemoParamKind::Lens { is_identity, .. } if *is_identity => {
                    quote! { #pname }
                }
                MemoParamKind::Lens { .. } => {
                    quote! { &#pname }
                }
                MemoParamKind::Value { .. } => {
                    // Clone to pass to compute; the original is moved into the
                    // snapshot below.
                    quote! { #pname.clone() }
                }
                MemoParamKind::ValueRef { .. } => {
                    // Pass the reference through directly; no clone needed
                    // for the compute call.
                    quote! { #pname }
                }
            }
        })
        .collect();

    quote! {
        #vis fn #fn_ident #generics (#(#outer_params),*) -> #output_ty {
            fn __compute(#(#compute_params),*) -> #output_ty {
                #body
            }

            #(#conversions)*

            // Short shared borrow: cache hit returns a clone and releases.
            {
                let __state = ::core::cell::RefCell::borrow(&#cache_expr.inner);
                if let Some(__prev) = __state.#input_field.as_ref() {
                    if #(#fresh_checks)&&* {
                        return <#output_ty as ::core::clone::Clone>::clone(
                            __state.#output_field.as_ref().unwrap()
                        );
                    }
                }
            }

            // Cache miss: compute with no borrow held.
            let __out = __compute(#(#compute_args),*);

            // Short exclusive borrow to store.
            {
                let mut __state = ::core::cell::RefCell::borrow_mut(&#cache_expr.inner);
                __state.#output_field = Some(<#output_ty as ::core::clone::Clone>::clone(&__out));
                __state.#input_field = Some(#input_struct {
                    #(#snapshot_fields,)*
                });
            }

            __out
        }
    }
}

fn build_memo_info(
    memo: &registry::MemoRegistration,
    reg: &registry::Registry,
) -> Result<MemoInfo, syn::Error> {
    let mut params = Vec::new();
    let mut primary_atom: Option<String> = None;

    for p in &memo.params {
        match p {
            MemoParam::Lens {
                param_name,
                lens_name,
            } => {
                let lens = reg
                    .find_lens(lens_name)
                    .expect("lens should exist (validated during #[drv::memo])");

                if primary_atom.is_none() {
                    primary_atom = Some(lens.atom_name.clone());
                }

                let snapshot_ident = if lens.is_identity {
                    format_ident!("__Drv{}Identity", lens.atom_name)
                } else {
                    format_ident!("__Drv{}", lens.name)
                };
                let lens_type = if lens.is_identity {
                    Ident::new(&lens.atom_name, Span::call_site()).into_token_stream()
                } else {
                    let i = Ident::new(&lens.name, Span::call_site());
                    quote! { #i<'_> }
                };

                params.push(MemoParamLocal {
                    param_name: param_name.clone(),
                    kind: MemoParamKind::Lens {
                        lens_name: lens.name.clone(),
                        atom_name: lens.atom_name.clone(),
                        is_identity: lens.is_identity,
                        snapshot_ident,
                        lens_type,
                        fields: lens.fields.clone(),
                    },
                });
            }
            MemoParam::Value {
                param_name,
                ty_tokens,
            } => {
                params.push(MemoParamLocal {
                    param_name: param_name.clone(),
                    kind: MemoParamKind::Value {
                        ty_tokens: ty_tokens.clone(),
                    },
                });
            }
            MemoParam::ValueRef {
                param_name,
                referent_tokens,
            } => {
                params.push(MemoParamLocal {
                    param_name: param_name.clone(),
                    kind: MemoParamKind::ValueRef {
                        referent_tokens: referent_tokens.clone(),
                    },
                });
            }
        }
    }

    Ok(MemoInfo {
        fn_name: memo.fn_name.clone(),
        vis_tokens: memo.vis_tokens.clone(),
        output_ty_tokens: memo.output_ty_tokens.clone(),
        body_tokens: memo.body_tokens.clone(),
        params,
        primary_atom: primary_atom.expect("memo must have at least one lens param"),
    })
}

#[derive(Clone)]
struct MemoInfo {
    fn_name: String,
    vis_tokens: String,
    output_ty_tokens: String,
    body_tokens: String,
    params: Vec<MemoParamLocal>,
    primary_atom: String,
}

#[derive(Clone)]
struct MemoParamLocal {
    param_name: String,
    kind: MemoParamKind,
}

#[derive(Clone)]
enum MemoParamKind {
    Lens {
        lens_name: String,
        atom_name: String,
        is_identity: bool,
        snapshot_ident: Ident,
        lens_type: TokenStream,
        fields: Vec<registry::LensField>,
    },
    Value {
        ty_tokens: String,
    },
    ValueRef {
        /// Token string for the referent type (e.g. "str", "[u8]").
        referent_tokens: String,
    },
}

// Required so we can use ToTokens on the Ident inline.
use quote::ToTokens;