vimltui 0.2.11

A self-contained, embeddable Vim editor for Ratatui TUI applications
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
509
510
511
512
513
514
515
516
517
518
519
520
521
use super::VimEditor;
use crate::{BlockInsertState, Register, VimMode, VisualKind, YankHighlight};

impl VimEditor {
    /// Enter visual mode
    pub fn enter_visual(&mut self, kind: VisualKind) {
        if !self.config.visual_allowed {
            return;
        }
        self.visual_anchor = Some((self.cursor_row, self.cursor_col));
        self.mode = VimMode::Visual(kind);
    }

    /// Get the ordered (start, end) of the visual selection
    pub fn visual_range(&self) -> Option<((usize, usize), (usize, usize))> {
        let anchor = self.visual_anchor?;
        let cursor = (self.cursor_row, self.cursor_col);

        let (start, end) = if anchor <= cursor {
            (anchor, cursor)
        } else {
            (cursor, anchor)
        };

        Some((start, end))
    }

    /// Delete visual selection
    pub fn visual_delete(&mut self) {
        if let Some(kind) = self.visual_kind() {
            self.save_undo();

            match kind {
                VisualKind::Line => {
                    if let Some(((sr, _), (er, _))) = self.visual_range() {
                        let text = self.delete_lines(sr, er - sr + 1);
                        self.unnamed_register = Register {
                            content: text,
                            linewise: true,
                        };
                    }
                }
                VisualKind::Char => {
                    if let Some(((sr, sc), (er, ec))) = self.visual_range() {
                        let ec = (ec + 1).min(
                            self.lines
                                .get(er)
                                .map(|l| l.len())
                                .unwrap_or(0),
                        );
                        if sr == er {
                            let text = self.delete_range(sc, ec, sr);
                            self.unnamed_register = Register {
                                content: text,
                                linewise: false,
                            };
                            self.cursor_col = sc;
                        } else {
                            // Multi-line char delete
                            let mut text = String::new();
                            text.push_str(&self.lines[sr][sc..]);
                            for row in (sr + 1)..er {
                                text.push('\n');
                                text.push_str(&self.lines[row]);
                            }
                            text.push('\n');
                            text.push_str(&self.lines[er][..ec.min(self.lines[er].len())]);

                            let after = self.lines[er][ec.min(self.lines[er].len())..].to_string();
                            self.lines[sr].truncate(sc);
                            self.lines[sr].push_str(&after);
                            if er > sr {
                                self.lines.drain((sr + 1)..=er);
                            }

                            self.unnamed_register = Register {
                                content: text,
                                linewise: false,
                            };
                            self.cursor_row = sr;
                            self.cursor_col = sc;
                            self.modified = true;
                        }
                    }
                }
                VisualKind::Block => {
                    // Block delete: remove columns from each line in the range
                    if let Some(((sr, sc), (er, ec))) = self.visual_range() {
                        let left = sc.min(ec);
                        let right = sc.max(ec) + 1;
                        let mut text = String::new();
                        for row in sr..=er.min(self.lines.len().saturating_sub(1)) {
                            let line_len = self.lines[row].len();
                            let l = left.min(line_len);
                            let r = right.min(line_len);
                            if l < r {
                                if !text.is_empty() {
                                    text.push('\n');
                                }
                                text.push_str(&self.lines[row][l..r]);
                                self.lines[row] = format!(
                                    "{}{}",
                                    &self.lines[row][..l],
                                    &self.lines[row][r..]
                                );
                            }
                        }
                        self.unnamed_register = Register {
                            content: text,
                            linewise: false,
                        };
                        self.cursor_row = sr;
                        self.cursor_col = left;
                        self.modified = true;
                    }
                }
            }

            // Always copy deleted text to system clipboard
            self.copy_to_system_clipboard(&self.unnamed_register.content.clone());
            self.exit_visual();
            self.clamp_cursor();
        }
    }

