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
use std::any::Any;
use std::num::NonZeroU32;
#[cfg(feature = "toml")]
use std::path::Path;
use crossbeam_channel::{self, Receiver, Sender};
use crate::{
backend,
cursive_run::CursiveRunner,
direction,
event::{Event, EventResult},
printer::Printer,
theme,
view::{self, Finder, IntoBoxedView, Position, View, ViewNotFound},
views::{self, LayerPosition},
Dump, Vec2,
};
static DEBUG_VIEW_NAME: &str = "_cursive_debug_view";
type RootView = views::OnEventView<views::ScreensView<views::StackView>>;
type BackendCallback = dyn FnOnce(&mut dyn backend::Backend);
type Callback = dyn FnOnce(&mut Cursive) + Send;
/// Central part of the cursive library.
///
/// It initializes ncurses on creation and cleans up on drop.
/// To use it, you should populate it with views, layouts, and callbacks,
/// then start the event loop with `run()`.
///
/// It uses a list of screen, with one screen active at a time.
pub struct Cursive {
theme: theme::Theme,
// The main view
root: RootView,
menubar: views::Menubar,
pub(crate) needs_clear: bool,
running: bool,
// Handle asynchronous callbacks
cb_source: Receiver<Box<Callback>>,
cb_sink: Sender<Box<Callback>>,
last_size: Vec2,
// User-provided data.
user_data: Box<dyn Any>,
// Handle auto-refresh when no event is received.
fps: Option<NonZeroU32>,
// List of callbacks to run on the backend.
// The current assumption is that we only add calls here during event processing.
pub(crate) backend_calls: Vec<Box<BackendCallback>>,
}
/// Identifies a screen in the cursive root.
pub type ScreenId = usize;
/// Convenient alias to the result of `Cursive::cb_sink`.
///
/// # Notes
///
/// Callbacks need to be `Send`, which can be limiting in some cases.
///
/// In some case [`send_wrapper`] may help you work around that.
///
/// [`send_wrapper`]: https://crates.io/crates/send_wrapper
pub type CbSink = Sender<Box<dyn FnOnce(&mut Cursive) + Send>>;
new_default!(Cursive);
impl Cursive {
/// Creates a new Cursive root, and initialize the back-end.
///
/// You probably don't want to use this function directly, unless you're
/// using a non-standard backend. Built-in backends have dedicated functions in the
/// [`CursiveExt`] trait.
///
/// [`CursiveExt`]: https://docs.rs/cursive/0/cursive/trait.CursiveExt.html
pub fn new() -> Self {
let theme = theme::load_default();
let (cb_sink, cb_source) = crossbeam_channel::unbounded();
let mut cursive = Cursive {
theme,
root: views::OnEventView::new(views::ScreensView::single_screen(
views::StackView::new(),
)),
menubar: views::Menubar::new(),
last_size: Vec2::zero(),
needs_clear: true,
running: true,
cb_source,
cb_sink,
fps: None,
user_data: Box::new(()),
backend_calls: Vec::new(),
};
cursive.reset_default_callbacks();
cursive
}
/// Returns the screen size given in the last layout phase.
///
/// Note: this will return `(0, 0)` before the first layout phase.
pub fn screen_size(&self) -> Vec2 {
self.last_size
}
pub(crate) fn layout(&mut self, size: Vec2) {
self.last_size = size;
let offset = if self.menubar.autohide { 0 } else { 1 };
let size = size.saturating_sub((0, offset));
self.root.layout(size);
}
pub(crate) fn draw(&mut self, size: Vec2, backend: &dyn backend::Backend) {
let printer = Printer::new(size, &self.theme, backend);
let selected = self.menubar.receive_events();
// Print the stackview background before the menubar
let offset = if self.menubar.autohide { 0 } else { 1 };
// The printer for the stackview
let sv_printer = printer.offset((0, offset)).focused(!selected);
self.root.get_inner().draw_bg(&sv_printer);
// Draw the currently active screen
// If the menubar is active, nothing else can be.
// Draw the menubar?
if self.menubar.visible() {
let printer = printer.focused(self.menubar.receive_events());
printer.with_color(theme::ColorStyle::primary(), |printer| {
self.menubar.draw(printer)
});
}
// finally draw stackview layers
// using variables from above
self.root.get_inner().draw_fg(&sv_printer);
}
/// Sets some data to be stored in Cursive.
///
/// It can later on be accessed with `Cursive::user_data()`
pub fn set_user_data<T: Any>(&mut self, user_data: T) {
self.user_data = Box::new(user_data);
}
/// Attempts to access the user-provided data.
///
/// If some data was set previously with the same type, returns a
/// reference to it.
///
/// If nothing was set or if the type is different, returns `None`.
pub fn user_data<T: Any>(&mut self) -> Option<&mut T> {
self.user_data.downcast_mut()
}
/// Attemps to take by value the current user-data.
///
/// If successful, this will replace the current user-data with the unit
/// type `()`.
///
/// If the current user data is not of the requested type, `None` will be
/// returned.
///
/// # Examples
///
/// ```rust
/// let mut siv = cursive_core::Cursive::new();
///
/// // Start with a simple `Vec<i32>` as user data.
/// siv.set_user_data(vec![1i32, 2, 3]);
/// assert_eq!(siv.user_data::<Vec<i32>>(), Some(&mut vec![1i32, 2, 3]));
///
/// // Let's mutate the data a bit.
/// siv.with_user_data(|numbers: &mut Vec<i32>| numbers.push(4));
///
/// // If mutable reference is not enough, we can take the data by value.
/// let data: Vec<i32> = siv.take_user_data().unwrap();
/// assert_eq!(data, vec![1i32, 2, 3, 4]);
///
/// // At this point the user data was removed and is no longer available.
/// assert_eq!(siv.user_data::<Vec<i32>>(), None);
/// ```
pub fn take_user_data<T: Any>(&mut self) -> Option<T> {
// Start by taking the user data and replacing it with a dummy.
let user_data = std::mem::replace(&mut self.user_data, Box::new(()));
// Downcast the data to the requested type.
// If it works, unbox it.
// It if doesn't, take it back.
user_data
.downcast()
.map_err(|user_data| {
// If we asked for the wrong type, put it back.
self.user_data = user_data;
})
.map(|boxed| *boxed)
.ok()
}
/// Runs the given closure on the stored user data, if any.
///
/// If no user data was supplied, or if the type is different, nothing
/// will be run.
///
/// Otherwise, the result will be returned.
pub fn with_user_data<F, T, R>(&mut self, f: F) -> Option<R>
where
F: FnOnce(&mut T) -> R,
T: Any,
{
self.user_data().map(f)
}
/// Sets the title for the terminal window.
///
/// Note that not all backends support this.
pub fn set_window_title<S: Into<String>>(&mut self, title: S) {
let title = title.into();
self.backend_calls
.push(Box::new(move |backend| backend.set_title(title)));
}
/// Show the debug console.
///
/// Currently, this will show logs if [`logger::init()`](crate::logger::init()) was called.
pub fn show_debug_console(&mut self) {
self.add_layer(
views::Dialog::around(
views::ScrollView::new(views::NamedView::new(
DEBUG_VIEW_NAME,
views::DebugView::new(),
))
.scroll_x(true),
)
.title("Debug console"),
);
}
/// Show the debug console, or hide it if it's already visible.
///
/// # Examples
///
/// ```rust
/// # use cursive_core::Cursive;
/// # let mut siv = Cursive::new();
/// siv.add_global_callback('~', Cursive::toggle_debug_console);
/// ```
pub fn toggle_debug_console(&mut self) {
if let Some(pos) =
self.screen_mut().find_layer_from_name(DEBUG_VIEW_NAME)
{
self.screen_mut().remove_layer(pos);
} else {
self.show_debug_console();
}
}
/// Returns a sink for asynchronous callbacks.
///
/// Returns the sender part of a channel, that allows to send
/// callbacks to `self` from other threads.
///
/// Callbacks will be executed in the order
/// of arrival on the next event cycle.
///
/// # Notes
///
/// Callbacks need to be `Send`, which can be limiting in some cases.
///
/// In some case [`send_wrapper`] may help you work around that.
///
/// [`send_wrapper`]: https://crates.io/crates/send_wrapper
///
/// # Examples
///
/// ```rust
/// # use cursive_core::*;
/// let mut siv = Cursive::new();
///
/// // quit() will be called during the next event cycle
/// siv.cb_sink().send(Box::new(|s| s.quit())).unwrap();
/// ```
pub fn cb_sink(&self) -> &CbSink {
&self.cb_sink
}
/// Selects the menubar.
pub fn select_menubar(&mut self) {
if let Ok(res) = self.menubar.take_focus(direction::Direction::none())
{
res.process(self);
}
}
/// Sets the menubar autohide feature.
///
/// * When enabled (default), the menu is only visible when selected.
/// * When disabled, the menu is always visible and reserves the top row.
pub fn set_autohide_menu(&mut self, autohide: bool) {
self.menubar.autohide = autohide;
}
/// Access the menu tree used by the menubar.
///
/// This allows to add menu items to the menubar.
///
/// # Examples
///
/// ```rust
/// # use cursive_core::{Cursive, event};
/// # use cursive_core::views::{Dialog};
/// # use cursive_core::traits::*;
/// # use cursive_core::menu;
/// #
/// let mut siv = Cursive::new();
///
/// siv.menubar()
/// .add_subtree(
/// "File",
/// menu::Tree::new()
/// .leaf("New", |s| s.add_layer(Dialog::info("New file!")))
/// .subtree(
/// "Recent",
/// menu::Tree::new().with(|tree| {
/// for i in 1..100 {
/// tree.add_leaf(format!("Item {}", i), |_| ())
/// }
/// }),
/// )
/// .delimiter()
/// .with(|tree| {
/// for i in 1..10 {
/// tree.add_leaf(format!("Option {}", i), |_| ());
/// }
/// })
/// .delimiter()
/// .leaf("Quit", |s| s.quit()),
/// )
/// .add_subtree(
/// "Help",
/// menu::Tree::new()
/// .subtree(
/// "Help",
/// menu::Tree::new()
/// .leaf("General", |s| {
/// s.add_layer(Dialog::info("Help message!"))
/// })
/// .leaf("Online", |s| {
/// s.add_layer(Dialog::info("Online help?"))
/// }),
/// )
/// .leaf("About", |s| {
/// s.add_layer(Dialog::info("Cursive v0.0.0"))
/// }),
/// );
///
/// siv.add_global_callback(event::Key::Esc, |s| s.select_menubar());
/// ```
pub fn menubar(&mut self) -> &mut views::Menubar {
&mut self.menubar
}
/// Returns the currently used theme.
pub fn current_theme(&self) -> &theme::Theme {
&self.theme
}
/// Modifies the current theme.
///
/// Shortcut to get the [`Cursive::current_theme()`],
/// then run [`Cursive::set_theme()`].
pub fn with_theme<F: FnOnce(&mut theme::Theme)>(&mut self, f: F) {
f(&mut self.theme);
self.clear();
}
/// Sets the current theme.
pub fn set_theme(&mut self, theme: theme::Theme) {
self.theme = theme;
self.clear();
}
/// Updates the current theme.
pub fn update_theme(&mut self, f: impl FnOnce(&mut theme::Theme)) {
// We don't just expose a `current_theme_mut` because we may want to
// run some logic _after_ setting the theme.
// Though right now, it's only clearing the screen, so...
let mut theme = self.theme.clone();
f(&mut theme);
self.set_theme(theme);
}
/// Clears the screen.
///
/// Users rarely have to call this directly.
pub fn clear(&mut self) {
self.needs_clear = true;
}
/// Loads a theme from the given file.
///
/// `filename` must point to a valid toml file.
///
/// Must have the `toml` feature enabled.
#[cfg(feature = "toml")]
pub fn load_theme_file<P: AsRef<Path>>(
&mut self,
filename: P,
) -> Result<(), theme::Error> {
theme::load_theme_file(filename).map(|theme| self.set_theme(theme))
}
/// Loads a theme from the given string content.
///
/// Content must be valid toml.
///
/// Must have the `toml` feature enabled.
#[cfg(feature = "toml")]
pub fn load_toml(&mut self, content: &str) -> Result<(), theme::Error> {
theme::load_toml(content).map(|theme| self.set_theme(theme))
}
/// Sets the refresh rate, in frames per second.
///
/// Note that the actual frequency is not guaranteed.
///
/// Between 0 and 30. Call with `fps = 0` to disable (default value).
pub fn set_fps(&mut self, fps: u32) {
self.fps = NonZeroU32::new(fps);
}
/// Enables or disables automatic refresh of the screen.
///
/// This is a shortcut to call `set_fps` with `30` or `0` depending on
/// `autorefresh`.
pub fn set_autorefresh(&mut self, autorefresh: bool) {
self.set_fps(if autorefresh { 30 } else { 0 });
}
/// Returns the current refresh rate, if any.
///
/// Returns `None` if no auto-refresh is set. Otherwise, returns the rate
/// in frames per second.
pub fn fps(&self) -> Option<NonZeroU32> {
self.fps
}
/// Returns a reference to the currently active screen.
pub fn screen(&self) -> &views::StackView {
self.root.get_inner().screen().unwrap()
}
/// Returns a mutable reference to the currently active screen.
pub fn screen_mut(&mut self) -> &mut views::StackView {
self.root.get_inner_mut().screen_mut().unwrap()
}
/// Returns the id of the currently active screen.
pub fn active_screen(&self) -> ScreenId {
self.root.get_inner().active_screen()
}
/// Adds a new screen, and returns its ID.
pub fn add_screen(&mut self) -> ScreenId {
self.root
.get_inner_mut()
.add_screen(views::StackView::new())
}
/// Convenient method to create a new screen, and set it as active.
pub fn add_active_screen(&mut self) -> ScreenId {
let res = self.add_screen();
self.set_screen(res);
res
}
/// Sets the active screen. Panics if no such screen exist.
pub fn set_screen(&mut self, screen_id: ScreenId) {
self.root.get_inner_mut().set_active_screen(screen_id);
}
/// Tries to find the view pointed to by the given selector.
///
/// Runs a closure on the view once it's found, and return the
/// result.
///
/// If the view is not found, or if it is not of the asked type,
/// returns None.
///
/// # Examples
///
/// ```rust
/// # use cursive_core::{Cursive, views, view};
/// # use cursive_core::traits::*;
/// let mut siv = Cursive::new();
///
/// siv.add_layer(views::TextView::new("Text #1").with_name("text"));
///
/// siv.add_global_callback('p', |s| {
/// s.call_on(
/// &view::Selector::Name("text"),
/// |view: &mut views::TextView| {
/// view.set_content("Text #2");
/// },
/// );
/// });
/// ```
pub fn call_on<V, F, R>(
&mut self,
sel: &view::Selector<'_>,
callback: F,
) -> Option<R>
where
V: View,
F: FnOnce(&mut V) -> R,
{
self.root.call_on(sel, callback)
}
/// Tries to find the view identified by the given name.
///
/// Convenient method to use `call_on` with a [`view::Selector::Name`].
///
/// # Examples
///
/// ```rust
/// # use cursive_core::{Cursive, views};
/// # use cursive_core::traits::*;
/// let mut siv = Cursive::new();
///
/// siv.add_layer(views::TextView::new("Text #1").with_name("text"));
///
/// siv.add_global_callback('p', |s| {
/// s.call_on_name("text", |view: &mut views::TextView| {
/// view.set_content("Text #2");
/// });
/// });
/// ```
pub fn call_on_name<V, F, R>(
&mut self,
name: &str,
callback: F,
) -> Option<R>
where
V: View,
F: FnOnce(&mut V) -> R,
{
self.call_on(&view::Selector::Name(name), callback)
}
/// Call the given closure on all views with the given name and the correct type.
pub fn call_on_all_named<V, F>(&mut self, name: &str, callback: F)
where
V: View,
F: FnMut(&mut V),
{
self.root.call_on_all(&view::Selector::Name(name), callback);
}
/// Convenient method to find a view wrapped in [`NamedView`].
///
/// This looks for a `NamedView<V>` with the given name, and return
/// a [`ViewRef`] to the wrapped view. The `ViewRef` implements
/// `DerefMut<Target=T>`, so you can treat it just like a `&mut T`.
///
/// # Examples
///
/// ```rust
/// # use cursive_core::Cursive;
/// # use cursive_core::views::{TextView, ViewRef};
/// # let mut siv = Cursive::new();
/// use cursive_core::traits::Nameable;
///
/// siv.add_layer(TextView::new("foo").with_name("id"));
///
/// // Could be called in a callback
/// let mut view: ViewRef<TextView> = siv.find_name("id").unwrap();
/// view.set_content("bar");
/// ```
///
/// Note that you must specify the exact type for the view you're after; for example, using the
/// wrong item type in a `SelectView` will not find anything:
///
/// ```rust
/// # use cursive_core::Cursive;
/// # use cursive_core::views::{SelectView};
/// # let mut siv = Cursive::new();
/// use cursive_core::traits::Nameable;
///
/// let select = SelectView::new().item("zero", 0u32).item("one", 1u32);
/// siv.add_layer(select.with_name("select"));
///
/// // Specifying a wrong type will not return anything.
/// assert!(siv.find_name::<SelectView<String>>("select").is_none());
///
/// // Omitting the type will use the default type, in this case `String`.
/// assert!(siv.find_name::<SelectView>("select").is_none());
///
/// // But with the correct type, it works fine.
/// assert!(siv.find_name::<SelectView<u32>>("select").is_some());
/// ```
///
/// [`NamedView`]: views::NamedView
/// [`ViewRef`]: views::ViewRef
pub fn find_name<V>(&mut self, id: &str) -> Option<views::ViewRef<V>>
where
V: View,
{
self.call_on_name(id, views::NamedView::<V>::get_mut)
}
/// Moves the focus to the view identified by `name`.
///
/// Convenient method to call `focus` with a [`view::Selector::Name`].
pub fn focus_name(
&mut self,
name: &str,
) -> Result<EventResult, ViewNotFound> {
self.focus(&view::Selector::Name(name))
}
/// Moves the focus to the view identified by `sel`.
pub fn focus(
&mut self,
sel: &view::Selector<'_>,
) -> Result<EventResult, ViewNotFound> {
self.root.focus_view(sel)
}
/// Adds a global callback.
///
/// Will be triggered on the given key press when no view catches it.
///
/// # Examples
///
/// ```rust
/// # use cursive_core::*;
/// let mut siv = Cursive::new();
///
/// siv.add_global_callback('q', |s| s.quit());
/// ```
pub fn add_global_callback<F, E: Into<Event>>(&mut self, event: E, cb: F)
where
F: FnMut(&mut Cursive) + 'static,
{
self.set_on_post_event(event.into(), cb);
}
/// Registers a callback for ignored events.
///
/// This is the same as `add_global_callback`, but can register any `EventTrigger`.
pub fn set_on_post_event<F, E>(&mut self, trigger: E, cb: F)
where
F: FnMut(&mut Cursive) + 'static,
E: Into<crate::event::EventTrigger>,
{
self.root.set_on_event(trigger, crate::immut1!(cb));
}
/// Registers a priotity callback.
///
/// If an event matches the given trigger, it will not be sent to the view
/// tree and will go to the given callback instead.
///
/// Note that regular "post-event" callbacks will also be skipped for
/// these events.
pub fn set_on_pre_event<F, E>(&mut self, trigger: E, cb: F)
where
F: FnMut(&mut Cursive) + 'static,
E: Into<crate::event::EventTrigger>,
{
self.root.set_on_pre_event(trigger, crate::immut1!(cb));
}
/// Registers an inner priority callback.
///
/// See [`OnEventView`] for more information.
///
/// [`OnEventView`]: crate::views::OnEventView::set_on_pre_event_inner()
pub fn set_on_pre_event_inner<E, F>(&mut self, trigger: E, cb: F)
where
E: Into<crate::event::EventTrigger>,
F: Fn(&Event) -> Option<EventResult> + 'static,
{
self.root
.set_on_pre_event_inner(trigger, move |_, event| cb(event));
}
/// Registers an inner callback.
///
/// See [`OnEventView`] for more information.
///
/// [`OnEventView`]: crate::views::OnEventView::set_on_event_inner()
pub fn set_on_event_inner<E, F>(&mut self, trigger: E, cb: F)
where
E: Into<crate::event::EventTrigger>,
F: Fn(&Event) -> Option<EventResult> + 'static,
{
self.root
.set_on_event_inner(trigger, move |_, event| cb(event));
}
/// Sets the only global callback for the given event.
///
/// Any other callback for this event will be removed.
///
/// See also [`Cursive::add_global_callback`].
pub fn set_global_callback<F, E: Into<Event>>(&mut self, event: E, cb: F)
where
F: FnMut(&mut Cursive) + 'static,
{
let event = event.into();
self.clear_global_callbacks(event.clone());
self.add_global_callback(event, cb);
}
/// Fetches the type name of a view in the tree.
pub fn debug_name(&mut self, name: &str) -> Option<&'static str> {
let mut result = None;
self.root.call_on_any(
&view::Selector::Name(name),
&mut |v: &mut dyn crate::View| result = Some(v.type_name()),
);
result
}
/// Removes any callback tied to the given event.
///
/// # Examples
///
/// ```rust
/// use cursive_core::Cursive;
/// let mut siv = Cursive::new();
///
/// siv.add_global_callback('q', |s| s.quit());
/// siv.clear_global_callbacks('q');
/// ```
pub fn clear_global_callbacks<E>(&mut self, event: E)
where
E: Into<Event>,
{
let event = event.into();
self.root.clear_event(event);
}
/// This resets the default callbacks.
///
/// Currently this mostly includes exiting on Ctrl-C.
pub fn reset_default_callbacks(&mut self) {
self.set_on_pre_event(Event::CtrlChar('c'), |s| s.quit());
self.set_on_pre_event(Event::Exit, |s| s.quit());
self.set_on_pre_event(Event::WindowResize, |s| s.clear());
}
/// Add a layer to the current screen.
///
/// # Examples
///
/// ```rust
/// use cursive_core::{views, Cursive};
/// let mut siv = Cursive::new();
///
/// siv.add_layer(views::TextView::new("Hello world!"));
/// ```
pub fn add_layer<T>(&mut self, view: T)
where
T: IntoBoxedView,
{
self.screen_mut().add_layer(view);
}
/// Adds a new full-screen layer to the current screen.
///
/// Fullscreen layers have no shadow.
pub fn add_fullscreen_layer<T>(&mut self, view: T)
where
T: IntoBoxedView,
{
self.screen_mut().add_fullscreen_layer(view);
}
/// Convenient method to remove a layer from the current screen.
pub fn pop_layer(&mut self) -> Option<Box<dyn View>> {
self.screen_mut().pop_layer()
}
/// Convenient stub forwarding layer repositioning.
pub fn reposition_layer(
&mut self,
layer: LayerPosition,
position: Position,
) {
self.screen_mut().reposition_layer(layer, position);
}
/// Processes an event.
///
/// * If the menubar is active, it will be handled the event.
/// * The view tree will be handled the event.
/// * If ignored, global_callbacks will be checked for this event.
pub fn on_event(&mut self, event: Event) {
if let Event::Mouse {
event, position, ..
} = event
{
if event.grabs_focus()
&& !self.menubar.autohide
&& !self.menubar.has_submenu()
&& position.y == 0
{
self.select_menubar();
}
}
if self.menubar.receive_events() {
self.menubar.on_event(event).process(self);
} else {
let offset = if self.menubar.autohide { 0 } else { 1 };
let result =
View::on_event(&mut self.root, event.relativized((0, offset)));
if let EventResult::Consumed(Some(cb)) = result {
cb(self);
}
}
}
/// Try to process a single callback.
///
/// Returns `true` if a callback was processed, `false` if there was
/// nothing to process.
pub(crate) fn process_callback(&mut self) -> bool {
match self.cb_source.try_recv() {
Ok(cb) => {
cb(self);
true
}
_ => false,
}
}
/// Returns `true` until [`quit(&mut self)`] is called.
///
/// [`quit(&mut self)`]: #method.quit
pub fn is_running(&self) -> bool {
self.running
}
/// Runs a dummy event loop.
///
/// Initializes a dummy backend for the event loop.
pub fn run_dummy(&mut self) {
self.run_with(backend::Dummy::init)
}
/// Returns a new runner on the given backend.
///
/// Used to manually control the event loop. In most cases, running
/// `Cursive::run_with` will be easier.
///
/// The runner will borrow `self`; when dropped, it will clear out the
/// terminal, and the cursive instance will be ready for another run if
/// needed.
pub fn runner(
&mut self,
backend: Box<dyn backend::Backend>,
) -> CursiveRunner<&mut Self> {
self.running = true;
CursiveRunner::new(self, backend)
}
/// Returns a new runner on the given backend.
///
/// Used to manually control the event loop. In most cases, running
/// `Cursive::run_with` will be easier.
///
/// The runner will embed `self`; when dropped, it will clear out the
/// terminal, and the cursive instance will be dropped as well.
pub fn into_runner(
self,
backend: Box<dyn backend::Backend>,
) -> CursiveRunner<Self> {
CursiveRunner::new(self, backend)
}
/// Initialize the backend and runs the event loop.
///
/// Used for infallible backend initializers.
pub fn run_with<F>(&mut self, backend_init: F)
where
F: FnOnce() -> Box<dyn backend::Backend>,
{
self.try_run_with::<(), _>(|| Ok(backend_init())).unwrap();
}
/// Initialize the backend and runs the event loop.
///
/// Returns an error if initializing the backend fails.
pub fn try_run_with<E, F>(&mut self, backend_init: F) -> Result<(), E>
where
F: FnOnce() -> Result<Box<dyn backend::Backend>, E>,
{
let mut runner = self.runner(backend_init()?);
runner.run();
Ok(())
}
/// Stops the event loop.
pub fn quit(&mut self) {
self.running = false;
}
/// Does not do anything.
pub fn noop(&mut self) {
// foo
}
/// Dump the current state of the Cursive root.
///
/// *It will clear out this `Cursive` instance* and save everything, including:
/// * The view tree
/// * Callbacks
/// * Menubar
/// * User data
/// * Callback sink
///
/// After calling this, the cursive object will be as if newly created.
pub fn dump(&mut self) -> crate::Dump {
let (cb_sink, cb_source) = crossbeam_channel::unbounded();
let root = views::OnEventView::new(views::ScreensView::single_screen(
views::StackView::new(),
));
Dump {
cb_sink: std::mem::replace(&mut self.cb_sink, cb_sink),
cb_source: std::mem::replace(&mut self.cb_source, cb_source),
fps: self.fps.take(),
menubar: std::mem::take(&mut self.menubar),
root_view: std::mem::replace(&mut self.root, root),
theme: std::mem::take(&mut self.theme),
user_data: std::mem::replace(&mut self.user_data, Box::new(())),
}
}
/// Restores the state from a previous dump.
///
/// This will discard everything from this `Cursive` instance.
/// In particular:
/// * All current views will be dropped, replaced by the dump.
/// * All callbacks will be replaced.
/// * Menubar will be replaced.
/// * User Data will be replaced.
/// * The callback channel will be replaced - any previous call to
/// `cb_sink` on this instance will be disconnected.
pub fn restore(&mut self, dump: Dump) {
self.cb_sink = dump.cb_sink;
self.cb_source = dump.cb_source;
self.fps = dump.fps;
self.menubar = dump.menubar;
self.root = dump.root_view;
self.theme = dump.theme;
self.user_data = dump.user_data;
self.clear();
}
}