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.
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 use hir::map::definitions::*;
12 use hir::def_id::{CRATE_DEF_INDEX, DefIndex};
15 use syntax::ext::hygiene::Mark;
17 use syntax::symbol::{Symbol, keywords};
19 /// Creates def ids for nodes in the HIR.
20 pub struct DefCollector<'a> {
21 definitions: &'a mut Definitions,
22 parent_def: Option<DefIndex>,
23 pub visit_macro_invoc: Option<&'a mut FnMut(MacroInvocationData)>,
26 pub struct MacroInvocationData {
28 pub def_index: DefIndex,
29 pub const_integer: bool,
32 impl<'a> DefCollector<'a> {
33 pub fn new(definitions: &'a mut Definitions) -> Self {
35 definitions: definitions,
37 visit_macro_invoc: None,
41 pub fn collect_root(&mut self) {
42 let root = self.create_def_with_parent(None, CRATE_NODE_ID, DefPathData::CrateRoot);
43 assert_eq!(root, CRATE_DEF_INDEX);
44 self.parent_def = Some(root);
47 fn create_def(&mut self, node_id: NodeId, data: DefPathData) -> DefIndex {
48 let parent_def = self.parent_def;
49 debug!("create_def(node_id={:?}, data={:?}, parent_def={:?})", node_id, data, parent_def);
50 self.definitions.create_def_with_parent(parent_def, node_id, data)
53 fn create_def_with_parent(&mut self,
54 parent: Option<DefIndex>,
58 self.definitions.create_def_with_parent(parent, node_id, data)
61 pub fn with_parent<F: FnOnce(&mut Self)>(&mut self, parent_def: DefIndex, f: F) {
62 let parent = self.parent_def;
63 self.parent_def = Some(parent_def);
65 self.parent_def = parent;
68 pub fn visit_ast_const_integer(&mut self, expr: &Expr) {
70 // Find the node which will be used after lowering.
71 ExprKind::Paren(ref inner) => return self.visit_ast_const_integer(inner),
72 ExprKind::Mac(..) => return self.visit_macro_invoc(expr.id, true),
73 // FIXME(eddyb) Closures should have separate
74 // function definition IDs and expression IDs.
75 ExprKind::Closure(..) => return,
79 self.create_def(expr.id, DefPathData::Initializer);
82 fn visit_macro_invoc(&mut self, id: NodeId, const_integer: bool) {
83 if let Some(ref mut visit) = self.visit_macro_invoc {
84 visit(MacroInvocationData {
85 mark: Mark::from_placeholder_id(id),
86 const_integer: const_integer,
87 def_index: self.parent_def.unwrap(),
93 impl<'a> visit::Visitor<'a> for DefCollector<'a> {
94 fn visit_item(&mut self, i: &'a Item) {
95 debug!("visit_item: {:?}", i);
97 // Pick the def data. This need not be unique, but the more
98 // information we encapsulate into
99 let def_data = match i.node {
100 ItemKind::DefaultImpl(..) | ItemKind::Impl(..) =>
102 ItemKind::Enum(..) | ItemKind::Struct(..) | ItemKind::Union(..) | ItemKind::Trait(..) |
103 ItemKind::ExternCrate(..) | ItemKind::ForeignMod(..) | ItemKind::Ty(..) =>
104 DefPathData::TypeNs(i.ident.name.as_str()),
105 ItemKind::Mod(..) if i.ident == keywords::Invalid.ident() => {
106 return visit::walk_item(self, i);
108 ItemKind::Mod(..) => DefPathData::Module(i.ident.name.as_str()),
109 ItemKind::Static(..) | ItemKind::Const(..) | ItemKind::Fn(..) =>
110 DefPathData::ValueNs(i.ident.name.as_str()),
111 ItemKind::Mac(..) if i.id == DUMMY_NODE_ID => return, // Scope placeholder
112 ItemKind::Mac(..) => return self.visit_macro_invoc(i.id, false),
113 ItemKind::Use(ref view_path) => {
114 match view_path.node {
115 ViewPathGlob(..) => {}
117 // FIXME(eddyb) Should use the real name. Which namespace?
118 ViewPathSimple(..) => {}
119 ViewPathList(_, ref imports) => {
120 for import in imports {
121 self.create_def(import.node.id, DefPathData::Misc);
128 let def = self.create_def(i.id, def_data);
130 self.with_parent(def, |this| {
132 ItemKind::Enum(ref enum_definition, _) => {
133 for v in &enum_definition.variants {
134 let variant_def_index =
135 this.create_def(v.node.data.id(),
136 DefPathData::EnumVariant(v.node.name.name.as_str()));
137 this.with_parent(variant_def_index, |this| {
138 for (index, field) in v.node.data.fields().iter().enumerate() {
139 let name = field.ident.map(|ident| ident.name)
140 .unwrap_or_else(|| Symbol::intern(&index.to_string()));
141 this.create_def(field.id, DefPathData::Field(name.as_str()));
144 if let Some(ref expr) = v.node.disr_expr {
145 this.visit_ast_const_integer(expr);
150 ItemKind::Struct(ref struct_def, _) | ItemKind::Union(ref struct_def, _) => {
151 // If this is a tuple-like struct, register the constructor.
152 if !struct_def.is_struct() {
153 this.create_def(struct_def.id(),
154 DefPathData::StructCtor);
157 for (index, field) in struct_def.fields().iter().enumerate() {
158 let name = field.ident.map(|ident| ident.name.as_str())
159 .unwrap_or(Symbol::intern(&index.to_string()).as_str());
160 this.create_def(field.id, DefPathData::Field(name));
165 visit::walk_item(this, i);
169 fn visit_foreign_item(&mut self, foreign_item: &'a ForeignItem) {
170 let def = self.create_def(foreign_item.id,
171 DefPathData::ValueNs(foreign_item.ident.name.as_str()));
173 self.with_parent(def, |this| {
174 visit::walk_foreign_item(this, foreign_item);
178 fn visit_generics(&mut self, generics: &'a Generics) {
179 for ty_param in generics.ty_params.iter() {
180 self.create_def(ty_param.id, DefPathData::TypeParam(ty_param.ident.name.as_str()));
183 visit::walk_generics(self, generics);
186 fn visit_trait_item(&mut self, ti: &'a TraitItem) {
187 let def_data = match ti.node {
188 TraitItemKind::Method(..) | TraitItemKind::Const(..) =>
189 DefPathData::ValueNs(ti.ident.name.as_str()),
190 TraitItemKind::Type(..) => DefPathData::TypeNs(ti.ident.name.as_str()),
191 TraitItemKind::Macro(..) => return self.visit_macro_invoc(ti.id, false),
194 let def = self.create_def(ti.id, def_data);
195 self.with_parent(def, |this| {
196 if let TraitItemKind::Const(_, Some(ref expr)) = ti.node {
197 this.create_def(expr.id, DefPathData::Initializer);
200 visit::walk_trait_item(this, ti);
204 fn visit_impl_item(&mut self, ii: &'a ImplItem) {
205 let def_data = match ii.node {
206 ImplItemKind::Method(..) | ImplItemKind::Const(..) =>
207 DefPathData::ValueNs(ii.ident.name.as_str()),
208 ImplItemKind::Type(..) => DefPathData::TypeNs(ii.ident.name.as_str()),
209 ImplItemKind::Macro(..) => return self.visit_macro_invoc(ii.id, false),
212 let def = self.create_def(ii.id, def_data);
213 self.with_parent(def, |this| {
214 if let ImplItemKind::Const(_, ref expr) = ii.node {
215 this.create_def(expr.id, DefPathData::Initializer);
218 visit::walk_impl_item(this, ii);
222 fn visit_pat(&mut self, pat: &'a Pat) {
223 let parent_def = self.parent_def;
226 PatKind::Mac(..) => return self.visit_macro_invoc(pat.id, false),
227 PatKind::Ident(_, id, _) => {
228 let def = self.create_def(pat.id, DefPathData::Binding(id.node.name.as_str()));
229 self.parent_def = Some(def);
234 visit::walk_pat(self, pat);
235 self.parent_def = parent_def;
238 fn visit_expr(&mut self, expr: &'a Expr) {
239 let parent_def = self.parent_def;
242 ExprKind::Mac(..) => return self.visit_macro_invoc(expr.id, false),
243 ExprKind::Repeat(_, ref count) => self.visit_ast_const_integer(count),
244 ExprKind::Closure(..) => {
245 let def = self.create_def(expr.id, DefPathData::ClosureExpr);
246 self.parent_def = Some(def);
251 visit::walk_expr(self, expr);
252 self.parent_def = parent_def;
255 fn visit_ty(&mut self, ty: &'a Ty) {
257 TyKind::Mac(..) => return self.visit_macro_invoc(ty.id, false),
258 TyKind::Array(_, ref length) => self.visit_ast_const_integer(length),
259 TyKind::ImplTrait(..) => {
260 self.create_def(ty.id, DefPathData::ImplTrait);
264 visit::walk_ty(self, ty);
267 fn visit_lifetime_def(&mut self, def: &'a LifetimeDef) {
268 self.create_def(def.lifetime.id, DefPathData::LifetimeDef(def.lifetime.name.as_str()));
271 fn visit_macro_def(&mut self, macro_def: &'a MacroDef) {
272 self.create_def(macro_def.id, DefPathData::MacroDef(macro_def.ident.name.as_str()));
275 fn visit_stmt(&mut self, stmt: &'a Stmt) {
277 StmtKind::Mac(..) => self.visit_macro_invoc(stmt.id, false),
278 _ => visit::walk_stmt(self, stmt),