    /// Yank visual selection
    pub fn visual_yank(&mut self) {
        if let Some(kind) = self.visual_kind() {
            match kind {
                VisualKind::Line => {
                    if let Some(((sr, _), (er, _))) = self.visual_range() {
                        let end = er.min(self.lines.len().saturating_sub(1));
                        let text: Vec<&str> = self.lines[sr..=end]
                            .iter()
                            .map(|s| s.as_str())
                            .collect();
                        self.unnamed_register = Register {
                            content: text.join("\n"),
                            linewise: true,
                        };
                    }
                }
                VisualKind::Char => {
                    if let Some(((sr, sc), (er, ec))) = self.visual_range() {
                        let ec = (ec + 1).min(
                            self.lines.get(er).map(|l| l.len()).unwrap_or(0),
                        );
                        if sr == er {
                            let line = &self.lines[sr];
                            let s = sc.min(line.len());
                            let e = ec.min(line.len());
                            self.unnamed_register = Register {
                                content: line[s..e].to_string(),
                                linewise: false,
                            };
                        } else {
                            let mut text = String::new();
                            text.push_str(&self.lines[sr][sc..]);
                            for row in (sr + 1)..er {
                                text.push('\n');
                                text.push_str(&self.lines[row]);
                            }
                            text.push('\n');
                            text.push_str(&self.lines[er][..ec.min(self.lines[er].len())]);
                            self.unnamed_register = Register {
                                content: text,
                                linewise: false,
                            };
                        }
                    }
                }
                VisualKind::Block => {
                    if let Some(((sr, sc), (er, ec))) = self.visual_range() {
                        let left = sc.min(ec);
                        let right = sc.max(ec) + 1;
                        let mut text = String::new();
                        for row in sr..=er.min(self.lines.len().saturating_sub(1)) {
                            let line_len = self.lines[row].len();
                            let l = left.min(line_len);
                            let r = right.min(line_len);
                            if !text.is_empty() {
                                text.push('\n');
                            }
                            if l < r {
                                text.push_str(&self.lines[row][l..r]);
                            }
                        }
                        self.unnamed_register = Register {
                            content: text,
                            linewise: false,
                        };
                    }
                }
            }
            // Always copy to system clipboard
            self.copy_to_system_clipboard(&self.unnamed_register.content.clone());

            // Set yank highlight before exiting visual (we need the range)
            if let Some(((sr, sc), (er, ec))) = self.visual_range() {
                let linewise = matches!(kind, VisualKind::Line);
                self.yank_highlight = Some(YankHighlight {
                    start_row: sr,
                    start_col: sc,
                    end_row: er,
                    end_col: ec,
                    linewise,
                    created_at: std::time::Instant::now(),
                });
            }

            self.exit_visual();
        }
    }

    /// Paste over visual selection (replace selection with register content)
    pub fn visual_paste(&mut self) {
        if self.visual_kind().is_some() {
            // Save the register content BEFORE deleting (delete overwrites it)
            let paste_reg = self.resolve_paste_register();
            if paste_reg.content.is_empty() {
                return;
            }

            // Delete the selection (this sets unnamed_register to deleted text)
            self.visual_delete();

            // Now insert the saved register content at cursor position
            if paste_reg.linewise {
                let new_lines: Vec<String> =
                    paste_reg.content.lines().map(String::from).collect();
                let insert_at = self.cursor_row;
                for (i, line) in new_lines.into_iter().enumerate() {
                    self.lines.insert(insert_at + i, line);
                }
                self.cursor_row = insert_at;
                self.cursor_col = 0;
            } else {
                let col = self.cursor_col.min(self.lines[self.cursor_row].len());
                let paste_lines: Vec<&str> = paste_reg.content.split('\n').collect();
                if paste_lines.len() <= 1 {
                    // Single-line paste
                    self.lines[self.cursor_row].insert_str(col, &paste_reg.content);
                    self.cursor_col = col + paste_reg.content.len().saturating_sub(1);
                } else {
                    // Multi-line paste: split current line and interleave
                    let after = self.lines[self.cursor_row][col..].to_string();
                    self.lines[self.cursor_row].truncate(col);
                    self.lines[self.cursor_row].push_str(paste_lines[0]);

                    let row = self.cursor_row;
                    for (i, &pl) in paste_lines.iter().enumerate().skip(1) {
                        if i == paste_lines.len() - 1 {
                            // Last line: append the remainder of the original line
                            let mut last = pl.to_string();
                            last.push_str(&after);
                            self.lines.insert(row + i, last);
                            self.cursor_row = row + i;
                            self.cursor_col = pl.len().saturating_sub(1);
                        } else {
                            self.lines.insert(row + i, pl.to_string());
                        }
                    }
                }
            }
            self.modified = true;
        }
    }

