1 //! This crate is responsible for the part of name resolution that doesn't require type checker.
3 //! Module structure of the crate is built here.
4 //! Paths in macros, imports, expressions, types, patterns are resolved here.
5 //! Label names are resolved here as well.
7 //! Type-relative name resolution (methods, fields, associated items) happens in `librustc_typeck`.
8 //! Lifetime names are resolved in `librustc/middle/resolve_lifetime.rs`.
10 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/")]
12 #![feature(inner_deref)]
13 #![feature(crate_visibility_modifier)]
14 #![feature(label_break_value)]
18 #![recursion_limit="256"]
20 pub use rustc::hir::def::{Namespace, PerNS};
24 use rustc::hir::map::Definitions;
25 use rustc::hir::{self, PrimTy, Bool, Char, Float, Int, Uint, Str};
26 use rustc::middle::cstore::CrateStore;
27 use rustc::session::Session;
29 use rustc::hir::def::{self, DefKind, PartialRes, CtorKind, CtorOf, NonMacroAttrKind, ExportMap};
30 use rustc::hir::def::Namespace::*;
31 use rustc::hir::def_id::{CRATE_DEF_INDEX, LOCAL_CRATE, DefId};
32 use rustc::hir::{TraitMap, GlobMap};
34 use rustc::util::nodemap::{NodeMap, NodeSet, FxHashMap, FxHashSet, DefIdMap};
37 use rustc_metadata::creader::CrateLoader;
38 use rustc_metadata::cstore::CStore;
40 use syntax::ext::hygiene::{ExpnId, Transparency, SyntaxContext};
41 use syntax::ast::{self, Name, NodeId, Ident, FloatTy, IntTy, UintTy};
42 use syntax::ext::base::{SyntaxExtension, MacroKind, SpecialDerives};
43 use syntax::symbol::{kw, sym};
45 use syntax::visit::{self, Visitor};
47 use syntax::ast::{CRATE_NODE_ID, Crate};
48 use syntax::ast::{ItemKind, Path};
49 use syntax::{struct_span_err, unwrap_or};
51 use syntax_pos::{Span, DUMMY_SP};
52 use errors::{Applicability, DiagnosticBuilder};
56 use std::cell::{Cell, RefCell};
57 use std::{cmp, fmt, iter, ptr};
58 use std::collections::BTreeSet;
59 use rustc_data_structures::ptr_key::PtrKey;
60 use rustc_data_structures::sync::Lrc;
62 use diagnostics::{Suggestion, ImportSuggestion};
63 use diagnostics::{find_span_of_binding_until_next_binding, extend_span_to_previous_binding};
64 use late::{PathSource, Rib, RibKind::*};
65 use resolve_imports::{ImportDirective, ImportDirectiveSubclass, NameResolution, ImportResolver};
66 use macros::{LegacyBinding, LegacyScope};
68 type Res = def::Res<NodeId>;
75 mod build_reduced_graph;
78 const KNOWN_TOOLS: &[Name] = &[sym::clippy, sym::rustfmt];
85 #[derive(Copy, Clone, PartialEq, Debug)]
86 pub enum Determinacy {
92 fn determined(determined: bool) -> Determinacy {
93 if determined { Determinacy::Determined } else { Determinacy::Undetermined }
97 /// A specific scope in which a name can be looked up.
98 /// This enum is currently used only for early resolution (imports and macros),
99 /// but not for late resolution yet.
100 #[derive(Clone, Copy)]
103 MacroRules(LegacyScope<'a>),
115 /// Names from different contexts may want to visit different subsets of all specific scopes
116 /// with different restrictions when looking up the resolution.
117 /// This enum is currently used only for early resolution (imports and macros),
118 /// but not for late resolution yet.
120 /// All scopes with the given namespace.
121 All(Namespace, /*is_import*/ bool),
122 /// Crate root, then extern prelude (used for mixed 2015-2018 mode in macros).
123 AbsolutePath(Namespace),
124 /// All scopes with macro namespace and the given macro kind restriction.
128 /// Everything you need to know about a name's location to resolve it.
129 /// Serves as a starting point for the scope visitor.
130 /// This struct is currently used only for early resolution (imports and macros),
131 /// but not for late resolution yet.
132 #[derive(Clone, Copy, Debug)]
133 pub struct ParentScope<'a> {
136 legacy: LegacyScope<'a>,
137 derives: &'a [ast::Path],
140 impl<'a> ParentScope<'a> {
141 /// Creates a parent scope with the passed argument used as the module scope component,
142 /// and other scope components set to default empty values.
143 pub fn module(module: Module<'a>) -> ParentScope<'a> {
146 expansion: ExpnId::root(),
147 legacy: LegacyScope::Empty,
154 struct BindingError {
156 origin: BTreeSet<Span>,
157 target: BTreeSet<Span>,
161 impl PartialOrd for BindingError {
162 fn partial_cmp(&self, other: &BindingError) -> Option<cmp::Ordering> {
163 Some(self.cmp(other))
167 impl PartialEq for BindingError {
168 fn eq(&self, other: &BindingError) -> bool {
169 self.name == other.name
173 impl Ord for BindingError {
174 fn cmp(&self, other: &BindingError) -> cmp::Ordering {
175 self.name.cmp(&other.name)
179 enum ResolutionError<'a> {
180 /// Error E0401: can't use type or const parameters from outer function.
181 GenericParamsFromOuterFunction(Res),
182 /// Error E0403: the name is already used for a type or const parameter in this generic
184 NameAlreadyUsedInParameterList(Name, Span),
185 /// Error E0407: method is not a member of trait.
186 MethodNotMemberOfTrait(Name, &'a str),
187 /// Error E0437: type is not a member of trait.
188 TypeNotMemberOfTrait(Name, &'a str),
189 /// Error E0438: const is not a member of trait.
190 ConstNotMemberOfTrait(Name, &'a str),
191 /// Error E0408: variable `{}` is not bound in all patterns.
192 VariableNotBoundInPattern(&'a BindingError),
193 /// Error E0409: variable `{}` is bound in inconsistent ways within the same match arm.
194 VariableBoundWithDifferentMode(Name, Span),
195 /// Error E0415: identifier is bound more than once in this parameter list.
196 IdentifierBoundMoreThanOnceInParameterList(&'a str),
197 /// Error E0416: identifier is bound more than once in the same pattern.
198 IdentifierBoundMoreThanOnceInSamePattern(&'a str),
199 /// Error E0426: use of undeclared label.
200 UndeclaredLabel(&'a str, Option<Name>),
201 /// Error E0429: `self` imports are only allowed within a `{ }` list.
202 SelfImportsOnlyAllowedWithin,
203 /// Error E0430: `self` import can only appear once in the list.
204 SelfImportCanOnlyAppearOnceInTheList,
205 /// Error E0431: `self` import can only appear in an import list with a non-empty prefix.
206 SelfImportOnlyInImportListWithNonEmptyPrefix,
207 /// Error E0433: failed to resolve.
208 FailedToResolve { label: String, suggestion: Option<Suggestion> },
209 /// Error E0434: can't capture dynamic environment in a fn item.
210 CannotCaptureDynamicEnvironmentInFnItem,
211 /// Error E0435: attempt to use a non-constant value in a constant.
212 AttemptToUseNonConstantValueInConstant,
213 /// Error E0530: `X` bindings cannot shadow `Y`s.
214 BindingShadowsSomethingUnacceptable(&'a str, Name, &'a NameBinding<'a>),
215 /// Error E0128: type parameters with a default cannot use forward-declared identifiers.
216 ForwardDeclaredTyParam, // FIXME(const_generics:defaults)
217 /// Error E0735: type parameters with a default cannot use `Self`
218 SelfInTyParamDefault,
219 /// Error E0671: const parameter cannot depend on type parameter.
220 ConstParamDependentOnTypeParam,
223 // A minimal representation of a path segment. We use this in resolve because
224 // we synthesize 'path segments' which don't have the rest of an AST or HIR
226 #[derive(Clone, Copy, Debug)]
233 fn from_path(path: &Path) -> Vec<Segment> {
234 path.segments.iter().map(|s| s.into()).collect()
237 fn from_ident(ident: Ident) -> Segment {
244 fn names_to_string(segments: &[Segment]) -> String {
245 names_to_string(&segments.iter()
246 .map(|seg| seg.ident.name)
247 .collect::<Vec<_>>())
251 impl<'a> From<&'a ast::PathSegment> for Segment {
252 fn from(seg: &'a ast::PathSegment) -> Segment {
260 struct UsePlacementFinder {
261 target_module: NodeId,
266 impl UsePlacementFinder {
267 fn check(krate: &Crate, target_module: NodeId) -> (Option<Span>, bool) {
268 let mut finder = UsePlacementFinder {
273 visit::walk_crate(&mut finder, krate);
274 (finder.span, finder.found_use)
278 impl<'tcx> Visitor<'tcx> for UsePlacementFinder {
281 module: &'tcx ast::Mod,
283 _: &[ast::Attribute],
286 if self.span.is_some() {
289 if node_id != self.target_module {
290 visit::walk_mod(self, module);
293 // find a use statement
294 for item in &module.items {
296 ItemKind::Use(..) => {
297 // don't suggest placing a use before the prelude
298 // import or other generated ones
299 if !item.span.from_expansion() {
300 self.span = Some(item.span.shrink_to_lo());
301 self.found_use = true;
305 // don't place use before extern crate
306 ItemKind::ExternCrate(_) => {}
307 // but place them before the first other item
308 _ => if self.span.map_or(true, |span| item.span < span ) {
309 if !item.span.from_expansion() {
310 // don't insert between attributes and an item
311 if item.attrs.is_empty() {
312 self.span = Some(item.span.shrink_to_lo());
314 // find the first attribute on the item
315 for attr in &item.attrs {
316 if self.span.map_or(true, |span| attr.span < span) {
317 self.span = Some(attr.span.shrink_to_lo());
328 /// An intermediate resolution result.
330 /// This refers to the thing referred by a name. The difference between `Res` and `Item` is that
331 /// items are visible in their whole block, while `Res`es only from the place they are defined
334 enum LexicalScopeBinding<'a> {
335 Item(&'a NameBinding<'a>),
339 impl<'a> LexicalScopeBinding<'a> {
340 fn item(self) -> Option<&'a NameBinding<'a>> {
342 LexicalScopeBinding::Item(binding) => Some(binding),
347 fn res(self) -> Res {
349 LexicalScopeBinding::Item(binding) => binding.res(),
350 LexicalScopeBinding::Res(res) => res,
355 #[derive(Copy, Clone, Debug)]
356 enum ModuleOrUniformRoot<'a> {
360 /// Virtual module that denotes resolution in crate root with fallback to extern prelude.
361 CrateRootAndExternPrelude,
363 /// Virtual module that denotes resolution in extern prelude.
364 /// Used for paths starting with `::` on 2018 edition.
367 /// Virtual module that denotes resolution in current scope.
368 /// Used only for resolving single-segment imports. The reason it exists is that import paths
369 /// are always split into two parts, the first of which should be some kind of module.
373 impl ModuleOrUniformRoot<'_> {
374 fn same_def(lhs: Self, rhs: Self) -> bool {
376 (ModuleOrUniformRoot::Module(lhs),
377 ModuleOrUniformRoot::Module(rhs)) => lhs.def_id() == rhs.def_id(),
378 (ModuleOrUniformRoot::CrateRootAndExternPrelude,
379 ModuleOrUniformRoot::CrateRootAndExternPrelude) |
380 (ModuleOrUniformRoot::ExternPrelude, ModuleOrUniformRoot::ExternPrelude) |
381 (ModuleOrUniformRoot::CurrentScope, ModuleOrUniformRoot::CurrentScope) => true,
387 #[derive(Clone, Debug)]
388 enum PathResult<'a> {
389 Module(ModuleOrUniformRoot<'a>),
390 NonModule(PartialRes),
395 suggestion: Option<Suggestion>,
396 is_error_from_last_segment: bool,
401 /// An anonymous module; e.g., just a block.
406 /// { // This is an anonymous module
407 /// f(); // This resolves to (2) as we are inside the block.
410 /// f(); // Resolves to (1)
414 /// Any module with a name.
418 /// * A normal module ‒ either `mod from_file;` or `mod from_block { }`.
419 /// * A trait or an enum (it implicitly contains associated types, methods and variant
421 Def(DefKind, DefId, Name),
425 /// Get name of the module.
426 pub fn name(&self) -> Option<Name> {
428 ModuleKind::Block(..) => None,
429 ModuleKind::Def(.., name) => Some(*name),
434 type Resolutions<'a> = RefCell<FxHashMap<(Ident, Namespace), &'a RefCell<NameResolution<'a>>>>;
436 /// One node in the tree of modules.
437 pub struct ModuleData<'a> {
438 parent: Option<Module<'a>>,
441 // The def id of the closest normal module (`mod`) ancestor (including this module).
442 normal_ancestor_id: DefId,
444 // Mapping between names and their (possibly in-progress) resolutions in this module.
445 // Resolutions in modules from other crates are not populated until accessed.
446 lazy_resolutions: Resolutions<'a>,
447 // True if this is a module from other crate that needs to be populated on access.
448 populate_on_access: Cell<bool>,
450 // Macro invocations that can expand into items in this module.
451 unexpanded_invocations: RefCell<FxHashSet<ExpnId>>,
453 no_implicit_prelude: bool,
455 glob_importers: RefCell<Vec<&'a ImportDirective<'a>>>,
456 globs: RefCell<Vec<&'a ImportDirective<'a>>>,
458 // Used to memoize the traits in this module for faster searches through all traits in scope.
459 traits: RefCell<Option<Box<[(Ident, &'a NameBinding<'a>)]>>>,
461 /// Span of the module itself. Used for error reporting.
467 type Module<'a> = &'a ModuleData<'a>;
469 impl<'a> ModuleData<'a> {
470 fn new(parent: Option<Module<'a>>,
472 normal_ancestor_id: DefId,
474 span: Span) -> Self {
479 lazy_resolutions: Default::default(),
480 populate_on_access: Cell::new(!normal_ancestor_id.is_local()),
481 unexpanded_invocations: Default::default(),
482 no_implicit_prelude: false,
483 glob_importers: RefCell::new(Vec::new()),
484 globs: RefCell::new(Vec::new()),
485 traits: RefCell::new(None),
491 fn for_each_child<R, F>(&'a self, resolver: &mut R, mut f: F)
492 where R: AsMut<Resolver<'a>>, F: FnMut(&mut R, Ident, Namespace, &'a NameBinding<'a>)
494 for (&(ident, ns), name_resolution) in resolver.as_mut().resolutions(self).borrow().iter() {
495 name_resolution.borrow().binding.map(|binding| f(resolver, ident, ns, binding));
499 fn for_each_child_stable<R, F>(&'a self, resolver: &mut R, mut f: F)
500 where R: AsMut<Resolver<'a>>, F: FnMut(&mut R, Ident, Namespace, &'a NameBinding<'a>)
502 let resolutions = resolver.as_mut().resolutions(self).borrow();
503 let mut resolutions = resolutions.iter().collect::<Vec<_>>();
504 resolutions.sort_by_cached_key(|&(&(ident, ns), _)| (ident.as_str(), ns));
505 for &(&(ident, ns), &resolution) in resolutions.iter() {
506 resolution.borrow().binding.map(|binding| f(resolver, ident, ns, binding));
510 fn res(&self) -> Option<Res> {
512 ModuleKind::Def(kind, def_id, _) => Some(Res::Def(kind, def_id)),
517 fn def_id(&self) -> Option<DefId> {
519 ModuleKind::Def(_, def_id, _) => Some(def_id),
524 // `self` resolves to the first module ancestor that `is_normal`.
525 fn is_normal(&self) -> bool {
527 ModuleKind::Def(DefKind::Mod, _, _) => true,
532 fn is_trait(&self) -> bool {
534 ModuleKind::Def(DefKind::Trait, _, _) => true,
539 fn nearest_item_scope(&'a self) -> Module<'a> {
541 ModuleKind::Def(DefKind::Enum, ..) | ModuleKind::Def(DefKind::Trait, ..) =>
542 self.parent.expect("enum or trait module without a parent"),
547 fn is_ancestor_of(&self, mut other: &Self) -> bool {
548 while !ptr::eq(self, other) {
549 if let Some(parent) = other.parent {
559 impl<'a> fmt::Debug for ModuleData<'a> {
560 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
561 write!(f, "{:?}", self.res())
565 /// Records a possibly-private value, type, or module definition.
566 #[derive(Clone, Debug)]
567 pub struct NameBinding<'a> {
568 kind: NameBindingKind<'a>,
569 ambiguity: Option<(&'a NameBinding<'a>, AmbiguityKind)>,
575 pub trait ToNameBinding<'a> {
576 fn to_name_binding(self, arenas: &'a ResolverArenas<'a>) -> &'a NameBinding<'a>;
579 impl<'a> ToNameBinding<'a> for &'a NameBinding<'a> {
580 fn to_name_binding(self, _: &'a ResolverArenas<'a>) -> &'a NameBinding<'a> {
585 #[derive(Clone, Debug)]
586 enum NameBindingKind<'a> {
587 Res(Res, /* is_macro_export */ bool),
590 binding: &'a NameBinding<'a>,
591 directive: &'a ImportDirective<'a>,
596 impl<'a> NameBindingKind<'a> {
597 /// Is this a name binding of a import?
598 fn is_import(&self) -> bool {
600 NameBindingKind::Import { .. } => true,
606 struct PrivacyError<'a>(Span, Ident, &'a NameBinding<'a>);
608 struct UseError<'a> {
609 err: DiagnosticBuilder<'a>,
610 /// Attach `use` statements for these candidates.
611 candidates: Vec<ImportSuggestion>,
612 /// The `NodeId` of the module to place the use-statements in.
614 /// Whether the diagnostic should state that it's "better".
618 #[derive(Clone, Copy, PartialEq, Debug)]
623 LegacyHelperVsPrelude,
632 fn descr(self) -> &'static str {
634 AmbiguityKind::Import =>
635 "name vs any other name during import resolution",
636 AmbiguityKind::BuiltinAttr =>
637 "built-in attribute vs any other name",
638 AmbiguityKind::DeriveHelper =>
639 "derive helper attribute vs any other name",
640 AmbiguityKind::LegacyHelperVsPrelude =>
641 "legacy plugin helper attribute vs name from prelude",
642 AmbiguityKind::LegacyVsModern =>
643 "`macro_rules` vs non-`macro_rules` from other module",
644 AmbiguityKind::GlobVsOuter =>
645 "glob import vs any other name from outer scope during import/macro resolution",
646 AmbiguityKind::GlobVsGlob =>
647 "glob import vs glob import in the same module",
648 AmbiguityKind::GlobVsExpanded =>
649 "glob import vs macro-expanded name in the same \
650 module during import/macro resolution",
651 AmbiguityKind::MoreExpandedVsOuter =>
652 "macro-expanded name vs less macro-expanded name \
653 from outer scope during import/macro resolution",
658 /// Miscellaneous bits of metadata for better ambiguity error reporting.
659 #[derive(Clone, Copy, PartialEq)]
660 enum AmbiguityErrorMisc {
667 struct AmbiguityError<'a> {
670 b1: &'a NameBinding<'a>,
671 b2: &'a NameBinding<'a>,
672 misc1: AmbiguityErrorMisc,
673 misc2: AmbiguityErrorMisc,
676 impl<'a> NameBinding<'a> {
677 fn module(&self) -> Option<Module<'a>> {
679 NameBindingKind::Module(module) => Some(module),
680 NameBindingKind::Import { binding, .. } => binding.module(),
685 fn res(&self) -> Res {
687 NameBindingKind::Res(res, _) => res,
688 NameBindingKind::Module(module) => module.res().unwrap(),
689 NameBindingKind::Import { binding, .. } => binding.res(),
693 fn is_ambiguity(&self) -> bool {
694 self.ambiguity.is_some() || match self.kind {
695 NameBindingKind::Import { binding, .. } => binding.is_ambiguity(),
700 // We sometimes need to treat variants as `pub` for backwards compatibility.
701 fn pseudo_vis(&self) -> ty::Visibility {
702 if self.is_variant() && self.res().def_id().is_local() {
703 ty::Visibility::Public
709 fn is_variant(&self) -> bool {
711 NameBindingKind::Res(Res::Def(DefKind::Variant, _), _) |
712 NameBindingKind::Res(Res::Def(DefKind::Ctor(CtorOf::Variant, ..), _), _) => true,
717 fn is_extern_crate(&self) -> bool {
719 NameBindingKind::Import {
720 directive: &ImportDirective {
721 subclass: ImportDirectiveSubclass::ExternCrate { .. }, ..
724 NameBindingKind::Module(
725 &ModuleData { kind: ModuleKind::Def(DefKind::Mod, def_id, _), .. }
726 ) => def_id.index == CRATE_DEF_INDEX,
731 fn is_import(&self) -> bool {
733 NameBindingKind::Import { .. } => true,
738 fn is_glob_import(&self) -> bool {
740 NameBindingKind::Import { directive, .. } => directive.is_glob(),
745 fn is_importable(&self) -> bool {
747 Res::Def(DefKind::AssocConst, _)
748 | Res::Def(DefKind::Method, _)
749 | Res::Def(DefKind::AssocTy, _) => false,
754 fn is_macro_def(&self) -> bool {
756 NameBindingKind::Res(Res::Def(DefKind::Macro(..), _), _) => true,
761 fn macro_kind(&self) -> Option<MacroKind> {
762 self.res().macro_kind()
765 // Suppose that we resolved macro invocation with `invoc_parent_expansion` to binding `binding`
766 // at some expansion round `max(invoc, binding)` when they both emerged from macros.
767 // Then this function returns `true` if `self` may emerge from a macro *after* that
768 // in some later round and screw up our previously found resolution.
769 // See more detailed explanation in
770 // https://github.com/rust-lang/rust/pull/53778#issuecomment-419224049
771 fn may_appear_after(&self, invoc_parent_expansion: ExpnId, binding: &NameBinding<'_>) -> bool {
772 // self > max(invoc, binding) => !(self <= invoc || self <= binding)
773 // Expansions are partially ordered, so "may appear after" is an inversion of
774 // "certainly appears before or simultaneously" and includes unordered cases.
775 let self_parent_expansion = self.expansion;
776 let other_parent_expansion = binding.expansion;
777 let certainly_before_other_or_simultaneously =
778 other_parent_expansion.is_descendant_of(self_parent_expansion);
779 let certainly_before_invoc_or_simultaneously =
780 invoc_parent_expansion.is_descendant_of(self_parent_expansion);
781 !(certainly_before_other_or_simultaneously || certainly_before_invoc_or_simultaneously)
785 /// Interns the names of the primitive types.
787 /// All other types are defined somewhere and possibly imported, but the primitive ones need
788 /// special handling, since they have no place of origin.
789 struct PrimitiveTypeTable {
790 primitive_types: FxHashMap<Name, PrimTy>,
793 impl PrimitiveTypeTable {
794 fn new() -> PrimitiveTypeTable {
795 let mut table = FxHashMap::default();
797 table.insert(sym::bool, Bool);
798 table.insert(sym::char, Char);
799 table.insert(sym::f32, Float(FloatTy::F32));
800 table.insert(sym::f64, Float(FloatTy::F64));
801 table.insert(sym::isize, Int(IntTy::Isize));
802 table.insert(sym::i8, Int(IntTy::I8));
803 table.insert(sym::i16, Int(IntTy::I16));
804 table.insert(sym::i32, Int(IntTy::I32));
805 table.insert(sym::i64, Int(IntTy::I64));
806 table.insert(sym::i128, Int(IntTy::I128));
807 table.insert(sym::str, Str);
808 table.insert(sym::usize, Uint(UintTy::Usize));
809 table.insert(sym::u8, Uint(UintTy::U8));
810 table.insert(sym::u16, Uint(UintTy::U16));
811 table.insert(sym::u32, Uint(UintTy::U32));
812 table.insert(sym::u64, Uint(UintTy::U64));
813 table.insert(sym::u128, Uint(UintTy::U128));
814 Self { primitive_types: table }
818 #[derive(Debug, Default, Clone)]
819 pub struct ExternPreludeEntry<'a> {
820 extern_crate_item: Option<&'a NameBinding<'a>>,
821 pub introduced_by_item: bool,
824 /// The main resolver class.
826 /// This is the visitor that walks the whole crate.
827 pub struct Resolver<'a> {
828 session: &'a Session,
831 pub definitions: Definitions,
833 pub graph_root: Module<'a>,
835 prelude: Option<Module<'a>>,
836 pub extern_prelude: FxHashMap<Ident, ExternPreludeEntry<'a>>,
838 /// N.B., this is used only for better diagnostics, not name resolution itself.
839 has_self: FxHashSet<DefId>,
841 /// Names of fields of an item `DefId` accessible with dot syntax.
842 /// Used for hints during error reporting.
843 field_names: FxHashMap<DefId, Vec<Name>>,
845 /// All imports known to succeed or fail.
846 determined_imports: Vec<&'a ImportDirective<'a>>,
848 /// All non-determined imports.
849 indeterminate_imports: Vec<&'a ImportDirective<'a>>,
851 /// FIXME: Refactor things so that these fields are passed through arguments and not resolver.
852 /// We are resolving a last import segment during import validation.
853 last_import_segment: bool,
854 /// This binding should be ignored during in-module resolution, so that we don't get
855 /// "self-confirming" import resolutions during import validation.
856 blacklisted_binding: Option<&'a NameBinding<'a>>,
858 /// The idents for the primitive types.
859 primitive_type_table: PrimitiveTypeTable,
861 /// Resolutions for nodes that have a single resolution.
862 partial_res_map: NodeMap<PartialRes>,
863 /// Resolutions for import nodes, which have multiple resolutions in different namespaces.
864 import_res_map: NodeMap<PerNS<Option<Res>>>,
865 /// Resolutions for labels (node IDs of their corresponding blocks or loops).
866 label_res_map: NodeMap<NodeId>,
868 pub export_map: ExportMap<NodeId>,
869 pub trait_map: TraitMap,
871 /// A map from nodes to anonymous modules.
872 /// Anonymous modules are pseudo-modules that are implicitly created around items
873 /// contained within blocks.
875 /// For example, if we have this:
883 /// There will be an anonymous module created around `g` with the ID of the
884 /// entry block for `f`.
885 block_map: NodeMap<Module<'a>>,
886 /// A fake module that contains no definition and no prelude. Used so that
887 /// some AST passes can generate identifiers that only resolve to local or
889 empty_module: Module<'a>,
890 module_map: FxHashMap<DefId, Module<'a>>,
891 extern_module_map: FxHashMap<(DefId, bool /* MacrosOnly? */), Module<'a>>,
892 binding_parent_modules: FxHashMap<PtrKey<'a, NameBinding<'a>>, Module<'a>>,
894 /// Maps glob imports to the names of items actually imported.
895 pub glob_map: GlobMap,
897 used_imports: FxHashSet<(NodeId, Namespace)>,
898 pub maybe_unused_trait_imports: NodeSet,
899 pub maybe_unused_extern_crates: Vec<(NodeId, Span)>,
901 /// Privacy errors are delayed until the end in order to deduplicate them.
902 privacy_errors: Vec<PrivacyError<'a>>,
903 /// Ambiguity errors are delayed for deduplication.
904 ambiguity_errors: Vec<AmbiguityError<'a>>,
905 /// `use` injections are delayed for better placement and deduplication.
906 use_injections: Vec<UseError<'a>>,
907 /// Crate-local macro expanded `macro_export` referred to by a module-relative path.
908 macro_expanded_macro_export_errors: BTreeSet<(Span, Span)>,
910 arenas: &'a ResolverArenas<'a>,
911 dummy_binding: &'a NameBinding<'a>,
913 crate_loader: &'a mut CrateLoader<'a>,
914 macro_names: FxHashSet<Ident>,
915 builtin_macros: FxHashMap<Name, SyntaxExtension>,
916 macro_use_prelude: FxHashMap<Name, &'a NameBinding<'a>>,
917 pub all_macros: FxHashMap<Name, Res>,
918 macro_map: FxHashMap<DefId, Lrc<SyntaxExtension>>,
919 dummy_ext_bang: Lrc<SyntaxExtension>,
920 dummy_ext_derive: Lrc<SyntaxExtension>,
921 non_macro_attrs: [Lrc<SyntaxExtension>; 2],
922 macro_defs: FxHashMap<ExpnId, DefId>,
923 local_macro_def_scopes: FxHashMap<NodeId, Module<'a>>,
924 ast_transform_scopes: FxHashMap<ExpnId, Module<'a>>,
925 unused_macros: NodeMap<Span>,
926 proc_macro_stubs: NodeSet,
927 /// Traces collected during macro resolution and validated when it's complete.
928 single_segment_macro_resolutions: Vec<(Ident, MacroKind, ParentScope<'a>,
929 Option<&'a NameBinding<'a>>)>,
930 multi_segment_macro_resolutions: Vec<(Vec<Segment>, Span, MacroKind, ParentScope<'a>,
932 builtin_attrs: Vec<(Ident, ParentScope<'a>)>,
933 /// Some built-in derives mark items they are applied to so they are treated specially later.
934 /// Derive macros cannot modify the item themselves and have to store the markers in the global
935 /// context, so they attach the markers to derive container IDs using this resolver table.
936 /// FIXME: Find a way for `PartialEq` and `Eq` to emulate `#[structural_match]`
937 /// by marking the produced impls rather than the original items.
938 special_derives: FxHashMap<ExpnId, SpecialDerives>,
939 /// Parent scopes in which the macros were invoked.
940 /// FIXME: `derives` are missing in these parent scopes and need to be taken from elsewhere.
941 invocation_parent_scopes: FxHashMap<ExpnId, ParentScope<'a>>,
942 /// Legacy scopes *produced* by expanding the macro invocations,
943 /// include all the `macro_rules` items and other invocations generated by them.
944 output_legacy_scopes: FxHashMap<ExpnId, LegacyScope<'a>>,
946 /// Avoid duplicated errors for "name already defined".
947 name_already_seen: FxHashMap<Name, Span>,
949 potentially_unused_imports: Vec<&'a ImportDirective<'a>>,
951 /// Table for mapping struct IDs into struct constructor IDs,
952 /// it's not used during normal resolution, only for better error reporting.
953 struct_constructors: DefIdMap<(Res, ty::Visibility)>,
955 /// Features enabled for this crate.
956 active_features: FxHashSet<Name>,
958 /// Stores enum visibilities to properly build a reduced graph
959 /// when visiting the correspondent variants.
960 variant_vis: DefIdMap<ty::Visibility>,
963 /// Nothing really interesting here; it just provides memory for the rest of the crate.
965 pub struct ResolverArenas<'a> {
966 modules: arena::TypedArena<ModuleData<'a>>,
967 local_modules: RefCell<Vec<Module<'a>>>,
968 name_bindings: arena::TypedArena<NameBinding<'a>>,
969 import_directives: arena::TypedArena<ImportDirective<'a>>,
970 name_resolutions: arena::TypedArena<RefCell<NameResolution<'a>>>,
971 legacy_bindings: arena::TypedArena<LegacyBinding<'a>>,
972 ast_paths: arena::TypedArena<ast::Path>,
975 impl<'a> ResolverArenas<'a> {
976 fn alloc_module(&'a self, module: ModuleData<'a>) -> Module<'a> {
977 let module = self.modules.alloc(module);
978 if module.def_id().map(|def_id| def_id.is_local()).unwrap_or(true) {
979 self.local_modules.borrow_mut().push(module);
983 fn local_modules(&'a self) -> std::cell::Ref<'a, Vec<Module<'a>>> {
984 self.local_modules.borrow()
986 fn alloc_name_binding(&'a self, name_binding: NameBinding<'a>) -> &'a NameBinding<'a> {
987 self.name_bindings.alloc(name_binding)
989 fn alloc_import_directive(&'a self, import_directive: ImportDirective<'a>)
990 -> &'a ImportDirective<'_> {
991 self.import_directives.alloc(import_directive)
993 fn alloc_name_resolution(&'a self) -> &'a RefCell<NameResolution<'a>> {
994 self.name_resolutions.alloc(Default::default())
996 fn alloc_legacy_binding(&'a self, binding: LegacyBinding<'a>) -> &'a LegacyBinding<'a> {
997 self.legacy_bindings.alloc(binding)
999 fn alloc_ast_paths(&'a self, paths: &[ast::Path]) -> &'a [ast::Path] {
1000 self.ast_paths.alloc_from_iter(paths.iter().cloned())
1004 impl<'a> AsMut<Resolver<'a>> for Resolver<'a> {
1005 fn as_mut(&mut self) -> &mut Resolver<'a> { self }
1008 impl<'a, 'b> ty::DefIdTree for &'a Resolver<'b> {
1009 fn parent(self, id: DefId) -> Option<DefId> {
1011 LOCAL_CRATE => self.definitions.def_key(id.index).parent,
1012 _ => self.cstore.def_key(id).parent,
1013 }.map(|index| DefId { index, ..id })
1017 /// This interface is used through the AST→HIR step, to embed full paths into the HIR. After that
1018 /// the resolver is no longer needed as all the relevant information is inline.
1019 impl<'a> hir::lowering::Resolver for Resolver<'a> {
1020 fn resolve_str_path(
1023 crate_root: Option<Name>,
1024 components: &[Name],
1026 ) -> (ast::Path, Res) {
1027 let root = if crate_root.is_some() {
1032 let segments = iter::once(Ident::with_dummy_span(root))
1034 crate_root.into_iter()
1035 .chain(components.iter().cloned())
1036 .map(Ident::with_dummy_span)
1037 ).map(|i| self.new_ast_path_segment(i)).collect::<Vec<_>>();
1039 let path = ast::Path {
1044 let parent_scope = &ParentScope::module(self.graph_root);
1045 let res = match self.resolve_ast_path(&path, ns, parent_scope) {
1047 Err((span, error)) => {
1048 self.report_error(span, error);
1055 fn get_partial_res(&mut self, id: NodeId) -> Option<PartialRes> {
1056 self.partial_res_map.get(&id).cloned()
1059 fn get_import_res(&mut self, id: NodeId) -> PerNS<Option<Res>> {
1060 self.import_res_map.get(&id).cloned().unwrap_or_default()
1063 fn get_label_res(&mut self, id: NodeId) -> Option<NodeId> {
1064 self.label_res_map.get(&id).cloned()
1067 fn definitions(&mut self) -> &mut Definitions {
1068 &mut self.definitions
1071 fn has_derives(&self, node_id: NodeId, derives: SpecialDerives) -> bool {
1072 let def_id = self.definitions.local_def_id(node_id);
1073 let expn_id = self.definitions.expansion_that_defined(def_id.index);
1074 self.has_derives(expn_id, derives)
1078 impl<'a> Resolver<'a> {
1079 pub fn new(session: &'a Session,
1083 crate_loader: &'a mut CrateLoader<'a>,
1084 arenas: &'a ResolverArenas<'a>)
1086 let root_def_id = DefId::local(CRATE_DEF_INDEX);
1087 let root_module_kind = ModuleKind::Def(
1092 let graph_root = arenas.alloc_module(ModuleData {
1093 no_implicit_prelude: attr::contains_name(&krate.attrs, sym::no_implicit_prelude),
1094 ..ModuleData::new(None, root_module_kind, root_def_id, ExpnId::root(), krate.span)
1096 let empty_module_kind = ModuleKind::Def(
1101 let empty_module = arenas.alloc_module(ModuleData {
1102 no_implicit_prelude: true,
1111 let mut module_map = FxHashMap::default();
1112 module_map.insert(DefId::local(CRATE_DEF_INDEX), graph_root);
1114 let mut definitions = Definitions::default();
1115 definitions.create_root_def(crate_name, session.local_crate_disambiguator());
1117 let mut extern_prelude: FxHashMap<Ident, ExternPreludeEntry<'_>> =
1118 session.opts.externs.iter().map(|kv| (Ident::from_str(kv.0), Default::default()))
1121 if !attr::contains_name(&krate.attrs, sym::no_core) {
1122 extern_prelude.insert(Ident::with_dummy_span(sym::core), Default::default());
1123 if !attr::contains_name(&krate.attrs, sym::no_std) {
1124 extern_prelude.insert(Ident::with_dummy_span(sym::std), Default::default());
1125 if session.rust_2018() {
1126 extern_prelude.insert(Ident::with_dummy_span(sym::meta), Default::default());
1131 let mut invocation_parent_scopes = FxHashMap::default();
1132 invocation_parent_scopes.insert(ExpnId::root(), ParentScope::module(graph_root));
1134 let mut macro_defs = FxHashMap::default();
1135 macro_defs.insert(ExpnId::root(), root_def_id);
1137 let features = session.features_untracked();
1138 let non_macro_attr =
1139 |mark_used| Lrc::new(SyntaxExtension::non_macro_attr(mark_used, session.edition()));
1148 // The outermost module has def ID 0; this is not reflected in the
1154 has_self: FxHashSet::default(),
1155 field_names: FxHashMap::default(),
1157 determined_imports: Vec::new(),
1158 indeterminate_imports: Vec::new(),
1160 last_import_segment: false,
1161 blacklisted_binding: None,
1163 primitive_type_table: PrimitiveTypeTable::new(),
1165 partial_res_map: Default::default(),
1166 import_res_map: Default::default(),
1167 label_res_map: Default::default(),
1168 export_map: FxHashMap::default(),
1169 trait_map: Default::default(),
1172 block_map: Default::default(),
1173 extern_module_map: FxHashMap::default(),
1174 binding_parent_modules: FxHashMap::default(),
1175 ast_transform_scopes: FxHashMap::default(),
1177 glob_map: Default::default(),
1179 used_imports: FxHashSet::default(),
1180 maybe_unused_trait_imports: Default::default(),
1181 maybe_unused_extern_crates: Vec::new(),
1183 privacy_errors: Vec::new(),
1184 ambiguity_errors: Vec::new(),
1185 use_injections: Vec::new(),
1186 macro_expanded_macro_export_errors: BTreeSet::new(),
1189 dummy_binding: arenas.alloc_name_binding(NameBinding {
1190 kind: NameBindingKind::Res(Res::Err, false),
1192 expansion: ExpnId::root(),
1194 vis: ty::Visibility::Public,
1198 macro_names: FxHashSet::default(),
1199 builtin_macros: Default::default(),
1200 macro_use_prelude: FxHashMap::default(),
1201 all_macros: FxHashMap::default(),
1202 macro_map: FxHashMap::default(),
1203 dummy_ext_bang: Lrc::new(SyntaxExtension::dummy_bang(session.edition())),
1204 dummy_ext_derive: Lrc::new(SyntaxExtension::dummy_derive(session.edition())),
1205 non_macro_attrs: [non_macro_attr(false), non_macro_attr(true)],
1206 invocation_parent_scopes,
1207 output_legacy_scopes: Default::default(),
1209 local_macro_def_scopes: FxHashMap::default(),
1210 name_already_seen: FxHashMap::default(),
1211 potentially_unused_imports: Vec::new(),
1212 struct_constructors: Default::default(),
1213 unused_macros: Default::default(),
1214 proc_macro_stubs: Default::default(),
1215 single_segment_macro_resolutions: Default::default(),
1216 multi_segment_macro_resolutions: Default::default(),
1217 builtin_attrs: Default::default(),
1218 special_derives: Default::default(),
1220 features.declared_lib_features.iter().map(|(feat, ..)| *feat)
1221 .chain(features.declared_lang_features.iter().map(|(feat, ..)| *feat))
1223 variant_vis: Default::default()
1227 pub fn arenas() -> ResolverArenas<'a> {
1231 fn non_macro_attr(&self, mark_used: bool) -> Lrc<SyntaxExtension> {
1232 self.non_macro_attrs[mark_used as usize].clone()
1235 fn dummy_ext(&self, macro_kind: MacroKind) -> Lrc<SyntaxExtension> {
1237 MacroKind::Bang => self.dummy_ext_bang.clone(),
1238 MacroKind::Derive => self.dummy_ext_derive.clone(),
1239 MacroKind::Attr => self.non_macro_attr(true),
1243 /// Runs the function on each namespace.
1244 fn per_ns<F: FnMut(&mut Self, Namespace)>(&mut self, mut f: F) {
1250 fn is_builtin_macro(&mut self, res: Res) -> bool {
1251 self.get_macro(res).map_or(false, |ext| ext.is_builtin)
1254 fn macro_def(&self, mut ctxt: SyntaxContext) -> DefId {
1256 match self.macro_defs.get(&ctxt.outer_expn()) {
1257 Some(&def_id) => return def_id,
1258 None => ctxt.remove_mark(),
1263 fn has_derives(&self, expn_id: ExpnId, markers: SpecialDerives) -> bool {
1264 self.special_derives.get(&expn_id).map_or(false, |m| m.contains(markers))
1267 /// Entry point to crate resolution.
1268 pub fn resolve_crate(&mut self, krate: &Crate) {
1269 ImportResolver { r: self }.finalize_imports();
1270 self.finalize_macro_resolutions();
1272 self.late_resolve_crate(krate);
1274 self.check_unused(krate);
1275 self.report_errors(krate);
1276 self.crate_loader.postprocess(krate);
1283 normal_ancestor_id: DefId,
1287 let module = ModuleData::new(Some(parent), kind, normal_ancestor_id, expn_id, span);
1288 self.arenas.alloc_module(module)
1291 fn resolutions(&mut self, module: Module<'a>) -> &'a Resolutions<'a> {
1292 if module.populate_on_access.get() {
1293 module.populate_on_access.set(false);
1294 self.build_reduced_graph_external(module);
1296 &module.lazy_resolutions
1299 fn resolution(&mut self, module: Module<'a>, ident: Ident, ns: Namespace)
1300 -> &'a RefCell<NameResolution<'a>> {
1301 *self.resolutions(module).borrow_mut().entry((ident.modern(), ns))
1302 .or_insert_with(|| self.arenas.alloc_name_resolution())
1305 fn record_use(&mut self, ident: Ident, ns: Namespace,
1306 used_binding: &'a NameBinding<'a>, is_lexical_scope: bool) {
1307 if let Some((b2, kind)) = used_binding.ambiguity {
1308 self.ambiguity_errors.push(AmbiguityError {
1309 kind, ident, b1: used_binding, b2,
1310 misc1: AmbiguityErrorMisc::None,
1311 misc2: AmbiguityErrorMisc::None,
1314 if let NameBindingKind::Import { directive, binding, ref used } = used_binding.kind {
1315 // Avoid marking `extern crate` items that refer to a name from extern prelude,
1316 // but not introduce it, as used if they are accessed from lexical scope.
1317 if is_lexical_scope {
1318 if let Some(entry) = self.extern_prelude.get(&ident.modern()) {
1319 if let Some(crate_item) = entry.extern_crate_item {
1320 if ptr::eq(used_binding, crate_item) && !entry.introduced_by_item {
1327 directive.used.set(true);
1328 self.used_imports.insert((directive.id, ns));
1329 self.add_to_glob_map(&directive, ident);
1330 self.record_use(ident, ns, binding, false);
1335 fn add_to_glob_map(&mut self, directive: &ImportDirective<'_>, ident: Ident) {
1336 if directive.is_glob() {
1337 self.glob_map.entry(directive.id).or_default().insert(ident.name);
1341 /// A generic scope visitor.
1342 /// Visits scopes in order to resolve some identifier in them or perform other actions.
1343 /// If the callback returns `Some` result, we stop visiting scopes and return it.
1346 scope_set: ScopeSet,
1347 parent_scope: &ParentScope<'a>,
1349 mut visitor: impl FnMut(&mut Self, Scope<'a>, /*use_prelude*/ bool, Ident) -> Option<T>,
1351 // General principles:
1352 // 1. Not controlled (user-defined) names should have higher priority than controlled names
1353 // built into the language or standard library. This way we can add new names into the
1354 // language or standard library without breaking user code.
1355 // 2. "Closed set" below means new names cannot appear after the current resolution attempt.
1356 // Places to search (in order of decreasing priority):
1358 // 1. FIXME: Ribs (type parameters), there's no necessary infrastructure yet
1359 // (open set, not controlled).
1360 // 2. Names in modules (both normal `mod`ules and blocks), loop through hygienic parents
1361 // (open, not controlled).
1362 // 3. Extern prelude (open, the open part is from macro expansions, not controlled).
1363 // 4. Tool modules (closed, controlled right now, but not in the future).
1364 // 5. Standard library prelude (de-facto closed, controlled).
1365 // 6. Language prelude (closed, controlled).
1367 // 1. FIXME: Ribs (local variables), there's no necessary infrastructure yet
1368 // (open set, not controlled).
1369 // 2. Names in modules (both normal `mod`ules and blocks), loop through hygienic parents
1370 // (open, not controlled).
1371 // 3. Standard library prelude (de-facto closed, controlled).
1373 // 1-3. Derive helpers (open, not controlled). All ambiguities with other names
1374 // are currently reported as errors. They should be higher in priority than preludes
1375 // and probably even names in modules according to the "general principles" above. They
1376 // also should be subject to restricted shadowing because are effectively produced by
1377 // derives (you need to resolve the derive first to add helpers into scope), but they
1378 // should be available before the derive is expanded for compatibility.
1379 // It's mess in general, so we are being conservative for now.
1380 // 1-3. `macro_rules` (open, not controlled), loop through legacy scopes. Have higher
1381 // priority than prelude macros, but create ambiguities with macros in modules.
1382 // 1-3. Names in modules (both normal `mod`ules and blocks), loop through hygienic parents
1383 // (open, not controlled). Have higher priority than prelude macros, but create
1384 // ambiguities with `macro_rules`.
1385 // 4. `macro_use` prelude (open, the open part is from macro expansions, not controlled).
1386 // 4a. User-defined prelude from macro-use
1387 // (open, the open part is from macro expansions, not controlled).
1388 // 4b. "Standard library prelude" part implemented through `macro-use` (closed, controlled).
1389 // 4c. Standard library prelude (de-facto closed, controlled).
1390 // 6. Language prelude: builtin attributes (closed, controlled).
1391 // 4-6. Legacy plugin helpers (open, not controlled). Similar to derive helpers,
1392 // but introduced by legacy plugins using `register_attribute`. Priority is somewhere
1393 // in prelude, not sure where exactly (creates ambiguities with any other prelude names).
1395 let rust_2015 = ident.span.rust_2015();
1396 let (ns, is_absolute_path) = match scope_set {
1397 ScopeSet::All(ns, _) => (ns, false),
1398 ScopeSet::AbsolutePath(ns) => (ns, true),
1399 ScopeSet::Macro(_) => (MacroNS, false),
1401 // Jump out of trait or enum modules, they do not act as scopes.
1402 let module = parent_scope.module.nearest_item_scope();
1403 let mut scope = match ns {
1404 _ if is_absolute_path => Scope::CrateRoot,
1405 TypeNS | ValueNS => Scope::Module(module),
1406 MacroNS => Scope::DeriveHelpers,
1408 let mut ident = ident.modern();
1409 let mut use_prelude = !module.no_implicit_prelude;
1412 let visit = match scope {
1413 Scope::DeriveHelpers => true,
1414 Scope::MacroRules(..) => true,
1415 Scope::CrateRoot => true,
1416 Scope::Module(..) => true,
1417 Scope::MacroUsePrelude => use_prelude || rust_2015,
1418 Scope::BuiltinAttrs => true,
1419 Scope::LegacyPluginHelpers => use_prelude || rust_2015,
1420 Scope::ExternPrelude => use_prelude || is_absolute_path,
1421 Scope::ToolPrelude => use_prelude,
1422 Scope::StdLibPrelude => use_prelude || ns == MacroNS,
1423 Scope::BuiltinTypes => true,
1427 if let break_result @ Some(..) = visitor(self, scope, use_prelude, ident) {
1428 return break_result;
1432 scope = match scope {
1433 Scope::DeriveHelpers =>
1434 Scope::MacroRules(parent_scope.legacy),
1435 Scope::MacroRules(legacy_scope) => match legacy_scope {
1436 LegacyScope::Binding(binding) => Scope::MacroRules(
1437 binding.parent_legacy_scope
1439 LegacyScope::Invocation(invoc_id) => Scope::MacroRules(
1440 self.output_legacy_scopes.get(&invoc_id).cloned()
1441 .unwrap_or(self.invocation_parent_scopes[&invoc_id].legacy)
1443 LegacyScope::Empty => Scope::Module(module),
1445 Scope::CrateRoot => match ns {
1447 ident.span.adjust(ExpnId::root());
1448 Scope::ExternPrelude
1450 ValueNS | MacroNS => break,
1452 Scope::Module(module) => {
1453 use_prelude = !module.no_implicit_prelude;
1454 match self.hygienic_lexical_parent(module, &mut ident.span) {
1455 Some(parent_module) => Scope::Module(parent_module),
1457 ident.span.adjust(ExpnId::root());
1459 TypeNS => Scope::ExternPrelude,
1460 ValueNS => Scope::StdLibPrelude,
1461 MacroNS => Scope::MacroUsePrelude,
1466 Scope::MacroUsePrelude => Scope::StdLibPrelude,
1467 Scope::BuiltinAttrs => Scope::LegacyPluginHelpers,
1468 Scope::LegacyPluginHelpers => break, // nowhere else to search
1469 Scope::ExternPrelude if is_absolute_path => break,
1470 Scope::ExternPrelude => Scope::ToolPrelude,
1471 Scope::ToolPrelude => Scope::StdLibPrelude,
1472 Scope::StdLibPrelude => match ns {
1473 TypeNS => Scope::BuiltinTypes,
1474 ValueNS => break, // nowhere else to search
1475 MacroNS => Scope::BuiltinAttrs,
1477 Scope::BuiltinTypes => break, // nowhere else to search
1484 /// This resolves the identifier `ident` in the namespace `ns` in the current lexical scope.
1485 /// More specifically, we proceed up the hierarchy of scopes and return the binding for
1486 /// `ident` in the first scope that defines it (or None if no scopes define it).
1488 /// A block's items are above its local variables in the scope hierarchy, regardless of where
1489 /// the items are defined in the block. For example,
1492 /// g(); // Since there are no local variables in scope yet, this resolves to the item.
1495 /// g(); // This resolves to the local variable `g` since it shadows the item.
1499 /// Invariant: This must only be called during main resolution, not during
1500 /// import resolution.
1501 fn resolve_ident_in_lexical_scope(&mut self,
1504 parent_scope: &ParentScope<'a>,
1505 record_used_id: Option<NodeId>,
1508 -> Option<LexicalScopeBinding<'a>> {
1509 assert!(ns == TypeNS || ns == ValueNS);
1510 if ident.name == kw::Invalid {
1511 return Some(LexicalScopeBinding::Res(Res::Err));
1513 let (general_span, modern_span) = if ident.name == kw::SelfUpper {
1514 // FIXME(jseyfried) improve `Self` hygiene
1515 let empty_span = ident.span.with_ctxt(SyntaxContext::root());
1516 (empty_span, empty_span)
1517 } else if ns == TypeNS {
1518 let modern_span = ident.span.modern();
1519 (modern_span, modern_span)
1521 (ident.span.modern_and_legacy(), ident.span.modern())
1523 ident.span = general_span;
1524 let modern_ident = Ident { span: modern_span, ..ident };
1526 // Walk backwards up the ribs in scope.
1527 let record_used = record_used_id.is_some();
1528 let mut module = self.graph_root;
1529 for i in (0 .. ribs.len()).rev() {
1530 debug!("walk rib\n{:?}", ribs[i].bindings);
1531 // Use the rib kind to determine whether we are resolving parameters
1532 // (modern hygiene) or local variables (legacy hygiene).
1533 let rib_ident = if ribs[i].kind.contains_params() {
1538 if let Some(res) = ribs[i].bindings.get(&rib_ident).cloned() {
1539 // The ident resolves to a type parameter or local variable.
1540 return Some(LexicalScopeBinding::Res(
1541 self.validate_res_from_ribs(i, rib_ident, res, record_used, path_span, ribs),
1545 module = match ribs[i].kind {
1546 ModuleRibKind(module) => module,
1547 MacroDefinition(def) if def == self.macro_def(ident.span.ctxt()) => {
1548 // If an invocation of this macro created `ident`, give up on `ident`
1549 // and switch to `ident`'s source from the macro definition.
1550 ident.span.remove_mark();
1557 let item = self.resolve_ident_in_module_unadjusted(
1558 ModuleOrUniformRoot::Module(module),
1565 if let Ok(binding) = item {
1566 // The ident resolves to an item.
1567 return Some(LexicalScopeBinding::Item(binding));
1571 ModuleKind::Block(..) => {}, // We can see through blocks
1576 ident = modern_ident;
1577 let mut poisoned = None;
1579 let opt_module = if let Some(node_id) = record_used_id {
1580 self.hygienic_lexical_parent_with_compatibility_fallback(module, &mut ident.span,
1581 node_id, &mut poisoned)
1583 self.hygienic_lexical_parent(module, &mut ident.span)
1585 module = unwrap_or!(opt_module, break);
1586 let adjusted_parent_scope = &ParentScope { module, ..*parent_scope };
1587 let result = self.resolve_ident_in_module_unadjusted(
1588 ModuleOrUniformRoot::Module(module),
1591 adjusted_parent_scope,
1598 if let Some(node_id) = poisoned {
1599 self.session.buffer_lint_with_diagnostic(
1600 lint::builtin::PROC_MACRO_DERIVE_RESOLUTION_FALLBACK,
1601 node_id, ident.span,
1602 &format!("cannot find {} `{}` in this scope", ns.descr(), ident),
1603 lint::builtin::BuiltinLintDiagnostics::
1604 ProcMacroDeriveResolutionFallback(ident.span),
1607 return Some(LexicalScopeBinding::Item(binding))
1609 Err(Determined) => continue,
1610 Err(Undetermined) =>
1611 span_bug!(ident.span, "undetermined resolution during main resolution pass"),
1615 if !module.no_implicit_prelude {
1616 ident.span.adjust(ExpnId::root());
1618 if let Some(binding) = self.extern_prelude_get(ident, !record_used) {
1619 return Some(LexicalScopeBinding::Item(binding));
1622 if ns == TypeNS && KNOWN_TOOLS.contains(&ident.name) {
1623 let binding = (Res::ToolMod, ty::Visibility::Public,
1624 DUMMY_SP, ExpnId::root()).to_name_binding(self.arenas);
1625 return Some(LexicalScopeBinding::Item(binding));
1627 if let Some(prelude) = self.prelude {
1628 if let Ok(binding) = self.resolve_ident_in_module_unadjusted(
1629 ModuleOrUniformRoot::Module(prelude),
1636 return Some(LexicalScopeBinding::Item(binding));
1644 fn hygienic_lexical_parent(&mut self, module: Module<'a>, span: &mut Span)
1645 -> Option<Module<'a>> {
1646 if !module.expansion.outer_expn_is_descendant_of(span.ctxt()) {
1647 return Some(self.macro_def_scope(span.remove_mark()));
1650 if let ModuleKind::Block(..) = module.kind {
1651 return Some(module.parent.unwrap().nearest_item_scope());
1657 fn hygienic_lexical_parent_with_compatibility_fallback(&mut self, module: Module<'a>,
1658 span: &mut Span, node_id: NodeId,
1659 poisoned: &mut Option<NodeId>)
1660 -> Option<Module<'a>> {
1661 if let module @ Some(..) = self.hygienic_lexical_parent(module, span) {
1665 // We need to support the next case under a deprecation warning
1668 // ---- begin: this comes from a proc macro derive
1669 // mod implementation_details {
1670 // // Note that `MyStruct` is not in scope here.
1671 // impl SomeTrait for MyStruct { ... }
1675 // So we have to fall back to the module's parent during lexical resolution in this case.
1676 if let Some(parent) = module.parent {
1677 // Inner module is inside the macro, parent module is outside of the macro.
1678 if module.expansion != parent.expansion &&
1679 module.expansion.is_descendant_of(parent.expansion) {
1680 // The macro is a proc macro derive
1681 if let Some(&def_id) = self.macro_defs.get(&module.expansion) {
1682 if let Some(ext) = self.get_macro_by_def_id(def_id) {
1683 if !ext.is_builtin && ext.macro_kind() == MacroKind::Derive {
1684 if parent.expansion.outer_expn_is_descendant_of(span.ctxt()) {
1685 *poisoned = Some(node_id);
1686 return module.parent;
1697 fn resolve_ident_in_module(
1699 module: ModuleOrUniformRoot<'a>,
1702 parent_scope: &ParentScope<'a>,
1705 ) -> Result<&'a NameBinding<'a>, Determinacy> {
1706 self.resolve_ident_in_module_ext(
1707 module, ident, ns, parent_scope, record_used, path_span
1708 ).map_err(|(determinacy, _)| determinacy)
1711 fn resolve_ident_in_module_ext(
1713 module: ModuleOrUniformRoot<'a>,
1716 parent_scope: &ParentScope<'a>,
1719 ) -> Result<&'a NameBinding<'a>, (Determinacy, Weak)> {
1720 let tmp_parent_scope;
1721 let mut adjusted_parent_scope = parent_scope;
1723 ModuleOrUniformRoot::Module(m) => {
1724 if let Some(def) = ident.span.modernize_and_adjust(m.expansion) {
1726 ParentScope { module: self.macro_def_scope(def), ..*parent_scope };
1727 adjusted_parent_scope = &tmp_parent_scope;
1730 ModuleOrUniformRoot::ExternPrelude => {
1731 ident.span.modernize_and_adjust(ExpnId::root());
1733 ModuleOrUniformRoot::CrateRootAndExternPrelude |
1734 ModuleOrUniformRoot::CurrentScope => {
1738 let result = self.resolve_ident_in_module_unadjusted_ext(
1739 module, ident, ns, adjusted_parent_scope, false, record_used, path_span,
1744 fn resolve_crate_root(&mut self, ident: Ident) -> Module<'a> {
1745 let mut ctxt = ident.span.ctxt();
1746 let mark = if ident.name == kw::DollarCrate {
1747 // When resolving `$crate` from a `macro_rules!` invoked in a `macro`,
1748 // we don't want to pretend that the `macro_rules!` definition is in the `macro`
1749 // as described in `SyntaxContext::apply_mark`, so we ignore prepended modern marks.
1750 // FIXME: This is only a guess and it doesn't work correctly for `macro_rules!`
1751 // definitions actually produced by `macro` and `macro` definitions produced by
1752 // `macro_rules!`, but at least such configurations are not stable yet.
1753 ctxt = ctxt.modern_and_legacy();
1754 let mut iter = ctxt.marks().into_iter().rev().peekable();
1755 let mut result = None;
1756 // Find the last modern mark from the end if it exists.
1757 while let Some(&(mark, transparency)) = iter.peek() {
1758 if transparency == Transparency::Opaque {
1759 result = Some(mark);
1765 // Then find the last legacy mark from the end if it exists.
1766 for (mark, transparency) in iter {
1767 if transparency == Transparency::SemiTransparent {
1768 result = Some(mark);
1775 ctxt = ctxt.modern();
1776 ctxt.adjust(ExpnId::root())
1778 let module = match mark {
1779 Some(def) => self.macro_def_scope(def),
1780 None => return self.graph_root,
1782 self.get_module(DefId { index: CRATE_DEF_INDEX, ..module.normal_ancestor_id })
1785 fn resolve_self(&mut self, ctxt: &mut SyntaxContext, module: Module<'a>) -> Module<'a> {
1786 let mut module = self.get_module(module.normal_ancestor_id);
1787 while module.span.ctxt().modern() != *ctxt {
1788 let parent = module.parent.unwrap_or_else(|| self.macro_def_scope(ctxt.remove_mark()));
1789 module = self.get_module(parent.normal_ancestor_id);
1797 opt_ns: Option<Namespace>, // `None` indicates a module path in import
1798 parent_scope: &ParentScope<'a>,
1801 crate_lint: CrateLint,
1802 ) -> PathResult<'a> {
1803 self.resolve_path_with_ribs(
1804 path, opt_ns, parent_scope, record_used, path_span, crate_lint, None
1808 fn resolve_path_with_ribs(
1811 opt_ns: Option<Namespace>, // `None` indicates a module path in import
1812 parent_scope: &ParentScope<'a>,
1815 crate_lint: CrateLint,
1816 ribs: Option<&PerNS<Vec<Rib<'a>>>>,
1817 ) -> PathResult<'a> {
1818 let mut module = None;
1819 let mut allow_super = true;
1820 let mut second_binding = None;
1823 "resolve_path(path={:?}, opt_ns={:?}, record_used={:?}, \
1824 path_span={:?}, crate_lint={:?})",
1832 for (i, &Segment { ident, id }) in path.iter().enumerate() {
1833 debug!("resolve_path ident {} {:?} {:?}", i, ident, id);
1834 let record_segment_res = |this: &mut Self, res| {
1836 if let Some(id) = id {
1837 if !this.partial_res_map.contains_key(&id) {
1838 assert!(id != ast::DUMMY_NODE_ID, "Trying to resolve dummy id");
1839 this.record_partial_res(id, PartialRes::new(res));
1845 let is_last = i == path.len() - 1;
1846 let ns = if is_last { opt_ns.unwrap_or(TypeNS) } else { TypeNS };
1847 let name = ident.name;
1849 allow_super &= ns == TypeNS &&
1850 (name == kw::SelfLower ||
1854 if allow_super && name == kw::Super {
1855 let mut ctxt = ident.span.ctxt().modern();
1856 let self_module = match i {
1857 0 => Some(self.resolve_self(&mut ctxt, parent_scope.module)),
1859 Some(ModuleOrUniformRoot::Module(module)) => Some(module),
1863 if let Some(self_module) = self_module {
1864 if let Some(parent) = self_module.parent {
1865 module = Some(ModuleOrUniformRoot::Module(
1866 self.resolve_self(&mut ctxt, parent)));
1870 let msg = "there are too many initial `super`s.".to_string();
1871 return PathResult::Failed {
1875 is_error_from_last_segment: false,
1879 if name == kw::SelfLower {
1880 let mut ctxt = ident.span.ctxt().modern();
1881 module = Some(ModuleOrUniformRoot::Module(
1882 self.resolve_self(&mut ctxt, parent_scope.module)));
1885 if name == kw::PathRoot && ident.span.rust_2018() {
1886 module = Some(ModuleOrUniformRoot::ExternPrelude);
1889 if name == kw::PathRoot &&
1890 ident.span.rust_2015() && self.session.rust_2018() {
1891 // `::a::b` from 2015 macro on 2018 global edition
1892 module = Some(ModuleOrUniformRoot::CrateRootAndExternPrelude);
1895 if name == kw::PathRoot ||
1896 name == kw::Crate ||
1897 name == kw::DollarCrate {
1898 // `::a::b`, `crate::a::b` or `$crate::a::b`
1899 module = Some(ModuleOrUniformRoot::Module(
1900 self.resolve_crate_root(ident)));
1906 // Report special messages for path segment keywords in wrong positions.
1907 if ident.is_path_segment_keyword() && i != 0 {
1908 let name_str = if name == kw::PathRoot {
1909 "crate root".to_string()
1911 format!("`{}`", name)
1913 let label = if i == 1 && path[0].ident.name == kw::PathRoot {
1914 format!("global paths cannot start with {}", name_str)
1916 format!("{} in paths can only be used in start position", name_str)
1918 return PathResult::Failed {
1922 is_error_from_last_segment: false,
1926 let binding = if let Some(module) = module {
1927 self.resolve_ident_in_module(
1928 module, ident, ns, parent_scope, record_used, path_span
1930 } else if ribs.is_none() || opt_ns.is_none() || opt_ns == Some(MacroNS) {
1931 let scopes = ScopeSet::All(ns, opt_ns.is_none());
1932 self.early_resolve_ident_in_lexical_scope(ident, scopes, parent_scope, record_used,
1933 record_used, path_span)
1935 let record_used_id =
1936 if record_used { crate_lint.node_id().or(Some(CRATE_NODE_ID)) } else { None };
1937 match self.resolve_ident_in_lexical_scope(
1938 ident, ns, parent_scope, record_used_id, path_span, &ribs.unwrap()[ns]
1940 // we found a locally-imported or available item/module
1941 Some(LexicalScopeBinding::Item(binding)) => Ok(binding),
1942 // we found a local variable or type param
1943 Some(LexicalScopeBinding::Res(res))
1944 if opt_ns == Some(TypeNS) || opt_ns == Some(ValueNS) => {
1945 record_segment_res(self, res);
1946 return PathResult::NonModule(PartialRes::with_unresolved_segments(
1950 _ => Err(Determinacy::determined(record_used)),
1957 second_binding = Some(binding);
1959 let res = binding.res();
1960 let maybe_assoc = opt_ns != Some(MacroNS) && PathSource::Type.is_expected(res);
1961 if let Some(next_module) = binding.module() {
1962 module = Some(ModuleOrUniformRoot::Module(next_module));
1963 record_segment_res(self, res);
1964 } else if res == Res::ToolMod && i + 1 != path.len() {
1965 if binding.is_import() {
1966 self.session.struct_span_err(
1967 ident.span, "cannot use a tool module through an import"
1969 binding.span, "the tool module imported here"
1972 let res = Res::NonMacroAttr(NonMacroAttrKind::Tool);
1973 return PathResult::NonModule(PartialRes::new(res));
1974 } else if res == Res::Err {
1975 return PathResult::NonModule(PartialRes::new(Res::Err));
1976 } else if opt_ns.is_some() && (is_last || maybe_assoc) {
1977 self.lint_if_path_starts_with_module(
1983 return PathResult::NonModule(PartialRes::with_unresolved_segments(
1984 res, path.len() - i - 1
1987 let label = format!(
1988 "`{}` is {} {}, not a module",
1994 return PathResult::Failed {
1998 is_error_from_last_segment: is_last,
2002 Err(Undetermined) => return PathResult::Indeterminate,
2003 Err(Determined) => {
2004 if let Some(ModuleOrUniformRoot::Module(module)) = module {
2005 if opt_ns.is_some() && !module.is_normal() {
2006 return PathResult::NonModule(PartialRes::with_unresolved_segments(
2007 module.res().unwrap(), path.len() - i
2011 let module_res = match module {
2012 Some(ModuleOrUniformRoot::Module(module)) => module.res(),
2015 let (label, suggestion) = if module_res == self.graph_root.res() {
2016 let is_mod = |res| {
2017 match res { Res::Def(DefKind::Mod, _) => true, _ => false }
2019 let mut candidates =
2020 self.lookup_import_candidates(ident, TypeNS, is_mod);
2021 candidates.sort_by_cached_key(|c| {
2022 (c.path.segments.len(), c.path.to_string())
2024 if let Some(candidate) = candidates.get(0) {
2026 String::from("unresolved import"),
2028 vec![(ident.span, candidate.path.to_string())],
2029 String::from("a similar path exists"),
2030 Applicability::MaybeIncorrect,
2033 } else if !ident.is_reserved() {
2034 (format!("maybe a missing crate `{}`?", ident), None)
2036 // the parser will already have complained about the keyword being used
2037 return PathResult::NonModule(PartialRes::new(Res::Err));
2040 (format!("use of undeclared type or module `{}`", ident), None)
2042 (format!("could not find `{}` in `{}`", ident, path[i - 1].ident), None)
2044 return PathResult::Failed {
2048 is_error_from_last_segment: is_last,
2054 self.lint_if_path_starts_with_module(crate_lint, path, path_span, second_binding);
2056 PathResult::Module(match module {
2057 Some(module) => module,
2058 None if path.is_empty() => ModuleOrUniformRoot::CurrentScope,
2059 _ => span_bug!(path_span, "resolve_path: non-empty path `{:?}` has no module", path),
2063 fn lint_if_path_starts_with_module(
2065 crate_lint: CrateLint,
2068 second_binding: Option<&NameBinding<'_>>,
2070 let (diag_id, diag_span) = match crate_lint {
2071 CrateLint::No => return,
2072 CrateLint::SimplePath(id) => (id, path_span),
2073 CrateLint::UsePath { root_id, root_span } => (root_id, root_span),
2074 CrateLint::QPathTrait { qpath_id, qpath_span } => (qpath_id, qpath_span),
2077 let first_name = match path.get(0) {
2078 // In the 2018 edition this lint is a hard error, so nothing to do
2079 Some(seg) if seg.ident.span.rust_2015() && self.session.rust_2015() => seg.ident.name,
2083 // We're only interested in `use` paths which should start with
2084 // `{{root}}` currently.
2085 if first_name != kw::PathRoot {
2090 // If this import looks like `crate::...` it's already good
2091 Some(Segment { ident, .. }) if ident.name == kw::Crate => return,
2092 // Otherwise go below to see if it's an extern crate
2094 // If the path has length one (and it's `PathRoot` most likely)
2095 // then we don't know whether we're gonna be importing a crate or an
2096 // item in our crate. Defer this lint to elsewhere
2100 // If the first element of our path was actually resolved to an
2101 // `ExternCrate` (also used for `crate::...`) then no need to issue a
2102 // warning, this looks all good!
2103 if let Some(binding) = second_binding {
2104 if let NameBindingKind::Import { directive: d, .. } = binding.kind {
2105 // Careful: we still want to rewrite paths from
2106 // renamed extern crates.
2107 if let ImportDirectiveSubclass::ExternCrate { source: None, .. } = d.subclass {
2113 let diag = lint::builtin::BuiltinLintDiagnostics
2114 ::AbsPathWithModule(diag_span);
2115 self.session.buffer_lint_with_diagnostic(
2116 lint::builtin::ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE,
2118 "absolute paths must start with `self`, `super`, \
2119 `crate`, or an external crate name in the 2018 edition",
2123 // Validate a local resolution (from ribs).
2124 fn validate_res_from_ribs(
2131 all_ribs: &[Rib<'a>],
2133 debug!("validate_res_from_ribs({:?})", res);
2134 let ribs = &all_ribs[rib_index + 1..];
2136 // An invalid forward use of a type parameter from a previous default.
2137 if let ForwardTyParamBanRibKind = all_ribs[rib_index].kind {
2139 let res_error = if rib_ident.name == kw::SelfUpper {
2140 ResolutionError::SelfInTyParamDefault
2142 ResolutionError::ForwardDeclaredTyParam
2144 self.report_error(span, res_error);
2146 assert_eq!(res, Res::Err);
2150 // An invalid use of a type parameter as the type of a const parameter.
2151 if let TyParamAsConstParamTy = all_ribs[rib_index].kind {
2153 self.report_error(span, ResolutionError::ConstParamDependentOnTypeParam);
2155 assert_eq!(res, Res::Err);
2161 use ResolutionError::*;
2162 let mut res_err = None;
2166 NormalRibKind | ModuleRibKind(..) | MacroDefinition(..) |
2167 ForwardTyParamBanRibKind | TyParamAsConstParamTy => {
2168 // Nothing to do. Continue.
2170 ItemRibKind | FnItemRibKind | AssocItemRibKind => {
2171 // This was an attempt to access an upvar inside a
2172 // named function item. This is not allowed, so we
2175 // We don't immediately trigger a resolve error, because
2176 // we want certain other resolution errors (namely those
2177 // emitted for `ConstantItemRibKind` below) to take
2179 res_err = Some(CannotCaptureDynamicEnvironmentInFnItem);
2182 ConstantItemRibKind => {
2183 // Still doesn't deal with upvars
2185 self.report_error(span, AttemptToUseNonConstantValueInConstant);
2191 if let Some(res_err) = res_err {
2192 self.report_error(span, res_err);
2196 Res::Def(DefKind::TyParam, _) | Res::SelfTy(..) => {
2199 NormalRibKind | AssocItemRibKind |
2200 ModuleRibKind(..) | MacroDefinition(..) | ForwardTyParamBanRibKind |
2201 ConstantItemRibKind | TyParamAsConstParamTy => {
2202 // Nothing to do. Continue.
2204 ItemRibKind | FnItemRibKind => {
2205 // This was an attempt to use a type parameter outside its scope.
2208 span, ResolutionError::GenericParamsFromOuterFunction(res)
2216 Res::Def(DefKind::ConstParam, _) => {
2217 let mut ribs = ribs.iter().peekable();
2218 if let Some(Rib { kind: FnItemRibKind, .. }) = ribs.peek() {
2219 // When declaring const parameters inside function signatures, the first rib
2220 // is always a `FnItemRibKind`. In this case, we can skip it, to avoid it
2221 // (spuriously) conflicting with the const param.
2225 if let ItemRibKind | FnItemRibKind = rib.kind {
2226 // This was an attempt to use a const parameter outside its scope.
2229 span, ResolutionError::GenericParamsFromOuterFunction(res)
2241 fn record_partial_res(&mut self, node_id: NodeId, resolution: PartialRes) {
2242 debug!("(recording res) recording {:?} for {}", resolution, node_id);
2243 if let Some(prev_res) = self.partial_res_map.insert(node_id, resolution) {
2244 panic!("path resolved multiple times ({:?} before, {:?} now)", prev_res, resolution);
2248 fn is_accessible_from(&self, vis: ty::Visibility, module: Module<'a>) -> bool {
2249 vis.is_accessible_from(module.normal_ancestor_id, self)
2252 fn set_binding_parent_module(&mut self, binding: &'a NameBinding<'a>, module: Module<'a>) {
2253 if let Some(old_module) = self.binding_parent_modules.insert(PtrKey(binding), module) {
2254 if !ptr::eq(module, old_module) {
2255 span_bug!(binding.span, "parent module is reset for binding");
2260 fn disambiguate_legacy_vs_modern(
2262 legacy: &'a NameBinding<'a>,
2263 modern: &'a NameBinding<'a>,
2265 // Some non-controversial subset of ambiguities "modern macro name" vs "macro_rules"
2266 // is disambiguated to mitigate regressions from macro modularization.
2267 // Scoping for `macro_rules` behaves like scoping for `let` at module level, in general.
2268 match (self.binding_parent_modules.get(&PtrKey(legacy)),
2269 self.binding_parent_modules.get(&PtrKey(modern))) {
2270 (Some(legacy), Some(modern)) =>
2271 legacy.normal_ancestor_id == modern.normal_ancestor_id &&
2272 modern.is_ancestor_of(legacy),
2277 fn binding_description(&self, b: &NameBinding<'_>, ident: Ident, from_prelude: bool) -> String {
2279 if b.span.is_dummy() {
2280 let add_built_in = match b.res() {
2281 // These already contain the "built-in" prefix or look bad with it.
2282 Res::NonMacroAttr(..) | Res::PrimTy(..) | Res::ToolMod => false,
2285 let (built_in, from) = if from_prelude {
2286 ("", " from prelude")
2287 } else if b.is_extern_crate() && !b.is_import() &&
2288 self.session.opts.externs.get(&ident.as_str()).is_some() {
2289 ("", " passed with `--extern`")
2290 } else if add_built_in {
2296 let article = if built_in.is_empty() { res.article() } else { "a" };
2297 format!("{a}{built_in} {thing}{from}",
2298 a = article, thing = res.descr(), built_in = built_in, from = from)
2300 let introduced = if b.is_import() { "imported" } else { "defined" };
2301 format!("the {thing} {introduced} here",
2302 thing = res.descr(), introduced = introduced)
2306 fn report_ambiguity_error(&self, ambiguity_error: &AmbiguityError<'_>) {
2307 let AmbiguityError { kind, ident, b1, b2, misc1, misc2 } = *ambiguity_error;
2308 let (b1, b2, misc1, misc2, swapped) = if b2.span.is_dummy() && !b1.span.is_dummy() {
2309 // We have to print the span-less alternative first, otherwise formatting looks bad.
2310 (b2, b1, misc2, misc1, true)
2312 (b1, b2, misc1, misc2, false)
2315 let mut err = struct_span_err!(self.session, ident.span, E0659,
2316 "`{ident}` is ambiguous ({why})",
2317 ident = ident, why = kind.descr());
2318 err.span_label(ident.span, "ambiguous name");
2320 let mut could_refer_to = |b: &NameBinding<'_>, misc: AmbiguityErrorMisc, also: &str| {
2321 let what = self.binding_description(b, ident, misc == AmbiguityErrorMisc::FromPrelude);
2322 let note_msg = format!("`{ident}` could{also} refer to {what}",
2323 ident = ident, also = also, what = what);
2325 let thing = b.res().descr();
2326 let mut help_msgs = Vec::new();
2327 if b.is_glob_import() && (kind == AmbiguityKind::GlobVsGlob ||
2328 kind == AmbiguityKind::GlobVsExpanded ||
2329 kind == AmbiguityKind::GlobVsOuter &&
2330 swapped != also.is_empty()) {
2331 help_msgs.push(format!("consider adding an explicit import of \
2332 `{ident}` to disambiguate", ident = ident))
2334 if b.is_extern_crate() && ident.span.rust_2018() {
2335 help_msgs.push(format!(
2336 "use `::{ident}` to refer to this {thing} unambiguously",
2337 ident = ident, thing = thing,
2340 if misc == AmbiguityErrorMisc::SuggestCrate {
2341 help_msgs.push(format!(
2342 "use `crate::{ident}` to refer to this {thing} unambiguously",
2343 ident = ident, thing = thing,
2345 } else if misc == AmbiguityErrorMisc::SuggestSelf {
2346 help_msgs.push(format!(
2347 "use `self::{ident}` to refer to this {thing} unambiguously",
2348 ident = ident, thing = thing,
2352 err.span_note(b.span, ¬e_msg);
2353 for (i, help_msg) in help_msgs.iter().enumerate() {
2354 let or = if i == 0 { "" } else { "or " };
2355 err.help(&format!("{}{}", or, help_msg));
2359 could_refer_to(b1, misc1, "");
2360 could_refer_to(b2, misc2, " also");
2364 fn report_errors(&mut self, krate: &Crate) {
2365 self.report_with_use_injections(krate);
2367 for &(span_use, span_def) in &self.macro_expanded_macro_export_errors {
2368 let msg = "macro-expanded `macro_export` macros from the current crate \
2369 cannot be referred to by absolute paths";
2370 self.session.buffer_lint_with_diagnostic(
2371 lint::builtin::MACRO_EXPANDED_MACRO_EXPORTS_ACCESSED_BY_ABSOLUTE_PATHS,
2372 CRATE_NODE_ID, span_use, msg,
2373 lint::builtin::BuiltinLintDiagnostics::
2374 MacroExpandedMacroExportsAccessedByAbsolutePaths(span_def),
2378 for ambiguity_error in &self.ambiguity_errors {
2379 self.report_ambiguity_error(ambiguity_error);
2382 let mut reported_spans = FxHashSet::default();
2383 for &PrivacyError(dedup_span, ident, binding) in &self.privacy_errors {
2384 if reported_spans.insert(dedup_span) {
2385 let mut err = struct_span_err!(
2389 "{} `{}` is private",
2390 binding.res().descr(),
2393 // FIXME: use the ctor's `def_id` to check wether any of the fields is not visible
2394 match binding.kind {
2395 NameBindingKind::Res(Res::Def(DefKind::Ctor(
2398 ), _def_id), _) => {
2399 err.note("a tuple struct constructor is private if any of its fields \
2402 NameBindingKind::Res(Res::Def(DefKind::Ctor(
2405 ), _def_id), _) => {
2406 err.note("a tuple variant constructor is private if any of its fields \
2416 fn report_with_use_injections(&mut self, krate: &Crate) {
2417 for UseError { mut err, candidates, node_id, better } in self.use_injections.drain(..) {
2418 let (span, found_use) = UsePlacementFinder::check(krate, node_id);
2419 if !candidates.is_empty() {
2420 diagnostics::show_candidates(&mut err, span, &candidates, better, found_use);
2426 fn report_conflict<'b>(&mut self,
2430 new_binding: &NameBinding<'b>,
2431 old_binding: &NameBinding<'b>) {
2432 // Error on the second of two conflicting names
2433 if old_binding.span.lo() > new_binding.span.lo() {
2434 return self.report_conflict(parent, ident, ns, old_binding, new_binding);
2437 let container = match parent.kind {
2438 ModuleKind::Def(DefKind::Mod, _, _) => "module",
2439 ModuleKind::Def(DefKind::Trait, _, _) => "trait",
2440 ModuleKind::Block(..) => "block",
2444 let old_noun = match old_binding.is_import() {
2446 false => "definition",
2449 let new_participle = match new_binding.is_import() {
2454 let (name, span) = (ident.name, self.session.source_map().def_span(new_binding.span));
2456 if let Some(s) = self.name_already_seen.get(&name) {
2462 let old_kind = match (ns, old_binding.module()) {
2463 (ValueNS, _) => "value",
2464 (MacroNS, _) => "macro",
2465 (TypeNS, _) if old_binding.is_extern_crate() => "extern crate",
2466 (TypeNS, Some(module)) if module.is_normal() => "module",
2467 (TypeNS, Some(module)) if module.is_trait() => "trait",
2468 (TypeNS, _) => "type",
2471 let msg = format!("the name `{}` is defined multiple times", name);
2473 let mut err = match (old_binding.is_extern_crate(), new_binding.is_extern_crate()) {
2474 (true, true) => struct_span_err!(self.session, span, E0259, "{}", msg),
2475 (true, _) | (_, true) => match new_binding.is_import() && old_binding.is_import() {
2476 true => struct_span_err!(self.session, span, E0254, "{}", msg),
2477 false => struct_span_err!(self.session, span, E0260, "{}", msg),
2479 _ => match (old_binding.is_import(), new_binding.is_import()) {
2480 (false, false) => struct_span_err!(self.session, span, E0428, "{}", msg),
2481 (true, true) => struct_span_err!(self.session, span, E0252, "{}", msg),
2482 _ => struct_span_err!(self.session, span, E0255, "{}", msg),
2486 err.note(&format!("`{}` must be defined only once in the {} namespace of this {}",
2491 err.span_label(span, format!("`{}` re{} here", name, new_participle));
2493 self.session.source_map().def_span(old_binding.span),
2494 format!("previous {} of the {} `{}` here", old_noun, old_kind, name),
2497 // See https://github.com/rust-lang/rust/issues/32354
2498 use NameBindingKind::Import;
2499 let directive = match (&new_binding.kind, &old_binding.kind) {
2500 // If there are two imports where one or both have attributes then prefer removing the
2501 // import without attributes.
2502 (Import { directive: new, .. }, Import { directive: old, .. }) if {
2503 !new_binding.span.is_dummy() && !old_binding.span.is_dummy() &&
2504 (new.has_attributes || old.has_attributes)
2506 if old.has_attributes {
2507 Some((new, new_binding.span, true))
2509 Some((old, old_binding.span, true))
2512 // Otherwise prioritize the new binding.
2513 (Import { directive, .. }, other) if !new_binding.span.is_dummy() =>
2514 Some((directive, new_binding.span, other.is_import())),
2515 (other, Import { directive, .. }) if !old_binding.span.is_dummy() =>
2516 Some((directive, old_binding.span, other.is_import())),
2520 // Check if the target of the use for both bindings is the same.
2521 let duplicate = new_binding.res().opt_def_id() == old_binding.res().opt_def_id();
2522 let has_dummy_span = new_binding.span.is_dummy() || old_binding.span.is_dummy();
2523 let from_item = self.extern_prelude.get(&ident)
2524 .map(|entry| entry.introduced_by_item)
2526 // Only suggest removing an import if both bindings are to the same def, if both spans
2527 // aren't dummy spans. Further, if both bindings are imports, then the ident must have
2528 // been introduced by a item.
2529 let should_remove_import = duplicate && !has_dummy_span &&
2530 ((new_binding.is_extern_crate() || old_binding.is_extern_crate()) || from_item);
2533 Some((directive, span, true)) if should_remove_import && directive.is_nested() =>
2534 self.add_suggestion_for_duplicate_nested_use(&mut err, directive, span),
2535 Some((directive, _, true)) if should_remove_import && !directive.is_glob() => {
2536 // Simple case - remove the entire import. Due to the above match arm, this can
2537 // only be a single use so just remove it entirely.
2538 err.tool_only_span_suggestion(
2539 directive.use_span_with_attributes,
2540 "remove unnecessary import",
2542 Applicability::MaybeIncorrect,
2545 Some((directive, span, _)) =>
2546 self.add_suggestion_for_rename_of_use(&mut err, name, directive, span),
2551 self.name_already_seen.insert(name, span);
2554 /// This function adds a suggestion to change the binding name of a new import that conflicts
2555 /// with an existing import.
2557 /// ```ignore (diagnostic)
2558 /// help: you can use `as` to change the binding name of the import
2560 /// LL | use foo::bar as other_bar;
2561 /// | ^^^^^^^^^^^^^^^^^^^^^
2563 fn add_suggestion_for_rename_of_use(
2565 err: &mut DiagnosticBuilder<'_>,
2567 directive: &ImportDirective<'_>,
2570 let suggested_name = if name.as_str().chars().next().unwrap().is_uppercase() {
2571 format!("Other{}", name)
2573 format!("other_{}", name)
2576 let mut suggestion = None;
2577 match directive.subclass {
2578 ImportDirectiveSubclass::SingleImport { type_ns_only: true, .. } =>
2579 suggestion = Some(format!("self as {}", suggested_name)),
2580 ImportDirectiveSubclass::SingleImport { source, .. } => {
2581 if let Some(pos) = source.span.hi().0.checked_sub(binding_span.lo().0)
2582 .map(|pos| pos as usize) {
2583 if let Ok(snippet) = self.session.source_map()
2584 .span_to_snippet(binding_span) {
2585 if pos <= snippet.len() {
2586 suggestion = Some(format!(
2590 if snippet.ends_with(";") { ";" } else { "" }
2596 ImportDirectiveSubclass::ExternCrate { source, target, .. } =>
2597 suggestion = Some(format!(
2598 "extern crate {} as {};",
2599 source.unwrap_or(target.name),
2602 _ => unreachable!(),
2605 let rename_msg = "you can use `as` to change the binding name of the import";
2606 if let Some(suggestion) = suggestion {
2607 err.span_suggestion(
2611 Applicability::MaybeIncorrect,
2614 err.span_label(binding_span, rename_msg);
2618 /// This function adds a suggestion to remove a unnecessary binding from an import that is
2619 /// nested. In the following example, this function will be invoked to remove the `a` binding
2620 /// in the second use statement:
2622 /// ```ignore (diagnostic)
2623 /// use issue_52891::a;
2624 /// use issue_52891::{d, a, e};
2627 /// The following suggestion will be added:
2629 /// ```ignore (diagnostic)
2630 /// use issue_52891::{d, a, e};
2631 /// ^-- help: remove unnecessary import
2634 /// If the nested use contains only one import then the suggestion will remove the entire
2637 /// It is expected that the directive provided is a nested import - this isn't checked by the
2638 /// function. If this invariant is not upheld, this function's behaviour will be unexpected
2639 /// as characters expected by span manipulations won't be present.
2640 fn add_suggestion_for_duplicate_nested_use(
2642 err: &mut DiagnosticBuilder<'_>,
2643 directive: &ImportDirective<'_>,
2646 assert!(directive.is_nested());
2647 let message = "remove unnecessary import";
2649 // Two examples will be used to illustrate the span manipulations we're doing:
2651 // - Given `use issue_52891::{d, a, e};` where `a` is a duplicate then `binding_span` is
2652 // `a` and `directive.use_span` is `issue_52891::{d, a, e};`.
2653 // - Given `use issue_52891::{d, e, a};` where `a` is a duplicate then `binding_span` is
2654 // `a` and `directive.use_span` is `issue_52891::{d, e, a};`.
2656 let (found_closing_brace, span) = find_span_of_binding_until_next_binding(
2657 self.session, binding_span, directive.use_span,
2660 // If there was a closing brace then identify the span to remove any trailing commas from
2661 // previous imports.
2662 if found_closing_brace {
2663 if let Some(span) = extend_span_to_previous_binding(self.session, span) {
2664 err.tool_only_span_suggestion(span, message, String::new(),
2665 Applicability::MaybeIncorrect);
2667 // Remove the entire line if we cannot extend the span back, this indicates a
2668 // `issue_52891::{self}` case.
2669 err.span_suggestion(directive.use_span_with_attributes, message, String::new(),
2670 Applicability::MaybeIncorrect);
2676 err.span_suggestion(span, message, String::new(), Applicability::MachineApplicable);
2679 fn extern_prelude_get(&mut self, ident: Ident, speculative: bool)
2680 -> Option<&'a NameBinding<'a>> {
2681 if ident.is_path_segment_keyword() {
2682 // Make sure `self`, `super` etc produce an error when passed to here.
2685 self.extern_prelude.get(&ident.modern()).cloned().and_then(|entry| {
2686 if let Some(binding) = entry.extern_crate_item {
2687 if !speculative && entry.introduced_by_item {
2688 self.record_use(ident, TypeNS, binding, false);
2692 let crate_id = if !speculative {
2693 self.crate_loader.process_path_extern(ident.name, ident.span)
2694 } else if let Some(crate_id) =
2695 self.crate_loader.maybe_process_path_extern(ident.name, ident.span) {
2700 let crate_root = self.get_module(DefId { krate: crate_id, index: CRATE_DEF_INDEX });
2701 Some((crate_root, ty::Visibility::Public, DUMMY_SP, ExpnId::root())
2702 .to_name_binding(self.arenas))
2707 /// Rustdoc uses this to resolve things in a recoverable way. `ResolutionError<'a>`
2708 /// isn't something that can be returned because it can't be made to live that long,
2709 /// and also it's a private type. Fortunately rustdoc doesn't need to know the error,
2710 /// just that an error occurred.
2711 // FIXME(Manishearth): intra-doc links won't get warned of epoch changes.
2712 pub fn resolve_str_path_error(
2713 &mut self, span: Span, path_str: &str, ns: Namespace, module_id: NodeId
2714 ) -> Result<(ast::Path, Res), ()> {
2715 let path = if path_str.starts_with("::") {
2718 segments: iter::once(Ident::with_dummy_span(kw::PathRoot))
2720 path_str.split("::").skip(1).map(Ident::from_str)
2722 .map(|i| self.new_ast_path_segment(i))
2730 .map(Ident::from_str)
2731 .map(|i| self.new_ast_path_segment(i))
2735 let module = self.block_map.get(&module_id).copied().unwrap_or_else(|| {
2736 let def_id = self.definitions.local_def_id(module_id);
2737 self.module_map.get(&def_id).copied().unwrap_or(self.graph_root)
2739 let parent_scope = &ParentScope::module(module);
2740 let res = self.resolve_ast_path(&path, ns, parent_scope).map_err(|_| ())?;
2744 // Resolve a path passed from rustdoc or HIR lowering.
2745 fn resolve_ast_path(
2749 parent_scope: &ParentScope<'a>,
2750 ) -> Result<Res, (Span, ResolutionError<'a>)> {
2751 match self.resolve_path(
2752 &Segment::from_path(path), Some(ns), parent_scope, true, path.span, CrateLint::No
2754 PathResult::Module(ModuleOrUniformRoot::Module(module)) =>
2755 Ok(module.res().unwrap()),
2756 PathResult::NonModule(path_res) if path_res.unresolved_segments() == 0 =>
2757 Ok(path_res.base_res()),
2758 PathResult::NonModule(..) => {
2759 Err((path.span, ResolutionError::FailedToResolve {
2760 label: String::from("type-relative paths are not supported in this context"),
2764 PathResult::Module(..) | PathResult::Indeterminate => unreachable!(),
2765 PathResult::Failed { span, label, suggestion, .. } => {
2766 Err((span, ResolutionError::FailedToResolve {
2774 fn new_ast_path_segment(&self, ident: Ident) -> ast::PathSegment {
2775 let mut seg = ast::PathSegment::from_ident(ident);
2776 seg.id = self.session.next_node_id();
2781 fn names_to_string(names: &[Name]) -> String {
2782 let mut result = String::new();
2783 for (i, name) in names.iter()
2784 .filter(|name| **name != kw::PathRoot)
2787 result.push_str("::");
2789 result.push_str(&name.as_str());
2794 fn path_names_to_string(path: &Path) -> String {
2795 names_to_string(&path.segments.iter()
2796 .map(|seg| seg.ident.name)
2797 .collect::<Vec<_>>())
2800 /// A somewhat inefficient routine to obtain the name of a module.
2801 fn module_to_string(module: Module<'_>) -> Option<String> {
2802 let mut names = Vec::new();
2804 fn collect_mod(names: &mut Vec<Name>, module: Module<'_>) {
2805 if let ModuleKind::Def(.., name) = module.kind {
2806 if let Some(parent) = module.parent {
2808 collect_mod(names, parent);
2811 names.push(Name::intern("<opaque>"));
2812 collect_mod(names, module.parent.unwrap());
2815 collect_mod(&mut names, module);
2817 if names.is_empty() {
2821 Some(names_to_string(&names))
2824 #[derive(Copy, Clone, Debug)]
2826 /// Do not issue the lint.
2829 /// This lint applies to some arbitrary path; e.g., `impl ::foo::Bar`.
2830 /// In this case, we can take the span of that path.
2833 /// This lint comes from a `use` statement. In this case, what we
2834 /// care about really is the *root* `use` statement; e.g., if we
2835 /// have nested things like `use a::{b, c}`, we care about the
2837 UsePath { root_id: NodeId, root_span: Span },
2839 /// This is the "trait item" from a fully qualified path. For example,
2840 /// we might be resolving `X::Y::Z` from a path like `<T as X::Y>::Z`.
2841 /// The `path_span` is the span of the to the trait itself (`X::Y`).
2842 QPathTrait { qpath_id: NodeId, qpath_span: Span },
2846 fn node_id(&self) -> Option<NodeId> {
2848 CrateLint::No => None,
2849 CrateLint::SimplePath(id) |
2850 CrateLint::UsePath { root_id: id, .. } |
2851 CrateLint::QPathTrait { qpath_id: id, .. } => Some(id),