From 1c64afec63c7f3981088c6c0782d5a637f0b2dfc Mon Sep 17 00:00:00 2001 From: Fynn Haupt <47634930+FynniX@users.noreply.github.com> Date: Sat, 20 Apr 2024 03:40:25 +0200 Subject: [PATCH] added prebuild --- docs/classes/index.MappedBuffer.html | 22 +- .../utils_BufferReader.BufferReader.html | 18 +- .../utils_BufferWriter.BufferWriter.html | 20 +- .../utils_SchemaReader.SchemaReader.html | 4 +- .../utils_StructBuilder.StructBuilder.html | 4 +- .../utils_parser_SchemaLexer.default.html | 4 +- .../utils_parser_SchemaListener.default.html | 30 +- ...tils_parser_SchemaParser.ArrayContext.html | 4 +- ..._parser_SchemaParser.DimensionContext.html | 4 +- ...ser_SchemaParser.PrimitiveTypeContext.html | 4 +- ...ils_parser_SchemaParser.SchemaContext.html | 4 +- ...ils_parser_SchemaParser.StructContext.html | 4 +- ...utils_parser_SchemaParser.TypeContext.html | 4 +- ...s_parser_SchemaParser.UserTypeContext.html | 4 +- .../utils_parser_SchemaParser.default.html | 4 +- .../utils_parser_SchemaVisitor.default.html | 16 +- .../enums_CollectionType.CollectionType.html | 4 +- ...enums_DeclarationType.DeclarationType.html | 4 +- docs/enums/enums_Endian.Endian.html | 4 +- .../enums_PrimitiveType.PrimitiveType.html | 4 +- docs/enums/enums_VarType.VarType.html | 4 +- .../utils_TypeSizes.calculateArraySize.html | 2 +- .../utils_TypeSizes.calculateStructSize.html | 2 +- .../utils_TypeSizes.getVarTypeSize.html | 2 +- ...faces_ArrayCollection.ArrayCollection.html | 4 +- .../interfaces_Collection.Collection.html | 4 +- ...ces_NodeMappedBuffer.NodeMappedBuffer.html | 4 +- docs/interfaces/interfaces_Struct.Struct.html | 2 +- ...ces_StructCollection.StructCollection.html | 2 +- docs/modules/enums_CollectionType.html | 2 +- docs/modules/enums_DeclarationType.html | 2 +- docs/modules/enums_Endian.html | 2 +- docs/modules/enums_PrimitiveType.html | 2 +- docs/modules/enums_VarType.html | 2 +- docs/modules/index.html | 2 +- docs/modules/interfaces_ArrayCollection.html | 2 +- docs/modules/interfaces_Collection.html | 2 +- docs/modules/interfaces_NodeMappedBuffer.html | 2 +- docs/modules/interfaces_Struct.html | 2 +- docs/modules/interfaces_StructCollection.html | 2 +- docs/modules/utils_BufferReader.html | 2 +- docs/modules/utils_BufferWriter.html | 2 +- docs/modules/utils_SchemaReader.html | 2 +- docs/modules/utils_StructBuilder.html | 2 +- docs/modules/utils_TypeSizes.html | 2 +- docs/modules/utils_parser_SchemaLexer.html | 2 +- docs/modules/utils_parser_SchemaListener.html | 2 +- docs/modules/utils_parser_SchemaParser.html | 2 +- docs/modules/utils_parser_SchemaVisitor.html | 2 +- package.json | 8 +- pnpm-lock.yaml | 2734 ++++++++++++----- 51 files changed, 2157 insertions(+), 817 deletions(-) diff --git a/docs/classes/index.MappedBuffer.html b/docs/classes/index.MappedBuffer.html index 33b9648..8fca012 100644 --- a/docs/classes/index.MappedBuffer.html +++ b/docs/classes/index.MappedBuffer.html @@ -159,7 +159,7 @@

Name

MappedBuffer

Description

A memory mapped buffer.

Type Parameters

  • T

    The interface of the struct.

    -

Constructors

Constructors

Properties

_addonInstance _template bufferPath @@ -172,26 +172,26 @@

Description

A memory mapped buffer.

Constructors

Properties

_addonInstance: NodeMappedBuffer

Description

The addon instance.

-
_template: StructCollection

Name

_template

+

Properties

_addonInstance: NodeMappedBuffer

Description

The addon instance.

+
_template: StructCollection

Name

