diff options
Diffstat (limited to 'src/utils')
-rw-r--r-- | src/utils/xml.h | 145 | ||||
-rw-r--r-- | src/utils/xml/libxml.cpp (renamed from src/utils/xml.cpp) | 6 | ||||
-rw-r--r-- | src/utils/xml/libxml.h | 171 |
3 files changed, 177 insertions, 145 deletions
diff --git a/src/utils/xml.h b/src/utils/xml.h index fe56917eb..055f93cbf 100644 --- a/src/utils/xml.h +++ b/src/utils/xml.h @@ -1,7 +1,5 @@ /* * The ManaPlus Client - * Copyright (C) 2004-2009 The Mana World Development Team - * Copyright (C) 2009-2010 The Mana Developers * Copyright (C) 2011-2016 The ManaPlus Developers * * This file is part of The ManaPlus Client. @@ -23,147 +21,6 @@ #ifndef UTILS_XML_H #define UTILS_XML_H -#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 XmlTextWriterEndElement(writer) xmlTextWriterEndElement(writer) -#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) +#include "utils/xml/libxml.h" #endif // UTILS_XML_H diff --git a/src/utils/xml.cpp b/src/utils/xml/libxml.cpp index 4d7688b1b..29bd83b4b 100644 --- a/src/utils/xml.cpp +++ b/src/utils/xml/libxml.cpp @@ -20,7 +20,9 @@ * along with this program. If not, see <http://www.gnu.org/licenses/>. */ -#include "utils/xml.h" +#ifdef ENABLE_LIBXML + +#include "utils/xml/libxml.h" #include "logger.h" @@ -309,3 +311,5 @@ namespace XML return true; } } // namespace XML + +#endif // ENABLE_LIBXML 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 |