1pub mod mappings;
2
3pub use alacritty_terminal;
4
5mod pty_info;
6pub mod terminal_settings;
7
8use alacritty_terminal::{
9 event::{Event as AlacTermEvent, EventListener, Notify, WindowSize},
10 event_loop::{EventLoop, Msg, Notifier},
11 grid::{Dimensions, Scroll as AlacScroll},
12 index::{Boundary, Column, Direction as AlacDirection, Line, Point as AlacPoint},
13 selection::{Selection, SelectionRange, SelectionType},
14 sync::FairMutex,
15 term::{
16 cell::Cell,
17 search::{Match, RegexIter, RegexSearch},
18 Config, RenderableCursor, TermMode,
19 },
20 tty::{self, setup_env},
21 vte::ansi::{ClearMode, Handler, NamedPrivateMode, PrivateMode, Rgb},
22 Term,
23};
24use anyhow::{bail, Result};
25
26use futures::{
27 channel::mpsc::{unbounded, UnboundedReceiver, UnboundedSender},
28 FutureExt,
29};
30
31use mappings::mouse::{
32 alt_scroll, grid_point, grid_point_and_side, mouse_button_report, mouse_moved_report,
33 scroll_report,
34};
35
36use collections::{HashMap, VecDeque};
37use futures::StreamExt;
38use pty_info::PtyProcessInfo;
39use serde::{Deserialize, Serialize};
40use settings::Settings;
41use smol::channel::{Receiver, Sender};
42use task::{HideStrategy, Shell, TaskId};
43use terminal_settings::{AlternateScroll, TerminalBlink, TerminalSettings};
44use theme::{ActiveTheme, Theme};
45use util::truncate_and_trailoff;
46
47use std::{
48 cmp::{self, min},
49 fmt::Display,
50 ops::{Deref, Index, RangeInclusive},
51 path::PathBuf,
52 sync::Arc,
53 time::Duration,
54};
55use thiserror::Error;
56
57use gpui::{
58 actions, black, px, AnyWindowHandle, AppContext, Bounds, ClipboardItem, EventEmitter, Hsla,
59 Keystroke, ModelContext, Modifiers, MouseButton, MouseDownEvent, MouseMoveEvent, MouseUpEvent,
60 Pixels, Point, Rgba, ScrollWheelEvent, Size, Task, TouchPhase,
61};
62
63use crate::mappings::{colors::to_alac_rgb, keys::to_esc_str};
64
65actions!(
66 terminal,
67 [
68 Clear,
69 Copy,
70 Paste,
71 ShowCharacterPalette,
72 SearchTest,
73 ScrollLineUp,
74 ScrollLineDown,
75 ScrollPageUp,
76 ScrollPageDown,
77 ScrollToTop,
78 ScrollToBottom,
79 ]
80);
81
82///Scrolling is unbearably sluggish by default. Alacritty supports a configurable
83///Scroll multiplier that is set to 3 by default. This will be removed when I
84///Implement scroll bars.
85#[cfg(target_os = "macos")]
86const SCROLL_MULTIPLIER: f32 = 4.;
87#[cfg(not(target_os = "macos"))]
88const SCROLL_MULTIPLIER: f32 = 1.;
89const MAX_SEARCH_LINES: usize = 100;
90const DEBUG_TERMINAL_WIDTH: Pixels = px(500.);
91const DEBUG_TERMINAL_HEIGHT: Pixels = px(30.);
92const DEBUG_CELL_WIDTH: Pixels = px(5.);
93const DEBUG_LINE_HEIGHT: Pixels = px(5.);
94
95///Upward flowing events, for changing the title and such
96#[derive(Clone, Debug)]
97pub enum Event {
98 TitleChanged,
99 BreadcrumbsChanged,
100 CloseTerminal,
101 Bell,
102 Wakeup,
103 BlinkChanged,
104 SelectionsChanged,
105 NewNavigationTarget(Option<MaybeNavigationTarget>),
106 Open(MaybeNavigationTarget),
107}
108
109#[derive(Clone, Debug)]
110pub struct PathLikeTarget {
111 /// File system path, absolute or relative, existing or not.
112 /// Might have line and column number(s) attached as `file.rs:1:23`
113 pub maybe_path: String,
114 /// Current working directory of the terminal
115 pub terminal_dir: Option<PathBuf>,
116}
117
118/// A string inside terminal, potentially useful as a URI that can be opened.
119#[derive(Clone, Debug)]
120pub enum MaybeNavigationTarget {
121 /// HTTP, git, etc. string determined by the [`URL_REGEX`] regex.
122 Url(String),
123 /// File system path, absolute or relative, existing or not.
124 /// Might have line and column number(s) attached as `file.rs:1:23`
125 PathLike(PathLikeTarget),
126}
127
128#[derive(Clone)]
129enum InternalEvent {
130 ColorRequest(usize, Arc<dyn Fn(Rgb) -> String + Sync + Send + 'static>),
131 Resize(TerminalSize),
132 Clear,
133 // FocusNextMatch,
134 Scroll(AlacScroll),
135 ScrollToAlacPoint(AlacPoint),
136 SetSelection(Option<(Selection, AlacPoint)>),
137 UpdateSelection(Point<Pixels>),
138 // Adjusted mouse position, should open
139 FindHyperlink(Point<Pixels>, bool),
140 Copy,
141}
142
143///A translation struct for Alacritty to communicate with us from their event loop
144#[derive(Clone)]
145pub struct ZedListener(pub UnboundedSender<AlacTermEvent>);
146
147impl EventListener for ZedListener {
148 fn send_event(&self, event: AlacTermEvent) {
149 self.0.unbounded_send(event).ok();
150 }
151}
152
153pub fn init(cx: &mut AppContext) {
154 TerminalSettings::register(cx);
155}
156
157#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize, Deserialize)]
158pub struct TerminalSize {
159 pub cell_width: Pixels,
160 pub line_height: Pixels,
161 pub size: Size<Pixels>,
162}
163
164impl TerminalSize {
165 pub fn new(line_height: Pixels, cell_width: Pixels, size: Size<Pixels>) -> Self {
166 TerminalSize {
167 cell_width,
168 line_height,
169 size,
170 }
171 }
172
173 pub fn num_lines(&self) -> usize {
174 (self.size.height / self.line_height).floor() as usize
175 }
176
177 pub fn num_columns(&self) -> usize {
178 (self.size.width / self.cell_width).floor() as usize
179 }
180
181 pub fn height(&self) -> Pixels {
182 self.size.height
183 }
184
185 pub fn width(&self) -> Pixels {
186 self.size.width
187 }
188
189 pub fn cell_width(&self) -> Pixels {
190 self.cell_width
191 }
192
193 pub fn line_height(&self) -> Pixels {
194 self.line_height
195 }
196}
197
198impl Default for TerminalSize {
199 fn default() -> Self {
200 TerminalSize::new(
201 DEBUG_LINE_HEIGHT,
202 DEBUG_CELL_WIDTH,
203 Size {
204 width: DEBUG_TERMINAL_WIDTH,
205 height: DEBUG_TERMINAL_HEIGHT,
206 },
207 )
208 }
209}
210
211impl From<TerminalSize> for WindowSize {
212 fn from(val: TerminalSize) -> Self {
213 WindowSize {
214 num_lines: val.num_lines() as u16,
215 num_cols: val.num_columns() as u16,
216 cell_width: f32::from(val.cell_width()) as u16,
217 cell_height: f32::from(val.line_height()) as u16,
218 }
219 }
220}
221
222impl Dimensions for TerminalSize {
223 /// Note: this is supposed to be for the back buffer's length,
224 /// but we exclusively use it to resize the terminal, which does not
225 /// use this method. We still have to implement it for the trait though,
226 /// hence, this comment.
227 fn total_lines(&self) -> usize {
228 self.screen_lines()
229 }
230
231 fn screen_lines(&self) -> usize {
232 self.num_lines()
233 }
234
235 fn columns(&self) -> usize {
236 self.num_columns()
237 }
238}
239
240#[derive(Error, Debug)]
241pub struct TerminalError {
242 pub directory: Option<PathBuf>,
243 pub shell: Shell,
244 pub source: std::io::Error,
245}
246
247impl TerminalError {
248 pub fn fmt_directory(&self) -> String {
249 self.directory
250 .clone()
251 .map(|path| {
252 match path
253 .into_os_string()
254 .into_string()
255 .map_err(|os_str| format!("<non-utf8 path> {}", os_str.to_string_lossy()))
256 {
257 Ok(s) => s,
258 Err(s) => s,
259 }
260 })
261 .unwrap_or_else(|| {
262 let default_dir =
263 dirs::home_dir().map(|buf| buf.into_os_string().to_string_lossy().to_string());
264 match default_dir {
265 Some(dir) => format!("<none specified, using home directory> {}", dir),
266 None => "<none specified, could not find home directory>".to_string(),
267 }
268 })
269 }
270
271 pub fn shell_to_string(&self) -> String {
272 match &self.shell {
273 Shell::System => "<system shell>".to_string(),
274 Shell::Program(p) => p.to_string(),
275 Shell::WithArguments { program, args } => format!("{} {}", program, args.join(" ")),
276 }
277 }
278
279 pub fn fmt_shell(&self) -> String {
280 match &self.shell {
281 Shell::System => "<system defined shell>".to_string(),
282 Shell::Program(s) => s.to_string(),
283 Shell::WithArguments { program, args } => format!("{} {}", program, args.join(" ")),
284 }
285 }
286}
287
288impl Display for TerminalError {
289 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
290 let dir_string: String = self.fmt_directory();
291 let shell = self.fmt_shell();
292
293 write!(
294 f,
295 "Working directory: {} Shell command: `{}`, IOError: {}",
296 dir_string, shell, self.source
297 )
298 }
299}
300
301// https://github.com/alacritty/alacritty/blob/cb3a79dbf6472740daca8440d5166c1d4af5029e/extra/man/alacritty.5.scd?plain=1#L207-L213
302const DEFAULT_SCROLL_HISTORY_LINES: usize = 10_000;
303const MAX_SCROLL_HISTORY_LINES: usize = 100_000;
304
305pub struct TerminalBuilder {
306 terminal: Terminal,
307 events_rx: UnboundedReceiver<AlacTermEvent>,
308}
309
310impl TerminalBuilder {
311 #[allow(clippy::too_many_arguments)]
312 pub fn new(
313 working_directory: Option<PathBuf>,
314 task: Option<TaskState>,
315 shell: Shell,
316 mut env: HashMap<String, String>,
317 blink_settings: Option<TerminalBlink>,
318 alternate_scroll: AlternateScroll,
319 max_scroll_history_lines: Option<usize>,
320 window: AnyWindowHandle,
321 completion_tx: Sender<()>,
322 cx: &mut AppContext,
323 ) -> Result<TerminalBuilder> {
324 // TODO: Properly set the current locale,
325 env.entry("LC_ALL".to_string())
326 .or_insert_with(|| "en_US.UTF-8".to_string());
327
328 env.insert("ZED_TERM".to_string(), "true".to_string());
329 env.insert("TERM_PROGRAM".to_string(), "zed".to_string());
330 env.insert(
331 "TERM_PROGRAM_VERSION".to_string(),
332 release_channel::AppVersion::global(cx).to_string(),
333 );
334
335 let pty_options = {
336 let alac_shell = match shell.clone() {
337 Shell::System => None,
338 Shell::Program(program) => {
339 Some(alacritty_terminal::tty::Shell::new(program, Vec::new()))
340 }
341 Shell::WithArguments { program, args } => {
342 Some(alacritty_terminal::tty::Shell::new(program, args))
343 }
344 };
345
346 alacritty_terminal::tty::Options {
347 shell: alac_shell,
348 working_directory: working_directory.clone(),
349 #[cfg(target_os = "linux")]
350 hold: !matches!(shell.clone(), Shell::System),
351 // with hold: true, macOS gets tasks stuck on ctrl-c interrupts periodically
352 #[cfg(not(target_os = "linux"))]
353 hold: false,
354 env: env.into_iter().collect(),
355 }
356 };
357
358 // Setup Alacritty's env
359 setup_env();
360
361 let scrolling_history = if task.is_some() {
362 // Tasks like `cargo build --all` may produce a lot of output, ergo allow maximum scrolling.
363 // After the task finishes, we do not allow appending to that terminal, so small tasks output should not
364 // cause excessive memory usage over time.
365 MAX_SCROLL_HISTORY_LINES
366 } else {
367 max_scroll_history_lines
368 .unwrap_or(DEFAULT_SCROLL_HISTORY_LINES)
369 .min(MAX_SCROLL_HISTORY_LINES)
370 };
371 let config = Config {
372 scrolling_history,
373 ..Config::default()
374 };
375
376 //Spawn a task so the Alacritty EventLoop can communicate with us in a view context
377 //TODO: Remove with a bounded sender which can be dispatched on &self
378 let (events_tx, events_rx) = unbounded();
379 //Set up the terminal...
380 let mut term = Term::new(
381 config,
382 &TerminalSize::default(),
383 ZedListener(events_tx.clone()),
384 );
385
386 //Start off blinking if we need to
387 if let Some(TerminalBlink::On) = blink_settings {
388 term.set_private_mode(PrivateMode::Named(NamedPrivateMode::BlinkingCursor));
389 }
390
391 //Alacritty defaults to alternate scrolling being on, so we just need to turn it off.
392 if let AlternateScroll::Off = alternate_scroll {
393 term.unset_private_mode(PrivateMode::Named(NamedPrivateMode::AlternateScroll));
394 }
395
396 let term = Arc::new(FairMutex::new(term));
397
398 //Setup the pty...
399 let pty = match tty::new(
400 &pty_options,
401 TerminalSize::default().into(),
402 window.window_id().as_u64(),
403 ) {
404 Ok(pty) => pty,
405 Err(error) => {
406 bail!(TerminalError {
407 directory: working_directory,
408 shell,
409 source: error,
410 });
411 }
412 };
413
414 let pty_info = PtyProcessInfo::new(&pty);
415
416 //And connect them together
417 let event_loop = EventLoop::new(
418 term.clone(),
419 ZedListener(events_tx.clone()),
420 pty,
421 pty_options.hold,
422 false,
423 )?;
424
425 //Kick things off
426 let pty_tx = event_loop.channel();
427 let _io_thread = event_loop.spawn(); // DANGER
428
429 let url_regex = RegexSearch::new(r#"(ipfs:|ipns:|magnet:|mailto:|gemini://|gopher://|https://|http://|news:|file://|git://|ssh:|ftp://)[^\u{0000}-\u{001F}\u{007F}-\u{009F}<>"\s{-}\^⟨⟩`]+"#).unwrap();
430 // Optional suffix matches MSBuild diagnostic suffixes for path parsing in PathLikeWithPosition
431 // https://learn.microsoft.com/en-us/visualstudio/msbuild/msbuild-diagnostic-format-for-tasks
432 let word_regex =
433 RegexSearch::new(r#"[\$\+\w.\[\]:/\\@\-~]+(?:\((?:\d+|\d+,\d+)\))?"#).unwrap();
434
435 let terminal = Terminal {
436 task,
437 pty_tx: Notifier(pty_tx),
438 completion_tx,
439 term,
440 events: VecDeque::with_capacity(10), //Should never get this high.
441 last_content: Default::default(),
442 last_mouse: None,
443 matches: Vec::new(),
444 selection_head: None,
445 pty_info,
446 breadcrumb_text: String::new(),
447 scroll_px: px(0.),
448 last_mouse_position: None,
449 next_link_id: 0,
450 selection_phase: SelectionPhase::Ended,
451 secondary_pressed: false,
452 hovered_word: false,
453 url_regex,
454 word_regex,
455 };
456
457 Ok(TerminalBuilder {
458 terminal,
459 events_rx,
460 })
461 }
462
463 pub fn subscribe(mut self, cx: &mut ModelContext<Terminal>) -> Terminal {
464 //Event loop
465 cx.spawn(|terminal, mut cx| async move {
466 while let Some(event) = self.events_rx.next().await {
467 terminal.update(&mut cx, |terminal, cx| {
468 //Process the first event immediately for lowered latency
469 terminal.process_event(&event, cx);
470 })?;
471
472 'outer: loop {
473 let mut events = Vec::new();
474 let mut timer = cx
475 .background_executor()
476 .timer(Duration::from_millis(4))
477 .fuse();
478 let mut wakeup = false;
479 loop {
480 futures::select_biased! {
481 _ = timer => break,
482 event = self.events_rx.next() => {
483 if let Some(event) = event {
484 if matches!(event, AlacTermEvent::Wakeup) {
485 wakeup = true;
486 } else {
487 events.push(event);
488 }
489
490 if events.len() > 100 {
491 break;
492 }
493 } else {
494 break;
495 }
496 },
497 }
498 }
499
500 if events.is_empty() && !wakeup {
501 smol::future::yield_now().await;
502 break 'outer;
503 }
504
505 terminal.update(&mut cx, |this, cx| {
506 if wakeup {
507 this.process_event(&AlacTermEvent::Wakeup, cx);
508 }
509
510 for event in events {
511 this.process_event(&event, cx);
512 }
513 })?;
514 smol::future::yield_now().await;
515 }
516 }
517
518 anyhow::Ok(())
519 })
520 .detach();
521
522 self.terminal
523 }
524}
525
526#[derive(Debug, Clone, Deserialize, Serialize)]
527pub struct IndexedCell {
528 pub point: AlacPoint,
529 pub cell: Cell,
530}
531
532impl Deref for IndexedCell {
533 type Target = Cell;
534
535 #[inline]
536 fn deref(&self) -> &Cell {
537 &self.cell
538 }
539}
540
541// TODO: Un-pub
542#[derive(Clone)]
543pub struct TerminalContent {
544 pub cells: Vec<IndexedCell>,
545 pub mode: TermMode,
546 pub display_offset: usize,
547 pub selection_text: Option<String>,
548 pub selection: Option<SelectionRange>,
549 pub cursor: RenderableCursor,
550 pub cursor_char: char,
551 pub size: TerminalSize,
552 pub last_hovered_word: Option<HoveredWord>,
553}
554
555#[derive(Clone)]
556pub struct HoveredWord {
557 pub word: String,
558 pub word_match: RangeInclusive<AlacPoint>,
559 pub id: usize,
560}
561
562impl Default for TerminalContent {
563 fn default() -> Self {
564 TerminalContent {
565 cells: Default::default(),
566 mode: Default::default(),
567 display_offset: Default::default(),
568 selection_text: Default::default(),
569 selection: Default::default(),
570 cursor: RenderableCursor {
571 shape: alacritty_terminal::vte::ansi::CursorShape::Block,
572 point: AlacPoint::new(Line(0), Column(0)),
573 },
574 cursor_char: Default::default(),
575 size: Default::default(),
576 last_hovered_word: None,
577 }
578 }
579}
580
581#[derive(PartialEq, Eq)]
582pub enum SelectionPhase {
583 Selecting,
584 Ended,
585}
586
587pub struct Terminal {
588 pty_tx: Notifier,
589 completion_tx: Sender<()>,
590 term: Arc<FairMutex<Term<ZedListener>>>,
591 events: VecDeque<InternalEvent>,
592 /// This is only used for mouse mode cell change detection
593 last_mouse: Option<(AlacPoint, AlacDirection)>,
594 /// This is only used for terminal hovered word checking
595 last_mouse_position: Option<Point<Pixels>>,
596 pub matches: Vec<RangeInclusive<AlacPoint>>,
597 pub last_content: TerminalContent,
598 pub selection_head: Option<AlacPoint>,
599 pub breadcrumb_text: String,
600 pub pty_info: PtyProcessInfo,
601 scroll_px: Pixels,
602 next_link_id: usize,
603 selection_phase: SelectionPhase,
604 secondary_pressed: bool,
605 hovered_word: bool,
606 url_regex: RegexSearch,
607 word_regex: RegexSearch,
608 task: Option<TaskState>,
609}
610
611pub struct TaskState {
612 pub id: TaskId,
613 pub full_label: String,
614 pub label: String,
615 pub command_label: String,
616 pub status: TaskStatus,
617 pub completion_rx: Receiver<()>,
618 pub hide: HideStrategy,
619}
620
621/// A status of the current terminal tab's task.
622#[derive(Debug, Clone, Copy, PartialEq, Eq)]
623pub enum TaskStatus {
624 /// The task had been started, but got cancelled or somehow otherwise it did not
625 /// report its exit code before the terminal event loop was shut down.
626 Unknown,
627 /// The task is started and running currently.
628 Running,
629 /// After the start, the task stopped running and reported its error code back.
630 Completed { success: bool },
631}
632
633impl TaskStatus {
634 fn register_terminal_exit(&mut self) {
635 if self == &Self::Running {
636 *self = Self::Unknown;
637 }
638 }
639
640 fn register_task_exit(&mut self, error_code: i32) {
641 *self = TaskStatus::Completed {
642 success: error_code == 0,
643 };
644 }
645}
646
647impl Terminal {
648 fn process_event(&mut self, event: &AlacTermEvent, cx: &mut ModelContext<Self>) {
649 match event {
650 AlacTermEvent::Title(title) => {
651 self.breadcrumb_text = title.to_string();
652 cx.emit(Event::BreadcrumbsChanged);
653 }
654 AlacTermEvent::ResetTitle => {
655 self.breadcrumb_text = String::new();
656 cx.emit(Event::BreadcrumbsChanged);
657 }
658 AlacTermEvent::ClipboardStore(_, data) => {
659 cx.write_to_clipboard(ClipboardItem::new(data.to_string()))
660 }
661 AlacTermEvent::ClipboardLoad(_, format) => self.write_to_pty(format(
662 &cx.read_from_clipboard()
663 .map(|ci| ci.text().to_string())
664 .unwrap_or_else(|| "".to_string()),
665 )),
666 AlacTermEvent::PtyWrite(out) => self.write_to_pty(out.clone()),
667 AlacTermEvent::TextAreaSizeRequest(format) => {
668 self.write_to_pty(format(self.last_content.size.into()))
669 }
670 AlacTermEvent::CursorBlinkingChange => {
671 cx.emit(Event::BlinkChanged);
672 }
673 AlacTermEvent::Bell => {
674 cx.emit(Event::Bell);
675 }
676 AlacTermEvent::Exit => self.register_task_finished(None, cx),
677 AlacTermEvent::MouseCursorDirty => {
678 //NOOP, Handled in render
679 }
680 AlacTermEvent::Wakeup => {
681 cx.emit(Event::Wakeup);
682
683 if self.pty_info.has_changed() {
684 cx.emit(Event::TitleChanged);
685 }
686 }
687 AlacTermEvent::ColorRequest(idx, fun_ptr) => {
688 self.events
689 .push_back(InternalEvent::ColorRequest(*idx, fun_ptr.clone()));
690 }
691 AlacTermEvent::ChildExit(error_code) => {
692 self.register_task_finished(Some(*error_code), cx);
693 }
694 }
695 }
696
697 pub fn selection_started(&self) -> bool {
698 self.selection_phase == SelectionPhase::Selecting
699 }
700
701 pub fn get_cwd(&self) -> Option<PathBuf> {
702 self.pty_info.current.as_ref().map(|info| info.cwd.clone())
703 }
704
705 ///Takes events from Alacritty and translates them to behavior on this view
706 fn process_terminal_event(
707 &mut self,
708 event: &InternalEvent,
709 term: &mut Term<ZedListener>,
710 cx: &mut ModelContext<Self>,
711 ) {
712 match event {
713 InternalEvent::ColorRequest(index, format) => {
714 let color = term.colors()[*index].unwrap_or_else(|| {
715 to_alac_rgb(get_color_at_index(*index, cx.theme().as_ref()))
716 });
717 self.write_to_pty(format(color))
718 }
719 InternalEvent::Resize(mut new_size) => {
720 new_size.size.height = cmp::max(new_size.line_height, new_size.height());
721 new_size.size.width = cmp::max(new_size.cell_width, new_size.width());
722
723 self.last_content.size = new_size;
724
725 self.pty_tx.0.send(Msg::Resize(new_size.into())).ok();
726
727 term.resize(new_size);
728 }
729 InternalEvent::Clear => {
730 // Clear back buffer
731 term.clear_screen(ClearMode::Saved);
732
733 let cursor = term.grid().cursor.point;
734
735 // Clear the lines above
736 term.grid_mut().reset_region(..cursor.line);
737
738 // Copy the current line up
739 let line = term.grid()[cursor.line][..Column(term.grid().columns())]
740 .iter()
741 .cloned()
742 .enumerate()
743 .collect::<Vec<(usize, Cell)>>();
744
745 for (i, cell) in line {
746 term.grid_mut()[Line(0)][Column(i)] = cell;
747 }
748
749 // Reset the cursor
750 term.grid_mut().cursor.point =
751 AlacPoint::new(Line(0), term.grid_mut().cursor.point.column);
752 let new_cursor = term.grid().cursor.point;
753
754 // Clear the lines below the new cursor
755 if (new_cursor.line.0 as usize) < term.screen_lines() - 1 {
756 term.grid_mut().reset_region((new_cursor.line + 1)..);
757 }
758
759 cx.emit(Event::Wakeup);
760 }
761 InternalEvent::Scroll(scroll) => {
762 term.scroll_display(*scroll);
763 self.refresh_hovered_word();
764 }
765 InternalEvent::SetSelection(selection) => {
766 term.selection = selection.as_ref().map(|(sel, _)| sel.clone());
767
768 #[cfg(target_os = "linux")]
769 if let Some(selection_text) = term.selection_to_string() {
770 cx.write_to_primary(ClipboardItem::new(selection_text));
771 }
772
773 if let Some((_, head)) = selection {
774 self.selection_head = Some(*head);
775 }
776 cx.emit(Event::SelectionsChanged)
777 }
778 InternalEvent::UpdateSelection(position) => {
779 if let Some(mut selection) = term.selection.take() {
780 let (point, side) = grid_point_and_side(
781 *position,
782 self.last_content.size,
783 term.grid().display_offset(),
784 );
785
786 selection.update(point, side);
787 term.selection = Some(selection);
788
789 #[cfg(target_os = "linux")]
790 if let Some(selection_text) = term.selection_to_string() {
791 cx.write_to_primary(ClipboardItem::new(selection_text));
792 }
793
794 self.selection_head = Some(point);
795 cx.emit(Event::SelectionsChanged)
796 }
797 }
798
799 InternalEvent::Copy => {
800 if let Some(txt) = term.selection_to_string() {
801 cx.write_to_clipboard(ClipboardItem::new(txt))
802 }
803 }
804 InternalEvent::ScrollToAlacPoint(point) => {
805 term.scroll_to_point(*point);
806 self.refresh_hovered_word();
807 }
808 InternalEvent::FindHyperlink(position, open) => {
809 let prev_hovered_word = self.last_content.last_hovered_word.take();
810
811 let point = grid_point(
812 *position,
813 self.last_content.size,
814 term.grid().display_offset(),
815 )
816 .grid_clamp(term, Boundary::Grid);
817
818 let link = term.grid().index(point).hyperlink();
819 let found_word = if link.is_some() {
820 let mut min_index = point;
821 loop {
822 let new_min_index = min_index.sub(term, Boundary::Cursor, 1);
823 if new_min_index == min_index {
824 break;
825 } else if term.grid().index(new_min_index).hyperlink() != link {
826 break;
827 } else {
828 min_index = new_min_index
829 }
830 }
831
832 let mut max_index = point;
833 loop {
834 let new_max_index = max_index.add(term, Boundary::Cursor, 1);
835 if new_max_index == max_index {
836 break;
837 } else if term.grid().index(new_max_index).hyperlink() != link {
838 break;
839 } else {
840 max_index = new_max_index
841 }
842 }
843
844 let url = link.unwrap().uri().to_owned();
845 let url_match = min_index..=max_index;
846
847 Some((url, true, url_match))
848 } else if let Some(word_match) = regex_match_at(term, point, &mut self.word_regex) {
849 let maybe_url_or_path =
850 term.bounds_to_string(*word_match.start(), *word_match.end());
851 let original_match = word_match.clone();
852 let (sanitized_match, sanitized_word) =
853 if maybe_url_or_path.starts_with('[') && maybe_url_or_path.ends_with(']') {
854 (
855 Match::new(
856 word_match.start().add(term, Boundary::Cursor, 1),
857 word_match.end().sub(term, Boundary::Cursor, 1),
858 ),
859 maybe_url_or_path[1..maybe_url_or_path.len() - 1].to_owned(),
860 )
861 } else {
862 (word_match, maybe_url_or_path)
863 };
864
865 let is_url = match regex_match_at(term, point, &mut self.url_regex) {
866 Some(url_match) => {
867 // `]` is a valid symbol in the `file://` URL, so the regex match will include it
868 // consider that when ensuring that the URL match is the same as the original word
869 if sanitized_match == original_match {
870 url_match == sanitized_match
871 } else {
872 url_match.start() == sanitized_match.start()
873 && url_match.end() == original_match.end()
874 }
875 }
876 None => false,
877 };
878 Some((sanitized_word, is_url, sanitized_match))
879 } else {
880 None
881 };
882
883 match found_word {
884 Some((maybe_url_or_path, is_url, url_match)) => {
885 if *open {
886 let target = if is_url {
887 MaybeNavigationTarget::Url(maybe_url_or_path)
888 } else {
889 MaybeNavigationTarget::PathLike(PathLikeTarget {
890 maybe_path: maybe_url_or_path,
891 terminal_dir: self.get_cwd(),
892 })
893 };
894 cx.emit(Event::Open(target));
895 } else {
896 self.update_selected_word(
897 prev_hovered_word,
898 url_match,
899 maybe_url_or_path,
900 is_url,
901 cx,
902 );
903 }
904 self.hovered_word = true;
905 }
906 None => {
907 if self.hovered_word {
908 cx.emit(Event::NewNavigationTarget(None));
909 }
910 self.hovered_word = false;
911 }
912 }
913 }
914 }
915 }
916
917 fn update_selected_word(
918 &mut self,
919 prev_word: Option<HoveredWord>,
920 word_match: RangeInclusive<AlacPoint>,
921 word: String,
922 is_url: bool,
923 cx: &mut ModelContext<Self>,
924 ) {
925 if let Some(prev_word) = prev_word {
926 if prev_word.word == word && prev_word.word_match == word_match {
927 self.last_content.last_hovered_word = Some(HoveredWord {
928 word,
929 word_match,
930 id: prev_word.id,
931 });
932 return;
933 }
934 }
935
936 self.last_content.last_hovered_word = Some(HoveredWord {
937 word: word.clone(),
938 word_match,
939 id: self.next_link_id(),
940 });
941 let navigation_target = if is_url {
942 MaybeNavigationTarget::Url(word)
943 } else {
944 MaybeNavigationTarget::PathLike(PathLikeTarget {
945 maybe_path: word,
946 terminal_dir: self.get_cwd(),
947 })
948 };
949 cx.emit(Event::NewNavigationTarget(Some(navigation_target)));
950 }
951
952 fn next_link_id(&mut self) -> usize {
953 let res = self.next_link_id;
954 self.next_link_id = self.next_link_id.wrapping_add(1);
955 res
956 }
957
958 pub fn last_content(&self) -> &TerminalContent {
959 &self.last_content
960 }
961
962 pub fn total_lines(&self) -> usize {
963 let term = self.term.clone();
964 let terminal = term.lock_unfair();
965 terminal.total_lines()
966 }
967
968 pub fn viewport_lines(&self) -> usize {
969 let term = self.term.clone();
970 let terminal = term.lock_unfair();
971 terminal.screen_lines()
972 }
973
974 //To test:
975 //- Activate match on terminal (scrolling and selection)
976 //- Editor search snapping behavior
977
978 pub fn activate_match(&mut self, index: usize) {
979 if let Some(search_match) = self.matches.get(index).cloned() {
980 self.set_selection(Some((make_selection(&search_match), *search_match.end())));
981
982 self.events
983 .push_back(InternalEvent::ScrollToAlacPoint(*search_match.start()));
984 }
985 }
986
987 pub fn select_matches(&mut self, matches: &[RangeInclusive<AlacPoint>]) {
988 let matches_to_select = self
989 .matches
990 .iter()
991 .filter(|self_match| matches.contains(self_match))
992 .cloned()
993 .collect::<Vec<_>>();
994 for match_to_select in matches_to_select {
995 self.set_selection(Some((
996 make_selection(&match_to_select),
997 *match_to_select.end(),
998 )));
999 }
1000 }
1001
1002 pub fn select_all(&mut self) {
1003 let term = self.term.lock();
1004 let start = AlacPoint::new(term.topmost_line(), Column(0));
1005 let end = AlacPoint::new(term.bottommost_line(), term.last_column());
1006 drop(term);
1007 self.set_selection(Some((make_selection(&(start..=end)), end)));
1008 }
1009
1010 fn set_selection(&mut self, selection: Option<(Selection, AlacPoint)>) {
1011 self.events
1012 .push_back(InternalEvent::SetSelection(selection));
1013 }
1014
1015 pub fn copy(&mut self) {
1016 self.events.push_back(InternalEvent::Copy);
1017 }
1018
1019 pub fn clear(&mut self) {
1020 self.events.push_back(InternalEvent::Clear)
1021 }
1022
1023 pub fn scroll_line_up(&mut self) {
1024 self.events
1025 .push_back(InternalEvent::Scroll(AlacScroll::Delta(1)));
1026 }
1027
1028 pub fn scroll_up_by(&mut self, lines: usize) {
1029 self.events
1030 .push_back(InternalEvent::Scroll(AlacScroll::Delta(lines as i32)));
1031 }
1032
1033 pub fn scroll_line_down(&mut self) {
1034 self.events
1035 .push_back(InternalEvent::Scroll(AlacScroll::Delta(-1)));
1036 }
1037
1038 pub fn scroll_down_by(&mut self, lines: usize) {
1039 self.events
1040 .push_back(InternalEvent::Scroll(AlacScroll::Delta(-(lines as i32))));
1041 }
1042
1043 pub fn scroll_page_up(&mut self) {
1044 self.events
1045 .push_back(InternalEvent::Scroll(AlacScroll::PageUp));
1046 }
1047
1048 pub fn scroll_page_down(&mut self) {
1049 self.events
1050 .push_back(InternalEvent::Scroll(AlacScroll::PageDown));
1051 }
1052
1053 pub fn scroll_to_top(&mut self) {
1054 self.events
1055 .push_back(InternalEvent::Scroll(AlacScroll::Top));
1056 }
1057
1058 pub fn scroll_to_bottom(&mut self) {
1059 self.events
1060 .push_back(InternalEvent::Scroll(AlacScroll::Bottom));
1061 }
1062
1063 ///Resize the terminal and the PTY.
1064 pub fn set_size(&mut self, new_size: TerminalSize) {
1065 if self.last_content.size != new_size {
1066 self.events.push_back(InternalEvent::Resize(new_size))
1067 }
1068 }
1069
1070 ///Write the Input payload to the tty.
1071 fn write_to_pty(&self, input: String) {
1072 self.pty_tx.notify(input.into_bytes());
1073 }
1074
1075 fn write_bytes_to_pty(&self, input: Vec<u8>) {
1076 self.pty_tx.notify(input);
1077 }
1078
1079 pub fn input(&mut self, input: String) {
1080 self.events
1081 .push_back(InternalEvent::Scroll(AlacScroll::Bottom));
1082 self.events.push_back(InternalEvent::SetSelection(None));
1083
1084 self.write_to_pty(input);
1085 }
1086
1087 pub fn input_bytes(&mut self, input: Vec<u8>) {
1088 self.events
1089 .push_back(InternalEvent::Scroll(AlacScroll::Bottom));
1090 self.events.push_back(InternalEvent::SetSelection(None));
1091
1092 self.write_bytes_to_pty(input);
1093 }
1094
1095 pub fn try_keystroke(&mut self, keystroke: &Keystroke, alt_is_meta: bool) -> bool {
1096 let esc = to_esc_str(keystroke, &self.last_content.mode, alt_is_meta);
1097 if let Some(esc) = esc {
1098 self.input(esc);
1099 true
1100 } else {
1101 false
1102 }
1103 }
1104
1105 pub fn try_modifiers_change(&mut self, modifiers: &Modifiers) -> bool {
1106 let changed = self.secondary_pressed != modifiers.secondary();
1107 if !self.secondary_pressed && modifiers.secondary() {
1108 self.refresh_hovered_word();
1109 }
1110 self.secondary_pressed = modifiers.secondary();
1111 changed
1112 }
1113
1114 ///Paste text into the terminal
1115 pub fn paste(&mut self, text: &str) {
1116 let paste_text = if self.last_content.mode.contains(TermMode::BRACKETED_PASTE) {
1117 format!("{}{}{}", "\x1b[200~", text.replace('\x1b', ""), "\x1b[201~")
1118 } else {
1119 text.replace("\r\n", "\r").replace('\n', "\r")
1120 };
1121
1122 self.input(paste_text);
1123 }
1124
1125 pub fn sync(&mut self, cx: &mut ModelContext<Self>) {
1126 let term = self.term.clone();
1127 let mut terminal = term.lock_unfair();
1128 //Note that the ordering of events matters for event processing
1129 while let Some(e) = self.events.pop_front() {
1130 self.process_terminal_event(&e, &mut terminal, cx)
1131 }
1132
1133 self.last_content = Self::make_content(&terminal, &self.last_content);
1134 }
1135
1136 fn make_content(term: &Term<ZedListener>, last_content: &TerminalContent) -> TerminalContent {
1137 let content = term.renderable_content();
1138 TerminalContent {
1139 cells: content
1140 .display_iter
1141 //TODO: Add this once there's a way to retain empty lines
1142 // .filter(|ic| {
1143 // !ic.flags.contains(Flags::HIDDEN)
1144 // && !(ic.bg == Named(NamedColor::Background)
1145 // && ic.c == ' '
1146 // && !ic.flags.contains(Flags::INVERSE))
1147 // })
1148 .map(|ic| IndexedCell {
1149 point: ic.point,
1150 cell: ic.cell.clone(),
1151 })
1152 .collect::<Vec<IndexedCell>>(),
1153 mode: content.mode,
1154 display_offset: content.display_offset,
1155 selection_text: term.selection_to_string(),
1156 selection: content.selection,
1157 cursor: content.cursor,
1158 cursor_char: term.grid()[content.cursor.point].c,
1159 size: last_content.size,
1160 last_hovered_word: last_content.last_hovered_word.clone(),
1161 }
1162 }
1163
1164 pub fn last_n_non_empty_lines(&self, n: usize) -> Vec<String> {
1165 let term = self.term.clone();
1166 let terminal = term.lock_unfair();
1167
1168 let mut lines = Vec::new();
1169 let mut current_line = terminal.bottommost_line();
1170 while lines.len() < n {
1171 let mut line_buffer = String::new();
1172 for cell in &terminal.grid()[current_line] {
1173 line_buffer.push(cell.c);
1174 }
1175 let line = line_buffer.trim_end();
1176 if !line.is_empty() {
1177 lines.push(line.to_string());
1178 }
1179
1180 if current_line == terminal.topmost_line() {
1181 break;
1182 }
1183 current_line = Line(current_line.0 - 1);
1184 }
1185 lines.reverse();
1186 lines
1187 }
1188
1189 pub fn focus_in(&self) {
1190 if self.last_content.mode.contains(TermMode::FOCUS_IN_OUT) {
1191 self.write_to_pty("\x1b[I".to_string());
1192 }
1193 }
1194
1195 pub fn focus_out(&mut self) {
1196 self.last_mouse_position = None;
1197 if self.last_content.mode.contains(TermMode::FOCUS_IN_OUT) {
1198 self.write_to_pty("\x1b[O".to_string());
1199 }
1200 }
1201
1202 pub fn mouse_changed(&mut self, point: AlacPoint, side: AlacDirection) -> bool {
1203 match self.last_mouse {
1204 Some((old_point, old_side)) => {
1205 if old_point == point && old_side == side {
1206 false
1207 } else {
1208 self.last_mouse = Some((point, side));
1209 true
1210 }
1211 }
1212 None => {
1213 self.last_mouse = Some((point, side));
1214 true
1215 }
1216 }
1217 }
1218
1219 pub fn mouse_mode(&self, shift: bool) -> bool {
1220 self.last_content.mode.intersects(TermMode::MOUSE_MODE) && !shift
1221 }
1222
1223 pub fn mouse_move(&mut self, e: &MouseMoveEvent, origin: Point<Pixels>) {
1224 let position = e.position - origin;
1225 self.last_mouse_position = Some(position);
1226 if self.mouse_mode(e.modifiers.shift) {
1227 let (point, side) = grid_point_and_side(
1228 position,
1229 self.last_content.size,
1230 self.last_content.display_offset,
1231 );
1232
1233 if self.mouse_changed(point, side) {
1234 if let Some(bytes) = mouse_moved_report(point, e, self.last_content.mode) {
1235 self.pty_tx.notify(bytes);
1236 }
1237 }
1238 } else if self.secondary_pressed {
1239 self.word_from_position(Some(position));
1240 }
1241 }
1242
1243 fn word_from_position(&mut self, position: Option<Point<Pixels>>) {
1244 if self.selection_phase == SelectionPhase::Selecting {
1245 self.last_content.last_hovered_word = None;
1246 } else if let Some(position) = position {
1247 self.events
1248 .push_back(InternalEvent::FindHyperlink(position, false));
1249 }
1250 }
1251
1252 pub fn mouse_drag(
1253 &mut self,
1254 e: &MouseMoveEvent,
1255 origin: Point<Pixels>,
1256 region: Bounds<Pixels>,
1257 ) {
1258 let position = e.position - origin;
1259 self.last_mouse_position = Some(position);
1260
1261 if !self.mouse_mode(e.modifiers.shift) {
1262 self.selection_phase = SelectionPhase::Selecting;
1263 // Alacritty has the same ordering, of first updating the selection
1264 // then scrolling 15ms later
1265 self.events
1266 .push_back(InternalEvent::UpdateSelection(position));
1267
1268 // Doesn't make sense to scroll the alt screen
1269 if !self.last_content.mode.contains(TermMode::ALT_SCREEN) {
1270 let scroll_delta = match self.drag_line_delta(e, region) {
1271 Some(value) => value,
1272 None => return,
1273 };
1274
1275 let scroll_lines = (scroll_delta / self.last_content.size.line_height) as i32;
1276
1277 self.events
1278 .push_back(InternalEvent::Scroll(AlacScroll::Delta(scroll_lines)));
1279 }
1280 }
1281 }
1282
1283 fn drag_line_delta(&mut self, e: &MouseMoveEvent, region: Bounds<Pixels>) -> Option<Pixels> {
1284 //TODO: Why do these need to be doubled? Probably the same problem that the IME has
1285 let top = region.origin.y + (self.last_content.size.line_height * 2.);
1286 let bottom = region.lower_left().y - (self.last_content.size.line_height * 2.);
1287 let scroll_delta = if e.position.y < top {
1288 (top - e.position.y).pow(1.1)
1289 } else if e.position.y > bottom {
1290 -((e.position.y - bottom).pow(1.1))
1291 } else {
1292 return None; //Nothing to do
1293 };
1294 Some(scroll_delta)
1295 }
1296
1297 pub fn mouse_down(
1298 &mut self,
1299 e: &MouseDownEvent,
1300 origin: Point<Pixels>,
1301 _cx: &mut ModelContext<Self>,
1302 ) {
1303 let position = e.position - origin;
1304 let point = grid_point(
1305 position,
1306 self.last_content.size,
1307 self.last_content.display_offset,
1308 );
1309
1310 if self.mouse_mode(e.modifiers.shift) {
1311 if let Some(bytes) =
1312 mouse_button_report(point, e.button, e.modifiers, true, self.last_content.mode)
1313 {
1314 self.pty_tx.notify(bytes);
1315 }
1316 } else {
1317 match e.button {
1318 MouseButton::Left => {
1319 let position = e.position - origin;
1320 let (point, side) = grid_point_and_side(
1321 position,
1322 self.last_content.size,
1323 self.last_content.display_offset,
1324 );
1325
1326 let selection_type = match e.click_count {
1327 0 => return, //This is a release
1328 1 => Some(SelectionType::Simple),
1329 2 => Some(SelectionType::Semantic),
1330 3 => Some(SelectionType::Lines),
1331 _ => None,
1332 };
1333
1334 let selection = selection_type
1335 .map(|selection_type| Selection::new(selection_type, point, side));
1336
1337 if let Some(sel) = selection {
1338 self.events
1339 .push_back(InternalEvent::SetSelection(Some((sel, point))));
1340 }
1341 }
1342 #[cfg(target_os = "linux")]
1343 MouseButton::Middle => {
1344 if let Some(item) = _cx.read_from_primary() {
1345 let text = item.text().to_string();
1346 self.input(text);
1347 }
1348 }
1349 _ => {}
1350 }
1351 }
1352 }
1353
1354 pub fn mouse_up(
1355 &mut self,
1356 e: &MouseUpEvent,
1357 origin: Point<Pixels>,
1358 cx: &mut ModelContext<Self>,
1359 ) {
1360 let setting = TerminalSettings::get_global(cx);
1361
1362 let position = e.position - origin;
1363 if self.mouse_mode(e.modifiers.shift) {
1364 let point = grid_point(
1365 position,
1366 self.last_content.size,
1367 self.last_content.display_offset,
1368 );
1369
1370 if let Some(bytes) =
1371 mouse_button_report(point, e.button, e.modifiers, false, self.last_content.mode)
1372 {
1373 self.pty_tx.notify(bytes);
1374 }
1375 } else {
1376 if e.button == MouseButton::Left && setting.copy_on_select {
1377 self.copy();
1378 }
1379
1380 //Hyperlinks
1381 if self.selection_phase == SelectionPhase::Ended {
1382 let mouse_cell_index = content_index_for_mouse(position, &self.last_content.size);
1383 if let Some(link) = self.last_content.cells[mouse_cell_index].hyperlink() {
1384 cx.open_url(link.uri());
1385 } else if self.secondary_pressed {
1386 self.events
1387 .push_back(InternalEvent::FindHyperlink(position, true));
1388 }
1389 }
1390 }
1391
1392 self.selection_phase = SelectionPhase::Ended;
1393 self.last_mouse = None;
1394 }
1395
1396 ///Scroll the terminal
1397 pub fn scroll_wheel(&mut self, e: &ScrollWheelEvent, origin: Point<Pixels>) {
1398 let mouse_mode = self.mouse_mode(e.shift);
1399
1400 if let Some(scroll_lines) = self.determine_scroll_lines(e, mouse_mode) {
1401 if mouse_mode {
1402 let point = grid_point(
1403 e.position - origin,
1404 self.last_content.size,
1405 self.last_content.display_offset,
1406 );
1407
1408 if let Some(scrolls) = scroll_report(point, scroll_lines, e, self.last_content.mode)
1409 {
1410 for scroll in scrolls {
1411 self.pty_tx.notify(scroll);
1412 }
1413 };
1414 } else if self
1415 .last_content
1416 .mode
1417 .contains(TermMode::ALT_SCREEN | TermMode::ALTERNATE_SCROLL)
1418 && !e.shift
1419 {
1420 self.pty_tx.notify(alt_scroll(scroll_lines))
1421 } else {
1422 if scroll_lines != 0 {
1423 let scroll = AlacScroll::Delta(scroll_lines);
1424
1425 self.events.push_back(InternalEvent::Scroll(scroll));
1426 }
1427 }
1428 }
1429 }
1430
1431 fn refresh_hovered_word(&mut self) {
1432 self.word_from_position(self.last_mouse_position);
1433 }
1434
1435 fn determine_scroll_lines(&mut self, e: &ScrollWheelEvent, mouse_mode: bool) -> Option<i32> {
1436 let scroll_multiplier = if mouse_mode { 1. } else { SCROLL_MULTIPLIER };
1437 let line_height = self.last_content.size.line_height;
1438 match e.touch_phase {
1439 /* Reset scroll state on started */
1440 TouchPhase::Started => {
1441 self.scroll_px = px(0.);
1442 None
1443 }
1444 /* Calculate the appropriate scroll lines */
1445 TouchPhase::Moved => {
1446 let old_offset = (self.scroll_px / line_height) as i32;
1447
1448 self.scroll_px += e.delta.pixel_delta(line_height).y * scroll_multiplier;
1449
1450 let new_offset = (self.scroll_px / line_height) as i32;
1451
1452 // Whenever we hit the edges, reset our stored scroll to 0
1453 // so we can respond to changes in direction quickly
1454 self.scroll_px %= self.last_content.size.height();
1455
1456 Some(new_offset - old_offset)
1457 }
1458 TouchPhase::Ended => None,
1459 }
1460 }
1461
1462 pub fn find_matches(
1463 &mut self,
1464 mut searcher: RegexSearch,
1465 cx: &mut ModelContext<Self>,
1466 ) -> Task<Vec<RangeInclusive<AlacPoint>>> {
1467 let term = self.term.clone();
1468 cx.background_executor().spawn(async move {
1469 let term = term.lock();
1470
1471 all_search_matches(&term, &mut searcher).collect()
1472 })
1473 }
1474
1475 pub fn working_directory(&self) -> Option<PathBuf> {
1476 self.pty_info
1477 .current
1478 .as_ref()
1479 .map(|process| process.cwd.clone())
1480 }
1481
1482 pub fn title(&self, truncate: bool) -> String {
1483 const MAX_CHARS: usize = 25;
1484 match &self.task {
1485 Some(task_state) => {
1486 if truncate {
1487 truncate_and_trailoff(&task_state.label, MAX_CHARS)
1488 } else {
1489 task_state.full_label.clone()
1490 }
1491 }
1492 None => self
1493 .pty_info
1494 .current
1495 .as_ref()
1496 .map(|fpi| {
1497 let process_file = fpi
1498 .cwd
1499 .file_name()
1500 .map(|name| name.to_string_lossy().to_string())
1501 .unwrap_or_default();
1502
1503 let argv = fpi.argv.clone();
1504 let process_name = format!(
1505 "{}{}",
1506 fpi.name,
1507 if argv.len() >= 1 {
1508 format!(" {}", (argv[1..]).join(" "))
1509 } else {
1510 "".to_string()
1511 }
1512 );
1513 let (process_file, process_name) = if truncate {
1514 (
1515 truncate_and_trailoff(&process_file, MAX_CHARS),
1516 truncate_and_trailoff(&process_name, MAX_CHARS),
1517 )
1518 } else {
1519 (process_file, process_name)
1520 };
1521 format!("{process_file} — {process_name}")
1522 })
1523 .unwrap_or_else(|| "Terminal".to_string()),
1524 }
1525 }
1526
1527 pub fn can_navigate_to_selected_word(&self) -> bool {
1528 self.secondary_pressed && self.hovered_word
1529 }
1530
1531 pub fn task(&self) -> Option<&TaskState> {
1532 self.task.as_ref()
1533 }
1534
1535 pub fn wait_for_completed_task(&self, cx: &mut AppContext) -> Task<()> {
1536 if let Some(task) = self.task() {
1537 if task.status == TaskStatus::Running {
1538 let mut completion_receiver = task.completion_rx.clone();
1539 return cx.spawn(|_| async move {
1540 completion_receiver.next().await;
1541 });
1542 }
1543 }
1544 Task::ready(())
1545 }
1546
1547 fn register_task_finished(
1548 &mut self,
1549 error_code: Option<i32>,
1550 cx: &mut ModelContext<'_, Terminal>,
1551 ) {
1552 self.completion_tx.try_send(()).ok();
1553 let task = match &mut self.task {
1554 Some(task) => task,
1555 None => {
1556 if error_code.is_none() {
1557 cx.emit(Event::CloseTerminal);
1558 }
1559 return;
1560 }
1561 };
1562 if task.status != TaskStatus::Running {
1563 return;
1564 }
1565 match error_code {
1566 Some(error_code) => {
1567 task.status.register_task_exit(error_code);
1568 }
1569 None => {
1570 task.status.register_terminal_exit();
1571 }
1572 };
1573
1574 let (finished_successfully, task_line, command_line) = task_summary(task, error_code);
1575 // SAFETY: the invocation happens on non `TaskStatus::Running` tasks, once,
1576 // after either `AlacTermEvent::Exit` or `AlacTermEvent::ChildExit` events that are spawned
1577 // when Zed task finishes and no more output is made.
1578 // After the task summary is output once, no more text is appended to the terminal.
1579 unsafe { append_text_to_term(&mut self.term.lock(), &[&task_line, &command_line]) };
1580 match task.hide {
1581 HideStrategy::Never => {}
1582 HideStrategy::Always => {
1583 cx.emit(Event::CloseTerminal);
1584 }
1585 HideStrategy::OnSuccess => {
1586 if finished_successfully {
1587 cx.emit(Event::CloseTerminal);
1588 }
1589 }
1590 }
1591 }
1592}
1593
1594const TASK_DELIMITER: &str = "⏵ ";
1595fn task_summary(task: &TaskState, error_code: Option<i32>) -> (bool, String, String) {
1596 let escaped_full_label = task.full_label.replace("\r\n", "\r").replace('\n', "\r");
1597 let (success, task_line) = match error_code {
1598 Some(0) => {
1599 (true, format!("{TASK_DELIMITER}Task `{escaped_full_label}` finished successfully"))
1600 }
1601 Some(error_code) => {
1602 (false, format!("{TASK_DELIMITER}Task `{escaped_full_label}` finished with non-zero error code: {error_code}"))
1603 }
1604 None => {
1605 (false, format!("{TASK_DELIMITER}Task `{escaped_full_label}` finished"))
1606 }
1607 };
1608 let escaped_command_label = task.command_label.replace("\r\n", "\r").replace('\n', "\r");
1609 let command_line = format!("{TASK_DELIMITER}Command: '{escaped_command_label}'");
1610 (success, task_line, command_line)
1611}
1612
1613/// Appends a stringified task summary to the terminal, after its output.
1614///
1615/// SAFETY: This function should only be called after terminal's PTY is no longer alive.
1616/// New text being added to the terminal here, uses "less public" APIs,
1617/// which are not maintaining the entire terminal state intact.
1618///
1619///
1620/// The library
1621///
1622/// * does not increment inner grid cursor's _lines_ on `input` calls
1623/// (but displaying the lines correctly and incrementing cursor's columns)
1624///
1625/// * ignores `\n` and \r` character input, requiring the `newline` call instead
1626///
1627/// * does not alter grid state after `newline` call
1628/// so its `bottommost_line` is always the same additions, and
1629/// the cursor's `point` is not updated to the new line and column values
1630///
1631/// * ??? there could be more consequences, and any further "proper" streaming from the PTY might bug and/or panic.
1632/// Still, concequent `append_text_to_term` invocations are possible and display the contents correctly.
1633///
1634/// Despite the quirks, this is the simplest approach to appending text to the terminal: its alternative, `grid_mut` manipulations,
1635/// do not properly set the scrolling state and display odd text after appending; also those manipulations are more tedious and error-prone.
1636/// The function achieves proper display and scrolling capabilities, at a cost of grid state not properly synchronized.
1637/// This is enough for printing moderately-sized texts like task summaries, but might break or perform poorly for larger texts.
1638unsafe fn append_text_to_term(term: &mut Term<ZedListener>, text_lines: &[&str]) {
1639 term.newline();
1640 term.grid_mut().cursor.point.column = Column(0);
1641 for line in text_lines {
1642 for c in line.chars() {
1643 term.input(c);
1644 }
1645 term.newline();
1646 term.grid_mut().cursor.point.column = Column(0);
1647 }
1648}
1649
1650impl Drop for Terminal {
1651 fn drop(&mut self) {
1652 self.pty_tx.0.send(Msg::Shutdown).ok();
1653 }
1654}
1655
1656impl EventEmitter<Event> for Terminal {}
1657
1658/// Based on alacritty/src/display/hint.rs > regex_match_at
1659/// Retrieve the match, if the specified point is inside the content matching the regex.
1660fn regex_match_at<T>(term: &Term<T>, point: AlacPoint, regex: &mut RegexSearch) -> Option<Match> {
1661 visible_regex_match_iter(term, regex).find(|rm| rm.contains(&point))
1662}
1663
1664/// Copied from alacritty/src/display/hint.rs:
1665/// Iterate over all visible regex matches.
1666pub fn visible_regex_match_iter<'a, T>(
1667 term: &'a Term<T>,
1668 regex: &'a mut RegexSearch,
1669) -> impl Iterator<Item = Match> + 'a {
1670 let viewport_start = Line(-(term.grid().display_offset() as i32));
1671 let viewport_end = viewport_start + term.bottommost_line();
1672 let mut start = term.line_search_left(AlacPoint::new(viewport_start, Column(0)));
1673 let mut end = term.line_search_right(AlacPoint::new(viewport_end, Column(0)));
1674 start.line = start.line.max(viewport_start - MAX_SEARCH_LINES);
1675 end.line = end.line.min(viewport_end + MAX_SEARCH_LINES);
1676
1677 RegexIter::new(start, end, AlacDirection::Right, term, regex)
1678 .skip_while(move |rm| rm.end().line < viewport_start)
1679 .take_while(move |rm| rm.start().line <= viewport_end)
1680}
1681
1682fn make_selection(range: &RangeInclusive<AlacPoint>) -> Selection {
1683 let mut selection = Selection::new(SelectionType::Simple, *range.start(), AlacDirection::Left);
1684 selection.update(*range.end(), AlacDirection::Right);
1685 selection
1686}
1687
1688fn all_search_matches<'a, T>(
1689 term: &'a Term<T>,
1690 regex: &'a mut RegexSearch,
1691) -> impl Iterator<Item = Match> + 'a {
1692 let start = AlacPoint::new(term.grid().topmost_line(), Column(0));
1693 let end = AlacPoint::new(term.grid().bottommost_line(), term.grid().last_column());
1694 RegexIter::new(start, end, AlacDirection::Right, term, regex)
1695}
1696
1697fn content_index_for_mouse(pos: Point<Pixels>, size: &TerminalSize) -> usize {
1698 let col = (pos.x / size.cell_width()).round() as usize;
1699 let clamped_col = min(col, size.columns() - 1);
1700 let row = (pos.y / size.line_height()).round() as usize;
1701 let clamped_row = min(row, size.screen_lines() - 1);
1702 clamped_row * size.columns() + clamped_col
1703}
1704
1705/// Converts an 8 bit ANSI color to its GPUI equivalent.
1706/// Accepts `usize` for compatibility with the `alacritty::Colors` interface,
1707/// Other than that use case, should only be called with values in the [0,255] range
1708pub fn get_color_at_index(index: usize, theme: &Theme) -> Hsla {
1709 let colors = theme.colors();
1710
1711 match index {
1712 // 0-15 are the same as the named colors above
1713 0 => colors.terminal_ansi_black,
1714 1 => colors.terminal_ansi_red,
1715 2 => colors.terminal_ansi_green,
1716 3 => colors.terminal_ansi_yellow,
1717 4 => colors.terminal_ansi_blue,
1718 5 => colors.terminal_ansi_magenta,
1719 6 => colors.terminal_ansi_cyan,
1720 7 => colors.terminal_ansi_white,
1721 8 => colors.terminal_ansi_bright_black,
1722 9 => colors.terminal_ansi_bright_red,
1723 10 => colors.terminal_ansi_bright_green,
1724 11 => colors.terminal_ansi_bright_yellow,
1725 12 => colors.terminal_ansi_bright_blue,
1726 13 => colors.terminal_ansi_bright_magenta,
1727 14 => colors.terminal_ansi_bright_cyan,
1728 15 => colors.terminal_ansi_bright_white,
1729 // 16-231 are mapped to their RGB colors on a 0-5 range per channel
1730 16..=231 => {
1731 let (r, g, b) = rgb_for_index(index as u8); // Split the index into its ANSI-RGB components
1732 let step = (u8::MAX as f32 / 5.).floor() as u8; // Split the RGB range into 5 chunks, with floor so no overflow
1733 rgba_color(r * step, g * step, b * step) // Map the ANSI-RGB components to an RGB color
1734 }
1735 // 232-255 are a 24 step grayscale from black to white
1736 232..=255 => {
1737 let i = index as u8 - 232; // Align index to 0..24
1738 let step = (u8::MAX as f32 / 24.).floor() as u8; // Split the RGB grayscale values into 24 chunks
1739 rgba_color(i * step, i * step, i * step) // Map the ANSI-grayscale components to the RGB-grayscale
1740 }
1741 // For compatibility with the alacritty::Colors interface
1742 256 => colors.text,
1743 257 => colors.background,
1744 258 => theme.players().local().cursor,
1745 259 => colors.terminal_ansi_dim_black,
1746 260 => colors.terminal_ansi_dim_red,
1747 261 => colors.terminal_ansi_dim_green,
1748 262 => colors.terminal_ansi_dim_yellow,
1749 263 => colors.terminal_ansi_dim_blue,
1750 264 => colors.terminal_ansi_dim_magenta,
1751 265 => colors.terminal_ansi_dim_cyan,
1752 266 => colors.terminal_ansi_dim_white,
1753 267 => colors.terminal_bright_foreground,
1754 268 => colors.terminal_ansi_black, // 'Dim Background', non-standard color
1755
1756 _ => black(),
1757 }
1758}
1759
1760/// Generates the RGB channels in [0, 5] for a given index into the 6x6x6 ANSI color cube.
1761/// See: [8 bit ANSI color](https://en.wikipedia.org/wiki/ANSI_escape_code#8-bit).
1762///
1763/// Wikipedia gives a formula for calculating the index for a given color:
1764///
1765/// ```
1766/// index = 16 + 36 × r + 6 × g + b (0 ≤ r, g, b ≤ 5)
1767/// ```
1768///
1769/// This function does the reverse, calculating the `r`, `g`, and `b` components from a given index.
1770fn rgb_for_index(i: u8) -> (u8, u8, u8) {
1771 debug_assert!((16..=231).contains(&i));
1772 let i = i - 16;
1773 let r = (i - (i % 36)) / 36;
1774 let g = ((i % 36) - (i % 6)) / 6;
1775 let b = (i % 36) % 6;
1776 (r, g, b)
1777}
1778
1779pub fn rgba_color(r: u8, g: u8, b: u8) -> Hsla {
1780 Rgba {
1781 r: (r as f32 / 255.),
1782 g: (g as f32 / 255.),
1783 b: (b as f32 / 255.),
1784 a: 1.,
1785 }
1786 .into()
1787}
1788
1789#[cfg(test)]
1790mod tests {
1791 use alacritty_terminal::{
1792 index::{Column, Line, Point as AlacPoint},
1793 term::cell::Cell,
1794 };
1795 use gpui::{point, size, Pixels};
1796 use rand::{distributions::Alphanumeric, rngs::ThreadRng, thread_rng, Rng};
1797
1798 use crate::{
1799 content_index_for_mouse, rgb_for_index, IndexedCell, TerminalContent, TerminalSize,
1800 };
1801
1802 #[test]
1803 fn test_rgb_for_index() {
1804 // Test every possible value in the color cube.
1805 for i in 16..=231 {
1806 let (r, g, b) = rgb_for_index(i);
1807 assert_eq!(i, 16 + 36 * r + 6 * g + b);
1808 }
1809 }
1810
1811 #[test]
1812 fn test_mouse_to_cell_test() {
1813 let mut rng = thread_rng();
1814 const ITERATIONS: usize = 10;
1815 const PRECISION: usize = 1000;
1816
1817 for _ in 0..ITERATIONS {
1818 let viewport_cells = rng.gen_range(15..20);
1819 let cell_size = rng.gen_range(5 * PRECISION..20 * PRECISION) as f32 / PRECISION as f32;
1820
1821 let size = crate::TerminalSize {
1822 cell_width: Pixels::from(cell_size),
1823 line_height: Pixels::from(cell_size),
1824 size: size(
1825 Pixels::from(cell_size * (viewport_cells as f32)),
1826 Pixels::from(cell_size * (viewport_cells as f32)),
1827 ),
1828 };
1829
1830 let cells = get_cells(size, &mut rng);
1831 let content = convert_cells_to_content(size, &cells);
1832
1833 for row in 0..(viewport_cells - 1) {
1834 let row = row as usize;
1835 for col in 0..(viewport_cells - 1) {
1836 let col = col as usize;
1837
1838 let row_offset = rng.gen_range(0..PRECISION) as f32 / PRECISION as f32;
1839 let col_offset = rng.gen_range(0..PRECISION) as f32 / PRECISION as f32;
1840
1841 let mouse_pos = point(
1842 Pixels::from(col as f32 * cell_size + col_offset),
1843 Pixels::from(row as f32 * cell_size + row_offset),
1844 );
1845
1846 let content_index = content_index_for_mouse(mouse_pos, &content.size);
1847 let mouse_cell = content.cells[content_index].c;
1848 let real_cell = cells[row][col];
1849
1850 assert_eq!(mouse_cell, real_cell);
1851 }
1852 }
1853 }
1854 }
1855
1856 #[test]
1857 fn test_mouse_to_cell_clamp() {
1858 let mut rng = thread_rng();
1859
1860 let size = crate::TerminalSize {
1861 cell_width: Pixels::from(10.),
1862 line_height: Pixels::from(10.),
1863 size: size(Pixels::from(100.), Pixels::from(100.)),
1864 };
1865
1866 let cells = get_cells(size, &mut rng);
1867 let content = convert_cells_to_content(size, &cells);
1868
1869 assert_eq!(
1870 content.cells[content_index_for_mouse(
1871 point(Pixels::from(-10.), Pixels::from(-10.)),
1872 &content.size,
1873 )]
1874 .c,
1875 cells[0][0]
1876 );
1877 assert_eq!(
1878 content.cells[content_index_for_mouse(
1879 point(Pixels::from(1000.), Pixels::from(1000.)),
1880 &content.size,
1881 )]
1882 .c,
1883 cells[9][9]
1884 );
1885 }
1886
1887 fn get_cells(size: TerminalSize, rng: &mut ThreadRng) -> Vec<Vec<char>> {
1888 let mut cells = Vec::new();
1889
1890 for _ in 0..((size.height() / size.line_height()) as usize) {
1891 let mut row_vec = Vec::new();
1892 for _ in 0..((size.width() / size.cell_width()) as usize) {
1893 let cell_char = rng.sample(Alphanumeric) as char;
1894 row_vec.push(cell_char)
1895 }
1896 cells.push(row_vec)
1897 }
1898
1899 cells
1900 }
1901
1902 fn convert_cells_to_content(size: TerminalSize, cells: &Vec<Vec<char>>) -> TerminalContent {
1903 let mut ic = Vec::new();
1904
1905 for row in 0..cells.len() {
1906 for col in 0..cells[row].len() {
1907 let cell_char = cells[row][col];
1908 ic.push(IndexedCell {
1909 point: AlacPoint::new(Line(row as i32), Column(col)),
1910 cell: Cell {
1911 c: cell_char,
1912 ..Default::default()
1913 },
1914 });
1915 }
1916 }
1917
1918 TerminalContent {
1919 cells: ic,
1920 size,
1921 ..Default::default()
1922 }
1923 }
1924}