revue 2.71.1

A Vue-style TUI framework for Rust with CSS styling
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
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
//! Vim Mode system for terminal applications
//!
//! Provides vim-style modal editing with Normal, Insert, Visual,
//! and Command modes.

use crate::event::{Key, KeyEvent};
use crate::style::Color;
use std::collections::HashMap;

/// Vim mode
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
pub enum VimMode {
    /// Normal mode (navigation, commands)
    #[default]
    Normal,
    /// Insert mode (text input)
    Insert,
    /// Visual mode (selection)
    Visual,
    /// Visual Line mode
    VisualLine,
    /// Visual Block mode
    VisualBlock,
    /// Command mode (:commands)
    Command,
    /// Search mode (/search)
    Search,
    /// Replace mode (r, R)
    Replace,
}

impl VimMode {
    /// Get mode name for display
    pub fn name(&self) -> &'static str {
        match self {
            VimMode::Normal => "NORMAL",
            VimMode::Insert => "INSERT",
            VimMode::Visual => "VISUAL",
            VimMode::VisualLine => "V-LINE",
            VimMode::VisualBlock => "V-BLOCK",
            VimMode::Command => "COMMAND",
            VimMode::Search => "SEARCH",
            VimMode::Replace => "REPLACE",
        }
    }

    /// Get mode color
    pub fn color(&self) -> Color {
        match self {
            VimMode::Normal => Color::rgb(100, 150, 255),
            VimMode::Insert => Color::rgb(100, 255, 100),
            VimMode::Visual | VimMode::VisualLine | VimMode::VisualBlock => {
                Color::rgb(255, 150, 100)
            }
            VimMode::Command => Color::rgb(255, 255, 100),
            VimMode::Search => Color::rgb(255, 100, 255),
            VimMode::Replace => Color::rgb(255, 100, 100),
        }
    }
}

/// Vim motion
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum VimMotion {
    /// Character left (h)
    Left,
    /// Character right (l)
    Right,
    /// Line up (k)
    Up,
    /// Line down (j)
    Down,
    /// Word forward (w)
    Word,
    /// Word backward (b)
    WordBack,
    /// End of word (e)
    WordEnd,
    /// Start of line (0)
    LineStart,
    /// End of line ($)
    LineEnd,
    /// First non-blank (^)
    FirstNonBlank,
    /// Go to line (G, gg)
    GoToLine(Option<usize>),
    /// Find character (f)
    FindChar(char),
    /// Find character backward (F)
    FindCharBack(char),
    /// Till character (t)
    TillChar(char),
    /// Till character backward (T)
    TillCharBack(char),
    /// Paragraph forward (})
    ParagraphForward,
    /// Paragraph backward ({)
    ParagraphBack,
    /// Match bracket (%)
    MatchBracket,
    /// Search forward (n)
    SearchNext,
    /// Search backward (N)
    SearchPrev,
}

/// Vim action
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum VimAction {
    /// Move cursor
    Move(VimMotion),
    /// Delete with motion
    Delete(Option<VimMotion>),
    /// Yank (copy) with motion
    Yank(Option<VimMotion>),
    /// Change with motion
    Change(Option<VimMotion>),
    /// Paste after
    PasteAfter,
    /// Paste before
    PasteBefore,
    /// Undo
    Undo,
    /// Redo
    Redo,
    /// Enter insert mode
    Insert,
    /// Insert at start of line
    InsertStart,
    /// Append after cursor
    Append,
    /// Append at end of line
    AppendEnd,
    /// Open line below
    OpenBelow,
    /// Open line above
    OpenAbove,
    /// Replace character
    ReplaceChar(char),
    /// Enter visual mode
    EnterVisual,
    /// Enter visual line mode
    EnterVisualLine,
    /// Enter visual block mode
    EnterVisualBlock,
    /// Enter command mode
    EnterCommand,
    /// Enter search mode
    EnterSearch,
    /// Escape to normal mode
    Escape,
    /// Repeat last action (.)
    Repeat,
    /// Join lines (J)
    JoinLines,
    /// Indent
    Indent,
    /// Outdent
    Outdent,
    /// Execute command
    ExecuteCommand(String),
    /// Nothing
    None,
}

/// Vim state manager
///
/// # Example
///
/// ```rust,ignore
/// use revue::prelude::*;
///
/// let mut vim = VimState::new();
///
/// // Process key event
/// let action = vim.handle_key(&KeyEvent::new(Key::Char('j')));
/// match action {
///     VimAction::Move(VimMotion::Down) => { /* move cursor down */ }
///     _ => {}
/// }
/// ```
pub struct VimState {
    /// Current mode
    mode: VimMode,
    /// Pending count (for repeat)
    count: Option<usize>,
    /// Pending operator
    operator: Option<char>,
    /// Command buffer (for :commands)
    command_buffer: String,
    /// Search pattern
    search_pattern: String,
    /// Search direction (true = forward)
    search_forward: bool,
    /// Last action for repeat
    last_action: Option<VimAction>,
    /// Register (for yank/paste)
    register: String,
    /// Register name (for future named register support)
    _register_name: char,
    /// Key sequence buffer
    key_buffer: Vec<char>,
    /// Custom key mappings
    mappings: HashMap<String, VimAction>,
}

