src/librustc_typeck/check/method/suggest.rs

   1 // Copyright 2014 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.
   4 //
   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.
  10
  11 //! Give useful errors and suggestions to users when an item can't be
  12 //! found or is otherwise invalid.
  13
  14 use check::FnCtxt;
  15 use rustc::hir::map as hir_map;
  16 use rustc::ty::{self, Ty, TyCtxt, ToPolyTraitRef, ToPredicate, TypeFoldable};
  17 use hir::def::Def;
  18 use hir::def_id::{CRATE_DEF_INDEX, DefId};
  19 use middle::lang_items::FnOnceTraitLangItem;
  20 use rustc::traits::{Obligation, SelectionContext};
  21 use util::nodemap::FxHashSet;
  22
  23 use syntax::ast;
  24 use errors::DiagnosticBuilder;
  25 use syntax_pos::Span;
  26
  27 use rustc::hir;
  28 use rustc::hir::print;
  29 use rustc::infer::type_variable::TypeVariableOrigin;
  30
  31 use std::cell;
  32 use std::cmp::Ordering;
  33
  34 use super::{MethodError, NoMatchData, CandidateSource};
  35 use super::probe::Mode;
  36
  37 impl<'a, 'gcx, 'tcx> FnCtxt<'a, 'gcx, 'tcx> {
  38     fn is_fn_ty(&self, ty: &Ty<'tcx>, span: Span) -> bool {
  39         let tcx = self.tcx;
  40         match ty.sty {
  41             // Not all of these (e.g. unsafe fns) implement FnOnce
  42             // so we look for these beforehand
  43             ty::TyClosure(..) |
  44             ty::TyFnDef(..) |
  45             ty::TyFnPtr(_) => true,
  46             // If it's not a simple function, look for things which implement FnOnce
  47             _ => {
  48                 let fn_once = match tcx.lang_items.require(FnOnceTraitLangItem) {
  49                     Ok(fn_once) => fn_once,
  50                     Err(..) => return false,
  51                 };
  52
  53                 self.autoderef(span, ty).any(|(ty, _)| {
  54                     self.probe(|_| {
  55                         let fn_once_substs = tcx.mk_substs_trait(ty,
  56                             &[self.next_ty_var(TypeVariableOrigin::MiscVariable(span))]);
  57                         let trait_ref = ty::TraitRef::new(fn_once, fn_once_substs);
  58                         let poly_trait_ref = trait_ref.to_poly_trait_ref();
  59                         let obligation =
  60                             Obligation::misc(span,
  61                                              self.body_id,
  62                                              self.param_env,
  63                                              poly_trait_ref.to_predicate());
  64                         SelectionContext::new(self).evaluate_obligation(&obligation)
  65                     })
  66                 })
  67             }
  68         }
  69     }
  70
  71     pub fn report_method_error(&self,
  72                                span: Span,
  73                                rcvr_ty: Ty<'tcx>,
  74                                item_name: ast::Name,
  75                                rcvr_expr: Option<&hir::Expr>,
  76                                error: MethodError<'tcx>,
  77                                args: Option<&'gcx [hir::Expr]>) {
  78         // avoid suggestions when we don't know what's going on.
  79         if rcvr_ty.references_error() {
  80             return;
  81         }
  82
  83         let report_candidates = |err: &mut DiagnosticBuilder, mut sources: Vec<CandidateSource>| {
  84
  85             sources.sort();
  86             sources.dedup();
  87             // Dynamic limit to avoid hiding just one candidate, which is silly.
  88             let limit = if sources.len() == 5 { 5 } else { 4 };
  89
  90             for (idx, source) in sources.iter().take(limit).enumerate() {
  91                 match *source {
  92                     CandidateSource::ImplSource(impl_did) => {
  93                         // Provide the best span we can. Use the item, if local to crate, else
  94                         // the impl, if local to crate (item may be defaulted), else nothing.
  95                         let item = self.associated_item(impl_did, item_name)
  96                             .or_else(|| {
  97                                 self.associated_item(
  98                                     self.tcx.impl_trait_ref(impl_did).unwrap().def_id,
  99
 100                                     item_name
 101                                 )
 102                             }).unwrap();
 103                         let note_span = self.tcx.hir.span_if_local(item.def_id).or_else(|| {
 104                             self.tcx.hir.span_if_local(impl_did)
 105                         });
 106
 107                         let impl_ty = self.impl_self_ty(span, impl_did).ty;
 108
 109                         let insertion = match self.tcx.impl_trait_ref(impl_did) {
 110                             None => format!(""),
 111                             Some(trait_ref) => {
 112                                 format!(" of the trait `{}`",
 113                                         self.tcx.item_path_str(trait_ref.def_id))
 114                             }
 115                         };
 116
 117                         let note_str = format!("candidate #{} is defined in an impl{} \
 118                                                 for the type `{}`",
 119                                                idx + 1,
 120                                                insertion,
 121                                                impl_ty);
 122                         if let Some(note_span) = note_span {
 123                             // We have a span pointing to the method. Show note with snippet.
 124                             err.span_note(note_span, &note_str);
 125                         } else {
 126                             err.note(&note_str);
 127                         }
 128                     }
 129                     CandidateSource::TraitSource(trait_did) => {
 130                         let item = self.associated_item(trait_did, item_name).unwrap();
 131                         let item_span = self.tcx.def_span(item.def_id);
 132                         span_note!(err,
 133                                    item_span,
 134                                    "candidate #{} is defined in the trait `{}`",
 135                                    idx + 1,
 136                                    self.tcx.item_path_str(trait_did));
 137                         err.help(&format!("to disambiguate the method call, write `{}::{}({}{})` \
 138                                           instead",
 139                                           self.tcx.item_path_str(trait_did),
 140                                           item_name,
 141                                           if rcvr_ty.is_region_ptr() && args.is_some() {
 142                                               if rcvr_ty.is_mutable_pointer() {
 143                                                   "&mut "
 144                                               } else {
 145                                                   "&"
 146                                               }
 147                                           } else {
 148                                               ""
 149                                           },
 150                                           args.map(|arg| arg.iter()
 151                                               .map(|arg| print::to_string(print::NO_ANN,
 152                                                                           |s| s.print_expr(arg)))
 153                                               .collect::<Vec<_>>()
 154                                               .join(", ")).unwrap_or("...".to_owned())));
 155                     }
 156                 }
 157             }
 158             if sources.len() > limit {
 159                 err.note(&format!("and {} others", sources.len() - limit));
 160             }
 161         };
 162
 163         match error {
 164             MethodError::NoMatch(NoMatchData { static_candidates: static_sources,
 165                                                unsatisfied_predicates,
 166                                                out_of_scope_traits,
 167                                                mode,
 168                                                .. }) => {
 169                 let tcx = self.tcx;
 170
 171                 let actual = self.resolve_type_vars_if_possible(&rcvr_ty);
 172                 let mut err = if !actual.references_error() {
 173                     struct_span_err!(tcx.sess, span, E0599,
 174                                      "no {} named `{}` found for type `{}` in the \
 175                                       current scope",
 176                                      if mode == Mode::MethodCall {
 177                                          "method"
 178                                      } else {
 179                                          match item_name.as_str().chars().next() {
 180                                              Some(name) => {
 181                                                  if name.is_lowercase() {
 182                                                      "function or associated item"
 183                                                  } else {
 184                                                      "associated item"
 185                                                  }
 186                                              },
 187                                              None => {
 188                                                  ""
 189                                              },
 190                                          }
 191                                      },
 192                                      item_name,
 193                                      self.ty_to_string(actual))
 194                 } else {
 195                     self.tcx.sess.diagnostic().struct_dummy()
 196                 };
 197
 198                 // If the method name is the name of a field with a function or closure type,
 199                 // give a helping note that it has to be called as (x.f)(...).
 200                 if let Some(expr) = rcvr_expr {
 201                     for (ty, _) in self.autoderef(span, rcvr_ty) {
 202                         match ty.sty {
 203                             ty::TyAdt(def, substs) if !def.is_enum() => {
 204                                 if let Some(field) = def.struct_variant()
 205                                     .find_field_named(item_name) {
 206                                     let snippet = tcx.sess.codemap().span_to_snippet(expr.span);
 207                                     let expr_string = match snippet {
 208                                         Ok(expr_string) => expr_string,
 209                                         _ => "s".into(), // Default to a generic placeholder for the
 210                                         // expression when we can't generate a
 211                                         // string snippet
 212                                     };
 213
 214                                     let field_ty = field.ty(tcx, substs);
 215                                     let scope = self.tcx.hir.get_module_parent(self.body_id);
 216                                     if field.vis.is_accessible_from(scope, self.tcx) {
 217                                         if self.is_fn_ty(&field_ty, span) {
 218                                             err.help(&format!("use `({0}.{1})(...)` if you \
 219                                                                meant to call the function \
 220                                                                stored in the `{1}` field",
 221                                                               expr_string,
 222                                                               item_name));
 223                                         } else {
 224                                             err.help(&format!("did you mean to write `{0}.{1}` \
 225                                                                instead of `{0}.{1}(...)`?",
 226                                                               expr_string,
 227                                                               item_name));
 228                                         }
 229                                         err.span_label(span, "field, not a method");
 230                                     } else {
 231                                         err.span_label(span, "private field, not a method");
 232                                     }
 233                                     break;
 234                                 }
 235                             }
 236                             _ => {}
 237                         }
 238                     }
 239                 }
 240
 241                 if self.is_fn_ty(&rcvr_ty, span) {
 242                     macro_rules! report_function {
 243                         ($span:expr, $name:expr) => {
 244                             err.note(&format!("{} is a function, perhaps you wish to call it",
 245                                               $name));
 246                         }
 247                     }
 248
 249                     if let Some(expr) = rcvr_expr {
 250                         if let Ok(expr_string) = tcx.sess.codemap().span_to_snippet(expr.span) {
 251                             report_function!(expr.span, expr_string);
 252                         } else if let hir::ExprPath(hir::QPath::Resolved(_, ref path)) = expr.node {
 253                             if let Some(segment) = path.segments.last() {
 254                                 report_function!(expr.span, segment.name);
 255                             }
 256                         }
 257                     }
 258                 }
 259
 260                 if !static_sources.is_empty() {
 261                     err.note("found the following associated functions; to be used as methods, \
 262                               functions must have a `self` parameter");
 263                     err.help(&format!("try with `{}::{}`", self.ty_to_string(actual), item_name));
 264
 265                     report_candidates(&mut err, static_sources);
 266                 }
 267
 268                 if !unsatisfied_predicates.is_empty() {
 269                     let bound_list = unsatisfied_predicates.iter()
 270                         .map(|p| format!("`{} : {}`", p.self_ty(), p))
 271                         .collect::<Vec<_>>()
 272                         .join("\n");
 273                     err.note(&format!("the method `{}` exists but the following trait bounds \
 274                                        were not satisfied:\n{}",
 275                                       item_name,
 276                                       bound_list));
 277                 }
 278
 279                 self.suggest_traits_to_import(&mut err,
 280                                               span,
 281                                               rcvr_ty,
 282                                               item_name,
 283                                               rcvr_expr,
 284                                               out_of_scope_traits);
 285                 err.emit();
 286             }
 287
 288             MethodError::Ambiguity(sources) => {
 289                 let mut err = struct_span_err!(self.sess(),
 290                                                span,
 291                                                E0034,
 292                                                "multiple applicable items in scope");
 293                 err.span_label(span, format!("multiple `{}` found", item_name));
 294
 295                 report_candidates(&mut err, sources);
 296                 err.emit();
 297             }
 298
 299             MethodError::PrivateMatch(def, out_of_scope_traits) => {
 300                 let mut err = struct_span_err!(self.tcx.sess, span, E0624,
 301                                                "{} `{}` is private", def.kind_name(), item_name);
 302                 self.suggest_valid_traits(&mut err, out_of_scope_traits);
 303                 err.emit();
 304             }
 305
 306             MethodError::IllegalSizedBound(candidates) => {
 307                 let msg = format!("the `{}` method cannot be invoked on a trait object", item_name);
 308                 let mut err = self.sess().struct_span_err(span, &msg);
 309                 if !candidates.is_empty() {
 310                     let help = format!("{an}other candidate{s} {were} found in the following \
 311                                         trait{s}, perhaps add a `use` for {one_of_them}:",
 312                                     an = if candidates.len() == 1 {"an" } else { "" },
 313                                     s = if candidates.len() == 1 { "" } else { "s" },
 314                                     were = if candidates.len() == 1 { "was" } else { "were" },
 315                                     one_of_them = if candidates.len() == 1 {
 316                                         "it"
 317                                     } else {
 318                                         "one_of_them"
 319                                     });
 320                     self.suggest_use_candidates(&mut err, help, candidates);
 321                 }
 322                 err.emit();
 323             }
 324
 325             MethodError::BadReturnType => {
 326                 bug!("no return type expectations but got BadReturnType")
 327             }
 328         }
 329     }
 330
 331     fn suggest_use_candidates(&self,
 332                               err: &mut DiagnosticBuilder,
 333                               mut msg: String,
 334                               candidates: Vec<DefId>) {
 335         let limit = if candidates.len() == 5 { 5 } else { 4 };
 336         for (i, trait_did) in candidates.iter().take(limit).enumerate() {
 337             msg.push_str(&format!("\ncandidate #{}: `use {};`",
 338                                     i + 1,
 339                                     self.tcx.item_path_str(*trait_did)));
 340         }
 341         if candidates.len() > limit {
 342             msg.push_str(&format!("\nand {} others", candidates.len() - limit));
 343         }
 344         err.note(&msg[..]);
 345     }
 346
 347     fn suggest_valid_traits(&self,
 348                             err: &mut DiagnosticBuilder,
 349                             valid_out_of_scope_traits: Vec<DefId>) -> bool {
 350         if !valid_out_of_scope_traits.is_empty() {
 351             let mut candidates = valid_out_of_scope_traits;
 352             candidates.sort();
 353             candidates.dedup();
 354             err.help("items from traits can only be used if the trait is in scope");
 355             let msg = format!("the following {traits_are} implemented but not in scope, \
 356                                perhaps add a `use` for {one_of_them}:",
 357                             traits_are = if candidates.len() == 1 {
 358                                 "trait is"
 359                             } else {
 360                                 "traits are"
 361                             },
 362                             one_of_them = if candidates.len() == 1 {
 363                                 "it"
 364                             } else {
 365                                 "one of them"
 366                             });
 367
 368             self.suggest_use_candidates(err, msg, candidates);
 369             true
 370         } else {
 371             false
 372         }
 373     }
 374
 375     fn suggest_traits_to_import(&self,
 376                                 err: &mut DiagnosticBuilder,
 377                                 span: Span,
 378                                 rcvr_ty: Ty<'tcx>,
 379                                 item_name: ast::Name,
 380                                 rcvr_expr: Option<&hir::Expr>,
 381                                 valid_out_of_scope_traits: Vec<DefId>) {
 382         if self.suggest_valid_traits(err, valid_out_of_scope_traits) {
 383             return;
 384         }
 385
 386         let type_is_local = self.type_derefs_to_local(span, rcvr_ty, rcvr_expr);
 387
 388         // there's no implemented traits, so lets suggest some traits to
 389         // implement, by finding ones that have the item name, and are
 390         // legal to implement.
 391         let mut candidates = all_traits(self.tcx)
 392             .filter(|info| {
 393                 // we approximate the coherence rules to only suggest
 394                 // traits that are legal to implement by requiring that
 395                 // either the type or trait is local. Multidispatch means
 396                 // this isn't perfect (that is, there are cases when
 397                 // implementing a trait would be legal but is rejected
 398                 // here).
 399                 (type_is_local || info.def_id.is_local())
 400                     && self.associated_item(info.def_id, item_name).is_some()
 401             })
 402             .collect::<Vec<_>>();
 403
 404         if !candidates.is_empty() {
 405             // sort from most relevant to least relevant
 406             candidates.sort_by(|a, b| a.cmp(b).reverse());
 407             candidates.dedup();
 408
 409             // FIXME #21673 this help message could be tuned to the case
 410             // of a type parameter: suggest adding a trait bound rather
 411             // than implementing.
 412             err.help("items from traits can only be used if the trait is implemented and in scope");
 413             let mut msg = format!("the following {traits_define} an item `{name}`, \
 414                                    perhaps you need to implement {one_of_them}:",
 415                                   traits_define = if candidates.len() == 1 {
 416                                       "trait defines"
 417                                   } else {
 418                                       "traits define"
 419                                   },
 420                                   one_of_them = if candidates.len() == 1 {
 421                                       "it"
 422                                   } else {
 423                                       "one of them"
 424                                   },
 425                                   name = item_name);
 426
 427             for (i, trait_info) in candidates.iter().enumerate() {
 428                 msg.push_str(&format!("\ncandidate #{}: `{}`",
 429                                       i + 1,
 430                                       self.tcx.item_path_str(trait_info.def_id)));
 431             }
 432             err.note(&msg[..]);
 433         }
 434     }
 435
 436     /// Checks whether there is a local type somewhere in the chain of
 437     /// autoderefs of `rcvr_ty`.
 438     fn type_derefs_to_local(&self,
 439                             span: Span,
 440                             rcvr_ty: Ty<'tcx>,
 441                             rcvr_expr: Option<&hir::Expr>)
 442                             -> bool {
 443         fn is_local(ty: Ty) -> bool {
 444             match ty.sty {
 445                 ty::TyAdt(def, _) => def.did.is_local(),
 446
 447                 ty::TyDynamic(ref tr, ..) => tr.principal()
 448                     .map_or(false, |p| p.def_id().is_local()),
 449
 450                 ty::TyParam(_) => true,
 451
 452                 // everything else (primitive types etc.) is effectively
 453                 // non-local (there are "edge" cases, e.g. (LocalType,), but
 454                 // the noise from these sort of types is usually just really
 455                 // annoying, rather than any sort of help).
 456                 _ => false,
 457             }
 458         }
 459
 460         // This occurs for UFCS desugaring of `T::method`, where there is no
 461         // receiver expression for the method call, and thus no autoderef.
 462         if rcvr_expr.is_none() {
 463             return is_local(self.resolve_type_vars_with_obligations(rcvr_ty));
 464         }
 465
 466         self.autoderef(span, rcvr_ty).any(|(ty, _)| is_local(ty))
 467     }
 468 }
 469
 470 pub type AllTraitsVec = Vec<DefId>;
 471
 472 #[derive(Copy, Clone)]
 473 pub struct TraitInfo {
 474     pub def_id: DefId,
 475 }
 476
 477 impl TraitInfo {
 478     fn new(def_id: DefId) -> TraitInfo {
 479         TraitInfo { def_id: def_id }
 480     }
 481 }
 482 impl PartialEq for TraitInfo {
 483     fn eq(&self, other: &TraitInfo) -> bool {
 484         self.cmp(other) == Ordering::Equal
 485     }
 486 }
 487 impl Eq for TraitInfo {}
 488 impl PartialOrd for TraitInfo {
 489     fn partial_cmp(&self, other: &TraitInfo) -> Option<Ordering> {
 490         Some(self.cmp(other))
 491     }
 492 }
 493 impl Ord for TraitInfo {
 494     fn cmp(&self, other: &TraitInfo) -> Ordering {
 495         // local crates are more important than remote ones (local:
 496         // cnum == 0), and otherwise we throw in the defid for totality
 497
 498         let lhs = (other.def_id.krate, other.def_id);
 499         let rhs = (self.def_id.krate, self.def_id);
 500         lhs.cmp(&rhs)
 501     }
 502 }
 503
 504 /// Retrieve all traits in this crate and any dependent crates.
 505 pub fn all_traits<'a, 'gcx, 'tcx>(tcx: TyCtxt<'a, 'gcx, 'tcx>) -> AllTraits<'a> {
 506     if tcx.all_traits.borrow().is_none() {
 507         use rustc::hir::itemlikevisit;
 508
 509         let mut traits = vec![];
 510
 511         // Crate-local:
 512         //
 513         // meh.
 514         struct Visitor<'a, 'tcx: 'a> {
 515             map: &'a hir_map::Map<'tcx>,
 516             traits: &'a mut AllTraitsVec,
 517         }
 518         impl<'v, 'a, 'tcx> itemlikevisit::ItemLikeVisitor<'v> for Visitor<'a, 'tcx> {
 519             fn visit_item(&mut self, i: &'v hir::Item) {
 520                 match i.node {
 521                     hir::ItemTrait(..) => {
 522                         let def_id = self.map.local_def_id(i.id);
 523                         self.traits.push(def_id);
 524                     }
 525                     _ => {}
 526                 }
 527             }
 528
 529             fn visit_trait_item(&mut self, _trait_item: &hir::TraitItem) {
 530             }
 531
 532             fn visit_impl_item(&mut self, _impl_item: &hir::ImplItem) {
 533             }
 534         }
 535         tcx.hir.krate().visit_all_item_likes(&mut Visitor {
 536             map: &tcx.hir,
 537             traits: &mut traits,
 538         });
 539
 540         // Cross-crate:
 541         let mut external_mods = FxHashSet();
 542         fn handle_external_def(tcx: TyCtxt,
 543                                traits: &mut AllTraitsVec,
 544                                external_mods: &mut FxHashSet<DefId>,
 545                                def: Def) {
 546             let def_id = def.def_id();
 547             match def {
 548                 Def::Trait(..) => {
 549                     traits.push(def_id);
 550                 }
 551                 Def::Mod(..) => {
 552                     if !external_mods.insert(def_id) {
 553                         return;
 554                     }
 555                     for child in tcx.sess.cstore.item_children(def_id, tcx.sess) {
 556                         handle_external_def(tcx, traits, external_mods, child.def)
 557                     }
 558                 }
 559                 _ => {}
 560             }
 561         }
 562         for cnum in tcx.sess.cstore.crates() {
 563             let def_id = DefId {
 564                 krate: cnum,
 565                 index: CRATE_DEF_INDEX,
 566             };
 567             handle_external_def(tcx, &mut traits, &mut external_mods, Def::Mod(def_id));
 568         }
 569
 570         *tcx.all_traits.borrow_mut() = Some(traits);
 571     }
 572
 573     let borrow = tcx.all_traits.borrow();
 574     assert!(borrow.is_some());
 575     AllTraits {
 576         borrow,
 577         idx: 0,
 578     }
 579 }
 580
 581 pub struct AllTraits<'a> {
 582     borrow: cell::Ref<'a, Option<AllTraitsVec>>,
 583     idx: usize,
 584 }
 585
 586 impl<'a> Iterator for AllTraits<'a> {
 587     type Item = TraitInfo;
 588
 589     fn next(&mut self) -> Option<TraitInfo> {
 590         let AllTraits { ref borrow, ref mut idx } = *self;
 591         // ugh.
 592         borrow.as_ref().unwrap().get(*idx).map(|info| {
 593             *idx += 1;
 594             TraitInfo::new(*info)
 595         })
 596     }
 597 }