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
use crate::{
action::mode::Mode,
action::scene::Scene,
action::Action,
components::{
base::Base, home::Home, internals::Internals, session::Session,
usage_info::UsageInfo, Component,
},
config::Config,
irx_client::IrxClient,
router::{Address, Message, Router},
tui,
};
use color_eyre::eyre::Result;
use crossterm::event::KeyEvent;
use ratatui::prelude::Rect;
use tokio::sync::mpsc;
/// The main application structure for Napali's `App`.
///
/// `App` manages the application's state, including configuration, tick and frame rates,
/// components, and message handling. It integrates with various modules to provide
/// a cohesive application framework.
pub struct App {
/// Application configuration settings.
pub config: Config,
/// The rate at which the application logic updates (in ticks per second).
pub tick_rate: f64,
/// The rate at which the application renders frames (in frames per second).
pub frame_rate: f64,
/// A vector of components that make up the application.
pub components: Vec<Box<dyn Component>>,
/// Flag to determine if the application should quit.
pub should_quit: bool,
/// Flag to determine if the application should suspend operations.
pub should_suspend: bool,
/// Current operating mode of the application.
pub mode: Mode,
/// Current scene being displayed in the application.
pub scene: Scene,
/// Stores the last key events processed in the current tick.
pub last_tick_key_events: Vec<KeyEvent>,
/// Internal router for managing message passing.
router: Router,
/// Channel for sending messages to the application itself.
pub message_tx_to_self: mpsc::UnboundedSender<Message>,
/// Client for interacting with the Irx API.
pub client: IrxClient,
}
impl App {
/// Constructs a new instance of `App`.
///
/// Initializes the application with specified tick and frame rates, sets up
/// components, message channels, and default states.
///
/// # Parameters
///
/// * `tick_rate`: The rate at which the app's logic updates.
/// * `frame_rate`: The rate at which the app renders frames.
///
/// # Returns
///
/// `Result<App, Error>` - Ok with `App` instance if successful, or an error if not.
///
/// # Errors
///
/// Returns an error if initialization fails (e.g., network issues, configuration errors).
///
/// # Examples
///
/// ```
/// #[tokio::main]
/// async fn main() {
/// let app = App::new(60.0, 30.0).await.expect("Failed to create App");
/// // Use `app` here
/// }
/// ```
pub async fn new(tick_rate: f64, frame_rate: f64) -> Result<Self> {
let (message_tx_to_self, _) = mpsc::unbounded_channel::<Message>();
let (mut router, message_tx_to_router) =
Router::new(message_tx_to_self.clone()).await?;
let base = Base::new();
let internals = Internals::new(message_tx_to_router.clone());
let home = Home::new(message_tx_to_router.clone());
let usage_info = UsageInfo::default();
let config = Config::new()?;
let scene = Scene::Internals;
let mode = Mode::Navigation;
let client = IrxClient::new(message_tx_to_router.clone()).await?;
let session = Session::new();
router.register(Address::Home, home.message_tx_to_self.clone());
router.register(Address::Internals, internals.message_tx_to_self.clone());
router.register(
Address::StateDisplay,
internals.get_state_display_tx_handle(),
);
router.register(Address::IrxClient, client.message_tx_to_self.clone());
router.register(Address::Session, session.message_tx_to_self.clone());
Ok(Self {
tick_rate,
frame_rate,
components: vec![
Box::new(internals),
Box::new(home),
Box::new(session),
Box::new(base),
// Overlays (must be listed last):
Box::new(usage_info),
],
should_quit: false,
should_suspend: false,
config,
mode,
scene,
last_tick_key_events: Vec::new(),
router,
message_tx_to_self,
client,
})
}
/// Runs the main event loop of the application.
///
/// This asynchronous method starts the application, handling UI events,
/// routing messages, and managing application states and transitions.
///
/// # Returns
///
/// `Result<()>` - Ok if the run loop completes normally, or an error if it encounters a problem.
///
/// # Errors
///
/// Returns an error if there are issues in event handling or message processing.
///
/// # Examples
///
/// ```
/// #[tokio::main]
/// async fn main() {
/// let mut app = App::new(60.0, 30.0).await.expect("Failed to create App");
/// app.run().await.expect("Failed to run App");
/// }
/// ```
pub async fn run(&mut self) -> Result<()> {
let (action_tx, mut action_rx) = mpsc::unbounded_channel();
action_tx.send(Action::ChangeScene(Scene::default()))?;
self.router.run();
self.client.run_responder();
let mut tui = tui::Tui::new()?
.tick_rate(self.tick_rate)
.frame_rate(self.frame_rate);
// tui.mouse(true);
tui.enter()?;
for component in &mut self.components {
component.register_action_handler(action_tx.clone())?;
component.register_config_handler(self.config.clone())?;
component.init(tui.size()?)?;
}
loop {
if let Some(e) = tui.next().await {
match e {
tui::Event::Quit => action_tx.send(Action::Quit)?,
tui::Event::Tick => action_tx.send(Action::Tick)?,
tui::Event::Render => action_tx.send(Action::Render)?,
tui::Event::Resize(x, y) => action_tx.send(Action::Resize(x, y))?,
tui::Event::Key(key) => {
if let Some(keymap) = self.config.keybindings.get(&self.scene) {
if let Some(action) = keymap.get(&vec![key]) {
log::info!("Got action: {action:?}");
action_tx.send(action.clone())?;
} else {
// If the key was not handled as a single key action,
// then consider it for multi-key combinations.
self.last_tick_key_events.push(key);
// Check for multi-key combinations
if let Some(action) = keymap.get(&self.last_tick_key_events) {
log::info!("Got action: {action:?}");
action_tx.send(action.clone())?;
}
}
};
}
_ => {}
}
for component in &mut self.components {
if let Some(action) = component.handle_events(Some(e.clone()))? {
action_tx.send(action)?;
}
}
}
while let Ok(action) = action_rx.try_recv() {
if action != Action::Tick && action != Action::Render {
log::debug!("{action:?}");
}
match action {
Action::Tick => {
self.last_tick_key_events.drain(..);
}
Action::Quit => self.should_quit = true,
Action::Suspend => self.should_suspend = true,
Action::Resume => self.should_suspend = false,
Action::Resize(w, h) => {
tui.resize(Rect::new(0, 0, w, h))?;
tui.draw(|f| {
for component in &mut self.components {
let r = component.draw(f, f.size());
if let Err(e) = r {
action_tx
.send(Action::Error(format!("Failed to draw: {e:?}")))
.unwrap();
}
}
})?;
}
Action::ChangeScene(scene) => self.scene = scene,
Action::Render => {
tui.draw(|f| {
for component in &mut self.components {
let r = component.draw(f, f.size());
if let Err(e) = r {
action_tx
.send(Action::Error(format!("Failed to draw: {e:?}")))
.unwrap();
}
}
})?;
}
_ => {}
}
for component in &mut self.components {
if let Some(action) = component.update(action.clone())? {
action_tx.send(action)?;
};
}
}
if self.should_suspend {
tui.suspend()?;
action_tx.send(Action::Resume)?;
tui = tui::Tui::new()?
.tick_rate(self.tick_rate)
.frame_rate(self.frame_rate);
// tui.mouse(true);
tui.enter()?;
} else if self.should_quit {
tui.stop();
break;
}
}
tui.exit()?;
Ok(())
}
// Additional methods or helper functions...
}