Go Library: GoGameRecord Class Reference

Definition at line 39 of file GoGame.h.


Public Member Functions
	GoGameRecord (GoBoard &board)
	Create a game record for replaying games on the given board.
virtual	~GoGameRecord ()
virtual void	InitFromRoot (SgNode *root, bool fTakeOwnership)
	Delete the old game record and start with a fresh one.
virtual void	Init (int size, const GoRules &rules)
	Delete the old game record and start with a fresh one.
virtual void	OnGoToNode (SgNode *dest)
	Hook for subclasses.
virtual void	OnInitBoard (int size, const GoRules &rules)
	Override to initialize other boards in derived classes.
virtual void	OnInitHandicap (const GoRules &rules, SgNode *root)
const GoBoard &	Board () const
	Get the board associated with this game record.
SgNode &	Root () const
	Return the root of this tree.
SgNode *	AddMove (SgMove move, SgBlackWhite player, const SgSearchStatistics *stat=0)
	Add move to the game record.
SgNode *	AddResignNode (SgBlackWhite player)
	Add a node with a comment that a player resigned.
void	GoToNode (SgNode *dest)
	Play to the given node.
void	GoInDirection (SgNode::Direction dir)
	Play to the next node in the given direction.
bool	CanGoInDirection (SgNode::Direction dir) const
	Return whether there is a next node in the given direction.
void	SetToPlay (SgBlackWhite player)
	Set the current player.
bool	EndOfGame () const
	Return whether the game is finished.
virtual std::string	GetPlayerName (SgBlackWhite player) const
	Get the name of the given player.
virtual bool	GetScore (int *score) const
	Return the current score (black minus white).
SgTimeRecord &	Time ()
	The time left in the game at the current position.
const SgTimeRecord &	Time () const
	The time left in the game at the current position.
SgNode *	CurrentNode ()
	Return the current position in the tree.
const SgNode *	CurrentNode () const
	Return the current position in the tree.
bool	OwnsTree () const
	Whether this game record owns the game tree.
bool	CanDeleteCurrentNode () const
SgMove	CurrentMove () const
	Return the move of the current node.
int	CurrentMoveNumber () const
	Get the number of moves since root or last node with setup properties.
Private Member Functions
	GoGameRecord (const GoGameRecord &)
	Not implemented.
GoGameRecord &	operator= (const GoGameRecord &)
	Not implemented.
void	DeleteTreeAndInitState ()
	Delete the tree and initialize the state associated with the position in the tree.
Private Attributes
SgNode *	m_current
	The position in the current tree.
GoBoard &	m_board
GoBoardUpdater	m_updater
SgTimeRecord	m_time
	A record of the clock settings and time left.
bool	m_ownsTree
	Whether this game record owns the game tree.
SgNode *	m_oldCommentNode
	Comment display.
int	m_numMovesToInsert
	Moves inserted into a line of play instead of added at the end.

Constructor & Destructor Documentation

GoGameRecord::GoGameRecord ( GoBoard & board ) [explicit]

Create a game record for replaying games on the given board.

Definition at line 59 of file GoGame.cpp.

References GoInitCheck(), and InitFromRoot().

GoGameRecord::~GoGameRecord ( ) [virtual]

Definition at line 73 of file GoGame.cpp.

References SgNode::DeleteTree(), m_current, and m_ownsTree.

GoGameRecord::GoGameRecord ( const GoGameRecord & ) [private]

Not implemented.

Member Function Documentation

SgNode * GoGameRecord::AddMove	(	SgMove	move,
		SgBlackWhite	player,
		const SgSearchStatistics *	stat = `0`
	)

Add move to the game record.

Add move as the next move at the current position. If a node with that move already exists, then don't add a new one. Return the node with that move. Also add any statistics from 'stat' and time left to that node.

Definition at line 81 of file GoGame.cpp.

References SgNode::AddMoveProp(), AddStatisticsToNode(), SgNode::Get(), SgNode::HasSon(), SgPropMove::IsPlayer(), SgPropMove::IsValue(), SgNode::LeftMostSon(), m_current, m_numMovesToInsert, m_time, SgNode::NewFather(), SgNode::NewRightMostSon(), SgTimeRecord::PlayedMove(), SgNode::RightBrother(), and SG_PROP_MOVE.

Referenced by GoGtpEngine::CmdGenMove(), GoGtpEngine::Play(), GoGame::PlayComputerMove(), and GoGame::PlayHumanMove().

SgNode * GoGameRecord::AddResignNode ( SgBlackWhite player )

Add a node with a comment that a player resigned.

For informational purposes only, the resign node will not be made the current node.

Definition at line 116 of file GoGame.cpp.

References SgNode::AddComment(), m_current, SgNode::NewRightMostSon(), and SG_BLACK.

Referenced by GoGtpEngine::CmdGenMove().

const GoBoard & GoGameRecord::Board ( ) const

Get the board associated with this game record.

Definition at line 193 of file GoGame.h.

References m_board.

Referenced by GoGame::CanPlayHumanMove(), and GoGame::PlayOneMove().

bool GoGameRecord::CanDeleteCurrentNode ( ) const

Definition at line 125 of file GoGame.cpp.

References CurrentNode(), and SgNode::HasFather().

