Struct alacritty_terminal::term::Term

pub struct Term<T> {
    pub is_focused: bool,
    pub vi_mode_cursor: ViModeCursor,
    pub selection: Option<Selection>,
    /* private fields */
}

Fields

is_focused: bool

Terminal focus controlling the cursor shape.

vi_mode_cursor: ViModeCursor

Cursor for keyboard selection.

selection: Option<Selection>

Implementations

impl<T> Term<T>

pub fn search_next( &self, regex: &mut RegexSearch, origin: Point, direction: Direction, side: Side, max_lines: Option<usize> ) -> Option<Match>

Get next search match in the specified direction.

pub fn regex_search_left( &self, regex: &mut RegexSearch, start: Point, end: Point ) -> Option<Match>

Find the next regex match to the left of the origin point.

The origin is always included in the regex.

pub fn regex_search_right( &self, regex: &mut RegexSearch, start: Point, end: Point ) -> Option<Match>

Find the next regex match to the right of the origin point.

The origin is always included in the regex.

pub fn bracket_search(&self, point: Point) -> Option<Point>

Find next matching bracket.

pub fn semantic_search_left(&self, point: Point) -> Point

Find left end of semantic block.

pub fn semantic_search_right(&self, point: Point) -> Point

Find right end of semantic block.

pub fn inline_search_left( &self, point: Point, needles: &str ) -> Result<Point, Point>

Searching to the left, find the next character contained in needles.

pub fn inline_search_right( &self, point: Point, needles: &str ) -> Result<Point, Point>

Searching to the right, find the next character contained in needles.

pub fn line_search_left(&self, point: Point) -> Point

Find the beginning of the current line across linewraps.

pub fn line_search_right(&self, point: Point) -> Point

Find the end of the current line across linewraps.

impl<T> Term<T>

pub fn scroll_display(&mut self, scroll: Scroll)

where T: EventListener,

pub fn new<D: Dimensions>( config: Config, dimensions: &D, event_proxy: T ) -> Term<T>

pub fn damage(&mut self) -> TermDamage<'_>

Collect the information about the changes in the lines, which could be used to minimize the amount of drawing operations.

The user controlled elements, like Vi mode cursor and Selection are not part of the collected damage state. Those could easily be tracked by comparing their old and new value between adjacent frames.

After reading damage reset_damage should be called.

pub fn reset_damage(&mut self)

Resets the terminal damage information.

pub fn set_options(&mut self, options: Config)

where T: EventListener,

Set new options for the Term.

pub fn selection_to_string(&self) -> Option<String>

Convert the active selection to a String.

pub fn bounds_to_string(&self, start: Point, end: Point) -> String

Convert range between two points to a String.

pub fn renderable_content(&self) -> RenderableContent<'_>

where T: EventListener,

Terminal content required for rendering.

pub fn grid(&self) -> &Grid<Cell>

Access to the raw grid data structure.

pub fn grid_mut(&mut self) -> &mut Grid<Cell>

Mutable access to the raw grid data structure.

pub fn resize<S: Dimensions>(&mut self, size: S)

Resize terminal to new dimensions.

pub fn mode(&self) -> &TermMode

Active terminal modes.

pub fn swap_alt(&mut self)

Swap primary and alternate screen buffer.

pub fn exit(&mut self)

where T: EventListener,

pub fn toggle_vi_mode(&mut self)

where T: EventListener,

Toggle the vi mode.

pub fn vi_motion(&mut self, motion: ViMotion)

where T: EventListener,

Move vi mode cursor.

pub fn vi_goto_point(&mut self, point: Point)

where T: EventListener,

Move vi cursor to a point in the grid.

pub fn scroll_to_point(&mut self, point: Point)

where T: EventListener,

Scroll display to point if it is outside of viewport.

pub fn expand_wide(&self, point: Point, direction: Direction) -> Point

Jump to the end of a wide cell.

pub fn semantic_escape_chars(&self) -> &str

pub fn cursor_style(&self) -> CursorStyle

Active terminal cursor style.

While vi mode is active, this will automatically return the vi mode cursor style.

pub fn colors(&self) -> &Colors

Trait Implementations

impl<T> Dimensions for Term<T>

fn columns(&self) -> usize

Width of the terminal in columns.

fn screen_lines(&self) -> usize

Height of the viewport in lines.

fn total_lines(&self) -> usize

Total number of lines in the buffer, this includes scrollback and visible lines.

fn last_column(&self) -> Column

Index for the last column.

fn topmost_line(&self) -> Line

Line farthest up in the grid history.

fn bottommost_line(&self) -> Line

Line farthest down in the grid history.

fn history_size(&self) -> usize

Number of invisible lines part of the scrollback history.

impl<T: EventListener> Handler for Term<T>

fn input(&mut self, c: char)

A character to be displayed.

fn put_tab(&mut self, count: u16)

Insert tab at cursor position.

fn backspace(&mut self)

Backspace.

fn carriage_return(&mut self)

Carriage return.

fn linefeed(&mut self)

Linefeed.

fn bell(&mut self)

Set current position as a tabstop.

fn newline(&mut self)

Run LF/NL.

LF/NL mode has some interesting history. According to ECMA-48 4th edition, in LINE FEED mode,

The execution of the formatter functions LINE FEED (LF), FORM FEED (FF), LINE TABULATION (VT) cause only movement of the active position in the direction of the line progression.

In NEW LINE mode,

The execution of the formatter functions LINE FEED (LF), FORM FEED (FF), LINE TABULATION (VT) cause movement to the line home position on the following line, the following form, etc. In the case of LF this is referred to as the New Line (NL) option.

