shebling_codegen/

lib.rs

use proc_macro::TokenStream;
use proc_macro2::Span;
use quote::quote;
use syn::{
    parse_macro_input, spanned::Spanned, AngleBracketedGenericArguments, Error, Fields,
    FieldsNamed, FieldsUnnamed, GenericArgument, ItemEnum, ItemStruct, PathArguments, Type,
};

/// Creates an implementation for a `new()` function that initializes
/// the attached struct.
///
/// # Example
/// ```
/// use shebling_codegen::New;
///
/// #[derive(New)]
/// struct Foo {
///    // Any type that implements Into<String> can be used as the
///    // first parameter for Foo::new.
///    #[new(into)]
///    foo: String,
///    // With boxed types, the generated constructor will take
///    // the unboxed type as a parameter.
///    bar: Box<u32>,
/// }
///
/// let foo = Foo::new("Foo", 10);
/// assert_eq!((foo.foo, *foo.bar), ("Foo".into(), 10));
/// ```
#[proc_macro_derive(New, attributes(new))]
pub fn new_derive(input: TokenStream) -> TokenStream {
    let ItemStruct {
        ident,
        fields,
        generics,
        ..
    } = parse_macro_input!(input as ItemStruct);

    if let Fields::Named(FieldsNamed { named, .. }) = fields {
        let mut param_list = Vec::with_capacity(named.len());
        let mut assigns = Vec::with_capacity(named.len());

        for field in named {
            // Get the #[new] attribute if present.
            let mut new_attrs = field
                .attrs
                .into_iter()
                .filter(|attr| attr.path().is_ident("new"));

            // Check that there is at most one #[new] attribute.
            let new_attr = new_attrs.next();
            if let Some(attr) = new_attrs.next() {
                return error(attr.span(), "Duplicate #[new(..)] attribute.");
            }

            // Check if we should use Into<..> for the constructor parameter.
            let mut use_into = false;
            if let Some(new_attr) = new_attr {
                if let Err(err) = new_attr.parse_nested_meta(|meta| {
                    if meta.path.is_ident("into") {
                        use_into = true;
                        Ok(())
                    } else {
                        Err(meta.error("Invalid #[new(..)] content."))
                    }
                }) {
                    return err.into_compile_error().into();
                }
            }

            // Get the type to use in the parameter list and the field assignment value.
            let field_ident = field.ident.expect("Field should be named.");
            let field_ty = field.ty;
            let (mut param_ty, mut field_assign) = if use_into {
                (quote!(impl Into<#field_ty>), quote!(#field_ident.into()))
            } else {
                (quote!(#field_ty), quote!(#field_ident))
            };

            if let Type::Path(ty) = &field_ty {
                let sgmt = if ty.path.segments.len() != 1 {
                    return error(ty.span(), "Expected a single-segmented type path.");
                } else {
                    &ty.path.segments[0]
                };

                // If the type is boxed, use the inner type as the parameter type
                // and box the parameter when assigning the field.
                if sgmt.ident == "Box" {
                    if let PathArguments::AngleBracketed(AngleBracketedGenericArguments {
                        args,
                        ..
                    }) = &sgmt.arguments
                    {
                        if args.len() != 1 {
                            return error(
                                ty.span(),
                                "Box<..> should have a single generic argument.",
                            );
                        }

                        let inner_ty = if let GenericArgument::Type(ty) = &args[0] {
                            ty
                        } else {
                            return error(ty.span(), "Expected a generic type.");
                        };
                        param_ty = if use_into {
                            quote!(impl Into<#inner_ty>)
                        } else {
                            quote!(#inner_ty)
                        };

                        field_assign = quote!(Box::new(#field_assign));
                    } else {
                        return error(sgmt.span(), "Invalid Box<..> type.");
                    }
                }
            } else {
                return error(field_ty.span(), "Expected a type path.");
            };

            param_list.push(quote!(#field_ident: #param_ty));
            assigns.push(quote!(#field_ident: #field_assign));
        }

        // Write the new() implementation.
        let (impl_generics, ty_generics, where_clause) = generics.split_for_impl();
        let new_impl = quote! {
            impl #impl_generics #ident #ty_generics #where_clause {
                pub(crate) fn new(#(#param_list),*) -> Self {
                    Self { #(#assigns),* }
                }
            }
        };

        new_impl.into()
    } else {
        error(
            fields.span(),
            "Only structs with named fields are supported.",
        )
    }
}

/// Creates a `From<..>` implementation for each variant of the attached
/// enum.
///
/// # Example
/// ```
/// use shebling_codegen::struct_enum;
///
/// struct Foo {
///     foo: u32,
/// }
///
/// #[struct_enum]
/// enum Bar {
///     Foo(Foo),
/// }
///
/// let bar = Bar::from(Foo { foo: 17 });
/// assert!(matches!(bar, Bar::Foo(_)));
/// ```
#[proc_macro_attribute]
pub fn struct_enum(_args: TokenStream, input: TokenStream) -> TokenStream {
    // Parse the input enum.
    let input @ ItemEnum {
        ident,
        variants,
        generics,
        ..
    } = &parse_macro_input!(input as ItemEnum);

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

    if variants.is_empty() {
        return error(input.span(), "Unexpected empty enum.");
    }

    // For each enum variant with an inner struct, generate the From<..> implementation.
    let mut from_impls = Vec::with_capacity(variants.len());
    for variant in variants {
        let variant_ident = &variant.ident;
        let struct_ty = match &variant.fields {
            Fields::Unit => None,
            Fields::Unnamed(FieldsUnnamed { unnamed, .. }) => {
                if unnamed.len() != 1 {
                    return error(unnamed.span(), "Expected a single struct identifier.");
                }

                Some(&unnamed[0].ty)
            }
            _ => return error(variant.span(), "Invalid struct of enums variant."),
        };

        if let Some(struct_ty) = struct_ty {
            from_impls.push(quote! {
                impl #impl_generics From<#struct_ty> for #ident #ty_generics #where_clause {
                    fn from(inner: #struct_ty) -> Self {
                        #ident::#variant_ident(inner)
                    }
                }
            });
        }
    }

    let output = quote! {
        #input
        #(#from_impls)*
    };

    output.into()
}

fn error(span: Span, message: &str) -> TokenStream {
    Error::new(span, message).to_compile_error().into()
}