Raxol.Terminal.ScreenManager (Raxol v2.0.1)

View Source

Manages screen buffer operations for the terminal emulator. This module handles operations related to the main and alternate screen buffers, including buffer switching, initialization, and state management.

Summary

Functions

clear_selection(buffer)

Clears the current selection.

get_buffer_type(emulator)

Gets the current buffer type (main or alternate).

get_screen_buffer(emulator)

Gets the currently active screen buffer.

get_scroll_bottom(buffer)

Gets the scroll bottom from the active buffer.

get_scroll_region(buffer)

Gets the scroll region from the active buffer.

get_scroll_top(buffer)

Gets the scroll top from the active buffer.

get_selected_text(buffer)

Gets the selected text from the buffer.

get_selection(buffer)

Gets the current selection from the buffer.

get_selection_boundaries(buffer)

Gets the selection boundaries as {start, end} tuple.

get_selection_end(buffer)

Gets the selection end coordinates.

get_selection_start(buffer)

Gets the selection start coordinates.

get_state(buffer)

Gets the current state of the buffer.

get_style(buffer)

Gets the current style of the buffer.

get_style_at(buffer, x, y)

Gets the style at a specific position.

get_style_at_cursor(buffer)

Gets the style at the cursor position.

in_selection?(buffer, x, y)

Checks if a position is within the current selection.

initialize_buffers(width, height)

Initializes both main and alternate screen buffers with default scrollback limit.

initialize_buffers(width, height, scrollback_limit)

Initializes both main and alternate screen buffers.

parse_scrollback_limit(opts)

Parses scrollback limit from options, defaulting to 1000.

resize_buffers(emulator, new_width, new_height)

Resizes both screen buffers.

selection_active?(buffer)

Checks if a selection is currently active.

set_buffer_type(emulator, type)

Sets the buffer type.

set_scroll_region(buffer, arg)

Sets the scroll region on the buffer.

start_selection(buffer, x, y)

Starts a selection at the specified position.

switch_buffer(emulator)

Switches between main and alternate screen buffers.

update_active_buffer(emulator, new_buffer)

Updates the currently active screen buffer.

update_selection(buffer, x, y)

Updates the selection end position.

write_string(buffer, x, y, string, style)

Writes a string to the buffer at the given position with the given style.

Functions

clear_selection(buffer)

@spec clear_selection(Raxol.Terminal.ScreenBuffer.t()) ::
  Raxol.Terminal.ScreenBuffer.t()

Clears the current selection.

get_buffer_type(emulator)

@spec get_buffer_type(Raxol.Terminal.Emulator.Struct.t()) :: :main | :alternate

Gets the current buffer type (main or alternate).

get_screen_buffer(emulator)

@spec get_screen_buffer(Raxol.Terminal.Emulator.Struct.t()) ::
  Raxol.Terminal.ScreenBuffer.t()

Gets the currently active screen buffer.

get_scroll_bottom(buffer)

@spec get_scroll_bottom(Raxol.Terminal.ScreenBuffer.t()) :: non_neg_integer()

Gets the scroll bottom from the active buffer.

get_scroll_region(buffer)

@spec get_scroll_region(Raxol.Terminal.ScreenBuffer.t()) ::
  {non_neg_integer(), non_neg_integer()}

Gets the scroll region from the active buffer.

get_scroll_top(buffer)

@spec get_scroll_top(Raxol.Terminal.ScreenBuffer.t()) :: non_neg_integer()

Gets the scroll top from the active buffer.

get_selected_text(buffer)

@spec get_selected_text(Raxol.Terminal.ScreenBuffer.t()) :: String.t()

Gets the selected text from the buffer.

get_selection(buffer)

@spec get_selection(Raxol.Terminal.ScreenBuffer.t()) :: String.t()

Gets the current selection from the buffer.

get_selection_boundaries(buffer)

@spec get_selection_boundaries(Raxol.Terminal.ScreenBuffer.t()) ::
  {{non_neg_integer(), non_neg_integer()},
   {non_neg_integer(), non_neg_integer()}}
  | nil

Gets the selection boundaries as {start, end} tuple.

get_selection_end(buffer)

@spec get_selection_end(Raxol.Terminal.ScreenBuffer.t()) ::
  {non_neg_integer(), non_neg_integer()} | nil

