Data.Gedcom.Internal.ParseMonads

This module contains monads and utility functions for extracting GEDCOM records from the raw syntax tree.

Documentation

type StructureParser a

Arguments

 = GDTree

The subtree to parse.

-> StructureMonad (Either GDTree a)

Either parsed structure, or the subtree itself if the subtree doesn't contain the expected GEDCOM structure.

A parser that extracts a GEDCOM structure from a GEDCOM subtree.

data MultiMonad a

A Monad for parsing GEDCOM structures out of a list of GEDCOM subtrees.

Instances

Monad MultiMonad

Methods

(>>=) :: MultiMonad a -> (a -> MultiMonad b) -> MultiMonad b

(>>) :: MultiMonad a -> MultiMonad b -> MultiMonad b

return :: a -> MultiMonad a

fail :: String -> MultiMonad a

Functor MultiMonad

Methods

fmap :: (a -> b) -> MultiMonad a -> MultiMonad b

(<$) :: a -> MultiMonad b -> MultiMonad a

Applicative MultiMonad

Methods

pure :: a -> MultiMonad a

(<*>) :: MultiMonad (a -> b) -> MultiMonad a -> MultiMonad b

liftA2 :: (a -> b -> c) -> MultiMonad a -> MultiMonad b -> MultiMonad c

(*>) :: MultiMonad a -> MultiMonad b -> MultiMonad b

(<*) :: MultiMonad a -> MultiMonad b -> MultiMonad a

MonadError GDError MultiMonad

Methods

throwError :: GDError -> MultiMonad a

catchError :: MultiMonad a -> (GDError -> MultiMonad a) -> MultiMonad a

runMultiMonad

Arguments

:: [GDTree]

The subtrees to parse the structure from.

-> MultiMonad a

The MultiMonad that does the parsing.

-> StructureMonad a

Run a MultiMonad into a StructureMonad.

parseMulti :: StructureParser a -> MultiMonad [a]

Parse multiple instances of a structure

parseOptional :: StructureParser a -> MultiMonad (Maybe a)

Parse an optional instance of a structure

parseRequired

Arguments

:: GDTag

The tag that identifies the required structure.

-> StructureParser a

-> MultiMonad a

Parse a required instance of a structure

data StructureMonad a

A monad for parsing an instance of a GEDCOM structure from a GEDCOM subtree.

Instances

Monad StructureMonad

Methods

(>>=) :: StructureMonad a -> (a -> StructureMonad b) -> StructureMonad b

(>>) :: StructureMonad a -> StructureMonad b -> StructureMonad b

return :: a -> StructureMonad a

fail :: String -> StructureMonad a

Functor StructureMonad

Methods

fmap :: (a -> b) -> StructureMonad a -> StructureMonad b

(<$) :: a -> StructureMonad b -> StructureMonad a

Applicative StructureMonad

Methods

pure :: a -> StructureMonad a

(<*>) :: StructureMonad (a -> b) -> StructureMonad a -> StructureMonad b

liftA2 :: (a -> b -> c) -> StructureMonad a -> StructureMonad b -> StructureMonad c

(*>) :: StructureMonad a -> StructureMonad b -> StructureMonad b

(<*) :: StructureMonad a -> StructureMonad b -> StructureMonad a

MonadError GDError StructureMonad

Methods

throwError :: GDError -> StructureMonad a

catchError :: StructureMonad a -> (GDError -> StructureMonad a) -> StructureMonad a

addReference

Arguments

:: Typeable a

=> GDXRefID

The cross reference to add.

-> a

The value the reference will resolve to.

-> StructureMonad ()

Add a reference to the cross reference table.

runStructure :: StructureMonad a -> (Either GDError a, Map GDXRefID Dynamic)

Run a StructureMonad, returning either an error or a value, and the cross reference table.