1 // Copyright 2012 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
12 use rustc::infer::InferOk;
13 use rustc::traits::ObligationCause;
16 use syntax::util::parser::PREC_POSTFIX;
19 use rustc::hir::def::Def;
21 use rustc::hir::{Item, ItemKind, print};
22 use rustc::ty::{self, Ty, AssociatedItem};
23 use rustc::ty::adjustment::AllowTwoPhase;
24 use errors::{Applicability, DiagnosticBuilder, SourceMapper};
26 use super::method::probe;
28 impl<'a, 'gcx, 'tcx> FnCtxt<'a, 'gcx, 'tcx> {
29 // Requires that the two types unify, and prints an error message if
31 pub fn demand_suptype(&self, sp: Span, expected: Ty<'tcx>, actual: Ty<'tcx>) {
32 self.demand_suptype_diag(sp, expected, actual).map(|mut e| e.emit());
35 pub fn demand_suptype_diag(&self,
38 actual: Ty<'tcx>) -> Option<DiagnosticBuilder<'tcx>> {
39 let cause = &self.misc(sp);
40 match self.at(cause, self.param_env).sup(expected, actual) {
41 Ok(InferOk { obligations, value: () }) => {
42 self.register_predicates(obligations);
46 Some(self.report_mismatched_types(&cause, expected, actual, e))
51 pub fn demand_eqtype(&self, sp: Span, expected: Ty<'tcx>, actual: Ty<'tcx>) {
52 if let Some(mut err) = self.demand_eqtype_diag(sp, expected, actual) {
57 pub fn demand_eqtype_diag(&self,
60 actual: Ty<'tcx>) -> Option<DiagnosticBuilder<'tcx>> {
61 self.demand_eqtype_with_origin(&self.misc(sp), expected, actual)
64 pub fn demand_eqtype_with_origin(&self,
65 cause: &ObligationCause<'tcx>,
67 actual: Ty<'tcx>) -> Option<DiagnosticBuilder<'tcx>> {
68 match self.at(cause, self.param_env).eq(expected, actual) {
69 Ok(InferOk { obligations, value: () }) => {
70 self.register_predicates(obligations);
74 Some(self.report_mismatched_types(cause, expected, actual, e))
79 pub fn demand_coerce(&self,
83 allow_two_phase: AllowTwoPhase)
85 let (ty, err) = self.demand_coerce_diag(expr, checked_ty, expected, allow_two_phase);
86 if let Some(mut err) = err {
92 // Checks that the type of `expr` can be coerced to `expected`.
94 // NB: This code relies on `self.diverges` to be accurate. In
95 // particular, assignments to `!` will be permitted if the
96 // diverges flag is currently "always".
97 pub fn demand_coerce_diag(&self,
101 allow_two_phase: AllowTwoPhase)
102 -> (Ty<'tcx>, Option<DiagnosticBuilder<'tcx>>) {
103 let expected = self.resolve_type_vars_with_obligations(expected);
105 let e = match self.try_coerce(expr, checked_ty, expected, allow_two_phase) {
106 Ok(ty) => return (ty, None),
110 let cause = self.misc(expr.span);
111 let expr_ty = self.resolve_type_vars_with_obligations(checked_ty);
112 let mut err = self.report_mismatched_types(&cause, expected, expr_ty, e);
114 // If the expected type is an enum (Issue #55250) with any variants whose
115 // sole field is of the found type, suggest such variants. (Issue #42764)
116 if let ty::Adt(expected_adt, substs) = expected.sty {
117 if expected_adt.is_enum() {
118 let mut compatible_variants = expected_adt.variants
120 .filter(|variant| variant.fields.len() == 1)
121 .filter_map(|variant| {
122 let sole_field = &variant.fields[0];
123 let sole_field_ty = sole_field.ty(self.tcx, substs);
124 if self.can_coerce(expr_ty, sole_field_ty) {
125 let variant_path = self.tcx.item_path_str(variant.did);
126 Some(variant_path.trim_left_matches("std::prelude::v1::").to_string())
132 if compatible_variants.peek().is_some() {
133 let expr_text = print::to_string(print::NO_ANN, |s| s.print_expr(expr));
134 let suggestions = compatible_variants
135 .map(|v| format!("{}({})", v, expr_text));
136 err.span_suggestions_with_applicability(
138 "try using a variant of the expected type",
140 Applicability::MaybeIncorrect,
146 self.suggest_ref_or_into(&mut err, expr, expected, expr_ty);
148 (expected, Some(err))
151 pub fn get_conversion_methods(&self, span: Span, expected: Ty<'tcx>, checked_ty: Ty<'tcx>)
152 -> Vec<AssociatedItem> {
153 let mut methods = self.probe_for_return_type(span,
154 probe::Mode::MethodCall,
159 self.has_no_input_arg(m) &&
160 self.tcx.get_attrs(m.def_id).iter()
161 // This special internal attribute is used to whitelist
162 // "identity-like" conversion methods to be suggested here.
164 // FIXME (#46459 and #46460): ideally
165 // `std::convert::Into::into` and `std::borrow:ToOwned` would
166 // also be `#[rustc_conversion_suggestion]`, if not for
167 // method-probing false-positives and -negatives (respectively).
169 // FIXME? Other potential candidate methods: `as_ref` and
171 .find(|a| a.check_name("rustc_conversion_suggestion")).is_some()
177 // This function checks if the method isn't static and takes other arguments than `self`.
178 fn has_no_input_arg(&self, method: &AssociatedItem) -> bool {
180 Def::Method(def_id) => {
181 self.tcx.fn_sig(def_id).inputs().skip_binder().len() == 1
187 /// Identify some cases where `as_ref()` would be appropriate and suggest it.
189 /// Given the following code:
192 /// fn takes_ref(_: &Foo) {}
193 /// let ref opt = Some(Foo);
195 /// opt.map(|arg| takes_ref(arg));
197 /// Suggest using `opt.as_ref().map(|arg| takes_ref(arg));` instead.
199 /// It only checks for `Option` and `Result` and won't work with
201 /// opt.map(|arg| { takes_ref(arg) });
203 fn can_use_as_ref(&self, expr: &hir::Expr) -> Option<(Span, &'static str, String)> {
204 if let hir::ExprKind::Path(hir::QPath::Resolved(_, ref path)) = expr.node {
205 if let hir::def::Def::Local(id) = path.def {
206 let parent = self.tcx.hir().get_parent_node(id);
207 if let Some(Node::Expr(hir::Expr {
209 node: hir::ExprKind::Closure(_, decl, ..),
211 })) = self.tcx.hir().find(parent) {
212 let parent = self.tcx.hir().get_parent_node(*id);
213 if let (Some(Node::Expr(hir::Expr {
214 node: hir::ExprKind::MethodCall(path, span, expr),
216 })), 1) = (self.tcx.hir().find(parent), decl.inputs.len()) {
217 let self_ty = self.tables.borrow().node_id_to_type(expr[0].hir_id);
218 let self_ty = format!("{:?}", self_ty);
219 let name = path.ident.as_str();
220 let is_as_ref_able = (
221 self_ty.starts_with("&std::option::Option") ||
222 self_ty.starts_with("&std::result::Result") ||
223 self_ty.starts_with("std::option::Option") ||
224 self_ty.starts_with("std::result::Result")
225 ) && (name == "map" || name == "and_then");
227 return Some((span.shrink_to_lo(),
228 "consider using `as_ref` instead",
229 "as_ref().".into()));
238 /// This function is used to determine potential "simple" improvements or users' errors and
239 /// provide them useful help. For example:
242 /// fn some_fn(s: &str) {}
244 /// let x = "hey!".to_owned();
245 /// some_fn(x); // error
248 /// No need to find every potential function which could make a coercion to transform a
249 /// `String` into a `&str` since a `&` would do the trick!
251 /// In addition of this check, it also checks between references mutability state. If the
252 /// expected is mutable but the provided isn't, maybe we could just say "Hey, try with
254 pub fn check_ref(&self,
256 checked_ty: Ty<'tcx>,
258 -> Option<(Span, &'static str, String)> {
259 let cm = self.sess().source_map();
260 // Use the callsite's span if this is a macro call. #41858
261 let sp = cm.call_span_if_macro(expr.span);
262 if !cm.span_to_filename(sp).is_real() {
266 match (&expected.sty, &checked_ty.sty) {
267 (&ty::Ref(_, exp, _), &ty::Ref(_, check, _)) => match (&exp.sty, &check.sty) {
268 (&ty::Str, &ty::Array(arr, _)) |
269 (&ty::Str, &ty::Slice(arr)) if arr == self.tcx.types.u8 => {
270 if let hir::ExprKind::Lit(_) = expr.node {
271 if let Ok(src) = cm.span_to_snippet(sp) {
272 if src.starts_with("b\"") {
274 "consider removing the leading `b`",
275 src[1..].to_string()));
280 (&ty::Array(arr, _), &ty::Str) |
281 (&ty::Slice(arr), &ty::Str) if arr == self.tcx.types.u8 => {
282 if let hir::ExprKind::Lit(_) = expr.node {
283 if let Ok(src) = cm.span_to_snippet(sp) {
284 if src.starts_with("\"") {
286 "consider adding a leading `b`",
287 format!("b{}", src)));
294 (&ty::Ref(_, _, mutability), _) => {
295 // Check if it can work when put into a ref. For example:
298 // fn bar(x: &mut i32) {}
301 // bar(&x); // error, expected &mut
303 let ref_ty = match mutability {
304 hir::Mutability::MutMutable => self.tcx.mk_mut_ref(
305 self.tcx.mk_region(ty::ReStatic),
307 hir::Mutability::MutImmutable => self.tcx.mk_imm_ref(
308 self.tcx.mk_region(ty::ReStatic),
311 if self.can_coerce(ref_ty, expected) {
312 if let Ok(src) = cm.span_to_snippet(sp) {
313 let needs_parens = match expr.node {
314 // parenthesize if needed (Issue #46756)
315 hir::ExprKind::Cast(_, _) |
316 hir::ExprKind::Binary(_, _, _) => true,
317 // parenthesize borrows of range literals (Issue #54505)
318 _ if self.is_range_literal(expr) => true,
321 let sugg_expr = if needs_parens {
327 if let Some(sugg) = self.can_use_as_ref(expr) {
330 return Some(match mutability {
331 hir::Mutability::MutMutable => {
332 (sp, "consider mutably borrowing here", format!("&mut {}",
335 hir::Mutability::MutImmutable => {
336 (sp, "consider borrowing here", format!("&{}", sugg_expr))
342 (_, &ty::Ref(_, checked, _)) => {
343 // We have `&T`, check if what was expected was `T`. If so,
344 // we may want to suggest adding a `*`, or removing
347 // (But, also check check the `expn_info()` to see if this is
348 // a macro; if so, it's hard to extract the text and make a good
349 // suggestion, so don't bother.)
350 if self.infcx.can_sub(self.param_env, checked, &expected).is_ok() &&
351 sp.ctxt().outer().expn_info().is_none() {
354 hir::ExprKind::AddrOf(_, ref expr) => {
355 if !cm.span_to_filename(expr.span).is_real() {
358 if let Ok(code) = cm.span_to_snippet(expr.span) {
359 return Some((sp, "consider removing the borrow", code));
363 // Maybe add `*`? Only if `T: Copy`.
365 if !self.infcx.type_moves_by_default(self.param_env,
368 // do not suggest if the span comes from a macro (#52783)
370 true) = (cm.span_to_snippet(sp), sp == expr.span) {
373 "consider dereferencing the borrow",
374 format!("*{}", code),
387 /// This function checks if the specified expression is a built-in range literal.
388 /// (See: `LoweringContext::lower_expr()` in `src/librustc/hir/lowering.rs`).
389 fn is_range_literal(&self, expr: &hir::Expr) -> bool {
390 use hir::{Path, QPath, ExprKind, TyKind};
392 // We support `::std::ops::Range` and `::core::ops::Range` prefixes
393 let is_range_path = |path: &Path| {
394 let mut segs = path.segments.iter()
395 .map(|seg| seg.ident.as_str());
397 if let (Some(root), Some(std_core), Some(ops), Some(range), None) =
398 (segs.next(), segs.next(), segs.next(), segs.next(), segs.next())
400 // "{{root}}" is the equivalent of `::` prefix in Path
401 root == "{{root}}" && (std_core == "std" || std_core == "core")
402 && ops == "ops" && range.starts_with("Range")
408 let span_is_range_literal = |span: &Span| {
409 // Check whether a span corresponding to a range expression
410 // is a range literal, rather than an explicit struct or `new()` call.
411 let source_map = self.tcx.sess.source_map();
412 let end_point = source_map.end_point(*span);
414 if let Ok(end_string) = source_map.span_to_snippet(end_point) {
415 !(end_string.ends_with("}") || end_string.ends_with(")"))
422 // All built-in range literals but `..=` and `..` desugar to Structs
423 ExprKind::Struct(QPath::Resolved(None, ref path), _, _) |
424 // `..` desugars to its struct path
425 ExprKind::Path(QPath::Resolved(None, ref path)) => {
426 return is_range_path(&path) && span_is_range_literal(&expr.span);
429 // `..=` desugars into `::std::ops::RangeInclusive::new(...)`
430 ExprKind::Call(ref func, _) => {
431 if let ExprKind::Path(QPath::TypeRelative(ref ty, ref segment)) = func.node {
432 if let TyKind::Path(QPath::Resolved(None, ref path)) = ty.node {
433 let call_to_new = segment.ident.as_str() == "new";
435 return is_range_path(&path) && span_is_range_literal(&expr.span)
447 pub fn check_for_cast(&self,
448 err: &mut DiagnosticBuilder<'tcx>,
450 checked_ty: Ty<'tcx>,
451 expected_ty: Ty<'tcx>)
453 let parent_id = self.tcx.hir().get_parent_node(expr.id);
454 if let Some(parent) = self.tcx.hir().find(parent_id) {
455 // Shouldn't suggest `.into()` on `const`s.
456 if let Node::Item(Item { node: ItemKind::Const(_, _), .. }) = parent {
457 // FIXME(estebank): modify once we decide to suggest `as` casts
462 let will_truncate = "will truncate the source value";
463 let depending_on_isize = "will truncate or zero-extend depending on the bit width of \
465 let depending_on_usize = "will truncate or zero-extend depending on the bit width of \
467 let will_sign_extend = "will sign-extend the source value";
468 let will_zero_extend = "will zero-extend the source value";
470 // If casting this expression to a given numeric type would be appropriate in case of a type
473 // We want to minimize the amount of casting operations that are suggested, as it can be a
474 // lossy operation with potentially bad side effects, so we only suggest when encountering
475 // an expression that indicates that the original type couldn't be directly changed.
477 // For now, don't suggest casting with `as`.
478 let can_cast = false;
480 let needs_paren = expr.precedence().order() < (PREC_POSTFIX as i8);
482 if let Ok(src) = self.tcx.sess.source_map().span_to_snippet(expr.span) {
483 let msg = format!("you can cast an `{}` to `{}`", checked_ty, expected_ty);
484 let cast_suggestion = format!("{}{}{} as {}",
485 if needs_paren { "(" } else { "" },
487 if needs_paren { ")" } else { "" },
489 let into_suggestion = format!(
491 if needs_paren { "(" } else { "" },
493 if needs_paren { ")" } else { "" },
495 let literal_is_ty_suffixed = |expr: &hir::Expr| {
496 if let hir::ExprKind::Lit(lit) = &expr.node {
497 lit.node.is_suffixed()
503 let into_sugg = into_suggestion.clone();
504 let suggest_to_change_suffix_or_into = |err: &mut DiagnosticBuilder,
505 note: Option<&str>| {
506 let suggest_msg = if literal_is_ty_suffixed(expr) {
508 "change the type of the numeric literal from `{}` to `{}`",
514 Some(note) => format!("{}, which {}", msg, note),
515 _ => format!("{} in a lossless way", msg),
519 let suffix_suggestion = format!(
521 if needs_paren { "(" } else { "" },
522 src.trim_right_matches(&checked_ty.to_string()),
524 if needs_paren { ")" } else { "" },
527 err.span_suggestion_with_applicability(
530 if literal_is_ty_suffixed(expr) {
535 Applicability::MachineApplicable,
539 match (&expected_ty.sty, &checked_ty.sty) {
540 (&ty::Int(ref exp), &ty::Int(ref found)) => {
541 match (found.bit_width(), exp.bit_width()) {
542 (Some(found), Some(exp)) if found > exp => {
544 err.span_suggestion_with_applicability(
546 &format!("{}, which {}", msg, will_truncate),
548 Applicability::MaybeIncorrect // lossy conversion
552 (None, _) | (_, None) => {
554 err.span_suggestion_with_applicability(
556 &format!("{}, which {}", msg, depending_on_isize),
558 Applicability::MaybeIncorrect // lossy conversion
563 suggest_to_change_suffix_or_into(
565 Some(will_sign_extend),
571 (&ty::Uint(ref exp), &ty::Uint(ref found)) => {
572 match (found.bit_width(), exp.bit_width()) {
573 (Some(found), Some(exp)) if found > exp => {
575 err.span_suggestion_with_applicability(
577 &format!("{}, which {}", msg, will_truncate),
579 Applicability::MaybeIncorrect // lossy conversion
583 (None, _) | (_, None) => {
585 err.span_suggestion_with_applicability(
587 &format!("{}, which {}", msg, depending_on_usize),
589 Applicability::MaybeIncorrect // lossy conversion
594 suggest_to_change_suffix_or_into(
596 Some(will_zero_extend),
602 (&ty::Int(ref exp), &ty::Uint(ref found)) => {
604 match (found.bit_width(), exp.bit_width()) {
605 (Some(found), Some(exp)) if found > exp - 1 => {
606 err.span_suggestion_with_applicability(
608 &format!("{}, which {}", msg, will_truncate),
610 Applicability::MaybeIncorrect // lossy conversion
614 err.span_suggestion_with_applicability(
616 &format!("{}, which {}", msg, will_truncate),
618 Applicability::MaybeIncorrect // lossy conversion
622 err.span_suggestion_with_applicability(
624 &format!("{}, which {}", msg, depending_on_isize),
626 Applicability::MaybeIncorrect // lossy conversion
630 err.span_suggestion_with_applicability(
632 &format!("{}, which {}", msg, depending_on_usize),
634 Applicability::MaybeIncorrect // lossy conversion
638 err.span_suggestion_with_applicability(
640 &format!("{}, which {}", msg, will_zero_extend),
642 Applicability::MachineApplicable
649 (&ty::Uint(ref exp), &ty::Int(ref found)) => {
651 match (found.bit_width(), exp.bit_width()) {
652 (Some(found), Some(exp)) if found - 1 > exp => {
653 err.span_suggestion_with_applicability(
655 &format!("{}, which {}", msg, will_truncate),
657 Applicability::MaybeIncorrect // lossy conversion
661 err.span_suggestion_with_applicability(
663 &format!("{}, which {}", msg, will_sign_extend),
665 Applicability::MachineApplicable // lossy conversion
669 err.span_suggestion_with_applicability(
671 &format!("{}, which {}", msg, depending_on_usize),
673 Applicability::MaybeIncorrect // lossy conversion
677 err.span_suggestion_with_applicability(
679 &format!("{}, which {}", msg, depending_on_isize),
681 Applicability::MaybeIncorrect // lossy conversion
685 err.span_suggestion_with_applicability(
687 &format!("{}, which {}", msg, will_sign_extend),
689 Applicability::MachineApplicable
696 (&ty::Float(ref exp), &ty::Float(ref found)) => {
697 if found.bit_width() < exp.bit_width() {
698 suggest_to_change_suffix_or_into(
703 err.span_suggestion_with_applicability(
705 &format!("{}, producing the closest possible value", msg),
707 Applicability::MaybeIncorrect // lossy conversion
712 (&ty::Uint(_), &ty::Float(_)) | (&ty::Int(_), &ty::Float(_)) => {
714 err.span_suggestion_with_applicability(
716 &format!("{}, rounding the float towards zero", msg),
718 Applicability::MaybeIncorrect // lossy conversion
720 err.warn("casting here will cause undefined behavior if the rounded value \
721 cannot be represented by the target integer type, including \
722 `Inf` and `NaN` (this is a bug and will be fixed)");
726 (&ty::Float(ref exp), &ty::Uint(ref found)) => {
727 // if `found` is `None` (meaning found is `usize`), don't suggest `.into()`
728 if exp.bit_width() > found.bit_width().unwrap_or(256) {
729 err.span_suggestion_with_applicability(
731 &format!("{}, producing the floating point representation of the \
735 Applicability::MachineApplicable
738 err.span_suggestion_with_applicability(expr.span,
739 &format!("{}, producing the floating point representation of the \
740 integer, rounded if necessary",
743 Applicability::MaybeIncorrect // lossy conversion
748 (&ty::Float(ref exp), &ty::Int(ref found)) => {
749 // if `found` is `None` (meaning found is `isize`), don't suggest `.into()`
750 if exp.bit_width() > found.bit_width().unwrap_or(256) {
751 err.span_suggestion_with_applicability(
753 &format!("{}, producing the floating point representation of the \
757 Applicability::MachineApplicable
760 err.span_suggestion_with_applicability(
762 &format!("{}, producing the floating point representation of the \
763 integer, rounded if necessary",
766 Applicability::MaybeIncorrect // lossy conversion