net.sf.gogui.gtp

Class GtpEngine

java.lang.Object

net.sf.gogui.gtp.GtpEngine

Direct Known Subclasses:

Display, Dummy, TwoGtp

public class GtpEngine
extends java.lang.Object

Base class for Go programs and tools implementing GTP.

Constructor Summary

Constructors

Constructor and Description
GtpEngine(java.io.PrintStream log)

Method Summary

Methods

Modifier and Type	Method and Description
void	cmdKnownCommand(GtpCommand cmd)
void	cmdListCommands(GtpCommand cmd)
void	cmdName(GtpCommand cmd)
void	cmdProtocolVersion(GtpCommand cmd)
void	cmdQuit(GtpCommand cmd)
void	cmdUnknown(GtpCommand cmd)
void	cmdVersion(GtpCommand cmd)
void	handleCommand(GtpCommand cmd) Handle command.
void	interruptCommand() Callback for interrupting commands.
protected boolean	isInterrupted()
boolean	isRegistered(java.lang.String command)
void	log(java.lang.String line)
void	mainLoop(java.io.InputStream in, java.io.OutputStream out) Main command loop.
static GoPoint	parsePointArgument(java.lang.String[] cmdArray, int boardSize) Utility function for parsing a point argument.
static PointList	parsePointListArgument(java.lang.String[] cmdArray, int boardSize) Utility function for parsing an point list argument.
void	printInvalidResponse(java.lang.String text) Print invalid response directly to output stream.
void	register(java.lang.String command, GtpCallback callback) Register new command.
void	respond(boolean status, boolean hasId, int id, java.lang.String response)
void	setName(java.lang.String name) Set name for name command.
void	setQuit() Set quit flag for terminating command loop.
void	setVersion(java.lang.String version) Set version for version command.
void	unregister(java.lang.String command)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GtpEngine

public GtpEngine(java.io.PrintStream log)

Method Detail

cmdKnownCommand

public void cmdKnownCommand(GtpCommand cmd)
                     throws GtpError

Throws:

GtpError

cmdListCommands

public void cmdListCommands(GtpCommand cmd)
                     throws GtpError

Throws:

GtpError

cmdName

public void cmdName(GtpCommand cmd)
             throws GtpError

Throws:

GtpError

cmdProtocolVersion

public void cmdProtocolVersion(GtpCommand cmd)
                        throws GtpError

Throws:

GtpError

cmdQuit

public void cmdQuit(GtpCommand cmd)
             throws GtpError

Throws:

GtpError

cmdUnknown

public void cmdUnknown(GtpCommand cmd)
                throws GtpError

Throws:

GtpError

cmdVersion

public void cmdVersion(GtpCommand cmd)
                throws GtpError

Throws:

GtpError

interruptCommand

public void interruptCommand()

Callback for interrupting commands. This callback will be invoked if the special comment line "# interrupt" is received. It will be invoked from a different thread.

handleCommand

public void handleCommand(GtpCommand cmd)
                   throws GtpError

Handle command. The default implementation looks up the command within the registered commands and calls the registered callback.

Throws:

GtpError

isRegistered

public boolean isRegistered(java.lang.String command)

log

public void log(java.lang.String line)

mainLoop

public void mainLoop(java.io.InputStream in,
            java.io.OutputStream out)
              throws java.io.IOException

Main command loop. Reads commands and calls GtpEngine.handleCommand until the end of the input stream or the quit command is reached.

Throws:

java.io.IOException

parsePointArgument

public static GoPoint parsePointArgument(java.lang.String[] cmdArray,
                         int boardSize)
                                  throws GtpError

Utility function for parsing a point argument.

Parameters:

cmdArray - Command line split into words.

boardSize - Board size is needed for parsing the point

Returns:

GoPoint argument

Throws:

GtpError

parsePointListArgument

public static PointList parsePointListArgument(java.lang.String[] cmdArray,
                               int boardSize)
                                        throws GtpError

Utility function for parsing an point list argument.

Parameters:

cmdArray - Command line split into words.

boardSize - Board size is needed for parsing the points

Returns:

Point list argument

Throws:

GtpError

printInvalidResponse

public void printInvalidResponse(java.lang.String text)

Print invalid response directly to output stream. Should only be used for simulationg broken GTP implementations like used in the gogui-dummy_invalid command.

Parameters:

text - Text to print to output stream. No newline will be appended.

register

public final void register(java.lang.String command,
            GtpCallback callback)

Register new command. If a command was already registered with the same name, it will be replaced by the new command.

respond

public void respond(boolean status,
           boolean hasId,
           int id,
           java.lang.String response)

setQuit

public void setQuit()

Set quit flag for terminating command loop.

setName

public void setName(java.lang.String name)

Set name for name command.

setVersion

public void setVersion(java.lang.String version)

Set version for version command.

unregister

public final void unregister(java.lang.String command)

isInterrupted

protected boolean isInterrupted()