_template

Description

The template of the struct.

-
bufferPath: string

Name

bufferPath

+
bufferPath: string

Name

bufferPath

Description

The path of the buffer.

-
bufferSize: number = 0

Name

bufferSize

+
bufferSize: number = 0

Name

bufferSize

Description

The size of the buffer in bytes.

-

Methods

Methods

  • Returns void

    Name

    create

    Description

    Creates the buffer.

    -
  • Returns void

    Name

    open

    Description

    Opens the buffer.

    -
  • Returns null | T

    The struct from the buffer.

    +
  • Returns null | T

    The struct from the buffer.

    Name

    read

    Description

    Reads the buffer.

    -
  • Parameters

    • data: Struct

      The struct to write to the buffer.

    Returns void

    Name

    write

    Description

    Writes to the buffer.

    -
  • Returns void

    Name

    close

    Description

    Closes the buffer.

    -

Name

BufferReader

Description

A buffer reader.

-

Constructors

Constructors

Properties

Methods

readNumber @@ -169,26 +169,26 @@

Description

A buffer reader.

Constructors

Properties

_buffer: Buffer

Name

_buffer

+

Properties

_buffer: Buffer

Name

_buffer

Description

The buffer.

-
_endian: Endian

Name

_endian

+
_endian: Endian

Name

_endian

Description

The endianness.

-

Methods

  • Reads a number value from the buffer based on the given variable type.

    +

Methods

  • Reads a number value from the buffer based on the given variable type.

    Parameters

    • type: VarType

      The variable type to read the number value from.

    Returns null | number

    The read number value or null if the buffer does not have enough bytes.

    -
  • Reads a boolean value from the buffer based on the given variable type.

    +
  • Reads a boolean value from the buffer based on the given variable type.

    Parameters

    • type: VarType

      The variable type to read the boolean value from.

    Returns null | boolean

    The read boolean value or null if the buffer does not have enough bytes.

    -
  • Reads an array from a template and returns it.

    Parameters

    Returns unknown[]

    The read array.

    -
  • Private

    Returns the internal type of a given variable type.

    Parameters

    • type: VarType

      The variable type to get the internal type for.

    Returns VarType

    The internal type of the given variable type.

    -

Name

BufferWriter

Description

A buffer writer.

-

Constructors

Constructors

Properties

Methods

writeNumber @@ -169,32 +169,32 @@

Description

A buffer writer.

getInternalType

Constructors

Properties

_buffer: Buffer = ...

Name

_buffer

+

Properties

_buffer: Buffer = ...

Name

_buffer

Description

The buffer.

-
_endian: Endian

Name

_endian

+
_endian: Endian

Name

_endian

Description

The endianness.

-

Methods

Methods

  • Writes a number to the buffer based on the specified type.

    Parameters

    • type: VarType

      The type of the number.

    • value: number

      The value to write.

    Returns void

    This function does not return anything.

    -
  • Writes a boolean value to the buffer based on the specified type.

    Parameters

    • type: VarType

      The type of the boolean value.

    • value: boolean

      The boolean value to write.

    Returns void

    This function does not return anything.

    -
  • Writes an array to the buffer based on the given template and value.

    Parameters

    • template: ArrayCollection

      The template of the array to write.

    • value: unknown[]

      The array to write.

    Returns void

    This function does not return anything.

    -
  • A description of the entire function.

    Parameters

    Returns void

    This function does not return anything.

    -

Constructors

constructor +

Constructors

Properties

Methods

Constructors

Properties

structs: Map<string, StructCollection> = ...

Methods

Constructors

constructor +

Constructors

Properties

Methods

Constructors

Properties

Methods

Hierarchy

  • Lexer
    • default

Constructors

constructor +

Hierarchy

  • Lexer
    • default

Constructors

Properties

Constructors

Properties

