compiler/rustc_resolve/src/def_collector.rs

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