Mirrors
/
helix
mirror of https://github.com/helix-editor/helix
1
1
Fork 1
Code Issues Packages Projects Releases Wiki Activity

Show surround delete and replace errors in editor (#1709)

Browse Source 
* Refactor surround commands to use early returns

* Show surround delete and replace errors in editor
pull/1722/head
Gokul Soumya 3 years ago committed by GitHub
parent f9ad1cafdc
commit c15996aff5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 141 additions and 92 deletions
Show Stats Download Patch File Download Diff File

111
helix-core/src/surround.rs
Unescape Escape View File

@ -1,3 +1,5 @@
use std::fmt::Display;
use crate::{search, Range, Selection}; use crate::{search, Range, Selection};
use ropey::RopeSlice; use ropey::RopeSlice;
@ -11,6 +13,27 @@ pub const PAIRS: &[(char, char)] = &[
('（', '）'), ('（', '）'),
]; ];
#[derive(Debug, PartialEq)]
pub enum Error {
PairNotFound,
CursorOverlap,
RangeExceedsText,
CursorOnAmbiguousPair,
}
impl Display for Error {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.write_str(match *self {
Error::PairNotFound => "Surround pair not found around all cursors",
Error::CursorOverlap => "Cursors overlap for a single surround pair range",
Error::RangeExceedsText => "Cursor range exceeds text length",
Error::CursorOnAmbiguousPair => "Cursor on ambiguous surround pair",
})
}
}
type Result<T> = std::result::Result<T, Error>;
/// Given any char in [PAIRS], return the open and closing chars. If not found in /// Given any char in [PAIRS], return the open and closing chars. If not found in
/// [PAIRS] return (ch, ch). /// [PAIRS] return (ch, ch).
/// ///
@ -37,31 +60,36 @@ pub fn find_nth_pairs_pos(
ch: char, ch: char,
range: Range, range: Range,
n: usize, n: usize,
) -> Option<(usize, usize)> { ) -> Result<(usize, usize)> {
if text.len_chars() < 2 || range.to() >= text.len_chars() { if text.len_chars() < 2 {
return None; return Err(Error::PairNotFound);
}
if range.to() >= text.len_chars() {
return Err(Error::RangeExceedsText);
} }
let (open, close) = get_pair(ch); let (open, close) = get_pair(ch);
let pos = range.cursor(text); let pos = range.cursor(text);
if open == close { let (open, close) = if open == close {
if Some(open) == text.get_char(pos) { if Some(open) == text.get_char(pos) {
// Cursor is directly on match char. We return no match // Cursor is directly on match char. We return no match
// because there's no way to know which side of the char // because there's no way to know which side of the char
// we should be searching on. // we should be searching on.
return None; return Err(Error::CursorOnAmbiguousPair);
} }
Some(( (
search::find_nth_prev(text, open, pos, n)?, search::find_nth_prev(text, open, pos, n),
search::find_nth_next(text, close, pos, n)?, search::find_nth_next(text, close, pos, n),
)) )
} else { } else {
Some(( (
find_nth_open_pair(text, open, close, pos, n)?, find_nth_open_pair(text, open, close, pos, n),
find_nth_close_pair(text, open, close, pos, n)?, find_nth_close_pair(text, open, close, pos, n),
)) )
} };
Option::zip(open, close).ok_or(Error::PairNotFound)
} }
fn find_nth_open_pair( fn find_nth_open_pair(
@ -151,17 +179,17 @@ pub fn get_surround_pos(
selection: &Selection, selection: &Selection,
ch: char, ch: char,
skip: usize, skip: usize,
) -> Option<Vec<usize>> { ) -> Result<Vec<usize>> {
let mut change_pos = Vec::new(); let mut change_pos = Vec::new();
for &range in selection { for &range in selection {
let (open_pos, close_pos) = find_nth_pairs_pos(text, ch, range, skip)?; let (open_pos, close_pos) = find_nth_pairs_pos(text, ch, range, skip)?;
if change_pos.contains(&open_pos) || change_pos.contains(&close_pos) { if change_pos.contains(&open_pos) || change_pos.contains(&close_pos) {
return None; return Err(Error::CursorOverlap);
} }
change_pos.extend_from_slice(&[open_pos, close_pos]); change_pos.extend_from_slice(&[open_pos, close_pos]);
} }
Some(change_pos) Ok(change_pos)
} }
#[cfg(test)] #[cfg(test)]
@ -175,7 +203,7 @@ mod test {
#[allow(clippy::type_complexity)] #[allow(clippy::type_complexity)]
fn check_find_nth_pair_pos( fn check_find_nth_pair_pos(
text: &str, text: &str,
cases: Vec<(usize, char, usize, Option<(usize, usize)>)>, cases: Vec<(usize, char, usize, Result<(usize, usize)>)>,
) { ) {
let doc = Rope::from(text); let doc = Rope::from(text);
let slice = doc.slice(..); let slice = doc.slice(..);
@ -196,13 +224,13 @@ mod test {
"some (text) here", "some (text) here",
vec![ vec![
// cursor on [t]ext // cursor on [t]ext
(6, '(', 1, Some((5, 10))), (6, '(', 1, Ok((5, 10))),
(6, ')', 1, Some((5, 10))), (6, ')', 1, Ok((5, 10))),
// cursor on so[m]e // cursor on so[m]e
(2, '(', 1, None), (2, '(', 1, Err(Error::PairNotFound)),
// cursor on bracket itself // cursor on bracket itself
(5, '(', 1, Some((5, 10))), (5, '(', 1, Ok((5, 10))),
(10, '(', 1, Some((5, 10))), (10, '(', 1, Ok((5, 10))),
], ],
); );
} }
@ -213,9 +241,9 @@ mod test {
"(so (many (good) text) here)", "(so (many (good) text) here)",
vec![ vec![
// cursor on go[o]d // cursor on go[o]d
(13, '(', 1, Some((10, 15))), (13, '(', 1, Ok((10, 15))),
(13, '(', 2, Some((4, 21))), (13, '(', 2, Ok((4, 21))),
(13, '(', 3, Some((0, 27))), (13, '(', 3, Ok((0, 27))),
], ],
); );
} }
@ -226,11 +254,11 @@ mod test {
"'so 'many 'good' text' here'", "'so 'many 'good' text' here'",
vec![ vec![
// cursor on go[o]d // cursor on go[o]d
(13, '\'', 1, Some((10, 15))), (13, '\'', 1, Ok((10, 15))),
(13, '\'', 2, Some((4, 21))), (13, '\'', 2, Ok((4, 21))),
(13, '\'', 3, Some((0, 27))), (13, '\'', 3, Ok((0, 27))),
// cursor on the quotes // cursor on the quotes
(10, '\'', 1, None), (10, '\'', 1, Err(Error::CursorOnAmbiguousPair)),
], ],
) )
} }
@ -241,8 +269,8 @@ mod test {
"((so)((many) good (text))(here))", "((so)((many) good (text))(here))",
vec![ vec![
// cursor on go[o]d // cursor on go[o]d
(15, '(', 1, Some((5, 24))), (15, '(', 1, Ok((5, 24))),
(15, '(', 2, Some((0, 31))), (15, '(', 2, Ok((0, 31))),
], ],
) )
} }
@ -253,9 +281,9 @@ mod test {
"(so [many {good} text] here)", "(so [many {good} text] here)",
vec![ vec![
// cursor on go[o]d // cursor on go[o]d
(13, '{', 1, Some((10, 15))), (13, '{', 1, Ok((10, 15))),
(13, '[', 1, Some((4, 21))), (13, '[', 1, Ok((4, 21))),
(13, '(', 1, Some((0, 27))), (13, '(', 1, Ok((0, 27))),
], ],
) )
} }
@ -285,11 +313,10 @@ mod test {
let selection = let selection =
Selection::new(SmallVec::from_slice(&[Range::point(2), Range::point(9)]), 0); Selection::new(SmallVec::from_slice(&[Range::point(2), Range::point(9)]), 0);
// cursor on s[o]me, c[h]ars // cursor on s[o]me, c[h]ars
assert_eq!( assert_eq!(
get_surround_pos(slice, &selection, '(', 1), get_surround_pos(slice, &selection, '(', 1),
None // different surround chars Err(Error::PairNotFound) // different surround chars
); );
let selection = Selection::new( let selection = Selection::new(
@ -299,7 +326,15 @@ mod test {
// cursor on [x]x, newli[n]e // cursor on [x]x, newli[n]e
assert_eq!( assert_eq!(
get_surround_pos(slice, &selection, '(', 1), get_surround_pos(slice, &selection, '(', 1),
None // overlapping surround chars Err(Error::PairNotFound) // overlapping surround chars
);
let selection =
Selection::new(SmallVec::from_slice(&[Range::point(2), Range::point(3)]), 0);
// cursor on s[o][m]e
assert_eq!(
get_surround_pos(slice, &selection, '[', 1),
Err(Error::CursorOverlap)
); );
} }
} }

