com.fathzer.jchess.uci.Engine Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of jchess-uci Show documentation
There is a newer version: 2.0.0
package com.fathzer.jchess.uci;

import com.fathzer.jchess.uci.option.Option;

/** An engine able to respond to UCI protocol.
 */
public interface Engine {
	/** Gets the engine's id, the one returned when a uci command is received.
	 * @return a non null String
	 */
	String getId();
	/** Gets the engine's author, the one returned when a uci command is received.
	 * @return a String. Null if author is unknown (this is the default implementation).
	 */
	default String getAuthor() {
		return null;
	}
	/** Clears all data from previous game.
	 * 
The default implementation does nothing
	 */
	default void newGame() {
		// Does nothing by default, assuming the engine do not have cached things
	}
	/** Checks whether this engine supports Chess960.
	 * @return true if chess960 is supported, false (the default) if not.
	 */
	default boolean isChess960Supported() {
		return false;
	}
	/** Switches the Chess960 mode.
	 * 
The default implementation does nothing 
	 * @param chess960Mode true to start playing with chess 960 rules.
	 */
	default void setChess960(boolean chess960Mode) {
		// Does nothing by default
	}
	/** Gets the options supported by the engine.
	 * 
This method is called once during the engine instanciation.
	 * 
The default implementation returns an empty array.
	 * @return An option array.
	 * 
Please note that there's no need to send the UCI_Chess960 if chess960 is supported. This option will be automatically added if {@link #isChess960Supported()} returns true.
	 */
	default Option[] getOptions() {
		// By default engine has no option
		return new Option[0];
	}
	/** Sets the start position.
	 * @param fen The start position in the fen format.
	 */
	void setStartPosition(String fen);
	/** Moves a piece on the chess board.
	 * @param move The move to apply.
	 */
	void move(UCIMove move);
	/** Start searching for the best move.
	 * 
Please note that:
 	 * The returned task is considered as a 'long running method' and its supplier will be called on a different thread than methods of this class.
	 * The supplier should be cooperative with the stopper; It should end as quickly as possible when stopper is invoked and always return a move.
	 * 
	 * @param params The go parameters.
	 * @return A long running task able to compute the engine's move.
	 */
	LongRunningTask go(GoOptions params);
	
	/** Returns a string representation of the board.
	 * 
The representation is totally free. The default implementation returns the fen representation.
	 * @return A string representing the chess board.
	 */
	default String getBoardAsString() {
		final String fen = getFEN();
		return fen == null ? "no position defined" : fen;
	}
	/** Returns the FEN representation of the board.
	 * @return a string representing the chess board. Null if no position were defined
	 */
	String getFEN();
}