berkus
/
miette
mirror of https://github.com/zkat/miette.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

feat(labels): allow optional labels in derive macro (#153) 

Fixes: https://github.com/zkat/miette/issues/110
This commit is contained in:
Kat Marchán 2022-04-17 19:41:10 -07:00 committed by GitHub
parent 45093c2f58
commit 23ee3642d1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 117 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

125
miette-derive/src/label.rs
View File

@ -18,20 +18,35 @@ pub struct Labels(Vec<Label>);
struct Label { struct Label {
label: Option<Display>, label: Option<Display>,
optional: bool,
span: syn::Member, span: syn::Member,
} }
struct LabelAttr { struct LabelAttr {
label: Option<Display>, label: Option<Display>,
optional: bool,
} }
impl Parse for LabelAttr { impl Parse for LabelAttr {
fn parse(input: ParseStream) -> syn::Result<Self> { fn parse(input: ParseStream) -> syn::Result<Self> {
let la = input.lookahead1(); let la = input.lookahead1();
let label = if la.peek(syn::token::Paren) { let (label, optional) = if la.peek(syn::token::Paren) {
// #[label("{}", x)] // #[label("{}", x)]
let content; let content;
parenthesized!(content in input); parenthesized!(content in input);
let optional = if content.peek(syn::Ident) {
let ident = content.parse::<syn::Ident>()?;
if ident == "optional" {
if content.peek(syn::Token![,]) {
content.parse::<syn::Token![,]>()?;
}
true
} else {
false
}
} else {
false
};
if content.peek(syn::LitStr) { if content.peek(syn::LitStr) {
let fmt = content.parse()?; let fmt = content.parse()?;
let args = if content.is_empty() { let args = if content.is_empty() {
@ -44,22 +59,27 @@ impl Parse for LabelAttr {
args, args,
has_bonus_display: false, has_bonus_display: false,
}; };
Some(display) (Some(display), optional)
} else if optional {
(None, optional)
} else { } else {
return Err(syn::Error::new(input.span(), "Invalid argument to label() attribute. The first argument must be a literal string.")); return Err(syn::Error::new(input.span(), "Invalid argument to label() attribute. The first argument must be a literal string or the identifier `optional`"));
} }
} else if la.peek(Token![=]) { } else if la.peek(Token![=]) {
// #[label = "blabla"] // #[label = "blabla"]
input.parse::<Token![=]>()?; input.parse::<Token![=]>()?;
Some(Display { (
fmt: input.parse()?, Some(Display {
args: TokenStream::new(), fmt: input.parse()?,
has_bonus_display: false, args: TokenStream::new(),
}) has_bonus_display: false,
}),
false,
)
} else { } else {
None (None, false)
}; };
Ok(LabelAttr { label }) Ok(LabelAttr { label, optional })
} }
} }
@ -87,8 +107,13 @@ impl Labels {
span: field.span(), span: field.span(),
}) })
}; };
let LabelAttr { label } = syn::parse2::<LabelAttr>(attr.tokens.clone())?; let LabelAttr { label, optional } =
labels.push(Label { label, span }); syn::parse2::<LabelAttr>(attr.tokens.clone())?;
labels.push(Label {
label,
span,
optional,
});
} }
} }
} }
@ -102,21 +127,44 @@ impl Labels {
pub(crate) fn gen_struct(&self, fields: &syn::Fields) -> Option<TokenStream> { pub(crate) fn gen_struct(&self, fields: &syn::Fields) -> Option<TokenStream> {
let (display_pat, display_members) = display_pat_members(fields); let (display_pat, display_members) = display_pat_members(fields);
let labels = self.0.iter().map(|highlight| { let labels = self.0.iter().map(|highlight| {
let Label { span, label } = highlight; let Label {
span,
label,
optional,
} = highlight;
let var = quote! { __miette_internal_var };
if let Some(display) = label { if let Some(display) = label {
let (fmt, args) = display.expand_shorthand_cloned(&display_members); let (fmt, args) = display.expand_shorthand_cloned(&display_members);
if *optional {
quote! {
self.#span.clone().map(|#var|
miette::LabeledSpan::new_with_span(
std::option::Option::Some(format!(#fmt #args)),
#var,
))
}
} else {
quote! {
Some(miette::LabeledSpan::new_with_span(
std::option::Option::Some(format!(#fmt #args)),
self.#span.clone(),
))
}
}
} else if *optional {
quote! { quote! {
miette::LabeledSpan::new_with_span( self.#span.clone().map(|#var|
std::option::Option::Some(format!(#fmt #args)), miette::LabeledSpan::new_with_span(
self.#span.clone(), std::option::Option::None,
) #var,
))
} }
} else { } else {
quote! { quote! {
miette::LabeledSpan::new_with_span( Some(miette::LabeledSpan::new_with_span(
std::option::Option::None, std::option::Option::None,
self.#span.clone(), self.#span.clone(),
) ))
} }
} }
}); });
@ -124,9 +172,9 @@ impl Labels {
#[allow(unused_variables)] #[allow(unused_variables)]
fn labels(&self) -> std::option::Option<std::boxed::Box<dyn std::iter::Iterator<Item = miette::LabeledSpan> + '_>> { fn labels(&self) -> std::option::Option<std::boxed::Box<dyn std::iter::Iterator<Item = miette::LabeledSpan> + '_>> {
let Self #display_pat = self; let Self #display_pat = self;
Some(Box::new(vec![ std::option::Option::Some(Box::new(vec![
#(#labels),* #(#labels),*
].into_iter())) ].into_iter().filter(Option::is_some).map(Option::unwrap)))
} }
}) })
} }
@ -139,27 +187,46 @@ impl Labels {
let (display_pat, display_members) = display_pat_members(fields); let (display_pat, display_members) = display_pat_members(fields);
labels.as_ref().and_then(|labels| { labels.as_ref().and_then(|labels| {
let variant_labels = labels.0.iter().map(|label| { let variant_labels = labels.0.iter().map(|label| {
let Label { span, label } = label; let Label { span, label, optional } = label;
let field = match &span { let field = match &span {
syn::Member::Named(ident) => ident.clone(), syn::Member::Named(ident) => ident.clone(),
syn::Member::Unnamed(syn::Index { index, .. }) => { syn::Member::Unnamed(syn::Index { index, .. }) => {
format_ident!("_{}", index) format_ident!("_{}", index)
} }
}; };
let var = quote! { __miette_internal_var };
if let Some(display) = label { if let Some(display) = label {
let (fmt, args) = display.expand_shorthand_cloned(&display_members); let (fmt, args) = display.expand_shorthand_cloned(&display_members);
if *optional {
quote! {
#field.clone().map(|#var|
miette::LabeledSpan::new_with_span(
std::option::Option::Some(format!(#fmt #args)),
#var,
))
}
} else {
quote! {
Some(miette::LabeledSpan::new_with_span(
std::option::Option::Some(format!(#fmt #args)),
#field.clone(),
))
}
}
} else if *optional {
quote! { quote! {
miette::LabeledSpan::new_with_span( #field.clone().map(|#var|
std::option::Option::Some(format!(#fmt #args)), miette::LabeledSpan::new_with_span(
#field.clone(), std::option::Option::None,
) #var,
))
} }
} else { } else {
quote! { quote! {
miette::LabeledSpan::new_with_span( Some(miette::LabeledSpan::new_with_span(
std::option::Option::None, std::option::Option::None,
#field.clone(), #field.clone(),
) ))
} }
} }
}); });
@ -169,7 +236,7 @@ impl Labels {
_ => Some(quote! { _ => Some(quote! {
Self::#variant_name #display_pat => std::option::Option::Some(std::boxed::Box::new(vec![ Self::#variant_name #display_pat => std::option::Option::Some(std::boxed::Box::new(vec![
#(#variant_labels),* #(#variant_labels),*
].into_iter())), ].into_iter().filter(Option::is_some).map(Option::unwrap))),
}), }),
} }
}) })

