Class Scanner

Scans an input text string for character symbols.

This scanner provides a reference to the current and next characters when parsing a string.

Hierarchy

Scanner

Index

Constructors

constructor

new Scanner(input): Scanner
Constructors a new lexer.
Parameters
- input: string
  
  The input haystack filter string to process.
Returns Scanner
- Defined in src/util/Scanner.ts:46

Properties

current

current: null | string = null

The current character read from the input.

index

index: number = 0

The current character index from the input.

`Readonly` input

input: string

The input string to read from.

next

next: null | string = null

The next character read from the input.

Methods

consume

consume(): Scanner
Consume the next character.

Returns Scanner
The scanner instance.
- Defined in src/util/Scanner.ts:58

consumeSpacesAndTabs

consumeSpacesAndTabs(): Scanner
Consume any space and tab characters.

This does not consume all different types of white space - just space and tab characters.

Returns Scanner
The scanner instance.
- Defined in src/util/Scanner.ts:152

consumeWhiteSpace

consumeWhiteSpace(): Scanner
Consume any white space characters.

Returns Scanner
The scanner instance.
- Defined in src/util/Scanner.ts:180

expect

expect(expected, id): Scanner
Expect the current character or throw an error.
Parameters
- expected: string
  
  The expected character.
- id: string
  
  The expected id.
Returns Scanner
The scanner instance.

Throws
An error if the two values don't match.
- Defined in src/util/Scanner.ts:91

expectAndConsumeNewLine

expectAndConsumeNewLine(id): Scanner
Expect a new line character and consume it.

This will handle carriage return line feeds as well.
Parameters
- id: string
  
  The expected id.
Returns Scanner
The scanner instance.

Throws
An error if a newline isn't found.
- Defined in src/util/Scanner.ts:73

is

is(c): boolean
Return true if the specified character matches the current character.
Parameters
- c: null | string
  
  The character to test.
Returns boolean
True if there's a match.
- Defined in src/util/Scanner.ts:133

isDigit

isDigit(): boolean
Return true if the current character is a valid digit.

Returns boolean
True if valid number.
- Defined in src/util/Scanner.ts:239

isEof

isEof(): boolean
Return true if the end of the data stream has been reached.

Returns boolean
True if EOF.
- Defined in src/util/Scanner.ts:142

isHex

isHex(): boolean
Return true if the current character is a valid hex character

Returns boolean
True if this is a hex character.
- Defined in src/util/Scanner.ts:282

isLetter

isLetter(): boolean
Return true if the current character is a valid letter (a-z and A-Z).

Returns boolean
True if valid letter.
- Defined in src/util/Scanner.ts:192

isLowerCase

isLowerCase(): boolean
Return true if the current character is a string and is lower case.

Returns boolean
True if lower case.
- Defined in src/util/Scanner.ts:350

isNewLine

isNewLine(): boolean
Return true if the current character is a newline.

Returns boolean
True if the current character is a new line.
- Defined in src/util/Scanner.ts:201

isSpaceOrTab

isSpaceOrTab(): boolean
Returns boolean
true if the current character is a space or tab.
- Defined in src/util/Scanner.ts:162

isUpperCase

isUpperCase(): boolean
Return true if the current character is a string and is upper case.

Returns boolean
True if upper case.
- Defined in src/util/Scanner.ts:327

isWhiteSpace

isWhiteSpace(): boolean
Return true if the current character is considered white space.

Returns boolean
True if white space.
- Defined in src/util/Scanner.ts:263

`Static` isDigit

isDigit(c): boolean
Return true if the character is a valid digit.
Parameters
- c: null | string
  
  The character to test.
Returns boolean
True if valid number.
- Defined in src/util/Scanner.ts:249

`Static` isHex

isHex(c): boolean
Return true if the character is a valid hex character
Parameters
- c: null | string
  
  The charcter to test.
Returns boolean
True if this is a hex character.
- Defined in src/util/Scanner.ts:292

`Static` isLetter

isLetter(c): boolean
Return true if the character is a valid letter (a-z and A-Z).
Parameters
- c: null | string
  
  The character to test.
Returns boolean
True if valid letter.
- Defined in src/util/Scanner.ts:221

`Static` isLowerCase

isLowerCase(c): boolean
Return true if the character is a string and is lower case.
Parameters
- c: null | string
  
  The character to test.
Returns boolean
True if lower case.
- Defined in src/util/Scanner.ts:360

`Static` isNewLine

isNewLine(c): boolean
Return true if the character is a newline.
Parameters
- c: null | string
  
  The character to test.
Returns boolean
True if the character is a new line.
- Defined in src/util/Scanner.ts:211

`Static` isSpaceOrTab

isSpaceOrTab(c): boolean
Return true if the character is a space or a tab.
Parameters
- c: null | string
  
  The character to test.
Returns boolean
True if a space or a tab.
- Defined in src/util/Scanner.ts:172

`Static` isUpperCase

isUpperCase(c): boolean
Return true if the character is a string and is upper case.
Parameters
- c: null | string
  
  The character to test.
Returns boolean
True if upper case.
- Defined in src/util/Scanner.ts:337

`Static` isWhiteSpace

isWhiteSpace(c): boolean
Return true if the character is considered white space.
Parameters
- c: null | string
  
  The character to test.
Returns boolean
True if white space.
- Defined in src/util/Scanner.ts:273

Generated using TypeDoc