eliot/game/xml_reader.h
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

89 lines
2.9 KiB
C++

/*****************************************************************************
* Copyright (C) 2009 Eliot
* Authors: 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
*****************************************************************************/
#ifndef XML_READER_H_
#define XML_READER_H_
#include <map>
#include <SAX/helpers/DefaultHandler.hpp>
#include <SAX/Locator.hpp>
#include <SAX/Attributes.hpp>
#include <SAX/SAXException.hpp>
class Dictionary;
class Game;
class Player;
using std::string;
using std::map;
class XmlReader : public Arabica::SAX::DefaultHandler<string>
{
public:
virtual ~XmlReader() {}
/**
* Only entry point of the class.
* Create a Game object, from a XML file created using the XmlWriter class.
* The method throws an exception in case of problem.
*/
static Game * read(const string &iFileName, const Dictionary &iDic);
// Return the built game
Game * getGame();
////////////////////////////////////////////////////
// ContentHandler
virtual void startElement(const string& namespaceURI,
const string& localName,
const string& qName,
const AttributesT& atts);
virtual void endElement(const string& namespaceURI,
const string& localName,
const string& qName);
virtual void characters(const string& ch);
/////////////////////////////////////////////////////
// ErrorHandler
virtual void warning(const Arabica::SAX::SAXParseException<string>&);
virtual void error(const Arabica::SAX::SAXParseException<string>&);
virtual void fatalError(const Arabica::SAX::SAXParseException<string>& exception);
private:
const Dictionary &m_dic;
Game *m_game;
string errorMessage;
string m_context;
string m_data;
map<string, Player*> m_players;
map<string, string> m_attributes;
// Private constructor, because we only want the read() method
// to be called externally
XmlReader(const Dictionary &iDic) : m_dic(iDic), m_game(NULL) {}
XmlReader(const XmlReader&);
XmlReader& operator=(const XmlReader&);
bool operator==(const XmlReader&);
};
#endif