src/chess/rules.c

/*
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
 *
 * Copyright 2016 Mike Becker. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 *   1. Redistributions of source code must retain the above copyright
 *      notice, this list of conditions and the following disclaimer.
 *
 *   2. Redistributions in binary form must reproduce the above copyright
 *      notice, this list of conditions and the following disclaimer in the
 *      documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 */

#include "rules.h"
#include "pawn.h"
#include "rook.h"
#include "knight.h"
#include "bishop.h"
#include "queen.h"
#include "king.h"

#include <string.h>
#include <stdio.h>
#include <stdlib.h>
#include <sys/time.h>

static GameState gamestate_copy_sim(GameState *gamestate) {
    GameState simulation = *gamestate;

    // create a new move list for the simulation
    simulation.movecapacity = 4;
    simulation.movecount = 0;
    simulation.moves = malloc(4 * sizeof(Move));

    // copy the most recent move if a move was played
    if (gamestate->movecount > 0) {
        simulation.moves[0] = last_move(gamestate);
        simulation.movecount++;
    }

    return simulation;
}

/* MUST be called BETWEEN validating AND applying a move to work correctly */
static void format_move(GameState *gamestate, Move *move) {
    char *string = &(move->string[0]);
    
    /* at least 8 characters should be available, wipe them out */
    memset(string, 0, 8);
    
    unsigned int idx;
    if ((move->piece&PIECE_MASK) == KING &&
            abs(move->tofile-move->fromfile) == 2) {
        /* special formats for castling */
        if (move->tofile==fileidx('c')) {
            memcpy(string, "O-O-O", 5);
            idx = 5;
        } else {
            memcpy(string, "O-O", 3);
            idx = 3;
        }
    } else {
        /* start by notating the piece character */
        string[0] = getpiecechr(move->piece);
        idx = string[0] ? 1 : 0;

        /* find out how many source information we do need */
        uint8_t piece = move->piece & PIECE_MASK;
        if (piece == PAWN) {
            if (move->capture) {
                string[idx++] = filechr(move->fromfile);
            }
        } else if (piece != KING) {
            /* resolve ambiguities, if any */
            Move threats[16];
            uint8_t threatcount;
            if (get_threats(gamestate, move->torow, move->tofile,
                    move->piece&COLOR_MASK, threats, &threatcount)) {
                unsigned int ambrows = 0, ambfiles = 0, ambpiece = 0;
                for (uint8_t i = 0 ; i < threatcount ; i++) {
                    if (threats[i].piece == move->piece) {
                        ambpiece++;
                        if (threats[i].fromrow == move->fromrow) {
                            ambrows++;
                        }
                        if (threats[i].fromfile == move->fromfile) {
                            ambfiles++;
                        }
                    }
                }
                /* neither file, nor row are ambiguous, name file */
                if (ambpiece > 1 && ambrows == 1 && ambfiles == 1) {
                    /* this is most likely the case with Knights
                     * in diagonal opposition */
                    string[idx++] = filechr(move->fromfile);
                } else {
                    /* ambiguous row, name file */
                    if (ambrows > 1) {
                        string[idx++] = filechr(move->fromfile);
                    }
                    /* ambiguous file, name row */
                    if (ambfiles > 1) {
                        string[idx++] = filechr(move->fromrow);
                    }
                }
            }
        }

        /* capturing? */
        if (move->capture) {
            string[idx++] = 'x';
        }

        /* destination */
        string[idx++] = filechr(move->tofile);
        string[idx++] = rowchr(move->torow);

        /* promotion? */
        if (move->promotion) {
            string[idx++] = '=';
            string[idx++] = getpiecechr(move->promotion);
        }
    }
    
    /* check? */
    if (move->check) {
        string[idx++] = gamestate->checkmate?'#':'+';
    }
}

