libxml.h

Go to the documentation of this file.

/*
 * The ManaPlus Client
 * Copyright (C) 2004-2009 The Mana World Development Team
 * Copyright (C) 2009-2010 The Mana Developers
 * Copyright (C) 2011-2019 The ManaPlus Developers
 * Copyright (C) 2019-2021 Andrei Karas
 *
 * 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
 
#define XML_INCLUDE_DEFINE
 
#include "enums/simpletypes/skiperror.h"
#include "enums/simpletypes/usevirtfs.h"
 
#include "utils/xml/libxml.inc"
 
#include "resources/resource.h"
 
#ifndef _GLIBCXX_STRING
#include <string>
#endif // _GLIBCXX_STRING
 
#include "localconsts.h"
 
namespace XML
{
 class Document final : public Resource
 {
 public:
 Document(const std::string &filename,
 const UseVirtFs useResman,
 const SkipError skipError);
 
 Document(const char *const data, const int size);
 
 A_DELETE_COPY(Document)
 
 
 ~Document() override final;
 
 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;
 };
 
 float getFloatProperty(XmlNodeConstPtr node,
 const char *const name,
 float def) A_WARN_UNUSED;
 
 double getDoubleProperty(XmlNodeConstPtr node,
 const char *const name,
 double def) A_WARN_UNUSED;
 
 int getProperty(XmlNodeConstPtr node,
 const char *const name,
 int def) A_WARN_UNUSED;
 
 int getIntProperty(XmlNodeConstPtr node,
 const char *const name,
 int def,
 const int min,
 const int max) A_WARN_UNUSED;
 
 std::string getProperty(XmlNodeConstPtr node,
 const char *const name,
 const std::string &def) A_WARN_UNUSED;
 
 std::string langProperty(XmlNodeConstPtr node,
 const char *const name,
 const std::string &def) A_WARN_UNUSED;
 
 bool getBoolProperty(XmlNodeConstPtr node,
 const char *const name,
 const bool def) A_WARN_UNUSED;
 
 XmlNodePtr findFirstChildByName(XmlNodeConstPtrConst 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