Text.Boomerang.String

a Boomerang library for working with a String

Types

type StringBoomerang = Boomerang StringError String

type StringPrinterParser = StringBoomerang

Deprecated: Use StringBoomerang instead

type StringError = ParserError MajorMinorPos

Combinators

alpha :: StringBoomerang r (Char :- r)

matches alphabetic Unicode characters (lower-case, upper-case and title-case letters, plus letters of caseless scripts and modifiers letters). (Uses isAlpha)

anyChar :: StringBoomerang r (Char :- r)

any character

char :: Char -> StringBoomerang r (Char :- r)

matches the specified character

digit :: StringBoomerang r (Char :- r)

ascii digits '0'..'9'

int :: StringBoomerang r (Int :- r)

matches an Int

integer :: StringBoomerang r (Integer :- r)

matches an Integer

lit :: String -> StringBoomerang r r

a constant string

satisfy :: (Char -> Bool) -> StringBoomerang r (Char :- r)

statisfy a Char predicate

space :: StringBoomerang r (Char :- r)

matches white-space characters in the Latin-1 range. (Uses isSpace)

Running the Boomerang

isComplete :: String -> Bool

Predicate to test if we have parsed all the strings. Typically used as argument to parse1

see also: parseStrings

parseString :: StringBoomerang () (r :- ()) -> String -> Either StringError r

run the parser

Returns the first complete parse or a parse error.

parseString (rUnit . lit "foo") ["foo"]

unparseString :: StringBoomerang () (r :- ()) -> r -> Maybe String

run the printer

unparseString (rUnit . lit "foo") ()

Orphan instances

InitialPosition StringError

Methods

initialPos :: Maybe StringError -> Pos StringError

(~) * a b => IsString (Boomerang StringError String a b)

Methods

fromString :: String -> Boomerang StringError String a b