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
  14 use syntax::ast::*;
  15 use syntax::ext::hygiene::Mark;
  16 use syntax::visit;
  17 use syntax::symbol::keywords;
  18 use syntax::symbol::Symbol;
  19
  20 use hir::map::{ITEM_LIKE_SPACE, REGULAR_SPACE};
  21
  22 /// Creates def ids for nodes in the AST.
  23 pub struct DefCollector<'a> {
  24     definitions: &'a mut Definitions,
  25     parent_def: Option<DefIndex>,
  26     expansion: Mark,
  27     pub visit_macro_invoc: Option<&'a mut FnMut(MacroInvocationData)>,
  28 }
  29
  30 pub struct MacroInvocationData {
  31     pub mark: Mark,
  32     pub def_index: DefIndex,
  33     pub const_expr: bool,
  34 }
  35
  36 impl<'a> DefCollector<'a> {
  37     pub fn new(definitions: &'a mut Definitions, expansion: Mark) -> Self {
  38         DefCollector {
  39             definitions,
  40             expansion,
  41             parent_def: None,
  42             visit_macro_invoc: None,
  43         }
  44     }
  45
  46     pub fn collect_root(&mut self, crate_name: &str, crate_disambiguator: &str) {
  47         let root = self.definitions.create_root_def(crate_name,
  48                                                     crate_disambiguator);
  49         assert_eq!(root, CRATE_DEF_INDEX);
  50         self.parent_def = Some(root);
  51     }
  52
  53     fn create_def(&mut self,
  54                   node_id: NodeId,
  55                   data: DefPathData,
  56                   address_space: DefIndexAddressSpace)
  57                   -> DefIndex {
  58         let parent_def = self.parent_def.unwrap();
  59         debug!("create_def(node_id={:?}, data={:?}, parent_def={:?})", node_id, data, parent_def);
  60         self.definitions
  61             .create_def_with_parent(parent_def, node_id, data, address_space, self.expansion)
  62     }
  63
  64     pub fn with_parent<F: FnOnce(&mut Self)>(&mut self, parent_def: DefIndex, f: F) {
  65         let parent = self.parent_def;
  66         self.parent_def = Some(parent_def);
  67         f(self);
  68         self.parent_def = parent;
  69     }
  70
  71     pub fn visit_const_expr(&mut self, expr: &Expr) {
  72         match expr.node {
  73             // Find the node which will be used after lowering.
  74             ExprKind::Paren(ref inner) => return self.visit_const_expr(inner),
  75             ExprKind::Mac(..) => return self.visit_macro_invoc(expr.id, true),
  76             // FIXME(eddyb) Closures should have separate
  77             // function definition IDs and expression IDs.
  78             ExprKind::Closure(..) => return,
  79             _ => {}
  80         }
  81
  82         self.create_def(expr.id, DefPathData::Initializer, REGULAR_SPACE);
  83     }
  84
  85     fn visit_macro_invoc(&mut self, id: NodeId, const_expr: bool) {
  86         if let Some(ref mut visit) = self.visit_macro_invoc {
  87             visit(MacroInvocationData {
  88                 mark: id.placeholder_to_mark(),
  89                 const_expr,
  90                 def_index: self.parent_def.unwrap(),
  91             })
  92         }
  93     }
  94 }
  95
  96 impl<'a> visit::Visitor<'a> for DefCollector<'a> {
  97     fn visit_item(&mut self, i: &'a Item) {
  98         debug!("visit_item: {:?}", i);
  99
 100         // Pick the def data. This need not be unique, but the more
 101         // information we encapsulate into
 102         let def_data = match i.node {
 103             ItemKind::DefaultImpl(..) | ItemKind::Impl(..) =>
 104                 DefPathData::Impl,
 105             ItemKind::Enum(..) | ItemKind::Struct(..) | ItemKind::Union(..) | ItemKind::Trait(..) |
 106             ItemKind::ExternCrate(..) | ItemKind::ForeignMod(..) | ItemKind::Ty(..) =>
 107                 DefPathData::TypeNs(i.ident.name),
 108             ItemKind::Mod(..) if i.ident == keywords::Invalid.ident() => {
 109                 return visit::walk_item(self, i);
 110             }
 111             ItemKind::Mod(..) => DefPathData::Module(i.ident.name),
 112             ItemKind::Static(..) | ItemKind::Const(..) | ItemKind::Fn(..) =>
 113                 DefPathData::ValueNs(i.ident.name),
 114             ItemKind::MacroDef(..) => DefPathData::MacroDef(i.ident.name),
 115             ItemKind::Mac(..) => return self.visit_macro_invoc(i.id, false),
 116             ItemKind::GlobalAsm(..) => DefPathData::Misc,
 117             ItemKind::Use(ref view_path) => {
 118                 match view_path.node {
 119                     ViewPathGlob(..) => {}
 120
 121                     // FIXME(eddyb) Should use the real name. Which namespace?
 122                     ViewPathSimple(..) => {}
 123                     ViewPathList(_, ref imports) => {
 124                         for import in imports {
 125                             self.create_def(import.node.id,
 126                                             DefPathData::Misc,
 127                                             ITEM_LIKE_SPACE);
 128                         }
 129                     }
 130                 }
 131                 DefPathData::Misc
 132             }
 133         };
 134         let def = self.create_def(i.id, def_data, ITEM_LIKE_SPACE);
 135
 136         self.with_parent(def, |this| {
 137             match i.node {
 138                 ItemKind::Enum(ref enum_definition, _) => {
 139                     for v in &enum_definition.variants {
 140                         let variant_def_index =
 141                             this.create_def(v.node.data.id(),
 142                                             DefPathData::EnumVariant(v.node.name.name),
 143                                             REGULAR_SPACE);
 144                         this.with_parent(variant_def_index, |this| {
 145                             for (index, field) in v.node.data.fields().iter().enumerate() {
 146                                 let name = field.ident.map(|ident| ident.name)
 147                                     .unwrap_or_else(|| Symbol::intern(&index.to_string()));
 148                                 this.create_def(field.id, DefPathData::Field(name), REGULAR_SPACE);
 149                             }
 150
 151                             if let Some(ref expr) = v.node.disr_expr {
 152                                 this.visit_const_expr(expr);
 153                             }
 154                         });
 155                     }
 156                 }
 157                 ItemKind::Struct(ref struct_def, _) | ItemKind::Union(ref struct_def, _) => {
 158                     // If this is a tuple-like struct, register the constructor.
 159                     if !struct_def.is_struct() {
 160                         this.create_def(struct_def.id(),
 161                                         DefPathData::StructCtor,
 162                                         REGULAR_SPACE);
 163                     }
 164
 165                     for (index, field) in struct_def.fields().iter().enumerate() {
 166                         let name = field.ident.map(|ident| ident.name)
 167                             .unwrap_or_else(|| Symbol::intern(&index.to_string()));
 168                         this.create_def(field.id, DefPathData::Field(name), REGULAR_SPACE);
 169                     }
 170                 }
 171                 _ => {}
 172             }
 173             visit::walk_item(this, i);
 174         });
 175     }
 176
 177     fn visit_foreign_item(&mut self, foreign_item: &'a ForeignItem) {
 178         let def = self.create_def(foreign_item.id,
 179                                   DefPathData::ValueNs(foreign_item.ident.name),
 180                                   REGULAR_SPACE);
 181
 182         self.with_parent(def, |this| {
 183             visit::walk_foreign_item(this, foreign_item);
 184         });
 185     }
 186
 187     fn visit_generics(&mut self, generics: &'a Generics) {
 188         for ty_param in generics.ty_params.iter() {
 189             self.create_def(ty_param.id,
 190                             DefPathData::TypeParam(ty_param.ident.name),
 191                             REGULAR_SPACE);
 192         }
 193
 194         visit::walk_generics(self, generics);
 195     }
 196
 197     fn visit_trait_item(&mut self, ti: &'a TraitItem) {
 198         let def_data = match ti.node {
 199             TraitItemKind::Method(..) | TraitItemKind::Const(..) =>
 200                 DefPathData::ValueNs(ti.ident.name),
 201             TraitItemKind::Type(..) => DefPathData::TypeNs(ti.ident.name),
 202             TraitItemKind::Macro(..) => return self.visit_macro_invoc(ti.id, false),
 203         };
 204
 205         let def = self.create_def(ti.id, def_data, ITEM_LIKE_SPACE);
 206         self.with_parent(def, |this| {
 207             if let TraitItemKind::Const(_, Some(ref expr)) = ti.node {
 208                 this.visit_const_expr(expr);
 209             }
 210
 211             visit::walk_trait_item(this, ti);
 212         });
 213     }
 214
 215     fn visit_impl_item(&mut self, ii: &'a ImplItem) {
 216         let def_data = match ii.node {
 217             ImplItemKind::Method(..) | ImplItemKind::Const(..) =>
 218                 DefPathData::ValueNs(ii.ident.name),
 219             ImplItemKind::Type(..) => DefPathData::TypeNs(ii.ident.name),
 220             ImplItemKind::Macro(..) => return self.visit_macro_invoc(ii.id, false),
 221         };
 222
 223         let def = self.create_def(ii.id, def_data, ITEM_LIKE_SPACE);
 224         self.with_parent(def, |this| {
 225             if let ImplItemKind::Const(_, ref expr) = ii.node {
 226                 this.visit_const_expr(expr);
 227             }
 228
 229             visit::walk_impl_item(this, ii);
 230         });
 231     }
 232
 233     fn visit_pat(&mut self, pat: &'a Pat) {
 234         let parent_def = self.parent_def;
 235
 236         match pat.node {
 237             PatKind::Mac(..) => return self.visit_macro_invoc(pat.id, false),
 238             PatKind::Ident(_, id, _) => {
 239                 let def = self.create_def(pat.id,
 240                                           DefPathData::Binding(id.node.name),
 241                                           REGULAR_SPACE);
 242                 self.parent_def = Some(def);
 243             }
 244             _ => {}
 245         }
 246
 247         visit::walk_pat(self, pat);
 248         self.parent_def = parent_def;
 249     }
 250
 251     fn visit_expr(&mut self, expr: &'a Expr) {
 252         let parent_def = self.parent_def;
 253
 254         match expr.node {
 255             ExprKind::Mac(..) => return self.visit_macro_invoc(expr.id, false),
 256             ExprKind::Repeat(_, ref count) => self.visit_const_expr(count),
 257             ExprKind::Closure(..) => {
 258                 let def = self.create_def(expr.id,
 259                                           DefPathData::ClosureExpr,
 260                                           REGULAR_SPACE);
 261                 self.parent_def = Some(def);
 262             }
 263             _ => {}
 264         }
 265
 266         visit::walk_expr(self, expr);
 267         self.parent_def = parent_def;
 268     }
 269
 270     fn visit_ty(&mut self, ty: &'a Ty) {
 271         match ty.node {
 272             TyKind::Mac(..) => return self.visit_macro_invoc(ty.id, false),
 273             TyKind::Array(_, ref length) => self.visit_const_expr(length),
 274             TyKind::ImplTrait(..) => {
 275                 self.create_def(ty.id, DefPathData::ImplTrait, REGULAR_SPACE);
 276             }
 277             TyKind::Typeof(ref expr) => self.visit_const_expr(expr),
 278             _ => {}
 279         }
 280         visit::walk_ty(self, ty);
 281     }
 282
 283     fn visit_lifetime_def(&mut self, def: &'a LifetimeDef) {
 284         self.create_def(def.lifetime.id,
 285                         DefPathData::LifetimeDef(def.lifetime.ident.name),
 286                         REGULAR_SPACE);
 287     }
 288
 289     fn visit_stmt(&mut self, stmt: &'a Stmt) {
 290         match stmt.node {
 291             StmtKind::Mac(..) => self.visit_macro_invoc(stmt.id, false),
 292             _ => visit::walk_stmt(self, stmt),
 293         }
 294     }
 295 }