buffer.rs 14.9 KB
Newer Older
Steven Stanfield's avatar
Steven Stanfield committed
1
use std::fmt::{self, Write as FmtWrite};
MovingtoMars's avatar
MovingtoMars committed
2 3
use std::io::{self, Write};
use std::iter::FromIterator;
Steven Stanfield's avatar
Steven Stanfield committed
4
use unicode_width::UnicodeWidthStr;
MovingtoMars's avatar
MovingtoMars committed
5

MovingtoMars's avatar
MovingtoMars committed
6
/// A modification performed on a `Buffer`. These are used for the purpose of undo/redo.
Steven Stanfield's avatar
Steven Stanfield committed
7
#[derive(Debug, Clone)]
MovingtoMars's avatar
MovingtoMars committed
8
pub enum Action {
MovingtoMars's avatar
MovingtoMars committed
9 10
    Insert { start: usize, text: Vec<char> },
    Remove { start: usize, text: Vec<char> },
11 12
    StartGroup,
    EndGroup,
MovingtoMars's avatar
MovingtoMars committed
13 14 15 16 17 18 19 20 21
}

impl Action {
    pub fn do_on(&self, buf: &mut Buffer) {
        match *self {
            Action::Insert { start, ref text } => buf.insert_raw(start, &text[..]),
            Action::Remove { start, ref text } => {
                buf.remove_raw(start, start + text.len());
            }
22
            Action::StartGroup | Action::EndGroup => {}
MovingtoMars's avatar
MovingtoMars committed
23 24 25 26 27 28 29 30 31
        }
    }

    pub fn undo(&self, buf: &mut Buffer) {
        match *self {
            Action::Insert { start, ref text } => {
                buf.remove_raw(start, start + text.len());
            }
            Action::Remove { start, ref text } => buf.insert_raw(start, &text[..]),
32
            Action::StartGroup | Action::EndGroup => {}
MovingtoMars's avatar
MovingtoMars committed
33 34 35 36
        }
    }
}

MovingtoMars's avatar
MovingtoMars committed
37 38 39
/// A buffer for text in the line editor.
///
/// It keeps track of each action performed on it for use with undo/redo.
MovingtoMars's avatar
MovingtoMars committed
40 41 42 43 44 45 46
#[derive(Debug, Clone)]
pub struct Buffer {
    data: Vec<char>,
    actions: Vec<Action>,
    undone_actions: Vec<Action>,
}

Steven Stanfield's avatar
Steven Stanfield committed
47 48 49 50 51 52 53
impl PartialEq for Buffer {
    fn eq(&self, other: &Self) -> bool {
        self.data == other.data
    }
}
impl Eq for Buffer {}

MovingtoMars's avatar
MovingtoMars committed
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71
impl From<Buffer> for String {
    fn from(buf: Buffer) -> Self {
        String::from_iter(buf.data)
    }
}

impl From<String> for Buffer {
    fn from(s: String) -> Self {
        Buffer::from_iter(s.chars())
    }
}

impl<'a> From<&'a str> for Buffer {
    fn from(s: &'a str) -> Self {
        Buffer::from_iter(s.chars())
    }
}

72 73 74
impl fmt::Display for Buffer {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        for &c in &self.data {
75
            f.write_char(c)?;
76 77 78 79 80
        }
        Ok(())
    }
}

MovingtoMars's avatar
MovingtoMars committed
81 82 83 84 85 86 87 88 89 90
impl FromIterator<char> for Buffer {
    fn from_iter<T: IntoIterator<Item = char>>(t: T) -> Self {
        Buffer {
            data: t.into_iter().collect(),
            actions: Vec::new(),
            undone_actions: Vec::new(),
        }
    }
}

AdminXVII's avatar
AdminXVII committed
91 92 93 94 95 96
impl Default for Buffer {
    fn default() -> Self {
        Self::new()
    }
}

MovingtoMars's avatar
MovingtoMars committed
97 98 99 100 101 102 103 104 105 106 107 108 109 110
impl Buffer {
    pub fn new() -> Self {
        Buffer {
            data: Vec::new(),
            actions: Vec::new(),
            undone_actions: Vec::new(),
        }
    }

