ordinal-map-derive 0.1.6

Ordinal trait to map values to integers and efficient maps and sets for such types
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
use quote::format_ident;
use syn::spanned::Spanned;

pub(crate) fn derive_ordinal(
    input: proc_macro2::TokenStream,
) -> syn::Result<proc_macro2::TokenStream> {
    let span = input.span();
    let input = syn::parse2::<syn::DeriveInput>(input)?;

    let ident = input.ident;

    let from_ordinal_ordinal_var = format_ident!("ordinal");

    let (size, index_expr, from_index_expr) = match input.data {
        syn::Data::Struct(s) => {
            let s = StructGen { s };
            (
                s.ordinal_size()?,
                s.ordinal()?,
                s.from_ordinal(&from_ordinal_ordinal_var)?,
            )
        }
        syn::Data::Enum(e) => {
            let e = EnumGen { e };
            (
                e.ordinal_size()?,
                e.ordinal()?,
                e.from_ordinal(&from_ordinal_ordinal_var)?,
            )
        }
        syn::Data::Union(_) => {
            return Err(syn::Error::new(
                span,
                "Ordinal cannot be derived for unions",
            ))
        }
    };

    let (impl_generics, ty_generics, where_clause) = input.generics.split_for_impl();

    let check_overflow = check_overflow();
    let check_zero_size = check_zero_size();

    Ok(syn::parse_quote_spanned! { span =>
        impl #impl_generics ordinal_map::Ordinal for #ident #ty_generics #where_clause {
            const ORDINAL_SIZE: usize = #size;

            fn ordinal(&self) -> usize {
                #check_overflow
                #index_expr
            }

            // For empty types where after check for zero, code is unreachable.
            #[allow(unreachable_code)]
            fn from_ordinal(#from_ordinal_ordinal_var: usize) -> std::option::Option<Self> {
                #check_zero_size
                #from_index_expr
            }
        }
    })
}

fn check_overflow() -> syn::Stmt {
    syn::parse_quote! {
        // Make sure multiplication doesn't overflow.
        let _check_overflow = Self::ORDINAL_SIZE;
    }
}

fn check_zero_size() -> syn::Stmt {
    syn::parse_quote! {
        // - Make sure multiplication doesn't overflow by accessing the field
        // - Make sure we don't divide by zero in the implementation body
        if Self::ORDINAL_SIZE == 0 {
            return None;
        }
    }
}

fn field_vars(fields: &syn::Fields) -> impl Iterator<Item = syn::Ident> + '_ {
    fields.iter().enumerate().map(|(i, f)| match &f.ident {
        Some(ident) => ident.clone(),
        None => syn::Ident::new(&format!("f{}", i), f.span()),
    })
}

fn field_types(fields: &syn::Fields) -> impl Iterator<Item = &syn::Type> {
    fields.iter().map(|f| &f.ty)
}

fn ordinal_size(ty: &syn::Type) -> syn::Expr {
    syn::parse_quote_spanned! { ty.span() =>
        <#ty as ordinal_map::Ordinal>::ORDINAL_SIZE
    }
}

fn ordinal_expr(value: &syn::Expr) -> syn::Expr {
    syn::parse_quote_spanned! { value.span() =>
        ordinal_map::Ordinal::ordinal(#value)
    }
}

struct StructGen {
    s: syn::DataStruct,
}

fn struct_ordinal_size<'a>(types: impl IntoIterator<Item = &'a syn::Type>) -> syn::Expr {
    let types = types.into_iter();
    syn::parse_quote! {
        const {
            ordinal_map::__macro_refs::ordinal_size_product([
                #( <#types as ordinal_map::Ordinal>::ORDINAL_SIZE, )*
            ])
        }
    }
}