T__0: 1 = 1
T__1: 2 = 2
T__2: 3 = 3
T__3: 4 = 4
T__4: 5 = 5
T__5: 6 = 6
T__6: 7 = 7
T__7: 8 = 8
T__8: 9 = 9
T__9: 10 = 10
T__10: 11 = 11
T__11: 12 = 12
T__12: 13 = 13
T__13: 14 = 14
T__14: 15 = 15
T__15: 16 = 16
T__16: 17 = 17
T__17: 18 = 18
T__18: 19 = 19
T__19: 20 = 20
T__20: 21 = 21
SEMICOLON: 22 = 22
CURVED_BRACKET_OPEN: 23 = 23
CURVED_BRACKET_CLOSE: 24 = 24
BRACKET_OPEN: 25 = 25
BRACKET_CLOSE: 26 = 26
NAME: 27 = 27
NUMBER: 28 = 28
NEWLINE: 29 = 29
WHITESPACE: 30 = 30
EOF: number = Token.EOF
channelNames: string[] = ...
literalNames: (null | string)[] = ...
symbolicNames: (null | string)[] = ...
modeNames: string[] = ...
ruleNames: string[] = ...
_serializedATN: number[] = ...
__ATN: ATN
DecisionsToDFA: DFA[] = ...
DEFAULT_MODE: number
_input: CharStream
_interp: LexerATNSimulator
text: string
line: number
column: number
_tokenStartCharIndex: number
_tokenStartLine: number
_tokenStartColumn: number
_type: number
state: number

Accessors

Methods

  • Returns void

  • Returns Token

  • Returns void

  • Returns void

  • Parameters

    • m: number

    Returns void

  • Parameters

    • m: number

    Returns void

  • Returns number

  • Parameters

    • token: Token

    Returns void

  • Returns Token

  • Returns Token

  • Returns Token[]

  • Returns void

  • Parameters

    • listener: ErrorListener<number>

    Returns void

This interface defines a complete listener for a parse tree produced by SchemaParser.

-

Hierarchy

  • ParseTreeListener
    • default

Constructors

Hierarchy

  • ParseTreeListener
    • default

Constructors

Properties

Constructors

  • Returns default

Properties

enterSchema?: ((ctx) => void)

Enter a parse tree produced by SchemaParser.schema.

Type declaration

    • (ctx): void
    • Parameters

      Returns void

exitSchema?: ((ctx) => void)

Exit a parse tree produced by SchemaParser.schema.

+

Returns void

exitSchema?: ((ctx) => void)

Exit a parse tree produced by SchemaParser.schema.

Type declaration

    • (ctx): void
    • Parameters

      Returns void

enterStruct?: ((ctx) => void)

Enter a parse tree produced by SchemaParser.struct.

+

Returns void

enterStruct?: ((ctx) => void)

Enter a parse tree produced by SchemaParser.struct.

Type declaration

    • (ctx): void
    • Parameters

      Returns void

exitStruct?: ((ctx) => void)

Exit a parse tree produced by SchemaParser.struct.

+

Returns void

exitStruct?: ((ctx) => void)

Exit a parse tree produced by SchemaParser.struct.

Type declaration

    • (ctx): void
    • Parameters

      Returns void

enterType?: ((ctx) => void)

Enter a parse tree produced by SchemaParser.type.

+

Returns void

enterType?: ((ctx) => void)

Enter a parse tree produced by SchemaParser.type.

Type declaration

    • (ctx): void
    • Parameters

      Returns void

exitType?: ((ctx) => void)

Exit a parse tree produced by SchemaParser.type.

+

Returns void

exitType?: ((ctx) => void)

Exit a parse tree produced by SchemaParser.type.

Type declaration

    • (ctx): void
    • Parameters

      Returns void

enterArray?: ((ctx) => void)

Enter a parse tree produced by SchemaParser.array.

+

Returns void

enterArray?: ((ctx) => void)

Enter a parse tree produced by SchemaParser.array.

Type declaration

exitArray?: ((ctx) => void)

Exit a parse tree produced by SchemaParser.array.

+

Returns void

exitArray?: ((ctx) => void)

Exit a parse tree produced by SchemaParser.array.

Type declaration

enterDimension?: ((ctx) => void)

Enter a parse tree produced by SchemaParser.dimension.

+

Returns void

enterDimension?: ((ctx) => void)

Enter a parse tree produced by SchemaParser.dimension.

Type declaration

exitDimension?: ((ctx) => void)

Exit a parse tree produced by SchemaParser.dimension.

+

Returns void

exitDimension?: ((ctx) => void)

Exit a parse tree produced by SchemaParser.dimension.

Type declaration

enterPrimitiveType?: ((ctx) => void)

Enter a parse tree produced by SchemaParser.primitiveType.

+

Returns void

enterPrimitiveType?: ((ctx) => void)

Enter a parse tree produced by SchemaParser.primitiveType.

Type declaration

exitPrimitiveType?: ((ctx) => void)

