Variable SourceRange

SourceRange: {
    add(
        this: void,
        __namedParameters: readonly [
            Line,
            Column,
            Line,
            Column,
            string
            | undefined,
        ],
        __namedParameters: readonly [
            Line,
            Column,
            Line,
            Column,
            string
            | undefined,
        ],
    ): SourceRange;
    combineRanges(this: void, ...ranges: SourceRange[]): SourceRange[];
    compare(
        this: void,
        __namedParameters: readonly [
            Line,
            Column,
            Line,
            Column,
            string
            | undefined,
        ],
        __namedParameters: readonly [
            Line,
            Column,
            Line,
            Column,
            string
            | undefined,
        ],
    ): number;
    containsPosition(
        this: void,
        __namedParameters: readonly [
            Line,
            Column,
            Line,
            Column,
            string
            | undefined,
        ],
        line: Line,
        column?: Column,
    ): boolean;
    equals(
        this: void,
        __namedParameters: readonly [
            Line,
            Column,
            Line,
            Column,
            string
            | undefined,
        ],
        __namedParameters: readonly [
            Line,
            Column,
            Line,
            Column,
            string
            | undefined,
        ],
    ): boolean;
    format(
        this: void,
        range:
            | readonly [Line, Column, Line, Column, string | undefined]
            | undefined,
    ): string;
    formatPosition(this: void, pos: SourcePosition | undefined): string;
    from(
        this: void,
        sl: string | Line,
        sc: string | Column,
        el?: string | Line,
        ec?: string | Column,
    ): SourceRange;
    fromNode<OtherInfo>(
        this: void,
        node: RNode<OtherInfo> | undefined,
    ): SourceRange | undefined;
    getEnd: Accessor<
        readonly [Line, Column, Line, Column, string | undefined],
        SourcePosition,
    >;
    getEndColumn: Accessor<
        readonly [Line, Column, Line, Column, string | undefined],
        Column,
    >;
    getEndLine: Accessor<
        readonly [Line, Column, Line, Column, string | undefined],
        Line,
    >;
    getStart: Accessor<
        readonly [Line, Column, Line, Column, string | undefined],
        SourcePosition,
    >;
    getStartColumn: Accessor<
        readonly [Line, Column, Line, Column, string | undefined],
        Column,
    >;
    getStartLine: Accessor<
        readonly [Line, Column, Line, Column, string | undefined],
        Line,
    >;
    innermostNodes<OtherInfo>(
        this: void,
        nodes: readonly RNodeWithParent<OtherInfo>[],
        treatChildAsInner?: boolean,
    ): RNodeWithParent<OtherInfo>[];
    invalid(this: void): SourceRange;
    isSingleLine(
        this: void,
        range: readonly [Line, Column, Line, Column, string | undefined],
    ): boolean;
    isStrictSubsetOf(
        this: void,
        r1: readonly [Line, Column, Line, Column, string | undefined],
        r2: readonly [Line, Column, Line, Column, string | undefined],
    ): boolean;
    isSubsetOf(
        this: void,
        __namedParameters: readonly [
            Line,
            Column,
            Line,
            Column,
            string
            | undefined,
        ],
        __namedParameters: readonly [
            Line,
            Column,
            Line,
            Column,
            string
            | undefined,
        ],
    ): boolean;
    isValid(
        this: void,
        range:
            | readonly [Line, Column, Line, Column, string | undefined]
            | undefined,
    ): range is readonly [Line, Column, Line, Column, string | undefined];
    lineCount(
        this: void,
        range: readonly [Line, Column, Line, Column, string | undefined],
    ): number;
    merge(
        this: void,
        rs: readonly (
            readonly [Line, Column, Line, Column, (...) | (...)]
            | undefined
        )[],
    ): SourceRange;
    name: "SourceRange";
    nodesContaining<OtherInfo>(
        this: void,
        nodes: readonly RNodeWithParent<OtherInfo>[],
        line: Line,
        column?: Column,
    ): RNodeWithParent<OtherInfo>[];
    overlap(
        this: void,
        r1: readonly [Line, Column, Line, Column, string | undefined],
        r2: readonly [Line, Column, Line, Column, string | undefined],
    ): boolean;
    ownFromNode<OtherInfo>(
        this: void,
        node: RNode<OtherInfo> | undefined,
    ): SourceRange | undefined;
    startsCompletelyBefore(
        this: void,
        __namedParameters: readonly [
            Line,
            Column,
            Line,
            Column,
            string
            | undefined,
        ],
        __namedParameters: readonly [
            Line,
            Column,
            Line,
            Column,
            string
            | undefined,
        ],
    ): boolean;
    view: Accessor<
        readonly [Line, Column, Line, Column, string | undefined],
        SourceLocationView,
    >;
}

