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