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