compiler/rustc_resolve/src/diagnostics.rs

   1 use std::ptr;
   2
   3 use rustc_ast::ptr::P;
   4 use rustc_ast::visit::{self, Visitor};
   5 use rustc_ast::{self as ast, Crate, ItemKind, ModKind, NodeId, Path, CRATE_NODE_ID};
   6 use rustc_ast_pretty::pprust;
   7 use rustc_data_structures::fx::FxHashSet;
   8 use rustc_errors::struct_span_err;
   9 use rustc_errors::{Applicability, Diagnostic, DiagnosticBuilder, ErrorGuaranteed, MultiSpan};
  10 use rustc_feature::BUILTIN_ATTRIBUTES;
  11 use rustc_hir::def::Namespace::{self, *};
  12 use rustc_hir::def::{self, CtorKind, CtorOf, DefKind, NonMacroAttrKind, PerNS};
  13 use rustc_hir::def_id::{DefId, LocalDefId, CRATE_DEF_ID, LOCAL_CRATE};
  14 use rustc_hir::PrimTy;
  15 use rustc_index::vec::IndexVec;
  16 use rustc_middle::bug;
  17 use rustc_middle::ty::DefIdTree;
  18 use rustc_session::lint::builtin::ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE;
  19 use rustc_session::lint::builtin::MACRO_EXPANDED_MACRO_EXPORTS_ACCESSED_BY_ABSOLUTE_PATHS;
  20 use rustc_session::lint::BuiltinLintDiagnostics;
  21 use rustc_session::Session;
  22 use rustc_span::edition::Edition;
  23 use rustc_span::hygiene::MacroKind;
  24 use rustc_span::lev_distance::find_best_match_for_name;
  25 use rustc_span::source_map::SourceMap;
  26 use rustc_span::symbol::{kw, sym, Ident, Symbol};
  27 use rustc_span::{BytePos, Span};
  28 use tracing::debug;
  29
  30 use crate::imports::{Import, ImportKind, ImportResolver};
  31 use crate::late::{PatternSource, Rib};
  32 use crate::path_names_to_string;
  33 use crate::{AmbiguityError, AmbiguityErrorMisc, AmbiguityKind, BindingError, Finalize};
  34 use crate::{HasGenericParams, MacroRulesScope, Module, ModuleKind, ModuleOrUniformRoot};
  35 use crate::{LexicalScopeBinding, NameBinding, NameBindingKind, PrivacyError, VisResolutionError};
  36 use crate::{ParentScope, PathResult, ResolutionError, Resolver, Scope, ScopeSet};
  37 use crate::{Segment, UseError};
  38
  39 #[cfg(test)]
  40 mod tests;
  41
  42 type Res = def::Res<ast::NodeId>;
  43
  44 /// A vector of spans and replacements, a message and applicability.
  45 pub(crate) type Suggestion = (Vec<(Span, String)>, String, Applicability);
  46
  47 /// Potential candidate for an undeclared or out-of-scope label - contains the ident of a
  48 /// similarly named label and whether or not it is reachable.
  49 pub(crate) type LabelSuggestion = (Ident, bool);
  50
  51 pub(crate) enum SuggestionTarget {
  52     /// The target has a similar name as the name used by the programmer (probably a typo)
  53     SimilarlyNamed,
  54     /// The target is the only valid item that can be used in the corresponding context
  55     SingleItem,
  56 }
  57
  58 pub(crate) struct TypoSuggestion {
  59     pub candidate: Symbol,
  60     pub res: Res,
  61     pub target: SuggestionTarget,
  62 }
  63
  64 impl TypoSuggestion {
  65     pub(crate) fn typo_from_res(candidate: Symbol, res: Res) -> TypoSuggestion {
  66         Self { candidate, res, target: SuggestionTarget::SimilarlyNamed }
  67     }
  68     pub(crate) fn single_item_from_res(candidate: Symbol, res: Res) -> TypoSuggestion {
  69         Self { candidate, res, target: SuggestionTarget::SingleItem }
  70     }
  71 }
  72
  73 /// A free importable items suggested in case of resolution failure.
  74 pub(crate) struct ImportSuggestion {
  75     pub did: Option<DefId>,
  76     pub descr: &'static str,
  77     pub path: Path,
  78     pub accessible: bool,
  79     /// An extra note that should be issued if this item is suggested
  80     pub note: Option<String>,
  81 }
  82
  83 /// Adjust the impl span so that just the `impl` keyword is taken by removing
  84 /// everything after `<` (`"impl<T> Iterator for A<T> {}" -> "impl"`) and
  85 /// everything after the first whitespace (`"impl Iterator for A" -> "impl"`).
  86 ///
  87 /// *Attention*: the method used is very fragile since it essentially duplicates the work of the
  88 /// parser. If you need to use this function or something similar, please consider updating the
  89 /// `source_map` functions and this function to something more robust.
  90 fn reduce_impl_span_to_impl_keyword(sm: &SourceMap, impl_span: Span) -> Span {
  91     let impl_span = sm.span_until_char(impl_span, '<');
  92     sm.span_until_whitespace(impl_span)
  93 }
  94
  95 impl<'a> Resolver<'a> {
  96     pub(crate) fn report_errors(&mut self, krate: &Crate) {
  97         self.report_with_use_injections(krate);
  98
  99         for &(span_use, span_def) in &self.macro_expanded_macro_export_errors {
 100             let msg = "macro-expanded `macro_export` macros from the current crate \
 101                        cannot be referred to by absolute paths";
 102             self.lint_buffer.buffer_lint_with_diagnostic(
 103                 MACRO_EXPANDED_MACRO_EXPORTS_ACCESSED_BY_ABSOLUTE_PATHS,
 104                 CRATE_NODE_ID,
 105                 span_use,
 106                 msg,
 107                 BuiltinLintDiagnostics::MacroExpandedMacroExportsAccessedByAbsolutePaths(span_def),
 108             );
 109         }
 110
 111         for ambiguity_error in &self.ambiguity_errors {
 112             self.report_ambiguity_error(ambiguity_error);
 113         }
 114
 115         let mut reported_spans = FxHashSet::default();
 116         for error in &self.privacy_errors {
 117             if reported_spans.insert(error.dedup_span) {
 118                 self.report_privacy_error(error);
 119             }
 120         }
 121     }
 122
 123     fn report_with_use_injections(&mut self, krate: &Crate) {
 124         for UseError { mut err, candidates, def_id, instead, suggestion, path } in
 125             self.use_injections.drain(..)
 126         {
 127             let (span, found_use) = if let Some(def_id) = def_id.as_local() {
 128                 UsePlacementFinder::check(krate, self.def_id_to_node_id[def_id])
 129             } else {
 130                 (None, FoundUse::No)
 131             };
 132             if !candidates.is_empty() {
 133                 show_candidates(
 134                     &self.session,
 135                     &self.source_span,
 136                     &mut err,
 137                     span,
 138                     &candidates,
 139                     if instead { Instead::Yes } else { Instead::No },
 140                     found_use,
 141                     IsPattern::No,
 142                     path,
 143                 );
 144             } else if let Some((span, msg, sugg, appl)) = suggestion {
 145                 err.span_suggestion(span, msg, sugg, appl);
 146             }
 147             err.emit();
 148         }
 149     }
 150
 151     pub(crate) fn report_conflict<'b>(
 152         &mut self,
 153         parent: Module<'_>,
 154         ident: Ident,
 155         ns: Namespace,
 156         new_binding: &NameBinding<'b>,
 157         old_binding: &NameBinding<'b>,
 158     ) {
 159         // Error on the second of two conflicting names
 160         if old_binding.span.lo() > new_binding.span.lo() {
 161             return self.report_conflict(parent, ident, ns, old_binding, new_binding);
 162         }
 163
 164         let container = match parent.kind {
 165             ModuleKind::Def(kind, _, _) => kind.descr(parent.def_id()),
 166             ModuleKind::Block(..) => "block",
 167         };
 168
 169         let old_noun = match old_binding.is_import() {
 170             true => "import",
 171             false => "definition",
 172         };
 173
 174         let new_participle = match new_binding.is_import() {
 175             true => "imported",
 176             false => "defined",
 177         };
 178
 179         let (name, span) =
 180             (ident.name, self.session.source_map().guess_head_span(new_binding.span));
 181
 182         if let Some(s) = self.name_already_seen.get(&name) {
 183             if s == &span {
 184                 return;
 185             }
 186         }
 187
 188         let old_kind = match (ns, old_binding.module()) {
 189             (ValueNS, _) => "value",
 190             (MacroNS, _) => "macro",
 191             (TypeNS, _) if old_binding.is_extern_crate() => "extern crate",
 192             (TypeNS, Some(module)) if module.is_normal() => "module",
 193             (TypeNS, Some(module)) if module.is_trait() => "trait",
 194             (TypeNS, _) => "type",
 195         };
 196
 197         let msg = format!("the name `{}` is defined multiple times", name);
 198
 199         let mut err = match (old_binding.is_extern_crate(), new_binding.is_extern_crate()) {
 200             (true, true) => struct_span_err!(self.session, span, E0259, "{}", msg),
 201             (true, _) | (_, true) => match new_binding.is_import() && old_binding.is_import() {
 202                 true => struct_span_err!(self.session, span, E0254, "{}", msg),
 203                 false => struct_span_err!(self.session, span, E0260, "{}", msg),
 204             },
 205             _ => match (old_binding.is_import(), new_binding.is_import()) {
 206                 (false, false) => struct_span_err!(self.session, span, E0428, "{}", msg),
 207                 (true, true) => struct_span_err!(self.session, span, E0252, "{}", msg),
 208                 _ => struct_span_err!(self.session, span, E0255, "{}", msg),
 209             },
 210         };
 211
 212         err.note(&format!(
 213             "`{}` must be defined only once in the {} namespace of this {}",
 214             name,
 215             ns.descr(),
 216             container
 217         ));
 218
 219         err.span_label(span, format!("`{}` re{} here", name, new_participle));
 220         err.span_label(
 221             self.session.source_map().guess_head_span(old_binding.span),
 222             format!("previous {} of the {} `{}` here", old_noun, old_kind, name),
 223         );
 224
 225         // See https://github.com/rust-lang/rust/issues/32354
 226         use NameBindingKind::Import;
 227         let import = match (&new_binding.kind, &old_binding.kind) {
 228             // If there are two imports where one or both have attributes then prefer removing the
 229             // import without attributes.
 230             (Import { import: new, .. }, Import { import: old, .. })
 231                 if {
 232                     !new_binding.span.is_dummy()
 233                         && !old_binding.span.is_dummy()
 234                         && (new.has_attributes || old.has_attributes)
 235                 } =>
 236             {
 237                 if old.has_attributes {
 238                     Some((new, new_binding.span, true))
 239                 } else {
 240                     Some((old, old_binding.span, true))
 241                 }
 242             }
 243             // Otherwise prioritize the new binding.
 244             (Import { import, .. }, other) if !new_binding.span.is_dummy() => {
 245                 Some((import, new_binding.span, other.is_import()))
 246             }
 247             (other, Import { import, .. }) if !old_binding.span.is_dummy() => {
 248                 Some((import, old_binding.span, other.is_import()))
 249             }
 250             _ => None,
 251         };
 252
 253         // Check if the target of the use for both bindings is the same.
 254         let duplicate = new_binding.res().opt_def_id() == old_binding.res().opt_def_id();
 255         let has_dummy_span = new_binding.span.is_dummy() || old_binding.span.is_dummy();
 256         let from_item =
 257             self.extern_prelude.get(&ident).map_or(true, |entry| entry.introduced_by_item);
 258         // Only suggest removing an import if both bindings are to the same def, if both spans
 259         // aren't dummy spans. Further, if both bindings are imports, then the ident must have
 260         // been introduced by an item.
 261         let should_remove_import = duplicate
 262             && !has_dummy_span
 263             && ((new_binding.is_extern_crate() || old_binding.is_extern_crate()) || from_item);
 264
 265         match import {
 266             Some((import, span, true)) if should_remove_import && import.is_nested() => {
 267                 self.add_suggestion_for_duplicate_nested_use(&mut err, import, span)
 268             }
 269             Some((import, _, true)) if should_remove_import && !import.is_glob() => {
 270                 // Simple case - remove the entire import. Due to the above match arm, this can
 271                 // only be a single use so just remove it entirely.
 272                 err.tool_only_span_suggestion(
 273                     import.use_span_with_attributes,
 274                     "remove unnecessary import",
 275                     "",
 276                     Applicability::MaybeIncorrect,
 277                 );
 278             }
 279             Some((import, span, _)) => {
 280                 self.add_suggestion_for_rename_of_use(&mut err, name, import, span)
 281             }
 282             _ => {}
 283         }
 284
 285         err.emit();
 286         self.name_already_seen.insert(name, span);
 287     }
 288
 289     /// This function adds a suggestion to change the binding name of a new import that conflicts
 290     /// with an existing import.
 291     ///
 292     /// ```text,ignore (diagnostic)
 293     /// help: you can use `as` to change the binding name of the import
 294     ///    |
 295     /// LL | use foo::bar as other_bar;
 296     ///    |     ^^^^^^^^^^^^^^^^^^^^^
 297     /// ```
 298     fn add_suggestion_for_rename_of_use(
 299         &self,
 300         err: &mut Diagnostic,
 301         name: Symbol,
 302         import: &Import<'_>,
 303         binding_span: Span,
 304     ) {
 305         let suggested_name = if name.as_str().chars().next().unwrap().is_uppercase() {
 306             format!("Other{}", name)
 307         } else {
 308             format!("other_{}", name)
 309         };
 310
 311         let mut suggestion = None;
 312         match import.kind {
 313             ImportKind::Single { type_ns_only: true, .. } => {
 314                 suggestion = Some(format!("self as {}", suggested_name))
 315             }
 316             ImportKind::Single { source, .. } => {
 317                 if let Some(pos) =
 318                     source.span.hi().0.checked_sub(binding_span.lo().0).map(|pos| pos as usize)
 319                 {
 320                     if let Ok(snippet) = self.session.source_map().span_to_snippet(binding_span) {
 321                         if pos <= snippet.len() {
 322                             suggestion = Some(format!(
 323                                 "{} as {}{}",
 324                                 &snippet[..pos],
 325                                 suggested_name,
 326                                 if snippet.ends_with(';') { ";" } else { "" }
 327                             ))
 328                         }
 329                     }
 330                 }
 331             }
 332             ImportKind::ExternCrate { source, target } => {
 333                 suggestion = Some(format!(
 334                     "extern crate {} as {};",
 335                     source.unwrap_or(target.name),
 336                     suggested_name,
 337                 ))
 338             }
 339             _ => unreachable!(),
 340         }
 341
 342         let rename_msg = "you can use `as` to change the binding name of the import";
 343         if let Some(suggestion) = suggestion {
 344             err.span_suggestion(
 345                 binding_span,
 346                 rename_msg,
 347                 suggestion,
 348                 Applicability::MaybeIncorrect,
 349             );
 350         } else {
 351             err.span_label(binding_span, rename_msg);
 352         }
 353     }
 354
 355     /// This function adds a suggestion to remove an unnecessary binding from an import that is
 356     /// nested. In the following example, this function will be invoked to remove the `a` binding
 357     /// in the second use statement:
 358     ///
 359     /// ```ignore (diagnostic)
 360     /// use issue_52891::a;
 361     /// use issue_52891::{d, a, e};
 362     /// ```
 363     ///
 364     /// The following suggestion will be added:
 365     ///
 366     /// ```ignore (diagnostic)
 367     /// use issue_52891::{d, a, e};
 368     ///                      ^-- help: remove unnecessary import
 369     /// ```
 370     ///
 371     /// If the nested use contains only one import then the suggestion will remove the entire
 372     /// line.
 373     ///
 374     /// It is expected that the provided import is nested - this isn't checked by the
 375     /// function. If this invariant is not upheld, this function's behaviour will be unexpected
 376     /// as characters expected by span manipulations won't be present.
 377     fn add_suggestion_for_duplicate_nested_use(
 378         &self,
 379         err: &mut Diagnostic,
 380         import: &Import<'_>,
 381         binding_span: Span,
 382     ) {
 383         assert!(import.is_nested());
 384         let message = "remove unnecessary import";
 385
 386         // Two examples will be used to illustrate the span manipulations we're doing:
 387         //
 388         // - Given `use issue_52891::{d, a, e};` where `a` is a duplicate then `binding_span` is
 389         //   `a` and `import.use_span` is `issue_52891::{d, a, e};`.
 390         // - Given `use issue_52891::{d, e, a};` where `a` is a duplicate then `binding_span` is
 391         //   `a` and `import.use_span` is `issue_52891::{d, e, a};`.
 392
 393         let (found_closing_brace, span) =
 394             find_span_of_binding_until_next_binding(self.session, binding_span, import.use_span);
 395
 396         // If there was a closing brace then identify the span to remove any trailing commas from
 397         // previous imports.
 398         if found_closing_brace {
 399             if let Some(span) = extend_span_to_previous_binding(self.session, span) {
 400                 err.tool_only_span_suggestion(span, message, "", Applicability::MaybeIncorrect);
 401             } else {
 402                 // Remove the entire line if we cannot extend the span back, this indicates an
 403                 // `issue_52891::{self}` case.
 404                 err.span_suggestion(
 405                     import.use_span_with_attributes,
 406                     message,
 407                     "",
 408                     Applicability::MaybeIncorrect,
 409                 );
 410             }
 411
 412             return;
 413         }
 414
 415         err.span_suggestion(span, message, "", Applicability::MachineApplicable);
 416     }
 417
 418     pub(crate) fn lint_if_path_starts_with_module(
 419         &mut self,
 420         finalize: Option<Finalize>,
 421         path: &[Segment],
 422         second_binding: Option<&NameBinding<'_>>,
 423     ) {
 424         let Some(Finalize { node_id, root_span, .. }) = finalize else {
 425             return;
 426         };
 427
 428         let first_name = match path.get(0) {
 429             // In the 2018 edition this lint is a hard error, so nothing to do
 430             Some(seg) if seg.ident.span.rust_2015() && self.session.rust_2015() => seg.ident.name,
 431             _ => return,
 432         };
 433
 434         // We're only interested in `use` paths which should start with
 435         // `{{root}}` currently.
 436         if first_name != kw::PathRoot {
 437             return;
 438         }
 439
 440         match path.get(1) {
 441             // If this import looks like `crate::...` it's already good
 442             Some(Segment { ident, .. }) if ident.name == kw::Crate => return,
 443             // Otherwise go below to see if it's an extern crate
 444             Some(_) => {}
 445             // If the path has length one (and it's `PathRoot` most likely)
 446             // then we don't know whether we're gonna be importing a crate or an
 447             // item in our crate. Defer this lint to elsewhere
 448             None => return,
 449         }
 450
 451         // If the first element of our path was actually resolved to an
 452         // `ExternCrate` (also used for `crate::...`) then no need to issue a
 453         // warning, this looks all good!
 454         if let Some(binding) = second_binding {
 455             if let NameBindingKind::Import { import, .. } = binding.kind {
 456                 // Careful: we still want to rewrite paths from renamed extern crates.
 457                 if let ImportKind::ExternCrate { source: None, .. } = import.kind {
 458                     return;
 459                 }
 460             }
 461         }
 462
 463         let diag = BuiltinLintDiagnostics::AbsPathWithModule(root_span);
 464         self.lint_buffer.buffer_lint_with_diagnostic(
 465             ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE,
 466             node_id,
 467             root_span,
 468             "absolute paths must start with `self`, `super`, \
 469              `crate`, or an external crate name in the 2018 edition",
 470             diag,
 471         );
 472     }
 473
 474     pub(crate) fn add_module_candidates(
 475         &mut self,
 476         module: Module<'a>,
 477         names: &mut Vec<TypoSuggestion>,
 478         filter_fn: &impl Fn(Res) -> bool,
 479     ) {
 480         for (key, resolution) in self.resolutions(module).borrow().iter() {
 481             if let Some(binding) = resolution.borrow().binding {
 482                 let res = binding.res();
 483                 if filter_fn(res) {
 484                     names.push(TypoSuggestion::typo_from_res(key.ident.name, res));
 485                 }
 486             }
 487         }
 488     }
 489
 490     /// Combines an error with provided span and emits it.
 491     ///
 492     /// This takes the error provided, combines it with the span and any additional spans inside the
 493     /// error and emits it.
 494     pub(crate) fn report_error(&mut self, span: Span, resolution_error: ResolutionError<'a>) {
 495         self.into_struct_error(span, resolution_error).emit();
 496     }
 497
 498     pub(crate) fn into_struct_error(
 499         &mut self,
 500         span: Span,
 501         resolution_error: ResolutionError<'a>,
 502     ) -> DiagnosticBuilder<'_, ErrorGuaranteed> {
 503         match resolution_error {
 504             ResolutionError::GenericParamsFromOuterFunction(outer_res, has_generic_params) => {
 505                 let mut err = struct_span_err!(
 506                     self.session,
 507                     span,
 508                     E0401,
 509                     "can't use generic parameters from outer function",
 510                 );
 511                 err.span_label(span, "use of generic parameter from outer function");
 512
 513                 let sm = self.session.source_map();
 514                 match outer_res {
 515                     Res::SelfTy { trait_: maybe_trait_defid, alias_to: maybe_impl_defid } => {
 516                         if let Some(impl_span) =
 517                             maybe_impl_defid.and_then(|(def_id, _)| self.opt_span(def_id))
 518                         {
 519                             err.span_label(
 520                                 reduce_impl_span_to_impl_keyword(sm, impl_span),
 521                                 "`Self` type implicitly declared here, by this `impl`",
 522                             );
 523                         }
 524                         match (maybe_trait_defid, maybe_impl_defid) {
 525                             (Some(_), None) => {
 526                                 err.span_label(span, "can't use `Self` here");
 527                             }
 528                             (_, Some(_)) => {
 529                                 err.span_label(span, "use a type here instead");
 530                             }
 531                             (None, None) => bug!("`impl` without trait nor type?"),
 532                         }
 533                         return err;
 534                     }
 535                     Res::Def(DefKind::TyParam, def_id) => {
 536                         if let Some(span) = self.opt_span(def_id) {
 537                             err.span_label(span, "type parameter from outer function");
 538                         }
 539                     }
 540                     Res::Def(DefKind::ConstParam, def_id) => {
 541                         if let Some(span) = self.opt_span(def_id) {
 542                             err.span_label(span, "const parameter from outer function");
 543                         }
 544                     }
 545                     _ => {
 546                         bug!(
 547                             "GenericParamsFromOuterFunction should only be used with Res::SelfTy, \
 548                             DefKind::TyParam or DefKind::ConstParam"
 549                         );
 550                     }
 551                 }
 552
 553                 if has_generic_params == HasGenericParams::Yes {
 554                     // Try to retrieve the span of the function signature and generate a new
 555                     // message with a local type or const parameter.
 556                     let sugg_msg = "try using a local generic parameter instead";
 557                     if let Some((sugg_span, snippet)) = sm.generate_local_type_param_snippet(span) {
 558                         // Suggest the modification to the user
 559                         err.span_suggestion(
 560                             sugg_span,
 561                             sugg_msg,
 562                             snippet,
 563                             Applicability::MachineApplicable,
 564                         );
 565                     } else if let Some(sp) = sm.generate_fn_name_span(span) {
 566                         err.span_label(
 567                             sp,
 568                             "try adding a local generic parameter in this method instead"
 569                                 .to_string(),
 570                         );
 571                     } else {
 572                         err.help("try using a local generic parameter instead");
 573                     }
 574                 }
 575
 576                 err
 577             }
 578             ResolutionError::NameAlreadyUsedInParameterList(name, first_use_span) => {
 579                 let mut err = struct_span_err!(
 580                     self.session,
 581                     span,
 582                     E0403,
 583                     "the name `{}` is already used for a generic \
 584                      parameter in this item's generic parameters",
 585                     name,
 586                 );
 587                 err.span_label(span, "already used");
 588                 err.span_label(first_use_span, format!("first use of `{}`", name));
 589                 err
 590             }
 591             ResolutionError::MethodNotMemberOfTrait(method, trait_, candidate) => {
 592                 let mut err = struct_span_err!(
 593                     self.session,
 594                     span,
 595                     E0407,
 596                     "method `{}` is not a member of trait `{}`",
 597                     method,
 598                     trait_
 599                 );
 600                 err.span_label(span, format!("not a member of trait `{}`", trait_));
 601                 if let Some(candidate) = candidate {
 602                     err.span_suggestion(
 603                         method.span,
 604                         "there is an associated function with a similar name",
 605                         candidate.to_ident_string(),
 606                         Applicability::MaybeIncorrect,
 607                     );
 608                 }
 609                 err
 610             }
 611             ResolutionError::TypeNotMemberOfTrait(type_, trait_, candidate) => {
 612                 let mut err = struct_span_err!(
 613                     self.session,
 614                     span,
 615                     E0437,
 616                     "type `{}` is not a member of trait `{}`",
 617                     type_,
 618                     trait_
 619                 );
 620                 err.span_label(span, format!("not a member of trait `{}`", trait_));
 621                 if let Some(candidate) = candidate {
 622                     err.span_suggestion(
 623                         type_.span,
 624                         "there is an associated type with a similar name",
 625                         candidate.to_ident_string(),
 626                         Applicability::MaybeIncorrect,
 627                     );
 628                 }
 629                 err
 630             }
 631             ResolutionError::ConstNotMemberOfTrait(const_, trait_, candidate) => {
 632                 let mut err = struct_span_err!(
 633                     self.session,
 634                     span,
 635                     E0438,
 636                     "const `{}` is not a member of trait `{}`",
 637                     const_,
 638                     trait_
 639                 );
 640                 err.span_label(span, format!("not a member of trait `{}`", trait_));
 641                 if let Some(candidate) = candidate {
 642                     err.span_suggestion(
 643                         const_.span,
 644                         "there is an associated constant with a similar name",
 645                         candidate.to_ident_string(),
 646                         Applicability::MaybeIncorrect,
 647                     );
 648                 }
 649                 err
 650             }
 651             ResolutionError::VariableNotBoundInPattern(binding_error, parent_scope) => {
 652                 let BindingError { name, target, origin, could_be_path } = binding_error;
 653
 654                 let target_sp = target.iter().copied().collect::<Vec<_>>();
 655                 let origin_sp = origin.iter().copied().collect::<Vec<_>>();
 656
 657                 let msp = MultiSpan::from_spans(target_sp.clone());
 658                 let mut err = struct_span_err!(
 659                     self.session,
 660                     msp,
 661                     E0408,
 662                     "variable `{}` is not bound in all patterns",
 663                     name,
 664                 );
 665                 for sp in target_sp {
 666                     err.span_label(sp, format!("pattern doesn't bind `{}`", name));
 667                 }
 668                 for sp in origin_sp {
 669                     err.span_label(sp, "variable not in all patterns");
 670                 }
 671                 if could_be_path {
 672                     let import_suggestions = self.lookup_import_candidates(
 673                         Ident::with_dummy_span(name),
 674                         Namespace::ValueNS,
 675                         &parent_scope,
 676                         &|res: Res| match res {
 677                             Res::Def(
 678                                 DefKind::Ctor(CtorOf::Variant, CtorKind::Const)
 679                                 | DefKind::Ctor(CtorOf::Struct, CtorKind::Const)
 680                                 | DefKind::Const
 681                                 | DefKind::AssocConst,
 682                                 _,
 683                             ) => true,
 684                             _ => false,
 685                         },
 686                     );
 687
 688                     if import_suggestions.is_empty() {
 689                         let help_msg = format!(
 690                             "if you meant to match on a variant or a `const` item, consider \
 691                              making the path in the pattern qualified: `path::to::ModOrType::{}`",
 692                             name,
 693                         );
 694                         err.span_help(span, &help_msg);
 695                     }
 696                     show_candidates(
 697                         &self.session,
 698                         &self.source_span,
 699                         &mut err,
 700                         Some(span),
 701                         &import_suggestions,
 702                         Instead::No,
 703                         FoundUse::Yes,
 704                         IsPattern::Yes,
 705                         vec![],
 706                     );
 707                 }
 708                 err
 709             }
 710             ResolutionError::VariableBoundWithDifferentMode(variable_name, first_binding_span) => {
 711                 let mut err = struct_span_err!(
 712                     self.session,
 713                     span,
 714                     E0409,
 715                     "variable `{}` is bound inconsistently across alternatives separated by `|`",
 716                     variable_name
 717                 );
 718                 err.span_label(span, "bound in different ways");
 719                 err.span_label(first_binding_span, "first binding");
 720                 err
 721             }
 722             ResolutionError::IdentifierBoundMoreThanOnceInParameterList(identifier) => {
 723                 let mut err = struct_span_err!(
 724                     self.session,
 725                     span,
 726                     E0415,
 727                     "identifier `{}` is bound more than once in this parameter list",
 728                     identifier
 729                 );
 730                 err.span_label(span, "used as parameter more than once");
 731                 err
 732             }
 733             ResolutionError::IdentifierBoundMoreThanOnceInSamePattern(identifier) => {
 734                 let mut err = struct_span_err!(
 735                     self.session,
 736                     span,
 737                     E0416,
 738                     "identifier `{}` is bound more than once in the same pattern",
 739                     identifier
 740                 );
 741                 err.span_label(span, "used in a pattern more than once");
 742                 err
 743             }
 744             ResolutionError::UndeclaredLabel { name, suggestion } => {
 745                 let mut err = struct_span_err!(
 746                     self.session,
 747                     span,
 748                     E0426,
 749                     "use of undeclared label `{}`",
 750                     name
 751                 );
 752
 753                 err.span_label(span, format!("undeclared label `{}`", name));
 754
 755                 match suggestion {
 756                     // A reachable label with a similar name exists.
 757                     Some((ident, true)) => {
 758                         err.span_label(ident.span, "a label with a similar name is reachable");
 759                         err.span_suggestion(
 760                             span,
 761                             "try using similarly named label",
 762                             ident.name,
 763                             Applicability::MaybeIncorrect,
 764                         );
 765                     }
 766                     // An unreachable label with a similar name exists.
 767                     Some((ident, false)) => {
 768                         err.span_label(
 769                             ident.span,
 770                             "a label with a similar name exists but is unreachable",
 771                         );
 772                     }
 773                     // No similarly-named labels exist.
 774                     None => (),
 775                 }
 776
 777                 err
 778             }
 779             ResolutionError::SelfImportsOnlyAllowedWithin { root, span_with_rename } => {
 780                 let mut err = struct_span_err!(
 781                     self.session,
 782                     span,
 783                     E0429,
 784                     "{}",
 785                     "`self` imports are only allowed within a { } list"
 786                 );
 787
 788                 // None of the suggestions below would help with a case like `use self`.
 789                 if !root {
 790                     // use foo::bar::self        -> foo::bar
 791                     // use foo::bar::self as abc -> foo::bar as abc
 792                     err.span_suggestion(
 793                         span,
 794                         "consider importing the module directly",
 795                         "",
 796                         Applicability::MachineApplicable,
 797                     );
 798
 799                     // use foo::bar::self        -> foo::bar::{self}
 800                     // use foo::bar::self as abc -> foo::bar::{self as abc}
 801                     let braces = vec![
 802                         (span_with_rename.shrink_to_lo(), "{".to_string()),
 803                         (span_with_rename.shrink_to_hi(), "}".to_string()),
 804                     ];
 805                     err.multipart_suggestion(
 806                         "alternatively, use the multi-path `use` syntax to import `self`",
 807                         braces,
 808                         Applicability::MachineApplicable,
 809                     );
 810                 }
 811                 err
 812             }
 813             ResolutionError::SelfImportCanOnlyAppearOnceInTheList => {
 814                 let mut err = struct_span_err!(
 815                     self.session,
 816                     span,
 817                     E0430,
 818                     "`self` import can only appear once in an import list"
 819                 );
 820                 err.span_label(span, "can only appear once in an import list");
 821                 err
 822             }
 823             ResolutionError::SelfImportOnlyInImportListWithNonEmptyPrefix => {
 824                 let mut err = struct_span_err!(
 825                     self.session,
 826                     span,
 827                     E0431,
 828                     "`self` import can only appear in an import list with \
 829                                                 a non-empty prefix"
 830                 );
 831                 err.span_label(span, "can only appear in an import list with a non-empty prefix");
 832                 err
 833             }
 834             ResolutionError::FailedToResolve { label, suggestion } => {
 835                 let mut err =
 836                     struct_span_err!(self.session, span, E0433, "failed to resolve: {}", &label);
 837                 err.span_label(span, label);
 838
 839                 if let Some((suggestions, msg, applicability)) = suggestion {
 840                     if suggestions.is_empty() {
 841                         err.help(&msg);
 842                         return err;
 843                     }
 844                     err.multipart_suggestion(&msg, suggestions, applicability);
 845                 }
 846
 847                 err
 848             }
 849             ResolutionError::CannotCaptureDynamicEnvironmentInFnItem => {
 850                 let mut err = struct_span_err!(
 851                     self.session,
 852                     span,
 853                     E0434,
 854                     "{}",
 855                     "can't capture dynamic environment in a fn item"
 856                 );
 857                 err.help("use the `|| { ... }` closure form instead");
 858                 err
 859             }
 860             ResolutionError::AttemptToUseNonConstantValueInConstant(ident, sugg, current) => {
 861                 let mut err = struct_span_err!(
 862                     self.session,
 863                     span,
 864                     E0435,
 865                     "attempt to use a non-constant value in a constant"
 866                 );
 867                 // let foo =...
 868                 //     ^^^ given this Span
 869                 // ------- get this Span to have an applicable suggestion
 870
 871                 // edit:
 872                 // only do this if the const and usage of the non-constant value are on the same line
 873                 // the further the two are apart, the higher the chance of the suggestion being wrong
 874
 875                 let sp = self
 876                     .session
 877                     .source_map()
 878                     .span_extend_to_prev_str(ident.span, current, true, false);
 879
 880                 match sp {
 881                     Some(sp) if !self.session.source_map().is_multiline(sp) => {
 882                         let sp = sp.with_lo(BytePos(sp.lo().0 - (current.len() as u32)));
 883                         err.span_suggestion(
 884                             sp,
 885                             &format!("consider using `{}` instead of `{}`", sugg, current),
 886                             format!("{} {}", sugg, ident),
 887                             Applicability::MaybeIncorrect,
 888                         );
 889                         err.span_label(span, "non-constant value");
 890                     }
 891                     _ => {
 892                         err.span_label(ident.span, &format!("this would need to be a `{}`", sugg));
 893                     }
 894                 }
 895
 896                 err
 897             }
 898             ResolutionError::BindingShadowsSomethingUnacceptable {
 899                 shadowing_binding,
 900                 name,
 901                 participle,
 902                 article,
 903                 shadowed_binding,
 904                 shadowed_binding_span,
 905             } => {
 906                 let shadowed_binding_descr = shadowed_binding.descr();
 907                 let mut err = struct_span_err!(
 908                     self.session,
 909                     span,
 910                     E0530,
 911                     "{}s cannot shadow {}s",
 912                     shadowing_binding.descr(),
 913                     shadowed_binding_descr,
 914                 );
 915                 err.span_label(
 916                     span,
 917                     format!("cannot be named the same as {} {}", article, shadowed_binding_descr),
 918                 );
 919                 match (shadowing_binding, shadowed_binding) {
 920                     (
 921                         PatternSource::Match,
 922                         Res::Def(DefKind::Ctor(CtorOf::Variant | CtorOf::Struct, CtorKind::Fn), _),
 923                     ) => {
 924                         err.span_suggestion(
 925                             span,
 926                             "try specify the pattern arguments",
 927                             format!("{}(..)", name),
 928                             Applicability::Unspecified,
 929                         );
 930                     }
 931                     _ => (),
 932                 }
 933                 let msg =
 934                     format!("the {} `{}` is {} here", shadowed_binding_descr, name, participle);
 935                 err.span_label(shadowed_binding_span, msg);
 936                 err
 937             }
 938             ResolutionError::ForwardDeclaredGenericParam => {
 939                 let mut err = struct_span_err!(
 940                     self.session,
 941                     span,
 942                     E0128,
 943                     "generic parameters with a default cannot use \
 944                                                 forward declared identifiers"
 945                 );
 946                 err.span_label(span, "defaulted generic parameters cannot be forward declared");
 947                 err
 948             }
 949             ResolutionError::ParamInTyOfConstParam(name) => {
 950                 let mut err = struct_span_err!(
 951                     self.session,
 952                     span,
 953                     E0770,
 954                     "the type of const parameters must not depend on other generic parameters"
 955                 );
 956                 err.span_label(
 957                     span,
 958                     format!("the type must not depend on the parameter `{}`", name),
 959                 );
 960                 err
 961             }
 962             ResolutionError::ParamInNonTrivialAnonConst { name, is_type } => {
 963                 let mut err = self.session.struct_span_err(
 964                     span,
 965                     "generic parameters may not be used in const operations",
 966                 );
 967                 err.span_label(span, &format!("cannot perform const operation using `{}`", name));
 968
 969                 if is_type {
 970                     err.note("type parameters may not be used in const expressions");
 971                 } else {
 972                     err.help(&format!(
 973                         "const parameters may only be used as standalone arguments, i.e. `{}`",
 974                         name
 975                     ));
 976                 }
 977
 978                 if self.session.is_nightly_build() {
 979                     err.help(
 980                         "use `#![feature(generic_const_exprs)]` to allow generic const expressions",
 981                     );
 982                 }
 983
 984                 err
 985             }
 986             ResolutionError::SelfInGenericParamDefault => {
 987                 let mut err = struct_span_err!(
 988                     self.session,
 989                     span,
 990                     E0735,
 991                     "generic parameters cannot use `Self` in their defaults"
 992                 );
 993                 err.span_label(span, "`Self` in generic parameter default");
 994                 err
 995             }
 996             ResolutionError::UnreachableLabel { name, definition_span, suggestion } => {
 997                 let mut err = struct_span_err!(
 998                     self.session,
 999                     span,
1000                     E0767,
1001                     "use of unreachable label `{}`",
1002                     name,
1003                 );
1004
1005                 err.span_label(definition_span, "unreachable label defined here");
1006                 err.span_label(span, format!("unreachable label `{}`", name));
1007                 err.note(
1008                     "labels are unreachable through functions, closures, async blocks and modules",
1009                 );
1010
1011                 match suggestion {
1012                     // A reachable label with a similar name exists.
1013                     Some((ident, true)) => {
1014                         err.span_label(ident.span, "a label with a similar name is reachable");
1015                         err.span_suggestion(
1016                             span,
1017                             "try using similarly named label",
1018                             ident.name,
1019                             Applicability::MaybeIncorrect,
1020                         );
1021                     }
1022                     // An unreachable label with a similar name exists.
1023                     Some((ident, false)) => {
1024                         err.span_label(
1025                             ident.span,
1026                             "a label with a similar name exists but is also unreachable",
1027                         );
1028                     }
1029                     // No similarly-named labels exist.
1030                     None => (),
1031                 }
1032
1033                 err
1034             }
1035             ResolutionError::TraitImplMismatch {
1036                 name,
1037                 kind,
1038                 code,
1039                 trait_item_span,
1040                 trait_path,
1041             } => {
1042                 let mut err = self.session.struct_span_err_with_code(
1043                     span,
1044                     &format!(
1045                         "item `{}` is an associated {}, which doesn't match its trait `{}`",
1046                         name, kind, trait_path,
1047                     ),
1048                     code,
1049                 );
1050                 err.span_label(span, "does not match trait");
1051                 err.span_label(trait_item_span, "item in trait");
1052                 err
1053             }
1054             ResolutionError::InvalidAsmSym => {
1055                 let mut err = self.session.struct_span_err(span, "invalid `sym` operand");
1056                 err.span_label(span, "is a local variable");
1057                 err.help("`sym` operands must refer to either a function or a static");
1058                 err
1059             }
1060         }
1061     }
1062
1063     pub(crate) fn report_vis_error(
1064         &mut self,
1065         vis_resolution_error: VisResolutionError<'_>,
1066     ) -> ErrorGuaranteed {
1067         match vis_resolution_error {
1068             VisResolutionError::Relative2018(span, path) => {
1069                 let mut err = self.session.struct_span_err(
1070                     span,
1071                     "relative paths are not supported in visibilities in 2018 edition or later",
1072                 );
1073                 err.span_suggestion(
1074                     path.span,
1075                     "try",
1076                     format!("crate::{}", pprust::path_to_string(&path)),
1077                     Applicability::MaybeIncorrect,
1078                 );
1079                 err
1080             }
1081             VisResolutionError::AncestorOnly(span) => struct_span_err!(
1082                 self.session,
1083                 span,
1084                 E0742,
1085                 "visibilities can only be restricted to ancestor modules"
1086             ),
1087             VisResolutionError::FailedToResolve(span, label, suggestion) => {
1088                 self.into_struct_error(span, ResolutionError::FailedToResolve { label, suggestion })
1089             }
1090             VisResolutionError::ExpectedFound(span, path_str, res) => {
1091                 let mut err = struct_span_err!(
1092                     self.session,
1093                     span,
1094                     E0577,
1095                     "expected module, found {} `{}`",
1096                     res.descr(),
1097                     path_str
1098                 );
1099                 err.span_label(span, "not a module");
1100                 err
1101             }
1102             VisResolutionError::Indeterminate(span) => struct_span_err!(
1103                 self.session,
1104                 span,
1105                 E0578,
1106                 "cannot determine resolution for the visibility"
1107             ),
1108             VisResolutionError::ModuleOnly(span) => {
1109                 self.session.struct_span_err(span, "visibility must resolve to a module")
1110             }
1111         }
1112         .emit()
1113     }
1114
1115     /// Lookup typo candidate in scope for a macro or import.
1116     fn early_lookup_typo_candidate(
1117         &mut self,
1118         scope_set: ScopeSet<'a>,
1119         parent_scope: &ParentScope<'a>,
1120         ident: Ident,
1121         filter_fn: &impl Fn(Res) -> bool,
1122     ) -> Option<TypoSuggestion> {
1123         let mut suggestions = Vec::new();
1124         let ctxt = ident.span.ctxt();
1125         self.visit_scopes(scope_set, parent_scope, ctxt, |this, scope, use_prelude, _| {
1126             match scope {
1127                 Scope::DeriveHelpers(expn_id) => {
1128                     let res = Res::NonMacroAttr(NonMacroAttrKind::DeriveHelper);
1129                     if filter_fn(res) {
1130                         suggestions.extend(
1131                             this.helper_attrs
1132                                 .get(&expn_id)
1133                                 .into_iter()
1134                                 .flatten()
1135                                 .map(|ident| TypoSuggestion::typo_from_res(ident.name, res)),
1136                         );
1137                     }
1138                 }
1139                 Scope::DeriveHelpersCompat => {
1140                     let res = Res::NonMacroAttr(NonMacroAttrKind::DeriveHelperCompat);
1141                     if filter_fn(res) {
1142                         for derive in parent_scope.derives {
1143                             let parent_scope = &ParentScope { derives: &[], ..*parent_scope };
1144                             if let Ok((Some(ext), _)) = this.resolve_macro_path(
1145                                 derive,
1146                                 Some(MacroKind::Derive),
1147                                 parent_scope,
1148                                 false,
1149                                 false,
1150                             ) {
1151                                 suggestions.extend(
1152                                     ext.helper_attrs
1153                                         .iter()
1154                                         .map(|name| TypoSuggestion::typo_from_res(*name, res)),
1155                                 );
1156                             }
1157                         }
1158                     }
1159                 }
1160                 Scope::MacroRules(macro_rules_scope) => {
1161                     if let MacroRulesScope::Binding(macro_rules_binding) = macro_rules_scope.get() {
1162                         let res = macro_rules_binding.binding.res();
1163                         if filter_fn(res) {
1164                             suggestions.push(TypoSuggestion::typo_from_res(
1165                                 macro_rules_binding.ident.name,
1166                                 res,
1167                             ))
1168                         }
1169                     }
1170                 }
1171                 Scope::CrateRoot => {
1172                     let root_ident = Ident::new(kw::PathRoot, ident.span);
1173                     let root_module = this.resolve_crate_root(root_ident);
1174                     this.add_module_candidates(root_module, &mut suggestions, filter_fn);
1175                 }
1176                 Scope::Module(module, _) => {
1177                     this.add_module_candidates(module, &mut suggestions, filter_fn);
1178                 }
1179                 Scope::RegisteredAttrs => {
1180                     let res = Res::NonMacroAttr(NonMacroAttrKind::Registered);
1181                     if filter_fn(res) {
1182                         suggestions.extend(
1183                             this.registered_attrs
1184                                 .iter()
1185                                 .map(|ident| TypoSuggestion::typo_from_res(ident.name, res)),
1186                         );
1187                     }
1188                 }
1189                 Scope::MacroUsePrelude => {
1190                     suggestions.extend(this.macro_use_prelude.iter().filter_map(
1191                         |(name, binding)| {
1192                             let res = binding.res();
1193                             filter_fn(res).then_some(TypoSuggestion::typo_from_res(*name, res))
1194                         },
1195                     ));
1196                 }
1197                 Scope::BuiltinAttrs => {
1198                     let res = Res::NonMacroAttr(NonMacroAttrKind::Builtin(kw::Empty));
1199                     if filter_fn(res) {
1200                         suggestions.extend(
1201                             BUILTIN_ATTRIBUTES
1202                                 .iter()
1203                                 .map(|attr| TypoSuggestion::typo_from_res(attr.name, res)),
1204                         );
1205                     }
1206                 }
1207                 Scope::ExternPrelude => {
1208                     suggestions.extend(this.extern_prelude.iter().filter_map(|(ident, _)| {
1209                         let res = Res::Def(DefKind::Mod, CRATE_DEF_ID.to_def_id());
1210                         filter_fn(res).then_some(TypoSuggestion::typo_from_res(ident.name, res))
1211                     }));
1212                 }
1213                 Scope::ToolPrelude => {
1214                     let res = Res::NonMacroAttr(NonMacroAttrKind::Tool);
1215                     suggestions.extend(
1216                         this.registered_tools
1217                             .iter()
1218                             .map(|ident| TypoSuggestion::typo_from_res(ident.name, res)),
1219                     );
1220                 }
1221                 Scope::StdLibPrelude => {
1222                     if let Some(prelude) = this.prelude {
1223                         let mut tmp_suggestions = Vec::new();
1224                         this.add_module_candidates(prelude, &mut tmp_suggestions, filter_fn);
1225                         suggestions.extend(
1226                             tmp_suggestions
1227                                 .into_iter()
1228                                 .filter(|s| use_prelude || this.is_builtin_macro(s.res)),
1229                         );
1230                     }
1231                 }
1232                 Scope::BuiltinTypes => {
1233                     suggestions.extend(PrimTy::ALL.iter().filter_map(|prim_ty| {
1234                         let res = Res::PrimTy(*prim_ty);
1235                         filter_fn(res).then_some(TypoSuggestion::typo_from_res(prim_ty.name(), res))
1236                     }))
1237                 }
1238             }
1239
1240             None::<()>
1241         });
1242
1243         // Make sure error reporting is deterministic.
1244         suggestions.sort_by(|a, b| a.candidate.as_str().partial_cmp(b.candidate.as_str()).unwrap());
1245
1246         match find_best_match_for_name(
1247             &suggestions.iter().map(|suggestion| suggestion.candidate).collect::<Vec<Symbol>>(),
1248             ident.name,
1249             None,
1250         ) {
1251             Some(found) if found != ident.name => {
1252                 suggestions.into_iter().find(|suggestion| suggestion.candidate == found)
1253             }
1254             _ => None,
1255         }
1256     }
1257
1258     fn lookup_import_candidates_from_module<FilterFn>(
1259         &mut self,
1260         lookup_ident: Ident,
1261         namespace: Namespace,
1262         parent_scope: &ParentScope<'a>,
1263         start_module: Module<'a>,
1264         crate_name: Ident,
1265         filter_fn: FilterFn,
1266     ) -> Vec<ImportSuggestion>
1267     where
1268         FilterFn: Fn(Res) -> bool,
1269     {
1270         let mut candidates = Vec::new();
1271         let mut seen_modules = FxHashSet::default();
1272         let mut worklist = vec![(start_module, Vec::<ast::PathSegment>::new(), true)];
1273         let mut worklist_via_import = vec![];
1274
1275         while let Some((in_module, path_segments, accessible)) = match worklist.pop() {
1276             None => worklist_via_import.pop(),
1277             Some(x) => Some(x),
1278         } {
1279             let in_module_is_extern = !in_module.def_id().is_local();
1280             // We have to visit module children in deterministic order to avoid
1281             // instabilities in reported imports (#43552).
1282             in_module.for_each_child(self, |this, ident, ns, name_binding| {
1283                 // avoid non-importable candidates
1284                 if !name_binding.is_importable() {
1285                     return;
1286                 }
1287
1288                 let child_accessible =
1289                     accessible && this.is_accessible_from(name_binding.vis, parent_scope.module);
1290
1291                 // do not venture inside inaccessible items of other crates
1292                 if in_module_is_extern && !child_accessible {
1293                     return;
1294                 }
1295
1296                 let via_import = name_binding.is_import() && !name_binding.is_extern_crate();
1297
1298                 // There is an assumption elsewhere that paths of variants are in the enum's
1299                 // declaration and not imported. With this assumption, the variant component is
1300                 // chopped and the rest of the path is assumed to be the enum's own path. For
1301                 // errors where a variant is used as the type instead of the enum, this causes
1302                 // funny looking invalid suggestions, i.e `foo` instead of `foo::MyEnum`.
1303                 if via_import && name_binding.is_possibly_imported_variant() {
1304                     return;
1305                 }
1306
1307                 // #90113: Do not count an inaccessible reexported item as a candidate.
1308                 if let NameBindingKind::Import { binding, .. } = name_binding.kind {
1309                     if this.is_accessible_from(binding.vis, parent_scope.module)
1310                         && !this.is_accessible_from(name_binding.vis, parent_scope.module)
1311                     {
1312                         return;
1313                     }
1314                 }
1315
1316                 // collect results based on the filter function
1317                 // avoid suggesting anything from the same module in which we are resolving
1318                 // avoid suggesting anything with a hygienic name
1319                 if ident.name == lookup_ident.name
1320                     && ns == namespace
1321                     && !ptr::eq(in_module, parent_scope.module)
1322                     && !ident.span.normalize_to_macros_2_0().from_expansion()
1323                 {
1324                     let res = name_binding.res();
1325                     if filter_fn(res) {
1326                         // create the path
1327                         let mut segms = path_segments.clone();
1328                         if lookup_ident.span.rust_2018() {
1329                             // crate-local absolute paths start with `crate::` in edition 2018
1330                             // FIXME: may also be stabilized for Rust 2015 (Issues #45477, #44660)
1331                             segms.insert(0, ast::PathSegment::from_ident(crate_name));
1332                         }
1333
1334                         segms.push(ast::PathSegment::from_ident(ident));
1335                         let path = Path { span: name_binding.span, segments: segms, tokens: None };
1336                         let did = match res {
1337                             Res::Def(DefKind::Ctor(..), did) => this.opt_parent(did),
1338                             _ => res.opt_def_id(),
1339                         };
1340
1341                         if child_accessible {
1342                             // Remove invisible match if exists
1343                             if let Some(idx) = candidates
1344                                 .iter()
1345                                 .position(|v: &ImportSuggestion| v.did == did && !v.accessible)
1346                             {
1347                                 candidates.remove(idx);
1348                             }
1349                         }
1350
1351                         if candidates.iter().all(|v: &ImportSuggestion| v.did != did) {
1352                             // See if we're recommending TryFrom, TryInto, or FromIterator and add
1353                             // a note about editions
1354                             let note = if let Some(did) = did {
1355                                 let requires_note = !did.is_local()
1356                                     && this.cstore().item_attrs_untracked(did, this.session).any(
1357                                         |attr| {
1358                                             if attr.has_name(sym::rustc_diagnostic_item) {
1359                                                 [sym::TryInto, sym::TryFrom, sym::FromIterator]
1360                                                     .map(|x| Some(x))
1361                                                     .contains(&attr.value_str())
1362                                             } else {
1363                                                 false
1364                                             }
1365                                         },
1366                                     );
1367
1368                                 requires_note.then(|| {
1369                                     format!(
1370                                         "'{}' is included in the prelude starting in Edition 2021",
1371                                         path_names_to_string(&path)
1372                                     )
1373                                 })
1374                             } else {
1375                                 None
1376                             };
1377
1378                             candidates.push(ImportSuggestion {
1379                                 did,
1380                                 descr: res.descr(),
1381                                 path,
1382                                 accessible: child_accessible,
1383                                 note,
1384                             });
1385                         }
1386                     }
1387                 }
1388
1389                 // collect submodules to explore
1390                 if let Some(module) = name_binding.module() {
1391                     // form the path
1392                     let mut path_segments = path_segments.clone();
1393                     path_segments.push(ast::PathSegment::from_ident(ident));
1394
1395                     let is_extern_crate_that_also_appears_in_prelude =
1396                         name_binding.is_extern_crate() && lookup_ident.span.rust_2018();
1397
1398                     if !is_extern_crate_that_also_appears_in_prelude {
1399                         // add the module to the lookup
1400                         if seen_modules.insert(module.def_id()) {
1401                             if via_import { &mut worklist_via_import } else { &mut worklist }
1402                                 .push((module, path_segments, child_accessible));
1403                         }
1404                     }
1405                 }
1406             })
1407         }
1408
1409         // If only some candidates are accessible, take just them
1410         if !candidates.iter().all(|v: &ImportSuggestion| !v.accessible) {
1411             candidates = candidates.into_iter().filter(|x| x.accessible).collect();
1412         }
1413
1414         candidates
1415     }
1416
1417     /// When name resolution fails, this method can be used to look up candidate
1418     /// entities with the expected name. It allows filtering them using the
1419     /// supplied predicate (which should be used to only accept the types of
1420     /// definitions expected, e.g., traits). The lookup spans across all crates.
1421     ///
1422     /// N.B., the method does not look into imports, but this is not a problem,
1423     /// since we report the definitions (thus, the de-aliased imports).
1424     pub(crate) fn lookup_import_candidates<FilterFn>(
1425         &mut self,
1426         lookup_ident: Ident,
1427         namespace: Namespace,
1428         parent_scope: &ParentScope<'a>,
1429         filter_fn: FilterFn,
1430     ) -> Vec<ImportSuggestion>
1431     where
1432         FilterFn: Fn(Res) -> bool,
1433     {
1434         let mut suggestions = self.lookup_import_candidates_from_module(
1435             lookup_ident,
1436             namespace,
1437             parent_scope,
1438             self.graph_root,
1439             Ident::with_dummy_span(kw::Crate),
1440             &filter_fn,
1441         );
1442
1443         if lookup_ident.span.rust_2018() {
1444             let extern_prelude_names = self.extern_prelude.clone();
1445             for (ident, _) in extern_prelude_names.into_iter() {
1446                 if ident.span.from_expansion() {
1447                     // Idents are adjusted to the root context before being
1448                     // resolved in the extern prelude, so reporting this to the
1449                     // user is no help. This skips the injected
1450                     // `extern crate std` in the 2018 edition, which would
1451                     // otherwise cause duplicate suggestions.
1452                     continue;
1453                 }
1454                 if let Some(crate_id) = self.crate_loader.maybe_process_path_extern(ident.name) {
1455                     let crate_root = self.expect_module(crate_id.as_def_id());
1456                     suggestions.extend(self.lookup_import_candidates_from_module(
1457                         lookup_ident,
1458                         namespace,
1459                         parent_scope,
1460                         crate_root,
1461                         ident,
1462                         &filter_fn,
1463                     ));
1464                 }
1465             }
1466         }
1467
1468         suggestions
1469     }
1470
1471     pub(crate) fn unresolved_macro_suggestions(
1472         &mut self,
1473         err: &mut Diagnostic,
1474         macro_kind: MacroKind,
1475         parent_scope: &ParentScope<'a>,
1476         ident: Ident,
1477     ) {
1478         let is_expected = &|res: Res| res.macro_kind() == Some(macro_kind);
1479         let suggestion = self.early_lookup_typo_candidate(
1480             ScopeSet::Macro(macro_kind),
1481             parent_scope,
1482             ident,
1483             is_expected,
1484         );
1485         self.add_typo_suggestion(err, suggestion, ident.span);
1486
1487         let import_suggestions =
1488             self.lookup_import_candidates(ident, Namespace::MacroNS, parent_scope, is_expected);
1489         show_candidates(
1490             &self.session,
1491             &self.source_span,
1492             err,
1493             None,
1494             &import_suggestions,
1495             Instead::No,
1496             FoundUse::Yes,
1497             IsPattern::No,
1498             vec![],
1499         );
1500
1501         if macro_kind == MacroKind::Derive && (ident.name == sym::Send || ident.name == sym::Sync) {
1502             let msg = format!("unsafe traits like `{}` should be implemented explicitly", ident);
1503             err.span_note(ident.span, &msg);
1504             return;
1505         }
1506         if self.macro_names.contains(&ident.normalize_to_macros_2_0()) {
1507             err.help("have you added the `#[macro_use]` on the module/import?");
1508             return;
1509         }
1510         if ident.name == kw::Default
1511             && let ModuleKind::Def(DefKind::Enum, def_id, _) = parent_scope.module.kind
1512             && let Some(span) = self.opt_span(def_id)
1513         {
1514             let source_map = self.session.source_map();
1515             let head_span = source_map.guess_head_span(span);
1516             if let Ok(head) = source_map.span_to_snippet(head_span) {
1517                 err.span_suggestion(head_span, "consider adding a derive", format!("#[derive(Default)]\n{head}"), Applicability::MaybeIncorrect);
1518             } else {
1519                 err.span_help(
1520                     head_span,
1521                     "consider adding `#[derive(Default)]` to this enum",
1522                 );
1523             }
1524         }
1525         for ns in [Namespace::MacroNS, Namespace::TypeNS, Namespace::ValueNS] {
1526             if let Ok(binding) = self.early_resolve_ident_in_lexical_scope(
1527                 ident,
1528                 ScopeSet::All(ns, false),
1529                 &parent_scope,
1530                 None,
1531                 false,
1532                 None,
1533             ) {
1534                 let desc = match binding.res() {
1535                     Res::Def(DefKind::Macro(MacroKind::Bang), _) => {
1536                         "a function-like macro".to_string()
1537                     }
1538                     Res::Def(DefKind::Macro(MacroKind::Attr), _) | Res::NonMacroAttr(..) => {
1539                         format!("an attribute: `#[{}]`", ident)
1540                     }
1541                     Res::Def(DefKind::Macro(MacroKind::Derive), _) => {
1542                         format!("a derive macro: `#[derive({})]`", ident)
1543                     }
1544                     Res::ToolMod => {
1545                         // Don't confuse the user with tool modules.
1546                         continue;
1547                     }
1548                     Res::Def(DefKind::Trait, _) if macro_kind == MacroKind::Derive => {
1549                         "only a trait, without a derive macro".to_string()
1550                     }
1551                     res => format!(
1552                         "{} {}, not {} {}",
1553                         res.article(),
1554                         res.descr(),
1555                         macro_kind.article(),
1556                         macro_kind.descr_expected(),
1557                     ),
1558                 };
1559                 if let crate::NameBindingKind::Import { import, .. } = binding.kind {
1560                     if !import.span.is_dummy() {
1561                         err.span_note(
1562                             import.span,
1563                             &format!("`{}` is imported here, but it is {}", ident, desc),
1564                         );
1565                         // Silence the 'unused import' warning we might get,
1566                         // since this diagnostic already covers that import.
1567                         self.record_use(ident, binding, false);
1568                         return;
1569                     }
1570                 }
1571                 err.note(&format!("`{}` is in scope, but it is {}", ident, desc));
1572                 return;
1573             }
1574         }
1575     }
1576
1577     pub(crate) fn add_typo_suggestion(
1578         &self,
1579         err: &mut Diagnostic,
1580         suggestion: Option<TypoSuggestion>,
1581         span: Span,
1582     ) -> bool {
1583         let suggestion = match suggestion {
1584             None => return false,
1585             // We shouldn't suggest underscore.
1586             Some(suggestion) if suggestion.candidate == kw::Underscore => return false,
1587             Some(suggestion) => suggestion,
1588         };
1589         let def_span = suggestion.res.opt_def_id().and_then(|def_id| match def_id.krate {
1590             LOCAL_CRATE => self.opt_span(def_id),
1591             _ => Some(
1592                 self.session
1593                     .source_map()
1594                     .guess_head_span(self.cstore().get_span_untracked(def_id, self.session)),
1595             ),
1596         });
1597         if let Some(def_span) = def_span {
1598             if span.overlaps(def_span) {
1599                 // Don't suggest typo suggestion for itself like in the following:
1600                 // error[E0423]: expected function, tuple struct or tuple variant, found struct `X`
1601                 //   --> $DIR/issue-64792-bad-unicode-ctor.rs:3:14
1602                 //    |
1603                 // LL | struct X {}
1604                 //    | ----------- `X` defined here
1605                 // LL |
1606                 // LL | const Y: X = X("ö");
1607                 //    | -------------^^^^^^- similarly named constant `Y` defined here
1608                 //    |
1609                 // help: use struct literal syntax instead
1610                 //    |
1611                 // LL | const Y: X = X {};
1612                 //    |              ^^^^
1613                 // help: a constant with a similar name exists
1614                 //    |
1615                 // LL | const Y: X = Y("ö");
1616                 //    |              ^
1617                 return false;
1618             }
1619             let prefix = match suggestion.target {
1620                 SuggestionTarget::SimilarlyNamed => "similarly named ",
1621                 SuggestionTarget::SingleItem => "",
1622             };
1623
1624             err.span_label(
1625                 self.session.source_map().guess_head_span(def_span),
1626                 &format!(
1627                     "{}{} `{}` defined here",
1628                     prefix,
1629                     suggestion.res.descr(),
1630                     suggestion.candidate,
1631                 ),
1632             );
1633         }
1634         let msg = match suggestion.target {
1635             SuggestionTarget::SimilarlyNamed => format!(
1636                 "{} {} with a similar name exists",
1637                 suggestion.res.article(),
1638                 suggestion.res.descr()
1639             ),
1640             SuggestionTarget::SingleItem => {
1641                 format!("maybe you meant this {}", suggestion.res.descr())
1642             }
1643         };
1644         err.span_suggestion(span, &msg, suggestion.candidate, Applicability::MaybeIncorrect);
1645         true
1646     }
1647
1648     fn binding_description(&self, b: &NameBinding<'_>, ident: Ident, from_prelude: bool) -> String {
1649         let res = b.res();
1650         if b.span.is_dummy() || !self.session.source_map().is_span_accessible(b.span) {
1651             // These already contain the "built-in" prefix or look bad with it.
1652             let add_built_in =
1653                 !matches!(b.res(), Res::NonMacroAttr(..) | Res::PrimTy(..) | Res::ToolMod);
1654             let (built_in, from) = if from_prelude {
1655                 ("", " from prelude")
1656             } else if b.is_extern_crate()
1657                 && !b.is_import()
1658                 && self.session.opts.externs.get(ident.as_str()).is_some()
1659             {
1660                 ("", " passed with `--extern`")
1661             } else if add_built_in {
1662                 (" built-in", "")
1663             } else {
1664                 ("", "")
1665             };
1666
1667             let a = if built_in.is_empty() { res.article() } else { "a" };
1668             format!("{a}{built_in} {thing}{from}", thing = res.descr())
1669         } else {
1670             let introduced = if b.is_import() { "imported" } else { "defined" };
1671             format!("the {thing} {introduced} here", thing = res.descr())
1672         }
1673     }
1674
1675     fn report_ambiguity_error(&self, ambiguity_error: &AmbiguityError<'_>) {
1676         let AmbiguityError { kind, ident, b1, b2, misc1, misc2 } = *ambiguity_error;
1677         let (b1, b2, misc1, misc2, swapped) = if b2.span.is_dummy() && !b1.span.is_dummy() {
1678             // We have to print the span-less alternative first, otherwise formatting looks bad.
1679             (b2, b1, misc2, misc1, true)
1680         } else {
1681             (b1, b2, misc1, misc2, false)
1682         };
1683
1684         let mut err = struct_span_err!(self.session, ident.span, E0659, "`{ident}` is ambiguous");
1685         err.span_label(ident.span, "ambiguous name");
1686         err.note(&format!("ambiguous because of {}", kind.descr()));
1687
1688         let mut could_refer_to = |b: &NameBinding<'_>, misc: AmbiguityErrorMisc, also: &str| {
1689             let what = self.binding_description(b, ident, misc == AmbiguityErrorMisc::FromPrelude);
1690             let note_msg = format!("`{ident}` could{also} refer to {what}");
1691
1692             let thing = b.res().descr();
1693             let mut help_msgs = Vec::new();
1694             if b.is_glob_import()
1695                 && (kind == AmbiguityKind::GlobVsGlob
1696                     || kind == AmbiguityKind::GlobVsExpanded
1697                     || kind == AmbiguityKind::GlobVsOuter && swapped != also.is_empty())
1698             {
1699                 help_msgs.push(format!(
1700                     "consider adding an explicit import of `{ident}` to disambiguate"
1701                 ))
1702             }
1703             if b.is_extern_crate() && ident.span.rust_2018() {
1704                 help_msgs.push(format!("use `::{ident}` to refer to this {thing} unambiguously"))
1705             }
1706             if misc == AmbiguityErrorMisc::SuggestCrate {
1707                 help_msgs
1708                     .push(format!("use `crate::{ident}` to refer to this {thing} unambiguously"))
1709             } else if misc == AmbiguityErrorMisc::SuggestSelf {
1710                 help_msgs
1711                     .push(format!("use `self::{ident}` to refer to this {thing} unambiguously"))
1712             }
1713
1714             err.span_note(b.span, &note_msg);
1715             for (i, help_msg) in help_msgs.iter().enumerate() {
1716                 let or = if i == 0 { "" } else { "or " };
1717                 err.help(&format!("{}{}", or, help_msg));
1718             }
1719         };
1720
1721         could_refer_to(b1, misc1, "");
1722         could_refer_to(b2, misc2, " also");
1723         err.emit();
1724     }
1725
1726     /// If the binding refers to a tuple struct constructor with fields,
1727     /// returns the span of its fields.
1728     fn ctor_fields_span(&self, binding: &NameBinding<'_>) -> Option<Span> {
1729         if let NameBindingKind::Res(
1730             Res::Def(DefKind::Ctor(CtorOf::Struct, CtorKind::Fn), ctor_def_id),
1731             _,
1732         ) = binding.kind
1733         {
1734             let def_id = self.parent(ctor_def_id);
1735             let fields = self.field_names.get(&def_id)?;
1736             return fields.iter().map(|name| name.span).reduce(Span::to); // None for `struct Foo()`
1737         }
1738         None
1739     }
1740
1741     fn report_privacy_error(&self, privacy_error: &PrivacyError<'_>) {
1742         let PrivacyError { ident, binding, .. } = *privacy_error;
1743
1744         let res = binding.res();
1745         let ctor_fields_span = self.ctor_fields_span(binding);
1746         let plain_descr = res.descr().to_string();
1747         let nonimport_descr =
1748             if ctor_fields_span.is_some() { plain_descr + " constructor" } else { plain_descr };
1749         let import_descr = nonimport_descr.clone() + " import";
1750         let get_descr =
1751             |b: &NameBinding<'_>| if b.is_import() { &import_descr } else { &nonimport_descr };
1752
1753         // Print the primary message.
1754         let descr = get_descr(binding);
1755         let mut err =
1756             struct_span_err!(self.session, ident.span, E0603, "{} `{}` is private", descr, ident);
1757         err.span_label(ident.span, &format!("private {}", descr));
1758         if let Some(span) = ctor_fields_span {
1759             err.span_label(span, "a constructor is private if any of the fields is private");
1760         }
1761
1762         // Print the whole import chain to make it easier to see what happens.
1763         let first_binding = binding;
1764         let mut next_binding = Some(binding);
1765         let mut next_ident = ident;
1766         while let Some(binding) = next_binding {
1767             let name = next_ident;
1768             next_binding = match binding.kind {
1769                 _ if res == Res::Err => None,
1770                 NameBindingKind::Import { binding, import, .. } => match import.kind {
1771                     _ if binding.span.is_dummy() => None,
1772                     ImportKind::Single { source, .. } => {
1773                         next_ident = source;
1774                         Some(binding)
1775                     }
1776                     ImportKind::Glob { .. } | ImportKind::MacroUse => Some(binding),
1777                     ImportKind::ExternCrate { .. } => None,
1778                 },
1779                 _ => None,
1780             };
1781
1782             let first = ptr::eq(binding, first_binding);
1783             let msg = format!(
1784                 "{and_refers_to}the {item} `{name}`{which} is defined here{dots}",
1785                 and_refers_to = if first { "" } else { "...and refers to " },
1786                 item = get_descr(binding),
1787                 which = if first { "" } else { " which" },
1788                 dots = if next_binding.is_some() { "..." } else { "" },
1789             );
1790             let def_span = self.session.source_map().guess_head_span(binding.span);
1791             let mut note_span = MultiSpan::from_span(def_span);
1792             if !first && binding.vis.is_public() {
1793                 note_span.push_span_label(def_span, "consider importing it directly");
1794             }
1795             err.span_note(note_span, &msg);
1796         }
1797
1798         err.emit();
1799     }
1800
1801     pub(crate) fn find_similarly_named_module_or_crate(
1802         &mut self,
1803         ident: Symbol,
1804         current_module: &Module<'a>,
1805     ) -> Option<Symbol> {
1806         let mut candidates = self
1807             .extern_prelude
1808             .iter()
1809             .map(|(ident, _)| ident.name)
1810             .chain(
1811                 self.module_map
1812                     .iter()
1813                     .filter(|(_, module)| {
1814                         current_module.is_ancestor_of(module) && !ptr::eq(current_module, *module)
1815                     })
1816                     .flat_map(|(_, module)| module.kind.name()),
1817             )
1818             .filter(|c| !c.to_string().is_empty())
1819             .collect::<Vec<_>>();
1820         candidates.sort();
1821         candidates.dedup();
1822         match find_best_match_for_name(&candidates, ident, None) {
1823             Some(sugg) if sugg == ident => None,
1824             sugg => sugg,
1825         }
1826     }
1827
1828     pub(crate) fn report_path_resolution_error(
1829         &mut self,
1830         path: &[Segment],
1831         opt_ns: Option<Namespace>, // `None` indicates a module path in import
1832         parent_scope: &ParentScope<'a>,
1833         ribs: Option<&PerNS<Vec<Rib<'a>>>>,
1834         ignore_binding: Option<&'a NameBinding<'a>>,
1835         module: Option<ModuleOrUniformRoot<'a>>,
1836         i: usize,
1837         ident: Ident,
1838     ) -> (String, Option<Suggestion>) {
1839         let is_last = i == path.len() - 1;
1840         let ns = if is_last { opt_ns.unwrap_or(TypeNS) } else { TypeNS };
1841         let module_res = match module {
1842             Some(ModuleOrUniformRoot::Module(module)) => module.res(),
1843             _ => None,
1844         };
1845         if module_res == self.graph_root.res() {
1846             let is_mod = |res| matches!(res, Res::Def(DefKind::Mod, _));
1847             let mut candidates = self.lookup_import_candidates(ident, TypeNS, parent_scope, is_mod);
1848             candidates
1849                 .sort_by_cached_key(|c| (c.path.segments.len(), pprust::path_to_string(&c.path)));
1850             if let Some(candidate) = candidates.get(0) {
1851                 (
1852                     String::from("unresolved import"),
1853                     Some((
1854                         vec![(ident.span, pprust::path_to_string(&candidate.path))],
1855                         String::from("a similar path exists"),
1856                         Applicability::MaybeIncorrect,
1857                     )),
1858                 )
1859             } else if self.session.edition() == Edition::Edition2015 {
1860                 (
1861                     format!("maybe a missing crate `{ident}`?"),
1862                     Some((
1863                         vec![],
1864                         format!(
1865                             "consider adding `extern crate {ident}` to use the `{ident}` crate"
1866                         ),
1867                         Applicability::MaybeIncorrect,
1868                     )),
1869                 )
1870             } else {
1871                 (format!("could not find `{ident}` in the crate root"), None)
1872             }
1873         } else if i > 0 {
1874             let parent = path[i - 1].ident.name;
1875             let parent = match parent {
1876                 // ::foo is mounted at the crate root for 2015, and is the extern
1877                 // prelude for 2018+
1878                 kw::PathRoot if self.session.edition() > Edition::Edition2015 => {
1879                     "the list of imported crates".to_owned()
1880                 }
1881                 kw::PathRoot | kw::Crate => "the crate root".to_owned(),
1882                 _ => format!("`{parent}`"),
1883             };
1884
1885             let mut msg = format!("could not find `{}` in {}", ident, parent);
1886             if ns == TypeNS || ns == ValueNS {
1887                 let ns_to_try = if ns == TypeNS { ValueNS } else { TypeNS };
1888                 let binding = if let Some(module) = module {
1889                     self.resolve_ident_in_module(
1890                         module,
1891                         ident,
1892                         ns_to_try,
1893                         parent_scope,
1894                         None,
1895                         ignore_binding,
1896                     ).ok()
1897                 } else if let Some(ribs) = ribs
1898                     && let Some(TypeNS | ValueNS) = opt_ns
1899                 {
1900                     match self.resolve_ident_in_lexical_scope(
1901                         ident,
1902                         ns_to_try,
1903                         parent_scope,
1904                         None,
1905                         &ribs[ns_to_try],
1906                         ignore_binding,
1907                     ) {
1908                         // we found a locally-imported or available item/module
1909                         Some(LexicalScopeBinding::Item(binding)) => Some(binding),
1910                         _ => None,
1911                     }
1912                 } else {
1913                     let scopes = ScopeSet::All(ns_to_try, opt_ns.is_none());
1914                     self.early_resolve_ident_in_lexical_scope(
1915                         ident,
1916                         scopes,
1917                         parent_scope,
1918                         None,
1919                         false,
1920                         ignore_binding,
1921                     ).ok()
1922                 };
1923                 if let Some(binding) = binding {
1924                     let mut found = |what| {
1925                         msg = format!(
1926                             "expected {}, found {} `{}` in {}",
1927                             ns.descr(),
1928                             what,
1929                             ident,
1930                             parent
1931                         )
1932                     };
1933                     if binding.module().is_some() {
1934                         found("module")
1935                     } else {
1936                         match binding.res() {
1937                             Res::Def(kind, id) => found(kind.descr(id)),
1938                             _ => found(ns_to_try.descr()),
1939                         }
1940                     }
1941                 };
1942             }
1943             (msg, None)
1944         } else if ident.name == kw::SelfUpper {
1945             ("`Self` is only available in impls, traits, and type definitions".to_string(), None)
1946         } else if ident.name.as_str().chars().next().map_or(false, |c| c.is_ascii_uppercase()) {
1947             // Check whether the name refers to an item in the value namespace.
1948             let binding = if let Some(ribs) = ribs {
1949                 self.resolve_ident_in_lexical_scope(
1950                     ident,
1951                     ValueNS,
1952                     parent_scope,
1953                     None,
1954                     &ribs[ValueNS],
1955                     ignore_binding,
1956                 )
1957             } else {
1958                 None
1959             };
1960             let match_span = match binding {
1961                 // Name matches a local variable. For example:
1962                 // ```
1963                 // fn f() {
1964                 //     let Foo: &str = "";
1965                 //     println!("{}", Foo::Bar); // Name refers to local
1966                 //                               // variable `Foo`.
1967                 // }
1968                 // ```
1969                 Some(LexicalScopeBinding::Res(Res::Local(id))) => {
1970                     Some(*self.pat_span_map.get(&id).unwrap())
1971                 }
1972                 // Name matches item from a local name binding
1973                 // created by `use` declaration. For example:
1974                 // ```
1975                 // pub Foo: &str = "";
1976                 //
1977                 // mod submod {
1978                 //     use super::Foo;
1979                 //     println!("{}", Foo::Bar); // Name refers to local
1980                 //                               // binding `Foo`.
1981                 // }
1982                 // ```
1983                 Some(LexicalScopeBinding::Item(name_binding)) => Some(name_binding.span),
1984                 _ => None,
1985             };
1986             let suggestion = if let Some(span) = match_span {
1987                 Some((
1988                     vec![(span, String::from(""))],
1989                     format!("`{}` is defined here, but is not a type", ident),
1990                     Applicability::MaybeIncorrect,
1991                 ))
1992             } else {
1993                 None
1994             };
1995
1996             (format!("use of undeclared type `{}`", ident), suggestion)
1997         } else {
1998             let suggestion = if ident.name == sym::alloc {
1999                 Some((
2000                     vec![],
2001                     String::from("add `extern crate alloc` to use the `alloc` crate"),
2002                     Applicability::MaybeIncorrect,
2003                 ))
2004             } else {
2005                 self.find_similarly_named_module_or_crate(ident.name, &parent_scope.module).map(
2006                     |sugg| {
2007                         (
2008                             vec![(ident.span, sugg.to_string())],
2009                             String::from("there is a crate or module with a similar name"),
2010                             Applicability::MaybeIncorrect,
2011                         )
2012                     },
2013                 )
2014             };
2015             (format!("use of undeclared crate or module `{}`", ident), suggestion)
2016         }
2017     }
2018 }
2019
2020 impl<'a, 'b> ImportResolver<'a, 'b> {
2021     /// Adds suggestions for a path that cannot be resolved.
2022     pub(crate) fn make_path_suggestion(
2023         &mut self,
2024         span: Span,
2025         mut path: Vec<Segment>,
2026         parent_scope: &ParentScope<'b>,
2027     ) -> Option<(Vec<Segment>, Vec<String>)> {
2028         debug!("make_path_suggestion: span={:?} path={:?}", span, path);
2029
2030         match (path.get(0), path.get(1)) {
2031             // `{{root}}::ident::...` on both editions.
2032             // On 2015 `{{root}}` is usually added implicitly.
2033             (Some(fst), Some(snd))
2034                 if fst.ident.name == kw::PathRoot && !snd.ident.is_path_segment_keyword() => {}
2035             // `ident::...` on 2018.
2036             (Some(fst), _)
2037                 if fst.ident.span.rust_2018() && !fst.ident.is_path_segment_keyword() =>
2038             {
2039                 // Insert a placeholder that's later replaced by `self`/`super`/etc.
2040                 path.insert(0, Segment::from_ident(Ident::empty()));
2041             }
2042             _ => return None,
2043         }
2044
2045         self.make_missing_self_suggestion(path.clone(), parent_scope)
2046             .or_else(|| self.make_missing_crate_suggestion(path.clone(), parent_scope))
2047             .or_else(|| self.make_missing_super_suggestion(path.clone(), parent_scope))
2048             .or_else(|| self.make_external_crate_suggestion(path, parent_scope))
2049     }
2050
2051     /// Suggest a missing `self::` if that resolves to an correct module.
2052     ///
2053     /// ```text
2054     ///    |
2055     /// LL | use foo::Bar;
2056     ///    |     ^^^ did you mean `self::foo`?
2057     /// ```
2058     fn make_missing_self_suggestion(
2059         &mut self,
2060         mut path: Vec<Segment>,
2061         parent_scope: &ParentScope<'b>,
2062     ) -> Option<(Vec<Segment>, Vec<String>)> {
2063         // Replace first ident with `self` and check if that is valid.
2064         path[0].ident.name = kw::SelfLower;
2065         let result = self.r.maybe_resolve_path(&path, None, parent_scope);
2066         debug!("make_missing_self_suggestion: path={:?} result={:?}", path, result);
2067         if let PathResult::Module(..) = result { Some((path, Vec::new())) } else { None }
2068     }
2069
2070     /// Suggests a missing `crate::` if that resolves to an correct module.
2071     ///
2072     /// ```text
2073     ///    |
2074     /// LL | use foo::Bar;
2075     ///    |     ^^^ did you mean `crate::foo`?
2076     /// ```
2077     fn make_missing_crate_suggestion(
2078         &mut self,
2079         mut path: Vec<Segment>,
2080         parent_scope: &ParentScope<'b>,
2081     ) -> Option<(Vec<Segment>, Vec<String>)> {
2082         // Replace first ident with `crate` and check if that is valid.
2083         path[0].ident.name = kw::Crate;
2084         let result = self.r.maybe_resolve_path(&path, None, parent_scope);
2085         debug!("make_missing_crate_suggestion:  path={:?} result={:?}", path, result);
2086         if let PathResult::Module(..) = result {
2087             Some((
2088                 path,
2089                 vec![
2090                     "`use` statements changed in Rust 2018; read more at \
2091                      <https://doc.rust-lang.org/edition-guide/rust-2018/module-system/path-\
2092                      clarity.html>"
2093                         .to_string(),
2094                 ],
2095             ))
2096         } else {
2097             None
2098         }
2099     }
2100
2101     /// Suggests a missing `super::` if that resolves to an correct module.
2102     ///
2103     /// ```text
2104     ///    |
2105     /// LL | use foo::Bar;
2106     ///    |     ^^^ did you mean `super::foo`?
2107     /// ```
2108     fn make_missing_super_suggestion(
2109         &mut self,
2110         mut path: Vec<Segment>,
2111         parent_scope: &ParentScope<'b>,
2112     ) -> Option<(Vec<Segment>, Vec<String>)> {
2113         // Replace first ident with `crate` and check if that is valid.
2114         path[0].ident.name = kw::Super;
2115         let result = self.r.maybe_resolve_path(&path, None, parent_scope);
2116         debug!("make_missing_super_suggestion:  path={:?} result={:?}", path, result);
2117         if let PathResult::Module(..) = result { Some((path, Vec::new())) } else { None }
2118     }
2119
2120     /// Suggests a missing external crate name if that resolves to an correct module.
2121     ///
2122     /// ```text
2123     ///    |
2124     /// LL | use foobar::Baz;
2125     ///    |     ^^^^^^ did you mean `baz::foobar`?
2126     /// ```
2127     ///
2128     /// Used when importing a submodule of an external crate but missing that crate's
2129     /// name as the first part of path.
2130     fn make_external_crate_suggestion(
2131         &mut self,
2132         mut path: Vec<Segment>,
2133         parent_scope: &ParentScope<'b>,
2134     ) -> Option<(Vec<Segment>, Vec<String>)> {
2135         if path[1].ident.span.rust_2015() {
2136             return None;
2137         }
2138
2139         // Sort extern crate names in *reverse* order to get
2140         // 1) some consistent ordering for emitted diagnostics, and
2141         // 2) `std` suggestions before `core` suggestions.
2142         let mut extern_crate_names =
2143             self.r.extern_prelude.iter().map(|(ident, _)| ident.name).collect::<Vec<_>>();
2144         extern_crate_names.sort_by(|a, b| b.as_str().partial_cmp(a.as_str()).unwrap());
2145
2146         for name in extern_crate_names.into_iter() {
2147             // Replace first ident with a crate name and check if that is valid.
2148             path[0].ident.name = name;
2149             let result = self.r.maybe_resolve_path(&path, None, parent_scope);
2150             debug!(
2151                 "make_external_crate_suggestion: name={:?} path={:?} result={:?}",
2152                 name, path, result
2153             );
2154             if let PathResult::Module(..) = result {
2155                 return Some((path, Vec::new()));
2156             }
2157         }
2158
2159         None
2160     }
2161
2162     /// Suggests importing a macro from the root of the crate rather than a module within
2163     /// the crate.
2164     ///
2165     /// ```text
2166     /// help: a macro with this name exists at the root of the crate
2167     ///    |
2168     /// LL | use issue_59764::makro;
2169     ///    |     ^^^^^^^^^^^^^^^^^^
2170     ///    |
2171     ///    = note: this could be because a macro annotated with `#[macro_export]` will be exported
2172     ///            at the root of the crate instead of the module where it is defined
2173     /// ```
2174     pub(crate) fn check_for_module_export_macro(
2175         &mut self,
2176         import: &'b Import<'b>,
2177         module: ModuleOrUniformRoot<'b>,
2178         ident: Ident,
2179     ) -> Option<(Option<Suggestion>, Vec<String>)> {
2180         let ModuleOrUniformRoot::Module(mut crate_module) = module else {
2181             return None;
2182         };
2183
2184         while let Some(parent) = crate_module.parent {
2185             crate_module = parent;
2186         }
2187
2188         if ModuleOrUniformRoot::same_def(ModuleOrUniformRoot::Module(crate_module), module) {
2189             // Don't make a suggestion if the import was already from the root of the
2190             // crate.
2191             return None;
2192         }
2193
2194         let resolutions = self.r.resolutions(crate_module).borrow();
2195         let resolution = resolutions.get(&self.r.new_key(ident, MacroNS))?;
2196         let binding = resolution.borrow().binding()?;
2197         if let Res::Def(DefKind::Macro(MacroKind::Bang), _) = binding.res() {
2198             let module_name = crate_module.kind.name().unwrap();
2199             let import_snippet = match import.kind {
2200                 ImportKind::Single { source, target, .. } if source != target => {
2201                     format!("{} as {}", source, target)
2202                 }
2203                 _ => format!("{}", ident),
2204             };
2205
2206             let mut corrections: Vec<(Span, String)> = Vec::new();
2207             if !import.is_nested() {
2208                 // Assume this is the easy case of `use issue_59764::foo::makro;` and just remove
2209                 // intermediate segments.
2210                 corrections.push((import.span, format!("{}::{}", module_name, import_snippet)));
2211             } else {
2212                 // Find the binding span (and any trailing commas and spaces).
2213                 //   ie. `use a::b::{c, d, e};`
2214                 //                      ^^^
2215                 let (found_closing_brace, binding_span) = find_span_of_binding_until_next_binding(
2216                     self.r.session,
2217                     import.span,
2218                     import.use_span,
2219                 );
2220                 debug!(
2221                     "check_for_module_export_macro: found_closing_brace={:?} binding_span={:?}",
2222                     found_closing_brace, binding_span
2223                 );
2224
2225                 let mut removal_span = binding_span;
2226                 if found_closing_brace {
2227                     // If the binding span ended with a closing brace, as in the below example:
2228                     //   ie. `use a::b::{c, d};`
2229                     //                      ^
2230                     // Then expand the span of characters to remove to include the previous
2231                     // binding's trailing comma.
2232                     //   ie. `use a::b::{c, d};`
2233                     //                    ^^^
2234                     if let Some(previous_span) =
2235                         extend_span_to_previous_binding(self.r.session, binding_span)
2236                     {
2237                         debug!("check_for_module_export_macro: previous_span={:?}", previous_span);
2238                         removal_span = removal_span.with_lo(previous_span.lo());
2239                     }
2240                 }
2241                 debug!("check_for_module_export_macro: removal_span={:?}", removal_span);
2242
2243                 // Remove the `removal_span`.
2244                 corrections.push((removal_span, "".to_string()));
2245
2246                 // Find the span after the crate name and if it has nested imports immediately
2247                 // after the crate name already.
2248                 //   ie. `use a::b::{c, d};`
2249                 //               ^^^^^^^^^
2250                 //   or  `use a::{b, c, d}};`
2251                 //               ^^^^^^^^^^^
2252                 let (has_nested, after_crate_name) = find_span_immediately_after_crate_name(
2253                     self.r.session,
2254                     module_name,
2255                     import.use_span,
2256                 );
2257                 debug!(
2258                     "check_for_module_export_macro: has_nested={:?} after_crate_name={:?}",
2259                     has_nested, after_crate_name
2260                 );
2261
2262                 let source_map = self.r.session.source_map();
2263
2264                 // Add the import to the start, with a `{` if required.
2265                 let start_point = source_map.start_point(after_crate_name);
2266                 if let Ok(start_snippet) = source_map.span_to_snippet(start_point) {
2267                     corrections.push((
2268                         start_point,
2269                         if has_nested {
2270                             // In this case, `start_snippet` must equal '{'.
2271                             format!("{}{}, ", start_snippet, import_snippet)
2272                         } else {
2273                             // In this case, add a `{`, then the moved import, then whatever
2274                             // was there before.
2275                             format!("{{{}, {}", import_snippet, start_snippet)
2276                         },
2277                     ));
2278                 }
2279
2280                 // Add a `};` to the end if nested, matching the `{` added at the start.
2281                 if !has_nested {
2282                     corrections.push((source_map.end_point(after_crate_name), "};".to_string()));
2283                 }
2284             }
2285
2286             let suggestion = Some((
2287                 corrections,
2288                 String::from("a macro with this name exists at the root of the crate"),
2289                 Applicability::MaybeIncorrect,
2290             ));
2291             let note = vec![
2292                 "this could be because a macro annotated with `#[macro_export]` will be exported \
2293                  at the root of the crate instead of the module where it is defined"
2294                     .to_string(),
2295             ];
2296             Some((suggestion, note))
2297         } else {
2298             None
2299         }
2300     }
2301 }
2302
2303 /// Given a `binding_span` of a binding within a use statement:
2304 ///
2305 /// ```ignore (illustrative)
2306 /// use foo::{a, b, c};
2307 /// //           ^
2308 /// ```
2309 ///
2310 /// then return the span until the next binding or the end of the statement:
2311 ///
2312 /// ```ignore (illustrative)
2313 /// use foo::{a, b, c};
2314 /// //           ^^^
2315 /// ```
2316 fn find_span_of_binding_until_next_binding(
2317     sess: &Session,
2318     binding_span: Span,
2319     use_span: Span,
2320 ) -> (bool, Span) {
2321     let source_map = sess.source_map();
2322
2323     // Find the span of everything after the binding.
2324     //   ie. `a, e};` or `a};`
2325     let binding_until_end = binding_span.with_hi(use_span.hi());
2326
2327     // Find everything after the binding but not including the binding.
2328     //   ie. `, e};` or `};`
2329     let after_binding_until_end = binding_until_end.with_lo(binding_span.hi());
2330
2331     // Keep characters in the span until we encounter something that isn't a comma or
2332     // whitespace.
2333     //   ie. `, ` or ``.
2334     //
2335     // Also note whether a closing brace character was encountered. If there
2336     // was, then later go backwards to remove any trailing commas that are left.
2337     let mut found_closing_brace = false;
2338     let after_binding_until_next_binding =
2339         source_map.span_take_while(after_binding_until_end, |&ch| {
2340             if ch == '}' {
2341                 found_closing_brace = true;
2342             }
2343             ch == ' ' || ch == ','
2344         });
2345
2346     // Combine the two spans.
2347     //   ie. `a, ` or `a`.
2348     //
2349     // Removing these would leave `issue_52891::{d, e};` or `issue_52891::{d, e, };`
2350     let span = binding_span.with_hi(after_binding_until_next_binding.hi());
2351
2352     (found_closing_brace, span)
2353 }
2354
2355 /// Given a `binding_span`, return the span through to the comma or opening brace of the previous
2356 /// binding.
2357 ///
2358 /// ```ignore (illustrative)
2359 /// use foo::a::{a, b, c};
2360 /// //            ^^--- binding span
2361 /// //            |
2362 /// //            returned span
2363 ///
2364 /// use foo::{a, b, c};
2365 /// //        --- binding span
2366 /// ```
2367 fn extend_span_to_previous_binding(sess: &Session, binding_span: Span) -> Option<Span> {
2368     let source_map = sess.source_map();
2369
2370     // `prev_source` will contain all of the source that came before the span.
2371     // Then split based on a command and take the first (ie. closest to our span)
2372     // snippet. In the example, this is a space.
2373     let prev_source = source_map.span_to_prev_source(binding_span).ok()?;
2374
2375     let prev_comma = prev_source.rsplit(',').collect::<Vec<_>>();
2376     let prev_starting_brace = prev_source.rsplit('{').collect::<Vec<_>>();
2377     if prev_comma.len() <= 1 || prev_starting_brace.len() <= 1 {
2378         return None;
2379     }
2380
2381     let prev_comma = prev_comma.first().unwrap();
2382     let prev_starting_brace = prev_starting_brace.first().unwrap();
2383
2384     // If the amount of source code before the comma is greater than
2385     // the amount of source code before the starting brace then we've only
2386     // got one item in the nested item (eg. `issue_52891::{self}`).
2387     if prev_comma.len() > prev_starting_brace.len() {
2388         return None;
2389     }
2390
2391     Some(binding_span.with_lo(BytePos(
2392         // Take away the number of bytes for the characters we've found and an
2393         // extra for the comma.
2394         binding_span.lo().0 - (prev_comma.as_bytes().len() as u32) - 1,
2395     )))
2396 }
2397
2398 /// Given a `use_span` of a binding within a use statement, returns the highlighted span and if
2399 /// it is a nested use tree.
2400 ///
2401 /// ```ignore (illustrative)
2402 /// use foo::a::{b, c};
2403 /// //       ^^^^^^^^^^ -- false
2404 ///
2405 /// use foo::{a, b, c};
2406 /// //       ^^^^^^^^^^ -- true
2407 ///
2408 /// use foo::{a, b::{c, d}};
2409 /// //       ^^^^^^^^^^^^^^^ -- true
2410 /// ```
2411 fn find_span_immediately_after_crate_name(
2412     sess: &Session,
2413     module_name: Symbol,
2414     use_span: Span,
2415 ) -> (bool, Span) {
2416     debug!(
2417         "find_span_immediately_after_crate_name: module_name={:?} use_span={:?}",
2418         module_name, use_span
2419     );
2420     let source_map = sess.source_map();
2421
2422     // Using `use issue_59764::foo::{baz, makro};` as an example throughout..
2423     let mut num_colons = 0;
2424     // Find second colon.. `use issue_59764:`
2425     let until_second_colon = source_map.span_take_while(use_span, |c| {
2426         if *c == ':' {
2427             num_colons += 1;
2428         }
2429         !matches!(c, ':' if num_colons == 2)
2430     });
2431     // Find everything after the second colon.. `foo::{baz, makro};`
2432     let from_second_colon = use_span.with_lo(until_second_colon.hi() + BytePos(1));
2433
2434     let mut found_a_non_whitespace_character = false;
2435     // Find the first non-whitespace character in `from_second_colon`.. `f`
2436     let after_second_colon = source_map.span_take_while(from_second_colon, |c| {
2437         if found_a_non_whitespace_character {
2438             return false;
2439         }
2440         if !c.is_whitespace() {
2441             found_a_non_whitespace_character = true;
2442         }
2443         true
2444     });
2445
2446     // Find the first `{` in from_second_colon.. `foo::{`
2447     let next_left_bracket = source_map.span_through_char(from_second_colon, '{');
2448
2449     (next_left_bracket == after_second_colon, from_second_colon)
2450 }
2451
2452 /// A suggestion has already been emitted, change the wording slightly to clarify that both are
2453 /// independent options.
2454 enum Instead {
2455     Yes,
2456     No,
2457 }
2458
2459 /// Whether an existing place with an `use` item was found.
2460 enum FoundUse {
2461     Yes,
2462     No,
2463 }
2464
2465 /// Whether a binding is part of a pattern or an expression. Used for diagnostics.
2466 enum IsPattern {
2467     /// The binding is part of a pattern
2468     Yes,
2469     /// The binding is part of an expression
2470     No,
2471 }
2472
2473 /// When an entity with a given name is not available in scope, we search for
2474 /// entities with that name in all crates. This method allows outputting the
2475 /// results of this search in a programmer-friendly way
2476 fn show_candidates(
2477     session: &Session,
2478     source_span: &IndexVec<LocalDefId, Span>,
2479     err: &mut Diagnostic,
2480     // This is `None` if all placement locations are inside expansions
2481     use_placement_span: Option<Span>,
2482     candidates: &[ImportSuggestion],
2483     instead: Instead,
2484     found_use: FoundUse,
2485     is_pattern: IsPattern,
2486     path: Vec<Segment>,
2487 ) {
2488     if candidates.is_empty() {
2489         return;
2490     }
2491
2492     let mut accessible_path_strings: Vec<(String, &str, Option<DefId>, &Option<String>)> =
2493         Vec::new();
2494     let mut inaccessible_path_strings: Vec<(String, &str, Option<DefId>, &Option<String>)> =
2495         Vec::new();
2496
2497     candidates.iter().for_each(|c| {
2498         (if c.accessible { &mut accessible_path_strings } else { &mut inaccessible_path_strings })
2499             .push((path_names_to_string(&c.path), c.descr, c.did, &c.note))
2500     });
2501
2502     // we want consistent results across executions, but candidates are produced
2503     // by iterating through a hash map, so make sure they are ordered:
2504     for path_strings in [&mut accessible_path_strings, &mut inaccessible_path_strings] {
2505         path_strings.sort_by(|a, b| a.0.cmp(&b.0));
2506         let core_path_strings =
2507             path_strings.drain_filter(|p| p.0.starts_with("core::")).collect::<Vec<_>>();
2508         path_strings.extend(core_path_strings);
2509         path_strings.dedup_by(|a, b| a.0 == b.0);
2510     }
2511
2512     if !accessible_path_strings.is_empty() {
2513         let (determiner, kind, name) = if accessible_path_strings.len() == 1 {
2514             ("this", accessible_path_strings[0].1, format!(" `{}`", accessible_path_strings[0].0))
2515         } else {
2516             ("one of these", "items", String::new())
2517         };
2518
2519         let instead = if let Instead::Yes = instead { " instead" } else { "" };
2520         let mut msg = if let IsPattern::Yes = is_pattern {
2521             format!(
2522                 "if you meant to match on {}{}{}, use the full path in the pattern",
2523                 kind, instead, name
2524             )
2525         } else {
2526             format!("consider importing {} {}{}", determiner, kind, instead)
2527         };
2528
2529         for note in accessible_path_strings.iter().flat_map(|cand| cand.3.as_ref()) {
2530             err.note(note);
2531         }
2532
2533         if let (IsPattern::Yes, Some(span)) = (is_pattern, use_placement_span) {
2534             err.span_suggestions(
2535                 span,
2536                 &msg,
2537                 accessible_path_strings.into_iter().map(|a| a.0),
2538                 Applicability::MaybeIncorrect,
2539             );
2540         } else if let Some(span) = use_placement_span {
2541             for candidate in &mut accessible_path_strings {
2542                 // produce an additional newline to separate the new use statement
2543                 // from the directly following item.
2544                 let additional_newline = if let FoundUse::Yes = found_use { "" } else { "\n" };
2545                 candidate.0 = format!("use {};\n{}", &candidate.0, additional_newline);
2546             }
2547
2548             err.span_suggestions(
2549                 span,
2550                 &msg,
2551                 accessible_path_strings.into_iter().map(|a| a.0),
2552                 Applicability::MaybeIncorrect,
2553             );
2554             if let [first, .., last] = &path[..] {
2555                 err.span_suggestion_verbose(
2556                     first.ident.span.until(last.ident.span),
2557                     &format!("if you import `{}`, refer to it directly", last.ident),
2558                     "",
2559                     Applicability::Unspecified,
2560                 );
2561             }
2562         } else {
2563             msg.push(':');
2564
2565             for candidate in accessible_path_strings {
2566                 msg.push('\n');
2567                 msg.push_str(&candidate.0);
2568             }
2569
2570             err.note(&msg);
2571         }
2572     } else {
2573         assert!(!inaccessible_path_strings.is_empty());
2574
2575         let prefix =
2576             if let IsPattern::Yes = is_pattern { "you might have meant to match on " } else { "" };
2577         if inaccessible_path_strings.len() == 1 {
2578             let (name, descr, def_id, note) = &inaccessible_path_strings[0];
2579             let msg = format!(
2580                 "{}{} `{}`{} exists but is inaccessible",
2581                 prefix,
2582                 descr,
2583                 name,
2584                 if let IsPattern::Yes = is_pattern { ", which" } else { "" }
2585             );
2586
2587             if let Some(local_def_id) = def_id.and_then(|did| did.as_local()) {
2588                 let span = source_span[local_def_id];
2589                 let span = session.source_map().guess_head_span(span);
2590                 let mut multi_span = MultiSpan::from_span(span);
2591                 multi_span.push_span_label(span, "not accessible");
2592                 err.span_note(multi_span, &msg);
2593             } else {
2594                 err.note(&msg);
2595             }
2596             if let Some(note) = (*note).as_deref() {
2597                 err.note(note);
2598             }
2599         } else {
2600             let (_, descr_first, _, _) = &inaccessible_path_strings[0];
2601             let descr = if inaccessible_path_strings
2602                 .iter()
2603                 .skip(1)
2604                 .all(|(_, descr, _, _)| descr == descr_first)
2605             {
2606                 descr_first
2607             } else {
2608                 "item"
2609             };
2610             let plural_descr =
2611                 if descr.ends_with('s') { format!("{}es", descr) } else { format!("{}s", descr) };
2612
2613             let mut msg = format!("{}these {} exist but are inaccessible", prefix, plural_descr);
2614             let mut has_colon = false;
2615
2616             let mut spans = Vec::new();
2617             for (name, _, def_id, _) in &inaccessible_path_strings {
2618                 if let Some(local_def_id) = def_id.and_then(|did| did.as_local()) {
2619                     let span = source_span[local_def_id];
2620                     let span = session.source_map().guess_head_span(span);
2621                     spans.push((name, span));
2622                 } else {
2623                     if !has_colon {
2624                         msg.push(':');
2625                         has_colon = true;
2626                     }
2627                     msg.push('\n');
2628                     msg.push_str(name);
2629                 }
2630             }
2631
2632             let mut multi_span = MultiSpan::from_spans(spans.iter().map(|(_, sp)| *sp).collect());
2633             for (name, span) in spans {
2634                 multi_span.push_span_label(span, format!("`{}`: not accessible", name));
2635             }
2636
2637             for note in inaccessible_path_strings.iter().flat_map(|cand| cand.3.as_ref()) {
2638                 err.note(note);
2639             }
2640
2641             err.span_note(multi_span, &msg);
2642         }
2643     }
2644 }
2645
2646 #[derive(Debug)]
2647 struct UsePlacementFinder {
2648     target_module: NodeId,
2649     first_legal_span: Option<Span>,
2650     first_use_span: Option<Span>,
2651 }
2652
2653 impl UsePlacementFinder {
2654     fn check(krate: &Crate, target_module: NodeId) -> (Option<Span>, FoundUse) {
2655         let mut finder =
2656             UsePlacementFinder { target_module, first_legal_span: None, first_use_span: None };
2657         finder.visit_crate(krate);
2658         if let Some(use_span) = finder.first_use_span {
2659             (Some(use_span), FoundUse::Yes)
2660         } else {
2661             (finder.first_legal_span, FoundUse::No)
2662         }
2663     }
2664 }
2665
2666 impl<'tcx> visit::Visitor<'tcx> for UsePlacementFinder {
2667     fn visit_crate(&mut self, c: &Crate) {
2668         if self.target_module == CRATE_NODE_ID {
2669             let inject = c.spans.inject_use_span;
2670             if is_span_suitable_for_use_injection(inject) {
2671                 self.first_legal_span = Some(inject);
2672             }
2673             self.first_use_span = search_for_any_use_in_items(&c.items);
2674             return;
2675         } else {
2676             visit::walk_crate(self, c);
2677         }
2678     }
2679
2680     fn visit_item(&mut self, item: &'tcx ast::Item) {
2681         if self.target_module == item.id {
2682             if let ItemKind::Mod(_, ModKind::Loaded(items, _inline, mod_spans)) = &item.kind {
2683                 let inject = mod_spans.inject_use_span;
2684                 if is_span_suitable_for_use_injection(inject) {
2685                     self.first_legal_span = Some(inject);
2686                 }
2687                 self.first_use_span = search_for_any_use_in_items(items);
2688                 return;
2689             }
2690         } else {
2691             visit::walk_item(self, item);
2692         }
2693     }
2694 }
2695
2696 fn search_for_any_use_in_items(items: &[P<ast::Item>]) -> Option<Span> {
2697     for item in items {
2698         if let ItemKind::Use(..) = item.kind {
2699             if is_span_suitable_for_use_injection(item.span) {
2700                 return Some(item.span.shrink_to_lo());
2701             }
2702         }
2703     }
2704     return None;
2705 }
2706
2707 fn is_span_suitable_for_use_injection(s: Span) -> bool {
2708     // don't suggest placing a use before the prelude
2709     // import or other generated ones
2710     !s.from_expansion()
2711 }
2712
2713 /// Convert the given number into the corresponding ordinal
2714 pub(crate) fn ordinalize(v: usize) -> String {
2715     let suffix = match ((11..=13).contains(&(v % 100)), v % 10) {
2716         (false, 1) => "st",
2717         (false, 2) => "nd",
2718         (false, 3) => "rd",
2719         _ => "th",
2720     };
2721     format!("{v}{suffix}")
2722 }