static void addmove(GameState* gamestate, Move *data) {
    if (gamestate->movecount == gamestate->movecapacity) {
        gamestate->movecapacity += 64; /* 32 more full moves */
        gamestate->moves = realloc(gamestate->moves,
            gamestate->movecapacity * sizeof(Move));
    }

    Move *move = &gamestate->moves[gamestate->movecount];
    *move = *data;

    struct timeval curtimestamp;
    gettimeofday(&curtimestamp, NULL);
    move->timestamp.tv_sec = curtimestamp.tv_sec;
    move->timestamp.tv_usec = (int32_t) curtimestamp.tv_usec;
    
    if (gamestate->movecount > 1) {
        struct movetimeval lasttstamp = last_move(gamestate).timestamp;
        uint64_t sec = curtimestamp.tv_sec - lasttstamp.tv_sec;
        suseconds_t micros;
        if (curtimestamp.tv_usec < lasttstamp.tv_usec) {
            micros = 1000000-(lasttstamp.tv_usec - curtimestamp.tv_usec);
            sec--;
        } else {
            micros = curtimestamp.tv_usec - lasttstamp.tv_usec;
        }
        
        move->movetime.tv_sec = sec;
        move->movetime.tv_usec = (int32_t) micros;
    } else {
        /* no move time for the first move of both white and black */
        move->movetime.tv_usec = 0;
        move->movetime.tv_sec = 0;
    }
    gamestate->movecount++;
}

char getpiecechr(uint8_t piece) {
    switch (piece & PIECE_MASK) {
    case ROOK: return 'R';
    case KNIGHT: return 'N';
    case BISHOP: return 'B';
    case QUEEN: return 'Q';
    case KING: return 'K';
    default: return '\0';
    }
}

char* getpieceunicode(uint8_t piece) {
    switch (piece & PIECE_MASK) {
    case PAWN: return "\u265f";
    case ROOK: return "\u265c";
    case KNIGHT: return "\u265e";
    case BISHOP: return "\u265d";
    case QUEEN: return "\u265b";
    case KING: return "\u265a";
    default: return "";
    }
}

uint8_t getpiece(char c) {
    switch (c) {
        case 'R': return ROOK;
        case 'N': return KNIGHT;
        case 'B': return BISHOP;
        case 'Q': return QUEEN;
        case 'K': return KING;
        default: return 0;
    }
}

static void apply_move_impl(GameState *gamestate, Move *move, bool simulate) {
    /* format move before moving (s.t. ambiguities can be resolved) */
    if (!simulate) {
        if (!move->string[0]) {
            format_move(gamestate, move);
        }
    }
    
    uint8_t piece = move->piece & PIECE_MASK;
    uint8_t color = move->piece & COLOR_MASK;
    
    /* en passant capture */
    if (move->capture && piece == PAWN &&
        mdst(gamestate->board, move) == 0) {
        gamestate->board[move->fromrow][move->tofile] = 0;
    }
    
    /* remove old en passant threats */
    for (uint8_t file = 0 ; file < 8 ; file++) {
        gamestate->board[3][file] &= ~ENPASSANT_THREAT;
        gamestate->board[4][file] &= ~ENPASSANT_THREAT;
    }
    
    /* add new en passant threat */
    if (piece == PAWN && (
        (move->fromrow == 1 && move->torow == 3) ||
        (move->fromrow == 6 && move->torow == 4))) {
        move->piece |= ENPASSANT_THREAT;
    }
    
    /* move (and maybe capture or promote) */
    msrc(gamestate->board, move) = 0;
    if (move->promotion) {
        mdst(gamestate->board, move) = move->promotion;
    } else {
        mdst(gamestate->board, move) = move->piece;
    }
    
    /* castling */
    if (piece == KING && move->fromfile == fileidx('e')) {
        if (move->tofile == fileidx('g')) {
            gamestate->board[move->torow][fileidx('h')] = 0;
            gamestate->board[move->torow][fileidx('f')] = color|ROOK;
        } else if (move->tofile == fileidx('c')) {
            gamestate->board[move->torow][fileidx('a')] = 0;
            gamestate->board[move->torow][fileidx('d')] = color|ROOK;
        }
    }
    
    /* add move, even in simulation (checkmate test needs it) */
    addmove(gamestate, move);
}

void apply_move(GameState *gamestate, Move *move) {
    apply_move_impl(gamestate, move, 0);
}

