compiler/rustc_resolve/src/def_collector.rs

   1 use crate::{ImplTraitContext, Resolver};
   2 use rustc_ast::visit::{self, FnKind};
   3 use rustc_ast::*;
   4 use rustc_expand::expand::AstFragment;
   5 use rustc_hir::def_id::LocalDefId;
   6 use rustc_hir::definitions::*;
   7 use rustc_span::hygiene::LocalExpnId;
   8 use rustc_span::symbol::sym;
   9 use rustc_span::Span;
  10
  11 pub(crate) fn collect_definitions(
  12     resolver: &mut Resolver<'_>,
  13     fragment: &AstFragment,
  14     expansion: LocalExpnId,
  15 ) {
  16     let (parent_def, impl_trait_context) = resolver.invocation_parents[&expansion];
  17     fragment.visit_with(&mut DefCollector { resolver, parent_def, expansion, impl_trait_context });
  18 }
  19
  20 /// Creates `DefId`s for nodes in the AST.
  21 struct DefCollector<'a, 'b> {
  22     resolver: &'a mut Resolver<'b>,
  23     parent_def: LocalDefId,
  24     impl_trait_context: ImplTraitContext,
  25     expansion: LocalExpnId,
  26 }
  27
  28 impl<'a, 'b> DefCollector<'a, 'b> {
  29     fn create_def(&mut self, node_id: NodeId, data: DefPathData, span: Span) -> LocalDefId {
  30         let parent_def = self.parent_def;
  31         debug!("create_def(node_id={:?}, data={:?}, parent_def={:?})", node_id, data, parent_def);
  32         self.resolver.create_def(
  33             parent_def,
  34             node_id,
  35             data,
  36             self.expansion.to_expn_id(),
  37             span.with_parent(None),
  38         )
  39     }
  40
  41     fn with_parent<F: FnOnce(&mut Self)>(&mut self, parent_def: LocalDefId, f: F) {
  42         let orig_parent_def = std::mem::replace(&mut self.parent_def, parent_def);
  43         f(self);
  44         self.parent_def = orig_parent_def;
  45     }
  46
  47     fn with_impl_trait<F: FnOnce(&mut Self)>(
  48         &mut self,
  49         impl_trait_context: ImplTraitContext,
  50         f: F,
  51     ) {
  52         let orig_itc = std::mem::replace(&mut self.impl_trait_context, impl_trait_context);
  53         f(self);
  54         self.impl_trait_context = orig_itc;
  55     }
  56
  57     fn collect_field(&mut self, field: &'a FieldDef, index: Option<usize>) {
  58         let index = |this: &Self| {
  59             index.unwrap_or_else(|| {
  60                 let node_id = NodeId::placeholder_from_expn_id(this.expansion);
  61                 this.resolver.placeholder_field_indices[&node_id]
  62             })
  63         };
  64
  65         if field.is_placeholder {
  66             let old_index = self.resolver.placeholder_field_indices.insert(field.id, index(self));
  67             assert!(old_index.is_none(), "placeholder field index is reset for a node ID");
  68             self.visit_macro_invoc(field.id);
  69         } else {
  70             let name = field.ident.map_or_else(|| sym::integer(index(self)), |ident| ident.name);
  71             let def = self.create_def(field.id, DefPathData::ValueNs(name), field.span);
  72             self.with_parent(def, |this| visit::walk_field_def(this, field));
  73         }
  74     }
  75
  76     fn visit_macro_invoc(&mut self, id: NodeId) {
  77         let id = id.placeholder_to_expn_id();
  78         let old_parent =
  79             self.resolver.invocation_parents.insert(id, (self.parent_def, self.impl_trait_context));
  80         assert!(old_parent.is_none(), "parent `LocalDefId` is reset for an invocation");
  81     }
  82 }
  83
  84 impl<'a, 'b> visit::Visitor<'a> for DefCollector<'a, 'b> {
  85     fn visit_item(&mut self, i: &'a Item) {
  86         debug!("visit_item: {:?}", i);
  87
  88         // Pick the def data. This need not be unique, but the more
  89         // information we encapsulate into, the better
  90         let def_data = match &i.kind {
  91             ItemKind::Impl { .. } => DefPathData::Impl,
  92             ItemKind::ForeignMod(..) => DefPathData::ForeignMod,
  93             ItemKind::Mod(..)
  94             | ItemKind::Trait(..)
  95             | ItemKind::TraitAlias(..)
  96             | ItemKind::Enum(..)
  97             | ItemKind::Struct(..)
  98             | ItemKind::Union(..)
  99             | ItemKind::ExternCrate(..)
 100             | ItemKind::TyAlias(..) => DefPathData::TypeNs(i.ident.name),
 101             ItemKind::Static(..) | ItemKind::Const(..) | ItemKind::Fn(..) => {
 102                 DefPathData::ValueNs(i.ident.name)
 103             }
 104             ItemKind::MacroDef(..) => DefPathData::MacroNs(i.ident.name),
 105             ItemKind::MacCall(..) => {
 106                 visit::walk_item(self, i);
 107                 return self.visit_macro_invoc(i.id);
 108             }
 109             ItemKind::GlobalAsm(..) => DefPathData::GlobalAsm,
 110             ItemKind::Use(..) => {
 111                 return visit::walk_item(self, i);
 112             }
 113         };
 114         let def = self.create_def(i.id, def_data, i.span);
 115
 116         self.with_parent(def, |this| {
 117             this.with_impl_trait(ImplTraitContext::Existential, |this| {
 118                 match i.kind {
 119                     ItemKind::Struct(ref struct_def, _) | ItemKind::Union(ref struct_def, _) => {
 120                         // If this is a unit or tuple-like struct, register the constructor.
 121                         if let Some(ctor_hir_id) = struct_def.ctor_id() {
 122                             this.create_def(ctor_hir_id, DefPathData::Ctor, i.span);
 123                         }
 124                     }
 125                     _ => {}
 126                 }
 127                 visit::walk_item(this, i);
 128             })
 129         });
 130     }
 131
 132     fn visit_fn(&mut self, fn_kind: FnKind<'a>, span: Span, _: NodeId) {
 133         if let FnKind::Fn(_, _, sig, _, generics, body) = fn_kind {
 134             if let Async::Yes { closure_id, return_impl_trait_id, .. } = sig.header.asyncness {
 135                 self.visit_generics(generics);
 136
 137                 let return_impl_trait_id =
 138                     self.create_def(return_impl_trait_id, DefPathData::ImplTrait, span);
 139
 140                 // For async functions, we need to create their inner defs inside of a
 141                 // closure to match their desugared representation. Besides that,
 142                 // we must mirror everything that `visit::walk_fn` below does.
 143                 self.visit_fn_header(&sig.header);
 144                 for param in &sig.decl.inputs {
 145                     self.visit_param(param);
 146                 }
 147                 self.with_parent(return_impl_trait_id, |this| {
 148                     this.visit_fn_ret_ty(&sig.decl.output)
 149                 });
 150                 // If this async fn has no body (i.e. it's an async fn signature in a trait)
 151                 // then the closure_def will never be used, and we should avoid generating a
 152                 // def-id for it.
 153                 if let Some(body) = body {
 154                     let closure_def = self.create_def(closure_id, DefPathData::ClosureExpr, span);
 155                     self.with_parent(closure_def, |this| this.visit_block(body));
 156                 }
 157                 return;
 158             }
 159         }
 160
 161         visit::walk_fn(self, fn_kind);
 162     }
 163
 164     fn visit_use_tree(&mut self, use_tree: &'a UseTree, id: NodeId, _nested: bool) {
 165         self.create_def(id, DefPathData::Use, use_tree.span);
 166         match use_tree.kind {
 167             UseTreeKind::Simple(_, id1, id2) => {
 168                 self.create_def(id1, DefPathData::Use, use_tree.prefix.span);
 169                 self.create_def(id2, DefPathData::Use, use_tree.prefix.span);
 170             }
 171             UseTreeKind::Glob => (),
 172             UseTreeKind::Nested(..) => {}
 173         }
 174         visit::walk_use_tree(self, use_tree, id);
 175     }
 176
 177     fn visit_foreign_item(&mut self, foreign_item: &'a ForeignItem) {
 178         if let ForeignItemKind::MacCall(_) = foreign_item.kind {
 179             return self.visit_macro_invoc(foreign_item.id);
 180         }
 181
 182         let def = self.create_def(
 183             foreign_item.id,
 184             DefPathData::ValueNs(foreign_item.ident.name),
 185             foreign_item.span,
 186         );
 187
 188         self.with_parent(def, |this| {
 189             visit::walk_foreign_item(this, foreign_item);
 190         });
 191     }
 192
 193     fn visit_variant(&mut self, v: &'a Variant) {
 194         if v.is_placeholder {
 195             return self.visit_macro_invoc(v.id);
 196         }
 197         let def = self.create_def(v.id, DefPathData::TypeNs(v.ident.name), v.span);
 198         self.with_parent(def, |this| {
 199             if let Some(ctor_hir_id) = v.data.ctor_id() {
 200                 this.create_def(ctor_hir_id, DefPathData::Ctor, v.span);
 201             }
 202             visit::walk_variant(this, v)
 203         });
 204     }
 205
 206     fn visit_variant_data(&mut self, data: &'a VariantData) {
 207         // The assumption here is that non-`cfg` macro expansion cannot change field indices.
 208         // It currently holds because only inert attributes are accepted on fields,
 209         // and every such attribute expands into a single field after it's resolved.
 210         for (index, field) in data.fields().iter().enumerate() {
 211             self.collect_field(field, Some(index));
 212         }
 213     }
 214
 215     fn visit_generic_param(&mut self, param: &'a GenericParam) {
 216         if param.is_placeholder {
 217             self.visit_macro_invoc(param.id);
 218             return;
 219         }
 220         let name = param.ident.name;
 221         let def_path_data = match param.kind {
 222             GenericParamKind::Lifetime { .. } => DefPathData::LifetimeNs(name),
 223             GenericParamKind::Type { .. } => DefPathData::TypeNs(name),
 224             GenericParamKind::Const { .. } => DefPathData::ValueNs(name),
 225         };
 226         self.create_def(param.id, def_path_data, param.ident.span);
 227
 228         // impl-Trait can happen inside generic parameters, like
 229         // ```
 230         // fn foo<U: Iterator<Item = impl Clone>>() {}
 231         // ```
 232         //
 233         // In that case, the impl-trait is lowered as an additional generic parameter.
 234         self.with_impl_trait(ImplTraitContext::Universal(self.parent_def), |this| {
 235             visit::walk_generic_param(this, param)
 236         });
 237     }
 238
 239     fn visit_assoc_item(&mut self, i: &'a AssocItem, ctxt: visit::AssocCtxt) {
 240         let def_data = match &i.kind {
 241             AssocItemKind::Fn(..) | AssocItemKind::Const(..) => DefPathData::ValueNs(i.ident.name),
 242             AssocItemKind::Type(..) => DefPathData::TypeNs(i.ident.name),
 243             AssocItemKind::MacCall(..) => return self.visit_macro_invoc(i.id),
 244         };
 245
 246         let def = self.create_def(i.id, def_data, i.span);
 247         self.with_parent(def, |this| visit::walk_assoc_item(this, i, ctxt));
 248     }
 249
 250     fn visit_pat(&mut self, pat: &'a Pat) {
 251         match pat.kind {
 252             PatKind::MacCall(..) => self.visit_macro_invoc(pat.id),
 253             _ => visit::walk_pat(self, pat),
 254         }
 255     }
 256
 257     fn visit_anon_const(&mut self, constant: &'a AnonConst) {
 258         let def = self.create_def(constant.id, DefPathData::AnonConst, constant.value.span);
 259         self.with_parent(def, |this| visit::walk_anon_const(this, constant));
 260     }
 261
 262     fn visit_expr(&mut self, expr: &'a Expr) {
 263         let parent_def = match expr.kind {
 264             ExprKind::MacCall(..) => return self.visit_macro_invoc(expr.id),
 265             ExprKind::Closure(ref closure) => {
 266                 // Async closures desugar to closures inside of closures, so
 267                 // we must create two defs.
 268                 let closure_def = self.create_def(expr.id, DefPathData::ClosureExpr, expr.span);
 269                 match closure.asyncness {
 270                     Async::Yes { closure_id, .. } => {
 271                         self.create_def(closure_id, DefPathData::ClosureExpr, expr.span)
 272                     }
 273                     Async::No => closure_def,
 274                 }
 275             }
 276             ExprKind::Async(_, async_id, _) => {
 277                 self.create_def(async_id, DefPathData::ClosureExpr, expr.span)
 278             }
 279             _ => self.parent_def,
 280         };
 281
 282         self.with_parent(parent_def, |this| visit::walk_expr(this, expr));
 283     }
 284
 285     fn visit_ty(&mut self, ty: &'a Ty) {
 286         match ty.kind {
 287             TyKind::MacCall(..) => self.visit_macro_invoc(ty.id),
 288             _ => visit::walk_ty(self, ty),
 289         }
 290     }
 291
 292     fn visit_stmt(&mut self, stmt: &'a Stmt) {
 293         match stmt.kind {
 294             StmtKind::MacCall(..) => self.visit_macro_invoc(stmt.id),
 295             _ => visit::walk_stmt(self, stmt),
 296         }
 297     }
 298
 299     fn visit_arm(&mut self, arm: &'a Arm) {
 300         if arm.is_placeholder { self.visit_macro_invoc(arm.id) } else { visit::walk_arm(self, arm) }
 301     }
 302
 303     fn visit_expr_field(&mut self, f: &'a ExprField) {
 304         if f.is_placeholder {
 305             self.visit_macro_invoc(f.id)
 306         } else {
 307             visit::walk_expr_field(self, f)
 308         }
 309     }
 310
 311     fn visit_pat_field(&mut self, fp: &'a PatField) {
 312         if fp.is_placeholder {
 313             self.visit_macro_invoc(fp.id)
 314         } else {
 315             visit::walk_pat_field(self, fp)
 316         }
 317     }
 318
 319     fn visit_param(&mut self, p: &'a Param) {
 320         if p.is_placeholder {
 321             self.visit_macro_invoc(p.id)
 322         } else {
 323             self.with_impl_trait(ImplTraitContext::Universal(self.parent_def), |this| {
 324                 visit::walk_param(this, p)
 325             })
 326         }
 327     }
 328
 329     // This method is called only when we are visiting an individual field
 330     // after expanding an attribute on it.
 331     fn visit_field_def(&mut self, field: &'a FieldDef) {
 332         self.collect_field(field, None);
 333     }
 334
 335     fn visit_crate(&mut self, krate: &'a Crate) {
 336         if krate.is_placeholder {
 337             self.visit_macro_invoc(krate.id)
 338         } else {
 339             visit::walk_crate(self, krate)
 340         }
 341     }
 342 }