dom.h

Go to the documentation of this file.

 
#ifndef A_UTILS_UTIL_XML_DOM_HEADER_INCLUDED_
#define A_UTILS_UTIL_XML_DOM_HEADER_INCLUDED_
 
#include <a_util/base/enums.h>
#include <a_util/memory/stack_ptr.h>
 
#include <list>
#include <map>
#include <stdexcept>
 
namespace a_util {
namespace xml {
class DOM;
class DOMElement;

class DOMException : public std::runtime_error {
public:
    DOMException(const std::string& what);
};

typedef std::list<DOMElement> DOMElementList;
typedef std::map<std::string, std::string> DOMAttributes;

class DOMElement {
public:
    DOMElement();

    ~DOMElement();

    DOMElement(const DOMElement& element);

    DOMElement& operator=(const DOMElement& element);

    std::string getAttribute(const std::string& name,
                             const std::string& def_value = std::string()) const;

    DOMAttributes getAttributes() const;

    DOMElement getChild(const std::string& name) const;

    DOMElementList getChildren() const;

    std::string getData() const;

    DOM getDocument() const;

    std::string getName() const;

    DOMElement getParent() const;

    std::string getPath() const;

    bool setAttribute(const std::string& name, const std::string& strValue);

    bool setData(const std::string& data);

    bool setName(const std::string& name);

    bool hasAttribute(const std::string& name) const;

    bool eraseAttribute(const std::string& name);

    bool findNode(const std::string& query, DOMElement& element_ptr) const;

    bool findNodes(const std::string& query, DOMElementList& elements) const;

    bool sortNodes(const std::string& query, SortingOrder order);

    bool sortNodes(const std::string& query, SortingOrder order, std::size_t number_of_nodes);

    std::size_t sortNodes(const std::string& query,
                          const std::string& attribute,
                          SortingOrder order);

    bool sortNodes(const std::string& query,
                   const std::string& attribute,
                   SortingOrder order,
                   std::size_t number_of_nodes);

    DOMElement createChild(const std::string& name);

    DOMElement createChildBefore(const std::string& name, const DOMElement& before);

    bool removeChild(const std::string& name);

    bool isNull() const;
 
private:
    friend bool operator==(const DOMElement& lhs, const DOMElement& rhs);
 
private:
    class Implementation;
    memory::StackPtr<Implementation, 16> _impl;
    friend class DOM;
};

bool operator!=(const DOMElement& lhs, const DOMElement& rhs);

class DOM {
public:
    DOM();

    ~DOM();

    DOM(const DOM& dom);

    DOM& operator=(const DOM& dom);

    bool load(const std::string& file_path);

    bool save(const std::string& file_path) const;

    bool fromString(const std::string& xml);

    std::string toString() const;

    void reset();

    DOMElement getRoot() const;

    bool findNode(const std::string& query, DOMElement& element_ptr) const;

    bool findNodes(const std::string& query, DOMElementList& elements) const;

    std::string getLastError() const;

    bool isNull() const;
 
private:
    class Implementation;
    memory::StackPtr<Implementation, 280> _impl;
    friend class DOMElement;
};

bool operator==(const DOM& lhs, const DOM& rhs);

bool operator!=(const DOM& lhs, const DOM& rhs);
 
} // namespace xml
} // namespace a_util
 
#endif // A_UTILS_UTIL_XML_DOM_HEADER_INCLUDED_