static int validate_move_rules(GameState *gamestate, Move *move) {
    /* validate indices (don't trust opponent) */
    if (!chkidx(move)) {
        return INVALID_POSITION;
    }
    
    /* must move */
    if (move->fromfile == move->tofile && move->fromrow == move->torow) {
        return INVALID_MOVE_SYNTAX;
    }
    
    /* does piece exist */
    if ((msrc(gamestate->board, move)&(PIECE_MASK|COLOR_MASK))
           != (move->piece&(PIECE_MASK|COLOR_MASK))) {
        return INVALID_POSITION;
    }
    
    /* can't capture own pieces */
    if ((mdst(gamestate->board, move) & COLOR_MASK)
            == (move->piece & COLOR_MASK)) {
        return RULES_VIOLATED;
    }
    
    /* must capture, if and only if destination is occupied */
    if ((mdst(gamestate->board, move) == 0 && move->capture) ||
            (mdst(gamestate->board, move) != 0 && !move->capture)) {
        return INVALID_MOVE_SYNTAX;
    }
    
    /* validate individual rules */
    bool chkrules;
    switch (move->piece & PIECE_MASK) {
    case PAWN:
        chkrules = pawn_chkrules(gamestate, move) &&
            !pawn_isblocked(gamestate, move);
        break;
    case ROOK:
        chkrules = rook_chkrules(move) &&
            !rook_isblocked(gamestate, move);
        break;
    case KNIGHT:
        chkrules = knight_chkrules(move); /* knight is never blocked */
        break;
    case BISHOP:
        chkrules = bishop_chkrules(move) &&
            !bishop_isblocked(gamestate, move);
        break;
    case QUEEN:
        chkrules = queen_chkrules(move) &&
            !queen_isblocked(gamestate, move);
        break;
    case KING:
        chkrules = king_chkrules(gamestate, move) &&
            !king_isblocked(gamestate, move);
        break;
    default:
        return INVALID_MOVE_SYNTAX;
    }
    
    return chkrules ? VALID_MOVE_SEMANTICS : RULES_VIOLATED;
}

int validate_move(GameState *gamestate, Move *move) {
    
    int result = validate_move_rules(gamestate, move);
    
    /* cancel processing to save resources */
    if (result != VALID_MOVE_SEMANTICS) {
        return result;
    }
    
    /* simulate move for check validation */
    GameState simulation = gamestate_copy_sim(gamestate);
    Move simmove = *move;
    apply_move_impl(&simulation, &simmove, 1);
    
    /* find kings for check validation */
    uint8_t piececolor = (move->piece & COLOR_MASK);
    
    uint8_t mykingfile = 0, mykingrow = 0, opkingfile = 0, opkingrow = 0;
    for (uint8_t row = 0 ; row < 8 ; row++) {
        for (uint8_t file = 0 ; file < 8 ; file++) {
            if (simulation.board[row][file] ==
                    (piececolor == WHITE?WKING:BKING)) {
                mykingfile = file;
                mykingrow = row;
            } else if (simulation.board[row][file] ==
                    (piececolor == WHITE?BKING:WKING)) {
                opkingfile = file;
                opkingrow = row;
            }
        }
    }
    
    /* don't move into or stay in check position */
    if (is_covered(&simulation, mykingrow, mykingfile,
        opponent_color(piececolor))) {
        
        gamestate_cleanup(&simulation);
        if ((move->piece & PIECE_MASK) == KING) {
            return KING_MOVES_INTO_CHECK;
        } else {
            /* last move is always not null in this case */
            return last_move(gamestate).check ?
                KING_IN_CHECK : PIECE_PINNED;
        }
    }
    
    /* correct check and checkmate flags (move is still valid) */
    Move threats[16];
    uint8_t threatcount;
    move->check = get_threats(&simulation, opkingrow, opkingfile,
        piececolor, threats, &threatcount);
    
    if (move->check) {
        /* determine possible escape fields */
        bool canescape = false;
        for (int dr = -1 ; dr <= 1 && !canescape ; dr++) {
            for (int df = -1 ; df <= 1 && !canescape ; df++) {
                if (!(dr == 0 && df == 0)  &&
                        isidx(opkingrow + dr) && isidx(opkingfile + df)) {
                    
                    /* escape field neither blocked nor covered */
                    if ((simulation.board[opkingrow + dr][opkingfile + df]
                            & COLOR_MASK) != opponent_color(piececolor)) {
                        canescape |= !is_covered(&simulation,
                            opkingrow + dr, opkingfile + df, piececolor);
                    }
                }
            }
        }
        /* can't escape, can he capture? */
        if (!canescape && threatcount == 1) {
            canescape = is_attacked(&simulation, threats[0].fromrow,
                threats[0].fromfile, opponent_color(piececolor));
        }
        
        /* can't capture, can he block? */
        if (!canescape && threatcount == 1) {
            Move *threat = &(threats[0]);
            uint8_t threatpiece = threat->piece & PIECE_MASK;
            
            /* knight, pawns and the king cannot be blocked */
            if (threatpiece == BISHOP || threatpiece == ROOK
                || threatpiece == QUEEN) {
                if (threat->fromrow == threat->torow) {
                    /* rook aspect (on row) */
                    int d = threat->tofile > threat->fromfile ? 1 : -1;
                    uint8_t file = threat->fromfile;
                    while (!canescape && file != threat->tofile - d) {
                        file += d;
                        canescape |= is_protected(&simulation,
                            threat->torow, file, opponent_color(piececolor));
                    }
                } else if (threat->fromfile == threat->tofile) {
                    /* rook aspect (on file) */
                    int d = threat->torow > threat->fromrow ? 1 : -1;
                    uint8_t row = threat->fromrow;
                    while (!canescape && row != threat->torow - d) {
                        row += d;
                        canescape |= is_protected(&simulation,
                            row, threat->tofile, opponent_color(piececolor));
                    }
                } else {
                    /* bishop aspect */
                    int dr = threat->torow > threat->fromrow ? 1 : -1;
                    int df = threat->tofile > threat->fromfile ? 1 : -1;

                    uint8_t row = threat->fromrow;
                    uint8_t file = threat->fromfile;
                    while (!canescape && file != threat->tofile - df
                        && row != threat->torow - dr) {
                        row += dr;
                        file += df;
                        canescape |= is_protected(&simulation, row, file,
                            opponent_color(piececolor));
                    }
                }
            }
        }
            
        if (!canescape) {
            gamestate->checkmate = 1;
        }
    }
    
    gamestate_cleanup(&simulation);
    
    return VALID_MOVE_SEMANTICS;
}

