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
#![doc = include_str!("../readme.md")]
mod focus;
mod zrect;
#[allow(unused_imports)]
use log::debug;
use ratatui::layout::Rect;
use std::cell::Cell;
use std::fmt::{Debug, Display, Formatter};
use std::rc::Rc;
pub use crate::focus::{handle_focus, handle_mouse_focus, Focus};
pub use crate::zrect::ZRect;
pub mod event {
//! Rexported eventhandling traits.
pub use rat_event::{
crossterm, ct_event, flow, try_flow, util, ConsumedEvent, HandleEvent, MouseOnly, Outcome,
Regular,
};
}
/// Holds the flags for the focus.
/// This struct is embedded in the widget state.
///
/// This is a wrapper around Rc<_some_impl_>, so cloning this is
/// cheap and what you want to do if you implement any high-level
/// focus-handling.
///
/// Attention:
/// Equality for FocusFlag means pointer-equality of the underlying
/// Rc using Rc::ptr_eq.
///
/// See [HasFocusFlag], [on_gained!](crate::on_gained!) and
/// [on_lost!](crate::on_lost!).
///
#[derive(Clone, Default)]
pub struct FocusFlag(Rc<FocusFlagCore>);
/// The same as FocusFlag, but distinct to mark the focus for
/// a container.
///
/// This serves the purpose of
///
/// * summarizing the focus for the container. If any of the
/// widgets of the container has the focus, the container
/// itself has the focus).
/// * identifying the container.
#[derive(Clone, Default)]
pub struct ContainerFlag(Rc<FocusFlagCore>);
/// Equality for FocusFlag means pointer equality of the underlying
/// Rc using Rc::ptr_eq.
impl PartialEq for FocusFlag {
fn eq(&self, other: &Self) -> bool {
Rc::ptr_eq(&self.0, &other.0)
}
}
impl Eq for FocusFlag {}
impl Display for FocusFlag {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(f, "|{}|", self.0.name)
}
}
/// Equality for ContainerFlag means pointer equality of the underlying
/// Rc using Rc::ptr_eq.
impl PartialEq for ContainerFlag {
fn eq(&self, other: &Self) -> bool {
Rc::ptr_eq(&self.0, &other.0)
}
}
impl Eq for ContainerFlag {}
impl Display for ContainerFlag {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
write!(f, "|{}|", self.0.name)
}
}
// not Clone, always Rc<>
#[derive(Default)]
struct FocusFlagCore {
/// Field name for debugging purposes.
name: Box<str>,
/// Focus.
focus: Cell<bool>,
/// This widget just gained the focus. This flag is set by [Focus::handle]
/// if there is a focus transfer, and will be reset by the next
/// call to [Focus::handle].
///
/// See [on_gained!](crate::on_gained!)
gained: Cell<bool>,
/// This widget just lost the focus. This flag is set by [Focus::handle]
/// if there is a focus transfer, and will be reset by the next
/// call to [Focus::handle].
///
/// See [on_lost!](crate::on_lost!)
lost: Cell<bool>,
}
/// Focus navigation for widgets.
#[derive(Debug, Clone, Copy, Default, PartialEq, Eq)]
pub enum Navigation {
/// Widget is not reachable with normal keyboard or mouse navigation.
None,
/// Widget is not reachable with keyboard navigation, but can be focused with the mouse.
Mouse,
/// Widget cannot be reached with normal keyboard navigation, but can be left.
/// (e.g. Tabs, Split-Divider)
Leave,
/// Widget can be reached with normal keyboard navigation, but not left.
/// (e.g. TextArea)
Reach,
/// Widget can be reached with normal keyboard navigation, but only be left with
/// backward navigation.
ReachLeaveFront,
/// Widget can be reached with normal keyboard navigation, but only be left with
/// forward navigation.
ReachLeaveBack,
/// Widget can be reached and left with normal keyboard navigation.
#[default]
Regular,
}
/// Trait for a widget that has a focus flag.
pub trait HasFocusFlag {
/// Access to the flag for the rest.
fn focus(&self) -> FocusFlag;
/// Access the area for mouse focus.
fn area(&self) -> Rect;
/// The widget might have several disjointed areas.
/// This is the case if it is showing a popup, but there
/// might be other causes.
///
/// This is seen as a higher resolution image of the
/// area given with area(). That means the result of
/// area() is the union of all areas given here.
fn z_areas(&self) -> &[ZRect] {
&[]
}
/// Declares how the widget interacts with focus.
///
/// Default is Navigation::Regular.
fn navigable(&self) -> Navigation {
Navigation::Regular
}
/// Focused?
fn is_focused(&self) -> bool {
self.focus().get()
}
/// Just lost focus.
fn lost_focus(&self) -> bool {
self.focus().lost()
}
/// Just gained focus.
fn gained_focus(&self) -> bool {
self.focus().gained()
}
}
/// Is this a container widget.
pub trait HasFocus {
/// Returns a Focus struct.
fn focus(&self) -> Focus;
/// Returns the container-flag
fn container(&self) -> Option<ContainerFlag> {
self.focus().container_flag()
}
/// Area of the container.
fn area(&self) -> Rect {
self.focus().container_area()
}
/// Focused?
fn is_focused(&self) -> bool {
if let Some(flag) = self.container() {
flag.get()
} else {
false
}
}
/// Just lost focus.
fn lost_focus(&self) -> bool {
if let Some(flag) = self.container() {
flag.lost()
} else {
false
}
}
/// Just gained focus.
fn gained_focus(&self) -> bool {
if let Some(flag) = self.container() {
flag.gained()
} else {
false
}
}
}
impl Debug for FocusFlag {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
f.debug_struct("FocusFlag")
.field("name", &self.name())
.field("focus", &self.get())
.field("gained", &self.gained())
.field("lost", &self.lost())
.finish()
}
}
impl Debug for ContainerFlag {
fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
f.debug_struct("ContainerFlag")
.field("name", &self.name())
.field("focus", &self.get())
.field("gained", &self.gained())
.field("lost", &self.lost())
.finish()
}
}
impl FocusFlag {
/// Create a default flag.
pub fn new() -> Self {
Self::default()
}
/// Create a named flag.
pub fn named(name: &str) -> Self {
Self(Rc::new(FocusFlagCore::named(name)))
}
/// Has the focus.
#[inline]
pub fn get(&self) -> bool {
self.0.focus.get()
}
/// Set the focus.
#[inline]
pub fn set(&self, focus: bool) {
self.0.focus.set(focus);
}
/// Get the field-name.
#[inline]
pub fn name(&self) -> &str {
self.0.name.as_ref()
}
/// Just lost the focus.
#[inline]
pub fn lost(&self) -> bool {
self.0.lost.get()
}
#[inline]
pub fn set_lost(&self, lost: bool) {
self.0.lost.set(lost);
}
/// Just gained the focus.
#[inline]
pub fn gained(&self) -> bool {
self.0.gained.get()
}
#[inline]
pub fn set_gained(&self, gained: bool) {
self.0.gained.set(gained);
}
/// Reset all flags to false.
#[inline]
pub fn clear(&self) {
self.0.focus.set(false);
self.0.lost.set(false);
self.0.gained.set(false);
}
}
impl ContainerFlag {
/// Create a default flag.
pub fn new() -> Self {
Self::default()
}
/// Create a named flag.
pub fn named(name: &str) -> Self {
Self(Rc::new(FocusFlagCore::named(name)))
}
/// Has the focus.
#[inline]
pub fn get(&self) -> bool {
self.0.focus.get()
}
/// Set the focus.
#[inline]
pub fn set(&self, focus: bool) {
self.0.focus.set(focus);
}
/// Get the field-name.
#[inline]
pub fn name(&self) -> &str {
self.0.name.as_ref()
}
/// Just lost the focus.
#[inline]
pub fn lost(&self) -> bool {
self.0.lost.get()
}
#[inline]
pub fn set_lost(&self, lost: bool) {
self.0.lost.set(lost);
}
/// Just gained the focus.
#[inline]
pub fn gained(&self) -> bool {
self.0.gained.get()
}
#[inline]
pub fn set_gained(&self, gained: bool) {
self.0.gained.set(gained);
}
/// Reset all flags to false.
#[inline]
pub fn clear(&self) {
self.0.focus.set(false);
self.0.lost.set(false);
self.0.gained.set(false);
}
}
impl FocusFlagCore {
pub(crate) fn named(name: &str) -> Self {
Self {
name: name.into(),
focus: Cell::new(false),
gained: Cell::new(false),
lost: Cell::new(false),
}
}
}
/// Does a match on the state struct of a widget. If `widget_state.lost_focus()` is true
/// the block is executed. This requires that `widget_state` implements [HasFocusFlag],
/// but that's the basic requirement for this whole crate.
///
/// ```rust ignore
/// use rat_focus::on_lost;
///
/// on_lost!(
/// state.field1 => {
/// // do checks
/// },
/// state.field2 => {
/// // do checks
/// }
/// );
/// ```
#[macro_export]
macro_rules! on_lost {
($($field:expr => $validate:expr),*) => {{
use $crate::HasFocusFlag;
$(if $field.lost_focus() { _ = $validate })*
}};
}
/// Does a match on the state struct of a widget. If `widget_state.gained_focus()` is true
/// the block is executed. This requires that `widget_state` implements [HasFocusFlag],
/// but that's the basic requirement for this whole crate.
///
/// ```rust ignore
/// use rat_focus::on_gained;
///
/// on_gained!(
/// state.field1 => {
/// // do prep
/// },
/// state.field2 => {
/// // do prep
/// }
/// );
/// ```
#[macro_export]
macro_rules! on_gained {
($($field:expr => $validate:expr),*) => {{
use $crate::HasFocusFlag;
$(if $field.gained_focus() { _ = $validate })*
}};
}
/// Does a match on the state struct of a widget. If
/// `widget_state.is_focused()` is true the block is executed.
/// There is a `_` branch too, that is evaluated if none of the
/// given widget-states has the focus.
///
/// This requires that `widget_state` implements [HasFocusFlag],
/// but that's the basic requirement for this whole crate.
///
/// ```rust ignore
/// use rat_focus::match_focus;
///
/// let res = match_focus!(
/// state.field1 => {
/// // do this
/// true
/// },
/// state.field2 => {
/// // do that
/// true
/// },
/// _ => {
/// false
/// }
/// );
///
/// if res {
/// // react
/// }
/// ```
///
#[macro_export]
macro_rules! match_focus {
($($field:expr => $block:expr),* $(, _ => $final:expr)?) => {{
use $crate::HasFocusFlag;
if false {
unreachable!();
}
$(else if $field.is_focused() { $block })*
$(else { $final })?
}};
}