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
//! User-input events and their effects.
//!
//! * Every user input the application receives is converted to an [`Event`].
//! * Each event is then given to the root, and descends the view tree down to
//! the view currently in focus, through the [`on_event`] method.
//! * If the view consumes the event, it may return a callback to be
//! executed.
//! * Otherwise, it ignores the event, and the view parent can in turn
//! choose to consume it or not.
//! * If no view consumes the event, the [global callback] table is checked.
//!
//! [`Event`]: enum.Event.html
//! [`on_event`]: ../trait.View.html#method.on_event
//! [global callback]: ../struct.Cursive.html#method.add_global_callback
use crate::Cursive;
use crate::Vec2;
use std::any::Any;
use std::ops::Deref;
use std::rc::Rc;
/// Callback is a function that can be triggered by an event.
/// It has a mutable access to the cursive root.
///
/// It is meant to be stored in views.
#[derive(Clone)]
pub struct Callback(Rc<dyn Fn(&mut Cursive)>);
// TODO: remove the Box when Box<T: Sized> -> Rc<T> is possible
/// A callback that can be run on `&mut dyn View`.
///
/// It is meant to be used as parameter in `View::call_on_any`, and not much else.
pub type AnyCb<'a> = &'a mut dyn FnMut(&mut dyn crate::view::View);
/// A trigger that only selects some types of events.
///
/// It is meant to be stored in views.
pub struct EventTrigger {
trigger: Box<dyn Fn(&Event) -> bool>,
tag: Box<dyn AnyTag>,
}
trait AnyTag: Any + std::fmt::Debug {
fn as_any(&self) -> &dyn Any;
}
impl<T> AnyTag for T
where
T: Any + std::fmt::Debug,
{
fn as_any(&self) -> &dyn Any {
self
}
}
impl EventTrigger {
/// Create a new `EventTrigger` using the given function as filter.
pub fn from_fn<F>(f: F) -> Self
where
F: 'static + Fn(&Event) -> bool,
{
EventTrigger::from_fn_and_tag(f, "free function")
}
/// Create a new `EventTrigger`.
pub fn from_fn_and_tag<F, T>(f: F, tag: T) -> Self
where
F: 'static + Fn(&Event) -> bool,
T: Any + std::fmt::Debug,
{
let tag = Box::new(tag);
let trigger = Box::new(f);
EventTrigger { trigger, tag }
}
/// Check if this trigger has the given tag.
///
/// # Examples
///
/// ```rust
/// use cursive_core::event::{Event, EventTrigger};
///
/// let event = Event::CtrlChar('c');
/// let trigger: EventTrigger = event.clone().into();
/// assert!(
/// trigger.has_tag(&event),
/// "Trigger does not recognize its own tag."
/// );
/// ```
pub fn has_tag<T: PartialEq + 'static>(&self, tag: &T) -> bool {
(*self.tag)
.as_any()
.downcast_ref::<T>()
.map_or(false, |t| tag == t)
}
/// Checks if this trigger applies to the given `Event`.
pub fn apply(&self, event: &Event) -> bool {
(self.trigger)(event)
}
/// Returns an `EventTrigger` that only accepts arrow keys.
///
/// Only bare arrow keys without modifiers (Shift, Ctrl, Alt) will be accepted.
pub fn arrows() -> Self {
Self::from_fn_and_tag(
|e| {
matches!(
e,
Event::Key(Key::Left)
| Event::Key(Key::Down)
| Event::Key(Key::Up)
| Event::Key(Key::Right)
)
},
"arrows",
)
}
/// Returns an `EventTrigger` that only accepts mouse events.
pub fn mouse() -> Self {
Self::from_fn_and_tag(|e| matches!(e, Event::Mouse { .. }), "mouse")
}
/// Returns an `EventTrigger` that accepts any event.
pub fn any() -> Self {
Self::from_fn_and_tag(|_| true, "any")
}
/// Returns an `EventTrigger` that doesn't accept any event.
pub fn none() -> Self {
Self::from_fn_and_tag(|_| false, "none")
}
/// Returns an `EventTrigger` that applies if either `self` or `other` applies.
#[must_use]
pub fn or<O>(self, other: O) -> Self
where
O: Into<EventTrigger>,
{
let other = other.into();
let self_trigger = self.trigger;
let other_trigger = other.trigger;
let tag = (self.tag, "or", other.tag);
Self::from_fn_and_tag(
move |e| self_trigger(e) || other_trigger(e),
tag,
)
}
}
impl From<Event> for EventTrigger {
fn from(event: Event) -> Self {
let tag = event.clone();
Self::from_fn_and_tag(move |e| *e == event, tag)
}
}
impl From<char> for EventTrigger {
fn from(c: char) -> Self {
Self::from(Event::from(c))
}
}
impl From<Key> for EventTrigger {
fn from(k: Key) -> Self {
Self::from(Event::from(k))
}
}
impl<F> From<F> for EventTrigger
where
F: 'static + Fn(&Event) -> bool,
{
fn from(f: F) -> Self {
Self::from_fn(f)
}
}
impl Callback {
/// Wraps the given function into a `Callback` object.
pub fn from_fn<F>(f: F) -> Self
where
F: 'static + Fn(&mut Cursive),
{
Callback(Rc::new(move |siv| {
f(siv);
}))
}
/// Wrap a `FnMut` into a `Callback` object.
///
/// If this methods tries to call itself, nested calls will be no-ops.
pub fn from_fn_mut<F>(f: F) -> Self
where
F: 'static + FnMut(&mut Cursive),
{
Self::from_fn(crate::immut1!(f))
}
/// Wrap a `FnOnce` into a `Callback` object.
///
/// After being called once, the callback will become a no-op.
pub fn from_fn_once<F>(f: F) -> Self
where
F: 'static + FnOnce(&mut Cursive),
{
Self::from_fn_mut(crate::once1!(f))
}
/// Returns a dummy callback that doesn't run anything.
pub fn dummy() -> Self {
Callback::from_fn(|_| ())
}
}
impl Deref for Callback {
type Target = dyn Fn(&mut Cursive) + 'static;
fn deref(&self) -> &Self::Target {
&*self.0
}
}
impl From<Rc<dyn Fn(&mut Cursive)>> for Callback {
fn from(f: Rc<dyn Fn(&mut Cursive)>) -> Self {
Callback(f)
}
}
impl From<Box<dyn Fn(&mut Cursive)>> for Callback {
fn from(f: Box<dyn Fn(&mut Cursive)>) -> Self {
Callback(Rc::from(f))
}
}
/// Answer to an event notification.
/// The event can be consumed or ignored.
pub enum EventResult {
/// The event was ignored. The parent can keep handling it.
Ignored,
/// The event was consumed. An optional callback to run is attached.
Consumed(Option<Callback>), // TODO: make this a FnOnce?
}
impl EventResult {
/// Convenient method to create `Consumed(Some(f))`
pub fn with_cb<F>(f: F) -> Self
where
F: 'static + Fn(&mut Cursive),
{
EventResult::Consumed(Some(Callback::from_fn(f)))
}
/// Convenient method to create `Consumed(Some(f))`
///
/// After being called once, the callback will become a no-op.
pub fn with_cb_once<F>(f: F) -> Self
where
F: 'static + FnOnce(&mut Cursive),
{
EventResult::Consumed(Some(Callback::from_fn_once(f)))
}
/// Convenient method to create `Consumed(None)`
pub fn consumed() -> Self {
EventResult::Consumed(None)
}
/// Returns `true` if `self` is `EventResult::Consumed`.
pub fn is_consumed(&self) -> bool {
matches!(*self, EventResult::Consumed(_))
}
/// Returns `true` if `self` contains a callback.
pub fn has_callback(&self) -> bool {
matches!(*self, EventResult::Consumed(Some(_)))
}
/// Process this result if it is a callback.
///
/// Does nothing otherwise.
pub fn process(self, s: &mut Cursive) {
if let EventResult::Consumed(Some(cb)) = self {
cb(s);
}
}
/// Returns `self` if it is not `EventResult::Ignored`, otherwise returns `f()`.
#[must_use]
pub fn or_else<F>(self, f: F) -> Self
where
F: FnOnce() -> EventResult,
{
match self {
EventResult::Ignored => f(),
other => other,
}
}
/// Returns an event result that combines `self` and `other`.
#[must_use]
pub fn and(self, other: Self) -> Self {
match (self, other) {
(EventResult::Ignored, result)
| (result, EventResult::Ignored) => result,
(EventResult::Consumed(None), EventResult::Consumed(cb))
| (EventResult::Consumed(cb), EventResult::Consumed(None)) => {
EventResult::Consumed(cb)
}
(
EventResult::Consumed(Some(cb1)),
EventResult::Consumed(Some(cb2)),
) => EventResult::with_cb(move |siv| {
(cb1)(siv);
(cb2)(siv);
}),
}
}
}
/// A non-character key on the keyboard
#[derive(PartialEq, Eq, Clone, Copy, Hash, Debug)]
pub enum Key {
/// Both Enter (or Return) and numpad Enter
Enter,
/// Tabulation key
Tab,
/// Backspace key
Backspace,
/// Escape key
Esc,
/// Left arrow
Left,
/// Right arrow
Right,
/// Up arrow
Up,
/// Down arrow
Down,
/// Insert key
Ins,
/// Delete key
Del,
/// Home key
Home,
/// End key
End,
/// Page Up key
PageUp,
/// Page Down key
PageDown,
/// Pause Break key
PauseBreak,
/// The 5 in the center of the keypad, when numlock is disabled.
NumpadCenter,
/// F0 key
F0,
/// F1 key
F1,
/// F2 key
F2,
/// F3 key
F3,
/// F4 key
F4,
/// F5 key
F5,
/// F6 key
F6,
/// F7 key
F7,
/// F8 key
F8,
/// F9 key
F9,
/// F10 key
F10,
/// F11 key
F11,
/// F12 key
F12,
}
impl Key {
/// Returns the function key corresponding to the given number
///
/// 1 -> F1, etc...
///
/// # Panics
///
/// If `n == 0 || n > 12`
pub fn from_f(n: u8) -> Key {
match n {
0 => Key::F0,
1 => Key::F1,
2 => Key::F2,
3 => Key::F3,
4 => Key::F4,
5 => Key::F5,
6 => Key::F6,
7 => Key::F7,
8 => Key::F8,
9 => Key::F9,
10 => Key::F10,
11 => Key::F11,
12 => Key::F12,
_ => panic!("unknown function key: F{}", n),
}
}
}
/// One of the buttons present on the mouse
#[derive(PartialEq, Eq, Clone, Copy, Hash, Debug)]
pub enum MouseButton {
/// The left button, used for main actions.
Left,
/// Middle button, probably the wheel. Often pastes text in X11 on linux.
Middle,
/// The right button, for special actions.
Right,
/// Fourth button if the mouse supports it.
Button4,
/// Fifth button if the mouse supports it.
Button5,
// TODO: handle more buttons?
#[doc(hidden)]
Other,
}
/// Represents a possible event sent by the mouse.
#[derive(PartialEq, Eq, Clone, Copy, Hash, Debug)]
pub enum MouseEvent {
/// A button was pressed.
Press(MouseButton),
/// A button was released.
Release(MouseButton),
/// A button is being held.
Hold(MouseButton),
/// The wheel was moved up.
WheelUp,
/// The wheel was moved down.
WheelDown,
}
impl MouseEvent {
/// Returns the button used by this event, if any.
///
/// Returns `None` if `self` is `WheelUp` or `WheelDown`.
pub fn button(self) -> Option<MouseButton> {
match self {
MouseEvent::Press(btn)
| MouseEvent::Release(btn)
| MouseEvent::Hold(btn) => Some(btn),
_ => None,
}
}
/// Returns `true` if `self` is an event that can grab focus.
///
/// This includes `Press`, `WheelUp` and `WheelDown`.
///
/// It does _not_ include `Release` or `Hold`.
///
/// It means you should be able to grab a scroll bar, and move the mouse
/// away from the view, without actually changing the focus.
pub fn grabs_focus(self) -> bool {
matches!(
self,
MouseEvent::Press(_) | MouseEvent::WheelUp | MouseEvent::WheelDown
)
}
}
/// Represents an event as seen by the application.
#[derive(PartialEq, Eq, Clone, Hash, Debug)]
pub enum Event {
/// Event fired when the window is resized.
WindowResize,
/// Event fired when the view is about to lose focus.
FocusLost,
/// Event fired regularly when a auto-refresh is set.
Refresh,
// TODO: have Char(modifier, char) and Key(modifier, key) enums?
/// A character was entered (includes numbers, punctuation, ...).
Char(char),
/// A character was entered with the Ctrl key pressed.
CtrlChar(char),
/// A character was entered with the Alt key pressed.
AltChar(char),
/// A non-character key was pressed.
Key(Key),
/// A non-character key was pressed with the Shift key pressed.
Shift(Key),
/// A non-character key was pressed with the Alt key pressed.
Alt(Key),
/// A non-character key was pressed with the Shift and Alt keys pressed.
AltShift(Key),
/// A non-character key was pressed with the Ctrl key pressed.
Ctrl(Key),
/// A non-character key was pressed with the Ctrl and Shift keys pressed.
CtrlShift(Key),
/// A non-character key was pressed with the Ctrl and Alt keys pressed.
CtrlAlt(Key),
/// A mouse event was sent.
Mouse {
/// Position of the top-left corner of the view receiving this event.
offset: Vec2,
/// Position of the mouse when this event was fired.
position: Vec2,
/// The mouse event itself.
event: MouseEvent,
},
// TODO: use a backend-dependent type for the unknown values?
/// An unknown event was received.
Unknown(Vec<u8>),
// Maybe add a `Custom(Rc<Any>)` ?
// Having a doc-hidden event prevents people from having exhaustive
// matches, allowing us to add events in the future.
//
// In addition we may not want people to listen to the exit event?
#[doc(hidden)]
/// The application is about to exit.
Exit,
}
impl Event {
/// Returns the position of the mouse, if `self` is a mouse event.
pub fn mouse_position(&self) -> Option<Vec2> {
if let Event::Mouse { position, .. } = *self {
Some(position)
} else {
None
}
}
/// Returns a mutable reference to the position of the mouse/
///
/// Returns `None` if `self` is not a mouse event.
pub fn mouse_position_mut(&mut self) -> Option<&mut Vec2> {
if let Event::Mouse {
ref mut position, ..
} = *self
{
Some(position)
} else {
None
}
}
/// Update `self` with the given offset.
///
/// If `self` is a mouse event, adds `top_left` to its offset.
/// Otherwise, do nothing.
pub fn relativize<V>(&mut self, top_left: V)
where
V: Into<Vec2>,
{
if let Event::Mouse { ref mut offset, .. } = *self {
*offset = *offset + top_left;
}
}
/// Returns a cloned, relativized event.
///
/// If `self` is a mouse event, adds `top_left` to its offset.
/// Otherwise, returns a simple clone.
#[must_use]
pub fn relativized<V>(&self, top_left: V) -> Self
where
V: Into<Vec2>,
{
let mut result = self.clone();
result.relativize(top_left);
result
}
}
impl From<char> for Event {
fn from(c: char) -> Event {
Event::Char(c)
}
}
impl From<Key> for Event {
fn from(k: Key) -> Event {
Event::Key(k)
}
}