Go to repository

Interface SourcePosition

SourcePositions point to particular positions in the source given by a SourceReader. All SourcePositions are created only through SourceReader.

A source position may be known (pointing to a particular position into a SourceReader) or unknown (if a position cannot be determined). The boolean property isUnknown indicates which is the case.

Additionally, a string representation of any SourcePosition can be obtained through toString for internal use purposes.

A typical use of SourcePositions is relating nodes of an AST representation of code to particular positions in the string version of the source code (that may come from several input documents).

interface SourcePosition {
    column: number;
    documentName: string;
    fullDocumentContents: string;
    isEndOfDocument: boolean;
    isEndOfInput: boolean;
    isUnknown: boolean;
    line: number;
    regions: string[];
    visibleDocumentContents: string;
    documentContextAfter(lines: number): string[];
    documentContextBefore(lines: number): string[];
    fullContentsFrom(from: SourcePosition): string;
    fullContentsTo(to: SourcePosition): string;
    toString(): string;
    visibleContentsFrom(from: SourcePosition): string;
    visibleContentsTo(to: SourcePosition): string;
}

Implemented by

Properties

column documentName fullDocumentContents isEndOfDocument isEndOfInput isUnknown line regions visibleDocumentContents

Methods

documentContextAfter documentContextBefore fullContentsFrom fullContentsTo toString visibleContentsFrom visibleContentsTo

Properties

Readonly

column

column: number

The column number of this position in the current input.

PRECONDITIONS:

  • the position is not unknown
  • the position is not at the end of input

INVARIANT: column >= 1 and it is a valid column in that reader.

Throws

SourceReader/Errors.InvalidOperationAtUnknownPositionError if the position is unknown.

Throws

SourceReader/Errors.InvalidOperationAtEOIError if the position is at the end of input.

Readonly

documentName

documentName: string

The name of the input document this position belongs to.

PRECONDITIONS:

  • the position is not unknown
  • the position is not at the end of input

Throws

SourceReader/Errors.InvalidOperationAtUnknownPositionError if the position is unknown.

Throws

SourceReader/Errors.InvalidOperationAtEOIError if the position is at the end of input.

Readonly

fullDocumentContents

fullDocumentContents: string

The contents of the input document this position belongs to (both visible and non visible).

PRECONDITIONS:

  • the position is not unknown
  • the position is not at the end of input

Throws

SourceReader/Errors.InvalidOperationAtUnknownPositionError if the receiver is unknown.

Throws

SourceReader/Errors.InvalidOperationAtEOIError if the receiver is the end of input.

Readonly

isEndOfDocument

isEndOfDocument: boolean

Answers if this position corresponds to the end of a document in the SourceReader it belongs, or not. The EndOfDocument is reached when all the characters in a document in the source input has been processed, but before the processing of the next document started.

PRECONDITIONS:

  • the position is not unknown
  • the position is not at the end of input

Throws

SourceReader/Errors.InvalidOperationAtUnknownPositionError if the position is unknown.

Throws

SourceReader/Errors.InvalidOperationAtEOIError if the position is at the end of input.

Readonly

isEndOfInput

isEndOfInput: boolean

Answers if this position corresponds to the end of input of the SourceReader it belongs, or not. The EndOfInput is reached when all documents in the source input has been processed.

PRECONDITIONS:

  • the position is known

Throws

SourceReader/Errors.InvalidOperationAtUnknownPositionError if the position is unknown.

Readonly

isUnknown

isUnknown: boolean

Answers if this position correspond to one in some SourceReader, or if it is unknown.

Readonly

line

line: number

The line number of this position in the current input.

PRECONDITIONS:

  • the position is not unknown
  • the position is not at the end of input

INVARIANT: line >=1, and it is a valid line in that reader.

Throws

SourceReader/Errors.InvalidOperationAtUnknownPositionError if the position is unknown.

Throws

SourceReader/Errors.InvalidOperationAtEOIError if the position is at the end of input.

Readonly

regions

regions: string[]

The regions the position in the current input belongs to.

PRECONDITIONS:

  • the position is not unknown
  • the position is not at the end of input

INVARIANT: the regions are valid in the position's reader.

Throws

SourceReader/Errors.InvalidOperationAtUnknownPositionError if the position is unknown.

Throws

SourceReader/Errors.InvalidOperationAtEOIError if the position is at the end of input.

