1use crate::{
2 history::SearchHistory,
3 mode::{next_mode, SearchMode, Side},
4 search_bar::{render_nav_button, render_search_mode_button},
5 CycleMode, NextHistoryQuery, PreviousHistoryQuery, ReplaceAll, ReplaceNext, SearchOptions,
6 SelectAllMatches, SelectNextMatch, SelectPrevMatch, ToggleCaseSensitive, ToggleReplace,
7 ToggleWholeWord,
8};
9use collections::HashMap;
10use editor::Editor;
11use futures::channel::oneshot;
12use gpui::{
13 actions, elements::*, impl_actions, Action, AnyViewHandle, AppContext, Entity, Subscription,
14 Task, View, ViewContext, ViewHandle, WindowContext,
15};
16use project::search::SearchQuery;
17use serde::Deserialize;
18use std::{any::Any, sync::Arc};
19
20use util::ResultExt;
21use workspace::{
22 item::ItemHandle,
23 searchable::{Direction, SearchEvent, SearchableItemHandle, WeakSearchableItemHandle},
24 Pane, ToolbarItemLocation, ToolbarItemView,
25};
26
27#[derive(Clone, Deserialize, PartialEq)]
28pub struct Deploy {
29 pub focus: bool,
30}
31
32actions!(buffer_search, [Dismiss, FocusEditor]);
33impl_actions!(buffer_search, [Deploy]);
34
35pub enum Event {
36 UpdateLocation,
37}
38
39pub fn init(cx: &mut AppContext) {
40 cx.add_action(BufferSearchBar::deploy_bar);
41 cx.add_action(BufferSearchBar::dismiss);
42 cx.add_action(BufferSearchBar::focus_editor);
43 cx.add_action(BufferSearchBar::select_next_match);
44 cx.add_action(BufferSearchBar::select_prev_match);
45 cx.add_action(BufferSearchBar::select_all_matches);
46 cx.add_action(BufferSearchBar::select_next_match_on_pane);
47 cx.add_action(BufferSearchBar::select_prev_match_on_pane);
48 cx.add_action(BufferSearchBar::select_all_matches_on_pane);
49 cx.add_action(BufferSearchBar::handle_editor_cancel);
50 cx.add_action(BufferSearchBar::next_history_query);
51 cx.add_action(BufferSearchBar::previous_history_query);
52 cx.add_action(BufferSearchBar::cycle_mode);
53 cx.add_action(BufferSearchBar::cycle_mode_on_pane);
54 cx.add_action(BufferSearchBar::replace_all);
55 cx.add_action(BufferSearchBar::replace_next);
56 cx.add_action(BufferSearchBar::replace_all_on_pane);
57 cx.add_action(BufferSearchBar::replace_next_on_pane);
58 cx.add_action(BufferSearchBar::toggle_replace);
59 cx.add_action(BufferSearchBar::toggle_replace_on_a_pane);
60 add_toggle_option_action::<ToggleCaseSensitive>(SearchOptions::CASE_SENSITIVE, cx);
61 add_toggle_option_action::<ToggleWholeWord>(SearchOptions::WHOLE_WORD, cx);
62}
63
64fn add_toggle_option_action<A: Action>(option: SearchOptions, cx: &mut AppContext) {
65 cx.add_action(move |pane: &mut Pane, _: &A, cx: &mut ViewContext<Pane>| {
66 if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
67 search_bar.update(cx, |search_bar, cx| {
68 if search_bar.show(cx) {
69 search_bar.toggle_search_option(option, cx);
70 }
71 });
72 }
73 cx.propagate_action();
74 });
75}
76
77pub struct BufferSearchBar {
78 query_editor: ViewHandle<Editor>,
79 replacement_editor: ViewHandle<Editor>,
80 active_searchable_item: Option<Box<dyn SearchableItemHandle>>,
81 active_match_index: Option<usize>,
82 active_searchable_item_subscription: Option<Subscription>,
83 active_search: Option<Arc<SearchQuery>>,
84 searchable_items_with_matches:
85 HashMap<Box<dyn WeakSearchableItemHandle>, Vec<Box<dyn Any + Send>>>,
86 pending_search: Option<Task<()>>,
87 search_options: SearchOptions,
88 default_options: SearchOptions,
89 query_contains_error: bool,
90 dismissed: bool,
91 search_history: SearchHistory,
92 current_mode: SearchMode,
93 replace_is_active: bool,
94}
95
96impl Entity for BufferSearchBar {
97 type Event = Event;
98}
99
100impl View for BufferSearchBar {
101 fn ui_name() -> &'static str {
102 "BufferSearchBar"
103 }
104
105 fn update_keymap_context(
106 &self,
107 keymap: &mut gpui::keymap_matcher::KeymapContext,
108 cx: &AppContext,
109 ) {
110 Self::reset_to_default_keymap_context(keymap);
111 let in_replace = self
112 .replacement_editor
113 .read_with(cx, |_, cx| cx.is_self_focused())
114 .unwrap_or(false);
115 if in_replace {
116 keymap.add_identifier("in_replace");
117 }
118 }
119
120 fn focus_in(&mut self, _: AnyViewHandle, cx: &mut ViewContext<Self>) {
121 if cx.is_self_focused() {
122 cx.focus(&self.query_editor);
123 }
124 }
125
126 fn render(&mut self, cx: &mut ViewContext<Self>) -> AnyElement<Self> {
127 let theme = theme::current(cx).clone();
128 let query_container_style = if self.query_contains_error {
129 theme.search.invalid_editor
130 } else {
131 theme.search.editor.input.container
132 };
133 let supported_options = self
134 .active_searchable_item
135 .as_ref()
136 .map(|active_searchable_item| active_searchable_item.supported_options())
137 .unwrap_or_default();
138
139 let previous_query_keystrokes =
140 cx.binding_for_action(&PreviousHistoryQuery {})
141 .map(|binding| {
142 binding
143 .keystrokes()
144 .iter()
145 .map(|k| k.to_string())
146 .collect::<Vec<_>>()
147 });
148 let next_query_keystrokes = cx.binding_for_action(&NextHistoryQuery {}).map(|binding| {
149 binding
150 .keystrokes()
151 .iter()
152 .map(|k| k.to_string())
153 .collect::<Vec<_>>()
154 });
155 let new_placeholder_text = match (previous_query_keystrokes, next_query_keystrokes) {
156 (Some(previous_query_keystrokes), Some(next_query_keystrokes)) => {
157 format!(
158 "Search ({}/{} for previous/next query)",
159 previous_query_keystrokes.join(" "),
160 next_query_keystrokes.join(" ")
161 )
162 }
163 (None, Some(next_query_keystrokes)) => {
164 format!(
165 "Search ({} for next query)",
166 next_query_keystrokes.join(" ")
167 )
168 }
169 (Some(previous_query_keystrokes), None) => {
170 format!(
171 "Search ({} for previous query)",
172 previous_query_keystrokes.join(" ")
173 )
174 }
175 (None, None) => String::new(),
176 };
177 self.query_editor.update(cx, |editor, cx| {
178 editor.set_placeholder_text(new_placeholder_text, cx);
179 });
180 self.replacement_editor.update(cx, |editor, cx| {
181 editor.set_placeholder_text("Replace with...", cx);
182 });
183 let search_button_for_mode = |mode, side, cx: &mut ViewContext<BufferSearchBar>| {
184 let is_active = self.current_mode == mode;
185
186 render_search_mode_button(
187 mode,
188 side,
189 is_active,
190 move |_, this, cx| {
191 this.activate_search_mode(mode, cx);
192 },
193 cx,
194 )
195 };
196 let search_option_button = |option| {
197 let is_active = self.search_options.contains(option);
198 option.as_button(
199 is_active,
200 theme.tooltip.clone(),
201 theme.search.option_button_component.clone(),
202 )
203 };
204 let match_count = self
205 .active_searchable_item
206 .as_ref()
207 .and_then(|searchable_item| {
208 if self.query(cx).is_empty() {
209 return None;
210 }
211 let matches = self
212 .searchable_items_with_matches
213 .get(&searchable_item.downgrade())?;
214 let message = if let Some(match_ix) = self.active_match_index {
215 format!("{}/{}", match_ix + 1, matches.len())
216 } else {
217 "No matches".to_string()
218 };
219
220 Some(
221 Label::new(message, theme.search.match_index.text.clone())
222 .contained()
223 .with_style(theme.search.match_index.container)
224 .aligned(),
225 )
226 });
227 let nav_button_for_direction = |label, direction, cx: &mut ViewContext<Self>| {
228 render_nav_button(
229 label,
230 direction,
231 self.active_match_index.is_some(),
232 move |_, this, cx| match direction {
233 Direction::Prev => this.select_prev_match(&Default::default(), cx),
234 Direction::Next => this.select_next_match(&Default::default(), cx),
235 },
236 cx,
237 )
238 };
239 let query_column = Flex::row()
240 .with_child(
241 Svg::for_style(theme.search.editor_icon.clone().icon)
242 .contained()
243 .with_style(theme.search.editor_icon.clone().container),
244 )
245 .with_child(ChildView::new(&self.query_editor, cx).flex(1., true))
246 .with_child(
247 Flex::row()
248 .with_children(
249 supported_options
250 .case
251 .then(|| search_option_button(SearchOptions::CASE_SENSITIVE)),
252 )
253 .with_children(
254 supported_options
255 .word
256 .then(|| search_option_button(SearchOptions::WHOLE_WORD)),
257 )
258 .flex_float()
259 .contained(),
260 )
261 .align_children_center()
262 .contained()
263 .with_style(query_container_style)
264 .constrained()
265 .with_min_width(theme.search.editor.min_width)
266 .with_max_width(theme.search.editor.max_width)
267 .with_height(theme.search.search_bar_row_height)
268 .flex(1., false);
269 let should_show_replace_input = self.replace_is_active && supported_options.replacement;
270
271 let replacement = should_show_replace_input.then(|| {
272 Flex::row()
273 .with_child(
274 Svg::for_style(theme.search.replace_icon.clone().icon)
275 .contained()
276 .with_style(theme.search.replace_icon.clone().container),
277 )
278 .with_child(ChildView::new(&self.replacement_editor, cx).flex(1., true))
279 .align_children_center()
280 .flex(1., true)
281 .contained()
282 .with_style(query_container_style)
283 .constrained()
284 .with_min_width(theme.search.editor.min_width)
285 .with_max_width(theme.search.editor.max_width)
286 .with_height(theme.search.search_bar_row_height)
287 .flex(1., false)
288 });
289 let replace_all = should_show_replace_input.then(|| {
290 super::replace_action(
291 ReplaceAll,
292 "Replace all",
293 "icons/replace_all.svg",
294 theme.tooltip.clone(),
295 theme.search.action_button.clone(),
296 )
297 });
298 let replace_next = should_show_replace_input.then(|| {
299 super::replace_action(
300 ReplaceNext,
301 "Replace next",
302 "icons/replace_next.svg",
303 theme.tooltip.clone(),
304 theme.search.action_button.clone(),
305 )
306 });
307 let switches_column = supported_options.replacement.then(|| {
308 Flex::row()
309 .align_children_center()
310 .with_child(super::toggle_replace_button(
311 self.replace_is_active,
312 theme.tooltip.clone(),
313 theme.search.option_button_component.clone(),
314 ))
315 .constrained()
316 .with_height(theme.search.search_bar_row_height)
317 .contained()
318 .with_style(theme.search.option_button_group)
319 });
320 let mode_column = Flex::row()
321 .with_child(search_button_for_mode(
322 SearchMode::Text,
323 Some(Side::Left),
324 cx,
325 ))
326 .with_child(search_button_for_mode(
327 SearchMode::Regex,
328 Some(Side::Right),
329 cx,
330 ))
331 .contained()
332 .with_style(theme.search.modes_container)
333 .constrained()
334 .with_height(theme.search.search_bar_row_height);
335
336 let nav_column = Flex::row()
337 .align_children_center()
338 .with_children(replace_next)
339 .with_children(replace_all)
340 .with_child(self.render_action_button("icons/select-all.svg", cx))
341 .with_child(Flex::row().with_children(match_count))
342 .with_child(nav_button_for_direction("<", Direction::Prev, cx))
343 .with_child(nav_button_for_direction(">", Direction::Next, cx))
344 .constrained()
345 .with_height(theme.search.search_bar_row_height)
346 .flex_float();
347
348 Flex::row()
349 .with_child(query_column)
350 .with_children(switches_column)
351 .with_children(replacement)
352 .with_child(mode_column)
353 .with_child(nav_column)
354 .contained()
355 .with_style(theme.search.container)
356 .into_any_named("search bar")
357 }
358}
359
360impl ToolbarItemView for BufferSearchBar {
361 fn set_active_pane_item(
362 &mut self,
363 item: Option<&dyn ItemHandle>,
364 cx: &mut ViewContext<Self>,
365 ) -> ToolbarItemLocation {
366 cx.notify();
367 self.active_searchable_item_subscription.take();
368 self.active_searchable_item.take();
369 self.pending_search.take();
370
371 if let Some(searchable_item_handle) =
372 item.and_then(|item| item.to_searchable_item_handle(cx))
373 {
374 let this = cx.weak_handle();
375 self.active_searchable_item_subscription =
376 Some(searchable_item_handle.subscribe_to_search_events(
377 cx,
378 Box::new(move |search_event, cx| {
379 if let Some(this) = this.upgrade(cx) {
380 this.update(cx, |this, cx| {
381 this.on_active_searchable_item_event(search_event, cx)
382 });
383 }
384 }),
385 ));
386
387 self.active_searchable_item = Some(searchable_item_handle);
388 let _ = self.update_matches(cx);
389 if !self.dismissed {
390 return ToolbarItemLocation::Secondary;
391 }
392 }
393
394 ToolbarItemLocation::Hidden
395 }
396
397 fn location_for_event(
398 &self,
399 _: &Self::Event,
400 _: ToolbarItemLocation,
401 _: &AppContext,
402 ) -> ToolbarItemLocation {
403 if self.active_searchable_item.is_some() && !self.dismissed {
404 ToolbarItemLocation::Secondary
405 } else {
406 ToolbarItemLocation::Hidden
407 }
408 }
409
410 fn row_count(&self, _: &ViewContext<Self>) -> usize {
411 1
412 }
413}
414
415impl BufferSearchBar {
416 pub fn new(cx: &mut ViewContext<Self>) -> Self {
417 let query_editor = cx.add_view(|cx| {
418 Editor::auto_height(
419 2,
420 Some(Arc::new(|theme| theme.search.editor.input.clone())),
421 cx,
422 )
423 });
424 cx.subscribe(&query_editor, Self::on_query_editor_event)
425 .detach();
426 let replacement_editor = cx.add_view(|cx| {
427 Editor::auto_height(
428 2,
429 Some(Arc::new(|theme| theme.search.editor.input.clone())),
430 cx,
431 )
432 });
433 // cx.subscribe(&replacement_editor, Self::on_query_editor_event)
434 // .detach();
435 Self {
436 query_editor,
437 replacement_editor,
438 active_searchable_item: None,
439 active_searchable_item_subscription: None,
440 active_match_index: None,
441 searchable_items_with_matches: Default::default(),
442 default_options: SearchOptions::NONE,
443 search_options: SearchOptions::NONE,
444 pending_search: None,
445 query_contains_error: false,
446 dismissed: true,
447 search_history: SearchHistory::default(),
448 current_mode: SearchMode::default(),
449 active_search: None,
450 replace_is_active: false,
451 }
452 }
453
454 pub fn is_dismissed(&self) -> bool {
455 self.dismissed
456 }
457
458 pub fn dismiss(&mut self, _: &Dismiss, cx: &mut ViewContext<Self>) {
459 self.dismissed = true;
460 for searchable_item in self.searchable_items_with_matches.keys() {
461 if let Some(searchable_item) =
462 WeakSearchableItemHandle::upgrade(searchable_item.as_ref(), cx)
463 {
464 searchable_item.clear_matches(cx);
465 }
466 }
467 if let Some(active_editor) = self.active_searchable_item.as_ref() {
468 cx.focus(active_editor.as_any());
469 }
470 cx.emit(Event::UpdateLocation);
471 cx.notify();
472 }
473
474 pub fn deploy(&mut self, deploy: &Deploy, cx: &mut ViewContext<Self>) -> bool {
475 if self.show(cx) {
476 self.search_suggested(cx);
477 if deploy.focus {
478 self.select_query(cx);
479 cx.focus_self();
480 }
481 return true;
482 }
483
484 false
485 }
486
487 pub fn show(&mut self, cx: &mut ViewContext<Self>) -> bool {
488 if self.active_searchable_item.is_none() {
489 return false;
490 }
491 self.dismissed = false;
492 cx.notify();
493 cx.emit(Event::UpdateLocation);
494 true
495 }
496
497 pub fn search_suggested(&mut self, cx: &mut ViewContext<Self>) {
498 let search = self
499 .query_suggestion(cx)
500 .map(|suggestion| self.search(&suggestion, Some(self.default_options), cx));
501
502 if let Some(search) = search {
503 cx.spawn(|this, mut cx| async move {
504 search.await?;
505 this.update(&mut cx, |this, cx| this.activate_current_match(cx))
506 })
507 .detach_and_log_err(cx);
508 }
509 }
510
511 pub fn activate_current_match(&mut self, cx: &mut ViewContext<Self>) {
512 if let Some(match_ix) = self.active_match_index {
513 if let Some(active_searchable_item) = self.active_searchable_item.as_ref() {
514 if let Some(matches) = self
515 .searchable_items_with_matches
516 .get(&active_searchable_item.downgrade())
517 {
518 active_searchable_item.activate_match(match_ix, matches, cx)
519 }
520 }
521 }
522 }
523
524 pub fn select_query(&mut self, cx: &mut ViewContext<Self>) {
525 self.query_editor.update(cx, |query_editor, cx| {
526 query_editor.select_all(&Default::default(), cx);
527 });
528 }
529
530 pub fn query(&self, cx: &WindowContext) -> String {
531 self.query_editor.read(cx).text(cx)
532 }
533 pub fn replacement(&self, cx: &WindowContext) -> String {
534 self.replacement_editor.read(cx).text(cx)
535 }
536 pub fn query_suggestion(&mut self, cx: &mut ViewContext<Self>) -> Option<String> {
537 self.active_searchable_item
538 .as_ref()
539 .map(|searchable_item| searchable_item.query_suggestion(cx))
540 }
541
542 pub fn search(
543 &mut self,
544 query: &str,
545 options: Option<SearchOptions>,
546 cx: &mut ViewContext<Self>,
547 ) -> oneshot::Receiver<()> {
548 let options = options.unwrap_or(self.default_options);
549 if query != self.query(cx) || self.search_options != options {
550 self.query_editor.update(cx, |query_editor, cx| {
551 query_editor.buffer().update(cx, |query_buffer, cx| {
552 let len = query_buffer.len(cx);
553 query_buffer.edit([(0..len, query)], None, cx);
554 });
555 });
556 self.search_options = options;
557 self.query_contains_error = false;
558 self.clear_matches(cx);
559 cx.notify();
560 }
561 self.update_matches(cx)
562 }
563
564 fn render_action_button(
565 &self,
566 icon: &'static str,
567 cx: &mut ViewContext<Self>,
568 ) -> AnyElement<Self> {
569 let tooltip = "Select All Matches";
570 let tooltip_style = theme::current(cx).tooltip.clone();
571
572 let theme = theme::current(cx);
573 let style = theme.search.action_button.clone();
574
575 gpui::elements::Component::element(SafeStylable::with_style(
576 theme::components::action_button::Button::action(SelectAllMatches)
577 .with_tooltip(tooltip, tooltip_style)
578 .with_contents(theme::components::svg::Svg::new(icon)),
579 style,
580 ))
581 .into_any()
582 }
583
584 pub fn activate_search_mode(&mut self, mode: SearchMode, cx: &mut ViewContext<Self>) {
585 assert_ne!(
586 mode,
587 SearchMode::Semantic,
588 "Semantic search is not supported in buffer search"
589 );
590 if mode == self.current_mode {
591 return;
592 }
593 self.current_mode = mode;
594 let _ = self.update_matches(cx);
595 cx.notify();
596 }
597
598 fn deploy_bar(pane: &mut Pane, action: &Deploy, cx: &mut ViewContext<Pane>) {
599 let mut propagate_action = true;
600 if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
601 search_bar.update(cx, |search_bar, cx| {
602 if search_bar.deploy(action, cx) {
603 propagate_action = false;
604 }
605 });
606 }
607 if propagate_action {
608 cx.propagate_action();
609 }
610 }
611
612 fn handle_editor_cancel(pane: &mut Pane, _: &editor::Cancel, cx: &mut ViewContext<Pane>) {
613 if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
614 if !search_bar.read(cx).dismissed {
615 search_bar.update(cx, |search_bar, cx| search_bar.dismiss(&Dismiss, cx));
616 return;
617 }
618 }
619 cx.propagate_action();
620 }
621
622 pub fn focus_editor(&mut self, _: &FocusEditor, cx: &mut ViewContext<Self>) {
623 if let Some(active_editor) = self.active_searchable_item.as_ref() {
624 cx.focus(active_editor.as_any());
625 }
626 }
627
628 fn toggle_search_option(&mut self, search_option: SearchOptions, cx: &mut ViewContext<Self>) {
629 self.search_options.toggle(search_option);
630 self.default_options = self.search_options;
631 let _ = self.update_matches(cx);
632 cx.notify();
633 }
634
635 pub fn set_search_options(
636 &mut self,
637 search_options: SearchOptions,
638 cx: &mut ViewContext<Self>,
639 ) {
640 self.search_options = search_options;
641 cx.notify();
642 }
643
644 fn select_next_match(&mut self, _: &SelectNextMatch, cx: &mut ViewContext<Self>) {
645 self.select_match(Direction::Next, 1, cx);
646 }
647
648 fn select_prev_match(&mut self, _: &SelectPrevMatch, cx: &mut ViewContext<Self>) {
649 self.select_match(Direction::Prev, 1, cx);
650 }
651
652 fn select_all_matches(&mut self, _: &SelectAllMatches, cx: &mut ViewContext<Self>) {
653 if !self.dismissed && self.active_match_index.is_some() {
654 if let Some(searchable_item) = self.active_searchable_item.as_ref() {
655 if let Some(matches) = self
656 .searchable_items_with_matches
657 .get(&searchable_item.downgrade())
658 {
659 searchable_item.select_matches(matches, cx);
660 self.focus_editor(&FocusEditor, cx);
661 }
662 }
663 }
664 }
665
666 pub fn select_match(&mut self, direction: Direction, count: usize, cx: &mut ViewContext<Self>) {
667 if let Some(index) = self.active_match_index {
668 if let Some(searchable_item) = self.active_searchable_item.as_ref() {
669 if let Some(matches) = self
670 .searchable_items_with_matches
671 .get(&searchable_item.downgrade())
672 {
673 let new_match_index = searchable_item
674 .match_index_for_direction(matches, index, direction, count, cx);
675 searchable_item.update_matches(matches, cx);
676 searchable_item.activate_match(new_match_index, matches, cx);
677 }
678 }
679 }
680 }
681
682 fn select_next_match_on_pane(
683 pane: &mut Pane,
684 action: &SelectNextMatch,
685 cx: &mut ViewContext<Pane>,
686 ) {
687 if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
688 search_bar.update(cx, |bar, cx| bar.select_next_match(action, cx));
689 }
690 }
691
692 fn select_prev_match_on_pane(
693 pane: &mut Pane,
694 action: &SelectPrevMatch,
695 cx: &mut ViewContext<Pane>,
696 ) {
697 if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
698 search_bar.update(cx, |bar, cx| bar.select_prev_match(action, cx));
699 }
700 }
701
702 fn select_all_matches_on_pane(
703 pane: &mut Pane,
704 action: &SelectAllMatches,
705 cx: &mut ViewContext<Pane>,
706 ) {
707 if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
708 search_bar.update(cx, |bar, cx| bar.select_all_matches(action, cx));
709 }
710 }
711
712 fn on_query_editor_event(
713 &mut self,
714 _: ViewHandle<Editor>,
715 event: &editor::Event,
716 cx: &mut ViewContext<Self>,
717 ) {
718 if let editor::Event::Edited { .. } = event {
719 self.query_contains_error = false;
720 self.clear_matches(cx);
721 let search = self.update_matches(cx);
722 cx.spawn(|this, mut cx| async move {
723 search.await?;
724 this.update(&mut cx, |this, cx| this.activate_current_match(cx))
725 })
726 .detach_and_log_err(cx);
727 }
728 }
729
730 fn on_active_searchable_item_event(&mut self, event: SearchEvent, cx: &mut ViewContext<Self>) {
731 match event {
732 SearchEvent::MatchesInvalidated => {
733 let _ = self.update_matches(cx);
734 }
735 SearchEvent::ActiveMatchChanged => self.update_match_index(cx),
736 }
737 }
738
739 fn clear_matches(&mut self, cx: &mut ViewContext<Self>) {
740 let mut active_item_matches = None;
741 for (searchable_item, matches) in self.searchable_items_with_matches.drain() {
742 if let Some(searchable_item) =
743 WeakSearchableItemHandle::upgrade(searchable_item.as_ref(), cx)
744 {
745 if Some(&searchable_item) == self.active_searchable_item.as_ref() {
746 active_item_matches = Some((searchable_item.downgrade(), matches));
747 } else {
748 searchable_item.clear_matches(cx);
749 }
750 }
751 }
752
753 self.searchable_items_with_matches
754 .extend(active_item_matches);
755 }
756
757 fn update_matches(&mut self, cx: &mut ViewContext<Self>) -> oneshot::Receiver<()> {
758 let (done_tx, done_rx) = oneshot::channel();
759 let query = self.query(cx);
760 self.pending_search.take();
761
762 if let Some(active_searchable_item) = self.active_searchable_item.as_ref() {
763 if query.is_empty() {
764 self.active_match_index.take();
765 active_searchable_item.clear_matches(cx);
766 let _ = done_tx.send(());
767 cx.notify();
768 } else {
769 let query: Arc<_> = if self.current_mode == SearchMode::Regex {
770 match SearchQuery::regex(
771 query,
772 self.search_options.contains(SearchOptions::WHOLE_WORD),
773 self.search_options.contains(SearchOptions::CASE_SENSITIVE),
774 Vec::new(),
775 Vec::new(),
776 ) {
777 Ok(query) => query
778 .with_replacement(Some(self.replacement(cx)).filter(|s| !s.is_empty())),
779 Err(_) => {
780 self.query_contains_error = true;
781 cx.notify();
782 return done_rx;
783 }
784 }
785 } else {
786 SearchQuery::text(
787 query,
788 self.search_options.contains(SearchOptions::WHOLE_WORD),
789 self.search_options.contains(SearchOptions::CASE_SENSITIVE),
790 Vec::new(),
791 Vec::new(),
792 )
793 .with_replacement(Some(self.replacement(cx)).filter(|s| !s.is_empty()))
794 }
795 .into();
796 self.active_search = Some(query.clone());
797 let query_text = query.as_str().to_string();
798 let matches = active_searchable_item.find_matches(query, cx);
799
800 let active_searchable_item = active_searchable_item.downgrade();
801 self.pending_search = Some(cx.spawn(|this, mut cx| async move {
802 let matches = matches.await;
803 this.update(&mut cx, |this, cx| {
804 if let Some(active_searchable_item) =
805 WeakSearchableItemHandle::upgrade(active_searchable_item.as_ref(), cx)
806 {
807 this.searchable_items_with_matches
808 .insert(active_searchable_item.downgrade(), matches);
809
810 this.update_match_index(cx);
811 this.search_history.add(query_text);
812 if !this.dismissed {
813 let matches = this
814 .searchable_items_with_matches
815 .get(&active_searchable_item.downgrade())
816 .unwrap();
817 active_searchable_item.update_matches(matches, cx);
818 let _ = done_tx.send(());
819 }
820 cx.notify();
821 }
822 })
823 .log_err();
824 }));
825 }
826 }
827 done_rx
828 }
829
830 fn update_match_index(&mut self, cx: &mut ViewContext<Self>) {
831 let new_index = self
832 .active_searchable_item
833 .as_ref()
834 .and_then(|searchable_item| {
835 let matches = self
836 .searchable_items_with_matches
837 .get(&searchable_item.downgrade())?;
838 searchable_item.active_match_index(matches, cx)
839 });
840 if new_index != self.active_match_index {
841 self.active_match_index = new_index;
842 cx.notify();
843 }
844 }
845
846 fn next_history_query(&mut self, _: &NextHistoryQuery, cx: &mut ViewContext<Self>) {
847 if let Some(new_query) = self.search_history.next().map(str::to_string) {
848 let _ = self.search(&new_query, Some(self.search_options), cx);
849 } else {
850 self.search_history.reset_selection();
851 let _ = self.search("", Some(self.search_options), cx);
852 }
853 }
854
855 fn previous_history_query(&mut self, _: &PreviousHistoryQuery, cx: &mut ViewContext<Self>) {
856 if self.query(cx).is_empty() {
857 if let Some(new_query) = self.search_history.current().map(str::to_string) {
858 let _ = self.search(&new_query, Some(self.search_options), cx);
859 return;
860 }
861 }
862
863 if let Some(new_query) = self.search_history.previous().map(str::to_string) {
864 let _ = self.search(&new_query, Some(self.search_options), cx);
865 }
866 }
867 fn cycle_mode(&mut self, _: &CycleMode, cx: &mut ViewContext<Self>) {
868 self.activate_search_mode(next_mode(&self.current_mode, false), cx);
869 }
870 fn cycle_mode_on_pane(pane: &mut Pane, action: &CycleMode, cx: &mut ViewContext<Pane>) {
871 let mut should_propagate = true;
872 if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
873 search_bar.update(cx, |bar, cx| {
874 if bar.show(cx) {
875 should_propagate = false;
876 bar.cycle_mode(action, cx);
877 false
878 } else {
879 true
880 }
881 });
882 }
883 if should_propagate {
884 cx.propagate_action();
885 }
886 }
887 fn toggle_replace(&mut self, _: &ToggleReplace, cx: &mut ViewContext<Self>) {
888 if let Some(_) = &self.active_searchable_item {
889 self.replace_is_active = !self.replace_is_active;
890 cx.notify();
891 }
892 }
893 fn toggle_replace_on_a_pane(pane: &mut Pane, _: &ToggleReplace, cx: &mut ViewContext<Pane>) {
894 let mut should_propagate = true;
895 if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
896 search_bar.update(cx, |bar, cx| {
897 if let Some(_) = &bar.active_searchable_item {
898 should_propagate = false;
899 bar.replace_is_active = !bar.replace_is_active;
900 cx.notify();
901 }
902 });
903 }
904 if should_propagate {
905 cx.propagate_action();
906 }
907 }
908 fn replace_next(&mut self, _: &ReplaceNext, cx: &mut ViewContext<Self>) {
909 if !self.dismissed && self.active_search.is_some() {
910 if let Some(searchable_item) = self.active_searchable_item.as_ref() {
911 if let Some(query) = self.active_search.as_ref() {
912 if let Some(matches) = self
913 .searchable_items_with_matches
914 .get(&searchable_item.downgrade())
915 {
916 if let Some(active_index) = self.active_match_index {
917 let query = query.as_ref().clone().with_replacement(
918 Some(self.replacement(cx)).filter(|rep| !rep.is_empty()),
919 );
920 searchable_item.replace(&matches[active_index], &query, cx);
921 }
922
923 self.focus_editor(&FocusEditor, cx);
924 }
925 }
926 }
927 }
928 }
929 fn replace_all(&mut self, _: &ReplaceAll, cx: &mut ViewContext<Self>) {
930 if !self.dismissed && self.active_search.is_some() {
931 if let Some(searchable_item) = self.active_searchable_item.as_ref() {
932 if let Some(query) = self.active_search.as_ref() {
933 if let Some(matches) = self
934 .searchable_items_with_matches
935 .get(&searchable_item.downgrade())
936 {
937 let query = query.as_ref().clone().with_replacement(
938 Some(self.replacement(cx)).filter(|rep| !rep.is_empty()),
939 );
940 for m in matches {
941 searchable_item.replace(m, &query, cx);
942 }
943
944 self.focus_editor(&FocusEditor, cx);
945 }
946 }
947 }
948 }
949 }
950 fn replace_next_on_pane(pane: &mut Pane, action: &ReplaceNext, cx: &mut ViewContext<Pane>) {
951 if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
952 search_bar.update(cx, |bar, cx| bar.replace_next(action, cx));
953 return;
954 }
955 cx.propagate_action();
956 }
957 fn replace_all_on_pane(pane: &mut Pane, action: &ReplaceAll, cx: &mut ViewContext<Pane>) {
958 if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
959 search_bar.update(cx, |bar, cx| bar.replace_all(action, cx));
960 return;
961 }
962 cx.propagate_action();
963 }
964}
965
966#[cfg(test)]
967mod tests {
968 use super::*;
969 use editor::{DisplayPoint, Editor};
970 use gpui::{color::Color, test::EmptyView, TestAppContext};
971 use language::Buffer;
972 use unindent::Unindent as _;
973
974 fn init_test(cx: &mut TestAppContext) -> (ViewHandle<Editor>, ViewHandle<BufferSearchBar>) {
975 crate::project_search::tests::init_test(cx);
976
977 let buffer = cx.add_model(|cx| {
978 Buffer::new(
979 0,
980 cx.model_id() as u64,
981 r#"
982 A regular expression (shortened as regex or regexp;[1] also referred to as
983 rational expression[2][3]) is a sequence of characters that specifies a search
984 pattern in text. Usually such patterns are used by string-searching algorithms
985 for "find" or "find and replace" operations on strings, or for input validation.
986 "#
987 .unindent(),
988 )
989 });
990 let window = cx.add_window(|_| EmptyView);
991 let editor = window.add_view(cx, |cx| Editor::for_buffer(buffer.clone(), None, cx));
992
993 let search_bar = window.add_view(cx, |cx| {
994 let mut search_bar = BufferSearchBar::new(cx);
995 search_bar.set_active_pane_item(Some(&editor), cx);
996 search_bar.show(cx);
997 search_bar
998 });
999
1000 (editor, search_bar)
1001 }
1002
1003 #[gpui::test]
1004 async fn test_search_simple(cx: &mut TestAppContext) {
1005 let (editor, search_bar) = init_test(cx);
1006
1007 // Search for a string that appears with different casing.
1008 // By default, search is case-insensitive.
1009 search_bar
1010 .update(cx, |search_bar, cx| search_bar.search("us", None, cx))
1011 .await
1012 .unwrap();
1013 editor.update(cx, |editor, cx| {
1014 assert_eq!(
1015 editor.all_text_background_highlights(cx),
1016 &[
1017 (
1018 DisplayPoint::new(2, 17)..DisplayPoint::new(2, 19),
1019 Color::red(),
1020 ),
1021 (
1022 DisplayPoint::new(2, 43)..DisplayPoint::new(2, 45),
1023 Color::red(),
1024 ),
1025 ]
1026 );
1027 });
1028
1029 // Switch to a case sensitive search.
1030 search_bar.update(cx, |search_bar, cx| {
1031 search_bar.toggle_search_option(SearchOptions::CASE_SENSITIVE, cx);
1032 });
1033 editor.next_notification(cx).await;
1034 editor.update(cx, |editor, cx| {
1035 assert_eq!(
1036 editor.all_text_background_highlights(cx),
1037 &[(
1038 DisplayPoint::new(2, 43)..DisplayPoint::new(2, 45),
1039 Color::red(),
1040 )]
1041 );
1042 });
1043
1044 // Search for a string that appears both as a whole word and
1045 // within other words. By default, all results are found.
1046 search_bar
1047 .update(cx, |search_bar, cx| search_bar.search("or", None, cx))
1048 .await
1049 .unwrap();
1050 editor.update(cx, |editor, cx| {
1051 assert_eq!(
1052 editor.all_text_background_highlights(cx),
1053 &[
1054 (
1055 DisplayPoint::new(0, 24)..DisplayPoint::new(0, 26),
1056 Color::red(),
1057 ),
1058 (
1059 DisplayPoint::new(0, 41)..DisplayPoint::new(0, 43),
1060 Color::red(),
1061 ),
1062 (
1063 DisplayPoint::new(2, 71)..DisplayPoint::new(2, 73),
1064 Color::red(),
1065 ),
1066 (
1067 DisplayPoint::new(3, 1)..DisplayPoint::new(3, 3),
1068 Color::red(),
1069 ),
1070 (
1071 DisplayPoint::new(3, 11)..DisplayPoint::new(3, 13),
1072 Color::red(),
1073 ),
1074 (
1075 DisplayPoint::new(3, 56)..DisplayPoint::new(3, 58),
1076 Color::red(),
1077 ),
1078 (
1079 DisplayPoint::new(3, 60)..DisplayPoint::new(3, 62),
1080 Color::red(),
1081 ),
1082 ]
1083 );
1084 });
1085
1086 // Switch to a whole word search.
1087 search_bar.update(cx, |search_bar, cx| {
1088 search_bar.toggle_search_option(SearchOptions::WHOLE_WORD, cx);
1089 });
1090 editor.next_notification(cx).await;
1091 editor.update(cx, |editor, cx| {
1092 assert_eq!(
1093 editor.all_text_background_highlights(cx),
1094 &[
1095 (
1096 DisplayPoint::new(0, 41)..DisplayPoint::new(0, 43),
1097 Color::red(),
1098 ),
1099 (
1100 DisplayPoint::new(3, 11)..DisplayPoint::new(3, 13),
1101 Color::red(),
1102 ),
1103 (
1104 DisplayPoint::new(3, 56)..DisplayPoint::new(3, 58),
1105 Color::red(),
1106 ),
1107 ]
1108 );
1109 });
1110
1111 editor.update(cx, |editor, cx| {
1112 editor.change_selections(None, cx, |s| {
1113 s.select_display_ranges([DisplayPoint::new(0, 0)..DisplayPoint::new(0, 0)])
1114 });
1115 });
1116 search_bar.update(cx, |search_bar, cx| {
1117 assert_eq!(search_bar.active_match_index, Some(0));
1118 search_bar.select_next_match(&SelectNextMatch, cx);
1119 assert_eq!(
1120 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1121 [DisplayPoint::new(0, 41)..DisplayPoint::new(0, 43)]
1122 );
1123 });
1124 search_bar.read_with(cx, |search_bar, _| {
1125 assert_eq!(search_bar.active_match_index, Some(0));
1126 });
1127
1128 search_bar.update(cx, |search_bar, cx| {
1129 search_bar.select_next_match(&SelectNextMatch, cx);
1130 assert_eq!(
1131 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1132 [DisplayPoint::new(3, 11)..DisplayPoint::new(3, 13)]
1133 );
1134 });
1135 search_bar.read_with(cx, |search_bar, _| {
1136 assert_eq!(search_bar.active_match_index, Some(1));
1137 });
1138
1139 search_bar.update(cx, |search_bar, cx| {
1140 search_bar.select_next_match(&SelectNextMatch, cx);
1141 assert_eq!(
1142 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1143 [DisplayPoint::new(3, 56)..DisplayPoint::new(3, 58)]
1144 );
1145 });
1146 search_bar.read_with(cx, |search_bar, _| {
1147 assert_eq!(search_bar.active_match_index, Some(2));
1148 });
1149
1150 search_bar.update(cx, |search_bar, cx| {
1151 search_bar.select_next_match(&SelectNextMatch, cx);
1152 assert_eq!(
1153 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1154 [DisplayPoint::new(0, 41)..DisplayPoint::new(0, 43)]
1155 );
1156 });
1157 search_bar.read_with(cx, |search_bar, _| {
1158 assert_eq!(search_bar.active_match_index, Some(0));
1159 });
1160
1161 search_bar.update(cx, |search_bar, cx| {
1162 search_bar.select_prev_match(&SelectPrevMatch, cx);
1163 assert_eq!(
1164 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1165 [DisplayPoint::new(3, 56)..DisplayPoint::new(3, 58)]
1166 );
1167 });
1168 search_bar.read_with(cx, |search_bar, _| {
1169 assert_eq!(search_bar.active_match_index, Some(2));
1170 });
1171
1172 search_bar.update(cx, |search_bar, cx| {
1173 search_bar.select_prev_match(&SelectPrevMatch, cx);
1174 assert_eq!(
1175 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1176 [DisplayPoint::new(3, 11)..DisplayPoint::new(3, 13)]
1177 );
1178 });
1179 search_bar.read_with(cx, |search_bar, _| {
1180 assert_eq!(search_bar.active_match_index, Some(1));
1181 });
1182
1183 search_bar.update(cx, |search_bar, cx| {
1184 search_bar.select_prev_match(&SelectPrevMatch, cx);
1185 assert_eq!(
1186 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1187 [DisplayPoint::new(0, 41)..DisplayPoint::new(0, 43)]
1188 );
1189 });
1190 search_bar.read_with(cx, |search_bar, _| {
1191 assert_eq!(search_bar.active_match_index, Some(0));
1192 });
1193
1194 // Park the cursor in between matches and ensure that going to the previous match selects
1195 // the closest match to the left.
1196 editor.update(cx, |editor, cx| {
1197 editor.change_selections(None, cx, |s| {
1198 s.select_display_ranges([DisplayPoint::new(1, 0)..DisplayPoint::new(1, 0)])
1199 });
1200 });
1201 search_bar.update(cx, |search_bar, cx| {
1202 assert_eq!(search_bar.active_match_index, Some(1));
1203 search_bar.select_prev_match(&SelectPrevMatch, cx);
1204 assert_eq!(
1205 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1206 [DisplayPoint::new(0, 41)..DisplayPoint::new(0, 43)]
1207 );
1208 });
1209 search_bar.read_with(cx, |search_bar, _| {
1210 assert_eq!(search_bar.active_match_index, Some(0));
1211 });
1212
1213 // Park the cursor in between matches and ensure that going to the next match selects the
1214 // closest match to the right.
1215 editor.update(cx, |editor, cx| {
1216 editor.change_selections(None, cx, |s| {
1217 s.select_display_ranges([DisplayPoint::new(1, 0)..DisplayPoint::new(1, 0)])
1218 });
1219 });
1220 search_bar.update(cx, |search_bar, cx| {
1221 assert_eq!(search_bar.active_match_index, Some(1));
1222 search_bar.select_next_match(&SelectNextMatch, cx);
1223 assert_eq!(
1224 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1225 [DisplayPoint::new(3, 11)..DisplayPoint::new(3, 13)]
1226 );
1227 });
1228 search_bar.read_with(cx, |search_bar, _| {
1229 assert_eq!(search_bar.active_match_index, Some(1));
1230 });
1231
1232 // Park the cursor after the last match and ensure that going to the previous match selects
1233 // the last match.
1234 editor.update(cx, |editor, cx| {
1235 editor.change_selections(None, cx, |s| {
1236 s.select_display_ranges([DisplayPoint::new(3, 60)..DisplayPoint::new(3, 60)])
1237 });
1238 });
1239 search_bar.update(cx, |search_bar, cx| {
1240 assert_eq!(search_bar.active_match_index, Some(2));
1241 search_bar.select_prev_match(&SelectPrevMatch, cx);
1242 assert_eq!(
1243 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1244 [DisplayPoint::new(3, 56)..DisplayPoint::new(3, 58)]
1245 );
1246 });
1247 search_bar.read_with(cx, |search_bar, _| {
1248 assert_eq!(search_bar.active_match_index, Some(2));
1249 });
1250
1251 // Park the cursor after the last match and ensure that going to the next match selects the
1252 // first match.
1253 editor.update(cx, |editor, cx| {
1254 editor.change_selections(None, cx, |s| {
1255 s.select_display_ranges([DisplayPoint::new(3, 60)..DisplayPoint::new(3, 60)])
1256 });
1257 });
1258 search_bar.update(cx, |search_bar, cx| {
1259 assert_eq!(search_bar.active_match_index, Some(2));
1260 search_bar.select_next_match(&SelectNextMatch, cx);
1261 assert_eq!(
1262 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1263 [DisplayPoint::new(0, 41)..DisplayPoint::new(0, 43)]
1264 );
1265 });
1266 search_bar.read_with(cx, |search_bar, _| {
1267 assert_eq!(search_bar.active_match_index, Some(0));
1268 });
1269
1270 // Park the cursor before the first match and ensure that going to the previous match
1271 // selects the last match.
1272 editor.update(cx, |editor, cx| {
1273 editor.change_selections(None, cx, |s| {
1274 s.select_display_ranges([DisplayPoint::new(0, 0)..DisplayPoint::new(0, 0)])
1275 });
1276 });
1277 search_bar.update(cx, |search_bar, cx| {
1278 assert_eq!(search_bar.active_match_index, Some(0));
1279 search_bar.select_prev_match(&SelectPrevMatch, cx);
1280 assert_eq!(
1281 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1282 [DisplayPoint::new(3, 56)..DisplayPoint::new(3, 58)]
1283 );
1284 });
1285 search_bar.read_with(cx, |search_bar, _| {
1286 assert_eq!(search_bar.active_match_index, Some(2));
1287 });
1288 }
1289
1290 #[gpui::test]
1291 async fn test_search_option_handling(cx: &mut TestAppContext) {
1292 let (editor, search_bar) = init_test(cx);
1293
1294 // show with options should make current search case sensitive
1295 search_bar
1296 .update(cx, |search_bar, cx| {
1297 search_bar.show(cx);
1298 search_bar.search("us", Some(SearchOptions::CASE_SENSITIVE), cx)
1299 })
1300 .await
1301 .unwrap();
1302 editor.update(cx, |editor, cx| {
1303 assert_eq!(
1304 editor.all_text_background_highlights(cx),
1305 &[(
1306 DisplayPoint::new(2, 43)..DisplayPoint::new(2, 45),
1307 Color::red(),
1308 )]
1309 );
1310 });
1311
1312 // search_suggested should restore default options
1313 search_bar.update(cx, |search_bar, cx| {
1314 search_bar.search_suggested(cx);
1315 assert_eq!(search_bar.search_options, SearchOptions::NONE)
1316 });
1317
1318 // toggling a search option should update the defaults
1319 search_bar
1320 .update(cx, |search_bar, cx| {
1321 search_bar.search("regex", Some(SearchOptions::CASE_SENSITIVE), cx)
1322 })
1323 .await
1324 .unwrap();
1325 search_bar.update(cx, |search_bar, cx| {
1326 search_bar.toggle_search_option(SearchOptions::WHOLE_WORD, cx)
1327 });
1328 editor.next_notification(cx).await;
1329 editor.update(cx, |editor, cx| {
1330 assert_eq!(
1331 editor.all_text_background_highlights(cx),
1332 &[(
1333 DisplayPoint::new(0, 35)..DisplayPoint::new(0, 40),
1334 Color::red(),
1335 ),]
1336 );
1337 });
1338
1339 // defaults should still include whole word
1340 search_bar.update(cx, |search_bar, cx| {
1341 search_bar.search_suggested(cx);
1342 assert_eq!(
1343 search_bar.search_options,
1344 SearchOptions::CASE_SENSITIVE | SearchOptions::WHOLE_WORD
1345 )
1346 });
1347 }
1348
1349 #[gpui::test]
1350 async fn test_search_select_all_matches(cx: &mut TestAppContext) {
1351 crate::project_search::tests::init_test(cx);
1352
1353 let buffer_text = r#"
1354 A regular expression (shortened as regex or regexp;[1] also referred to as
1355 rational expression[2][3]) is a sequence of characters that specifies a search
1356 pattern in text. Usually such patterns are used by string-searching algorithms
1357 for "find" or "find and replace" operations on strings, or for input validation.
1358 "#
1359 .unindent();
1360 let expected_query_matches_count = buffer_text
1361 .chars()
1362 .filter(|c| c.to_ascii_lowercase() == 'a')
1363 .count();
1364 assert!(
1365 expected_query_matches_count > 1,
1366 "Should pick a query with multiple results"
1367 );
1368 let buffer = cx.add_model(|cx| Buffer::new(0, cx.model_id() as u64, buffer_text));
1369 let window = cx.add_window(|_| EmptyView);
1370 let editor = window.add_view(cx, |cx| Editor::for_buffer(buffer.clone(), None, cx));
1371
1372 let search_bar = window.add_view(cx, |cx| {
1373 let mut search_bar = BufferSearchBar::new(cx);
1374 search_bar.set_active_pane_item(Some(&editor), cx);
1375 search_bar.show(cx);
1376 search_bar
1377 });
1378
1379 search_bar
1380 .update(cx, |search_bar, cx| search_bar.search("a", None, cx))
1381 .await
1382 .unwrap();
1383 search_bar.update(cx, |search_bar, cx| {
1384 cx.focus(search_bar.query_editor.as_any());
1385 search_bar.activate_current_match(cx);
1386 });
1387
1388 window.read_with(cx, |cx| {
1389 assert!(
1390 !editor.is_focused(cx),
1391 "Initially, the editor should not be focused"
1392 );
1393 });
1394
1395 let initial_selections = editor.update(cx, |editor, cx| {
1396 let initial_selections = editor.selections.display_ranges(cx);
1397 assert_eq!(
1398 initial_selections.len(), 1,
1399 "Expected to have only one selection before adding carets to all matches, but got: {initial_selections:?}",
1400 );
1401 initial_selections
1402 });
1403 search_bar.update(cx, |search_bar, _| {
1404 assert_eq!(search_bar.active_match_index, Some(0));
1405 });
1406
1407 search_bar.update(cx, |search_bar, cx| {
1408 cx.focus(search_bar.query_editor.as_any());
1409 search_bar.select_all_matches(&SelectAllMatches, cx);
1410 });
1411 window.read_with(cx, |cx| {
1412 assert!(
1413 editor.is_focused(cx),
1414 "Should focus editor after successful SelectAllMatches"
1415 );
1416 });
1417 search_bar.update(cx, |search_bar, cx| {
1418 let all_selections =
1419 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx));
1420 assert_eq!(
1421 all_selections.len(),
1422 expected_query_matches_count,
1423 "Should select all `a` characters in the buffer, but got: {all_selections:?}"
1424 );
1425 assert_eq!(
1426 search_bar.active_match_index,
1427 Some(0),
1428 "Match index should not change after selecting all matches"
1429 );
1430 });
1431
1432 search_bar.update(cx, |search_bar, cx| {
1433 search_bar.select_next_match(&SelectNextMatch, cx);
1434 });
1435 window.read_with(cx, |cx| {
1436 assert!(
1437 editor.is_focused(cx),
1438 "Should still have editor focused after SelectNextMatch"
1439 );
1440 });
1441 search_bar.update(cx, |search_bar, cx| {
1442 let all_selections =
1443 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx));
1444 assert_eq!(
1445 all_selections.len(),
1446 1,
1447 "On next match, should deselect items and select the next match"
1448 );
1449 assert_ne!(
1450 all_selections, initial_selections,
1451 "Next match should be different from the first selection"
1452 );
1453 assert_eq!(
1454 search_bar.active_match_index,
1455 Some(1),
1456 "Match index should be updated to the next one"
1457 );
1458 });
1459
1460 search_bar.update(cx, |search_bar, cx| {
1461 cx.focus(search_bar.query_editor.as_any());
1462 search_bar.select_all_matches(&SelectAllMatches, cx);
1463 });
1464 window.read_with(cx, |cx| {
1465 assert!(
1466 editor.is_focused(cx),
1467 "Should focus editor after successful SelectAllMatches"
1468 );
1469 });
1470 search_bar.update(cx, |search_bar, cx| {
1471 let all_selections =
1472 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx));
1473 assert_eq!(
1474 all_selections.len(),
1475 expected_query_matches_count,
1476 "Should select all `a` characters in the buffer, but got: {all_selections:?}"
1477 );
1478 assert_eq!(
1479 search_bar.active_match_index,
1480 Some(1),
1481 "Match index should not change after selecting all matches"
1482 );
1483 });
1484
1485 search_bar.update(cx, |search_bar, cx| {
1486 search_bar.select_prev_match(&SelectPrevMatch, cx);
1487 });
1488 window.read_with(cx, |cx| {
1489 assert!(
1490 editor.is_focused(cx),
1491 "Should still have editor focused after SelectPrevMatch"
1492 );
1493 });
1494 let last_match_selections = search_bar.update(cx, |search_bar, cx| {
1495 let all_selections =
1496 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx));
1497 assert_eq!(
1498 all_selections.len(),
1499 1,
1500 "On previous match, should deselect items and select the previous item"
1501 );
1502 assert_eq!(
1503 all_selections, initial_selections,
1504 "Previous match should be the same as the first selection"
1505 );
1506 assert_eq!(
1507 search_bar.active_match_index,
1508 Some(0),
1509 "Match index should be updated to the previous one"
1510 );
1511 all_selections
1512 });
1513
1514 search_bar
1515 .update(cx, |search_bar, cx| {
1516 cx.focus(search_bar.query_editor.as_any());
1517 search_bar.search("abas_nonexistent_match", None, cx)
1518 })
1519 .await
1520 .unwrap();
1521 search_bar.update(cx, |search_bar, cx| {
1522 search_bar.select_all_matches(&SelectAllMatches, cx);
1523 });
1524 window.read_with(cx, |cx| {
1525 assert!(
1526 !editor.is_focused(cx),
1527 "Should not switch focus to editor if SelectAllMatches does not find any matches"
1528 );
1529 });
1530 search_bar.update(cx, |search_bar, cx| {
1531 let all_selections =
1532 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx));
1533 assert_eq!(
1534 all_selections, last_match_selections,
1535 "Should not select anything new if there are no matches"
1536 );
1537 assert!(
1538 search_bar.active_match_index.is_none(),
1539 "For no matches, there should be no active match index"
1540 );
1541 });
1542 }
1543
1544 #[gpui::test]
1545 async fn test_search_query_history(cx: &mut TestAppContext) {
1546 crate::project_search::tests::init_test(cx);
1547
1548 let buffer_text = r#"
1549 A regular expression (shortened as regex or regexp;[1] also referred to as
1550 rational expression[2][3]) is a sequence of characters that specifies a search
1551 pattern in text. Usually such patterns are used by string-searching algorithms
1552 for "find" or "find and replace" operations on strings, or for input validation.
1553 "#
1554 .unindent();
1555 let buffer = cx.add_model(|cx| Buffer::new(0, cx.model_id() as u64, buffer_text));
1556 let window = cx.add_window(|_| EmptyView);
1557
1558 let editor = window.add_view(cx, |cx| Editor::for_buffer(buffer.clone(), None, cx));
1559
1560 let search_bar = window.add_view(cx, |cx| {
1561 let mut search_bar = BufferSearchBar::new(cx);
1562 search_bar.set_active_pane_item(Some(&editor), cx);
1563 search_bar.show(cx);
1564 search_bar
1565 });
1566
1567 // Add 3 search items into the history.
1568 search_bar
1569 .update(cx, |search_bar, cx| search_bar.search("a", None, cx))
1570 .await
1571 .unwrap();
1572 search_bar
1573 .update(cx, |search_bar, cx| search_bar.search("b", None, cx))
1574 .await
1575 .unwrap();
1576 search_bar
1577 .update(cx, |search_bar, cx| {
1578 search_bar.search("c", Some(SearchOptions::CASE_SENSITIVE), cx)
1579 })
1580 .await
1581 .unwrap();
1582 // Ensure that the latest search is active.
1583 search_bar.read_with(cx, |search_bar, cx| {
1584 assert_eq!(search_bar.query(cx), "c");
1585 assert_eq!(search_bar.search_options, SearchOptions::CASE_SENSITIVE);
1586 });
1587
1588 // Next history query after the latest should set the query to the empty string.
1589 search_bar.update(cx, |search_bar, cx| {
1590 search_bar.next_history_query(&NextHistoryQuery, cx);
1591 });
1592 search_bar.read_with(cx, |search_bar, cx| {
1593 assert_eq!(search_bar.query(cx), "");
1594 assert_eq!(search_bar.search_options, SearchOptions::CASE_SENSITIVE);
1595 });
1596 search_bar.update(cx, |search_bar, cx| {
1597 search_bar.next_history_query(&NextHistoryQuery, cx);
1598 });
1599 search_bar.read_with(cx, |search_bar, cx| {
1600 assert_eq!(search_bar.query(cx), "");
1601 assert_eq!(search_bar.search_options, SearchOptions::CASE_SENSITIVE);
1602 });
1603
1604 // First previous query for empty current query should set the query to the latest.
1605 search_bar.update(cx, |search_bar, cx| {
1606 search_bar.previous_history_query(&PreviousHistoryQuery, cx);
1607 });
1608 search_bar.read_with(cx, |search_bar, cx| {
1609 assert_eq!(search_bar.query(cx), "c");
1610 assert_eq!(search_bar.search_options, SearchOptions::CASE_SENSITIVE);
1611 });
1612
1613 // Further previous items should go over the history in reverse order.
1614 search_bar.update(cx, |search_bar, cx| {
1615 search_bar.previous_history_query(&PreviousHistoryQuery, cx);
1616 });
1617 search_bar.read_with(cx, |search_bar, cx| {
1618 assert_eq!(search_bar.query(cx), "b");
1619 assert_eq!(search_bar.search_options, SearchOptions::CASE_SENSITIVE);
1620 });
1621
1622 // Previous items should never go behind the first history item.
1623 search_bar.update(cx, |search_bar, cx| {
1624 search_bar.previous_history_query(&PreviousHistoryQuery, cx);
1625 });
1626 search_bar.read_with(cx, |search_bar, cx| {
1627 assert_eq!(search_bar.query(cx), "a");
1628 assert_eq!(search_bar.search_options, SearchOptions::CASE_SENSITIVE);
1629 });
1630 search_bar.update(cx, |search_bar, cx| {
1631 search_bar.previous_history_query(&PreviousHistoryQuery, cx);
1632 });
1633 search_bar.read_with(cx, |search_bar, cx| {
1634 assert_eq!(search_bar.query(cx), "a");
1635 assert_eq!(search_bar.search_options, SearchOptions::CASE_SENSITIVE);
1636 });
1637
1638 // Next items should go over the history in the original order.
1639 search_bar.update(cx, |search_bar, cx| {
1640 search_bar.next_history_query(&NextHistoryQuery, cx);
1641 });
1642 search_bar.read_with(cx, |search_bar, cx| {
1643 assert_eq!(search_bar.query(cx), "b");
1644 assert_eq!(search_bar.search_options, SearchOptions::CASE_SENSITIVE);
1645 });
1646
1647 search_bar
1648 .update(cx, |search_bar, cx| search_bar.search("ba", None, cx))
1649 .await
1650 .unwrap();
1651 search_bar.read_with(cx, |search_bar, cx| {
1652 assert_eq!(search_bar.query(cx), "ba");
1653 assert_eq!(search_bar.search_options, SearchOptions::NONE);
1654 });
1655
1656 // New search input should add another entry to history and move the selection to the end of the history.
1657 search_bar.update(cx, |search_bar, cx| {
1658 search_bar.previous_history_query(&PreviousHistoryQuery, cx);
1659 });
1660 search_bar.read_with(cx, |search_bar, cx| {
1661 assert_eq!(search_bar.query(cx), "c");
1662 assert_eq!(search_bar.search_options, SearchOptions::NONE);
1663 });
1664 search_bar.update(cx, |search_bar, cx| {
1665 search_bar.previous_history_query(&PreviousHistoryQuery, cx);
1666 });
1667 search_bar.read_with(cx, |search_bar, cx| {
1668 assert_eq!(search_bar.query(cx), "b");
1669 assert_eq!(search_bar.search_options, SearchOptions::NONE);
1670 });
1671 search_bar.update(cx, |search_bar, cx| {
1672 search_bar.next_history_query(&NextHistoryQuery, cx);
1673 });
1674 search_bar.read_with(cx, |search_bar, cx| {
1675 assert_eq!(search_bar.query(cx), "c");
1676 assert_eq!(search_bar.search_options, SearchOptions::NONE);
1677 });
1678 search_bar.update(cx, |search_bar, cx| {
1679 search_bar.next_history_query(&NextHistoryQuery, cx);
1680 });
1681 search_bar.read_with(cx, |search_bar, cx| {
1682 assert_eq!(search_bar.query(cx), "ba");
1683 assert_eq!(search_bar.search_options, SearchOptions::NONE);
1684 });
1685 search_bar.update(cx, |search_bar, cx| {
1686 search_bar.next_history_query(&NextHistoryQuery, cx);
1687 });
1688 search_bar.read_with(cx, |search_bar, cx| {
1689 assert_eq!(search_bar.query(cx), "");
1690 assert_eq!(search_bar.search_options, SearchOptions::NONE);
1691 });
1692 }
1693 #[gpui::test]
1694 async fn test_replace_simple(cx: &mut TestAppContext) {
1695 let (editor, search_bar) = init_test(cx);
1696
1697 search_bar
1698 .update(cx, |search_bar, cx| {
1699 search_bar.search("expression", None, cx)
1700 })
1701 .await
1702 .unwrap();
1703
1704 search_bar.update(cx, |search_bar, cx| {
1705 search_bar.replacement_editor.update(cx, |editor, cx| {
1706 // We use $1 here as initially we should be in Text mode, where `$1` should be treated literally.
1707 editor.set_text("expr$1", cx);
1708 });
1709 search_bar.replace_all(&ReplaceAll, cx)
1710 });
1711 assert_eq!(
1712 editor.read_with(cx, |this, cx| { this.text(cx) }),
1713 r#"
1714 A regular expr$1 (shortened as regex or regexp;[1] also referred to as
1715 rational expr$1[2][3]) is a sequence of characters that specifies a search
1716 pattern in text. Usually such patterns are used by string-searching algorithms
1717 for "find" or "find and replace" operations on strings, or for input validation.
1718 "#
1719 .unindent()
1720 );
1721
1722 // Search for word boundaries and replace just a single one.
1723 search_bar
1724 .update(cx, |search_bar, cx| {
1725 search_bar.search("or", Some(SearchOptions::WHOLE_WORD), cx)
1726 })
1727 .await
1728 .unwrap();
1729
1730 search_bar.update(cx, |search_bar, cx| {
1731 search_bar.replacement_editor.update(cx, |editor, cx| {
1732 editor.set_text("banana", cx);
1733 });
1734 search_bar.replace_next(&ReplaceNext, cx)
1735 });
1736 // Notice how the first or in the text (shORtened) is not replaced. Neither are the remaining hits of `or` in the text.
1737 assert_eq!(
1738 editor.read_with(cx, |this, cx| { this.text(cx) }),
1739 r#"
1740 A regular expr$1 (shortened as regex banana regexp;[1] also referred to as
1741 rational expr$1[2][3]) is a sequence of characters that specifies a search
1742 pattern in text. Usually such patterns are used by string-searching algorithms
1743 for "find" or "find and replace" operations on strings, or for input validation.
1744 "#
1745 .unindent()
1746 );
1747 // Let's turn on regex mode.
1748 search_bar
1749 .update(cx, |search_bar, cx| {
1750 search_bar.activate_search_mode(SearchMode::Regex, cx);
1751 search_bar.search("\\[([^\\]]+)\\]", None, cx)
1752 })
1753 .await
1754 .unwrap();
1755 search_bar.update(cx, |search_bar, cx| {
1756 search_bar.replacement_editor.update(cx, |editor, cx| {
1757 editor.set_text("${1}number", cx);
1758 });
1759 search_bar.replace_all(&ReplaceAll, cx)
1760 });
1761 assert_eq!(
1762 editor.read_with(cx, |this, cx| { this.text(cx) }),
1763 r#"
1764 A regular expr$1 (shortened as regex banana regexp;1number also referred to as
1765 rational expr$12number3number) is a sequence of characters that specifies a search
1766 pattern in text. Usually such patterns are used by string-searching algorithms
1767 for "find" or "find and replace" operations on strings, or for input validation.
1768 "#
1769 .unindent()
1770 );
1771 // Now with a whole-word twist.
1772 search_bar
1773 .update(cx, |search_bar, cx| {
1774 search_bar.activate_search_mode(SearchMode::Regex, cx);
1775 search_bar.search("a\\w+s", Some(SearchOptions::WHOLE_WORD), cx)
1776 })
1777 .await
1778 .unwrap();
1779 search_bar.update(cx, |search_bar, cx| {
1780 search_bar.replacement_editor.update(cx, |editor, cx| {
1781 editor.set_text("things", cx);
1782 });
1783 search_bar.replace_all(&ReplaceAll, cx)
1784 });
1785 // The only word affected by this edit should be `algorithms`, even though there's a bunch
1786 // of words in this text that would match this regex if not for WHOLE_WORD.
1787 assert_eq!(
1788 editor.read_with(cx, |this, cx| { this.text(cx) }),
1789 r#"
1790 A regular expr$1 (shortened as regex banana regexp;1number also referred to as
1791 rational expr$12number3number) is a sequence of characters that specifies a search
1792 pattern in text. Usually such patterns are used by string-searching things
1793 for "find" or "find and replace" operations on strings, or for input validation.
1794 "#
1795 .unindent()
1796 );
1797 }
1798}