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
use std::{
cell::{Ref, RefCell},
fmt::write,
rc::Rc,
};
use probe_rs::Core;
use crate::{cmd::cargo_embed::rttui::channel::ChannelData, util::rtt::client::RttClient};
use super::channel::UpChannel;
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct TabConfig {
/// Which up channel to use.
pub up_channel: u32,
/// Which down channel to use, if any.
#[serde(default)]
pub down_channel: Option<u32>,
/// The name of the tab. If not set, the name of the up channel is used.
#[serde(default)]
pub name: Option<String>,
/// Whether to hide the tab. By default, all up channels are shown in separate tabs.
#[serde(default)]
pub hide: bool,
}
pub struct Tab {
up_channel: Rc<RefCell<UpChannel>>,
down_channel: Option<(u32, String)>,
name: String,
scroll_offset: usize,
messages: Vec<String>,
last_processed: usize,
last_width: usize,
}
impl Tab {
pub fn new(
up_channel: Rc<RefCell<UpChannel>>,
down_channel: Option<u32>,
name: Option<String>,
) -> Self {
Self {
name: name.unwrap_or_else(|| up_channel.borrow().channel_name().to_string()),
up_channel,
down_channel: down_channel.map(|down| (down, String::new())),
scroll_offset: 0,
messages: Vec::new(),
last_processed: 0,
last_width: 0,
}
}
pub fn name(&self) -> &str {
&self.name
}
pub fn set_scroll_offset(&mut self, value: usize) {
self.scroll_offset = value;
}
pub fn up_channel(&self) -> Ref<'_, UpChannel> {
self.up_channel.borrow()
}
pub fn scroll_up(&mut self, lines: usize) {
self.set_scroll_offset(
self.scroll_offset
.saturating_add(lines)
.min(self.messages.len()),
);
}
pub fn scroll_down(&mut self, lines: usize) {
self.set_scroll_offset(self.scroll_offset.saturating_sub(lines));
}
pub fn clear(&mut self) {
self.set_scroll_offset(0);
}
pub fn push_input(&mut self, c: char) {
if let Some((_, input)) = self.down_channel.as_mut() {
input.push(c);
}
}
pub fn pop_input(&mut self) {
if let Some((_, input)) = self.down_channel.as_mut() {
input.pop();
}
}
pub fn input(&self) -> Option<&str> {
self.down_channel.as_ref().map(|(_, input)| input.as_str())
}
pub fn send_input(&mut self, core: &mut Core, client: &mut RttClient) -> anyhow::Result<()> {
if let Some((channel, input)) = self.down_channel.as_mut() {
input.push('\n');
client.write_down_channel(core, *channel, input.as_str())?;
input.clear();
}
Ok(())
}
pub fn update_messages(&mut self, width: usize, height: usize) {
if self.last_width != width {
// If the width changes, we need to reprocess all messages.
self.last_width = width;
self.last_processed = 0;
self.set_scroll_offset(0);
self.messages.clear();
}
let old_message_count = self.messages.len();
match &self.up_channel.borrow().data {
ChannelData::Strings { messages, .. } => {
// We strip ANSI sequences because they interfere with text wrapping.
// - It's not obvious how we could tell defmt_parser to not emit ANSI sequences.
// - Calling textwrap on a string with ANSI sequences may break a sequence into
// multiple lines, which is incorrect.
// - We can only interpret the sequences by emitting ratatui span styles, but at
// that point we can no longer wrap the text using textwrap.
// - Leaving sequences in the output intact is just a bad experience.
for line in messages.iter().skip(self.last_processed).map(strip_ansi) {
// TODO: we shouldn't assume that one message is one complete line. If the
// last line did not end with a newline, we should append to that line instead.
// Trim a single newline from the end
let line = if line.ends_with('\n') {
&line[..line.len() - 1]
} else {
&line
};
self.messages
.extend(textwrap::wrap(line, width).into_iter().map(String::from));
}
self.last_processed = messages.len();
}
ChannelData::Binary { data } => {
let mut string = self.messages.pop().unwrap_or_default();
if !data.is_empty() {
// 4 characters per byte (0xAB) + 1 space, except at the end
string.reserve(data.len() * 5 - 1);
}
let string =
data.iter()
.skip(self.last_processed)
.fold(string, |mut output, byte| {
if !output.is_empty() {
output.push(' ');
}
let _ = write(&mut output, format_args!("{byte:#04x}"));
output
});
self.messages
.extend(textwrap::wrap(&string, width).into_iter().map(String::from));
self.last_processed = data.len();
}
};
let inserted = self.messages.len() - old_message_count;
// Move scroll offset if we're not at the bottom
if self.scroll_offset != 0 {
// This scroll ensures that inserting new messages will not move our view.
self.scroll_up(inserted);
// Don't let scrolling up more than necessary to show all messages.
// Doing so would require the user to scroll down more times than necessary.
self.set_scroll_offset(
self.scroll_offset
.min(self.messages.len().saturating_sub(height)),
);
}
}
pub fn messages(&self, height: usize) -> impl Iterator<Item = &str> + '_ {
let message_num = self.messages.len();
self.messages
.iter()
.map(|s| s.as_str())
.skip(message_num.saturating_sub(height + self.scroll_offset))
.take(height)
}
}
/// Removes ANSI escape sequences from a string.
fn strip_ansi(s: impl AsRef<str>) -> String {
fn text_block(output: ansi_parser::Output<'_>) -> Option<&str> {
match output {
ansi_parser::Output::TextBlock(text) => Some(text),
_ => None,
}
}
// TODO: use a cow: if ansi-parser returns a single string, do not allocate
use ansi_parser::AnsiParser;
s.as_ref()
.ansi_parse()
.filter_map(text_block)
.collect::<String>()
}