silex
API
Generated with
silex/silex

silex

package silex

This package is used to write lexers.

=Lexer=

To define a lexer, mix-in the silex.Lexers trait.

object MyLexer extends Lexers {

 // Type of characters consumed.
 type Character = Char

 // Type of positions.
 type Position = MyPosition

 // Type of tokens produced.
 type Token = MyToken

 // Then define your lexing rules using regular expressions.
 val lex = Lexer(...)

 // Then, you can query the lexer.
 def apply(source: Source[Character, Position]): Iterator[Token] =
   lex(source)
}

Additional traits can be mixed-in. See for instance silex.CharLexers for lexers specialized on Char.

=Data sources=

The input of lexers is in a form of a data source.

// Building a source from a string:
val stringSource = Source.fromString("[1, 2, 3]")

// Or from a file:
val fileSource = Source.fromFile("data/clients.json")

// With a custom positioner:
val customSource = Source.fromFile("data/clients.json", IndexPositioner)

Attributes

Members list

Packages

package silex.util

Grouped members

Lexers

trait CharLexers

Specialized lexers operating on Char characters. Expected to be mixed-in with silex.Lexers.

Specialized lexers operating on Char characters. Expected to be mixed-in with silex.Lexers.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
trait Lexers extends RegExps, Zippers

Contains definitions for lexers.

Contains definitions for lexers.

Attributes

Supertypes
trait Zippers
trait RegExps
class Object
trait Matchable
class Any
trait RegExps

Contains definitions relating to regular expressions.

Contains definitions relating to regular expressions.

Attributes

See also

See silex.CharLexers for useful regular expressions on Char.

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Lexers

Sources

trait Source[Character, Position] extends Iterator[Character]

Represents iterators with Positions and ability to mark points and reset to them.

Represents iterators with Positions and ability to mark points and reset to them.

Attributes

Companion
object
Supertypes
trait Iterator[Character]
trait IterableOnceOps[Character, Iterator, Iterator[Character]]
trait IterableOnce[Character]
class Object
trait Matchable
class Any
Show all
Known subtypes
class ArraySource[Character, Position]
class IteratorSource[Character, Position]
class ReaderSource[Position]
class StringSource[Position]
object Source

Builds sources.

Builds sources.

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
Source.type

Positions

case class StringPosition(index: Int, line: Int, column: Int)

Position within a string.

Position within a string.

Value parameters

column

The column number. Zero-based.

index

The index in the string. Zero-based.

line

The line number. Zero-based.

Attributes

See also

See silex.StringPositioner for the corresponding positioner.

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Positioners

object IndexPositioner extends Positioner[Any, Int]

General index-based positioner.

General index-based positioner.

Attributes

Supertypes
trait Positioner[Any, Int]
class Object
trait Matchable
class Any
Self type
object NoPositioner extends Positioner[Any, Unit]

Positioner for Unit positions.

Positioner for Unit positions.

Attributes

Supertypes
trait Positioner[Any, Unit]
class Object
trait Matchable
class Any
Self type
trait Positioner[-Character, Position]

Indicates the start position and how to increment positions.

Indicates the start position and how to increment positions.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
object NoPositioner
object StringPositioner extends Positioner[Char, StringPosition]

Positioner for silex.StringPosition.

Positioner for silex.StringPosition.

Attributes

Supertypes
trait Positioner[Char, StringPosition]
class Object
trait Matchable
class Any
Self type

Type members

Classlikes

class ArraySource[Character, Position](array: Array[Character], positioner: Positioner[Character, Position]) extends Source[Character, Position]

Source over an array of character.

Source over an array of character.

Attributes

Supertypes
trait Source[Character, Position]
trait Iterator[Character]
trait IterableOnceOps[Character, Iterator, Iterator[Character]]
trait IterableOnce[Character]
class Object
trait Matchable
class Any
Show all
class IteratorSource[Character, Position](iterator: Iterator[Character], positioner: Positioner[Character, Position]) extends Source[Character, Position]

Source over an interator.

Source over an interator.

Attributes

Supertypes
trait Source[Character, Position]
trait Iterator[Character]
trait IterableOnceOps[Character, Iterator, Iterator[Character]]
trait IterableOnce[Character]
class Object
trait Matchable
class Any
Show all
class ReaderSource[Position](reader: Reader, positioner: Positioner[Char, Position], markLimit: Int) extends Source[Char, Position]

Source over a Reader.

Source over a Reader.

Attributes

Supertypes
trait Source[Char, Position]
trait Iterator[Char]
trait IterableOnceOps[Char, Iterator, Iterator[Char]]
trait IterableOnce[Char]
class Object
trait Matchable
class Any
Show all
class StringSource[Position](string: String, positioner: Positioner[Char, Position]) extends Source[Char, Position]

Source over an array of character.

Source over an array of character.

Attributes

Supertypes
trait Source[Char, Position]
trait Iterator[Char]
trait IterableOnceOps[Char, Iterator, Iterator[Char]]
trait IterableOnce[Char]
class Object
trait Matchable
class Any
Show all
Generated with