src/librustc/hir/map/mod.rs

   1 use self::collector::NodeCollector;
   2 pub use self::def_collector::{DefCollector, MacroInvocationData};
   3 pub use self::definitions::{
   4     Definitions, DefKey, DefPath, DefPathData, DisambiguatedDefPathData, DefPathHash
   5 };
   6
   7 use crate::dep_graph::{DepGraph, DepNode, DepKind, DepNodeIndex};
   8
   9 use crate::hir::def_id::{CRATE_DEF_INDEX, DefId, LocalDefId};
  10
  11 use crate::middle::cstore::CrateStoreDyn;
  12
  13 use rustc_target::spec::abi::Abi;
  14 use rustc_data_structures::svh::Svh;
  15 use rustc_data_structures::indexed_vec::IndexVec;
  16 use syntax::ast::{self, Name, NodeId};
  17 use syntax::source_map::Spanned;
  18 use syntax::ext::base::MacroKind;
  19 use syntax_pos::{Span, DUMMY_SP};
  20
  21 use crate::hir::*;
  22 use crate::hir::DefKind;
  23 use crate::hir::itemlikevisit::ItemLikeVisitor;
  24 use crate::hir::print::Nested;
  25 use crate::util::nodemap::FxHashMap;
  26 use crate::util::common::time;
  27
  28 use std::io;
  29 use std::result::Result::Err;
  30 use crate::ty::query::Providers;
  31
  32 pub mod blocks;
  33 mod collector;
  34 mod def_collector;
  35 pub mod definitions;
  36 mod hir_id_validator;
  37
  38 /// Represents an entry and its parent `HirId`.
  39 #[derive(Copy, Clone, Debug)]
  40 pub struct Entry<'hir> {
  41     parent: HirId,
  42     dep_node: DepNodeIndex,
  43     node: Node<'hir>,
  44 }
  45
  46 impl<'hir> Entry<'hir> {
  47     fn parent_node(self) -> Option<HirId> {
  48         match self.node {
  49             Node::Crate | Node::MacroDef(_) => None,
  50             _ => Some(self.parent),
  51         }
  52     }
  53
  54     fn fn_decl(&self) -> Option<&'hir FnDecl> {
  55         match self.node {
  56             Node::Item(ref item) => {
  57                 match item.node {
  58                     ItemKind::Fn(ref fn_decl, _, _, _) => Some(fn_decl),
  59                     _ => None,
  60                 }
  61             }
  62
  63             Node::TraitItem(ref item) => {
  64                 match item.node {
  65                     TraitItemKind::Method(ref method_sig, _) => Some(&method_sig.decl),
  66                     _ => None
  67                 }
  68             }
  69
  70             Node::ImplItem(ref item) => {
  71                 match item.node {
  72                     ImplItemKind::Method(ref method_sig, _) => Some(&method_sig.decl),
  73                     _ => None,
  74                 }
  75             }
  76
  77             Node::Expr(ref expr) => {
  78                 match expr.node {
  79                     ExprKind::Closure(_, ref fn_decl, ..) => Some(fn_decl),
  80                     _ => None,
  81                 }
  82             }
  83
  84             _ => None,
  85         }
  86     }
  87
  88     fn associated_body(self) -> Option<BodyId> {
  89         match self.node {
  90             Node::Item(item) => {
  91                 match item.node {
  92                     ItemKind::Const(_, body) |
  93                     ItemKind::Static(.., body) |
  94                     ItemKind::Fn(_, _, _, body) => Some(body),
  95                     _ => None,
  96                 }
  97             }
  98
  99             Node::TraitItem(item) => {
 100                 match item.node {
 101                     TraitItemKind::Const(_, Some(body)) |
 102                     TraitItemKind::Method(_, TraitMethod::Provided(body)) => Some(body),
 103                     _ => None
 104                 }
 105             }
 106
 107             Node::ImplItem(item) => {
 108                 match item.node {
 109                     ImplItemKind::Const(_, body) |
 110                     ImplItemKind::Method(_, body) => Some(body),
 111                     _ => None,
 112                 }
 113             }
 114
 115             Node::AnonConst(constant) => Some(constant.body),
 116
 117             Node::Expr(expr) => {
 118                 match expr.node {
 119                     ExprKind::Closure(.., body, _, _) => Some(body),
 120                     _ => None,
 121                 }
 122             }
 123
 124             _ => None
 125         }
 126     }
 127
 128     fn is_body_owner(self, hir_id: HirId) -> bool {
 129         match self.associated_body() {
 130             Some(b) => b.hir_id == hir_id,
 131             None => false,
 132         }
 133     }
 134 }
 135
 136 /// Stores a crate and any number of inlined items from other crates.
 137 pub struct Forest {
 138     krate: Crate,
 139     pub dep_graph: DepGraph,
 140 }
 141
 142 impl Forest {
 143     pub fn new(krate: Crate, dep_graph: &DepGraph) -> Forest {
 144         Forest {
 145             krate,
 146             dep_graph: dep_graph.clone(),
 147         }
 148     }
 149
 150     pub fn krate<'hir>(&'hir self) -> &'hir Crate {
 151         self.dep_graph.read(DepNode::new_no_params(DepKind::Krate));
 152         &self.krate
 153     }
 154
 155     /// This is used internally in the dependency tracking system.
 156     /// Use the `krate` method to ensure your dependency on the
 157     /// crate is tracked.
 158     pub fn untracked_krate<'hir>(&'hir self) -> &'hir Crate {
 159         &self.krate
 160     }
 161 }
 162
 163 /// This type is effectively a `HashMap<HirId, Entry<'hir>>`,
 164 /// but it is implemented as 2 layers of arrays.
 165 /// - first we have `A = Vec<Option<B>>` mapping a `DefIndex`'s index to an inner value
 166 /// - which is `B = IndexVec<ItemLocalId, Option<Entry<'hir>>` which gives you the `Entry`.
 167 pub(super) type HirEntryMap<'hir> = Vec<Option<IndexVec<ItemLocalId, Option<Entry<'hir>>>>>;
 168
 169 /// Represents a mapping from `NodeId`s to AST elements and their parent `NodeId`s.
 170 #[derive(Clone)]
 171 pub struct Map<'hir> {
 172     /// The backing storage for all the AST nodes.
 173     pub forest: &'hir Forest,
 174
 175     /// Same as the dep_graph in forest, just available with one fewer
 176     /// deref. This is a gratuitous micro-optimization.
 177     pub dep_graph: DepGraph,
 178
 179     /// The SVH of the local crate.
 180     pub crate_hash: Svh,
 181
 182     map: HirEntryMap<'hir>,
 183
 184     definitions: &'hir Definitions,
 185
 186     /// The reverse mapping of `node_to_hir_id`.
 187     hir_to_node_id: FxHashMap<HirId, NodeId>,
 188 }
 189
 190 impl<'hir> Map<'hir> {
 191     #[inline]
 192     fn lookup(&self, id: HirId) -> Option<&Entry<'hir>> {
 193         let local_map = self.map.get(id.owner.index())?;
 194         local_map.as_ref()?.get(id.local_id)?.as_ref()
 195     }
 196
 197     /// Registers a read in the dependency graph of the AST node with
 198     /// the given `id`. This needs to be called each time a public
 199     /// function returns the HIR for a node -- in other words, when it
 200     /// "reveals" the content of a node to the caller (who might not
 201     /// otherwise have had access to those contents, and hence needs a
 202     /// read recorded). If the function just returns a DefId or
 203     /// HirId, no actual content was returned, so no read is needed.
 204     pub fn read(&self, hir_id: HirId) {
 205         if let Some(entry) = self.lookup(hir_id) {
 206             self.dep_graph.read_index(entry.dep_node);
 207         } else {
 208             bug!("called `HirMap::read()` with invalid `HirId`: {:?}", hir_id)
 209         }
 210     }
 211
 212     #[inline]
 213     pub fn definitions(&self) -> &'hir Definitions {
 214         self.definitions
 215     }
 216
 217     pub fn def_key(&self, def_id: DefId) -> DefKey {
 218         assert!(def_id.is_local());
 219         self.definitions.def_key(def_id.index)
 220     }
 221
 222     pub fn def_path_from_hir_id(&self, id: HirId) -> Option<DefPath> {
 223         self.opt_local_def_id_from_hir_id(id).map(|def_id| {
 224             self.def_path(def_id)
 225         })
 226     }
 227
 228     pub fn def_path(&self, def_id: DefId) -> DefPath {
 229         assert!(def_id.is_local());
 230         self.definitions.def_path(def_id.index)
 231     }
 232
 233     #[inline]
 234     pub fn local_def_id(&self, node: NodeId) -> DefId {
 235         self.opt_local_def_id(node).unwrap_or_else(|| {
 236             let hir_id = self.node_to_hir_id(node);
 237             bug!("local_def_id: no entry for `{}`, which has a map of `{:?}`",
 238                  node, self.find_entry(hir_id))
 239         })
 240     }
 241
 242     // FIXME(@ljedrz): replace the `NodeId` variant.
 243     #[inline]
 244     pub fn local_def_id_from_hir_id(&self, hir_id: HirId) -> DefId {
 245         self.opt_local_def_id_from_hir_id(hir_id).unwrap_or_else(|| {
 246             bug!("local_def_id_from_hir_id: no entry for `{:?}`, which has a map of `{:?}`",
 247                  hir_id, self.find_entry(hir_id))
 248         })
 249     }
 250
 251     // FIXME(@ljedrz): replace the `NodeId` variant.
 252     #[inline]
 253     pub fn opt_local_def_id_from_hir_id(&self, hir_id: HirId) -> Option<DefId> {
 254         let node_id = self.hir_to_node_id(hir_id);
 255         self.definitions.opt_local_def_id(node_id)
 256     }
 257
 258     #[inline]
 259     pub fn opt_local_def_id(&self, node: NodeId) -> Option<DefId> {
 260         self.definitions.opt_local_def_id(node)
 261     }
 262
 263     #[inline]
 264     pub fn as_local_node_id(&self, def_id: DefId) -> Option<NodeId> {
 265         self.definitions.as_local_node_id(def_id)
 266     }
 267
 268     // FIXME(@ljedrz): replace the `NodeId` variant.
 269     #[inline]
 270     pub fn as_local_hir_id(&self, def_id: DefId) -> Option<HirId> {
 271         self.definitions.as_local_hir_id(def_id)
 272     }
 273
 274     #[inline]
 275     pub fn hir_to_node_id(&self, hir_id: HirId) -> NodeId {
 276         self.hir_to_node_id[&hir_id]
 277     }
 278
 279     #[inline]
 280     pub fn node_to_hir_id(&self, node_id: NodeId) -> HirId {
 281         self.definitions.node_to_hir_id(node_id)
 282     }
 283
 284     #[inline]
 285     pub fn def_index_to_hir_id(&self, def_index: DefIndex) -> HirId {
 286         self.definitions.def_index_to_hir_id(def_index)
 287     }
 288
 289     #[inline]
 290     pub fn local_def_id_to_hir_id(&self, def_id: LocalDefId) -> HirId {
 291         self.definitions.def_index_to_hir_id(def_id.to_def_id().index)
 292     }
 293
 294     fn def_kind(&self, hir_id: HirId) -> Option<DefKind> {
 295         let node = if let Some(node) = self.find_by_hir_id(hir_id) {
 296             node
 297         } else {
 298             return None
 299         };
 300
 301         Some(match node {
 302             Node::Item(item) => {
 303                 match item.node {
 304                     ItemKind::Static(..) => DefKind::Static,
 305                     ItemKind::Const(..) => DefKind::Const,
 306                     ItemKind::Fn(..) => DefKind::Fn,
 307                     ItemKind::Mod(..) => DefKind::Mod,
 308                     ItemKind::Existential(..) => DefKind::Existential,
 309                     ItemKind::Ty(..) => DefKind::TyAlias,
 310                     ItemKind::Enum(..) => DefKind::Enum,
 311                     ItemKind::Struct(..) => DefKind::Struct,
 312                     ItemKind::Union(..) => DefKind::Union,
 313                     ItemKind::Trait(..) => DefKind::Trait,
 314                     ItemKind::TraitAlias(..) => DefKind::TraitAlias,
 315                     ItemKind::ExternCrate(_) |
 316                     ItemKind::Use(..) |
 317                     ItemKind::ForeignMod(..) |
 318                     ItemKind::GlobalAsm(..) |
 319                     ItemKind::Impl(..) => return None,
 320                 }
 321             }
 322             Node::ForeignItem(item) => {
 323                 match item.node {
 324                     ForeignItemKind::Fn(..) => DefKind::Fn,
 325                     ForeignItemKind::Static(..) => DefKind::Static,
 326                     ForeignItemKind::Type => DefKind::ForeignTy,
 327                 }
 328             }
 329             Node::TraitItem(item) => {
 330                 match item.node {
 331                     TraitItemKind::Const(..) => DefKind::AssocConst,
 332                     TraitItemKind::Method(..) => DefKind::Method,
 333                     TraitItemKind::Type(..) => DefKind::AssocTy,
 334                 }
 335             }
 336             Node::ImplItem(item) => {
 337                 match item.node {
 338                     ImplItemKind::Const(..) => DefKind::AssocConst,
 339                     ImplItemKind::Method(..) => DefKind::Method,
 340                     ImplItemKind::Type(..) => DefKind::AssocTy,
 341                     ImplItemKind::Existential(..) => DefKind::AssocExistential,
 342                 }
 343             }
 344             Node::Variant(_) => DefKind::Variant,
 345             Node::Ctor(variant_data) => {
 346                 // FIXME(eddyb) is this even possible, if we have a `Node::Ctor`?
 347                 if variant_data.ctor_hir_id().is_none() {
 348                     return None;
 349                 }
 350                 let ctor_of = match self.find_by_hir_id(self.get_parent_node_by_hir_id(hir_id)) {
 351                     Some(Node::Item(..)) => def::CtorOf::Struct,
 352                     Some(Node::Variant(..)) => def::CtorOf::Variant,
 353                     _ => unreachable!(),
 354                 };
 355                 DefKind::Ctor(ctor_of, def::CtorKind::from_hir(variant_data))
 356             }
 357             Node::AnonConst(_) |
 358             Node::Field(_) |
 359             Node::Expr(_) |
 360             Node::Stmt(_) |
 361             Node::PathSegment(_) |
 362             Node::Ty(_) |
 363             Node::TraitRef(_) |
 364             Node::Pat(_) |
 365             Node::Binding(_) |
 366             Node::Local(_) |
 367             Node::Arm(_) |
 368             Node::Lifetime(_) |
 369             Node::Visibility(_) |
 370             Node::Block(_) |
 371             Node::Crate => return None,
 372             Node::MacroDef(_) => DefKind::Macro(MacroKind::Bang),
 373             Node::GenericParam(param) => {
 374                 match param.kind {
 375                     GenericParamKind::Lifetime { .. } => return None,
 376                     GenericParamKind::Type { .. } => DefKind::TyParam,
 377                     GenericParamKind::Const { .. } => DefKind::ConstParam,
 378                 }
 379             }
 380         })
 381     }
 382
 383     fn find_entry(&self, id: HirId) -> Option<Entry<'hir>> {
 384         self.lookup(id).cloned()
 385     }
 386
 387     pub fn krate(&self) -> &'hir Crate {
 388         self.forest.krate()
 389     }
 390
 391     pub fn trait_item(&self, id: TraitItemId) -> &'hir TraitItem {
 392         self.read(id.hir_id);
 393
 394         // N.B., intentionally bypass `self.forest.krate()` so that we
 395         // do not trigger a read of the whole krate here
 396         self.forest.krate.trait_item(id)
 397     }
 398
 399     pub fn impl_item(&self, id: ImplItemId) -> &'hir ImplItem {
 400         self.read(id.hir_id);
 401
 402         // N.B., intentionally bypass `self.forest.krate()` so that we
 403         // do not trigger a read of the whole krate here
 404         self.forest.krate.impl_item(id)
 405     }
 406
 407     pub fn body(&self, id: BodyId) -> &'hir Body {
 408         self.read(id.hir_id);
 409
 410         // N.B., intentionally bypass `self.forest.krate()` so that we
 411         // do not trigger a read of the whole krate here
 412         self.forest.krate.body(id)
 413     }
 414
 415     pub fn fn_decl_by_hir_id(&self, hir_id: HirId) -> Option<&'hir FnDecl> {
 416         if let Some(entry) = self.find_entry(hir_id) {
 417             entry.fn_decl()
 418         } else {
 419             bug!("no entry for hir_id `{}`", hir_id)
 420         }
 421     }
 422
 423     /// Returns the `HirId` that corresponds to the definition of
 424     /// which this is the body of, i.e., a `fn`, `const` or `static`
 425     /// item (possibly associated), a closure, or a `hir::AnonConst`.
 426     pub fn body_owner(&self, BodyId { hir_id }: BodyId) -> HirId {
 427         let parent = self.get_parent_node_by_hir_id(hir_id);
 428         assert!(self.lookup(parent).map_or(false, |e| e.is_body_owner(hir_id)));
 429         parent
 430     }
 431
 432     pub fn body_owner_def_id(&self, id: BodyId) -> DefId {
 433         self.local_def_id_from_hir_id(self.body_owner(id))
 434     }
 435
 436     /// Given a `HirId`, returns the `BodyId` associated with it,
 437     /// if the node is a body owner, otherwise returns `None`.
 438     pub fn maybe_body_owned_by(&self, hir_id: HirId) -> Option<BodyId> {
 439         if let Some(entry) = self.find_entry(hir_id) {
 440             if self.dep_graph.is_fully_enabled() {
 441                 let hir_id_owner = hir_id.owner;
 442                 let def_path_hash = self.definitions.def_path_hash(hir_id_owner);
 443                 self.dep_graph.read(def_path_hash.to_dep_node(DepKind::HirBody));
 444             }
 445
 446             entry.associated_body()
 447         } else {
 448             bug!("no entry for id `{}`", hir_id)
 449         }
 450     }
 451
 452     /// Given a body owner's id, returns the `BodyId` associated with it.
 453     pub fn body_owned_by(&self, id: HirId) -> BodyId {
 454         self.maybe_body_owned_by(id).unwrap_or_else(|| {
 455             span_bug!(self.span(id), "body_owned_by: {} has no associated body",
 456                       self.node_to_string(id));
 457         })
 458     }
 459
 460     pub fn body_owner_kind(&self, id: HirId) -> BodyOwnerKind {
 461         match self.get(id) {
 462             Node::Item(&Item { node: ItemKind::Const(..), .. }) |
 463             Node::TraitItem(&TraitItem { node: TraitItemKind::Const(..), .. }) |
 464             Node::ImplItem(&ImplItem { node: ImplItemKind::Const(..), .. }) |
 465             Node::AnonConst(_) => {
 466                 BodyOwnerKind::Const
 467             }
 468             Node::Ctor(..) |
 469             Node::Item(&Item { node: ItemKind::Fn(..), .. }) |
 470             Node::TraitItem(&TraitItem { node: TraitItemKind::Method(..), .. }) |
 471             Node::ImplItem(&ImplItem { node: ImplItemKind::Method(..), .. }) => {
 472                 BodyOwnerKind::Fn
 473             }
 474             Node::Item(&Item { node: ItemKind::Static(_, m, _), .. }) => {
 475                 BodyOwnerKind::Static(m)
 476             }
 477             Node::Expr(&Expr { node: ExprKind::Closure(..), .. }) => {
 478                 BodyOwnerKind::Closure
 479             }
 480             node => bug!("{:#?} is not a body node", node),
 481         }
 482     }
 483
 484     pub fn ty_param_owner(&self, id: HirId) -> HirId {
 485         match self.get(id) {
 486             Node::Item(&Item { node: ItemKind::Trait(..), .. }) |
 487             Node::Item(&Item { node: ItemKind::TraitAlias(..), .. }) => id,
 488             Node::GenericParam(_) => self.get_parent_node_by_hir_id(id),
 489             _ => bug!("ty_param_owner: {} not a type parameter", self.node_to_string(id))
 490         }
 491     }
 492
 493     pub fn ty_param_name(&self, id: HirId) -> Name {
 494         match self.get(id) {
 495             Node::Item(&Item { node: ItemKind::Trait(..), .. }) |
 496             Node::Item(&Item { node: ItemKind::TraitAlias(..), .. }) => kw::SelfUpper,
 497             Node::GenericParam(param) => param.name.ident().name,
 498             _ => bug!("ty_param_name: {} not a type parameter", self.node_to_string(id)),
 499         }
 500     }
 501
 502     pub fn trait_impls(&self, trait_did: DefId) -> &'hir [HirId] {
 503         self.dep_graph.read(DepNode::new_no_params(DepKind::AllLocalTraitImpls));
 504
 505         // N.B., intentionally bypass `self.forest.krate()` so that we
 506         // do not trigger a read of the whole krate here
 507         self.forest.krate.trait_impls.get(&trait_did).map_or(&[], |xs| &xs[..])
 508     }
 509
 510     /// Gets the attributes on the crate. This is preferable to
 511     /// invoking `krate.attrs` because it registers a tighter
 512     /// dep-graph access.
 513     pub fn krate_attrs(&self) -> &'hir [ast::Attribute] {
 514         let def_path_hash = self.definitions.def_path_hash(CRATE_DEF_INDEX);
 515
 516         self.dep_graph.read(def_path_hash.to_dep_node(DepKind::Hir));
 517         &self.forest.krate.attrs
 518     }
 519
 520     pub fn get_module(&self, module: DefId) -> (&'hir Mod, Span, HirId)
 521     {
 522         let hir_id = self.as_local_hir_id(module).unwrap();
 523         self.read(hir_id);
 524         match self.find_entry(hir_id).unwrap().node {
 525             Node::Item(&Item {
 526                 span,
 527                 node: ItemKind::Mod(ref m),
 528                 ..
 529             }) => (m, span, hir_id),
 530             Node::Crate => (&self.forest.krate.module, self.forest.krate.span, hir_id),
 531             _ => panic!("not a module")
 532         }
 533     }
 534
 535     pub fn visit_item_likes_in_module<V>(&self, module: DefId, visitor: &mut V)
 536         where V: ItemLikeVisitor<'hir>
 537     {
 538         let hir_id = self.as_local_hir_id(module).unwrap();
 539
 540         // Read the module so we'll be re-executed if new items
 541         // appear immediately under in the module. If some new item appears
 542         // in some nested item in the module, we'll be re-executed due to reads
 543         // in the expect_* calls the loops below
 544         self.read(hir_id);
 545
 546         let node_id = self.hir_to_node_id[&hir_id];
 547
 548         let module = &self.forest.krate.modules[&node_id];
 549
 550         for id in &module.items {
 551             visitor.visit_item(self.expect_item(*id));
 552         }
 553
 554         for id in &module.trait_items {
 555             visitor.visit_trait_item(self.expect_trait_item(id.hir_id));
 556         }
 557
 558         for id in &module.impl_items {
 559             visitor.visit_impl_item(self.expect_impl_item(id.hir_id));
 560         }
 561     }
 562
 563     /// Retrieves the `Node` corresponding to `id`, panicking if it cannot be found.
 564     pub fn get(&self, id: HirId) -> Node<'hir> {
 565         // read recorded by `find`
 566         self.find_by_hir_id(id).unwrap_or_else(||
 567             bug!("couldn't find hir id {} in the HIR map", id))
 568     }
 569
 570     pub fn get_if_local(&self, id: DefId) -> Option<Node<'hir>> {
 571         self.as_local_hir_id(id).map(|id| self.get(id)) // read recorded by `get`
 572     }
 573
 574     pub fn get_generics(&self, id: DefId) -> Option<&'hir Generics> {
 575         self.get_if_local(id).and_then(|node| {
 576             match node {
 577                 Node::ImplItem(ref impl_item) => Some(&impl_item.generics),
 578                 Node::TraitItem(ref trait_item) => Some(&trait_item.generics),
 579                 Node::Item(ref item) => {
 580                     match item.node {
 581                         ItemKind::Fn(_, _, ref generics, _) |
 582                         ItemKind::Ty(_, ref generics) |
 583                         ItemKind::Enum(_, ref generics) |
 584                         ItemKind::Struct(_, ref generics) |
 585                         ItemKind::Union(_, ref generics) |
 586                         ItemKind::Trait(_, _, ref generics, ..) |
 587                         ItemKind::TraitAlias(ref generics, _) |
 588                         ItemKind::Impl(_, _, _, ref generics, ..) => Some(generics),
 589                         _ => None,
 590                     }
 591                 }
 592                 _ => None,
 593             }
 594         })
 595     }
 596
 597     /// Retrieves the `Node` corresponding to `id`, returning `None` if cannot be found.
 598     pub fn find(&self, id: NodeId) -> Option<Node<'hir>> {
 599         let hir_id = self.node_to_hir_id(id);
 600         self.find_by_hir_id(hir_id)
 601     }
 602
 603     // FIXME(@ljedrz): replace the `NodeId` variant.
 604     pub fn find_by_hir_id(&self, hir_id: HirId) -> Option<Node<'hir>> {
 605         let result = self.find_entry(hir_id).and_then(|entry| {
 606             if let Node::Crate = entry.node {
 607                 None
 608             } else {
 609                 Some(entry.node)
 610             }
 611         });
 612         if result.is_some() {
 613             self.read(hir_id);
 614         }
 615         result
 616     }
 617
 618     /// Similar to `get_parent`; returns the parent node-ID, or just `hir_id` if there
 619     /// is no parent. Note that the parent may be `CRATE_NODE_ID`, which is not itself
 620     /// present in the map, so passing the return value of `get_parent_node` to
 621     /// `get` may in fact panic.
 622     /// This function returns the immediate parent in the AST, whereas `get_parent`
 623     /// returns the enclosing item. Note that this might not be the actual parent
 624     /// node in the AST -- some kinds of nodes are not in the map and these will
 625     /// never appear as the parent node. Thus, you can always walk the parent nodes
 626     /// from a node to the root of the AST (unless you get back the same ID here,
 627     /// which can happen if the ID is not in the map itself or is just weird).
 628     pub fn get_parent_node(&self, id: NodeId) -> NodeId {
 629         let hir_id = self.node_to_hir_id(id);
 630         let parent_hir_id = self.get_parent_node_by_hir_id(hir_id);
 631         self.hir_to_node_id(parent_hir_id)
 632     }
 633
 634     // FIXME(@ljedrz): replace the `NodeId` variant.
 635     pub fn get_parent_node_by_hir_id(&self, hir_id: HirId) -> HirId {
 636         if self.dep_graph.is_fully_enabled() {
 637             let hir_id_owner = hir_id.owner;
 638             let def_path_hash = self.definitions.def_path_hash(hir_id_owner);
 639             self.dep_graph.read(def_path_hash.to_dep_node(DepKind::HirBody));
 640         }
 641
 642         self.find_entry(hir_id)
 643             .and_then(|x| x.parent_node())
 644             .unwrap_or(hir_id)
 645     }
 646
 647     /// Check if the node is an argument. An argument is a local variable whose
 648     /// immediate parent is an item or a closure.
 649     pub fn is_argument(&self, id: NodeId) -> bool {
 650         match self.find(id) {
 651             Some(Node::Binding(_)) => (),
 652             _ => return false,
 653         }
 654         match self.find(self.get_parent_node(id)) {
 655             Some(Node::Item(_)) |
 656             Some(Node::TraitItem(_)) |
 657             Some(Node::ImplItem(_)) => true,
 658             Some(Node::Expr(e)) => {
 659                 match e.node {
 660                     ExprKind::Closure(..) => true,
 661                     _ => false,
 662                 }
 663             }
 664             _ => false,
 665         }
 666     }
 667
 668     pub fn is_const_scope(&self, hir_id: HirId) -> bool {
 669         self.walk_parent_nodes(hir_id, |node| match *node {
 670             Node::Item(Item { node: ItemKind::Const(_, _), .. }) => true,
 671             Node::Item(Item { node: ItemKind::Fn(_, header, _, _), .. }) => header.is_const(),
 672             _ => false,
 673         }, |_| false).map(|id| id != CRATE_HIR_ID).unwrap_or(false)
 674     }
 675
 676     /// If there is some error when walking the parents (e.g., a node does not
 677     /// have a parent in the map or a node can't be found), then we return the
 678     /// last good `HirId` we found. Note that reaching the crate root (`id == 0`),
 679     /// is not an error, since items in the crate module have the crate root as
 680     /// parent.
 681     fn walk_parent_nodes<F, F2>(&self,
 682                                 start_id: HirId,
 683                                 found: F,
 684                                 bail_early: F2)
 685         -> Result<HirId, HirId>
 686         where F: Fn(&Node<'hir>) -> bool, F2: Fn(&Node<'hir>) -> bool
 687     {
 688         let mut id = start_id;
 689         loop {
 690             let parent_id = self.get_parent_node_by_hir_id(id);
 691             if parent_id == CRATE_HIR_ID {
 692                 return Ok(CRATE_HIR_ID);
 693             }
 694             if parent_id == id {
 695                 return Err(id);
 696             }
 697
 698             if let Some(entry) = self.find_entry(parent_id) {
 699                 if let Node::Crate = entry.node {
 700                     return Err(id);
 701                 }
 702                 if found(&entry.node) {
 703                     return Ok(parent_id);
 704                 } else if bail_early(&entry.node) {
 705                     return Err(parent_id);
 706                 }
 707                 id = parent_id;
 708             } else {
 709                 return Err(id);
 710             }
 711         }
 712     }
 713
 714     /// Retrieves the `HirId` for `id`'s enclosing method, unless there's a
 715     /// `while` or `loop` before reaching it, as block tail returns are not
 716     /// available in them.
 717     ///
 718     /// ```
 719     /// fn foo(x: usize) -> bool {
 720     ///     if x == 1 {
 721     ///         true  // `get_return_block` gets passed the `id` corresponding
 722     ///     } else {  // to this, it will return `foo`'s `HirId`.
 723     ///         false
 724     ///     }
 725     /// }
 726     /// ```
 727     ///
 728     /// ```
 729     /// fn foo(x: usize) -> bool {
 730     ///     loop {
 731     ///         true  // `get_return_block` gets passed the `id` corresponding
 732     ///     }         // to this, it will return `None`.
 733     ///     false
 734     /// }
 735     /// ```
 736     pub fn get_return_block(&self, id: HirId) -> Option<HirId> {
 737         let match_fn = |node: &Node<'_>| {
 738             match *node {
 739                 Node::Item(_) |
 740                 Node::ForeignItem(_) |
 741                 Node::TraitItem(_) |
 742                 Node::Expr(Expr { node: ExprKind::Closure(..), ..}) |
 743                 Node::ImplItem(_) => true,
 744                 _ => false,
 745             }
 746         };
 747         let match_non_returning_block = |node: &Node<'_>| {
 748             match *node {
 749                 Node::Expr(ref expr) => {
 750                     match expr.node {
 751                         ExprKind::While(..) | ExprKind::Loop(..) | ExprKind::Ret(..) => true,
 752                         _ => false,
 753                     }
 754                 }
 755                 _ => false,
 756             }
 757         };
 758
 759         self.walk_parent_nodes(id, match_fn, match_non_returning_block).ok()
 760     }
 761
 762     /// Retrieves the `HirId` for `id`'s parent item, or `id` itself if no
 763     /// parent item is in this map. The "parent item" is the closest parent node
 764     /// in the HIR which is recorded by the map and is an item, either an item
 765     /// in a module, trait, or impl.
 766     pub fn get_parent_item(&self, hir_id: HirId) -> HirId {
 767         match self.walk_parent_nodes(hir_id, |node| match *node {
 768             Node::Item(_) |
 769             Node::ForeignItem(_) |
 770             Node::TraitItem(_) |
 771             Node::ImplItem(_) => true,
 772             _ => false,
 773         }, |_| false) {
 774             Ok(id) => id,
 775             Err(id) => id,
 776         }
 777     }
 778
 779     /// Returns the `DefId` of `id`'s nearest module parent, or `id` itself if no
 780     /// module parent is in this map.
 781     pub fn get_module_parent(&self, id: HirId) -> DefId {
 782         self.local_def_id_from_hir_id(self.get_module_parent_node(id))
 783     }
 784
 785     /// Returns the `HirId` of `id`'s nearest module parent, or `id` itself if no
 786     /// module parent is in this map.
 787     pub fn get_module_parent_node(&self, hir_id: HirId) -> HirId {
 788         match self.walk_parent_nodes(hir_id, |node| match *node {
 789             Node::Item(&Item { node: ItemKind::Mod(_), .. }) => true,
 790             _ => false,
 791         }, |_| false) {
 792             Ok(id) => id,
 793             Err(id) => id,
 794         }
 795     }
 796
 797     /// Returns the nearest enclosing scope. A scope is roughly an item or block.
 798     pub fn get_enclosing_scope(&self, hir_id: HirId) -> Option<HirId> {
 799         self.walk_parent_nodes(hir_id, |node| match *node {
 800             Node::Item(i) => {
 801                 match i.node {
 802                     ItemKind::Fn(..)
 803                     | ItemKind::Mod(..)
 804                     | ItemKind::Enum(..)
 805                     | ItemKind::Struct(..)
 806                     | ItemKind::Union(..)
 807                     | ItemKind::Trait(..)
 808                     | ItemKind::Impl(..) => true,
 809                     _ => false,
 810                 }
 811             },
 812             Node::ForeignItem(fi) => {
 813                 match fi.node {
 814                     ForeignItemKind::Fn(..) => true,
 815                     _ => false,
 816                 }
 817             },
 818             Node::TraitItem(ti) => {
 819                 match ti.node {
 820                     TraitItemKind::Method(..) => true,
 821                     _ => false,
 822                 }
 823             },
 824             Node::ImplItem(ii) => {
 825                 match ii.node {
 826                     ImplItemKind::Method(..) => true,
 827                     _ => false,
 828                 }
 829             },
 830             Node::Block(_) => true,
 831             _ => false,
 832         }, |_| false).ok()
 833     }
 834
 835     /// Returns the defining scope for an existential type definition.
 836     pub fn get_defining_scope(&self, id: HirId) -> Option<HirId> {
 837         let mut scope = id;
 838         loop {
 839             scope = self.get_enclosing_scope(scope)?;
 840             if scope == CRATE_HIR_ID {
 841                 return Some(CRATE_HIR_ID);
 842             }
 843             match self.get(scope) {
 844                 Node::Item(i) => {
 845                     match i.node {
 846                         ItemKind::Existential(ExistTy { impl_trait_fn: None, .. }) => {}
 847                         _ => break,
 848                     }
 849                 }
 850                 Node::Block(_) => {}
 851                 _ => break,
 852             }
 853         }
 854         Some(scope)
 855     }
 856
 857     pub fn get_parent_did(&self, id: HirId) -> DefId {
 858         self.local_def_id_from_hir_id(self.get_parent_item(id))
 859     }
 860
 861     pub fn get_foreign_abi(&self, hir_id: HirId) -> Abi {
 862         let parent = self.get_parent_item(hir_id);
 863         if let Some(entry) = self.find_entry(parent) {
 864             if let Entry {
 865                 node: Node::Item(Item { node: ItemKind::ForeignMod(ref nm), .. }), .. } = entry
 866             {
 867                 self.read(hir_id); // reveals some of the content of a node
 868                 return nm.abi;
 869             }
 870         }
 871         bug!("expected foreign mod or inlined parent, found {}", self.node_to_string(parent))
 872     }
 873
 874     pub fn expect_item(&self, id: HirId) -> &'hir Item {
 875         match self.find_by_hir_id(id) { // read recorded by `find`
 876             Some(Node::Item(item)) => item,
 877             _ => bug!("expected item, found {}", self.node_to_string(id))
 878         }
 879     }
 880
 881     pub fn expect_impl_item(&self, id: HirId) -> &'hir ImplItem {
 882         match self.find_by_hir_id(id) {
 883             Some(Node::ImplItem(item)) => item,
 884             _ => bug!("expected impl item, found {}", self.node_to_string(id))
 885         }
 886     }
 887
 888     pub fn expect_trait_item(&self, id: HirId) -> &'hir TraitItem {
 889         match self.find_by_hir_id(id) {
 890             Some(Node::TraitItem(item)) => item,
 891             _ => bug!("expected trait item, found {}", self.node_to_string(id))
 892         }
 893     }
 894
 895     pub fn expect_variant_data(&self, id: HirId) -> &'hir VariantData {
 896         match self.find_by_hir_id(id) {
 897             Some(Node::Item(i)) => {
 898                 match i.node {
 899                     ItemKind::Struct(ref struct_def, _) |
 900                     ItemKind::Union(ref struct_def, _) => struct_def,
 901                     _ => bug!("struct ID bound to non-struct {}", self.node_to_string(id))
 902                 }
 903             }
 904             Some(Node::Variant(variant)) => &variant.node.data,
 905             Some(Node::Ctor(data)) => data,
 906             _ => bug!("expected struct or variant, found {}", self.node_to_string(id))
 907         }
 908     }
 909
 910     pub fn expect_variant(&self, id: HirId) -> &'hir Variant {
 911         match self.find_by_hir_id(id) {
 912             Some(Node::Variant(variant)) => variant,
 913             _ => bug!("expected variant, found {}", self.node_to_string(id)),
 914         }
 915     }
 916
 917     pub fn expect_foreign_item(&self, id: HirId) -> &'hir ForeignItem {
 918         match self.find_by_hir_id(id) {
 919             Some(Node::ForeignItem(item)) => item,
 920             _ => bug!("expected foreign item, found {}", self.node_to_string(id))
 921         }
 922     }
 923
 924     pub fn expect_expr(&self, id: HirId) -> &'hir Expr {
 925         match self.find_by_hir_id(id) { // read recorded by find
 926             Some(Node::Expr(expr)) => expr,
 927             _ => bug!("expected expr, found {}", self.node_to_string(id))
 928         }
 929     }
 930
 931     pub fn name(&self, id: HirId) -> Name {
 932         match self.get(id) {
 933             Node::Item(i) => i.ident.name,
 934             Node::ForeignItem(fi) => fi.ident.name,
 935             Node::ImplItem(ii) => ii.ident.name,
 936             Node::TraitItem(ti) => ti.ident.name,
 937             Node::Variant(v) => v.node.ident.name,
 938             Node::Field(f) => f.ident.name,
 939             Node::Lifetime(lt) => lt.name.ident().name,
 940             Node::GenericParam(param) => param.name.ident().name,
 941             Node::Binding(&Pat { node: PatKind::Binding(_, _, l, _), .. }) => l.name,
 942             Node::Ctor(..) => self.name(self.get_parent_item(id)),
 943             _ => bug!("no name for {}", self.node_to_string(id))
 944         }
 945     }
 946
 947     /// Given a node ID, gets a list of attributes associated with the AST
 948     /// corresponding to the node-ID.
 949     pub fn attrs(&self, id: HirId) -> &'hir [ast::Attribute] {
 950         self.read(id); // reveals attributes on the node
 951         let attrs = match self.find_entry(id).map(|entry| entry.node) {
 952             Some(Node::Local(l)) => Some(&l.attrs[..]),
 953             Some(Node::Item(i)) => Some(&i.attrs[..]),
 954             Some(Node::ForeignItem(fi)) => Some(&fi.attrs[..]),
 955             Some(Node::TraitItem(ref ti)) => Some(&ti.attrs[..]),
 956             Some(Node::ImplItem(ref ii)) => Some(&ii.attrs[..]),
 957             Some(Node::Variant(ref v)) => Some(&v.node.attrs[..]),
 958             Some(Node::Field(ref f)) => Some(&f.attrs[..]),
 959             Some(Node::Expr(ref e)) => Some(&*e.attrs),
 960             Some(Node::Stmt(ref s)) => Some(s.node.attrs()),
 961             Some(Node::Arm(ref a)) => Some(&*a.attrs),
 962             Some(Node::GenericParam(param)) => Some(&param.attrs[..]),
 963             // Unit/tuple structs/variants take the attributes straight from
 964             // the struct/variant definition.
 965             Some(Node::Ctor(..)) => return self.attrs(self.get_parent_item(id)),
 966             Some(Node::Crate) => Some(&self.forest.krate.attrs[..]),
 967             _ => None
 968         };
 969         attrs.unwrap_or(&[])
 970     }
 971
 972     /// Returns an iterator that yields all the hir ids in the map.
 973     fn all_ids<'a>(&'a self) -> impl Iterator<Item = HirId> + 'a {
 974         // This code is a bit awkward because the map is implemented as 2 levels of arrays,
 975         // see the comment on `HirEntryMap`.
 976         // Iterate over all the indices and return a reference to
 977         // local maps and their index given that they exist.
 978         self.map.iter().enumerate().filter_map(|(i, local_map)| {
 979             local_map.as_ref().map(|m| (i, m))
 980         }).flat_map(move |(array_index, local_map)| {
 981             // Iterate over each valid entry in the local map
 982             local_map.iter_enumerated().filter_map(move |(i, entry)| entry.map(move |_| {
 983                 // Reconstruct the HirId based on the 3 indices we used to find it
 984                 HirId {
 985                     owner: DefIndex::from(array_index),
 986                     local_id: i,
 987                 }
 988             }))
 989         })
 990     }
 991
 992     /// Returns an iterator that yields the node id's with paths that
 993     /// match `parts`.  (Requires `parts` is non-empty.)
 994     ///
 995     /// For example, if given `parts` equal to `["bar", "quux"]`, then
 996     /// the iterator will produce node id's for items with paths
 997     /// such as `foo::bar::quux`, `bar::quux`, `other::bar::quux`, and
 998     /// any other such items it can find in the map.
 999     pub fn nodes_matching_suffix<'a>(&'a self, parts: &'a [String])
