XMLParser Class Reference

Utility for parsing XML files. More...

#include "XMLParser.h"

Inheritance diagram for XMLParser:

Collaboration diagram for XMLParser:

Classes
class	ElementParser
	This virtual interface must be implemented by all parsers. More...

Public Member Functions
	XMLParser ()
	Primary constructor. More...
virtual	~XMLParser ()
	A destructor. More...
bool	ParseFile (const char *file)
	Parses file using registered parsers. More...
bool	ParseElement (const TiXmlElement *element) const
	Parses element using registered parsers. More...
bool	ParseElementChildren (const TiXmlElement *element, size_t max=0) const
	Parses element's children using registered parsers. More...
void	AddParser (const char *name, ElementParser *parser)
	Adds a parser. More...
void	RemoveParser (const char *name)
	Removes a parser. More...
void	ClearParsers ()
	Clears all parsers. More...

Public Attributes
std::unique_ptr< TiXmlDocument >	m_pXML_Document

Private Attributes
std::map< std::string, ElementParser * >	mParsers

Detailed Description

Utility for parsing XML files.

Author

Zhur, Bloody.Rabbit

Definition at line 34 of file XMLParser.h.

Constructor & Destructor Documentation

XMLParser::XMLParser

(

)

Primary constructor.

Definition at line 35 of file XMLParser.cpp.

{
}

XMLParser::~XMLParser ( )

virtual

A destructor.

Definition at line 39 of file XMLParser.cpp.

References ClearParsers().

{
    ClearParsers();
}

Here is the call graph for this function:

Member Function Documentation

void XMLParser::AddParser	(	const char *	name,
		ElementParser *	parser
	)

Adds a parser.

Parameters

[in]	name	Name of element to be parsed by the parser.
[in]	parser	The parser itself.

Definition at line 101 of file XMLParser.cpp.

References mParsers.

Referenced by XMLParserEx::AddMemberParser(), and XMLParserEx::AddValueParser().

{
    mParsers[ name ] = parser;
}

Here is the caller graph for this function:

void XMLParser::ClearParsers

(

)

Clears all parsers.

Definition at line 115 of file XMLParser.cpp.

References mParsers, and SafeDelete().

