clippy_lints/src/misc_early.rs

   1 use rustc::lint::*;
   2 use std::collections::HashMap;
   3 use std::char;
   4 use syntax::ast::*;
   5 use syntax::codemap::Span;
   6 use syntax::visit::FnKind;
   7 use utils::{constants, span_lint, span_help_and_lint, snippet, snippet_opt, span_lint_and_then};
   8
   9 /// **What it does:** Checks for structure field patterns bound to wildcards.
  10 ///
  11 /// **Why is this bad?** Using `..` instead is shorter and leaves the focus on
  12 /// the fields that are actually bound.
  13 ///
  14 /// **Known problems:** None.
  15 ///
  16 /// **Example:**
  17 /// ```rust
  18 /// let { a: _, b: ref b, c: _ } = ..
  19 /// ```
  20 declare_lint! {
  21     pub UNNEEDED_FIELD_PATTERN,
  22     Warn,
  23     "struct fields bound to a wildcard instead of using `..`"
  24 }
  25
  26 /// **What it does:** Checks for function arguments having the similar names
  27 /// differing by an underscore.
  28 ///
  29 /// **Why is this bad?** It affects code readability.
  30 ///
  31 /// **Known problems:** None.
  32 ///
  33 /// **Example:**
  34 /// ```rust
  35 /// fn foo(a: i32, _a: i32) {}
  36 /// ```
  37 declare_lint! {
  38     pub DUPLICATE_UNDERSCORE_ARGUMENT,
  39     Warn,
  40     "function arguments having names which only differ by an underscore"
  41 }
  42
  43 /// **What it does:** Detects closures called in the same expression where they are defined.
  44 ///
  45 /// **Why is this bad?** It is unnecessarily adding to the expression's complexity.
  46 ///
  47 /// **Known problems:** None.
  48 ///
  49 /// **Example:**
  50 /// ```rust
  51 /// (|| 42)()
  52 /// ```
  53 declare_lint! {
  54     pub REDUNDANT_CLOSURE_CALL,
  55     Warn,
  56     "throwaway closures called in the expression they are defined"
  57 }
  58
  59 /// **What it does:** Detects expressions of the form `--x`.
  60 ///
  61 /// **Why is this bad?** It can mislead C/C++ programmers to think `x` was
  62 /// decremented.
  63 ///
  64 /// **Known problems:** None.
  65 ///
  66 /// **Example:**
  67 /// ```rust
  68 /// --x;
  69 /// ```
  70 declare_lint! {
  71     pub DOUBLE_NEG,
  72     Warn,
  73     "`--x`, which is a double negation of `x` and not a pre-decrement as in C/C++"
  74 }
  75
  76 /// **What it does:** Warns on hexadecimal literals with mixed-case letter digits.
  77 ///
  78 /// **Why is this bad?** It looks confusing.
  79 ///
  80 /// **Known problems:** None.
  81 ///
  82 /// **Example:**
  83 /// ```rust
  84 /// let y = 0x1a9BAcD;
  85 /// ```
  86 declare_lint! {
  87     pub MIXED_CASE_HEX_LITERALS,
  88     Warn,
  89     "hex literals whose letter digits are not consistently upper- or lowercased"
  90 }
  91
  92 /// **What it does:** Warns if literal suffixes are not separated by an underscore.
  93 ///
  94 /// **Why is this bad?** It is much less readable.
  95 ///
  96 /// **Known problems:** None.
  97 ///
  98 /// **Example:**
  99 /// ```rust
 100 /// let y = 123832i32;
 101 /// ```
 102 declare_lint! {
 103     pub UNSEPARATED_LITERAL_SUFFIX,
 104     Allow,
 105     "literals whose suffix is not separated by an underscore"
 106 }
 107
 108 /// **What it does:** Warns if an integral constant literal starts with `0`.
 109 ///
 110 /// **Why is this bad?** In some languages (including the infamous C language and most of its
 111 /// familly), this marks an octal constant. In Rust however, this is a decimal constant. This could
 112 /// be confusing for both the writer and a reader of the constant.
 113 ///
 114 /// **Known problems:** None.
 115 ///
 116 /// **Example:**
 117 ///
 118 /// In Rust:
 119 /// ```rust
 120 /// fn main() {
 121 ///     let a = 0123;
 122 ///     println!("{}", a);
 123 /// }
 124 /// ```
 125 ///
 126 /// prints `123`, while in C:
 127 ///
 128 /// ```c
 129 /// #include <stdio.h>
 130 ///
 131 /// int main() {
 132 ///     int a = 0123;
 133 ///     printf("%d\n", a);
 134 /// }
 135 /// ```
 136 ///
 137 /// prints `83` (as `83 == 0o123` while `123 == 0o173`).
 138 declare_lint! {
 139     pub ZERO_PREFIXED_LITERAL,
 140     Warn,
 141     "integer literals starting with `0`"
 142 }
 143
 144 /// **What it does:** Warns if a generic shadows a built-in type.
 145 ///
 146 /// **Why is this bad?** This gives surprising type errors.
 147 ///
 148 /// **Known problems:** None.
 149 ///
 150 /// **Example:**
 151 ///
 152 /// ```rust
 153 /// impl<u32> Foo<u32> {
 154 ///     fn impl_func(&self) -> u32 {
 155 ///         42
 156 ///     }
 157 /// }
 158 /// ```
 159 declare_lint! {
 160     pub BUILTIN_TYPE_SHADOW,
 161     Warn,
 162     "shadowing a builtin type"
 163 }
 164
 165
 166 #[derive(Copy, Clone)]
 167 pub struct MiscEarly;
 168
 169 impl LintPass for MiscEarly {
 170     fn get_lints(&self) -> LintArray {
 171         lint_array!(UNNEEDED_FIELD_PATTERN, DUPLICATE_UNDERSCORE_ARGUMENT, REDUNDANT_CLOSURE_CALL,
 172                     DOUBLE_NEG, MIXED_CASE_HEX_LITERALS, UNSEPARATED_LITERAL_SUFFIX,
 173                     ZERO_PREFIXED_LITERAL, BUILTIN_TYPE_SHADOW)
 174     }
 175 }
 176
 177 impl EarlyLintPass for MiscEarly {
 178     fn check_generics(&mut self, cx: &EarlyContext, gen: &Generics) {
 179         for ty in &gen.ty_params {
 180             let name = ty.ident.name.as_str();
 181             if constants::BUILTIN_TYPES.contains(&&*name) {
 182                 span_lint(cx,
 183                           BUILTIN_TYPE_SHADOW,
 184                           ty.span,
 185                           &format!("This generic shadows the built-in type `{}`", name));
 186             }
 187         }
 188     }
 189
 190     fn check_pat(&mut self, cx: &EarlyContext, pat: &Pat) {
 191         if let PatKind::Struct(ref npat, ref pfields, _) = pat.node {
 192             let mut wilds = 0;
 193             let type_name = npat.segments.last().expect("A path must have at least one segment").identifier.name;
 194
 195             for field in pfields {
 196                 if field.node.pat.node == PatKind::Wild {
 197                     wilds += 1;
 198                 }
 199             }
 200             if !pfields.is_empty() && wilds == pfields.len() {
 201                 span_help_and_lint(cx,
 202                                    UNNEEDED_FIELD_PATTERN,
 203                                    pat.span,
 204                                    "All the struct fields are matched to a wildcard pattern, consider using `..`.",
 205                                    &format!("Try with `{} {{ .. }}` instead", type_name));
 206                 return;
 207             }
 208             if wilds > 0 {
 209                 let mut normal = vec![];
 210
 211                 for field in pfields {
 212                     if field.node.pat.node != PatKind::Wild {
 213                         if let Ok(n) = cx.sess().codemap().span_to_snippet(field.span) {
 214                             normal.push(n);
 215                         }
 216                     }
 217                 }
 218                 for field in pfields {
 219                     if field.node.pat.node == PatKind::Wild {
 220                         wilds -= 1;
 221                         if wilds > 0 {
 222                             span_lint(cx,
 223                                       UNNEEDED_FIELD_PATTERN,
 224                                       field.span,
 225                                       "You matched a field with a wildcard pattern. Consider using `..` instead");
 226                         } else {
 227                             span_help_and_lint(cx,
 228                                                UNNEEDED_FIELD_PATTERN,
 229                                                field.span,
 230                                                "You matched a field with a wildcard pattern. Consider using `..` \
 231                                                 instead",
 232                                                &format!("Try with `{} {{ {}, .. }}`",
 233                                                         type_name,
 234                                                         normal[..].join(", ")));
 235                         }
 236                     }
 237                 }
 238             }
 239         }
 240     }
 241
 242     fn check_fn(&mut self, cx: &EarlyContext, _: FnKind, decl: &FnDecl, _: Span, _: NodeId) {
 243         let mut registered_names: HashMap<String, Span> = HashMap::new();
 244
 245         for arg in &decl.inputs {
 246             if let PatKind::Ident(_, sp_ident, None) = arg.pat.node {
 247                 let arg_name = sp_ident.node.to_string();
 248
 249                 if arg_name.starts_with('_') {
 250                     if let Some(correspondence) = registered_names.get(&arg_name[1..]) {
 251                         span_lint(cx,
 252                                   DUPLICATE_UNDERSCORE_ARGUMENT,
 253                                   *correspondence,
 254                                   &format!("`{}` already exists, having another argument having almost the same \
 255                                             name makes code comprehension and documentation more difficult",
 256                                            arg_name[1..].to_owned()));;
 257                     }
 258                 } else {
 259                     registered_names.insert(arg_name, arg.pat.span);
 260                 }
 261             }
 262         }
 263     }
 264
 265     fn check_expr(&mut self, cx: &EarlyContext, expr: &Expr) {
 266         match expr.node {
 267             ExprKind::Call(ref paren, _) => {
 268                 if let ExprKind::Paren(ref closure) = paren.node {
 269                     if let ExprKind::Closure(_, ref decl, ref block, _) = closure.node {
 270                         span_lint_and_then(cx,
 271                                            REDUNDANT_CLOSURE_CALL,
 272                                            expr.span,
 273                                            "Try not to call a closure in the expression where it is declared.",
 274                                            |db| {
 275                                                if decl.inputs.is_empty() {
 276                                                    let hint = snippet(cx, block.span, "..").into_owned();
 277                                                    db.span_suggestion(expr.span, "Try doing something like: ", hint);
 278                                                }
 279                                            });
 280                     }
 281                 }
 282             }
 283             ExprKind::Unary(UnOp::Neg, ref inner) => {
 284                 if let ExprKind::Unary(UnOp::Neg, _) = inner.node {
 285                     span_lint(cx,
 286                               DOUBLE_NEG,
 287                               expr.span,
 288                               "`--x` could be misinterpreted as pre-decrement by C programmers, is usually a no-op");
 289                 }
 290             }
 291             ExprKind::Lit(ref lit) => {
 292                 if_let_chain! {[
 293                     let LitKind::Int(value, ..) = lit.node,
 294                     let Some(src) = snippet_opt(cx, lit.span),
 295                     let Some(firstch) = src.chars().next(),
 296                     char::to_digit(firstch, 10).is_some()
 297                 ], {
 298                     let mut prev = '\0';
 299                     for ch in src.chars() {
 300                         if ch == 'i' || ch == 'u' {
 301                             if prev != '_' {
 302                                 span_lint(cx, UNSEPARATED_LITERAL_SUFFIX, lit.span,
 303                                           "integer type suffix should be separated by an underscore");
 304                             }
 305                             break;
 306                         }
 307                         prev = ch;
 308                     }
 309                     if src.starts_with("0x") {
 310                         let mut seen = (false, false);
 311                         for ch in src.chars() {
 312                             match ch {
 313                                 'a' ... 'f' => seen.0 = true,
 314                                 'A' ... 'F' => seen.1 = true,
 315                                 'i' | 'u'   => break,   // start of suffix already
 316                                 _ => ()
 317                             }
 318                         }
 319                         if seen.0 && seen.1 {
 320                             span_lint(cx, MIXED_CASE_HEX_LITERALS, lit.span,
 321                                       "inconsistent casing in hexadecimal literal");
 322                         }
 323                     } else if src.starts_with("0b") || src.starts_with("0o") {
 324                         /* nothing to do */
 325                     } else if value != 0 && src.starts_with('0') {
 326                         span_lint_and_then(cx,
 327                                            ZERO_PREFIXED_LITERAL,
 328                                            lit.span,
 329                                            "this is a decimal constant",
 330                                            |db| {
 331                             db.span_suggestion(lit.span, "if you mean to use a decimal constant, remove the `0` to remove confusion:", src[1..].to_string());
 332                             db.span_suggestion(lit.span, "if you mean to use an octal constant, use `0o`:", format!("0o{}", &src[1..]));
 333                         });
 334                     }
 335                 }}
 336                 if_let_chain! {[
 337                     let LitKind::Float(..) = lit.node,
 338                     let Some(src) = snippet_opt(cx, lit.span),
 339                     let Some(firstch) = src.chars().next(),
 340                     char::to_digit(firstch, 10).is_some()
 341                 ], {
 342                     let mut prev = '\0';
 343                     for ch in src.chars() {
 344                         if ch == 'f' {
 345                             if prev != '_' {
 346                                 span_lint(cx, UNSEPARATED_LITERAL_SUFFIX, lit.span,
 347                                           "float type suffix should be separated by an underscore");
 348                             }
 349                             break;
 350                         }
 351                         prev = ch;
 352                     }
 353                 }}
 354             }
 355             _ => ()
 356         }
 357     }
 358
 359     fn check_block(&mut self, cx: &EarlyContext, block: &Block) {
 360         for w in block.stmts.windows(2) {
 361             if_let_chain! {[
 362                 let StmtKind::Local(ref local) = w[0].node,
 363                 let Option::Some(ref t) = local.init,
 364                 let ExprKind::Closure(_, _, _, _) = t.node,
 365                 let PatKind::Ident(_, sp_ident, _) = local.pat.node,
 366                 let StmtKind::Semi(ref second) = w[1].node,
 367                 let ExprKind::Assign(_, ref call) = second.node,
 368                 let ExprKind::Call(ref closure, _) = call.node,
 369                 let ExprKind::Path(_, ref path) = closure.node
 370             ], {
 371                 if sp_ident.node == (&path.segments[0]).identifier {
 372                     span_lint(cx, REDUNDANT_CLOSURE_CALL, second.span, "Closure called just once immediately after it was declared");
 373                 }
 374             }}
 375         }
 376     }
 377 }