Safe Haskell	Safe
Language	Haskell2010

Text.Boomerang.Prim

Contents

Types
Running routers
Constructing / Manipulating Boomerangs

Synopsis

newtype Parser e tok a = Parser {
- runParser :: tok -> Pos e -> [Either e ((a, tok), Pos e)]
}
data Boomerang e tok a b = Boomerang {
- prs :: Parser e tok (a -> b)
- ser :: b -> [(tok -> tok, a)]
}
type PrinterParser = Boomerang
(.~) :: Boomerang e tok a b -> Boomerang e tok b c -> Boomerang e tok a c
parse :: forall e a p tok. InitialPosition e => Boomerang e tok () a -> tok -> [Either e (a, tok)]
parse1 :: (ErrorPosition e, InitialPosition e, Show e, Ord (Pos e)) => (tok -> Bool) -> Boomerang e tok () (a :- ()) -> tok -> Either [e] a
unparse :: tok -> Boomerang e tok () url -> url -> [tok]
unparse1 :: tok -> Boomerang e tok () (a :- ()) -> a -> Maybe tok
bestErrors :: (ErrorPosition e, Ord (Pos e)) => [e] -> [e]
xpure :: (a -> b) -> (b -> Maybe a) -> Boomerang e tok a b
val :: forall e tok a r. Parser e tok a -> (a -> [tok -> tok]) -> Boomerang e tok r (a :- r)
xmap :: (a -> b) -> (b -> Maybe a) -> Boomerang e tok r a -> Boomerang e tok r b
xmaph :: (a -> b) -> (b -> Maybe a) -> Boomerang e tok i (a :- o) -> Boomerang e tok i (b :- o)

Types

newtype Parser e tok a Source #

Yet another parser.

Returns all possible parses and parse errors

Constructors

Parser
Fields runParser :: tok -> Pos e -> [Either e ((a, tok), Pos e)]

Instances

Monad (Parser e tok) Source #
Instance details Defined in Text.Boomerang.Prim Methods (>>=) :: Parser e tok a -> (a -> Parser e tok b) -> Parser e tok b # (>>) :: Parser e tok a -> Parser e tok b -> Parser e tok b # return :: a -> Parser e tok a # fail :: String -> Parser e tok a #
Functor (Parser e tok) Source #
Instance details Defined in Text.Boomerang.Prim Methods fmap :: (a -> b) -> Parser e tok a -> Parser e tok b # (<$) :: a -> Parser e tok b -> Parser e tok a #
Applicative (Parser e tok) Source #
Instance details Defined in Text.Boomerang.Prim Methods pure :: a -> Parser e tok a # (<>) :: Parser e tok (a -> b) -> Parser e tok a -> Parser e tok b # liftA2 :: (a -> b -> c) -> Parser e tok a -> Parser e tok b -> Parser e tok c # (>) :: Parser e tok a -> Parser e tok b -> Parser e tok b # (<*) :: Parser e tok a -> Parser e tok b -> Parser e tok a #
Alternative (Parser e tok) Source #
Instance details Defined in Text.Boomerang.Prim Methods empty :: Parser e tok a # (<\|>) :: Parser e tok a -> Parser e tok a -> Parser e tok a # some :: Parser e tok a -> Parser e tok [a] # many :: Parser e tok a -> Parser e tok [a] #
MonadPlus (Parser e tok) Source #
Instance details Defined in Text.Boomerang.Prim Methods mzero :: Parser e tok a # mplus :: Parser e tok a -> Parser e tok a -> Parser e tok a #

data Boomerang e tok a b Source #

A Boomerang a b takes an a to parse a URL and results in b if parsing succeeds. And it takes a b to serialize to a URL and results in a if serializing succeeds.

Constructors

Boomerang
Fields prs :: Parser e tok (a -> b) ser :: b -> [(tok -> tok, a)]

Instances

Category (Boomerang e tok :: Type -> Type -> Type) Source #
Instance details Defined in Text.Boomerang.Prim Methods id :: Boomerang e tok a a # (.) :: Boomerang e tok b c -> Boomerang e tok a b -> Boomerang e tok a c #
a ~ b => IsString (Boomerang StringsError [String] a b) Source #
Instance details Defined in Text.Boomerang.Strings Methods fromString :: String -> Boomerang StringsError [String] a b #
a ~ b => IsString (Boomerang StringError String a b) Source #
Instance details Defined in Text.Boomerang.String Methods fromString :: String -> Boomerang StringError String a b #
a ~ b => IsString (Boomerang TextsError [Text] a b) Source #
Instance details Defined in Text.Boomerang.Texts Methods fromString :: String -> Boomerang TextsError [Text] a b #
Semigroup (Boomerang e tok a b) Source #
Instance details Defined in Text.Boomerang.Prim Methods (<>) :: Boomerang e tok a b -> Boomerang e tok a b -> Boomerang e tok a b # sconcat :: NonEmpty (Boomerang e tok a b) -> Boomerang e tok a b # stimes :: Integral b0 => b0 -> Boomerang e tok a b -> Boomerang e tok a b #
Monoid (Boomerang e tok a b) Source #
Instance details Defined in Text.Boomerang.Prim Methods mempty :: Boomerang e tok a b # mappend :: Boomerang e tok a b -> Boomerang e tok a b -> Boomerang e tok a b # mconcat :: [Boomerang e tok a b] -> Boomerang e tok a b #

type PrinterParser = Boomerang Source #

Deprecated: Use Boomerang instead

(.~) :: Boomerang e tok a b -> Boomerang e tok b c -> Boomerang e tok a c infixr 9 Source #

Reverse composition, but with the side effects still in left-to-right order.

Running routers

parse :: forall e a p tok. InitialPosition e => Boomerang e tok () a -> tok -> [Either e (a, tok)] Source #

Give all possible parses or errors.

parse1 :: (ErrorPosition e, InitialPosition e, Show e, Ord (Pos e)) => (tok -> Bool) -> Boomerang e tok () (a :- ()) -> tok -> Either [e] a Source #

Give the first parse, for Boomerangs with a parser that yields just one value. Otherwise return the error (or errors) with the highest error position.

unparse :: tok -> Boomerang e tok () url -> url -> [tok] Source #

Give all possible serializations.

unparse1 :: tok -> Boomerang e tok () (a :- ()) -> a -> Maybe tok Source #

Give the first serialization, for Boomerangs with a serializer that needs just one value.

bestErrors :: (ErrorPosition e, Ord (Pos e)) => [e] -> [e] Source #

Attempt to extract the most relevant errors from a list of parse errors.

The current heuristic is to find error (or errors) where the error position is highest.

Constructing / Manipulating Boomerangs

xpure :: (a -> b) -> (b -> Maybe a) -> Boomerang e tok a b Source #

Lift a constructor-destructor pair to a pure router.

val :: forall e tok a r. Parser e tok a -> (a -> [tok -> tok]) -> Boomerang e tok r (a :- r) Source #

lift a Parser and a printer into a Boomerang

xmap :: (a -> b) -> (b -> Maybe a) -> Boomerang e tok r a -> Boomerang e tok r b Source #

Map over routers.

xmaph :: (a -> b) -> (b -> Maybe a) -> Boomerang e tok i (a :- o) -> Boomerang e tok i (b :- o) Source #

Like "xmap", but only maps over the top of the stack.