-
Notifications
You must be signed in to change notification settings - Fork 5
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add quote integration as optional printing feature #13
base: main
Are you sure you want to change the base?
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
[package] | ||
name = "litrs" | ||
version = "0.4.0" | ||
version = "0.4.1" | ||
authors = ["Lukas Kalbertodt <[email protected]>"] | ||
edition = "2018" | ||
rust-version = "1.54" | ||
|
@@ -25,9 +25,11 @@ exclude = [".github"] | |
|
||
|
||
[features] | ||
default = ["proc-macro2"] | ||
default = ["proc-macro2", "printing"] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Don't make it a default feature. In fact, I consider removing |
||
check_suffix = ["unicode-xid"] | ||
printing = ["dep:quote"] | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Mh this feature requires Rust 1.60, but currently this is targetting 1.54. So if we want this, I would only release that with a major version bump. While I dislike implicit features and do think Also, independently: I guess this should also mention |
||
|
||
[dependencies] | ||
proc-macro2 = { version = "1", optional = true } | ||
proc-macro2 = { version = "1", optional = true } | ||
unicode-xid = { version = "0.2.4", optional = true } | ||
quote = { version = "1", optional = true, no-default-features = true } | ||
Comment on lines
-32
to
+35
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please don't align it like that. Just one space after the comma. and before the |
Original file line number | Diff line number | Diff line change | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,44 @@ | ||||||||||||||||||||
use quote::{ToTokens, TokenStreamExt}; | ||||||||||||||||||||
|
||||||||||||||||||||
use crate::Buffer; | ||||||||||||||||||||
|
||||||||||||||||||||
macro_rules! to_tokens_simple { | ||||||||||||||||||||
($id:ident) => { | ||||||||||||||||||||
impl<B: Buffer + Clone> ToTokens for crate::$id<B> { | ||||||||||||||||||||
fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) { | ||||||||||||||||||||
tokens.append(<Self as Into<proc_macro2::Literal>>::into(self.clone())) | ||||||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That shouldn't require a clone. I suppose there should be Also, |
||||||||||||||||||||
} | ||||||||||||||||||||
|
||||||||||||||||||||
fn into_token_stream(self) -> proc_macro2::TokenStream | ||||||||||||||||||||
where | ||||||||||||||||||||
Self: Sized, | ||||||||||||||||||||
{ | ||||||||||||||||||||
proc_macro2::TokenStream::from(proc_macro2::TokenTree::from(<Self as Into< | ||||||||||||||||||||
proc_macro2::Literal, | ||||||||||||||||||||
>>::into(self))) | ||||||||||||||||||||
} | ||||||||||||||||||||
Comment on lines
+12
to
+19
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. And I suppose if we remove the |
||||||||||||||||||||
} | ||||||||||||||||||||
}; | ||||||||||||||||||||
} | ||||||||||||||||||||
to_tokens_simple!(ByteLit); | ||||||||||||||||||||
to_tokens_simple!(ByteStringLit); | ||||||||||||||||||||
to_tokens_simple!(CharLit); | ||||||||||||||||||||
to_tokens_simple!(FloatLit); | ||||||||||||||||||||
to_tokens_simple!(IntegerLit); | ||||||||||||||||||||
to_tokens_simple!(StringLit); | ||||||||||||||||||||
|
||||||||||||||||||||
impl ToTokens for crate::BoolLit { | ||||||||||||||||||||
fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) { | ||||||||||||||||||||
use crate::BoolLit::*; | ||||||||||||||||||||
tokens.append(proc_macro2::Ident::new( | ||||||||||||||||||||
match self { | ||||||||||||||||||||
True => "true", | ||||||||||||||||||||
False => "false", | ||||||||||||||||||||
}, | ||||||||||||||||||||
proc_macro2::Span::call_site(), | ||||||||||||||||||||
)) | ||||||||||||||||||||
Comment on lines
+32
to
+39
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Should work? |
||||||||||||||||||||
} | ||||||||||||||||||||
} | ||||||||||||||||||||
|
||||||||||||||||||||
#[cfg(test)] | ||||||||||||||||||||
mod tests; |
Original file line number | Diff line number | Diff line change | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,82 @@ | ||||||||||||||||||||||||||||||||||||
use proc_macro2::{Literal, TokenTree}; | ||||||||||||||||||||||||||||||||||||
use quote::ToTokens; | ||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
use crate::{ByteLit, ByteStringLit, CharLit, FloatLit, IntegerLit, StringLit}; | ||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
#[test] | ||||||||||||||||||||||||||||||||||||
fn it_preserves_bool_true() { | ||||||||||||||||||||||||||||||||||||
let other = crate::BoolLit::True | ||||||||||||||||||||||||||||||||||||
.to_token_stream() | ||||||||||||||||||||||||||||||||||||
.into_iter() | ||||||||||||||||||||||||||||||||||||
.next() | ||||||||||||||||||||||||||||||||||||
.and_then(|v| { | ||||||||||||||||||||||||||||||||||||
if let TokenTree::Ident(v) = v { | ||||||||||||||||||||||||||||||||||||
Some(v) | ||||||||||||||||||||||||||||||||||||
} else { | ||||||||||||||||||||||||||||||||||||
None | ||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||
}) | ||||||||||||||||||||||||||||||||||||
.unwrap(); | ||||||||||||||||||||||||||||||||||||
assert_eq!(other, "true") | ||||||||||||||||||||||||||||||||||||
Comment on lines
+8
to
+20
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
How about this? This also checks that there are no extra token trees in the stream. |
||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||
#[test] | ||||||||||||||||||||||||||||||||||||
fn it_preserves_bool_false() { | ||||||||||||||||||||||||||||||||||||
let other = crate::BoolLit::False | ||||||||||||||||||||||||||||||||||||
.to_token_stream() | ||||||||||||||||||||||||||||||||||||
.into_iter() | ||||||||||||||||||||||||||||||||||||
.next() | ||||||||||||||||||||||||||||||||||||
.and_then(|v| { | ||||||||||||||||||||||||||||||||||||
if let TokenTree::Ident(v) = v { | ||||||||||||||||||||||||||||||||||||
Some(v) | ||||||||||||||||||||||||||||||||||||
} else { | ||||||||||||||||||||||||||||||||||||
None | ||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||
}) | ||||||||||||||||||||||||||||||||||||
.unwrap(); | ||||||||||||||||||||||||||||||||||||
assert_eq!(other, "false") | ||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
// NOTE: sometimes the round-trip to quote simplifies literals (for example float literals) | ||||||||||||||||||||||||||||||||||||
// this is something that has to be taken into consideration when writing tests | ||||||||||||||||||||||||||||||||||||
macro_rules! preservation { | ||||||||||||||||||||||||||||||||||||
($name:ident : $ty:ident : $($content:tt)+) => { | ||||||||||||||||||||||||||||||||||||
#[test] | ||||||||||||||||||||||||||||||||||||
fn $name() { | ||||||||||||||||||||||||||||||||||||
use std::convert::TryFrom; | ||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
let lit = Literal::$($content)+; | ||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
let lhs = $ty::try_from(lit).unwrap(); | ||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
let rhs = $ty::try_from( | ||||||||||||||||||||||||||||||||||||
lhs.to_token_stream() | ||||||||||||||||||||||||||||||||||||
.into_iter() | ||||||||||||||||||||||||||||||||||||
.next() | ||||||||||||||||||||||||||||||||||||
.and_then(|v| { | ||||||||||||||||||||||||||||||||||||
if let TokenTree::Literal(v) = v { | ||||||||||||||||||||||||||||||||||||
Some(v) | ||||||||||||||||||||||||||||||||||||
} else { | ||||||||||||||||||||||||||||||||||||
None | ||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||
}) | ||||||||||||||||||||||||||||||||||||
Comment on lines
+55
to
+61
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. That shouldn't be necessary as a |
||||||||||||||||||||||||||||||||||||
.unwrap(), | ||||||||||||||||||||||||||||||||||||
) | ||||||||||||||||||||||||||||||||||||
.unwrap(); | ||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
assert_eq!(lhs, rhs); | ||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||
} | ||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
preservation!(it_preserves_u8_suffixed : IntegerLit : u8_suffixed(10)); | ||||||||||||||||||||||||||||||||||||
preservation!(it_preserves_u8_unsuffixed : IntegerLit : u8_unsuffixed(10)); | ||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
preservation!(it_preserves_f64_suffixed : FloatLit : f64_suffixed(1.1)); | ||||||||||||||||||||||||||||||||||||
preservation!(it_preserves_f64_unsuffixed : FloatLit : f64_unsuffixed(1.1)); | ||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
preservation!(it_preserves_strings : StringLit : string("hello world")); | ||||||||||||||||||||||||||||||||||||
preservation!(it_preserves_raw_strings : StringLit : string(r#"hello world"#)); | ||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
preservation!(it_preserves_char : CharLit : character('1')); | ||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||
preservation!(it_preserves_bytestring : ByteStringLit : byte_string(b"hello world")); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will bump the version as part of my release process. At least in my workflow, this doesn't belong into feature commits.