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