Safe Haskell	None
Language	Haskell2010

Game.Chess.UCI

Contents

Exceptions
The Engine data type
Starting a UCI engine
Engine options
Manipulating the current game information
The Info data type
Searching
Quitting

Synopsis

data UCIException = IllegalMove Ply
data Engine
name :: Engine -> Maybe ByteString
author :: Engine -> Maybe ByteString
start :: String -> [String] -> IO (Maybe Engine)
start' :: KnownDivRat unit Microsecond => Time unit -> (String -> IO ()) -> String -> [String] -> IO (Maybe Engine)
data Option
- = CheckBox Bool
- | ComboBox {
  - comboBoxValue :: ByteString
  - comboBoxValues :: [ByteString]
  }
- | SpinButton {
  - spinButtonValue, spinButtonMinBound, spinButtonMaxBound :: Int
  }
- | OString ByteString
- | Button
options :: Engine -> HashMap ByteString Option
getOption :: ByteString -> Engine -> Maybe Option
setOptionSpinButton :: MonadIO m => ByteString -> Int -> Engine -> m Engine
setOptionString :: MonadIO m => ByteString -> ByteString -> Engine -> m Engine
isready :: Engine -> IO ()
currentPosition :: MonadIO m => Engine -> m Position
setPosition :: MonadIO m => Engine -> Position -> m (Position, [Ply])
addPly :: MonadIO m => Engine -> Ply -> m ()
data Info
- = PV [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
data Score
- = CentiPawns Int
- | MateIn Int
data Bounds
- = UpperBound
- | LowerBound
search :: MonadIO m => Engine -> [SearchParam] -> m (TChan (Ply, Maybe Ply), TChan [Info])
searching :: MonadIO m => Engine -> m Bool
data SearchParam
searchmoves :: [Ply] -> 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
stop :: MonadIO m => Engine -> m ()
quit :: MonadIO m => Engine -> m (Maybe ExitCode)
quit' :: (KnownDivRat unit Microsecond, MonadIO m) => Time unit -> Engine -> m (Maybe ExitCode)

Exceptions

data UCIException Source #

Constructors

IllegalMove Ply

Instances

Show UCIException Source #
Instance details Defined in Game.Chess.UCI Methods showsPrec :: Int -> UCIException -> ShowS # show :: UCIException -> String # showList :: [UCIException] -> ShowS #
Exception UCIException Source #
Instance details Defined in Game.Chess.UCI Methods toException :: UCIException -> SomeException # fromException :: SomeException -> Maybe UCIException # displayException :: UCIException -> String #

The Engine data type

data Engine Source #

name :: Engine -> Maybe ByteString Source #

author :: Engine -> Maybe ByteString Source #

Starting a UCI engine

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

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) Source #

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 Source #

Constructors

CheckBox Bool
ComboBox
Fields comboBoxValue :: ByteString comboBoxValues :: [ByteString]
SpinButton
Fields spinButtonValue, spinButtonMinBound, spinButtonMaxBound :: Int
OString ByteString
Button

Instances

Eq Option Source #
Instance details Defined in Game.Chess.UCI Methods (==) :: Option -> Option -> Bool # (/=) :: Option -> Option -> Bool #
Show Option Source #
Instance details Defined in Game.Chess.UCI Methods showsPrec :: Int -> Option -> ShowS # show :: Option -> String # showList :: [Option] -> ShowS #
IsString Option Source #
Instance details Defined in Game.Chess.UCI Methods fromString :: String -> Option #

options :: Engine -> HashMap ByteString Option Source #

getOption :: ByteString -> Engine -> Maybe Option Source #

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

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 Source #

Manipulating the current game information

isready :: Engine -> IO () Source #

Wait until the engine is ready to take more commands.

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

Return the final position of the currently active game.

setPosition Source #

Arguments

:: MonadIO m
=> Engine
-> Position
-> m (Position, [Ply])	the game previously in progress

Set the starting position of the current game, also clearing any pre-existing history.

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

Add a Move to the game history.

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

The Info data type

data Info Source #

Constructors

PV [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

Eq Info Source #
Instance details Defined in Game.Chess.UCI Methods (==) :: Info -> Info -> Bool # (/=) :: Info -> Info -> Bool #
Show Info Source #
Instance details Defined in Game.Chess.UCI Methods showsPrec :: Int -> Info -> ShowS # show :: Info -> String # showList :: [Info] -> ShowS #

data Score Source #

Constructors

CentiPawns Int
MateIn Int

Instances

Eq Score Source #
Instance details Defined in Game.Chess.UCI Methods (==) :: Score -> Score -> Bool # (/=) :: Score -> Score -> Bool #
Ord Score Source #
Instance details 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 #
Show Score Source #
Instance details Defined in Game.Chess.UCI Methods showsPrec :: Int -> Score -> ShowS # show :: Score -> String # showList :: [Score] -> ShowS #

data Bounds Source #

Constructors

UpperBound
LowerBound

Instances

Eq Bounds Source #
Instance details Defined in Game.Chess.UCI Methods (==) :: Bounds -> Bounds -> Bool # (/=) :: Bounds -> Bounds -> Bool #
Show Bounds Source #
Instance details Defined in Game.Chess.UCI Methods showsPrec :: Int -> Bounds -> ShowS # show :: Bounds -> String # showList :: [Bounds] -> ShowS #

Searching

search :: MonadIO m => Engine -> [SearchParam] -> m (TChan (Ply, Maybe Ply), TChan [Info]) Source #

Instruct the engine to begin searching.

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

data SearchParam Source #

Instances

Eq SearchParam Source #
Instance details Defined in Game.Chess.UCI Methods (==) :: SearchParam -> SearchParam -> Bool # (/=) :: SearchParam -> SearchParam -> Bool #
Show SearchParam Source #
Instance details Defined in Game.Chess.UCI Methods showsPrec :: Int -> SearchParam -> ShowS # show :: SearchParam -> String # showList :: [SearchParam] -> ShowS #

searchmoves :: [Ply] -> SearchParam Source #

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

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

movestogo :: Natural -> SearchParam Source #

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

nodes :: Natural -> SearchParam Source #

depth :: Natural -> SearchParam Source #

infinite :: SearchParam Source #

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

Stop a search in progress.

Quitting

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

Quit the engine.

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