#![deny(clippy::all)] #![deny(clippy::pedantic)] #![deny(missing_docs)] //! Macros for the [Syrette](https://crates.io/crates/syrette) crate. use proc_macro::TokenStream; use quote::quote; use syn::{parse, parse_macro_input}; mod decl_def_factory_args; mod declare_interface_args; mod dependency; mod factory_macro_args; mod factory_type_alias; mod fn_trait; mod injectable_impl; mod injectable_macro_args; mod libs; mod macro_flag; mod named_attr_input; mod util; use declare_interface_args::DeclareInterfaceArgs; use injectable_impl::InjectableImpl; use injectable_macro_args::InjectableMacroArgs; use libs::intertrait_macros::gen_caster::generate_caster; /// Makes a struct injectable. Thereby usable with [`DIContainer`]. /// /// # Arguments /// * (Optional) A interface trait the struct implements. /// * (Zero or more) Flags. Like `a = true, b = false` /// /// # Flags /// - `no_doc_hidden` - Don't hide the impl of the [`Injectable`] trait from /// documentation. /// - `async` - Mark as async. /// /// # Panics /// If the attributed item is not a impl. /// /// # Important /// If the interface trait argument is excluded, you should either manually /// declare the interface with the [`declare_interface!`] macro or use /// the [`di_container_bind`] macro to create a DI container binding. /// /// # Attributes /// Attributes specific to impls with this attribute macro. /// /// ### Named /// Used inside the `new` method before a dependency argument. Declares the name of the /// dependency. Should be given the name quoted inside parenthesis. /// /// The [`macro@named`] ghost attribute macro can be used for intellisense and /// autocompletion for this attribute. /// /// For example: /// ``` /// # use syrette::ptr::TransientPtr; /// # use syrette::injectable; /// # /// # trait IArmor {} /// # /// # trait IKnight {} /// # /// # struct Knight /// # { /// # tough_armor: TransientPtr, /// # light_armor: TransientPtr, /// # } /// # /// #[injectable(IKnight)] /// impl Knight /// { /// pub fn new( /// #[named("tough")] tough_armor: TransientPtr, /// #[named("light")] light_armor: TransientPtr, /// ) -> Self /// { /// Self { /// tough_armor, /// light_armor, /// } /// } /// } /// # /// # impl IKnight for Knight {} /// ``` /// /// # Example /// ``` /// # use syrette::injectable; /// # /// # struct PasswordManager {} /// # /// #[injectable] /// impl PasswordManager /// { /// pub fn new() -> Self /// { /// Self {} /// } /// } /// ``` /// /// [`DIContainer`]: ../syrette/di_container/struct.DIContainer.html /// [`Injectable`]: ../syrette/interfaces/injectable/trait.Injectable.html /// [`di_container_bind`]: ../syrette/macro.di_container_bind.html #[proc_macro_attribute] pub fn injectable(args_stream: TokenStream, impl_stream: TokenStream) -> TokenStream { let InjectableMacroArgs { interface, flags } = parse_macro_input!(args_stream); let no_doc_hidden = flags .iter() .find(|flag| flag.flag.to_string().as_str() == "no_doc_hidden") .map_or(false, |flag| flag.is_on.value); let is_async = flags .iter() .find(|flag| flag.flag.to_string().as_str() == "async") .map_or(false, |flag| flag.is_on.value); let injectable_impl: InjectableImpl = parse(impl_stream).unwrap(); let expanded_injectable_impl = injectable_impl.expand(no_doc_hidden, is_async); let maybe_decl_interface = if interface.is_some() { let self_type = &injectable_impl.self_type; if is_async { quote! { syrette::declare_interface!(#self_type -> #interface, async = true); } } else { quote! { syrette::declare_interface!(#self_type -> #interface); } } } else { quote! {} }; quote! { #expanded_injectable_impl #maybe_decl_interface } .into() } /// Makes a type alias usable as a factory interface. /// /// The return type is automatically put inside of a [`TransientPtr`]. /// /// *This macro is only available if Syrette is built with the "factory" feature.* /// /// # Arguments /// * (Zero or more) Flags. Like `a = true, b = false` /// /// # Flags /// - `threadsafe` - Mark as threadsafe. /// - `async` - Mark as async. Infers the `threadsafe` flag. The return type is /// automatically put inside of a pinned boxed future. /// /// # Panics /// If the attributed item is not a type alias. /// /// # Examples /// ``` /// # use syrette::factory; /// # /// # trait IConfigurator {} /// # /// # struct Configurator {} /// # /// # impl Configurator /// # { /// # fn new() -> Self /// # { /// # Self {} /// # } /// # } /// # /// # impl IConfigurator for Configurator {} /// # /// #[factory] /// type IConfiguratorFactory = dyn Fn(Vec) -> dyn IConfigurator; /// ``` #[proc_macro_attribute] #[cfg(feature = "factory")] pub fn factory(args_stream: TokenStream, type_alias_stream: TokenStream) -> TokenStream { use quote::ToTokens; use syn::Type; use crate::factory_macro_args::FactoryMacroArgs; let FactoryMacroArgs { flags } = parse(args_stream).unwrap(); let mut is_threadsafe = flags .iter() .find(|flag| flag.flag.to_string().as_str() == "threadsafe") .map_or(false, |flag| flag.is_on.value); let is_async = flags .iter() .find(|flag| flag.flag.to_string().as_str() == "async") .map_or(false, |flag| flag.is_on.value); if is_async { is_threadsafe = true; } let factory_type_alias::FactoryTypeAlias { mut type_alias, mut factory_interface, arg_types: _, return_type: _, } = parse(type_alias_stream).unwrap(); let output = factory_interface.output.clone(); factory_interface.output = parse( if is_async { quote! { std::pin::Pin> >> } } else { quote! { syrette::ptr::TransientPtr<#output> } } .into(), ) .unwrap(); type_alias.ty = Box::new(Type::Verbatim(factory_interface.to_token_stream())); let decl_interfaces = if is_threadsafe { quote! { syrette::declare_interface!( syrette::castable_factory::threadsafe::ThreadsafeCastableFactory< (std::sync::Arc,), #factory_interface > -> syrette::interfaces::factory::IFactory< (std::sync::Arc,), #factory_interface >, async = true ); syrette::declare_interface!( syrette::castable_factory::threadsafe::ThreadsafeCastableFactory< (std::sync::Arc,), #factory_interface > -> syrette::interfaces::any_factory::AnyThreadsafeFactory, async = true ); } } else { quote! { syrette::declare_interface!( syrette::castable_factory::blocking::CastableFactory< (std::rc::Rc,), #factory_interface > -> syrette::interfaces::factory::IFactory< (std::rc::Rc,), #factory_interface > ); syrette::declare_interface!( syrette::castable_factory::blocking::CastableFactory< (std::rc::Rc,), #factory_interface > -> syrette::interfaces::any_factory::AnyFactory ); } }; quote! { #type_alias #decl_interfaces } .into() } /// Shortcut for declaring a default factory. /// /// A default factory is a factory that doesn't take any arguments. /// /// The more tedious way to accomplish what this macro does would be by using /// the [`macro@factory`] macro. /// /// *This macro is only available if Syrette is built with the "factory" feature.* /// /// # Arguments /// - Interface trait /// * (Zero or more) Flags. Like `a = true, b = false` /// /// # Flags /// - `threadsafe` - Mark as threadsafe. /// /// # Panics /// If the provided arguments are invalid. /// /// # Examples /// ``` /// # use syrette::declare_default_factory; /// # /// trait IParser /// { /// // Methods and etc here... /// } /// /// declare_default_factory!(dyn IParser); /// ``` #[proc_macro] #[cfg(feature = "factory")] pub fn declare_default_factory(args_stream: TokenStream) -> TokenStream { use crate::decl_def_factory_args::DeclareDefaultFactoryMacroArgs; let DeclareDefaultFactoryMacroArgs { interface, flags } = parse(args_stream).unwrap(); let is_threadsafe = flags .iter() .find(|flag| flag.flag.to_string().as_str() == "threadsafe") .map_or(false, |flag| flag.is_on.value); if is_threadsafe { return quote! { syrette::declare_interface!( syrette::castable_factory::threadsafe::ThreadsafeCastableFactory< (std::sync::Arc,), #interface, > -> syrette::interfaces::factory::IFactory< (std::sync::Arc,), #interface >, async = true ); syrette::declare_interface!( syrette::castable_factory::threadsafe::ThreadsafeCastableFactory< (std::sync::Arc,), #interface, > -> syrette::interfaces::any_factory::AnyThreadsafeFactory, async = true ); } .into(); } quote! { syrette::declare_interface!( syrette::castable_factory::blocking::CastableFactory< (std::rc::Rc,), #interface, > -> syrette::interfaces::factory::IFactory< (std::rc::Rc,), #interface > ); syrette::declare_interface!( syrette::castable_factory::blocking::CastableFactory< (std::rc::Rc,), #interface, > -> syrette::interfaces::any_factory::AnyFactory ); } .into() } /// Declares the interface trait of a implementation. /// /// # Arguments /// {Implementation} -> {Interface} /// * (Zero or more) Flags. Like `a = true, b = false` /// /// # Flags /// - `async` - Mark as async. /// /// # Examples /// ``` /// # use syrette::declare_interface; /// # /// # trait INinja {} /// # /// # struct Ninja {} /// # /// # impl INinja for Ninja {} /// # /// declare_interface!(Ninja -> INinja); /// ``` #[proc_macro] pub fn declare_interface(input: TokenStream) -> TokenStream { let DeclareInterfaceArgs { implementation, interface, flags, } = parse_macro_input!(input); let opt_async_flag = flags .iter() .find(|flag| flag.flag.to_string().as_str() == "async"); let is_async = opt_async_flag.map_or_else(|| false, |async_flag| async_flag.is_on.value); generate_caster(&implementation, &interface, is_async).into() } /// Declares the name of a dependency. /// /// This macro attribute doesn't actually do anything. It only exists for the /// convenience of having intellisense and autocompletion. /// You might as well just use `named` if you don't care about that. /// /// Only means something inside a `new` method inside a impl with /// the [`macro@injectable`] macro attribute. /// /// # Examples /// ``` /// # use syrette::ptr::TransientPtr; /// # use syrette::injectable; /// # /// # trait INinja {} /// # trait IWeapon {} /// # /// # struct Ninja /// # { /// # strong_weapon: TransientPtr, /// # weak_weapon: TransientPtr, /// # } /// # /// #[injectable(INinja)] /// impl Ninja /// { /// pub fn new( /// #[syrette::named("strong")] strong_weapon: TransientPtr, /// #[syrette::named("weak")] weak_weapon: TransientPtr, /// ) -> Self /// { /// Self { /// strong_weapon, /// weak_weapon, /// } /// } /// } /// # /// # impl INinja for Ninja {} /// ``` #[proc_macro_attribute] pub fn named(_: TokenStream, _: TokenStream) -> TokenStream { TokenStream::new() }