Parsley.Internal.Backend.Machine.InputOps

This module contains the primitive operations required by the parsing machinery to work with input.

Since: 1.0.0.0

Documentation

class InputPrep input where

This class is responsible for converting the user's input into a form that parsley can work with efficiently.

Since: 1.0.0.0

Methods

prepare :: rep ~ Rep input => Code input -> Code (InputDependant rep)

Given the user's input to the parser, in its original form, this function distils it first into Rep input, which is parsley's internal representation, and then produces an InputDependant containing the core operations.

Since: 1.0.0.0

Instances

InputPrep ByteString

Defined in Parsley.Internal.Backend.Machine.InputOps

Methods

prepare :: forall (rep :: TYPE (RepKind ByteString)). rep ~ Rep ByteString => Code ByteString -> Code (InputDependant rep)

InputPrep ByteString

Defined in Parsley.Internal.Backend.Machine.InputOps

Methods

prepare :: forall (rep :: TYPE (RepKind ByteString)). rep ~ Rep ByteString => Code ByteString -> Code (InputDependant rep)

InputPrep Text

Defined in Parsley.Internal.Backend.Machine.InputOps

Methods

prepare :: forall (rep :: TYPE (RepKind Text)). rep ~ Rep Text => Code Text -> Code (InputDependant rep)

InputPrep Stream

Defined in Parsley.Internal.Backend.Machine.InputOps

Methods

prepare :: forall (rep :: TYPE (RepKind Stream)). rep ~ Rep Stream => Code Stream -> Code (InputDependant rep)

InputPrep CharList

Defined in Parsley.Internal.Backend.Machine.InputOps

Methods

prepare :: forall (rep :: TYPE (RepKind CharList)). rep ~ Rep CharList => Code CharList -> Code (InputDependant rep)

InputPrep Text16

Defined in Parsley.Internal.Backend.Machine.InputOps

Methods

prepare :: forall (rep :: TYPE (RepKind Text16)). rep ~ Rep Text16 => Code Text16 -> Code (InputDependant rep)

InputPrep [Char]

Defined in Parsley.Internal.Backend.Machine.InputOps

Methods

prepare :: forall (rep :: TYPE (RepKind [Char])). rep ~ Rep [Char] => Code [Char] -> Code (InputDependant rep)

InputPrep (UArray Int Char)

Defined in Parsley.Internal.Backend.Machine.InputOps

Methods

prepare :: forall (rep :: TYPE (RepKind (UArray Int Char))). rep ~ Rep (UArray Int Char) => Code (UArray Int Char) -> Code (InputDependant rep)

class PositionOps (rep :: TYPE r) where

Defines operations for manipulating offsets for regular use. These are not tied to the original captured input but instead to the representation of its offset.

Since: 1.0.0.0

Methods

same :: Code rep -> Code rep -> Code Bool

Compares two "input"s for equality. In reality this usually means an offset present in the rep.

Since: 1.0.0.0

shiftRight :: Code rep -> Code Int# -> Code rep

Advances the input by several characters at a time (existence not included). This can be used to check if characters exist at a future point in the input in conjunction with more.

Since: 1.0.0.0

Instances

PositionOps Text

Defined in Parsley.Internal.Backend.Machine.InputOps

Methods

same :: Code Text -> Code Text -> Code Bool

shiftRight :: Code Text -> Code Int# -> Code Text

PositionOps Int#

Defined in Parsley.Internal.Backend.Machine.InputOps

Methods

same :: Code Int# -> Code Int# -> Code Bool

shiftRight :: Code Int# -> Code Int# -> Code Int#

PositionOps UnpackedLazyByteString

Defined in Parsley.Internal.Backend.Machine.InputOps

Methods

same :: Code UnpackedLazyByteString -> Code UnpackedLazyByteString -> Code Bool

shiftRight :: Code UnpackedLazyByteString -> Code Int# -> Code UnpackedLazyByteString

PositionOps (# Int#, [Char] #)

Defined in Parsley.Internal.Backend.Machine.InputOps

Methods

same :: Code (# Int#, [Char] #) -> Code (# Int#, [Char] #) -> Code Bool

shiftRight :: Code (# Int#, [Char] #) -> Code Int# -> Code (# Int#, [Char] #)

PositionOps (# Int#, Stream #)

Defined in Parsley.Internal.Backend.Machine.InputOps

Methods

same :: Code (# Int#, Stream #) -> Code (# Int#, Stream #) -> Code Bool

shiftRight :: Code (# Int#, Stream #) -> Code Int# -> Code (# Int#, Stream #)

class LogOps (rep :: TYPE r) where

Defines operation used for debugging operations.

Since: 1.0.0.0

Methods

shiftLeft :: Code rep -> Code Int# -> Code rep

If possible, shifts the input back several characters. This is used to provide the previous input characters for the debugging combinator.

Since: 1.0.0.0

offToInt :: Code rep -> Code Int

Converts the represention of the input into an Int.

Since: 1.0.0.0

Instances

LogOps Text

Defined in Parsley.Internal.Backend.Machine.InputOps

Methods

shiftLeft :: Code Text -> Code Int# -> Code Text

offToInt :: Code Text -> Code Int

LogOps Int#

Defined in Parsley.Internal.Backend.Machine.InputOps

Methods

shiftLeft :: Code Int# -> Code Int# -> Code Int#

offToInt :: Code Int# -> Code Int

LogOps UnpackedLazyByteString

Defined in Parsley.Internal.Backend.Machine.InputOps

Methods

shiftLeft :: Code UnpackedLazyByteString -> Code Int# -> Code UnpackedLazyByteString

offToInt :: Code UnpackedLazyByteString -> Code Int

LogOps ((# Int#, ts #) :: TYPE ('TupleRep '['IntRep, 'LiftedRep]))

Defined in Parsley.Internal.Backend.Machine.InputOps

Methods

shiftLeft :: Code (# Int#, ts #) -> Code Int# -> Code (# Int#, ts #)

offToInt :: Code (# Int#, ts #) -> Code Int

data InputOps (rep :: TYPE r)

This is a psuedo-typeclass, which depends directly on the values obtained from InputDependant. Because this instance must depend on local information, it is synthesised and passed around using ImplicitParams.

Since: 1.0.0.0

Constructors

InputOps

Fields

• _more :: Code (rep -> Bool)

  Does the input have any more characters?

• _next :: Code (rep -> (# Char, rep #))

  Read the next character (without checking existence)

more :: forall r (rep :: TYPE r). (?ops :: InputOps rep) => Code rep -> Code Bool

Wraps around InputOps and _more.

Queries the input to see if another character may be consumed.

Since: 1.4.0.0

next :: forall r (rep :: TYPE r) a. (?ops :: InputOps rep) => Code rep -> (Code Char -> Code rep -> Code a) -> Code a

Wraps around InputOps and _next.

Given some input and a continuation that accepts new input and a character, it will read a character off (without checking that it exists!) and feeds it and the remaining input to the continuation.

Since: 1.0.0.0

type InputDependant (rep :: TYPE r) = (# rep -> (# Char, rep #), rep -> Bool, rep #)

Given some associated representation type, defines the operations that work with a closed over instance of that type. These are:

• next: extract the next character from the input (existence not included)
• more: query whether another character can be read
• init: the initial state of the input.

Since: 1.0.0.0