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::Enter if self.vim_accepts_insert_input() => {
53                self.handle_enter()
54            }
55            Message::Tab | Message::Enter => Task::none(),
56
57            // Deletion operations
58            Message::Backspace if self.vim_accepts_insert_input() => {
59                self.handle_backspace()
60            }
61            Message::Delete if self.vim_accepts_insert_input() => {
62                self.handle_delete()
63            }
64            Message::Backspace | Message::Delete => Task::none(),
65            Message::DeleteSelection => self.handle_delete_selection(),
66
67            // Navigation operations
68            Message::ArrowKey(direction, shift) => {
69                self.handle_arrow_key(*direction, *shift)
70            }
71            Message::Home(shift) => self.handle_home(*shift),
72            Message::End(shift) => self.handle_end(*shift),
73            Message::CtrlHome => self.handle_ctrl_home(),
74            Message::CtrlEnd => self.handle_ctrl_end(),
75            Message::GotoPosition(line, col) => {
76                self.handle_goto_position(*line, *col)
77            }
78            Message::OpenGotoLine => self.handle_open_goto_line_msg(),
79            Message::CloseGotoLine => self.handle_close_goto_line_msg(),
80            Message::GotoLineChanged(query) => {
81                self.handle_goto_line_changed_msg(query)
82            }
83            Message::SubmitGotoLine => self.handle_submit_goto_line_msg(),
84            Message::OpenCommandPalette => {
85                self.handle_open_command_palette_msg()
86            }
87            Message::CloseCommandPalette => {
88                self.handle_close_command_palette_msg()
89            }
90            Message::CommandPaletteChanged(query) => {
91                self.handle_command_palette_changed_msg(query)
92            }
93            Message::CommandPaletteNavigate(forward) => {
94                self.handle_command_palette_navigate_msg(*forward)
95            }
96            Message::CommandPaletteSelected(index) => {
97                self.handle_command_palette_selected_msg(*index)
98            }
99            Message::SubmitCommandPalette => {
100                self.handle_submit_command_palette_msg()
101            }
102            Message::PageUp(shift) => self.handle_page_up(*shift),
103            Message::PageDown(shift) => self.handle_page_down(*shift),
104
105            // Mouse and selection operations
106            Message::MouseClick(point) => self.handle_mouse_click_msg(*point),
107            Message::MouseDrag(point) => self.handle_mouse_drag_msg(*point),
108            Message::MouseHover(point) => self.handle_mouse_drag_msg(*point),
109            Message::MouseRelease => self.handle_mouse_release_msg(),
110            Message::DoubleClick(point) => self.handle_double_click_msg(*point),
111            Message::TripleClick(point) => self.handle_triple_click_msg(*point),
112            Message::ContextMenuRequested(point) => {
113                self.handle_context_menu_requested_msg(*point)
114            }
115            Message::WriteRequested
116            | Message::CustomContextMenuAction(_)
117            | Message::CommandPaletteAction(_)
118            | Message::RevealInFileManager => Task::none(),
119
120            // Clipboard operations
121            Message::Cut => self.handle_cut_msg(),
122            Message::Copy => self.copy_selection(),
123            Message::Paste(text) => self.handle_paste_msg(text),
124            Message::SelectAll => self.handle_select_all_msg(),
125
126            // History operations
127            Message::Undo => self.handle_undo_msg(),
128            Message::Redo => self.handle_redo_msg(),
129
130            // Search and replace operations
131            Message::OpenSearch => self.handle_open_search(false),
132            Message::OpenSearchReplace => self.handle_open_search(true),
133            Message::CloseSearch => self.handle_close_search_msg(),
134            Message::SearchQueryChanged(query) => {
135                self.handle_search_query_changed_msg(query)
136            }
137            Message::ReplaceQueryChanged(text) => {
138                self.handle_replace_query_changed_msg(text)
139            }
140            Message::ToggleCaseSensitive => {
141                self.handle_toggle_case_sensitive_msg()
142            }
143            Message::FindNext => self.handle_find_match(true),
144            Message::FindPrevious => self.handle_find_match(false),
145            Message::ReplaceNext => self.handle_replace_next_msg(),
146            Message::ReplaceAll => self.handle_replace_all_msg(),
147            Message::SearchDialogTab => self.handle_search_dialog_tab(true),
148            Message::SearchDialogShiftTab => {
149                self.handle_search_dialog_tab(false)
150            }
151            Message::FocusNavigationShiftTab => self.handle_focus_navigation(),
152
153            // Focus and IME operations
154            Message::CanvasFocusGained => self.handle_canvas_focus_gained_msg(),
155            Message::CanvasFocusLost => self.handle_canvas_focus_lost_msg(),
156            Message::ImeOpened if self.vim_accepts_insert_input() => {
157                self.handle_ime_opened_msg()
158            }
159            Message::ImeOpened => Task::none(),
160            Message::ImePreedit(content, selection) => {
161                if self.vim_accepts_insert_input() {
162                    self.handle_ime_preedit_msg(content, selection)
163                } else {
164                    Task::none()
165                }
166            }
167            Message::ImeCommit(text) => self.handle_ime_commit_msg(text),
168            Message::ImeClosed => self.handle_ime_closed_msg(),
169
170            // UI update operations
171            Message::Tick => self.handle_tick_msg(),
172            Message::Scrolled(viewport) => self.handle_scrolled_msg(*viewport),
173            Message::HorizontalScrolled(viewport) => {
174                self.handle_horizontal_scrolled_msg(*viewport)
175            }
176
177            // Handle the "Jump to Definition" action triggered by Ctrl+Click.
178            // Currently, this returns `Task::none()` as the actual navigation logic
179            // is delegated to the `LspClient` implementation or handled elsewhere.
180            Message::JumpClick(_point) => Task::none(),
181
182            // Multi-cursor operations
183            Message::AltClick(point) => self.handle_alt_click_msg(*point),
184            Message::AddCursorAbove => self.handle_add_cursor_above_msg(),
185            Message::AddCursorBelow => self.handle_add_cursor_below_msg(),
186            Message::SelectNextOccurrence => {
187                self.handle_select_next_occurrence_msg()
188            }
189            Message::ToggleFold(header_line) => {
190                self.toggle_fold(*header_line);
191                Task::none()
192            }
193            Message::ToggleFoldAtCursor => {
194                self.toggle_fold_at(self.cursors.primary_position().0);
195                Task::none()
196            }
197            Message::FoldAll => {
198                self.fold_all();
199                Task::none()
200            }
201            Message::UnfoldAll => {
202                self.unfold_all();
203                Task::none()
204            }
205
206            // Line manipulation operations
207            Message::MoveLineUp => self.move_lines(false),
208            Message::MoveLineDown => self.move_lines(true),
209            Message::DuplicateLineUp => self.duplicate_lines(false),
210            Message::DuplicateLineDown => self.duplicate_lines(true),
211            Message::ToggleComment => self.toggle_comment(),
212
213            // Sticky scroll. The headroom matters: the blocks enclosing `line`
214            // stay pinned once it is at the top, so a jump to row 0 would land
215            // it underneath its own outer header.
216            Message::StickyScrollJump(line) => {
217                self.scroll_to_line(*line, self.sticky_headroom(*line))
218            }
219        }
220    }
221}
222
223#[cfg(test)]
224mod tests {
225    use super::*;
226
227    #[test]
228    fn test_escape_collapses_multi_cursor() {
229        let mut editor = CodeEditor::new("line0\nline1", "rs");
230        editor.cursors.primary_mut().position = (0, 0);
231        editor.cursors.add_cursor((1, 0));
232        assert!(editor.cursors.is_multi());
233
234        let _ = editor.update(&Message::CloseSearch);
235
236        assert!(!editor.cursors.is_multi());
237    }
238}