The end of the position's range, error if not a range position
The end of the position's range, or point if not a range position
Content of the source file that contains this position.
Java file corresponding to the source file of this position.
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
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
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
Does this position include the given position pos.
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.
Is this position neither a NoPosition nor a FakePosition? If isDefined is true, offset and source are both defined.
Is this position a non-transparent range position?
Is this position a range position?
Is this position a transparent position?
if opaque range, make this position transparent
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.
The point (where the ^ is) of the position
The point (where the ^ is) of the position, or else default if undefined
Gets the underlying position
Gets the underlying 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.
Does this position properly include the given position pos ("properly" meaning their
ranges are not the same)?
Does this position properly precede the given position pos ("properly" meaning their ranges
do not share a common point).
Does this position cover the same range as that position? Holds only if both position are ranges
The start of the position's range, error if not a range position
The start of the position's range, or point if not a range position
Convert this to a position around point that spans a single source line
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
The same position with a different end value (if a range)
The same position with a different point value (if a range or offset)
Creates a copy of this attachment with its position updated
Creates a copy of this attachment with its position updated
The same position with a different start value (if a range)
Test two objects for inequality.
Test two objects for inequality.
true if !(this == that), false otherwise.
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.
a hash value consistent with ==
Test two objects for equality.
Test two objects for equality.
The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).
true if the receiver object is equivalent to the argument; false otherwise.
Creates a copy of this attachment with its payload updated
Creates a copy of this attachment with its payload updated
Gets the underlying payload
Gets the underlying payload
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.
the receiver object.
if the receiver object is not an instance of the erasure of type T0.
Create a copy of the receiver object.
Create a copy of the receiver object.
The default implementation of the clone method is platform dependent.
a copy of the receiver object.
not specified by SLS as a member of AnyRef
Tests whether the argument (arg0) is a reference to the receiver object (this).
Tests whether the argument (arg0) 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:
x and y of type AnyRef, multiple invocations of
x.eq(y) consistently returns true or consistently returns false.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).
true if the argument is a reference to the receiver object; false otherwise.
The equality method for reference types.
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.
not specified by SLS as a member of AnyRef
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).
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.
a representation that corresponds to the dynamic class of the receiver object.
not specified by SLS as a member of AnyRef
The hashCode method for reference types.
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.
true if the receiver object is an instance of erasure of type T0; false otherwise.
Equivalent to !(this eq that).
Equivalent to !(this eq that).
true if the argument is not a reference to the receiver object; false otherwise.
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.
not specified by SLS as a member of AnyRef
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.
not specified by SLS as a member of AnyRef
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.
a String representation of the object.
(positionApi: StringAdd).self
(positionApi: StringFormat).self
(positionApi: ArrowAssoc[PositionApi]).x
(Since version 2.10.0) Use leftOfArrow instead
(positionApi: Ensuring[PositionApi]).x
(Since version 2.10.0) Use resultOfEnsuring instead
The Position class and its subclasses represent positions of ASTs and symbols. Except for NoPosition and FakePos, every position refers to a SourceFile and to an offset in the sourcefile (its
point). For batch compilation, that's all. For interactive IDE's there are also RangePositions and TransparentPositions. A RangePosition indicates a start and an end in addition to its point. TransparentPositions are a subclass of RangePositions. Range positions that are not transparent are called opaque. Trees with RangePositions need to satisfy the following invariants.INV1: A tree with an offset position never contains a child with a range position INV2: If the child of a tree with a range position also has a range position, then the child's range is contained in the parent's range. INV3: Opaque range positions of children of the same node are non-overlapping (this means their overlap is at most a single point).
The following tests are useful on positions:
pos.isDefined true if position is not a NoPosition nor a FakePosition pos.isRange true if position is a range pos.isOpaqueRange true if position is an opaque range
The following accessor methods are provided:
pos.source The source file of the position, which must be defined pos.point The offset of the position's point, which must be defined pos.start The start of the position, which must be a range pos.end The end of the position, which must be a range
There are also convenience methods, such as
pos.startOrPoint pos.endOrPoint pos.pointOrElse(default)
These are less strict about the kind of position on which they can be applied.
The following conversion methods are often used:
pos.focus converts a range position to an offset position, keeping its point; returns all other positions unchanged. pos.makeTransparent converts an opaque range position into a transparent one. returns all other positions unchanged.