SourceInfo
SourceInfo collects source metadata for a parsed expression.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SourceInfo(
syntax?,desc?,lines?,baseLine?,baseCol?,extensions?):SourceInfo
Parameters
Section titled “Parameters”syntax?
Section titled “syntax?”string = ""
string = ""
lines?
Section titled “lines?”number[] = []
baseLine?
Section titled “baseLine?”number = 0
baseCol?
Section titled “baseCol?”number = 0
extensions?
Section titled “extensions?”Extension[] = []
Returns
Section titled “Returns”SourceInfo
Methods
Section titled “Methods”addExtension()
Section titled “addExtension()”addExtension(
extension):void
AddExtension appends an extension descriptor.
Parameters
Section titled “Parameters”extension
Section titled “extension”Returns
Section titled “Returns”void
clearMacroCall()
Section titled “clearMacroCall()”clearMacroCall(
id):void
ClearMacroCall removes the macro call stored for an expression id.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
clearOffsetRange()
Section titled “clearOffsetRange()”clearOffsetRange(
id):void
ClearOffsetRange removes the source offset range for an expression id.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
computeOffset()
Section titled “computeOffset()”computeOffset(
line,column):number
ComputeOffset converts a line and column to an absolute source offset.
Parameters
Section titled “Parameters”number
column
Section titled “column”number
Returns
Section titled “Returns”number
description()
Section titled “description()”description():
string
Description returns the source description.
Returns
Section titled “Returns”string
extensions()
Section titled “extensions()”extensions():
Extension[]
Extensions returns the enabled extension list.
Returns
Section titled “Returns”getMacroCall()
Section titled “getMacroCall()”getMacroCall(
id): [Expr|undefined,boolean]
GetMacroCall looks up the macro call for an expression id.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”[Expr | undefined, boolean]
getOffsetRange()
Section titled “getOffsetRange()”getOffsetRange(
id): [OffsetRange|undefined,boolean]
GetOffsetRange looks up the source offset range for an expression id.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”[OffsetRange | undefined, boolean]
getStartLocation()
Section titled “getStartLocation()”getStartLocation(
id):Location
GetStartLocation returns the start location for an expression id.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”getStopLocation()
Section titled “getStopLocation()”getStopLocation(
id):Location
GetStopLocation returns the stop location for an expression id.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”hasExtension()
Section titled “hasExtension()”hasExtension(
id,version):boolean
HasExtension reports whether a compatible extension is enabled.
Parameters
Section titled “Parameters”string
version
Section titled “version”Returns
Section titled “Returns”boolean
lineOffsets()
Section titled “lineOffsets()”lineOffsets():
number[]
LineOffsets returns the stored line offsets.
Returns
Section titled “Returns”number[]
macroCalls()
Section titled “macroCalls()”macroCalls():
Map<number,Expr>
MacroCalls returns the stored macro call expressions.
Returns
Section titled “Returns”Map<number, Expr>
offsetRanges()
Section titled “offsetRanges()”offsetRanges():
Map<number,OffsetRange>
OffsetRanges returns the expression id to offset range map.
Returns
Section titled “Returns”Map<number, OffsetRange>
renumberIds()
Section titled “renumberIds()”renumberIds(
generator):void
RenumberIds rewrites stored ids using the provided generator.
Parameters
Section titled “Parameters”generator
Section titled “generator”Returns
Section titled “Returns”void
setMacroCall()
Section titled “setMacroCall()”setMacroCall(
id,expr):void
SetMacroCall stores the macro call for an expression id.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
setOffsetRange()
Section titled “setOffsetRange()”setOffsetRange(
id,range):void
SetOffsetRange stores the source offset range for an expression id.
Parameters
Section titled “Parameters”number
Returns
Section titled “Returns”void
syntaxVersion()
Section titled “syntaxVersion()”syntaxVersion():
string
SyntaxVersion returns the source syntax version.
Returns
Section titled “Returns”string