Position
Position
is the base trait for objects describing a position in a document
.
It provides functionality for:
- generating a visual representation of this position (
longString
); - comparing two positions (
<
).
To use this class for a concrete kind of document
, implement the lineContents
method.
Value members
Abstract methods
The column number referred to by the position; column numbers start at 1.
The column number referred to by the position; column numbers start at 1.
The line number referred to by the position; line numbers start at 1.
The line number referred to by the position; line numbers start at 1.
Concrete methods
Compare this position to another, by first comparing their line numbers, and then -- if necessary -- using the columns to break a tie.
Compare this position to another, by first comparing their line numbers, and then -- if necessary -- using the columns to break a tie.
- Value parameters:
- `that`
a
Position
to compare to thisPosition
- Returns:
true if this position's line number or (in case of equal line numbers) column is smaller than the corresponding components of
that
Returns a more visual
representation of this position.
More precisely, the resulting string consists of two lines:
Returns a more visual
representation of this position.
More precisely, the resulting string consists of two lines:
- the line in the document referred to by this position
- a caret indicating the column
Example:
List(this, is, a, line, from, the, document)
^