Raxol.Terminal.Emulator (Raxol v2.0.1)
View SourceEnterprise-grade terminal emulator with VT100/ANSI support and high-performance parsing.
Provides full terminal emulation with true color, mouse tracking, alternate screen, and modern features. Uses modular architecture with separate coordinators for buffer, mode, input, and output operations.
Usage
# Create standard emulator
emulator = Raxol.Terminal.Emulator.new(80, 24)
# Process input with colors
{emulator, output} = Raxol.Terminal.Emulator.process_input(
emulator,
"\e[1;31mRed Bold\e[0m Normal text"
)Performance Modes
new/2- Full features (2.8MB, ~95ms startup)new_lite/3- Most features (1.2MB, ~30ms startup)new_minimal/2- Basic only (8.8KB, <10ms startup)
Summary
Functions
Applies color changes (legacy compatibility).
Returns cursor blinking state.
Cleans up emulator resources.
Clears the specified line.
Clears the entire screen.
Clears the screen and moves cursor to home position.
Clears the scrollback buffer.
Clears the current text selection.
Returns true if the cursor is blinking.
Returns true if the cursor is visible.
Deletes the character at the cursor position.
Deletes the specified number of characters.
Ends the current text selection.
Erases the specified number of characters.
Erases display content based on mode (0=to end, 1=from start, 2=entire).
Erases from cursor position to end of screen.
Erases from start of screen to cursor position.
Erases content within the display.
Erases content within the current line.
Erases line content based on mode.
Gets the configuration structure.
Gets the current cursor position as {x, y}.
Gets cursor position as a structured object.
Gets the current cursor style (:block, :line, :underscore).
Gets cursor visibility state.
Gets the terminal height in rows.
Gets the mode manager.
Gets cursor visibility from mode manager.
Gets output from the emulator.
Gets output buffer (legacy compatibility).
Gets the active screen buffer.
Gets the current scroll region as {top, bottom}.
Gets the scrollback buffer contents.
Gets the currently selected text.
Gets the terminal width in columns.
Handles ESC = sequence (DECKPAM - Enable application keypad mode).
Handles ESC > sequence (DECKPNM - Disable application keypad mode).
Returns true if text is currently selected.
Inserts a character at the cursor position.
Inserts the specified number of blank characters.
Performs automatic scrolling if needed.
Moves the cursor to the specified position.
Moves cursor back (stub implementation).
Moves cursor down (stub implementation).
Moves cursor forward (stub implementation).
Moves cursor to specified position.
Moves cursor to specified position with options.
Moves cursor up (stub implementation).
Creates a new terminal emulator.
Creates a new terminal emulator with specified dimensions.
Creates a new terminal emulator with options.
Creates a new terminal emulator with session ID and client options.
Processes input and returns updated emulator with output.
Renders the emulator screen.
Resets the terminal emulator to its initial state.
Resets a terminal mode.
Resizes the terminal to the specified dimensions.
Restores the previously saved terminal state.
Saves the current terminal state.
Scrolls the display down by the specified number of lines.
Scrolls the display up by the specified number of lines.
Sets a terminal attribute.
Sets cursor blinking state.
Sets the cursor position to the specified coordinates.
Sets the cursor style to :block, :line, or :underscore.
Sets cursor visibility.
Sets terminal dimensions after validation.
Sets a terminal mode.
Starts a linked terminal emulator process.
Starts text selection at the specified coordinates.
Switches to the alternate screen buffer.
Switches to the normal screen buffer.
Updates the active buffer with new content.
Updates auto wrap mode state.
Updates blink state (legacy compatibility).
Updates insert mode state.
Updates the selection endpoint to the specified coordinates.
Validates terminal dimensions.
Returns cursor visibility state.
Writes text to the terminal at the cursor position.
Writes data to the output buffer.
Types
@type t() :: %Raxol.Terminal.Emulator{ active: any(), active_buffer: any(), active_buffer_type: atom(), alternate: any(), alternate_screen_buffer: any(), bracketed_paste_active: boolean(), bracketed_paste_buffer: String.t(), buffer: any(), capabilities_manager: any(), charset_state: map(), client_options: map(), clipboard_manager: any(), color_manager: any(), color_palette: map(), command: any(), command_history: list(), config: any(), current_command_buffer: String.t(), current_hyperlink: any(), cursor: any(), cursor_blink_rate: non_neg_integer(), cursor_manager: any(), cursor_position_reported: boolean(), cursor_style: atom(), damage_tracker: any(), device_status_manager: any(), device_status_reported: boolean(), event: any(), font_manager: any(), graphics_manager: any(), height: non_neg_integer(), history_buffer: term(), hyperlink_manager: any(), icon_name: String.t() | nil, input_manager: any(), last_col_exceeded: boolean(), last_key_event: any(), main_screen_buffer: any(), max_command_history: non_neg_integer(), memory_limit: non_neg_integer(), metrics_manager: any(), mode_manager: any(), mode_manager_pid: any(), mode_state: map(), mouse_manager: any(), notification_manager: any(), output_buffer: list(), output_manager: any(), parser_state: any(), plugin_manager: any(), registry: any(), renderer: any(), saved_cursor: any(), screen_buffer_manager: any(), scroll_manager: any(), scroll_region: tuple(), scrollback_buffer: list(), scrollback_limit: non_neg_integer(), scrollback_manager: any(), selection_manager: any(), session_id: String.t(), session_manager: any(), sixel_state: any(), state: any(), state_manager: any(), state_stack: list(), style: any(), style_manager: any(), supervisor: any(), sync_manager: any(), tab_manager: any(), tab_stops: list(), terminal_state_manager: any(), theme_manager: any(), validation_service: any(), width: non_neg_integer(), window_manager: any(), window_registry: any(), window_state: map(), window_title: String.t() | nil }
Functions
Applies color changes (legacy compatibility).
Returns cursor blinking state.
@spec cleanup(t()) :: :ok
Cleans up emulator resources.
Clears the specified line.
Clears the entire screen.
Clears the screen and moves cursor to home position.
Clears the scrollback buffer.
Clears the current text selection.
Returns true if the cursor is blinking.
Returns true if the cursor is visible.
Deletes the character at the cursor position.
Deletes the specified number of characters.
Ends the current text selection.
Erases the specified number of characters.
Erases display content based on mode (0=to end, 1=from start, 2=entire).
Erases from cursor position to end of screen.
Erases from start of screen to cursor position.
Erases content within the display.
Erases content within the current line.
Erases line content based on mode.
Gets the configuration structure.
Gets the current cursor position as {x, y}.
Gets cursor position as a structured object.
Gets the current cursor style (:block, :line, :underscore).
Gets cursor visibility state.
Gets the terminal height in rows.
Gets the mode manager.
Gets cursor visibility from mode manager.
Gets output from the emulator.
Gets output buffer (legacy compatibility).
Gets the active screen buffer.
Gets the current scroll region as {top, bottom}.
Gets the scrollback buffer contents.
Gets the currently selected text.
Gets the terminal width in columns.
Handles ESC = sequence (DECKPAM - Enable application keypad mode).
Handles ESC > sequence (DECKPNM - Disable application keypad mode).
Returns true if text is currently selected.
Inserts a character at the cursor position.
Inserts the specified number of blank characters.
Performs automatic scrolling if needed.
Moves the cursor to the specified position.
Moves cursor back (stub implementation).
Moves cursor down (stub implementation).
Moves cursor forward (stub implementation).
Moves cursor to specified position.
Moves cursor to specified position with options.
Moves cursor up (stub implementation).
Creates a new terminal emulator.
Options
:use_genservers- Use GenServer processes for state management (default: false for performance):enable_history- Enable command history tracking (default: true):scrollback_limit- Number of scrollback lines (default: 1000):alternate_buffer- Create alternate screen buffer (default: true):session_id- Session identifier:client_options- Client-specific options
Examples
# Simple creation (no GenServers, optimized for performance)
emulator = Emulator.new(80, 24)
# Full featured with GenServers (for concurrent operations)
emulator = Emulator.new(80, 24, use_genservers: true)
# Minimal for benchmarking (no history, no alternate buffer)
emulator = Emulator.new(80, 24, enable_history: false, alternate_buffer: false)Creates a new terminal emulator with specified dimensions.
Creates a new terminal emulator with options.
Creates a new terminal emulator with session ID and client options.
Processes input and returns updated emulator with output.
Renders the emulator screen.
Resets the terminal emulator to its initial state.
Resets a terminal mode.
Resizes the terminal to the specified dimensions.
Restores the previously saved terminal state.
Saves the current terminal state.
Scrolls the display down by the specified number of lines.
Scrolls the display up by the specified number of lines.
Sets a terminal attribute.
Sets cursor blinking state.
Sets the cursor position to the specified coordinates.
Sets the cursor style to :block, :line, or :underscore.
Sets cursor visibility.
Sets terminal dimensions after validation.
Sets a terminal mode.
Starts a linked terminal emulator process.
This function starts a GenServer-based terminal emulator that can handle terminal operations asynchronously.
Options
:width- Terminal width in columns (default: 80):height- Terminal height in rows (default: 24):name- Optional process name for registration:session_id- Optional session identifier
Examples
{:ok, pid} = Emulator.start_link(width: 120, height: 40)Starts text selection at the specified coordinates.
Switches to the alternate screen buffer.
Switches to the normal screen buffer.
Updates the active buffer with new content.
Updates auto wrap mode state.
Updates blink state (legacy compatibility).
Updates insert mode state.
Updates the selection endpoint to the specified coordinates.
Validates terminal dimensions.
Returns cursor visibility state.
Writes text to the terminal at the cursor position.
Writes data to the output buffer.