1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
use std::sync::*;

///
/// Trait implemented by things that can be edited (or described) by sequences
/// of commands
/// 
pub trait EditLog<Edit> {
    ///
    /// Retrieves the number of edits in this log
    ///
    fn length(&self) -> usize;

    ///
    /// Reads a range of edits from this log
    /// 
    fn read(&self, indices: &mut Iterator<Item=usize>) -> Vec<Edit>;
}

///
/// Trait implemented by edit logs representing a set of edits
/// waiting to be committed to another edit log.
/// 
pub trait PendingEditLog<Edit> {
    ///
    /// The current set of pending edits
    /// 
    fn pending(&self) -> Vec<Edit>;

    ///
    /// Sets the pending edits for this log (replacing any existing
    /// pending edits)
    /// 
    fn set_pending(&mut self, edits: &[Edit]);

    ///
    /// Commits any pending edits for this log. Returns the
    /// range where the edits were committed.
    /// 
    fn commit_pending(&mut self);

    ///
    /// Cancels any pending edits for this log
    /// 
    fn cancel_pending(&mut self);
}

///
/// Utility trait that provides some extra sugar for edit logs
/// 
pub trait EditLogUtils<Edit> {
    ///
    /// Convenience version of read that works on an IntoIterator type
    /// 
    fn read_iter<ToIterator: IntoIterator<Item=usize>>(&self, items: ToIterator) -> Vec<Edit>;
}

impl<TEditLog: EditLog<Edit>, Edit> EditLogUtils<Edit> for TEditLog {
    #[inline]
    fn read_iter<ToIterator: IntoIterator<Item=usize>>(&self, items: ToIterator) -> Vec<Edit> {
        self.read(&mut items.into_iter())
    }
}

//
// Convenience implementations that let us treat references to edit logs as
// edit logs themselves if we want. (Very useful when mapping or slicing
// existing logs)
//

impl<'a, Edit, Log: EditLog<Edit>> EditLog<Edit> for &'a mut Log {
    #[inline]
    fn length(&self) -> usize { 
        (**self).length()
    }

    #[inline]
    fn read(&self, indices: &mut Iterator<Item=usize>) -> Vec<Edit> {
        (**self).read(indices)
    }
}

impl<'a, Edit, Log: PendingEditLog<Edit>> PendingEditLog<Edit> for &'a mut Log {
    #[inline]
    fn pending(&self) -> Vec<Edit> {
        (**self).pending()
    }

    #[inline]
    fn set_pending(&mut self, edits: &[Edit]) {
        (**self).set_pending(edits)
    }

    #[inline]
    fn commit_pending(&mut self) {
        (**self).commit_pending()
    }

    #[inline]
    fn cancel_pending(&mut self) {
        (**self).cancel_pending()
    }
}

impl<'a, Edit, Log: EditLog<Edit>> EditLog<Edit> for RwLockReadGuard<'a, Log> {
    #[inline]
    fn length(&self) -> usize { 
        (**self).length()
    }

    #[inline]
    fn read(&self, indices: &mut Iterator<Item=usize>) -> Vec<Edit> {
        (**self).read(indices)
    }
}

impl<'a, Edit, Log: EditLog<Edit>> EditLog<Edit> for RwLockWriteGuard<'a, Log> {
    #[inline]
    fn length(&self) -> usize { 
        (**self).length()
    }

    #[inline]
    fn read(&self, indices: &mut Iterator<Item=usize>) -> Vec<Edit> {
        (**self).read(indices)
    }
}

impl<'a, Edit, Log: PendingEditLog<Edit>> PendingEditLog<Edit> for RwLockWriteGuard<'a, Log> {
    #[inline]
    fn pending(&self) -> Vec<Edit> {
        (**self).pending()
    }

    #[inline]
    fn set_pending(&mut self, edits: &[Edit]) {
        (**self).set_pending(edits)
    }

    #[inline]
    fn commit_pending(&mut self) {
        (**self).commit_pending()
    }

    #[inline]
    fn cancel_pending(&mut self) {
        (**self).cancel_pending()
    }
}

impl<'a, Edit, Log: EditLog<Edit>> EditLog<Edit> for RwLock<Log> {
    #[inline]
    fn length(&self) -> usize { 
        self.read().unwrap().length()
    }

    #[inline]
    fn read(&self, indices: &mut Iterator<Item=usize>) -> Vec<Edit> {
        self.read().unwrap().read(indices)
    }
}

impl<'a, Edit, Log: PendingEditLog<Edit>> PendingEditLog<Edit> for RwLock<Log> {
    #[inline]
    fn pending(&self) -> Vec<Edit> {
        self.read().unwrap().pending()
    }

    #[inline]
    fn set_pending(&mut self, edits: &[Edit]) {
        // TODO: race condition if multiple threads are calling set/commit pending (as we release the write lock)
        // Maybe want to fix so that threads each have their own 'pending' list or something
        // Using the write guard implementation also fixes this issue
        self.write().unwrap().set_pending(edits)
    }

    #[inline]
    fn commit_pending(&mut self) {
        self.write().unwrap().commit_pending()
    }

    #[inline]
    fn cancel_pending(&mut self) {
        self.write().unwrap().cancel_pending()
    }
}

impl<'a, Edit, Log: EditLog<Edit>> EditLog<Edit> for Arc<RwLock<Log>> {
    #[inline]
    fn length(&self) -> usize { 
        (**self).read().unwrap().length()
    }

    #[inline]
    fn read(&self, indices: &mut Iterator<Item=usize>) -> Vec<Edit> {
        (**self).read().unwrap().read(indices)
    }
}

impl<'a, Edit, Log: PendingEditLog<Edit>> PendingEditLog<Edit> for Arc<RwLock<Log>> {
    #[inline]
    fn pending(&self) -> Vec<Edit> {
        (**self).read().unwrap().pending()
    }

    #[inline]
    fn set_pending(&mut self, edits: &[Edit]) {
        // TODO: race condition if multiple threads are calling set/commit pending (as we release the write lock)
        // Maybe want to fix so that threads each have their own 'pending' list or something
        // Using the write guard implementation also fixes this issue
        (**self).write().unwrap().set_pending(edits)
    }

    #[inline]
    fn commit_pending(&mut self) {
        (**self).write().unwrap().commit_pending()
    }

    #[inline]
    fn cancel_pending(&mut self) {
        (**self).write().unwrap().cancel_pending()
    }
}