Add pugixml backend incomplete.

Add some defines for xml nodes manipulation.
With pugixml backend no xml writing.

5 files changed, 573 insertions, 6 deletions

diff --git a/src/utils/xml.h b/src/utils/xml.h
index 055f93cbf..556455f7b 100644
--- a/src/utils/xml.h
+++ b/src/utils/xml.h
@@ -21,6 +21,10 @@
 #ifndef UTILS_XML_H
 #define UTILS_XML_H
 
+#ifdef ENABLE_PUGIXML
+#include "utils/xml/pugixml.h"
+#else  // ENABLE_PUGIXML
 #include "utils/xml/libxml.h"
+#endif  // ENABLE_PUGIXML
 
 #endif  // UTILS_XML_H
diff --git a/src/utils/xml/libxml.h b/src/utils/xml/libxml.h
index a783c09c2..6d8c35cab 100644
--- a/src/utils/xml/libxml.h
+++ b/src/utils/xml/libxml.h
@@ -49,10 +49,26 @@
     reinterpret_cast<const xmlChar*>(name))
 #define XmlTextWriterStartElement(writer, name) \
     xmlTextWriterStartElement(writer, reinterpret_cast<const xmlChar*>(name))
+#define XmlTextWriterEndElement(writer) xmlTextWriterEndElement(writer)
 #define XmlTextWriterWriteAttribute(writer, name, content) \
     xmlTextWriterWriteAttribute(writer, \
     reinterpret_cast<const xmlChar*>(name), \
     reinterpret_cast<const xmlChar*>(content))
