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_enabled: 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_enabled && 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_enabled,
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_enabled: 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.with_replacement(self.replacement(cx)),
778 Err(_) => {
779 self.query_contains_error = true;
780 cx.notify();
781 return done_rx;
782 }
783 }
784 } else {
785 match SearchQuery::text(
786 query,
787 self.search_options.contains(SearchOptions::WHOLE_WORD),
788 self.search_options.contains(SearchOptions::CASE_SENSITIVE),
789 Vec::new(),
790 Vec::new(),
791 ) {
792 Ok(query) => query.with_replacement(self.replacement(cx)),
793 Err(_) => {
794 self.query_contains_error = true;
795 cx.notify();
796 return done_rx;
797 }
798 }
799 }
800 .into();
801 self.active_search = Some(query.clone());
802 let query_text = query.as_str().to_string();
803 let matches = active_searchable_item.find_matches(query, cx);
804
805 let active_searchable_item = active_searchable_item.downgrade();
806 self.pending_search = Some(cx.spawn(|this, mut cx| async move {
807 let matches = matches.await;
808 this.update(&mut cx, |this, cx| {
809 if let Some(active_searchable_item) =
810 WeakSearchableItemHandle::upgrade(active_searchable_item.as_ref(), cx)
811 {
812 this.searchable_items_with_matches
813 .insert(active_searchable_item.downgrade(), matches);
814
815 this.update_match_index(cx);
816 this.search_history.add(query_text);
817 if !this.dismissed {
818 let matches = this
819 .searchable_items_with_matches
820 .get(&active_searchable_item.downgrade())
821 .unwrap();
822 active_searchable_item.update_matches(matches, cx);
823 let _ = done_tx.send(());
824 }
825 cx.notify();
826 }
827 })
828 .log_err();
829 }));
830 }
831 }
832 done_rx
833 }
834
835 fn update_match_index(&mut self, cx: &mut ViewContext<Self>) {
836 let new_index = self
837 .active_searchable_item
838 .as_ref()
839 .and_then(|searchable_item| {
840 let matches = self
841 .searchable_items_with_matches
842 .get(&searchable_item.downgrade())?;
843 searchable_item.active_match_index(matches, cx)
844 });
845 if new_index != self.active_match_index {
846 self.active_match_index = new_index;
847 cx.notify();
848 }
849 }
850
851 fn next_history_query(&mut self, _: &NextHistoryQuery, cx: &mut ViewContext<Self>) {
852 if let Some(new_query) = self.search_history.next().map(str::to_string) {
853 let _ = self.search(&new_query, Some(self.search_options), cx);
854 } else {
855 self.search_history.reset_selection();
856 let _ = self.search("", Some(self.search_options), cx);
857 }
858 }
859
860 fn previous_history_query(&mut self, _: &PreviousHistoryQuery, cx: &mut ViewContext<Self>) {
861 if self.query(cx).is_empty() {
862 if let Some(new_query) = self.search_history.current().map(str::to_string) {
863 let _ = self.search(&new_query, Some(self.search_options), cx);
864 return;
865 }
866 }
867
868 if let Some(new_query) = self.search_history.previous().map(str::to_string) {
869 let _ = self.search(&new_query, Some(self.search_options), cx);
870 }
871 }
872 fn cycle_mode(&mut self, _: &CycleMode, cx: &mut ViewContext<Self>) {
873 self.activate_search_mode(next_mode(&self.current_mode, false), cx);
874 }
875 fn cycle_mode_on_pane(pane: &mut Pane, action: &CycleMode, cx: &mut ViewContext<Pane>) {
876 let mut should_propagate = true;
877 if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
878 search_bar.update(cx, |bar, cx| {
879 if bar.show(cx) {
880 should_propagate = false;
881 bar.cycle_mode(action, cx);
882 false
883 } else {
884 true
885 }
886 });
887 }
888 if should_propagate {
889 cx.propagate_action();
890 }
891 }
892 fn toggle_replace(&mut self, _: &ToggleReplace, cx: &mut ViewContext<Self>) {
893 if let Some(_) = &self.active_searchable_item {
894 self.replace_enabled = !self.replace_enabled;
895 if !self.replace_enabled {
896 cx.focus(&self.query_editor);
897 }
898 cx.notify();
899 }
900 }
901 fn toggle_replace_on_a_pane(pane: &mut Pane, _: &ToggleReplace, cx: &mut ViewContext<Pane>) {
902 let mut should_propagate = true;
903 if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
904 search_bar.update(cx, |bar, cx| {
905 if let Some(_) = &bar.active_searchable_item {
906 should_propagate = false;
907 bar.replace_enabled = !bar.replace_enabled;
908 if bar.dismissed {
909 bar.show(cx);
910 }
911 if !bar.replace_enabled {
912 cx.focus(&bar.query_editor);
913 }
914 cx.notify();
915 }
916 });
917 }
918 if should_propagate {
919 cx.propagate_action();
920 }
921 }
922 fn replace_next(&mut self, _: &ReplaceNext, cx: &mut ViewContext<Self>) {
923 let mut should_propagate = true;
924 if !self.dismissed && self.active_search.is_some() {
925 if let Some(searchable_item) = self.active_searchable_item.as_ref() {
926 if let Some(query) = self.active_search.as_ref() {
927 if let Some(matches) = self
928 .searchable_items_with_matches
929 .get(&searchable_item.downgrade())
930 {
931 if let Some(active_index) = self.active_match_index {
932 let query = query
933 .as_ref()
934 .clone()
935 .with_replacement(self.replacement(cx));
936 searchable_item.replace(&matches[active_index], &query, cx);
937 self.select_next_match(&SelectNextMatch, cx);
938 }
939 should_propagate = false;
940 self.focus_editor(&FocusEditor, cx);
941 }
942 }
943 }
944 }
945 if should_propagate {
946 cx.propagate_action();
947 }
948 }
949 fn replace_all(&mut self, _: &ReplaceAll, cx: &mut ViewContext<Self>) {
950 if !self.dismissed && self.active_search.is_some() {
951 if let Some(searchable_item) = self.active_searchable_item.as_ref() {
952 if let Some(query) = self.active_search.as_ref() {
953 if let Some(matches) = self
954 .searchable_items_with_matches
955 .get(&searchable_item.downgrade())
956 {
957 let query = query
958 .as_ref()
959 .clone()
960 .with_replacement(self.replacement(cx));
961 for m in matches {
962 searchable_item.replace(m, &query, cx);
963 }
964 }
965 }
966 }
967 }
968 }
969 fn replace_next_on_pane(pane: &mut Pane, action: &ReplaceNext, cx: &mut ViewContext<Pane>) {
970 if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
971 search_bar.update(cx, |bar, cx| bar.replace_next(action, cx));
972 return;
973 }
974 cx.propagate_action();
975 }
976 fn replace_all_on_pane(pane: &mut Pane, action: &ReplaceAll, cx: &mut ViewContext<Pane>) {
977 if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
978 search_bar.update(cx, |bar, cx| bar.replace_all(action, cx));
979 return;
980 }
981 cx.propagate_action();
982 }
983}
984
985#[cfg(test)]
986mod tests {
987 use super::*;
988 use editor::{DisplayPoint, Editor};
989 use gpui::{color::Color, test::EmptyView, TestAppContext};
990 use language::Buffer;
991 use unindent::Unindent as _;
992
993 fn init_test(cx: &mut TestAppContext) -> (ViewHandle<Editor>, ViewHandle<BufferSearchBar>) {
994 crate::project_search::tests::init_test(cx);
995
996 let buffer = cx.add_model(|cx| {
997 Buffer::new(
998 0,
999 cx.model_id() as u64,
1000 r#"
1001 A regular expression (shortened as regex or regexp;[1] also referred to as
1002 rational expression[2][3]) is a sequence of characters that specifies a search
1003 pattern in text. Usually such patterns are used by string-searching algorithms
1004 for "find" or "find and replace" operations on strings, or for input validation.
1005 "#
1006 .unindent(),
1007 )
1008 });
1009 let window = cx.add_window(|_| EmptyView);
1010 let editor = window.add_view(cx, |cx| Editor::for_buffer(buffer.clone(), None, cx));
1011
1012 let search_bar = window.add_view(cx, |cx| {
1013 let mut search_bar = BufferSearchBar::new(cx);
1014 search_bar.set_active_pane_item(Some(&editor), cx);
1015 search_bar.show(cx);
1016 search_bar
1017 });
1018
1019 (editor, search_bar)
1020 }
1021
1022 #[gpui::test]
1023 async fn test_search_simple(cx: &mut TestAppContext) {
1024 let (editor, search_bar) = init_test(cx);
1025
1026 // Search for a string that appears with different casing.
1027 // By default, search is case-insensitive.
1028 search_bar
1029 .update(cx, |search_bar, cx| search_bar.search("us", None, cx))
1030 .await
1031 .unwrap();
1032 editor.update(cx, |editor, cx| {
1033 assert_eq!(
1034 editor.all_text_background_highlights(cx),
1035 &[
1036 (
1037 DisplayPoint::new(2, 17)..DisplayPoint::new(2, 19),
1038 Color::red(),
1039 ),
1040 (
1041 DisplayPoint::new(2, 43)..DisplayPoint::new(2, 45),
1042 Color::red(),
1043 ),
1044 ]
1045 );
1046 });
1047
1048 // Switch to a case sensitive search.
1049 search_bar.update(cx, |search_bar, cx| {
1050 search_bar.toggle_search_option(SearchOptions::CASE_SENSITIVE, cx);
1051 });
1052 editor.next_notification(cx).await;
1053 editor.update(cx, |editor, cx| {
1054 assert_eq!(
1055 editor.all_text_background_highlights(cx),
1056 &[(
1057 DisplayPoint::new(2, 43)..DisplayPoint::new(2, 45),
1058 Color::red(),
1059 )]
1060 );
1061 });
1062
1063 // Search for a string that appears both as a whole word and
1064 // within other words. By default, all results are found.
1065 search_bar
1066 .update(cx, |search_bar, cx| search_bar.search("or", None, cx))
1067 .await
1068 .unwrap();
1069 editor.update(cx, |editor, cx| {
1070 assert_eq!(
1071 editor.all_text_background_highlights(cx),
1072 &[
1073 (
1074 DisplayPoint::new(0, 24)..DisplayPoint::new(0, 26),
1075 Color::red(),
1076 ),
1077 (
1078 DisplayPoint::new(0, 41)..DisplayPoint::new(0, 43),
1079 Color::red(),
1080 ),
1081 (
1082 DisplayPoint::new(2, 71)..DisplayPoint::new(2, 73),
1083 Color::red(),
1084 ),
1085 (
1086 DisplayPoint::new(3, 1)..DisplayPoint::new(3, 3),
1087 Color::red(),
1088 ),
1089 (
1090 DisplayPoint::new(3, 11)..DisplayPoint::new(3, 13),
1091 Color::red(),
1092 ),
1093 (
1094 DisplayPoint::new(3, 56)..DisplayPoint::new(3, 58),
1095 Color::red(),
1096 ),
1097 (
1098 DisplayPoint::new(3, 60)..DisplayPoint::new(3, 62),
1099 Color::red(),
1100 ),
1101 ]
1102 );
1103 });
1104
1105 // Switch to a whole word search.
1106 search_bar.update(cx, |search_bar, cx| {
1107 search_bar.toggle_search_option(SearchOptions::WHOLE_WORD, cx);
1108 });
1109 editor.next_notification(cx).await;
1110 editor.update(cx, |editor, cx| {
1111 assert_eq!(
1112 editor.all_text_background_highlights(cx),
1113 &[
1114 (
1115 DisplayPoint::new(0, 41)..DisplayPoint::new(0, 43),
1116 Color::red(),
1117 ),
1118 (
1119 DisplayPoint::new(3, 11)..DisplayPoint::new(3, 13),
1120 Color::red(),
1121 ),
1122 (
1123 DisplayPoint::new(3, 56)..DisplayPoint::new(3, 58),
1124 Color::red(),
1125 ),
1126 ]
1127 );
1128 });
1129
1130 editor.update(cx, |editor, cx| {
1131 editor.change_selections(None, cx, |s| {
1132 s.select_display_ranges([DisplayPoint::new(0, 0)..DisplayPoint::new(0, 0)])
1133 });
1134 });
1135 search_bar.update(cx, |search_bar, cx| {
1136 assert_eq!(search_bar.active_match_index, Some(0));
1137 search_bar.select_next_match(&SelectNextMatch, cx);
1138 assert_eq!(
1139 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1140 [DisplayPoint::new(0, 41)..DisplayPoint::new(0, 43)]
1141 );
1142 });
1143 search_bar.read_with(cx, |search_bar, _| {
1144 assert_eq!(search_bar.active_match_index, Some(0));
1145 });
1146
1147 search_bar.update(cx, |search_bar, cx| {
1148 search_bar.select_next_match(&SelectNextMatch, cx);
1149 assert_eq!(
1150 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1151 [DisplayPoint::new(3, 11)..DisplayPoint::new(3, 13)]
1152 );
1153 });
1154 search_bar.read_with(cx, |search_bar, _| {
1155 assert_eq!(search_bar.active_match_index, Some(1));
1156 });
1157
1158 search_bar.update(cx, |search_bar, cx| {
1159 search_bar.select_next_match(&SelectNextMatch, cx);
1160 assert_eq!(
1161 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1162 [DisplayPoint::new(3, 56)..DisplayPoint::new(3, 58)]
1163 );
1164 });
1165 search_bar.read_with(cx, |search_bar, _| {
1166 assert_eq!(search_bar.active_match_index, Some(2));
1167 });
1168
1169 search_bar.update(cx, |search_bar, cx| {
1170 search_bar.select_next_match(&SelectNextMatch, cx);
1171 assert_eq!(
1172 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1173 [DisplayPoint::new(0, 41)..DisplayPoint::new(0, 43)]
1174 );
1175 });
1176 search_bar.read_with(cx, |search_bar, _| {
1177 assert_eq!(search_bar.active_match_index, Some(0));
1178 });
1179
1180 search_bar.update(cx, |search_bar, cx| {
1181 search_bar.select_prev_match(&SelectPrevMatch, cx);
1182 assert_eq!(
1183 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1184 [DisplayPoint::new(3, 56)..DisplayPoint::new(3, 58)]
1185 );
1186 });
1187 search_bar.read_with(cx, |search_bar, _| {
1188 assert_eq!(search_bar.active_match_index, Some(2));
1189 });
1190
1191 search_bar.update(cx, |search_bar, cx| {
1192 search_bar.select_prev_match(&SelectPrevMatch, cx);
1193 assert_eq!(
1194 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1195 [DisplayPoint::new(3, 11)..DisplayPoint::new(3, 13)]
1196 );
1197 });
1198 search_bar.read_with(cx, |search_bar, _| {
1199 assert_eq!(search_bar.active_match_index, Some(1));
1200 });
1201
1202 search_bar.update(cx, |search_bar, cx| {
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 previous match selects
1214 // the closest match to the left.
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_prev_match(&SelectPrevMatch, cx);
1223 assert_eq!(
1224 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1225 [DisplayPoint::new(0, 41)..DisplayPoint::new(0, 43)]
1226 );
1227 });
1228 search_bar.read_with(cx, |search_bar, _| {
1229 assert_eq!(search_bar.active_match_index, Some(0));
1230 });
1231
1232 // Park the cursor in between matches and ensure that going to the next match selects the
1233 // closest match to the right.
1234 editor.update(cx, |editor, cx| {
1235 editor.change_selections(None, cx, |s| {
1236 s.select_display_ranges([DisplayPoint::new(1, 0)..DisplayPoint::new(1, 0)])
1237 });
1238 });
1239 search_bar.update(cx, |search_bar, cx| {
1240 assert_eq!(search_bar.active_match_index, Some(1));
1241 search_bar.select_next_match(&SelectNextMatch, cx);
1242 assert_eq!(
1243 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1244 [DisplayPoint::new(3, 11)..DisplayPoint::new(3, 13)]
1245 );
1246 });
1247 search_bar.read_with(cx, |search_bar, _| {
1248 assert_eq!(search_bar.active_match_index, Some(1));
1249 });
1250
1251 // Park the cursor after the last match and ensure that going to the previous match selects
1252 // the last 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_prev_match(&SelectPrevMatch, cx);
1261 assert_eq!(
1262 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1263 [DisplayPoint::new(3, 56)..DisplayPoint::new(3, 58)]
1264 );
1265 });
1266 search_bar.read_with(cx, |search_bar, _| {
1267 assert_eq!(search_bar.active_match_index, Some(2));
1268 });
1269
1270 // Park the cursor after the last match and ensure that going to the next match selects the
1271 // first match.
1272 editor.update(cx, |editor, cx| {
1273 editor.change_selections(None, cx, |s| {
1274 s.select_display_ranges([DisplayPoint::new(3, 60)..DisplayPoint::new(3, 60)])
1275 });
1276 });
1277 search_bar.update(cx, |search_bar, cx| {
1278 assert_eq!(search_bar.active_match_index, Some(2));
1279 search_bar.select_next_match(&SelectNextMatch, cx);
1280 assert_eq!(
1281 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1282 [DisplayPoint::new(0, 41)..DisplayPoint::new(0, 43)]
1283 );
1284 });
1285 search_bar.read_with(cx, |search_bar, _| {
1286 assert_eq!(search_bar.active_match_index, Some(0));
1287 });
1288
1289 // Park the cursor before the first match and ensure that going to the previous match
1290 // selects the last match.
1291 editor.update(cx, |editor, cx| {
1292 editor.change_selections(None, cx, |s| {
1293 s.select_display_ranges([DisplayPoint::new(0, 0)..DisplayPoint::new(0, 0)])
1294 });
1295 });
1296 search_bar.update(cx, |search_bar, cx| {
1297 assert_eq!(search_bar.active_match_index, Some(0));
1298 search_bar.select_prev_match(&SelectPrevMatch, cx);
1299 assert_eq!(
1300 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1301 [DisplayPoint::new(3, 56)..DisplayPoint::new(3, 58)]
1302 );
1303 });
1304 search_bar.read_with(cx, |search_bar, _| {
1305 assert_eq!(search_bar.active_match_index, Some(2));
1306 });
1307 }
1308
1309 #[gpui::test]
1310 async fn test_search_option_handling(cx: &mut TestAppContext) {
1311 let (editor, search_bar) = init_test(cx);
1312
1313 // show with options should make current search case sensitive
1314 search_bar
1315 .update(cx, |search_bar, cx| {
1316 search_bar.show(cx);
1317 search_bar.search("us", Some(SearchOptions::CASE_SENSITIVE), cx)
1318 })
1319 .await
1320 .unwrap();
1321 editor.update(cx, |editor, cx| {
1322 assert_eq!(
1323 editor.all_text_background_highlights(cx),
1324 &[(
1325 DisplayPoint::new(2, 43)..DisplayPoint::new(2, 45),
1326 Color::red(),
1327 )]
1328 );
1329 });
1330
1331 // search_suggested should restore default options
1332 search_bar.update(cx, |search_bar, cx| {
1333 search_bar.search_suggested(cx);
1334 assert_eq!(search_bar.search_options, SearchOptions::NONE)
1335 });
1336
1337 // toggling a search option should update the defaults
1338 search_bar
1339 .update(cx, |search_bar, cx| {
1340 search_bar.search("regex", Some(SearchOptions::CASE_SENSITIVE), cx)
1341 })
1342 .await
1343 .unwrap();
1344 search_bar.update(cx, |search_bar, cx| {
1345 search_bar.toggle_search_option(SearchOptions::WHOLE_WORD, cx)
1346 });
1347 editor.next_notification(cx).await;
1348 editor.update(cx, |editor, cx| {
1349 assert_eq!(
1350 editor.all_text_background_highlights(cx),
1351 &[(
1352 DisplayPoint::new(0, 35)..DisplayPoint::new(0, 40),
1353 Color::red(),
1354 ),]
1355 );
1356 });
1357
1358 // defaults should still include whole word
1359 search_bar.update(cx, |search_bar, cx| {
1360 search_bar.search_suggested(cx);
1361 assert_eq!(
1362 search_bar.search_options,
1363 SearchOptions::CASE_SENSITIVE | SearchOptions::WHOLE_WORD
1364 )
1365 });
1366 }
1367
1368 #[gpui::test]
1369 async fn test_search_select_all_matches(cx: &mut TestAppContext) {
1370 crate::project_search::tests::init_test(cx);
1371
1372 let buffer_text = r#"
1373 A regular expression (shortened as regex or regexp;[1] also referred to as
1374 rational expression[2][3]) is a sequence of characters that specifies a search
1375 pattern in text. Usually such patterns are used by string-searching algorithms
1376 for "find" or "find and replace" operations on strings, or for input validation.
1377 "#
1378 .unindent();
1379 let expected_query_matches_count = buffer_text
1380 .chars()
1381 .filter(|c| c.to_ascii_lowercase() == 'a')
1382 .count();
1383 assert!(
1384 expected_query_matches_count > 1,
1385 "Should pick a query with multiple results"
1386 );
1387 let buffer = cx.add_model(|cx| Buffer::new(0, cx.model_id() as u64, buffer_text));
1388 let window = cx.add_window(|_| EmptyView);
1389 let editor = window.add_view(cx, |cx| Editor::for_buffer(buffer.clone(), None, cx));
1390
1391 let search_bar = window.add_view(cx, |cx| {
1392 let mut search_bar = BufferSearchBar::new(cx);
1393 search_bar.set_active_pane_item(Some(&editor), cx);
1394 search_bar.show(cx);
1395 search_bar
1396 });
1397
1398 search_bar
1399 .update(cx, |search_bar, cx| search_bar.search("a", None, cx))
1400 .await
1401 .unwrap();
1402 search_bar.update(cx, |search_bar, cx| {
1403 cx.focus(search_bar.query_editor.as_any());
1404 search_bar.activate_current_match(cx);
1405 });
1406
1407 window.read_with(cx, |cx| {
1408 assert!(
1409 !editor.is_focused(cx),
1410 "Initially, the editor should not be focused"
1411 );
1412 });
1413
1414 let initial_selections = editor.update(cx, |editor, cx| {
1415 let initial_selections = editor.selections.display_ranges(cx);
1416 assert_eq!(
1417 initial_selections.len(), 1,
1418 "Expected to have only one selection before adding carets to all matches, but got: {initial_selections:?}",
1419 );
1420 initial_selections
1421 });
1422 search_bar.update(cx, |search_bar, _| {
1423 assert_eq!(search_bar.active_match_index, Some(0));
1424 });
1425
1426 search_bar.update(cx, |search_bar, cx| {
1427 cx.focus(search_bar.query_editor.as_any());
1428 search_bar.select_all_matches(&SelectAllMatches, cx);
1429 });
1430 window.read_with(cx, |cx| {
1431 assert!(
1432 editor.is_focused(cx),
1433 "Should focus editor after successful SelectAllMatches"
1434 );
1435 });
1436 search_bar.update(cx, |search_bar, cx| {
1437 let all_selections =
1438 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx));
1439 assert_eq!(
1440 all_selections.len(),
1441 expected_query_matches_count,
1442 "Should select all `a` characters in the buffer, but got: {all_selections:?}"
1443 );
1444 assert_eq!(
1445 search_bar.active_match_index,
1446 Some(0),
1447 "Match index should not change after selecting all matches"
1448 );
1449 });
1450
1451 search_bar.update(cx, |search_bar, cx| {
1452 search_bar.select_next_match(&SelectNextMatch, cx);
1453 });
1454 window.read_with(cx, |cx| {
1455 assert!(
1456 editor.is_focused(cx),
1457 "Should still have editor focused after SelectNextMatch"
1458 );
1459 });
1460 search_bar.update(cx, |search_bar, cx| {
1461 let all_selections =
1462 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx));
1463 assert_eq!(
1464 all_selections.len(),
1465 1,
1466 "On next match, should deselect items and select the next match"
1467 );
1468 assert_ne!(
1469 all_selections, initial_selections,
1470 "Next match should be different from the first selection"
1471 );
1472 assert_eq!(
1473 search_bar.active_match_index,
1474 Some(1),
1475 "Match index should be updated to the next one"
1476 );
1477 });
1478
1479 search_bar.update(cx, |search_bar, cx| {
1480 cx.focus(search_bar.query_editor.as_any());
1481 search_bar.select_all_matches(&SelectAllMatches, cx);
1482 });
1483 window.read_with(cx, |cx| {
1484 assert!(
1485 editor.is_focused(cx),
1486 "Should focus editor after successful SelectAllMatches"
1487 );
1488 });
1489 search_bar.update(cx, |search_bar, cx| {
1490 let all_selections =
1491 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx));
1492 assert_eq!(
1493 all_selections.len(),
1494 expected_query_matches_count,
1495 "Should select all `a` characters in the buffer, but got: {all_selections:?}"
1496 );
1497 assert_eq!(
1498 search_bar.active_match_index,
1499 Some(1),
1500 "Match index should not change after selecting all matches"
1501 );
1502 });
1503
1504 search_bar.update(cx, |search_bar, cx| {
1505 search_bar.select_prev_match(&SelectPrevMatch, cx);
1506 });
1507 window.read_with(cx, |cx| {
1508 assert!(
1509 editor.is_focused(cx),
1510 "Should still have editor focused after SelectPrevMatch"
1511 );
1512 });
1513 let last_match_selections = search_bar.update(cx, |search_bar, cx| {
1514 let all_selections =
1515 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx));
1516 assert_eq!(
1517 all_selections.len(),
1518 1,
1519 "On previous match, should deselect items and select the previous item"
1520 );
1521 assert_eq!(
1522 all_selections, initial_selections,
1523 "Previous match should be the same as the first selection"
1524 );
1525 assert_eq!(
1526 search_bar.active_match_index,
1527 Some(0),
1528 "Match index should be updated to the previous one"
1529 );
1530 all_selections
1531 });
1532
1533 search_bar
1534 .update(cx, |search_bar, cx| {
1535 cx.focus(search_bar.query_editor.as_any());
1536 search_bar.search("abas_nonexistent_match", None, cx)
1537 })
1538 .await
1539 .unwrap();
1540 search_bar.update(cx, |search_bar, cx| {
1541 search_bar.select_all_matches(&SelectAllMatches, cx);
1542 });
1543 window.read_with(cx, |cx| {
1544 assert!(
1545 !editor.is_focused(cx),
1546 "Should not switch focus to editor if SelectAllMatches does not find any matches"
1547 );
1548 });
1549 search_bar.update(cx, |search_bar, cx| {
1550 let all_selections =
1551 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx));
1552 assert_eq!(
1553 all_selections, last_match_selections,
1554 "Should not select anything new if there are no matches"
1555 );
1556 assert!(
1557 search_bar.active_match_index.is_none(),
1558 "For no matches, there should be no active match index"
1559 );
1560 });
1561 }
1562
1563 #[gpui::test]
1564 async fn test_search_query_history(cx: &mut TestAppContext) {
1565 crate::project_search::tests::init_test(cx);
1566
1567 let buffer_text = r#"
1568 A regular expression (shortened as regex or regexp;[1] also referred to as
1569 rational expression[2][3]) is a sequence of characters that specifies a search
1570 pattern in text. Usually such patterns are used by string-searching algorithms
1571 for "find" or "find and replace" operations on strings, or for input validation.
1572 "#
1573 .unindent();
1574 let buffer = cx.add_model(|cx| Buffer::new(0, cx.model_id() as u64, buffer_text));
1575 let window = cx.add_window(|_| EmptyView);
1576
1577 let editor = window.add_view(cx, |cx| Editor::for_buffer(buffer.clone(), None, cx));
1578
1579 let search_bar = window.add_view(cx, |cx| {
1580 let mut search_bar = BufferSearchBar::new(cx);
1581 search_bar.set_active_pane_item(Some(&editor), cx);
1582 search_bar.show(cx);
1583 search_bar
1584 });
1585
1586 // Add 3 search items into the history.
1587 search_bar
1588 .update(cx, |search_bar, cx| search_bar.search("a", None, cx))
1589 .await
1590 .unwrap();
1591 search_bar
1592 .update(cx, |search_bar, cx| search_bar.search("b", None, cx))
1593 .await
1594 .unwrap();
1595 search_bar
1596 .update(cx, |search_bar, cx| {
1597 search_bar.search("c", Some(SearchOptions::CASE_SENSITIVE), cx)
1598 })
1599 .await
1600 .unwrap();
1601 // Ensure that the latest search is active.
1602 search_bar.read_with(cx, |search_bar, cx| {
1603 assert_eq!(search_bar.query(cx), "c");
1604 assert_eq!(search_bar.search_options, SearchOptions::CASE_SENSITIVE);
1605 });
1606
1607 // Next history query after the latest should set the query to the empty string.
1608 search_bar.update(cx, |search_bar, cx| {
1609 search_bar.next_history_query(&NextHistoryQuery, cx);
1610 });
1611 search_bar.read_with(cx, |search_bar, cx| {
1612 assert_eq!(search_bar.query(cx), "");
1613 assert_eq!(search_bar.search_options, SearchOptions::CASE_SENSITIVE);
1614 });
1615 search_bar.update(cx, |search_bar, cx| {
1616 search_bar.next_history_query(&NextHistoryQuery, cx);
1617 });
1618 search_bar.read_with(cx, |search_bar, cx| {
1619 assert_eq!(search_bar.query(cx), "");
1620 assert_eq!(search_bar.search_options, SearchOptions::CASE_SENSITIVE);
1621 });
1622
1623 // First previous query for empty current query should set the query to the latest.
1624 search_bar.update(cx, |search_bar, cx| {
1625 search_bar.previous_history_query(&PreviousHistoryQuery, cx);
1626 });
1627 search_bar.read_with(cx, |search_bar, cx| {
1628 assert_eq!(search_bar.query(cx), "c");
1629 assert_eq!(search_bar.search_options, SearchOptions::CASE_SENSITIVE);
1630 });
1631
1632 // Further previous items should go over the history in reverse order.
1633 search_bar.update(cx, |search_bar, cx| {
1634 search_bar.previous_history_query(&PreviousHistoryQuery, cx);
1635 });
1636 search_bar.read_with(cx, |search_bar, cx| {
1637 assert_eq!(search_bar.query(cx), "b");
1638 assert_eq!(search_bar.search_options, SearchOptions::CASE_SENSITIVE);
1639 });
1640
1641 // Previous items should never go behind the first history item.
1642 search_bar.update(cx, |search_bar, cx| {
1643 search_bar.previous_history_query(&PreviousHistoryQuery, cx);
1644 });
1645 search_bar.read_with(cx, |search_bar, cx| {
1646 assert_eq!(search_bar.query(cx), "a");
1647 assert_eq!(search_bar.search_options, SearchOptions::CASE_SENSITIVE);
1648 });
1649 search_bar.update(cx, |search_bar, cx| {
1650 search_bar.previous_history_query(&PreviousHistoryQuery, cx);
1651 });
1652 search_bar.read_with(cx, |search_bar, cx| {
1653 assert_eq!(search_bar.query(cx), "a");
1654 assert_eq!(search_bar.search_options, SearchOptions::CASE_SENSITIVE);
1655 });
1656
1657 // Next items should go over the history in the original order.
1658 search_bar.update(cx, |search_bar, cx| {
1659 search_bar.next_history_query(&NextHistoryQuery, cx);
1660 });
1661 search_bar.read_with(cx, |search_bar, cx| {
1662 assert_eq!(search_bar.query(cx), "b");
1663 assert_eq!(search_bar.search_options, SearchOptions::CASE_SENSITIVE);
1664 });
1665
1666 search_bar
1667 .update(cx, |search_bar, cx| search_bar.search("ba", None, cx))
1668 .await
1669 .unwrap();
1670 search_bar.read_with(cx, |search_bar, cx| {
1671 assert_eq!(search_bar.query(cx), "ba");
1672 assert_eq!(search_bar.search_options, SearchOptions::NONE);
1673 });
1674
1675 // New search input should add another entry to history and move the selection to the end of the history.
1676 search_bar.update(cx, |search_bar, cx| {
1677 search_bar.previous_history_query(&PreviousHistoryQuery, cx);
1678 });
1679 search_bar.read_with(cx, |search_bar, cx| {
1680 assert_eq!(search_bar.query(cx), "c");
1681 assert_eq!(search_bar.search_options, SearchOptions::NONE);
1682 });
1683 search_bar.update(cx, |search_bar, cx| {
1684 search_bar.previous_history_query(&PreviousHistoryQuery, cx);
1685 });
1686 search_bar.read_with(cx, |search_bar, cx| {
1687 assert_eq!(search_bar.query(cx), "b");
1688 assert_eq!(search_bar.search_options, SearchOptions::NONE);
1689 });
1690 search_bar.update(cx, |search_bar, cx| {
1691 search_bar.next_history_query(&NextHistoryQuery, cx);
1692 });
1693 search_bar.read_with(cx, |search_bar, cx| {
1694 assert_eq!(search_bar.query(cx), "c");
1695 assert_eq!(search_bar.search_options, SearchOptions::NONE);
1696 });
1697 search_bar.update(cx, |search_bar, cx| {
1698 search_bar.next_history_query(&NextHistoryQuery, cx);
1699 });
1700 search_bar.read_with(cx, |search_bar, cx| {
1701 assert_eq!(search_bar.query(cx), "ba");
1702 assert_eq!(search_bar.search_options, SearchOptions::NONE);
1703 });
1704 search_bar.update(cx, |search_bar, cx| {
1705 search_bar.next_history_query(&NextHistoryQuery, cx);
1706 });
1707 search_bar.read_with(cx, |search_bar, cx| {
1708 assert_eq!(search_bar.query(cx), "");
1709 assert_eq!(search_bar.search_options, SearchOptions::NONE);
1710 });
1711 }
1712 #[gpui::test]
1713 async fn test_replace_simple(cx: &mut TestAppContext) {
1714 let (editor, search_bar) = init_test(cx);
1715
1716 search_bar
1717 .update(cx, |search_bar, cx| {
1718 search_bar.search("expression", None, cx)
1719 })
1720 .await
1721 .unwrap();
1722
1723 search_bar.update(cx, |search_bar, cx| {
1724 search_bar.replacement_editor.update(cx, |editor, cx| {
1725 // We use $1 here as initially we should be in Text mode, where `$1` should be treated literally.
1726 editor.set_text("expr$1", cx);
1727 });
1728 search_bar.replace_all(&ReplaceAll, cx)
1729 });
1730 assert_eq!(
1731 editor.read_with(cx, |this, cx| { this.text(cx) }),
1732 r#"
1733 A regular expr$1 (shortened as regex or regexp;[1] also referred to as
1734 rational expr$1[2][3]) is a sequence of characters that specifies a search
1735 pattern in text. Usually such patterns are used by string-searching algorithms
1736 for "find" or "find and replace" operations on strings, or for input validation.
1737 "#
1738 .unindent()
1739 );
1740
1741 // Search for word boundaries and replace just a single one.
1742 search_bar
1743 .update(cx, |search_bar, cx| {
1744 search_bar.search("or", Some(SearchOptions::WHOLE_WORD), cx)
1745 })
1746 .await
1747 .unwrap();
1748
1749 search_bar.update(cx, |search_bar, cx| {
1750 search_bar.replacement_editor.update(cx, |editor, cx| {
1751 editor.set_text("banana", cx);
1752 });
1753 search_bar.replace_next(&ReplaceNext, cx)
1754 });
1755 // Notice how the first or in the text (shORtened) is not replaced. Neither are the remaining hits of `or` in the text.
1756 assert_eq!(
1757 editor.read_with(cx, |this, cx| { this.text(cx) }),
1758 r#"
1759 A regular expr$1 (shortened as regex banana regexp;[1] also referred to as
1760 rational expr$1[2][3]) is a sequence of characters that specifies a search
1761 pattern in text. Usually such patterns are used by string-searching algorithms
1762 for "find" or "find and replace" operations on strings, or for input validation.
1763 "#
1764 .unindent()
1765 );
1766 // Let's turn on regex mode.
1767 search_bar
1768 .update(cx, |search_bar, cx| {
1769 search_bar.activate_search_mode(SearchMode::Regex, cx);
1770 search_bar.search("\\[([^\\]]+)\\]", None, cx)
1771 })
1772 .await
1773 .unwrap();
1774 search_bar.update(cx, |search_bar, cx| {
1775 search_bar.replacement_editor.update(cx, |editor, cx| {
1776 editor.set_text("${1}number", cx);
1777 });
1778 search_bar.replace_all(&ReplaceAll, cx)
1779 });
1780 assert_eq!(
1781 editor.read_with(cx, |this, cx| { this.text(cx) }),
1782 r#"
1783 A regular expr$1 (shortened as regex banana regexp;1number also referred to as
1784 rational expr$12number3number) is a sequence of characters that specifies a search
1785 pattern in text. Usually such patterns are used by string-searching algorithms
1786 for "find" or "find and replace" operations on strings, or for input validation.
1787 "#
1788 .unindent()
1789 );
1790 // Now with a whole-word twist.
1791 search_bar
1792 .update(cx, |search_bar, cx| {
1793 search_bar.activate_search_mode(SearchMode::Regex, cx);
1794 search_bar.search("a\\w+s", Some(SearchOptions::WHOLE_WORD), cx)
1795 })
1796 .await
1797 .unwrap();
1798 search_bar.update(cx, |search_bar, cx| {
1799 search_bar.replacement_editor.update(cx, |editor, cx| {
1800 editor.set_text("things", cx);
1801 });
1802 search_bar.replace_all(&ReplaceAll, cx)
1803 });
1804 // The only word affected by this edit should be `algorithms`, even though there's a bunch
1805 // of words in this text that would match this regex if not for WHOLE_WORD.
1806 assert_eq!(
1807 editor.read_with(cx, |this, cx| { this.text(cx) }),
1808 r#"
1809 A regular expr$1 (shortened as regex banana regexp;1number also referred to as
1810 rational expr$12number3number) is a sequence of characters that specifies a search
1811 pattern in text. Usually such patterns are used by string-searching things
1812 for "find" or "find and replace" operations on strings, or for input validation.
1813 "#
1814 .unindent()
1815 );
1816 }
1817}