From 9f27a925bd323e8e0864bedeb33a3c6953517ea1 Mon Sep 17 00:00:00 2001 From: HampusM Date: Sat, 19 Nov 2022 15:45:12 +0100 Subject: refactor: reorganize non-public API items --- macros/src/caster.rs | 150 +++++++++++++++++++ macros/src/factory/build_declare_interfaces.rs | 16 +-- macros/src/lib.rs | 4 +- macros/src/libs/intertrait_macros/LICENSE-APACHE | 176 ----------------------- macros/src/libs/intertrait_macros/LICENSE-MIT | 17 --- macros/src/libs/intertrait_macros/gen_caster.rs | 150 ------------------- macros/src/libs/intertrait_macros/mod.rs | 14 -- macros/src/libs/mod.rs | 1 - 8 files changed, 160 insertions(+), 368 deletions(-) create mode 100644 macros/src/caster.rs delete mode 100644 macros/src/libs/intertrait_macros/LICENSE-APACHE delete mode 100644 macros/src/libs/intertrait_macros/LICENSE-MIT delete mode 100644 macros/src/libs/intertrait_macros/gen_caster.rs delete mode 100644 macros/src/libs/intertrait_macros/mod.rs delete mode 100644 macros/src/libs/mod.rs (limited to 'macros/src') diff --git a/macros/src/caster.rs b/macros/src/caster.rs new file mode 100644 index 0000000..b84bd4d --- /dev/null +++ b/macros/src/caster.rs @@ -0,0 +1,150 @@ +/** + * Originally from Intertrait by CodeChain + * + * + * + * + * Licensed under either of + * + * Apache License, Version 2.0 (LICENSE-APACHE or ) + * MIT license (LICENSE-MIT or ) + + * at your option. +*/ +use std::str::from_utf8; + +use proc_macro2::{Ident, TokenStream}; +use quote::{format_ident, quote, ToTokens}; +use uuid::adapter::Simple; +use uuid::Uuid; + +const CASTER_FN_NAME_PREFIX: &[u8] = b"__"; + +const FN_BUF_LEN: usize = CASTER_FN_NAME_PREFIX.len() + Simple::LENGTH; + +pub fn generate_caster( + ty: &impl ToTokens, + dst_trait: &impl ToTokens, + sync: bool, +) -> TokenStream +{ + let fn_ident = create_caster_fn_ident(Uuid::new_v4()); + + let new_caster = if sync { + quote! { + syrette::private::cast::Caster::<#dst_trait>::new_sync( + |from| { + let concrete = from + .downcast::<#ty>() + .map_err(|_| syrette::private::cast::CasterError::CastBoxFailed)?; + + Ok(concrete as Box<#dst_trait>) + }, + |from| { + let concrete = from + .downcast::<#ty>() + .map_err(|_| syrette::private::cast::CasterError::CastRcFailed)?; + + Ok(concrete as std::rc::Rc<#dst_trait>) + }, + |from| { + let concrete = from + .downcast::<#ty>() + .map_err(|_| syrette::private::cast::CasterError::CastArcFailed)?; + + Ok(concrete as std::sync::Arc<#dst_trait>) + }, + ) + } + } else { + quote! { + syrette::private::cast::Caster::<#dst_trait>::new( + |from| { + let concrete = from + .downcast::<#ty>() + .map_err(|_| syrette::private::cast::CasterError::CastBoxFailed)?; + + Ok(concrete as Box<#dst_trait>) + }, + |from| { + let concrete = from + .downcast::<#ty>() + .map_err(|_| syrette::private::cast::CasterError::CastRcFailed)?; + + Ok(concrete as std::rc::Rc<#dst_trait>) + }, + ) + } + }; + + quote! { + #[syrette::private::linkme::distributed_slice(syrette::private::cast::CASTERS)] + #[linkme(crate = syrette::private::linkme)] + fn #fn_ident() -> (::std::any::TypeId, syrette::private::cast::BoxedCaster) { + (::std::any::TypeId::of::<#ty>(), Box::new(#new_caster)) + } + } +} + +fn create_caster_fn_ident(uuid: impl IUuid) -> Ident +{ + let buf = &mut [0u8; FN_BUF_LEN]; + + buf[..CASTER_FN_NAME_PREFIX.len()].copy_from_slice(CASTER_FN_NAME_PREFIX); + + uuid.encode_simple_lower_into(&mut buf[CASTER_FN_NAME_PREFIX.len()..]); + + let fn_name = + from_utf8(&buf[..FN_BUF_LEN]).expect("Created caster function name is not UTF-8"); + + format_ident!("{}", fn_name) +} + +/// Simple interface for `Uuid`. +/// +/// Created for ease of testing the [`create_caster_fn_ident`] function. +/// +/// [`Uuid`]: uuid::Uuid +#[cfg_attr(test, mockall::automock)] +trait IUuid +{ + /// Writes the Uuid as a simple lower-case string to `buf`. + fn encode_simple_lower_into(self, buf: &mut [u8]); +} + +impl IUuid for Uuid +{ + fn encode_simple_lower_into(self, buf: &mut [u8]) + { + self.to_simple().encode_lower(buf); + } +} + +#[cfg(test)] +mod tests +{ + use pretty_assertions::assert_eq; + use utility_macros::repeat_char; + + use super::*; + + #[test] + fn can_create_caster_fn_ident() + { + let mut uuid_mock = MockIUuid::new(); + + uuid_mock + .expect_encode_simple_lower_into() + .return_once(|buf| { + for index in 0..(FN_BUF_LEN - 2) { + buf[index] = b'f'; + } + }) + .once(); + + assert_eq!( + create_caster_fn_ident(uuid_mock), + format_ident!(concat!("__", repeat_char!('f', 32))) + ); + } +} diff --git a/macros/src/factory/build_declare_interfaces.rs b/macros/src/factory/build_declare_interfaces.rs index 6ab135e..038d29d 100644 --- a/macros/src/factory/build_declare_interfaces.rs +++ b/macros/src/factory/build_declare_interfaces.rs @@ -11,10 +11,10 @@ pub fn build_declare_factory_interfaces( if is_threadsafe { quote! { syrette::declare_interface!( - syrette::castable_factory::threadsafe::ThreadsafeCastableFactory< + syrette::private::castable_factory::threadsafe::ThreadsafeCastableFactory< (std::sync::Arc,), #factory_interface - > -> syrette::interfaces::factory::IThreadsafeFactory< + > -> syrette::private::factory::IThreadsafeFactory< (std::sync::Arc,), #factory_interface >, @@ -22,30 +22,30 @@ pub fn build_declare_factory_interfaces( ); syrette::declare_interface!( - syrette::castable_factory::threadsafe::ThreadsafeCastableFactory< + syrette::private::castable_factory::threadsafe::ThreadsafeCastableFactory< (std::sync::Arc,), #factory_interface - > -> syrette::interfaces::any_factory::AnyThreadsafeFactory, + > -> syrette::private::any_factory::AnyThreadsafeFactory, async = true ); } } else { quote! { syrette::declare_interface!( - syrette::castable_factory::blocking::CastableFactory< + syrette::private::castable_factory::blocking::CastableFactory< (std::rc::Rc,), #factory_interface - > -> syrette::interfaces::factory::IFactory< + > -> syrette::private::factory::IFactory< (std::rc::Rc,), #factory_interface > ); syrette::declare_interface!( - syrette::castable_factory::blocking::CastableFactory< + syrette::private::castable_factory::blocking::CastableFactory< (std::rc::Rc,), #factory_interface - > -> syrette::interfaces::any_factory::AnyFactory + > -> syrette::private::any_factory::AnyFactory ); } } diff --git a/macros/src/lib.rs b/macros/src/lib.rs index ccd38e1..ac0309e 100644 --- a/macros/src/lib.rs +++ b/macros/src/lib.rs @@ -20,9 +20,9 @@ use syn::{ TypeTraitObject, }; +mod caster; mod declare_interface_args; mod injectable; -mod libs; mod macro_flag; mod util; @@ -37,11 +37,11 @@ mod fn_trait; #[cfg(test)] mod test_utils; +use crate::caster::generate_caster; use crate::declare_interface_args::DeclareInterfaceArgs; use crate::injectable::dependency::Dependency; use crate::injectable::implementation::InjectableImpl; use crate::injectable::macro_args::InjectableMacroArgs; -use crate::libs::intertrait_macros::gen_caster::generate_caster; /// Makes a struct injectable. Thereby usable with [`DIContainer`] or /// [`AsyncDIContainer`]. diff --git a/macros/src/libs/intertrait_macros/LICENSE-APACHE b/macros/src/libs/intertrait_macros/LICENSE-APACHE deleted file mode 100644 index d9a10c0..0000000 --- a/macros/src/libs/intertrait_macros/LICENSE-APACHE +++ /dev/null @@ -1,176 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS diff --git a/macros/src/libs/intertrait_macros/LICENSE-MIT b/macros/src/libs/intertrait_macros/LICENSE-MIT deleted file mode 100644 index 969d061..0000000 --- a/macros/src/libs/intertrait_macros/LICENSE-MIT +++ /dev/null @@ -1,17 +0,0 @@ -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/macros/src/libs/intertrait_macros/gen_caster.rs b/macros/src/libs/intertrait_macros/gen_caster.rs deleted file mode 100644 index 06f5aad..0000000 --- a/macros/src/libs/intertrait_macros/gen_caster.rs +++ /dev/null @@ -1,150 +0,0 @@ -/** - * Originally from Intertrait by CodeChain - * - * - * - * - * Licensed under either of - * - * Apache License, Version 2.0 (LICENSE-APACHE or ) - * MIT license (LICENSE-MIT or ) - - * at your option. -*/ -use std::str::from_utf8; - -use proc_macro2::{Ident, TokenStream}; -use quote::{format_ident, quote, ToTokens}; -use uuid::adapter::Simple; -use uuid::Uuid; - -const CASTER_FN_NAME_PREFIX: &[u8] = b"__"; - -const FN_BUF_LEN: usize = CASTER_FN_NAME_PREFIX.len() + Simple::LENGTH; - -pub fn generate_caster( - ty: &impl ToTokens, - dst_trait: &impl ToTokens, - sync: bool, -) -> TokenStream -{ - let fn_ident = create_caster_fn_ident(Uuid::new_v4()); - - let new_caster = if sync { - quote! { - syrette::libs::intertrait::Caster::<#dst_trait>::new_sync( - |from| { - let concrete = from - .downcast::<#ty>() - .map_err(|_| syrette::libs::intertrait::CasterError::CastBoxFailed)?; - - Ok(concrete as Box<#dst_trait>) - }, - |from| { - let concrete = from - .downcast::<#ty>() - .map_err(|_| syrette::libs::intertrait::CasterError::CastRcFailed)?; - - Ok(concrete as std::rc::Rc<#dst_trait>) - }, - |from| { - let concrete = from - .downcast::<#ty>() - .map_err(|_| syrette::libs::intertrait::CasterError::CastArcFailed)?; - - Ok(concrete as std::sync::Arc<#dst_trait>) - }, - ) - } - } else { - quote! { - syrette::libs::intertrait::Caster::<#dst_trait>::new( - |from| { - let concrete = from - .downcast::<#ty>() - .map_err(|_| syrette::libs::intertrait::CasterError::CastBoxFailed)?; - - Ok(concrete as Box<#dst_trait>) - }, - |from| { - let concrete = from - .downcast::<#ty>() - .map_err(|_| syrette::libs::intertrait::CasterError::CastRcFailed)?; - - Ok(concrete as std::rc::Rc<#dst_trait>) - }, - ) - } - }; - - quote! { - #[syrette::libs::linkme::distributed_slice(syrette::libs::intertrait::CASTERS)] - #[linkme(crate = syrette::libs::linkme)] - fn #fn_ident() -> (::std::any::TypeId, syrette::libs::intertrait::BoxedCaster) { - (::std::any::TypeId::of::<#ty>(), Box::new(#new_caster)) - } - } -} - -fn create_caster_fn_ident(uuid: impl IUuid) -> Ident -{ - let buf = &mut [0u8; FN_BUF_LEN]; - - buf[..CASTER_FN_NAME_PREFIX.len()].copy_from_slice(CASTER_FN_NAME_PREFIX); - - uuid.encode_simple_lower_into(&mut buf[CASTER_FN_NAME_PREFIX.len()..]); - - let fn_name = - from_utf8(&buf[..FN_BUF_LEN]).expect("Created caster function name is not UTF-8"); - - format_ident!("{}", fn_name) -} - -/// Simple interface for `Uuid`. -/// -/// Created for ease of testing the [`create_caster_fn_ident`] function. -/// -/// [`Uuid`]: uuid::Uuid -#[cfg_attr(test, mockall::automock)] -trait IUuid -{ - /// Writes the Uuid as a simple lower-case string to `buf`. - fn encode_simple_lower_into(self, buf: &mut [u8]); -} - -impl IUuid for Uuid -{ - fn encode_simple_lower_into(self, buf: &mut [u8]) - { - self.to_simple().encode_lower(buf); - } -} - -#[cfg(test)] -mod tests -{ - use pretty_assertions::assert_eq; - use utility_macros::repeat_char; - - use super::*; - - #[test] - fn can_create_caster_fn_ident() - { - let mut uuid_mock = MockIUuid::new(); - - uuid_mock - .expect_encode_simple_lower_into() - .return_once(|buf| { - for index in 0..(FN_BUF_LEN - 2) { - buf[index] = b'f'; - } - }) - .once(); - - assert_eq!( - create_caster_fn_ident(uuid_mock), - format_ident!(concat!("__", repeat_char!('f', 32))) - ); - } -} diff --git a/macros/src/libs/intertrait_macros/mod.rs b/macros/src/libs/intertrait_macros/mod.rs deleted file mode 100644 index fa8c021..0000000 --- a/macros/src/libs/intertrait_macros/mod.rs +++ /dev/null @@ -1,14 +0,0 @@ -/** - * Originally from Intertrait by CodeChain - * - * - * - * - * Licensed under either of - * - * Apache License, Version 2.0 (LICENSE-APACHE or ) - * MIT license (LICENSE-MIT or ) - - * at your option. -*/ -pub mod gen_caster; diff --git a/macros/src/libs/mod.rs b/macros/src/libs/mod.rs deleted file mode 100644 index e4964de..0000000 --- a/macros/src/libs/mod.rs +++ /dev/null @@ -1 +0,0 @@ -pub mod intertrait_macros; -- cgit v1.2.3-18-g5258