XML::Document Class Reference

#include <libxml.h>

Inheritance diagram for XML::Document:

Public Member Functions
	Document (const std::string &filename, const UseVirtFs useResman, const SkipError skipError)
	Document (const char *const data, const int size)
	~Document ()
xmlNodePtr	rootNode ()
bool	isLoaded () const
bool	isValid () const
Public Member Functions inherited from Resource
	Resource ()
	~Resource ()
virtual void	incRef ()
virtual void	decRef ()
int	calcMemoryLocal () const
std::string	getCounterName () const
Public Member Functions inherited from MemoryCounter
	MemoryCounter ()
virtual	~MemoryCounter ()
int	calcMemory (const int level) const
virtual int	calcMemoryChilds (const int level) const

Static Public Member Functions
static bool	validateXml (const std::string &fileName)

Private Attributes
xmlDocPtr	mDoc
bool	mIsValid

Additional Inherited Members
Data Fields inherited from Resource
time_t	mTimeStamp
std::string	mIdPath
std::string	mSource
unsigned int	mRefCount
bool	mProtected
bool	mNotCount

Detailed Description

A helper class for parsing an XML document, which also cleans it up again (RAII).

Definition at line 53 of file libxml.h.

Constructor & Destructor Documentation

Document() [1/2]

XML::Document::Document	(	const std::string &	filename,
		const UseVirtFs	useResman,
		const SkipError	skipError
	)

Constructor that attempts to load the given file through the resource manager. Logs errors.

Definition at line 87 of file libxml.cpp.

                                                  :
        Resource(),
        mDoc(nullptr),
        mIsValid(false)
    {
#ifdef USE_FUZZER
        if (Fuzzer::conditionTerminate(filename.c_str()))
            return;
#endif  // USE_FUZZER
 
        BLOCK_START("XML::Document::Document")
        int size = 0;
        char *data = nullptr;
        valid = true;
        if (useResman == UseVirtFs_true)
        {
            data = const_cast<char*>(VirtFs::loadFile(
                filename,
                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 = CAST_S32(file.tellg());
                if (size < 0)
                {
                    reportAlways("Error loading XML file %s",
                        filename.c_str())
                }
                else
                {
                    file.seekg(0, std::ios::beg);
                    data = new char[size];
                    file.read(data, size);
                }
                file.close();
            }
            else if (skipError == SkipError_false)
            {
                reportAlways("Error loading XML file %s",
                    filename.c_str())
            }
        }
 
        if (data != nullptr)
        {
            mDoc = xmlParseMemory(data, size);
            delete [] data;
 
            if (mDoc == nullptr)
            {
                reportAlways("Error parsing XML file %s", filename.c_str())
            }
        }
        else if (skipError == SkipError_false)
        {
            reportAlways("Error loading XML file %s", filename.c_str())
        }
        mIsValid = valid;
        BLOCK_END("XML::Document::Document")
    }

References BLOCK_END, BLOCK_START, CAST_S32, data, VirtFs::loadFile(), mDoc, mIsValid, reportAlways, EmoteDB::size(), SkipError_false, UseVirtFs_true, and anonymous_namespace{libxml.cpp}::valid.

Document() [2/2]

XML::Document::Document	(	const char *const	data,
		const int	size
	)

Constructor that attempts to load an XML document from memory. Does not log errors.

Parameters

data	the string to parse as XML
size	the length of the string in bytes

Definition at line 157 of file libxml.cpp.

                                                             :
        mDoc(data != nullptr ? xmlParseMemory(data, size) : nullptr),
        mIsValid(true)
    {
    }

~Document()

XML::Document::~Document

(

)

Destructor. Frees the loaded XML file.

Definition at line 163 of file libxml.cpp.

    {
        if (mDoc != nullptr)
            xmlFreeDoc(mDoc);
    }

References mDoc.

Member Function Documentation

isLoaded()

bool XML::Document::isLoaded ( ) const

inline

Definition at line 86 of file libxml.h.

            { return mDoc != nullptr; }

References mDoc.

isValid()

bool XML::Document::isValid ( ) const

inline

Definition at line 89 of file libxml.h.

            { return mIsValid; }

References mIsValid.

rootNode()

xmlNodePtr XML::Document::rootNode

(

)

Returns the root node of the document (or NULL if there was a load error).

Definition at line 169 of file libxml.cpp.

    {
        return mDoc != nullptr ? xmlDocGetRootElement(mDoc) : nullptr;
    }

References mDoc.

Referenced by Particle::addEffect(), ParticleEngine::addEffect(), MapReader::addLayerToList(), EquipmentWindow::fillBoxes(), SpriteDef::includeSprite(), Configuration::init(), CharDB::load(), SpriteDef::load(), ColorDB::loadColorLists(), Theme::loadColors(), ColorDB::loadHair(), MapDB::loadInfo(), Theme::loadInfo(), MapDB::loadRemapXmlFile(), ServerDialog::loadServers(), EmoteDB::loadSpecialXmlFile(), loadXMLFile(), EffectManager::loadXmlFile(), SkillDialog::loadXmlFile(), AvatarDB::loadXmlFile(), ClanDb::loadXmlFile(), CommandsDB::loadXmlFile(), DeadDB::loadXmlFile(), ElementalDb::loadXmlFile(), EmoteDB::loadXmlFile(), GroupDb::loadXmlFile(), HomunculusDB::loadXmlFile(), HorseDB::loadXmlFile(), ItemFieldDb::loadXmlFile(), ItemOptionDb::loadXmlFile(), LanguageDb::loadXmlFile(), MercenaryDB::loadXmlFile(), ModDB::loadXmlFile(), MonsterDB::loadXmlFile(), NPCDB::loadXmlFile(), NpcDialogDB::loadXmlFile(), PETDB::loadXmlFile(), QuestDb::loadXmlFile(), SkillUnitDb::loadXmlFile(), SoundDB::loadXmlFile(), StatDb::loadXmlFile(), StatusEffectDB::loadXmlFile(), TextDb::loadXmlFile(), UnitsDb::loadXmlFile(), ItemDB::loadXmlFile(), EquipmentWindow::prepareSlotNames(), Theme::readSkin(), MapReader::readTileset(), readXmlIntMap(), readXmlIntVector(), readXmlStringMap(), and Configuration::reInit().

validateXml()

bool XML::Document::validateXml ( const std::string &  fileName )

static

Definition at line 320 of file libxml.cpp.

    {
        const xmlDocPtr doc = xmlReadFile(fileName.c_str(),
            nullptr, XML_PARSE_PEDANTIC);
        const bool valid1(doc != nullptr);
        xmlFreeDoc(doc);
        if (!valid1)
            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;
    }

References fileName, and strStartWith().

Referenced by Net::Download::downloadThread().

Field Documentation

mDoc

xmlDocPtr XML::Document::mDoc

private

Definition at line 95 of file libxml.h.

Referenced by Document(), isLoaded(), rootNode(), and ~Document().

mIsValid

bool XML::Document::mIsValid

private

Definition at line 96 of file libxml.h.

Referenced by Document(), and isValid().

---

The documentation for this class was generated from the following files:

• src/utils/xml/libxml.h (986a3bf)
• src/utils/xml/libxml.cpp (986a3bf)