Scala example source code file (CharSequenceReader.scala)

This example Scala source code file (CharSequenceReader.scala) is included in the DevDaily.com "Java Source Code Warehouse" project. The intent of this project is to help you "Learn Java by Example" ^TM.

Java - Scala tags/keywords

charsequencereader, charsequencereader, eofch, eofch, int, int, offsetposition, offsetposition, position, reader

The Scala CharSequenceReader.scala source code

/*                     __                                               *\
**     ________ ___   / /  ___     Scala API                            **
**    / __/ __// _ | / /  / _ |    (c) 2006-2011, LAMP/EPFL             **
**  __\ \/ /__/ __ |/ /__/ __ |    http://scala-lang.org/               **
** /____/\___/_/ |_/____/_/ | |                                         **
**                          |/                                          **
\*                                                                      */


package scala.util.parsing.input

/** An object encapsulating basic character constants 
 *
 * @author Martin Odersky, Adriaan Moors
 */
object CharSequenceReader {
  final val EofCh = '\032'
}

/** A character array reader reads a stream of characters (keeping track of their positions) 
 * from an array.
 *
 * @param source the source sequence
 * @param offset  starting offset.
 *
 * @author Martin Odersky 
 */
class CharSequenceReader(override val source: java.lang.CharSequence, 
                         override val offset: Int) extends Reader[Char] {
  import CharSequenceReader._

  /** Construct a <code>CharSequenceReader with its first element at
   *  <code>source(0) and position (1,1).
   */
  def this(source: java.lang.CharSequence) = this(source, 0)

  /** Returns the first element of the reader, or EofCh if reader is at its end 
   */
  def first = 
    if (offset < source.length) source.charAt(offset) else EofCh 

  /** Returns a CharSequenceReader consisting of all elements except the first 
   * 
   * @return If <code>atEnd is true, the result will be
   *         <code>this'; otherwise, it's a CharSequenceReader containing
   *         the rest of input.
   */
  def rest: CharSequenceReader =
    if (offset < source.length) new CharSequenceReader(source, offset + 1)
    else this

  /** The position of the first element in the reader
   */
  def pos: Position = new OffsetPosition(source, offset)

  /** true iff there are no more elements in this reader (except for trailing
   *  EofCh's)
   */
  def atEnd = offset >= source.length
    
  /** Returns an abstract reader consisting of all elements except the first
   *  <code>n elements.
   */ 
  override def drop(n: Int): CharSequenceReader = 
    new CharSequenceReader(source, offset + n)
}