impl VimState {
    /// Create a new vim state
    pub fn new() -> Self {
        Self {
            mode: VimMode::Normal,
            count: None,
            operator: None,
            command_buffer: String::new(),
            search_pattern: String::new(),
            search_forward: true,
            last_action: None,
            register: String::new(),
            _register_name: '"',
            key_buffer: Vec::new(),
            mappings: HashMap::new(),
        }
    }

    /// Get current mode
    pub fn mode(&self) -> VimMode {
        self.mode
    }

    /// Set mode
    pub fn set_mode(&mut self, mode: VimMode) {
        self.mode = mode;
        if mode == VimMode::Normal {
            self.operator = None;
            self.count = None;
        }
    }

    /// Get count (default 1)
    pub fn count(&self) -> usize {
        self.count.unwrap_or(1)
    }

    /// Get command buffer
    pub fn command_buffer(&self) -> &str {
        &self.command_buffer
    }

    /// Get search pattern
    pub fn search_pattern(&self) -> &str {
        &self.search_pattern
    }

    /// Get register content
    pub fn register(&self) -> &str {
        &self.register
    }

    /// Set register content
    pub fn set_register(&mut self, content: impl Into<String>) {
        self.register = content.into();
    }

    /// Add a custom key mapping
    pub fn map(&mut self, keys: &str, action: VimAction) {
        self.mappings.insert(keys.to_string(), action);
    }

    /// Handle key event in normal mode
    fn handle_normal(&mut self, key: &KeyEvent) -> VimAction {
        // Handle digits for count
        if let Key::Char(ch) = key.key {
            if let Some(digit) = ch.to_digit(10) {
                let digit = digit as usize;
                self.count = Some(self.count.unwrap_or(0) * 10 + digit);
                return VimAction::None;
            }
        }

        // Handle operator pending
        if let Some(op) = self.operator {
            if let Key::Char(ch) = key.key {
                let motion = self.char_to_motion(ch);
                if motion.is_some() {
                    self.operator = None;
                    return match op {
                        'd' => VimAction::Delete(motion),
                        'y' => VimAction::Yank(motion),
                        'c' => VimAction::Change(motion),
                        _ => VimAction::None,
                    };
                }
            }
        }

        match key.key {
            // Mode changes
            Key::Char('i') => {
                self.set_mode(VimMode::Insert);
                VimAction::Insert
            }
            Key::Char('I') => {
                self.set_mode(VimMode::Insert);
                VimAction::InsertStart
            }
            Key::Char('a') => {
                self.set_mode(VimMode::Insert);
                VimAction::Append
            }
            Key::Char('A') => {
                self.set_mode(VimMode::Insert);
                VimAction::AppendEnd
            }
            Key::Char('o') => {
                self.set_mode(VimMode::Insert);
                VimAction::OpenBelow
            }
            Key::Char('O') => {
                self.set_mode(VimMode::Insert);
                VimAction::OpenAbove
            }
            Key::Char('v') => {
                self.set_mode(VimMode::Visual);
                VimAction::EnterVisual
            }
            Key::Char('V') => {
                self.set_mode(VimMode::VisualLine);
                VimAction::EnterVisualLine
            }
            Key::Char(':') => {
                self.set_mode(VimMode::Command);
                self.command_buffer.clear();
                VimAction::EnterCommand
            }
            Key::Char('/') => {
                self.set_mode(VimMode::Search);
                self.search_pattern.clear();
                self.search_forward = true;
                VimAction::EnterSearch
            }
            Key::Char('?') => {
                self.set_mode(VimMode::Search);
                self.search_pattern.clear();
                self.search_forward = false;
                VimAction::EnterSearch
            }

            // Motions
            Key::Char('h') | Key::Left => VimAction::Move(VimMotion::Left),
            Key::Char('j') | Key::Down => VimAction::Move(VimMotion::Down),
            Key::Char('k') | Key::Up => VimAction::Move(VimMotion::Up),
            Key::Char('l') | Key::Right => VimAction::Move(VimMotion::Right),
            Key::Char('w') => VimAction::Move(VimMotion::Word),
            Key::Char('b') => VimAction::Move(VimMotion::WordBack),
            Key::Char('e') => VimAction::Move(VimMotion::WordEnd),
            Key::Char('0') => VimAction::Move(VimMotion::LineStart),
            Key::Char('$') => VimAction::Move(VimMotion::LineEnd),
            Key::Char('^') => VimAction::Move(VimMotion::FirstNonBlank),
            Key::Char('G') => VimAction::Move(VimMotion::GoToLine(self.count)),
            Key::Char('g') => {
                self.key_buffer.push('g');
                VimAction::None
            }
            Key::Char('{') => VimAction::Move(VimMotion::ParagraphBack),
            Key::Char('}') => VimAction::Move(VimMotion::ParagraphForward),
            Key::Char('%') => VimAction::Move(VimMotion::MatchBracket),
            Key::Char('n') => VimAction::Move(VimMotion::SearchNext),
            Key::Char('N') => VimAction::Move(VimMotion::SearchPrev),

            // Operators
            Key::Char('d') => {
                self.operator = Some('d');
                VimAction::None
            }
            Key::Char('y') => {
                self.operator = Some('y');
                VimAction::None
            }
            Key::Char('c') => {
                self.operator = Some('c');
                VimAction::None
            }

            // Actions
            Key::Char('x') => VimAction::Delete(Some(VimMotion::Right)),
            Key::Char('X') => VimAction::Delete(Some(VimMotion::Left)),
            Key::Char('p') => VimAction::PasteAfter,
            Key::Char('P') => VimAction::PasteBefore,
            Key::Char('u') => VimAction::Undo,
            Key::Char('r') if key.ctrl => VimAction::Redo,
            Key::Char('.') => VimAction::Repeat,
            Key::Char('J') => VimAction::JoinLines,
            Key::Char('>') => VimAction::Indent,
            Key::Char('<') => VimAction::Outdent,

            Key::Escape => {
                self.count = None;
                self.operator = None;
                VimAction::Escape
            }

            _ => VimAction::None,
        }
    }

