Class RollParser

A class for transforming events from the Peggy grammar lexer into various formats.

Index

Constructors

Properties

Methods

_collapseOperators _onDiceTerm _onExpression _onFunctionTerm _onNumericTerm _onParenthetical _onPoolTerm _onStringTerm _wrapNegativeTerm flattenTree formatArg formatDebug formatList isOperatorTerm toAST

Constructors

constructor

new RollParser(formula: string): RollParser
Parameters
- formula: string
  The full formula.
Returns RollParser

Properties

formula

formula: string

The full formula.

Methods

`Protected`_collapseOperators

_collapseOperators(operators: string[]): string
Protected
Collapse multiple additive operators into a single one.
Parameters
- operators: string[]
  A sequence of additive operators.
Returns string

`Protected`_onDiceTerm

_onDiceTerm(
    number: RollParseNode | null,
    faces: string | RollParseNode | null,
    modifiers: string | null,
    flavor: string | null,
    formula: string,
    offset: RollParseOffset,
): RollParseNode
Protected
Handle a dice term.
Parameters
- number: RollParseNode | null
  The number of dice.
- faces: string | RollParseNode | null
  The number of die faces or a string denomination like "c" or "f".
- modifiers: string | null
  The matched modifiers string.
- flavor: string | null
  Associated flavor text.
- formula: string
  The original matched text.
- offset: RollParseOffset
  The position of the matched term in the formula string.
Returns RollParseNode

`Protected`_onExpression

_onExpression(
    head: RollParseNode,
    tail: [string[], RollParseNode][],
    leading?: string,
    formula: string,
    error: Function,
): RollParseNode
Protected
Handle a base roll expression.
Parameters
- head: RollParseNode
  The first operand.
- tail: [string[], RollParseNode][]
  Zero or more subsequent (operators, operand) tuples.
- Optionalleading: string
  A leading operator.
- formula: string
  The original matched text.
- error: Function
  The peggy error callback to invoke on a parse error.
Returns RollParseNode

`Protected`_onFunctionTerm

_onFunctionTerm(
    fn: string,
    head: RollParseNode,
    tail: RollParseNode[],
    flavor: string,
    formula: string,
    offset: RollParseOffset,
): RollParseNode
Protected
Handle a math term.
Parameters
- fn: string
  The Math function.
- head: RollParseNode
  The first term.
- tail: RollParseNode[]
  Zero or more additional terms.
- flavor: string
  Associated flavor text.
- formula: string
  The original matched text.
- offset: RollParseOffset
  The position of the matched term in the formula string.
Returns RollParseNode

`Protected`_onNumericTerm

_onNumericTerm(
    number: number,
    flavor: string,
    offset: RollParseOffset,
): RollParseNode
Protected
Handle a numeric term.
Parameters
- number: number
  The number.
- flavor: string
  Associated flavor text.
- offset: RollParseOffset
  The position of the matched term in the formula string.
Returns RollParseNode

`Protected`_onParenthetical

_onParenthetical(
    term: RollParseNode,
    flavor: string | null,
    formula: string,
    offset: RollParseOffset,
): RollParseNode
Protected
Handle a parenthetical.
Parameters
- term: RollParseNode
  The inner term.
- flavor: string | null
  Associated flavor text.
- formula: string
  The original matched text.
- offset: RollParseOffset
  The position of the matched term in the formula string.
Returns RollParseNode

`Protected`_onPoolTerm

_onPoolTerm(
    head: RollParseNode,
    tail: RollParseNode[],
    modifiers: string | null,
    flavor: string | null,
    formula: string,
    offset: RollParseOffset,
): RollParseNode
Protected
Handle a pool term.
Parameters
- head: RollParseNode
  The first term.
- tail: RollParseNode[]
  Zero or more additional terms.
- modifiers: string | null
  The matched modifiers string.
- flavor: string | null
  Associated flavor text.
- formula: string
  The original matched text.
- offset: RollParseOffset
  The position of the matched term in the formula string.
Returns RollParseNode

`Protected`_onStringTerm

_onStringTerm(
    term: string,
    flavor?: string | null,
    offset: RollParseOffset,
): StringParseNode
Protected
Handle some string that failed to be classified.
Parameters
- term: string
  The term.
- Optionalflavor: string | null
  Associated flavor text.
- offset: RollParseOffset
  The position of the matched term in the formula string.
Returns StringParseNode

`Protected`_wrapNegativeTerm

_wrapNegativeTerm(term: RollParseNode): RollParseNode
Protected
Wrap a term with a leading minus.
Parameters
- term: RollParseNode
  The term to wrap.
Returns RollParseNode

`Static`flattenTree

flattenTree(root: RollParseNode): RollParseNode[]
Flatten a tree structure (either a parse tree or AST) into an array with operators in infix notation.
Parameters
- root: RollParseNode
  The root of the tree.
Returns RollParseNode[]

`Static`formatArg

formatArg(arg: any): string
Format a parser argument.
Parameters
- arg: any
  The argument.
Returns string

`Static`formatDebug

formatDebug(method: string, ...args: any[]): string
Format arguments for debugging.
Parameters
- method: string
  The method name.
- ...args: any[]
  The arguments.
Returns string

`Static`formatList

formatList(list: any[]): string
Format a list argument.
Parameters
- list: any[]
  The list to format.
Returns string

`Static`isOperatorTerm

isOperatorTerm(node: any): boolean
Determine if a given node is an operator term.
Parameters
- node: any
Returns boolean

`Static`toAST

toAST(root: RollParseNode | RollTerm[]): RollParseNode
Use the Shunting Yard algorithm to convert a parse tree or list of terms into an AST with correct operator precedence. See https://en.wikipedia.org/wiki/Shunting_yard_algorithm for a description of the algorithm in detail.
Parameters
- root: RollParseNode | RollTerm[]
  The root of the parse tree or a list of terms.
Returns RollParseNode
The root of the AST.

Class RollParser

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RollParser

Properties

formula

Methods

Protected_collapseOperators

Parameters

Returns string

Protected_onDiceTerm

Parameters

Returns RollParseNode

Protected_onExpression

Parameters

Returns RollParseNode

Protected_onFunctionTerm

Parameters

Returns RollParseNode

Protected_onNumericTerm

Parameters

Returns RollParseNode

Protected_onParenthetical

Parameters

Returns RollParseNode

Protected_onPoolTerm

Parameters

Returns RollParseNode

Protected_onStringTerm

Parameters

Returns StringParseNode

Protected_wrapNegativeTerm

Parameters

Returns RollParseNode

StaticflattenTree

Parameters

Returns RollParseNode[]

StaticformatArg

Parameters

Returns string

StaticformatDebug

Parameters

Returns string

StaticformatList

Parameters

Returns string

StaticisOperatorTerm

Parameters

Returns boolean

StatictoAST

Parameters

Returns RollParseNode

Settings

On This Page

`Protected`_collapseOperators

`Protected`_onDiceTerm

`Protected`_onExpression

`Protected`_onFunctionTerm

`Protected`_onNumericTerm

`Protected`_onParenthetical

`Protected`_onPoolTerm

`Protected`_onStringTerm

`Protected`_wrapNegativeTerm

`Static`flattenTree

`Static`formatArg

`Static`formatDebug

`Static`formatList

`Static`isOperatorTerm

`Static`toAST