diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..ea8c4bf --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/target diff --git a/Cargo.lock b/Cargo.lock new file mode 100644 index 0000000..bf627b0 --- /dev/null +++ b/Cargo.lock @@ -0,0 +1,54 @@ +# This file is automatically @generated by Cargo. +# It is not intended for manual editing. +version = 3 + +[[package]] +name = "proc-macro2" +version = "1.0.86" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5e719e8df665df0d1c8fbfd238015744736151d4445ec0836b8e628aae103b77" +dependencies = [ + "unicode-ident", +] + +[[package]] +name = "quote" +version = "1.0.36" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0fa76aaf39101c457836aec0ce2316dbdc3ab723cdda1c6bd4e6ad4208acaca7" +dependencies = [ + "proc-macro2", +] + +[[package]] +name = "relax" +version = "0.1.0-alpha.1" +dependencies = [ + "relax-macros", +] + +[[package]] +name = "relax-macros" +version = "0.1.0-alpha.1" +dependencies = [ + "proc-macro2", + "quote", + "syn", +] + +[[package]] +name = "syn" +version = "2.0.71" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b146dcf730474b4bcd16c311627b31ede9ab149045db4d6088b3becaea046462" +dependencies = [ + "proc-macro2", + "quote", + "unicode-ident", +] + +[[package]] +name = "unicode-ident" +version = "1.0.12" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b" diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..fc0c181 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,17 @@ +[workspace] +members = ["crates/relax", "crates/relax-macros"] +resolver = "2" + +[workspace.package] +edition = "2021" +rust-version = "1.74.0" + +[workspace.dependencies] +relax-macros = { path = "crates/relax-macros" } + +syn = { version = "2.0.70", features = ["full"] } +quote = "1.0.36" +proc-macro2 = "1.0.86" + +[profile.release] +lto = true diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..c98d27d --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + https://www.apache.org/licenses/LICENSE-2.0 + +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 + +APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + +Copyright [yyyy] [name of copyright owner] + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..b8aef6d --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2024 Firefish contributors + +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/README.md b/README.md new file mode 100644 index 0000000..053930a --- /dev/null +++ b/README.md @@ -0,0 +1,14 @@ +## License + +Licensed under either of + + * MIT license + ([LICENSE-MIT](./LICENSE-MIT) or https://opensource.org/licenses/MIT) + * Apache License, Version 2.0 + ([LICENSE-APACHE](./LICENSE-APACHE) or https://www.apache.org/licenses/LICENSE-2.0) + +at your option. + +### Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions. diff --git a/crates/relax-macros/Cargo.toml b/crates/relax-macros/Cargo.toml new file mode 100644 index 0000000..f32c7e6 --- /dev/null +++ b/crates/relax-macros/Cargo.toml @@ -0,0 +1,15 @@ +[package] +name = "relax-macros" +version = "0.1.0-alpha.1" +license = "MIT OR Apache-2.0" + +edition = { workspace = true } +rust-version = { workspace = true } + +[lib] +proc-macro = true + +[dependencies] +syn = { workspace = true, features = ["full"] } +quote = { workspace = true } +proc-macro2 = { workspace = true } diff --git a/crates/relax-macros/src/lib.rs b/crates/relax-macros/src/lib.rs new file mode 100644 index 0000000..cab40ff --- /dev/null +++ b/crates/relax-macros/src/lib.rs @@ -0,0 +1,278 @@ +use proc_macro2::{TokenStream, TokenTree}; +use quote::{quote, ToTokens}; +use syn::{parse_macro_input, spanned::Spanned}; + +#[proc_macro_derive(Relax, attributes(relax))] +pub fn derive(input: proc_macro::TokenStream) -> proc_macro::TokenStream { + derive_impl(parse_macro_input!(input)).unwrap().into() +} + +fn derive_impl(input: syn::DeriveInput) -> syn::Result { + let orig_attrs: Vec = input.attrs.clone().into_iter().collect(); + let relax_attrs: Vec<&syn::Attribute> = orig_attrs + .iter() + .filter(|attr| { + if let syn::Attribute { + meta: + syn::Meta::List(syn::MetaList { + path: syn::Path { segments, .. }, + .. + }), + .. + } = attr + { + if segments.len() != 1 { + return false; + } + matches!(&segments[0], syn::PathSegment { ident, .. } if ident == "relax") + } else { + false + } + }) + .collect(); + + if relax_attrs.is_empty() { + return Err(syn::Error::new_spanned( + input, + "expected #[relax(StructName)] attrubute", + )); + } + if relax_attrs.len() > 1 { + return Err(syn::Error::new_spanned( + input, + "expected only one #[relax(StructName)] attrubute on top of the struct", + )); + } + let relax_attr = relax_attrs[0]; + + let mut relax_attr_tokens = match relax_attr { + syn::Attribute { + meta: syn::Meta::List(syn::MetaList { tokens, .. }), + .. + } => tokens.clone().into_iter(), + _ => { + return Err(syn::Error::new_spanned( + relax_attr, + "unexpected #[relax(...)] attribute format", + )) + } + }; + + let first_attr: TokenStream = relax_attr_tokens + .next() + .map(|tt| syn::parse2(tt.into_token_stream())) + .transpose() + .ok() + .flatten() + .ok_or(syn::Error::new_spanned( + relax_attr, + "struct name is expected", + ))?; + + let first_attr_path: syn::Path = syn::parse2(first_attr.clone())?; + + let partial: syn::Ident = match first_attr_path { + syn::Path { segments, .. } if segments.len() == 1 => segments[0].ident.to_owned(), + _ => { + return Err(syn::Error::new_spanned( + first_attr, + "struct name is expected", + )) + } + }; + let partial = syn::Ident::new(&partial.to_string(), first_attr.span()); + + // consume comma + relax_attr_tokens.next(); + + let mut extra_attrs = Vec::new(); + + while let Some(token) = relax_attr_tokens.next() { + // extra attributes are + // * ident + punct + // * ident + group + punct + // * ident (the last one) + + let ident: syn::Ident = syn::parse2(token.into_token_stream())?; + + // we may have ran out of tokens at this point + let second_item = relax_attr_tokens.next(); + if second_item.is_none() { + extra_attrs.push(quote! { #[#ident] }); + break; + } + + // the second item must be punct or group + let group = match second_item.to_owned().unwrap() { + TokenTree::Punct(_) => { + extra_attrs.push(quote! { #[#ident] }); + continue; + } + TokenTree::Group(group) => group, + _ => { + return Err(syn::Error::new_spanned( + second_item, + "expected a comma or parenthesis", + )) + } + }; + + extra_attrs.push(quote! { #[#ident #group] }); + } + + let fields = match &input.data { + syn::Data::Struct(syn::DataStruct { fields, .. }) => fields, + _ => return Err(syn::Error::new_spanned(input, "expected a struct")), + }; + + let vis = &input.vis; + let generics = &input.generics; + + let partial_fields = fields + .iter() + .map(|field: &syn::Field| { + let name = field.ident.as_ref(); + let vis = &field.vis; + let ty = &field.ty; + + let relax_attr = field + .attrs + .iter() + .find(|attr| attr.path().is_ident("relax")); + + if relax_attr.is_none() { + // not nested + match get_generic_ty("Option", ty) { + Some(ty) => Ok(quote! { #vis #name: ::std::option::Option<#ty> }), + None => Ok(quote! { #vis #name: ::std::option::Option<#ty> }), + } + } else { + // nested + let ty = get_ty_name_from_helper_attr(relax_attr.unwrap())?; + Ok(quote! { #vis #name: ::std::option::Option<#ty> }) + } + }) + .collect::>>()?; + + let base = &input.ident; + + let from_fields = fields.iter().map(|field| { + let name = field.ident.as_ref(); + let ty = &field.ty; + + match get_generic_ty("Option", ty) { + Some(_) => quote! { #name: value.#name.map(|v| v.into()) }, + None => quote! { #name: ::std::option::Option::Some(value.#name.into()) }, + } + }); + + let try_from_fields = fields.iter().map(|field| -> syn::Result { + let name = field.ident.as_ref(); + let ty = &field.ty; + let relaxed_ty = field + .attrs + .iter() + .find(|attr| attr.path().is_ident("relax")) + .map(get_ty_name_from_helper_attr) + .transpose()?; + + Ok(match (relaxed_ty, get_generic_ty("Option", ty)) { + (None, None) => quote! { #name: value.#name.ok_or(::relax::RequiredFieldNotSet(stringify!(#name)))? }, + (None, Some(_)) => quote! { #name: value.#name }, + (Some(_), None) => quote! { #name: value.#name.ok_or(::relax::RequiredFieldNotSet(stringify!(#name)))?.try_into()? }, + (Some(_), Some(_)) => quote! { #name: value.#name.map(|val| val.try_into()).transpose().ok().flatten() }, + }) + }).collect::>>()?; + + let merge_fields = fields.iter().map(|field| { + let name = field.ident.as_ref(); + quote! { #name: self.#name.or(optb.#name) } + }); + + Ok(quote! { + #(#extra_attrs)* + #vis struct #partial #generics { + #(#partial_fields),* + } + + impl #generics ::std::convert::From<#base #generics> for #partial #generics { + fn from(value: #base) -> Self { + Self { + #(#from_fields),* + } + } + } + + impl #generics ::std::convert::TryFrom<#partial #generics> for #base #generics { + type Error = ::relax::RequiredFieldNotSet; + + fn try_from(value: #partial) -> ::std::result::Result { + Ok(Self{ + #(#try_from_fields),* + }) + } + } + + impl #generics ::relax::Relaxed for #partial #generics { + type Complete = #base #generics; + + fn merge(self, optb: Self) -> Self { + Self { + #(#merge_fields),* + } + } + } + + impl #generics ::relax::Relax for #base #generics { + type Partial = #partial #generics; + } + }) +} + +fn get_generic_ty<'a>(wrapper: &str, ty: &'a syn::Type) -> Option<&'a syn::Type> { + if let syn::Type::Path(path) = ty { + let last_segment = path.path.segments.iter().last().unwrap(); + + if last_segment.ident != wrapper { + return None; + } + + let generic_arg = match &last_segment.arguments { + syn::PathArguments::AngleBracketed(inner) if inner.args.len() == 1 => &inner.args[0], + _ => return None, + }; + + match generic_arg { + syn::GenericArgument::Type(ty) => Some(ty), + _ => None, + } + } else { + None + } +} + +fn get_ty_name_from_helper_attr(attr: &syn::Attribute) -> syn::Result { + let tokens = match attr { + syn::Attribute { + meta: syn::Meta::List(syn::MetaList { ref tokens, .. }), + .. + } => tokens, + _ => { + return Err(syn::Error::new_spanned( + attr, + "helper attribute should be #[relax(StructName)]", + )) + } + }; + + let tokens: Vec = tokens.clone().into_iter().collect(); + + if tokens.len() != 1 { + return Err(syn::Error::new_spanned( + attr, + "helper attribute should be #[relax(StructName)]", + )); + } + + Ok(tokens[0].to_owned()) +} diff --git a/crates/relax/Cargo.toml b/crates/relax/Cargo.toml new file mode 100644 index 0000000..1faadcc --- /dev/null +++ b/crates/relax/Cargo.toml @@ -0,0 +1,17 @@ +[package] +name = "relax" +version = "0.1.0-alpha.1" +license = "MIT OR Apache-2.0" + +edition = { workspace = true } +rust-version = { workspace = true } + +[features] +default = ["macros"] +macros = ["dep:relax-macros"] + +[lib] +crate-type = ["lib"] + +[dependencies] +relax-macros = { workspace = true, optional = true } diff --git a/crates/relax/src/lib.rs b/crates/relax/src/lib.rs new file mode 100644 index 0000000..ee00fc3 --- /dev/null +++ b/crates/relax/src/lib.rs @@ -0,0 +1,23 @@ +#[cfg(feature = "macros")] +pub use relax_macros::Relax; + +use std::convert::{From, TryFrom}; + +pub trait Relax: TryFrom { + type Partial; +} + +pub trait Relaxed: From { + type Complete; + fn merge(self, optb: Self) -> Self; +} + +#[derive(Debug)] +pub struct RequiredFieldNotSet(pub &'static str); + +impl std::fmt::Display for RequiredFieldNotSet { + fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result { + write!(f, "required field `{}` is not set", self.0) + } +} +impl std::error::Error for RequiredFieldNotSet {}