]> git.lizzy.rs Git - rust.git/blobdiff - clippy_lints/src/format.rs
Merge pull request #3465 from flip1995/rustfmt
[rust.git] / clippy_lints / src / format.rs
index 072b68d6beb9f19c292bcb142afa043897ca5b88..ac80580b14820c9dc1d0b51b9aa2deeb557c5d8e 100644 (file)
@@ -1,15 +1,29 @@
-use rustc::hir::*;
-use rustc::lint::*;
-use rustc::ty;
-use syntax::ast::LitKind;
-use syntax_pos::Span;
+// Copyright 2014-2018 The Rust Project Developers. See the COPYRIGHT
+// file at the top-level directory of this distribution.
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+use crate::rustc::hir::*;
+use crate::rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
+use crate::rustc::ty;
+use crate::rustc::{declare_tool_lint, lint_array};
+use crate::rustc_errors::Applicability;
+use crate::syntax::ast::LitKind;
 use crate::utils::paths;
-use crate::utils::{in_macro, is_expn_of, last_path_segment, match_def_path, match_type, opt_def_id, resolve_node, snippet, span_lint_and_then, walk_ptrs_ty};
+use crate::utils::{
+    in_macro, is_expn_of, last_path_segment, match_def_path, match_type, opt_def_id, resolve_node, snippet,
+    span_lint_and_then, walk_ptrs_ty,
+};
+use if_chain::if_chain;
 
 /// **What it does:** Checks for the use of `format!("string literal with no
 /// argument")` and `format!("{}", foo)` where `foo` is a string.
 ///
-/// **Why is this bad?** There is no point of doing that. `format!("too")` can
+/// **Why is this bad?** There is no point of doing that. `format!("foo")` can
 /// be replaced by `"foo".to_owned()` if you really need a `String`. The even
 /// worse `&format!("foo")` is often encountered in the wild. `format!("{}",
 /// foo)` can be replaced by `foo.clone()` if `foo: String` or `foo.to_owned()`
