Data.ParserCombinators.KangarooReader

Kangaroo parse monad with env.

Documentation

satisfy :: (Word8 -> Bool) -> GenKangaroo ust Word8

manyTill :: GenKangaroo ust a -> GenKangaroo ust b -> GenKangaroo ust [a]

genericManyTill :: (a -> c -> c) -> c -> GenKangaroo ust a -> GenKangaroo ust b -> GenKangaroo ust c

manyTillPC :: GenKangaroo ust a -> (a -> Bool) -> GenKangaroo ust ([a], a)

genericManyTillPC :: (a -> b -> b) -> b -> GenKangaroo ust a -> (a -> Bool) -> GenKangaroo ust (b, a)

count :: Int -> GenKangaroo ust a -> GenKangaroo ust [a]

countPrefixed :: Integral i => GenKangaroo ust i -> GenKangaroo ust a -> GenKangaroo ust (i, [a])

genericCount :: (a -> b -> b) -> b -> Int -> GenKangaroo ust a -> GenKangaroo ust b

runOn :: GenKangaroo ust a -> GenKangaroo ust [a]

genericRunOn :: (a -> b -> b) -> b -> GenKangaroo ust a -> GenKangaroo ust b

postCheck :: GenKangaroo ust a -> (a -> Bool) -> String -> GenKangaroo ust a

Apply parse then apply the check, if the check fails report the error message.

buildWhile :: (a -> Bool) -> (a -> b -> b) -> (a -> b -> b) -> b -> GenKangaroo ust a -> GenKangaroo ust b

Build a value by while the test holds. When the test fails the position is not backtracked, instead we use the "failing" element with lastOp potentially still building the value with it.

buildPrimitive :: Int -> (Word8 -> Bool) -> (Word8 -> b -> b) -> b -> GenKangaroo ust b

data GenKangaroo ust a

Instances

Monad (GenKangaroo ust)

Functor (GenKangaroo ust)

Applicative (GenKangaroo ust)

type ParseErr = String

data RegionCoda

RegionCoda - represents three useful final positions:

1. dalpunto - 'from the point' - Run the parser within a region and return to where you came from.
2. alfermata - 'to the stop' - Run the parser within a region, the cursor remains wherever the parse finished.
3. alfine - 'to the end' - Run the parser within a region and jump to the right-end of the region after the parse.

Constructors

Dalpunto

Alfermata

Alfine

Instances

Enum RegionCoda

Eq RegionCoda

Show RegionCoda

type RegionName = String

getUserSt :: GenKangaroo ust ust

putUserSt :: ust -> GenKangaroo ust ()

modifyUserSt :: (ust -> ust) -> GenKangaroo ust ()

throwErr :: ParseErr -> GenKangaroo ust a

liftIOAction :: IO a -> GenKangaroo ust a

withSuccess :: Bool -> ParseErr -> GenKangaroo ust a -> GenKangaroo ust a

runGenKangaroo :: GenKangaroo ust a -> ust -> FilePath -> IO (Either ParseErr a, ust)

reportError :: ParseErr -> GenKangaroo ust a

substError :: GenKangaroo ust a -> ParseErr -> GenKangaroo ust a

Primitive parsers

word8 :: GenKangaroo ust Word8

checkWord8 :: (Word8 -> Bool) -> GenKangaroo ust (Maybe Word8)

opt :: GenKangaroo ust a -> GenKangaroo ust (Maybe a)

Query the cursor position

position :: GenKangaroo ust Int

position : -> cursor-position

Return the current cursor position

region :: GenKangaroo ust (Int, Int, Int)

region : -> (region-start, cursor-position, region-end)

Return the current parse region and the current position of the cursor within it.

atEnd :: GenKangaroo ust Bool

atEnd - is the cursor at the end of the current region?

lengthRemaining :: GenKangaroo ust Int

lengthRemaining : -> distance-to-region-end

Distance from the current cursor position to the end of the current region

regionSize :: GenKangaroo ust Int

regionSize : -> region-length

Size of the current region.

Parse within a region

intraparse :: RegionName -> RegionCoda -> RegionStart -> Int -> GenKangaroo ust a -> GenKangaroo ust a

intraparse : name * coda * abs_region_start * region_length * parser -> parser

Create a new region within the current one and run the supplied parser. The cursor position is moved to the start of the new region. The value of coda determines where the cursor is positioned after a successful parse.

intraparse throws a parse error if the supplied absolute-region-start is not located within the current region, or if the right-boundary of the new region (abs_region_start + region_length) extends beyond the right-boundary of the current region.

advance :: RegionName -> RegionCoda -> Int -> GenKangaroo ust a -> GenKangaroo ust a

advance : name * coda * abs_region_start * parser -> parser

A variation of intraparse - the new region starts at the supplied abs_region_start and continues to the end of the current region.

advance throws a parse error if the new start position is not within the current region.

advanceRelative :: RegionName -> RegionCoda -> Int -> GenKangaroo ust a -> GenKangaroo ust a

advanceRelative : name * coda * distance * parser -> parser

A variation of advance - the start of the new region is calculated from the current-cursor-position + the supplied distance.

advanceRelative throws a parse error if the new start position is not within the current region.

restrict :: RegionName -> RegionCoda -> Int -> GenKangaroo ust a -> GenKangaroo ust a

restrict : name * coda * distance * parser -> parser

A variation of intraparse - create a new region as a restriction of the current one and run the supplied parser. The new region starts at the current coursor position, the right-boundary is restricted to the current-cursor-position + the supplied distance.

restrict throws a parse error if the right-boundary of the new region extends beyond the current region.

restrictToPos :: RegionName -> RegionCoda -> Int -> GenKangaroo ust a -> GenKangaroo ust a

restrictToPos : region-name * coda * abs-end-pos * parser -> parser

A variantion of restrict - the new region takes the current cursor position for the left-boundary and the supplied absolute-end-position (abs-end-pos) as the right-boundary.

restrictToPos throws a parse error if the abs-end-pos extends beyond the right-boundary of the current region.

Debug

printHexAll :: GenKangaroo ust ()

printRegionStack :: GenKangaroo ust ()

cstring :: GenKangaroo ust String

Read a null-terminated string

w8Zero :: GenKangaroo ust Word8

getBytes :: Integral a => a -> GenKangaroo ust [Word8]

char :: GenKangaroo ust Char

text :: Int -> GenKangaroo ust String

int8 :: GenKangaroo ust Int8

word16be :: GenKangaroo ust Word16

word32be :: GenKangaroo ust Word32

word64be :: GenKangaroo ust Word64

word16le :: GenKangaroo ust Word16

word32le :: GenKangaroo ust Word32

int16be :: GenKangaroo ust Int16

int32be :: GenKangaroo ust Int32

int16le :: GenKangaroo ust Int16

int32le :: GenKangaroo ust Int32

ieeeFloatSP :: Fractional a => GenKangaroo ust a

type Kangaroo e a = GenKangaroo e a

parse :: Kangaroo e a -> e -> FilePath -> IO (Either ParseErr a)

runKangaroo :: Kangaroo e a -> e -> FilePath -> IO (Either ParseErr a)

ask :: Kangaroo e e