commit 1a2f4639199d494561c60f394543cfc08b663377 Author: David Tolnay Date: Fri Sep 2 22:35:18 2016 -0700 quote! diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..4fffb2f --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +/target +/Cargo.lock diff --git a/Cargo.toml b/Cargo.toml new file mode 100644 index 0000000..af690c1 --- /dev/null +++ b/Cargo.toml @@ -0,0 +1,6 @@ +[package] +name = "quote" +version = "0.1.0" +authors = ["David Tolnay "] + +[dependencies] diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..16fe87b --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,201 @@ + 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. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..40b8817 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,25 @@ +Copyright (c) 2016 The Rust Project Developers + +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..885c243 --- /dev/null +++ b/README.md @@ -0,0 +1,60 @@ +Dead Simple Rust Quasi-Quoting +============================== + +Quasi-quoting without a Syntex dependency, intended for use with [Macros +1.1](https://github.com/rust-lang/rfcs/blob/master/text/1681-macros-1.1.md). + +```toml +[dependencies] +quote = "0.1" +``` + +```rust +#[macro_use] +extern crate quote; +``` + +Interpolation is done with `#var`: + +```rust +let tokens = quote! { + struct SerializeWith #generics #where_clause { + value: &'a #field_ty, + phantom: ::std::marker::PhantomData<#item_ty>, + } + + impl #generics serde::Serialize for SerializeWith #generics #where_clause { + fn serialize(&self, s: &mut S) -> Result<(), S::Error> + where S: serde::Serializer + { + #path(self.value, s) + } + } + + SerializeWith { + value: #value, + phantom: ::std::marker::PhantomData::<#item_ty>, + } +}; +``` + +Repetition is done in one of three ways, similar to `macro_rules!` repetitions: + +- `#(var)*` - no separators +- `#(var),*` - the character before the asterisk is used as a separator +- `#(var;)*` - the character before the close paren is used as a terminator + +## License + +Licensed under either of + + * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0) + * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT) + +at your option. + +### Contribution + +Unless you explicitly state otherwise, any contribution intentionally submitted +for inclusion in this crate 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/src/lib.rs b/src/lib.rs new file mode 100644 index 0000000..5913cc4 --- /dev/null +++ b/src/lib.rs @@ -0,0 +1,85 @@ +mod tokens; +pub use tokens::Tokens; + +mod to_tokens; +pub use to_tokens::ToTokens; + +#[macro_export] +macro_rules! quote { + ($($tt:tt)+) => { + { + #[allow(unused_imports)] + use $crate::ToTokens; + let mut _s = $crate::Tokens::new(); + quote_each_token!(_s $($tt)*); + _s + } + }; +} + +#[macro_export] +#[doc(hidden)] +macro_rules! quote_each_token { + ($tokens:ident) => {}; + + ($tokens:ident # ! $($rest:tt)*) => { + $tokens.append("#!"); + quote_each_token!($tokens $($rest)*); + }; + + ($tokens:ident # ( $first:ident ) * $($rest:tt)*) => { + for _v in &$first { + _v.to_tokens(&mut $tokens); + } + quote_each_token!($tokens $($rest)*); + }; + + ($tokens:ident # ( $first:ident $sep:tt ) * $($rest:tt)*) => { + for _v in &$first { + _v.to_tokens(&mut $tokens); + $tokens.append(stringify!($sep)); + } + quote_each_token!($tokens $($rest)*); + }; + + ($tokens:ident # ( $first:ident ) $sep:tt * $($rest:tt)*) => { + for (_i, _v) in $first.iter().enumerate() { + if _i > 0 { + $tokens.append(stringify!($sep)); + } + _v.to_tokens(&mut $tokens); + } + quote_each_token!($tokens $($rest)*); + }; + + ($tokens:ident # $first:ident $($rest:tt)*) => { + $first.to_tokens(&mut $tokens); + quote_each_token!($tokens $($rest)*); + }; + + ($tokens:ident ( $($first:tt)* ) $($rest:tt)*) => { + $tokens.append("("); + quote_each_token!($tokens $($first)*); + $tokens.append(")"); + quote_each_token!($tokens $($rest)*); + }; + + ($tokens:ident [ $($first:tt)* ] $($rest:tt)*) => { + $tokens.append("["); + quote_each_token!($tokens $($first)*); + $tokens.append("]"); + quote_each_token!($tokens $($rest)*); + }; + + ($tokens:ident { $($first:tt)* } $($rest:tt)*) => { + $tokens.append("{"); + quote_each_token!($tokens $($first)*); + $tokens.append("}"); + quote_each_token!($tokens $($rest)*); + }; + + ($tokens:ident $first:tt $($rest:tt)*) => { + $tokens.append(stringify!($first)); + quote_each_token!($tokens $($rest)*); + }; +} diff --git a/src/to_tokens.rs b/src/to_tokens.rs new file mode 100644 index 0000000..37085d1 --- /dev/null +++ b/src/to_tokens.rs @@ -0,0 +1,50 @@ +use super::Tokens; + +pub trait ToTokens { + fn to_tokens(&self, &mut Tokens); +} + +impl<'a, T: ToTokens> ToTokens for &'a T { + fn to_tokens(&self, tokens: &mut Tokens) { + (**self).to_tokens(tokens); + } +} + +impl ToTokens for Option { + fn to_tokens(&self, tokens: &mut Tokens) { + if let Some(ref t) = *self { + t.to_tokens(tokens); + } + } +} + +impl ToTokens for str { + fn to_tokens(&self, tokens: &mut Tokens) { + tokens.append(&format!("{:?}", self)); + } +} + +macro_rules! impl_to_tokens_display { + ($ty:ty) => { + impl ToTokens for $ty { + fn to_tokens(&self, tokens: &mut Tokens) { + tokens.append(&self.to_string()); + } + } + }; +} + +impl_to_tokens_display!(Tokens); +impl_to_tokens_display!(bool); +impl_to_tokens_display!(i8); +impl_to_tokens_display!(i16); +impl_to_tokens_display!(i32); +impl_to_tokens_display!(i64); +impl_to_tokens_display!(isize); +impl_to_tokens_display!(u8); +impl_to_tokens_display!(u16); +impl_to_tokens_display!(u32); +impl_to_tokens_display!(u64); +impl_to_tokens_display!(usize); +impl_to_tokens_display!(f32); +impl_to_tokens_display!(f64); diff --git a/src/tokens.rs b/src/tokens.rs new file mode 100644 index 0000000..1f972f6 --- /dev/null +++ b/src/tokens.rs @@ -0,0 +1,27 @@ +use std::fmt::{self, Display}; + +#[derive(Debug)] +pub struct Tokens(String); + +impl Tokens { + pub fn new() -> Self { + Tokens(String::new()) + } + + pub fn append(&mut self, token: &str) { + self.0.push_str(token); + self.0.push(' '); + } +} + +impl Default for Tokens { + fn default() -> Self { + Tokens::new() + } +} + +impl Display for Tokens { + fn fmt(&self, formatter: &mut fmt::Formatter) -> Result<(), fmt::Error> { + self.0.fmt(formatter) + } +} diff --git a/tests/test.rs b/tests/test.rs new file mode 100644 index 0000000..d70d290 --- /dev/null +++ b/tests/test.rs @@ -0,0 +1,99 @@ +#[macro_use] +extern crate quote; + +#[test] +fn test_quote_impl() { + let tokens = quote!( + impl<'a, T: ToTokens> ToTokens for &'a T { + fn to_tokens(&self, tokens: &mut Tokens) { + (**self).to_tokens(tokens) + } + } + ); + + let expected = concat!( + "impl < 'a , T : ToTokens > ToTokens for & 'a T { ", + "fn to_tokens ( & self , tokens : & mut Tokens ) { ", + "( * * self ) . to_tokens ( tokens ) ", + "} ", + "} " + ); + + assert_eq!(expected, tokens.to_string()); +} + +#[test] +fn test_substitution() { + let n = 1; + let tokens = quote!(#n <#n> (#n) [#n] {#n}); + + let expected = "1 < 1 > ( 1 ) [ 1 ] { 1 } "; + + assert_eq!(expected, tokens.to_string()); +} + +#[test] +fn test_iter() { + let primes = vec![2, 3, 5, 7]; + + assert_eq!("2 3 5 7 ", quote!(#(primes)*).to_string()); + + assert_eq!("2 , 3 , 5 , 7 , ", quote!(#(primes,)*).to_string()); + + assert_eq!("2 , 3 , 5 , 7 ", quote!(#(primes),*).to_string()); +} + +#[test] +fn test_advanced() { + let generics = quote!( <'a, T> ); + + let where_clause = quote!( where T: Serialize ); + + let field_ty = quote!( String ); + + let item_ty = quote!( Cow<'a, str> ); + + let path = quote!( SomeTrait::serialize_with ); + + let value = quote!( self.x ); + + let tokens = quote! { + struct SerializeWith #generics #where_clause { + value: &'a #field_ty, + phantom: ::std::marker::PhantomData<#item_ty>, + } + + impl #generics ::serde::Serialize for SerializeWith #generics #where_clause { + fn serialize(&self, s: &mut S) -> Result<(), S::Error> + where S: ::serde::Serializer + { + #path(self.value, s) + } + } + + SerializeWith { + value: #value, + phantom: ::std::marker::PhantomData::<#item_ty>, + } + }; + + let expected = concat!( + "struct SerializeWith < 'a , T > where T : Serialize { ", + "value : & 'a String , ", + "phantom : :: std :: marker :: PhantomData < Cow < 'a , str > > , ", + "} ", + "impl < 'a , T > :: serde :: Serialize for SerializeWith < 'a , T > where T : Serialize { ", + "fn serialize < S > ( & self , s : & mut S ) -> Result < ( ) , S :: Error > ", + "where S : :: serde :: Serializer ", + "{ ", + "SomeTrait :: serialize_with ( self . value , s ) ", + "} ", + "} ", + "SerializeWith { ", + "value : self . x , ", + "phantom : :: std :: marker :: PhantomData :: < Cow < 'a , str > > , ", + "} " + ); + + assert_eq!(expected, tokens.to_string()); +}