xml.h

Go to the documentation of this file.

/* xoreos - A reimplementation of BioWare's Aurora engine
 *
 * xoreos is the legal property of its developers, whose names
 * can be found in the AUTHORS file distributed with this source
 * distribution.
 *
 * xoreos 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 3
 * of the License, or (at your option) any later version.
 *
 * xoreos 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 xoreos. If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef COMMON_XML_H
#define COMMON_XML_H

#include <list>
#include <map>

#include <boost/noncopyable.hpp>

#include "src/common/scopedptr.h"
#include "src/common/ptrlist.h"
#include "src/common/ustring.h"

struct _xmlNode;

namespace Common {

class ReadStream;

void initXML();
void deinitXML();

class XMLNode;

class XMLParser : boost::noncopyable {
public:
    XMLParser(ReadStream &stream, bool makeLower = false, const UString &fileName = "stream.xml");
    ~XMLParser();

    const XMLNode &getRoot() const;

private:
    ScopedPtr<XMLNode> _rootNode;
};

class XMLNode : boost::noncopyable {
public:
    typedef std::map<UString, UString> Properties;
    typedef PtrList<const XMLNode> Children;

    const UString &getName() const;
    const UString &getContent() const;

    const XMLNode *getParent() const;

    const Children &getChildren() const;

    const XMLNode *findChild(const UString &name) const;

    const Properties &getProperties() const;
    UString getProperty(const UString &name, const UString &def = "") const;


private:
    typedef std::map<UString, const XMLNode *, UString::iless> ChildMap;

    UString _name;
    UString _content;

    XMLNode *_parent;

    Children _children;
    ChildMap _childMap;

    Properties _properties;


    XMLNode(_xmlNode &node, bool makeLower = false, XMLNode *parent = 0);
    ~XMLNode();

    void load(_xmlNode &node, bool makeLower);


    friend class XMLParser;

    template<typename T>
    friend void DeallocatorDefault::destroy(T *);
};

} // End of namespace Common

#endif // COMMON_XML_H