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