1 use crate::hir::map::definitions::*;
2 use crate::hir::def_id::{CRATE_DEF_INDEX, DefIndex};
3 use crate::session::CrateDisambiguator;
6 use syntax::ext::hygiene::Mark;
8 use syntax::symbol::{kw, sym};
9 use syntax::parse::token::{self, TokenKind};
12 /// Creates `DefId`s for nodes in the AST.
13 pub struct DefCollector<'a> {
14 definitions: &'a mut Definitions,
15 parent_def: Option<DefIndex>,
17 pub visit_macro_invoc: Option<&'a mut dyn FnMut(MacroInvocationData)>,
20 pub struct MacroInvocationData {
22 pub def_index: DefIndex,
25 impl<'a> DefCollector<'a> {
26 pub fn new(definitions: &'a mut Definitions, expansion: Mark) -> Self {
31 visit_macro_invoc: None,
35 pub fn collect_root(&mut self,
37 crate_disambiguator: CrateDisambiguator) {
38 let root = self.definitions.create_root_def(crate_name,
40 assert_eq!(root, CRATE_DEF_INDEX);
41 self.parent_def = Some(root);
44 fn create_def(&mut self,
49 let parent_def = self.parent_def.unwrap();
50 debug!("create_def(node_id={:?}, data={:?}, parent_def={:?})", node_id, data, parent_def);
52 .create_def_with_parent(parent_def, node_id, data, self.expansion, span)
55 pub fn with_parent<F: FnOnce(&mut Self)>(&mut self, parent_def: DefIndex, f: F) {
56 let parent = self.parent_def;
57 self.parent_def = Some(parent_def);
59 self.parent_def = parent;
68 generics: &'a Generics,
72 let (closure_id, return_impl_trait_id) = match header.asyncness.node {
76 } => (closure_id, return_impl_trait_id),
80 // For async functions, we need to create their inner defs inside of a
81 // closure to match their desugared representation.
82 let fn_def_data = DefPathData::ValueNs(name.as_interned_str());
83 let fn_def = self.create_def(id, fn_def_data, span);
84 return self.with_parent(fn_def, |this| {
85 this.create_def(return_impl_trait_id, DefPathData::ImplTrait, span);
87 visit::walk_generics(this, generics);
88 visit::walk_fn_decl(this, decl);
90 let closure_def = this.create_def(
91 closure_id, DefPathData::ClosureExpr, span,
93 this.with_parent(closure_def, |this| {
94 visit::walk_block(this, body);
99 fn visit_macro_invoc(&mut self, id: NodeId) {
100 if let Some(ref mut visit) = self.visit_macro_invoc {
101 visit(MacroInvocationData {
102 mark: id.placeholder_to_mark(),
103 def_index: self.parent_def.unwrap(),
109 impl<'a> visit::Visitor<'a> for DefCollector<'a> {
110 fn visit_item(&mut self, i: &'a Item) {
111 debug!("visit_item: {:?}", i);
113 // Pick the def data. This need not be unique, but the more
114 // information we encapsulate into, the better
115 let def_data = match i.node {
116 ItemKind::Impl(..) => DefPathData::Impl,
117 ItemKind::Mod(..) if i.ident.name == kw::Invalid => {
118 return visit::walk_item(self, i);
120 ItemKind::Mod(..) | ItemKind::Trait(..) | ItemKind::TraitAlias(..) |
121 ItemKind::Enum(..) | ItemKind::Struct(..) | ItemKind::Union(..) |
122 ItemKind::Existential(..) | ItemKind::ExternCrate(..) | ItemKind::ForeignMod(..) |
123 ItemKind::Ty(..) => DefPathData::TypeNs(i.ident.as_interned_str()),
129 ) if header.asyncness.node.is_async() => {
130 return self.visit_async_fn(
140 ItemKind::Static(..) | ItemKind::Const(..) | ItemKind::Fn(..) =>
141 DefPathData::ValueNs(i.ident.as_interned_str()),
142 ItemKind::MacroDef(..) => DefPathData::MacroNs(i.ident.as_interned_str()),
143 ItemKind::Mac(..) => return self.visit_macro_invoc(i.id),
144 ItemKind::GlobalAsm(..) => DefPathData::Misc,
145 ItemKind::Use(..) => {
146 return visit::walk_item(self, i);
149 let def = self.create_def(i.id, def_data, i.span);
151 self.with_parent(def, |this| {
153 ItemKind::Struct(ref struct_def, _) | ItemKind::Union(ref struct_def, _) => {
154 // If this is a unit or tuple-like struct, register the constructor.
155 if let Some(ctor_hir_id) = struct_def.ctor_id() {
156 this.create_def(ctor_hir_id, DefPathData::Ctor, i.span);
161 visit::walk_item(this, i);
165 fn visit_use_tree(&mut self, use_tree: &'a UseTree, id: NodeId, _nested: bool) {
166 self.create_def(id, DefPathData::Misc, use_tree.span);
167 visit::walk_use_tree(self, use_tree, id);
170 fn visit_foreign_item(&mut self, foreign_item: &'a ForeignItem) {
171 if let ForeignItemKind::Macro(_) = foreign_item.node {
172 return self.visit_macro_invoc(foreign_item.id);
175 let def = self.create_def(foreign_item.id,
176 DefPathData::ValueNs(foreign_item.ident.as_interned_str()),
179 self.with_parent(def, |this| {
180 visit::walk_foreign_item(this, foreign_item);
184 fn visit_variant(&mut self, v: &'a Variant, g: &'a Generics, item_id: NodeId) {
185 let def = self.create_def(v.node.id,
186 DefPathData::TypeNs(v.node.ident.as_interned_str()),
188 self.with_parent(def, |this| {
189 if let Some(ctor_hir_id) = v.node.data.ctor_id() {
190 this.create_def(ctor_hir_id, DefPathData::Ctor, v.span);
192 visit::walk_variant(this, v, g, item_id)
196 fn visit_variant_data(&mut self, data: &'a VariantData, _: Ident,
197 _: &'a Generics, _: NodeId, _: Span) {
198 for (index, field) in data.fields().iter().enumerate() {
199 let name = field.ident.map(|ident| ident.name)
200 .unwrap_or_else(|| sym::integer(index));
201 let def = self.create_def(field.id,
202 DefPathData::ValueNs(name.as_interned_str()),
204 self.with_parent(def, |this| this.visit_struct_field(field));
208 fn visit_generic_param(&mut self, param: &'a GenericParam) {
209 let name = param.ident.as_interned_str();
210 let def_path_data = match param.kind {
211 GenericParamKind::Lifetime { .. } => DefPathData::LifetimeNs(name),
212 GenericParamKind::Type { .. } => DefPathData::TypeNs(name),
213 GenericParamKind::Const { .. } => DefPathData::ValueNs(name),
215 self.create_def(param.id, def_path_data, param.ident.span);
217 visit::walk_generic_param(self, param);
220 fn visit_trait_item(&mut self, ti: &'a TraitItem) {
221 let def_data = match ti.node {
222 TraitItemKind::Method(..) | TraitItemKind::Const(..) =>
223 DefPathData::ValueNs(ti.ident.as_interned_str()),
224 TraitItemKind::Type(..) => {
225 DefPathData::TypeNs(ti.ident.as_interned_str())
227 TraitItemKind::Macro(..) => return self.visit_macro_invoc(ti.id),
230 let def = self.create_def(ti.id, def_data, ti.span);
231 self.with_parent(def, |this| visit::walk_trait_item(this, ti));
234 fn visit_impl_item(&mut self, ii: &'a ImplItem) {
235 let def_data = match ii.node {
236 ImplItemKind::Method(MethodSig {
239 }, ref body) if header.asyncness.node.is_async() => {
240 return self.visit_async_fn(
250 ImplItemKind::Method(..) | ImplItemKind::Const(..) =>
251 DefPathData::ValueNs(ii.ident.as_interned_str()),
252 ImplItemKind::Type(..) |
253 ImplItemKind::Existential(..) => {
254 DefPathData::TypeNs(ii.ident.as_interned_str())
256 ImplItemKind::Macro(..) => return self.visit_macro_invoc(ii.id),
259 let def = self.create_def(ii.id, def_data, ii.span);
260 self.with_parent(def, |this| visit::walk_impl_item(this, ii));
263 fn visit_pat(&mut self, pat: &'a Pat) {
265 PatKind::Mac(..) => return self.visit_macro_invoc(pat.id),
266 _ => visit::walk_pat(self, pat),
270 fn visit_anon_const(&mut self, constant: &'a AnonConst) {
271 let def = self.create_def(constant.id,
272 DefPathData::AnonConst,
273 constant.value.span);
274 self.with_parent(def, |this| visit::walk_anon_const(this, constant));
277 fn visit_expr(&mut self, expr: &'a Expr) {
278 let parent_def = self.parent_def;
281 ExprKind::Mac(..) => return self.visit_macro_invoc(expr.id),
282 ExprKind::Closure(_, asyncness, ..) => {
283 let closure_def = self.create_def(expr.id,
284 DefPathData::ClosureExpr,
286 self.parent_def = Some(closure_def);
288 // Async closures desugar to closures inside of closures, so
289 // we must create two defs.
290 if let IsAsync::Async { closure_id, .. } = asyncness {
291 let async_def = self.create_def(closure_id,
292 DefPathData::ClosureExpr,
294 self.parent_def = Some(async_def);
297 ExprKind::Async(_, async_id, _) => {
298 let async_def = self.create_def(async_id,
299 DefPathData::ClosureExpr,
301 self.parent_def = Some(async_def);
306 visit::walk_expr(self, expr);
307 self.parent_def = parent_def;
310 fn visit_ty(&mut self, ty: &'a Ty) {
312 TyKind::Mac(..) => return self.visit_macro_invoc(ty.id),
313 TyKind::ImplTrait(node_id, _) => {
314 self.create_def(node_id, DefPathData::ImplTrait, ty.span);
318 visit::walk_ty(self, ty);
321 fn visit_stmt(&mut self, stmt: &'a Stmt) {
323 StmtKind::Mac(..) => self.visit_macro_invoc(stmt.id),
324 _ => visit::walk_stmt(self, stmt),
328 fn visit_token(&mut self, t: TokenKind) {
329 if let token::Interpolated(nt) = t {
330 if let token::NtExpr(ref expr) = *nt {
331 if let ExprKind::Mac(..) = expr.node {
332 self.visit_macro_invoc(expr.id);