Referenced by ~XMLParser().

                             {
    for (auto cur : mParsers)
        SafeDelete(cur.second);

    mParsers.clear();
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool XMLParser::ParseElement

(

const TiXmlElement *

element

)

const

Parses element using registered parsers.

Parameters

[in]

element

Element to be parsed.

Return values

true	Parsing successful.
false	Error occurred during parsing.

Definition at line 61 of file XMLParser.cpp.

References mParsers, and sLog.

Referenced by ParseElementChildren(), XMLPacketGen::ParseElementDef(), ParseFile(), ClassDecodeGenerator::ProcessElementDef(), ClassEncodeGenerator::ProcessElementDef(), and ClassHeaderGenerator::ProcessElementDef().

{
    std::map<std::string, ElementParser*>::const_iterator res = mParsers.find( element->Value() );
    if (res == mParsers.end()) {
        sLog.Error( "XMLParser", "Unknown element '%s' at line %d.", element->Value(), element->Row() );
        return true;    // Ignore any unanticipated XML tags and structures and continue parsing the rest of the XML
    }

    return res->second->Parse( element );
}

Here is the caller graph for this function:

bool XMLParser::ParseElementChildren	(	const TiXmlElement *	element,
		size_t	max = 0
	)		const

Parses element's children using registered parsers.

Parameters

[in]	element	Element the children of which should be parsed.
[in]	max	The maximal count of children to be processed; 0 means all.

Return values

true	Parsing successful.
false	Error occurred during parsing.

Definition at line 72 of file XMLParser.cpp.

References ParseElement(), and sLog.

Referenced by XMLPacketGen::ParseElements(), EVEServerConfig::ProcessAccount(), MarketBotConf::ProcessBotConf(), EVEServerConfig::ProcessBPTimes(), MarketBotConf::ProcessBuy(), EVEServerConfig::ProcessCharacter(), EVEServerConfig::ProcessChat(), EVEServerConfig::ProcessCosmic(), EVEServerConfig::ProcessCrime(), EVEServerConfig::ProcessDatabase(), EVEServerConfig::ProcessDebug(), ClassCloneGenerator::ProcessDictInline(), ClassConstructGenerator::ProcessDictInline(), ClassDestructGenerator::ProcessDictInline(), ClassDumpGenerator::ProcessDictInline(), ClassDecodeGenerator::ProcessDictInline(), ClassEncodeGenerator::ProcessDictInline(), ClassHeaderGenerator::ProcessDictInline(), ClassCloneGenerator::ProcessDictInlineEntry(), ClassConstructGenerator::ProcessDictInlineEntry(), ClassDestructGenerator::ProcessDictInlineEntry(), ClassDumpGenerator::ProcessDictInlineEntry(), ClassHeaderGenerator::ProcessDictInlineEntry(), ClassConstructGenerator::ProcessElementDef(), ClassDestructGenerator::ProcessElementDef(), ClassCloneGenerator::ProcessElementDef(), ClassDumpGenerator::ProcessElementDef(), EVEServerConfig::ProcessEveServer(), EVEServerConfig::ProcessExploring(), EVEServerConfig::ProcessFiles(), ClassConstructGenerator::ProcessListInline(), ClassDestructGenerator::ProcessListInline(), ClassDumpGenerator::ProcessListInline(), ClassCloneGenerator::ProcessListInline(), ClassDecodeGenerator::ProcessListInline(), ClassEncodeGenerator::ProcessListInline(), ClassHeaderGenerator::ProcessListInline(), MarketBotConf::ProcessMain(), EVEServerConfig::ProcessMarket(), EVEServerConfig::ProcessNet(), EVEServerConfig::ProcessNPC(), NPCMarket::ProcessNPCOrders(), ClassConstructGenerator::ProcessObjectInline(), ClassDestructGenerator::ProcessObjectInline(), ClassDumpGenerator::ProcessObjectInline(), ClassCloneGenerator::ProcessObjectInline(), ClassDecodeGenerator::ProcessObjectInline(), ClassEncodeGenerator::ProcessObjectInline(), ClassHeaderGenerator::ProcessObjectInline(), NPCMarket::ProcessOrder(), EVEServerConfig::ProcessRates(), MarketBotConf::ProcessSell(), EVEServerConfig::ProcessServer(), EVEServerConfig::ProcessStandings(), NPCMarket::ProcessStation(), ClassDumpGenerator::ProcessSubStreamInline(), ClassConstructGenerator::ProcessSubStreamInline(), ClassCloneGenerator::ProcessSubStreamInline(), ClassDestructGenerator::ProcessSubStreamInline(), ClassDecodeGenerator::ProcessSubStreamInline(), ClassEncodeGenerator::ProcessSubStreamInline(), ClassHeaderGenerator::ProcessSubStreamInline(), ClassDumpGenerator::ProcessSubStructInline(), ClassDestructGenerator::ProcessSubStructInline(), ClassConstructGenerator::ProcessSubStructInline(), ClassCloneGenerator::ProcessSubStructInline(), ClassDecodeGenerator::ProcessSubStructInline(), ClassEncodeGenerator::ProcessSubStructInline(), ClassHeaderGenerator::ProcessSubStructInline(), EVEServerConfig::ProcessTesting(), EVEServerConfig::ProcessThreads(), ClassConstructGenerator::ProcessTupleInline(), ClassCloneGenerator::ProcessTupleInline(), ClassDumpGenerator::ProcessTupleInline(), ClassDestructGenerator::ProcessTupleInline(), ClassDecodeGenerator::ProcessTupleInline(), ClassHeaderGenerator::ProcessTupleInline(), ClassEncodeGenerator::ProcessTupleInline(), and EVEServerConfig::ProcessWorld().

{
    const TiXmlNode* child = nullptr;

    size_t count = 0;
    while ((child = element->IterateChildren(child))) {
        if (child->Type() == TiXmlNode::TINYXML_ELEMENT) {
            const TiXmlElement* childElement = child->ToElement();
            if ((max > 0) && (max <= count)) {
                sLog.Error( "XMLParser", "Maximal children count %lu exceeded"
                                         " in element '%s' at line %d"
                                         " by element '%s' at line %d.",
                                         max,
                                         element->Value(), element->Row(),
                                         childElement->Value(), childElement->Row() );

                return false;
            }

            if (!ParseElement(childElement))
                return false;

            ++count;
        }
    }

    return true;
}

Here is the call graph for this function:

bool XMLParser::ParseFile

(

const char *

file

)

Parses file using registered parsers.

Parameters

[in]

file

File to parse.

Return values

true	Parsing successful.
false	Error occurred during parsing.

Definition at line 44 of file XMLParser.cpp.

References m_pXML_Document, ParseElement(), and sLog.

Referenced by NPCMarket::CreateNPCMarketFromFile(), and main().

{
    m_pXML_Document = make_unique<TiXmlDocument>(file);
    if (!m_pXML_Document->LoadFile()) {
        sLog.Error( "XMLParser", "Unable to load '%s': %s.", file, m_pXML_Document->ErrorDesc() );
        return false;
    }

    TiXmlElement* root = m_pXML_Document->RootElement();
    if (root == nullptr) {
        sLog.Error( "XMLParser", "Unable to find root in '%s'.", file );
        return false;
    }

    return ParseElement( root );
}

Here is the call graph for this function:

Here is the caller graph for this function:

void XMLParser::RemoveParser

(

const char *

name

)

Removes a parser.

Parameters

[in]

name

Name of element to be parsed by the parser.

Definition at line 106 of file XMLParser.cpp.

References mParsers, and SafeDelete().

Referenced by EVEServerConfig::ProcessAccount(), MarketBotConf::ProcessBotConf(), EVEServerConfig::ProcessBPTimes(), MarketBotConf::ProcessBuy(), EVEServerConfig::ProcessCharacter(), EVEServerConfig::ProcessChat(), EVEServerConfig::ProcessCosmic(), EVEServerConfig::ProcessCrime(), EVEServerConfig::ProcessDatabase(), EVEServerConfig::ProcessDebug(), EVEServerConfig::ProcessEveServer(), EVEServerConfig::ProcessExploring(), EVEServerConfig::ProcessFiles(), MarketBotConf::ProcessMain(), EVEServerConfig::ProcessMarket(), EVEServerConfig::ProcessNet(), EVEServerConfig::ProcessNPC(), NPCMarket::ProcessNPCOrders(), EVEServerConfig::ProcessRates(), MarketBotConf::ProcessSell(), EVEServerConfig::ProcessServer(), EVEServerConfig::ProcessStandings(), EVEServerConfig::ProcessTesting(), EVEServerConfig::ProcessThreads(), and EVEServerConfig::ProcessWorld().

{
    std::map<std::string, ElementParser*>::iterator res = mParsers.find( name );
    if( mParsers.end() != res ) {
        SafeDelete(res->second);
        mParsers.erase(res);
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

std::unique_ptr<TiXmlDocument> XMLParser::m_pXML_Document

Definition at line 113 of file XMLParser.h.

Referenced by ParseFile().

std::map<std::string, ElementParser*> XMLParser::mParsers

private

Parser storage.

Definition at line 117 of file XMLParser.h.

Referenced by AddParser(), ClearParsers(), ParseElement(), and RemoveParser().

---

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

• /backups/local/src/eve/EvEmu_Crucible/src/eve-core/utils/XMLParser.h
• /backups/local/src/eve/EvEmu_Crucible/src/eve-core/utils/XMLParser.cpp