src/symbols.h

   1 /*
   2     This file is part of SloppyGUI.
   3
   4     SloppyGUI is free software: you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation, either version 3 of the License, or
   7     (at your option) any later version.
   8
   9     SloppyGUI is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with SloppyGUI.  If not, see <http://www.gnu.org/licenses/>.
  16 */
  17
  18 #ifndef SYMBOLS_H
  19 #define SYMBOLS_H
  20
  21 #include <QString>
  22
  23 #include "chessboard/chessboard.h"
  24
  25 /**
  26  * Symbols class provides chess symbols found in the Unicode character set.
  27 */
  28 class Symbols
  29 {
  30         public:
  31                 /** Symbol of black pawn. */
  32                 static const QString BlackPawn;
  33                 /** Symbol of black rook. */
  34                 static const QString BlackRook;
  35                 /** Symbol of black knight. */
  36                 static const QString BlackKnight;
  37                 /** Symbol of black bishop. */
  38                 static const QString BlackBishop;
  39                 /** Symbol of black queen. */
  40                 static const QString BlackQueen;
  41                 /** Symbol of black king. */
  42                 static const QString BlackKing;
  43
  44                 /** Symbol of white pawn. */
  45                 static const QString WhitePawn;
  46                 /** Symbol of white rook. */
  47                 static const QString WhiteRook;
  48                 /** Symbol of white knight. */
  49                 static const QString WhiteKnight;
  50                 /** Symbol of white bishop. */
  51                 static const QString WhiteBishop;
  52                 /** Symbol of white queen. */
  53                 static const QString WhiteQueen;
  54                 /** Symbol of white king. */
  55                 static const QString WhiteKing;
  56
  57                 /**
  58                  * Returns a symbol of given side and piece type.
  59                  * @param side The side of the wanted symbol.
  60                  * @param piece The piece type of the wanted symbol.
  61                  * @return The symbol of the given side and piece type. If the given
  62                  * values are invalid an empty string is returned.
  63                 */
  64                 static QString symbolOf(Chessboard::ChessSide side, Chessboard::ChessPiece piece);
  65
  66                 /**
  67                  * Returns a symbol of given side and piece type.
  68                  * The piece type is given as a single character. The mappings to
  69                  * chess pieces are:
  70                  *
  71                  * K - King
  72                  * Q - Queen
  73                  * B - Bishop
  74                  * N - Knight
  75                  * R - Rook
  76                  * P - Pawn
  77                  *
  78                  * Uppercase and lowercase letters give same results.
  79                  * @param side The side of the wanted symbol.
  80                  * @param piece The piece type of the wanted symbol (as a single
  81                  * character).
  82                  * @return The symbol of the given side and piece type. If the given
  83                  * values are invalid an empty string is returned.
  84                 */
  85                 static QString symbolOf(Chessboard::ChessSide side, const QChar& piece);
  86
  87         private:
  88                 Symbols() { }
  89
  90 };
  91
  92 #endif // SYMBOLS_H
  93