1use editor::{CursorLayout, HighlightedRange, HighlightedRangeLine};
2use gpui::{
3 div, fill, point, px, relative, size, AnyElement, App, AvailableSpace, Bounds, ContentMask,
4 Context, DispatchPhase, Element, ElementId, Entity, FocusHandle, Font, FontStyle, FontWeight,
5 GlobalElementId, HighlightStyle, Hitbox, Hsla, InputHandler, InteractiveElement, Interactivity,
6 IntoElement, LayoutId, ModifiersChangedEvent, MouseButton, MouseMoveEvent, Pixels, Point,
7 ShapedLine, StatefulInteractiveElement, StrikethroughStyle, Styled, TextRun, TextStyle,
8 UTF16Selection, UnderlineStyle, WeakEntity, WhiteSpace, Window, WindowTextSystem,
9};
10use itertools::Itertools;
11use language::CursorShape;
12use settings::Settings;
13use terminal::{
14 alacritty_terminal::{
15 grid::Dimensions,
16 index::Point as AlacPoint,
17 term::{cell::Flags, TermMode},
18 vte::ansi::{
19 Color::{self as AnsiColor, Named},
20 CursorShape as AlacCursorShape, NamedColor,
21 },
22 },
23 terminal_settings::TerminalSettings,
24 HoveredWord, IndexedCell, Terminal, TerminalContent, TerminalSize,
25};
26use theme::{ActiveTheme, Theme, ThemeSettings};
27use ui::{ParentElement, Tooltip};
28use workspace::Workspace;
29
30use std::mem;
31use std::{fmt::Debug, ops::RangeInclusive, rc::Rc};
32
33use crate::{BlockContext, BlockProperties, TerminalView};
34
35/// The information generated during layout that is necessary for painting.
36pub struct LayoutState {
37 hitbox: Hitbox,
38 cells: Vec<LayoutCell>,
39 rects: Vec<LayoutRect>,
40 relative_highlighted_ranges: Vec<(RangeInclusive<AlacPoint>, Hsla)>,
41 cursor: Option<CursorLayout>,
42 background_color: Hsla,
43 dimensions: TerminalSize,
44 mode: TermMode,
45 display_offset: usize,
46 hyperlink_tooltip: Option<AnyElement>,
47 gutter: Pixels,
48 last_hovered_word: Option<HoveredWord>,
49 block_below_cursor_element: Option<AnyElement>,
50}
51
52/// Helper struct for converting data between Alacritty's cursor points, and displayed cursor points.
53struct DisplayCursor {
54 line: i32,
55 col: usize,
56}
57
58impl DisplayCursor {
59 fn from(cursor_point: AlacPoint, display_offset: usize) -> Self {
60 Self {
61 line: cursor_point.line.0 + display_offset as i32,
62 col: cursor_point.column.0,
63 }
64 }
65
66 pub fn line(&self) -> i32 {
67 self.line
68 }
69
70 pub fn col(&self) -> usize {
71 self.col
72 }
73}
74
75#[derive(Debug, Default)]
76pub struct LayoutCell {
77 pub point: AlacPoint<i32, i32>,
78 text: gpui::ShapedLine,
79}
80
81impl LayoutCell {
82 fn new(point: AlacPoint<i32, i32>, text: gpui::ShapedLine) -> LayoutCell {
83 LayoutCell { point, text }
84 }
85
86 pub fn paint(
87 &self,
88 origin: Point<Pixels>,
89 dimensions: &TerminalSize,
90 _visible_bounds: Bounds<Pixels>,
91 window: &mut Window,
92 cx: &mut App,
93 ) {
94 let pos = {
95 let point = self.point;
96
97 Point::new(
98 (origin.x + point.column as f32 * dimensions.cell_width).floor(),
99 origin.y + point.line as f32 * dimensions.line_height,
100 )
101 };
102
103 self.text
104 .paint(pos, dimensions.line_height, window, cx)
105 .ok();
106 }
107}
108
109#[derive(Clone, Debug, Default)]
110pub struct LayoutRect {
111 point: AlacPoint<i32, i32>,
112 num_of_cells: usize,
113 color: Hsla,
114}
115
116impl LayoutRect {
117 fn new(point: AlacPoint<i32, i32>, num_of_cells: usize, color: Hsla) -> LayoutRect {
118 LayoutRect {
119 point,
120 num_of_cells,
121 color,
122 }
123 }
124
125 fn extend(&self) -> Self {
126 LayoutRect {
127 point: self.point,
128 num_of_cells: self.num_of_cells + 1,
129 color: self.color,
130 }
131 }
132
133 pub fn paint(&self, origin: Point<Pixels>, dimensions: &TerminalSize, window: &mut Window) {
134 let position = {
135 let alac_point = self.point;
136 point(
137 (origin.x + alac_point.column as f32 * dimensions.cell_width).floor(),
138 origin.y + alac_point.line as f32 * dimensions.line_height,
139 )
140 };
141 let size = point(
142 (dimensions.cell_width * self.num_of_cells as f32).ceil(),
143 dimensions.line_height,
144 )
145 .into();
146
147 window.paint_quad(fill(Bounds::new(position, size), self.color));
148 }
149}
150
151/// The GPUI element that paints the terminal.
152/// We need to keep a reference to the model for mouse events, do we need it for any other terminal stuff, or can we move that to connection?
153pub struct TerminalElement {
154 terminal: Entity<Terminal>,
155 terminal_view: Entity<TerminalView>,
156 workspace: WeakEntity<Workspace>,
157 focus: FocusHandle,
158 focused: bool,
159 cursor_visible: bool,
160 can_navigate_to_selected_word: bool,
161 interactivity: Interactivity,
162 block_below_cursor: Option<Rc<BlockProperties>>,
163}
164
165impl InteractiveElement for TerminalElement {
166 fn interactivity(&mut self) -> &mut Interactivity {
167 &mut self.interactivity
168 }
169}
170
171impl StatefulInteractiveElement for TerminalElement {}
172
173impl TerminalElement {
174 #[allow(clippy::too_many_arguments)]
175 pub fn new(
176 terminal: Entity<Terminal>,
177 terminal_view: Entity<TerminalView>,
178 workspace: WeakEntity<Workspace>,
179 focus: FocusHandle,
180 focused: bool,
181 cursor_visible: bool,
182 can_navigate_to_selected_word: bool,
183 block_below_cursor: Option<Rc<BlockProperties>>,
184 ) -> TerminalElement {
185 TerminalElement {
186 terminal,
187 terminal_view,
188 workspace,
189 focused,
190 focus: focus.clone(),
191 cursor_visible,
192 can_navigate_to_selected_word,
193 block_below_cursor,
194 interactivity: Default::default(),
195 }
196 .track_focus(&focus)
197 .element
198 }
199
200 //Vec<Range<AlacPoint>> -> Clip out the parts of the ranges
201
202 pub fn layout_grid(
203 grid: impl Iterator<Item = IndexedCell>,
204 text_style: &TextStyle,
205 // terminal_theme: &TerminalStyle,
206 text_system: &WindowTextSystem,
207 hyperlink: Option<(HighlightStyle, &RangeInclusive<AlacPoint>)>,
208 window: &Window,
209 cx: &App,
210 ) -> (Vec<LayoutCell>, Vec<LayoutRect>) {
211 let theme = cx.theme();
212 let mut cells = vec![];
213 let mut rects = vec![];
214
215 let mut cur_rect: Option<LayoutRect> = None;
216 let mut cur_alac_color = None;
217
218 let linegroups = grid.into_iter().chunk_by(|i| i.point.line);
219 for (line_index, (_, line)) in linegroups.into_iter().enumerate() {
220 for cell in line {
221 let mut fg = cell.fg;
222 let mut bg = cell.bg;
223 if cell.flags.contains(Flags::INVERSE) {
224 mem::swap(&mut fg, &mut bg);
225 }
226
227 //Expand background rect range
228 {
229 if matches!(bg, Named(NamedColor::Background)) {
230 //Continue to next cell, resetting variables if necessary
231 cur_alac_color = None;
232 if let Some(rect) = cur_rect {
233 rects.push(rect);
234 cur_rect = None
235 }
236 } else {
237 match cur_alac_color {
238 Some(cur_color) => {
239 if bg == cur_color {
240 // `cur_rect` can be None if it was moved to the `rects` vec after wrapping around
241 // from one line to the next. The variables are all set correctly but there is no current
242 // rect, so we create one if necessary.
243 cur_rect = cur_rect.map_or_else(
244 || {
245 Some(LayoutRect::new(
246 AlacPoint::new(
247 line_index as i32,
248 cell.point.column.0 as i32,
249 ),
250 1,
251 convert_color(&bg, theme),
252 ))
253 },
254 |rect| Some(rect.extend()),
255 );
256 } else {
257 cur_alac_color = Some(bg);
258 if cur_rect.is_some() {
259 rects.push(cur_rect.take().unwrap());
260 }
261 cur_rect = Some(LayoutRect::new(
262 AlacPoint::new(
263 line_index as i32,
264 cell.point.column.0 as i32,
265 ),
266 1,
267 convert_color(&bg, theme),
268 ));
269 }
270 }
271 None => {
272 cur_alac_color = Some(bg);
273 cur_rect = Some(LayoutRect::new(
274 AlacPoint::new(line_index as i32, cell.point.column.0 as i32),
275 1,
276 convert_color(&bg, theme),
277 ));
278 }
279 }
280 }
281 }
282
283 //Layout current cell text
284 {
285 if !is_blank(&cell) {
286 let cell_text = cell.c.to_string();
287 let cell_style =
288 TerminalElement::cell_style(&cell, fg, theme, text_style, hyperlink);
289
290 let layout_cell = text_system
291 .shape_line(
292 cell_text.into(),
293 text_style.font_size.to_pixels(window.rem_size()),
294 &[cell_style],
295 )
296 .unwrap();
297
298 cells.push(LayoutCell::new(
299 AlacPoint::new(line_index as i32, cell.point.column.0 as i32),
300 layout_cell,
301 ))
302 };
303 }
304 }
305
306 if cur_rect.is_some() {
307 rects.push(cur_rect.take().unwrap());
308 }
309 }
310 (cells, rects)
311 }
312
313 /// Computes the cursor position and expected block width, may return a zero width if x_for_index returns
314 /// the same position for sequential indexes. Use em_width instead
315 fn shape_cursor(
316 cursor_point: DisplayCursor,
317 size: TerminalSize,
318 text_fragment: &ShapedLine,
319 ) -> Option<(Point<Pixels>, Pixels)> {
320 if cursor_point.line() < size.total_lines() as i32 {
321 let cursor_width = if text_fragment.width == Pixels::ZERO {
322 size.cell_width()
323 } else {
324 text_fragment.width
325 };
326
327 // Cursor should always surround as much of the text as possible,
328 // hence when on pixel boundaries round the origin down and the width up
329 Some((
330 point(
331 (cursor_point.col() as f32 * size.cell_width()).floor(),
332 (cursor_point.line() as f32 * size.line_height()).floor(),
333 ),
334 cursor_width.ceil(),
335 ))
336 } else {
337 None
338 }
339 }
340
341 /// Converts the Alacritty cell styles to GPUI text styles and background color.
342 fn cell_style(
343 indexed: &IndexedCell,
344 fg: terminal::alacritty_terminal::vte::ansi::Color,
345 // bg: terminal::alacritty_terminal::ansi::Color,
346 colors: &Theme,
347 text_style: &TextStyle,
348 hyperlink: Option<(HighlightStyle, &RangeInclusive<AlacPoint>)>,
349 ) -> TextRun {
350 let flags = indexed.cell.flags;
351 let mut fg = convert_color(&fg, colors);
352
353 // Ghostty uses (175/255) as the multiplier (~0.69), Alacritty uses 0.66, Kitty
354 // uses 0.75. We're using 0.7 because it's pretty well in the middle of that.
355 if flags.intersects(Flags::DIM) {
356 fg.a *= 0.7;
357 }
358
359 let underline = (flags.intersects(Flags::ALL_UNDERLINES)
360 || indexed.cell.hyperlink().is_some())
361 .then(|| UnderlineStyle {
362 color: Some(fg),
363 thickness: Pixels::from(1.0),
364 wavy: flags.contains(Flags::UNDERCURL),
365 });
366
367 let strikethrough = flags
368 .intersects(Flags::STRIKEOUT)
369 .then(|| StrikethroughStyle {
370 color: Some(fg),
371 thickness: Pixels::from(1.0),
372 });
373
374 let weight = if flags.intersects(Flags::BOLD) {
375 FontWeight::BOLD
376 } else {
377 text_style.font_weight
378 };
379
380 let style = if flags.intersects(Flags::ITALIC) {
381 FontStyle::Italic
382 } else {
383 FontStyle::Normal
384 };
385
386 let mut result = TextRun {
387 len: indexed.c.len_utf8(),
388 color: fg,
389 background_color: None,
390 font: Font {
391 weight,
392 style,
393 ..text_style.font()
394 },
395 underline,
396 strikethrough,
397 };
398
399 if let Some((style, range)) = hyperlink {
400 if range.contains(&indexed.point) {
401 if let Some(underline) = style.underline {
402 result.underline = Some(underline);
403 }
404
405 if let Some(color) = style.color {
406 result.color = color;
407 }
408 }
409 }
410
411 result
412 }
413
414 fn generic_button_handler<E>(
415 connection: Entity<Terminal>,
416 origin: Point<Pixels>,
417 focus_handle: FocusHandle,
418 f: impl Fn(&mut Terminal, Point<Pixels>, &E, &mut Context<Terminal>),
419 ) -> impl Fn(&E, &mut Window, &mut App) {
420 move |event, window, cx| {
421 window.focus(&focus_handle);
422 connection.update(cx, |terminal, cx| {
423 f(terminal, origin, event, cx);
424
425 cx.notify();
426 })
427 }
428 }
429
430 fn register_mouse_listeners(
431 &mut self,
432 origin: Point<Pixels>,
433 mode: TermMode,
434 hitbox: &Hitbox,
435 window: &mut Window,
436 ) {
437 let focus = self.focus.clone();
438 let terminal = self.terminal.clone();
439
440 self.interactivity.on_mouse_down(MouseButton::Left, {
441 let terminal = terminal.clone();
442 let focus = focus.clone();
443 move |e, window, cx| {
444 window.focus(&focus);
445 terminal.update(cx, |terminal, cx| {
446 terminal.mouse_down(e, origin, cx);
447 cx.notify();
448 })
449 }
450 });
451
452 window.on_mouse_event({
453 let focus = self.focus.clone();
454 let terminal = self.terminal.clone();
455 let hitbox = hitbox.clone();
456 move |e: &MouseMoveEvent, phase, window, cx| {
457 if phase != DispatchPhase::Bubble || !focus.is_focused(window) {
458 return;
459 }
460
461 if e.pressed_button.is_some() && !cx.has_active_drag() {
462 let hovered = hitbox.is_hovered(window);
463 terminal.update(cx, |terminal, cx| {
464 if terminal.selection_started() {
465 terminal.mouse_drag(e, origin, hitbox.bounds);
466 cx.notify();
467 } else if hovered {
468 terminal.mouse_drag(e, origin, hitbox.bounds);
469 cx.notify();
470 }
471 })
472 }
473
474 if hitbox.is_hovered(window) {
475 terminal.update(cx, |terminal, cx| {
476 terminal.mouse_move(e, origin);
477 cx.notify();
478 })
479 }
480 }
481 });
482
483 self.interactivity.on_mouse_up(
484 MouseButton::Left,
485 TerminalElement::generic_button_handler(
486 terminal.clone(),
487 origin,
488 focus.clone(),
489 move |terminal, origin, e, cx| {
490 terminal.mouse_up(e, origin, cx);
491 },
492 ),
493 );
494 self.interactivity.on_mouse_down(
495 MouseButton::Middle,
496 TerminalElement::generic_button_handler(
497 terminal.clone(),
498 origin,
499 focus.clone(),
500 move |terminal, origin, e, cx| {
501 terminal.mouse_down(e, origin, cx);
502 },
503 ),
504 );
505 self.interactivity.on_scroll_wheel({
506 let terminal_view = self.terminal_view.downgrade();
507 move |e, _, cx| {
508 terminal_view
509 .update(cx, |terminal_view, cx| {
510 terminal_view.scroll_wheel(e, origin, cx);
511 cx.notify();
512 })
513 .ok();
514 }
515 });
516
517 // Mouse mode handlers:
518 // All mouse modes need the extra click handlers
519 if mode.intersects(TermMode::MOUSE_MODE) {
520 self.interactivity.on_mouse_down(
521 MouseButton::Right,
522 TerminalElement::generic_button_handler(
523 terminal.clone(),
524 origin,
525 focus.clone(),
526 move |terminal, origin, e, cx| {
527 terminal.mouse_down(e, origin, cx);
528 },
529 ),
530 );
531 self.interactivity.on_mouse_up(
532 MouseButton::Right,
533 TerminalElement::generic_button_handler(
534 terminal.clone(),
535 origin,
536 focus.clone(),
537 move |terminal, origin, e, cx| {
538 terminal.mouse_up(e, origin, cx);
539 },
540 ),
541 );
542 self.interactivity.on_mouse_up(
543 MouseButton::Middle,
544 TerminalElement::generic_button_handler(
545 terminal,
546 origin,
547 focus,
548 move |terminal, origin, e, cx| {
549 terminal.mouse_up(e, origin, cx);
550 },
551 ),
552 );
553 }
554 }
555
556 fn rem_size(&self, cx: &mut App) -> Option<Pixels> {
557 let settings = ThemeSettings::get_global(cx).clone();
558 let buffer_font_size = settings.buffer_font_size();
559 let rem_size_scale = {
560 // Our default UI font size is 14px on a 16px base scale.
561 // This means the default UI font size is 0.875rems.
562 let default_font_size_scale = 14. / ui::BASE_REM_SIZE_IN_PX;
563
564 // We then determine the delta between a single rem and the default font
565 // size scale.
566 let default_font_size_delta = 1. - default_font_size_scale;
567
568 // Finally, we add this delta to 1rem to get the scale factor that
569 // should be used to scale up the UI.
570 1. + default_font_size_delta
571 };
572
573 Some(buffer_font_size * rem_size_scale)
574 }
575}
576
577impl Element for TerminalElement {
578 type RequestLayoutState = ();
579 type PrepaintState = LayoutState;
580
581 fn id(&self) -> Option<ElementId> {
582 self.interactivity.element_id.clone()
583 }
584
585 fn request_layout(
586 &mut self,
587 global_id: Option<&GlobalElementId>,
588 window: &mut Window,
589 cx: &mut App,
590 ) -> (LayoutId, Self::RequestLayoutState) {
591 let layout_id =
592 self.interactivity
593 .request_layout(global_id, window, cx, |mut style, window, cx| {
594 style.size.width = relative(1.).into();
595 style.size.height = relative(1.).into();
596 // style.overflow = point(Overflow::Hidden, Overflow::Hidden);
597
598 window.request_layout(style, None, cx)
599 });
600 (layout_id, ())
601 }
602
603 fn prepaint(
604 &mut self,
605 global_id: Option<&GlobalElementId>,
606 bounds: Bounds<Pixels>,
607 _: &mut Self::RequestLayoutState,
608 window: &mut Window,
609 cx: &mut App,
610 ) -> Self::PrepaintState {
611 let rem_size = self.rem_size(cx);
612 self.interactivity.prepaint(
613 global_id,
614 bounds,
615 bounds.size,
616 window,
617 cx,
618 |_, _, hitbox, window, cx| {
619 let hitbox = hitbox.unwrap();
620 let settings = ThemeSettings::get_global(cx).clone();
621
622 let buffer_font_size = settings.buffer_font_size();
623
624 let terminal_settings = TerminalSettings::get_global(cx);
625
626 let font_family = terminal_settings
627 .font_family
628 .as_ref()
629 .unwrap_or(&settings.buffer_font.family)
630 .clone();
631
632 let font_fallbacks = terminal_settings
633 .font_fallbacks
634 .as_ref()
635 .or(settings.buffer_font.fallbacks.as_ref())
636 .cloned();
637
638 let font_features = terminal_settings
639 .font_features
640 .as_ref()
641 .unwrap_or(&settings.buffer_font.features)
642 .clone();
643
644 let font_weight = terminal_settings.font_weight.unwrap_or_default();
645
646 let line_height = terminal_settings.line_height.value();
647 let font_size = terminal_settings.font_size;
648
649 let font_size = font_size.unwrap_or(buffer_font_size);
650
651 let theme = cx.theme().clone();
652
653 let link_style = HighlightStyle {
654 color: Some(theme.colors().link_text_hover),
655 font_weight: Some(font_weight),
656 font_style: None,
657 background_color: None,
658 underline: Some(UnderlineStyle {
659 thickness: px(1.0),
660 color: Some(theme.colors().link_text_hover),
661 wavy: false,
662 }),
663 strikethrough: None,
664 fade_out: None,
665 };
666
667 let text_style = TextStyle {
668 font_family,
669 font_features,
670 font_weight,
671 font_fallbacks,
672 font_size: font_size.into(),
673 font_style: FontStyle::Normal,
674 line_height: line_height.into(),
675 background_color: Some(theme.colors().terminal_ansi_background),
676 white_space: WhiteSpace::Normal,
677 truncate: None,
678 // These are going to be overridden per-cell
679 underline: None,
680 strikethrough: None,
681 color: theme.colors().terminal_foreground,
682 };
683
684 let text_system = cx.text_system();
685 let player_color = theme.players().local();
686 let match_color = theme.colors().search_match_background;
687 let gutter;
688 let dimensions = {
689 let rem_size = window.rem_size();
690 let font_pixels = text_style.font_size.to_pixels(rem_size);
691 let line_height = font_pixels * line_height.to_pixels(rem_size);
692 let font_id = cx.text_system().resolve_font(&text_style.font());
693
694 let cell_width = text_system
695 .advance(font_id, font_pixels, 'm')
696 .unwrap()
697 .width;
698 gutter = cell_width;
699
700 let mut size = bounds.size;
701 size.width -= gutter;
702
703 // https://github.com/zed-industries/zed/issues/2750
704 // if the terminal is one column wide, rendering 🦀
705 // causes alacritty to misbehave.
706 if size.width < cell_width * 2.0 {
707 size.width = cell_width * 2.0;
708 }
709
710 TerminalSize::new(line_height, cell_width, size)
711 };
712
713 let search_matches = self.terminal.read(cx).matches.clone();
714
715 let background_color = theme.colors().terminal_background;
716
717 let last_hovered_word = self.terminal.update(cx, |terminal, cx| {
718 terminal.set_size(dimensions);
719 terminal.sync(cx);
720 if self.can_navigate_to_selected_word
721 && terminal.can_navigate_to_selected_word()
722 {
723 terminal.last_content.last_hovered_word.clone()
724 } else {
725 None
726 }
727 });
728
729 let scroll_top = self.terminal_view.read(cx).scroll_top;
730 let hyperlink_tooltip = last_hovered_word.clone().map(|hovered_word| {
731 let offset = bounds.origin + point(gutter, px(0.)) - point(px(0.), scroll_top);
732 let mut element = div()
733 .size_full()
734 .id("terminal-element")
735 .tooltip(Tooltip::text(hovered_word.word.clone()))
736 .into_any_element();
737 element.prepaint_as_root(offset, bounds.size.into(), window, cx);
738 element
739 });
740
741 let TerminalContent {
742 cells,
743 mode,
744 display_offset,
745 cursor_char,
746 selection,
747 cursor,
748 ..
749 } = &self.terminal.read(cx).last_content;
750 let mode = *mode;
751 let display_offset = *display_offset;
752
753 // searches, highlights to a single range representations
754 let mut relative_highlighted_ranges = Vec::new();
755 for search_match in search_matches {
756 relative_highlighted_ranges.push((search_match, match_color))
757 }
758 if let Some(selection) = selection {
759 relative_highlighted_ranges
760 .push((selection.start..=selection.end, player_color.selection));
761 }
762
763 // then have that representation be converted to the appropriate highlight data structure
764
765 let (cells, rects) = TerminalElement::layout_grid(
766 cells.iter().cloned(),
767 &text_style,
768 window.text_system(),
769 last_hovered_word
770 .as_ref()
771 .map(|last_hovered_word| (link_style, &last_hovered_word.word_match)),
772 window,
773 cx,
774 );
775
776 // Layout cursor. Rectangle is used for IME, so we should lay it out even
777 // if we don't end up showing it.
778 let cursor = if let AlacCursorShape::Hidden = cursor.shape {
779 None
780 } else {
781 let cursor_point = DisplayCursor::from(cursor.point, display_offset);
782 let cursor_text = {
783 let str_trxt = cursor_char.to_string();
784 let len = str_trxt.len();
785 window
786 .text_system()
787 .shape_line(
788 str_trxt.into(),
789 text_style.font_size.to_pixels(window.rem_size()),
790 &[TextRun {
791 len,
792 font: text_style.font(),
793 color: theme.colors().terminal_ansi_background,
794 background_color: None,
795 underline: Default::default(),
796 strikethrough: None,
797 }],
798 )
799 .unwrap()
800 };
801
802 let focused = self.focused;
803 TerminalElement::shape_cursor(cursor_point, dimensions, &cursor_text).map(
804 move |(cursor_position, block_width)| {
805 let (shape, text) = match cursor.shape {
806 AlacCursorShape::Block if !focused => (CursorShape::Hollow, None),
807 AlacCursorShape::Block => (CursorShape::Block, Some(cursor_text)),
808 AlacCursorShape::Underline => (CursorShape::Underline, None),
809 AlacCursorShape::Beam => (CursorShape::Bar, None),
810 AlacCursorShape::HollowBlock => (CursorShape::Hollow, None),
811 //This case is handled in the if wrapping the whole cursor layout
812 AlacCursorShape::Hidden => unreachable!(),
813 };
814
815 CursorLayout::new(
816 cursor_position,
817 block_width,
818 dimensions.line_height,
819 theme.players().local().cursor,
820 shape,
821 text,
822 )
823 },
824 )
825 };
826
827 let block_below_cursor_element = if let Some(block) = &self.block_below_cursor {
828 let terminal = self.terminal.read(cx);
829 if terminal.last_content.display_offset == 0 {
830 let target_line = terminal.last_content.cursor.point.line.0 + 1;
831 let render = &block.render;
832 let mut block_cx = BlockContext {
833 window,
834 context: cx,
835 dimensions,
836 };
837 let element = render(&mut block_cx);
838 let mut element = div().occlude().child(element).into_any_element();
839 let available_space = size(
840 AvailableSpace::Definite(dimensions.width() + gutter),
841 AvailableSpace::Definite(
842 block.height as f32 * dimensions.line_height(),
843 ),
844 );
845 let origin = bounds.origin
846 + point(px(0.), target_line as f32 * dimensions.line_height())
847 - point(px(0.), scroll_top);
848 window.with_rem_size(rem_size, |window| {
849 element.prepaint_as_root(origin, available_space, window, cx);
850 });
851 Some(element)
852 } else {
853 None
854 }
855 } else {
856 None
857 };
858
859 LayoutState {
860 hitbox,
861 cells,
862 cursor,
863 background_color,
864 dimensions,
865 rects,
866 relative_highlighted_ranges,
867 mode,
868 display_offset,
869 hyperlink_tooltip,
870 gutter,
871 last_hovered_word,
872 block_below_cursor_element,
873 }
874 },
875 )
876 }
877
878 fn paint(
879 &mut self,
880 global_id: Option<&GlobalElementId>,
881 bounds: Bounds<Pixels>,
882 _: &mut Self::RequestLayoutState,
883 layout: &mut Self::PrepaintState,
884 window: &mut Window,
885 cx: &mut App,
886 ) {
887 window.with_content_mask(Some(ContentMask { bounds }), |window| {
888 let scroll_top = self.terminal_view.read(cx).scroll_top;
889
890 window.paint_quad(fill(bounds, layout.background_color));
891 let origin =
892 bounds.origin + Point::new(layout.gutter, px(0.)) - Point::new(px(0.), scroll_top);
893
894 let terminal_input_handler = TerminalInputHandler {
895 terminal: self.terminal.clone(),
896 cursor_bounds: layout
897 .cursor
898 .as_ref()
899 .map(|cursor| cursor.bounding_rect(origin)),
900 workspace: self.workspace.clone(),
901 };
902
903 self.register_mouse_listeners(origin, layout.mode, &layout.hitbox, window);
904 if self.can_navigate_to_selected_word && layout.last_hovered_word.is_some() {
905 window.set_cursor_style(gpui::CursorStyle::PointingHand, &layout.hitbox);
906 } else {
907 window.set_cursor_style(gpui::CursorStyle::IBeam, &layout.hitbox);
908 }
909
910 let cursor = layout.cursor.take();
911 let hyperlink_tooltip = layout.hyperlink_tooltip.take();
912 let block_below_cursor_element = layout.block_below_cursor_element.take();
913 self.interactivity.paint(
914 global_id,
915 bounds,
916 Some(&layout.hitbox),
917 window,
918 cx,
919 |_, window, cx| {
920 window.handle_input(&self.focus, terminal_input_handler, cx);
921
922 window.on_key_event({
923 let this = self.terminal.clone();
924 move |event: &ModifiersChangedEvent, phase, window, cx| {
925 if phase != DispatchPhase::Bubble {
926 return;
927 }
928
929 let handled = this
930 .update(cx, |term, _| term.try_modifiers_change(&event.modifiers));
931
932 if handled {
933 window.refresh();
934 }
935 }
936 });
937
938 for rect in &layout.rects {
939 rect.paint(origin, &layout.dimensions, window);
940 }
941
942 for (relative_highlighted_range, color) in
943 layout.relative_highlighted_ranges.iter()
944 {
945 if let Some((start_y, highlighted_range_lines)) =
946 to_highlighted_range_lines(relative_highlighted_range, layout, origin)
947 {
948 let hr = HighlightedRange {
949 start_y,
950 line_height: layout.dimensions.line_height,
951 lines: highlighted_range_lines,
952 color: *color,
953 corner_radius: 0.15 * layout.dimensions.line_height,
954 };
955 hr.paint(bounds, window);
956 }
957 }
958
959 for cell in &layout.cells {
960 cell.paint(origin, &layout.dimensions, bounds, window, cx);
961 }
962
963 if self.cursor_visible {
964 if let Some(mut cursor) = cursor {
965 cursor.paint(origin, window, cx);
966 }
967 }
968
969 if let Some(mut element) = block_below_cursor_element {
970 element.paint(window, cx);
971 }
972
973 if let Some(mut element) = hyperlink_tooltip {
974 element.paint(window, cx);
975 }
976 },
977 );
978 });
979 }
980}
981
982impl IntoElement for TerminalElement {
983 type Element = Self;
984
985 fn into_element(self) -> Self::Element {
986 self
987 }
988}
989
990struct TerminalInputHandler {
991 terminal: Entity<Terminal>,
992 workspace: WeakEntity<Workspace>,
993 cursor_bounds: Option<Bounds<Pixels>>,
994}
995
996impl InputHandler for TerminalInputHandler {
997 fn selected_text_range(
998 &mut self,
999 _ignore_disabled_input: bool,
1000 _: &mut Window,
1001 cx: &mut App,
1002 ) -> Option<UTF16Selection> {
1003 if self
1004 .terminal
1005 .read(cx)
1006 .last_content
1007 .mode
1008 .contains(TermMode::ALT_SCREEN)
1009 {
1010 None
1011 } else {
1012 Some(UTF16Selection {
1013 range: 0..0,
1014 reversed: false,
1015 })
1016 }
1017 }
1018
1019 fn marked_text_range(&mut self, _: &mut Window, _: &mut App) -> Option<std::ops::Range<usize>> {
1020 None
1021 }
1022
1023 fn text_for_range(
1024 &mut self,
1025 _: std::ops::Range<usize>,
1026 _: &mut Option<std::ops::Range<usize>>,
1027 _: &mut Window,
1028 _: &mut App,
1029 ) -> Option<String> {
1030 None
1031 }
1032
1033 fn replace_text_in_range(
1034 &mut self,
1035 _replacement_range: Option<std::ops::Range<usize>>,
1036 text: &str,
1037 window: &mut Window,
1038 cx: &mut App,
1039 ) {
1040 self.terminal.update(cx, |terminal, _| {
1041 terminal.input(text.into());
1042 });
1043
1044 self.workspace
1045 .update(cx, |this, cx| {
1046 window.invalidate_character_coordinates();
1047 let project = this.project().read(cx);
1048 let telemetry = project.client().telemetry().clone();
1049 telemetry.log_edit_event("terminal", project.is_via_ssh());
1050 })
1051 .ok();
1052 }
1053
1054 fn replace_and_mark_text_in_range(
1055 &mut self,
1056 _range_utf16: Option<std::ops::Range<usize>>,
1057 _new_text: &str,
1058 _new_selected_range: Option<std::ops::Range<usize>>,
1059 _window: &mut Window,
1060 _cx: &mut App,
1061 ) {
1062 }
1063
1064 fn unmark_text(&mut self, _window: &mut Window, _cx: &mut App) {}
1065
1066 fn bounds_for_range(
1067 &mut self,
1068 _range_utf16: std::ops::Range<usize>,
1069 _window: &mut Window,
1070 _cx: &mut App,
1071 ) -> Option<Bounds<Pixels>> {
1072 self.cursor_bounds
1073 }
1074
1075 fn apple_press_and_hold_enabled(&mut self) -> bool {
1076 false
1077 }
1078
1079 fn character_index_for_point(
1080 &mut self,
1081 _point: Point<Pixels>,
1082 _window: &mut Window,
1083 _cx: &mut App,
1084 ) -> Option<usize> {
1085 None
1086 }
1087}
1088
1089pub fn is_blank(cell: &IndexedCell) -> bool {
1090 if cell.c != ' ' {
1091 return false;
1092 }
1093
1094 if cell.bg != AnsiColor::Named(NamedColor::Background) {
1095 return false;
1096 }
1097
1098 if cell.hyperlink().is_some() {
1099 return false;
1100 }
1101
1102 if cell
1103 .flags
1104 .intersects(Flags::ALL_UNDERLINES | Flags::INVERSE | Flags::STRIKEOUT)
1105 {
1106 return false;
1107 }
1108
1109 true
1110}
1111
1112fn to_highlighted_range_lines(
1113 range: &RangeInclusive<AlacPoint>,
1114 layout: &LayoutState,
1115 origin: Point<Pixels>,
1116) -> Option<(Pixels, Vec<HighlightedRangeLine>)> {
1117 // Step 1. Normalize the points to be viewport relative.
1118 // When display_offset = 1, here's how the grid is arranged:
1119 //-2,0 -2,1...
1120 //--- Viewport top
1121 //-1,0 -1,1...
1122 //--------- Terminal Top
1123 // 0,0 0,1...
1124 // 1,0 1,1...
1125 //--- Viewport Bottom
1126 // 2,0 2,1...
1127 //--------- Terminal Bottom
1128
1129 // Normalize to viewport relative, from terminal relative.
1130 // lines are i32s, which are negative above the top left corner of the terminal
1131 // If the user has scrolled, we use the display_offset to tell us which offset
1132 // of the grid data we should be looking at. But for the rendering step, we don't
1133 // want negatives. We want things relative to the 'viewport' (the area of the grid
1134 // which is currently shown according to the display offset)
1135 let unclamped_start = AlacPoint::new(
1136 range.start().line + layout.display_offset,
1137 range.start().column,
1138 );
1139 let unclamped_end =
1140 AlacPoint::new(range.end().line + layout.display_offset, range.end().column);
1141
1142 // Step 2. Clamp range to viewport, and return None if it doesn't overlap
1143 if unclamped_end.line.0 < 0 || unclamped_start.line.0 > layout.dimensions.num_lines() as i32 {
1144 return None;
1145 }
1146
1147 let clamped_start_line = unclamped_start.line.0.max(0) as usize;
1148 let clamped_end_line = unclamped_end
1149 .line
1150 .0
1151 .min(layout.dimensions.num_lines() as i32) as usize;
1152 //Convert the start of the range to pixels
1153 let start_y = origin.y + clamped_start_line as f32 * layout.dimensions.line_height;
1154
1155 // Step 3. Expand ranges that cross lines into a collection of single-line ranges.
1156 // (also convert to pixels)
1157 let mut highlighted_range_lines = Vec::new();
1158 for line in clamped_start_line..=clamped_end_line {
1159 let mut line_start = 0;
1160 let mut line_end = layout.dimensions.columns();
1161
1162 if line == clamped_start_line {
1163 line_start = unclamped_start.column.0;
1164 }
1165 if line == clamped_end_line {
1166 line_end = unclamped_end.column.0 + 1; // +1 for inclusive
1167 }
1168
1169 highlighted_range_lines.push(HighlightedRangeLine {
1170 start_x: origin.x + line_start as f32 * layout.dimensions.cell_width,
1171 end_x: origin.x + line_end as f32 * layout.dimensions.cell_width,
1172 });
1173 }
1174
1175 Some((start_y, highlighted_range_lines))
1176}
1177
1178/// Converts a 2, 8, or 24 bit color ANSI color to the GPUI equivalent.
1179pub fn convert_color(fg: &terminal::alacritty_terminal::vte::ansi::Color, theme: &Theme) -> Hsla {
1180 let colors = theme.colors();
1181 match fg {
1182 // Named and theme defined colors
1183 terminal::alacritty_terminal::vte::ansi::Color::Named(n) => match n {
1184 NamedColor::Black => colors.terminal_ansi_black,
1185 NamedColor::Red => colors.terminal_ansi_red,
1186 NamedColor::Green => colors.terminal_ansi_green,
1187 NamedColor::Yellow => colors.terminal_ansi_yellow,
1188 NamedColor::Blue => colors.terminal_ansi_blue,
1189 NamedColor::Magenta => colors.terminal_ansi_magenta,
1190 NamedColor::Cyan => colors.terminal_ansi_cyan,
1191 NamedColor::White => colors.terminal_ansi_white,
1192 NamedColor::BrightBlack => colors.terminal_ansi_bright_black,
1193 NamedColor::BrightRed => colors.terminal_ansi_bright_red,
1194 NamedColor::BrightGreen => colors.terminal_ansi_bright_green,
1195 NamedColor::BrightYellow => colors.terminal_ansi_bright_yellow,
1196 NamedColor::BrightBlue => colors.terminal_ansi_bright_blue,
1197 NamedColor::BrightMagenta => colors.terminal_ansi_bright_magenta,
1198 NamedColor::BrightCyan => colors.terminal_ansi_bright_cyan,
1199 NamedColor::BrightWhite => colors.terminal_ansi_bright_white,
1200 NamedColor::Foreground => colors.terminal_foreground,
1201 NamedColor::Background => colors.terminal_ansi_background,
1202 NamedColor::Cursor => theme.players().local().cursor,
1203 NamedColor::DimBlack => colors.terminal_ansi_dim_black,
1204 NamedColor::DimRed => colors.terminal_ansi_dim_red,
1205 NamedColor::DimGreen => colors.terminal_ansi_dim_green,
1206 NamedColor::DimYellow => colors.terminal_ansi_dim_yellow,
1207 NamedColor::DimBlue => colors.terminal_ansi_dim_blue,
1208 NamedColor::DimMagenta => colors.terminal_ansi_dim_magenta,
1209 NamedColor::DimCyan => colors.terminal_ansi_dim_cyan,
1210 NamedColor::DimWhite => colors.terminal_ansi_dim_white,
1211 NamedColor::BrightForeground => colors.terminal_bright_foreground,
1212 NamedColor::DimForeground => colors.terminal_dim_foreground,
1213 },
1214 // 'True' colors
1215 terminal::alacritty_terminal::vte::ansi::Color::Spec(rgb) => {
1216 terminal::rgba_color(rgb.r, rgb.g, rgb.b)
1217 }
1218 // 8 bit, indexed colors
1219 terminal::alacritty_terminal::vte::ansi::Color::Indexed(i) => {
1220 terminal::get_color_at_index(*i as usize, theme)
1221 }
1222 }
1223}