everscale-types-proc 0.1.5

Proc-macro helpers for everscale-types
Documentation
use std::collections::BTreeSet;

use proc_macro2::TokenStream;
use quote::quote;

use crate::internals::{ast, attr, ctxt};
use crate::{bound, Derive};

pub fn impl_derive(input: syn::DeriveInput) -> Result<TokenStream, Vec<syn::Error>> {
    let cx = ctxt::Ctxt::new();
    let container = match ast::Container::from_ast(&cx, &input, Derive::Debug) {
        Some(container) => container,
        None => return Err(cx.check().unwrap_err()),
    };
    cx.check()?;

    let ident = &container.ident;
    let generics = bound::without_default(container.generics);
    let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();

    let (inline, body) = match &container.data {
        ast::Data::Enum(variants) => (variants.len() < 2, build_enum(variants)),
        ast::Data::Struct(style, fields) => {
            (fields.len() < 2, build_struct(&container, *style, fields))
        }
    };

    let inline = if inline { quote!(#[inline]) } else { quote!() };

    let result = quote! {
        #[automatically_derived]
        impl #impl_generics ::everscale_types::cell::Store for #ident #ty_generics #where_clause {
            #inline
            fn store_into(
                &self,
                __builder: &mut ::everscale_types::cell::CellBuilder,
                __context: &mut dyn ::everscale_types::cell::CellContext,
            ) -> ::core::result::Result<(), ::everscale_types::error::Error> {
                #body
            }
        }
    };

    Ok(result)
}

fn build_enum(_: &[ast::Variant<'_>]) -> TokenStream {
    panic!("Unsupported")
}

fn build_struct(
    container: &ast::Container<'_>,
    style: ast::Style,
    fields: &[ast::Field<'_>],
) -> TokenStream {
    let mut tag_version = None;
    let (compute_tag_version, store_tag) = match &container.attrs.tlb_tag {
        attr::ContainerTag::None => (None, None),
        attr::ContainerTag::Single(tag) => (None, store_tag(*tag)),
        attr::ContainerTag::Multiple(tags) => store_tags_versioned(tags, fields, &mut tag_version),
    };

    let fields_len = fields.len();
    let members = fields.iter().enumerate().map(|(i, field)| {
        let ident = &field.member;
        let field_ident = quote!(self.#ident);
        let op = store_op(&field_ident, field.ty);

        let is_last = i + 1 == fields_len;
        match (field.attrs.since_tag, &tag_version) {
            (Some(since), Some(tag_version)) if is_last => {
                quote! {
                    if #tag_version >= #since {
                        #op
                    } else {
                        Ok(())
                    }
                }
            }
            (Some(since), Some(tag_version)) => {
                let op = into_ok(op);
                quote! {
                    if #tag_version >= #since {
                        #op
                    }
                }
            }
            _ if is_last => op,
            _ => into_ok(op),
        }
    });

    match style {
        ast::Style::Unit => match store_tag {
            Some(store_tag) => store_tag,
            None => quote!(::core::result::Result::Ok(())),
        },
        _ => {
            let validate_with = container.attrs.tlb_validate_with.as_ref().map(|expr| {
                quote!(if !#expr(self) {
                    return ::core::result::Result::Err(::everscale_types::error::Error::InvalidData);
                })
            });
            let store_tag = store_tag.map(into_ok);
            quote! {
                #validate_with
                #compute_tag_version
                #store_tag
                #(#members)*
            }
        }
    }
}

fn store_tag(tag: attr::TlbTag) -> Option<TokenStream> {
    let bits = tag.bits as u16;

    let op = match bits {
        0 => return None,
        1 if tag.value == 0 => quote!(store_bit_zero()),
        1 => quote!(store_bit_one()),
        2..=7 => {
            let value = tag.value as u8;
            quote!(store_small_uint(#value, #bits))
        }
        8 => {
            let value = tag.value as u8;
            quote!(store_u8(#value))
        }
        16 => {
            let value = tag.value as u16;
            quote!(store_u16(#value))
        }
        32 => {
            let value = tag.value;
            quote!(store_u32(#value))
        }
        _ => {
            let value = tag.value as u64;
            quote!(store_uint(#value, #bits))
        }
    };
    Some(quote!(__builder.#op))
}

// Returns (tag_version, stop_tag)
fn store_tags_versioned(
    tags: &[attr::TlbTag],
    fields: &[ast::Field<'_>],
    tag_version: &mut Option<syn::Ident>,
) -> (Option<TokenStream>, Option<TokenStream>) {
    let Some(first_tag) = tags.first() else {
        return (None, None);
    };

    let mut used_tags = BTreeSet::new();
    let mut version_guards = Vec::new();
    for field in fields {
        if let Some(since) = field.attrs.since_tag {
            used_tags.insert(since);

            let tag_version =
                tag_version.get_or_insert_with(|| quote::format_ident!("__tag_version"));

            let ident = &field.member;
            let ty = field.ty;

            // TODO: Optimize codegen
            version_guards.push(quote! {
                if self.#ident != <#ty as Default>::default() {
                    #tag_version = std::cmp::max(#tag_version, #since);
                }
            });
        }
    }

    let Some(tag_version) = &tag_version else {
        return (None, store_tag(*first_tag));
    };

    used_tags.remove(&0);
    let match_arms = used_tags.into_iter().filter_map(|tag_index| {
        let store_op = store_tag(tags[tag_index])?;
        Some(quote! { #tag_index => #store_op })
    });
    let Some(store_first) = store_tag(*first_tag) else {
        return (None, None);
    };

    let store_tag = quote! {
        match #tag_version {
            #(#match_arms),*,
            _ => #store_first,
        }
    };

    let compute_tag_version = quote! {
        let mut #tag_version = 0usize;
        #(#version_guards)*
    };
    (Some(compute_tag_version), Some(store_tag))
}

fn store_op(field_ident: &TokenStream, ty: &syn::Type) -> TokenStream {
    #[allow(clippy::unnecessary_operation)]
    'fallback: {
        match ty {
            syn::Type::Path(syn::TypePath { path, .. }) => {
                if let Some(syn::PathSegment { ident, .. }) = path.segments.last() {
                    let op = match ident.to_string().as_str() {
                        "bool" => quote!(store_bit(#field_ident)),
                        "i8" => quote!(store_u8(#field_ident as u8)),
                        "u8" => quote!(store_u8(#field_ident)),
                        "i16" => quote!(store_u16(#field_ident as u16)),
                        "u16" => quote!(store_u16(#field_ident)),
                        "i32" => quote!(store_u32(#field_ident as u32)),
                        "u32" => quote!(store_u32(#field_ident)),
                        "i64" => quote!(store_u64(#field_ident as u64)),
                        "u64" => quote!(store_u64(#field_ident)),
                        "NonZeroU8" => quote!(store_u8(#field_ident.get())),
                        "NonZeroU16" => quote!(store_u16(#field_ident.get())),
                        "NonZeroU32" => quote!(store_u32(#field_ident.get())),
                        "HashBytes" => quote!(store_u256(&#field_ident)),
                        "CellContainer" => quote!(store_reference(#field_ident.clone())),
                        _ => break 'fallback,
                    };

                    return quote!(__builder.#op);
                }
            }
            syn::Type::Reference(syn::TypeReference { elem, .. }) => {
                return store_op(field_ident, elem);
            }
            _ => break 'fallback,
        }
    };

    quote! { <#ty as ::everscale_types::cell::Store>::store_into(&#field_ident, __builder, __context) }
}

fn into_ok(tokens: TokenStream) -> TokenStream {
    quote!(match #tokens {
        ::core::result::Result::Ok(_) => {},
        ::core::result::Result::Err(err) => return ::core::result::Result::Err(err),
    })
}