Game.Chess

Types for representing positions and plies and functions for move generation and application. Internally, quad bitboards are employed and plies are stored as 16 bit values. The move generation is fully compliant to the standard rules of Chess.

This module does deliberately not implement any search or evaluation functionality. It is intended to be used to lay the ground for communicating with other programs or players, hence the package name chessIO.

The following modules implement more specific functionality:

• Game.Chess.ECO: Parse the Encyclopedia of Chess Openings and lookup positions
• Game.Chess.Polyglot: Polyglot opening book format
• Game.Chess.SAN: Parse and print Standard Algebraic Notation.
• Game.Chess.PGN: Parse and format Portable Game Notation files.
• Game.Chess.Tree: Functions for converting a position to a tree.
• Game.Chess.UCI: Control external engines using the Universal Chess Interface.

Chess positions

data Color

Constructors

Black

White

Instances

Generic Color

Defined in Game.Chess.Internal

Associated Types

type Rep Color :: Type -> Type

Methods

from :: Color -> Rep Color x

to :: Rep Color x -> Color

Ix Color

Defined in Game.Chess.Internal

Methods

range :: (Color, Color) -> [Color]

index :: (Color, Color) -> Color -> Int

unsafeIndex :: (Color, Color) -> Color -> Int

inRange :: (Color, Color) -> Color -> Bool

rangeSize :: (Color, Color) -> Int

unsafeRangeSize :: (Color, Color) -> Int

Show Color

Defined in Game.Chess.Internal

Methods

showsPrec :: Int -> Color -> ShowS

show :: Color -> String

showList :: [Color] -> ShowS

Binary Color

Defined in Game.Chess.Internal

Methods

put :: Color -> Put

get :: Get Color

putList :: [Color] -> Put

NFData Color

Defined in Game.Chess.Internal

Methods

rnf :: Color -> ()

Eq Color

Defined in Game.Chess.Internal

Methods

(==) :: Color -> Color -> Bool

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

Ord Color

Defined in Game.Chess.Internal

Methods

compare :: Color -> Color -> Ordering

(<) :: Color -> Color -> Bool

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

(>) :: Color -> Color -> Bool

(>=) :: Color -> Color -> Bool

max :: Color -> Color -> Color

min :: Color -> Color -> Color

Hashable Color

Defined in Game.Chess.Internal

Methods

hashWithSalt :: Int -> Color -> Int

hash :: Color -> Int

Lift Color

Defined in Game.Chess.Internal

Methods

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

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

type Rep Color

Defined in Game.Chess.Internal

