use crate::HashStableContext; use rustc_data_structures::fingerprint::Fingerprint; use rustc_data_structures::stable_hasher::{HashStable, StableHasher}; use rustc_data_structures::AtomicRef; use rustc_index::vec::Idx; use rustc_macros::HashStable_Generic; use rustc_serialize::{Decodable, Decoder, Encodable, Encoder}; use std::borrow::Borrow; use std::fmt; rustc_index::newtype_index! { pub struct CrateId { ENCODABLE = custom } } #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)] pub enum CrateNum { /// A special `CrateNum` that we use for the `tcx.rcache` when decoding from /// the incr. comp. cache. ReservedForIncrCompCache, Index(CrateId), } /// Item definitions in the currently-compiled crate would have the `CrateNum` /// `LOCAL_CRATE` in their `DefId`. pub const LOCAL_CRATE: CrateNum = CrateNum::Index(CrateId::from_u32(0)); impl Idx for CrateNum { #[inline] fn new(value: usize) -> Self { CrateNum::Index(Idx::new(value)) } #[inline] fn index(self) -> usize { match self { CrateNum::Index(idx) => Idx::index(idx), _ => panic!("Tried to get crate index of {:?}", self), } } } impl CrateNum { pub fn new(x: usize) -> CrateNum { CrateNum::from_usize(x) } pub fn from_usize(x: usize) -> CrateNum { CrateNum::Index(CrateId::from_usize(x)) } pub fn from_u32(x: u32) -> CrateNum { CrateNum::Index(CrateId::from_u32(x)) } pub fn as_usize(self) -> usize { match self { CrateNum::Index(id) => id.as_usize(), _ => panic!("tried to get index of non-standard crate {:?}", self), } } pub fn as_u32(self) -> u32 { match self { CrateNum::Index(id) => id.as_u32(), _ => panic!("tried to get index of non-standard crate {:?}", self), } } pub fn as_def_id(&self) -> DefId { DefId { krate: *self, index: CRATE_DEF_INDEX } } } impl fmt::Display for CrateNum { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { match self { CrateNum::Index(id) => fmt::Display::fmt(&id.private, f), CrateNum::ReservedForIncrCompCache => write!(f, "crate for decoding incr comp cache"), } } } /// As a local identifier, a `CrateNum` is only meaningful within its context, e.g. within a tcx. /// Therefore, make sure to include the context when encode a `CrateNum`. impl Encodable for CrateNum { default fn encode(&self, s: &mut E) -> Result<(), E::Error> { s.emit_u32(self.as_u32()) } } impl Decodable for CrateNum { default fn decode(d: &mut D) -> Result { Ok(CrateNum::from_u32(d.read_u32()?)) } } impl ::std::fmt::Debug for CrateNum { fn fmt(&self, fmt: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result { match self { CrateNum::Index(id) => write!(fmt, "crate{}", id.private), CrateNum::ReservedForIncrCompCache => write!(fmt, "crate for decoding incr comp cache"), } } } #[derive(Copy, Clone, Hash, PartialEq, Eq, PartialOrd, Ord, Debug)] #[derive(HashStable_Generic, Encodable, Decodable)] pub struct DefPathHash(pub Fingerprint); impl Borrow for DefPathHash { #[inline] fn borrow(&self) -> &Fingerprint { &self.0 } } rustc_index::newtype_index! { /// A DefIndex is an index into the hir-map for a crate, identifying a /// particular definition. It should really be considered an interned /// shorthand for a particular DefPath. pub struct DefIndex { ENCODABLE = custom // (only encodable in metadata) DEBUG_FORMAT = "DefIndex({})", /// The crate root is always assigned index 0 by the AST Map code, /// thanks to `NodeCollector::new`. const CRATE_DEF_INDEX = 0, } } impl Encodable for DefIndex { default fn encode(&self, _: &mut E) -> Result<(), E::Error> { panic!("cannot encode `DefIndex` with `{}`", std::any::type_name::()); } } impl Decodable for DefIndex { default fn decode(_: &mut D) -> Result { panic!("cannot decode `DefIndex` with `{}`", std::any::type_name::()); } } /// A `DefId` identifies a particular *definition*, by combining a crate /// index and a def index. /// /// You can create a `DefId` from a `LocalDefId` using `local_def_id.to_def_id()`. #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Copy)] pub struct DefId { pub krate: CrateNum, pub index: DefIndex, } impl DefId { /// Makes a local `DefId` from the given `DefIndex`. #[inline] pub fn local(index: DefIndex) -> DefId { DefId { krate: LOCAL_CRATE, index } } /// Returns whether the item is defined in the crate currently being compiled. #[inline] pub fn is_local(self) -> bool { self.krate == LOCAL_CRATE } #[inline] pub fn as_local(self) -> Option { if self.is_local() { Some(LocalDefId { local_def_index: self.index }) } else { None } } #[inline] pub fn expect_local(self) -> LocalDefId { self.as_local().unwrap_or_else(|| panic!("DefId::expect_local: `{:?}` isn't local", self)) } pub fn is_top_level_module(self) -> bool { self.is_local() && self.index == CRATE_DEF_INDEX } } impl Encodable for DefId { default fn encode(&self, s: &mut E) -> Result<(), E::Error> { s.emit_struct("DefId", 2, |s| { s.emit_struct_field("krate", 0, |s| self.krate.encode(s))?; s.emit_struct_field("index", 1, |s| self.index.encode(s)) }) } } impl Decodable for DefId { default fn decode(d: &mut D) -> Result { d.read_struct("DefId", 2, |d| { Ok(DefId { krate: d.read_struct_field("krate", 0, Decodable::decode)?, index: d.read_struct_field("index", 1, Decodable::decode)?, }) }) } } pub fn default_def_id_debug(def_id: DefId, f: &mut fmt::Formatter<'_>) -> fmt::Result { f.debug_struct("DefId").field("krate", &def_id.krate).field("index", &def_id.index).finish() } pub static DEF_ID_DEBUG: AtomicRef) -> fmt::Result> = AtomicRef::new(&(default_def_id_debug as fn(_, &mut fmt::Formatter<'_>) -> _)); impl fmt::Debug for DefId { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { (*DEF_ID_DEBUG)(*self, f) } } rustc_data_structures::define_id_collections!(DefIdMap, DefIdSet, DefId); /// A LocalDefId is equivalent to a DefId with `krate == LOCAL_CRATE`. Since /// we encode this information in the type, we can ensure at compile time that /// no DefIds from upstream crates get thrown into the mix. There are quite a /// few cases where we know that only DefIds from the local crate are expected /// and a DefId from a different crate would signify a bug somewhere. This /// is when LocalDefId comes in handy. #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)] pub struct LocalDefId { pub local_def_index: DefIndex, } pub const CRATE_DEF_ID: LocalDefId = LocalDefId { local_def_index: CRATE_DEF_INDEX }; impl Idx for LocalDefId { #[inline] fn new(idx: usize) -> Self { LocalDefId { local_def_index: Idx::new(idx) } } #[inline] fn index(self) -> usize { self.local_def_index.index() } } impl LocalDefId { #[inline] pub fn to_def_id(self) -> DefId { DefId { krate: LOCAL_CRATE, index: self.local_def_index } } #[inline] pub fn is_top_level_module(self) -> bool { self.local_def_index == CRATE_DEF_INDEX } } impl fmt::Debug for LocalDefId { fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { self.to_def_id().fmt(f) } } impl Encodable for LocalDefId { fn encode(&self, s: &mut E) -> Result<(), E::Error> { self.to_def_id().encode(s) } } impl Decodable for LocalDefId { fn decode(d: &mut D) -> Result { DefId::decode(d).map(|d| d.expect_local()) } } rustc_data_structures::define_id_collections!(LocalDefIdMap, LocalDefIdSet, LocalDefId); impl HashStable for DefId { fn hash_stable(&self, hcx: &mut CTX, hasher: &mut StableHasher) { hcx.hash_def_id(*self, hasher) } } impl HashStable for CrateNum { fn hash_stable(&self, hcx: &mut CTX, hasher: &mut StableHasher) { hcx.hash_crate_num(*self, hasher) } }