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(crate_visibility_modifier)]
13 #![feature(label_break_value)]
16 #![recursion_limit="256"]
18 pub use rustc::hir::def::{Namespace, PerNS};
22 use rustc::hir::map::Definitions;
23 use rustc::hir::{self, PrimTy, Bool, Char, Float, Int, Uint, Str};
24 use rustc::middle::cstore::{CrateStore, MetadataLoaderDyn};
25 use rustc::session::Session;
27 use rustc::hir::def::{self, DefKind, PartialRes, CtorKind, CtorOf, NonMacroAttrKind, ExportMap};
28 use rustc::hir::def::Namespace::*;
29 use rustc::hir::def_id::{CRATE_DEF_INDEX, LOCAL_CRATE, CrateNum, DefId};
30 use rustc::hir::{TraitMap, GlobMap};
31 use rustc::ty::{self, DefIdTree, ResolverOutputs};
32 use rustc::util::nodemap::{NodeMap, NodeSet, FxHashMap, FxHashSet, DefIdMap};
35 use rustc_metadata::creader::CrateLoader;
36 use rustc_metadata::cstore::CStore;
38 use syntax::{struct_span_err, unwrap_or};
39 use syntax::ast::{self, Name, NodeId, Ident, FloatTy, IntTy, UintTy};
40 use syntax::ast::{CRATE_NODE_ID, Crate};
41 use syntax::ast::{ItemKind, Path};
43 use syntax::print::pprust;
44 use syntax::symbol::{kw, sym};
45 use syntax::source_map::Spanned;
46 use syntax::visit::{self, Visitor};
47 use syntax_expand::base::SyntaxExtension;
48 use syntax_pos::hygiene::{MacroKind, ExpnId, ExpnKind, Transparency, SyntaxContext};
49 use syntax_pos::{Span, DUMMY_SP};
50 use errors::{Applicability, DiagnosticBuilder};
54 use std::cell::{Cell, RefCell};
55 use std::{cmp, fmt, iter, ptr};
56 use std::collections::BTreeSet;
57 use rustc_data_structures::ptr_key::PtrKey;
58 use rustc_data_structures::sync::Lrc;
59 use rustc_data_structures::fx::FxIndexMap;
61 use diagnostics::{Suggestion, ImportSuggestion};
62 use diagnostics::{find_span_of_binding_until_next_binding, extend_span_to_previous_binding};
63 use late::{HasGenericParams, PathSource, Rib, RibKind::*};
64 use resolve_imports::{ImportDirective, ImportDirectiveSubclass, NameResolution, ImportResolver};
65 use macros::{LegacyBinding, LegacyScope};
67 use rustc_error_codes::*;
69 type Res = def::Res<NodeId>;
75 mod build_reduced_graph;
83 #[derive(Copy, Clone, PartialEq, Debug)]
84 pub enum Determinacy {
90 fn determined(determined: bool) -> Determinacy {
91 if determined { Determinacy::Determined } else { Determinacy::Undetermined }
95 /// A specific scope in which a name can be looked up.
96 /// This enum is currently used only for early resolution (imports and macros),
97 /// but not for late resolution yet.
98 #[derive(Clone, Copy)]
100 DeriveHelpers(ExpnId),
102 MacroRules(LegacyScope<'a>),
114 /// Names from different contexts may want to visit different subsets of all specific scopes
115 /// with different restrictions when looking up the resolution.
116 /// This enum is currently used only for early resolution (imports and macros),
117 /// but not for late resolution yet.
119 /// All scopes with the given namespace.
120 All(Namespace, /*is_import*/ bool),
121 /// Crate root, then extern prelude (used for mixed 2015-2018 mode in macros).
122 AbsolutePath(Namespace),
123 /// All scopes with macro namespace and the given macro kind restriction.
127 /// Everything you need to know about a name's location to resolve it.
128 /// Serves as a starting point for the scope visitor.
129 /// This struct is currently used only for early resolution (imports and macros),
130 /// but not for late resolution yet.
131 #[derive(Clone, Copy, Debug)]
132 pub struct ParentScope<'a> {
135 legacy: LegacyScope<'a>,
136 derives: &'a [ast::Path],
139 impl<'a> ParentScope<'a> {
140 /// Creates a parent scope with the passed argument used as the module scope component,
141 /// and other scope components set to default empty values.
142 pub fn module(module: Module<'a>) -> ParentScope<'a> {
145 expansion: ExpnId::root(),
146 legacy: LegacyScope::Empty,
153 struct BindingError {
155 origin: BTreeSet<Span>,
156 target: BTreeSet<Span>,
160 impl PartialOrd for BindingError {
161 fn partial_cmp(&self, other: &BindingError) -> Option<cmp::Ordering> {
162 Some(self.cmp(other))
166 impl PartialEq for BindingError {
167 fn eq(&self, other: &BindingError) -> bool {
168 self.name == other.name
172 impl Ord for BindingError {
173 fn cmp(&self, other: &BindingError) -> cmp::Ordering {
174 self.name.cmp(&other.name)
178 enum ResolutionError<'a> {
179 /// Error E0401: can't use type or const parameters from outer function.
180 GenericParamsFromOuterFunction(Res, HasGenericParams),
181 /// Error E0403: the name is already used for a type or const parameter in this generic
183 NameAlreadyUsedInParameterList(Name, Span),
184 /// Error E0407: method is not a member of trait.
185 MethodNotMemberOfTrait(Name, &'a str),
186 /// Error E0437: type is not a member of trait.
187 TypeNotMemberOfTrait(Name, &'a str),
188 /// Error E0438: const is not a member of trait.
189 ConstNotMemberOfTrait(Name, &'a str),
190 /// Error E0408: variable `{}` is not bound in all patterns.
191 VariableNotBoundInPattern(&'a BindingError),
192 /// Error E0409: variable `{}` is bound in inconsistent ways within the same match arm.
193 VariableBoundWithDifferentMode(Name, Span),
194 /// Error E0415: identifier is bound more than once in this parameter list.
195 IdentifierBoundMoreThanOnceInParameterList(&'a str),
196 /// Error E0416: identifier is bound more than once in the same pattern.
197 IdentifierBoundMoreThanOnceInSamePattern(&'a str),
198 /// Error E0426: use of undeclared label.
199 UndeclaredLabel(&'a str, Option<Name>),
200 /// Error E0429: `self` imports are only allowed within a `{ }` list.
201 SelfImportsOnlyAllowedWithin,
202 /// Error E0430: `self` import can only appear once in the list.
203 SelfImportCanOnlyAppearOnceInTheList,
204 /// Error E0431: `self` import can only appear in an import list with a non-empty prefix.
205 SelfImportOnlyInImportListWithNonEmptyPrefix,
206 /// Error E0433: failed to resolve.
207 FailedToResolve { label: String, suggestion: Option<Suggestion> },
208 /// Error E0434: can't capture dynamic environment in a fn item.
209 CannotCaptureDynamicEnvironmentInFnItem,
210 /// Error E0435: attempt to use a non-constant value in a constant.
211 AttemptToUseNonConstantValueInConstant,
212 /// Error E0530: `X` bindings cannot shadow `Y`s.
213 BindingShadowsSomethingUnacceptable(&'a str, Name, &'a NameBinding<'a>),
214 /// Error E0128: type parameters with a default cannot use forward-declared identifiers.
215 ForwardDeclaredTyParam, // FIXME(const_generics:defaults)
216 /// Error E0735: type parameters with a default cannot use `Self`
217 SelfInTyParamDefault,
220 // A minimal representation of a path segment. We use this in resolve because
221 // we synthesize 'path segments' which don't have the rest of an AST or HIR
223 #[derive(Clone, Copy, Debug)]
230 fn from_path(path: &Path) -> Vec<Segment> {
231 path.segments.iter().map(|s| s.into()).collect()
234 fn from_ident(ident: Ident) -> Segment {
241 fn names_to_string(segments: &[Segment]) -> String {
242 names_to_string(&segments.iter()
243 .map(|seg| seg.ident.name)
244 .collect::<Vec<_>>())
248 impl<'a> From<&'a ast::PathSegment> for Segment {
249 fn from(seg: &'a ast::PathSegment) -> Segment {
257 struct UsePlacementFinder {
258 target_module: NodeId,
263 impl UsePlacementFinder {
264 fn check(krate: &Crate, target_module: NodeId) -> (Option<Span>, bool) {
265 let mut finder = UsePlacementFinder {
270 visit::walk_crate(&mut finder, krate);
271 (finder.span, finder.found_use)
275 impl<'tcx> Visitor<'tcx> for UsePlacementFinder {
278 module: &'tcx ast::Mod,
280 _: &[ast::Attribute],
283 if self.span.is_some() {
286 if node_id != self.target_module {
287 visit::walk_mod(self, module);
290 // find a use statement
291 for item in &module.items {
293 ItemKind::Use(..) => {
294 // don't suggest placing a use before the prelude
295 // import or other generated ones
296 if !item.span.from_expansion() {
297 self.span = Some(item.span.shrink_to_lo());
298 self.found_use = true;
302 // don't place use before extern crate
303 ItemKind::ExternCrate(_) => {}
304 // but place them before the first other item
305 _ => if self.span.map_or(true, |span| item.span < span ) {
306 if !item.span.from_expansion() {
307 // don't insert between attributes and an item
308 if item.attrs.is_empty() {
309 self.span = Some(item.span.shrink_to_lo());
311 // find the first attribute on the item
312 for attr in &item.attrs {
313 if self.span.map_or(true, |span| attr.span < span) {
314 self.span = Some(attr.span.shrink_to_lo());
325 /// An intermediate resolution result.
327 /// This refers to the thing referred by a name. The difference between `Res` and `Item` is that
328 /// items are visible in their whole block, while `Res`es only from the place they are defined
331 enum LexicalScopeBinding<'a> {
332 Item(&'a NameBinding<'a>),
336 impl<'a> LexicalScopeBinding<'a> {
337 fn item(self) -> Option<&'a NameBinding<'a>> {
339 LexicalScopeBinding::Item(binding) => Some(binding),
344 fn res(self) -> Res {
346 LexicalScopeBinding::Item(binding) => binding.res(),
347 LexicalScopeBinding::Res(res) => res,
352 #[derive(Copy, Clone, Debug)]
353 enum ModuleOrUniformRoot<'a> {
357 /// Virtual module that denotes resolution in crate root with fallback to extern prelude.
358 CrateRootAndExternPrelude,
360 /// Virtual module that denotes resolution in extern prelude.
361 /// Used for paths starting with `::` on 2018 edition.
364 /// Virtual module that denotes resolution in current scope.
365 /// Used only for resolving single-segment imports. The reason it exists is that import paths
366 /// are always split into two parts, the first of which should be some kind of module.
370 impl ModuleOrUniformRoot<'_> {
371 fn same_def(lhs: Self, rhs: Self) -> bool {
373 (ModuleOrUniformRoot::Module(lhs),
374 ModuleOrUniformRoot::Module(rhs)) => lhs.def_id() == rhs.def_id(),
375 (ModuleOrUniformRoot::CrateRootAndExternPrelude,
376 ModuleOrUniformRoot::CrateRootAndExternPrelude) |
377 (ModuleOrUniformRoot::ExternPrelude, ModuleOrUniformRoot::ExternPrelude) |
378 (ModuleOrUniformRoot::CurrentScope, ModuleOrUniformRoot::CurrentScope) => true,
384 #[derive(Clone, Debug)]
385 enum PathResult<'a> {
386 Module(ModuleOrUniformRoot<'a>),
387 NonModule(PartialRes),
392 suggestion: Option<Suggestion>,
393 is_error_from_last_segment: bool,
398 /// An anonymous module; e.g., just a block.
403 /// { // This is an anonymous module
404 /// f(); // This resolves to (2) as we are inside the block.
407 /// f(); // Resolves to (1)
411 /// Any module with a name.
415 /// * A normal module ‒ either `mod from_file;` or `mod from_block { }`.
416 /// * A trait or an enum (it implicitly contains associated types, methods and variant
418 Def(DefKind, DefId, Name),
422 /// Get name of the module.
423 pub fn name(&self) -> Option<Name> {
425 ModuleKind::Block(..) => None,
426 ModuleKind::Def(.., name) => Some(*name),
431 /// A key that identifies a binding in a given `Module`.
433 /// Multiple bindings in the same module can have the same key (in a valid
434 /// program) if all but one of them come from glob imports.
435 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
437 /// The identifier for the binding, aways the `modern` version of the
441 /// 0 if ident is not `_`, otherwise a value that's unique to the specific
442 /// `_` in the expanded AST that introduced this binding.
446 type Resolutions<'a> = RefCell<FxIndexMap<BindingKey, &'a RefCell<NameResolution<'a>>>>;
448 /// One node in the tree of modules.
449 pub struct ModuleData<'a> {
450 parent: Option<Module<'a>>,
453 // The def id of the closest normal module (`mod`) ancestor (including this module).
454 normal_ancestor_id: DefId,
456 // Mapping between names and their (possibly in-progress) resolutions in this module.
457 // Resolutions in modules from other crates are not populated until accessed.
458 lazy_resolutions: Resolutions<'a>,
459 // True if this is a module from other crate that needs to be populated on access.
460 populate_on_access: Cell<bool>,
462 // Macro invocations that can expand into items in this module.
463 unexpanded_invocations: RefCell<FxHashSet<ExpnId>>,
465 no_implicit_prelude: bool,
467 glob_importers: RefCell<Vec<&'a ImportDirective<'a>>>,
468 globs: RefCell<Vec<&'a ImportDirective<'a>>>,
470 // Used to memoize the traits in this module for faster searches through all traits in scope.
471 traits: RefCell<Option<Box<[(Ident, &'a NameBinding<'a>)]>>>,
473 /// Span of the module itself. Used for error reporting.
479 type Module<'a> = &'a ModuleData<'a>;
481 impl<'a> ModuleData<'a> {
482 fn new(parent: Option<Module<'a>>,
484 normal_ancestor_id: DefId,
486 span: Span) -> Self {
491 lazy_resolutions: Default::default(),
492 populate_on_access: Cell::new(!normal_ancestor_id.is_local()),
493 unexpanded_invocations: Default::default(),
494 no_implicit_prelude: false,
495 glob_importers: RefCell::new(Vec::new()),
496 globs: RefCell::new(Vec::new()),
497 traits: RefCell::new(None),
503 fn for_each_child<R, F>(&'a self, resolver: &mut R, mut f: F)
504 where R: AsMut<Resolver<'a>>, F: FnMut(&mut R, Ident, Namespace, &'a NameBinding<'a>)
506 for (key, name_resolution) in resolver.as_mut().resolutions(self).borrow().iter() {
507 name_resolution.borrow().binding.map(|binding| f(resolver, key.ident, key.ns, binding));
511 fn res(&self) -> Option<Res> {
513 ModuleKind::Def(kind, def_id, _) => Some(Res::Def(kind, def_id)),
518 fn def_id(&self) -> Option<DefId> {
520 ModuleKind::Def(_, def_id, _) => Some(def_id),
525 // `self` resolves to the first module ancestor that `is_normal`.
526 fn is_normal(&self) -> bool {
528 ModuleKind::Def(DefKind::Mod, _, _) => true,
533 fn is_trait(&self) -> bool {
535 ModuleKind::Def(DefKind::Trait, _, _) => true,
540 fn nearest_item_scope(&'a self) -> Module<'a> {
542 ModuleKind::Def(DefKind::Enum, ..) | ModuleKind::Def(DefKind::Trait, ..) =>
543 self.parent.expect("enum or trait module without a parent"),
548 fn is_ancestor_of(&self, mut other: &Self) -> bool {
549 while !ptr::eq(self, other) {
550 if let Some(parent) = other.parent {
560 impl<'a> fmt::Debug for ModuleData<'a> {
561 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
562 write!(f, "{:?}", self.res())
566 /// Records a possibly-private value, type, or module definition.
567 #[derive(Clone, Debug)]
568 pub struct NameBinding<'a> {
569 kind: NameBindingKind<'a>,
570 ambiguity: Option<(&'a NameBinding<'a>, AmbiguityKind)>,
576 pub trait ToNameBinding<'a> {
577 fn to_name_binding(self, arenas: &'a ResolverArenas<'a>) -> &'a NameBinding<'a>;
580 impl<'a> ToNameBinding<'a> for &'a NameBinding<'a> {
581 fn to_name_binding(self, _: &'a ResolverArenas<'a>) -> &'a NameBinding<'a> {
586 #[derive(Clone, Debug)]
587 enum NameBindingKind<'a> {
588 Res(Res, /* is_macro_export */ bool),
591 binding: &'a NameBinding<'a>,
592 directive: &'a ImportDirective<'a>,
597 impl<'a> NameBindingKind<'a> {
598 /// Is this a name binding of a import?
599 fn is_import(&self) -> bool {
601 NameBindingKind::Import { .. } => true,
607 struct PrivacyError<'a>(Span, Ident, &'a NameBinding<'a>);
609 struct UseError<'a> {
610 err: DiagnosticBuilder<'a>,
611 /// Attach `use` statements for these candidates.
612 candidates: Vec<ImportSuggestion>,
613 /// The `NodeId` of the module to place the use-statements in.
615 /// Whether the diagnostic should state that it's "better".
619 #[derive(Clone, Copy, PartialEq, Debug)]
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::LegacyVsModern =>
641 "`macro_rules` vs non-`macro_rules` from other module",
642 AmbiguityKind::GlobVsOuter =>
643 "glob import vs any other name from outer scope during import/macro resolution",
644 AmbiguityKind::GlobVsGlob =>
645 "glob import vs glob import in the same module",
646 AmbiguityKind::GlobVsExpanded =>
647 "glob import vs macro-expanded name in the same \
648 module during import/macro resolution",
649 AmbiguityKind::MoreExpandedVsOuter =>
650 "macro-expanded name vs less macro-expanded name \
651 from outer scope during import/macro resolution",
656 /// Miscellaneous bits of metadata for better ambiguity error reporting.
657 #[derive(Clone, Copy, PartialEq)]
658 enum AmbiguityErrorMisc {
665 struct AmbiguityError<'a> {
668 b1: &'a NameBinding<'a>,
669 b2: &'a NameBinding<'a>,
670 misc1: AmbiguityErrorMisc,
671 misc2: AmbiguityErrorMisc,
674 impl<'a> NameBinding<'a> {
675 fn module(&self) -> Option<Module<'a>> {
677 NameBindingKind::Module(module) => Some(module),
678 NameBindingKind::Import { binding, .. } => binding.module(),
683 fn res(&self) -> Res {
685 NameBindingKind::Res(res, _) => res,
686 NameBindingKind::Module(module) => module.res().unwrap(),
687 NameBindingKind::Import { binding, .. } => binding.res(),
691 fn is_ambiguity(&self) -> bool {
692 self.ambiguity.is_some() || match self.kind {
693 NameBindingKind::Import { binding, .. } => binding.is_ambiguity(),
698 // We sometimes need to treat variants as `pub` for backwards compatibility.
699 fn pseudo_vis(&self) -> ty::Visibility {
700 if self.is_variant() && self.res().def_id().is_local() {
701 ty::Visibility::Public
707 fn is_variant(&self) -> bool {
709 NameBindingKind::Res(Res::Def(DefKind::Variant, _), _) |
710 NameBindingKind::Res(Res::Def(DefKind::Ctor(CtorOf::Variant, ..), _), _) => true,
715 fn is_extern_crate(&self) -> bool {
717 NameBindingKind::Import {
718 directive: &ImportDirective {
719 subclass: ImportDirectiveSubclass::ExternCrate { .. }, ..
722 NameBindingKind::Module(
723 &ModuleData { kind: ModuleKind::Def(DefKind::Mod, def_id, _), .. }
724 ) => def_id.index == CRATE_DEF_INDEX,
729 fn is_import(&self) -> bool {
731 NameBindingKind::Import { .. } => true,
736 fn is_glob_import(&self) -> bool {
738 NameBindingKind::Import { directive, .. } => directive.is_glob(),
743 fn is_importable(&self) -> bool {
745 Res::Def(DefKind::AssocConst, _)
746 | Res::Def(DefKind::Method, _)
747 | Res::Def(DefKind::AssocTy, _) => false,
752 fn is_macro_def(&self) -> bool {
754 NameBindingKind::Res(Res::Def(DefKind::Macro(..), _), _) => true,
759 fn macro_kind(&self) -> Option<MacroKind> {
760 self.res().macro_kind()
763 // Suppose that we resolved macro invocation with `invoc_parent_expansion` to binding `binding`
764 // at some expansion round `max(invoc, binding)` when they both emerged from macros.
765 // Then this function returns `true` if `self` may emerge from a macro *after* that
766 // in some later round and screw up our previously found resolution.
767 // See more detailed explanation in
768 // https://github.com/rust-lang/rust/pull/53778#issuecomment-419224049
769 fn may_appear_after(&self, invoc_parent_expansion: ExpnId, binding: &NameBinding<'_>) -> bool {
770 // self > max(invoc, binding) => !(self <= invoc || self <= binding)
771 // Expansions are partially ordered, so "may appear after" is an inversion of
772 // "certainly appears before or simultaneously" and includes unordered cases.
773 let self_parent_expansion = self.expansion;
774 let other_parent_expansion = binding.expansion;
775 let certainly_before_other_or_simultaneously =
776 other_parent_expansion.is_descendant_of(self_parent_expansion);
777 let certainly_before_invoc_or_simultaneously =
778 invoc_parent_expansion.is_descendant_of(self_parent_expansion);
779 !(certainly_before_other_or_simultaneously || certainly_before_invoc_or_simultaneously)
783 /// Interns the names of the primitive types.
785 /// All other types are defined somewhere and possibly imported, but the primitive ones need
786 /// special handling, since they have no place of origin.
787 struct PrimitiveTypeTable {
788 primitive_types: FxHashMap<Name, PrimTy>,
791 impl PrimitiveTypeTable {
792 fn new() -> PrimitiveTypeTable {
793 let mut table = FxHashMap::default();
795 table.insert(sym::bool, Bool);
796 table.insert(sym::char, Char);
797 table.insert(sym::f32, Float(FloatTy::F32));
798 table.insert(sym::f64, Float(FloatTy::F64));
799 table.insert(sym::isize, Int(IntTy::Isize));
800 table.insert(sym::i8, Int(IntTy::I8));
801 table.insert(sym::i16, Int(IntTy::I16));
802 table.insert(sym::i32, Int(IntTy::I32));
803 table.insert(sym::i64, Int(IntTy::I64));
804 table.insert(sym::i128, Int(IntTy::I128));
805 table.insert(sym::str, Str);
806 table.insert(sym::usize, Uint(UintTy::Usize));
807 table.insert(sym::u8, Uint(UintTy::U8));
808 table.insert(sym::u16, Uint(UintTy::U16));
809 table.insert(sym::u32, Uint(UintTy::U32));
810 table.insert(sym::u64, Uint(UintTy::U64));
811 table.insert(sym::u128, Uint(UintTy::U128));
812 Self { primitive_types: table }
816 #[derive(Debug, Default, Clone)]
817 pub struct ExternPreludeEntry<'a> {
818 extern_crate_item: Option<&'a NameBinding<'a>>,
819 pub introduced_by_item: bool,
822 /// The main resolver class.
824 /// This is the visitor that walks the whole crate.
825 pub struct Resolver<'a> {
826 session: &'a Session,
828 definitions: Definitions,
830 graph_root: Module<'a>,
832 prelude: Option<Module<'a>>,
833 extern_prelude: FxHashMap<Ident, ExternPreludeEntry<'a>>,
835 /// N.B., this is used only for better diagnostics, not name resolution itself.
836 has_self: FxHashSet<DefId>,
838 /// Names of fields of an item `DefId` accessible with dot syntax.
839 /// Used for hints during error reporting.
840 field_names: FxHashMap<DefId, Vec<Spanned<Name>>>,
842 /// All imports known to succeed or fail.
843 determined_imports: Vec<&'a ImportDirective<'a>>,
845 /// All non-determined imports.
846 indeterminate_imports: Vec<&'a ImportDirective<'a>>,
848 /// FIXME: Refactor things so that these fields are passed through arguments and not resolver.
849 /// We are resolving a last import segment during import validation.
850 last_import_segment: bool,
851 /// This binding should be ignored during in-module resolution, so that we don't get
852 /// "self-confirming" import resolutions during import validation.
853 blacklisted_binding: Option<&'a NameBinding<'a>>,
855 /// The idents for the primitive types.
856 primitive_type_table: PrimitiveTypeTable,
858 /// Resolutions for nodes that have a single resolution.
859 partial_res_map: NodeMap<PartialRes>,
860 /// Resolutions for import nodes, which have multiple resolutions in different namespaces.
861 import_res_map: NodeMap<PerNS<Option<Res>>>,
862 /// Resolutions for labels (node IDs of their corresponding blocks or loops).
863 label_res_map: NodeMap<NodeId>,
865 /// `CrateNum` resolutions of `extern crate` items.
866 extern_crate_map: NodeMap<CrateNum>,
867 export_map: ExportMap<NodeId>,
870 /// A map from nodes to anonymous modules.
871 /// Anonymous modules are pseudo-modules that are implicitly created around items
872 /// contained within blocks.
874 /// For example, if we have this:
882 /// There will be an anonymous module created around `g` with the ID of the
883 /// entry block for `f`.
884 block_map: NodeMap<Module<'a>>,
885 /// A fake module that contains no definition and no prelude. Used so that
886 /// some AST passes can generate identifiers that only resolve to local or
888 empty_module: Module<'a>,
889 module_map: FxHashMap<DefId, Module<'a>>,
890 extern_module_map: FxHashMap<DefId, Module<'a>>,
891 binding_parent_modules: FxHashMap<PtrKey<'a, NameBinding<'a>>, Module<'a>>,
892 underscore_disambiguator: u32,
894 /// Maps glob imports to the names of items actually imported.
897 used_imports: FxHashSet<(NodeId, Namespace)>,
898 maybe_unused_trait_imports: NodeSet,
899 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: CrateLoader<'a>,
914 macro_names: FxHashSet<Ident>,
915 builtin_macros: FxHashMap<Name, SyntaxExtension>,
916 registered_attrs: FxHashSet<Ident>,
917 registered_tools: FxHashSet<Ident>,
918 macro_use_prelude: FxHashMap<Name, &'a NameBinding<'a>>,
919 all_macros: FxHashMap<Name, Res>,
920 macro_map: FxHashMap<DefId, Lrc<SyntaxExtension>>,
921 dummy_ext_bang: Lrc<SyntaxExtension>,
922 dummy_ext_derive: Lrc<SyntaxExtension>,
923 non_macro_attrs: [Lrc<SyntaxExtension>; 2],
924 macro_defs: FxHashMap<ExpnId, DefId>,
925 local_macro_def_scopes: FxHashMap<NodeId, Module<'a>>,
926 ast_transform_scopes: FxHashMap<ExpnId, Module<'a>>,
927 unused_macros: NodeMap<Span>,
928 proc_macro_stubs: NodeSet,
929 /// Traces collected during macro resolution and validated when it's complete.
930 single_segment_macro_resolutions: Vec<(Ident, MacroKind, ParentScope<'a>,
931 Option<&'a NameBinding<'a>>)>,
932 multi_segment_macro_resolutions: Vec<(Vec<Segment>, Span, MacroKind, ParentScope<'a>,
934 builtin_attrs: Vec<(Ident, ParentScope<'a>)>,
935 /// `derive(Copy)` marks items they are applied to so they are treated specially later.
936 /// Derive macros cannot modify the item themselves and have to store the markers in the global
937 /// context, so they attach the markers to derive container IDs using this resolver table.
938 containers_deriving_copy: FxHashSet<ExpnId>,
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>>,
945 /// Helper attributes that are in scope for the given expansion.
946 helper_attrs: FxHashMap<ExpnId, Vec<Ident>>,
948 /// Avoid duplicated errors for "name already defined".
949 name_already_seen: FxHashMap<Name, Span>,
951 potentially_unused_imports: Vec<&'a ImportDirective<'a>>,
953 /// Table for mapping struct IDs into struct constructor IDs,
954 /// it's not used during normal resolution, only for better error reporting.
955 struct_constructors: DefIdMap<(Res, ty::Visibility)>,
957 /// Features enabled for this crate.
958 active_features: FxHashSet<Name>,
960 /// Stores enum visibilities to properly build a reduced graph
961 /// when visiting the correspondent variants.
962 variant_vis: DefIdMap<ty::Visibility>,
964 lint_buffer: lint::LintBuffer,
966 next_node_id: NodeId,
969 /// Nothing really interesting here; it just provides memory for the rest of the crate.
971 pub struct ResolverArenas<'a> {
972 modules: arena::TypedArena<ModuleData<'a>>,
973 local_modules: RefCell<Vec<Module<'a>>>,
974 name_bindings: arena::TypedArena<NameBinding<'a>>,
975 import_directives: arena::TypedArena<ImportDirective<'a>>,
976 name_resolutions: arena::TypedArena<RefCell<NameResolution<'a>>>,
977 legacy_bindings: arena::TypedArena<LegacyBinding<'a>>,
978 ast_paths: arena::TypedArena<ast::Path>,
981 impl<'a> ResolverArenas<'a> {
982 fn alloc_module(&'a self, module: ModuleData<'a>) -> Module<'a> {
983 let module = self.modules.alloc(module);
984 if module.def_id().map(|def_id| def_id.is_local()).unwrap_or(true) {
985 self.local_modules.borrow_mut().push(module);
989 fn local_modules(&'a self) -> std::cell::Ref<'a, Vec<Module<'a>>> {
990 self.local_modules.borrow()
992 fn alloc_name_binding(&'a self, name_binding: NameBinding<'a>) -> &'a NameBinding<'a> {
993 self.name_bindings.alloc(name_binding)
995 fn alloc_import_directive(&'a self, import_directive: ImportDirective<'a>)
996 -> &'a ImportDirective<'_> {
997 self.import_directives.alloc(import_directive)
999 fn alloc_name_resolution(&'a self) -> &'a RefCell<NameResolution<'a>> {
1000 self.name_resolutions.alloc(Default::default())
1002 fn alloc_legacy_binding(&'a self, binding: LegacyBinding<'a>) -> &'a LegacyBinding<'a> {
1003 self.legacy_bindings.alloc(binding)
1005 fn alloc_ast_paths(&'a self, paths: &[ast::Path]) -> &'a [ast::Path] {
1006 self.ast_paths.alloc_from_iter(paths.iter().cloned())
1010 impl<'a> AsMut<Resolver<'a>> for Resolver<'a> {
1011 fn as_mut(&mut self) -> &mut Resolver<'a> { self }
1014 impl<'a, 'b> DefIdTree for &'a Resolver<'b> {
1015 fn parent(self, id: DefId) -> Option<DefId> {
1017 LOCAL_CRATE => self.definitions.def_key(id.index).parent,
1018 _ => self.cstore().def_key(id).parent,
1019 }.map(|index| DefId { index, ..id })
1023 /// This interface is used through the AST→HIR step, to embed full paths into the HIR. After that
1024 /// the resolver is no longer needed as all the relevant information is inline.
1025 impl<'a> hir::lowering::Resolver for Resolver<'a> {
1026 fn cstore(&self) -> &dyn CrateStore {
1030 fn resolve_str_path(
1033 crate_root: Option<Name>,
1034 components: &[Name],
1036 ) -> (ast::Path, Res) {
1037 let root = if crate_root.is_some() {
1042 let segments = iter::once(Ident::with_dummy_span(root))
1044 crate_root.into_iter()
1045 .chain(components.iter().cloned())
1046 .map(Ident::with_dummy_span)
1047 ).map(|i| self.new_ast_path_segment(i)).collect::<Vec<_>>();
1049 let path = ast::Path {
1054 let parent_scope = &ParentScope::module(self.graph_root);
1055 let res = match self.resolve_ast_path(&path, ns, parent_scope) {
1057 Err((span, error)) => {
1058 self.report_error(span, error);
1065 fn get_partial_res(&mut self, id: NodeId) -> Option<PartialRes> {
1066 self.partial_res_map.get(&id).cloned()
1069 fn get_import_res(&mut self, id: NodeId) -> PerNS<Option<Res>> {
1070 self.import_res_map.get(&id).cloned().unwrap_or_default()
1073 fn get_label_res(&mut self, id: NodeId) -> Option<NodeId> {
1074 self.label_res_map.get(&id).cloned()
1077 fn definitions(&mut self) -> &mut Definitions {
1078 &mut self.definitions
1081 fn lint_buffer(&mut self) -> &mut lint::LintBuffer {
1082 &mut self.lint_buffer
1085 fn next_node_id(&mut self) -> NodeId {
1090 impl<'a> Resolver<'a> {
1091 pub fn new(session: &'a Session,
1094 metadata_loader: &'a MetadataLoaderDyn,
1095 arenas: &'a ResolverArenas<'a>)
1097 let root_def_id = DefId::local(CRATE_DEF_INDEX);
1098 let root_module_kind = ModuleKind::Def(
1103 let graph_root = arenas.alloc_module(ModuleData {
1104 no_implicit_prelude: attr::contains_name(&krate.attrs, sym::no_implicit_prelude),
1105 ..ModuleData::new(None, root_module_kind, root_def_id, ExpnId::root(), krate.span)
1107 let empty_module_kind = ModuleKind::Def(
1112 let empty_module = arenas.alloc_module(ModuleData {
1113 no_implicit_prelude: true,
1122 let mut module_map = FxHashMap::default();
1123 module_map.insert(DefId::local(CRATE_DEF_INDEX), graph_root);
1125 let mut definitions = Definitions::default();
1126 definitions.create_root_def(crate_name, session.local_crate_disambiguator());
1128 let mut extern_prelude: FxHashMap<Ident, ExternPreludeEntry<'_>> =
1129 session.opts.externs.iter().map(|kv| (Ident::from_str(kv.0), Default::default()))
1132 if !attr::contains_name(&krate.attrs, sym::no_core) {
1133 extern_prelude.insert(Ident::with_dummy_span(sym::core), Default::default());
1134 if !attr::contains_name(&krate.attrs, sym::no_std) {
1135 extern_prelude.insert(Ident::with_dummy_span(sym::std), Default::default());
1136 if session.rust_2018() {
1137 extern_prelude.insert(Ident::with_dummy_span(sym::meta), Default::default());
1142 let (registered_attrs, registered_tools) =
1143 macros::registered_attrs_and_tools(session, &krate.attrs);
1145 let mut invocation_parent_scopes = FxHashMap::default();
1146 invocation_parent_scopes.insert(ExpnId::root(), ParentScope::module(graph_root));
1148 let mut macro_defs = FxHashMap::default();
1149 macro_defs.insert(ExpnId::root(), root_def_id);
1151 let features = session.features_untracked();
1152 let non_macro_attr =
1153 |mark_used| Lrc::new(SyntaxExtension::non_macro_attr(mark_used, session.edition()));
1160 // The outermost module has def ID 0; this is not reflected in the
1166 has_self: FxHashSet::default(),
1167 field_names: FxHashMap::default(),
1169 determined_imports: Vec::new(),
1170 indeterminate_imports: Vec::new(),
1172 last_import_segment: false,
1173 blacklisted_binding: None,
1175 primitive_type_table: PrimitiveTypeTable::new(),
1177 partial_res_map: Default::default(),
1178 import_res_map: Default::default(),
1179 label_res_map: Default::default(),
1180 extern_crate_map: Default::default(),
1181 export_map: FxHashMap::default(),
1182 trait_map: Default::default(),
1183 underscore_disambiguator: 0,
1186 block_map: Default::default(),
1187 extern_module_map: FxHashMap::default(),
1188 binding_parent_modules: FxHashMap::default(),
1189 ast_transform_scopes: FxHashMap::default(),
1191 glob_map: Default::default(),
1193 used_imports: FxHashSet::default(),
1194 maybe_unused_trait_imports: Default::default(),
1195 maybe_unused_extern_crates: Vec::new(),
1197 privacy_errors: Vec::new(),
1198 ambiguity_errors: Vec::new(),
1199 use_injections: Vec::new(),
1200 macro_expanded_macro_export_errors: BTreeSet::new(),
1203 dummy_binding: arenas.alloc_name_binding(NameBinding {
1204 kind: NameBindingKind::Res(Res::Err, false),
1206 expansion: ExpnId::root(),
1208 vis: ty::Visibility::Public,
1211 crate_loader: CrateLoader::new(session, metadata_loader, crate_name),
1212 macro_names: FxHashSet::default(),
1213 builtin_macros: Default::default(),
1216 macro_use_prelude: FxHashMap::default(),
1217 all_macros: FxHashMap::default(),
1218 macro_map: FxHashMap::default(),
1219 dummy_ext_bang: Lrc::new(SyntaxExtension::dummy_bang(session.edition())),
1220 dummy_ext_derive: Lrc::new(SyntaxExtension::dummy_derive(session.edition())),
1221 non_macro_attrs: [non_macro_attr(false), non_macro_attr(true)],
1222 invocation_parent_scopes,
1223 output_legacy_scopes: Default::default(),
1224 helper_attrs: Default::default(),
1226 local_macro_def_scopes: FxHashMap::default(),
1227 name_already_seen: FxHashMap::default(),
1228 potentially_unused_imports: Vec::new(),
1229 struct_constructors: Default::default(),
1230 unused_macros: Default::default(),
1231 proc_macro_stubs: Default::default(),
1232 single_segment_macro_resolutions: Default::default(),
1233 multi_segment_macro_resolutions: Default::default(),
1234 builtin_attrs: Default::default(),
1235 containers_deriving_copy: Default::default(),
1237 features.declared_lib_features.iter().map(|(feat, ..)| *feat)
1238 .chain(features.declared_lang_features.iter().map(|(feat, ..)| *feat))
1240 variant_vis: Default::default(),
1241 lint_buffer: lint::LintBuffer::default(),
1242 next_node_id: NodeId::from_u32(1),
1246 pub fn next_node_id(&mut self) -> NodeId {
1247 let next = self.next_node_id.as_usize()
1249 .expect("input too large; ran out of NodeIds");
1250 self.next_node_id = ast::NodeId::from_usize(next);
1254 pub fn lint_buffer(&mut self) -> &mut lint::LintBuffer {
1255 &mut self.lint_buffer
1258 pub fn arenas() -> ResolverArenas<'a> {
1262 pub fn into_outputs(self) -> ResolverOutputs {
1264 definitions: self.definitions,
1265 cstore: Box::new(self.crate_loader.into_cstore()),
1266 extern_crate_map: self.extern_crate_map,
1267 export_map: self.export_map,
1268 trait_map: self.trait_map,
1269 glob_map: self.glob_map,
1270 maybe_unused_trait_imports: self.maybe_unused_trait_imports,
1271 maybe_unused_extern_crates: self.maybe_unused_extern_crates,
1272 extern_prelude: self.extern_prelude.iter().map(|(ident, entry)| {
1273 (ident.name, entry.introduced_by_item)
1278 pub fn clone_outputs(&self) -> ResolverOutputs {
1280 definitions: self.definitions.clone(),
1281 cstore: Box::new(self.cstore().clone()),
1282 extern_crate_map: self.extern_crate_map.clone(),
1283 export_map: self.export_map.clone(),
1284 trait_map: self.trait_map.clone(),
1285 glob_map: self.glob_map.clone(),
1286 maybe_unused_trait_imports: self.maybe_unused_trait_imports.clone(),
1287 maybe_unused_extern_crates: self.maybe_unused_extern_crates.clone(),
1288 extern_prelude: self.extern_prelude.iter().map(|(ident, entry)| {
1289 (ident.name, entry.introduced_by_item)
1294 pub fn cstore(&self) -> &CStore {
1295 self.crate_loader.cstore()
1298 fn non_macro_attr(&self, mark_used: bool) -> Lrc<SyntaxExtension> {
1299 self.non_macro_attrs[mark_used as usize].clone()
1302 fn dummy_ext(&self, macro_kind: MacroKind) -> Lrc<SyntaxExtension> {
1304 MacroKind::Bang => self.dummy_ext_bang.clone(),
1305 MacroKind::Derive => self.dummy_ext_derive.clone(),
1306 MacroKind::Attr => self.non_macro_attr(true),
1310 /// Runs the function on each namespace.
1311 fn per_ns<F: FnMut(&mut Self, Namespace)>(&mut self, mut f: F) {
1317 fn is_builtin_macro(&mut self, res: Res) -> bool {
1318 self.get_macro(res).map_or(false, |ext| ext.is_builtin)
1321 fn macro_def(&self, mut ctxt: SyntaxContext) -> DefId {
1323 match self.macro_defs.get(&ctxt.outer_expn()) {
1324 Some(&def_id) => return def_id,
1325 None => ctxt.remove_mark(),
1330 /// Entry point to crate resolution.
1331 pub fn resolve_crate(&mut self, krate: &Crate) {
1333 self.session.prof.generic_activity("resolve_crate");
1335 ImportResolver { r: self }.finalize_imports();
1336 self.finalize_macro_resolutions();
1338 self.late_resolve_crate(krate);
1340 self.check_unused(krate);
1341 self.report_errors(krate);
1342 self.crate_loader.postprocess(krate);
1349 normal_ancestor_id: DefId,
1353 let module = ModuleData::new(Some(parent), kind, normal_ancestor_id, expn_id, span);
1354 self.arenas.alloc_module(module)
1357 fn new_key(&mut self, ident: Ident, ns: Namespace) -> BindingKey {
1358 let ident = ident.modern();
1359 let disambiguator = if ident.name == kw::Underscore {
1360 self.underscore_disambiguator += 1;
1361 self.underscore_disambiguator
1365 BindingKey { ident, ns, disambiguator }
1368 fn resolutions(&mut self, module: Module<'a>) -> &'a Resolutions<'a> {
1369 if module.populate_on_access.get() {
1370 module.populate_on_access.set(false);
1371 self.build_reduced_graph_external(module);
1373 &module.lazy_resolutions
1376 fn resolution(&mut self, module: Module<'a>, key: BindingKey)
1377 -> &'a RefCell<NameResolution<'a>> {
1378 *self.resolutions(module).borrow_mut().entry(key)
1379 .or_insert_with(|| self.arenas.alloc_name_resolution())
1382 fn record_use(&mut self, ident: Ident, ns: Namespace,
1383 used_binding: &'a NameBinding<'a>, is_lexical_scope: bool) {
1384 if let Some((b2, kind)) = used_binding.ambiguity {
1385 self.ambiguity_errors.push(AmbiguityError {
1386 kind, ident, b1: used_binding, b2,
1387 misc1: AmbiguityErrorMisc::None,
1388 misc2: AmbiguityErrorMisc::None,
1391 if let NameBindingKind::Import { directive, binding, ref used } = used_binding.kind {
1392 // Avoid marking `extern crate` items that refer to a name from extern prelude,
1393 // but not introduce it, as used if they are accessed from lexical scope.
1394 if is_lexical_scope {
1395 if let Some(entry) = self.extern_prelude.get(&ident.modern()) {
1396 if let Some(crate_item) = entry.extern_crate_item {
1397 if ptr::eq(used_binding, crate_item) && !entry.introduced_by_item {
1404 directive.used.set(true);
1405 self.used_imports.insert((directive.id, ns));
1406 self.add_to_glob_map(&directive, ident);
1407 self.record_use(ident, ns, binding, false);
1412 fn add_to_glob_map(&mut self, directive: &ImportDirective<'_>, ident: Ident) {
1413 if directive.is_glob() {
1414 self.glob_map.entry(directive.id).or_default().insert(ident.name);
1418 /// A generic scope visitor.
1419 /// Visits scopes in order to resolve some identifier in them or perform other actions.
1420 /// If the callback returns `Some` result, we stop visiting scopes and return it.
1423 scope_set: ScopeSet,
1424 parent_scope: &ParentScope<'a>,
1426 mut visitor: impl FnMut(&mut Self, Scope<'a>, /*use_prelude*/ bool, Ident) -> Option<T>,
1428 // General principles:
1429 // 1. Not controlled (user-defined) names should have higher priority than controlled names
1430 // built into the language or standard library. This way we can add new names into the
1431 // language or standard library without breaking user code.
1432 // 2. "Closed set" below means new names cannot appear after the current resolution attempt.
1433 // Places to search (in order of decreasing priority):
1435 // 1. FIXME: Ribs (type parameters), there's no necessary infrastructure yet
1436 // (open set, not controlled).
1437 // 2. Names in modules (both normal `mod`ules and blocks), loop through hygienic parents
1438 // (open, not controlled).
1439 // 3. Extern prelude (open, the open part is from macro expansions, not controlled).
1440 // 4. Tool modules (closed, controlled right now, but not in the future).
1441 // 5. Standard library prelude (de-facto closed, controlled).
1442 // 6. Language prelude (closed, controlled).
1444 // 1. FIXME: Ribs (local variables), there's no necessary infrastructure yet
1445 // (open set, not controlled).
1446 // 2. Names in modules (both normal `mod`ules and blocks), loop through hygienic parents
1447 // (open, not controlled).
1448 // 3. Standard library prelude (de-facto closed, controlled).
1450 // 1-3. Derive helpers (open, not controlled). All ambiguities with other names
1451 // are currently reported as errors. They should be higher in priority than preludes
1452 // and probably even names in modules according to the "general principles" above. They
1453 // also should be subject to restricted shadowing because are effectively produced by
1454 // derives (you need to resolve the derive first to add helpers into scope), but they
1455 // should be available before the derive is expanded for compatibility.
1456 // It's mess in general, so we are being conservative for now.
1457 // 1-3. `macro_rules` (open, not controlled), loop through legacy scopes. Have higher
1458 // priority than prelude macros, but create ambiguities with macros in modules.
1459 // 1-3. Names in modules (both normal `mod`ules and blocks), loop through hygienic parents
1460 // (open, not controlled). Have higher priority than prelude macros, but create
1461 // ambiguities with `macro_rules`.
1462 // 4. `macro_use` prelude (open, the open part is from macro expansions, not controlled).
1463 // 4a. User-defined prelude from macro-use
1464 // (open, the open part is from macro expansions, not controlled).
1465 // 4b. "Standard library prelude" part implemented through `macro-use` (closed, controlled).
1466 // 4c. Standard library prelude (de-facto closed, controlled).
1467 // 6. Language prelude: builtin attributes (closed, controlled).
1469 let rust_2015 = ident.span.rust_2015();
1470 let (ns, macro_kind, is_absolute_path) = match scope_set {
1471 ScopeSet::All(ns, _) => (ns, None, false),
1472 ScopeSet::AbsolutePath(ns) => (ns, None, true),
1473 ScopeSet::Macro(macro_kind) => (MacroNS, Some(macro_kind), false),
1475 // Jump out of trait or enum modules, they do not act as scopes.
1476 let module = parent_scope.module.nearest_item_scope();
1477 let mut scope = match ns {
1478 _ if is_absolute_path => Scope::CrateRoot,
1479 TypeNS | ValueNS => Scope::Module(module),
1480 MacroNS => Scope::DeriveHelpers(parent_scope.expansion),
1482 let mut ident = ident.modern();
1483 let mut use_prelude = !module.no_implicit_prelude;
1486 let visit = match scope {
1487 // Derive helpers are not in scope when resolving derives in the same container.
1488 Scope::DeriveHelpers(expn_id) =>
1489 !(expn_id == parent_scope.expansion && macro_kind == Some(MacroKind::Derive)),
1490 Scope::DeriveHelpersCompat => true,
1491 Scope::MacroRules(..) => true,
1492 Scope::CrateRoot => true,
1493 Scope::Module(..) => true,
1494 Scope::RegisteredAttrs => use_prelude,
1495 Scope::MacroUsePrelude => use_prelude || rust_2015,
1496 Scope::BuiltinAttrs => true,
1497 Scope::ExternPrelude => use_prelude || is_absolute_path,
1498 Scope::ToolPrelude => use_prelude,
1499 Scope::StdLibPrelude => use_prelude || ns == MacroNS,
1500 Scope::BuiltinTypes => true,
1504 if let break_result @ Some(..) = visitor(self, scope, use_prelude, ident) {
1505 return break_result;
1509 scope = match scope {
1510 Scope::DeriveHelpers(expn_id) if expn_id != ExpnId::root() => {
1511 // Derive helpers are not visible to code generated by bang or derive macros.
1512 let expn_data = expn_id.expn_data();
1513 match expn_data.kind {
1515 ExpnKind::Macro(MacroKind::Bang, _) |
1516 ExpnKind::Macro(MacroKind::Derive, _) => Scope::DeriveHelpersCompat,
1517 _ => Scope::DeriveHelpers(expn_data.parent),
1520 Scope::DeriveHelpers(..) => Scope::DeriveHelpersCompat,
1521 Scope::DeriveHelpersCompat =>
1522 Scope::MacroRules(parent_scope.legacy),
1523 Scope::MacroRules(legacy_scope) => match legacy_scope {
1524 LegacyScope::Binding(binding) => Scope::MacroRules(
1525 binding.parent_legacy_scope
1527 LegacyScope::Invocation(invoc_id) => Scope::MacroRules(
1528 self.output_legacy_scopes.get(&invoc_id).cloned()
1529 .unwrap_or(self.invocation_parent_scopes[&invoc_id].legacy)
1531 LegacyScope::Empty => Scope::Module(module),
1533 Scope::CrateRoot => match ns {
1535 ident.span.adjust(ExpnId::root());
1536 Scope::ExternPrelude
1538 ValueNS | MacroNS => break,
1540 Scope::Module(module) => {
1541 use_prelude = !module.no_implicit_prelude;
1542 match self.hygienic_lexical_parent(module, &mut ident.span) {
1543 Some(parent_module) => Scope::Module(parent_module),
1545 ident.span.adjust(ExpnId::root());
1547 TypeNS => Scope::ExternPrelude,
1548 ValueNS => Scope::StdLibPrelude,
1549 MacroNS => Scope::RegisteredAttrs,
1554 Scope::RegisteredAttrs => Scope::MacroUsePrelude,
1555 Scope::MacroUsePrelude => Scope::StdLibPrelude,
1556 Scope::BuiltinAttrs => break, // nowhere else to search
1557 Scope::ExternPrelude if is_absolute_path => break,
1558 Scope::ExternPrelude => Scope::ToolPrelude,
1559 Scope::ToolPrelude => Scope::StdLibPrelude,
1560 Scope::StdLibPrelude => match ns {
1561 TypeNS => Scope::BuiltinTypes,
1562 ValueNS => break, // nowhere else to search
1563 MacroNS => Scope::BuiltinAttrs,
1565 Scope::BuiltinTypes => break, // nowhere else to search
1572 /// This resolves the identifier `ident` in the namespace `ns` in the current lexical scope.
1573 /// More specifically, we proceed up the hierarchy of scopes and return the binding for
1574 /// `ident` in the first scope that defines it (or None if no scopes define it).
1576 /// A block's items are above its local variables in the scope hierarchy, regardless of where
1577 /// the items are defined in the block. For example,
1580 /// g(); // Since there are no local variables in scope yet, this resolves to the item.
1583 /// g(); // This resolves to the local variable `g` since it shadows the item.
1587 /// Invariant: This must only be called during main resolution, not during
1588 /// import resolution.
1589 fn resolve_ident_in_lexical_scope(&mut self,
1592 parent_scope: &ParentScope<'a>,
1593 record_used_id: Option<NodeId>,
1596 -> Option<LexicalScopeBinding<'a>> {
1597 assert!(ns == TypeNS || ns == ValueNS);
1598 if ident.name == kw::Invalid {
1599 return Some(LexicalScopeBinding::Res(Res::Err));
1601 let (general_span, modern_span) = if ident.name == kw::SelfUpper {
1602 // FIXME(jseyfried) improve `Self` hygiene
1603 let empty_span = ident.span.with_ctxt(SyntaxContext::root());
1604 (empty_span, empty_span)
1605 } else if ns == TypeNS {
1606 let modern_span = ident.span.modern();
1607 (modern_span, modern_span)
1609 (ident.span.modern_and_legacy(), ident.span.modern())
1611 ident.span = general_span;
1612 let modern_ident = Ident { span: modern_span, ..ident };
1614 // Walk backwards up the ribs in scope.
1615 let record_used = record_used_id.is_some();
1616 let mut module = self.graph_root;
1617 for i in (0 .. ribs.len()).rev() {
1618 debug!("walk rib\n{:?}", ribs[i].bindings);
1619 // Use the rib kind to determine whether we are resolving parameters
1620 // (modern hygiene) or local variables (legacy hygiene).
1621 let rib_ident = if ribs[i].kind.contains_params() {
1626 if let Some(res) = ribs[i].bindings.get(&rib_ident).cloned() {
1627 // The ident resolves to a type parameter or local variable.
1628 return Some(LexicalScopeBinding::Res(
1629 self.validate_res_from_ribs(i, rib_ident, res, record_used, path_span, ribs),
1633 module = match ribs[i].kind {
1634 ModuleRibKind(module) => module,
1635 MacroDefinition(def) if def == self.macro_def(ident.span.ctxt()) => {
1636 // If an invocation of this macro created `ident`, give up on `ident`
1637 // and switch to `ident`'s source from the macro definition.
1638 ident.span.remove_mark();
1645 let item = self.resolve_ident_in_module_unadjusted(
1646 ModuleOrUniformRoot::Module(module),
1653 if let Ok(binding) = item {
1654 // The ident resolves to an item.
1655 return Some(LexicalScopeBinding::Item(binding));
1659 ModuleKind::Block(..) => {}, // We can see through blocks
1664 ident = modern_ident;
1665 let mut poisoned = None;
1667 let opt_module = if let Some(node_id) = record_used_id {
1668 self.hygienic_lexical_parent_with_compatibility_fallback(module, &mut ident.span,
1669 node_id, &mut poisoned)
1671 self.hygienic_lexical_parent(module, &mut ident.span)
1673 module = unwrap_or!(opt_module, break);
1674 let adjusted_parent_scope = &ParentScope { module, ..*parent_scope };
1675 let result = self.resolve_ident_in_module_unadjusted(
1676 ModuleOrUniformRoot::Module(module),
1679 adjusted_parent_scope,
1686 if let Some(node_id) = poisoned {
1687 self.lint_buffer.buffer_lint_with_diagnostic(
1688 lint::builtin::PROC_MACRO_DERIVE_RESOLUTION_FALLBACK,
1689 node_id, ident.span,
1690 &format!("cannot find {} `{}` in this scope", ns.descr(), ident),
1691 lint::builtin::BuiltinLintDiagnostics::
1692 ProcMacroDeriveResolutionFallback(ident.span),
1695 return Some(LexicalScopeBinding::Item(binding))
1697 Err(Determined) => continue,
1698 Err(Undetermined) =>
1699 span_bug!(ident.span, "undetermined resolution during main resolution pass"),
1703 if !module.no_implicit_prelude {
1704 ident.span.adjust(ExpnId::root());
1706 if let Some(binding) = self.extern_prelude_get(ident, !record_used) {
1707 return Some(LexicalScopeBinding::Item(binding));
1709 if let Some(ident) = self.registered_tools.get(&ident) {
1710 let binding = (Res::ToolMod, ty::Visibility::Public,
1711 ident.span, ExpnId::root()).to_name_binding(self.arenas);
1712 return Some(LexicalScopeBinding::Item(binding));
1715 if let Some(prelude) = self.prelude {
1716 if let Ok(binding) = self.resolve_ident_in_module_unadjusted(
1717 ModuleOrUniformRoot::Module(prelude),
1724 return Some(LexicalScopeBinding::Item(binding));
1732 fn hygienic_lexical_parent(&mut self, module: Module<'a>, span: &mut Span)
1733 -> Option<Module<'a>> {
1734 if !module.expansion.outer_expn_is_descendant_of(span.ctxt()) {
1735 return Some(self.macro_def_scope(span.remove_mark()));
1738 if let ModuleKind::Block(..) = module.kind {
1739 return Some(module.parent.unwrap().nearest_item_scope());
1745 fn hygienic_lexical_parent_with_compatibility_fallback(&mut self, module: Module<'a>,
1746 span: &mut Span, node_id: NodeId,
1747 poisoned: &mut Option<NodeId>)
1748 -> Option<Module<'a>> {
1749 if let module @ Some(..) = self.hygienic_lexical_parent(module, span) {
1753 // We need to support the next case under a deprecation warning
1756 // ---- begin: this comes from a proc macro derive
1757 // mod implementation_details {
1758 // // Note that `MyStruct` is not in scope here.
1759 // impl SomeTrait for MyStruct { ... }
1763 // So we have to fall back to the module's parent during lexical resolution in this case.
1764 if let Some(parent) = module.parent {
1765 // Inner module is inside the macro, parent module is outside of the macro.
1766 if module.expansion != parent.expansion &&
1767 module.expansion.is_descendant_of(parent.expansion) {
1768 // The macro is a proc macro derive
1769 if let Some(&def_id) = self.macro_defs.get(&module.expansion) {
1770 if let Some(ext) = self.get_macro_by_def_id(def_id) {
1771 if !ext.is_builtin && ext.macro_kind() == MacroKind::Derive {
1772 if parent.expansion.outer_expn_is_descendant_of(span.ctxt()) {
1773 *poisoned = Some(node_id);
1774 return module.parent;
1785 fn resolve_ident_in_module(
1787 module: ModuleOrUniformRoot<'a>,
1790 parent_scope: &ParentScope<'a>,
1793 ) -> Result<&'a NameBinding<'a>, Determinacy> {
1794 self.resolve_ident_in_module_ext(
1795 module, ident, ns, parent_scope, record_used, path_span
1796 ).map_err(|(determinacy, _)| determinacy)
1799 fn resolve_ident_in_module_ext(
1801 module: ModuleOrUniformRoot<'a>,
1804 parent_scope: &ParentScope<'a>,
1807 ) -> Result<&'a NameBinding<'a>, (Determinacy, Weak)> {
1808 let tmp_parent_scope;
1809 let mut adjusted_parent_scope = parent_scope;
1811 ModuleOrUniformRoot::Module(m) => {
1812 if let Some(def) = ident.span.modernize_and_adjust(m.expansion) {
1814 ParentScope { module: self.macro_def_scope(def), ..*parent_scope };
1815 adjusted_parent_scope = &tmp_parent_scope;
1818 ModuleOrUniformRoot::ExternPrelude => {
1819 ident.span.modernize_and_adjust(ExpnId::root());
1821 ModuleOrUniformRoot::CrateRootAndExternPrelude |
1822 ModuleOrUniformRoot::CurrentScope => {
1826 let result = self.resolve_ident_in_module_unadjusted_ext(
1827 module, ident, ns, adjusted_parent_scope, false, record_used, path_span,
1832 fn resolve_crate_root(&mut self, ident: Ident) -> Module<'a> {
1833 let mut ctxt = ident.span.ctxt();
1834 let mark = if ident.name == kw::DollarCrate {
1835 // When resolving `$crate` from a `macro_rules!` invoked in a `macro`,
1836 // we don't want to pretend that the `macro_rules!` definition is in the `macro`
1837 // as described in `SyntaxContext::apply_mark`, so we ignore prepended modern marks.
1838 // FIXME: This is only a guess and it doesn't work correctly for `macro_rules!`
1839 // definitions actually produced by `macro` and `macro` definitions produced by
1840 // `macro_rules!`, but at least such configurations are not stable yet.
1841 ctxt = ctxt.modern_and_legacy();
1842 let mut iter = ctxt.marks().into_iter().rev().peekable();
1843 let mut result = None;
1844 // Find the last modern mark from the end if it exists.
1845 while let Some(&(mark, transparency)) = iter.peek() {
1846 if transparency == Transparency::Opaque {
1847 result = Some(mark);
1853 // Then find the last legacy mark from the end if it exists.
1854 for (mark, transparency) in iter {
1855 if transparency == Transparency::SemiTransparent {
1856 result = Some(mark);
1863 ctxt = ctxt.modern();
1864 ctxt.adjust(ExpnId::root())
1866 let module = match mark {
1867 Some(def) => self.macro_def_scope(def),
1868 None => return self.graph_root,
1870 self.get_module(DefId { index: CRATE_DEF_INDEX, ..module.normal_ancestor_id })
1873 fn resolve_self(&mut self, ctxt: &mut SyntaxContext, module: Module<'a>) -> Module<'a> {
1874 let mut module = self.get_module(module.normal_ancestor_id);
1875 while module.span.ctxt().modern() != *ctxt {
1876 let parent = module.parent.unwrap_or_else(|| self.macro_def_scope(ctxt.remove_mark()));
1877 module = self.get_module(parent.normal_ancestor_id);
1885 opt_ns: Option<Namespace>, // `None` indicates a module path in import
1886 parent_scope: &ParentScope<'a>,
1889 crate_lint: CrateLint,
1890 ) -> PathResult<'a> {
1891 self.resolve_path_with_ribs(
1892 path, opt_ns, parent_scope, record_used, path_span, crate_lint, None
1896 fn resolve_path_with_ribs(
1899 opt_ns: Option<Namespace>, // `None` indicates a module path in import
1900 parent_scope: &ParentScope<'a>,
1903 crate_lint: CrateLint,
1904 ribs: Option<&PerNS<Vec<Rib<'a>>>>,
1905 ) -> PathResult<'a> {
1906 let mut module = None;
1907 let mut allow_super = true;
1908 let mut second_binding = None;
1911 "resolve_path(path={:?}, opt_ns={:?}, record_used={:?}, \
1912 path_span={:?}, crate_lint={:?})",
1920 for (i, &Segment { ident, id }) in path.iter().enumerate() {
1921 debug!("resolve_path ident {} {:?} {:?}", i, ident, id);
1922 let record_segment_res = |this: &mut Self, res| {
1924 if let Some(id) = id {
1925 if !this.partial_res_map.contains_key(&id) {
1926 assert!(id != ast::DUMMY_NODE_ID, "Trying to resolve dummy id");
1927 this.record_partial_res(id, PartialRes::new(res));
1933 let is_last = i == path.len() - 1;
1934 let ns = if is_last { opt_ns.unwrap_or(TypeNS) } else { TypeNS };
1935 let name = ident.name;
1937 allow_super &= ns == TypeNS &&
1938 (name == kw::SelfLower ||
1942 if allow_super && name == kw::Super {
1943 let mut ctxt = ident.span.ctxt().modern();
1944 let self_module = match i {
1945 0 => Some(self.resolve_self(&mut ctxt, parent_scope.module)),
1947 Some(ModuleOrUniformRoot::Module(module)) => Some(module),
1951 if let Some(self_module) = self_module {
1952 if let Some(parent) = self_module.parent {
1953 module = Some(ModuleOrUniformRoot::Module(
1954 self.resolve_self(&mut ctxt, parent)));
1958 let msg = "there are too many initial `super`s.".to_string();
1959 return PathResult::Failed {
1963 is_error_from_last_segment: false,
1967 if name == kw::SelfLower {
1968 let mut ctxt = ident.span.ctxt().modern();
1969 module = Some(ModuleOrUniformRoot::Module(
1970 self.resolve_self(&mut ctxt, parent_scope.module)));
1973 if name == kw::PathRoot && ident.span.rust_2018() {
1974 module = Some(ModuleOrUniformRoot::ExternPrelude);
1977 if name == kw::PathRoot &&
1978 ident.span.rust_2015() && self.session.rust_2018() {
1979 // `::a::b` from 2015 macro on 2018 global edition
1980 module = Some(ModuleOrUniformRoot::CrateRootAndExternPrelude);
1983 if name == kw::PathRoot ||
1984 name == kw::Crate ||
1985 name == kw::DollarCrate {
1986 // `::a::b`, `crate::a::b` or `$crate::a::b`
1987 module = Some(ModuleOrUniformRoot::Module(
1988 self.resolve_crate_root(ident)));
1994 // Report special messages for path segment keywords in wrong positions.
1995 if ident.is_path_segment_keyword() && i != 0 {
1996 let name_str = if name == kw::PathRoot {
1997 "crate root".to_string()
1999 format!("`{}`", name)
2001 let label = if i == 1 && path[0].ident.name == kw::PathRoot {
2002 format!("global paths cannot start with {}", name_str)
2004 format!("{} in paths can only be used in start position", name_str)
2006 return PathResult::Failed {
2010 is_error_from_last_segment: false,
2014 let binding = if let Some(module) = module {
2015 self.resolve_ident_in_module(
2016 module, ident, ns, parent_scope, record_used, path_span
2018 } else if ribs.is_none() || opt_ns.is_none() || opt_ns == Some(MacroNS) {
2019 let scopes = ScopeSet::All(ns, opt_ns.is_none());
2020 self.early_resolve_ident_in_lexical_scope(ident, scopes, parent_scope, record_used,
2021 record_used, path_span)
2023 let record_used_id =
2024 if record_used { crate_lint.node_id().or(Some(CRATE_NODE_ID)) } else { None };
2025 match self.resolve_ident_in_lexical_scope(
2026 ident, ns, parent_scope, record_used_id, path_span, &ribs.unwrap()[ns]
2028 // we found a locally-imported or available item/module
2029 Some(LexicalScopeBinding::Item(binding)) => Ok(binding),
2030 // we found a local variable or type param
2031 Some(LexicalScopeBinding::Res(res))
2032 if opt_ns == Some(TypeNS) || opt_ns == Some(ValueNS) => {
2033 record_segment_res(self, res);
2034 return PathResult::NonModule(PartialRes::with_unresolved_segments(
2038 _ => Err(Determinacy::determined(record_used)),
2045 second_binding = Some(binding);
2047 let res = binding.res();
2048 let maybe_assoc = opt_ns != Some(MacroNS) && PathSource::Type.is_expected(res);
2049 if let Some(next_module) = binding.module() {
2050 module = Some(ModuleOrUniformRoot::Module(next_module));
2051 record_segment_res(self, res);
2052 } else if res == Res::ToolMod && i + 1 != path.len() {
2053 if binding.is_import() {
2054 self.session.struct_span_err(
2055 ident.span, "cannot use a tool module through an import"
2057 binding.span, "the tool module imported here"
2060 let res = Res::NonMacroAttr(NonMacroAttrKind::Tool);
2061 return PathResult::NonModule(PartialRes::new(res));
2062 } else if res == Res::Err {
2063 return PathResult::NonModule(PartialRes::new(Res::Err));
2064 } else if opt_ns.is_some() && (is_last || maybe_assoc) {
2065 self.lint_if_path_starts_with_module(
2071 return PathResult::NonModule(PartialRes::with_unresolved_segments(
2072 res, path.len() - i - 1
2075 let label = format!(
2076 "`{}` is {} {}, not a module",
2082 return PathResult::Failed {
2086 is_error_from_last_segment: is_last,
2090 Err(Undetermined) => return PathResult::Indeterminate,
2091 Err(Determined) => {
2092 if let Some(ModuleOrUniformRoot::Module(module)) = module {
2093 if opt_ns.is_some() && !module.is_normal() {
2094 return PathResult::NonModule(PartialRes::with_unresolved_segments(
2095 module.res().unwrap(), path.len() - i
2099 let module_res = match module {
2100 Some(ModuleOrUniformRoot::Module(module)) => module.res(),
2103 let (label, suggestion) = if module_res == self.graph_root.res() {
2104 let is_mod = |res| {
2105 match res { Res::Def(DefKind::Mod, _) => true, _ => false }
2107 let mut candidates =
2108 self.lookup_import_candidates(ident, TypeNS, is_mod);
2109 candidates.sort_by_cached_key(|c| {
2110 (c.path.segments.len(), pprust::path_to_string(&c.path))
2112 if let Some(candidate) = candidates.get(0) {
2114 String::from("unresolved import"),
2116 vec![(ident.span, pprust::path_to_string(&candidate.path))],
2117 String::from("a similar path exists"),
2118 Applicability::MaybeIncorrect,
2121 } else if !ident.is_reserved() {
2122 (format!("maybe a missing crate `{}`?", ident), None)
2124 // the parser will already have complained about the keyword being used
2125 return PathResult::NonModule(PartialRes::new(Res::Err));
2128 (format!("use of undeclared type or module `{}`", ident), None)
2130 (format!("could not find `{}` in `{}`", ident, path[i - 1].ident), None)
2132 return PathResult::Failed {
2136 is_error_from_last_segment: is_last,
2142 self.lint_if_path_starts_with_module(crate_lint, path, path_span, second_binding);
2144 PathResult::Module(match module {
2145 Some(module) => module,
2146 None if path.is_empty() => ModuleOrUniformRoot::CurrentScope,
2147 _ => span_bug!(path_span, "resolve_path: non-empty path `{:?}` has no module", path),
2151 fn lint_if_path_starts_with_module(
2153 crate_lint: CrateLint,
2156 second_binding: Option<&NameBinding<'_>>,
2158 let (diag_id, diag_span) = match crate_lint {
2159 CrateLint::No => return,
2160 CrateLint::SimplePath(id) => (id, path_span),
2161 CrateLint::UsePath { root_id, root_span } => (root_id, root_span),
2162 CrateLint::QPathTrait { qpath_id, qpath_span } => (qpath_id, qpath_span),
2165 let first_name = match path.get(0) {
2166 // In the 2018 edition this lint is a hard error, so nothing to do
2167 Some(seg) if seg.ident.span.rust_2015() && self.session.rust_2015() => seg.ident.name,
2171 // We're only interested in `use` paths which should start with
2172 // `{{root}}` currently.
2173 if first_name != kw::PathRoot {
2178 // If this import looks like `crate::...` it's already good
2179 Some(Segment { ident, .. }) if ident.name == kw::Crate => return,
2180 // Otherwise go below to see if it's an extern crate
2182 // If the path has length one (and it's `PathRoot` most likely)
2183 // then we don't know whether we're gonna be importing a crate or an
2184 // item in our crate. Defer this lint to elsewhere
2188 // If the first element of our path was actually resolved to an
2189 // `ExternCrate` (also used for `crate::...`) then no need to issue a
2190 // warning, this looks all good!
2191 if let Some(binding) = second_binding {
2192 if let NameBindingKind::Import { directive: d, .. } = binding.kind {
2193 // Careful: we still want to rewrite paths from
2194 // renamed extern crates.
2195 if let ImportDirectiveSubclass::ExternCrate { source: None, .. } = d.subclass {
2201 let diag = lint::builtin::BuiltinLintDiagnostics
2202 ::AbsPathWithModule(diag_span);
2203 self.lint_buffer.buffer_lint_with_diagnostic(
2204 lint::builtin::ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE,
2206 "absolute paths must start with `self`, `super`, \
2207 `crate`, or an external crate name in the 2018 edition",
2211 // Validate a local resolution (from ribs).
2212 fn validate_res_from_ribs(
2219 all_ribs: &[Rib<'a>],
2221 debug!("validate_res_from_ribs({:?})", res);
2222 let ribs = &all_ribs[rib_index + 1..];
2224 // An invalid forward use of a type parameter from a previous default.
2225 if let ForwardTyParamBanRibKind = all_ribs[rib_index].kind {
2227 let res_error = if rib_ident.name == kw::SelfUpper {
2228 ResolutionError::SelfInTyParamDefault
2230 ResolutionError::ForwardDeclaredTyParam
2232 self.report_error(span, res_error);
2234 assert_eq!(res, Res::Err);
2240 use ResolutionError::*;
2241 let mut res_err = None;
2245 NormalRibKind | ModuleRibKind(..) | MacroDefinition(..) |
2246 ForwardTyParamBanRibKind => {
2247 // Nothing to do. Continue.
2249 ItemRibKind(_) | FnItemRibKind | AssocItemRibKind => {
2250 // This was an attempt to access an upvar inside a
2251 // named function item. This is not allowed, so we
2254 // We don't immediately trigger a resolve error, because
2255 // we want certain other resolution errors (namely those
2256 // emitted for `ConstantItemRibKind` below) to take
2258 res_err = Some(CannotCaptureDynamicEnvironmentInFnItem);
2261 ConstantItemRibKind => {
2262 // Still doesn't deal with upvars
2264 self.report_error(span, AttemptToUseNonConstantValueInConstant);
2270 if let Some(res_err) = res_err {
2271 self.report_error(span, res_err);
2275 Res::Def(DefKind::TyParam, _) | Res::SelfTy(..) => {
2277 let has_generic_params = match rib.kind {
2278 NormalRibKind | AssocItemRibKind |
2279 ModuleRibKind(..) | MacroDefinition(..) | ForwardTyParamBanRibKind |
2280 ConstantItemRibKind => {
2281 // Nothing to do. Continue.
2284 // This was an attempt to use a type parameter outside its scope.
2285 ItemRibKind(has_generic_params) => has_generic_params,
2286 FnItemRibKind => HasGenericParams::Yes,
2290 self.report_error(span, ResolutionError::GenericParamsFromOuterFunction(
2291 res, has_generic_params));
2296 Res::Def(DefKind::ConstParam, _) => {
2297 let mut ribs = ribs.iter().peekable();
2298 if let Some(Rib { kind: FnItemRibKind, .. }) = ribs.peek() {
2299 // When declaring const parameters inside function signatures, the first rib
2300 // is always a `FnItemRibKind`. In this case, we can skip it, to avoid it
2301 // (spuriously) conflicting with the const param.
2305 let has_generic_params = match rib.kind {
2306 ItemRibKind(has_generic_params) => has_generic_params,
2307 FnItemRibKind => HasGenericParams::Yes,
2311 // This was an attempt to use a const parameter outside its scope.
2313 self.report_error(span, ResolutionError::GenericParamsFromOuterFunction(
2314 res, has_generic_params));
2324 fn record_partial_res(&mut self, node_id: NodeId, resolution: PartialRes) {
2325 debug!("(recording res) recording {:?} for {}", resolution, node_id);
2326 if let Some(prev_res) = self.partial_res_map.insert(node_id, resolution) {
2327 panic!("path resolved multiple times ({:?} before, {:?} now)", prev_res, resolution);
2331 fn is_accessible_from(&self, vis: ty::Visibility, module: Module<'a>) -> bool {
2332 vis.is_accessible_from(module.normal_ancestor_id, self)
2335 fn set_binding_parent_module(&mut self, binding: &'a NameBinding<'a>, module: Module<'a>) {
2336 if let Some(old_module) = self.binding_parent_modules.insert(PtrKey(binding), module) {
2337 if !ptr::eq(module, old_module) {
2338 span_bug!(binding.span, "parent module is reset for binding");
2343 fn disambiguate_legacy_vs_modern(
2345 legacy: &'a NameBinding<'a>,
2346 modern: &'a NameBinding<'a>,
2348 // Some non-controversial subset of ambiguities "modern macro name" vs "macro_rules"
2349 // is disambiguated to mitigate regressions from macro modularization.
2350 // Scoping for `macro_rules` behaves like scoping for `let` at module level, in general.
2351 match (self.binding_parent_modules.get(&PtrKey(legacy)),
2352 self.binding_parent_modules.get(&PtrKey(modern))) {
2353 (Some(legacy), Some(modern)) =>
2354 legacy.normal_ancestor_id == modern.normal_ancestor_id &&
2355 modern.is_ancestor_of(legacy),
2360 fn binding_description(&self, b: &NameBinding<'_>, ident: Ident, from_prelude: bool) -> String {
2362 if b.span.is_dummy() {
2363 let add_built_in = match b.res() {
2364 // These already contain the "built-in" prefix or look bad with it.
2365 Res::NonMacroAttr(..) | Res::PrimTy(..) | Res::ToolMod => false,
2368 let (built_in, from) = if from_prelude {
2369 ("", " from prelude")
2370 } else if b.is_extern_crate() && !b.is_import() &&
2371 self.session.opts.externs.get(&ident.as_str()).is_some() {
2372 ("", " passed with `--extern`")
2373 } else if add_built_in {
2379 let article = if built_in.is_empty() { res.article() } else { "a" };
2380 format!("{a}{built_in} {thing}{from}",
2381 a = article, thing = res.descr(), built_in = built_in, from = from)
2383 let introduced = if b.is_import() { "imported" } else { "defined" };
2384 format!("the {thing} {introduced} here",
2385 thing = res.descr(), introduced = introduced)
2389 fn report_ambiguity_error(&self, ambiguity_error: &AmbiguityError<'_>) {
2390 let AmbiguityError { kind, ident, b1, b2, misc1, misc2 } = *ambiguity_error;
2391 let (b1, b2, misc1, misc2, swapped) = if b2.span.is_dummy() && !b1.span.is_dummy() {
2392 // We have to print the span-less alternative first, otherwise formatting looks bad.
2393 (b2, b1, misc2, misc1, true)
2395 (b1, b2, misc1, misc2, false)
2398 let mut err = struct_span_err!(self.session, ident.span, E0659,
2399 "`{ident}` is ambiguous ({why})",
2400 ident = ident, why = kind.descr());
2401 err.span_label(ident.span, "ambiguous name");
2403 let mut could_refer_to = |b: &NameBinding<'_>, misc: AmbiguityErrorMisc, also: &str| {
2404 let what = self.binding_description(b, ident, misc == AmbiguityErrorMisc::FromPrelude);
2405 let note_msg = format!("`{ident}` could{also} refer to {what}",
2406 ident = ident, also = also, what = what);
2408 let thing = b.res().descr();
2409 let mut help_msgs = Vec::new();
2410 if b.is_glob_import() && (kind == AmbiguityKind::GlobVsGlob ||
2411 kind == AmbiguityKind::GlobVsExpanded ||
2412 kind == AmbiguityKind::GlobVsOuter &&
2413 swapped != also.is_empty()) {
2414 help_msgs.push(format!("consider adding an explicit import of \
2415 `{ident}` to disambiguate", ident = ident))
2417 if b.is_extern_crate() && ident.span.rust_2018() {
2418 help_msgs.push(format!(
2419 "use `::{ident}` to refer to this {thing} unambiguously",
2420 ident = ident, thing = thing,
2423 if misc == AmbiguityErrorMisc::SuggestCrate {
2424 help_msgs.push(format!(
2425 "use `crate::{ident}` to refer to this {thing} unambiguously",
2426 ident = ident, thing = thing,
2428 } else if misc == AmbiguityErrorMisc::SuggestSelf {
2429 help_msgs.push(format!(
2430 "use `self::{ident}` to refer to this {thing} unambiguously",
2431 ident = ident, thing = thing,
2435 err.span_note(b.span, ¬e_msg);
2436 for (i, help_msg) in help_msgs.iter().enumerate() {
2437 let or = if i == 0 { "" } else { "or " };
2438 err.help(&format!("{}{}", or, help_msg));
2442 could_refer_to(b1, misc1, "");
2443 could_refer_to(b2, misc2, " also");
2447 fn report_errors(&mut self, krate: &Crate) {
2448 self.report_with_use_injections(krate);
2450 for &(span_use, span_def) in &self.macro_expanded_macro_export_errors {
2451 let msg = "macro-expanded `macro_export` macros from the current crate \
2452 cannot be referred to by absolute paths";
2453 self.lint_buffer.buffer_lint_with_diagnostic(
2454 lint::builtin::MACRO_EXPANDED_MACRO_EXPORTS_ACCESSED_BY_ABSOLUTE_PATHS,
2455 CRATE_NODE_ID, span_use, msg,
2456 lint::builtin::BuiltinLintDiagnostics::
2457 MacroExpandedMacroExportsAccessedByAbsolutePaths(span_def),
2461 for ambiguity_error in &self.ambiguity_errors {
2462 self.report_ambiguity_error(ambiguity_error);
2465 let mut reported_spans = FxHashSet::default();
2466 for &PrivacyError(dedup_span, ident, binding) in &self.privacy_errors {
2467 if reported_spans.insert(dedup_span) {
2468 let session = &self.session;
2469 let mk_struct_span_error = |is_constructor| {
2474 "{}{} `{}` is private",
2475 binding.res().descr(),
2476 if is_constructor { " constructor"} else { "" },
2481 let mut err = if let NameBindingKind::Res(
2482 Res::Def(DefKind::Ctor(CtorOf::Struct, CtorKind::Fn), ctor_def_id), _
2484 let def_id = (&*self).parent(ctor_def_id).expect("no parent for a constructor");
2485 if let Some(fields) = self.field_names.get(&def_id) {
2486 let mut err = mk_struct_span_error(true);
2487 let first_field = fields.first().expect("empty field list in the map");
2489 fields.iter().fold(first_field.span, |acc, field| acc.to(field.span)),
2490 "a constructor is private if any of the fields is private",
2494 mk_struct_span_error(false)
2497 mk_struct_span_error(false)
2505 fn report_with_use_injections(&mut self, krate: &Crate) {
2506 for UseError { mut err, candidates, node_id, better } in self.use_injections.drain(..) {
2507 let (span, found_use) = UsePlacementFinder::check(krate, node_id);
2508 if !candidates.is_empty() {
2509 diagnostics::show_candidates(&mut err, span, &candidates, better, found_use);
2515 fn report_conflict<'b>(&mut self,
2519 new_binding: &NameBinding<'b>,
2520 old_binding: &NameBinding<'b>) {
2521 // Error on the second of two conflicting names
2522 if old_binding.span.lo() > new_binding.span.lo() {
2523 return self.report_conflict(parent, ident, ns, old_binding, new_binding);
2526 let container = match parent.kind {
2527 ModuleKind::Def(DefKind::Mod, _, _) => "module",
2528 ModuleKind::Def(DefKind::Trait, _, _) => "trait",
2529 ModuleKind::Block(..) => "block",
2533 let old_noun = match old_binding.is_import() {
2535 false => "definition",
2538 let new_participle = match new_binding.is_import() {
2543 let (name, span) = (ident.name, self.session.source_map().def_span(new_binding.span));
2545 if let Some(s) = self.name_already_seen.get(&name) {
2551 let old_kind = match (ns, old_binding.module()) {
2552 (ValueNS, _) => "value",
2553 (MacroNS, _) => "macro",
2554 (TypeNS, _) if old_binding.is_extern_crate() => "extern crate",
2555 (TypeNS, Some(module)) if module.is_normal() => "module",
2556 (TypeNS, Some(module)) if module.is_trait() => "trait",
2557 (TypeNS, _) => "type",
2560 let msg = format!("the name `{}` is defined multiple times", name);
2562 let mut err = match (old_binding.is_extern_crate(), new_binding.is_extern_crate()) {
2563 (true, true) => struct_span_err!(self.session, span, E0259, "{}", msg),
2564 (true, _) | (_, true) => match new_binding.is_import() && old_binding.is_import() {
2565 true => struct_span_err!(self.session, span, E0254, "{}", msg),
2566 false => struct_span_err!(self.session, span, E0260, "{}", msg),
2568 _ => match (old_binding.is_import(), new_binding.is_import()) {
2569 (false, false) => struct_span_err!(self.session, span, E0428, "{}", msg),
2570 (true, true) => struct_span_err!(self.session, span, E0252, "{}", msg),
2571 _ => struct_span_err!(self.session, span, E0255, "{}", msg),
2575 err.note(&format!("`{}` must be defined only once in the {} namespace of this {}",
2580 err.span_label(span, format!("`{}` re{} here", name, new_participle));
2582 self.session.source_map().def_span(old_binding.span),
2583 format!("previous {} of the {} `{}` here", old_noun, old_kind, name),
2586 // See https://github.com/rust-lang/rust/issues/32354
2587 use NameBindingKind::Import;
2588 let directive = match (&new_binding.kind, &old_binding.kind) {
2589 // If there are two imports where one or both have attributes then prefer removing the
2590 // import without attributes.
2591 (Import { directive: new, .. }, Import { directive: old, .. }) if {
2592 !new_binding.span.is_dummy() && !old_binding.span.is_dummy() &&
2593 (new.has_attributes || old.has_attributes)
2595 if old.has_attributes {
2596 Some((new, new_binding.span, true))
2598 Some((old, old_binding.span, true))
2601 // Otherwise prioritize the new binding.
2602 (Import { directive, .. }, other) if !new_binding.span.is_dummy() =>
2603 Some((directive, new_binding.span, other.is_import())),
2604 (other, Import { directive, .. }) if !old_binding.span.is_dummy() =>
2605 Some((directive, old_binding.span, other.is_import())),
2609 // Check if the target of the use for both bindings is the same.
2610 let duplicate = new_binding.res().opt_def_id() == old_binding.res().opt_def_id();
2611 let has_dummy_span = new_binding.span.is_dummy() || old_binding.span.is_dummy();
2612 let from_item = self.extern_prelude.get(&ident)
2613 .map(|entry| entry.introduced_by_item)
2615 // Only suggest removing an import if both bindings are to the same def, if both spans
2616 // aren't dummy spans. Further, if both bindings are imports, then the ident must have
2617 // been introduced by a item.
2618 let should_remove_import = duplicate && !has_dummy_span &&
2619 ((new_binding.is_extern_crate() || old_binding.is_extern_crate()) || from_item);
2622 Some((directive, span, true)) if should_remove_import && directive.is_nested() =>
2623 self.add_suggestion_for_duplicate_nested_use(&mut err, directive, span),
2624 Some((directive, _, true)) if should_remove_import && !directive.is_glob() => {
2625 // Simple case - remove the entire import. Due to the above match arm, this can
2626 // only be a single use so just remove it entirely.
2627 err.tool_only_span_suggestion(
2628 directive.use_span_with_attributes,
2629 "remove unnecessary import",
2631 Applicability::MaybeIncorrect,
2634 Some((directive, span, _)) =>
2635 self.add_suggestion_for_rename_of_use(&mut err, name, directive, span),
2640 self.name_already_seen.insert(name, span);
2643 /// This function adds a suggestion to change the binding name of a new import that conflicts
2644 /// with an existing import.
2646 /// ```ignore (diagnostic)
2647 /// help: you can use `as` to change the binding name of the import
2649 /// LL | use foo::bar as other_bar;
2650 /// | ^^^^^^^^^^^^^^^^^^^^^
2652 fn add_suggestion_for_rename_of_use(
2654 err: &mut DiagnosticBuilder<'_>,
2656 directive: &ImportDirective<'_>,
2659 let suggested_name = if name.as_str().chars().next().unwrap().is_uppercase() {
2660 format!("Other{}", name)
2662 format!("other_{}", name)
2665 let mut suggestion = None;
2666 match directive.subclass {
2667 ImportDirectiveSubclass::SingleImport { type_ns_only: true, .. } =>
2668 suggestion = Some(format!("self as {}", suggested_name)),
2669 ImportDirectiveSubclass::SingleImport { source, .. } => {
2670 if let Some(pos) = source.span.hi().0.checked_sub(binding_span.lo().0)
2671 .map(|pos| pos as usize) {
2672 if let Ok(snippet) = self.session.source_map()
2673 .span_to_snippet(binding_span) {
2674 if pos <= snippet.len() {
2675 suggestion = Some(format!(
2679 if snippet.ends_with(";") { ";" } else { "" }
2685 ImportDirectiveSubclass::ExternCrate { source, target, .. } =>
2686 suggestion = Some(format!(
2687 "extern crate {} as {};",
2688 source.unwrap_or(target.name),
2691 _ => unreachable!(),
2694 let rename_msg = "you can use `as` to change the binding name of the import";
2695 if let Some(suggestion) = suggestion {
2696 err.span_suggestion(
2700 Applicability::MaybeIncorrect,
2703 err.span_label(binding_span, rename_msg);
2707 /// This function adds a suggestion to remove a unnecessary binding from an import that is
2708 /// nested. In the following example, this function will be invoked to remove the `a` binding
2709 /// in the second use statement:
2711 /// ```ignore (diagnostic)
2712 /// use issue_52891::a;
2713 /// use issue_52891::{d, a, e};
2716 /// The following suggestion will be added:
2718 /// ```ignore (diagnostic)
2719 /// use issue_52891::{d, a, e};
2720 /// ^-- help: remove unnecessary import
2723 /// If the nested use contains only one import then the suggestion will remove the entire
2726 /// It is expected that the directive provided is a nested import - this isn't checked by the
2727 /// function. If this invariant is not upheld, this function's behaviour will be unexpected
2728 /// as characters expected by span manipulations won't be present.
2729 fn add_suggestion_for_duplicate_nested_use(
2731 err: &mut DiagnosticBuilder<'_>,
2732 directive: &ImportDirective<'_>,
2735 assert!(directive.is_nested());
2736 let message = "remove unnecessary import";
2738 // Two examples will be used to illustrate the span manipulations we're doing:
2740 // - Given `use issue_52891::{d, a, e};` where `a` is a duplicate then `binding_span` is
2741 // `a` and `directive.use_span` is `issue_52891::{d, a, e};`.
2742 // - Given `use issue_52891::{d, e, a};` where `a` is a duplicate then `binding_span` is
2743 // `a` and `directive.use_span` is `issue_52891::{d, e, a};`.
2745 let (found_closing_brace, span) = find_span_of_binding_until_next_binding(
2746 self.session, binding_span, directive.use_span,
2749 // If there was a closing brace then identify the span to remove any trailing commas from
2750 // previous imports.
2751 if found_closing_brace {
2752 if let Some(span) = extend_span_to_previous_binding(self.session, span) {
2753 err.tool_only_span_suggestion(span, message, String::new(),
2754 Applicability::MaybeIncorrect);
2756 // Remove the entire line if we cannot extend the span back, this indicates a
2757 // `issue_52891::{self}` case.
2758 err.span_suggestion(directive.use_span_with_attributes, message, String::new(),
2759 Applicability::MaybeIncorrect);
2765 err.span_suggestion(span, message, String::new(), Applicability::MachineApplicable);
2768 fn extern_prelude_get(&mut self, ident: Ident, speculative: bool)
2769 -> Option<&'a NameBinding<'a>> {
2770 if ident.is_path_segment_keyword() {
2771 // Make sure `self`, `super` etc produce an error when passed to here.
2774 self.extern_prelude.get(&ident.modern()).cloned().and_then(|entry| {
2775 if let Some(binding) = entry.extern_crate_item {
2776 if !speculative && entry.introduced_by_item {
2777 self.record_use(ident, TypeNS, binding, false);
2781 let crate_id = if !speculative {
2782 self.crate_loader.process_path_extern(ident.name, ident.span)
2783 } else if let Some(crate_id) =
2784 self.crate_loader.maybe_process_path_extern(ident.name, ident.span) {
2789 let crate_root = self.get_module(DefId { krate: crate_id, index: CRATE_DEF_INDEX });
2790 Some((crate_root, ty::Visibility::Public, DUMMY_SP, ExpnId::root())
2791 .to_name_binding(self.arenas))
2796 /// Rustdoc uses this to resolve things in a recoverable way. `ResolutionError<'a>`
2797 /// isn't something that can be returned because it can't be made to live that long,
2798 /// and also it's a private type. Fortunately rustdoc doesn't need to know the error,
2799 /// just that an error occurred.
2800 // FIXME(Manishearth): intra-doc links won't get warned of epoch changes.
2801 pub fn resolve_str_path_error(
2802 &mut self, span: Span, path_str: &str, ns: Namespace, module_id: NodeId
2803 ) -> Result<(ast::Path, Res), ()> {
2804 let path = if path_str.starts_with("::") {
2807 segments: iter::once(Ident::with_dummy_span(kw::PathRoot))
2809 path_str.split("::").skip(1).map(Ident::from_str)
2811 .map(|i| self.new_ast_path_segment(i))
2819 .map(Ident::from_str)
2820 .map(|i| self.new_ast_path_segment(i))
2824 let module = self.block_map.get(&module_id).copied().unwrap_or_else(|| {
2825 let def_id = self.definitions.local_def_id(module_id);
2826 self.module_map.get(&def_id).copied().unwrap_or(self.graph_root)
2828 let parent_scope = &ParentScope::module(module);
2829 let res = self.resolve_ast_path(&path, ns, parent_scope).map_err(|_| ())?;
2833 // Resolve a path passed from rustdoc or HIR lowering.
2834 fn resolve_ast_path(
2838 parent_scope: &ParentScope<'a>,
2839 ) -> Result<Res, (Span, ResolutionError<'a>)> {
2840 match self.resolve_path(
2841 &Segment::from_path(path), Some(ns), parent_scope, true, path.span, CrateLint::No
2843 PathResult::Module(ModuleOrUniformRoot::Module(module)) =>
2844 Ok(module.res().unwrap()),
2845 PathResult::NonModule(path_res) if path_res.unresolved_segments() == 0 =>
2846 Ok(path_res.base_res()),
2847 PathResult::NonModule(..) => {
2848 Err((path.span, ResolutionError::FailedToResolve {
2849 label: String::from("type-relative paths are not supported in this context"),
2853 PathResult::Module(..) | PathResult::Indeterminate => unreachable!(),
2854 PathResult::Failed { span, label, suggestion, .. } => {
2855 Err((span, ResolutionError::FailedToResolve {
2863 fn new_ast_path_segment(&mut self, ident: Ident) -> ast::PathSegment {
2864 let mut seg = ast::PathSegment::from_ident(ident);
2865 seg.id = self.next_node_id();
2870 pub fn graph_root(&self) -> Module<'a> {
2875 pub fn all_macros(&self) -> &FxHashMap<Name, Res> {
2880 fn names_to_string(names: &[Name]) -> String {
2881 let mut result = String::new();
2882 for (i, name) in names.iter()
2883 .filter(|name| **name != kw::PathRoot)
2886 result.push_str("::");
2888 result.push_str(&name.as_str());
2893 fn path_names_to_string(path: &Path) -> String {
2894 names_to_string(&path.segments.iter()
2895 .map(|seg| seg.ident.name)
2896 .collect::<Vec<_>>())
2899 /// A somewhat inefficient routine to obtain the name of a module.
2900 fn module_to_string(module: Module<'_>) -> Option<String> {
2901 let mut names = Vec::new();
2903 fn collect_mod(names: &mut Vec<Name>, module: Module<'_>) {
2904 if let ModuleKind::Def(.., name) = module.kind {
2905 if let Some(parent) = module.parent {
2907 collect_mod(names, parent);
2910 names.push(Name::intern("<opaque>"));
2911 collect_mod(names, module.parent.unwrap());
2914 collect_mod(&mut names, module);
2916 if names.is_empty() {
2920 Some(names_to_string(&names))
2923 #[derive(Copy, Clone, Debug)]
2925 /// Do not issue the lint.
2928 /// This lint applies to some arbitrary path; e.g., `impl ::foo::Bar`.
2929 /// In this case, we can take the span of that path.
2932 /// This lint comes from a `use` statement. In this case, what we
2933 /// care about really is the *root* `use` statement; e.g., if we
2934 /// have nested things like `use a::{b, c}`, we care about the
2936 UsePath { root_id: NodeId, root_span: Span },
2938 /// This is the "trait item" from a fully qualified path. For example,
2939 /// we might be resolving `X::Y::Z` from a path like `<T as X::Y>::Z`.
2940 /// The `path_span` is the span of the to the trait itself (`X::Y`).
2941 QPathTrait { qpath_id: NodeId, qpath_span: Span },
2945 fn node_id(&self) -> Option<NodeId> {
2947 CrateLint::No => None,
2948 CrateLint::SimplePath(id) |
2949 CrateLint::UsePath { root_id: id, .. } |
2950 CrateLint::QPathTrait { qpath_id: id, .. } => Some(id),