Interface ILexer

Hierarchy

ILexer

Implemented by

Lexer

Index

Properties

debug

debug: boolean

logger

logger: Logger

Accessors

digested

get digested(): number
How many chars are digested.

Returns number
- Defined in src/lexer/model.ts:44

Methods

clone

clone(options?: {
debug?: boolean;
logger?: Logger;
}): ILexer
Clone a new lexer with the same state and definitions. If options.debug/logger is omitted, the new lexer will inherit from the original one.
Parameters
- Optional options: {
  debug?: boolean;
  logger?: Logger;
  }
  - Optional debug?: boolean
  - Optional logger?: Logger
Returns ILexer
- Defined in src/lexer/model.ts:35

dryClone

dryClone(options?: {
debug?: boolean;
logger?: Logger;
}): ILexer
Clone a new lexer with the same definitions, without states. If options.debug/logger is omitted, the new lexer will inherit from the original one.
Parameters
- Optional options: {
  debug?: boolean;
  logger?: Logger;
  }
  - Optional debug?: boolean
  - Optional logger?: Logger
Returns ILexer
- Defined in src/lexer/model.ts:40

feed

feed(input: string): ILexer
Append buffer with input.
Parameters
- input: string
Returns ILexer
- Defined in src/lexer/model.ts:42

getErrors

getErrors(): readonly Token[]
Get error tokens.

Returns readonly Token[]
- Defined in src/lexer/model.ts:98

getLineChars

getLineChars(): readonly number[]
Get how many chars in each line.

Returns readonly number[]
- Defined in src/lexer/model.ts:89

getPos

getPos(index: number): {
column: number;
line: number;
}
Get line number (starts from 1) and column number (starts from 1) from the index (starts from 0) of the input string.
Parameters
- index: number
Returns {
column: number;
line: number;
}
- column: number
- line: number
- Defined in src/lexer/model.ts:94

getRest

getRest(): string
Get the un-lexed string buffer.

Returns string
- Defined in src/lexer/model.ts:77

getTokenTypes

getTokenTypes(): Set<string>
Get all defined token types.

Returns Set<string>
- Defined in src/lexer/model.ts:85

hasErrors

hasErrors(): boolean
Returns boolean
- Defined in src/lexer/model.ts:99

hasRest

hasRest(): boolean
The rest of buffer not empty.

Returns boolean
- Defined in src/lexer/model.ts:81

lex

lex(input?: string | Readonly<{
    expect?: Readonly<{
        text?: string;
        type?: string;
    }>;
    input?: string;
}>): null | Token
Try to retrieve a token. If nothing match, return null.

You can provide expect to limit the token type/content to be accepted.
Parameters
- Optional input: string | Readonly<{
      expect?: Readonly<{
          text?: string;
          type?: string;
      }>;
      input?: string;
  }>
Returns null | Token
- Defined in src/lexer/model.ts:55

lexAll

lexAll(input?: string | {
input?: string;
stopOnError?: boolean;
}): Token[]
Try to retrieve a token list exhaustively.
Parameters
- Optional input: string | {
  input?: string;
  stopOnError?: boolean;
  }
Returns Token[]
- Defined in src/lexer/model.ts:69

reset

reset(): ILexer
Returns ILexer
- Defined in src/lexer/model.ts:30

take

take(n?: number): string
Take n chars from the rest of buffer and update state. This is useful when you have external logic to handle the token.
Parameters
- Optional n: number
Returns string
- Defined in src/lexer/model.ts:49

trimStart

trimStart(input?: string): ILexer
Remove ignored chars from the start of the rest of buffer.
Parameters
- Optional input: string
Returns ILexer
- Defined in src/lexer/model.ts:73

Interface ILexer

Hierarchy

Implemented by

Index

Properties

Accessors

Methods

Properties

debug

logger

Accessors

digested

Returns number

Methods

clone

Parameters

Optional options: { debug?: boolean; logger?: Logger; }

Optional debug?: boolean

Optional logger?: Logger

Returns ILexer

dryClone

Parameters

Optional options: { debug?: boolean; logger?: Logger; }

Optional debug?: boolean

Optional logger?: Logger

Returns ILexer

feed

Parameters

input: string

Returns ILexer

getErrors

Returns readonly Token[]

getLineChars

Returns readonly number[]

getPos

Parameters

index: number

Returns { column: number; line: number; }

column: number

line: number

getRest

Returns string

getTokenTypes

Returns Set<string>

hasErrors

Returns boolean

hasRest

Returns boolean

lex

Parameters

Optional input: string | Readonly<{ expect?: Readonly<{ text?: string; type?: string; }>; input?: string; }>

Returns null | Token

lexAll

Parameters

Optional input: string | { input?: string; stopOnError?: boolean; }

Returns Token[]

reset

Returns ILexer

take

Parameters

Optional n: number

Returns string

trimStart

Parameters

Optional input: string

Returns ILexer

Settings

Member Visibility

Theme

`Optional` options: {
debug?: boolean;
logger?: Logger;
}

`Optional` debug?: boolean

`Optional` logger?: Logger

`Optional` options: {
debug?: boolean;
logger?: Logger;
}

`Optional` debug?: boolean

`Optional` logger?: Logger

Returns {
column: number;
line: number;
}

`Optional` input: string | Readonly<{
expect?: Readonly<{
text?: string;
type?: string;
}>;
input?: string;
}>

`Optional` input: string | {
input?: string;
stopOnError?: boolean;
}

`Optional` n: number

`Optional` input: string