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() as usize,
 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            .clone()
 410            .unwrap_or(settings.buffer_font.features.clone());
 411
 412        let line_height = terminal_settings.line_height.value();
 413        let font_size = terminal_settings.font_size.clone();
 414
 415        let font_size =
 416            font_size.map_or(buffer_font_size, |size| theme::adjusted_font_size(size, cx));
 417
 418        let theme = cx.theme().clone();
 419
 420        let link_style = HighlightStyle {
 421            color: Some(theme.colors().link_text_hover),
 422            font_weight: None,
 423            font_style: None,
 424            background_color: None,
 425            underline: Some(UnderlineStyle {
 426                thickness: px(1.0),
 427                color: Some(theme.colors().link_text_hover),
 428                wavy: false,
 429            }),
 430            strikethrough: None,
 431            fade_out: None,
 432        };
 433
 434        let text_style = TextStyle {
 435            font_family,
 436            font_features,
 437            font_size: font_size.into(),
 438            font_style: FontStyle::Normal,
 439            line_height: line_height.into(),
 440            background_color: None,
 441            white_space: WhiteSpace::Normal,
 442            // These are going to be overridden per-cell
 443            underline: None,
 444            strikethrough: None,
 445            color: theme.colors().text,
 446            font_weight: FontWeight::NORMAL,
 447        };
 448
 449        let text_system = cx.text_system();
 450        let player_color = theme.players().local();
 451        let match_color = theme.colors().search_match_background;
 452        let gutter;
 453        let dimensions = {
 454            let rem_size = cx.rem_size();
 455            let font_pixels = text_style.font_size.to_pixels(rem_size);
 456            let line_height = font_pixels * line_height.to_pixels(rem_size);
 457            let font_id = cx.text_system().resolve_font(&text_style.font());
 458
 459            let cell_width = text_system
 460                .advance(font_id, font_pixels, 'm')
 461                .unwrap()
 462                .width;
 463            gutter = cell_width;
 464
 465            let mut size = bounds.size.clone();
 466            size.width -= gutter;
 467
 468            // https://github.com/zed-industries/zed/issues/2750
 469            // if the terminal is one column wide, rendering 🦀
 470            // causes alacritty to misbehave.
 471            if size.width < cell_width * 2.0 {
 472                size.width = cell_width * 2.0;
 473            }
 474
 475            TerminalSize::new(line_height, cell_width, size)
 476        };
 477
 478        let search_matches = self.terminal.read(cx).matches.clone();
 479
 480        let background_color = theme.colors().terminal_background;
 481
 482        let last_hovered_word = self.terminal.update(cx, |terminal, cx| {
 483            terminal.set_size(dimensions);
 484            terminal.sync(cx);
 485            if self.can_navigate_to_selected_word && terminal.can_navigate_to_selected_word() {
 486                terminal.last_content.last_hovered_word.clone()
 487            } else {
 488                None
 489            }
 490        });
 491
 492        if bounds.contains(&cx.mouse_position()) {
 493            let stacking_order = cx.stacking_order().clone();
 494            if self.can_navigate_to_selected_word && last_hovered_word.is_some() {
 495                cx.set_cursor_style(gpui::CursorStyle::PointingHand, stacking_order);
 496            } else {
 497                cx.set_cursor_style(gpui::CursorStyle::IBeam, stacking_order);
 498            }
 499        }
 500
 501        let hyperlink_tooltip = last_hovered_word.clone().map(|hovered_word| {
 502            div()
 503                .size_full()
 504                .id("terminal-element")
 505                .tooltip(move |cx| Tooltip::text(hovered_word.word.clone(), cx))
 506                .into_any_element()
 507        });
 508
 509        let TerminalContent {
 510            cells,
 511            mode,
 512            display_offset,
 513            cursor_char,
 514            selection,
 515            cursor,
 516            ..
 517        } = &self.terminal.read(cx).last_content;
 518
 519        // searches, highlights to a single range representations
 520        let mut relative_highlighted_ranges = Vec::new();
 521        for search_match in search_matches {
 522            relative_highlighted_ranges.push((search_match, match_color))
 523        }
 524        if let Some(selection) = selection {
 525            relative_highlighted_ranges
 526                .push((selection.start..=selection.end, player_color.selection));
 527        }
 528
 529        // then have that representation be converted to the appropriate highlight data structure
 530
 531        let (cells, rects) = TerminalElement::layout_grid(
 532            cells,
 533            &text_style,
 534            &cx.text_system(),
 535            last_hovered_word
 536                .as_ref()
 537                .map(|last_hovered_word| (link_style, &last_hovered_word.word_match)),
 538            cx,
 539        );
 540
 541        // Layout cursor. Rectangle is used for IME, so we should lay it out even
 542        // if we don't end up showing it.
 543        let cursor = if let AlacCursorShape::Hidden = cursor.shape {
 544            None
 545        } else {
 546            let cursor_point = DisplayCursor::from(cursor.point, *display_offset);
 547            let cursor_text = {
 548                let str_trxt = cursor_char.to_string();
 549                let len = str_trxt.len();
 550                cx.text_system()
 551                    .shape_line(
 552                        str_trxt.into(),
 553                        text_style.font_size.to_pixels(cx.rem_size()),
 554                        &[TextRun {
 555                            len,
 556                            font: text_style.font(),
 557                            color: theme.colors().terminal_background,
 558                            background_color: None,
 559                            underline: Default::default(),
 560                            strikethrough: None,
 561                        }],
 562                    )
 563                    .unwrap()
 564            };
 565
 566            let focused = self.focused;
 567            TerminalElement::shape_cursor(cursor_point, dimensions, &cursor_text).map(
 568                move |(cursor_position, block_width)| {
 569                    let (shape, text) = match cursor.shape {
 570                        AlacCursorShape::Block if !focused => (CursorShape::Hollow, None),
 571                        AlacCursorShape::Block => (CursorShape::Block, Some(cursor_text)),
 572                        AlacCursorShape::Underline => (CursorShape::Underscore, None),
 573                        AlacCursorShape::Beam => (CursorShape::Bar, None),
 574                        AlacCursorShape::HollowBlock => (CursorShape::Hollow, None),
 575                        //This case is handled in the if wrapping the whole cursor layout
 576                        AlacCursorShape::Hidden => unreachable!(),
 577                    };
 578
 579                    Cursor::new(
 580                        cursor_position,
 581                        block_width,
 582                        dimensions.line_height,
 583                        theme.players().local().cursor,
 584                        shape,
 585                        text,
 586                        None,
 587                    )
 588                },
 589            )
 590        };
 591
 592        LayoutState {
 593            cells,
 594            cursor,
 595            background_color,
 596            dimensions,
 597            rects,
 598            relative_highlighted_ranges,
 599            mode: *mode,
 600            display_offset: *display_offset,
 601            hyperlink_tooltip,
 602            gutter,
 603        }
 604    }
 605
 606    fn generic_button_handler<E>(
 607        connection: Model<Terminal>,
 608        origin: Point<Pixels>,
 609        focus_handle: FocusHandle,
 610        f: impl Fn(&mut Terminal, Point<Pixels>, &E, &mut ModelContext<Terminal>),
 611    ) -> impl Fn(&E, &mut WindowContext) {
 612        move |event, cx| {
 613            cx.focus(&focus_handle);
 614            connection.update(cx, |terminal, cx| {
 615                f(terminal, origin, event, cx);
 616
 617                cx.notify();
 618            })
 619        }
 620    }
 621
 622    fn register_mouse_listeners(
 623        &mut self,
 624        origin: Point<Pixels>,
 625        mode: TermMode,
 626        bounds: Bounds<Pixels>,
 627        cx: &mut ElementContext,
 628    ) {
 629        let focus = self.focus.clone();
 630        let terminal = self.terminal.clone();
 631        let interactive_bounds = InteractiveBounds {
 632            bounds: bounds.intersect(&cx.content_mask().bounds),
 633            stacking_order: cx.stacking_order().clone(),
 634        };
 635
 636        self.interactivity.on_mouse_down(MouseButton::Left, {
 637            let terminal = terminal.clone();
 638            let focus = focus.clone();
 639            move |e, cx| {
 640                cx.focus(&focus);
 641                terminal.update(cx, |terminal, cx| {
 642                    terminal.mouse_down(&e, origin);
 643                    cx.notify();
 644                })
 645            }
 646        });
 647
 648        cx.on_mouse_event({
 649            let bounds = bounds.clone();
 650            let focus = self.focus.clone();
 651            let terminal = self.terminal.clone();
 652            move |e: &MouseMoveEvent, phase, cx| {
 653                if phase != DispatchPhase::Bubble || !focus.is_focused(cx) {
 654                    return;
 655                }
 656
 657                if e.pressed_button.is_some() && !cx.has_active_drag() {
 658                    let visibly_contains = interactive_bounds.visibly_contains(&e.position, cx);
 659                    terminal.update(cx, |terminal, cx| {
 660                        if !terminal.selection_started() {
 661                            if visibly_contains {
 662                                terminal.mouse_drag(e, origin, bounds);
 663                                cx.notify();
 664                            }
 665                        } else {
 666                            terminal.mouse_drag(e, origin, bounds);
 667                            cx.notify();
 668                        }
 669                    })
 670                }
 671
 672                if interactive_bounds.visibly_contains(&e.position, cx) {
 673                    terminal.update(cx, |terminal, cx| {
 674                        terminal.mouse_move(&e, origin);
 675                        cx.notify();
 676                    })
 677                }
 678            }
 679        });
 680
 681        self.interactivity.on_mouse_up(
 682            MouseButton::Left,
 683            TerminalElement::generic_button_handler(
 684                terminal.clone(),
 685                origin,
 686                focus.clone(),
 687                move |terminal, origin, e, cx| {
 688                    terminal.mouse_up(&e, origin, cx);
 689                },
 690            ),
 691        );
 692        self.interactivity.on_scroll_wheel({
 693            let terminal = terminal.clone();
 694            move |e, cx| {
 695                terminal.update(cx, |terminal, cx| {
 696                    terminal.scroll_wheel(e, origin);
 697                    cx.notify();
 698                })
 699            }
 700        });
 701
 702        // Mouse mode handlers:
 703        // All mouse modes need the extra click handlers
 704        if mode.intersects(TermMode::MOUSE_MODE) {
 705            self.interactivity.on_mouse_down(
 706                MouseButton::Right,
 707                TerminalElement::generic_button_handler(
 708                    terminal.clone(),
 709                    origin,
 710                    focus.clone(),
 711                    move |terminal, origin, e, _cx| {
 712                        terminal.mouse_down(&e, origin);
 713                    },
 714                ),
 715            );
 716            self.interactivity.on_mouse_down(
 717                MouseButton::Middle,
 718                TerminalElement::generic_button_handler(
 719                    terminal.clone(),
 720                    origin,
 721                    focus.clone(),
 722                    move |terminal, origin, e, _cx| {
 723                        terminal.mouse_down(&e, origin);
 724                    },
 725                ),
 726            );
 727            self.interactivity.on_mouse_up(
 728                MouseButton::Right,
 729                TerminalElement::generic_button_handler(
 730                    terminal.clone(),
 731                    origin,
 732                    focus.clone(),
 733                    move |terminal, origin, e, cx| {
 734                        terminal.mouse_up(&e, origin, cx);
 735                    },
 736                ),
 737            );
 738            self.interactivity.on_mouse_up(
 739                MouseButton::Middle,
 740                TerminalElement::generic_button_handler(
 741                    terminal,
 742                    origin,
 743                    focus,
 744                    move |terminal, origin, e, cx| {
 745                        terminal.mouse_up(&e, origin, cx);
 746                    },
 747                ),
 748            );
 749        }
 750    }
 751}
 752
 753impl Element for TerminalElement {
 754    type State = InteractiveElementState;
 755
 756    fn request_layout(
 757        &mut self,
 758        element_state: Option<Self::State>,
 759        cx: &mut ElementContext<'_>,
 760    ) -> (LayoutId, Self::State) {
 761        let (layout_id, interactive_state) =
 762            self.interactivity
 763                .layout(element_state, cx, |mut style, cx| {
 764                    style.size.width = relative(1.).into();
 765                    style.size.height = relative(1.).into();
 766                    let layout_id = cx.request_layout(&style, None);
 767
 768                    layout_id
 769                });
 770
 771        (layout_id, interactive_state)
 772    }
 773
 774    fn paint(
 775        &mut self,
 776        bounds: Bounds<Pixels>,
 777        state: &mut Self::State,
 778        cx: &mut ElementContext<'_>,
 779    ) {
 780        let mut layout = self.compute_layout(bounds, cx);
 781
 782        cx.paint_quad(fill(bounds, layout.background_color));
 783        let origin = bounds.origin + Point::new(layout.gutter, px(0.));
 784
 785        let terminal_input_handler = TerminalInputHandler {
 786            terminal: self.terminal.clone(),
 787            cursor_bounds: layout
 788                .cursor
 789                .as_ref()
 790                .map(|cursor| cursor.bounding_rect(origin)),
 791            workspace: self.workspace.clone(),
 792        };
 793
 794        self.register_mouse_listeners(origin, layout.mode, bounds, cx);
 795
 796        self.interactivity
 797            .paint(bounds, bounds.size, state, cx, |_, _, cx| {
 798                cx.handle_input(&self.focus, terminal_input_handler);
 799
 800                cx.on_key_event({
 801                    let this = self.terminal.clone();
 802                    move |event: &ModifiersChangedEvent, phase, cx| {
 803                        if phase != DispatchPhase::Bubble {
 804                            return;
 805                        }
 806
 807                        let handled =
 808                            this.update(cx, |term, _| term.try_modifiers_change(&event.modifiers));
 809
 810                        if handled {
 811                            cx.refresh();
 812                        }
 813                    }
 814                });
 815
 816                for rect in &layout.rects {
 817                    rect.paint(origin, &layout, cx);
 818                }
 819
 820                cx.with_z_index(1, |cx| {
 821                    for (relative_highlighted_range, color) in
 822                        layout.relative_highlighted_ranges.iter()
 823                    {
 824                        if let Some((start_y, highlighted_range_lines)) =
 825                            to_highlighted_range_lines(relative_highlighted_range, &layout, origin)
 826                        {
 827                            let hr = HighlightedRange {
 828                                start_y, //Need to change this
 829                                line_height: layout.dimensions.line_height,
 830                                lines: highlighted_range_lines,
 831                                color: color.clone(),
 832                                //Copied from editor. TODO: move to theme or something
 833                                corner_radius: 0.15 * layout.dimensions.line_height,
 834                            };
 835                            hr.paint(bounds, cx);
 836                        }
 837                    }
 838                });
 839
 840                cx.with_z_index(2, |cx| {
 841                    for cell in &layout.cells {
 842                        cell.paint(origin, &layout, bounds, cx);
 843                    }
 844                });
 845
 846                if self.cursor_visible {
 847                    cx.with_z_index(3, |cx| {
 848                        if let Some(cursor) = &layout.cursor {
 849                            cursor.paint(origin, cx);
 850                        }
 851                    });
 852                }
 853
 854                if let Some(mut element) = layout.hyperlink_tooltip.take() {
 855                    element.draw(origin, bounds.size.map(AvailableSpace::Definite), cx)
 856                }
 857            });
 858    }
 859}
 860
 861impl IntoElement for TerminalElement {
 862    type Element = Self;
 863
 864    fn element_id(&self) -> Option<ElementId> {
 865        Some("terminal".into())
 866    }
 867
 868    fn into_element(self) -> Self::Element {
 869        self
 870    }
 871}
 872
 873struct TerminalInputHandler {
 874    terminal: Model<Terminal>,
 875    workspace: WeakView<Workspace>,
 876    cursor_bounds: Option<Bounds<Pixels>>,
 877}
 878
 879impl InputHandler for TerminalInputHandler {
 880    fn selected_text_range(&mut self, cx: &mut WindowContext) -> Option<std::ops::Range<usize>> {
 881        if self
 882            .terminal
 883            .read(cx)
 884            .last_content
 885            .mode
 886            .contains(TermMode::ALT_SCREEN)
 887        {
 888            None
 889        } else {
 890            Some(0..0)
 891        }
 892    }
 893
 894    fn marked_text_range(&mut self, _: &mut WindowContext) -> Option<std::ops::Range<usize>> {
 895        None
 896    }
 897
 898    fn text_for_range(
 899        &mut self,
 900        _: std::ops::Range<usize>,
 901        _: &mut WindowContext,
 902    ) -> Option<String> {
 903        None
 904    }
 905
 906    fn replace_text_in_range(
 907        &mut self,
 908        _replacement_range: Option<std::ops::Range<usize>>,
 909        text: &str,
 910        cx: &mut WindowContext,
 911    ) {
 912        self.terminal.update(cx, |terminal, _| {
 913            terminal.input(text.into());
 914        });
 915
 916        self.workspace
 917            .update(cx, |this, cx| {
 918                let telemetry = this.project().read(cx).client().telemetry().clone();
 919                telemetry.log_edit_event("terminal");
 920            })
 921            .ok();
 922    }
 923
 924    fn replace_and_mark_text_in_range(
 925        &mut self,
 926        _range_utf16: Option<std::ops::Range<usize>>,
 927        _new_text: &str,
 928        _new_selected_range: Option<std::ops::Range<usize>>,
 929        _: &mut WindowContext,
 930    ) {
 931    }
 932
 933    fn unmark_text(&mut self, _: &mut WindowContext) {}
 934
 935    fn bounds_for_range(
 936        &mut self,
 937        _range_utf16: std::ops::Range<usize>,
 938        _: &mut WindowContext,
 939    ) -> Option<Bounds<Pixels>> {
 940        self.cursor_bounds
 941    }
 942}
 943
 944fn is_blank(cell: &IndexedCell) -> bool {
 945    if cell.c != ' ' {
 946        return false;
 947    }
 948
 949    if cell.bg != AnsiColor::Named(NamedColor::Background) {
 950        return false;
 951    }
 952
 953    if cell.hyperlink().is_some() {
 954        return false;
 955    }
 956
 957    if cell
 958        .flags
 959        .intersects(Flags::ALL_UNDERLINES | Flags::INVERSE | Flags::STRIKEOUT)
 960    {
 961        return false;
 962    }
 963
 964    return true;
 965}
 966
 967fn to_highlighted_range_lines(
 968    range: &RangeInclusive<AlacPoint>,
 969    layout: &LayoutState,
 970    origin: Point<Pixels>,
 971) -> Option<(Pixels, Vec<HighlightedRangeLine>)> {
 972    // Step 1. Normalize the points to be viewport relative.
 973    // When display_offset = 1, here's how the grid is arranged:
 974    //-2,0 -2,1...
 975    //--- Viewport top
 976    //-1,0 -1,1...
 977    //--------- Terminal Top
 978    // 0,0  0,1...
 979    // 1,0  1,1...
 980    //--- Viewport Bottom
 981    // 2,0  2,1...
 982    //--------- Terminal Bottom
 983
 984    // Normalize to viewport relative, from terminal relative.
 985    // lines are i32s, which are negative above the top left corner of the terminal
 986    // If the user has scrolled, we use the display_offset to tell us which offset
 987    // of the grid data we should be looking at. But for the rendering step, we don't
 988    // want negatives. We want things relative to the 'viewport' (the area of the grid
 989    // which is currently shown according to the display offset)
 990    let unclamped_start = AlacPoint::new(
 991        range.start().line + layout.display_offset,
 992        range.start().column,
 993    );
 994    let unclamped_end =
 995        AlacPoint::new(range.end().line + layout.display_offset, range.end().column);
 996
 997    // Step 2. Clamp range to viewport, and return None if it doesn't overlap
 998    if unclamped_end.line.0 < 0 || unclamped_start.line.0 > layout.dimensions.num_lines() as i32 {
 999        return None;
1000    }
1001
1002    let clamped_start_line = unclamped_start.line.0.max(0) as usize;
1003    let clamped_end_line = unclamped_end
1004        .line
1005        .0
1006        .min(layout.dimensions.num_lines() as i32) as usize;
1007    //Convert the start of the range to pixels
1008    let start_y = origin.y + clamped_start_line as f32 * layout.dimensions.line_height;
1009
1010    // Step 3. Expand ranges that cross lines into a collection of single-line ranges.
1011    //  (also convert to pixels)
1012    let mut highlighted_range_lines = Vec::new();
1013    for line in clamped_start_line..=clamped_end_line {
1014        let mut line_start = 0;
1015        let mut line_end = layout.dimensions.columns();
1016
1017        if line == clamped_start_line {
1018            line_start = unclamped_start.column.0 as usize;
1019        }
1020        if line == clamped_end_line {
1021            line_end = unclamped_end.column.0 as usize + 1; //+1 for inclusive
1022        }
1023
1024        highlighted_range_lines.push(HighlightedRangeLine {
1025            start_x: origin.x + line_start as f32 * layout.dimensions.cell_width,
1026            end_x: origin.x + line_end as f32 * layout.dimensions.cell_width,
1027        });
1028    }
1029
1030    Some((start_y, highlighted_range_lines))
1031}
1032
1033/// Converts a 2, 8, or 24 bit color ANSI color to the GPUI equivalent.
1034fn convert_color(fg: &terminal::alacritty_terminal::vte::ansi::Color, theme: &Theme) -> Hsla {
1035    let colors = theme.colors();
1036    match fg {
1037        // Named and theme defined colors
1038        terminal::alacritty_terminal::vte::ansi::Color::Named(n) => match n {
1039            NamedColor::Black => colors.terminal_ansi_black,
1040            NamedColor::Red => colors.terminal_ansi_red,
1041            NamedColor::Green => colors.terminal_ansi_green,
1042            NamedColor::Yellow => colors.terminal_ansi_yellow,
1043            NamedColor::Blue => colors.terminal_ansi_blue,
1044            NamedColor::Magenta => colors.terminal_ansi_magenta,
1045            NamedColor::Cyan => colors.terminal_ansi_cyan,
1046            NamedColor::White => colors.terminal_ansi_white,
1047            NamedColor::BrightBlack => colors.terminal_ansi_bright_black,
1048            NamedColor::BrightRed => colors.terminal_ansi_bright_red,
1049            NamedColor::BrightGreen => colors.terminal_ansi_bright_green,
1050            NamedColor::BrightYellow => colors.terminal_ansi_bright_yellow,
1051            NamedColor::BrightBlue => colors.terminal_ansi_bright_blue,
1052            NamedColor::BrightMagenta => colors.terminal_ansi_bright_magenta,
1053            NamedColor::BrightCyan => colors.terminal_ansi_bright_cyan,
1054            NamedColor::BrightWhite => colors.terminal_ansi_bright_white,
1055            NamedColor::Foreground => colors.text,
1056            NamedColor::Background => colors.background,
1057            NamedColor::Cursor => theme.players().local().cursor,
1058            NamedColor::DimBlack => colors.terminal_ansi_dim_black,
1059            NamedColor::DimRed => colors.terminal_ansi_dim_red,
1060            NamedColor::DimGreen => colors.terminal_ansi_dim_green,
1061            NamedColor::DimYellow => colors.terminal_ansi_dim_yellow,
1062            NamedColor::DimBlue => colors.terminal_ansi_dim_blue,
1063            NamedColor::DimMagenta => colors.terminal_ansi_dim_magenta,
1064            NamedColor::DimCyan => colors.terminal_ansi_dim_cyan,
1065            NamedColor::DimWhite => colors.terminal_ansi_dim_white,
1066            NamedColor::BrightForeground => colors.terminal_bright_foreground,
1067            NamedColor::DimForeground => colors.terminal_dim_foreground,
1068        },
1069        // 'True' colors
1070        terminal::alacritty_terminal::vte::ansi::Color::Spec(rgb) => {
1071            terminal::rgba_color(rgb.r, rgb.g, rgb.b)
1072        }
1073        // 8 bit, indexed colors
1074        terminal::alacritty_terminal::vte::ansi::Color::Indexed(i) => {
1075            terminal::get_color_at_index(*i as usize, theme)
1076        }
1077    }
1078}