1 // Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 #![crate_name = "rustc_resolve"]
12 #![crate_type = "dylib"]
13 #![crate_type = "rlib"]
14 #![doc(html_logo_url = "https://www.rust-lang.org/logos/rust-logo-128x128-blk-v2.png",
15 html_favicon_url = "https://doc.rust-lang.org/favicon.ico",
16 html_root_url = "https://doc.rust-lang.org/nightly/")]
19 #![feature(associated_consts)]
20 #![feature(rustc_diagnostic_macros)]
22 #![cfg_attr(stage0, unstable(feature = "rustc_private", issue = "27812"))]
23 #![cfg_attr(stage0, feature(rustc_private))]
24 #![cfg_attr(stage0, feature(staged_api))]
30 extern crate syntax_pos;
31 extern crate rustc_errors as errors;
36 use self::Namespace::*;
37 use self::TypeParameters::*;
40 use rustc::hir::map::{Definitions, DefCollector};
41 use rustc::hir::{self, PrimTy, TyBool, TyChar, TyFloat, TyInt, TyUint, TyStr};
42 use rustc::middle::cstore::CrateLoader;
43 use rustc::session::Session;
45 use rustc::hir::def::*;
46 use rustc::hir::def_id::{CRATE_DEF_INDEX, LOCAL_CRATE, DefId};
48 use rustc::hir::{Freevar, FreevarMap, TraitCandidate, TraitMap, GlobMap};
49 use rustc::util::nodemap::{NodeMap, NodeSet, FxHashMap, FxHashSet, DefIdMap};
51 use syntax::ext::hygiene::{Mark, SyntaxContext};
52 use syntax::ast::{self, Name, NodeId, Ident, SpannedIdent, FloatTy, IntTy, UintTy};
53 use syntax::ext::base::SyntaxExtension;
54 use syntax::ext::base::Determinacy::{self, Determined, Undetermined};
55 use syntax::ext::base::MacroKind;
56 use syntax::symbol::{Symbol, keywords};
57 use syntax::util::lev_distance::find_best_match_for_name;
59 use syntax::visit::{self, FnKind, Visitor};
61 use syntax::ast::{Arm, BindingMode, Block, Crate, Expr, ExprKind};
62 use syntax::ast::{FnDecl, ForeignItem, ForeignItemKind, Generics};
63 use syntax::ast::{Item, ItemKind, ImplItem, ImplItemKind};
64 use syntax::ast::{Local, Mutability, Pat, PatKind, Path};
65 use syntax::ast::{QSelf, TraitItemKind, TraitRef, Ty, TyKind};
66 use syntax::feature_gate::{feature_err, emit_feature_err, GateIssue};
68 use syntax_pos::{Span, DUMMY_SP, MultiSpan};
69 use errors::DiagnosticBuilder;
71 use std::cell::{Cell, RefCell};
73 use std::collections::BTreeSet;
75 use std::mem::replace;
78 use resolve_imports::{ImportDirective, ImportDirectiveSubclass, NameResolution, ImportResolver};
79 use macros::{InvocationData, LegacyBinding, LegacyScope, MacroBinding};
81 // NB: This module needs to be declared first so diagnostics are
82 // registered before they are used.
87 mod build_reduced_graph;
90 /// A free importable items suggested in case of resolution failure.
91 struct ImportSuggestion {
95 /// A field or associated item from self type suggested in case of resolution failure.
96 enum AssocSuggestion {
103 struct BindingError {
105 origin: BTreeSet<Span>,
106 target: BTreeSet<Span>,
109 impl PartialOrd for BindingError {
110 fn partial_cmp(&self, other: &BindingError) -> Option<cmp::Ordering> {
111 Some(self.cmp(other))
115 impl PartialEq for BindingError {
116 fn eq(&self, other: &BindingError) -> bool {
117 self.name == other.name
121 impl Ord for BindingError {
122 fn cmp(&self, other: &BindingError) -> cmp::Ordering {
123 self.name.cmp(&other.name)
127 enum ResolutionError<'a> {
128 /// error E0401: can't use type parameters from outer function
129 TypeParametersFromOuterFunction,
130 /// error E0403: the name is already used for a type parameter in this type parameter list
131 NameAlreadyUsedInTypeParameterList(Name, &'a Span),
132 /// error E0407: method is not a member of trait
133 MethodNotMemberOfTrait(Name, &'a str),
134 /// error E0437: type is not a member of trait
135 TypeNotMemberOfTrait(Name, &'a str),
136 /// error E0438: const is not a member of trait
137 ConstNotMemberOfTrait(Name, &'a str),
138 /// error E0408: variable `{}` is not bound in all patterns
139 VariableNotBoundInPattern(&'a BindingError),
140 /// error E0409: variable `{}` is bound in inconsistent ways within the same match arm
141 VariableBoundWithDifferentMode(Name, Span),
142 /// error E0415: identifier is bound more than once in this parameter list
143 IdentifierBoundMoreThanOnceInParameterList(&'a str),
144 /// error E0416: identifier is bound more than once in the same pattern
145 IdentifierBoundMoreThanOnceInSamePattern(&'a str),
146 /// error E0426: use of undeclared label
147 UndeclaredLabel(&'a str),
148 /// error E0429: `self` imports are only allowed within a { } list
149 SelfImportsOnlyAllowedWithin,
150 /// error E0430: `self` import can only appear once in the list
151 SelfImportCanOnlyAppearOnceInTheList,
152 /// error E0431: `self` import can only appear in an import list with a non-empty prefix
153 SelfImportOnlyInImportListWithNonEmptyPrefix,
154 /// error E0432: unresolved import
155 UnresolvedImport(Option<(&'a str, &'a str)>),
156 /// error E0433: failed to resolve
157 FailedToResolve(&'a str),
158 /// error E0434: can't capture dynamic environment in a fn item
159 CannotCaptureDynamicEnvironmentInFnItem,
160 /// error E0435: attempt to use a non-constant value in a constant
161 AttemptToUseNonConstantValueInConstant,
162 /// error E0530: X bindings cannot shadow Ys
163 BindingShadowsSomethingUnacceptable(&'a str, Name, &'a NameBinding<'a>),
164 /// error E0128: type parameters with a default cannot use forward declared identifiers
165 ForwardDeclaredTyParam,
168 fn resolve_error<'sess, 'a>(resolver: &'sess Resolver,
170 resolution_error: ResolutionError<'a>) {
171 resolve_struct_error(resolver, span, resolution_error).emit();
174 fn resolve_struct_error<'sess, 'a>(resolver: &'sess Resolver,
176 resolution_error: ResolutionError<'a>)
177 -> DiagnosticBuilder<'sess> {
178 match resolution_error {
179 ResolutionError::TypeParametersFromOuterFunction => {
180 let mut err = struct_span_err!(resolver.session,
183 "can't use type parameters from outer function; \
184 try using a local type parameter instead");
185 err.span_label(span, "use of type variable from outer function");
188 ResolutionError::NameAlreadyUsedInTypeParameterList(name, first_use_span) => {
189 let mut err = struct_span_err!(resolver.session,
192 "the name `{}` is already used for a type parameter \
193 in this type parameter list",
195 err.span_label(span, "already used");
196 err.span_label(first_use_span.clone(), format!("first use of `{}`", name));
199 ResolutionError::MethodNotMemberOfTrait(method, trait_) => {
200 let mut err = struct_span_err!(resolver.session,
203 "method `{}` is not a member of trait `{}`",
206 err.span_label(span, format!("not a member of trait `{}`", trait_));
209 ResolutionError::TypeNotMemberOfTrait(type_, trait_) => {
210 let mut err = struct_span_err!(resolver.session,
213 "type `{}` is not a member of trait `{}`",
216 err.span_label(span, format!("not a member of trait `{}`", trait_));
219 ResolutionError::ConstNotMemberOfTrait(const_, trait_) => {
220 let mut err = struct_span_err!(resolver.session,
223 "const `{}` is not a member of trait `{}`",
226 err.span_label(span, format!("not a member of trait `{}`", trait_));
229 ResolutionError::VariableNotBoundInPattern(binding_error) => {
230 let target_sp = binding_error.target.iter().map(|x| *x).collect::<Vec<_>>();
231 let msp = MultiSpan::from_spans(target_sp.clone());
232 let msg = format!("variable `{}` is not bound in all patterns", binding_error.name);
233 let mut err = resolver.session.struct_span_err_with_code(msp, &msg, "E0408");
234 for sp in target_sp {
235 err.span_label(sp, format!("pattern doesn't bind `{}`", binding_error.name));
237 let origin_sp = binding_error.origin.iter().map(|x| *x).collect::<Vec<_>>();
238 for sp in origin_sp {
239 err.span_label(sp, "variable not in all patterns");
243 ResolutionError::VariableBoundWithDifferentMode(variable_name,
244 first_binding_span) => {
245 let mut err = struct_span_err!(resolver.session,
248 "variable `{}` is bound in inconsistent \
249 ways within the same match arm",
251 err.span_label(span, "bound in different ways");
252 err.span_label(first_binding_span, "first binding");
255 ResolutionError::IdentifierBoundMoreThanOnceInParameterList(identifier) => {
256 let mut err = struct_span_err!(resolver.session,
259 "identifier `{}` is bound more than once in this parameter list",
261 err.span_label(span, "used as parameter more than once");
264 ResolutionError::IdentifierBoundMoreThanOnceInSamePattern(identifier) => {
265 let mut err = struct_span_err!(resolver.session,
268 "identifier `{}` is bound more than once in the same pattern",
270 err.span_label(span, "used in a pattern more than once");
273 ResolutionError::UndeclaredLabel(name) => {
274 let mut err = struct_span_err!(resolver.session,
277 "use of undeclared label `{}`",
279 err.span_label(span, format!("undeclared label `{}`", name));
282 ResolutionError::SelfImportsOnlyAllowedWithin => {
283 struct_span_err!(resolver.session,
287 "`self` imports are only allowed within a { } list")
289 ResolutionError::SelfImportCanOnlyAppearOnceInTheList => {
290 struct_span_err!(resolver.session,
293 "`self` import can only appear once in the list")
295 ResolutionError::SelfImportOnlyInImportListWithNonEmptyPrefix => {
296 struct_span_err!(resolver.session,
299 "`self` import can only appear in an import list with a \
302 ResolutionError::UnresolvedImport(name) => {
303 let msg = match name {
304 Some((n, _)) => format!("unresolved import `{}`", n),
305 None => "unresolved import".to_owned(),
307 let mut err = struct_span_err!(resolver.session, span, E0432, "{}", msg);
308 if let Some((_, p)) = name {
309 err.span_label(span, p);
313 ResolutionError::FailedToResolve(msg) => {
314 let mut err = struct_span_err!(resolver.session, span, E0433,
315 "failed to resolve. {}", msg);
316 err.span_label(span, msg);
319 ResolutionError::CannotCaptureDynamicEnvironmentInFnItem => {
320 struct_span_err!(resolver.session,
324 "can't capture dynamic environment in a fn item; use the || { ... } \
325 closure form instead")
327 ResolutionError::AttemptToUseNonConstantValueInConstant => {
328 let mut err = struct_span_err!(resolver.session,
331 "attempt to use a non-constant value in a constant");
332 err.span_label(span, "non-constant used with constant");
335 ResolutionError::BindingShadowsSomethingUnacceptable(what_binding, name, binding) => {
336 let shadows_what = PathResolution::new(binding.def()).kind_name();
337 let mut err = struct_span_err!(resolver.session,
340 "{}s cannot shadow {}s", what_binding, shadows_what);
341 err.span_label(span, format!("cannot be named the same as a {}", shadows_what));
342 let participle = if binding.is_import() { "imported" } else { "defined" };
343 let msg = format!("a {} `{}` is {} here", shadows_what, name, participle);
344 err.span_label(binding.span, msg);
347 ResolutionError::ForwardDeclaredTyParam => {
348 let mut err = struct_span_err!(resolver.session, span, E0128,
349 "type parameters with a default cannot use \
350 forward declared identifiers");
351 err.span_label(span, format!("defaulted type parameters \
352 cannot be forward declared"));
358 #[derive(Copy, Clone, Debug)]
361 binding_mode: BindingMode,
364 // Map from the name in a pattern to its binding mode.
365 type BindingMap = FxHashMap<Ident, BindingInfo>;
367 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
378 fn is_refutable(self) -> bool {
380 PatternSource::Match | PatternSource::IfLet | PatternSource::WhileLet => true,
381 PatternSource::Let | PatternSource::For | PatternSource::FnParam => false,
384 fn descr(self) -> &'static str {
386 PatternSource::Match => "match binding",
387 PatternSource::IfLet => "if let binding",
388 PatternSource::WhileLet => "while let binding",
389 PatternSource::Let => "let binding",
390 PatternSource::For => "for binding",
391 PatternSource::FnParam => "function parameter",
396 #[derive(Copy, Clone, PartialEq, Eq, Debug)]
397 enum PathSource<'a> {
398 // Type paths `Path`.
400 // Trait paths in bounds or impls.
402 // Expression paths `path`, with optional parent context.
403 Expr(Option<&'a Expr>),
404 // Paths in path patterns `Path`.
406 // Paths in struct expressions and patterns `Path { .. }`.
408 // Paths in tuple struct patterns `Path(..)`.
410 // `m::A::B` in `<T as m::A>::B::C`.
411 TraitItem(Namespace),
412 // Path in `pub(path)`
414 // Path in `use a::b::{...};`
418 impl<'a> PathSource<'a> {
419 fn namespace(self) -> Namespace {
421 PathSource::Type | PathSource::Trait | PathSource::Struct |
422 PathSource::Visibility | PathSource::ImportPrefix => TypeNS,
423 PathSource::Expr(..) | PathSource::Pat | PathSource::TupleStruct => ValueNS,
424 PathSource::TraitItem(ns) => ns,
428 fn global_by_default(self) -> bool {
430 PathSource::Visibility | PathSource::ImportPrefix => true,
431 PathSource::Type | PathSource::Expr(..) | PathSource::Pat |
432 PathSource::Struct | PathSource::TupleStruct |
433 PathSource::Trait | PathSource::TraitItem(..) => false,
437 fn defer_to_typeck(self) -> bool {
439 PathSource::Type | PathSource::Expr(..) | PathSource::Pat |
440 PathSource::Struct | PathSource::TupleStruct => true,
441 PathSource::Trait | PathSource::TraitItem(..) |
442 PathSource::Visibility | PathSource::ImportPrefix => false,
446 fn descr_expected(self) -> &'static str {
448 PathSource::Type => "type",
449 PathSource::Trait => "trait",
450 PathSource::Pat => "unit struct/variant or constant",
451 PathSource::Struct => "struct, variant or union type",
452 PathSource::TupleStruct => "tuple struct/variant",
453 PathSource::Visibility => "module",
454 PathSource::ImportPrefix => "module or enum",
455 PathSource::TraitItem(ns) => match ns {
456 TypeNS => "associated type",
457 ValueNS => "method or associated constant",
458 MacroNS => bug!("associated macro"),
460 PathSource::Expr(parent) => match parent.map(|p| &p.node) {
461 // "function" here means "anything callable" rather than `Def::Fn`,
462 // this is not precise but usually more helpful than just "value".
463 Some(&ExprKind::Call(..)) => "function",
469 fn is_expected(self, def: Def) -> bool {
471 PathSource::Type => match def {
472 Def::Struct(..) | Def::Union(..) | Def::Enum(..) |
473 Def::Trait(..) | Def::TyAlias(..) | Def::AssociatedTy(..) |
474 Def::PrimTy(..) | Def::TyParam(..) | Def::SelfTy(..) => true,
477 PathSource::Trait => match def {
478 Def::Trait(..) => true,
481 PathSource::Expr(..) => match def {
482 Def::StructCtor(_, CtorKind::Const) | Def::StructCtor(_, CtorKind::Fn) |
483 Def::VariantCtor(_, CtorKind::Const) | Def::VariantCtor(_, CtorKind::Fn) |
484 Def::Const(..) | Def::Static(..) | Def::Local(..) | Def::Upvar(..) |
485 Def::Fn(..) | Def::Method(..) | Def::AssociatedConst(..) => true,
488 PathSource::Pat => match def {
489 Def::StructCtor(_, CtorKind::Const) |
490 Def::VariantCtor(_, CtorKind::Const) |
491 Def::Const(..) | Def::AssociatedConst(..) => true,
494 PathSource::TupleStruct => match def {
495 Def::StructCtor(_, CtorKind::Fn) | Def::VariantCtor(_, CtorKind::Fn) => true,
498 PathSource::Struct => match def {
499 Def::Struct(..) | Def::Union(..) | Def::Variant(..) |
500 Def::TyAlias(..) | Def::AssociatedTy(..) | Def::SelfTy(..) => true,
503 PathSource::TraitItem(ns) => match def {
504 Def::AssociatedConst(..) | Def::Method(..) if ns == ValueNS => true,
505 Def::AssociatedTy(..) if ns == TypeNS => true,
508 PathSource::ImportPrefix => match def {
509 Def::Mod(..) | Def::Enum(..) => true,
512 PathSource::Visibility => match def {
513 Def::Mod(..) => true,
519 fn error_code(self, has_unexpected_resolution: bool) -> &'static str {
520 __diagnostic_used!(E0404);
521 __diagnostic_used!(E0405);
522 __diagnostic_used!(E0412);
523 __diagnostic_used!(E0422);
524 __diagnostic_used!(E0423);
525 __diagnostic_used!(E0425);
526 __diagnostic_used!(E0531);
527 __diagnostic_used!(E0532);
528 __diagnostic_used!(E0573);
529 __diagnostic_used!(E0574);
530 __diagnostic_used!(E0575);
531 __diagnostic_used!(E0576);
532 __diagnostic_used!(E0577);
533 __diagnostic_used!(E0578);
534 match (self, has_unexpected_resolution) {
535 (PathSource::Trait, true) => "E0404",
536 (PathSource::Trait, false) => "E0405",
537 (PathSource::Type, true) => "E0573",
538 (PathSource::Type, false) => "E0412",
539 (PathSource::Struct, true) => "E0574",
540 (PathSource::Struct, false) => "E0422",
541 (PathSource::Expr(..), true) => "E0423",
542 (PathSource::Expr(..), false) => "E0425",
543 (PathSource::Pat, true) | (PathSource::TupleStruct, true) => "E0532",
544 (PathSource::Pat, false) | (PathSource::TupleStruct, false) => "E0531",
545 (PathSource::TraitItem(..), true) => "E0575",
546 (PathSource::TraitItem(..), false) => "E0576",
547 (PathSource::Visibility, true) | (PathSource::ImportPrefix, true) => "E0577",
548 (PathSource::Visibility, false) | (PathSource::ImportPrefix, false) => "E0578",
553 #[derive(Copy, Clone, PartialEq, Eq, Hash, Debug)]
560 #[derive(Clone, Default, Debug)]
561 pub struct PerNS<T> {
567 impl<T> ::std::ops::Index<Namespace> for PerNS<T> {
569 fn index(&self, ns: Namespace) -> &T {
571 ValueNS => &self.value_ns,
572 TypeNS => &self.type_ns,
573 MacroNS => self.macro_ns.as_ref().unwrap(),
578 impl<T> ::std::ops::IndexMut<Namespace> for PerNS<T> {
579 fn index_mut(&mut self, ns: Namespace) -> &mut T {
581 ValueNS => &mut self.value_ns,
582 TypeNS => &mut self.type_ns,
583 MacroNS => self.macro_ns.as_mut().unwrap(),
588 impl<'a, 'tcx> Visitor<'tcx> for Resolver<'a> {
589 fn visit_item(&mut self, item: &'tcx Item) {
590 self.resolve_item(item);
592 fn visit_arm(&mut self, arm: &'tcx Arm) {
593 self.resolve_arm(arm);
595 fn visit_block(&mut self, block: &'tcx Block) {
596 self.resolve_block(block);
598 fn visit_expr(&mut self, expr: &'tcx Expr) {
599 self.resolve_expr(expr, None);
601 fn visit_local(&mut self, local: &'tcx Local) {
602 self.resolve_local(local);
604 fn visit_ty(&mut self, ty: &'tcx Ty) {
605 if let TyKind::Path(ref qself, ref path) = ty.node {
606 self.smart_resolve_path(ty.id, qself.as_ref(), path, PathSource::Type);
607 } else if let TyKind::ImplicitSelf = ty.node {
608 let self_ty = keywords::SelfType.ident();
609 let def = self.resolve_ident_in_lexical_scope(self_ty, TypeNS, true, ty.span)
610 .map_or(Def::Err, |d| d.def());
611 self.record_def(ty.id, PathResolution::new(def));
612 } else if let TyKind::Array(ref element, ref length) = ty.node {
613 self.visit_ty(element);
614 self.with_constant_rib(|this| {
615 this.visit_expr(length);
619 visit::walk_ty(self, ty);
621 fn visit_poly_trait_ref(&mut self,
622 tref: &'tcx ast::PolyTraitRef,
623 m: &'tcx ast::TraitBoundModifier) {
624 self.smart_resolve_path(tref.trait_ref.ref_id, None,
625 &tref.trait_ref.path, PathSource::Trait);
626 visit::walk_poly_trait_ref(self, tref, m);
628 fn visit_variant(&mut self,
629 variant: &'tcx ast::Variant,
630 generics: &'tcx Generics,
631 item_id: ast::NodeId) {
632 if let Some(ref dis_expr) = variant.node.disr_expr {
633 // resolve the discriminator expr as a constant
634 self.with_constant_rib(|this| {
635 this.visit_expr(dis_expr);
639 // `visit::walk_variant` without the discriminant expression.
640 self.visit_variant_data(&variant.node.data,
646 fn visit_foreign_item(&mut self, foreign_item: &'tcx ForeignItem) {
647 let type_parameters = match foreign_item.node {
648 ForeignItemKind::Fn(_, ref generics) => {
649 HasTypeParameters(generics, ItemRibKind)
651 ForeignItemKind::Static(..) => NoTypeParameters,
653 self.with_type_parameter_rib(type_parameters, |this| {
654 visit::walk_foreign_item(this, foreign_item);
657 fn visit_fn(&mut self,
658 function_kind: FnKind<'tcx>,
659 declaration: &'tcx FnDecl,
662 let rib_kind = match function_kind {
663 FnKind::ItemFn(_, generics, ..) => {
664 self.visit_generics(generics);
667 FnKind::Method(_, sig, _, _) => {
668 self.visit_generics(&sig.generics);
669 MethodRibKind(!sig.decl.has_self())
671 FnKind::Closure(_) => ClosureRibKind(node_id),
674 // Create a value rib for the function.
675 self.ribs[ValueNS].push(Rib::new(rib_kind));
677 // Create a label rib for the function.
678 self.label_ribs.push(Rib::new(rib_kind));
680 // Add each argument to the rib.
681 let mut bindings_list = FxHashMap();
682 for argument in &declaration.inputs {
683 self.resolve_pattern(&argument.pat, PatternSource::FnParam, &mut bindings_list);
685 self.visit_ty(&argument.ty);
687 debug!("(resolving function) recorded argument");
689 visit::walk_fn_ret_ty(self, &declaration.output);
691 // Resolve the function body.
692 match function_kind {
693 FnKind::ItemFn(.., body) |
694 FnKind::Method(.., body) => {
695 self.visit_block(body);
697 FnKind::Closure(body) => {
698 self.visit_expr(body);
702 debug!("(resolving function) leaving function");
704 self.label_ribs.pop();
705 self.ribs[ValueNS].pop();
707 fn visit_generics(&mut self, generics: &'tcx Generics) {
708 // For type parameter defaults, we have to ban access
709 // to following type parameters, as the Substs can only
710 // provide previous type parameters as they're built.
711 let mut default_ban_rib = Rib::new(ForwardTyParamBanRibKind);
712 default_ban_rib.bindings.extend(generics.ty_params.iter()
713 .skip_while(|p| p.default.is_none())
714 .map(|p| (Ident::with_empty_ctxt(p.ident.name), Def::Err)));
716 for param in &generics.ty_params {
717 for bound in ¶m.bounds {
718 self.visit_ty_param_bound(bound);
721 if let Some(ref ty) = param.default {
722 self.ribs[TypeNS].push(default_ban_rib);
724 default_ban_rib = self.ribs[TypeNS].pop().unwrap();
727 // Allow all following defaults to refer to this type parameter.
728 default_ban_rib.bindings.remove(&Ident::with_empty_ctxt(param.ident.name));
730 for lt in &generics.lifetimes { self.visit_lifetime_def(lt); }
731 for p in &generics.where_clause.predicates { self.visit_where_predicate(p); }
735 pub type ErrorMessage = Option<(Span, String)>;
737 #[derive(Copy, Clone)]
738 enum TypeParameters<'a, 'b> {
740 HasTypeParameters(// Type parameters.
743 // The kind of the rib used for type parameters.
747 // The rib kind controls the translation of local
748 // definitions (`Def::Local`) to upvars (`Def::Upvar`).
749 #[derive(Copy, Clone, Debug)]
751 // No translation needs to be applied.
754 // We passed through a closure scope at the given node ID.
755 // Translate upvars as appropriate.
756 ClosureRibKind(NodeId /* func id */),
758 // We passed through an impl or trait and are now in one of its
759 // methods. Allow references to ty params that impl or trait
760 // binds. Disallow any other upvars (including other ty params that are
763 // The boolean value represents the fact that this method is static or not.
766 // We passed through an item scope. Disallow upvars.
769 // We're in a constant item. Can't refer to dynamic stuff.
772 // We passed through a module.
773 ModuleRibKind(Module<'a>),
775 // We passed through a `macro_rules!` statement
776 MacroDefinition(DefId),
778 // All bindings in this rib are type parameters that can't be used
779 // from the default of a type parameter because they're not declared
780 // before said type parameter. Also see the `visit_generics` override.
781 ForwardTyParamBanRibKind,
787 bindings: FxHashMap<Ident, Def>,
792 fn new(kind: RibKind<'a>) -> Rib<'a> {
794 bindings: FxHashMap(),
800 enum LexicalScopeBinding<'a> {
801 Item(&'a NameBinding<'a>),
805 impl<'a> LexicalScopeBinding<'a> {
806 fn item(self) -> Option<&'a NameBinding<'a>> {
808 LexicalScopeBinding::Item(binding) => Some(binding),
813 fn def(self) -> Def {
815 LexicalScopeBinding::Item(binding) => binding.def(),
816 LexicalScopeBinding::Def(def) => def,
822 enum PathResult<'a> {
824 NonModule(PathResolution),
826 Failed(String, bool /* is the error from the last segment? */),
834 /// One node in the tree of modules.
835 pub struct ModuleData<'a> {
836 parent: Option<Module<'a>>,
839 // The def id of the closest normal module (`mod`) ancestor (including this module).
840 normal_ancestor_id: DefId,
842 resolutions: RefCell<FxHashMap<(Ident, Namespace), &'a RefCell<NameResolution<'a>>>>,
843 legacy_macro_resolutions: RefCell<Vec<(Mark, Ident, Span, MacroKind)>>,
844 macro_resolutions: RefCell<Vec<(Box<[Ident]>, Span)>>,
846 // Macro invocations that can expand into items in this module.
847 unresolved_invocations: RefCell<FxHashSet<Mark>>,
849 no_implicit_prelude: bool,
851 glob_importers: RefCell<Vec<&'a ImportDirective<'a>>>,
852 globs: RefCell<Vec<&'a ImportDirective<'a>>>,
854 // Used to memoize the traits in this module for faster searches through all traits in scope.
855 traits: RefCell<Option<Box<[(Ident, &'a NameBinding<'a>)]>>>,
857 // Whether this module is populated. If not populated, any attempt to
858 // access the children must be preceded with a
859 // `populate_module_if_necessary` call.
860 populated: Cell<bool>,
862 /// Span of the module itself. Used for error reporting.
868 pub type Module<'a> = &'a ModuleData<'a>;
870 impl<'a> ModuleData<'a> {
871 fn new(parent: Option<Module<'a>>,
873 normal_ancestor_id: DefId,
875 span: Span) -> Self {
879 normal_ancestor_id: normal_ancestor_id,
880 resolutions: RefCell::new(FxHashMap()),
881 legacy_macro_resolutions: RefCell::new(Vec::new()),
882 macro_resolutions: RefCell::new(Vec::new()),
883 unresolved_invocations: RefCell::new(FxHashSet()),
884 no_implicit_prelude: false,
885 glob_importers: RefCell::new(Vec::new()),
886 globs: RefCell::new((Vec::new())),
887 traits: RefCell::new(None),
888 populated: Cell::new(normal_ancestor_id.is_local()),
890 expansion: expansion,
894 fn for_each_child<F: FnMut(Ident, Namespace, &'a NameBinding<'a>)>(&self, mut f: F) {
895 for (&(ident, ns), name_resolution) in self.resolutions.borrow().iter() {
896 name_resolution.borrow().binding.map(|binding| f(ident, ns, binding));
900 fn def(&self) -> Option<Def> {
902 ModuleKind::Def(def, _) => Some(def),
907 fn def_id(&self) -> Option<DefId> {
908 self.def().as_ref().map(Def::def_id)
911 // `self` resolves to the first module ancestor that `is_normal`.
912 fn is_normal(&self) -> bool {
914 ModuleKind::Def(Def::Mod(_), _) => true,
919 fn is_trait(&self) -> bool {
921 ModuleKind::Def(Def::Trait(_), _) => true,
926 fn is_local(&self) -> bool {
927 self.normal_ancestor_id.is_local()
930 fn nearest_item_scope(&'a self) -> Module<'a> {
931 if self.is_trait() { self.parent.unwrap() } else { self }
935 impl<'a> fmt::Debug for ModuleData<'a> {
936 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
937 write!(f, "{:?}", self.def())
941 // Records a possibly-private value, type, or module definition.
942 #[derive(Clone, Debug)]
943 pub struct NameBinding<'a> {
944 kind: NameBindingKind<'a>,
950 pub trait ToNameBinding<'a> {
951 fn to_name_binding(self, arenas: &'a ResolverArenas<'a>) -> &'a NameBinding<'a>;
954 impl<'a> ToNameBinding<'a> for &'a NameBinding<'a> {
955 fn to_name_binding(self, _: &'a ResolverArenas<'a>) -> &'a NameBinding<'a> {
960 #[derive(Clone, Debug)]
961 enum NameBindingKind<'a> {
965 binding: &'a NameBinding<'a>,
966 directive: &'a ImportDirective<'a>,
968 legacy_self_import: bool,
971 b1: &'a NameBinding<'a>,
972 b2: &'a NameBinding<'a>,
977 struct PrivacyError<'a>(Span, Name, &'a NameBinding<'a>);
979 struct AmbiguityError<'a> {
983 b1: &'a NameBinding<'a>,
984 b2: &'a NameBinding<'a>,
988 impl<'a> NameBinding<'a> {
989 fn module(&self) -> Option<Module<'a>> {
991 NameBindingKind::Module(module) => Some(module),
992 NameBindingKind::Import { binding, .. } => binding.module(),
993 NameBindingKind::Ambiguity { legacy: true, b1, .. } => b1.module(),
998 fn def(&self) -> Def {
1000 NameBindingKind::Def(def) => def,
1001 NameBindingKind::Module(module) => module.def().unwrap(),
1002 NameBindingKind::Import { binding, .. } => binding.def(),
1003 NameBindingKind::Ambiguity { legacy: true, b1, .. } => b1.def(),
1004 NameBindingKind::Ambiguity { .. } => Def::Err,
1008 fn def_ignoring_ambiguity(&self) -> Def {
1010 NameBindingKind::Import { binding, .. } => binding.def_ignoring_ambiguity(),
1011 NameBindingKind::Ambiguity { b1, .. } => b1.def_ignoring_ambiguity(),
1016 fn get_macro(&self, resolver: &mut Resolver<'a>) -> Rc<SyntaxExtension> {
1017 resolver.get_macro(self.def_ignoring_ambiguity())
1020 // We sometimes need to treat variants as `pub` for backwards compatibility
1021 fn pseudo_vis(&self) -> ty::Visibility {
1022 if self.is_variant() { ty::Visibility::Public } else { self.vis }
1025 fn is_variant(&self) -> bool {
1027 NameBindingKind::Def(Def::Variant(..)) |
1028 NameBindingKind::Def(Def::VariantCtor(..)) => true,
1033 fn is_extern_crate(&self) -> bool {
1035 NameBindingKind::Import {
1036 directive: &ImportDirective {
1037 subclass: ImportDirectiveSubclass::ExternCrate, ..
1044 fn is_import(&self) -> bool {
1046 NameBindingKind::Import { .. } => true,
1051 fn is_glob_import(&self) -> bool {
1053 NameBindingKind::Import { directive, .. } => directive.is_glob(),
1054 NameBindingKind::Ambiguity { b1, .. } => b1.is_glob_import(),
1059 fn is_importable(&self) -> bool {
1061 Def::AssociatedConst(..) | Def::Method(..) | Def::AssociatedTy(..) => false,
1066 fn is_macro_def(&self) -> bool {
1068 NameBindingKind::Def(Def::Macro(..)) => true,
1074 /// Interns the names of the primitive types.
1075 struct PrimitiveTypeTable {
1076 primitive_types: FxHashMap<Name, PrimTy>,
1079 impl PrimitiveTypeTable {
1080 fn new() -> PrimitiveTypeTable {
1081 let mut table = PrimitiveTypeTable { primitive_types: FxHashMap() };
1083 table.intern("bool", TyBool);
1084 table.intern("char", TyChar);
1085 table.intern("f32", TyFloat(FloatTy::F32));
1086 table.intern("f64", TyFloat(FloatTy::F64));
1087 table.intern("isize", TyInt(IntTy::Is));
1088 table.intern("i8", TyInt(IntTy::I8));
1089 table.intern("i16", TyInt(IntTy::I16));
1090 table.intern("i32", TyInt(IntTy::I32));
1091 table.intern("i64", TyInt(IntTy::I64));
1092 table.intern("i128", TyInt(IntTy::I128));
1093 table.intern("str", TyStr);
1094 table.intern("usize", TyUint(UintTy::Us));
1095 table.intern("u8", TyUint(UintTy::U8));
1096 table.intern("u16", TyUint(UintTy::U16));
1097 table.intern("u32", TyUint(UintTy::U32));
1098 table.intern("u64", TyUint(UintTy::U64));
1099 table.intern("u128", TyUint(UintTy::U128));
1103 fn intern(&mut self, string: &str, primitive_type: PrimTy) {
1104 self.primitive_types.insert(Symbol::intern(string), primitive_type);
1108 /// The main resolver class.
1109 pub struct Resolver<'a> {
1110 session: &'a Session,
1112 pub definitions: Definitions,
1114 graph_root: Module<'a>,
1116 prelude: Option<Module<'a>>,
1118 // n.b. This is used only for better diagnostics, not name resolution itself.
1119 has_self: FxHashSet<DefId>,
1121 // Names of fields of an item `DefId` accessible with dot syntax.
1122 // Used for hints during error reporting.
1123 field_names: FxHashMap<DefId, Vec<Name>>,
1125 // All imports known to succeed or fail.
1126 determined_imports: Vec<&'a ImportDirective<'a>>,
1128 // All non-determined imports.
1129 indeterminate_imports: Vec<&'a ImportDirective<'a>>,
1131 // The module that represents the current item scope.
1132 current_module: Module<'a>,
1134 // The current set of local scopes for types and values.
1135 // FIXME #4948: Reuse ribs to avoid allocation.
1136 ribs: PerNS<Vec<Rib<'a>>>,
1138 // The current set of local scopes, for labels.
1139 label_ribs: Vec<Rib<'a>>,
1141 // The trait that the current context can refer to.
1142 current_trait_ref: Option<(Module<'a>, TraitRef)>,
1144 // The current self type if inside an impl (used for better errors).
1145 current_self_type: Option<Ty>,
1147 // The idents for the primitive types.
1148 primitive_type_table: PrimitiveTypeTable,
1151 pub freevars: FreevarMap,
1152 freevars_seen: NodeMap<NodeMap<usize>>,
1153 pub export_map: ExportMap,
1154 pub trait_map: TraitMap,
1156 // A map from nodes to anonymous modules.
1157 // Anonymous modules are pseudo-modules that are implicitly created around items
1158 // contained within blocks.
1160 // For example, if we have this:
1168 // There will be an anonymous module created around `g` with the ID of the
1169 // entry block for `f`.
1170 block_map: NodeMap<Module<'a>>,
1171 module_map: FxHashMap<DefId, Module<'a>>,
1172 extern_module_map: FxHashMap<(DefId, bool /* MacrosOnly? */), Module<'a>>,
1174 pub make_glob_map: bool,
1175 // Maps imports to the names of items actually imported (this actually maps
1176 // all imports, but only glob imports are actually interesting).
1177 pub glob_map: GlobMap,
1179 used_imports: FxHashSet<(NodeId, Namespace)>,
1180 pub maybe_unused_trait_imports: NodeSet,
1182 privacy_errors: Vec<PrivacyError<'a>>,
1183 ambiguity_errors: Vec<AmbiguityError<'a>>,
1184 gated_errors: FxHashSet<Span>,
1185 disallowed_shadowing: Vec<&'a LegacyBinding<'a>>,
1187 arenas: &'a ResolverArenas<'a>,
1188 dummy_binding: &'a NameBinding<'a>,
1189 use_extern_macros: bool, // true if `#![feature(use_extern_macros)]`
1191 crate_loader: &'a mut CrateLoader,
1192 macro_names: FxHashSet<Ident>,
1193 global_macros: FxHashMap<Name, &'a NameBinding<'a>>,
1194 lexical_macro_resolutions: Vec<(Ident, &'a Cell<LegacyScope<'a>>)>,
1195 macro_map: FxHashMap<DefId, Rc<SyntaxExtension>>,
1196 macro_defs: FxHashMap<Mark, DefId>,
1197 local_macro_def_scopes: FxHashMap<NodeId, Module<'a>>,
1198 macro_exports: Vec<Export>,
1199 pub whitelisted_legacy_custom_derives: Vec<Name>,
1200 pub found_unresolved_macro: bool,
1202 // List of crate local macros that we need to warn about as being unused.
1203 // Right now this only includes macro_rules! macros.
1204 unused_macros: FxHashSet<DefId>,
1206 // Maps the `Mark` of an expansion to its containing module or block.
1207 invocations: FxHashMap<Mark, &'a InvocationData<'a>>,
1209 // Avoid duplicated errors for "name already defined".
1210 name_already_seen: FxHashMap<Name, Span>,
1212 // If `#![feature(proc_macro)]` is set
1213 proc_macro_enabled: bool,
1215 // A set of procedural macros imported by `#[macro_use]` that have already been warned about
1216 warned_proc_macros: FxHashSet<Name>,
1218 potentially_unused_imports: Vec<&'a ImportDirective<'a>>,
1220 // This table maps struct IDs into struct constructor IDs,
1221 // it's not used during normal resolution, only for better error reporting.
1222 struct_constructors: DefIdMap<(Def, ty::Visibility)>,
1225 pub struct ResolverArenas<'a> {
1226 modules: arena::TypedArena<ModuleData<'a>>,
1227 local_modules: RefCell<Vec<Module<'a>>>,
1228 name_bindings: arena::TypedArena<NameBinding<'a>>,
1229 import_directives: arena::TypedArena<ImportDirective<'a>>,
1230 name_resolutions: arena::TypedArena<RefCell<NameResolution<'a>>>,
1231 invocation_data: arena::TypedArena<InvocationData<'a>>,
1232 legacy_bindings: arena::TypedArena<LegacyBinding<'a>>,
1235 impl<'a> ResolverArenas<'a> {
1236 fn alloc_module(&'a self, module: ModuleData<'a>) -> Module<'a> {
1237 let module = self.modules.alloc(module);
1238 if module.def_id().map(|def_id| def_id.is_local()).unwrap_or(true) {
1239 self.local_modules.borrow_mut().push(module);
1243 fn local_modules(&'a self) -> ::std::cell::Ref<'a, Vec<Module<'a>>> {
1244 self.local_modules.borrow()
1246 fn alloc_name_binding(&'a self, name_binding: NameBinding<'a>) -> &'a NameBinding<'a> {
1247 self.name_bindings.alloc(name_binding)
1249 fn alloc_import_directive(&'a self, import_directive: ImportDirective<'a>)
1250 -> &'a ImportDirective {
1251 self.import_directives.alloc(import_directive)
1253 fn alloc_name_resolution(&'a self) -> &'a RefCell<NameResolution<'a>> {
1254 self.name_resolutions.alloc(Default::default())
1256 fn alloc_invocation_data(&'a self, expansion_data: InvocationData<'a>)
1257 -> &'a InvocationData<'a> {
1258 self.invocation_data.alloc(expansion_data)
1260 fn alloc_legacy_binding(&'a self, binding: LegacyBinding<'a>) -> &'a LegacyBinding<'a> {
1261 self.legacy_bindings.alloc(binding)
1265 impl<'a, 'b: 'a> ty::DefIdTree for &'a Resolver<'b> {
1266 fn parent(self, id: DefId) -> Option<DefId> {
1268 LOCAL_CRATE => self.definitions.def_key(id.index).parent,
1269 _ => self.session.cstore.def_key(id).parent,
1270 }.map(|index| DefId { index: index, ..id })
1274 impl<'a> hir::lowering::Resolver for Resolver<'a> {
1275 fn resolve_hir_path(&mut self, path: &mut hir::Path, is_value: bool) {
1276 let namespace = if is_value { ValueNS } else { TypeNS };
1277 let hir::Path { ref segments, span, ref mut def } = *path;
1278 let path: Vec<_> = segments.iter().map(|seg| Ident::with_empty_ctxt(seg.name)).collect();
1279 match self.resolve_path(&path, Some(namespace), true, span) {
1280 PathResult::Module(module) => *def = module.def().unwrap(),
1281 PathResult::NonModule(path_res) if path_res.unresolved_segments() == 0 =>
1282 *def = path_res.base_def(),
1283 PathResult::NonModule(..) => match self.resolve_path(&path, None, true, span) {
1284 PathResult::Failed(msg, _) => {
1285 resolve_error(self, span, ResolutionError::FailedToResolve(&msg));
1289 PathResult::Indeterminate => unreachable!(),
1290 PathResult::Failed(msg, _) => {
1291 resolve_error(self, span, ResolutionError::FailedToResolve(&msg));
1296 fn get_resolution(&mut self, id: NodeId) -> Option<PathResolution> {
1297 self.def_map.get(&id).cloned()
1300 fn definitions(&mut self) -> &mut Definitions {
1301 &mut self.definitions
1305 impl<'a> Resolver<'a> {
1306 pub fn new(session: &'a Session,
1309 make_glob_map: MakeGlobMap,
1310 crate_loader: &'a mut CrateLoader,
1311 arenas: &'a ResolverArenas<'a>)
1313 let root_def_id = DefId::local(CRATE_DEF_INDEX);
1314 let root_module_kind = ModuleKind::Def(Def::Mod(root_def_id), keywords::Invalid.name());
1315 let graph_root = arenas.alloc_module(ModuleData {
1316 no_implicit_prelude: attr::contains_name(&krate.attrs, "no_implicit_prelude"),
1317 ..ModuleData::new(None, root_module_kind, root_def_id, Mark::root(), krate.span)
1319 let mut module_map = FxHashMap();
1320 module_map.insert(DefId::local(CRATE_DEF_INDEX), graph_root);
1322 let mut definitions = Definitions::new();
1323 DefCollector::new(&mut definitions, Mark::root())
1324 .collect_root(crate_name, &session.local_crate_disambiguator().as_str());
1326 let mut invocations = FxHashMap();
1327 invocations.insert(Mark::root(),
1328 arenas.alloc_invocation_data(InvocationData::root(graph_root)));
1330 let features = session.features.borrow();
1332 let mut macro_defs = FxHashMap();
1333 macro_defs.insert(Mark::root(), root_def_id);
1338 definitions: definitions,
1340 // The outermost module has def ID 0; this is not reflected in the
1342 graph_root: graph_root,
1345 has_self: FxHashSet(),
1346 field_names: FxHashMap(),
1348 determined_imports: Vec::new(),
1349 indeterminate_imports: Vec::new(),
1351 current_module: graph_root,
1353 value_ns: vec![Rib::new(ModuleRibKind(graph_root))],
1354 type_ns: vec![Rib::new(ModuleRibKind(graph_root))],
1355 macro_ns: Some(vec![Rib::new(ModuleRibKind(graph_root))]),
1357 label_ribs: Vec::new(),
1359 current_trait_ref: None,
1360 current_self_type: None,
1362 primitive_type_table: PrimitiveTypeTable::new(),
1365 freevars: NodeMap(),
1366 freevars_seen: NodeMap(),
1367 export_map: NodeMap(),
1368 trait_map: NodeMap(),
1369 module_map: module_map,
1370 block_map: NodeMap(),
1371 extern_module_map: FxHashMap(),
1373 make_glob_map: make_glob_map == MakeGlobMap::Yes,
1374 glob_map: NodeMap(),
1376 used_imports: FxHashSet(),
1377 maybe_unused_trait_imports: NodeSet(),
1379 privacy_errors: Vec::new(),
1380 ambiguity_errors: Vec::new(),
1381 gated_errors: FxHashSet(),
1382 disallowed_shadowing: Vec::new(),
1385 dummy_binding: arenas.alloc_name_binding(NameBinding {
1386 kind: NameBindingKind::Def(Def::Err),
1387 expansion: Mark::root(),
1389 vis: ty::Visibility::Public,
1392 // The `proc_macro` and `decl_macro` features imply `use_extern_macros`
1394 features.use_extern_macros || features.proc_macro || features.decl_macro,
1396 crate_loader: crate_loader,
1397 macro_names: FxHashSet(),
1398 global_macros: FxHashMap(),
1399 lexical_macro_resolutions: Vec::new(),
1400 macro_map: FxHashMap(),
1401 macro_exports: Vec::new(),
1402 invocations: invocations,
1403 macro_defs: macro_defs,
1404 local_macro_def_scopes: FxHashMap(),
1405 name_already_seen: FxHashMap(),
1406 whitelisted_legacy_custom_derives: Vec::new(),
1407 proc_macro_enabled: features.proc_macro,
1408 warned_proc_macros: FxHashSet(),
1409 potentially_unused_imports: Vec::new(),
1410 struct_constructors: DefIdMap(),
1411 found_unresolved_macro: false,
1412 unused_macros: FxHashSet(),
1416 pub fn arenas() -> ResolverArenas<'a> {
1418 modules: arena::TypedArena::new(),
1419 local_modules: RefCell::new(Vec::new()),
1420 name_bindings: arena::TypedArena::new(),
1421 import_directives: arena::TypedArena::new(),
1422 name_resolutions: arena::TypedArena::new(),
1423 invocation_data: arena::TypedArena::new(),
1424 legacy_bindings: arena::TypedArena::new(),
1428 fn per_ns<T, F: FnMut(&mut Self, Namespace) -> T>(&mut self, mut f: F) -> PerNS<T> {
1430 type_ns: f(self, TypeNS),
1431 value_ns: f(self, ValueNS),
1432 macro_ns: match self.use_extern_macros {
1433 true => Some(f(self, MacroNS)),
1439 /// Entry point to crate resolution.
1440 pub fn resolve_crate(&mut self, krate: &Crate) {
1441 ImportResolver { resolver: self }.finalize_imports();
1442 self.current_module = self.graph_root;
1443 self.finalize_current_module_macro_resolutions();
1444 visit::walk_crate(self, krate);
1446 check_unused::check_crate(self, krate);
1447 self.report_errors();
1448 self.crate_loader.postprocess(krate);
1455 normal_ancestor_id: DefId,
1459 let module = ModuleData::new(Some(parent), kind, normal_ancestor_id, expansion, span);
1460 self.arenas.alloc_module(module)
1463 fn record_use(&mut self, ident: Ident, ns: Namespace, binding: &'a NameBinding<'a>, span: Span)
1464 -> bool /* true if an error was reported */ {
1465 match binding.kind {
1466 NameBindingKind::Import { directive, binding, ref used, legacy_self_import }
1469 directive.used.set(true);
1470 if legacy_self_import {
1471 self.warn_legacy_self_import(directive);
1474 self.used_imports.insert((directive.id, ns));
1475 self.add_to_glob_map(directive.id, ident);
1476 self.record_use(ident, ns, binding, span)
1478 NameBindingKind::Import { .. } => false,
1479 NameBindingKind::Ambiguity { b1, b2, legacy } => {
1480 self.ambiguity_errors.push(AmbiguityError {
1481 span: span, name: ident.name, lexical: false, b1: b1, b2: b2, legacy: legacy,
1484 self.record_use(ident, ns, b1, span);
1492 fn add_to_glob_map(&mut self, id: NodeId, ident: Ident) {
1493 if self.make_glob_map {
1494 self.glob_map.entry(id).or_insert_with(FxHashSet).insert(ident.name);
1498 /// This resolves the identifier `ident` in the namespace `ns` in the current lexical scope.
1499 /// More specifically, we proceed up the hierarchy of scopes and return the binding for
1500 /// `ident` in the first scope that defines it (or None if no scopes define it).
1502 /// A block's items are above its local variables in the scope hierarchy, regardless of where
1503 /// the items are defined in the block. For example,
1506 /// g(); // Since there are no local variables in scope yet, this resolves to the item.
1509 /// g(); // This resolves to the local variable `g` since it shadows the item.
1513 /// Invariant: This must only be called during main resolution, not during
1514 /// import resolution.
1515 fn resolve_ident_in_lexical_scope(&mut self,
1520 -> Option<LexicalScopeBinding<'a>> {
1522 ident.ctxt = if ident.name == keywords::SelfType.name() {
1523 SyntaxContext::empty() // FIXME(jseyfried) improve `Self` hygiene
1529 // Walk backwards up the ribs in scope.
1530 let mut module = self.graph_root;
1531 for i in (0 .. self.ribs[ns].len()).rev() {
1532 if let Some(def) = self.ribs[ns][i].bindings.get(&ident).cloned() {
1533 // The ident resolves to a type parameter or local variable.
1534 return Some(LexicalScopeBinding::Def(
1535 self.adjust_local_def(ns, i, def, record_used, path_span)
1539 module = match self.ribs[ns][i].kind {
1540 ModuleRibKind(module) => module,
1541 MacroDefinition(def) if def == self.macro_defs[&ident.ctxt.outer()] => {
1542 // If an invocation of this macro created `ident`, give up on `ident`
1543 // and switch to `ident`'s source from the macro definition.
1544 ident.ctxt.remove_mark();
1550 let item = self.resolve_ident_in_module_unadjusted(
1551 module, ident, ns, false, record_used, path_span,
1553 if let Ok(binding) = item {
1554 // The ident resolves to an item.
1555 return Some(LexicalScopeBinding::Item(binding));
1559 ModuleKind::Block(..) => {}, // We can see through blocks
1564 ident.ctxt = ident.ctxt.modern();
1566 module = unwrap_or!(self.hygienic_lexical_parent(module, &mut ident.ctxt), break);
1567 let orig_current_module = self.current_module;
1568 self.current_module = module; // Lexical resolutions can never be a privacy error.
1569 let result = self.resolve_ident_in_module_unadjusted(
1570 module, ident, ns, false, record_used, path_span,
1572 self.current_module = orig_current_module;
1575 Ok(binding) => return Some(LexicalScopeBinding::Item(binding)),
1576 Err(Undetermined) => return None,
1577 Err(Determined) => {}
1581 match self.prelude {
1582 Some(prelude) if !module.no_implicit_prelude => {
1583 self.resolve_ident_in_module_unadjusted(prelude, ident, ns, false, false, path_span)
1584 .ok().map(LexicalScopeBinding::Item)
1590 fn hygienic_lexical_parent(&mut self, mut module: Module<'a>, ctxt: &mut SyntaxContext)
1591 -> Option<Module<'a>> {
1592 if !module.expansion.is_descendant_of(ctxt.outer()) {
1593 return Some(self.macro_def_scope(ctxt.remove_mark()));
1596 if let ModuleKind::Block(..) = module.kind {
1597 return Some(module.parent.unwrap());
1600 let mut module_expansion = module.expansion.modern(); // for backward compatability
1601 while let Some(parent) = module.parent {
1602 let parent_expansion = parent.expansion.modern();
1603 if module_expansion.is_descendant_of(parent_expansion) &&
1604 parent_expansion != module_expansion {
1605 return if parent_expansion.is_descendant_of(ctxt.outer()) {
1612 module_expansion = parent_expansion;
1618 fn resolve_ident_in_module(&mut self,
1622 ignore_unresolved_invocations: bool,
1625 -> Result<&'a NameBinding<'a>, Determinacy> {
1626 ident.ctxt = ident.ctxt.modern();
1627 let orig_current_module = self.current_module;
1628 if let Some(def) = ident.ctxt.adjust(module.expansion) {
1629 self.current_module = self.macro_def_scope(def);
1631 let result = self.resolve_ident_in_module_unadjusted(
1632 module, ident, ns, ignore_unresolved_invocations, record_used, span,
1634 self.current_module = orig_current_module;
1638 fn resolve_crate_root(&mut self, mut ctxt: SyntaxContext) -> Module<'a> {
1639 let module = match ctxt.adjust(Mark::root()) {
1640 Some(def) => self.macro_def_scope(def),
1641 None => return self.graph_root,
1643 self.get_module(DefId { index: CRATE_DEF_INDEX, ..module.normal_ancestor_id })
1646 fn resolve_self(&mut self, ctxt: &mut SyntaxContext, module: Module<'a>) -> Module<'a> {
1647 let mut module = self.get_module(module.normal_ancestor_id);
1648 while module.span.ctxt.modern() != *ctxt {
1649 let parent = module.parent.unwrap_or_else(|| self.macro_def_scope(ctxt.remove_mark()));
1650 module = self.get_module(parent.normal_ancestor_id);
1657 // We maintain a list of value ribs and type ribs.
1659 // Simultaneously, we keep track of the current position in the module
1660 // graph in the `current_module` pointer. When we go to resolve a name in
1661 // the value or type namespaces, we first look through all the ribs and
1662 // then query the module graph. When we resolve a name in the module
1663 // namespace, we can skip all the ribs (since nested modules are not
1664 // allowed within blocks in Rust) and jump straight to the current module
1667 // Named implementations are handled separately. When we find a method
1668 // call, we consult the module node to find all of the implementations in
1669 // scope. This information is lazily cached in the module node. We then
1670 // generate a fake "implementation scope" containing all the
1671 // implementations thus found, for compatibility with old resolve pass.
1673 fn with_scope<F>(&mut self, id: NodeId, f: F)
1674 where F: FnOnce(&mut Resolver)
1676 let id = self.definitions.local_def_id(id);
1677 let module = self.module_map.get(&id).cloned(); // clones a reference
1678 if let Some(module) = module {
1679 // Move down in the graph.
1680 let orig_module = replace(&mut self.current_module, module);
1681 self.ribs[ValueNS].push(Rib::new(ModuleRibKind(module)));
1682 self.ribs[TypeNS].push(Rib::new(ModuleRibKind(module)));
1684 self.finalize_current_module_macro_resolutions();
1687 self.current_module = orig_module;
1688 self.ribs[ValueNS].pop();
1689 self.ribs[TypeNS].pop();
1695 /// Searches the current set of local scopes for labels.
1696 /// Stops after meeting a closure.
1697 fn search_label(&self, mut ident: Ident) -> Option<Def> {
1698 for rib in self.label_ribs.iter().rev() {
1701 // If an invocation of this macro created `ident`, give up on `ident`
1702 // and switch to `ident`'s source from the macro definition.
1703 MacroDefinition(def) => {
1704 if def == self.macro_defs[&ident.ctxt.outer()] {
1705 ident.ctxt.remove_mark();
1709 // Do not resolve labels across function boundary
1713 let result = rib.bindings.get(&ident).cloned();
1714 if result.is_some() {
1721 fn resolve_item(&mut self, item: &Item) {
1722 let name = item.ident.name;
1724 debug!("(resolving item) resolving {}", name);
1726 self.check_proc_macro_attrs(&item.attrs);
1729 ItemKind::Enum(_, ref generics) |
1730 ItemKind::Ty(_, ref generics) |
1731 ItemKind::Struct(_, ref generics) |
1732 ItemKind::Union(_, ref generics) |
1733 ItemKind::Fn(.., ref generics, _) => {
1734 self.with_type_parameter_rib(HasTypeParameters(generics, ItemRibKind),
1735 |this| visit::walk_item(this, item));
1738 ItemKind::DefaultImpl(_, ref trait_ref) => {
1739 self.with_optional_trait_ref(Some(trait_ref), |this, _| {
1740 // Resolve type arguments in trait path
1741 visit::walk_trait_ref(this, trait_ref);
1744 ItemKind::Impl(.., ref generics, ref opt_trait_ref, ref self_type, ref impl_items) =>
1745 self.resolve_implementation(generics,
1751 ItemKind::Trait(_, ref generics, ref bounds, ref trait_items) => {
1752 // Create a new rib for the trait-wide type parameters.
1753 self.with_type_parameter_rib(HasTypeParameters(generics, ItemRibKind), |this| {
1754 let local_def_id = this.definitions.local_def_id(item.id);
1755 this.with_self_rib(Def::SelfTy(Some(local_def_id), None), |this| {
1756 this.visit_generics(generics);
1757 walk_list!(this, visit_ty_param_bound, bounds);
1759 for trait_item in trait_items {
1760 this.check_proc_macro_attrs(&trait_item.attrs);
1762 match trait_item.node {
1763 TraitItemKind::Const(ref ty, ref default) => {
1766 // Only impose the restrictions of
1767 // ConstRibKind for an actual constant
1768 // expression in a provided default.
1769 if let Some(ref expr) = *default{
1770 this.with_constant_rib(|this| {
1771 this.visit_expr(expr);
1775 TraitItemKind::Method(ref sig, _) => {
1776 let type_parameters =
1777 HasTypeParameters(&sig.generics,
1778 MethodRibKind(!sig.decl.has_self()));
1779 this.with_type_parameter_rib(type_parameters, |this| {
1780 visit::walk_trait_item(this, trait_item)
1783 TraitItemKind::Type(..) => {
1784 this.with_type_parameter_rib(NoTypeParameters, |this| {
1785 visit::walk_trait_item(this, trait_item)
1788 TraitItemKind::Macro(_) => panic!("unexpanded macro in resolve!"),
1795 ItemKind::Mod(_) | ItemKind::ForeignMod(_) => {
1796 self.with_scope(item.id, |this| {
1797 visit::walk_item(this, item);
1801 ItemKind::Static(ref ty, _, ref expr) |
1802 ItemKind::Const(ref ty, ref expr) => {
1803 self.with_item_rib(|this| {
1805 this.with_constant_rib(|this| {
1806 this.visit_expr(expr);
1811 ItemKind::Use(ref view_path) => {
1812 match view_path.node {
1813 ast::ViewPathList(ref prefix, ref items) if items.is_empty() => {
1814 // Resolve prefix of an import with empty braces (issue #28388).
1815 self.smart_resolve_path(item.id, None, prefix, PathSource::ImportPrefix);
1821 ItemKind::ExternCrate(_) | ItemKind::MacroDef(..) | ItemKind::GlobalAsm(_)=> {
1822 // do nothing, these are just around to be encoded
1825 ItemKind::Mac(_) => panic!("unexpanded macro in resolve!"),
1829 fn with_type_parameter_rib<'b, F>(&'b mut self, type_parameters: TypeParameters<'a, 'b>, f: F)
1830 where F: FnOnce(&mut Resolver)
1832 match type_parameters {
1833 HasTypeParameters(generics, rib_kind) => {
1834 let mut function_type_rib = Rib::new(rib_kind);
1835 let mut seen_bindings = FxHashMap();
1836 for type_parameter in &generics.ty_params {
1837 let ident = type_parameter.ident.modern();
1838 debug!("with_type_parameter_rib: {}", type_parameter.id);
1840 if seen_bindings.contains_key(&ident) {
1841 let span = seen_bindings.get(&ident).unwrap();
1843 ResolutionError::NameAlreadyUsedInTypeParameterList(ident.name, span);
1844 resolve_error(self, type_parameter.span, err);
1846 seen_bindings.entry(ident).or_insert(type_parameter.span);
1848 // plain insert (no renaming)
1849 let def_id = self.definitions.local_def_id(type_parameter.id);
1850 let def = Def::TyParam(def_id);
1851 function_type_rib.bindings.insert(ident, def);
1852 self.record_def(type_parameter.id, PathResolution::new(def));
1854 self.ribs[TypeNS].push(function_type_rib);
1857 NoTypeParameters => {
1864 if let HasTypeParameters(..) = type_parameters {
1865 self.ribs[TypeNS].pop();
1869 fn with_label_rib<F>(&mut self, f: F)
1870 where F: FnOnce(&mut Resolver)
1872 self.label_ribs.push(Rib::new(NormalRibKind));
1874 self.label_ribs.pop();
1877 fn with_item_rib<F>(&mut self, f: F)
1878 where F: FnOnce(&mut Resolver)
1880 self.ribs[ValueNS].push(Rib::new(ItemRibKind));
1881 self.ribs[TypeNS].push(Rib::new(ItemRibKind));
1883 self.ribs[TypeNS].pop();
1884 self.ribs[ValueNS].pop();
1887 fn with_constant_rib<F>(&mut self, f: F)
1888 where F: FnOnce(&mut Resolver)
1890 self.ribs[ValueNS].push(Rib::new(ConstantItemRibKind));
1892 self.ribs[ValueNS].pop();
1895 fn with_current_self_type<T, F>(&mut self, self_type: &Ty, f: F) -> T
1896 where F: FnOnce(&mut Resolver) -> T
1898 // Handle nested impls (inside fn bodies)
1899 let previous_value = replace(&mut self.current_self_type, Some(self_type.clone()));
1900 let result = f(self);
1901 self.current_self_type = previous_value;
1905 fn with_optional_trait_ref<T, F>(&mut self, opt_trait_ref: Option<&TraitRef>, f: F) -> T
1906 where F: FnOnce(&mut Resolver, Option<DefId>) -> T
1908 let mut new_val = None;
1909 let mut new_id = None;
1910 if let Some(trait_ref) = opt_trait_ref {
1911 let path: Vec<_> = trait_ref.path.segments.iter().map(|seg| seg.identifier).collect();
1912 let def = self.smart_resolve_path_fragment(trait_ref.ref_id,
1915 trait_ref.path.span,
1916 trait_ref.path.segments.last().unwrap().span,
1919 if def != Def::Err {
1920 new_id = Some(def.def_id());
1921 let span = trait_ref.path.span;
1922 if let PathResult::Module(module) = self.resolve_path(&path, None, false, span) {
1923 new_val = Some((module, trait_ref.clone()));
1927 let original_trait_ref = replace(&mut self.current_trait_ref, new_val);
1928 let result = f(self, new_id);
1929 self.current_trait_ref = original_trait_ref;
1933 fn with_self_rib<F>(&mut self, self_def: Def, f: F)
1934 where F: FnOnce(&mut Resolver)
1936 let mut self_type_rib = Rib::new(NormalRibKind);
1938 // plain insert (no renaming, types are not currently hygienic....)
1939 self_type_rib.bindings.insert(keywords::SelfType.ident(), self_def);
1940 self.ribs[TypeNS].push(self_type_rib);
1942 self.ribs[TypeNS].pop();
1945 fn resolve_implementation(&mut self,
1946 generics: &Generics,
1947 opt_trait_reference: &Option<TraitRef>,
1950 impl_items: &[ImplItem]) {
1951 // If applicable, create a rib for the type parameters.
1952 self.with_type_parameter_rib(HasTypeParameters(generics, ItemRibKind), |this| {
1953 // Dummy self type for better errors if `Self` is used in the trait path.
1954 this.with_self_rib(Def::SelfTy(None, None), |this| {
1955 // Resolve the trait reference, if necessary.
1956 this.with_optional_trait_ref(opt_trait_reference.as_ref(), |this, trait_id| {
1957 let item_def_id = this.definitions.local_def_id(item_id);
1958 this.with_self_rib(Def::SelfTy(trait_id, Some(item_def_id)), |this| {
1959 if let Some(trait_ref) = opt_trait_reference.as_ref() {
1960 // Resolve type arguments in trait path
1961 visit::walk_trait_ref(this, trait_ref);
1963 // Resolve the self type.
1964 this.visit_ty(self_type);
1965 // Resolve the type parameters.
1966 this.visit_generics(generics);
1967 this.with_current_self_type(self_type, |this| {
1968 for impl_item in impl_items {
1969 this.check_proc_macro_attrs(&impl_item.attrs);
1970 this.resolve_visibility(&impl_item.vis);
1971 match impl_item.node {
1972 ImplItemKind::Const(..) => {
1973 // If this is a trait impl, ensure the const
1975 this.check_trait_item(impl_item.ident,
1978 |n, s| ResolutionError::ConstNotMemberOfTrait(n, s));
1979 visit::walk_impl_item(this, impl_item);
1981 ImplItemKind::Method(ref sig, _) => {
1982 // If this is a trait impl, ensure the method
1984 this.check_trait_item(impl_item.ident,
1987 |n, s| ResolutionError::MethodNotMemberOfTrait(n, s));
1989 // We also need a new scope for the method-
1990 // specific type parameters.
1991 let type_parameters =
1992 HasTypeParameters(&sig.generics,
1993 MethodRibKind(!sig.decl.has_self()));
1994 this.with_type_parameter_rib(type_parameters, |this| {
1995 visit::walk_impl_item(this, impl_item);
1998 ImplItemKind::Type(ref ty) => {
1999 // If this is a trait impl, ensure the type
2001 this.check_trait_item(impl_item.ident,
2004 |n, s| ResolutionError::TypeNotMemberOfTrait(n, s));
2008 ImplItemKind::Macro(_) =>
2009 panic!("unexpanded macro in resolve!"),
2019 fn check_trait_item<F>(&mut self, ident: Ident, ns: Namespace, span: Span, err: F)
2020 where F: FnOnce(Name, &str) -> ResolutionError
2022 // If there is a TraitRef in scope for an impl, then the method must be in the
2024 if let Some((module, _)) = self.current_trait_ref {
2025 if self.resolve_ident_in_module(module, ident, ns, false, false, span).is_err() {
2026 let path = &self.current_trait_ref.as_ref().unwrap().1.path;
2027 resolve_error(self, span, err(ident.name, &path_names_to_string(path)));
2032 fn resolve_local(&mut self, local: &Local) {
2033 // Resolve the type.
2034 walk_list!(self, visit_ty, &local.ty);
2036 // Resolve the initializer.
2037 walk_list!(self, visit_expr, &local.init);
2039 // Resolve the pattern.
2040 self.resolve_pattern(&local.pat, PatternSource::Let, &mut FxHashMap());
2043 // build a map from pattern identifiers to binding-info's.
2044 // this is done hygienically. This could arise for a macro
2045 // that expands into an or-pattern where one 'x' was from the
2046 // user and one 'x' came from the macro.
2047 fn binding_mode_map(&mut self, pat: &Pat) -> BindingMap {
2048 let mut binding_map = FxHashMap();
2050 pat.walk(&mut |pat| {
2051 if let PatKind::Ident(binding_mode, ident, ref sub_pat) = pat.node {
2052 if sub_pat.is_some() || match self.def_map.get(&pat.id).map(|res| res.base_def()) {
2053 Some(Def::Local(..)) => true,
2056 let binding_info = BindingInfo { span: ident.span, binding_mode: binding_mode };
2057 binding_map.insert(ident.node, binding_info);
2066 // check that all of the arms in an or-pattern have exactly the
2067 // same set of bindings, with the same binding modes for each.
2068 fn check_consistent_bindings(&mut self, arm: &Arm) {
2069 if arm.pats.is_empty() {
2073 let mut missing_vars = FxHashMap();
2074 let mut inconsistent_vars = FxHashMap();
2075 for (i, p) in arm.pats.iter().enumerate() {
2076 let map_i = self.binding_mode_map(&p);
2078 for (j, q) in arm.pats.iter().enumerate() {
2083 let map_j = self.binding_mode_map(&q);
2084 for (&key, &binding_i) in &map_i {
2085 if map_j.len() == 0 { // Account for missing bindings when
2086 let binding_error = missing_vars // map_j has none.
2088 .or_insert(BindingError {
2090 origin: BTreeSet::new(),
2091 target: BTreeSet::new(),
2093 binding_error.origin.insert(binding_i.span);
2094 binding_error.target.insert(q.span);
2096 for (&key_j, &binding_j) in &map_j {
2097 match map_i.get(&key_j) {
2098 None => { // missing binding
2099 let binding_error = missing_vars
2101 .or_insert(BindingError {
2103 origin: BTreeSet::new(),
2104 target: BTreeSet::new(),
2106 binding_error.origin.insert(binding_j.span);
2107 binding_error.target.insert(p.span);
2109 Some(binding_i) => { // check consistent binding
2110 if binding_i.binding_mode != binding_j.binding_mode {
2113 .or_insert((binding_j.span, binding_i.span));
2121 let mut missing_vars = missing_vars.iter().collect::<Vec<_>>();
2122 missing_vars.sort();
2123 for (_, v) in missing_vars {
2125 *v.origin.iter().next().unwrap(),
2126 ResolutionError::VariableNotBoundInPattern(v));
2128 let mut inconsistent_vars = inconsistent_vars.iter().collect::<Vec<_>>();
2129 inconsistent_vars.sort();
2130 for (name, v) in inconsistent_vars {
2131 resolve_error(self, v.0, ResolutionError::VariableBoundWithDifferentMode(*name, v.1));
2135 fn resolve_arm(&mut self, arm: &Arm) {
2136 self.ribs[ValueNS].push(Rib::new(NormalRibKind));
2138 let mut bindings_list = FxHashMap();
2139 for pattern in &arm.pats {
2140 self.resolve_pattern(&pattern, PatternSource::Match, &mut bindings_list);
2143 // This has to happen *after* we determine which
2144 // pat_idents are variants
2145 self.check_consistent_bindings(arm);
2147 walk_list!(self, visit_expr, &arm.guard);
2148 self.visit_expr(&arm.body);
2150 self.ribs[ValueNS].pop();
2153 fn resolve_block(&mut self, block: &Block) {
2154 debug!("(resolving block) entering block");
2155 // Move down in the graph, if there's an anonymous module rooted here.
2156 let orig_module = self.current_module;
2157 let anonymous_module = self.block_map.get(&block.id).cloned(); // clones a reference
2159 let mut num_macro_definition_ribs = 0;
2160 if let Some(anonymous_module) = anonymous_module {
2161 debug!("(resolving block) found anonymous module, moving down");
2162 self.ribs[ValueNS].push(Rib::new(ModuleRibKind(anonymous_module)));
2163 self.ribs[TypeNS].push(Rib::new(ModuleRibKind(anonymous_module)));
2164 self.current_module = anonymous_module;
2165 self.finalize_current_module_macro_resolutions();
2167 self.ribs[ValueNS].push(Rib::new(NormalRibKind));
2170 // Descend into the block.
2171 for stmt in &block.stmts {
2172 if let ast::StmtKind::Item(ref item) = stmt.node {
2173 if let ast::ItemKind::MacroDef(..) = item.node {
2174 num_macro_definition_ribs += 1;
2175 let def = self.definitions.local_def_id(item.id);
2176 self.ribs[ValueNS].push(Rib::new(MacroDefinition(def)));
2177 self.label_ribs.push(Rib::new(MacroDefinition(def)));
2181 self.visit_stmt(stmt);
2185 self.current_module = orig_module;
2186 for _ in 0 .. num_macro_definition_ribs {
2187 self.ribs[ValueNS].pop();
2188 self.label_ribs.pop();
2190 self.ribs[ValueNS].pop();
2191 if let Some(_) = anonymous_module {
2192 self.ribs[TypeNS].pop();
2194 debug!("(resolving block) leaving block");
2197 fn fresh_binding(&mut self,
2198 ident: &SpannedIdent,
2200 outer_pat_id: NodeId,
2201 pat_src: PatternSource,
2202 bindings: &mut FxHashMap<Ident, NodeId>)
2204 // Add the binding to the local ribs, if it
2205 // doesn't already exist in the bindings map. (We
2206 // must not add it if it's in the bindings map
2207 // because that breaks the assumptions later
2208 // passes make about or-patterns.)
2209 let mut def = Def::Local(self.definitions.local_def_id(pat_id));
2210 match bindings.get(&ident.node).cloned() {
2211 Some(id) if id == outer_pat_id => {
2212 // `Variant(a, a)`, error
2216 ResolutionError::IdentifierBoundMoreThanOnceInSamePattern(
2217 &ident.node.name.as_str())
2220 Some(..) if pat_src == PatternSource::FnParam => {
2221 // `fn f(a: u8, a: u8)`, error
2225 ResolutionError::IdentifierBoundMoreThanOnceInParameterList(
2226 &ident.node.name.as_str())
2229 Some(..) if pat_src == PatternSource::Match => {
2230 // `Variant1(a) | Variant2(a)`, ok
2231 // Reuse definition from the first `a`.
2232 def = self.ribs[ValueNS].last_mut().unwrap().bindings[&ident.node];
2235 span_bug!(ident.span, "two bindings with the same name from \
2236 unexpected pattern source {:?}", pat_src);
2239 // A completely fresh binding, add to the lists if it's valid.
2240 if ident.node.name != keywords::Invalid.name() {
2241 bindings.insert(ident.node, outer_pat_id);
2242 self.ribs[ValueNS].last_mut().unwrap().bindings.insert(ident.node, def);
2247 PathResolution::new(def)
2250 fn resolve_pattern(&mut self,
2252 pat_src: PatternSource,
2253 // Maps idents to the node ID for the
2254 // outermost pattern that binds them.
2255 bindings: &mut FxHashMap<Ident, NodeId>) {
2256 // Visit all direct subpatterns of this pattern.
2257 let outer_pat_id = pat.id;
2258 pat.walk(&mut |pat| {
2260 PatKind::Ident(bmode, ref ident, ref opt_pat) => {
2261 // First try to resolve the identifier as some existing
2262 // entity, then fall back to a fresh binding.
2263 let binding = self.resolve_ident_in_lexical_scope(ident.node, ValueNS,
2265 .and_then(LexicalScopeBinding::item);
2266 let resolution = binding.map(NameBinding::def).and_then(|def| {
2267 let always_binding = !pat_src.is_refutable() || opt_pat.is_some() ||
2268 bmode != BindingMode::ByValue(Mutability::Immutable);
2270 Def::StructCtor(_, CtorKind::Const) |
2271 Def::VariantCtor(_, CtorKind::Const) |
2272 Def::Const(..) if !always_binding => {
2273 // A unit struct/variant or constant pattern.
2274 self.record_use(ident.node, ValueNS, binding.unwrap(), ident.span);
2275 Some(PathResolution::new(def))
2277 Def::StructCtor(..) | Def::VariantCtor(..) |
2278 Def::Const(..) | Def::Static(..) => {
2279 // A fresh binding that shadows something unacceptable.
2283 ResolutionError::BindingShadowsSomethingUnacceptable(
2284 pat_src.descr(), ident.node.name, binding.unwrap())
2288 Def::Local(..) | Def::Upvar(..) | Def::Fn(..) | Def::Err => {
2289 // These entities are explicitly allowed
2290 // to be shadowed by fresh bindings.
2294 span_bug!(ident.span, "unexpected definition for an \
2295 identifier in pattern: {:?}", def);
2298 }).unwrap_or_else(|| {
2299 self.fresh_binding(ident, pat.id, outer_pat_id, pat_src, bindings)
2302 self.record_def(pat.id, resolution);
2305 PatKind::TupleStruct(ref path, ..) => {
2306 self.smart_resolve_path(pat.id, None, path, PathSource::TupleStruct);
2309 PatKind::Path(ref qself, ref path) => {
2310 self.smart_resolve_path(pat.id, qself.as_ref(), path, PathSource::Pat);
2313 PatKind::Struct(ref path, ..) => {
2314 self.smart_resolve_path(pat.id, None, path, PathSource::Struct);
2322 visit::walk_pat(self, pat);
2325 // High-level and context dependent path resolution routine.
2326 // Resolves the path and records the resolution into definition map.
2327 // If resolution fails tries several techniques to find likely
2328 // resolution candidates, suggest imports or other help, and report
2329 // errors in user friendly way.
2330 fn smart_resolve_path(&mut self,
2332 qself: Option<&QSelf>,
2336 let segments = &path.segments.iter().map(|seg| seg.identifier).collect::<Vec<_>>();
2337 let ident_span = path.segments.last().map_or(path.span, |seg| seg.span);
2338 self.smart_resolve_path_fragment(id, qself, segments, path.span, ident_span, source)
2341 fn smart_resolve_path_fragment(&mut self,
2343 qself: Option<&QSelf>,
2349 let ns = source.namespace();
2350 let is_expected = &|def| source.is_expected(def);
2351 let is_enum_variant = &|def| if let Def::Variant(..) = def { true } else { false };
2353 // Base error is amended with one short label and possibly some longer helps/notes.
2354 let report_errors = |this: &mut Self, def: Option<Def>| {
2355 // Make the base error.
2356 let expected = source.descr_expected();
2357 let path_str = names_to_string(path);
2358 let code = source.error_code(def.is_some());
2359 let (base_msg, fallback_label, base_span) = if let Some(def) = def {
2360 (format!("expected {}, found {} `{}`", expected, def.kind_name(), path_str),
2361 format!("not a {}", expected), span)
2363 let item_str = path[path.len() - 1];
2364 let (mod_prefix, mod_str) = if path.len() == 1 {
2365 (format!(""), format!("this scope"))
2366 } else if path.len() == 2 && path[0].name == keywords::CrateRoot.name() {
2367 (format!(""), format!("the crate root"))
2369 let mod_path = &path[..path.len() - 1];
2370 let mod_prefix = match this.resolve_path(mod_path, Some(TypeNS), false, span) {
2371 PathResult::Module(module) => module.def(),
2373 }.map_or(format!(""), |def| format!("{} ", def.kind_name()));
2374 (mod_prefix, format!("`{}`", names_to_string(mod_path)))
2376 (format!("cannot find {} `{}` in {}{}", expected, item_str, mod_prefix, mod_str),
2377 format!("not found in {}", mod_str), ident_span)
2379 let mut err = this.session.struct_span_err_with_code(base_span, &base_msg, code);
2381 // Emit special messages for unresolved `Self` and `self`.
2382 if is_self_type(path, ns) {
2383 __diagnostic_used!(E0411);
2384 err.code("E0411".into());
2385 err.span_label(span, "`Self` is only available in traits and impls");
2388 if is_self_value(path, ns) {
2389 __diagnostic_used!(E0424);
2390 err.code("E0424".into());
2391 err.span_label(span, format!("`self` value is only available in \
2392 methods with `self` parameter"));
2396 // Try to lookup the name in more relaxed fashion for better error reporting.
2397 let ident = *path.last().unwrap();
2398 let candidates = this.lookup_import_candidates(ident.name, ns, is_expected);
2399 if !candidates.is_empty() {
2400 let mut module_span = this.current_module.span;
2401 module_span.hi = module_span.lo;
2402 // Report import candidates as help and proceed searching for labels.
2403 show_candidates(&mut err, module_span, &candidates, def.is_some());
2404 } else if is_expected(Def::Enum(DefId::local(CRATE_DEF_INDEX))) {
2405 let enum_candidates =
2406 this.lookup_import_candidates(ident.name, ns, is_enum_variant);
2407 let mut enum_candidates = enum_candidates.iter()
2408 .map(|suggestion| import_candidate_to_paths(&suggestion)).collect::<Vec<_>>();
2409 enum_candidates.sort();
2410 for (sp, variant_path, enum_path) in enum_candidates {
2411 let msg = format!("there is an enum variant `{}`, did you mean to use `{}`?",
2417 err.span_help(sp, &msg);
2421 if path.len() == 1 && this.self_type_is_available(span) {
2422 if let Some(candidate) = this.lookup_assoc_candidate(ident, ns, is_expected) {
2423 let self_is_available = this.self_value_is_available(path[0].ctxt, span);
2425 AssocSuggestion::Field => {
2426 err.span_label(span, format!("did you mean `self.{}`?", path_str));
2427 if !self_is_available {
2428 err.span_label(span, format!("`self` value is only available in \
2429 methods with `self` parameter"));
2432 AssocSuggestion::MethodWithSelf if self_is_available => {
2433 err.span_label(span, format!("did you mean `self.{}(...)`?",
2436 AssocSuggestion::MethodWithSelf | AssocSuggestion::AssocItem => {
2437 err.span_label(span, format!("did you mean `Self::{}`?", path_str));
2444 let mut levenshtein_worked = false;
2447 if let Some(candidate) = this.lookup_typo_candidate(path, ns, is_expected, span) {
2448 err.span_label(ident_span, format!("did you mean `{}`?", candidate));
2449 levenshtein_worked = true;
2452 // Try context dependent help if relaxed lookup didn't work.
2453 if let Some(def) = def {
2454 match (def, source) {
2455 (Def::Macro(..), _) => {
2456 err.span_label(span, format!("did you mean `{}!(...)`?", path_str));
2459 (Def::TyAlias(..), PathSource::Trait) => {
2460 err.span_label(span, "type aliases cannot be used for traits");
2463 (Def::Mod(..), PathSource::Expr(Some(parent))) => match parent.node {
2464 ExprKind::Field(_, ident) => {
2465 err.span_label(parent.span, format!("did you mean `{}::{}`?",
2466 path_str, ident.node));
2469 ExprKind::MethodCall(ident, ..) => {
2470 err.span_label(parent.span, format!("did you mean `{}::{}(...)`?",
2471 path_str, ident.node));
2476 _ if ns == ValueNS && is_struct_like(def) => {
2477 if let Def::Struct(def_id) = def {
2478 if let Some((ctor_def, ctor_vis))
2479 = this.struct_constructors.get(&def_id).cloned() {
2480 if is_expected(ctor_def) && !this.is_accessible(ctor_vis) {
2481 err.span_label(span, format!("constructor is not visible \
2482 here due to private fields"));
2486 err.span_label(span, format!("did you mean `{} {{ /* fields */ }}`?",
2495 if !levenshtein_worked {
2496 err.span_label(base_span, fallback_label);
2500 let report_errors = |this: &mut Self, def: Option<Def>| {
2501 report_errors(this, def).emit();
2502 err_path_resolution()
2505 let resolution = match self.resolve_qpath_anywhere(id, qself, path, ns, span,
2506 source.defer_to_typeck(),
2507 source.global_by_default()) {
2508 Some(resolution) if resolution.unresolved_segments() == 0 => {
2509 if is_expected(resolution.base_def()) || resolution.base_def() == Def::Err {
2512 // Add a temporary hack to smooth the transition to new struct ctor
2513 // visibility rules. See #38932 for more details.
2515 if let Def::Struct(def_id) = resolution.base_def() {
2516 if let Some((ctor_def, ctor_vis))
2517 = self.struct_constructors.get(&def_id).cloned() {
2518 if is_expected(ctor_def) && self.is_accessible(ctor_vis) {
2519 let lint = lint::builtin::LEGACY_CONSTRUCTOR_VISIBILITY;
2520 self.session.add_lint(lint, id, span,
2521 "private struct constructors are not usable through \
2522 reexports in outer modules".to_string());
2523 res = Some(PathResolution::new(ctor_def));
2528 res.unwrap_or_else(|| report_errors(self, Some(resolution.base_def())))
2531 Some(resolution) if source.defer_to_typeck() => {
2532 // Not fully resolved associated item `T::A::B` or `<T as Tr>::A::B`
2533 // or `<T>::A::B`. If `B` should be resolved in value namespace then
2534 // it needs to be added to the trait map.
2536 let item_name = *path.last().unwrap();
2537 let traits = self.get_traits_containing_item(item_name, ns);
2538 self.trait_map.insert(id, traits);
2542 _ => report_errors(self, None)
2545 if let PathSource::TraitItem(..) = source {} else {
2546 // Avoid recording definition of `A::B` in `<T as A>::B::C`.
2547 self.record_def(id, resolution);
2552 fn self_type_is_available(&mut self, span: Span) -> bool {
2553 let binding = self.resolve_ident_in_lexical_scope(keywords::SelfType.ident(),
2554 TypeNS, false, span);
2555 if let Some(LexicalScopeBinding::Def(def)) = binding { def != Def::Err } else { false }
2558 fn self_value_is_available(&mut self, ctxt: SyntaxContext, span: Span) -> bool {
2559 let ident = Ident { name: keywords::SelfValue.name(), ctxt: ctxt };
2560 let binding = self.resolve_ident_in_lexical_scope(ident, ValueNS, false, span);
2561 if let Some(LexicalScopeBinding::Def(def)) = binding { def != Def::Err } else { false }
2564 // Resolve in alternative namespaces if resolution in the primary namespace fails.
2565 fn resolve_qpath_anywhere(&mut self,
2567 qself: Option<&QSelf>,
2569 primary_ns: Namespace,
2571 defer_to_typeck: bool,
2572 global_by_default: bool)
2573 -> Option<PathResolution> {
2574 let mut fin_res = None;
2575 // FIXME: can't resolve paths in macro namespace yet, macros are
2576 // processed by the little special hack below.
2577 for (i, ns) in [primary_ns, TypeNS, ValueNS, /*MacroNS*/].iter().cloned().enumerate() {
2578 if i == 0 || ns != primary_ns {
2579 match self.resolve_qpath(id, qself, path, ns, span, global_by_default) {
2580 // If defer_to_typeck, then resolution > no resolution,
2581 // otherwise full resolution > partial resolution > no resolution.
2582 Some(res) if res.unresolved_segments() == 0 || defer_to_typeck =>
2584 res => if fin_res.is_none() { fin_res = res },
2588 let is_global = self.global_macros.get(&path[0].name).cloned()
2589 .map(|binding| binding.get_macro(self).kind() == MacroKind::Bang).unwrap_or(false);
2590 if primary_ns != MacroNS && (is_global || self.macro_names.contains(&path[0].modern())) {
2591 // Return some dummy definition, it's enough for error reporting.
2593 PathResolution::new(Def::Macro(DefId::local(CRATE_DEF_INDEX), MacroKind::Bang))
2599 /// Handles paths that may refer to associated items.
2600 fn resolve_qpath(&mut self,
2602 qself: Option<&QSelf>,
2606 global_by_default: bool)
2607 -> Option<PathResolution> {
2608 if let Some(qself) = qself {
2609 if qself.position == 0 {
2610 // FIXME: Create some fake resolution that can't possibly be a type.
2611 return Some(PathResolution::with_unresolved_segments(
2612 Def::Mod(DefId::local(CRATE_DEF_INDEX)), path.len()
2615 // Make sure `A::B` in `<T as A>::B::C` is a trait item.
2616 let ns = if qself.position + 1 == path.len() { ns } else { TypeNS };
2617 let res = self.smart_resolve_path_fragment(id, None, &path[..qself.position + 1],
2618 span, span, PathSource::TraitItem(ns));
2619 return Some(PathResolution::with_unresolved_segments(
2620 res.base_def(), res.unresolved_segments() + path.len() - qself.position - 1
2624 let result = match self.resolve_path(&path, Some(ns), true, span) {
2625 PathResult::NonModule(path_res) => path_res,
2626 PathResult::Module(module) if !module.is_normal() => {
2627 PathResolution::new(module.def().unwrap())
2629 // In `a(::assoc_item)*` `a` cannot be a module. If `a` does resolve to a module we
2630 // don't report an error right away, but try to fallback to a primitive type.
2631 // So, we are still able to successfully resolve something like
2633 // use std::u8; // bring module u8 in scope
2634 // fn f() -> u8 { // OK, resolves to primitive u8, not to std::u8
2635 // u8::max_value() // OK, resolves to associated function <u8>::max_value,
2636 // // not to non-existent std::u8::max_value
2639 // Such behavior is required for backward compatibility.
2640 // The same fallback is used when `a` resolves to nothing.
2641 PathResult::Module(..) | PathResult::Failed(..)
2642 if (ns == TypeNS || path.len() > 1) &&
2643 self.primitive_type_table.primitive_types.contains_key(&path[0].name) => {
2644 let prim = self.primitive_type_table.primitive_types[&path[0].name];
2646 TyUint(UintTy::U128) | TyInt(IntTy::I128) => {
2647 if !self.session.features.borrow().i128_type {
2648 emit_feature_err(&self.session.parse_sess,
2649 "i128_type", span, GateIssue::Language,
2650 "128-bit type is unstable");
2656 PathResolution::with_unresolved_segments(Def::PrimTy(prim), path.len() - 1)
2658 PathResult::Module(module) => PathResolution::new(module.def().unwrap()),
2659 PathResult::Failed(msg, false) => {
2660 resolve_error(self, span, ResolutionError::FailedToResolve(&msg));
2661 err_path_resolution()
2663 PathResult::Failed(..) => return None,
2664 PathResult::Indeterminate => bug!("indetermined path result in resolve_qpath"),
2667 if path.len() > 1 && !global_by_default && result.base_def() != Def::Err &&
2668 path[0].name != keywords::CrateRoot.name() && path[0].name != "$crate" {
2669 let unqualified_result = {
2670 match self.resolve_path(&[*path.last().unwrap()], Some(ns), false, span) {
2671 PathResult::NonModule(path_res) => path_res.base_def(),
2672 PathResult::Module(module) => module.def().unwrap(),
2673 _ => return Some(result),
2676 if result.base_def() == unqualified_result {
2677 let lint = lint::builtin::UNUSED_QUALIFICATIONS;
2678 self.session.add_lint(lint, id, span, "unnecessary qualification".to_string());
2685 fn resolve_path(&mut self,
2687 opt_ns: Option<Namespace>, // `None` indicates a module path
2691 let mut module = None;
2692 let mut allow_super = true;
2694 for (i, &ident) in path.iter().enumerate() {
2695 let is_last = i == path.len() - 1;
2696 let ns = if is_last { opt_ns.unwrap_or(TypeNS) } else { TypeNS };
2698 if i == 0 && ns == TypeNS && ident.name == keywords::SelfValue.name() {
2699 let mut ctxt = ident.ctxt.modern();
2700 module = Some(self.resolve_self(&mut ctxt, self.current_module));
2702 } else if allow_super && ns == TypeNS && ident.name == keywords::Super.name() {
2703 let mut ctxt = ident.ctxt.modern();
2704 let self_module = match i {
2705 0 => self.resolve_self(&mut ctxt, self.current_module),
2706 _ => module.unwrap(),
2708 if let Some(parent) = self_module.parent {
2709 module = Some(self.resolve_self(&mut ctxt, parent));
2712 let msg = "There are too many initial `super`s.".to_string();
2713 return PathResult::Failed(msg, false);
2716 allow_super = false;
2718 if i == 0 && ns == TypeNS && ident.name == keywords::CrateRoot.name() {
2719 module = Some(self.resolve_crate_root(ident.ctxt.modern()));
2721 } else if i == 0 && ns == TypeNS && ident.name == "$crate" {
2722 module = Some(self.resolve_crate_root(ident.ctxt));
2726 let binding = if let Some(module) = module {
2727 self.resolve_ident_in_module(module, ident, ns, false, record_used, path_span)
2728 } else if opt_ns == Some(MacroNS) {
2729 self.resolve_lexical_macro_path_segment(ident, ns, record_used, path_span)
2730 .map(MacroBinding::binding)
2732 match self.resolve_ident_in_lexical_scope(ident, ns, record_used, path_span) {
2733 Some(LexicalScopeBinding::Item(binding)) => Ok(binding),
2734 Some(LexicalScopeBinding::Def(def))
2735 if opt_ns == Some(TypeNS) || opt_ns == Some(ValueNS) => {
2736 return PathResult::NonModule(PathResolution::with_unresolved_segments(
2740 _ => Err(if record_used { Determined } else { Undetermined }),
2746 let def = binding.def();
2747 let maybe_assoc = opt_ns != Some(MacroNS) && PathSource::Type.is_expected(def);
2748 if let Some(next_module) = binding.module() {
2749 module = Some(next_module);
2750 } else if def == Def::Err {
2751 return PathResult::NonModule(err_path_resolution());
2752 } else if opt_ns.is_some() && (is_last || maybe_assoc) {
2753 return PathResult::NonModule(PathResolution::with_unresolved_segments(
2754 def, path.len() - i - 1
2757 return PathResult::Failed(format!("Not a module `{}`", ident), is_last);
2760 Err(Undetermined) => return PathResult::Indeterminate,
2761 Err(Determined) => {
2762 if let Some(module) = module {
2763 if opt_ns.is_some() && !module.is_normal() {
2764 return PathResult::NonModule(PathResolution::with_unresolved_segments(
2765 module.def().unwrap(), path.len() - i
2769 let msg = if module.and_then(ModuleData::def) == self.graph_root.def() {
2770 let is_mod = |def| match def { Def::Mod(..) => true, _ => false };
2771 let mut candidates =
2772 self.lookup_import_candidates(ident.name, TypeNS, is_mod);
2773 candidates.sort_by_key(|c| (c.path.segments.len(), c.path.to_string()));
2774 if let Some(candidate) = candidates.get(0) {
2775 format!("Did you mean `{}`?", candidate.path)
2777 format!("Maybe a missing `extern crate {};`?", ident)
2780 format!("Use of undeclared type or module `{}`", ident)
2782 format!("Could not find `{}` in `{}`", ident, path[i - 1])
2784 return PathResult::Failed(msg, is_last);
2789 PathResult::Module(module.unwrap_or(self.graph_root))
2792 // Resolve a local definition, potentially adjusting for closures.
2793 fn adjust_local_def(&mut self,
2798 span: Span) -> Def {
2799 let ribs = &self.ribs[ns][rib_index + 1..];
2801 // An invalid forward use of a type parameter from a previous default.
2802 if let ForwardTyParamBanRibKind = self.ribs[ns][rib_index].kind {
2804 resolve_error(self, span,
2805 ResolutionError::ForwardDeclaredTyParam);
2807 assert_eq!(def, Def::Err);
2813 span_bug!(span, "unexpected {:?} in bindings", def)
2815 Def::Local(def_id) => {
2818 NormalRibKind | ModuleRibKind(..) | MacroDefinition(..) |
2819 ForwardTyParamBanRibKind => {
2820 // Nothing to do. Continue.
2822 ClosureRibKind(function_id) => {
2824 let node_id = self.definitions.as_local_node_id(def_id).unwrap();
2826 let seen = self.freevars_seen
2828 .or_insert_with(|| NodeMap());
2829 if let Some(&index) = seen.get(&node_id) {
2830 def = Def::Upvar(def_id, index, function_id);
2833 let vec = self.freevars
2835 .or_insert_with(|| vec![]);
2836 let depth = vec.len();
2837 def = Def::Upvar(def_id, depth, function_id);
2844 seen.insert(node_id, depth);
2847 ItemRibKind | MethodRibKind(_) => {
2848 // This was an attempt to access an upvar inside a
2849 // named function item. This is not allowed, so we
2852 resolve_error(self, span,
2853 ResolutionError::CannotCaptureDynamicEnvironmentInFnItem);
2857 ConstantItemRibKind => {
2858 // Still doesn't deal with upvars
2860 resolve_error(self, span,
2861 ResolutionError::AttemptToUseNonConstantValueInConstant);
2868 Def::TyParam(..) | Def::SelfTy(..) => {
2871 NormalRibKind | MethodRibKind(_) | ClosureRibKind(..) |
2872 ModuleRibKind(..) | MacroDefinition(..) | ForwardTyParamBanRibKind |
2873 ConstantItemRibKind => {
2874 // Nothing to do. Continue.
2877 // This was an attempt to use a type parameter outside
2880 resolve_error(self, span,
2881 ResolutionError::TypeParametersFromOuterFunction);
2893 // Calls `f` with a `Resolver` whose current lexical scope is `module`'s lexical scope,
2894 // i.e. the module's items and the prelude (unless the module is `#[no_implicit_prelude]`).
2895 // FIXME #34673: This needs testing.
2896 pub fn with_module_lexical_scope<T, F>(&mut self, module: Module<'a>, f: F) -> T
2897 where F: FnOnce(&mut Resolver<'a>) -> T,
2899 self.with_empty_ribs(|this| {
2900 this.ribs[ValueNS].push(Rib::new(ModuleRibKind(module)));
2901 this.ribs[TypeNS].push(Rib::new(ModuleRibKind(module)));
2906 fn with_empty_ribs<T, F>(&mut self, f: F) -> T
2907 where F: FnOnce(&mut Resolver<'a>) -> T,
2909 let ribs = replace(&mut self.ribs, PerNS::<Vec<Rib>>::default());
2910 let label_ribs = replace(&mut self.label_ribs, Vec::new());
2912 let result = f(self);
2914 self.label_ribs = label_ribs;
2918 fn lookup_assoc_candidate<FilterFn>(&mut self,
2921 filter_fn: FilterFn)
2922 -> Option<AssocSuggestion>
2923 where FilterFn: Fn(Def) -> bool
2925 fn extract_node_id(t: &Ty) -> Option<NodeId> {
2927 TyKind::Path(None, _) => Some(t.id),
2928 TyKind::Rptr(_, ref mut_ty) => extract_node_id(&mut_ty.ty),
2929 // This doesn't handle the remaining `Ty` variants as they are not
2930 // that commonly the self_type, it might be interesting to provide
2931 // support for those in future.
2936 // Fields are generally expected in the same contexts as locals.
2937 if filter_fn(Def::Local(DefId::local(CRATE_DEF_INDEX))) {
2938 if let Some(node_id) = self.current_self_type.as_ref().and_then(extract_node_id) {
2939 // Look for a field with the same name in the current self_type.
2940 if let Some(resolution) = self.def_map.get(&node_id) {
2941 match resolution.base_def() {
2942 Def::Struct(did) | Def::Union(did)
2943 if resolution.unresolved_segments() == 0 => {
2944 if let Some(field_names) = self.field_names.get(&did) {
2945 if field_names.iter().any(|&field_name| ident.name == field_name) {
2946 return Some(AssocSuggestion::Field);
2956 // Look for associated items in the current trait.
2957 if let Some((module, _)) = self.current_trait_ref {
2958 if let Ok(binding) =
2959 self.resolve_ident_in_module(module, ident, ns, false, false, module.span) {
2960 let def = binding.def();
2962 return Some(if self.has_self.contains(&def.def_id()) {
2963 AssocSuggestion::MethodWithSelf
2965 AssocSuggestion::AssocItem
2974 fn lookup_typo_candidate<FilterFn>(&mut self,
2977 filter_fn: FilterFn,
2980 where FilterFn: Fn(Def) -> bool
2982 let add_module_candidates = |module: Module, names: &mut Vec<Name>| {
2983 for (&(ident, _), resolution) in module.resolutions.borrow().iter() {
2984 if let Some(binding) = resolution.borrow().binding {
2985 if filter_fn(binding.def()) {
2986 names.push(ident.name);
2992 let mut names = Vec::new();
2993 if path.len() == 1 {
2994 // Search in lexical scope.
2995 // Walk backwards up the ribs in scope and collect candidates.
2996 for rib in self.ribs[ns].iter().rev() {
2997 // Locals and type parameters
2998 for (ident, def) in &rib.bindings {
2999 if filter_fn(*def) {
3000 names.push(ident.name);
3004 if let ModuleRibKind(module) = rib.kind {
3005 // Items from this module
3006 add_module_candidates(module, &mut names);
3008 if let ModuleKind::Block(..) = module.kind {
3009 // We can see through blocks
3011 // Items from the prelude
3012 if let Some(prelude) = self.prelude {
3013 if !module.no_implicit_prelude {
3014 add_module_candidates(prelude, &mut names);
3021 // Add primitive types to the mix
3022 if filter_fn(Def::PrimTy(TyBool)) {
3023 for (name, _) in &self.primitive_type_table.primitive_types {
3028 // Search in module.
3029 let mod_path = &path[..path.len() - 1];
3030 if let PathResult::Module(module) = self.resolve_path(mod_path, Some(TypeNS),
3032 add_module_candidates(module, &mut names);
3036 let name = path[path.len() - 1].name;
3037 // Make sure error reporting is deterministic.
3038 names.sort_by_key(|name| name.as_str());
3039 match find_best_match_for_name(names.iter(), &name.as_str(), None) {
3040 Some(found) if found != name => Some(found),
3045 fn with_resolved_label<F>(&mut self, label: Option<SpannedIdent>, id: NodeId, f: F)
3046 where F: FnOnce(&mut Resolver)
3048 if let Some(label) = label {
3049 let def = Def::Label(id);
3050 self.with_label_rib(|this| {
3051 this.label_ribs.last_mut().unwrap().bindings.insert(label.node, def);
3059 fn resolve_labeled_block(&mut self, label: Option<SpannedIdent>, id: NodeId, block: &Block) {
3060 self.with_resolved_label(label, id, |this| this.visit_block(block));
3063 fn resolve_expr(&mut self, expr: &Expr, parent: Option<&Expr>) {
3064 // First, record candidate traits for this expression if it could
3065 // result in the invocation of a method call.
3067 self.record_candidate_traits_for_expr_if_necessary(expr);
3069 // Next, resolve the node.
3071 ExprKind::Path(ref qself, ref path) => {
3072 self.smart_resolve_path(expr.id, qself.as_ref(), path, PathSource::Expr(parent));
3073 visit::walk_expr(self, expr);
3076 ExprKind::Struct(ref path, ..) => {
3077 self.smart_resolve_path(expr.id, None, path, PathSource::Struct);
3078 visit::walk_expr(self, expr);
3081 ExprKind::Break(Some(label), _) | ExprKind::Continue(Some(label)) => {
3082 match self.search_label(label.node) {
3084 self.record_def(expr.id, err_path_resolution());
3087 ResolutionError::UndeclaredLabel(&label.node.name.as_str()));
3089 Some(def @ Def::Label(_)) => {
3090 // Since this def is a label, it is never read.
3091 self.record_def(expr.id, PathResolution::new(def));
3094 span_bug!(expr.span, "label wasn't mapped to a label def!");
3098 // visit `break` argument if any
3099 visit::walk_expr(self, expr);
3102 ExprKind::IfLet(ref pattern, ref subexpression, ref if_block, ref optional_else) => {
3103 self.visit_expr(subexpression);
3105 self.ribs[ValueNS].push(Rib::new(NormalRibKind));
3106 self.resolve_pattern(pattern, PatternSource::IfLet, &mut FxHashMap());
3107 self.visit_block(if_block);
3108 self.ribs[ValueNS].pop();
3110 optional_else.as_ref().map(|expr| self.visit_expr(expr));
3113 ExprKind::Loop(ref block, label) => self.resolve_labeled_block(label, expr.id, &block),
3115 ExprKind::While(ref subexpression, ref block, label) => {
3116 self.with_resolved_label(label, expr.id, |this| {
3117 this.visit_expr(subexpression);
3118 this.visit_block(block);
3122 ExprKind::WhileLet(ref pattern, ref subexpression, ref block, label) => {
3123 self.with_resolved_label(label, expr.id, |this| {
3124 this.visit_expr(subexpression);
3125 this.ribs[ValueNS].push(Rib::new(NormalRibKind));
3126 this.resolve_pattern(pattern, PatternSource::WhileLet, &mut FxHashMap());
3127 this.visit_block(block);
3128 this.ribs[ValueNS].pop();
3132 ExprKind::ForLoop(ref pattern, ref subexpression, ref block, label) => {
3133 self.visit_expr(subexpression);
3134 self.ribs[ValueNS].push(Rib::new(NormalRibKind));
3135 self.resolve_pattern(pattern, PatternSource::For, &mut FxHashMap());
3137 self.resolve_labeled_block(label, expr.id, block);
3139 self.ribs[ValueNS].pop();
3142 // Equivalent to `visit::walk_expr` + passing some context to children.
3143 ExprKind::Field(ref subexpression, _) => {
3144 self.resolve_expr(subexpression, Some(expr));
3146 ExprKind::MethodCall(_, ref types, ref arguments) => {
3147 let mut arguments = arguments.iter();
3148 self.resolve_expr(arguments.next().unwrap(), Some(expr));
3149 for argument in arguments {
3150 self.resolve_expr(argument, None);
3152 for ty in types.iter() {
3157 ExprKind::Repeat(ref element, ref count) => {
3158 self.visit_expr(element);
3159 self.with_constant_rib(|this| {
3160 this.visit_expr(count);
3163 ExprKind::Call(ref callee, ref arguments) => {
3164 self.resolve_expr(callee, Some(expr));
3165 for argument in arguments {
3166 self.resolve_expr(argument, None);
3171 visit::walk_expr(self, expr);
3176 fn record_candidate_traits_for_expr_if_necessary(&mut self, expr: &Expr) {
3178 ExprKind::Field(_, name) => {
3179 // FIXME(#6890): Even though you can't treat a method like a
3180 // field, we need to add any trait methods we find that match
3181 // the field name so that we can do some nice error reporting
3182 // later on in typeck.
3183 let traits = self.get_traits_containing_item(name.node, ValueNS);
3184 self.trait_map.insert(expr.id, traits);
3186 ExprKind::MethodCall(name, ..) => {
3187 debug!("(recording candidate traits for expr) recording traits for {}",
3189 let traits = self.get_traits_containing_item(name.node, ValueNS);
3190 self.trait_map.insert(expr.id, traits);
3198 fn get_traits_containing_item(&mut self, mut ident: Ident, ns: Namespace)
3199 -> Vec<TraitCandidate> {
3200 debug!("(getting traits containing item) looking for '{}'", ident.name);
3202 let mut found_traits = Vec::new();
3203 // Look for the current trait.
3204 if let Some((module, _)) = self.current_trait_ref {
3205 if self.resolve_ident_in_module(module, ident, ns, false, false, module.span).is_ok() {
3206 let def_id = module.def_id().unwrap();
3207 found_traits.push(TraitCandidate { def_id: def_id, import_id: None });
3211 ident.ctxt = ident.ctxt.modern();
3212 let mut search_module = self.current_module;
3214 self.get_traits_in_module_containing_item(ident, ns, search_module, &mut found_traits);
3216 unwrap_or!(self.hygienic_lexical_parent(search_module, &mut ident.ctxt), break);
3219 if let Some(prelude) = self.prelude {
3220 if !search_module.no_implicit_prelude {
3221 self.get_traits_in_module_containing_item(ident, ns, prelude, &mut found_traits);
3228 fn get_traits_in_module_containing_item(&mut self,
3232 found_traits: &mut Vec<TraitCandidate>) {
3233 let mut traits = module.traits.borrow_mut();
3234 if traits.is_none() {
3235 let mut collected_traits = Vec::new();
3236 module.for_each_child(|name, ns, binding| {
3237 if ns != TypeNS { return }
3238 if let Def::Trait(_) = binding.def() {
3239 collected_traits.push((name, binding));
3242 *traits = Some(collected_traits.into_boxed_slice());
3245 for &(trait_name, binding) in traits.as_ref().unwrap().iter() {
3246 let module = binding.module().unwrap();
3247 let mut ident = ident;
3248 if ident.ctxt.glob_adjust(module.expansion, binding.span.ctxt.modern()).is_none() {
3251 if self.resolve_ident_in_module_unadjusted(module, ident, ns, false, false, module.span)
3253 let import_id = match binding.kind {
3254 NameBindingKind::Import { directive, .. } => {
3255 self.maybe_unused_trait_imports.insert(directive.id);
3256 self.add_to_glob_map(directive.id, trait_name);
3261 let trait_def_id = module.def_id().unwrap();
3262 found_traits.push(TraitCandidate { def_id: trait_def_id, import_id: import_id });
3267 /// When name resolution fails, this method can be used to look up candidate
3268 /// entities with the expected name. It allows filtering them using the
3269 /// supplied predicate (which should be used to only accept the types of
3270 /// definitions expected e.g. traits). The lookup spans across all crates.
3272 /// NOTE: The method does not look into imports, but this is not a problem,
3273 /// since we report the definitions (thus, the de-aliased imports).
3274 fn lookup_import_candidates<FilterFn>(&mut self,
3276 namespace: Namespace,
3277 filter_fn: FilterFn)
3278 -> Vec<ImportSuggestion>
3279 where FilterFn: Fn(Def) -> bool
3281 let mut candidates = Vec::new();
3282 let mut worklist = Vec::new();
3283 let mut seen_modules = FxHashSet();
3284 worklist.push((self.graph_root, Vec::new(), false));
3286 while let Some((in_module,
3288 in_module_is_extern)) = worklist.pop() {
3289 self.populate_module_if_necessary(in_module);
3291 in_module.for_each_child(|ident, ns, name_binding| {
3293 // avoid imports entirely
3294 if name_binding.is_import() && !name_binding.is_extern_crate() { return; }
3295 // avoid non-importable candidates as well
3296 if !name_binding.is_importable() { return; }
3298 // collect results based on the filter function
3299 if ident.name == lookup_name && ns == namespace {
3300 if filter_fn(name_binding.def()) {
3302 let mut segms = path_segments.clone();
3303 segms.push(ast::PathSegment::from_ident(ident, name_binding.span));
3305 span: name_binding.span,
3308 // the entity is accessible in the following cases:
3309 // 1. if it's defined in the same crate, it's always
3310 // accessible (since private entities can be made public)
3311 // 2. if it's defined in another crate, it's accessible
3312 // only if both the module is public and the entity is
3313 // declared as public (due to pruning, we don't explore
3314 // outside crate private modules => no need to check this)
3315 if !in_module_is_extern || name_binding.vis == ty::Visibility::Public {
3316 candidates.push(ImportSuggestion { path: path });
3321 // collect submodules to explore
3322 if let Some(module) = name_binding.module() {
3324 let mut path_segments = path_segments.clone();
3325 path_segments.push(ast::PathSegment::from_ident(ident, name_binding.span));
3327 if !in_module_is_extern || name_binding.vis == ty::Visibility::Public {
3328 // add the module to the lookup
3329 let is_extern = in_module_is_extern || name_binding.is_extern_crate();
3330 if seen_modules.insert(module.def_id().unwrap()) {
3331 worklist.push((module, path_segments, is_extern));
3341 fn record_def(&mut self, node_id: NodeId, resolution: PathResolution) {
3342 debug!("(recording def) recording {:?} for {}", resolution, node_id);
3343 if let Some(prev_res) = self.def_map.insert(node_id, resolution) {
3344 panic!("path resolved multiple times ({:?} before, {:?} now)", prev_res, resolution);
3348 fn resolve_visibility(&mut self, vis: &ast::Visibility) -> ty::Visibility {
3350 ast::Visibility::Public => ty::Visibility::Public,
3351 ast::Visibility::Crate(..) => ty::Visibility::Restricted(DefId::local(CRATE_DEF_INDEX)),
3352 ast::Visibility::Inherited => {
3353 ty::Visibility::Restricted(self.current_module.normal_ancestor_id)
3355 ast::Visibility::Restricted { ref path, id } => {
3356 let def = self.smart_resolve_path(id, None, path,
3357 PathSource::Visibility).base_def();
3358 if def == Def::Err {
3359 ty::Visibility::Public
3361 let vis = ty::Visibility::Restricted(def.def_id());
3362 if self.is_accessible(vis) {
3365 self.session.span_err(path.span, "visibilities can only be restricted \
3366 to ancestor modules");
3367 ty::Visibility::Public
3374 fn is_accessible(&self, vis: ty::Visibility) -> bool {
3375 vis.is_accessible_from(self.current_module.normal_ancestor_id, self)
3378 fn is_accessible_from(&self, vis: ty::Visibility, module: Module<'a>) -> bool {
3379 vis.is_accessible_from(module.normal_ancestor_id, self)
3382 fn report_errors(&mut self) {
3383 self.report_shadowing_errors();
3384 let mut reported_spans = FxHashSet();
3386 for &AmbiguityError { span, name, b1, b2, lexical, legacy } in &self.ambiguity_errors {
3387 if !reported_spans.insert(span) { continue }
3388 let participle = |binding: &NameBinding| {
3389 if binding.is_import() { "imported" } else { "defined" }
3391 let msg1 = format!("`{}` could refer to the name {} here", name, participle(b1));
3392 let msg2 = format!("`{}` could also refer to the name {} here", name, participle(b2));
3393 let note = if b1.expansion == Mark::root() || !lexical && b1.is_glob_import() {
3394 format!("consider adding an explicit import of `{}` to disambiguate", name)
3395 } else if let Def::Macro(..) = b1.def() {
3396 format!("macro-expanded {} do not shadow",
3397 if b1.is_import() { "macro imports" } else { "macros" })
3399 format!("macro-expanded {} do not shadow when used in a macro invocation path",
3400 if b1.is_import() { "imports" } else { "items" })
3403 let id = match b2.kind {
3404 NameBindingKind::Import { directive, .. } => directive.id,
3405 _ => unreachable!(),
3407 let mut span = MultiSpan::from_span(span);
3408 span.push_span_label(b1.span, msg1);
3409 span.push_span_label(b2.span, msg2);
3410 let msg = format!("`{}` is ambiguous", name);
3411 self.session.add_lint(lint::builtin::LEGACY_IMPORTS, id, span, msg);
3414 self.session.struct_span_err(span, &format!("`{}` is ambiguous", name));
3415 err.span_note(b1.span, &msg1);
3417 Def::Macro(..) if b2.span == DUMMY_SP =>
3418 err.note(&format!("`{}` is also a builtin macro", name)),
3419 _ => err.span_note(b2.span, &msg2),
3421 err.note(¬e).emit();
3425 for &PrivacyError(span, name, binding) in &self.privacy_errors {
3426 if !reported_spans.insert(span) { continue }
3427 if binding.is_extern_crate() {
3428 // Warn when using an inaccessible extern crate.
3429 let node_id = match binding.kind {
3430 NameBindingKind::Import { directive, .. } => directive.id,
3431 _ => unreachable!(),
3433 let msg = format!("extern crate `{}` is private", name);
3434 self.session.add_lint(lint::builtin::INACCESSIBLE_EXTERN_CRATE, node_id, span, msg);
3436 let def = binding.def();
3437 self.session.span_err(span, &format!("{} `{}` is private", def.kind_name(), name));
3442 fn report_shadowing_errors(&mut self) {
3443 for (ident, scope) in replace(&mut self.lexical_macro_resolutions, Vec::new()) {
3444 self.resolve_legacy_scope(scope, ident, true);
3447 let mut reported_errors = FxHashSet();
3448 for binding in replace(&mut self.disallowed_shadowing, Vec::new()) {
3449 if self.resolve_legacy_scope(&binding.parent, binding.ident, false).is_some() &&
3450 reported_errors.insert((binding.ident, binding.span)) {
3451 let msg = format!("`{}` is already in scope", binding.ident);
3452 self.session.struct_span_err(binding.span, &msg)
3453 .note("macro-expanded `macro_rules!`s may not shadow \
3454 existing macros (see RFC 1560)")
3460 fn report_conflict(&mut self,
3464 binding: &NameBinding,
3465 old_binding: &NameBinding) {
3466 // Error on the second of two conflicting names
3467 if old_binding.span.lo > binding.span.lo {
3468 return self.report_conflict(parent, ident, ns, old_binding, binding);
3471 let container = match parent.kind {
3472 ModuleKind::Def(Def::Mod(_), _) => "module",
3473 ModuleKind::Def(Def::Trait(_), _) => "trait",
3474 ModuleKind::Block(..) => "block",
3478 let (participle, noun) = match old_binding.is_import() {
3479 true => ("imported", "import"),
3480 false => ("defined", "definition"),
3483 let (name, span) = (ident.name, binding.span);
3485 if let Some(s) = self.name_already_seen.get(&name) {
3492 let kind = match (ns, old_binding.module()) {
3493 (ValueNS, _) => "a value",
3494 (MacroNS, _) => "a macro",
3495 (TypeNS, _) if old_binding.is_extern_crate() => "an extern crate",
3496 (TypeNS, Some(module)) if module.is_normal() => "a module",
3497 (TypeNS, Some(module)) if module.is_trait() => "a trait",
3498 (TypeNS, _) => "a type",
3500 format!("{} named `{}` has already been {} in this {}",
3501 kind, name, participle, container)
3504 let mut err = match (old_binding.is_extern_crate(), binding.is_extern_crate()) {
3505 (true, true) => struct_span_err!(self.session, span, E0259, "{}", msg),
3506 (true, _) | (_, true) => match binding.is_import() && old_binding.is_import() {
3507 true => struct_span_err!(self.session, span, E0254, "{}", msg),
3508 false => struct_span_err!(self.session, span, E0260, "{}", msg),
3510 _ => match (old_binding.is_import(), binding.is_import()) {
3511 (false, false) => struct_span_err!(self.session, span, E0428, "{}", msg),
3512 (true, true) => struct_span_err!(self.session, span, E0252, "{}", msg),
3513 _ => struct_span_err!(self.session, span, E0255, "{}", msg),
3517 err.span_label(span, format!("`{}` already {}", name, participle));
3518 if old_binding.span != syntax_pos::DUMMY_SP {
3519 err.span_label(old_binding.span, format!("previous {} of `{}` here", noun, name));
3522 self.name_already_seen.insert(name, span);
3525 fn warn_legacy_self_import(&self, directive: &'a ImportDirective<'a>) {
3526 let (id, span) = (directive.id, directive.span);
3527 let msg = "`self` no longer imports values".to_string();
3528 self.session.add_lint(lint::builtin::LEGACY_IMPORTS, id, span, msg);
3531 fn check_proc_macro_attrs(&mut self, attrs: &[ast::Attribute]) {
3532 if self.proc_macro_enabled { return; }
3535 if attr.path.segments.len() > 1 {
3538 let ident = attr.path.segments[0].identifier;
3539 let result = self.resolve_lexical_macro_path_segment(ident,
3543 if let Ok(binding) = result {
3544 if let SyntaxExtension::AttrProcMacro(..) = *binding.binding().get_macro(self) {
3545 attr::mark_known(attr);
3547 let msg = "attribute procedural macros are experimental";
3548 let feature = "proc_macro";
3550 feature_err(&self.session.parse_sess, feature,
3551 attr.span, GateIssue::Language, msg)
3552 .span_note(binding.span(), "procedural macro imported here")
3560 fn is_struct_like(def: Def) -> bool {
3562 Def::VariantCtor(_, CtorKind::Fictive) => true,
3563 _ => PathSource::Struct.is_expected(def),
3567 fn is_self_type(path: &[Ident], namespace: Namespace) -> bool {
3568 namespace == TypeNS && path.len() == 1 && path[0].name == keywords::SelfType.name()
3571 fn is_self_value(path: &[Ident], namespace: Namespace) -> bool {
3572 namespace == ValueNS && path.len() == 1 && path[0].name == keywords::SelfValue.name()
3575 fn names_to_string(idents: &[Ident]) -> String {
3576 let mut result = String::new();
3577 for (i, ident) in idents.iter().filter(|i| i.name != keywords::CrateRoot.name()).enumerate() {
3579 result.push_str("::");
3581 result.push_str(&ident.name.as_str());
3586 fn path_names_to_string(path: &Path) -> String {
3587 names_to_string(&path.segments.iter().map(|seg| seg.identifier).collect::<Vec<_>>())
3590 /// Get the path for an enum and the variant from an `ImportSuggestion` for an enum variant.
3591 fn import_candidate_to_paths(suggestion: &ImportSuggestion) -> (Span, String, String) {
3592 let variant_path = &suggestion.path;
3593 let variant_path_string = path_names_to_string(variant_path);
3595 let path_len = suggestion.path.segments.len();
3596 let enum_path = ast::Path {
3597 span: suggestion.path.span,
3598 segments: suggestion.path.segments[0..path_len - 1].to_vec(),
3600 let enum_path_string = path_names_to_string(&enum_path);
3602 (suggestion.path.span, variant_path_string, enum_path_string)
3606 /// When an entity with a given name is not available in scope, we search for
3607 /// entities with that name in all crates. This method allows outputting the
3608 /// results of this search in a programmer-friendly way
3609 fn show_candidates(err: &mut DiagnosticBuilder,
3611 candidates: &[ImportSuggestion],
3614 // we want consistent results across executions, but candidates are produced
3615 // by iterating through a hash map, so make sure they are ordered:
3616 let mut path_strings: Vec<_> =
3617 candidates.into_iter().map(|c| path_names_to_string(&c.path)).collect();
3618 path_strings.sort();
3620 let better = if better { "better " } else { "" };
3621 let msg_diff = match path_strings.len() {
3622 1 => " is found in another module, you can import it",
3623 _ => "s are found in other modules, you can import them",
3625 let msg = format!("possible {}candidate{} into scope", better, msg_diff);
3627 for candidate in &mut path_strings {
3628 *candidate = format!("use {};\n", candidate);
3631 err.span_suggestions(span, &msg, path_strings);
3634 /// A somewhat inefficient routine to obtain the name of a module.
3635 fn module_to_string(module: Module) -> String {
3636 let mut names = Vec::new();
3638 fn collect_mod(names: &mut Vec<Ident>, module: Module) {
3639 if let ModuleKind::Def(_, name) = module.kind {
3640 if let Some(parent) = module.parent {
3641 names.push(Ident::with_empty_ctxt(name));
3642 collect_mod(names, parent);
3645 // danger, shouldn't be ident?
3646 names.push(Ident::from_str("<opaque>"));
3647 collect_mod(names, module.parent.unwrap());
3650 collect_mod(&mut names, module);
3652 if names.is_empty() {
3653 return "???".to_string();
3655 names_to_string(&names.into_iter().rev().collect::<Vec<_>>())
3658 fn err_path_resolution() -> PathResolution {
3659 PathResolution::new(Def::Err)
3662 #[derive(PartialEq,Copy, Clone)]
3663 pub enum MakeGlobMap {
3668 __build_diagnostic_array! { librustc_resolve, DIAGNOSTICS }