1. Home
  2. API
  3. XenoAtom.Ansi.Tokens
  4. CsiToken

CsiToken Class

Definition

Assembly XenoAtom.Ansi.dll
Inherits Object → AnsiToken
Show inherited members (4)

Represents a CSI (Control Sequence Introducer) sequence, typically of the form ESC [ parameters intermediates final.

[NullableContext((byte)1)]
[Nullable((byte)0)]
public sealed record CsiToken : AnsiToken, IEquatable<AnsiToken>, IEquatable<CsiToken>

Remarks

Examples:

  • ESC [ 31 m (SGR red foreground)
  • ESC [ ? 25 l (hide cursor)
Tip: use kind:method, kind:property, kind:ctor. Press Esc to clear.

Constructors (1)

CsiToken(String, Int32[], Char, Nullable<Char>, String?)

Properties (6)

EqualityContract
FinalFinal byte (0x40–0x7E) identifying the command.
IntermediatesIntermediate bytes (0x20–0x2F) captured as a string.
Parameters
PrivateMarker
RawOptional raw sequence as encountered.

Methods (8)

<Clone>$()
Deconstruct(out String, out Int32[], out Char, out Nullable<Char>, out String?)
Equals(Object?)
Equals(AnsiToken?)
Equals(CsiToken?)
GetHashCode()
PrintMembers(StringBuilder)
ToString()

Operators (2)

Equality(CsiToken?, CsiToken?)
Inequality(CsiToken?, CsiToken?)

Extensions (4)

TryGetCursorPositionReport(CsiToken, out AnsiCursorPosition)
TryGetKeyEvent(CsiToken, out AnsiKeyEvent)Attempts to interpret a CSI token as a key event (Windows Console VT / xterm conventions).
TryGetSgrMouseEvent(CsiToken, out AnsiMouseEvent)Attempts to interpret a CsiToken as an xterm SGR mouse event (CSI < b ; x ; y M/m).
TryGetCursorStyle(CsiToken, out AnsiCursorStyle)Attempts to interpret this token as a DECSCUSR cursor style sequence (ESC [ n SP q).