Readonly

visibleDocumentContents

visibleDocumentContents: string

The contents of the visible input document this position belongs to.

PRECONDITIONS:

  • the position is not unknown
  • the position is not at the end of input

Throws

SourceReader/Errors.InvalidOperationAtUnknownPositionError if the receiver is unknown.

Throws

SourceReader/Errors.InvalidOperationAtEOIError if the receiver is the end of input.

Methods

documentContextAfter

documentContextAfter(lines): string[]

Returns the full context of the source document after the position, up to the beginning of the given number of lines or the end of the document.

The char at the given position is the first one in the solution.

PRECONDITIONS:

  • the position is not unknown
  • the position is not at the end of input

Parameters

  • lines: number

Returns string[]

Throws

SourceReader/Errors.InvalidOperationAtUnknownPositionError if the position is unknown.

Throws

SourceReader/Errors.InvalidOperationAtEOIError if the position is at the end of input.

documentContextBefore

documentContextBefore(lines): string[]

Returns the full context of the source document before the position, up to the beginning of the given number of lines, or the beginning of the document, whichever comes first.

The char at the given position is NOT included in the solution.

PRECONDITIONS:

  • the position is not unknown
  • the position is not at the end of input

Parameters

  • lines: number

Returns string[]

Throws

SourceReader/Errors.InvalidOperationAtUnknownPositionError if the position is unknown.

Throws

SourceReader/Errors.InvalidOperationAtEOIError if the position is at the end of input.

fullContentsFrom

fullContentsFrom(from): string

The exact portion of the source that is enclosed between the argument position and the receiver position (not included), both visible and non visible. If the receiver does not come after the argument, the result is the empty string.

PRECONDITIONS:

  • both positions are known
  • both positions correspond to the same reader
  • the receiver is not at the end of input

Parameters

Returns string

Throws

SourceReader/Errors.InvalidOperationAtUnknownPositionError if the receiver or the argument positions are unknown.

Throws

SourceReader/Errors.MismatchedInputsError if the receiver and the argument positions do not belong to the same reader.

Throws

SourceReader/Errors.InvalidOperationAtEOIError if the receiver is the end of input.

fullContentsTo

fullContentsTo(to): string

The exact portion of the source, both visible and non visible, that is enclosed between the receiver position and the argument position (not included). If the argument does not come after the receiver, the result is the empty string.

PRECONDITIONS:

  • both positions are known
  • both positions correspond to the same reader
  • the receiver is not at the end of input

Parameters

Returns string

Throws

SourceReader/Errors.InvalidOperationAtUnknownPositionError if the receiver or the argument positions are unknown.

Throws

SourceReader/Errors.MismatchedInputsError if the receiver and the argument positions do not belong to the same reader.

Throws

SourceReader/Errors.InvalidOperationAtEOIError if the receiver is the end of input.

toString

toString(): string

Gives a string representation of the position. It is NOT useful for persistence, as it may loose information.

Returns string

visibleContentsFrom

visibleContentsFrom(from): string

The exact portion of the source that is enclosed between the from position and this position (not included) and is visible. If this does not come after from, the result is the empty string.

PRECONDITIONS:

  • both positions are known
  • both positions correspond to the same reader
  • the receiver is not at the end of input

Parameters

Returns string

Throws

SourceReader/Errors.InvalidOperationAtUnknownPositionError if the receiver or the argument positions are unknown.

Throws

SourceReader/Errors.MismatchedInputsError if the receiver and the argument positions do not belong to the same reader.

Throws

SourceReader/Errors.InvalidOperationAtEOIError if the receiver is the end of input.

visibleContentsTo

visibleContentsTo(to): string

The exact portion of the source that is enclosed between the this position and to position (not included) and is visible. If to does not come after this, the result is the empty string.

PRECONDITIONS:

  • both positions are known
  • both positions correspond to the same reader
  • the receiver is not at the end of input

Parameters

Returns string

Throws

SourceReader/Errors.InvalidOperationAtUnknownPositionError if the receiver or the argument positions are unknown.

Throws

SourceReader/Errors.MismatchedInputsError if the receiver and the argument positions do not belong to the same reader.

Throws

SourceReader/Errors.InvalidOperationAtEOIError if the receiver is the end of input.

Settings

Member Visibility

On This Page

Properties
Methods