fixed_map_derive/
lib.rs

1//! [<img alt="github" src="https://img.shields.io/badge/github-udoprog/fixed--map-8da0cb?style=for-the-badge&logo=github" height="20">](https://github.com/udoprog/fixed-map)
2//! [<img alt="crates.io" src="https://img.shields.io/crates/v/fixed-map-derive.svg?style=for-the-badge&color=fc8d62&logo=rust" height="20">](https://crates.io/crates/fixed-map-derive)
3//! [<img alt="docs.rs" src="https://img.shields.io/badge/docs.rs-fixed--map--derive-66c2a5?style=for-the-badge&logoColor=white&logo=data:image/svg+xml;base64,PHN2ZyByb2xlPSJpbWciIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgdmlld0JveD0iMCAwIDUxMiA1MTIiPjxwYXRoIGZpbGw9IiNmNWY1ZjUiIGQ9Ik00ODguNiAyNTAuMkwzOTIgMjE0VjEwNS41YzAtMTUtOS4zLTI4LjQtMjMuNC0zMy43bC0xMDAtMzcuNWMtOC4xLTMuMS0xNy4xLTMuMS0yNS4zIDBsLTEwMCAzNy41Yy0xNC4xIDUuMy0yMy40IDE4LjctMjMuNCAzMy43VjIxNGwtOTYuNiAzNi4yQzkuMyAyNTUuNSAwIDI2OC45IDAgMjgzLjlWMzk0YzAgMTMuNiA3LjcgMjYuMSAxOS45IDMyLjJsMTAwIDUwYzEwLjEgNS4xIDIyLjEgNS4xIDMyLjIgMGwxMDMuOS01MiAxMDMuOSA1MmMxMC4xIDUuMSAyMi4xIDUuMSAzMi4yIDBsMTAwLTUwYzEyLjItNi4xIDE5LjktMTguNiAxOS45LTMyLjJWMjgzLjljMC0xNS05LjMtMjguNC0yMy40LTMzLjd6TTM1OCAyMTQuOGwtODUgMzEuOXYtNjguMmw4NS0zN3Y3My4zek0xNTQgMTA0LjFsMTAyLTM4LjIgMTAyIDM4LjJ2LjZsLTEwMiA0MS40LTEwMi00MS40di0uNnptODQgMjkxLjFsLTg1IDQyLjV2LTc5LjFsODUtMzguOHY3NS40em0wLTExMmwtMTAyIDQxLjQtMTAyLTQxLjR2LS42bDEwMi0zOC4yIDEwMiAzOC4ydi42em0yNDAgMTEybC04NSA0Mi41di03OS4xbDg1LTM4Ljh2NzUuNHptMC0xMTJsLTEwMiA0MS40LTEwMi00MS40di0uNmwxMDItMzguMiAxMDIgMzguMnYuNnoiPjwvcGF0aD48L3N2Zz4K" height="20">](https://docs.rs/fixed-map-derive)
4//!
5//! This crate contains the procedural macros used in [fixed-map].
6//!
7//! [fixed-map]: https://github.com/udoprog/fixed-map
8
9#![recursion_limit = "256"]
10#![forbid(unsafe_code)]
11#![warn(absolute_paths_not_starting_with_crate)]
12#![warn(clippy::alloc_instead_of_core)]
13#![warn(clippy::pedantic)]
14#![warn(clippy::std_instead_of_alloc)]
15#![warn(clippy::std_instead_of_core)]
16#![warn(dead_code)]
17#![warn(elided_lifetimes_in_paths)]
18#![warn(explicit_outlives_requirements)]
19#![warn(keyword_idents)]
20#![warn(macro_use_extern_crate)]
21#![warn(meta_variable_misuse)]
22#![warn(missing_copy_implementations)]
23#![warn(missing_docs)]
24#![warn(non_ascii_idents)]
25#![warn(noop_method_call)]
26#![warn(pointer_structural_match)]
27#![warn(single_use_lifetimes)]
28#![warn(trivial_casts)]
29#![warn(trivial_numeric_casts)]
30#![warn(unreachable_pub)]
31#![warn(unused_extern_crates)]
32#![warn(unused_import_braces)]
33#![warn(unused_lifetimes)]
34#![warn(unused_macro_rules)]
35#![warn(unused_qualifications)]
36#![warn(variant_size_differences)]
37#![allow(clippy::expl_impl_clone_on_copy)]
38#![allow(clippy::module_name_repetitions)]
39#![allow(clippy::too_many_lines)]
40#![allow(clippy::type_repetition_in_bounds)]
41#![allow(clippy::unnecessary_wraps)]
42#![allow(missing_docs)]
43
44use proc_macro2::TokenStream;
45use quote::quote;
46use syn::spanned::Spanned;
47use syn::{Data, DataEnum, DeriveInput, Fields};
48
49mod any_variants;
50mod attrs;
51mod context;
52mod symbol;
53mod unit_variants;
54
55/// See <https://docs.rs/fixed-map>.
56#[proc_macro_derive(Key, attributes(key))]
57pub fn storage_derive(input: proc_macro::TokenStream) -> proc_macro::TokenStream {
58    let ast = syn::parse_macro_input!(input as DeriveInput);
59
60    let lt = syn::Lifetime::new("'a", ast.span());
61    let crate_prefix = context::leading_path(["fixed_map"]);
62    let tokens = context::Toks::new(&crate_prefix);
63    let cx = context::Ctxt::new(&tokens, &ast, &lt);
64
65    let result = impl_storage(&cx);
66
67    if let Ok(gen) = result {
68        return gen.into();
69    }
70
71    let errors = cx.into_errors();
72    let compile_errors = errors.iter().map(syn::Error::to_compile_error);
73    quote!(#(#compile_errors)*).into()
74}
75
76fn impl_storage(cx: &context::Ctxt<'_>) -> Result<TokenStream, ()> {
77    let opts = attrs::parse(cx)?;
78
79    if let Data::Enum(en) = &cx.ast.data {
80        if is_all_unit_variants(en) {
81            unit_variants::implement(cx, &opts, en)
82        } else {
83            any_variants::implement(cx, en)
84        }
85    } else {
86        cx.span_error(cx.ast.span(), "named fields are not supported");
87        Err(())
88    }
89}
90
91fn is_all_unit_variants(en: &DataEnum) -> bool {
92    for v in &en.variants {
93        if !matches!(&v.fields, Fields::Unit) {
94            return false;
95        }
96    }
97
98    true
99}