is-macro-0.3.6/.cargo_vcs_info.json0000644000000001550000000000100125550ustar { "git": { "sha1": "64cbcab86ae7b2717aea82eb125d7c433a53bc67" }, "path_in_vcs": "crates/is-macro" }is-macro-0.3.6/Cargo.toml0000644000000031330000000000100105520ustar # THIS FILE IS AUTOMATICALLY GENERATED BY CARGO # # When uploading crates to the registry Cargo will automatically # "normalize" Cargo.toml files for maximal compatibility # with all versions of Cargo and also rewrite `path` dependencies # to registry (e.g., crates.io) dependencies. # # If you are reading this file be aware that the original Cargo.toml # will likely look very different (and much more reasonable). # See Cargo.toml.orig for the original contents. [package] edition = "2018" name = "is-macro" version = "0.3.6" authors = ["강동윤 "] build = false autobins = false autoexamples = false autotests = false autobenches = false description = "Derive methods for using custom enums like Option / Result" documentation = "https://docs.rs/is-macro" readme = "README.md" license = "Apache-2.0" repository = "https://github.com/dudykr/ddbase.git" resolver = "2" [lib] name = "is_macro" path = "src/lib.rs" proc-macro = true [[test]] name = "arg_count" path = "tests/arg_count.rs" [[test]] name = "as_mut" path = "tests/as_mut.rs" [[test]] name = "generic" path = "tests/generic.rs" [[test]] name = "reference" path = "tests/reference.rs" [[test]] name = "rename" path = "tests/rename.rs" [[test]] name = "trailing_punct" path = "tests/trailing_punct.rs" [[test]] name = "usage" path = "tests/usage.rs" [dependencies.Inflector] version = "0.11.4" default-features = false [dependencies.proc-macro2] version = "1.0.70" [dependencies.quote] version = "1.0.33" [dependencies.syn] version = "2.0.39" features = [ "fold", "full", "derive", "extra-traits", "fold", ] is-macro-0.3.6/Cargo.toml.orig000064400000000000000000000011071046102023000142320ustar 00000000000000[package] authors = ["강동윤 "] description = "Derive methods for using custom enums like Option / Result" documentation = "https://docs.rs/is-macro" edition = "2018" license = { workspace = true } name = "is-macro" repository = { workspace = true } version = "0.3.6" [lib] proc-macro = true [dependencies] Inflector = { workspace = true } proc-macro2 = { workspace = true } quote = { workspace = true } syn = { workspace = true, features = [ "fold", "full", "derive", "extra-traits", "fold", ] } is-macro-0.3.6/LICENSE000064400000000000000000000261351046102023000123600ustar 00000000000000 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 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 http://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.is-macro-0.3.6/README.md000064400000000000000000000001541046102023000126230ustar 00000000000000# is-macro See the [documentation](https://docs.rs/is-macro) for more information. ## License Apache 2.0 is-macro-0.3.6/src/lib.rs000064400000000000000000000330201046102023000132450ustar 00000000000000extern crate proc_macro; use inflector::Inflector; use proc_macro2::Span; use quote::{quote, ToTokens}; use syn::{ parse, parse::Parse, parse2, parse_quote, punctuated::{Pair, Punctuated}, spanned::Spanned, Data, DataEnum, DeriveInput, Expr, ExprLit, Field, Fields, Generics, Ident, ImplItem, ItemImpl, Lit, Meta, MetaNameValue, Path, Token, Type, TypePath, TypeReference, TypeTuple, WhereClause, }; /// A proc macro to generate methods like is_variant / expect_variant. /// /// /// # Example /// /// ```rust /// /// use is_macro::Is; /// #[derive(Debug, Is)] /// pub enum Enum { /// A, /// B(T), /// C(Option), /// } /// /// // Rust's type inference cannot handle this. /// assert!(Enum::<()>::A.is_a()); /// /// assert_eq!(Enum::B(String::from("foo")).b(), Some(String::from("foo"))); /// /// assert_eq!(Enum::B(String::from("foo")).expect_b(), String::from("foo")); /// ``` /// /// # Renaming /// /// ```rust /// /// use is_macro::Is; /// #[derive(Debug, Is)] /// pub enum Enum { /// #[is(name = "video_mp4")] /// VideoMp4, /// } /// /// assert!(Enum::VideoMp4.is_video_mp4()); /// ``` #[proc_macro_derive(Is, attributes(is))] pub fn is(input: proc_macro::TokenStream) -> proc_macro::TokenStream { let input: DeriveInput = syn::parse(input).expect("failed to parse derive input"); let generics: Generics = input.generics.clone(); let items = match input.data { Data::Enum(e) => expand(e), _ => panic!("`Is` can be applied only on enums"), }; ItemImpl { attrs: vec![], defaultness: None, unsafety: None, impl_token: Default::default(), generics: Default::default(), trait_: None, self_ty: Box::new(Type::Path(TypePath { qself: None, path: Path::from(input.ident), })), brace_token: Default::default(), items, } .with_generics(generics) .into_token_stream() .into() } #[derive(Debug)] struct Input { name: String, } impl Parse for Input { fn parse(input: parse::ParseStream) -> syn::Result { let _: Ident = input.parse()?; let _: Token![=] = input.parse()?; let name = input.parse::()?; Ok(Input { name: match name.lit { Lit::Str(s) => s.value(), _ => panic!("is(name = ...) expects a string literal"), }, }) } } fn expand(input: DataEnum) -> Vec { let mut items = vec![]; for v in &input.variants { let attrs = v .attrs .iter() .filter(|attr| attr.path().is_ident("is")) .collect::>(); if attrs.len() >= 2 { panic!("derive(Is) expects no attribute or one attribute") } let i = match attrs.into_iter().next() { None => Input { name: { v.ident.to_string().to_snake_case() // }, }, Some(attr) => { // let mut input = Input { name: Default::default(), }; let mut apply = |v: &MetaNameValue| { assert!( v.path.is_ident("name"), "Currently, is() only supports `is(name = 'foo')`" ); input.name = match &v.value { Expr::Lit(ExprLit { lit: Lit::Str(s), .. }) => s.value(), _ => unimplemented!( "is(): name must be a string literal but {:?} is provided", v.value ), }; }; match &attr.meta { Meta::NameValue(v) => { // apply(v) } Meta::List(l) => { // Handle is(name = "foo") input = parse2(l.tokens.clone()).expect("failed to parse input"); } _ => unimplemented!("is({:?})", attr.meta), } input } }; let name = &*i.name; { let name_of_is = Ident::new(&format!("is_{name}"), v.ident.span()); let docs_of_is = format!( "Returns `true` if `self` is of variant [`{variant}`].\n\n[`{variant}`]: \ #variant.{variant}", variant = v.ident, ); let variant = &v.ident; let item_impl: ItemImpl = parse_quote!( impl Type { #[doc = #docs_of_is] #[inline] pub const fn #name_of_is(&self) -> bool { match *self { Self::#variant { .. } => true, _ => false, } } } ); items.extend(item_impl.items); } { let name_of_cast = Ident::new(&format!("as_{name}"), v.ident.span()); let name_of_cast_mut = Ident::new(&format!("as_mut_{name}"), v.ident.span()); let name_of_expect = Ident::new(&format!("expect_{name}"), v.ident.span()); let name_of_take = Ident::new(name, v.ident.span()); let docs_of_cast = format!( "Returns `Some` if `self` is a reference of variant [`{variant}`], and `None` \ otherwise.\n\n[`{variant}`]: #variant.{variant}", variant = v.ident, ); let docs_of_cast_mut = format!( "Returns `Some` if `self` is a mutable reference of variant [`{variant}`], and \ `None` otherwise.\n\n[`{variant}`]: #variant.{variant}", variant = v.ident, ); let docs_of_expect = format!( "Unwraps the value, yielding the content of [`{variant}`].\n\n# Panics\n\nPanics \ if the value is not [`{variant}`], with a panic message including the content of \ `self`.\n\n[`{variant}`]: #variant.{variant}", variant = v.ident, ); let docs_of_take = format!( "Returns `Some` if `self` is of variant [`{variant}`], and `None` \ otherwise.\n\n[`{variant}`]: #variant.{variant}", variant = v.ident, ); if let Fields::Unnamed(fields) = &v.fields { let types = fields.unnamed.iter().map(|f| f.ty.clone()); let cast_ty = types_to_type(types.clone().map(|ty| add_ref(false, ty))); let cast_ty_mut = types_to_type(types.clone().map(|ty| add_ref(true, ty))); let ty = types_to_type(types); let mut fields: Punctuated = fields .unnamed .clone() .into_pairs() .enumerate() .map(|(i, pair)| { let handle = |f: Field| { // Ident::new(&format!("v{i}"), f.span()) }; match pair { Pair::Punctuated(v, p) => Pair::Punctuated(handle(v), p), Pair::End(v) => Pair::End(handle(v)), } }) .collect(); // Make sure that we don't have any trailing punctuation // This ensure that if we have a single unnamed field, // we will produce a value of the form `(v)`, // not a single-element tuple `(v,)` if let Some(mut pair) = fields.pop() { if let Pair::Punctuated(v, _) = pair { pair = Pair::End(v); } fields.extend(std::iter::once(pair)); } let variant = &v.ident; let item_impl: ItemImpl = parse_quote!( impl #ty { #[doc = #docs_of_cast] #[inline] pub fn #name_of_cast(&self) -> Option<#cast_ty> { match self { Self::#variant(#fields) => Some((#fields)), _ => None, } } #[doc = #docs_of_cast_mut] #[inline] pub fn #name_of_cast_mut(&mut self) -> Option<#cast_ty_mut> { match self { Self::#variant(#fields) => Some((#fields)), _ => None, } } #[doc = #docs_of_expect] #[inline] pub fn #name_of_expect(self) -> #ty where Self: ::std::fmt::Debug, { match self { Self::#variant(#fields) => (#fields), _ => panic!("called expect on {:?}", self), } } #[doc = #docs_of_take] #[inline] pub fn #name_of_take(self) -> Option<#ty> { match self { Self::#variant(#fields) => Some((#fields)), _ => None, } } } ); items.extend(item_impl.items); } } } items } fn types_to_type(types: impl Iterator) -> Type { let mut types: Punctuated<_, _> = types.collect(); if types.len() == 1 { types.pop().expect("len is 1").into_value() } else { TypeTuple { paren_token: Default::default(), elems: types, } .into() } } fn add_ref(mutable: bool, ty: Type) -> Type { Type::Reference(TypeReference { and_token: Default::default(), lifetime: None, mutability: if mutable { Some(Default::default()) } else { None }, elem: Box::new(ty), }) } /// Extension trait for `ItemImpl` (impl block). trait ItemImplExt { /// Instead of /// /// ```rust,ignore /// let (impl_generics, ty_generics, where_clause) = input.generics.split_for_impl(); /// /// let item: Item = Quote::new(def_site::()) /// .quote_with(smart_quote!( /// Vars { /// Type: type_name, /// impl_generics, /// ty_generics, /// where_clause, /// }, /// { /// impl impl_generics ::swc_common::AstNode for Type ty_generics /// where_clause {} /// } /// )).parse(); /// ``` /// /// You can use this like /// /// ```rust,ignore // let item = Quote::new(def_site::()) /// .quote_with(smart_quote!(Vars { Type: type_name }, { /// impl ::swc_common::AstNode for Type {} /// })) /// .parse::() /// .with_generics(input.generics); /// ``` fn with_generics(self, generics: Generics) -> Self; } impl ItemImplExt for ItemImpl { fn with_generics(mut self, mut generics: Generics) -> Self { // TODO: Check conflicting name let need_new_punct = !generics.params.empty_or_trailing(); if need_new_punct { generics .params .push_punct(syn::token::Comma(Span::call_site())); } // Respan if let Some(t) = generics.lt_token { self.generics.lt_token = Some(t) } if let Some(t) = generics.gt_token { self.generics.gt_token = Some(t) } let ty = self.self_ty; // Handle generics defined on struct, enum, or union. let mut item: ItemImpl = { let (impl_generics, ty_generics, where_clause) = generics.split_for_impl(); let item = if let Some((ref polarity, ref path, ref for_token)) = self.trait_ { quote! { impl #impl_generics #polarity #path #for_token #ty #ty_generics #where_clause {} } } else { quote! { impl #impl_generics #ty #ty_generics #where_clause {} } }; parse2(item.into_token_stream()) .unwrap_or_else(|err| panic!("with_generics failed: {}", err)) }; // Handle generics added by proc-macro. item.generics .params .extend(self.generics.params.into_pairs()); match self.generics.where_clause { Some(WhereClause { ref mut predicates, .. }) => predicates.extend( generics .where_clause .into_iter() .flat_map(|wc| wc.predicates.into_pairs()), ), ref mut opt @ None => *opt = generics.where_clause, } ItemImpl { attrs: self.attrs, defaultness: self.defaultness, unsafety: self.unsafety, impl_token: self.impl_token, brace_token: self.brace_token, items: self.items, ..item } } } is-macro-0.3.6/tests/arg_count.rs000064400000000000000000000002161046102023000150340ustar 00000000000000use is_macro::Is; #[derive(Debug, Is)] pub enum Enum { A(), B(usize, usize), C(String), D(&'static str, &'static mut u32), } is-macro-0.3.6/tests/as_mut.rs000064400000000000000000000004771046102023000143540ustar 00000000000000use is_macro::Is; #[derive(Debug, PartialEq, Is)] pub enum Enum { A(u32), B(Vec), } #[test] fn test() { let mut e = Enum::A(0); *e.as_mut_a().unwrap() += 1; assert_eq!(e, Enum::A(1)); let mut e = Enum::B(vec![]); e.as_mut_b().unwrap().push(1); assert_eq!(e, Enum::B(vec![1])); } is-macro-0.3.6/tests/generic.rs000064400000000000000000000001401046102023000144630ustar 00000000000000use is_macro::Is; #[derive(Debug, Is)] pub enum Enum { A, B(T), C(Option), } is-macro-0.3.6/tests/reference.rs000064400000000000000000000001571046102023000150150ustar 00000000000000use is_macro::Is; #[derive(Debug, Is)] pub enum Enum { A, B(&'static str), C(&'static mut u32), } is-macro-0.3.6/tests/rename.rs000064400000000000000000000002501046102023000143200ustar 00000000000000use is_macro::Is; #[derive(Debug, Is)] pub enum Enum { #[is(name = "video_mp4")] VideoMp4, } #[test] fn test() { assert!(Enum::VideoMp4.is_video_mp4()); } is-macro-0.3.6/tests/trailing_punct.rs000064400000000000000000000001101046102023000160660ustar 00000000000000use is_macro::Is; #[derive(Debug, Is)] pub enum Enum { B(usize), } is-macro-0.3.6/tests/usage.rs000064400000000000000000000001351046102023000141570ustar 00000000000000use is_macro::Is; #[derive(Debug, Is)] pub enum Enum { A, B(String), C(bool), }