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