Variable SourceLocation

Type Declaration

• at: function

  • at<OtherInfo>(
        this: void,
        node: RNode<OtherInfo> | undefined,
    ): SourceLocationView | undefined

    The view on the location of an AST node, undefined if the node has none. Combines with optional chaining, so a single ?. replaces the usual undefined dance: SourceLocation.at(node)?.startLine.

    Type Parameters

    • OtherInfo

    Parameters

    • this: void
    • node: RNode<OtherInfo> | undefined

    Returns SourceLocationView | undefined

• compare: function

  • compare(
        this: void,
        loc1: readonly [Line, Column, Line, Column, string | undefined],
        loc2: readonly [Line, Column, Line, Column, string | undefined],
    ): number

    Parameters

    • this: void
    • loc1: readonly [Line, Column, Line, Column, string | undefined]
    • loc2: readonly [Line, Column, Line, Column, string | undefined]

    Returns number

• equals: function

  • equals(
        this: void,
        loc1: readonly [Line, Column, Line, Column, string | undefined],
        loc2: readonly [Line, Column, Line, Column, string | undefined],
    ): boolean

    Checks if two locations are equal, file included.

    Parameters

    • this: void
    • loc1: readonly [Line, Column, Line, Column, string | undefined]
    • loc2: readonly [Line, Column, Line, Column, string | undefined]

    Returns boolean

• format: function

  • format(
        this: void,
        location:
            | readonly [Line, Column, Line, Column, string | undefined]
            | undefined,
    ): string

    Formats a source location as a human-readable string.

    Parameters

    • this: void
    • location: readonly [Line, Column, Line, Column, string | undefined] | undefined

    Returns string

• from: function

  • from(
        this: void,
        range: SourceRange,
        file?: string,
    ): readonly [Line, Column, Line, Column, string | undefined]

    Creates a source location from a source range and a file name.

    Parameters

    • this: void
    • range: SourceRange
    • Optionalfile: string

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

• fromNode: function

  • fromNode<OtherInfo>(
        this: void,
        node: RNode<OtherInfo> | undefined,
    ): readonly [Line, Column, Line, Column, string | undefined] | undefined

    The source location of an AST node, file included.

    Type Parameters

    • OtherInfo

    Parameters

    • this: void
    • node: RNode<OtherInfo> | undefined

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

    undefined if the given range is undefined

    See

    • SourceRange.fromNode for getting the range from an AST node
    • SourceLocation.at for the same thing as a view

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

  See

  SourceRange.getEnd

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

  See

  SourceRange.getEndColumn

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

  See

  SourceRange.getEndLine

• getFile: function

  • getFile(
        this: void,
        location:
            | readonly [Line, Column, Line, Column, string | undefined]
            | undefined,
    ): string | undefined

    Returns the file part of a source location, or undefined if no file is set.

    Parameters

    • this: void
    • location: readonly [Line, Column, Line, Column, string | undefined] | undefined

    Returns string | undefined

• ReadonlygetRange: Accessor<readonly [Line, Column, Line, Column, string | undefined], SourceRange>

  Returns the source range part of a source location, file excluded.

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

  See

  SourceRange.getStart

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

  See

  SourceRange.getStartColumn

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

  See

  SourceRange.getStartLine

• invalid: function

  • invalid(this: void): readonly [Line, Column, Line, Column, string | undefined]

    Returns an invalid source location (i.e., with an invalid range and no file).

    Parameters

    • this: void

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

• is: function

  • is(
        this: void,
        x: unknown,
    ): x is readonly [Line, Column, Line, Column, string | undefined]

    Whether x is a location rather than, for example, the node it is the location of.

    Parameters

    • this: void
    • x: unknown

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

• isSubsetOf: function

  • isSubsetOf(
        this: void,
        loc1: readonly [Line, Column, Line, Column, string | undefined],
        loc2: readonly [Line, Column, Line, Column, string | undefined],
    ): boolean

    Checks if the first location is a subset of the second location. For this, they must be in the same file!

    Parameters

    • this: void
    • loc1: readonly [Line, Column, Line, Column, string | undefined]
    • loc2: readonly [Line, Column, Line, Column, string | undefined]

    Returns boolean

    See

    SourceRange.isSubsetOf

• ReadonlyisValid: (
      this: void,
      range: readonly [Line, Column, Line, Column, (...) | (...)] | undefined,
  ) => range is readonly [Line, Column, Line, Column, string | undefined]

  See

  SourceRange.isValid

• mapFile: function

  • mapFile(
        this: void,
        loc: readonly [Line, Column, Line, Column, string | undefined],
        fileMapper: (file: string | undefined) => string,
    ): readonly [Line, Column, Line, Column, string | undefined]

    Maps the file part of a source location using the given mapper function.

    Parameters

    • this: void
    • loc: readonly [Line, Column, Line, Column, string | undefined]
    • fileMapper: (file: string | undefined) => string

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

• merge: function

  • merge(
        this: void,
        locs: readonly (
            readonly [Line, Column, Line, Column, (...) | (...)]
            | undefined
        )[],
    ): readonly [Line, Column, Line, Column, string | undefined] | undefined

    Merges multiple source locations into a single source location that spans from the earliest start to the latest end. If the locations are from different files, undefined is returned. Files may be undefined themselves, but if there is at least one defined file, they must all be the same defined file for the merge to succeed.

    Parameters

    • this: void
    • locs: readonly (readonly [Line, Column, Line, Column, (...) | (...)] | undefined)[]

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

• Readonlyname: "SourceLocation"

• Readonlyview: Accessor<
      readonly [Line, Column, Line, Column, string | undefined],
      SourceLocationView,
  >

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