44
helix-term/src/commands.rs
Unescape Escape View File

@ -5407,7 +5407,10 @@ fn select_textobject(cx: &mut Context, objtype: textobject::TextObject) {
fn surround_add(cx: &mut Context) { fn surround_add(cx: &mut Context) {
cx.on_next_key(move |cx, event| { cx.on_next_key(move |cx, event| {
if let Some(ch) = event.char() { let ch = match event.char() {
Some(ch) => ch,
None => return,
};
let (view, doc) = current!(cx.editor); let (view, doc) = current!(cx.editor);
let selection = doc.selection(view.id); let selection = doc.selection(view.id);
let (open, close) = surround::get_pair(ch); let (open, close) = surround::get_pair(ch);
@ -5424,26 +5427,34 @@ fn surround_add(cx: &mut Context) {
let transaction = Transaction::change(doc.text(), changes.into_iter()); let transaction = Transaction::change(doc.text(), changes.into_iter());
doc.apply(&transaction, view.id); doc.apply(&transaction, view.id);
}
}) })
} }
fn surround_replace(cx: &mut Context) { fn surround_replace(cx: &mut Context) {
let count = cx.count(); let count = cx.count();
cx.on_next_key(move |cx, event| { cx.on_next_key(move |cx, event| {
if let Some(from) = event.char() { let from = match event.char() {
cx.on_next_key(move |cx, event| { Some(from) => from,
if let Some(to) = event.char() { None => return,
};
let (view, doc) = current!(cx.editor); let (view, doc) = current!(cx.editor);
let text = doc.text().slice(..); let text = doc.text().slice(..);
let selection = doc.selection(view.id); let selection = doc.selection(view.id);
let change_pos = match surround::get_surround_pos(text, selection, from, count) let change_pos = match surround::get_surround_pos(text, selection, from, count) {
{ Ok(c) => c,
Some(c) => c, Err(err) => {
None => return, cx.editor.set_error(err.to_string());
return;
}
}; };
cx.on_next_key(move |cx, event| {
let (view, doc) = current!(cx.editor);
let to = match event.char() {
Some(to) => to,
None => return,
};
let (open, close) = surround::get_pair(to); let (open, close) = surround::get_pair(to);
let transaction = Transaction::change( let transaction = Transaction::change(
doc.text(), doc.text(),
@ -5454,29 +5465,32 @@ fn surround_replace(cx: &mut Context) {
}), }),
); );
doc.apply(&transaction, view.id); doc.apply(&transaction, view.id);
}
}); });
}
}) })
} }
fn surround_delete(cx: &mut Context) { fn surround_delete(cx: &mut Context) {
let count = cx.count(); let count = cx.count();
cx.on_next_key(move |cx, event| { cx.on_next_key(move |cx, event| {
if let Some(ch) = event.char() { let ch = match event.char() {
Some(ch) => ch,
None => return,
};
let (view, doc) = current!(cx.editor); let (view, doc) = current!(cx.editor);
let text = doc.text().slice(..); let text = doc.text().slice(..);
let selection = doc.selection(view.id); let selection = doc.selection(view.id);
let change_pos = match surround::get_surround_pos(text, selection, ch, count) { let change_pos = match surround::get_surround_pos(text, selection, ch, count) {
Some(c) => c, Ok(c) => c,
None => return, Err(err) => {
cx.editor.set_error(err.to_string());
return;
}
}; };
let transaction = let transaction =
Transaction::change(doc.text(), change_pos.into_iter().map(|p| (p, p + 1, None))); Transaction::change(doc.text(), change_pos.into_iter().map(|p| (p, p + 1, None)));
doc.apply(&transaction, view.id); doc.apply(&transaction, view.id);
}
}) })
} }

Write Preview
Loading…
Cancel
Save