scala-parser-combinators/scala.util.parsing.input

scala.util.parsing.input

package scala.util.parsing.input

Type members

Classlikes

object CharArrayReader
An object encapsulating basic character constants.
Companion
class
class CharArrayReader(chars: Array[Char], index: Int) extends CharSequenceReader
A character array reader reads a stream of characters (keeping track of their positions)
from an array.
Value Params
chars
an array of characters
index
starting offset into the array; the first element returned will be source(index)
Companion
object
object CharSequenceReader
An object encapsulating basic character constants.
Companion
class
class CharSequenceReader(val source: CharSequence, val offset: Int) extends Reader[Char]
A character array reader reads a stream of characters (keeping track of their positions)
from an array.
Value Params
offset
starting offset.
source
the source sequence
Companion
object
object NoPosition extends Position
Undefined position.
case class OffsetPosition(source: CharSequence, offset: Int) extends Position
OffsetPosition is a standard class for positions
represented as offsets into a source document.
Value Params
offset
The offset indicating the position
source
The source document
Companion
object
object OffsetPosition extends AbstractFunction2[CharSequence, Int, OffsetPosition] with PositionCache
An object holding the index cache.
Companion
class
object PagedSeq
The PagedSeq object defines a lazy implementations of
a random access sequence.
Provides utility methods that return instances of PagedSeq[Char].
fromIterator and fromIterable provide generalised instances of PagedSeq
Companion
class
class PagedSeq[T] extends AbstractSeq[T] with IndexedSeq[T] with ScalaVersionSpecificPagedSeq[T]
An implementation of lazily computed sequences, where elements are stored
in "pages", i.e. arrays of fixed size.
A paged sequence is constructed from a function that produces more elements when asked.
The producer function - more, is similar to the read method in java.io.Reader.
The more function takes three parameters: an array of elements, a start index, and an end index.
It should try to fill the array between start and end indices (excluding end index).
It returns the number of elements produced, or -1 if end of logical input stream was reached
before reading any element.
Type Params
T
the type of the elements contained in this paged sequence, with an ClassTag context bound.
Companion
object
object PagedSeqReader
An object encapsulating basic character constants.
Companion
class
class PagedSeqReader(seq: PagedSeq[Char], val offset: Int) extends Reader[Char]
A character array reader reads a stream of characters (keeping track of their positions)
from an array.
Value Params
offset
starting offset.
seq
the source sequence
Companion
object
trait Position
Position is the base trait for objects describing a position in a document.
It provides functionality for:
- generating a visual representation of this position (longString);
- comparing two positions (<).
To use this class for a concrete kind of document, implement the lineContents method.
trait Positional
A trait for objects that have a source position.
abstract class Reader[+T]
An interface for streams of values that have positions.
object StreamReader
An object to create a StreamReader from a java.io.Reader.
Companion
class
sealed class StreamReader extends PagedSeqReader
A StreamReader reads from a character sequence, typically created as a PagedSeq
from a java.io.Reader
NOTE:
StreamReaders do not really fulfill the new contract for readers, which
requires a source CharSequence representing the full input.
Instead source is treated line by line.
As a consequence, regex matching cannot extend beyond a single line
when a StreamReader are used for input.
If you need to match regexes spanning several lines you should consider
class PagedSeqReader instead.
Companion
object