fn struct_ordinal<'a>(
    field_expr_refs: impl IntoIterator<Item = &'a syn::Expr>,
    field_types: impl IntoIterator<Item = &'a syn::Type>,
    span: proc_macro2::Span,
) -> syn::Result<syn::Expr> {
    fn tuple_count<'b>(counts: impl IntoIterator<Item = &'b syn::Expr>) -> syn::Expr {
        fn tuple_count_impl(counts: &[&syn::Expr]) -> syn::Expr {
            match counts {
                [] => syn::parse_quote! { 1usize },
                [count] => (*count).clone(),
                [first, rem @ ..] => {
                    let rem = tuple_count_impl(rem);
                    syn::parse_quote_spanned! { first.span() =>
                        #first * #rem
                    }
                }
            }
        }
        tuple_count_impl(&Vec::from_iter(counts))
    }

    fn tuple_2_ordinal(
        a: &syn::Expr,
        b: &syn::Expr,
        b_count: &syn::Expr,
    ) -> syn::Result<syn::Expr> {
        Ok(syn::parse_quote_spanned! { a.span() =>
            #a * #b_count + #b
        })
    }

    fn struct_ordinal_impl(
        field_expr_refs: &[&syn::Expr],
        field_types: &[&syn::Type],
        span: proc_macro2::Span,
    ) -> syn::Result<syn::Expr> {
        match (field_expr_refs, field_types) {
            ([], []) => Ok(syn::parse_quote_spanned! { span => 0usize }),
            ([field_expr], [_]) => Ok(ordinal_expr(field_expr)),
            ([first_expr, rem_exprs @ ..], [_first_ty, rem_tys @ ..]) => {
                let rem_count = tuple_count(
                    &rem_tys
                        .iter()
                        .copied()
                        .map(ordinal_size)
                        .collect::<Vec<_>>(),
                );
                let first_expr = ordinal_expr(first_expr);
                let rem_expr = struct_ordinal_impl(rem_exprs, rem_tys, span)?;
                tuple_2_ordinal(&first_expr, &rem_expr, &rem_count)
            }
            _ => {
                return Err(syn::Error::new(
                    span,
                    "Mismatched field_expr_refs and field_types",
                ))
            }
        }
    }

    let expr = struct_ordinal_impl(
        field_expr_refs.into_iter().collect::<Vec<_>>().as_slice(),
        field_types.into_iter().collect::<Vec<_>>().as_slice(),
        span,
    )?;
    Ok(expr)
}

