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
use crossterm::event::{KeyEvent, MouseEvent};
use ratatui::{
Frame,
layout::{Rect, Size},
};
use tokio::sync::mpsc::UnboundedSender;
use crate::{action::Action, config::Config, tui::Event};
pub mod comment_composer;
pub mod comments_list;
pub mod diff_view;
pub mod footer;
pub mod header;
pub mod help_overlay;
pub mod revision_selector;
pub mod toast;
/// `Component` is a trait that represents a visual and interactive element of the user interface.
///
/// Implementors of this trait can be registered with the main application loop and will be able to
/// receive events, update state, and be rendered on the screen.
pub trait Component {
/// Register an action handler that can send actions for processing if necessary.
///
/// # Arguments
///
/// * `tx` - An unbounded sender that can send actions.
///
/// # Returns
///
/// * [`color_eyre::Result<()>`] - An Ok result or an error.
fn register_action_handler(&mut self, tx: UnboundedSender<Action>) -> color_eyre::Result<()> {
let _ = tx; // to appease clippy
Ok(())
}
/// Register a configuration handler that provides configuration settings if necessary.
///
/// # Arguments
///
/// * `config` - Configuration settings.
///
/// # Returns
///
/// * [`color_eyre::Result<()>`] - An Ok result or an error.
fn register_config_handler(&mut self, config: Config) -> color_eyre::Result<()> {
let _ = config; // to appease clippy
Ok(())
}
/// Initialize the component with a specified area if necessary.
///
/// # Arguments
///
/// * `area` - Rectangular area to initialize the component within.
///
/// # Returns
///
/// * [`color_eyre::Result<()>`] - An Ok result or an error.
fn init(&mut self, area: Size) -> color_eyre::Result<()> {
let _ = area; // to appease clippy
Ok(())
}
/// Handle incoming events and produce actions if necessary.
///
/// # Arguments
///
/// * `event` - An optional event to be processed.
///
/// # Returns
///
/// * [`color_eyre::Result<Option<Action>>`] - An action to be processed or none.
fn handle_events(&mut self, event: Option<Event>) -> color_eyre::Result<Option<Action>> {
let action = match event {
Some(Event::Key(key_event)) => self.handle_key_event(key_event)?,
Some(Event::Mouse(mouse_event)) => self.handle_mouse_event(mouse_event)?,
_ => None,
};
Ok(action)
}
/// Handle key events and produce actions if necessary.
///
/// # Arguments
///
/// * `key` - A key event to be processed.
///
/// # Returns
///
/// * [`color_eyre::Result<Option<Action>>`] - An action to be processed or none.
fn handle_key_event(&mut self, key: KeyEvent) -> color_eyre::Result<Option<Action>> {
let _ = key; // to appease clippy
Ok(None)
}
/// Handle mouse events and produce actions if necessary.
///
/// # Arguments
///
/// * `mouse` - A mouse event to be processed.
///
/// # Returns
///
/// * [`color_eyre::Result<Option<Action>>`] - An action to be processed or none.
fn handle_mouse_event(&mut self, mouse: MouseEvent) -> color_eyre::Result<Option<Action>> {
let _ = mouse; // to appease clippy
Ok(None)
}
/// Update the state of the component based on a received action. (REQUIRED)
///
/// # Arguments
///
/// * `action` - An action that may modify the state of the component.
///
/// # Returns
///
/// * [`color_eyre::Result<Option<Action>>`] - An action to be processed or none.
fn update(&mut self, action: Action) -> color_eyre::Result<Option<Action>> {
let _ = action; // to appease clippy
Ok(None)
}
/// Render the component on the screen. (REQUIRED)
///
/// # Arguments
///
/// * `f` - A frame used for rendering.
/// * `area` - The area in which the component should be drawn.
///
/// # Returns
///
/// * [`color_eyre::Result<()>`] - An Ok result or an error.
fn draw(&mut self, frame: &mut Frame, area: Rect) -> color_eyre::Result<()>;
}