    /// Handle key event in insert mode
    fn handle_insert(&mut self, key: &KeyEvent) -> VimAction {
        match key.key {
            Key::Escape => {
                self.set_mode(VimMode::Normal);
                VimAction::Escape
            }
            _ => VimAction::None, // Let the widget handle insert keys
        }
    }

    /// Handle key event in visual mode
    fn handle_visual(&mut self, key: &KeyEvent) -> VimAction {
        match key.key {
            Key::Escape => {
                self.set_mode(VimMode::Normal);
                VimAction::Escape
            }
            Key::Char('d') | Key::Char('x') => {
                self.set_mode(VimMode::Normal);
                VimAction::Delete(None)
            }
            Key::Char('y') => {
                self.set_mode(VimMode::Normal);
                VimAction::Yank(None)
            }
            Key::Char('c') => {
                self.set_mode(VimMode::Insert);
                VimAction::Change(None)
            }
            // Movement in visual mode
            Key::Char('h') | Key::Left => VimAction::Move(VimMotion::Left),
            Key::Char('j') | Key::Down => VimAction::Move(VimMotion::Down),
            Key::Char('k') | Key::Up => VimAction::Move(VimMotion::Up),
            Key::Char('l') | Key::Right => VimAction::Move(VimMotion::Right),
            Key::Char('w') => VimAction::Move(VimMotion::Word),
            Key::Char('b') => VimAction::Move(VimMotion::WordBack),
            _ => VimAction::None,
        }
    }

    /// Handle key event in command mode
    fn handle_command(&mut self, key: &KeyEvent) -> VimAction {
        match key.key {
            Key::Escape => {
                self.set_mode(VimMode::Normal);
                self.command_buffer.clear();
                VimAction::Escape
            }
            Key::Enter => {
                let cmd = self.command_buffer.clone();
                self.set_mode(VimMode::Normal);
                self.command_buffer.clear();
                VimAction::ExecuteCommand(cmd)
            }
            Key::Backspace => {
                self.command_buffer.pop();
                if self.command_buffer.is_empty() {
                    self.set_mode(VimMode::Normal);
                }
                VimAction::None
            }
            Key::Char(ch) => {
                self.command_buffer.push(ch);
                VimAction::None
            }
            _ => VimAction::None,
        }
    }

    /// Handle key event in search mode
    fn handle_search(&mut self, key: &KeyEvent) -> VimAction {
        match key.key {
            Key::Escape => {
                self.set_mode(VimMode::Normal);
                self.search_pattern.clear();
                VimAction::Escape
            }
            Key::Enter => {
                self.set_mode(VimMode::Normal);
                VimAction::Move(if self.search_forward {
                    VimMotion::SearchNext
                } else {
                    VimMotion::SearchPrev
                })
            }
            Key::Backspace => {
                self.search_pattern.pop();
                if self.search_pattern.is_empty() {
                    self.set_mode(VimMode::Normal);
                }
                VimAction::None
            }
            Key::Char(ch) => {
                self.search_pattern.push(ch);
                VimAction::None
            }
            _ => VimAction::None,
        }
    }