    /// Indent visual selection. Selection is preserved so the user can press
    /// `>` repeatedly to indent multiple levels without losing visual mode.
    pub fn visual_indent(&mut self) {
        if let Some(((sr, _), (er, _))) = self.visual_range() {
            self.save_undo();
            let end = er.min(self.lines.len().saturating_sub(1));
            for row in sr..=end {
                self.indent_line(row);
            }
        }
    }

    /// Dedent visual selection. Selection is preserved so the user can press
    /// `<` repeatedly to dedent multiple levels without losing visual mode.
    pub fn visual_dedent(&mut self) {
        if let Some(((sr, _), (er, _))) = self.visual_range() {
            self.save_undo();
            let end = er.min(self.lines.len().saturating_sub(1));
            for row in sr..=end {
                self.dedent_line(row);
            }
        }
    }

    /// Convert visual selection to uppercase
    pub fn visual_uppercase(&mut self) {
        self.visual_transform_case(|s| s.to_uppercase());
    }

    /// Convert visual selection to lowercase
    pub fn visual_lowercase(&mut self) {
        self.visual_transform_case(|s| s.to_lowercase());
    }

    /// Toggle case of visual selection
    pub fn visual_toggle_case(&mut self) {
        self.visual_transform_case(|s| {
            s.chars()
                .map(|c| {
                    if c.is_uppercase() {
                        c.to_lowercase().to_string()
                    } else {
                        c.to_uppercase().to_string()
                    }
                })
                .collect()
        });
    }

    fn visual_transform_case(&mut self, transform: impl Fn(&str) -> String) {
        if let Some(kind) = self.visual_kind() {
            self.save_undo();
            if let Some(((sr, sc), (er, ec))) = self.visual_range() {
                match kind {
                    VisualKind::Line => {
                        let end = er.min(self.lines.len().saturating_sub(1));
                        for row in sr..=end {
                            self.lines[row] = transform(&self.lines[row]);
                        }
                    }
                    VisualKind::Char => {
                        let ec = (ec + 1).min(
                            self.lines.get(er).map(|l| l.len()).unwrap_or(0),
                        );
                        if sr == er {
                            let line = &self.lines[sr];
                            let s = sc.min(line.len());
                            let e = ec.min(line.len());
                            let changed = transform(&line[s..e]);
                            self.lines[sr] = format!("{}{}{}", &line[..s], changed, &line[e..]);
                        } else {
                            // First line
                            let line = &self.lines[sr];
                            let s = sc.min(line.len());
                            self.lines[sr] = format!("{}{}", &line[..s], transform(&line[s..]));
                            // Middle lines
                            for row in (sr + 1)..er {
                                self.lines[row] = transform(&self.lines[row]);
                            }
                            // Last line
                            let line = &self.lines[er];
                            let e = ec.min(line.len());
                            self.lines[er] = format!("{}{}", transform(&line[..e]), &line[e..]);
                        }
                    }
                    VisualKind::Block => {
                        let left = sc.min(ec);
                        let right = sc.max(ec) + 1;
                        for row in sr..=er.min(self.lines.len().saturating_sub(1)) {
                            let line = &self.lines[row];
                            let l = left.min(line.len());
                            let r = right.min(line.len());
                            if l < r {
                                let changed = transform(&line[l..r]);
                                self.lines[row] = format!("{}{}{}", &line[..l], changed, &line[r..]);
                            }
                        }
                    }
                }
                self.modified = true;
            }
            self.exit_visual();
        }
    }

    /// Block insert (I): insert text at the left column of the block on all rows.
    /// Enters insert mode on the first row; on Esc the edits are replayed on the rest.
    pub fn block_insert_start(&mut self) {
        if let Some(((sr, sc), (er, ec))) = self.visual_range() {
            let left = sc.min(ec);
            self.save_undo();
            self.block_insert = Some(BlockInsertState {
                start_row: sr,
                end_row: er.min(self.lines.len().saturating_sub(1)),
                col: left,
            });
            self.cursor_row = sr;
            self.cursor_col = left;
            self.visual_anchor = None;
            self.mode = VimMode::Insert;
        }
    }

