net.sf.gogui.gtp

Class GtpCommand

java.lang.Object

net.sf.gogui.gtp.GtpCommand

public class GtpCommand
extends java.lang.Object

GTP command. Handles parsing the command line and storing the response to the command. Arguments containing whitespaces can be quoted with double quotes ("). The responses are allowed to contain consecutive new lines. They will be replaced in GtpEngine.mainLoop() by lines containing a single space to form a valid GTP response.

Constructor Summary

Constructors

Constructor and Description
GtpCommand(java.lang.String line) Construct command from command line.

Method Summary

Methods

Modifier and Type	Method and Description
void	checkArgNone() Check that command has no arguments.
void	checkNuArg(int n) Check that command has n arguments.
void	checkNuArgLessEqual(int n) Check that command has not more than n arguments.
java.lang.String	getArg()
java.lang.String	getArg(int i) Get argument.
java.lang.String	getArgLine() Get argument line.
GoColor	getColorArg() Get single color argument.
GoColor	getColorArg(int i) Get color argument.
java.lang.String	getCommand() Get command.
double	getDoubleArg() Get single floating point number argument.
double	getDoubleArg(int i) Get floating point number argument.
int	getId() Get command ID.
int	getIntArg() Get single integer argument.
int	getIntArg(int i) Get integer argument.
int	getIntArg(int i, int min, int max) Get integer argument in a range.
java.lang.String	getLine() Full command line without ID.
int	getNuArg() Get number of arguments.
GoPoint	getPointArg(int i, int boardSize) Get point argument.
PointList	getPointListArg(int boardSize) Get point arguments.
java.lang.StringBuilder	getResponse() Get string buffer for construction the response.
boolean	hasId() Check if command has an ID.
boolean	isQuit() Check if command is quit command.
void	setResponse(java.lang.String response) Set the response.

Methods inherited from class java.lang.Object

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

Constructor Detail

GtpCommand

public GtpCommand(java.lang.String line)

Construct command from command line.

Parameters:

line - The full command line including ID.

Method Detail

checkArgNone

public void checkArgNone()
                  throws GtpError

Check that command has no arguments.

Throws:

GtpError - If command has any arguments.

checkNuArg

public void checkNuArg(int n)
                throws GtpError

Check that command has n arguments.

Throws:

GtpError - If command has not n arguments.

checkNuArgLessEqual

public void checkNuArgLessEqual(int n)
                         throws GtpError

Check that command has not more than n arguments.

Throws:

GtpError - If command has more than n arguments.

hasId

public boolean hasId()

Check if command has an ID.

Returns:

true, if command has an ID.

getArg

public java.lang.String getArg()
                        throws GtpError

Throws:

GtpError

getArg

public java.lang.String getArg(int i)
                        throws GtpError

Get argument.

Parameters:

i - The index of the argument (starting with zero).

Returns:

The argument.

Throws:

GtpError - If command has not enough arguments.

getArgLine

public java.lang.String getArgLine()

Get argument line. Get a string containing all arguments (the command line without ID and command; leading and trailing whitespaces trimmed).

Returns:

The argument line.

getColorArg

public GoColor getColorArg()
                    throws GtpError

Get single color argument. Valid color strings are "b", "w", "black", "white" and the corresponding uppercase strings.

Returns:

The color.

Throws:

GtpError - If command has not exactly one argument or argument is not a color.

getColorArg

public GoColor getColorArg(int i)
                    throws GtpError

Get color argument. Valid color strings are "b", "w", "black", "white" and the corresponding uppercase strings.

Parameters:

i - The index of the argument (starting with zero).

Returns:

The color.

Throws:

GtpError - If command has not enough arguments or argument is not a color.

getCommand

public java.lang.String getCommand()

Get command.

Returns:

The command string (command line without ID and arguments, leading and trailing whitespaces trimmed).

getDoubleArg

public double getDoubleArg()
                    throws GtpError

Get single floating point number argument.

Returns:

The color.

Throws:

GtpError - If command has not exactly one argument or argument is not a floating point number.

getDoubleArg

public double getDoubleArg(int i)
                    throws GtpError

Get floating point number argument.

Parameters:

i - The index of the argument (starting with zero).

Returns:

The color.

Throws:

GtpError - If command has not enough arguments or argument is not a floating point number.

getIntArg

public int getIntArg()
              throws GtpError

Get single integer argument.

Returns:

The color.

Throws:

GtpError - If command has not exactly one argument or argument is not an integer.

getIntArg

public int getIntArg(int i)
              throws GtpError

Get integer argument.

Parameters:

i - The index of the argument (starting with zero).

Returns:

The color.

Throws:

GtpError - If command has not enough arguments or argument is not an integer.

getIntArg

public int getIntArg(int i,
            int min,
            int max)
              throws GtpError

Get integer argument in a range.

Parameters:

i - The index of the argument (starting with zero).

min - Minimum allowed value.

max - Maximum allowed value.

Returns:

The color.

Throws:

GtpError - If command has not enough arguments or argument is not an integer in the allowed range.

getPointArg

public GoPoint getPointArg(int i,
                  int boardSize)
                    throws GtpError

Get point argument. Valid point strings are as in GtpUtil.parsePoint (uppercase or lowercase coordinates, e.g. "A1", or "pass").

Parameters:

i - The index of the argument (starting with zero).

boardSize - The board size (points will be checked to be within this board size).

Returns:

The point.

Throws:

GtpError - If command has not enough arguments or argument is not a valid point.

getPointListArg

public PointList getPointListArg(int boardSize)
                          throws GtpError

Get point arguments. Valid point strings are as in GtpUtil.parsePoint (uppercase or lowercase coordinates, e.g. "A1", or "pass"). All arguments will be parsed as points.

Parameters:

boardSize - The board size (points will be checked to be within this board size).

Returns:

Point list containg the points.

Throws:

GtpError - If at least one argument is not a valid point.

getLine

public java.lang.String getLine()

Full command line without ID.

Returns:

The command line without ID.

getNuArg

public int getNuArg()

Get number of arguments.

Returns:

The number of arguments.

getResponse

public java.lang.StringBuilder getResponse()

Get string buffer for construction the response. The response to the command can be constructed by appending to this string buffer.

getId

public int getId()

Get command ID. It is allowed to call this function if command has no ID, but the returned value is undefined.

Returns:

The command ID.

isQuit

public boolean isQuit()

Check if command is quit command. DEPRECATED: Fix GtpEngine to use only GtpEngine.m_quit

Returns:

true, if command name is "quit".

setResponse

public void setResponse(java.lang.String response)

Set the response. Clears the string buffer containg the response and sets it to the given string.

Parameters:

response - The string containing the new response.