    pub fn clear_actions(&mut self) {
        self.actions.clear();
        self.undone_actions.clear();
    }

111 112 113 114 115 116 117 118
    pub fn start_undo_group(&mut self) {
        self.actions.push(Action::StartGroup);
    }

    pub fn end_undo_group(&mut self) {
        self.actions.push(Action::EndGroup);
    }

MovingtoMars's avatar
MovingtoMars committed
119
    pub fn undo(&mut self) -> bool {
120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
        use Action::*;

        let did = !self.actions.is_empty();
        let mut group_nest = 0;
        let mut group_count = 0;
        while let Some(act) = self.actions.pop() {
            act.undo(self);
            self.undone_actions.push(act.clone());
            match act {
                EndGroup => {
                    group_nest += 1;
                    group_count = 0;
                }
                StartGroup => group_nest -= 1,
                // count the actions in this group so we can ignore empty groups below
                _ => group_count += 1,
            }

            // if we aren't in a group, and the last group wasn't empty
            if group_nest == 0 && group_count > 0 {
                break;
MovingtoMars's avatar
MovingtoMars committed
141 142
            }
        }
143
        did
MovingtoMars's avatar
MovingtoMars committed
144 145 146
    }

    pub fn redo(&mut self) -> bool {
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167
        use Action::*;

        let did = !self.undone_actions.is_empty();
        let mut group_nest = 0;
        let mut group_count = 0;
        while let Some(act) = self.undone_actions.pop() {
            act.do_on(self);
            self.actions.push(act.clone());
            match act {
                StartGroup => {
                    group_nest += 1;
                    group_count = 0;
                }
                EndGroup => group_nest -= 1,
                // count the actions in this group so we can ignore empty groups below
                _ => group_count += 1,
            }

            // if we aren't in a group, and the last group wasn't empty
            if group_nest == 0 && group_count > 0 {
                break;
MovingtoMars's avatar
MovingtoMars committed
168 169
            }
        }
170
        did
MovingtoMars's avatar
MovingtoMars committed
171 172 173
    }

    pub fn revert(&mut self) -> bool {
174
        if self.actions.is_empty() {
MovingtoMars's avatar
MovingtoMars committed
175 176 177 178 179 180 181 182 183 184 185 186
            return false;
        }

        while self.undo() {}
        true
    }

    fn push_action(&mut self, act: Action) {
        self.actions.push(act);
        self.undone_actions.clear();
    }

187
    pub fn last_arg(&self) -> Option<&[char]> {
Steven Stanfield's avatar
Steven Stanfield committed
188 189 190 191
        self.data
            .split(|&c| c == ' ')
            .filter(|s| !s.is_empty())
            .last()
192 193
    }

MovingtoMars's avatar
MovingtoMars committed
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
    pub fn num_chars(&self) -> usize {
        self.data.len()
    }

    pub fn num_bytes(&self) -> usize {
        let s: String = self.clone().into();
        s.len()
    }

    pub fn char_before(&self, cursor: usize) -> Option<char> {
        if cursor == 0 {
            None
        } else {
            self.data.get(cursor - 1).cloned()
        }
    }

    pub fn char_after(&self, cursor: usize) -> Option<char> {
        self.data.get(cursor).cloned()
    }

    /// Returns the number of characters removed.
    pub fn remove(&mut self, start: usize, end: usize) -> usize {
        let s = self.remove_raw(start, end);
        let num_removed = s.len();
AdminXVII's avatar
AdminXVII committed
219
        self.push_action(Action::Remove { start, text: s });
MovingtoMars's avatar
MovingtoMars committed
220 221 222 223 224
        num_removed
    }

    pub fn insert(&mut self, start: usize, text: &[char]) {
        let act = Action::Insert {
AdminXVII's avatar
AdminXVII committed
225
            start,
MovingtoMars's avatar
MovingtoMars committed
226 227 228 229 230 231
            text: text.into(),
        };
        act.do_on(self);
        self.push_action(act);
    }

232
    // XXX rename, too confusing
233 234 235 236 237
    pub fn insert_from_buffer(&mut self, other: &Buffer) {
        let start = self.data.len();
        self.insert(start, &other.data[start..])
    }

238 239 240 241 242 243
    pub fn copy_buffer(&mut self, other: &Buffer) {
        let data_len = self.data.len();
        self.remove(0, data_len);
        self.insert(0, &other.data[0..])
    }

MovingtoMars's avatar
MovingtoMars committed
244 245 246 247 248
    pub fn range(&self, start: usize, end: usize) -> String {
        self.data[start..end].iter().cloned().collect()
    }

