Copyright	(c) Callum Lowcay 2017
License	BSD3
Maintainer	cwslowcay@gmail.com
Stability	experimental
Portability	GHC
Safe Haskell	None
Language	Haskell2010

Data.Gedcom.Internal.CoreTypes

Description

Synopsis

Documentation

data GDRefError Source #

An error arising from dereferencing a GDRef

Constructors

RefNotPresent GDXRefID	The referred structure doesn't exist.
WrongRefType TypeRep TypeRep	Dereferenced structure had the wrong type

Instances

Show GDRefError Source #
Methods showsPrec :: Int -> GDRefError -> ShowS # show :: GDRefError -> String # showList :: [GDRefError] -> ShowS #

data GDError Source #

A parse error.

Constructors

LineFormatError Text	A badly formatted GEDCOM line
UnexpectedRef Text	A reference where a reference wasn't allowed
RequiredRef Text	Missing a reference where a reference was required
DuplicateRef Text	Two targets for the same reference
FormatError Text	A badly formatted field
TagError Text	The wrong tag

Instances

Show GDError Source #
Methods showsPrec :: Int -> GDError -> ShowS # show :: GDError -> String # showList :: [GDError] -> ShowS #
MonadError GDError StructureMonad #
Methods throwError :: GDError -> StructureMonad a # catchError :: StructureMonad a -> (GDError -> StructureMonad a) -> StructureMonad a #
MonadError GDError MultiMonad #
Methods throwError :: GDError -> MultiMonad a # catchError :: MultiMonad a -> (GDError -> MultiMonad a) -> MultiMonad a #

data GDRef a Source #

A reference to another structure

Constructors

GDStructure a	Already dereferenced.
GDXRef GDXRefID	The `GDXRefID` to look up

Instances

Eq a => Eq (GDRef a) Source #
Methods (==) :: GDRef a -> GDRef a -> Bool # (/=) :: GDRef a -> GDRef a -> Bool #
Show a => Show (GDRef a) Source #
Methods showsPrec :: Int -> GDRef a -> ShowS # show :: GDRef a -> String # showList :: [GDRef a] -> ShowS #

data GDRoot Source #

A raw GEDCOM syntax tree

Constructors

GDRoot [GDTree]

Instances

Eq GDRoot Source #
Methods (==) :: GDRoot -> GDRoot -> Bool # (/=) :: GDRoot -> GDRoot -> Bool #
Show GDRoot Source #
Methods showsPrec :: Int -> GDRoot -> ShowS # show :: GDRoot -> String # showList :: [GDRoot] -> ShowS #

data GDTree Source #

A GEDCOM subtree

Constructors

GDTree GDLine [GDTree]

Instances

Eq GDTree Source #
Methods (==) :: GDTree -> GDTree -> Bool # (/=) :: GDTree -> GDTree -> Bool #
Show GDTree Source #
Methods showsPrec :: Int -> GDTree -> ShowS # show :: GDTree -> String # showList :: [GDTree] -> ShowS #

data GDLine Source #

A GEDCOM line

Constructors

GDLine GDLevel (Maybe GDXRefID) GDTag (Maybe GDLineValue)

Instances

Eq GDLine Source #
Methods (==) :: GDLine -> GDLine -> Bool # (/=) :: GDLine -> GDLine -> Bool #
Show GDLine Source #
Methods showsPrec :: Int -> GDLine -> ShowS # show :: GDLine -> String # showList :: [GDLine] -> ShowS #

data GDLineValue Source #

The value field

Constructors

GDLineItemV GDLineItem
GDXRefIDV GDXRefID

Instances

Eq GDLineValue Source #
Methods (==) :: GDLineValue -> GDLineValue -> Bool # (/=) :: GDLineValue -> GDLineValue -> Bool #
Show GDLineValue Source #
Methods showsPrec :: Int -> GDLineValue -> ShowS # show :: GDLineValue -> String # showList :: [GDLineValue] -> ShowS #

newtype GDLineItem Source #

Line text

Constructors

GDLineItem [(Maybe GDEscape, Text)]

Instances

