Game.Chess.UCI

The Universal Chess Interface (UCI) is a protocol for communicating with external Chess engines.

Exceptions

data UCIException

Constructors

IllegalMove Ply

Instances

Exception UCIException

Defined in Game.Chess.UCI

Methods

toException :: UCIException -> SomeException

fromException :: SomeException -> Maybe UCIException

displayException :: UCIException -> String

Show UCIException

Defined in Game.Chess.UCI

Methods

showsPrec :: Int -> UCIException -> ShowS

show :: UCIException -> String

showList :: [UCIException] -> ShowS

The Engine data type

data Engine

type BestMove = Maybe (Ply, Maybe Ply)

name :: Engine -> Maybe ByteString

author :: Engine -> Maybe ByteString

Starting a UCI engine

start :: String -> [String] -> IO (Maybe Engine)

Start a UCI engine with the given executable name and command line arguments.

start' :: KnownDivRat unit Microsecond => Time unit -> (String -> IO ()) -> String -> [String] -> IO (Maybe Engine)

Start a UCI engine with the given timeout for initialisation.

If the engine takes more then the given microseconds to answer to the initialisation request, Nothing is returned and the external process will be terminated.

Engine options

data Option

Constructors

CheckBox Bool

ComboBox

Fields

• comboBoxValue :: ByteString
• comboBoxValues :: [ByteString]

SpinButton

Fields

• spinButtonValue, spinButtonMinBound, spinButtonMaxBound :: Int

OString ByteString

Button

Instances

IsString Option

Defined in Game.Chess.UCI

Methods

fromString :: String -> Option

Show Option

Defined in Game.Chess.UCI

Methods

showsPrec :: Int -> Option -> ShowS

show :: Option -> String

showList :: [Option] -> ShowS

Eq Option

Defined in Game.Chess.UCI

Methods

(==) :: Option -> Option -> Bool

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

options :: Engine -> HashMap ByteString Option

getOption :: ByteString -> Engine -> Maybe Option

setOptionSpinButton :: MonadIO m => ByteString -> Int -> Engine -> m Engine

Set a spin option to a particular value.

Bounds are validated. Make sure you don't set a value which is out of range.

setOptionString :: MonadIO m => ByteString -> ByteString -> Engine -> m Engine

Manipulating the current game information

isready :: Engine -> IO ()

Wait until the engine is ready to take more commands.

currentPosition :: MonadIO m => Engine -> m Position

Return the final position of the currently active game.

setPosition :: (Foldable f, MonadIO m) => Engine -> Position -> f Ply -> m ()

Set the starting position and plies of the current game.

addPly :: MonadIO m => Engine -> Ply -> m ()

Add a Move to the game history.

This function checks if the move is actually legal, and throws a UCIException if it isn't.

replacePly :: MonadIO m => Engine -> Ply -> m ()

The Info data type

data Info

Constructors

PV !(Vector Ply)

Depth !Int

SelDepth !Int

Elapsed !(Time Millisecond)

MultiPV !Int

Score !Score (Maybe Bounds)

Nodes !Int

NPS !Int

TBHits !Int

HashFull !Int

CurrMove !Ply

CurrMoveNumber !Int

String !ByteString

Instances

Show Info

Defined in Game.Chess.UCI

Methods

showsPrec :: Int -> Info -> ShowS

show :: Info -> String

showList :: [Info] -> ShowS

Eq Info

Defined in Game.Chess.UCI

Methods

(==) :: Info -> Info -> Bool

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

data Score

Constructors

CentiPawns Int

MateIn Int

Instances

Show Score

Defined in Game.Chess.UCI

Methods

showsPrec :: Int -> Score -> ShowS

show :: Score -> String

showList :: [Score] -> ShowS

Eq Score

Defined in Game.Chess.UCI

Methods

(==) :: Score -> Score -> Bool

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

Ord Score

Defined in Game.Chess.UCI

Methods

compare :: Score -> Score -> Ordering

(<) :: Score -> Score -> Bool

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

(>) :: Score -> Score -> Bool

(>=) :: Score -> Score -> Bool

max :: Score -> Score -> Score

min :: Score -> Score -> Score

data Bounds

Constructors

UpperBound

LowerBound

Instances

Show Bounds

Defined in Game.Chess.UCI

Methods

showsPrec :: Int -> Bounds -> ShowS

show :: Bounds -> String

showList :: [Bounds] -> ShowS

Eq Bounds

Defined in Game.Chess.UCI

Methods

(==) :: Bounds -> Bounds -> Bool

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

Searching

search :: MonadIO m => Engine -> [SearchParam] -> m (TChan BestMove, TChan [Info])

Instruct the engine to begin searching.

searching :: MonadIO m => Engine -> m Bool

data SearchParam

Instances

Show SearchParam

Defined in Game.Chess.UCI

Methods

showsPrec :: Int -> SearchParam -> ShowS

show :: SearchParam -> String

showList :: [SearchParam] -> ShowS

Eq SearchParam

Defined in Game.Chess.UCI

Methods

(==) :: SearchParam -> SearchParam -> Bool

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

searchmoves :: [Ply] -> SearchParam

ponder :: SearchParam

timeleft :: KnownDivRat unit Millisecond => Color -> Time unit -> SearchParam

timeincrement :: KnownDivRat unit Millisecond => Color -> Time unit -> SearchParam

movestogo :: Natural -> SearchParam

movetime :: KnownDivRat unit Millisecond => Time unit -> SearchParam

nodes :: Natural -> SearchParam

depth :: Natural -> SearchParam

infinite :: SearchParam

ponderhit :: MonadIO m => Engine -> m ()

Switch a ponder search to normal search when the pondered move was played.

stop :: MonadIO m => Engine -> m ()

Stop a search in progress.

Quitting

quit :: MonadIO m => Engine -> m (Maybe ExitCode)

Quit the engine.

quit' :: (KnownDivRat unit Microsecond, MonadIO m) => Time unit -> Engine -> m (Maybe ExitCode)