Packages

trait Position extends AnyRef

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.

Source
Position.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
NoPosition, OffsetPosition
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Position
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def column: Int

    The column number referred to by the position; column numbers start at 1.

  2. abstract def line: Int

    The line number referred to by the position; line numbers start at 1.

Concrete Value Members

  1. def <(that: Position): Boolean

    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.

    returns

    true if this position's line number or (in case of equal line numbers) column is smaller than the corresponding components of that

  2. def longString: String

    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:

    1. the line in the document referred to by this position 2. a caret indicating the column

    Example:

    List(this, is, a, line, from, the, document)
             ^
  3. def toString(): String

    Returns a string representation of the Position, of the form line.column.

    Returns a string representation of the Position, of the form line.column.

    Definition Classes
    Position → AnyRef → Any