1 use crate::check::FnCtxt;
2 use rustc::infer::InferOk;
3 use rustc::traits::{self, ObligationCause, ObligationCauseCode};
5 use syntax::symbol::sym;
6 use syntax::util::parser::PREC_POSTFIX;
10 use rustc::hir::{print, lowering::is_range_literal};
11 use rustc::ty::{self, Ty, AssocItem};
12 use rustc::ty::adjustment::AllowTwoPhase;
13 use errors::{Applicability, DiagnosticBuilder};
15 use super::method::probe;
17 impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
18 // Requires that the two types unify, and prints an error message if
20 pub fn demand_suptype(&self, sp: Span, expected: Ty<'tcx>, actual: Ty<'tcx>) {
21 self.demand_suptype_diag(sp, expected, actual).map(|mut e| e.emit());
24 pub fn demand_suptype_diag(&self,
27 actual: Ty<'tcx>) -> Option<DiagnosticBuilder<'tcx>> {
28 let cause = &self.misc(sp);
29 match self.at(cause, self.param_env).sup(expected, actual) {
30 Ok(InferOk { obligations, value: () }) => {
31 self.register_predicates(obligations);
35 Some(self.report_mismatched_types(&cause, expected, actual, e))
40 pub fn demand_eqtype(&self, sp: Span, expected: Ty<'tcx>, actual: Ty<'tcx>) {
41 if let Some(mut err) = self.demand_eqtype_diag(sp, expected, actual) {
46 pub fn demand_eqtype_diag(&self,
49 actual: Ty<'tcx>) -> Option<DiagnosticBuilder<'tcx>> {
50 self.demand_eqtype_with_origin(&self.misc(sp), expected, actual)
53 pub fn demand_eqtype_with_origin(&self,
54 cause: &ObligationCause<'tcx>,
56 actual: Ty<'tcx>) -> Option<DiagnosticBuilder<'tcx>> {
57 match self.at(cause, self.param_env).eq(expected, actual) {
58 Ok(InferOk { obligations, value: () }) => {
59 self.register_predicates(obligations);
63 Some(self.report_mismatched_types(cause, expected, actual, e))
68 pub fn demand_eqtype_pat(
73 match_expr_span: Option<Span>,
75 let cause = if let Some(span) = match_expr_span {
78 ObligationCauseCode::MatchExpressionArmPattern { span, ty: expected },
83 self.demand_eqtype_with_origin(&cause, expected, actual).map(|mut err| err.emit());
87 pub fn demand_coerce(&self,
91 allow_two_phase: AllowTwoPhase)
93 let (ty, err) = self.demand_coerce_diag(expr, checked_ty, expected, allow_two_phase);
94 if let Some(mut err) = err {
100 // Checks that the type of `expr` can be coerced to `expected`.
102 // N.B., this code relies on `self.diverges` to be accurate. In
103 // particular, assignments to `!` will be permitted if the
104 // diverges flag is currently "always".
105 pub fn demand_coerce_diag(&self,
107 checked_ty: Ty<'tcx>,
109 allow_two_phase: AllowTwoPhase)
110 -> (Ty<'tcx>, Option<DiagnosticBuilder<'tcx>>) {
111 let expected = self.resolve_type_vars_with_obligations(expected);
113 let e = match self.try_coerce(expr, checked_ty, expected, allow_two_phase) {
114 Ok(ty) => return (ty, None),
118 let cause = self.misc(expr.span);
119 let expr_ty = self.resolve_type_vars_with_obligations(checked_ty);
120 let mut err = self.report_mismatched_types(&cause, expected, expr_ty, e);
122 if self.is_assign_to_bool(expr, expected) {
123 // Error reported in `check_assign` so avoid emitting error again.
125 return (expected, None)
128 self.suggest_compatible_variants(&mut err, expr, expected, expr_ty);
129 self.suggest_ref_or_into(&mut err, expr, expected, expr_ty);
130 self.suggest_missing_await(&mut err, expr, expected, expr_ty);
132 (expected, Some(err))
135 /// Returns whether the expected type is `bool` and the expression is `x = y`.
136 pub fn is_assign_to_bool(&self, expr: &hir::Expr, expected: Ty<'tcx>) -> bool {
137 if let hir::ExprKind::Assign(..) = expr.node {
138 return expected == self.tcx.types.bool;
143 /// If the expected type is an enum (Issue #55250) with any variants whose
144 /// sole field is of the found type, suggest such variants. (Issue #42764)
145 fn suggest_compatible_variants(
147 err: &mut DiagnosticBuilder<'_>,
152 if let ty::Adt(expected_adt, substs) = expected.sty {
153 if !expected_adt.is_enum() {
157 let mut compatible_variants = expected_adt.variants
159 .filter(|variant| variant.fields.len() == 1)
160 .filter_map(|variant| {
161 let sole_field = &variant.fields[0];
162 let sole_field_ty = sole_field.ty(self.tcx, substs);
163 if self.can_coerce(expr_ty, sole_field_ty) {
164 let variant_path = self.tcx.def_path_str(variant.def_id);
165 // FIXME #56861: DRYer prelude filtering
166 Some(variant_path.trim_start_matches("std::prelude::v1::").to_string())
172 if compatible_variants.peek().is_some() {
173 let expr_text = print::to_string(print::NO_ANN, |s| s.print_expr(expr));
174 let suggestions = compatible_variants
175 .map(|v| format!("{}({})", v, expr_text));
176 let msg = "try using a variant of the expected type";
177 err.span_suggestions(expr.span, msg, suggestions, Applicability::MaybeIncorrect);
182 pub fn get_conversion_methods(&self, span: Span, expected: Ty<'tcx>, checked_ty: Ty<'tcx>)
184 let mut methods = self.probe_for_return_type(span,
185 probe::Mode::MethodCall,
190 self.has_no_input_arg(m) &&
191 self.tcx.get_attrs(m.def_id).iter()
192 // This special internal attribute is used to whitelist
193 // "identity-like" conversion methods to be suggested here.
195 // FIXME (#46459 and #46460): ideally
196 // `std::convert::Into::into` and `std::borrow:ToOwned` would
197 // also be `#[rustc_conversion_suggestion]`, if not for
198 // method-probing false-positives and -negatives (respectively).
200 // FIXME? Other potential candidate methods: `as_ref` and
202 .find(|a| a.check_name(sym::rustc_conversion_suggestion)).is_some()
208 // This function checks if the method isn't static and takes other arguments than `self`.
209 fn has_no_input_arg(&self, method: &AssocItem) -> bool {
211 ty::AssocKind::Method => {
212 self.tcx.fn_sig(method.def_id).inputs().skip_binder().len() == 1
218 /// Identify some cases where `as_ref()` would be appropriate and suggest it.
220 /// Given the following code:
223 /// fn takes_ref(_: &Foo) {}
224 /// let ref opt = Some(Foo);
226 /// opt.map(|arg| takes_ref(arg));
228 /// Suggest using `opt.as_ref().map(|arg| takes_ref(arg));` instead.
230 /// It only checks for `Option` and `Result` and won't work with
232 /// opt.map(|arg| { takes_ref(arg) });
237 ) -> Option<(Span, &'static str, String)> {
238 if let hir::ExprKind::Path(hir::QPath::Resolved(_, ref path)) = expr.node {
239 if let hir::def::Res::Local(id) = path.res {
240 let parent = self.tcx.hir().get_parent_node(id);
241 if let Some(Node::Expr(hir::Expr {
243 node: hir::ExprKind::Closure(_, decl, ..),
245 })) = self.tcx.hir().find(parent) {
246 let parent = self.tcx.hir().get_parent_node(*hir_id);
247 if let (Some(Node::Expr(hir::Expr {
248 node: hir::ExprKind::MethodCall(path, span, expr),
250 })), 1) = (self.tcx.hir().find(parent), decl.inputs.len()) {
251 let self_ty = self.tables.borrow().node_type(expr[0].hir_id);
252 let self_ty = format!("{:?}", self_ty);
253 let name = path.ident.as_str();
254 let is_as_ref_able = (
255 self_ty.starts_with("&std::option::Option") ||
256 self_ty.starts_with("&std::result::Result") ||
257 self_ty.starts_with("std::option::Option") ||
258 self_ty.starts_with("std::result::Result")
259 ) && (name == "map" || name == "and_then");
260 match (is_as_ref_able, self.sess().source_map().span_to_snippet(*span)) {
262 return Some((*span, "consider using `as_ref` instead",
263 format!("as_ref().{}", src)));
274 crate fn is_hir_id_from_struct_pattern_shorthand_field(
279 let cm = self.sess().source_map();
280 let parent_id = self.tcx.hir().get_parent_node(hir_id);
281 if let Some(parent) = self.tcx.hir().find(parent_id) {
282 // Account for fields
283 if let Node::Expr(hir::Expr {
284 node: hir::ExprKind::Struct(_, fields, ..), ..
286 if let Ok(src) = cm.span_to_snippet(sp) {
287 for field in fields {
288 if field.ident.as_str() == src.as_str() && field.is_shorthand {
298 /// This function is used to determine potential "simple" improvements or users' errors and
299 /// provide them useful help. For example:
302 /// fn some_fn(s: &str) {}
304 /// let x = "hey!".to_owned();
305 /// some_fn(x); // error
308 /// No need to find every potential function which could make a coercion to transform a
309 /// `String` into a `&str` since a `&` would do the trick!
311 /// In addition of this check, it also checks between references mutability state. If the
312 /// expected is mutable but the provided isn't, maybe we could just say "Hey, try with
317 checked_ty: Ty<'tcx>,
319 ) -> Option<(Span, &'static str, String)> {
320 let cm = self.sess().source_map();
322 if !cm.span_to_filename(sp).is_real() {
323 // Ignore if span is from within a macro #41858, #58298. We previously used the macro
324 // call span, but that breaks down when the type error comes from multiple calls down.
328 let is_struct_pat_shorthand_field = self.is_hir_id_from_struct_pattern_shorthand_field(
333 // Check the `expn_info()` to see if this is a macro; if so, it's hard to
334 // extract the text and make a good suggestion, so don't bother.
335 let is_macro = sp.ctxt().outer_expn_info().is_some();
337 match (&expr.node, &expected.sty, &checked_ty.sty) {
338 (_, &ty::Ref(_, exp, _), &ty::Ref(_, check, _)) => match (&exp.sty, &check.sty) {
339 (&ty::Str, &ty::Array(arr, _)) |
340 (&ty::Str, &ty::Slice(arr)) if arr == self.tcx.types.u8 => {
341 if let hir::ExprKind::Lit(_) = expr.node {
342 if let Ok(src) = cm.span_to_snippet(sp) {
343 if src.starts_with("b\"") {
345 "consider removing the leading `b`",
346 src[1..].to_string()));
351 (&ty::Array(arr, _), &ty::Str) |
352 (&ty::Slice(arr), &ty::Str) if arr == self.tcx.types.u8 => {
353 if let hir::ExprKind::Lit(_) = expr.node {
354 if let Ok(src) = cm.span_to_snippet(sp) {
355 if src.starts_with("\"") {
357 "consider adding a leading `b`",
358 format!("b{}", src)));
365 (_, &ty::Ref(_, _, mutability), _) => {
366 // Check if it can work when put into a ref. For example:
369 // fn bar(x: &mut i32) {}
372 // bar(&x); // error, expected &mut
374 let ref_ty = match mutability {
375 hir::Mutability::MutMutable => {
376 self.tcx.mk_mut_ref(self.tcx.mk_region(ty::ReStatic), checked_ty)
378 hir::Mutability::MutImmutable => {
379 self.tcx.mk_imm_ref(self.tcx.mk_region(ty::ReStatic), checked_ty)
382 if self.can_coerce(ref_ty, expected) {
383 let mut sugg_sp = sp;
384 if let hir::ExprKind::MethodCall(segment, _sp, args) = &expr.node {
385 let clone_trait = self.tcx.lang_items().clone_trait().unwrap();
386 if let ([arg], Some(true), "clone") = (
388 self.tables.borrow().type_dependent_def_id(expr.hir_id).map(|did| {
389 let ai = self.tcx.associated_item(did);
390 ai.container == ty::TraitContainer(clone_trait)
392 &segment.ident.as_str()[..],
394 // If this expression had a clone call when suggesting borrowing
395 // we want to suggest removing it because it'd now be unecessary.
399 if let Ok(src) = cm.span_to_snippet(sugg_sp) {
400 let needs_parens = match expr.node {
401 // parenthesize if needed (Issue #46756)
402 hir::ExprKind::Cast(_, _) |
403 hir::ExprKind::Binary(_, _, _) => true,
404 // parenthesize borrows of range literals (Issue #54505)
405 _ if is_range_literal(self.tcx.sess, expr) => true,
408 let sugg_expr = if needs_parens {
414 if let Some(sugg) = self.can_use_as_ref(expr) {
417 let field_name = if is_struct_pat_shorthand_field {
418 format!("{}: ", sugg_expr)
422 if let Some(hir::Node::Expr(hir::Expr {
423 node: hir::ExprKind::Assign(left_expr, _),
425 })) = self.tcx.hir().find(
426 self.tcx.hir().get_parent_node(expr.hir_id),
428 if mutability == hir::Mutability::MutMutable {
429 // Found the following case:
430 // fn foo(opt: &mut Option<String>){ opt = None }
433 // consider dereferencing here: `*opt` |
434 // expected mutable reference, found enum `Option`
435 if let Ok(src) = cm.span_to_snippet(left_expr.span) {
438 "consider dereferencing here to assign to the mutable \
439 borrowed piece of memory",
446 return Some(match mutability {
447 hir::Mutability::MutMutable => (
449 "consider mutably borrowing here",
450 format!("{}&mut {}", field_name, sugg_expr),
452 hir::Mutability::MutImmutable => (
454 "consider borrowing here",
455 format!("{}&{}", field_name, sugg_expr),
461 (hir::ExprKind::AddrOf(_, ref expr), _, &ty::Ref(_, checked, _)) if {
462 self.infcx.can_sub(self.param_env, checked, &expected).is_ok() && !is_macro
464 // We have `&T`, check if what was expected was `T`. If so,
465 // we may want to suggest removing a `&`.
466 if !cm.span_to_filename(expr.span).is_real() {
467 if let Ok(code) = cm.span_to_snippet(sp) {
468 if code.chars().next() == Some('&') {
471 "consider removing the borrow",
472 code[1..].to_string(),
478 if let Ok(code) = cm.span_to_snippet(expr.span) {
479 return Some((sp, "consider removing the borrow", code));
482 _ if sp == expr.span && !is_macro => {
483 // Check for `Deref` implementations by constructing a predicate to
484 // prove: `<T as Deref>::Output == U`
485 let deref_trait = self.tcx.lang_items().deref_trait().unwrap();
486 let item_def_id = self.tcx.associated_items(deref_trait).next().unwrap().def_id;
487 let predicate = ty::Predicate::Projection(ty::Binder::bind(ty::ProjectionPredicate {
488 // `<T as Deref>::Output`
489 projection_ty: ty::ProjectionTy {
491 substs: self.tcx.mk_substs_trait(
493 self.fresh_substs_for_item(sp, item_def_id),
501 let obligation = traits::Obligation::new(self.misc(sp), self.param_env, predicate);
502 let impls_deref = self.infcx.predicate_may_hold(&obligation);
504 // For a suggestion to make sense, the type would need to be `Copy`.
505 let is_copy = self.infcx.type_is_copy_modulo_regions(self.param_env, expected, sp);
507 if is_copy && impls_deref {
508 if let Ok(code) = cm.span_to_snippet(sp) {
509 let message = if checked_ty.is_region_ptr() {
510 "consider dereferencing the borrow"
512 "consider dereferencing the type"
514 let suggestion = if is_struct_pat_shorthand_field {
515 format!("{}: *{}", code, code)
519 return Some((sp, message, suggestion));
528 pub fn check_for_cast(
530 err: &mut DiagnosticBuilder<'tcx>,
532 checked_ty: Ty<'tcx>,
533 expected_ty: Ty<'tcx>,
535 if self.tcx.hir().is_const_scope(expr.hir_id) {
536 // Shouldn't suggest `.into()` on `const`s.
537 // FIXME(estebank): modify once we decide to suggest `as` casts
541 // If casting this expression to a given numeric type would be appropriate in case of a type
544 // We want to minimize the amount of casting operations that are suggested, as it can be a
545 // lossy operation with potentially bad side effects, so we only suggest when encountering
546 // an expression that indicates that the original type couldn't be directly changed.
548 // For now, don't suggest casting with `as`.
549 let can_cast = false;
551 let mut prefix = String::new();
552 if let Some(hir::Node::Expr(hir::Expr {
553 node: hir::ExprKind::Struct(_, fields, _),
555 })) = self.tcx.hir().find(self.tcx.hir().get_parent_node(expr.hir_id)) {
556 // `expr` is a literal field for a struct, only suggest if appropriate
557 for field in fields {
558 if field.expr.hir_id == expr.hir_id && field.is_shorthand {
559 // This is a field literal
560 prefix = format!("{}: ", field.ident);
565 // Likely a field was meant, but this field wasn't found. Do not suggest anything.
570 let msg = format!("you can convert an `{}` to `{}`", checked_ty, expected_ty);
571 let cast_msg = format!("you can cast an `{} to `{}`", checked_ty, expected_ty);
572 let try_msg = format!("{} and panic if the converted value wouldn't fit", msg);
573 let lit_msg = format!(
574 "change the type of the numeric literal from `{}` to `{}`",
579 let needs_paren = expr.precedence().order() < (PREC_POSTFIX as i8);
581 if let Ok(src) = self.tcx.sess.source_map().span_to_snippet(expr.span) {
582 let cast_suggestion = format!(
585 if needs_paren { "(" } else { "" },
587 if needs_paren { ")" } else { "" },
590 let try_into_suggestion = format!(
591 "{}{}{}{}.try_into().unwrap()",
593 if needs_paren { "(" } else { "" },
595 if needs_paren { ")" } else { "" },
597 let into_suggestion = format!(
600 if needs_paren { "(" } else { "" },
602 if needs_paren { ")" } else { "" },
604 let suffix_suggestion = format!(
606 if needs_paren { "(" } else { "" },
607 if let (ty::Int(_), ty::Float(_)) | (ty::Uint(_), ty::Float(_)) = (
611 // Remove fractional part from literal, for example `42.0f32` into `42`
612 let src = src.trim_end_matches(&checked_ty.to_string());
613 src.split(".").next().unwrap()
615 src.trim_end_matches(&checked_ty.to_string())
618 if needs_paren { ")" } else { "" },
620 let literal_is_ty_suffixed = |expr: &hir::Expr| {
621 if let hir::ExprKind::Lit(lit) = &expr.node {
622 lit.node.is_suffixed()
628 let suggest_to_change_suffix_or_into = |
629 err: &mut DiagnosticBuilder<'_>,
632 let into_sugg = into_suggestion.clone();
635 if literal_is_ty_suffixed(expr) {
637 } else if is_fallible {
642 if literal_is_ty_suffixed(expr) {
643 suffix_suggestion.clone()
644 } else if is_fallible {
649 Applicability::MachineApplicable,
653 match (&expected_ty.sty, &checked_ty.sty) {
654 (&ty::Int(ref exp), &ty::Int(ref found)) => {
655 let is_fallible = match (found.bit_width(), exp.bit_width()) {
656 (Some(found), Some(exp)) if found > exp => true,
657 (None, _) | (_, None) => true,
660 suggest_to_change_suffix_or_into(err, is_fallible);
663 (&ty::Uint(ref exp), &ty::Uint(ref found)) => {
664 let is_fallible = match (found.bit_width(), exp.bit_width()) {
665 (Some(found), Some(exp)) if found > exp => true,
666 (None, _) | (_, None) => true,
669 suggest_to_change_suffix_or_into(err, is_fallible);
672 (&ty::Int(_), &ty::Uint(_)) | (&ty::Uint(_), &ty::Int(_)) => {
673 suggest_to_change_suffix_or_into(err, true);
676 (&ty::Float(ref exp), &ty::Float(ref found)) => {
677 if found.bit_width() < exp.bit_width() {
678 suggest_to_change_suffix_or_into(err, false);
679 } else if literal_is_ty_suffixed(expr) {
684 Applicability::MachineApplicable,
686 } else if can_cast { // Missing try_into implementation for `f64` to `f32`
689 &format!("{}, producing the closest possible value", cast_msg),
691 Applicability::MaybeIncorrect, // lossy conversion
696 (&ty::Uint(_), &ty::Float(_)) | (&ty::Int(_), &ty::Float(_)) => {
697 if literal_is_ty_suffixed(expr) {
702 Applicability::MachineApplicable,
705 // Missing try_into implementation for `{float}` to `{integer}`
708 &format!("{}, rounding the float towards zero", msg),
710 Applicability::MaybeIncorrect // lossy conversion
712 err.warn("if the rounded value cannot be represented by the target \
713 integer type, including `Inf` and `NaN`, casting will cause \
715 (https://github.com/rust-lang/rust/issues/10184)");
719 (&ty::Float(ref exp), &ty::Uint(ref found)) => {
720 // if `found` is `None` (meaning found is `usize`), don't suggest `.into()`
721 if exp.bit_width() > found.bit_width().unwrap_or(256) {
725 "{}, producing the floating point representation of the integer",
729 Applicability::MachineApplicable
731 } else if literal_is_ty_suffixed(expr) {
736 Applicability::MachineApplicable,
739 // Missing try_into implementation for `{integer}` to `{float}`
743 "{}, producing the floating point representation of the integer,
744 rounded if necessary",
748 Applicability::MaybeIncorrect // lossy conversion
753 (&ty::Float(ref exp), &ty::Int(ref found)) => {
754 // if `found` is `None` (meaning found is `isize`), don't suggest `.into()`
755 if exp.bit_width() > found.bit_width().unwrap_or(256) {
759 "{}, producing the floating point representation of the integer",
763 Applicability::MachineApplicable
765 } else if literal_is_ty_suffixed(expr) {
770 Applicability::MachineApplicable,
773 // Missing try_into implementation for `{integer}` to `{float}`
777 "{}, producing the floating point representation of the integer, \
778 rounded if necessary",
782 Applicability::MaybeIncorrect // lossy conversion