Utility functions for source ranges.

Type Declaration

add: function
- add(
      this: void,
      __namedParameters: readonly [
          Line,
          Column,
          Line,
          Column,
          string
          | undefined,
      ],
      __namedParameters: readonly [
          Line,
          Column,
          Line,
          Column,
          string
          | undefined,
      ],
  ): SourceRange
  Calculates the component-wise sum of two ranges.
  Parameters
  - this: void
  - __namedParameters: readonly [Line, Column, Line, Column, string | undefined]
  - __namedParameters: readonly [Line, Column, Line, Column, string | undefined]
  Returns SourceRange
  - Defined in src/util/range.ts:177
combineRanges: function
- combineRanges(this: void, ...ranges: SourceRange[]): SourceRange[]
  Reduces the ranges to those no other one contains, keeping the first of any duplicates. Ranges that merely overlap are both kept, as neither contains the other. A non-empty input always yields a non-empty result.
  Parameters
  - this: void
  - ...ranges: SourceRange[]
  Returns SourceRange[]
  
  See
  SourceRange.merge for merging multiple ranges into a single range.
  - Defined in src/util/range.ts:232
compare: function
- compare(
      this: void,
      __namedParameters: readonly [
          Line,
          Column,
          Line,
          Column,
          string
          | undefined,
      ],
      __namedParameters: readonly [
          Line,
          Column,
          Line,
          Column,
          string
          | undefined,
      ],
  ): number
  Provides a comparator for SourceRanges that sorts them in ascending order.
  Parameters
  - this: void
  - __namedParameters: readonly [Line, Column, Line, Column, string | undefined]
  - __namedParameters: readonly [Line, Column, Line, Column, string | undefined]
  Returns number
  a positive number if r1 comes after r2, a negative number if r1 comes before r2, and 0 if they are equal
  - Defined in src/util/range.ts:184
containsPosition: function
- containsPosition(
      this: void,
      __namedParameters: readonly [
          Line,
          Column,
          Line,
          Column,
          string
          | undefined,
      ],
      line: Line,
      column?: Column,
  ): boolean
  Checks if a given position (line, column) is contained within the range. Omitting the column checks whether the line is covered at all.
  Parameters
  - this: void
  - __namedParameters: readonly [Line, Column, Line, Column, string | undefined]
  - line: Line
  - Optionalcolumn: Column
  Returns boolean
  - Defined in src/util/range.ts:201
equals: function
- equals(
      this: void,
      __namedParameters: readonly [
          Line,
          Column,
          Line,
          Column,
          string
          | undefined,
      ],
      __namedParameters: readonly [
          Line,
          Column,
          Line,
          Column,
          string
          | undefined,
      ],
  ): boolean
  Checks if two ranges are equal (i.e., they start and end at the same position).
  Parameters
  - this: void
  - __namedParameters: readonly [Line, Column, Line, Column, string | undefined]
  - __namedParameters: readonly [Line, Column, Line, Column, string | undefined]
  Returns boolean
  - Defined in src/util/range.ts:194
format: function
- format(
      this: void,
      range:
          | readonly [Line, Column, Line, Column, string | undefined]
          | undefined,
  ): string
  Prints a range as a human-readable string.
  Parameters
  - this: void
  - range: readonly [Line, Column, Line, Column, string | undefined] | undefined
  Returns string
  - Defined in src/util/range.ts:74