type Rep Color = D1 ('MetaData "Color" "Game.Chess.Internal" "chessIO-0.9.3.1-FhorHdlbYNXK07vrmB8ltu" 'False) (C1 ('MetaCons "Black" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "White" 'PrefixI 'False) (U1 :: Type -> Type))

opponent :: Color -> Color

data Square where

Bundled Patterns

pattern A1 :: Square

pattern A2 :: Square

pattern A3 :: Square

pattern A4 :: Square

pattern A5 :: Square

pattern A6 :: Square

pattern A7 :: Square

pattern A8 :: Square

pattern B1 :: Square

pattern B2 :: Square

pattern B3 :: Square

pattern B4 :: Square

pattern B5 :: Square

pattern B6 :: Square

pattern B7 :: Square

pattern B8 :: Square

pattern C1 :: Square

pattern C2 :: Square

pattern C3 :: Square

pattern C4 :: Square

pattern C5 :: Square

pattern C6 :: Square

pattern C7 :: Square

pattern C8 :: Square

pattern D1 :: Square

pattern D2 :: Square

pattern D3 :: Square

pattern D4 :: Square

pattern D5 :: Square

pattern D6 :: Square

pattern D7 :: Square

pattern D8 :: Square

pattern E1 :: Square

pattern E2 :: Square

pattern E3 :: Square

pattern E4 :: Square

pattern E5 :: Square

pattern E6 :: Square

pattern E7 :: Square

pattern E8 :: Square

pattern F1 :: Square

pattern F2 :: Square

pattern F3 :: Square

pattern F4 :: Square

pattern F5 :: Square

pattern F6 :: Square

pattern F7 :: Square

pattern F8 :: Square

pattern G1 :: Square

pattern G2 :: Square

pattern G3 :: Square

pattern G4 :: Square

pattern G5 :: Square

pattern G6 :: Square

pattern G7 :: Square

pattern G8 :: Square

pattern H1 :: Square

pattern H2 :: Square

pattern H3 :: Square

pattern H4 :: Square

pattern H5 :: Square

pattern H6 :: Square

pattern H7 :: Square

pattern H8 :: Square

Instances

Bounded Square

Defined in Game.Chess.Internal.Square

Methods

minBound :: Square

maxBound :: Square

Enum Square

Defined in Game.Chess.Internal.Square

Methods

succ :: Square -> Square

pred :: Square -> Square

toEnum :: Int -> Square

fromEnum :: Square -> Int

enumFrom :: Square -> [Square]

enumFromThen :: Square -> Square -> [Square]

enumFromTo :: Square -> Square -> [Square]

enumFromThenTo :: Square -> Square -> Square -> [Square]

Ix Square

Defined in Game.Chess.Internal.Square

Methods

range :: (Square, Square) -> [Square]

index :: (Square, Square) -> Square -> Int

unsafeIndex :: (Square, Square) -> Square -> Int

inRange :: (Square, Square) -> Square -> Bool

rangeSize :: (Square, Square) -> Int

unsafeRangeSize :: (Square, Square) -> Int

Show Square

Defined in Game.Chess.Internal.Square

Methods

showsPrec :: Int -> Square -> ShowS

show :: Square -> String

showList :: [Square] -> ShowS

Binary Square

Defined in Game.Chess.Internal.Square

Methods

put :: Square -> Put

get :: Get Square

putList :: [Square] -> Put

Eq Square

Defined in Game.Chess.Internal.Square

Methods

(==) :: Square -> Square -> Bool

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

Ord Square

Defined in Game.Chess.Internal.Square

Methods

compare :: Square -> Square -> Ordering

(<) :: Square -> Square -> Bool

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

(>) :: Square -> Square -> Bool

(>=) :: Square -> Square -> Bool

max :: Square -> Square -> Square

min :: Square -> Square -> Square

rank :: Square -> Rank

data Rank where

Bundled Patterns

pattern Rank1 :: Rank

pattern Rank2 :: Rank

pattern Rank3 :: Rank

pattern Rank4 :: Rank

pattern Rank5 :: Rank

pattern Rank6 :: Rank

pattern Rank7 :: Rank

pattern Rank8 :: Rank

Instances

Bounded Rank

Defined in Game.Chess.Internal.Square

Methods

minBound :: Rank

maxBound :: Rank

Enum Rank

Defined in Game.Chess.Internal.Square

Methods

succ :: Rank -> Rank

pred :: Rank -> Rank

toEnum :: Int -> Rank

fromEnum :: Rank -> Int

enumFrom :: Rank -> [Rank]

enumFromThen :: Rank -> Rank -> [Rank]

enumFromTo :: Rank -> Rank -> [Rank]

enumFromThenTo :: Rank -> Rank -> Rank -> [Rank]

Show Rank

Defined in Game.Chess.Internal.Square

Methods

showsPrec :: Int -> Rank -> ShowS

show :: Rank -> String

showList :: [Rank] -> ShowS

Eq Rank

Defined in Game.Chess.Internal.Square

Methods

(==) :: Rank -> Rank -> Bool

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

Ord Rank

Defined in Game.Chess.Internal.Square

Methods

compare :: Rank -> Rank -> Ordering

(<) :: Rank -> Rank -> Bool

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

(>) :: Rank -> Rank -> Bool

(>=) :: Rank -> Rank -> Bool

max :: Rank -> Rank -> Rank

min :: Rank -> Rank -> Rank

mkRank :: HasCallStack => Int -> Rank

unRank :: Rank -> Int

file :: Square -> File

data File where

Bundled Patterns

pattern FileA :: File

pattern FileB :: File

pattern FileC :: File

pattern FileD :: File

pattern FileE :: File

pattern FileF :: File

pattern FileG :: File

pattern FileH :: File

Instances

Bounded File

Defined in Game.Chess.Internal.Square

Methods

minBound :: File

maxBound :: File

Enum File

Defined in Game.Chess.Internal.Square

Methods

succ :: File -> File

pred :: File -> File

toEnum :: Int -> File

fromEnum :: File -> Int

enumFrom :: File -> [File]

enumFromThen :: File -> File -> [File]

enumFromTo :: File -> File -> [File]

enumFromThenTo :: File -> File -> File -> [File]

Show File

Defined in Game.Chess.Internal.Square

Methods

showsPrec :: Int -> File -> ShowS

show :: File -> String

showList :: [File] -> ShowS

Eq File

Defined in Game.Chess.Internal.Square

Methods

(==) :: File -> File -> Bool

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

Ord File

Defined in Game.Chess.Internal.Square

Methods

compare :: File -> File -> Ordering

(<) :: File -> File -> Bool

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

(>) :: File -> File -> Bool

(>=) :: File -> File -> Bool

max :: File -> File -> File

min :: File -> File -> File

mkFile :: HasCallStack => Int -> File

unFile :: File -> Int

rankFile :: Iso' Square (Rank, File)

mapRank :: (Rank -> Rank) -> Square -> Square

mapFile :: (File -> File) -> Square -> Square

isLight :: Square -> Bool

isDark :: Square -> Bool

rankChar :: Square -> Char

fileChar :: Square -> Char

toCoord :: IsString s => Square -> s

data PieceType where

Bundled Patterns

pattern Pawn :: PieceType

pattern Knight :: PieceType

pattern Bishop :: PieceType

pattern Rook :: PieceType

pattern Queen :: PieceType

pattern King :: PieceType

Instances

Ix PieceType

Defined in Game.Chess.Internal

Methods

range :: (PieceType, PieceType) -> [PieceType]

index :: (PieceType, PieceType) -> PieceType -> Int

unsafeIndex :: (PieceType, PieceType) -> PieceType -> Int

inRange :: (PieceType, PieceType) -> PieceType -> Bool

rangeSize :: (PieceType, PieceType) -> Int

unsafeRangeSize :: (PieceType, PieceType) -> Int

Show PieceType

Defined in Game.Chess.Internal

Methods

showsPrec :: Int -> PieceType -> ShowS

show :: PieceType -> String

showList :: [PieceType] -> ShowS

Eq PieceType

Defined in Game.Chess.Internal

Methods

(==) :: PieceType -> PieceType -> Bool

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

Ord PieceType

Defined in Game.Chess.Internal

Methods

compare :: PieceType -> PieceType -> Ordering

(<) :: PieceType -> PieceType -> Bool

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

(>) :: PieceType -> PieceType -> Bool

(>=) :: PieceType -> PieceType -> Bool

max :: PieceType -> PieceType -> PieceType

min :: PieceType -> PieceType -> PieceType

Lift PieceType

Defined in Game.Chess.Internal

Methods

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

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

data Castle

Constructors

Kingside

Queenside

Instances

Ix Castle

Defined in Game.Chess.Internal

Methods

range :: (Castle, Castle) -> [Castle]

index :: (Castle, Castle) -> Castle -> Int

unsafeIndex :: (Castle, Castle) -> Castle -> Int

inRange :: (Castle, Castle) -> Castle -> Bool

rangeSize :: (Castle, Castle) -> Int

unsafeRangeSize :: (Castle, Castle) -> Int

Show Castle

Defined in Game.Chess.Internal

Methods

showsPrec :: Int -> Castle -> ShowS

show :: Castle -> String

showList :: [Castle] -> ShowS

Eq Castle

Defined in Game.Chess.Internal

Methods

(==) :: Castle -> Castle -> Bool

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

Ord Castle

Defined in Game.Chess.Internal

Methods

compare :: Castle -> Castle -> Ordering

(<) :: Castle -> Castle -> Bool

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

(>) :: Castle -> Castle -> Bool

(>=) :: Castle -> Castle -> Bool

max :: Castle -> Castle -> Castle

min :: Castle -> Castle -> Castle

data Position

Instances

IsString Position

Defined in Game.Chess.Internal

Methods

fromString :: String -> Position

Generic Position

Defined in Game.Chess.Internal

Associated Types

type Rep Position :: Type -> Type

Methods

from :: Position -> Rep Position x

to :: Rep Position x -> Position

Show Position

Defined in Game.Chess.Internal

Methods

showsPrec :: Int -> Position -> ShowS

show :: Position -> String

showList :: [Position] -> ShowS

Binary Position

Defined in Game.Chess.Internal

Methods

put :: Position -> Put

get :: Get Position

putList :: [Position] -> Put

NFData Position

Defined in Game.Chess.Internal

Methods

rnf :: Position -> ()

Eq Position

Defined in Game.Chess.Internal

Methods

(==) :: Position -> Position -> Bool

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

Ord Position

Defined in Game.Chess.Internal

Methods

compare :: Position -> Position -> Ordering

(<) :: Position -> Position -> Bool

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

(>) :: Position -> Position -> Bool

(>=) :: Position -> Position -> Bool

max :: Position -> Position -> Position

min :: Position -> Position -> Position

Hashable Position

Defined in Game.Chess.Internal

Methods

hashWithSalt :: Int -> Position -> Int

hash :: Position -> Int

Lift Position

Defined in Game.Chess.Internal

Methods

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

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

type Rep Position

Defined in Game.Chess.Internal

type Rep Position

startpos :: Position

The starting position as given by the FEN string "rnbqkbnrpppppppp8888PPPPPPPP/RNBQKBNR w KQkq - 0 1".

color :: Position -> Color

active color

moveNumber :: Position -> Int

number of the full move

halfMoveClock :: Position -> Int

pieceAt :: Position -> Square -> Maybe (Color, PieceType)

inCheck :: Color -> Position -> Bool

Returns True if Color is in check in the given position.

castlingRights :: Position -> [(Color, Castle)]

canCastleKingside :: Position -> Bool

canCastleQueenside :: Position -> Bool

insufficientMaterial :: Position -> Bool

repetitions :: [Position] -> Maybe (Int, Position)

enPassantSquare :: Position -> Maybe Square

Converting from/to Forsyth-Edwards-Notation

fromFEN :: String -> Maybe Position

Construct a position from Forsyth-Edwards-Notation.

toFEN :: Position -> String

Convert a position to Forsyth-Edwards-Notation.

Chess moves

data Ply

Instances

Storable Ply

Defined in Game.Chess.Internal

Methods

sizeOf :: Ply -> Int

alignment :: Ply -> Int

peekElemOff :: Ptr Ply -> Int -> IO Ply

pokeElemOff :: Ptr Ply -> Int -> Ply -> IO ()

peekByteOff :: Ptr b -> Int -> IO Ply

pokeByteOff :: Ptr b -> Int -> Ply -> IO ()

peek :: Ptr Ply -> IO Ply

poke :: Ptr Ply -> Ply -> IO ()

Show Ply

Defined in Game.Chess.Internal

Methods

showsPrec :: Int -> Ply -> ShowS

show :: Ply -> String

showList :: [Ply] -> ShowS

Binary Ply

Defined in Game.Chess.Internal

Methods

put :: Ply -> Put

get :: Get Ply

putList :: [Ply] -> Put

Eq Ply

Defined in Game.Chess.Internal

Methods

(==) :: Ply -> Ply -> Bool

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

Ord Ply

Defined in Game.Chess.Internal

Methods

compare :: Ply -> Ply -> Ordering

(<) :: Ply -> Ply -> Bool

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

(>) :: Ply -> Ply -> Bool

(>=) :: Ply -> Ply -> Bool

max :: Ply -> Ply -> Ply

min :: Ply -> Ply -> Ply

Hashable Ply

Defined in Game.Chess.Internal

Methods

hashWithSalt :: Int -> Ply -> Int

hash :: Ply -> Int

Unbox Ply

Defined in Game.Chess.Internal

Vector Vector Ply

Defined in Game.Chess.Internal

Methods

basicUnsafeFreeze :: Mutable Vector s Ply -> ST s (Vector Ply)

basicUnsafeThaw :: Vector Ply -> ST s (Mutable Vector s Ply)

basicLength :: Vector Ply -> Int

basicUnsafeSlice :: Int -> Int -> Vector Ply -> Vector Ply

basicUnsafeIndexM :: Vector Ply -> Int -> Box Ply

basicUnsafeCopy :: Mutable Vector s Ply -> Vector Ply -> ST s ()

elemseq :: Vector Ply -> Ply -> b -> b

MVector MVector Ply

Defined in Game.Chess.Internal

Methods

basicLength :: MVector s Ply -> Int

basicUnsafeSlice :: Int -> Int -> MVector s Ply -> MVector s Ply

basicOverlaps :: MVector s Ply -> MVector s Ply -> Bool

basicUnsafeNew :: Int -> ST s (MVector s Ply)

basicInitialize :: MVector s Ply -> ST s ()

basicUnsafeReplicate :: Int -> Ply -> ST s (MVector s Ply)

basicUnsafeRead :: MVector s Ply -> Int -> ST s Ply

basicUnsafeWrite :: MVector s Ply -> Int -> Ply -> ST s ()

basicClear :: MVector s Ply -> ST s ()

basicSet :: MVector s Ply -> Ply -> ST s ()

basicUnsafeCopy :: MVector s Ply -> MVector s Ply -> ST s ()

basicUnsafeMove :: MVector s Ply -> MVector s Ply -> ST s ()

basicUnsafeGrow :: MVector s Ply -> Int -> ST s (MVector s Ply)

Lift Ply

Defined in Game.Chess.Internal

Methods

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

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

newtype Vector Ply

Defined in Game.Chess.Internal

newtype Vector Ply = V_Ply (Vector Word16)

newtype MVector s Ply

Defined in Game.Chess.Internal

newtype MVector s Ply = MV_Ply (MVector s Word16)

plySource :: Ply -> Square

plyTarget :: Ply -> Square

plyPromotion :: Ply -> Maybe PieceType

move :: Square -> Square -> Ply

promoteTo :: Ply -> PieceType -> Ply

Convertion

fromUCI :: Position -> String -> Maybe Ply

Parse a move in the format used by the Universal Chess Interface protocol.

toUCI :: Ply -> String

Convert a move to the format used by the Universal Chess Interface protocol.

Move generation

legalPlies :: Position -> [Ply]

Generate a list of possible moves for the given position.

legalPlies' :: Position -> Vector Ply

Executing moves

doPly :: HasCallStack => Position -> Ply -> Position

Apply a move to the given position.

This function checks if the move is actually legal and throws and error if it isn't. See unsafeDoPly for a version that omits the legality check.

unsafeDoPly :: Position -> Ply -> Position

An unsafe version of doPly. Only use this if you are sure the given move can be applied to the position. This is useful if the move has been generated by the legalPlies function.