summaryrefslogtreecommitdiff
path: root/src/utils/xml/libxml.h
diff options
context:
space:
mode:
authorAndrei Karas <akaras@inbox.ru>2015-11-29 23:37:08 +0300
committerAndrei Karas <akaras@inbox.ru>2016-01-19 22:28:32 +0300
commit7e7109fa019b3a7ac95d2cdb139948603d541b20 (patch)
treeb4fc74e1172aea4c2e0add7481f6113c75b9f415 /src/utils/xml/libxml.h
parenta0366810ba246c5a84dd5e32af4a23dc799cc7f3 (diff)
downloadmanaplus-7e7109fa019b3a7ac95d2cdb139948603d541b20.tar.gz
manaplus-7e7109fa019b3a7ac95d2cdb139948603d541b20.tar.bz2
manaplus-7e7109fa019b3a7ac95d2cdb139948603d541b20.tar.xz
manaplus-7e7109fa019b3a7ac95d2cdb139948603d541b20.zip
Move xml class based on libxml into libxml.cpp file.
Diffstat (limited to 'src/utils/xml/libxml.h')
-rw-r--r--src/utils/xml/libxml.h171
1 files changed, 171 insertions, 0 deletions
diff --git a/src/utils/xml/libxml.h b/src/utils/xml/libxml.h
new file mode 100644
index 000000000..a783c09c2
--- /dev/null
+++ b/src/utils/xml/libxml.h
@@ -0,0 +1,171 @@
+/*
+ * 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_LIBXML_H
+#define UTILS_XML_LIBXML_H
+
+#ifdef ENABLE_LIBXML
+
+#include "enums/simpletypes/skiperror.h"
+#include "enums/simpletypes/useresman.h"
+
+#include <libxml/tree.h>
+#include <libxml/xmlwriter.h>
+
+#include <string>
+
+#include "localconsts.h"
+
+#define XmlNodePtr xmlNodePtr
+#define XmlNodePtrConst xmlNode *const
+#define XmlStrEqual(str1, str2) xmlStrEqual(str1, \
+ reinterpret_cast<const xmlChar*>(str2))
+#define xmlNameEqual(node, str) xmlStrEqual((node)->name, \
+ reinterpret_cast<const xmlChar*>(str))
+#define XmlTextWriterPtr xmlTextWriterPtr
+#define xmlTypeEqual(node, typ) ((node)->type == (typ))
+#define XmlHasProp(node, name) (xmlHasProp(node, \
+ reinterpret_cast<const xmlChar*>(name)) != nullptr)
+#define XmlGetProp(node, name) xmlGetProp(node, \
+ reinterpret_cast<const xmlChar*>(name))
+#define XmlTextWriterStartElement(writer, name) \
+ xmlTextWriterStartElement(writer, reinterpret_cast<const xmlChar*>(name))
+#define XmlTextWriterWriteAttribute(writer, name, content) \
+ xmlTextWriterWriteAttribute(writer, \
+ reinterpret_cast<const xmlChar*>(name), \
+ reinterpret_cast<const xmlChar*>(content))
+
+/**
+ * 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 != nullptr; }
+
+ bool isValid() const
+ { return mIsValid; }
+
+ static bool validateXml(const std::string &fileName);
+
+ private:
+ xmlDocPtr mDoc;
+ 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 (XmlNodePtr var = parent->xmlChildrenNode; var; var = var->next)
+
+#endif // ENABLE_LIBXML
+#endif // UTILS_XML_LIBXML_H