+use matches::matches;
use rustc::hir;
use rustc::lint::*;
+use rustc::{declare_lint, lint_array};
+use if_chain::if_chain;
use rustc::ty::{self, Ty};
use rustc::hir::def::Def;
use std::borrow::Cow;
use std::iter;
use syntax::ast;
use syntax::codemap::{Span, BytePos};
-use crate::utils::{get_arg_name, get_trait_def_id, implements_trait, in_external_macro, in_macro, is_copy, is_self, is_self_ty,
- iter_input_pats, last_path_segment, match_def_path, match_path, match_qpath, match_trait_method,
+use crate::utils::{get_arg_name, get_trait_def_id, implements_trait, in_external_macro, in_macro, is_copy, is_expn_of, is_self,
+ is_self_ty, iter_input_pats, last_path_segment, match_def_path, match_path, match_qpath, match_trait_method,
match_type, method_chain_args, match_var, return_ty, remove_blocks, same_tys, single_segment_path, snippet,
- span_lint, span_lint_and_sugg, span_lint_and_then, span_note_and_lint, walk_ptrs_ty, walk_ptrs_ty_depth};
+ span_lint, span_lint_and_sugg, span_lint_and_then, span_note_and_lint, walk_ptrs_ty, walk_ptrs_ty_depth, SpanlessEq};
use crate::utils::paths;
use crate::utils::sugg;
use crate::consts::{constant, Constant};
"using any `*or` method with a function call, which suggests `*or_else`"
}
+/// **What it does:** Checks for calls to `.expect(&format!(...))`, `.expect(foo(..))`,
+/// etc., and suggests to use `unwrap_or_else` instead
+///
+/// **Why is this bad?** The function will always be called.
+///
+/// **Known problems:** If the function has side-effects, not calling it will
+/// change the semantic of the program, but you shouldn't rely on that anyway.
+///
+/// **Example:**
+/// ```rust
+/// foo.expect(&format("Err {}: {}", err_code, err_msg))
+/// ```
+/// or
+/// ```rust
+/// foo.expect(format("Err {}: {}", err_code, err_msg).as_str())
+/// ```
+/// this can instead be written:
+/// ```rust
+/// foo.unwrap_or_else(|_| panic!("Err {}: {}", err_code, err_msg))
+/// ```
+/// or
+/// ```rust
+/// foo.unwrap_or_else(|_| panic!(format("Err {}: {}", err_code, err_msg).as_str()))
+/// ```
+declare_clippy_lint! {
+ pub EXPECT_FUN_CALL,
+ perf,
+ "using any `expect` method with a function call"
+}
+
/// **What it does:** Checks for usage of `.clone()` on a `Copy` type.
///
/// **Why is this bad?** The only reason `Copy` types implement `Clone` is for
RESULT_MAP_UNWRAP_OR_ELSE,
OPTION_MAP_OR_NONE,
OR_FUN_CALL,
+ EXPECT_FUN_CALL,
CHARS_NEXT_CMP,
CHARS_LAST_CMP,
CLONE_ON_COPY,
}
match expr.node {
- hir::ExprMethodCall(ref method_call, ref method_span, ref args) => {
+ hir::ExprKind::MethodCall(ref method_call, ref method_span, ref args) => {
// Chain calls
// GET_UNWRAP needs to be checked before general `UNWRAP` lints
if let Some(arglists) = method_chain_args(expr, &["get", "unwrap"]) {
lint_unnecessary_fold(cx, expr, arglists[0]);
}
- lint_or_fun_call(cx, expr, *method_span, &method_call.name.as_str(), args);
+ lint_or_fun_call(cx, expr, *method_span, &method_call.ident.as_str(), args);
+ lint_expect_fun_call(cx, expr, *method_span, &method_call.ident.as_str(), args);
let self_ty = cx.tables.expr_ty_adjusted(&args[0]);
- if args.len() == 1 && method_call.name == "clone" {
+ if args.len() == 1 && method_call.ident.name == "clone" {
lint_clone_on_copy(cx, expr, &args[0], self_ty);
lint_clone_on_ref_ptr(cx, expr, &args[0]);
}
match self_ty.sty {
ty::TyRef(_, ty, _) if ty.sty == ty::TyStr => for &(method, pos) in &PATTERN_METHODS {
- if method_call.name == method && args.len() > pos {
+ if method_call.ident.name == method && args.len() > pos {
lint_single_char_pattern(cx, expr, &args[pos]);
}
},
_ => (),
}
},
- hir::ExprBinary(op, ref lhs, ref rhs) if op.node == hir::BiEq || op.node == hir::BiNe => {
+ hir::ExprKind::Binary(op, ref lhs, ref rhs) if op.node == hir::BinOpKind::Eq || op.node == hir::BinOpKind::Ne => {
let mut info = BinaryExprInfo {
expr,
chain: lhs,
other: rhs,
- eq: op.node == hir::BiEq,
+ eq: op.node == hir::BinOpKind::Eq,
};
lint_binary_expr_with_method_call(cx, &mut info);
},
if in_external_macro(cx, implitem.span) {
return;
}
- let name = implitem.name;
+ let name = implitem.ident.name;
let parent = cx.tcx.hir.get_parent(implitem.id);
let item = cx.tcx.hir.expect_item(parent);
if_chain! {
if let hir::ImplItemKind::Method(ref sig, id) = implitem.node;
if let Some(first_arg_ty) = sig.decl.inputs.get(0);
if let Some(first_arg) = iter_input_pats(&sig.decl, cx.tcx.hir.body(id)).next();
- if let hir::ItemImpl(_, _, _, _, None, ref self_ty, _) = item.node;
+ if let hir::ItemKind::Impl(_, _, _, _, None, ref self_ty, _) = item.node;
then {
if cx.access_levels.is_exported(implitem.id) {
// check missing trait implementations
for &(method_name, n_args, self_kind, out_type, trait_name) in &TRAIT_METHODS {
if name == method_name &&
sig.decl.inputs.len() == n_args &&
- out_type.matches(&sig.decl.output) &&
- self_kind.matches(first_arg_ty, first_arg, self_ty, false, &implitem.generics) {
+ out_type.matches(cx, &sig.decl.output) &&
+ self_kind.matches(cx, first_arg_ty, first_arg, self_ty, false, &implitem.generics) {
span_lint(cx, SHOULD_IMPLEMENT_TRAIT, implitem.span, &format!(
"defining a method called `{}` on this type; consider implementing \
the `{}` trait or choosing a less ambiguous name", name, trait_name));
if conv.check(&name.as_str());
if !self_kinds
.iter()
- .any(|k| k.matches(first_arg_ty, first_arg, self_ty, is_copy, &implitem.generics));
+ .any(|k| k.matches(cx, first_arg_ty, first_arg, self_ty, is_copy, &implitem.generics));
then {
- let lint = if item.vis == hir::Visibility::Public {
+ let lint = if item.vis.node.is_pub() {
WRONG_PUB_SELF_CONVENTION
} else {
WRONG_SELF_CONVENTION
}
if name == "unwrap_or" {
- if let hir::ExprPath(ref qpath) = fun.node {
- let path = &*last_path_segment(qpath).name.as_str();
+ if let hir::ExprKind::Path(ref qpath) = fun.node {
+ let path = &*last_path_segment(qpath).ident.as_str();
if ["default", "new"].contains(&path) {
let arg_ty = cx.tables.expr_ty(arg);
if args.len() == 2 {
match args[1].node {
- hir::ExprCall(ref fun, ref or_args) => {
+ hir::ExprKind::Call(ref fun, ref or_args) => {
let or_has_args = !or_args.is_empty();
if !check_unwrap_or_default(cx, name, fun, &args[0], &args[1], or_has_args, expr.span) {
check_general_case(cx, name, method_span, fun.span, &args[0], &args[1], or_has_args, expr.span);
}
},
- hir::ExprMethodCall(_, span, ref or_args) => {
+ hir::ExprKind::MethodCall(_, span, ref or_args) => {
check_general_case(cx, name, method_span, span, &args[0], &args[1], !or_args.is_empty(), expr.span)
},
_ => {},
}
}
+/// Checks for the `EXPECT_FUN_CALL` lint.
+fn lint_expect_fun_call(cx: &LateContext, expr: &hir::Expr, method_span: Span, name: &str, args: &[hir::Expr]) {
+ fn extract_format_args(arg: &hir::Expr) -> Option<&hir::HirVec<hir::Expr>> {
+ if let hir::ExprKind::AddrOf(_, ref addr_of) = arg.node {
+ if let hir::ExprKind::Call(ref inner_fun, ref inner_args) = addr_of.node {
+ if is_expn_of(inner_fun.span, "format").is_some() && inner_args.len() == 1 {
+ if let hir::ExprKind::Call(_, ref format_args) = inner_args[0].node {
+ return Some(format_args);
+ }
+ }
+ }
+ }
+
+ None
+ }
+
+ fn generate_format_arg_snippet(cx: &LateContext, a: &hir::Expr) -> String {
+ if let hir::ExprKind::AddrOf(_, ref format_arg) = a.node {
+ if let hir::ExprKind::Match(ref format_arg_expr, _, _) = format_arg.node {
+ if let hir::ExprKind::Tup(ref format_arg_expr_tup) = format_arg_expr.node {
+ return snippet(cx, format_arg_expr_tup[0].span, "..").into_owned();
+ }
+ }
+ };
+
+ snippet(cx, a.span, "..").into_owned()
+ }
+
+ fn check_general_case(
+ cx: &LateContext,
+ name: &str,
+ method_span: Span,
+ self_expr: &hir::Expr,
+ arg: &hir::Expr,
+ span: Span,
+ ) {
+ if name != "expect" {
+ return;
+ }
+
+ let self_type = cx.tables.expr_ty(self_expr);
+ let known_types = &[&paths::OPTION, &paths::RESULT];
+
+ // if not a known type, return early
+ if known_types.iter().all(|&k| !match_type(cx, self_type, k)) {
+ return;
+ }
+
+ // don't lint for constant values
+ let owner_def = cx.tcx.hir.get_parent_did(arg.id);
+ let promotable = cx.tcx.rvalue_promotable_map(owner_def).contains(&arg.hir_id.local_id);
+ if promotable {
+ return;
+ }
+
+ let closure = if match_type(cx, self_type, &paths::OPTION) { "||" } else { "|_|" };
+ let span_replace_word = method_span.with_hi(span.hi());
+
+ if let Some(format_args) = extract_format_args(arg) {
+ let args_len = format_args.len();
+ let args: Vec<String> = format_args
+ .into_iter()
+ .take(args_len - 1)
+ .map(|a| generate_format_arg_snippet(cx, a))
+ .collect();
+
+ let sugg = args.join(", ");
+
+ span_lint_and_sugg(
+ cx,
+ EXPECT_FUN_CALL,
+ span_replace_word,
+ &format!("use of `{}` followed by a function call", name),
+ "try this",
+ format!("unwrap_or_else({} panic!({}))", closure, sugg),
+ );
+
+ return;
+ }
+
+ let sugg: Cow<_> = snippet(cx, arg.span, "..");
+
+ span_lint_and_sugg(
+ cx,
+ EXPECT_FUN_CALL,
+ span_replace_word,
+ &format!("use of `{}` followed by a function call", name),
+ "try this",
+ format!("unwrap_or_else({} panic!({}))", closure, sugg),
+ );
+ }
+
+ if args.len() == 2 {
+ match args[1].node {
+ hir::ExprKind::Lit(_) => {},
+ _ => check_general_case(cx, name, method_span, &args[0], &args[1], expr.span),
+ }
+ }
+}
+
/// Checks for the `CLONE_ON_COPY` lint.
fn lint_clone_on_copy(cx: &LateContext, expr: &hir::Expr, arg: &hir::Expr, arg_ty: Ty) {
let ty = cx.tables.expr_ty(expr);
match cx.tcx.hir.get(parent) {
hir::map::NodeExpr(parent) => match parent.node {
// &*x is a nop, &x.clone() is not
- hir::ExprAddrOf(..) |
+ hir::ExprKind::AddrOf(..) |
// (*x).func() is useless, x.clone().func() can work in case func borrows mutably
- hir::ExprMethodCall(..) => return,
+ hir::ExprKind::MethodCall(..) => return,
_ => {},
}
hir::map::NodeStmt(stmt) => {
- if let hir::StmtDecl(ref decl, _) = stmt.node {
- if let hir::DeclLocal(ref loc) = decl.node {
+ if let hir::StmtKind::Decl(ref decl, _) = stmt.node {
+ if let hir::DeclKind::Local(ref loc) = decl.node {
if let hir::PatKind::Ref(..) = loc.pat.node {
// let ref y = *x borrows x, let ref y = x.clone() does not
return;
fn lint_cstring_as_ptr(cx: &LateContext, expr: &hir::Expr, new: &hir::Expr, unwrap: &hir::Expr) {
if_chain! {
- if let hir::ExprCall(ref fun, ref args) = new.node;
+ if let hir::ExprKind::Call(ref fun, ref args) = new.node;
if args.len() == 1;
- if let hir::ExprPath(ref path) = fun.node;
+ if let hir::ExprKind::Path(ref path) = fun.node;
if let Def::Method(did) = cx.tables.qpath_def(path, fun.hir_id);
if match_def_path(cx.tcx, did, &paths::CSTRING_NEW);
then {
fn check_fold_with_op(
cx: &LateContext,
fold_args: &[hir::Expr],
- op: hir::BinOp_,
+ op: hir::BinOpKind,
replacement_method_name: &str,
replacement_has_args: bool) {
if_chain! {
// Extract the body of the closure passed to fold
- if let hir::ExprClosure(_, _, body_id, _, _) = fold_args[2].node;
+ if let hir::ExprKind::Closure(_, _, body_id, _, _) = fold_args[2].node;
let closure_body = cx.tcx.hir.body(body_id);
let closure_expr = remove_blocks(&closure_body.value);
// Check if the closure body is of the form `acc <op> some_expr(x)`
- if let hir::ExprBinary(ref bin_op, ref left_expr, ref right_expr) = closure_expr.node;
+ if let hir::ExprKind::Binary(ref bin_op, ref left_expr, ref right_expr) = closure_expr.node;
if bin_op.node == op;
// Extract the names of the two arguments to the closure
// Check if the first argument to .fold is a suitable literal
match fold_args[1].node {
- hir::ExprLit(ref lit) => {
+ hir::ExprKind::Lit(ref lit) => {
match lit.node {
ast::LitKind::Bool(false) => check_fold_with_op(
- cx, fold_args, hir::BinOp_::BiOr, "any", true
+ cx, fold_args, hir::BinOpKind::Or, "any", true
),
ast::LitKind::Bool(true) => check_fold_with_op(
- cx, fold_args, hir::BinOp_::BiAnd, "all", true
+ cx, fold_args, hir::BinOpKind::And, "all", true
),
ast::LitKind::Int(0, _) => check_fold_with_op(
- cx, fold_args, hir::BinOp_::BiAdd, "sum", false
+ cx, fold_args, hir::BinOpKind::Add, "sum", false
),
ast::LitKind::Int(1, _) => check_fold_with_op(
- cx, fold_args, hir::BinOp_::BiMul, "product", false
+ cx, fold_args, hir::BinOpKind::Mul, "product", false
),
_ => return
}
}
}
- if let hir::ExprMethodCall(ref path, _, ref args) = expr.node {
- if path.name == "iter" && may_slice(cx, cx.tables.expr_ty(&args[0])) {
+ if let hir::ExprKind::MethodCall(ref path, _, ref args) = expr.node {
+ if path.ident.name == "iter" && may_slice(cx, cx.tables.expr_ty(&args[0])) {
sugg::Sugg::hir_opt(cx, &args[0]).map(|sugg| sugg.addr())
} else {
None
fn lint_map_or_none<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx hir::Expr, map_or_args: &'tcx [hir::Expr]) {
if match_type(cx, cx.tables.expr_ty(&map_or_args[0]), &paths::OPTION) {
// check if the first non-self argument to map_or() is None
- let map_or_arg_is_none = if let hir::Expr_::ExprPath(ref qpath) = map_or_args[1].node {
+ let map_or_arg_is_none = if let hir::ExprKind::Path(ref qpath) = map_or_args[1].node {
match_qpath(qpath, &paths::OPTION_NONE)
} else {
false
) -> bool {
if_chain! {
if let Some(args) = method_chain_args(info.chain, chain_methods);
- if let hir::ExprCall(ref fun, ref arg_char) = info.other.node;
+ if let hir::ExprKind::Call(ref fun, ref arg_char) = info.other.node;
if arg_char.len() == 1;
- if let hir::ExprPath(ref qpath) = fun.node;
+ if let hir::ExprKind::Path(ref qpath) = fun.node;
if let Some(segment) = single_segment_path(qpath);
- if segment.name == "Some";
+ if segment.ident.name == "Some";
then {
let self_ty = walk_ptrs_ty(cx.tables.expr_ty_adjusted(&args[0][0]));
) -> bool {
if_chain! {
if let Some(args) = method_chain_args(info.chain, chain_methods);
- if let hir::ExprLit(ref lit) = info.other.node;
+ if let hir::ExprKind::Lit(ref lit) = info.other.node;
if let ast::LitKind::Char(c) = lit.node;
then {
span_lint_and_sugg(
impl SelfKind {
fn matches(
self,
+ cx: &LateContext,
ty: &hir::Ty,
arg: &hir::Arg,
self_ty: &hir::Ty,
// `Self`, `&mut Self`,
// and `Box<Self>`, including the equivalent types with `Foo`.
- let is_actually_self = |ty| is_self_ty(ty) || ty == self_ty;
+ let is_actually_self = |ty| is_self_ty(ty) || SpanlessEq::new(cx).eq_ty(ty, self_ty);
if is_self(arg) {
match self {
SelfKind::Value => is_actually_self(ty),
return true;
}
match ty.node {
- hir::TyRptr(_, ref mt_ty) => {
+ hir::TyKind::Rptr(_, ref mt_ty) => {
let mutability_match = if self == SelfKind::Ref {
mt_ty.mutbl == hir::MutImmutable
} else {
}
}
- fn description(&self) -> &'static str {
- match *self {
+ fn description(self) -> &'static str {
+ match self {
SelfKind::Value => "self by value",
SelfKind::Ref => "self by reference",
SelfKind::RefMut => "self by mutable reference",
fn is_as_ref_or_mut_trait(ty: &hir::Ty, self_ty: &hir::Ty, generics: &hir::Generics, name: &[&str]) -> bool {
single_segment_ty(ty).map_or(false, |seg| {
- generics.ty_params().any(|param| {
- param.name == seg.name && param.bounds.iter().any(|bound| {
- if let hir::TyParamBound::TraitTyParamBound(ref ptr, ..) = *bound {
- let path = &ptr.trait_ref.path;
- match_path(path, name) && path.segments.last().map_or(false, |s| {
- if let Some(ref params) = s.parameters {
- if params.parenthesized {
- false
+ generics.params.iter().any(|param| match param.kind {
+ hir::GenericParamKind::Type { .. } => {
+ param.name.ident().name == seg.ident.name && param.bounds.iter().any(|bound| {
+ if let hir::GenericBound::Trait(ref ptr, ..) = *bound {
+ let path = &ptr.trait_ref.path;
+ match_path(path, name) && path.segments.last().map_or(false, |s| {
+ if let Some(ref params) = s.args {
+ if params.parenthesized {
+ false
+ } else {
+ // FIXME(flip1995): messy, improve if there is a better option
+ // in the compiler
+ let types: Vec<_> = params.args.iter().filter_map(|arg| match arg {
+ hir::GenericArg::Type(ty) => Some(ty),
+ _ => None,
+ }).collect();
+ types.len() == 1
+ && (is_self_ty(&types[0]) || is_ty(&*types[0], self_ty))
+ }
} else {
- params.types.len() == 1
- && (is_self_ty(¶ms.types[0]) || is_ty(&*params.types[0], self_ty))
+ false
}
- } else {
- false
- }
- })
- } else {
- false
- }
- })
+ })
+ } else {
+ false
+ }
+ })
+ },
+ _ => false,
})
})
}
fn is_ty(ty: &hir::Ty, self_ty: &hir::Ty) -> bool {
match (&ty.node, &self_ty.node) {
(
- &hir::TyPath(hir::QPath::Resolved(_, ref ty_path)),
- &hir::TyPath(hir::QPath::Resolved(_, ref self_ty_path)),
+ &hir::TyKind::Path(hir::QPath::Resolved(_, ref ty_path)),
+ &hir::TyKind::Path(hir::QPath::Resolved(_, ref self_ty_path)),
) => ty_path
.segments
.iter()
- .map(|seg| seg.name)
- .eq(self_ty_path.segments.iter().map(|seg| seg.name)),
+ .map(|seg| seg.ident.name)
+ .eq(self_ty_path.segments.iter().map(|seg| seg.ident.name)),
_ => false,
}
}
fn single_segment_ty(ty: &hir::Ty) -> Option<&hir::PathSegment> {
- if let hir::TyPath(ref path) = ty.node {
+ if let hir::TyKind::Path(ref path) = ty.node {
single_segment_path(path)
} else {
None
}
impl OutType {
- fn matches(&self, ty: &hir::FunctionRetTy) -> bool {
+ fn matches(self, cx: &LateContext, ty: &hir::FunctionRetTy) -> bool {
+ let is_unit = |ty: &hir::Ty| SpanlessEq::new(cx).eq_ty_kind(&ty.node, &hir::TyKind::Tup(vec![].into()));
match (self, ty) {
- (&OutType::Unit, &hir::DefaultReturn(_)) => true,
- (&OutType::Unit, &hir::Return(ref ty)) if ty.node == hir::TyTup(vec![].into()) => true,
- (&OutType::Bool, &hir::Return(ref ty)) if is_bool(ty) => true,
- (&OutType::Any, &hir::Return(ref ty)) if ty.node != hir::TyTup(vec![].into()) => true,
- (&OutType::Ref, &hir::Return(ref ty)) => matches!(ty.node, hir::TyRptr(_, _)),
+ (OutType::Unit, &hir::DefaultReturn(_)) => true,
+ (OutType::Unit, &hir::Return(ref ty)) if is_unit(ty) => true,
+ (OutType::Bool, &hir::Return(ref ty)) if is_bool(ty) => true,
+ (OutType::Any, &hir::Return(ref ty)) if !is_unit(ty) => true,
+ (OutType::Ref, &hir::Return(ref ty)) => matches!(ty.node, hir::TyKind::Rptr(_, _)),
_ => false,
}
}
}
fn is_bool(ty: &hir::Ty) -> bool {
- if let hir::TyPath(ref p) = ty.node {
+ if let hir::TyKind::Path(ref p) = ty.node {
match_qpath(p, &["bool"])
} else {
false
projects / rust.git / blobdiff