clippy_lints/src/nonstandard_macro_braces.rs

   1 use std::{
   2     fmt,
   3     hash::{Hash, Hasher},
   4 };
   5
   6 use clippy_utils::{diagnostics::span_lint_and_help, in_macro, is_direct_expn_of, source::snippet_opt};
   7 use if_chain::if_chain;
   8 use rustc_ast::ast;
   9 use rustc_data_structures::fx::{FxHashMap, FxHashSet};
  10 use rustc_lint::{EarlyContext, EarlyLintPass};
  11 use rustc_session::{declare_tool_lint, impl_lint_pass};
  12 use rustc_span::Span;
  13 use serde::{de, Deserialize};
  14
  15 declare_clippy_lint! {
  16     /// **What it does:** Checks that common macros are used with consistent bracing.
  17     ///
  18     /// **Why is this bad?** This is mostly a consistency lint although using () or []
  19     /// doesn't give you a semicolon in item position, which can be unexpected.
  20     ///
  21     /// **Known problems:**
  22     /// None
  23     ///
  24     /// **Example:**
  25     ///
  26     /// ```rust
  27     /// vec!{1, 2, 3};
  28     /// ```
  29     /// Use instead:
  30     /// ```rust
  31     /// vec![1, 2, 3];
  32     /// ```
  33     pub NONSTANDARD_MACRO_BRACES,
  34     nursery,
  35     "check consistent use of braces in macro"
  36 }
  37
  38 const BRACES: &[(&str, &str)] = &[("(", ")"), ("{", "}"), ("[", "]")];
  39
  40 /// The (name, (open brace, close brace), source snippet)
  41 type MacroInfo<'a> = (&'a str, &'a (String, String), String);
  42
  43 #[derive(Clone, Debug, Default)]
  44 pub struct MacroBraces {
  45     macro_braces: FxHashMap<String, (String, String)>,
  46     done: FxHashSet<Span>,
  47 }
  48
  49 impl MacroBraces {
  50     pub fn new(conf: &FxHashSet<MacroMatcher>) -> Self {
  51         let macro_braces = macro_braces(conf.clone());
  52         Self {
  53             macro_braces,
  54             done: FxHashSet::default(),
  55         }
  56     }
  57 }
  58
  59 impl_lint_pass!(MacroBraces => [NONSTANDARD_MACRO_BRACES]);
  60
  61 impl EarlyLintPass for MacroBraces {
  62     fn check_item(&mut self, cx: &EarlyContext<'_>, item: &ast::Item) {
  63         if let Some((name, braces, snip)) = is_offending_macro(cx, item.span, self) {
  64             let span = item.span.ctxt().outer_expn_data().call_site;
  65             emit_help(cx, snip, braces, name, span);
  66             self.done.insert(span);
  67         }
  68     }
  69
  70     fn check_stmt(&mut self, cx: &EarlyContext<'_>, stmt: &ast::Stmt) {
  71         if let Some((name, braces, snip)) = is_offending_macro(cx, stmt.span, self) {
  72             let span = stmt.span.ctxt().outer_expn_data().call_site;
  73             emit_help(cx, snip, braces, name, span);
  74             self.done.insert(span);
  75         }
  76     }
  77
  78     fn check_expr(&mut self, cx: &EarlyContext<'_>, expr: &ast::Expr) {
  79         if let Some((name, braces, snip)) = is_offending_macro(cx, expr.span, self) {
  80             let span = expr.span.ctxt().outer_expn_data().call_site;
  81             emit_help(cx, snip, braces, name, span);
  82             self.done.insert(span);
  83         }
  84     }
  85
  86     fn check_ty(&mut self, cx: &EarlyContext<'_>, ty: &ast::Ty) {
  87         if let Some((name, braces, snip)) = is_offending_macro(cx, ty.span, self) {
  88             let span = ty.span.ctxt().outer_expn_data().call_site;
  89             emit_help(cx, snip, braces, name, span);
  90             self.done.insert(span);
  91         }
  92     }
  93 }
  94
  95 fn is_offending_macro<'a>(cx: &EarlyContext<'_>, span: Span, mac_braces: &'a MacroBraces) -> Option<MacroInfo<'a>> {
  96     if_chain! {
  97         // Make sure we are only one level deep otherwise there are to many FP's
  98         if in_macro(span) && !in_macro(span.ctxt().outer_expn_data().call_site);
  99         if let Some((name, braces)) = find_matching_macro(span, &mac_braces.macro_braces);
 100         if let Some(snip) = snippet_opt(cx, span.ctxt().outer_expn_data().call_site);
 101         // we must check only invocation sites
 102         // https://github.com/rust-lang/rust-clippy/issues/7422
 103         if snip.starts_with(&format!("{}!", name));
 104         // make formatting consistent
 105         let c = snip.replace(" ", "");
 106         if !c.starts_with(&format!("{}!{}", name, braces.0));
 107         if !mac_braces.done.contains(&span.ctxt().outer_expn_data().call_site);
 108         then {
 109             Some((name, braces, snip))
 110         } else {
 111             None
 112         }
 113     }
 114 }
 115
 116 fn emit_help(cx: &EarlyContext<'_>, snip: String, braces: &(String, String), name: &str, span: Span) {
 117     let with_space = &format!("! {}", braces.0);
 118     let without_space = &format!("!{}", braces.0);
 119     let mut help = snip;
 120     for b in BRACES.iter().filter(|b| b.0 != braces.0) {
 121         help = help.replace(b.0, &braces.0).replace(b.1, &braces.1);
 122         // Only `{` traditionally has space before the brace
 123         if braces.0 != "{" && help.contains(with_space) {
 124             help = help.replace(with_space, without_space);
 125         } else if braces.0 == "{" && help.contains(without_space) {
 126             help = help.replace(without_space, with_space);
 127         }
 128     }
 129     span_lint_and_help(
 130         cx,
 131         NONSTANDARD_MACRO_BRACES,
 132         span,
 133         &format!("use of irregular braces for `{}!` macro", name),
 134         Some(span),
 135         &format!("consider writing `{}`", help),
 136     );
 137 }
 138
 139 fn find_matching_macro(
 140     span: Span,
 141     braces: &FxHashMap<String, (String, String)>,
 142 ) -> Option<(&String, &(String, String))> {
 143     braces
 144         .iter()
 145         .find(|(macro_name, _)| is_direct_expn_of(span, macro_name).is_some())
 146 }
 147
 148 fn macro_braces(conf: FxHashSet<MacroMatcher>) -> FxHashMap<String, (String, String)> {
 149     let mut braces = vec![
 150         macro_matcher!(
 151             name: "print",
 152             braces: ("(", ")"),
 153         ),
 154         macro_matcher!(
 155             name: "println",
 156             braces: ("(", ")"),
 157         ),
 158         macro_matcher!(
 159             name: "eprint",
 160             braces: ("(", ")"),
 161         ),
 162         macro_matcher!(
 163             name: "eprintln",
 164             braces: ("(", ")"),
 165         ),
 166         macro_matcher!(
 167             name: "write",
 168             braces: ("(", ")"),
 169         ),
 170         macro_matcher!(
 171             name: "writeln",
 172             braces: ("(", ")"),
 173         ),
 174         macro_matcher!(
 175             name: "format",
 176             braces: ("(", ")"),
 177         ),
 178         macro_matcher!(
 179             name: "format_args",
 180             braces: ("(", ")"),
 181         ),
 182         macro_matcher!(
 183             name: "vec",
 184             braces: ("[", "]"),
 185         ),
 186     ]
 187     .into_iter()
 188     .collect::<FxHashMap<_, _>>();
 189     // We want users items to override any existing items
 190     for it in conf {
 191         braces.insert(it.name, it.braces);
 192     }
 193     braces
 194 }
 195
 196 macro_rules! macro_matcher {
 197     (name: $name:expr, braces: ($open:expr, $close:expr) $(,)?) => {
 198         ($name.to_owned(), ($open.to_owned(), $close.to_owned()))
 199     };
 200 }
 201 pub(crate) use macro_matcher;
 202
 203 #[derive(Clone, Debug)]
 204 pub struct MacroMatcher {
 205     name: String,
 206     braces: (String, String),
 207 }
 208
 209 impl Hash for MacroMatcher {
 210     fn hash<H: Hasher>(&self, state: &mut H) {
 211         self.name.hash(state);
 212     }
 213 }
 214
 215 impl PartialEq for MacroMatcher {
 216     fn eq(&self, other: &Self) -> bool {
 217         self.name == other.name
 218     }
 219 }
 220 impl Eq for MacroMatcher {}
 221
 222 impl<'de> Deserialize<'de> for MacroMatcher {
 223     fn deserialize<D>(deser: D) -> Result<Self, D::Error>
 224     where
 225         D: de::Deserializer<'de>,
 226     {
 227         #[derive(Deserialize)]
 228         #[serde(field_identifier, rename_all = "lowercase")]
 229         enum Field {
 230             Name,
 231             Brace,
 232         }
 233         struct MacVisitor;
 234         impl<'de> de::Visitor<'de> for MacVisitor {
 235             type Value = MacroMatcher;
 236
 237             fn expecting(&self, formatter: &mut fmt::Formatter<'_>) -> fmt::Result {
 238                 formatter.write_str("struct MacroMatcher")
 239             }
 240
 241             fn visit_map<V>(self, mut map: V) -> Result<Self::Value, V::Error>
 242             where
 243                 V: de::MapAccess<'de>,
 244             {
 245                 let mut name = None;
 246                 let mut brace: Option<&str> = None;
 247                 while let Some(key) = map.next_key()? {
 248                     match key {
 249                         Field::Name => {
 250                             if name.is_some() {
 251                                 return Err(de::Error::duplicate_field("name"));
 252                             }
 253                             name = Some(map.next_value()?);
 254                         },
 255                         Field::Brace => {
 256                             if brace.is_some() {
 257                                 return Err(de::Error::duplicate_field("brace"));
 258                             }
 259                             brace = Some(map.next_value()?);
 260                         },
 261                     }
 262                 }
 263                 let name = name.ok_or_else(|| de::Error::missing_field("name"))?;
 264                 let brace = brace.ok_or_else(|| de::Error::missing_field("brace"))?;
 265                 Ok(MacroMatcher {
 266                     name,
 267                     braces: BRACES
 268                         .iter()
 269                         .find(|b| b.0 == brace)
 270                         .map(|(o, c)| ((*o).to_owned(), (*c).to_owned()))
 271                         .ok_or_else(|| {
 272                             de::Error::custom(&format!("expected one of `(`, `{{`, `[` found `{}`", brace))
 273                         })?,
 274                 })
 275             }
 276         }
 277
 278         const FIELDS: &[&str] = &["name", "brace"];
 279         deser.deserialize_struct("MacroMatcher", FIELDS, MacVisitor)
 280     }
 281 }