4
src/handlers/graphical.rs
View File

@ -350,9 +350,7 @@ impl GraphicalReportHandler {
let labels = labels let labels = labels
.iter() .iter()
.zip(self.theme.styles.highlights.iter().cloned().cycle()) .zip(self.theme.styles.highlights.iter().cloned().cycle())
.map(|(label, st)| { .map(|(label, st)| FancySpan::new(label.label().map(String::from), *label.inner(), st))
FancySpan::new(label.label().map(String::from), label.inner().clone(), st)
})
.collect::<Vec<_>>(); .collect::<Vec<_>>();
// The max number of gutter-lines that will be active at any given // The max number of gutter-lines that will be active at any given

8
src/lib.rs
View File

@ -368,6 +368,14 @@
//! // They'll be rendered sequentially. //! // They'll be rendered sequentially.
//! #[label("This is bad")] //! #[label("This is bad")]
//! snip2: (usize, usize), // `(usize, usize)` is `Into<SourceSpan>`! //! snip2: (usize, usize), // `(usize, usize)` is `Into<SourceSpan>`!
//!
//! // Snippets can be optional, by tagging them as such:
//! #[label(optional, "some text")]
//! snip3: Option<SourceSpan>,
//!
//! // with or without label text
//! #[label(optional)]
//! snip4: Option<SourceSpan>,
//! } //! }
//! ``` //! ```
//! //!

12
tests/derive.rs
View File

@ -309,6 +309,10 @@ fn test_snippet_named_struct() {
var2: (usize, usize), var2: (usize, usize),
#[label] #[label]
var3: (usize, usize), var3: (usize, usize),
#[label(optional, "var 4")]
var4: Option<(usize, usize)>,
#[label(optional)]
var5: Option<(usize, usize)>,
} }
} }
@ -322,6 +326,8 @@ fn test_snippet_unnamed_struct() {
#[label("{0}")] SourceSpan, #[label("{0}")] SourceSpan,
#[label = "idk"] SourceSpan, #[label = "idk"] SourceSpan,
#[label] SourceSpan, #[label] SourceSpan,
#[label(optional, "foo")] Option<SourceSpan>,
#[label(optional)] Option<SourceSpan>,
); );
} }
@ -342,6 +348,10 @@ fn test_snippet_enum() {
var1: SourceSpan, var1: SourceSpan,
#[label] #[label]
var2: SourceSpan, var2: SourceSpan,
#[label(optional, "var 3")]
var3: Option<(usize, usize)>,
#[label(optional)]
var4: Option<(usize, usize)>,
}, },
#[diagnostic(code(foo::b))] #[diagnostic(code(foo::b))]
B( B(
@ -350,6 +360,8 @@ fn test_snippet_enum() {
#[label("{1}")] SourceSpan, #[label("{1}")] SourceSpan,
#[label = "blorp"] SourceSpan, #[label = "blorp"] SourceSpan,
#[label] SourceSpan, #[label] SourceSpan,
#[label(optional, "foo")] Option<SourceSpan>,
#[label(optional)] Option<SourceSpan>,
), ),
} }
} }