TKParser

Description

An internal class used by the TOMLKit module to parse a string into a dictionary

Properties

Name	Type	Read-Only
BaseDictionary	`Dictionary`
CurrentDictionary	`Dictionary`
DotDefinedDictionaries()	`Dictionary`
InlineArrays()	`Variant`
RowNumber	`Integer`
RowStartByteIndex	`Integer`
SectionDefinedDictionaries()	`Dictionary`
TOML	`String`
TOMLMemoryBlock	`MemoryBlock`

Methods

Name	Parameters	Returns
GetChunk	startIndex As `Integer`, endIndex As `Integer`	`String`
IndexOfByte	p As `Ptr`, lastByteIndex As `Integer`, byteIndex As `Integer`, targetByte As `Integer`	`Integer`
InterpretEscaped	p As `Ptr`, lastByteIndex As `Integer`, byteIndex As `Integer`	`String`
IsDictionaryArray	arr() As `Variant`	`Boolean`
MaybeParseArray	p As `Ptr`, lastByteIndex As `Integer`, byteIndex As `Integer`, value As `Variant`	`Boolean`
MaybeParseBoolean	p As `Ptr`, lastByteIndex As `Integer`, byteIndex As `Integer`, value As `Variant`	`Boolean`
MaybeParseComment	p As `Ptr`, lastByteIndex As `Integer`, byteIndex As `Integer`	`Boolean`
MaybeParseDateTime	p As `Ptr`, lastByteIndex As `Integer`, byteIndex As `Integer`, value As `Variant`	`Boolean`
MaybeParseNumber	p As `Ptr`, lastByteIndex As `Integer`, byteIndex As `Integer`, value As `Variant`	`Boolean`
MaybeParseString	p As `Ptr`, lastByteIndex As `Integer`, byteIndex As `Integer`, value As `Variant`	`Boolean`
MaybeParseTable	p As `Ptr`, lastByteIndex As `Integer`, byteIndex As `Integer`, value As `Variant`	`Boolean`
MaybeRaiseIllegalCharacterException	p As `Ptr`, lastByteIndex As `Integer`, byteIndex As `Integer`
MaybeRaiseInvalidUnderscoreException	p As `Ptr`, lastByteIndex As `Integer`, byteIndex As `Integer`
MaybeRaiseUnexpectedCharException	p As `Ptr`, lastByteIndex As `Integer`, byteIndex As `Integer`, expectedByte As `Integer`
MaybeRaiseUnexpectedEOLException	p As `Ptr`, lastByteIndex As `Integer`, byteIndex As `Integer`
Parse	toml As `String`	`Dictionary`
ParseBasicString	p As `Ptr`, lastByteIndex As `Integer`, byteIndex As `Integer`	`String`
ParseBinary	p As `Ptr`, lastByteIndex As `Integer`, byteIndex As `Integer`	`Integer`
ParseHex	p As `Ptr`, lastByteIndex As `Integer`, byteIndex As `Integer`	`Integer`
ParseKeyAndValueIntoDictionary	p As `Ptr`, lastByteIndex As `Integer`, byteIndex As `Integer`, intoDict As `Dictionary`, allowInline As `Boolean`
ParseKeys	p As `Ptr`, lastByteIndex As `Integer`, byteIndex As `Integer`	`String()`
ParseLiteralString	p As `Ptr`, lastByteIndex As `Integer`, byteIndex As `Integer`	`String`
ParseNextRow	p As `Ptr`, lastByteIndex As `Integer`, byteIndex As `Integer`
ParseOctal	p As `Ptr`, lastByteIndex As `Integer`, byteIndex As `Integer`	`Integer`
ParseValue	p As `Ptr`, lastByteIndex As `Integer`, byteIndex As `Integer`	`Variant`
RaiseDuplicateKeyException	key As `String`
RaiseException	msg As `String`
RaiseIllegalCharacterException	byteIndex As `Integer`
RaiseIllegalKeyException
RaiseUnexpectedCharException	p As `Ptr`, lastByteIndex As `Integer`, byteIndex As `Integer`, expectedByte As `Integer`
RaiseUnexpectedEndOfDataException
SkipToNextRow	p As `Ptr`, lastByteIndex As `Integer`, byteIndex As `Integer`
SkipWhitespace	p As `Ptr`, lastByteIndex As `Integer`, byteIndex As `Integer`

Constants

Name	Type
kErrorUnexpectedEOL	`String`

kErrorUnexpectedEOL As String Unexpected EOL error message.

Property Descriptions

