-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Add macro_braces lint to check for irregular brace use in certain macros #7299
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
Merged
+443
−10
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,276 @@ | ||
| use std::{ | ||
| fmt, | ||
| hash::{Hash, Hasher}, | ||
| }; | ||
|
|
||
| use clippy_utils::{diagnostics::span_lint_and_help, in_macro, is_direct_expn_of, source::snippet_opt}; | ||
| use if_chain::if_chain; | ||
| use rustc_ast::ast; | ||
| use rustc_data_structures::fx::{FxHashMap, FxHashSet}; | ||
| use rustc_lint::{EarlyContext, EarlyLintPass}; | ||
| use rustc_session::{declare_tool_lint, impl_lint_pass}; | ||
| use rustc_span::Span; | ||
| use serde::{de, Deserialize}; | ||
|
|
||
| declare_clippy_lint! { | ||
| /// **What it does:** Checks that common macros are used with consistent bracing. | ||
| /// | ||
| /// **Why is this bad?** This is mostly a consistency lint although using () or [] | ||
| /// doesn't give you a semicolon in item position, which can be unexpected. | ||
| /// | ||
| /// **Known problems:** | ||
| /// None | ||
| /// | ||
| /// **Example:** | ||
| /// | ||
| /// ```rust | ||
| /// vec!{1, 2, 3}; | ||
| /// ``` | ||
| /// Use instead: | ||
| /// ```rust | ||
| /// vec![1, 2, 3]; | ||
| /// ``` | ||
| pub NONSTANDARD_MACRO_BRACES, | ||
| style, | ||
| "check consistent use of braces in macro" | ||
| } | ||
|
|
||
| const BRACES: &[(&str, &str)] = &[("(", ")"), ("{", "}"), ("[", "]")]; | ||
|
|
||
| /// The (name, (open brace, close brace), source snippet) | ||
| type MacroInfo<'a> = (&'a str, &'a (String, String), String); | ||
|
|
||
| #[derive(Clone, Debug, Default)] | ||
| pub struct MacroBraces { | ||
| macro_braces: FxHashMap<String, (String, String)>, | ||
| done: FxHashSet<Span>, | ||
| } | ||
|
|
||
| impl MacroBraces { | ||
| pub fn new(conf: &FxHashSet<MacroMatcher>) -> Self { | ||
| let macro_braces = macro_braces(conf.clone()); | ||
| Self { | ||
| macro_braces, | ||
| done: FxHashSet::default(), | ||
| } | ||
| } | ||
| } | ||
|
|
||
| impl_lint_pass!(MacroBraces => [NONSTANDARD_MACRO_BRACES]); | ||
|
|
||
| impl EarlyLintPass for MacroBraces { | ||
| fn check_item(&mut self, cx: &EarlyContext<'_>, item: &ast::Item) { | ||
| if let Some((name, braces, snip)) = is_offending_macro(cx, item.span, self) { | ||
| let span = item.span.ctxt().outer_expn_data().call_site; | ||
| emit_help(cx, snip, braces, name, span); | ||
| self.done.insert(span); | ||
| } | ||
| } | ||
|
|
||
| fn check_stmt(&mut self, cx: &EarlyContext<'_>, stmt: &ast::Stmt) { | ||
| if let Some((name, braces, snip)) = is_offending_macro(cx, stmt.span, self) { | ||
| let span = stmt.span.ctxt().outer_expn_data().call_site; | ||
| emit_help(cx, snip, braces, name, span); | ||
| self.done.insert(span); | ||
| } | ||
| } | ||
|
|
||
| fn check_expr(&mut self, cx: &EarlyContext<'_>, expr: &ast::Expr) { | ||
| if let Some((name, braces, snip)) = is_offending_macro(cx, expr.span, self) { | ||
| let span = expr.span.ctxt().outer_expn_data().call_site; | ||
| emit_help(cx, snip, braces, name, span); | ||
| self.done.insert(span); | ||
| } | ||
| } | ||
|
|
||
| fn check_ty(&mut self, cx: &EarlyContext<'_>, ty: &ast::Ty) { | ||
| if let Some((name, braces, snip)) = is_offending_macro(cx, ty.span, self) { | ||
| let span = ty.span.ctxt().outer_expn_data().call_site; | ||
| emit_help(cx, snip, braces, name, span); | ||
| self.done.insert(span); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| fn is_offending_macro<'a>(cx: &EarlyContext<'_>, span: Span, this: &'a MacroBraces) -> Option<MacroInfo<'a>> { | ||
| if_chain! { | ||
| if in_macro(span); | ||
| if let Some((name, braces)) = find_matching_macro(span, &this.macro_braces); | ||
| if let Some(snip) = snippet_opt(cx, span.ctxt().outer_expn_data().call_site); | ||
| let c = snip.replace(" ", ""); // make formatting consistent | ||
| if !c.starts_with(&format!("{}!{}", name, braces.0)); | ||
| if !this.done.contains(&span.ctxt().outer_expn_data().call_site); | ||
| then { | ||
| Some((name, braces, snip)) | ||
| } else { | ||
| None | ||
| } | ||
| } | ||
| } | ||
|
|
||
| fn emit_help(cx: &EarlyContext<'_>, snip: String, braces: &(String, String), name: &str, span: Span) { | ||
| let with_space = &format!("! {}", braces.0); | ||
| let without_space = &format!("!{}", braces.0); | ||
| let mut help = snip; | ||
| for b in BRACES.iter().filter(|b| b.0 != braces.0) { | ||
| help = help.replace(b.0, &braces.0).replace(b.1, &braces.1); | ||
| // Only `{` traditionally has space before the brace | ||
| if braces.0 != "{" && help.contains(with_space) { | ||
| help = help.replace(with_space, without_space); | ||
| } else if braces.0 == "{" && help.contains(without_space) { | ||
| help = help.replace(without_space, with_space); | ||
| } | ||
| } | ||
| span_lint_and_help( | ||
| cx, | ||
| NONSTANDARD_MACRO_BRACES, | ||
| span, | ||
| &format!("use of irregular braces for `{}!` macro", name), | ||
| Some(span), | ||
| &format!("consider writing `{}`", help), | ||
| ); | ||
| } | ||
|
|
||
| fn find_matching_macro( | ||
| span: Span, | ||
| braces: &FxHashMap<String, (String, String)>, | ||
| ) -> Option<(&String, &(String, String))> { | ||
| braces | ||
| .iter() | ||
| .find(|(macro_name, _)| is_direct_expn_of(span, macro_name).is_some()) | ||
| } | ||
|
|
||
| fn macro_braces(conf: FxHashSet<MacroMatcher>) -> FxHashMap<String, (String, String)> { | ||
| let mut braces = vec![ | ||
| macro_matcher!( | ||
| name: "print", | ||
| braces: ("(", ")"), | ||
| ), | ||
| macro_matcher!( | ||
| name: "println", | ||
| braces: ("(", ")"), | ||
| ), | ||
| macro_matcher!( | ||
| name: "eprint", | ||
| braces: ("(", ")"), | ||
| ), | ||
| macro_matcher!( | ||
| name: "eprintln", | ||
| braces: ("(", ")"), | ||
| ), | ||
| macro_matcher!( | ||
| name: "write", | ||
| braces: ("(", ")"), | ||
| ), | ||
| macro_matcher!( | ||
| name: "writeln", | ||
| braces: ("(", ")"), | ||
| ), | ||
| macro_matcher!( | ||
| name: "format", | ||
| braces: ("(", ")"), | ||
| ), | ||
| macro_matcher!( | ||
| name: "format_args", | ||
| braces: ("(", ")"), | ||
| ), | ||
| macro_matcher!( | ||
| name: "vec", | ||
| braces: ("[", "]"), | ||
| ), | ||
| ] | ||
| .into_iter() | ||
| .collect::<FxHashMap<_, _>>(); | ||
| // We want users items to override any existing items | ||
| for it in conf { | ||
| braces.insert(it.name, it.braces); | ||
| } | ||
| braces | ||
| } | ||
|
|
||
| macro_rules! macro_matcher { | ||
| (name: $name:expr, braces: ($open:expr, $close:expr) $(,)?) => { | ||
| ($name.to_owned(), ($open.to_owned(), $close.to_owned())) | ||
| }; | ||
| } | ||
| pub(crate) use macro_matcher; | ||
|
|
||
| #[derive(Clone, Debug)] | ||
| pub struct MacroMatcher { | ||
| name: String, | ||
| braces: (String, String), | ||
| } | ||
|
|
||
| impl Hash for MacroMatcher { | ||
| fn hash<H: Hasher>(&self, state: &mut H) { | ||
| self.name.hash(state); | ||
| } | ||
| } | ||
|
|
||
| impl PartialEq for MacroMatcher { | ||
| fn eq(&self, other: &Self) -> bool { | ||
| self.name == other.name | ||
| } | ||
| } | ||
| impl Eq for MacroMatcher {} | ||
|
|
||
| impl<'de> Deserialize<'de> for MacroMatcher { | ||
| fn deserialize<D>(deser: D) -> Result<Self, D::Error> | ||
| where | ||
| D: de::Deserializer<'de>, | ||
| { | ||
| #[derive(Deserialize)] | ||
| #[serde(field_identifier, rename_all = "lowercase")] | ||
| enum Field { | ||
| Name, | ||
| Brace, | ||
| } | ||
| struct MacVisitor; | ||
| impl<'de> de::Visitor<'de> for MacVisitor { | ||
| type Value = MacroMatcher; | ||
|
|
||
| fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result { | ||
| formatter.write_str("struct MacroMatcher") | ||
| } | ||
|
|
||
| fn visit_map<V>(self, mut map: V) -> Result<Self::Value, V::Error> | ||
| where | ||
| V: de::MapAccess<'de>, | ||
| { | ||
| let mut name = None; | ||
| let mut brace: Option<&str> = None; | ||
| while let Some(key) = map.next_key()? { | ||
| match key { | ||
| Field::Name => { | ||
| if name.is_some() { | ||
| return Err(de::Error::duplicate_field("name")); | ||
| } | ||
| name = Some(map.next_value()?); | ||
| }, | ||
| Field::Brace => { | ||
| if brace.is_some() { | ||
| return Err(de::Error::duplicate_field("brace")); | ||
| } | ||
| brace = Some(map.next_value()?); | ||
| }, | ||
| } | ||
| } | ||
| let name = name.ok_or_else(|| de::Error::missing_field("name"))?; | ||
| let brace = brace.ok_or_else(|| de::Error::missing_field("brace"))?; | ||
| Ok(MacroMatcher { | ||
| name, | ||
| braces: BRACES | ||
| .iter() | ||
| .find(|b| b.0 == brace) | ||
| .map(|(o, c)| ((*o).to_owned(), (*c).to_owned())) | ||
| .ok_or_else(|| { | ||
| de::Error::custom(&format!("expected one of `(`, `{{`, `[` found `{}`", brace)) | ||
| })?, | ||
| }) | ||
| } | ||
| } | ||
|
|
||
| const FIELDS: &[&str] = &["name", "brace"]; | ||
| deser.deserialize_struct("MacroMatcher", FIELDS, MacVisitor) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| standard-macro-braces = [ | ||
| { name = "quote", brace = "{" }, | ||
| { name = "quote::quote", brace = "{" }, | ||
| { name = "eprint", brace = "[" }, | ||
| { name = "type_pos", brace = "[" }, | ||
| ] |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.