1000                                  -> impl Iterator<Item = NodeId> + 'a {
1001         let nodes = NodesMatchingSuffix {
1002             map: self,
1003             item_name: parts.last().unwrap(),
1004             in_which: &parts[..parts.len() - 1],
1005         };
1006
1007         self.all_ids().filter(move |hir| nodes.matches_suffix(*hir)).map(move |hir| {
1008             self.hir_to_node_id(hir)
1009         })
1010     }
1011
1012     pub fn span(&self, hir_id: HirId) -> Span {
1013         self.read(hir_id); // reveals span from node
1014         match self.find_entry(hir_id).map(|entry| entry.node) {
1015             Some(Node::Item(item)) => item.span,
1016             Some(Node::ForeignItem(foreign_item)) => foreign_item.span,
1017             Some(Node::TraitItem(trait_method)) => trait_method.span,
1018             Some(Node::ImplItem(impl_item)) => impl_item.span,
1019             Some(Node::Variant(variant)) => variant.span,
1020             Some(Node::Field(field)) => field.span,
1021             Some(Node::AnonConst(constant)) => self.body(constant.body).value.span,
1022             Some(Node::Expr(expr)) => expr.span,
1023             Some(Node::Stmt(stmt)) => stmt.span,
1024             Some(Node::PathSegment(seg)) => seg.ident.span,
1025             Some(Node::Ty(ty)) => ty.span,
1026             Some(Node::TraitRef(tr)) => tr.path.span,
1027             Some(Node::Binding(pat)) => pat.span,
1028             Some(Node::Pat(pat)) => pat.span,
1029             Some(Node::Arm(arm)) => arm.span,
1030             Some(Node::Block(block)) => block.span,
1031             Some(Node::Ctor(..)) => match self.find_by_hir_id(
1032                 self.get_parent_node_by_hir_id(hir_id))
1033             {
1034                 Some(Node::Item(item)) => item.span,
1035                 Some(Node::Variant(variant)) => variant.span,
1036                 _ => unreachable!(),
1037             }
1038             Some(Node::Lifetime(lifetime)) => lifetime.span,
1039             Some(Node::GenericParam(param)) => param.span,
1040             Some(Node::Visibility(&Spanned {
1041                 node: VisibilityKind::Restricted { ref path, .. }, ..
1042             })) => path.span,
1043             Some(Node::Visibility(v)) => bug!("unexpected Visibility {:?}", v),
1044             Some(Node::Local(local)) => local.span,
1045             Some(Node::MacroDef(macro_def)) => macro_def.span,
1046             Some(Node::Crate) => self.forest.krate.span,
1047             None => bug!("hir::map::Map::span: id not in map: {:?}", hir_id),
1048         }
1049     }
1050
1051     pub fn span_if_local(&self, id: DefId) -> Option<Span> {
1052         self.as_local_hir_id(id).map(|id| self.span(id))
1053     }
1054
1055     pub fn node_to_string(&self, id: HirId) -> String {
1056         hir_id_to_string(self, id, true)
1057     }
1058
1059     pub fn hir_to_user_string(&self, id: HirId) -> String {
1060         hir_id_to_string(self, id, false)
1061     }
1062
1063     pub fn hir_to_pretty_string(&self, id: HirId) -> String {
1064         print::to_string(self, |s| s.print_node(self.get(id)))
1065     }
1066 }
1067
1068 pub struct NodesMatchingSuffix<'a> {
1069     map: &'a Map<'a>,
1070     item_name: &'a String,
1071     in_which: &'a [String],
1072 }
1073
1074 impl<'a> NodesMatchingSuffix<'a> {
1075     /// Returns `true` only if some suffix of the module path for parent
1076     /// matches `self.in_which`.
1077     ///
1078     /// In other words: let `[x_0,x_1,...,x_k]` be `self.in_which`;
1079     /// returns true if parent's path ends with the suffix
1080     /// `x_0::x_1::...::x_k`.
1081     fn suffix_matches(&self, parent: HirId) -> bool {
1082         let mut cursor = parent;
1083         for part in self.in_which.iter().rev() {
1084             let (mod_id, mod_name) = match find_first_mod_parent(self.map, cursor) {
1085                 None => return false,
1086                 Some((node_id, name)) => (node_id, name),
1087             };
1088             if mod_name.as_str() != *part {
1089                 return false;
1090             }
1091             cursor = self.map.get_parent_item(mod_id);
1092         }
1093         return true;
1094
1095         // Finds the first mod in parent chain for `id`, along with
1096         // that mod's name.
1097         //
1098         // If `id` itself is a mod named `m` with parent `p`, then
1099         // returns `Some(id, m, p)`.  If `id` has no mod in its parent
1100         // chain, then returns `None`.
1101         fn find_first_mod_parent<'a>(map: &'a Map<'_>, mut id: HirId) -> Option<(HirId, Name)> {
1102             loop {
1103                 if let Node::Item(item) = map.find_by_hir_id(id)? {
1104                     if item_is_mod(&item) {
1105                         return Some((id, item.ident.name))
1106                     }
1107                 }
1108                 let parent = map.get_parent_item(id);
1109                 if parent == id { return None }
1110                 id = parent;
1111             }
1112
1113             fn item_is_mod(item: &Item) -> bool {
1114                 match item.node {
1115                     ItemKind::Mod(_) => true,
1116                     _ => false,
1117                 }
1118             }
1119         }
1120     }
1121
1122     // We are looking at some node `n` with a given name and parent
1123     // id; do their names match what I am seeking?
1124     fn matches_names(&self, parent_of_n: HirId, name: Name) -> bool {
1125         name.as_str() == *self.item_name && self.suffix_matches(parent_of_n)
1126     }
1127
1128     fn matches_suffix(&self, hir: HirId) -> bool {
1129         let name = match self.map.find_entry(hir).map(|entry| entry.node) {
1130             Some(Node::Item(n)) => n.name(),
1131             Some(Node::ForeignItem(n)) => n.name(),
1132             Some(Node::TraitItem(n)) => n.name(),
1133             Some(Node::ImplItem(n)) => n.name(),
1134             Some(Node::Variant(n)) => n.name(),
1135             Some(Node::Field(n)) => n.name(),
1136             _ => return false,
1137         };
1138         self.matches_names(self.map.get_parent_item(hir), name)
1139     }
1140 }
1141
1142 trait Named {
1143     fn name(&self) -> Name;
1144 }
1145
1146 impl<T:Named> Named for Spanned<T> { fn name(&self) -> Name { self.node.name() } }
1147
1148 impl Named for Item { fn name(&self) -> Name { self.ident.name } }
1149 impl Named for ForeignItem { fn name(&self) -> Name { self.ident.name } }
1150 impl Named for VariantKind { fn name(&self) -> Name { self.ident.name } }
1151 impl Named for StructField { fn name(&self) -> Name { self.ident.name } }
1152 impl Named for TraitItem { fn name(&self) -> Name { self.ident.name } }
1153 impl Named for ImplItem { fn name(&self) -> Name { self.ident.name } }
1154
1155 pub fn map_crate<'hir>(sess: &crate::session::Session,
1156                        cstore: &CrateStoreDyn,
1157                        forest: &'hir Forest,
1158                        definitions: &'hir Definitions)
1159                        -> Map<'hir> {
1160     // Build the reverse mapping of `node_to_hir_id`.
1161     let hir_to_node_id = definitions.node_to_hir_id.iter_enumerated()
1162         .map(|(node_id, &hir_id)| (hir_id, node_id)).collect();
1163
1164     let (map, crate_hash) = {
1165         let hcx = crate::ich::StableHashingContext::new(sess, &forest.krate, definitions, cstore);
1166
1167         let mut collector = NodeCollector::root(sess,
1168                                                 &forest.krate,
1169                                                 &forest.dep_graph,
1170                                                 &definitions,
1171                                                 &hir_to_node_id,
1172                                                 hcx);
1173         intravisit::walk_crate(&mut collector, &forest.krate);
1174
1175         let crate_disambiguator = sess.local_crate_disambiguator();
1176         let cmdline_args = sess.opts.dep_tracking_hash();
1177         collector.finalize_and_compute_crate_hash(
1178             crate_disambiguator,
1179             cstore,
1180             cmdline_args
1181         )
1182     };
1183
1184     let map = Map {
1185         forest,
1186         dep_graph: forest.dep_graph.clone(),
1187         crate_hash,
1188         map,
1189         hir_to_node_id,
1190         definitions,
1191     };
1192
1193     time(sess, "validate hir map", || {
1194         hir_id_validator::check_crate(&map);
1195     });
1196
1197     map
1198 }
1199
1200 /// Identical to the `PpAnn` implementation for `hir::Crate`,
1201 /// except it avoids creating a dependency on the whole crate.
1202 impl<'hir> print::PpAnn for Map<'hir> {
1203     fn nested(&self, state: &mut print::State<'_>, nested: print::Nested) -> io::Result<()> {
1204         match nested {
1205             Nested::Item(id) => state.print_item(self.expect_item(id.id)),
1206             Nested::TraitItem(id) => state.print_trait_item(self.trait_item(id)),
1207             Nested::ImplItem(id) => state.print_impl_item(self.impl_item(id)),
1208             Nested::Body(id) => state.print_expr(&self.body(id).value),
1209             Nested::BodyArgPat(id, i) => state.print_pat(&self.body(id).arguments[i].pat)
1210         }
1211     }
1212 }
1213
1214 impl<'a> print::State<'a> {
1215     pub fn print_node(&mut self, node: Node<'_>) -> io::Result<()> {
1216         match node {
1217             Node::Item(a)         => self.print_item(&a),
1218             Node::ForeignItem(a)  => self.print_foreign_item(&a),
1219             Node::TraitItem(a)    => self.print_trait_item(a),
1220             Node::ImplItem(a)     => self.print_impl_item(a),
1221             Node::Variant(a)      => self.print_variant(&a),
1222             Node::AnonConst(a)    => self.print_anon_const(&a),
1223             Node::Expr(a)         => self.print_expr(&a),
1224             Node::Stmt(a)         => self.print_stmt(&a),
1225             Node::PathSegment(a)  => self.print_path_segment(&a),
1226             Node::Ty(a)           => self.print_type(&a),
1227             Node::TraitRef(a)     => self.print_trait_ref(&a),
1228             Node::Binding(a)      |
1229             Node::Pat(a)          => self.print_pat(&a),
1230             Node::Arm(a)          => self.print_arm(&a),
1231             Node::Block(a)        => {
1232                 use syntax::print::pprust::PrintState;
1233
1234                 // containing cbox, will be closed by print-block at }
1235                 self.cbox(print::indent_unit)?;
1236                 // head-ibox, will be closed by print-block after {
1237                 self.ibox(0)?;
1238                 self.print_block(&a)
1239             }
1240             Node::Lifetime(a)     => self.print_lifetime(&a),
1241             Node::Visibility(a)   => self.print_visibility(&a),
1242             Node::GenericParam(_) => bug!("cannot print Node::GenericParam"),
1243             Node::Field(_)        => bug!("cannot print StructField"),
1244             // these cases do not carry enough information in the
1245             // hir_map to reconstruct their full structure for pretty
1246             // printing.
1247             Node::Ctor(..)        => bug!("cannot print isolated Ctor"),
1248             Node::Local(a)        => self.print_local_decl(&a),
1249             Node::MacroDef(_)     => bug!("cannot print MacroDef"),
1250             Node::Crate           => bug!("cannot print Crate"),
1251         }
1252     }
1253 }
1254
1255 fn hir_id_to_string(map: &Map<'_>, id: HirId, include_id: bool) -> String {
1256     let id_str = format!(" (hir_id={})", id);
1257     let id_str = if include_id { &id_str[..] } else { "" };
1258
1259     let path_str = || {
1260         // This functionality is used for debugging, try to use TyCtxt to get
1261         // the user-friendly path, otherwise fall back to stringifying DefPath.
1262         crate::ty::tls::with_opt(|tcx| {
1263             if let Some(tcx) = tcx {
1264                 let def_id = map.local_def_id_from_hir_id(id);
1265                 tcx.def_path_str(def_id)
1266             } else if let Some(path) = map.def_path_from_hir_id(id) {
1267                 path.data.into_iter().map(|elem| {
1268                     elem.data.to_string()
1269                 }).collect::<Vec<_>>().join("::")
1270             } else {
1271                 String::from("<missing path>")
1272             }
1273         })
1274     };
1275
1276     match map.find_by_hir_id(id) {
1277         Some(Node::Item(item)) => {
1278             let item_str = match item.node {
1279                 ItemKind::ExternCrate(..) => "extern crate",
1280                 ItemKind::Use(..) => "use",
1281                 ItemKind::Static(..) => "static",
1282                 ItemKind::Const(..) => "const",
1283                 ItemKind::Fn(..) => "fn",
1284                 ItemKind::Mod(..) => "mod",
1285                 ItemKind::ForeignMod(..) => "foreign mod",
1286                 ItemKind::GlobalAsm(..) => "global asm",
1287                 ItemKind::Ty(..) => "ty",
1288                 ItemKind::Existential(..) => "existential type",
1289                 ItemKind::Enum(..) => "enum",
1290                 ItemKind::Struct(..) => "struct",
1291                 ItemKind::Union(..) => "union",
1292                 ItemKind::Trait(..) => "trait",
1293                 ItemKind::TraitAlias(..) => "trait alias",
1294                 ItemKind::Impl(..) => "impl",
1295             };
1296             format!("{} {}{}", item_str, path_str(), id_str)
1297         }
1298         Some(Node::ForeignItem(_)) => {
1299             format!("foreign item {}{}", path_str(), id_str)
1300         }
1301         Some(Node::ImplItem(ii)) => {
1302             match ii.node {
1303                 ImplItemKind::Const(..) => {
1304                     format!("assoc const {} in {}{}", ii.ident, path_str(), id_str)
1305                 }
1306                 ImplItemKind::Method(..) => {
1307                     format!("method {} in {}{}", ii.ident, path_str(), id_str)
1308                 }
1309                 ImplItemKind::Type(_) => {
1310                     format!("assoc type {} in {}{}", ii.ident, path_str(), id_str)
1311                 }
1312                 ImplItemKind::Existential(_) => {
1313                     format!("assoc existential type {} in {}{}", ii.ident, path_str(), id_str)
1314                 }
1315             }
1316         }
1317         Some(Node::TraitItem(ti)) => {
1318             let kind = match ti.node {
1319                 TraitItemKind::Const(..) => "assoc constant",
1320                 TraitItemKind::Method(..) => "trait method",
1321                 TraitItemKind::Type(..) => "assoc type",
1322             };
1323
1324             format!("{} {} in {}{}", kind, ti.ident, path_str(), id_str)
1325         }
1326         Some(Node::Variant(ref variant)) => {
1327             format!("variant {} in {}{}",
1328                     variant.node.ident,
1329                     path_str(), id_str)
1330         }
1331         Some(Node::Field(ref field)) => {
1332             format!("field {} in {}{}",
1333                     field.ident,
1334                     path_str(), id_str)
1335         }
1336         Some(Node::AnonConst(_)) => {
1337             format!("const {}{}", map.hir_to_pretty_string(id), id_str)
1338         }
1339         Some(Node::Expr(_)) => {
1340             format!("expr {}{}", map.hir_to_pretty_string(id), id_str)
1341         }
1342         Some(Node::Stmt(_)) => {
1343             format!("stmt {}{}", map.hir_to_pretty_string(id), id_str)
1344         }
1345         Some(Node::PathSegment(_)) => {
1346             format!("path segment {}{}", map.hir_to_pretty_string(id), id_str)
1347         }
1348         Some(Node::Ty(_)) => {
1349             format!("type {}{}", map.hir_to_pretty_string(id), id_str)
1350         }
1351         Some(Node::TraitRef(_)) => {
1352             format!("trait_ref {}{}", map.hir_to_pretty_string(id), id_str)
1353         }
1354         Some(Node::Binding(_)) => {
1355             format!("local {}{}", map.hir_to_pretty_string(id), id_str)
1356         }
1357         Some(Node::Pat(_)) => {
1358             format!("pat {}{}", map.hir_to_pretty_string(id), id_str)
1359         }
1360         Some(Node::Arm(_)) => {
1361             format!("arm {}{}", map.hir_to_pretty_string(id), id_str)
1362         }
1363         Some(Node::Block(_)) => {
1364             format!("block {}{}", map.hir_to_pretty_string(id), id_str)
1365         }
1366         Some(Node::Local(_)) => {
1367             format!("local {}{}", map.hir_to_pretty_string(id), id_str)
1368         }
1369         Some(Node::Ctor(..)) => {
1370             format!("ctor {}{}", path_str(), id_str)
1371         }
1372         Some(Node::Lifetime(_)) => {
1373             format!("lifetime {}{}", map.hir_to_pretty_string(id), id_str)
1374         }
1375         Some(Node::GenericParam(ref param)) => {
1376             format!("generic_param {:?}{}", param, id_str)
1377         }
1378         Some(Node::Visibility(ref vis)) => {
1379             format!("visibility {:?}{}", vis, id_str)
1380         }
1381         Some(Node::MacroDef(_)) => {
1382             format!("macro {}{}",  path_str(), id_str)
1383         }
1384         Some(Node::Crate) => String::from("root_crate"),
1385         None => format!("unknown node{}", id_str),
1386     }
1387 }
1388
1389 pub fn provide(providers: &mut Providers<'_>) {
1390     providers.def_kind = |tcx, def_id| {
1391         if let Some(hir_id) = tcx.hir().as_local_hir_id(def_id) {
1392             tcx.hir().def_kind(hir_id)
1393         } else {
1394             bug!("calling local def_kind query provider for upstream DefId: {:?}",
1395                 def_id
1396             );
1397         }
1398     };
1399 }