BaseDictionary As Dictionary

Internal use.

CurrentDictionary As Dictionary

Internal use.

DotDefinedDictionaries() As Dictionary

Internal use.

InlineArrays() As Variant

Internal use.

RowNumber As Integer

Internal use.

RowStartByteIndex As Integer

Internal use.

SectionDefinedDictionaries() As Dictionary

Internal use.

TOML As String

Internal use.

TOMLMemoryBlock As MemoryBlock

Internal use.

Method Descriptions

GetChunk(startIndex As Integer, endIndex As Integer) As String

Internal use.

IndexOfByte(p As Ptr, lastByteIndex As Integer, byteIndex As Integer, targetByte As Integer) As Integer

Gets the index of the target byte in the row. Will stop at EOL or a comment.

InterpretEscaped(p As Ptr, lastByteIndex As Integer, byteIndex As Integer) As String

Internal use. Will raise an exception if it's not a valid escape character.

IsDictionaryArray(arr() As Variant) As Boolean

Internal use.

MaybeParseArray(p As Ptr, lastByteIndex As Integer, byteIndex As Integer, value As Variant) As Boolean

Internal use.

MaybeParseBoolean(p As Ptr, lastByteIndex As Integer, byteIndex As Integer, value As Variant) As Boolean

Internal use.

MaybeParseComment(p As Ptr, lastByteIndex As Integer, byteIndex As Integer) As Boolean

Internal use.

Should skip whitespace before calling this.

MaybeParseDateTime(p As Ptr, lastByteIndex As Integer, byteIndex As Integer, value As Variant) As Boolean

Internal use.

MaybeParseNumber(p As Ptr, lastByteIndex As Integer, byteIndex As Integer, value As Variant) As Boolean

Internal use.

MaybeParseString(p As Ptr, lastByteIndex As Integer, byteIndex As Integer, value As Variant) As Boolean

Internal use.

MaybeParseTable(p As Ptr, lastByteIndex As Integer, byteIndex As Integer, value As Variant) As Boolean

Internal use.

MaybeRaiseIllegalCharacterException(p As Ptr, lastByteIndex As Integer, byteIndex As Integer)

Internal use.

MaybeRaiseInvalidUnderscoreException(p As Ptr, lastByteIndex As Integer, byteIndex As Integer)

Internal use.

MaybeRaiseUnexpectedCharException(p As Ptr, lastByteIndex As Integer, byteIndex As Integer, expectedByte As Integer)

Internal use.

MaybeRaiseUnexpectedEOLException(p As Ptr, lastByteIndex As Integer, byteIndex As Integer)

Internal use.

Parse(toml As String) As Dictionary

Parses a TOML document string into a Dictionary.

ParseBasicString(p As Ptr, lastByteIndex As Integer, byteIndex As Integer) As String

Internal use.

ParseBinary(p As Ptr, lastByteIndex As Integer, byteIndex As Integer) As Integer

Internal use.

ParseHex(p As Ptr, lastByteIndex As Integer, byteIndex As Integer) As Integer

Internal use.

ParseKeyAndValueIntoDictionary(p As Ptr, lastByteIndex As Integer, byteIndex As Integer, intoDict As Dictionary, allowInline As Boolean)

Internal use.

ParseKeys(p As Ptr, lastByteIndex As Integer, byteIndex As Integer) As String()

Internal use.

Should be at the first non-whitespace position.

ParseLiteralString(p As Ptr, lastByteIndex As Integer, byteIndex As Integer) As String

Internal use.

ParseNextRow(p As Ptr, lastByteIndex As Integer, byteIndex As Integer)

Internal use.

ParseOctal(p As Ptr, lastByteIndex As Integer, byteIndex As Integer) As Integer

Internal use.

ParseValue(p As Ptr, lastByteIndex As Integer, byteIndex As Integer) As Variant

Internal use.

RaiseDuplicateKeyException(key As String)

Internal use.

RaiseException(msg As String)

Internal use.

RaiseIllegalCharacterException(byteIndex As Integer)

Internal use.

RaiseIllegalKeyException()

Internal use.

RaiseUnexpectedCharException(p As Ptr, lastByteIndex As Integer, byteIndex As Integer, expectedByte As Integer)

Internal use.

RaiseUnexpectedEndOfDataException()

Internal use.

SkipToNextRow(p As Ptr, lastByteIndex As Integer, byteIndex As Integer)

Internal use.

SkipWhitespace(p As Ptr, lastByteIndex As Integer, byteIndex As Integer)

Internal use.