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