modalkit 0.0.25

A library for building applications that use modal editing
Documentation
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
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
use std::cmp::{Ord, Ordering};
use std::slice::IterMut;

use crate::prelude::*;
use crate::{
    editing::cursor::{Adjustable, CursorAdjustment, CursorState},
    editing::rope::EditRope,
    util::idx_offset,
};

/// Errors returned when combining cursor groups.
#[derive(thiserror::Error, Debug, Eq, PartialEq)]
pub enum CursorGroupCombineError {
    /// Empty cursor group.
    #[error("Specified register does not contain a cursor group")]
    Empty(Register),

    /// The cursors groups need to be the same size.
    #[error("The two groups are not the same size ({0} vs {1})")]
    SizeMismatch(usize, usize),
}

/// Iterate over references to [CursorState] values within a [CursorGroup].
pub struct CursorGroupIter<'a> {
    members: std::vec::IntoIter<&'a CursorState>,
    leader: Option<&'a CursorState>,
}

impl<'a> Iterator for CursorGroupIter<'a> {
    type Item = &'a CursorState;

    fn next(&mut self) -> Option<Self::Item> {
        if let Some(m) = self.members.next() {
            if let Some(ref mut l) = self.leader {
                if let Ordering::Less = Ord::cmp(l, &m) {
                    return std::mem::replace(l, m).into();
                }
            }

            return Some(m);
        }

        return self.leader.take();
    }
}

impl DoubleEndedIterator for CursorGroupIter<'_> {
    fn next_back(&mut self) -> Option<Self::Item> {
        if let Some(m) = self.members.next_back() {
            if let Some(ref mut l) = self.leader {
                if let Ordering::Greater = Ord::cmp(l, &m) {
                    return std::mem::replace(l, m).into();
                }
            }

            return Some(m);
        }

        return self.leader.take();
    }
}

/// Iterate over mutable references to [CursorState] values within a [CursorGroup].
pub struct CursorGroupIterMut<'a> {
    members: IterMut<'a, CursorState>,
    leader: Option<&'a mut CursorState>,
}

impl<'a> Iterator for CursorGroupIterMut<'a> {
    type Item = &'a mut CursorState;

    fn next(&mut self) -> Option<Self::Item> {
        if let Some(m) = self.members.next() {
            if let Some(ref mut l) = self.leader {
                if let Ordering::Less = Ord::cmp(l, &m) {
                    return std::mem::replace(l, m).into();
                }
            }

            return Some(m);
        }

        return self.leader.take();
    }
}

impl DoubleEndedIterator for CursorGroupIterMut<'_> {
    fn next_back(&mut self) -> Option<Self::Item> {
        if let Some(m) = self.members.next_back() {
            if let Some(ref mut l) = self.leader {
                if let Ordering::Greater = Ord::cmp(l, &m) {
                    return std::mem::replace(l, m).into();
                }
            }

            return Some(m);
        }

        return self.leader.take();
    }
}

/// A group of cursors, where one of them has on-screen focus.
#[derive(Clone, Debug, Default, Eq, PartialEq)]
pub struct CursorGroup {
    /// The members of the cursor group which do not have have on-screen focus.
    pub members: Vec<CursorState>,

    /// The main cursor, which has on-screen focus.
    pub leader: CursorState,
}

impl CursorGroup {
    /// Create a new [CursorGroup] with the given leader and followers.
    pub fn new(leader: CursorState, members: Vec<CursorState>) -> Self {
        let mut group = CursorGroup { leader, members };

        group.merge();

        return group;
    }

    fn len(&self) -> usize {
        self.members.len() + 1
    }

    /// Ensure that the member cursor states are sorted by their cursors.
    pub fn sort(&mut self) {
        self.members.sort()
    }

    /// Iterate over mutable references to the [CursorState] values in this group, in cursor order.
    pub fn iter_mut(&mut self) -> CursorGroupIterMut<'_> {
        self.sort();

