1 use super::method::probe::{IsSuggestion, Mode, ProbeScope};
2 use super::method::MethodCallee;
3 use super::{Expectation, FnCtxt, TupleArgumentsFlag};
4 use crate::type_error_struct;
6 use rustc_ast::util::parser::PREC_POSTFIX;
7 use rustc_errors::{struct_span_err, Applicability, Diagnostic, StashKey};
9 use rustc_hir::def::{self, Namespace, Res};
10 use rustc_hir::def_id::DefId;
13 traits::{self, Obligation},
16 infer::type_variable::{TypeVariableOrigin, TypeVariableOriginKind},
17 traits::ObligationCause,
19 use rustc_middle::ty::adjustment::{
20 Adjust, Adjustment, AllowTwoPhase, AutoBorrow, AutoBorrowMutability,
22 use rustc_middle::ty::SubstsRef;
23 use rustc_middle::ty::{self, Ty, TyCtxt, TypeVisitable};
24 use rustc_span::def_id::LocalDefId;
25 use rustc_span::symbol::{sym, Ident};
27 use rustc_target::spec::abi;
28 use rustc_trait_selection::autoderef::Autoderef;
29 use rustc_trait_selection::infer::InferCtxtExt as _;
30 use rustc_trait_selection::traits::error_reporting::DefIdOrName;
31 use rustc_trait_selection::traits::query::evaluate_obligation::InferCtxtExt as _;
35 /// Checks that it is legal to call methods of the trait corresponding
36 /// to `trait_id` (this only cares about the trait, not the specific
37 /// method that is called).
38 pub fn check_legal_trait_for_method_call(
41 receiver: Option<Span>,
45 if tcx.lang_items().drop_trait() == Some(trait_id) {
46 let mut err = struct_span_err!(tcx.sess, span, E0040, "explicit use of destructor method");
47 err.span_label(span, "explicit destructor calls not allowed");
49 let (sp, suggestion) = receiver
50 .and_then(|s| tcx.sess.source_map().span_to_snippet(s).ok())
51 .filter(|snippet| !snippet.is_empty())
52 .map(|snippet| (expr_span, format!("drop({snippet})")))
53 .unwrap_or_else(|| (span, "drop".to_string()));
57 "consider using `drop` function",
59 Applicability::MaybeIncorrect,
69 DeferredClosure(LocalDefId, ty::FnSig<'tcx>),
70 /// E.g., enum variant constructors.
71 Overloaded(MethodCallee<'tcx>),
74 impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
77 call_expr: &'tcx hir::Expr<'tcx>,
78 callee_expr: &'tcx hir::Expr<'tcx>,
79 arg_exprs: &'tcx [hir::Expr<'tcx>],
80 expected: Expectation<'tcx>,
82 let original_callee_ty = match &callee_expr.kind {
83 hir::ExprKind::Path(hir::QPath::Resolved(..) | hir::QPath::TypeRelative(..)) => self
84 .check_expr_with_expectation_and_args(
86 Expectation::NoExpectation,
89 _ => self.check_expr(callee_expr),
92 let expr_ty = self.structurally_resolved_type(call_expr.span, original_callee_ty);
94 let mut autoderef = self.autoderef(callee_expr.span, expr_ty);
95 let mut result = None;
96 while result.is_none() && autoderef.next().is_some() {
97 result = self.try_overloaded_call_step(call_expr, callee_expr, arg_exprs, &autoderef);
99 self.register_predicates(autoderef.into_obligations());
101 let output = match result {
103 // this will report an error since original_callee_ty is not a fn
104 self.confirm_builtin_call(
113 Some(CallStep::Builtin(callee_ty)) => {
114 self.confirm_builtin_call(call_expr, callee_expr, callee_ty, arg_exprs, expected)
117 Some(CallStep::DeferredClosure(def_id, fn_sig)) => {
118 self.confirm_deferred_closure_call(call_expr, arg_exprs, expected, def_id, fn_sig)
121 Some(CallStep::Overloaded(method_callee)) => {
122 self.confirm_overloaded_call(call_expr, arg_exprs, expected, method_callee)
126 // we must check that return type of called functions is WF:
127 self.register_wf_obligation(output.into(), call_expr.span, traits::WellFormed(None));
132 fn try_overloaded_call_step(
134 call_expr: &'tcx hir::Expr<'tcx>,
135 callee_expr: &'tcx hir::Expr<'tcx>,
136 arg_exprs: &'tcx [hir::Expr<'tcx>],
137 autoderef: &Autoderef<'a, 'tcx>,
138 ) -> Option<CallStep<'tcx>> {
140 self.structurally_resolved_type(autoderef.span(), autoderef.final_ty(false));
142 "try_overloaded_call_step(call_expr={:?}, adjusted_ty={:?})",
143 call_expr, adjusted_ty
146 // If the callee is a bare function or a closure, then we're all set.
147 match *adjusted_ty.kind() {
148 ty::FnDef(..) | ty::FnPtr(_) => {
149 let adjustments = self.adjust_steps(autoderef);
150 self.apply_adjustments(callee_expr, adjustments);
151 return Some(CallStep::Builtin(adjusted_ty));
154 ty::Closure(def_id, substs) => {
155 let def_id = def_id.expect_local();
157 // Check whether this is a call to a closure where we
158 // haven't yet decided on whether the closure is fn vs
159 // fnmut vs fnonce. If so, we have to defer further processing.
160 if self.closure_kind(substs).is_none() {
161 let closure_sig = substs.as_closure().sig();
162 let closure_sig = self.replace_bound_vars_with_fresh_vars(
167 let adjustments = self.adjust_steps(autoderef);
168 self.record_deferred_call_resolution(
170 DeferredCallResolution {
176 closure_substs: substs,
179 return Some(CallStep::DeferredClosure(def_id, closure_sig));
183 // Hack: we know that there are traits implementing Fn for &F
184 // where F:Fn and so forth. In the particular case of types
185 // like `x: &mut FnMut()`, if there is a call `x()`, we would
186 // normally translate to `FnMut::call_mut(&mut x, ())`, but
187 // that winds up requiring `mut x: &mut FnMut()`. A little
188 // over the top. The simplest fix by far is to just ignore
189 // this case and deref again, so we wind up with
190 // `FnMut::call_mut(&mut *x, ())`.
191 ty::Ref(..) if autoderef.step_count() == 0 => {
202 // Now, we look for the implementation of a Fn trait on the object's type.
203 // We first do it with the explicit instruction to look for an impl of
204 // `Fn<Tuple>`, with the tuple `Tuple` having an arity corresponding
205 // to the number of call parameters.
206 // If that fails (or_else branch), we try again without specifying the
207 // shape of the tuple (hence the None). This allows to detect an Fn trait
208 // is implemented, and use this information for diagnostic.
209 self.try_overloaded_call_traits(call_expr, adjusted_ty, Some(arg_exprs))
210 .or_else(|| self.try_overloaded_call_traits(call_expr, adjusted_ty, None))
211 .map(|(autoref, method)| {
212 let mut adjustments = self.adjust_steps(autoderef);
213 adjustments.extend(autoref);
214 self.apply_adjustments(callee_expr, adjustments);
215 CallStep::Overloaded(method)
219 fn try_overloaded_call_traits(
221 call_expr: &hir::Expr<'_>,
222 adjusted_ty: Ty<'tcx>,
223 opt_arg_exprs: Option<&'tcx [hir::Expr<'tcx>]>,
224 ) -> Option<(Option<Adjustment<'tcx>>, MethodCallee<'tcx>)> {
225 // Try the options that are least restrictive on the caller first.
226 for (opt_trait_def_id, method_name, borrow) in [
227 (self.tcx.lang_items().fn_trait(), Ident::with_dummy_span(sym::call), true),
228 (self.tcx.lang_items().fn_mut_trait(), Ident::with_dummy_span(sym::call_mut), true),
229 (self.tcx.lang_items().fn_once_trait(), Ident::with_dummy_span(sym::call_once), false),
231 let Some(trait_def_id) = opt_trait_def_id else { continue };
233 let opt_input_types = opt_arg_exprs.map(|arg_exprs| {
234 [self.tcx.mk_tup(arg_exprs.iter().map(|e| {
235 self.next_ty_var(TypeVariableOrigin {
236 kind: TypeVariableOriginKind::TypeInference,
241 let opt_input_types = opt_input_types.as_ref().map(AsRef::as_ref);
243 if let Some(ok) = self.lookup_method_in_trait(
250 let method = self.register_infer_ok_obligations(ok);
251 let mut autoref = None;
253 // Check for &self vs &mut self in the method signature. Since this is either
254 // the Fn or FnMut trait, it should be one of those.
255 let ty::Ref(region, _, mutbl) = method.sig.inputs()[0].kind() else {
256 // The `fn`/`fn_mut` lang item is ill-formed, which should have
257 // caused an error elsewhere.
260 .delay_span_bug(call_expr.span, "input to call/call_mut is not a ref?");
264 let mutbl = match mutbl {
265 hir::Mutability::Not => AutoBorrowMutability::Not,
266 hir::Mutability::Mut => AutoBorrowMutability::Mut {
267 // For initial two-phase borrow
268 // deployment, conservatively omit
269 // overloaded function call ops.
270 allow_two_phase_borrow: AllowTwoPhase::No,
273 autoref = Some(Adjustment {
274 kind: Adjust::Borrow(AutoBorrow::Ref(*region, mutbl)),
275 target: method.sig.inputs()[0],
278 return Some((autoref, method));
285 /// Give appropriate suggestion when encountering `||{/* not callable */}()`, where the
286 /// likely intention is to call the closure, suggest `(||{})()`. (#55851)
287 fn identify_bad_closure_def_and_call(
289 err: &mut Diagnostic,
291 callee_node: &hir::ExprKind<'_>,
294 let hir = self.tcx.hir();
295 let parent_hir_id = hir.get_parent_node(hir_id);
296 let parent_node = hir.get(parent_hir_id);
298 hir::Node::Expr(hir::Expr {
299 kind: hir::ExprKind::Closure(&hir::Closure { fn_decl_span, body, .. }),
302 hir::ExprKind::Block(..),
303 ) = (parent_node, callee_node)
305 let fn_decl_span = if hir.body(body).generator_kind
306 == Some(hir::GeneratorKind::Async(hir::AsyncGeneratorKind::Closure))
308 // Actually need to unwrap a few more layers of HIR to get to
309 // the _real_ closure...
310 let async_closure = hir.get_parent_node(hir.get_parent_node(parent_hir_id));
311 if let hir::Node::Expr(hir::Expr {
312 kind: hir::ExprKind::Closure(&hir::Closure { fn_decl_span, .. }),
314 }) = hir.get(async_closure)
324 let start = fn_decl_span.shrink_to_lo();
325 let end = callee_span.shrink_to_hi();
326 err.multipart_suggestion(
327 "if you meant to create this closure and immediately call it, surround the \
328 closure with parentheses",
329 vec![(start, "(".to_string()), (end, ")".to_string())],
330 Applicability::MaybeIncorrect,
335 /// Give appropriate suggestion when encountering `[("a", 0) ("b", 1)]`, where the
336 /// likely intention is to create an array containing tuples.
337 fn maybe_suggest_bad_array_definition(
339 err: &mut Diagnostic,
340 call_expr: &'tcx hir::Expr<'tcx>,
341 callee_expr: &'tcx hir::Expr<'tcx>,
343 let hir_id = self.tcx.hir().get_parent_node(call_expr.hir_id);
344 let parent_node = self.tcx.hir().get(hir_id);
346 hir::Node::Expr(hir::Expr { kind: hir::ExprKind::Array(_), .. }),
347 hir::ExprKind::Tup(exp),
348 hir::ExprKind::Call(_, args),
349 ) = (parent_node, &callee_expr.kind, &call_expr.kind)
350 && args.len() == exp.len()
352 let start = callee_expr.span.shrink_to_hi();
355 "consider separating array elements with a comma",
357 Applicability::MaybeIncorrect,
364 fn confirm_builtin_call(
366 call_expr: &'tcx hir::Expr<'tcx>,
367 callee_expr: &'tcx hir::Expr<'tcx>,
369 arg_exprs: &'tcx [hir::Expr<'tcx>],
370 expected: Expectation<'tcx>,
372 let (fn_sig, def_id) = match *callee_ty.kind() {
373 ty::FnDef(def_id, subst) => {
374 let fn_sig = self.tcx.bound_fn_sig(def_id).subst(self.tcx, subst);
376 // Unit testing: function items annotated with
377 // `#[rustc_evaluate_where_clauses]` trigger special output
378 // to let us test the trait evaluation system.
379 if self.tcx.has_attr(def_id, sym::rustc_evaluate_where_clauses) {
380 let predicates = self.tcx.predicates_of(def_id);
381 let predicates = predicates.instantiate(self.tcx, subst);
382 for (predicate, predicate_span) in
383 predicates.predicates.iter().zip(&predicates.spans)
385 let obligation = Obligation::new(
386 ObligationCause::dummy_with_span(callee_expr.span),
390 let result = self.evaluate_obligation(&obligation);
395 &format!("evaluate({:?}) = {:?}", predicate, result),
397 .span_label(*predicate_span, "predicate")
401 (fn_sig, Some(def_id))
403 ty::FnPtr(sig) => (sig, None),
405 if let hir::ExprKind::Path(hir::QPath::Resolved(_, path)) = &callee_expr.kind
406 && let [segment] = path.segments
407 && let Some(mut diag) = self
411 .steal_diagnostic(segment.ident.span, StashKey::CallIntoMethod)
413 // Try suggesting `foo(a)` -> `a.foo()` if possible.
415 self.suggest_call_as_method(
430 self.report_invalid_callee(call_expr, callee_expr, callee_ty, arg_exprs);
432 // This is the "default" function signature, used in case of error.
433 // In that case, we check each argument against "error" in order to
434 // set up all the node type bindings.
436 ty::Binder::dummy(self.tcx.mk_fn_sig(
437 self.err_args(arg_exprs.len()).into_iter(),
440 hir::Unsafety::Normal,
448 // Replace any late-bound regions that appear in the function
449 // signature with region variables. We also have to
450 // renormalize the associated types at this point, since they
451 // previously appeared within a `Binder<>` and hence would not
452 // have been normalized before.
453 let fn_sig = self.replace_bound_vars_with_fresh_vars(call_expr.span, infer::FnCall, fn_sig);
454 let fn_sig = self.normalize_associated_types_in(call_expr.span, fn_sig);
456 // Call the generic checker.
457 let expected_arg_tys = self.expected_inputs_for_expected_output(
463 self.check_argument_types(
470 TupleArgumentsFlag::DontTupleArguments,
477 /// Attempts to reinterpret `method(rcvr, args...)` as `rcvr.method(args...)`
478 /// and suggesting the fix if the method probe is successful.
479 fn suggest_call_as_method(
481 diag: &mut Diagnostic,
482 segment: &'tcx hir::PathSegment<'tcx>,
483 arg_exprs: &'tcx [hir::Expr<'tcx>],
484 call_expr: &'tcx hir::Expr<'tcx>,
485 expected: Expectation<'tcx>,
486 ) -> Option<Ty<'tcx>> {
487 if let [callee_expr, rest @ ..] = arg_exprs {
488 let callee_ty = self.check_expr(callee_expr);
489 // First, do a probe with `IsSuggestion(true)` to avoid emitting
490 // any strange errors. If it's successful, then we'll do a true
500 // We didn't record the in scope traits during late resolution
501 // so we need to probe AllTraits unfortunately
502 ProbeScope::AllTraits,
507 let pick = self.confirm_method(
515 if pick.illegal_sized_bound.is_some() {
519 let up_to_rcvr_span = segment.ident.span.until(callee_expr.span);
520 let rest_span = callee_expr.span.shrink_to_hi().to(call_expr.span.shrink_to_hi());
521 let rest_snippet = if let Some(first) = rest.first() {
525 .span_to_snippet(first.span.to(call_expr.span.shrink_to_hi()))
530 if let Ok(rest_snippet) = rest_snippet {
531 let sugg = if callee_expr.precedence().order() >= PREC_POSTFIX {
533 (up_to_rcvr_span, "".to_string()),
534 (rest_span, format!(".{}({rest_snippet}", segment.ident)),
538 (up_to_rcvr_span, "(".to_string()),
539 (rest_span, format!(").{}({rest_snippet}", segment.ident)),
542 let self_ty = self.resolve_vars_if_possible(pick.callee.sig.inputs()[0]);
543 diag.multipart_suggestion(
545 "use the `.` operator to call the method `{}{}` on `{self_ty}`",
547 .associated_item(pick.callee.def_id)
548 .trait_container(self.tcx)
551 |trait_def_id| self.tcx.def_path_str(trait_def_id) + "::"
556 Applicability::MaybeIncorrect,
559 // Let's check the method fully now
560 let return_ty = self.check_method_argument_types(
565 TupleArgumentsFlag::DontTupleArguments,
569 return Some(return_ty);
576 fn report_invalid_callee(
578 call_expr: &'tcx hir::Expr<'tcx>,
579 callee_expr: &'tcx hir::Expr<'tcx>,
581 arg_exprs: &'tcx [hir::Expr<'tcx>],
583 let mut unit_variant = None;
584 if let hir::ExprKind::Path(qpath) = &callee_expr.kind
585 && let Res::Def(def::DefKind::Ctor(kind, def::CtorKind::Const), _)
586 = self.typeck_results.borrow().qpath_res(qpath, callee_expr.hir_id)
587 // Only suggest removing parens if there are no arguments
588 && arg_exprs.is_empty()
590 let descr = match kind {
591 def::CtorOf::Struct => "struct",
592 def::CtorOf::Variant => "enum variant",
594 let removal_span = callee_expr.span.shrink_to_hi().to(call_expr.span.shrink_to_hi());
595 unit_variant = Some((removal_span, descr, rustc_hir_pretty::qpath_to_string(qpath)));
598 let callee_ty = self.resolve_vars_if_possible(callee_ty);
599 let mut err = type_error_struct!(
604 "expected function, found {}",
605 match &unit_variant {
606 Some((_, kind, path)) => format!("{kind} `{path}`"),
607 None => format!("`{callee_ty}`"),
611 self.identify_bad_closure_def_and_call(
618 if let Some((removal_span, kind, path)) = &unit_variant {
619 err.span_suggestion_verbose(
622 "`{path}` is a unit {kind}, and does not take parentheses to be constructed",
625 Applicability::MachineApplicable,
629 let mut inner_callee_path = None;
630 let def = match callee_expr.kind {
631 hir::ExprKind::Path(ref qpath) => {
632 self.typeck_results.borrow().qpath_res(qpath, callee_expr.hir_id)
634 hir::ExprKind::Call(ref inner_callee, _) => {
635 // If the call spans more than one line and the callee kind is
636 // itself another `ExprCall`, that's a clue that we might just be
637 // missing a semicolon (Issue #51055)
638 let call_is_multiline = self.tcx.sess.source_map().is_multiline(call_expr.span);
639 if call_is_multiline {
641 callee_expr.span.shrink_to_hi(),
642 "consider using a semicolon here",
644 Applicability::MaybeIncorrect,
647 if let hir::ExprKind::Path(ref inner_qpath) = inner_callee.kind {
648 inner_callee_path = Some(inner_qpath);
649 self.typeck_results.borrow().qpath_res(inner_qpath, inner_callee.hir_id)
657 if !self.maybe_suggest_bad_array_definition(&mut err, call_expr, callee_expr) {
658 if let Some((maybe_def, output_ty, _)) =
659 self.extract_callable_info(callee_expr, callee_ty)
660 && !self.type_is_sized_modulo_regions(self.param_env, output_ty, callee_expr.span)
662 let descr = match maybe_def {
663 DefIdOrName::DefId(def_id) => self.tcx.def_kind(def_id).descr(def_id),
664 DefIdOrName::Name(name) => name,
668 format!("this {descr} returns an unsized value `{output_ty}`, so it cannot be called")
670 if let DefIdOrName::DefId(def_id) = maybe_def
671 && let Some(def_span) = self.tcx.hir().span_if_local(def_id)
673 err.span_label(def_span, "the callable type is defined here");
676 err.span_label(call_expr.span, "call expression requires function");
680 if let Some(span) = self.tcx.hir().res_span(def) {
681 let callee_ty = callee_ty.to_string();
682 let label = match (unit_variant, inner_callee_path) {
683 (Some((_, kind, path)), _) => Some(format!("{kind} `{path}` defined here")),
684 (_, Some(hir::QPath::Resolved(_, path))) => self
688 .span_to_snippet(path.span)
690 .map(|p| format!("`{p}` defined here returns `{callee_ty}`")),
693 // Emit a different diagnostic for local variables, as they are not
694 // type definitions themselves, but rather variables *of* that type.
695 Res::Local(hir_id) => Some(format!(
696 "`{}` has type `{}`",
697 self.tcx.hir().name(hir_id),
700 Res::Def(kind, def_id) if kind.ns() == Some(Namespace::ValueNS) => {
701 Some(format!("`{}` defined here", self.tcx.def_path_str(def_id),))
703 _ => Some(format!("`{callee_ty}` defined here")),
707 if let Some(label) = label {
708 err.span_label(span, label);
714 fn confirm_deferred_closure_call(
716 call_expr: &'tcx hir::Expr<'tcx>,
717 arg_exprs: &'tcx [hir::Expr<'tcx>],
718 expected: Expectation<'tcx>,
719 closure_def_id: LocalDefId,
720 fn_sig: ty::FnSig<'tcx>,
722 // `fn_sig` is the *signature* of the closure being called. We
723 // don't know the full details yet (`Fn` vs `FnMut` etc), but we
724 // do know the types expected for each argument and the return
727 let expected_arg_tys = self.expected_inputs_for_expected_output(
734 self.check_argument_types(
741 TupleArgumentsFlag::TupleArguments,
742 Some(closure_def_id.to_def_id()),
748 fn confirm_overloaded_call(
750 call_expr: &'tcx hir::Expr<'tcx>,
751 arg_exprs: &'tcx [hir::Expr<'tcx>],
752 expected: Expectation<'tcx>,
753 method_callee: MethodCallee<'tcx>,
755 let output_type = self.check_method_argument_types(
760 TupleArgumentsFlag::TupleArguments,
764 self.write_method_call(call_expr.hir_id, method_callee);
770 pub struct DeferredCallResolution<'tcx> {
771 call_expr: &'tcx hir::Expr<'tcx>,
772 callee_expr: &'tcx hir::Expr<'tcx>,
773 adjusted_ty: Ty<'tcx>,
774 adjustments: Vec<Adjustment<'tcx>>,
775 fn_sig: ty::FnSig<'tcx>,
776 closure_substs: SubstsRef<'tcx>,
779 impl<'a, 'tcx> DeferredCallResolution<'tcx> {
780 pub fn resolve(self, fcx: &FnCtxt<'a, 'tcx>) {
781 debug!("DeferredCallResolution::resolve() {:?}", self);
783 // we should not be invoked until the closure kind has been
784 // determined by upvar inference
785 assert!(fcx.closure_kind(self.closure_substs).is_some());
787 // We may now know enough to figure out fn vs fnmut etc.
788 match fcx.try_overloaded_call_traits(self.call_expr, self.adjusted_ty, None) {
789 Some((autoref, method_callee)) => {
790 // One problem is that when we get here, we are going
791 // to have a newly instantiated function signature
792 // from the call trait. This has to be reconciled with
793 // the older function signature we had before. In
794 // principle we *should* be able to fn_sigs(), but we
795 // can't because of the annoying need for a TypeTrace.
796 // (This always bites me, should find a way to
798 let method_sig = method_callee.sig;
800 debug!("attempt_resolution: method_callee={:?}", method_callee);
802 for (method_arg_ty, self_arg_ty) in
803 iter::zip(method_sig.inputs().iter().skip(1), self.fn_sig.inputs())
805 fcx.demand_eqtype(self.call_expr.span, *self_arg_ty, *method_arg_ty);
808 fcx.demand_eqtype(self.call_expr.span, method_sig.output(), self.fn_sig.output());
810 let mut adjustments = self.adjustments;
811 adjustments.extend(autoref);
812 fcx.apply_adjustments(self.callee_expr, adjustments);
814 fcx.write_method_call(self.call_expr.hir_id, method_callee);
817 // This can happen if `#![no_core]` is used and the `fn/fn_mut/fn_once`
818 // lang items are not defined (issue #86238).
819 let mut err = fcx.inh.tcx.sess.struct_span_err(
821 "failed to find an overloaded call trait for closure call",
824 "make sure the `fn`/`fn_mut`/`fn_once` lang items are defined \
825 and have associated `call`/`call_mut`/`call_once` functions",