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};
14 /// A visitor that walks over the HIR and collects `Node`s into a HIR map.
15 pub(super) struct NodeCollector<'a, 'hir> {
17 source_map: &'a SourceMap,
18 bodies: &'a SortedMap<ItemLocalId, &'hir Body<'hir>>,
21 nodes: IndexVec<ItemLocalId, Option<ParentedNode<'hir>>>,
22 parenting: FxHashMap<LocalDefId, ItemLocalId>,
24 /// The parent of this node
25 parent_node: hir::ItemLocalId,
29 definitions: &'a definitions::Definitions,
32 #[instrument(level = "debug", skip(sess, definitions, bodies))]
33 pub(super) fn index_hir<'hir>(
35 definitions: &definitions::Definitions,
36 item: hir::OwnerNode<'hir>,
37 bodies: &SortedMap<ItemLocalId, &'hir Body<'hir>>,
38 ) -> (IndexVec<ItemLocalId, Option<ParentedNode<'hir>>>, FxHashMap<LocalDefId, ItemLocalId>) {
39 let mut nodes = IndexVec::new();
40 // This node's parent should never be accessed: the owner's parent is computed by the
41 // hir_owner_parent query. Make it invalid (= ItemLocalId::MAX) to force an ICE whenever it is
43 nodes.push(Some(ParentedNode { parent: ItemLocalId::INVALID, node: item.into() }));
44 let mut collector = NodeCollector {
45 source_map: sess.source_map(),
48 parent_node: ItemLocalId::new(0),
51 parenting: FxHashMap::default(),
55 OwnerNode::Crate(citem) => {
56 collector.visit_mod(&citem, citem.spans.inner_span, hir::CRATE_HIR_ID)
58 OwnerNode::Item(item) => collector.visit_item(item),
59 OwnerNode::TraitItem(item) => collector.visit_trait_item(item),
60 OwnerNode::ImplItem(item) => collector.visit_impl_item(item),
61 OwnerNode::ForeignItem(item) => collector.visit_foreign_item(item),
64 (collector.nodes, collector.parenting)
67 impl<'a, 'hir> NodeCollector<'a, 'hir> {
68 #[instrument(level = "debug", skip(self))]
69 fn insert(&mut self, span: Span, hir_id: HirId, node: Node<'hir>) {
70 debug_assert_eq!(self.owner, hir_id.owner);
71 debug_assert_ne!(hir_id.local_id.as_u32(), 0);
72 debug_assert_ne!(hir_id.local_id, self.parent_node);
74 // Make sure that the DepNode of some node coincides with the HirId
75 // owner of that node.
76 if cfg!(debug_assertions) {
77 if hir_id.owner != self.owner {
80 "inconsistent DepNode at `{:?}` for `{:?}`: \
81 current_dep_node_owner={} ({:?}), hir_id.owner={} ({:?})",
82 self.source_map.span_to_diagnostic_string(span),
84 self.definitions.def_path(self.owner.def_id).to_string_no_crate_verbose(),
86 self.definitions.def_path(hir_id.owner.def_id).to_string_no_crate_verbose(),
92 self.nodes.insert(hir_id.local_id, ParentedNode { parent: self.parent_node, node: node });
95 fn with_parent<F: FnOnce(&mut Self)>(&mut self, parent_node_id: HirId, f: F) {
96 debug_assert_eq!(parent_node_id.owner, self.owner);
97 let parent_node = self.parent_node;
98 self.parent_node = parent_node_id.local_id;
100 self.parent_node = parent_node;
103 fn insert_nested(&mut self, item: LocalDefId) {
104 self.parenting.insert(item, self.parent_node);
108 impl<'a, 'hir> Visitor<'hir> for NodeCollector<'a, 'hir> {
109 /// Because we want to track parent items and so forth, enable
110 /// deep walking so that we walk nested items in the context of
111 /// their outer items.
113 fn visit_nested_item(&mut self, item: ItemId) {
114 debug!("visit_nested_item: {:?}", item);
115 self.insert_nested(item.owner_id.def_id);
118 fn visit_nested_trait_item(&mut self, item_id: TraitItemId) {
119 self.insert_nested(item_id.owner_id.def_id);
122 fn visit_nested_impl_item(&mut self, item_id: ImplItemId) {
123 self.insert_nested(item_id.owner_id.def_id);
126 fn visit_nested_foreign_item(&mut self, foreign_id: ForeignItemId) {
127 self.insert_nested(foreign_id.owner_id.def_id);
130 fn visit_nested_body(&mut self, id: BodyId) {
131 debug_assert_eq!(id.hir_id.owner, self.owner);
132 let body = self.bodies[&id.hir_id.local_id];
133 self.visit_body(body);
136 fn visit_param(&mut self, param: &'hir Param<'hir>) {
137 let node = Node::Param(param);
138 self.insert(param.pat.span, param.hir_id, node);
139 self.with_parent(param.hir_id, |this| {
140 intravisit::walk_param(this, param);
144 #[instrument(level = "debug", skip(self))]
145 fn visit_item(&mut self, i: &'hir Item<'hir>) {
146 debug_assert_eq!(i.owner_id, self.owner);
147 self.with_parent(i.hir_id(), |this| {
148 if let ItemKind::Struct(ref struct_def, _) = i.kind {
149 // If this is a tuple or unit-like struct, register the constructor.
150 if let Some(ctor_hir_id) = struct_def.ctor_hir_id() {
151 this.insert(i.span, ctor_hir_id, Node::Ctor(struct_def));
154 intravisit::walk_item(this, i);
158 #[instrument(level = "debug", skip(self))]
159 fn visit_foreign_item(&mut self, fi: &'hir ForeignItem<'hir>) {
160 debug_assert_eq!(fi.owner_id, self.owner);
161 self.with_parent(fi.hir_id(), |this| {
162 intravisit::walk_foreign_item(this, fi);
166 fn visit_generic_param(&mut self, param: &'hir GenericParam<'hir>) {
167 self.insert(param.span, param.hir_id, Node::GenericParam(param));
168 intravisit::walk_generic_param(self, param);
171 fn visit_const_param_default(&mut self, param: HirId, ct: &'hir AnonConst) {
172 self.with_parent(param, |this| {
173 intravisit::walk_const_param_default(this, ct);
177 #[instrument(level = "debug", skip(self))]
178 fn visit_trait_item(&mut self, ti: &'hir TraitItem<'hir>) {
179 debug_assert_eq!(ti.owner_id, self.owner);
180 self.with_parent(ti.hir_id(), |this| {
181 intravisit::walk_trait_item(this, ti);
185 #[instrument(level = "debug", skip(self))]
186 fn visit_impl_item(&mut self, ii: &'hir ImplItem<'hir>) {
187 debug_assert_eq!(ii.owner_id, self.owner);
188 self.with_parent(ii.hir_id(), |this| {
189 intravisit::walk_impl_item(this, ii);
193 fn visit_pat(&mut self, pat: &'hir Pat<'hir>) {
194 self.insert(pat.span, pat.hir_id, Node::Pat(pat));
196 self.with_parent(pat.hir_id, |this| {
197 intravisit::walk_pat(this, pat);
201 fn visit_pat_field(&mut self, field: &'hir PatField<'hir>) {
202 self.insert(field.span, field.hir_id, Node::PatField(field));
203 self.with_parent(field.hir_id, |this| {
204 intravisit::walk_pat_field(this, field);
208 fn visit_arm(&mut self, arm: &'hir Arm<'hir>) {
209 let node = Node::Arm(arm);
211 self.insert(arm.span, arm.hir_id, node);
213 self.with_parent(arm.hir_id, |this| {
214 intravisit::walk_arm(this, arm);
218 fn visit_anon_const(&mut self, constant: &'hir AnonConst) {
219 self.insert(DUMMY_SP, constant.hir_id, Node::AnonConst(constant));
221 self.with_parent(constant.hir_id, |this| {
222 intravisit::walk_anon_const(this, constant);
226 fn visit_expr(&mut self, expr: &'hir Expr<'hir>) {
227 self.insert(expr.span, expr.hir_id, Node::Expr(expr));
229 self.with_parent(expr.hir_id, |this| {
230 intravisit::walk_expr(this, expr);
234 fn visit_expr_field(&mut self, field: &'hir ExprField<'hir>) {
235 self.insert(field.span, field.hir_id, Node::ExprField(field));
236 self.with_parent(field.hir_id, |this| {
237 intravisit::walk_expr_field(this, field);
241 fn visit_stmt(&mut self, stmt: &'hir Stmt<'hir>) {
242 self.insert(stmt.span, stmt.hir_id, Node::Stmt(stmt));
244 self.with_parent(stmt.hir_id, |this| {
245 intravisit::walk_stmt(this, stmt);
249 fn visit_path_segment(&mut self, path_segment: &'hir PathSegment<'hir>) {
250 self.insert(path_segment.ident.span, path_segment.hir_id, Node::PathSegment(path_segment));
251 intravisit::walk_path_segment(self, path_segment);
254 fn visit_ty(&mut self, ty: &'hir Ty<'hir>) {
255 self.insert(ty.span, ty.hir_id, Node::Ty(ty));
257 self.with_parent(ty.hir_id, |this| {
258 intravisit::walk_ty(this, ty);
262 fn visit_infer(&mut self, inf: &'hir InferArg) {
263 self.insert(inf.span, inf.hir_id, Node::Infer(inf));
265 self.with_parent(inf.hir_id, |this| {
266 intravisit::walk_inf(this, inf);
270 fn visit_trait_ref(&mut self, tr: &'hir TraitRef<'hir>) {
271 self.insert(tr.path.span, tr.hir_ref_id, Node::TraitRef(tr));
273 self.with_parent(tr.hir_ref_id, |this| {
274 intravisit::walk_trait_ref(this, tr);
280 fk: intravisit::FnKind<'hir>,
281 fd: &'hir FnDecl<'hir>,
286 assert_eq!(self.owner, id.owner);
287 assert_eq!(self.parent_node, id.local_id);
288 intravisit::walk_fn(self, fk, fd, b, id);
291 fn visit_block(&mut self, block: &'hir Block<'hir>) {
292 self.insert(block.span, block.hir_id, Node::Block(block));
293 self.with_parent(block.hir_id, |this| {
294 intravisit::walk_block(this, block);
298 fn visit_local(&mut self, l: &'hir Local<'hir>) {
299 self.insert(l.span, l.hir_id, Node::Local(l));
300 self.with_parent(l.hir_id, |this| {
301 intravisit::walk_local(this, l);
305 fn visit_lifetime(&mut self, lifetime: &'hir Lifetime) {
306 self.insert(lifetime.span, lifetime.hir_id, Node::Lifetime(lifetime));
309 fn visit_variant(&mut self, v: &'hir Variant<'hir>) {
310 self.insert(v.span, v.id, Node::Variant(v));
311 self.with_parent(v.id, |this| {
312 // Register the constructor of this variant.
313 if let Some(ctor_hir_id) = v.data.ctor_hir_id() {
314 this.insert(v.span, ctor_hir_id, Node::Ctor(&v.data));
316 intravisit::walk_variant(this, v);
320 fn visit_field_def(&mut self, field: &'hir FieldDef<'hir>) {
321 self.insert(field.span, field.hir_id, Node::Field(field));
322 self.with_parent(field.hir_id, |this| {
323 intravisit::walk_field_def(this, field);
327 fn visit_assoc_type_binding(&mut self, type_binding: &'hir TypeBinding<'hir>) {
328 self.insert(type_binding.span, type_binding.hir_id, Node::TypeBinding(type_binding));
329 self.with_parent(type_binding.hir_id, |this| {
330 intravisit::walk_assoc_type_binding(this, type_binding)
334 fn visit_trait_item_ref(&mut self, ii: &'hir TraitItemRef) {
335 // Do not visit the duplicate information in TraitItemRef. We want to
336 // map the actual nodes, not the duplicate ones in the *Ref.
337 let TraitItemRef { id, ident: _, kind: _, span: _ } = *ii;
339 self.visit_nested_trait_item(id);
342 fn visit_impl_item_ref(&mut self, ii: &'hir ImplItemRef) {
343 // Do not visit the duplicate information in ImplItemRef. We want to
344 // map the actual nodes, not the duplicate ones in the *Ref.
345 let ImplItemRef { id, ident: _, kind: _, span: _, trait_item_def_id: _ } = *ii;
347 self.visit_nested_impl_item(id);
350 fn visit_foreign_item_ref(&mut self, fi: &'hir ForeignItemRef) {
351 // Do not visit the duplicate information in ForeignItemRef. We want to
352 // map the actual nodes, not the duplicate ones in the *Ref.
353 let ForeignItemRef { id, ident: _, span: _ } = *fi;
355 self.visit_nested_foreign_item(id);