Raxol.Terminal.Emulator.Adapter (Raxol v2.0.1)

View Source

Adapter module to make EmulatorLite compatible with existing code that expects the full Emulator struct.

This module provides conversion functions and compatibility shims.

Summary

Functions

ensure_emulator(emulator)

Ensures we have an Emulator struct, converting from EmulatorLite if needed.

ensure_lite(lite)

Ensures we have an EmulatorLite struct, converting from Emulator if needed.

from_lite(lite)

Converts an EmulatorLite to an Emulator struct for compatibility.

is_lite?(emulator) deprecated
lite?(arg1)

Checks if an emulator is the lite version (no GenServers).

to_lite(emulator)

Converts a full Emulator to EmulatorLite, discarding GenServer references.

Functions

ensure_emulator(emulator)

@spec ensure_emulator(Raxol.Terminal.Emulator.t() | Raxol.Terminal.EmulatorLite.t()) ::
  Raxol.Terminal.Emulator.t()

Ensures we have an Emulator struct, converting from EmulatorLite if needed.

This is a compatibility function for code that expects Emulator structs.

ensure_lite(lite)

@spec ensure_lite(Raxol.Terminal.Emulator.t() | Raxol.Terminal.EmulatorLite.t()) ::
  Raxol.Terminal.EmulatorLite.t()

Ensures we have an EmulatorLite struct, converting from Emulator if needed.

This is useful for performance-critical paths that don't need GenServers.

from_lite(lite)

@spec from_lite(Raxol.Terminal.EmulatorLite.t()) :: Raxol.Terminal.Emulator.t()

Converts an EmulatorLite to an Emulator struct for compatibility.

Note: This creates a "hollow" Emulator with nil PIDs for GenServers. It's suitable for parsing and buffer operations but not for full terminal emulation with concurrent state management.

is_lite?(emulator)

This function is deprecated. Use lite?/1 instead.

lite?(arg1)

@spec lite?(Raxol.Terminal.Emulator.t() | Raxol.Terminal.EmulatorLite.t()) ::
  boolean()

Checks if an emulator is the lite version (no GenServers).

to_lite(emulator)

@spec to_lite(Raxol.Terminal.Emulator.t()) :: Raxol.Terminal.EmulatorLite.t()

Converts a full Emulator to EmulatorLite, discarding GenServer references.

This is useful for extracting just the state without the process overhead.