    /// Convert character to motion
    fn char_to_motion(&self, ch: char) -> Option<VimMotion> {
        match ch {
            'h' => Some(VimMotion::Left),
            'j' => Some(VimMotion::Down),
            'k' => Some(VimMotion::Up),
            'l' => Some(VimMotion::Right),
            'w' => Some(VimMotion::Word),
            'b' => Some(VimMotion::WordBack),
            'e' => Some(VimMotion::WordEnd),
            '0' => Some(VimMotion::LineStart),
            '$' => Some(VimMotion::LineEnd),
            '^' => Some(VimMotion::FirstNonBlank),
            'G' => Some(VimMotion::GoToLine(None)),
            '{' => Some(VimMotion::ParagraphBack),
            '}' => Some(VimMotion::ParagraphForward),
            '%' => Some(VimMotion::MatchBracket),
            // Same key repeats = line
            'd' | 'y' | 'c' => Some(VimMotion::Down),
            _ => None,
        }
    }

    /// Handle a key event
    pub fn handle_key(&mut self, key: &KeyEvent) -> VimAction {
        // Check for 'gg' sequence
        if !self.key_buffer.is_empty() {
            if let Key::Char(ch) = key.key {
                if self.key_buffer == ['g'] && ch == 'g' {
                    self.key_buffer.clear();
                    return VimAction::Move(VimMotion::GoToLine(Some(1)));
                }
            }
            self.key_buffer.clear();
        }

        let action = match self.mode {
            VimMode::Normal => self.handle_normal(key),
            VimMode::Insert => self.handle_insert(key),
            VimMode::Visual | VimMode::VisualLine | VimMode::VisualBlock => self.handle_visual(key),
            VimMode::Command => self.handle_command(key),
            VimMode::Search => self.handle_search(key),
            VimMode::Replace => {
                if let Key::Char(ch) = key.key {
                    self.set_mode(VimMode::Normal);
                    VimAction::ReplaceChar(ch)
                } else if key.key == Key::Escape {
                    self.set_mode(VimMode::Normal);
                    VimAction::Escape
                } else {
                    VimAction::None
                }
            }
        };

        // Save for repeat
        if action != VimAction::None
            && action != VimAction::Escape
            && matches!(
                action,
                VimAction::Delete(_)
                    | VimAction::Yank(_)
                    | VimAction::Change(_)
                    | VimAction::Insert
                    | VimAction::Append
                    | VimAction::OpenBelow
                    | VimAction::OpenAbove
            )
        {
            self.last_action = Some(action.clone());
        }

        // Reset count after action
        if action != VimAction::None {
            self.count = None;
        }

        action
    }

    /// Parse and execute a command
    pub fn execute_command(&mut self, cmd: &str) -> VimCommandResult {
        let cmd = cmd.trim();

        match cmd {
            "w" | "write" => VimCommandResult::Write,
            "q" | "quit" => VimCommandResult::Quit,
            "wq" | "x" => VimCommandResult::WriteQuit,
            "q!" => VimCommandResult::ForceQuit,
            "e" | "edit" => VimCommandResult::Edit(None),
            _ if cmd.starts_with("e ") || cmd.starts_with("edit ") => {
                let file = cmd.split_whitespace().nth(1).map(|s| s.to_string());
                VimCommandResult::Edit(file)
            }
            _ if cmd.starts_with("set ") => {
                let option = cmd[4..].trim();
                VimCommandResult::Set(option.to_string())
            }
            _ if cmd.chars().all(|c| c.is_ascii_digit()) => {
                let line: usize = cmd.parse().unwrap_or(1);
                VimCommandResult::GoToLine(line)
            }
            _ => VimCommandResult::Unknown(cmd.to_string()),
        }
    }
}

impl Default for VimState {
    fn default() -> Self {
        Self::new()
    }
}

/// Result of executing a vim command
#[derive(Clone, Debug, PartialEq, Eq)]
pub enum VimCommandResult {
    /// Write file
    Write,
    /// Quit
    Quit,
    /// Write and quit
    WriteQuit,
    /// Force quit without saving
    ForceQuit,
    /// Edit file
    Edit(Option<String>),
    /// Set option
    Set(String),
    /// Go to line number
    GoToLine(usize),
    /// Unknown command
    Unknown(String),
}

/// Create a new vim state
pub fn vim_state() -> VimState {
    VimState::new()
}

// KEEP HERE - Private field access tests (tests note operator field is private)

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

    // =========================================================================
    // Private field access tests
    // =========================================================================

    #[test]
    fn test_set_mode_from_insert_clears_operator() {
        let mut vim = VimState::new();
        vim.set_mode(VimMode::Insert);
        vim.handle_key(&KeyEvent::new(Key::Char('d')));
        // Can't test operator directly as it's private
    }
}