Exit a parse tree produced by SchemaParser.primitiveType.

+

Returns void

exitPrimitiveType?: ((ctx) => void)

Exit a parse tree produced by SchemaParser.primitiveType.

Type declaration

enterUserType?: ((ctx) => void)

Enter a parse tree produced by SchemaParser.userType.

+

Returns void

enterUserType?: ((ctx) => void)

Enter a parse tree produced by SchemaParser.userType.

Type declaration

exitUserType?: ((ctx) => void)

Exit a parse tree produced by SchemaParser.userType.

+

Returns void

exitUserType?: ((ctx) => void)

Exit a parse tree produced by SchemaParser.userType.

Type declaration

Methods

Hierarchy

  • ParserRuleContext
    • ArrayContext

Constructors

constructor +

Hierarchy

  • ParserRuleContext
    • ArrayContext

Constructors

Properties

Constructors

Properties

start: Token
stop: undefined | Token
children: null | ParseTree[]
parentCtx: undefined | ParserRuleContext
exception?: RecognitionException
parser?: Parser
invokingState: number

Accessors

  • get ruleContext(): RuleContext
  • Returns RuleContext

Methods

  • Parameters

    • ctx: ParserRuleContext

    Returns void

  • Returns number

  • Parameters

    • i: number

    Returns ParseTree

  • Parameters

    • ttype: number
    • i: number

    Returns TerminalNode

  • Parameters

    • ttype: number

    Returns TerminalNode[]

  • Type Parameters

    • T extends ParserRuleContext
    • P extends Parser

    Parameters

    • ctxType: (new (parser?, parent?, invokingState?, ...args) => T)
        • new (parser?, parent?, invokingState?, ...args): T
        • Parameters

          • Optional parser: P
          • Optional parent: ParserRuleContext
          • Optional invokingState: number
          • Rest ...args: any[]

          Returns T

    • i: number

    Returns T

  • Type Parameters

    • T extends ParserRuleContext
    • P extends Parser

    Parameters

    • ctxType: (new (parser?, parent?, invokingState?, ...args) => T)
        • new (parser?, parent?, invokingState?, ...args): T
        • Parameters

          • Optional parser: P
          • Optional parent: ParserRuleContext
          • Optional invokingState: number
          • Rest ...args: any[]

          Returns T

    Returns T[]

  • Parameters

    • ruleNames: null | string[]
    • recog: Parser

    Returns string

  • Returns string

Hierarchy

  • ParserRuleContext
    • DimensionContext

Constructors

constructor +

Hierarchy

  • ParserRuleContext
    • DimensionContext

Constructors

Properties

Constructors

Properties

start: Token
stop: undefined | Token
children: null | ParseTree[]
parentCtx: undefined | ParserRuleContext
exception?: RecognitionException
parser?: Parser
invokingState: number

Accessors

  • get ruleContext(): RuleContext
  • Returns RuleContext

Methods

  • Parameters

    • ctx: ParserRuleContext

    Returns void

  • Returns number

  • Parameters

    • i: number

    Returns ParseTree

  • Parameters

    • ttype: number
    • i: number

    Returns TerminalNode

  • Parameters

    • ttype: number

    Returns TerminalNode[]

  • Type Parameters

    • T extends ParserRuleContext
    • P extends Parser

    Parameters

    • ctxType: (new (parser?, parent?, invokingState?, ...args) => T)
        • new (parser?, parent?, invokingState?, ...args): T
        • Parameters

          • Optional parser: P
          • Optional parent: ParserRuleContext
          • Optional invokingState: number
          • Rest ...args: any[]

          Returns T

    • i: number

    Returns T

  • Type Parameters

    • T extends ParserRuleContext
    • P extends Parser

    Parameters

    • ctxType: (new (parser?, parent?, invokingState?, ...args) => T)
        • new (parser?, parent?, invokingState?, ...args): T
        • Parameters

          • Optional parser: P
          • Optional parent: ParserRuleContext
          • Optional invokingState: number
          • Rest ...args: any[]

          Returns T

    Returns T[]

  • Parameters

    • ruleNames: null | string[]
    • recog: Parser

    Returns string

  • Returns string

Hierarchy

  • ParserRuleContext
    • PrimitiveTypeContext

Constructors

constructor +

Hierarchy

  • ParserRuleContext
    • PrimitiveTypeContext

Constructors

Properties

Constructors

Properties

