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 Position
s, see the Reflection Guide: Annotations, Names, Scopes, and More
- Source
- Position.scala
- Grouped
- Alphabetic
- By Inheritance
- Position
- Attachments
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Type Members
-
abstract
type
Pos >: Null <: Position
The position type of this attachment
The position type of this attachment
- Definition Classes
- Position → Attachments
Abstract Value Members
-
abstract
def
column: Int
The position indicates a
column
and theline
in the source file. -
abstract
def
end: Int
The end of the position's range, or the point if not a range position.
-
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
-
abstract
def
isOpaqueRange: Boolean
Is this position a non-transparent range position?
-
abstract
def
isRange: Boolean
Is this position a range position?
-
abstract
def
isTransparent: Boolean
Is this position a transparent position?
-
abstract
def
line: Int
The position indicates a
column
and theline
in the source file. -
abstract
def
makeTransparent: Pos
If opaque range, make this position transparent.
-
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.
-
abstract
def
pos: Pos
The underlying position
The underlying position
- Definition Classes
- Attachments
-
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. -
abstract
def
start: Int
The start of the position's range, or the point if not a range position.
-
abstract
def
withEnd(off: Int): Pos
Returns a new position with the same attributes, but a different end value (if a range).
-
abstract
def
withPoint(off: Int): Pos
Returns a new position with the same attributes, but a different point value (if a range or offset).
-
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
-
abstract
def
withStart(off: Int): Pos
Returns a new position with the same attributes, but a different start value (if a range).
-
abstract
def
endOrPoint: Int
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
-
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
- 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.
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 ifthis
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 ifthis
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.
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.
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.
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.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.
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)?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).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
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.
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.
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 lineConvert 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.
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
Test two objects for inequality.
Test two objects for inequality.
- returns
true
if !(this == that), false otherwise.
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
Equivalent to
x.hashCode
except for boxed numeric types andnull
.Equivalent to
x.hashCode
except for boxed numeric types andnull
. 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. Fornull
returns a hashcode wherenull.hashCode
throws aNullPointerException
.- returns
a hash value consistent with ==
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Position, B)
-
final
def
==(arg0: Any): Boolean
The expression
x == that
is equivalent toif (x eq null) that eq null else x.equals(that)
.The expression
x == that
is equivalent toif (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
-
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
-
final
def
asInstanceOf[T0]: T0
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 aClassCastException
at runtime, while the expressionList(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 typeT0
.
-
def
clone(): AnyRef
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
-
def
contains[T](implicit arg0: ClassTag[T]): Boolean
Check underlying payload contains an instance of type
T
.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
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 ofAnyRef
, and has three additional properties:- It is consistent: for any non-null instances
x
andy
of typeAnyRef
, multiple invocations ofx.eq(y)
consistently returnstrue
or consistently returnsfalse
. - For any non-null instance
x
of typeAnyRef
,x.eq(null)
andnull.eq(x)
returnsfalse
. null.eq(null)
returnstrue
.
When overriding the
equals
orhashCode
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
- It is consistent: for any non-null instances
-
def
equals(arg0: Any): Boolean
The equality method for reference types.
-
def
finalize(): Unit
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 betweenfinalize
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
- def formatted(fmtstr: String): String
-
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
-
final
def
getClass(): Class[_]
Returns the runtime class representation of the object.
Returns the runtime class representation of the object.
- returns
a class object corresponding to the runtime type of the receiver.
- Definition Classes
- AnyRef → Any
-
def
hashCode(): Int
The hashCode method for reference types.
-
def
isEmpty: Boolean
- Definition Classes
- Attachments
-
final
def
isInstanceOf[T0]: Boolean
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 returnfalse
, while the expressionList(1).isInstanceOf[List[String]]
will returntrue
. 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 typeT0
;false
otherwise.
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
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
-
final
def
notify(): Unit
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
-
final
def
notifyAll(): Unit
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
-
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
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
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
-
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
-
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( ... )
- def →[B](y: B): (Position, B)