bool get_threats(GameState *gamestate, uint8_t row, uint8_t file,
        uint8_t color, Move *threats, uint8_t *threatcount) {
    Move candidates[32];
    int candidatecount = 0;
    for (uint8_t r = 0 ; r < 8 ; r++) {
        for (uint8_t f = 0 ; f < 8 ; f++) {
            if ((gamestate->board[r][f] & COLOR_MASK) == color) {
                /* non-capturing move */
                memset(&(candidates[candidatecount]), 0, sizeof(Move));
                candidates[candidatecount].piece = gamestate->board[r][f];
                candidates[candidatecount].fromrow = r;
                candidates[candidatecount].fromfile = f;
                candidates[candidatecount].torow = row;
                candidates[candidatecount].tofile = file;
                candidatecount++;

                /* capturing move */
                memcpy(&(candidates[candidatecount]),
                    &(candidates[candidatecount-1]), sizeof(Move));
                candidates[candidatecount].capture = 1;
                candidatecount++;
            }
        }
    }

    if (threatcount) {
        *threatcount = 0;
    }
    
    
    bool result = false;
    
    for (int i = 0 ; i < candidatecount ; i++) {
        if (validate_move_rules(gamestate, &(candidates[i]))
                == VALID_MOVE_SEMANTICS) {
            result = true;
            if (threats && threatcount) {
                threats[(*threatcount)++] = candidates[i];
            }
        }
    }
    
    return result;
}

bool is_pinned(GameState *gamestate, Move *move) {
    uint8_t color = move->piece & COLOR_MASK;

    GameState simulation = gamestate_copy_sim(gamestate);
    Move simmove = *move;
    apply_move(&simulation, &simmove);
    
    uint8_t kingfile = 0, kingrow = 0;
    for (uint8_t row = 0 ; row < 8 ; row++) {
        for (uint8_t file = 0 ; file < 8 ; file++) {
            if (simulation.board[row][file] == (color|KING)) {
                kingfile = file;
                kingrow = row;
            }
        }
    }
    
    bool covered = is_covered(&simulation,
        kingrow, kingfile, opponent_color(color));
    gamestate_cleanup(&simulation);
    
    return covered;
}

bool get_real_threats(GameState *gamestate, uint8_t row, uint8_t file,
        uint8_t color, Move *threats, uint8_t *threatcount) {
    
    if (threatcount) {
        *threatcount = 0;
    }

    Move candidates[16];
    uint8_t candidatecount;
    if (get_threats(gamestate, row, file, color, candidates, &candidatecount)) {
        
        bool result = false;
        uint8_t kingfile = 0, kingrow = 0;
        for (uint8_t r = 0 ; r < 8 ; r++) {
            for (uint8_t f = 0 ; f < 8 ; f++) {
                if (gamestate->board[r][f] == (color|KING)) {
                    kingfile = f;
                    kingrow = r;
                }
            }
        }

        for (uint8_t i = 0 ; i < candidatecount ; i++) {
            GameState simulation = gamestate_copy_sim(gamestate);
            Move simmove = candidates[i];
            apply_move(&simulation, &simmove);
            if (!is_covered(&simulation, kingrow, kingfile,
                    opponent_color(color))) {
                result = true;
                if (threats && threatcount) {
                    threats[(*threatcount)++] = candidates[i];
                }
            }
        }
        
        return result;
    } else {
        return false;
    }
}

