Skip to main content

iced_code_editor/canvas_editor/input/update/
dispatch.rs

1//! Top-level message dispatcher: routes every [`Message`] variant to its handler.
2
3use iced::Task;
4
5use crate::canvas_editor::{CodeEditor, Message};
6
7impl CodeEditor {
8    /// Updates the editor state based on messages and returns scroll commands.
9    ///
10    /// # Arguments
11    ///
12    /// * `message` - The message to process for updating the editor state
13    ///
14    /// # Returns
15    /// A `Task<Message>` for any asynchronous operations, such as scrolling to keep the cursor visible after state updates
16    ///
17    /// # Example
18    ///
19    /// ```
20    /// use iced_code_editor::{CodeEditor, Message};
21    ///
22    /// let mut editor = CodeEditor::new("hello", "rs");
23    ///
24    /// // Forward the messages the editor emits, and send your own to drive
25    /// // commands from a menu or toolbar.
26    /// let _task = editor.update(&Message::Paste(" world".to_string()));
27    /// assert_eq!(editor.content(), " worldhello");
28    ///
29    /// let _task = editor.update(&Message::Undo);
30    /// assert_eq!(editor.content(), "hello");
31    /// ```
32    pub fn update(&mut self, message: &Message) -> Task<Message> {
33        // Capture the topmost active line before any edit mutates the buffer,
34        // so `finish_edit_operation` can truncate the highlight cache precisely.
35        self.pre_edit_line = self.min_active_line();
36        self.pre_edit_last_line = self.max_active_line();
37        self.capture_lsp_edit_snapshot(message);
38        match message {
39            // Text input operations
40            Message::CharacterInput(ch) if self.vim_accepts_insert_input() => {
41                self.handle_character_input_msg(*ch)
42            }
43            Message::CharacterInput(_) => Task::none(),
44            Message::VimKey(ch) => self.handle_vim_key_msg(*ch),
45            Message::ToggleVimMode => {
46                self.set_vim_enabled(!self.vim_enabled);
47                Task::none()
48            }
49            Message::Tab if self.vim_accepts_insert_input() => {
50                self.handle_tab()
51            }
52            Message::Backtab if self.vim_accepts_insert_input() => {
53                self.handle_backtab()
54            }
55            Message::Enter if self.vim_accepts_insert_input() => {
56                self.handle_enter()
57            }
58            Message::Tab | Message::Backtab | Message::Enter => Task::none(),
59
60            // Deletion operations
61            Message::Backspace if self.vim_accepts_insert_input() => {
62                self.handle_backspace()
63            }
64            Message::Delete if self.vim_accepts_insert_input() => {
65                self.handle_delete()
66            }
67            Message::DeleteWordBack if self.vim_accepts_insert_input() => {
68                self.handle_delete_word(false)
69            }
70            Message::DeleteWordForward if self.vim_accepts_insert_input() => {
71                self.handle_delete_word(true)
72            }
73            Message::Backspace
74            | Message::Delete
75            | Message::DeleteWordBack
76            | Message::DeleteWordForward => Task::none(),
77            Message::DeleteSelection => self.handle_delete_selection(),
78
79            // Navigation operations
80            Message::ArrowKey(direction, shift) => {
81                self.handle_arrow_key(*direction, *shift)
82            }
83            Message::Home(shift) => self.handle_home(*shift),
84            Message::End(shift) => self.handle_end(*shift),
85            Message::CtrlHome => self.handle_ctrl_home(),
86            Message::CtrlEnd => self.handle_ctrl_end(),
87            Message::WordLeft(shift) => self.handle_word_move(false, *shift),
88            Message::WordRight(shift) => self.handle_word_move(true, *shift),
89            Message::GotoPosition(line, col) => {
90                self.handle_goto_position(*line, *col)
91            }
92            Message::OpenGotoLine => self.handle_open_goto_line_msg(),
93            Message::CloseGotoLine => self.handle_close_goto_line_msg(),
94            Message::GotoLineChanged(query) => {
95                self.handle_goto_line_changed_msg(query)
96            }
97            Message::SubmitGotoLine => self.handle_submit_goto_line_msg(),
98            Message::OpenCommandPalette => {
99                self.handle_open_command_palette_msg()
100            }
101            Message::CloseCommandPalette => {
102                self.handle_close_command_palette_msg()
103            }
104            Message::CommandPaletteChanged(query) => {
105                self.handle_command_palette_changed_msg(query)
106            }
107            Message::CommandPaletteNavigate(forward) => {
108                self.handle_command_palette_navigate_msg(*forward)
109            }
110            Message::CommandPaletteSelected(index) => {
111                self.handle_command_palette_selected_msg(*index)
112            }
113            Message::SubmitCommandPalette => {
114                self.handle_submit_command_palette_msg()
115            }
116            Message::PageUp(shift) => self.handle_page_up(*shift),
117            Message::PageDown(shift) => self.handle_page_down(*shift),
118
119            // Mouse and selection operations
120            Message::MouseClick(point) => self.handle_mouse_click_msg(*point),
121            Message::MouseDrag(point) => self.handle_mouse_drag_msg(*point),
122            Message::MouseHover(point) => self.handle_mouse_drag_msg(*point),
123            Message::SelectionAutoScroll(seconds) => {
124                self.handle_selection_auto_scroll(*seconds)
125            }
126            Message::MouseRelease => self.handle_mouse_release_msg(),
127            Message::DoubleClick(point) => self.handle_double_click_msg(*point),
128            Message::TripleClick(point) => self.handle_triple_click_msg(*point),
129            Message::ContextMenuRequested(point) => {
130                self.handle_context_menu_requested_msg(*point)
131            }
132            Message::WriteRequested
133            | Message::CustomContextMenuAction(_)
134            | Message::CommandPaletteAction(_)
135            | Message::RevealInFileManager => Task::none(),
136
137            // Clipboard operations
138            Message::Cut => self.handle_cut_msg(),
139            Message::Copy => self.copy_selection(),
140            Message::Paste(text) => self.handle_paste_msg(text),
141            Message::SelectAll => self.handle_select_all_msg(),
142
143            // History operations
144            Message::Undo => self.handle_undo_msg(),
145            Message::Redo => self.handle_redo_msg(),
146
147            // Search and replace operations
148            Message::OpenSearch => self.handle_open_search(false),
149            Message::OpenSearchReplace => self.handle_open_search(true),
150            Message::CloseSearch => self.handle_close_search_msg(),
151            Message::SearchQueryChanged(query) => {
152                self.handle_search_query_changed_msg(query)
153            }
154            Message::ReplaceQueryChanged(text) => {
155                self.handle_replace_query_changed_msg(text)
156            }
157            Message::ToggleCaseSensitive => {
158                self.handle_toggle_case_sensitive_msg()
159            }
160            Message::ToggleWholeWord | Message::ToggleSearchRegex => {
161                if matches!(message, Message::ToggleWholeWord) {
162                    self.search_state.whole_word =
163                        !self.search_state.whole_word;
164                } else {
165                    self.search_state.use_regex = !self.search_state.use_regex;
166                }
167                self.search_state.update_matches(&self.buffer);
168                self.overlay_cache.clear();
169                Task::none()
170            }
171            Message::ToggleSearchMultiline => {
172                self.search_state.multiline = !self.search_state.multiline;
173                iced::widget::operation::focus(
174                    self.search_state.search_input_id.clone(),
175                )
176            }
177            Message::ToggleSearchReplace => {
178                self.search_state.is_replace_mode =
179                    !self.search_state.is_replace_mode;
180                Task::none()
181            }
182            Message::SearchInputAction(action) => {
183                self.search_state.search_content.perform(action.clone());
184                let query = self.search_state.search_content.text();
185                self.handle_search_query_changed_msg(&query)
186            }
187            Message::ReplaceInputAction(action) => {
188                self.search_state.replace_content.perform(action.clone());
189                let value = self.search_state.replace_content.text();
190                self.handle_replace_query_changed_msg(&value)
191            }
192            Message::SelectAllSearchMatches => {
193                self.handle_select_all_search_matches()
194            }
195            Message::FindNext => self.handle_find_match(true),
196            Message::FindPrevious => self.handle_find_match(false),
197            Message::ReplaceNext => self.handle_replace_next_msg(),
198            Message::ReplaceAll => self.handle_replace_all_msg(),
199            Message::SearchDialogTab => self.handle_search_dialog_tab(true),
200            Message::SearchDialogShiftTab => {
201                self.handle_search_dialog_tab(false)
202            }
203
204            // Focus and IME operations
205            Message::CanvasFocusGained => self.handle_canvas_focus_gained_msg(),
206            Message::CanvasFocusLost => self.handle_canvas_focus_lost_msg(),
207            Message::ImeOpened if self.vim_accepts_insert_input() => {
208                self.handle_ime_opened_msg()
209            }
210            Message::ImeOpened => Task::none(),
211            Message::ImePreedit(content, selection) => {
212                if self.vim_accepts_insert_input() {
213                    self.handle_ime_preedit_msg(content, selection)
214                } else {
215                    Task::none()
216                }
217            }
218            Message::ImeCommit(text) => self.handle_ime_commit_msg(text),
219            Message::ImeClosed => self.handle_ime_closed_msg(),
220
221            // UI update operations
222            Message::Tick => self.handle_tick_msg(),
223            Message::Scrolled(viewport) => self.handle_scrolled_msg(*viewport),
224            Message::HorizontalScrolled(viewport) => {
225                self.handle_horizontal_scrolled_msg(*viewport)
226            }
227
228            // Handle the "Jump to Definition" action triggered by Ctrl+Click.
229            // Currently, this returns `Task::none()` as the actual navigation logic
230            // is delegated to the `LspClient` implementation or handled elsewhere.
231            Message::JumpClick(_point) => Task::none(),
232
233            // Multi-cursor operations
234            Message::AltClick(point) => self.handle_alt_click_msg(*point),
235            Message::ShiftClick(point) => self.handle_shift_click_msg(*point),
236            Message::AddCursorAbove => self.handle_add_cursor_above_msg(),
237            Message::AddCursorBelow => self.handle_add_cursor_below_msg(),
238            Message::SelectNextOccurrence => {
239                self.handle_select_next_occurrence_msg()
240            }
241            Message::ToggleFold(header_line) => {
242                self.toggle_fold(*header_line);
243                Task::none()
244            }
245            Message::ToggleFoldAtCursor => {
246                self.toggle_fold_at(self.cursors.primary_position().0);
247                Task::none()
248            }
249            Message::FoldAll => {
250                self.fold_all();
251                Task::none()
252            }
253            Message::UnfoldAll => {
254                self.unfold_all();
255                Task::none()
256            }
257
258            // Line manipulation operations
259            Message::MoveLineUp => self.move_lines(false),
260            Message::MoveLineDown => self.move_lines(true),
261            Message::DuplicateLineUp => self.duplicate_lines(false),
262            Message::DuplicateLineDown => self.duplicate_lines(true),
263            Message::ToggleComment => self.toggle_comment(),
264
265            // Sticky scroll. The headroom matters: the blocks enclosing `line`
266            // stay pinned once it is at the top, so a jump to row 0 would land
267            // it underneath its own outer header.
268            Message::StickyScrollJump(line) => {
269                self.scroll_to_line(*line, self.sticky_headroom(*line))
270            }
271        }
272    }
273}
274
275#[cfg(test)]
276mod tests {
277    use super::*;
278
279    #[test]
280    fn test_escape_collapses_multi_cursor() {
281        let mut editor = CodeEditor::new("line0\nline1", "rs");
282        editor.cursors.primary_mut().position = (0, 0);
283        editor.cursors.add_cursor((1, 0));
284        assert!(editor.cursors.is_multi());
285
286        let _ = editor.update(&Message::CloseSearch);
287
288        assert!(!editor.cursors.is_multi());
289    }
290}