1 #![doc(html_root_url = "https://doc.rust-lang.org/nightly/")]
3 #![feature(crate_visibility_modifier)]
4 #![feature(label_break_value)]
5 #![feature(rustc_diagnostic_macros)]
6 #![feature(slice_sort_by_cached_key)]
8 #![recursion_limit="256"]
10 #![deny(rust_2018_idioms)]
12 use rustc_errors as errors;
14 pub use rustc::hir::def::{Namespace, PerNS};
16 use GenericParameters::*;
19 use rustc::hir::map::{Definitions, DefCollector};
20 use rustc::hir::{self, PrimTy, Bool, Char, Float, Int, Uint, Str};
21 use rustc::middle::cstore::CrateStore;
22 use rustc::session::Session;
24 use rustc::hir::def::*;
25 use rustc::hir::def::Namespace::*;
26 use rustc::hir::def_id::{CRATE_DEF_INDEX, LOCAL_CRATE, DefId};
27 use rustc::hir::{Freevar, FreevarMap, TraitCandidate, TraitMap, GlobMap};
29 use rustc::util::nodemap::{NodeMap, NodeSet, FxHashMap, FxHashSet, DefIdMap};
30 use rustc::{bug, span_bug};
32 use rustc_metadata::creader::CrateLoader;
33 use rustc_metadata::cstore::CStore;
35 use syntax::source_map::SourceMap;
36 use syntax::ext::hygiene::{Mark, Transparency, SyntaxContext};
37 use syntax::ast::{self, Name, NodeId, Ident, FloatTy, IntTy, UintTy};
38 use syntax::ext::base::SyntaxExtension;
39 use syntax::ext::base::Determinacy::{self, Determined, Undetermined};
40 use syntax::ext::base::MacroKind;
41 use syntax::symbol::{Symbol, keywords};
42 use syntax::util::lev_distance::find_best_match_for_name;
44 use syntax::visit::{self, FnKind, Visitor};
46 use syntax::ast::{CRATE_NODE_ID, Arm, IsAsync, BindingMode, Block, Crate, Expr, ExprKind};
47 use syntax::ast::{FnDecl, ForeignItem, ForeignItemKind, GenericParamKind, Generics};
48 use syntax::ast::{Item, ItemKind, ImplItem, ImplItemKind};
49 use syntax::ast::{Label, Local, Mutability, Pat, PatKind, Path};
50 use syntax::ast::{QSelf, TraitItemKind, TraitRef, Ty, TyKind};
52 use syntax::{span_err, struct_span_err, unwrap_or, walk_list};
54 use syntax_pos::{BytePos, Span, DUMMY_SP, MultiSpan};
55 use errors::{Applicability, DiagnosticBuilder, DiagnosticId};
59 use std::cell::{Cell, RefCell};
60 use std::{cmp, fmt, iter, mem, ptr};
61 use std::collections::BTreeSet;
62 use std::mem::replace;
63 use rustc_data_structures::ptr_key::PtrKey;
64 use rustc_data_structures::sync::Lrc;
66 use resolve_imports::{ImportDirective, ImportDirectiveSubclass, NameResolution, ImportResolver};
67 use macros::{InvocationData, LegacyBinding, ParentScope};
69 // N.B., this module needs to be declared first so diagnostics are
70 // registered before they are used.
75 mod build_reduced_graph;
78 fn is_known_tool(name: Name) -> bool {
79 ["clippy", "rustfmt"].contains(&&*name.as_str())
89 AbsolutePath(Namespace),
94 /// A free importable items suggested in case of resolution failure.
95 struct ImportSuggestion {
99 /// A field or associated item from self type suggested in case of resolution failure.
100 enum AssocSuggestion {
107 struct BindingError {
109 origin: BTreeSet<Span>,
110 target: BTreeSet<Span>,
113 struct TypoSuggestion {
116 /// The kind of the binding ("crate", "module", etc.)
119 /// An appropriate article to refer to the binding ("a", "an", etc.)
120 article: &'static str,
123 impl PartialOrd for BindingError {
124 fn partial_cmp(&self, other: &BindingError) -> Option<cmp::Ordering> {
125 Some(self.cmp(other))
129 impl PartialEq for BindingError {
130 fn eq(&self, other: &BindingError) -> bool {
131 self.name == other.name
135 impl Ord for BindingError {
136 fn cmp(&self, other: &BindingError) -> cmp::Ordering {
137 self.name.cmp(&other.name)
141 enum ResolutionError<'a> {
142 /// error E0401: can't use type or const parameters from outer function
143 GenericParamsFromOuterFunction(Def),
144 /// error E0403: the name is already used for a type/const parameter in this list of
145 /// generic parameters
146 NameAlreadyUsedInParameterList(Name, &'a Span),
147 /// error E0407: method is not a member of trait
148 MethodNotMemberOfTrait(Name, &'a str),
149 /// error E0437: type is not a member of trait
150 TypeNotMemberOfTrait(Name, &'a str),
151 /// error E0438: const is not a member of trait
152 ConstNotMemberOfTrait(Name, &'a str),
153 /// error E0408: variable `{}` is not bound in all patterns
154 VariableNotBoundInPattern(&'a BindingError),
155 /// error E0409: variable `{}` is bound in inconsistent ways within the same match arm
156 VariableBoundWithDifferentMode(Name, Span),
157 /// error E0415: identifier is bound more than once in this parameter list
158 IdentifierBoundMoreThanOnceInParameterList(&'a str),
159 /// error E0416: identifier is bound more than once in the same pattern
160 IdentifierBoundMoreThanOnceInSamePattern(&'a str),
161 /// error E0426: use of undeclared label
162 UndeclaredLabel(&'a str, Option<Name>),
163 /// error E0429: `self` imports are only allowed within a { } list
164 SelfImportsOnlyAllowedWithin,
165 /// error E0430: `self` import can only appear once in the list
166 SelfImportCanOnlyAppearOnceInTheList,
167 /// error E0431: `self` import can only appear in an import list with a non-empty prefix
168 SelfImportOnlyInImportListWithNonEmptyPrefix,
169 /// error E0433: failed to resolve
170 FailedToResolve(&'a str),
171 /// error E0434: can't capture dynamic environment in a fn item
172 CannotCaptureDynamicEnvironmentInFnItem,
173 /// error E0435: attempt to use a non-constant value in a constant
174 AttemptToUseNonConstantValueInConstant,
175 /// error E0530: X bindings cannot shadow Ys
176 BindingShadowsSomethingUnacceptable(&'a str, Name, &'a NameBinding<'a>),
177 /// error E0128: type parameters with a default cannot use forward declared identifiers
178 ForwardDeclaredTyParam, // FIXME(const_generics:defaults)
181 /// Combines an error with provided span and emits it
183 /// This takes the error provided, combines it with the span and any additional spans inside the
184 /// error and emits it.
185 fn resolve_error<'sess, 'a>(resolver: &'sess Resolver<'_>,
187 resolution_error: ResolutionError<'a>) {
188 resolve_struct_error(resolver, span, resolution_error).emit();
191 fn resolve_struct_error<'sess, 'a>(resolver: &'sess Resolver<'_>,
193 resolution_error: ResolutionError<'a>)
194 -> DiagnosticBuilder<'sess> {
195 match resolution_error {
196 ResolutionError::GenericParamsFromOuterFunction(outer_def) => {
197 let mut err = struct_span_err!(resolver.session,
200 "can't use generic parameters from outer function",
202 err.span_label(span, format!("use of generic parameter from outer function"));
204 let cm = resolver.session.source_map();
206 Def::SelfTy(maybe_trait_defid, maybe_impl_defid) => {
207 if let Some(impl_span) = maybe_impl_defid.and_then(|def_id| {
208 resolver.definitions.opt_span(def_id)
211 reduce_impl_span_to_impl_keyword(cm, impl_span),
212 "`Self` type implicitly declared here, by this `impl`",
215 match (maybe_trait_defid, maybe_impl_defid) {
217 err.span_label(span, "can't use `Self` here");
220 err.span_label(span, "use a type here instead");
222 (None, None) => bug!("`impl` without trait nor type?"),
226 Def::TyParam(def_id) => {
227 if let Some(span) = resolver.definitions.opt_span(def_id) {
228 err.span_label(span, "type variable from outer function");
231 Def::ConstParam(def_id) => {
232 if let Some(span) = resolver.definitions.opt_span(def_id) {
233 err.span_label(span, "const variable from outer function");
237 bug!("GenericParamsFromOuterFunction should only be used with Def::SelfTy, \
242 // Try to retrieve the span of the function signature and generate a new message with
243 // a local type or const parameter.
244 let sugg_msg = &format!("try using a local generic parameter instead");
245 if let Some((sugg_span, new_snippet)) = cm.generate_local_type_param_snippet(span) {
246 // Suggest the modification to the user
251 Applicability::MachineApplicable,
253 } else if let Some(sp) = cm.generate_fn_name_span(span) {
255 format!("try adding a local generic parameter in this method instead"));
257 err.help(&format!("try using a local generic parameter instead"));
262 ResolutionError::NameAlreadyUsedInParameterList(name, first_use_span) => {
263 let mut err = struct_span_err!(resolver.session,
266 "the name `{}` is already used for a generic \
267 parameter in this list of generic parameters",
269 err.span_label(span, "already used");
270 err.span_label(first_use_span.clone(), format!("first use of `{}`", name));
273 ResolutionError::MethodNotMemberOfTrait(method, trait_) => {
274 let mut err = struct_span_err!(resolver.session,
277 "method `{}` is not a member of trait `{}`",
280 err.span_label(span, format!("not a member of trait `{}`", trait_));
283 ResolutionError::TypeNotMemberOfTrait(type_, trait_) => {
284 let mut err = struct_span_err!(resolver.session,
287 "type `{}` is not a member of trait `{}`",
290 err.span_label(span, format!("not a member of trait `{}`", trait_));
293 ResolutionError::ConstNotMemberOfTrait(const_, trait_) => {
294 let mut err = struct_span_err!(resolver.session,
297 "const `{}` is not a member of trait `{}`",
300 err.span_label(span, format!("not a member of trait `{}`", trait_));
303 ResolutionError::VariableNotBoundInPattern(binding_error) => {
304 let target_sp = binding_error.target.iter().cloned().collect::<Vec<_>>();
305 let msp = MultiSpan::from_spans(target_sp.clone());
306 let msg = format!("variable `{}` is not bound in all patterns", binding_error.name);
307 let mut err = resolver.session.struct_span_err_with_code(
310 DiagnosticId::Error("E0408".into()),
312 for sp in target_sp {
313 err.span_label(sp, format!("pattern doesn't bind `{}`", binding_error.name));
315 let origin_sp = binding_error.origin.iter().cloned();
316 for sp in origin_sp {
317 err.span_label(sp, "variable not in all patterns");
321 ResolutionError::VariableBoundWithDifferentMode(variable_name,
322 first_binding_span) => {
323 let mut err = struct_span_err!(resolver.session,
326 "variable `{}` is bound in inconsistent \
327 ways within the same match arm",
329 err.span_label(span, "bound in different ways");
330 err.span_label(first_binding_span, "first binding");
333 ResolutionError::IdentifierBoundMoreThanOnceInParameterList(identifier) => {
334 let mut err = struct_span_err!(resolver.session,
337 "identifier `{}` is bound more than once in this parameter list",
339 err.span_label(span, "used as parameter more than once");
342 ResolutionError::IdentifierBoundMoreThanOnceInSamePattern(identifier) => {
343 let mut err = struct_span_err!(resolver.session,
346 "identifier `{}` is bound more than once in the same pattern",
348 err.span_label(span, "used in a pattern more than once");
351 ResolutionError::UndeclaredLabel(name, lev_candidate) => {
352 let mut err = struct_span_err!(resolver.session,
355 "use of undeclared label `{}`",
357 if let Some(lev_candidate) = lev_candidate {
358 err.span_label(span, format!("did you mean `{}`?", lev_candidate));
360 err.span_label(span, format!("undeclared label `{}`", name));
364 ResolutionError::SelfImportsOnlyAllowedWithin => {
365 struct_span_err!(resolver.session,
369 "`self` imports are only allowed within a { } list")
371 ResolutionError::SelfImportCanOnlyAppearOnceInTheList => {
372 let mut err = struct_span_err!(resolver.session, span, E0430,
373 "`self` import can only appear once in an import list");
374 err.span_label(span, "can only appear once in an import list");
377 ResolutionError::SelfImportOnlyInImportListWithNonEmptyPrefix => {
378 let mut err = struct_span_err!(resolver.session, span, E0431,
379 "`self` import can only appear in an import list with \
380 a non-empty prefix");
381 err.span_label(span, "can only appear in an import list with a non-empty prefix");
384 ResolutionError::FailedToResolve(msg) => {
385 let mut err = struct_span_err!(resolver.session, span, E0433,
386 "failed to resolve: {}", msg);
387 err.span_label(span, msg);
390 ResolutionError::CannotCaptureDynamicEnvironmentInFnItem => {
391 let mut err = struct_span_err!(resolver.session,
395 "can't capture dynamic environment in a fn item");
396 err.help("use the `|| { ... }` closure form instead");
399 ResolutionError::AttemptToUseNonConstantValueInConstant => {
400 let mut err = struct_span_err!(resolver.session, span, E0435,
401 "attempt to use a non-constant value in a constant");
402 err.span_label(span, "non-constant value");
405 ResolutionError::BindingShadowsSomethingUnacceptable(what_binding, name, binding) => {
406 let shadows_what = binding.descr();
407 let mut err = struct_span_err!(resolver.session, span, E0530, "{}s cannot shadow {}s",
408 what_binding, shadows_what);
409 err.span_label(span, format!("cannot be named the same as {} {}",
410 binding.article(), shadows_what));
411 let participle = if binding.is_import() { "imported" } else { "defined" };
412 let msg = format!("the {} `{}` is {} here", shadows_what, name, participle);
413 err.span_label(binding.span, msg);
416 ResolutionError::ForwardDeclaredTyParam => {
417 let mut err = struct_span_err!(resolver.session, span, E0128,
418 "type parameters with a default cannot use \
419 forward declared identifiers");
421 span, "defaulted type parameters cannot be forward declared".to_string());
427 /// Adjust the impl span so that just the `impl` keyword is taken by removing
428 /// everything after `<` (`"impl<T> Iterator for A<T> {}" -> "impl"`) and
429 /// everything after the first whitespace (`"impl Iterator for A" -> "impl"`)
431 /// Attention: The method used is very fragile since it essentially duplicates the work of the
432 /// parser. If you need to use this function or something similar, please consider updating the
433 /// source_map functions and this function to something more robust.
434 fn reduce_impl_span_to_impl_keyword(cm: &SourceMap, impl_span: Span) -> Span {
435 let impl_span = cm.span_until_char(impl_span, '<');
436 let impl_span = cm.span_until_whitespace(impl_span);
440 #[derive(Copy, Clone, Debug)]
443 binding_mode: BindingMode,
446 /// Map from the name in a pattern to its binding mode.
447 type BindingMap = FxHashMap<Ident, BindingInfo>;
449 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
460 fn descr(self) -> &'static str {
462 PatternSource::Match => "match binding",
463 PatternSource::IfLet => "if let binding",
464 PatternSource::WhileLet => "while let binding",
465 PatternSource::Let => "let binding",
466 PatternSource::For => "for binding",
467 PatternSource::FnParam => "function parameter",
472 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
473 enum AliasPossibility {
478 #[derive(Copy, Clone, Debug)]
479 enum PathSource<'a> {
480 // Type paths `Path`.
482 // Trait paths in bounds or impls.
483 Trait(AliasPossibility),
484 // Expression paths `path`, with optional parent context.
485 Expr(Option<&'a Expr>),
486 // Paths in path patterns `Path`.
488 // Paths in struct expressions and patterns `Path { .. }`.
490 // Paths in tuple struct patterns `Path(..)`.
492 // `m::A::B` in `<T as m::A>::B::C`.
493 TraitItem(Namespace),
494 // Path in `pub(path)`
498 impl<'a> PathSource<'a> {
499 fn namespace(self) -> Namespace {
501 PathSource::Type | PathSource::Trait(_) | PathSource::Struct |
502 PathSource::Visibility => TypeNS,
503 PathSource::Expr(..) | PathSource::Pat | PathSource::TupleStruct => ValueNS,
504 PathSource::TraitItem(ns) => ns,
508 fn global_by_default(self) -> bool {
510 PathSource::Visibility => true,
511 PathSource::Type | PathSource::Expr(..) | PathSource::Pat |
512 PathSource::Struct | PathSource::TupleStruct |
513 PathSource::Trait(_) | PathSource::TraitItem(..) => false,
517 fn defer_to_typeck(self) -> bool {
519 PathSource::Type | PathSource::Expr(..) | PathSource::Pat |
520 PathSource::Struct | PathSource::TupleStruct => true,
521 PathSource::Trait(_) | PathSource::TraitItem(..) |
522 PathSource::Visibility => false,
526 fn descr_expected(self) -> &'static str {
528 PathSource::Type => "type",
529 PathSource::Trait(_) => "trait",
530 PathSource::Pat => "unit struct/variant or constant",
531 PathSource::Struct => "struct, variant or union type",
532 PathSource::TupleStruct => "tuple struct/variant",
533 PathSource::Visibility => "module",
534 PathSource::TraitItem(ns) => match ns {
535 TypeNS => "associated type",
536 ValueNS => "method or associated constant",
537 MacroNS => bug!("associated macro"),
539 PathSource::Expr(parent) => match parent.map(|p| &p.node) {
540 // "function" here means "anything callable" rather than `Def::Fn`,
541 // this is not precise but usually more helpful than just "value".
542 Some(&ExprKind::Call(..)) => "function",
548 fn is_expected(self, def: Def) -> bool {
550 PathSource::Type => match def {
551 Def::Struct(..) | Def::Union(..) | Def::Enum(..) |
552 Def::Trait(..) | Def::TraitAlias(..) | Def::TyAlias(..) |
553 Def::AssociatedTy(..) | Def::PrimTy(..) | Def::TyParam(..) |
554 Def::SelfTy(..) | Def::Existential(..) | Def::ForeignTy(..) => true,
557 PathSource::Trait(AliasPossibility::No) => match def {
558 Def::Trait(..) => true,
561 PathSource::Trait(AliasPossibility::Maybe) => match def {
562 Def::Trait(..) => true,
563 Def::TraitAlias(..) => true,
566 PathSource::Expr(..) => match def {
567 Def::StructCtor(_, CtorKind::Const) | Def::StructCtor(_, CtorKind::Fn) |
568 Def::VariantCtor(_, CtorKind::Const) | Def::VariantCtor(_, CtorKind::Fn) |
569 Def::Const(..) | Def::Static(..) | Def::Local(..) | Def::Upvar(..) |
570 Def::Fn(..) | Def::Method(..) | Def::AssociatedConst(..) |
571 Def::SelfCtor(..) | Def::ConstParam(..) => true,
574 PathSource::Pat => match def {
575 Def::StructCtor(_, CtorKind::Const) |
576 Def::VariantCtor(_, CtorKind::Const) |
577 Def::Const(..) | Def::AssociatedConst(..) |
578 Def::SelfCtor(..) => true,
581 PathSource::TupleStruct => match def {
582 Def::StructCtor(_, CtorKind::Fn) |
583 Def::VariantCtor(_, CtorKind::Fn) |
584 Def::SelfCtor(..) => true,
587 PathSource::Struct => match def {
588 Def::Struct(..) | Def::Union(..) | Def::Variant(..) |
589 Def::TyAlias(..) | Def::AssociatedTy(..) | Def::SelfTy(..) => true,
592 PathSource::TraitItem(ns) => match def {
593 Def::AssociatedConst(..) | Def::Method(..) if ns == ValueNS => true,
594 Def::AssociatedTy(..) if ns == TypeNS => true,
597 PathSource::Visibility => match def {
598 Def::Mod(..) => true,
604 fn error_code(self, has_unexpected_resolution: bool) -> &'static str {
605 __diagnostic_used!(E0404);
606 __diagnostic_used!(E0405);
607 __diagnostic_used!(E0412);
608 __diagnostic_used!(E0422);
609 __diagnostic_used!(E0423);
610 __diagnostic_used!(E0425);
611 __diagnostic_used!(E0531);
612 __diagnostic_used!(E0532);
613 __diagnostic_used!(E0573);
614 __diagnostic_used!(E0574);
615 __diagnostic_used!(E0575);
616 __diagnostic_used!(E0576);
617 __diagnostic_used!(E0577);
618 __diagnostic_used!(E0578);
619 match (self, has_unexpected_resolution) {
620 (PathSource::Trait(_), true) => "E0404",
621 (PathSource::Trait(_), false) => "E0405",
622 (PathSource::Type, true) => "E0573",
623 (PathSource::Type, false) => "E0412",
624 (PathSource::Struct, true) => "E0574",
625 (PathSource::Struct, false) => "E0422",
626 (PathSource::Expr(..), true) => "E0423",
627 (PathSource::Expr(..), false) => "E0425",
628 (PathSource::Pat, true) | (PathSource::TupleStruct, true) => "E0532",
629 (PathSource::Pat, false) | (PathSource::TupleStruct, false) => "E0531",
630 (PathSource::TraitItem(..), true) => "E0575",
631 (PathSource::TraitItem(..), false) => "E0576",
632 (PathSource::Visibility, true) => "E0577",
633 (PathSource::Visibility, false) => "E0578",
638 // A minimal representation of a path segment. We use this in resolve because
639 // we synthesize 'path segments' which don't have the rest of an AST or HIR
641 #[derive(Clone, Copy, Debug)]
648 fn from_path(path: &Path) -> Vec<Segment> {
649 path.segments.iter().map(|s| s.into()).collect()
652 fn from_ident(ident: Ident) -> Segment {
659 fn names_to_string(segments: &[Segment]) -> String {
660 names_to_string(&segments.iter()
661 .map(|seg| seg.ident)
662 .collect::<Vec<_>>())
666 impl<'a> From<&'a ast::PathSegment> for Segment {
667 fn from(seg: &'a ast::PathSegment) -> Segment {
675 struct UsePlacementFinder {
676 target_module: NodeId,
681 impl UsePlacementFinder {
682 fn check(krate: &Crate, target_module: NodeId) -> (Option<Span>, bool) {
683 let mut finder = UsePlacementFinder {
688 visit::walk_crate(&mut finder, krate);
689 (finder.span, finder.found_use)
693 impl<'tcx> Visitor<'tcx> for UsePlacementFinder {
696 module: &'tcx ast::Mod,
698 _: &[ast::Attribute],
701 if self.span.is_some() {
704 if node_id != self.target_module {
705 visit::walk_mod(self, module);
708 // find a use statement
709 for item in &module.items {
711 ItemKind::Use(..) => {
712 // don't suggest placing a use before the prelude
713 // import or other generated ones
714 if item.span.ctxt().outer().expn_info().is_none() {
715 self.span = Some(item.span.shrink_to_lo());
716 self.found_use = true;
720 // don't place use before extern crate
721 ItemKind::ExternCrate(_) => {}
722 // but place them before the first other item
723 _ => if self.span.map_or(true, |span| item.span < span ) {
724 if item.span.ctxt().outer().expn_info().is_none() {
725 // don't insert between attributes and an item
726 if item.attrs.is_empty() {
727 self.span = Some(item.span.shrink_to_lo());
729 // find the first attribute on the item
730 for attr in &item.attrs {
731 if self.span.map_or(true, |span| attr.span < span) {
732 self.span = Some(attr.span.shrink_to_lo());
743 /// This thing walks the whole crate in DFS manner, visiting each item, resolving names as it goes.
744 impl<'a, 'tcx> Visitor<'tcx> for Resolver<'a> {
745 fn visit_item(&mut self, item: &'tcx Item) {
746 self.resolve_item(item);
748 fn visit_arm(&mut self, arm: &'tcx Arm) {
749 self.resolve_arm(arm);
751 fn visit_block(&mut self, block: &'tcx Block) {
752 self.resolve_block(block);
754 fn visit_anon_const(&mut self, constant: &'tcx ast::AnonConst) {
755 debug!("visit_anon_const {:?}", constant);
756 self.with_constant_rib(|this| {
757 visit::walk_anon_const(this, constant);
760 fn visit_expr(&mut self, expr: &'tcx Expr) {
761 self.resolve_expr(expr, None);
763 fn visit_local(&mut self, local: &'tcx Local) {
764 self.resolve_local(local);
766 fn visit_ty(&mut self, ty: &'tcx Ty) {
768 TyKind::Path(ref qself, ref path) => {
769 self.smart_resolve_path(ty.id, qself.as_ref(), path, PathSource::Type);
771 TyKind::ImplicitSelf => {
772 let self_ty = keywords::SelfUpper.ident();
773 let def = self.resolve_ident_in_lexical_scope(self_ty, TypeNS, Some(ty.id), ty.span)
774 .map_or(Def::Err, |d| d.def());
775 self.record_def(ty.id, PathResolution::new(def));
779 visit::walk_ty(self, ty);
781 fn visit_poly_trait_ref(&mut self,
782 tref: &'tcx ast::PolyTraitRef,
783 m: &'tcx ast::TraitBoundModifier) {
784 self.smart_resolve_path(tref.trait_ref.ref_id, None,
785 &tref.trait_ref.path, PathSource::Trait(AliasPossibility::Maybe));
786 visit::walk_poly_trait_ref(self, tref, m);
788 fn visit_foreign_item(&mut self, foreign_item: &'tcx ForeignItem) {
789 let generic_params = match foreign_item.node {
790 ForeignItemKind::Fn(_, ref generics) => {
791 HasGenericParams(generics, ItemRibKind)
793 ForeignItemKind::Static(..) => NoGenericParams,
794 ForeignItemKind::Ty => NoGenericParams,
795 ForeignItemKind::Macro(..) => NoGenericParams,
797 self.with_generic_param_rib(generic_params, |this| {
798 visit::walk_foreign_item(this, foreign_item);
801 fn visit_fn(&mut self,
802 function_kind: FnKind<'tcx>,
803 declaration: &'tcx FnDecl,
807 debug!("(resolving function) entering function");
808 let (rib_kind, asyncness) = match function_kind {
809 FnKind::ItemFn(_, ref header, ..) =>
810 (ItemRibKind, header.asyncness),
811 FnKind::Method(_, ref sig, _, _) =>
812 (TraitOrImplItemRibKind, sig.header.asyncness),
813 FnKind::Closure(_) =>
814 // Async closures aren't resolved through `visit_fn`-- they're
815 // processed separately
816 (ClosureRibKind(node_id), IsAsync::NotAsync),
819 // Create a value rib for the function.
820 self.ribs[ValueNS].push(Rib::new(rib_kind));
822 // Create a label rib for the function.
823 self.label_ribs.push(Rib::new(rib_kind));
825 // Add each argument to the rib.
826 let mut bindings_list = FxHashMap::default();
827 for argument in &declaration.inputs {
828 self.resolve_pattern(&argument.pat, PatternSource::FnParam, &mut bindings_list);
830 self.visit_ty(&argument.ty);
832 debug!("(resolving function) recorded argument");
834 visit::walk_fn_ret_ty(self, &declaration.output);
836 // Resolve the function body, potentially inside the body of an async closure
837 if let IsAsync::Async { closure_id, .. } = asyncness {
838 let rib_kind = ClosureRibKind(closure_id);
839 self.ribs[ValueNS].push(Rib::new(rib_kind));
840 self.label_ribs.push(Rib::new(rib_kind));
843 match function_kind {
844 FnKind::ItemFn(.., body) |
845 FnKind::Method(.., body) => {
846 self.visit_block(body);
848 FnKind::Closure(body) => {
849 self.visit_expr(body);
853 // Leave the body of the async closure
854 if asyncness.is_async() {
855 self.label_ribs.pop();
856 self.ribs[ValueNS].pop();
859 debug!("(resolving function) leaving function");
861 self.label_ribs.pop();
862 self.ribs[ValueNS].pop();
865 fn visit_generics(&mut self, generics: &'tcx Generics) {
866 // For type parameter defaults, we have to ban access
867 // to following type parameters, as the Substs can only
868 // provide previous type parameters as they're built. We
869 // put all the parameters on the ban list and then remove
870 // them one by one as they are processed and become available.
871 let mut default_ban_rib = Rib::new(ForwardTyParamBanRibKind);
872 let mut found_default = false;
873 default_ban_rib.bindings.extend(generics.params.iter()
874 .filter_map(|param| match param.kind {
875 GenericParamKind::Const { .. } |
876 GenericParamKind::Lifetime { .. } => None,
877 GenericParamKind::Type { ref default, .. } => {
878 found_default |= default.is_some();
880 Some((Ident::with_empty_ctxt(param.ident.name), Def::Err))
887 for param in &generics.params {
889 GenericParamKind::Lifetime { .. } => self.visit_generic_param(param),
890 GenericParamKind::Type { ref default, .. } => {
891 for bound in ¶m.bounds {
892 self.visit_param_bound(bound);
895 if let Some(ref ty) = default {
896 self.ribs[TypeNS].push(default_ban_rib);
898 default_ban_rib = self.ribs[TypeNS].pop().unwrap();
901 // Allow all following defaults to refer to this type parameter.
902 default_ban_rib.bindings.remove(&Ident::with_empty_ctxt(param.ident.name));
904 GenericParamKind::Const { ref ty } => {
905 for bound in ¶m.bounds {
906 self.visit_param_bound(bound);
913 for p in &generics.where_clause.predicates {
914 self.visit_where_predicate(p);
919 #[derive(Copy, Clone)]
920 enum GenericParameters<'a, 'b> {
922 HasGenericParams(// Type parameters.
925 // The kind of the rib used for type parameters.
929 /// The rib kind controls the translation of local
930 /// definitions (`Def::Local`) to upvars (`Def::Upvar`).
931 #[derive(Copy, Clone, Debug)]
933 /// No translation needs to be applied.
936 /// We passed through a closure scope at the given node ID.
937 /// Translate upvars as appropriate.
938 ClosureRibKind(NodeId /* func id */),
940 /// We passed through an impl or trait and are now in one of its
941 /// methods or associated types. Allow references to ty params that impl or trait
942 /// binds. Disallow any other upvars (including other ty params that are
944 TraitOrImplItemRibKind,
946 /// We passed through an item scope. Disallow upvars.
949 /// We're in a constant item. Can't refer to dynamic stuff.
952 /// We passed through a module.
953 ModuleRibKind(Module<'a>),
955 /// We passed through a `macro_rules!` statement
956 MacroDefinition(DefId),
958 /// All bindings in this rib are type parameters that can't be used
959 /// from the default of a type parameter because they're not declared
960 /// before said type parameter. Also see the `visit_generics` override.
961 ForwardTyParamBanRibKind,
966 /// A rib represents a scope names can live in. Note that these appear in many places, not just
967 /// around braces. At any place where the list of accessible names (of the given namespace)
968 /// changes or a new restrictions on the name accessibility are introduced, a new rib is put onto a
969 /// stack. This may be, for example, a `let` statement (because it introduces variables), a macro,
972 /// Different [rib kinds](enum.RibKind) are transparent for different names.
974 /// The resolution keeps a separate stack of ribs as it traverses the AST for each namespace. When
975 /// resolving, the name is looked up from inside out.
978 bindings: FxHashMap<Ident, Def>,
983 fn new(kind: RibKind<'a>) -> Rib<'a> {
985 bindings: Default::default(),
991 /// An intermediate resolution result.
993 /// This refers to the thing referred by a name. The difference between `Def` and `Item` is that
994 /// items are visible in their whole block, while defs only from the place they are defined
996 enum LexicalScopeBinding<'a> {
997 Item(&'a NameBinding<'a>),
1001 impl<'a> LexicalScopeBinding<'a> {
1002 fn item(self) -> Option<&'a NameBinding<'a>> {
1004 LexicalScopeBinding::Item(binding) => Some(binding),
1009 fn def(self) -> Def {
1011 LexicalScopeBinding::Item(binding) => binding.def(),
1012 LexicalScopeBinding::Def(def) => def,
1017 #[derive(Copy, Clone, Debug)]
1018 enum ModuleOrUniformRoot<'a> {
1022 /// Virtual module that denotes resolution in crate root with fallback to extern prelude.
1023 CrateRootAndExternPrelude,
1025 /// Virtual module that denotes resolution in extern prelude.
1026 /// Used for paths starting with `::` on 2018 edition.
1029 /// Virtual module that denotes resolution in current scope.
1030 /// Used only for resolving single-segment imports. The reason it exists is that import paths
1031 /// are always split into two parts, the first of which should be some kind of module.
1035 impl ModuleOrUniformRoot<'_> {
1036 fn same_def(lhs: Self, rhs: Self) -> bool {
1038 (ModuleOrUniformRoot::Module(lhs),
1039 ModuleOrUniformRoot::Module(rhs)) => lhs.def() == rhs.def(),
1040 (ModuleOrUniformRoot::CrateRootAndExternPrelude,
1041 ModuleOrUniformRoot::CrateRootAndExternPrelude) |
1042 (ModuleOrUniformRoot::ExternPrelude, ModuleOrUniformRoot::ExternPrelude) |
1043 (ModuleOrUniformRoot::CurrentScope, ModuleOrUniformRoot::CurrentScope) => true,
1049 #[derive(Clone, Debug)]
1050 enum PathResult<'a> {
1051 Module(ModuleOrUniformRoot<'a>),
1052 NonModule(PathResolution),
1054 Failed(Span, String, bool /* is the error from the last segment? */),
1058 /// An anonymous module, eg. just a block.
1062 /// fn f() {} // (1)
1063 /// { // This is an anonymous module
1064 /// f(); // This resolves to (2) as we are inside the block.
1065 /// fn f() {} // (2)
1067 /// f(); // Resolves to (1)
1071 /// Any module with a name.
1075 /// * A normal module ‒ either `mod from_file;` or `mod from_block { }`.
1076 /// * A trait or an enum (it implicitly contains associated types, methods and variant
1081 /// One node in the tree of modules.
1082 pub struct ModuleData<'a> {
1083 parent: Option<Module<'a>>,
1086 // The def id of the closest normal module (`mod`) ancestor (including this module).
1087 normal_ancestor_id: DefId,
1089 resolutions: RefCell<FxHashMap<(Ident, Namespace), &'a RefCell<NameResolution<'a>>>>,
1090 single_segment_macro_resolutions: RefCell<Vec<(Ident, MacroKind, ParentScope<'a>,
1091 Option<&'a NameBinding<'a>>)>>,
1092 multi_segment_macro_resolutions: RefCell<Vec<(Vec<Segment>, Span, MacroKind, ParentScope<'a>,
1094 builtin_attrs: RefCell<Vec<(Ident, ParentScope<'a>)>>,
1096 // Macro invocations that can expand into items in this module.
1097 unresolved_invocations: RefCell<FxHashSet<Mark>>,
1099 no_implicit_prelude: bool,
1101 glob_importers: RefCell<Vec<&'a ImportDirective<'a>>>,
1102 globs: RefCell<Vec<&'a ImportDirective<'a>>>,
1104 // Used to memoize the traits in this module for faster searches through all traits in scope.
1105 traits: RefCell<Option<Box<[(Ident, &'a NameBinding<'a>)]>>>,
1107 // Whether this module is populated. If not populated, any attempt to
1108 // access the children must be preceded with a
1109 // `populate_module_if_necessary` call.
1110 populated: Cell<bool>,
1112 /// Span of the module itself. Used for error reporting.
1118 type Module<'a> = &'a ModuleData<'a>;
1120 impl<'a> ModuleData<'a> {
1121 fn new(parent: Option<Module<'a>>,
1123 normal_ancestor_id: DefId,
1125 span: Span) -> Self {
1130 resolutions: Default::default(),
1131 single_segment_macro_resolutions: RefCell::new(Vec::new()),
1132 multi_segment_macro_resolutions: RefCell::new(Vec::new()),
1133 builtin_attrs: RefCell::new(Vec::new()),
1134 unresolved_invocations: Default::default(),
1135 no_implicit_prelude: false,
1136 glob_importers: RefCell::new(Vec::new()),
1137 globs: RefCell::new(Vec::new()),
1138 traits: RefCell::new(None),
1139 populated: Cell::new(normal_ancestor_id.is_local()),
1145 fn for_each_child<F: FnMut(Ident, Namespace, &'a NameBinding<'a>)>(&self, mut f: F) {
1146 for (&(ident, ns), name_resolution) in self.resolutions.borrow().iter() {
1147 name_resolution.borrow().binding.map(|binding| f(ident, ns, binding));
1151 fn for_each_child_stable<F: FnMut(Ident, Namespace, &'a NameBinding<'a>)>(&self, mut f: F) {
1152 let resolutions = self.resolutions.borrow();
1153 let mut resolutions = resolutions.iter().collect::<Vec<_>>();
1154 resolutions.sort_by_cached_key(|&(&(ident, ns), _)| (ident.as_str(), ns));
1155 for &(&(ident, ns), &resolution) in resolutions.iter() {
1156 resolution.borrow().binding.map(|binding| f(ident, ns, binding));
1160 fn def(&self) -> Option<Def> {
1162 ModuleKind::Def(def, _) => Some(def),
1167 fn def_id(&self) -> Option<DefId> {
1168 self.def().as_ref().map(Def::def_id)
1171 // `self` resolves to the first module ancestor that `is_normal`.
1172 fn is_normal(&self) -> bool {
1174 ModuleKind::Def(Def::Mod(_), _) => true,
1179 fn is_trait(&self) -> bool {
1181 ModuleKind::Def(Def::Trait(_), _) => true,
1186 fn nearest_item_scope(&'a self) -> Module<'a> {
1187 if self.is_trait() { self.parent.unwrap() } else { self }
1190 fn is_ancestor_of(&self, mut other: &Self) -> bool {
1191 while !ptr::eq(self, other) {
1192 if let Some(parent) = other.parent {
1202 impl<'a> fmt::Debug for ModuleData<'a> {
1203 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1204 write!(f, "{:?}", self.def())
1208 /// Records a possibly-private value, type, or module definition.
1209 #[derive(Clone, Debug)]
1210 pub struct NameBinding<'a> {
1211 kind: NameBindingKind<'a>,
1212 ambiguity: Option<(&'a NameBinding<'a>, AmbiguityKind)>,
1215 vis: ty::Visibility,
1218 pub trait ToNameBinding<'a> {
1219 fn to_name_binding(self, arenas: &'a ResolverArenas<'a>) -> &'a NameBinding<'a>;
1222 impl<'a> ToNameBinding<'a> for &'a NameBinding<'a> {
1223 fn to_name_binding(self, _: &'a ResolverArenas<'a>) -> &'a NameBinding<'a> {
1228 #[derive(Clone, Debug)]
1229 enum NameBindingKind<'a> {
1230 Def(Def, /* is_macro_export */ bool),
1233 binding: &'a NameBinding<'a>,
1234 directive: &'a ImportDirective<'a>,
1239 impl<'a> NameBindingKind<'a> {
1240 /// Is this a name binding of a import?
1241 fn is_import(&self) -> bool {
1243 NameBindingKind::Import { .. } => true,
1249 struct PrivacyError<'a>(Span, Ident, &'a NameBinding<'a>);
1251 struct UseError<'a> {
1252 err: DiagnosticBuilder<'a>,
1253 /// Attach `use` statements for these candidates
1254 candidates: Vec<ImportSuggestion>,
1255 /// The node id of the module to place the use statements in
1257 /// Whether the diagnostic should state that it's "better"
1261 #[derive(Clone, Copy, PartialEq, Debug)]
1262 enum AmbiguityKind {
1267 LegacyHelperVsPrelude,
1272 MoreExpandedVsOuter,
1275 impl AmbiguityKind {
1276 fn descr(self) -> &'static str {
1278 AmbiguityKind::Import =>
1279 "name vs any other name during import resolution",
1280 AmbiguityKind::AbsolutePath =>
1281 "name in the crate root vs extern crate during absolute path resolution",
1282 AmbiguityKind::BuiltinAttr =>
1283 "built-in attribute vs any other name",
1284 AmbiguityKind::DeriveHelper =>
1285 "derive helper attribute vs any other name",
1286 AmbiguityKind::LegacyHelperVsPrelude =>
1287 "legacy plugin helper attribute vs name from prelude",
1288 AmbiguityKind::LegacyVsModern =>
1289 "`macro_rules` vs non-`macro_rules` from other module",
1290 AmbiguityKind::GlobVsOuter =>
1291 "glob import vs any other name from outer scope during import/macro resolution",
1292 AmbiguityKind::GlobVsGlob =>
1293 "glob import vs glob import in the same module",
1294 AmbiguityKind::GlobVsExpanded =>
1295 "glob import vs macro-expanded name in the same \
1296 module during import/macro resolution",
1297 AmbiguityKind::MoreExpandedVsOuter =>
1298 "macro-expanded name vs less macro-expanded name \
1299 from outer scope during import/macro resolution",
1304 /// Miscellaneous bits of metadata for better ambiguity error reporting.
1305 #[derive(Clone, Copy, PartialEq)]
1306 enum AmbiguityErrorMisc {
1313 struct AmbiguityError<'a> {
1314 kind: AmbiguityKind,
1316 b1: &'a NameBinding<'a>,
1317 b2: &'a NameBinding<'a>,
1318 misc1: AmbiguityErrorMisc,
1319 misc2: AmbiguityErrorMisc,
1322 impl<'a> NameBinding<'a> {
1323 fn module(&self) -> Option<Module<'a>> {
1325 NameBindingKind::Module(module) => Some(module),
1326 NameBindingKind::Import { binding, .. } => binding.module(),
1331 fn def(&self) -> Def {
1333 NameBindingKind::Def(def, _) => def,
1334 NameBindingKind::Module(module) => module.def().unwrap(),
1335 NameBindingKind::Import { binding, .. } => binding.def(),
1339 fn is_ambiguity(&self) -> bool {
1340 self.ambiguity.is_some() || match self.kind {
1341 NameBindingKind::Import { binding, .. } => binding.is_ambiguity(),
1346 // We sometimes need to treat variants as `pub` for backwards compatibility
1347 fn pseudo_vis(&self) -> ty::Visibility {
1348 if self.is_variant() && self.def().def_id().is_local() {
1349 ty::Visibility::Public
1355 fn is_variant(&self) -> bool {
1357 NameBindingKind::Def(Def::Variant(..), _) |
1358 NameBindingKind::Def(Def::VariantCtor(..), _) => true,
1363 fn is_extern_crate(&self) -> bool {
1365 NameBindingKind::Import {
1366 directive: &ImportDirective {
1367 subclass: ImportDirectiveSubclass::ExternCrate { .. }, ..
1370 NameBindingKind::Module(
1371 &ModuleData { kind: ModuleKind::Def(Def::Mod(def_id), _), .. }
1372 ) => def_id.index == CRATE_DEF_INDEX,
1377 fn is_import(&self) -> bool {
1379 NameBindingKind::Import { .. } => true,
1384 fn is_glob_import(&self) -> bool {
1386 NameBindingKind::Import { directive, .. } => directive.is_glob(),
1391 fn is_importable(&self) -> bool {
1393 Def::AssociatedConst(..) | Def::Method(..) | Def::AssociatedTy(..) => false,
1398 fn is_macro_def(&self) -> bool {
1400 NameBindingKind::Def(Def::Macro(..), _) => true,
1405 fn macro_kind(&self) -> Option<MacroKind> {
1407 Def::Macro(_, kind) => Some(kind),
1408 Def::NonMacroAttr(..) => Some(MacroKind::Attr),
1413 fn descr(&self) -> &'static str {
1414 if self.is_extern_crate() { "extern crate" } else { self.def().kind_name() }
1417 fn article(&self) -> &'static str {
1418 if self.is_extern_crate() { "an" } else { self.def().article() }
1421 // Suppose that we resolved macro invocation with `invoc_parent_expansion` to binding `binding`
1422 // at some expansion round `max(invoc, binding)` when they both emerged from macros.
1423 // Then this function returns `true` if `self` may emerge from a macro *after* that
1424 // in some later round and screw up our previously found resolution.
1425 // See more detailed explanation in
1426 // https://github.com/rust-lang/rust/pull/53778#issuecomment-419224049
1427 fn may_appear_after(&self, invoc_parent_expansion: Mark, binding: &NameBinding<'_>) -> bool {
1428 // self > max(invoc, binding) => !(self <= invoc || self <= binding)
1429 // Expansions are partially ordered, so "may appear after" is an inversion of
1430 // "certainly appears before or simultaneously" and includes unordered cases.
1431 let self_parent_expansion = self.expansion;
1432 let other_parent_expansion = binding.expansion;
1433 let certainly_before_other_or_simultaneously =
1434 other_parent_expansion.is_descendant_of(self_parent_expansion);
1435 let certainly_before_invoc_or_simultaneously =
1436 invoc_parent_expansion.is_descendant_of(self_parent_expansion);
1437 !(certainly_before_other_or_simultaneously || certainly_before_invoc_or_simultaneously)
1441 /// Interns the names of the primitive types.
1443 /// All other types are defined somewhere and possibly imported, but the primitive ones need
1444 /// special handling, since they have no place of origin.
1446 struct PrimitiveTypeTable {
1447 primitive_types: FxHashMap<Name, PrimTy>,
1450 impl PrimitiveTypeTable {
1451 fn new() -> PrimitiveTypeTable {
1452 let mut table = PrimitiveTypeTable::default();
1454 table.intern("bool", Bool);
1455 table.intern("char", Char);
1456 table.intern("f32", Float(FloatTy::F32));
1457 table.intern("f64", Float(FloatTy::F64));
1458 table.intern("isize", Int(IntTy::Isize));
1459 table.intern("i8", Int(IntTy::I8));
1460 table.intern("i16", Int(IntTy::I16));
1461 table.intern("i32", Int(IntTy::I32));
1462 table.intern("i64", Int(IntTy::I64));
1463 table.intern("i128", Int(IntTy::I128));
1464 table.intern("str", Str);
1465 table.intern("usize", Uint(UintTy::Usize));
1466 table.intern("u8", Uint(UintTy::U8));
1467 table.intern("u16", Uint(UintTy::U16));
1468 table.intern("u32", Uint(UintTy::U32));
1469 table.intern("u64", Uint(UintTy::U64));
1470 table.intern("u128", Uint(UintTy::U128));
1474 fn intern(&mut self, string: &str, primitive_type: PrimTy) {
1475 self.primitive_types.insert(Symbol::intern(string), primitive_type);
1479 #[derive(Debug, Default, Clone)]
1480 pub struct ExternPreludeEntry<'a> {
1481 extern_crate_item: Option<&'a NameBinding<'a>>,
1482 pub introduced_by_item: bool,
1485 /// The main resolver class.
1487 /// This is the visitor that walks the whole crate.
1488 pub struct Resolver<'a> {
1489 session: &'a Session,
1492 pub definitions: Definitions,
1494 graph_root: Module<'a>,
1496 prelude: Option<Module<'a>>,
1497 pub extern_prelude: FxHashMap<Ident, ExternPreludeEntry<'a>>,
1499 /// n.b. This is used only for better diagnostics, not name resolution itself.
1500 has_self: FxHashSet<DefId>,
1502 /// Names of fields of an item `DefId` accessible with dot syntax.
1503 /// Used for hints during error reporting.
1504 field_names: FxHashMap<DefId, Vec<Name>>,
1506 /// All imports known to succeed or fail.
1507 determined_imports: Vec<&'a ImportDirective<'a>>,
1509 /// All non-determined imports.
1510 indeterminate_imports: Vec<&'a ImportDirective<'a>>,
1512 /// The module that represents the current item scope.
1513 current_module: Module<'a>,
1515 /// The current set of local scopes for types and values.
1516 /// FIXME #4948: Reuse ribs to avoid allocation.
1517 ribs: PerNS<Vec<Rib<'a>>>,
1519 /// The current set of local scopes, for labels.
1520 label_ribs: Vec<Rib<'a>>,
1522 /// The trait that the current context can refer to.
1523 current_trait_ref: Option<(Module<'a>, TraitRef)>,
1525 /// The current self type if inside an impl (used for better errors).
1526 current_self_type: Option<Ty>,
1528 /// The current self item if inside an ADT (used for better errors).
1529 current_self_item: Option<NodeId>,
1531 /// FIXME: Refactor things so that these fields are passed through arguments and not resolver.
1532 /// We are resolving a last import segment during import validation.
1533 last_import_segment: bool,
1534 /// This binding should be ignored during in-module resolution, so that we don't get
1535 /// "self-confirming" import resolutions during import validation.
1536 blacklisted_binding: Option<&'a NameBinding<'a>>,
1538 /// The idents for the primitive types.
1539 primitive_type_table: PrimitiveTypeTable,
1542 import_map: ImportMap,
1543 pub freevars: FreevarMap,
1544 freevars_seen: NodeMap<NodeMap<usize>>,
1545 pub export_map: ExportMap,
1546 pub trait_map: TraitMap,
1548 /// A map from nodes to anonymous modules.
1549 /// Anonymous modules are pseudo-modules that are implicitly created around items
1550 /// contained within blocks.
1552 /// For example, if we have this:
1560 /// There will be an anonymous module created around `g` with the ID of the
1561 /// entry block for `f`.
1562 block_map: NodeMap<Module<'a>>,
1563 module_map: FxHashMap<DefId, Module<'a>>,
1564 extern_module_map: FxHashMap<(DefId, bool /* MacrosOnly? */), Module<'a>>,
1565 binding_parent_modules: FxHashMap<PtrKey<'a, NameBinding<'a>>, Module<'a>>,
1567 /// Maps glob imports to the names of items actually imported.
1568 pub glob_map: GlobMap,
1570 used_imports: FxHashSet<(NodeId, Namespace)>,
1571 pub maybe_unused_trait_imports: NodeSet,
1572 pub maybe_unused_extern_crates: Vec<(NodeId, Span)>,
1574 /// A list of labels as of yet unused. Labels will be removed from this map when
1575 /// they are used (in a `break` or `continue` statement)
1576 pub unused_labels: FxHashMap<NodeId, Span>,
1578 /// privacy errors are delayed until the end in order to deduplicate them
1579 privacy_errors: Vec<PrivacyError<'a>>,
1580 /// ambiguity errors are delayed for deduplication
1581 ambiguity_errors: Vec<AmbiguityError<'a>>,
1582 /// `use` injections are delayed for better placement and deduplication
1583 use_injections: Vec<UseError<'a>>,
1584 /// crate-local macro expanded `macro_export` referred to by a module-relative path
1585 macro_expanded_macro_export_errors: BTreeSet<(Span, Span)>,
1587 arenas: &'a ResolverArenas<'a>,
1588 dummy_binding: &'a NameBinding<'a>,
1590 crate_loader: &'a mut CrateLoader<'a>,
1591 macro_names: FxHashSet<Ident>,
1592 builtin_macros: FxHashMap<Name, &'a NameBinding<'a>>,
1593 macro_use_prelude: FxHashMap<Name, &'a NameBinding<'a>>,
1594 pub all_macros: FxHashMap<Name, Def>,
1595 macro_map: FxHashMap<DefId, Lrc<SyntaxExtension>>,
1596 macro_defs: FxHashMap<Mark, DefId>,
1597 local_macro_def_scopes: FxHashMap<NodeId, Module<'a>>,
1599 /// List of crate local macros that we need to warn about as being unused.
1600 /// Right now this only includes macro_rules! macros, and macros 2.0.
1601 unused_macros: FxHashSet<DefId>,
1603 /// Maps the `Mark` of an expansion to its containing module or block.
1604 invocations: FxHashMap<Mark, &'a InvocationData<'a>>,
1606 /// Avoid duplicated errors for "name already defined".
1607 name_already_seen: FxHashMap<Name, Span>,
1609 potentially_unused_imports: Vec<&'a ImportDirective<'a>>,
1611 /// This table maps struct IDs into struct constructor IDs,
1612 /// it's not used during normal resolution, only for better error reporting.
1613 struct_constructors: DefIdMap<(Def, ty::Visibility)>,
1615 /// Only used for better errors on `fn(): fn()`
1616 current_type_ascription: Vec<Span>,
1618 injected_crate: Option<Module<'a>>,
1621 /// Nothing really interesting here, it just provides memory for the rest of the crate.
1623 pub struct ResolverArenas<'a> {
1624 modules: arena::TypedArena<ModuleData<'a>>,
1625 local_modules: RefCell<Vec<Module<'a>>>,
1626 name_bindings: arena::TypedArena<NameBinding<'a>>,
1627 import_directives: arena::TypedArena<ImportDirective<'a>>,
1628 name_resolutions: arena::TypedArena<RefCell<NameResolution<'a>>>,
1629 invocation_data: arena::TypedArena<InvocationData<'a>>,
1630 legacy_bindings: arena::TypedArena<LegacyBinding<'a>>,
1633 impl<'a> ResolverArenas<'a> {
1634 fn alloc_module(&'a self, module: ModuleData<'a>) -> Module<'a> {
1635 let module = self.modules.alloc(module);
1636 if module.def_id().map(|def_id| def_id.is_local()).unwrap_or(true) {
1637 self.local_modules.borrow_mut().push(module);
1641 fn local_modules(&'a self) -> std::cell::Ref<'a, Vec<Module<'a>>> {
1642 self.local_modules.borrow()
1644 fn alloc_name_binding(&'a self, name_binding: NameBinding<'a>) -> &'a NameBinding<'a> {
1645 self.name_bindings.alloc(name_binding)
1647 fn alloc_import_directive(&'a self, import_directive: ImportDirective<'a>)
1648 -> &'a ImportDirective<'_> {
1649 self.import_directives.alloc(import_directive)
1651 fn alloc_name_resolution(&'a self) -> &'a RefCell<NameResolution<'a>> {
1652 self.name_resolutions.alloc(Default::default())
1654 fn alloc_invocation_data(&'a self, expansion_data: InvocationData<'a>)
1655 -> &'a InvocationData<'a> {
1656 self.invocation_data.alloc(expansion_data)
1658 fn alloc_legacy_binding(&'a self, binding: LegacyBinding<'a>) -> &'a LegacyBinding<'a> {
1659 self.legacy_bindings.alloc(binding)
1663 impl<'a, 'b: 'a> ty::DefIdTree for &'a Resolver<'b> {
1664 fn parent(self, id: DefId) -> Option<DefId> {
1666 LOCAL_CRATE => self.definitions.def_key(id.index).parent,
1667 _ => self.cstore.def_key(id).parent,
1668 }.map(|index| DefId { index, ..id })
1672 /// This interface is used through the AST→HIR step, to embed full paths into the HIR. After that
1673 /// the resolver is no longer needed as all the relevant information is inline.
1674 impl<'a> hir::lowering::Resolver for Resolver<'a> {
1675 fn resolve_hir_path(
1680 self.resolve_hir_path_cb(path, is_value,
1681 |resolver, span, error| resolve_error(resolver, span, error))
1684 fn resolve_str_path(
1687 crate_root: Option<&str>,
1688 components: &[&str],
1691 let segments = iter::once(keywords::PathRoot.ident())
1693 crate_root.into_iter()
1694 .chain(components.iter().cloned())
1695 .map(Ident::from_str)
1696 ).map(|i| self.new_ast_path_segment(i)).collect::<Vec<_>>();
1699 let path = ast::Path {
1704 self.resolve_hir_path(&path, is_value)
1707 fn get_resolution(&mut self, id: NodeId) -> Option<PathResolution> {
1708 self.def_map.get(&id).cloned()
1711 fn get_import(&mut self, id: NodeId) -> PerNS<Option<PathResolution>> {
1712 self.import_map.get(&id).cloned().unwrap_or_default()
1715 fn definitions(&mut self) -> &mut Definitions {
1716 &mut self.definitions
1720 impl<'a> Resolver<'a> {
1721 /// Rustdoc uses this to resolve things in a recoverable way. ResolutionError<'a>
1722 /// isn't something that can be returned because it can't be made to live that long,
1723 /// and also it's a private type. Fortunately rustdoc doesn't need to know the error,
1724 /// just that an error occurred.
1725 pub fn resolve_str_path_error(&mut self, span: Span, path_str: &str, is_value: bool)
1726 -> Result<hir::Path, ()> {
1728 let mut errored = false;
1730 let path = if path_str.starts_with("::") {
1733 segments: iter::once(keywords::PathRoot.ident())
1735 path_str.split("::").skip(1).map(Ident::from_str)
1737 .map(|i| self.new_ast_path_segment(i))
1745 .map(Ident::from_str)
1746 .map(|i| self.new_ast_path_segment(i))
1750 let path = self.resolve_hir_path_cb(&path, is_value, |_, _, _| errored = true);
1751 if errored || path.def == Def::Err {
1758 /// Like `resolve_hir_path`, but takes a callback in case there was an error.
1759 fn resolve_hir_path_cb<F>(
1765 where F: for<'c, 'b> FnOnce(&'c mut Resolver<'_>, Span, ResolutionError<'b>)
1767 let namespace = if is_value { ValueNS } else { TypeNS };
1768 let span = path.span;
1769 let segments = &path.segments;
1770 let path = Segment::from_path(&path);
1771 // FIXME(Manishearth): intra-doc links won't get warned of epoch changes.
1772 let def = match self.resolve_path_without_parent_scope(&path, Some(namespace), true,
1773 span, CrateLint::No) {
1774 PathResult::Module(ModuleOrUniformRoot::Module(module)) =>
1775 module.def().unwrap(),
1776 PathResult::NonModule(path_res) if path_res.unresolved_segments() == 0 =>
1777 path_res.base_def(),
1778 PathResult::NonModule(..) => {
1779 let msg = "type-relative paths are not supported in this context";
1780 error_callback(self, span, ResolutionError::FailedToResolve(msg));
1783 PathResult::Module(..) | PathResult::Indeterminate => unreachable!(),
1784 PathResult::Failed(span, msg, _) => {
1785 error_callback(self, span, ResolutionError::FailedToResolve(&msg));
1790 let segments: Vec<_> = segments.iter().map(|seg| {
1791 let mut hir_seg = hir::PathSegment::from_ident(seg.ident);
1792 hir_seg.def = Some(self.def_map.get(&seg.id).map_or(Def::Err, |p| p.base_def()));
1798 segments: segments.into(),
1802 fn new_ast_path_segment(&self, ident: Ident) -> ast::PathSegment {
1803 let mut seg = ast::PathSegment::from_ident(ident);
1804 seg.id = self.session.next_node_id();
1809 impl<'a> Resolver<'a> {
1810 pub fn new(session: &'a Session,
1814 crate_loader: &'a mut CrateLoader<'a>,
1815 arenas: &'a ResolverArenas<'a>)
1817 let root_def_id = DefId::local(CRATE_DEF_INDEX);
1818 let root_module_kind = ModuleKind::Def(Def::Mod(root_def_id), keywords::Invalid.name());
1819 let graph_root = arenas.alloc_module(ModuleData {
1820 no_implicit_prelude: attr::contains_name(&krate.attrs, "no_implicit_prelude"),
1821 ..ModuleData::new(None, root_module_kind, root_def_id, Mark::root(), krate.span)
1823 let mut module_map = FxHashMap::default();
1824 module_map.insert(DefId::local(CRATE_DEF_INDEX), graph_root);
1826 let mut definitions = Definitions::new();
1827 DefCollector::new(&mut definitions, Mark::root())
1828 .collect_root(crate_name, session.local_crate_disambiguator());
1830 let mut extern_prelude: FxHashMap<Ident, ExternPreludeEntry<'_>> =
1831 session.opts.externs.iter().map(|kv| (Ident::from_str(kv.0), Default::default()))
1834 if !attr::contains_name(&krate.attrs, "no_core") {
1835 extern_prelude.insert(Ident::from_str("core"), Default::default());
1836 if !attr::contains_name(&krate.attrs, "no_std") {
1837 extern_prelude.insert(Ident::from_str("std"), Default::default());
1838 if session.rust_2018() {
1839 extern_prelude.insert(Ident::from_str("meta"), Default::default());
1844 let mut invocations = FxHashMap::default();
1845 invocations.insert(Mark::root(),
1846 arenas.alloc_invocation_data(InvocationData::root(graph_root)));
1848 let mut macro_defs = FxHashMap::default();
1849 macro_defs.insert(Mark::root(), root_def_id);
1858 // The outermost module has def ID 0; this is not reflected in the
1864 has_self: FxHashSet::default(),
1865 field_names: FxHashMap::default(),
1867 determined_imports: Vec::new(),
1868 indeterminate_imports: Vec::new(),
1870 current_module: graph_root,
1872 value_ns: vec![Rib::new(ModuleRibKind(graph_root))],
1873 type_ns: vec![Rib::new(ModuleRibKind(graph_root))],
1874 macro_ns: vec![Rib::new(ModuleRibKind(graph_root))],
1876 label_ribs: Vec::new(),
1878 current_trait_ref: None,
1879 current_self_type: None,
1880 current_self_item: None,
1881 last_import_segment: false,
1882 blacklisted_binding: None,
1884 primitive_type_table: PrimitiveTypeTable::new(),
1886 def_map: Default::default(),
1887 import_map: Default::default(),
1888 freevars: Default::default(),
1889 freevars_seen: Default::default(),
1890 export_map: FxHashMap::default(),
1891 trait_map: Default::default(),
1893 block_map: Default::default(),
1894 extern_module_map: FxHashMap::default(),
1895 binding_parent_modules: FxHashMap::default(),
1897 glob_map: Default::default(),
1899 used_imports: FxHashSet::default(),
1900 maybe_unused_trait_imports: Default::default(),
1901 maybe_unused_extern_crates: Vec::new(),
1903 unused_labels: FxHashMap::default(),
1905 privacy_errors: Vec::new(),
1906 ambiguity_errors: Vec::new(),
1907 use_injections: Vec::new(),
1908 macro_expanded_macro_export_errors: BTreeSet::new(),
1911 dummy_binding: arenas.alloc_name_binding(NameBinding {
1912 kind: NameBindingKind::Def(Def::Err, false),
1914 expansion: Mark::root(),
1916 vis: ty::Visibility::Public,
1920 macro_names: FxHashSet::default(),
1921 builtin_macros: FxHashMap::default(),
1922 macro_use_prelude: FxHashMap::default(),
1923 all_macros: FxHashMap::default(),
1924 macro_map: FxHashMap::default(),
1927 local_macro_def_scopes: FxHashMap::default(),
1928 name_already_seen: FxHashMap::default(),
1929 potentially_unused_imports: Vec::new(),
1930 struct_constructors: Default::default(),
1931 unused_macros: FxHashSet::default(),
1932 current_type_ascription: Vec::new(),
1933 injected_crate: None,
1937 pub fn arenas() -> ResolverArenas<'a> {
1941 /// Runs the function on each namespace.
1942 fn per_ns<F: FnMut(&mut Self, Namespace)>(&mut self, mut f: F) {
1948 fn macro_def(&self, mut ctxt: SyntaxContext) -> DefId {
1950 match self.macro_defs.get(&ctxt.outer()) {
1951 Some(&def_id) => return def_id,
1952 None => ctxt.remove_mark(),
1957 /// Entry point to crate resolution.
1958 pub fn resolve_crate(&mut self, krate: &Crate) {
1959 ImportResolver { resolver: self }.finalize_imports();
1960 self.current_module = self.graph_root;
1961 self.finalize_current_module_macro_resolutions();
1963 visit::walk_crate(self, krate);
1965 check_unused::check_crate(self, krate);
1966 self.report_errors(krate);
1967 self.crate_loader.postprocess(krate);
1974 normal_ancestor_id: DefId,
1978 let module = ModuleData::new(Some(parent), kind, normal_ancestor_id, expansion, span);
1979 self.arenas.alloc_module(module)
1982 fn record_use(&mut self, ident: Ident, ns: Namespace,
1983 used_binding: &'a NameBinding<'a>, is_lexical_scope: bool) {
1984 if let Some((b2, kind)) = used_binding.ambiguity {
1985 self.ambiguity_errors.push(AmbiguityError {
1986 kind, ident, b1: used_binding, b2,
1987 misc1: AmbiguityErrorMisc::None,
1988 misc2: AmbiguityErrorMisc::None,
1991 if let NameBindingKind::Import { directive, binding, ref used } = used_binding.kind {
1992 // Avoid marking `extern crate` items that refer to a name from extern prelude,
1993 // but not introduce it, as used if they are accessed from lexical scope.
1994 if is_lexical_scope {
1995 if let Some(entry) = self.extern_prelude.get(&ident.modern()) {
1996 if let Some(crate_item) = entry.extern_crate_item {
1997 if ptr::eq(used_binding, crate_item) && !entry.introduced_by_item {
2004 directive.used.set(true);
2005 self.used_imports.insert((directive.id, ns));
2006 self.add_to_glob_map(&directive, ident);
2007 self.record_use(ident, ns, binding, false);
2012 fn add_to_glob_map(&mut self, directive: &ImportDirective<'_>, ident: Ident) {
2013 if directive.is_glob() {
2014 self.glob_map.entry(directive.id).or_default().insert(ident.name);
2018 /// This resolves the identifier `ident` in the namespace `ns` in the current lexical scope.
2019 /// More specifically, we proceed up the hierarchy of scopes and return the binding for
2020 /// `ident` in the first scope that defines it (or None if no scopes define it).
2022 /// A block's items are above its local variables in the scope hierarchy, regardless of where
2023 /// the items are defined in the block. For example,
2026 /// g(); // Since there are no local variables in scope yet, this resolves to the item.
2029 /// g(); // This resolves to the local variable `g` since it shadows the item.
2033 /// Invariant: This must only be called during main resolution, not during
2034 /// import resolution.
2035 fn resolve_ident_in_lexical_scope(&mut self,
2038 record_used_id: Option<NodeId>,
2040 -> Option<LexicalScopeBinding<'a>> {
2041 assert!(ns == TypeNS || ns == ValueNS);
2042 if ident.name == keywords::Invalid.name() {
2043 return Some(LexicalScopeBinding::Def(Def::Err));
2045 ident.span = if ident.name == keywords::SelfUpper.name() {
2046 // FIXME(jseyfried) improve `Self` hygiene
2047 ident.span.with_ctxt(SyntaxContext::empty())
2048 } else if ns == TypeNS {
2051 ident.span.modern_and_legacy()
2054 // Walk backwards up the ribs in scope.
2055 let record_used = record_used_id.is_some();
2056 let mut module = self.graph_root;
2057 for i in (0 .. self.ribs[ns].len()).rev() {
2058 debug!("walk rib\n{:?}", self.ribs[ns][i].bindings);
2059 if let Some(def) = self.ribs[ns][i].bindings.get(&ident).cloned() {
2060 // The ident resolves to a type parameter or local variable.
2061 return Some(LexicalScopeBinding::Def(
2062 self.adjust_local_def(ns, i, def, record_used, path_span)
2066 module = match self.ribs[ns][i].kind {
2067 ModuleRibKind(module) => module,
2068 MacroDefinition(def) if def == self.macro_def(ident.span.ctxt()) => {
2069 // If an invocation of this macro created `ident`, give up on `ident`
2070 // and switch to `ident`'s source from the macro definition.
2071 ident.span.remove_mark();
2077 let item = self.resolve_ident_in_module_unadjusted(
2078 ModuleOrUniformRoot::Module(module),
2084 if let Ok(binding) = item {
2085 // The ident resolves to an item.
2086 return Some(LexicalScopeBinding::Item(binding));
2090 ModuleKind::Block(..) => {}, // We can see through blocks
2095 ident.span = ident.span.modern();
2096 let mut poisoned = None;
2098 let opt_module = if let Some(node_id) = record_used_id {
2099 self.hygienic_lexical_parent_with_compatibility_fallback(module, &mut ident.span,
2100 node_id, &mut poisoned)
2102 self.hygienic_lexical_parent(module, &mut ident.span)
2104 module = unwrap_or!(opt_module, break);
2105 let orig_current_module = self.current_module;
2106 self.current_module = module; // Lexical resolutions can never be a privacy error.
2107 let result = self.resolve_ident_in_module_unadjusted(
2108 ModuleOrUniformRoot::Module(module),
2114 self.current_module = orig_current_module;
2118 if let Some(node_id) = poisoned {
2119 self.session.buffer_lint_with_diagnostic(
2120 lint::builtin::PROC_MACRO_DERIVE_RESOLUTION_FALLBACK,
2121 node_id, ident.span,
2122 &format!("cannot find {} `{}` in this scope", ns.descr(), ident),
2123 lint::builtin::BuiltinLintDiagnostics::
2124 ProcMacroDeriveResolutionFallback(ident.span),
2127 return Some(LexicalScopeBinding::Item(binding))
2129 Err(Determined) => continue,
2130 Err(Undetermined) =>
2131 span_bug!(ident.span, "undetermined resolution during main resolution pass"),
2135 if !module.no_implicit_prelude {
2137 if let Some(binding) = self.extern_prelude_get(ident, !record_used) {
2138 return Some(LexicalScopeBinding::Item(binding));
2141 if ns == TypeNS && is_known_tool(ident.name) {
2142 let binding = (Def::ToolMod, ty::Visibility::Public,
2143 DUMMY_SP, Mark::root()).to_name_binding(self.arenas);
2144 return Some(LexicalScopeBinding::Item(binding));
2146 if let Some(prelude) = self.prelude {
2147 if let Ok(binding) = self.resolve_ident_in_module_unadjusted(
2148 ModuleOrUniformRoot::Module(prelude),
2154 return Some(LexicalScopeBinding::Item(binding));
2162 fn hygienic_lexical_parent(&mut self, module: Module<'a>, span: &mut Span)
2163 -> Option<Module<'a>> {
2164 if !module.expansion.is_descendant_of(span.ctxt().outer()) {
2165 return Some(self.macro_def_scope(span.remove_mark()));
2168 if let ModuleKind::Block(..) = module.kind {
2169 return Some(module.parent.unwrap());
2175 fn hygienic_lexical_parent_with_compatibility_fallback(&mut self, module: Module<'a>,
2176 span: &mut Span, node_id: NodeId,
2177 poisoned: &mut Option<NodeId>)
2178 -> Option<Module<'a>> {
2179 if let module @ Some(..) = self.hygienic_lexical_parent(module, span) {
2183 // We need to support the next case under a deprecation warning
2186 // ---- begin: this comes from a proc macro derive
2187 // mod implementation_details {
2188 // // Note that `MyStruct` is not in scope here.
2189 // impl SomeTrait for MyStruct { ... }
2193 // So we have to fall back to the module's parent during lexical resolution in this case.
2194 if let Some(parent) = module.parent {
2195 // Inner module is inside the macro, parent module is outside of the macro.
2196 if module.expansion != parent.expansion &&
2197 module.expansion.is_descendant_of(parent.expansion) {
2198 // The macro is a proc macro derive
2199 if module.expansion.looks_like_proc_macro_derive() {
2200 if parent.expansion.is_descendant_of(span.ctxt().outer()) {
2201 *poisoned = Some(node_id);
2202 return module.parent;
2211 fn resolve_ident_in_module(
2213 module: ModuleOrUniformRoot<'a>,
2216 parent_scope: Option<&ParentScope<'a>>,
2219 ) -> Result<&'a NameBinding<'a>, Determinacy> {
2220 self.resolve_ident_in_module_ext(
2221 module, ident, ns, parent_scope, record_used, path_span
2222 ).map_err(|(determinacy, _)| determinacy)
2225 fn resolve_ident_in_module_ext(
2227 module: ModuleOrUniformRoot<'a>,
2230 parent_scope: Option<&ParentScope<'a>>,
2233 ) -> Result<&'a NameBinding<'a>, (Determinacy, Weak)> {
2234 let orig_current_module = self.current_module;
2236 ModuleOrUniformRoot::Module(module) => {
2237 ident.span = ident.span.modern();
2238 if let Some(def) = ident.span.adjust(module.expansion) {
2239 self.current_module = self.macro_def_scope(def);
2242 ModuleOrUniformRoot::ExternPrelude => {
2243 ident.span = ident.span.modern();
2244 ident.span.adjust(Mark::root());
2246 ModuleOrUniformRoot::CrateRootAndExternPrelude |
2247 ModuleOrUniformRoot::CurrentScope => {
2251 let result = self.resolve_ident_in_module_unadjusted_ext(
2252 module, ident, ns, parent_scope, false, record_used, path_span,
2254 self.current_module = orig_current_module;
2258 fn resolve_crate_root(&mut self, ident: Ident) -> Module<'a> {
2259 let mut ctxt = ident.span.ctxt();
2260 let mark = if ident.name == keywords::DollarCrate.name() {
2261 // When resolving `$crate` from a `macro_rules!` invoked in a `macro`,
2262 // we don't want to pretend that the `macro_rules!` definition is in the `macro`
2263 // as described in `SyntaxContext::apply_mark`, so we ignore prepended modern marks.
2264 // FIXME: This is only a guess and it doesn't work correctly for `macro_rules!`
2265 // definitions actually produced by `macro` and `macro` definitions produced by
2266 // `macro_rules!`, but at least such configurations are not stable yet.
2267 ctxt = ctxt.modern_and_legacy();
2268 let mut iter = ctxt.marks().into_iter().rev().peekable();
2269 let mut result = None;
2270 // Find the last modern mark from the end if it exists.
2271 while let Some(&(mark, transparency)) = iter.peek() {
2272 if transparency == Transparency::Opaque {
2273 result = Some(mark);
2279 // Then find the last legacy mark from the end if it exists.
2280 for (mark, transparency) in iter {
2281 if transparency == Transparency::SemiTransparent {
2282 result = Some(mark);
2289 ctxt = ctxt.modern();
2290 ctxt.adjust(Mark::root())
2292 let module = match mark {
2293 Some(def) => self.macro_def_scope(def),
2294 None => return self.graph_root,
2296 self.get_module(DefId { index: CRATE_DEF_INDEX, ..module.normal_ancestor_id })
2299 fn resolve_self(&mut self, ctxt: &mut SyntaxContext, module: Module<'a>) -> Module<'a> {
2300 let mut module = self.get_module(module.normal_ancestor_id);
2301 while module.span.ctxt().modern() != *ctxt {
2302 let parent = module.parent.unwrap_or_else(|| self.macro_def_scope(ctxt.remove_mark()));
2303 module = self.get_module(parent.normal_ancestor_id);
2310 // We maintain a list of value ribs and type ribs.
2312 // Simultaneously, we keep track of the current position in the module
2313 // graph in the `current_module` pointer. When we go to resolve a name in
2314 // the value or type namespaces, we first look through all the ribs and
2315 // then query the module graph. When we resolve a name in the module
2316 // namespace, we can skip all the ribs (since nested modules are not
2317 // allowed within blocks in Rust) and jump straight to the current module
2320 // Named implementations are handled separately. When we find a method
2321 // call, we consult the module node to find all of the implementations in
2322 // scope. This information is lazily cached in the module node. We then
2323 // generate a fake "implementation scope" containing all the
2324 // implementations thus found, for compatibility with old resolve pass.
2326 pub fn with_scope<F, T>(&mut self, id: NodeId, f: F) -> T
2327 where F: FnOnce(&mut Resolver<'_>) -> T
2329 let id = self.definitions.local_def_id(id);
2330 let module = self.module_map.get(&id).cloned(); // clones a reference
2331 if let Some(module) = module {
2332 // Move down in the graph.
2333 let orig_module = replace(&mut self.current_module, module);
2334 self.ribs[ValueNS].push(Rib::new(ModuleRibKind(module)));
2335 self.ribs[TypeNS].push(Rib::new(ModuleRibKind(module)));
2337 self.finalize_current_module_macro_resolutions();
2340 self.current_module = orig_module;
2341 self.ribs[ValueNS].pop();
2342 self.ribs[TypeNS].pop();
2349 /// Searches the current set of local scopes for labels. Returns the first non-None label that
2350 /// is returned by the given predicate function
2352 /// Stops after meeting a closure.
2353 fn search_label<P, R>(&self, mut ident: Ident, pred: P) -> Option<R>
2354 where P: Fn(&Rib<'_>, Ident) -> Option<R>
2356 for rib in self.label_ribs.iter().rev() {
2359 // If an invocation of this macro created `ident`, give up on `ident`
2360 // and switch to `ident`'s source from the macro definition.
2361 MacroDefinition(def) => {
2362 if def == self.macro_def(ident.span.ctxt()) {
2363 ident.span.remove_mark();
2367 // Do not resolve labels across function boundary
2371 let r = pred(rib, ident);
2379 fn resolve_adt(&mut self, item: &Item, generics: &Generics) {
2380 debug!("resolve_adt");
2381 self.with_current_self_item(item, |this| {
2382 this.with_generic_param_rib(HasGenericParams(generics, ItemRibKind), |this| {
2383 let item_def_id = this.definitions.local_def_id(item.id);
2384 this.with_self_rib(Def::SelfTy(None, Some(item_def_id)), |this| {
2385 visit::walk_item(this, item);
2391 fn future_proof_import(&mut self, use_tree: &ast::UseTree) {
2392 let segments = &use_tree.prefix.segments;
2393 if !segments.is_empty() {
2394 let ident = segments[0].ident;
2395 if ident.is_path_segment_keyword() || ident.span.rust_2015() {
2399 let nss = match use_tree.kind {
2400 ast::UseTreeKind::Simple(..) if segments.len() == 1 => &[TypeNS, ValueNS][..],
2403 let report_error = |this: &Self, ns| {
2404 let what = if ns == TypeNS { "type parameters" } else { "local variables" };
2405 this.session.span_err(ident.span, &format!("imports cannot refer to {}", what));
2409 match self.resolve_ident_in_lexical_scope(ident, ns, None, use_tree.prefix.span) {
2410 Some(LexicalScopeBinding::Def(..)) => {
2411 report_error(self, ns);
2413 Some(LexicalScopeBinding::Item(binding)) => {
2414 let orig_blacklisted_binding =
2415 mem::replace(&mut self.blacklisted_binding, Some(binding));
2416 if let Some(LexicalScopeBinding::Def(..)) =
2417 self.resolve_ident_in_lexical_scope(ident, ns, None,
2418 use_tree.prefix.span) {
2419 report_error(self, ns);
2421 self.blacklisted_binding = orig_blacklisted_binding;
2426 } else if let ast::UseTreeKind::Nested(use_trees) = &use_tree.kind {
2427 for (use_tree, _) in use_trees {
2428 self.future_proof_import(use_tree);
2433 fn resolve_item(&mut self, item: &Item) {
2434 let name = item.ident.name;
2435 debug!("(resolving item) resolving {} ({:?})", name, item.node);
2438 ItemKind::Ty(_, ref generics) |
2439 ItemKind::Fn(_, _, ref generics, _) |
2440 ItemKind::Existential(_, ref generics) => {
2441 self.with_generic_param_rib(HasGenericParams(generics, ItemRibKind),
2442 |this| visit::walk_item(this, item));
2445 ItemKind::Enum(_, ref generics) |
2446 ItemKind::Struct(_, ref generics) |
2447 ItemKind::Union(_, ref generics) => {
2448 self.resolve_adt(item, generics);
2451 ItemKind::Impl(.., ref generics, ref opt_trait_ref, ref self_type, ref impl_items) =>
2452 self.resolve_implementation(generics,
2458 ItemKind::Trait(.., ref generics, ref bounds, ref trait_items) => {
2459 // Create a new rib for the trait-wide type parameters.
2460 self.with_generic_param_rib(HasGenericParams(generics, ItemRibKind), |this| {
2461 let local_def_id = this.definitions.local_def_id(item.id);
2462 this.with_self_rib(Def::SelfTy(Some(local_def_id), None), |this| {
2463 this.visit_generics(generics);
2464 walk_list!(this, visit_param_bound, bounds);
2466 for trait_item in trait_items {
2467 let generic_params = HasGenericParams(&trait_item.generics,
2468 TraitOrImplItemRibKind);
2469 this.with_generic_param_rib(generic_params, |this| {
2470 match trait_item.node {
2471 TraitItemKind::Const(ref ty, ref default) => {
2474 // Only impose the restrictions of
2475 // ConstRibKind for an actual constant
2476 // expression in a provided default.
2477 if let Some(ref expr) = *default{
2478 this.with_constant_rib(|this| {
2479 this.visit_expr(expr);
2483 TraitItemKind::Method(_, _) => {
2484 visit::walk_trait_item(this, trait_item)
2486 TraitItemKind::Type(..) => {
2487 visit::walk_trait_item(this, trait_item)
2489 TraitItemKind::Macro(_) => {
2490 panic!("unexpanded macro in resolve!")
2499 ItemKind::TraitAlias(ref generics, ref bounds) => {
2500 // Create a new rib for the trait-wide type parameters.
2501 self.with_generic_param_rib(HasGenericParams(generics, ItemRibKind), |this| {
2502 let local_def_id = this.definitions.local_def_id(item.id);
2503 this.with_self_rib(Def::SelfTy(Some(local_def_id), None), |this| {
2504 this.visit_generics(generics);
2505 walk_list!(this, visit_param_bound, bounds);
2510 ItemKind::Mod(_) | ItemKind::ForeignMod(_) => {
2511 self.with_scope(item.id, |this| {
2512 visit::walk_item(this, item);
2516 ItemKind::Static(ref ty, _, ref expr) |
2517 ItemKind::Const(ref ty, ref expr) => {
2518 debug!("resolve_item ItemKind::Const");
2519 self.with_item_rib(|this| {
2521 this.with_constant_rib(|this| {
2522 this.visit_expr(expr);
2527 ItemKind::Use(ref use_tree) => {
2528 self.future_proof_import(use_tree);
2531 ItemKind::ExternCrate(..) |
2532 ItemKind::MacroDef(..) | ItemKind::GlobalAsm(..) => {
2533 // do nothing, these are just around to be encoded
2536 ItemKind::Mac(_) => panic!("unexpanded macro in resolve!"),
2540 fn with_generic_param_rib<'b, F>(&'b mut self, generic_params: GenericParameters<'a, 'b>, f: F)
2541 where F: FnOnce(&mut Resolver<'_>)
2543 debug!("with_generic_param_rib");
2544 match generic_params {
2545 HasGenericParams(generics, rib_kind) => {
2546 let mut function_type_rib = Rib::new(rib_kind);
2547 let mut function_value_rib = Rib::new(rib_kind);
2548 let mut seen_bindings = FxHashMap::default();
2549 for param in &generics.params {
2551 GenericParamKind::Lifetime { .. } => {}
2552 GenericParamKind::Type { .. } => {
2553 let ident = param.ident.modern();
2554 debug!("with_generic_param_rib: {}", param.id);
2556 if seen_bindings.contains_key(&ident) {
2557 let span = seen_bindings.get(&ident).unwrap();
2558 let err = ResolutionError::NameAlreadyUsedInParameterList(
2562 resolve_error(self, param.ident.span, err);
2564 seen_bindings.entry(ident).or_insert(param.ident.span);
2566 // Plain insert (no renaming).
2567 let def = Def::TyParam(self.definitions.local_def_id(param.id));
2568 function_type_rib.bindings.insert(ident, def);
2569 self.record_def(param.id, PathResolution::new(def));
2571 GenericParamKind::Const { .. } => {
2572 let ident = param.ident.modern();
2573 debug!("with_generic_param_rib: {}", param.id);
2575 if seen_bindings.contains_key(&ident) {
2576 let span = seen_bindings.get(&ident).unwrap();
2577 let err = ResolutionError::NameAlreadyUsedInParameterList(
2581 resolve_error(self, param.ident.span, err);
2583 seen_bindings.entry(ident).or_insert(param.ident.span);
2585 let def = Def::ConstParam(self.definitions.local_def_id(param.id));
2586 function_value_rib.bindings.insert(ident, def);
2587 self.record_def(param.id, PathResolution::new(def));
2591 self.ribs[ValueNS].push(function_value_rib);
2592 self.ribs[TypeNS].push(function_type_rib);
2595 NoGenericParams => {
2602 if let HasGenericParams(..) = generic_params {
2603 self.ribs[TypeNS].pop();
2604 self.ribs[ValueNS].pop();
2608 fn with_label_rib<F>(&mut self, f: F)
2609 where F: FnOnce(&mut Resolver<'_>)
2611 self.label_ribs.push(Rib::new(NormalRibKind));
2613 self.label_ribs.pop();
2616 fn with_item_rib<F>(&mut self, f: F)
2617 where F: FnOnce(&mut Resolver<'_>)
2619 self.ribs[ValueNS].push(Rib::new(ItemRibKind));
2620 self.ribs[TypeNS].push(Rib::new(ItemRibKind));
2622 self.ribs[TypeNS].pop();
2623 self.ribs[ValueNS].pop();
2626 fn with_constant_rib<F>(&mut self, f: F)
2627 where F: FnOnce(&mut Resolver<'_>)
2629 debug!("with_constant_rib");
2630 self.ribs[ValueNS].push(Rib::new(ConstantItemRibKind));
2631 self.label_ribs.push(Rib::new(ConstantItemRibKind));
2633 self.label_ribs.pop();
2634 self.ribs[ValueNS].pop();
2637 fn with_current_self_type<T, F>(&mut self, self_type: &Ty, f: F) -> T
2638 where F: FnOnce(&mut Resolver<'_>) -> T
2640 // Handle nested impls (inside fn bodies)
2641 let previous_value = replace(&mut self.current_self_type, Some(self_type.clone()));
2642 let result = f(self);
2643 self.current_self_type = previous_value;
2647 fn with_current_self_item<T, F>(&mut self, self_item: &Item, f: F) -> T
2648 where F: FnOnce(&mut Resolver<'_>) -> T
2650 let previous_value = replace(&mut self.current_self_item, Some(self_item.id));
2651 let result = f(self);
2652 self.current_self_item = previous_value;
2656 /// This is called to resolve a trait reference from an `impl` (i.e., `impl Trait for Foo`)
2657 fn with_optional_trait_ref<T, F>(&mut self, opt_trait_ref: Option<&TraitRef>, f: F) -> T
2658 where F: FnOnce(&mut Resolver<'_>, Option<DefId>) -> T
2660 let mut new_val = None;
2661 let mut new_id = None;
2662 if let Some(trait_ref) = opt_trait_ref {
2663 let path: Vec<_> = Segment::from_path(&trait_ref.path);
2664 let def = self.smart_resolve_path_fragment(
2668 trait_ref.path.span,
2669 PathSource::Trait(AliasPossibility::No),
2670 CrateLint::SimplePath(trait_ref.ref_id),
2672 if def != Def::Err {
2673 new_id = Some(def.def_id());
2674 let span = trait_ref.path.span;
2675 if let PathResult::Module(ModuleOrUniformRoot::Module(module)) =
2676 self.resolve_path_without_parent_scope(
2681 CrateLint::SimplePath(trait_ref.ref_id),
2684 new_val = Some((module, trait_ref.clone()));
2688 let original_trait_ref = replace(&mut self.current_trait_ref, new_val);
2689 let result = f(self, new_id);
2690 self.current_trait_ref = original_trait_ref;
2694 fn with_self_rib<F>(&mut self, self_def: Def, f: F)
2695 where F: FnOnce(&mut Resolver<'_>)
2697 let mut self_type_rib = Rib::new(NormalRibKind);
2699 // plain insert (no renaming, types are not currently hygienic....)
2700 self_type_rib.bindings.insert(keywords::SelfUpper.ident(), self_def);
2701 self.ribs[TypeNS].push(self_type_rib);
2703 self.ribs[TypeNS].pop();
2706 fn with_self_struct_ctor_rib<F>(&mut self, impl_id: DefId, f: F)
2707 where F: FnOnce(&mut Resolver<'_>)
2709 let self_def = Def::SelfCtor(impl_id);
2710 let mut self_type_rib = Rib::new(NormalRibKind);
2711 self_type_rib.bindings.insert(keywords::SelfUpper.ident(), self_def);
2712 self.ribs[ValueNS].push(self_type_rib);
2714 self.ribs[ValueNS].pop();
2717 fn resolve_implementation(&mut self,
2718 generics: &Generics,
2719 opt_trait_reference: &Option<TraitRef>,
2722 impl_items: &[ImplItem]) {
2723 debug!("resolve_implementation");
2724 // If applicable, create a rib for the type parameters.
2725 self.with_generic_param_rib(HasGenericParams(generics, ItemRibKind), |this| {
2726 // Dummy self type for better errors if `Self` is used in the trait path.
2727 this.with_self_rib(Def::SelfTy(None, None), |this| {
2728 // Resolve the trait reference, if necessary.
2729 this.with_optional_trait_ref(opt_trait_reference.as_ref(), |this, trait_id| {
2730 let item_def_id = this.definitions.local_def_id(item_id);
2731 this.with_self_rib(Def::SelfTy(trait_id, Some(item_def_id)), |this| {
2732 if let Some(trait_ref) = opt_trait_reference.as_ref() {
2733 // Resolve type arguments in the trait path.
2734 visit::walk_trait_ref(this, trait_ref);
2736 // Resolve the self type.
2737 this.visit_ty(self_type);
2738 // Resolve the generic parameters.
2739 this.visit_generics(generics);
2740 // Resolve the items within the impl.
2741 this.with_current_self_type(self_type, |this| {
2742 this.with_self_struct_ctor_rib(item_def_id, |this| {
2743 debug!("resolve_implementation with_self_struct_ctor_rib");
2744 for impl_item in impl_items {
2745 this.resolve_visibility(&impl_item.vis);
2747 // We also need a new scope for the impl item type parameters.
2748 let generic_params = HasGenericParams(&impl_item.generics,
2749 TraitOrImplItemRibKind);
2750 this.with_generic_param_rib(generic_params, |this| {
2751 use self::ResolutionError::*;
2752 match impl_item.node {
2753 ImplItemKind::Const(..) => {
2755 "resolve_implementation ImplItemKind::Const",
2757 // If this is a trait impl, ensure the const
2759 this.check_trait_item(
2763 |n, s| ConstNotMemberOfTrait(n, s),
2766 this.with_constant_rib(|this| {
2767 visit::walk_impl_item(this, impl_item)
2770 ImplItemKind::Method(..) => {
2771 // If this is a trait impl, ensure the method
2773 this.check_trait_item(impl_item.ident,
2776 |n, s| MethodNotMemberOfTrait(n, s));
2778 visit::walk_impl_item(this, impl_item);
2780 ImplItemKind::Type(ref ty) => {
2781 // If this is a trait impl, ensure the type
2783 this.check_trait_item(impl_item.ident,
2786 |n, s| TypeNotMemberOfTrait(n, s));
2790 ImplItemKind::Existential(ref bounds) => {
2791 // If this is a trait impl, ensure the type
2793 this.check_trait_item(impl_item.ident,
2796 |n, s| TypeNotMemberOfTrait(n, s));
2798 for bound in bounds {
2799 this.visit_param_bound(bound);
2802 ImplItemKind::Macro(_) =>
2803 panic!("unexpanded macro in resolve!"),
2815 fn check_trait_item<F>(&mut self, ident: Ident, ns: Namespace, span: Span, err: F)
2816 where F: FnOnce(Name, &str) -> ResolutionError<'_>
2818 // If there is a TraitRef in scope for an impl, then the method must be in the
2820 if let Some((module, _)) = self.current_trait_ref {
2821 if self.resolve_ident_in_module(
2822 ModuleOrUniformRoot::Module(module),
2829 let path = &self.current_trait_ref.as_ref().unwrap().1.path;
2830 resolve_error(self, span, err(ident.name, &path_names_to_string(path)));
2835 fn resolve_local(&mut self, local: &Local) {
2836 // Resolve the type.
2837 walk_list!(self, visit_ty, &local.ty);
2839 // Resolve the initializer.
2840 walk_list!(self, visit_expr, &local.init);
2842 // Resolve the pattern.
2843 self.resolve_pattern(&local.pat, PatternSource::Let, &mut FxHashMap::default());
2846 // build a map from pattern identifiers to binding-info's.
2847 // this is done hygienically. This could arise for a macro
2848 // that expands into an or-pattern where one 'x' was from the
2849 // user and one 'x' came from the macro.
2850 fn binding_mode_map(&mut self, pat: &Pat) -> BindingMap {
2851 let mut binding_map = FxHashMap::default();
2853 pat.walk(&mut |pat| {
2854 if let PatKind::Ident(binding_mode, ident, ref sub_pat) = pat.node {
2855 if sub_pat.is_some() || match self.def_map.get(&pat.id).map(|res| res.base_def()) {
2856 Some(Def::Local(..)) => true,
2859 let binding_info = BindingInfo { span: ident.span, binding_mode: binding_mode };
2860 binding_map.insert(ident, binding_info);
2869 // check that all of the arms in an or-pattern have exactly the
2870 // same set of bindings, with the same binding modes for each.
2871 fn check_consistent_bindings(&mut self, pats: &[P<Pat>]) {
2872 if pats.is_empty() {
2876 let mut missing_vars = FxHashMap::default();
2877 let mut inconsistent_vars = FxHashMap::default();
2878 for (i, p) in pats.iter().enumerate() {
2879 let map_i = self.binding_mode_map(&p);
2881 for (j, q) in pats.iter().enumerate() {
2886 let map_j = self.binding_mode_map(&q);
2887 for (&key, &binding_i) in &map_i {
2888 if map_j.is_empty() { // Account for missing bindings when
2889 let binding_error = missing_vars // map_j has none.
2891 .or_insert(BindingError {
2893 origin: BTreeSet::new(),
2894 target: BTreeSet::new(),
2896 binding_error.origin.insert(binding_i.span);
2897 binding_error.target.insert(q.span);
2899 for (&key_j, &binding_j) in &map_j {
2900 match map_i.get(&key_j) {
2901 None => { // missing binding
2902 let binding_error = missing_vars
2904 .or_insert(BindingError {
2906 origin: BTreeSet::new(),
2907 target: BTreeSet::new(),
2909 binding_error.origin.insert(binding_j.span);
2910 binding_error.target.insert(p.span);
2912 Some(binding_i) => { // check consistent binding
2913 if binding_i.binding_mode != binding_j.binding_mode {
2916 .or_insert((binding_j.span, binding_i.span));
2924 let mut missing_vars = missing_vars.iter().collect::<Vec<_>>();
2925 missing_vars.sort();
2926 for (_, v) in missing_vars {
2928 *v.origin.iter().next().unwrap(),
2929 ResolutionError::VariableNotBoundInPattern(v));
2931 let mut inconsistent_vars = inconsistent_vars.iter().collect::<Vec<_>>();
2932 inconsistent_vars.sort();
2933 for (name, v) in inconsistent_vars {
2934 resolve_error(self, v.0, ResolutionError::VariableBoundWithDifferentMode(*name, v.1));
2938 fn resolve_arm(&mut self, arm: &Arm) {
2939 self.ribs[ValueNS].push(Rib::new(NormalRibKind));
2941 let mut bindings_list = FxHashMap::default();
2942 for pattern in &arm.pats {
2943 self.resolve_pattern(&pattern, PatternSource::Match, &mut bindings_list);
2946 // This has to happen *after* we determine which pat_idents are variants.
2947 self.check_consistent_bindings(&arm.pats);
2949 if let Some(ast::Guard::If(ref expr)) = arm.guard {
2950 self.visit_expr(expr)
2952 self.visit_expr(&arm.body);
2954 self.ribs[ValueNS].pop();
2957 fn resolve_block(&mut self, block: &Block) {
2958 debug!("(resolving block) entering block");
2959 // Move down in the graph, if there's an anonymous module rooted here.
2960 let orig_module = self.current_module;
2961 let anonymous_module = self.block_map.get(&block.id).cloned(); // clones a reference
2963 let mut num_macro_definition_ribs = 0;
2964 if let Some(anonymous_module) = anonymous_module {
2965 debug!("(resolving block) found anonymous module, moving down");
2966 self.ribs[ValueNS].push(Rib::new(ModuleRibKind(anonymous_module)));
2967 self.ribs[TypeNS].push(Rib::new(ModuleRibKind(anonymous_module)));
2968 self.current_module = anonymous_module;
2969 self.finalize_current_module_macro_resolutions();
2971 self.ribs[ValueNS].push(Rib::new(NormalRibKind));
2974 // Descend into the block.
2975 for stmt in &block.stmts {
2976 if let ast::StmtKind::Item(ref item) = stmt.node {
2977 if let ast::ItemKind::MacroDef(..) = item.node {
2978 num_macro_definition_ribs += 1;
2979 let def = self.definitions.local_def_id(item.id);
2980 self.ribs[ValueNS].push(Rib::new(MacroDefinition(def)));
2981 self.label_ribs.push(Rib::new(MacroDefinition(def)));
2985 self.visit_stmt(stmt);
2989 self.current_module = orig_module;
2990 for _ in 0 .. num_macro_definition_ribs {
2991 self.ribs[ValueNS].pop();
2992 self.label_ribs.pop();
2994 self.ribs[ValueNS].pop();
2995 if anonymous_module.is_some() {
2996 self.ribs[TypeNS].pop();
2998 debug!("(resolving block) leaving block");
3001 fn fresh_binding(&mut self,
3004 outer_pat_id: NodeId,
3005 pat_src: PatternSource,
3006 bindings: &mut FxHashMap<Ident, NodeId>)
3008 // Add the binding to the local ribs, if it
3009 // doesn't already exist in the bindings map. (We
3010 // must not add it if it's in the bindings map
3011 // because that breaks the assumptions later
3012 // passes make about or-patterns.)
3013 let ident = ident.modern_and_legacy();
3014 let mut def = Def::Local(pat_id);
3015 match bindings.get(&ident).cloned() {
3016 Some(id) if id == outer_pat_id => {
3017 // `Variant(a, a)`, error
3021 ResolutionError::IdentifierBoundMoreThanOnceInSamePattern(
3025 Some(..) if pat_src == PatternSource::FnParam => {
3026 // `fn f(a: u8, a: u8)`, error
3030 ResolutionError::IdentifierBoundMoreThanOnceInParameterList(
3034 Some(..) if pat_src == PatternSource::Match ||
3035 pat_src == PatternSource::IfLet ||
3036 pat_src == PatternSource::WhileLet => {
3037 // `Variant1(a) | Variant2(a)`, ok
3038 // Reuse definition from the first `a`.
3039 def = self.ribs[ValueNS].last_mut().unwrap().bindings[&ident];
3042 span_bug!(ident.span, "two bindings with the same name from \
3043 unexpected pattern source {:?}", pat_src);
3046 // A completely fresh binding, add to the lists if it's valid.
3047 if ident.name != keywords::Invalid.name() {
3048 bindings.insert(ident, outer_pat_id);
3049 self.ribs[ValueNS].last_mut().unwrap().bindings.insert(ident, def);
3054 PathResolution::new(def)
3057 fn resolve_pattern(&mut self,
3059 pat_src: PatternSource,
3060 // Maps idents to the node ID for the
3061 // outermost pattern that binds them.
3062 bindings: &mut FxHashMap<Ident, NodeId>) {
3063 // Visit all direct subpatterns of this pattern.
3064 let outer_pat_id = pat.id;
3065 pat.walk(&mut |pat| {
3066 debug!("resolve_pattern pat={:?} node={:?}", pat, pat.node);
3068 PatKind::Ident(bmode, ident, ref opt_pat) => {
3069 // First try to resolve the identifier as some existing
3070 // entity, then fall back to a fresh binding.
3071 let binding = self.resolve_ident_in_lexical_scope(ident, ValueNS,
3073 .and_then(LexicalScopeBinding::item);
3074 let resolution = binding.map(NameBinding::def).and_then(|def| {
3075 let is_syntactic_ambiguity = opt_pat.is_none() &&
3076 bmode == BindingMode::ByValue(Mutability::Immutable);
3078 Def::StructCtor(_, CtorKind::Const) |
3079 Def::VariantCtor(_, CtorKind::Const) |
3080 Def::Const(..) if is_syntactic_ambiguity => {
3081 // Disambiguate in favor of a unit struct/variant
3082 // or constant pattern.
3083 self.record_use(ident, ValueNS, binding.unwrap(), false);
3084 Some(PathResolution::new(def))
3086 Def::StructCtor(..) | Def::VariantCtor(..) |
3087 Def::Const(..) | Def::Static(..) => {
3088 // This is unambiguously a fresh binding, either syntactically
3089 // (e.g., `IDENT @ PAT` or `ref IDENT`) or because `IDENT` resolves
3090 // to something unusable as a pattern (e.g., constructor function),
3091 // but we still conservatively report an error, see
3092 // issues/33118#issuecomment-233962221 for one reason why.
3096 ResolutionError::BindingShadowsSomethingUnacceptable(
3097 pat_src.descr(), ident.name, binding.unwrap())
3101 Def::Fn(..) | Def::Err => {
3102 // These entities are explicitly allowed
3103 // to be shadowed by fresh bindings.
3107 span_bug!(ident.span, "unexpected definition for an \
3108 identifier in pattern: {:?}", def);
3111 }).unwrap_or_else(|| {
3112 self.fresh_binding(ident, pat.id, outer_pat_id, pat_src, bindings)
3115 self.record_def(pat.id, resolution);
3118 PatKind::TupleStruct(ref path, ..) => {
3119 self.smart_resolve_path(pat.id, None, path, PathSource::TupleStruct);
3122 PatKind::Path(ref qself, ref path) => {
3123 self.smart_resolve_path(pat.id, qself.as_ref(), path, PathSource::Pat);
3126 PatKind::Struct(ref path, ..) => {
3127 self.smart_resolve_path(pat.id, None, path, PathSource::Struct);
3135 visit::walk_pat(self, pat);
3138 // High-level and context dependent path resolution routine.
3139 // Resolves the path and records the resolution into definition map.
3140 // If resolution fails tries several techniques to find likely
3141 // resolution candidates, suggest imports or other help, and report
3142 // errors in user friendly way.
3143 fn smart_resolve_path(&mut self,
3145 qself: Option<&QSelf>,
3147 source: PathSource<'_>)
3149 self.smart_resolve_path_with_crate_lint(id, qself, path, source, CrateLint::SimplePath(id))
3152 /// A variant of `smart_resolve_path` where you also specify extra
3153 /// information about where the path came from; this extra info is
3154 /// sometimes needed for the lint that recommends rewriting
3155 /// absolute paths to `crate`, so that it knows how to frame the
3156 /// suggestion. If you are just resolving a path like `foo::bar`
3157 /// that appears...somewhere, though, then you just want
3158 /// `CrateLint::SimplePath`, which is what `smart_resolve_path`
3159 /// already provides.
3160 fn smart_resolve_path_with_crate_lint(
3163 qself: Option<&QSelf>,
3165 source: PathSource<'_>,
3166 crate_lint: CrateLint
3167 ) -> PathResolution {
3168 self.smart_resolve_path_fragment(
3171 &Segment::from_path(path),
3178 fn smart_resolve_path_fragment(&mut self,
3180 qself: Option<&QSelf>,
3183 source: PathSource<'_>,
3184 crate_lint: CrateLint)
3186 let ns = source.namespace();
3187 let is_expected = &|def| source.is_expected(def);
3189 let report_errors = |this: &mut Self, def: Option<Def>| {
3190 let (err, candidates) = this.smart_resolve_report_errors(path, span, source, def);
3191 let def_id = this.current_module.normal_ancestor_id;
3192 let node_id = this.definitions.as_local_node_id(def_id).unwrap();
3193 let better = def.is_some();
3194 this.use_injections.push(UseError { err, candidates, node_id, better });
3195 err_path_resolution()
3198 let resolution = match self.resolve_qpath_anywhere(
3204 source.defer_to_typeck(),
3205 source.global_by_default(),
3208 Some(resolution) if resolution.unresolved_segments() == 0 => {
3209 if is_expected(resolution.base_def()) || resolution.base_def() == Def::Err {
3212 // Add a temporary hack to smooth the transition to new struct ctor
3213 // visibility rules. See #38932 for more details.
3215 if let Def::Struct(def_id) = resolution.base_def() {
3216 if let Some((ctor_def, ctor_vis))
3217 = self.struct_constructors.get(&def_id).cloned() {
3218 if is_expected(ctor_def) && self.is_accessible(ctor_vis) {
3219 let lint = lint::builtin::LEGACY_CONSTRUCTOR_VISIBILITY;
3220 self.session.buffer_lint(lint, id, span,
3221 "private struct constructors are not usable through \
3222 re-exports in outer modules",
3224 res = Some(PathResolution::new(ctor_def));
3229 res.unwrap_or_else(|| report_errors(self, Some(resolution.base_def())))
3232 Some(resolution) if source.defer_to_typeck() => {
3233 // Not fully resolved associated item `T::A::B` or `<T as Tr>::A::B`
3234 // or `<T>::A::B`. If `B` should be resolved in value namespace then
3235 // it needs to be added to the trait map.
3237 let item_name = path.last().unwrap().ident;
3238 let traits = self.get_traits_containing_item(item_name, ns);
3239 self.trait_map.insert(id, traits);
3243 _ => report_errors(self, None)
3246 if let PathSource::TraitItem(..) = source {} else {
3247 // Avoid recording definition of `A::B` in `<T as A>::B::C`.
3248 self.record_def(id, resolution);
3253 fn type_ascription_suggestion(&self,
3254 err: &mut DiagnosticBuilder<'_>,
3256 debug!("type_ascription_suggetion {:?}", base_span);
3257 let cm = self.session.source_map();
3258 debug!("self.current_type_ascription {:?}", self.current_type_ascription);
3259 if let Some(sp) = self.current_type_ascription.last() {
3262 // Try to find the `:`; bail on first non-':' / non-whitespace.
3263 sp = cm.next_point(sp);
3264 if let Ok(snippet) = cm.span_to_snippet(sp.to(cm.next_point(sp))) {
3265 debug!("snippet {:?}", snippet);
3266 let line_sp = cm.lookup_char_pos(sp.hi()).line;
3267 let line_base_sp = cm.lookup_char_pos(base_span.lo()).line;
3268 debug!("{:?} {:?}", line_sp, line_base_sp);
3270 err.span_label(base_span,
3271 "expecting a type here because of type ascription");
3272 if line_sp != line_base_sp {
3273 err.span_suggestion_short(
3275 "did you mean to use `;` here instead?",
3277 Applicability::MaybeIncorrect,
3281 } else if !snippet.trim().is_empty() {
3282 debug!("tried to find type ascription `:` token, couldn't find it");
3292 fn self_type_is_available(&mut self, span: Span) -> bool {
3293 let binding = self.resolve_ident_in_lexical_scope(keywords::SelfUpper.ident(),
3294 TypeNS, None, span);
3295 if let Some(LexicalScopeBinding::Def(def)) = binding { def != Def::Err } else { false }
3298 fn self_value_is_available(&mut self, self_span: Span, path_span: Span) -> bool {
3299 let ident = Ident::new(keywords::SelfLower.name(), self_span);
3300 let binding = self.resolve_ident_in_lexical_scope(ident, ValueNS, None, path_span);
3301 if let Some(LexicalScopeBinding::Def(def)) = binding { def != Def::Err } else { false }
3304 // Resolve in alternative namespaces if resolution in the primary namespace fails.
3305 fn resolve_qpath_anywhere(&mut self,
3307 qself: Option<&QSelf>,
3309 primary_ns: Namespace,
3311 defer_to_typeck: bool,
3312 global_by_default: bool,
3313 crate_lint: CrateLint)
3314 -> Option<PathResolution> {
3315 let mut fin_res = None;
3316 // FIXME: can't resolve paths in macro namespace yet, macros are
3317 // processed by the little special hack below.
3318 for (i, ns) in [primary_ns, TypeNS, ValueNS, /*MacroNS*/].iter().cloned().enumerate() {
3319 if i == 0 || ns != primary_ns {
3320 match self.resolve_qpath(id, qself, path, ns, span, global_by_default, crate_lint) {
3321 // If defer_to_typeck, then resolution > no resolution,
3322 // otherwise full resolution > partial resolution > no resolution.
3323 Some(res) if res.unresolved_segments() == 0 || defer_to_typeck =>
3325 res => if fin_res.is_none() { fin_res = res },
3329 if primary_ns != MacroNS &&
3330 (self.macro_names.contains(&path[0].ident.modern()) ||
3331 self.builtin_macros.get(&path[0].ident.name).cloned()
3332 .and_then(NameBinding::macro_kind) == Some(MacroKind::Bang) ||
3333 self.macro_use_prelude.get(&path[0].ident.name).cloned()
3334 .and_then(NameBinding::macro_kind) == Some(MacroKind::Bang)) {
3335 // Return some dummy definition, it's enough for error reporting.
3337 PathResolution::new(Def::Macro(DefId::local(CRATE_DEF_INDEX), MacroKind::Bang))
3343 /// Handles paths that may refer to associated items.
3344 fn resolve_qpath(&mut self,
3346 qself: Option<&QSelf>,
3350 global_by_default: bool,
3351 crate_lint: CrateLint)
3352 -> Option<PathResolution> {
3354 "resolve_qpath(id={:?}, qself={:?}, path={:?}, \
3355 ns={:?}, span={:?}, global_by_default={:?})",
3364 if let Some(qself) = qself {
3365 if qself.position == 0 {
3366 // This is a case like `<T>::B`, where there is no
3367 // trait to resolve. In that case, we leave the `B`
3368 // segment to be resolved by type-check.
3369 return Some(PathResolution::with_unresolved_segments(
3370 Def::Mod(DefId::local(CRATE_DEF_INDEX)), path.len()
3374 // Make sure `A::B` in `<T as A::B>::C` is a trait item.
3376 // Currently, `path` names the full item (`A::B::C`, in
3377 // our example). so we extract the prefix of that that is
3378 // the trait (the slice upto and including
3379 // `qself.position`). And then we recursively resolve that,
3380 // but with `qself` set to `None`.
3382 // However, setting `qself` to none (but not changing the
3383 // span) loses the information about where this path
3384 // *actually* appears, so for the purposes of the crate
3385 // lint we pass along information that this is the trait
3386 // name from a fully qualified path, and this also
3387 // contains the full span (the `CrateLint::QPathTrait`).
3388 let ns = if qself.position + 1 == path.len() { ns } else { TypeNS };
3389 let res = self.smart_resolve_path_fragment(
3392 &path[..=qself.position],
3394 PathSource::TraitItem(ns),
3395 CrateLint::QPathTrait {
3397 qpath_span: qself.path_span,
3401 // The remaining segments (the `C` in our example) will
3402 // have to be resolved by type-check, since that requires doing
3403 // trait resolution.
3404 return Some(PathResolution::with_unresolved_segments(
3405 res.base_def(), res.unresolved_segments() + path.len() - qself.position - 1
3409 let result = match self.resolve_path_without_parent_scope(
3416 PathResult::NonModule(path_res) => path_res,
3417 PathResult::Module(ModuleOrUniformRoot::Module(module)) if !module.is_normal() => {
3418 PathResolution::new(module.def().unwrap())
3420 // In `a(::assoc_item)*` `a` cannot be a module. If `a` does resolve to a module we
3421 // don't report an error right away, but try to fallback to a primitive type.
3422 // So, we are still able to successfully resolve something like
3424 // use std::u8; // bring module u8 in scope
3425 // fn f() -> u8 { // OK, resolves to primitive u8, not to std::u8
3426 // u8::max_value() // OK, resolves to associated function <u8>::max_value,
3427 // // not to non-existent std::u8::max_value
3430 // Such behavior is required for backward compatibility.
3431 // The same fallback is used when `a` resolves to nothing.
3432 PathResult::Module(ModuleOrUniformRoot::Module(_)) |
3433 PathResult::Failed(..)
3434 if (ns == TypeNS || path.len() > 1) &&
3435 self.primitive_type_table.primitive_types
3436 .contains_key(&path[0].ident.name) => {
3437 let prim = self.primitive_type_table.primitive_types[&path[0].ident.name];
3438 PathResolution::with_unresolved_segments(Def::PrimTy(prim), path.len() - 1)
3440 PathResult::Module(ModuleOrUniformRoot::Module(module)) =>
3441 PathResolution::new(module.def().unwrap()),
3442 PathResult::Failed(span, msg, false) => {
3443 resolve_error(self, span, ResolutionError::FailedToResolve(&msg));
3444 err_path_resolution()
3446 PathResult::Module(..) | PathResult::Failed(..) => return None,
3447 PathResult::Indeterminate => bug!("indetermined path result in resolve_qpath"),
3450 if path.len() > 1 && !global_by_default && result.base_def() != Def::Err &&
3451 path[0].ident.name != keywords::PathRoot.name() &&
3452 path[0].ident.name != keywords::DollarCrate.name() {
3453 let unqualified_result = {
3454 match self.resolve_path_without_parent_scope(
3455 &[*path.last().unwrap()],
3461 PathResult::NonModule(path_res) => path_res.base_def(),
3462 PathResult::Module(ModuleOrUniformRoot::Module(module)) =>
3463 module.def().unwrap(),
3464 _ => return Some(result),
3467 if result.base_def() == unqualified_result {
3468 let lint = lint::builtin::UNUSED_QUALIFICATIONS;
3469 self.session.buffer_lint(lint, id, span, "unnecessary qualification")
3476 fn resolve_path_without_parent_scope(
3479 opt_ns: Option<Namespace>, // `None` indicates a module path in import
3482 crate_lint: CrateLint,
3483 ) -> PathResult<'a> {
3484 // Macro and import paths must have full parent scope available during resolution,
3485 // other paths will do okay with parent module alone.
3486 assert!(opt_ns != None && opt_ns != Some(MacroNS));
3487 let parent_scope = ParentScope { module: self.current_module, ..self.dummy_parent_scope() };
3488 self.resolve_path(path, opt_ns, &parent_scope, record_used, path_span, crate_lint)
3494 opt_ns: Option<Namespace>, // `None` indicates a module path in import
3495 parent_scope: &ParentScope<'a>,
3498 crate_lint: CrateLint,
3499 ) -> PathResult<'a> {
3500 let mut module = None;
3501 let mut allow_super = true;
3502 let mut second_binding = None;
3503 self.current_module = parent_scope.module;
3506 "resolve_path(path={:?}, opt_ns={:?}, record_used={:?}, \
3507 path_span={:?}, crate_lint={:?})",
3515 for (i, &Segment { ident, id }) in path.iter().enumerate() {
3516 debug!("resolve_path ident {} {:?} {:?}", i, ident, id);
3517 let record_segment_def = |this: &mut Self, def| {
3519 if let Some(id) = id {
3520 if !this.def_map.contains_key(&id) {
3521 assert!(id != ast::DUMMY_NODE_ID, "Trying to resolve dummy id");
3522 this.record_def(id, PathResolution::new(def));
3528 let is_last = i == path.len() - 1;
3529 let ns = if is_last { opt_ns.unwrap_or(TypeNS) } else { TypeNS };
3530 let name = ident.name;
3532 allow_super &= ns == TypeNS &&
3533 (name == keywords::SelfLower.name() ||
3534 name == keywords::Super.name());
3537 if allow_super && name == keywords::Super.name() {
3538 let mut ctxt = ident.span.ctxt().modern();
3539 let self_module = match i {
3540 0 => Some(self.resolve_self(&mut ctxt, self.current_module)),
3542 Some(ModuleOrUniformRoot::Module(module)) => Some(module),
3546 if let Some(self_module) = self_module {
3547 if let Some(parent) = self_module.parent {
3548 module = Some(ModuleOrUniformRoot::Module(
3549 self.resolve_self(&mut ctxt, parent)));
3553 let msg = "there are too many initial `super`s.".to_string();
3554 return PathResult::Failed(ident.span, msg, false);
3557 if name == keywords::SelfLower.name() {
3558 let mut ctxt = ident.span.ctxt().modern();
3559 module = Some(ModuleOrUniformRoot::Module(
3560 self.resolve_self(&mut ctxt, self.current_module)));
3563 if name == keywords::PathRoot.name() && ident.span.rust_2018() {
3564 module = Some(ModuleOrUniformRoot::ExternPrelude);
3567 if name == keywords::PathRoot.name() &&
3568 ident.span.rust_2015() && self.session.rust_2018() {
3569 // `::a::b` from 2015 macro on 2018 global edition
3570 module = Some(ModuleOrUniformRoot::CrateRootAndExternPrelude);
3573 if name == keywords::PathRoot.name() ||
3574 name == keywords::Crate.name() ||
3575 name == keywords::DollarCrate.name() {
3576 // `::a::b`, `crate::a::b` or `$crate::a::b`
3577 module = Some(ModuleOrUniformRoot::Module(
3578 self.resolve_crate_root(ident)));
3584 // Report special messages for path segment keywords in wrong positions.
3585 if ident.is_path_segment_keyword() && i != 0 {
3586 let name_str = if name == keywords::PathRoot.name() {
3587 "crate root".to_string()
3589 format!("`{}`", name)
3591 let msg = if i == 1 && path[0].ident.name == keywords::PathRoot.name() {
3592 format!("global paths cannot start with {}", name_str)
3594 format!("{} in paths can only be used in start position", name_str)
3596 return PathResult::Failed(ident.span, msg, false);
3599 let binding = if let Some(module) = module {
3600 self.resolve_ident_in_module(module, ident, ns, None, record_used, path_span)
3601 } else if opt_ns.is_none() || opt_ns == Some(MacroNS) {
3602 assert!(ns == TypeNS);
3603 let scopes = if opt_ns.is_none() { ScopeSet::Import(ns) } else { ScopeSet::Module };
3604 self.early_resolve_ident_in_lexical_scope(ident, scopes, parent_scope, record_used,
3605 record_used, path_span)
3607 let record_used_id =
3608 if record_used { crate_lint.node_id().or(Some(CRATE_NODE_ID)) } else { None };
3609 match self.resolve_ident_in_lexical_scope(ident, ns, record_used_id, path_span) {
3610 // we found a locally-imported or available item/module
3611 Some(LexicalScopeBinding::Item(binding)) => Ok(binding),
3612 // we found a local variable or type param
3613 Some(LexicalScopeBinding::Def(def))
3614 if opt_ns == Some(TypeNS) || opt_ns == Some(ValueNS) => {
3615 record_segment_def(self, def);
3616 return PathResult::NonModule(PathResolution::with_unresolved_segments(
3620 _ => Err(Determinacy::determined(record_used)),
3627 second_binding = Some(binding);
3629 let def = binding.def();
3630 let maybe_assoc = opt_ns != Some(MacroNS) && PathSource::Type.is_expected(def);
3631 if let Some(next_module) = binding.module() {
3632 module = Some(ModuleOrUniformRoot::Module(next_module));
3633 record_segment_def(self, def);
3634 } else if def == Def::ToolMod && i + 1 != path.len() {
3635 if binding.is_import() {
3636 self.session.struct_span_err(
3637 ident.span, "cannot use a tool module through an import"
3639 binding.span, "the tool module imported here"
3642 let def = Def::NonMacroAttr(NonMacroAttrKind::Tool);
3643 return PathResult::NonModule(PathResolution::new(def));
3644 } else if def == Def::Err {
3645 return PathResult::NonModule(err_path_resolution());
3646 } else if opt_ns.is_some() && (is_last || maybe_assoc) {
3647 self.lint_if_path_starts_with_module(
3653 return PathResult::NonModule(PathResolution::with_unresolved_segments(
3654 def, path.len() - i - 1
3657 return PathResult::Failed(ident.span,
3658 format!("not a module `{}`", ident),
3662 Err(Undetermined) => return PathResult::Indeterminate,
3663 Err(Determined) => {
3664 if let Some(ModuleOrUniformRoot::Module(module)) = module {
3665 if opt_ns.is_some() && !module.is_normal() {
3666 return PathResult::NonModule(PathResolution::with_unresolved_segments(
3667 module.def().unwrap(), path.len() - i
3671 let module_def = match module {
3672 Some(ModuleOrUniformRoot::Module(module)) => module.def(),
3675 let msg = if module_def == self.graph_root.def() {
3676 let is_mod = |def| match def { Def::Mod(..) => true, _ => false };
3677 let mut candidates =
3678 self.lookup_import_candidates(ident, TypeNS, is_mod);
3679 candidates.sort_by_cached_key(|c| {
3680 (c.path.segments.len(), c.path.to_string())
3682 if let Some(candidate) = candidates.get(0) {
3683 format!("did you mean `{}`?", candidate.path)
3684 } else if !ident.is_reserved() {
3685 format!("maybe a missing `extern crate {};`?", ident)
3687 // the parser will already have complained about the keyword being used
3688 return PathResult::NonModule(err_path_resolution());
3691 format!("use of undeclared type or module `{}`", ident)
3693 format!("could not find `{}` in `{}`", ident, path[i - 1].ident)
3695 return PathResult::Failed(ident.span, msg, is_last);
3700 self.lint_if_path_starts_with_module(crate_lint, path, path_span, second_binding);
3702 PathResult::Module(match module {
3703 Some(module) => module,
3704 None if path.is_empty() => ModuleOrUniformRoot::CurrentScope,
3705 _ => span_bug!(path_span, "resolve_path: non-empty path `{:?}` has no module", path),
3709 fn lint_if_path_starts_with_module(
3711 crate_lint: CrateLint,
3714 second_binding: Option<&NameBinding<'_>>,
3716 let (diag_id, diag_span) = match crate_lint {
3717 CrateLint::No => return,
3718 CrateLint::SimplePath(id) => (id, path_span),
3719 CrateLint::UsePath { root_id, root_span } => (root_id, root_span),
3720 CrateLint::QPathTrait { qpath_id, qpath_span } => (qpath_id, qpath_span),
3723 let first_name = match path.get(0) {
3724 // In the 2018 edition this lint is a hard error, so nothing to do
3725 Some(seg) if seg.ident.span.rust_2015() && self.session.rust_2015() => seg.ident.name,
3729 // We're only interested in `use` paths which should start with
3730 // `{{root}}` currently.
3731 if first_name != keywords::PathRoot.name() {
3736 // If this import looks like `crate::...` it's already good
3737 Some(Segment { ident, .. }) if ident.name == keywords::Crate.name() => return,
3738 // Otherwise go below to see if it's an extern crate
3740 // If the path has length one (and it's `PathRoot` most likely)
3741 // then we don't know whether we're gonna be importing a crate or an
3742 // item in our crate. Defer this lint to elsewhere
3746 // If the first element of our path was actually resolved to an
3747 // `ExternCrate` (also used for `crate::...`) then no need to issue a
3748 // warning, this looks all good!
3749 if let Some(binding) = second_binding {
3750 if let NameBindingKind::Import { directive: d, .. } = binding.kind {
3751 // Careful: we still want to rewrite paths from
3752 // renamed extern crates.
3753 if let ImportDirectiveSubclass::ExternCrate { source: None, .. } = d.subclass {
3759 let diag = lint::builtin::BuiltinLintDiagnostics
3760 ::AbsPathWithModule(diag_span);
3761 self.session.buffer_lint_with_diagnostic(
3762 lint::builtin::ABSOLUTE_PATHS_NOT_STARTING_WITH_CRATE,
3764 "absolute paths must start with `self`, `super`, \
3765 `crate`, or an external crate name in the 2018 edition",
3769 // Resolve a local definition, potentially adjusting for closures.
3770 fn adjust_local_def(&mut self,
3775 span: Span) -> Def {
3776 debug!("adjust_local_def");
3777 let ribs = &self.ribs[ns][rib_index + 1..];
3779 // An invalid forward use of a type parameter from a previous default.
3780 if let ForwardTyParamBanRibKind = self.ribs[ns][rib_index].kind {
3782 resolve_error(self, span, ResolutionError::ForwardDeclaredTyParam);
3784 assert_eq!(def, Def::Err);
3790 span_bug!(span, "unexpected {:?} in bindings", def)
3792 Def::Local(node_id) => {
3793 use ResolutionError::*;
3794 let mut res_err = None;
3798 NormalRibKind | ModuleRibKind(..) | MacroDefinition(..) |
3799 ForwardTyParamBanRibKind => {
3800 // Nothing to do. Continue.
3802 ClosureRibKind(function_id) => {
3805 let seen = self.freevars_seen
3808 if let Some(&index) = seen.get(&node_id) {
3809 def = Def::Upvar(node_id, index, function_id);
3812 let vec = self.freevars
3815 let depth = vec.len();
3816 def = Def::Upvar(node_id, depth, function_id);
3823 seen.insert(node_id, depth);
3826 ItemRibKind | TraitOrImplItemRibKind => {
3827 // This was an attempt to access an upvar inside a
3828 // named function item. This is not allowed, so we
3831 // We don't immediately trigger a resolve error, because
3832 // we want certain other resolution errors (namely those
3833 // emitted for `ConstantItemRibKind` below) to take
3835 res_err = Some(CannotCaptureDynamicEnvironmentInFnItem);
3838 ConstantItemRibKind => {
3839 // Still doesn't deal with upvars
3841 resolve_error(self, span, AttemptToUseNonConstantValueInConstant);
3847 if let Some(res_err) = res_err {
3848 resolve_error(self, span, res_err);
3852 Def::TyParam(..) | Def::SelfTy(..) => {
3855 NormalRibKind | TraitOrImplItemRibKind | ClosureRibKind(..) |
3856 ModuleRibKind(..) | MacroDefinition(..) | ForwardTyParamBanRibKind |
3857 ConstantItemRibKind => {
3858 // Nothing to do. Continue.
3861 // This was an attempt to use a type parameter outside its scope.
3866 ResolutionError::GenericParamsFromOuterFunction(def),
3874 Def::ConstParam(..) => {
3875 // A const param is always declared in a signature, which is always followed by
3876 // some kind of function rib kind (specifically, ItemRibKind in the case of a
3877 // normal function), so we can skip the first rib as it will be guaranteed to
3878 // (spuriously) conflict with the const param.
3879 for rib in &ribs[1..] {
3880 if let ItemRibKind = rib.kind {
3881 // This was an attempt to use a const parameter outside its scope.
3886 ResolutionError::GenericParamsFromOuterFunction(def),
3898 fn lookup_assoc_candidate<FilterFn>(&mut self,
3901 filter_fn: FilterFn)
3902 -> Option<AssocSuggestion>
3903 where FilterFn: Fn(Def) -> bool
3905 fn extract_node_id(t: &Ty) -> Option<NodeId> {
3907 TyKind::Path(None, _) => Some(t.id),
3908 TyKind::Rptr(_, ref mut_ty) => extract_node_id(&mut_ty.ty),
3909 // This doesn't handle the remaining `Ty` variants as they are not
3910 // that commonly the self_type, it might be interesting to provide
3911 // support for those in future.
3916 // Fields are generally expected in the same contexts as locals.
3917 if filter_fn(Def::Local(ast::DUMMY_NODE_ID)) {
3918 if let Some(node_id) = self.current_self_type.as_ref().and_then(extract_node_id) {
3919 // Look for a field with the same name in the current self_type.
3920 if let Some(resolution) = self.def_map.get(&node_id) {
3921 match resolution.base_def() {
3922 Def::Struct(did) | Def::Union(did)
3923 if resolution.unresolved_segments() == 0 => {
3924 if let Some(field_names) = self.field_names.get(&did) {
3925 if field_names.iter().any(|&field_name| ident.name == field_name) {
3926 return Some(AssocSuggestion::Field);
3936 // Look for associated items in the current trait.
3937 if let Some((module, _)) = self.current_trait_ref {
3938 if let Ok(binding) = self.resolve_ident_in_module(
3939 ModuleOrUniformRoot::Module(module),
3946 let def = binding.def();
3948 return Some(if self.has_self.contains(&def.def_id()) {
3949 AssocSuggestion::MethodWithSelf
3951 AssocSuggestion::AssocItem
3960 fn lookup_typo_candidate<FilterFn>(
3964 filter_fn: FilterFn,
3966 ) -> Option<TypoSuggestion>
3968 FilterFn: Fn(Def) -> bool,
3970 let add_module_candidates = |module: Module<'_>, names: &mut Vec<TypoSuggestion>| {
3971 for (&(ident, _), resolution) in module.resolutions.borrow().iter() {
3972 if let Some(binding) = resolution.borrow().binding {
3973 if filter_fn(binding.def()) {
3974 names.push(TypoSuggestion {
3975 candidate: ident.name,
3976 article: binding.def().article(),
3977 kind: binding.def().kind_name(),
3984 let mut names = Vec::new();
3985 if path.len() == 1 {
3986 // Search in lexical scope.
3987 // Walk backwards up the ribs in scope and collect candidates.
3988 for rib in self.ribs[ns].iter().rev() {
3989 // Locals and type parameters
3990 for (ident, def) in &rib.bindings {
3991 if filter_fn(*def) {
3992 names.push(TypoSuggestion {
3993 candidate: ident.name,
3994 article: def.article(),
3995 kind: def.kind_name(),
4000 if let ModuleRibKind(module) = rib.kind {
4001 // Items from this module
4002 add_module_candidates(module, &mut names);
4004 if let ModuleKind::Block(..) = module.kind {
4005 // We can see through blocks
4007 // Items from the prelude
4008 if !module.no_implicit_prelude {
4009 names.extend(self.extern_prelude.iter().map(|(ident, _)| {
4011 candidate: ident.name,
4016 if let Some(prelude) = self.prelude {
4017 add_module_candidates(prelude, &mut names);
4024 // Add primitive types to the mix
4025 if filter_fn(Def::PrimTy(Bool)) {
4027 self.primitive_type_table.primitive_types.iter().map(|(name, _)| {
4031 kind: "primitive type",
4037 // Search in module.
4038 let mod_path = &path[..path.len() - 1];
4039 if let PathResult::Module(module) = self.resolve_path_without_parent_scope(
4040 mod_path, Some(TypeNS), false, span, CrateLint::No
4042 if let ModuleOrUniformRoot::Module(module) = module {
4043 add_module_candidates(module, &mut names);
4048 let name = path[path.len() - 1].ident.name;
4049 // Make sure error reporting is deterministic.
4050 names.sort_by_cached_key(|suggestion| suggestion.candidate.as_str());
4052 match find_best_match_for_name(
4053 names.iter().map(|suggestion| &suggestion.candidate),
4057 Some(found) if found != name => names
4059 .find(|suggestion| suggestion.candidate == found),
4064 fn with_resolved_label<F>(&mut self, label: Option<Label>, id: NodeId, f: F)
4065 where F: FnOnce(&mut Resolver<'_>)
4067 if let Some(label) = label {
4068 self.unused_labels.insert(id, label.ident.span);
4069 let def = Def::Label(id);
4070 self.with_label_rib(|this| {
4071 let ident = label.ident.modern_and_legacy();
4072 this.label_ribs.last_mut().unwrap().bindings.insert(ident, def);
4080 fn resolve_labeled_block(&mut self, label: Option<Label>, id: NodeId, block: &Block) {
4081 self.with_resolved_label(label, id, |this| this.visit_block(block));
4084 fn resolve_expr(&mut self, expr: &Expr, parent: Option<&Expr>) {
4085 // First, record candidate traits for this expression if it could
4086 // result in the invocation of a method call.
4088 self.record_candidate_traits_for_expr_if_necessary(expr);
4090 // Next, resolve the node.
4092 ExprKind::Path(ref qself, ref path) => {
4093 self.smart_resolve_path(expr.id, qself.as_ref(), path, PathSource::Expr(parent));
4094 visit::walk_expr(self, expr);
4097 ExprKind::Struct(ref path, ..) => {
4098 self.smart_resolve_path(expr.id, None, path, PathSource::Struct);
4099 visit::walk_expr(self, expr);
4102 ExprKind::Break(Some(label), _) | ExprKind::Continue(Some(label)) => {
4103 let def = self.search_label(label.ident, |rib, ident| {
4104 rib.bindings.get(&ident.modern_and_legacy()).cloned()
4108 // Search again for close matches...
4109 // Picks the first label that is "close enough", which is not necessarily
4110 // the closest match
4111 let close_match = self.search_label(label.ident, |rib, ident| {
4112 let names = rib.bindings.iter().map(|(id, _)| &id.name);
4113 find_best_match_for_name(names, &*ident.as_str(), None)
4115 self.record_def(expr.id, err_path_resolution());
4118 ResolutionError::UndeclaredLabel(&label.ident.as_str(),
4121 Some(Def::Label(id)) => {
4122 // Since this def is a label, it is never read.
4123 self.record_def(expr.id, PathResolution::new(Def::Label(id)));
4124 self.unused_labels.remove(&id);
4127 span_bug!(expr.span, "label wasn't mapped to a label def!");
4131 // visit `break` argument if any
4132 visit::walk_expr(self, expr);
4135 ExprKind::IfLet(ref pats, ref subexpression, ref if_block, ref optional_else) => {
4136 self.visit_expr(subexpression);
4138 self.ribs[ValueNS].push(Rib::new(NormalRibKind));
4139 let mut bindings_list = FxHashMap::default();
4141 self.resolve_pattern(pat, PatternSource::IfLet, &mut bindings_list);
4143 // This has to happen *after* we determine which pat_idents are variants
4144 self.check_consistent_bindings(pats);
4145 self.visit_block(if_block);
4146 self.ribs[ValueNS].pop();
4148 optional_else.as_ref().map(|expr| self.visit_expr(expr));
4151 ExprKind::Loop(ref block, label) => self.resolve_labeled_block(label, expr.id, &block),
4153 ExprKind::While(ref subexpression, ref block, label) => {
4154 self.with_resolved_label(label, expr.id, |this| {
4155 this.visit_expr(subexpression);
4156 this.visit_block(block);
4160 ExprKind::WhileLet(ref pats, ref subexpression, ref block, label) => {
4161 self.with_resolved_label(label, expr.id, |this| {
4162 this.visit_expr(subexpression);
4163 this.ribs[ValueNS].push(Rib::new(NormalRibKind));
4164 let mut bindings_list = FxHashMap::default();
4166 this.resolve_pattern(pat, PatternSource::WhileLet, &mut bindings_list);
4168 // This has to happen *after* we determine which pat_idents are variants.
4169 this.check_consistent_bindings(pats);
4170 this.visit_block(block);
4171 this.ribs[ValueNS].pop();
4175 ExprKind::ForLoop(ref pattern, ref subexpression, ref block, label) => {
4176 self.visit_expr(subexpression);
4177 self.ribs[ValueNS].push(Rib::new(NormalRibKind));
4178 self.resolve_pattern(pattern, PatternSource::For, &mut FxHashMap::default());
4180 self.resolve_labeled_block(label, expr.id, block);
4182 self.ribs[ValueNS].pop();
4185 ExprKind::Block(ref block, label) => self.resolve_labeled_block(label, block.id, block),
4187 // Equivalent to `visit::walk_expr` + passing some context to children.
4188 ExprKind::Field(ref subexpression, _) => {
4189 self.resolve_expr(subexpression, Some(expr));
4191 ExprKind::MethodCall(ref segment, ref arguments) => {
4192 let mut arguments = arguments.iter();
4193 self.resolve_expr(arguments.next().unwrap(), Some(expr));
4194 for argument in arguments {
4195 self.resolve_expr(argument, None);
4197 self.visit_path_segment(expr.span, segment);
4200 ExprKind::Call(ref callee, ref arguments) => {
4201 self.resolve_expr(callee, Some(expr));
4202 for argument in arguments {
4203 self.resolve_expr(argument, None);
4206 ExprKind::Type(ref type_expr, _) => {
4207 self.current_type_ascription.push(type_expr.span);
4208 visit::walk_expr(self, expr);
4209 self.current_type_ascription.pop();
4211 // Resolve the body of async exprs inside the async closure to which they desugar
4212 ExprKind::Async(_, async_closure_id, ref block) => {
4213 let rib_kind = ClosureRibKind(async_closure_id);
4214 self.ribs[ValueNS].push(Rib::new(rib_kind));
4215 self.label_ribs.push(Rib::new(rib_kind));
4216 self.visit_block(&block);
4217 self.label_ribs.pop();
4218 self.ribs[ValueNS].pop();
4220 // `async |x| ...` gets desugared to `|x| future_from_generator(|| ...)`, so we need to
4221 // resolve the arguments within the proper scopes so that usages of them inside the
4222 // closure are detected as upvars rather than normal closure arg usages.
4224 _, IsAsync::Async { closure_id: inner_closure_id, .. }, _,
4225 ref fn_decl, ref body, _span,
4227 let rib_kind = ClosureRibKind(expr.id);
4228 self.ribs[ValueNS].push(Rib::new(rib_kind));
4229 self.label_ribs.push(Rib::new(rib_kind));
4230 // Resolve arguments:
4231 let mut bindings_list = FxHashMap::default();
4232 for argument in &fn_decl.inputs {
4233 self.resolve_pattern(&argument.pat, PatternSource::FnParam, &mut bindings_list);
4234 self.visit_ty(&argument.ty);
4236 // No need to resolve return type-- the outer closure return type is
4237 // FunctionRetTy::Default
4239 // Now resolve the inner closure
4241 let rib_kind = ClosureRibKind(inner_closure_id);
4242 self.ribs[ValueNS].push(Rib::new(rib_kind));
4243 self.label_ribs.push(Rib::new(rib_kind));
4244 // No need to resolve arguments: the inner closure has none.
4245 // Resolve the return type:
4246 visit::walk_fn_ret_ty(self, &fn_decl.output);
4248 self.visit_expr(body);
4249 self.label_ribs.pop();
4250 self.ribs[ValueNS].pop();
4252 self.label_ribs.pop();
4253 self.ribs[ValueNS].pop();
4256 visit::walk_expr(self, expr);
4261 fn record_candidate_traits_for_expr_if_necessary(&mut self, expr: &Expr) {
4263 ExprKind::Field(_, ident) => {
4264 // FIXME(#6890): Even though you can't treat a method like a
4265 // field, we need to add any trait methods we find that match
4266 // the field name so that we can do some nice error reporting
4267 // later on in typeck.
4268 let traits = self.get_traits_containing_item(ident, ValueNS);
4269 self.trait_map.insert(expr.id, traits);
4271 ExprKind::MethodCall(ref segment, ..) => {
4272 debug!("(recording candidate traits for expr) recording traits for {}",
4274 let traits = self.get_traits_containing_item(segment.ident, ValueNS);
4275 self.trait_map.insert(expr.id, traits);
4283 fn get_traits_containing_item(&mut self, mut ident: Ident, ns: Namespace)
4284 -> Vec<TraitCandidate> {
4285 debug!("(getting traits containing item) looking for '{}'", ident.name);
4287 let mut found_traits = Vec::new();
4288 // Look for the current trait.
4289 if let Some((module, _)) = self.current_trait_ref {
4290 if self.resolve_ident_in_module(
4291 ModuleOrUniformRoot::Module(module),
4298 let def_id = module.def_id().unwrap();
4299 found_traits.push(TraitCandidate { def_id: def_id, import_id: None });
4303 ident.span = ident.span.modern();
4304 let mut search_module = self.current_module;
4306 self.get_traits_in_module_containing_item(ident, ns, search_module, &mut found_traits);
4307 search_module = unwrap_or!(
4308 self.hygienic_lexical_parent(search_module, &mut ident.span), break
4312 if let Some(prelude) = self.prelude {
4313 if !search_module.no_implicit_prelude {
4314 self.get_traits_in_module_containing_item(ident, ns, prelude, &mut found_traits);
4321 fn get_traits_in_module_containing_item(&mut self,
4325 found_traits: &mut Vec<TraitCandidate>) {
4326 assert!(ns == TypeNS || ns == ValueNS);
4327 let mut traits = module.traits.borrow_mut();
4328 if traits.is_none() {
4329 let mut collected_traits = Vec::new();
4330 module.for_each_child(|name, ns, binding| {
4331 if ns != TypeNS { return }
4332 if let Def::Trait(_) = binding.def() {
4333 collected_traits.push((name, binding));
4336 *traits = Some(collected_traits.into_boxed_slice());
4339 for &(trait_name, binding) in traits.as_ref().unwrap().iter() {
4340 let module = binding.module().unwrap();
4341 let mut ident = ident;
4342 if ident.span.glob_adjust(module.expansion, binding.span.ctxt().modern()).is_none() {
4345 if self.resolve_ident_in_module_unadjusted(
4346 ModuleOrUniformRoot::Module(module),
4352 let import_id = match binding.kind {
4353 NameBindingKind::Import { directive, .. } => {
4354 self.maybe_unused_trait_imports.insert(directive.id);
4355 self.add_to_glob_map(&directive, trait_name);
4360 let trait_def_id = module.def_id().unwrap();
4361 found_traits.push(TraitCandidate { def_id: trait_def_id, import_id: import_id });
4366 fn lookup_import_candidates_from_module<FilterFn>(&mut self,
4367 lookup_ident: Ident,
4368 namespace: Namespace,
4369 start_module: &'a ModuleData<'a>,
4371 filter_fn: FilterFn)
4372 -> Vec<ImportSuggestion>
4373 where FilterFn: Fn(Def) -> bool
4375 let mut candidates = Vec::new();
4376 let mut seen_modules = FxHashSet::default();
4377 let not_local_module = crate_name != keywords::Crate.ident();
4378 let mut worklist = vec![(start_module, Vec::<ast::PathSegment>::new(), not_local_module)];
4380 while let Some((in_module,
4382 in_module_is_extern)) = worklist.pop() {
4383 self.populate_module_if_necessary(in_module);
4385 // We have to visit module children in deterministic order to avoid
4386 // instabilities in reported imports (#43552).
4387 in_module.for_each_child_stable(|ident, ns, name_binding| {
4388 // avoid imports entirely
4389 if name_binding.is_import() && !name_binding.is_extern_crate() { return; }
4390 // avoid non-importable candidates as well
4391 if !name_binding.is_importable() { return; }
4393 // collect results based on the filter function
4394 if ident.name == lookup_ident.name && ns == namespace {
4395 if filter_fn(name_binding.def()) {
4397 let mut segms = path_segments.clone();
4398 if lookup_ident.span.rust_2018() {
4399 // crate-local absolute paths start with `crate::` in edition 2018
4400 // FIXME: may also be stabilized for Rust 2015 (Issues #45477, #44660)
4402 0, ast::PathSegment::from_ident(crate_name)
4406 segms.push(ast::PathSegment::from_ident(ident));
4408 span: name_binding.span,
4411 // the entity is accessible in the following cases:
4412 // 1. if it's defined in the same crate, it's always
4413 // accessible (since private entities can be made public)
4414 // 2. if it's defined in another crate, it's accessible
4415 // only if both the module is public and the entity is
4416 // declared as public (due to pruning, we don't explore
4417 // outside crate private modules => no need to check this)
4418 if !in_module_is_extern || name_binding.vis == ty::Visibility::Public {
4419 candidates.push(ImportSuggestion { path });
4424 // collect submodules to explore
4425 if let Some(module) = name_binding.module() {
4427 let mut path_segments = path_segments.clone();
4428 path_segments.push(ast::PathSegment::from_ident(ident));
4430 let is_extern_crate_that_also_appears_in_prelude =
4431 name_binding.is_extern_crate() &&
4432 lookup_ident.span.rust_2018();
4434 let is_visible_to_user =
4435 !in_module_is_extern || name_binding.vis == ty::Visibility::Public;
4437 if !is_extern_crate_that_also_appears_in_prelude && is_visible_to_user {
4438 // add the module to the lookup
4439 let is_extern = in_module_is_extern || name_binding.is_extern_crate();
4440 if seen_modules.insert(module.def_id().unwrap()) {
4441 worklist.push((module, path_segments, is_extern));
4451 /// When name resolution fails, this method can be used to look up candidate
4452 /// entities with the expected name. It allows filtering them using the
4453 /// supplied predicate (which should be used to only accept the types of
4454 /// definitions expected e.g., traits). The lookup spans across all crates.
4456 /// NOTE: The method does not look into imports, but this is not a problem,
4457 /// since we report the definitions (thus, the de-aliased imports).
4458 fn lookup_import_candidates<FilterFn>(&mut self,
4459 lookup_ident: Ident,
4460 namespace: Namespace,
4461 filter_fn: FilterFn)
4462 -> Vec<ImportSuggestion>
4463 where FilterFn: Fn(Def) -> bool
4465 let mut suggestions = self.lookup_import_candidates_from_module(
4466 lookup_ident, namespace, self.graph_root, keywords::Crate.ident(), &filter_fn);
4468 if lookup_ident.span.rust_2018() {
4469 let extern_prelude_names = self.extern_prelude.clone();
4470 for (ident, _) in extern_prelude_names.into_iter() {
4471 if let Some(crate_id) = self.crate_loader.maybe_process_path_extern(ident.name,
4473 let crate_root = self.get_module(DefId {
4475 index: CRATE_DEF_INDEX,
4477 self.populate_module_if_necessary(&crate_root);
4479 suggestions.extend(self.lookup_import_candidates_from_module(
4480 lookup_ident, namespace, crate_root, ident, &filter_fn));
4488 fn find_module(&mut self,
4490 -> Option<(Module<'a>, ImportSuggestion)>
4492 let mut result = None;
4493 let mut seen_modules = FxHashSet::default();
4494 let mut worklist = vec![(self.graph_root, Vec::new())];
4496 while let Some((in_module, path_segments)) = worklist.pop() {
4497 // abort if the module is already found
4498 if result.is_some() { break; }
4500 self.populate_module_if_necessary(in_module);
4502 in_module.for_each_child_stable(|ident, _, name_binding| {
4503 // abort if the module is already found or if name_binding is private external
4504 if result.is_some() || !name_binding.vis.is_visible_locally() {
4507 if let Some(module) = name_binding.module() {
4509 let mut path_segments = path_segments.clone();
4510 path_segments.push(ast::PathSegment::from_ident(ident));
4511 if module.def() == Some(module_def) {
4513 span: name_binding.span,
4514 segments: path_segments,
4516 result = Some((module, ImportSuggestion { path }));
4518 // add the module to the lookup
4519 if seen_modules.insert(module.def_id().unwrap()) {
4520 worklist.push((module, path_segments));
4530 fn collect_enum_variants(&mut self, enum_def: Def) -> Option<Vec<Path>> {
4531 if let Def::Enum(..) = enum_def {} else {
4532 panic!("Non-enum def passed to collect_enum_variants: {:?}", enum_def)
4535 self.find_module(enum_def).map(|(enum_module, enum_import_suggestion)| {
4536 self.populate_module_if_necessary(enum_module);
4538 let mut variants = Vec::new();
4539 enum_module.for_each_child_stable(|ident, _, name_binding| {
4540 if let Def::Variant(..) = name_binding.def() {
4541 let mut segms = enum_import_suggestion.path.segments.clone();
4542 segms.push(ast::PathSegment::from_ident(ident));
4543 variants.push(Path {
4544 span: name_binding.span,
4553 fn record_def(&mut self, node_id: NodeId, resolution: PathResolution) {
4554 debug!("(recording def) recording {:?} for {}", resolution, node_id);
4555 if let Some(prev_res) = self.def_map.insert(node_id, resolution) {
4556 panic!("path resolved multiple times ({:?} before, {:?} now)", prev_res, resolution);
4560 fn resolve_visibility(&mut self, vis: &ast::Visibility) -> ty::Visibility {
4562 ast::VisibilityKind::Public => ty::Visibility::Public,
4563 ast::VisibilityKind::Crate(..) => {
4564 ty::Visibility::Restricted(DefId::local(CRATE_DEF_INDEX))
4566 ast::VisibilityKind::Inherited => {
4567 ty::Visibility::Restricted(self.current_module.normal_ancestor_id)
4569 ast::VisibilityKind::Restricted { ref path, id, .. } => {
4570 // For visibilities we are not ready to provide correct implementation of "uniform
4571 // paths" right now, so on 2018 edition we only allow module-relative paths for now.
4572 // On 2015 edition visibilities are resolved as crate-relative by default,
4573 // so we are prepending a root segment if necessary.
4574 let ident = path.segments.get(0).expect("empty path in visibility").ident;
4575 let crate_root = if ident.is_path_segment_keyword() {
4577 } else if ident.span.rust_2018() {
4578 let msg = "relative paths are not supported in visibilities on 2018 edition";
4579 self.session.struct_span_err(ident.span, msg)
4583 format!("crate::{}", path),
4584 Applicability::MaybeIncorrect,
4587 return ty::Visibility::Public;
4589 let ctxt = ident.span.ctxt();
4590 Some(Segment::from_ident(Ident::new(
4591 keywords::PathRoot.name(), path.span.shrink_to_lo().with_ctxt(ctxt)
4595 let segments = crate_root.into_iter()
4596 .chain(path.segments.iter().map(|seg| seg.into())).collect::<Vec<_>>();
4597 let def = self.smart_resolve_path_fragment(
4602 PathSource::Visibility,
4603 CrateLint::SimplePath(id),
4605 if def == Def::Err {
4606 ty::Visibility::Public
4608 let vis = ty::Visibility::Restricted(def.def_id());
4609 if self.is_accessible(vis) {
4612 self.session.span_err(path.span, "visibilities can only be restricted \
4613 to ancestor modules");
4614 ty::Visibility::Public
4621 fn is_accessible(&self, vis: ty::Visibility) -> bool {
4622 vis.is_accessible_from(self.current_module.normal_ancestor_id, self)
4625 fn is_accessible_from(&self, vis: ty::Visibility, module: Module<'a>) -> bool {
4626 vis.is_accessible_from(module.normal_ancestor_id, self)
4629 fn set_binding_parent_module(&mut self, binding: &'a NameBinding<'a>, module: Module<'a>) {
4630 if let Some(old_module) = self.binding_parent_modules.insert(PtrKey(binding), module) {
4631 if !ptr::eq(module, old_module) {
4632 span_bug!(binding.span, "parent module is reset for binding");
4637 fn disambiguate_legacy_vs_modern(
4639 legacy: &'a NameBinding<'a>,
4640 modern: &'a NameBinding<'a>,
4642 // Some non-controversial subset of ambiguities "modern macro name" vs "macro_rules"
4643 // is disambiguated to mitigate regressions from macro modularization.
4644 // Scoping for `macro_rules` behaves like scoping for `let` at module level, in general.
4645 match (self.binding_parent_modules.get(&PtrKey(legacy)),
4646 self.binding_parent_modules.get(&PtrKey(modern))) {
4647 (Some(legacy), Some(modern)) =>
4648 legacy.normal_ancestor_id == modern.normal_ancestor_id &&
4649 modern.is_ancestor_of(legacy),
4654 fn binding_description(&self, b: &NameBinding<'_>, ident: Ident, from_prelude: bool) -> String {
4655 if b.span.is_dummy() {
4656 let add_built_in = match b.def() {
4657 // These already contain the "built-in" prefix or look bad with it.
4658 Def::NonMacroAttr(..) | Def::PrimTy(..) | Def::ToolMod => false,
4661 let (built_in, from) = if from_prelude {
4662 ("", " from prelude")
4663 } else if b.is_extern_crate() && !b.is_import() &&
4664 self.session.opts.externs.get(&ident.as_str()).is_some() {
4665 ("", " passed with `--extern`")
4666 } else if add_built_in {
4672 let article = if built_in.is_empty() { b.article() } else { "a" };
4673 format!("{a}{built_in} {thing}{from}",
4674 a = article, thing = b.descr(), built_in = built_in, from = from)
4676 let introduced = if b.is_import() { "imported" } else { "defined" };
4677 format!("the {thing} {introduced} here",
4678 thing = b.descr(), introduced = introduced)
4682 fn report_ambiguity_error(&self, ambiguity_error: &AmbiguityError<'_>) {
4683 let AmbiguityError { kind, ident, b1, b2, misc1, misc2 } = *ambiguity_error;
4684 let (b1, b2, misc1, misc2, swapped) = if b2.span.is_dummy() && !b1.span.is_dummy() {
4685 // We have to print the span-less alternative first, otherwise formatting looks bad.
4686 (b2, b1, misc2, misc1, true)
4688 (b1, b2, misc1, misc2, false)
4691 let mut err = struct_span_err!(self.session, ident.span, E0659,
4692 "`{ident}` is ambiguous ({why})",
4693 ident = ident, why = kind.descr());
4694 err.span_label(ident.span, "ambiguous name");
4696 let mut could_refer_to = |b: &NameBinding<'_>, misc: AmbiguityErrorMisc, also: &str| {
4697 let what = self.binding_description(b, ident, misc == AmbiguityErrorMisc::FromPrelude);
4698 let note_msg = format!("`{ident}` could{also} refer to {what}",
4699 ident = ident, also = also, what = what);
4701 let mut help_msgs = Vec::new();
4702 if b.is_glob_import() && (kind == AmbiguityKind::GlobVsGlob ||
4703 kind == AmbiguityKind::GlobVsExpanded ||
4704 kind == AmbiguityKind::GlobVsOuter &&
4705 swapped != also.is_empty()) {
4706 help_msgs.push(format!("consider adding an explicit import of \
4707 `{ident}` to disambiguate", ident = ident))
4709 if b.is_extern_crate() && ident.span.rust_2018() {
4710 help_msgs.push(format!(
4711 "use `::{ident}` to refer to this {thing} unambiguously",
4712 ident = ident, thing = b.descr(),
4715 if misc == AmbiguityErrorMisc::SuggestCrate {
4716 help_msgs.push(format!(
4717 "use `crate::{ident}` to refer to this {thing} unambiguously",
4718 ident = ident, thing = b.descr(),
4720 } else if misc == AmbiguityErrorMisc::SuggestSelf {
4721 help_msgs.push(format!(
4722 "use `self::{ident}` to refer to this {thing} unambiguously",
4723 ident = ident, thing = b.descr(),
4727 err.span_note(b.span, ¬e_msg);
4728 for (i, help_msg) in help_msgs.iter().enumerate() {
4729 let or = if i == 0 { "" } else { "or " };
4730 err.help(&format!("{}{}", or, help_msg));
4734 could_refer_to(b1, misc1, "");
4735 could_refer_to(b2, misc2, " also");
4739 fn report_errors(&mut self, krate: &Crate) {
4740 self.report_with_use_injections(krate);
4742 for &(span_use, span_def) in &self.macro_expanded_macro_export_errors {
4743 let msg = "macro-expanded `macro_export` macros from the current crate \
4744 cannot be referred to by absolute paths";
4745 self.session.buffer_lint_with_diagnostic(
4746 lint::builtin::MACRO_EXPANDED_MACRO_EXPORTS_ACCESSED_BY_ABSOLUTE_PATHS,
4747 CRATE_NODE_ID, span_use, msg,
4748 lint::builtin::BuiltinLintDiagnostics::
4749 MacroExpandedMacroExportsAccessedByAbsolutePaths(span_def),
4753 for ambiguity_error in &self.ambiguity_errors {
4754 self.report_ambiguity_error(ambiguity_error);
4757 let mut reported_spans = FxHashSet::default();
4758 for &PrivacyError(dedup_span, ident, binding) in &self.privacy_errors {
4759 if reported_spans.insert(dedup_span) {
4760 span_err!(self.session, ident.span, E0603, "{} `{}` is private",
4761 binding.descr(), ident.name);
4766 fn report_with_use_injections(&mut self, krate: &Crate) {
4767 for UseError { mut err, candidates, node_id, better } in self.use_injections.drain(..) {
4768 let (span, found_use) = UsePlacementFinder::check(krate, node_id);
4769 if !candidates.is_empty() {
4770 show_candidates(&mut err, span, &candidates, better, found_use);
4776 fn report_conflict<'b>(&mut self,
4780 new_binding: &NameBinding<'b>,
4781 old_binding: &NameBinding<'b>) {
4782 // Error on the second of two conflicting names
4783 if old_binding.span.lo() > new_binding.span.lo() {
4784 return self.report_conflict(parent, ident, ns, old_binding, new_binding);
4787 let container = match parent.kind {
4788 ModuleKind::Def(Def::Mod(_), _) => "module",
4789 ModuleKind::Def(Def::Trait(_), _) => "trait",
4790 ModuleKind::Block(..) => "block",
4794 let old_noun = match old_binding.is_import() {
4796 false => "definition",
4799 let new_participle = match new_binding.is_import() {
4804 let (name, span) = (ident.name, self.session.source_map().def_span(new_binding.span));
4806 if let Some(s) = self.name_already_seen.get(&name) {
4812 let old_kind = match (ns, old_binding.module()) {
4813 (ValueNS, _) => "value",
4814 (MacroNS, _) => "macro",
4815 (TypeNS, _) if old_binding.is_extern_crate() => "extern crate",
4816 (TypeNS, Some(module)) if module.is_normal() => "module",
4817 (TypeNS, Some(module)) if module.is_trait() => "trait",
4818 (TypeNS, _) => "type",
4821 let msg = format!("the name `{}` is defined multiple times", name);
4823 let mut err = match (old_binding.is_extern_crate(), new_binding.is_extern_crate()) {
4824 (true, true) => struct_span_err!(self.session, span, E0259, "{}", msg),
4825 (true, _) | (_, true) => match new_binding.is_import() && old_binding.is_import() {
4826 true => struct_span_err!(self.session, span, E0254, "{}", msg),
4827 false => struct_span_err!(self.session, span, E0260, "{}", msg),
4829 _ => match (old_binding.is_import(), new_binding.is_import()) {
4830 (false, false) => struct_span_err!(self.session, span, E0428, "{}", msg),
4831 (true, true) => struct_span_err!(self.session, span, E0252, "{}", msg),
4832 _ => struct_span_err!(self.session, span, E0255, "{}", msg),
4836 err.note(&format!("`{}` must be defined only once in the {} namespace of this {}",
4841 err.span_label(span, format!("`{}` re{} here", name, new_participle));
4843 self.session.source_map().def_span(old_binding.span),
4844 format!("previous {} of the {} `{}` here", old_noun, old_kind, name),
4847 // See https://github.com/rust-lang/rust/issues/32354
4848 use NameBindingKind::Import;
4849 let directive = match (&new_binding.kind, &old_binding.kind) {
4850 // If there are two imports where one or both have attributes then prefer removing the
4851 // import without attributes.
4852 (Import { directive: new, .. }, Import { directive: old, .. }) if {
4853 !new_binding.span.is_dummy() && !old_binding.span.is_dummy() &&
4854 (new.has_attributes || old.has_attributes)
4856 if old.has_attributes {
4857 Some((new, new_binding.span, true))
4859 Some((old, old_binding.span, true))
4862 // Otherwise prioritize the new binding.
4863 (Import { directive, .. }, other) if !new_binding.span.is_dummy() =>
4864 Some((directive, new_binding.span, other.is_import())),
4865 (other, Import { directive, .. }) if !old_binding.span.is_dummy() =>
4866 Some((directive, old_binding.span, other.is_import())),
4870 // Check if the target of the use for both bindings is the same.
4871 let duplicate = new_binding.def().opt_def_id() == old_binding.def().opt_def_id();
4872 let has_dummy_span = new_binding.span.is_dummy() || old_binding.span.is_dummy();
4873 let from_item = self.extern_prelude.get(&ident)
4874 .map(|entry| entry.introduced_by_item)
4876 // Only suggest removing an import if both bindings are to the same def, if both spans
4877 // aren't dummy spans. Further, if both bindings are imports, then the ident must have
4878 // been introduced by a item.
4879 let should_remove_import = duplicate && !has_dummy_span &&
4880 ((new_binding.is_extern_crate() || old_binding.is_extern_crate()) || from_item);
4883 Some((directive, span, true)) if should_remove_import && directive.is_nested() =>
4884 self.add_suggestion_for_duplicate_nested_use(&mut err, directive, span),
4885 Some((directive, _, true)) if should_remove_import && !directive.is_glob() => {
4886 // Simple case - remove the entire import. Due to the above match arm, this can
4887 // only be a single use so just remove it entirely.
4888 err.span_suggestion(
4889 directive.use_span_with_attributes,
4890 "remove unnecessary import",
4892 Applicability::MaybeIncorrect,
4895 Some((directive, span, _)) =>
4896 self.add_suggestion_for_rename_of_use(&mut err, name, directive, span),
4901 self.name_already_seen.insert(name, span);
4904 /// This function adds a suggestion to change the binding name of a new import that conflicts
4905 /// with an existing import.
4907 /// ```ignore (diagnostic)
4908 /// help: you can use `as` to change the binding name of the import
4910 /// LL | use foo::bar as other_bar;
4911 /// | ^^^^^^^^^^^^^^^^^^^^^
4913 fn add_suggestion_for_rename_of_use(
4915 err: &mut DiagnosticBuilder<'_>,
4917 directive: &ImportDirective<'_>,
4920 let suggested_name = if name.as_str().chars().next().unwrap().is_uppercase() {
4921 format!("Other{}", name)
4923 format!("other_{}", name)
4926 let mut suggestion = None;
4927 match directive.subclass {
4928 ImportDirectiveSubclass::SingleImport { type_ns_only: true, .. } =>
4929 suggestion = Some(format!("self as {}", suggested_name)),
4930 ImportDirectiveSubclass::SingleImport { source, .. } => {
4931 if let Some(pos) = source.span.hi().0.checked_sub(binding_span.lo().0)
4932 .map(|pos| pos as usize) {
4933 if let Ok(snippet) = self.session.source_map()
4934 .span_to_snippet(binding_span) {
4935 if pos <= snippet.len() {
4936 suggestion = Some(format!(
4940 if snippet.ends_with(";") { ";" } else { "" }
4946 ImportDirectiveSubclass::ExternCrate { source, target, .. } =>
4947 suggestion = Some(format!(
4948 "extern crate {} as {};",
4949 source.unwrap_or(target.name),
4952 _ => unreachable!(),
4955 let rename_msg = "you can use `as` to change the binding name of the import";
4956 if let Some(suggestion) = suggestion {
4957 err.span_suggestion(
4961 Applicability::MaybeIncorrect,
4964 err.span_label(binding_span, rename_msg);
4968 /// This function adds a suggestion to remove a unnecessary binding from an import that is
4969 /// nested. In the following example, this function will be invoked to remove the `a` binding
4970 /// in the second use statement:
4972 /// ```ignore (diagnostic)
4973 /// use issue_52891::a;
4974 /// use issue_52891::{d, a, e};
4977 /// The following suggestion will be added:
4979 /// ```ignore (diagnostic)
4980 /// use issue_52891::{d, a, e};
4981 /// ^-- help: remove unnecessary import
4984 /// If the nested use contains only one import then the suggestion will remove the entire
4987 /// It is expected that the directive provided is a nested import - this isn't checked by the
4988 /// function. If this invariant is not upheld, this function's behaviour will be unexpected
4989 /// as characters expected by span manipulations won't be present.
4990 fn add_suggestion_for_duplicate_nested_use(
4992 err: &mut DiagnosticBuilder<'_>,
4993 directive: &ImportDirective<'_>,
4996 assert!(directive.is_nested());
4997 let message = "remove unnecessary import";
4998 let source_map = self.session.source_map();
5000 // Two examples will be used to illustrate the span manipulations we're doing:
5002 // - Given `use issue_52891::{d, a, e};` where `a` is a duplicate then `binding_span` is
5003 // `a` and `directive.use_span` is `issue_52891::{d, a, e};`.
5004 // - Given `use issue_52891::{d, e, a};` where `a` is a duplicate then `binding_span` is
5005 // `a` and `directive.use_span` is `issue_52891::{d, e, a};`.
5007 // Find the span of everything after the binding.
5008 // ie. `a, e};` or `a};`
5009 let binding_until_end = binding_span.with_hi(directive.use_span.hi());
5011 // Find everything after the binding but not including the binding.
5012 // ie. `, e};` or `};`
5013 let after_binding_until_end = binding_until_end.with_lo(binding_span.hi());
5015 // Keep characters in the span until we encounter something that isn't a comma or
5019 // Also note whether a closing brace character was encountered. If there
5020 // was, then later go backwards to remove any trailing commas that are left.
5021 let mut found_closing_brace = false;
5022 let after_binding_until_next_binding = source_map.span_take_while(
5023 after_binding_until_end,
5025 if ch == '}' { found_closing_brace = true; }
5026 ch == ' ' || ch == ','
5030 // Combine the two spans.
5031 // ie. `a, ` or `a`.
5033 // Removing these would leave `issue_52891::{d, e};` or `issue_52891::{d, e, };`
5034 let span = binding_span.with_hi(after_binding_until_next_binding.hi());
5036 // If there was a closing brace then identify the span to remove any trailing commas from
5037 // previous imports.
5038 if found_closing_brace {
5039 if let Ok(prev_source) = source_map.span_to_prev_source(span) {
5040 // `prev_source` will contain all of the source that came before the span.
5041 // Then split based on a command and take the first (ie. closest to our span)
5042 // snippet. In the example, this is a space.
5043 let prev_comma = prev_source.rsplit(',').collect::<Vec<_>>();
5044 let prev_starting_brace = prev_source.rsplit('{').collect::<Vec<_>>();
5045 if prev_comma.len() > 1 && prev_starting_brace.len() > 1 {
5046 let prev_comma = prev_comma.first().unwrap();
5047 let prev_starting_brace = prev_starting_brace.first().unwrap();
5049 // If the amount of source code before the comma is greater than
5050 // the amount of source code before the starting brace then we've only
5051 // got one item in the nested item (eg. `issue_52891::{self}`).
5052 if prev_comma.len() > prev_starting_brace.len() {
5053 // So just remove the entire line...
5054 err.span_suggestion(
5055 directive.use_span_with_attributes,
5058 Applicability::MaybeIncorrect,
5063 let span = span.with_lo(BytePos(
5064 // Take away the number of bytes for the characters we've found and an
5065 // extra for the comma.
5066 span.lo().0 - (prev_comma.as_bytes().len() as u32) - 1
5068 err.span_suggestion(
5069 span, message, String::new(), Applicability::MaybeIncorrect,
5076 err.span_suggestion(span, message, String::new(), Applicability::MachineApplicable);
5079 fn extern_prelude_get(&mut self, ident: Ident, speculative: bool)
5080 -> Option<&'a NameBinding<'a>> {
5081 if ident.is_path_segment_keyword() {
5082 // Make sure `self`, `super` etc produce an error when passed to here.
5085 self.extern_prelude.get(&ident.modern()).cloned().and_then(|entry| {
5086 if let Some(binding) = entry.extern_crate_item {
5087 if !speculative && entry.introduced_by_item {
5088 self.record_use(ident, TypeNS, binding, false);
5092 let crate_id = if !speculative {
5093 self.crate_loader.process_path_extern(ident.name, ident.span)
5094 } else if let Some(crate_id) =
5095 self.crate_loader.maybe_process_path_extern(ident.name, ident.span) {
5100 let crate_root = self.get_module(DefId { krate: crate_id, index: CRATE_DEF_INDEX });
5101 self.populate_module_if_necessary(&crate_root);
5102 Some((crate_root, ty::Visibility::Public, DUMMY_SP, Mark::root())
5103 .to_name_binding(self.arenas))
5109 fn is_self_type(path: &[Segment], namespace: Namespace) -> bool {
5110 namespace == TypeNS && path.len() == 1 && path[0].ident.name == keywords::SelfUpper.name()
5113 fn is_self_value(path: &[Segment], namespace: Namespace) -> bool {
5114 namespace == ValueNS && path.len() == 1 && path[0].ident.name == keywords::SelfLower.name()
5117 fn names_to_string(idents: &[Ident]) -> String {
5118 let mut result = String::new();
5119 for (i, ident) in idents.iter()
5120 .filter(|ident| ident.name != keywords::PathRoot.name())
5123 result.push_str("::");
5125 result.push_str(&ident.as_str());
5130 fn path_names_to_string(path: &Path) -> String {
5131 names_to_string(&path.segments.iter()
5132 .map(|seg| seg.ident)
5133 .collect::<Vec<_>>())
5136 /// Get the stringified path for an enum from an `ImportSuggestion` for an enum variant.
5137 fn import_candidate_to_enum_paths(suggestion: &ImportSuggestion) -> (String, String) {
5138 let variant_path = &suggestion.path;
5139 let variant_path_string = path_names_to_string(variant_path);
5141 let path_len = suggestion.path.segments.len();
5142 let enum_path = ast::Path {
5143 span: suggestion.path.span,
5144 segments: suggestion.path.segments[0..path_len - 1].to_vec(),
5146 let enum_path_string = path_names_to_string(&enum_path);
5148 (variant_path_string, enum_path_string)
5151 /// When an entity with a given name is not available in scope, we search for
5152 /// entities with that name in all crates. This method allows outputting the
5153 /// results of this search in a programmer-friendly way
5154 fn show_candidates(err: &mut DiagnosticBuilder<'_>,
5155 // This is `None` if all placement locations are inside expansions
5157 candidates: &[ImportSuggestion],
5161 // we want consistent results across executions, but candidates are produced
5162 // by iterating through a hash map, so make sure they are ordered:
5163 let mut path_strings: Vec<_> =
5164 candidates.into_iter().map(|c| path_names_to_string(&c.path)).collect();
5165 path_strings.sort();
5167 let better = if better { "better " } else { "" };
5168 let msg_diff = match path_strings.len() {
5169 1 => " is found in another module, you can import it",
5170 _ => "s are found in other modules, you can import them",
5172 let msg = format!("possible {}candidate{} into scope", better, msg_diff);
5174 if let Some(span) = span {
5175 for candidate in &mut path_strings {
5176 // produce an additional newline to separate the new use statement
5177 // from the directly following item.
5178 let additional_newline = if found_use {
5183 *candidate = format!("use {};\n{}", candidate, additional_newline);
5186 err.span_suggestions(
5189 path_strings.into_iter(),
5190 Applicability::Unspecified,
5195 for candidate in path_strings {
5197 msg.push_str(&candidate);
5202 /// A somewhat inefficient routine to obtain the name of a module.
5203 fn module_to_string(module: Module<'_>) -> Option<String> {
5204 let mut names = Vec::new();
5206 fn collect_mod(names: &mut Vec<Ident>, module: Module<'_>) {
5207 if let ModuleKind::Def(_, name) = module.kind {
5208 if let Some(parent) = module.parent {
5209 names.push(Ident::with_empty_ctxt(name));
5210 collect_mod(names, parent);
5213 // danger, shouldn't be ident?
5214 names.push(Ident::from_str("<opaque>"));
5215 collect_mod(names, module.parent.unwrap());
5218 collect_mod(&mut names, module);
5220 if names.is_empty() {
5223 Some(names_to_string(&names.into_iter()
5225 .collect::<Vec<_>>()))
5228 fn err_path_resolution() -> PathResolution {
5229 PathResolution::new(Def::Err)
5232 #[derive(Copy, Clone, Debug)]
5234 /// Do not issue the lint
5237 /// This lint applies to some random path like `impl ::foo::Bar`
5238 /// or whatever. In this case, we can take the span of that path.
5241 /// This lint comes from a `use` statement. In this case, what we
5242 /// care about really is the *root* `use` statement; e.g., if we
5243 /// have nested things like `use a::{b, c}`, we care about the
5245 UsePath { root_id: NodeId, root_span: Span },
5247 /// This is the "trait item" from a fully qualified path. For example,
5248 /// we might be resolving `X::Y::Z` from a path like `<T as X::Y>::Z`.
5249 /// The `path_span` is the span of the to the trait itself (`X::Y`).
5250 QPathTrait { qpath_id: NodeId, qpath_span: Span },
5254 fn node_id(&self) -> Option<NodeId> {
5256 CrateLint::No => None,
5257 CrateLint::SimplePath(id) |
5258 CrateLint::UsePath { root_id: id, .. } |
5259 CrateLint::QPathTrait { qpath_id: id, .. } => Some(id),
5264 __build_diagnostic_array! { librustc_resolve, DIAGNOSTICS }