    pub fn range_chars(&self, start: usize, end: usize) -> Vec<char> {
249
        self.data[start..end].to_owned()
MovingtoMars's avatar
MovingtoMars committed
250 251
    }

MovingtoMars's avatar
MovingtoMars committed
252 253 254 255 256
    pub fn width(&self) -> Vec<usize> {
        self.range_width(0, self.num_chars())
    }

    pub fn range_width(&self, start: usize, end: usize) -> Vec<usize> {
Steven Stanfield's avatar
Steven Stanfield committed
257 258 259 260
        self.range(start, end)
            .split('\n')
            .map(|s| s.width())
            .collect()
MovingtoMars's avatar
MovingtoMars committed
261 262 263
    }

    pub fn lines(&self) -> Vec<String> {
Steven Stanfield's avatar
Steven Stanfield committed
264 265 266 267
        self.data
            .split(|&c| c == '\n')
            .map(|s| s.iter().cloned().collect())
            .collect()
268 269
    }

MovingtoMars's avatar
MovingtoMars committed
270 271 272 273 274
    pub fn chars(&self) -> ::std::slice::Iter<char> {
        self.data.iter()
    }

    pub fn truncate(&mut self, num: usize) {
275 276
        let end = self.data.len();
        self.remove(num, end);
MovingtoMars's avatar
MovingtoMars committed
277 278 279
    }

    pub fn print<W>(&self, out: &mut W) -> io::Result<()>
Steven Stanfield's avatar
Steven Stanfield committed
280 281
    where
        W: Write,
MovingtoMars's avatar
MovingtoMars committed
282 283
    {
        let string: String = self.data.iter().cloned().collect();
284
        out.write_all(string.as_bytes())
MovingtoMars's avatar
MovingtoMars committed
285 286
    }

MovingtoMars's avatar
MovingtoMars committed
287 288 289 290 291 292
    pub fn as_bytes(&self) -> Vec<u8> {
        // NOTE: not particularly efficient. Could make a proper byte iterator with minimal
        // allocations if performance becomes an issue.
        self.to_string().into_bytes()
    }

293 294 295
    /// Takes other buffer, measures its length and prints this buffer from the point where
    /// the other stopped.
    /// Used to implement autosuggestions.
Sehny's avatar
Sehny committed
296
    pub fn print_rest<W>(&self, out: &mut W, after: usize) -> io::Result<usize>
Steven Stanfield's avatar
Steven Stanfield committed
297 298
    where
        W: Write,
299
    {
Sehny's avatar
Sehny committed
300
        let string: String = self.data.iter().skip(after).cloned().collect();
301
        out.write_all(string.as_bytes())?;
302

303
        Ok(string.len())
304 305
    }

MovingtoMars's avatar
MovingtoMars committed
306 307 308 309 310 311 312 313 314
    fn remove_raw(&mut self, start: usize, end: usize) -> Vec<char> {
        self.data.drain(start..end).collect()
    }

    fn insert_raw(&mut self, start: usize, text: &[char]) {
        for (i, &c) in text.iter().enumerate() {
            self.data.insert(start + i, c)
        }
    }
315

316 317
    /// Check if the other buffer starts with the same content as this one.
    /// Used to implement autosuggestions.
Sehny's avatar
Sehny committed
318
    pub fn starts_with(&self, other: &Buffer) -> bool {
319 320
        let other_len = other.data.len();
        let self_len = self.data.len();
Steven Stanfield's avatar
Steven Stanfield committed
321 322 323
        if !other.data.is_empty() && self_len != other_len {
            let match_let = self
                .data
324 325 326
                .iter()
                .zip(&other.data)
                .take_while(|&(s, o)| *s == *o)
327
                .count();
328
            match_let == other_len
329 330 331 332
        } else {
            false
        }
    }
333

334 335 336
    /// Check if the buffer contains pattern.
    /// Used to implement history search.
    pub fn contains(&self, pattern: &Buffer) -> bool {
Steven Stanfield's avatar
Steven Stanfield committed
337 338 339 340
        let search_term: &[char] = &pattern.data;
        if search_term.is_empty() {
            return false;
        }
Steven Stanfield's avatar
Steven Stanfield committed
341 342 343
        self.data
            .windows(search_term.len())
            .any(|window| window == search_term)
344 345
    }

346 347 348 349
    /// Return true if the buffer is empty.
    pub fn is_empty(&self) -> bool {
        self.data.is_empty()
    }
MovingtoMars's avatar
MovingtoMars committed
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

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_insert() {
        let mut buf = Buffer::new();
        buf.insert(0, &['a', 'b', 'c', 'd', 'e', 'f', 'g']);
        assert_eq!(String::from(buf), "abcdefg");
    }