static int getlocation(GameState *gamestate, Move *move) {   

    uint8_t color = move->piece & COLOR_MASK;
    uint8_t piece = move->piece & PIECE_MASK;
    bool incheck = gamestate->movecount > 0 ? last_move(gamestate).check:false;
    
    Move threats[16], *threat = NULL;
    uint8_t threatcount;
    
    if (get_threats(gamestate, move->torow, move->tofile, color,
            threats, &threatcount)) {
        
        int reason = INVALID_POSITION;
        
        /* find threats for the specified position */
        for (uint8_t i = 0 ; i < threatcount ; i++) {            
            if ((threats[i].piece & PIECE_MASK) == piece
                    && (threats[i].piece & COLOR_MASK) == color &&
                    (move->fromrow == POS_UNSPECIFIED ||
                    move->fromrow == threats[i].fromrow) &&
                    (move->fromfile == POS_UNSPECIFIED ||
                    move->fromfile == threats[i].fromfile)) {

                if (threat) {
                    return AMBIGUOUS_MOVE;
                } else {
                    /* found threat is no real threat */
                    if (is_pinned(gamestate, &(threats[i]))) {
                        reason = incheck?KING_IN_CHECK:
                            (piece==KING?KING_MOVES_INTO_CHECK:PIECE_PINNED);
                    } else {
                        threat = &(threats[i]);
                    }
                }
            }
        }
        
        /* can't threaten specified position */
        if (!threat) {
            return reason;
        }

        memcpy(move, threat, sizeof(Move));
        return VALID_MOVE_SYNTAX;
    } else {
        return INVALID_POSITION;
    }
}

int eval_move(GameState *gamestate, char *mstr, Move *move, uint8_t color) {
    memset(move, 0, sizeof(Move));
    move->fromfile = POS_UNSPECIFIED;
    move->fromrow = POS_UNSPECIFIED;

    size_t len = strlen(mstr);
    if (len < 1 || len > 6) {
        return INVALID_MOVE_SYNTAX;
    }
    
    /* evaluate check/checkmate flags */
    if (mstr[len-1] == '+') {
        len--; mstr[len] = '\0';
        move->check = 1;
    } else if (mstr[len-1] == '#') {
        len--; mstr[len] = '\0';
        /* ignore - validation should set game state */
    }
    
    /* evaluate promotion */
    if (len > 3 && mstr[len-2] == '=') {
        move->promotion = getpiece(mstr[len-1]);
        if (!move->promotion) {
            return INVALID_MOVE_SYNTAX;
        } else {
            move->promotion |= color;
            len -= 2;
            mstr[len] = 0;
        }
    }
    
    if (len == 2) {
        /* pawn move (e.g. "e4") */
        move->piece = PAWN;
        move->tofile = fileidx(mstr[0]);
        move->torow = rowidx(mstr[1]);
    } else if (len == 3) {
        if (strcmp(mstr, "O-O") == 0) {
            /* king side castling */
            move->piece = KING;
            move->fromfile = fileidx('e');
            move->tofile = fileidx('g');
            move->fromrow = move->torow = color == WHITE ? 0 : 7;
        } else {
            /* move (e.g. "Nf3") */
            move->piece = getpiece(mstr[0]);
            move->tofile = fileidx(mstr[1]);
            move->torow = rowidx(mstr[2]);
        }
    } else if (len == 4) {
        move->piece = getpiece(mstr[0]);
        if (!move->piece) {
            move->piece = PAWN;
            move->fromfile = fileidx(mstr[0]);
        }
        if (mstr[1] == 'x') {
            /* capture (e.g. "Nxf3", "dxe5") */
            move->capture = 1;
        } else {
            /* move (e.g. "Ndf3", "N2c3", "e2e4") */
            if (isfile(mstr[1])) {
                move->fromfile = fileidx(mstr[1]);
                if (move->piece == PAWN) {
                    move->piece = 0;
                }
            } else {
                move->fromrow = rowidx(mstr[1]);
            }
        }
        move->tofile = fileidx(mstr[2]);
        move->torow = rowidx(mstr[3]);
    } else if (len == 5) {
        if (strcmp(mstr, "O-O-O") == 0) {
            /* queen side castling "O-O-O" */
            move->piece = KING;
            move->fromfile = fileidx('e');
            move->tofile = fileidx('c');
            move->fromrow = move->torow = color == WHITE ? 0 : 7;
        } else {
            move->piece = getpiece(mstr[0]);
            if (mstr[2] == 'x') {
                move->capture = 1;
                if (move->piece) {
                    /* capture (e.g. "Ndxf3") */
                    move->fromfile = fileidx(mstr[1]);
                } else {
                    /* long notation capture (e.g. "e5xf6") */
                    move->piece = PAWN;
                    move->fromfile = fileidx(mstr[0]);
                    move->fromrow = rowidx(mstr[1]);
                }
            } else {
                /* long notation move (e.g. "Nc5a4") */
                move->fromfile = fileidx(mstr[1]);
                move->fromrow = rowidx(mstr[2]);
            }
            move->tofile = fileidx(mstr[3]);
            move->torow = rowidx(mstr[4]);
        }
    } else if (len == 6) {
        /* long notation capture (e.g. "Nc5xf3") */
        if (mstr[3] == 'x') {
            move->capture = 1;
            move->piece = getpiece(mstr[0]);
            move->fromfile = fileidx(mstr[1]);
            move->fromrow = rowidx(mstr[2]);
            move->tofile = fileidx(mstr[4]);
            move->torow = rowidx(mstr[5]);
        }
    }

    
    if (move->piece) {
        if (move->piece == PAWN
            && move->torow == (color==WHITE?7:0)
            && !move->promotion) {
            return NEED_PROMOTION;
        }
        
        move->piece |= color;
        if (move->fromfile == POS_UNSPECIFIED
            || move->fromrow == POS_UNSPECIFIED) {
            return getlocation(gamestate, move);
        } else {
            return chkidx(move) ? VALID_MOVE_SYNTAX : INVALID_POSITION;
        }
    } else {
        return INVALID_MOVE_SYNTAX;
    }
}

