Class

org.bitbucket.inkytonik.kiama.util

FileSource

Related Doc: package util

Permalink

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
Visibility
  1. Public
  2. All

Instance Constructors

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

    Permalink

Value Members

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

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

    Permalink

    The content of the source.

    The content of the source.

    Definition Classes
    FileSourceSource
  7. val encoding: String

    Permalink
  8. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  9. val filename: String

    Permalink
  10. def finalize(): Unit

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

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

    Permalink
    Definition Classes
    Any
  13. lazy val lineCount: Int

    Permalink

    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
  14. def lineFinish(line: Int): Int

    Permalink

    Return the offset after the last character of a line.

    Return the offset after the last character of a line.

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

    Permalink

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

    Permalink
    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

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

    Permalink

    Convert an offset into the content into a position.

    Convert an offset into the content into a position.

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

    Permalink

    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
  21. val optName: Option[String]

    Permalink

    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
  22. def positionToOffset(position: Position): Option[Int]

    Permalink

    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
  23. def reader: Reader

    Permalink

    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
  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  25. final def wait(): Unit

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

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

    Permalink
    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