XML.h

Go to the documentation of this file.

/* This file is part of the Zenipex Library (zenilib).
 * Copyright (C) 2011 Mitchell Keith Bloch (bazald).
 *
 * zenilib is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * zenilib 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with zenilib.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef ZENI_XML_H
#define ZENI_XML_H

#include <Zeni/Error.h>

#include <tinyxml.h>

namespace Zeni {

  class ZENI_DLL XML_Element_c {
  public:
    XML_Element_c(const TiXmlHandle &handle);

    XML_Element_c operator[](const String &field) const; 

    XML_Element_c first() const; 
    XML_Element_c next() const; 

    bool good() const; 
    String value() const; 

    bool to_bool() const; 
    int to_int() const; 
    float to_float() const; 
    double to_double() const; 
    String to_string() const; 

  protected:
    TiXmlNode * child(const String &field) const;
    TiXmlNode * first_child() const;
    TiXmlNode * child_element(const String &field) const;
    TiXmlNode * first_child_element() const;

    TiXmlHandle m_handle;
  };

  class ZENI_DLL XML_Element : public XML_Element_c {
  public:
    XML_Element(const TiXmlHandle &handle);

    XML_Element operator[](const String &field); 

    XML_Element first(); 
    XML_Element next(); 

    void create_child(const String &field); 
    void remove_child(const XML_Element &child); 

    void set_bool(const bool &b); 
    void set_int(const int &i); 
    void set_float(const float &f); 
    void set_double(const double &d); 
    void set_string(const String &s); 
  };

  class ZENI_DLL XML_Document {
    XML_Document(const XML_Document &);
    XML_Document & operator=(const XML_Document &);

  public:
    XML_Document();
    XML_Document(const String &filename);
    XML_Document(const String &filename, const String &backup);
    ~XML_Document();

    bool good() const;
    void load_mem(const String &data);
    void load(const String &filename);
    void save();
    void save(const String &filename);

    bool try_load_mem(const String &data);
    bool try_load(const String &filename);
    bool try_save();
    bool try_save(const String &filename);

    XML_Element_c operator[](const String &field) const; 
    XML_Element operator[](const String &field); 

    XML_Element_c first() const; 
    XML_Element first(); 

    void create_root(const String &field); 

  private:
    TiXmlDocument m_xml_file;
    XML_Element * m_root;
  };

  struct ZENI_DLL XML_Load_Failure : public Error {
    XML_Load_Failure() : Error("XML_Document could not be loaded.") {}
  };

  struct ZENI_DLL XML_Save_Failure : public Error {
    XML_Save_Failure() : Error("XML_Document could not be saved.") {}
  };

  struct ZENI_DLL XML_Document_Ungood : public Error {
    XML_Document_Ungood() : Error("XML_Document not good!") {}
  };

  struct ZENI_DLL XML_Element_Ungood : public Error {
    XML_Element_Ungood() : Error("XML_Element not good!") {}
  };

  struct ZENI_DLL XML_Element_Nonleaf : public Error {
    XML_Element_Nonleaf() : Error("XML_Element attempted leaf-node operation on non-leaf node!") {}
  };

  struct ZENI_DLL XML_Create_Child_Failure : public Error {
    XML_Create_Child_Failure() : Error("XML_Element failed to create a child node!") {}
  };

  struct ZENI_DLL XML_Remove_Child_Failure : public Error {
    XML_Remove_Child_Failure() : Error("XML_Element failed to remove a child node!") {}
  };

}

#endif