SourceFile

class SourceFile(val file: AbstractFile, computeContent: => Array[Char]) extends SourceFile
Companion:
object
trait SourceFile
trait AbstractFile
class Object
trait Matchable
class Any
object NoSource.type

Value members

Concrete methods

def apply(idx: Int): Char
def column(offset: Int): Int

The column corresponding to offset, starting at 0

The column corresponding to offset, starting at 0

The contents of the original source file. Note that this can be empty, for example when the source is read from Tasty.

The contents of the original source file. Note that this can be empty, for example when the source is read from Tasty.

override def equals(that: Any): Boolean

Compares the receiver object (this) with the argument object (that) for equivalence.

Compares the receiver object (this) with the argument object (that) for equivalence.

Any implementation of this method should be an equivalence relation:

  • It is reflexive: for any instance x of type Any, x.equals(x) should return true.
  • It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true.
  • It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).

Value parameters:
that

the object to compare against this object for equality.

Returns:

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

Definition Classes
Any

true for all source files except NoSource

true for all source files except NoSource

override def hashCode: Int

Calculate a hash code value for the object.

Calculate a hash code value for the object.

The default hashing algorithm is platform dependent.

Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.

Returns:

the hash code value for this object.

Definition Classes
Any
override def jfile: Optional[JFile]
Definition Classes
AbstractFile
def length: Int

length of the original source file Note that when the source is from Tasty, content() could be empty even though length > 0. Use content().length to determine the length of content().

length of the original source file Note that when the source is from Tasty, content() could be empty even though length > 0. Use content().length to determine the length of content().

def lineContent(offset: Int): String

The content of the line containing position offset

The content of the line containing position offset

def lineToOffset(index: Int): Int

Map line to offset of first character in line

Map line to offset of first character in line

Like lineToOffset, but doesn't crash if the index is out of bounds.

Like lineToOffset, but doesn't crash if the index is out of bounds.

override def name: String
Definition Classes
AbstractFile
def nextLine(offset: Int): Int

The start index of the line following the one containing position offset

The start index of the line following the one containing position offset

def offsetToLine(offset: Int): Int

Convert offset to line in this source file Lines are numbered from 0

Convert offset to line in this source file Lines are numbered from 0

override def path: String
Definition Classes
AbstractFile

Map a position to a position in the underlying source file. For regular source files, simply return the argument.

Map a position to a position in the underlying source file. For regular source files, simply return the argument.

def start: Int

The start of this file in the underlying source file

The start of this file in the underlying source file

The padding of the column corresponding to offset, includes tabs

The padding of the column corresponding to offset, includes tabs

def startOfLine(offset: Int): Int

The index of the first character of the line containing position offset

The index of the first character of the line containing position offset

override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Returns:

a string representation of the object.

Definition Classes
Any

The underlying source file

The underlying source file

Concrete fields