formatPosition: function
- formatPosition(this: void, pos: SourcePosition | undefined): string
  Prints a position as a human-readable string.
  Parameters
  - this: void
  - pos: SourcePosition | undefined
  Returns string
  - Defined in src/util/range.ts:89
from: function
- from(
      this: void,
      sl: string | Line,
      sc: string | Column,
      el?: string | Line,
      ec?: string | Column,
  ): SourceRange
  Creates a source range from the given line and column numbers.
  Parameters
  - this: void
  - sl: string | Line
    start line
  - sc: string | Column
    start column
  - el: string | Line = sl
    end line
  - ec: string | Column = sc
    end column
  Returns SourceRange
  - Defined in src/util/range.ts:123
fromNode: function
- fromNode<OtherInfo>(
  this: void,
  node: RNode<OtherInfo> | undefined,
  ): SourceRange | undefined
  The range of the code a node spans, its own token's range if it has no full range.
  Type Parameters
  - OtherInfo
  Parameters
  - this: void
  - node: RNode<OtherInfo> | undefined
  Returns SourceRange | undefined
  
  See
  SourceRange.ownFromNode - for the range of the token the node is made of
  - Defined in src/util/range.ts:240
ReadonlygetEnd: Accessor<
readonly [Line, Column, Line, Column, string | undefined],
SourcePosition,
>

Returns the end position of a source range, or undefined if there is no range.
ReadonlygetEndColumn: Accessor<readonly [Line, Column, Line, Column, string | undefined], Column>

Returns the end column of a source range, or undefined if there is no range.
ReadonlygetEndLine: Accessor<readonly [Line, Column, Line, Column, string | undefined], Line>

Returns the end line of a source range, or undefined if there is no range.
ReadonlygetStart: Accessor<
readonly [Line, Column, Line, Column, string | undefined],
SourcePosition,
>

Returns the start position of a source range, or undefined if there is no range.
ReadonlygetStartColumn: Accessor<readonly [Line, Column, Line, Column, string | undefined], Column>

Returns the start column of a source range, or undefined if there is no range.
ReadonlygetStartLine: Accessor<readonly [Line, Column, Line, Column, string | undefined], Line>

Returns the start line of a source range, or undefined if there is no range.
innermostNodes: function
- innermostNodes<OtherInfo>(
      this: void,
      nodes: readonly RNodeWithParent<OtherInfo>[],
      treatChildAsInner?: boolean,
  ): RNodeWithParent<OtherInfo>[]
  Collects all nodes satisfying the innermost condition: those containing no other of the given nodes.
  
  Nodes may share a range (a function call and the symbol naming it do), so treatChildAsInner decides that tie: with it, a node sharing its parent's range counts as the inner one and the parent drops out; without it, both are kept and the caller may pick between them (e.g. by node type).
  
  A non-empty input always yields a non-empty result: enclosure is a strict order so some node is always minimal, and a node carrying no range at all is kept rather than dropped.
  Type Parameters
  - OtherInfo
  Parameters
  - this: void
  - nodes: readonly RNodeWithParent<OtherInfo>[]
  - treatChildAsInner: boolean = true
  Returns RNodeWithParent<OtherInfo>[]
  
  See
  SourceRange.nodesContaining which this usually narrows down
  - Defined in src/util/range.ts:279
invalid: function
- invalid(this: void): SourceRange
  returns an invalid source range
  Parameters
  - this: void
  Returns SourceRange
  - Defined in src/util/range.ts:129
isSingleLine: function
- isSingleLine(
  this: void,
  range: readonly [Line, Column, Line, Column, string | undefined],
  ): boolean
  Whether the range starts and ends on the same line.
  Parameters
  - this: void
  - range: readonly [Line, Column, Line, Column, string | undefined]
  Returns boolean
  - Defined in src/util/range.ts:141
