use std::hash::Hash; use std::marker::PhantomData; use fxhash::FxHashMap; /// An index within a [`Interner`] structure. pub struct Interned { idx: u32, _phantom: PhantomData, } impl Interned { fn new(idx: u32) -> Self { Self { idx, _phantom: PhantomData } } } // TODO: the stable store should be replaced by a bump allocator // and the interned value should be a pointer wrapper // then we can get its value with `interned.get()` instead of `interner.get(interned)` // and as a bonus, its validity is tracked with Rust's lifetime system // one problem is that we need two lifetimes: one for the bump allocator, one for the // hashmap // but that's okay, we can use: // ``` // struct Interner<'bump> { // bump: &'bump Bump, // lookup: FxHashMap // } // ``` /// An [`Interner`] is used to store a unique copy of a value of type `T`. This value /// is then identified by a lightweight index of type [`Interned`], which can /// be copied, compared, and hashed efficiently. An immutable reference to the original value /// can be retrieved using `self.get(interned)`. pub struct Interner { stable_store: Vec, lookup: FxHashMap>, } impl Default for Interner { fn default() -> Self { Self { stable_store: Default::default(), lookup: Default::default() } } } impl Interner where T: Clone + Eq + Hash, { pub fn insert(&mut self, s: T) -> Interned { if let Some(interned) = self.lookup.get(&s) { *interned } else { self.stable_store.push(s.clone()); let interned = Interned::new(self.stable_store.len() as u32 - 1); self.lookup.insert(s, interned); interned } } pub fn get(&self, interned: Interned) -> &T { &self.stable_store[interned.idx as usize] } } // Interned boilerplate implementations impl Hash for Interned { fn hash(&self, state: &mut H) { self.idx.hash(state); } } impl Ord for Interned { fn cmp(&self, other: &Self) -> std::cmp::Ordering { self.idx.cmp(&other.idx) } } impl PartialOrd for Interned { fn partial_cmp(&self, other: &Self) -> Option { self.idx.partial_cmp(&other.idx) } } impl Eq for Interned {} impl PartialEq for Interned { fn eq(&self, other: &Self) -> bool { self.idx == other.idx } } impl Clone for Interned { fn clone(&self) -> Self { Self { idx: self.idx, _phantom: PhantomData } } } impl Copy for Interned {}