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.registers contains combinators that interact with the context-sensitive functionality in the form of registers.
    • 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 implicits

    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
  • object zipped

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

    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.

    Definition Classes
    implicits
    Annotations
    @deprecated
    Deprecated

    (Since version 4.5.0) This will be removed in 5.x, use parsley.syntax.zipped instead

    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

    3.0.0

    Note

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

  • Zipped10
  • Zipped11
  • Zipped12
  • Zipped13
  • Zipped14
  • Zipped15
  • Zipped16
  • Zipped17
  • Zipped18
  • Zipped19
  • Zipped2
  • Zipped20
  • Zipped21
  • Zipped22
  • Zipped3
  • Zipped4
  • Zipped5
  • Zipped6
  • Zipped7
  • Zipped8
  • Zipped9

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.

Source
zipped.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Zipped22
  2. AnyVal
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Zipped22(t: (Parsley[T1], Parsley[T2], Parsley[T3], Parsley[T4], Parsley[T5], Parsley[T6], Parsley[T7], Parsley[T8], Parsley[T9], Parsley[T10], Parsley[T11], Parsley[T12], Parsley[T13], Parsley[T14], Parsley[T15], Parsley[T16], Parsley[T17], Parsley[T18], Parsley[T19], Parsley[T20], Parsley[T21], Parsley[T22]))

    This constructor should not be called manually, it is designed to be used via Scala's implicit resolution.

    This constructor should not be called manually, it is designed to be used via Scala's implicit resolution.

    t

    the twenty-two parsers whose results should be zipped together.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    Any
  2. final def ##: Int
    Definition Classes
    Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def getClass(): Class[_ <: AnyVal]
    Definition Classes
    AnyVal → Any
  6. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  7. def toString(): String
    Definition Classes
    Any
  8. def zipped: Parsley[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22)]

    This combinator executes each of these parsers and pairs all their results together.

    This combinator executes each of these parsers and pairs all their results together.

    Each of these parsers is executed in turn, each yielding a result. So long as every parser succeeded, the whole combinator succeeds. The pair formed from all of the results is returned by the parser. If any of these parsers fail, the whole combinator fails.

    returns

    a parser that seqeunces each of these parsers and pairs them all together.

  9. def zipped[R](f: (T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22) => R): Parsley[R]

    This combinator executes each of these parsers and combines their results with a given function.

    This combinator executes each of these parsers and combines their results with a given function.

    Each of these parsers is executed in turn, each yielding a result. So long as every parser succeeded, the whole combinator succeeds and each of the results is fed into the function f. The result of applying f to the results is returned by the combinator. If any of these parsers fail, the whole combinator fails.

    f

    the function to apply across the results of all the parsers.

    returns

    a parser that seqeunces each of these parsers and combines their results with the function f.

Inherited from AnyVal

Inherited from Any

Ungrouped