Raxol.Terminal.ModeManager (Raxol v2.0.1)

View Source

Manages terminal modes (DEC Private Modes, Standard Modes) and their effects.

This module centralizes the state and logic for various terminal modes, handling both simple flag toggles and modes with side effects on the emulator state (like screen buffer switching or resizing).

Summary

Types

mode()
t()

Functions

get_manager(state)

Gets the mode manager.

get_set_modes(state)

Gets the set modes.

lookup_private(code)

Looks up a DEC private mode code and returns the corresponding mode atom.

lookup_standard(code)

Looks up a standard mode code and returns the corresponding mode atom.

mode_enabled?(state, mode)
mode_set?(state, mode)

Checks if the given mode is set.

new()

Creates a new mode manager with default values.

reset_all_modes(state)

Resets all modes.

reset_mode(emulator, modes, category \\ nil)

Resets one or more modes. Dispatches to specific handlers. Returns potentially updated Emulator state if side effects occurred.

restore_modes(state)

Restores the saved modes.

restore_state(emulator)

Restores the previously saved terminal state.

save_modes(state)

Saves the current modes.

save_state(emulator)

Saves the current terminal state.

set_mode(emulator, modes, category \\ nil)

Sets one or more modes. Dispatches to specific handlers. Returns potentially updated Emulator state if side effects occurred.

set_mode(emulator, mode_name, value, options)

Sets a mode with a value and options.

set_mode_with_private(emulator, mode, value, private)

Sets a mode with a value and private flag.

set_private_mode(emulator, mode, value)

Sets a private mode with a value.

set_standard_mode(emulator, mode, value)

Sets a standard mode with a value.

update_auto_repeat_mode(emulator, value)

Updates the auto repeat mode.

update_auto_wrap_mode(emulator, value)

Updates the auto wrap mode.

update_bracketed_paste_mode(emulator, value)

Updates the bracketed paste mode.

update_column_width_132(emulator, value)

Updates the column width 132 mode.

update_cursor_visible(emulator, value)

Updates the cursor visible mode.

update_insert_mode(emulator, value)

Updates the insert mode.

update_interlacing_mode(emulator, value)

Updates the interlacing mode.

update_line_feed_mode(emulator, value)

Updates the line feed mode.

update_manager(state, modes)

Updates the mode manager.

update_origin_mode(emulator, value)

Updates the origin mode.

update_screen_mode_reverse(emulator, value)

Updates the screen mode reverse.

Types

mode()

@type mode() :: atom()

t()

@type t() :: %Raxol.Terminal.ModeManager{
  active_buffer_type: term(),
  alt_screen_mode: term(),
  alternate_buffer_active: term(),
  auto_repeat_mode: term(),
  auto_wrap: term(),
  bracketed_paste_mode: term(),
  column_width_mode: term(),
  cursor_keys_mode: term(),
  cursor_visible: term(),
  focus_events_enabled: term(),
  insert_mode: term(),
  interlacing_mode: term(),
  line_feed_mode: term(),
  mouse_report_mode: term(),
  origin_mode: term(),
  screen_mode_reverse: term()
}

Functions

get_manager(state)

@spec get_manager(t()) :: map()

Gets the mode manager.

get_set_modes(state)

@spec get_set_modes(t()) :: list()

Gets the set modes.

lookup_private(code)

@spec lookup_private(integer()) :: mode() | nil

Looks up a DEC private mode code and returns the corresponding mode atom.

lookup_standard(code)

@spec lookup_standard(integer()) :: mode() | nil

Looks up a standard mode code and returns the corresponding mode atom.

mode_enabled?(state, mode)

@spec mode_enabled?(t(), mode()) :: boolean()

mode_set?(state, mode)

@spec mode_set?(t(), atom()) :: boolean()

Checks if the given mode is set.

new()

@spec new() :: t()

Creates a new mode manager with default values.

reset_all_modes(state)

@spec reset_all_modes(t()) :: t()

Resets all modes.

reset_mode(emulator, modes, category \\ nil)

@spec reset_mode(Raxol.Terminal.Emulator.t(), [mode()], atom() | nil) ::
  {:ok, Raxol.Terminal.Emulator.t()} | {:error, term()}

Resets one or more modes. Dispatches to specific handlers. Returns potentially updated Emulator state if side effects occurred.