Additionally, ECMA-48 4th edition says that this option is deprecated. ECMA-48 5th edition only mentions this option (without explanation) saying that it’s been removed.

As an emulator, we need to support it since applications may still rely on it.

fn set_color(&mut self, index: usize, color: Rgb)

Set the indexed color value.

fn dynamic_color_sequence( &mut self, prefix: String, index: usize, terminator: &str )

Respond to a color query escape sequence.

fn reset_color(&mut self, index: usize)

Reset the indexed color to original value.

fn clipboard_store(&mut self, clipboard: u8, base64: &[u8])

Store data into clipboard.

fn clipboard_load(&mut self, clipboard: u8, terminator: &str)

Load data from clipboard.

fn reset_state(&mut self)

Reset all important fields in the term struct.

fn terminal_attribute(&mut self, attr: Attr)

Set a terminal attribute.

fn decaln(&mut self)

Run the decaln routine.

fn goto(&mut self, line: i32, col: usize)

Set cursor to position.

fn goto_line(&mut self, line: i32)

Set cursor to specific row.

fn goto_col(&mut self, col: usize)

Set cursor to specific column.

fn insert_blank(&mut self, count: usize)

Insert blank characters in current line starting from cursor.

fn move_up(&mut self, lines: usize)

Move cursor up rows.

fn move_down(&mut self, lines: usize)

Move cursor down rows.

fn move_forward(&mut self, cols: usize)

Move cursor forward cols.

fn move_backward(&mut self, cols: usize)

Move cursor backward cols.

fn identify_terminal(&mut self, intermediate: Option<char>)

Identify the terminal (should write back to the pty stream).

fn report_keyboard_mode(&mut self)

Report current keyboard mode.

fn push_keyboard_mode(&mut self, mode: KeyboardModes)

Push keyboard mode into the keyboard mode stack.

fn pop_keyboard_modes(&mut self, to_pop: u16)

Pop the given amount of keyboard modes from the keyboard mode stack.

fn set_keyboard_mode( &mut self, mode: KeyboardModes, apply: KeyboardModesApplyBehavior )

Set the keyboard mode using the given behavior.

fn device_status(&mut self, arg: usize)

Report device status.

fn move_down_and_cr(&mut self, lines: usize)

Move cursor down rows and set to column 1.

fn move_up_and_cr(&mut self, lines: usize)

Move cursor up rows and set to column 1.

fn substitute(&mut self)

Substitute char under cursor.

fn set_horizontal_tabstop(&mut self)

Set current position as a tabstop.

fn scroll_up(&mut self, lines: usize)

Scroll up rows rows.

fn scroll_down(&mut self, lines: usize)

Scroll down rows rows.

fn insert_blank_lines(&mut self, lines: usize)

Insert count blank lines.

fn delete_lines(&mut self, lines: usize)

Delete count lines.

fn erase_chars(&mut self, count: usize)

Erase count chars in current line following cursor.

fn delete_chars(&mut self, count: usize)

Delete count chars.

fn move_backward_tabs(&mut self, count: u16)

Move backward count tabs.

fn move_forward_tabs(&mut self, count: u16)

Move forward count tabs.

fn save_cursor_position(&mut self)

Save current cursor position.

fn restore_cursor_position(&mut self)

Restore cursor position.

fn clear_line(&mut self, mode: LineClearMode)

Clear current line.

fn clear_screen(&mut self, mode: ClearMode)

Clear screen.

fn clear_tabs(&mut self, mode: TabulationClearMode)

Clear tab stops.

fn reverse_index(&mut self)

Reverse Index.

fn set_hyperlink(&mut self, hyperlink: Option<Hyperlink>)

Set hyperlink.

fn set_private_mode(&mut self, mode: PrivateMode)

Set private mode.

fn unset_private_mode(&mut self, mode: PrivateMode)

Unset private mode.

fn report_private_mode(&mut self, mode: PrivateMode)

DECRPM - report private mode.

fn set_mode(&mut self, mode: Mode)

Set mode.

fn unset_mode(&mut self, mode: Mode)

Unset mode.

fn report_mode(&mut self, mode: Mode)

DECRPM - report mode.

fn set_scrolling_region(&mut self, top: usize, bottom: Option<usize>)

DECSTBM - Set the terminal scrolling region.

fn set_keypad_application_mode(&mut self)

DECKPAM - Set keypad to applications mode (ESCape instead of digits).

fn unset_keypad_application_mode(&mut self)

DECKPNM - Set keypad to numeric mode (digits instead of ESCape seq).

fn configure_charset(&mut self, index: CharsetIndex, charset: StandardCharset)

Assign a graphic character set to G0, G1, G2 or G3.

fn set_active_charset(&mut self, index: CharsetIndex)

Set one of the graphic character sets, G0 to G3, as the active charset.

fn set_cursor_style(&mut self, style: Option<CursorStyle>)

Set the cursor style.

fn set_cursor_shape(&mut self, shape: CursorShape)

Set the cursor shape.

fn set_title(&mut self, title: Option<String>)

OSC to set window title.

fn push_title(&mut self)

Push a title onto the stack.

fn pop_title(&mut self)

Pop the last title from the stack.

fn text_area_size_pixels(&mut self)

Report text area size in pixels.

fn text_area_size_chars(&mut self)

Report text area size in characters.

fn set_mouse_cursor_icon(&mut self, _: CursorIcon)

Set mouse cursor icon.

fn set_modify_other_keys(&mut self, _mode: ModifyOtherKeys)

Set XTerm’s ModifyOtherKeys option.

fn report_modify_other_keys(&mut self)

Report XTerm’s ModifyOtherKeys state.