clippy_lints/src/non_expressive_names.rs

   1 use rustc::lint::*;
   2 use syntax::codemap::Span;
   3 use syntax::parse::token::InternedString;
   4 use syntax::ast::*;
   5 use syntax::attr;
   6 use syntax::visit::{Visitor, walk_block, walk_pat, walk_expr};
   7 use utils::{span_lint_and_then, in_macro, span_lint};
   8
   9 /// **What it does:** This lint warns about names that are very similar and thus confusing
  10 ///
  11 /// **Why is this bad?** It's hard to distinguish between names that differ only by a single character
  12 ///
  13 /// **Known problems:** None?
  14 ///
  15 /// **Example:** `checked_exp` and `checked_expr`
  16 declare_lint! {
  17     pub SIMILAR_NAMES,
  18     Allow,
  19     "similarly named items and bindings"
  20 }
  21
  22 /// **What it does:** This lint warns about having too many variables whose name consists of a single character
  23 ///
  24 /// **Why is this bad?** It's hard to memorize what a variable means without a descriptive name.
  25 ///
  26 /// **Known problems:** None?
  27 ///
  28 /// **Example:** let (a, b, c, d, e, f, g) = (...);
  29 declare_lint! {
  30     pub MANY_SINGLE_CHAR_NAMES,
  31     Warn,
  32     "too many single character bindings"
  33 }
  34
  35 pub struct NonExpressiveNames {
  36     pub max_single_char_names: u64,
  37 }
  38
  39 impl LintPass for NonExpressiveNames {
  40     fn get_lints(&self) -> LintArray {
  41         lint_array!(SIMILAR_NAMES, MANY_SINGLE_CHAR_NAMES)
  42     }
  43 }
  44
  45 struct ExistingName {
  46     interned: InternedString,
  47     span: Span,
  48     len: usize,
  49     whitelist: &'static [&'static str],
  50 }
  51
  52 struct SimilarNamesLocalVisitor<'a, 'b: 'a> {
  53     names: Vec<ExistingName>,
  54     cx: &'a EarlyContext<'b>,
  55     lint: &'a NonExpressiveNames,
  56     single_char_names: Vec<char>,
  57 }
  58
  59 // this list contains lists of names that are allowed to be similar
  60 // the assumption is that no name is ever contained in multiple lists.
  61 #[cfg_attr(rustfmt, rustfmt_skip)]
  62 const WHITELIST: &'static [&'static [&'static str]] = &[
  63     &["parsed", "parser"],
  64     &["lhs", "rhs"],
  65     &["tx", "rx"],
  66     &["set", "get"],
  67 ];
  68
  69 struct SimilarNamesNameVisitor<'a, 'b: 'a, 'c: 'b>(&'a mut SimilarNamesLocalVisitor<'b, 'c>);
  70
  71 impl<'v, 'a, 'b, 'c> Visitor<'v> for SimilarNamesNameVisitor<'a, 'b, 'c> {
  72     fn visit_pat(&mut self, pat: &'v Pat) {
  73         match pat.node {
  74             PatKind::Ident(_, id, _) => self.check_name(id.span, id.node.name),
  75             PatKind::Struct(_, ref fields, _) => {
  76                 for field in fields {
  77                     if !field.node.is_shorthand {
  78                         self.visit_pat(&field.node.pat);
  79                     }
  80                 }
  81             }
  82             _ => walk_pat(self, pat),
  83         }
  84     }
  85 }
  86
  87 fn get_whitelist(interned_name: &str) -> Option<&'static [&'static str]> {
  88     for &allow in WHITELIST {
  89         if whitelisted(interned_name, allow) {
  90             return Some(allow);
  91         }
  92     }
  93     None
  94 }
  95
  96 fn whitelisted(interned_name: &str, list: &[&str]) -> bool {
  97     if list.iter().any(|&name| interned_name == name) {
  98         return true;
  99     }
 100     for name in list {
 101         // name_*
 102         if interned_name.chars().zip(name.chars()).all(|(l, r)| l == r) {
 103             return true;
 104         }
 105         // *_name
 106         if interned_name.chars().rev().zip(name.chars().rev()).all(|(l, r)| l == r) {
 107             return true;
 108         }
 109     }
 110     false
 111 }
 112
 113 impl<'a, 'b, 'c> SimilarNamesNameVisitor<'a, 'b, 'c> {
 114     fn check_short_name(&mut self, c: char, span: Span) {
 115         // make sure we ignore shadowing
 116         if self.0.single_char_names.contains(&c) {
 117             return;
 118         }
 119         self.0.single_char_names.push(c);
 120         if self.0.single_char_names.len() as u64 >= self.0.lint.max_single_char_names {
 121             span_lint(self.0.cx,
 122                       MANY_SINGLE_CHAR_NAMES,
 123                       span,
 124                       &format!("{}th binding whose name is just one char", self.0.single_char_names.len()));
 125         }
 126     }
 127     fn check_name(&mut self, span: Span, name: Name) {
 128         if in_macro(self.0.cx, span) {
 129             return;
 130         }
 131         let interned_name = name.as_str();
 132         if interned_name.chars().any(char::is_uppercase) {
 133             return;
 134         }
 135         let count = interned_name.chars().count();
 136         if count < 3 {
 137             if count == 1 {
 138                 let c = interned_name.chars().next().expect("already checked");
 139                 self.check_short_name(c, span);
 140             }
 141             return;
 142         }
 143         for existing_name in &self.0.names {
 144             if whitelisted(&interned_name, existing_name.whitelist) {
 145                 continue;
 146             }
 147             let mut split_at = None;
 148             if existing_name.len > count {
 149                 if existing_name.len - count != 1 || levenstein_not_1(&interned_name, &existing_name.interned) {
 150                     continue;
 151                 }
 152             } else if existing_name.len < count {
 153                 if count - existing_name.len != 1 || levenstein_not_1(&existing_name.interned, &interned_name) {
 154                     continue;
 155                 }
 156             } else {
 157                 let mut interned_chars = interned_name.chars();
 158                 let mut existing_chars = existing_name.interned.chars();
 159                 let first_i = interned_chars.next().expect("we know we have at least one char");
 160                 let first_e = existing_chars.next().expect("we know we have at least one char");
 161                 let eq_or_numeric = |a: char, b: char| a == b || a.is_numeric() && b.is_numeric();
 162
 163                 if eq_or_numeric(first_i, first_e) {
 164                     let last_i = interned_chars.next_back().expect("we know we have at least two chars");
 165                     let last_e = existing_chars.next_back().expect("we know we have at least two chars");
 166                     if eq_or_numeric(last_i, last_e) {
 167                         if interned_chars.zip(existing_chars).filter(|&(i, e)| !eq_or_numeric(i, e)).count() != 1 {
 168                             continue;
 169                         }
 170                     } else {
 171                         let second_last_i = interned_chars.next_back().expect("we know we have at least three chars");
 172                         let second_last_e = existing_chars.next_back().expect("we know we have at least three chars");
 173                         if !eq_or_numeric(second_last_i, second_last_e) || second_last_i == '_' ||
 174                            !interned_chars.zip(existing_chars).all(|(i, e)| eq_or_numeric(i, e)) {
 175                             // allowed similarity foo_x, foo_y
 176                             // or too many chars differ (foo_x, boo_y) or (foox, booy)
 177                             continue;
 178                         }
 179                         split_at = interned_name.char_indices().rev().next().map(|(i, _)| i);
 180                     }
 181                 } else {
 182                     let second_i = interned_chars.next().expect("we know we have at least two chars");
 183                     let second_e = existing_chars.next().expect("we know we have at least two chars");
 184                     if !eq_or_numeric(second_i, second_e) || second_i == '_' ||
 185                        !interned_chars.zip(existing_chars).all(|(i, e)| eq_or_numeric(i, e)) {
 186                         // allowed similarity x_foo, y_foo
 187                         // or too many chars differ (x_foo, y_boo) or (xfoo, yboo)
 188                         continue;
 189                     }
 190                     split_at = interned_name.chars().next().map(|c| c.len_utf8());
 191                 }
 192             }
 193             span_lint_and_then(self.0.cx,
 194                                SIMILAR_NAMES,
 195                                span,
 196                                "binding's name is too similar to existing binding",
 197                                |diag| {
 198                 diag.span_note(existing_name.span, "existing binding defined here");
 199                 if let Some(split) = split_at {
 200                     diag.span_help(span,
 201                                    &format!("separate the discriminating character by an \
 202                                                                 underscore like: `{}_{}`",
 203                                                                &interned_name[..split],
 204                                                                &interned_name[split..]));
 205                 }
 206             });
 207             return;
 208         }
 209         self.0.names.push(ExistingName {
 210             whitelist: get_whitelist(&interned_name).unwrap_or(&[]),
 211             interned: interned_name,
 212             span: span,
 213             len: count,
 214         });
 215     }
 216 }
 217
 218 impl<'a, 'b> SimilarNamesLocalVisitor<'a, 'b> {
 219     /// ensure scoping rules work
 220     fn apply<F: for<'c> Fn(&'c mut Self)>(&mut self, f: F) {
 221         let n = self.names.len();
 222         let single_char_count = self.single_char_names.len();
 223         f(self);
 224         self.names.truncate(n);
 225         self.single_char_names.truncate(single_char_count);
 226     }
 227 }
 228
 229 impl<'v, 'a, 'b> Visitor<'v> for SimilarNamesLocalVisitor<'a, 'b> {
 230     fn visit_local(&mut self, local: &'v Local) {
 231         if let Some(ref init) = local.init {
 232             self.apply(|this| walk_expr(this, &**init));
 233         }
 234         // add the pattern after the expression because the bindings aren't available yet in the init expression
 235         SimilarNamesNameVisitor(self).visit_pat(&*local.pat);
 236     }
 237     fn visit_block(&mut self, blk: &'v Block) {
 238         self.apply(|this| walk_block(this, blk));
 239     }
 240     fn visit_arm(&mut self, arm: &'v Arm) {
 241         self.apply(|this| {
 242             // just go through the first pattern, as either all patterns bind the same bindings or rustc would have errored much earlier
 243             SimilarNamesNameVisitor(this).visit_pat(&arm.pats[0]);
 244             this.apply(|this| walk_expr(this, &arm.body));
 245         });
 246     }
 247     fn visit_item(&mut self, _: &'v Item) {
 248         // do not recurse into inner items
 249     }
 250 }
 251
 252 impl EarlyLintPass for NonExpressiveNames {
 253     fn check_item(&mut self, cx: &EarlyContext, item: &Item) {
 254         if let ItemKind::Fn(ref decl, _, _, _, _, ref blk) = item.node {
 255             if !attr::contains_name(&item.attrs, "test") {
 256                 let mut visitor = SimilarNamesLocalVisitor {
 257                     names: Vec::new(),
 258                     cx: cx,
 259                     lint: self,
 260                     single_char_names: Vec::new(),
 261                 };
 262                 // initialize with function arguments
 263                 for arg in &decl.inputs {
 264                     SimilarNamesNameVisitor(&mut visitor).visit_pat(&arg.pat);
 265                 }
 266                 // walk all other bindings
 267                 walk_block(&mut visitor, blk);
 268             }
 269         }
 270     }
 271 }
 272
 273 /// Precondition: `a_name.chars().count() < b_name.chars().count()`.
 274 fn levenstein_not_1(a_name: &str, b_name: &str) -> bool {
 275     debug_assert!(a_name.chars().count() < b_name.chars().count());
 276     let mut a_chars = a_name.chars();
 277     let mut b_chars = b_name.chars();
 278     while let (Some(a), Some(b)) = (a_chars.next(), b_chars.next()) {
 279         if a == b {
 280             continue;
 281         }
 282         if let Some(b2) = b_chars.next() {
 283             // check if there's just one character inserted
 284             return a != b2 || a_chars.ne(b_chars);
 285         } else {
 286             // tuple
 287             // ntuple
 288             return true;
 289         }
 290     }
 291     // for item in items
 292     true
 293 }