Raxol.Terminal.ANSI.Parser (Raxol v0.3.0)

View Source

ANSI escape sequence parser module.

Provides comprehensive parsing for ANSI escape sequences, determining the type of sequence and extracting its parameters for processing. This is the main entry point for parsing all ANSI sequences.

Summary

Functions

Parse a string containing ANSI escape sequences into tokens.

Parse an ANSI escape sequence and return its type and parameters.

Functions

parse(input)

Parse a string containing ANSI escape sequences into tokens.

This function scans through the input and returns a list of tokens, where each token is either a plain string or a parsed ANSI sequence.

Parameters

  • input - The string containing ANSI escape sequences

Returns

A list of tokens where each token is either:

  • A binary string (plain text)
  • A tuple representing a parsed ANSI sequence

Examples

iex> Raxol.Terminal.ANSI.Parser.parse("HelloWorld")
["Hello", {:text_attributes, [{:foreground_basic, 1}]}]

parse_sequence(sequence)

Parse an ANSI escape sequence and return its type and parameters.

Parameters

  • sequence - The ANSI sequence to parse

Returns

Parsed sequence as a tuple of type and parameters or error