isStrictSubsetOf: function
- isStrictSubsetOf(
      this: void,
      r1: readonly [Line, Column, Line, Column, string | undefined],
      r2: readonly [Line, Column, Line, Column, string | undefined],
  ): boolean
  Checks if the first range is a strict subset of the second range (i.e., it is a subset but not equal).
  Parameters
  - this: void
  - r1: readonly [Line, Column, Line, Column, string | undefined]
  - r2: readonly [Line, Column, Line, Column, string | undefined]
  Returns boolean
  - Defined in src/util/range.ts:224
isSubsetOf: function
- isSubsetOf(
      this: void,
      __namedParameters: readonly [
          Line,
          Column,
          Line,
          Column,
          string
          | undefined,
      ],
      __namedParameters: readonly [
          Line,
          Column,
          Line,
          Column,
          string
          | undefined,
      ],
  ): boolean
  Checks if the first range is a subset of the second range.
  Parameters
  - this: void
  - __namedParameters: readonly [Line, Column, Line, Column, string | undefined]
  - __namedParameters: readonly [Line, Column, Line, Column, string | undefined]
  Returns boolean
  - Defined in src/util/range.ts:218
isValid: function
- isValid(
      this: void,
      range:
          | readonly [Line, Column, Line, Column, string | undefined]
          | undefined,
  ): range is readonly [Line, Column, Line, Column, string | undefined]
  Whether the range is a real one, i.e., not the invalid range and not absent.
  Parameters
  - this: void
  - range: readonly [Line, Column, Line, Column, string | undefined] | undefined
  Returns range is readonly [Line, Column, Line, Column, string | undefined]
  - Defined in src/util/range.ts:135
lineCount: function
- lineCount(
  this: void,
  range: readonly [Line, Column, Line, Column, string | undefined],
  ): number
  The number of lines the range spans (always at least 1 for a valid range).
  Parameters
  - this: void
  - range: readonly [Line, Column, Line, Column, string | undefined]
  Returns number
  - Defined in src/util/range.ts:147
merge: function
- merge(
      this: void,
      rs: readonly (
          readonly [Line, Column, Line, Column, (...) | (...)]
          | undefined
      )[],
  ): SourceRange
  Merges multiple source ranges into a single source range that spans from the earliest start to the latest end. If you are interested in reducing a set of ranges to those none of the others contains, see combineRanges.
  Parameters
  - this: void
  - rs: readonly (readonly [Line, Column, Line, Column, (...) | (...)] | undefined)[]
  Returns SourceRange
  
  Throws
  if no ranges are provided
  - Defined in src/util/range.ts:155
Readonlyname: "SourceRange"
nodesContaining: function
- nodesContaining<OtherInfo>(
      this: void,
      nodes: readonly RNodeWithParent<OtherInfo>[],
      line: Line,
      column?: Column,
  ): RNodeWithParent<OtherInfo>[]
  "Fuzzy" position match, as opposed to requiring a node to start exactly at the position.
  Type Parameters
  - OtherInfo
  Parameters
  - this: void
  - nodes: readonly RNodeWithParent<OtherInfo>[]
  - line: Line
  - Optionalcolumn: Column
  Returns RNodeWithParent<OtherInfo>[]
  
  See
  SourceRange.innermostNodes to narrow the result down to the deepest matches
  - Defined in src/util/range.ts:259
overlap: function
- overlap(
      this: void,
      r1: readonly [Line, Column, Line, Column, string | undefined],
      r2: readonly [Line, Column, Line, Column, string | undefined],
  ): boolean
  Checks if the two ranges overlap, i.e. whether neither of them lies completely before the other.
  Parameters
  - this: void
  - r1: readonly [Line, Column, Line, Column, string | undefined]
  - r2: readonly [Line, Column, Line, Column, string | undefined]
  Returns boolean
  - Defined in src/util/range.ts:171
ownFromNode: function
- ownFromNode<OtherInfo>(
  this: void,
  node: RNode<OtherInfo> | undefined,
  ): SourceRange | undefined
  The range of the token a node is made of (the <- of an assignment), the range it spans if it has no token of its own.
  Type Parameters
  - OtherInfo
  Parameters
  - this: void
  - node: RNode<OtherInfo> | undefined
  Returns SourceRange | undefined
  
  See
  SourceRange.fromNode - for the range of the code the node spans
  - Defined in src/util/range.ts:247
