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
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
use anyhow::{anyhow, Result};
use crossterm::{
event::{self, KeyCode},
execute,
terminal::{disable_raw_mode, enable_raw_mode, EnterAlternateScreen, LeaveAlternateScreen},
};
use probe_rs_rtt::RttChannel;
use std::io::{Read, Seek, Write};
use std::{fmt::write, path::PathBuf};
use textwrap::wrap_iter;
use tui::{
backend::CrosstermBackend,
layout::{Constraint, Direction, Layout},
style::{Color, Modifier, Style},
text::{Span, Spans},
widgets::{Block, Borders, List, ListItem, Paragraph, Tabs},
Terminal,
};
use super::channel::{ChannelState, DataFormat};
use super::event::{Event, Events};
use event::{DisableMouseCapture, KeyModifiers};
/// App holds the state of the application
pub struct App {
tabs: Vec<ChannelState>,
current_tab: usize,
terminal: Terminal<CrosstermBackend<std::io::Stdout>>,
events: Events,
history_path: Option<PathBuf>,
logname: String,
}
fn pull_channel<C: RttChannel>(channels: &mut Vec<C>, n: usize) -> Option<C> {
let c = channels
.iter()
.enumerate()
.find_map(|(i, c)| if c.number() == n { Some(i) } else { None });
c.map(|c| channels.remove(c))
}
impl App {
pub fn new(
mut rtt: probe_rs_rtt::Rtt,
config: &crate::config::Config,
logname: String,
) -> Result<Self> {
let mut tabs = Vec::new();
let mut up_channels = rtt.up_channels().drain().collect::<Vec<_>>();
let mut down_channels = rtt.down_channels().drain().collect::<Vec<_>>();
if !config.rtt.channels.is_empty() {
for channel in &config.rtt.channels {
tabs.push(ChannelState::new(
channel.up.and_then(|up| pull_channel(&mut up_channels, up)),
channel
.down
.and_then(|down| pull_channel(&mut down_channels, down)),
channel.name.clone(),
config.rtt.show_timestamps,
channel.format,
))
}
} else {
for channel in up_channels.into_iter() {
let number = channel.number();
tabs.push(ChannelState::new(
Some(channel),
pull_channel(&mut down_channels, number),
None,
config.rtt.show_timestamps,
DataFormat::String,
));
}
for channel in down_channels {
tabs.push(ChannelState::new(
None,
Some(channel),
None,
config.rtt.show_timestamps,
DataFormat::String,
));
}
}
// Code farther down relies on tabs being configured and might panic
// otherwise.
if tabs.is_empty() {
return Err(anyhow!(
"Failed to initialize RTT UI: No RTT channels configured"
));
}
let events = Events::new();
enable_raw_mode().unwrap();
let mut stdout = std::io::stdout();
execute!(stdout, EnterAlternateScreen).unwrap();
let backend = CrosstermBackend::new(stdout);
let mut terminal = Terminal::new(backend).unwrap();
let _ = terminal.hide_cursor();
let history_path = {
if !config.rtt.log_enabled {
None
} else {
//when is the right time if ever to fail if the directory or file cant be created?
//should we create the path on startup or when we write
match std::fs::create_dir_all(&config.rtt.log_path) {
Ok(_) => Some(config.rtt.log_path.clone()),
Err(_) => {
log::warn!("Could not create log directory");
None
}
}
}
};
Ok(Self {
tabs,
current_tab: 0,
terminal,
events,
history_path,
logname,
})
}
pub fn get_rtt_symbol<'b, T: Read + Seek>(file: &'b mut T) -> Option<u64> {
let mut buffer = Vec::new();
if file.read_to_end(&mut buffer).is_ok() {
if let Ok(binary) = goblin::elf::Elf::parse(&buffer.as_slice()) {
for sym in &binary.syms {
if let Some(Ok(name)) = binary.strtab.get(sym.st_name) {
if name == "_SEGGER_RTT" {
return Some(sym.st_value);
}
}
}
}
}
log::warn!("No RTT header info was present in the ELF file. Does your firmware run RTT?");
None
}
pub fn render(&mut self) {
let input = self.current_tab().input().to_owned();
let has_down_channel = self.current_tab().has_down_channel();
let scroll_offset = self.current_tab().scroll_offset();
let messages = self.current_tab().messages().clone();
let data = self.current_tab().data().clone();
let tabs = &self.tabs;
let current_tab = self.current_tab;
let mut height = 0;
let mut messages_wrapped: Vec<String> = Vec::new();
match tabs[current_tab].format() {
DataFormat::String => {
self.terminal
.draw(|f| {
let constraints = if has_down_channel {
&[
Constraint::Length(1),
Constraint::Min(1),
Constraint::Length(1),
][..]
} else {
&[Constraint::Length(1), Constraint::Min(1)][..]
};
let chunks = Layout::default()
.direction(Direction::Vertical)
.margin(0)
.constraints(constraints)
.split(f.size());
let tab_names = tabs
.iter()
.map(|t| Spans::from(t.name()))
.collect::<Vec<_>>();
let tabs = Tabs::new(tab_names)
.select(current_tab)
.style(Style::default().fg(Color::Black).bg(Color::Yellow))
.highlight_style(
Style::default()
.fg(Color::Green)
.bg(Color::Yellow)
.add_modifier(Modifier::BOLD),
);
f.render_widget(tabs, chunks[0]);
height = chunks[1].height as usize;
// We need to collect to generate message_num :(
messages_wrapped = messages
.iter()
.map(|m| {
wrap_iter(m, chunks[1].width as usize).map(|cow| cow.into_owned())
})
.flatten()
.collect();
let message_num = messages_wrapped.len();
let messages: Vec<ListItem> = messages_wrapped
.iter()
.skip(message_num - (height + scroll_offset).min(message_num))
.take(height)
.map(|s| ListItem::new(vec![Spans::from(Span::raw(s))]))
.collect();
let messages = List::new(messages.as_slice())
.block(Block::default().borders(Borders::NONE));
f.render_widget(messages, chunks[1]);
if has_down_channel {
let input = Paragraph::new(Spans::from(vec![Span::raw(input.clone())]))
.style(Style::default().fg(Color::Yellow).bg(Color::Blue));
f.render_widget(input, chunks[2]);
}
})
.unwrap();
let message_num = messages_wrapped.len();
let scroll_offset = self.tabs[self.current_tab].scroll_offset();
if message_num < height + scroll_offset {
self.current_tab_mut()
.set_scroll_offset(message_num - height.min(message_num));
}
}
DataFormat::BinaryLE => {
self.terminal
.draw(|f| {
let constraints = if has_down_channel {
&[
Constraint::Length(1),
Constraint::Min(1),
Constraint::Length(1),
][..]
} else {
&[Constraint::Length(1), Constraint::Min(1)][..]
};
let chunks = Layout::default()
.direction(Direction::Vertical)
.margin(0)
.constraints(constraints)
.split(f.size());
let tab_names = tabs
.iter()
.map(|t| Spans::from(t.name()))
.collect::<Vec<_>>();
let tabs = Tabs::new(tab_names)
.select(current_tab)
.style(Style::default().fg(Color::Black).bg(Color::Yellow))
.highlight_style(
Style::default()
.fg(Color::Green)
.bg(Color::Yellow)
.add_modifier(Modifier::BOLD),
);
f.render_widget(tabs, chunks[0]);
height = chunks[1].height as usize;
//probably pretty bad
let data_string: String =
data.iter().fold(String::new(), |mut output, byte| {
let _ = write(&mut output, format_args!("{:#04x}, ", byte));
output
});
// We need to collect to generate message_num :(
messages_wrapped = textwrap::wrap(&data_string, chunks[1].width as usize)
.iter()
.cloned()
.map(|cow| cow.into_owned())
.collect();
let message_num = messages_wrapped.len();
let messages: Vec<ListItem> = messages_wrapped
.iter()
.skip(message_num - (height + scroll_offset).min(message_num))
.take(height)
.map(|s| ListItem::new(vec![Spans::from(Span::raw(s))]))
.collect();
let messages = List::new(messages.as_slice())
.block(Block::default().borders(Borders::NONE));
f.render_widget(messages, chunks[1]);
if has_down_channel {
let input = Paragraph::new(Spans::from(vec![Span::raw(input.clone())]))
.style(Style::default().fg(Color::Yellow).bg(Color::Blue));
f.render_widget(input, chunks[2]);
}
})
.unwrap();
let message_num = messages_wrapped.len();
let scroll_offset = self.tabs[self.current_tab].scroll_offset();
if message_num < height + scroll_offset {
self.current_tab_mut()
.set_scroll_offset(message_num - height.min(message_num));
}
}
}
}
/// Returns true if the application should exit.
pub fn handle_event(&mut self) -> bool {
match self.events.next().unwrap() {
Event::Input(event) => match event.code {
KeyCode::Char('c') if event.modifiers.contains(KeyModifiers::CONTROL) => {
clean_up_terminal();
let _ = self.terminal.show_cursor();
if let Some(path) = &self.history_path {
for (i, tab) in self.tabs.iter().enumerate() {
let extension = match tab.format() {
DataFormat::String => "txt",
DataFormat::BinaryLE => "dat",
};
let name = format!("{}_channel{}.{}", self.logname, i, extension);
let final_path = path.join(name);
match std::fs::File::create(final_path.clone()) {
Ok(mut file) => {
match tab.format() {
DataFormat::String => {
for line in tab.messages() {
match writeln!(file, "{}", line) {
Ok(_) => {}
Err(e) => {
eprintln!(
"\nError writing log channel {}: {}",
i, e
);
continue;
}
}
}
}
DataFormat::BinaryLE => match file.write(&tab.data()) {
Ok(_) => {}
Err(e) => {
eprintln!(
"\nError writing log channel {}: {}",
i, e
);
continue;
}
},
};
}
Err(e) => {
eprintln!(
"\nCould not create log file {:?}: {}",
final_path.clone(),
e
);
}
}
}
}
true
}
KeyCode::F(n) => {
let n = n as usize - 1;
if n < self.tabs.len() {
self.current_tab = n as usize;
}
false
}
KeyCode::Enter => {
self.push_rtt();
false
}
KeyCode::Char(c) => {
self.current_tab_mut().input_mut().push(c);
false
}
KeyCode::Backspace => {
self.current_tab_mut().input_mut().pop();
false
}
KeyCode::PageUp => {
self.current_tab_mut().scroll_up();
false
}
KeyCode::PageDown => {
self.current_tab_mut().scroll_down();
false
}
_ => false,
},
_ => false,
}
}
pub fn current_tab(&self) -> &ChannelState {
&self.tabs[self.current_tab]
}
pub fn current_tab_mut(&mut self) -> &mut ChannelState {
&mut self.tabs[self.current_tab]
}
/// Polls the RTT target for new data on all channels.
pub fn poll_rtt(&mut self) {
for channel in self.tabs.iter_mut() {
channel.poll_rtt();
}
}
pub fn push_rtt(&mut self) {
self.tabs[self.current_tab].push_rtt();
}
}
pub fn clean_up_terminal() {
let _ = disable_raw_mode();
let _ = execute!(std::io::stdout(), LeaveAlternateScreen, DisableMouseCapture);
}