buffer_search.rs

  1use crate::{
  2    SearchOption, SelectNextMatch, SelectPrevMatch, ToggleCaseSensitive, ToggleRegex,
  3    ToggleWholeWord,
  4};
  5use collections::HashMap;
  6use editor::Editor;
  7use gpui::{
  8    actions,
  9    elements::*,
 10    impl_actions,
 11    platform::{CursorStyle, MouseButton},
 12    Action, AnyViewHandle, AppContext, Entity, Subscription, Task, View, ViewContext, ViewHandle,
 13};
 14use project::search::SearchQuery;
 15use serde::Deserialize;
 16use settings::Settings;
 17use std::{any::Any, sync::Arc};
 18use util::ResultExt;
 19use workspace::{
 20    item::ItemHandle,
 21    searchable::{Direction, SearchEvent, SearchableItemHandle, WeakSearchableItemHandle},
 22    Pane, ToolbarItemLocation, ToolbarItemView,
 23};
 24
 25#[derive(Clone, Deserialize, PartialEq)]
 26pub struct Deploy {
 27    pub focus: bool,
 28}
 29
 30actions!(buffer_search, [Dismiss, FocusEditor]);
 31impl_actions!(buffer_search, [Deploy]);
 32
 33pub enum Event {
 34    UpdateLocation,
 35}
 36
 37pub fn init(cx: &mut AppContext) {
 38    cx.add_action(BufferSearchBar::deploy);
 39    cx.add_action(BufferSearchBar::dismiss);
 40    cx.add_action(BufferSearchBar::focus_editor);
 41    cx.add_action(BufferSearchBar::select_next_match);
 42    cx.add_action(BufferSearchBar::select_prev_match);
 43    cx.add_action(BufferSearchBar::select_next_match_on_pane);
 44    cx.add_action(BufferSearchBar::select_prev_match_on_pane);
 45    cx.add_action(BufferSearchBar::handle_editor_cancel);
 46    add_toggle_option_action::<ToggleCaseSensitive>(SearchOption::CaseSensitive, cx);
 47    add_toggle_option_action::<ToggleWholeWord>(SearchOption::WholeWord, cx);
 48    add_toggle_option_action::<ToggleRegex>(SearchOption::Regex, cx);
 49}
 50
 51fn add_toggle_option_action<A: Action>(option: SearchOption, cx: &mut AppContext) {
 52    cx.add_action(move |pane: &mut Pane, _: &A, cx: &mut ViewContext<Pane>| {
 53        if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
 54            if search_bar.update(cx, |search_bar, cx| search_bar.show(false, false, cx)) {
 55                search_bar.update(cx, |search_bar, cx| {
 56                    search_bar.toggle_search_option(option, cx);
 57                });
 58                return;
 59            }
 60        }
 61        cx.propagate_action();
 62    });
 63}
 64
 65pub struct BufferSearchBar {
 66    pub query_editor: ViewHandle<Editor>,
 67    active_searchable_item: Option<Box<dyn SearchableItemHandle>>,
 68    active_match_index: Option<usize>,
 69    active_searchable_item_subscription: Option<Subscription>,
 70    seachable_items_with_matches:
 71        HashMap<Box<dyn WeakSearchableItemHandle>, Vec<Box<dyn Any + Send>>>,
 72    pending_search: Option<Task<()>>,
 73    case_sensitive: bool,
 74    whole_word: bool,
 75    regex: bool,
 76    query_contains_error: bool,
 77    dismissed: bool,
 78}
 79
 80impl Entity for BufferSearchBar {
 81    type Event = Event;
 82}
 83
 84impl View for BufferSearchBar {
 85    fn ui_name() -> &'static str {
 86        "BufferSearchBar"
 87    }
 88
 89    fn focus_in(&mut self, _: AnyViewHandle, cx: &mut ViewContext<Self>) {
 90        if cx.is_self_focused() {
 91            cx.focus(&self.query_editor);
 92        }
 93    }
 94
 95    fn render(&mut self, cx: &mut ViewContext<Self>) -> AnyElement<Self> {
 96        let theme = cx.global::<Settings>().theme.clone();
 97        let editor_container = if self.query_contains_error {
 98            theme.search.invalid_editor
 99        } else {
100            theme.search.editor.input.container
101        };
102        let supported_options = self
103            .active_searchable_item
104            .as_ref()
105            .map(|active_searchable_item| active_searchable_item.supported_options())
106            .unwrap_or_default();
107
108        Flex::row()
109            .with_child(
110                Flex::row()
111                    .with_child(
112                        Flex::row()
113                            .with_child(
114                                ChildView::new(&self.query_editor, cx)
115                                    .aligned()
116                                    .left()
117                                    .flex(1., true),
118                            )
119                            .with_children(self.active_searchable_item.as_ref().and_then(
120                                |searchable_item| {
121                                    let matches = self
122                                        .seachable_items_with_matches
123                                        .get(&searchable_item.downgrade())?;
124                                    let message = if let Some(match_ix) = self.active_match_index {
125                                        format!("{}/{}", match_ix + 1, matches.len())
126                                    } else {
127                                        "No matches".to_string()
128                                    };
129
130                                    Some(
131                                        Label::new(message, theme.search.match_index.text.clone())
132                                            .contained()
133                                            .with_style(theme.search.match_index.container)
134                                            .aligned(),
135                                    )
136                                },
137                            ))
138                            .contained()
139                            .with_style(editor_container)
140                            .aligned()
141                            .constrained()
142                            .with_min_width(theme.search.editor.min_width)
143                            .with_max_width(theme.search.editor.max_width)
144                            .flex(1., false),
145                    )
146                    .with_child(
147                        Flex::row()
148                            .with_child(self.render_nav_button("<", Direction::Prev, cx))
149                            .with_child(self.render_nav_button(">", Direction::Next, cx))
150                            .aligned(),
151                    )
152                    .with_child(
153                        Flex::row()
154                            .with_children(self.render_search_option(
155                                supported_options.case,
156                                "Case",
157                                SearchOption::CaseSensitive,
158                                cx,
159                            ))
160                            .with_children(self.render_search_option(
161                                supported_options.word,
162                                "Word",
163                                SearchOption::WholeWord,
164                                cx,
165                            ))
166                            .with_children(self.render_search_option(
167                                supported_options.regex,
168                                "Regex",
169                                SearchOption::Regex,
170                                cx,
171                            ))
172                            .contained()
173                            .with_style(theme.search.option_button_group)
174                            .aligned(),
175                    )
176                    .flex(1., true),
177            )
178            .with_child(self.render_close_button(&theme.search, cx))
179            .contained()
180            .with_style(theme.search.container)
181            .into_any_named("search bar")
182    }
183}
184
185impl ToolbarItemView for BufferSearchBar {
186    fn set_active_pane_item(
187        &mut self,
188        item: Option<&dyn ItemHandle>,
189        cx: &mut ViewContext<Self>,
190    ) -> ToolbarItemLocation {
191        cx.notify();
192        self.active_searchable_item_subscription.take();
193        self.active_searchable_item.take();
194        self.pending_search.take();
195
196        if let Some(searchable_item_handle) =
197            item.and_then(|item| item.to_searchable_item_handle(cx))
198        {
199            let this = cx.weak_handle();
200            self.active_searchable_item_subscription =
201                Some(searchable_item_handle.subscribe_to_search_events(
202                    cx,
203                    Box::new(move |search_event, cx| {
204                        if let Some(this) = this.upgrade(cx) {
205                            this.update(cx, |this, cx| {
206                                this.on_active_searchable_item_event(search_event, cx)
207                            });
208                        }
209                    }),
210                ));
211
212            self.active_searchable_item = Some(searchable_item_handle);
213            self.update_matches(false, cx);
214            if !self.dismissed {
215                return ToolbarItemLocation::Secondary;
216            }
217        }
218
219        ToolbarItemLocation::Hidden
220    }
221
222    fn location_for_event(
223        &self,
224        _: &Self::Event,
225        _: ToolbarItemLocation,
226        _: &AppContext,
227    ) -> ToolbarItemLocation {
228        if self.active_searchable_item.is_some() && !self.dismissed {
229            ToolbarItemLocation::Secondary
230        } else {
231            ToolbarItemLocation::Hidden
232        }
233    }
234}
235
236impl BufferSearchBar {
237    pub fn new(cx: &mut ViewContext<Self>) -> Self {
238        let query_editor = cx.add_view(|cx| {
239            Editor::auto_height(
240                2,
241                Some(Arc::new(|theme| theme.search.editor.input.clone())),
242                cx,
243            )
244        });
245        cx.subscribe(&query_editor, Self::on_query_editor_event)
246            .detach();
247
248        Self {
249            query_editor,
250            active_searchable_item: None,
251            active_searchable_item_subscription: None,
252            active_match_index: None,
253            seachable_items_with_matches: Default::default(),
254            case_sensitive: false,
255            whole_word: false,
256            regex: false,
257            pending_search: None,
258            query_contains_error: false,
259            dismissed: true,
260        }
261    }
262
263    fn dismiss(&mut self, _: &Dismiss, cx: &mut ViewContext<Self>) {
264        self.dismissed = true;
265        for searchable_item in self.seachable_items_with_matches.keys() {
266            if let Some(searchable_item) =
267                WeakSearchableItemHandle::upgrade(searchable_item.as_ref(), cx)
268            {
269                searchable_item.clear_matches(cx);
270            }
271        }
272        if let Some(active_editor) = self.active_searchable_item.as_ref() {
273            cx.focus(active_editor.as_any());
274        }
275        cx.emit(Event::UpdateLocation);
276        cx.notify();
277    }
278
279    fn show(&mut self, focus: bool, suggest_query: bool, cx: &mut ViewContext<Self>) -> bool {
280        let searchable_item = if let Some(searchable_item) = &self.active_searchable_item {
281            SearchableItemHandle::boxed_clone(searchable_item.as_ref())
282        } else {
283            return false;
284        };
285
286        if suggest_query {
287            let text = searchable_item.query_suggestion(cx);
288            if !text.is_empty() {
289                self.set_query(&text, cx);
290            }
291        }
292
293        if focus {
294            let query_editor = self.query_editor.clone();
295            query_editor.update(cx, |query_editor, cx| {
296                query_editor.select_all(&editor::SelectAll, cx);
297            });
298            cx.focus_self();
299        }
300
301        self.dismissed = false;
302        cx.notify();
303        cx.emit(Event::UpdateLocation);
304        true
305    }
306
307    fn set_query(&mut self, query: &str, cx: &mut ViewContext<Self>) {
308        self.query_editor.update(cx, |query_editor, cx| {
309            query_editor.buffer().update(cx, |query_buffer, cx| {
310                let len = query_buffer.len(cx);
311                query_buffer.edit([(0..len, query)], None, cx);
312            });
313        });
314    }
315
316    fn render_search_option(
317        &self,
318        option_supported: bool,
319        icon: &'static str,
320        option: SearchOption,
321        cx: &mut ViewContext<Self>,
322    ) -> Option<AnyElement<Self>> {
323        if !option_supported {
324            return None;
325        }
326
327        let tooltip_style = cx.global::<Settings>().theme.tooltip.clone();
328        let is_active = self.is_search_option_enabled(option);
329        Some(
330            MouseEventHandler::<Self, _>::new(option as usize, cx, |state, cx| {
331                let style = cx
332                    .global::<Settings>()
333                    .theme
334                    .search
335                    .option_button
336                    .style_for(state, is_active);
337                Label::new(icon, style.text.clone())
338                    .contained()
339                    .with_style(style.container)
340            })
341            .on_click(MouseButton::Left, move |_, this, cx| {
342                this.toggle_search_option(option, cx);
343            })
344            .with_cursor_style(CursorStyle::PointingHand)
345            .with_tooltip::<Self>(
346                option as usize,
347                format!("Toggle {}", option.label()),
348                Some(option.to_toggle_action()),
349                tooltip_style,
350                cx,
351            )
352            .into_any(),
353        )
354    }
355
356    fn render_nav_button(
357        &self,
358        icon: &'static str,
359        direction: Direction,
360        cx: &mut ViewContext<Self>,
361    ) -> AnyElement<Self> {
362        let action: Box<dyn Action>;
363        let tooltip;
364        match direction {
365            Direction::Prev => {
366                action = Box::new(SelectPrevMatch);
367                tooltip = "Select Previous Match";
368            }
369            Direction::Next => {
370                action = Box::new(SelectNextMatch);
371                tooltip = "Select Next Match";
372            }
373        };
374        let tooltip_style = cx.global::<Settings>().theme.tooltip.clone();
375
376        enum NavButton {}
377        MouseEventHandler::<NavButton, _>::new(direction as usize, cx, |state, cx| {
378            let style = cx
379                .global::<Settings>()
380                .theme
381                .search
382                .option_button
383                .style_for(state, false);
384            Label::new(icon, style.text.clone())
385                .contained()
386                .with_style(style.container)
387        })
388        .on_click(MouseButton::Left, {
389            move |_, this, cx| match direction {
390                Direction::Prev => this.select_prev_match(&Default::default(), cx),
391                Direction::Next => this.select_next_match(&Default::default(), cx),
392            }
393        })
394        .with_cursor_style(CursorStyle::PointingHand)
395        .with_tooltip::<NavButton>(
396            direction as usize,
397            tooltip.to_string(),
398            Some(action),
399            tooltip_style,
400            cx,
401        )
402        .into_any()
403    }
404
405    fn render_close_button(
406        &self,
407        theme: &theme::Search,
408        cx: &mut ViewContext<Self>,
409    ) -> AnyElement<Self> {
410        let tooltip = "Dismiss Buffer Search";
411        let tooltip_style = cx.global::<Settings>().theme.tooltip.clone();
412
413        enum CloseButton {}
414        MouseEventHandler::<CloseButton, _>::new(0, cx, |state, _| {
415            let style = theme.dismiss_button.style_for(state, false);
416            Svg::new("icons/x_mark_8.svg")
417                .with_color(style.color)
418                .constrained()
419                .with_width(style.icon_width)
420                .aligned()
421                .constrained()
422                .with_width(style.button_width)
423                .contained()
424                .with_style(style.container)
425        })
426        .on_click(MouseButton::Left, move |_, this, cx| {
427            this.dismiss(&Default::default(), cx)
428        })
429        .with_cursor_style(CursorStyle::PointingHand)
430        .with_tooltip::<CloseButton>(
431            0,
432            tooltip.to_string(),
433            Some(Box::new(Dismiss)),
434            tooltip_style,
435            cx,
436        )
437        .into_any()
438    }
439
440    fn deploy(pane: &mut Pane, action: &Deploy, cx: &mut ViewContext<Pane>) {
441        if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
442            if search_bar.update(cx, |search_bar, cx| search_bar.show(action.focus, true, cx)) {
443                return;
444            }
445        }
446        cx.propagate_action();
447    }
448
449    fn handle_editor_cancel(pane: &mut Pane, _: &editor::Cancel, cx: &mut ViewContext<Pane>) {
450        if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
451            if !search_bar.read(cx).dismissed {
452                search_bar.update(cx, |search_bar, cx| search_bar.dismiss(&Dismiss, cx));
453                return;
454            }
455        }
456        cx.propagate_action();
457    }
458
459    fn focus_editor(&mut self, _: &FocusEditor, cx: &mut ViewContext<Self>) {
460        if let Some(active_editor) = self.active_searchable_item.as_ref() {
461            cx.focus(active_editor.as_any());
462        }
463    }
464
465    fn is_search_option_enabled(&self, search_option: SearchOption) -> bool {
466        match search_option {
467            SearchOption::WholeWord => self.whole_word,
468            SearchOption::CaseSensitive => self.case_sensitive,
469            SearchOption::Regex => self.regex,
470        }
471    }
472
473    fn toggle_search_option(&mut self, search_option: SearchOption, cx: &mut ViewContext<Self>) {
474        let value = match search_option {
475            SearchOption::WholeWord => &mut self.whole_word,
476            SearchOption::CaseSensitive => &mut self.case_sensitive,
477            SearchOption::Regex => &mut self.regex,
478        };
479        *value = !*value;
480        self.update_matches(false, cx);
481        cx.notify();
482    }
483
484    fn select_next_match(&mut self, _: &SelectNextMatch, cx: &mut ViewContext<Self>) {
485        self.select_match(Direction::Next, cx);
486    }
487
488    fn select_prev_match(&mut self, _: &SelectPrevMatch, cx: &mut ViewContext<Self>) {
489        self.select_match(Direction::Prev, cx);
490    }
491
492    fn select_match(&mut self, direction: Direction, cx: &mut ViewContext<Self>) {
493        if let Some(index) = self.active_match_index {
494            if let Some(searchable_item) = self.active_searchable_item.as_ref() {
495                if let Some(matches) = self
496                    .seachable_items_with_matches
497                    .get(&searchable_item.downgrade())
498                {
499                    let new_match_index =
500                        searchable_item.match_index_for_direction(matches, index, direction, cx);
501                    searchable_item.update_matches(matches, cx);
502                    searchable_item.activate_match(new_match_index, matches, cx);
503                }
504            }
505        }
506    }
507
508    fn select_next_match_on_pane(
509        pane: &mut Pane,
510        action: &SelectNextMatch,
511        cx: &mut ViewContext<Pane>,
512    ) {
513        if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
514            search_bar.update(cx, |bar, cx| bar.select_next_match(action, cx));
515        }
516    }
517
518    fn select_prev_match_on_pane(
519        pane: &mut Pane,
520        action: &SelectPrevMatch,
521        cx: &mut ViewContext<Pane>,
522    ) {
523        if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
524            search_bar.update(cx, |bar, cx| bar.select_prev_match(action, cx));
525        }
526    }
527
528    fn on_query_editor_event(
529        &mut self,
530        _: ViewHandle<Editor>,
531        event: &editor::Event,
532        cx: &mut ViewContext<Self>,
533    ) {
534        if let editor::Event::BufferEdited { .. } = event {
535            self.query_contains_error = false;
536            self.clear_matches(cx);
537            self.update_matches(true, cx);
538            cx.notify();
539        }
540    }
541
542    fn on_active_searchable_item_event(&mut self, event: SearchEvent, cx: &mut ViewContext<Self>) {
543        match event {
544            SearchEvent::MatchesInvalidated => self.update_matches(false, cx),
545            SearchEvent::ActiveMatchChanged => self.update_match_index(cx),
546        }
547    }
548
549    fn clear_matches(&mut self, cx: &mut ViewContext<Self>) {
550        let mut active_item_matches = None;
551        for (searchable_item, matches) in self.seachable_items_with_matches.drain() {
552            if let Some(searchable_item) =
553                WeakSearchableItemHandle::upgrade(searchable_item.as_ref(), cx)
554            {
555                if Some(&searchable_item) == self.active_searchable_item.as_ref() {
556                    active_item_matches = Some((searchable_item.downgrade(), matches));
557                } else {
558                    searchable_item.clear_matches(cx);
559                }
560            }
561        }
562
563        self.seachable_items_with_matches
564            .extend(active_item_matches);
565    }
566
567    fn update_matches(&mut self, select_closest_match: bool, cx: &mut ViewContext<Self>) {
568        let query = self.query_editor.read(cx).text(cx);
569        self.pending_search.take();
570        if let Some(active_searchable_item) = self.active_searchable_item.as_ref() {
571            if query.is_empty() {
572                self.active_match_index.take();
573                active_searchable_item.clear_matches(cx);
574            } else {
575                let query = if self.regex {
576                    match SearchQuery::regex(query, self.whole_word, self.case_sensitive) {
577                        Ok(query) => query,
578                        Err(_) => {
579                            self.query_contains_error = true;
580                            cx.notify();
581                            return;
582                        }
583                    }
584                } else {
585                    SearchQuery::text(query, self.whole_word, self.case_sensitive)
586                };
587
588                let matches = active_searchable_item.find_matches(query, cx);
589
590                let active_searchable_item = active_searchable_item.downgrade();
591                self.pending_search = Some(cx.spawn(|this, mut cx| async move {
592                    let matches = matches.await;
593                    this.update(&mut cx, |this, cx| {
594                        if let Some(active_searchable_item) =
595                            WeakSearchableItemHandle::upgrade(active_searchable_item.as_ref(), cx)
596                        {
597                            this.seachable_items_with_matches
598                                .insert(active_searchable_item.downgrade(), matches);
599
600                            this.update_match_index(cx);
601                            if !this.dismissed {
602                                let matches = this
603                                    .seachable_items_with_matches
604                                    .get(&active_searchable_item.downgrade())
605                                    .unwrap();
606                                active_searchable_item.update_matches(matches, cx);
607                                if select_closest_match {
608                                    if let Some(match_ix) = this.active_match_index {
609                                        active_searchable_item
610                                            .activate_match(match_ix, matches, cx);
611                                    }
612                                }
613                            }
614                            cx.notify();
615                        }
616                    })
617                    .log_err();
618                }));
619            }
620        }
621    }
622
623    fn update_match_index(&mut self, cx: &mut ViewContext<Self>) {
624        let new_index = self
625            .active_searchable_item
626            .as_ref()
627            .and_then(|searchable_item| {
628                let matches = self
629                    .seachable_items_with_matches
630                    .get(&searchable_item.downgrade())?;
631                searchable_item.active_match_index(matches, cx)
632            });
633        if new_index != self.active_match_index {
634            self.active_match_index = new_index;
635            cx.notify();
636        }
637    }
638}
639
640#[cfg(test)]
641mod tests {
642    use super::*;
643    use editor::{DisplayPoint, Editor};
644    use gpui::{color::Color, test::EmptyView, TestAppContext};
645    use language::Buffer;
646    use std::sync::Arc;
647    use unindent::Unindent as _;
648
649    #[gpui::test]
650    async fn test_search_simple(cx: &mut TestAppContext) {
651        let fonts = cx.font_cache();
652        let mut theme = gpui::fonts::with_font_cache(fonts.clone(), theme::Theme::default);
653        theme.search.match_background = Color::red();
654        cx.update(|cx| {
655            let mut settings = Settings::test(cx);
656            settings.theme = Arc::new(theme);
657            cx.set_global(settings)
658        });
659
660        let buffer = cx.add_model(|cx| {
661            Buffer::new(
662                0,
663                r#"
664                A regular expression (shortened as regex or regexp;[1] also referred to as
665                rational expression[2][3]) is a sequence of characters that specifies a search
666                pattern in text. Usually such patterns are used by string-searching algorithms
667                for "find" or "find and replace" operations on strings, or for input validation.
668                "#
669                .unindent(),
670                cx,
671            )
672        });
673        let (window_id, _root_view) = cx.add_window(|_| EmptyView);
674
675        let editor = cx.add_view(window_id, |cx| Editor::for_buffer(buffer.clone(), None, cx));
676
677        let search_bar = cx.add_view(window_id, |cx| {
678            let mut search_bar = BufferSearchBar::new(cx);
679            search_bar.set_active_pane_item(Some(&editor), cx);
680            search_bar.show(false, true, cx);
681            search_bar
682        });
683
684        // Search for a string that appears with different casing.
685        // By default, search is case-insensitive.
686        search_bar.update(cx, |search_bar, cx| {
687            search_bar.set_query("us", cx);
688        });
689        editor.next_notification(cx).await;
690        editor.update(cx, |editor, cx| {
691            assert_eq!(
692                editor.all_background_highlights(cx),
693                &[
694                    (
695                        DisplayPoint::new(2, 17)..DisplayPoint::new(2, 19),
696                        Color::red(),
697                    ),
698                    (
699                        DisplayPoint::new(2, 43)..DisplayPoint::new(2, 45),
700                        Color::red(),
701                    ),
702                ]
703            );
704        });
705
706        // Switch to a case sensitive search.
707        search_bar.update(cx, |search_bar, cx| {
708            search_bar.toggle_search_option(SearchOption::CaseSensitive, cx);
709        });
710        editor.next_notification(cx).await;
711        editor.update(cx, |editor, cx| {
712            assert_eq!(
713                editor.all_background_highlights(cx),
714                &[(
715                    DisplayPoint::new(2, 43)..DisplayPoint::new(2, 45),
716                    Color::red(),
717                )]
718            );
719        });
720
721        // Search for a string that appears both as a whole word and
722        // within other words. By default, all results are found.
723        search_bar.update(cx, |search_bar, cx| {
724            search_bar.set_query("or", cx);
725        });
726        editor.next_notification(cx).await;
727        editor.update(cx, |editor, cx| {
728            assert_eq!(
729                editor.all_background_highlights(cx),
730                &[
731                    (
732                        DisplayPoint::new(0, 24)..DisplayPoint::new(0, 26),
733                        Color::red(),
734                    ),
735                    (
736                        DisplayPoint::new(0, 41)..DisplayPoint::new(0, 43),
737                        Color::red(),
738                    ),
739                    (
740                        DisplayPoint::new(2, 71)..DisplayPoint::new(2, 73),
741                        Color::red(),
742                    ),
743                    (
744                        DisplayPoint::new(3, 1)..DisplayPoint::new(3, 3),
745                        Color::red(),
746                    ),
747                    (
748                        DisplayPoint::new(3, 11)..DisplayPoint::new(3, 13),
749                        Color::red(),
750                    ),
751                    (
752                        DisplayPoint::new(3, 56)..DisplayPoint::new(3, 58),
753                        Color::red(),
754                    ),
755                    (
756                        DisplayPoint::new(3, 60)..DisplayPoint::new(3, 62),
757                        Color::red(),
758                    ),
759                ]
760            );
761        });
762
763        // Switch to a whole word search.
764        search_bar.update(cx, |search_bar, cx| {
765            search_bar.toggle_search_option(SearchOption::WholeWord, cx);
766        });
767        editor.next_notification(cx).await;
768        editor.update(cx, |editor, cx| {
769            assert_eq!(
770                editor.all_background_highlights(cx),
771                &[
772                    (
773                        DisplayPoint::new(0, 41)..DisplayPoint::new(0, 43),
774                        Color::red(),
775                    ),
776                    (
777                        DisplayPoint::new(3, 11)..DisplayPoint::new(3, 13),
778                        Color::red(),
779                    ),
780                    (
781                        DisplayPoint::new(3, 56)..DisplayPoint::new(3, 58),
782                        Color::red(),
783                    ),
784                ]
785            );
786        });
787
788        editor.update(cx, |editor, cx| {
789            editor.change_selections(None, cx, |s| {
790                s.select_display_ranges([DisplayPoint::new(0, 0)..DisplayPoint::new(0, 0)])
791            });
792        });
793        search_bar.update(cx, |search_bar, cx| {
794            assert_eq!(search_bar.active_match_index, Some(0));
795            search_bar.select_next_match(&SelectNextMatch, cx);
796            assert_eq!(
797                editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
798                [DisplayPoint::new(0, 41)..DisplayPoint::new(0, 43)]
799            );
800        });
801        search_bar.read_with(cx, |search_bar, _| {
802            assert_eq!(search_bar.active_match_index, Some(0));
803        });
804
805        search_bar.update(cx, |search_bar, cx| {
806            search_bar.select_next_match(&SelectNextMatch, cx);
807            assert_eq!(
808                editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
809                [DisplayPoint::new(3, 11)..DisplayPoint::new(3, 13)]
810            );
811        });
812        search_bar.read_with(cx, |search_bar, _| {
813            assert_eq!(search_bar.active_match_index, Some(1));
814        });
815
816        search_bar.update(cx, |search_bar, cx| {
817            search_bar.select_next_match(&SelectNextMatch, cx);
818            assert_eq!(
819                editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
820                [DisplayPoint::new(3, 56)..DisplayPoint::new(3, 58)]
821            );
822        });
823        search_bar.read_with(cx, |search_bar, _| {
824            assert_eq!(search_bar.active_match_index, Some(2));
825        });
826
827        search_bar.update(cx, |search_bar, cx| {
828            search_bar.select_next_match(&SelectNextMatch, cx);
829            assert_eq!(
830                editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
831                [DisplayPoint::new(0, 41)..DisplayPoint::new(0, 43)]
832            );
833        });
834        search_bar.read_with(cx, |search_bar, _| {
835            assert_eq!(search_bar.active_match_index, Some(0));
836        });
837
838        search_bar.update(cx, |search_bar, cx| {
839            search_bar.select_prev_match(&SelectPrevMatch, cx);
840            assert_eq!(
841                editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
842                [DisplayPoint::new(3, 56)..DisplayPoint::new(3, 58)]
843            );
844        });
845        search_bar.read_with(cx, |search_bar, _| {
846            assert_eq!(search_bar.active_match_index, Some(2));
847        });
848
849        search_bar.update(cx, |search_bar, cx| {
850            search_bar.select_prev_match(&SelectPrevMatch, cx);
851            assert_eq!(
852                editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
853                [DisplayPoint::new(3, 11)..DisplayPoint::new(3, 13)]
854            );
855        });
856        search_bar.read_with(cx, |search_bar, _| {
857            assert_eq!(search_bar.active_match_index, Some(1));
858        });
859
860        search_bar.update(cx, |search_bar, cx| {
861            search_bar.select_prev_match(&SelectPrevMatch, cx);
862            assert_eq!(
863                editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
864                [DisplayPoint::new(0, 41)..DisplayPoint::new(0, 43)]
865            );
866        });
867        search_bar.read_with(cx, |search_bar, _| {
868            assert_eq!(search_bar.active_match_index, Some(0));
869        });
870
871        // Park the cursor in between matches and ensure that going to the previous match selects
872        // the closest match to the left.
873        editor.update(cx, |editor, cx| {
874            editor.change_selections(None, cx, |s| {
875                s.select_display_ranges([DisplayPoint::new(1, 0)..DisplayPoint::new(1, 0)])
876            });
877        });
878        search_bar.update(cx, |search_bar, cx| {
879            assert_eq!(search_bar.active_match_index, Some(1));
880            search_bar.select_prev_match(&SelectPrevMatch, cx);
881            assert_eq!(
882                editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
883                [DisplayPoint::new(0, 41)..DisplayPoint::new(0, 43)]
884            );
885        });
886        search_bar.read_with(cx, |search_bar, _| {
887            assert_eq!(search_bar.active_match_index, Some(0));
888        });
889
890        // Park the cursor in between matches and ensure that going to the next match selects the
891        // closest match to the right.
892        editor.update(cx, |editor, cx| {
893            editor.change_selections(None, cx, |s| {
894                s.select_display_ranges([DisplayPoint::new(1, 0)..DisplayPoint::new(1, 0)])
895            });
896        });
897        search_bar.update(cx, |search_bar, cx| {
898            assert_eq!(search_bar.active_match_index, Some(1));
899            search_bar.select_next_match(&SelectNextMatch, cx);
900            assert_eq!(
901                editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
902                [DisplayPoint::new(3, 11)..DisplayPoint::new(3, 13)]
903            );
904        });
905        search_bar.read_with(cx, |search_bar, _| {
906            assert_eq!(search_bar.active_match_index, Some(1));
907        });
908
909        // Park the cursor after the last match and ensure that going to the previous match selects
910        // the last match.
911        editor.update(cx, |editor, cx| {
912            editor.change_selections(None, cx, |s| {
913                s.select_display_ranges([DisplayPoint::new(3, 60)..DisplayPoint::new(3, 60)])
914            });
915        });
916        search_bar.update(cx, |search_bar, cx| {
917            assert_eq!(search_bar.active_match_index, Some(2));
918            search_bar.select_prev_match(&SelectPrevMatch, cx);
919            assert_eq!(
920                editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
921                [DisplayPoint::new(3, 56)..DisplayPoint::new(3, 58)]
922            );
923        });
924        search_bar.read_with(cx, |search_bar, _| {
925            assert_eq!(search_bar.active_match_index, Some(2));
926        });
927
928        // Park the cursor after the last match and ensure that going to the next match selects the
929        // first match.
930        editor.update(cx, |editor, cx| {
931            editor.change_selections(None, cx, |s| {
932                s.select_display_ranges([DisplayPoint::new(3, 60)..DisplayPoint::new(3, 60)])
933            });
934        });
935        search_bar.update(cx, |search_bar, cx| {
936            assert_eq!(search_bar.active_match_index, Some(2));
937            search_bar.select_next_match(&SelectNextMatch, cx);
938            assert_eq!(
939                editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
940                [DisplayPoint::new(0, 41)..DisplayPoint::new(0, 43)]
941            );
942        });
943        search_bar.read_with(cx, |search_bar, _| {
944            assert_eq!(search_bar.active_match_index, Some(0));
945        });
946
947        // Park the cursor before the first match and ensure that going to the previous match
948        // selects the last match.
949        editor.update(cx, |editor, cx| {
950            editor.change_selections(None, cx, |s| {
951                s.select_display_ranges([DisplayPoint::new(0, 0)..DisplayPoint::new(0, 0)])
952            });
953        });
954        search_bar.update(cx, |search_bar, cx| {
955            assert_eq!(search_bar.active_match_index, Some(0));
956            search_bar.select_prev_match(&SelectPrevMatch, cx);
957            assert_eq!(
958                editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
959                [DisplayPoint::new(3, 56)..DisplayPoint::new(3, 58)]
960            );
961        });
962        search_bar.read_with(cx, |search_bar, _| {
963            assert_eq!(search_bar.active_match_index, Some(2));
964        });
965    }
966}