startsCompletelyBefore: function
- startsCompletelyBefore(
      this: void,
      __namedParameters: readonly [
          Line,
          Column,
          Line,
          Column,
          string
          | undefined,
      ],
      __namedParameters: readonly [
          Line,
          Column,
          Line,
          Column,
          string
          | undefined,
      ],
  ): boolean
  Parameters
  - this: void
  - __namedParameters: readonly [Line, Column, Line, Column, string | undefined]
  - __namedParameters: readonly [Line, Column, Line, Column, string | undefined]
  Returns boolean
  true iff r1 starts and ends before r2 starts (i.e., if r1 and r2 do not overlap and r1 comes before r2
  - Defined in src/util/range.ts:167
Readonlyview: Accessor<
readonly [Line, Column, Line, Column, string | undefined],
SourceLocationView,
>

Wraps the range in a view offering property access (range.startLine) and methods. The view does not copy the tuple; see SourceLocationView for when to use it.

Helper

location

Variable SourceRange

Type Declaration

add: function

Parameters

Returns SourceRange

combineRanges: function

Parameters

Returns SourceRange[]

See

compare: function

Parameters

Returns number

containsPosition: function

Parameters

Returns boolean

equals: function

Parameters

Returns boolean

format: function

Parameters

Returns string

formatPosition: function

Parameters

Returns string

from: function

Parameters

Returns SourceRange

fromNode: function

Type Parameters

Parameters

Returns SourceRange | undefined

See

ReadonlygetEnd: Accessor< readonly [Line, Column, Line, Column, string | undefined], SourcePosition,>

ReadonlygetEndColumn: Accessor<readonly [Line, Column, Line, Column, string | undefined], Column>

ReadonlygetEndLine: Accessor<readonly [Line, Column, Line, Column, string | undefined], Line>

ReadonlygetStart: Accessor< readonly [Line, Column, Line, Column, string | undefined], SourcePosition,>

ReadonlygetStartColumn: Accessor<readonly [Line, Column, Line, Column, string | undefined], Column>

ReadonlygetStartLine: Accessor<readonly [Line, Column, Line, Column, string | undefined], Line>

innermostNodes: function

Type Parameters

Parameters

Returns RNodeWithParent<OtherInfo>[]

See

invalid: function

Parameters

Returns SourceRange

isSingleLine: function

Parameters

Returns boolean

isStrictSubsetOf: function

Parameters

Returns boolean

isSubsetOf: function

Parameters

Returns boolean

isValid: function

Parameters

Returns range is readonly [Line, Column, Line, Column, string | undefined]

lineCount: function

Parameters

Returns number

merge: function

Parameters

Returns SourceRange

Throws

Readonlyname: "SourceRange"

nodesContaining: function

Type Parameters

Parameters

Returns RNodeWithParent<OtherInfo>[]

See

overlap: function

Parameters

Returns boolean

ownFromNode: function

Type Parameters

Parameters

Returns SourceRange | undefined

See

startsCompletelyBefore: function

`Readonly`getEnd: Accessor<
readonly [Line, Column, Line, Column, string | undefined],
SourcePosition,
>

`Readonly`getEndColumn: Accessor<readonly [Line, Column, Line, Column, string | undefined], Column>

`Readonly`getEndLine: Accessor<readonly [Line, Column, Line, Column, string | undefined], Line>

`Readonly`getStart: Accessor<
readonly [Line, Column, Line, Column, string | undefined],
SourcePosition,
>

`Readonly`getStartColumn: Accessor<readonly [Line, Column, Line, Column, string | undefined], Column>

`Readonly`getStartLine: Accessor<readonly [Line, Column, Line, Column, string | undefined], Line>

`Readonly`name: "SourceRange"

`Readonly`view: Accessor<
readonly [Line, Column, Line, Column, string | undefined],
SourceLocationView,
>