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;
61 use rustc_data_structures::fx::FxIndexMap;
63 use diagnostics::{Suggestion, ImportSuggestion};
64 use diagnostics::{find_span_of_binding_until_next_binding, extend_span_to_previous_binding};
65 use late::{PathSource, Rib, RibKind::*};
66 use resolve_imports::{ImportDirective, ImportDirectiveSubclass, NameResolution, ImportResolver};
67 use macros::{LegacyBinding, LegacyScope};
69 type Res = def::Res<NodeId>;
76 mod build_reduced_graph;
79 const KNOWN_TOOLS: &[Name] = &[sym::clippy, sym::rustfmt];
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)]
104 MacroRules(LegacyScope<'a>),
116 /// Names from different contexts may want to visit different subsets of all specific scopes
117 /// with different restrictions when looking up the resolution.
118 /// This enum is currently used only for early resolution (imports and macros),
119 /// but not for late resolution yet.
121 /// All scopes with the given namespace.
122 All(Namespace, /*is_import*/ bool),
123 /// Crate root, then extern prelude (used for mixed 2015-2018 mode in macros).
124 AbsolutePath(Namespace),
125 /// All scopes with macro namespace and the given macro kind restriction.
129 /// Everything you need to know about a name's location to resolve it.
130 /// Serves as a starting point for the scope visitor.
131 /// This struct is currently used only for early resolution (imports and macros),
132 /// but not for late resolution yet.
133 #[derive(Clone, Copy, Debug)]
134 pub struct ParentScope<'a> {
137 legacy: LegacyScope<'a>,
138 derives: &'a [ast::Path],
141 impl<'a> ParentScope<'a> {
142 /// Creates a parent scope with the passed argument used as the module scope component,
143 /// and other scope components set to default empty values.
144 pub fn module(module: Module<'a>) -> ParentScope<'a> {
147 expansion: ExpnId::root(),
148 legacy: LegacyScope::Empty,
155 struct BindingError {
157 origin: BTreeSet<Span>,
158 target: BTreeSet<Span>,
162 impl PartialOrd for BindingError {
163 fn partial_cmp(&self, other: &BindingError) -> Option<cmp::Ordering> {
164 Some(self.cmp(other))
168 impl PartialEq for BindingError {
169 fn eq(&self, other: &BindingError) -> bool {
170 self.name == other.name
174 impl Ord for BindingError {
175 fn cmp(&self, other: &BindingError) -> cmp::Ordering {
176 self.name.cmp(&other.name)
180 enum ResolutionError<'a> {
181 /// Error E0401: can't use type or const parameters from outer function.
182 GenericParamsFromOuterFunction(Res),
183 /// Error E0403: the name is already used for a type or const parameter in this generic
185 NameAlreadyUsedInParameterList(Name, Span),
186 /// Error E0407: method is not a member of trait.
187 MethodNotMemberOfTrait(Name, &'a str),
188 /// Error E0437: type is not a member of trait.
189 TypeNotMemberOfTrait(Name, &'a str),
190 /// Error E0438: const is not a member of trait.
191 ConstNotMemberOfTrait(Name, &'a str),
192 /// Error E0408: variable `{}` is not bound in all patterns.
193 VariableNotBoundInPattern(&'a BindingError),
194 /// Error E0409: variable `{}` is bound in inconsistent ways within the same match arm.
195 VariableBoundWithDifferentMode(Name, Span),
196 /// Error E0415: identifier is bound more than once in this parameter list.
197 IdentifierBoundMoreThanOnceInParameterList(&'a str),
198 /// Error E0416: identifier is bound more than once in the same pattern.
199 IdentifierBoundMoreThanOnceInSamePattern(&'a str),
200 /// Error E0426: use of undeclared label.
201 UndeclaredLabel(&'a str, Option<Name>),
202 /// Error E0429: `self` imports are only allowed within a `{ }` list.
203 SelfImportsOnlyAllowedWithin,
204 /// Error E0430: `self` import can only appear once in the list.
205 SelfImportCanOnlyAppearOnceInTheList,
206 /// Error E0431: `self` import can only appear in an import list with a non-empty prefix.
207 SelfImportOnlyInImportListWithNonEmptyPrefix,
208 /// Error E0433: failed to resolve.
209 FailedToResolve { label: String, suggestion: Option<Suggestion> },
210 /// Error E0434: can't capture dynamic environment in a fn item.
211 CannotCaptureDynamicEnvironmentInFnItem,
212 /// Error E0435: attempt to use a non-constant value in a constant.
213 AttemptToUseNonConstantValueInConstant,
214 /// Error E0530: `X` bindings cannot shadow `Y`s.
215 BindingShadowsSomethingUnacceptable(&'a str, Name, &'a NameBinding<'a>),
216 /// Error E0128: type parameters with a default cannot use forward-declared identifiers.
217 ForwardDeclaredTyParam, // FIXME(const_generics:defaults)
218 /// Error E0735: type parameters with a default cannot use `Self`
219 SelfInTyParamDefault,
220 /// Error E0671: const parameter cannot depend on type parameter.
221 ConstParamDependentOnTypeParam,
224 // A minimal representation of a path segment. We use this in resolve because
225 // we synthesize 'path segments' which don't have the rest of an AST or HIR
227 #[derive(Clone, Copy, Debug)]
234 fn from_path(path: &Path) -> Vec<Segment> {
235 path.segments.iter().map(|s| s.into()).collect()
238 fn from_ident(ident: Ident) -> Segment {
245 fn names_to_string(segments: &[Segment]) -> String {
246 names_to_string(&segments.iter()
247 .map(|seg| seg.ident.name)
248 .collect::<Vec<_>>())
252 impl<'a> From<&'a ast::PathSegment> for Segment {
253 fn from(seg: &'a ast::PathSegment) -> Segment {
261 struct UsePlacementFinder {
262 target_module: NodeId,
267 impl UsePlacementFinder {
268 fn check(krate: &Crate, target_module: NodeId) -> (Option<Span>, bool) {
269 let mut finder = UsePlacementFinder {
274 visit::walk_crate(&mut finder, krate);
275 (finder.span, finder.found_use)
279 impl<'tcx> Visitor<'tcx> for UsePlacementFinder {
282 module: &'tcx ast::Mod,
284 _: &[ast::Attribute],
287 if self.span.is_some() {
290 if node_id != self.target_module {
291 visit::walk_mod(self, module);
294 // find a use statement
295 for item in &module.items {
297 ItemKind::Use(..) => {
298 // don't suggest placing a use before the prelude
299 // import or other generated ones
300 if !item.span.from_expansion() {
301 self.span = Some(item.span.shrink_to_lo());
302 self.found_use = true;
306 // don't place use before extern crate
307 ItemKind::ExternCrate(_) => {}
308 // but place them before the first other item
309 _ => if self.span.map_or(true, |span| item.span < span ) {
310 if !item.span.from_expansion() {
311 // don't insert between attributes and an item
312 if item.attrs.is_empty() {
313 self.span = Some(item.span.shrink_to_lo());
315 // find the first attribute on the item
316 for attr in &item.attrs {
317 if self.span.map_or(true, |span| attr.span < span) {
318 self.span = Some(attr.span.shrink_to_lo());
329 /// An intermediate resolution result.
331 /// This refers to the thing referred by a name. The difference between `Res` and `Item` is that
332 /// items are visible in their whole block, while `Res`es only from the place they are defined
335 enum LexicalScopeBinding<'a> {
336 Item(&'a NameBinding<'a>),
340 impl<'a> LexicalScopeBinding<'a> {
341 fn item(self) -> Option<&'a NameBinding<'a>> {
343 LexicalScopeBinding::Item(binding) => Some(binding),
348 fn res(self) -> Res {
350 LexicalScopeBinding::Item(binding) => binding.res(),
351 LexicalScopeBinding::Res(res) => res,
356 #[derive(Copy, Clone, Debug)]
357 enum ModuleOrUniformRoot<'a> {
361 /// Virtual module that denotes resolution in crate root with fallback to extern prelude.
362 CrateRootAndExternPrelude,
364 /// Virtual module that denotes resolution in extern prelude.
365 /// Used for paths starting with `::` on 2018 edition.
368 /// Virtual module that denotes resolution in current scope.
369 /// Used only for resolving single-segment imports. The reason it exists is that import paths
370 /// are always split into two parts, the first of which should be some kind of module.
374 impl ModuleOrUniformRoot<'_> {
375 fn same_def(lhs: Self, rhs: Self) -> bool {
377 (ModuleOrUniformRoot::Module(lhs),
378 ModuleOrUniformRoot::Module(rhs)) => lhs.def_id() == rhs.def_id(),
379 (ModuleOrUniformRoot::CrateRootAndExternPrelude,
380 ModuleOrUniformRoot::CrateRootAndExternPrelude) |
381 (ModuleOrUniformRoot::ExternPrelude, ModuleOrUniformRoot::ExternPrelude) |
382 (ModuleOrUniformRoot::CurrentScope, ModuleOrUniformRoot::CurrentScope) => true,
388 #[derive(Clone, Debug)]
389 enum PathResult<'a> {
390 Module(ModuleOrUniformRoot<'a>),
391 NonModule(PartialRes),
396 suggestion: Option<Suggestion>,
397 is_error_from_last_segment: bool,
402 /// An anonymous module; e.g., just a block.
407 /// { // This is an anonymous module
408 /// f(); // This resolves to (2) as we are inside the block.
411 /// f(); // Resolves to (1)
415 /// Any module with a name.
419 /// * A normal module ‒ either `mod from_file;` or `mod from_block { }`.
420 /// * A trait or an enum (it implicitly contains associated types, methods and variant
422 Def(DefKind, DefId, Name),
426 /// Get name of the module.
427 pub fn name(&self) -> Option<Name> {
429 ModuleKind::Block(..) => None,
430 ModuleKind::Def(.., name) => Some(*name),
435 type Resolutions<'a> = RefCell<FxIndexMap<(Ident, Namespace), &'a RefCell<NameResolution<'a>>>>;
437 /// One node in the tree of modules.
438 pub struct ModuleData<'a> {
439 parent: Option<Module<'a>>,
442 // The def id of the closest normal module (`mod`) ancestor (including this module).
443 normal_ancestor_id: DefId,
445 // Mapping between names and their (possibly in-progress) resolutions in this module.
446 // Resolutions in modules from other crates are not populated until accessed.
447 lazy_resolutions: Resolutions<'a>,
448 // True if this is a module from other crate that needs to be populated on access.
449 populate_on_access: Cell<bool>,
451 // Macro invocations that can expand into items in this module.
452 unexpanded_invocations: RefCell<FxHashSet<ExpnId>>,
454 no_implicit_prelude: bool,
456 glob_importers: RefCell<Vec<&'a ImportDirective<'a>>>,
457 globs: RefCell<Vec<&'a ImportDirective<'a>>>,
459 // Used to memoize the traits in this module for faster searches through all traits in scope.
460 traits: RefCell<Option<Box<[(Ident, &'a NameBinding<'a>)]>>>,
462 /// Span of the module itself. Used for error reporting.
468 type Module<'a> = &'a ModuleData<'a>;
470 impl<'a> ModuleData<'a> {
471 fn new(parent: Option<Module<'a>>,
473 normal_ancestor_id: DefId,
475 span: Span) -> Self {
480 lazy_resolutions: Default::default(),
481 populate_on_access: Cell::new(!normal_ancestor_id.is_local()),
482 unexpanded_invocations: Default::default(),
483 no_implicit_prelude: false,
484 glob_importers: RefCell::new(Vec::new()),
485 globs: RefCell::new(Vec::new()),
486 traits: RefCell::new(None),
492 fn for_each_child<R, F>(&'a self, resolver: &mut R, mut f: F)
493 where R: AsMut<Resolver<'a>>, F: FnMut(&mut R, Ident, Namespace, &'a NameBinding<'a>)
495 for (&(ident, ns), name_resolution) in resolver.as_mut().resolutions(self).borrow().iter() {
496 name_resolution.borrow().binding.map(|binding| f(resolver, ident, ns, binding));
500 fn res(&self) -> Option<Res> {
502 ModuleKind::Def(kind, def_id, _) => Some(Res::Def(kind, def_id)),
507 fn def_id(&self) -> Option<DefId> {
509 ModuleKind::Def(_, def_id, _) => Some(def_id),
514 // `self` resolves to the first module ancestor that `is_normal`.
515 fn is_normal(&self) -> bool {
517 ModuleKind::Def(DefKind::Mod, _, _) => true,
522 fn is_trait(&self) -> bool {
524 ModuleKind::Def(DefKind::Trait, _, _) => true,
529 fn nearest_item_scope(&'a self) -> Module<'a> {
531 ModuleKind::Def(DefKind::Enum, ..) | ModuleKind::Def(DefKind::Trait, ..) =>
532 self.parent.expect("enum or trait module without a parent"),
537 fn is_ancestor_of(&self, mut other: &Self) -> bool {
538 while !ptr::eq(self, other) {
539 if let Some(parent) = other.parent {
549 impl<'a> fmt::Debug for ModuleData<'a> {
550 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
551 write!(f, "{:?}", self.res())
555 /// Records a possibly-private value, type, or module definition.
556 #[derive(Clone, Debug)]
557 pub struct NameBinding<'a> {
558 kind: NameBindingKind<'a>,
559 ambiguity: Option<(&'a NameBinding<'a>, AmbiguityKind)>,
565 pub trait ToNameBinding<'a> {
566 fn to_name_binding(self, arenas: &'a ResolverArenas<'a>) -> &'a NameBinding<'a>;
569 impl<'a> ToNameBinding<'a> for &'a NameBinding<'a> {
570 fn to_name_binding(self, _: &'a ResolverArenas<'a>) -> &'a NameBinding<'a> {
575 #[derive(Clone, Debug)]
576 enum NameBindingKind<'a> {
577 Res(Res, /* is_macro_export */ bool),
580 binding: &'a NameBinding<'a>,
581 directive: &'a ImportDirective<'a>,
586 impl<'a> NameBindingKind<'a> {
587 /// Is this a name binding of a import?
588 fn is_import(&self) -> bool {
590 NameBindingKind::Import { .. } => true,
596 struct PrivacyError<'a>(Span, Ident, &'a NameBinding<'a>);
598 struct UseError<'a> {
599 err: DiagnosticBuilder<'a>,
600 /// Attach `use` statements for these candidates.
601 candidates: Vec<ImportSuggestion>,
602 /// The `NodeId` of the module to place the use-statements in.
604 /// Whether the diagnostic should state that it's "better".
608 #[derive(Clone, Copy, PartialEq, Debug)]
613 LegacyHelperVsPrelude,
622 fn descr(self) -> &'static str {
624 AmbiguityKind::Import =>
625 "name vs any other name during import resolution",
626 AmbiguityKind::BuiltinAttr =>
627 "built-in attribute vs any other name",
628 AmbiguityKind::DeriveHelper =>
629 "derive helper attribute vs any other name",
630 AmbiguityKind::LegacyHelperVsPrelude =>
631 "legacy plugin helper attribute vs name from prelude",
632 AmbiguityKind::LegacyVsModern =>
633 "`macro_rules` vs non-`macro_rules` from other module",
634 AmbiguityKind::GlobVsOuter =>
635 "glob import vs any other name from outer scope during import/macro resolution",
636 AmbiguityKind::GlobVsGlob =>
637 "glob import vs glob import in the same module",
638 AmbiguityKind::GlobVsExpanded =>
639 "glob import vs macro-expanded name in the same \
640 module during import/macro resolution",
641 AmbiguityKind::MoreExpandedVsOuter =>
642 "macro-expanded name vs less macro-expanded name \
643 from outer scope during import/macro resolution",
648 /// Miscellaneous bits of metadata for better ambiguity error reporting.
649 #[derive(Clone, Copy, PartialEq)]
650 enum AmbiguityErrorMisc {
657 struct AmbiguityError<'a> {
660 b1: &'a NameBinding<'a>,
661 b2: &'a NameBinding<'a>,
662 misc1: AmbiguityErrorMisc,
663 misc2: AmbiguityErrorMisc,
666 impl<'a> NameBinding<'a> {
667 fn module(&self) -> Option<Module<'a>> {
669 NameBindingKind::Module(module) => Some(module),
670 NameBindingKind::Import { binding, .. } => binding.module(),
675 fn res(&self) -> Res {
677 NameBindingKind::Res(res, _) => res,
678 NameBindingKind::Module(module) => module.res().unwrap(),
679 NameBindingKind::Import { binding, .. } => binding.res(),
683 fn is_ambiguity(&self) -> bool {
684 self.ambiguity.is_some() || match self.kind {
685 NameBindingKind::Import { binding, .. } => binding.is_ambiguity(),
690 // We sometimes need to treat variants as `pub` for backwards compatibility.
691 fn pseudo_vis(&self) -> ty::Visibility {
692 if self.is_variant() && self.res().def_id().is_local() {
693 ty::Visibility::Public
699 fn is_variant(&self) -> bool {
701 NameBindingKind::Res(Res::Def(DefKind::Variant, _), _) |
702 NameBindingKind::Res(Res::Def(DefKind::Ctor(CtorOf::Variant, ..), _), _) => true,
707 fn is_extern_crate(&self) -> bool {
709 NameBindingKind::Import {
710 directive: &ImportDirective {
711 subclass: ImportDirectiveSubclass::ExternCrate { .. }, ..
714 NameBindingKind::Module(
715 &ModuleData { kind: ModuleKind::Def(DefKind::Mod, def_id, _), .. }
716 ) => def_id.index == CRATE_DEF_INDEX,
721 fn is_import(&self) -> bool {
723 NameBindingKind::Import { .. } => true,
728 fn is_glob_import(&self) -> bool {
730 NameBindingKind::Import { directive, .. } => directive.is_glob(),
735 fn is_importable(&self) -> bool {
737 Res::Def(DefKind::AssocConst, _)
738 | Res::Def(DefKind::Method, _)
739 | Res::Def(DefKind::AssocTy, _) => false,
744 fn is_macro_def(&self) -> bool {
746 NameBindingKind::Res(Res::Def(DefKind::Macro(..), _), _) => true,
751 fn macro_kind(&self) -> Option<MacroKind> {
752 self.res().macro_kind()
755 // Suppose that we resolved macro invocation with `invoc_parent_expansion` to binding `binding`
756 // at some expansion round `max(invoc, binding)` when they both emerged from macros.
757 // Then this function returns `true` if `self` may emerge from a macro *after* that
758 // in some later round and screw up our previously found resolution.
759 // See more detailed explanation in
760 // https://github.com/rust-lang/rust/pull/53778#issuecomment-419224049
761 fn may_appear_after(&self, invoc_parent_expansion: ExpnId, binding: &NameBinding<'_>) -> bool {
762 // self > max(invoc, binding) => !(self <= invoc || self <= binding)
763 // Expansions are partially ordered, so "may appear after" is an inversion of
764 // "certainly appears before or simultaneously" and includes unordered cases.
765 let self_parent_expansion = self.expansion;
766 let other_parent_expansion = binding.expansion;
767 let certainly_before_other_or_simultaneously =
768 other_parent_expansion.is_descendant_of(self_parent_expansion);
769 let certainly_before_invoc_or_simultaneously =
770 invoc_parent_expansion.is_descendant_of(self_parent_expansion);
771 !(certainly_before_other_or_simultaneously || certainly_before_invoc_or_simultaneously)
775 /// Interns the names of the primitive types.
777 /// All other types are defined somewhere and possibly imported, but the primitive ones need
778 /// special handling, since they have no place of origin.
779 struct PrimitiveTypeTable {
780 primitive_types: FxHashMap<Name, PrimTy>,
783 impl PrimitiveTypeTable {
784 fn new() -> PrimitiveTypeTable {
785 let mut table = FxHashMap::default();
787 table.insert(sym::bool, Bool);
788 table.insert(sym::char, Char);
789 table.insert(sym::f32, Float(FloatTy::F32));
790 table.insert(sym::f64, Float(FloatTy::F64));
791 table.insert(sym::isize, Int(IntTy::Isize));
792 table.insert(sym::i8, Int(IntTy::I8));
793 table.insert(sym::i16, Int(IntTy::I16));
794 table.insert(sym::i32, Int(IntTy::I32));
795 table.insert(sym::i64, Int(IntTy::I64));
796 table.insert(sym::i128, Int(IntTy::I128));
797 table.insert(sym::str, Str);
798 table.insert(sym::usize, Uint(UintTy::Usize));
799 table.insert(sym::u8, Uint(UintTy::U8));
800 table.insert(sym::u16, Uint(UintTy::U16));
801 table.insert(sym::u32, Uint(UintTy::U32));
802 table.insert(sym::u64, Uint(UintTy::U64));
803 table.insert(sym::u128, Uint(UintTy::U128));
804 Self { primitive_types: table }
808 #[derive(Debug, Default, Clone)]
809 pub struct ExternPreludeEntry<'a> {
810 extern_crate_item: Option<&'a NameBinding<'a>>,
811 pub introduced_by_item: bool,
814 /// The main resolver class.
816 /// This is the visitor that walks the whole crate.
817 pub struct Resolver<'a> {
818 session: &'a Session,
821 pub definitions: Definitions,
823 pub graph_root: Module<'a>,
825 prelude: Option<Module<'a>>,
826 pub extern_prelude: FxHashMap<Ident, ExternPreludeEntry<'a>>,
828 /// N.B., this is used only for better diagnostics, not name resolution itself.
829 has_self: FxHashSet<DefId>,
831 /// Names of fields of an item `DefId` accessible with dot syntax.
832 /// Used for hints during error reporting.
833 field_names: FxHashMap<DefId, Vec<Name>>,
835 /// All imports known to succeed or fail.
836 determined_imports: Vec<&'a ImportDirective<'a>>,
838 /// All non-determined imports.
839 indeterminate_imports: Vec<&'a ImportDirective<'a>>,
841 /// FIXME: Refactor things so that these fields are passed through arguments and not resolver.
842 /// We are resolving a last import segment during import validation.
843 last_import_segment: bool,
844 /// This binding should be ignored during in-module resolution, so that we don't get
845 /// "self-confirming" import resolutions during import validation.
846 blacklisted_binding: Option<&'a NameBinding<'a>>,
848 /// The idents for the primitive types.
849 primitive_type_table: PrimitiveTypeTable,
851 /// Resolutions for nodes that have a single resolution.
852 partial_res_map: NodeMap<PartialRes>,
853 /// Resolutions for import nodes, which have multiple resolutions in different namespaces.
854 import_res_map: NodeMap<PerNS<Option<Res>>>,
855 /// Resolutions for labels (node IDs of their corresponding blocks or loops).
856 label_res_map: NodeMap<NodeId>,
858 pub export_map: ExportMap<NodeId>,
859 pub trait_map: TraitMap,
861 /// A map from nodes to anonymous modules.
862 /// Anonymous modules are pseudo-modules that are implicitly created around items
863 /// contained within blocks.
865 /// For example, if we have this:
873 /// There will be an anonymous module created around `g` with the ID of the
874 /// entry block for `f`.
875 block_map: NodeMap<Module<'a>>,
876 /// A fake module that contains no definition and no prelude. Used so that
877 /// some AST passes can generate identifiers that only resolve to local or
879 empty_module: Module<'a>,
880 module_map: FxHashMap<DefId, Module<'a>>,
881 extern_module_map: FxHashMap<(DefId, bool /* MacrosOnly? */), Module<'a>>,
882 binding_parent_modules: FxHashMap<PtrKey<'a, NameBinding<'a>>, Module<'a>>,
884 /// Maps glob imports to the names of items actually imported.
885 pub glob_map: GlobMap,
887 used_imports: FxHashSet<(NodeId, Namespace)>,
888 pub maybe_unused_trait_imports: NodeSet,
889 pub maybe_unused_extern_crates: Vec<(NodeId, Span)>,
891 /// Privacy errors are delayed until the end in order to deduplicate them.
892 privacy_errors: Vec<PrivacyError<'a>>,
893 /// Ambiguity errors are delayed for deduplication.
894 ambiguity_errors: Vec<AmbiguityError<'a>>,
895 /// `use` injections are delayed for better placement and deduplication.
896 use_injections: Vec<UseError<'a>>,
897 /// Crate-local macro expanded `macro_export` referred to by a module-relative path.
898 macro_expanded_macro_export_errors: BTreeSet<(Span, Span)>,
900 arenas: &'a ResolverArenas<'a>,
901 dummy_binding: &'a NameBinding<'a>,
903 crate_loader: &'a mut CrateLoader<'a>,
904 macro_names: FxHashSet<Ident>,
905 builtin_macros: FxHashMap<Name, SyntaxExtension>,
906 macro_use_prelude: FxHashMap<Name, &'a NameBinding<'a>>,
907 pub all_macros: FxHashMap<Name, Res>,
908 macro_map: FxHashMap<DefId, Lrc<SyntaxExtension>>,
909 dummy_ext_bang: Lrc<SyntaxExtension>,
910 dummy_ext_derive: Lrc<SyntaxExtension>,
911 non_macro_attrs: [Lrc<SyntaxExtension>; 2],
912 macro_defs: FxHashMap<ExpnId, DefId>,
913 local_macro_def_scopes: FxHashMap<NodeId, Module<'a>>,
914 ast_transform_scopes: FxHashMap<ExpnId, Module<'a>>,
915 unused_macros: NodeMap<Span>,
916 proc_macro_stubs: NodeSet,
917 /// Traces collected during macro resolution and validated when it's complete.
918 single_segment_macro_resolutions: Vec<(Ident, MacroKind, ParentScope<'a>,
919 Option<&'a NameBinding<'a>>)>,
920 multi_segment_macro_resolutions: Vec<(Vec<Segment>, Span, MacroKind, ParentScope<'a>,
922 builtin_attrs: Vec<(Ident, ParentScope<'a>)>,
923 /// Some built-in derives mark items they are applied to so they are treated specially later.
924 /// Derive macros cannot modify the item themselves and have to store the markers in the global
925 /// context, so they attach the markers to derive container IDs using this resolver table.
926 /// FIXME: Find a way for `PartialEq` and `Eq` to emulate `#[structural_match]`
927 /// by marking the produced impls rather than the original items.
928 special_derives: FxHashMap<ExpnId, SpecialDerives>,
929 /// Parent scopes in which the macros were invoked.
930 /// FIXME: `derives` are missing in these parent scopes and need to be taken from elsewhere.
931 invocation_parent_scopes: FxHashMap<ExpnId, ParentScope<'a>>,
932 /// Legacy scopes *produced* by expanding the macro invocations,
933 /// include all the `macro_rules` items and other invocations generated by them.
934 output_legacy_scopes: FxHashMap<ExpnId, LegacyScope<'a>>,
936 /// Avoid duplicated errors for "name already defined".
937 name_already_seen: FxHashMap<Name, Span>,
939 potentially_unused_imports: Vec<&'a ImportDirective<'a>>,
941 /// Table for mapping struct IDs into struct constructor IDs,
942 /// it's not used during normal resolution, only for better error reporting.
943 struct_constructors: DefIdMap<(Res, ty::Visibility)>,
945 /// Features enabled for this crate.
946 active_features: FxHashSet<Name>,
948 /// Stores enum visibilities to properly build a reduced graph
949 /// when visiting the correspondent variants.
950 variant_vis: DefIdMap<ty::Visibility>,
953 /// Nothing really interesting here; it just provides memory for the rest of the crate.
955 pub struct ResolverArenas<'a> {
956 modules: arena::TypedArena<ModuleData<'a>>,
957 local_modules: RefCell<Vec<Module<'a>>>,
958 name_bindings: arena::TypedArena<NameBinding<'a>>,
959 import_directives: arena::TypedArena<ImportDirective<'a>>,
960 name_resolutions: arena::TypedArena<RefCell<NameResolution<'a>>>,
961 legacy_bindings: arena::TypedArena<LegacyBinding<'a>>,
962 ast_paths: arena::TypedArena<ast::Path>,
965 impl<'a> ResolverArenas<'a> {
966 fn alloc_module(&'a self, module: ModuleData<'a>) -> Module<'a> {
967 let module = self.modules.alloc(module);
968 if module.def_id().map(|def_id| def_id.is_local()).unwrap_or(true) {
969 self.local_modules.borrow_mut().push(module);
973 fn local_modules(&'a self) -> std::cell::Ref<'a, Vec<Module<'a>>> {
974 self.local_modules.borrow()
976 fn alloc_name_binding(&'a self, name_binding: NameBinding<'a>) -> &'a NameBinding<'a> {
977 self.name_bindings.alloc(name_binding)
979 fn alloc_import_directive(&'a self, import_directive: ImportDirective<'a>)
980 -> &'a ImportDirective<'_> {
981 self.import_directives.alloc(import_directive)
983 fn alloc_name_resolution(&'a self) -> &'a RefCell<NameResolution<'a>> {
984 self.name_resolutions.alloc(Default::default())
986 fn alloc_legacy_binding(&'a self, binding: LegacyBinding<'a>) -> &'a LegacyBinding<'a> {
987 self.legacy_bindings.alloc(binding)
989 fn alloc_ast_paths(&'a self, paths: &[ast::Path]) -> &'a [ast::Path] {
990 self.ast_paths.alloc_from_iter(paths.iter().cloned())
994 impl<'a> AsMut<Resolver<'a>> for Resolver<'a> {
995 fn as_mut(&mut self) -> &mut Resolver<'a> { self }
998 impl<'a, 'b> ty::DefIdTree for &'a Resolver<'b> {
999 fn parent(self, id: DefId) -> Option<DefId> {
1001 LOCAL_CRATE => self.definitions.def_key(id.index).parent,
1002 _ => self.cstore.def_key(id).parent,
1003 }.map(|index| DefId { index, ..id })
1007 /// This interface is used through the AST→HIR step, to embed full paths into the HIR. After that
1008 /// the resolver is no longer needed as all the relevant information is inline.
1009 impl<'a> hir::lowering::Resolver for Resolver<'a> {
1010 fn resolve_str_path(
1013 crate_root: Option<Name>,
1014 components: &[Name],
1016 ) -> (ast::Path, Res) {
1017 let root = if crate_root.is_some() {
1022 let segments = iter::once(Ident::with_dummy_span(root))
1024 crate_root.into_iter()
1025 .chain(components.iter().cloned())
1026 .map(Ident::with_dummy_span)
1027 ).map(|i| self.new_ast_path_segment(i)).collect::<Vec<_>>();
1029 let path = ast::Path {
1034 let parent_scope = &ParentScope::module(self.graph_root);
1035 let res = match self.resolve_ast_path(&path, ns, parent_scope) {
1037 Err((span, error)) => {
1038 self.report_error(span, error);
1045 fn get_partial_res(&mut self, id: NodeId) -> Option<PartialRes> {
1046 self.partial_res_map.get(&id).cloned()
1049 fn get_import_res(&mut self, id: NodeId) -> PerNS<Option<Res>> {
1050 self.import_res_map.get(&id).cloned().unwrap_or_default()
1053 fn get_label_res(&mut self, id: NodeId) -> Option<NodeId> {
1054 self.label_res_map.get(&id).cloned()
1057 fn definitions(&mut self) -> &mut Definitions {
1058 &mut self.definitions
1061 fn has_derives(&self, node_id: NodeId, derives: SpecialDerives) -> bool {
1062 let def_id = self.definitions.local_def_id(node_id);
1063 let expn_id = self.definitions.expansion_that_defined(def_id.index);
1064 self.has_derives(expn_id, derives)
1068 impl<'a> Resolver<'a> {
1069 pub fn new(session: &'a Session,
1073 crate_loader: &'a mut CrateLoader<'a>,
1074 arenas: &'a ResolverArenas<'a>)
1076 let root_def_id = DefId::local(CRATE_DEF_INDEX);
1077 let root_module_kind = ModuleKind::Def(
1082 let graph_root = arenas.alloc_module(ModuleData {
1083 no_implicit_prelude: attr::contains_name(&krate.attrs, sym::no_implicit_prelude),
1084 ..ModuleData::new(None, root_module_kind, root_def_id, ExpnId::root(), krate.span)
1086 let empty_module_kind = ModuleKind::Def(
1091 let empty_module = arenas.alloc_module(ModuleData {
1092 no_implicit_prelude: true,
1101 let mut module_map = FxHashMap::default();
1102 module_map.insert(DefId::local(CRATE_DEF_INDEX), graph_root);
1104 let mut definitions = Definitions::default();
1105 definitions.create_root_def(crate_name, session.local_crate_disambiguator());
1107 let mut extern_prelude: FxHashMap<Ident, ExternPreludeEntry<'_>> =
1108 session.opts.externs.iter().map(|kv| (Ident::from_str(kv.0), Default::default()))
1111 if !attr::contains_name(&krate.attrs, sym::no_core) {
1112 extern_prelude.insert(Ident::with_dummy_span(sym::core), Default::default());
1113 if !attr::contains_name(&krate.attrs, sym::no_std) {
1114 extern_prelude.insert(Ident::with_dummy_span(sym::std), Default::default());
1115 if session.rust_2018() {
1116 extern_prelude.insert(Ident::with_dummy_span(sym::meta), Default::default());
1121 let mut invocation_parent_scopes = FxHashMap::default();
1122 invocation_parent_scopes.insert(ExpnId::root(), ParentScope::module(graph_root));
1124 let mut macro_defs = FxHashMap::default();
1125 macro_defs.insert(ExpnId::root(), root_def_id);
1127 let features = session.features_untracked();
1128 let non_macro_attr =
1129 |mark_used| Lrc::new(SyntaxExtension::non_macro_attr(mark_used, session.edition()));
1138 // The outermost module has def ID 0; this is not reflected in the
1144 has_self: FxHashSet::default(),
1145 field_names: FxHashMap::default(),
1147 determined_imports: Vec::new(),
1148 indeterminate_imports: Vec::new(),
1150 last_import_segment: false,
1151 blacklisted_binding: None,
1153 primitive_type_table: PrimitiveTypeTable::new(),
1155 partial_res_map: Default::default(),
1156 import_res_map: Default::default(),
1157 label_res_map: Default::default(),
1158 export_map: FxHashMap::default(),
1159 trait_map: Default::default(),
1162 block_map: Default::default(),
1163 extern_module_map: FxHashMap::default(),
1164 binding_parent_modules: FxHashMap::default(),
1165 ast_transform_scopes: FxHashMap::default(),
1167 glob_map: Default::default(),
1169 used_imports: FxHashSet::default(),
1170 maybe_unused_trait_imports: Default::default(),
1171 maybe_unused_extern_crates: Vec::new(),
1173 privacy_errors: Vec::new(),
1174 ambiguity_errors: Vec::new(),
1175 use_injections: Vec::new(),
1176 macro_expanded_macro_export_errors: BTreeSet::new(),
1179 dummy_binding: arenas.alloc_name_binding(NameBinding {
1180 kind: NameBindingKind::Res(Res::Err, false),
1182 expansion: ExpnId::root(),
1184 vis: ty::Visibility::Public,
1188 macro_names: FxHashSet::default(),
1189 builtin_macros: Default::default(),
1190 macro_use_prelude: FxHashMap::default(),
1191 all_macros: FxHashMap::default(),
1192 macro_map: FxHashMap::default(),
1193 dummy_ext_bang: Lrc::new(SyntaxExtension::dummy_bang(session.edition())),
1194 dummy_ext_derive: Lrc::new(SyntaxExtension::dummy_derive(session.edition())),
1195 non_macro_attrs: [non_macro_attr(false), non_macro_attr(true)],
1196 invocation_parent_scopes,
1197 output_legacy_scopes: Default::default(),
1199 local_macro_def_scopes: FxHashMap::default(),
1200 name_already_seen: FxHashMap::default(),
1201 potentially_unused_imports: Vec::new(),
1202 struct_constructors: Default::default(),
1203 unused_macros: Default::default(),
1204 proc_macro_stubs: Default::default(),
1205 single_segment_macro_resolutions: Default::default(),
1206 multi_segment_macro_resolutions: Default::default(),
1207 builtin_attrs: Default::default(),
1208 special_derives: Default::default(),
1210 features.declared_lib_features.iter().map(|(feat, ..)| *feat)
1211 .chain(features.declared_lang_features.iter().map(|(feat, ..)| *feat))
1213 variant_vis: Default::default()
1217 pub fn arenas() -> ResolverArenas<'a> {
1221 fn non_macro_attr(&self, mark_used: bool) -> Lrc<SyntaxExtension> {
1222 self.non_macro_attrs[mark_used as usize].clone()
1225 fn dummy_ext(&self, macro_kind: MacroKind) -> Lrc<SyntaxExtension> {
1227 MacroKind::Bang => self.dummy_ext_bang.clone(),
1228 MacroKind::Derive => self.dummy_ext_derive.clone(),
1229 MacroKind::Attr => self.non_macro_attr(true),
1233 /// Runs the function on each namespace.
1234 fn per_ns<F: FnMut(&mut Self, Namespace)>(&mut self, mut f: F) {
1240 fn is_builtin_macro(&mut self, res: Res) -> bool {
1241 self.get_macro(res).map_or(false, |ext| ext.is_builtin)
1244 fn macro_def(&self, mut ctxt: SyntaxContext) -> DefId {
1246 match self.macro_defs.get(&ctxt.outer_expn()) {
1247 Some(&def_id) => return def_id,
1248 None => ctxt.remove_mark(),
1253 fn has_derives(&self, expn_id: ExpnId, markers: SpecialDerives) -> bool {
1254 self.special_derives.get(&expn_id).map_or(false, |m| m.contains(markers))
1257 /// Entry point to crate resolution.
1258 pub fn resolve_crate(&mut self, krate: &Crate) {
1259 ImportResolver { r: self }.finalize_imports();
1260 self.finalize_macro_resolutions();
1262 self.late_resolve_crate(krate);
1264 self.check_unused(krate);
1265 self.report_errors(krate);
1266 self.crate_loader.postprocess(krate);
1273 normal_ancestor_id: DefId,
1277 let module = ModuleData::new(Some(parent), kind, normal_ancestor_id, expn_id, span);
1278 self.arenas.alloc_module(module)
1281 fn resolutions(&mut self, module: Module<'a>) -> &'a Resolutions<'a> {
1282 if module.populate_on_access.get() {
1283 module.populate_on_access.set(false);
1284 self.build_reduced_graph_external(module);
1286 &module.lazy_resolutions
1289 fn resolution(&mut self, module: Module<'a>, ident: Ident, ns: Namespace)
1290 -> &'a RefCell<NameResolution<'a>> {
1291 *self.resolutions(module).borrow_mut().entry((ident.modern(), ns))
1292 .or_insert_with(|| self.arenas.alloc_name_resolution())
1295 fn record_use(&mut self, ident: Ident, ns: Namespace,
1296 used_binding: &'a NameBinding<'a>, is_lexical_scope: bool) {
1297 if let Some((b2, kind)) = used_binding.ambiguity {
1298 self.ambiguity_errors.push(AmbiguityError {
1299 kind, ident, b1: used_binding, b2,
1300 misc1: AmbiguityErrorMisc::None,
1301 misc2: AmbiguityErrorMisc::None,
1304 if let NameBindingKind::Import { directive, binding, ref used } = used_binding.kind {
1305 // Avoid marking `extern crate` items that refer to a name from extern prelude,
1306 // but not introduce it, as used if they are accessed from lexical scope.
1307 if is_lexical_scope {
1308 if let Some(entry) = self.extern_prelude.get(&ident.modern()) {
1309 if let Some(crate_item) = entry.extern_crate_item {
1310 if ptr::eq(used_binding, crate_item) && !entry.introduced_by_item {
1317 directive.used.set(true);
1318 self.used_imports.insert((directive.id, ns));
1319 self.add_to_glob_map(&directive, ident);
1320 self.record_use(ident, ns, binding, false);
1325 fn add_to_glob_map(&mut self, directive: &ImportDirective<'_>, ident: Ident) {
1326 if directive.is_glob() {
1327 self.glob_map.entry(directive.id).or_default().insert(ident.name);
1331 /// A generic scope visitor.
1332 /// Visits scopes in order to resolve some identifier in them or perform other actions.
1333 /// If the callback returns `Some` result, we stop visiting scopes and return it.
1336 scope_set: ScopeSet,
1337 parent_scope: &ParentScope<'a>,
1339 mut visitor: impl FnMut(&mut Self, Scope<'a>, /*use_prelude*/ bool, Ident) -> Option<T>,
1341 // General principles:
1342 // 1. Not controlled (user-defined) names should have higher priority than controlled names
1343 // built into the language or standard library. This way we can add new names into the
1344 // language or standard library without breaking user code.
1345 // 2. "Closed set" below means new names cannot appear after the current resolution attempt.
1346 // Places to search (in order of decreasing priority):
1348 // 1. FIXME: Ribs (type parameters), there's no necessary infrastructure yet
1349 // (open set, not controlled).
1350 // 2. Names in modules (both normal `mod`ules and blocks), loop through hygienic parents
1351 // (open, not controlled).
1352 // 3. Extern prelude (open, the open part is from macro expansions, not controlled).
1353 // 4. Tool modules (closed, controlled right now, but not in the future).
1354 // 5. Standard library prelude (de-facto closed, controlled).
1355 // 6. Language prelude (closed, controlled).
1357 // 1. FIXME: Ribs (local variables), there's no necessary infrastructure yet
1358 // (open set, not controlled).
1359 // 2. Names in modules (both normal `mod`ules and blocks), loop through hygienic parents
1360 // (open, not controlled).
1361 // 3. Standard library prelude (de-facto closed, controlled).
1363 // 1-3. Derive helpers (open, not controlled). All ambiguities with other names
1364 // are currently reported as errors. They should be higher in priority than preludes
1365 // and probably even names in modules according to the "general principles" above. They
1366 // also should be subject to restricted shadowing because are effectively produced by
1367 // derives (you need to resolve the derive first to add helpers into scope), but they
1368 // should be available before the derive is expanded for compatibility.
1369 // It's mess in general, so we are being conservative for now.
1370 // 1-3. `macro_rules` (open, not controlled), loop through legacy scopes. Have higher
1371 // priority than prelude macros, but create ambiguities with macros in modules.
1372 // 1-3. Names in modules (both normal `mod`ules and blocks), loop through hygienic parents
1373 // (open, not controlled). Have higher priority than prelude macros, but create
1374 // ambiguities with `macro_rules`.
1375 // 4. `macro_use` prelude (open, the open part is from macro expansions, not controlled).
1376 // 4a. User-defined prelude from macro-use
1377 // (open, the open part is from macro expansions, not controlled).
1378 // 4b. "Standard library prelude" part implemented through `macro-use` (closed, controlled).
1379 // 4c. Standard library prelude (de-facto closed, controlled).
1380 // 6. Language prelude: builtin attributes (closed, controlled).
1381 // 4-6. Legacy plugin helpers (open, not controlled). Similar to derive helpers,
1382 // but introduced by legacy plugins using `register_attribute`. Priority is somewhere
1383 // in prelude, not sure where exactly (creates ambiguities with any other prelude names).
1385 let rust_2015 = ident.span.rust_2015();
1386 let (ns, is_absolute_path) = match scope_set {
1387 ScopeSet::All(ns, _) => (ns, false),
1388 ScopeSet::AbsolutePath(ns) => (ns, true),
1389 ScopeSet::Macro(_) => (MacroNS, false),
1391 // Jump out of trait or enum modules, they do not act as scopes.
1392 let module = parent_scope.module.nearest_item_scope();
1393 let mut scope = match ns {
1394 _ if is_absolute_path => Scope::CrateRoot,
1395 TypeNS | ValueNS => Scope::Module(module),
1396 MacroNS => Scope::DeriveHelpers,
1398 let mut ident = ident.modern();
1399 let mut use_prelude = !module.no_implicit_prelude;
1402 let visit = match scope {
1403 Scope::DeriveHelpers => true,
1404 Scope::MacroRules(..) => true,
1405 Scope::CrateRoot => true,
1406 Scope::Module(..) => true,
1407 Scope::MacroUsePrelude => use_prelude || rust_2015,
1408 Scope::BuiltinAttrs => true,
1409 Scope::LegacyPluginHelpers => use_prelude || rust_2015,
1410 Scope::ExternPrelude => use_prelude || is_absolute_path,
1411 Scope::ToolPrelude => use_prelude,
1412 Scope::StdLibPrelude => use_prelude || ns == MacroNS,
1413 Scope::BuiltinTypes => true,
1417 if let break_result @ Some(..) = visitor(self, scope, use_prelude, ident) {
1418 return break_result;
1422 scope = match scope {
1423 Scope::DeriveHelpers =>
1424 Scope::MacroRules(parent_scope.legacy),
1425 Scope::MacroRules(legacy_scope) => match legacy_scope {
1426 LegacyScope::Binding(binding) => Scope::MacroRules(
1427 binding.parent_legacy_scope
1429 LegacyScope::Invocation(invoc_id) => Scope::MacroRules(
1430 self.output_legacy_scopes.get(&invoc_id).cloned()
1431 .unwrap_or(self.invocation_parent_scopes[&invoc_id].legacy)
1433 LegacyScope::Empty => Scope::Module(module),
1435 Scope::CrateRoot => match ns {
1437 ident.span.adjust(ExpnId::root());
1438 Scope::ExternPrelude
1440 ValueNS | MacroNS => break,
1442 Scope::Module(module) => {
1443 use_prelude = !module.no_implicit_prelude;
1444 match self.hygienic_lexical_parent(module, &mut ident.span) {
1445 Some(parent_module) => Scope::Module(parent_module),
1447 ident.span.adjust(ExpnId::root());
1449 TypeNS => Scope::ExternPrelude,
1450 ValueNS => Scope::StdLibPrelude,
1451 MacroNS => Scope::MacroUsePrelude,
1456 Scope::MacroUsePrelude => Scope::StdLibPrelude,
1457 Scope::BuiltinAttrs => Scope::LegacyPluginHelpers,
1458 Scope::LegacyPluginHelpers => break, // nowhere else to search
1459 Scope::ExternPrelude if is_absolute_path => break,
1460 Scope::ExternPrelude => Scope::ToolPrelude,
1461 Scope::ToolPrelude => Scope::StdLibPrelude,
1462 Scope::StdLibPrelude => match ns {
1463 TypeNS => Scope::BuiltinTypes,
1464 ValueNS => break, // nowhere else to search
1465 MacroNS => Scope::BuiltinAttrs,
1467 Scope::BuiltinTypes => break, // nowhere else to search
1474 /// This resolves the identifier `ident` in the namespace `ns` in the current lexical scope.
1475 /// More specifically, we proceed up the hierarchy of scopes and return the binding for
1476 /// `ident` in the first scope that defines it (or None if no scopes define it).
1478 /// A block's items are above its local variables in the scope hierarchy, regardless of where
1479 /// the items are defined in the block. For example,
1482 /// g(); // Since there are no local variables in scope yet, this resolves to the item.
1485 /// g(); // This resolves to the local variable `g` since it shadows the item.
1489 /// Invariant: This must only be called during main resolution, not during
1490 /// import resolution.
1491 fn resolve_ident_in_lexical_scope(&mut self,
1494 parent_scope: &ParentScope<'a>,
1495 record_used_id: Option<NodeId>,
1498 -> Option<LexicalScopeBinding<'a>> {
1499 assert!(ns == TypeNS || ns == ValueNS);
1500 if ident.name == kw::Invalid {
1501 return Some(LexicalScopeBinding::Res(Res::Err));
1503 let (general_span, modern_span) = if ident.name == kw::SelfUpper {
1504 // FIXME(jseyfried) improve `Self` hygiene
1505 let empty_span = ident.span.with_ctxt(SyntaxContext::root());
1506 (empty_span, empty_span)
1507 } else if ns == TypeNS {
1508 let modern_span = ident.span.modern();
1509 (modern_span, modern_span)
1511 (ident.span.modern_and_legacy(), ident.span.modern())
1513 ident.span = general_span;
1514 let modern_ident = Ident { span: modern_span, ..ident };
1516 // Walk backwards up the ribs in scope.
1517 let record_used = record_used_id.is_some();
1518 let mut module = self.graph_root;
1519 for i in (0 .. ribs.len()).rev() {
1520 debug!("walk rib\n{:?}", ribs[i].bindings);
1521 // Use the rib kind to determine whether we are resolving parameters
1522 // (modern hygiene) or local variables (legacy hygiene).
1523 let rib_ident = if ribs[i].kind.contains_params() {
1528 if let Some(res) = ribs[i].bindings.get(&rib_ident).cloned() {
1529 // The ident resolves to a type parameter or local variable.
1530 return Some(LexicalScopeBinding::Res(
1531 self.validate_res_from_ribs(i, rib_ident, res, record_used, path_span, ribs),
1535 module = match ribs[i].kind {
1536 ModuleRibKind(module) => module,
1537 MacroDefinition(def) if def == self.macro_def(ident.span.ctxt()) => {
1538 // If an invocation of this macro created `ident`, give up on `ident`
1539 // and switch to `ident`'s source from the macro definition.
1540 ident.span.remove_mark();
1547 let item = self.resolve_ident_in_module_unadjusted(
1548 ModuleOrUniformRoot::Module(module),
1555 if let Ok(binding) = item {
1556 // The ident resolves to an item.
1557 return Some(LexicalScopeBinding::Item(binding));
1561 ModuleKind::Block(..) => {}, // We can see through blocks
1566 ident = modern_ident;
1567 let mut poisoned = None;
1569 let opt_module = if let Some(node_id) = record_used_id {
1570 self.hygienic_lexical_parent_with_compatibility_fallback(module, &mut ident.span,
1571 node_id, &mut poisoned)
1573 self.hygienic_lexical_parent(module, &mut ident.span)
1575 module = unwrap_or!(opt_module, break);
1576 let adjusted_parent_scope = &ParentScope { module, ..*parent_scope };
1577 let result = self.resolve_ident_in_module_unadjusted(
1578 ModuleOrUniformRoot::Module(module),
1581 adjusted_parent_scope,
1588 if let Some(node_id) = poisoned {
1589 self.session.buffer_lint_with_diagnostic(
1590 lint::builtin::PROC_MACRO_DERIVE_RESOLUTION_FALLBACK,
1591 node_id, ident.span,
1592 &format!("cannot find {} `{}` in this scope", ns.descr(), ident),
1593 lint::builtin::BuiltinLintDiagnostics::
1594 ProcMacroDeriveResolutionFallback(ident.span),
1597 return Some(LexicalScopeBinding::Item(binding))
1599 Err(Determined) => continue,
1600 Err(Undetermined) =>
1601 span_bug!(ident.span, "undetermined resolution during main resolution pass"),
1605 if !module.no_implicit_prelude {
1606 ident.span.adjust(ExpnId::root());
1608 if let Some(binding) = self.extern_prelude_get(ident, !record_used) {
1609 return Some(LexicalScopeBinding::Item(binding));
1612 if ns == TypeNS && KNOWN_TOOLS.contains(&ident.name) {
1613 let binding = (Res::ToolMod, ty::Visibility::Public,
1614 DUMMY_SP, ExpnId::root()).to_name_binding(self.arenas);
1615 return Some(LexicalScopeBinding::Item(binding));
1617 if let Some(prelude) = self.prelude {
1618 if let Ok(binding) = self.resolve_ident_in_module_unadjusted(
1619 ModuleOrUniformRoot::Module(prelude),
1626 return Some(LexicalScopeBinding::Item(binding));
1634 fn hygienic_lexical_parent(&mut self, module: Module<'a>, span: &mut Span)
1635 -> Option<Module<'a>> {
1636 if !module.expansion.outer_expn_is_descendant_of(span.ctxt()) {
1637 return Some(self.macro_def_scope(span.remove_mark()));
1640 if let ModuleKind::Block(..) = module.kind {
1641 return Some(module.parent.unwrap().nearest_item_scope());
1647 fn hygienic_lexical_parent_with_compatibility_fallback(&mut self, module: Module<'a>,
1648 span: &mut Span, node_id: NodeId,
1649 poisoned: &mut Option<NodeId>)
1650 -> Option<Module<'a>> {
1651 if let module @ Some(..) = self.hygienic_lexical_parent(module, span) {
1655 // We need to support the next case under a deprecation warning
1658 // ---- begin: this comes from a proc macro derive
1659 // mod implementation_details {
1660 // // Note that `MyStruct` is not in scope here.
1661 // impl SomeTrait for MyStruct { ... }
1665 // So we have to fall back to the module's parent during lexical resolution in this case.
1666 if let Some(parent) = module.parent {
1667 // Inner module is inside the macro, parent module is outside of the macro.
1668 if module.expansion != parent.expansion &&
1669 module.expansion.is_descendant_of(parent.expansion) {
1670 // The macro is a proc macro derive
1671 if let Some(&def_id) = self.macro_defs.get(&module.expansion) {
1672 if let Some(ext) = self.get_macro_by_def_id(def_id) {
1673 if !ext.is_builtin && ext.macro_kind() == MacroKind::Derive {
1674 if parent.expansion.outer_expn_is_descendant_of(span.ctxt()) {
1675 *poisoned = Some(node_id);
1676 return module.parent;
1687 fn resolve_ident_in_module(
1689 module: ModuleOrUniformRoot<'a>,
1692 parent_scope: &ParentScope<'a>,
1695 ) -> Result<&'a NameBinding<'a>, Determinacy> {
1696 self.resolve_ident_in_module_ext(
1697 module, ident, ns, parent_scope, record_used, path_span
1698 ).map_err(|(determinacy, _)| determinacy)
1701 fn resolve_ident_in_module_ext(
1703 module: ModuleOrUniformRoot<'a>,
1706 parent_scope: &ParentScope<'a>,
1709 ) -> Result<&'a NameBinding<'a>, (Determinacy, Weak)> {
1710 let tmp_parent_scope;
1711 let mut adjusted_parent_scope = parent_scope;
1713 ModuleOrUniformRoot::Module(m) => {
1714 if let Some(def) = ident.span.modernize_and_adjust(m.expansion) {
1716 ParentScope { module: self.macro_def_scope(def), ..*parent_scope };
1717 adjusted_parent_scope = &tmp_parent_scope;
1720 ModuleOrUniformRoot::ExternPrelude => {
1721 ident.span.modernize_and_adjust(ExpnId::root());
1723 ModuleOrUniformRoot::CrateRootAndExternPrelude |
1724 ModuleOrUniformRoot::CurrentScope => {
1728 let result = self.resolve_ident_in_module_unadjusted_ext(
1729 module, ident, ns, adjusted_parent_scope, false, record_used, path_span,
1734 fn resolve_crate_root(&mut self, ident: Ident) -> Module<'a> {
1735 let mut ctxt = ident.span.ctxt();
1736 let mark = if ident.name == kw::DollarCrate {
1737 // When resolving `$crate` from a `macro_rules!` invoked in a `macro`,
1738 // we don't want to pretend that the `macro_rules!` definition is in the `macro`
1739 // as described in `SyntaxContext::apply_mark`, so we ignore prepended modern marks.
1740 // FIXME: This is only a guess and it doesn't work correctly for `macro_rules!`
1741 // definitions actually produced by `macro` and `macro` definitions produced by
1742 // `macro_rules!`, but at least such configurations are not stable yet.
1743 ctxt = ctxt.modern_and_legacy();
1744 let mut iter = ctxt.marks().into_iter().rev().peekable();
1745 let mut result = None;
1746 // Find the last modern mark from the end if it exists.
1747 while let Some(&(mark, transparency)) = iter.peek() {
1748 if transparency == Transparency::Opaque {
1749 result = Some(mark);
1755 // Then find the last legacy mark from the end if it exists.
1756 for (mark, transparency) in iter {
1757 if transparency == Transparency::SemiTransparent {
1758 result = Some(mark);
1765 ctxt = ctxt.modern();
1766 ctxt.adjust(ExpnId::root())
1768 let module = match mark {
1769 Some(def) => self.macro_def_scope(def),
1770 None => return self.graph_root,
1772 self.get_module(DefId { index: CRATE_DEF_INDEX, ..module.normal_ancestor_id })
1775 fn resolve_self(&mut self, ctxt: &mut SyntaxContext, module: Module<'a>) -> Module<'a> {
1776 let mut module = self.get_module(module.normal_ancestor_id);
1777 while module.span.ctxt().modern() != *ctxt {
1778 let parent = module.parent.unwrap_or_else(|| self.macro_def_scope(ctxt.remove_mark()));
1779 module = self.get_module(parent.normal_ancestor_id);
1787 opt_ns: Option<Namespace>, // `None` indicates a module path in import
1788 parent_scope: &ParentScope<'a>,
1791 crate_lint: CrateLint,
1792 ) -> PathResult<'a> {
1793 self.resolve_path_with_ribs(
1794 path, opt_ns, parent_scope, record_used, path_span, crate_lint, None
1798 fn resolve_path_with_ribs(
1801 opt_ns: Option<Namespace>, // `None` indicates a module path in import
1802 parent_scope: &ParentScope<'a>,
1805 crate_lint: CrateLint,
1806 ribs: Option<&PerNS<Vec<Rib<'a>>>>,
1807 ) -> PathResult<'a> {
1808 let mut module = None;
1809 let mut allow_super = true;
1810 let mut second_binding = None;
1813 "resolve_path(path={:?}, opt_ns={:?}, record_used={:?}, \
1814 path_span={:?}, crate_lint={:?})",
1822 for (i, &Segment { ident, id }) in path.iter().enumerate() {
1823 debug!("resolve_path ident {} {:?} {:?}", i, ident, id);
1824 let record_segment_res = |this: &mut Self, res| {
1826 if let Some(id) = id {
1827 if !this.partial_res_map.contains_key(&id) {
1828 assert!(id != ast::DUMMY_NODE_ID, "Trying to resolve dummy id");
1829 this.record_partial_res(id, PartialRes::new(res));
1835 let is_last = i == path.len() - 1;
1836 let ns = if is_last { opt_ns.unwrap_or(TypeNS) } else { TypeNS };
1837 let name = ident.name;
1839 allow_super &= ns == TypeNS &&
1840 (name == kw::SelfLower ||
1844 if allow_super && name == kw::Super {
1845 let mut ctxt = ident.span.ctxt().modern();
1846 let self_module = match i {
1847 0 => Some(self.resolve_self(&mut ctxt, parent_scope.module)),
1849 Some(ModuleOrUniformRoot::Module(module)) => Some(module),
1853 if let Some(self_module) = self_module {
1854 if let Some(parent) = self_module.parent {
1855 module = Some(ModuleOrUniformRoot::Module(
1856 self.resolve_self(&mut ctxt, parent)));
1860 let msg = "there are too many initial `super`s.".to_string();
1861 return PathResult::Failed {
1865 is_error_from_last_segment: false,
1869 if name == kw::SelfLower {
1870 let mut ctxt = ident.span.ctxt().modern();
1871 module = Some(ModuleOrUniformRoot::Module(
1872 self.resolve_self(&mut ctxt, parent_scope.module)));
1875 if name == kw::PathRoot && ident.span.rust_2018() {
1876 module = Some(ModuleOrUniformRoot::ExternPrelude);
1879 if name == kw::PathRoot &&
1880 ident.span.rust_2015() && self.session.rust_2018() {
1881 // `::a::b` from 2015 macro on 2018 global edition
1882 module = Some(ModuleOrUniformRoot::CrateRootAndExternPrelude);
1885 if name == kw::PathRoot ||
1886 name == kw::Crate ||
1887 name == kw::DollarCrate {
1888 // `::a::b`, `crate::a::b` or `$crate::a::b`
1889 module = Some(ModuleOrUniformRoot::Module(
1890 self.resolve_crate_root(ident)));
1896 // Report special messages for path segment keywords in wrong positions.
1897 if ident.is_path_segment_keyword() && i != 0 {
1898 let name_str = if name == kw::PathRoot {
1899 "crate root".to_string()
1901 format!("`{}`", name)
1903 let label = if i == 1 && path[0].ident.name == kw::PathRoot {
1904 format!("global paths cannot start with {}", name_str)
1906 format!("{} in paths can only be used in start position", name_str)
1908 return PathResult::Failed {
1912 is_error_from_last_segment: false,
1916 let binding = if let Some(module) = module {
1917 self.resolve_ident_in_module(
1918 module, ident, ns, parent_scope, record_used, path_span
1920 } else if ribs.is_none() || opt_ns.is_none() || opt_ns == Some(MacroNS) {
1921 let scopes = ScopeSet::All(ns, opt_ns.is_none());
1922 self.early_resolve_ident_in_lexical_scope(ident, scopes, parent_scope, record_used,
1923 record_used, path_span)
1925 let record_used_id =
1926 if record_used { crate_lint.node_id().or(Some(CRATE_NODE_ID)) } else { None };
1927 match self.resolve_ident_in_lexical_scope(
1928 ident, ns, parent_scope, record_used_id, path_span, &ribs.unwrap()[ns]
1930 // we found a locally-imported or available item/module
1931 Some(LexicalScopeBinding::Item(binding)) => Ok(binding),
1932 // we found a local variable or type param
1933 Some(LexicalScopeBinding::Res(res))
1934 if opt_ns == Some(TypeNS) || opt_ns == Some(ValueNS) => {
1935 record_segment_res(self, res);
1936 return PathResult::NonModule(PartialRes::with_unresolved_segments(
1940 _ => Err(Determinacy::determined(record_used)),
1947 second_binding = Some(binding);
1949 let res = binding.res();
1950 let maybe_assoc = opt_ns != Some(MacroNS) && PathSource::Type.is_expected(res);
1951 if let Some(next_module) = binding.module() {
1952 module = Some(ModuleOrUniformRoot::Module(next_module));
1953 record_segment_res(self, res);
1954 } else if res == Res::ToolMod && i + 1 != path.len() {
1955 if binding.is_import() {
1956 self.session.struct_span_err(
1957 ident.span, "cannot use a tool module through an import"
1959 binding.span, "the tool module imported here"
1962 let res = Res::NonMacroAttr(NonMacroAttrKind::Tool);
1963 return PathResult::NonModule(PartialRes::new(res));
1964 } else if res == Res::Err {
1965 return PathResult::NonModule(PartialRes::new(Res::Err));
1966 } else if opt_ns.is_some() && (is_last || maybe_assoc) {
1967 self.lint_if_path_starts_with_module(
1973 return PathResult::NonModule(PartialRes::with_unresolved_segments(
1974 res, path.len() - i - 1
1977 let label = format!(
1978 "`{}` is {} {}, not a module",
1984 return PathResult::Failed {
1988 is_error_from_last_segment: is_last,
1992 Err(Undetermined) => return PathResult::Indeterminate,
1993 Err(Determined) => {
1994 if let Some(ModuleOrUniformRoot::Module(module)) = module {
1995 if opt_ns.is_some() && !module.is_normal() {
1996 return PathResult::NonModule(PartialRes::with_unresolved_segments(
1997 module.res().unwrap(), path.len() - i
2001 let module_res = match module {
2002 Some(ModuleOrUniformRoot::Module(module)) => module.res(),
2005 let (label, suggestion) = if module_res == self.graph_root.res() {
2006 let is_mod = |res| {
2007 match res { Res::Def(DefKind::Mod, _) => true, _ => false }
2009 let mut candidates =
2010 self.lookup_import_candidates(ident, TypeNS, is_mod);
2011 candidates.sort_by_cached_key(|c| {
2012 (c.path.segments.len(), c.path.to_string())
2014 if let Some(candidate) = candidates.get(0) {
2016 String::from("unresolved import"),
2018 vec![(ident.span, candidate.path.to_string())],
2019 String::from("a similar path exists"),
2020 Applicability::MaybeIncorrect,
2023 } else if !ident.is_reserved() {
2024 (format!("maybe a missing crate `{}`?", ident), None)
2026 // the parser will already have complained about the keyword being used
2027 return PathResult::NonModule(PartialRes::new(Res::Err));
2030 (format!("use of undeclared type or module `{}`", ident), None)
2032 (format!("could not find `{}` in `{}`", ident, path[i - 1].ident), None)
2034 return PathResult::Failed {
2038 is_error_from_last_segment: is_last,
2044 self.lint_if_path_starts_with_module(crate_lint, path, path_span, second_binding);
2046 PathResult::Module(match module {
2047 Some(module) => module,
2048 None if path.is_empty() => ModuleOrUniformRoot::CurrentScope,
2049 _ => span_bug!(path_span, "resolve_path: non-empty path `{:?}` has no module", path),
2053 fn lint_if_path_starts_with_module(
2055 crate_lint: CrateLint,
2058 second_binding: Option<&NameBinding<'_>>,
2060 let (diag_id, diag_span) = match crate_lint {
2061 CrateLint::No => return,
2062 CrateLint::SimplePath(id) => (id, path_span),
2063 CrateLint::UsePath { root_id, root_span } => (root_id, root_span),
2064 CrateLint::QPathTrait { qpath_id, qpath_span } => (qpath_id, qpath_span),
2067 let first_name = match path.get(0) {
2068 // In the 2018 edition this lint is a hard error, so nothing to do
2069 Some(seg) if seg.ident.span.rust_2015() && self.session.rust_2015() => seg.ident.name,
2073 // We're only interested in `use` paths which should start with
2074 // `{{root}}` currently.
2075 if first_name != kw::PathRoot {
2080 // If this import looks like `crate::...` it's already good
2081 Some(Segment { ident, .. }) if ident.name == kw::Crate => return,
2082 // Otherwise go below to see if it's an extern crate
2084 // If the path has length one (and it's `PathRoot` most likely)
2085 // then we don't know whether we're gonna be importing a crate or an
2086 // item in our crate. Defer this lint to elsewhere
2090 // If the first element of our path was actually resolved to an
2091 // `ExternCrate` (also used for `crate::...`) then no need to issue a
2092 // warning, this looks all good!
2093 if let Some(binding) = second_binding {
2094 if let NameBindingKind::Import { directive: d, .. } = binding.kind {
2095 // Careful: we still want to rewrite paths from
2096 // renamed extern crates.
2097 if let ImportDirectiveSubclass::ExternCrate { source: None, .. } = d.subclass {
2103 let diag = lint::builtin::BuiltinLintDiagnostics
2104 ::AbsPathWithModule(diag_span);
2105 self.session.buffer_lint_with_diagnostic(
2106 lint::builtin::ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE,
2108 "absolute paths must start with `self`, `super`, \
2109 `crate`, or an external crate name in the 2018 edition",
2113 // Validate a local resolution (from ribs).
2114 fn validate_res_from_ribs(
2121 all_ribs: &[Rib<'a>],
2123 debug!("validate_res_from_ribs({:?})", res);
2124 let ribs = &all_ribs[rib_index + 1..];
2126 // An invalid forward use of a type parameter from a previous default.
2127 if let ForwardTyParamBanRibKind = all_ribs[rib_index].kind {
2129 let res_error = if rib_ident.name == kw::SelfUpper {
2130 ResolutionError::SelfInTyParamDefault
2132 ResolutionError::ForwardDeclaredTyParam
2134 self.report_error(span, res_error);
2136 assert_eq!(res, Res::Err);
2140 // An invalid use of a type parameter as the type of a const parameter.
2141 if let TyParamAsConstParamTy = all_ribs[rib_index].kind {
2143 self.report_error(span, ResolutionError::ConstParamDependentOnTypeParam);
2145 assert_eq!(res, Res::Err);
2151 use ResolutionError::*;
2152 let mut res_err = None;
2156 NormalRibKind | ModuleRibKind(..) | MacroDefinition(..) |
2157 ForwardTyParamBanRibKind | TyParamAsConstParamTy => {
2158 // Nothing to do. Continue.
2160 ItemRibKind | FnItemRibKind | AssocItemRibKind => {
2161 // This was an attempt to access an upvar inside a
2162 // named function item. This is not allowed, so we
2165 // We don't immediately trigger a resolve error, because
2166 // we want certain other resolution errors (namely those
2167 // emitted for `ConstantItemRibKind` below) to take
2169 res_err = Some(CannotCaptureDynamicEnvironmentInFnItem);
2172 ConstantItemRibKind => {
2173 // Still doesn't deal with upvars
2175 self.report_error(span, AttemptToUseNonConstantValueInConstant);
2181 if let Some(res_err) = res_err {
2182 self.report_error(span, res_err);
2186 Res::Def(DefKind::TyParam, _) | Res::SelfTy(..) => {
2189 NormalRibKind | AssocItemRibKind |
2190 ModuleRibKind(..) | MacroDefinition(..) | ForwardTyParamBanRibKind |
2191 ConstantItemRibKind | TyParamAsConstParamTy => {
2192 // Nothing to do. Continue.
2194 ItemRibKind | FnItemRibKind => {
2195 // This was an attempt to use a type parameter outside its scope.
2198 span, ResolutionError::GenericParamsFromOuterFunction(res)
2206 Res::Def(DefKind::ConstParam, _) => {
2207 let mut ribs = ribs.iter().peekable();
2208 if let Some(Rib { kind: FnItemRibKind, .. }) = ribs.peek() {
2209 // When declaring const parameters inside function signatures, the first rib
2210 // is always a `FnItemRibKind`. In this case, we can skip it, to avoid it
2211 // (spuriously) conflicting with the const param.
2215 if let ItemRibKind | FnItemRibKind = rib.kind {
2216 // This was an attempt to use a const parameter outside its scope.
2219 span, ResolutionError::GenericParamsFromOuterFunction(res)
2231 fn record_partial_res(&mut self, node_id: NodeId, resolution: PartialRes) {
2232 debug!("(recording res) recording {:?} for {}", resolution, node_id);
2233 if let Some(prev_res) = self.partial_res_map.insert(node_id, resolution) {
2234 panic!("path resolved multiple times ({:?} before, {:?} now)", prev_res, resolution);
2238 fn is_accessible_from(&self, vis: ty::Visibility, module: Module<'a>) -> bool {
2239 vis.is_accessible_from(module.normal_ancestor_id, self)
2242 fn set_binding_parent_module(&mut self, binding: &'a NameBinding<'a>, module: Module<'a>) {
2243 if let Some(old_module) = self.binding_parent_modules.insert(PtrKey(binding), module) {
2244 if !ptr::eq(module, old_module) {
2245 span_bug!(binding.span, "parent module is reset for binding");
2250 fn disambiguate_legacy_vs_modern(
2252 legacy: &'a NameBinding<'a>,
2253 modern: &'a NameBinding<'a>,
2255 // Some non-controversial subset of ambiguities "modern macro name" vs "macro_rules"
2256 // is disambiguated to mitigate regressions from macro modularization.
2257 // Scoping for `macro_rules` behaves like scoping for `let` at module level, in general.
2258 match (self.binding_parent_modules.get(&PtrKey(legacy)),
2259 self.binding_parent_modules.get(&PtrKey(modern))) {
2260 (Some(legacy), Some(modern)) =>
2261 legacy.normal_ancestor_id == modern.normal_ancestor_id &&
2262 modern.is_ancestor_of(legacy),
2267 fn binding_description(&self, b: &NameBinding<'_>, ident: Ident, from_prelude: bool) -> String {
2269 if b.span.is_dummy() {
2270 let add_built_in = match b.res() {
2271 // These already contain the "built-in" prefix or look bad with it.
2272 Res::NonMacroAttr(..) | Res::PrimTy(..) | Res::ToolMod => false,
2275 let (built_in, from) = if from_prelude {
2276 ("", " from prelude")
2277 } else if b.is_extern_crate() && !b.is_import() &&
2278 self.session.opts.externs.get(&ident.as_str()).is_some() {
2279 ("", " passed with `--extern`")
2280 } else if add_built_in {
2286 let article = if built_in.is_empty() { res.article() } else { "a" };
2287 format!("{a}{built_in} {thing}{from}",
2288 a = article, thing = res.descr(), built_in = built_in, from = from)
2290 let introduced = if b.is_import() { "imported" } else { "defined" };
2291 format!("the {thing} {introduced} here",
2292 thing = res.descr(), introduced = introduced)
2296 fn report_ambiguity_error(&self, ambiguity_error: &AmbiguityError<'_>) {
2297 let AmbiguityError { kind, ident, b1, b2, misc1, misc2 } = *ambiguity_error;
2298 let (b1, b2, misc1, misc2, swapped) = if b2.span.is_dummy() && !b1.span.is_dummy() {
2299 // We have to print the span-less alternative first, otherwise formatting looks bad.
2300 (b2, b1, misc2, misc1, true)
2302 (b1, b2, misc1, misc2, false)
2305 let mut err = struct_span_err!(self.session, ident.span, E0659,
2306 "`{ident}` is ambiguous ({why})",
2307 ident = ident, why = kind.descr());
2308 err.span_label(ident.span, "ambiguous name");
2310 let mut could_refer_to = |b: &NameBinding<'_>, misc: AmbiguityErrorMisc, also: &str| {
2311 let what = self.binding_description(b, ident, misc == AmbiguityErrorMisc::FromPrelude);
2312 let note_msg = format!("`{ident}` could{also} refer to {what}",
2313 ident = ident, also = also, what = what);
2315 let thing = b.res().descr();
2316 let mut help_msgs = Vec::new();
2317 if b.is_glob_import() && (kind == AmbiguityKind::GlobVsGlob ||
2318 kind == AmbiguityKind::GlobVsExpanded ||
2319 kind == AmbiguityKind::GlobVsOuter &&
2320 swapped != also.is_empty()) {
2321 help_msgs.push(format!("consider adding an explicit import of \
2322 `{ident}` to disambiguate", ident = ident))
2324 if b.is_extern_crate() && ident.span.rust_2018() {
2325 help_msgs.push(format!(
2326 "use `::{ident}` to refer to this {thing} unambiguously",
2327 ident = ident, thing = thing,
2330 if misc == AmbiguityErrorMisc::SuggestCrate {
2331 help_msgs.push(format!(
2332 "use `crate::{ident}` to refer to this {thing} unambiguously",
2333 ident = ident, thing = thing,
2335 } else if misc == AmbiguityErrorMisc::SuggestSelf {
2336 help_msgs.push(format!(
2337 "use `self::{ident}` to refer to this {thing} unambiguously",
2338 ident = ident, thing = thing,
2342 err.span_note(b.span, ¬e_msg);
2343 for (i, help_msg) in help_msgs.iter().enumerate() {
2344 let or = if i == 0 { "" } else { "or " };
2345 err.help(&format!("{}{}", or, help_msg));
2349 could_refer_to(b1, misc1, "");
2350 could_refer_to(b2, misc2, " also");
2354 fn report_errors(&mut self, krate: &Crate) {
2355 self.report_with_use_injections(krate);
2357 for &(span_use, span_def) in &self.macro_expanded_macro_export_errors {
2358 let msg = "macro-expanded `macro_export` macros from the current crate \
2359 cannot be referred to by absolute paths";
2360 self.session.buffer_lint_with_diagnostic(
2361 lint::builtin::MACRO_EXPANDED_MACRO_EXPORTS_ACCESSED_BY_ABSOLUTE_PATHS,
2362 CRATE_NODE_ID, span_use, msg,
2363 lint::builtin::BuiltinLintDiagnostics::
2364 MacroExpandedMacroExportsAccessedByAbsolutePaths(span_def),
2368 for ambiguity_error in &self.ambiguity_errors {
2369 self.report_ambiguity_error(ambiguity_error);
2372 let mut reported_spans = FxHashSet::default();
2373 for &PrivacyError(dedup_span, ident, binding) in &self.privacy_errors {
2374 if reported_spans.insert(dedup_span) {
2375 let mut err = struct_span_err!(
2379 "{} `{}` is private",
2380 binding.res().descr(),
2383 // FIXME: use the ctor's `def_id` to check wether any of the fields is not visible
2384 match binding.kind {
2385 NameBindingKind::Res(Res::Def(DefKind::Ctor(
2388 ), _def_id), _) => {
2389 err.note("a tuple struct constructor is private if any of its fields \
2392 NameBindingKind::Res(Res::Def(DefKind::Ctor(
2395 ), _def_id), _) => {
2396 err.note("a tuple variant constructor is private if any of its fields \
2406 fn report_with_use_injections(&mut self, krate: &Crate) {
2407 for UseError { mut err, candidates, node_id, better } in self.use_injections.drain(..) {
2408 let (span, found_use) = UsePlacementFinder::check(krate, node_id);
2409 if !candidates.is_empty() {
2410 diagnostics::show_candidates(&mut err, span, &candidates, better, found_use);
2416 fn report_conflict<'b>(&mut self,
2420 new_binding: &NameBinding<'b>,
2421 old_binding: &NameBinding<'b>) {
2422 // Error on the second of two conflicting names
2423 if old_binding.span.lo() > new_binding.span.lo() {
2424 return self.report_conflict(parent, ident, ns, old_binding, new_binding);
2427 let container = match parent.kind {
2428 ModuleKind::Def(DefKind::Mod, _, _) => "module",
2429 ModuleKind::Def(DefKind::Trait, _, _) => "trait",
2430 ModuleKind::Block(..) => "block",
2434 let old_noun = match old_binding.is_import() {
2436 false => "definition",
2439 let new_participle = match new_binding.is_import() {
2444 let (name, span) = (ident.name, self.session.source_map().def_span(new_binding.span));
2446 if let Some(s) = self.name_already_seen.get(&name) {
2452 let old_kind = match (ns, old_binding.module()) {
2453 (ValueNS, _) => "value",
2454 (MacroNS, _) => "macro",
2455 (TypeNS, _) if old_binding.is_extern_crate() => "extern crate",
2456 (TypeNS, Some(module)) if module.is_normal() => "module",
2457 (TypeNS, Some(module)) if module.is_trait() => "trait",
2458 (TypeNS, _) => "type",
2461 let msg = format!("the name `{}` is defined multiple times", name);
2463 let mut err = match (old_binding.is_extern_crate(), new_binding.is_extern_crate()) {
2464 (true, true) => struct_span_err!(self.session, span, E0259, "{}", msg),
2465 (true, _) | (_, true) => match new_binding.is_import() && old_binding.is_import() {
2466 true => struct_span_err!(self.session, span, E0254, "{}", msg),
2467 false => struct_span_err!(self.session, span, E0260, "{}", msg),
2469 _ => match (old_binding.is_import(), new_binding.is_import()) {
2470 (false, false) => struct_span_err!(self.session, span, E0428, "{}", msg),
2471 (true, true) => struct_span_err!(self.session, span, E0252, "{}", msg),
2472 _ => struct_span_err!(self.session, span, E0255, "{}", msg),
2476 err.note(&format!("`{}` must be defined only once in the {} namespace of this {}",
2481 err.span_label(span, format!("`{}` re{} here", name, new_participle));
2483 self.session.source_map().def_span(old_binding.span),
2484 format!("previous {} of the {} `{}` here", old_noun, old_kind, name),
2487 // See https://github.com/rust-lang/rust/issues/32354
2488 use NameBindingKind::Import;
2489 let directive = match (&new_binding.kind, &old_binding.kind) {
2490 // If there are two imports where one or both have attributes then prefer removing the
2491 // import without attributes.
2492 (Import { directive: new, .. }, Import { directive: old, .. }) if {
2493 !new_binding.span.is_dummy() && !old_binding.span.is_dummy() &&
2494 (new.has_attributes || old.has_attributes)
2496 if old.has_attributes {
2497 Some((new, new_binding.span, true))
2499 Some((old, old_binding.span, true))
2502 // Otherwise prioritize the new binding.
2503 (Import { directive, .. }, other) if !new_binding.span.is_dummy() =>
2504 Some((directive, new_binding.span, other.is_import())),
2505 (other, Import { directive, .. }) if !old_binding.span.is_dummy() =>
2506 Some((directive, old_binding.span, other.is_import())),
2510 // Check if the target of the use for both bindings is the same.
2511 let duplicate = new_binding.res().opt_def_id() == old_binding.res().opt_def_id();
2512 let has_dummy_span = new_binding.span.is_dummy() || old_binding.span.is_dummy();
2513 let from_item = self.extern_prelude.get(&ident)
2514 .map(|entry| entry.introduced_by_item)
2516 // Only suggest removing an import if both bindings are to the same def, if both spans
2517 // aren't dummy spans. Further, if both bindings are imports, then the ident must have
2518 // been introduced by a item.
2519 let should_remove_import = duplicate && !has_dummy_span &&
2520 ((new_binding.is_extern_crate() || old_binding.is_extern_crate()) || from_item);
2523 Some((directive, span, true)) if should_remove_import && directive.is_nested() =>
2524 self.add_suggestion_for_duplicate_nested_use(&mut err, directive, span),
2525 Some((directive, _, true)) if should_remove_import && !directive.is_glob() => {
2526 // Simple case - remove the entire import. Due to the above match arm, this can
2527 // only be a single use so just remove it entirely.
2528 err.tool_only_span_suggestion(
2529 directive.use_span_with_attributes,
2530 "remove unnecessary import",
2532 Applicability::MaybeIncorrect,
2535 Some((directive, span, _)) =>
2536 self.add_suggestion_for_rename_of_use(&mut err, name, directive, span),
2541 self.name_already_seen.insert(name, span);
2544 /// This function adds a suggestion to change the binding name of a new import that conflicts
2545 /// with an existing import.
2547 /// ```ignore (diagnostic)
2548 /// help: you can use `as` to change the binding name of the import
2550 /// LL | use foo::bar as other_bar;
2551 /// | ^^^^^^^^^^^^^^^^^^^^^
2553 fn add_suggestion_for_rename_of_use(
2555 err: &mut DiagnosticBuilder<'_>,
2557 directive: &ImportDirective<'_>,
2560 let suggested_name = if name.as_str().chars().next().unwrap().is_uppercase() {
2561 format!("Other{}", name)
2563 format!("other_{}", name)
2566 let mut suggestion = None;
2567 match directive.subclass {
2568 ImportDirectiveSubclass::SingleImport { type_ns_only: true, .. } =>
2569 suggestion = Some(format!("self as {}", suggested_name)),
2570 ImportDirectiveSubclass::SingleImport { source, .. } => {
2571 if let Some(pos) = source.span.hi().0.checked_sub(binding_span.lo().0)
2572 .map(|pos| pos as usize) {
2573 if let Ok(snippet) = self.session.source_map()
2574 .span_to_snippet(binding_span) {
2575 if pos <= snippet.len() {
2576 suggestion = Some(format!(
2580 if snippet.ends_with(";") { ";" } else { "" }
2586 ImportDirectiveSubclass::ExternCrate { source, target, .. } =>
2587 suggestion = Some(format!(
2588 "extern crate {} as {};",
2589 source.unwrap_or(target.name),
2592 _ => unreachable!(),
2595 let rename_msg = "you can use `as` to change the binding name of the import";
2596 if let Some(suggestion) = suggestion {
2597 err.span_suggestion(
2601 Applicability::MaybeIncorrect,
2604 err.span_label(binding_span, rename_msg);
2608 /// This function adds a suggestion to remove a unnecessary binding from an import that is
2609 /// nested. In the following example, this function will be invoked to remove the `a` binding
2610 /// in the second use statement:
2612 /// ```ignore (diagnostic)
2613 /// use issue_52891::a;
2614 /// use issue_52891::{d, a, e};
2617 /// The following suggestion will be added:
2619 /// ```ignore (diagnostic)
2620 /// use issue_52891::{d, a, e};
2621 /// ^-- help: remove unnecessary import
2624 /// If the nested use contains only one import then the suggestion will remove the entire
2627 /// It is expected that the directive provided is a nested import - this isn't checked by the
2628 /// function. If this invariant is not upheld, this function's behaviour will be unexpected
2629 /// as characters expected by span manipulations won't be present.
2630 fn add_suggestion_for_duplicate_nested_use(
2632 err: &mut DiagnosticBuilder<'_>,
2633 directive: &ImportDirective<'_>,
2636 assert!(directive.is_nested());
2637 let message = "remove unnecessary import";
2639 // Two examples will be used to illustrate the span manipulations we're doing:
2641 // - Given `use issue_52891::{d, a, e};` where `a` is a duplicate then `binding_span` is
2642 // `a` and `directive.use_span` is `issue_52891::{d, a, e};`.
2643 // - Given `use issue_52891::{d, e, a};` where `a` is a duplicate then `binding_span` is
2644 // `a` and `directive.use_span` is `issue_52891::{d, e, a};`.
2646 let (found_closing_brace, span) = find_span_of_binding_until_next_binding(
2647 self.session, binding_span, directive.use_span,
2650 // If there was a closing brace then identify the span to remove any trailing commas from
2651 // previous imports.
2652 if found_closing_brace {
2653 if let Some(span) = extend_span_to_previous_binding(self.session, span) {
2654 err.tool_only_span_suggestion(span, message, String::new(),
2655 Applicability::MaybeIncorrect);
2657 // Remove the entire line if we cannot extend the span back, this indicates a
2658 // `issue_52891::{self}` case.
2659 err.span_suggestion(directive.use_span_with_attributes, message, String::new(),
2660 Applicability::MaybeIncorrect);
2666 err.span_suggestion(span, message, String::new(), Applicability::MachineApplicable);
2669 fn extern_prelude_get(&mut self, ident: Ident, speculative: bool)
2670 -> Option<&'a NameBinding<'a>> {
2671 if ident.is_path_segment_keyword() {
2672 // Make sure `self`, `super` etc produce an error when passed to here.
2675 self.extern_prelude.get(&ident.modern()).cloned().and_then(|entry| {
2676 if let Some(binding) = entry.extern_crate_item {
2677 if !speculative && entry.introduced_by_item {
2678 self.record_use(ident, TypeNS, binding, false);
2682 let crate_id = if !speculative {
2683 self.crate_loader.process_path_extern(ident.name, ident.span)
2684 } else if let Some(crate_id) =
2685 self.crate_loader.maybe_process_path_extern(ident.name, ident.span) {
2690 let crate_root = self.get_module(DefId { krate: crate_id, index: CRATE_DEF_INDEX });
2691 Some((crate_root, ty::Visibility::Public, DUMMY_SP, ExpnId::root())
2692 .to_name_binding(self.arenas))
2697 /// Rustdoc uses this to resolve things in a recoverable way. `ResolutionError<'a>`
2698 /// isn't something that can be returned because it can't be made to live that long,
2699 /// and also it's a private type. Fortunately rustdoc doesn't need to know the error,
2700 /// just that an error occurred.
2701 // FIXME(Manishearth): intra-doc links won't get warned of epoch changes.
2702 pub fn resolve_str_path_error(
2703 &mut self, span: Span, path_str: &str, ns: Namespace, module_id: NodeId
2704 ) -> Result<(ast::Path, Res), ()> {
2705 let path = if path_str.starts_with("::") {
2708 segments: iter::once(Ident::with_dummy_span(kw::PathRoot))
2710 path_str.split("::").skip(1).map(Ident::from_str)
2712 .map(|i| self.new_ast_path_segment(i))
2720 .map(Ident::from_str)
2721 .map(|i| self.new_ast_path_segment(i))
2725 let module = self.block_map.get(&module_id).copied().unwrap_or_else(|| {
2726 let def_id = self.definitions.local_def_id(module_id);
2727 self.module_map.get(&def_id).copied().unwrap_or(self.graph_root)
2729 let parent_scope = &ParentScope::module(module);
2730 let res = self.resolve_ast_path(&path, ns, parent_scope).map_err(|_| ())?;
2734 // Resolve a path passed from rustdoc or HIR lowering.
2735 fn resolve_ast_path(
2739 parent_scope: &ParentScope<'a>,
2740 ) -> Result<Res, (Span, ResolutionError<'a>)> {
2741 match self.resolve_path(
2742 &Segment::from_path(path), Some(ns), parent_scope, true, path.span, CrateLint::No
2744 PathResult::Module(ModuleOrUniformRoot::Module(module)) =>
2745 Ok(module.res().unwrap()),
2746 PathResult::NonModule(path_res) if path_res.unresolved_segments() == 0 =>
2747 Ok(path_res.base_res()),
2748 PathResult::NonModule(..) => {
2749 Err((path.span, ResolutionError::FailedToResolve {
2750 label: String::from("type-relative paths are not supported in this context"),
2754 PathResult::Module(..) | PathResult::Indeterminate => unreachable!(),
2755 PathResult::Failed { span, label, suggestion, .. } => {
2756 Err((span, ResolutionError::FailedToResolve {
2764 fn new_ast_path_segment(&self, ident: Ident) -> ast::PathSegment {
2765 let mut seg = ast::PathSegment::from_ident(ident);
2766 seg.id = self.session.next_node_id();
2771 fn names_to_string(names: &[Name]) -> String {
2772 let mut result = String::new();
2773 for (i, name) in names.iter()
2774 .filter(|name| **name != kw::PathRoot)
2777 result.push_str("::");
2779 result.push_str(&name.as_str());
2784 fn path_names_to_string(path: &Path) -> String {
2785 names_to_string(&path.segments.iter()
2786 .map(|seg| seg.ident.name)
2787 .collect::<Vec<_>>())
2790 /// A somewhat inefficient routine to obtain the name of a module.
2791 fn module_to_string(module: Module<'_>) -> Option<String> {
2792 let mut names = Vec::new();
2794 fn collect_mod(names: &mut Vec<Name>, module: Module<'_>) {
2795 if let ModuleKind::Def(.., name) = module.kind {
2796 if let Some(parent) = module.parent {
2798 collect_mod(names, parent);
2801 names.push(Name::intern("<opaque>"));
2802 collect_mod(names, module.parent.unwrap());
2805 collect_mod(&mut names, module);
2807 if names.is_empty() {
2811 Some(names_to_string(&names))
2814 #[derive(Copy, Clone, Debug)]
2816 /// Do not issue the lint.
2819 /// This lint applies to some arbitrary path; e.g., `impl ::foo::Bar`.
2820 /// In this case, we can take the span of that path.
2823 /// This lint comes from a `use` statement. In this case, what we
2824 /// care about really is the *root* `use` statement; e.g., if we
2825 /// have nested things like `use a::{b, c}`, we care about the
2827 UsePath { root_id: NodeId, root_span: Span },
2829 /// This is the "trait item" from a fully qualified path. For example,
2830 /// we might be resolving `X::Y::Z` from a path like `<T as X::Y>::Z`.
2831 /// The `path_span` is the span of the to the trait itself (`X::Y`).
2832 QPathTrait { qpath_id: NodeId, qpath_span: Span },
2836 fn node_id(&self) -> Option<NodeId> {
2838 CrateLint::No => None,
2839 CrateLint::SimplePath(id) |
2840 CrateLint::UsePath { root_id: id, .. } |
2841 CrateLint::QPathTrait { qpath_id: id, .. } => Some(id),