1 // ignore-tidy-filelength
3 //! This crate is responsible for the part of name resolution that doesn't require type checker.
5 //! Module structure of the crate is built here.
6 //! Paths in macros, imports, expressions, types, patterns are resolved here.
7 //! Label and lifetime names are resolved here as well.
9 //! Type-relative name resolution (methods, fields, associated items) happens in `librustc_typeck`.
11 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/nightly-rustc/")]
12 #![feature(bool_to_option)]
13 #![feature(crate_visibility_modifier)]
14 #![feature(format_args_capture)]
16 #![feature(or_patterns)]
17 #![recursion_limit = "256"]
19 pub use rustc_hir::def::{Namespace, PerNS};
23 use rustc_arena::{DroplessArena, TypedArena};
24 use rustc_ast::node_id::NodeMap;
25 use rustc_ast::unwrap_or;
26 use rustc_ast::visit::{self, Visitor};
27 use rustc_ast::{self as ast, FloatTy, IntTy, NodeId, UintTy};
28 use rustc_ast::{Crate, CRATE_NODE_ID};
29 use rustc_ast::{ItemKind, Path};
30 use rustc_ast_lowering::ResolverAstLowering;
31 use rustc_ast_pretty::pprust;
32 use rustc_data_structures::fx::{FxHashMap, FxHashSet, FxIndexMap};
33 use rustc_data_structures::ptr_key::PtrKey;
34 use rustc_data_structures::sync::Lrc;
35 use rustc_errors::{struct_span_err, Applicability, DiagnosticBuilder};
36 use rustc_expand::base::{SyntaxExtension, SyntaxExtensionKind};
37 use rustc_hir::def::Namespace::*;
38 use rustc_hir::def::{self, CtorOf, DefKind, NonMacroAttrKind, PartialRes};
39 use rustc_hir::def_id::{CrateNum, DefId, DefIdMap, LocalDefId, CRATE_DEF_INDEX};
40 use rustc_hir::definitions::{DefKey, DefPathData, Definitions};
41 use rustc_hir::PrimTy::{self, Bool, Char, Float, Int, Str, Uint};
42 use rustc_hir::TraitCandidate;
43 use rustc_index::vec::IndexVec;
44 use rustc_metadata::creader::{CStore, CrateLoader};
45 use rustc_middle::hir::exports::ExportMap;
46 use rustc_middle::middle::cstore::{CrateStore, MetadataLoaderDyn};
47 use rustc_middle::span_bug;
48 use rustc_middle::ty::query::Providers;
49 use rustc_middle::ty::{self, DefIdTree, ResolverOutputs};
50 use rustc_session::lint;
51 use rustc_session::lint::{BuiltinLintDiagnostics, LintBuffer};
52 use rustc_session::Session;
53 use rustc_span::edition::Edition;
54 use rustc_span::hygiene::{ExpnId, ExpnKind, MacroKind, SyntaxContext, Transparency};
55 use rustc_span::source_map::Spanned;
56 use rustc_span::symbol::{kw, sym, Ident, Symbol};
57 use rustc_span::{Span, DUMMY_SP};
59 use smallvec::{smallvec, SmallVec};
60 use std::cell::{Cell, RefCell};
61 use std::collections::BTreeSet;
62 use std::{cmp, fmt, iter, ptr};
65 use diagnostics::{extend_span_to_previous_binding, find_span_of_binding_until_next_binding};
66 use diagnostics::{ImportSuggestion, LabelSuggestion, Suggestion};
67 use imports::{Import, ImportKind, ImportResolver, NameResolution};
68 use late::{ConstantItemKind, HasGenericParams, PathSource, Rib, RibKind::*};
69 use macros::{MacroRulesBinding, MacroRulesScope, MacroRulesScopeRef};
71 type Res = def::Res<NodeId>;
73 mod build_reduced_graph;
86 #[derive(Copy, Clone, PartialEq, Debug)]
87 pub enum Determinacy {
93 fn determined(determined: bool) -> Determinacy {
94 if determined { Determinacy::Determined } else { Determinacy::Undetermined }
98 /// A specific scope in which a name can be looked up.
99 /// This enum is currently used only for early resolution (imports and macros),
100 /// but not for late resolution yet.
101 #[derive(Clone, Copy)]
103 DeriveHelpers(ExpnId),
105 MacroRules(MacroRulesScopeRef<'a>),
117 /// Names from different contexts may want to visit different subsets of all specific scopes
118 /// with different restrictions when looking up the resolution.
119 /// This enum is currently used only for early resolution (imports and macros),
120 /// but not for late resolution yet.
122 /// All scopes with the given namespace.
123 All(Namespace, /*is_import*/ bool),
124 /// Crate root, then extern prelude (used for mixed 2015-2018 mode in macros).
125 AbsolutePath(Namespace),
126 /// All scopes with macro namespace and the given macro kind restriction.
130 /// Everything you need to know about a name's location to resolve it.
131 /// Serves as a starting point for the scope visitor.
132 /// This struct is currently used only for early resolution (imports and macros),
133 /// but not for late resolution yet.
134 #[derive(Clone, Copy, Debug)]
135 pub struct ParentScope<'a> {
138 macro_rules: MacroRulesScopeRef<'a>,
139 derives: &'a [ast::Path],
142 impl<'a> ParentScope<'a> {
143 /// Creates a parent scope with the passed argument used as the module scope component,
144 /// and other scope components set to default empty values.
145 pub fn module(module: Module<'a>, resolver: &Resolver<'a>) -> ParentScope<'a> {
148 expansion: ExpnId::root(),
149 macro_rules: resolver.arenas.alloc_macro_rules_scope(MacroRulesScope::Empty),
156 struct BindingError {
158 origin: BTreeSet<Span>,
159 target: BTreeSet<Span>,
163 impl PartialOrd for BindingError {
164 fn partial_cmp(&self, other: &BindingError) -> Option<cmp::Ordering> {
165 Some(self.cmp(other))
169 impl PartialEq for BindingError {
170 fn eq(&self, other: &BindingError) -> bool {
171 self.name == other.name
175 impl Ord for BindingError {
176 fn cmp(&self, other: &BindingError) -> cmp::Ordering {
177 self.name.cmp(&other.name)
181 enum ResolutionError<'a> {
182 /// Error E0401: can't use type or const parameters from outer function.
183 GenericParamsFromOuterFunction(Res, HasGenericParams),
184 /// Error E0403: the name is already used for a type or const parameter in this generic
186 NameAlreadyUsedInParameterList(Symbol, Span),
187 /// Error E0407: method is not a member of trait.
188 MethodNotMemberOfTrait(Symbol, &'a str),
189 /// Error E0437: type is not a member of trait.
190 TypeNotMemberOfTrait(Symbol, &'a str),
191 /// Error E0438: const is not a member of trait.
192 ConstNotMemberOfTrait(Symbol, &'a str),
193 /// Error E0408: variable `{}` is not bound in all patterns.
194 VariableNotBoundInPattern(&'a BindingError),
195 /// Error E0409: variable `{}` is bound in inconsistent ways within the same match arm.
196 VariableBoundWithDifferentMode(Symbol, Span),
197 /// Error E0415: identifier is bound more than once in this parameter list.
198 IdentifierBoundMoreThanOnceInParameterList(Symbol),
199 /// Error E0416: identifier is bound more than once in the same pattern.
200 IdentifierBoundMoreThanOnceInSamePattern(Symbol),
201 /// Error E0426: use of undeclared label.
202 UndeclaredLabel { name: Symbol, suggestion: Option<LabelSuggestion> },
203 /// Error E0429: `self` imports are only allowed within a `{ }` list.
204 SelfImportsOnlyAllowedWithin { root: bool, span_with_rename: Span },
205 /// Error E0430: `self` import can only appear once in the list.
206 SelfImportCanOnlyAppearOnceInTheList,
207 /// Error E0431: `self` import can only appear in an import list with a non-empty prefix.
208 SelfImportOnlyInImportListWithNonEmptyPrefix,
209 /// Error E0433: failed to resolve.
210 FailedToResolve { label: String, suggestion: Option<Suggestion> },
211 /// Error E0434: can't capture dynamic environment in a fn item.
212 CannotCaptureDynamicEnvironmentInFnItem,
213 /// Error E0435: attempt to use a non-constant value in a constant.
214 AttemptToUseNonConstantValueInConstant(
216 /* suggestion */ &'static str,
217 /* current */ &'static str,
219 /// Error E0530: `X` bindings cannot shadow `Y`s.
220 BindingShadowsSomethingUnacceptable(&'static str, Symbol, &'a NameBinding<'a>),
221 /// Error E0128: type parameters with a default cannot use forward-declared identifiers.
222 ForwardDeclaredTyParam, // FIXME(const_generics_defaults)
223 /// ERROR E0770: the type of const parameters must not depend on other generic parameters.
224 ParamInTyOfConstParam(Symbol),
225 /// constant values inside of type parameter defaults must not depend on generic parameters.
226 ParamInAnonConstInTyDefault(Symbol),
227 /// generic parameters must not be used inside const evaluations.
229 /// This error is only emitted when using `min_const_generics`.
230 ParamInNonTrivialAnonConst { name: Symbol, is_type: bool },
231 /// Error E0735: type parameters with a default cannot use `Self`
232 SelfInTyParamDefault,
233 /// Error E0767: use of unreachable label
234 UnreachableLabel { name: Symbol, definition_span: Span, suggestion: Option<LabelSuggestion> },
237 enum VisResolutionError<'a> {
238 Relative2018(Span, &'a ast::Path),
240 FailedToResolve(Span, String, Option<Suggestion>),
241 ExpectedFound(Span, String, Res),
246 /// A minimal representation of a path segment. We use this in resolve because we synthesize 'path
247 /// segments' which don't have the rest of an AST or HIR `PathSegment`.
248 #[derive(Clone, Copy, Debug)]
252 /// Signals whether this `PathSegment` has generic arguments. Used to avoid providing
253 /// nonsensical suggestions.
254 has_generic_args: bool,
258 fn from_path(path: &Path) -> Vec<Segment> {
259 path.segments.iter().map(|s| s.into()).collect()
262 fn from_ident(ident: Ident) -> Segment {
263 Segment { ident, id: None, has_generic_args: false }
266 fn names_to_string(segments: &[Segment]) -> String {
267 names_to_string(&segments.iter().map(|seg| seg.ident.name).collect::<Vec<_>>())
271 impl<'a> From<&'a ast::PathSegment> for Segment {
272 fn from(seg: &'a ast::PathSegment) -> Segment {
273 Segment { ident: seg.ident, id: Some(seg.id), has_generic_args: seg.args.is_some() }
277 struct UsePlacementFinder {
278 target_module: NodeId,
283 impl UsePlacementFinder {
284 fn check(krate: &Crate, target_module: NodeId) -> (Option<Span>, bool) {
285 let mut finder = UsePlacementFinder { target_module, span: None, found_use: false };
286 visit::walk_crate(&mut finder, krate);
287 (finder.span, finder.found_use)
291 impl<'tcx> Visitor<'tcx> for UsePlacementFinder {
294 module: &'tcx ast::Mod,
296 _: &[ast::Attribute],
299 if self.span.is_some() {
302 if node_id != self.target_module {
303 visit::walk_mod(self, module);
306 // find a use statement
307 for item in &module.items {
309 ItemKind::Use(..) => {
310 // don't suggest placing a use before the prelude
311 // import or other generated ones
312 if !item.span.from_expansion() {
313 self.span = Some(item.span.shrink_to_lo());
314 self.found_use = true;
318 // don't place use before extern crate
319 ItemKind::ExternCrate(_) => {}
320 // but place them before the first other item
322 if self.span.map_or(true, |span| item.span < span)
323 && !item.span.from_expansion()
325 // don't insert between attributes and an item
326 if item.attrs.is_empty() {
327 self.span = Some(item.span.shrink_to_lo());
329 // find the first attribute on the item
330 for attr in &item.attrs {
331 if self.span.map_or(true, |span| attr.span < span) {
332 self.span = Some(attr.span.shrink_to_lo());
343 /// An intermediate resolution result.
345 /// This refers to the thing referred by a name. The difference between `Res` and `Item` is that
346 /// items are visible in their whole block, while `Res`es only from the place they are defined
349 enum LexicalScopeBinding<'a> {
350 Item(&'a NameBinding<'a>),
354 impl<'a> LexicalScopeBinding<'a> {
355 fn res(self) -> Res {
357 LexicalScopeBinding::Item(binding) => binding.res(),
358 LexicalScopeBinding::Res(res) => res,
363 #[derive(Copy, Clone, Debug)]
364 enum ModuleOrUniformRoot<'a> {
368 /// Virtual module that denotes resolution in crate root with fallback to extern prelude.
369 CrateRootAndExternPrelude,
371 /// Virtual module that denotes resolution in extern prelude.
372 /// Used for paths starting with `::` on 2018 edition.
375 /// Virtual module that denotes resolution in current scope.
376 /// Used only for resolving single-segment imports. The reason it exists is that import paths
377 /// are always split into two parts, the first of which should be some kind of module.
381 impl ModuleOrUniformRoot<'_> {
382 fn same_def(lhs: Self, rhs: Self) -> bool {
384 (ModuleOrUniformRoot::Module(lhs), ModuleOrUniformRoot::Module(rhs)) => {
385 lhs.def_id() == rhs.def_id()
388 ModuleOrUniformRoot::CrateRootAndExternPrelude,
389 ModuleOrUniformRoot::CrateRootAndExternPrelude,
391 | (ModuleOrUniformRoot::ExternPrelude, ModuleOrUniformRoot::ExternPrelude)
392 | (ModuleOrUniformRoot::CurrentScope, ModuleOrUniformRoot::CurrentScope) => true,
398 #[derive(Clone, Debug)]
399 enum PathResult<'a> {
400 Module(ModuleOrUniformRoot<'a>),
401 NonModule(PartialRes),
406 suggestion: Option<Suggestion>,
407 is_error_from_last_segment: bool,
413 /// An anonymous module; e.g., just a block.
418 /// { // This is an anonymous module
419 /// f(); // This resolves to (2) as we are inside the block.
422 /// f(); // Resolves to (1)
426 /// Any module with a name.
430 /// * A normal module – either `mod from_file;` or `mod from_block { }` –
431 /// or the crate root (which is conceptually a top-level module).
432 /// Note that the crate root's [name][Self::name] will be [`kw::Empty`].
433 /// * A trait or an enum (it implicitly contains associated types, methods and variant
435 Def(DefKind, DefId, Symbol),
439 /// Get name of the module.
440 pub fn name(&self) -> Option<Symbol> {
442 ModuleKind::Block(..) => None,
443 ModuleKind::Def(.., name) => Some(*name),
448 /// A key that identifies a binding in a given `Module`.
450 /// Multiple bindings in the same module can have the same key (in a valid
451 /// program) if all but one of them come from glob imports.
452 #[derive(Copy, Clone, PartialEq, Eq, Hash, Debug)]
454 /// The identifier for the binding, aways the `normalize_to_macros_2_0` version of the
458 /// 0 if ident is not `_`, otherwise a value that's unique to the specific
459 /// `_` in the expanded AST that introduced this binding.
463 type Resolutions<'a> = RefCell<FxIndexMap<BindingKey, &'a RefCell<NameResolution<'a>>>>;
465 /// One node in the tree of modules.
467 /// Note that a "module" in resolve is broader than a `mod` that you declare in Rust code. It may be one of these:
470 /// * crate root (aka, top-level anonymous module)
473 /// * curly-braced block with statements
475 /// You can use [`ModuleData::kind`] to determine the kind of module this is.
476 pub struct ModuleData<'a> {
477 /// The direct parent module (it may not be a `mod`, however).
478 parent: Option<Module<'a>>,
479 /// What kind of module this is, because this may not be a `mod`.
482 /// The [`DefId`] of the nearest `mod` item ancestor (which may be this module).
483 /// This may be the crate root.
484 nearest_parent_mod: DefId,
486 /// Mapping between names and their (possibly in-progress) resolutions in this module.
487 /// Resolutions in modules from other crates are not populated until accessed.
488 lazy_resolutions: Resolutions<'a>,
489 /// True if this is a module from other crate that needs to be populated on access.
490 populate_on_access: Cell<bool>,
492 /// Macro invocations that can expand into items in this module.
493 unexpanded_invocations: RefCell<FxHashSet<ExpnId>>,
495 /// Whether `#[no_implicit_prelude]` is active.
496 no_implicit_prelude: bool,
498 glob_importers: RefCell<Vec<&'a Import<'a>>>,
499 globs: RefCell<Vec<&'a Import<'a>>>,
501 /// Used to memoize the traits in this module for faster searches through all traits in scope.
502 traits: RefCell<Option<Box<[(Ident, &'a NameBinding<'a>)]>>>,
504 /// Span of the module itself. Used for error reporting.
510 type Module<'a> = &'a ModuleData<'a>;
512 impl<'a> ModuleData<'a> {
514 parent: Option<Module<'a>>,
516 nearest_parent_mod: DefId,
524 lazy_resolutions: Default::default(),
525 populate_on_access: Cell::new(!nearest_parent_mod.is_local()),
526 unexpanded_invocations: Default::default(),
527 no_implicit_prelude: false,
528 glob_importers: RefCell::new(Vec::new()),
529 globs: RefCell::new(Vec::new()),
530 traits: RefCell::new(None),
536 fn for_each_child<R, F>(&'a self, resolver: &mut R, mut f: F)
538 R: AsMut<Resolver<'a>>,
539 F: FnMut(&mut R, Ident, Namespace, &'a NameBinding<'a>),
541 for (key, name_resolution) in resolver.as_mut().resolutions(self).borrow().iter() {
542 if let Some(binding) = name_resolution.borrow().binding {
543 f(resolver, key.ident, key.ns, binding);
548 /// This modifies `self` in place. The traits will be stored in `self.traits`.
549 fn ensure_traits<R>(&'a self, resolver: &mut R)
551 R: AsMut<Resolver<'a>>,
553 let mut traits = self.traits.borrow_mut();
554 if traits.is_none() {
555 let mut collected_traits = Vec::new();
556 self.for_each_child(resolver, |_, name, ns, binding| {
560 if let Res::Def(DefKind::Trait | DefKind::TraitAlias, _) = binding.res() {
561 collected_traits.push((name, binding))
564 *traits = Some(collected_traits.into_boxed_slice());
568 fn res(&self) -> Option<Res> {
570 ModuleKind::Def(kind, def_id, _) => Some(Res::Def(kind, def_id)),
575 fn def_id(&self) -> Option<DefId> {
577 ModuleKind::Def(_, def_id, _) => Some(def_id),
582 // `self` resolves to the first module ancestor that `is_normal`.
583 fn is_normal(&self) -> bool {
584 matches!(self.kind, ModuleKind::Def(DefKind::Mod, _, _))
587 fn is_trait(&self) -> bool {
588 matches!(self.kind, ModuleKind::Def(DefKind::Trait, _, _))
591 fn nearest_item_scope(&'a self) -> Module<'a> {
593 ModuleKind::Def(DefKind::Enum | DefKind::Trait, ..) => {
594 self.parent.expect("enum or trait module without a parent")
600 fn is_ancestor_of(&self, mut other: &Self) -> bool {
601 while !ptr::eq(self, other) {
602 if let Some(parent) = other.parent {
612 impl<'a> fmt::Debug for ModuleData<'a> {
613 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
614 write!(f, "{:?}", self.res())
618 /// Records a possibly-private value, type, or module definition.
619 #[derive(Clone, Debug)]
620 pub struct NameBinding<'a> {
621 kind: NameBindingKind<'a>,
622 ambiguity: Option<(&'a NameBinding<'a>, AmbiguityKind)>,
628 pub trait ToNameBinding<'a> {
629 fn to_name_binding(self, arenas: &'a ResolverArenas<'a>) -> &'a NameBinding<'a>;
632 impl<'a> ToNameBinding<'a> for &'a NameBinding<'a> {
633 fn to_name_binding(self, _: &'a ResolverArenas<'a>) -> &'a NameBinding<'a> {
638 #[derive(Clone, Debug)]
639 enum NameBindingKind<'a> {
640 Res(Res, /* is_macro_export */ bool),
642 Import { binding: &'a NameBinding<'a>, import: &'a Import<'a>, used: Cell<bool> },
645 impl<'a> NameBindingKind<'a> {
646 /// Is this a name binding of a import?
647 fn is_import(&self) -> bool {
648 matches!(*self, NameBindingKind::Import { .. })
652 struct PrivacyError<'a> {
654 binding: &'a NameBinding<'a>,
658 struct UseError<'a> {
659 err: DiagnosticBuilder<'a>,
660 /// Candidates which user could `use` to access the missing type.
661 candidates: Vec<ImportSuggestion>,
662 /// The `DefId` of the module to place the use-statements in.
664 /// Whether the diagnostic should say "instead" (as in `consider importing ... instead`).
666 /// Extra free-form suggestion.
667 suggestion: Option<(Span, &'static str, String, Applicability)>,
670 #[derive(Clone, Copy, PartialEq, Debug)]
675 MacroRulesVsModularized,
683 fn descr(self) -> &'static str {
685 AmbiguityKind::Import => "name vs any other name during import resolution",
686 AmbiguityKind::BuiltinAttr => "built-in attribute vs any other name",
687 AmbiguityKind::DeriveHelper => "derive helper attribute vs any other name",
688 AmbiguityKind::MacroRulesVsModularized => {
689 "`macro_rules` vs non-`macro_rules` from other module"
691 AmbiguityKind::GlobVsOuter => {
692 "glob import vs any other name from outer scope during import/macro resolution"
694 AmbiguityKind::GlobVsGlob => "glob import vs glob import in the same module",
695 AmbiguityKind::GlobVsExpanded => {
696 "glob import vs macro-expanded name in the same \
697 module during import/macro resolution"
699 AmbiguityKind::MoreExpandedVsOuter => {
700 "macro-expanded name vs less macro-expanded name \
701 from outer scope during import/macro resolution"
707 /// Miscellaneous bits of metadata for better ambiguity error reporting.
708 #[derive(Clone, Copy, PartialEq)]
709 enum AmbiguityErrorMisc {
716 struct AmbiguityError<'a> {
719 b1: &'a NameBinding<'a>,
720 b2: &'a NameBinding<'a>,
721 misc1: AmbiguityErrorMisc,
722 misc2: AmbiguityErrorMisc,
725 impl<'a> NameBinding<'a> {
726 fn module(&self) -> Option<Module<'a>> {
728 NameBindingKind::Module(module) => Some(module),
729 NameBindingKind::Import { binding, .. } => binding.module(),
734 fn res(&self) -> Res {
736 NameBindingKind::Res(res, _) => res,
737 NameBindingKind::Module(module) => module.res().unwrap(),
738 NameBindingKind::Import { binding, .. } => binding.res(),
742 fn is_ambiguity(&self) -> bool {
743 self.ambiguity.is_some()
745 NameBindingKind::Import { binding, .. } => binding.is_ambiguity(),
750 fn is_possibly_imported_variant(&self) -> bool {
752 NameBindingKind::Import { binding, .. } => binding.is_possibly_imported_variant(),
753 _ => self.is_variant(),
757 // We sometimes need to treat variants as `pub` for backwards compatibility.
758 fn pseudo_vis(&self) -> ty::Visibility {
759 if self.is_variant() && self.res().def_id().is_local() {
760 ty::Visibility::Public
766 fn is_variant(&self) -> bool {
769 NameBindingKind::Res(
770 Res::Def(DefKind::Variant | DefKind::Ctor(CtorOf::Variant, ..), _),
776 fn is_extern_crate(&self) -> bool {
778 NameBindingKind::Import {
779 import: &Import { kind: ImportKind::ExternCrate { .. }, .. },
782 NameBindingKind::Module(&ModuleData {
783 kind: ModuleKind::Def(DefKind::Mod, def_id, _),
785 }) => def_id.index == CRATE_DEF_INDEX,
790 fn is_import(&self) -> bool {
791 matches!(self.kind, NameBindingKind::Import { .. })
794 fn is_glob_import(&self) -> bool {
796 NameBindingKind::Import { import, .. } => import.is_glob(),
801 fn is_importable(&self) -> bool {
804 Res::Def(DefKind::AssocConst | DefKind::AssocFn | DefKind::AssocTy, _)
808 fn is_macro_def(&self) -> bool {
809 matches!(self.kind, NameBindingKind::Res(Res::Def(DefKind::Macro(..), _), _))
812 fn macro_kind(&self) -> Option<MacroKind> {
813 self.res().macro_kind()
816 // Suppose that we resolved macro invocation with `invoc_parent_expansion` to binding `binding`
817 // at some expansion round `max(invoc, binding)` when they both emerged from macros.
818 // Then this function returns `true` if `self` may emerge from a macro *after* that
819 // in some later round and screw up our previously found resolution.
820 // See more detailed explanation in
821 // https://github.com/rust-lang/rust/pull/53778#issuecomment-419224049
822 fn may_appear_after(&self, invoc_parent_expansion: ExpnId, binding: &NameBinding<'_>) -> bool {
823 // self > max(invoc, binding) => !(self <= invoc || self <= binding)
824 // Expansions are partially ordered, so "may appear after" is an inversion of
825 // "certainly appears before or simultaneously" and includes unordered cases.
826 let self_parent_expansion = self.expansion;
827 let other_parent_expansion = binding.expansion;
828 let certainly_before_other_or_simultaneously =
829 other_parent_expansion.is_descendant_of(self_parent_expansion);
830 let certainly_before_invoc_or_simultaneously =
831 invoc_parent_expansion.is_descendant_of(self_parent_expansion);
832 !(certainly_before_other_or_simultaneously || certainly_before_invoc_or_simultaneously)
836 /// Interns the names of the primitive types.
838 /// All other types are defined somewhere and possibly imported, but the primitive ones need
839 /// special handling, since they have no place of origin.
840 struct PrimitiveTypeTable {
841 primitive_types: FxHashMap<Symbol, PrimTy>,
844 impl PrimitiveTypeTable {
845 fn new() -> PrimitiveTypeTable {
846 let mut table = FxHashMap::default();
848 table.insert(sym::bool, Bool);
849 table.insert(sym::char, Char);
850 table.insert(sym::f32, Float(FloatTy::F32));
851 table.insert(sym::f64, Float(FloatTy::F64));
852 table.insert(sym::isize, Int(IntTy::Isize));
853 table.insert(sym::i8, Int(IntTy::I8));
854 table.insert(sym::i16, Int(IntTy::I16));
855 table.insert(sym::i32, Int(IntTy::I32));
856 table.insert(sym::i64, Int(IntTy::I64));
857 table.insert(sym::i128, Int(IntTy::I128));
858 table.insert(sym::str, Str);
859 table.insert(sym::usize, Uint(UintTy::Usize));
860 table.insert(sym::u8, Uint(UintTy::U8));
861 table.insert(sym::u16, Uint(UintTy::U16));
862 table.insert(sym::u32, Uint(UintTy::U32));
863 table.insert(sym::u64, Uint(UintTy::U64));
864 table.insert(sym::u128, Uint(UintTy::U128));
865 Self { primitive_types: table }
869 #[derive(Debug, Default, Clone)]
870 pub struct ExternPreludeEntry<'a> {
871 extern_crate_item: Option<&'a NameBinding<'a>>,
872 pub introduced_by_item: bool,
875 /// Used for better errors for E0773
876 enum BuiltinMacroState {
877 NotYetSeen(SyntaxExtensionKind),
881 /// The main resolver class.
883 /// This is the visitor that walks the whole crate.
884 pub struct Resolver<'a> {
885 session: &'a Session,
887 definitions: Definitions,
889 graph_root: Module<'a>,
891 prelude: Option<Module<'a>>,
892 extern_prelude: FxHashMap<Ident, ExternPreludeEntry<'a>>,
894 /// N.B., this is used only for better diagnostics, not name resolution itself.
895 has_self: FxHashSet<DefId>,
897 /// Names of fields of an item `DefId` accessible with dot syntax.
898 /// Used for hints during error reporting.
899 field_names: FxHashMap<DefId, Vec<Spanned<Symbol>>>,
901 /// All imports known to succeed or fail.
902 determined_imports: Vec<&'a Import<'a>>,
904 /// All non-determined imports.
905 indeterminate_imports: Vec<&'a Import<'a>>,
907 /// FIXME: Refactor things so that these fields are passed through arguments and not resolver.
908 /// We are resolving a last import segment during import validation.
909 last_import_segment: bool,
910 /// This binding should be ignored during in-module resolution, so that we don't get
911 /// "self-confirming" import resolutions during import validation.
912 unusable_binding: Option<&'a NameBinding<'a>>,
914 /// The idents for the primitive types.
915 primitive_type_table: PrimitiveTypeTable,
917 /// Resolutions for nodes that have a single resolution.
918 partial_res_map: NodeMap<PartialRes>,
919 /// Resolutions for import nodes, which have multiple resolutions in different namespaces.
920 import_res_map: NodeMap<PerNS<Option<Res>>>,
921 /// Resolutions for labels (node IDs of their corresponding blocks or loops).
922 label_res_map: NodeMap<NodeId>,
924 /// `CrateNum` resolutions of `extern crate` items.
925 extern_crate_map: FxHashMap<LocalDefId, CrateNum>,
926 export_map: ExportMap<LocalDefId>,
927 trait_map: NodeMap<Vec<TraitCandidate>>,
929 /// A map from nodes to anonymous modules.
930 /// Anonymous modules are pseudo-modules that are implicitly created around items
931 /// contained within blocks.
933 /// For example, if we have this:
941 /// There will be an anonymous module created around `g` with the ID of the
942 /// entry block for `f`.
943 block_map: NodeMap<Module<'a>>,
944 /// A fake module that contains no definition and no prelude. Used so that
945 /// some AST passes can generate identifiers that only resolve to local or
947 empty_module: Module<'a>,
948 module_map: FxHashMap<LocalDefId, Module<'a>>,
949 extern_module_map: FxHashMap<DefId, Module<'a>>,
950 binding_parent_modules: FxHashMap<PtrKey<'a, NameBinding<'a>>, Module<'a>>,
951 underscore_disambiguator: u32,
953 /// Maps glob imports to the names of items actually imported.
954 glob_map: FxHashMap<LocalDefId, FxHashSet<Symbol>>,
955 /// Visibilities in "lowered" form, for all entities that have them.
956 visibilities: FxHashMap<LocalDefId, ty::Visibility>,
957 used_imports: FxHashSet<(NodeId, Namespace)>,
958 maybe_unused_trait_imports: FxHashSet<LocalDefId>,
959 maybe_unused_extern_crates: Vec<(LocalDefId, Span)>,
961 /// Privacy errors are delayed until the end in order to deduplicate them.
962 privacy_errors: Vec<PrivacyError<'a>>,
963 /// Ambiguity errors are delayed for deduplication.
964 ambiguity_errors: Vec<AmbiguityError<'a>>,
965 /// `use` injections are delayed for better placement and deduplication.
966 use_injections: Vec<UseError<'a>>,
967 /// Crate-local macro expanded `macro_export` referred to by a module-relative path.
968 macro_expanded_macro_export_errors: BTreeSet<(Span, Span)>,
970 arenas: &'a ResolverArenas<'a>,
971 dummy_binding: &'a NameBinding<'a>,
973 crate_loader: CrateLoader<'a>,
974 macro_names: FxHashSet<Ident>,
975 builtin_macros: FxHashMap<Symbol, BuiltinMacroState>,
976 registered_attrs: FxHashSet<Ident>,
977 registered_tools: FxHashSet<Ident>,
978 macro_use_prelude: FxHashMap<Symbol, &'a NameBinding<'a>>,
979 all_macros: FxHashMap<Symbol, Res>,
980 macro_map: FxHashMap<DefId, Lrc<SyntaxExtension>>,
981 dummy_ext_bang: Lrc<SyntaxExtension>,
982 dummy_ext_derive: Lrc<SyntaxExtension>,
983 non_macro_attrs: [Lrc<SyntaxExtension>; 2],
984 local_macro_def_scopes: FxHashMap<LocalDefId, Module<'a>>,
985 ast_transform_scopes: FxHashMap<ExpnId, Module<'a>>,
986 unused_macros: FxHashMap<LocalDefId, (NodeId, Span)>,
987 proc_macro_stubs: FxHashSet<LocalDefId>,
988 /// Traces collected during macro resolution and validated when it's complete.
989 single_segment_macro_resolutions:
990 Vec<(Ident, MacroKind, ParentScope<'a>, Option<&'a NameBinding<'a>>)>,
991 multi_segment_macro_resolutions:
992 Vec<(Vec<Segment>, Span, MacroKind, ParentScope<'a>, Option<Res>)>,
993 builtin_attrs: Vec<(Ident, ParentScope<'a>)>,
994 /// `derive(Copy)` marks items they are applied to so they are treated specially later.
995 /// Derive macros cannot modify the item themselves and have to store the markers in the global
996 /// context, so they attach the markers to derive container IDs using this resolver table.
997 containers_deriving_copy: FxHashSet<ExpnId>,
998 /// Parent scopes in which the macros were invoked.
999 /// FIXME: `derives` are missing in these parent scopes and need to be taken from elsewhere.
1000 invocation_parent_scopes: FxHashMap<ExpnId, ParentScope<'a>>,
1001 /// `macro_rules` scopes *produced* by expanding the macro invocations,
1002 /// include all the `macro_rules` items and other invocations generated by them.
1003 output_macro_rules_scopes: FxHashMap<ExpnId, MacroRulesScopeRef<'a>>,
1004 /// Helper attributes that are in scope for the given expansion.
1005 helper_attrs: FxHashMap<ExpnId, Vec<Ident>>,
1007 /// Avoid duplicated errors for "name already defined".
1008 name_already_seen: FxHashMap<Symbol, Span>,
1010 potentially_unused_imports: Vec<&'a Import<'a>>,
1012 /// Table for mapping struct IDs into struct constructor IDs,
1013 /// it's not used during normal resolution, only for better error reporting.
1014 /// Also includes of list of each fields visibility
1015 struct_constructors: DefIdMap<(Res, ty::Visibility, Vec<ty::Visibility>)>,
1017 /// Features enabled for this crate.
1018 active_features: FxHashSet<Symbol>,
1020 lint_buffer: LintBuffer,
1022 next_node_id: NodeId,
1024 def_id_to_span: IndexVec<LocalDefId, Span>,
1026 node_id_to_def_id: FxHashMap<ast::NodeId, LocalDefId>,
1027 def_id_to_node_id: IndexVec<LocalDefId, ast::NodeId>,
1029 /// Indices of unnamed struct or variant fields with unresolved attributes.
1030 placeholder_field_indices: FxHashMap<NodeId, usize>,
1031 /// When collecting definitions from an AST fragment produced by a macro invocation `ExpnId`
1032 /// we know what parent node that fragment should be attached to thanks to this table.
1033 invocation_parents: FxHashMap<ExpnId, LocalDefId>,
1035 next_disambiguator: FxHashMap<(LocalDefId, DefPathData), u32>,
1036 /// Some way to know that we are in a *trait* impl in `visit_assoc_item`.
1037 /// FIXME: Replace with a more general AST map (together with some other fields).
1038 trait_impl_items: FxHashSet<LocalDefId>,
1041 /// Nothing really interesting here; it just provides memory for the rest of the crate.
1043 pub struct ResolverArenas<'a> {
1044 modules: TypedArena<ModuleData<'a>>,
1045 local_modules: RefCell<Vec<Module<'a>>>,
1046 imports: TypedArena<Import<'a>>,
1047 name_resolutions: TypedArena<RefCell<NameResolution<'a>>>,
1048 ast_paths: TypedArena<ast::Path>,
1049 dropless: DroplessArena,
1052 impl<'a> ResolverArenas<'a> {
1053 fn alloc_module(&'a self, module: ModuleData<'a>) -> Module<'a> {
1054 let module = self.modules.alloc(module);
1055 if module.def_id().map_or(true, |def_id| def_id.is_local()) {
1056 self.local_modules.borrow_mut().push(module);
1060 fn local_modules(&'a self) -> std::cell::Ref<'a, Vec<Module<'a>>> {
1061 self.local_modules.borrow()
1063 fn alloc_name_binding(&'a self, name_binding: NameBinding<'a>) -> &'a NameBinding<'a> {
1064 self.dropless.alloc(name_binding)
1066 fn alloc_import(&'a self, import: Import<'a>) -> &'a Import<'_> {
1067 self.imports.alloc(import)
1069 fn alloc_name_resolution(&'a self) -> &'a RefCell<NameResolution<'a>> {
1070 self.name_resolutions.alloc(Default::default())
1072 fn alloc_macro_rules_scope(&'a self, scope: MacroRulesScope<'a>) -> MacroRulesScopeRef<'a> {
1073 PtrKey(self.dropless.alloc(Cell::new(scope)))
1075 fn alloc_macro_rules_binding(
1077 binding: MacroRulesBinding<'a>,
1078 ) -> &'a MacroRulesBinding<'a> {
1079 self.dropless.alloc(binding)
1081 fn alloc_ast_paths(&'a self, paths: &[ast::Path]) -> &'a [ast::Path] {
1082 self.ast_paths.alloc_from_iter(paths.iter().cloned())
1084 fn alloc_pattern_spans(&'a self, spans: impl Iterator<Item = Span>) -> &'a [Span] {
1085 self.dropless.alloc_from_iter(spans)
1089 impl<'a> AsMut<Resolver<'a>> for Resolver<'a> {
1090 fn as_mut(&mut self) -> &mut Resolver<'a> {
1095 impl<'a, 'b> DefIdTree for &'a Resolver<'b> {
1096 fn parent(self, id: DefId) -> Option<DefId> {
1097 match id.as_local() {
1098 Some(id) => self.definitions.def_key(id).parent,
1099 None => self.cstore().def_key(id).parent,
1101 .map(|index| DefId { index, ..id })
1105 /// This interface is used through the AST→HIR step, to embed full paths into the HIR. After that
1106 /// the resolver is no longer needed as all the relevant information is inline.
1107 impl ResolverAstLowering for Resolver<'_> {
1108 fn def_key(&mut self, id: DefId) -> DefKey {
1109 if let Some(id) = id.as_local() {
1110 self.definitions().def_key(id)
1112 self.cstore().def_key(id)
1116 fn item_generics_num_lifetimes(&self, def_id: DefId, sess: &Session) -> usize {
1117 self.cstore().item_generics_num_lifetimes(def_id, sess)
1120 fn get_partial_res(&mut self, id: NodeId) -> Option<PartialRes> {
1121 self.partial_res_map.get(&id).cloned()
1124 fn get_import_res(&mut self, id: NodeId) -> PerNS<Option<Res>> {
1125 self.import_res_map.get(&id).cloned().unwrap_or_default()
1128 fn get_label_res(&mut self, id: NodeId) -> Option<NodeId> {
1129 self.label_res_map.get(&id).cloned()
1132 fn definitions(&mut self) -> &mut Definitions {
1133 &mut self.definitions
1136 fn lint_buffer(&mut self) -> &mut LintBuffer {
1137 &mut self.lint_buffer
1140 fn next_node_id(&mut self) -> NodeId {
1144 fn trait_map(&self) -> &NodeMap<Vec<TraitCandidate>> {
1148 fn opt_local_def_id(&self, node: NodeId) -> Option<LocalDefId> {
1149 self.node_id_to_def_id.get(&node).copied()
1152 fn local_def_id(&self, node: NodeId) -> LocalDefId {
1153 self.opt_local_def_id(node).unwrap_or_else(|| panic!("no entry for node id: `{:?}`", node))
1156 /// Adds a definition with a parent definition.
1160 node_id: ast::NodeId,
1166 !self.node_id_to_def_id.contains_key(&node_id),
1167 "adding a def'n for node-id {:?} and data {:?} but a previous def'n exists: {:?}",
1170 self.definitions.def_key(self.node_id_to_def_id[&node_id]),
1173 // Find the next free disambiguator for this key.
1174 let next_disambiguator = &mut self.next_disambiguator;
1175 let next_disambiguator = |parent, data| {
1176 let next_disamb = next_disambiguator.entry((parent, data)).or_insert(0);
1177 let disambiguator = *next_disamb;
1178 *next_disamb = next_disamb.checked_add(1).expect("disambiguator overflow");
1182 let def_id = self.definitions.create_def(parent, data, expn_id, next_disambiguator);
1184 assert_eq!(self.def_id_to_span.push(span), def_id);
1186 // Some things for which we allocate `LocalDefId`s don't correspond to
1187 // anything in the AST, so they don't have a `NodeId`. For these cases
1188 // we don't need a mapping from `NodeId` to `LocalDefId`.
1189 if node_id != ast::DUMMY_NODE_ID {
1190 debug!("create_def: def_id_to_node_id[{:?}] <-> {:?}", def_id, node_id);
1191 self.node_id_to_def_id.insert(node_id, def_id);
1193 assert_eq!(self.def_id_to_node_id.push(node_id), def_id);
1199 impl<'a> Resolver<'a> {
1201 session: &'a Session,
1204 metadata_loader: &'a MetadataLoaderDyn,
1205 arenas: &'a ResolverArenas<'a>,
1207 let root_local_def_id = LocalDefId { local_def_index: CRATE_DEF_INDEX };
1208 let root_def_id = root_local_def_id.to_def_id();
1209 let root_module_kind = ModuleKind::Def(DefKind::Mod, root_def_id, kw::Empty);
1210 let graph_root = arenas.alloc_module(ModuleData {
1211 no_implicit_prelude: session.contains_name(&krate.attrs, sym::no_implicit_prelude),
1212 ..ModuleData::new(None, root_module_kind, root_def_id, ExpnId::root(), krate.span)
1214 let empty_module_kind = ModuleKind::Def(DefKind::Mod, root_def_id, kw::Empty);
1215 let empty_module = arenas.alloc_module(ModuleData {
1216 no_implicit_prelude: true,
1225 let mut module_map = FxHashMap::default();
1226 module_map.insert(root_local_def_id, graph_root);
1228 let definitions = Definitions::new(crate_name, session.local_crate_disambiguator());
1229 let root = definitions.get_root_def();
1231 let mut visibilities = FxHashMap::default();
1232 visibilities.insert(root_local_def_id, ty::Visibility::Public);
1234 let mut def_id_to_span = IndexVec::default();
1235 assert_eq!(def_id_to_span.push(rustc_span::DUMMY_SP), root);
1236 let mut def_id_to_node_id = IndexVec::default();
1237 assert_eq!(def_id_to_node_id.push(CRATE_NODE_ID), root);
1238 let mut node_id_to_def_id = FxHashMap::default();
1239 node_id_to_def_id.insert(CRATE_NODE_ID, root);
1241 let mut invocation_parents = FxHashMap::default();
1242 invocation_parents.insert(ExpnId::root(), root);
1244 let mut extern_prelude: FxHashMap<Ident, ExternPreludeEntry<'_>> = session
1248 .filter(|(_, entry)| entry.add_prelude)
1249 .map(|(name, _)| (Ident::from_str(name), Default::default()))
1252 if !session.contains_name(&krate.attrs, sym::no_core) {
1253 extern_prelude.insert(Ident::with_dummy_span(sym::core), Default::default());
1254 if !session.contains_name(&krate.attrs, sym::no_std) {
1255 extern_prelude.insert(Ident::with_dummy_span(sym::std), Default::default());
1259 let (registered_attrs, registered_tools) =
1260 macros::registered_attrs_and_tools(session, &krate.attrs);
1262 let features = session.features_untracked();
1263 let non_macro_attr =
1264 |mark_used| Lrc::new(SyntaxExtension::non_macro_attr(mark_used, session.edition()));
1266 let mut resolver = Resolver {
1271 // The outermost module has def ID 0; this is not reflected in the
1277 has_self: FxHashSet::default(),
1278 field_names: FxHashMap::default(),
1280 determined_imports: Vec::new(),
1281 indeterminate_imports: Vec::new(),
1283 last_import_segment: false,
1284 unusable_binding: None,
1286 primitive_type_table: PrimitiveTypeTable::new(),
1288 partial_res_map: Default::default(),
1289 import_res_map: Default::default(),
1290 label_res_map: Default::default(),
1291 extern_crate_map: Default::default(),
1292 export_map: FxHashMap::default(),
1293 trait_map: Default::default(),
1294 underscore_disambiguator: 0,
1297 block_map: Default::default(),
1298 extern_module_map: FxHashMap::default(),
1299 binding_parent_modules: FxHashMap::default(),
1300 ast_transform_scopes: FxHashMap::default(),
1302 glob_map: Default::default(),
1304 used_imports: FxHashSet::default(),
1305 maybe_unused_trait_imports: Default::default(),
1306 maybe_unused_extern_crates: Vec::new(),
1308 privacy_errors: Vec::new(),
1309 ambiguity_errors: Vec::new(),
1310 use_injections: Vec::new(),
1311 macro_expanded_macro_export_errors: BTreeSet::new(),
1314 dummy_binding: arenas.alloc_name_binding(NameBinding {
1315 kind: NameBindingKind::Res(Res::Err, false),
1317 expansion: ExpnId::root(),
1319 vis: ty::Visibility::Public,
1322 crate_loader: CrateLoader::new(session, metadata_loader, crate_name),
1323 macro_names: FxHashSet::default(),
1324 builtin_macros: Default::default(),
1327 macro_use_prelude: FxHashMap::default(),
1328 all_macros: FxHashMap::default(),
1329 macro_map: FxHashMap::default(),
1330 dummy_ext_bang: Lrc::new(SyntaxExtension::dummy_bang(session.edition())),
1331 dummy_ext_derive: Lrc::new(SyntaxExtension::dummy_derive(session.edition())),
1332 non_macro_attrs: [non_macro_attr(false), non_macro_attr(true)],
1333 invocation_parent_scopes: Default::default(),
1334 output_macro_rules_scopes: Default::default(),
1335 helper_attrs: Default::default(),
1336 local_macro_def_scopes: FxHashMap::default(),
1337 name_already_seen: FxHashMap::default(),
1338 potentially_unused_imports: Vec::new(),
1339 struct_constructors: Default::default(),
1340 unused_macros: Default::default(),
1341 proc_macro_stubs: Default::default(),
1342 single_segment_macro_resolutions: Default::default(),
1343 multi_segment_macro_resolutions: Default::default(),
1344 builtin_attrs: Default::default(),
1345 containers_deriving_copy: Default::default(),
1346 active_features: features
1347 .declared_lib_features
1349 .map(|(feat, ..)| *feat)
1350 .chain(features.declared_lang_features.iter().map(|(feat, ..)| *feat))
1352 lint_buffer: LintBuffer::default(),
1353 next_node_id: NodeId::from_u32(1),
1357 placeholder_field_indices: Default::default(),
1359 next_disambiguator: Default::default(),
1360 trait_impl_items: Default::default(),
1363 let root_parent_scope = ParentScope::module(graph_root, &resolver);
1364 resolver.invocation_parent_scopes.insert(ExpnId::root(), root_parent_scope);
1369 pub fn next_node_id(&mut self) -> NodeId {
1374 .expect("input too large; ran out of NodeIds");
1375 self.next_node_id = ast::NodeId::from_usize(next);
1379 pub fn lint_buffer(&mut self) -> &mut LintBuffer {
1380 &mut self.lint_buffer
1383 pub fn arenas() -> ResolverArenas<'a> {
1387 pub fn into_outputs(self) -> ResolverOutputs {
1388 let definitions = self.definitions;
1389 let visibilities = self.visibilities;
1390 let extern_crate_map = self.extern_crate_map;
1391 let export_map = self.export_map;
1392 let maybe_unused_trait_imports = self.maybe_unused_trait_imports;
1393 let maybe_unused_extern_crates = self.maybe_unused_extern_crates;
1394 let glob_map = self.glob_map;
1397 cstore: Box::new(self.crate_loader.into_cstore()),
1402 maybe_unused_trait_imports,
1403 maybe_unused_extern_crates,
1404 extern_prelude: self
1407 .map(|(ident, entry)| (ident.name, entry.introduced_by_item))
1412 pub fn clone_outputs(&self) -> ResolverOutputs {
1414 definitions: self.definitions.clone(),
1415 cstore: Box::new(self.cstore().clone()),
1416 visibilities: self.visibilities.clone(),
1417 extern_crate_map: self.extern_crate_map.clone(),
1418 export_map: self.export_map.clone(),
1419 glob_map: self.glob_map.clone(),
1420 maybe_unused_trait_imports: self.maybe_unused_trait_imports.clone(),
1421 maybe_unused_extern_crates: self.maybe_unused_extern_crates.clone(),
1422 extern_prelude: self
1425 .map(|(ident, entry)| (ident.name, entry.introduced_by_item))
1430 pub fn cstore(&self) -> &CStore {
1431 self.crate_loader.cstore()
1434 fn non_macro_attr(&self, mark_used: bool) -> Lrc<SyntaxExtension> {
1435 self.non_macro_attrs[mark_used as usize].clone()
1438 fn dummy_ext(&self, macro_kind: MacroKind) -> Lrc<SyntaxExtension> {
1440 MacroKind::Bang => self.dummy_ext_bang.clone(),
1441 MacroKind::Derive => self.dummy_ext_derive.clone(),
1442 MacroKind::Attr => self.non_macro_attr(true),
1446 /// Runs the function on each namespace.
1447 fn per_ns<F: FnMut(&mut Self, Namespace)>(&mut self, mut f: F) {
1453 fn is_builtin_macro(&mut self, res: Res) -> bool {
1454 self.get_macro(res).map_or(false, |ext| ext.builtin_name.is_some())
1457 fn macro_def(&self, mut ctxt: SyntaxContext) -> DefId {
1459 match ctxt.outer_expn().expn_data().macro_def_id {
1460 Some(def_id) => return def_id,
1461 None => ctxt.remove_mark(),
1466 /// Entry point to crate resolution.
1467 pub fn resolve_crate(&mut self, krate: &Crate) {
1468 let _prof_timer = self.session.prof.generic_activity("resolve_crate");
1470 ImportResolver { r: self }.finalize_imports();
1471 self.finalize_macro_resolutions();
1473 self.late_resolve_crate(krate);
1475 self.check_unused(krate);
1476 self.report_errors(krate);
1477 self.crate_loader.postprocess(krate);
1480 pub fn traits_in_scope(
1482 current_trait: Option<Module<'a>>,
1483 parent_scope: &ParentScope<'a>,
1484 ctxt: SyntaxContext,
1485 assoc_item: Option<(Symbol, Namespace)>,
1486 ) -> Vec<TraitCandidate> {
1487 let mut found_traits = Vec::new();
1489 if let Some(module) = current_trait {
1490 if self.trait_may_have_item(Some(module), assoc_item) {
1491 let def_id = module.def_id().unwrap();
1492 found_traits.push(TraitCandidate { def_id, import_ids: smallvec![] });
1496 self.visit_scopes(ScopeSet::All(TypeNS, false), parent_scope, ctxt, |this, scope, _, _| {
1498 Scope::Module(module) => {
1499 this.traits_in_module(module, assoc_item, &mut found_traits);
1501 Scope::StdLibPrelude => {
1502 if let Some(module) = this.prelude {
1503 this.traits_in_module(module, assoc_item, &mut found_traits);
1506 Scope::ExternPrelude | Scope::ToolPrelude | Scope::BuiltinTypes => {}
1507 _ => unreachable!(),
1515 fn traits_in_module(
1518 assoc_item: Option<(Symbol, Namespace)>,
1519 found_traits: &mut Vec<TraitCandidate>,
1521 module.ensure_traits(self);
1522 let traits = module.traits.borrow();
1523 for (trait_name, trait_binding) in traits.as_ref().unwrap().iter() {
1524 if self.trait_may_have_item(trait_binding.module(), assoc_item) {
1525 let def_id = trait_binding.res().def_id();
1526 let import_ids = self.find_transitive_imports(&trait_binding.kind, *trait_name);
1527 found_traits.push(TraitCandidate { def_id, import_ids });
1532 // List of traits in scope is pruned on best effort basis. We reject traits not having an
1533 // associated item with the given name and namespace (if specified). This is a conservative
1534 // optimization, proper hygienic type-based resolution of associated items is done in typeck.
1535 // We don't reject trait aliases (`trait_module == None`) because we don't have access to their
1536 // associated items.
1537 fn trait_may_have_item(
1539 trait_module: Option<Module<'a>>,
1540 assoc_item: Option<(Symbol, Namespace)>,
1542 match (trait_module, assoc_item) {
1543 (Some(trait_module), Some((name, ns))) => {
1544 self.resolutions(trait_module).borrow().iter().any(|resolution| {
1545 let (&BindingKey { ident: assoc_ident, ns: assoc_ns, .. }, _) = resolution;
1546 assoc_ns == ns && assoc_ident.name == name
1553 fn find_transitive_imports(
1555 mut kind: &NameBindingKind<'_>,
1557 ) -> SmallVec<[LocalDefId; 1]> {
1558 let mut import_ids = smallvec![];
1559 while let NameBindingKind::Import { import, binding, .. } = kind {
1560 let id = self.local_def_id(import.id);
1561 self.maybe_unused_trait_imports.insert(id);
1562 self.add_to_glob_map(&import, trait_name);
1563 import_ids.push(id);
1564 kind = &binding.kind;
1573 nearest_parent_mod: DefId,
1577 let module = ModuleData::new(Some(parent), kind, nearest_parent_mod, expn_id, span);
1578 self.arenas.alloc_module(module)
1581 fn new_key(&mut self, ident: Ident, ns: Namespace) -> BindingKey {
1582 let ident = ident.normalize_to_macros_2_0();
1583 let disambiguator = if ident.name == kw::Underscore {
1584 self.underscore_disambiguator += 1;
1585 self.underscore_disambiguator
1589 BindingKey { ident, ns, disambiguator }
1592 fn resolutions(&mut self, module: Module<'a>) -> &'a Resolutions<'a> {
1593 if module.populate_on_access.get() {
1594 module.populate_on_access.set(false);
1595 self.build_reduced_graph_external(module);
1597 &module.lazy_resolutions
1604 ) -> &'a RefCell<NameResolution<'a>> {
1606 .resolutions(module)
1609 .or_insert_with(|| self.arenas.alloc_name_resolution())
1616 used_binding: &'a NameBinding<'a>,
1617 is_lexical_scope: bool,
1619 if let Some((b2, kind)) = used_binding.ambiguity {
1620 self.ambiguity_errors.push(AmbiguityError {
1625 misc1: AmbiguityErrorMisc::None,
1626 misc2: AmbiguityErrorMisc::None,
1629 if let NameBindingKind::Import { import, binding, ref used } = used_binding.kind {
1630 // Avoid marking `extern crate` items that refer to a name from extern prelude,
1631 // but not introduce it, as used if they are accessed from lexical scope.
1632 if is_lexical_scope {
1633 if let Some(entry) = self.extern_prelude.get(&ident.normalize_to_macros_2_0()) {
1634 if let Some(crate_item) = entry.extern_crate_item {
1635 if ptr::eq(used_binding, crate_item) && !entry.introduced_by_item {
1642 import.used.set(true);
1643 self.used_imports.insert((import.id, ns));
1644 self.add_to_glob_map(&import, ident);
1645 self.record_use(ident, ns, binding, false);
1650 fn add_to_glob_map(&mut self, import: &Import<'_>, ident: Ident) {
1651 if import.is_glob() {
1652 let def_id = self.local_def_id(import.id);
1653 self.glob_map.entry(def_id).or_default().insert(ident.name);
1657 /// A generic scope visitor.
1658 /// Visits scopes in order to resolve some identifier in them or perform other actions.
1659 /// If the callback returns `Some` result, we stop visiting scopes and return it.
1662 scope_set: ScopeSet,
1663 parent_scope: &ParentScope<'a>,
1664 ctxt: SyntaxContext,
1665 mut visitor: impl FnMut(
1668 /*use_prelude*/ bool,
1672 // General principles:
1673 // 1. Not controlled (user-defined) names should have higher priority than controlled names
1674 // built into the language or standard library. This way we can add new names into the
1675 // language or standard library without breaking user code.
1676 // 2. "Closed set" below means new names cannot appear after the current resolution attempt.
1677 // Places to search (in order of decreasing priority):
1679 // 1. FIXME: Ribs (type parameters), there's no necessary infrastructure yet
1680 // (open set, not controlled).
1681 // 2. Names in modules (both normal `mod`ules and blocks), loop through hygienic parents
1682 // (open, not controlled).
1683 // 3. Extern prelude (open, the open part is from macro expansions, not controlled).
1684 // 4. Tool modules (closed, controlled right now, but not in the future).
1685 // 5. Standard library prelude (de-facto closed, controlled).
1686 // 6. Language prelude (closed, controlled).
1688 // 1. FIXME: Ribs (local variables), there's no necessary infrastructure yet
1689 // (open set, not controlled).
1690 // 2. Names in modules (both normal `mod`ules and blocks), loop through hygienic parents
1691 // (open, not controlled).
1692 // 3. Standard library prelude (de-facto closed, controlled).
1694 // 1-3. Derive helpers (open, not controlled). All ambiguities with other names
1695 // are currently reported as errors. They should be higher in priority than preludes
1696 // and probably even names in modules according to the "general principles" above. They
1697 // also should be subject to restricted shadowing because are effectively produced by
1698 // derives (you need to resolve the derive first to add helpers into scope), but they
1699 // should be available before the derive is expanded for compatibility.
1700 // It's mess in general, so we are being conservative for now.
1701 // 1-3. `macro_rules` (open, not controlled), loop through `macro_rules` scopes. Have higher
1702 // priority than prelude macros, but create ambiguities with macros in modules.
1703 // 1-3. Names in modules (both normal `mod`ules and blocks), loop through hygienic parents
1704 // (open, not controlled). Have higher priority than prelude macros, but create
1705 // ambiguities with `macro_rules`.
1706 // 4. `macro_use` prelude (open, the open part is from macro expansions, not controlled).
1707 // 4a. User-defined prelude from macro-use
1708 // (open, the open part is from macro expansions, not controlled).
1709 // 4b. "Standard library prelude" part implemented through `macro-use` (closed, controlled).
1710 // 4c. Standard library prelude (de-facto closed, controlled).
1711 // 6. Language prelude: builtin attributes (closed, controlled).
1713 let rust_2015 = ctxt.edition() == Edition::Edition2015;
1714 let (ns, macro_kind, is_absolute_path) = match scope_set {
1715 ScopeSet::All(ns, _) => (ns, None, false),
1716 ScopeSet::AbsolutePath(ns) => (ns, None, true),
1717 ScopeSet::Macro(macro_kind) => (MacroNS, Some(macro_kind), false),
1719 // Jump out of trait or enum modules, they do not act as scopes.
1720 let module = parent_scope.module.nearest_item_scope();
1721 let mut scope = match ns {
1722 _ if is_absolute_path => Scope::CrateRoot,
1723 TypeNS | ValueNS => Scope::Module(module),
1724 MacroNS => Scope::DeriveHelpers(parent_scope.expansion),
1726 let mut ctxt = ctxt.normalize_to_macros_2_0();
1727 let mut use_prelude = !module.no_implicit_prelude;
1730 let visit = match scope {
1731 // Derive helpers are not in scope when resolving derives in the same container.
1732 Scope::DeriveHelpers(expn_id) => {
1733 !(expn_id == parent_scope.expansion && macro_kind == Some(MacroKind::Derive))
1735 Scope::DeriveHelpersCompat => true,
1736 Scope::MacroRules(macro_rules_scope) => {
1737 // Use "path compression" on `macro_rules` scope chains. This is an optimization
1738 // used to avoid long scope chains, see the comments on `MacroRulesScopeRef`.
1739 // As another consequence of this optimization visitors never observe invocation
1740 // scopes for macros that were already expanded.
1741 while let MacroRulesScope::Invocation(invoc_id) = macro_rules_scope.get() {
1742 if let Some(next_scope) = self.output_macro_rules_scopes.get(&invoc_id) {
1743 macro_rules_scope.set(next_scope.get());
1750 Scope::CrateRoot => true,
1751 Scope::Module(..) => true,
1752 Scope::RegisteredAttrs => use_prelude,
1753 Scope::MacroUsePrelude => use_prelude || rust_2015,
1754 Scope::BuiltinAttrs => true,
1755 Scope::ExternPrelude => use_prelude || is_absolute_path,
1756 Scope::ToolPrelude => use_prelude,
1757 Scope::StdLibPrelude => use_prelude || ns == MacroNS,
1758 Scope::BuiltinTypes => true,
1762 if let break_result @ Some(..) = visitor(self, scope, use_prelude, ctxt) {
1763 return break_result;
1767 scope = match scope {
1768 Scope::DeriveHelpers(expn_id) if expn_id != ExpnId::root() => {
1769 // Derive helpers are not visible to code generated by bang or derive macros.
1770 let expn_data = expn_id.expn_data();
1771 match expn_data.kind {
1773 | ExpnKind::Macro(MacroKind::Bang | MacroKind::Derive, _) => {
1774 Scope::DeriveHelpersCompat
1776 _ => Scope::DeriveHelpers(expn_data.parent),
1779 Scope::DeriveHelpers(..) => Scope::DeriveHelpersCompat,
1780 Scope::DeriveHelpersCompat => Scope::MacroRules(parent_scope.macro_rules),
1781 Scope::MacroRules(macro_rules_scope) => match macro_rules_scope.get() {
1782 MacroRulesScope::Binding(binding) => {
1783 Scope::MacroRules(binding.parent_macro_rules_scope)
1785 MacroRulesScope::Invocation(invoc_id) => {
1786 Scope::MacroRules(self.invocation_parent_scopes[&invoc_id].macro_rules)
1788 MacroRulesScope::Empty => Scope::Module(module),
1790 Scope::CrateRoot => match ns {
1792 ctxt.adjust(ExpnId::root());
1793 Scope::ExternPrelude
1795 ValueNS | MacroNS => break,
1797 Scope::Module(module) => {
1798 use_prelude = !module.no_implicit_prelude;
1799 match self.hygienic_lexical_parent(module, &mut ctxt) {
1800 Some(parent_module) => Scope::Module(parent_module),
1802 ctxt.adjust(ExpnId::root());
1804 TypeNS => Scope::ExternPrelude,
1805 ValueNS => Scope::StdLibPrelude,
1806 MacroNS => Scope::RegisteredAttrs,
1811 Scope::RegisteredAttrs => Scope::MacroUsePrelude,
1812 Scope::MacroUsePrelude => Scope::StdLibPrelude,
1813 Scope::BuiltinAttrs => break, // nowhere else to search
1814 Scope::ExternPrelude if is_absolute_path => break,
1815 Scope::ExternPrelude => Scope::ToolPrelude,
1816 Scope::ToolPrelude => Scope::StdLibPrelude,
1817 Scope::StdLibPrelude => match ns {
1818 TypeNS => Scope::BuiltinTypes,
1819 ValueNS => break, // nowhere else to search
1820 MacroNS => Scope::BuiltinAttrs,
1822 Scope::BuiltinTypes => break, // nowhere else to search
1829 /// This resolves the identifier `ident` in the namespace `ns` in the current lexical scope.
1830 /// More specifically, we proceed up the hierarchy of scopes and return the binding for
1831 /// `ident` in the first scope that defines it (or None if no scopes define it).
1833 /// A block's items are above its local variables in the scope hierarchy, regardless of where
1834 /// the items are defined in the block. For example,
1837 /// g(); // Since there are no local variables in scope yet, this resolves to the item.
1840 /// g(); // This resolves to the local variable `g` since it shadows the item.
1844 /// Invariant: This must only be called during main resolution, not during
1845 /// import resolution.
1846 fn resolve_ident_in_lexical_scope(
1850 parent_scope: &ParentScope<'a>,
1851 record_used_id: Option<NodeId>,
1854 ) -> Option<LexicalScopeBinding<'a>> {
1855 assert!(ns == TypeNS || ns == ValueNS);
1856 if ident.name == kw::Empty {
1857 return Some(LexicalScopeBinding::Res(Res::Err));
1859 let (general_span, normalized_span) = if ident.name == kw::SelfUpper {
1860 // FIXME(jseyfried) improve `Self` hygiene
1861 let empty_span = ident.span.with_ctxt(SyntaxContext::root());
1862 (empty_span, empty_span)
1863 } else if ns == TypeNS {
1864 let normalized_span = ident.span.normalize_to_macros_2_0();
1865 (normalized_span, normalized_span)
1867 (ident.span.normalize_to_macro_rules(), ident.span.normalize_to_macros_2_0())
1869 ident.span = general_span;
1870 let normalized_ident = Ident { span: normalized_span, ..ident };
1872 // Walk backwards up the ribs in scope.
1873 let record_used = record_used_id.is_some();
1874 let mut module = self.graph_root;
1875 for i in (0..ribs.len()).rev() {
1876 debug!("walk rib\n{:?}", ribs[i].bindings);
1877 // Use the rib kind to determine whether we are resolving parameters
1878 // (macro 2.0 hygiene) or local variables (`macro_rules` hygiene).
1879 let rib_ident = if ribs[i].kind.contains_params() { normalized_ident } else { ident };
1880 if let Some((original_rib_ident_def, res)) = ribs[i].bindings.get_key_value(&rib_ident)
1882 // The ident resolves to a type parameter or local variable.
1883 return Some(LexicalScopeBinding::Res(self.validate_res_from_ribs(
1889 *original_rib_ident_def,
1894 module = match ribs[i].kind {
1895 ModuleRibKind(module) => module,
1896 MacroDefinition(def) if def == self.macro_def(ident.span.ctxt()) => {
1897 // If an invocation of this macro created `ident`, give up on `ident`
1898 // and switch to `ident`'s source from the macro definition.
1899 ident.span.remove_mark();
1905 let item = self.resolve_ident_in_module_unadjusted(
1906 ModuleOrUniformRoot::Module(module),
1913 if let Ok(binding) = item {
1914 // The ident resolves to an item.
1915 return Some(LexicalScopeBinding::Item(binding));
1919 ModuleKind::Block(..) => {} // We can see through blocks
1924 ident = normalized_ident;
1925 let mut poisoned = None;
1927 let mut span_data = ident.span.data();
1928 let opt_module = if let Some(node_id) = record_used_id {
1929 self.hygienic_lexical_parent_with_compatibility_fallback(
1931 &mut span_data.ctxt,
1936 self.hygienic_lexical_parent(module, &mut span_data.ctxt)
1938 ident.span = span_data.span();
1939 module = unwrap_or!(opt_module, break);
1940 let adjusted_parent_scope = &ParentScope { module, ..*parent_scope };
1941 let result = self.resolve_ident_in_module_unadjusted(
1942 ModuleOrUniformRoot::Module(module),
1945 adjusted_parent_scope,
1952 if let Some(node_id) = poisoned {
1953 self.lint_buffer.buffer_lint_with_diagnostic(
1954 lint::builtin::PROC_MACRO_DERIVE_RESOLUTION_FALLBACK,
1957 &format!("cannot find {} `{}` in this scope", ns.descr(), ident),
1958 BuiltinLintDiagnostics::ProcMacroDeriveResolutionFallback(ident.span),
1961 return Some(LexicalScopeBinding::Item(binding));
1963 Err(Determined) => continue,
1964 Err(Undetermined) => {
1965 span_bug!(ident.span, "undetermined resolution during main resolution pass")
1970 if !module.no_implicit_prelude {
1971 ident.span.adjust(ExpnId::root());
1973 if let Some(binding) = self.extern_prelude_get(ident, !record_used) {
1974 return Some(LexicalScopeBinding::Item(binding));
1976 if let Some(ident) = self.registered_tools.get(&ident) {
1978 (Res::ToolMod, ty::Visibility::Public, ident.span, ExpnId::root())
1979 .to_name_binding(self.arenas);
1980 return Some(LexicalScopeBinding::Item(binding));
1983 if let Some(prelude) = self.prelude {
1984 if let Ok(binding) = self.resolve_ident_in_module_unadjusted(
1985 ModuleOrUniformRoot::Module(prelude),
1992 return Some(LexicalScopeBinding::Item(binding));
1998 if let Some(prim_ty) = self.primitive_type_table.primitive_types.get(&ident.name) {
2000 (Res::PrimTy(*prim_ty), ty::Visibility::Public, DUMMY_SP, ExpnId::root())
2001 .to_name_binding(self.arenas);
2002 return Some(LexicalScopeBinding::Item(binding));
2009 fn hygienic_lexical_parent(
2012 ctxt: &mut SyntaxContext,
2013 ) -> Option<Module<'a>> {
2014 if !module.expansion.outer_expn_is_descendant_of(*ctxt) {
2015 return Some(self.macro_def_scope(ctxt.remove_mark()));
2018 if let ModuleKind::Block(..) = module.kind {
2019 return Some(module.parent.unwrap().nearest_item_scope());
2025 fn hygienic_lexical_parent_with_compatibility_fallback(
2028 ctxt: &mut SyntaxContext,
2030 poisoned: &mut Option<NodeId>,
2031 ) -> Option<Module<'a>> {
2032 if let module @ Some(..) = self.hygienic_lexical_parent(module, ctxt) {
2036 // We need to support the next case under a deprecation warning
2039 // ---- begin: this comes from a proc macro derive
2040 // mod implementation_details {
2041 // // Note that `MyStruct` is not in scope here.
2042 // impl SomeTrait for MyStruct { ... }
2046 // So we have to fall back to the module's parent during lexical resolution in this case.
2047 if let Some(parent) = module.parent {
2048 // Inner module is inside the macro, parent module is outside of the macro.
2049 if module.expansion != parent.expansion
2050 && module.expansion.is_descendant_of(parent.expansion)
2052 // The macro is a proc macro derive
2053 if let Some(def_id) = module.expansion.expn_data().macro_def_id {
2054 let ext = self.get_macro_by_def_id(def_id);
2055 if ext.builtin_name.is_none()
2056 && ext.macro_kind() == MacroKind::Derive
2057 && parent.expansion.outer_expn_is_descendant_of(*ctxt)
2059 *poisoned = Some(node_id);
2060 return module.parent;
2069 fn resolve_ident_in_module(
2071 module: ModuleOrUniformRoot<'a>,
2074 parent_scope: &ParentScope<'a>,
2077 ) -> Result<&'a NameBinding<'a>, Determinacy> {
2078 self.resolve_ident_in_module_ext(module, ident, ns, parent_scope, record_used, path_span)
2079 .map_err(|(determinacy, _)| determinacy)
2082 fn resolve_ident_in_module_ext(
2084 module: ModuleOrUniformRoot<'a>,
2087 parent_scope: &ParentScope<'a>,
2090 ) -> Result<&'a NameBinding<'a>, (Determinacy, Weak)> {
2091 let tmp_parent_scope;
2092 let mut adjusted_parent_scope = parent_scope;
2094 ModuleOrUniformRoot::Module(m) => {
2095 if let Some(def) = ident.span.normalize_to_macros_2_0_and_adjust(m.expansion) {
2097 ParentScope { module: self.macro_def_scope(def), ..*parent_scope };
2098 adjusted_parent_scope = &tmp_parent_scope;
2101 ModuleOrUniformRoot::ExternPrelude => {
2102 ident.span.normalize_to_macros_2_0_and_adjust(ExpnId::root());
2104 ModuleOrUniformRoot::CrateRootAndExternPrelude | ModuleOrUniformRoot::CurrentScope => {
2108 self.resolve_ident_in_module_unadjusted_ext(
2112 adjusted_parent_scope,
2119 fn resolve_crate_root(&mut self, ident: Ident) -> Module<'a> {
2120 debug!("resolve_crate_root({:?})", ident);
2121 let mut ctxt = ident.span.ctxt();
2122 let mark = if ident.name == kw::DollarCrate {
2123 // When resolving `$crate` from a `macro_rules!` invoked in a `macro`,
2124 // we don't want to pretend that the `macro_rules!` definition is in the `macro`
2125 // as described in `SyntaxContext::apply_mark`, so we ignore prepended opaque marks.
2126 // FIXME: This is only a guess and it doesn't work correctly for `macro_rules!`
2127 // definitions actually produced by `macro` and `macro` definitions produced by
2128 // `macro_rules!`, but at least such configurations are not stable yet.
2129 ctxt = ctxt.normalize_to_macro_rules();
2131 "resolve_crate_root: marks={:?}",
2132 ctxt.marks().into_iter().map(|(i, t)| (i.expn_data(), t)).collect::<Vec<_>>()
2134 let mut iter = ctxt.marks().into_iter().rev().peekable();
2135 let mut result = None;
2136 // Find the last opaque mark from the end if it exists.
2137 while let Some(&(mark, transparency)) = iter.peek() {
2138 if transparency == Transparency::Opaque {
2139 result = Some(mark);
2146 "resolve_crate_root: found opaque mark {:?} {:?}",
2148 result.map(|r| r.expn_data())
2150 // Then find the last semi-transparent mark from the end if it exists.
2151 for (mark, transparency) in iter {
2152 if transparency == Transparency::SemiTransparent {
2153 result = Some(mark);
2159 "resolve_crate_root: found semi-transparent mark {:?} {:?}",
2161 result.map(|r| r.expn_data())
2165 debug!("resolve_crate_root: not DollarCrate");
2166 ctxt = ctxt.normalize_to_macros_2_0();
2167 ctxt.adjust(ExpnId::root())
2169 let module = match mark {
2170 Some(def) => self.macro_def_scope(def),
2173 "resolve_crate_root({:?}): found no mark (ident.span = {:?})",
2176 return self.graph_root;
2179 let module = self.get_module(DefId { index: CRATE_DEF_INDEX, ..module.nearest_parent_mod });
2181 "resolve_crate_root({:?}): got module {:?} ({:?}) (ident.span = {:?})",
2190 fn resolve_self(&mut self, ctxt: &mut SyntaxContext, module: Module<'a>) -> Module<'a> {
2191 let mut module = self.get_module(module.nearest_parent_mod);
2192 while module.span.ctxt().normalize_to_macros_2_0() != *ctxt {
2193 let parent = module.parent.unwrap_or_else(|| self.macro_def_scope(ctxt.remove_mark()));
2194 module = self.get_module(parent.nearest_parent_mod);
2202 opt_ns: Option<Namespace>, // `None` indicates a module path in import
2203 parent_scope: &ParentScope<'a>,
2206 crate_lint: CrateLint,
2207 ) -> PathResult<'a> {
2208 self.resolve_path_with_ribs(
2219 fn resolve_path_with_ribs(
2222 opt_ns: Option<Namespace>, // `None` indicates a module path in import
2223 parent_scope: &ParentScope<'a>,
2226 crate_lint: CrateLint,
2227 ribs: Option<&PerNS<Vec<Rib<'a>>>>,
2228 ) -> PathResult<'a> {
2229 let mut module = None;
2230 let mut allow_super = true;
2231 let mut second_binding = None;
2234 "resolve_path(path={:?}, opt_ns={:?}, record_used={:?}, \
2235 path_span={:?}, crate_lint={:?})",
2236 path, opt_ns, record_used, path_span, crate_lint,
2239 for (i, &Segment { ident, id, has_generic_args: _ }) in path.iter().enumerate() {
2240 debug!("resolve_path ident {} {:?} {:?}", i, ident, id);
2241 let record_segment_res = |this: &mut Self, res| {
2243 if let Some(id) = id {
2244 if !this.partial_res_map.contains_key(&id) {
2245 assert!(id != ast::DUMMY_NODE_ID, "Trying to resolve dummy id");
2246 this.record_partial_res(id, PartialRes::new(res));
2252 let is_last = i == path.len() - 1;
2253 let ns = if is_last { opt_ns.unwrap_or(TypeNS) } else { TypeNS };
2254 let name = ident.name;
2256 allow_super &= ns == TypeNS && (name == kw::SelfLower || name == kw::Super);
2259 if allow_super && name == kw::Super {
2260 let mut ctxt = ident.span.ctxt().normalize_to_macros_2_0();
2261 let self_module = match i {
2262 0 => Some(self.resolve_self(&mut ctxt, parent_scope.module)),
2264 Some(ModuleOrUniformRoot::Module(module)) => Some(module),
2268 if let Some(self_module) = self_module {
2269 if let Some(parent) = self_module.parent {
2270 module = Some(ModuleOrUniformRoot::Module(
2271 self.resolve_self(&mut ctxt, parent),
2276 let msg = "there are too many leading `super` keywords".to_string();
2277 return PathResult::Failed {
2281 is_error_from_last_segment: false,
2285 if name == kw::SelfLower {
2286 let mut ctxt = ident.span.ctxt().normalize_to_macros_2_0();
2287 module = Some(ModuleOrUniformRoot::Module(
2288 self.resolve_self(&mut ctxt, parent_scope.module),
2292 if name == kw::PathRoot && ident.span.rust_2018() {
2293 module = Some(ModuleOrUniformRoot::ExternPrelude);
2296 if name == kw::PathRoot && ident.span.rust_2015() && self.session.rust_2018() {
2297 // `::a::b` from 2015 macro on 2018 global edition
2298 module = Some(ModuleOrUniformRoot::CrateRootAndExternPrelude);
2301 if name == kw::PathRoot || name == kw::Crate || name == kw::DollarCrate {
2302 // `::a::b`, `crate::a::b` or `$crate::a::b`
2303 module = Some(ModuleOrUniformRoot::Module(self.resolve_crate_root(ident)));
2309 // Report special messages for path segment keywords in wrong positions.
2310 if ident.is_path_segment_keyword() && i != 0 {
2311 let name_str = if name == kw::PathRoot {
2312 "crate root".to_string()
2314 format!("`{}`", name)
2316 let label = if i == 1 && path[0].ident.name == kw::PathRoot {
2317 format!("global paths cannot start with {}", name_str)
2319 format!("{} in paths can only be used in start position", name_str)
2321 return PathResult::Failed {
2325 is_error_from_last_segment: false,
2329 enum FindBindingResult<'a> {
2330 Binding(Result<&'a NameBinding<'a>, Determinacy>),
2331 PathResult(PathResult<'a>),
2333 let find_binding_in_ns = |this: &mut Self, ns| {
2334 let binding = if let Some(module) = module {
2335 this.resolve_ident_in_module(
2343 } else if ribs.is_none() || opt_ns.is_none() || opt_ns == Some(MacroNS) {
2344 let scopes = ScopeSet::All(ns, opt_ns.is_none());
2345 this.early_resolve_ident_in_lexical_scope(
2354 let record_used_id = if record_used {
2355 crate_lint.node_id().or(Some(CRATE_NODE_ID))
2359 match this.resolve_ident_in_lexical_scope(
2367 // we found a locally-imported or available item/module
2368 Some(LexicalScopeBinding::Item(binding)) => Ok(binding),
2369 // we found a local variable or type param
2370 Some(LexicalScopeBinding::Res(res))
2371 if opt_ns == Some(TypeNS) || opt_ns == Some(ValueNS) =>
2373 record_segment_res(this, res);
2374 return FindBindingResult::PathResult(PathResult::NonModule(
2375 PartialRes::with_unresolved_segments(res, path.len() - 1),
2378 _ => Err(Determinacy::determined(record_used)),
2381 FindBindingResult::Binding(binding)
2383 let binding = match find_binding_in_ns(self, ns) {
2384 FindBindingResult::PathResult(x) => return x,
2385 FindBindingResult::Binding(binding) => binding,
2390 second_binding = Some(binding);
2392 let res = binding.res();
2393 let maybe_assoc = opt_ns != Some(MacroNS) && PathSource::Type.is_expected(res);
2394 if let Some(next_module) = binding.module() {
2395 module = Some(ModuleOrUniformRoot::Module(next_module));
2396 record_segment_res(self, res);
2397 } else if res == Res::ToolMod && i + 1 != path.len() {
2398 if binding.is_import() {
2402 "cannot use a tool module through an import",
2404 .span_note(binding.span, "the tool module imported here")
2407 let res = Res::NonMacroAttr(NonMacroAttrKind::Tool);
2408 return PathResult::NonModule(PartialRes::new(res));
2409 } else if res == Res::Err {
2410 return PathResult::NonModule(PartialRes::new(Res::Err));
2411 } else if opt_ns.is_some() && (is_last || maybe_assoc) {
2412 self.lint_if_path_starts_with_module(
2418 return PathResult::NonModule(PartialRes::with_unresolved_segments(
2423 let label = format!(
2424 "`{}` is {} {}, not a module",
2430 return PathResult::Failed {
2434 is_error_from_last_segment: is_last,
2438 Err(Undetermined) => return PathResult::Indeterminate,
2439 Err(Determined) => {
2440 if let Some(ModuleOrUniformRoot::Module(module)) = module {
2441 if opt_ns.is_some() && !module.is_normal() {
2442 return PathResult::NonModule(PartialRes::with_unresolved_segments(
2443 module.res().unwrap(),
2448 let module_res = match module {
2449 Some(ModuleOrUniformRoot::Module(module)) => module.res(),
2452 let (label, suggestion) = if module_res == self.graph_root.res() {
2453 let is_mod = |res| matches!(res, Res::Def(DefKind::Mod, _));
2454 // Don't look up import candidates if this is a speculative resolve
2455 let mut candidates = if record_used {
2456 self.lookup_import_candidates(ident, TypeNS, parent_scope, is_mod)
2460 candidates.sort_by_cached_key(|c| {
2461 (c.path.segments.len(), pprust::path_to_string(&c.path))
2463 if let Some(candidate) = candidates.get(0) {
2465 String::from("unresolved import"),
2467 vec![(ident.span, pprust::path_to_string(&candidate.path))],
2468 String::from("a similar path exists"),
2469 Applicability::MaybeIncorrect,
2473 (format!("maybe a missing crate `{}`?", ident), None)
2481 .map_or(false, |c| c.is_ascii_uppercase())
2483 (format!("use of undeclared type `{}`", ident), None)
2485 (format!("use of undeclared crate or module `{}`", ident), None)
2489 format!("could not find `{}` in `{}`", ident, path[i - 1].ident);
2490 if ns == TypeNS || ns == ValueNS {
2491 let ns_to_try = if ns == TypeNS { ValueNS } else { TypeNS };
2492 if let FindBindingResult::Binding(Ok(binding)) =
2493 find_binding_in_ns(self, ns_to_try)
2495 let mut found = |what| {
2497 "expected {}, found {} `{}` in `{}`",
2504 if binding.module().is_some() {
2507 match binding.res() {
2508 def::Res::<NodeId>::Def(kind, id) => found(kind.descr(id)),
2509 _ => found(ns_to_try.descr()),
2516 return PathResult::Failed {
2520 is_error_from_last_segment: is_last,
2526 self.lint_if_path_starts_with_module(crate_lint, path, path_span, second_binding);
2528 PathResult::Module(match module {
2529 Some(module) => module,
2530 None if path.is_empty() => ModuleOrUniformRoot::CurrentScope,
2531 _ => span_bug!(path_span, "resolve_path: non-empty path `{:?}` has no module", path),
2535 fn lint_if_path_starts_with_module(
2537 crate_lint: CrateLint,
2540 second_binding: Option<&NameBinding<'_>>,
2542 let (diag_id, diag_span) = match crate_lint {
2543 CrateLint::No => return,
2544 CrateLint::SimplePath(id) => (id, path_span),
2545 CrateLint::UsePath { root_id, root_span } => (root_id, root_span),
2546 CrateLint::QPathTrait { qpath_id, qpath_span } => (qpath_id, qpath_span),
2549 let first_name = match path.get(0) {
2550 // In the 2018 edition this lint is a hard error, so nothing to do
2551 Some(seg) if seg.ident.span.rust_2015() && self.session.rust_2015() => seg.ident.name,
2555 // We're only interested in `use` paths which should start with
2556 // `{{root}}` currently.
2557 if first_name != kw::PathRoot {
2562 // If this import looks like `crate::...` it's already good
2563 Some(Segment { ident, .. }) if ident.name == kw::Crate => return,
2564 // Otherwise go below to see if it's an extern crate
2566 // If the path has length one (and it's `PathRoot` most likely)
2567 // then we don't know whether we're gonna be importing a crate or an
2568 // item in our crate. Defer this lint to elsewhere
2572 // If the first element of our path was actually resolved to an
2573 // `ExternCrate` (also used for `crate::...`) then no need to issue a
2574 // warning, this looks all good!
2575 if let Some(binding) = second_binding {
2576 if let NameBindingKind::Import { import, .. } = binding.kind {
2577 // Careful: we still want to rewrite paths from renamed extern crates.
2578 if let ImportKind::ExternCrate { source: None, .. } = import.kind {
2584 let diag = BuiltinLintDiagnostics::AbsPathWithModule(diag_span);
2585 self.lint_buffer.buffer_lint_with_diagnostic(
2586 lint::builtin::ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE,
2589 "absolute paths must start with `self`, `super`, \
2590 `crate`, or an external crate name in the 2018 edition",
2595 // Validate a local resolution (from ribs).
2596 fn validate_res_from_ribs(
2603 original_rib_ident_def: Ident,
2604 all_ribs: &[Rib<'a>],
2606 const CG_BUG_STR: &str = "min_const_generics resolve check didn't stop compilation";
2607 debug!("validate_res_from_ribs({:?})", res);
2608 let ribs = &all_ribs[rib_index + 1..];
2610 // An invalid forward use of a type parameter from a previous default.
2611 if let ForwardTyParamBanRibKind = all_ribs[rib_index].kind {
2613 let res_error = if rib_ident.name == kw::SelfUpper {
2614 ResolutionError::SelfInTyParamDefault
2616 ResolutionError::ForwardDeclaredTyParam
2618 self.report_error(span, res_error);
2620 assert_eq!(res, Res::Err);
2626 use ResolutionError::*;
2627 let mut res_err = None;
2632 | ClosureOrAsyncRibKind
2634 | MacroDefinition(..)
2635 | ForwardTyParamBanRibKind => {
2636 // Nothing to do. Continue.
2638 ItemRibKind(_) | FnItemRibKind | AssocItemRibKind => {
2639 // This was an attempt to access an upvar inside a
2640 // named function item. This is not allowed, so we
2643 // We don't immediately trigger a resolve error, because
2644 // we want certain other resolution errors (namely those
2645 // emitted for `ConstantItemRibKind` below) to take
2647 res_err = Some(CannotCaptureDynamicEnvironmentInFnItem);
2650 ConstantItemRibKind(_, item) => {
2651 // Still doesn't deal with upvars
2653 let (span, resolution_error) =
2654 if let Some((ident, constant_item_kind)) = item {
2655 let kind_str = match constant_item_kind {
2656 ConstantItemKind::Const => "const",
2657 ConstantItemKind::Static => "static",
2661 AttemptToUseNonConstantValueInConstant(
2662 ident, "let", kind_str,
2668 AttemptToUseNonConstantValueInConstant(
2669 original_rib_ident_def,
2675 self.report_error(span, resolution_error);
2679 ConstParamTyRibKind => {
2681 self.report_error(span, ParamInTyOfConstParam(rib_ident.name));
2687 if let Some(res_err) = res_err {
2688 self.report_error(span, res_err);
2692 Res::Def(DefKind::TyParam, _) | Res::SelfTy(..) => {
2693 let mut in_ty_param_default = false;
2695 let has_generic_params = match rib.kind {
2697 | ClosureOrAsyncRibKind
2700 | MacroDefinition(..) => {
2701 // Nothing to do. Continue.
2705 // We only forbid constant items if we are inside of type defaults,
2706 // for example `struct Foo<T, U = [u8; std::mem::size_of::<T>()]>`
2707 ForwardTyParamBanRibKind => {
2708 in_ty_param_default = true;
2711 ConstantItemRibKind(trivial, _) => {
2712 let features = self.session.features_untracked();
2713 // HACK(min_const_generics): We currently only allow `N` or `{ N }`.
2715 || features.const_generics
2716 || features.lazy_normalization_consts)
2718 // HACK(min_const_generics): If we encounter `Self` in an anonymous constant
2719 // we can't easily tell if it's generic at this stage, so we instead remember
2720 // this and then enforce the self type to be concrete later on.
2721 if let Res::SelfTy(trait_def, Some((impl_def, _))) = res {
2722 res = Res::SelfTy(trait_def, Some((impl_def, true)));
2727 ResolutionError::ParamInNonTrivialAnonConst {
2728 name: rib_ident.name,
2734 self.session.delay_span_bug(span, CG_BUG_STR);
2739 if in_ty_param_default {
2743 ResolutionError::ParamInAnonConstInTyDefault(
2754 // This was an attempt to use a type parameter outside its scope.
2755 ItemRibKind(has_generic_params) => has_generic_params,
2756 FnItemRibKind => HasGenericParams::Yes,
2757 ConstParamTyRibKind => {
2761 ResolutionError::ParamInTyOfConstParam(rib_ident.name),
2771 ResolutionError::GenericParamsFromOuterFunction(
2780 Res::Def(DefKind::ConstParam, _) => {
2781 let mut ribs = ribs.iter().peekable();
2782 if let Some(Rib { kind: FnItemRibKind, .. }) = ribs.peek() {
2783 // When declaring const parameters inside function signatures, the first rib
2784 // is always a `FnItemRibKind`. In this case, we can skip it, to avoid it
2785 // (spuriously) conflicting with the const param.
2789 let mut in_ty_param_default = false;
2791 let has_generic_params = match rib.kind {
2793 | ClosureOrAsyncRibKind
2796 | MacroDefinition(..) => continue,
2798 // We only forbid constant items if we are inside of type defaults,
2799 // for example `struct Foo<T, U = [u8; std::mem::size_of::<T>()]>`
2800 ForwardTyParamBanRibKind => {
2801 in_ty_param_default = true;
2804 ConstantItemRibKind(trivial, _) => {
2805 let features = self.session.features_untracked();
2806 // HACK(min_const_generics): We currently only allow `N` or `{ N }`.
2808 || features.const_generics
2809 || features.lazy_normalization_consts)
2814 ResolutionError::ParamInNonTrivialAnonConst {
2815 name: rib_ident.name,
2821 self.session.delay_span_bug(span, CG_BUG_STR);
2825 if in_ty_param_default {
2829 ResolutionError::ParamInAnonConstInTyDefault(
2840 ItemRibKind(has_generic_params) => has_generic_params,
2841 FnItemRibKind => HasGenericParams::Yes,
2842 ConstParamTyRibKind => {
2846 ResolutionError::ParamInTyOfConstParam(rib_ident.name),
2853 // This was an attempt to use a const parameter outside its scope.
2857 ResolutionError::GenericParamsFromOuterFunction(
2871 fn record_partial_res(&mut self, node_id: NodeId, resolution: PartialRes) {
2872 debug!("(recording res) recording {:?} for {}", resolution, node_id);
2873 if let Some(prev_res) = self.partial_res_map.insert(node_id, resolution) {
2874 panic!("path resolved multiple times ({:?} before, {:?} now)", prev_res, resolution);
2878 fn is_accessible_from(&self, vis: ty::Visibility, module: Module<'a>) -> bool {
2879 vis.is_accessible_from(module.nearest_parent_mod, self)
2882 fn set_binding_parent_module(&mut self, binding: &'a NameBinding<'a>, module: Module<'a>) {
2883 if let Some(old_module) = self.binding_parent_modules.insert(PtrKey(binding), module) {
2884 if !ptr::eq(module, old_module) {
2885 span_bug!(binding.span, "parent module is reset for binding");
2890 fn disambiguate_macro_rules_vs_modularized(
2892 macro_rules: &'a NameBinding<'a>,
2893 modularized: &'a NameBinding<'a>,
2895 // Some non-controversial subset of ambiguities "modularized macro name" vs "macro_rules"
2896 // is disambiguated to mitigate regressions from macro modularization.
2897 // Scoping for `macro_rules` behaves like scoping for `let` at module level, in general.
2899 self.binding_parent_modules.get(&PtrKey(macro_rules)),
2900 self.binding_parent_modules.get(&PtrKey(modularized)),
2902 (Some(macro_rules), Some(modularized)) => {
2903 macro_rules.nearest_parent_mod == modularized.nearest_parent_mod
2904 && modularized.is_ancestor_of(macro_rules)
2910 fn report_errors(&mut self, krate: &Crate) {
2911 self.report_with_use_injections(krate);
2913 for &(span_use, span_def) in &self.macro_expanded_macro_export_errors {
2914 let msg = "macro-expanded `macro_export` macros from the current crate \
2915 cannot be referred to by absolute paths";
2916 self.lint_buffer.buffer_lint_with_diagnostic(
2917 lint::builtin::MACRO_EXPANDED_MACRO_EXPORTS_ACCESSED_BY_ABSOLUTE_PATHS,
2921 BuiltinLintDiagnostics::MacroExpandedMacroExportsAccessedByAbsolutePaths(span_def),
2925 for ambiguity_error in &self.ambiguity_errors {
2926 self.report_ambiguity_error(ambiguity_error);
2929 let mut reported_spans = FxHashSet::default();
2930 for error in &self.privacy_errors {
2931 if reported_spans.insert(error.dedup_span) {
2932 self.report_privacy_error(error);
2937 fn report_with_use_injections(&mut self, krate: &Crate) {
2938 for UseError { mut err, candidates, def_id, instead, suggestion } in
2939 self.use_injections.drain(..)
2941 let (span, found_use) = if let Some(def_id) = def_id.as_local() {
2942 UsePlacementFinder::check(krate, self.def_id_to_node_id[def_id])
2946 if !candidates.is_empty() {
2947 diagnostics::show_candidates(&mut err, span, &candidates, instead, found_use);
2948 } else if let Some((span, msg, sugg, appl)) = suggestion {
2949 err.span_suggestion(span, msg, sugg, appl);
2955 fn report_conflict<'b>(
2960 new_binding: &NameBinding<'b>,
2961 old_binding: &NameBinding<'b>,
2963 // Error on the second of two conflicting names
2964 if old_binding.span.lo() > new_binding.span.lo() {
2965 return self.report_conflict(parent, ident, ns, old_binding, new_binding);
2968 let container = match parent.kind {
2969 ModuleKind::Def(kind, _, _) => kind.descr(parent.def_id().unwrap()),
2970 ModuleKind::Block(..) => "block",
2973 let old_noun = match old_binding.is_import() {
2975 false => "definition",
2978 let new_participle = match new_binding.is_import() {
2984 (ident.name, self.session.source_map().guess_head_span(new_binding.span));
2986 if let Some(s) = self.name_already_seen.get(&name) {
2992 let old_kind = match (ns, old_binding.module()) {
2993 (ValueNS, _) => "value",
2994 (MacroNS, _) => "macro",
2995 (TypeNS, _) if old_binding.is_extern_crate() => "extern crate",
2996 (TypeNS, Some(module)) if module.is_normal() => "module",
2997 (TypeNS, Some(module)) if module.is_trait() => "trait",
2998 (TypeNS, _) => "type",
3001 let msg = format!("the name `{}` is defined multiple times", name);
3003 let mut err = match (old_binding.is_extern_crate(), new_binding.is_extern_crate()) {
3004 (true, true) => struct_span_err!(self.session, span, E0259, "{}", msg),
3005 (true, _) | (_, true) => match new_binding.is_import() && old_binding.is_import() {
3006 true => struct_span_err!(self.session, span, E0254, "{}", msg),
3007 false => struct_span_err!(self.session, span, E0260, "{}", msg),
3009 _ => match (old_binding.is_import(), new_binding.is_import()) {
3010 (false, false) => struct_span_err!(self.session, span, E0428, "{}", msg),
3011 (true, true) => struct_span_err!(self.session, span, E0252, "{}", msg),
3012 _ => struct_span_err!(self.session, span, E0255, "{}", msg),
3017 "`{}` must be defined only once in the {} namespace of this {}",
3023 err.span_label(span, format!("`{}` re{} here", name, new_participle));
3025 self.session.source_map().guess_head_span(old_binding.span),
3026 format!("previous {} of the {} `{}` here", old_noun, old_kind, name),
3029 // See https://github.com/rust-lang/rust/issues/32354
3030 use NameBindingKind::Import;
3031 let import = match (&new_binding.kind, &old_binding.kind) {
3032 // If there are two imports where one or both have attributes then prefer removing the
3033 // import without attributes.
3034 (Import { import: new, .. }, Import { import: old, .. })
3036 !new_binding.span.is_dummy()
3037 && !old_binding.span.is_dummy()
3038 && (new.has_attributes || old.has_attributes)
3041 if old.has_attributes {
3042 Some((new, new_binding.span, true))
3044 Some((old, old_binding.span, true))
3047 // Otherwise prioritize the new binding.
3048 (Import { import, .. }, other) if !new_binding.span.is_dummy() => {
3049 Some((import, new_binding.span, other.is_import()))
3051 (other, Import { import, .. }) if !old_binding.span.is_dummy() => {
3052 Some((import, old_binding.span, other.is_import()))
3057 // Check if the target of the use for both bindings is the same.
3058 let duplicate = new_binding.res().opt_def_id() == old_binding.res().opt_def_id();
3059 let has_dummy_span = new_binding.span.is_dummy() || old_binding.span.is_dummy();
3061 self.extern_prelude.get(&ident).map_or(true, |entry| entry.introduced_by_item);
3062 // Only suggest removing an import if both bindings are to the same def, if both spans
3063 // aren't dummy spans. Further, if both bindings are imports, then the ident must have
3064 // been introduced by a item.
3065 let should_remove_import = duplicate
3067 && ((new_binding.is_extern_crate() || old_binding.is_extern_crate()) || from_item);
3070 Some((import, span, true)) if should_remove_import && import.is_nested() => {
3071 self.add_suggestion_for_duplicate_nested_use(&mut err, import, span)
3073 Some((import, _, true)) if should_remove_import && !import.is_glob() => {
3074 // Simple case - remove the entire import. Due to the above match arm, this can
3075 // only be a single use so just remove it entirely.
3076 err.tool_only_span_suggestion(
3077 import.use_span_with_attributes,
3078 "remove unnecessary import",
3080 Applicability::MaybeIncorrect,
3083 Some((import, span, _)) => {
3084 self.add_suggestion_for_rename_of_use(&mut err, name, import, span)
3090 self.name_already_seen.insert(name, span);
3093 /// This function adds a suggestion to change the binding name of a new import that conflicts
3094 /// with an existing import.
3096 /// ```text,ignore (diagnostic)
3097 /// help: you can use `as` to change the binding name of the import
3099 /// LL | use foo::bar as other_bar;
3100 /// | ^^^^^^^^^^^^^^^^^^^^^
3102 fn add_suggestion_for_rename_of_use(
3104 err: &mut DiagnosticBuilder<'_>,
3106 import: &Import<'_>,
3109 let suggested_name = if name.as_str().chars().next().unwrap().is_uppercase() {
3110 format!("Other{}", name)
3112 format!("other_{}", name)
3115 let mut suggestion = None;
3117 ImportKind::Single { type_ns_only: true, .. } => {
3118 suggestion = Some(format!("self as {}", suggested_name))
3120 ImportKind::Single { source, .. } => {
3122 source.span.hi().0.checked_sub(binding_span.lo().0).map(|pos| pos as usize)
3124 if let Ok(snippet) = self.session.source_map().span_to_snippet(binding_span) {
3125 if pos <= snippet.len() {
3126 suggestion = Some(format!(
3130 if snippet.ends_with(';') { ";" } else { "" }
3136 ImportKind::ExternCrate { source, target, .. } => {
3137 suggestion = Some(format!(
3138 "extern crate {} as {};",
3139 source.unwrap_or(target.name),
3143 _ => unreachable!(),
3146 let rename_msg = "you can use `as` to change the binding name of the import";
3147 if let Some(suggestion) = suggestion {
3148 err.span_suggestion(
3152 Applicability::MaybeIncorrect,
3155 err.span_label(binding_span, rename_msg);
3159 /// This function adds a suggestion to remove a unnecessary binding from an import that is
3160 /// nested. In the following example, this function will be invoked to remove the `a` binding
3161 /// in the second use statement:
3163 /// ```ignore (diagnostic)
3164 /// use issue_52891::a;
3165 /// use issue_52891::{d, a, e};
3168 /// The following suggestion will be added:
3170 /// ```ignore (diagnostic)
3171 /// use issue_52891::{d, a, e};
3172 /// ^-- help: remove unnecessary import
3175 /// If the nested use contains only one import then the suggestion will remove the entire
3178 /// It is expected that the provided import is nested - this isn't checked by the
3179 /// function. If this invariant is not upheld, this function's behaviour will be unexpected
3180 /// as characters expected by span manipulations won't be present.
3181 fn add_suggestion_for_duplicate_nested_use(
3183 err: &mut DiagnosticBuilder<'_>,
3184 import: &Import<'_>,
3187 assert!(import.is_nested());
3188 let message = "remove unnecessary import";
3190 // Two examples will be used to illustrate the span manipulations we're doing:
3192 // - Given `use issue_52891::{d, a, e};` where `a` is a duplicate then `binding_span` is
3193 // `a` and `import.use_span` is `issue_52891::{d, a, e};`.
3194 // - Given `use issue_52891::{d, e, a};` where `a` is a duplicate then `binding_span` is
3195 // `a` and `import.use_span` is `issue_52891::{d, e, a};`.
3197 let (found_closing_brace, span) =
3198 find_span_of_binding_until_next_binding(self.session, binding_span, import.use_span);
3200 // If there was a closing brace then identify the span to remove any trailing commas from
3201 // previous imports.
3202 if found_closing_brace {
3203 if let Some(span) = extend_span_to_previous_binding(self.session, span) {
3204 err.tool_only_span_suggestion(
3208 Applicability::MaybeIncorrect,
3211 // Remove the entire line if we cannot extend the span back, this indicates a
3212 // `issue_52891::{self}` case.
3213 err.span_suggestion(
3214 import.use_span_with_attributes,
3217 Applicability::MaybeIncorrect,
3224 err.span_suggestion(span, message, String::new(), Applicability::MachineApplicable);
3227 fn extern_prelude_get(
3231 ) -> Option<&'a NameBinding<'a>> {
3232 if ident.is_path_segment_keyword() {
3233 // Make sure `self`, `super` etc produce an error when passed to here.
3236 self.extern_prelude.get(&ident.normalize_to_macros_2_0()).cloned().and_then(|entry| {
3237 if let Some(binding) = entry.extern_crate_item {
3238 if !speculative && entry.introduced_by_item {
3239 self.record_use(ident, TypeNS, binding, false);
3243 let crate_id = if !speculative {
3244 self.crate_loader.process_path_extern(ident.name, ident.span)
3246 self.crate_loader.maybe_process_path_extern(ident.name)?
3248 let crate_root = self.get_module(DefId { krate: crate_id, index: CRATE_DEF_INDEX });
3250 (crate_root, ty::Visibility::Public, DUMMY_SP, ExpnId::root())
3251 .to_name_binding(self.arenas),
3257 /// Rustdoc uses this to resolve things in a recoverable way. `ResolutionError<'a>`
3258 /// isn't something that can be returned because it can't be made to live that long,
3259 /// and also it's a private type. Fortunately rustdoc doesn't need to know the error,
3260 /// just that an error occurred.
3261 // FIXME(Manishearth): intra-doc links won't get warned of epoch changes.
3262 pub fn resolve_str_path_error(
3268 ) -> Result<(ast::Path, Res), ()> {
3269 let path = if path_str.starts_with("::") {
3272 segments: iter::once(Ident::with_dummy_span(kw::PathRoot))
3273 .chain(path_str.split("::").skip(1).map(Ident::from_str))
3274 .map(|i| self.new_ast_path_segment(i))
3283 .map(Ident::from_str)
3284 .map(|i| self.new_ast_path_segment(i))
3289 let module = self.get_module(module_id);
3290 let parent_scope = &ParentScope::module(module, self);
3291 let res = self.resolve_ast_path(&path, ns, parent_scope).map_err(|_| ())?;
3295 // Resolve a path passed from rustdoc or HIR lowering.
3296 fn resolve_ast_path(
3300 parent_scope: &ParentScope<'a>,
3301 ) -> Result<Res, (Span, ResolutionError<'a>)> {
3302 match self.resolve_path(
3303 &Segment::from_path(path),
3310 PathResult::Module(ModuleOrUniformRoot::Module(module)) => Ok(module.res().unwrap()),
3311 PathResult::NonModule(path_res) if path_res.unresolved_segments() == 0 => {
3312 Ok(path_res.base_res())
3314 PathResult::NonModule(..) => Err((
3316 ResolutionError::FailedToResolve {
3317 label: String::from("type-relative paths are not supported in this context"),
3321 PathResult::Module(..) | PathResult::Indeterminate => unreachable!(),
3322 PathResult::Failed { span, label, suggestion, .. } => {
3323 Err((span, ResolutionError::FailedToResolve { label, suggestion }))
3328 fn new_ast_path_segment(&mut self, ident: Ident) -> ast::PathSegment {
3329 let mut seg = ast::PathSegment::from_ident(ident);
3330 seg.id = self.next_node_id();
3335 pub fn graph_root(&self) -> Module<'a> {
3340 pub fn all_macros(&self) -> &FxHashMap<Symbol, Res> {
3344 /// Retrieves the span of the given `DefId` if `DefId` is in the local crate.
3346 pub fn opt_span(&self, def_id: DefId) -> Option<Span> {
3347 if let Some(def_id) = def_id.as_local() { Some(self.def_id_to_span[def_id]) } else { None }
3351 fn names_to_string(names: &[Symbol]) -> String {
3352 let mut result = String::new();
3353 for (i, name) in names.iter().filter(|name| **name != kw::PathRoot).enumerate() {
3355 result.push_str("::");
3357 if Ident::with_dummy_span(*name).is_raw_guess() {
3358 result.push_str("r#");
3360 result.push_str(&name.as_str());
3365 fn path_names_to_string(path: &Path) -> String {
3366 names_to_string(&path.segments.iter().map(|seg| seg.ident.name).collect::<Vec<_>>())
3369 /// A somewhat inefficient routine to obtain the name of a module.
3370 fn module_to_string(module: Module<'_>) -> Option<String> {
3371 let mut names = Vec::new();
3373 fn collect_mod(names: &mut Vec<Symbol>, module: Module<'_>) {
3374 if let ModuleKind::Def(.., name) = module.kind {
3375 if let Some(parent) = module.parent {
3377 collect_mod(names, parent);
3380 names.push(Symbol::intern("<opaque>"));
3381 collect_mod(names, module.parent.unwrap());
3384 collect_mod(&mut names, module);
3386 if names.is_empty() {
3390 Some(names_to_string(&names))
3393 #[derive(Copy, Clone, Debug)]
3395 /// Do not issue the lint.
3398 /// This lint applies to some arbitrary path; e.g., `impl ::foo::Bar`.
3399 /// In this case, we can take the span of that path.
3402 /// This lint comes from a `use` statement. In this case, what we
3403 /// care about really is the *root* `use` statement; e.g., if we
3404 /// have nested things like `use a::{b, c}`, we care about the
3406 UsePath { root_id: NodeId, root_span: Span },
3408 /// This is the "trait item" from a fully qualified path. For example,
3409 /// we might be resolving `X::Y::Z` from a path like `<T as X::Y>::Z`.
3410 /// The `path_span` is the span of the to the trait itself (`X::Y`).
3411 QPathTrait { qpath_id: NodeId, qpath_span: Span },
3415 fn node_id(&self) -> Option<NodeId> {
3417 CrateLint::No => None,
3418 CrateLint::SimplePath(id)
3419 | CrateLint::UsePath { root_id: id, .. }
3420 | CrateLint::QPathTrait { qpath_id: id, .. } => Some(id),
3425 pub fn provide(providers: &mut Providers) {
3426 late::lifetimes::provide(providers);