1 // Copyright 2012-2015 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 self::collector::NodeCollector;
12 pub use self::def_collector::{DefCollector, MacroInvocationData};
13 pub use self::definitions::{Definitions, DefKey, DefPath, DefPathData,
14 DisambiguatedDefPathData, DefPathHash};
16 use dep_graph::{DepGraph, DepNode, DepKind, DepNodeIndex};
18 use hir::def_id::{CRATE_DEF_INDEX, DefId, LocalDefId, DefIndexAddressSpace};
20 use middle::cstore::CrateStore;
22 use rustc_target::spec::abi::Abi;
23 use rustc_data_structures::svh::Svh;
24 use syntax::ast::{self, Name, NodeId, CRATE_NODE_ID};
25 use syntax::source_map::Spanned;
26 use syntax::ext::base::MacroKind;
27 use syntax_pos::{Span, DUMMY_SP};
30 use hir::print::Nested;
31 use util::nodemap::FxHashMap;
34 use std::result::Result::Err;
43 pub const ITEM_LIKE_SPACE: DefIndexAddressSpace = DefIndexAddressSpace::Low;
44 pub const REGULAR_SPACE: DefIndexAddressSpace = DefIndexAddressSpace::High;
46 /// Represents an entry and its parent NodeId.
47 #[derive(Copy, Clone, Debug)]
48 pub struct Entry<'hir> {
50 dep_node: DepNodeIndex,
54 impl<'hir> Entry<'hir> {
55 fn parent_node(self) -> Option<NodeId> {
57 Node::Crate | Node::MacroDef(_) => None,
58 _ => Some(self.parent),
62 fn fn_decl(&self) -> Option<&FnDecl> {
64 Node::Item(ref item) => {
66 ItemKind::Fn(ref fn_decl, _, _, _) => Some(&fn_decl),
71 Node::TraitItem(ref item) => {
73 TraitItemKind::Method(ref method_sig, _) => Some(&method_sig.decl),
78 Node::ImplItem(ref item) => {
80 ImplItemKind::Method(ref method_sig, _) => Some(&method_sig.decl),
85 Node::Expr(ref expr) => {
87 ExprKind::Closure(_, ref fn_decl, ..) => Some(&fn_decl),
96 fn associated_body(self) -> Option<BodyId> {
100 ItemKind::Const(_, body) |
101 ItemKind::Static(.., body) |
102 ItemKind::Fn(_, _, _, body) => Some(body),
107 Node::TraitItem(item) => {
109 TraitItemKind::Const(_, Some(body)) |
110 TraitItemKind::Method(_, TraitMethod::Provided(body)) => Some(body),
115 Node::ImplItem(item) => {
117 ImplItemKind::Const(_, body) |
118 ImplItemKind::Method(_, body) => Some(body),
123 Node::AnonConst(constant) => Some(constant.body),
125 Node::Expr(expr) => {
127 ExprKind::Closure(.., body, _, _) => Some(body),
136 fn is_body_owner(self, node_id: NodeId) -> bool {
137 match self.associated_body() {
138 Some(b) => b.node_id == node_id,
144 /// Stores a crate and any number of inlined items from other crates.
147 pub dep_graph: DepGraph,
151 pub fn new(krate: Crate, dep_graph: &DepGraph) -> Forest {
154 dep_graph: dep_graph.clone(),
158 pub fn krate<'hir>(&'hir self) -> &'hir Crate {
159 self.dep_graph.read(DepNode::new_no_params(DepKind::Krate));
164 /// Represents a mapping from Node IDs to AST elements and their parent
167 pub struct Map<'hir> {
168 /// The backing storage for all the AST nodes.
169 pub forest: &'hir Forest,
171 /// Same as the dep_graph in forest, just available with one fewer
172 /// deref. This is a gratuitous micro-optimization.
173 pub dep_graph: DepGraph,
175 /// The SVH of the local crate.
178 /// `NodeId`s are sequential integers from 0, so we can be
179 /// super-compact by storing them in a vector. Not everything with
180 /// a `NodeId` is in the map, but empirically the occupancy is about
181 /// 75-80%, so there's not too much overhead (certainly less than
182 /// a hashmap, since they (at the time of writing) have a maximum
183 /// of 75% occupancy).
185 /// Also, indexing is pretty quick when you've got a vector and
186 /// plain old integers.
187 map: Vec<Option<Entry<'hir>>>,
189 definitions: &'hir Definitions,
191 /// The reverse mapping of `node_to_hir_id`.
192 hir_to_node_id: FxHashMap<HirId, NodeId>,
195 impl<'hir> Map<'hir> {
196 /// Registers a read in the dependency graph of the AST node with
197 /// the given `id`. This needs to be called each time a public
198 /// function returns the HIR for a node -- in other words, when it
199 /// "reveals" the content of a node to the caller (who might not
200 /// otherwise have had access to those contents, and hence needs a
201 /// read recorded). If the function just returns a DefId or
202 /// NodeId, no actual content was returned, so no read is needed.
203 pub fn read(&self, id: NodeId) {
204 if let Some(entry) = self.map[id.as_usize()] {
205 self.dep_graph.read_index(entry.dep_node);
207 bug!("called `HirMap::read()` with invalid `NodeId`")
212 pub fn definitions(&self) -> &'hir Definitions {
216 pub fn def_key(&self, def_id: DefId) -> DefKey {
217 assert!(def_id.is_local());
218 self.definitions.def_key(def_id.index)
221 pub fn def_path_from_id(&self, id: NodeId) -> Option<DefPath> {
222 self.opt_local_def_id(id).map(|def_id| {
223 self.def_path(def_id)
227 pub fn def_path(&self, def_id: DefId) -> DefPath {
228 assert!(def_id.is_local());
229 self.definitions.def_path(def_id.index)
233 pub fn local_def_id(&self, node: NodeId) -> DefId {
234 self.opt_local_def_id(node).unwrap_or_else(|| {
235 bug!("local_def_id: no entry for `{}`, which has a map of `{:?}`",
236 node, self.find_entry(node))
241 pub fn opt_local_def_id(&self, node: NodeId) -> Option<DefId> {
242 self.definitions.opt_local_def_id(node)
246 pub fn as_local_node_id(&self, def_id: DefId) -> Option<NodeId> {
247 self.definitions.as_local_node_id(def_id)
251 pub fn hir_to_node_id(&self, hir_id: HirId) -> NodeId {
252 self.hir_to_node_id[&hir_id]
256 pub fn node_to_hir_id(&self, node_id: NodeId) -> HirId {
257 self.definitions.node_to_hir_id(node_id)
261 pub fn def_index_to_hir_id(&self, def_index: DefIndex) -> HirId {
262 self.definitions.def_index_to_hir_id(def_index)
266 pub fn def_index_to_node_id(&self, def_index: DefIndex) -> NodeId {
267 self.definitions.as_local_node_id(DefId::local(def_index)).unwrap()
271 pub fn local_def_id_to_hir_id(&self, def_id: LocalDefId) -> HirId {
272 self.definitions.def_index_to_hir_id(def_id.to_def_id().index)
276 pub fn local_def_id_to_node_id(&self, def_id: LocalDefId) -> NodeId {
277 self.definitions.as_local_node_id(def_id.to_def_id()).unwrap()
280 pub fn describe_def(&self, node_id: NodeId) -> Option<Def> {
281 let node = if let Some(node) = self.find(node_id) {
288 Node::Item(item) => {
290 self.local_def_id(item.id)
294 ItemKind::Static(_, m, _) => Some(Def::Static(def_id(), m == MutMutable)),
295 ItemKind::Const(..) => Some(Def::Const(def_id())),
296 ItemKind::Fn(..) => Some(Def::Fn(def_id())),
297 ItemKind::Mod(..) => Some(Def::Mod(def_id())),
298 ItemKind::Existential(..) => Some(Def::Existential(def_id())),
299 ItemKind::Ty(..) => Some(Def::TyAlias(def_id())),
300 ItemKind::Enum(..) => Some(Def::Enum(def_id())),
301 ItemKind::Struct(..) => Some(Def::Struct(def_id())),
302 ItemKind::Union(..) => Some(Def::Union(def_id())),
303 ItemKind::Trait(..) => Some(Def::Trait(def_id())),
304 ItemKind::TraitAlias(..) => {
305 bug!("trait aliases are not yet implemented (see issue #41517)")
307 ItemKind::ExternCrate(_) |
309 ItemKind::ForeignMod(..) |
310 ItemKind::GlobalAsm(..) |
311 ItemKind::Impl(..) => None,
314 Node::ForeignItem(item) => {
315 let def_id = self.local_def_id(item.id);
317 ForeignItemKind::Fn(..) => Some(Def::Fn(def_id)),
318 ForeignItemKind::Static(_, m) => Some(Def::Static(def_id, m)),
319 ForeignItemKind::Type => Some(Def::ForeignTy(def_id)),
322 Node::TraitItem(item) => {
323 let def_id = self.local_def_id(item.id);
325 TraitItemKind::Const(..) => Some(Def::AssociatedConst(def_id)),
326 TraitItemKind::Method(..) => Some(Def::Method(def_id)),
327 TraitItemKind::Type(..) => Some(Def::AssociatedTy(def_id)),
330 Node::ImplItem(item) => {
331 let def_id = self.local_def_id(item.id);
333 ImplItemKind::Const(..) => Some(Def::AssociatedConst(def_id)),
334 ImplItemKind::Method(..) => Some(Def::Method(def_id)),
335 ImplItemKind::Type(..) => Some(Def::AssociatedTy(def_id)),
336 ImplItemKind::Existential(..) => Some(Def::AssociatedExistential(def_id)),
339 Node::Variant(variant) => {
340 let def_id = self.local_def_id(variant.node.data.id());
341 Some(Def::Variant(def_id))
351 Node::StructCtor(_) |
353 Node::Visibility(_) |
356 Node::Local(local) => {
357 Some(Def::Local(local.id))
359 Node::MacroDef(macro_def) => {
360 Some(Def::Macro(self.local_def_id(macro_def.id),
363 Node::GenericParam(param) => {
364 Some(match param.kind {
365 GenericParamKind::Lifetime { .. } => Def::Local(param.id),
366 GenericParamKind::Type { .. } => Def::TyParam(self.local_def_id(param.id)),
372 fn entry_count(&self) -> usize {
376 fn find_entry(&self, id: NodeId) -> Option<Entry<'hir>> {
377 self.map.get(id.as_usize()).cloned().unwrap_or(None)
380 pub fn krate(&self) -> &'hir Crate {
384 pub fn trait_item(&self, id: TraitItemId) -> &'hir TraitItem {
385 self.read(id.node_id);
387 // NB: intentionally bypass `self.forest.krate()` so that we
388 // do not trigger a read of the whole krate here
389 self.forest.krate.trait_item(id)
392 pub fn impl_item(&self, id: ImplItemId) -> &'hir ImplItem {
393 self.read(id.node_id);
395 // NB: intentionally bypass `self.forest.krate()` so that we
396 // do not trigger a read of the whole krate here
397 self.forest.krate.impl_item(id)
400 pub fn body(&self, id: BodyId) -> &'hir Body {
401 self.read(id.node_id);
403 // NB: intentionally bypass `self.forest.krate()` so that we
404 // do not trigger a read of the whole krate here
405 self.forest.krate.body(id)
408 pub fn fn_decl(&self, node_id: ast::NodeId) -> Option<FnDecl> {
409 if let Some(entry) = self.find_entry(node_id) {
410 entry.fn_decl().cloned()
412 bug!("no entry for node_id `{}`", node_id)
416 /// Returns the `NodeId` that corresponds to the definition of
417 /// which this is the body of, i.e. a `fn`, `const` or `static`
418 /// item (possibly associated), a closure, or a `hir::AnonConst`.
419 pub fn body_owner(&self, BodyId { node_id }: BodyId) -> NodeId {
420 let parent = self.get_parent_node(node_id);
421 assert!(self.map[parent.as_usize()].map_or(false, |e| e.is_body_owner(node_id)));
425 pub fn body_owner_def_id(&self, id: BodyId) -> DefId {
426 self.local_def_id(self.body_owner(id))
429 /// Given a node id, returns the `BodyId` associated with it,
430 /// if the node is a body owner, otherwise returns `None`.
431 pub fn maybe_body_owned_by(&self, id: NodeId) -> Option<BodyId> {
432 if let Some(entry) = self.find_entry(id) {
433 if self.dep_graph.is_fully_enabled() {
434 let hir_id_owner = self.node_to_hir_id(id).owner;
435 let def_path_hash = self.definitions.def_path_hash(hir_id_owner);
436 self.dep_graph.read(def_path_hash.to_dep_node(DepKind::HirBody));
439 entry.associated_body()
441 bug!("no entry for id `{}`", id)
445 /// Given a body owner's id, returns the `BodyId` associated with it.
446 pub fn body_owned_by(&self, id: NodeId) -> BodyId {
447 self.maybe_body_owned_by(id).unwrap_or_else(|| {
448 span_bug!(self.span(id), "body_owned_by: {} has no associated body",
449 self.node_to_string(id));
453 pub fn body_owner_kind(&self, id: NodeId) -> BodyOwnerKind {
455 Node::Item(&Item { node: ItemKind::Const(..), .. }) |
456 Node::TraitItem(&TraitItem { node: TraitItemKind::Const(..), .. }) |
457 Node::ImplItem(&ImplItem { node: ImplItemKind::Const(..), .. }) |
458 Node::AnonConst(_) => {
461 Node::Item(&Item { node: ItemKind::Static(_, m, _), .. }) => {
462 BodyOwnerKind::Static(m)
464 // Default to function if it's not a constant or static.
465 _ => BodyOwnerKind::Fn
469 pub fn ty_param_owner(&self, id: NodeId) -> NodeId {
471 Node::Item(&Item { node: ItemKind::Trait(..), .. }) => id,
472 Node::GenericParam(_) => self.get_parent_node(id),
473 _ => bug!("ty_param_owner: {} not a type parameter", self.node_to_string(id))
477 pub fn ty_param_name(&self, id: NodeId) -> Name {
479 Node::Item(&Item { node: ItemKind::Trait(..), .. }) => keywords::SelfType.name(),
480 Node::GenericParam(param) => param.name.ident().name,
481 _ => bug!("ty_param_name: {} not a type parameter", self.node_to_string(id)),
485 pub fn trait_impls(&self, trait_did: DefId) -> &'hir [NodeId] {
486 self.dep_graph.read(DepNode::new_no_params(DepKind::AllLocalTraitImpls));
488 // NB: intentionally bypass `self.forest.krate()` so that we
489 // do not trigger a read of the whole krate here
490 self.forest.krate.trait_impls.get(&trait_did).map_or(&[], |xs| &xs[..])
493 pub fn trait_auto_impl(&self, trait_did: DefId) -> Option<NodeId> {
494 self.dep_graph.read(DepNode::new_no_params(DepKind::AllLocalTraitImpls));
496 // NB: intentionally bypass `self.forest.krate()` so that we
497 // do not trigger a read of the whole krate here
498 self.forest.krate.trait_auto_impl.get(&trait_did).cloned()
501 pub fn trait_is_auto(&self, trait_did: DefId) -> bool {
502 self.trait_auto_impl(trait_did).is_some()
505 /// Get the attributes on the krate. This is preferable to
506 /// invoking `krate.attrs` because it registers a tighter
507 /// dep-graph access.
508 pub fn krate_attrs(&self) -> &'hir [ast::Attribute] {
509 let def_path_hash = self.definitions.def_path_hash(CRATE_DEF_INDEX);
511 self.dep_graph.read(def_path_hash.to_dep_node(DepKind::Hir));
512 &self.forest.krate.attrs
515 /// Retrieve the Node corresponding to `id`, panicking if it cannot
517 pub fn get(&self, id: NodeId) -> Node<'hir> {
518 // read recorded by `find`
519 self.find(id).unwrap_or_else(|| bug!("couldn't find node id {} in the AST map", id))
522 pub fn get_if_local(&self, id: DefId) -> Option<Node<'hir>> {
523 self.as_local_node_id(id).map(|id| self.get(id)) // read recorded by `get`
526 pub fn get_generics(&self, id: DefId) -> Option<&'hir Generics> {
527 self.get_if_local(id).and_then(|node| {
529 Node::ImplItem(ref impl_item) => Some(&impl_item.generics),
530 Node::TraitItem(ref trait_item) => Some(&trait_item.generics),
531 Node::Item(ref item) => {
533 ItemKind::Fn(_, _, ref generics, _) |
534 ItemKind::Ty(_, ref generics) |
535 ItemKind::Enum(_, ref generics) |
536 ItemKind::Struct(_, ref generics) |
537 ItemKind::Union(_, ref generics) |
538 ItemKind::Trait(_, _, ref generics, ..) |
539 ItemKind::TraitAlias(ref generics, _) |
540 ItemKind::Impl(_, _, _, ref generics, ..) => Some(generics),
549 pub fn get_generics_span(&self, id: DefId) -> Option<Span> {
550 self.get_generics(id).map(|generics| generics.span).filter(|sp| *sp != DUMMY_SP)
553 /// Retrieve the Node corresponding to `id`, returning None if
555 pub fn find(&self, id: NodeId) -> Option<Node<'hir>> {
556 let result = self.find_entry(id).and_then(|entry| {
557 if let Node::Crate = entry.node {
563 if result.is_some() {
569 /// Similar to get_parent, returns the parent node id or id if there is no
570 /// parent. Note that the parent may be CRATE_NODE_ID, which is not itself
571 /// present in the map -- so passing the return value of get_parent_node to
572 /// get may actually panic.
573 /// This function returns the immediate parent in the AST, whereas get_parent
574 /// returns the enclosing item. Note that this might not be the actual parent
575 /// node in the AST - some kinds of nodes are not in the map and these will
576 /// never appear as the parent_node. So you can always walk the parent_nodes
577 /// from a node to the root of the ast (unless you get the same id back here
578 /// that can happen if the id is not in the map itself or is just weird).
579 pub fn get_parent_node(&self, id: NodeId) -> NodeId {
580 if self.dep_graph.is_fully_enabled() {
581 let hir_id_owner = self.node_to_hir_id(id).owner;
582 let def_path_hash = self.definitions.def_path_hash(hir_id_owner);
583 self.dep_graph.read(def_path_hash.to_dep_node(DepKind::HirBody));
586 self.find_entry(id).and_then(|x| x.parent_node()).unwrap_or(id)
589 /// Check if the node is an argument. An argument is a local variable whose
590 /// immediate parent is an item or a closure.
591 pub fn is_argument(&self, id: NodeId) -> bool {
592 match self.find(id) {
593 Some(Node::Binding(_)) => (),
596 match self.find(self.get_parent_node(id)) {
597 Some(Node::Item(_)) |
598 Some(Node::TraitItem(_)) |
599 Some(Node::ImplItem(_)) => true,
600 Some(Node::Expr(e)) => {
602 ExprKind::Closure(..) => true,
610 /// If there is some error when walking the parents (e.g., a node does not
611 /// have a parent in the map or a node can't be found), then we return the
612 /// last good node id we found. Note that reaching the crate root (id == 0),
613 /// is not an error, since items in the crate module have the crate root as
615 fn walk_parent_nodes<F, F2>(&self,
619 -> Result<NodeId, NodeId>
620 where F: Fn(&Node<'hir>) -> bool, F2: Fn(&Node<'hir>) -> bool
622 let mut id = start_id;
624 let parent_node = self.get_parent_node(id);
625 if parent_node == CRATE_NODE_ID {
626 return Ok(CRATE_NODE_ID);
628 if parent_node == id {
632 if let Some(entry) = self.find_entry(parent_node) {
633 if let Node::Crate = entry.node {
636 if found(&entry.node) {
637 return Ok(parent_node);
638 } else if bail_early(&entry.node) {
639 return Err(parent_node);
648 /// Retrieve the NodeId for `id`'s enclosing method, unless there's a
649 /// `while` or `loop` before reaching it, as block tail returns are not
650 /// available in them.
653 /// fn foo(x: usize) -> bool {
655 /// true // `get_return_block` gets passed the `id` corresponding
656 /// } else { // to this, it will return `foo`'s `NodeId`.
663 /// fn foo(x: usize) -> bool {
665 /// true // `get_return_block` gets passed the `id` corresponding
666 /// } // to this, it will return `None`.
670 pub fn get_return_block(&self, id: NodeId) -> Option<NodeId> {
671 let match_fn = |node: &Node| {
674 Node::ForeignItem(_) |
676 Node::ImplItem(_) => true,
680 let match_non_returning_block = |node: &Node| {
682 Node::Expr(ref expr) => {
684 ExprKind::While(..) | ExprKind::Loop(..) => true,
692 self.walk_parent_nodes(id, match_fn, match_non_returning_block).ok()
695 /// Retrieve the NodeId for `id`'s parent item, or `id` itself if no
696 /// parent item is in this map. The "parent item" is the closest parent node
697 /// in the HIR which is recorded by the map and is an item, either an item
698 /// in a module, trait, or impl.
699 pub fn get_parent(&self, id: NodeId) -> NodeId {
700 match self.walk_parent_nodes(id, |node| match *node {
702 Node::ForeignItem(_) |
704 Node::ImplItem(_) => true,
712 /// Returns the NodeId of `id`'s nearest module parent, or `id` itself if no
713 /// module parent is in this map.
714 pub fn get_module_parent(&self, id: NodeId) -> DefId {
715 let id = match self.walk_parent_nodes(id, |node| match *node {
716 Node::Item(&Item { node: ItemKind::Mod(_), .. }) => true,
722 self.local_def_id(id)
725 /// Returns the nearest enclosing scope. A scope is an item or block.
726 /// FIXME it is not clear to me that all items qualify as scopes - statics
727 /// and associated types probably shouldn't, for example. Behavior in this
728 /// regard should be expected to be highly unstable.
729 pub fn get_enclosing_scope(&self, id: NodeId) -> Option<NodeId> {
730 self.walk_parent_nodes(id, |node| match *node {
732 Node::ForeignItem(_) |
735 Node::Block(_) => true,
740 pub fn get_parent_did(&self, id: NodeId) -> DefId {
741 self.local_def_id(self.get_parent(id))
744 pub fn get_foreign_abi(&self, id: NodeId) -> Abi {
745 let parent = self.get_parent(id);
746 if let Some(entry) = self.find_entry(parent) {
748 node: Node::Item(Item { node: ItemKind::ForeignMod(ref nm), .. }), .. } = entry
750 self.read(id); // reveals some of the content of a node
754 bug!("expected foreign mod or inlined parent, found {}", self.node_to_string(parent))
757 pub fn expect_item(&self, id: NodeId) -> &'hir Item {
758 match self.find(id) { // read recorded by `find`
759 Some(Node::Item(item)) => item,
760 _ => bug!("expected item, found {}", self.node_to_string(id))
764 pub fn expect_impl_item(&self, id: NodeId) -> &'hir ImplItem {
765 match self.find(id) {
766 Some(Node::ImplItem(item)) => item,
767 _ => bug!("expected impl item, found {}", self.node_to_string(id))
771 pub fn expect_trait_item(&self, id: NodeId) -> &'hir TraitItem {
772 match self.find(id) {
773 Some(Node::TraitItem(item)) => item,
774 _ => bug!("expected trait item, found {}", self.node_to_string(id))
778 pub fn expect_variant_data(&self, id: NodeId) -> &'hir VariantData {
779 match self.find(id) {
780 Some(Node::Item(i)) => {
782 ItemKind::Struct(ref struct_def, _) |
783 ItemKind::Union(ref struct_def, _) => struct_def,
784 _ => bug!("struct ID bound to non-struct {}", self.node_to_string(id))
787 Some(Node::StructCtor(data)) => data,
788 Some(Node::Variant(variant)) => &variant.node.data,
789 _ => bug!("expected struct or variant, found {}", self.node_to_string(id))
793 pub fn expect_variant(&self, id: NodeId) -> &'hir Variant {
794 match self.find(id) {
795 Some(Node::Variant(variant)) => variant,
796 _ => bug!("expected variant, found {}", self.node_to_string(id)),
800 pub fn expect_foreign_item(&self, id: NodeId) -> &'hir ForeignItem {
801 match self.find(id) {
802 Some(Node::ForeignItem(item)) => item,
803 _ => bug!("expected foreign item, found {}", self.node_to_string(id))
807 pub fn expect_expr(&self, id: NodeId) -> &'hir Expr {
808 match self.find(id) { // read recorded by find
809 Some(Node::Expr(expr)) => expr,
810 _ => bug!("expected expr, found {}", self.node_to_string(id))
814 /// Returns the name associated with the given NodeId's AST.
815 pub fn name(&self, id: NodeId) -> Name {
817 Node::Item(i) => i.name,
818 Node::ForeignItem(i) => i.name,
819 Node::ImplItem(ii) => ii.ident.name,
820 Node::TraitItem(ti) => ti.ident.name,
821 Node::Variant(v) => v.node.name,
822 Node::Field(f) => f.ident.name,
823 Node::Lifetime(lt) => lt.name.ident().name,
824 Node::GenericParam(param) => param.name.ident().name,
825 Node::Binding(&Pat { node: PatKind::Binding(_,_,l,_), .. }) => l.name,
826 Node::StructCtor(_) => self.name(self.get_parent(id)),
827 _ => bug!("no name for {}", self.node_to_string(id))
831 /// Given a node ID, get a list of attributes associated with the AST
832 /// corresponding to the Node ID
833 pub fn attrs(&self, id: NodeId) -> &'hir [ast::Attribute] {
834 self.read(id); // reveals attributes on the node
835 let attrs = match self.find(id) {
836 Some(Node::Item(i)) => Some(&i.attrs[..]),
837 Some(Node::ForeignItem(fi)) => Some(&fi.attrs[..]),
838 Some(Node::TraitItem(ref ti)) => Some(&ti.attrs[..]),
839 Some(Node::ImplItem(ref ii)) => Some(&ii.attrs[..]),
840 Some(Node::Variant(ref v)) => Some(&v.node.attrs[..]),
841 Some(Node::Field(ref f)) => Some(&f.attrs[..]),
842 Some(Node::Expr(ref e)) => Some(&*e.attrs),
843 Some(Node::Stmt(ref s)) => Some(s.node.attrs()),
844 Some(Node::GenericParam(param)) => Some(¶m.attrs[..]),
845 // unit/tuple structs take the attributes straight from
846 // the struct definition.
847 Some(Node::StructCtor(_)) => return self.attrs(self.get_parent(id)),
853 /// Returns an iterator that yields the node id's with paths that
854 /// match `parts`. (Requires `parts` is non-empty.)
856 /// For example, if given `parts` equal to `["bar", "quux"]`, then
857 /// the iterator will produce node id's for items with paths
858 /// such as `foo::bar::quux`, `bar::quux`, `other::bar::quux`, and
859 /// any other such items it can find in the map.
860 pub fn nodes_matching_suffix<'a>(&'a self, parts: &'a [String])
861 -> NodesMatchingSuffix<'a, 'hir> {
862 NodesMatchingSuffix {
864 item_name: parts.last().unwrap(),
865 in_which: &parts[..parts.len() - 1],
870 pub fn span(&self, id: NodeId) -> Span {
871 self.read(id); // reveals span from node
872 match self.find_entry(id).map(|entry| entry.node) {
873 Some(Node::Item(item)) => item.span,
874 Some(Node::ForeignItem(foreign_item)) => foreign_item.span,
875 Some(Node::TraitItem(trait_method)) => trait_method.span,
876 Some(Node::ImplItem(impl_item)) => impl_item.span,
877 Some(Node::Variant(variant)) => variant.span,
878 Some(Node::Field(field)) => field.span,
879 Some(Node::AnonConst(constant)) => self.body(constant.body).value.span,
880 Some(Node::Expr(expr)) => expr.span,
881 Some(Node::Stmt(stmt)) => stmt.span,
882 Some(Node::Ty(ty)) => ty.span,
883 Some(Node::TraitRef(tr)) => tr.path.span,
884 Some(Node::Binding(pat)) => pat.span,
885 Some(Node::Pat(pat)) => pat.span,
886 Some(Node::Block(block)) => block.span,
887 Some(Node::StructCtor(_)) => self.expect_item(self.get_parent(id)).span,
888 Some(Node::Lifetime(lifetime)) => lifetime.span,
889 Some(Node::GenericParam(param)) => param.span,
890 Some(Node::Visibility(&Spanned {
891 node: VisibilityKind::Restricted { ref path, .. }, ..
893 Some(Node::Visibility(v)) => bug!("unexpected Visibility {:?}", v),
894 Some(Node::Local(local)) => local.span,
895 Some(Node::MacroDef(macro_def)) => macro_def.span,
896 Some(Node::Crate) => self.forest.krate.span,
897 None => bug!("hir::map::Map::span: id not in map: {:?}", id),
901 pub fn span_if_local(&self, id: DefId) -> Option<Span> {
902 self.as_local_node_id(id).map(|id| self.span(id))
905 pub fn node_to_string(&self, id: NodeId) -> String {
906 node_id_to_string(self, id, true)
909 pub fn node_to_user_string(&self, id: NodeId) -> String {
910 node_id_to_string(self, id, false)
913 pub fn node_to_pretty_string(&self, id: NodeId) -> String {
914 print::to_string(self, |s| s.print_node(self.get(id)))
918 pub struct NodesMatchingSuffix<'a, 'hir:'a> {
920 item_name: &'a String,
921 in_which: &'a [String],
925 impl<'a, 'hir> NodesMatchingSuffix<'a, 'hir> {
926 /// Returns true only if some suffix of the module path for parent
927 /// matches `self.in_which`.
929 /// In other words: let `[x_0,x_1,...,x_k]` be `self.in_which`;
930 /// returns true if parent's path ends with the suffix
931 /// `x_0::x_1::...::x_k`.
932 fn suffix_matches(&self, parent: NodeId) -> bool {
933 let mut cursor = parent;
934 for part in self.in_which.iter().rev() {
935 let (mod_id, mod_name) = match find_first_mod_parent(self.map, cursor) {
936 None => return false,
937 Some((node_id, name)) => (node_id, name),
939 if mod_name != &**part {
942 cursor = self.map.get_parent(mod_id);
946 // Finds the first mod in parent chain for `id`, along with
949 // If `id` itself is a mod named `m` with parent `p`, then
950 // returns `Some(id, m, p)`. If `id` has no mod in its parent
951 // chain, then returns `None`.
952 fn find_first_mod_parent<'a>(map: &'a Map, mut id: NodeId) -> Option<(NodeId, Name)> {
954 if let Node::Item(item) = map.find(id)? {
955 if item_is_mod(&item) {
956 return Some((id, item.name))
959 let parent = map.get_parent(id);
960 if parent == id { return None }
964 fn item_is_mod(item: &Item) -> bool {
966 ItemKind::Mod(_) => true,
973 // We are looking at some node `n` with a given name and parent
974 // id; do their names match what I am seeking?
975 fn matches_names(&self, parent_of_n: NodeId, name: Name) -> bool {
976 name == &**self.item_name && self.suffix_matches(parent_of_n)
980 impl<'a, 'hir> Iterator for NodesMatchingSuffix<'a, 'hir> {
983 fn next(&mut self) -> Option<NodeId> {
986 if idx.as_usize() >= self.map.entry_count() {
989 self.idx = NodeId::from_u32(self.idx.as_u32() + 1);
990 let name = match self.map.find_entry(idx).map(|entry| entry.node) {
991 Some(Node::Item(n)) => n.name(),
992 Some(Node::ForeignItem(n)) => n.name(),
993 Some(Node::TraitItem(n)) => n.name(),
994 Some(Node::ImplItem(n)) => n.name(),
995 Some(Node::Variant(n)) => n.name(),
996 Some(Node::Field(n)) => n.name(),
999 if self.matches_names(self.map.get_parent(idx), name) {
1007 fn name(&self) -> Name;
1010 impl<T:Named> Named for Spanned<T> { fn name(&self) -> Name { self.node.name() } }
1012 impl Named for Item { fn name(&self) -> Name { self.name } }
1013 impl Named for ForeignItem { fn name(&self) -> Name { self.name } }
1014 impl Named for VariantKind { fn name(&self) -> Name { self.name } }
1015 impl Named for StructField { fn name(&self) -> Name { self.ident.name } }
1016 impl Named for TraitItem { fn name(&self) -> Name { self.ident.name } }
1017 impl Named for ImplItem { fn name(&self) -> Name { self.ident.name } }
1019 pub fn map_crate<'hir>(sess: &::session::Session,
1020 cstore: &dyn CrateStore,
1021 forest: &'hir mut Forest,
1022 definitions: &'hir Definitions)
1024 let (map, crate_hash) = {
1025 let hcx = ::ich::StableHashingContext::new(sess, &forest.krate, definitions, cstore);
1027 let mut collector = NodeCollector::root(&forest.krate,
1031 intravisit::walk_crate(&mut collector, &forest.krate);
1033 let crate_disambiguator = sess.local_crate_disambiguator();
1034 let cmdline_args = sess.opts.dep_tracking_hash();
1035 collector.finalize_and_compute_crate_hash(crate_disambiguator,
1041 if log_enabled!(::log::Level::Debug) {
1042 // This only makes sense for ordered stores; note the
1043 // enumerate to count the number of entries.
1044 let (entries_less_1, _) = map.iter().filter_map(|x| *x).enumerate().last()
1045 .expect("AST map was empty after folding?");
1047 let entries = entries_less_1 + 1;
1048 let vector_length = map.len();
1049 debug!("The AST map has {} entries with a maximum of {}: occupancy {:.1}%",
1050 entries, vector_length, (entries as f64 / vector_length as f64) * 100.);
1053 // Build the reverse mapping of `node_to_hir_id`.
1054 let hir_to_node_id = definitions.node_to_hir_id.iter_enumerated()
1055 .map(|(node_id, &hir_id)| (hir_id, node_id)).collect();
1059 dep_graph: forest.dep_graph.clone(),
1066 hir_id_validator::check_crate(&map);
1071 /// Identical to the `PpAnn` implementation for `hir::Crate`,
1072 /// except it avoids creating a dependency on the whole crate.
1073 impl<'hir> print::PpAnn for Map<'hir> {
1074 fn nested(&self, state: &mut print::State, nested: print::Nested) -> io::Result<()> {
1076 Nested::Item(id) => state.print_item(self.expect_item(id.id)),
1077 Nested::TraitItem(id) => state.print_trait_item(self.trait_item(id)),
1078 Nested::ImplItem(id) => state.print_impl_item(self.impl_item(id)),
1079 Nested::Body(id) => state.print_expr(&self.body(id).value),
1080 Nested::BodyArgPat(id, i) => state.print_pat(&self.body(id).arguments[i].pat)
1085 impl<'a> print::State<'a> {
1086 pub fn print_node(&mut self, node: Node) -> io::Result<()> {
1088 Node::Item(a) => self.print_item(&a),
1089 Node::ForeignItem(a) => self.print_foreign_item(&a),
1090 Node::TraitItem(a) => self.print_trait_item(a),
1091 Node::ImplItem(a) => self.print_impl_item(a),
1092 Node::Variant(a) => self.print_variant(&a),
1093 Node::AnonConst(a) => self.print_anon_const(&a),
1094 Node::Expr(a) => self.print_expr(&a),
1095 Node::Stmt(a) => self.print_stmt(&a),
1096 Node::Ty(a) => self.print_type(&a),
1097 Node::TraitRef(a) => self.print_trait_ref(&a),
1099 Node::Pat(a) => self.print_pat(&a),
1101 use syntax::print::pprust::PrintState;
1103 // containing cbox, will be closed by print-block at }
1104 self.cbox(print::indent_unit)?;
1105 // head-ibox, will be closed by print-block after {
1107 self.print_block(&a)
1109 Node::Lifetime(a) => self.print_lifetime(&a),
1110 Node::Visibility(a) => self.print_visibility(&a),
1111 Node::GenericParam(_) => bug!("cannot print Node::GenericParam"),
1112 Node::Field(_) => bug!("cannot print StructField"),
1113 // these cases do not carry enough information in the
1114 // hir_map to reconstruct their full structure for pretty
1116 Node::StructCtor(_) => bug!("cannot print isolated StructCtor"),
1117 Node::Local(a) => self.print_local_decl(&a),
1118 Node::MacroDef(_) => bug!("cannot print MacroDef"),
1119 Node::Crate => bug!("cannot print Crate"),
1124 fn node_id_to_string(map: &Map, id: NodeId, include_id: bool) -> String {
1125 let id_str = format!(" (id={})", id);
1126 let id_str = if include_id { &id_str[..] } else { "" };
1129 // This functionality is used for debugging, try to use TyCtxt to get
1130 // the user-friendly path, otherwise fall back to stringifying DefPath.
1131 ::ty::tls::with_opt(|tcx| {
1132 if let Some(tcx) = tcx {
1133 tcx.node_path_str(id)
1134 } else if let Some(path) = map.def_path_from_id(id) {
1135 path.data.into_iter().map(|elem| {
1136 elem.data.to_string()
1137 }).collect::<Vec<_>>().join("::")
1139 String::from("<missing path>")
1144 match map.find(id) {
1145 Some(Node::Item(item)) => {
1146 let item_str = match item.node {
1147 ItemKind::ExternCrate(..) => "extern crate",
1148 ItemKind::Use(..) => "use",
1149 ItemKind::Static(..) => "static",
1150 ItemKind::Const(..) => "const",
1151 ItemKind::Fn(..) => "fn",
1152 ItemKind::Mod(..) => "mod",
1153 ItemKind::ForeignMod(..) => "foreign mod",
1154 ItemKind::GlobalAsm(..) => "global asm",
1155 ItemKind::Ty(..) => "ty",
1156 ItemKind::Existential(..) => "existential type",
1157 ItemKind::Enum(..) => "enum",
1158 ItemKind::Struct(..) => "struct",
1159 ItemKind::Union(..) => "union",
1160 ItemKind::Trait(..) => "trait",
1161 ItemKind::TraitAlias(..) => "trait alias",
1162 ItemKind::Impl(..) => "impl",
1164 format!("{} {}{}", item_str, path_str(), id_str)
1166 Some(Node::ForeignItem(_)) => {
1167 format!("foreign item {}{}", path_str(), id_str)
1169 Some(Node::ImplItem(ii)) => {
1171 ImplItemKind::Const(..) => {
1172 format!("assoc const {} in {}{}", ii.ident, path_str(), id_str)
1174 ImplItemKind::Method(..) => {
1175 format!("method {} in {}{}", ii.ident, path_str(), id_str)
1177 ImplItemKind::Type(_) => {
1178 format!("assoc type {} in {}{}", ii.ident, path_str(), id_str)
1180 ImplItemKind::Existential(_) => {
1181 format!("assoc existential type {} in {}{}", ii.ident, path_str(), id_str)
1185 Some(Node::TraitItem(ti)) => {
1186 let kind = match ti.node {
1187 TraitItemKind::Const(..) => "assoc constant",
1188 TraitItemKind::Method(..) => "trait method",
1189 TraitItemKind::Type(..) => "assoc type",
1192 format!("{} {} in {}{}", kind, ti.ident, path_str(), id_str)
1194 Some(Node::Variant(ref variant)) => {
1195 format!("variant {} in {}{}",
1199 Some(Node::Field(ref field)) => {
1200 format!("field {} in {}{}",
1204 Some(Node::AnonConst(_)) => {
1205 format!("const {}{}", map.node_to_pretty_string(id), id_str)
1207 Some(Node::Expr(_)) => {
1208 format!("expr {}{}", map.node_to_pretty_string(id), id_str)
1210 Some(Node::Stmt(_)) => {
1211 format!("stmt {}{}", map.node_to_pretty_string(id), id_str)
1213 Some(Node::Ty(_)) => {
1214 format!("type {}{}", map.node_to_pretty_string(id), id_str)
1216 Some(Node::TraitRef(_)) => {
1217 format!("trait_ref {}{}", map.node_to_pretty_string(id), id_str)
1219 Some(Node::Binding(_)) => {
1220 format!("local {}{}", map.node_to_pretty_string(id), id_str)
1222 Some(Node::Pat(_)) => {
1223 format!("pat {}{}", map.node_to_pretty_string(id), id_str)
1225 Some(Node::Block(_)) => {
1226 format!("block {}{}", map.node_to_pretty_string(id), id_str)
1228 Some(Node::Local(_)) => {
1229 format!("local {}{}", map.node_to_pretty_string(id), id_str)
1231 Some(Node::StructCtor(_)) => {
1232 format!("struct_ctor {}{}", path_str(), id_str)
1234 Some(Node::Lifetime(_)) => {
1235 format!("lifetime {}{}", map.node_to_pretty_string(id), id_str)
1237 Some(Node::GenericParam(ref param)) => {
1238 format!("generic_param {:?}{}", param, id_str)
1240 Some(Node::Visibility(ref vis)) => {
1241 format!("visibility {:?}{}", vis, id_str)
1243 Some(Node::MacroDef(_)) => {
1244 format!("macro {}{}", path_str(), id_str)
1246 Some(Node::Crate) => format!("root_crate"),
1247 None => format!("unknown node{}", id_str),
1251 pub fn describe_def(tcx: TyCtxt, def_id: DefId) -> Option<Def> {
1252 if let Some(node_id) = tcx.hir.as_local_node_id(def_id) {
1253 tcx.hir.describe_def(node_id)
1255 bug!("Calling local describe_def query provider for upstream DefId: {:?}",