vim increment (#3054)

- vim: add ctrl-a/ctrl-x for increment/decrement

assets/keymaps/vim.json

@@ -415,6 +415,8 @@
       "o": "vim::InsertLineBelow",
       "shift-o": "vim::InsertLineAbove",
       "~": "vim::ChangeCase",
+      "ctrl-a": "vim::Increment",
+      "ctrl-x": "vim::Decrement",
       "p": "vim::Paste",
       "shift-p": [
         "vim::Paste",
@@ -526,6 +528,20 @@
       "shift-r": "vim::SubstituteLine",
       "c": "vim::Substitute",
       "~": "vim::ChangeCase",
+      "ctrl-a": "vim::Increment",
+      "ctrl-x": "vim::Decrement",
+      "g ctrl-a": [
+        "vim::Increment",
+        {
+          "step": true
+        }
+      ],
+      "g ctrl-x": [
+        "vim::Decrement",
+        {
+          "step": true
+        }
+      ],
       "shift-i": "vim::InsertBefore",
       "shift-a": "vim::InsertAfter",
       "shift-j": "vim::JoinLines",

crates/vim/src/normal.rs

@@ -1,6 +1,7 @@
 mod case;
 mod change;
 mod delete;
+mod increment;
 mod paste;
 pub(crate) mod repeat;
 mod scroll;
@@ -56,6 +57,7 @@ pub fn init(cx: &mut AppContext) {
     scroll::init(cx);
     search::init(cx);
     substitute::init(cx);
+    increment::init(cx);
 
     cx.add_action(insert_after);
     cx.add_action(insert_before);

crates/vim/src/normal/increment.rs

@@ -0,0 +1,262 @@
+use std::ops::Range;
+
+use editor::{scroll::autoscroll::Autoscroll, MultiBufferSnapshot, ToOffset, ToPoint};
+use gpui::{impl_actions, AppContext, WindowContext};
+use language::{Bias, Point};
+use serde::Deserialize;
+use workspace::Workspace;
+
+use crate::{state::Mode, Vim};
+
+#[derive(Clone, Deserialize, PartialEq)]
+#[serde(rename_all = "camelCase")]
+struct Increment {
+    #[serde(default)]
+    step: bool,
+}
+
+#[derive(Clone, Deserialize, PartialEq)]
+#[serde(rename_all = "camelCase")]
+struct Decrement {
+    #[serde(default)]
+    step: bool,
+}
+
+impl_actions!(vim, [Increment, Decrement]);
+
+pub fn init(cx: &mut AppContext) {
+    cx.add_action(|_: &mut Workspace, action: &Increment, cx| {
+        Vim::update(cx, |vim, cx| {
+            vim.record_current_action(cx);
+            let count = vim.take_count(cx).unwrap_or(1);
+            let step = if action.step { 1 } else { 0 };
+            increment(vim, count as i32, step, cx)
+        })
+    });
+    cx.add_action(|_: &mut Workspace, action: &Decrement, cx| {
+        Vim::update(cx, |vim, cx| {
+            vim.record_current_action(cx);
+            let count = vim.take_count(cx).unwrap_or(1);
+            let step = if action.step { -1 } else { 0 };
+            increment(vim, count as i32 * -1, step, cx)
+        })
+    });
+}
+
+fn increment(vim: &mut Vim, mut delta: i32, step: i32, cx: &mut WindowContext) {
+    vim.update_active_editor(cx, |editor, cx| {
+        let mut edits = Vec::new();
+        let mut new_anchors = Vec::new();
+
+        let snapshot = editor.buffer().read(cx).snapshot(cx);
+        for selection in editor.selections.all_adjusted(cx) {
+            if !selection.is_empty() {
+                if vim.state().mode != Mode::VisualBlock || new_anchors.is_empty() {
+                    new_anchors.push((true, snapshot.anchor_before(selection.start)))
+                }
+            }
+            for row in selection.start.row..=selection.end.row {
+                let start = if row == selection.start.row {
+                    selection.start
+                } else {
+                    Point::new(row, 0)
+                };
+
+                if let Some((range, num, radix)) = find_number(&snapshot, start) {
+                    if let Ok(val) = i32::from_str_radix(&num, radix) {
+                        let result = val + delta;
+                        delta += step;
+                        let replace = match radix {
+                            10 => format!("{}", result),
+                            16 => {
+                                if num.to_ascii_lowercase() == num {
+                                    format!("{:x}", result)
+                                } else {
+                                    format!("{:X}", result)
+                                }
+                            }
+                            2 => format!("{:b}", result),
+                            _ => unreachable!(),
+                        };
+                        if selection.is_empty() {
+                            new_anchors.push((false, snapshot.anchor_after(range.end)))
+                        }
+                        edits.push((range, replace));
+                    }
+                }
+            }
+        }
+        editor.transact(cx, |editor, cx| {
+            editor.edit(edits, cx);
+
+            let snapshot = editor.buffer().read(cx).snapshot(cx);
+            editor.change_selections(Some(Autoscroll::fit()), cx, |s| {
+                let mut new_ranges = Vec::new();
+                for (visual, anchor) in new_anchors.iter() {
+                    let mut point = anchor.to_point(&snapshot);
+                    if !*visual && point.column > 0 {
+                        point.column -= 1;
+                        point = snapshot.clip_point(point, Bias::Left)
+                    }
+                    new_ranges.push(point..point);
+                }
+                s.select_ranges(new_ranges)
+            })
+        });
+    });
+    vim.switch_mode(Mode::Normal, true, cx)
+}
+
+fn find_number(
+    snapshot: &MultiBufferSnapshot,
+    start: Point,
+) -> Option<(Range<Point>, String, u32)> {
+    let mut offset = start.to_offset(snapshot);
+
+    // go backwards to the start of any number the selection is within
+    for ch in snapshot.reversed_chars_at(offset) {
+        if ch.is_ascii_digit() || ch == '-' || ch == 'b' || ch == 'x' {
+            offset -= ch.len_utf8();
+            continue;
+        }
+        break;
+    }
+
+    let mut begin = None;
+    let mut end = None;
+    let mut num = String::new();
+    let mut radix = 10;
+
+    let mut chars = snapshot.chars_at(offset).peekable();
+    // find the next number on the line (may start after the original cursor position)
+    while let Some(ch) = chars.next() {
+        if num == "0" && ch == 'b' && chars.peek().is_some() && chars.peek().unwrap().is_digit(2) {
+            radix = 2;
+            begin = None;
+            num = String::new();
+        }
+        if num == "0" && ch == 'x' && chars.peek().is_some() && chars.peek().unwrap().is_digit(16) {
+            radix = 16;
+            begin = None;
+            num = String::new();
+        }
+
+        if ch.is_digit(radix)
+            || (begin.is_none()
+                && ch == '-'
+                && chars.peek().is_some()
+                && chars.peek().unwrap().is_digit(radix))
+        {
+            if begin.is_none() {
+                begin = Some(offset);
+            }
+            num.push(ch);
+        } else {
+            if begin.is_some() {
+                end = Some(offset);
+                break;
+            } else if ch == '\n' {
+                break;
+            }
+        }
+        offset += ch.len_utf8();
+    }
+    if let Some(begin) = begin {
+        let end = end.unwrap_or(offset);
+        Some((begin.to_point(snapshot)..end.to_point(snapshot), num, radix))
+    } else {
+        None
+    }
+}
+
+#[cfg(test)]
+mod test {
+    use indoc::indoc;
+
+    use crate::test::NeovimBackedTestContext;
+
+    #[gpui::test]
+    async fn test_increment(cx: &mut gpui::TestAppContext) {
+        let mut cx = NeovimBackedTestContext::new(cx).await;
+
+        cx.set_shared_state(indoc! {"
+            1ˇ2
+            "})
+            .await;
+
+        cx.simulate_shared_keystrokes(["ctrl-a"]).await;
+        cx.assert_shared_state(indoc! {"
+            1ˇ3
+            "})
+            .await;
+        cx.simulate_shared_keystrokes(["ctrl-x"]).await;
+        cx.assert_shared_state(indoc! {"
+            1ˇ2
+            "})
+            .await;
+
+        cx.simulate_shared_keystrokes(["9", "9", "ctrl-a"]).await;
+        cx.assert_shared_state(indoc! {"
+            11ˇ1
+            "})
+            .await;
+        cx.simulate_shared_keystrokes(["1", "1", "1", "ctrl-x"])
+            .await;
+        cx.assert_shared_state(indoc! {"
+            ˇ0
+            "})
+            .await;
+        cx.simulate_shared_keystrokes(["."]).await;
+        cx.assert_shared_state(indoc! {"
+            -11ˇ1
+            "})
+            .await;
+    }
+
+    #[gpui::test]
+    async fn test_increment_radix(cx: &mut gpui::TestAppContext) {
+        let mut cx = NeovimBackedTestContext::new(cx).await;
+
+        cx.assert_matches_neovim("ˇ total: 0xff", ["ctrl-a"], " total: 0x10ˇ0")
+            .await;
+        cx.assert_matches_neovim("ˇ total: 0xff", ["ctrl-x"], " total: 0xfˇe")
+            .await;
+        cx.assert_matches_neovim("ˇ total: 0xFF", ["ctrl-x"], " total: 0xFˇE")
+            .await;
+        cx.assert_matches_neovim("(ˇ0b10f)", ["ctrl-a"], "(0b1ˇ1f)")
+            .await;
+        cx.assert_matches_neovim("ˇ-1", ["ctrl-a"], "ˇ0").await;
+    }
+
+    #[gpui::test]
+    async fn test_increment_steps(cx: &mut gpui::TestAppContext) {
+        let mut cx = NeovimBackedTestContext::new(cx).await;
+
+        cx.set_shared_state(indoc! {"
+            ˇ1
+            1
+            1  2
+            1
+            1"})
+            .await;
+
+        cx.simulate_shared_keystrokes(["j", "v", "shift-g", "g", "ctrl-a"])
+            .await;
+        cx.assert_shared_state(indoc! {"
+            1
+            ˇ2
+            3  2
+            4
+            5"})
+            .await;
+        cx.simulate_shared_keystrokes(["shift-g", "ctrl-v", "g", "g", "g", "ctrl-x"])
+            .await;
+        cx.assert_shared_state(indoc! {"
+            ˇ0
+            0
+            0  2
+            0
+            0"})
+            .await;
+    }
+}

crates/vim/src/test/neovim_backed_test_context.rs

@@ -363,6 +363,17 @@ impl<'a> NeovimBackedTestContext<'a> {
         self.assert_state_matches().await;
     }
 
+    pub async fn assert_matches_neovim<const COUNT: usize>(
+        &mut self,
+        marked_positions: &str,
+        keystrokes: [&str; COUNT],
+        result: &str,
+    ) {
+        self.set_shared_state(marked_positions).await;
+        self.simulate_shared_keystrokes(keystrokes).await;
+        self.assert_shared_state(result).await;
+    }
+
     pub async fn assert_binding_matches_all_exempted<const COUNT: usize>(
         &mut self,
         keystrokes: [&str; COUNT],

crates/vim/test_data/test_increment.json

@@ -0,0 +1,16 @@
+{"Put":{"state":"1ˇ2\n"}}
+{"Key":"ctrl-a"}
+{"Get":{"state":"1ˇ3\n","mode":"Normal"}}
+{"Key":"ctrl-x"}
+{"Get":{"state":"1ˇ2\n","mode":"Normal"}}
+{"Key":"9"}
+{"Key":"9"}
+{"Key":"ctrl-a"}
+{"Get":{"state":"11ˇ1\n","mode":"Normal"}}
+{"Key":"1"}
+{"Key":"1"}
+{"Key":"1"}
+{"Key":"ctrl-x"}
+{"Get":{"state":"ˇ0\n","mode":"Normal"}}
+{"Key":"."}
+{"Get":{"state":"-11ˇ1\n","mode":"Normal"}}

crates/vim/test_data/test_increment_radix.json

@@ -0,0 +1,15 @@
+{"Put":{"state":"ˇ total: 0xff"}}
+{"Key":"ctrl-a"}
+{"Get":{"state":" total: 0x10ˇ0","mode":"Normal"}}
+{"Put":{"state":"ˇ total: 0xff"}}
+{"Key":"ctrl-x"}
+{"Get":{"state":" total: 0xfˇe","mode":"Normal"}}
+{"Put":{"state":"ˇ total: 0xFF"}}
+{"Key":"ctrl-x"}
+{"Get":{"state":" total: 0xFˇE","mode":"Normal"}}
+{"Put":{"state":"(ˇ0b10f)"}}
+{"Key":"ctrl-a"}
+{"Get":{"state":"(0b1ˇ1f)","mode":"Normal"}}
+{"Put":{"state":"ˇ-1"}}
+{"Key":"ctrl-a"}
+{"Get":{"state":"ˇ0","mode":"Normal"}}

crates/vim/test_data/test_increment_steps.json

@@ -0,0 +1,14 @@
+{"Put":{"state":"ˇ1\n1\n1  2\n1\n1"}}
+{"Key":"j"}
+{"Key":"v"}
+{"Key":"shift-g"}
+{"Key":"g"}
+{"Key":"ctrl-a"}
+{"Get":{"state":"1\nˇ2\n3  2\n4\n5","mode":"Normal"}}
+{"Key":"shift-g"}
+{"Key":"ctrl-v"}
+{"Key":"g"}
+{"Key":"g"}
+{"Key":"g"}
+{"Key":"ctrl-x"}
+{"Get":{"state":"ˇ0\n0\n0  2\n0\n0","mode":"Normal"}}