Add derive macros

Fixes #43

Author: Sufflope

Cargo.toml

@@ -26,8 +26,13 @@ name = "approx"
 
 [features]
 default = ["std"]
+derive = ["dep:approx-derive"]
 std = []
 
 [dependencies]
+approx-derive = { version = "0.5.1", path = "approx-derive", optional = true }
 num-traits = { version = "0.2.0", default_features = false }
 num-complex = { version = "0.4.0", optional = true }
+
+[workspace]
+members = ["approx-derive"]

approx-derive/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "approx-derive"
+version = "0.5.1"
+edition = "2021"
+
+[lib]
+proc-macro = true
+
+[dependencies]
+darling = "0.20"
+itertools = "0.13"
+proc-macro2 = "1"
+quote = "1"
+syn = "2"

approx-derive/src/abs_diff_eq.rs

@@ -0,0 +1,40 @@
+use darling::{ast::Data, FromDeriveInput};
+use proc_macro2::TokenStream;
+use quote::quote;
+use syn::{DeriveInput, Expr, Path};
+
+use crate::{Field, Variant};
+
+#[derive(FromDeriveInput)]
+#[darling(allow_unknown_fields, attributes(approx))]
+struct Opts {
+    epsilon: Path,
+    absolute: Expr,
+    data: Data<Variant, Field>,
+}
+
+pub(crate) fn derive(item: DeriveInput) -> syn::Result<TokenStream> {
+    let Opts {
+        epsilon,
+        absolute,
+        data,
+    } = Opts::from_derive_input(&item)?;
+
+    let ident = item.ident;
+    let comparisons = super::comparisons(data, "abs_diff_eq", None);
+
+    Ok(quote! {
+        #[automatically_derived]
+        impl AbsDiffEq for #ident {
+            type Epsilon = #epsilon;
+
+            fn default_epsilon() -> Self::Epsilon {
+                #absolute
+            }
+
+            fn abs_diff_eq(&self, other: &Self, epsilon: Self::Epsilon) -> bool {
+                #comparisons
+            }
+        }
+    })
+}

approx-derive/src/lib.rs

