tui-pages 0.7.2

Core for TUI apps with multiple pages
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

use crate::focus::{FocusIntent, FocusTarget, FocusWrap};
use crate::navigation::BufferState;

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum NavigationEvent<V> {
    NavigateTo(V),
    NextBuffer,
    PreviousBuffer,
    CloseBuffer,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub enum NavigationResult<V> {
    Navigated { to: V },
    Switched { from: V, to: V },
    Closed { closed: V, now_on: V },
    NoChange,
}

pub trait NavigationRouter<V> {
    fn sync_to_view(&mut self, view: &V);
    fn current_view(&self) -> V;
    fn focus_targets(&self) -> Vec<FocusTarget>;
}

#[derive(Debug, Clone, Copy, Default)]
pub struct NavigationCoordinator;

impl NavigationCoordinator {
    pub fn navigate<V, R>(
        event: NavigationEvent<V>,
        router: &mut R,
        buffer: &mut BufferState<V>,
        fallback: V,
        wrap: FocusWrap,
    ) -> (NavigationResult<V>, Option<FocusIntent>)
    where
        V: Clone + PartialEq,
        R: NavigationRouter<V>,
    {
        match event {
            NavigationEvent::NavigateTo(view) => Self::navigate_to(view, router, buffer),
            NavigationEvent::NextBuffer => Self::switch_buffer(true, router, buffer, wrap),
            NavigationEvent::PreviousBuffer => Self::switch_buffer(false, router, buffer, wrap),
            NavigationEvent::CloseBuffer => Self::close_buffer(router, buffer, fallback),
        }
    }

    fn navigate_to<V, R>(
        view: V,
        router: &mut R,
        buffer: &mut BufferState<V>,
    ) -> (NavigationResult<V>, Option<FocusIntent>)
    where
        V: Clone + PartialEq,
        R: NavigationRouter<V>,
    {
        buffer.update_history(view.clone());
        router.sync_to_view(&view);
        (
            NavigationResult::Navigated { to: view },
            Self::focus_intent_for_router(router),
        )
    }

    fn switch_buffer<V, R>(
        forward: bool,
        router: &mut R,
        buffer: &mut BufferState<V>,
        wrap: FocusWrap,
    ) -> (NavigationResult<V>, Option<FocusIntent>)
    where
        V: Clone + PartialEq,
        R: NavigationRouter<V>,
    {
        if buffer.history.len() <= 1 {
            return (NavigationResult::NoChange, None);
        }

        let old_view = buffer.history[buffer.active_index].clone();
        let len = buffer.history.len();
        buffer.active_index = wrap.step(buffer.active_index, len, forward);
        buffer.sync_active_pane_to_active_buffer();

        let new_view = buffer.history[buffer.active_index].clone();
        router.sync_to_view(&new_view);
        (
            NavigationResult::Switched {
                from: old_view,
                to: new_view,
            },
            Self::focus_intent_for_router(router),
        )
    }

    fn close_buffer<V, R>(
        router: &mut R,
        buffer: &mut BufferState<V>,
        fallback: V,
    ) -> (NavigationResult<V>, Option<FocusIntent>)
    where
        V: Clone + PartialEq,
        R: NavigationRouter<V>,
    {
        let Some(closed_view) = buffer.close_active_buffer(fallback) else {
            return (NavigationResult::NoChange, None);
        };
        let new_view = buffer
            .get_active_view()
            .cloned()
            .unwrap_or_else(|| router.current_view());
        buffer.replace_workspace_view(&closed_view, new_view.clone());
        router.sync_to_view(&new_view);
        (
            NavigationResult::Closed {
                closed: closed_view,
                now_on: new_view,
            },
            Self::focus_intent_for_router(router),
        )
    }

    fn focus_intent_for_router<V, R>(router: &R) -> Option<FocusIntent>
    where
        R: NavigationRouter<V>,
    {
        let targets = router.focus_targets();
        if targets.is_empty() {
            None
        } else {
            Some(FocusIntent::RegisterPage(targets))
        }
    }
}