xml.hh

/*
** TowBowlTactics, a turn-based strategy football game.
**
** Copyright (C) 2006-2010 The TBT Team.
**
** 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.
**
** The complete GNU General Public Licence Notice can be found as the
** `NOTICE' file in the root directory.
**
** The TBT Team consists of people listed in the `AUTHORS' file.
*/

#ifndef XML_HH_
# define XML_HH_

# include "tools.hh"

BEGIN_NS(xml);

class XMLInternal;

class XMLError : public Exception
{
public:
  XMLError(const std::string& reason);
};

class XML
{
public:
  virtual void parse(const std::string& filename);

  void save();

  friend std::ostream& operator<< (std::ostream& os, const XML& xml);

  void setNodeAppend(bool enabled);
  
  //    @c string are supported.
  template <typename T>
  T getData(const std::string& node_name, int index = 0) const;

  template <typename T>
  T getAttr(const std::string& node_name,
        const std::string& attr_name,
        int index = 0) const;

  template <typename T>
  void setData(const std::string& node_name,
           const T& value);

  template <typename T>
  void setAttr(const std::string& node_name,
           const std::string& attr_name,
           const T& value);

protected:
  XML();
  virtual ~XML();

  virtual const char* getExpectedRoot() const = 0;

  virtual void initXMLInternal();

  mutable XMLInternal* xml_internal_;

  std::string filename_;

private:
  // Do not allow copies of this object.
  XML(const XML&);
  XML& operator= (const XML&);

  static int inst_count_;
  mutable int append_node_;
};

END_NS(xml);

#endif /* !XML_HH_ */