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
/// Holds information about the hosting terminal.
#[derive(Clone, Debug, Default)]
#[allow(dead_code)]
pub struct TerminalInfo {
/// The detected terminal, if any.
pub terminal: Option<KnownTerminal>,
/// If applicable, a session nonce assigned by the terminal.
pub session_nonce: Option<String>,
/// Whether the terminal's OSC support is unknown.
pub osc_support_unknown: bool,
/// Whether the terminal supports OSC 0 sequences: setting terminal title and icon.
pub supports_osc_0: bool,
/// Whether the terminal supports OSC 1 sequences: setting icon name.
pub supports_osc_1: bool,
/// Whether the terminal supports OSC 2 sequences: setting terminal title.
pub supports_osc_2: bool,
/// Whether the terminal supports OSC 3 sequences: setting X11 window properties.
pub supports_osc_3: bool,
/// Whether the terminal supports OSC 4 sequences: setting color palette.
pub supports_osc_4: bool,
/// Whether the terminal supports OSC 5 sequences: setting/querying special color number.
pub supports_osc_5: bool,
/// Whether the terminal supports OSC 6 sequences: setting title tab color (iTerm2)
pub supports_osc_6: bool,
/// Whether the terminal supports OSC 7 sequences: setting current working directory.
pub supports_osc_7: bool,
/// Whether the terminal supports OSC 8 sequences: hyperlinks.
pub supports_osc_8: bool,
/// Whether the terminal supports OSC 9 sequences: showing system notification (iTerm2).
pub supports_osc_9: bool,
/// Whether the terminal supports OSC 10 sequences: setting default foreground color.
pub supports_osc_10: bool,
/// Whether the terminal supports OSC 11 sequences: setting default background color.
pub supports_osc_11: bool,
/// Whether the terminal supports OSC 12 sequences: setting cursor color.
pub supports_osc_12: bool,
/// Whether the terminal supports OSC 13 sequences: setting pointer foreground color.
pub supports_osc_13: bool,
/// Whether the terminal supports OSC 14 sequences: setting pointer background color.
pub supports_osc_14: bool,
/// Whether the terminal supports OSC 15 sequences: setting Tektronix foreground color.
pub supports_osc_15: bool,
/// Whether the terminal supports OSC 16 sequences: setting Tektronix background color.
pub supports_osc_16: bool,
/// Whether the terminal supports OSC 17 sequences: setting highlight background color.
pub supports_osc_17: bool,
/// Whether the terminal supports OSC 18 sequences: setting Tektronix cursor color.
pub supports_osc_18: bool,
/// Whether the terminal supports OSC 19 sequences: setting highlight foreground color.
pub supports_osc_19: bool,
/// Whether the terminal supports OSC 21 sequences: color control (Kitty extension).
pub supports_osc_21: bool,
/// Whether the terminal supports OSC 22 sequences: setting mouse pointer.
pub supports_osc_22: bool,
/// Whether the terminal supports OSC 50 sequences: setting font.
pub supports_osc_50: bool,
/// Whether the terminal supports OSC 52 sequences: clipboard and primary selection.
pub supports_osc_52: bool,
/// Whether the terminal supports OSC 66 sequences: scoped text size.
pub supports_osc_66: bool,
/// Whether the terminal supports OSC 99 sequences: desktop notifications.
pub supports_osc_99: bool,
/// Whether the terminal supports OSC 104 sequences: resetting color palette.
pub supports_osc_104: bool,
/// Whether the terminal supports OSC 105 sequences: resetting special colors.
pub supports_osc_105: bool,
/// Whether the terminal supports OSC 110 sequences: resetting default foreground color.
pub supports_osc_110: bool,
/// Whether the terminal supports OSC 111 sequences: resetting default background color.
pub supports_osc_111: bool,
/// Whether the terminal supports OSC 112 sequences: resetting cursor color.
pub supports_osc_112: bool,
/// Whether the terminal supports OSC 113 sequences: resetting pointer foreground color.
pub supports_osc_113: bool,
/// Whether the terminal supports OSC 114 sequences: resetting pointer background color.
pub supports_osc_114: bool,
/// Whether the terminal supports OSC 115 sequences: resetting Tektronix foreground color.
pub supports_osc_115: bool,
/// Whether the terminal supports OSC 116 sequences: resetting Tektronix background color.
pub supports_osc_116: bool,
/// Whether the terminal supports OSC 117 sequences: resetting highlight background color
pub supports_osc_117: bool,
/// Whether the terminal supports OSC 118 sequences: resetting Tektronix cursor color.
pub supports_osc_118: bool,
/// Whether the terminal supports OSC 119 sequences: resetting highlight foreground color
pub supports_osc_119: bool,
/// Whether the terminal supports OSC 133 sequences: shell integration (input, output, and
/// prompt zones).
pub supports_osc_133: bool,
/// Whether the terminal supports OSC 176 sequences: setting app ID.
pub supports_osc_176: bool,
/// Whether the terminal supports OSC 555 sequences: flashing screen (foot-specific)
pub supports_osc_555: bool,
/// Whether the terminal supports OSC 633 sequences: shell integration (`VSCode` extension).
pub supports_osc_633: bool,
/// Whether the terminal supports OSC 777 sequences: desktop notifications / rxvt extensions.
pub supports_osc_777: bool,
/// Whether the terminal supports OSC 1337 sequences: custom iTerm2 sequences.
pub supports_osc_1337: bool,
/// Whether the terminal supports OSC 5113 sequences: file transfer (Kitty extension).
pub supports_osc_5113: bool,
/// Whether the terminal supports OSC 5522 sequences: advanced clipboard interaction (Kitty
/// extension).
pub supports_osc_5522: bool,
/// Whether the terminal supports OSC 9001 sequences: Windows Terminal extensions.
pub supports_osc_9001: bool,
}
/// Identifies a known terminal emulator hosting this process.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum KnownTerminal {
/// Alacritty
Alacritty,
/// Apple terminal
AppleTerminal,
/// Ghostty
Ghostty,
/// GNOME Terminal
GnomeTerminal,
/// iTerm2
ITerm2,
/// Kitty
Kitty,
/// Konsole
Konsole,
/// `VSCode` Terminal
VSCode,
/// Other VTE-based terminal
Vte,
/// Warp Terminal
WarpTerminal,
/// `WezTerm`
WezTerm,
/// Windows Terminal
WindowsTerminal,
}
/// Abstracts access to environment variables used for terminal detection.
pub(crate) trait TerminalEnvironment {
/// Gets the value of an environment variable. Returns `None` if the variable is not set.
fn get_env_var(&self, key: &str) -> Option<String>;
}
#[allow(clippy::too_many_lines)]
pub(crate) fn get_terminal_info(env: &impl TerminalEnvironment) -> TerminalInfo {
let mut info = TerminalInfo {
terminal: try_detect_terminal(env),
..Default::default()
};
if let Some(terminal) = &info.terminal {
match terminal {
KnownTerminal::Alacritty => {
// https://github.com/alacritty/alacritty/blob/master/docs/escape_support.md
info.supports_osc_0 = true;
info.supports_osc_2 = true;
info.supports_osc_4 = true;
info.supports_osc_8 = true;
info.supports_osc_10 = true;
info.supports_osc_11 = true;
info.supports_osc_12 = true;
info.supports_osc_50 = true; // only cursor shape supported
info.supports_osc_52 = true; // only clipboard and primary selection supported
info.supports_osc_104 = true;
info.supports_osc_110 = true;
info.supports_osc_111 = true;
info.supports_osc_112 = true;
}
KnownTerminal::Ghostty => {
// https://ghostty.org/docs/vt/osc/0
info.supports_osc_0 = true;
info.supports_osc_1 = true;
info.supports_osc_2 = true;
info.supports_osc_4 = true;
info.supports_osc_5 = true;
info.supports_osc_7 = true;
info.supports_osc_8 = true;
info.supports_osc_9 = true;
info.supports_osc_10 = true;
info.supports_osc_11 = true;
info.supports_osc_12 = true;
info.supports_osc_21 = true;
info.supports_osc_22 = true;
info.supports_osc_52 = true;
info.supports_osc_104 = true;
info.supports_osc_105 = true;
info.supports_osc_110 = true;
info.supports_osc_111 = true;
info.supports_osc_112 = true;
}
KnownTerminal::ITerm2 => {
// https://iterm2.com/documentation-escape-codes.html
info.supports_osc_4 = true;
info.supports_osc_6 = true;
info.supports_osc_7 = true;
info.supports_osc_8 = true;
info.supports_osc_133 = true;
info.supports_osc_1337 = true;
}
KnownTerminal::Kitty => {
// https://sw.kovidgoyal.net/kitty/protocol-extensions/
info.supports_osc_21 = true;
info.supports_osc_22 = true;
info.supports_osc_66 = true;
info.supports_osc_5113 = true;
info.supports_osc_5522 = true;
}
KnownTerminal::VSCode => {
// https://code.visualstudio.com/docs/terminal/shell-integration
// https://github.com/microsoft/vscode/blob/main/src/vs/workbench/contrib/terminal/browser/terminalEscapeSequences.ts
info.supports_osc_7 = true;
info.supports_osc_9 = true;
info.supports_osc_133 = true;
info.supports_osc_633 = true;
info.supports_osc_1337 = true;
info.session_nonce = env.get_env_var("VSCODE_NONCE");
}
KnownTerminal::WezTerm => {
// https://wezterm.org/escape-sequences.html
// https://wezterm.org/shell-integration.html
info.supports_osc_0 = true;
info.supports_osc_1 = true;
info.supports_osc_2 = true;
info.supports_osc_4 = true;
info.supports_osc_7 = true;
info.supports_osc_8 = true;
info.supports_osc_9 = true;
info.supports_osc_10 = true;
info.supports_osc_11 = true;
info.supports_osc_12 = true;
info.supports_osc_52 = true;
info.supports_osc_104 = true;
info.supports_osc_133 = true;
info.supports_osc_777 = true;
info.supports_osc_1337 = true;
}
KnownTerminal::WindowsTerminal => {
// https://learn.microsoft.com/en-us/windows/terminal/tutorials/shell-integration
// https://github.com/microsoft/terminal/blob/main/src/terminal/parser/OutputStateMachineEngine.hpp
info.supports_osc_0 = true;
info.supports_osc_1 = true;
info.supports_osc_2 = true;
info.supports_osc_4 = true;
info.supports_osc_8 = true;
info.supports_osc_9 = true;
info.supports_osc_10 = true;
info.supports_osc_11 = true;
info.supports_osc_12 = true;
info.supports_osc_17 = true;
info.supports_osc_21 = true;
info.supports_osc_52 = true;
info.supports_osc_104 = true;
info.supports_osc_110 = true;
info.supports_osc_111 = true;
info.supports_osc_112 = true;
info.supports_osc_117 = true;
info.supports_osc_133 = true;
info.supports_osc_633 = true;
info.supports_osc_1337 = true;
info.supports_osc_9001 = true;
}
_ => {
info.osc_support_unknown = true;
}
}
} else {
info.osc_support_unknown = true;
}
info
}
/// Tries to detect the hosting terminal.
///
/// # Arguments
///
/// * `env` - An implementation of `TerminalEnvironment` to access environment variables.
pub(crate) fn try_detect_terminal(env: &impl TerminalEnvironment) -> Option<KnownTerminal> {
if let Some(detected) = try_detect_terminal_from_prog_var(env) {
Some(detected)
} else if env.get_env_var("WT_SESSION").is_some() {
Some(KnownTerminal::WindowsTerminal)
} else {
None
}
}
fn try_detect_terminal_from_prog_var(env: &impl TerminalEnvironment) -> Option<KnownTerminal> {
let term_prog = env.get_env_var("TERM_PROGRAM")?;
// Remove punctuation and normalize.
let term_prog: String = term_prog
.chars()
.filter(|c| c.is_alphanumeric())
.map(|c| c.to_ascii_lowercase())
.collect();
match term_prog.as_str() {
"alacritty" => Some(KnownTerminal::Alacritty),
"appleterminal" => Some(KnownTerminal::AppleTerminal),
"ghostty" => Some(KnownTerminal::Ghostty),
"gnometerminal" => Some(KnownTerminal::GnomeTerminal),
"iterm" | "iterm2" | "itermapp" => Some(KnownTerminal::ITerm2),
"kitty" => Some(KnownTerminal::Kitty),
"konsole" => Some(KnownTerminal::Konsole),
"vscode" => Some(KnownTerminal::VSCode),
"vte" => Some(KnownTerminal::Vte),
"warp" | "warpterminal" => Some(KnownTerminal::WarpTerminal),
"wezterm" => Some(KnownTerminal::WezTerm),
"windowsterminal" => Some(KnownTerminal::WindowsTerminal),
_ => None,
}
}
#[cfg(test)]
mod tests {
use super::*;
use pretty_assertions::assert_matches;
use std::collections::HashMap;
impl TerminalEnvironment for HashMap<&str, &str> {
fn get_env_var(&self, key: &str) -> Option<String> {
self.get(key).map(|v| (*v).to_string())
}
}
#[test]
fn no_term_program() {
let test_env = HashMap::new();
let term_info = get_terminal_info(&test_env);
assert_matches!(term_info.terminal, None);
assert!(term_info.osc_support_unknown);
}
#[test]
fn unknown_term_program() {
let test_env = HashMap::from([("TERM_PROGRAM", "unknown_terminal")]);
let term_info = get_terminal_info(&test_env);
assert_matches!(term_info.terminal, None);
assert!(term_info.osc_support_unknown);
}
#[test]
fn vscode_recognition() {
let test_env = HashMap::from([("TERM_PROGRAM", "vscode"), ("VSCODE_NONCE", "test_nonce")]);
let term_info = get_terminal_info(&test_env);
assert_matches!(term_info.terminal, Some(KnownTerminal::VSCode));
assert!(term_info.supports_osc_633);
assert_eq!(term_info.session_nonce, Some("test_nonce".to_string()));
}
#[test]
fn windows_terminal_recognition() {
let test_env = HashMap::from([("WT_SESSION", "some_value")]);
let term_info = get_terminal_info(&test_env);
assert_matches!(term_info.terminal, Some(KnownTerminal::WindowsTerminal));
assert!(term_info.supports_osc_9001);
}
}