start: Token
stop: undefined | Token
children: null | ParseTree[]
parentCtx: undefined | ParserRuleContext
exception?: RecognitionException
parser?: Parser
invokingState: number

Accessors

  • get ruleContext(): RuleContext
  • Returns RuleContext

Methods

  • Parameters

    • ctx: ParserRuleContext

    Returns void

  • Returns number

  • Parameters

    • i: number

    Returns ParseTree

  • Parameters

    • ttype: number
    • i: number

    Returns TerminalNode

  • Parameters

    • ttype: number

    Returns TerminalNode[]

  • Type Parameters

    • T extends ParserRuleContext
    • P extends Parser

    Parameters

    • ctxType: (new (parser?, parent?, invokingState?, ...args) => T)
        • new (parser?, parent?, invokingState?, ...args): T
        • Parameters

          • Optional parser: P
          • Optional parent: ParserRuleContext
          • Optional invokingState: number
          • Rest ...args: any[]

          Returns T

    • i: number

    Returns T

  • Type Parameters

    • T extends ParserRuleContext
    • P extends Parser

    Parameters

    • ctxType: (new (parser?, parent?, invokingState?, ...args) => T)
        • new (parser?, parent?, invokingState?, ...args): T
        • Parameters

          • Optional parser: P
          • Optional parent: ParserRuleContext
          • Optional invokingState: number
          • Rest ...args: any[]

          Returns T

    Returns T[]

  • Parameters

    • ruleNames: null | string[]
    • recog: Parser

    Returns string

  • Returns string

Hierarchy

  • ParserRuleContext
    • SchemaContext

Constructors

constructor +

Hierarchy

  • ParserRuleContext
    • SchemaContext

Constructors

Properties

Constructors

Properties

start: Token
stop: undefined | Token
children: null | ParseTree[]
parentCtx: undefined | ParserRuleContext
exception?: RecognitionException
parser?: Parser
invokingState: number

Accessors

  • get ruleContext(): RuleContext
  • Returns RuleContext

Methods

  • Parameters

    • ctx: ParserRuleContext

    Returns void

  • Returns number

  • Parameters

    • i: number

    Returns ParseTree

  • Parameters

    • ttype: number
    • i: number

    Returns TerminalNode

  • Parameters

    • ttype: number

    Returns TerminalNode[]

  • Type Parameters

    • T extends ParserRuleContext
    • P extends Parser

    Parameters

    • ctxType: (new (parser?, parent?, invokingState?, ...args) => T)
        • new (parser?, parent?, invokingState?, ...args): T
        • Parameters

          • Optional parser: P
          • Optional parent: ParserRuleContext
          • Optional invokingState: number
          • Rest ...args: any[]

          Returns T

    • i: number

    Returns T

  • Type Parameters

    • T extends ParserRuleContext
    • P extends Parser

    Parameters

    • ctxType: (new (parser?, parent?, invokingState?, ...args) => T)
        • new (parser?, parent?, invokingState?, ...args): T
        • Parameters

          • Optional parser: P
          • Optional parent: ParserRuleContext
          • Optional invokingState: number
          • Rest ...args: any[]

          Returns T

    Returns T[]

  • Parameters

    • ruleNames: null | string[]
    • recog: Parser

    Returns string

  • Returns string

Hierarchy

  • ParserRuleContext
    • StructContext

Constructors

constructor +

Hierarchy

  • ParserRuleContext
    • StructContext

Constructors

Properties

Constructors

Properties

start: Token
stop: undefined | Token
children: null | ParseTree[]
parentCtx: undefined | ParserRuleContext
exception?: RecognitionException
parser?: Parser
invokingState: number

Accessors

  • get ruleContext(): RuleContext
  • Returns RuleContext

Methods

  • Parameters

    • ctx: ParserRuleContext

    Returns void

  • Returns number

  • Parameters

    • i: number

    Returns ParseTree

  • Parameters

    • ttype: number
    • i: number

    Returns TerminalNode

  • Parameters

    • ttype: number

    Returns TerminalNode[]

  • Type Parameters

    • T extends ParserRuleContext
    • P extends Parser

    Parameters

    • ctxType: (new (parser?, parent?, invokingState?, ...args) => T)
        • new (parser?, parent?, invokingState?, ...args): T
        • Parameters

          • Optional parser: P
          • Optional parent: ParserRuleContext
          • Optional invokingState: number
          • Rest ...args: any[]

          Returns T

    • i: number

    Returns T

  • Type Parameters

    • T extends ParserRuleContext
    • P extends Parser

    Parameters

    • ctxType: (new (parser?, parent?, invokingState?, ...args) => T)
        • new (parser?, parent?, invokingState?, ...args): T
        • Parameters

          • Optional parser: P
          • Optional parent: ParserRuleContext
          • Optional invokingState: number
          • Rest ...args: any[]

          Returns T

    Returns T[]

  • Parameters

    • ruleNames: null | string[]
    • recog: Parser

    Returns string

  • Returns string