    #[test]
    fn test_truncate_empty() {
        let mut buf = Buffer::new();
        buf.truncate(0);
        assert_eq!(String::from(buf), "");
    }

    #[test]
    fn test_truncate_all() {
        let mut buf = Buffer::new();
        buf.insert(0, &['a', 'b', 'c', 'd', 'e', 'f', 'g']);
        buf.truncate(0);
        assert_eq!(String::from(buf), "");
    }

    #[test]
    fn test_truncate_end() {
        let mut buf = Buffer::new();
        buf.insert(0, &['a', 'b', 'c', 'd', 'e', 'f', 'g']);
        let end = buf.num_chars();
        buf.truncate(end);
        assert_eq!(String::from(buf), "abcdefg");
    }

    #[test]
    fn test_truncate_part() {
        let mut buf = Buffer::new();
        buf.insert(0, &['a', 'b', 'c', 'd', 'e', 'f', 'g']);
        buf.truncate(3);
        assert_eq!(String::from(buf), "abc");
    }

    #[test]
    fn test_truncate_empty_undo() {
        let mut buf = Buffer::new();
        buf.truncate(0);
        buf.undo();
        assert_eq!(String::from(buf), "");
    }

    #[test]
    fn test_truncate_all_then_undo() {
        let mut buf = Buffer::new();
        buf.insert(0, &['a', 'b', 'c', 'd', 'e', 'f', 'g']);
        buf.truncate(0);
        buf.undo();
        assert_eq!(String::from(buf), "abcdefg");
    }

    #[test]
    fn test_truncate_end_then_undo() {
        let mut buf = Buffer::new();
        buf.insert(0, &['a', 'b', 'c', 'd', 'e', 'f', 'g']);
        let end = buf.num_chars();
        buf.truncate(end);
        buf.undo();
        assert_eq!(String::from(buf), "abcdefg");
    }

    #[test]
    fn test_truncate_part_then_undo() {
        let mut buf = Buffer::new();
        buf.insert(0, &['a', 'b', 'c', 'd', 'e', 'f', 'g']);
        buf.truncate(3);
        buf.undo();
        assert_eq!(String::from(buf), "abcdefg");
    }
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

    #[test]
    fn test_undo_group() {
        let mut buf = Buffer::new();
        buf.insert(0, &['a', 'b', 'c', 'd', 'e', 'f', 'g']);
        buf.start_undo_group();
        buf.remove(0, 1);
        buf.remove(0, 1);
        buf.remove(0, 1);
        buf.end_undo_group();
        assert_eq!(buf.undo(), true);
        assert_eq!(String::from(buf), "abcdefg");
    }

    #[test]
    fn test_redo_group() {
        let mut buf = Buffer::new();
        buf.insert(0, &['a', 'b', 'c', 'd', 'e', 'f', 'g']);
        buf.start_undo_group();
        buf.remove(0, 1);
        buf.remove(0, 1);
        buf.remove(0, 1);
        buf.end_undo_group();
        assert_eq!(buf.undo(), true);
        assert_eq!(buf.redo(), true);
        assert_eq!(String::from(buf), "defg");
    }

    #[test]
    fn test_nested_undo_group() {
        let mut buf = Buffer::new();
        buf.insert(0, &['a', 'b', 'c', 'd', 'e', 'f', 'g']);
        buf.start_undo_group();
        buf.remove(0, 1);
        buf.start_undo_group();
        buf.remove(0, 1);
        buf.end_undo_group();
        buf.remove(0, 1);
        buf.end_undo_group();
        assert_eq!(buf.undo(), true);
        assert_eq!(String::from(buf), "abcdefg");
    }

