Raxol.Terminal.Commands.CSIHandlers.Cursor (Raxol v0.5.0)

View Source

Handles CSI cursor control sequences.

Summary

Functions

Handles Cursor Horizontal Absolute (CHA - 'G')

Handles Cursor Next Line (CNL - 'E')

Handles cursor movement commands.

Handles Cursor Previous Line (CPL - 'F')

Handles Cursor Backward (CUB - 'D')

Handles Cursor Down (CUD - 'B')

Handles Cursor Forward (CUF - 'C')

Handles Cursor Position (CUP - 'H')

Handles Cursor Up (CUU - 'A')

Handles Horizontal Position Absolute (HPA - '`')

Handles Horizontal Position Relative (HPR - 'a')

Handles Vertical Position Absolute (VPA - 'd')

Functions

handle_cha(emulator, params)

@spec handle_cha(Raxol.Terminal.Emulator.t(), [integer()]) ::
  {:ok, Raxol.Terminal.Emulator.t()}
  | {:error, atom(), Raxol.Terminal.Emulator.t()}

Handles Cursor Horizontal Absolute (CHA - 'G')

handle_cnl(emulator, params)

@spec handle_cnl(Raxol.Terminal.Emulator.t(), [integer()]) ::
  {:ok, Raxol.Terminal.Emulator.t()}
  | {:error, atom(), Raxol.Terminal.Emulator.t()}

Handles Cursor Next Line (CNL - 'E')

handle_command(emulator, params, byte)

Handles cursor movement commands.

handle_cpl(emulator, params)

@spec handle_cpl(Raxol.Terminal.Emulator.t(), [integer()]) ::
  {:ok, Raxol.Terminal.Emulator.t()}
  | {:error, atom(), Raxol.Terminal.Emulator.t()}

Handles Cursor Previous Line (CPL - 'F')

handle_cub(emulator, params)

@spec handle_cub(Raxol.Terminal.Emulator.t(), [integer()]) ::
  {:ok, Raxol.Terminal.Emulator.t()}
  | {:error, atom(), Raxol.Terminal.Emulator.t()}

Handles Cursor Backward (CUB - 'D')

handle_cud(emulator, params)

@spec handle_cud(Raxol.Terminal.Emulator.t(), [integer()]) ::
  {:ok, Raxol.Terminal.Emulator.t()}
  | {:error, atom(), Raxol.Terminal.Emulator.t()}

Handles Cursor Down (CUD - 'B')

handle_cuf(emulator, params)

@spec handle_cuf(Raxol.Terminal.Emulator.t(), [integer()]) ::
  {:ok, Raxol.Terminal.Emulator.t()}
  | {:error, atom(), Raxol.Terminal.Emulator.t()}

Handles Cursor Forward (CUF - 'C')

handle_cup(emulator, params)

@spec handle_cup(Raxol.Terminal.Emulator.t(), [integer()]) ::
  {:ok, Raxol.Terminal.Emulator.t()}
  | {:error, atom(), Raxol.Terminal.Emulator.t()}

Handles Cursor Position (CUP - 'H')

handle_cuu(emulator, params)

@spec handle_cuu(Raxol.Terminal.Emulator.t(), [integer()]) ::
  {:ok, Raxol.Terminal.Emulator.t()}
  | {:error, atom(), Raxol.Terminal.Emulator.t()}

Handles Cursor Up (CUU - 'A')

handle_hpa(emulator, params)

@spec handle_hpa(Raxol.Terminal.Emulator.t(), [integer()]) ::
  {:ok, Raxol.Terminal.Emulator.t()}
  | {:error, atom(), Raxol.Terminal.Emulator.t()}

Handles Horizontal Position Absolute (HPA - '`')

handle_hpr(emulator, params)

@spec handle_hpr(Raxol.Terminal.Emulator.t(), [integer()]) ::
  {:ok, Raxol.Terminal.Emulator.t()}
  | {:error, atom(), Raxol.Terminal.Emulator.t()}

Handles Horizontal Position Relative (HPR - 'a')

handle_vpa(emulator, params)

@spec handle_vpa(Raxol.Terminal.Emulator.t(), [integer()]) ::
  {:ok, Raxol.Terminal.Emulator.t()}
  | {:error, atom(), Raxol.Terminal.Emulator.t()}

Handles Vertical Position Absolute (VPA - 'd')