educe 0.8.1

This crate offers procedural macros designed to facilitate the swift implementation of Rust's built-in traits.
Documentation
use syn::{Data, DeriveInput, Meta, Type};

use super::{
    TraitHandler,
    models::{FieldAttributeBuilder, TypeAttributeBuilder},
};
use crate::{
    Trait,
    common::{
        attributes::{borrow_field, is_packed},
        bound::BOUND_EXCEPTIONS_EQUALITY,
        ident_index::IdentOrIndex,
        quote_mixed,
        where_predicates_bool::{WherePredicates, extend_where_predicates},
    },
    trait_handlers::TraitHandlerContext,
};

/// Generates the `PartialEq` implementation for a struct.
pub(crate) struct PartialEqStructHandler;

impl TraitHandler for PartialEqStructHandler {
    #[inline]
    fn trait_meta_handler<'a>(
        ast: &'a DeriveInput,
        ctx: &mut TraitHandlerContext<'a>,
        token_stream: &mut proc_macro2::TokenStream,
        traits: &[Trait],
        meta: &Meta,
    ) -> syn::Result<()> {
        let generated_impl_attributes =
            crate::common::attributes::generated_impl_attributes(&ast.attrs);

        let type_attribute =
            TypeAttributeBuilder {
                enable_flag: true, enable_unsafe: false, enable_bound: true
            }
            .build_from_partial_eq_meta(meta)?;

        let mut partial_eq_types: Vec<&Type> = Vec::new();

        // A `#[repr(packed)]` type reads every compared field through a copy, so those field types additionally have to be `Copy`.
        let is_packed = is_packed(&ast.attrs);
        let mut copy_types: Vec<&Type> = Vec::new();

        let mut eq_token_stream = proc_macro2::TokenStream::new();

        if let Data::Struct(data) = &ast.data {
            let this = quote_mixed!(self);
            let that = quote_mixed!(other);

            for (index, field) in data.fields.iter().enumerate() {
                let field_attribute = FieldAttributeBuilder {
                    enable_ignore: true,
                    enable_method: true,
                }
                .build_from_attributes(&field.attrs, traits)?;

                if field_attribute.ignore {
                    continue;
                }

                let field_name = IdentOrIndex::from_ident_with_index(field.ident.as_ref(), index);

                if is_packed {
                    copy_types.push(&field.ty);
                }

                let self_ref = borrow_field(is_packed, &this, &field_name);
                let other_ref = borrow_field(is_packed, &that, &field_name);

                if let Some(method) = field_attribute.method {
                    eq_token_stream.extend(quote_mixed! {
                        if !#method(#self_ref, #other_ref) {
                            return false;
                        }
                    });
                } else {
                    let ty = &field.ty;

                    partial_eq_types.push(ty);

                    eq_token_stream.extend(quote_mixed! {
                        if ::core::cmp::PartialEq::ne(#self_ref, #other_ref) {
                            return false;
                        }
                    });
                }
            }
        }

        // `Eq` compares exactly the same fields, so it reuses this list instead of parsing the field attributes again.
        #[cfg(feature = "Eq")]
        ctx.record_partial_eq_types(&partial_eq_types);

        let ident = &ast.ident;

        let packed_copy_predicates = if is_packed {
            type_attribute.bound.packed_copy_predicates(
                &ast.generics.params,
                &copy_types,
                &ast.ident,
            )
        } else {
            WherePredicates::new()
        };

        let mut bound =
            type_attribute.bound.into_where_predicates_by_generic_parameters_check_types(
                &ast.generics.params,
                &syn::parse2(quote_mixed!(::core::cmp::PartialEq)).unwrap(),
                &partial_eq_types,
                &ast.ident,
                &BOUND_EXCEPTIONS_EQUALITY,
            );

        extend_where_predicates(&mut bound, packed_copy_predicates);

        ctx.record(Trait::PartialEq, &bound);

        let generics = crate::common::generics::with_predicates(ast.generics.clone(), bound);

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

        token_stream.extend(quote_mixed! {
            #generated_impl_attributes
            impl #impl_generics ::core::cmp::PartialEq for #ident #ty_generics #where_clause {
                #[inline]
                fn eq(&self, other: &Self) -> ::core::primitive::bool {
                    #eq_token_stream

                    true
                }
            }
        });

        Ok(())
    }
}