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
//! Context hooks with proper lifecycle management.
//!
//! This module provides React-like context hooks that allow components to share
//! values without explicitly passing props through every level of the tree.
//!
//! # Example
//!
//! ```rust,ignore
//! use reratui_fiber::hooks::{use_context_provider, use_context};
//!
//! // Define a theme context
//! #[derive(Clone)]
//! struct Theme {
//!     primary: Color,
//!     background: Color,
//! }
//!
//! // Provider component
//! #[component]
//! fn ThemeProvider(children: Element) -> Element {
//!     let theme = use_context_provider(|| Theme {
//!         primary: Color::Cyan,
//!         background: Color::Black,
//!     });
//!     
//!     rsx! { {children} }
//! }
//!
//! // Consumer component
//! #[component]
//! fn ThemedButton(label: &str) -> Element {
//!     let theme = use_context::<Theme>();
//!     
//!     rsx! {
//!         <Block style={Style::default().fg(theme.primary)}>
//!             {label}
//!         </Block>
//!     }
//! }
//! ```

use std::any::TypeId;

use crate::context_stack::push_context;
use crate::fiber_tree::with_current_fiber;

/// Provide a context value to all descendants.
///
/// The value is created using the provided initializer function and made available
/// to all descendant components via `use_context`. The value is automatically
/// cleaned up when the provider fiber unmounts.
///
/// # Type Parameters
///
/// * `T` - The context value type. Must be `Clone + Send + Sync + 'static`.
/// * `F` - The initializer function type.
///
/// # Arguments
///
/// * `create_value` - A function that creates the initial context value.
///   Only called on the first render.
///
/// # Returns
///
/// The context value (cloned).
///
/// # Example
///
/// ```rust,ignore
/// #[derive(Clone)]
/// struct AppConfig {
///     api_url: String,
///     debug_mode: bool,
/// }
///
/// #[component]
/// fn App() -> Element {
///     // Provide config to all descendants
///     let config = use_context_provider(|| AppConfig {
///         api_url: "https://api.example.com".to_string(),
///         debug_mode: cfg!(debug_assertions),
///     });
///     
///     rsx! { <MainContent /> }
/// }
/// ```
///
/// # Panics
///
/// Panics if called outside of a component render context (no current fiber).
pub fn use_context_provider<T, F>(create_value: F) -> T
where
    T: Clone + Send + Sync + 'static,
    F: FnOnce() -> T,
{
    with_current_fiber(|fiber| {
        let hook_index = fiber.next_hook_index();
        let type_id = TypeId::of::<T>();
        let fiber_id = fiber.id;

        // Check if we already have a value for this hook
        if let Some(existing) = fiber.get_hook::<T>(hook_index) {
            return existing;
        }

        // Create the new value
        let value = create_value();

        // Store in fiber's hook state
        fiber.set_hook(hook_index, value.clone());

        // Push to context stack with fiber ownership
        push_context(fiber_id, value.clone());

        // Track that this fiber provides this context type
        if !fiber.provided_contexts.contains(&type_id) {
            fiber.provided_contexts.push(type_id);
        }

        value
    })
    .expect("use_context_provider must be called within a component render context")
}

/// Consume a context value from the nearest ancestor provider.
///
/// Returns the value from the nearest ancestor that called `use_context_provider`
/// with the same type `T`.
///
/// # Type Parameters
///
/// * `T` - The context value type. Must be `Clone + Send + Sync + 'static`.
///
/// # Returns
///
/// The context value from the nearest provider.
///
/// # Example
///
/// ```rust,ignore
/// #[component]
/// fn UserProfile() -> Element {
///     // Get the user context from an ancestor provider
///     let user = use_context::<User>();
///     
///     rsx! {
///         <Block>
///             <Text text={format!("Hello, {}!", user.name)} />
///         </Block>
///     }
/// }
/// ```
///
/// # Panics
///
/// Panics if no provider exists for the context type `T`.
/// Use `try_use_context` if you want to handle missing providers gracefully.
pub fn use_context<T>() -> T
where
    T: Clone + Send + Sync + 'static,
{
    try_use_context::<T>().unwrap_or_else(|| {
        panic!(
            "use_context: No provider found for context type `{}`. \
             Make sure a parent component calls use_context_provider with this type.",
            std::any::type_name::<T>()
        )
    })
}

