reratui 1.1.0

A modern, reactive TUI framework for Rust with React-inspired hooks and components, powered by ratatui
Documentation
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
//! Event system for sharing terminal events between components.
//!
//! This module provides the event state management for the fiber-based component system.
//! It allows components to access terminal events (keyboard, mouse, resize) through
//! the `use_event` hook.
//!
//! # Architecture
//!
//! Events are available to ALL components during a render frame, matching React's
//! event semantics. Components can explicitly call `stop_propagation()` to prevent
//! other components from receiving the event.
//!
//! # Example
//!
//! ```rust,ignore
//! use reratui_fiber::event::{set_current_event, clear_current_event};
//! use crossterm::event::Event;
//! use std::sync::Arc;
//!
//! // Set an event (typically done by the runtime)
//! set_current_event(Some(Arc::new(Event::Key(...))));
//!
//! // Components can then use use_event() to access it
//! // Multiple components can read the same event!
//!
//! // Clear the event at the end of the render cycle
//! clear_current_event();
//! ```

use crate::fiber::FiberId;
use crossterm::event::Event;
use once_cell::sync::Lazy;
use std::sync::{Arc, RwLock};
use tracing::debug;

/// Structure to track the current event and propagation state.
///
/// Events are available to all fibers during a render frame unless propagation
/// is explicitly stopped. This matches React's event semantics where events
/// bubble through the component tree.
#[derive(Default)]
pub struct EventState {
    /// The current event being processed.
    pub(crate) event: Option<Arc<Event>>,
    /// Whether propagation has been stopped for this event.
    pub(crate) propagation_stopped: bool,
    /// The fiber that stopped propagation (can still read the event).
    pub(crate) stopped_by_fiber: Option<FiberId>,
}

impl EventState {
    /// Creates a new empty EventState.
    pub fn new() -> Self {
        Self::default()
    }

    /// Returns true if an event is currently available.
    pub fn has_event(&self) -> bool {
        self.event.is_some()
    }

    /// Resets propagation state (called when new event is set).
    pub fn reset_propagation(&mut self) {
        self.propagation_stopped = false;
        self.stopped_by_fiber = None;
    }
}

/// Global storage for the current event.
///
/// This is thread-local to ensure proper isolation in multi-threaded scenarios.
pub(crate) static CURRENT_EVENT: Lazy<RwLock<EventState>> = Lazy::new(Default::default);

/// Sets the current event in the global storage.
///
/// This function should be called by the runtime when an event is received.
/// It resets propagation state, allowing all fibers to read the new event.
///
/// # Arguments
///
/// * `event` - The event to set, or None to clear the current event.
///
/// # Example
///
/// ```rust,ignore
/// use reratui_fiber::event::set_current_event;
/// use crossterm::event::{Event, KeyCode, KeyEvent, KeyEventKind, KeyModifiers};
/// use std::sync::Arc;
///
/// let key_event = Event::Key(KeyEvent::new(KeyCode::Char('a'), KeyModifiers::NONE));
/// set_current_event(Some(Arc::new(key_event)));
/// ```
pub fn set_current_event(event: Option<Arc<Event>>) {
    let event_debug = event.clone();

    let mut current_event = CURRENT_EVENT.write().unwrap();
    current_event.event = event;
    current_event.reset_propagation();

    debug!("Set current event: {:?}, propagation reset", event_debug);
}

/// Gets the current event for the current fiber.
///
/// Returns the event if:
/// - An event is available
/// - Propagation has not been stopped, OR
/// - This fiber is the one that stopped propagation
///
/// Unlike the previous implementation, this does NOT consume the event.
/// Multiple calls from the same fiber or different fibers will all receive
/// the same event, matching React's event semantics.
///
/// # Returns
///
/// * `Some(Arc<Event>)` - The current event if available and propagation allows.
/// * `None` - If no event is available or propagation was stopped by another fiber.
pub fn get_current_event() -> Option<Arc<Event>> {
    use crate::fiber_tree::with_current_fiber;

    let event_state = CURRENT_EVENT.read().unwrap();

    // Get the current event, return None if no event is available
    let event = match event_state.event.as_ref() {
        Some(e) => e.clone(),
        None => {
            debug!("No event available");
            return None;
        }
    };

    // Check if propagation was stopped
    if event_state.propagation_stopped {
        // Get current fiber ID
        let current_fiber_id = with_current_fiber(|fiber| fiber.id);

        // Allow the fiber that stopped propagation to still read the event
        if current_fiber_id != event_state.stopped_by_fiber {
            debug!("Propagation stopped by another fiber");
            return None;
        }
    }

    Some(event)
}

