Game.Goatee.Lib.Board

Data structures that wrap and provide a higher-level interface to the SGF game tree, including a zipper that navigates the tree and provides the current board state.

Documentation

data RootInfo

Properties that are specified in the root nodes of game trees.

Constructors

RootInfo

Fields

• rootInfoWidth :: Int
• rootInfoHeight :: Int
• rootInfoVariationMode :: VariationMode

Instances

Eq RootInfo

Defined in Game.Goatee.Lib.Board

Methods

(==) :: RootInfo -> RootInfo -> Bool

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

Show RootInfo

Defined in Game.Goatee.Lib.Board

Methods

showsPrec :: Int -> RootInfo -> ShowS

show :: RootInfo -> String

showList :: [RootInfo] -> ShowS

data GameInfo

Properties that are specified in game info nodes.

Constructors

GameInfo

Fields

• gameInfoRootInfo :: RootInfo
• gameInfoBlackName :: Maybe SimpleText
• gameInfoBlackTeamName :: Maybe SimpleText
• gameInfoBlackRank :: Maybe SimpleText
• gameInfoWhiteName :: Maybe SimpleText
• gameInfoWhiteTeamName :: Maybe SimpleText
• gameInfoWhiteRank :: Maybe SimpleText
• gameInfoRuleset :: Maybe Ruleset
• gameInfoBasicTimeSeconds :: Maybe RealValue
• gameInfoOvertime :: Maybe SimpleText
• gameInfoResult :: Maybe GameResult
• gameInfoGameName :: Maybe SimpleText
• gameInfoGameComment :: Maybe Text
• gameInfoOpeningComment :: Maybe SimpleText
• gameInfoEvent :: Maybe SimpleText
• gameInfoRound :: Maybe SimpleText
• gameInfoPlace :: Maybe SimpleText
• gameInfoDatesPlayed :: Maybe SimpleText
• gameInfoSource :: Maybe SimpleText
• gameInfoCopyright :: Maybe SimpleText
• gameInfoAnnotatorName :: Maybe SimpleText
• gameInfoEntererName :: Maybe SimpleText

Instances

Eq GameInfo

Defined in Game.Goatee.Lib.Board

Methods

(==) :: GameInfo -> GameInfo -> Bool

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

Show GameInfo

Defined in Game.Goatee.Lib.Board

Methods

showsPrec :: Int -> GameInfo -> ShowS

show :: GameInfo -> String

showList :: [GameInfo] -> ShowS

emptyGameInfo :: RootInfo -> GameInfo

Builds a GameInfo with the given RootInfo and no extra data.

internalIsGameInfoNode :: Node -> Bool

Returns whether a node contains any game info properties.

gameInfoToProperties :: GameInfo -> [Property]

Converts a GameInfo into a list of Propertys that can be used to reconstruct the GameInfo.

data BoardState

An object that corresponds to a node in some game tree, and represents the state of the game at that node, including board position, player turn and captures, and also board annotations.

Constructors

BoardState

Fields

• boardCoordStates :: [[CoordState]]

  The state of individual points on the board. Stored in row-major order. Point (x, y) can be accessed via !! y !! x (but prefer boardCoordState).

• boardHasInvisible :: Bool

  Whether any of the board's CoordStates are invisible. This is an optimization to make it more efficient to set the board to "all visible."

• boardHasDimmed :: Bool

  Whether any of the board's CoordStates are dimmed. This is an optimization to make it more efficient to clear all dimming from the board.

• boardHasCoordMarks :: Bool

  Whether any of the board's CoordStates have a Mark set on them. This is an optimization to make it more efficient to clear marks in the common case where there are no marks set.

• boardArrows :: ArrowList
• boardLines :: LineList
• boardLabels :: LabelList
• boardMoveNumber :: Integer
• boardPlayerTurn :: Color
• boardBlackCaptures :: Int
• boardWhiteCaptures :: Int
• boardGameInfo :: GameInfo

