summaryrefslogtreecommitdiffstats
path: root/src/app/widgets/base/time_graph.rs
blob: 47436f71a0a716d668bb5a11a4c4cbbdf51c52f8 (plain)
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
use std::{
    borrow::Cow,
    time::{Duration, Instant},
};

use crossterm::event::{KeyEvent, KeyModifiers, MouseEvent, MouseEventKind};
use tui::{
    backend::Backend,
    layout::{Constraint, Rect},
    style::Style,
    symbols::Marker,
    text::Span,
    widgets::{Block, GraphType},
};

use crate::{
    app::{
        event::ComponentEventResult,
        widgets::tui_stuff::{
            custom_legend_chart::{Axis, Dataset},
            TimeChart,
        },
        AppConfigFields, Component,
    },
    canvas::Painter,
    constants::{
        AUTOHIDE_TIMEOUT_MILLISECONDS, STALE_MAX_MILLISECONDS, STALE_MIN_MILLISECONDS,
        TIME_LABEL_HEIGHT_LIMIT,
    },
};

#[derive(Clone)]
pub enum AutohideTimerState {
    Hidden,
    Running(Instant),
}

#[derive(Clone)]
pub enum AutohideTimer {
    AlwaysShow,
    AlwaysHide,
    Enabled {
        state: AutohideTimerState,
        show_duration: Duration,
    },
}

// TODO: [AUTOHIDE] Not a fan of how this is done, as this should really "trigger" a draw when it's done.
impl AutohideTimer {
    fn start_display_timer(&mut self) {
        match self {
            AutohideTimer::AlwaysShow | AutohideTimer::AlwaysHide => {
                // Do nothing.
            }
            AutohideTimer::Enabled {
                state,
                show_duration: _,
            } => {
                *state = AutohideTimerState::Running(Instant::now());
            }
        }
    }

    pub fn update_display_timer(&mut self) {
        match self {
            AutohideTimer::AlwaysShow | AutohideTimer::AlwaysHide => {
                // Do nothing.
            }
            AutohideTimer::Enabled {
                state,
                show_duration,
            } => match state {
                AutohideTimerState::Hidden => {}
                AutohideTimerState::Running(trigger_instant) => {
                    if trigger_instant.elapsed() > *show_duration {
                        *state = AutohideTimerState::Hidden;
                    }
                }
            },
        }
    }

    pub fn is_showing(&mut self) -> bool {
        self.update_display_timer();
        match self {
            AutohideTimer::AlwaysShow => true,
            AutohideTimer::AlwaysHide => false,
            AutohideTimer::Enabled {
                state,
                show_duration: _,
            } => match state {
                AutohideTimerState::Hidden => false,
                AutohideTimerState::Running(_) => true,
            },
        }
    }
}

pub struct TimeGraphData<'d> {
    pub data: &'d [(f64, f64)],
    pub label: Option<Cow<'static, str>>,
    pub style: Style,
}

/// A graph widget with controllable time ranges along the x-axis.
pub struct TimeGraph {
    current_display_time: u64,
    autohide_timer: AutohideTimer,

    default_time_value: u64,

    min_duration: u64,
    max_duration: u64,
    time_interval: u64,

    bounds: Rect,
    border_bounds: Rect,

    use_dot: bool,
}

impl TimeGraph {
    /// Creates a new [`TimeGraph`].  All time values are in milliseconds.
    pub fn new(
        start_value: u64, autohide_timer: AutohideTimer, min_duration: u64, max_duration: u64,
        time_interval: u64, use_dot: bool,
    ) -> Self {
        Self {
            current_display_time: start_value,
            autohide_timer,
            default_time_value: start_value,
            min_duration,
            max_duration,
            time_interval,
            bounds: Rect::default(),
            border_bounds: Rect::default(),
            use_dot,
        }
    }

    /// Creates a new [`TimeGraph`] given an [`AppConfigFields`].
    pub fn from_config(app_config_fields: &AppConfigFields) -> Self {
        Self::new(
            app_config_fields.default_time_value,
            if app_config_fields.hide_time {
                AutohideTimer::AlwaysHide
            } else if app_config_fields.autohide_time {
                AutohideTimer::Enabled {
                    state: AutohideTimerState::Running(Instant::now()),
                    show_duration: Duration::from_millis(AUTOHIDE_TIMEOUT_MILLISECONDS),
                }
            } else {
                AutohideTimer::AlwaysShow
            },
            STALE_MIN_MILLISECONDS,
            STALE_MAX_MILLISECONDS,
            app_config_fields.time_interval,
            app_config_fields.use_dot,
        )
    }

