org.bitbucket.inkytonik.kiama.util

FileSource

case class FileSource(filename: String, encoding: String = "UTF-8") extends Source with Product with Serializable

A source that is a named file.

Source
Source.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, Source, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. FileSource
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Source
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FileSource(filename: String, encoding: String = "UTF-8")

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. lazy val content: String

    Definition Classes
    FileSourceSource
  9. val encoding: String

  10. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  11. val filename: String

  12. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  15. lazy val lineCount: Int

    A map of line offsets into the source character sequence and a count of how many lines are present.

    A map of line offsets into the source character sequence and a count of how many lines are present. The line offset map is indexed starting at zero and contains at least one entry.

    Definition Classes
    Source
  16. def lineFinish(line: Int): Int

    Return the offset after the last character of a line.

    Return the offset after the last character of a line.

    Definition Classes
    Source
  17. lazy val lineStarts: Vector[Int]

    A map of line offsets into the source character sequence and a count of how many lines are present.

    A map of line offsets into the source character sequence and a count of how many lines are present. The line offset map is indexed starting at zero and contains at least one entry.

    Definition Classes
    Source
  18. final def ne(arg0: AnyRef): Boolean

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

    Definition Classes
    AnyRef
  20. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  21. def offsetToPosition(offset: Int): Position

    Convert an offset into the content into a position.

    Convert an offset into the content into a position.

    Definition Classes
    Source
  22. def optLineContents(line: Int): Option[String]

    If the given line number is within range for this source, return the content of that line, otherwise return None.

    If the given line number is within range for this source, return the content of that line, otherwise return None. As a special case, support a line beyond the end of the input which contains nothing since parsers

    Definition Classes
    Source
  23. val optName: Option[String]

    The name of this source or None if it doesn't have a name.

    The name of this source or None if it doesn't have a name.

    Definition Classes
    FileSourceSource
  24. def positionToOffset(position: Position): Option[Int]

    If the position is valid for this source, return the corresponding offset into the content, otherwise return None.

    If the position is valid for this source, return the corresponding offset into the content, otherwise return None.

    Definition Classes
    Source
  25. def reader: Reader

    Return a reader on this source.

    Return a reader on this source. Not normally used by Kiama but useful if you want to use a source with other code that requires a reader.

    Definition Classes
    FileSourceSource
  26. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  27. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Source

Inherited from AnyRef

Inherited from Any

Ungrouped