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