restore_modes(state)

@spec restore_modes(t()) :: t()

Restores the saved modes.

restore_state(emulator)

@spec restore_state(Raxol.Terminal.Emulator.t()) :: Raxol.Terminal.Emulator.t()

Restores the previously saved terminal state.

save_modes(state)

@spec save_modes(t()) :: t()

Saves the current modes.

save_state(emulator)

@spec save_state(Raxol.Terminal.Emulator.t()) :: Raxol.Terminal.Emulator.t()

Saves the current terminal state.

set_mode(emulator, modes, category \\ nil)

@spec set_mode(Raxol.Terminal.Emulator.t(), [mode()], atom() | nil) ::
  {:ok, Raxol.Terminal.Emulator.t()} | {:error, term()}

Sets one or more modes. Dispatches to specific handlers. Returns potentially updated Emulator state if side effects occurred.

set_mode(emulator, mode_name, value, options)

@spec set_mode(Raxol.Terminal.Emulator.t(), atom(), any(), keyword()) ::
  {:ok, Raxol.Terminal.Emulator.t()} | {:error, term()}

Sets a mode with a value and options.

set_mode_with_private(emulator, mode, value, private)

@spec set_mode_with_private(Raxol.Terminal.Emulator.t(), mode(), boolean(), boolean()) ::
  {:ok, Raxol.Terminal.Emulator.t()} | {:error, term()}

Sets a mode with a value and private flag.

set_private_mode(emulator, mode, value)

@spec set_private_mode(Raxol.Terminal.Emulator.t(), mode(), boolean()) ::
  {:ok, Raxol.Terminal.Emulator.t()} | {:error, term()}

Sets a private mode with a value.

set_standard_mode(emulator, mode, value)

@spec set_standard_mode(Raxol.Terminal.Emulator.t(), mode(), boolean()) ::
  {:ok, Raxol.Terminal.Emulator.t()} | {:error, term()}

Sets a standard mode with a value.

update_auto_repeat_mode(emulator, value)

@spec update_auto_repeat_mode(Raxol.Terminal.Emulator.t(), boolean()) ::
  Raxol.Terminal.Emulator.t()

Updates the auto repeat mode.

update_auto_wrap_mode(emulator, value)

@spec update_auto_wrap_mode(Raxol.Terminal.Emulator.t(), boolean()) ::
  Raxol.Terminal.Emulator.t()

Updates the auto wrap mode.

update_bracketed_paste_mode(emulator, value)

@spec update_bracketed_paste_mode(Raxol.Terminal.Emulator.t(), boolean()) ::
  Raxol.Terminal.Emulator.t()

Updates the bracketed paste mode.

update_column_width_132(emulator, value)

@spec update_column_width_132(Raxol.Terminal.Emulator.t(), boolean()) ::
  Raxol.Terminal.Emulator.t()

Updates the column width 132 mode.

update_cursor_visible(emulator, value)

@spec update_cursor_visible(Raxol.Terminal.Emulator.t(), boolean()) ::
  Raxol.Terminal.Emulator.t()

Updates the cursor visible mode.

update_insert_mode(emulator, value)

@spec update_insert_mode(Raxol.Terminal.Emulator.t(), boolean()) ::
  Raxol.Terminal.Emulator.t()

Updates the insert mode.

update_interlacing_mode(emulator, value)

@spec update_interlacing_mode(Raxol.Terminal.Emulator.t(), boolean()) ::
  Raxol.Terminal.Emulator.t()

Updates the interlacing mode.

update_line_feed_mode(emulator, value)

@spec update_line_feed_mode(Raxol.Terminal.Emulator.t(), boolean()) ::
  Raxol.Terminal.Emulator.t()

Updates the line feed mode.

update_manager(state, modes)

@spec update_manager(t(), map()) :: t()

Updates the mode manager.

update_origin_mode(emulator, value)

@spec update_origin_mode(Raxol.Terminal.Emulator.t(), boolean()) ::
  Raxol.Terminal.Emulator.t()

Updates the origin mode.

update_screen_mode_reverse(emulator, value)

@spec update_screen_mode_reverse(Raxol.Terminal.Emulator.t(), boolean()) ::
  Raxol.Terminal.Emulator.t()

Updates the screen mode reverse.