+#define XmlNodeGetContent(node) xmlNodeGetContent(node)
+#define XmlNewTextWriterFilename(name, flags) \
+    xmlNewTextWriterFilename(name, flags)
+#define XmlTextWriterSetIndent(writer, flags) \
+    xmlTextWriterSetIndent(writer, flags)
+#define XmlTextWriterStartDocument(writer, p1, p2, p3) \
+    xmlTextWriterStartDocument(writer, p1, p2, p3)
+#define XmlTextWriterEndDocument(writer) xmlTextWriterEndDocument(writer)
+#define XmlFreeTextWriter(writer) xmlFreeTextWriter(writer)
+#define XmlHaveChildContent(node) ((node)->xmlChildrenNode != nullptr && \
+    (node)->xmlChildrenNode->content != nullptr)
+#define XmlChildContent(node) reinterpret_cast<const char*>(\
+    (node)->xmlChildrenNode->content)
+#define XmlFree(ptr) xmlFree(ptr)
+#define XmlNodeDefault nullptr
 
 /**
  * XML helper functions.
diff --git a/src/utils/xml/pugixml.cpp b/src/utils/xml/pugixml.cpp
new file mode 100644
index 000000000..7bff15f6c
--- /dev/null
+++ b/src/utils/xml/pugixml.cpp
@@ -0,0 +1,335 @@
+/*
+ *  The ManaPlus Client
+ *  Copyright (C) 2004-2009  The Mana World Development Team
+ *  Copyright (C) 2009-2010  The Mana Developers
+ *  Copyright (C) 2011-2015  The ManaPlus Developers
+ *
+ *  This file is part of The ManaPlus Client.
+ *
+ *  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
+ *  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, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifdef ENABLE_PUGIXML
+
+#include "utils/xml/pugixml.h"
+
+#include "logger.h"
+
+#include "utils/delete2.h"
+#include "utils/fuzzer.h"
+#include "utils/physfstools.h"
+#include "utils/stringutils.h"
+
+#include "utils/translation/podict.h"
+
+#include "debug.h"
+
+namespace
+{
+    bool valid = false;
+}  // namespace
+
+namespace XML
+{
+    static void showErrorStatus(pugi::xml_parse_result &result)
+    {
+//        switch (result.status)
+//        {
+//            case pugi::status_ok:
+//                break;
+//            case pugi::status_file_not_found:
+//                logger->log("xml error: %s", result.description());
+//                break;
+//        }
+        logger->log("xml error: %s", result.description());
+    }
+
+    Document::Document(const std::string &filename,
+                       const UseResman useResman,
+                       const SkipError skipError) :
+        mDoc(),
+        mRoot(),
+        mData(nullptr),
+        mIsValid(false)
+    {
+#ifdef USE_FUZZER
+        if (Fuzzer::conditionTerminate(filename.c_str()))
+            return;
+#endif
+        BLOCK_START("XML::Document::Document")
+        int size = 0;
+        char *data = nullptr;
+        valid = true;
+        if (useResman == UseResman_true)
+        {
+            data = static_cast<char*>(PhysFs::loadFile(
+                filename.c_str(), size));
+        }
+        else
+        {
+            std::ifstream file;
+            file.open(filename.c_str(), std::ios::in);
+
+            if (file.is_open())
+            {
+                // Get length of file
+                file.seekg(0, std::ios::end);
+                size = static_cast<int>(file.tellg());
+                if (size < 0)
+                {
+                    logger->log("Error loading XML file %s", filename.c_str());
+                }
+                else
+                {
+                    file.seekg(0, std::ios::beg);
+                    data = static_cast<char*>(malloc(size));
+                    file.read(data, size);
+                }
+                file.close();
+            }
+            else
+            {
+                logger->log("Error loading XML file %s", filename.c_str());
+            }
+        }
+
+        if (data)
+        {
+            // +++ use other pugi::parse_* flags
+            pugi::xml_parse_result result = mDoc.load_buffer_inplace(data,
+                size,
+                pugi::parse_default,
+                pugi::encoding_utf8);
+            if (result.status != pugi::status_ok)
+            {
+                showErrorStatus(result);
+                free(data);
+            }
+            else
+            {
+                mData = data;
+            }
+
+            mRoot = mDoc.first_child();
+//            if (!mDoc)
+//                logger->log("Error parsing XML file %s", filename.c_str());
+        }
+        else if (skipError == SkipError_false)
+        {
+            logger->log("Error loading %s", filename.c_str());
+        }
+        mIsValid = valid;
+        BLOCK_END("XML::Document::Document")
+    }
+
+    Document::Document(const char *const data, const int size) :
+        mDoc(),
+        mRoot(),
+        mData(nullptr),
+        mIsValid(true)
+    {
+        if (!data)
+            return;
+
+        char *buf = static_cast<char*>(calloc(size + 1, 1));
+        strncpy(buf, data, size);
+        buf[size] = 0;
+        pugi::xml_parse_result result = mDoc.load_buffer_inplace(buf,
+            size,
+            pugi::parse_default,
+            pugi::encoding_utf8);
+        if (result.status != pugi::status_ok)
+        {
+            showErrorStatus(result);
+            free(buf);
+        }
+        else
+        {
+            mRoot = mDoc.first_child();
+            mData = buf;
+        }
+    }
+
+    Document::~Document()
+    {
+        free(mData);
+        mData = nullptr;
+//        if (mDoc)
+//            xmlFreeDoc(mDoc);
+    }
+
+    XmlNodePtr Document::rootNode()
+    {
+        return mDoc.first_child();
+    }
+
+    int getProperty(const XmlNodePtr node,
+                    const char *const name,
+                    int def)
+    {
+        int &ret = def;
+
+        if (!node)
+            return ret;
+        const pugi::xml_attribute &attr = node.attribute(name);
+        if (!attr.empty())
+            ret = atoi(attr.value());
+
+        return ret;
+    }
+
+    int getIntProperty(const XmlNodePtr node,
+                       const char *const name,
+                       int def,
+                       const int min,
+                       const int max)
+    {
+        int &ret = def;
+
+        if (!node)
+            return ret;
+        const pugi::xml_attribute &attr = node.attribute(name);
+        if (!attr.empty())
+            ret = atoi(attr.value());
+
+        if (ret < min)
+            ret = min;
+        else if (ret > max)
+            ret = max;
+        return ret;
+    }
+
+    double getFloatProperty(const XmlNodePtr node,
+                            const char *const name,
+                            double def)
+    {
+        double &ret = def;
+
+        if (!node)
+            return ret;
+        const pugi::xml_attribute &attr = node.attribute(name);
+        if (!attr.empty())
+            ret = atof(attr.value());
+
+        return ret;
+    }
+
+    std::string getProperty(const XmlNodePtr node,
+                            const char *const name,
+                            const std::string &def)
+    {
+        if (!node)
+            return def;
+        const pugi::xml_attribute &attr = node.attribute(name);
+        if (!attr.empty())
+            return attr.value();
+
+        return def;
+    }
+
+    std::string langProperty(const XmlNodePtr node,
+                             const char *const name,
+                             const std::string &def)
+    {
+        std::string str = getProperty(node, name, def);
+        if (!translator)
+            return str;
+
+        return translator->getStr(str);
+    }
+
+    bool getBoolProperty(const XmlNodePtr node,
+                         const char *const name,
+                         const bool def)
+    {
+        if (!node)
+            return def;
+        const pugi::xml_attribute &attr = node.attribute(name);
+        if (!attr.empty())
+        {
+            std::string val = attr.value();
+            if (val == "true")
+                return true;
+            if (val == "false")
+                return false;
+        }
+
+        return def;
+    }
+
+    XmlNodePtr findFirstChildByName(const XmlNodePtrConst parent,
+                                    const char *const name)
+    {
+        if (!parent || !name)
+            return pugi::xml_node();
+        for_each_xml_child_node(child, parent)
+        {
+            if (!strcmp(child.name(), name))
+                return child;
+        }
+
+        return pugi::xml_node();
+    }
+
+    // Initialize libxml2 and check for potential ABI mismatches between
+    // compiled version and the shared library actually used.
+    void initXML()
+    {
+//        xmlInitParser();
+//        LIBXML_TEST_VERSION;
+
+        // Suppress libxml2 error messages
+//        xmlSetGenericErrorFunc(nullptr, &xmlErrorLogger);
+    }
+
+    // Shutdown libxml
+    void cleanupXML()
+    {
+//        xmlCleanupParser();
+    }
+
+    bool Document::validateXml(const std::string &fileName)
+    {
+        pugi::xml_document doc;
+        pugi::xml_parse_result result = doc.load_file(fileName.c_str(),
+            pugi::parse_default,
+            pugi::encoding_utf8);
+
+        if (result.status != pugi::status_ok)
+        {
+            showErrorStatus(result);
+            return false;
+        }
+
+        std::ifstream file;
+        file.open(fileName.c_str(), std::ios::in);
+        if (!file.is_open())
+        {
+            file.close();
+            return false;
+        }
+        char line[101];
+        if (!file.getline(line, 100))
+            return false;
+        file.close();
+
+        const std::string str = line;
+        if (!strStartWith(str, "<?xml "))
+            return false;
+
+        return true;
+    }
+}  // namespace XML
+
+#endif  // ENABLE_PUGIXML
diff --git a/src/utils/xml/pugixml.h b/src/utils/xml/pugixml.h
new file mode 100644
index 000000000..57e0cccd3
--- /dev/null
+++ b/src/utils/xml/pugixml.h
@@ -0,0 +1,181 @@
+/*
+ *  The ManaPlus Client
+ *  Copyright (C) 2004-2009  The Mana World Development Team
+ *  Copyright (C) 2009-2010  The Mana Developers
+ *  Copyright (C) 2011-2015  The ManaPlus Developers
+ *
+ *  This file is part of The ManaPlus Client.
+ *
+ *  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
+ *  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, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef UTILS_XML_PUGIXML_H
+#define UTILS_XML_PUGIXML_H
+
+#ifdef ENABLE_PUGIXML
+
+#include "enums/simpletypes/skiperror.h"
+#include "enums/simpletypes/useresman.h"
+
+#include <pugixml.hpp>
+
+#include <string>
+
+#include "localconsts.h"
+
+#define XML_ELEMENT_NODE pugi::node_element
+
+#define XmlNodePtr pugi::xml_node
+#define XmlNodePtrConst pugi::xml_node 
+#define xmlNameEqual(node, str) !strcmp((node).name(), str)
+#define xmlTypeEqual(node, typ) ((node).type() == (typ))
+#define XmlHasProp(node, name) (!((node).attribute(name).empty()))
+#define XmlHaveChildContent(node) ((node).child_value() != nullptr && \
+    *(node).child_value())
+#define XmlChildContent(node) (node).child_value()
+#define xmlChar char
+#define XmlFree(ptr)
+#define XmlNodeDefault pugi::xml_node()
+
+// +++ need impliment get context 
+#define XmlNodeGetContent(node) (node).child_value()
+
+// +++ need impliment writing code
+#define XmlTextWriterPtr pugi::xml_writer*
+#define XmlTextWriterStartElement(writer, name)
+#define XmlTextWriterEndElement(writer)
+#define XmlTextWriterWriteAttribute(writer, name, content)
+#define XmlNewTextWriterFilename(name, flags) nullptr;
+#define XmlTextWriterSetIndent(writer, flags)
+#define XmlTextWriterStartDocument(writer, p1, p2, p3)
+#define XmlTextWriterEndDocument(writer)
+#define XmlFreeTextWriter(writer)
+
+/**
+ * XML helper functions.
+ */
+namespace XML
+{
+    /**
+     * A helper class for parsing an XML document, which also cleans it up
+     * again (RAII).
+     */
+    class Document final
+    {
+        public:
+            /**
+             * Constructor that attempts to load the given file through the
+             * resource manager. Logs errors.
+             */
+            Document(const std::string &filename,
+                     const UseResman useResman,
+                     const SkipError skipError);
+
+            /**
+             * Constructor that attempts to load an XML document from memory.
+             * Does not log errors.
+             *
+             * @param data the string to parse as XML
+             * @param size the length of the string in bytes
+             */
+            Document(const char *const data, const int size);
+
+            A_DELETE_COPY(Document)
+
+            /**
+             * Destructor. Frees the loaded XML file.
+             */
+            ~Document();
+
+            /**
+             * Returns the root node of the document (or NULL if there was a
+             * load error).
+             */
+            XmlNodePtr rootNode() A_WARN_UNUSED;
+
+            bool isLoaded() const
+            { return !mDoc.empty(); }
+
+            bool isValid() const
+            { return mIsValid; }
+
+            static bool validateXml(const std::string &fileName);
+
+        private:
+            pugi::xml_document mDoc;
+            pugi::xml_node mRoot;
+            char *mData;
+            bool mIsValid;
+    };
+
+    /**
+     * Gets an floating point property from an XmlNodePtr.
+     */
+    double getFloatProperty(const XmlNodePtr node,
+                            const char *const name,
+                            double def) A_WARN_UNUSED;
+
+    /**
+     * Gets an integer property from an XmlNodePtr.
+     */
+    int getProperty(const XmlNodePtr node,
+                    const char *const name,
+                    int def) A_WARN_UNUSED;
+
+    /**
+     * Gets an integer property from an XmlNodePtr.
+     */
+    int getIntProperty(const XmlNodePtr node,
+                       const char *const name,
+                       int def,
+                       const int min,
+                       const int max) A_WARN_UNUSED;
+
+    /**
+     * Gets a string property from an XmlNodePtr.
+     */
+    std::string getProperty(const XmlNodePtr node,
+                            const char *const name,
+                            const std::string &def) A_WARN_UNUSED;
+
+    /**
+     * Gets a translated string property from an XmlNodePtr.
+     */
+    std::string langProperty(const XmlNodePtr node,
+                             const char *const name,
+                             const std::string &def) A_WARN_UNUSED;
+
+    /**
+     * Gets a boolean property from an XmlNodePtr.
+     */
+    bool getBoolProperty(const XmlNodePtr node,
+                         const char *const name,
+                         const bool def) A_WARN_UNUSED;
+
+    /**
+     * Finds the first child node with the given name
+     */
+    XmlNodePtr findFirstChildByName(const XmlNodePtrConst parent,
+                                    const char *const name) A_WARN_UNUSED;
+
+    void initXML();
+
+    void cleanupXML();
+}  // namespace XML
+
+#define for_each_xml_child_node(var, parent) \
+    for (pugi::xml_node var = parent.first_child(); var; var = var.next_sibling())
+
+#endif  // ENABLE_PUGIXML
+#endif  // UTILS_XML_PUGIXML_H
diff --git a/src/utils/xml_unittest.cc b/src/utils/xml_unittest.cc
index ba89a3b70..24a025e4a 100644
--- a/src/utils/xml_unittest.cc
+++ b/src/utils/xml_unittest.cc
@@ -51,13 +51,15 @@ TEST_CASE("xml doc")
         REQUIRE(xmlNameEqual(doc.rootNode(), "skinset") == true);
         REQUIRE(xmlNameEqual(doc.rootNode(), "skinset123") == false);
         REQUIRE(xmlTypeEqual(doc.rootNode(), XML_ELEMENT_NODE) == true);
