1use editor::{Cursor, HighlightedRange, HighlightedRangeLine};
2use gpui::{
3 color::Color,
4 elements::{Empty, Overlay},
5 fonts::{HighlightStyle, Properties, Style::Italic, TextStyle, Underline, Weight},
6 geometry::{
7 rect::RectF,
8 vector::{vec2f, Vector2F},
9 },
10 platform::{CursorStyle, MouseButton},
11 serde_json::json,
12 text_layout::{Line, RunStyle},
13 AnyElement, Element, EventContext, FontCache, LayoutContext, ModelContext, MouseRegion, Quad,
14 SceneBuilder, SizeConstraint, TextLayoutCache, ViewContext, WeakModelHandle,
15};
16use itertools::Itertools;
17use language::CursorShape;
18use ordered_float::OrderedFloat;
19use terminal::{
20 alacritty_terminal::{
21 ansi::{Color as AnsiColor, Color::Named, CursorShape as AlacCursorShape, NamedColor},
22 grid::Dimensions,
23 index::Point,
24 term::{cell::Flags, TermMode},
25 },
26 mappings::colors::convert_color,
27 IndexedCell, Terminal, TerminalContent, TerminalSettings, TerminalSize,
28};
29use theme::{TerminalStyle, ThemeSettings};
30use util::ResultExt;
31
32use std::{fmt::Debug, ops::RangeInclusive};
33use std::{mem, ops::Range};
34
35use crate::TerminalView;
36
37///The information generated during layout that is necessary for painting
38pub struct LayoutState {
39 cells: Vec<LayoutCell>,
40 rects: Vec<LayoutRect>,
41 relative_highlighted_ranges: Vec<(RangeInclusive<Point>, Color)>,
42 cursor: Option<Cursor>,
43 background_color: Color,
44 size: TerminalSize,
45 mode: TermMode,
46 display_offset: usize,
47 hyperlink_tooltip: Option<AnyElement<TerminalView>>,
48 gutter: f32,
49}
50
51///Helper struct for converting data between alacritty's cursor points, and displayed cursor points
52struct DisplayCursor {
53 line: i32,
54 col: usize,
55}
56
57impl DisplayCursor {
58 fn from(cursor_point: Point, display_offset: usize) -> Self {
59 Self {
60 line: cursor_point.line.0 + display_offset as i32,
61 col: cursor_point.column.0,
62 }
63 }
64
65 pub fn line(&self) -> i32 {
66 self.line
67 }
68
69 pub fn col(&self) -> usize {
70 self.col
71 }
72}
73
74#[derive(Clone, Debug, Default)]
75struct LayoutCell {
76 point: Point<i32, i32>,
77 text: Line,
78}
79
80impl LayoutCell {
81 fn new(point: Point<i32, i32>, text: Line) -> LayoutCell {
82 LayoutCell { point, text }
83 }
84
85 fn paint(
86 &self,
87 scene: &mut SceneBuilder,
88 origin: Vector2F,
89 layout: &LayoutState,
90 visible_bounds: RectF,
91 _view: &mut TerminalView,
92 cx: &mut ViewContext<TerminalView>,
93 ) {
94 let pos = {
95 let point = self.point;
96 vec2f(
97 (origin.x() + point.column as f32 * layout.size.cell_width).floor(),
98 origin.y() + point.line as f32 * layout.size.line_height,
99 )
100 };
101
102 self.text
103 .paint(scene, pos, visible_bounds, layout.size.line_height, cx);
104 }
105}
106
107#[derive(Clone, Debug, Default)]
108struct LayoutRect {
109 point: Point<i32, i32>,
110 num_of_cells: usize,
111 color: Color,
112}
113
114impl LayoutRect {
115 fn new(point: Point<i32, i32>, num_of_cells: usize, color: Color) -> LayoutRect {
116 LayoutRect {
117 point,
118 num_of_cells,
119 color,
120 }
121 }
122
123 fn extend(&self) -> Self {
124 LayoutRect {
125 point: self.point,
126 num_of_cells: self.num_of_cells + 1,
127 color: self.color,
128 }
129 }
130
131 fn paint(
132 &self,
133 scene: &mut SceneBuilder,
134 origin: Vector2F,
135 layout: &LayoutState,
136 _view: &mut TerminalView,
137 _cx: &mut ViewContext<TerminalView>,
138 ) {
139 let position = {
140 let point = self.point;
141 vec2f(
142 (origin.x() + point.column as f32 * layout.size.cell_width).floor(),
143 origin.y() + point.line as f32 * layout.size.line_height,
144 )
145 };
146 let size = vec2f(
147 (layout.size.cell_width * self.num_of_cells as f32).ceil(),
148 layout.size.line_height,
149 );
150
151 scene.push_quad(Quad {
152 bounds: RectF::new(position, size),
153 background: Some(self.color),
154 border: Default::default(),
155 corner_radius: 0.,
156 })
157 }
158}
159
160///The GPUI element that paints the terminal.
161///We need to keep a reference to the view for mouse events, do we need it for any other terminal stuff, or can we move that to connection?
162pub struct TerminalElement {
163 terminal: WeakModelHandle<Terminal>,
164 focused: bool,
165 cursor_visible: bool,
166}
167
168impl TerminalElement {
169 pub fn new(
170 terminal: WeakModelHandle<Terminal>,
171 focused: bool,
172 cursor_visible: bool,
173 ) -> TerminalElement {
174 TerminalElement {
175 terminal,
176 focused,
177 cursor_visible,
178 }
179 }
180
181 //Vec<Range<Point>> -> Clip out the parts of the ranges
182
183 fn layout_grid(
184 grid: &Vec<IndexedCell>,
185 text_style: &TextStyle,
186 terminal_theme: &TerminalStyle,
187 text_layout_cache: &TextLayoutCache,
188 font_cache: &FontCache,
189 hyperlink: Option<(HighlightStyle, &RangeInclusive<Point>)>,
190 ) -> (Vec<LayoutCell>, Vec<LayoutRect>) {
191 let mut cells = vec![];
192 let mut rects = vec![];
193
194 let mut cur_rect: Option<LayoutRect> = None;
195 let mut cur_alac_color = None;
196
197 let linegroups = grid.into_iter().group_by(|i| i.point.line);
198 for (line_index, (_, line)) in linegroups.into_iter().enumerate() {
199 for cell in line {
200 let mut fg = cell.fg;
201 let mut bg = cell.bg;
202 if cell.flags.contains(Flags::INVERSE) {
203 mem::swap(&mut fg, &mut bg);
204 }
205
206 //Expand background rect range
207 {
208 if matches!(bg, Named(NamedColor::Background)) {
209 //Continue to next cell, resetting variables if necessary
210 cur_alac_color = None;
211 if let Some(rect) = cur_rect {
212 rects.push(rect);
213 cur_rect = None
214 }
215 } else {
216 match cur_alac_color {
217 Some(cur_color) => {
218 if bg == cur_color {
219 cur_rect = cur_rect.take().map(|rect| rect.extend());
220 } else {
221 cur_alac_color = Some(bg);
222 if cur_rect.is_some() {
223 rects.push(cur_rect.take().unwrap());
224 }
225 cur_rect = Some(LayoutRect::new(
226 Point::new(line_index as i32, cell.point.column.0 as i32),
227 1,
228 convert_color(&bg, &terminal_theme),
229 ));
230 }
231 }
232 None => {
233 cur_alac_color = Some(bg);
234 cur_rect = Some(LayoutRect::new(
235 Point::new(line_index as i32, cell.point.column.0 as i32),
236 1,
237 convert_color(&bg, &terminal_theme),
238 ));
239 }
240 }
241 }
242 }
243
244 //Layout current cell text
245 {
246 let cell_text = &cell.c.to_string();
247 if !is_blank(&cell) {
248 let cell_style = TerminalElement::cell_style(
249 &cell,
250 fg,
251 terminal_theme,
252 text_style,
253 font_cache,
254 hyperlink,
255 );
256
257 let layout_cell = text_layout_cache.layout_str(
258 cell_text,
259 text_style.font_size,
260 &[(cell_text.len(), cell_style)],
261 );
262
263 cells.push(LayoutCell::new(
264 Point::new(line_index as i32, cell.point.column.0 as i32),
265 layout_cell,
266 ))
267 };
268 }
269 }
270
271 if cur_rect.is_some() {
272 rects.push(cur_rect.take().unwrap());
273 }
274 }
275 (cells, rects)
276 }
277
278 // Compute the cursor position and expected block width, may return a zero width if x_for_index returns
279 // the same position for sequential indexes. Use em_width instead
280 fn shape_cursor(
281 cursor_point: DisplayCursor,
282 size: TerminalSize,
283 text_fragment: &Line,
284 ) -> Option<(Vector2F, f32)> {
285 if cursor_point.line() < size.total_lines() as i32 {
286 let cursor_width = if text_fragment.width() == 0. {
287 size.cell_width()
288 } else {
289 text_fragment.width()
290 };
291
292 //Cursor should always surround as much of the text as possible,
293 //hence when on pixel boundaries round the origin down and the width up
294 Some((
295 vec2f(
296 (cursor_point.col() as f32 * size.cell_width()).floor(),
297 (cursor_point.line() as f32 * size.line_height()).floor(),
298 ),
299 cursor_width.ceil(),
300 ))
301 } else {
302 None
303 }
304 }
305
306 ///Convert the Alacritty cell styles to GPUI text styles and background color
307 fn cell_style(
308 indexed: &IndexedCell,
309 fg: terminal::alacritty_terminal::ansi::Color,
310 style: &TerminalStyle,
311 text_style: &TextStyle,
312 font_cache: &FontCache,
313 hyperlink: Option<(HighlightStyle, &RangeInclusive<Point>)>,
314 ) -> RunStyle {
315 let flags = indexed.cell.flags;
316 let fg = convert_color(&fg, &style);
317
318 let mut underline = flags
319 .intersects(Flags::ALL_UNDERLINES)
320 .then(|| Underline {
321 color: Some(fg),
322 squiggly: flags.contains(Flags::UNDERCURL),
323 thickness: OrderedFloat(1.),
324 })
325 .unwrap_or_default();
326
327 if indexed.cell.hyperlink().is_some() {
328 if underline.thickness == OrderedFloat(0.) {
329 underline.thickness = OrderedFloat(1.);
330 }
331 }
332
333 let mut properties = Properties::new();
334 if indexed.flags.intersects(Flags::BOLD | Flags::DIM_BOLD) {
335 properties = *properties.weight(Weight::BOLD);
336 }
337 if indexed.flags.intersects(Flags::ITALIC) {
338 properties = *properties.style(Italic);
339 }
340
341 let font_id = font_cache
342 .select_font(text_style.font_family_id, &properties)
343 .unwrap_or(text_style.font_id);
344
345 let mut result = RunStyle {
346 color: fg,
347 font_id,
348 underline,
349 };
350
351 if let Some((style, range)) = hyperlink {
352 if range.contains(&indexed.point) {
353 if let Some(underline) = style.underline {
354 result.underline = underline;
355 }
356
357 if let Some(color) = style.color {
358 result.color = color;
359 }
360 }
361 }
362
363 result
364 }
365
366 fn generic_button_handler<E>(
367 connection: WeakModelHandle<Terminal>,
368 origin: Vector2F,
369 f: impl Fn(&mut Terminal, Vector2F, E, &mut ModelContext<Terminal>),
370 ) -> impl Fn(E, &mut TerminalView, &mut EventContext<TerminalView>) {
371 move |event, _: &mut TerminalView, cx| {
372 cx.focus_parent();
373 if let Some(conn_handle) = connection.upgrade(cx) {
374 conn_handle.update(cx, |terminal, cx| {
375 f(terminal, origin, event, cx);
376
377 cx.notify();
378 })
379 }
380 }
381 }
382
383 fn attach_mouse_handlers(
384 &self,
385 scene: &mut SceneBuilder,
386 origin: Vector2F,
387 visible_bounds: RectF,
388 mode: TermMode,
389 cx: &mut ViewContext<TerminalView>,
390 ) {
391 let connection = self.terminal;
392
393 let mut region = MouseRegion::new::<Self>(cx.view_id(), 0, visible_bounds);
394
395 // Terminal Emulator controlled behavior:
396 region = region
397 // Start selections
398 .on_down(MouseButton::Left, move |event, v: &mut TerminalView, cx| {
399 cx.focus_parent();
400 v.context_menu.update(cx, |menu, _cx| menu.delay_cancel());
401 if let Some(conn_handle) = connection.upgrade(cx) {
402 conn_handle.update(cx, |terminal, cx| {
403 terminal.mouse_down(&event, origin);
404
405 cx.notify();
406 })
407 }
408 })
409 // Update drag selections
410 .on_drag(MouseButton::Left, move |event, _: &mut TerminalView, cx| {
411 if cx.is_self_focused() {
412 if let Some(conn_handle) = connection.upgrade(cx) {
413 conn_handle.update(cx, |terminal, cx| {
414 terminal.mouse_drag(event, origin);
415 cx.notify();
416 })
417 }
418 }
419 })
420 // Copy on up behavior
421 .on_up(
422 MouseButton::Left,
423 TerminalElement::generic_button_handler(
424 connection,
425 origin,
426 move |terminal, origin, e, cx| {
427 terminal.mouse_up(&e, origin, cx);
428 },
429 ),
430 )
431 // Context menu
432 .on_click(
433 MouseButton::Right,
434 move |event, view: &mut TerminalView, cx| {
435 let mouse_mode = if let Some(conn_handle) = connection.upgrade(cx) {
436 conn_handle.update(cx, |terminal, _cx| terminal.mouse_mode(event.shift))
437 } else {
438 // If we can't get the model handle, probably can't deploy the context menu
439 true
440 };
441 if !mouse_mode {
442 view.deploy_context_menu(event.position, cx);
443 }
444 },
445 )
446 .on_move(move |event, _: &mut TerminalView, cx| {
447 if cx.is_self_focused() {
448 if let Some(conn_handle) = connection.upgrade(cx) {
449 conn_handle.update(cx, |terminal, cx| {
450 terminal.mouse_move(&event, origin);
451 cx.notify();
452 })
453 }
454 }
455 })
456 .on_scroll(move |event, _: &mut TerminalView, cx| {
457 if let Some(conn_handle) = connection.upgrade(cx) {
458 conn_handle.update(cx, |terminal, cx| {
459 terminal.scroll_wheel(event, origin);
460 cx.notify();
461 })
462 }
463 });
464
465 // Mouse mode handlers:
466 // All mouse modes need the extra click handlers
467 if mode.intersects(TermMode::MOUSE_MODE) {
468 region = region
469 .on_down(
470 MouseButton::Right,
471 TerminalElement::generic_button_handler(
472 connection,
473 origin,
474 move |terminal, origin, e, _cx| {
475 terminal.mouse_down(&e, origin);
476 },
477 ),
478 )
479 .on_down(
480 MouseButton::Middle,
481 TerminalElement::generic_button_handler(
482 connection,
483 origin,
484 move |terminal, origin, e, _cx| {
485 terminal.mouse_down(&e, origin);
486 },
487 ),
488 )
489 .on_up(
490 MouseButton::Right,
491 TerminalElement::generic_button_handler(
492 connection,
493 origin,
494 move |terminal, origin, e, cx| {
495 terminal.mouse_up(&e, origin, cx);
496 },
497 ),
498 )
499 .on_up(
500 MouseButton::Middle,
501 TerminalElement::generic_button_handler(
502 connection,
503 origin,
504 move |terminal, origin, e, cx| {
505 terminal.mouse_up(&e, origin, cx);
506 },
507 ),
508 )
509 }
510
511 scene.push_mouse_region(region);
512 }
513}
514
515impl Element<TerminalView> for TerminalElement {
516 type LayoutState = LayoutState;
517 type PaintState = ();
518
519 fn layout(
520 &mut self,
521 constraint: gpui::SizeConstraint,
522 view: &mut TerminalView,
523 cx: &mut LayoutContext<TerminalView>,
524 ) -> (gpui::geometry::vector::Vector2F, Self::LayoutState) {
525 let settings = settings::get::<ThemeSettings>(cx);
526 let terminal_settings = settings::get::<TerminalSettings>(cx);
527
528 //Setup layout information
529 let terminal_theme = settings.theme.terminal.clone(); //TODO: Try to minimize this clone.
530 let link_style = settings.theme.editor.link_definition;
531 let tooltip_style = settings.theme.tooltip.clone();
532
533 let font_cache = cx.font_cache();
534 let font_size = terminal_settings
535 .font_size(cx)
536 .unwrap_or(settings.buffer_font_size(cx));
537 let font_family_name = terminal_settings
538 .font_family
539 .as_ref()
540 .unwrap_or(&settings.buffer_font_family_name);
541 let font_features = terminal_settings
542 .font_features
543 .as_ref()
544 .unwrap_or(&settings.buffer_font_features);
545 let family_id = font_cache
546 .load_family(&[font_family_name], &font_features)
547 .log_err()
548 .unwrap_or(settings.buffer_font_family);
549 let font_id = font_cache
550 .select_font(family_id, &Default::default())
551 .unwrap();
552
553 let text_style = TextStyle {
554 color: settings.theme.editor.text_color,
555 font_family_id: family_id,
556 font_family_name: font_cache.family_name(family_id).unwrap(),
557 font_id,
558 font_size,
559 font_properties: Default::default(),
560 underline: Default::default(),
561 };
562 let selection_color = settings.theme.editor.selection.selection;
563 let match_color = settings.theme.search.match_background;
564 let gutter;
565 let dimensions = {
566 let line_height = text_style.font_size * terminal_settings.line_height.value();
567 let cell_width = font_cache.em_advance(text_style.font_id, text_style.font_size);
568 gutter = cell_width;
569
570 let size = constraint.max - vec2f(gutter, 0.);
571 TerminalSize::new(line_height, cell_width, size)
572 };
573
574 let search_matches = if let Some(terminal_model) = self.terminal.upgrade(cx) {
575 terminal_model.read(cx).matches.clone()
576 } else {
577 Default::default()
578 };
579
580 let background_color = terminal_theme.background;
581 let terminal_handle = self.terminal.upgrade(cx).unwrap();
582
583 let last_hovered_hyperlink = terminal_handle.update(cx, |terminal, cx| {
584 terminal.set_size(dimensions);
585 terminal.try_sync(cx);
586 terminal.last_content.last_hovered_hyperlink.clone()
587 });
588
589 let hyperlink_tooltip = last_hovered_hyperlink.map(|(uri, _, id)| {
590 let mut tooltip = Overlay::new(
591 Empty::new()
592 .contained()
593 .constrained()
594 .with_width(dimensions.width())
595 .with_height(dimensions.height())
596 .with_tooltip::<TerminalElement>(id, uri, None, tooltip_style, cx),
597 )
598 .with_position_mode(gpui::elements::OverlayPositionMode::Local)
599 .into_any();
600
601 tooltip.layout(
602 SizeConstraint::new(Vector2F::zero(), cx.window_size()),
603 view,
604 cx,
605 );
606 tooltip
607 });
608
609 let TerminalContent {
610 cells,
611 mode,
612 display_offset,
613 cursor_char,
614 selection,
615 cursor,
616 last_hovered_hyperlink,
617 ..
618 } = { &terminal_handle.read(cx).last_content };
619
620 // searches, highlights to a single range representations
621 let mut relative_highlighted_ranges = Vec::new();
622 for search_match in search_matches {
623 relative_highlighted_ranges.push((search_match, match_color))
624 }
625 if let Some(selection) = selection {
626 relative_highlighted_ranges.push((selection.start..=selection.end, selection_color));
627 }
628
629 // then have that representation be converted to the appropriate highlight data structure
630
631 let (cells, rects) = TerminalElement::layout_grid(
632 cells,
633 &text_style,
634 &terminal_theme,
635 cx.text_layout_cache(),
636 cx.font_cache(),
637 last_hovered_hyperlink
638 .as_ref()
639 .map(|(_, range, _)| (link_style, range)),
640 );
641
642 //Layout cursor. Rectangle is used for IME, so we should lay it out even
643 //if we don't end up showing it.
644 let cursor = if let AlacCursorShape::Hidden = cursor.shape {
645 None
646 } else {
647 let cursor_point = DisplayCursor::from(cursor.point, *display_offset);
648 let cursor_text = {
649 let str_trxt = cursor_char.to_string();
650
651 let color = if self.focused {
652 terminal_theme.background
653 } else {
654 terminal_theme.foreground
655 };
656
657 cx.text_layout_cache().layout_str(
658 &str_trxt,
659 text_style.font_size,
660 &[(
661 str_trxt.len(),
662 RunStyle {
663 font_id: text_style.font_id,
664 color,
665 underline: Default::default(),
666 },
667 )],
668 )
669 };
670
671 let focused = self.focused;
672 TerminalElement::shape_cursor(cursor_point, dimensions, &cursor_text).map(
673 move |(cursor_position, block_width)| {
674 let (shape, text) = match cursor.shape {
675 AlacCursorShape::Block if !focused => (CursorShape::Hollow, None),
676 AlacCursorShape::Block => (CursorShape::Block, Some(cursor_text)),
677 AlacCursorShape::Underline => (CursorShape::Underscore, None),
678 AlacCursorShape::Beam => (CursorShape::Bar, None),
679 AlacCursorShape::HollowBlock => (CursorShape::Hollow, None),
680 //This case is handled in the if wrapping the whole cursor layout
681 AlacCursorShape::Hidden => unreachable!(),
682 };
683
684 Cursor::new(
685 cursor_position,
686 block_width,
687 dimensions.line_height,
688 terminal_theme.cursor,
689 shape,
690 text,
691 )
692 },
693 )
694 };
695
696 //Done!
697 (
698 constraint.max,
699 LayoutState {
700 cells,
701 cursor,
702 background_color,
703 size: dimensions,
704 rects,
705 relative_highlighted_ranges,
706 mode: *mode,
707 display_offset: *display_offset,
708 hyperlink_tooltip,
709 gutter,
710 },
711 )
712 }
713
714 fn paint(
715 &mut self,
716 scene: &mut SceneBuilder,
717 bounds: RectF,
718 visible_bounds: RectF,
719 layout: &mut Self::LayoutState,
720 view: &mut TerminalView,
721 cx: &mut ViewContext<TerminalView>,
722 ) -> Self::PaintState {
723 let visible_bounds = bounds.intersection(visible_bounds).unwrap_or_default();
724
725 //Setup element stuff
726 let clip_bounds = Some(visible_bounds);
727
728 scene.paint_layer(clip_bounds, |scene| {
729 let origin = bounds.origin() + vec2f(layout.gutter, 0.);
730
731 // Elements are ephemeral, only at paint time do we know what could be clicked by a mouse
732 self.attach_mouse_handlers(scene, origin, visible_bounds, layout.mode, cx);
733
734 scene.push_cursor_region(gpui::CursorRegion {
735 bounds,
736 style: if layout.hyperlink_tooltip.is_some() {
737 CursorStyle::PointingHand
738 } else {
739 CursorStyle::IBeam
740 },
741 });
742
743 scene.paint_layer(clip_bounds, |scene| {
744 //Start with a background color
745 scene.push_quad(Quad {
746 bounds: RectF::new(bounds.origin(), bounds.size()),
747 background: Some(layout.background_color),
748 border: Default::default(),
749 corner_radius: 0.,
750 });
751
752 for rect in &layout.rects {
753 rect.paint(scene, origin, layout, view, cx)
754 }
755 });
756
757 //Draw Highlighted Backgrounds
758 scene.paint_layer(clip_bounds, |scene| {
759 for (relative_highlighted_range, color) in layout.relative_highlighted_ranges.iter()
760 {
761 if let Some((start_y, highlighted_range_lines)) =
762 to_highlighted_range_lines(relative_highlighted_range, layout, origin)
763 {
764 let hr = HighlightedRange {
765 start_y, //Need to change this
766 line_height: layout.size.line_height,
767 lines: highlighted_range_lines,
768 color: color.clone(),
769 //Copied from editor. TODO: move to theme or something
770 corner_radius: 0.15 * layout.size.line_height,
771 };
772 hr.paint(bounds, scene);
773 }
774 }
775 });
776
777 //Draw the text cells
778 scene.paint_layer(clip_bounds, |scene| {
779 for cell in &layout.cells {
780 cell.paint(scene, origin, layout, visible_bounds, view, cx);
781 }
782 });
783
784 //Draw cursor
785 if self.cursor_visible {
786 if let Some(cursor) = &layout.cursor {
787 scene.paint_layer(clip_bounds, |scene| {
788 cursor.paint(scene, origin, cx);
789 })
790 }
791 }
792
793 if let Some(element) = &mut layout.hyperlink_tooltip {
794 element.paint(scene, origin, visible_bounds, view, cx)
795 }
796 });
797 }
798
799 fn metadata(&self) -> Option<&dyn std::any::Any> {
800 None
801 }
802
803 fn debug(
804 &self,
805 _: RectF,
806 _: &Self::LayoutState,
807 _: &Self::PaintState,
808 _: &TerminalView,
809 _: &gpui::ViewContext<TerminalView>,
810 ) -> gpui::serde_json::Value {
811 json!({
812 "type": "TerminalElement",
813 })
814 }
815
816 fn rect_for_text_range(
817 &self,
818 _: Range<usize>,
819 bounds: RectF,
820 _: RectF,
821 layout: &Self::LayoutState,
822 _: &Self::PaintState,
823 _: &TerminalView,
824 _: &gpui::ViewContext<TerminalView>,
825 ) -> Option<RectF> {
826 // Use the same origin that's passed to `Cursor::paint` in the paint
827 // method bove.
828 let mut origin = bounds.origin() + vec2f(layout.size.cell_width, 0.);
829
830 // TODO - Why is it necessary to move downward one line to get correct
831 // positioning? I would think that we'd want the same rect that is
832 // painted for the cursor.
833 origin += vec2f(0., layout.size.line_height);
834
835 Some(layout.cursor.as_ref()?.bounding_rect(origin))
836 }
837}
838
839fn is_blank(cell: &IndexedCell) -> bool {
840 if cell.c != ' ' {
841 return false;
842 }
843
844 if cell.bg != AnsiColor::Named(NamedColor::Background) {
845 return false;
846 }
847
848 if cell.hyperlink().is_some() {
849 return false;
850 }
851
852 if cell
853 .flags
854 .intersects(Flags::ALL_UNDERLINES | Flags::INVERSE | Flags::STRIKEOUT)
855 {
856 return false;
857 }
858
859 return true;
860}
861
862fn to_highlighted_range_lines(
863 range: &RangeInclusive<Point>,
864 layout: &LayoutState,
865 origin: Vector2F,
866) -> Option<(f32, Vec<HighlightedRangeLine>)> {
867 // Step 1. Normalize the points to be viewport relative.
868 // When display_offset = 1, here's how the grid is arranged:
869 //-2,0 -2,1...
870 //--- Viewport top
871 //-1,0 -1,1...
872 //--------- Terminal Top
873 // 0,0 0,1...
874 // 1,0 1,1...
875 //--- Viewport Bottom
876 // 2,0 2,1...
877 //--------- Terminal Bottom
878
879 // Normalize to viewport relative, from terminal relative.
880 // lines are i32s, which are negative above the top left corner of the terminal
881 // If the user has scrolled, we use the display_offset to tell us which offset
882 // of the grid data we should be looking at. But for the rendering step, we don't
883 // want negatives. We want things relative to the 'viewport' (the area of the grid
884 // which is currently shown according to the display offset)
885 let unclamped_start = Point::new(
886 range.start().line + layout.display_offset,
887 range.start().column,
888 );
889 let unclamped_end = Point::new(range.end().line + layout.display_offset, range.end().column);
890
891 // Step 2. Clamp range to viewport, and return None if it doesn't overlap
892 if unclamped_end.line.0 < 0 || unclamped_start.line.0 > layout.size.num_lines() as i32 {
893 return None;
894 }
895
896 let clamped_start_line = unclamped_start.line.0.max(0) as usize;
897 let clamped_end_line = unclamped_end.line.0.min(layout.size.num_lines() as i32) as usize;
898 //Convert the start of the range to pixels
899 let start_y = origin.y() + clamped_start_line as f32 * layout.size.line_height;
900
901 // Step 3. Expand ranges that cross lines into a collection of single-line ranges.
902 // (also convert to pixels)
903 let mut highlighted_range_lines = Vec::new();
904 for line in clamped_start_line..=clamped_end_line {
905 let mut line_start = 0;
906 let mut line_end = layout.size.columns();
907
908 if line == clamped_start_line {
909 line_start = unclamped_start.column.0 as usize;
910 }
911 if line == clamped_end_line {
912 line_end = unclamped_end.column.0 as usize + 1; //+1 for inclusive
913 }
914
915 highlighted_range_lines.push(HighlightedRangeLine {
916 start_x: origin.x() + line_start as f32 * layout.size.cell_width,
917 end_x: origin.x() + line_end as f32 * layout.size.cell_width,
918 });
919 }
920
921 Some((start_y, highlighted_range_lines))
922}