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

newtype PGN

Constructors

PGN [Game]

Instances

Monoid PGN

Defined in Game.Chess.PGN

Methods

mempty :: PGN

mappend :: PGN -> PGN -> PGN

mconcat :: [PGN] -> PGN

Semigroup PGN

Defined in Game.Chess.PGN

Methods

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

sconcat :: NonEmpty PGN -> PGN

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

Eq PGN

Defined in Game.Chess.PGN

Methods

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

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

Wrapped PGN

Defined in Game.Chess.PGN

Associated Types

type Unwrapped PGN

Methods

_Wrapped' :: Iso' PGN (Unwrapped PGN)

PGN ~ t => Rewrapped PGN t

Defined in Game.Chess.PGN

type Unwrapped PGN

Defined in Game.Chess.PGN

type Unwrapped PGN = [Game]

data Game

Constructors

CG

Fields

• _cgTags :: ![(Text, Text)]
• _cgForest :: ![Tree (Annotated Ply)]
• _cgOutcome :: !Outcome

Instances

Generic Game

Defined in Game.Chess.PGN

Associated Types

type Rep Game :: Type -> Type

Methods

from :: Game -> Rep Game x

to :: Rep Game x -> Game

Show Game

Defined in Game.Chess.PGN

Methods

showsPrec :: Int -> Game -> ShowS

show :: Game -> String

showList :: [Game] -> ShowS

Eq Game

Defined in Game.Chess.PGN

Methods

(==) :: Game -> Game -> Bool

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

Hashable Game

Defined in Game.Chess.PGN

Methods

hashWithSalt :: Int -> Game -> Int

hash :: Game -> Int

type Rep Game

Defined in Game.Chess.PGN

type Rep Game = D1 ('MetaData "Game" "Game.Chess.PGN" "chessIO-0.9.3.1-FhorHdlbYNXK07vrmB8ltu" 'False) (C1 ('MetaCons "CG" 'PrefixI 'True) (S1 ('MetaSel ('Just "_cgTags") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [(Text, Text)]) :*: (S1 ('MetaSel ('Just "_cgForest") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Tree (Annotated Ply)]) :*: S1 ('MetaSel ('Just "_cgOutcome") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Outcome))))

cgTags :: Lens' Game [(Text, Text)]

cgOutcome :: Lens' Game Outcome

cgForest :: Lens' Game [Tree (Annotated Ply)]

data Outcome

Constructors

Win Color

Draw

Undecided

Instances

Generic Outcome

Defined in Game.Chess.PGN

Associated Types

type Rep Outcome :: Type -> Type

Methods

from :: Outcome -> Rep Outcome x

to :: Rep Outcome x -> Outcome

Show Outcome

Defined in Game.Chess.PGN

Methods

showsPrec :: Int -> Outcome -> ShowS

show :: Outcome -> String

showList :: [Outcome] -> ShowS

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

Hashable Outcome

Defined in Game.Chess.PGN

Methods

hashWithSalt :: Int -> Outcome -> Int

hash :: Outcome -> Int

Pretty Outcome

Defined in Game.Chess.PGN

Methods

pretty :: Outcome -> Doc ann

prettyList :: [Outcome] -> Doc ann

Lift Outcome

Defined in Game.Chess.PGN

Methods

lift :: Quote m => Outcome -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => Outcome -> Code m Outcome

type Rep Outcome

Defined in Game.Chess.PGN

type Rep Outcome = D1 ('MetaData "Outcome" "Game.Chess.PGN" "chessIO-0.9.3.1-FhorHdlbYNXK07vrmB8ltu" 'False) (C1 ('MetaCons "Win" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Color)) :+: (C1 ('MetaCons "Draw" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Undecided" 'PrefixI 'False) (U1 :: Type -> Type)))

_Win :: Prism' Outcome Color

_Draw :: Prism' Outcome ()

_Undecided :: Prism' Outcome ()

data Annotated a

Constructors

Ann

Fields

• _annPrefixNAG :: ![Int]
• _annPly :: !a
• _annSuffixNAG :: ![Int]

Instances

Applicative Annotated

Defined in Game.Chess.PGN

Methods

pure :: a -> Annotated a

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

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

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

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

Functor Annotated

Defined in Game.Chess.PGN

Methods

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

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

Generic (Annotated a)

Defined in Game.Chess.PGN

Associated Types

type Rep (Annotated a) :: Type -> Type

Methods

from :: Annotated a -> Rep (Annotated a) x

to :: Rep (Annotated a) x -> Annotated a

Show a => Show (Annotated a)

Defined in Game.Chess.PGN

Methods

showsPrec :: Int -> Annotated a -> ShowS

show :: Annotated a -> String

showList :: [Annotated a] -> ShowS

Eq a => Eq (Annotated a)

Defined in Game.Chess.PGN

Methods

(==) :: Annotated a -> Annotated a -> Bool

(/=) :: Annotated a -> Annotated a -> Bool

Hashable a => Hashable (Annotated a)

Defined in Game.Chess.PGN

Methods

hashWithSalt :: Int -> Annotated a -> Int

hash :: Annotated a -> Int

Lift a => Lift (Annotated a :: Type)

Defined in Game.Chess.PGN

Methods

lift :: Quote m => Annotated a -> m Exp

liftTyped :: forall (m :: Type -> Type). Quote m => Annotated a -> Code m (Annotated a)

type Rep (Annotated a)

Defined in Game.Chess.PGN

type Rep (Annotated a) = D1 ('MetaData "Annotated" "Game.Chess.PGN" "chessIO-0.9.3.1-FhorHdlbYNXK07vrmB8ltu" 'False) (C1 ('MetaCons "Ann" 'PrefixI 'True) (S1 ('MetaSel ('Just "_annPrefixNAG") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Int]) :*: (S1 ('MetaSel ('Just "_annPly") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 a) :*: S1 ('MetaSel ('Just "_annSuffixNAG") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 [Int]))))

annPrefixNAG :: forall a. Lens' (Annotated a) [Int]

annPly :: forall a a. Lens (Annotated a) (Annotated a) a a

annSuffixNAG :: forall a. Lens' (Annotated a) [Int]

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

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

pgnForest :: PGN -> [Tree Ply]

A PGN parser

pgn :: Parser PGN

Prettyprinting

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

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

type RAVOrder a = ([Tree (Annotated Ply)] -> a) -> [Tree (Annotated Ply)] -> [a]

breadthFirst :: RAVOrder a

depthFirst :: RAVOrder a

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

weightedForest :: PGN -> [Tree (Rational, Ply)]