/// Try to consume a context value, returning None if no provider exists.
///
/// This is a non-panicking version of `use_context` that returns `None`
/// if no provider exists for the context type.
///
/// # Type Parameters
///
/// * `T` - The context value type. Must be `Clone + Send + Sync + 'static`.
///
/// # Returns
///
/// `Some(value)` if a provider exists, `None` otherwise.
///
/// # Example
///
/// ```rust,ignore
/// #[component]
/// fn OptionalThemeConsumer() -> Element {
///     // Works with or without a theme provider
///     let style = match try_use_context::<Theme>() {
///         Some(theme) => Style::default().fg(theme.primary),
///         None => Style::default().fg(Color::White),
///     };
///     
///     rsx! {
///         <Block style={style}>
///             {"Content"}
///         </Block>
///     }
/// }
/// ```
pub fn try_use_context<T>() -> Option<T>
where
    T: Clone + Send + Sync + 'static,
{
    crate::context_stack::get_context::<T>()
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::context_stack::clear_context_stack;
    use crate::fiber::FiberId;
    use crate::fiber_tree::{FiberTree, clear_fiber_tree, set_fiber_tree};

    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 cleanup_test() {
        clear_fiber_tree();
        clear_context_stack();
    }

    #[test]
    fn test_use_context_provider_creates_value() {
        let _fiber_id = setup_test_fiber();

        let value = use_context_provider(|| 42i32);
        assert_eq!(value, 42);

        cleanup_test();
    }

    #[test]
    fn test_use_context_provider_returns_same_value_on_rerender() {
        let fiber_id = setup_test_fiber();

        // First render
        let value1 = use_context_provider(|| 100i32);
        assert_eq!(value1, 100);

        // Simulate re-render
        crate::fiber_tree::with_fiber_tree_mut(|tree| {
            tree.end_render();
            tree.begin_render(fiber_id);
        });

        // Second render - should return same value, not call initializer again
        let value2 = use_context_provider(|| 999i32);
        assert_eq!(value2, 100); // Still 100, not 999

        cleanup_test();
    }

    #[test]
    fn test_use_context_provider_pushes_to_context_stack() {
        let _fiber_id = setup_test_fiber();

        use_context_provider(|| "test-value".to_string());

        // Value should be available in context stack
        let value = crate::context_stack::get_context::<String>();
        assert_eq!(value, Some("test-value".to_string()));

        cleanup_test();
    }

    #[test]
    fn test_use_context_provider_tracks_provided_contexts() {
        let fiber_id = setup_test_fiber();

        use_context_provider(|| 42i32);
        use_context_provider(|| "hello".to_string());

        // Check that fiber tracks provided context types
        crate::fiber_tree::with_fiber_tree_mut(|tree| {
            let fiber = tree.get(fiber_id).unwrap();
            assert!(fiber.provided_contexts.contains(&TypeId::of::<i32>()));
            assert!(fiber.provided_contexts.contains(&TypeId::of::<String>()));
        });

        cleanup_test();
    }

    #[test]
    fn test_try_use_context_returns_value() {
        let _fiber_id = setup_test_fiber();

        use_context_provider(|| 42i32);

        let value = try_use_context::<i32>();
        assert_eq!(value, Some(42));

        cleanup_test();
    }

    #[test]
    fn test_try_use_context_returns_none_without_provider() {
        cleanup_test(); // Ensure clean state

        let value = try_use_context::<i32>();
        assert_eq!(value, None);
    }

    #[test]
    fn test_use_context_returns_value() {
        let _fiber_id = setup_test_fiber();

        use_context_provider(|| "context-value".to_string());

        let value = use_context::<String>();
        assert_eq!(value, "context-value");

        cleanup_test();
    }

    #[test]
    #[should_panic(expected = "No provider found for context type")]
    fn test_use_context_panics_without_provider() {
        cleanup_test(); // Ensure clean state

        // This should panic because there's no provider
        let _ = use_context::<i32>();
    }

    #[test]
    fn test_nested_providers_shadow() {
        // Setup outer fiber
        let mut tree = FiberTree::new();
        let outer_fiber = tree.mount(None, None);
        let inner_fiber = tree.mount(Some(outer_fiber), None);
        set_fiber_tree(tree);

        // Outer provider
        crate::fiber_tree::with_fiber_tree_mut(|tree| {
            tree.begin_render(outer_fiber);
        });
        use_context_provider(|| "outer".to_string());
        crate::fiber_tree::with_fiber_tree_mut(|tree| {
            tree.end_render();
        });

        // Inner provider shadows outer
        crate::fiber_tree::with_fiber_tree_mut(|tree| {
            tree.begin_render(inner_fiber);
        });
        use_context_provider(|| "inner".to_string());

        // Should get inner value
        let value = use_context::<String>();
        assert_eq!(value, "inner");

        cleanup_test();
    }

    #[test]
    fn test_multiple_context_types() {
        let _fiber_id = setup_test_fiber();

        use_context_provider(|| 42i32);
        use_context_provider(|| "hello".to_string());
        use_context_provider(|| true);

        assert_eq!(use_context::<i32>(), 42);
        assert_eq!(use_context::<String>(), "hello");
        assert!(use_context::<bool>());

        cleanup_test();
    }

    #[test]
    fn test_context_with_custom_type() {
        #[derive(Clone, Debug, PartialEq)]
        struct Theme {
            name: String,
            dark_mode: bool,
        }

        let _fiber_id = setup_test_fiber();

        let provided_theme = use_context_provider(|| Theme {
            name: "default".to_string(),
            dark_mode: true,
        });

        assert_eq!(provided_theme.name, "default");
        assert!(provided_theme.dark_mode);

        let consumed_theme = use_context::<Theme>();
        assert_eq!(consumed_theme, provided_theme);

        cleanup_test();
    }

    #[test]
    #[should_panic(
        expected = "use_context_provider must be called within a component render context"
    )]
    fn test_use_context_provider_panics_outside_render() {
        cleanup_test();

        // This should panic because there's no current fiber
        let _ = use_context_provider(|| 42i32);
    }
}