scala.reflect.api

Position

trait Position extends Attachments

EXPERIMENTAL

Position tracks the origin of symbols and tree nodes. They are commonly used when displaying warnings and errors, to indicate the incorrect point in the program.

Please note that this trait may be refactored in future versions of the Scala reflection API.

For more information about Positions, see the Reflection Guide: Annotations, Names, Scopes, and More

Source
Position.scala
Linear Supertypes
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Grouped
  2. Alphabetic
  3. By inheritance
Inherited
  1. Position
  2. Attachments
  3. AnyRef
  4. Any
Implicitly
  1. by StringAdd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. abstract type Pos >: Null <: Position

    The position type of this attachment

    The position type of this attachment

    Definition Classes
    PositionAttachments

Abstract Value Members

  1. abstract def column: Int

    The position indicates a column and the line in the source file.

  2. abstract def end: Int

    The end of the position's range, error if not a range position.

  3. abstract def endOrPoint: Int

    The end of the position's range, or point if not a range position.

  4. abstract def focus: Pos

    If this is a range position, the offset position of its point.

    If this is a range position, the offset position of its point. Otherwise the position itself

  5. abstract def focusEnd: Pos

    If this is a range position, the offset position of its end.

    If this is a range position, the offset position of its end. Otherwise the position itself

  6. abstract def focusStart: Pos

    If this is a range position, the offset position of its start.

    If this is a range position, the offset position of its start. Otherwise the position itself

  7. abstract def includes(pos: Pos): Boolean

    Does this position include the given position pos? This holds if this is a range position and its range [start.

    Does this position include the given position pos? This holds if this is a range position and its range [start..end] is the same or covers the range of the given position, which may or may not be a range position.

  8. abstract def isDefined: Boolean

    Is this position neither a NoPosition nor a FakePosition? If isDefined is true, offset and source are both defined.

  9. abstract def isOpaqueRange: Boolean

    Is this position a non-transparent range position?

  10. abstract def isRange: Boolean

    Is this position a range position?

  11. abstract def isTransparent: Boolean

    Is this position a transparent position?

  12. abstract def line: Int

    The position indicates a column and the line in the source file.

  13. abstract def lineContent: String

    The content of the line this Position refers to.

  14. abstract def makeTransparent: Pos

    If opaque range, make this position transparent.

  15. abstract def overlaps(pos: Pos): Boolean

    Does this position overlap with that position? This holds if both positions are ranges and there is an interval of non-zero length that is shared by both position ranges.

  16. abstract def point: Int

    The point (where the ^ is) of the position, which is easiest to access using the line and column values. The line content is also available.

  17. abstract def pointOrElse(default: Int): Int

    The point (where the ^ is) of the position, or else default if undefined.

  18. abstract def pos: Pos

    The underlying position

    The underlying position

    Definition Classes
    Attachments
  19. abstract def precedes(pos: Pos): Boolean

    Does this position precede that position? This holds if both positions are defined and the end point of this position is not larger than the start point of the given position.

  20. abstract def properlyIncludes(pos: Pos): Boolean

    Does this position properly include the given position pos ("properly" meaning their ranges are not the same)?

  21. abstract def properlyPrecedes(pos: Pos): Boolean

    Does this position properly precede the given position pos ("properly" meaning their ranges do not share a common point).

  22. abstract def sameRange(pos: Pos): Boolean

    Does this position cover the same range as that position? Holds only if both position are ranges

  23. abstract def show: String

    Show a textual representation of the position.

  24. abstract def source: SourceFile

    Java file corresponding to the source file of this position.

    Java file corresponding to the source file of this position.

    The return type is scala.reflect.io.AbstractFile, which belongs to an experimental part of Scala reflection. It should not be used unless you know what you are doing. In subsequent releases, this API will be refined and exposed as a part of scala.reflect.api.

  25. abstract def start: Int

    The start of the position's range, error if not a range position.

  26. abstract def startOrPoint: Int

    The start of the position's range, or point if not a range position.

  27. abstract def toSingleLine: Pos

    Convert this to a position around point that spans a single source line

  28. abstract def union(pos: Pos): Pos

    If this is a range, the union with the other range, with the point of this position.

    If this is a range, the union with the other range, with the point of this position. Otherwise, this position

  29. abstract def withEnd(off: Int): Pos

    The same position with a different end value (if a range).

  30. abstract def withPoint(off: Int): Pos

    The same position with a different point value (if a range or offset).

  31. abstract def withPos(newPos: Pos): Attachments { type Pos = Position.this.Pos }

    Creates a copy of this attachment with the position replaced by newPos

    Creates a copy of this attachment with the position replaced by newPos

    Definition Classes
    Attachments
  32. abstract def withStart(off: Int): Pos

    The same position with a different start value (if a range).

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Position to StringAdd[Position] performed by method StringAdd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (Position, B)

    Implicit information
    This member is added by an implicit conversion from Position to ArrowAssoc[Position] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  8. def all: Set[Any]

    The underlying payload with the guarantee that no two elements have the same type.

    The underlying payload with the guarantee that no two elements have the same type.

    Definition Classes
    Attachments
  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  11. def ensuring(cond: (Position) ⇒ Boolean, msg: ⇒ Any): Position

    Implicit information
    This member is added by an implicit conversion from Position to Ensuring[Position] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (Position) ⇒ Boolean): Position

    Implicit information
    This member is added by an implicit conversion from Position to Ensuring[Position] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: ⇒ Any): Position

    Implicit information
    This member is added by an implicit conversion from Position to Ensuring[Position] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): Position

    Implicit information
    This member is added by an implicit conversion from Position to Ensuring[Position] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  18. def formatted(fmtstr: String): String

    Returns string formatted according to given format string.

    Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).

    Implicit information
    This member is added by an implicit conversion from Position to StringFormat[Position] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  19. def get[T](implicit arg0: ClassTag[T]): Option[T]

    An underlying payload of the given class type T.

    An underlying payload of the given class type T.

    Definition Classes
    Attachments
  20. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  21. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  22. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  23. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  24. final def notify(): Unit

    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  26. def remove[T](implicit arg0: ClassTag[T]): Attachments { type Pos = Position.this.Pos }

    Creates a copy of this attachment with the payload of the given class type T removed.

    Creates a copy of this attachment with the payload of the given class type T removed.

    Definition Classes
    Attachments
  27. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  28. def toString(): String

    Definition Classes
    AnyRef → Any
  29. def update[T](attachment: T)(implicit arg0: ClassTag[T]): Attachments { type Pos = Position.this.Pos }

    Creates a copy of this attachment with the payload slot of T added/updated with the provided value.

    Creates a copy of this attachment with the payload slot of T added/updated with the provided value. Replaces an existing payload of the same type, if exists.

    Definition Classes
    Attachments
  30. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  31. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  32. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  33. def [B](y: B): (Position, B)

    Implicit information
    This member is added by an implicit conversion from Position to ArrowAssoc[Position] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Attachments

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringAdd from Position to StringAdd[Position]

Inherited by implicit conversion StringFormat from Position to StringFormat[Position]

Inherited by implicit conversion Ensuring from Position to Ensuring[Position]

Inherited by implicit conversion ArrowAssoc from Position to ArrowAssoc[Position]

Commonly used methods

Ungrouped