fn struct_from_ordinal<'a>(
    ordinal: &syn::Expr,
    field_vars: impl IntoIterator<Item = syn::Ident>,
    field_types: impl IntoIterator<Item = &'a syn::Type>,
    span: proc_macro2::Span,
    constructor: impl FnOnce(Vec<syn::Expr>) -> syn::Expr,
) -> syn::Result<syn::Expr> {
    let field_vars = Vec::from_iter(field_vars);
    let field_types = Vec::from_iter(field_types);

    let mut stmts: Vec<syn::Stmt> = Vec::new();
    stmts.push(syn::parse_quote_spanned! { span =>
        #[allow(unused_mut)]
        let mut rem = #ordinal;
    });
    for (field_var, field_ty) in field_vars.iter().zip(&field_types).rev() {
        let field_ordinal_size = ordinal_size(field_ty);
        stmts.extend([
            syn::parse_quote_spanned! { field_var.span() =>
                let #field_var = <#field_ty as ordinal_map::Ordinal>::from_ordinal(
                    rem % #field_ordinal_size).unwrap();
            },
            syn::parse_quote_spanned! { field_var.span() =>
                rem /= #field_ordinal_size;
            },
        ]);
    }
    stmts.push(syn::parse_quote_spanned! { span =>
        if rem != 0 {
            return None
        }
    });
    let build = constructor(
        field_vars
            .iter()
            .map(|f| syn::parse_quote! { #f })
            .collect(),
    );
    Ok(syn::parse_quote_spanned! { span =>
        {
            #( #stmts )*
            std::option::Option::Some(#build)
        }
    })
}

impl StructGen {
    fn field_ref_exprs(&self) -> impl Iterator<Item = syn::Expr> + '_ {
        self.s.fields.iter().enumerate().map(|(i, f)| {
            let i = syn::Index::from(i);
            match &f.ident {
                Some(ident) => syn::parse_quote_spanned! { ident.span() => &self.#ident },
                None => syn::parse_quote_spanned! { f.span() => &self.#i },
            }
        })
    }

    /// Generate `const ORDINAL_SIZE = ` RHS.
    fn ordinal_size(&self) -> syn::Result<syn::Expr> {
        Ok(struct_ordinal_size(field_types(&self.s.fields)))
    }

    /// Generate `fn ordinal(&self) -> usize` body.
    fn ordinal(&self) -> syn::Result<syn::Expr> {
        let field_types: Vec<_> = field_types(&self.s.fields).collect();
        let field_exprs: Vec<_> = self.field_ref_exprs().collect();
        struct_ordinal(
            &field_exprs,
            field_types.iter().copied(),
            self.s.struct_token.span,
        )
    }

    /// Generate `fn from_ordinal(ordinal: usize) -> Option<Self>` body.
    fn from_ordinal(&self, ordinal_var: &syn::Ident) -> syn::Result<syn::Expr> {
        let field_types: Vec<_> = field_types(&self.s.fields).collect();
        let field_vars: Vec<_> = field_vars(&self.s.fields).collect();
        struct_from_ordinal(
            &syn::parse_quote_spanned! { ordinal_var.span() => #ordinal_var },
            field_vars.iter().cloned(),
            field_types,
            self.s.struct_token.span,
            |exprs| match &self.s.fields {
                syn::Fields::Unit => syn::parse_quote_spanned! { self.s.struct_token.span =>
                    Self
                },
                syn::Fields::Unnamed(_) => {
                    syn::parse_quote_spanned! { self.s.struct_token.span =>
                        Self(
                            #( #exprs, )*
                        )
                    }
                }
                syn::Fields::Named(_) => {
                    syn::parse_quote_spanned! { self.s.struct_token.span =>
                        Self {
                            #( #field_vars: #exprs, )*
                        }
                    }
                }
            },
        )
    }
}

struct EnumGen {
    e: syn::DataEnum,
}

impl EnumGen {
    fn size_of_first_variants(&self, i: usize) -> syn::Result<syn::Expr> {
        let sizes = self
            .e
            .variants
            .iter()
            .take(i)
            .map(|v| struct_ordinal_size(v.fields.iter().map(|f| &f.ty)));
        Ok(syn::parse_quote_spanned! { self.e.enum_token.span =>
            const {
                ordinal_map::__macro_refs::ordinal_size_sum([
                    #( #sizes, )*
                ])
            }
        })
    }

    fn ordinal_size(&self) -> syn::Result<syn::Expr> {
        self.size_of_first_variants(self.e.variants.len())
    }

    fn ordinal(&self) -> syn::Result<syn::Expr> {
        if self.e.variants.is_empty() {
            // Special case because rust doesn't like `match &empty_enum {}`.
            return Ok(syn::parse_quote_spanned! {
                self.e.enum_token.span =>
                0usize
            });
        }

        let mut arms: Vec<syn::Arm> = Vec::new();
        for (i, variant) in self.e.variants.iter().enumerate() {
            let variant_name = &variant.ident;
            let vars = Vec::from_iter(field_vars(&variant.fields));
            let vars = vars.as_slice();
            let size_of_first_variants = self.size_of_first_variants(i)?;
            let bind: syn::Pat = match &variant.fields {
                syn::Fields::Unit => syn::parse_quote_spanned! {
                    variant.span() =>
                    Self::#variant_name
                },
                syn::Fields::Unnamed(_) => {
                    syn::parse_quote_spanned! {
                        variant.span() =>
                        Self::#variant_name( #( #vars ),* )
                    }
                }
                syn::Fields::Named(_) => {
                    syn::parse_quote_spanned! {
                        variant.span() =>
                        Self::#variant_name { #( #vars ),* }
                    }
                }
            };
            let struct_ordinal = struct_ordinal(
                vars.iter()
                    .map(|v| syn::parse_quote! { #v })
                    .collect::<Vec<_>>()
                    .as_slice(),
                field_types(&variant.fields),
                variant.span(),
            )?;
            arms.push(syn::parse_quote_spanned! {
                variant.span() =>
                #bind => {
                    (#size_of_first_variants) + #struct_ordinal
                }
            })
        }
        Ok(syn::parse_quote_spanned! {
            self.e.enum_token.span =>
            match self {
                #( #arms, )*
            }
        })
    }

    fn from_ordinal(&self, ordinal_var: &syn::Ident) -> syn::Result<syn::Expr> {
        let mut stmts: Vec<syn::Stmt> = Vec::new();
        for (i, variant) in self.e.variants.iter().enumerate() {
            let size_of_first_variants_before = self.size_of_first_variants(i)?;
            let size_of_first_variants_including = self.size_of_first_variants(i + 1)?;
            let rem_ordinal = syn::parse_quote_spanned! { variant.span() =>
                #ordinal_var - #size_of_first_variants_before
            };
            let variant_name = &variant.ident;
            let struct_from_ordinal = struct_from_ordinal(
                &rem_ordinal,
                field_vars(&variant.fields),
                field_types(&variant.fields),
                variant.span(),
                |exprs| match &variant.fields {
                    syn::Fields::Unit => syn::parse_quote_spanned! { variant.span() =>
                        Self::#variant_name
                    },
                    syn::Fields::Unnamed(_) => {
                        syn::parse_quote_spanned! { variant.span() =>
                            Self::#variant_name( #( #exprs ),* )
                        }
                    }
                    syn::Fields::Named(_) => {
                        syn::parse_quote_spanned! { variant.span() =>
                            Self::#variant_name { #( #exprs ),* }
                        }
                    }
                },
            )?;
            stmts.push(syn::parse_quote_spanned! {
                variant.span() =>
                if #ordinal_var < #size_of_first_variants_including {
                    return #struct_from_ordinal;
                }
            })
        }
        Ok(syn::parse_quote_spanned! { self.e.enum_token.span =>
            {
                #( #stmts )*
                let _ignore = #ordinal_var;
                std::option::Option::None
            }
        })
    }
}

fn impl_ordinal_for_tuple_n(n: u32) -> syn::Result<syn::ItemImpl> {
    let ordinal_var = format_ident!("ordinal");
    let params: Vec<_> = (0..n)
        .map(|i| format_ident!("{}", char::try_from('A' as u32 + i).unwrap()))
        .collect();
    let vars: Vec<_> = (0..n)
        .map(|i| format_ident!("{}", char::try_from('a' as u32 + i).unwrap()))
        .collect();
    let field_types: Vec<syn::Type> = params.iter().map(|p| syn::parse_quote! { #p }).collect();
    let field_ref_exprs: Vec<syn::Expr> = (0..n)
        .map(|i| {
            let i = syn::Index::from(i as usize);
            syn::parse_quote! { &self.#i }
        })
        .collect();
    let ordinal_size = struct_ordinal_size(&field_types);
    let ordinal = struct_ordinal(
        &field_ref_exprs,
        &field_types,
        proc_macro2::Span::call_site(),
    )?;
    let from_ordinal = struct_from_ordinal(
        &syn::parse_quote_spanned! { ordinal_var.span() => #ordinal_var },
        vars,
        &field_types,
        proc_macro2::Span::call_site(),
        |exprs| syn::parse_quote! { ( #( #exprs, )* ) },
    )?;
    let check_overflow = check_overflow();
    let check_zero_size = check_zero_size();
    Ok(syn::parse_quote! {
        impl< #( #params: ordinal_map::Ordinal, )* > ordinal_map::Ordinal for ( #( #params, )* ) {
            const ORDINAL_SIZE: usize = #ordinal_size;

            fn ordinal(&self) -> usize {
                #check_overflow
                #ordinal
            }

            fn from_ordinal(#ordinal_var: usize) -> std::option::Option<Self> {
                #check_zero_size
                #from_ordinal
            }
        }
    })
}

pub(crate) fn impl_ordinal_for_tuple(
    _input: proc_macro2::TokenStream,
) -> syn::Result<proc_macro2::TokenStream> {
    let tuples: Vec<_> = (0..=16)
        .map(impl_ordinal_for_tuple_n)
        .collect::<syn::Result<_>>()?;
    Ok(quote::quote! {
        #( #tuples )*
    })
}