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_child(mode_column)
351 .with_children(switches_column)
352 .with_children(replacement)
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 .filter(|suggestion| !suggestion.is_empty())
541 }
542
543 pub fn set_replacement(&mut self, replacement: Option<&str>, cx: &mut ViewContext<Self>) {
544 if replacement.is_none() {
545 self.replace_enabled = false;
546 return;
547 }
548 self.replace_enabled = true;
549 self.replacement_editor
550 .update(cx, |replacement_editor, cx| {
551 replacement_editor
552 .buffer()
553 .update(cx, |replacement_buffer, cx| {
554 let len = replacement_buffer.len(cx);
555 replacement_buffer.edit([(0..len, replacement.unwrap())], None, cx);
556 });
557 });
558 }
559
560 pub fn search(
561 &mut self,
562 query: &str,
563 options: Option<SearchOptions>,
564 cx: &mut ViewContext<Self>,
565 ) -> oneshot::Receiver<()> {
566 let options = options.unwrap_or(self.default_options);
567 if query != self.query(cx) || self.search_options != options {
568 self.query_editor.update(cx, |query_editor, cx| {
569 query_editor.buffer().update(cx, |query_buffer, cx| {
570 let len = query_buffer.len(cx);
571 query_buffer.edit([(0..len, query)], None, cx);
572 });
573 });
574 self.search_options = options;
575 self.query_contains_error = false;
576 self.clear_matches(cx);
577 cx.notify();
578 }
579 self.update_matches(cx)
580 }
581
582 fn render_action_button(
583 &self,
584 icon: &'static str,
585 cx: &mut ViewContext<Self>,
586 ) -> AnyElement<Self> {
587 let tooltip = "Select All Matches";
588 let tooltip_style = theme::current(cx).tooltip.clone();
589
590 let theme = theme::current(cx);
591 let style = theme.search.action_button.clone();
592
593 gpui::elements::Component::element(SafeStylable::with_style(
594 theme::components::action_button::Button::action(SelectAllMatches)
595 .with_tooltip(tooltip, tooltip_style)
596 .with_contents(theme::components::svg::Svg::new(icon)),
597 style,
598 ))
599 .into_any()
600 }
601
602 pub fn activate_search_mode(&mut self, mode: SearchMode, cx: &mut ViewContext<Self>) {
603 assert_ne!(
604 mode,
605 SearchMode::Semantic,
606 "Semantic search is not supported in buffer search"
607 );
608 if mode == self.current_mode {
609 return;
610 }
611 self.current_mode = mode;
612 let _ = self.update_matches(cx);
613 cx.notify();
614 }
615
616 fn deploy_bar(pane: &mut Pane, action: &Deploy, cx: &mut ViewContext<Pane>) {
617 let mut propagate_action = true;
618 if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
619 search_bar.update(cx, |search_bar, cx| {
620 if search_bar.deploy(action, cx) {
621 propagate_action = false;
622 }
623 });
624 }
625 if propagate_action {
626 cx.propagate_action();
627 }
628 }
629
630 fn handle_editor_cancel(pane: &mut Pane, _: &editor::Cancel, cx: &mut ViewContext<Pane>) {
631 if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
632 if !search_bar.read(cx).dismissed {
633 search_bar.update(cx, |search_bar, cx| search_bar.dismiss(&Dismiss, cx));
634 return;
635 }
636 }
637 cx.propagate_action();
638 }
639
640 pub fn focus_editor(&mut self, _: &FocusEditor, cx: &mut ViewContext<Self>) {
641 if let Some(active_editor) = self.active_searchable_item.as_ref() {
642 cx.focus(active_editor.as_any());
643 }
644 }
645
646 fn toggle_search_option(&mut self, search_option: SearchOptions, cx: &mut ViewContext<Self>) {
647 self.search_options.toggle(search_option);
648 self.default_options = self.search_options;
649 let _ = self.update_matches(cx);
650 cx.notify();
651 }
652
653 pub fn set_search_options(
654 &mut self,
655 search_options: SearchOptions,
656 cx: &mut ViewContext<Self>,
657 ) {
658 self.search_options = search_options;
659 cx.notify();
660 }
661
662 fn select_next_match(&mut self, _: &SelectNextMatch, cx: &mut ViewContext<Self>) {
663 self.select_match(Direction::Next, 1, cx);
664 }
665
666 fn select_prev_match(&mut self, _: &SelectPrevMatch, cx: &mut ViewContext<Self>) {
667 self.select_match(Direction::Prev, 1, cx);
668 }
669
670 fn select_all_matches(&mut self, _: &SelectAllMatches, cx: &mut ViewContext<Self>) {
671 if !self.dismissed && self.active_match_index.is_some() {
672 if let Some(searchable_item) = self.active_searchable_item.as_ref() {
673 if let Some(matches) = self
674 .searchable_items_with_matches
675 .get(&searchable_item.downgrade())
676 {
677 searchable_item.select_matches(matches, cx);
678 self.focus_editor(&FocusEditor, cx);
679 }
680 }
681 }
682 }
683
684 pub fn select_match(&mut self, direction: Direction, count: usize, cx: &mut ViewContext<Self>) {
685 if let Some(index) = self.active_match_index {
686 if let Some(searchable_item) = self.active_searchable_item.as_ref() {
687 if let Some(matches) = self
688 .searchable_items_with_matches
689 .get(&searchable_item.downgrade())
690 {
691 let new_match_index = searchable_item
692 .match_index_for_direction(matches, index, direction, count, cx);
693 searchable_item.update_matches(matches, cx);
694 searchable_item.activate_match(new_match_index, matches, cx);
695 }
696 }
697 }
698 }
699
700 pub fn select_last_match(&mut self, cx: &mut ViewContext<Self>) {
701 if let Some(searchable_item) = self.active_searchable_item.as_ref() {
702 if let Some(matches) = self
703 .searchable_items_with_matches
704 .get(&searchable_item.downgrade())
705 {
706 if matches.len() == 0 {
707 return;
708 }
709 let new_match_index = matches.len() - 1;
710 searchable_item.update_matches(matches, cx);
711 searchable_item.activate_match(new_match_index, matches, cx);
712 }
713 }
714 }
715
716 fn select_next_match_on_pane(
717 pane: &mut Pane,
718 action: &SelectNextMatch,
719 cx: &mut ViewContext<Pane>,
720 ) {
721 if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
722 search_bar.update(cx, |bar, cx| bar.select_next_match(action, cx));
723 }
724 }
725
726 fn select_prev_match_on_pane(
727 pane: &mut Pane,
728 action: &SelectPrevMatch,
729 cx: &mut ViewContext<Pane>,
730 ) {
731 if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
732 search_bar.update(cx, |bar, cx| bar.select_prev_match(action, cx));
733 }
734 }
735
736 fn select_all_matches_on_pane(
737 pane: &mut Pane,
738 action: &SelectAllMatches,
739 cx: &mut ViewContext<Pane>,
740 ) {
741 if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
742 search_bar.update(cx, |bar, cx| bar.select_all_matches(action, cx));
743 }
744 }
745
746 fn on_query_editor_event(
747 &mut self,
748 _: ViewHandle<Editor>,
749 event: &editor::Event,
750 cx: &mut ViewContext<Self>,
751 ) {
752 if let editor::Event::Edited { .. } = event {
753 self.query_contains_error = false;
754 self.clear_matches(cx);
755 let search = self.update_matches(cx);
756 cx.spawn(|this, mut cx| async move {
757 search.await?;
758 this.update(&mut cx, |this, cx| this.activate_current_match(cx))
759 })
760 .detach_and_log_err(cx);
761 }
762 }
763
764 fn on_active_searchable_item_event(&mut self, event: SearchEvent, cx: &mut ViewContext<Self>) {
765 match event {
766 SearchEvent::MatchesInvalidated => {
767 let _ = self.update_matches(cx);
768 }
769 SearchEvent::ActiveMatchChanged => self.update_match_index(cx),
770 }
771 }
772
773 fn clear_matches(&mut self, cx: &mut ViewContext<Self>) {
774 let mut active_item_matches = None;
775 for (searchable_item, matches) in self.searchable_items_with_matches.drain() {
776 if let Some(searchable_item) =
777 WeakSearchableItemHandle::upgrade(searchable_item.as_ref(), cx)
778 {
779 if Some(&searchable_item) == self.active_searchable_item.as_ref() {
780 active_item_matches = Some((searchable_item.downgrade(), matches));
781 } else {
782 searchable_item.clear_matches(cx);
783 }
784 }
785 }
786
787 self.searchable_items_with_matches
788 .extend(active_item_matches);
789 }
790
791 fn update_matches(&mut self, cx: &mut ViewContext<Self>) -> oneshot::Receiver<()> {
792 let (done_tx, done_rx) = oneshot::channel();
793 let query = self.query(cx);
794 self.pending_search.take();
795
796 if let Some(active_searchable_item) = self.active_searchable_item.as_ref() {
797 if query.is_empty() {
798 self.active_match_index.take();
799 active_searchable_item.clear_matches(cx);
800 let _ = done_tx.send(());
801 cx.notify();
802 } else {
803 let query: Arc<_> = if self.current_mode == SearchMode::Regex {
804 match SearchQuery::regex(
805 query,
806 self.search_options.contains(SearchOptions::WHOLE_WORD),
807 self.search_options.contains(SearchOptions::CASE_SENSITIVE),
808 Vec::new(),
809 Vec::new(),
810 ) {
811 Ok(query) => query.with_replacement(self.replacement(cx)),
812 Err(_) => {
813 self.query_contains_error = true;
814 cx.notify();
815 return done_rx;
816 }
817 }
818 } else {
819 match SearchQuery::text(
820 query,
821 self.search_options.contains(SearchOptions::WHOLE_WORD),
822 self.search_options.contains(SearchOptions::CASE_SENSITIVE),
823 Vec::new(),
824 Vec::new(),
825 ) {
826 Ok(query) => query.with_replacement(self.replacement(cx)),
827 Err(_) => {
828 self.query_contains_error = true;
829 cx.notify();
830 return done_rx;
831 }
832 }
833 }
834 .into();
835 self.active_search = Some(query.clone());
836 let query_text = query.as_str().to_string();
837 let matches = active_searchable_item.find_matches(query, cx);
838
839 let active_searchable_item = active_searchable_item.downgrade();
840 self.pending_search = Some(cx.spawn(|this, mut cx| async move {
841 let matches = matches.await;
842 this.update(&mut cx, |this, cx| {
843 if let Some(active_searchable_item) =
844 WeakSearchableItemHandle::upgrade(active_searchable_item.as_ref(), cx)
845 {
846 this.searchable_items_with_matches
847 .insert(active_searchable_item.downgrade(), matches);
848
849 this.update_match_index(cx);
850 this.search_history.add(query_text);
851 if !this.dismissed {
852 let matches = this
853 .searchable_items_with_matches
854 .get(&active_searchable_item.downgrade())
855 .unwrap();
856 active_searchable_item.update_matches(matches, cx);
857 let _ = done_tx.send(());
858 }
859 cx.notify();
860 }
861 })
862 .log_err();
863 }));
864 }
865 }
866 done_rx
867 }
868
869 fn update_match_index(&mut self, cx: &mut ViewContext<Self>) {
870 let new_index = self
871 .active_searchable_item
872 .as_ref()
873 .and_then(|searchable_item| {
874 let matches = self
875 .searchable_items_with_matches
876 .get(&searchable_item.downgrade())?;
877 searchable_item.active_match_index(matches, cx)
878 });
879 if new_index != self.active_match_index {
880 self.active_match_index = new_index;
881 cx.notify();
882 }
883 }
884
885 fn next_history_query(&mut self, _: &NextHistoryQuery, cx: &mut ViewContext<Self>) {
886 if let Some(new_query) = self.search_history.next().map(str::to_string) {
887 let _ = self.search(&new_query, Some(self.search_options), cx);
888 } else {
889 self.search_history.reset_selection();
890 let _ = self.search("", Some(self.search_options), cx);
891 }
892 }
893
894 fn previous_history_query(&mut self, _: &PreviousHistoryQuery, cx: &mut ViewContext<Self>) {
895 if self.query(cx).is_empty() {
896 if let Some(new_query) = self.search_history.current().map(str::to_string) {
897 let _ = self.search(&new_query, Some(self.search_options), cx);
898 return;
899 }
900 }
901
902 if let Some(new_query) = self.search_history.previous().map(str::to_string) {
903 let _ = self.search(&new_query, Some(self.search_options), cx);
904 }
905 }
906 fn cycle_mode(&mut self, _: &CycleMode, cx: &mut ViewContext<Self>) {
907 self.activate_search_mode(next_mode(&self.current_mode, false), cx);
908 }
909 fn cycle_mode_on_pane(pane: &mut Pane, action: &CycleMode, cx: &mut ViewContext<Pane>) {
910 let mut should_propagate = true;
911 if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
912 search_bar.update(cx, |bar, cx| {
913 if bar.show(cx) {
914 should_propagate = false;
915 bar.cycle_mode(action, cx);
916 false
917 } else {
918 true
919 }
920 });
921 }
922 if should_propagate {
923 cx.propagate_action();
924 }
925 }
926 fn toggle_replace(&mut self, _: &ToggleReplace, cx: &mut ViewContext<Self>) {
927 if let Some(_) = &self.active_searchable_item {
928 self.replace_enabled = !self.replace_enabled;
929 if !self.replace_enabled {
930 cx.focus(&self.query_editor);
931 }
932 cx.notify();
933 }
934 }
935 fn toggle_replace_on_a_pane(pane: &mut Pane, _: &ToggleReplace, cx: &mut ViewContext<Pane>) {
936 let mut should_propagate = true;
937 if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
938 search_bar.update(cx, |bar, cx| {
939 if let Some(_) = &bar.active_searchable_item {
940 should_propagate = false;
941 bar.replace_enabled = !bar.replace_enabled;
942 if bar.dismissed {
943 bar.show(cx);
944 }
945 if !bar.replace_enabled {
946 cx.focus(&bar.query_editor);
947 }
948 cx.notify();
949 }
950 });
951 }
952 if should_propagate {
953 cx.propagate_action();
954 }
955 }
956 fn replace_next(&mut self, _: &ReplaceNext, cx: &mut ViewContext<Self>) {
957 let mut should_propagate = true;
958 if !self.dismissed && self.active_search.is_some() {
959 if let Some(searchable_item) = self.active_searchable_item.as_ref() {
960 if let Some(query) = self.active_search.as_ref() {
961 if let Some(matches) = self
962 .searchable_items_with_matches
963 .get(&searchable_item.downgrade())
964 {
965 if let Some(active_index) = self.active_match_index {
966 let query = query
967 .as_ref()
968 .clone()
969 .with_replacement(self.replacement(cx));
970 searchable_item.replace(&matches[active_index], &query, cx);
971 self.select_next_match(&SelectNextMatch, cx);
972 }
973 should_propagate = false;
974 self.focus_editor(&FocusEditor, cx);
975 }
976 }
977 }
978 }
979 if should_propagate {
980 cx.propagate_action();
981 }
982 }
983 pub fn replace_all(&mut self, _: &ReplaceAll, cx: &mut ViewContext<Self>) {
984 if !self.dismissed && self.active_search.is_some() {
985 if let Some(searchable_item) = self.active_searchable_item.as_ref() {
986 if let Some(query) = self.active_search.as_ref() {
987 if let Some(matches) = self
988 .searchable_items_with_matches
989 .get(&searchable_item.downgrade())
990 {
991 let query = query
992 .as_ref()
993 .clone()
994 .with_replacement(self.replacement(cx));
995 for m in matches {
996 searchable_item.replace(m, &query, cx);
997 }
998 }
999 }
1000 }
1001 }
1002 }
1003 fn replace_next_on_pane(pane: &mut Pane, action: &ReplaceNext, cx: &mut ViewContext<Pane>) {
1004 if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
1005 search_bar.update(cx, |bar, cx| bar.replace_next(action, cx));
1006 return;
1007 }
1008 cx.propagate_action();
1009 }
1010 fn replace_all_on_pane(pane: &mut Pane, action: &ReplaceAll, cx: &mut ViewContext<Pane>) {
1011 if let Some(search_bar) = pane.toolbar().read(cx).item_of_type::<BufferSearchBar>() {
1012 search_bar.update(cx, |bar, cx| bar.replace_all(action, cx));
1013 return;
1014 }
1015 cx.propagate_action();
1016 }
1017}
1018
1019#[cfg(test)]
1020mod tests {
1021 use super::*;
1022 use editor::{DisplayPoint, Editor};
1023 use gpui::{color::Color, test::EmptyView, TestAppContext};
1024 use language::Buffer;
1025 use unindent::Unindent as _;
1026
1027 fn init_test(cx: &mut TestAppContext) -> (ViewHandle<Editor>, ViewHandle<BufferSearchBar>) {
1028 crate::project_search::tests::init_test(cx);
1029
1030 let buffer = cx.add_model(|cx| {
1031 Buffer::new(
1032 0,
1033 cx.model_id() as u64,
1034 r#"
1035 A regular expression (shortened as regex or regexp;[1] also referred to as
1036 rational expression[2][3]) is a sequence of characters that specifies a search
1037 pattern in text. Usually such patterns are used by string-searching algorithms
1038 for "find" or "find and replace" operations on strings, or for input validation.
1039 "#
1040 .unindent(),
1041 )
1042 });
1043 let window = cx.add_window(|_| EmptyView);
1044 let editor = window.add_view(cx, |cx| Editor::for_buffer(buffer.clone(), None, cx));
1045
1046 let search_bar = window.add_view(cx, |cx| {
1047 let mut search_bar = BufferSearchBar::new(cx);
1048 search_bar.set_active_pane_item(Some(&editor), cx);
1049 search_bar.show(cx);
1050 search_bar
1051 });
1052
1053 (editor, search_bar)
1054 }
1055
1056 #[gpui::test]
1057 async fn test_search_simple(cx: &mut TestAppContext) {
1058 let (editor, search_bar) = init_test(cx);
1059
1060 // Search for a string that appears with different casing.
1061 // By default, search is case-insensitive.
1062 search_bar
1063 .update(cx, |search_bar, cx| search_bar.search("us", None, cx))
1064 .await
1065 .unwrap();
1066 editor.update(cx, |editor, cx| {
1067 assert_eq!(
1068 editor.all_text_background_highlights(cx),
1069 &[
1070 (
1071 DisplayPoint::new(2, 17)..DisplayPoint::new(2, 19),
1072 Color::red(),
1073 ),
1074 (
1075 DisplayPoint::new(2, 43)..DisplayPoint::new(2, 45),
1076 Color::red(),
1077 ),
1078 ]
1079 );
1080 });
1081
1082 // Switch to a case sensitive search.
1083 search_bar.update(cx, |search_bar, cx| {
1084 search_bar.toggle_search_option(SearchOptions::CASE_SENSITIVE, cx);
1085 });
1086 editor.next_notification(cx).await;
1087 editor.update(cx, |editor, cx| {
1088 assert_eq!(
1089 editor.all_text_background_highlights(cx),
1090 &[(
1091 DisplayPoint::new(2, 43)..DisplayPoint::new(2, 45),
1092 Color::red(),
1093 )]
1094 );
1095 });
1096
1097 // Search for a string that appears both as a whole word and
1098 // within other words. By default, all results are found.
1099 search_bar
1100 .update(cx, |search_bar, cx| search_bar.search("or", None, cx))
1101 .await
1102 .unwrap();
1103 editor.update(cx, |editor, cx| {
1104 assert_eq!(
1105 editor.all_text_background_highlights(cx),
1106 &[
1107 (
1108 DisplayPoint::new(0, 24)..DisplayPoint::new(0, 26),
1109 Color::red(),
1110 ),
1111 (
1112 DisplayPoint::new(0, 41)..DisplayPoint::new(0, 43),
1113 Color::red(),
1114 ),
1115 (
1116 DisplayPoint::new(2, 71)..DisplayPoint::new(2, 73),
1117 Color::red(),
1118 ),
1119 (
1120 DisplayPoint::new(3, 1)..DisplayPoint::new(3, 3),
1121 Color::red(),
1122 ),
1123 (
1124 DisplayPoint::new(3, 11)..DisplayPoint::new(3, 13),
1125 Color::red(),
1126 ),
1127 (
1128 DisplayPoint::new(3, 56)..DisplayPoint::new(3, 58),
1129 Color::red(),
1130 ),
1131 (
1132 DisplayPoint::new(3, 60)..DisplayPoint::new(3, 62),
1133 Color::red(),
1134 ),
1135 ]
1136 );
1137 });
1138
1139 // Switch to a whole word search.
1140 search_bar.update(cx, |search_bar, cx| {
1141 search_bar.toggle_search_option(SearchOptions::WHOLE_WORD, cx);
1142 });
1143 editor.next_notification(cx).await;
1144 editor.update(cx, |editor, cx| {
1145 assert_eq!(
1146 editor.all_text_background_highlights(cx),
1147 &[
1148 (
1149 DisplayPoint::new(0, 41)..DisplayPoint::new(0, 43),
1150 Color::red(),
1151 ),
1152 (
1153 DisplayPoint::new(3, 11)..DisplayPoint::new(3, 13),
1154 Color::red(),
1155 ),
1156 (
1157 DisplayPoint::new(3, 56)..DisplayPoint::new(3, 58),
1158 Color::red(),
1159 ),
1160 ]
1161 );
1162 });
1163
1164 editor.update(cx, |editor, cx| {
1165 editor.change_selections(None, cx, |s| {
1166 s.select_display_ranges([DisplayPoint::new(0, 0)..DisplayPoint::new(0, 0)])
1167 });
1168 });
1169 search_bar.update(cx, |search_bar, cx| {
1170 assert_eq!(search_bar.active_match_index, Some(0));
1171 search_bar.select_next_match(&SelectNextMatch, cx);
1172 assert_eq!(
1173 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1174 [DisplayPoint::new(0, 41)..DisplayPoint::new(0, 43)]
1175 );
1176 });
1177 search_bar.read_with(cx, |search_bar, _| {
1178 assert_eq!(search_bar.active_match_index, Some(0));
1179 });
1180
1181 search_bar.update(cx, |search_bar, cx| {
1182 search_bar.select_next_match(&SelectNextMatch, cx);
1183 assert_eq!(
1184 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1185 [DisplayPoint::new(3, 11)..DisplayPoint::new(3, 13)]
1186 );
1187 });
1188 search_bar.read_with(cx, |search_bar, _| {
1189 assert_eq!(search_bar.active_match_index, Some(1));
1190 });
1191
1192 search_bar.update(cx, |search_bar, cx| {
1193 search_bar.select_next_match(&SelectNextMatch, cx);
1194 assert_eq!(
1195 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1196 [DisplayPoint::new(3, 56)..DisplayPoint::new(3, 58)]
1197 );
1198 });
1199 search_bar.read_with(cx, |search_bar, _| {
1200 assert_eq!(search_bar.active_match_index, Some(2));
1201 });
1202
1203 search_bar.update(cx, |search_bar, cx| {
1204 search_bar.select_next_match(&SelectNextMatch, cx);
1205 assert_eq!(
1206 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1207 [DisplayPoint::new(0, 41)..DisplayPoint::new(0, 43)]
1208 );
1209 });
1210 search_bar.read_with(cx, |search_bar, _| {
1211 assert_eq!(search_bar.active_match_index, Some(0));
1212 });
1213
1214 search_bar.update(cx, |search_bar, cx| {
1215 search_bar.select_prev_match(&SelectPrevMatch, cx);
1216 assert_eq!(
1217 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1218 [DisplayPoint::new(3, 56)..DisplayPoint::new(3, 58)]
1219 );
1220 });
1221 search_bar.read_with(cx, |search_bar, _| {
1222 assert_eq!(search_bar.active_match_index, Some(2));
1223 });
1224
1225 search_bar.update(cx, |search_bar, cx| {
1226 search_bar.select_prev_match(&SelectPrevMatch, cx);
1227 assert_eq!(
1228 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1229 [DisplayPoint::new(3, 11)..DisplayPoint::new(3, 13)]
1230 );
1231 });
1232 search_bar.read_with(cx, |search_bar, _| {
1233 assert_eq!(search_bar.active_match_index, Some(1));
1234 });
1235
1236 search_bar.update(cx, |search_bar, cx| {
1237 search_bar.select_prev_match(&SelectPrevMatch, cx);
1238 assert_eq!(
1239 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1240 [DisplayPoint::new(0, 41)..DisplayPoint::new(0, 43)]
1241 );
1242 });
1243 search_bar.read_with(cx, |search_bar, _| {
1244 assert_eq!(search_bar.active_match_index, Some(0));
1245 });
1246
1247 // Park the cursor in between matches and ensure that going to the previous match selects
1248 // the closest match to the left.
1249 editor.update(cx, |editor, cx| {
1250 editor.change_selections(None, cx, |s| {
1251 s.select_display_ranges([DisplayPoint::new(1, 0)..DisplayPoint::new(1, 0)])
1252 });
1253 });
1254 search_bar.update(cx, |search_bar, cx| {
1255 assert_eq!(search_bar.active_match_index, Some(1));
1256 search_bar.select_prev_match(&SelectPrevMatch, cx);
1257 assert_eq!(
1258 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1259 [DisplayPoint::new(0, 41)..DisplayPoint::new(0, 43)]
1260 );
1261 });
1262 search_bar.read_with(cx, |search_bar, _| {
1263 assert_eq!(search_bar.active_match_index, Some(0));
1264 });
1265
1266 // Park the cursor in between matches and ensure that going to the next match selects the
1267 // closest match to the right.
1268 editor.update(cx, |editor, cx| {
1269 editor.change_selections(None, cx, |s| {
1270 s.select_display_ranges([DisplayPoint::new(1, 0)..DisplayPoint::new(1, 0)])
1271 });
1272 });
1273 search_bar.update(cx, |search_bar, cx| {
1274 assert_eq!(search_bar.active_match_index, Some(1));
1275 search_bar.select_next_match(&SelectNextMatch, cx);
1276 assert_eq!(
1277 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1278 [DisplayPoint::new(3, 11)..DisplayPoint::new(3, 13)]
1279 );
1280 });
1281 search_bar.read_with(cx, |search_bar, _| {
1282 assert_eq!(search_bar.active_match_index, Some(1));
1283 });
1284
1285 // Park the cursor after the last match and ensure that going to the previous match selects
1286 // the last match.
1287 editor.update(cx, |editor, cx| {
1288 editor.change_selections(None, cx, |s| {
1289 s.select_display_ranges([DisplayPoint::new(3, 60)..DisplayPoint::new(3, 60)])
1290 });
1291 });
1292 search_bar.update(cx, |search_bar, cx| {
1293 assert_eq!(search_bar.active_match_index, Some(2));
1294 search_bar.select_prev_match(&SelectPrevMatch, cx);
1295 assert_eq!(
1296 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1297 [DisplayPoint::new(3, 56)..DisplayPoint::new(3, 58)]
1298 );
1299 });
1300 search_bar.read_with(cx, |search_bar, _| {
1301 assert_eq!(search_bar.active_match_index, Some(2));
1302 });
1303
1304 // Park the cursor after the last match and ensure that going to the next match selects the
1305 // first match.
1306 editor.update(cx, |editor, cx| {
1307 editor.change_selections(None, cx, |s| {
1308 s.select_display_ranges([DisplayPoint::new(3, 60)..DisplayPoint::new(3, 60)])
1309 });
1310 });
1311 search_bar.update(cx, |search_bar, cx| {
1312 assert_eq!(search_bar.active_match_index, Some(2));
1313 search_bar.select_next_match(&SelectNextMatch, cx);
1314 assert_eq!(
1315 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1316 [DisplayPoint::new(0, 41)..DisplayPoint::new(0, 43)]
1317 );
1318 });
1319 search_bar.read_with(cx, |search_bar, _| {
1320 assert_eq!(search_bar.active_match_index, Some(0));
1321 });
1322
1323 // Park the cursor before the first match and ensure that going to the previous match
1324 // selects the last match.
1325 editor.update(cx, |editor, cx| {
1326 editor.change_selections(None, cx, |s| {
1327 s.select_display_ranges([DisplayPoint::new(0, 0)..DisplayPoint::new(0, 0)])
1328 });
1329 });
1330 search_bar.update(cx, |search_bar, cx| {
1331 assert_eq!(search_bar.active_match_index, Some(0));
1332 search_bar.select_prev_match(&SelectPrevMatch, cx);
1333 assert_eq!(
1334 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx)),
1335 [DisplayPoint::new(3, 56)..DisplayPoint::new(3, 58)]
1336 );
1337 });
1338 search_bar.read_with(cx, |search_bar, _| {
1339 assert_eq!(search_bar.active_match_index, Some(2));
1340 });
1341 }
1342
1343 #[gpui::test]
1344 async fn test_search_option_handling(cx: &mut TestAppContext) {
1345 let (editor, search_bar) = init_test(cx);
1346
1347 // show with options should make current search case sensitive
1348 search_bar
1349 .update(cx, |search_bar, cx| {
1350 search_bar.show(cx);
1351 search_bar.search("us", Some(SearchOptions::CASE_SENSITIVE), cx)
1352 })
1353 .await
1354 .unwrap();
1355 editor.update(cx, |editor, cx| {
1356 assert_eq!(
1357 editor.all_text_background_highlights(cx),
1358 &[(
1359 DisplayPoint::new(2, 43)..DisplayPoint::new(2, 45),
1360 Color::red(),
1361 )]
1362 );
1363 });
1364
1365 // search_suggested should restore default options
1366 search_bar.update(cx, |search_bar, cx| {
1367 search_bar.search_suggested(cx);
1368 assert_eq!(search_bar.search_options, SearchOptions::NONE)
1369 });
1370
1371 // toggling a search option should update the defaults
1372 search_bar
1373 .update(cx, |search_bar, cx| {
1374 search_bar.search("regex", Some(SearchOptions::CASE_SENSITIVE), cx)
1375 })
1376 .await
1377 .unwrap();
1378 search_bar.update(cx, |search_bar, cx| {
1379 search_bar.toggle_search_option(SearchOptions::WHOLE_WORD, cx)
1380 });
1381 editor.next_notification(cx).await;
1382 editor.update(cx, |editor, cx| {
1383 assert_eq!(
1384 editor.all_text_background_highlights(cx),
1385 &[(
1386 DisplayPoint::new(0, 35)..DisplayPoint::new(0, 40),
1387 Color::red(),
1388 ),]
1389 );
1390 });
1391
1392 // defaults should still include whole word
1393 search_bar.update(cx, |search_bar, cx| {
1394 search_bar.search_suggested(cx);
1395 assert_eq!(
1396 search_bar.search_options,
1397 SearchOptions::CASE_SENSITIVE | SearchOptions::WHOLE_WORD
1398 )
1399 });
1400 }
1401
1402 #[gpui::test]
1403 async fn test_search_select_all_matches(cx: &mut TestAppContext) {
1404 crate::project_search::tests::init_test(cx);
1405
1406 let buffer_text = r#"
1407 A regular expression (shortened as regex or regexp;[1] also referred to as
1408 rational expression[2][3]) is a sequence of characters that specifies a search
1409 pattern in text. Usually such patterns are used by string-searching algorithms
1410 for "find" or "find and replace" operations on strings, or for input validation.
1411 "#
1412 .unindent();
1413 let expected_query_matches_count = buffer_text
1414 .chars()
1415 .filter(|c| c.to_ascii_lowercase() == 'a')
1416 .count();
1417 assert!(
1418 expected_query_matches_count > 1,
1419 "Should pick a query with multiple results"
1420 );
1421 let buffer = cx.add_model(|cx| Buffer::new(0, cx.model_id() as u64, buffer_text));
1422 let window = cx.add_window(|_| EmptyView);
1423 let editor = window.add_view(cx, |cx| Editor::for_buffer(buffer.clone(), None, cx));
1424
1425 let search_bar = window.add_view(cx, |cx| {
1426 let mut search_bar = BufferSearchBar::new(cx);
1427 search_bar.set_active_pane_item(Some(&editor), cx);
1428 search_bar.show(cx);
1429 search_bar
1430 });
1431
1432 search_bar
1433 .update(cx, |search_bar, cx| search_bar.search("a", None, cx))
1434 .await
1435 .unwrap();
1436 search_bar.update(cx, |search_bar, cx| {
1437 cx.focus(search_bar.query_editor.as_any());
1438 search_bar.activate_current_match(cx);
1439 });
1440
1441 window.read_with(cx, |cx| {
1442 assert!(
1443 !editor.is_focused(cx),
1444 "Initially, the editor should not be focused"
1445 );
1446 });
1447
1448 let initial_selections = editor.update(cx, |editor, cx| {
1449 let initial_selections = editor.selections.display_ranges(cx);
1450 assert_eq!(
1451 initial_selections.len(), 1,
1452 "Expected to have only one selection before adding carets to all matches, but got: {initial_selections:?}",
1453 );
1454 initial_selections
1455 });
1456 search_bar.update(cx, |search_bar, _| {
1457 assert_eq!(search_bar.active_match_index, Some(0));
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(0),
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_next_match(&SelectNextMatch, cx);
1487 });
1488 window.read_with(cx, |cx| {
1489 assert!(
1490 editor.is_focused(cx),
1491 "Should still have editor focused after SelectNextMatch"
1492 );
1493 });
1494 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 next match, should deselect items and select the next match"
1501 );
1502 assert_ne!(
1503 all_selections, initial_selections,
1504 "Next match should be different from the first selection"
1505 );
1506 assert_eq!(
1507 search_bar.active_match_index,
1508 Some(1),
1509 "Match index should be updated to the next one"
1510 );
1511 });
1512
1513 search_bar.update(cx, |search_bar, cx| {
1514 cx.focus(search_bar.query_editor.as_any());
1515 search_bar.select_all_matches(&SelectAllMatches, cx);
1516 });
1517 window.read_with(cx, |cx| {
1518 assert!(
1519 editor.is_focused(cx),
1520 "Should focus editor after successful SelectAllMatches"
1521 );
1522 });
1523 search_bar.update(cx, |search_bar, cx| {
1524 let all_selections =
1525 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx));
1526 assert_eq!(
1527 all_selections.len(),
1528 expected_query_matches_count,
1529 "Should select all `a` characters in the buffer, but got: {all_selections:?}"
1530 );
1531 assert_eq!(
1532 search_bar.active_match_index,
1533 Some(1),
1534 "Match index should not change after selecting all matches"
1535 );
1536 });
1537
1538 search_bar.update(cx, |search_bar, cx| {
1539 search_bar.select_prev_match(&SelectPrevMatch, cx);
1540 });
1541 window.read_with(cx, |cx| {
1542 assert!(
1543 editor.is_focused(cx),
1544 "Should still have editor focused after SelectPrevMatch"
1545 );
1546 });
1547 let last_match_selections = search_bar.update(cx, |search_bar, cx| {
1548 let all_selections =
1549 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx));
1550 assert_eq!(
1551 all_selections.len(),
1552 1,
1553 "On previous match, should deselect items and select the previous item"
1554 );
1555 assert_eq!(
1556 all_selections, initial_selections,
1557 "Previous match should be the same as the first selection"
1558 );
1559 assert_eq!(
1560 search_bar.active_match_index,
1561 Some(0),
1562 "Match index should be updated to the previous one"
1563 );
1564 all_selections
1565 });
1566
1567 search_bar
1568 .update(cx, |search_bar, cx| {
1569 cx.focus(search_bar.query_editor.as_any());
1570 search_bar.search("abas_nonexistent_match", None, cx)
1571 })
1572 .await
1573 .unwrap();
1574 search_bar.update(cx, |search_bar, cx| {
1575 search_bar.select_all_matches(&SelectAllMatches, cx);
1576 });
1577 window.read_with(cx, |cx| {
1578 assert!(
1579 !editor.is_focused(cx),
1580 "Should not switch focus to editor if SelectAllMatches does not find any matches"
1581 );
1582 });
1583 search_bar.update(cx, |search_bar, cx| {
1584 let all_selections =
1585 editor.update(cx, |editor, cx| editor.selections.display_ranges(cx));
1586 assert_eq!(
1587 all_selections, last_match_selections,
1588 "Should not select anything new if there are no matches"
1589 );
1590 assert!(
1591 search_bar.active_match_index.is_none(),
1592 "For no matches, there should be no active match index"
1593 );
1594 });
1595 }
1596
1597 #[gpui::test]
1598 async fn test_search_query_history(cx: &mut TestAppContext) {
1599 crate::project_search::tests::init_test(cx);
1600
1601 let buffer_text = r#"
1602 A regular expression (shortened as regex or regexp;[1] also referred to as
1603 rational expression[2][3]) is a sequence of characters that specifies a search
1604 pattern in text. Usually such patterns are used by string-searching algorithms
1605 for "find" or "find and replace" operations on strings, or for input validation.
1606 "#
1607 .unindent();
1608 let buffer = cx.add_model(|cx| Buffer::new(0, cx.model_id() as u64, buffer_text));
1609 let window = cx.add_window(|_| EmptyView);
1610
1611 let editor = window.add_view(cx, |cx| Editor::for_buffer(buffer.clone(), None, cx));
1612
1613 let search_bar = window.add_view(cx, |cx| {
1614 let mut search_bar = BufferSearchBar::new(cx);
1615 search_bar.set_active_pane_item(Some(&editor), cx);
1616 search_bar.show(cx);
1617 search_bar
1618 });
1619
1620 // Add 3 search items into the history.
1621 search_bar
1622 .update(cx, |search_bar, cx| search_bar.search("a", None, cx))
1623 .await
1624 .unwrap();
1625 search_bar
1626 .update(cx, |search_bar, cx| search_bar.search("b", None, cx))
1627 .await
1628 .unwrap();
1629 search_bar
1630 .update(cx, |search_bar, cx| {
1631 search_bar.search("c", Some(SearchOptions::CASE_SENSITIVE), cx)
1632 })
1633 .await
1634 .unwrap();
1635 // Ensure that the latest search is active.
1636 search_bar.read_with(cx, |search_bar, cx| {
1637 assert_eq!(search_bar.query(cx), "c");
1638 assert_eq!(search_bar.search_options, SearchOptions::CASE_SENSITIVE);
1639 });
1640
1641 // Next history query after the latest should set the query to the empty string.
1642 search_bar.update(cx, |search_bar, cx| {
1643 search_bar.next_history_query(&NextHistoryQuery, cx);
1644 });
1645 search_bar.read_with(cx, |search_bar, cx| {
1646 assert_eq!(search_bar.query(cx), "");
1647 assert_eq!(search_bar.search_options, SearchOptions::CASE_SENSITIVE);
1648 });
1649 search_bar.update(cx, |search_bar, cx| {
1650 search_bar.next_history_query(&NextHistoryQuery, cx);
1651 });
1652 search_bar.read_with(cx, |search_bar, cx| {
1653 assert_eq!(search_bar.query(cx), "");
1654 assert_eq!(search_bar.search_options, SearchOptions::CASE_SENSITIVE);
1655 });
1656
1657 // First previous query for empty current query should set the query to the latest.
1658 search_bar.update(cx, |search_bar, cx| {
1659 search_bar.previous_history_query(&PreviousHistoryQuery, cx);
1660 });
1661 search_bar.read_with(cx, |search_bar, cx| {
1662 assert_eq!(search_bar.query(cx), "c");
1663 assert_eq!(search_bar.search_options, SearchOptions::CASE_SENSITIVE);
1664 });
1665
1666 // Further previous items should go over the history in reverse order.
1667 search_bar.update(cx, |search_bar, cx| {
1668 search_bar.previous_history_query(&PreviousHistoryQuery, cx);
1669 });
1670 search_bar.read_with(cx, |search_bar, cx| {
1671 assert_eq!(search_bar.query(cx), "b");
1672 assert_eq!(search_bar.search_options, SearchOptions::CASE_SENSITIVE);
1673 });
1674
1675 // Previous items should never go behind the first history item.
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), "a");
1681 assert_eq!(search_bar.search_options, SearchOptions::CASE_SENSITIVE);
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), "a");
1688 assert_eq!(search_bar.search_options, SearchOptions::CASE_SENSITIVE);
1689 });
1690
1691 // Next items should go over the history in the original order.
1692 search_bar.update(cx, |search_bar, cx| {
1693 search_bar.next_history_query(&NextHistoryQuery, cx);
1694 });
1695 search_bar.read_with(cx, |search_bar, cx| {
1696 assert_eq!(search_bar.query(cx), "b");
1697 assert_eq!(search_bar.search_options, SearchOptions::CASE_SENSITIVE);
1698 });
1699
1700 search_bar
1701 .update(cx, |search_bar, cx| search_bar.search("ba", None, cx))
1702 .await
1703 .unwrap();
1704 search_bar.read_with(cx, |search_bar, cx| {
1705 assert_eq!(search_bar.query(cx), "ba");
1706 assert_eq!(search_bar.search_options, SearchOptions::NONE);
1707 });
1708
1709 // New search input should add another entry to history and move the selection to the end of the history.
1710 search_bar.update(cx, |search_bar, cx| {
1711 search_bar.previous_history_query(&PreviousHistoryQuery, cx);
1712 });
1713 search_bar.read_with(cx, |search_bar, cx| {
1714 assert_eq!(search_bar.query(cx), "c");
1715 assert_eq!(search_bar.search_options, SearchOptions::NONE);
1716 });
1717 search_bar.update(cx, |search_bar, cx| {
1718 search_bar.previous_history_query(&PreviousHistoryQuery, cx);
1719 });
1720 search_bar.read_with(cx, |search_bar, cx| {
1721 assert_eq!(search_bar.query(cx), "b");
1722 assert_eq!(search_bar.search_options, SearchOptions::NONE);
1723 });
1724 search_bar.update(cx, |search_bar, cx| {
1725 search_bar.next_history_query(&NextHistoryQuery, cx);
1726 });
1727 search_bar.read_with(cx, |search_bar, cx| {
1728 assert_eq!(search_bar.query(cx), "c");
1729 assert_eq!(search_bar.search_options, SearchOptions::NONE);
1730 });
1731 search_bar.update(cx, |search_bar, cx| {
1732 search_bar.next_history_query(&NextHistoryQuery, cx);
1733 });
1734 search_bar.read_with(cx, |search_bar, cx| {
1735 assert_eq!(search_bar.query(cx), "ba");
1736 assert_eq!(search_bar.search_options, SearchOptions::NONE);
1737 });
1738 search_bar.update(cx, |search_bar, cx| {
1739 search_bar.next_history_query(&NextHistoryQuery, cx);
1740 });
1741 search_bar.read_with(cx, |search_bar, cx| {
1742 assert_eq!(search_bar.query(cx), "");
1743 assert_eq!(search_bar.search_options, SearchOptions::NONE);
1744 });
1745 }
1746 #[gpui::test]
1747 async fn test_replace_simple(cx: &mut TestAppContext) {
1748 let (editor, search_bar) = init_test(cx);
1749
1750 search_bar
1751 .update(cx, |search_bar, cx| {
1752 search_bar.search("expression", None, cx)
1753 })
1754 .await
1755 .unwrap();
1756
1757 search_bar.update(cx, |search_bar, cx| {
1758 search_bar.replacement_editor.update(cx, |editor, cx| {
1759 // We use $1 here as initially we should be in Text mode, where `$1` should be treated literally.
1760 editor.set_text("expr$1", cx);
1761 });
1762 search_bar.replace_all(&ReplaceAll, cx)
1763 });
1764 assert_eq!(
1765 editor.read_with(cx, |this, cx| { this.text(cx) }),
1766 r#"
1767 A regular expr$1 (shortened as regex or regexp;[1] also referred to as
1768 rational expr$1[2][3]) is a sequence of characters that specifies a search
1769 pattern in text. Usually such patterns are used by string-searching algorithms
1770 for "find" or "find and replace" operations on strings, or for input validation.
1771 "#
1772 .unindent()
1773 );
1774
1775 // Search for word boundaries and replace just a single one.
1776 search_bar
1777 .update(cx, |search_bar, cx| {
1778 search_bar.search("or", Some(SearchOptions::WHOLE_WORD), cx)
1779 })
1780 .await
1781 .unwrap();
1782
1783 search_bar.update(cx, |search_bar, cx| {
1784 search_bar.replacement_editor.update(cx, |editor, cx| {
1785 editor.set_text("banana", cx);
1786 });
1787 search_bar.replace_next(&ReplaceNext, cx)
1788 });
1789 // Notice how the first or in the text (shORtened) is not replaced. Neither are the remaining hits of `or` in the text.
1790 assert_eq!(
1791 editor.read_with(cx, |this, cx| { this.text(cx) }),
1792 r#"
1793 A regular expr$1 (shortened as regex banana regexp;[1] also referred to as
1794 rational expr$1[2][3]) is a sequence of characters that specifies a search
1795 pattern in text. Usually such patterns are used by string-searching algorithms
1796 for "find" or "find and replace" operations on strings, or for input validation.
1797 "#
1798 .unindent()
1799 );
1800 // Let's turn on regex mode.
1801 search_bar
1802 .update(cx, |search_bar, cx| {
1803 search_bar.activate_search_mode(SearchMode::Regex, cx);
1804 search_bar.search("\\[([^\\]]+)\\]", None, cx)
1805 })
1806 .await
1807 .unwrap();
1808 search_bar.update(cx, |search_bar, cx| {
1809 search_bar.replacement_editor.update(cx, |editor, cx| {
1810 editor.set_text("${1}number", cx);
1811 });
1812 search_bar.replace_all(&ReplaceAll, cx)
1813 });
1814 assert_eq!(
1815 editor.read_with(cx, |this, cx| { this.text(cx) }),
1816 r#"
1817 A regular expr$1 (shortened as regex banana regexp;1number also referred to as
1818 rational expr$12number3number) is a sequence of characters that specifies a search
1819 pattern in text. Usually such patterns are used by string-searching algorithms
1820 for "find" or "find and replace" operations on strings, or for input validation.
1821 "#
1822 .unindent()
1823 );
1824 // Now with a whole-word twist.
1825 search_bar
1826 .update(cx, |search_bar, cx| {
1827 search_bar.activate_search_mode(SearchMode::Regex, cx);
1828 search_bar.search("a\\w+s", Some(SearchOptions::WHOLE_WORD), cx)
1829 })
1830 .await
1831 .unwrap();
1832 search_bar.update(cx, |search_bar, cx| {
1833 search_bar.replacement_editor.update(cx, |editor, cx| {
1834 editor.set_text("things", cx);
1835 });
1836 search_bar.replace_all(&ReplaceAll, cx)
1837 });
1838 // The only word affected by this edit should be `algorithms`, even though there's a bunch
1839 // of words in this text that would match this regex if not for WHOLE_WORD.
1840 assert_eq!(
1841 editor.read_with(cx, |this, cx| { this.text(cx) }),
1842 r#"
1843 A regular expr$1 (shortened as regex banana regexp;1number also referred to as
1844 rational expr$12number3number) is a sequence of characters that specifies a search
1845 pattern in text. Usually such patterns are used by string-searching things
1846 for "find" or "find and replace" operations on strings, or for input validation.
1847 "#
1848 .unindent()
1849 );
1850 }
1851}