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