/*****************************************************************************
 * Eliot
 * Copyright (C) 2002-2007 Antoine Fraboulet & Olivier Teulière
 * Authors: Antoine Fraboulet <antoine.fraboulet @@ free.fr>
 *          Olivier Teulière <ipkiss @@ 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 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 PLAYEDRACK_H_
#define PLAYEDRACK_H_

#include <vector>
#include <string>
#include "tile.h"
#include "logging.h"

class Rack;

using namespace std;


/**
 * A Playedrack is an "improved" rack, allowing to differentiate new letters
 * from letters that are left from the previous rack.
 * This is useful, to be able to write a rack on the form ABC+DEFG, where
 * A, B, C are the "old" letters and D, E, F, G are the "new" ones.
 */
class PlayedRack
{
    DEFINE_LOGGER();
public:
    PlayedRack();

    void reset();
    void resetNew();

    Rack getOld() const;
    Rack getNew() const;
    Rack getRack() const;

    void setOld(const Rack &iRack);
    void setNew(const Rack &iRack);
    void setManual(const wstring& iLetters);
    void setReject(bool iReject = true) { m_reject = iReject; }

    unsigned int getNbTiles() const  { return getNbNew() + getNbOld(); }
    unsigned int getNbNew() const    { return m_newTiles.size(); }
    unsigned int getNbOld() const    { return m_oldTiles.size(); }

    void addNew(const Tile &t);
    void addOld(const Tile &t);
    void getNewTiles(vector<Tile> &oTiles) const;
    void getOldTiles(vector<Tile> &oTiles) const;
    void getAllTiles(vector<Tile> &oTiles) const;

    bool checkRack(unsigned int cMin, unsigned int vMin) const;

    /// Randomly change the order of the "new" tiles
    void shuffleNew();
    /// Randomly change the order of all the tiles (they all become "new")
    void shuffle();

    enum display_mode
    {
        RACK_SIMPLE,
        RACK_EXTRA,
        RACK_DEBUG
    };
    wstring toString(display_mode iShowExtraSigns = RACK_EXTRA) const;

private:
    bool m_reject;
    vector<Tile> m_oldTiles;
    vector<Tile> m_newTiles;
};

#endif