Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expand selection to whole word when pressing * #6046

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions book/src/keymap.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,13 +146,13 @@ Normal mode is the default mode when you launch helix. You can return to it from

Search commands all operate on the `/` register by default. To use a different register, use `"<char>`.

| Key | Description | Command |
| ----- | ----------- | ------- |
| `/` | Search for regex pattern | `search` |
| `?` | Search for previous pattern | `rsearch` |
| `n` | Select next search match | `search_next` |
| `N` | Select previous search match | `search_prev` |
| `*` | Use current selection as the search pattern | `search_selection` |
| Key | Description | Command |
| ----- | ----------- | ------- |
| `/` | Search for regex pattern | `search` |
| `?` | Search for previous pattern | `rsearch` |
| `n` | Select next search match | `search_next` |
| `N` | Select previous search match | `search_prev` |
| `*` | Use current selection as the search pattern, if only a single char is selected the current word (miW) is used instead | `search_selection` |

### Minor modes

Expand Down
36 changes: 27 additions & 9 deletions helix-term/src/commands.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2083,19 +2083,37 @@ fn extend_search_prev(cx: &mut Context) {

fn search_selection(cx: &mut Context) {
let register = cx.register.unwrap_or('/');
let count = cx.count();
let (view, doc) = current!(cx.editor);
let contents = doc.text().slice(..);

let regex = doc
.selection(view.id)
.iter()
.map(|selection| regex::escape(&selection.fragment(contents)))
.collect::<HashSet<_>>() // Collect into hashset to deduplicate identical regexes
.into_iter()
.collect::<Vec<_>>()
.join("|");
// Checks whether there is only one selection with a width of 1
let selections = doc.selection(view.id);
let primary = selections.primary();
let regex = if selections.len() == 1 && primary.len() == 1 {
let text = doc.text();
let text_slice = text.slice(..);
// In this case select the WORD under the cursor
let current_word = textobject::textobject_word(
text_slice,
primary,
textobject::TextObject::Inside,
count,
false,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Passing false here makes this look for the surrounding "word" rather than the "WORD". I think that's an ok behavior but the change in book/src/keymap.md should mention miw instead of miW. Also see

'w' => textobject::textobject_word(text, range, objtype, count, false),
'W' => textobject::textobject_word(text, range, objtype, count, true),

);
let text_to_search = current_word.fragment(text_slice).to_string();
regex::escape(&text_to_search)
} else {
selections
.iter()
.map(|selection| regex::escape(&selection.fragment(contents)))
.collect::<HashSet<_>>() // Collect into hashset to deduplicate identical regexes
.into_iter()
.collect::<Vec<_>>()
.join("|")
};

let msg = format!("register '{}' set to '{}'", register, &regex);
let msg = format!("register '{}' set to '{}'", '/', &regex);
match cx.editor.registers.push(register, regex) {
Ok(_) => {
cx.editor.registers.last_search_register = register;
Expand Down
50 changes: 50 additions & 0 deletions helix-term/tests/test/commands.rs
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,56 @@ async fn test_goto_file_impl() -> anyhow::Result<()> {
Ok(())
}

#[tokio::test(flavor = "multi_thread")]
async fn test_search_selection() -> anyhow::Result<()> {
// Single selection with a length of 1: search for the whole word
test_key_sequence(
&mut helpers::AppBuilder::new().build()?,
Some("ifoobar::baz<esc>3bl*"), // 3b places the cursor on the first letter of 'foobar', then move one to the right for good measure
Some(&|app| {
assert!(
r#"register '/' set to 'foobar'"# == app.editor.get_status().unwrap().0
&& Some(&"foobar".to_string()) == app.editor.registers.first('/')
);
}),
false,
)
.await?;

// Single selection with a length greather than 1: only search for the selection
test_key_sequence(
&mut helpers::AppBuilder::new().build()?,
Some("ifoobar::baz<esc>3blvll*"), // 3b places the cursor on the first letter of 'foobar', then move one to the right for good measure, then select two more chars for a total of three
Some(&|app| {
assert!(
r#"register '/' set to 'oob'"# == app.editor.get_status().unwrap().0
&& Some(&"oob".to_string()) == app.editor.registers.first('/')
);
}),
false,
)
.await?;

// Multiple selection of length 1 each : should still only search for the selection
test_key_sequence(
&mut helpers::AppBuilder::new().build()?,
Some("ifoobar::baz<ret>bar::crux<esc>k3blC*"), // k3b places the cursor on the first letter of 'foobar', then move one to the right for good measure, then adds a cursor on the line below
Some(&|app| {
assert!(
// The selections don't seem to be ordered, so we have to test for the two possible orders.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe what's happening here is that collecting into a hashmap might change the order. The selections do have a deterministic order

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The source code could add the itertools crate and then use unique on the iterator instead of collecting twice. unique is stable.

(r#"register '/' set to 'o|a'"# == app.editor.get_status().unwrap().0
|| r#"register '/' set to 'a|o'"# == app.editor.get_status().unwrap().0)
&& (Some(&"o|a".to_string()) == app.editor.registers.first('/')
|| Some(&"a|o".to_string()) == app.editor.registers.first('/'))
);
}),
false,
)
.await?;

Ok(())
}

#[tokio::test(flavor = "multi_thread")]
async fn test_multi_selection_paste() -> anyhow::Result<()> {
test((
Expand Down
Loading