Gets the selection end coordinates.

get_selection_start(buffer)

@spec get_selection_start(Raxol.Terminal.ScreenBuffer.t()) ::
  {non_neg_integer(), non_neg_integer()} | nil

Gets the selection start coordinates.

get_state(buffer)

@spec get_state(Raxol.Terminal.ScreenBuffer.t()) :: map()

Gets the current state of the buffer.

get_style(buffer)

@spec get_style(Raxol.Terminal.ScreenBuffer.t()) :: map()

Gets the current style of the buffer.

get_style_at(buffer, x, y)

@spec get_style_at(
  Raxol.Terminal.ScreenBuffer.t(),
  non_neg_integer(),
  non_neg_integer()
) :: map()

Gets the style at a specific position.

get_style_at_cursor(buffer)

@spec get_style_at_cursor(Raxol.Terminal.ScreenBuffer.t()) :: map()

Gets the style at the cursor position.

in_selection?(buffer, x, y)

@spec in_selection?(
  Raxol.Terminal.ScreenBuffer.t(),
  non_neg_integer(),
  non_neg_integer()
) :: boolean()

Checks if a position is within the current selection.

initialize_buffers(width, height)

@spec initialize_buffers(non_neg_integer(), non_neg_integer()) ::
  {Raxol.Terminal.ScreenBuffer.t(), Raxol.Terminal.ScreenBuffer.t()}

Initializes both main and alternate screen buffers with default scrollback limit.

initialize_buffers(width, height, scrollback_limit)

@spec initialize_buffers(
  non_neg_integer(),
  non_neg_integer(),
  non_neg_integer()
) :: {Raxol.Terminal.ScreenBuffer.t(), Raxol.Terminal.ScreenBuffer.t()}

Initializes both main and alternate screen buffers.

parse_scrollback_limit(opts)

@spec parse_scrollback_limit(keyword()) :: non_neg_integer()

Parses scrollback limit from options, defaulting to 1000.

resize_buffers(emulator, new_width, new_height)

@spec resize_buffers(
  Raxol.Terminal.Emulator.Struct.t(),
  non_neg_integer(),
  non_neg_integer()
) ::
  Raxol.Terminal.Emulator.Struct.t()

Resizes both screen buffers.

selection_active?(buffer)

@spec selection_active?(Raxol.Terminal.ScreenBuffer.t()) :: boolean()

Checks if a selection is currently active.

set_buffer_type(emulator, type)

@spec set_buffer_type(Raxol.Terminal.Emulator.Struct.t(), :main | :alternate) ::
  Raxol.Terminal.Emulator.Struct.t()

Sets the buffer type.

set_scroll_region(buffer, arg)

@spec set_scroll_region(
  Raxol.Terminal.ScreenBuffer.t(),
  {non_neg_integer(), non_neg_integer()}
) :: Raxol.Terminal.ScreenBuffer.t()

Sets the scroll region on the buffer.

start_selection(buffer, x, y)

@spec start_selection(
  Raxol.Terminal.ScreenBuffer.t(),
  non_neg_integer(),
  non_neg_integer()
) ::
  Raxol.Terminal.ScreenBuffer.t()

Starts a selection at the specified position.

switch_buffer(emulator)

@spec switch_buffer(Raxol.Terminal.Emulator.Struct.t()) ::
  Raxol.Terminal.Emulator.Struct.t()

Switches between main and alternate screen buffers.

update_active_buffer(emulator, new_buffer)

@spec update_active_buffer(
  Raxol.Terminal.Emulator.Struct.t(),
  Raxol.Terminal.ScreenBuffer.t()
) ::
  Raxol.Terminal.Emulator.Struct.t()

Updates the currently active screen buffer.

update_selection(buffer, x, y)

@spec update_selection(
  Raxol.Terminal.ScreenBuffer.t(),
  non_neg_integer(),
  non_neg_integer()
) ::
  Raxol.Terminal.ScreenBuffer.t()

Updates the selection end position.

write_string(buffer, x, y, string, style)

@spec write_string(
  Raxol.Terminal.ScreenBuffer.t(),
  non_neg_integer(),
  non_neg_integer(),
  String.t(),
  map()
) :: Raxol.Terminal.ScreenBuffer.t()

Writes a string to the buffer at the given position with the given style.