2 use rustc::hir::map::Node::NodeItem;
4 use rustc::ty::TypeVariants;
5 use syntax::ast::LitKind;
6 use syntax::symbol::InternedString;
8 use utils::{is_expn_of, match_def_path, match_type, resolve_node, span_lint, walk_ptrs_ty};
10 /// **What it does:** Checks for the use of `format!("string literal with no
11 /// argument")` and `format!("{}", foo)` where `foo` is a string.
13 /// **Why is this bad?** There is no point of doing that. `format!("too")` can
14 /// be replaced by `"foo".to_owned()` if you really need a `String`. The even
15 /// worse `&format!("foo")` is often encountered in the wild. `format!("{}",
16 /// foo)` can be replaced by `foo.clone()` if `foo: String` or `foo.to_owned()`
19 /// **Known problems:** None.
24 /// format!("{}", foo)
29 "useless use of `format!`"
32 #[derive(Copy, Clone, Debug)]
35 impl LintPass for Pass {
36 fn get_lints(&self) -> LintArray {
37 lint_array![USELESS_FORMAT]
41 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Pass {
42 fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
43 if let Some(span) = is_expn_of(cx, expr.span, "format") {
45 // `format!("{}", foo)` expansion
46 ExprCall(ref fun, ref args) => {
48 let ExprPath(ref qpath) = fun.node,
50 match_def_path(cx, resolve_node(cx, qpath, fun.id).def_id(), &paths::FMT_ARGUMENTS_NEWV1),
51 // ensure the format string is `"{..}"` with only one argument and no text
52 check_static_str(cx, &args[0]),
53 // ensure the format argument is `{}` ie. Display with no fancy option
54 check_arg_is_display(cx, &args[1])
56 span_lint(cx, USELESS_FORMAT, span, "useless use of `format!`");
59 // `format!("foo")` expansion contains `match () { () => [], }`
60 ExprMatch(ref matchee, _, _) => {
61 if let ExprTup(ref tup) = matchee.node {
63 span_lint(cx, USELESS_FORMAT, span, "useless use of `format!`");
73 /// Returns the slice of format string parts in an `Arguments::new_v1` call.
74 /// Public because it's shared with a lint in print.rs.
75 pub fn get_argument_fmtstr_parts<'a, 'b>(cx: &LateContext<'a, 'b>, expr: &'a Expr)
76 -> Option<Vec<InternedString>> {
78 let ExprBlock(ref block) = expr.node,
79 block.stmts.len() == 1,
80 let StmtDecl(ref decl, _) = block.stmts[0].node,
81 let DeclItem(ref decl) = decl.node,
82 let Some(NodeItem(decl)) = cx.tcx.map.find(decl.id),
83 &*decl.name.as_str() == "__STATIC_FMTSTR",
84 let ItemStatic(_, _, ref expr) = decl.node,
85 let ExprAddrOf(_, ref expr) = expr.node, // &["…", "…", …]
86 let ExprArray(ref exprs) = expr.node,
88 let mut result = Vec::new();
90 if let ExprLit(ref lit) = expr.node {
91 if let LitKind::Str(ref lit, _) = lit.node {
92 result.push(lit.as_str());
101 /// Checks if the expressions matches
103 /// { static __STATIC_FMTSTR: … = &["…", "…", …]; __STATIC_FMTSTR }
105 fn check_static_str(cx: &LateContext, expr: &Expr) -> bool {
106 if let Some(expr) = get_argument_fmtstr_parts(cx, expr) {
107 expr.len() == 1 && expr[0].is_empty()
113 /// Checks if the expressions matches
116 /// (__arg0,) => [::std::fmt::ArgumentV1::new(__arg0, ::std::fmt::Display::fmt)],
119 fn check_arg_is_display(cx: &LateContext, expr: &Expr) -> bool {
121 let ExprAddrOf(_, ref expr) = expr.node,
122 let ExprMatch(_, ref arms, _) = expr.node,
124 arms[0].pats.len() == 1,
125 let PatKind::Tuple(ref pat, None) = arms[0].pats[0].node,
127 let ExprArray(ref exprs) = arms[0].body.node,
129 let ExprCall(_, ref args) = exprs[0].node,
131 let ExprPath(ref qpath) = args[1].node,
132 match_def_path(cx, resolve_node(cx, qpath, args[1].id).def_id(), &paths::DISPLAY_FMT_METHOD),
134 let ty = walk_ptrs_ty(cx.tcx.tables().pat_ty(&pat[0]));
136 return ty.sty == TypeVariants::TyStr || match_type(cx, ty, &paths::STRING);