src/librustc_data_structures/snapshot_map/mod.rs

   1 use crate::fx::FxHashMap;
   2 use crate::undo_log::{Rollback, Snapshots, UndoLogs, VecLog};
   3 use std::borrow::{Borrow, BorrowMut};
   4 use std::hash::Hash;
   5 use std::marker::PhantomData;
   6 use std::ops;
   7
   8 pub use crate::undo_log::Snapshot;
   9
  10 #[cfg(test)]
  11 mod tests;
  12
  13 pub type SnapshotMapStorage<K, V> = SnapshotMap<K, V, FxHashMap<K, V>, ()>;
  14 pub type SnapshotMapRef<'a, K, V, L> = SnapshotMap<K, V, &'a mut FxHashMap<K, V>, &'a mut L>;
  15
  16 pub struct SnapshotMap<K, V, M = FxHashMap<K, V>, L = VecLog<UndoLog<K, V>>> {
  17     map: M,
  18     undo_log: L,
  19     _marker: PhantomData<(K, V)>,
  20 }
  21
  22 // HACK(eddyb) manual impl avoids `Default` bounds on `K` and `V`.
  23 impl<K, V, M, L> Default for SnapshotMap<K, V, M, L>
  24 where
  25     M: Default,
  26     L: Default,
  27 {
  28     fn default() -> Self {
  29         SnapshotMap { map: Default::default(), undo_log: Default::default(), _marker: PhantomData }
  30     }
  31 }
  32
  33 pub enum UndoLog<K, V> {
  34     Inserted(K),
  35     Overwrite(K, V),
  36     Purged,
  37 }
  38
  39 impl<K, V, M, L> SnapshotMap<K, V, M, L> {
  40     pub fn with_log<L2>(&mut self, undo_log: L2) -> SnapshotMap<K, V, &mut M, L2> {
  41         SnapshotMap { map: &mut self.map, undo_log, _marker: PhantomData }
  42     }
  43 }
  44
  45 impl<K, V, M, L> SnapshotMap<K, V, M, L>
  46 where
  47     K: Hash + Clone + Eq,
  48     M: BorrowMut<FxHashMap<K, V>> + Borrow<FxHashMap<K, V>>,
  49     L: UndoLogs<UndoLog<K, V>>,
  50 {
  51     pub fn clear(&mut self) {
  52         self.map.borrow_mut().clear();
  53         self.undo_log.clear();
  54     }
  55
  56     pub fn insert(&mut self, key: K, value: V) -> bool {
  57         match self.map.borrow_mut().insert(key.clone(), value) {
  58             None => {
  59                 self.undo_log.push(UndoLog::Inserted(key));
  60                 true
  61             }
  62             Some(old_value) => {
  63                 self.undo_log.push(UndoLog::Overwrite(key, old_value));
  64                 false
  65             }
  66         }
  67     }
  68
  69     pub fn remove(&mut self, key: K) -> bool {
  70         match self.map.borrow_mut().remove(&key) {
  71             Some(old_value) => {
  72                 self.undo_log.push(UndoLog::Overwrite(key, old_value));
  73                 true
  74             }
  75             None => false,
  76         }
  77     }
  78
  79     pub fn get(&self, key: &K) -> Option<&V> {
  80         self.map.borrow().get(key)
  81     }
  82 }
  83
  84 impl<K, V> SnapshotMap<K, V>
  85 where
  86     K: Hash + Clone + Eq,
  87 {
  88     pub fn snapshot(&mut self) -> Snapshot {
  89         self.undo_log.start_snapshot()
  90     }
  91
  92     pub fn commit(&mut self, snapshot: Snapshot) {
  93         self.undo_log.commit(snapshot)
  94     }
  95
  96     pub fn rollback_to(&mut self, snapshot: Snapshot) {
  97         let map = &mut self.map;
  98         self.undo_log.rollback_to(|| map, snapshot)
  99     }
 100 }
 101
 102 impl<'k, K, V, M, L> ops::Index<&'k K> for SnapshotMap<K, V, M, L>
 103 where
 104     K: Hash + Clone + Eq,
 105     M: Borrow<FxHashMap<K, V>>,
 106 {
 107     type Output = V;
 108     fn index(&self, key: &'k K) -> &V {
 109         &self.map.borrow()[key]
 110     }
 111 }
 112
 113 impl<K, V, M, L> Rollback<UndoLog<K, V>> for SnapshotMap<K, V, M, L>
 114 where
 115     K: Eq + Hash,
 116     M: Rollback<UndoLog<K, V>>,
 117 {
 118     fn reverse(&mut self, undo: UndoLog<K, V>) {
 119         self.map.reverse(undo)
 120     }
 121 }
 122
 123 impl<K, V> Rollback<UndoLog<K, V>> for FxHashMap<K, V>
 124 where
 125     K: Eq + Hash,
 126 {
 127     fn reverse(&mut self, undo: UndoLog<K, V>) {
 128         match undo {
 129             UndoLog::Inserted(key) => {
 130                 self.remove(&key);
 131             }
 132
 133             UndoLog::Overwrite(key, old_value) => {
 134                 self.insert(key, old_value);
 135             }
 136
 137             UndoLog::Purged => {}
 138         }
 139     }
 140 }