eliot/utils/game_io.h
2012-12-29 17:46:14 +01:00

66 lines
2.3 KiB
C++
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/*****************************************************************************
* Eliot
* Copyright (C) 1999-2012 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 GAME_IO_H_
#define GAME_IO_H_
#include <iostream>
#include "logging.h"
class PublicGame;
class Results;
using std::ostream;
/**
* This class offers methods to display some information relative to a game
* object. It is currently used by the 'eliottxt' interface, but is also useful
* for debugging purposes. Feel free to add other printing methods that you may
* need...
*
* TODO: Maybe we could also use this class as a basis for non-regression tests?
*/
class GameIO
{
DEFINE_LOGGER();
public:
static void printBoard(ostream &out, const PublicGame &iGame);
static void printBoardDebug(ostream &out, const PublicGame &iGame);
static void printBoardMultipliers(ostream &out, const PublicGame &iGame);
static void printNonPlayed(ostream &out, const PublicGame &iGame);
static void printPlayedRack(ostream &out, const PublicGame &iGame);
static void printAllRacks(ostream &out, const PublicGame &iGame);
static void printSearchResults(ostream &out, const Results &iResults, int);
static void printPoints(ostream &out, const PublicGame &iGame);
static void printAllPoints(ostream &out, const PublicGame &iGame);
static void printGameDebug(ostream &out, const PublicGame &iGame);
private:
/// This class is a toolbox, and should not be instanciated
GameIO();
};
#endif