rust-clippy/clippy_lints/src/fallible_impl_from.rs

145 lines
5.1 KiB
Rust
Raw Normal View History

use crate::utils::{is_expn_of, is_type_diagnostic_item, match_panic_def_id, method_chain_args, span_lint_and_then};
2018-11-27 20:14:15 +00:00
use if_chain::if_chain;
2020-01-06 16:39:50 +00:00
use rustc_hir as hir;
2020-01-12 06:08:41 +00:00
use rustc_lint::{LateContext, LateLintPass};
use rustc_middle::hir::map::Map;
use rustc_middle::ty;
2020-01-11 11:37:08 +00:00
use rustc_session::{declare_lint_pass, declare_tool_lint};
use rustc_span::{sym, Span};
2017-10-16 21:06:31 +00:00
2018-03-28 13:24:26 +00:00
declare_clippy_lint! {
/// **What it does:** Checks for impls of `From<..>` that contain `panic!()` or `unwrap()`
///
/// **Why is this bad?** `TryFrom` should be used if there's a possibility of failure.
///
/// **Known problems:** None.
///
/// **Example:**
/// ```rust
/// struct Foo(i32);
///
/// // Bad
/// impl From<String> for Foo {
/// fn from(s: String) -> Self {
/// Foo(s.parse().unwrap())
/// }
/// }
/// ```
///
/// ```rust
/// // Good
/// struct Foo(i32);
///
/// use std::convert::TryFrom;
/// impl TryFrom<String> for Foo {
/// type Error = ();
/// fn try_from(s: String) -> Result<Self, Self::Error> {
/// if let Ok(parsed) = s.parse() {
/// Ok(Foo(parsed))
/// } else {
/// Err(())
/// }
/// }
/// }
/// ```
2018-03-28 13:24:26 +00:00
pub FALLIBLE_IMPL_FROM,
nursery,
2017-10-17 16:09:10 +00:00
"Warn on impls of `From<..>` that contain `panic!()` or `unwrap()`"
2017-10-16 21:06:31 +00:00
}
2019-04-08 20:43:55 +00:00
declare_lint_pass!(FallibleImplFrom => [FALLIBLE_IMPL_FROM]);
2017-10-16 21:06:31 +00:00
impl<'tcx> LateLintPass<'tcx> for FallibleImplFrom {
fn check_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx hir::Item<'_>) {
2017-10-16 21:06:31 +00:00
// check for `impl From<???> for ..`
if_chain! {
if let hir::ItemKind::Impl(impl_) = &item.kind;
if let Some(impl_trait_ref) = cx.tcx.impl_trait_ref(item.def_id);
if cx.tcx.is_diagnostic_item(sym::from_trait, impl_trait_ref.def_id);
then {
lint_impl_body(cx, item.span, impl_.items);
}
}
2017-10-16 21:06:31 +00:00
}
}
fn lint_impl_body<'tcx>(cx: &LateContext<'tcx>, impl_span: Span, impl_items: &[hir::ImplItemRef<'_>]) {
2020-01-09 07:13:22 +00:00
use rustc_hir::intravisit::{self, NestedVisitorMap, Visitor};
2020-02-21 08:39:38 +00:00
use rustc_hir::{Expr, ExprKind, ImplItemKind, QPath};
2017-10-16 21:06:31 +00:00
struct FindPanicUnwrap<'a, 'tcx> {
lcx: &'a LateContext<'tcx>,
2020-07-17 08:47:04 +00:00
typeck_results: &'tcx ty::TypeckResults<'tcx>,
2017-10-16 21:06:31 +00:00
result: Vec<Span>,
}
impl<'a, 'tcx> Visitor<'tcx> for FindPanicUnwrap<'a, 'tcx> {
2020-01-09 07:13:22 +00:00
type Map = Map<'tcx>;
2019-12-27 07:12:26 +00:00
fn visit_expr(&mut self, expr: &'tcx Expr<'_>) {
2017-10-16 21:06:31 +00:00
// check for `begin_panic`
if_chain! {
2019-09-27 15:16:06 +00:00
if let ExprKind::Call(ref func_expr, _) = expr.kind;
if let ExprKind::Path(QPath::Resolved(_, ref path)) = func_expr.kind;
if let Some(path_def_id) = path.res.opt_def_id();
if match_panic_def_id(self.lcx, path_def_id);
2019-05-17 21:53:54 +00:00
if is_expn_of(expr.span, "unreachable").is_none();
then {
self.result.push(expr.span);
}
}
2017-10-16 21:06:31 +00:00
// check for `unwrap`
2019-05-17 21:53:54 +00:00
if let Some(arglists) = method_chain_args(expr, &["unwrap"]) {
let reciever_ty = self.typeck_results.expr_ty(&arglists[0][0]).peel_refs();
if is_type_diagnostic_item(self.lcx, reciever_ty, sym::option_type)
|| is_type_diagnostic_item(self.lcx, reciever_ty, sym::result_type)
2020-04-12 13:23:54 +00:00
{
2017-10-16 21:06:31 +00:00
self.result.push(expr.span);
}
}
// and check sub-expressions
intravisit::walk_expr(self, expr);
}
fn nested_visit_map(&mut self) -> NestedVisitorMap<Self::Map> {
2017-10-16 21:06:31 +00:00
NestedVisitorMap::None
}
}
for impl_item in impl_items {
if_chain! {
if impl_item.ident.name == sym::from;
if let ImplItemKind::Fn(_, body_id) =
2019-09-27 15:16:06 +00:00
cx.tcx.hir().impl_item(impl_item.id).kind;
then {
// check the body for `begin_panic` or `unwrap`
let body = cx.tcx.hir().body(body_id);
let impl_item_def_id = cx.tcx.hir().local_def_id(impl_item.id.hir_id);
let mut fpu = FindPanicUnwrap {
lcx: cx,
2020-07-17 08:47:04 +00:00
typeck_results: cx.tcx.typeck(impl_item_def_id),
result: Vec::new(),
};
fpu.visit_expr(&body.value);
2017-11-04 19:55:56 +00:00
// if we've found one, lint
if !fpu.result.is_empty() {
span_lint_and_then(
cx,
FALLIBLE_IMPL_FROM,
impl_span,
"consider implementing `TryFrom` instead",
move |diag| {
diag.help(
"`From` is intended for infallible conversions only. \
Use `TryFrom` if there's a possibility for the conversion to fail.");
diag.span_note(fpu.result, "potential failure(s)");
});
}
2017-10-16 21:06:31 +00:00
}
}
2017-10-16 21:06:31 +00:00
}
}