1pub mod mappings;
2
3pub use alacritty_terminal;
4
5mod pty_info;
6mod terminal_hyperlinks;
7pub mod terminal_settings;
8
9use alacritty_terminal::{
10 Term,
11 event::{Event as AlacTermEvent, EventListener, Notify, WindowSize},
12 event_loop::{EventLoop, Msg, Notifier},
13 grid::{Dimensions, Grid, Row, Scroll as AlacScroll},
14 index::{Boundary, Column, Direction as AlacDirection, Line, Point as AlacPoint},
15 selection::{Selection, SelectionRange, SelectionType},
16 sync::FairMutex,
17 term::{
18 Config, RenderableCursor, TermMode,
19 cell::{Cell, Flags},
20 search::{Match, RegexIter, RegexSearch},
21 },
22 tty::{self},
23 vi_mode::{ViModeCursor, ViMotion},
24 vte::ansi::{
25 ClearMode, CursorStyle as AlacCursorStyle, Handler, NamedPrivateMode, PrivateMode,
26 },
27};
28use anyhow::{Context as _, Result, bail};
29
30use futures::{
31 FutureExt,
32 channel::mpsc::{UnboundedReceiver, UnboundedSender, unbounded},
33};
34
35use itertools::Itertools as _;
36use mappings::mouse::{
37 alt_scroll, grid_point, grid_point_and_side, mouse_button_report, mouse_moved_report,
38 scroll_report,
39};
40
41use collections::{HashMap, VecDeque};
42use futures::StreamExt;
43use pty_info::PtyProcessInfo;
44use serde::{Deserialize, Serialize};
45use settings::Settings;
46use smol::channel::{Receiver, Sender};
47use task::{HideStrategy, Shell, SpawnInTerminal};
48use terminal_hyperlinks::RegexSearches;
49use terminal_settings::{AlternateScroll, CursorShape, TerminalSettings};
50use theme::{ActiveTheme, Theme};
51use urlencoding;
52use util::truncate_and_trailoff;
53
54use std::{
55 borrow::Cow,
56 cmp::{self, min},
57 fmt::Display,
58 ops::{Deref, RangeInclusive},
59 path::PathBuf,
60 process::ExitStatus,
61 sync::Arc,
62 time::Instant,
63};
64use thiserror::Error;
65
66use gpui::{
67 App, AppContext as _, Bounds, ClipboardItem, Context, EventEmitter, Hsla, Keystroke, Modifiers,
68 MouseButton, MouseDownEvent, MouseMoveEvent, MouseUpEvent, Pixels, Point, Rgba,
69 ScrollWheelEvent, SharedString, Size, Task, TouchPhase, Window, actions, black, px,
70};
71
72use crate::mappings::{colors::to_alac_rgb, keys::to_esc_str};
73
74actions!(
75 terminal,
76 [
77 /// Clears the terminal screen.
78 Clear,
79 /// Copies selected text to the clipboard.
80 Copy,
81 /// Pastes from the clipboard.
82 Paste,
83 /// Shows the character palette for special characters.
84 ShowCharacterPalette,
85 /// Searches for text in the terminal.
86 SearchTest,
87 /// Scrolls up by one line.
88 ScrollLineUp,
89 /// Scrolls down by one line.
90 ScrollLineDown,
91 /// Scrolls up by one page.
92 ScrollPageUp,
93 /// Scrolls down by one page.
94 ScrollPageDown,
95 /// Scrolls up by half a page.
96 ScrollHalfPageUp,
97 /// Scrolls down by half a page.
98 ScrollHalfPageDown,
99 /// Scrolls to the top of the terminal buffer.
100 ScrollToTop,
101 /// Scrolls to the bottom of the terminal buffer.
102 ScrollToBottom,
103 /// Toggles vi mode in the terminal.
104 ToggleViMode,
105 /// Selects all text in the terminal.
106 SelectAll,
107 ]
108);
109
110///Scrolling is unbearably sluggish by default. Alacritty supports a configurable
111///Scroll multiplier that is set to 3 by default. This will be removed when I
112///Implement scroll bars.
113#[cfg(target_os = "macos")]
114const SCROLL_MULTIPLIER: f32 = 4.;
115#[cfg(not(target_os = "macos"))]
116const SCROLL_MULTIPLIER: f32 = 1.;
117const DEBUG_TERMINAL_WIDTH: Pixels = px(500.);
118const DEBUG_TERMINAL_HEIGHT: Pixels = px(30.);
119const DEBUG_CELL_WIDTH: Pixels = px(5.);
120const DEBUG_LINE_HEIGHT: Pixels = px(5.);
121
122///Upward flowing events, for changing the title and such
123#[derive(Clone, Debug)]
124pub enum Event {
125 TitleChanged,
126 BreadcrumbsChanged,
127 CloseTerminal,
128 Bell,
129 Wakeup,
130 BlinkChanged(bool),
131 SelectionsChanged,
132 NewNavigationTarget(Option<MaybeNavigationTarget>),
133 Open(MaybeNavigationTarget),
134}
135
136#[derive(Clone, Debug)]
137pub struct PathLikeTarget {
138 /// File system path, absolute or relative, existing or not.
139 /// Might have line and column number(s) attached as `file.rs:1:23`
140 pub maybe_path: String,
141 /// Current working directory of the terminal
142 pub terminal_dir: Option<PathBuf>,
143}
144
145/// A string inside terminal, potentially useful as a URI that can be opened.
146#[derive(Clone, Debug)]
147pub enum MaybeNavigationTarget {
148 /// HTTP, git, etc. string determined by the `URL_REGEX` regex.
149 Url(String),
150 /// File system path, absolute or relative, existing or not.
151 /// Might have line and column number(s) attached as `file.rs:1:23`
152 PathLike(PathLikeTarget),
153}
154
155#[derive(Clone)]
156enum InternalEvent {
157 Resize(TerminalBounds),
158 Clear,
159 // FocusNextMatch,
160 Scroll(AlacScroll),
161 ScrollToAlacPoint(AlacPoint),
162 SetSelection(Option<(Selection, AlacPoint)>),
163 UpdateSelection(Point<Pixels>),
164 // Adjusted mouse position, should open
165 FindHyperlink(Point<Pixels>, bool),
166 // Whether keep selection when copy
167 Copy(Option<bool>),
168 // Vi mode events
169 ToggleViMode,
170 ViMotion(ViMotion),
171 MoveViCursorToAlacPoint(AlacPoint),
172}
173
174///A translation struct for Alacritty to communicate with us from their event loop
175#[derive(Clone)]
176pub struct ZedListener(pub UnboundedSender<AlacTermEvent>);
177
178impl EventListener for ZedListener {
179 fn send_event(&self, event: AlacTermEvent) {
180 self.0.unbounded_send(event).ok();
181 }
182}
183
184pub fn init(cx: &mut App) {
185 TerminalSettings::register(cx);
186}
187
188#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
189pub struct TerminalBounds {
190 pub cell_width: Pixels,
191 pub line_height: Pixels,
192 pub bounds: Bounds<Pixels>,
193}
194
195impl TerminalBounds {
196 pub fn new(line_height: Pixels, cell_width: Pixels, bounds: Bounds<Pixels>) -> Self {
197 TerminalBounds {
198 cell_width,
199 line_height,
200 bounds,
201 }
202 }
203
204 pub fn num_lines(&self) -> usize {
205 (self.bounds.size.height / self.line_height).floor() as usize
206 }
207
208 pub fn num_columns(&self) -> usize {
209 (self.bounds.size.width / self.cell_width).floor() as usize
210 }
211
212 pub fn height(&self) -> Pixels {
213 self.bounds.size.height
214 }
215
216 pub fn width(&self) -> Pixels {
217 self.bounds.size.width
218 }
219
220 pub fn cell_width(&self) -> Pixels {
221 self.cell_width
222 }
223
224 pub fn line_height(&self) -> Pixels {
225 self.line_height
226 }
227}
228
229impl Default for TerminalBounds {
230 fn default() -> Self {
231 TerminalBounds::new(
232 DEBUG_LINE_HEIGHT,
233 DEBUG_CELL_WIDTH,
234 Bounds {
235 origin: Point::default(),
236 size: Size {
237 width: DEBUG_TERMINAL_WIDTH,
238 height: DEBUG_TERMINAL_HEIGHT,
239 },
240 },
241 )
242 }
243}
244
245impl From<TerminalBounds> for WindowSize {
246 fn from(val: TerminalBounds) -> Self {
247 WindowSize {
248 num_lines: val.num_lines() as u16,
249 num_cols: val.num_columns() as u16,
250 cell_width: f32::from(val.cell_width()) as u16,
251 cell_height: f32::from(val.line_height()) as u16,
252 }
253 }
254}
255
256impl Dimensions for TerminalBounds {
257 /// Note: this is supposed to be for the back buffer's length,
258 /// but we exclusively use it to resize the terminal, which does not
259 /// use this method. We still have to implement it for the trait though,
260 /// hence, this comment.
261 fn total_lines(&self) -> usize {
262 self.screen_lines()
263 }
264
265 fn screen_lines(&self) -> usize {
266 self.num_lines()
267 }
268
269 fn columns(&self) -> usize {
270 self.num_columns()
271 }
272}
273
274#[derive(Error, Debug)]
275pub struct TerminalError {
276 pub directory: Option<PathBuf>,
277 pub program: Option<String>,
278 pub args: Option<Vec<String>>,
279 pub title_override: Option<SharedString>,
280 pub source: std::io::Error,
281}
282
283impl TerminalError {
284 pub fn fmt_directory(&self) -> String {
285 self.directory
286 .clone()
287 .map(|path| {
288 match path
289 .into_os_string()
290 .into_string()
291 .map_err(|os_str| format!("<non-utf8 path> {}", os_str.to_string_lossy()))
292 {
293 Ok(s) => s,
294 Err(s) => s,
295 }
296 })
297 .unwrap_or_else(|| "<none specified>".to_string())
298 }
299
300 pub fn fmt_shell(&self) -> String {
301 if let Some(title_override) = &self.title_override {
302 format!(
303 "{} {} ({})",
304 self.program.as_deref().unwrap_or("<system defined shell>"),
305 self.args.as_ref().into_iter().flatten().format(" "),
306 title_override
307 )
308 } else {
309 format!(
310 "{} {}",
311 self.program.as_deref().unwrap_or("<system defined shell>"),
312 self.args.as_ref().into_iter().flatten().format(" ")
313 )
314 }
315 }
316}
317
318impl Display for TerminalError {
319 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
320 let dir_string: String = self.fmt_directory();
321 let shell = self.fmt_shell();
322
323 write!(
324 f,
325 "Working directory: {} Shell command: `{}`, IOError: {}",
326 dir_string, shell, self.source
327 )
328 }
329}
330
331// https://github.com/alacritty/alacritty/blob/cb3a79dbf6472740daca8440d5166c1d4af5029e/extra/man/alacritty.5.scd?plain=1#L207-L213
332const DEFAULT_SCROLL_HISTORY_LINES: usize = 10_000;
333pub const MAX_SCROLL_HISTORY_LINES: usize = 100_000;
334
335pub struct TerminalBuilder {
336 terminal: Terminal,
337 events_rx: UnboundedReceiver<AlacTermEvent>,
338}
339
340impl TerminalBuilder {
341 pub fn new(
342 working_directory: Option<PathBuf>,
343 task: Option<TaskState>,
344 shell: Shell,
345 mut env: HashMap<String, String>,
346 cursor_shape: CursorShape,
347 alternate_scroll: AlternateScroll,
348 max_scroll_history_lines: Option<usize>,
349 is_ssh_terminal: bool,
350 window_id: u64,
351 completion_tx: Option<Sender<Option<ExitStatus>>>,
352 cx: &App,
353 activation_script: Vec<String>,
354 ) -> Result<TerminalBuilder> {
355 // If the parent environment doesn't have a locale set
356 // (As is the case when launched from a .app on MacOS),
357 // and the Project doesn't have a locale set, then
358 // set a fallback for our child environment to use.
359 if std::env::var("LANG").is_err() {
360 env.entry("LANG".to_string())
361 .or_insert_with(|| "en_US.UTF-8".to_string());
362 }
363
364 env.insert("ZED_TERM".to_string(), "true".to_string());
365 env.insert("TERM_PROGRAM".to_string(), "zed".to_string());
366 env.insert("TERM".to_string(), "xterm-256color".to_string());
367 env.insert("COLORTERM".to_string(), "truecolor".to_string());
368 env.insert(
369 "TERM_PROGRAM_VERSION".to_string(),
370 release_channel::AppVersion::global(cx).to_string(),
371 );
372
373 #[derive(Default)]
374 struct ShellParams {
375 program: String,
376 args: Option<Vec<String>>,
377 title_override: Option<SharedString>,
378 }
379
380 let shell_params = match shell.clone() {
381 Shell::System => {
382 #[cfg(target_os = "windows")]
383 {
384 Some(ShellParams {
385 program: util::get_windows_system_shell(),
386 ..Default::default()
387 })
388 }
389 #[cfg(not(target_os = "windows"))]
390 None
391 }
392 Shell::Program(program) => Some(ShellParams {
393 program,
394 ..Default::default()
395 }),
396 Shell::WithArguments {
397 program,
398 args,
399 title_override,
400 } => Some(ShellParams {
401 program,
402 args: Some(args),
403 title_override,
404 }),
405 };
406 let terminal_title_override = shell_params.as_ref().and_then(|e| e.title_override.clone());
407
408 #[cfg(windows)]
409 let shell_program = shell_params.as_ref().map(|params| {
410 use util::ResultExt;
411
412 Self::resolve_path(¶ms.program)
413 .log_err()
414 .unwrap_or(params.program.clone())
415 });
416
417 let pty_options = {
418 let alac_shell = shell_params.as_ref().map(|params| {
419 alacritty_terminal::tty::Shell::new(
420 params.program.clone(),
421 params.args.clone().unwrap_or_default(),
422 )
423 });
424
425 alacritty_terminal::tty::Options {
426 shell: alac_shell,
427 working_directory: working_directory.clone(),
428 drain_on_exit: true,
429 env: env.clone().into_iter().collect(),
430 #[cfg(windows)]
431 escape_args: true,
432 }
433 };
434
435 let default_cursor_style = AlacCursorStyle::from(cursor_shape);
436 let scrolling_history = if task.is_some() {
437 // Tasks like `cargo build --all` may produce a lot of output, ergo allow maximum scrolling.
438 // After the task finishes, we do not allow appending to that terminal, so small tasks output should not
439 // cause excessive memory usage over time.
440 MAX_SCROLL_HISTORY_LINES
441 } else {
442 max_scroll_history_lines
443 .unwrap_or(DEFAULT_SCROLL_HISTORY_LINES)
444 .min(MAX_SCROLL_HISTORY_LINES)
445 };
446 let config = Config {
447 scrolling_history,
448 default_cursor_style,
449 ..Config::default()
450 };
451
452 //Spawn a task so the Alacritty EventLoop can communicate with us
453 //TODO: Remove with a bounded sender which can be dispatched on &self
454 let (events_tx, events_rx) = unbounded();
455 //Set up the terminal...
456 let mut term = Term::new(
457 config.clone(),
458 &TerminalBounds::default(),
459 ZedListener(events_tx.clone()),
460 );
461
462 //Alacritty defaults to alternate scrolling being on, so we just need to turn it off.
463 if let AlternateScroll::Off = alternate_scroll {
464 term.unset_private_mode(PrivateMode::Named(NamedPrivateMode::AlternateScroll));
465 }
466
467 let term = Arc::new(FairMutex::new(term));
468
469 //Setup the pty...
470 let pty = match tty::new(&pty_options, TerminalBounds::default().into(), window_id) {
471 Ok(pty) => pty,
472 Err(error) => {
473 bail!(TerminalError {
474 directory: working_directory,
475 program: shell_params.as_ref().map(|params| params.program.clone()),
476 args: shell_params.as_ref().and_then(|params| params.args.clone()),
477 title_override: terminal_title_override,
478 source: error,
479 });
480 }
481 };
482
483 let pty_info = PtyProcessInfo::new(&pty);
484
485 //And connect them together
486 let event_loop = EventLoop::new(
487 term.clone(),
488 ZedListener(events_tx),
489 pty,
490 pty_options.drain_on_exit,
491 false,
492 )
493 .context("failed to create event loop")?;
494
495 //Kick things off
496 let pty_tx = event_loop.channel();
497 let _io_thread = event_loop.spawn(); // DANGER
498
499 let no_task = task.is_none();
500
501 let mut terminal = Terminal {
502 task,
503 pty_tx: Notifier(pty_tx),
504 completion_tx,
505 term,
506 term_config: config,
507 title_override: terminal_title_override,
508 events: VecDeque::with_capacity(10), //Should never get this high.
509 last_content: Default::default(),
510 last_mouse: None,
511 matches: Vec::new(),
512 selection_head: None,
513 pty_info,
514 breadcrumb_text: String::new(),
515 scroll_px: px(0.),
516 next_link_id: 0,
517 selection_phase: SelectionPhase::Ended,
518 // hovered_word: false,
519 hyperlink_regex_searches: RegexSearches::new(),
520 vi_mode_enabled: false,
521 is_ssh_terminal,
522 last_mouse_move_time: Instant::now(),
523 last_hyperlink_search_position: None,
524 #[cfg(windows)]
525 shell_program,
526 activation_script: activation_script.clone(),
527 template: CopyTemplate {
528 shell,
529 env,
530 cursor_shape,
531 alternate_scroll,
532 max_scroll_history_lines,
533 window_id,
534 },
535 child_exited: None,
536 };
537
538 if cfg!(not(target_os = "windows")) && !activation_script.is_empty() && no_task {
539 for activation_script in activation_script {
540 terminal.input(activation_script.into_bytes());
541 terminal.write_to_pty(b"\n");
542 }
543 terminal.clear();
544 }
545
546 Ok(TerminalBuilder {
547 terminal,
548 events_rx,
549 })
550 }
551
552 pub fn subscribe(mut self, cx: &Context<Terminal>) -> Terminal {
553 //Event loop
554 cx.spawn(async move |terminal, cx| {
555 while let Some(event) = self.events_rx.next().await {
556 terminal.update(cx, |terminal, cx| {
557 //Process the first event immediately for lowered latency
558 terminal.process_event(event, cx);
559 })?;
560
561 'outer: loop {
562 let mut events = Vec::new();
563
564 #[cfg(any(test, feature = "test-support"))]
565 let mut timer = cx.background_executor().simulate_random_delay().fuse();
566 #[cfg(not(any(test, feature = "test-support")))]
567 let mut timer = cx
568 .background_executor()
569 .timer(std::time::Duration::from_millis(4))
570 .fuse();
571
572 let mut wakeup = false;
573 loop {
574 futures::select_biased! {
575 _ = timer => break,
576 event = self.events_rx.next() => {
577 if let Some(event) = event {
578 if matches!(event, AlacTermEvent::Wakeup) {
579 wakeup = true;
580 } else {
581 events.push(event);
582 }
583
584 if events.len() > 100 {
585 break;
586 }
587 } else {
588 break;
589 }
590 },
591 }
592 }
593
594 if events.is_empty() && !wakeup {
595 smol::future::yield_now().await;
596 break 'outer;
597 }
598
599 terminal.update(cx, |this, cx| {
600 if wakeup {
601 this.process_event(AlacTermEvent::Wakeup, cx);
602 }
603
604 for event in events {
605 this.process_event(event, cx);
606 }
607 })?;
608 smol::future::yield_now().await;
609 }
610 }
611
612 anyhow::Ok(())
613 })
614 .detach();
615
616 self.terminal
617 }
618
619 #[cfg(windows)]
620 fn resolve_path(path: &str) -> Result<String> {
621 use windows::Win32::Storage::FileSystem::SearchPathW;
622 use windows::core::HSTRING;
623
624 let path = if path.starts_with(r"\\?\") || !path.contains(&['/', '\\']) {
625 path.to_string()
626 } else {
627 r"\\?\".to_string() + path
628 };
629
630 let required_length = unsafe { SearchPathW(None, &HSTRING::from(&path), None, None, None) };
631 let mut buf = vec![0u16; required_length as usize];
632 let size = unsafe { SearchPathW(None, &HSTRING::from(&path), None, Some(&mut buf), None) };
633
634 Ok(String::from_utf16(&buf[..size as usize])?)
635 }
636}
637
638#[derive(Debug, Clone, Deserialize, Serialize)]
639pub struct IndexedCell {
640 pub point: AlacPoint,
641 pub cell: Cell,
642}
643
644impl Deref for IndexedCell {
645 type Target = Cell;
646
647 #[inline]
648 fn deref(&self) -> &Cell {
649 &self.cell
650 }
651}
652
653// TODO: Un-pub
654#[derive(Clone)]
655pub struct TerminalContent {
656 pub cells: Vec<IndexedCell>,
657 pub mode: TermMode,
658 pub display_offset: usize,
659 pub selection_text: Option<String>,
660 pub selection: Option<SelectionRange>,
661 pub cursor: RenderableCursor,
662 pub cursor_char: char,
663 pub terminal_bounds: TerminalBounds,
664 pub last_hovered_word: Option<HoveredWord>,
665 pub scrolled_to_top: bool,
666 pub scrolled_to_bottom: bool,
667}
668
669#[derive(Debug, Clone, Eq, PartialEq)]
670pub struct HoveredWord {
671 pub word: String,
672 pub word_match: RangeInclusive<AlacPoint>,
673 pub id: usize,
674}
675
676impl Default for TerminalContent {
677 fn default() -> Self {
678 TerminalContent {
679 cells: Default::default(),
680 mode: Default::default(),
681 display_offset: Default::default(),
682 selection_text: Default::default(),
683 selection: Default::default(),
684 cursor: RenderableCursor {
685 shape: alacritty_terminal::vte::ansi::CursorShape::Block,
686 point: AlacPoint::new(Line(0), Column(0)),
687 },
688 cursor_char: Default::default(),
689 terminal_bounds: Default::default(),
690 last_hovered_word: None,
691 scrolled_to_top: false,
692 scrolled_to_bottom: false,
693 }
694 }
695}
696
697#[derive(PartialEq, Eq)]
698pub enum SelectionPhase {
699 Selecting,
700 Ended,
701}
702
703pub struct Terminal {
704 pty_tx: Notifier,
705 completion_tx: Option<Sender<Option<ExitStatus>>>,
706 term: Arc<FairMutex<Term<ZedListener>>>,
707 term_config: Config,
708 events: VecDeque<InternalEvent>,
709 /// This is only used for mouse mode cell change detection
710 last_mouse: Option<(AlacPoint, AlacDirection)>,
711 pub matches: Vec<RangeInclusive<AlacPoint>>,
712 pub last_content: TerminalContent,
713 pub selection_head: Option<AlacPoint>,
714 pub breadcrumb_text: String,
715 pub pty_info: PtyProcessInfo,
716 title_override: Option<SharedString>,
717 scroll_px: Pixels,
718 next_link_id: usize,
719 selection_phase: SelectionPhase,
720 hyperlink_regex_searches: RegexSearches,
721 task: Option<TaskState>,
722 vi_mode_enabled: bool,
723 is_ssh_terminal: bool,
724 last_mouse_move_time: Instant,
725 last_hyperlink_search_position: Option<Point<Pixels>>,
726 #[cfg(windows)]
727 shell_program: Option<String>,
728 template: CopyTemplate,
729 activation_script: Vec<String>,
730 child_exited: Option<ExitStatus>,
731}
732
733struct CopyTemplate {
734 shell: Shell,
735 env: HashMap<String, String>,
736 cursor_shape: CursorShape,
737 alternate_scroll: AlternateScroll,
738 max_scroll_history_lines: Option<usize>,
739 window_id: u64,
740}
741
742#[derive(Debug)]
743pub struct TaskState {
744 pub status: TaskStatus,
745 pub completion_rx: Receiver<Option<ExitStatus>>,
746 pub spawned_task: SpawnInTerminal,
747}
748
749/// A status of the current terminal tab's task.
750#[derive(Debug, Clone, Copy, PartialEq, Eq)]
751pub enum TaskStatus {
752 /// The task had been started, but got cancelled or somehow otherwise it did not
753 /// report its exit code before the terminal event loop was shut down.
754 Unknown,
755 /// The task is started and running currently.
756 Running,
757 /// After the start, the task stopped running and reported its error code back.
758 Completed { success: bool },
759}
760
761impl TaskStatus {
762 fn register_terminal_exit(&mut self) {
763 if self == &Self::Running {
764 *self = Self::Unknown;
765 }
766 }
767
768 fn register_task_exit(&mut self, error_code: i32) {
769 *self = TaskStatus::Completed {
770 success: error_code == 0,
771 };
772 }
773}
774
775impl Terminal {
776 fn process_event(&mut self, event: AlacTermEvent, cx: &mut Context<Self>) {
777 match event {
778 AlacTermEvent::Title(title) => {
779 // ignore default shell program title change as windows always sends those events
780 // and it would end up showing the shell executable path in breadcrumbs
781 #[cfg(windows)]
782 {
783 if self
784 .shell_program
785 .as_ref()
786 .map(|e| *e == title)
787 .unwrap_or(false)
788 {
789 return;
790 }
791 }
792
793 self.breadcrumb_text = title;
794 cx.emit(Event::BreadcrumbsChanged);
795 }
796 AlacTermEvent::ResetTitle => {
797 self.breadcrumb_text = String::new();
798 cx.emit(Event::BreadcrumbsChanged);
799 }
800 AlacTermEvent::ClipboardStore(_, data) => {
801 cx.write_to_clipboard(ClipboardItem::new_string(data))
802 }
803 AlacTermEvent::ClipboardLoad(_, format) => {
804 self.write_to_pty(
805 match &cx.read_from_clipboard().and_then(|item| item.text()) {
806 // The terminal only supports pasting strings, not images.
807 Some(text) => format(text),
808 _ => format(""),
809 }
810 .into_bytes(),
811 )
812 }
813 AlacTermEvent::PtyWrite(out) => self.write_to_pty(out.into_bytes()),
814 AlacTermEvent::TextAreaSizeRequest(format) => {
815 self.write_to_pty(format(self.last_content.terminal_bounds.into()).into_bytes())
816 }
817 AlacTermEvent::CursorBlinkingChange => {
818 let terminal = self.term.lock();
819 let blinking = terminal.cursor_style().blinking;
820 cx.emit(Event::BlinkChanged(blinking));
821 }
822 AlacTermEvent::Bell => {
823 cx.emit(Event::Bell);
824 }
825 AlacTermEvent::Exit => self.register_task_finished(None, cx),
826 AlacTermEvent::MouseCursorDirty => {
827 //NOOP, Handled in render
828 }
829 AlacTermEvent::Wakeup => {
830 cx.emit(Event::Wakeup);
831
832 if self.pty_info.has_changed() {
833 cx.emit(Event::TitleChanged);
834 }
835 }
836 AlacTermEvent::ColorRequest(index, format) => {
837 // It's important that the color request is processed here to retain relative order
838 // with other PTY writes. Otherwise applications might witness out-of-order
839 // responses to requests. For example: An application sending `OSC 11 ; ? ST`
840 // (color request) followed by `CSI c` (request device attributes) would receive
841 // the response to `CSI c` first.
842 // Instead of locking, we could store the colors in `self.last_content`. But then
843 // we might respond with out of date value if a "set color" sequence is immediately
844 // followed by a color request sequence.
845 let color = self.term.lock().colors()[index]
846 .unwrap_or_else(|| to_alac_rgb(get_color_at_index(index, cx.theme().as_ref())));
847 self.write_to_pty(format(color).into_bytes());
848 }
849 AlacTermEvent::ChildExit(error_code) => {
850 self.register_task_finished(Some(error_code), cx);
851 }
852 }
853 }
854
855 pub fn selection_started(&self) -> bool {
856 self.selection_phase == SelectionPhase::Selecting
857 }
858
859 fn process_terminal_event(
860 &mut self,
861 event: &InternalEvent,
862 term: &mut Term<ZedListener>,
863 window: &mut Window,
864 cx: &mut Context<Self>,
865 ) {
866 match event {
867 &InternalEvent::Resize(mut new_bounds) => {
868 new_bounds.bounds.size.height =
869 cmp::max(new_bounds.line_height, new_bounds.height());
870 new_bounds.bounds.size.width = cmp::max(new_bounds.cell_width, new_bounds.width());
871
872 self.last_content.terminal_bounds = new_bounds;
873
874 self.pty_tx.0.send(Msg::Resize(new_bounds.into())).ok();
875
876 term.resize(new_bounds);
877 }
878 InternalEvent::Clear => {
879 // Clear back buffer
880 term.clear_screen(ClearMode::Saved);
881
882 let cursor = term.grid().cursor.point;
883
884 // Clear the lines above
885 term.grid_mut().reset_region(..cursor.line);
886
887 // Copy the current line up
888 let line = term.grid()[cursor.line][..Column(term.grid().columns())]
889 .iter()
890 .cloned()
891 .enumerate()
892 .collect::<Vec<(usize, Cell)>>();
893
894 for (i, cell) in line {
895 term.grid_mut()[Line(0)][Column(i)] = cell;
896 }
897
898 // Reset the cursor
899 term.grid_mut().cursor.point =
900 AlacPoint::new(Line(0), term.grid_mut().cursor.point.column);
901 let new_cursor = term.grid().cursor.point;
902
903 // Clear the lines below the new cursor
904 if (new_cursor.line.0 as usize) < term.screen_lines() - 1 {
905 term.grid_mut().reset_region((new_cursor.line + 1)..);
906 }
907
908 cx.emit(Event::Wakeup);
909 }
910 InternalEvent::Scroll(scroll) => {
911 term.scroll_display(*scroll);
912 self.refresh_hovered_word(window);
913
914 if self.vi_mode_enabled {
915 match *scroll {
916 AlacScroll::Delta(delta) => {
917 term.vi_mode_cursor = term.vi_mode_cursor.scroll(term, delta);
918 }
919 AlacScroll::PageUp => {
920 let lines = term.screen_lines() as i32;
921 term.vi_mode_cursor = term.vi_mode_cursor.scroll(term, lines);
922 }
923 AlacScroll::PageDown => {
924 let lines = -(term.screen_lines() as i32);
925 term.vi_mode_cursor = term.vi_mode_cursor.scroll(term, lines);
926 }
927 AlacScroll::Top => {
928 let point = AlacPoint::new(term.topmost_line(), Column(0));
929 term.vi_mode_cursor = ViModeCursor::new(point);
930 }
931 AlacScroll::Bottom => {
932 let point = AlacPoint::new(term.bottommost_line(), Column(0));
933 term.vi_mode_cursor = ViModeCursor::new(point);
934 }
935 }
936 if let Some(mut selection) = term.selection.take() {
937 let point = term.vi_mode_cursor.point;
938 selection.update(point, AlacDirection::Right);
939 term.selection = Some(selection);
940
941 #[cfg(any(target_os = "linux", target_os = "freebsd"))]
942 if let Some(selection_text) = term.selection_to_string() {
943 cx.write_to_primary(ClipboardItem::new_string(selection_text));
944 }
945
946 self.selection_head = Some(point);
947 cx.emit(Event::SelectionsChanged)
948 }
949 }
950 }
951 InternalEvent::SetSelection(selection) => {
952 term.selection = selection.as_ref().map(|(sel, _)| sel.clone());
953
954 #[cfg(any(target_os = "linux", target_os = "freebsd"))]
955 if let Some(selection_text) = term.selection_to_string() {
956 cx.write_to_primary(ClipboardItem::new_string(selection_text));
957 }
958
959 if let Some((_, head)) = selection {
960 self.selection_head = Some(*head);
961 }
962 cx.emit(Event::SelectionsChanged)
963 }
964 InternalEvent::UpdateSelection(position) => {
965 if let Some(mut selection) = term.selection.take() {
966 let (point, side) = grid_point_and_side(
967 *position,
968 self.last_content.terminal_bounds,
969 term.grid().display_offset(),
970 );
971
972 selection.update(point, side);
973 term.selection = Some(selection);
974
975 #[cfg(any(target_os = "linux", target_os = "freebsd"))]
976 if let Some(selection_text) = term.selection_to_string() {
977 cx.write_to_primary(ClipboardItem::new_string(selection_text));
978 }
979
980 self.selection_head = Some(point);
981 cx.emit(Event::SelectionsChanged)
982 }
983 }
984
985 InternalEvent::Copy(keep_selection) => {
986 if let Some(txt) = term.selection_to_string() {
987 cx.write_to_clipboard(ClipboardItem::new_string(txt));
988 if !keep_selection.unwrap_or_else(|| {
989 let settings = TerminalSettings::get_global(cx);
990 settings.keep_selection_on_copy
991 }) {
992 self.events.push_back(InternalEvent::SetSelection(None));
993 }
994 }
995 }
996 InternalEvent::ScrollToAlacPoint(point) => {
997 term.scroll_to_point(*point);
998 self.refresh_hovered_word(window);
999 }
1000 InternalEvent::MoveViCursorToAlacPoint(point) => {
1001 term.vi_goto_point(*point);
1002 self.refresh_hovered_word(window);
1003 }
1004 InternalEvent::ToggleViMode => {
1005 self.vi_mode_enabled = !self.vi_mode_enabled;
1006 term.toggle_vi_mode();
1007 }
1008 InternalEvent::ViMotion(motion) => {
1009 term.vi_motion(*motion);
1010 }
1011 InternalEvent::FindHyperlink(position, open) => {
1012 let prev_hovered_word = self.last_content.last_hovered_word.take();
1013
1014 let point = grid_point(
1015 *position,
1016 self.last_content.terminal_bounds,
1017 term.grid().display_offset(),
1018 )
1019 .grid_clamp(term, Boundary::Grid);
1020
1021 match terminal_hyperlinks::find_from_grid_point(
1022 term,
1023 point,
1024 &mut self.hyperlink_regex_searches,
1025 ) {
1026 Some((maybe_url_or_path, is_url, url_match)) => {
1027 let target = if is_url {
1028 // Treat "file://" URLs like file paths to ensure
1029 // that line numbers at the end of the path are
1030 // handled correctly.
1031 // file://{path} should be urldecoded, returning a urldecoded {path}
1032 if let Some(path) = maybe_url_or_path.strip_prefix("file://") {
1033 let decoded_path = urlencoding::decode(path)
1034 .map(|decoded| decoded.into_owned())
1035 .unwrap_or(path.to_owned());
1036
1037 MaybeNavigationTarget::PathLike(PathLikeTarget {
1038 maybe_path: decoded_path,
1039 terminal_dir: self.working_directory(),
1040 })
1041 } else {
1042 MaybeNavigationTarget::Url(maybe_url_or_path.clone())
1043 }
1044 } else {
1045 MaybeNavigationTarget::PathLike(PathLikeTarget {
1046 maybe_path: maybe_url_or_path.clone(),
1047 terminal_dir: self.working_directory(),
1048 })
1049 };
1050 if *open {
1051 cx.emit(Event::Open(target));
1052 } else {
1053 self.update_selected_word(
1054 prev_hovered_word,
1055 url_match,
1056 maybe_url_or_path,
1057 target,
1058 cx,
1059 );
1060 }
1061 }
1062 None => {
1063 cx.emit(Event::NewNavigationTarget(None));
1064 }
1065 }
1066 }
1067 }
1068 }
1069
1070 fn update_selected_word(
1071 &mut self,
1072 prev_word: Option<HoveredWord>,
1073 word_match: RangeInclusive<AlacPoint>,
1074 word: String,
1075 navigation_target: MaybeNavigationTarget,
1076 cx: &mut Context<Self>,
1077 ) {
1078 if let Some(prev_word) = prev_word
1079 && prev_word.word == word
1080 && prev_word.word_match == word_match
1081 {
1082 self.last_content.last_hovered_word = Some(HoveredWord {
1083 word,
1084 word_match,
1085 id: prev_word.id,
1086 });
1087 return;
1088 }
1089
1090 self.last_content.last_hovered_word = Some(HoveredWord {
1091 word,
1092 word_match,
1093 id: self.next_link_id(),
1094 });
1095 cx.emit(Event::NewNavigationTarget(Some(navigation_target)));
1096 cx.notify()
1097 }
1098
1099 fn next_link_id(&mut self) -> usize {
1100 let res = self.next_link_id;
1101 self.next_link_id = self.next_link_id.wrapping_add(1);
1102 res
1103 }
1104
1105 pub fn last_content(&self) -> &TerminalContent {
1106 &self.last_content
1107 }
1108
1109 pub fn set_cursor_shape(&mut self, cursor_shape: CursorShape) {
1110 self.term_config.default_cursor_style = cursor_shape.into();
1111 self.term.lock().set_options(self.term_config.clone());
1112 }
1113
1114 pub fn total_lines(&self) -> usize {
1115 let term = self.term.clone();
1116 let terminal = term.lock_unfair();
1117 terminal.total_lines()
1118 }
1119
1120 pub fn viewport_lines(&self) -> usize {
1121 let term = self.term.clone();
1122 let terminal = term.lock_unfair();
1123 terminal.screen_lines()
1124 }
1125
1126 //To test:
1127 //- Activate match on terminal (scrolling and selection)
1128 //- Editor search snapping behavior
1129
1130 pub fn activate_match(&mut self, index: usize) {
1131 if let Some(search_match) = self.matches.get(index).cloned() {
1132 self.set_selection(Some((make_selection(&search_match), *search_match.end())));
1133 if self.vi_mode_enabled {
1134 self.events
1135 .push_back(InternalEvent::MoveViCursorToAlacPoint(*search_match.end()));
1136 } else {
1137 self.events
1138 .push_back(InternalEvent::ScrollToAlacPoint(*search_match.start()));
1139 }
1140 }
1141 }
1142
1143 pub fn select_matches(&mut self, matches: &[RangeInclusive<AlacPoint>]) {
1144 let matches_to_select = self
1145 .matches
1146 .iter()
1147 .filter(|self_match| matches.contains(self_match))
1148 .cloned()
1149 .collect::<Vec<_>>();
1150 for match_to_select in matches_to_select {
1151 self.set_selection(Some((
1152 make_selection(&match_to_select),
1153 *match_to_select.end(),
1154 )));
1155 }
1156 }
1157
1158 pub fn select_all(&mut self) {
1159 let term = self.term.lock();
1160 let start = AlacPoint::new(term.topmost_line(), Column(0));
1161 let end = AlacPoint::new(term.bottommost_line(), term.last_column());
1162 drop(term);
1163 self.set_selection(Some((make_selection(&(start..=end)), end)));
1164 }
1165
1166 fn set_selection(&mut self, selection: Option<(Selection, AlacPoint)>) {
1167 self.events
1168 .push_back(InternalEvent::SetSelection(selection));
1169 }
1170
1171 pub fn copy(&mut self, keep_selection: Option<bool>) {
1172 self.events.push_back(InternalEvent::Copy(keep_selection));
1173 }
1174
1175 pub fn clear(&mut self) {
1176 self.events.push_back(InternalEvent::Clear)
1177 }
1178
1179 pub fn scroll_line_up(&mut self) {
1180 self.events
1181 .push_back(InternalEvent::Scroll(AlacScroll::Delta(1)));
1182 }
1183
1184 pub fn scroll_up_by(&mut self, lines: usize) {
1185 self.events
1186 .push_back(InternalEvent::Scroll(AlacScroll::Delta(lines as i32)));
1187 }
1188
1189 pub fn scroll_line_down(&mut self) {
1190 self.events
1191 .push_back(InternalEvent::Scroll(AlacScroll::Delta(-1)));
1192 }
1193
1194 pub fn scroll_down_by(&mut self, lines: usize) {
1195 self.events
1196 .push_back(InternalEvent::Scroll(AlacScroll::Delta(-(lines as i32))));
1197 }
1198
1199 pub fn scroll_page_up(&mut self) {
1200 self.events
1201 .push_back(InternalEvent::Scroll(AlacScroll::PageUp));
1202 }
1203
1204 pub fn scroll_page_down(&mut self) {
1205 self.events
1206 .push_back(InternalEvent::Scroll(AlacScroll::PageDown));
1207 }
1208
1209 pub fn scroll_to_top(&mut self) {
1210 self.events
1211 .push_back(InternalEvent::Scroll(AlacScroll::Top));
1212 }
1213
1214 pub fn scroll_to_bottom(&mut self) {
1215 self.events
1216 .push_back(InternalEvent::Scroll(AlacScroll::Bottom));
1217 }
1218
1219 pub fn scrolled_to_top(&self) -> bool {
1220 self.last_content.scrolled_to_top
1221 }
1222
1223 pub fn scrolled_to_bottom(&self) -> bool {
1224 self.last_content.scrolled_to_bottom
1225 }
1226
1227 ///Resize the terminal and the PTY.
1228 pub fn set_size(&mut self, new_bounds: TerminalBounds) {
1229 if self.last_content.terminal_bounds != new_bounds {
1230 self.events.push_back(InternalEvent::Resize(new_bounds))
1231 }
1232 }
1233
1234 ///Write the Input payload to the tty.
1235 fn write_to_pty(&self, input: impl Into<Cow<'static, [u8]>>) {
1236 self.pty_tx.notify(input.into());
1237 }
1238
1239 pub fn input(&mut self, input: impl Into<Cow<'static, [u8]>>) {
1240 self.events
1241 .push_back(InternalEvent::Scroll(AlacScroll::Bottom));
1242 self.events.push_back(InternalEvent::SetSelection(None));
1243
1244 self.write_to_pty(input);
1245 }
1246
1247 pub fn toggle_vi_mode(&mut self) {
1248 self.events.push_back(InternalEvent::ToggleViMode);
1249 }
1250
1251 pub fn vi_motion(&mut self, keystroke: &Keystroke) {
1252 if !self.vi_mode_enabled {
1253 return;
1254 }
1255
1256 let key: Cow<'_, str> = if keystroke.modifiers.shift {
1257 Cow::Owned(keystroke.key.to_uppercase())
1258 } else {
1259 Cow::Borrowed(keystroke.key.as_str())
1260 };
1261
1262 let motion: Option<ViMotion> = match key.as_ref() {
1263 "h" | "left" => Some(ViMotion::Left),
1264 "j" | "down" => Some(ViMotion::Down),
1265 "k" | "up" => Some(ViMotion::Up),
1266 "l" | "right" => Some(ViMotion::Right),
1267 "w" => Some(ViMotion::WordRight),
1268 "b" if !keystroke.modifiers.control => Some(ViMotion::WordLeft),
1269 "e" => Some(ViMotion::WordRightEnd),
1270 "%" => Some(ViMotion::Bracket),
1271 "$" => Some(ViMotion::Last),
1272 "0" => Some(ViMotion::First),
1273 "^" => Some(ViMotion::FirstOccupied),
1274 "H" => Some(ViMotion::High),
1275 "M" => Some(ViMotion::Middle),
1276 "L" => Some(ViMotion::Low),
1277 _ => None,
1278 };
1279
1280 if let Some(motion) = motion {
1281 let cursor = self.last_content.cursor.point;
1282 let cursor_pos = Point {
1283 x: cursor.column.0 as f32 * self.last_content.terminal_bounds.cell_width,
1284 y: cursor.line.0 as f32 * self.last_content.terminal_bounds.line_height,
1285 };
1286 self.events
1287 .push_back(InternalEvent::UpdateSelection(cursor_pos));
1288 self.events.push_back(InternalEvent::ViMotion(motion));
1289 return;
1290 }
1291
1292 let scroll_motion = match key.as_ref() {
1293 "g" => Some(AlacScroll::Top),
1294 "G" => Some(AlacScroll::Bottom),
1295 "b" if keystroke.modifiers.control => Some(AlacScroll::PageUp),
1296 "f" if keystroke.modifiers.control => Some(AlacScroll::PageDown),
1297 "d" if keystroke.modifiers.control => {
1298 let amount = self.last_content.terminal_bounds.line_height().to_f64() as i32 / 2;
1299 Some(AlacScroll::Delta(-amount))
1300 }
1301 "u" if keystroke.modifiers.control => {
1302 let amount = self.last_content.terminal_bounds.line_height().to_f64() as i32 / 2;
1303 Some(AlacScroll::Delta(amount))
1304 }
1305 _ => None,
1306 };
1307
1308 if let Some(scroll_motion) = scroll_motion {
1309 self.events.push_back(InternalEvent::Scroll(scroll_motion));
1310 return;
1311 }
1312
1313 match key.as_ref() {
1314 "v" => {
1315 let point = self.last_content.cursor.point;
1316 let selection_type = SelectionType::Simple;
1317 let side = AlacDirection::Right;
1318 let selection = Selection::new(selection_type, point, side);
1319 self.events
1320 .push_back(InternalEvent::SetSelection(Some((selection, point))));
1321 }
1322
1323 "escape" => {
1324 self.events.push_back(InternalEvent::SetSelection(None));
1325 }
1326
1327 "y" => {
1328 self.copy(Some(false));
1329 }
1330
1331 "i" => {
1332 self.scroll_to_bottom();
1333 self.toggle_vi_mode();
1334 }
1335 _ => {}
1336 }
1337 }
1338
1339 pub fn try_keystroke(&mut self, keystroke: &Keystroke, alt_is_meta: bool) -> bool {
1340 if self.vi_mode_enabled {
1341 self.vi_motion(keystroke);
1342 return true;
1343 }
1344
1345 // Keep default terminal behavior
1346 let esc = to_esc_str(keystroke, &self.last_content.mode, alt_is_meta);
1347 if let Some(esc) = esc {
1348 match esc {
1349 Cow::Borrowed(string) => self.input(string.as_bytes()),
1350 Cow::Owned(string) => self.input(string.into_bytes()),
1351 };
1352 true
1353 } else {
1354 false
1355 }
1356 }
1357
1358 pub fn try_modifiers_change(
1359 &mut self,
1360 modifiers: &Modifiers,
1361 window: &Window,
1362 cx: &mut Context<Self>,
1363 ) {
1364 if self
1365 .last_content
1366 .terminal_bounds
1367 .bounds
1368 .contains(&window.mouse_position())
1369 && modifiers.secondary()
1370 {
1371 self.refresh_hovered_word(window);
1372 }
1373 cx.notify();
1374 }
1375
1376 ///Paste text into the terminal
1377 pub fn paste(&mut self, text: &str) {
1378 let paste_text = if self.last_content.mode.contains(TermMode::BRACKETED_PASTE) {
1379 format!("{}{}{}", "\x1b[200~", text.replace('\x1b', ""), "\x1b[201~")
1380 } else {
1381 text.replace("\r\n", "\r").replace('\n', "\r")
1382 };
1383
1384 self.input(paste_text.into_bytes());
1385 }
1386
1387 pub fn sync(&mut self, window: &mut Window, cx: &mut Context<Self>) {
1388 let term = self.term.clone();
1389 let mut terminal = term.lock_unfair();
1390 //Note that the ordering of events matters for event processing
1391 while let Some(e) = self.events.pop_front() {
1392 self.process_terminal_event(&e, &mut terminal, window, cx)
1393 }
1394
1395 self.last_content = Self::make_content(&terminal, &self.last_content);
1396 }
1397
1398 fn make_content(term: &Term<ZedListener>, last_content: &TerminalContent) -> TerminalContent {
1399 let content = term.renderable_content();
1400
1401 // Pre-allocate with estimated size to reduce reallocations
1402 let estimated_size = content.display_iter.size_hint().0;
1403 let mut cells = Vec::with_capacity(estimated_size);
1404
1405 cells.extend(content.display_iter.map(|ic| IndexedCell {
1406 point: ic.point,
1407 cell: ic.cell.clone(),
1408 }));
1409
1410 let selection_text = if content.selection.is_some() {
1411 term.selection_to_string()
1412 } else {
1413 None
1414 };
1415
1416 TerminalContent {
1417 cells,
1418 mode: content.mode,
1419 display_offset: content.display_offset,
1420 selection_text,
1421 selection: content.selection,
1422 cursor: content.cursor,
1423 cursor_char: term.grid()[content.cursor.point].c,
1424 terminal_bounds: last_content.terminal_bounds,
1425 last_hovered_word: last_content.last_hovered_word.clone(),
1426 scrolled_to_top: content.display_offset == term.history_size(),
1427 scrolled_to_bottom: content.display_offset == 0,
1428 }
1429 }
1430
1431 pub fn get_content(&self) -> String {
1432 let term = self.term.lock_unfair();
1433 let start = AlacPoint::new(term.topmost_line(), Column(0));
1434 let end = AlacPoint::new(term.bottommost_line(), term.last_column());
1435 term.bounds_to_string(start, end)
1436 }
1437
1438 pub fn last_n_non_empty_lines(&self, n: usize) -> Vec<String> {
1439 let term = self.term.clone();
1440 let terminal = term.lock_unfair();
1441 let grid = terminal.grid();
1442 let mut lines = Vec::new();
1443
1444 let mut current_line = grid.bottommost_line().0;
1445 let topmost_line = grid.topmost_line().0;
1446
1447 while current_line >= topmost_line && lines.len() < n {
1448 let logical_line_start = self.find_logical_line_start(grid, current_line, topmost_line);
1449 let logical_line = self.construct_logical_line(grid, logical_line_start, current_line);
1450
1451 if let Some(line) = self.process_line(logical_line) {
1452 lines.push(line);
1453 }
1454
1455 // Move to the line above the start of the current logical line
1456 current_line = logical_line_start - 1;
1457 }
1458
1459 lines.reverse();
1460 lines
1461 }
1462
1463 fn find_logical_line_start(&self, grid: &Grid<Cell>, current: i32, topmost: i32) -> i32 {
1464 let mut line_start = current;
1465 while line_start > topmost {
1466 let prev_line = Line(line_start - 1);
1467 let last_cell = &grid[prev_line][Column(grid.columns() - 1)];
1468 if !last_cell.flags.contains(Flags::WRAPLINE) {
1469 break;
1470 }
1471 line_start -= 1;
1472 }
1473 line_start
1474 }
1475
1476 fn construct_logical_line(&self, grid: &Grid<Cell>, start: i32, end: i32) -> String {
1477 let mut logical_line = String::new();
1478 for row in start..=end {
1479 let grid_row = &grid[Line(row)];
1480 logical_line.push_str(&row_to_string(grid_row));
1481 }
1482 logical_line
1483 }
1484
1485 fn process_line(&self, line: String) -> Option<String> {
1486 let trimmed = line.trim_end().to_string();
1487 if !trimmed.is_empty() {
1488 Some(trimmed)
1489 } else {
1490 None
1491 }
1492 }
1493
1494 pub fn focus_in(&self) {
1495 if self.last_content.mode.contains(TermMode::FOCUS_IN_OUT) {
1496 self.write_to_pty("\x1b[I".as_bytes());
1497 }
1498 }
1499
1500 pub fn focus_out(&mut self) {
1501 if self.last_content.mode.contains(TermMode::FOCUS_IN_OUT) {
1502 self.write_to_pty("\x1b[O".as_bytes());
1503 }
1504 }
1505
1506 pub fn mouse_changed(&mut self, point: AlacPoint, side: AlacDirection) -> bool {
1507 match self.last_mouse {
1508 Some((old_point, old_side)) => {
1509 if old_point == point && old_side == side {
1510 false
1511 } else {
1512 self.last_mouse = Some((point, side));
1513 true
1514 }
1515 }
1516 None => {
1517 self.last_mouse = Some((point, side));
1518 true
1519 }
1520 }
1521 }
1522
1523 pub fn mouse_mode(&self, shift: bool) -> bool {
1524 self.last_content.mode.intersects(TermMode::MOUSE_MODE) && !shift
1525 }
1526
1527 pub fn mouse_move(&mut self, e: &MouseMoveEvent, cx: &mut Context<Self>) {
1528 let position = e.position - self.last_content.terminal_bounds.bounds.origin;
1529 if self.mouse_mode(e.modifiers.shift) {
1530 let (point, side) = grid_point_and_side(
1531 position,
1532 self.last_content.terminal_bounds,
1533 self.last_content.display_offset,
1534 );
1535
1536 if self.mouse_changed(point, side)
1537 && let Some(bytes) =
1538 mouse_moved_report(point, e.pressed_button, e.modifiers, self.last_content.mode)
1539 {
1540 self.pty_tx.notify(bytes);
1541 }
1542 } else if e.modifiers.secondary() {
1543 self.word_from_position(e.position);
1544 }
1545 cx.notify();
1546 }
1547
1548 fn word_from_position(&mut self, position: Point<Pixels>) {
1549 if self.selection_phase == SelectionPhase::Selecting {
1550 self.last_content.last_hovered_word = None;
1551 } else if self.last_content.terminal_bounds.bounds.contains(&position) {
1552 // Throttle hyperlink searches to avoid excessive processing
1553 let now = Instant::now();
1554 let should_search = if let Some(last_pos) = self.last_hyperlink_search_position {
1555 // Only search if mouse moved significantly or enough time passed
1556 let distance_moved =
1557 ((position.x - last_pos.x).abs() + (position.y - last_pos.y).abs()) > px(5.0);
1558 let time_elapsed = now.duration_since(self.last_mouse_move_time).as_millis() > 100;
1559 distance_moved || time_elapsed
1560 } else {
1561 true
1562 };
1563
1564 if should_search {
1565 self.last_mouse_move_time = now;
1566 self.last_hyperlink_search_position = Some(position);
1567 self.events.push_back(InternalEvent::FindHyperlink(
1568 position - self.last_content.terminal_bounds.bounds.origin,
1569 false,
1570 ));
1571 }
1572 } else {
1573 self.last_content.last_hovered_word = None;
1574 }
1575 }
1576
1577 pub fn select_word_at_event_position(&mut self, e: &MouseDownEvent) {
1578 let position = e.position - self.last_content.terminal_bounds.bounds.origin;
1579 let (point, side) = grid_point_and_side(
1580 position,
1581 self.last_content.terminal_bounds,
1582 self.last_content.display_offset,
1583 );
1584 let selection = Selection::new(SelectionType::Semantic, point, side);
1585 self.events
1586 .push_back(InternalEvent::SetSelection(Some((selection, point))));
1587 }
1588
1589 pub fn mouse_drag(
1590 &mut self,
1591 e: &MouseMoveEvent,
1592 region: Bounds<Pixels>,
1593 cx: &mut Context<Self>,
1594 ) {
1595 let position = e.position - self.last_content.terminal_bounds.bounds.origin;
1596 if !self.mouse_mode(e.modifiers.shift) {
1597 self.selection_phase = SelectionPhase::Selecting;
1598 // Alacritty has the same ordering, of first updating the selection
1599 // then scrolling 15ms later
1600 self.events
1601 .push_back(InternalEvent::UpdateSelection(position));
1602
1603 // Doesn't make sense to scroll the alt screen
1604 if !self.last_content.mode.contains(TermMode::ALT_SCREEN) {
1605 let scroll_lines = match self.drag_line_delta(e, region) {
1606 Some(value) => value,
1607 None => return,
1608 };
1609
1610 self.events
1611 .push_back(InternalEvent::Scroll(AlacScroll::Delta(scroll_lines)));
1612 }
1613
1614 cx.notify();
1615 }
1616 }
1617
1618 fn drag_line_delta(&self, e: &MouseMoveEvent, region: Bounds<Pixels>) -> Option<i32> {
1619 let top = region.origin.y;
1620 let bottom = region.bottom_left().y;
1621
1622 let scroll_lines = if e.position.y < top {
1623 let scroll_delta = (top - e.position.y).pow(1.1);
1624 (scroll_delta / self.last_content.terminal_bounds.line_height).ceil() as i32
1625 } else if e.position.y > bottom {
1626 let scroll_delta = -((e.position.y - bottom).pow(1.1));
1627 (scroll_delta / self.last_content.terminal_bounds.line_height).floor() as i32
1628 } else {
1629 return None;
1630 };
1631
1632 Some(scroll_lines.clamp(-3, 3))
1633 }
1634
1635 pub fn mouse_down(&mut self, e: &MouseDownEvent, _cx: &mut Context<Self>) {
1636 let position = e.position - self.last_content.terminal_bounds.bounds.origin;
1637 let point = grid_point(
1638 position,
1639 self.last_content.terminal_bounds,
1640 self.last_content.display_offset,
1641 );
1642
1643 if self.mouse_mode(e.modifiers.shift) {
1644 if let Some(bytes) =
1645 mouse_button_report(point, e.button, e.modifiers, true, self.last_content.mode)
1646 {
1647 self.pty_tx.notify(bytes);
1648 }
1649 } else {
1650 match e.button {
1651 MouseButton::Left => {
1652 let (point, side) = grid_point_and_side(
1653 position,
1654 self.last_content.terminal_bounds,
1655 self.last_content.display_offset,
1656 );
1657
1658 let selection_type = match e.click_count {
1659 0 => return, //This is a release
1660 1 => Some(SelectionType::Simple),
1661 2 => Some(SelectionType::Semantic),
1662 3 => Some(SelectionType::Lines),
1663 _ => None,
1664 };
1665
1666 if selection_type == Some(SelectionType::Simple) && e.modifiers.shift {
1667 self.events
1668 .push_back(InternalEvent::UpdateSelection(position));
1669 return;
1670 }
1671
1672 let selection = selection_type
1673 .map(|selection_type| Selection::new(selection_type, point, side));
1674
1675 if let Some(sel) = selection {
1676 self.events
1677 .push_back(InternalEvent::SetSelection(Some((sel, point))));
1678 }
1679 }
1680 #[cfg(any(target_os = "linux", target_os = "freebsd"))]
1681 MouseButton::Middle => {
1682 if let Some(item) = _cx.read_from_primary() {
1683 let text = item.text().unwrap_or_default();
1684 self.input(text.into_bytes());
1685 }
1686 }
1687 _ => {}
1688 }
1689 }
1690 }
1691
1692 pub fn mouse_up(&mut self, e: &MouseUpEvent, cx: &Context<Self>) {
1693 let setting = TerminalSettings::get_global(cx);
1694
1695 let position = e.position - self.last_content.terminal_bounds.bounds.origin;
1696 if self.mouse_mode(e.modifiers.shift) {
1697 let point = grid_point(
1698 position,
1699 self.last_content.terminal_bounds,
1700 self.last_content.display_offset,
1701 );
1702
1703 if let Some(bytes) =
1704 mouse_button_report(point, e.button, e.modifiers, false, self.last_content.mode)
1705 {
1706 self.pty_tx.notify(bytes);
1707 }
1708 } else {
1709 if e.button == MouseButton::Left && setting.copy_on_select {
1710 self.copy(Some(true));
1711 }
1712
1713 //Hyperlinks
1714 if self.selection_phase == SelectionPhase::Ended {
1715 let mouse_cell_index =
1716 content_index_for_mouse(position, &self.last_content.terminal_bounds);
1717 if let Some(link) = self.last_content.cells[mouse_cell_index].hyperlink() {
1718 cx.open_url(link.uri());
1719 } else if e.modifiers.secondary() {
1720 self.events
1721 .push_back(InternalEvent::FindHyperlink(position, true));
1722 }
1723 }
1724 }
1725
1726 self.selection_phase = SelectionPhase::Ended;
1727 self.last_mouse = None;
1728 }
1729
1730 ///Scroll the terminal
1731 pub fn scroll_wheel(&mut self, e: &ScrollWheelEvent) {
1732 let mouse_mode = self.mouse_mode(e.shift);
1733
1734 if let Some(scroll_lines) = self.determine_scroll_lines(e, mouse_mode) {
1735 if mouse_mode {
1736 let point = grid_point(
1737 e.position - self.last_content.terminal_bounds.bounds.origin,
1738 self.last_content.terminal_bounds,
1739 self.last_content.display_offset,
1740 );
1741
1742 if let Some(scrolls) = scroll_report(point, scroll_lines, e, self.last_content.mode)
1743 {
1744 for scroll in scrolls {
1745 self.pty_tx.notify(scroll);
1746 }
1747 };
1748 } else if self
1749 .last_content
1750 .mode
1751 .contains(TermMode::ALT_SCREEN | TermMode::ALTERNATE_SCROLL)
1752 && !e.shift
1753 {
1754 self.pty_tx.notify(alt_scroll(scroll_lines))
1755 } else if scroll_lines != 0 {
1756 let scroll = AlacScroll::Delta(scroll_lines);
1757
1758 self.events.push_back(InternalEvent::Scroll(scroll));
1759 }
1760 }
1761 }
1762
1763 fn refresh_hovered_word(&mut self, window: &Window) {
1764 self.word_from_position(window.mouse_position());
1765 }
1766
1767 fn determine_scroll_lines(&mut self, e: &ScrollWheelEvent, mouse_mode: bool) -> Option<i32> {
1768 let scroll_multiplier = if mouse_mode { 1. } else { SCROLL_MULTIPLIER };
1769 let line_height = self.last_content.terminal_bounds.line_height;
1770 match e.touch_phase {
1771 /* Reset scroll state on started */
1772 TouchPhase::Started => {
1773 self.scroll_px = px(0.);
1774 None
1775 }
1776 /* Calculate the appropriate scroll lines */
1777 TouchPhase::Moved => {
1778 let old_offset = (self.scroll_px / line_height) as i32;
1779
1780 self.scroll_px += e.delta.pixel_delta(line_height).y * scroll_multiplier;
1781
1782 let new_offset = (self.scroll_px / line_height) as i32;
1783
1784 // Whenever we hit the edges, reset our stored scroll to 0
1785 // so we can respond to changes in direction quickly
1786 self.scroll_px %= self.last_content.terminal_bounds.height();
1787
1788 Some(new_offset - old_offset)
1789 }
1790 TouchPhase::Ended => None,
1791 }
1792 }
1793
1794 pub fn find_matches(
1795 &self,
1796 mut searcher: RegexSearch,
1797 cx: &Context<Self>,
1798 ) -> Task<Vec<RangeInclusive<AlacPoint>>> {
1799 let term = self.term.clone();
1800 cx.background_spawn(async move {
1801 let term = term.lock();
1802
1803 all_search_matches(&term, &mut searcher).collect()
1804 })
1805 }
1806
1807 pub fn working_directory(&self) -> Option<PathBuf> {
1808 if self.is_ssh_terminal {
1809 // We can't yet reliably detect the working directory of a shell on the
1810 // SSH host. Until we can do that, it doesn't make sense to display
1811 // the working directory on the client and persist that.
1812 None
1813 } else {
1814 self.client_side_working_directory()
1815 }
1816 }
1817
1818 /// Returns the working directory of the process that's connected to the PTY.
1819 /// That means it returns the working directory of the local shell or program
1820 /// that's running inside the terminal.
1821 ///
1822 /// This does *not* return the working directory of the shell that runs on the
1823 /// remote host, in case Zed is connected to a remote host.
1824 fn client_side_working_directory(&self) -> Option<PathBuf> {
1825 self.pty_info
1826 .current
1827 .as_ref()
1828 .map(|process| process.cwd.clone())
1829 }
1830
1831 pub fn title(&self, truncate: bool) -> String {
1832 const MAX_CHARS: usize = 25;
1833 match &self.task {
1834 Some(task_state) => {
1835 if truncate {
1836 truncate_and_trailoff(&task_state.spawned_task.label, MAX_CHARS)
1837 } else {
1838 task_state.spawned_task.full_label.clone()
1839 }
1840 }
1841 None => self
1842 .title_override
1843 .as_ref()
1844 .map(|title_override| title_override.to_string())
1845 .unwrap_or_else(|| {
1846 self.pty_info
1847 .current
1848 .as_ref()
1849 .map(|fpi| {
1850 let process_file = fpi
1851 .cwd
1852 .file_name()
1853 .map(|name| name.to_string_lossy().to_string())
1854 .unwrap_or_default();
1855
1856 let argv = fpi.argv.as_slice();
1857 let process_name = format!(
1858 "{}{}",
1859 fpi.name,
1860 if !argv.is_empty() {
1861 format!(" {}", (argv[1..]).join(" "))
1862 } else {
1863 "".to_string()
1864 }
1865 );
1866 let (process_file, process_name) = if truncate {
1867 (
1868 truncate_and_trailoff(&process_file, MAX_CHARS),
1869 truncate_and_trailoff(&process_name, MAX_CHARS),
1870 )
1871 } else {
1872 (process_file, process_name)
1873 };
1874 format!("{process_file} — {process_name}")
1875 })
1876 .unwrap_or_else(|| "Terminal".to_string())
1877 }),
1878 }
1879 }
1880
1881 pub fn kill_active_task(&mut self) {
1882 if let Some(task) = self.task()
1883 && task.status == TaskStatus::Running
1884 {
1885 self.pty_info.kill_current_process();
1886 }
1887 }
1888
1889 pub fn task(&self) -> Option<&TaskState> {
1890 self.task.as_ref()
1891 }
1892
1893 pub fn wait_for_completed_task(&self, cx: &App) -> Task<Option<ExitStatus>> {
1894 if let Some(task) = self.task() {
1895 if task.status == TaskStatus::Running {
1896 let completion_receiver = task.completion_rx.clone();
1897 return cx.spawn(async move |_| completion_receiver.recv().await.ok().flatten());
1898 } else if let Ok(status) = task.completion_rx.try_recv() {
1899 return Task::ready(status);
1900 }
1901 }
1902 Task::ready(None)
1903 }
1904
1905 fn register_task_finished(&mut self, error_code: Option<i32>, cx: &mut Context<Terminal>) {
1906 let e: Option<ExitStatus> = error_code.map(|code| {
1907 #[cfg(unix)]
1908 {
1909 std::os::unix::process::ExitStatusExt::from_raw(code)
1910 }
1911 #[cfg(windows)]
1912 {
1913 std::os::windows::process::ExitStatusExt::from_raw(code as u32)
1914 }
1915 });
1916
1917 if let Some(tx) = &self.completion_tx {
1918 tx.try_send(e).ok();
1919 }
1920 if let Some(e) = e {
1921 self.child_exited = Some(e);
1922 }
1923 let task = match &mut self.task {
1924 Some(task) => task,
1925 None => {
1926 if self.child_exited.is_none_or(|e| e.code() == Some(0)) {
1927 cx.emit(Event::CloseTerminal);
1928 }
1929 return;
1930 }
1931 };
1932 if task.status != TaskStatus::Running {
1933 return;
1934 }
1935 match error_code {
1936 Some(error_code) => {
1937 task.status.register_task_exit(error_code);
1938 }
1939 None => {
1940 task.status.register_terminal_exit();
1941 }
1942 };
1943
1944 let (finished_successfully, task_line, command_line) = task_summary(task, error_code);
1945 let mut lines_to_show = Vec::new();
1946 if task.spawned_task.show_summary {
1947 lines_to_show.push(task_line.as_str());
1948 }
1949 if task.spawned_task.show_command {
1950 lines_to_show.push(command_line.as_str());
1951 }
1952
1953 if !lines_to_show.is_empty() {
1954 // SAFETY: the invocation happens on non `TaskStatus::Running` tasks, once,
1955 // after either `AlacTermEvent::Exit` or `AlacTermEvent::ChildExit` events that are spawned
1956 // when Zed task finishes and no more output is made.
1957 // After the task summary is output once, no more text is appended to the terminal.
1958 unsafe { append_text_to_term(&mut self.term.lock(), &lines_to_show) };
1959 }
1960
1961 match task.spawned_task.hide {
1962 HideStrategy::Never => {}
1963 HideStrategy::Always => {
1964 cx.emit(Event::CloseTerminal);
1965 }
1966 HideStrategy::OnSuccess => {
1967 if finished_successfully {
1968 cx.emit(Event::CloseTerminal);
1969 }
1970 }
1971 }
1972 }
1973
1974 pub fn vi_mode_enabled(&self) -> bool {
1975 self.vi_mode_enabled
1976 }
1977
1978 pub fn clone_builder(
1979 &self,
1980 cx: &App,
1981 cwd: impl FnOnce() -> Option<PathBuf>,
1982 ) -> Result<TerminalBuilder> {
1983 let working_directory = self.working_directory().or_else(cwd);
1984 TerminalBuilder::new(
1985 working_directory,
1986 None,
1987 self.template.shell.clone(),
1988 self.template.env.clone(),
1989 self.template.cursor_shape,
1990 self.template.alternate_scroll,
1991 self.template.max_scroll_history_lines,
1992 self.is_ssh_terminal,
1993 self.template.window_id,
1994 None,
1995 cx,
1996 self.activation_script.clone(),
1997 )
1998 }
1999}
2000
2001// Helper function to convert a grid row to a string
2002pub fn row_to_string(row: &Row<Cell>) -> String {
2003 row[..Column(row.len())]
2004 .iter()
2005 .map(|cell| cell.c)
2006 .collect::<String>()
2007}
2008
2009const TASK_DELIMITER: &str = "⏵ ";
2010fn task_summary(task: &TaskState, error_code: Option<i32>) -> (bool, String, String) {
2011 let escaped_full_label = task
2012 .spawned_task
2013 .full_label
2014 .replace("\r\n", "\r")
2015 .replace('\n', "\r");
2016 let (success, task_line) = match error_code {
2017 Some(0) => (
2018 true,
2019 format!("{TASK_DELIMITER}Task `{escaped_full_label}` finished successfully"),
2020 ),
2021 Some(error_code) => (
2022 false,
2023 format!(
2024 "{TASK_DELIMITER}Task `{escaped_full_label}` finished with non-zero error code: {error_code}"
2025 ),
2026 ),
2027 None => (
2028 false,
2029 format!("{TASK_DELIMITER}Task `{escaped_full_label}` finished"),
2030 ),
2031 };
2032 let escaped_command_label = task
2033 .spawned_task
2034 .command_label
2035 .replace("\r\n", "\r")
2036 .replace('\n', "\r");
2037 let command_line = format!("{TASK_DELIMITER}Command: {escaped_command_label}");
2038 (success, task_line, command_line)
2039}
2040
2041/// Appends a stringified task summary to the terminal, after its output.
2042///
2043/// SAFETY: This function should only be called after terminal's PTY is no longer alive.
2044/// New text being added to the terminal here, uses "less public" APIs,
2045/// which are not maintaining the entire terminal state intact.
2046///
2047///
2048/// The library
2049///
2050/// * does not increment inner grid cursor's _lines_ on `input` calls
2051/// (but displaying the lines correctly and incrementing cursor's columns)
2052///
2053/// * ignores `\n` and \r` character input, requiring the `newline` call instead
2054///
2055/// * does not alter grid state after `newline` call
2056/// so its `bottommost_line` is always the same additions, and
2057/// the cursor's `point` is not updated to the new line and column values
2058///
2059/// * ??? there could be more consequences, and any further "proper" streaming from the PTY might bug and/or panic.
2060/// Still, subsequent `append_text_to_term` invocations are possible and display the contents correctly.
2061///
2062/// Despite the quirks, this is the simplest approach to appending text to the terminal: its alternative, `grid_mut` manipulations,
2063/// do not properly set the scrolling state and display odd text after appending; also those manipulations are more tedious and error-prone.
2064/// The function achieves proper display and scrolling capabilities, at a cost of grid state not properly synchronized.
2065/// This is enough for printing moderately-sized texts like task summaries, but might break or perform poorly for larger texts.
2066unsafe fn append_text_to_term(term: &mut Term<ZedListener>, text_lines: &[&str]) {
2067 term.newline();
2068 term.grid_mut().cursor.point.column = Column(0);
2069 for line in text_lines {
2070 for c in line.chars() {
2071 term.input(c);
2072 }
2073 term.newline();
2074 term.grid_mut().cursor.point.column = Column(0);
2075 }
2076}
2077
2078impl Drop for Terminal {
2079 fn drop(&mut self) {
2080 self.pty_tx.0.send(Msg::Shutdown).ok();
2081 }
2082}
2083
2084impl EventEmitter<Event> for Terminal {}
2085
2086fn make_selection(range: &RangeInclusive<AlacPoint>) -> Selection {
2087 let mut selection = Selection::new(SelectionType::Simple, *range.start(), AlacDirection::Left);
2088 selection.update(*range.end(), AlacDirection::Right);
2089 selection
2090}
2091
2092fn all_search_matches<'a, T>(
2093 term: &'a Term<T>,
2094 regex: &'a mut RegexSearch,
2095) -> impl Iterator<Item = Match> + 'a {
2096 let start = AlacPoint::new(term.grid().topmost_line(), Column(0));
2097 let end = AlacPoint::new(term.grid().bottommost_line(), term.grid().last_column());
2098 RegexIter::new(start, end, AlacDirection::Right, term, regex)
2099}
2100
2101fn content_index_for_mouse(pos: Point<Pixels>, terminal_bounds: &TerminalBounds) -> usize {
2102 let col = (pos.x / terminal_bounds.cell_width()).round() as usize;
2103 let clamped_col = min(col, terminal_bounds.columns() - 1);
2104 let row = (pos.y / terminal_bounds.line_height()).round() as usize;
2105 let clamped_row = min(row, terminal_bounds.screen_lines() - 1);
2106 clamped_row * terminal_bounds.columns() + clamped_col
2107}
2108
2109/// Converts an 8 bit ANSI color to its GPUI equivalent.
2110/// Accepts `usize` for compatibility with the `alacritty::Colors` interface,
2111/// Other than that use case, should only be called with values in the `[0,255]` range
2112pub fn get_color_at_index(index: usize, theme: &Theme) -> Hsla {
2113 let colors = theme.colors();
2114
2115 match index {
2116 // 0-15 are the same as the named colors above
2117 0 => colors.terminal_ansi_black,
2118 1 => colors.terminal_ansi_red,
2119 2 => colors.terminal_ansi_green,
2120 3 => colors.terminal_ansi_yellow,
2121 4 => colors.terminal_ansi_blue,
2122 5 => colors.terminal_ansi_magenta,
2123 6 => colors.terminal_ansi_cyan,
2124 7 => colors.terminal_ansi_white,
2125 8 => colors.terminal_ansi_bright_black,
2126 9 => colors.terminal_ansi_bright_red,
2127 10 => colors.terminal_ansi_bright_green,
2128 11 => colors.terminal_ansi_bright_yellow,
2129 12 => colors.terminal_ansi_bright_blue,
2130 13 => colors.terminal_ansi_bright_magenta,
2131 14 => colors.terminal_ansi_bright_cyan,
2132 15 => colors.terminal_ansi_bright_white,
2133 // 16-231 are a 6x6x6 RGB color cube, mapped to 0-255 using steps defined by XTerm.
2134 // See: https://github.com/xterm-x11/xterm-snapshots/blob/master/256colres.pl
2135 16..=231 => {
2136 let (r, g, b) = rgb_for_index(index as u8);
2137 rgba_color(
2138 if r == 0 { 0 } else { r * 40 + 55 },
2139 if g == 0 { 0 } else { g * 40 + 55 },
2140 if b == 0 { 0 } else { b * 40 + 55 },
2141 )
2142 }
2143 // 232-255 are a 24-step grayscale ramp from (8, 8, 8) to (238, 238, 238).
2144 232..=255 => {
2145 let i = index as u8 - 232; // Align index to 0..24
2146 let value = i * 10 + 8;
2147 rgba_color(value, value, value)
2148 }
2149 // For compatibility with the alacritty::Colors interface
2150 // See: https://github.com/alacritty/alacritty/blob/master/alacritty_terminal/src/term/color.rs
2151 256 => colors.terminal_foreground,
2152 257 => colors.terminal_background,
2153 258 => theme.players().local().cursor,
2154 259 => colors.terminal_ansi_dim_black,
2155 260 => colors.terminal_ansi_dim_red,
2156 261 => colors.terminal_ansi_dim_green,
2157 262 => colors.terminal_ansi_dim_yellow,
2158 263 => colors.terminal_ansi_dim_blue,
2159 264 => colors.terminal_ansi_dim_magenta,
2160 265 => colors.terminal_ansi_dim_cyan,
2161 266 => colors.terminal_ansi_dim_white,
2162 267 => colors.terminal_bright_foreground,
2163 268 => colors.terminal_ansi_black, // 'Dim Background', non-standard color
2164
2165 _ => black(),
2166 }
2167}
2168
2169/// Generates the RGB channels in [0, 5] for a given index into the 6x6x6 ANSI color cube.
2170///
2171/// See: [8 bit ANSI color](https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit).
2172///
2173/// Wikipedia gives a formula for calculating the index for a given color:
2174///
2175/// ```text
2176/// index = 16 + 36 × r + 6 × g + b (0 ≤ r, g, b ≤ 5)
2177/// ```
2178///
2179/// This function does the reverse, calculating the `r`, `g`, and `b` components from a given index.
2180fn rgb_for_index(i: u8) -> (u8, u8, u8) {
2181 debug_assert!((16..=231).contains(&i));
2182 let i = i - 16;
2183 let r = (i - (i % 36)) / 36;
2184 let g = ((i % 36) - (i % 6)) / 6;
2185 let b = (i % 36) % 6;
2186 (r, g, b)
2187}
2188
2189pub fn rgba_color(r: u8, g: u8, b: u8) -> Hsla {
2190 Rgba {
2191 r: (r as f32 / 255.),
2192 g: (g as f32 / 255.),
2193 b: (b as f32 / 255.),
2194 a: 1.,
2195 }
2196 .into()
2197}
2198
2199#[cfg(test)]
2200mod tests {
2201 use super::*;
2202 use crate::{
2203 IndexedCell, TerminalBounds, TerminalBuilder, TerminalContent, content_index_for_mouse,
2204 rgb_for_index,
2205 };
2206 use alacritty_terminal::{
2207 index::{Column, Line, Point as AlacPoint},
2208 term::cell::Cell,
2209 };
2210 use collections::HashMap;
2211 use gpui::{Pixels, Point, TestAppContext, bounds, point, size};
2212 use rand::{Rng, distr, rngs::ThreadRng};
2213 use task::ShellBuilder;
2214
2215 #[gpui::test]
2216 async fn test_basic_terminal(cx: &mut TestAppContext) {
2217 cx.executor().allow_parking();
2218
2219 let (completion_tx, completion_rx) = smol::channel::unbounded();
2220 let (program, args) = ShellBuilder::new(None, &Shell::System)
2221 .build(Some("echo".to_owned()), &["hello".to_owned()]);
2222 let terminal = cx.new(|cx| {
2223 TerminalBuilder::new(
2224 None,
2225 None,
2226 task::Shell::WithArguments {
2227 program,
2228 args,
2229 title_override: None,
2230 },
2231 HashMap::default(),
2232 CursorShape::default(),
2233 AlternateScroll::On,
2234 None,
2235 false,
2236 0,
2237 Some(completion_tx),
2238 cx,
2239 vec![],
2240 )
2241 .unwrap()
2242 .subscribe(cx)
2243 });
2244 assert_eq!(
2245 completion_rx.recv().await.unwrap(),
2246 Some(ExitStatus::default())
2247 );
2248 assert_eq!(
2249 terminal.update(cx, |term, _| term.get_content()).trim(),
2250 "hello"
2251 );
2252 }
2253
2254 #[test]
2255 fn test_rgb_for_index() {
2256 // Test every possible value in the color cube.
2257 for i in 16..=231 {
2258 let (r, g, b) = rgb_for_index(i);
2259 assert_eq!(i, 16 + 36 * r + 6 * g + b);
2260 }
2261 }
2262
2263 #[test]
2264 fn test_mouse_to_cell_test() {
2265 let mut rng = rand::rng();
2266 const ITERATIONS: usize = 10;
2267 const PRECISION: usize = 1000;
2268
2269 for _ in 0..ITERATIONS {
2270 let viewport_cells = rng.random_range(15..20);
2271 let cell_size =
2272 rng.random_range(5 * PRECISION..20 * PRECISION) as f32 / PRECISION as f32;
2273
2274 let size = crate::TerminalBounds {
2275 cell_width: Pixels::from(cell_size),
2276 line_height: Pixels::from(cell_size),
2277 bounds: bounds(
2278 Point::default(),
2279 size(
2280 Pixels::from(cell_size * (viewport_cells as f32)),
2281 Pixels::from(cell_size * (viewport_cells as f32)),
2282 ),
2283 ),
2284 };
2285
2286 let cells = get_cells(size, &mut rng);
2287 let content = convert_cells_to_content(size, &cells);
2288
2289 for row in 0..(viewport_cells - 1) {
2290 let row = row as usize;
2291 for col in 0..(viewport_cells - 1) {
2292 let col = col as usize;
2293
2294 let row_offset = rng.random_range(0..PRECISION) as f32 / PRECISION as f32;
2295 let col_offset = rng.random_range(0..PRECISION) as f32 / PRECISION as f32;
2296
2297 let mouse_pos = point(
2298 Pixels::from(col as f32 * cell_size + col_offset),
2299 Pixels::from(row as f32 * cell_size + row_offset),
2300 );
2301
2302 let content_index =
2303 content_index_for_mouse(mouse_pos, &content.terminal_bounds);
2304 let mouse_cell = content.cells[content_index].c;
2305 let real_cell = cells[row][col];
2306
2307 assert_eq!(mouse_cell, real_cell);
2308 }
2309 }
2310 }
2311 }
2312
2313 #[test]
2314 fn test_mouse_to_cell_clamp() {
2315 let mut rng = rand::rng();
2316
2317 let size = crate::TerminalBounds {
2318 cell_width: Pixels::from(10.),
2319 line_height: Pixels::from(10.),
2320 bounds: bounds(
2321 Point::default(),
2322 size(Pixels::from(100.), Pixels::from(100.)),
2323 ),
2324 };
2325
2326 let cells = get_cells(size, &mut rng);
2327 let content = convert_cells_to_content(size, &cells);
2328
2329 assert_eq!(
2330 content.cells[content_index_for_mouse(
2331 point(Pixels::from(-10.), Pixels::from(-10.)),
2332 &content.terminal_bounds,
2333 )]
2334 .c,
2335 cells[0][0]
2336 );
2337 assert_eq!(
2338 content.cells[content_index_for_mouse(
2339 point(Pixels::from(1000.), Pixels::from(1000.)),
2340 &content.terminal_bounds,
2341 )]
2342 .c,
2343 cells[9][9]
2344 );
2345 }
2346
2347 fn get_cells(size: TerminalBounds, rng: &mut ThreadRng) -> Vec<Vec<char>> {
2348 let mut cells = Vec::new();
2349
2350 for _ in 0..((size.height() / size.line_height()) as usize) {
2351 let mut row_vec = Vec::new();
2352 for _ in 0..((size.width() / size.cell_width()) as usize) {
2353 let cell_char = rng.sample(distr::Alphanumeric) as char;
2354 row_vec.push(cell_char)
2355 }
2356 cells.push(row_vec)
2357 }
2358
2359 cells
2360 }
2361
2362 fn convert_cells_to_content(
2363 terminal_bounds: TerminalBounds,
2364 cells: &[Vec<char>],
2365 ) -> TerminalContent {
2366 let mut ic = Vec::new();
2367
2368 for (index, row) in cells.iter().enumerate() {
2369 for (cell_index, cell_char) in row.iter().enumerate() {
2370 ic.push(IndexedCell {
2371 point: AlacPoint::new(Line(index as i32), Column(cell_index)),
2372 cell: Cell {
2373 c: *cell_char,
2374 ..Default::default()
2375 },
2376 });
2377 }
2378 }
2379
2380 TerminalContent {
2381 cells: ic,
2382 terminal_bounds,
2383 ..Default::default()
2384 }
2385 }
2386}