    /// Block append (A): insert text after the right column of the block on all rows.
    pub fn block_append_start(&mut self) {
        if let Some(((sr, sc), (er, ec))) = self.visual_range() {
            let right = sc.max(ec) + 1;
            self.save_undo();
            self.block_insert = Some(BlockInsertState {
                start_row: sr,
                end_row: er.min(self.lines.len().saturating_sub(1)),
                col: right,
            });
            self.cursor_row = sr;
            self.cursor_col = right.min(self.lines[sr].len());
            self.visual_anchor = None;
            self.mode = VimMode::Insert;
        }
    }

    /// Block change (c): delete the block columns, then insert at the left column.
    pub fn block_change_start(&mut self) {
        if let Some(((sr, sc), (er, ec))) = self.visual_range() {
            let left = sc.min(ec);
            let right = sc.max(ec) + 1;
            self.save_undo();
            // Delete block columns from each row
            for row in sr..=er.min(self.lines.len().saturating_sub(1)) {
                let line_len = self.lines[row].len();
                let l = left.min(line_len);
                let r = right.min(line_len);
                if l < r {
                    self.lines[row] = format!("{}{}", &self.lines[row][..l], &self.lines[row][r..]);
                }
            }
            self.modified = true;
            self.block_insert = Some(BlockInsertState {
                start_row: sr,
                end_row: er.min(self.lines.len().saturating_sub(1)),
                col: left,
            });
            self.cursor_row = sr;
            self.cursor_col = left.min(self.lines[sr].len());
            self.visual_anchor = None;
            self.mode = VimMode::Insert;
        }
    }

    /// Block replace (r): replace every character in the block with a single character.
    pub fn block_replace(&mut self, ch: char) {
        if let Some(((sr, sc), (er, ec))) = self.visual_range() {
            let left = sc.min(ec);
            let right = sc.max(ec) + 1;
            self.save_undo();
            for row in sr..=er.min(self.lines.len().saturating_sub(1)) {
                let line_len = self.lines[row].len();
                let l = left.min(line_len);
                let r = right.min(line_len);
                if l < r {
                    let replaced: String = self.lines[row][l..r]
                        .chars()
                        .map(|_| ch)
                        .collect();
                    self.lines[row] = format!(
                        "{}{}{}",
                        &self.lines[row][..l],
                        replaced,
                        &self.lines[row][r..]
                    );
                }
            }
            self.modified = true;
            self.cursor_row = sr;
            self.cursor_col = left;
            self.exit_visual();
        }
    }

    /// Finish a block insert: replay the recorded keystrokes on all remaining rows.
    pub fn finish_block_insert(&mut self, keys: &[crossterm::event::KeyEvent]) {
        if let Some(state) = self.block_insert.take() {
            // The first row (state.start_row) was already edited live.
            // Replay the same keystrokes on every other row.
            for row in (state.start_row + 1)..=state.end_row.min(self.lines.len().saturating_sub(1)) {
                let col = state.col.min(self.lines[row].len());
                let mut insert_col = col;
                for key in keys {
                    match key.code {
                        crossterm::event::KeyCode::Char(c) => {
                            if insert_col <= self.lines[row].len() {
                                self.lines[row].insert(insert_col, c);
                                insert_col += 1;
                            }
                        }
                        crossterm::event::KeyCode::Tab => {
                            for _ in 0..4 {
                                if insert_col <= self.lines[row].len() {
                                    self.lines[row].insert(insert_col, ' ');
                                    insert_col += 1;
                                }
                            }
                        }
                        crossterm::event::KeyCode::Backspace => {
                            if insert_col > 0 && insert_col <= self.lines[row].len() {
                                self.lines[row].remove(insert_col - 1);
                                insert_col -= 1;
                            }
                        }
                        crossterm::event::KeyCode::Delete => {
                            if insert_col < self.lines[row].len() {
                                self.lines[row].remove(insert_col);
                            }
                        }
                        _ => {}
                    }
                }
            }
        }
    }

    /// Exit visual mode
    pub fn exit_visual(&mut self) {
        self.visual_anchor = None;
        self.mode = super::VimMode::Normal;
    }

    fn visual_kind(&self) -> Option<VisualKind> {
        match &self.mode {
            VimMode::Visual(kind) => Some(kind.clone()),
            _ => None,
        }
    }
}