tdf_derive/

lib.rs

use darling::{FromAttributes, FromMeta};
use proc_macro::{Span, TokenStream};
use proc_macro2::{Delimiter, Group, Punct};
use quote::{quote, ToTokens, TokenStreamExt};
use syn::{
    parse_macro_input, punctuated::Punctuated, token::Comma, Attribute, DataEnum, DataStruct,
    DeriveInput, Expr, Field, Fields, Generics, Ident, Lifetime, LifetimeParam,
};

#[derive(Debug)]
struct DataTag([u8; 4]);

impl FromMeta for DataTag {
    fn from_string(value: &str) -> darling::Result<Self> {
        assert!(value.len() <= 4, "Tag cannot be longer than 4 bytes");
        assert!(!value.is_empty(), "Tag cannot be empty");

        let mut out = [0u8; 4];

        let input = value.as_bytes();
        // Only copy the max of 4 bytes
        let len = input.len().min(4);
        out[0..len].copy_from_slice(input);

        Ok(Self(out))
    }
}

impl ToTokens for DataTag {
    fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {
        tokens.append(Punct::new('&', proc_macro2::Spacing::Joint));
        let [a, b, c, d] = &self.0;
        let inner_stream = quote!(#a, #b, #c, #d);
        tokens.append(Group::new(Delimiter::Bracket, inner_stream));
    }
}

#[derive(Debug, FromAttributes)]
#[darling(attributes(tdf), forward_attrs(allow, doc, cfg))]
struct TdfFieldAttrs {
    tag: Option<DataTag>,
    #[darling(default)]
    into: Option<Expr>,
    #[darling(default)]
    skip: bool,
}

#[derive(Debug, FromAttributes)]
#[darling(attributes(tdf), forward_attrs(allow, doc, cfg))]
struct TdfStructAttr {
    #[darling(default)]
    group: bool,
    #[darling(default)]
    prefix_two: bool,
}

#[derive(Debug, FromAttributes)]
#[darling(attributes(tdf), forward_attrs(allow, doc, cfg))]
struct TdfEnumVariantAttr {
    #[darling(default)]
    default: bool,
}

#[derive(Debug, FromAttributes)]
#[darling(attributes(tdf), forward_attrs(allow, doc, cfg))]
struct TdfTaggedEnumVariantAttr {
    pub key: Option<Expr>,

    #[darling(default)]
    pub tag: Option<DataTag>,

    #[darling(default)]
    pub prefix_two: bool,

    #[darling(default)]
    pub default: bool,

    #[darling(default)]
    pub unset: bool,
}

#[proc_macro_derive(TdfSerialize, attributes(tdf))]
pub fn derive_tdf_serialize(input: TokenStream) -> TokenStream {
    let input: DeriveInput = parse_macro_input!(input);

    match &input.data {
        syn::Data::Struct(data) => impl_serialize_struct(&input, data),
        syn::Data::Enum(data) => {
            if is_enum_tagged(data) {
                impl_serialize_tagged_enum(&input, data)
            } else {
                impl_serialize_repr_enum(&input, data)
            }
        }
        syn::Data::Union(_) => panic!("TdfSerialize cannot be implemented on union types"),
    }
}

#[proc_macro_derive(TdfTyped, attributes(tdf))]
pub fn derive_tdf_typed(input: TokenStream) -> TokenStream {
    let input: DeriveInput = parse_macro_input!(input);

    match &input.data {
        syn::Data::Struct(data) => impl_type_struct(&input, data),
        syn::Data::Enum(data) => {
            if is_enum_tagged(data) {
                impl_type_tagged_enum(&input, data)
            } else {
                impl_type_repr_enum(&input, data)
            }
        }
        syn::Data::Union(_) => panic!("TdfTyped cannot be implemented on union types"),
    }
}

#[proc_macro_derive(TdfDeserialize, attributes(tdf))]
pub fn derive_tdf_deserialize(input: TokenStream) -> TokenStream {
    let input: DeriveInput = parse_macro_input!(input);
    match &input.data {
        syn::Data::Struct(data) => impl_deserialize_struct(&input, data),
        syn::Data::Enum(data) => {
            if is_enum_tagged(data) {
                impl_deserialize_tagged_enum(&input, data)
            } else {
                impl_deserialize_repr_enum(&input, data)
            }
        }

        syn::Data::Union(_) => panic!("TdfDeserialize cannot be implemented on union types"),
    }
}

fn get_repr_attribute(attrs: &[Attribute]) -> Option<Ident> {
    attrs
        .iter()
        .filter_map(|attr| attr.meta.require_list().ok())
        .find(|value| value.path.is_ident("repr"))
        .map(|attr| {
            let value: Ident = attr.parse_args().expect("Failed to parse repr type");
            value
        })
}

/// Determines whether an enum should be considered to be a Tagged Union
/// rather than a repr enum. Any enum types that have fields cannot be
/// repr types and thus must be Tagged Union's
fn is_enum_tagged(data: &DataEnum) -> bool {
    data.variants
        .iter()
        .any(|variant| !variant.fields.is_empty())
}

fn impl_type_struct(input: &DeriveInput, _data: &DataStruct) -> TokenStream {
    let attr =
        TdfStructAttr::from_attributes(&input.attrs).expect("Failed to parse tdf struct attrs");

    assert!(
        attr.group,
        "Cannot derive TdfTyped on non group struct, type is unknown"
    );

    let ident = &input.ident;
    let generics = &input.generics;
    let where_clause = generics.where_clause.as_ref();

    quote! {
        impl #generics tdf::TdfTyped for #ident #generics #where_clause {
            const TYPE: tdf::TdfType = tdf::TdfType::Group;
        }
    }
    .into()
}

