Raxol.Terminal.Emulator (Raxol v0.4.0)
View SourceManages the state of the terminal emulator, including screen buffer, cursor position, attributes, and modes.
Scrollback Limit Configuration
The scrollback buffer limit can be set via application config:
config :raxol, :terminal, scrollback_lines: 1000
Or overridden per emulator instance by passing the :scrollback
option to new/3
:
Emulator.new(80, 24, scrollback: 2000)
Summary
Functions
Clears the scrollback buffer.
Gets the currently active buffer (:main or :alt) from the emulator state.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.get_charset_state/1
.
Callback implementation for Raxol.Terminal.EmulatorBehaviour.get_cursor_position/1
.
Gets whether the cursor is currently visible.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.get_hyperlink_url/1
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.get_icon_name/1
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.get_last_col_exceeded/1
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.get_mode_manager/1
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.get_scroll_region/1
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.get_state_stack/1
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.get_window_title/1
.
Checks if the cursor is below the scroll region and scrolls up if necessary. Called after operations like LF, IND, NEL that might move the cursor off-screen. Version called with no specific target Y - checks current cursor position.
See Raxol.Terminal.Cursor.Manager.move_down/2
.
See Raxol.Terminal.Cursor.Manager.move_left/2
.
See Raxol.Terminal.Cursor.Manager.move_right/2
.
See Raxol.Terminal.Cursor.Manager.move_to_column/2
.
See Raxol.Terminal.Cursor.Manager.move_up/2
.
Creates a new terminal emulator instance with the specified dimensions and options.
Creates a new terminal emulator instance with specified dimensions, session ID, and client options. This function is required by the TerminalChannel.
Processes input from the user, handling both regular characters and escape sequences. Delegates to Raxol.Terminal.InputHandler.process_terminal_input/2.
Resizes the emulator's screen buffers.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.restore_state/1
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.save_state/1
.
See Raxol.Terminal.Cursor.Manager.set_position/2
.
Updates the currently active screen buffer.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.update_charset_state/2
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.update_hyperlink_url/2
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.update_icon_name/2
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.update_last_col_exceeded/2
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.update_mode_manager/2
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.update_scroll_region/2
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.update_state_stack/2
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.update_window_title/2
.
Types
@type cursor_style_type() ::
:blinking_block
| :steady_block
| :blinking_underline
| :steady_underline
| :blinking_bar
| :steady_bar
@type t() :: %Raxol.Terminal.Emulator{ active_buffer_type: :main | :alternate, alternate_screen_buffer: Raxol.Terminal.ScreenBuffer.t(), charset_state: Raxol.Terminal.ANSI.CharacterSets.charset_state(), client_options: map(), color_palette: map(), command: Raxol.Terminal.Command.Manager.t(), command_history: list(), current_command_buffer: String.t(), current_hyperlink: map() | nil, current_hyperlink_url: String.t() | nil, cursor: Raxol.Terminal.Cursor.Manager.t(), cursor_style: cursor_style_type(), cwd: String.t() | nil, default_palette: map() | nil, height: non_neg_integer(), icon_name: String.t() | nil, last_col_exceeded: term(), last_key_event: map() | nil, main_screen_buffer: Raxol.Terminal.ScreenBuffer.t(), max_command_history: non_neg_integer(), memory_limit: non_neg_integer(), mode_manager: Raxol.Terminal.ModeManager.t(), options: map(), output_buffer: String.t(), parser_state: map(), plugin_manager: Raxol.Terminal.Cursor.Manager.t(Raxol.Plugins.Manager.Core), saved_cursor: Raxol.Terminal.Cursor.Manager.t() | nil, scroll_region: {non_neg_integer(), non_neg_integer()} | nil, scrollback_buffer: list(), scrollback_limit: non_neg_integer(), session_id: String.t() | nil, sixel_state: map() | nil, state: Raxol.Terminal.ANSI.CharacterSets.StateManager.t(), state_stack: term(), style: Raxol.Terminal.ANSI.TextFormatting.text_style(), tab_stops: MapSet.t(), width: non_neg_integer(), window_state: %{ title: String.t(), icon_name: String.t(), size: {non_neg_integer(), non_neg_integer()}, position: {non_neg_integer(), non_neg_integer()}, stacking_order: :normal | :maximized | :iconified, iconified: boolean(), maximized: boolean(), previous_size: {non_neg_integer(), non_neg_integer()} | nil }, window_title: String.t() | nil }
Functions
Clears the scrollback buffer.
@spec get_active_buffer(t()) :: Raxol.Terminal.ScreenBuffer.t()
Gets the currently active buffer (:main or :alt) from the emulator state.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.get_charset_state/1
.
Callback implementation for Raxol.Terminal.EmulatorBehaviour.get_cursor_position/1
.
Gets whether the cursor is currently visible.
Parameters
emulator
- The emulator to check
Returns
Boolean indicating if cursor is visible
See Raxol.Terminal.ANSI.CharacterSets.StateManager.get_hyperlink_url/1
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.get_icon_name/1
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.get_last_col_exceeded/1
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.get_mode_manager/1
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.get_scroll_region/1
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.get_state_stack/1
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.get_window_title/1
.
Checks if the cursor is below the scroll region and scrolls up if necessary. Called after operations like LF, IND, NEL that might move the cursor off-screen. Version called with no specific target Y - checks current cursor position.
See Raxol.Terminal.Cursor.Manager.move_down/2
.
See Raxol.Terminal.Cursor.Manager.move_left/2
.
See Raxol.Terminal.Cursor.Manager.move_right/2
.
See Raxol.Terminal.Cursor.Manager.move_to_column/2
.
See Raxol.Terminal.Cursor.Manager.move_up/2
.
@spec new(non_neg_integer(), non_neg_integer(), keyword()) :: t()
Creates a new terminal emulator instance with the specified dimensions and options.
Options
:scrollback
- Maximum number of scrollback lines (default: from config or 1000):memorylimit
- Memory limit (default: 1_000_000):max_command_history
- Max command history (default: 100)
Examples
iex> emulator = Raxol.Terminal.Emulator.new(80, 24, scrollback: 2000)
iex> emulator.scrollback_limit
2000
Creates a new terminal emulator instance with specified dimensions, session ID, and client options. This function is required by the TerminalChannel.
Processes input from the user, handling both regular characters and escape sequences. Delegates to Raxol.Terminal.InputHandler.process_terminal_input/2.
@spec resize( t(), non_neg_integer(), non_neg_integer() ) :: t()
Resizes the emulator's screen buffers.
Parameters
emulator
- The emulator to resizenew_width
- New width in columnsnew_height
- New height in rows
Returns
Updated emulator with resized buffers
See Raxol.Terminal.ANSI.CharacterSets.StateManager.restore_state/1
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.save_state/1
.
See Raxol.Terminal.Cursor.Manager.set_position/2
.
@spec update_active_buffer( t(), Raxol.Terminal.ScreenBuffer.t() ) :: t()
Updates the currently active screen buffer.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.update_charset_state/2
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.update_hyperlink_url/2
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.update_icon_name/2
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.update_last_col_exceeded/2
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.update_mode_manager/2
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.update_scroll_region/2
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.update_state_stack/2
.
See Raxol.Terminal.ANSI.CharacterSets.StateManager.update_window_title/2
.