+//        REQUIRE(XmlHaveChildContent(doc.rootNode()) == true);
     }
 
     SECTION("load2")
     {
-        const std::string xml = "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
-            "<root><data option1=\"false\" option2=\"true\"/></root>";
-        XML::Document doc(xml.c_str(), xml.size());
+        const char *xml = "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
+            "<root><data option1=\"false\" option2=\"true\"/>"
+            "<cont>this is test</cont></root>";
+        XML::Document doc(xml, strlen(xml));
         REQUIRE(doc.isLoaded() == true);
         REQUIRE(doc.isValid() == true);
         REQUIRE(doc.rootNode() != nullptr);
@@ -66,6 +68,8 @@ TEST_CASE("xml doc")
         REQUIRE(xmlTypeEqual(doc.rootNode(), XML_ELEMENT_NODE) == true);
         REQUIRE(XmlHasProp(doc.rootNode(), "option1") == false);
         REQUIRE(XmlHasProp(doc.rootNode(), "option123") == false);
+        logger->log("content: '%s'", doc.rootNode().first_child().child_value());
+        REQUIRE(XmlHaveChildContent(doc.rootNode()) == false);
     }
 
     SECTION("load3")
@@ -82,6 +86,24 @@ TEST_CASE("xml doc")
         REQUIRE(xmlTypeEqual(doc.rootNode(), XML_ELEMENT_NODE) == true);
         REQUIRE(XmlHasProp(doc.rootNode(), "option1") == false);
         REQUIRE(XmlHasProp(doc.rootNode(), "option123") == false);
