1 use rustc_data_structures::fx::FxHashMap;
2 use rustc_data_structures::sorted_map::SortedMap;
4 use rustc_hir::def_id::LocalDefId;
5 use rustc_hir::definitions;
6 use rustc_hir::intravisit::{self, Visitor};
8 use rustc_index::vec::{Idx, IndexVec};
9 use rustc_middle::span_bug;
10 use rustc_session::Session;
11 use rustc_span::source_map::SourceMap;
12 use rustc_span::{Span, DUMMY_SP};
16 /// A visitor that walks over the HIR and collects `Node`s into a HIR map.
17 pub(super) struct NodeCollector<'a, 'hir> {
19 source_map: &'a SourceMap,
20 bodies: &'a SortedMap<ItemLocalId, &'hir Body<'hir>>,
23 nodes: IndexVec<ItemLocalId, Option<ParentedNode<'hir>>>,
24 parenting: FxHashMap<LocalDefId, ItemLocalId>,
26 /// The parent of this node
27 parent_node: hir::ItemLocalId,
31 definitions: &'a definitions::Definitions,
34 #[tracing::instrument(level = "debug", skip(sess, definitions, bodies))]
35 pub(super) fn index_hir<'hir>(
37 definitions: &definitions::Definitions,
38 item: hir::OwnerNode<'hir>,
39 bodies: &SortedMap<ItemLocalId, &'hir Body<'hir>>,
40 ) -> (IndexVec<ItemLocalId, Option<ParentedNode<'hir>>>, FxHashMap<LocalDefId, ItemLocalId>) {
41 let mut nodes = IndexVec::new();
42 // This node's parent should never be accessed: the owner's parent is computed by the
43 // hir_owner_parent query. Make it invalid (= ItemLocalId::MAX) to force an ICE whenever it is
45 nodes.push(Some(ParentedNode { parent: ItemLocalId::INVALID, node: item.into() }));
46 let mut collector = NodeCollector {
47 source_map: sess.source_map(),
50 parent_node: ItemLocalId::new(0),
53 parenting: FxHashMap::default(),
57 OwnerNode::Crate(citem) => {
58 collector.visit_mod(&citem, citem.spans.inner_span, hir::CRATE_HIR_ID)
60 OwnerNode::Item(item) => collector.visit_item(item),
61 OwnerNode::TraitItem(item) => collector.visit_trait_item(item),
62 OwnerNode::ImplItem(item) => collector.visit_impl_item(item),
63 OwnerNode::ForeignItem(item) => collector.visit_foreign_item(item),
66 (collector.nodes, collector.parenting)
69 impl<'a, 'hir> NodeCollector<'a, 'hir> {
70 #[tracing::instrument(level = "debug", skip(self))]
71 fn insert(&mut self, span: Span, hir_id: HirId, node: Node<'hir>) {
72 debug_assert_eq!(self.owner, hir_id.owner);
73 debug_assert_ne!(hir_id.local_id.as_u32(), 0);
75 // Make sure that the DepNode of some node coincides with the HirId
76 // owner of that node.
77 if cfg!(debug_assertions) {
78 if hir_id.owner != self.owner {
81 "inconsistent DepNode at `{:?}` for `{:?}`: \
82 current_dep_node_owner={} ({:?}), hir_id.owner={} ({:?})",
83 self.source_map.span_to_diagnostic_string(span),
85 self.definitions.def_path(self.owner).to_string_no_crate_verbose(),
87 self.definitions.def_path(hir_id.owner).to_string_no_crate_verbose(),
93 self.nodes.insert(hir_id.local_id, ParentedNode { parent: self.parent_node, node: node });
96 fn with_parent<F: FnOnce(&mut Self)>(&mut self, parent_node_id: HirId, f: F) {
97 debug_assert_eq!(parent_node_id.owner, self.owner);
98 let parent_node = self.parent_node;
99 self.parent_node = parent_node_id.local_id;
101 self.parent_node = parent_node;
104 fn insert_nested(&mut self, item: LocalDefId) {
105 self.parenting.insert(item, self.parent_node);
109 impl<'a, 'hir> Visitor<'hir> for NodeCollector<'a, 'hir> {
110 /// Because we want to track parent items and so forth, enable
111 /// deep walking so that we walk nested items in the context of
112 /// their outer items.
114 fn visit_nested_item(&mut self, item: ItemId) {
115 debug!("visit_nested_item: {:?}", item);
116 self.insert_nested(item.def_id);
119 fn visit_nested_trait_item(&mut self, item_id: TraitItemId) {
120 self.insert_nested(item_id.def_id);
123 fn visit_nested_impl_item(&mut self, item_id: ImplItemId) {
124 self.insert_nested(item_id.def_id);
127 fn visit_nested_foreign_item(&mut self, foreign_id: ForeignItemId) {
128 self.insert_nested(foreign_id.def_id);
131 fn visit_nested_body(&mut self, id: BodyId) {
132 debug_assert_eq!(id.hir_id.owner, self.owner);
133 let body = self.bodies[&id.hir_id.local_id];
134 self.visit_body(body);
137 fn visit_param(&mut self, param: &'hir Param<'hir>) {
138 let node = Node::Param(param);
139 self.insert(param.pat.span, param.hir_id, node);
140 self.with_parent(param.hir_id, |this| {
141 intravisit::walk_param(this, param);
145 #[tracing::instrument(level = "debug", skip(self))]
146 fn visit_item(&mut self, i: &'hir Item<'hir>) {
147 debug_assert_eq!(i.def_id, self.owner);
148 self.with_parent(i.hir_id(), |this| {
149 if let ItemKind::Struct(ref struct_def, _) = i.kind {
150 // If this is a tuple or unit-like struct, register the constructor.
151 if let Some(ctor_hir_id) = struct_def.ctor_hir_id() {
152 this.insert(i.span, ctor_hir_id, Node::Ctor(struct_def));
155 intravisit::walk_item(this, i);
159 #[tracing::instrument(level = "debug", skip(self))]
160 fn visit_foreign_item(&mut self, fi: &'hir ForeignItem<'hir>) {
161 debug_assert_eq!(fi.def_id, self.owner);
162 self.with_parent(fi.hir_id(), |this| {
163 intravisit::walk_foreign_item(this, fi);
167 fn visit_generic_param(&mut self, param: &'hir GenericParam<'hir>) {
168 self.insert(param.span, param.hir_id, Node::GenericParam(param));
169 intravisit::walk_generic_param(self, param);
172 fn visit_const_param_default(&mut self, param: HirId, ct: &'hir AnonConst) {
173 self.with_parent(param, |this| {
174 intravisit::walk_const_param_default(this, ct);
178 #[tracing::instrument(level = "debug", skip(self))]
179 fn visit_trait_item(&mut self, ti: &'hir TraitItem<'hir>) {
180 debug_assert_eq!(ti.def_id, self.owner);
181 self.with_parent(ti.hir_id(), |this| {
182 intravisit::walk_trait_item(this, ti);
186 #[tracing::instrument(level = "debug", skip(self))]
187 fn visit_impl_item(&mut self, ii: &'hir ImplItem<'hir>) {
188 debug_assert_eq!(ii.def_id, self.owner);
189 self.with_parent(ii.hir_id(), |this| {
190 intravisit::walk_impl_item(this, ii);
194 fn visit_pat(&mut self, pat: &'hir Pat<'hir>) {
195 self.insert(pat.span, pat.hir_id, Node::Pat(pat));
197 self.with_parent(pat.hir_id, |this| {
198 intravisit::walk_pat(this, pat);
202 fn visit_pat_field(&mut self, field: &'hir PatField<'hir>) {
203 self.insert(field.span, field.hir_id, Node::PatField(field));
204 self.with_parent(field.hir_id, |this| {
205 intravisit::walk_pat_field(this, field);
209 fn visit_arm(&mut self, arm: &'hir Arm<'hir>) {
210 let node = Node::Arm(arm);
212 self.insert(arm.span, arm.hir_id, node);
214 self.with_parent(arm.hir_id, |this| {
215 intravisit::walk_arm(this, arm);
219 fn visit_anon_const(&mut self, constant: &'hir AnonConst) {
220 self.insert(DUMMY_SP, constant.hir_id, Node::AnonConst(constant));
222 self.with_parent(constant.hir_id, |this| {
223 intravisit::walk_anon_const(this, constant);
227 fn visit_expr(&mut self, expr: &'hir Expr<'hir>) {
228 self.insert(expr.span, expr.hir_id, Node::Expr(expr));
230 self.with_parent(expr.hir_id, |this| {
231 intravisit::walk_expr(this, expr);
235 fn visit_expr_field(&mut self, field: &'hir ExprField<'hir>) {
236 self.insert(field.span, field.hir_id, Node::ExprField(field));
237 self.with_parent(field.hir_id, |this| {
238 intravisit::walk_expr_field(this, field);
242 fn visit_stmt(&mut self, stmt: &'hir Stmt<'hir>) {
243 self.insert(stmt.span, stmt.hir_id, Node::Stmt(stmt));
245 self.with_parent(stmt.hir_id, |this| {
246 intravisit::walk_stmt(this, stmt);
250 fn visit_path_segment(&mut self, path_span: Span, path_segment: &'hir PathSegment<'hir>) {
251 if let Some(hir_id) = path_segment.hir_id {
252 self.insert(path_span, hir_id, Node::PathSegment(path_segment));
254 intravisit::walk_path_segment(self, path_span, path_segment);
257 fn visit_ty(&mut self, ty: &'hir Ty<'hir>) {
258 self.insert(ty.span, ty.hir_id, Node::Ty(ty));
260 self.with_parent(ty.hir_id, |this| {
261 intravisit::walk_ty(this, ty);
265 fn visit_infer(&mut self, inf: &'hir InferArg) {
266 self.insert(inf.span, inf.hir_id, Node::Infer(inf));
268 self.with_parent(inf.hir_id, |this| {
269 intravisit::walk_inf(this, inf);
273 fn visit_trait_ref(&mut self, tr: &'hir TraitRef<'hir>) {
274 self.insert(tr.path.span, tr.hir_ref_id, Node::TraitRef(tr));
276 self.with_parent(tr.hir_ref_id, |this| {
277 intravisit::walk_trait_ref(this, tr);
283 fk: intravisit::FnKind<'hir>,
284 fd: &'hir FnDecl<'hir>,
289 assert_eq!(self.owner, id.owner);
290 assert_eq!(self.parent_node, id.local_id);
291 intravisit::walk_fn(self, fk, fd, b, s, id);
294 fn visit_block(&mut self, block: &'hir Block<'hir>) {
295 self.insert(block.span, block.hir_id, Node::Block(block));
296 self.with_parent(block.hir_id, |this| {
297 intravisit::walk_block(this, block);
301 fn visit_local(&mut self, l: &'hir Local<'hir>) {
302 self.insert(l.span, l.hir_id, Node::Local(l));
303 self.with_parent(l.hir_id, |this| {
304 intravisit::walk_local(this, l);
308 fn visit_lifetime(&mut self, lifetime: &'hir Lifetime) {
309 self.insert(lifetime.span, lifetime.hir_id, Node::Lifetime(lifetime));
312 fn visit_variant(&mut self, v: &'hir Variant<'hir>) {
313 self.insert(v.span, v.id, Node::Variant(v));
314 self.with_parent(v.id, |this| {
315 // Register the constructor of this variant.
316 if let Some(ctor_hir_id) = v.data.ctor_hir_id() {
317 this.insert(v.span, ctor_hir_id, Node::Ctor(&v.data));
319 intravisit::walk_variant(this, v);
323 fn visit_field_def(&mut self, field: &'hir FieldDef<'hir>) {
324 self.insert(field.span, field.hir_id, Node::Field(field));
325 self.with_parent(field.hir_id, |this| {
326 intravisit::walk_field_def(this, field);
330 fn visit_assoc_type_binding(&mut self, type_binding: &'hir TypeBinding<'hir>) {
331 self.insert(type_binding.span, type_binding.hir_id, Node::TypeBinding(type_binding));
332 self.with_parent(type_binding.hir_id, |this| {
333 intravisit::walk_assoc_type_binding(this, type_binding)
337 fn visit_trait_item_ref(&mut self, ii: &'hir TraitItemRef) {
338 // Do not visit the duplicate information in TraitItemRef. We want to
339 // map the actual nodes, not the duplicate ones in the *Ref.
340 let TraitItemRef { id, ident: _, kind: _, span: _ } = *ii;
342 self.visit_nested_trait_item(id);
345 fn visit_impl_item_ref(&mut self, ii: &'hir ImplItemRef) {
346 // Do not visit the duplicate information in ImplItemRef. We want to
347 // map the actual nodes, not the duplicate ones in the *Ref.
348 let ImplItemRef { id, ident: _, kind: _, span: _, trait_item_def_id: _ } = *ii;
350 self.visit_nested_impl_item(id);
353 fn visit_foreign_item_ref(&mut self, fi: &'hir ForeignItemRef) {
354 // Do not visit the duplicate information in ForeignItemRef. We want to
355 // map the actual nodes, not the duplicate ones in the *Ref.
356 let ForeignItemRef { id, ident: _, span: _ } = *fi;
358 self.visit_nested_foreign_item(id);