        CursorGroupIterMut {
            members: self.members.iter_mut(),
            leader: Some(&mut self.leader),
        }
    }

    /// Iterate over references to the [CursorState] values in this group, in cursor order.
    pub fn iter(&self) -> CursorGroupIter<'_> {
        let mut members = self.members.iter().collect::<Vec<_>>();
        members.sort();

        CursorGroupIter {
            members: members.into_iter(),
            leader: Some(&self.leader),
        }
    }

    /// Clone each cursor in the group *n* times.
    pub fn split(&mut self, count: usize) {
        let mut created = vec![];

        for state in self.iter_mut() {
            for _ in 0..count {
                created.push(state.clone());
            }
        }

        self.members.append(&mut created);
        self.members.sort();
    }

    /// Close some of the cursors in this cursor group.
    pub fn close(&mut self, target: &CursorCloseTarget) {
        match target {
            CursorCloseTarget::Leader => {
                self.members.sort();

                let midx =
                    self.members.iter().position(|state| self.leader.cursor() < state.cursor());

                if let Some(idx) = midx {
                    self.leader = self.members.remove(idx);
                } else if let Some(leader) = self.members.pop() {
                    self.leader = leader;
                }
            },
            CursorCloseTarget::Followers => {
                self.members = vec![];
            },
        }
    }

    /// Rotate the cursor leader forwards or backwards *n* times.
    pub fn rotate(&mut self, dir: MoveDir1D, offset: usize) {
        if self.members.is_empty() {
            return;
        }

        // Make the leader one of the members.
        let mut members = vec![(true, std::mem::take(&mut self.leader))];

        for member in std::mem::take(&mut self.members).into_iter() {
            members.push((false, member));
        }

        // Sort all of the members by their cursor positions.
        members.sort_by(|a, b| {
            return a.1.cursor().cmp(b.1.cursor());
        });

        // Calculate the relative offset of the new leader from the old leader.
        let idx = members
            .iter()
            .position(|(leader, _)| *leader)
            .map(|idx| idx_offset(idx, offset, &dir, members.len(), true).unwrap_or(idx))
            .unwrap_or(0);

        // Promote the new leader.
        self.leader = members.remove(idx).1;
        self.members = members.into_iter().map(|p| p.1).collect();
    }

    /// Combine this cursor group with another.
    pub fn combine(
        &self,
        other: &Self,
        style: &CursorGroupCombineStyle,
        rope: &EditRope,
    ) -> Result<Self, CursorGroupCombineError> {
        let group = match style {
            CursorGroupCombineStyle::Append => {
                let leader = other.leader.clone();
                let members = other.members.iter().chain(self.iter()).cloned().collect::<Vec<_>>();

                CursorGroup::new(leader, members)
            },
            CursorGroupCombineStyle::Merge(style) => {
                let alen = self.len();
                let blen = other.len();

                if alen != blen {
                    let err = CursorGroupCombineError::SizeMismatch(alen, blen);

                    return Err(err);
                }

                // Preserve relative leader position.
                let mut a = vec![(&self.leader, true)];
                let mut b = vec![&other.leader];

                for member in self.members.iter() {
                    a.push((member, false));
                }

                for member in other.members.iter() {
                    b.push(member);
                }

                a.sort();
                b.sort();

                let mut leader = CursorState::default();
                let mut members = vec![];

                for ((a, leads), b) in a.iter().zip(b.iter()) {
                    let c = a.merge(b, style, rope);

                    if *leads {
                        leader = c;
                    } else {
                        members.push(c);
                    }
                }

                CursorGroup::new(leader, members)
            },
            CursorGroupCombineStyle::Replace => other.clone(),
        };

        return Ok(group);
    }

    /// Merge any overlapping selections.
    pub fn merge(&mut self) {
        if self.members.is_empty() {
            // There's nothing to merge.
            return;
        }

        // Begin by sorting and merging member selections.
        let mut unmerged = std::mem::take(&mut self.members);
        unmerged.sort_by(|a, b| a.start().cmp(b.start()));

        let mut iter = unmerged.into_iter();
        let mut merged = Vec::new();

        let mut a = iter.next().unwrap();

        for b in iter {
            if a.overlaps(&b) {
                // Merge w/ previous selection.
                a = a.union(&b);
            } else {
                // Save the previous selection, and begin merges into this one.
                merged.push(a);
                a = b;
            }
        }

        // Commit last member.
        merged.push(a);

        // Now we can merge them into the current leader.
        for m in merged.into_iter() {
            if self.leader.overlaps(&m) {
                // Merge this selection into the leader.
                self.leader = self.leader.union(&m);
            } else {
                // Keep this selection.
                self.members.push(m);
            }
        }
    }
}