Hierarchy

  • ParserRuleContext
    • TypeContext

Constructors

constructor +

Hierarchy

  • ParserRuleContext
    • TypeContext

Constructors

Properties

Constructors

Properties

start: Token
stop: undefined | Token
children: null | ParseTree[]
parentCtx: undefined | ParserRuleContext
exception?: RecognitionException
parser?: Parser
invokingState: number

Accessors

  • get ruleContext(): RuleContext
  • Returns RuleContext

Methods

  • Parameters

    • ctx: ParserRuleContext

    Returns void

  • Returns number

  • Parameters

    • i: number

    Returns ParseTree

  • Parameters

    • ttype: number
    • i: number

    Returns TerminalNode

  • Parameters

    • ttype: number

    Returns TerminalNode[]

  • Type Parameters

    • T extends ParserRuleContext
    • P extends Parser

    Parameters

    • ctxType: (new (parser?, parent?, invokingState?, ...args) => T)
        • new (parser?, parent?, invokingState?, ...args): T
        • Parameters

          • Optional parser: P
          • Optional parent: ParserRuleContext
          • Optional invokingState: number
          • Rest ...args: any[]

          Returns T

    • i: number

    Returns T

  • Type Parameters

    • T extends ParserRuleContext
    • P extends Parser

    Parameters

    • ctxType: (new (parser?, parent?, invokingState?, ...args) => T)
        • new (parser?, parent?, invokingState?, ...args): T
        • Parameters

          • Optional parser: P
          • Optional parent: ParserRuleContext
          • Optional invokingState: number
          • Rest ...args: any[]

          Returns T

    Returns T[]

  • Parameters

    • ruleNames: null | string[]
    • recog: Parser

    Returns string

  • Returns string

Hierarchy

  • ParserRuleContext
    • UserTypeContext

Constructors

constructor +

Hierarchy

  • ParserRuleContext
    • UserTypeContext

Constructors

Properties

Constructors

Properties

start: Token
stop: undefined | Token
children: null | ParseTree[]
parentCtx: undefined | ParserRuleContext
exception?: RecognitionException
parser?: Parser
invokingState: number

Accessors

  • get ruleContext(): RuleContext
  • Returns RuleContext

Methods

  • Parameters

    • ctx: ParserRuleContext

    Returns void

  • Returns number

  • Parameters

    • i: number

    Returns ParseTree

  • Parameters

    • ttype: number
    • i: number

    Returns TerminalNode

  • Parameters

    • ttype: number

    Returns TerminalNode[]

  • Type Parameters

    • T extends ParserRuleContext
    • P extends Parser

    Parameters

    • ctxType: (new (parser?, parent?, invokingState?, ...args) => T)
        • new (parser?, parent?, invokingState?, ...args): T
        • Parameters

          • Optional parser: P
          • Optional parent: ParserRuleContext
          • Optional invokingState: number
          • Rest ...args: any[]

          Returns T

    • i: number

    Returns T

  • Type Parameters

    • T extends ParserRuleContext
    • P extends Parser

    Parameters

    • ctxType: (new (parser?, parent?, invokingState?, ...args) => T)
        • new (parser?, parent?, invokingState?, ...args): T
        • Parameters

          • Optional parser: P
          • Optional parent: ParserRuleContext
          • Optional invokingState: number
          • Rest ...args: any[]

          Returns T

    Returns T[]

  • Parameters

    • ruleNames: null | string[]
    • recog: Parser

    Returns string

  • Returns string

Hierarchy

  • Parser
    • default

Constructors

constructor +

Hierarchy

  • Parser
    • default

Constructors

Properties

Constructors

Properties

