Codec.Phaser

Documentation

data Phase p i o a

A type for building Automaton values. Monad and Applicative instances are defined for this type rather than for Automaton in order to avoid traversing the entire call stack for every input value.

Instances

PhaserType Phase

Methods

toAutomaton :: Monoid p => Phase p i o a -> Automaton p i o a

fromAutomaton :: Monoid p => Automaton p i o a -> Phase p i o a

toPhase :: Monoid p => Phase p i o a -> Phase p i o a

fromPhase :: Monoid p => Phase p i o a -> Phase p i o a

($#$) :: Monoid p => Phase p b c x -> (c -> t) -> Phase p b t x

Monad (Phase p i o)

Methods

(>>=) :: Phase p i o a -> (a -> Phase p i o b) -> Phase p i o b

(>>) :: Phase p i o a -> Phase p i o b -> Phase p i o b

return :: a -> Phase p i o a

fail :: String -> Phase p i o a

Functor (Phase p i o)

Methods

fmap :: (a -> b) -> Phase p i o a -> Phase p i o b

(<$) :: a -> Phase p i o b -> Phase p i o a

Applicative (Phase p i o)

Methods

pure :: a -> Phase p i o a

(<*>) :: Phase p i o (a -> b) -> Phase p i o a -> Phase p i o b

(*>) :: Phase p i o a -> Phase p i o b -> Phase p i o b

(<*) :: Phase p i o a -> Phase p i o b -> Phase p i o a

Monoid p => Alternative (Phase p i o)

Methods

empty :: Phase p i o a

(<|>) :: Phase p i o a -> Phase p i o a -> Phase p i o a

some :: Phase p i o a -> Phase p i o [a]

many :: Phase p i o a -> Phase p i o [a]

Monoid p => MonadPlus (Phase p i o)

Methods

mzero :: Phase p i o a

mplus :: Phase p i o a -> Phase p i o a -> Phase p i o a

data Automaton p i o a

Represents a nondeterministic computation in progress. There are 4 type parameters: a counter type (may be used for tracking line and column numbers), an input type, an incremental output type, and a final output type.

Instances

PhaserType Automaton

Methods

toAutomaton :: Monoid p => Automaton p i o a -> Automaton p i o a

fromAutomaton :: Monoid p => Automaton p i o a -> Automaton p i o a

toPhase :: Monoid p => Automaton p i o a -> Phase p i o a

fromPhase :: Monoid p => Phase p i o a -> Automaton p i o a

($#$) :: Monoid p => Automaton p b c x -> (c -> t) -> Automaton p b t x

Functor (Automaton p i o)

Methods

fmap :: (a -> b) -> Automaton p i o a -> Automaton p i o b

(<$) :: a -> Automaton p i o b -> Automaton p i o a

data Position

A data type for describing a position in a text file. Constructor arguments are row number and column number.

Constructors

Position !Int !Int

Instances

Eq Position

Methods

(==) :: Position -> Position -> Bool

(/=) :: Position -> Position -> Bool

Ord Position

Methods

compare :: Position -> Position -> Ordering

(<) :: Position -> Position -> Bool

(<=) :: Position -> Position -> Bool

(>) :: Position -> Position -> Bool

(>=) :: Position -> Position -> Bool

max :: Position -> Position -> Position

min :: Position -> Position -> Position

Read Position

Methods

readsPrec :: Int -> ReadS Position

readList :: ReadS [Position]

readPrec :: ReadPrec Position

readListPrec :: ReadPrec [Position]

Show Position

Methods

showsPrec :: Int -> Position -> ShowS

show :: Position -> String

showList :: [Position] -> ShowS

Monoid Position

Methods

mempty :: Position

mappend :: Position -> Position -> Position

mconcat :: [Position] -> Position

(>>#) :: (Monoid p, PhaserType s, PhaserType d) => s p b c x -> d p c t a -> Automaton p b t a infixr 4

Take the incremental output of the first argument and use it as input for the second argument. Discard the final output of the first argument.

(>#>) :: (PhaserType s, Monoid p0, Monoid p) => (p0 -> p) -> s p0 i o a -> s p i o a infixr 1

Change the counter type of a Phaser object.

(<?>) :: [Char] -> Phase p i o a -> Phase p i o a infixr 1

If parsing fails in the right argument: prepend the left argument to the errors

($#$) :: (PhaserType s, Monoid p) => s p b c x -> (c -> t) -> s p b t x

parse :: PhaserType s => s Position i o a -> [i] -> Either [(Position, [String])] [a]

Use a Phase as a parser. Note that unlike other parsers the reported position in the input when the parser fails is the position reached when all parsing options are exhausted, not the beginning of the failing token. Since the characters may be counted nondeterministically: if multiple errors are returned the reported error position may be different for each error report.

parse_ :: (Monoid p, PhaserType s) => p -> s p i o a -> [i] -> Either [(p, [String])] [a]

Use a Phase value similarly to a parser.

get :: Phase p i o i

Return one item of the input.

count :: p -> Phase p i o ()

Modify the counter

yield :: o -> Phase p i o ()

Yield one item for the incremental output

put1 :: Monoid p => i -> Phase p i o ()

Insert one value back into the input. May be used for implementing lookahead

put :: Monoid p => [i] -> Phase p i o ()

Put a list of values back into the input.

run :: Monoid p => Automaton p i o a -> [i] -> Automaton p i o a

Pass a list of input values to an Automaton

step :: Monoid p => Automaton p i o a -> i -> Automaton p i o a

Pass one input to an automaton

extract :: Monoid p => p -> Automaton p i o a -> Either [(p, [String])] [a]

Take either counters with errors or a list of possible results from an automaton.

satisfy :: Monoid p => (i -> Bool) -> Phase p i o i

Consume one input, return it if it matches the predicate, otherwise fail.

match :: (Eq i, Monoid p) => i -> Phase p i o i

Consume one input, if it's equal to the parameter then return it, otherwise fail.

char :: Monoid p => Char -> Phase p Char o Char

match specialized to Char

iChar :: Monoid p => Char -> Phase p Char o Char

Case insensitive version of char

string :: (Eq i, Monoid p) => [i] -> Phase p i o [i]

Match a list of input values

iString :: Monoid p => String -> Phase p Char o String

Match a string (case insensitive)

integer :: (Num a, Monoid p) => Phase p Char o a

Parse a number either from decimal digits or from hexadecimal prefixed with "0x"

decimal :: (Fractional a, Monoid p) => Phase p Char o a

Parse a number from decimal digits, "-", and "."

scientificNotation :: (Fractional a, Monoid p) => Phase p Char o a

Parse a number from standard decimal format or from scientific notation.

sepBy :: Monoid p => Phase p i o a -> Phase p i o s -> Phase p i o [a]

sepBy p sep parses zero or more occurrences of p, separated by sep. Returns a list of values returned by p.

munch :: Monoid p => (i -> Bool) -> Phase p i o [i]

Parses the first zero or more values satisfying the predicate. Always succeds, exactly once, having consumed all the characters Hence NOT the same as (many (satisfy p))

munch1 :: Monoid p => (i -> Bool) -> Phase p i o [i]

Parses the first one or more values satisfying the predicate. Succeeds if at least one value matches, having consumed all the characters Hence NOT the same as (some (satisfy p))

trackPosition :: Phase Position Char Char ()

Count the lines and characters from the input before yielding them again. If the phase pipeline does not include this or similar: parsing errors will not report the correct position. Unix, Windows, Mac-OS Classic, and Acorn newline formats are all recognized.