1 use clippy_utils::diagnostics::span_lint_and_then;
2 use clippy_utils::source::snippet;
3 use clippy_utils::{contains_return, in_macro, is_lang_ctor, return_ty, visitors::find_all_ret_expressions};
4 use if_chain::if_chain;
5 use rustc_errors::Applicability;
6 use rustc_hir::intravisit::FnKind;
7 use rustc_hir::LangItem::{OptionSome, ResultOk};
8 use rustc_hir::{Body, ExprKind, FnDecl, HirId, Impl, ItemKind, Node};
9 use rustc_lint::{LateContext, LateLintPass};
11 use rustc_session::{declare_lint_pass, declare_tool_lint};
12 use rustc_span::symbol::sym;
15 declare_clippy_lint! {
16 /// **What it does:** Checks for private functions that only return `Ok` or `Some`.
18 /// **Why is this bad?** It is not meaningful to wrap values when no `None` or `Err` is returned.
20 /// **Known problems:** There can be false positives if the function signature is designed to
21 /// fit some external requirement.
26 /// fn get_cool_number(a: bool, b: bool) -> Option<i32> {
39 /// fn get_cool_number(a: bool, b: bool) -> i32 {
50 pub UNNECESSARY_WRAPS,
52 "functions that only return `Ok` or `Some`"
55 declare_lint_pass!(UnnecessaryWraps => [UNNECESSARY_WRAPS]);
57 impl<'tcx> LateLintPass<'tcx> for UnnecessaryWraps {
60 cx: &LateContext<'tcx>,
61 fn_kind: FnKind<'tcx>,
62 fn_decl: &FnDecl<'tcx>,
67 // Abort if public function/method or closure.
69 FnKind::ItemFn(.., visibility) | FnKind::Method(.., Some(visibility)) => {
70 if visibility.node.is_pub() {
74 FnKind::Closure => return,
75 FnKind::Method(..) => (),
78 // Abort if the method is implementing a trait or of it a trait method.
79 if let Some(Node::Item(item)) = cx.tcx.hir().find(cx.tcx.hir().get_parent_node(hir_id)) {
82 ItemKind::Impl(Impl { of_trait: Some(_), .. }) | ItemKind::Trait(..)
88 // Get the wrapper and inner types, if can't, abort.
89 let (return_type_label, lang_item, inner_type) = if let ty::Adt(adt_def, subst) = return_ty(cx, hir_id).kind() {
90 if cx.tcx.is_diagnostic_item(sym::option_type, adt_def.did) {
91 ("Option", OptionSome, subst.type_at(0))
92 } else if cx.tcx.is_diagnostic_item(sym::result_type, adt_def.did) {
93 ("Result", ResultOk, subst.type_at(0))
101 // Check if all return expression respect the following condition and collect them.
102 let mut suggs = Vec::new();
103 let can_sugg = find_all_ret_expressions(cx, &body.value, |ret_expr| {
105 if !in_macro(ret_expr.span);
106 // Check if a function call.
107 if let ExprKind::Call(func, [arg]) = ret_expr.kind;
108 // Check if OPTION_SOME or RESULT_OK, depending on return type.
109 if let ExprKind::Path(qpath) = &func.kind;
110 if is_lang_ctor(cx, qpath, lang_item);
111 // Make sure the function argument does not contain a return expression.
112 if !contains_return(arg);
117 if inner_type.is_unit() {
120 snippet(cx, arg.span.source_callsite(), "..").to_string()
131 if can_sugg && !suggs.is_empty() {
132 let (lint_msg, return_type_sugg_msg, return_type_sugg, body_sugg_msg) = if inner_type.is_unit() {
134 "this function's return value is unnecessary".to_string(),
135 "remove the return type...".to_string(),
136 snippet(cx, fn_decl.output.span(), "..").to_string(),
137 "...and then remove returned values",
142 "this function's return value is unnecessarily wrapped by `{}`",
145 format!("remove `{}` from the return type...", return_type_label),
146 inner_type.to_string(),
147 "...and then change returning expressions",
151 span_lint_and_then(cx, UNNECESSARY_WRAPS, span, lint_msg.as_str(), |diag| {
152 diag.span_suggestion(
153 fn_decl.output.span(),
154 return_type_sugg_msg.as_str(),
156 Applicability::MaybeIncorrect,
158 diag.multipart_suggestion(body_sugg_msg, suggs, Applicability::MaybeIncorrect);