fn impl_type_repr_enum(input: &DeriveInput, _data: &DataEnum) -> TokenStream {
    let ident = &input.ident;
    let repr = get_repr_attribute(&input.attrs)
        .expect("Non-tagged enums require #[repr({ty})] to be specified");

    quote! {
        impl tdf::TdfTyped for #ident {
            const TYPE: tdf::TdfType = <#repr as tdf::TdfTyped>::TYPE;
        }
    }
    .into()
}

fn impl_type_tagged_enum(input: &DeriveInput, _data: &DataEnum) -> TokenStream {
    let ident = &input.ident;

    let generics = &input.generics;
    let where_clause = generics.where_clause.as_ref();

    quote! {
        impl #generics tdf::TdfTyped for #ident #generics #where_clause {
            const TYPE: tdf::TdfType = tdf::TdfType::TaggedUnion;
        }
    }
    .into()
}

fn tag_field_serialize(
    field: &Field,
    into: Option<Expr>,
    tag: Option<DataTag>,
    is_struct: bool,
) -> proc_macro2::TokenStream {
    let tag = tag.expect("Fields that arent skipped must specify a tag");
    let ident = &field.ident;
    let ty = &field.ty;

    // TODO: Validate tag

    let value = if is_struct {
        quote!(&self.#ident)
    } else {
        quote!(#ident)
    };

    if let Some(into) = into {
        quote!( w.tag_owned::<#into>(#tag, <#ty as Into::<#into>>::into(*#value)); )
    } else {
        quote! ( w.tag_ref::<#ty>(#tag, #value); )
    }
}

fn impl_serialize_struct(input: &DeriveInput, data: &DataStruct) -> TokenStream {
    let attr =
        TdfStructAttr::from_attributes(&input.attrs).expect("Failed to parse tdf struct attrs");
    let ident = &input.ident;
    let generics = &input.generics;
    let where_clause = generics.where_clause.as_ref();

    let serialize_impls = data.fields.iter().filter_map(|field| {
        let attributes =
            TdfFieldAttrs::from_attributes(&field.attrs).expect("Failed to parse tdf field attrs");
        if attributes.skip {
            None
        } else {
            Some(tag_field_serialize(
                field,
                attributes.into,
                attributes.tag,
                true,
            ))
        }
    });

    let mut leading = None;
    let mut trailing = None;

    if attr.group {
        if attr.prefix_two {
            leading = Some(quote! { w.write_byte(2); });
        }

        trailing = Some(quote!( w.tag_group_end();));
    }

    quote! {
        impl #generics tdf::TdfSerialize for #ident #generics #where_clause {
            fn serialize<S: tdf::TdfSerializer>(&self, w: &mut S) {
                #leading
                #(#serialize_impls)*
                #trailing
            }
        }
    }
    .into()
}

fn impl_serialize_repr_enum(input: &DeriveInput, _data: &DataEnum) -> TokenStream {
    let ident = &input.ident;
    let repr = get_repr_attribute(&input.attrs)
        .expect("Non-tagged enums require #[repr({ty})] to be specified");

    quote! {
        impl tdf::TdfSerializeOwned for #ident {
            fn serialize_owned<S: tdf::TdfSerializer>(self, w: &mut S) {
                <#repr as tdf::TdfSerializeOwned>::serialize_owned(self as #repr, w);
            }
        }

        impl tdf::TdfSerialize for #ident {
            #[inline]
            fn serialize<S: tdf::TdfSerializer>(&self, w: &mut S) {
               tdf::TdfSerializeOwned::serialize_owned(*self, w);
            }
        }
    }
    .into()
}

fn impl_serialize_tagged_enum(input: &DeriveInput, data: &DataEnum) -> TokenStream {
    let ident = &input.ident;

    let field_impls: Vec<_> = data
        .variants
        .iter()
        .map(|variant| {
            let attr: TdfTaggedEnumVariantAttr =
                TdfTaggedEnumVariantAttr::from_attributes(&variant.attrs)
                    .expect("Failed to parse tdf field attrs");

            (variant, attr)
        })
        .map(|(variant, attr)| {
            let var_ident = &variant.ident;
            let value_tag = attr.tag;
            let is_unit = attr.unset || attr.default;

            // TODO: Ensure no duplicates & validate value tag matches

            if let Fields::Unit = &variant.fields {
                assert!(
                    is_unit,
                    "Only unset or default enum variants can have no content"
                );

                return quote! {
                    Self::#var_ident => {
                        w.write_byte(tdf::types::tagged_union::TAGGED_UNSET_KEY);
                    }
                };
            }

            assert!(
                !is_unit,
                "Enum variants with fields cannot be used as the default or unset variant"
            );

            let discriminant = attr.key.expect("Missing discriminant key");
            let value_tag = value_tag.expect("Missing value tag");

            match &variant.fields {
                // Variants with named fields are handled as groups
                Fields::Named(fields) => {
                    let (idents, impls): (Vec<_>, Vec<_>) = fields
                        .named
                        .iter()
                        .filter_map(|field| {
                            let attributes = TdfFieldAttrs::from_attributes(&field.attrs)
                                .expect("Failed to parse tdf field attrs");
                            if attributes.skip {
                                return None;
                            }

                            Some((field, attributes))
                        })
                        .map(|(field, attributes)| {
                            let ident = field.ident.as_ref().expect("Field missing ident");
                            let serialize = tag_field_serialize(field, attributes.into,attributes.tag, false);
                            (ident, serialize)
                        })
                        .unzip();

                    // Handle how field names are listed
                    let field_names: proc_macro2::TokenStream = if idents.is_empty() {
                        quote!(..)
                    } else if idents.len() != fields.named.len() {
                        quote!(#(#idents,)* ..)
                    } else {
                        quote!(#(#idents),*)
                    };

                    let mut leading = None;

                    if attr.prefix_two {
                        leading = Some(quote!( w.write_byte(2); ))
                    }

                    quote! {
                        Self::#var_ident { #field_names } => {
                            w.write_byte(#discriminant);
                            tdf::Tagged::serialize_raw(w, #value_tag, tdf::TdfType::Group);

                            #leading
                            #(#impls)*
                            w.tag_group_end();
                        }
                    }
                }

                // Variants with unnamed fields are treated as the type of the first field (Only one field is allowed)
                Fields::Unnamed(fields) => {
                    let fields = &fields.unnamed;
                    let field = fields.first().expect("Unnamed tagged enum missing field");

                    assert!(
                        fields.len() == 1,
                        "Tagged union cannot have more than one unnamed field"
                    );

                    let field_ty = &field.ty;

                    quote! {
                        Self::#var_ident(value) => {
                            w.write_byte(#discriminant);
                            tdf::Tagged::serialize_raw(w, #value_tag, <#field_ty as tdf::TdfTyped>::TYPE);

                            <#field_ty as tdf::TdfSerialize>::serialize(value, w);
                        }
                    }
                }
                Fields::Unit => unreachable!("Unit types should already be handled above"),
            }
        })
        .collect();
    let generics = &input.generics;
    let where_clause = generics.where_clause.as_ref();

    quote! {
        impl #generics tdf::TdfSerialize for #ident #generics #where_clause {
            fn serialize<S: tdf::TdfSerializer>(&self, w: &mut S) {
                match self {
                    #(#field_impls),*
                }
            }
        }
    }
    .into()
}

/// Obtains the lifetime that should be used by [tdf::TdfDeserializer] when
/// deserializing values. If the generic parameters specify a lifetime then
/// that lifetime is used otherwise the default lifetime '_ is used instead
///
/// Will panic if structure uses more than 1 lifetime as its not possible
/// to deserialize with more than one lifetime
fn get_deserialize_lifetime(generics: &Generics) -> LifetimeParam {
    let mut lifetimes = generics.lifetimes();

    let lifetime = lifetimes
        .next()
        .cloned()
        // Use a default '_ lifetime while deserializing when no lifetime is provided
        .unwrap_or_else(|| LifetimeParam::new(Lifetime::new("'_", Span::call_site().into())));

    assert!(
        lifetimes.next().is_none(),
        "Deserializable structs cannot have more than one lifetime"
    );

    lifetime
}

/// Creates a token stream for deserializing the provided `field`
/// loads the tag and whether
fn tag_field_deserialize(field: &Field) -> proc_macro2::TokenStream {
    let attributes =
        TdfFieldAttrs::from_attributes(&field.attrs).expect("Failed to parse tdf field attrs");

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

    if attributes.skip {
        quote!( let #ident = Default::default(); )
    } else {
        let tag = attributes
            .tag
            .expect("Fields that arent skipped must specify a tag");

        // TODO: Validate tag
        if let Some(into) = attributes.into {
            quote!( let #ident = <#ty as From<#into>>::from(r.tag::<#into>(#tag)?); )
        } else {
            quote!( let #ident = r.tag::<#ty>(#tag)?; )
        }
    }
}

fn impl_deserialize_struct(input: &DeriveInput, data: &DataStruct) -> TokenStream {
    let attributes =
        TdfStructAttr::from_attributes(&input.attrs).expect("Failed to parse tdf struct attrs");

    let ident = &input.ident;

    let generics = &input.generics;
    let lifetime = get_deserialize_lifetime(generics);
    let where_clause = generics.where_clause.as_ref();

    let idents = data.fields.iter().filter_map(|field| field.ident.as_ref());
    let impls = data.fields.iter().map(tag_field_deserialize);

    let mut trailing = None;

    // Groups need leading deserialization for possible prefixes and trailing
    // deserialization to read any unused tags and to read the group end byte
    if attributes.group {
        trailing = Some(quote!( tdf::GroupSlice::deserialize_content_skip(r)?; ));
    }

    quote! {
        impl #generics tdf::TdfDeserialize<#lifetime> for #ident #generics #where_clause {
            fn deserialize(r: &mut tdf::TdfDeserializer<#lifetime>) -> tdf::DecodeResult<Self> {
                #(#impls)*
                #trailing
                Ok(Self {
                    #(#idents),*
                })
            }
        }
    }
    .into()
}

fn impl_deserialize_repr_enum(input: &DeriveInput, data: &DataEnum) -> TokenStream {
    let repr = get_repr_attribute(&input.attrs)
        .expect("Non-tagged enums require #[repr({ty})] to be specified");

    let mut default = None;

    let variant_cases: Vec<_> = data
        .variants
        .iter()
        .map(|variant| {
            let attr = TdfEnumVariantAttr::from_attributes(&variant.attrs)
                .expect("Failed to parse tdf enum variant attrs");
            (variant, attr)
        })
        .filter(|(variant, attr)| {
            if !attr.default {
                return true;
            }

            assert!(
                default.is_none(),
                "Cannot have more than one default variant"
            );

            let ident = &variant.ident;

            default = Some(quote!(_ => Self::#ident));

            false
        })
        .map(|(variant, _attr)| {
            let var_ident = &variant.ident;
            let (_, discriminant) = variant
                .discriminant
                .as_ref()
                .expect("Repr enum variants must include a descriminant for each value");

            quote! ( #discriminant => Self::#var_ident )
        })
        .collect();

    let ident = &input.ident;
    let default = default.unwrap_or_else(
        || quote!(_ => return Err(tdf::DecodeError::Other("Missing fallback enum variant"))),
    );

    quote! {
        impl tdf::TdfDeserialize<'_> for #ident {
            fn deserialize(r: &mut tdf::TdfDeserializer<'_>) -> tdf::DecodeResult<Self> {
                let value = <#repr as tdf::TdfDeserialize<'_>>::deserialize(r)?;
                Ok(match value {
                    #(#variant_cases,)*
                    #default
                })
            }
        }
    }
    .into()
}

fn impl_deserialize_tagged_enum(input: &DeriveInput, data: &DataEnum) -> TokenStream {
    let generics = &input.generics;
    let lifetime = get_deserialize_lifetime(generics);
    let where_clause = generics.where_clause.as_ref();

    let mut has_unset = false;
    let mut has_default = false;

    let mut impls: Punctuated<proc_macro2::TokenStream, Comma> = data
        .variants
        .iter()
        .map(|variant| {
            let attr: TdfTaggedEnumVariantAttr =
                TdfTaggedEnumVariantAttr::from_attributes(&variant.attrs)
                    .expect("Failed to parse tdf field attrs");

            let var_ident = &variant.ident;
            let is_unit = attr.unset || attr.default;

            if let Fields::Unit = &variant.fields {
                assert!(
                    is_unit,
                    "Only unset or default enum variants can have no content"
                );

                assert!(
                    !(attr.default && attr.unset),
                    "Enum variant cannot be default and unset"
                );

                return if attr.default {
                    assert!(!has_default, "Default variant already defined");
                    has_default = true;

                    quote! {
                        _  => {
                            let tag = tdf::Tagged::deserialize_owned(r)?;
                            tag.ty.skip(r, false)?;
                            Self::#var_ident
                        }
                    }
                } else {
                    assert!(!has_unset, "Unset variant already defined");
                    has_unset = true;
                    quote!( tdf::types::tagged_union::TAGGED_UNSET_KEY => Self::#var_ident )
                };
            }

            assert!(
                !is_unit,
                "Enum variants with fields cannot be used as the default or unset variant"
            );

            let discriminant = attr.key.expect("Missing discriminant key");
            let _value_tag = attr.tag.expect("Missing value tag");

            match &variant.fields {
                // Variants with named fields are handled as groups
                Fields::Named(fields) => {
                    let (idents, impls): (Vec<_>, Vec<_>) = fields
                        .named
                        .iter()
                        .map(|field| {
                            let ident = field.ident.as_ref().unwrap();
                            let value = tag_field_deserialize(field);
                            (ident, value)
                        })
                        .unzip();

                    quote! {
                        #discriminant => {
                            let tag = tdf::Tagged::deserialize_owned(r)?;

                            #(#impls)*
                            tdf::GroupSlice::deserialize_content_skip(r)?;

                            Self::#var_ident {
                                #(#idents),*
                            }
                        }
                    }
                }
                // Variants with unnamed fields are treated as the type of the first field (Only one field is allowed)
                Fields::Unnamed(fields) => {
                    let fields = &fields.unnamed;
                    let field = fields.first().expect("Unnamed tagged enum missing field");

                    assert!(
                        fields.len() == 1,
                        "Tagged union cannot have more than one unnamed field"
                    );

                    let field_ty = &field.ty;

                    quote! {
                        #discriminant => {
                            let tag = tdf::Tagged::deserialize_owned(r)?;

                            let value = <#field_ty as tdf::TdfDeserialize<'_>>::deserialize(r)?;
                            Self::#var_ident(value)
                        }
                    }
                }

                Fields::Unit => unreachable!("Unit types should already be handled above"),
            }
        })
        .collect();

    if !has_unset {
        // If an unset variant is not specified its handling is replaced with a runtime error
        impls.push(quote!(
            tdf::types::tagged_union::TAGGED_UNSET_KEY => return Err(tdf::DecodeError::Other("Missing unset enum variant"))
        ));
    }

    if !has_default {
        // If a default variant is not specified its handling is replaced with a runtime error
        impls.push(quote!(
            _ => return Err(tdf::DecodeError::Other("Missing default enum variant"))
        ));
    }

    let ident = &input.ident;

    quote! {
        impl #generics tdf::TdfDeserialize<#lifetime> for #ident #generics #where_clause {
            fn deserialize(r: &mut tdf::TdfDeserializer<#lifetime>) -> tdf::DecodeResult<Self> {
                let discriminant = <u8 as tdf::TdfDeserialize<#lifetime>>::deserialize(r)?;

                Ok(match discriminant {
                    #impls
                })
            }
        }
    }
    .into()
}