Packages

raxol

1.5.4
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
33 Dependencies
2 Dependants
Files
Activity
raxol lib raxol terminal parser state_behaviour.ex
Raw

lib/raxol/terminal/parser/state_behaviour.ex 

defmodule Raxol.Terminal.Parser.StateBehaviour do

  @moduledoc """

  Defines the behaviour for parser states.

  """



  alias Raxol.Terminal.Emulator



  @type emulator :: Emulator.t()

  @type state :: any()



  @callback handle(emulator(), state(), binary()) ::

              {:continue, emulator(), state(), binary()}

              | {:finished, emulator(), state()}

              | {:incomplete, emulator(), state()}



  @callback handle_byte(byte(), emulator(), state()) ::

              {:ok, emulator(), state()} | {:error, atom(), emulator(), state()}



  @callback handle_escape(emulator(), state()) ::

              {:ok, emulator(), state()} | {:error, atom(), emulator(), state()}



  @callback handle_control_sequence(emulator(), state()) ::

              {:ok, emulator(), state()} | {:error, atom(), emulator(), state()}



  @callback handle_osc_string(emulator(), state()) ::

              {:ok, emulator(), state()} | {:error, atom(), emulator(), state()}



  @callback handle_dcs_string(emulator(), state()) ::

              {:ok, emulator(), state()} | {:error, atom(), emulator(), state()}



  @callback handle_apc_string(emulator(), state()) ::

              {:ok, emulator(), state()} | {:error, atom(), emulator(), state()}



  @callback handle_pm_string(emulator(), state()) ::

              {:ok, emulator(), state()} | {:error, atom(), emulator(), state()}



  @callback handle_sos_string(emulator(), state()) ::

              {:ok, emulator(), state()} | {:error, atom(), emulator(), state()}



  @callback handle_unknown(emulator(), state()) ::

              {:ok, emulator(), state()} | {:error, atom(), emulator(), state()}

end