src/librustc/hir/map/mod.rs

   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.
   4 //
   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.
  10
  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};
  15
  16 use dep_graph::{DepGraph, DepNode, DepKind, DepNodeIndex};
  17
  18 use hir::def_id::{CRATE_DEF_INDEX, DefId, LocalDefId, DefIndexAddressSpace};
  19
  20 use middle::cstore::CrateStore;
  21
  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};
  28
  29 use hir::*;
  30 use hir::print::Nested;
  31 use util::nodemap::FxHashMap;
  32
  33 use std::io;
  34 use std::result::Result::Err;
  35 use ty::TyCtxt;
  36
  37 pub mod blocks;
  38 mod collector;
  39 mod def_collector;
  40 pub mod definitions;
  41 mod hir_id_validator;
  42
  43 pub const ITEM_LIKE_SPACE: DefIndexAddressSpace = DefIndexAddressSpace::Low;
  44 pub const REGULAR_SPACE: DefIndexAddressSpace = DefIndexAddressSpace::High;
  45
  46 /// Represents an entry and its parent NodeId.
  47 #[derive(Copy, Clone, Debug)]
  48 pub struct Entry<'hir> {
  49     parent: NodeId,
  50     dep_node: DepNodeIndex,
  51     node: Node<'hir>,
  52 }
  53
  54 impl<'hir> Entry<'hir> {
  55     fn parent_node(self) -> Option<NodeId> {
  56         match self.node {
  57             Node::Crate | Node::MacroDef(_) => None,
  58             _ => Some(self.parent),
  59         }
  60     }
  61
  62     fn fn_decl(&self) -> Option<&FnDecl> {
  63         match self.node {
  64             Node::Item(ref item) => {
  65                 match item.node {
  66                     ItemKind::Fn(ref fn_decl, _, _, _) => Some(&fn_decl),
  67                     _ => None,
  68                 }
  69             }
  70
  71             Node::TraitItem(ref item) => {
  72                 match item.node {
  73                     TraitItemKind::Method(ref method_sig, _) => Some(&method_sig.decl),
  74                     _ => None
  75                 }
  76             }
  77
  78             Node::ImplItem(ref item) => {
  79                 match item.node {
  80                     ImplItemKind::Method(ref method_sig, _) => Some(&method_sig.decl),
  81                     _ => None,
  82                 }
  83             }
  84
  85             Node::Expr(ref expr) => {
  86                 match expr.node {
  87                     ExprKind::Closure(_, ref fn_decl, ..) => Some(&fn_decl),
  88                     _ => None,
  89                 }
  90             }
  91
  92             _ => None,
  93         }
  94     }
  95
  96     fn associated_body(self) -> Option<BodyId> {
  97         match self.node {
  98             Node::Item(item) => {
  99                 match item.node {
 100                     ItemKind::Const(_, body) |
 101                     ItemKind::Static(.., body) |
 102                     ItemKind::Fn(_, _, _, body) => Some(body),
 103                     _ => None,
 104                 }
 105             }
 106
 107             Node::TraitItem(item) => {
 108                 match item.node {
 109                     TraitItemKind::Const(_, Some(body)) |
 110                     TraitItemKind::Method(_, TraitMethod::Provided(body)) => Some(body),
 111                     _ => None
 112                 }
 113             }
 114
 115             Node::ImplItem(item) => {
 116                 match item.node {
 117                     ImplItemKind::Const(_, body) |
 118                     ImplItemKind::Method(_, body) => Some(body),
 119                     _ => None,
 120                 }
 121             }
 122
 123             Node::AnonConst(constant) => Some(constant.body),
 124
 125             Node::Expr(expr) => {
 126                 match expr.node {
 127                     ExprKind::Closure(.., body, _, _) => Some(body),
 128                     _ => None,
 129                 }
 130             }
 131
 132             _ => None
 133         }
 134     }
 135
 136     fn is_body_owner(self, node_id: NodeId) -> bool {
 137         match self.associated_body() {
 138             Some(b) => b.node_id == node_id,
 139             None => false,
 140         }
 141     }
 142 }
 143
 144 /// Stores a crate and any number of inlined items from other crates.
 145 pub struct Forest {
 146     krate: Crate,
 147     pub dep_graph: DepGraph,
 148 }
 149
 150 impl Forest {
 151     pub fn new(krate: Crate, dep_graph: &DepGraph) -> Forest {
 152         Forest {
 153             krate,
 154             dep_graph: dep_graph.clone(),
 155         }
 156     }
 157
 158     pub fn krate<'hir>(&'hir self) -> &'hir Crate {
 159         self.dep_graph.read(DepNode::new_no_params(DepKind::Krate));
 160         &self.krate
 161     }
 162 }
 163
 164 /// Represents a mapping from Node IDs to AST elements and their parent
 165 /// Node IDs
 166 #[derive(Clone)]
 167 pub struct Map<'hir> {
 168     /// The backing storage for all the AST nodes.
 169     pub forest: &'hir Forest,
 170
 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,
 174
 175     /// The SVH of the local crate.
 176     pub crate_hash: Svh,
 177
 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).
 184     ///
 185     /// Also, indexing is pretty quick when you've got a vector and
 186     /// plain old integers.
 187     map: Vec<Option<Entry<'hir>>>,
 188
 189     definitions: &'hir Definitions,
 190
 191     /// The reverse mapping of `node_to_hir_id`.
 192     hir_to_node_id: FxHashMap<HirId, NodeId>,
 193 }
 194
 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);
 206         } else {
 207             bug!("called `HirMap::read()` with invalid `NodeId`")
 208         }
 209     }
 210
 211     #[inline]
 212     pub fn definitions(&self) -> &'hir Definitions {
 213         self.definitions
 214     }
 215
 216     pub fn def_key(&self, def_id: DefId) -> DefKey {
 217         assert!(def_id.is_local());
 218         self.definitions.def_key(def_id.index)
 219     }
 220
 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)
 224         })
 225     }
 226
 227     pub fn def_path(&self, def_id: DefId) -> DefPath {
 228         assert!(def_id.is_local());
 229         self.definitions.def_path(def_id.index)
 230     }
 231
 232     #[inline]
 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))
 237         })
 238     }
 239
 240     #[inline]
 241     pub fn opt_local_def_id(&self, node: NodeId) -> Option<DefId> {
 242         self.definitions.opt_local_def_id(node)
 243     }
 244
 245     #[inline]
 246     pub fn as_local_node_id(&self, def_id: DefId) -> Option<NodeId> {
 247         self.definitions.as_local_node_id(def_id)
 248     }
 249
 250     #[inline]
 251     pub fn hir_to_node_id(&self, hir_id: HirId) -> NodeId {
 252         self.hir_to_node_id[&hir_id]
 253     }
 254
 255     #[inline]
 256     pub fn node_to_hir_id(&self, node_id: NodeId) -> HirId {
 257         self.definitions.node_to_hir_id(node_id)
 258     }
 259
 260     #[inline]
 261     pub fn def_index_to_hir_id(&self, def_index: DefIndex) -> HirId {
 262         self.definitions.def_index_to_hir_id(def_index)
 263     }
 264
 265     #[inline]
 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()
 268     }
 269
 270     #[inline]
 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)
 273     }
 274
 275     #[inline]
 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()
 278     }
 279
 280     pub fn describe_def(&self, node_id: NodeId) -> Option<Def> {
 281         let node = if let Some(node) = self.find(node_id) {
 282             node
 283         } else {
 284             return None
 285         };
 286
 287         match node {
 288             Node::Item(item) => {
 289                 let def_id = || {
 290                     self.local_def_id(item.id)
 291                 };
 292
 293                 match item.node {
 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)")
 306                     },
 307                     ItemKind::ExternCrate(_) |
 308                     ItemKind::Use(..) |
 309                     ItemKind::ForeignMod(..) |
 310                     ItemKind::GlobalAsm(..) |
 311                     ItemKind::Impl(..) => None,
 312                 }
 313             }
 314             Node::ForeignItem(item) => {
 315                 let def_id = self.local_def_id(item.id);
 316                 match item.node {
 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)),
 320                 }
 321             }
 322             Node::TraitItem(item) => {
 323                 let def_id = self.local_def_id(item.id);
 324                 match item.node {
 325                     TraitItemKind::Const(..) => Some(Def::AssociatedConst(def_id)),
 326                     TraitItemKind::Method(..) => Some(Def::Method(def_id)),
 327                     TraitItemKind::Type(..) => Some(Def::AssociatedTy(def_id)),
 328                 }
 329             }
 330             Node::ImplItem(item) => {
 331                 let def_id = self.local_def_id(item.id);
 332                 match item.node {
 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)),
 337                 }
 338             }
 339             Node::Variant(variant) => {
 340                 let def_id = self.local_def_id(variant.node.data.id());
 341                 Some(Def::Variant(def_id))
 342             }
 343             Node::Field(_) |
 344             Node::AnonConst(_) |
 345             Node::Expr(_) |
 346             Node::Stmt(_) |
 347             Node::Ty(_) |
 348             Node::TraitRef(_) |
 349             Node::Pat(_) |
 350             Node::Binding(_) |
 351             Node::StructCtor(_) |
 352             Node::Lifetime(_) |
 353             Node::Visibility(_) |
 354             Node::Block(_) |
 355             Node::Crate => None,
 356             Node::Local(local) => {
 357                 Some(Def::Local(local.id))
 358             }
 359             Node::MacroDef(macro_def) => {
 360                 Some(Def::Macro(self.local_def_id(macro_def.id),
 361                                 MacroKind::Bang))
 362             }
 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)),
 367                 })
 368             }
 369         }
 370     }
 371
 372     fn entry_count(&self) -> usize {
 373         self.map.len()
 374     }
 375
 376     fn find_entry(&self, id: NodeId) -> Option<Entry<'hir>> {
 377         self.map.get(id.as_usize()).cloned().unwrap_or(None)
 378     }
 379
 380     pub fn krate(&self) -> &'hir Crate {
 381         self.forest.krate()
 382     }
 383
 384     pub fn trait_item(&self, id: TraitItemId) -> &'hir TraitItem {
 385         self.read(id.node_id);
 386
 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)
 390     }
 391
 392     pub fn impl_item(&self, id: ImplItemId) -> &'hir ImplItem {
 393         self.read(id.node_id);
 394
 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)
 398     }
 399
 400     pub fn body(&self, id: BodyId) -> &'hir Body {
 401         self.read(id.node_id);
 402
 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)
 406     }
 407
 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()
 411         } else {
 412             bug!("no entry for node_id `{}`", node_id)
 413         }
 414     }
 415
 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)));
 422         parent
 423     }
 424
 425     pub fn body_owner_def_id(&self, id: BodyId) -> DefId {
 426         self.local_def_id(self.body_owner(id))
 427     }
 428
 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));
 437             }
 438
 439             entry.associated_body()
 440         } else {
 441             bug!("no entry for id `{}`", id)
 442         }
 443     }
 444
 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));
 450         })
 451     }
 452
 453     pub fn body_owner_kind(&self, id: NodeId) -> BodyOwnerKind {
 454         match self.get(id) {
 455             Node::Item(&Item { node: ItemKind::Const(..), .. }) |
 456             Node::TraitItem(&TraitItem { node: TraitItemKind::Const(..), .. }) |
 457             Node::ImplItem(&ImplItem { node: ImplItemKind::Const(..), .. }) |
 458             Node::AnonConst(_) => {
 459                 BodyOwnerKind::Const
 460             }
 461             Node::Item(&Item { node: ItemKind::Static(_, m, _), .. }) => {
 462                 BodyOwnerKind::Static(m)
 463             }
 464             // Default to function if it's not a constant or static.
 465             _ => BodyOwnerKind::Fn
 466         }
 467     }
 468
 469     pub fn ty_param_owner(&self, id: NodeId) -> NodeId {
 470         match self.get(id) {
 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))
 474         }
 475     }
 476
 477     pub fn ty_param_name(&self, id: NodeId) -> Name {
 478         match self.get(id) {
 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)),
 482         }
 483     }
 484
 485     pub fn trait_impls(&self, trait_did: DefId) -> &'hir [NodeId] {
 486         self.dep_graph.read(DepNode::new_no_params(DepKind::AllLocalTraitImpls));
 487
 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[..])
 491     }
 492
 493     pub fn trait_auto_impl(&self, trait_did: DefId) -> Option<NodeId> {
 494         self.dep_graph.read(DepNode::new_no_params(DepKind::AllLocalTraitImpls));
 495
 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()
 499     }
 500
 501     pub fn trait_is_auto(&self, trait_did: DefId) -> bool {
 502         self.trait_auto_impl(trait_did).is_some()
 503     }
 504
 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);
 510
 511         self.dep_graph.read(def_path_hash.to_dep_node(DepKind::Hir));
 512         &self.forest.krate.attrs
 513     }
 514
 515     /// Retrieve the Node corresponding to `id`, panicking if it cannot
 516     /// be found.
 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))
 520     }
 521
 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`
 524     }
 525
 526     pub fn get_generics(&self, id: DefId) -> Option<&'hir Generics> {
 527         self.get_if_local(id).and_then(|node| {
 528             match 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) => {
 532                     match item.node {
 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),
 541                         _ => None,
 542                     }
 543                 }
 544                 _ => None,
 545             }
 546         })
 547     }
 548
 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)
 551     }
 552
 553     /// Retrieve the Node corresponding to `id`, returning None if
 554     /// cannot be found.
 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 {
 558                 None
 559             } else {
 560                 Some(entry.node)
 561             }
 562         });
 563         if result.is_some() {
 564             self.read(id);
 565         }
 566         result
 567     }
 568
 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));
 584         }
 585
 586         self.find_entry(id).and_then(|x| x.parent_node()).unwrap_or(id)
 587     }
 588
 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(_)) => (),
 594             _ => return false,
 595         }
 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)) => {
 601                 match e.node {
 602                     ExprKind::Closure(..) => true,
 603                     _ => false,
 604                 }
 605             }
 606             _ => false,
 607         }
 608     }
 609
 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
 614     /// parent.
 615     fn walk_parent_nodes<F, F2>(&self,
 616                                 start_id: NodeId,
 617                                 found: F,
 618                                 bail_early: F2)
 619         -> Result<NodeId, NodeId>
 620         where F: Fn(&Node<'hir>) -> bool, F2: Fn(&Node<'hir>) -> bool
 621     {
 622         let mut id = start_id;
 623         loop {
 624             let parent_node = self.get_parent_node(id);
 625             if parent_node == CRATE_NODE_ID {
 626                 return Ok(CRATE_NODE_ID);
 627             }
 628             if parent_node == id {
 629                 return Err(id);
 630             }
 631
 632             if let Some(entry) = self.find_entry(parent_node) {
 633                 if let Node::Crate = entry.node {
 634                     return Err(id);
 635                 }
 636                 if found(&entry.node) {
 637                     return Ok(parent_node);
 638                 } else if bail_early(&entry.node) {
 639                     return Err(parent_node);
 640                 }
 641                 id = parent_node;
 642             } else {
 643                 return Err(id);
 644             }
 645         }
 646     }
 647
 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.
 651     ///
 652     /// ```
 653     /// fn foo(x: usize) -> bool {
 654     ///     if x == 1 {
 655     ///         true  // `get_return_block` gets passed the `id` corresponding
 656     ///     } else {  // to this, it will return `foo`'s `NodeId`.
 657     ///         false
 658     ///     }
 659     /// }
 660     /// ```
 661     ///
 662     /// ```
 663     /// fn foo(x: usize) -> bool {
 664     ///     loop {
 665     ///         true  // `get_return_block` gets passed the `id` corresponding
 666     ///     }         // to this, it will return `None`.
 667     ///     false
 668     /// }
 669     /// ```
 670     pub fn get_return_block(&self, id: NodeId) -> Option<NodeId> {
 671         let match_fn = |node: &Node| {
 672             match *node {
 673                 Node::Item(_) |
 674                 Node::ForeignItem(_) |
 675                 Node::TraitItem(_) |
 676                 Node::ImplItem(_) => true,
 677                 _ => false,
 678             }
 679         };
 680         let match_non_returning_block = |node: &Node| {
 681             match *node {
 682                 Node::Expr(ref expr) => {
 683                     match expr.node {
 684                         ExprKind::While(..) | ExprKind::Loop(..) => true,
 685                         _ => false,
 686                     }
 687                 }
 688                 _ => false,
 689             }
 690         };
 691
 692         self.walk_parent_nodes(id, match_fn, match_non_returning_block).ok()
 693     }
 694
 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 {
 701             Node::Item(_) |
 702             Node::ForeignItem(_) |
 703             Node::TraitItem(_) |
 704             Node::ImplItem(_) => true,
 705             _ => false,
 706         }, |_| false) {
 707             Ok(id) => id,
 708             Err(id) => id,
 709         }
 710     }
 711
 712     /// Returns the DefId 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         self.local_def_id(self.get_module_parent_node(id))
 716     }
 717
 718     /// Returns the NodeId of `id`'s nearest module parent, or `id` itself if no
 719     /// module parent is in this map.
 720     pub fn get_module_parent_node(&self, id: NodeId) -> NodeId {
 721         match self.walk_parent_nodes(id, |node| match *node {
 722             Node::Item(&Item { node: ItemKind::Mod(_), .. }) => true,
 723             _ => false,
 724         }, |_| false) {
 725             Ok(id) => id,
 726             Err(id) => id,
 727         }
 728     }
 729
 730     /// Returns the nearest enclosing scope. A scope is an item or block.
 731     /// FIXME it is not clear to me that all items qualify as scopes - statics
 732     /// and associated types probably shouldn't, for example. Behavior in this
 733     /// regard should be expected to be highly unstable.
 734     pub fn get_enclosing_scope(&self, id: NodeId) -> Option<NodeId> {
 735         self.walk_parent_nodes(id, |node| match *node {
 736             Node::Item(_) |
 737             Node::ForeignItem(_) |
 738             Node::TraitItem(_) |
 739             Node::ImplItem(_) |
 740             Node::Block(_) => true,
 741             _ => false,
 742         }, |_| false).ok()
 743     }
 744
 745     pub fn get_parent_did(&self, id: NodeId) -> DefId {
 746         self.local_def_id(self.get_parent(id))
 747     }
 748
 749     pub fn get_foreign_abi(&self, id: NodeId) -> Abi {
 750         let parent = self.get_parent(id);
 751         if let Some(entry) = self.find_entry(parent) {
 752             if let Entry {
 753                 node: Node::Item(Item { node: ItemKind::ForeignMod(ref nm), .. }), .. } = entry
 754             {
 755                 self.read(id); // reveals some of the content of a node
 756                 return nm.abi;
 757             }
 758         }
 759         bug!("expected foreign mod or inlined parent, found {}", self.node_to_string(parent))
 760     }
 761
 762     pub fn expect_item(&self, id: NodeId) -> &'hir Item {
 763         match self.find(id) { // read recorded by `find`
 764             Some(Node::Item(item)) => item,
 765             _ => bug!("expected item, found {}", self.node_to_string(id))
 766         }
 767     }
 768
 769     pub fn expect_impl_item(&self, id: NodeId) -> &'hir ImplItem {
 770         match self.find(id) {
 771             Some(Node::ImplItem(item)) => item,
 772             _ => bug!("expected impl item, found {}", self.node_to_string(id))
 773         }
 774     }
 775
 776     pub fn expect_trait_item(&self, id: NodeId) -> &'hir TraitItem {
 777         match self.find(id) {
 778             Some(Node::TraitItem(item)) => item,
 779             _ => bug!("expected trait item, found {}", self.node_to_string(id))
 780         }
 781     }
 782
 783     pub fn expect_variant_data(&self, id: NodeId) -> &'hir VariantData {
 784         match self.find(id) {
 785             Some(Node::Item(i)) => {
 786                 match i.node {
 787                     ItemKind::Struct(ref struct_def, _) |
 788                     ItemKind::Union(ref struct_def, _) => struct_def,
 789                     _ => bug!("struct ID bound to non-struct {}", self.node_to_string(id))
 790                 }
 791             }
 792             Some(Node::StructCtor(data)) => data,
 793             Some(Node::Variant(variant)) => &variant.node.data,
 794             _ => bug!("expected struct or variant, found {}", self.node_to_string(id))
 795         }
 796     }
 797
 798     pub fn expect_variant(&self, id: NodeId) -> &'hir Variant {
 799         match self.find(id) {
 800             Some(Node::Variant(variant)) => variant,
 801             _ => bug!("expected variant, found {}", self.node_to_string(id)),
 802         }
 803     }
 804
 805     pub fn expect_foreign_item(&self, id: NodeId) -> &'hir ForeignItem {
 806         match self.find(id) {
 807             Some(Node::ForeignItem(item)) => item,
 808             _ => bug!("expected foreign item, found {}", self.node_to_string(id))
 809         }
 810     }
 811
 812     pub fn expect_expr(&self, id: NodeId) -> &'hir Expr {
 813         match self.find(id) { // read recorded by find
 814             Some(Node::Expr(expr)) => expr,
 815             _ => bug!("expected expr, found {}", self.node_to_string(id))
 816         }
 817     }
 818
 819     /// Returns the name associated with the given NodeId's AST.
 820     pub fn name(&self, id: NodeId) -> Name {
 821         match self.get(id) {
 822             Node::Item(i) => i.name,
 823             Node::ForeignItem(i) => i.name,
 824             Node::ImplItem(ii) => ii.ident.name,
 825             Node::TraitItem(ti) => ti.ident.name,
 826             Node::Variant(v) => v.node.name,
 827             Node::Field(f) => f.ident.name,
 828             Node::Lifetime(lt) => lt.name.ident().name,
 829             Node::GenericParam(param) => param.name.ident().name,
 830             Node::Binding(&Pat { node: PatKind::Binding(_,_,l,_), .. }) => l.name,
 831             Node::StructCtor(_) => self.name(self.get_parent(id)),
 832             _ => bug!("no name for {}", self.node_to_string(id))
 833         }
 834     }
 835
 836     /// Given a node ID, get a list of attributes associated with the AST
 837     /// corresponding to the Node ID
 838     pub fn attrs(&self, id: NodeId) -> &'hir [ast::Attribute] {
 839         self.read(id); // reveals attributes on the node
 840         let attrs = match self.find(id) {
 841             Some(Node::Item(i)) => Some(&i.attrs[..]),
 842             Some(Node::ForeignItem(fi)) => Some(&fi.attrs[..]),
 843             Some(Node::TraitItem(ref ti)) => Some(&ti.attrs[..]),
 844             Some(Node::ImplItem(ref ii)) => Some(&ii.attrs[..]),
 845             Some(Node::Variant(ref v)) => Some(&v.node.attrs[..]),
 846             Some(Node::Field(ref f)) => Some(&f.attrs[..]),
 847             Some(Node::Expr(ref e)) => Some(&*e.attrs),
 848             Some(Node::Stmt(ref s)) => Some(s.node.attrs()),
 849             Some(Node::GenericParam(param)) => Some(&param.attrs[..]),
 850             // unit/tuple structs take the attributes straight from
 851             // the struct definition.
 852             Some(Node::StructCtor(_)) => return self.attrs(self.get_parent(id)),
 853             _ => None
 854         };
 855         attrs.unwrap_or(&[])
 856     }
 857
 858     /// Returns an iterator that yields the node id's with paths that
 859     /// match `parts`.  (Requires `parts` is non-empty.)
 860     ///
 861     /// For example, if given `parts` equal to `["bar", "quux"]`, then
 862     /// the iterator will produce node id's for items with paths
 863     /// such as `foo::bar::quux`, `bar::quux`, `other::bar::quux`, and
 864     /// any other such items it can find in the map.
 865     pub fn nodes_matching_suffix<'a>(&'a self, parts: &'a [String])
 866                                  -> NodesMatchingSuffix<'a, 'hir> {
 867         NodesMatchingSuffix {
 868             map: self,
 869             item_name: parts.last().unwrap(),
 870             in_which: &parts[..parts.len() - 1],
 871             idx: CRATE_NODE_ID,
 872         }
 873     }
 874
 875     pub fn span(&self, id: NodeId) -> Span {
 876         self.read(id); // reveals span from node
 877         match self.find_entry(id).map(|entry| entry.node) {
 878             Some(Node::Item(item)) => item.span,
 879             Some(Node::ForeignItem(foreign_item)) => foreign_item.span,
 880             Some(Node::TraitItem(trait_method)) => trait_method.span,
 881             Some(Node::ImplItem(impl_item)) => impl_item.span,
 882             Some(Node::Variant(variant)) => variant.span,
 883             Some(Node::Field(field)) => field.span,
 884             Some(Node::AnonConst(constant)) => self.body(constant.body).value.span,
 885             Some(Node::Expr(expr)) => expr.span,
 886             Some(Node::Stmt(stmt)) => stmt.span,
 887             Some(Node::Ty(ty)) => ty.span,
 888             Some(Node::TraitRef(tr)) => tr.path.span,
 889             Some(Node::Binding(pat)) => pat.span,
 890             Some(Node::Pat(pat)) => pat.span,
 891             Some(Node::Block(block)) => block.span,
 892             Some(Node::StructCtor(_)) => self.expect_item(self.get_parent(id)).span,
 893             Some(Node::Lifetime(lifetime)) => lifetime.span,
 894             Some(Node::GenericParam(param)) => param.span,
 895             Some(Node::Visibility(&Spanned {
 896                 node: VisibilityKind::Restricted { ref path, .. }, ..
 897             })) => path.span,
 898             Some(Node::Visibility(v)) => bug!("unexpected Visibility {:?}", v),
 899             Some(Node::Local(local)) => local.span,
 900             Some(Node::MacroDef(macro_def)) => macro_def.span,
 901             Some(Node::Crate) => self.forest.krate.span,
 902             None => bug!("hir::map::Map::span: id not in map: {:?}", id),
 903         }
 904     }
 905
 906     pub fn span_if_local(&self, id: DefId) -> Option<Span> {
 907         self.as_local_node_id(id).map(|id| self.span(id))
 908     }
 909
 910     pub fn node_to_string(&self, id: NodeId) -> String {
 911         node_id_to_string(self, id, true)
 912     }
 913
 914     pub fn node_to_user_string(&self, id: NodeId) -> String {
 915         node_id_to_string(self, id, false)
 916     }
 917
 918     pub fn node_to_pretty_string(&self, id: NodeId) -> String {
 919         print::to_string(self, |s| s.print_node(self.get(id)))
 920     }
 921 }
 922
 923 pub struct NodesMatchingSuffix<'a, 'hir:'a> {
 924     map: &'a Map<'hir>,
 925     item_name: &'a String,
 926     in_which: &'a [String],
 927     idx: NodeId,
 928 }
 929
 930 impl<'a, 'hir> NodesMatchingSuffix<'a, 'hir> {
 931     /// Returns true only if some suffix of the module path for parent
 932     /// matches `self.in_which`.
 933     ///
 934     /// In other words: let `[x_0,x_1,...,x_k]` be `self.in_which`;
 935     /// returns true if parent's path ends with the suffix
 936     /// `x_0::x_1::...::x_k`.
 937     fn suffix_matches(&self, parent: NodeId) -> bool {
 938         let mut cursor = parent;
 939         for part in self.in_which.iter().rev() {
 940             let (mod_id, mod_name) = match find_first_mod_parent(self.map, cursor) {
 941                 None => return false,
 942                 Some((node_id, name)) => (node_id, name),
 943             };
 944             if mod_name != &**part {
 945                 return false;
 946             }
 947             cursor = self.map.get_parent(mod_id);
 948         }
 949         return true;
 950
 951         // Finds the first mod in parent chain for `id`, along with
 952         // that mod's name.
 953         //
 954         // If `id` itself is a mod named `m` with parent `p`, then
 955         // returns `Some(id, m, p)`.  If `id` has no mod in its parent
 956         // chain, then returns `None`.
 957         fn find_first_mod_parent<'a>(map: &'a Map, mut id: NodeId) -> Option<(NodeId, Name)> {
 958             loop {
 959                 if let Node::Item(item) = map.find(id)? {
 960                     if item_is_mod(&item) {
 961                         return Some((id, item.name))
 962                     }
 963                 }
 964                 let parent = map.get_parent(id);
 965                 if parent == id { return None }
 966                 id = parent;
 967             }
 968
 969             fn item_is_mod(item: &Item) -> bool {
 970                 match item.node {
 971                     ItemKind::Mod(_) => true,
 972                     _ => false,
 973                 }
 974             }
 975         }
 976     }
 977
 978     // We are looking at some node `n` with a given name and parent
 979     // id; do their names match what I am seeking?
 980     fn matches_names(&self, parent_of_n: NodeId, name: Name) -> bool {
 981         name == &**self.item_name && self.suffix_matches(parent_of_n)
 982     }
 983 }
 984
 985 impl<'a, 'hir> Iterator for NodesMatchingSuffix<'a, 'hir> {
 986     type Item = NodeId;
 987
 988     fn next(&mut self) -> Option<NodeId> {
 989         loop {
 990             let idx = self.idx;
 991             if idx.as_usize() >= self.map.entry_count() {
 992                 return None;
 993             }
 994             self.idx = NodeId::from_u32(self.idx.as_u32() + 1);
 995             let name = match self.map.find_entry(idx).map(|entry| entry.node) {
 996                 Some(Node::Item(n)) => n.name(),
 997                 Some(Node::ForeignItem(n)) => n.name(),
 998                 Some(Node::TraitItem(n)) => n.name(),
 999                 Some(Node::ImplItem(n)) => n.name(),
1000                 Some(Node::Variant(n)) => n.name(),
1001                 Some(Node::Field(n)) => n.name(),
1002                 _ => continue,
1003             };
1004             if self.matches_names(self.map.get_parent(idx), name) {
1005                 return Some(idx)
1006             }
1007         }
1008     }
1009 }
1010
1011 trait Named {
1012     fn name(&self) -> Name;
1013 }
1014
1015 impl<T:Named> Named for Spanned<T> { fn name(&self) -> Name { self.node.name() } }
1016
1017 impl Named for Item { fn name(&self) -> Name { self.name } }
1018 impl Named for ForeignItem { fn name(&self) -> Name { self.name } }
1019 impl Named for VariantKind { fn name(&self) -> Name { self.name } }
1020 impl Named for StructField { fn name(&self) -> Name { self.ident.name } }
1021 impl Named for TraitItem { fn name(&self) -> Name { self.ident.name } }
1022 impl Named for ImplItem { fn name(&self) -> Name { self.ident.name } }
1023
1024 pub fn map_crate<'hir>(sess: &::session::Session,
1025                        cstore: &dyn CrateStore,
1026                        forest: &'hir mut Forest,
1027                        definitions: &'hir Definitions)
1028                        -> Map<'hir> {
1029     let (map, crate_hash) = {
1030         let hcx = ::ich::StableHashingContext::new(sess, &forest.krate, definitions, cstore);
1031
1032         let mut collector = NodeCollector::root(&forest.krate,
1033                                                 &forest.dep_graph,
1034                                                 &definitions,
1035                                                 hcx);
1036         intravisit::walk_crate(&mut collector, &forest.krate);
1037
1038         let crate_disambiguator = sess.local_crate_disambiguator();
1039         let cmdline_args = sess.opts.dep_tracking_hash();
1040         collector.finalize_and_compute_crate_hash(crate_disambiguator,
1041                                                   cstore,
1042                                                   sess.source_map(),
1043                                                   cmdline_args)
1044     };
1045
1046     if log_enabled!(::log::Level::Debug) {
1047         // This only makes sense for ordered stores; note the
1048         // enumerate to count the number of entries.
1049         let (entries_less_1, _) = map.iter().filter_map(|x| *x).enumerate().last()
1050             .expect("AST map was empty after folding?");
1051
1052         let entries = entries_less_1 + 1;
1053         let vector_length = map.len();
1054         debug!("The AST map has {} entries with a maximum of {}: occupancy {:.1}%",
1055               entries, vector_length, (entries as f64 / vector_length as f64) * 100.);
1056     }
1057
1058     // Build the reverse mapping of `node_to_hir_id`.
1059     let hir_to_node_id = definitions.node_to_hir_id.iter_enumerated()
1060         .map(|(node_id, &hir_id)| (hir_id, node_id)).collect();
1061
1062     let map = Map {
1063         forest,
1064         dep_graph: forest.dep_graph.clone(),
1065         crate_hash,
1066         map,
1067         hir_to_node_id,
1068         definitions,
1069     };
1070
1071     hir_id_validator::check_crate(&map);
1072
1073     map
1074 }
1075
1076 /// Identical to the `PpAnn` implementation for `hir::Crate`,
1077 /// except it avoids creating a dependency on the whole crate.
1078 impl<'hir> print::PpAnn for Map<'hir> {
1079     fn nested(&self, state: &mut print::State, nested: print::Nested) -> io::Result<()> {
1080         match nested {
1081             Nested::Item(id) => state.print_item(self.expect_item(id.id)),
1082             Nested::TraitItem(id) => state.print_trait_item(self.trait_item(id)),
1083             Nested::ImplItem(id) => state.print_impl_item(self.impl_item(id)),
1084             Nested::Body(id) => state.print_expr(&self.body(id).value),
1085             Nested::BodyArgPat(id, i) => state.print_pat(&self.body(id).arguments[i].pat)
1086         }
1087     }
1088 }
1089
1090 impl<'a> print::State<'a> {
1091     pub fn print_node(&mut self, node: Node) -> io::Result<()> {
1092         match node {
1093             Node::Item(a)         => self.print_item(&a),
1094             Node::ForeignItem(a)  => self.print_foreign_item(&a),
1095             Node::TraitItem(a)    => self.print_trait_item(a),
1096             Node::ImplItem(a)     => self.print_impl_item(a),
1097             Node::Variant(a)      => self.print_variant(&a),
1098             Node::AnonConst(a)    => self.print_anon_const(&a),
1099             Node::Expr(a)         => self.print_expr(&a),
1100             Node::Stmt(a)         => self.print_stmt(&a),
1101             Node::Ty(a)           => self.print_type(&a),
1102             Node::TraitRef(a)     => self.print_trait_ref(&a),
1103             Node::Binding(a)      |
1104             Node::Pat(a)          => self.print_pat(&a),
1105             Node::Block(a)        => {
1106                 use syntax::print::pprust::PrintState;
1107
1108                 // containing cbox, will be closed by print-block at }
1109                 self.cbox(print::indent_unit)?;
1110                 // head-ibox, will be closed by print-block after {
1111                 self.ibox(0)?;
1112                 self.print_block(&a)
1113             }
1114             Node::Lifetime(a)     => self.print_lifetime(&a),
1115             Node::Visibility(a)   => self.print_visibility(&a),
1116             Node::GenericParam(_) => bug!("cannot print Node::GenericParam"),
1117             Node::Field(_)        => bug!("cannot print StructField"),
1118             // these cases do not carry enough information in the
1119             // hir_map to reconstruct their full structure for pretty
1120             // printing.
1121             Node::StructCtor(_)   => bug!("cannot print isolated StructCtor"),
1122             Node::Local(a)        => self.print_local_decl(&a),
1123             Node::MacroDef(_)     => bug!("cannot print MacroDef"),
1124             Node::Crate           => bug!("cannot print Crate"),
1125         }
1126     }
1127 }
1128
1129 fn node_id_to_string(map: &Map, id: NodeId, include_id: bool) -> String {
1130     let id_str = format!(" (id={})", id);
1131     let id_str = if include_id { &id_str[..] } else { "" };
1132
1133     let path_str = || {
1134         // This functionality is used for debugging, try to use TyCtxt to get
1135         // the user-friendly path, otherwise fall back to stringifying DefPath.
1136         ::ty::tls::with_opt(|tcx| {
1137             if let Some(tcx) = tcx {
1138                 tcx.node_path_str(id)
1139             } else if let Some(path) = map.def_path_from_id(id) {
1140                 path.data.into_iter().map(|elem| {
1141                     elem.data.to_string()
1142                 }).collect::<Vec<_>>().join("::")
1143             } else {
1144                 String::from("<missing path>")
1145             }
1146         })
1147     };
1148
1149     match map.find(id) {
1150         Some(Node::Item(item)) => {
1151             let item_str = match item.node {
1152                 ItemKind::ExternCrate(..) => "extern crate",
1153                 ItemKind::Use(..) => "use",
1154                 ItemKind::Static(..) => "static",
1155                 ItemKind::Const(..) => "const",
1156                 ItemKind::Fn(..) => "fn",
1157                 ItemKind::Mod(..) => "mod",
1158                 ItemKind::ForeignMod(..) => "foreign mod",
1159                 ItemKind::GlobalAsm(..) => "global asm",
1160                 ItemKind::Ty(..) => "ty",
1161                 ItemKind::Existential(..) => "existential type",
1162                 ItemKind::Enum(..) => "enum",
1163                 ItemKind::Struct(..) => "struct",
1164                 ItemKind::Union(..) => "union",
1165                 ItemKind::Trait(..) => "trait",
1166                 ItemKind::TraitAlias(..) => "trait alias",
1167                 ItemKind::Impl(..) => "impl",
1168             };
1169             format!("{} {}{}", item_str, path_str(), id_str)
1170         }
1171         Some(Node::ForeignItem(_)) => {
1172             format!("foreign item {}{}", path_str(), id_str)
1173         }
1174         Some(Node::ImplItem(ii)) => {
1175             match ii.node {
1176                 ImplItemKind::Const(..) => {
1177                     format!("assoc const {} in {}{}", ii.ident, path_str(), id_str)
1178                 }
1179                 ImplItemKind::Method(..) => {
1180                     format!("method {} in {}{}", ii.ident, path_str(), id_str)
1181                 }
1182                 ImplItemKind::Type(_) => {
1183                     format!("assoc type {} in {}{}", ii.ident, path_str(), id_str)
1184                 }
1185                 ImplItemKind::Existential(_) => {
1186                     format!("assoc existential type {} in {}{}", ii.ident, path_str(), id_str)
1187                 }
1188             }
1189         }
1190         Some(Node::TraitItem(ti)) => {
1191             let kind = match ti.node {
1192                 TraitItemKind::Const(..) => "assoc constant",
1193                 TraitItemKind::Method(..) => "trait method",
1194                 TraitItemKind::Type(..) => "assoc type",
1195             };
1196
1197             format!("{} {} in {}{}", kind, ti.ident, path_str(), id_str)
1198         }
1199         Some(Node::Variant(ref variant)) => {
1200             format!("variant {} in {}{}",
1201                     variant.node.name,
1202                     path_str(), id_str)
1203         }
1204         Some(Node::Field(ref field)) => {
1205             format!("field {} in {}{}",
1206                     field.ident,
1207                     path_str(), id_str)
1208         }
1209         Some(Node::AnonConst(_)) => {
1210             format!("const {}{}", map.node_to_pretty_string(id), id_str)
1211         }
1212         Some(Node::Expr(_)) => {
1213             format!("expr {}{}", map.node_to_pretty_string(id), id_str)
1214         }
1215         Some(Node::Stmt(_)) => {
1216             format!("stmt {}{}", map.node_to_pretty_string(id), id_str)
1217         }
1218         Some(Node::Ty(_)) => {
1219             format!("type {}{}", map.node_to_pretty_string(id), id_str)
1220         }
1221         Some(Node::TraitRef(_)) => {
1222             format!("trait_ref {}{}", map.node_to_pretty_string(id), id_str)
1223         }
1224         Some(Node::Binding(_)) => {
1225             format!("local {}{}", map.node_to_pretty_string(id), id_str)
1226         }
1227         Some(Node::Pat(_)) => {
1228             format!("pat {}{}", map.node_to_pretty_string(id), id_str)
1229         }
1230         Some(Node::Block(_)) => {
1231             format!("block {}{}", map.node_to_pretty_string(id), id_str)
1232         }
1233         Some(Node::Local(_)) => {
1234             format!("local {}{}", map.node_to_pretty_string(id), id_str)
1235         }
1236         Some(Node::StructCtor(_)) => {
1237             format!("struct_ctor {}{}", path_str(), id_str)
1238         }
1239         Some(Node::Lifetime(_)) => {
1240             format!("lifetime {}{}", map.node_to_pretty_string(id), id_str)
1241         }
1242         Some(Node::GenericParam(ref param)) => {
1243             format!("generic_param {:?}{}", param, id_str)
1244         }
1245         Some(Node::Visibility(ref vis)) => {
1246             format!("visibility {:?}{}", vis, id_str)
1247         }
1248         Some(Node::MacroDef(_)) => {
1249             format!("macro {}{}",  path_str(), id_str)
1250         }
1251         Some(Node::Crate) => format!("root_crate"),
1252         None => format!("unknown node{}", id_str),
1253     }
1254 }
1255
1256 pub fn describe_def(tcx: TyCtxt, def_id: DefId) -> Option<Def> {
1257     if let Some(node_id) = tcx.hir.as_local_node_id(def_id) {
1258         tcx.hir.describe_def(node_id)
1259     } else {
1260         bug!("Calling local describe_def query provider for upstream DefId: {:?}",
1261              def_id)
1262     }
1263 }