T__0: 1 = 1
T__1: 2 = 2
T__2: 3 = 3
T__3: 4 = 4
T__4: 5 = 5
T__5: 6 = 6
T__6: 7 = 7
T__7: 8 = 8
T__8: 9 = 9
T__9: 10 = 10
T__10: 11 = 11
T__11: 12 = 12
T__12: 13 = 13
T__13: 14 = 14
T__14: 15 = 15
T__15: 16 = 16
T__16: 17 = 17
T__17: 18 = 18
T__18: 19 = 19
T__19: 20 = 20
T__20: 21 = 21
SEMICOLON: 22 = 22
CURVED_BRACKET_OPEN: 23 = 23
CURVED_BRACKET_CLOSE: 24 = 24
BRACKET_OPEN: 25 = 25
BRACKET_CLOSE: 26 = 26
NAME: 27 = 27
NUMBER: 28 = 28
NEWLINE: 29 = 29
WHITESPACE: 30 = 30
EOF: number = Token.EOF
RULE_schema: 0 = 0
RULE_struct: 1 = 1
RULE_type: 2 = 2
RULE_array: 3 = 3
RULE_dimension: 4 = 4
RULE_primitiveType: 5 = 5
RULE_userType: 6 = 6
literalNames: (null | string)[] = ...
symbolicNames: (null | string)[] = ...
ruleNames: string[] = ...
_serializedATN: number[] = ...
__ATN: ATN
DecisionsToDFA: DFA[] = ...
_input: TokenStream
_ctx: ParserRuleContext
_interp: ParserATNSimulator
_errHandler: ErrorStrategy
_parseListeners?: any[]
matchedEOF: boolean
buildParseTrees: boolean
printer?: Printer
syntaxErrorsCount: number
state: number

Accessors

Methods

  • Parameters

    • Optional predicate: string
    • Optional message: string

    Returns FailedPredicateException

  • Parameters

    • ttype: number

    Returns Token

  • Returns Token

  • Returns Token

  • Parameters

    • localctx: ParserRuleContext
    • state: number
    • ruleIndex: number

    Returns void

  • Returns void

  • Returns void

  • Parameters

    • localctx: ParserRuleContext
    • altNum: number

    Returns void

  • Parameters

    • localctx: ParserRuleContext
    • state: number
    • ruleIndex: number
    • precedence: number

    Returns void

  • Parameters

    • localctx: ParserRuleContext
    • state: number
    • ruleIndex: number

    Returns void

  • Parameters

    • parentCtx: ParserRuleContext

    Returns void

  • Parameters

    • localctx: ParserRuleContext
    • precedence: number

    Returns boolean

  • Returns string[]

  • Returns void

  • Returns IntervalSet

  • Returns TokenStream

  • Returns void

  • Parameters

    • input: TokenStream

    Returns void

  • Parameters

    • msg: string
    • offendingToken: Token
    • err: undefined | RecognitionException

    Returns void

  • Returns Token

  • Returns void

  • Parameters

    • listener: ErrorListener<Token>

    Returns void

Enumeration Members

Array +

Enumeration Members

Enumeration Members

Array: "array"
Struct: "struct"

Enumeration Members

Unknown +

Enumeration Members

Enumeration Members

Unknown: 0
Primitive: 1
User: 2

Enumeration Members

Big +

Enumeration Members

Enumeration Members

Big: "BE"
Little: "LE"

Enumeration Members

char +

Enumeration Members

char char16_t char32_t wchar_t @@ -176,7 +176,7 @@ float double bool -

Enumeration Members

char: "char"
char16_t: "char16_t"
char32_t: "char32_t"
wchar_t: "wchar_t"
unsigned: "unsigned"
signed: "signed"
short: "short"
int: "int"
long: "long"
int8_t: "int8_t"
int16_t: "int16_t"
int32_t: "int32_t"
int64_t: "int64_t"
uint8_t: "uint8_t"
uint16_t: "uint16_t"
uint32_t: "uint32_t"
uint64_t: "uint64_t"
float: "float"
double: "double"
bool: "bool"

Enumeration Members

char +

Enumeration Members

char char16_t char32_t wchar_t @@ -180,7 +180,7 @@ float double bool -

Enumeration Members

