terminal_element.rs

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