bool GoGameRecord::CanGoInDirection ( SgNode::Direction dir ) const

Return whether there is a next node in the given direction.

Definition at line 130 of file GoGame.cpp.

References m_current, and SgNode::NodeInDirection().

Referenced by GoGameUtil::GotoBeforeMove().

SgMove GoGameRecord::CurrentMove ( ) const

Return the move of the current node.

Return NullMove if no current move.

Definition at line 136 of file GoGame.cpp.

References CurrentNode(), SgNode::Get(), SG_NULLMOVE, and SG_PROP_MOVE.

int GoGameRecord::CurrentMoveNumber ( ) const

Get the number of moves since root or last node with setup properties.

Definition at line 149 of file GoGame.cpp.

References SgNodeUtil::GetMoveNumber(), and m_current.

Referenced by GoGtpEngine::CheckLegal(), and GoGameUtil::GotoBeforeMove().

const SgNode * GoGameRecord::CurrentNode ( ) const

Return the current position in the tree.

Todo:: changed from protected to public because of getting the current time left.

Definition at line 219 of file GoGame.h.

References m_current.

SgNode * GoGameRecord::CurrentNode ( )

Return the current position in the tree.

Todo:: changed from protected to public because of getting the current time left.

Definition at line 214 of file GoGame.h.

References m_current.

Referenced by GoGtpEngine::ApplyTimeSettings(), CanDeleteCurrentNode(), GoGtpEngine::CmdPlaySequence(), GoGtpEngine::CmdSetup(), GoGtpEngine::CmdSetupPlayer(), CurrentMove(), GetPlayerName(), GetScore(), GoGameUtil::GotoBeforeMove(), GoGtpEngine::PlaceHandicap(), GoGtpEngine::Undo(), and GoGame::UpdatePlayer().

void GoGameRecord::DeleteTreeAndInitState ( ) [private]

Delete the tree and initialize the state associated with the position in the tree.

Definition at line 157 of file GoGame.cpp.

References SgNode::DeleteTree(), m_current, m_oldCommentNode, and m_ownsTree.

Referenced by Init(), and InitFromRoot().

bool GoGameRecord::EndOfGame ( ) const

Return whether the game is finished.

Definition at line 167 of file GoGame.cpp.

References GoBoardUtil::EndOfGame(), and m_board.

std::string GoGameRecord::GetPlayerName ( SgBlackWhite player ) const [virtual]

Get the name of the given player.

Return the blank string if unknown. Override to get information from an ongoing game rather than fron the game record.

Definition at line 172 of file GoGame.cpp.

References CurrentNode(), SgNode::Get(), SgNode::HasProp(), SgProp::PlayerProp(), SG_PROP_PLAYER_BLACK, and SgNode::TopProp().

bool GoGameRecord::GetScore ( int * score ) const [virtual]

Return the current score (black minus white).

Todo:: : in what units? Return true if there's a score recorded in the tree, otherwise false. Override to return information about the score from a player.

Definition at line 187 of file GoGame.cpp.

References CurrentNode(), SgNode::GetIntProp(), SgNode::HasProp(), SG_ASSERT, SG_PROP_VALUE, and SgNode::TopProp().

void GoGameRecord::GoInDirection ( SgNode::Direction dir )

Play to the next node in the given direction.

Definition at line 200 of file GoGame.cpp.

References GoToNode(), m_current, and SgNode::NodeInDirection().

Referenced by GoGameUtil::GotoBeforeMove().

void GoGameRecord::GoToNode ( SgNode * dest )

Play to the given node.

dest must be in this tree, or 0. Also updates the clock.

Definition at line 207 of file GoGame.cpp.

References SgTimeRecord::EnterNode(), m_board, m_current, m_time, m_updater, OnGoToNode(), GoBoardUtil::RemainingChineseHandicap(), SG_BLACK, Time(), GoBoardUpdater::Update(), and SgNodeUtil::UpdateTime().

Referenced by GoGtpEngine::CmdGenMove(), GoGtpEngine::CmdPlaySequence(), GoGtpEngine::CmdSetup(), GoInDirection(), Init(), InitFromRoot(), GoGtpEngine::PlaceHandicap(), GoGtpEngine::Play(), GoGame::PlayComputerMove(), GoGame::PlayHumanMove(), and GoGtpEngine::Undo().

void GoGameRecord::Init	(	int	size,
		const GoRules &	rules
	)			`[virtual]`

Delete the old game record and start with a fresh one.

Init the board with the given parameters, and create a root node to start with.

Reimplemented in GoGame.

Definition at line 218 of file GoGame.cpp.

References SgNode::Add(), DeleteTreeAndInitState(), GoToNode(), m_board, m_ownsTree, OnInitBoard(), OnInitHandicap(), SG_PROP_SIZE, and GoBoard::Size().

Referenced by GoGame::Init().

void GoGameRecord::InitFromRoot	(	SgNode *	root,
		bool	fTakeOwnership
	)			`[virtual]`

Delete the old game record and start with a fresh one.

If 'root' is 0, create a root node to start with, otherwise use the game tree passed in 'root'. If 'fTakeOwnership', the game record will delete this tree when it's destroyed, otherwise the client is reponsible for deleting the tree.