Packages

raxol

1.0.1
2.6.0 2.4.0 2.3.0 2.2.0 2.1.0 2.0.1 2.0.0 1.5.4 1.4.1 1.0.1 1.0.0 0.9.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

Multi-surface application runtime for Elixir. One TEA module renders to terminal, browser (LiveView), SSH, and MCP (agents). 30+ widgets, flexbox + CSS grid, AI agent runtime, distributed swarm with CRDTs, time-travel debugging, session recording, sandboxed REPL, and agentic commerce.

HexDocs

Current section

Files

Jump to
Readme
18 Versions
34 Dependencies
Dependants
Files
Activity
raxol lib raxol terminal ansi terminal_state_behaviour.ex
Raw

lib/raxol/terminal/ansi/terminal_state_behaviour.ex 

defmodule Raxol.Terminal.ANSI.TerminalStateBehaviour do

  @moduledoc """

  Behaviour for managing terminal state saving and restoring.

  """



  alias Raxol.Terminal.Emulator

  # For the @type t and state_data_map

  alias Raxol.Terminal.ANSI.TerminalState



  # Represents the map of state data from restore_state

  @type state_data_map :: map()

  # or the emulator-like map passed to save_state's second arg.



  # The second argument to save_state is the current emulator state (or a map with similar structure)

  # from which fields like :cursor, :style, etc., are extracted.

  @callback save_state(

              stack :: TerminalState.state_stack(),

              current_emulator_state :: map()

            ) :: TerminalState.state_stack()



  @callback restore_state(stack :: TerminalState.state_stack()) ::

              {new_stack :: TerminalState.state_stack(),

               state_data :: state_data_map() | nil}



  @callback apply_restored_data(

              emulator_state :: Emulator.t(),

              state_data :: state_data_map() | nil,

              fields_to_restore :: list(atom())

            ) :: Emulator.t()

end