Trait scala.reflect.api.Position
trait Position extends Attachments
Type Members
abstract type Pos >: Null <: Position
The position type of this attachment
- Definition Classes
- Position → Attachments
Abstract Value Members
abstract def column: Int
abstract def end: Int
abstract def focus: Pos
If this is a range position, the offset position of its point. Otherwise the position itself
abstract def isOpaqueRange: Boolean
abstract def isRange: Boolean
abstract def isTransparent: Boolean
abstract def line: Int
abstract def makeTransparent: Pos
abstract def point: Int
abstract def pos: Pos
The underlying position
- Definition Classes
- Attachments
abstract def source: SourceFile
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.
abstract def start: Int
abstract def withEnd(off: Int): Pos
abstract def withPoint(off: Int): Pos
abstract def withPos(newPos: Pos): Attachments { type Pos = Position.this.Pos }
Creates a copy of this attachment with the position replaced by newPos
- Definition Classes
- Attachments
abstract def withStart(off: Int): Pos
abstract def endOrPoint: Int
The end of the position's range, or point if not a range position.
- Annotations
- @deprecated
- Deprecated
(Since version 2.11.0) removed from the public API
abstract def focusEnd: Pos
If this is a range position, the offset position of its end. Otherwise the position itself
- Annotations
- @deprecated
- Deprecated
(Since version 2.11.0) removed from the public API
abstract def focusStart: Pos
If this is a range position, the offset position of its start. Otherwise the position itself
- Annotations
- @deprecated
- Deprecated
(Since version 2.11.0) removed from the public API
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..end] is the same or covers the range of the given position, which may or may not be a range position.
- Annotations
- @deprecated
- Deprecated
(Since version 2.11.0) removed from the public API
abstract def isDefined: Boolean
Is this position not a NoPosition? If isDefined is true, offset and source are both defined.
- Annotations
- @deprecated
- Deprecated
(Since version 2.11.0) removed from the public API
abstract def lineContent: String
The content of the line this Position refers to.
- Annotations
- @deprecated
- Deprecated
(Since version 2.11.0) removed from the public API
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.
- Annotations
- @deprecated
- Deprecated
(Since version 2.11.0) removed from the public API
abstract def pointOrElse(default: Int): Int
The point (where the ^ is) of the position, or else default if undefined.
- Annotations
- @deprecated
- Deprecated
(Since version 2.11.0) removed from the public API
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.
- Annotations
- @deprecated
- Deprecated
(Since version 2.11.0) removed from the public API
abstract def properlyIncludes(pos: Pos): Boolean
Does this position properly include the given position pos ("properly" meaning their ranges are not the same)?
- Annotations
- @deprecated
- Deprecated
(Since version 2.11.0) removed from the public API
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).
- Annotations
- @deprecated
- Deprecated
(Since version 2.11.0) removed from the public API
abstract def sameRange(pos: Pos): Boolean
Does this position cover the same range as that position? Holds only if both position are ranges
- Annotations
- @deprecated
- Deprecated
(Since version 2.11.0) removed from the public API
abstract def show: String
Show a textual representation of the position.
- Annotations
- @deprecated
- Deprecated
(Since version 2.11.0) use
universe.show(position)instead
abstract def startOrPoint: Int
The start of the position's range, or point if not a range position.
- Annotations
- @deprecated
- Deprecated
(Since version 2.11.0) removed from the public API
abstract def toSingleLine: Pos
Convert this to a position around point that spans a single source line
- Annotations
- @deprecated
- Deprecated
(Since version 2.11.0) removed from the public API
abstract def union(pos: Pos): Pos
If this is a range, the union with the other range, with the point of this position. Otherwise, this position
- Annotations
- @deprecated
- Deprecated
(Since version 2.11.0) removed from the public API
Concrete Value Members
final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
final def ##(): Int
- Definition Classes
- AnyRef → Any
def +(other: String): String
def ->[B](y: B): (Position, B)
final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
def all: Set[Any]
The underlying payload with the guarantee that no two elements have the same type.
- Definition Classes
- Attachments
final def asInstanceOf[T0]: T0
- Definition Classes
- Any
def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
def contains[T](implicit arg0: ClassTag[T]): Boolean
Check underlying payload contains an instance of type T.
- Definition Classes
- Attachments
def ensuring(cond: (Position) ⇒ Boolean, msg: ⇒ Any): Position
def ensuring(cond: (Position) ⇒ Boolean): Position
def ensuring(cond: Boolean, msg: ⇒ Any): Position
def ensuring(cond: Boolean): Position
final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
def equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
def formatted(fmtstr: String): String
def get[T](implicit arg0: ClassTag[T]): Option[T]
An underlying payload of the given class type T.
- Definition Classes
- Attachments
final def getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
def isEmpty: Boolean
- Definition Classes
- Attachments
final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
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.
- Definition Classes
- Attachments
final def synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
def toString(): String
- Definition Classes
- AnyRef → Any
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. Replaces an existing payload of the same type, if exists.
- Definition Classes
- Attachments
final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
def →[B](y: B): (Position, B)
© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.12.9/scala-reflect/scala/reflect/api/Position.html
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.
Every non-empty position refers to a SourceFile and three character offsets within it: start, end, and point. The point is where the ^ belongs when issuing an error message, usually a Name. A range position can be designated as transparent, which excuses it from maintaining the invariants to follow. If a transparent position has opaque children, those are considered as if they were the direct children of the transparent position's parent.
Note: some of these invariants actually apply to the trees which carry the positions, but they are phrased as if the positions themselves were the parent/children for conciseness.
Invariant 1: in a focused/offset position, start == point == end Invariant 2: in a range position, start <= point < end Invariant 3: an offset position never has a child with a range position Invariant 4: every range position child of a range position parent is contained within its parent Invariant 5: opaque range position siblings overlap at most at a single point
The following tests are useful on positions:
pos.isDefined true if position is not an UndefinedPosition (those being NoPosition and FakePos) pos.isRange true if position is a range (opaque or transparent) which implies start < end pos.isOpaqueRange true if position is an opaque range
The following accessor methods are provided - an exception will be thrown if point/start/end are attempted on an UndefinedPosition.
pos.source The source file of the position, or NoSourceFile if unavailable pos.point The offset of the point pos.start The (inclusive) start offset, or the point of an offset position pos.end The (exclusive) end offset, or the point of an offset position
The following conversion methods are often used:
pos.focus Converts a range position to an offset position focused on the point pos.makeTransparent Convert an opaque range into a transparent range
For more information about
Positions, see the Reflection Guide: Annotations, Names, Scopes, and More