@@ -44,32 +58,55 @@ fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
                 return;
             }
             match expr.node {
-
                 // `format!("{}", foo)` expansion
-                ExprCall(ref fun, ref args) => {
+                ExprKind::Call(ref fun, ref args) => {
                     if_chain! {
-                        if let ExprPath(ref qpath) = fun.node;
+                        if let ExprKind::Path(ref qpath) = fun.node;
                         if args.len() == 3;
                         if let Some(fun_def_id) = opt_def_id(resolve_node(cx, qpath, fun.hir_id));
                         if match_def_path(cx.tcx, fun_def_id, &paths::FMT_ARGUMENTS_NEWV1FORMATTED);
                         if check_single_piece(&args[0]);
                         if let Some(format_arg) = get_single_string_arg(cx, &args[1]);
                         if check_unformatted(&args[2]);
+                        if let ExprKind::AddrOf(_, ref format_arg) = format_arg.node;
                         then {
-                            let sugg = format!("{}.to_string()", snippet(cx, format_arg, "<arg>").into_owned());
+                            let (message, sugg) = if_chain! {
+                                if let ExprKind::MethodCall(ref path, _, _) = format_arg.node;
+                                if path.ident.as_interned_str() == "to_string";
+                                then {
+                                    ("`to_string()` is enough",
+                                    snippet(cx, format_arg.span, "<arg>").to_string())
+                                } else {
+                                    ("consider using .to_string()",
+                                    format!("{}.to_string()", snippet(cx, format_arg.span, "<arg>")))
+                                }
+                            };
+
                             span_lint_and_then(cx, USELESS_FORMAT, span, "useless use of `format!`", |db| {
-                                db.span_suggestion(expr.span, "consider using .to_string()", sugg);
+                                db.span_suggestion_with_applicability(
+                                    expr.span,
+                                    message,
+                                    sugg,
+                                    Applicability::MachineApplicable,
+                                );
                             });
                         }
                     }
                 },
                 // `format!("foo")` expansion contains `match () { () => [], }`
-                ExprMatch(ref matchee, _, _) => if let ExprTup(ref tup) = matchee.node {
-                    if tup.is_empty() {
-                        let sugg = format!("{}.to_string()", snippet(cx, expr.span, "<expr>").into_owned());
-                        span_lint_and_then(cx, USELESS_FORMAT, span, "useless use of `format!`", |db| {
-                            db.span_suggestion(span, "consider using .to_string()", sugg);
-                        });
+                ExprKind::Match(ref matchee, _, _) => {
+                    if let ExprKind::Tup(ref tup) = matchee.node {
+                        if tup.is_empty() {
+                            let sugg = format!("{}.to_string()", snippet(cx, expr.span, "<expr>").into_owned());
+                            span_lint_and_then(cx, USELESS_FORMAT, span, "useless use of `format!`", |db| {
+                                db.span_suggestion_with_applicability(
+                                    span,
+                                    "consider using .to_string()",
+                                    sugg,
+                                    Applicability::MachineApplicable, // snippet
+                                );
+                            });
+                        }
                     }
                 },
                 _ => (),
@@ -81,10 +118,10 @@ fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
 /// Checks if the expressions matches `&[""]`
 fn check_single_piece(expr: &Expr) -> bool {
     if_chain! {
-        if let ExprAddrOf(_, ref expr) = expr.node; // &[""]
-        if let ExprArray(ref exprs) = expr.node; // [""]
+        if let ExprKind::AddrOf(_, ref expr) = expr.node; // &[""]
+        if let ExprKind::Array(ref exprs) = expr.node; // [""]
         if exprs.len() == 1;
-        if let ExprLit(ref lit) = exprs[0].node;
+        if let ExprKind::Lit(ref lit) = exprs[0].node;
         if let LitKind::Str(ref lit, _) = lit.node;
         then {
             return lit.as_str().is_empty();
@@ -101,28 +138,28 @@ fn check_single_piece(expr: &Expr) -> bool {
 /// ::std::fmt::Display::fmt)],
 /// }
 /// ```
-/// and that type of `__arg0` is `&str` or `String`
-/// then returns the span of first element of the matched tuple
-fn get_single_string_arg(cx: &LateContext, expr: &Expr) -> Option<Span> {
+/// and that the type of `__arg0` is `&str` or `String`,
+/// then returns the span of first element of the matched tuple.
+fn get_single_string_arg<'a>(cx: &LateContext<'_, '_>, expr: &'a Expr) -> Option<&'a Expr> {
     if_chain! {
-        if let ExprAddrOf(_, ref expr) = expr.node;
-        if let ExprMatch(ref match_expr, ref arms, _) = expr.node;
+        if let ExprKind::AddrOf(_, ref expr) = expr.node;
+        if let ExprKind::Match(ref match_expr, ref arms, _) = expr.node;
         if arms.len() == 1;
         if arms[0].pats.len() == 1;
         if let PatKind::Tuple(ref pat, None) = arms[0].pats[0].node;
         if pat.len() == 1;
-        if let ExprArray(ref exprs) = arms[0].body.node;
+        if let ExprKind::Array(ref exprs) = arms[0].body.node;
         if exprs.len() == 1;
-        if let ExprCall(_, ref args) = exprs[0].node;
+        if let ExprKind::Call(_, ref args) = exprs[0].node;
         if args.len() == 2;
-        if let ExprPath(ref qpath) = args[1].node;
+        if let ExprKind::Path(ref qpath) = args[1].node;
         if let Some(fun_def_id) = opt_def_id(resolve_node(cx, qpath, args[1].hir_id));
         if match_def_path(cx.tcx, fun_def_id, &paths::DISPLAY_FMT_METHOD);
         then {
             let ty = walk_ptrs_ty(cx.tables.pat_ty(&pat[0]));
-            if ty.sty == ty::TyStr || match_type(cx, ty, &paths::STRING) {
-                if let ExprTup(ref values) = match_expr.node {
-                    return Some(values[0].span);
+            if ty.sty == ty::Str || match_type(cx, ty, &paths::STRING) {
+                if let ExprKind::Tup(ref values) = match_expr.node {
+                    return Some(&values[0]);
                 }
             }
         }
@@ -143,15 +180,18 @@ fn get_single_string_arg(cx: &LateContext, expr: &Expr) -> Option<Span> {
 /// ```
 fn check_unformatted(expr: &Expr) -> bool {
     if_chain! {
-        if let ExprAddrOf(_, ref expr) = expr.node;
-        if let ExprArray(ref exprs) = expr.node;
+        if let ExprKind::AddrOf(_, ref expr) = expr.node;
+        if let ExprKind::Array(ref exprs) = expr.node;
         if exprs.len() == 1;
-        if let ExprStruct(_, ref fields, _) = exprs[0].node;
+        if let ExprKind::Struct(_, ref fields, _) = exprs[0].node;
         if let Some(format_field) = fields.iter().find(|f| f.ident.name == "format");
-        if let ExprStruct(_, ref fields, _) = format_field.expr.node;
-        if let Some(align_field) = fields.iter().find(|f| f.ident.name == "width");
-        if let ExprPath(ref qpath) = align_field.expr.node;
-        if last_path_segment(qpath).name == "Implied";
+        if let ExprKind::Struct(_, ref fields, _) = format_field.expr.node;
+        if let Some(width_field) = fields.iter().find(|f| f.ident.name == "width");
+        if let ExprKind::Path(ref width_qpath) = width_field.expr.node;
+        if last_path_segment(width_qpath).ident.name == "Implied";
+        if let Some(precision_field) = fields.iter().find(|f| f.ident.name == "precision");
+        if let ExprKind::Path(ref precision_path) = precision_field.expr.node;
+        if last_path_segment(precision_path).ident.name == "Implied";
         then {
             return true;
         }