    /// Handles a char `c`.
    fn handle_char(&mut self, c: char) -> ComponentEventResult {
        match c {
            '-' => self.zoom_out(),
            '+' => self.zoom_in(),
            '=' => self.reset_zoom(),
            _ => ComponentEventResult::Unhandled,
        }
    }

    fn zoom_in(&mut self) -> ComponentEventResult {
        let new_time = self.current_display_time.saturating_sub(self.time_interval);

        if self.current_display_time == new_time {
            ComponentEventResult::NoRedraw
        } else if new_time >= self.min_duration {
            self.current_display_time = new_time;
            self.autohide_timer.start_display_timer();

            ComponentEventResult::Redraw
        } else if new_time != self.min_duration {
            self.current_display_time = self.min_duration;
            self.autohide_timer.start_display_timer();

            ComponentEventResult::Redraw
        } else {
            ComponentEventResult::NoRedraw
        }
    }

    fn zoom_out(&mut self) -> ComponentEventResult {
        let new_time = self.current_display_time + self.time_interval;

        if self.current_display_time == new_time {
            ComponentEventResult::NoRedraw
        } else if new_time <= self.max_duration {
            self.current_display_time = new_time;
            self.autohide_timer.start_display_timer();

            ComponentEventResult::Redraw
        } else if new_time != self.max_duration {
            self.current_display_time = self.max_duration;
            self.autohide_timer.start_display_timer();

            ComponentEventResult::Redraw
        } else {
            ComponentEventResult::NoRedraw
        }
    }

    fn reset_zoom(&mut self) -> ComponentEventResult {
        if self.current_display_time == self.default_time_value {
            ComponentEventResult::NoRedraw
        } else {
            self.current_display_time = self.default_time_value;
            self.autohide_timer.start_display_timer();
            ComponentEventResult::Redraw
        }
    }

    fn get_x_axis_labels(&self, painter: &Painter) -> Vec<Span<'_>> {
        vec![
            Span::styled(
                format!("{}s", self.current_display_time / 1000),
                painter.colours.graph_style,
            ),
            Span::styled("0s", painter.colours.graph_style),
        ]
    }

    /// Returns the current display time boundary.
    pub fn get_current_display_time(&self) -> u64 {
        self.current_display_time
    }

    /// Creates a [`Chart`].
    ///
    /// The `reverse_order` parameter is mostly used for cases where you want the first entry to be drawn on
    /// top - note that this will also reverse the naturally generated legend, if shown!
    pub fn draw_tui_chart<B: Backend>(
        &mut self, painter: &Painter, f: &mut tui::Frame<'_, B>, data: &'_ [TimeGraphData<'_>],
        y_bound_labels: &[Cow<'static, str>], y_bounds: [f64; 2], reverse_order: bool,
        block: Block<'_>, block_area: Rect,
    ) {
        let inner_area = block.inner(block_area);

        self.set_border_bounds(block_area);
        self.set_bounds(inner_area);

        let time_start = -(self.current_display_time as f64);
        let x_axis = {
            let x_axis = Axis::default()
                .bounds([time_start, 0.0])
                .style(painter.colours.graph_style);
            if inner_area.height >= TIME_LABEL_HEIGHT_LIMIT && self.autohide_timer.is_showing() {
                x_axis.labels(self.get_x_axis_labels(painter))
            } else {
                x_axis
            }
        };
        let y_axis = Axis::default()
            .bounds(y_bounds)
            .style(painter.colours.graph_style)
            .labels(
                y_bound_labels
                    .iter()
                    .map(|label| Span::styled(label.clone(), painter.colours.graph_style))
                    .collect(),
            );
        // TODO: [Small size bug] There's a rendering issue if you use a very short window with how some legend entries are hidden. It sometimes hides the 0; instead, it should hide middle entries!

        let mut datasets: Vec<Dataset<'_>> = data
            .iter()
            .map(|time_graph_data| {
                let mut dataset = Dataset::default()