GUIInterface.java

/*
    DroidFish - An Android chess program.
    Copyright (C) 2011-2012  Peter Österlund, peterosterlund2@gmail.com

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

package org.petero.droidfish;

import java.util.ArrayList;

import org.petero.droidfish.gamelogic.Game;
import org.petero.droidfish.gamelogic.Move;
import org.petero.droidfish.gamelogic.Position;

/** Interface between the GUI and the ChessController. */
public interface GUIInterface {

    /** Update the displayed board position. */
    void setPosition(Position pos, String variantInfo, ArrayList<Move> variantMoves);

    /** Mark square sq as selected. Set to -1 to clear selection. */
    void setSelection(int sq);

    final static class GameStatus {
        public Game.GameState state = Game.GameState.ALIVE;
        public int moveNr = 0;
        /** Move required to claim draw, or empty string. */
        public String drawInfo = "";
        public boolean white = false;
        public boolean ponder = false;
        public boolean thinking = false;
        public boolean analyzing = false;
    }

    /** Set the status text. */
    void setStatus(GameStatus status);

    /** Update the list of moves. */
    void moveListUpdated();

    final public static class ThinkingInfo {
        public int id;
        public String pvStr;
        public String statStr;
        public String bookInfo;
        public ArrayList<ArrayList<Move>> pvMoves;
        public ArrayList<Move> bookMoves;
        public String eco;
        public int distToEcoTree;
    }

    /** Update the computer thinking information. */
    void setThinkingInfo(ThinkingInfo ti);

    /** Ask what to promote a pawn to. Should call reportPromotePiece() when done. */
    void requestPromotePiece();

    /** Run code on the GUI thread. */
    void runOnUIThread(Runnable runnable);

    /** Report that user attempted to make an invalid move. */
    void reportInvalidMove(Move m);

    /** Report UCI engine name. */
    void reportEngineName(String engine);

    /** Report UCI engine error message. */
    void reportEngineError(String errMsg);

    /** Called when a move is played. GUI can notify user, for example by playing a sound. */
    void movePlayed(Position pos, Move move, boolean computerMove);

    /** Report remaining thinking time to GUI. */
    void setRemainingTime(int wTime, int bTime, int nextUpdate);

    /** Update engine title text. */
    void updateEngineTitle();

    /** Update title with the material difference. */
    void updateMaterialDifferenceTitle(Util.MaterialDiff diff);

    /** Update title with time control information. */
    void updateTimeControlTitle();

    /** Report a move made that is a candidate for GUI animation. */
    void setAnimMove(Position sourcePos, Move move, boolean forward);

    /** Return true if positive analysis scores means good for white. */
    boolean whiteBasedScores();

    /** Return true if pondering (permanent brain) is enabled. */
    boolean ponderMode();

    /** Get the default player name. */
    String playerName();

    /** Return true if only main-line moves are to be kept. */
    boolean discardVariations();
}