use helix_core::{ graphemes, indent::TAB_WIDTH, regex::Regex, register, selection, state::{Direction, Granularity, State}, ChangeSet, Range, Selection, Tendril, Transaction, }; use once_cell::sync::Lazy; use crate::compositor::Compositor; use crate::ui::{self, Prompt, PromptEvent}; use helix_view::{ document::Mode, view::{View, PADDING}, Document, Editor, }; pub struct Context<'a> { pub count: usize, pub editor: &'a mut Editor, pub executor: &'static smol::Executor<'static>, pub callback: Option, } impl<'a> Context<'a> { #[inline] pub fn view(&mut self) -> &mut View { self.editor.view_mut() } #[inline] pub fn doc(&mut self) -> &mut Document { &mut self.editor.view_mut().doc } } /// A command is a function that takes the current state and a count, and does a side-effect on the /// state (usually by creating and applying a transaction). pub type Command = fn(cx: &mut Context); pub fn move_char_left(cx: &mut Context) { let count = cx.count; let selection = cx.doc() .state .move_selection(Direction::Backward, Granularity::Character, count); cx.doc().set_selection(selection); } pub fn move_char_right(cx: &mut Context) { let count = cx.count; let selection = cx.doc() .state .move_selection(Direction::Forward, Granularity::Character, count); cx.doc().set_selection(selection); } pub fn move_line_up(cx: &mut Context) { let count = cx.count; let selection = cx .doc() .state .move_selection(Direction::Backward, Granularity::Line, count); cx.doc().set_selection(selection); } pub fn move_line_down(cx: &mut Context) { let count = cx.count; let selection = cx .doc() .state .move_selection(Direction::Forward, Granularity::Line, count); cx.doc().set_selection(selection); } pub fn move_line_end(cx: &mut Context) { let lines = selection_lines(&cx.doc().state); let positions = lines .into_iter() .map(|index| { // adjust all positions to the end of the line. // Line end is pos at the start of next line - 1 // subtract another 1 because the line ends with \n cx.doc().text().line_to_char(index + 1).saturating_sub(2) }) .map(|pos| Range::new(pos, pos)); let selection = Selection::new(positions.collect(), 0); cx.doc().set_selection(selection); } pub fn move_line_start(cx: &mut Context) { let lines = selection_lines(&cx.doc().state); let positions = lines .into_iter() .map(|index| { // adjust all positions to the start of the line. cx.doc().text().line_to_char(index) }) .map(|pos| Range::new(pos, pos)); let selection = Selection::new(positions.collect(), 0); cx.doc().set_selection(selection); } pub fn move_next_word_start(cx: &mut Context) { let count = cx.count; let doc = cx.doc(); let pos = doc.state.move_pos( doc.selection().cursor(), Direction::Forward, Granularity::Word, count, ); doc.set_selection(Selection::point(pos)); } pub fn move_prev_word_start(cx: &mut Context) { let count = cx.count; let doc = cx.doc(); let pos = doc.state.move_pos( doc.selection().cursor(), Direction::Backward, Granularity::Word, count, ); doc.set_selection(Selection::point(pos)); } pub fn move_next_word_end(cx: &mut Context) { let count = cx.count; let doc = cx.doc(); let pos = State::move_next_word_end(&doc.text().slice(..), doc.selection().cursor(), count); doc.set_selection(Selection::point(pos)); } pub fn move_file_start(cx: &mut Context) { cx.doc().set_selection(Selection::point(0)); cx.doc().mode = Mode::Normal; } pub fn move_file_end(cx: &mut Context) { let text = &cx.doc().text(); let last_line = text.line_to_char(text.len_lines().saturating_sub(2)); cx.doc().set_selection(Selection::point(last_line)); cx.doc().mode = Mode::Normal; } pub fn extend_next_word_start(cx: &mut Context) { let count = cx.count; let selection = cx .doc() .state .extend_selection(Direction::Forward, Granularity::Word, count); cx.doc().set_selection(selection); } pub fn extend_prev_word_start(cx: &mut Context) { let count = cx.count; let selection = cx .doc() .state .extend_selection(Direction::Backward, Granularity::Word, count); cx.doc().set_selection(selection); } pub fn check_cursor_in_view(view: &View) -> bool { let doc = &view.doc; let cursor = doc.selection().cursor(); let line = doc.text().char_to_line(cursor); let document_end = view.first_line + view.area.height.saturating_sub(1) as usize; if (line > document_end.saturating_sub(PADDING)) | (line < view.first_line + PADDING) { return false; } true } pub fn page_up(cx: &mut Context) { let view = cx.view(); if view.first_line < PADDING { return; } view.first_line = view.first_line.saturating_sub(view.area.height as usize); if !check_cursor_in_view(view) { let text = view.doc.text(); let pos = text.line_to_char(view.last_line().saturating_sub(PADDING)); view.doc.set_selection(Selection::point(pos)); } } pub fn page_down(cx: &mut Context) { let view = cx.view(); view.first_line += view.area.height as usize + PADDING; if view.first_line < view.doc.text().len_lines() { let text = view.doc.text(); let pos = text.line_to_char(view.first_line as usize); view.doc.set_selection(Selection::point(pos)); } } pub fn half_page_up(cx: &mut Context) { let view = cx.view(); if view.first_line < PADDING { return; } view.first_line = view .first_line .saturating_sub(view.area.height as usize / 2); if !check_cursor_in_view(view) { let text = &view.doc.text(); let pos = text.line_to_char(view.last_line() - PADDING); view.doc.set_selection(Selection::point(pos)); } } pub fn half_page_down(cx: &mut Context) { let view = cx.view(); let lines = view.doc.text().len_lines(); if view.first_line < lines.saturating_sub(view.area.height as usize) { view.first_line += view.area.height as usize / 2; } if !check_cursor_in_view(view) { let text = view.doc.text(); let pos = text.line_to_char(view.first_line as usize); view.doc.set_selection(Selection::point(pos)); } } // avoid select by default by having a visual mode switch that makes movements into selects pub fn extend_char_left(cx: &mut Context) { let count = cx.count; let doc = cx.doc(); let selection = doc .state .extend_selection(Direction::Backward, Granularity::Character, count); doc.set_selection(selection); } pub fn extend_char_right(cx: &mut Context) { let count = cx.count; let doc = cx.doc(); let selection = doc .state .extend_selection(Direction::Forward, Granularity::Character, count); doc.set_selection(selection); } pub fn extend_line_up(cx: &mut Context) { let count = cx.count; let doc = cx.doc(); let selection = doc .state .extend_selection(Direction::Backward, Granularity::Line, count); doc.set_selection(selection); } pub fn extend_line_down(cx: &mut Context) { let count = cx.count; let doc = cx.doc(); let selection = doc .state .extend_selection(Direction::Forward, Granularity::Line, count); doc.set_selection(selection); } pub fn select_regex(cx: &mut Context) { let prompt = ui::regex_prompt(cx, "select:".to_string(), |doc, regex| { let text = &doc.text().slice(..); let selection = selection::select_on_matches(text, doc.selection(), ®ex); doc.set_selection(selection); }); cx.callback = Some(Box::new( move |compositor: &mut Compositor, editor: &mut Editor| { compositor.push(Box::new(prompt)); }, )); } pub fn split_selection(cx: &mut Context) { // TODO: this needs to store initial selection state, revert on esc, confirm on enter // needs to also call the callback function per input change, not just final time. // could cheat and put it into completion_fn // // kakoune does it like this: // # save state to register // { // # restore state from register // # if event == abort, return early // # add to history if enabled // # update state // } let snapshot = cx.doc().state.clone(); let prompt = ui::regex_prompt(cx, "split:".to_string(), |doc, regex| { let text = &doc.text().slice(..); let selection = selection::split_on_matches(text, doc.selection(), ®ex); doc.set_selection(selection); }); cx.callback = Some(Box::new( move |compositor: &mut Compositor, editor: &mut Editor| { compositor.push(Box::new(prompt)); }, )); } pub fn split_selection_on_newline(cx: &mut Context) { let doc = cx.doc(); let text = &doc.text().slice(..); // only compile the regex once #[allow(clippy::trivial_regex)] static REGEX: Lazy = Lazy::new(|| Regex::new(r"\n").unwrap()); let selection = selection::split_on_matches(text, doc.selection(), ®EX); doc.set_selection(selection); } pub fn select_line(cx: &mut Context) { // TODO: count let pos = cx.doc().selection().primary(); let text = cx.doc().text(); let line = text.char_to_line(pos.head); let start = text.line_to_char(line); let end = text.line_to_char(line + 1).saturating_sub(1); cx.doc().set_selection(Selection::single(start, end)); } // heuristic: append changes to history after each command, unless we're in insert mode fn _delete_selection(cx: &mut Context) { let transaction = Transaction::change_by_selection(&cx.doc().state, |range| { (range.from(), range.to() + 1, None) }); cx.doc().apply(&transaction); } pub fn delete_selection(cx: &mut Context) { _delete_selection(cx); append_changes_to_history(cx); } pub fn change_selection(cx: &mut Context) { _delete_selection(cx); insert_mode(cx); } pub fn collapse_selection(cx: &mut Context) { let selection = cx .doc() .selection() .transform(|range| Range::new(range.head, range.head)); cx.doc().set_selection(selection); } pub fn flip_selections(cx: &mut Context) { let selection = cx .doc() .selection() .transform(|range| Range::new(range.head, range.anchor)); cx.doc().set_selection(selection); } fn enter_insert_mode(cx: &mut Context) { cx.doc().mode = Mode::Insert; // TODO: store selection for undo } // inserts at the start of each selection pub fn insert_mode(cx: &mut Context) { enter_insert_mode(cx); let selection = cx .doc() .selection() .transform(|range| Range::new(range.to(), range.from())); cx.doc().set_selection(selection); } // inserts at the end of each selection pub fn append_mode(cx: &mut Context) { enter_insert_mode(cx); let doc = cx.doc(); doc.restore_cursor = true; // TODO: as transaction let text = &doc.text().slice(..); let selection = doc.selection().transform(|range| { // TODO: to() + next char Range::new( range.from(), graphemes::next_grapheme_boundary(text, range.to()), ) }); doc.set_selection(selection); } // TODO: I, A, o and O can share a lot of the primitives. pub fn command_mode(cx: &mut Context) { let executor = cx.executor; cx.callback = Some(Box::new( move |compositor: &mut Compositor, editor: &mut Editor| { let prompt = Prompt::new( ":".to_owned(), |_input: &str| { // TODO: i need this duplicate list right now to avoid borrow checker issues let command_list = vec![ "q".to_string(), "o".to_string(), "w".to_string(), // String::from("q"), // String::from("aaa"), // String::from("bbb"), // String::from("ccc"), // String::from("ddd"), // String::from("eee"), // String::from("averylongcommandaverylongcommandaverylongcommandaverylongcommandaverylongcommand"), // String::from("q"), // String::from("aaa"), // String::from("bbb"), // String::from("ccc"), // String::from("ddd"), // String::from("eee"), // String::from("q"), // String::from("aaa"), // String::from("bbb"), // String::from("ccc"), // String::from("ddd"), // String::from("eee"), // String::from("q"), // String::from("aaa"), // String::from("bbb"), // String::from("ccc"), // String::from("ddd"), // String::from("eee"), // String::from("q"), // String::from("aaa"), // String::from("bbb"), // String::from("ccc"), // String::from("ddd"), // String::from("eee"), ]; command_list .into_iter() .filter(|command| command.contains(_input)) .collect() }, // completion move |editor: &mut Editor, input: &str, event: PromptEvent| { if event != PromptEvent::Validate { return; } let parts = input.split_ascii_whitespace().collect::>(); match *parts.as_slice() { ["q"] => editor.should_close = true, ["o", path] => { editor.open(path.into(), executor); } _ => (), } }, ); compositor.push(Box::new(prompt)); }, )); } pub fn file_picker(cx: &mut Context) { let picker = ui::file_picker("./", cx.executor); cx.callback = Some(Box::new( |compositor: &mut Compositor, editor: &mut Editor| { compositor.push(Box::new(picker)); }, )); } pub fn buffer_picker(cx: &mut Context) { unimplemented!() // cx.callback = Some(Box::new( // |compositor: &mut Compositor, editor: &mut Editor| { // let picker = ui::buffer_picker(&editor.views, editor.focus); // compositor.push(Box::new(picker)); // }, // )); } // calculate line numbers for each selection range fn selection_lines(state: &State) -> Vec { let mut lines = state .selection .ranges() .iter() .map(|range| state.doc.char_to_line(range.head)) .collect::>(); lines.sort_unstable(); // sorting by usize so _unstable is preferred lines.dedup(); lines } // I inserts at the start of each line with a selection pub fn prepend_to_line(cx: &mut Context) { enter_insert_mode(cx); move_line_start(cx); } // A inserts at the end of each line with a selection pub fn append_to_line(cx: &mut Context) { enter_insert_mode(cx); move_line_end(cx); } // o inserts a new line after each line with a selection pub fn open_below(cx: &mut Context) { enter_insert_mode(cx); let doc = cx.doc(); let lines = selection_lines(&doc.state); let positions: Vec<_> = lines .into_iter() .map(|index| { // adjust all positions to the end of the line/start of the next one. doc.text().line_to_char(index + 1) }) .collect(); let changes = positions.iter().copied().map(|index| { // TODO: share logic with insert_newline for indentation let indent_level = helix_core::indent::suggested_indent_for_pos( doc.syntax.as_ref(), &doc.state, index, true, ); let indent = " ".repeat(TAB_WIDTH).repeat(indent_level); let mut text = String::with_capacity(1 + indent.len()); text.push_str(&indent); text.push('\n'); // TODO: ideally we want to run a hook over the transactions to figure out and reindent all // \n's as a post-processing step? // behaviors: // - on insert mode enter: we add newline + indent and position cursor at the end // - on 3o/3O: we insert 3 newlines + indents each and position cursors at ends // generate changes (index, index, Some(text.into())) }); // TODO: count actually inserts "n" new lines and starts editing on all of them. // TODO: append "count" newlines and modify cursors to those lines let selection = Selection::new( changes .clone() .map(|(start, end, text): (usize, usize, Option)| { let len = text.map(|text| text.len()).unwrap() - 1; // minus newline let pos = start + len; Range::new(pos, pos) }) .collect(), 0, ); let transaction = Transaction::change(&doc.state, changes).with_selection(selection); doc.apply(&transaction); } // O inserts a new line before each line with a selection fn append_changes_to_history(cx: &mut Context) { if cx.doc().changes.is_empty() { return; } // TODO: change -> change -> undo -> change -> change fails, probably old_state needs reset let new_changeset = ChangeSet::new(cx.doc().text()); let changes = std::mem::replace(&mut cx.doc().changes, new_changeset); // Instead of doing this messy merge we could always commit, and based on transaction // annotations either add a new layer or compose into the previous one. let transaction = Transaction::from(changes).with_selection(cx.doc().selection().clone()); // increment document version // TODO: needs to happen on undo/redo too cx.doc().version += 1; // TODO: trigger lsp/documentDidChange with changes // HAXX: we need to reconstruct the state as it was before the changes.. let old_state = cx.doc().old_state.take().expect("no old_state available"); // TODO: take transaction by value? cx.doc().history.commit_revision(&transaction, &old_state); // TODO: notify LSP of changes } pub fn normal_mode(cx: &mut Context) { cx.doc().mode = Mode::Normal; append_changes_to_history(cx); let doc = cx.doc(); // if leaving append mode, move cursor back by 1 if doc.restore_cursor { let text = &doc.text().slice(..); let selection = doc.selection().transform(|range| { Range::new( range.from(), graphemes::prev_grapheme_boundary(text, range.to()), ) }); doc.set_selection(selection); doc.restore_cursor = false; } } pub fn goto_mode(cx: &mut Context) { cx.doc().mode = Mode::Goto; } // NOTE: Transactions in this module get appended to history when we switch back to normal mode. pub mod insert { use super::*; // TODO: insert means add text just before cursor, on exit we should be on the last letter. pub fn insert_char(cx: &mut Context, c: char) { let c = Tendril::from_char(c); let transaction = Transaction::insert(&cx.doc().state, c); cx.doc().apply(&transaction); } pub fn insert_tab(cx: &mut Context) { insert_char(cx, '\t'); } pub fn insert_newline(cx: &mut Context) { let doc = cx.doc(); let transaction = Transaction::change_by_selection(&doc.state, |range| { let indent_level = helix_core::indent::suggested_indent_for_pos( doc.syntax.as_ref(), &doc.state, range.head, true, ); let indent = " ".repeat(TAB_WIDTH).repeat(indent_level); let mut text = String::with_capacity(1 + indent.len()); text.push('\n'); text.push_str(&indent); (range.head, range.head, Some(text.into())) }); doc.apply(&transaction); } // TODO: handle indent-aware delete pub fn delete_char_backward(cx: &mut Context) { let count = cx.count; let doc = cx.doc(); let text = &doc.text().slice(..); let transaction = Transaction::change_by_selection(&doc.state, |range| { ( graphemes::nth_prev_grapheme_boundary(text, range.head, count), range.head, None, ) }); doc.apply(&transaction); } pub fn delete_char_forward(cx: &mut Context) { let count = cx.count; let doc = cx.doc(); let text = &doc.text().slice(..); let transaction = Transaction::change_by_selection(&doc.state, |range| { ( range.head, graphemes::nth_next_grapheme_boundary(text, range.head, count), None, ) }); doc.apply(&transaction); } } pub fn insert_char_prompt(prompt: &mut Prompt, c: char) { prompt.insert_char(c); } // Undo / Redo // TODO: each command could simply return a Option, then the higher level handles // storing it? pub fn undo(cx: &mut Context) { cx.doc().undo(); } pub fn redo(cx: &mut Context) { cx.doc().redo(); } // Yank / Paste pub fn yank(cx: &mut Context) { // TODO: should selections be made end inclusive? let doc = cx.doc(); let values = doc .state .selection() .fragments(&doc.text().slice(..)) .map(|cow| cow.into_owned()) .collect(); // TODO: allow specifying reg let reg = '"'; register::set(reg, values); } pub fn paste(cx: &mut Context) { // TODO: allow specifying reg let reg = '"'; if let Some(values) = register::get(reg) { let repeat = std::iter::repeat( values .last() .map(|value| Tendril::from_slice(value)) .unwrap(), ); // TODO: if any of values ends \n it's linewise paste // // p => paste after // P => paste before // alt-p => paste every yanked selection after selected text // alt-P => paste every yanked selection before selected text // R => replace selected text with yanked text // alt-R => replace selected text with every yanked text // // append => insert at next line // insert => insert at start of line // replace => replace // default insert let linewise = values.iter().any(|value| value.ends_with('\n')); let mut values = values.into_iter().map(Tendril::from).chain(repeat); let doc = cx.doc(); let transaction = if linewise { // paste on the next line // TODO: can simply take a range + modifier and compute the right pos without ifs let text = doc.text(); Transaction::change_by_selection(&doc.state, |range| { let line_end = text.line_to_char(text.char_to_line(range.head) + 1); (line_end, line_end, Some(values.next().unwrap())) }) } else { Transaction::change_by_selection(&doc.state, |range| { (range.head + 1, range.head + 1, Some(values.next().unwrap())) }) }; doc.apply(&transaction); append_changes_to_history(cx); } } fn get_lines(doc: &Document) -> Vec { let mut lines = Vec::new(); // Get all line numbers for range in doc.selection().ranges() { let start = doc.text().char_to_line(range.from()); let end = doc.text().char_to_line(range.to()); for line in start..=end { lines.push(line) } } lines.sort_unstable(); // sorting by usize so _unstable is preferred lines.dedup(); lines } pub fn indent(cx: &mut Context) { let doc = cx.doc(); let lines = get_lines(doc); // Indent by one level let indent = Tendril::from(" ".repeat(TAB_WIDTH)); let transaction = Transaction::change( &doc.state, lines.into_iter().map(|line| { let pos = doc.text().line_to_char(line); (pos, pos, Some(indent.clone())) }), ); cx.doc().apply(&transaction); append_changes_to_history(cx); } pub fn unindent(cx: &mut Context) { let doc = cx.doc(); let lines = get_lines(doc); let mut changes = Vec::with_capacity(lines.len()); for line_idx in lines { let line = doc.text().line(line_idx); let mut width = 0; for ch in line.chars() { match ch { ' ' => width += 1, '\t' => width = (width / TAB_WIDTH + 1) * TAB_WIDTH, _ => break, } if width >= TAB_WIDTH { break; } } if width > 0 { let start = doc.text().line_to_char(line_idx); changes.push((start, start + width, None)) } } let transaction = Transaction::change(&doc.state, changes.into_iter()); doc.apply(&transaction); append_changes_to_history(cx); } pub fn indent_selection(_cx: &mut Context) { // loop over each line and recompute proper indentation unimplemented!() } // pub fn save(cx: &mut Context) { // Spawns an async task to actually do the saving. This way we prevent blocking. // TODO: handle save errors somehow? cx.executor.spawn(cx.doc().save()).detach(); } pub fn completion(cx: &mut Context) { let language_server = cx .editor .language_servers .get("source.rust", &cx.executor) .unwrap(); use log::info; let doc = cx.doc(); // TODO: blocking here is not ideal let pos = helix_lsp::util::pos_to_lsp_pos(&doc.text().slice(..), doc.selection().cursor()); // TODO: handle fails let res = smol::block_on(language_server.completion(cx.doc().identifier(), pos)).unwrap_or_default(); // TODO: if no completion, show some message or something if !res.is_empty() { let picker = ui::Picker::new( res, |item| { // format_fn item.label.as_str().into() // TODO: use item.filter_text for filtering }, |editor: &mut Editor, item| { use helix_lsp::{lsp, util}; // determine what to insert: text_edit | insert_text | label let edit = if let Some(edit) = &item.text_edit { match edit { lsp::CompletionTextEdit::Edit(edit) => edit.clone(), lsp::CompletionTextEdit::InsertAndReplace(item) => { unimplemented!("completion: insert_and_replace {:?}", item) } } } else { item.insert_text.as_ref().unwrap_or(&item.label); unimplemented!(); // lsp::TextEdit::new(); TODO: calculate a TextEdit from insert_text // and we insert at position. }; // TODO: merge edit with additional_text_edits if let Some(additional_edits) = &item.additional_text_edits { if !additional_edits.is_empty() { unimplemented!("completion: additional_text_edits: {:?}", additional_edits); } } let doc = &mut editor.view_mut().doc; let transaction = util::generate_transaction_from_edits(&doc.state, vec![edit]); doc.apply(&transaction); // TODO: append_changes_to_history(cx); if not in insert mode? }, ); cx.callback = Some(Box::new( move |compositor: &mut Compositor, editor: &mut Editor| { compositor.push(Box::new(picker)); }, )); // TODO!: when iterating over items, show the docs in popup // language server client needs to be accessible via a registry of some sort } } // view movements pub fn next_view(cx: &mut Context) { cx.editor.tree.focus_next() }