impl Adjustable for CursorGroup {
    fn zero(&mut self) {
        for member in self.members.iter_mut() {
            member.zero();
        }

        self.leader.zero();
    }

    fn adjust(&mut self, adjs: &[CursorAdjustment]) {
        for member in self.members.iter_mut() {
            member.adjust(adjs);
        }

        self.leader.adjust(adjs);
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::editing::cursor::Cursor;

    #[test]
    fn test_combine_append() {
        // Define some unique cursors.
        let c0 = CursorState::Location(Cursor::new(0, 0));
        let c1 = CursorState::Location(Cursor::new(0, 1));
        let c2 = CursorState::Location(Cursor::new(0, 2));
        let c3 = CursorState::Location(Cursor::new(0, 3));
        let c4 = CursorState::Location(Cursor::new(0, 4));

        // Create two cursor groups.
        let a = CursorGroup::new(c1.clone(), vec![c0.clone(), c2.clone()]);
        let b = CursorGroup::new(c4.clone(), vec![c3.clone()]);
        let r = EditRope::from("");

        let res = a.combine(&b, &CursorGroupCombineStyle::Append, &r).unwrap();
        let exp =
            CursorGroup::new(c4.clone(), vec![c0.clone(), c1.clone(), c2.clone(), c3.clone()]);
        assert_eq!(res, exp);
    }

    #[test]
    fn test_combine_merge_error() {
        // Define some unique cursors.
        let c0 = CursorState::Location(Cursor::new(0, 0));
        let c1 = CursorState::Location(Cursor::new(0, 1));
        let c2 = CursorState::Location(Cursor::new(0, 2));
        let c3 = CursorState::Location(Cursor::new(0, 3));
        let c4 = CursorState::Location(Cursor::new(0, 4));

        // Create two cursor groups.
        let a = CursorGroup::new(c1.clone(), vec![c0.clone(), c2.clone()]);
        let b = CursorGroup::new(c4.clone(), vec![c3.clone()]);
        let r = EditRope::from("");

        let res = a.combine(&b, &CursorMergeStyle::Union.into(), &r);
        assert_eq!(res, Err(CursorGroupCombineError::SizeMismatch(3, 2)));
    }

    #[test]
    fn test_combine_replace() {
        // Define some unique cursors.
        let c0 = CursorState::Location(Cursor::new(0, 0));
        let c1 = CursorState::Location(Cursor::new(0, 1));
        let c2 = CursorState::Location(Cursor::new(0, 2));
        let c3 = CursorState::Location(Cursor::new(0, 3));
        let c4 = CursorState::Location(Cursor::new(0, 4));

        // Create two cursor groups.
        let a = CursorGroup::new(c1.clone(), vec![c0.clone(), c2.clone()]);
        let b = CursorGroup::new(c4.clone(), vec![c3.clone()]);
        let r = EditRope::from("");

        // a replaced with b is b.
        let res = a.combine(&b, &CursorGroupCombineStyle::Replace, &r).unwrap();
        assert_eq!(res, b);

        // b replaced with a is a.
        let res = b.combine(&a, &CursorGroupCombineStyle::Replace, &r).unwrap();
        assert_eq!(res, a);
    }

    #[test]
    fn test_group_iter() {
        let cw = TargetShape::CharWise;
        let c1 = CursorState::Location(Cursor::new(0, 1));
        let c2 = CursorState::Location(Cursor::new(0, 2));
        let s3 = CursorState::Selection(Cursor::new(0, 3), Cursor::new(0, 4), cw);
        let c5 = CursorState::Location(Cursor::new(0, 5));
        let c7 = CursorState::Location(Cursor::new(0, 7));

        // Skip the merge() call in new() so we can verify that members gets sorted.
        let group = CursorGroup {
            leader: c5.clone(),
            members: vec![c7.clone(), c2.clone(), c1.clone(), s3.clone()],
        };

        let mut iter = group.iter();

        assert_eq!(iter.next(), Some(&c1));
        assert_eq!(iter.next(), Some(&c2));
        assert_eq!(iter.next(), Some(&s3));
        assert_eq!(iter.next(), Some(&c5));
        assert_eq!(iter.next(), Some(&c7));
        assert_eq!(iter.next(), None);
    }

    #[test]
    fn test_group_iter_mut() {
        let cw = TargetShape::CharWise;
        let mut c1 = CursorState::Location(Cursor::new(0, 1));
        let mut c2 = CursorState::Location(Cursor::new(0, 2));
        let mut s3 = CursorState::Selection(Cursor::new(0, 3), Cursor::new(0, 4), cw);
        let mut c5 = CursorState::Location(Cursor::new(0, 5));
        let mut c7 = CursorState::Location(Cursor::new(0, 7));

        // Skip the merge() call in new() so we can verify that members gets sorted.
        let mut group = CursorGroup {
            leader: c5.clone(),
            members: vec![c7.clone(), c2.clone(), c1.clone(), s3.clone()],
        };

        let mut iter = group.iter_mut();

        assert_eq!(iter.next(), Some(&mut c1));
        assert_eq!(iter.next(), Some(&mut c2));
        assert_eq!(iter.next(), Some(&mut s3));
        assert_eq!(iter.next(), Some(&mut c5));
        assert_eq!(iter.next(), Some(&mut c7));
        assert_eq!(iter.next(), None);
    }

    #[test]
    fn test_group_merge() {
        let cw = TargetShape::CharWise;
        let s1 = CursorState::Selection(Cursor::new(0, 2), Cursor::new(0, 5), cw);
        let s2 = CursorState::Selection(Cursor::new(2, 4), Cursor::new(2, 7), cw);
        let s3 = CursorState::Selection(Cursor::new(0, 0), Cursor::new(0, 3), cw);
        let s4 = CursorState::Selection(Cursor::new(0, 6), Cursor::new(2, 3), cw);
        let s5 = CursorState::Selection(Cursor::new(3, 0), Cursor::new(3, 5), cw);
        let s6 = CursorState::Selection(Cursor::new(5, 0), Cursor::new(2, 7), cw);

        // Skip the merge() call in new() so we do the call ourselves.
        let mut group = CursorGroup {
            leader: s1.clone(),
            members: vec![s2.clone(), s3.clone(), s4.clone(), s5.clone(), s6.clone()],
        };

        group.merge();

        assert_eq!(group.leader, CursorState::Selection(Cursor::new(0, 0), Cursor::new(0, 5), cw));
        assert_eq!(group.members, vec![
            CursorState::Selection(Cursor::new(0, 6), Cursor::new(2, 3), cw),
            CursorState::Selection(Cursor::new(2, 4), Cursor::new(5, 0), cw),
        ]);
    }

    #[test]
    fn test_group_rotate() {
        let c0 = CursorState::Location(Cursor::new(0, 0));
        let c1 = CursorState::Location(Cursor::new(0, 1));
        let c2 = CursorState::Location(Cursor::new(0, 2));
        let c3 = CursorState::Location(Cursor::new(0, 3));
        let c4 = CursorState::Location(Cursor::new(0, 4));
        let c5 = CursorState::Location(Cursor::new(0, 5));
        let mut group = CursorGroup::new(c1.clone(), vec![
            c0.clone(),
            c2.clone(),
            c3.clone(),
            c4.clone(),
            c5.clone(),
        ]);

        group.rotate(MoveDir1D::Next, 2);
        assert_eq!(group.leader, c3.clone());
        assert_eq!(group.members, vec![c0.clone(), c1.clone(), c2.clone(), c4.clone(), c5.clone()]);

        group.rotate(MoveDir1D::Next, 3);
        assert_eq!(group.leader, c0.clone());
        assert_eq!(group.members, vec![c1.clone(), c2.clone(), c3.clone(), c4.clone(), c5.clone()]);

        group.rotate(MoveDir1D::Previous, 1);
        assert_eq!(group.leader, c5.clone());
        assert_eq!(group.members, vec![c0.clone(), c1.clone(), c2.clone(), c3.clone(), c4.clone()]);
    }
}