char: "char"
char16_t: "char16_t"
char32_t: "char32_t"
wchar_t: "wchar_t"
unsigned_char: "unsigned_char"
short_int: "short_int"
int: "int"
long_int: "long_int"
long_long_int: "long_long_int"
unsigned_short_int: "unsigned_short_int"
unsigned_int: "unsigned_int"
unsigned_long_int: "unsigned_long_int"
unsigned_long_long_int: "unsigned_long_long_int"
int8_t: "int8_t"
int16_t: "int16_t"
int32_t: "int32_t"
int64_t: "int64_t"
uint8_t: "uint8_t"
uint16_t: "uint16_t"
uint32_t: "uint32_t"
uint64_t: "uint64_t"
float: "float"
double: "double"
bool: "bool"
  • Calculates the size of an array based on the given array collection.

    Parameters

    Returns number

    The size of the array.

    -
  • Calculates the size of a struct based on the given struct collection.

    Parameters

    Returns number

    The size of the struct.

    -
  • Returns the size of the given variable type.

    Parameters

    • type: VarType

      The variable type to get the size of.

    Returns undefined | number

    The size of the variable type, or undefined if the type is not recognized.

    -
interface ArrayCollection {
    type: VarType | Collection;
    size: number;
}

Properties

type +
interface ArrayCollection {
    type: VarType | Collection;
    size: number;
}

Properties

Properties

size: number
interface Collection {
    type: CollectionType;
    data?: ArrayCollection | StructCollection;
}

Properties

type +
interface Collection {
    type: CollectionType;
    data?: ArrayCollection | StructCollection;
}

Properties

Properties

interface NodeMappedBuffer {
    create(): void;
    open(): void;
    read(): undefined | Buffer;
    write(buffer): void;
    close(): void;
}

Methods

create +
interface NodeMappedBuffer {
    create(): void;
    open(): void;
    read(): undefined | Buffer;
    write(buffer): void;
    close(): void;
}

Methods

interface Struct {
    [key: string]: number | boolean | Struct | unknown[] | null;
}

Indexable

[key: string]: number | boolean | Struct | unknown[] | null
interface Struct {
    [key: string]: number | boolean | Struct | unknown[] | null;
}

Indexable

[key: string]: number | boolean | Struct | unknown[] | null
interface StructCollection {
    [key: string]: VarType | Collection;
}

Indexable

[key: string]: VarType | Collection
interface StructCollection {
    [key: string]: VarType | Collection;
}

Indexable

[key: string]: VarType | Collection

Module enums/CollectionType

Index

Enumerations

CollectionType +

Module enums/CollectionType

Index

Enumerations

Module enums/DeclarationType

Index

Enumerations

DeclarationType +

Module enums/DeclarationType

Index

Enumerations

Index

Enumerations

Endian +

Index

Enumerations

Module enums/PrimitiveType

Index

Enumerations

PrimitiveType +

Module enums/PrimitiveType

Index

Enumerations

Index

Enumerations

VarType +

Index

Enumerations

Index

Classes

MappedBuffer +

Index

Classes

Module interfaces/ArrayCollection

Index

Interfaces

ArrayCollection +

Module interfaces/Collection

Index

Interfaces

Collection +

Module interfaces/Collection

Index

Interfaces

Module interfaces/NodeMappedBuffer

Index

Interfaces

NodeMappedBuffer +

Module interfaces/Struct

Index

Interfaces

Struct +

Module interfaces/Struct

Index

Interfaces

Module interfaces/StructCollection

Index

Interfaces

StructCollection +

Module utils/BufferReader

Index

Classes

BufferReader +

Module utils/BufferWriter

Index

Classes

BufferWriter +

Module utils/SchemaReader

Index

Classes

SchemaReader +

Module utils/StructBuilder

Index

Classes

StructBuilder +

Module utils/TypeSizes

Index

Functions

getVarTypeSize +

Module utils/parser/SchemaLexer

Index

Classes

default +

Module utils/parser/SchemaLexer

Index

Classes

Module utils/parser/SchemaListener

Index

Classes

default +

Module utils/parser/SchemaParser

Index

Classes

default +

Module utils/parser/SchemaParser

Index

Classes

default SchemaContext StructContext TypeContext diff --git a/docs/modules/utils_parser_SchemaVisitor.html b/docs/modules/utils_parser_SchemaVisitor.html index 282bc67..cf7e989 100644 --- a/docs/modules/utils_parser_SchemaVisitor.html +++ b/docs/modules/utils_parser_SchemaVisitor.html @@ -156,7 +156,7 @@ --md-sys-color-surface-container-high: #f2e5e4; --md-sys-color-surface-container-highest: #ece0df } -

Module utils/parser/SchemaVisitor

Index

Classes

default +