Trait

scala.reflect.api

Position

Related Doc: package api

Permalink

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.

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

Source
Position.scala
Linear Supertypes
Type Hierarchy
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. Position
  2. Attachments
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type Pos >: Null <: Position

    Permalink

    The position type of this attachment

    The position type of this attachment

    Definition Classes
    PositionAttachments

Abstract Value Members

  1. abstract def column: Int

    Permalink

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

  2. abstract def end: Int

    Permalink

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

  3. abstract def focus: Pos

    Permalink

    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

  4. abstract def isOpaqueRange: Boolean

    Permalink

    Is this position a non-transparent range position?

  5. abstract def isRange: Boolean

    Permalink

    Is this position a range position?

  6. abstract def isTransparent: Boolean

    Permalink

    Is this position a transparent position?

  7. abstract def line: Int

    Permalink

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

  8. abstract def makeTransparent: Pos

    Permalink

    If opaque range, make this position transparent.

  9. abstract def point: Int

    Permalink

    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.

  10. abstract def pos: Pos

    Permalink

    The underlying position

    The underlying position

    Definition Classes
    Attachments
  11. abstract def source: SourceFile

    Permalink

    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.

  12. abstract def start: Int

    Permalink

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

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

    Permalink

    Returns a new position with the same attributes, but a different end value (if a range).

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

    Permalink

    Returns a new position with the same attributes, but a different point value (if a range or offset).

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

    Permalink

    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
  16. abstract def withStart(off: Int): Pos

    Permalink

    Returns a new position with the same attributes, but a different start value (if a range).

  17. abstract def endOrPoint: Int

    Permalink

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

    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

  18. abstract def focusEnd: Pos

    Permalink

    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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.11.0) Removed from the public API

  19. abstract def focusStart: Pos

    Permalink

    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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.11.0) Removed from the public API

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

    Permalink

    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.

    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

  21. abstract def isDefined: Boolean

    Permalink

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

    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

  22. abstract def lineContent: String

    Permalink

    The content of the line this Position refers to.

    The content of the line this Position refers to.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.11.0) Removed from the public API

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

    Permalink

    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.

    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

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

    Permalink

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

    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

  25. abstract def precedes(pos: Pos): Boolean

    Permalink

    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.

    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

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

    Permalink

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

    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

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

    Permalink

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

    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

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

    Permalink

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

    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

  29. abstract def show: String

    Permalink

    Show a textual representation of the position.

    Show a textual representation of the position.

    Annotations
    @deprecated
    Deprecated

    (Since version 2.11.0) Use universe.show(position) instead

  30. abstract def startOrPoint: Int

    Permalink

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

    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

  31. abstract def toSingleLine: Pos

    Permalink

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

    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

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

    Permalink

    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

    Annotations
    @deprecated
    Deprecated

    (Since version 2.11.0) Removed from the public API

Concrete Value Members

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

    Permalink

    Test two objects for inequality.

    Test two objects for inequality.

    returns

    true if !(this == that), false otherwise.

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink

    Equivalent to x.hashCode except for boxed numeric types and null.

    Equivalent to x.hashCode except for boxed numeric types and null. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them. For null returns a hashcode where null.hashCode throws a NullPointerException.

    returns

    a hash value consistent with ==

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

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

    Permalink
    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()
  5. final def ==(arg0: Any): Boolean

    Permalink

    The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    AnyRef → Any
  6. def all: Set[Any]

    Permalink

    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
  7. final def asInstanceOf[T0]: T0

    Permalink

    Cast the receiver object to be of type T0.

    Cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

    returns

    the receiver object.

    Definition Classes
    Any
    Exceptions thrown

    ClassCastException if the receiver object is not an instance of the erasure of type T0.

  8. def clone(): AnyRef

    Permalink

    Create a copy of the receiver object.

    Create a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
    Note

    not specified by SLS as a member of AnyRef

  9. def contains[T](implicit arg0: ClassTag[T]): Boolean

    Permalink

    Check underlying payload contains an instance of type T.

    Check underlying payload contains an instance of type T.

    Definition Classes
    Attachments
  10. def ensuring(cond: (Position) ⇒ Boolean, msg: ⇒ Any): Position

    Permalink
    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
  11. def ensuring(cond: (Position) ⇒ Boolean): Position

    Permalink
    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: Boolean, msg: ⇒ Any): Position

    Permalink
    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): Position

    Permalink
    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. final def eq(arg0: AnyRef): Boolean

    Permalink

    Tests whether the argument (that) is a reference to the receiver object (this).

    Tests whether the argument (that) is a reference to the receiver object (this).

    The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:

    • It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
    • For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
    • null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    returns

    true if the argument is a reference to the receiver object; false otherwise.

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

    Permalink

    The equality method for reference types.

    The equality method for reference types. Default implementation delegates to eq.

    See also equals in scala.Any.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

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

    Permalink

    Called by the garbage collector on the receiver object when there are no more references to the object.

    Called by the garbage collector on the receiver object when there are no more references to the object.

    The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
    Note

    not specified by SLS as a member of AnyRef

  17. def formatted(fmtstr: String): String

    Permalink
    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()
  18. def get[T](implicit arg0: ClassTag[T]): Option[T]

    Permalink

    An underlying payload of the given class type T.

    An underlying payload of the given class type T.

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

    Permalink

    A representation that corresponds to the dynamic class of the receiver object.

    A representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    Definition Classes
    AnyRef → Any
    Note

    not specified by SLS as a member of AnyRef

  20. def hashCode(): Int

    Permalink

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in scala.Any.

    returns

    the hash code value for this object.

    Definition Classes
    AnyRef → Any
  21. def isEmpty: Boolean

    Permalink
    Definition Classes
    Attachments
  22. final def isInstanceOf[T0]: Boolean

    Permalink

    Test whether the dynamic type of the receiver object is T0.

    Test whether the dynamic type of the receiver object is T0.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

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

    Permalink

    Equivalent to !(this eq that).

    Equivalent to !(this eq that).

    returns

    true if the argument is not a reference to the receiver object; false otherwise.

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

    Permalink

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  25. final def notifyAll(): Unit

    Permalink

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

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

    Permalink

    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

    Permalink
    Definition Classes
    AnyRef
  28. def toString(): String

    Permalink

    Creates a String representation of this object.

    Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

    returns

    a String representation of the object.

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

    Permalink

    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

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

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

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

    Permalink
    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 any2stringadd from Position to any2stringadd[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