@@ -0,0 +1,183 @@
+mod abs_diff_eq;
+mod relative_eq;
+
+use darling::{
+    ast::{Data, Fields, Style},
+    util::Flag,
+    FromField, FromVariant,
+};
+use itertools::Itertools;
+use proc_macro2::{Literal, Span, TokenStream};
+use quote::{format_ident, quote, ToTokens};
+use syn::{parse_macro_input, DeriveInput, Ident};
+
+#[derive(FromVariant)]
+#[darling(attributes(approx))]
+struct Variant {
+    ident: Ident,
+    fields: Fields<Field>,
+}
+
+#[derive(FromField)]
+#[darling(attributes(approx), and_then = Self::validate)]
+struct Field {
+    ident: Option<Ident>,
+    skip: Flag,
+    approximate: Flag,
+}
+
+impl Field {
+    fn validate(self) -> darling::Result<Self> {
+        if self.skip.is_present() && self.approximate.is_present() {
+            Err(
+                darling::Error::custom("Cannot both skip and use approximate equality")
+                    .with_span(&self.approximate.span()),
+            )
+        } else {
+            Ok(self)
+        }
+    }
+}
+
+#[proc_macro_derive(AbsDiffEq, attributes(approx))]
+pub fn abs_diff_eq(item: proc_macro::TokenStream) -> proc_macro::TokenStream {
+    let item = parse_macro_input!(item as DeriveInput);
+    convert(abs_diff_eq::derive(item))
+}
+
+#[proc_macro_derive(RelativeEq, attributes(approx))]
+pub fn relative_eq(item: proc_macro::TokenStream) -> proc_macro::TokenStream {
+    let item = parse_macro_input!(item as DeriveInput);
+    convert(relative_eq::derive(item))
+}
+
+fn convert(tokens: syn::Result<TokenStream>) -> proc_macro::TokenStream {
+    tokens.unwrap_or_else(syn::Error::into_compile_error).into()
+}
+
+fn comparisons(data: Data<Variant, Field>, f: &str, arg: Option<&str>) -> TokenStream {
+    let comparisons = data
+        .map_enum_variants(|variant| {
+            let ident = variant.ident;
+            let fields = variant.fields;
+            match fields.style {
+                Style::Tuple => {
+                    let (comps, self_extractors, other_extractors): (Vec<_>, Vec<_>, Vec<_>) =
+                        fields
+                            .fields
+                            .into_iter()
+                            .enumerate()
+                            .map(|(i, field)| {
+                                if field.skip.is_present() {
+                                    (None, format_ident!("_"), format_ident!("_"))
+                                } else {
+                                    let one = format_ident!("_{}", i);
+                                    let other = format_ident!("other_{}", i);
+                                    (
+                                        Some(compare(&one, &other, field.approximate, f, arg)),
+                                        one,
+                                        other,
+                                    )
+                                }
+                            })
+                            .multiunzip();
+                    let comps = comps.iter().flatten();
+                    quote! {
+                        Self::#ident(#(#self_extractors),*) => match other {
+                            Self::#ident(#(#other_extractors),*) => #(#comps)&&*,
+                            _ => false
+                        }
+                    }
+                }
+                Style::Struct => {
+                    let (comps, self_extractors, other_extractors): (Vec<_>, Vec<_>, Vec<_>) =
+                        fields
+                            .fields
+                            .into_iter()
+                            .filter_map(|field| {
+                                if field.skip.is_present() {
+                                    None
+                                } else {
+                                    let one = field.ident.clone().unwrap();
+                                    let other = format_ident!("other_{}", one);
+                                    Some((
+                                        compare(&one, &other, field.approximate, f, arg),
+                                        one.clone(),
+                                        quote! { #one: #other },
+                                    ))
+                                }
+                            })
+                            .multiunzip();
+                    quote! {
+                        Self::#ident { #(#self_extractors),*, .. } => match other {
+                            Self::#ident {#(#other_extractors),*, ..} => #(#comps)&&*,
+                            _ => false
+                        }
+                    }
+                }
+                Style::Unit => quote! { Self::#ident => self == other },
+            }
+        })
+        .map_struct(|fields| {
+            Fields::<TokenStream>::from((
+                fields.style,
+                fields
+                    .into_iter()
+                    .enumerate()
+                    .filter_map(|(i, field)| {
+                        if field.skip.is_present() {
+                            None
+                        } else {
+                            let ident = match field.ident {
+                                None => Literal::usize_unsuffixed(i).to_token_stream(),
+                                Some(ident) => quote! { #ident },
+                            };
+                            Some(compare(
+                                quote! { self.#ident },
+                                quote! { other.#ident },
+                                field.approximate,
+                                f,
+                                arg,
+                            ))
+                        }
+                    })
+                    .collect::<Vec<_>>(),
+            ))
+        });
+
+    if comparisons.is_enum() {
+        let comparisons = comparisons.take_enum().unwrap();
+        quote! {
+            match self {
+                #(#comparisons),*
+            }
+        }
+    } else {
+        let comparisons = comparisons.take_struct().unwrap().fields.into_iter();
+        quote!(#(#comparisons)&&*)
+    }
+}
+
+fn compare<One, Other>(
+    one: One,
+    other: Other,
+    approximate: Flag,
+    f: &str,
+    arg: Option<&str>,
+) -> TokenStream
+where
+    One: ToTokens,
+    Other: ToTokens,
+{
+    if approximate.is_present() {
+        let q = |s| Ident::new(s, Span::call_site());
+        let arg = arg.map(|arg| {
+            let arg = q(arg);
+            quote! {, #arg}
+        });
+        let f = q(f);
+        quote! { #one.#f(&#other, epsilon #arg) }
+    } else {
+        quote! { #one == #other }
+    }
+}

approx-derive/src/relative_eq.rs

@@ -0,0 +1,33 @@
+use darling::{ast::Data, FromDeriveInput};
+use proc_macro2::TokenStream;
+use quote::quote;
+use syn::{DeriveInput, Expr};
+
+use crate::{Field, Variant};
+
+#[derive(FromDeriveInput)]
+#[darling(allow_unknown_fields, attributes(approx))]
+struct Opts {
+    relative: Expr,
+    data: Data<Variant, Field>,
+}
+
+pub(crate) fn derive(item: DeriveInput) -> syn::Result<TokenStream> {
+    let Opts { relative, data } = Opts::from_derive_input(&item)?;
+
+    let ident = item.ident;
+    let comparisons = super::comparisons(data, "relative_eq", Some("max_relative"));
+
+    Ok(quote! {
+        #[automatically_derived]
+        impl RelativeEq for #ident {
+            fn default_max_relative() -> Self::Epsilon {
+                #relative
+            }
+
+            fn relative_eq(&self, other: &Self, epsilon: Self::Epsilon, max_relative: Self::Epsilon) -> bool {
+                #comparisons
+            }
+        }
+    })
+}

src/lib.rs

@@ -157,6 +157,8 @@
 #![no_std]
 #![allow(clippy::transmute_float_to_int)]
 
+#[cfg(feature = "derive")]
+extern crate approx_derive;
 #[cfg(feature = "num-complex")]
 extern crate num_complex;
 extern crate num_traits;
@@ -171,6 +173,9 @@ pub use abs_diff_eq::AbsDiffEq;
 pub use relative_eq::RelativeEq;
 pub use ulps_eq::UlpsEq;
 
+#[cfg(feature = "derive")]
+pub use approx_derive::{AbsDiffEq, RelativeEq};
+
 /// The requisite parameters for testing for approximate equality using a
 /// absolute difference based comparison.
 ///