/**
 * @file ChineseChess.h.
 *
 * 中国象棋类，实现象棋的接口，各界面框架派生此类，然后实现其虚拟重载函数，实现其平台界面功能。
 * 
 */

#ifndef CHINESE_CHESS_H_KL_2020_05_13__
#define CHINESE_CHESS_H_KL_2020_05_13__

#pragma once

#include "GoRule.h"
#include "ChessGame.h"

#include "chinesechess_export.h"

/**
 * 中国象棋类
 * - 实现中国象棋的基本规则
 * - 实现复盘  
 * - 实现复盘棋局  
 * 
 * 界面部分由相应的界面派生类实现相应的虚拟函数
 * 
 * @see CPiece CGoRule CChessGame
 * @author 康林 <kl222@126.com>
 * @date 2020/5/17
 */
class CHINESECHESS_EXPORT CChineseChess
{
public:
    CChineseChess();
    virtual ~CChineseChess();
    
    /// 标准棋盘布局:详见《象棋竞赛规则(2011)》第一章 第1条。红棋在下，黑棋在上。
    /// 界面可以支持非标准棋盘布局（红在上，黑在下）
    /// @see CChessGame
    typedef enum  _ENUM_BoardLayout{
        NoQi = 0,
        OnlyTopBlack = 1,
        OnlyBottomRed = 2,
        SwapRedBetweenBlack = 4,
        OnlyTopRed = OnlyBottomRed | SwapRedBetweenBlack,
        OnlyBottomBlack = OnlyTopBlack | SwapRedBetweenBlack,
        TopBlackAndBottomRed = OnlyTopBlack | OnlyBottomRed,
        TopRedAndBottomBlack = TopBlackAndBottomRed | SwapRedBetweenBlack
    } ENUM_BoardLayout;
    int SetBoardLayout(ENUM_BoardLayout layout);
    ENUM_BoardLayout GetBoardLayout();
    
    /**
     * 走棋
     *
     * @author KangLin(kl222@126.com)
     * @date 2020/5/17
     *
     * @param  int i：当前下棋的位置,横坐标[0-8]
     * @param  int j：当前下棋的位置,纵坐标[0-9]
     * @param  bNext (Optional) 指示是否是在NextStep中调用
     * 				 如果是在 NextStep 中调用，则是在复盘
     * 				 如果不是。则是在正常下棋
     *
     * @returns True if it succeeds, false if it fails.
     */
    bool GoChess(int i, int j, bool bNext = false);	//走棋
    
    // 复盘操作
    int NextStep();	   //下一步
    int PreviouStep();     //上一步
    
    /**
     * 保存棋局。
     * 根据文件扩展名来保存为相应的格式。
     * 当前支持自定义格式、PGN格式
     */
    virtual int SaveChessGame(const char* pszFile);
    /**
     *  加载棋局。
     * 根据文件扩展名来解析文件的格式。
     * 当前支持自定义格式、PGN格式
     */
    virtual int LoadChessGame(const char* pszFile);
    time_t GetStartTime();
    int SetStartTime(const time_t &t);
    time_t GetEndTime();
    int SetEndTime(const time_t &t);
    std::string GetRedName();
    int SetRedName(const char* pszName);
    std::string GetBlackName();
    int SetBlackName(const char* pszName);
    std::string GetGameTag(const std::string &tag);
    int AddGameTag(const std::string &szTag, const std::string &szVal);
    
    int EnablePromptSound(bool sound = true);
    bool getEnablePromptSound();
    int EnablePromptMessage(bool bMsg = true);
    bool getEnablePromptMessage();
    
protected:
    // 下列虚拟函数由界面实现类完成
    
    /// 提示音
    enum PROMPT_SOUND {
        JiangJun, //< 将军
        Eat,      //< 吃子
        Go,       //< 走棋
        NoGo,     //< 不能走
        Select    //< 选棋
    };
    virtual int onPromptSound(PROMPT_SOUND sound = NoGo) = 0;
    /// 提示错误消息
    virtual int onPromptMessage(CGoRule::ENUM_ReturnValue val) = 0;
    /// 清除提示框
    virtual int onCleanPrompt(int i, int j) = 0;
    /// 画提示框
    virtual int onDrawPrompt(int i, int j) = 0;
    /// 走棋事件
    // @see m_ChessBoard
    virtual int onGoChess(int i, int j, CPiece::ENUM_QiZi chess) = 0;
    
private:
    // 判断当前着法是否合法
    bool IsGoChess(int i, int j);
    
    CGoRule m_GoRule;  //下棋规则
    CChessGame m_Game; //棋局
    
    bool m_bPromptSound;
    bool m_bPromptMessage;
    
protected:
    /**
            @brief 棋盘描述
            
            @details 
            @code
            
            [0][0] ------------------> i 或 x 方向
                   |
                   |
                   |
                   |       [i][j]
                   |
                   |
                  \|/                 [9][10]
                   |
              j 或 y 方向
              
            @endcode
            
            @see CChessGame
    */
    CPiece::ENUM_QiZi m_ChessBoard[9][10]; //棋盘 m_ChessBoard[i][j]
    ENUM_BoardLayout m_BoardLayout;		   //棋盘布局
    
    //走棋状态，行棋，红方先行：详见《象棋竞赛规则(2011)》第一章 第2条
    typedef enum _ENUM_WalkState {
        RedReadly,
        RedWalked,
        BlackReadly,
        BlackWalked
    } ENUM_WalkState;			
    ENUM_WalkState m_WalkState;	//走棋状态（红方选棋，红方走棋，黑方先棋，黑方走棋）
    
    // 提示框
    // 上一步棋的位置
    int m_PreviouPositionX;
    int m_PreviouPositionY;
    int m_CurrentPositionX;
    int m_CurrentPositionY;
    int CleanPrompt(int &i, int &j); //清理指定位置的提示框
    
    bool IsValidPosition(int i, int j);
    
    int Initial();
    
    // 因为棋局是用的标准棋盘布局（红下黑上），而界面可以是非标准布局
    // 所以是交换布局时，需要转换
    int ConvertQiPang(const int &i, const int &j, int &x, int &y);
};

#endif //CHINESE_CHESS_H_KL_2020_05_13__