helix-editor#13833

feat: manipulating one of the selections

optional: assign # for togging primary manipulation

optional: allow for styling primary only selection

Author: mgazeel

helix-core/src/selection.rs

@@ -417,6 +417,7 @@ impl From<Range> for helix_stdx::Range {
 pub struct Selection {
     ranges: SmallVec<[Range; 1]>,
     primary_index: usize,
+    edit_only_primary: bool,
 }
 
 #[allow(clippy::len_without_is_empty)] // a Selection is never empty
@@ -440,10 +441,7 @@ impl Selection {
         if self.ranges.len() == 1 {
             self
         } else {
-            Self {
-                ranges: smallvec![self.ranges[self.primary_index]],
-                primary_index: 0,
-            }
+            Self::new(smallvec![self.ranges[self.primary_index]], 0)
         }
     }
 
@@ -536,6 +534,14 @@ impl Selection {
         self.primary_index = idx;
     }
 
+    pub fn edit_only_primary(&self) -> bool {
+        self.edit_only_primary
+    }
+
+    pub fn set_edit_only_primary(&mut self, val: bool) {
+        self.edit_only_primary = val;
+    }
+
     #[must_use]
     /// Constructs a selection holding a single range.
     pub fn single(anchor: usize, head: usize) -> Self {
@@ -546,6 +552,7 @@ impl Selection {
                 old_visual_position: None
             }],
             primary_index: 0,
+            edit_only_primary: false,
         }
     }
 
@@ -627,6 +634,9 @@ impl Selection {
         let selection = Self {
             ranges,
             primary_index,
+
+            // This is not a parameter since everywhere a Selection is constructed, editing only the primary is not desired.
+            edit_only_primary: false,
         };
 
         selection.normalize()
@@ -637,9 +647,14 @@ impl Selection {
     where
         F: FnMut(Range) -> Range,
     {
-        for range in self.ranges.iter_mut() {
-            *range = f(*range)
+        if self.edit_only_primary {
+            self.ranges[self.primary_index] = f(self.ranges[self.primary_index])
+        } else {
+            for range in self.ranges.iter_mut() {
+                *range = f(*range)
+            }
         }
+
         self.normalize()
     }
 
@@ -728,10 +743,7 @@ impl FromIterator<Range> for Selection {
 
 impl From<Range> for Selection {
     fn from(range: Range) -> Self {
-        Self {
-            ranges: smallvec![range],
-            primary_index: 0,
-        }
+        Self::new(smallvec![range], 0)
     }
 }
 

helix-term/src/commands.rs

@@ -525,6 +525,7 @@ impl MappableCommand {
         rotate_selections_backward, "Rotate selections backward",
         rotate_selection_contents_forward, "Rotate selection contents forward",
         rotate_selection_contents_backward, "Rotate selections contents backward",
+        toggle_move_primary_selection_only, "Toggle movement only of primary selection",
         reverse_selection_contents, "Reverse selections contents",
         expand_selection, "Expand selection to parent syntax node",
         shrink_selection, "Shrink selection to previously expanded syntax node",
@@ -5457,6 +5458,14 @@ fn reverse_selection_contents(cx: &mut Context) {
     reorder_selection_contents(cx, ReorderStrategy::Reverse)
 }
 
+fn toggle_move_primary_selection_only(cx: &mut Context) {
+    let (view, doc) = current!(cx.editor);
+    let mut selection = doc.selection(view.id).clone();
+
+    selection.set_edit_only_primary(!selection.edit_only_primary());
+    doc.set_selection(view.id, selection);
+}
+
 // tree sitter node selection
 
 fn expand_selection(cx: &mut Context) {

helix-term/src/keymap/default.rs

@@ -182,6 +182,8 @@ pub fn default() -> HashMap<Mode, KeyTrie> {
         "A-(" => rotate_selection_contents_backward,
         "A-)" => rotate_selection_contents_forward,
 
+        "#" => toggle_move_primary_selection_only,
+
         "A-:" => ensure_selections_forward,
 
         "esc" => normal_mode,

helix-term/src/ui/statusline.rs

@@ -333,14 +333,33 @@ where
 {
     let selection = context.doc.selection(context.view.id);
     let count = selection.len();
-    write(
-        context,
-        if count == 1 {
-            " 1 sel ".into()
-        } else {
-            format!(" {}/{count} sels ", selection.primary_index() + 1).into()
-        },
-    );
+
+    match (count, selection.edit_only_primary()) {
+        (1, _) => write(context, " 1 sel ".into()),
+        (_, true) => {
+            write(context, " ".into());
+
+            write(
+                context,
+                Span::styled(
+                    "primary",
+                    context
+                        .editor
+                        .theme
+                        .get("ui.statusline.selections.primary-only"),
+                ),
+            );
+
+            write(
+                context,
+                format!(" {}/{count} ", selection.primary_index() + 1).into(),
+            )
+        }
+        (_, false) => write(
+            context,
+            format!(" {}/{count} sels ", selection.primary_index() + 1).into(),
+        ),
+    }
 }
 
 fn render_primary_selection_length<'a, F>(context: &mut RenderContext<'a>, write: F)

helix-term/tests/test/helpers.rs

@@ -65,6 +65,8 @@ pub struct TestCase {
     pub out_text: String,
     pub out_selection: Selection,
 
+    // remove when this is used in any test.
+    #[allow(dead_code)]
     pub line_feed_handling: LineFeedHandling,
 }
 

helix-term/tests/test/movement.rs

@@ -670,6 +670,26 @@ async fn test_surround_delete() -> anyhow::Result<()> {
     Ok(())
 }
 
+#[tokio::test(flavor = "multi_thread")]
+async fn test_movement_of_primary_only() -> anyhow::Result<()> {
+    test((
+        indoc! {"\
+                #[|]#Test1 Test2 Test3
+                Test1 Test2 Test3
+                Test1 Test2 Test3
+            "},
+        "wlCCt (#wwcTest4<esc>#b;",
+        indoc! {"\
+                Test1 #(T|)#est4 Test3
+                Test1 Test2 #[T|]#est4
+                Test1 #(T|)#est4 Test3
+            "},
+    ))
+    .await?;
+
+    Ok(())
+}
+
 #[tokio::test(flavor = "multi_thread")]
 async fn tree_sitter_motions_work_across_injections() -> anyhow::Result<()> {
     test_with_config(

theme.toml

@@ -50,6 +50,7 @@ tabstop = { modifiers = ["italic"], bg = "bossanova" }
 "ui.linenr.selected" = { fg = "lilac" }
 "ui.statusline" = { fg = "lilac", bg = "revolver" }
 "ui.statusline.inactive" = { fg = "lavender", bg = "revolver" }
+"ui.statusline.selections.primary-only" = { fg = "apricot" }
 "ui.popup" = { bg = "revolver" }
 "ui.window" = { fg = "bossanova" }
 "ui.help" = { bg = "#7958DC", fg = "#171452" }