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.
Attributes
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
- Known subtypes
-
object NoPositionclass OffsetPosition
Members list
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.
Attributes
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.
Attributes
The contents of the line at this position. (must not contain a new-line character).
The contents of the line at this position. (must not contain a new-line character).
Attributes
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
Positionto compare to thisPosition
Attributes
- Returns
-
true if this position's line number or (in case of equal line numbers) column is smaller than the corresponding components of
that
Compare this position to another, checking for equality.
Compare this position to another, checking for equality.
Value parameters
- `that`
-
a
Positionto compare to thisPosition
Attributes
- Returns
-
true if the line numbers and column numbers are equal.
- Definition Classes
-
Any
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)
^