    #[test]
    fn test_nested_redo_group() {
        let mut buf = Buffer::new();
        buf.insert(0, &['a', 'b', 'c', 'd', 'e', 'f', 'g']);
        buf.start_undo_group();
        buf.remove(0, 1);
        buf.start_undo_group();
        buf.remove(0, 1);
        buf.end_undo_group();
        buf.remove(0, 1);
        buf.end_undo_group();
        assert_eq!(buf.undo(), true);
        assert_eq!(buf.redo(), true);
        assert_eq!(String::from(buf), "defg");
    }
Sehny's avatar
Sehny committed
488 489

    #[test]
Sehny's avatar
Sehny committed
490
    fn test_starts_with() {
Sehny's avatar
Sehny committed
491 492 493 494
        let mut buf = Buffer::new();
        buf.insert(0, &['a', 'b', 'c', 'd', 'e', 'f', 'g']);
        let mut buf2 = Buffer::new();
        buf2.insert(0, &['a', 'b', 'c']);
Sehny's avatar
Sehny committed
495
        assert_eq!(buf.starts_with(&buf2), true);
Sehny's avatar
Sehny committed
496 497 498
    }

    #[test]
Sehny's avatar
Sehny committed
499
    fn test_does_not_start_with() {
Sehny's avatar
Sehny committed
500 501 502 503
        let mut buf = Buffer::new();
        buf.insert(0, &['a', 'b', 'c']);
        let mut buf2 = Buffer::new();
        buf2.insert(0, &['a', 'b', 'c']);
Sehny's avatar
Sehny committed
504
        assert_eq!(buf.starts_with(&buf2), false);
Sehny's avatar
Sehny committed
505 506 507 508 509 510 511 512
    }

    #[test]
    fn test_is_not_match2() {
        let mut buf = Buffer::new();
        buf.insert(0, &['a', 'b', 'c', 'd', 'e', 'f', 'g']);
        let mut buf2 = Buffer::new();
        buf2.insert(0, &['x', 'y', 'z']);
Sehny's avatar
Sehny committed
513
        assert_eq!(buf.starts_with(&buf2), false);
Sehny's avatar
Sehny committed
514 515
    }

516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542
    #[test]
    fn test_contains() {
        let mut buf = Buffer::new();
        buf.insert(0, &['a', 'b', 'c', 'd', 'e', 'f', 'g']);
        let mut buf2 = Buffer::new();
        buf2.insert(0, &['a', 'b', 'c']);
        assert_eq!(buf.contains(&buf2), true);
        let mut buf2 = Buffer::new();
        buf2.insert(0, &['c', 'd', 'e']);
        assert_eq!(buf.contains(&buf2), true);
        let mut buf2 = Buffer::new();
        buf2.insert(0, &['e', 'f', 'g']);
        assert_eq!(buf.contains(&buf2), true);
    }

    #[test]
    fn test_does_not_contain() {
        let mut buf = Buffer::new();
        buf.insert(0, &['a', 'b', 'c', 'd', 'e', 'f', 'g']);
        let mut buf2 = Buffer::new();
        buf2.insert(0, &['x', 'b', 'c']);
        assert_eq!(buf.contains(&buf2), false);
        let mut buf2 = Buffer::new();
        buf2.insert(0, &['a', 'b', 'd']);
        assert_eq!(buf.contains(&buf2), false);
    }

Sehny's avatar
Sehny committed
543 544 545 546 547 548 549
    #[test]
    fn test_print_rest() {
        let mut buf = Buffer::new();
        buf.insert(0, &['a', 'b', 'c', 'd', 'e', 'f', 'g']);
        let mut buf2 = Buffer::new();
        buf2.insert(0, &['a', 'b', 'c']);
        let mut out: Vec<u8> = vec![];
Sehny's avatar
Sehny committed
550
        buf.print_rest(&mut out, buf2.data.len()).unwrap();
Sehny's avatar
Sehny committed
551 552
        assert_eq!(out.len(), 4);
    }
553
}