Eq GDLineItem Source #
Methods (==) :: GDLineItem -> GDLineItem -> Bool # (/=) :: GDLineItem -> GDLineItem -> Bool #
Show GDLineItem Source #
Methods showsPrec :: Int -> GDLineItem -> ShowS # show :: GDLineItem -> String # showList :: [GDLineItem] -> ShowS #
Monoid GDLineItem Source #
Methods mempty :: GDLineItem # mappend :: GDLineItem -> GDLineItem -> GDLineItem # mconcat :: [GDLineItem] -> GDLineItem #

newtype GDEscape Source #

An escape sequence

Constructors

GDEscape Text

Instances

Eq GDEscape Source #
Methods (==) :: GDEscape -> GDEscape -> Bool # (/=) :: GDEscape -> GDEscape -> Bool #
Show GDEscape Source #
Methods showsPrec :: Int -> GDEscape -> ShowS # show :: GDEscape -> String # showList :: [GDEscape] -> ShowS #

newtype GDXRefID Source #

A cross reference ID

Constructors

GDXRefID Text

Instances

Eq GDXRefID Source #
Methods (==) :: GDXRefID -> GDXRefID -> Bool # (/=) :: GDXRefID -> GDXRefID -> Bool #
Ord GDXRefID Source #
Methods compare :: GDXRefID -> GDXRefID -> Ordering # (<) :: GDXRefID -> GDXRefID -> Bool # (<=) :: GDXRefID -> GDXRefID -> Bool # (>) :: GDXRefID -> GDXRefID -> Bool # (>=) :: GDXRefID -> GDXRefID -> Bool # max :: GDXRefID -> GDXRefID -> GDXRefID # min :: GDXRefID -> GDXRefID -> GDXRefID #
Show GDXRefID Source #
Methods showsPrec :: Int -> GDXRefID -> ShowS # show :: GDXRefID -> String # showList :: [GDXRefID] -> ShowS #

newtype GDTag Source #

The tag field

Constructors

GDTag Text

Instances

Eq GDTag Source #
Methods (==) :: GDTag -> GDTag -> Bool # (/=) :: GDTag -> GDTag -> Bool #
Ord GDTag Source #
Methods compare :: GDTag -> GDTag -> Ordering # (<) :: GDTag -> GDTag -> Bool # (<=) :: GDTag -> GDTag -> Bool # (>) :: GDTag -> GDTag -> Bool # (>=) :: GDTag -> GDTag -> Bool # max :: GDTag -> GDTag -> GDTag # min :: GDTag -> GDTag -> GDTag #
Show GDTag Source #
Methods showsPrec :: Int -> GDTag -> ShowS # show :: GDTag -> String # showList :: [GDTag] -> ShowS #

newtype GDLevel Source #

The level field

Constructors

GDLevel Int

Instances

Eq GDLevel Source #
Methods (==) :: GDLevel -> GDLevel -> Bool # (/=) :: GDLevel -> GDLevel -> Bool #
Num GDLevel Source #
Methods (+) :: GDLevel -> GDLevel -> GDLevel # (-) :: GDLevel -> GDLevel -> GDLevel # (*) :: GDLevel -> GDLevel -> GDLevel # negate :: GDLevel -> GDLevel # abs :: GDLevel -> GDLevel # signum :: GDLevel -> GDLevel # fromInteger :: Integer -> GDLevel #
Ord GDLevel Source #
Methods compare :: GDLevel -> GDLevel -> Ordering # (<) :: GDLevel -> GDLevel -> Bool # (<=) :: GDLevel -> GDLevel -> Bool # (>) :: GDLevel -> GDLevel -> Bool # (>=) :: GDLevel -> GDLevel -> Bool # max :: GDLevel -> GDLevel -> GDLevel # min :: GDLevel -> GDLevel -> GDLevel #
Show GDLevel Source #
Methods showsPrec :: Int -> GDLevel -> ShowS # show :: GDLevel -> String # showList :: [GDLevel] -> ShowS #

gdLineData :: GDLineItem -> [(Maybe GDEscape, Text)] Source #

Extract the line text

gdTrimLineItem :: GDLineItem -> GDLineItem Source #

Trim white space off the start an end of a GEDCOM line text.

gdIgnoreEscapes :: [(Maybe GDEscape, Text)] -> Text Source #

Ignore escape sequences

gdFilterEscapes :: [GDEscape] -> [(Maybe GDEscape, Text)] -> [(Maybe GDEscape, Text)] Source #

Ignore certain escape sequences