3 use errors::{Applicability, DiagnosticBuilder, DiagnosticId};
6 use rustc::hir::def::{self, DefKind, NonMacroAttrKind};
7 use rustc::hir::def::Namespace::{self, *};
8 use rustc::hir::def_id::{CRATE_DEF_INDEX, DefId};
9 use rustc::session::Session;
10 use rustc::ty::{self, DefIdTree};
11 use rustc::util::nodemap::FxHashSet;
12 use syntax::ast::{self, Ident, Path};
13 use syntax::feature_gate::BUILTIN_ATTRIBUTES;
14 use syntax::source_map::SourceMap;
15 use syntax::struct_span_err;
16 use syntax::symbol::{Symbol, kw};
17 use syntax::util::lev_distance::find_best_match_for_name;
18 use syntax_pos::hygiene::MacroKind;
19 use syntax_pos::{BytePos, Span, MultiSpan};
21 use crate::resolve_imports::{ImportDirective, ImportDirectiveSubclass, ImportResolver};
22 use crate::{path_names_to_string, KNOWN_TOOLS};
23 use crate::{BindingError, CrateLint, HasGenericParams, LegacyScope, Module, ModuleOrUniformRoot};
24 use crate::{PathResult, ParentScope, ResolutionError, Resolver, Scope, ScopeSet, Segment};
26 type Res = def::Res<ast::NodeId>;
28 /// A vector of spans and replacements, a message and applicability.
29 crate type Suggestion = (Vec<(Span, String)>, String, Applicability);
31 crate struct TypoSuggestion {
32 pub candidate: Symbol,
37 crate fn from_res(candidate: Symbol, res: Res) -> TypoSuggestion {
38 TypoSuggestion { candidate, res }
42 /// A free importable items suggested in case of resolution failure.
43 crate struct ImportSuggestion {
44 pub did: Option<DefId>,
48 /// Adjust the impl span so that just the `impl` keyword is taken by removing
49 /// everything after `<` (`"impl<T> Iterator for A<T> {}" -> "impl"`) and
50 /// everything after the first whitespace (`"impl Iterator for A" -> "impl"`).
52 /// *Attention*: the method used is very fragile since it essentially duplicates the work of the
53 /// parser. If you need to use this function or something similar, please consider updating the
54 /// `source_map` functions and this function to something more robust.
55 fn reduce_impl_span_to_impl_keyword(cm: &SourceMap, impl_span: Span) -> Span {
56 let impl_span = cm.span_until_char(impl_span, '<');
57 let impl_span = cm.span_until_whitespace(impl_span);
61 impl<'a> Resolver<'a> {
62 crate fn add_module_candidates(
65 names: &mut Vec<TypoSuggestion>,
66 filter_fn: &impl Fn(Res) -> bool,
68 for (key, resolution) in self.resolutions(module).borrow().iter() {
69 if let Some(binding) = resolution.borrow().binding {
70 let res = binding.res();
72 names.push(TypoSuggestion::from_res(key.ident.name, res));
78 /// Combines an error with provided span and emits it.
80 /// This takes the error provided, combines it with the span and any additional spans inside the
81 /// error and emits it.
82 crate fn report_error(&self, span: Span, resolution_error: ResolutionError<'_>) {
83 self.into_struct_error(span, resolution_error).emit();
86 crate fn into_struct_error(
87 &self, span: Span, resolution_error: ResolutionError<'_>
88 ) -> DiagnosticBuilder<'_> {
89 match resolution_error {
90 ResolutionError::GenericParamsFromOuterFunction(outer_res, has_generic_params) => {
91 let mut err = struct_span_err!(self.session,
94 "can't use generic parameters from outer function",
96 err.span_label(span, format!("use of generic parameter from outer function"));
98 let cm = self.session.source_map();
100 Res::SelfTy(maybe_trait_defid, maybe_impl_defid) => {
101 if let Some(impl_span) = maybe_impl_defid.and_then(|def_id| {
102 self.definitions.opt_span(def_id)
105 reduce_impl_span_to_impl_keyword(cm, impl_span),
106 "`Self` type implicitly declared here, by this `impl`",
109 match (maybe_trait_defid, maybe_impl_defid) {
111 err.span_label(span, "can't use `Self` here");
114 err.span_label(span, "use a type here instead");
116 (None, None) => bug!("`impl` without trait nor type?"),
120 Res::Def(DefKind::TyParam, def_id) => {
121 if let Some(span) = self.definitions.opt_span(def_id) {
122 err.span_label(span, "type parameter from outer function");
125 Res::Def(DefKind::ConstParam, def_id) => {
126 if let Some(span) = self.definitions.opt_span(def_id) {
127 err.span_label(span, "const parameter from outer function");
131 bug!("GenericParamsFromOuterFunction should only be used with Res::SelfTy, \
136 if has_generic_params == HasGenericParams::Yes {
137 // Try to retrieve the span of the function signature and generate a new
138 // message with a local type or const parameter.
139 let sugg_msg = &format!("try using a local generic parameter instead");
140 if let Some((sugg_span, snippet)) = cm.generate_local_type_param_snippet(span) {
141 // Suggest the modification to the user
146 Applicability::MachineApplicable,
148 } else if let Some(sp) = cm.generate_fn_name_span(span) {
150 format!("try adding a local generic parameter in this method instead"));
152 err.help(&format!("try using a local generic parameter instead"));
158 ResolutionError::NameAlreadyUsedInParameterList(name, first_use_span) => {
159 let mut err = struct_span_err!(
163 "the name `{}` is already used for a generic \
164 parameter in this item's generic parameters",
167 err.span_label(span, "already used");
168 err.span_label(first_use_span, format!("first use of `{}`", name));
171 ResolutionError::MethodNotMemberOfTrait(method, trait_) => {
172 let mut err = struct_span_err!(self.session,
175 "method `{}` is not a member of trait `{}`",
178 err.span_label(span, format!("not a member of trait `{}`", trait_));
181 ResolutionError::TypeNotMemberOfTrait(type_, trait_) => {
182 let mut err = struct_span_err!(self.session,
185 "type `{}` is not a member of trait `{}`",
188 err.span_label(span, format!("not a member of trait `{}`", trait_));
191 ResolutionError::ConstNotMemberOfTrait(const_, trait_) => {
192 let mut err = struct_span_err!(self.session,
195 "const `{}` is not a member of trait `{}`",
198 err.span_label(span, format!("not a member of trait `{}`", trait_));
201 ResolutionError::VariableNotBoundInPattern(binding_error) => {
202 let BindingError { name, target, origin, could_be_path } = binding_error;
204 let target_sp = target.iter().copied().collect::<Vec<_>>();
205 let origin_sp = origin.iter().copied().collect::<Vec<_>>();
207 let msp = MultiSpan::from_spans(target_sp.clone());
208 let msg = format!("variable `{}` is not bound in all patterns", name);
209 let mut err = self.session.struct_span_err_with_code(
212 DiagnosticId::Error("E0408".into()),
214 for sp in target_sp {
215 err.span_label(sp, format!("pattern doesn't bind `{}`", name));
217 for sp in origin_sp {
218 err.span_label(sp, "variable not in all patterns");
221 let help_msg = format!(
222 "if you meant to match on a variant or a `const` item, consider \
223 making the path in the pattern qualified: `?::{}`",
226 err.span_help(span, &help_msg);
230 ResolutionError::VariableBoundWithDifferentMode(variable_name,
231 first_binding_span) => {
232 let mut err = struct_span_err!(self.session,
235 "variable `{}` is bound in inconsistent \
236 ways within the same match arm",
238 err.span_label(span, "bound in different ways");
239 err.span_label(first_binding_span, "first binding");
242 ResolutionError::IdentifierBoundMoreThanOnceInParameterList(identifier) => {
243 let mut err = struct_span_err!(self.session,
246 "identifier `{}` is bound more than once in this parameter list",
248 err.span_label(span, "used as parameter more than once");
251 ResolutionError::IdentifierBoundMoreThanOnceInSamePattern(identifier) => {
252 let mut err = struct_span_err!(self.session,
255 "identifier `{}` is bound more than once in the same pattern",
257 err.span_label(span, "used in a pattern more than once");
260 ResolutionError::UndeclaredLabel(name, lev_candidate) => {
261 let mut err = struct_span_err!(self.session,
264 "use of undeclared label `{}`",
266 if let Some(lev_candidate) = lev_candidate {
269 "a label with a similar name exists in this scope",
270 lev_candidate.to_string(),
271 Applicability::MaybeIncorrect,
274 err.span_label(span, format!("undeclared label `{}`", name));
278 ResolutionError::SelfImportsOnlyAllowedWithin => {
279 struct_span_err!(self.session,
283 "`self` imports are only allowed within a { } list")
285 ResolutionError::SelfImportCanOnlyAppearOnceInTheList => {
286 let mut err = struct_span_err!(self.session, span, E0430,
287 "`self` import can only appear once in an import list");
288 err.span_label(span, "can only appear once in an import list");
291 ResolutionError::SelfImportOnlyInImportListWithNonEmptyPrefix => {
292 let mut err = struct_span_err!(self.session, span, E0431,
293 "`self` import can only appear in an import list with \
294 a non-empty prefix");
295 err.span_label(span, "can only appear in an import list with a non-empty prefix");
298 ResolutionError::FailedToResolve { label, suggestion } => {
299 let mut err = struct_span_err!(self.session, span, E0433,
300 "failed to resolve: {}", &label);
301 err.span_label(span, label);
303 if let Some((suggestions, msg, applicability)) = suggestion {
304 err.multipart_suggestion(&msg, suggestions, applicability);
309 ResolutionError::CannotCaptureDynamicEnvironmentInFnItem => {
310 let mut err = struct_span_err!(self.session,
314 "can't capture dynamic environment in a fn item");
315 err.help("use the `|| { ... }` closure form instead");
318 ResolutionError::AttemptToUseNonConstantValueInConstant => {
319 let mut err = struct_span_err!(self.session, span, E0435,
320 "attempt to use a non-constant value in a constant");
321 err.span_label(span, "non-constant value");
324 ResolutionError::BindingShadowsSomethingUnacceptable(what_binding, name, binding) => {
325 let res = binding.res();
326 let shadows_what = res.descr();
327 let mut err = struct_span_err!(self.session, span, E0530, "{}s cannot shadow {}s",
328 what_binding, shadows_what);
329 err.span_label(span, format!("cannot be named the same as {} {}",
330 res.article(), shadows_what));
331 let participle = if binding.is_import() { "imported" } else { "defined" };
332 let msg = format!("the {} `{}` is {} here", shadows_what, name, participle);
333 err.span_label(binding.span, msg);
336 ResolutionError::ForwardDeclaredTyParam => {
337 let mut err = struct_span_err!(self.session, span, E0128,
338 "type parameters with a default cannot use \
339 forward declared identifiers");
341 span, "defaulted type parameters cannot be forward declared".to_string());
344 ResolutionError::SelfInTyParamDefault => {
345 let mut err = struct_span_err!(
349 "type parameters cannot use `Self` in their defaults"
352 span, "`Self` in type parameter default".to_string());
358 /// Lookup typo candidate in scope for a macro or import.
359 fn early_lookup_typo_candidate(
362 parent_scope: &ParentScope<'a>,
364 filter_fn: &impl Fn(Res) -> bool,
365 ) -> Option<TypoSuggestion> {
366 let mut suggestions = Vec::new();
367 self.visit_scopes(scope_set, parent_scope, ident, |this, scope, use_prelude, _| {
369 Scope::DeriveHelpers => {
370 let res = Res::NonMacroAttr(NonMacroAttrKind::DeriveHelper);
372 for derive in parent_scope.derives {
374 &ParentScope { derives: &[], ..*parent_scope };
375 if let Ok((Some(ext), _)) = this.resolve_macro_path(
376 derive, Some(MacroKind::Derive), parent_scope, false, false
378 suggestions.extend(ext.helper_attrs.iter().map(|name| {
379 TypoSuggestion::from_res(*name, res)
385 Scope::MacroRules(legacy_scope) => {
386 if let LegacyScope::Binding(legacy_binding) = legacy_scope {
387 let res = legacy_binding.binding.res();
390 TypoSuggestion::from_res(legacy_binding.ident.name, res)
395 Scope::CrateRoot => {
396 let root_ident = Ident::new(kw::PathRoot, ident.span);
397 let root_module = this.resolve_crate_root(root_ident);
398 this.add_module_candidates(root_module, &mut suggestions, filter_fn);
400 Scope::Module(module) => {
401 this.add_module_candidates(module, &mut suggestions, filter_fn);
403 Scope::MacroUsePrelude => {
404 suggestions.extend(this.macro_use_prelude.iter().filter_map(|(name, binding)| {
405 let res = binding.res();
407 Some(TypoSuggestion::from_res(*name, res))
413 Scope::BuiltinAttrs => {
414 let res = Res::NonMacroAttr(NonMacroAttrKind::Builtin);
416 suggestions.extend(BUILTIN_ATTRIBUTES.iter().map(|(name, ..)| {
417 TypoSuggestion::from_res(*name, res)
421 Scope::LegacyPluginHelpers => {
422 let res = Res::NonMacroAttr(NonMacroAttrKind::LegacyPluginHelper);
424 let plugin_attributes = this.session.plugin_attributes.borrow();
425 suggestions.extend(plugin_attributes.iter().map(|(name, _)| {
426 TypoSuggestion::from_res(*name, res)
430 Scope::ExternPrelude => {
431 suggestions.extend(this.extern_prelude.iter().filter_map(|(ident, _)| {
432 let res = Res::Def(DefKind::Mod, DefId::local(CRATE_DEF_INDEX));
434 Some(TypoSuggestion::from_res(ident.name, res))
440 Scope::ToolPrelude => {
441 let res = Res::NonMacroAttr(NonMacroAttrKind::Tool);
442 suggestions.extend(KNOWN_TOOLS.iter().map(|name| {
443 TypoSuggestion::from_res(*name, res)
446 Scope::StdLibPrelude => {
447 if let Some(prelude) = this.prelude {
448 let mut tmp_suggestions = Vec::new();
449 this.add_module_candidates(prelude, &mut tmp_suggestions, filter_fn);
450 suggestions.extend(tmp_suggestions.into_iter().filter(|s| {
451 use_prelude || this.is_builtin_macro(s.res)
455 Scope::BuiltinTypes => {
456 let primitive_types = &this.primitive_type_table.primitive_types;
458 primitive_types.iter().flat_map(|(name, prim_ty)| {
459 let res = Res::PrimTy(*prim_ty);
461 Some(TypoSuggestion::from_res(*name, res))
473 // Make sure error reporting is deterministic.
474 suggestions.sort_by_cached_key(|suggestion| suggestion.candidate.as_str());
476 match find_best_match_for_name(
477 suggestions.iter().map(|suggestion| &suggestion.candidate),
481 Some(found) if found != ident.name => suggestions
483 .find(|suggestion| suggestion.candidate == found),
488 fn lookup_import_candidates_from_module<FilterFn>(&mut self,
490 namespace: Namespace,
491 start_module: Module<'a>,
494 -> Vec<ImportSuggestion>
495 where FilterFn: Fn(Res) -> bool
497 let mut candidates = Vec::new();
498 let mut seen_modules = FxHashSet::default();
499 let not_local_module = crate_name.name != kw::Crate;
500 let mut worklist = vec![(start_module, Vec::<ast::PathSegment>::new(), not_local_module)];
502 while let Some((in_module,
504 in_module_is_extern)) = worklist.pop() {
505 // We have to visit module children in deterministic order to avoid
506 // instabilities in reported imports (#43552).
507 in_module.for_each_child(self, |this, ident, ns, name_binding| {
508 // avoid imports entirely
509 if name_binding.is_import() && !name_binding.is_extern_crate() { return; }
510 // avoid non-importable candidates as well
511 if !name_binding.is_importable() { return; }
513 // collect results based on the filter function
514 if ident.name == lookup_ident.name && ns == namespace {
515 let res = name_binding.res();
518 let mut segms = path_segments.clone();
519 if lookup_ident.span.rust_2018() {
520 // crate-local absolute paths start with `crate::` in edition 2018
521 // FIXME: may also be stabilized for Rust 2015 (Issues #45477, #44660)
523 0, ast::PathSegment::from_ident(crate_name)
527 segms.push(ast::PathSegment::from_ident(ident));
529 span: name_binding.span,
532 // the entity is accessible in the following cases:
533 // 1. if it's defined in the same crate, it's always
534 // accessible (since private entities can be made public)
535 // 2. if it's defined in another crate, it's accessible
536 // only if both the module is public and the entity is
537 // declared as public (due to pruning, we don't explore
538 // outside crate private modules => no need to check this)
539 if !in_module_is_extern || name_binding.vis == ty::Visibility::Public {
540 let did = match res {
541 Res::Def(DefKind::Ctor(..), did) => this.parent(did),
542 _ => res.opt_def_id(),
544 candidates.push(ImportSuggestion { did, path });
549 // collect submodules to explore
550 if let Some(module) = name_binding.module() {
552 let mut path_segments = path_segments.clone();
553 path_segments.push(ast::PathSegment::from_ident(ident));
555 let is_extern_crate_that_also_appears_in_prelude =
556 name_binding.is_extern_crate() &&
557 lookup_ident.span.rust_2018();
559 let is_visible_to_user =
560 !in_module_is_extern || name_binding.vis == ty::Visibility::Public;
562 if !is_extern_crate_that_also_appears_in_prelude && is_visible_to_user {
563 // add the module to the lookup
564 let is_extern = in_module_is_extern || name_binding.is_extern_crate();
565 if seen_modules.insert(module.def_id().unwrap()) {
566 worklist.push((module, path_segments, is_extern));
576 /// When name resolution fails, this method can be used to look up candidate
577 /// entities with the expected name. It allows filtering them using the
578 /// supplied predicate (which should be used to only accept the types of
579 /// definitions expected, e.g., traits). The lookup spans across all crates.
581 /// N.B., the method does not look into imports, but this is not a problem,
582 /// since we report the definitions (thus, the de-aliased imports).
583 crate fn lookup_import_candidates<FilterFn>(
584 &mut self, lookup_ident: Ident, namespace: Namespace, filter_fn: FilterFn
585 ) -> Vec<ImportSuggestion>
586 where FilterFn: Fn(Res) -> bool
588 let mut suggestions = self.lookup_import_candidates_from_module(
589 lookup_ident, namespace, self.graph_root, Ident::with_dummy_span(kw::Crate), &filter_fn
592 if lookup_ident.span.rust_2018() {
593 let extern_prelude_names = self.extern_prelude.clone();
594 for (ident, _) in extern_prelude_names.into_iter() {
595 if ident.span.from_expansion() {
596 // Idents are adjusted to the root context before being
597 // resolved in the extern prelude, so reporting this to the
598 // user is no help. This skips the injected
599 // `extern crate std` in the 2018 edition, which would
600 // otherwise cause duplicate suggestions.
603 if let Some(crate_id) = self.crate_loader.maybe_process_path_extern(ident.name,
605 let crate_root = self.get_module(DefId {
607 index: CRATE_DEF_INDEX,
609 suggestions.extend(self.lookup_import_candidates_from_module(
610 lookup_ident, namespace, crate_root, ident, &filter_fn));
618 crate fn unresolved_macro_suggestions(
620 err: &mut DiagnosticBuilder<'a>,
621 macro_kind: MacroKind,
622 parent_scope: &ParentScope<'a>,
625 let is_expected = &|res: Res| res.macro_kind() == Some(macro_kind);
626 let suggestion = self.early_lookup_typo_candidate(
627 ScopeSet::Macro(macro_kind), parent_scope, ident, is_expected
629 self.add_typo_suggestion(err, suggestion, ident.span);
631 if macro_kind == MacroKind::Derive &&
632 (ident.as_str() == "Send" || ident.as_str() == "Sync") {
633 let msg = format!("unsafe traits like `{}` should be implemented explicitly", ident);
634 err.span_note(ident.span, &msg);
636 if self.macro_names.contains(&ident.modern()) {
637 err.help("have you added the `#[macro_use]` on the module/import?");
641 crate fn add_typo_suggestion(
643 err: &mut DiagnosticBuilder<'_>,
644 suggestion: Option<TypoSuggestion>,
647 if let Some(suggestion) = suggestion {
649 "{} {} with a similar name exists", suggestion.res.article(), suggestion.res.descr()
652 span, &msg, suggestion.candidate.to_string(), Applicability::MaybeIncorrect
654 let def_span = suggestion.res.opt_def_id()
655 .and_then(|def_id| self.definitions.opt_span(def_id));
656 if let Some(span) = def_span {
657 err.span_label(span, &format!(
658 "similarly named {} `{}` defined here",
659 suggestion.res.descr(),
660 suggestion.candidate.as_str(),
669 impl<'a, 'b> ImportResolver<'a, 'b> {
670 /// Adds suggestions for a path that cannot be resolved.
671 pub(crate) fn make_path_suggestion(
674 mut path: Vec<Segment>,
675 parent_scope: &ParentScope<'b>,
676 ) -> Option<(Vec<Segment>, Vec<String>)> {
677 debug!("make_path_suggestion: span={:?} path={:?}", span, path);
679 match (path.get(0), path.get(1)) {
680 // `{{root}}::ident::...` on both editions.
681 // On 2015 `{{root}}` is usually added implicitly.
682 (Some(fst), Some(snd)) if fst.ident.name == kw::PathRoot &&
683 !snd.ident.is_path_segment_keyword() => {}
684 // `ident::...` on 2018.
685 (Some(fst), _) if fst.ident.span.rust_2018() &&
686 !fst.ident.is_path_segment_keyword() => {
687 // Insert a placeholder that's later replaced by `self`/`super`/etc.
688 path.insert(0, Segment::from_ident(Ident::invalid()));
693 self.make_missing_self_suggestion(span, path.clone(), parent_scope)
694 .or_else(|| self.make_missing_crate_suggestion(span, path.clone(), parent_scope))
695 .or_else(|| self.make_missing_super_suggestion(span, path.clone(), parent_scope))
696 .or_else(|| self.make_external_crate_suggestion(span, path, parent_scope))
699 /// Suggest a missing `self::` if that resolves to an correct module.
703 /// LL | use foo::Bar;
704 /// | ^^^ did you mean `self::foo`?
706 fn make_missing_self_suggestion(
709 mut path: Vec<Segment>,
710 parent_scope: &ParentScope<'b>,
711 ) -> Option<(Vec<Segment>, Vec<String>)> {
712 // Replace first ident with `self` and check if that is valid.
713 path[0].ident.name = kw::SelfLower;
714 let result = self.r.resolve_path(&path, None, parent_scope, false, span, CrateLint::No);
715 debug!("make_missing_self_suggestion: path={:?} result={:?}", path, result);
716 if let PathResult::Module(..) = result {
717 Some((path, Vec::new()))
723 /// Suggests a missing `crate::` if that resolves to an correct module.
727 /// LL | use foo::Bar;
728 /// | ^^^ did you mean `crate::foo`?
730 fn make_missing_crate_suggestion(
733 mut path: Vec<Segment>,
734 parent_scope: &ParentScope<'b>,
735 ) -> Option<(Vec<Segment>, Vec<String>)> {
736 // Replace first ident with `crate` and check if that is valid.
737 path[0].ident.name = kw::Crate;
738 let result = self.r.resolve_path(&path, None, parent_scope, false, span, CrateLint::No);
739 debug!("make_missing_crate_suggestion: path={:?} result={:?}", path, result);
740 if let PathResult::Module(..) = result {
744 "`use` statements changed in Rust 2018; read more at \
745 <https://doc.rust-lang.org/edition-guide/rust-2018/module-system/path-\
746 clarity.html>".to_string()
754 /// Suggests a missing `super::` if that resolves to an correct module.
758 /// LL | use foo::Bar;
759 /// | ^^^ did you mean `super::foo`?
761 fn make_missing_super_suggestion(
764 mut path: Vec<Segment>,
765 parent_scope: &ParentScope<'b>,
766 ) -> Option<(Vec<Segment>, Vec<String>)> {
767 // Replace first ident with `crate` and check if that is valid.
768 path[0].ident.name = kw::Super;
769 let result = self.r.resolve_path(&path, None, parent_scope, false, span, CrateLint::No);
770 debug!("make_missing_super_suggestion: path={:?} result={:?}", path, result);
771 if let PathResult::Module(..) = result {
772 Some((path, Vec::new()))
778 /// Suggests a missing external crate name if that resolves to an correct module.
782 /// LL | use foobar::Baz;
783 /// | ^^^^^^ did you mean `baz::foobar`?
786 /// Used when importing a submodule of an external crate but missing that crate's
787 /// name as the first part of path.
788 fn make_external_crate_suggestion(
791 mut path: Vec<Segment>,
792 parent_scope: &ParentScope<'b>,
793 ) -> Option<(Vec<Segment>, Vec<String>)> {
794 if path[1].ident.span.rust_2015() {
798 // Sort extern crate names in reverse order to get
799 // 1) some consistent ordering for emitted dignostics, and
800 // 2) `std` suggestions before `core` suggestions.
801 let mut extern_crate_names =
802 self.r.extern_prelude.iter().map(|(ident, _)| ident.name).collect::<Vec<_>>();
803 extern_crate_names.sort_by_key(|name| Reverse(name.as_str()));
805 for name in extern_crate_names.into_iter() {
806 // Replace first ident with a crate name and check if that is valid.
807 path[0].ident.name = name;
808 let result = self.r.resolve_path(&path, None, parent_scope, false, span, CrateLint::No);
809 debug!("make_external_crate_suggestion: name={:?} path={:?} result={:?}",
811 if let PathResult::Module(..) = result {
812 return Some((path, Vec::new()));
819 /// Suggests importing a macro from the root of the crate rather than a module within
823 /// help: a macro with this name exists at the root of the crate
825 /// LL | use issue_59764::makro;
826 /// | ^^^^^^^^^^^^^^^^^^
828 /// = note: this could be because a macro annotated with `#[macro_export]` will be exported
829 /// at the root of the crate instead of the module where it is defined
831 pub(crate) fn check_for_module_export_macro(
833 directive: &'b ImportDirective<'b>,
834 module: ModuleOrUniformRoot<'b>,
836 ) -> Option<(Option<Suggestion>, Vec<String>)> {
837 let mut crate_module = if let ModuleOrUniformRoot::Module(module) = module {
843 while let Some(parent) = crate_module.parent {
844 crate_module = parent;
847 if ModuleOrUniformRoot::same_def(ModuleOrUniformRoot::Module(crate_module), module) {
848 // Don't make a suggestion if the import was already from the root of the
853 let resolutions = self.r.resolutions(crate_module).borrow();
854 let resolution = resolutions.get(&self.r.new_key(ident, MacroNS))?;
855 let binding = resolution.borrow().binding()?;
856 if let Res::Def(DefKind::Macro(MacroKind::Bang), _) = binding.res() {
857 let module_name = crate_module.kind.name().unwrap();
858 let import = match directive.subclass {
859 ImportDirectiveSubclass::SingleImport { source, target, .. } if source != target =>
860 format!("{} as {}", source, target),
861 _ => format!("{}", ident),
864 let mut corrections: Vec<(Span, String)> = Vec::new();
865 if !directive.is_nested() {
866 // Assume this is the easy case of `use issue_59764::foo::makro;` and just remove
867 // intermediate segments.
868 corrections.push((directive.span, format!("{}::{}", module_name, import)));
870 // Find the binding span (and any trailing commas and spaces).
871 // ie. `use a::b::{c, d, e};`
873 let (found_closing_brace, binding_span) = find_span_of_binding_until_next_binding(
874 self.r.session, directive.span, directive.use_span,
876 debug!("check_for_module_export_macro: found_closing_brace={:?} binding_span={:?}",
877 found_closing_brace, binding_span);
879 let mut removal_span = binding_span;
880 if found_closing_brace {
881 // If the binding span ended with a closing brace, as in the below example:
882 // ie. `use a::b::{c, d};`
884 // Then expand the span of characters to remove to include the previous
885 // binding's trailing comma.
886 // ie. `use a::b::{c, d};`
888 if let Some(previous_span) = extend_span_to_previous_binding(
889 self.r.session, binding_span,
891 debug!("check_for_module_export_macro: previous_span={:?}", previous_span);
892 removal_span = removal_span.with_lo(previous_span.lo());
895 debug!("check_for_module_export_macro: removal_span={:?}", removal_span);
897 // Remove the `removal_span`.
898 corrections.push((removal_span, "".to_string()));
900 // Find the span after the crate name and if it has nested imports immediatately
901 // after the crate name already.
902 // ie. `use a::b::{c, d};`
904 // or `use a::{b, c, d}};`
906 let (has_nested, after_crate_name) = find_span_immediately_after_crate_name(
907 self.r.session, module_name, directive.use_span,
909 debug!("check_for_module_export_macro: has_nested={:?} after_crate_name={:?}",
910 has_nested, after_crate_name);
912 let source_map = self.r.session.source_map();
914 // Add the import to the start, with a `{` if required.
915 let start_point = source_map.start_point(after_crate_name);
916 if let Ok(start_snippet) = source_map.span_to_snippet(start_point) {
920 // In this case, `start_snippet` must equal '{'.
921 format!("{}{}, ", start_snippet, import)
923 // In this case, add a `{`, then the moved import, then whatever
925 format!("{{{}, {}", import, start_snippet)
930 // Add a `};` to the end if nested, matching the `{` added at the start.
932 corrections.push((source_map.end_point(after_crate_name),
937 let suggestion = Some((
939 String::from("a macro with this name exists at the root of the crate"),
940 Applicability::MaybeIncorrect,
943 "this could be because a macro annotated with `#[macro_export]` will be exported \
944 at the root of the crate instead of the module where it is defined".to_string(),
946 Some((suggestion, note))
953 /// Given a `binding_span` of a binding within a use statement:
956 /// use foo::{a, b, c};
960 /// then return the span until the next binding or the end of the statement:
963 /// use foo::{a, b, c};
966 pub(crate) fn find_span_of_binding_until_next_binding(
971 let source_map = sess.source_map();
973 // Find the span of everything after the binding.
974 // ie. `a, e};` or `a};`
975 let binding_until_end = binding_span.with_hi(use_span.hi());
977 // Find everything after the binding but not including the binding.
978 // ie. `, e};` or `};`
979 let after_binding_until_end = binding_until_end.with_lo(binding_span.hi());
981 // Keep characters in the span until we encounter something that isn't a comma or
985 // Also note whether a closing brace character was encountered. If there
986 // was, then later go backwards to remove any trailing commas that are left.
987 let mut found_closing_brace = false;
988 let after_binding_until_next_binding = source_map.span_take_while(
989 after_binding_until_end,
991 if ch == '}' { found_closing_brace = true; }
992 ch == ' ' || ch == ','
996 // Combine the two spans.
999 // Removing these would leave `issue_52891::{d, e};` or `issue_52891::{d, e, };`
1000 let span = binding_span.with_hi(after_binding_until_next_binding.hi());
1002 (found_closing_brace, span)
1005 /// Given a `binding_span`, return the span through to the comma or opening brace of the previous
1009 /// use foo::a::{a, b, c};
1010 /// ^^--- binding span
1014 /// use foo::{a, b, c};
1015 /// --- binding span
1017 pub(crate) fn extend_span_to_previous_binding(
1021 let source_map = sess.source_map();
1023 // `prev_source` will contain all of the source that came before the span.
1024 // Then split based on a command and take the first (ie. closest to our span)
1025 // snippet. In the example, this is a space.
1026 let prev_source = source_map.span_to_prev_source(binding_span).ok()?;
1028 let prev_comma = prev_source.rsplit(',').collect::<Vec<_>>();
1029 let prev_starting_brace = prev_source.rsplit('{').collect::<Vec<_>>();
1030 if prev_comma.len() <= 1 || prev_starting_brace.len() <= 1 {
1034 let prev_comma = prev_comma.first().unwrap();
1035 let prev_starting_brace = prev_starting_brace.first().unwrap();
1037 // If the amount of source code before the comma is greater than
1038 // the amount of source code before the starting brace then we've only
1039 // got one item in the nested item (eg. `issue_52891::{self}`).
1040 if prev_comma.len() > prev_starting_brace.len() {
1044 Some(binding_span.with_lo(BytePos(
1045 // Take away the number of bytes for the characters we've found and an
1046 // extra for the comma.
1047 binding_span.lo().0 - (prev_comma.as_bytes().len() as u32) - 1
1051 /// Given a `use_span` of a binding within a use statement, returns the highlighted span and if
1052 /// it is a nested use tree.
1055 /// use foo::a::{b, c};
1056 /// ^^^^^^^^^^ // false
1058 /// use foo::{a, b, c};
1059 /// ^^^^^^^^^^ // true
1061 /// use foo::{a, b::{c, d}};
1062 /// ^^^^^^^^^^^^^^^ // true
1064 fn find_span_immediately_after_crate_name(
1066 module_name: Symbol,
1069 debug!("find_span_immediately_after_crate_name: module_name={:?} use_span={:?}",
1070 module_name, use_span);
1071 let source_map = sess.source_map();
1073 // Using `use issue_59764::foo::{baz, makro};` as an example throughout..
1074 let mut num_colons = 0;
1075 // Find second colon.. `use issue_59764:`
1076 let until_second_colon = source_map.span_take_while(use_span, |c| {
1077 if *c == ':' { num_colons += 1; }
1079 ':' if num_colons == 2 => false,
1083 // Find everything after the second colon.. `foo::{baz, makro};`
1084 let from_second_colon = use_span.with_lo(until_second_colon.hi() + BytePos(1));
1086 let mut found_a_non_whitespace_character = false;
1087 // Find the first non-whitespace character in `from_second_colon`.. `f`
1088 let after_second_colon = source_map.span_take_while(from_second_colon, |c| {
1089 if found_a_non_whitespace_character { return false; }
1090 if !c.is_whitespace() { found_a_non_whitespace_character = true; }
1094 // Find the first `{` in from_second_colon.. `foo::{`
1095 let next_left_bracket = source_map.span_through_char(from_second_colon, '{');
1097 (next_left_bracket == after_second_colon, from_second_colon)
1100 /// When an entity with a given name is not available in scope, we search for
1101 /// entities with that name in all crates. This method allows outputting the
1102 /// results of this search in a programmer-friendly way
1103 crate fn show_candidates(
1104 err: &mut DiagnosticBuilder<'_>,
1105 // This is `None` if all placement locations are inside expansions
1107 candidates: &[ImportSuggestion],
1111 // we want consistent results across executions, but candidates are produced
1112 // by iterating through a hash map, so make sure they are ordered:
1113 let mut path_strings: Vec<_> =
1114 candidates.into_iter().map(|c| path_names_to_string(&c.path)).collect();
1115 path_strings.sort();
1117 let better = if better { "better " } else { "" };
1118 let msg_diff = match path_strings.len() {
1119 1 => " is found in another module, you can import it",
1120 _ => "s are found in other modules, you can import them",
1122 let msg = format!("possible {}candidate{} into scope", better, msg_diff);
1124 if let Some(span) = span {
1125 for candidate in &mut path_strings {
1126 // produce an additional newline to separate the new use statement
1127 // from the directly following item.
1128 let additional_newline = if found_use {
1133 *candidate = format!("use {};\n{}", candidate, additional_newline);
1136 err.span_suggestions(
1139 path_strings.into_iter(),
1140 Applicability::Unspecified,
1145 for candidate in path_strings {
1147 msg.push_str(&candidate);