Packages

  • package root

    This is the documentation for Parsley.

    This is the documentation for Parsley.

    Package structure

    The parsley package contains the Parsley class, as well as the Result, Success, and Failure types. In addition to these, it also contains the following packages and "modules" (a module is defined as being an object which mocks a package):

    • parsley.Parsley contains the bulk of the core "function-style" combinators.
    • parsley.combinator contains many helpful combinators that simplify some common parser patterns.
    • parsley.character contains the combinators needed to read characters and strings, as well as combinators to match specific sub-sets of characters.
    • parsley.debug contains debugging combinators, helpful for identifying faults in parsers.
    • parsley.expr contains the following sub modules:
      • parsley.expr.chain contains combinators used in expression parsing
      • parsley.expr.precedence is a builder for expression parsers built on a precedence table.
      • parsley.expr.infix contains combinators used in expression parsing, but with more permissive types than their equivalents in chain.
      • parsley.expr.mixed contains combinators that can be used for expression parsing, but where different fixities may be mixed on the same level: this is rare in practice.
    • parsley.syntax contains several implicits to add syntactic sugar to the combinators. These are sub-categorised into the following sub modules:
      • parsley.syntax.character contains implicits to allow you to use character and string literals as parsers.
      • parsley.syntax.lift enables postfix application of the lift combinator onto a function (or value).
      • parsley.syntax.zipped enables boths a reversed form of lift where the function appears on the right and is applied on a tuple (useful when type inference has failed) as well as a .zipped method for building tuples out of several combinators.
      • parsley.syntax.extension contains syntactic sugar combinators exposed as implicit classes.
    • parsley.errors contains modules to deal with error messages, their refinement and generation.
    • parsley.lift contains functions which lift functions that work on regular types to those which now combine the results of parsers returning those same types. these are ubiquitous.
    • parsley.ap contains functions which allow for the application of a parser returning a function to several parsers returning each of the argument types.
    • parsley.state contains combinators that interact with the context-sensitive functionality in the form of state.
    • parsley.token contains the Lexer class that provides a host of helpful lexing combinators when provided with the description of a language.
    • parsley.position contains parsers for extracting position information.
    • parsley.generic contains some basic implementations of the Parser Bridge pattern (see Design Patterns for Parser Combinators in Scala, or the parsley wiki): these can be used before more specialised generic bridge traits can be constructed.
    Definition Classes
    root
  • package parsley
    Definition Classes
    root
  • package syntax

    This package contains various functionality that involve Scala's implicits mechanism.

    This package contains various functionality that involve Scala's implicits mechanism.

    This includes conversions from scala literals into parsers, as well as enabling new syntax on regular Scala values (such as Parsley's lift or zipped syntax). Automatic conversion to Parsley[Unit] is also supported within this package.

    Definition Classes
    parsley
  • character
  • extension
  • lift
  • zipped

object zipped

This module provides alternatives to the f.lift(x, y) syntax, (x, y).zipped(f), which works better with type inference.

Also enables a parameterless zipped method, to pair an arbitrary number of parsers such that (p, q).zipped = p.zip(q).

Thanks to Andrei Gramescu and George Stacey for ensuring that these combinators even exist in the first place.

Source
zipped.scala
Example:

  1. scala> import parsley.character.char
scala> import parsley.syntax.zipped.{Zipped2, Zipped3}
scala> case class Add(x: Int, y: Int)
scala> val p = (char('a').as(4), char('b').as(5)).zipped(Add)
scala> p.parse("ab")
val res0 = Success(Add(4, 5))
scala> val q = (char('a').as(3), char('b').as(2), char('c').as(5)).zipped((x, y, z) => x * y + z)
scala> q.parse("abc")
val res1 = Success(11)
scala> q.parse("ab")
val res2 = Failure(..)
Since

4.5.0

Note

these methods are not lazy like the lift syntax or liftN functions! Use the prefix ~ combinator to make arguments lazy where necessary.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. zipped
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. implicit final class Zipped10[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10] extends AnyVal

    This class enables the zipped syntax on tuples of ten parsers.

  2. implicit final class Zipped11[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11] extends AnyVal

    This class enables the zipped syntax on tuples of eleven parsers.

  3. implicit final class Zipped12[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12] extends AnyVal

    This class enables the zipped syntax on tuples of twelve parsers.

  4. implicit final class Zipped13[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13] extends AnyVal

    This class enables the zipped syntax on tuples of thirteen parsers.

  5. implicit final class Zipped14[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14] extends AnyVal

    This class enables the zipped syntax on tuples of fourteen parsers.

  6. implicit final class Zipped15[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15] extends AnyVal

    This class enables the zipped syntax on tuples of fifteen parsers.

  7. implicit final class Zipped16[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16] extends AnyVal

    This class enables the zipped syntax on tuples of sixteen parsers.

  8. implicit final class Zipped17[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17] extends AnyVal

    This class enables the zipped syntax on tuples of seventeen parsers.

  9. implicit final class Zipped18[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18] extends AnyVal

    This class enables the zipped syntax on tuples of eighteen parsers.

  10. implicit final class Zipped19[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19] extends AnyVal

    This class enables the zipped syntax on tuples of nineteen parsers.

  11. implicit final class Zipped2[T1, T2] extends AnyVal

    This class enables the zipped syntax on pairs of two parsers.

  12. implicit final class Zipped20[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20] extends AnyVal

    This class enables the zipped syntax on tuples of twenty parsers.

  13. implicit final class Zipped21[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21] extends AnyVal

    This class enables the zipped syntax on tuples of twenty-one parsers.

  14. implicit final class Zipped22[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22] extends AnyVal

    This class enables the zipped syntax on tuples of twenty-two parsers.

  15. implicit final class Zipped3[T1, T2, T3] extends AnyVal

    This class enables the zipped syntax on tuples of three parsers.

  16. implicit final class Zipped4[T1, T2, T3, T4] extends AnyVal

    This class enables the zipped syntax on tuples of four parsers.

  17. implicit final class Zipped5[T1, T2, T3, T4, T5] extends AnyVal

    This class enables the zipped syntax on tuples of five parsers.

  18. implicit final class Zipped6[T1, T2, T3, T4, T5, T6] extends AnyVal

    This class enables the zipped syntax on tuples of six parsers.

  19. implicit final class Zipped7[T1, T2, T3, T4, T5, T6, T7] extends AnyVal

    This class enables the zipped syntax on tuples of seven parsers.

  20. implicit final class Zipped8[T1, T2, T3, T4, T5, T6, T7, T8] extends AnyVal

    This class enables the zipped syntax on tuples of eight parsers.

  21. implicit final class Zipped9[T1, T2, T3, T4, T5, T6, T7, T8, T9] extends AnyVal

    This class enables the zipped syntax on tuples of nine parsers.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped