]> git.lizzy.rs Git - rust.git/blob - compiler/rustc_resolve/src/lib.rs
Rename to `nearest_parent_mod`
[rust.git] / compiler / rustc_resolve / src / lib.rs
1 // ignore-tidy-filelength
2
3 //! This crate is responsible for the part of name resolution that doesn't require type checker.
4 //!
5 //! Module structure of the crate is built here.
6 //! Paths in macros, imports, expressions, types, patterns are resolved here.
7 //! Label and lifetime names are resolved here as well.
8 //!
9 //! Type-relative name resolution (methods, fields, associated items) happens in `librustc_typeck`.
10
11 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/nightly-rustc/")]
12 #![feature(bool_to_option)]
13 #![feature(crate_visibility_modifier)]
14 #![feature(format_args_capture)]
15 #![feature(nll)]
16 #![feature(or_patterns)]
17 #![recursion_limit = "256"]
18
19 pub use rustc_hir::def::{Namespace, PerNS};
20
21 use Determinacy::*;
22
23 use rustc_arena::{DroplessArena, TypedArena};
24 use rustc_ast::node_id::NodeMap;
25 use rustc_ast::unwrap_or;
26 use rustc_ast::visit::{self, Visitor};
27 use rustc_ast::{self as ast, FloatTy, IntTy, NodeId, UintTy};
28 use rustc_ast::{Crate, CRATE_NODE_ID};
29 use rustc_ast::{ItemKind, Path};
30 use rustc_ast_lowering::ResolverAstLowering;
31 use rustc_ast_pretty::pprust;
32 use rustc_data_structures::fx::{FxHashMap, FxHashSet, FxIndexMap};
33 use rustc_data_structures::ptr_key::PtrKey;
34 use rustc_data_structures::sync::Lrc;
35 use rustc_errors::{struct_span_err, Applicability, DiagnosticBuilder};
36 use rustc_expand::base::SyntaxExtension;
37 use rustc_hir::def::Namespace::*;
38 use rustc_hir::def::{self, CtorOf, DefKind, NonMacroAttrKind, PartialRes};
39 use rustc_hir::def_id::{CrateNum, DefId, DefIdMap, LocalDefId, CRATE_DEF_INDEX};
40 use rustc_hir::definitions::{DefKey, DefPathData, Definitions};
41 use rustc_hir::PrimTy::{self, Bool, Char, Float, Int, Str, Uint};
42 use rustc_hir::TraitCandidate;
43 use rustc_index::vec::IndexVec;
44 use rustc_metadata::creader::{CStore, CrateLoader};
45 use rustc_middle::hir::exports::ExportMap;
46 use rustc_middle::middle::cstore::{CrateStore, MetadataLoaderDyn};
47 use rustc_middle::ty::query::Providers;
48 use rustc_middle::ty::{self, DefIdTree, ResolverOutputs};
49 use rustc_middle::{bug, span_bug};
50 use rustc_session::lint;
51 use rustc_session::lint::{BuiltinLintDiagnostics, LintBuffer};
52 use rustc_session::Session;
53 use rustc_span::hygiene::{ExpnId, ExpnKind, MacroKind, SyntaxContext, Transparency};
54 use rustc_span::source_map::Spanned;
55 use rustc_span::symbol::{kw, sym, Ident, Symbol};
56 use rustc_span::{Span, DUMMY_SP};
57
58 use smallvec::{smallvec, SmallVec};
59 use std::cell::{Cell, RefCell};
60 use std::collections::BTreeSet;
61 use std::{cmp, fmt, iter, ptr};
62 use tracing::debug;
63
64 use diagnostics::{extend_span_to_previous_binding, find_span_of_binding_until_next_binding};
65 use diagnostics::{ImportSuggestion, LabelSuggestion, Suggestion};
66 use imports::{Import, ImportKind, ImportResolver, NameResolution};
67 use late::{HasGenericParams, PathSource, Rib, RibKind::*};
68 use macros::{MacroRulesBinding, MacroRulesScope, MacroRulesScopeRef};
69
70 type Res = def::Res<NodeId>;
71
72 mod build_reduced_graph;
73 mod check_unused;
74 mod def_collector;
75 mod diagnostics;
76 mod imports;
77 mod late;
78 mod macros;
79
80 enum Weak {
81     Yes,
82     No,
83 }
84
85 #[derive(Copy, Clone, PartialEq, Debug)]
86 pub enum Determinacy {
87     Determined,
88     Undetermined,
89 }
90
91 impl Determinacy {
92     fn determined(determined: bool) -> Determinacy {
93         if determined { Determinacy::Determined } else { Determinacy::Undetermined }
94     }
95 }
96
97 /// A specific scope in which a name can be looked up.
98 /// This enum is currently used only for early resolution (imports and macros),
99 /// but not for late resolution yet.
100 #[derive(Clone, Copy)]
101 enum Scope<'a> {
102     DeriveHelpers(ExpnId),
103     DeriveHelpersCompat,
104     MacroRules(MacroRulesScopeRef<'a>),
105     CrateRoot,
106     Module(Module<'a>),
107     RegisteredAttrs,
108     MacroUsePrelude,
109     BuiltinAttrs,
110     ExternPrelude,
111     ToolPrelude,
112     StdLibPrelude,
113     BuiltinTypes,
114 }
115
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.
120 enum ScopeSet {
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.
126     Macro(MacroKind),
127 }
128
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> {
135     module: Module<'a>,
136     expansion: ExpnId,
137     macro_rules: MacroRulesScopeRef<'a>,
138     derives: &'a [ast::Path],
139 }
140
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>, resolver: &Resolver<'a>) -> ParentScope<'a> {
145         ParentScope {
146             module,
147             expansion: ExpnId::root(),
148             macro_rules: resolver.arenas.alloc_macro_rules_scope(MacroRulesScope::Empty),
149             derives: &[],
150         }
151     }
152 }
153
154 #[derive(Eq)]
155 struct BindingError {
156     name: Symbol,
157     origin: BTreeSet<Span>,
158     target: BTreeSet<Span>,
159     could_be_path: bool,
160 }
161
162 impl PartialOrd for BindingError {
163     fn partial_cmp(&self, other: &BindingError) -> Option<cmp::Ordering> {
164         Some(self.cmp(other))
165     }
166 }
167
168 impl PartialEq for BindingError {
169     fn eq(&self, other: &BindingError) -> bool {
170         self.name == other.name
171     }
172 }
173
174 impl Ord for BindingError {
175     fn cmp(&self, other: &BindingError) -> cmp::Ordering {
176         self.name.cmp(&other.name)
177     }
178 }
179
180 enum ResolutionError<'a> {
181     /// Error E0401: can't use type or const parameters from outer function.
182     GenericParamsFromOuterFunction(Res, HasGenericParams),
183     /// Error E0403: the name is already used for a type or const parameter in this generic
184     /// parameter list.
185     NameAlreadyUsedInParameterList(Symbol, Span),
186     /// Error E0407: method is not a member of trait.
187     MethodNotMemberOfTrait(Symbol, &'a str),
188     /// Error E0437: type is not a member of trait.
189     TypeNotMemberOfTrait(Symbol, &'a str),
190     /// Error E0438: const is not a member of trait.
191     ConstNotMemberOfTrait(Symbol, &'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(Symbol, Span),
196     /// Error E0415: identifier is bound more than once in this parameter list.
197     IdentifierBoundMoreThanOnceInParameterList(Symbol),
198     /// Error E0416: identifier is bound more than once in the same pattern.
199     IdentifierBoundMoreThanOnceInSamePattern(Symbol),
200     /// Error E0426: use of undeclared label.
201     UndeclaredLabel { name: Symbol, suggestion: Option<LabelSuggestion> },
202     /// Error E0429: `self` imports are only allowed within a `{ }` list.
203     SelfImportsOnlyAllowedWithin { root: bool, span_with_rename: Span },
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(&'static str, Symbol, &'a NameBinding<'a>),
216     /// Error E0128: type parameters with a default cannot use forward-declared identifiers.
217     ForwardDeclaredTyParam, // FIXME(const_generics_defaults)
218     /// ERROR E0770: the type of const parameters must not depend on other generic parameters.
219     ParamInTyOfConstParam(Symbol),
220     /// constant values inside of type parameter defaults must not depend on generic parameters.
221     ParamInAnonConstInTyDefault(Symbol),
222     /// generic parameters must not be used inside const evaluations.
223     ///
224     /// This error is only emitted when using `min_const_generics`.
225     ParamInNonTrivialAnonConst { name: Symbol, is_type: bool },
226     /// Error E0735: type parameters with a default cannot use `Self`
227     SelfInTyParamDefault,
228     /// Error E0767: use of unreachable label
229     UnreachableLabel { name: Symbol, definition_span: Span, suggestion: Option<LabelSuggestion> },
230 }
231
232 enum VisResolutionError<'a> {
233     Relative2018(Span, &'a ast::Path),
234     AncestorOnly(Span),
235     FailedToResolve(Span, String, Option<Suggestion>),
236     ExpectedFound(Span, String, Res),
237     Indeterminate(Span),
238     ModuleOnly(Span),
239 }
240
241 /// A minimal representation of a path segment. We use this in resolve because we synthesize 'path
242 /// segments' which don't have the rest of an AST or HIR `PathSegment`.
243 #[derive(Clone, Copy, Debug)]
244 pub struct Segment {
245     ident: Ident,
246     id: Option<NodeId>,
247     /// Signals whether this `PathSegment` has generic arguments. Used to avoid providing
248     /// nonsensical suggestions.
249     has_generic_args: bool,
250 }
251
252 impl Segment {
253     fn from_path(path: &Path) -> Vec<Segment> {
254         path.segments.iter().map(|s| s.into()).collect()
255     }
256
257     fn from_ident(ident: Ident) -> Segment {
258         Segment { ident, id: None, has_generic_args: false }
259     }
260
261     fn names_to_string(segments: &[Segment]) -> String {
262         names_to_string(&segments.iter().map(|seg| seg.ident.name).collect::<Vec<_>>())
263     }
264 }
265
266 impl<'a> From<&'a ast::PathSegment> for Segment {
267     fn from(seg: &'a ast::PathSegment) -> Segment {
268         Segment { ident: seg.ident, id: Some(seg.id), has_generic_args: seg.args.is_some() }
269     }
270 }
271
272 struct UsePlacementFinder {
273     target_module: NodeId,
274     span: Option<Span>,
275     found_use: bool,
276 }
277
278 impl UsePlacementFinder {
279     fn check(krate: &Crate, target_module: NodeId) -> (Option<Span>, bool) {
280         let mut finder = UsePlacementFinder { target_module, span: None, found_use: false };
281         visit::walk_crate(&mut finder, krate);
282         (finder.span, finder.found_use)
283     }
284 }
285
286 impl<'tcx> Visitor<'tcx> for UsePlacementFinder {
287     fn visit_mod(
288         &mut self,
289         module: &'tcx ast::Mod,
290         _: Span,
291         _: &[ast::Attribute],
292         node_id: NodeId,
293     ) {
294         if self.span.is_some() {
295             return;
296         }
297         if node_id != self.target_module {
298             visit::walk_mod(self, module);
299             return;
300         }
301         // find a use statement
302         for item in &module.items {
303             match item.kind {
304                 ItemKind::Use(..) => {
305                     // don't suggest placing a use before the prelude
306                     // import or other generated ones
307                     if !item.span.from_expansion() {
308                         self.span = Some(item.span.shrink_to_lo());
309                         self.found_use = true;
310                         return;
311                     }
312                 }
313                 // don't place use before extern crate
314                 ItemKind::ExternCrate(_) => {}
315                 // but place them before the first other item
316                 _ => {
317                     if self.span.map_or(true, |span| item.span < span)
318                         && !item.span.from_expansion()
319                     {
320                         // don't insert between attributes and an item
321                         if item.attrs.is_empty() {
322                             self.span = Some(item.span.shrink_to_lo());
323                         } else {
324                             // find the first attribute on the item
325                             for attr in &item.attrs {
326                                 if self.span.map_or(true, |span| attr.span < span) {
327                                     self.span = Some(attr.span.shrink_to_lo());
328                                 }
329                             }
330                         }
331                     }
332                 }
333             }
334         }
335     }
336 }
337
338 /// An intermediate resolution result.
339 ///
340 /// This refers to the thing referred by a name. The difference between `Res` and `Item` is that
341 /// items are visible in their whole block, while `Res`es only from the place they are defined
342 /// forward.
343 #[derive(Debug)]
344 enum LexicalScopeBinding<'a> {
345     Item(&'a NameBinding<'a>),
346     Res(Res),
347 }
348
349 impl<'a> LexicalScopeBinding<'a> {
350     fn res(self) -> Res {
351         match self {
352             LexicalScopeBinding::Item(binding) => binding.res(),
353             LexicalScopeBinding::Res(res) => res,
354         }
355     }
356 }
357
358 #[derive(Copy, Clone, Debug)]
359 enum ModuleOrUniformRoot<'a> {
360     /// Regular module.
361     Module(Module<'a>),
362
363     /// Virtual module that denotes resolution in crate root with fallback to extern prelude.
364     CrateRootAndExternPrelude,
365
366     /// Virtual module that denotes resolution in extern prelude.
367     /// Used for paths starting with `::` on 2018 edition.
368     ExternPrelude,
369
370     /// Virtual module that denotes resolution in current scope.
371     /// Used only for resolving single-segment imports. The reason it exists is that import paths
372     /// are always split into two parts, the first of which should be some kind of module.
373     CurrentScope,
374 }
375
376 impl ModuleOrUniformRoot<'_> {
377     fn same_def(lhs: Self, rhs: Self) -> bool {
378         match (lhs, rhs) {
379             (ModuleOrUniformRoot::Module(lhs), ModuleOrUniformRoot::Module(rhs)) => {
380                 lhs.def_id() == rhs.def_id()
381             }
382             (
383                 ModuleOrUniformRoot::CrateRootAndExternPrelude,
384                 ModuleOrUniformRoot::CrateRootAndExternPrelude,
385             )
386             | (ModuleOrUniformRoot::ExternPrelude, ModuleOrUniformRoot::ExternPrelude)
387             | (ModuleOrUniformRoot::CurrentScope, ModuleOrUniformRoot::CurrentScope) => true,
388             _ => false,
389         }
390     }
391 }
392
393 #[derive(Clone, Debug)]
394 enum PathResult<'a> {
395     Module(ModuleOrUniformRoot<'a>),
396     NonModule(PartialRes),
397     Indeterminate,
398     Failed {
399         span: Span,
400         label: String,
401         suggestion: Option<Suggestion>,
402         is_error_from_last_segment: bool,
403     },
404 }
405
406 #[derive(Debug)]
407 enum ModuleKind {
408     /// An anonymous module; e.g., just a block.
409     ///
410     /// ```
411     /// fn main() {
412     ///     fn f() {} // (1)
413     ///     { // This is an anonymous module
414     ///         f(); // This resolves to (2) as we are inside the block.
415     ///         fn f() {} // (2)
416     ///     }
417     ///     f(); // Resolves to (1)
418     /// }
419     /// ```
420     Block(NodeId),
421     /// Any module with a name.
422     ///
423     /// This could be:
424     ///
425     /// * A normal module â€“ either `mod from_file;` or `mod from_block { }` â€“
426     ///   or the crate root (which is conceptually a top-level module).
427     ///   Note that the crate root's [name][Self::name] will be [`kw::Empty`].
428     /// * A trait or an enum (it implicitly contains associated types, methods and variant
429     ///   constructors).
430     Def(DefKind, DefId, Symbol),
431 }
432
433 impl ModuleKind {
434     /// Get name of the module.
435     pub fn name(&self) -> Option<Symbol> {
436         match self {
437             ModuleKind::Block(..) => None,
438             ModuleKind::Def(.., name) => Some(*name),
439         }
440     }
441 }
442
443 /// A key that identifies a binding in a given `Module`.
444 ///
445 /// Multiple bindings in the same module can have the same key (in a valid
446 /// program) if all but one of them come from glob imports.
447 #[derive(Copy, Clone, PartialEq, Eq, Hash, Debug)]
448 struct BindingKey {
449     /// The identifier for the binding, aways the `normalize_to_macros_2_0` version of the
450     /// identifier.
451     ident: Ident,
452     ns: Namespace,
453     /// 0 if ident is not `_`, otherwise a value that's unique to the specific
454     /// `_` in the expanded AST that introduced this binding.
455     disambiguator: u32,
456 }
457
458 type Resolutions<'a> = RefCell<FxIndexMap<BindingKey, &'a RefCell<NameResolution<'a>>>>;
459
460 /// One node in the tree of modules.
461 ///
462 /// Note that a "module" in resolve is broader than a `mod` that you declare in Rust code. It may be one of these:
463 ///
464 /// * `mod`
465 /// * crate root (aka, top-level anonymous module)
466 /// * `enum`
467 /// * `trait`
468 /// * curly-braced block with statements
469 ///
470 /// You can use [`ModuleData::kind`] to determine the kind of module this is.
471 pub struct ModuleData<'a> {
472     /// The direct parent module (it may not be a `mod`, however).
473     parent: Option<Module<'a>>,
474     /// What kind of module this is, because this may not be a `mod`.
475     kind: ModuleKind,
476
477     /// The [`DefId`] of the nearest `mod` item ancestor (which may be this module).
478     /// This may be the crate root.
479     nearest_parent_mod: DefId,
480
481     /// Mapping between names and their (possibly in-progress) resolutions in this module.
482     /// Resolutions in modules from other crates are not populated until accessed.
483     lazy_resolutions: Resolutions<'a>,
484     /// True if this is a module from other crate that needs to be populated on access.
485     populate_on_access: Cell<bool>,
486
487     /// Macro invocations that can expand into items in this module.
488     unexpanded_invocations: RefCell<FxHashSet<ExpnId>>,
489
490     /// Whether `#[no_implicit_prelude]` is active.
491     no_implicit_prelude: bool,
492
493     glob_importers: RefCell<Vec<&'a Import<'a>>>,
494     globs: RefCell<Vec<&'a Import<'a>>>,
495
496     /// Used to memoize the traits in this module for faster searches through all traits in scope.
497     traits: RefCell<Option<Box<[(Ident, &'a NameBinding<'a>)]>>>,
498
499     /// Span of the module itself. Used for error reporting.
500     span: Span,
501
502     expansion: ExpnId,
503 }
504
505 type Module<'a> = &'a ModuleData<'a>;
506
507 impl<'a> ModuleData<'a> {
508     fn new(
509         parent: Option<Module<'a>>,
510         kind: ModuleKind,
511         nearest_parent_mod: DefId,
512         expansion: ExpnId,
513         span: Span,
514     ) -> Self {
515         ModuleData {
516             parent,
517             kind,
518             nearest_parent_mod,
519             lazy_resolutions: Default::default(),
520             populate_on_access: Cell::new(!nearest_parent_mod.is_local()),
521             unexpanded_invocations: Default::default(),
522             no_implicit_prelude: false,
523             glob_importers: RefCell::new(Vec::new()),
524             globs: RefCell::new(Vec::new()),
525             traits: RefCell::new(None),
526             span,
527             expansion,
528         }
529     }
530
531     fn for_each_child<R, F>(&'a self, resolver: &mut R, mut f: F)
532     where
533         R: AsMut<Resolver<'a>>,
534         F: FnMut(&mut R, Ident, Namespace, &'a NameBinding<'a>),
535     {
536         for (key, name_resolution) in resolver.as_mut().resolutions(self).borrow().iter() {
537             if let Some(binding) = name_resolution.borrow().binding {
538                 f(resolver, key.ident, key.ns, binding);
539             }
540         }
541     }
542
543     /// This modifies `self` in place. The traits will be stored in `self.traits`.
544     fn ensure_traits<R>(&'a self, resolver: &mut R)
545     where
546         R: AsMut<Resolver<'a>>,
547     {
548         let mut traits = self.traits.borrow_mut();
549         if traits.is_none() {
550             let mut collected_traits = Vec::new();
551             self.for_each_child(resolver, |_, name, ns, binding| {
552                 if ns != TypeNS {
553                     return;
554                 }
555                 if let Res::Def(DefKind::Trait | DefKind::TraitAlias, _) = binding.res() {
556                     collected_traits.push((name, binding))
557                 }
558             });
559             *traits = Some(collected_traits.into_boxed_slice());
560         }
561     }
562
563     fn res(&self) -> Option<Res> {
564         match self.kind {
565             ModuleKind::Def(kind, def_id, _) => Some(Res::Def(kind, def_id)),
566             _ => None,
567         }
568     }
569
570     fn def_id(&self) -> Option<DefId> {
571         match self.kind {
572             ModuleKind::Def(_, def_id, _) => Some(def_id),
573             _ => None,
574         }
575     }
576
577     // `self` resolves to the first module ancestor that `is_normal`.
578     fn is_normal(&self) -> bool {
579         matches!(self.kind, ModuleKind::Def(DefKind::Mod, _, _))
580     }
581
582     fn is_trait(&self) -> bool {
583         matches!(self.kind, ModuleKind::Def(DefKind::Trait, _, _))
584     }
585
586     fn nearest_item_scope(&'a self) -> Module<'a> {
587         match self.kind {
588             ModuleKind::Def(DefKind::Enum | DefKind::Trait, ..) => {
589                 self.parent.expect("enum or trait module without a parent")
590             }
591             _ => self,
592         }
593     }
594
595     fn is_ancestor_of(&self, mut other: &Self) -> bool {
596         while !ptr::eq(self, other) {
597             if let Some(parent) = other.parent {
598                 other = parent;
599             } else {
600                 return false;
601             }
602         }
603         true
604     }
605 }
606
607 impl<'a> fmt::Debug for ModuleData<'a> {
608     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
609         write!(f, "{:?}", self.res())
610     }
611 }
612
613 /// Records a possibly-private value, type, or module definition.
614 #[derive(Clone, Debug)]
615 pub struct NameBinding<'a> {
616     kind: NameBindingKind<'a>,
617     ambiguity: Option<(&'a NameBinding<'a>, AmbiguityKind)>,
618     expansion: ExpnId,
619     span: Span,
620     vis: ty::Visibility,
621 }
622
623 pub trait ToNameBinding<'a> {
624     fn to_name_binding(self, arenas: &'a ResolverArenas<'a>) -> &'a NameBinding<'a>;
625 }
626
627 impl<'a> ToNameBinding<'a> for &'a NameBinding<'a> {
628     fn to_name_binding(self, _: &'a ResolverArenas<'a>) -> &'a NameBinding<'a> {
629         self
630     }
631 }
632
633 #[derive(Clone, Debug)]
634 enum NameBindingKind<'a> {
635     Res(Res, /* is_macro_export */ bool),
636     Module(Module<'a>),
637     Import { binding: &'a NameBinding<'a>, import: &'a Import<'a>, used: Cell<bool> },
638 }
639
640 impl<'a> NameBindingKind<'a> {
641     /// Is this a name binding of a import?
642     fn is_import(&self) -> bool {
643         matches!(*self, NameBindingKind::Import { .. })
644     }
645 }
646
647 struct PrivacyError<'a> {
648     ident: Ident,
649     binding: &'a NameBinding<'a>,
650     dedup_span: Span,
651 }
652
653 struct UseError<'a> {
654     err: DiagnosticBuilder<'a>,
655     /// Candidates which user could `use` to access the missing type.
656     candidates: Vec<ImportSuggestion>,
657     /// The `DefId` of the module to place the use-statements in.
658     def_id: DefId,
659     /// Whether the diagnostic should say "instead" (as in `consider importing ... instead`).
660     instead: bool,
661     /// Extra free-form suggestion.
662     suggestion: Option<(Span, &'static str, String, Applicability)>,
663 }
664
665 #[derive(Clone, Copy, PartialEq, Debug)]
666 enum AmbiguityKind {
667     Import,
668     BuiltinAttr,
669     DeriveHelper,
670     MacroRulesVsModularized,
671     GlobVsOuter,
672     GlobVsGlob,
673     GlobVsExpanded,
674     MoreExpandedVsOuter,
675 }
676
677 impl AmbiguityKind {
678     fn descr(self) -> &'static str {
679         match self {
680             AmbiguityKind::Import => "name vs any other name during import resolution",
681             AmbiguityKind::BuiltinAttr => "built-in attribute vs any other name",
682             AmbiguityKind::DeriveHelper => "derive helper attribute vs any other name",
683             AmbiguityKind::MacroRulesVsModularized => {
684                 "`macro_rules` vs non-`macro_rules` from other module"
685             }
686             AmbiguityKind::GlobVsOuter => {
687                 "glob import vs any other name from outer scope during import/macro resolution"
688             }
689             AmbiguityKind::GlobVsGlob => "glob import vs glob import in the same module",
690             AmbiguityKind::GlobVsExpanded => {
691                 "glob import vs macro-expanded name in the same \
692                  module during import/macro resolution"
693             }
694             AmbiguityKind::MoreExpandedVsOuter => {
695                 "macro-expanded name vs less macro-expanded name \
696                  from outer scope during import/macro resolution"
697             }
698         }
699     }
700 }
701
702 /// Miscellaneous bits of metadata for better ambiguity error reporting.
703 #[derive(Clone, Copy, PartialEq)]
704 enum AmbiguityErrorMisc {
705     SuggestCrate,
706     SuggestSelf,
707     FromPrelude,
708     None,
709 }
710
711 struct AmbiguityError<'a> {
712     kind: AmbiguityKind,
713     ident: Ident,
714     b1: &'a NameBinding<'a>,
715     b2: &'a NameBinding<'a>,
716     misc1: AmbiguityErrorMisc,
717     misc2: AmbiguityErrorMisc,
718 }
719
720 impl<'a> NameBinding<'a> {
721     fn module(&self) -> Option<Module<'a>> {
722         match self.kind {
723             NameBindingKind::Module(module) => Some(module),
724             NameBindingKind::Import { binding, .. } => binding.module(),
725             _ => None,
726         }
727     }
728
729     fn res(&self) -> Res {
730         match self.kind {
731             NameBindingKind::Res(res, _) => res,
732             NameBindingKind::Module(module) => module.res().unwrap(),
733             NameBindingKind::Import { binding, .. } => binding.res(),
734         }
735     }
736
737     fn is_ambiguity(&self) -> bool {
738         self.ambiguity.is_some()
739             || match self.kind {
740                 NameBindingKind::Import { binding, .. } => binding.is_ambiguity(),
741                 _ => false,
742             }
743     }
744
745     fn is_possibly_imported_variant(&self) -> bool {
746         match self.kind {
747             NameBindingKind::Import { binding, .. } => binding.is_possibly_imported_variant(),
748             _ => self.is_variant(),
749         }
750     }
751
752     // We sometimes need to treat variants as `pub` for backwards compatibility.
753     fn pseudo_vis(&self) -> ty::Visibility {
754         if self.is_variant() && self.res().def_id().is_local() {
755             ty::Visibility::Public
756         } else {
757             self.vis
758         }
759     }
760
761     fn is_variant(&self) -> bool {
762         matches!(self.kind, NameBindingKind::Res(
763                 Res::Def(DefKind::Variant | DefKind::Ctor(CtorOf::Variant, ..), _),
764                 _,
765             ))
766     }
767
768     fn is_extern_crate(&self) -> bool {
769         match self.kind {
770             NameBindingKind::Import {
771                 import: &Import { kind: ImportKind::ExternCrate { .. }, .. },
772                 ..
773             } => true,
774             NameBindingKind::Module(&ModuleData {
775                 kind: ModuleKind::Def(DefKind::Mod, def_id, _),
776                 ..
777             }) => def_id.index == CRATE_DEF_INDEX,
778             _ => false,
779         }
780     }
781
782     fn is_import(&self) -> bool {
783         matches!(self.kind, NameBindingKind::Import { .. })
784     }
785
786     fn is_glob_import(&self) -> bool {
787         match self.kind {
788             NameBindingKind::Import { import, .. } => import.is_glob(),
789             _ => false,
790         }
791     }
792
793     fn is_importable(&self) -> bool {
794         !matches!(
795             self.res(),
796             Res::Def(DefKind::AssocConst | DefKind::AssocFn | DefKind::AssocTy, _)
797         )
798     }
799
800     fn is_macro_def(&self) -> bool {
801         matches!(self.kind, NameBindingKind::Res(Res::Def(DefKind::Macro(..), _), _))
802     }
803
804     fn macro_kind(&self) -> Option<MacroKind> {
805         self.res().macro_kind()
806     }
807
808     // Suppose that we resolved macro invocation with `invoc_parent_expansion` to binding `binding`
809     // at some expansion round `max(invoc, binding)` when they both emerged from macros.
810     // Then this function returns `true` if `self` may emerge from a macro *after* that
811     // in some later round and screw up our previously found resolution.
812     // See more detailed explanation in
813     // https://github.com/rust-lang/rust/pull/53778#issuecomment-419224049
814     fn may_appear_after(&self, invoc_parent_expansion: ExpnId, binding: &NameBinding<'_>) -> bool {
815         // self > max(invoc, binding) => !(self <= invoc || self <= binding)
816         // Expansions are partially ordered, so "may appear after" is an inversion of
817         // "certainly appears before or simultaneously" and includes unordered cases.
818         let self_parent_expansion = self.expansion;
819         let other_parent_expansion = binding.expansion;
820         let certainly_before_other_or_simultaneously =
821             other_parent_expansion.is_descendant_of(self_parent_expansion);
822         let certainly_before_invoc_or_simultaneously =
823             invoc_parent_expansion.is_descendant_of(self_parent_expansion);
824         !(certainly_before_other_or_simultaneously || certainly_before_invoc_or_simultaneously)
825     }
826 }
827
828 /// Interns the names of the primitive types.
829 ///
830 /// All other types are defined somewhere and possibly imported, but the primitive ones need
831 /// special handling, since they have no place of origin.
832 struct PrimitiveTypeTable {
833     primitive_types: FxHashMap<Symbol, PrimTy>,
834 }
835
836 impl PrimitiveTypeTable {
837     fn new() -> PrimitiveTypeTable {
838         let mut table = FxHashMap::default();
839
840         table.insert(sym::bool, Bool);
841         table.insert(sym::char, Char);
842         table.insert(sym::f32, Float(FloatTy::F32));
843         table.insert(sym::f64, Float(FloatTy::F64));
844         table.insert(sym::isize, Int(IntTy::Isize));
845         table.insert(sym::i8, Int(IntTy::I8));
846         table.insert(sym::i16, Int(IntTy::I16));
847         table.insert(sym::i32, Int(IntTy::I32));
848         table.insert(sym::i64, Int(IntTy::I64));
849         table.insert(sym::i128, Int(IntTy::I128));
850         table.insert(sym::str, Str);
851         table.insert(sym::usize, Uint(UintTy::Usize));
852         table.insert(sym::u8, Uint(UintTy::U8));
853         table.insert(sym::u16, Uint(UintTy::U16));
854         table.insert(sym::u32, Uint(UintTy::U32));
855         table.insert(sym::u64, Uint(UintTy::U64));
856         table.insert(sym::u128, Uint(UintTy::U128));
857         Self { primitive_types: table }
858     }
859 }
860
861 #[derive(Debug, Default, Clone)]
862 pub struct ExternPreludeEntry<'a> {
863     extern_crate_item: Option<&'a NameBinding<'a>>,
864     pub introduced_by_item: bool,
865 }
866
867 /// Used for better errors for E0773
868 enum BuiltinMacroState {
869     NotYetSeen(SyntaxExtension),
870     AlreadySeen(Span),
871 }
872
873 /// The main resolver class.
874 ///
875 /// This is the visitor that walks the whole crate.
876 pub struct Resolver<'a> {
877     session: &'a Session,
878
879     definitions: Definitions,
880
881     graph_root: Module<'a>,
882
883     prelude: Option<Module<'a>>,
884     extern_prelude: FxHashMap<Ident, ExternPreludeEntry<'a>>,
885
886     /// N.B., this is used only for better diagnostics, not name resolution itself.
887     has_self: FxHashSet<DefId>,
888
889     /// Names of fields of an item `DefId` accessible with dot syntax.
890     /// Used for hints during error reporting.
891     field_names: FxHashMap<DefId, Vec<Spanned<Symbol>>>,
892
893     /// All imports known to succeed or fail.
894     determined_imports: Vec<&'a Import<'a>>,
895
896     /// All non-determined imports.
897     indeterminate_imports: Vec<&'a Import<'a>>,
898
899     /// FIXME: Refactor things so that these fields are passed through arguments and not resolver.
900     /// We are resolving a last import segment during import validation.
901     last_import_segment: bool,
902     /// This binding should be ignored during in-module resolution, so that we don't get
903     /// "self-confirming" import resolutions during import validation.
904     unusable_binding: Option<&'a NameBinding<'a>>,
905
906     /// The idents for the primitive types.
907     primitive_type_table: PrimitiveTypeTable,
908
909     /// Resolutions for nodes that have a single resolution.
910     partial_res_map: NodeMap<PartialRes>,
911     /// Resolutions for import nodes, which have multiple resolutions in different namespaces.
912     import_res_map: NodeMap<PerNS<Option<Res>>>,
913     /// Resolutions for labels (node IDs of their corresponding blocks or loops).
914     label_res_map: NodeMap<NodeId>,
915
916     /// `CrateNum` resolutions of `extern crate` items.
917     extern_crate_map: FxHashMap<LocalDefId, CrateNum>,
918     export_map: ExportMap<LocalDefId>,
919     trait_map: NodeMap<Vec<TraitCandidate>>,
920
921     /// A map from nodes to anonymous modules.
922     /// Anonymous modules are pseudo-modules that are implicitly created around items
923     /// contained within blocks.
924     ///
925     /// For example, if we have this:
926     ///
927     ///  fn f() {
928     ///      fn g() {
929     ///          ...
930     ///      }
931     ///  }
932     ///
933     /// There will be an anonymous module created around `g` with the ID of the
934     /// entry block for `f`.
935     block_map: NodeMap<Module<'a>>,
936     /// A fake module that contains no definition and no prelude. Used so that
937     /// some AST passes can generate identifiers that only resolve to local or
938     /// language items.
939     empty_module: Module<'a>,
940     module_map: FxHashMap<LocalDefId, Module<'a>>,
941     extern_module_map: FxHashMap<DefId, Module<'a>>,
942     binding_parent_modules: FxHashMap<PtrKey<'a, NameBinding<'a>>, Module<'a>>,
943     underscore_disambiguator: u32,
944
945     /// Maps glob imports to the names of items actually imported.
946     glob_map: FxHashMap<LocalDefId, FxHashSet<Symbol>>,
947     /// Visibilities in "lowered" form, for all entities that have them.
948     visibilities: FxHashMap<LocalDefId, ty::Visibility>,
949     used_imports: FxHashSet<(NodeId, Namespace)>,
950     maybe_unused_trait_imports: FxHashSet<LocalDefId>,
951     maybe_unused_extern_crates: Vec<(LocalDefId, Span)>,
952
953     /// Privacy errors are delayed until the end in order to deduplicate them.
954     privacy_errors: Vec<PrivacyError<'a>>,
955     /// Ambiguity errors are delayed for deduplication.
956     ambiguity_errors: Vec<AmbiguityError<'a>>,
957     /// `use` injections are delayed for better placement and deduplication.
958     use_injections: Vec<UseError<'a>>,
959     /// Crate-local macro expanded `macro_export` referred to by a module-relative path.
960     macro_expanded_macro_export_errors: BTreeSet<(Span, Span)>,
961
962     arenas: &'a ResolverArenas<'a>,
963     dummy_binding: &'a NameBinding<'a>,
964
965     crate_loader: CrateLoader<'a>,
966     macro_names: FxHashSet<Ident>,
967     builtin_macros: FxHashMap<Symbol, BuiltinMacroState>,
968     registered_attrs: FxHashSet<Ident>,
969     registered_tools: FxHashSet<Ident>,
970     macro_use_prelude: FxHashMap<Symbol, &'a NameBinding<'a>>,
971     all_macros: FxHashMap<Symbol, Res>,
972     macro_map: FxHashMap<DefId, Lrc<SyntaxExtension>>,
973     dummy_ext_bang: Lrc<SyntaxExtension>,
974     dummy_ext_derive: Lrc<SyntaxExtension>,
975     non_macro_attrs: [Lrc<SyntaxExtension>; 2],
976     local_macro_def_scopes: FxHashMap<LocalDefId, Module<'a>>,
977     ast_transform_scopes: FxHashMap<ExpnId, Module<'a>>,
978     unused_macros: FxHashMap<LocalDefId, (NodeId, Span)>,
979     proc_macro_stubs: FxHashSet<LocalDefId>,
980     /// Traces collected during macro resolution and validated when it's complete.
981     single_segment_macro_resolutions:
982         Vec<(Ident, MacroKind, ParentScope<'a>, Option<&'a NameBinding<'a>>)>,
983     multi_segment_macro_resolutions:
984         Vec<(Vec<Segment>, Span, MacroKind, ParentScope<'a>, Option<Res>)>,
985     builtin_attrs: Vec<(Ident, ParentScope<'a>)>,
986     /// `derive(Copy)` marks items they are applied to so they are treated specially later.
987     /// Derive macros cannot modify the item themselves and have to store the markers in the global
988     /// context, so they attach the markers to derive container IDs using this resolver table.
989     containers_deriving_copy: FxHashSet<ExpnId>,
990     /// Parent scopes in which the macros were invoked.
991     /// FIXME: `derives` are missing in these parent scopes and need to be taken from elsewhere.
992     invocation_parent_scopes: FxHashMap<ExpnId, ParentScope<'a>>,
993     /// `macro_rules` scopes *produced* by expanding the macro invocations,
994     /// include all the `macro_rules` items and other invocations generated by them.
995     output_macro_rules_scopes: FxHashMap<ExpnId, MacroRulesScopeRef<'a>>,
996     /// Helper attributes that are in scope for the given expansion.
997     helper_attrs: FxHashMap<ExpnId, Vec<Ident>>,
998
999     /// Avoid duplicated errors for "name already defined".
1000     name_already_seen: FxHashMap<Symbol, Span>,
1001
1002     potentially_unused_imports: Vec<&'a Import<'a>>,
1003
1004     /// Table for mapping struct IDs into struct constructor IDs,
1005     /// it's not used during normal resolution, only for better error reporting.
1006     /// Also includes of list of each fields visibility
1007     struct_constructors: DefIdMap<(Res, ty::Visibility, Vec<ty::Visibility>)>,
1008
1009     /// Features enabled for this crate.
1010     active_features: FxHashSet<Symbol>,
1011
1012     lint_buffer: LintBuffer,
1013
1014     next_node_id: NodeId,
1015
1016     def_id_to_span: IndexVec<LocalDefId, Span>,
1017
1018     node_id_to_def_id: FxHashMap<ast::NodeId, LocalDefId>,
1019     def_id_to_node_id: IndexVec<LocalDefId, ast::NodeId>,
1020
1021     /// Indices of unnamed struct or variant fields with unresolved attributes.
1022     placeholder_field_indices: FxHashMap<NodeId, usize>,
1023     /// When collecting definitions from an AST fragment produced by a macro invocation `ExpnId`
1024     /// we know what parent node that fragment should be attached to thanks to this table.
1025     invocation_parents: FxHashMap<ExpnId, LocalDefId>,
1026
1027     next_disambiguator: FxHashMap<(LocalDefId, DefPathData), u32>,
1028     /// Some way to know that we are in a *trait* impl in `visit_assoc_item`.
1029     /// FIXME: Replace with a more general AST map (together with some other fields).
1030     trait_impl_items: FxHashSet<LocalDefId>,
1031 }
1032
1033 /// Nothing really interesting here; it just provides memory for the rest of the crate.
1034 #[derive(Default)]
1035 pub struct ResolverArenas<'a> {
1036     modules: TypedArena<ModuleData<'a>>,
1037     local_modules: RefCell<Vec<Module<'a>>>,
1038     imports: TypedArena<Import<'a>>,
1039     name_resolutions: TypedArena<RefCell<NameResolution<'a>>>,
1040     ast_paths: TypedArena<ast::Path>,
1041     dropless: DroplessArena,
1042 }
1043
1044 impl<'a> ResolverArenas<'a> {
1045     fn alloc_module(&'a self, module: ModuleData<'a>) -> Module<'a> {
1046         let module = self.modules.alloc(module);
1047         if module.def_id().map(|def_id| def_id.is_local()).unwrap_or(true) {
1048             self.local_modules.borrow_mut().push(module);
1049         }
1050         module
1051     }
1052     fn local_modules(&'a self) -> std::cell::Ref<'a, Vec<Module<'a>>> {
1053         self.local_modules.borrow()
1054     }
1055     fn alloc_name_binding(&'a self, name_binding: NameBinding<'a>) -> &'a NameBinding<'a> {
1056         self.dropless.alloc(name_binding)
1057     }
1058     fn alloc_import(&'a self, import: Import<'a>) -> &'a Import<'_> {
1059         self.imports.alloc(import)
1060     }
1061     fn alloc_name_resolution(&'a self) -> &'a RefCell<NameResolution<'a>> {
1062         self.name_resolutions.alloc(Default::default())
1063     }
1064     fn alloc_macro_rules_scope(&'a self, scope: MacroRulesScope<'a>) -> MacroRulesScopeRef<'a> {
1065         PtrKey(self.dropless.alloc(Cell::new(scope)))
1066     }
1067     fn alloc_macro_rules_binding(
1068         &'a self,
1069         binding: MacroRulesBinding<'a>,
1070     ) -> &'a MacroRulesBinding<'a> {
1071         self.dropless.alloc(binding)
1072     }
1073     fn alloc_ast_paths(&'a self, paths: &[ast::Path]) -> &'a [ast::Path] {
1074         self.ast_paths.alloc_from_iter(paths.iter().cloned())
1075     }
1076     fn alloc_pattern_spans(&'a self, spans: impl Iterator<Item = Span>) -> &'a [Span] {
1077         self.dropless.alloc_from_iter(spans)
1078     }
1079 }
1080
1081 impl<'a> AsMut<Resolver<'a>> for Resolver<'a> {
1082     fn as_mut(&mut self) -> &mut Resolver<'a> {
1083         self
1084     }
1085 }
1086
1087 impl<'a, 'b> DefIdTree for &'a Resolver<'b> {
1088     fn parent(self, id: DefId) -> Option<DefId> {
1089         match id.as_local() {
1090             Some(id) => self.definitions.def_key(id).parent,
1091             None => self.cstore().def_key(id).parent,
1092         }
1093         .map(|index| DefId { index, ..id })
1094     }
1095 }
1096
1097 /// This interface is used through the AST→HIR step, to embed full paths into the HIR. After that
1098 /// the resolver is no longer needed as all the relevant information is inline.
1099 impl ResolverAstLowering for Resolver<'_> {
1100     fn def_key(&mut self, id: DefId) -> DefKey {
1101         if let Some(id) = id.as_local() {
1102             self.definitions().def_key(id)
1103         } else {
1104             self.cstore().def_key(id)
1105         }
1106     }
1107
1108     fn item_generics_num_lifetimes(&self, def_id: DefId, sess: &Session) -> usize {
1109         self.cstore().item_generics_num_lifetimes(def_id, sess)
1110     }
1111
1112     fn get_partial_res(&mut self, id: NodeId) -> Option<PartialRes> {
1113         self.partial_res_map.get(&id).cloned()
1114     }
1115
1116     fn get_import_res(&mut self, id: NodeId) -> PerNS<Option<Res>> {
1117         self.import_res_map.get(&id).cloned().unwrap_or_default()
1118     }
1119
1120     fn get_label_res(&mut self, id: NodeId) -> Option<NodeId> {
1121         self.label_res_map.get(&id).cloned()
1122     }
1123
1124     fn definitions(&mut self) -> &mut Definitions {
1125         &mut self.definitions
1126     }
1127
1128     fn lint_buffer(&mut self) -> &mut LintBuffer {
1129         &mut self.lint_buffer
1130     }
1131
1132     fn next_node_id(&mut self) -> NodeId {
1133         self.next_node_id()
1134     }
1135
1136     fn trait_map(&self) -> &NodeMap<Vec<TraitCandidate>> {
1137         &self.trait_map
1138     }
1139
1140     fn opt_local_def_id(&self, node: NodeId) -> Option<LocalDefId> {
1141         self.node_id_to_def_id.get(&node).copied()
1142     }
1143
1144     fn local_def_id(&self, node: NodeId) -> LocalDefId {
1145         self.opt_local_def_id(node).unwrap_or_else(|| panic!("no entry for node id: `{:?}`", node))
1146     }
1147
1148     /// Adds a definition with a parent definition.
1149     fn create_def(
1150         &mut self,
1151         parent: LocalDefId,
1152         node_id: ast::NodeId,
1153         data: DefPathData,
1154         expn_id: ExpnId,
1155         span: Span,
1156     ) -> LocalDefId {
1157         assert!(
1158             !self.node_id_to_def_id.contains_key(&node_id),
1159             "adding a def'n for node-id {:?} and data {:?} but a previous def'n exists: {:?}",
1160             node_id,
1161             data,
1162             self.definitions.def_key(self.node_id_to_def_id[&node_id]),
1163         );
1164
1165         // Find the next free disambiguator for this key.
1166         let next_disambiguator = &mut self.next_disambiguator;
1167         let next_disambiguator = |parent, data| {
1168             let next_disamb = next_disambiguator.entry((parent, data)).or_insert(0);
1169             let disambiguator = *next_disamb;
1170             *next_disamb = next_disamb.checked_add(1).expect("disambiguator overflow");
1171             disambiguator
1172         };
1173
1174         let def_id = self.definitions.create_def(parent, data, expn_id, next_disambiguator);
1175
1176         assert_eq!(self.def_id_to_span.push(span), def_id);
1177
1178         // Some things for which we allocate `LocalDefId`s don't correspond to
1179         // anything in the AST, so they don't have a `NodeId`. For these cases
1180         // we don't need a mapping from `NodeId` to `LocalDefId`.
1181         if node_id != ast::DUMMY_NODE_ID {
1182             debug!("create_def: def_id_to_node_id[{:?}] <-> {:?}", def_id, node_id);
1183             self.node_id_to_def_id.insert(node_id, def_id);
1184         }
1185         assert_eq!(self.def_id_to_node_id.push(node_id), def_id);
1186
1187         def_id
1188     }
1189 }
1190
1191 impl<'a> Resolver<'a> {
1192     pub fn new(
1193         session: &'a Session,
1194         krate: &Crate,
1195         crate_name: &str,
1196         metadata_loader: &'a MetadataLoaderDyn,
1197         arenas: &'a ResolverArenas<'a>,
1198     ) -> Resolver<'a> {
1199         let root_local_def_id = LocalDefId { local_def_index: CRATE_DEF_INDEX };
1200         let root_def_id = root_local_def_id.to_def_id();
1201         let root_module_kind = ModuleKind::Def(DefKind::Mod, root_def_id, kw::Empty);
1202         let graph_root = arenas.alloc_module(ModuleData {
1203             no_implicit_prelude: session.contains_name(&krate.attrs, sym::no_implicit_prelude),
1204             ..ModuleData::new(None, root_module_kind, root_def_id, ExpnId::root(), krate.span)
1205         });
1206         let empty_module_kind = ModuleKind::Def(DefKind::Mod, root_def_id, kw::Empty);
1207         let empty_module = arenas.alloc_module(ModuleData {
1208             no_implicit_prelude: true,
1209             ..ModuleData::new(
1210                 Some(graph_root),
1211                 empty_module_kind,
1212                 root_def_id,
1213                 ExpnId::root(),
1214                 DUMMY_SP,
1215             )
1216         });
1217         let mut module_map = FxHashMap::default();
1218         module_map.insert(root_local_def_id, graph_root);
1219
1220         let definitions = Definitions::new(crate_name, session.local_crate_disambiguator());
1221         let root = definitions.get_root_def();
1222
1223         let mut visibilities = FxHashMap::default();
1224         visibilities.insert(root_local_def_id, ty::Visibility::Public);
1225
1226         let mut def_id_to_span = IndexVec::default();
1227         assert_eq!(def_id_to_span.push(rustc_span::DUMMY_SP), root);
1228         let mut def_id_to_node_id = IndexVec::default();
1229         assert_eq!(def_id_to_node_id.push(CRATE_NODE_ID), root);
1230         let mut node_id_to_def_id = FxHashMap::default();
1231         node_id_to_def_id.insert(CRATE_NODE_ID, root);
1232
1233         let mut invocation_parents = FxHashMap::default();
1234         invocation_parents.insert(ExpnId::root(), root);
1235
1236         let mut extern_prelude: FxHashMap<Ident, ExternPreludeEntry<'_>> = session
1237             .opts
1238             .externs
1239             .iter()
1240             .filter(|(_, entry)| entry.add_prelude)
1241             .map(|(name, _)| (Ident::from_str(name), Default::default()))
1242             .collect();
1243
1244         if !session.contains_name(&krate.attrs, sym::no_core) {
1245             extern_prelude.insert(Ident::with_dummy_span(sym::core), Default::default());
1246             if !session.contains_name(&krate.attrs, sym::no_std) {
1247                 extern_prelude.insert(Ident::with_dummy_span(sym::std), Default::default());
1248             }
1249         }
1250
1251         let (registered_attrs, registered_tools) =
1252             macros::registered_attrs_and_tools(session, &krate.attrs);
1253
1254         let features = session.features_untracked();
1255         let non_macro_attr =
1256             |mark_used| Lrc::new(SyntaxExtension::non_macro_attr(mark_used, session.edition()));
1257
1258         let mut resolver = Resolver {
1259             session,
1260
1261             definitions,
1262
1263             // The outermost module has def ID 0; this is not reflected in the
1264             // AST.
1265             graph_root,
1266             prelude: None,
1267             extern_prelude,
1268
1269             has_self: FxHashSet::default(),
1270             field_names: FxHashMap::default(),
1271
1272             determined_imports: Vec::new(),
1273             indeterminate_imports: Vec::new(),
1274
1275             last_import_segment: false,
1276             unusable_binding: None,
1277
1278             primitive_type_table: PrimitiveTypeTable::new(),
1279
1280             partial_res_map: Default::default(),
1281             import_res_map: Default::default(),
1282             label_res_map: Default::default(),
1283             extern_crate_map: Default::default(),
1284             export_map: FxHashMap::default(),
1285             trait_map: Default::default(),
1286             underscore_disambiguator: 0,
1287             empty_module,
1288             module_map,
1289             block_map: Default::default(),
1290             extern_module_map: FxHashMap::default(),
1291             binding_parent_modules: FxHashMap::default(),
1292             ast_transform_scopes: FxHashMap::default(),
1293
1294             glob_map: Default::default(),
1295             visibilities,
1296             used_imports: FxHashSet::default(),
1297             maybe_unused_trait_imports: Default::default(),
1298             maybe_unused_extern_crates: Vec::new(),
1299
1300             privacy_errors: Vec::new(),
1301             ambiguity_errors: Vec::new(),
1302             use_injections: Vec::new(),
1303             macro_expanded_macro_export_errors: BTreeSet::new(),
1304
1305             arenas,
1306             dummy_binding: arenas.alloc_name_binding(NameBinding {
1307                 kind: NameBindingKind::Res(Res::Err, false),
1308                 ambiguity: None,
1309                 expansion: ExpnId::root(),
1310                 span: DUMMY_SP,
1311                 vis: ty::Visibility::Public,
1312             }),
1313
1314             crate_loader: CrateLoader::new(session, metadata_loader, crate_name),
1315             macro_names: FxHashSet::default(),
1316             builtin_macros: Default::default(),
1317             registered_attrs,
1318             registered_tools,
1319             macro_use_prelude: FxHashMap::default(),
1320             all_macros: FxHashMap::default(),
1321             macro_map: FxHashMap::default(),
1322             dummy_ext_bang: Lrc::new(SyntaxExtension::dummy_bang(session.edition())),
1323             dummy_ext_derive: Lrc::new(SyntaxExtension::dummy_derive(session.edition())),
1324             non_macro_attrs: [non_macro_attr(false), non_macro_attr(true)],
1325             invocation_parent_scopes: Default::default(),
1326             output_macro_rules_scopes: Default::default(),
1327             helper_attrs: Default::default(),
1328             local_macro_def_scopes: FxHashMap::default(),
1329             name_already_seen: FxHashMap::default(),
1330             potentially_unused_imports: Vec::new(),
1331             struct_constructors: Default::default(),
1332             unused_macros: Default::default(),
1333             proc_macro_stubs: Default::default(),
1334             single_segment_macro_resolutions: Default::default(),
1335             multi_segment_macro_resolutions: Default::default(),
1336             builtin_attrs: Default::default(),
1337             containers_deriving_copy: Default::default(),
1338             active_features: features
1339                 .declared_lib_features
1340                 .iter()
1341                 .map(|(feat, ..)| *feat)
1342                 .chain(features.declared_lang_features.iter().map(|(feat, ..)| *feat))
1343                 .collect(),
1344             lint_buffer: LintBuffer::default(),
1345             next_node_id: NodeId::from_u32(1),
1346             def_id_to_span,
1347             node_id_to_def_id,
1348             def_id_to_node_id,
1349             placeholder_field_indices: Default::default(),
1350             invocation_parents,
1351             next_disambiguator: Default::default(),
1352             trait_impl_items: Default::default(),
1353         };
1354
1355         let root_parent_scope = ParentScope::module(graph_root, &resolver);
1356         resolver.invocation_parent_scopes.insert(ExpnId::root(), root_parent_scope);
1357
1358         resolver
1359     }
1360
1361     pub fn next_node_id(&mut self) -> NodeId {
1362         let next = self
1363             .next_node_id
1364             .as_usize()
1365             .checked_add(1)
1366             .expect("input too large; ran out of NodeIds");
1367         self.next_node_id = ast::NodeId::from_usize(next);
1368         self.next_node_id
1369     }
1370
1371     pub fn lint_buffer(&mut self) -> &mut LintBuffer {
1372         &mut self.lint_buffer
1373     }
1374
1375     pub fn arenas() -> ResolverArenas<'a> {
1376         Default::default()
1377     }
1378
1379     pub fn into_outputs(self) -> ResolverOutputs {
1380         let definitions = self.definitions;
1381         let visibilities = self.visibilities;
1382         let extern_crate_map = self.extern_crate_map;
1383         let export_map = self.export_map;
1384         let maybe_unused_trait_imports = self.maybe_unused_trait_imports;
1385         let maybe_unused_extern_crates = self.maybe_unused_extern_crates;
1386         let glob_map = self.glob_map;
1387         ResolverOutputs {
1388             definitions,
1389             cstore: Box::new(self.crate_loader.into_cstore()),
1390             visibilities,
1391             extern_crate_map,
1392             export_map,
1393             glob_map,
1394             maybe_unused_trait_imports,
1395             maybe_unused_extern_crates,
1396             extern_prelude: self
1397                 .extern_prelude
1398                 .iter()
1399                 .map(|(ident, entry)| (ident.name, entry.introduced_by_item))
1400                 .collect(),
1401         }
1402     }
1403
1404     pub fn clone_outputs(&self) -> ResolverOutputs {
1405         ResolverOutputs {
1406             definitions: self.definitions.clone(),
1407             cstore: Box::new(self.cstore().clone()),
1408             visibilities: self.visibilities.clone(),
1409             extern_crate_map: self.extern_crate_map.clone(),
1410             export_map: self.export_map.clone(),
1411             glob_map: self.glob_map.clone(),
1412             maybe_unused_trait_imports: self.maybe_unused_trait_imports.clone(),
1413             maybe_unused_extern_crates: self.maybe_unused_extern_crates.clone(),
1414             extern_prelude: self
1415                 .extern_prelude
1416                 .iter()
1417                 .map(|(ident, entry)| (ident.name, entry.introduced_by_item))
1418                 .collect(),
1419         }
1420     }
1421
1422     pub fn cstore(&self) -> &CStore {
1423         self.crate_loader.cstore()
1424     }
1425
1426     fn non_macro_attr(&self, mark_used: bool) -> Lrc<SyntaxExtension> {
1427         self.non_macro_attrs[mark_used as usize].clone()
1428     }
1429
1430     fn dummy_ext(&self, macro_kind: MacroKind) -> Lrc<SyntaxExtension> {
1431         match macro_kind {
1432             MacroKind::Bang => self.dummy_ext_bang.clone(),
1433             MacroKind::Derive => self.dummy_ext_derive.clone(),
1434             MacroKind::Attr => self.non_macro_attr(true),
1435         }
1436     }
1437
1438     /// Runs the function on each namespace.
1439     fn per_ns<F: FnMut(&mut Self, Namespace)>(&mut self, mut f: F) {
1440         f(self, TypeNS);
1441         f(self, ValueNS);
1442         f(self, MacroNS);
1443     }
1444
1445     fn is_builtin_macro(&mut self, res: Res) -> bool {
1446         self.get_macro(res).map_or(false, |ext| ext.is_builtin)
1447     }
1448
1449     fn macro_def(&self, mut ctxt: SyntaxContext) -> DefId {
1450         loop {
1451             match ctxt.outer_expn().expn_data().macro_def_id {
1452                 Some(def_id) => return def_id,
1453                 None => ctxt.remove_mark(),
1454             };
1455         }
1456     }
1457
1458     /// Entry point to crate resolution.
1459     pub fn resolve_crate(&mut self, krate: &Crate) {
1460         let _prof_timer = self.session.prof.generic_activity("resolve_crate");
1461
1462         ImportResolver { r: self }.finalize_imports();
1463         self.finalize_macro_resolutions();
1464
1465         self.late_resolve_crate(krate);
1466
1467         self.check_unused(krate);
1468         self.report_errors(krate);
1469         self.crate_loader.postprocess(krate);
1470     }
1471
1472     fn get_traits_in_module_containing_item(
1473         &mut self,
1474         ident: Ident,
1475         ns: Namespace,
1476         module: Module<'a>,
1477         found_traits: &mut Vec<TraitCandidate>,
1478         parent_scope: &ParentScope<'a>,
1479     ) {
1480         assert!(ns == TypeNS || ns == ValueNS);
1481         module.ensure_traits(self);
1482         let traits = module.traits.borrow();
1483
1484         for &(trait_name, binding) in traits.as_ref().unwrap().iter() {
1485             // Traits have pseudo-modules that can be used to search for the given ident.
1486             if let Some(module) = binding.module() {
1487                 let mut ident = ident;
1488                 if ident.span.glob_adjust(module.expansion, binding.span).is_none() {
1489                     continue;
1490                 }
1491                 if self
1492                     .resolve_ident_in_module_unadjusted(
1493                         ModuleOrUniformRoot::Module(module),
1494                         ident,
1495                         ns,
1496                         parent_scope,
1497                         false,
1498                         module.span,
1499                     )
1500                     .is_ok()
1501                 {
1502                     let import_ids = self.find_transitive_imports(&binding.kind, trait_name);
1503                     let trait_def_id = module.def_id().unwrap();
1504                     found_traits.push(TraitCandidate { def_id: trait_def_id, import_ids });
1505                 }
1506             } else if let Res::Def(DefKind::TraitAlias, _) = binding.res() {
1507                 // For now, just treat all trait aliases as possible candidates, since we don't
1508                 // know if the ident is somewhere in the transitive bounds.
1509                 let import_ids = self.find_transitive_imports(&binding.kind, trait_name);
1510                 let trait_def_id = binding.res().def_id();
1511                 found_traits.push(TraitCandidate { def_id: trait_def_id, import_ids });
1512             } else {
1513                 bug!("candidate is not trait or trait alias?")
1514             }
1515         }
1516     }
1517
1518     fn find_transitive_imports(
1519         &mut self,
1520         mut kind: &NameBindingKind<'_>,
1521         trait_name: Ident,
1522     ) -> SmallVec<[LocalDefId; 1]> {
1523         let mut import_ids = smallvec![];
1524         while let NameBindingKind::Import { import, binding, .. } = kind {
1525             let id = self.local_def_id(import.id);
1526             self.maybe_unused_trait_imports.insert(id);
1527             self.add_to_glob_map(&import, trait_name);
1528             import_ids.push(id);
1529             kind = &binding.kind;
1530         }
1531         import_ids
1532     }
1533
1534     fn new_module(
1535         &self,
1536         parent: Module<'a>,
1537         kind: ModuleKind,
1538         nearest_parent_mod: DefId,
1539         expn_id: ExpnId,
1540         span: Span,
1541     ) -> Module<'a> {
1542         let module = ModuleData::new(Some(parent), kind, nearest_parent_mod, expn_id, span);
1543         self.arenas.alloc_module(module)
1544     }
1545
1546     fn new_key(&mut self, ident: Ident, ns: Namespace) -> BindingKey {
1547         let ident = ident.normalize_to_macros_2_0();
1548         let disambiguator = if ident.name == kw::Underscore {
1549             self.underscore_disambiguator += 1;
1550             self.underscore_disambiguator
1551         } else {
1552             0
1553         };
1554         BindingKey { ident, ns, disambiguator }
1555     }
1556
1557     fn resolutions(&mut self, module: Module<'a>) -> &'a Resolutions<'a> {
1558         if module.populate_on_access.get() {
1559             module.populate_on_access.set(false);
1560             self.build_reduced_graph_external(module);
1561         }
1562         &module.lazy_resolutions
1563     }
1564
1565     fn resolution(
1566         &mut self,
1567         module: Module<'a>,
1568         key: BindingKey,
1569     ) -> &'a RefCell<NameResolution<'a>> {
1570         *self
1571             .resolutions(module)
1572             .borrow_mut()
1573             .entry(key)
1574             .or_insert_with(|| self.arenas.alloc_name_resolution())
1575     }
1576
1577     fn record_use(
1578         &mut self,
1579         ident: Ident,
1580         ns: Namespace,
1581         used_binding: &'a NameBinding<'a>,
1582         is_lexical_scope: bool,
1583     ) {
1584         if let Some((b2, kind)) = used_binding.ambiguity {
1585             self.ambiguity_errors.push(AmbiguityError {
1586                 kind,
1587                 ident,
1588                 b1: used_binding,
1589                 b2,
1590                 misc1: AmbiguityErrorMisc::None,
1591                 misc2: AmbiguityErrorMisc::None,
1592             });
1593         }
1594         if let NameBindingKind::Import { import, binding, ref used } = used_binding.kind {
1595             // Avoid marking `extern crate` items that refer to a name from extern prelude,
1596             // but not introduce it, as used if they are accessed from lexical scope.
1597             if is_lexical_scope {
1598                 if let Some(entry) = self.extern_prelude.get(&ident.normalize_to_macros_2_0()) {
1599                     if let Some(crate_item) = entry.extern_crate_item {
1600                         if ptr::eq(used_binding, crate_item) && !entry.introduced_by_item {
1601                             return;
1602                         }
1603                     }
1604                 }
1605             }
1606             used.set(true);
1607             import.used.set(true);
1608             self.used_imports.insert((import.id, ns));
1609             self.add_to_glob_map(&import, ident);
1610             self.record_use(ident, ns, binding, false);
1611         }
1612     }
1613
1614     #[inline]
1615     fn add_to_glob_map(&mut self, import: &Import<'_>, ident: Ident) {
1616         if import.is_glob() {
1617             let def_id = self.local_def_id(import.id);
1618             self.glob_map.entry(def_id).or_default().insert(ident.name);
1619         }
1620     }
1621
1622     /// A generic scope visitor.
1623     /// Visits scopes in order to resolve some identifier in them or perform other actions.
1624     /// If the callback returns `Some` result, we stop visiting scopes and return it.
1625     fn visit_scopes<T>(
1626         &mut self,
1627         scope_set: ScopeSet,
1628         parent_scope: &ParentScope<'a>,
1629         ident: Ident,
1630         mut visitor: impl FnMut(&mut Self, Scope<'a>, /*use_prelude*/ bool, Ident) -> Option<T>,
1631     ) -> Option<T> {
1632         // General principles:
1633         // 1. Not controlled (user-defined) names should have higher priority than controlled names
1634         //    built into the language or standard library. This way we can add new names into the
1635         //    language or standard library without breaking user code.
1636         // 2. "Closed set" below means new names cannot appear after the current resolution attempt.
1637         // Places to search (in order of decreasing priority):
1638         // (Type NS)
1639         // 1. FIXME: Ribs (type parameters), there's no necessary infrastructure yet
1640         //    (open set, not controlled).
1641         // 2. Names in modules (both normal `mod`ules and blocks), loop through hygienic parents
1642         //    (open, not controlled).
1643         // 3. Extern prelude (open, the open part is from macro expansions, not controlled).
1644         // 4. Tool modules (closed, controlled right now, but not in the future).
1645         // 5. Standard library prelude (de-facto closed, controlled).
1646         // 6. Language prelude (closed, controlled).
1647         // (Value NS)
1648         // 1. FIXME: Ribs (local variables), there's no necessary infrastructure yet
1649         //    (open set, not controlled).
1650         // 2. Names in modules (both normal `mod`ules and blocks), loop through hygienic parents
1651         //    (open, not controlled).
1652         // 3. Standard library prelude (de-facto closed, controlled).
1653         // (Macro NS)
1654         // 1-3. Derive helpers (open, not controlled). All ambiguities with other names
1655         //    are currently reported as errors. They should be higher in priority than preludes
1656         //    and probably even names in modules according to the "general principles" above. They
1657         //    also should be subject to restricted shadowing because are effectively produced by
1658         //    derives (you need to resolve the derive first to add helpers into scope), but they
1659         //    should be available before the derive is expanded for compatibility.
1660         //    It's mess in general, so we are being conservative for now.
1661         // 1-3. `macro_rules` (open, not controlled), loop through `macro_rules` scopes. Have higher
1662         //    priority than prelude macros, but create ambiguities with macros in modules.
1663         // 1-3. Names in modules (both normal `mod`ules and blocks), loop through hygienic parents
1664         //    (open, not controlled). Have higher priority than prelude macros, but create
1665         //    ambiguities with `macro_rules`.
1666         // 4. `macro_use` prelude (open, the open part is from macro expansions, not controlled).
1667         // 4a. User-defined prelude from macro-use
1668         //    (open, the open part is from macro expansions, not controlled).
1669         // 4b. "Standard library prelude" part implemented through `macro-use` (closed, controlled).
1670         // 4c. Standard library prelude (de-facto closed, controlled).
1671         // 6. Language prelude: builtin attributes (closed, controlled).
1672
1673         let rust_2015 = ident.span.rust_2015();
1674         let (ns, macro_kind, is_absolute_path) = match scope_set {
1675             ScopeSet::All(ns, _) => (ns, None, false),
1676             ScopeSet::AbsolutePath(ns) => (ns, None, true),
1677             ScopeSet::Macro(macro_kind) => (MacroNS, Some(macro_kind), false),
1678         };
1679         // Jump out of trait or enum modules, they do not act as scopes.
1680         let module = parent_scope.module.nearest_item_scope();
1681         let mut scope = match ns {
1682             _ if is_absolute_path => Scope::CrateRoot,
1683             TypeNS | ValueNS => Scope::Module(module),
1684             MacroNS => Scope::DeriveHelpers(parent_scope.expansion),
1685         };
1686         let mut ident = ident.normalize_to_macros_2_0();
1687         let mut use_prelude = !module.no_implicit_prelude;
1688
1689         loop {
1690             let visit = match scope {
1691                 // Derive helpers are not in scope when resolving derives in the same container.
1692                 Scope::DeriveHelpers(expn_id) => {
1693                     !(expn_id == parent_scope.expansion && macro_kind == Some(MacroKind::Derive))
1694                 }
1695                 Scope::DeriveHelpersCompat => true,
1696                 Scope::MacroRules(macro_rules_scope) => {
1697                     // Use "path compression" on `macro_rules` scope chains. This is an optimization
1698                     // used to avoid long scope chains, see the comments on `MacroRulesScopeRef`.
1699                     // As another consequence of this optimization visitors never observe invocation
1700                     // scopes for macros that were already expanded.
1701                     while let MacroRulesScope::Invocation(invoc_id) = macro_rules_scope.get() {
1702                         if let Some(next_scope) = self.output_macro_rules_scopes.get(&invoc_id) {
1703                             macro_rules_scope.set(next_scope.get());
1704                         } else {
1705                             break;
1706                         }
1707                     }
1708                     true
1709                 }
1710                 Scope::CrateRoot => true,
1711                 Scope::Module(..) => true,
1712                 Scope::RegisteredAttrs => use_prelude,
1713                 Scope::MacroUsePrelude => use_prelude || rust_2015,
1714                 Scope::BuiltinAttrs => true,
1715                 Scope::ExternPrelude => use_prelude || is_absolute_path,
1716                 Scope::ToolPrelude => use_prelude,
1717                 Scope::StdLibPrelude => use_prelude || ns == MacroNS,
1718                 Scope::BuiltinTypes => true,
1719             };
1720
1721             if visit {
1722                 if let break_result @ Some(..) = visitor(self, scope, use_prelude, ident) {
1723                     return break_result;
1724                 }
1725             }
1726
1727             scope = match scope {
1728                 Scope::DeriveHelpers(expn_id) if expn_id != ExpnId::root() => {
1729                     // Derive helpers are not visible to code generated by bang or derive macros.
1730                     let expn_data = expn_id.expn_data();
1731                     match expn_data.kind {
1732                         ExpnKind::Root
1733                         | ExpnKind::Macro(MacroKind::Bang | MacroKind::Derive, _) => {
1734                             Scope::DeriveHelpersCompat
1735                         }
1736                         _ => Scope::DeriveHelpers(expn_data.parent),
1737                     }
1738                 }
1739                 Scope::DeriveHelpers(..) => Scope::DeriveHelpersCompat,
1740                 Scope::DeriveHelpersCompat => Scope::MacroRules(parent_scope.macro_rules),
1741                 Scope::MacroRules(macro_rules_scope) => match macro_rules_scope.get() {
1742                     MacroRulesScope::Binding(binding) => {
1743                         Scope::MacroRules(binding.parent_macro_rules_scope)
1744                     }
1745                     MacroRulesScope::Invocation(invoc_id) => {
1746                         Scope::MacroRules(self.invocation_parent_scopes[&invoc_id].macro_rules)
1747                     }
1748                     MacroRulesScope::Empty => Scope::Module(module),
1749                 },
1750                 Scope::CrateRoot => match ns {
1751                     TypeNS => {
1752                         ident.span.adjust(ExpnId::root());
1753                         Scope::ExternPrelude
1754                     }
1755                     ValueNS | MacroNS => break,
1756                 },
1757                 Scope::Module(module) => {
1758                     use_prelude = !module.no_implicit_prelude;
1759                     match self.hygienic_lexical_parent(module, &mut ident.span) {
1760                         Some(parent_module) => Scope::Module(parent_module),
1761                         None => {
1762                             ident.span.adjust(ExpnId::root());
1763                             match ns {
1764                                 TypeNS => Scope::ExternPrelude,
1765                                 ValueNS => Scope::StdLibPrelude,
1766                                 MacroNS => Scope::RegisteredAttrs,
1767                             }
1768                         }
1769                     }
1770                 }
1771                 Scope::RegisteredAttrs => Scope::MacroUsePrelude,
1772                 Scope::MacroUsePrelude => Scope::StdLibPrelude,
1773                 Scope::BuiltinAttrs => break, // nowhere else to search
1774                 Scope::ExternPrelude if is_absolute_path => break,
1775                 Scope::ExternPrelude => Scope::ToolPrelude,
1776                 Scope::ToolPrelude => Scope::StdLibPrelude,
1777                 Scope::StdLibPrelude => match ns {
1778                     TypeNS => Scope::BuiltinTypes,
1779                     ValueNS => break, // nowhere else to search
1780                     MacroNS => Scope::BuiltinAttrs,
1781                 },
1782                 Scope::BuiltinTypes => break, // nowhere else to search
1783             };
1784         }
1785
1786         None
1787     }
1788
1789     /// This resolves the identifier `ident` in the namespace `ns` in the current lexical scope.
1790     /// More specifically, we proceed up the hierarchy of scopes and return the binding for
1791     /// `ident` in the first scope that defines it (or None if no scopes define it).
1792     ///
1793     /// A block's items are above its local variables in the scope hierarchy, regardless of where
1794     /// the items are defined in the block. For example,
1795     /// ```rust
1796     /// fn f() {
1797     ///    g(); // Since there are no local variables in scope yet, this resolves to the item.
1798     ///    let g = || {};
1799     ///    fn g() {}
1800     ///    g(); // This resolves to the local variable `g` since it shadows the item.
1801     /// }
1802     /// ```
1803     ///
1804     /// Invariant: This must only be called during main resolution, not during
1805     /// import resolution.
1806     fn resolve_ident_in_lexical_scope(
1807         &mut self,
1808         mut ident: Ident,
1809         ns: Namespace,
1810         parent_scope: &ParentScope<'a>,
1811         record_used_id: Option<NodeId>,
1812         path_span: Span,
1813         ribs: &[Rib<'a>],
1814     ) -> Option<LexicalScopeBinding<'a>> {
1815         assert!(ns == TypeNS || ns == ValueNS);
1816         if ident.name == kw::Empty {
1817             return Some(LexicalScopeBinding::Res(Res::Err));
1818         }
1819         let (general_span, normalized_span) = if ident.name == kw::SelfUpper {
1820             // FIXME(jseyfried) improve `Self` hygiene
1821             let empty_span = ident.span.with_ctxt(SyntaxContext::root());
1822             (empty_span, empty_span)
1823         } else if ns == TypeNS {
1824             let normalized_span = ident.span.normalize_to_macros_2_0();
1825             (normalized_span, normalized_span)
1826         } else {
1827             (ident.span.normalize_to_macro_rules(), ident.span.normalize_to_macros_2_0())
1828         };
1829         ident.span = general_span;
1830         let normalized_ident = Ident { span: normalized_span, ..ident };
1831
1832         // Walk backwards up the ribs in scope.
1833         let record_used = record_used_id.is_some();
1834         let mut module = self.graph_root;
1835         for i in (0..ribs.len()).rev() {
1836             debug!("walk rib\n{:?}", ribs[i].bindings);
1837             // Use the rib kind to determine whether we are resolving parameters
1838             // (macro 2.0 hygiene) or local variables (`macro_rules` hygiene).
1839             let rib_ident = if ribs[i].kind.contains_params() { normalized_ident } else { ident };
1840             if let Some(res) = ribs[i].bindings.get(&rib_ident).cloned() {
1841                 // The ident resolves to a type parameter or local variable.
1842                 return Some(LexicalScopeBinding::Res(self.validate_res_from_ribs(
1843                     i,
1844                     rib_ident,
1845                     res,
1846                     record_used,
1847                     path_span,
1848                     ribs,
1849                 )));
1850             }
1851
1852             module = match ribs[i].kind {
1853                 ModuleRibKind(module) => module,
1854                 MacroDefinition(def) if def == self.macro_def(ident.span.ctxt()) => {
1855                     // If an invocation of this macro created `ident`, give up on `ident`
1856                     // and switch to `ident`'s source from the macro definition.
1857                     ident.span.remove_mark();
1858                     continue;
1859                 }
1860                 _ => continue,
1861             };
1862
1863             let item = self.resolve_ident_in_module_unadjusted(
1864                 ModuleOrUniformRoot::Module(module),
1865                 ident,
1866                 ns,
1867                 parent_scope,
1868                 record_used,
1869                 path_span,
1870             );
1871             if let Ok(binding) = item {
1872                 // The ident resolves to an item.
1873                 return Some(LexicalScopeBinding::Item(binding));
1874             }
1875
1876             match module.kind {
1877                 ModuleKind::Block(..) => {} // We can see through blocks
1878                 _ => break,
1879             }
1880         }
1881
1882         ident = normalized_ident;
1883         let mut poisoned = None;
1884         loop {
1885             let opt_module = if let Some(node_id) = record_used_id {
1886                 self.hygienic_lexical_parent_with_compatibility_fallback(
1887                     module,
1888                     &mut ident.span,
1889                     node_id,
1890                     &mut poisoned,
1891                 )
1892             } else {
1893                 self.hygienic_lexical_parent(module, &mut ident.span)
1894             };
1895             module = unwrap_or!(opt_module, break);
1896             let adjusted_parent_scope = &ParentScope { module, ..*parent_scope };
1897             let result = self.resolve_ident_in_module_unadjusted(
1898                 ModuleOrUniformRoot::Module(module),
1899                 ident,
1900                 ns,
1901                 adjusted_parent_scope,
1902                 record_used,
1903                 path_span,
1904             );
1905
1906             match result {
1907                 Ok(binding) => {
1908                     if let Some(node_id) = poisoned {
1909                         self.lint_buffer.buffer_lint_with_diagnostic(
1910                             lint::builtin::PROC_MACRO_DERIVE_RESOLUTION_FALLBACK,
1911                             node_id,
1912                             ident.span,
1913                             &format!("cannot find {} `{}` in this scope", ns.descr(), ident),
1914                             BuiltinLintDiagnostics::ProcMacroDeriveResolutionFallback(ident.span),
1915                         );
1916                     }
1917                     return Some(LexicalScopeBinding::Item(binding));
1918                 }
1919                 Err(Determined) => continue,
1920                 Err(Undetermined) => {
1921                     span_bug!(ident.span, "undetermined resolution during main resolution pass")
1922                 }
1923             }
1924         }
1925
1926         if !module.no_implicit_prelude {
1927             ident.span.adjust(ExpnId::root());
1928             if ns == TypeNS {
1929                 if let Some(binding) = self.extern_prelude_get(ident, !record_used) {
1930                     return Some(LexicalScopeBinding::Item(binding));
1931                 }
1932                 if let Some(ident) = self.registered_tools.get(&ident) {
1933                     let binding =
1934                         (Res::ToolMod, ty::Visibility::Public, ident.span, ExpnId::root())
1935                             .to_name_binding(self.arenas);
1936                     return Some(LexicalScopeBinding::Item(binding));
1937                 }
1938             }
1939             if let Some(prelude) = self.prelude {
1940                 if let Ok(binding) = self.resolve_ident_in_module_unadjusted(
1941                     ModuleOrUniformRoot::Module(prelude),
1942                     ident,
1943                     ns,
1944                     parent_scope,
1945                     false,
1946                     path_span,
1947                 ) {
1948                     return Some(LexicalScopeBinding::Item(binding));
1949                 }
1950             }
1951         }
1952
1953         if ns == TypeNS {
1954             if let Some(prim_ty) = self.primitive_type_table.primitive_types.get(&ident.name) {
1955                 let binding =
1956                     (Res::PrimTy(*prim_ty), ty::Visibility::Public, DUMMY_SP, ExpnId::root())
1957                         .to_name_binding(self.arenas);
1958                 return Some(LexicalScopeBinding::Item(binding));
1959             }
1960         }
1961
1962         None
1963     }
1964
1965     fn hygienic_lexical_parent(
1966         &mut self,
1967         module: Module<'a>,
1968         span: &mut Span,
1969     ) -> Option<Module<'a>> {
1970         if !module.expansion.outer_expn_is_descendant_of(span.ctxt()) {
1971             return Some(self.macro_def_scope(span.remove_mark()));
1972         }
1973
1974         if let ModuleKind::Block(..) = module.kind {
1975             return Some(module.parent.unwrap().nearest_item_scope());
1976         }
1977
1978         None
1979     }
1980
1981     fn hygienic_lexical_parent_with_compatibility_fallback(
1982         &mut self,
1983         module: Module<'a>,
1984         span: &mut Span,
1985         node_id: NodeId,
1986         poisoned: &mut Option<NodeId>,
1987     ) -> Option<Module<'a>> {
1988         if let module @ Some(..) = self.hygienic_lexical_parent(module, span) {
1989             return module;
1990         }
1991
1992         // We need to support the next case under a deprecation warning
1993         // ```
1994         // struct MyStruct;
1995         // ---- begin: this comes from a proc macro derive
1996         // mod implementation_details {
1997         //     // Note that `MyStruct` is not in scope here.
1998         //     impl SomeTrait for MyStruct { ... }
1999         // }
2000         // ---- end
2001         // ```
2002         // So we have to fall back to the module's parent during lexical resolution in this case.
2003         if let Some(parent) = module.parent {
2004             // Inner module is inside the macro, parent module is outside of the macro.
2005             if module.expansion != parent.expansion
2006                 && module.expansion.is_descendant_of(parent.expansion)
2007             {
2008                 // The macro is a proc macro derive
2009                 if let Some(def_id) = module.expansion.expn_data().macro_def_id {
2010                     let ext = self.get_macro_by_def_id(def_id);
2011                     if !ext.is_builtin
2012                         && ext.macro_kind() == MacroKind::Derive
2013                         && parent.expansion.outer_expn_is_descendant_of(span.ctxt())
2014                     {
2015                         *poisoned = Some(node_id);
2016                         return module.parent;
2017                     }
2018                 }
2019             }
2020         }
2021
2022         None
2023     }
2024
2025     fn resolve_ident_in_module(
2026         &mut self,
2027         module: ModuleOrUniformRoot<'a>,
2028         ident: Ident,
2029         ns: Namespace,
2030         parent_scope: &ParentScope<'a>,
2031         record_used: bool,
2032         path_span: Span,
2033     ) -> Result<&'a NameBinding<'a>, Determinacy> {
2034         self.resolve_ident_in_module_ext(module, ident, ns, parent_scope, record_used, path_span)
2035             .map_err(|(determinacy, _)| determinacy)
2036     }
2037
2038     fn resolve_ident_in_module_ext(
2039         &mut self,
2040         module: ModuleOrUniformRoot<'a>,
2041         mut ident: Ident,
2042         ns: Namespace,
2043         parent_scope: &ParentScope<'a>,
2044         record_used: bool,
2045         path_span: Span,
2046     ) -> Result<&'a NameBinding<'a>, (Determinacy, Weak)> {
2047         let tmp_parent_scope;
2048         let mut adjusted_parent_scope = parent_scope;
2049         match module {
2050             ModuleOrUniformRoot::Module(m) => {
2051                 if let Some(def) = ident.span.normalize_to_macros_2_0_and_adjust(m.expansion) {
2052                     tmp_parent_scope =
2053                         ParentScope { module: self.macro_def_scope(def), ..*parent_scope };
2054                     adjusted_parent_scope = &tmp_parent_scope;
2055                 }
2056             }
2057             ModuleOrUniformRoot::ExternPrelude => {
2058                 ident.span.normalize_to_macros_2_0_and_adjust(ExpnId::root());
2059             }
2060             ModuleOrUniformRoot::CrateRootAndExternPrelude | ModuleOrUniformRoot::CurrentScope => {
2061                 // No adjustments
2062             }
2063         }
2064         self.resolve_ident_in_module_unadjusted_ext(
2065             module,
2066             ident,
2067             ns,
2068             adjusted_parent_scope,
2069             false,
2070             record_used,
2071             path_span,
2072         )
2073     }
2074
2075     fn resolve_crate_root(&mut self, ident: Ident) -> Module<'a> {
2076         debug!("resolve_crate_root({:?})", ident);
2077         let mut ctxt = ident.span.ctxt();
2078         let mark = if ident.name == kw::DollarCrate {
2079             // When resolving `$crate` from a `macro_rules!` invoked in a `macro`,
2080             // we don't want to pretend that the `macro_rules!` definition is in the `macro`
2081             // as described in `SyntaxContext::apply_mark`, so we ignore prepended opaque marks.
2082             // FIXME: This is only a guess and it doesn't work correctly for `macro_rules!`
2083             // definitions actually produced by `macro` and `macro` definitions produced by
2084             // `macro_rules!`, but at least such configurations are not stable yet.
2085             ctxt = ctxt.normalize_to_macro_rules();
2086             debug!(
2087                 "resolve_crate_root: marks={:?}",
2088                 ctxt.marks().into_iter().map(|(i, t)| (i.expn_data(), t)).collect::<Vec<_>>()
2089             );
2090             let mut iter = ctxt.marks().into_iter().rev().peekable();
2091             let mut result = None;
2092             // Find the last opaque mark from the end if it exists.
2093             while let Some(&(mark, transparency)) = iter.peek() {
2094                 if transparency == Transparency::Opaque {
2095                     result = Some(mark);
2096                     iter.next();
2097                 } else {
2098                     break;
2099                 }
2100             }
2101             debug!(
2102                 "resolve_crate_root: found opaque mark {:?} {:?}",
2103                 result,
2104                 result.map(|r| r.expn_data())
2105             );
2106             // Then find the last semi-transparent mark from the end if it exists.
2107             for (mark, transparency) in iter {
2108                 if transparency == Transparency::SemiTransparent {
2109                     result = Some(mark);
2110                 } else {
2111                     break;
2112                 }
2113             }
2114             debug!(
2115                 "resolve_crate_root: found semi-transparent mark {:?} {:?}",
2116                 result,
2117                 result.map(|r| r.expn_data())
2118             );
2119             result
2120         } else {
2121             debug!("resolve_crate_root: not DollarCrate");
2122             ctxt = ctxt.normalize_to_macros_2_0();
2123             ctxt.adjust(ExpnId::root())
2124         };
2125         let module = match mark {
2126             Some(def) => self.macro_def_scope(def),
2127             None => {
2128                 debug!(
2129                     "resolve_crate_root({:?}): found no mark (ident.span = {:?})",
2130                     ident, ident.span
2131                 );
2132                 return self.graph_root;
2133             }
2134         };
2135         let module = self.get_module(DefId { index: CRATE_DEF_INDEX, ..module.nearest_parent_mod });
2136         debug!(
2137             "resolve_crate_root({:?}): got module {:?} ({:?}) (ident.span = {:?})",
2138             ident,
2139             module,
2140             module.kind.name(),
2141             ident.span
2142         );
2143         module
2144     }
2145
2146     fn resolve_self(&mut self, ctxt: &mut SyntaxContext, module: Module<'a>) -> Module<'a> {
2147         let mut module = self.get_module(module.nearest_parent_mod);
2148         while module.span.ctxt().normalize_to_macros_2_0() != *ctxt {
2149             let parent = module.parent.unwrap_or_else(|| self.macro_def_scope(ctxt.remove_mark()));
2150             module = self.get_module(parent.nearest_parent_mod);
2151         }
2152         module
2153     }
2154
2155     fn resolve_path(
2156         &mut self,
2157         path: &[Segment],
2158         opt_ns: Option<Namespace>, // `None` indicates a module path in import
2159         parent_scope: &ParentScope<'a>,
2160         record_used: bool,
2161         path_span: Span,
2162         crate_lint: CrateLint,
2163     ) -> PathResult<'a> {
2164         self.resolve_path_with_ribs(
2165             path,
2166             opt_ns,
2167             parent_scope,
2168             record_used,
2169             path_span,
2170             crate_lint,
2171             None,
2172         )
2173     }
2174
2175     fn resolve_path_with_ribs(
2176         &mut self,
2177         path: &[Segment],
2178         opt_ns: Option<Namespace>, // `None` indicates a module path in import
2179         parent_scope: &ParentScope<'a>,
2180         record_used: bool,
2181         path_span: Span,
2182         crate_lint: CrateLint,
2183         ribs: Option<&PerNS<Vec<Rib<'a>>>>,
2184     ) -> PathResult<'a> {
2185         let mut module = None;
2186         let mut allow_super = true;
2187         let mut second_binding = None;
2188
2189         debug!(
2190             "resolve_path(path={:?}, opt_ns={:?}, record_used={:?}, \
2191              path_span={:?}, crate_lint={:?})",
2192             path, opt_ns, record_used, path_span, crate_lint,
2193         );
2194
2195         for (i, &Segment { ident, id, has_generic_args: _ }) in path.iter().enumerate() {
2196             debug!("resolve_path ident {} {:?} {:?}", i, ident, id);
2197             let record_segment_res = |this: &mut Self, res| {
2198                 if record_used {
2199                     if let Some(id) = id {
2200                         if !this.partial_res_map.contains_key(&id) {
2201                             assert!(id != ast::DUMMY_NODE_ID, "Trying to resolve dummy id");
2202                             this.record_partial_res(id, PartialRes::new(res));
2203                         }
2204                     }
2205                 }
2206             };
2207
2208             let is_last = i == path.len() - 1;
2209             let ns = if is_last { opt_ns.unwrap_or(TypeNS) } else { TypeNS };
2210             let name = ident.name;
2211
2212             allow_super &= ns == TypeNS && (name == kw::SelfLower || name == kw::Super);
2213
2214             if ns == TypeNS {
2215                 if allow_super && name == kw::Super {
2216                     let mut ctxt = ident.span.ctxt().normalize_to_macros_2_0();
2217                     let self_module = match i {
2218                         0 => Some(self.resolve_self(&mut ctxt, parent_scope.module)),
2219                         _ => match module {
2220                             Some(ModuleOrUniformRoot::Module(module)) => Some(module),
2221                             _ => None,
2222                         },
2223                     };
2224                     if let Some(self_module) = self_module {
2225                         if let Some(parent) = self_module.parent {
2226                             module = Some(ModuleOrUniformRoot::Module(
2227                                 self.resolve_self(&mut ctxt, parent),
2228                             ));
2229                             continue;
2230                         }
2231                     }
2232                     let msg = "there are too many leading `super` keywords".to_string();
2233                     return PathResult::Failed {
2234                         span: ident.span,
2235                         label: msg,
2236                         suggestion: None,
2237                         is_error_from_last_segment: false,
2238                     };
2239                 }
2240                 if i == 0 {
2241                     if name == kw::SelfLower {
2242                         let mut ctxt = ident.span.ctxt().normalize_to_macros_2_0();
2243                         module = Some(ModuleOrUniformRoot::Module(
2244                             self.resolve_self(&mut ctxt, parent_scope.module),
2245                         ));
2246                         continue;
2247                     }
2248                     if name == kw::PathRoot && ident.span.rust_2018() {
2249                         module = Some(ModuleOrUniformRoot::ExternPrelude);
2250                         continue;
2251                     }
2252                     if name == kw::PathRoot && ident.span.rust_2015() && self.session.rust_2018() {
2253                         // `::a::b` from 2015 macro on 2018 global edition
2254                         module = Some(ModuleOrUniformRoot::CrateRootAndExternPrelude);
2255                         continue;
2256                     }
2257                     if name == kw::PathRoot || name == kw::Crate || name == kw::DollarCrate {
2258                         // `::a::b`, `crate::a::b` or `$crate::a::b`
2259                         module = Some(ModuleOrUniformRoot::Module(self.resolve_crate_root(ident)));
2260                         continue;
2261                     }
2262                 }
2263             }
2264
2265             // Report special messages for path segment keywords in wrong positions.
2266             if ident.is_path_segment_keyword() && i != 0 {
2267                 let name_str = if name == kw::PathRoot {
2268                     "crate root".to_string()
2269                 } else {
2270                     format!("`{}`", name)
2271                 };
2272                 let label = if i == 1 && path[0].ident.name == kw::PathRoot {
2273                     format!("global paths cannot start with {}", name_str)
2274                 } else {
2275                     format!("{} in paths can only be used in start position", name_str)
2276                 };
2277                 return PathResult::Failed {
2278                     span: ident.span,
2279                     label,
2280                     suggestion: None,
2281                     is_error_from_last_segment: false,
2282                 };
2283             }
2284
2285             enum FindBindingResult<'a> {
2286                 Binding(Result<&'a NameBinding<'a>, Determinacy>),
2287                 PathResult(PathResult<'a>),
2288             }
2289             let find_binding_in_ns = |this: &mut Self, ns| {
2290                 let binding = if let Some(module) = module {
2291                     this.resolve_ident_in_module(
2292                         module,
2293                         ident,
2294                         ns,
2295                         parent_scope,
2296                         record_used,
2297                         path_span,
2298                     )
2299                 } else if ribs.is_none() || opt_ns.is_none() || opt_ns == Some(MacroNS) {
2300                     let scopes = ScopeSet::All(ns, opt_ns.is_none());
2301                     this.early_resolve_ident_in_lexical_scope(
2302                         ident,
2303                         scopes,
2304                         parent_scope,
2305                         record_used,
2306                         record_used,
2307                         path_span,
2308                     )
2309                 } else {
2310                     let record_used_id = if record_used {
2311                         crate_lint.node_id().or(Some(CRATE_NODE_ID))
2312                     } else {
2313                         None
2314                     };
2315                     match this.resolve_ident_in_lexical_scope(
2316                         ident,
2317                         ns,
2318                         parent_scope,
2319                         record_used_id,
2320                         path_span,
2321                         &ribs.unwrap()[ns],
2322                     ) {
2323                         // we found a locally-imported or available item/module
2324                         Some(LexicalScopeBinding::Item(binding)) => Ok(binding),
2325                         // we found a local variable or type param
2326                         Some(LexicalScopeBinding::Res(res))
2327                             if opt_ns == Some(TypeNS) || opt_ns == Some(ValueNS) =>
2328                         {
2329                             record_segment_res(this, res);
2330                             return FindBindingResult::PathResult(PathResult::NonModule(
2331                                 PartialRes::with_unresolved_segments(res, path.len() - 1),
2332                             ));
2333                         }
2334                         _ => Err(Determinacy::determined(record_used)),
2335                     }
2336                 };
2337                 FindBindingResult::Binding(binding)
2338             };
2339             let binding = match find_binding_in_ns(self, ns) {
2340                 FindBindingResult::PathResult(x) => return x,
2341                 FindBindingResult::Binding(binding) => binding,
2342             };
2343             match binding {
2344                 Ok(binding) => {
2345                     if i == 1 {
2346                         second_binding = Some(binding);
2347                     }
2348                     let res = binding.res();
2349                     let maybe_assoc = opt_ns != Some(MacroNS) && PathSource::Type.is_expected(res);
2350                     if let Some(next_module) = binding.module() {
2351                         module = Some(ModuleOrUniformRoot::Module(next_module));
2352                         record_segment_res(self, res);
2353                     } else if res == Res::ToolMod && i + 1 != path.len() {
2354                         if binding.is_import() {
2355                             self.session
2356                                 .struct_span_err(
2357                                     ident.span,
2358                                     "cannot use a tool module through an import",
2359                                 )
2360                                 .span_note(binding.span, "the tool module imported here")
2361                                 .emit();
2362                         }
2363                         let res = Res::NonMacroAttr(NonMacroAttrKind::Tool);
2364                         return PathResult::NonModule(PartialRes::new(res));
2365                     } else if res == Res::Err {
2366                         return PathResult::NonModule(PartialRes::new(Res::Err));
2367                     } else if opt_ns.is_some() && (is_last || maybe_assoc) {
2368                         self.lint_if_path_starts_with_module(
2369                             crate_lint,
2370                             path,
2371                             path_span,
2372                             second_binding,
2373                         );
2374                         return PathResult::NonModule(PartialRes::with_unresolved_segments(
2375                             res,
2376                             path.len() - i - 1,
2377                         ));
2378                     } else {
2379                         let label = format!(
2380                             "`{}` is {} {}, not a module",
2381                             ident,
2382                             res.article(),
2383                             res.descr(),
2384                         );
2385
2386                         return PathResult::Failed {
2387                             span: ident.span,
2388                             label,
2389                             suggestion: None,
2390                             is_error_from_last_segment: is_last,
2391                         };
2392                     }
2393                 }
2394                 Err(Undetermined) => return PathResult::Indeterminate,
2395                 Err(Determined) => {
2396                     if let Some(ModuleOrUniformRoot::Module(module)) = module {
2397                         if opt_ns.is_some() && !module.is_normal() {
2398                             return PathResult::NonModule(PartialRes::with_unresolved_segments(
2399                                 module.res().unwrap(),
2400                                 path.len() - i,
2401                             ));
2402                         }
2403                     }
2404                     let module_res = match module {
2405                         Some(ModuleOrUniformRoot::Module(module)) => module.res(),
2406                         _ => None,
2407                     };
2408                     let (label, suggestion) = if module_res == self.graph_root.res() {
2409                         let is_mod = |res| matches!(res, Res::Def(DefKind::Mod, _));
2410                         // Don't look up import candidates if this is a speculative resolve
2411                         let mut candidates = if record_used {
2412                             self.lookup_import_candidates(ident, TypeNS, parent_scope, is_mod)
2413                         } else {
2414                             Vec::new()
2415                         };
2416                         candidates.sort_by_cached_key(|c| {
2417                             (c.path.segments.len(), pprust::path_to_string(&c.path))
2418                         });
2419                         if let Some(candidate) = candidates.get(0) {
2420                             (
2421                                 String::from("unresolved import"),
2422                                 Some((
2423                                     vec![(ident.span, pprust::path_to_string(&candidate.path))],
2424                                     String::from("a similar path exists"),
2425                                     Applicability::MaybeIncorrect,
2426                                 )),
2427                             )
2428                         } else {
2429                             (format!("maybe a missing crate `{}`?", ident), None)
2430                         }
2431                     } else if i == 0 {
2432                         if ident
2433                             .name
2434                             .as_str()
2435                             .chars()
2436                             .next()
2437                             .map_or(false, |c| c.is_ascii_uppercase())
2438                         {
2439                             (format!("use of undeclared type `{}`", ident), None)
2440                         } else {
2441                             (format!("use of undeclared crate or module `{}`", ident), None)
2442                         }
2443                     } else {
2444                         let mut msg =
2445                             format!("could not find `{}` in `{}`", ident, path[i - 1].ident);
2446                         if ns == TypeNS || ns == ValueNS {
2447                             let ns_to_try = if ns == TypeNS { ValueNS } else { TypeNS };
2448                             if let FindBindingResult::Binding(Ok(binding)) =
2449                                 find_binding_in_ns(self, ns_to_try)
2450                             {
2451                                 let mut found = |what| {
2452                                     msg = format!(
2453                                         "expected {}, found {} `{}` in `{}`",
2454                                         ns.descr(),
2455                                         what,
2456                                         ident,
2457                                         path[i - 1].ident
2458                                     )
2459                                 };
2460                                 if binding.module().is_some() {
2461                                     found("module")
2462                                 } else {
2463                                     match binding.res() {
2464                                         def::Res::<NodeId>::Def(kind, id) => found(kind.descr(id)),
2465                                         _ => found(ns_to_try.descr()),
2466                                     }
2467                                 }
2468                             };
2469                         }
2470                         (msg, None)
2471                     };
2472                     return PathResult::Failed {
2473                         span: ident.span,
2474                         label,
2475                         suggestion,
2476                         is_error_from_last_segment: is_last,
2477                     };
2478                 }
2479             }
2480         }
2481
2482         self.lint_if_path_starts_with_module(crate_lint, path, path_span, second_binding);
2483
2484         PathResult::Module(match module {
2485             Some(module) => module,
2486             None if path.is_empty() => ModuleOrUniformRoot::CurrentScope,
2487             _ => span_bug!(path_span, "resolve_path: non-empty path `{:?}` has no module", path),
2488         })
2489     }
2490
2491     fn lint_if_path_starts_with_module(
2492         &mut self,
2493         crate_lint: CrateLint,
2494         path: &[Segment],
2495         path_span: Span,
2496         second_binding: Option<&NameBinding<'_>>,
2497     ) {
2498         let (diag_id, diag_span) = match crate_lint {
2499             CrateLint::No => return,
2500             CrateLint::SimplePath(id) => (id, path_span),
2501             CrateLint::UsePath { root_id, root_span } => (root_id, root_span),
2502             CrateLint::QPathTrait { qpath_id, qpath_span } => (qpath_id, qpath_span),
2503         };
2504
2505         let first_name = match path.get(0) {
2506             // In the 2018 edition this lint is a hard error, so nothing to do
2507             Some(seg) if seg.ident.span.rust_2015() && self.session.rust_2015() => seg.ident.name,
2508             _ => return,
2509         };
2510
2511         // We're only interested in `use` paths which should start with
2512         // `{{root}}` currently.
2513         if first_name != kw::PathRoot {
2514             return;
2515         }
2516
2517         match path.get(1) {
2518             // If this import looks like `crate::...` it's already good
2519             Some(Segment { ident, .. }) if ident.name == kw::Crate => return,
2520             // Otherwise go below to see if it's an extern crate
2521             Some(_) => {}
2522             // If the path has length one (and it's `PathRoot` most likely)
2523             // then we don't know whether we're gonna be importing a crate or an
2524             // item in our crate. Defer this lint to elsewhere
2525             None => return,
2526         }
2527
2528         // If the first element of our path was actually resolved to an
2529         // `ExternCrate` (also used for `crate::...`) then no need to issue a
2530         // warning, this looks all good!
2531         if let Some(binding) = second_binding {
2532             if let NameBindingKind::Import { import, .. } = binding.kind {
2533                 // Careful: we still want to rewrite paths from renamed extern crates.
2534                 if let ImportKind::ExternCrate { source: None, .. } = import.kind {
2535                     return;
2536                 }
2537             }
2538         }
2539
2540         let diag = BuiltinLintDiagnostics::AbsPathWithModule(diag_span);
2541         self.lint_buffer.buffer_lint_with_diagnostic(
2542             lint::builtin::ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE,
2543             diag_id,
2544             diag_span,
2545             "absolute paths must start with `self`, `super`, \
2546              `crate`, or an external crate name in the 2018 edition",
2547             diag,
2548         );
2549     }
2550
2551     // Validate a local resolution (from ribs).
2552     fn validate_res_from_ribs(
2553         &mut self,
2554         rib_index: usize,
2555         rib_ident: Ident,
2556         mut res: Res,
2557         record_used: bool,
2558         span: Span,
2559         all_ribs: &[Rib<'a>],
2560     ) -> Res {
2561         const CG_BUG_STR: &str = "min_const_generics resolve check didn't stop compilation";
2562         debug!("validate_res_from_ribs({:?})", res);
2563         let ribs = &all_ribs[rib_index + 1..];
2564
2565         // An invalid forward use of a type parameter from a previous default.
2566         if let ForwardTyParamBanRibKind = all_ribs[rib_index].kind {
2567             if record_used {
2568                 let res_error = if rib_ident.name == kw::SelfUpper {
2569                     ResolutionError::SelfInTyParamDefault
2570                 } else {
2571                     ResolutionError::ForwardDeclaredTyParam
2572                 };
2573                 self.report_error(span, res_error);
2574             }
2575             assert_eq!(res, Res::Err);
2576             return Res::Err;
2577         }
2578
2579         match res {
2580             Res::Local(_) => {
2581                 use ResolutionError::*;
2582                 let mut res_err = None;
2583
2584                 for rib in ribs {
2585                     match rib.kind {
2586                         NormalRibKind
2587                         | ClosureOrAsyncRibKind
2588                         | ModuleRibKind(..)
2589                         | MacroDefinition(..)
2590                         | ForwardTyParamBanRibKind => {
2591                             // Nothing to do. Continue.
2592                         }
2593                         ItemRibKind(_) | FnItemRibKind | AssocItemRibKind => {
2594                             // This was an attempt to access an upvar inside a
2595                             // named function item. This is not allowed, so we
2596                             // report an error.
2597                             if record_used {
2598                                 // We don't immediately trigger a resolve error, because
2599                                 // we want certain other resolution errors (namely those
2600                                 // emitted for `ConstantItemRibKind` below) to take
2601                                 // precedence.
2602                                 res_err = Some(CannotCaptureDynamicEnvironmentInFnItem);
2603                             }
2604                         }
2605                         ConstantItemRibKind(_) => {
2606                             // Still doesn't deal with upvars
2607                             if record_used {
2608                                 self.report_error(span, AttemptToUseNonConstantValueInConstant);
2609                             }
2610                             return Res::Err;
2611                         }
2612                         ConstParamTyRibKind => {
2613                             if record_used {
2614                                 self.report_error(span, ParamInTyOfConstParam(rib_ident.name));
2615                             }
2616                             return Res::Err;
2617                         }
2618                     }
2619                 }
2620                 if let Some(res_err) = res_err {
2621                     self.report_error(span, res_err);
2622                     return Res::Err;
2623                 }
2624             }
2625             Res::Def(DefKind::TyParam, _) | Res::SelfTy(..) => {
2626                 let mut in_ty_param_default = false;
2627                 for rib in ribs {
2628                     let has_generic_params = match rib.kind {
2629                         NormalRibKind
2630                         | ClosureOrAsyncRibKind
2631                         | AssocItemRibKind
2632                         | ModuleRibKind(..)
2633                         | MacroDefinition(..) => {
2634                             // Nothing to do. Continue.
2635                             continue;
2636                         }
2637
2638                         // We only forbid constant items if we are inside of type defaults,
2639                         // for example `struct Foo<T, U = [u8; std::mem::size_of::<T>()]>`
2640                         ForwardTyParamBanRibKind => {
2641                             in_ty_param_default = true;
2642                             continue;
2643                         }
2644                         ConstantItemRibKind(trivial) => {
2645                             let features = self.session.features_untracked();
2646                             // HACK(min_const_generics): We currently only allow `N` or `{ N }`.
2647                             if !(trivial
2648                                 || features.const_generics
2649                                 || features.lazy_normalization_consts)
2650                             {
2651                                 // HACK(min_const_generics): If we encounter `Self` in an anonymous constant
2652                                 // we can't easily tell if it's generic at this stage, so we instead remember
2653                                 // this and then enforce the self type to be concrete later on.
2654                                 if let Res::SelfTy(trait_def, Some((impl_def, _))) = res {
2655                                     res = Res::SelfTy(trait_def, Some((impl_def, true)));
2656                                 } else {
2657                                     if record_used {
2658                                         self.report_error(
2659                                             span,
2660                                             ResolutionError::ParamInNonTrivialAnonConst {
2661                                                 name: rib_ident.name,
2662                                                 is_type: true,
2663                                             },
2664                                         );
2665                                     }
2666
2667                                     self.session.delay_span_bug(span, CG_BUG_STR);
2668                                     return Res::Err;
2669                                 }
2670                             }
2671
2672                             if in_ty_param_default {
2673                                 if record_used {
2674                                     self.report_error(
2675                                         span,
2676                                         ResolutionError::ParamInAnonConstInTyDefault(
2677                                             rib_ident.name,
2678                                         ),
2679                                     );
2680                                 }
2681                                 return Res::Err;
2682                             } else {
2683                                 continue;
2684                             }
2685                         }
2686
2687                         // This was an attempt to use a type parameter outside its scope.
2688                         ItemRibKind(has_generic_params) => has_generic_params,
2689                         FnItemRibKind => HasGenericParams::Yes,
2690                         ConstParamTyRibKind => {
2691                             if record_used {
2692                                 self.report_error(
2693                                     span,
2694                                     ResolutionError::ParamInTyOfConstParam(rib_ident.name),
2695                                 );
2696                             }
2697                             return Res::Err;
2698                         }
2699                     };
2700
2701                     if record_used {
2702                         self.report_error(
2703                             span,
2704                             ResolutionError::GenericParamsFromOuterFunction(
2705                                 res,
2706                                 has_generic_params,
2707                             ),
2708                         );
2709                     }
2710                     return Res::Err;
2711                 }
2712             }
2713             Res::Def(DefKind::ConstParam, _) => {
2714                 let mut ribs = ribs.iter().peekable();
2715                 if let Some(Rib { kind: FnItemRibKind, .. }) = ribs.peek() {
2716                     // When declaring const parameters inside function signatures, the first rib
2717                     // is always a `FnItemRibKind`. In this case, we can skip it, to avoid it
2718                     // (spuriously) conflicting with the const param.
2719                     ribs.next();
2720                 }
2721
2722                 let mut in_ty_param_default = false;
2723                 for rib in ribs {
2724                     let has_generic_params = match rib.kind {
2725                         NormalRibKind
2726                         | ClosureOrAsyncRibKind
2727                         | AssocItemRibKind
2728                         | ModuleRibKind(..)
2729                         | MacroDefinition(..) => continue,
2730
2731                         // We only forbid constant items if we are inside of type defaults,
2732                         // for example `struct Foo<T, U = [u8; std::mem::size_of::<T>()]>`
2733                         ForwardTyParamBanRibKind => {
2734                             in_ty_param_default = true;
2735                             continue;
2736                         }
2737                         ConstantItemRibKind(trivial) => {
2738                             let features = self.session.features_untracked();
2739                             // HACK(min_const_generics): We currently only allow `N` or `{ N }`.
2740                             if !(trivial
2741                                 || features.const_generics
2742                                 || features.lazy_normalization_consts)
2743                             {
2744                                 if record_used {
2745                                     self.report_error(
2746                                         span,
2747                                         ResolutionError::ParamInNonTrivialAnonConst {
2748                                             name: rib_ident.name,
2749                                             is_type: false,
2750                                         },
2751                                     );
2752                                 }
2753
2754                                 self.session.delay_span_bug(span, CG_BUG_STR);
2755                                 return Res::Err;
2756                             }
2757
2758                             if in_ty_param_default {
2759                                 if record_used {
2760                                     self.report_error(
2761                                         span,
2762                                         ResolutionError::ParamInAnonConstInTyDefault(
2763                                             rib_ident.name,
2764                                         ),
2765                                     );
2766                                 }
2767                                 return Res::Err;
2768                             } else {
2769                                 continue;
2770                             }
2771                         }
2772
2773                         ItemRibKind(has_generic_params) => has_generic_params,
2774                         FnItemRibKind => HasGenericParams::Yes,
2775                         ConstParamTyRibKind => {
2776                             if record_used {
2777                                 self.report_error(
2778                                     span,
2779                                     ResolutionError::ParamInTyOfConstParam(rib_ident.name),
2780                                 );
2781                             }
2782                             return Res::Err;
2783                         }
2784                     };
2785
2786                     // This was an attempt to use a const parameter outside its scope.
2787                     if record_used {
2788                         self.report_error(
2789                             span,
2790                             ResolutionError::GenericParamsFromOuterFunction(
2791                                 res,
2792                                 has_generic_params,
2793                             ),
2794                         );
2795                     }
2796                     return Res::Err;
2797                 }
2798             }
2799             _ => {}
2800         }
2801         res
2802     }
2803
2804     fn record_partial_res(&mut self, node_id: NodeId, resolution: PartialRes) {
2805         debug!("(recording res) recording {:?} for {}", resolution, node_id);
2806         if let Some(prev_res) = self.partial_res_map.insert(node_id, resolution) {
2807             panic!("path resolved multiple times ({:?} before, {:?} now)", prev_res, resolution);
2808         }
2809     }
2810
2811     fn is_accessible_from(&self, vis: ty::Visibility, module: Module<'a>) -> bool {
2812         vis.is_accessible_from(module.nearest_parent_mod, self)
2813     }
2814
2815     fn set_binding_parent_module(&mut self, binding: &'a NameBinding<'a>, module: Module<'a>) {
2816         if let Some(old_module) = self.binding_parent_modules.insert(PtrKey(binding), module) {
2817             if !ptr::eq(module, old_module) {
2818                 span_bug!(binding.span, "parent module is reset for binding");
2819             }
2820         }
2821     }
2822
2823     fn disambiguate_macro_rules_vs_modularized(
2824         &self,
2825         macro_rules: &'a NameBinding<'a>,
2826         modularized: &'a NameBinding<'a>,
2827     ) -> bool {
2828         // Some non-controversial subset of ambiguities "modularized macro name" vs "macro_rules"
2829         // is disambiguated to mitigate regressions from macro modularization.
2830         // Scoping for `macro_rules` behaves like scoping for `let` at module level, in general.
2831         match (
2832             self.binding_parent_modules.get(&PtrKey(macro_rules)),
2833             self.binding_parent_modules.get(&PtrKey(modularized)),
2834         ) {
2835             (Some(macro_rules), Some(modularized)) => {
2836                 macro_rules.nearest_parent_mod == modularized.nearest_parent_mod
2837                     && modularized.is_ancestor_of(macro_rules)
2838             }
2839             _ => false,
2840         }
2841     }
2842
2843     fn report_errors(&mut self, krate: &Crate) {
2844         self.report_with_use_injections(krate);
2845
2846         for &(span_use, span_def) in &self.macro_expanded_macro_export_errors {
2847             let msg = "macro-expanded `macro_export` macros from the current crate \
2848                        cannot be referred to by absolute paths";
2849             self.lint_buffer.buffer_lint_with_diagnostic(
2850                 lint::builtin::MACRO_EXPANDED_MACRO_EXPORTS_ACCESSED_BY_ABSOLUTE_PATHS,
2851                 CRATE_NODE_ID,
2852                 span_use,
2853                 msg,
2854                 BuiltinLintDiagnostics::MacroExpandedMacroExportsAccessedByAbsolutePaths(span_def),
2855             );
2856         }
2857
2858         for ambiguity_error in &self.ambiguity_errors {
2859             self.report_ambiguity_error(ambiguity_error);
2860         }
2861
2862         let mut reported_spans = FxHashSet::default();
2863         for error in &self.privacy_errors {
2864             if reported_spans.insert(error.dedup_span) {
2865                 self.report_privacy_error(error);
2866             }
2867         }
2868     }
2869
2870     fn report_with_use_injections(&mut self, krate: &Crate) {
2871         for UseError { mut err, candidates, def_id, instead, suggestion } in
2872             self.use_injections.drain(..)
2873         {
2874             let (span, found_use) = if let Some(def_id) = def_id.as_local() {
2875                 UsePlacementFinder::check(krate, self.def_id_to_node_id[def_id])
2876             } else {
2877                 (None, false)
2878             };
2879             if !candidates.is_empty() {
2880                 diagnostics::show_candidates(&mut err, span, &candidates, instead, found_use);
2881             } else if let Some((span, msg, sugg, appl)) = suggestion {
2882                 err.span_suggestion(span, msg, sugg, appl);
2883             }
2884             err.emit();
2885         }
2886     }
2887
2888     fn report_conflict<'b>(
2889         &mut self,
2890         parent: Module<'_>,
2891         ident: Ident,
2892         ns: Namespace,
2893         new_binding: &NameBinding<'b>,
2894         old_binding: &NameBinding<'b>,
2895     ) {
2896         // Error on the second of two conflicting names
2897         if old_binding.span.lo() > new_binding.span.lo() {
2898             return self.report_conflict(parent, ident, ns, old_binding, new_binding);
2899         }
2900
2901         let container = match parent.kind {
2902             ModuleKind::Def(kind, _, _) => kind.descr(parent.def_id().unwrap()),
2903             ModuleKind::Block(..) => "block",
2904         };
2905
2906         let old_noun = match old_binding.is_import() {
2907             true => "import",
2908             false => "definition",
2909         };
2910
2911         let new_participle = match new_binding.is_import() {
2912             true => "imported",
2913             false => "defined",
2914         };
2915
2916         let (name, span) =
2917             (ident.name, self.session.source_map().guess_head_span(new_binding.span));
2918
2919         if let Some(s) = self.name_already_seen.get(&name) {
2920             if s == &span {
2921                 return;
2922             }
2923         }
2924
2925         let old_kind = match (ns, old_binding.module()) {
2926             (ValueNS, _) => "value",
2927             (MacroNS, _) => "macro",
2928             (TypeNS, _) if old_binding.is_extern_crate() => "extern crate",
2929             (TypeNS, Some(module)) if module.is_normal() => "module",
2930             (TypeNS, Some(module)) if module.is_trait() => "trait",
2931             (TypeNS, _) => "type",
2932         };
2933
2934         let msg = format!("the name `{}` is defined multiple times", name);
2935
2936         let mut err = match (old_binding.is_extern_crate(), new_binding.is_extern_crate()) {
2937             (true, true) => struct_span_err!(self.session, span, E0259, "{}", msg),
2938             (true, _) | (_, true) => match new_binding.is_import() && old_binding.is_import() {
2939                 true => struct_span_err!(self.session, span, E0254, "{}", msg),
2940                 false => struct_span_err!(self.session, span, E0260, "{}", msg),
2941             },
2942             _ => match (old_binding.is_import(), new_binding.is_import()) {
2943                 (false, false) => struct_span_err!(self.session, span, E0428, "{}", msg),
2944                 (true, true) => struct_span_err!(self.session, span, E0252, "{}", msg),
2945                 _ => struct_span_err!(self.session, span, E0255, "{}", msg),
2946             },
2947         };
2948
2949         err.note(&format!(
2950             "`{}` must be defined only once in the {} namespace of this {}",
2951             name,
2952             ns.descr(),
2953             container
2954         ));
2955
2956         err.span_label(span, format!("`{}` re{} here", name, new_participle));
2957         err.span_label(
2958             self.session.source_map().guess_head_span(old_binding.span),
2959             format!("previous {} of the {} `{}` here", old_noun, old_kind, name),
2960         );
2961
2962         // See https://github.com/rust-lang/rust/issues/32354
2963         use NameBindingKind::Import;
2964         let import = match (&new_binding.kind, &old_binding.kind) {
2965             // If there are two imports where one or both have attributes then prefer removing the
2966             // import without attributes.
2967             (Import { import: new, .. }, Import { import: old, .. })
2968                 if {
2969                     !new_binding.span.is_dummy()
2970                         && !old_binding.span.is_dummy()
2971                         && (new.has_attributes || old.has_attributes)
2972                 } =>
2973             {
2974                 if old.has_attributes {
2975                     Some((new, new_binding.span, true))
2976                 } else {
2977                     Some((old, old_binding.span, true))
2978                 }
2979             }
2980             // Otherwise prioritize the new binding.
2981             (Import { import, .. }, other) if !new_binding.span.is_dummy() => {
2982                 Some((import, new_binding.span, other.is_import()))
2983             }
2984             (other, Import { import, .. }) if !old_binding.span.is_dummy() => {
2985                 Some((import, old_binding.span, other.is_import()))
2986             }
2987             _ => None,
2988         };
2989
2990         // Check if the target of the use for both bindings is the same.
2991         let duplicate = new_binding.res().opt_def_id() == old_binding.res().opt_def_id();
2992         let has_dummy_span = new_binding.span.is_dummy() || old_binding.span.is_dummy();
2993         let from_item =
2994             self.extern_prelude.get(&ident).map(|entry| entry.introduced_by_item).unwrap_or(true);
2995         // Only suggest removing an import if both bindings are to the same def, if both spans
2996         // aren't dummy spans. Further, if both bindings are imports, then the ident must have
2997         // been introduced by a item.
2998         let should_remove_import = duplicate
2999             && !has_dummy_span
3000             && ((new_binding.is_extern_crate() || old_binding.is_extern_crate()) || from_item);
3001
3002         match import {
3003             Some((import, span, true)) if should_remove_import && import.is_nested() => {
3004                 self.add_suggestion_for_duplicate_nested_use(&mut err, import, span)
3005             }
3006             Some((import, _, true)) if should_remove_import && !import.is_glob() => {
3007                 // Simple case - remove the entire import. Due to the above match arm, this can
3008                 // only be a single use so just remove it entirely.
3009                 err.tool_only_span_suggestion(
3010                     import.use_span_with_attributes,
3011                     "remove unnecessary import",
3012                     String::new(),
3013                     Applicability::MaybeIncorrect,
3014                 );
3015             }
3016             Some((import, span, _)) => {
3017                 self.add_suggestion_for_rename_of_use(&mut err, name, import, span)
3018             }
3019             _ => {}
3020         }
3021
3022         err.emit();
3023         self.name_already_seen.insert(name, span);
3024     }
3025
3026     /// This function adds a suggestion to change the binding name of a new import that conflicts
3027     /// with an existing import.
3028     ///
3029     /// ```text,ignore (diagnostic)
3030     /// help: you can use `as` to change the binding name of the import
3031     ///    |
3032     /// LL | use foo::bar as other_bar;
3033     ///    |     ^^^^^^^^^^^^^^^^^^^^^
3034     /// ```
3035     fn add_suggestion_for_rename_of_use(
3036         &self,
3037         err: &mut DiagnosticBuilder<'_>,
3038         name: Symbol,
3039         import: &Import<'_>,
3040         binding_span: Span,
3041     ) {
3042         let suggested_name = if name.as_str().chars().next().unwrap().is_uppercase() {
3043             format!("Other{}", name)
3044         } else {
3045             format!("other_{}", name)
3046         };
3047
3048         let mut suggestion = None;
3049         match import.kind {
3050             ImportKind::Single { type_ns_only: true, .. } => {
3051                 suggestion = Some(format!("self as {}", suggested_name))
3052             }
3053             ImportKind::Single { source, .. } => {
3054                 if let Some(pos) =
3055                     source.span.hi().0.checked_sub(binding_span.lo().0).map(|pos| pos as usize)
3056                 {
3057                     if let Ok(snippet) = self.session.source_map().span_to_snippet(binding_span) {
3058                         if pos <= snippet.len() {
3059                             suggestion = Some(format!(
3060                                 "{} as {}{}",
3061                                 &snippet[..pos],
3062                                 suggested_name,
3063                                 if snippet.ends_with(';') { ";" } else { "" }
3064                             ))
3065                         }
3066                     }
3067                 }
3068             }
3069             ImportKind::ExternCrate { source, target, .. } => {
3070                 suggestion = Some(format!(
3071                     "extern crate {} as {};",
3072                     source.unwrap_or(target.name),
3073                     suggested_name,
3074                 ))
3075             }
3076             _ => unreachable!(),
3077         }
3078
3079         let rename_msg = "you can use `as` to change the binding name of the import";
3080         if let Some(suggestion) = suggestion {
3081             err.span_suggestion(
3082                 binding_span,
3083                 rename_msg,
3084                 suggestion,
3085                 Applicability::MaybeIncorrect,
3086             );
3087         } else {
3088             err.span_label(binding_span, rename_msg);
3089         }
3090     }
3091
3092     /// This function adds a suggestion to remove a unnecessary binding from an import that is
3093     /// nested. In the following example, this function will be invoked to remove the `a` binding
3094     /// in the second use statement:
3095     ///
3096     /// ```ignore (diagnostic)
3097     /// use issue_52891::a;
3098     /// use issue_52891::{d, a, e};
3099     /// ```
3100     ///
3101     /// The following suggestion will be added:
3102     ///
3103     /// ```ignore (diagnostic)
3104     /// use issue_52891::{d, a, e};
3105     ///                      ^-- help: remove unnecessary import
3106     /// ```
3107     ///
3108     /// If the nested use contains only one import then the suggestion will remove the entire
3109     /// line.
3110     ///
3111     /// It is expected that the provided import is nested - this isn't checked by the
3112     /// function. If this invariant is not upheld, this function's behaviour will be unexpected
3113     /// as characters expected by span manipulations won't be present.
3114     fn add_suggestion_for_duplicate_nested_use(
3115         &self,
3116         err: &mut DiagnosticBuilder<'_>,
3117         import: &Import<'_>,
3118         binding_span: Span,
3119     ) {
3120         assert!(import.is_nested());
3121         let message = "remove unnecessary import";
3122
3123         // Two examples will be used to illustrate the span manipulations we're doing:
3124         //
3125         // - Given `use issue_52891::{d, a, e};` where `a` is a duplicate then `binding_span` is
3126         //   `a` and `import.use_span` is `issue_52891::{d, a, e};`.
3127         // - Given `use issue_52891::{d, e, a};` where `a` is a duplicate then `binding_span` is
3128         //   `a` and `import.use_span` is `issue_52891::{d, e, a};`.
3129
3130         let (found_closing_brace, span) =
3131             find_span_of_binding_until_next_binding(self.session, binding_span, import.use_span);
3132
3133         // If there was a closing brace then identify the span to remove any trailing commas from
3134         // previous imports.
3135         if found_closing_brace {
3136             if let Some(span) = extend_span_to_previous_binding(self.session, span) {
3137                 err.tool_only_span_suggestion(
3138                     span,
3139                     message,
3140                     String::new(),
3141                     Applicability::MaybeIncorrect,
3142                 );
3143             } else {
3144                 // Remove the entire line if we cannot extend the span back, this indicates a
3145                 // `issue_52891::{self}` case.
3146                 err.span_suggestion(
3147                     import.use_span_with_attributes,
3148                     message,
3149                     String::new(),
3150                     Applicability::MaybeIncorrect,
3151                 );
3152             }
3153
3154             return;
3155         }
3156
3157         err.span_suggestion(span, message, String::new(), Applicability::MachineApplicable);
3158     }
3159
3160     fn extern_prelude_get(
3161         &mut self,
3162         ident: Ident,
3163         speculative: bool,
3164     ) -> Option<&'a NameBinding<'a>> {
3165         if ident.is_path_segment_keyword() {
3166             // Make sure `self`, `super` etc produce an error when passed to here.
3167             return None;
3168         }
3169         self.extern_prelude.get(&ident.normalize_to_macros_2_0()).cloned().and_then(|entry| {
3170             if let Some(binding) = entry.extern_crate_item {
3171                 if !speculative && entry.introduced_by_item {
3172                     self.record_use(ident, TypeNS, binding, false);
3173                 }
3174                 Some(binding)
3175             } else {
3176                 let crate_id = if !speculative {
3177                     self.crate_loader.process_path_extern(ident.name, ident.span)
3178                 } else {
3179                     self.crate_loader.maybe_process_path_extern(ident.name)?
3180                 };
3181                 let crate_root = self.get_module(DefId { krate: crate_id, index: CRATE_DEF_INDEX });
3182                 Some(
3183                     (crate_root, ty::Visibility::Public, DUMMY_SP, ExpnId::root())
3184                         .to_name_binding(self.arenas),
3185                 )
3186             }
3187         })
3188     }
3189
3190     /// This is equivalent to `get_traits_in_module_containing_item`, but without filtering by the associated item.
3191     ///
3192     /// This is used by rustdoc for intra-doc links.
3193     pub fn traits_in_scope(&mut self, module_id: DefId) -> Vec<TraitCandidate> {
3194         let module = self.get_module(module_id);
3195         module.ensure_traits(self);
3196         let traits = module.traits.borrow();
3197         let to_candidate =
3198             |this: &mut Self, &(trait_name, binding): &(Ident, &NameBinding<'_>)| TraitCandidate {
3199                 def_id: binding.res().def_id(),
3200                 import_ids: this.find_transitive_imports(&binding.kind, trait_name),
3201             };
3202
3203         let mut candidates: Vec<_> =
3204             traits.as_ref().unwrap().iter().map(|x| to_candidate(self, x)).collect();
3205
3206         if let Some(prelude) = self.prelude {
3207             if !module.no_implicit_prelude {
3208                 prelude.ensure_traits(self);
3209                 candidates.extend(
3210                     prelude.traits.borrow().as_ref().unwrap().iter().map(|x| to_candidate(self, x)),
3211                 );
3212             }
3213         }
3214
3215         candidates
3216     }
3217
3218     /// Rustdoc uses this to resolve things in a recoverable way. `ResolutionError<'a>`
3219     /// isn't something that can be returned because it can't be made to live that long,
3220     /// and also it's a private type. Fortunately rustdoc doesn't need to know the error,
3221     /// just that an error occurred.
3222     // FIXME(Manishearth): intra-doc links won't get warned of epoch changes.
3223     pub fn resolve_str_path_error(
3224         &mut self,
3225         span: Span,
3226         path_str: &str,
3227         ns: Namespace,
3228         module_id: DefId,
3229     ) -> Result<(ast::Path, Res), ()> {
3230         let path = if path_str.starts_with("::") {
3231             ast::Path {
3232                 span,
3233                 segments: iter::once(Ident::with_dummy_span(kw::PathRoot))
3234                     .chain(path_str.split("::").skip(1).map(Ident::from_str))
3235                     .map(|i| self.new_ast_path_segment(i))
3236                     .collect(),
3237                 tokens: None,
3238             }
3239         } else {
3240             ast::Path {
3241                 span,
3242                 segments: path_str
3243                     .split("::")
3244                     .map(Ident::from_str)
3245                     .map(|i| self.new_ast_path_segment(i))
3246                     .collect(),
3247                 tokens: None,
3248             }
3249         };
3250         let module = self.get_module(module_id);
3251         let parent_scope = &ParentScope::module(module, self);
3252         let res = self.resolve_ast_path(&path, ns, parent_scope).map_err(|_| ())?;
3253         Ok((path, res))
3254     }
3255
3256     // Resolve a path passed from rustdoc or HIR lowering.
3257     fn resolve_ast_path(
3258         &mut self,
3259         path: &ast::Path,
3260         ns: Namespace,
3261         parent_scope: &ParentScope<'a>,
3262     ) -> Result<Res, (Span, ResolutionError<'a>)> {
3263         match self.resolve_path(
3264             &Segment::from_path(path),
3265             Some(ns),
3266             parent_scope,
3267             false,
3268             path.span,
3269             CrateLint::No,
3270         ) {
3271             PathResult::Module(ModuleOrUniformRoot::Module(module)) => Ok(module.res().unwrap()),
3272             PathResult::NonModule(path_res) if path_res.unresolved_segments() == 0 => {
3273                 Ok(path_res.base_res())
3274             }
3275             PathResult::NonModule(..) => Err((
3276                 path.span,
3277                 ResolutionError::FailedToResolve {
3278                     label: String::from("type-relative paths are not supported in this context"),
3279                     suggestion: None,
3280                 },
3281             )),
3282             PathResult::Module(..) | PathResult::Indeterminate => unreachable!(),
3283             PathResult::Failed { span, label, suggestion, .. } => {
3284                 Err((span, ResolutionError::FailedToResolve { label, suggestion }))
3285             }
3286         }
3287     }
3288
3289     fn new_ast_path_segment(&mut self, ident: Ident) -> ast::PathSegment {
3290         let mut seg = ast::PathSegment::from_ident(ident);
3291         seg.id = self.next_node_id();
3292         seg
3293     }
3294
3295     // For rustdoc.
3296     pub fn graph_root(&self) -> Module<'a> {
3297         self.graph_root
3298     }
3299
3300     // For rustdoc.
3301     pub fn all_macros(&self) -> &FxHashMap<Symbol, Res> {
3302         &self.all_macros
3303     }
3304
3305     /// Retrieves the span of the given `DefId` if `DefId` is in the local crate.
3306     #[inline]
3307     pub fn opt_span(&self, def_id: DefId) -> Option<Span> {
3308         if let Some(def_id) = def_id.as_local() { Some(self.def_id_to_span[def_id]) } else { None }
3309     }
3310 }
3311
3312 fn names_to_string(names: &[Symbol]) -> String {
3313     let mut result = String::new();
3314     for (i, name) in names.iter().filter(|name| **name != kw::PathRoot).enumerate() {
3315         if i > 0 {
3316             result.push_str("::");
3317         }
3318         if Ident::with_dummy_span(*name).is_raw_guess() {
3319             result.push_str("r#");
3320         }
3321         result.push_str(&name.as_str());
3322     }
3323     result
3324 }
3325
3326 fn path_names_to_string(path: &Path) -> String {
3327     names_to_string(&path.segments.iter().map(|seg| seg.ident.name).collect::<Vec<_>>())
3328 }
3329
3330 /// A somewhat inefficient routine to obtain the name of a module.
3331 fn module_to_string(module: Module<'_>) -> Option<String> {
3332     let mut names = Vec::new();
3333
3334     fn collect_mod(names: &mut Vec<Symbol>, module: Module<'_>) {
3335         if let ModuleKind::Def(.., name) = module.kind {
3336             if let Some(parent) = module.parent {
3337                 names.push(name);
3338                 collect_mod(names, parent);
3339             }
3340         } else {
3341             names.push(Symbol::intern("<opaque>"));
3342             collect_mod(names, module.parent.unwrap());
3343         }
3344     }
3345     collect_mod(&mut names, module);
3346
3347     if names.is_empty() {
3348         return None;
3349     }
3350     names.reverse();
3351     Some(names_to_string(&names))
3352 }
3353
3354 #[derive(Copy, Clone, Debug)]
3355 enum CrateLint {
3356     /// Do not issue the lint.
3357     No,
3358
3359     /// This lint applies to some arbitrary path; e.g., `impl ::foo::Bar`.
3360     /// In this case, we can take the span of that path.
3361     SimplePath(NodeId),
3362
3363     /// This lint comes from a `use` statement. In this case, what we
3364     /// care about really is the *root* `use` statement; e.g., if we
3365     /// have nested things like `use a::{b, c}`, we care about the
3366     /// `use a` part.
3367     UsePath { root_id: NodeId, root_span: Span },
3368
3369     /// This is the "trait item" from a fully qualified path. For example,
3370     /// we might be resolving  `X::Y::Z` from a path like `<T as X::Y>::Z`.
3371     /// The `path_span` is the span of the to the trait itself (`X::Y`).
3372     QPathTrait { qpath_id: NodeId, qpath_span: Span },
3373 }
3374
3375 impl CrateLint {
3376     fn node_id(&self) -> Option<NodeId> {
3377         match *self {
3378             CrateLint::No => None,
3379             CrateLint::SimplePath(id)
3380             | CrateLint::UsePath { root_id: id, .. }
3381             | CrateLint::QPathTrait { qpath_id: id, .. } => Some(id),
3382         }
3383     }
3384 }
3385
3386 pub fn provide(providers: &mut Providers) {
3387     late::lifetimes::provide(providers);
3388 }