src/librustc/hir/map/def_collector.rs

   1 // Copyright 2016 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.
   4 //
   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.
  10
  11 use hir::map::definitions::*;
  12 use hir::def_id::{CRATE_DEF_INDEX, DefIndex, DefIndexAddressSpace};
  13 use session::CrateDisambiguator;
  14
  15 use syntax::ast::*;
  16 use syntax::ext::hygiene::Mark;
  17 use syntax::visit;
  18 use syntax::symbol::keywords;
  19 use syntax::symbol::Symbol;
  20 use syntax::parse::token::{self, Token};
  21 use syntax_pos::Span;
  22
  23 use hir::map::{ITEM_LIKE_SPACE, REGULAR_SPACE};
  24
  25 /// Creates def ids for nodes in the AST.
  26 pub struct DefCollector<'a> {
  27     definitions: &'a mut Definitions,
  28     parent_def: Option<DefIndex>,
  29     expansion: Mark,
  30     pub visit_macro_invoc: Option<&'a mut dyn FnMut(MacroInvocationData)>,
  31 }
  32
  33 pub struct MacroInvocationData {
  34     pub mark: Mark,
  35     pub def_index: DefIndex,
  36 }
  37
  38 impl<'a> DefCollector<'a> {
  39     pub fn new(definitions: &'a mut Definitions, expansion: Mark) -> Self {
  40         DefCollector {
  41             definitions,
  42             expansion,
  43             parent_def: None,
  44             visit_macro_invoc: None,
  45         }
  46     }
  47
  48     pub fn collect_root(&mut self,
  49                         crate_name: &str,
  50                         crate_disambiguator: CrateDisambiguator) {
  51         let root = self.definitions.create_root_def(crate_name,
  52                                                     crate_disambiguator);
  53         assert_eq!(root, CRATE_DEF_INDEX);
  54         self.parent_def = Some(root);
  55     }
  56
  57     fn create_def(&mut self,
  58                   node_id: NodeId,
  59                   data: DefPathData,
  60                   address_space: DefIndexAddressSpace,
  61                   span: Span)
  62                   -> DefIndex {
  63         let parent_def = self.parent_def.unwrap();
  64         debug!("create_def(node_id={:?}, data={:?}, parent_def={:?})", node_id, data, parent_def);
  65         self.definitions
  66             .create_def_with_parent(parent_def, node_id, data, address_space, self.expansion, span)
  67     }
  68
  69     pub fn with_parent<F: FnOnce(&mut Self)>(&mut self, parent_def: DefIndex, f: F) {
  70         let parent = self.parent_def;
  71         self.parent_def = Some(parent_def);
  72         f(self);
  73         self.parent_def = parent;
  74     }
  75
  76     fn visit_macro_invoc(&mut self, id: NodeId) {
  77         if let Some(ref mut visit) = self.visit_macro_invoc {
  78             visit(MacroInvocationData {
  79                 mark: id.placeholder_to_mark(),
  80                 def_index: self.parent_def.unwrap(),
  81             })
  82         }
  83     }
  84 }
  85
  86 impl<'a> visit::Visitor<'a> for DefCollector<'a> {
  87     fn visit_item(&mut self, i: &'a Item) {
  88         debug!("visit_item: {:?}", i);
  89
  90         // Pick the def data. This need not be unique, but the more
  91         // information we encapsulate into, the better
  92         let def_data = match i.node {
  93             ItemKind::Impl(..) => DefPathData::Impl,
  94             ItemKind::Trait(..) => DefPathData::Trait(i.ident.name.as_interned_str()),
  95             ItemKind::Enum(..) | ItemKind::Struct(..) | ItemKind::Union(..) |
  96             ItemKind::TraitAlias(..) |
  97             ItemKind::ExternCrate(..) | ItemKind::ForeignMod(..) | ItemKind::Ty(..) =>
  98                 DefPathData::TypeNs(i.ident.name.as_interned_str()),
  99             ItemKind::Mod(..) if i.ident == keywords::Invalid.ident() => {
 100                 return visit::walk_item(self, i);
 101             }
 102             ItemKind::Fn(_, FnHeader { asyncness: IsAsync::Async(async_node_id), .. }, ..) => {
 103                 // For async functions, we need to create their inner defs inside of a
 104                 // closure to match their desugared representation.
 105                 let fn_def_data = DefPathData::ValueNs(i.ident.name.as_interned_str());
 106                 let fn_def = self.create_def(i.id, fn_def_data, ITEM_LIKE_SPACE, i.span);
 107                 return self.with_parent(fn_def, |this| {
 108                     let closure_def = this.create_def(async_node_id,
 109                                           DefPathData::ClosureExpr,
 110                                           REGULAR_SPACE,
 111                                           i.span);
 112                     this.with_parent(closure_def, |this| {
 113                         visit::walk_item(this, i);
 114                     })
 115                 });
 116             }
 117             ItemKind::Mod(..) => DefPathData::Module(i.ident.name.as_interned_str()),
 118             ItemKind::Static(..) | ItemKind::Const(..) | ItemKind::Fn(..) =>
 119                 DefPathData::ValueNs(i.ident.name.as_interned_str()),
 120             ItemKind::MacroDef(..) => DefPathData::MacroDef(i.ident.name.as_interned_str()),
 121             ItemKind::Mac(..) => return self.visit_macro_invoc(i.id),
 122             ItemKind::GlobalAsm(..) => DefPathData::Misc,
 123             ItemKind::Use(..) => {
 124                 return visit::walk_item(self, i);
 125             }
 126         };
 127         let def = self.create_def(i.id, def_data, ITEM_LIKE_SPACE, i.span);
 128
 129         self.with_parent(def, |this| {
 130             match i.node {
 131                 ItemKind::Struct(ref struct_def, _) | ItemKind::Union(ref struct_def, _) => {
 132                     // If this is a tuple-like struct, register the constructor.
 133                     if !struct_def.is_struct() {
 134                         this.create_def(struct_def.id(),
 135                                         DefPathData::StructCtor,
 136                                         REGULAR_SPACE,
 137                                         i.span);
 138                     }
 139                 }
 140                 _ => {}
 141             }
 142             visit::walk_item(this, i);
 143         });
 144     }
 145
 146     fn visit_use_tree(&mut self, use_tree: &'a UseTree, id: NodeId, _nested: bool) {
 147         self.create_def(id, DefPathData::Misc, ITEM_LIKE_SPACE, use_tree.span);
 148         visit::walk_use_tree(self, use_tree, id);
 149     }
 150
 151     fn visit_foreign_item(&mut self, foreign_item: &'a ForeignItem) {
 152         if let ForeignItemKind::Macro(_) = foreign_item.node {
 153             return self.visit_macro_invoc(foreign_item.id);
 154         }
 155
 156         let def = self.create_def(foreign_item.id,
 157                                   DefPathData::ValueNs(foreign_item.ident.name.as_interned_str()),
 158                                   REGULAR_SPACE,
 159                                   foreign_item.span);
 160
 161         self.with_parent(def, |this| {
 162             visit::walk_foreign_item(this, foreign_item);
 163         });
 164     }
 165
 166     fn visit_variant(&mut self, v: &'a Variant, g: &'a Generics, item_id: NodeId) {
 167         let def = self.create_def(v.node.data.id(),
 168                                   DefPathData::EnumVariant(v.node.ident
 169                                                             .name.as_interned_str()),
 170                                   REGULAR_SPACE,
 171                                   v.span);
 172         self.with_parent(def, |this| visit::walk_variant(this, v, g, item_id));
 173     }
 174
 175     fn visit_variant_data(&mut self, data: &'a VariantData, _: Ident,
 176                           _: &'a Generics, _: NodeId, _: Span) {
 177         for (index, field) in data.fields().iter().enumerate() {
 178             let name = field.ident.map(|ident| ident.name)
 179                 .unwrap_or_else(|| Symbol::intern(&index.to_string()));
 180             let def = self.create_def(field.id,
 181                                       DefPathData::Field(name.as_interned_str()),
 182                                       REGULAR_SPACE,
 183                                       field.span);
 184             self.with_parent(def, |this| this.visit_struct_field(field));
 185         }
 186     }
 187
 188     fn visit_generic_param(&mut self, param: &'a GenericParam) {
 189         let name = param.ident.name.as_interned_str();
 190         let def_path_data = match param.kind {
 191             GenericParamKind::Lifetime { .. } => DefPathData::LifetimeParam(name),
 192             GenericParamKind::Type { .. } => DefPathData::TypeParam(name),
 193         };
 194         self.create_def(param.id, def_path_data, REGULAR_SPACE, param.ident.span);
 195
 196         visit::walk_generic_param(self, param);
 197     }
 198
 199     fn visit_trait_item(&mut self, ti: &'a TraitItem) {
 200         let def_data = match ti.node {
 201             TraitItemKind::Method(..) | TraitItemKind::Const(..) =>
 202                 DefPathData::ValueNs(ti.ident.name.as_interned_str()),
 203             TraitItemKind::Type(..) => {
 204                 DefPathData::AssocTypeInTrait(ti.ident.name.as_interned_str())
 205             },
 206             TraitItemKind::Macro(..) => return self.visit_macro_invoc(ti.id),
 207         };
 208
 209         let def = self.create_def(ti.id, def_data, ITEM_LIKE_SPACE, ti.span);
 210         self.with_parent(def, |this| visit::walk_trait_item(this, ti));
 211     }
 212
 213     fn visit_impl_item(&mut self, ii: &'a ImplItem) {
 214         let def_data = match ii.node {
 215             ImplItemKind::Method(..) | ImplItemKind::Const(..) =>
 216                 DefPathData::ValueNs(ii.ident.name.as_interned_str()),
 217             ImplItemKind::Type(..) => DefPathData::AssocTypeInImpl(ii.ident.name.as_interned_str()),
 218             ImplItemKind::Macro(..) => return self.visit_macro_invoc(ii.id),
 219         };
 220
 221         let def = self.create_def(ii.id, def_data, ITEM_LIKE_SPACE, ii.span);
 222         self.with_parent(def, |this| visit::walk_impl_item(this, ii));
 223     }
 224
 225     fn visit_pat(&mut self, pat: &'a Pat) {
 226         match pat.node {
 227             PatKind::Mac(..) => return self.visit_macro_invoc(pat.id),
 228             _ => visit::walk_pat(self, pat),
 229         }
 230     }
 231
 232     fn visit_anon_const(&mut self, constant: &'a AnonConst) {
 233         let def = self.create_def(constant.id,
 234                                   DefPathData::AnonConst,
 235                                   REGULAR_SPACE,
 236                                   constant.value.span);
 237         self.with_parent(def, |this| visit::walk_anon_const(this, constant));
 238     }
 239
 240     fn visit_expr(&mut self, expr: &'a Expr) {
 241         let parent_def = self.parent_def;
 242
 243         match expr.node {
 244             ExprKind::Mac(..) => return self.visit_macro_invoc(expr.id),
 245             ExprKind::Closure(_, asyncness, ..) => {
 246                 let closure_def = self.create_def(expr.id,
 247                                           DefPathData::ClosureExpr,
 248                                           REGULAR_SPACE,
 249                                           expr.span);
 250                 self.parent_def = Some(closure_def);
 251
 252                 // Async closures desugar to closures inside of closures, so
 253                 // we must create two defs.
 254                 if let IsAsync::Async(async_id) = asyncness {
 255                     let async_def = self.create_def(async_id,
 256                                                     DefPathData::ClosureExpr,
 257                                                     REGULAR_SPACE,
 258                                                     expr.span);
 259                     self.parent_def = Some(async_def);
 260                 }
 261             }
 262             ExprKind::Async(_, async_id, _) => {
 263                 let async_def = self.create_def(async_id,
 264                                                 DefPathData::ClosureExpr,
 265                                                 REGULAR_SPACE,
 266                                                 expr.span);
 267                 self.parent_def = Some(async_def);
 268             }
 269             _ => {}
 270         };
 271
 272         visit::walk_expr(self, expr);
 273         self.parent_def = parent_def;
 274     }
 275
 276     fn visit_ty(&mut self, ty: &'a Ty) {
 277         match ty.node {
 278             TyKind::Mac(..) => return self.visit_macro_invoc(ty.id),
 279             _ => {}
 280         }
 281         visit::walk_ty(self, ty);
 282     }
 283
 284     fn visit_stmt(&mut self, stmt: &'a Stmt) {
 285         match stmt.node {
 286             StmtKind::Mac(..) => self.visit_macro_invoc(stmt.id),
 287             _ => visit::walk_stmt(self, stmt),
 288         }
 289     }
 290
 291     fn visit_token(&mut self, t: Token) {
 292         if let Token::Interpolated(nt) = t {
 293             match nt.0 {
 294                 token::NtExpr(ref expr) => {
 295                     if let ExprKind::Mac(..) = expr.node {
 296                         self.visit_macro_invoc(expr.id);
 297                     }
 298                 }
 299                 _ => {}
 300             }
 301         }
 302     }
 303 }