Game.Chess.PGN

A PGN file consists of a list of games. Each game consists of a tag list, the outcome, and a forest of rosetrees.

Documentation

readPGNFile :: MonadIO m => FilePath -> m (Either String PGN)

gameFromForest :: [(ByteString, Text)] -> Forest Ply -> Outcome -> Game

pgnForest :: PGN -> Forest Ply

newtype PGN

Constructors

PGN [Game]

Instances

Eq PGN

Defined in Game.Chess.PGN

Methods

(==) :: PGN -> PGN -> Bool

(/=) :: PGN -> PGN -> Bool

Semigroup PGN

Defined in Game.Chess.PGN

Methods

(<>) :: PGN -> PGN -> PGN

sconcat :: NonEmpty PGN -> PGN

stimes :: Integral b => b -> PGN -> PGN

Monoid PGN

Defined in Game.Chess.PGN

Methods

mempty :: PGN

mappend :: PGN -> PGN -> PGN

mconcat :: [PGN] -> PGN

type Game = ([(ByteString, Text)], (Outcome, Forest PlyData))

data Outcome

Constructors

Win Color

Draw

Undecided

Instances

Eq Outcome

Defined in Game.Chess.PGN

Methods

(==) :: Outcome -> Outcome -> Bool

(/=) :: Outcome -> Outcome -> Bool

Ord Outcome

Defined in Game.Chess.PGN

Methods

compare :: Outcome -> Outcome -> Ordering

(<) :: Outcome -> Outcome -> Bool

(<=) :: Outcome -> Outcome -> Bool

(>) :: Outcome -> Outcome -> Bool

(>=) :: Outcome -> Outcome -> Bool

max :: Outcome -> Outcome -> Outcome

min :: Outcome -> Outcome -> Outcome

Show Outcome

Defined in Game.Chess.PGN

Methods

showsPrec :: Int -> Outcome -> ShowS

show :: Outcome -> String

showList :: [Outcome] -> ShowS

Pretty Outcome

Defined in Game.Chess.PGN

Methods

pretty :: Outcome -> Doc ann

prettyList :: [Outcome] -> Doc ann

data PlyData

Constructors

PlyData

Fields

• prefixNAG :: ![Int]
• pgnPly :: !Ply
• suffixNAG :: ![Int]

Instances

Eq PlyData

Defined in Game.Chess.PGN

Methods

(==) :: PlyData -> PlyData -> Bool

(/=) :: PlyData -> PlyData -> Bool

Show PlyData

Defined in Game.Chess.PGN

Methods

showsPrec :: Int -> PlyData -> ShowS

show :: PlyData -> String

showList :: [PlyData] -> ShowS

pgn :: Parser PGN

hPutPGN :: Handle -> RAVOrder (Doc ann) -> PGN -> IO ()

pgnDoc :: RAVOrder (Doc ann) -> PGN -> Doc ann

type RAVOrder a = (Forest PlyData -> a) -> Forest PlyData -> [a]

breadthFirst :: RAVOrder a

depthFirst :: RAVOrder a

gameDoc :: RAVOrder (Doc ann) -> Game -> Doc ann

weightedForest :: PGN -> Forest (Rational, Ply)