eliot/utils/game_io.cpp
Olivier Teulière 3c7a84d543 Support saving/loading games (any game type) in XML format.
Status:
It works well, but there are still a few details to improve/fix

More details about the changes:
 - New dependency on Arabica and Libxml2 to parse the XML
 - Loading the old format is still supported for this release, but won't be supported anymore in the next one
 - Games are now only saved in the new format
 - In training mode, the player is now created externally, like in the other modes
 - Avoid using GameIO (the one from game/) whenever possible
 - Do not use a FILE* argument anymore when loading a game
 - Throw and catch exceptions correctly when a game cannot be loaded or saved
 - The non-regression tests now use a new method to print the game history
2009-11-29 16:01:31 +00:00

325 lines
9.7 KiB
C++

/*****************************************************************************
* Copyright (C) 1999-2005 Eliot
* Authors: Antoine Fraboulet <antoine.fraboulet@free.fr>
* Olivier Teuliere <ipkiss@via.ecp.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
*****************************************************************************/
#include <boost/foreach.hpp>
#include <boost/format.hpp>
#include <iomanip>
#include <string>
#include <stdlib.h>
#include <dic.h>
#include "game_io.h"
#include "public_game.h"
#include "bag.h"
#include "board.h"
#include "results.h"
#include "player.h"
#include "encoding.h"
#include "history.h"
#include "turn.h"
#include "move.h"
#include "round.h"
using namespace std;
using boost::format;
using boost::wformat;
#define __UNUSED__ __attribute__((unused))
void GameIO::printBoard(ostream &out, const PublicGame &iGame)
{
int row, col;
out << " ";
for (col = BOARD_MIN; col <= BOARD_MAX; col++)
out << setw(3) << col - BOARD_MIN + 1;
out << endl;
for (row = BOARD_MIN; row <= BOARD_MAX; row++)
{
out << " " << (char)(row - BOARD_MIN + 'A') << " ";
for (col = BOARD_MIN; col <= BOARD_MAX; col++)
{
if (iGame.getBoard().isVacant(row, col))
out << " - ";
else
out << centerAndConvert(iGame.getBoard().getDisplayStr(row, col), 3);
}
out << endl;
}
}
/* this mode is used for regression tests */
void GameIO::printBoardDebug(ostream &out, const PublicGame &iGame)
{
int row, col;
/* first printf row cell contents */
for (row = BOARD_MIN; row <= BOARD_MAX; row++)
{
out << " " << (char)(row - BOARD_MIN + 'A') << "r ";
for (col = BOARD_MIN; col <= BOARD_MAX; col++)
{
out << iGame.getBoard().getCellContent_row(row, col);
}
out << endl;
}
out << " -" << endl;
for (row = BOARD_MIN; row <= BOARD_MAX; row++)
{
out << " " << (char)(row - BOARD_MIN + 'A') << "c ";
for (col = BOARD_MIN; col <= BOARD_MAX; col++)
{
out << iGame.getBoard().getCellContent_col(row, col);
}
out << endl;
}
}
void GameIO::printBoardJoker(ostream &out, const PublicGame &iGame)
{
int row,col;
out << " ";
for (col = BOARD_MIN; col <= BOARD_MAX; col++)
out << setw(3) << col - BOARD_MIN + 1;
out << endl;
for (row = BOARD_MIN; row <= BOARD_MAX; row++)
{
out << " " << (char)(row - BOARD_MIN + 'A') << " ";
for (col = BOARD_MIN; col <= BOARD_MAX; col++)
{
if (iGame.getBoard().isVacant(row, col))
out << " --";
else
{
bool j = iGame.getBoard().isJoker(row, col);
out << (j ? " ." : " ")
<< convertToMb(iGame.getBoard().getDisplayStr(row, col));
}
}
out << endl;
}
}
void GameIO::printBoardMultipliers(ostream &out, const PublicGame &iGame)
{
int row, col;
out << " ";
for (col = BOARD_MIN; col <= BOARD_MAX; col++)
out << setw(3) << col - BOARD_MIN + 1;
out << endl;
for (row = BOARD_MIN; row <= BOARD_MAX; row++)
{
out << " " << (char)(row - BOARD_MIN + 'A') << " ";
for (col = BOARD_MIN; col <= BOARD_MAX; col++)
{
if (!iGame.getBoard().isVacant(row, col))
out << padAndConvert(iGame.getBoard().getDisplayStr(row, col), 3);
else
{
int wm = iGame.getBoard().GetWordMultiplier(row, col);
int tm = iGame.getBoard().GetLetterMultiplier(row, col);
if (wm > 1)
out << " " << ((wm == 3) ? '@' : '#');
else if (tm > 1)
out << " " << ((tm == 3) ? '*' : '+');
else
out << " -";
}
}
out << endl;
}
}
void GameIO::printBoardMultipliers2(ostream &out, const PublicGame &iGame)
{
int row, col;
out << " ";
for (col = BOARD_MIN; col <= BOARD_MAX; col++)
out << setw(3) << col - BOARD_MIN + 1;
out << endl;
for (row = BOARD_MIN; row <= BOARD_MAX; row++)
{
out << " " << (char)(row - BOARD_MIN + 'A') << " ";
for (col = BOARD_MIN; col <= BOARD_MAX; col++)
{
int wm = iGame.getBoard().GetWordMultiplier(row, col);
int tm = iGame.getBoard().GetLetterMultiplier(row, col);
if (wm > 1)
out << " " << ((wm == 3) ? '@' : '#');
else if (tm > 1)
out << " " << ((tm == 3) ? '*' : '+');
else
out << " -";
if (iGame.getBoard().isVacant(row, col))
out << "-";
else
out << convertToMb(iGame.getBoard().getDisplayStr(row, col));
}
out << endl;
}
}
void GameIO::printNonPlayed(ostream &out, const PublicGame &iGame)
{
const Bag &bag = iGame.getBag();
BOOST_FOREACH(const Tile &tile, iGame.getDic().getAllTiles())
{
if (bag.in(tile) > 9)
out << " ";
out << setw(2) << convertToMb(tile.getDisplayStr());
}
out << endl;
BOOST_FOREACH(const Tile &tile, iGame.getDic().getAllTiles())
{
out << " " << bag.in(tile);
}
out << endl;
}
void GameIO::printPlayedRack(ostream &out, const PublicGame &iGame, int __UNUSED__ n)
{
out << convertToMb(iGame.getCurrentPlayer().getCurrentRack().toString(PlayedRack::RACK_SIMPLE)) << endl;
}
void GameIO::printAllRacks(ostream &out, const PublicGame &iGame)
{
for (unsigned int j = 0; j < iGame.getNbPlayers(); j++)
{
out << "Rack " << j << ": ";
out << convertToMb(iGame.getPlayer(j).getCurrentRack().toString(PlayedRack::RACK_EXTRA)) << endl;
}
}
static void searchResultLine(ostream &out, const Results &iResults, int num)
{
const Round &r = iResults.get(num);
const wstring &word = r.getWord();
if (word.empty())
return;
out << convertToMb(word) << string(16 - word.size(), ' ')
<< (r.getBonus() ? '*' : ' ')
<< setw(4) << r.getPoints()
<< ' ' << convertToMb(r.getCoord().toString());
}
void GameIO::printSearchResults(ostream &out, const Results &iResults, int num)
{
for (int i = 0; i < num && i < (int)iResults.size(); i++)
{
out << setw(3) << i + 1 << ": ";
searchResultLine(out, iResults, i);
out << endl;
}
}
void GameIO::printPoints(ostream &out, const PublicGame &iGame)
{
out << iGame.getPlayer(0).getPoints() << endl;
}
void GameIO::printAllPoints(ostream &out, const PublicGame &iGame)
{
for (unsigned int i = 0; i < iGame.getNbPlayers(); i++)
{
out << "Score " << i << ": "
<< setw(4) << iGame.getPlayer(i).getPoints() << endl;
}
}
void GameIO::printGameDebug(ostream &out, const PublicGame &iGame)
{
out << "Game: player " << iGame.getCurrentPlayer().getId() + 1
<< " out of " << iGame.getNbPlayers() << endl;
out << "Game: mode=" << iGame.getModeAsString() << endl;
out << "Game: variant=";
switch (iGame.getVariant())
{
case PublicGame::kEXPLOSIVE:
out << "explosive" << endl;
break;
case PublicGame::kJOKER:
out << "joker" << endl;
break;
default:
out << "unknown" << endl;
break;
}
out << "Game: history:" << endl;
out << " N | P | RACK | SOLUTION | REF | PTS | BONUS" << endl;
out << " ===|===|==========|================|=====|=====|======" << endl;
for (unsigned int i = 0; i < iGame.getHistory().getSize(); ++i)
{
const Turn &turn = iGame.getHistory().getTurn(i);
const Move &move = turn.getMove();
format fmter("%1% | %2% | %3% | %4% | %5% | %6% | %7%");
fmter % padAndConvert(str(wformat(L"%1%") % (i + 1)), 5);
fmter % padAndConvert(str(wformat(L"%1%") % turn.getPlayer()), 1);
fmter % padAndConvert(turn.getPlayedRack().toString(), 8);
if (move.getType() == Move::VALID_ROUND)
{
const Round &round = move.getRound();
fmter % padAndConvert(round.getWord(), 14, false);
fmter % padAndConvert(round.getCoord().toString(), 3);
fmter % padAndConvert(str(wformat(L"%1%") % round.getPoints()), 3);
fmter % padAndConvert(round.getBonus() ? L"*": L"", 1, false);
}
else
{
if (move.getType() == Move::INVALID_WORD)
{
fmter % padAndConvert(L"#" + move.getBadWord() + L"#", 14, false);
fmter % padAndConvert(move.getBadCoord(), 3);
}
else if (move.getType() == Move::CHANGE_LETTERS)
{
fmter % padAndConvert(L"[" + move.getChangedLetters() + L"]", 14, false) % " - ";
}
else
{
fmter % padAndConvert(L"(PASS)", 14, false) % " - ";
}
fmter % " 0" % " ";
}
out << fmter.str() << endl;
}
out << endl << endl;
}