1 // ignore-tidy-filelength
3 //! This crate is responsible for the part of name resolution that doesn't require type checker.
5 //! Module structure of the crate is built here.
6 //! Paths in macros, imports, expressions, types, patterns are resolved here.
7 //! Label and lifetime names are resolved here as well.
9 //! Type-relative name resolution (methods, fields, associated items) happens in `rustc_typeck`.
11 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/nightly-rustc/")]
12 #![feature(box_patterns)]
13 #![feature(drain_filter)]
14 #![feature(bool_to_option)]
15 #![feature(crate_visibility_modifier)]
17 #![feature(never_type)]
19 #![recursion_limit = "256"]
20 #![allow(rustdoc::private_intra_doc_links)]
21 #![cfg_attr(not(bootstrap), allow(rustc::potential_query_instability))]
26 pub use rustc_hir::def::{Namespace, PerNS};
30 use rustc_arena::{DroplessArena, TypedArena};
31 use rustc_ast::node_id::NodeMap;
32 use rustc_ast::ptr::P;
33 use rustc_ast::visit::{self, Visitor};
34 use rustc_ast::{self as ast, NodeId};
35 use rustc_ast::{Crate, CRATE_NODE_ID};
36 use rustc_ast::{Expr, ExprKind, LitKind};
37 use rustc_ast::{ItemKind, ModKind, Path};
38 use rustc_ast_lowering::ResolverAstLowering;
39 use rustc_ast_pretty::pprust;
40 use rustc_data_structures::fx::{FxHashMap, FxHashSet, FxIndexMap};
41 use rustc_data_structures::intern::Interned;
42 use rustc_data_structures::sync::Lrc;
43 use rustc_errors::{struct_span_err, Applicability, DiagnosticBuilder};
44 use rustc_expand::base::{DeriveResolutions, SyntaxExtension, SyntaxExtensionKind};
45 use rustc_hir::def::Namespace::*;
46 use rustc_hir::def::{self, CtorOf, DefKind, NonMacroAttrKind, PartialRes};
47 use rustc_hir::def_id::{CrateNum, DefId, DefIdMap, DefPathHash, LocalDefId};
48 use rustc_hir::def_id::{CRATE_DEF_ID, CRATE_DEF_INDEX, LOCAL_CRATE};
49 use rustc_hir::definitions::{DefKey, DefPathData, Definitions};
50 use rustc_hir::TraitCandidate;
51 use rustc_index::vec::IndexVec;
52 use rustc_metadata::creader::{CStore, CrateLoader};
53 use rustc_middle::metadata::ModChild;
54 use rustc_middle::middle::privacy::AccessLevels;
55 use rustc_middle::span_bug;
56 use rustc_middle::ty::query::Providers;
57 use rustc_middle::ty::{self, DefIdTree, MainDefinition, RegisteredTools, ResolverOutputs};
58 use rustc_query_system::ich::StableHashingContext;
59 use rustc_session::cstore::{CrateStore, MetadataLoaderDyn};
60 use rustc_session::lint;
61 use rustc_session::lint::{BuiltinLintDiagnostics, LintBuffer};
62 use rustc_session::Session;
63 use rustc_span::edition::Edition;
64 use rustc_span::hygiene::{ExpnId, ExpnKind, LocalExpnId, MacroKind, SyntaxContext, Transparency};
65 use rustc_span::source_map::Spanned;
66 use rustc_span::symbol::{kw, sym, Ident, Symbol};
67 use rustc_span::{Span, DUMMY_SP};
69 use smallvec::{smallvec, SmallVec};
70 use std::cell::{Cell, RefCell};
71 use std::collections::BTreeSet;
72 use std::ops::ControlFlow;
73 use std::{cmp, fmt, iter, mem, ptr};
76 use diagnostics::{extend_span_to_previous_binding, find_span_of_binding_until_next_binding};
77 use diagnostics::{ImportSuggestion, LabelSuggestion, Suggestion};
78 use imports::{Import, ImportKind, ImportResolver, NameResolution};
79 use late::{ConstantItemKind, HasGenericParams, PathSource, Rib, RibKind::*};
80 use macros::{MacroRulesBinding, MacroRulesScope, MacroRulesScopeRef};
82 use crate::access_levels::AccessLevelsVisitor;
84 type Res = def::Res<NodeId>;
87 mod build_reduced_graph;
100 #[derive(Copy, Clone, PartialEq, Debug)]
101 pub enum Determinacy {
107 fn determined(determined: bool) -> Determinacy {
108 if determined { Determinacy::Determined } else { Determinacy::Undetermined }
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)]
117 DeriveHelpers(LocalExpnId),
119 MacroRules(MacroRulesScopeRef<'a>),
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>),
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.
137 #[derive(Clone, Copy)]
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).
142 AbsolutePath(Namespace),
143 /// All scopes with macro namespace and the given macro kind restriction.
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>),
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.
154 #[derive(Clone, Copy, Debug)]
155 pub struct ParentScope<'a> {
157 expansion: LocalExpnId,
158 macro_rules: MacroRulesScopeRef<'a>,
159 derives: &'a [ast::Path],
162 impl<'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.
165 pub fn module(module: Module<'a>, resolver: &Resolver<'a>) -> ParentScope<'a> {
168 expansion: LocalExpnId::ROOT,
169 macro_rules: resolver.arenas.alloc_macro_rules_scope(MacroRulesScope::Empty),
175 #[derive(Copy, Debug, Clone)]
176 enum ImplTraitContext {
178 Universal(LocalDefId),
182 struct BindingError {
184 origin: BTreeSet<Span>,
185 target: BTreeSet<Span>,
189 impl PartialOrd for BindingError {
190 fn partial_cmp(&self, other: &BindingError) -> Option<cmp::Ordering> {
191 Some(self.cmp(other))
195 impl PartialEq for BindingError {
196 fn eq(&self, other: &BindingError) -> bool {
197 self.name == other.name
201 impl Ord for BindingError {
202 fn cmp(&self, other: &BindingError) -> cmp::Ordering {
203 self.name.cmp(&other.name)
207 enum ResolutionError<'a> {
208 /// Error E0401: can't use type or const parameters from outer function.
209 GenericParamsFromOuterFunction(Res, HasGenericParams),
210 /// Error E0403: the name is already used for a type or const parameter in this generic
212 NameAlreadyUsedInParameterList(Symbol, Span),
213 /// Error E0407: method is not a member of trait.
214 MethodNotMemberOfTrait(Ident, &'a str, Option<Symbol>),
215 /// Error E0437: type is not a member of trait.
216 TypeNotMemberOfTrait(Ident, &'a str, Option<Symbol>),
217 /// Error E0438: const is not a member of trait.
218 ConstNotMemberOfTrait(Ident, &'a str, Option<Symbol>),
219 /// Error E0408: variable `{}` is not bound in all patterns.
220 VariableNotBoundInPattern(&'a BindingError),
221 /// Error E0409: variable `{}` is bound in inconsistent ways within the same match arm.
222 VariableBoundWithDifferentMode(Symbol, Span),
223 /// Error E0415: identifier is bound more than once in this parameter list.
224 IdentifierBoundMoreThanOnceInParameterList(Symbol),
225 /// Error E0416: identifier is bound more than once in the same pattern.
226 IdentifierBoundMoreThanOnceInSamePattern(Symbol),
227 /// Error E0426: use of undeclared label.
228 UndeclaredLabel { name: Symbol, suggestion: Option<LabelSuggestion> },
229 /// Error E0429: `self` imports are only allowed within a `{ }` list.
230 SelfImportsOnlyAllowedWithin { root: bool, span_with_rename: Span },
231 /// Error E0430: `self` import can only appear once in the list.
232 SelfImportCanOnlyAppearOnceInTheList,
233 /// Error E0431: `self` import can only appear in an import list with a non-empty prefix.
234 SelfImportOnlyInImportListWithNonEmptyPrefix,
235 /// Error E0433: failed to resolve.
236 FailedToResolve { label: String, suggestion: Option<Suggestion> },
237 /// Error E0434: can't capture dynamic environment in a fn item.
238 CannotCaptureDynamicEnvironmentInFnItem,
239 /// Error E0435: attempt to use a non-constant value in a constant.
240 AttemptToUseNonConstantValueInConstant(
242 /* suggestion */ &'static str,
243 /* current */ &'static str,
245 /// Error E0530: `X` bindings cannot shadow `Y`s.
246 BindingShadowsSomethingUnacceptable {
247 shadowing_binding_descr: &'static str,
249 participle: &'static str,
250 article: &'static str,
251 shadowed_binding_descr: &'static str,
252 shadowed_binding_span: Span,
254 /// Error E0128: generic parameters with a default cannot use forward-declared identifiers.
255 ForwardDeclaredGenericParam,
256 /// ERROR E0770: the type of const parameters must not depend on other generic parameters.
257 ParamInTyOfConstParam(Symbol),
258 /// generic parameters must not be used inside const evaluations.
260 /// This error is only emitted when using `min_const_generics`.
261 ParamInNonTrivialAnonConst { name: Symbol, is_type: bool },
262 /// Error E0735: generic parameters with a default cannot use `Self`
263 SelfInGenericParamDefault,
264 /// Error E0767: use of unreachable label
265 UnreachableLabel { name: Symbol, definition_span: Span, suggestion: Option<LabelSuggestion> },
266 /// Error E0323, E0324, E0325: mismatch between trait item and impl item.
271 trait_item_span: Span,
272 code: rustc_errors::DiagnosticId,
276 enum VisResolutionError<'a> {
277 Relative2018(Span, &'a ast::Path),
279 FailedToResolve(Span, String, Option<Suggestion>),
280 ExpectedFound(Span, String, Res),
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`.
287 #[derive(Clone, Copy, Debug)]
291 /// Signals whether this `PathSegment` has generic arguments. Used to avoid providing
292 /// nonsensical suggestions.
293 has_generic_args: bool,
297 fn from_path(path: &Path) -> Vec<Segment> {
298 path.segments.iter().map(|s| s.into()).collect()
301 fn from_ident(ident: Ident) -> Segment {
302 Segment { ident, id: None, has_generic_args: false }
305 fn names_to_string(segments: &[Segment]) -> String {
306 names_to_string(&segments.iter().map(|seg| seg.ident.name).collect::<Vec<_>>())
310 impl<'a> From<&'a ast::PathSegment> for Segment {
311 fn from(seg: &'a ast::PathSegment) -> Segment {
312 Segment { ident: seg.ident, id: Some(seg.id), has_generic_args: seg.args.is_some() }
316 struct UsePlacementFinder {
317 target_module: NodeId,
322 impl UsePlacementFinder {
323 fn check(krate: &Crate, target_module: NodeId) -> (Option<Span>, bool) {
324 let mut finder = UsePlacementFinder { target_module, span: None, found_use: false };
325 if let ControlFlow::Continue(..) = finder.check_mod(&krate.items, CRATE_NODE_ID) {
326 visit::walk_crate(&mut finder, krate);
328 (finder.span, finder.found_use)
331 fn check_mod(&mut self, items: &[P<ast::Item>], node_id: NodeId) -> ControlFlow<()> {
332 if self.span.is_some() {
333 return ControlFlow::Break(());
335 if node_id != self.target_module {
336 return ControlFlow::Continue(());
338 // find a use statement
341 ItemKind::Use(..) => {
342 // don't suggest placing a use before the prelude
343 // import or other generated ones
344 if !item.span.from_expansion() {
345 self.span = Some(item.span.shrink_to_lo());
346 self.found_use = true;
347 return ControlFlow::Break(());
350 // don't place use before extern crate
351 ItemKind::ExternCrate(_) => {}
352 // but place them before the first other item
354 if self.span.map_or(true, |span| item.span < span)
355 && !item.span.from_expansion()
357 self.span = Some(item.span.shrink_to_lo());
358 // don't insert between attributes and an item
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)
365 self.span = Some(attr.span.shrink_to_lo());
372 ControlFlow::Continue(())
376 impl<'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) {
383 visit::walk_item(self, item);
387 /// An intermediate resolution result.
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
393 enum LexicalScopeBinding<'a> {
394 Item(&'a NameBinding<'a>),
398 impl<'a> LexicalScopeBinding<'a> {
399 fn res(self) -> Res {
401 LexicalScopeBinding::Item(binding) => binding.res(),
402 LexicalScopeBinding::Res(res) => res,
407 #[derive(Copy, Clone, Debug)]
408 enum ModuleOrUniformRoot<'a> {
412 /// Virtual module that denotes resolution in crate root with fallback to extern prelude.
413 CrateRootAndExternPrelude,
415 /// Virtual module that denotes resolution in extern prelude.
416 /// Used for paths starting with `::` on 2018 edition.
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.
425 impl ModuleOrUniformRoot<'_> {
426 fn same_def(lhs: Self, rhs: Self) -> bool {
428 (ModuleOrUniformRoot::Module(lhs), ModuleOrUniformRoot::Module(rhs)) => {
432 ModuleOrUniformRoot::CrateRootAndExternPrelude,
433 ModuleOrUniformRoot::CrateRootAndExternPrelude,
435 | (ModuleOrUniformRoot::ExternPrelude, ModuleOrUniformRoot::ExternPrelude)
436 | (ModuleOrUniformRoot::CurrentScope, ModuleOrUniformRoot::CurrentScope) => true,
442 #[derive(Clone, Debug)]
443 enum PathResult<'a> {
444 Module(ModuleOrUniformRoot<'a>),
445 NonModule(PartialRes),
450 suggestion: Option<Suggestion>,
451 is_error_from_last_segment: bool,
457 /// An anonymous module; e.g., just a block.
462 /// { // This is an anonymous module
463 /// f(); // This resolves to (2) as we are inside the block.
466 /// f(); // Resolves to (1)
470 /// Any module with a name.
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`].
477 /// * A trait or an enum (it implicitly contains associated types, methods and variant
479 Def(DefKind, DefId, Symbol),
483 /// Get name of the module.
484 pub fn name(&self) -> Option<Symbol> {
486 ModuleKind::Block(..) => None,
487 ModuleKind::Def(.., name) => Some(*name),
492 /// A key that identifies a binding in a given `Module`.
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.
496 #[derive(Copy, Clone, PartialEq, Eq, Hash, Debug)]
498 /// The identifier for the binding, aways the `normalize_to_macros_2_0` version of the
502 /// 0 if ident is not `_`, otherwise a value that's unique to the specific
503 /// `_` in the expanded AST that introduced this binding.
507 type Resolutions<'a> = RefCell<FxIndexMap<BindingKey, &'a RefCell<NameResolution<'a>>>>;
509 /// One node in the tree of modules.
511 /// Note that a "module" in resolve is broader than a `mod` that you declare in Rust code. It may be one of these:
514 /// * crate root (aka, top-level anonymous module)
517 /// * curly-braced block with statements
519 /// You can use [`ModuleData::kind`] to determine the kind of module this is.
520 pub struct ModuleData<'a> {
521 /// The direct parent module (it may not be a `mod`, however).
522 parent: Option<Module<'a>>,
523 /// What kind of module this is, because this may not be a `mod`.
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.
528 lazy_resolutions: Resolutions<'a>,
529 /// True if this is a module from other crate that needs to be populated on access.
530 populate_on_access: Cell<bool>,
532 /// Macro invocations that can expand into items in this module.
533 unexpanded_invocations: RefCell<FxHashSet<LocalExpnId>>,
535 /// Whether `#[no_implicit_prelude]` is active.
536 no_implicit_prelude: bool,
538 glob_importers: RefCell<Vec<&'a Import<'a>>>,
539 globs: RefCell<Vec<&'a Import<'a>>>,
541 /// Used to memoize the traits in this module for faster searches through all traits in scope.
542 traits: RefCell<Option<Box<[(Ident, &'a NameBinding<'a>)]>>>,
544 /// Span of the module itself. Used for error reporting.
550 type Module<'a> = &'a ModuleData<'a>;
552 impl<'a> ModuleData<'a> {
554 parent: Option<Module<'a>>,
558 no_implicit_prelude: bool,
560 let is_foreign = match kind {
561 ModuleKind::Def(_, def_id, _) => !def_id.is_local(),
562 ModuleKind::Block(_) => false,
567 lazy_resolutions: Default::default(),
568 populate_on_access: Cell::new(is_foreign),
569 unexpanded_invocations: Default::default(),
571 glob_importers: RefCell::new(Vec::new()),
572 globs: RefCell::new(Vec::new()),
573 traits: RefCell::new(None),
579 fn for_each_child<R, F>(&'a self, resolver: &mut R, mut f: F)
581 R: AsMut<Resolver<'a>>,
582 F: FnMut(&mut R, Ident, Namespace, &'a NameBinding<'a>),
584 for (key, name_resolution) in resolver.as_mut().resolutions(self).borrow().iter() {
585 if let Some(binding) = name_resolution.borrow().binding {
586 f(resolver, key.ident, key.ns, binding);
591 /// This modifies `self` in place. The traits will be stored in `self.traits`.
592 fn ensure_traits<R>(&'a self, resolver: &mut R)
594 R: AsMut<Resolver<'a>>,
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| {
603 if let Res::Def(DefKind::Trait | DefKind::TraitAlias, _) = binding.res() {
604 collected_traits.push((name, binding))
607 *traits = Some(collected_traits.into_boxed_slice());
611 fn res(&self) -> Option<Res> {
613 ModuleKind::Def(kind, def_id, _) => Some(Res::Def(kind, def_id)),
618 // Public for rustdoc.
619 pub fn def_id(&self) -> DefId {
620 self.opt_def_id().expect("`ModuleData::def_id` is called on a block module")
623 fn opt_def_id(&self) -> Option<DefId> {
625 ModuleKind::Def(_, def_id, _) => Some(def_id),
630 // `self` resolves to the first module ancestor that `is_normal`.
631 fn is_normal(&self) -> bool {
632 matches!(self.kind, ModuleKind::Def(DefKind::Mod, _, _))
635 fn is_trait(&self) -> bool {
636 matches!(self.kind, ModuleKind::Def(DefKind::Trait, _, _))
639 fn nearest_item_scope(&'a self) -> Module<'a> {
641 ModuleKind::Def(DefKind::Enum | DefKind::Trait, ..) => {
642 self.parent.expect("enum or trait module without a parent")
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 {
652 ModuleKind::Def(DefKind::Mod, def_id, _) => def_id,
653 _ => self.parent.expect("non-root module without parent").nearest_parent_mod(),
657 fn is_ancestor_of(&self, mut other: &Self) -> bool {
658 while !ptr::eq(self, other) {
659 if let Some(parent) = other.parent {
669 impl<'a> fmt::Debug for ModuleData<'a> {
670 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
671 write!(f, "{:?}", self.res())
675 /// Records a possibly-private value, type, or module definition.
676 #[derive(Clone, Debug)]
677 pub struct NameBinding<'a> {
678 kind: NameBindingKind<'a>,
679 ambiguity: Option<(&'a NameBinding<'a>, AmbiguityKind)>,
680 expansion: LocalExpnId,
685 pub trait ToNameBinding<'a> {
686 fn to_name_binding(self, arenas: &'a ResolverArenas<'a>) -> &'a NameBinding<'a>;
689 impl<'a> ToNameBinding<'a> for &'a NameBinding<'a> {
690 fn to_name_binding(self, _: &'a ResolverArenas<'a>) -> &'a NameBinding<'a> {
695 #[derive(Clone, Debug)]
696 enum NameBindingKind<'a> {
697 Res(Res, /* is_macro_export */ bool),
699 Import { binding: &'a NameBinding<'a>, import: &'a Import<'a>, used: Cell<bool> },
702 impl<'a> NameBindingKind<'a> {
703 /// Is this a name binding of an import?
704 fn is_import(&self) -> bool {
705 matches!(*self, NameBindingKind::Import { .. })
709 struct PrivacyError<'a> {
711 binding: &'a NameBinding<'a>,
715 struct UseError<'a> {
716 err: DiagnosticBuilder<'a>,
717 /// Candidates which user could `use` to access the missing type.
718 candidates: Vec<ImportSuggestion>,
719 /// The `DefId` of the module to place the use-statements in.
721 /// Whether the diagnostic should say "instead" (as in `consider importing ... instead`).
723 /// Extra free-form suggestion.
724 suggestion: Option<(Span, &'static str, String, Applicability)>,
727 #[derive(Clone, Copy, PartialEq, Debug)]
732 MacroRulesVsModularized,
740 fn descr(self) -> &'static str {
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",
745 AmbiguityKind::MacroRulesVsModularized => {
746 "a conflict between a `macro_rules` name and a non-`macro_rules` name from another module"
748 AmbiguityKind::GlobVsOuter => {
749 "a conflict between a name from a glob import and an outer scope during import or macro resolution"
751 AmbiguityKind::GlobVsGlob => "multiple glob imports of a name in the same module",
752 AmbiguityKind::GlobVsExpanded => {
753 "a conflict between a name from a glob import and a macro-expanded name in the same module during import or macro resolution"
755 AmbiguityKind::MoreExpandedVsOuter => {
756 "a conflict between a macro-expanded name and a less macro-expanded name from outer scope during import or macro resolution"
762 /// Miscellaneous bits of metadata for better ambiguity error reporting.
763 #[derive(Clone, Copy, PartialEq)]
764 enum AmbiguityErrorMisc {
771 struct AmbiguityError<'a> {
774 b1: &'a NameBinding<'a>,
775 b2: &'a NameBinding<'a>,
776 misc1: AmbiguityErrorMisc,
777 misc2: AmbiguityErrorMisc,
780 impl<'a> NameBinding<'a> {
781 fn module(&self) -> Option<Module<'a>> {
783 NameBindingKind::Module(module) => Some(module),
784 NameBindingKind::Import { binding, .. } => binding.module(),
789 fn res(&self) -> Res {
791 NameBindingKind::Res(res, _) => res,
792 NameBindingKind::Module(module) => module.res().unwrap(),
793 NameBindingKind::Import { binding, .. } => binding.res(),
797 fn is_ambiguity(&self) -> bool {
798 self.ambiguity.is_some()
800 NameBindingKind::Import { binding, .. } => binding.is_ambiguity(),
805 fn is_possibly_imported_variant(&self) -> bool {
807 NameBindingKind::Import { binding, .. } => binding.is_possibly_imported_variant(),
808 NameBindingKind::Res(
809 Res::Def(DefKind::Variant | DefKind::Ctor(CtorOf::Variant, ..), _),
812 NameBindingKind::Res(..) | NameBindingKind::Module(..) => false,
816 fn is_extern_crate(&self) -> bool {
818 NameBindingKind::Import {
819 import: &Import { kind: ImportKind::ExternCrate { .. }, .. },
822 NameBindingKind::Module(&ModuleData {
823 kind: ModuleKind::Def(DefKind::Mod, def_id, _),
825 }) => def_id.index == CRATE_DEF_INDEX,
830 fn is_import(&self) -> bool {
831 matches!(self.kind, NameBindingKind::Import { .. })
834 fn is_glob_import(&self) -> bool {
836 NameBindingKind::Import { import, .. } => import.is_glob(),
841 fn is_importable(&self) -> bool {
844 Res::Def(DefKind::AssocConst | DefKind::AssocFn | DefKind::AssocTy, _)
848 fn is_macro_def(&self) -> bool {
849 matches!(self.kind, NameBindingKind::Res(Res::Def(DefKind::Macro(..), _), _))
852 fn macro_kind(&self) -> Option<MacroKind> {
853 self.res().macro_kind()
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
864 invoc_parent_expansion: LocalExpnId,
865 binding: &NameBinding<'_>,
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)
880 #[derive(Debug, Default, Clone)]
881 pub struct ExternPreludeEntry<'a> {
882 extern_crate_item: Option<&'a NameBinding<'a>>,
883 pub introduced_by_item: bool,
886 /// Used for better errors for E0773
887 enum BuiltinMacroState {
888 NotYetSeen(SyntaxExtensionKind),
893 resolutions: DeriveResolutions,
894 helper_attrs: Vec<(usize, Ident)>,
895 has_derive_copy: bool,
898 /// The main resolver class.
900 /// This is the visitor that walks the whole crate.
901 pub struct Resolver<'a> {
902 session: &'a Session,
904 definitions: Definitions,
906 graph_root: Module<'a>,
908 prelude: Option<Module<'a>>,
909 extern_prelude: FxHashMap<Ident, ExternPreludeEntry<'a>>,
911 /// N.B., this is used only for better diagnostics, not name resolution itself.
912 has_self: FxHashSet<DefId>,
914 /// Names of fields of an item `DefId` accessible with dot syntax.
915 /// Used for hints during error reporting.
916 field_names: FxHashMap<DefId, Vec<Spanned<Symbol>>>,
918 /// All imports known to succeed or fail.
919 determined_imports: Vec<&'a Import<'a>>,
921 /// All non-determined imports.
922 indeterminate_imports: Vec<&'a Import<'a>>,
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.
926 last_import_segment: bool,
927 /// This binding should be ignored during in-module resolution, so that we don't get
928 /// "self-confirming" import resolutions during import validation.
929 unusable_binding: Option<&'a NameBinding<'a>>,
931 // Spans for local variables found during pattern resolution.
932 // Used for suggestions during error reporting.
933 pat_span_map: NodeMap<Span>,
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>,
942 /// `CrateNum` resolutions of `extern crate` items.
943 extern_crate_map: FxHashMap<LocalDefId, CrateNum>,
944 reexport_map: FxHashMap<LocalDefId, Vec<ModChild>>,
945 trait_map: NodeMap<Vec<TraitCandidate>>,
947 /// A map from nodes to anonymous modules.
948 /// Anonymous modules are pseudo-modules that are implicitly created around items
949 /// contained within blocks.
951 /// For example, if we have this:
959 /// There will be an anonymous module created around `g` with the ID of the
960 /// entry block for `f`.
961 block_map: NodeMap<Module<'a>>,
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
965 empty_module: Module<'a>,
966 module_map: FxHashMap<DefId, Module<'a>>,
967 binding_parent_modules: FxHashMap<Interned<'a, NameBinding<'a>>, Module<'a>>,
968 underscore_disambiguator: u32,
970 /// Maps glob imports to the names of items actually imported.
971 glob_map: FxHashMap<LocalDefId, FxHashSet<Symbol>>,
972 /// Visibilities in "lowered" form, for all entities that have them.
973 visibilities: FxHashMap<LocalDefId, ty::Visibility>,
974 used_imports: FxHashSet<NodeId>,
975 maybe_unused_trait_imports: FxHashSet<LocalDefId>,
976 maybe_unused_extern_crates: Vec<(LocalDefId, Span)>,
978 /// Privacy errors are delayed until the end in order to deduplicate them.
979 privacy_errors: Vec<PrivacyError<'a>>,
980 /// Ambiguity errors are delayed for deduplication.
981 ambiguity_errors: Vec<AmbiguityError<'a>>,
982 /// `use` injections are delayed for better placement and deduplication.
983 use_injections: Vec<UseError<'a>>,
984 /// Crate-local macro expanded `macro_export` referred to by a module-relative path.
985 macro_expanded_macro_export_errors: BTreeSet<(Span, Span)>,
987 arenas: &'a ResolverArenas<'a>,
988 dummy_binding: &'a NameBinding<'a>,
990 crate_loader: CrateLoader<'a>,
991 macro_names: FxHashSet<Ident>,
992 builtin_macros: FxHashMap<Symbol, BuiltinMacroState>,
993 registered_attrs: FxHashSet<Ident>,
994 registered_tools: RegisteredTools,
995 macro_use_prelude: FxHashMap<Symbol, &'a NameBinding<'a>>,
996 all_macros: FxHashMap<Symbol, Res>,
997 macro_map: FxHashMap<DefId, Lrc<SyntaxExtension>>,
998 dummy_ext_bang: Lrc<SyntaxExtension>,
999 dummy_ext_derive: Lrc<SyntaxExtension>,
1000 non_macro_attr: Lrc<SyntaxExtension>,
1001 local_macro_def_scopes: FxHashMap<LocalDefId, Module<'a>>,
1002 ast_transform_scopes: FxHashMap<LocalExpnId, Module<'a>>,
1003 unused_macros: FxHashMap<LocalDefId, (NodeId, Ident)>,
1004 proc_macro_stubs: FxHashSet<LocalDefId>,
1005 /// Traces collected during macro resolution and validated when it's complete.
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>)>,
1010 builtin_attrs: Vec<(Ident, ParentScope<'a>)>,
1011 /// `derive(Copy)` marks items they are applied to so they are treated specially later.
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.
1014 containers_deriving_copy: FxHashSet<LocalExpnId>,
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.
1017 invocation_parent_scopes: FxHashMap<LocalExpnId, ParentScope<'a>>,
1018 /// `macro_rules` scopes *produced* by expanding the macro invocations,
1019 /// include all the `macro_rules` items and other invocations generated by them.
1020 output_macro_rules_scopes: FxHashMap<LocalExpnId, MacroRulesScopeRef<'a>>,
1021 /// Helper attributes that are in scope for the given expansion.
1022 helper_attrs: FxHashMap<LocalExpnId, Vec<Ident>>,
1023 /// Ready or in-progress results of resolving paths inside the `#[derive(...)]` attribute
1024 /// with the given `ExpnId`.
1025 derive_data: FxHashMap<LocalExpnId, DeriveData>,
1027 /// Avoid duplicated errors for "name already defined".
1028 name_already_seen: FxHashMap<Symbol, Span>,
1030 potentially_unused_imports: Vec<&'a Import<'a>>,
1032 /// Table for mapping struct IDs into struct constructor IDs,
1033 /// it's not used during normal resolution, only for better error reporting.
1034 /// Also includes of list of each fields visibility
1035 struct_constructors: DefIdMap<(Res, ty::Visibility, Vec<ty::Visibility>)>,
1037 /// Features enabled for this crate.
1038 active_features: FxHashSet<Symbol>,
1040 lint_buffer: LintBuffer,
1042 next_node_id: NodeId,
1044 node_id_to_def_id: FxHashMap<ast::NodeId, LocalDefId>,
1045 def_id_to_node_id: IndexVec<LocalDefId, ast::NodeId>,
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`
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.
1052 invocation_parents: FxHashMap<LocalExpnId, (LocalDefId, ImplTraitContext)>,
1054 next_disambiguator: FxHashMap<(LocalDefId, DefPathData), u32>,
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>,
1059 legacy_const_generic_args: FxHashMap<DefId, Option<Vec<usize>>>,
1060 /// Amount of lifetime parameters for each item in the crate.
1061 item_generics_num_lifetimes: FxHashMap<LocalDefId, usize>,
1063 main_def: Option<MainDefinition>,
1064 trait_impls: FxIndexMap<DefId, Vec<LocalDefId>>,
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>,
1068 confused_type_with_std_module: FxHashMap<Span, Span>,
1070 access_levels: AccessLevels,
1073 /// Nothing really interesting here; it just provides memory for the rest of the crate.
1075 pub struct ResolverArenas<'a> {
1076 modules: TypedArena<ModuleData<'a>>,
1077 local_modules: RefCell<Vec<Module<'a>>>,
1078 imports: TypedArena<Import<'a>>,
1079 name_resolutions: TypedArena<RefCell<NameResolution<'a>>>,
1080 ast_paths: TypedArena<ast::Path>,
1081 dropless: DroplessArena,
1084 impl<'a> ResolverArenas<'a> {
1087 parent: Option<Module<'a>>,
1091 no_implicit_prelude: bool,
1092 module_map: &mut FxHashMap<DefId, Module<'a>>,
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()) {
1098 self.local_modules.borrow_mut().push(module);
1100 if let Some(def_id) = def_id {
1101 module_map.insert(def_id, module);
1105 fn local_modules(&'a self) -> std::cell::Ref<'a, Vec<Module<'a>>> {
1106 self.local_modules.borrow()
1108 fn alloc_name_binding(&'a self, name_binding: NameBinding<'a>) -> &'a NameBinding<'a> {
1109 self.dropless.alloc(name_binding)
1111 fn alloc_import(&'a self, import: Import<'a>) -> &'a Import<'_> {
1112 self.imports.alloc(import)
1114 fn alloc_name_resolution(&'a self) -> &'a RefCell<NameResolution<'a>> {
1115 self.name_resolutions.alloc(Default::default())
1117 fn alloc_macro_rules_scope(&'a self, scope: MacroRulesScope<'a>) -> MacroRulesScopeRef<'a> {
1118 Interned::new_unchecked(self.dropless.alloc(Cell::new(scope)))
1120 fn alloc_macro_rules_binding(
1122 binding: MacroRulesBinding<'a>,
1123 ) -> &'a MacroRulesBinding<'a> {
1124 self.dropless.alloc(binding)
1126 fn alloc_ast_paths(&'a self, paths: &[ast::Path]) -> &'a [ast::Path] {
1127 self.ast_paths.alloc_from_iter(paths.iter().cloned())
1129 fn alloc_pattern_spans(&'a self, spans: impl Iterator<Item = Span>) -> &'a [Span] {
1130 self.dropless.alloc_from_iter(spans)
1134 impl<'a> AsMut<Resolver<'a>> for Resolver<'a> {
1135 fn as_mut(&mut self) -> &mut Resolver<'a> {
1140 impl<'a, 'b> DefIdTree for &'a Resolver<'b> {
1141 fn parent(self, id: DefId) -> Option<DefId> {
1142 match id.as_local() {
1143 Some(id) => self.definitions.def_key(id).parent,
1144 None => self.cstore().def_key(id).parent,
1146 .map(|index| DefId { index, ..id })
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.
1152 impl ResolverAstLowering for Resolver<'_> {
1153 fn def_key(&mut self, id: DefId) -> DefKey {
1154 if let Some(id) = id.as_local() {
1155 self.definitions().def_key(id)
1157 self.cstore().def_key(id)
1162 fn def_span(&self, id: LocalDefId) -> Span {
1163 self.definitions.def_span(id)
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]
1170 self.cstore().item_generics_num_lifetimes(def_id, self.session)
1174 fn legacy_const_generic_args(&mut self, expr: &Expr) -> Option<Vec<usize>> {
1175 self.legacy_const_generic_args(expr)
1178 fn get_partial_res(&self, id: NodeId) -> Option<PartialRes> {
1179 self.partial_res_map.get(&id).cloned()
1182 fn get_import_res(&mut self, id: NodeId) -> PerNS<Option<Res>> {
1183 self.import_res_map.get(&id).cloned().unwrap_or_default()
1186 fn get_label_res(&mut self, id: NodeId) -> Option<NodeId> {
1187 self.label_res_map.get(&id).cloned()
1190 fn definitions(&mut self) -> &mut Definitions {
1191 &mut self.definitions
1194 fn create_stable_hashing_context(&self) -> StableHashingContext<'_> {
1195 StableHashingContext::new(self.session, &self.definitions, self.crate_loader.cstore())
1198 fn lint_buffer(&mut self) -> &mut LintBuffer {
1199 &mut self.lint_buffer
1202 fn next_node_id(&mut self) -> NodeId {
1206 fn take_trait_map(&mut self, node: NodeId) -> Option<Vec<TraitCandidate>> {
1207 self.trait_map.remove(&node)
1210 fn opt_local_def_id(&self, node: NodeId) -> Option<LocalDefId> {
1211 self.node_id_to_def_id.get(&node).copied()
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))
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),
1225 /// Adds a definition with a parent definition.
1229 node_id: ast::NodeId,
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: {:?}",
1239 self.definitions.def_key(self.node_id_to_def_id[&node_id]),
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");
1251 let def_id = self.definitions.create_def(parent, data, expn_id, next_disambiguator, span);
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);
1260 assert_eq!(self.def_id_to_node_id.push(node_id), def_id);
1266 impl<'a> Resolver<'a> {
1268 session: &'a Session,
1271 metadata_loader: Box<MetadataLoaderDyn>,
1272 arenas: &'a ResolverArenas<'a>,
1274 let root_def_id = CRATE_DEF_ID.to_def_id();
1275 let mut module_map = FxHashMap::default();
1276 let graph_root = arenas.new_module(
1278 ModuleKind::Def(DefKind::Mod, root_def_id, kw::Empty),
1281 session.contains_name(&krate.attrs, sym::no_implicit_prelude),
1284 let empty_module = arenas.new_module(
1286 ModuleKind::Def(DefKind::Mod, root_def_id, kw::Empty),
1290 &mut FxHashMap::default(),
1293 let definitions = Definitions::new(session.local_stable_crate_id(), krate.span);
1294 let root = definitions.get_root_def();
1296 let mut visibilities = FxHashMap::default();
1297 visibilities.insert(CRATE_DEF_ID, ty::Visibility::Public);
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);
1304 let mut invocation_parents = FxHashMap::default();
1305 invocation_parents.insert(LocalExpnId::ROOT, (root, ImplTraitContext::Existential));
1307 let mut extern_prelude: FxHashMap<Ident, ExternPreludeEntry<'_>> = session
1311 .filter(|(_, entry)| entry.add_prelude)
1312 .map(|(name, _)| (Ident::from_str(name), Default::default()))
1315 if !session.contains_name(&krate.attrs, sym::no_core) {
1316 extern_prelude.insert(Ident::with_dummy_span(sym::core), Default::default());
1317 if !session.contains_name(&krate.attrs, sym::no_std) {
1318 extern_prelude.insert(Ident::with_dummy_span(sym::std), Default::default());
1322 let (registered_attrs, registered_tools) =
1323 macros::registered_attrs_and_tools(session, &krate.attrs);
1325 let features = session.features_untracked();
1327 let mut resolver = Resolver {
1332 // The outermost module has def ID 0; this is not reflected in the
1338 has_self: FxHashSet::default(),
1339 field_names: FxHashMap::default(),
1341 determined_imports: Vec::new(),
1342 indeterminate_imports: Vec::new(),
1344 last_import_segment: false,
1345 unusable_binding: None,
1347 pat_span_map: Default::default(),
1348 partial_res_map: Default::default(),
1349 import_res_map: Default::default(),
1350 label_res_map: Default::default(),
1351 extern_crate_map: Default::default(),
1352 reexport_map: FxHashMap::default(),
1353 trait_map: NodeMap::default(),
1354 underscore_disambiguator: 0,
1357 block_map: Default::default(),
1358 binding_parent_modules: FxHashMap::default(),
1359 ast_transform_scopes: FxHashMap::default(),
1361 glob_map: Default::default(),
1363 used_imports: FxHashSet::default(),
1364 maybe_unused_trait_imports: Default::default(),
1365 maybe_unused_extern_crates: Vec::new(),
1367 privacy_errors: Vec::new(),
1368 ambiguity_errors: Vec::new(),
1369 use_injections: Vec::new(),
1370 macro_expanded_macro_export_errors: BTreeSet::new(),
1373 dummy_binding: arenas.alloc_name_binding(NameBinding {
1374 kind: NameBindingKind::Res(Res::Err, false),
1376 expansion: LocalExpnId::ROOT,
1378 vis: ty::Visibility::Public,
1381 crate_loader: CrateLoader::new(session, metadata_loader, crate_name),
1382 macro_names: FxHashSet::default(),
1383 builtin_macros: Default::default(),
1386 macro_use_prelude: FxHashMap::default(),
1387 all_macros: FxHashMap::default(),
1388 macro_map: FxHashMap::default(),
1389 dummy_ext_bang: Lrc::new(SyntaxExtension::dummy_bang(session.edition())),
1390 dummy_ext_derive: Lrc::new(SyntaxExtension::dummy_derive(session.edition())),
1391 non_macro_attr: Lrc::new(SyntaxExtension::non_macro_attr(session.edition())),
1392 invocation_parent_scopes: Default::default(),
1393 output_macro_rules_scopes: Default::default(),
1394 helper_attrs: Default::default(),
1395 derive_data: Default::default(),
1396 local_macro_def_scopes: FxHashMap::default(),
1397 name_already_seen: FxHashMap::default(),
1398 potentially_unused_imports: Vec::new(),
1399 struct_constructors: Default::default(),
1400 unused_macros: Default::default(),
1401 proc_macro_stubs: Default::default(),
1402 single_segment_macro_resolutions: Default::default(),
1403 multi_segment_macro_resolutions: Default::default(),
1404 builtin_attrs: Default::default(),
1405 containers_deriving_copy: Default::default(),
1406 active_features: features
1407 .declared_lib_features
1409 .map(|(feat, ..)| *feat)
1410 .chain(features.declared_lang_features.iter().map(|(feat, ..)| *feat))
1412 lint_buffer: LintBuffer::default(),
1413 next_node_id: CRATE_NODE_ID,
1416 placeholder_field_indices: Default::default(),
1418 next_disambiguator: Default::default(),
1419 trait_impl_items: Default::default(),
1420 legacy_const_generic_args: Default::default(),
1421 item_generics_num_lifetimes: Default::default(),
1422 main_def: Default::default(),
1423 trait_impls: Default::default(),
1424 proc_macros: Default::default(),
1425 confused_type_with_std_module: Default::default(),
1426 access_levels: Default::default(),
1429 let root_parent_scope = ParentScope::module(graph_root, &resolver);
1430 resolver.invocation_parent_scopes.insert(LocalExpnId::ROOT, root_parent_scope);
1437 parent: Option<Module<'a>>,
1441 no_implicit_prelude: bool,
1443 let module_map = &mut self.module_map;
1444 self.arenas.new_module(parent, kind, expn_id, span, no_implicit_prelude, module_map)
1447 pub fn next_node_id(&mut self) -> NodeId {
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))
1453 pub fn lint_buffer(&mut self) -> &mut LintBuffer {
1454 &mut self.lint_buffer
1457 pub fn arenas() -> ResolverArenas<'a> {
1461 pub fn into_outputs(self) -> ResolverOutputs {
1462 let proc_macros = self.proc_macros.iter().map(|id| self.local_def_id(*id)).collect();
1463 let definitions = self.definitions;
1464 let visibilities = self.visibilities;
1465 let extern_crate_map = self.extern_crate_map;
1466 let reexport_map = self.reexport_map;
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;
1470 let main_def = self.main_def;
1471 let confused_type_with_std_module = self.confused_type_with_std_module;
1472 let access_levels = self.access_levels;
1475 cstore: Box::new(self.crate_loader.into_cstore()),
1481 maybe_unused_trait_imports,
1482 maybe_unused_extern_crates,
1483 extern_prelude: self
1486 .map(|(ident, entry)| (ident.name, entry.introduced_by_item))
1489 trait_impls: self.trait_impls,
1491 confused_type_with_std_module,
1492 registered_tools: self.registered_tools,
1496 pub fn clone_outputs(&self) -> ResolverOutputs {
1497 let proc_macros = self.proc_macros.iter().map(|id| self.local_def_id(*id)).collect();
1499 definitions: self.definitions.clone(),
1500 access_levels: self.access_levels.clone(),
1501 cstore: Box::new(self.cstore().clone()),
1502 visibilities: self.visibilities.clone(),
1503 extern_crate_map: self.extern_crate_map.clone(),
1504 reexport_map: self.reexport_map.clone(),
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(),
1508 extern_prelude: self
1511 .map(|(ident, entry)| (ident.name, entry.introduced_by_item))
1513 main_def: self.main_def,
1514 trait_impls: self.trait_impls.clone(),
1516 confused_type_with_std_module: self.confused_type_with_std_module.clone(),
1517 registered_tools: self.registered_tools.clone(),
1521 pub fn cstore(&self) -> &CStore {
1522 self.crate_loader.cstore()
1525 fn dummy_ext(&self, macro_kind: MacroKind) -> Lrc<SyntaxExtension> {
1527 MacroKind::Bang => self.dummy_ext_bang.clone(),
1528 MacroKind::Derive => self.dummy_ext_derive.clone(),
1529 MacroKind::Attr => self.non_macro_attr.clone(),
1533 /// Runs the function on each namespace.
1534 fn per_ns<F: FnMut(&mut Self, Namespace)>(&mut self, mut f: F) {
1540 fn is_builtin_macro(&mut self, res: Res) -> bool {
1541 self.get_macro(res).map_or(false, |ext| ext.builtin_name.is_some())
1544 fn macro_def(&self, mut ctxt: SyntaxContext) -> DefId {
1546 match ctxt.outer_expn_data().macro_def_id {
1547 Some(def_id) => return def_id,
1548 None => ctxt.remove_mark(),
1553 /// Entry point to crate resolution.
1554 pub fn resolve_crate(&mut self, krate: &Crate) {
1555 self.session.time("resolve_crate", || {
1556 self.session.time("finalize_imports", || ImportResolver { r: self }.finalize_imports());
1557 self.session.time("resolve_access_levels", || {
1558 AccessLevelsVisitor::compute_access_levels(self, krate)
1560 self.session.time("finalize_macro_resolutions", || self.finalize_macro_resolutions());
1561 self.session.time("late_resolve_crate", || self.late_resolve_crate(krate));
1562 self.session.time("resolve_main", || self.resolve_main());
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));
1569 pub fn traits_in_scope(
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();
1578 if let Some(module) = current_trait {
1579 if self.trait_may_have_item(Some(module), assoc_item) {
1580 let def_id = module.def_id();
1581 found_traits.push(TraitCandidate { def_id, import_ids: smallvec![] });
1585 self.visit_scopes(ScopeSet::All(TypeNS, false), parent_scope, ctxt, |this, scope, _, _| {
1587 Scope::Module(module, _) => {
1588 this.traits_in_module(module, assoc_item, &mut found_traits);
1590 Scope::StdLibPrelude => {
1591 if let Some(module) = this.prelude {
1592 this.traits_in_module(module, assoc_item, &mut found_traits);
1595 Scope::ExternPrelude | Scope::ToolPrelude | Scope::BuiltinTypes => {}
1596 _ => unreachable!(),
1604 fn traits_in_module(
1607 assoc_item: Option<(Symbol, Namespace)>,
1608 found_traits: &mut Vec<TraitCandidate>,
1610 module.ensure_traits(self);
1611 let traits = module.traits.borrow();
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 });
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(
1628 trait_module: Option<Module<'a>>,
1629 assoc_item: Option<(Symbol, Namespace)>,
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
1642 fn find_transitive_imports(
1644 mut kind: &NameBindingKind<'_>,
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;
1658 fn new_key(&mut self, ident: Ident, ns: Namespace) -> BindingKey {
1659 let ident = ident.normalize_to_macros_2_0();
1660 let disambiguator = if ident.name == kw::Underscore {
1661 self.underscore_disambiguator += 1;
1662 self.underscore_disambiguator
1666 BindingKey { ident, ns, disambiguator }
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);
1674 &module.lazy_resolutions
1681 ) -> &'a RefCell<NameResolution<'a>> {
1683 .resolutions(module)
1686 .or_insert_with(|| self.arenas.alloc_name_resolution())
1692 used_binding: &'a NameBinding<'a>,
1693 is_lexical_scope: bool,
1695 if let Some((b2, kind)) = used_binding.ambiguity {
1696 self.ambiguity_errors.push(AmbiguityError {
1701 misc1: AmbiguityErrorMisc::None,
1702 misc2: AmbiguityErrorMisc::None,
1705 if let NameBindingKind::Import { import, binding, ref used } = used_binding.kind {
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 {
1709 if let Some(entry) = self.extern_prelude.get(&ident.normalize_to_macros_2_0()) {
1710 if let Some(crate_item) = entry.extern_crate_item {
1711 if ptr::eq(used_binding, crate_item) && !entry.introduced_by_item {
1718 import.used.set(true);
1719 self.used_imports.insert(import.id);
1720 self.add_to_glob_map(&import, ident);
1721 self.record_use(ident, binding, false);
1726 fn add_to_glob_map(&mut self, import: &Import<'_>, ident: Ident) {
1727 if import.is_glob() {
1728 let def_id = self.local_def_id(import.id);
1729 self.glob_map.entry(def_id).or_default().insert(ident.name);
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.
1738 scope_set: ScopeSet<'a>,
1739 parent_scope: &ParentScope<'a>,
1740 ctxt: SyntaxContext,
1741 mut visitor: impl FnMut(
1744 /*use_prelude*/ bool,
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):
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).
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).
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.
1777 // 1-3. `macro_rules` (open, not controlled), loop through `macro_rules` scopes. Have higher
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).
1789 let rust_2015 = ctxt.edition() == Edition::Edition2015;
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),
1794 ScopeSet::Late(ns, ..) => (ns, None, false),
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(),
1802 let mut scope = match ns {
1803 _ if is_absolute_path => Scope::CrateRoot,
1804 TypeNS | ValueNS => Scope::Module(module, None),
1805 MacroNS => Scope::DeriveHelpers(parent_scope.expansion),
1807 let mut ctxt = ctxt.normalize_to_macros_2_0();
1808 let mut use_prelude = !module.no_implicit_prelude;
1811 let visit = match scope {
1812 // Derive helpers are not in scope when resolving derives in the same container.
1813 Scope::DeriveHelpers(expn_id) => {
1814 !(expn_id == parent_scope.expansion && macro_kind == Some(MacroKind::Derive))
1816 Scope::DeriveHelpersCompat => true,
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());
1831 Scope::CrateRoot => true,
1832 Scope::Module(..) => true,
1833 Scope::RegisteredAttrs => use_prelude,
1834 Scope::MacroUsePrelude => use_prelude || rust_2015,
1835 Scope::BuiltinAttrs => true,
1836 Scope::ExternPrelude => use_prelude || is_absolute_path,
1837 Scope::ToolPrelude => use_prelude,
1838 Scope::StdLibPrelude => use_prelude || ns == MacroNS,
1839 Scope::BuiltinTypes => true,
1843 if let break_result @ Some(..) = visitor(self, scope, use_prelude, ctxt) {
1844 return break_result;
1848 scope = match scope {
1849 Scope::DeriveHelpers(LocalExpnId::ROOT) => Scope::DeriveHelpersCompat,
1850 Scope::DeriveHelpers(expn_id) => {
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 {
1855 | ExpnKind::Macro(MacroKind::Bang | MacroKind::Derive, _) => {
1856 Scope::DeriveHelpersCompat
1858 _ => Scope::DeriveHelpers(expn_data.parent.expect_local()),
1861 Scope::DeriveHelpersCompat => Scope::MacroRules(parent_scope.macro_rules),
1862 Scope::MacroRules(macro_rules_scope) => match macro_rules_scope.get() {
1863 MacroRulesScope::Binding(binding) => {
1864 Scope::MacroRules(binding.parent_macro_rules_scope)
1866 MacroRulesScope::Invocation(invoc_id) => {
1867 Scope::MacroRules(self.invocation_parent_scopes[&invoc_id].macro_rules)
1869 MacroRulesScope::Empty => Scope::Module(module, None),
1871 Scope::CrateRoot => match ns {
1873 ctxt.adjust(ExpnId::root());
1874 Scope::ExternPrelude
1876 ValueNS | MacroNS => break,
1878 Scope::Module(module, prev_lint_id) => {
1879 use_prelude = !module.no_implicit_prelude;
1880 let derive_fallback_lint_id = match scope_set {
1881 ScopeSet::Late(.., lint_id) => lint_id,
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))
1889 ctxt.adjust(ExpnId::root());
1891 TypeNS => Scope::ExternPrelude,
1892 ValueNS => Scope::StdLibPrelude,
1893 MacroNS => Scope::RegisteredAttrs,
1898 Scope::RegisteredAttrs => Scope::MacroUsePrelude,
1899 Scope::MacroUsePrelude => Scope::StdLibPrelude,
1900 Scope::BuiltinAttrs => break, // nowhere else to search
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,
1909 Scope::BuiltinTypes => break, // nowhere else to search
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).
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,
1924 /// g(); // Since there are no local variables in scope yet, this resolves to the item.
1927 /// g(); // This resolves to the local variable `g` since it shadows the item.
1931 /// Invariant: This must only be called during main resolution, not during
1932 /// import resolution.
1933 fn resolve_ident_in_lexical_scope(
1937 parent_scope: &ParentScope<'a>,
1938 record_used_id: Option<NodeId>,
1941 ) -> Option<LexicalScopeBinding<'a>> {
1942 assert!(ns == TypeNS || ns == ValueNS);
1943 let orig_ident = ident;
1944 if ident.name == kw::Empty {
1945 return Some(LexicalScopeBinding::Res(Res::Err));
1947 let (general_span, normalized_span) = if ident.name == kw::SelfUpper {
1948 // FIXME(jseyfried) improve `Self` hygiene
1949 let empty_span = ident.span.with_ctxt(SyntaxContext::root());
1950 (empty_span, empty_span)
1951 } else if ns == TypeNS {
1952 let normalized_span = ident.span.normalize_to_macros_2_0();
1953 (normalized_span, normalized_span)
1955 (ident.span.normalize_to_macro_rules(), ident.span.normalize_to_macros_2_0())
1957 ident.span = general_span;
1958 let normalized_ident = Ident { span: normalized_span, ..ident };
1960 // Walk backwards up the ribs in scope.
1961 let record_used = record_used_id.is_some();
1962 let mut module = self.graph_root;
1963 for i in (0..ribs.len()).rev() {
1964 debug!("walk rib\n{:?}", ribs[i].bindings);
1965 // Use the rib kind to determine whether we are resolving parameters
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 };
1968 if let Some((original_rib_ident_def, res)) = ribs[i].bindings.get_key_value(&rib_ident)
1970 // The ident resolves to a type parameter or local variable.
1971 return Some(LexicalScopeBinding::Res(self.validate_res_from_ribs(
1977 *original_rib_ident_def,
1982 module = match ribs[i].kind {
1983 ModuleRibKind(module) => module,
1984 MacroDefinition(def) if def == self.macro_def(ident.span.ctxt()) => {
1985 // If an invocation of this macro created `ident`, give up on `ident`
1986 // and switch to `ident`'s source from the macro definition.
1987 ident.span.remove_mark();
1994 ModuleKind::Block(..) => {} // We can see through blocks
1998 let item = self.resolve_ident_in_module_unadjusted(
1999 ModuleOrUniformRoot::Module(module),
2006 if let Ok(binding) = item {
2007 // The ident resolves to an item.
2008 return Some(LexicalScopeBinding::Item(binding));
2011 self.early_resolve_ident_in_lexical_scope(
2013 ScopeSet::Late(ns, module, record_used_id),
2020 .map(LexicalScopeBinding::Item)
2023 fn hygienic_lexical_parent(
2026 ctxt: &mut SyntaxContext,
2027 derive_fallback_lint_id: Option<NodeId>,
2028 ) -> Option<(Module<'a>, Option<NodeId>)> {
2029 if !module.expansion.outer_expn_is_descendant_of(*ctxt) {
2030 return Some((self.expn_def_scope(ctxt.remove_mark()), None));
2033 if let ModuleKind::Block(..) = module.kind {
2034 return Some((module.parent.unwrap().nearest_item_scope(), None));
2037 // We need to support the next case under a deprecation warning
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 { ... }
2047 // So we have to fall back to the module's parent during lexical resolution in this case.
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)
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)
2061 return Some((parent, derive_fallback_lint_id));
2071 fn resolve_ident_in_module(
2073 module: ModuleOrUniformRoot<'a>,
2076 parent_scope: &ParentScope<'a>,
2079 ) -> Result<&'a NameBinding<'a>, Determinacy> {
2080 self.resolve_ident_in_module_ext(module, ident, ns, parent_scope, record_used, path_span)
2081 .map_err(|(determinacy, _)| determinacy)
2084 fn resolve_ident_in_module_ext(
2086 module: ModuleOrUniformRoot<'a>,
2089 parent_scope: &ParentScope<'a>,
2092 ) -> Result<&'a NameBinding<'a>, (Determinacy, Weak)> {
2093 let tmp_parent_scope;
2094 let mut adjusted_parent_scope = parent_scope;
2096 ModuleOrUniformRoot::Module(m) => {
2097 if let Some(def) = ident.span.normalize_to_macros_2_0_and_adjust(m.expansion) {
2099 ParentScope { module: self.expn_def_scope(def), ..*parent_scope };
2100 adjusted_parent_scope = &tmp_parent_scope;
2103 ModuleOrUniformRoot::ExternPrelude => {
2104 ident.span.normalize_to_macros_2_0_and_adjust(ExpnId::root());
2106 ModuleOrUniformRoot::CrateRootAndExternPrelude | ModuleOrUniformRoot::CurrentScope => {
2110 self.resolve_ident_in_module_unadjusted_ext(
2114 adjusted_parent_scope,
2121 fn resolve_crate_root(&mut self, ident: Ident) -> Module<'a> {
2122 debug!("resolve_crate_root({:?})", ident);
2123 let mut ctxt = ident.span.ctxt();
2124 let mark = if ident.name == kw::DollarCrate {
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`
2127 // as described in `SyntaxContext::apply_mark`, so we ignore prepended opaque marks.
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.
2131 ctxt = ctxt.normalize_to_macro_rules();
2133 "resolve_crate_root: marks={:?}",
2134 ctxt.marks().into_iter().map(|(i, t)| (i.expn_data(), t)).collect::<Vec<_>>()
2136 let mut iter = ctxt.marks().into_iter().rev().peekable();
2137 let mut result = None;
2138 // Find the last opaque mark from the end if it exists.
2139 while let Some(&(mark, transparency)) = iter.peek() {
2140 if transparency == Transparency::Opaque {
2141 result = Some(mark);
2148 "resolve_crate_root: found opaque mark {:?} {:?}",
2150 result.map(|r| r.expn_data())
2152 // Then find the last semi-transparent mark from the end if it exists.
2153 for (mark, transparency) in iter {
2154 if transparency == Transparency::SemiTransparent {
2155 result = Some(mark);
2161 "resolve_crate_root: found semi-transparent mark {:?} {:?}",
2163 result.map(|r| r.expn_data())
2167 debug!("resolve_crate_root: not DollarCrate");
2168 ctxt = ctxt.normalize_to_macros_2_0();
2169 ctxt.adjust(ExpnId::root())
2171 let module = match mark {
2172 Some(def) => self.expn_def_scope(def),
2175 "resolve_crate_root({:?}): found no mark (ident.span = {:?})",
2178 return self.graph_root;
2181 let module = self.expect_module(
2182 module.opt_def_id().map_or(LOCAL_CRATE, |def_id| def_id.krate).as_def_id(),
2185 "resolve_crate_root({:?}): got module {:?} ({:?}) (ident.span = {:?})",
2194 fn resolve_self(&mut self, ctxt: &mut SyntaxContext, module: Module<'a>) -> Module<'a> {
2195 let mut module = self.expect_module(module.nearest_parent_mod());
2196 while module.span.ctxt().normalize_to_macros_2_0() != *ctxt {
2197 let parent = module.parent.unwrap_or_else(|| self.expn_def_scope(ctxt.remove_mark()));
2198 module = self.expect_module(parent.nearest_parent_mod());
2206 opt_ns: Option<Namespace>, // `None` indicates a module path in import
2207 parent_scope: &ParentScope<'a>,
2210 crate_lint: CrateLint,
2211 ) -> PathResult<'a> {
2212 self.resolve_path_with_ribs(
2223 fn resolve_path_with_ribs(
2226 opt_ns: Option<Namespace>, // `None` indicates a module path in import
2227 parent_scope: &ParentScope<'a>,
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;
2238 "resolve_path(path={:?}, opt_ns={:?}, record_used={:?}, \
2239 path_span={:?}, crate_lint={:?})",
2240 path, opt_ns, record_used, path_span, crate_lint,
2243 for (i, &Segment { ident, id, has_generic_args: _ }) in path.iter().enumerate() {
2244 debug!("resolve_path ident {} {:?} {:?}", i, ident, id);
2245 let record_segment_res = |this: &mut Self, res| {
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));
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;
2260 allow_super &= ns == TypeNS && (name == kw::SelfLower || name == kw::Super);
2263 if allow_super && name == kw::Super {
2264 let mut ctxt = ident.span.ctxt().normalize_to_macros_2_0();
2265 let self_module = match i {
2266 0 => Some(self.resolve_self(&mut ctxt, parent_scope.module)),
2268 Some(ModuleOrUniformRoot::Module(module)) => Some(module),
2272 if let Some(self_module) = self_module {
2273 if let Some(parent) = self_module.parent {
2274 module = Some(ModuleOrUniformRoot::Module(
2275 self.resolve_self(&mut ctxt, parent),
2280 let msg = "there are too many leading `super` keywords".to_string();
2281 return PathResult::Failed {
2285 is_error_from_last_segment: false,
2289 if name == kw::SelfLower {
2290 let mut ctxt = ident.span.ctxt().normalize_to_macros_2_0();
2291 module = Some(ModuleOrUniformRoot::Module(
2292 self.resolve_self(&mut ctxt, parent_scope.module),
2296 if name == kw::PathRoot && ident.span.rust_2018() {
2297 module = Some(ModuleOrUniformRoot::ExternPrelude);
2300 if name == kw::PathRoot && ident.span.rust_2015() && self.session.rust_2018() {
2301 // `::a::b` from 2015 macro on 2018 global edition
2302 module = Some(ModuleOrUniformRoot::CrateRootAndExternPrelude);
2305 if name == kw::PathRoot || name == kw::Crate || name == kw::DollarCrate {
2306 // `::a::b`, `crate::a::b` or `$crate::a::b`
2307 module = Some(ModuleOrUniformRoot::Module(self.resolve_crate_root(ident)));
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()
2318 format!("`{}`", name)
2320 let label = if i == 1 && path[0].ident.name == kw::PathRoot {
2321 format!("global paths cannot start with {}", name_str)
2323 format!("{} in paths can only be used in start position", name_str)
2325 return PathResult::Failed {
2329 is_error_from_last_segment: false,
2333 enum FindBindingResult<'a> {
2334 Binding(Result<&'a NameBinding<'a>, Determinacy>),
2335 PathResult(PathResult<'a>),
2337 let find_binding_in_ns = |this: &mut Self, ns| {
2338 let binding = if let Some(module) = module {
2339 this.resolve_ident_in_module(
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(
2358 let record_used_id = if record_used {
2359 crate_lint.node_id().or(Some(CRATE_NODE_ID))
2363 match this.resolve_ident_in_lexical_scope(
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) =>
2377 record_segment_res(this, res);
2378 return FindBindingResult::PathResult(PathResult::NonModule(
2379 PartialRes::with_unresolved_segments(res, path.len() - 1),
2382 _ => Err(Determinacy::determined(record_used)),
2385 FindBindingResult::Binding(binding)
2387 let binding = match find_binding_in_ns(self, ns) {
2388 FindBindingResult::PathResult(x) => return x,
2389 FindBindingResult::Binding(binding) => binding,
2394 second_binding = Some(binding);
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() {
2406 "cannot use a tool module through an import",
2408 .span_note(binding.span, "the tool module imported here")
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(
2422 return PathResult::NonModule(PartialRes::with_unresolved_segments(
2427 let label = format!(
2428 "`{}` is {} {}, not a module",
2434 return PathResult::Failed {
2438 is_error_from_last_segment: is_last,
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(
2447 module.res().unwrap(),
2452 let module_res = match module {
2453 Some(ModuleOrUniformRoot::Module(module)) => module.res(),
2456 let (label, suggestion) = if module_res == self.graph_root.res() {
2457 let is_mod = |res| matches!(res, Res::Def(DefKind::Mod, _));
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)
2464 candidates.sort_by_cached_key(|c| {
2465 (c.path.segments.len(), pprust::path_to_string(&c.path))
2467 if let Some(candidate) = candidates.get(0) {
2469 String::from("unresolved import"),
2471 vec![(ident.span, pprust::path_to_string(&candidate.path))],
2472 String::from("a similar path exists"),
2473 Applicability::MaybeIncorrect,
2476 } else if self.session.edition() == Edition::Edition2015 {
2477 (format!("maybe a missing crate `{}`?", ident), None)
2479 (format!("could not find `{}` in the crate root", ident), None)
2487 .map_or(false, |c| c.is_ascii_uppercase())
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(
2497 &ribs.unwrap()[ValueNS],
2499 // Name matches a local variable. For example:
2502 // let Foo: &str = "";
2503 // println!("{}", Foo::Bar); // Name refers to local
2504 // // variable `Foo`.
2507 Some(LexicalScopeBinding::Res(Res::Local(id))) => {
2508 Some(*self.pat_span_map.get(&id).unwrap())
2511 // Name matches item from a local name binding
2512 // created by `use` declaration. For example:
2514 // pub Foo: &str = "";
2518 // println!("{}", Foo::Bar); // Name refers to local
2519 // // binding `Foo`.
2522 Some(LexicalScopeBinding::Item(name_binding)) => {
2523 Some(name_binding.span)
2528 if let Some(span) = match_span {
2530 vec![(span, String::from(""))],
2531 format!("`{}` is defined here, but is not a type", ident),
2532 Applicability::MaybeIncorrect,
2541 (format!("use of undeclared type `{}`", ident), suggestion)
2544 format!("use of undeclared crate or module `{}`", ident),
2545 if ident.name == sym::alloc {
2549 "add `extern crate alloc` to use the `alloc` crate",
2551 Applicability::MaybeIncorrect,
2554 self.find_similarly_named_module_or_crate(
2556 &parent_scope.module,
2560 vec![(ident.span, sugg.to_string())],
2562 "there is a crate or module with a similar name",
2564 Applicability::MaybeIncorrect,
2571 let parent = path[i - 1].ident.name;
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()
2578 kw::PathRoot | kw::Crate => "the crate root".to_owned(),
2580 format!("`{}`", parent)
2584 let mut msg = format!("could not find `{}` in {}", ident, parent);
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)
2590 let mut found = |what| {
2592 "expected {}, found {} `{}` in {}",
2599 if binding.module().is_some() {
2602 match binding.res() {
2603 def::Res::<NodeId>::Def(kind, id) => found(kind.descr(id)),
2604 _ => found(ns_to_try.descr()),
2611 return PathResult::Failed {
2615 is_error_from_last_segment: is_last,
2621 self.lint_if_path_starts_with_module(crate_lint, path, path_span, second_binding);
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),
2630 fn lint_if_path_starts_with_module(
2632 crate_lint: CrateLint,
2635 second_binding: Option<&NameBinding<'_>>,
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),
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,
2650 // We're only interested in `use` paths which should start with
2651 // `{{root}}` currently.
2652 if first_name != kw::PathRoot {
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
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
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 {
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 {
2679 let diag = BuiltinLintDiagnostics::AbsPathWithModule(diag_span);
2680 self.lint_buffer.buffer_lint_with_diagnostic(
2681 lint::builtin::ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE,
2684 "absolute paths must start with `self`, `super`, \
2685 `crate`, or an external crate name in the 2018 edition",
2690 // Validate a local resolution (from ribs).
2691 fn validate_res_from_ribs(
2698 original_rib_ident_def: Ident,
2699 all_ribs: &[Rib<'a>],
2701 const CG_BUG_STR: &str = "min_const_generics resolve check didn't stop compilation";
2702 debug!("validate_res_from_ribs({:?})", res);
2703 let ribs = &all_ribs[rib_index + 1..];
2705 // An invalid forward use of a generic parameter from a previous default.
2706 if let ForwardGenericParamBanRibKind = all_ribs[rib_index].kind {
2708 let res_error = if rib_ident.name == kw::SelfUpper {
2709 ResolutionError::SelfInGenericParamDefault
2711 ResolutionError::ForwardDeclaredGenericParam
2713 self.report_error(span, res_error);
2715 assert_eq!(res, Res::Err);
2721 use ResolutionError::*;
2722 let mut res_err = None;
2727 | ClosureOrAsyncRibKind
2729 | MacroDefinition(..)
2730 | ForwardGenericParamBanRibKind => {
2731 // Nothing to do. Continue.
2733 ItemRibKind(_) | FnItemRibKind | AssocItemRibKind => {
2734 // This was an attempt to access an upvar inside a
2735 // named function item. This is not allowed, so we
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
2742 res_err = Some(CannotCaptureDynamicEnvironmentInFnItem);
2745 ConstantItemRibKind(_, item) => {
2746 // Still doesn't deal with upvars
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",
2756 AttemptToUseNonConstantValueInConstant(
2757 ident, "let", kind_str,
2763 AttemptToUseNonConstantValueInConstant(
2764 original_rib_ident_def,
2770 self.report_error(span, resolution_error);
2774 ConstParamTyRibKind => {
2776 self.report_error(span, ParamInTyOfConstParam(rib_ident.name));
2782 if let Some(res_err) = res_err {
2783 self.report_error(span, res_err);
2787 Res::Def(DefKind::TyParam, _) | Res::SelfTy { .. } => {
2789 let has_generic_params: HasGenericParams = match rib.kind {
2791 | ClosureOrAsyncRibKind
2794 | MacroDefinition(..)
2795 | ForwardGenericParamBanRibKind => {
2796 // Nothing to do. Continue.
2800 ConstantItemRibKind(trivial, _) => {
2801 let features = self.session.features_untracked();
2802 // HACK(min_const_generics): We currently only allow `N` or `{ N }`.
2803 if !(trivial || features.generic_const_exprs) {
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.
2807 if let Res::SelfTy { trait_, alias_to: Some((def, _)) } = res {
2808 res = Res::SelfTy { trait_, alias_to: Some((def, true)) }
2813 ResolutionError::ParamInNonTrivialAnonConst {
2814 name: rib_ident.name,
2820 self.session.delay_span_bug(span, CG_BUG_STR);
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,
2831 ConstParamTyRibKind => {
2835 ResolutionError::ParamInTyOfConstParam(rib_ident.name),
2845 ResolutionError::GenericParamsFromOuterFunction(
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.
2864 let has_generic_params = match rib.kind {
2866 | ClosureOrAsyncRibKind
2869 | MacroDefinition(..)
2870 | ForwardGenericParamBanRibKind => continue,
2872 ConstantItemRibKind(trivial, _) => {
2873 let features = self.session.features_untracked();
2874 // HACK(min_const_generics): We currently only allow `N` or `{ N }`.
2875 if !(trivial || features.generic_const_exprs) {
2879 ResolutionError::ParamInNonTrivialAnonConst {
2880 name: rib_ident.name,
2886 self.session.delay_span_bug(span, CG_BUG_STR);
2893 ItemRibKind(has_generic_params) => has_generic_params,
2894 FnItemRibKind => HasGenericParams::Yes,
2895 ConstParamTyRibKind => {
2899 ResolutionError::ParamInTyOfConstParam(rib_ident.name),
2906 // This was an attempt to use a const parameter outside its scope.
2910 ResolutionError::GenericParamsFromOuterFunction(
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) {
2927 panic!("path resolved multiple times ({:?} before, {:?} now)", prev_res, resolution);
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);
2936 fn is_accessible_from(&self, vis: ty::Visibility, module: Module<'a>) -> bool {
2937 vis.is_accessible_from(module.nearest_parent_mod(), self)
2940 fn set_binding_parent_module(&mut self, binding: &'a NameBinding<'a>, module: Module<'a>) {
2941 if let Some(old_module) =
2942 self.binding_parent_modules.insert(Interned::new_unchecked(binding), module)
2944 if !ptr::eq(module, old_module) {
2945 span_bug!(binding.span, "parent module is reset for binding");
2950 fn disambiguate_macro_rules_vs_modularized(
2952 macro_rules: &'a NameBinding<'a>,
2953 modularized: &'a NameBinding<'a>,
2955 // Some non-controversial subset of ambiguities "modularized macro name" vs "macro_rules"
2956 // is disambiguated to mitigate regressions from macro modularization.
2957 // Scoping for `macro_rules` behaves like scoping for `let` at module level, in general.
2959 self.binding_parent_modules.get(&Interned::new_unchecked(macro_rules)),
2960 self.binding_parent_modules.get(&Interned::new_unchecked(modularized)),
2962 (Some(macro_rules), Some(modularized)) => {
2963 macro_rules.nearest_parent_mod() == modularized.nearest_parent_mod()
2964 && modularized.is_ancestor_of(macro_rules)
2970 fn report_errors(&mut self, krate: &Crate) {
2971 self.report_with_use_injections(krate);
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";
2976 self.lint_buffer.buffer_lint_with_diagnostic(
2977 lint::builtin::MACRO_EXPANDED_MACRO_EXPORTS_ACCESSED_BY_ABSOLUTE_PATHS,
2981 BuiltinLintDiagnostics::MacroExpandedMacroExportsAccessedByAbsolutePaths(span_def),
2985 for ambiguity_error in &self.ambiguity_errors {
2986 self.report_ambiguity_error(ambiguity_error);
2989 let mut reported_spans = FxHashSet::default();
2990 for error in &self.privacy_errors {
2991 if reported_spans.insert(error.dedup_span) {
2992 self.report_privacy_error(error);
2997 fn report_with_use_injections(&mut self, krate: &Crate) {
2998 for UseError { mut err, candidates, def_id, instead, suggestion } in
2999 self.use_injections.drain(..)
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])
3006 if !candidates.is_empty() {
3007 diagnostics::show_candidates(
3016 } else if let Some((span, msg, sugg, appl)) = suggestion {
3017 err.span_suggestion(span, msg, sugg, appl);
3023 fn report_conflict<'b>(
3028 new_binding: &NameBinding<'b>,
3029 old_binding: &NameBinding<'b>,
3031 // Error on the second of two conflicting names
3032 if old_binding.span.lo() > new_binding.span.lo() {
3033 return self.report_conflict(parent, ident, ns, old_binding, new_binding);
3036 let container = match parent.kind {
3037 ModuleKind::Def(kind, _, _) => kind.descr(parent.def_id()),
3038 ModuleKind::Block(..) => "block",
3041 let old_noun = match old_binding.is_import() {
3043 false => "definition",
3046 let new_participle = match new_binding.is_import() {
3052 (ident.name, self.session.source_map().guess_head_span(new_binding.span));
3054 if let Some(s) = self.name_already_seen.get(&name) {
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",
3069 let msg = format!("the name `{}` is defined multiple times", name);
3071 let mut err = match (old_binding.is_extern_crate(), new_binding.is_extern_crate()) {
3072 (true, true) => struct_span_err!(self.session, span, E0259, "{}", msg),
3073 (true, _) | (_, true) => match new_binding.is_import() && old_binding.is_import() {
3074 true => struct_span_err!(self.session, span, E0254, "{}", msg),
3075 false => struct_span_err!(self.session, span, E0260, "{}", msg),
3077 _ => match (old_binding.is_import(), new_binding.is_import()) {
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),
3085 "`{}` must be defined only once in the {} namespace of this {}",
3091 err.span_label(span, format!("`{}` re{} here", name, new_participle));
3093 self.session.source_map().guess_head_span(old_binding.span),
3094 format!("previous {} of the {} `{}` here", old_noun, old_kind, name),
3097 // See https://github.com/rust-lang/rust/issues/32354
3098 use NameBindingKind::Import;
3099 let import = match (&new_binding.kind, &old_binding.kind) {
3100 // If there are two imports where one or both have attributes then prefer removing the
3101 // import without attributes.
3102 (Import { import: new, .. }, Import { import: old, .. })
3104 !new_binding.span.is_dummy()
3105 && !old_binding.span.is_dummy()
3106 && (new.has_attributes || old.has_attributes)
3109 if old.has_attributes {
3110 Some((new, new_binding.span, true))
3112 Some((old, old_binding.span, true))
3115 // Otherwise prioritize the new binding.
3116 (Import { import, .. }, other) if !new_binding.span.is_dummy() => {
3117 Some((import, new_binding.span, other.is_import()))
3119 (other, Import { import, .. }) if !old_binding.span.is_dummy() => {
3120 Some((import, old_binding.span, other.is_import()))
3125 // Check if the target of the use for both bindings is the same.
3126 let duplicate = new_binding.res().opt_def_id() == old_binding.res().opt_def_id();
3127 let has_dummy_span = new_binding.span.is_dummy() || old_binding.span.is_dummy();
3129 self.extern_prelude.get(&ident).map_or(true, |entry| entry.introduced_by_item);
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
3132 // been introduced by an item.
3133 let should_remove_import = duplicate
3135 && ((new_binding.is_extern_crate() || old_binding.is_extern_crate()) || from_item);
3138 Some((import, span, true)) if should_remove_import && import.is_nested() => {
3139 self.add_suggestion_for_duplicate_nested_use(&mut err, import, span)
3141 Some((import, _, true)) if should_remove_import && !import.is_glob() => {
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.
3144 err.tool_only_span_suggestion(
3145 import.use_span_with_attributes,
3146 "remove unnecessary import",
3148 Applicability::MaybeIncorrect,
3151 Some((import, span, _)) => {
3152 self.add_suggestion_for_rename_of_use(&mut err, name, import, span)
3158 self.name_already_seen.insert(name, span);
3161 /// This function adds a suggestion to change the binding name of a new import that conflicts
3162 /// with an existing import.
3164 /// ```text,ignore (diagnostic)
3165 /// help: you can use `as` to change the binding name of the import
3167 /// LL | use foo::bar as other_bar;
3168 /// | ^^^^^^^^^^^^^^^^^^^^^
3170 fn add_suggestion_for_rename_of_use(
3172 err: &mut DiagnosticBuilder<'_>,
3174 import: &Import<'_>,
3177 let suggested_name = if name.as_str().chars().next().unwrap().is_uppercase() {
3178 format!("Other{}", name)
3180 format!("other_{}", name)
3183 let mut suggestion = None;
3185 ImportKind::Single { type_ns_only: true, .. } => {
3186 suggestion = Some(format!("self as {}", suggested_name))
3188 ImportKind::Single { source, .. } => {
3190 source.span.hi().0.checked_sub(binding_span.lo().0).map(|pos| pos as usize)
3192 if let Ok(snippet) = self.session.source_map().span_to_snippet(binding_span) {
3193 if pos <= snippet.len() {
3194 suggestion = Some(format!(
3198 if snippet.ends_with(';') { ";" } else { "" }
3204 ImportKind::ExternCrate { source, target, .. } => {
3205 suggestion = Some(format!(
3206 "extern crate {} as {};",
3207 source.unwrap_or(target.name),
3211 _ => unreachable!(),
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(
3220 Applicability::MaybeIncorrect,
3223 err.span_label(binding_span, rename_msg);
3227 /// This function adds a suggestion to remove an unnecessary binding from an import that is
3228 /// nested. In the following example, this function will be invoked to remove the `a` binding
3229 /// in the second use statement:
3231 /// ```ignore (diagnostic)
3232 /// use issue_52891::a;
3233 /// use issue_52891::{d, a, e};
3236 /// The following suggestion will be added:
3238 /// ```ignore (diagnostic)
3239 /// use issue_52891::{d, a, e};
3240 /// ^-- help: remove unnecessary import
3243 /// If the nested use contains only one import then the suggestion will remove the entire
3246 /// It is expected that the provided import is nested - this isn't checked by the
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(
3251 err: &mut DiagnosticBuilder<'_>,
3252 import: &Import<'_>,
3255 assert!(import.is_nested());
3256 let message = "remove unnecessary import";
3258 // Two examples will be used to illustrate the span manipulations we're doing:
3260 // - Given `use issue_52891::{d, a, e};` where `a` is a duplicate then `binding_span` is
3261 // `a` and `import.use_span` is `issue_52891::{d, a, e};`.
3262 // - Given `use issue_52891::{d, e, a};` where `a` is a duplicate then `binding_span` is
3263 // `a` and `import.use_span` is `issue_52891::{d, e, a};`.
3265 let (found_closing_brace, span) =
3266 find_span_of_binding_until_next_binding(self.session, binding_span, import.use_span);
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 {
3271 if let Some(span) = extend_span_to_previous_binding(self.session, span) {
3272 err.tool_only_span_suggestion(
3276 Applicability::MaybeIncorrect,
3279 // Remove the entire line if we cannot extend the span back, this indicates an
3280 // `issue_52891::{self}` case.
3281 err.span_suggestion(
3282 import.use_span_with_attributes,
3285 Applicability::MaybeIncorrect,
3292 err.span_suggestion(span, message, String::new(), Applicability::MachineApplicable);
3295 fn extern_prelude_get(
3299 ) -> Option<&'a NameBinding<'a>> {
3300 if ident.is_path_segment_keyword() {
3301 // Make sure `self`, `super` etc produce an error when passed to here.
3304 self.extern_prelude.get(&ident.normalize_to_macros_2_0()).cloned().and_then(|entry| {
3305 if let Some(binding) = entry.extern_crate_item {
3306 if !speculative && entry.introduced_by_item {
3307 self.record_use(ident, binding, false);
3311 let crate_id = if !speculative {
3312 let Some(crate_id) =
3313 self.crate_loader.process_path_extern(ident.name, ident.span) else { return Some(self.dummy_binding); };
3316 self.crate_loader.maybe_process_path_extern(ident.name)?
3318 let crate_root = self.expect_module(crate_id.as_def_id());
3320 (crate_root, ty::Visibility::Public, DUMMY_SP, LocalExpnId::ROOT)
3321 .to_name_binding(self.arenas),
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(
3338 ) -> Result<(ast::Path, Res), ()> {
3339 let path = if path_str.starts_with("::") {
3342 segments: iter::once(Ident::with_dummy_span(kw::PathRoot))
3343 .chain(path_str.split("::").skip(1).map(Ident::from_str))
3344 .map(|i| self.new_ast_path_segment(i))
3353 .map(Ident::from_str)
3354 .map(|i| self.new_ast_path_segment(i))
3359 let module = self.expect_module(module_id);
3360 let parent_scope = &ParentScope::module(module, self);
3361 let res = self.resolve_ast_path(&path, ns, parent_scope).map_err(|_| ())?;
3365 // Resolve a path passed from rustdoc or HIR lowering.
3366 fn resolve_ast_path(
3370 parent_scope: &ParentScope<'a>,
3371 ) -> Result<Res, (Span, ResolutionError<'a>)> {
3372 match self.resolve_path(
3373 &Segment::from_path(path),
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())
3384 PathResult::NonModule(..) => Err((
3386 ResolutionError::FailedToResolve {
3387 label: String::from("type-relative paths are not supported in this context"),
3391 PathResult::Module(..) | PathResult::Indeterminate => unreachable!(),
3392 PathResult::Failed { span, label, suggestion, .. } => {
3393 Err((span, ResolutionError::FailedToResolve { label, suggestion }))
3398 fn new_ast_path_segment(&mut self, ident: Ident) -> ast::PathSegment {
3399 let mut seg = ast::PathSegment::from_ident(ident);
3400 seg.id = self.next_node_id();
3405 pub fn graph_root(&self) -> Module<'a> {
3410 pub fn all_macros(&self) -> &FxHashMap<Symbol, Res> {
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()
3420 self.cstore().module_children_untracked(def_id, self.session)
3424 /// Retrieves the span of the given `DefId` if `DefId` is in the local crate.
3426 pub fn opt_span(&self, def_id: DefId) -> Option<Span> {
3427 def_id.as_local().map(|def_id| self.definitions.def_span(def_id))
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() {
3441 let partial_res = self.partial_res_map.get(&expr.id)?;
3442 if partial_res.unresolved_segments() != 0 {
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() {
3454 if let Some(v) = self.legacy_const_generic_args.get(&def_id) {
3460 .item_attrs_untracked(def_id, self.session)
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"),
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()));
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);
3482 let name_binding = match self.resolve_ident_in_module(
3483 ModuleOrUniformRoot::Module(module),
3490 Ok(name_binding) => name_binding,
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 {
3498 self.record_use(ident, name_binding, false);
3500 self.main_def = Some(MainDefinition { res, is_import, span });
3504 fn names_to_string(names: &[Symbol]) -> String {
3505 let mut result = String::new();
3506 for (i, name) in names.iter().filter(|name| **name != kw::PathRoot).enumerate() {
3508 result.push_str("::");
3510 if Ident::with_dummy_span(*name).is_raw_guess() {
3511 result.push_str("r#");
3513 result.push_str(name.as_str());
3518 fn path_names_to_string(path: &Path) -> String {
3519 names_to_string(&path.segments.iter().map(|seg| seg.ident.name).collect::<Vec<_>>())
3522 /// A somewhat inefficient routine to obtain the name of a module.
3523 fn module_to_string(module: Module<'_>) -> Option<String> {
3524 let mut names = Vec::new();
3526 fn collect_mod(names: &mut Vec<Symbol>, module: Module<'_>) {
3527 if let ModuleKind::Def(.., name) = module.kind {
3528 if let Some(parent) = module.parent {
3530 collect_mod(names, parent);
3533 names.push(Symbol::intern("<opaque>"));
3534 collect_mod(names, module.parent.unwrap());
3537 collect_mod(&mut names, module);
3539 if names.is_empty() {
3543 Some(names_to_string(&names))
3546 #[derive(Copy, Clone, Debug)]
3548 /// Do not issue the lint.
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.
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
3559 UsePath { root_id: NodeId, root_span: Span },
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 },
3568 fn node_id(&self) -> Option<NodeId> {
3570 CrateLint::No => None,
3571 CrateLint::SimplePath(id)
3572 | CrateLint::UsePath { root_id: id, .. }
3573 | CrateLint::QPathTrait { qpath_id: id, .. } => Some(id),
3578 pub fn provide(providers: &mut Providers) {
3579 late::lifetimes::provide(providers);