Class HedStringTokenizer

Class for tokenizing HED strings.

Constructors

constructor

new HedStringTokenizer(hedString: string): HedStringTokenizer
Constructor.
Parameters
- hedString: string
  The HED string to tokenize.
Returns HedStringTokenizer
- Defined in src/parser/tokenizer.js:153

Properties

hedString

hedString: string

The HED string being tokenized.

issues

issues: Issue[]

The issues found during tokenization.

`Internal`state

state: TokenizerState

The current state of the tokenizer.

Methods

_checkForBadPlaceholderIssues

_checkForBadPlaceholderIssues(): string
Internal
Check for issues related to placeholders in the current token.

Returns string
empty string if no issues, otherwise a message describing the issue.
- Defined in src/parser/tokenizer.js:494

closeGroup

closeGroup(i: number): void
Internal
Close the current group.
Parameters
- i: number
  The current index in the HED string.
Returns void
- Defined in src/parser/tokenizer.js:514

finalizeTokenizer

finalizeTokenizer(): void
Internal
Finalize the tokenization process.

Returns void
- Defined in src/parser/tokenizer.js:202

handleCharacter

handleCharacter(i: number, character: string): void
Internal
Handle a single character during tokenization.
Parameters
- i: number
  The index of the character.
- character: string
  The character to handle.
Returns void
- Defined in src/parser/tokenizer.js:263

handleClosingColumn

handleClosingColumn(i: number): void
Internal
Handle a closing column character.
Parameters
- i: number
  The index of the closing column character.
Returns void
- Defined in src/parser/tokenizer.js:414

handleClosingGroup

handleClosingGroup(i: number): void
Internal
Handle a closing group character.
Parameters
- i: number
  The index of the closing group character.
Returns void
- Defined in src/parser/tokenizer.js:375

handleColon

handleColon(i: number): void
Internal
Handle a colon character.
Parameters
- i: number
  The index of the colon.
Returns void
- Defined in src/parser/tokenizer.js:434

handleComma

handleComma(i: number): void
Internal
Handle a comma character.
Parameters
- i: number
  The index of the comma.
Returns void
- Defined in src/parser/tokenizer.js:288

handleOpeningColumn

handleOpeningColumn(i: number): void
Internal
Handle an opening column character.
Parameters
- i: number
  The index of the opening column character.
Returns void
- Defined in src/parser/tokenizer.js:399

handleOpeningGroup

handleOpeningGroup(i: number): void
Internal
Handle an opening group character.
Parameters
- i: number
  The index of the opening group character.
Returns void
- Defined in src/parser/tokenizer.js:348

handleSlash

handleSlash(i: number): void
Internal
Handle a slash character.
Parameters
- i: number
  The index of the slash.
Returns void
- Defined in src/parser/tokenizer.js:325

initializeTokenizer

initializeTokenizer(): void
Internal
Initialize the tokenizer.

Returns void
- Defined in src/parser/tokenizer.js:251

pushInvalidCharacterIssue

pushInvalidCharacterIssue(character: string, index: number, msg?: string): void
Internal
Push an invalid character issue to the issue list.
Parameters
- character: string
  The invalid character.
- index: number
  The index of the character.
- msg: string = ''
  An optional message to include with the error.
Returns void
- Defined in src/parser/tokenizer.js:555

pushInvalidTag

pushInvalidTag(
    issueCode: string,
    index: number,
    tag: string,
    msg?: string,
): void
Internal
Push an invalid tag issue to the issue list.
Parameters
- issueCode: string
  The issue code.
- index: number
  The index of the issue.
- tag: string
  The invalid tag.
- msg: string = ''
  An optional message to include with the error.
Returns void
- Defined in src/parser/tokenizer.js:544

pushIssue

pushIssue(issueCode: string, index: number, msg?: string): void
Internal
Push an issue to the issue list.
Parameters
- issueCode: string
  The issue code.
- index: number
  The index of the issue.
- msg: string = ''
  An optional message to include with the error
Returns void
- Defined in src/parser/tokenizer.js:532

pushTag

pushTag(i: number): void
Internal
Push a tag to the current group stack.
Parameters
- i: number
  The current index in the HED string.
Returns void
- Defined in src/parser/tokenizer.js:467

resetToken

resetToken(i: number): void
Internal
Reset the current token.
Parameters
- i: number
  The current index in the HED string.
Returns void
- Defined in src/parser/tokenizer.js:191

tokenize

tokenize(): any[]
Split the HED string into delimiters and tags.

Returns any[]
- [TagSpec[], GroupSpec, Issue[]] representing the tag specifications, group bounds, and any issues found.
- Defined in src/parser/tokenizer.js:164

unwindGroupStack

unwindGroupStack(): void
Internal
Unwind the group stack to handle unclosed groups.

Returns void
- Defined in src/parser/tokenizer.js:451