1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
use crate::align::{Align, HAlign, VAlign}; use crate::direction::Direction; use crate::event::{ Callback, Event, EventResult, Key, MouseButton, MouseEvent, }; use crate::menu::MenuTree; use crate::rect::Rect; use crate::theme::ColorStyle; use crate::utils::markup::StyledString; use crate::view::{Position, View}; use crate::views::MenuPopup; use crate::Cursive; use crate::Printer; use crate::Vec2; use crate::With; use std::borrow::Borrow; use std::cell::Cell; use std::cmp::{min, Ordering}; use std::rc::Rc; /// View to select an item among a list. /// /// It contains a list of values of type T, with associated labels. /// /// # Examples /// /// ```rust /// # use cursive_core::Cursive; /// # use cursive_core::views::{SelectView, Dialog, TextView}; /// # use cursive_core::align::HAlign; /// let mut time_select = SelectView::new().h_align(HAlign::Center); /// time_select.add_item("Short", 1); /// time_select.add_item("Medium", 5); /// time_select.add_item("Long", 10); /// /// time_select.set_on_submit(|s, time| { /// s.pop_layer(); /// let text = format!("You will wait for {} minutes...", time); /// s.add_layer( /// Dialog::around(TextView::new(text)).button("Quit", |s| s.quit()), /// ); /// }); /// /// let mut siv = Cursive::new(); /// siv.add_layer(Dialog::around(time_select).title("How long is your wait?")); /// ``` pub struct SelectView<T = String> { // The core of the view: we store a list of items // `Item` is more or less a `(String, Rc<T>)`. items: Vec<Item<T>>, // When disabled, we cannot change selection. enabled: bool, // Callbacks may need to manipulate focus, so give it some mutability. focus: Rc<Cell<usize>>, // This is a custom callback to include a &T. // It will be called whenever "Enter" is pressed or when an item is clicked. on_submit: Option<Rc<dyn Fn(&mut Cursive, &T)>>, // This callback is called when the selection is changed. // TODO: add the previous selection? Indices? on_select: Option<Rc<dyn Fn(&mut Cursive, &T)>>, // If `true`, when a character is pressed, jump to the next item starting // with this character. autojump: bool, align: Align, // `true` if we show a one-line view, with popup on selection. popup: bool, // We need the last offset to place the popup window // We "cache" it during the draw, so we need interior mutability. last_offset: Cell<Vec2>, last_size: Vec2, } impl<T: 'static> Default for SelectView<T> { fn default() -> Self { Self::new() } } impl<T: 'static> SelectView<T> { impl_enabled!(self.enabled); /// Creates a new empty SelectView. pub fn new() -> Self { SelectView { items: Vec::new(), enabled: true, focus: Rc::new(Cell::new(0)), on_select: None, on_submit: None, align: Align::top_left(), popup: false, autojump: false, last_offset: Cell::new(Vec2::zero()), last_size: Vec2::zero(), } } /// Sets the "auto-jump" property for this view. /// /// If enabled, when a key is pressed, the selection will jump to the next /// item beginning with the pressed letter. pub fn set_autojump(&mut self, autojump: bool) { self.autojump = autojump; } /// Sets the "auto-jump" property for this view. /// /// If enabled, when a key is pressed, the selection will jump to the next /// item beginning with the pressed letter. /// /// Chainable variant. pub fn autojump(self) -> Self { self.with(|s| s.set_autojump(true)) } /// Turns `self` into a popup select view. /// /// Chainable variant. pub fn popup(self) -> Self { self.with(|s| s.set_popup(true)) } /// Turns `self` into a popup select view. pub fn set_popup(&mut self, popup: bool) { self.popup = popup; } /// Sets a callback to be used when an item is selected. pub fn set_on_select<F>(&mut self, cb: F) where F: Fn(&mut Cursive, &T) + 'static, { self.on_select = Some(Rc::new(cb)); } /// Sets a callback to be used when an item is selected. /// /// Chainable variant. /// /// # Examples /// /// ``` /// use cursive_core::traits::Identifiable; /// use cursive_core::views::{SelectView, TextView}; /// /// let text_view = TextView::new("").with_name("text"); /// /// let select_view = SelectView::new() /// .item("One", 1) /// .item("Two", 2) /// .on_select(|s, item| { /// let content = match *item { /// 1 => "Content number one", /// 2 => "Content number two! Much better!", /// _ => unreachable!("no such item"), /// }; /// /// // Update the textview with the currently selected item. /// s.call_on_name("text", |v: &mut TextView| { /// v.set_content(content); /// }) /// .unwrap(); /// }); /// ``` pub fn on_select<F>(self, cb: F) -> Self where F: Fn(&mut Cursive, &T) + 'static, { self.with(|s| s.set_on_select(cb)) } /// Sets a callback to be used when `<Enter>` is pressed. /// /// Also happens if the user clicks an item. /// /// The item currently selected will be given to the callback. /// /// Here, `V` can be `T` itself, or a type that can be borrowed from `T`. pub fn set_on_submit<F, R, V: ?Sized>(&mut self, cb: F) where F: 'static + Fn(&mut Cursive, &V) -> R, T: Borrow<V>, { self.on_submit = Some(Rc::new(move |s, t| { cb(s, t.borrow()); })); } /// Sets a callback to be used when `<Enter>` is pressed. /// /// Also happens if the user clicks an item. /// /// The item currently selected will be given to the callback. /// /// Chainable variant. /// /// # Examples /// /// ``` /// use cursive_core::views::{Dialog, SelectView}; /// /// let select_view = SelectView::new() /// .item("One", 1) /// .item("Two", 2) /// .on_submit(|s, item| { /// let content = match *item { /// 1 => "Content number one", /// 2 => "Content number two! Much better!", /// _ => unreachable!("no such item"), /// }; /// /// // Show a popup whenever the user presses <Enter>. /// s.add_layer(Dialog::info(content)); /// }); /// ``` pub fn on_submit<F, V: ?Sized>(self, cb: F) -> Self where F: Fn(&mut Cursive, &V) + 'static, T: Borrow<V>, { self.with(|s| s.set_on_submit(cb)) } /// Sets the alignment for this view. /// /// # Examples /// /// ``` /// use cursive_core::align; /// use cursive_core::views::SelectView; /// /// let select_view = SelectView::new() /// .item("One", 1) /// .align(align::Align::top_center()); /// ``` pub fn align(mut self, align: Align) -> Self { self.align = align; self } /// Sets the vertical alignment for this view. /// (If the view is given too much space vertically.) pub fn v_align(mut self, v: VAlign) -> Self { self.align.v = v; self } /// Sets the horizontal alignment for this view. pub fn h_align(mut self, h: HAlign) -> Self { self.align.h = h; self } /// Returns the value of the currently selected item. /// /// Returns `None` if the list is empty. pub fn selection(&self) -> Option<Rc<T>> { let focus = self.focus(); if self.len() <= focus { None } else { Some(Rc::clone(&self.items[focus].value)) } } /// Removes all items from this view. pub fn clear(&mut self) { self.items.clear(); self.focus.set(0); } /// Adds a item to the list, with given label and value. /// /// # Examples /// /// ``` /// use cursive_core::views::SelectView; /// /// let mut select_view = SelectView::new(); /// /// select_view.add_item("Item 1", 1); /// select_view.add_item("Item 2", 2); /// ``` pub fn add_item<S: Into<StyledString>>(&mut self, label: S, value: T) { self.items.push(Item::new(label.into(), value)); } /// Gets an item at given idx or None. /// /// ``` /// use cursive_core::views::{SelectView, TextView}; /// use cursive_core::Cursive; /// let select = SelectView::new().item("Short", 1); /// assert_eq!(select.get_item(0), Some(("Short", &1))); /// ``` pub fn get_item(&self, i: usize) -> Option<(&str, &T)> { self.iter().nth(i) } /// Gets a mut item at given idx or None. pub fn get_item_mut( &mut self, i: usize, ) -> Option<(&mut StyledString, &mut T)> { if i >= self.items.len() { None } else { let item = &mut self.items[i]; if let Some(t) = Rc::get_mut(&mut item.value) { let label = &mut item.label; Some((label, t)) } else { None } } } /// Iterate mutably on the items in this view. /// /// Returns an iterator with each item and their labels. /// /// In some cases some items will need to be cloned (for example if a /// `Rc<T>` is still alive after calling `SelectView::selection()`). /// /// If `T` does not implement `Clone`, check `SelectView::try_iter_mut()`. pub fn iter_mut( &mut self, ) -> impl Iterator<Item = (&mut StyledString, &mut T)> where T: Clone, { self.items .iter_mut() .map(|item| (&mut item.label, Rc::make_mut(&mut item.value))) } /// Try to iterate mutably on the items in this view. /// /// Returns an iterator with each item and their labels. /// /// Some items may not be returned mutably, for example if a `Rc<T>` is /// still alive after calling `SelectView::selection()`. pub fn try_iter_mut( &mut self, ) -> impl Iterator<Item = (&mut StyledString, Option<&mut T>)> { self.items .iter_mut() .map(|item| (&mut item.label, Rc::get_mut(&mut item.value))) } /// Iterate on the items in this view. /// /// Returns an iterator with each item and their labels. pub fn iter(&self) -> impl Iterator<Item = (&str, &T)> { self.items .iter() .map(|item| (item.label.source(), &*item.value)) } /// Removes an item from the list. /// /// Returns a callback in response to the selection change. /// /// You should run this callback with a `&mut Cursive`. pub fn remove_item(&mut self, id: usize) -> Callback { self.items.remove(id); let focus = self.focus(); if focus >= id && focus > 0 { self.focus.set(focus - 1); } self.make_select_cb().unwrap_or_else(Callback::dummy) } /// Inserts an item at position `index`, shifting all elements after it to /// the right. pub fn insert_item<S>(&mut self, index: usize, label: S, value: T) where S: Into<StyledString>, { self.items.insert(index, Item::new(label.into(), value)); } /// Chainable variant of add_item /// /// # Examples /// /// ``` /// use cursive_core::views::SelectView; /// /// let select_view = SelectView::new() /// .item("Item 1", 1) /// .item("Item 2", 2) /// .item("Surprise item", 42); /// ``` pub fn item<S: Into<StyledString>>(self, label: S, value: T) -> Self { self.with(|s| s.add_item(label, value)) } /// Adds all items from from an iterator. pub fn add_all<S, I>(&mut self, iter: I) where S: Into<StyledString>, I: IntoIterator<Item = (S, T)>, { for (s, t) in iter { self.add_item(s, t); } } /// Adds all items from from an iterator. /// /// Chainable variant. /// /// # Examples /// /// ``` /// use cursive_core::views::SelectView; /// /// // Create a SelectView with 100 items /// let select_view = SelectView::new() /// .with_all((1u8..100).into_iter().map(|i| (format!("Item {}", i), i))); /// ``` pub fn with_all<S, I>(self, iter: I) -> Self where S: Into<StyledString>, I: IntoIterator<Item = (S, T)>, { self.with(|s| s.add_all(iter)) } fn draw_item(&self, printer: &Printer, i: usize) { let l = self.items[i].label.width(); let x = self.align.h.get_offset(l, printer.size.x); printer.print_hline((0, 0), x, " "); printer.print_styled((x, 0), (&self.items[i].label).into()); if l < printer.size.x { assert!((l + x) <= printer.size.x); printer.print_hline((x + l, 0), printer.size.x - (l + x), " "); } } /// Returns the id of the item currently selected. /// /// Returns `None` if the list is empty. pub fn selected_id(&self) -> Option<usize> { if self.items.is_empty() { None } else { Some(self.focus()) } } /// Returns the number of items in this list. /// /// # Examples /// /// ``` /// use cursive_core::views::SelectView; /// /// let select_view = SelectView::new() /// .item("Item 1", 1) /// .item("Item 2", 2) /// .item("Item 3", 3); /// /// assert_eq!(select_view.len(), 3); /// ``` pub fn len(&self) -> usize { self.items.len() } /// Returns `true` if this list has no item. /// /// # Examples /// /// ``` /// use cursive_core::views::SelectView; /// /// let mut select_view = SelectView::new(); /// assert!(select_view.is_empty()); /// /// select_view.add_item("Item 1", 1); /// select_view.add_item("Item 2", 2); /// assert!(!select_view.is_empty()); /// /// select_view.clear(); /// assert!(select_view.is_empty()); /// ``` pub fn is_empty(&self) -> bool { self.items.is_empty() } fn focus(&self) -> usize { self.focus.get() } /// Sort the current items lexicographically by their label. /// /// Note that this does not change the current focus index, which means that the current /// selection will likely be changed by the sorting. /// /// This sort is stable: items with identical label will not be reordered. pub fn sort_by_label(&mut self) { self.items .sort_by(|a, b| a.label.source().cmp(b.label.source())); } /// Sort the current items with the given comparator function. /// /// Note that this does not change the current focus index, which means that the current /// selection will likely be changed by the sorting. /// /// The given comparator function must define a total order for the items. /// /// If the comparator function does not define a total order, then the order after the sort is /// unspecified. /// /// This sort is stable: equal items will not be reordered. pub fn sort_by<F>(&mut self, mut compare: F) where F: FnMut(&T, &T) -> Ordering, { self.items.sort_by(|a, b| compare(&a.value, &b.value)); } /// Sort the current items with the given key extraction function. /// /// Note that this does not change the current focus index, which means that the current /// selection will likely be changed by the sorting. /// /// This sort is stable: items with equal keys will not be reordered. pub fn sort_by_key<K, F>(&mut self, mut key_of: F) where F: FnMut(&T) -> K, K: Ord, { self.items.sort_by_key(|item| key_of(&item.value)); } /// Moves the selection to the given position. /// /// Returns a callback in response to the selection change. /// /// You should run this callback with a `&mut Cursive`. pub fn set_selection(&mut self, i: usize) -> Callback { // TODO: Check if `i >= self.len()` ? // assert!(i < self.len(), "SelectView: trying to select out-of-bound"); // Or just cap the ID? let i = if self.is_empty() { 0 } else { min(i, self.len() - 1) }; self.focus.set(i); self.make_select_cb().unwrap_or_else(Callback::dummy) } /// Sets the selection to the given position. /// /// Chainable variant. /// /// Does not apply `on_select` callbacks. pub fn selected(self, i: usize) -> Self { self.with(|s| { s.set_selection(i); }) } /// Moves the selection up by the given number of rows. /// /// Returns a callback in response to the selection change. /// /// You should run this callback with a `&mut Cursive`: /// /// ```rust /// # use cursive_core::Cursive; /// # use cursive_core::views::SelectView; /// fn select_up(siv: &mut Cursive, view: &mut SelectView<()>) { /// let cb = view.select_up(1); /// cb(siv); /// } /// ``` pub fn select_up(&mut self, n: usize) -> Callback { self.focus_up(n); self.make_select_cb().unwrap_or_else(Callback::dummy) } /// Moves the selection down by the given number of rows. /// /// Returns a callback in response to the selection change. /// /// You should run this callback with a `&mut Cursive`. pub fn select_down(&mut self, n: usize) -> Callback { self.focus_down(n); self.make_select_cb().unwrap_or_else(Callback::dummy) } fn focus_up(&mut self, n: usize) { let focus = self.focus().saturating_sub(n); self.focus.set(focus); } fn focus_down(&mut self, n: usize) { let focus = min(self.focus() + n, self.items.len().saturating_sub(1)); self.focus.set(focus); } fn submit(&mut self) -> EventResult { let cb = self.on_submit.clone().unwrap(); // We return a Callback Rc<|s| cb(s, &*v)> EventResult::Consumed( self.selection() .map(|v| Callback::from_fn(move |s| cb(s, &v))), ) } fn on_char_event(&mut self, c: char) -> EventResult { let i = { // * Starting from the current focus, find the first item that // match the char. // * Cycle back to the beginning of the list when we reach the end. // * This is achieved by chaining twice the iterator. let iter = self.iter().chain(self.iter()); // We'll do a lowercase check. let lower_c: Vec<char> = c.to_lowercase().collect(); let lower_c: &[char] = &lower_c; if let Some((i, _)) = iter.enumerate().skip(self.focus() + 1).find( |&(_, (label, _))| label.to_lowercase().starts_with(lower_c), ) { i % self.len() } else { return EventResult::Ignored; } }; self.focus.set(i); // Apply modulo in case we have a hit from the chained iterator let cb = self.set_selection(i); EventResult::Consumed(Some(cb)) } fn on_event_regular(&mut self, event: Event) -> EventResult { match event { Event::Key(Key::Up) if self.focus() > 0 => self.focus_up(1), Event::Key(Key::Down) if self.focus() + 1 < self.items.len() => { self.focus_down(1) } Event::Key(Key::PageUp) => self.focus_up(10), Event::Key(Key::PageDown) => self.focus_down(10), Event::Key(Key::Home) => self.focus.set(0), Event::Key(Key::End) => { self.focus.set(self.items.len().saturating_sub(1)) } Event::Mouse { event: MouseEvent::Press(_), position, offset, } if position .checked_sub(offset) .map(|position| { position < self.last_size && position.y < self.len() }) .unwrap_or(false) => { self.focus.set(position.y - offset.y) } Event::Mouse { event: MouseEvent::Release(MouseButton::Left), position, offset, } if self.on_submit.is_some() && position .checked_sub(offset) .map(|position| { position < self.last_size && position.y == self.focus() }) .unwrap_or(false) => { return self.submit(); } Event::Key(Key::Enter) if self.on_submit.is_some() => { return self.submit(); } Event::Char(c) if self.autojump => return self.on_char_event(c), _ => return EventResult::Ignored, } EventResult::Consumed(self.make_select_cb()) } /// Returns a callback from selection change. fn make_select_cb(&self) -> Option<Callback> { self.on_select.clone().and_then(|cb| { self.selection() .map(|v| Callback::from_fn(move |s| cb(s, &v))) }) } fn open_popup(&mut self) -> EventResult { // Build a shallow menu tree to mimick the items array. // TODO: cache it? let mut tree = MenuTree::new(); for (i, item) in self.items.iter().enumerate() { let focus = Rc::clone(&self.focus); let on_submit = self.on_submit.as_ref().cloned(); let value = Rc::clone(&item.value); tree.add_leaf(item.label.source(), move |s| { // TODO: What if an item was removed in the meantime? focus.set(i); if let Some(ref on_submit) = on_submit { on_submit(s, &value); } }); } // Let's keep the tree around, // the callback will want to use it. let tree = Rc::new(tree); let focus = self.focus(); // This is the offset for the label text. // We'll want to show the popup so that the text matches. // It'll be soo cool. let item_length = self.items[focus].label.width(); let text_offset = (self.last_size.x.saturating_sub(item_length)) / 2; // The total offset for the window is: // * the last absolute offset at which we drew this view // * shifted to the right of the text offset // * shifted to the top of the focus (so the line matches) // * shifted top-left of the border+padding of the popup let offset = self.last_offset.get(); let offset = offset + (text_offset, 0); let offset = offset.saturating_sub((0, focus)); let offset = offset.saturating_sub((2, 1)); // And now, we can return the callback that will create the popup. EventResult::with_cb(move |s| { // The callback will want to work with a fresh Rc let tree = Rc::clone(&tree); // We'll relativise the absolute position, // So that we are locked to the parent view. // A nice effect is that window resizes will keep both // layers together. let current_offset = s.screen().offset(); let offset = offset.signed() - current_offset; // And finally, put the view in view! s.screen_mut().add_layer_at( Position::parent(offset), MenuPopup::new(tree).focus(focus), ); }) } // A popup view only does one thing: open the popup on Enter. fn on_event_popup(&mut self, event: Event) -> EventResult { match event { // TODO: add Left/Right support for quick-switch? Event::Key(Key::Enter) => self.open_popup(), Event::Mouse { event: MouseEvent::Release(MouseButton::Left), position, offset, } if position.fits_in_rect(offset, self.last_size) => { self.open_popup() } _ => EventResult::Ignored, } } } impl SelectView<String> { /// Convenient method to use the label as value. pub fn add_item_str<S: Into<String>>(&mut self, label: S) { let label = label.into(); self.add_item(label.clone(), label); } /// Chainable variant of add_item_str /// /// # Examples /// /// ``` /// use cursive_core::views::SelectView; /// /// let select_view = SelectView::new() /// .item_str("Paris") /// .item_str("New York") /// .item_str("Tokyo"); /// ``` pub fn item_str<S: Into<String>>(self, label: S) -> Self { self.with(|s| s.add_item_str(label)) } /// Convenient method to use the label as value. pub fn insert_item_str<S>(&mut self, index: usize, label: S) where S: Into<String>, { let label = label.into(); self.insert_item(index, label.clone(), label); } /// Adds all strings from an iterator. /// /// # Examples /// /// ``` /// # use cursive_core::views::SelectView; /// let mut select_view = SelectView::new(); /// select_view.add_all_str(vec!["a", "b", "c"]); /// ``` pub fn add_all_str<S, I>(&mut self, iter: I) where S: Into<String>, I: IntoIterator<Item = S>, { for s in iter { self.add_item_str(s); } } /// Adds all strings from an iterator. /// /// Chainable variant. /// /// # Examples /// /// ``` /// use cursive_core::views::SelectView; /// /// let text = "..."; // Maybe read some config file /// /// let select_view = SelectView::new().with_all_str(text.lines()); /// ``` pub fn with_all_str<S, I>(self, iter: I) -> Self where S: Into<String>, I: IntoIterator<Item = S>, { self.with(|s| s.add_all_str(iter)) } } impl<T: 'static> SelectView<T> where T: Ord, { /// Sort the current items by their natural ordering. /// /// Note that this does not change the current focus index, which means that the current /// selection will likely be changed by the sorting. /// /// This sort is stable: items that are equal will not be reordered. pub fn sort(&mut self) { self.items.sort_by(|a, b| a.value.cmp(&b.value)); } } impl<T: 'static> View for SelectView<T> { fn draw(&self, printer: &Printer) { self.last_offset.set(printer.offset); if self.popup { // Popup-select only draw the active element. // We'll draw the full list in a popup if needed. let style = if !(self.enabled && printer.enabled) { ColorStyle::secondary() } else if printer.focused { ColorStyle::highlight() } else { ColorStyle::primary() }; let x = match printer.size.x.checked_sub(1) { Some(x) => x, None => return, }; printer.with_color(style, |printer| { // Prepare the entire background printer.print_hline((1, 0), x, " "); // Draw the borders printer.print((0, 0), "<"); printer.print((x, 0), ">"); if let Some(label) = self.items.get(self.focus()).map(|item| &item.label) { // And center the text? let offset = HAlign::Center.get_offset(label.width(), x + 1); printer.print_styled((offset, 0), label.into()); } }); } else { // Non-popup mode: we always print the entire list. let h = self.items.len(); let offset = self.align.v.get_offset(h, printer.size.y); let printer = &printer.offset((0, offset)); for i in 0..self.len() { printer.offset((0, i)).with_selection( i == self.focus(), |printer| { if i != self.focus() && !(self.enabled && printer.enabled) { printer.with_color( ColorStyle::secondary(), |printer| self.draw_item(printer, i), ); } else { self.draw_item(printer, i); } }, ); } } } fn required_size(&mut self, _: Vec2) -> Vec2 { // Items here are not compressible. // So no matter what the horizontal requirements are, // we'll still return our longest item. let w = self .items .iter() .map(|item| item.label.width()) .max() .unwrap_or(1); if self.popup { Vec2::new(w + 2, 1) } else { let h = self.items.len(); Vec2::new(w, h) } } fn on_event(&mut self, event: Event) -> EventResult { if !self.enabled { return EventResult::Ignored; } if self.popup { self.on_event_popup(event) } else { self.on_event_regular(event) } } fn take_focus(&mut self, _: Direction) -> bool { self.enabled && !self.items.is_empty() } fn layout(&mut self, size: Vec2) { self.last_size = size; } fn important_area(&self, size: Vec2) -> Rect { self.selected_id() .map(|i| Rect::from_size((0, i), (size.x, 1))) .unwrap_or_else(|| Rect::from((0, 0))) } } // We wrap each value in a `Rc` and add a label struct Item<T> { label: StyledString, value: Rc<T>, } impl<T> Item<T> { fn new(label: StyledString, value: T) -> Self { let value = Rc::new(value); Item { label, value } } } #[cfg(test)] mod tests { use super::*; #[test] fn select_view_sorting() { // We add items in no particular order, from going by their label. let mut view = SelectView::new(); view.add_item_str("Y"); view.add_item_str("Z"); view.add_item_str("X"); // Then sorting the list... view.sort_by_label(); // ... should observe the items in sorted order. // And focus is NOT changed by the sorting, so the first item is "X". assert_eq!(view.selection(), Some(Rc::new(String::from("X")))); view.on_event(Event::Key(Key::Down)); assert_eq!(view.selection(), Some(Rc::new(String::from("Y")))); view.on_event(Event::Key(Key::Down)); assert_eq!(view.selection(), Some(Rc::new(String::from("Z")))); view.on_event(Event::Key(Key::Down)); assert_eq!(view.selection(), Some(Rc::new(String::from("Z")))); } #[test] fn select_view_sorting_with_comparator() { // We add items in no particular order, from going by their value. let mut view = SelectView::new(); view.add_item("Y", 2); view.add_item("Z", 1); view.add_item("X", 3); // Then sorting the list... view.sort_by(|a, b| a.cmp(b)); // ... should observe the items in sorted order. // And focus is NOT changed by the sorting, so the first item is "X". assert_eq!(view.selection(), Some(Rc::new(1))); view.on_event(Event::Key(Key::Down)); assert_eq!(view.selection(), Some(Rc::new(2))); view.on_event(Event::Key(Key::Down)); assert_eq!(view.selection(), Some(Rc::new(3))); view.on_event(Event::Key(Key::Down)); assert_eq!(view.selection(), Some(Rc::new(3))); } #[test] fn select_view_sorting_by_key() { // We add items in no particular order, from going by their key value. #[derive(Eq, PartialEq, Debug)] struct MyStruct { key: i32, } let mut view = SelectView::new(); view.add_item("Y", MyStruct { key: 2 }); view.add_item("Z", MyStruct { key: 1 }); view.add_item("X", MyStruct { key: 3 }); // Then sorting the list... view.sort_by_key(|s| s.key); // ... should observe the items in sorted order. // And focus is NOT changed by the sorting, so the first item is "X". assert_eq!(view.selection(), Some(Rc::new(MyStruct { key: 1 }))); view.on_event(Event::Key(Key::Down)); assert_eq!(view.selection(), Some(Rc::new(MyStruct { key: 2 }))); view.on_event(Event::Key(Key::Down)); assert_eq!(view.selection(), Some(Rc::new(MyStruct { key: 3 }))); view.on_event(Event::Key(Key::Down)); assert_eq!(view.selection(), Some(Rc::new(MyStruct { key: 3 }))); } #[test] fn select_view_sorting_orderable_items() { // We add items in no particular order, from going by their value. let mut view = SelectView::new(); view.add_item("Y", 2); view.add_item("Z", 1); view.add_item("X", 3); // Then sorting the list... view.sort(); // ... should observe the items in sorted order. // And focus is NOT changed by the sorting, so the first item is "X". assert_eq!(view.selection(), Some(Rc::new(1))); view.on_event(Event::Key(Key::Down)); assert_eq!(view.selection(), Some(Rc::new(2))); view.on_event(Event::Key(Key::Down)); assert_eq!(view.selection(), Some(Rc::new(3))); view.on_event(Event::Key(Key::Down)); assert_eq!(view.selection(), Some(Rc::new(3))); } }