rust-clippy/clippy_lints/src/format.rs

205 lines
7.9 KiB
Rust
Raw Normal View History

2018-05-30 08:15:50 +00:00
use crate::utils::paths;
2019-08-23 08:46:23 +00:00
use crate::utils::{
is_expn_of, last_path_segment, match_def_path, match_type, resolve_node, snippet, span_lint_and_then, walk_ptrs_ty,
};
2018-11-27 20:14:15 +00:00
use if_chain::if_chain;
use rustc::hir::*;
2019-02-24 05:30:08 +00:00
use rustc::lint::{LateContext, LateLintPass, LintArray, LintContext, LintPass};
2019-04-08 20:43:55 +00:00
use rustc::{declare_lint_pass, declare_tool_lint};
use rustc_errors::Applicability;
use syntax::ast::LitKind;
2019-02-24 05:30:08 +00:00
use syntax::source_map::Span;
2018-03-28 13:24:26 +00:00
declare_clippy_lint! {
/// **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!("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()`
/// if `foo: &str`.
///
/// **Known problems:** None.
///
/// **Examples:**
/// ```rust
/// # let foo = "foo";
/// format!("foo");
/// format!("{}", foo);
/// ```
pub USELESS_FORMAT,
2018-03-28 13:24:26 +00:00
complexity,
"useless use of `format!`"
}
2019-04-08 20:43:55 +00:00
declare_lint_pass!(UselessFormat => [USELESS_FORMAT]);
2019-04-08 20:43:55 +00:00
impl<'a, 'tcx> LateLintPass<'a, 'tcx> for UselessFormat {
fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) {
2019-08-23 05:26:24 +00:00
let span = match is_expn_of(expr.span, "format") {
Some(s) if !s.from_expansion() => s,
_ => return,
};
2019-08-23 05:26:24 +00:00
// Operate on the only argument of `alloc::fmt::format`.
if let Some(sugg) = on_new_v1(cx, expr) {
span_useless_format(cx, span, "consider using .to_string()", sugg);
} else if let Some(sugg) = on_new_v1_fmt(cx, expr) {
span_useless_format(cx, span, "consider using .to_string()", sugg);
}
}
}
2016-02-20 20:15:05 +00:00
2019-06-12 03:07:48 +00:00
fn span_useless_format<T: LintContext>(cx: &T, span: Span, help: &str, mut sugg: String) {
2019-02-24 05:30:08 +00:00
let to_replace = span.source_callsite();
// The callsite span contains the statement semicolon for some reason.
let snippet = snippet(cx, to_replace, "..");
if snippet.ends_with(';') {
sugg.push(';');
}
span_lint_and_then(cx, USELESS_FORMAT, span, "useless use of `format!`", |db| {
db.span_suggestion(
to_replace,
help,
sugg,
Applicability::MachineApplicable, // snippet
);
});
}
2019-08-23 05:26:24 +00:00
fn on_argumentv1_new<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr, arms: &'a [Arm]) -> Option<String> {
if_chain! {
2019-08-23 05:26:24 +00:00
if let ExprKind::AddrOf(_, ref format_args) = expr.node;
if let ExprKind::Array(ref elems) = arms[0].body.node;
if elems.len() == 1;
if let ExprKind::Call(ref fun, ref args) = elems[0].node;
if let ExprKind::Path(ref qpath) = fun.node;
if let Some(did) = resolve_node(cx, qpath, fun.hir_id).opt_def_id();
if match_def_path(cx, did, &paths::FMT_ARGUMENTV1_NEW);
// matches `core::fmt::Display::fmt`
if args.len() == 2;
if let ExprKind::Path(ref qpath) = args[1].node;
if let Some(did) = resolve_node(cx, qpath, args[1].hir_id).opt_def_id();
if match_def_path(cx, did, &paths::DISPLAY_FMT_METHOD);
// check `(arg0,)` in match block
2019-09-25 19:00:17 +00:00
if let PatKind::Tuple(ref pats, None) = arms[0].pat.node;
2019-08-23 05:26:24 +00:00
if pats.len() == 1;
then {
2019-08-23 08:46:23 +00:00
let ty = walk_ptrs_ty(cx.tables.pat_ty(&pats[0]));
if ty.sty != rustc::ty::Str && !match_type(cx, ty, &paths::STRING) {
return None;
}
2019-08-23 05:26:24 +00:00
if let ExprKind::Lit(ref lit) = format_args.node {
if let LitKind::Str(ref s, _) = lit.node {
return Some(format!("{:?}.to_string()", s.as_str()));
2019-08-23 05:26:24 +00:00
}
} else {
let snip = snippet(cx, format_args.span, "<arg>");
if let ExprKind::MethodCall(ref path, _, _) = format_args.node {
if path.ident.name == sym!(to_string) {
return Some(format!("{}", snip));
}
2019-08-23 08:46:23 +00:00
} else if let ExprKind::Binary(..) = format_args.node {
return Some(format!("{}", snip));
2019-08-23 05:26:24 +00:00
}
return Some(format!("{}.to_string()", snip));
}
}
}
2019-08-23 05:26:24 +00:00
None
2016-02-20 20:15:05 +00:00
}
2019-08-23 05:26:24 +00:00
fn on_new_v1<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) -> Option<String> {
if_chain! {
2019-08-23 05:26:24 +00:00
if let ExprKind::Call(ref fun, ref args) = expr.node;
if args.len() == 2;
2019-08-23 05:26:24 +00:00
if let ExprKind::Path(ref qpath) = fun.node;
if let Some(did) = resolve_node(cx, qpath, fun.hir_id).opt_def_id();
if match_def_path(cx, did, &paths::FMT_ARGUMENTS_NEW_V1);
// Argument 1 in `new_v1()`
if let ExprKind::AddrOf(_, ref arr) = args[0].node;
if let ExprKind::Array(ref pieces) = arr.node;
if pieces.len() == 1;
if let ExprKind::Lit(ref lit) = pieces[0].node;
if let LitKind::Str(ref s, _) = lit.node;
// Argument 2 in `new_v1()`
if let ExprKind::AddrOf(_, ref arg1) = args[1].node;
if let ExprKind::Match(ref matchee, ref arms, MatchSource::Normal) = arg1.node;
if arms.len() == 1;
if let ExprKind::Tup(ref tup) = matchee.node;
then {
2019-08-23 05:26:24 +00:00
// `format!("foo")` expansion contains `match () { () => [], }`
if tup.is_empty() {
return Some(format!("{:?}.to_string()", s.as_str()));
} else if s.as_str().is_empty() {
return on_argumentv1_new(cx, &tup[0], arms);
}
}
}
2019-08-23 05:26:24 +00:00
None
}
2019-08-23 05:26:24 +00:00
fn on_new_v1_fmt<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx Expr) -> Option<String> {
if_chain! {
if let ExprKind::Call(ref fun, ref args) = expr.node;
if args.len() == 3;
if let ExprKind::Path(ref qpath) = fun.node;
if let Some(did) = resolve_node(cx, qpath, fun.hir_id).opt_def_id();
if match_def_path(cx, did, &paths::FMT_ARGUMENTS_NEW_V1_FORMATTED);
if check_unformatted(&args[2]);
// Argument 1 in `new_v1_formatted()`
if let ExprKind::AddrOf(_, ref arr) = args[0].node;
if let ExprKind::Array(ref pieces) = arr.node;
if pieces.len() == 1;
if let ExprKind::Lit(ref lit) = pieces[0].node;
if let LitKind::Str(..) = lit.node;
// Argument 2 in `new_v1_formatted()`
if let ExprKind::AddrOf(_, ref arg1) = args[1].node;
if let ExprKind::Match(ref matchee, ref arms, MatchSource::Normal) = arg1.node;
if arms.len() == 1;
if let ExprKind::Tup(ref tup) = matchee.node;
then {
return on_argumentv1_new(cx, &tup[0], arms);
}
}
None
}
2017-11-04 19:55:56 +00:00
/// Checks if the expression matches
/// ```rust,ignore
/// &[_ {
/// format: _ {
/// width: _::Implied,
2019-08-23 05:26:24 +00:00
/// precision: _::Implied,
/// ...
/// },
/// ...,
/// }]
/// ```
fn check_unformatted(expr: &Expr) -> bool {
if_chain! {
2018-07-12 07:30:57 +00:00
if let ExprKind::AddrOf(_, ref expr) = expr.node;
if let ExprKind::Array(ref exprs) = expr.node;
if exprs.len() == 1;
2019-08-23 05:26:24 +00:00
// struct `core::fmt::rt::v1::Argument`
2018-07-12 07:30:57 +00:00
if let ExprKind::Struct(_, ref fields, _) = exprs[0].node;
2019-05-17 21:53:54 +00:00
if let Some(format_field) = fields.iter().find(|f| f.ident.name == sym!(format));
2019-08-23 05:26:24 +00:00
// struct `core::fmt::rt::v1::FormatSpec`
2018-07-12 07:30:57 +00:00
if let ExprKind::Struct(_, ref fields, _) = format_field.expr.node;
2019-05-17 21:53:54 +00:00
if let Some(precision_field) = fields.iter().find(|f| f.ident.name == sym!(precision));
if let ExprKind::Path(ref precision_path) = precision_field.expr.node;
2019-05-17 21:53:54 +00:00
if last_path_segment(precision_path).ident.name == sym!(Implied);
2019-08-23 05:26:24 +00:00
if let Some(width_field) = fields.iter().find(|f| f.ident.name == sym!(width));
if let ExprKind::Path(ref width_qpath) = width_field.expr.node;
if last_path_segment(width_qpath).ident.name == sym!(Implied);
then {
return true;
}
}
2016-02-20 20:15:05 +00:00
false
}