Copyright	(c) Mario Lang 2021
License	BSD3
Maintainer	mlang@blind.guru
Stability	experimental
Safe Haskell	Safe-Inferred
Language	Haskell2010

Game.Chess.ECO

Contents

Data types
Query
Conversion
Parsing eco.pgn files
Parsing scid .eco files
Template Haskell

Description

Types and functions to name chess positions according to the opening used.

Two commonly used file formats for opening classification are supported.

Synopsis

data ECO
data Opening = CO {
- coCode :: !Text
- coName :: !Text
- coVariation :: !(Maybe Text)
- coPlies :: !(Vector Ply)
}
defaultECO :: ECO
lookup :: Position -> ECO -> Maybe Opening
fromList :: [Opening] -> ECO
toList :: ECO -> [Opening]
fromPGN :: PGN -> ECO
readECOPGNFile :: MonadIO m => FilePath -> m (Either String ECO)
readSCIDECOFile :: MonadIO m => FilePath -> m (Either String ECO)
scid :: Parser ECO
embedECO :: FileReader -> FilePath -> SpliceQ ECO
ecoPgn :: FileReader
scidEco :: FileReader

Data types

data ECO Source #

Encyclopedia of Chess Openings

Instances

Instances details

Monoid ECO Source #
Instance details Defined in Game.Chess.Internal.ECO Methods mempty :: ECO # mappend :: ECO -> ECO -> ECO # mconcat :: [ECO] -> ECO #
Semigroup ECO Source #
Instance details Defined in Game.Chess.Internal.ECO Methods (<>) :: ECO -> ECO -> ECO # sconcat :: NonEmpty ECO -> ECO # stimes :: Integral b => b -> ECO -> ECO #
Binary ECO Source #
Instance details Defined in Game.Chess.Internal.ECO Methods put :: ECO -> Put # get :: Get ECO # putList :: [ECO] -> Put #
NFData ECO Source #
Instance details Defined in Game.Chess.Internal.ECO Methods rnf :: ECO -> () #
Eq ECO Source #
Instance details Defined in Game.Chess.Internal.ECO Methods (==) :: ECO -> ECO -> Bool # (/=) :: ECO -> ECO -> Bool #
Hashable ECO Source #
Instance details Defined in Game.Chess.Internal.ECO Methods hashWithSalt :: Int -> ECO -> Int # hash :: ECO -> Int #

data Opening Source #

A Chess Opening

Constructors

CO
Fields coCode :: !Text coName :: !Text coVariation :: !(Maybe Text) coPlies :: !(Vector Ply)

Instances

Instances details

Generic Opening Source #
Instance details Defined in Game.Chess.Internal.ECO Associated Types type Rep Opening :: Type -> Type # Methods from :: Opening -> Rep Opening x # to :: Rep Opening x -> Opening #
Show Opening Source #
Instance details Defined in Game.Chess.Internal.ECO Methods showsPrec :: Int -> Opening -> ShowS # show :: Opening -> String # showList :: [Opening] -> ShowS #
Binary Opening Source #
Instance details Defined in Game.Chess.Internal.ECO Methods put :: Opening -> Put # get :: Get Opening # putList :: [Opening] -> Put #
NFData Opening Source #
Instance details Defined in Game.Chess.Internal.ECO Methods rnf :: Opening -> () #
Eq Opening Source #
Instance details Defined in Game.Chess.Internal.ECO Methods (==) :: Opening -> Opening -> Bool # (/=) :: Opening -> Opening -> Bool #
Hashable Opening Source #
Instance details Defined in Game.Chess.Internal.ECO Methods hashWithSalt :: Int -> Opening -> Int # hash :: Opening -> Int #
Lift Opening Source #
Instance details Defined in Game.Chess.Internal.ECO Methods lift :: Quote m => Opening -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => Opening -> Code m Opening #
type Rep Opening Source #
Instance details Defined in Game.Chess.Internal.ECO type Rep Opening = D1 ('MetaData "Opening" "Game.Chess.Internal.ECO" "chessIO-0.9.3.1-FhorHdlbYNXK07vrmB8ltu" 'False) (C1 ('MetaCons "CO" 'PrefixI 'True) ((S1 ('MetaSel ('Just "coCode") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "coName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "coVariation") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "coPlies") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 (Vector Ply)))))