eliot/dic/tile.h
Olivier Teulière 70be50c64e A lot of clean-up:
- Removed logiv from the History class
 - Used BOOST_FOREACH to simplify loops
 - Remove useless annotations and doxygen blocks
 - Added some constness
 - Marked Training::setRack() as deprecated
 - Improved compilation order in game/
2008-11-22 13:09:28 +00:00

91 lines
2.7 KiB
C++

/*****************************************************************************
* Eliot
* Copyright (C) 2005-2007 Olivier Teulière & Antoine Fraboulet
* Authors: Olivier Teulière <ipkiss @@ gmail.com>
* Antoine Fraboulet <antoine.fraboulet @@ free.fr>
*
* 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 2 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, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*****************************************************************************/
#ifndef _TILE_H_
#define _TILE_H_
#include <list>
#include <vector>
using namespace std;
class Header;
/*************************
* A Tile is the internal representation
* used within the game library to
* handle letters
*************************/
class Tile
{
friend class Dictionary;
public:
// a lowercase character is always a joker
// - this permits to detect joker in already played games
// - we need to pay attention when inserting characters taken
// from user input
Tile(wchar_t c = kTILE_DUMMY);
bool isEmpty() const { return m_char == kTILE_DUMMY; }
bool isJoker() const { return m_joker; }
bool isPureJoker() const { return m_char == kTILE_JOKER; }
bool isVowel() const;
bool isConsonant() const;
unsigned int maxNumber() const;
unsigned int getPoints() const;
wchar_t toChar() const;
unsigned int toCode() const;
static const Tile &Joker() { return m_TheJoker; }
bool operator <(const Tile &iOther) const;
bool operator ==(const Tile &iOther) const;
bool operator !=(const Tile &iOther) const;
private:
wchar_t m_char;
bool m_joker;
/**
* Internal code, used in the dictionary to represent the letter.
* It is mainly used by the Cross class.
*/
int m_code;
static const wchar_t kTILE_DUMMY = L'%';
static const wchar_t kTILE_JOKER = L'?';
// Special tiles are declared static
static Tile m_TheJoker;
/// Dictionary header
static const Header *m_header;
/// Update the dictionary header
static void SetHeader(const Header &iHeader) { m_header = &iHeader; }
};
#endif