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
//! Terminal stdio query parser module.
use std::{fmt::Write, time::Duration};
use crate::picker::{ProtocolType, STDIN_READ_TIMEOUT_MILLIS};
pub struct Parser {
data: String,
sequence: ResponseParseState,
}
#[derive(Debug, PartialEq)]
pub enum ResponseParseState {
Unknown,
CSIResponse,
KittyResponse,
}
#[derive(Debug, PartialEq, Clone)]
pub enum Response {
Kitty,
Sixel,
RectangularOps,
CellSize(Option<(u16, u16)>),
CursorPositionReport(u16, u16),
Status,
}
/// Extra query options
pub struct QueryStdioOptions {
/// Timeout for the stdio query.
pub timeout: Duration,
/// Query for [Text Sizing Protocol]. The result can be checked by searching for
/// [crate::picker::Capability::TextSizingProtocol] in [crate::picker::Picker::capabilities].
///
/// [Text Sizing Protocol] <https://sw.kovidgoyal.net/kitty/text-sizing-protocol//>
pub text_sizing_protocol: bool,
/// Blacklist protocols from the detection query. Currently only kitty can be detected, so that
/// is the only ProtocolType that can have any effect here.
/// [`crate::picker::Picker`] currently sets ProtocolType::Kitty for WezTerm and Konsole.
blacklist_protocols: Vec<ProtocolType>,
}
impl QueryStdioOptions {
pub(crate) fn blacklist_protocols(&mut self, protocol_types: Vec<ProtocolType>) {
self.blacklist_protocols = protocol_types;
}
}
impl Default for QueryStdioOptions {
fn default() -> Self {
Self {
timeout: Duration::from_millis(STDIN_READ_TIMEOUT_MILLIS),
text_sizing_protocol: false,
blacklist_protocols: Vec::new(),
}
}
}
impl Default for Parser {
fn default() -> Self {
Parser {
data: String::new(),
sequence: ResponseParseState::Unknown,
}
}
}
impl Parser {
pub fn new() -> Self {
Parser {
data: String::new(),
sequence: ResponseParseState::Unknown,
}
}
// Tmux requires escapes to be escaped, and some special start/end sequences.
pub fn escape_tmux(is_tmux: bool) -> (&'static str, &'static str, &'static str) {
match is_tmux {
false => ("", "\x1b", ""),
true => ("\x1bPtmux;", "\x1b\x1b", "\x1b\\"),
}
}
pub fn query(is_tmux: bool, options: QueryStdioOptions) -> String {
let (start, escape, end) = Parser::escape_tmux(is_tmux);
let mut buf = String::with_capacity(100);
buf.push_str(start);
if !options.blacklist_protocols.contains(&ProtocolType::Kitty) {
// Kitty graphics
write!(buf, "{escape}_Gi=31,s=1,v=1,a=q,t=d,f=24;AAAA{escape}\\").unwrap();
}
if !options.blacklist_protocols.contains(&ProtocolType::Sixel) {
// Device Attributes Report 1 (sixel support)
write!(buf, "{escape}[c").unwrap();
}
// Font size in pixels
write!(buf, "{escape}[16t").unwrap();
// iTerm2 proprietary, unknown response, untested so far.
//write!(buf, "{escape}[1337n").unwrap();
if options.text_sizing_protocol {
const BEL: &str = "\u{7}";
// Send CPR (Cursor Position Report) and Text Sizing Protocol commands.
// https://sw.kovidgoyal.net/kitty/text-sizing-protocol/#detecting-if-the-terminal-supports-this-protocol
// We need to write a CPR, a resized space, and CPR again, to see if it moved the cursor
// correctly with extra width.
// Do it again for the scaling part of the protocol.
// See [Picker::interpret_parser_responses] for how the responses are interpreted - it
// differs slightly from the spec!
write!(
buf,
"{escape}[6n{escape}]66;w=2; {BEL}{escape}[6n{escape}]66;s=2; {BEL}{escape}[6n"
)
.unwrap();
}
// End with Device Status Report, implemented by all terminals, ensure that there is some
// response and we don't hang reading forever.
write!(buf, "{escape}[5n").unwrap();
write!(buf, "{end}").unwrap();
buf
}
pub fn push(&mut self, next: char) -> Vec<Response> {
match self.sequence {
ResponseParseState::Unknown => {
match (&self.data[..], next) {
(_, '\x1b') => {
// If the current sequence hasn't been identified yet, start a new one on Esc.
return self.restart();
}
("_Gi=31", ';') => {
self.sequence = ResponseParseState::KittyResponse;
}
("[", _) => {
self.sequence = ResponseParseState::CSIResponse;
}
_ => {}
};
self.data.push(next);
}
ResponseParseState::CSIResponse => {
if self.data == "[0" && next == 'n' {
self.restart();
return vec![Response::Status];
}
match next {
'c' if self.data.starts_with("[?") => {
let mut caps = vec![];
let inner: Vec<&str> = (self.data[2..]).split(';').collect();
for cap in inner {
match cap {
"4" => caps.push(Response::Sixel),
"28" => caps.push(Response::RectangularOps),
_ => {}
}
}
self.restart();
return caps;
}
't' => {
let mut cell_size = None;
let inner: Vec<&str> = self.data.split(';').collect();
if let [_, h, w] = inner[..] {
if let (Ok(h), Ok(w)) = (h.parse::<u16>(), w.parse::<u16>()) {
if w > 0 && h > 0 {
cell_size = Some((w, h));
}
}
}
self.restart();
return vec![Response::CellSize(cell_size)];
}
'R' => {
let mut cursor_pos = None;
let inner: Vec<&str> = self.data[1..].split(';').collect();
if let [x, w] = inner[..] {
if let (Ok(x), Ok(y)) = (x.parse::<u16>(), w.parse::<u16>()) {
cursor_pos = Some((y, x));
}
}
if let Some((x, y)) = cursor_pos {
self.restart();
return vec![Response::CursorPositionReport(x, y)];
} else {
self.restart();
return vec![];
}
}
'\x1b' => {
// Give up?
return self.restart();
}
_ => {
self.data.push(next);
}
};
}
ResponseParseState::KittyResponse => match next {
'\\' => {
let caps = match &self.data[..] {
"_Gi=31;OK\x1b" => vec![Response::Kitty],
_ => vec![],
};
self.restart();
return caps;
}
_ => {
self.data.push(next);
}
},
};
vec![]
}
fn restart(&mut self) -> Vec<Response> {
self.data = String::new();
self.sequence = ResponseParseState::Unknown;
vec![]
}
}
#[cfg(test)]
mod tests {
use std::assert_eq;
use super::{Parser, Response};
fn parse(response: &str) -> Vec<Response> {
let mut parser = Parser::new();
let mut caps: Vec<Response> = vec![];
for ch in response.chars() {
let mut more_caps = parser.push(ch);
caps.append(&mut more_caps)
}
caps
}
#[test]
fn test_parse_all() {
let caps =
parse("\x1b_Gi=31;OK\x1b\\\x1b[?64;4c\x1b[6;7;14t\x1b[6;6R\x1b[7;7R\x1b[6;6R\x1b[0n");
assert_eq!(
caps,
vec![
Response::Kitty,
Response::Sixel,
Response::CellSize(Some((14, 7))),
Response::CursorPositionReport(6, 6),
Response::CursorPositionReport(7, 7),
Response::CursorPositionReport(6, 6),
Response::Status,
],
);
}
#[test]
fn test_parse_only_garbage() {
let caps = parse("\x1bhonkey\x1btonkey\x1b[42\x1b\\");
assert_eq!(caps, vec![]);
}
#[test]
fn test_parse_preceding_garbage() {
let caps = parse("\x1bgarbage...\x1b[?64;5c\x1b[0n");
assert_eq!(caps, vec![Response::Status]);
}
#[test]
fn test_parse_inner_garbage() {
let caps = parse("\x1b[6;7;14t\x1bgarbage...\x1b[?64;5c\x1b[0n");
assert_eq!(
caps,
vec![Response::CellSize(Some((14, 7))), Response::Status]
);
}
// #[test]
// fn test_parse_incomplete_support_in_text_sizing_protocol() {
// let caps = parse("\x1b[6;7;14t\x1b[6;6R\x1b[7;7R\x1b[6;6R\x1b[0n");
// assert_eq!(
// caps,
// vec![
// Response::CellSize(Some((14, 7))),
// Response::CursorPositionReport(6, 6),
// Response::CursorPositionReport(7, 7),
// Response::CursorPositionReport(6, 6),
// Response::Status,
// ],
// );
// }
}