/// Stops propagation of the current event.
///
/// After calling this, only the fiber that called stop_propagation
/// can continue to read the event via use_event(). All other fibers
/// will receive None.
///
/// This matches React's `event.stopPropagation()` behavior.
pub fn stop_event_propagation() {
    use crate::fiber_tree::with_current_fiber;

    let current_fiber_id = with_current_fiber(|fiber| fiber.id);

    let mut event_state = CURRENT_EVENT.write().unwrap();
    event_state.propagation_stopped = true;
    event_state.stopped_by_fiber = current_fiber_id;

    debug!("Propagation stopped by fiber {:?}", current_fiber_id);
}

/// Clears the current event from the global storage.
///
/// This function should be called at the end of each render cycle to ensure
/// events don't persist across renders.
pub fn clear_current_event() {
    set_current_event(None);
}

/// Returns the current event without affecting propagation state.
///
/// This is useful for peeking at the event without consuming it.
/// Works even after stop_propagation() was called.
///
/// # Returns
///
/// * `Some(Arc<Event>)` - The current event if available.
/// * `None` - If no event is available.
pub fn peek_current_event() -> Option<Arc<Event>> {
    let event_state = CURRENT_EVENT.read().unwrap();
    event_state.event.clone()
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::fiber_tree::{FiberTree, clear_fiber_tree, set_fiber_tree, with_fiber_tree_mut};
    use crossterm::event::{KeyCode, KeyEvent, KeyEventKind, KeyModifiers};
    use once_cell::sync::Lazy;
    use parking_lot::Mutex;

    /// Test mutex to ensure tests run sequentially since they share global state
    /// This is shared between unit tests and property tests
    pub(super) static TEST_MUTEX: Lazy<Mutex<()>> = Lazy::new(|| Mutex::new(()));

    fn create_test_key_event(c: char) -> Event {
        Event::Key(KeyEvent::new_with_kind(
            KeyCode::Char(c),
            KeyModifiers::NONE,
            KeyEventKind::Press,
        ))
    }

    fn setup_test_fiber() -> FiberId {
        let mut tree = FiberTree::new();
        let fiber_id = tree.mount(None, None);
        tree.begin_render(fiber_id);
        set_fiber_tree(tree);
        fiber_id
    }

    fn teardown_test_fiber() {
        with_fiber_tree_mut(|tree| {
            tree.end_render();
        });
        clear_fiber_tree();
    }

    #[test]
    fn test_set_and_get_event() {
        let _lock = TEST_MUTEX.lock();
        clear_current_event();
        setup_test_fiber();

        let event = create_test_key_event('a');
        set_current_event(Some(Arc::new(event.clone())));

        let retrieved = get_current_event();
        assert!(retrieved.is_some());

        if let Some(e) = retrieved {
            if let Event::Key(key) = &*e {
                assert_eq!(key.code, KeyCode::Char('a'));
            } else {
                panic!("Expected Key event");
            }
        }

        teardown_test_fiber();
    }

    #[test]
    fn test_event_available_multiple_times_per_fiber() {
        let _lock = TEST_MUTEX.lock();
        clear_current_event();
        setup_test_fiber();

        let event = create_test_key_event('b');
        set_current_event(Some(Arc::new(event)));

        // First call should return the event
        let first = get_current_event();
        assert!(first.is_some());

        // Second call should ALSO return the event (React-like behavior)
        let second = get_current_event();
        assert!(second.is_some());

        // Third call should ALSO return the event
        let third = get_current_event();
        assert!(third.is_some());

        teardown_test_fiber();
    }

    #[test]
    fn test_different_fibers_can_read_same_event() {
        let _lock = TEST_MUTEX.lock();
        clear_current_event();

        let mut tree = FiberTree::new();
        let fiber1 = tree.mount(None, None);
        let fiber2 = tree.mount(None, None);
        set_fiber_tree(tree);

        let event = create_test_key_event('c');
        set_current_event(Some(Arc::new(event)));

        // Fiber 1 reads the event
        with_fiber_tree_mut(|tree| {
            tree.begin_render(fiber1);
        });
        let result1 = get_current_event();
        assert!(result1.is_some());
        with_fiber_tree_mut(|tree| {
            tree.end_render();
        });

        // Fiber 2 can also read the same event
        with_fiber_tree_mut(|tree| {
            tree.begin_render(fiber2);
        });
        let result2 = get_current_event();
        assert!(result2.is_some());
        with_fiber_tree_mut(|tree| {
            tree.end_render();
        });

        // Fiber 1 can read again (no consumption)
        with_fiber_tree_mut(|tree| {
            tree.begin_render(fiber1);
        });
        let result1_again = get_current_event();
        assert!(result1_again.is_some());
        with_fiber_tree_mut(|tree| {
            tree.end_render();
        });

        clear_fiber_tree();
    }

    #[test]
    fn test_stop_propagation_blocks_other_fibers() {
        let _lock = TEST_MUTEX.lock();
        clear_current_event();

        let mut tree = FiberTree::new();
        let fiber1 = tree.mount(None, None);
        let fiber2 = tree.mount(None, None);
        set_fiber_tree(tree);

        let event = create_test_key_event('d');
        set_current_event(Some(Arc::new(event)));

        // Fiber 1 reads and stops propagation
        with_fiber_tree_mut(|tree| {
            tree.begin_render(fiber1);
        });
        let result1 = get_current_event();
        assert!(result1.is_some());
        stop_event_propagation();
        with_fiber_tree_mut(|tree| {
            tree.end_render();
        });

        // Fiber 2 should NOT be able to read the event
        with_fiber_tree_mut(|tree| {
            tree.begin_render(fiber2);
        });
        let result2 = get_current_event();
        assert!(result2.is_none());
        with_fiber_tree_mut(|tree| {
            tree.end_render();
        });

        clear_fiber_tree();
    }

    #[test]
    fn test_stop_propagation_allows_same_fiber() {
        let _lock = TEST_MUTEX.lock();
        clear_current_event();
        let fiber_id = setup_test_fiber();

        let event = create_test_key_event('e');
        set_current_event(Some(Arc::new(event)));

        // Read event
        let result1 = get_current_event();
        assert!(result1.is_some());

        // Stop propagation
        stop_event_propagation();

        // Same fiber can still read the event
        let result2 = get_current_event();
        assert!(result2.is_some());

        // Verify it's the same fiber
        with_fiber_tree_mut(|tree| {
            assert!(tree.get(fiber_id).is_some());
        });

        teardown_test_fiber();
    }

    #[test]
    fn test_clear_event() {
        let _lock = TEST_MUTEX.lock();
        clear_current_event();
        setup_test_fiber();

        let event = create_test_key_event('f');
        set_current_event(Some(Arc::new(event)));

        // Event should be available
        assert!(peek_current_event().is_some());

        // Clear the event
        clear_current_event();

        // Event should no longer be available
        assert!(peek_current_event().is_none());

        teardown_test_fiber();
    }

    #[test]
    fn test_new_event_resets_propagation_state() {
        let _lock = TEST_MUTEX.lock();
        clear_current_event();

        let mut tree = FiberTree::new();
        let fiber1 = tree.mount(None, None);
        let fiber2 = tree.mount(None, None);
        set_fiber_tree(tree);

        let event1 = create_test_key_event('g');
        set_current_event(Some(Arc::new(event1)));

        // Fiber 1 stops propagation
        with_fiber_tree_mut(|tree| {
            tree.begin_render(fiber1);
        });
        stop_event_propagation();
        with_fiber_tree_mut(|tree| {
            tree.end_render();
        });

        // Set a new event - should reset propagation
        let event2 = create_test_key_event('h');
        set_current_event(Some(Arc::new(event2)));

        // Fiber 2 should be able to read the new event
        with_fiber_tree_mut(|tree| {
            tree.begin_render(fiber2);
        });
        let result = get_current_event();
        assert!(result.is_some());
        with_fiber_tree_mut(|tree| {
            tree.end_render();
        });

        clear_fiber_tree();
    }

    #[test]
    fn test_peek_does_not_affect_propagation() {
        let _lock = TEST_MUTEX.lock();
        clear_current_event();
        setup_test_fiber();

        let event = create_test_key_event('i');
        set_current_event(Some(Arc::new(event)));

        // Peek at the event
        let peeked = peek_current_event();
        assert!(peeked.is_some());

        // Fiber should still be able to get the event
        let retrieved = get_current_event();
        assert!(retrieved.is_some());

        // Peek again after stop_propagation
        stop_event_propagation();
        let peeked_after = peek_current_event();
        assert!(peeked_after.is_some());

        teardown_test_fiber();
    }

    #[test]
    fn test_event_state_helpers() {
        let _lock = TEST_MUTEX.lock();
        clear_current_event();

        let state = CURRENT_EVENT.read().unwrap();
        assert!(!state.has_event());
        drop(state);

        let event = create_test_key_event('j');
        set_current_event(Some(Arc::new(event)));

        let state = CURRENT_EVENT.read().unwrap();
        assert!(state.has_event());
        assert!(!state.propagation_stopped);
        assert!(state.stopped_by_fiber.is_none());
    }

    #[test]
    fn test_propagation_state_reset() {
        let _lock = TEST_MUTEX.lock();
        clear_current_event();

        let mut state = EventState::new();
        state.propagation_stopped = true;
        state.stopped_by_fiber = Some(FiberId(42));

        state.reset_propagation();

        assert!(!state.propagation_stopped);
        assert!(state.stopped_by_fiber.is_none());
    }
}