+        REQUIRE(XmlHaveChildContent(doc.rootNode()) == false);
+    }
+
+    SECTION("load4")
+    {
+        const char *xml = "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
+            "<root>this is test</root>";
+        XML::Document doc(xml, strlen(xml));
+        REQUIRE(doc.isLoaded() == true);
+        REQUIRE(doc.isValid() == true);
+        REQUIRE(doc.rootNode() != nullptr);
+        REQUIRE(xmlNameEqual(doc.rootNode(), "root") == true);
+        REQUIRE(xmlNameEqual(doc.rootNode(), "root123") == false);
+        REQUIRE(xmlTypeEqual(doc.rootNode(), XML_ELEMENT_NODE) == true);
+        REQUIRE(XmlHasProp(doc.rootNode(), "option1") == false);
+        REQUIRE(XmlHasProp(doc.rootNode(), "option123") == false);
+        REQUIRE(XmlHaveChildContent(doc.rootNode()) == true);
+        REQUIRE(!strcmp(XmlChildContent(doc.rootNode()), "this is test"));
     }
 
     SECTION("properties")
@@ -101,7 +123,8 @@ TEST_CASE("xml doc")
             SkipError_false);
 
         const XmlNodePtr rootNode = doc.rootNode();
-        XmlNodePtr node = nullptr;
+//        REQUIRE(XmlHaveChildContent(rootNode) == true);
+        XmlNodePtr node = XmlNodeDefault;
         for_each_xml_child_node(widgetNode, rootNode)
         {
             node = widgetNode;
@@ -111,6 +134,7 @@ TEST_CASE("xml doc")
         REQUIRE(node != nullptr);
         REQUIRE(xmlTypeEqual(node, XML_ELEMENT_NODE) == true);
         REQUIRE(xmlNameEqual(node, "widget") == true);
+//        REQUIRE(XmlHaveChildContent(node) == true);
         for_each_xml_child_node(optionNode, node)
         {
             node = optionNode;
@@ -120,6 +144,7 @@ TEST_CASE("xml doc")
         REQUIRE(node != nullptr);
         REQUIRE(xmlTypeEqual(node, XML_ELEMENT_NODE) == true);
         REQUIRE(xmlNameEqual(node, "option") == true);
+        REQUIRE(XmlHaveChildContent(node) == false);
         REQUIRE(XmlHasProp(node, "name") == true);
         REQUIRE(XmlHasProp(node, "value") == true);
         REQUIRE(XmlHasProp(node, "option123") == false);
@@ -142,10 +167,12 @@ TEST_CASE("xml doc")
         REQUIRE(node != nullptr);
         REQUIRE(xmlTypeEqual(node, XML_ELEMENT_NODE) == true);
         REQUIRE(xmlNameEqual(node, "widget") == true);
+//        REQUIRE(XmlHaveChildContent(node) == true);
         node = XML::findFirstChildByName(node, "option");
         REQUIRE(node != nullptr);
         REQUIRE(xmlTypeEqual(node, XML_ELEMENT_NODE) == true);
         REQUIRE(xmlNameEqual(node, "option") == true);
+        REQUIRE(XmlHaveChildContent(node) == false);
         REQUIRE(XmlHasProp(node, "name") == true);
         REQUIRE(XmlHasProp(node, "value") == true);
         REQUIRE(XmlHasProp(node, "option123") == false);
@@ -163,15 +190,17 @@ TEST_CASE("xml doc")
 
     SECTION("child2")
     {
-        const std::string xml = "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
+        const char *xml = "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
             "<root><data option1=\"false\" option2=\"true\" "
             "option3=\"10.5\"/></root>";
-        XML::Document doc(xml.c_str(), xml.size());
+        XML::Document doc(xml, strlen(xml));
         const XmlNodePtr rootNode = doc.rootNode();
+        REQUIRE(XmlHaveChildContent(rootNode) == false);
         XmlNodePtr node = XML::findFirstChildByName(rootNode, "data");
         REQUIRE(node != nullptr);
         REQUIRE(xmlTypeEqual(node, XML_ELEMENT_NODE) == true);
         REQUIRE(xmlNameEqual(node, "data") == true);
+        REQUIRE(XmlHaveChildContent(node) == false);
         REQUIRE(XmlHasProp(node, "option1") == true);
         REQUIRE(XmlHasProp(node, "option123") == false);
         REQUIRE(XML::getBoolProperty(node, "option1", true) == false);
@@ -189,10 +218,12 @@ TEST_CASE("xml doc")
             "option3=\"10.5\"/><!-- comment --></root>";
         XML::Document doc(xml.c_str(), xml.size());
         const XmlNodePtr rootNode = doc.rootNode();
+//        REQUIRE(XmlHaveChildContent(rootNode) == true);
         XmlNodePtr node = XML::findFirstChildByName(rootNode, "data");
         REQUIRE(node != nullptr);
         REQUIRE(xmlTypeEqual(node, XML_ELEMENT_NODE) == true);
         REQUIRE(xmlNameEqual(node, "data") == true);
+        REQUIRE(XmlHaveChildContent(node) == false);
         REQUIRE(XmlHasProp(node, "option1") == true);
         REQUIRE(XmlHasProp(node, "option123") == false);
         REQUIRE(XML::getBoolProperty(node, "option1", true) == false);