bool is_protected(GameState *gamestate, uint8_t row, uint8_t file,
        uint8_t color) {
    
    Move threats[16];
    uint8_t threatcount;
    if (get_real_threats(gamestate, row, file, color, threats, &threatcount)) {
        for (int i = 0 ; i < threatcount ; i++) {
            if (threats[i].piece != (color|KING)) {
                return true;
            }
        }
        return false;
    } else {
        return false;
    }
}

uint16_t remaining_movetime(GameInfo *gameinfo, GameState *gamestate,
        uint8_t color) {
    unsigned move_number = gamestate->movecount;
    if (color == BLACK) {
        move_number |= 1;
    } else {
        move_number = (move_number + 1) & ~1;
    }
    return remaining_movetime2(gameinfo, gamestate, move_number);
}

uint16_t remaining_movetime2(GameInfo *gameinfo, GameState *gamestate,
        unsigned move_number) {
    if (!gameinfo->timecontrol) {
        return 0;
    }

    unsigned total_time = gameinfo->time;
    unsigned used_time = 0;
    suseconds_t micros = 0;

    /* go through all already played moves */
    unsigned first_move = move_number % 2;
    unsigned next_move = move_number;
    if (next_move > gamestate->movecount) next_move = gamestate->movecount;
    for (unsigned i = first_move ; i < next_move ; i += 2) {
        used_time += gamestate->moves[i].movetime.tv_sec;
        micros += gamestate->moves[i].movetime.tv_usec;
        /* add increments starting with move 2 */
        if (i > 1) total_time += gameinfo->addtime;
    }

    /* when the player is currently playing, count down the clock */
    if (is_game_running(gamestate) && move_number > 1 &&
            move_number == gamestate->movecount) {
        struct movetimeval lastmovetstamp =
            gamestate->moves[move_number - 1].timestamp;
        struct timeval currenttstamp;
        gettimeofday(&currenttstamp, NULL);
        used_time += currenttstamp.tv_sec - lastmovetstamp.tv_sec;
        micros += currenttstamp.tv_usec - lastmovetstamp.tv_usec;
    }

    /* apply the microseconds */
    used_time += micros / 1000000;

    return used_time >= total_time ? 0 : total_time - used_time;
}

void print_clk(uint16_t time, char *str, bool always_hours) {
    unsigned hours = time / 3600;
    unsigned minutes = (time % 3600) / 60;
    unsigned seconds = time % 60;
    if (hours > 0 || always_hours) {
        snprintf(str, 9, "%02u:%02u:%02u", hours, minutes, seconds);
    } else {
        snprintf(str, 6, "%02u:%02u", minutes, seconds);
    }
}