Instances

Show BoardState

Defined in Game.Goatee.Lib.Board

Methods

showsPrec :: Int -> BoardState -> ShowS

show :: BoardState -> String

showList :: [BoardState] -> ShowS

boardWidth :: BoardState -> Int

Returns the width of the board, in stones.

boardHeight :: BoardState -> Int

Returns the height of the board, in stones.

data CoordState

Used by BoardState to represent the state of a single point on the board. Records whether a stone is present, as well as annotations and visibility properties.

Constructors

CoordState

Fields

• coordStar :: Bool

  Whether this point is a star point.

• coordStone :: Maybe Color
• coordMark :: Maybe Mark
• coordVisible :: Bool
• coordDimmed :: Bool

Instances

Eq CoordState

Defined in Game.Goatee.Lib.Board

Methods

(==) :: CoordState -> CoordState -> Bool

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

Show CoordState

Defined in Game.Goatee.Lib.Board

Methods

showsPrec :: Int -> CoordState -> ShowS

show :: CoordState -> String

showList :: [CoordState] -> ShowS

emptyBoardState :: Int -> Int -> BoardState

Creates a BoardState for an empty board of the given width and height.

rootBoardState :: Node -> BoardState

emptyCoordState :: CoordState

A CoordState for an empty point on the board.

boardCoordState :: Coord -> BoardState -> CoordState

Returns the CoordState for a coordinate on a board.

boardCoordModify :: BoardState -> Coord -> (CoordState -> CoordState) -> BoardState

Modifies a BoardState by updating the CoordState at a single point.

mapBoardCoords :: (Int -> Int -> CoordState -> a) -> BoardState -> [[a]]

Maps a function over each CoordState in a BoardState, returning a list-of-lists with the function's values. The function is called like fn y x coordState.

isValidMove :: BoardState -> Color -> Coord -> Bool

Returns whether it is legal to place a stone of the given color at a point on a board. Accepts out-of-bound coordinates and returns false.

isCurrentValidMove :: BoardState -> Coord -> Bool

Returns whether it is legal for the current player to place a stone at a point on a board. Accepts out-of-bound coordinates and returns false.

data Cursor

A pointer to a node in a game tree that also holds information about the current state of the game at that node.

Instances

Show Cursor

Defined in Game.Goatee.Lib.Board

Methods

showsPrec :: Int -> Cursor -> ShowS

show :: Cursor -> String

showList :: [Cursor] -> ShowS

cursorParent :: Cursor -> Maybe Cursor

The cursor for the node above this cursor's node in the game tree. The node of the parent cursor is the parent of the cursor's node.

This is Nothing iff the cursor's node has no parent.

cursorChildIndex :: Cursor -> Int

The index of this cursor's node in its parent's child list. When the cursor's node has no parent, the value in this field is not specified.

cursorNode :: Cursor -> Node

The game tree node about which the cursor stores information.

cursorBoard :: Cursor -> BoardState

The complete board state for the current node.

rootCursor :: Node -> Cursor

Returns a cursor for a root node.

cursorRoot :: Cursor -> Cursor

cursorChild :: Cursor -> Int -> Cursor

cursorChildren :: Cursor -> [Cursor]

cursorChildCount :: Cursor -> Int

cursorChildPlayingAt :: Maybe Coord -> Cursor -> Maybe Cursor

cursorProperties :: Cursor -> [Property]

This is simply nodeProperties . cursorNode.

cursorModifyNode :: (Node -> Node) -> Cursor -> Cursor

cursorVariations :: VariationModeSource -> Cursor -> [(Coord, Color)]

Returns the variations to display for a cursor. The returned list contains the location and color of B and W properties in variation nodes. Variation nodes are either children of the current node, or siblings of the current node, depending on the variation mode source.

moveToProperty :: Color -> Maybe Coord -> Property