XML Namespace Reference

Data Structures
class	Document

Functions
int	getProperty (const xmlNodePtr node, const char *const name, int def)
int	getIntProperty (const xmlNodePtr node, const char *const name, int def, const int min, const int max)
float	getFloatProperty (const xmlNodePtr node, const char *const name, float def)
double	getDoubleProperty (const xmlNodePtr node, const char *const name, double def)
std::string	getProperty (const xmlNodePtr node, const char *const name, const std::string &def)
std::string	langProperty (const xmlNodePtr node, const char *const name, const std::string &def)
bool	getBoolProperty (const xmlNodePtr node, const char *const name, const bool def)
xmlNodePtr	findFirstChildByName (const xmlNode *const parent, const char *const name)
void	initXML ()
void	cleanupXML ()

Detailed Description

XML helper functions.

Function Documentation

cleanupXML()

void XML::cleanupXML

(

)

Definition at line 315 of file libxml.cpp.

    {
        xmlCleanupParser();
    }

Referenced by Client::gameClear().

findFirstChildByName()

xmlNodePtr XML::findFirstChildByName	(	const xmlNode *const	parent,
		const char *const	name
	)

Finds the first child node with the given name

Definition at line 289 of file libxml.cpp.

    {
        if (parent == nullptr)
            return nullptr;
        for_each_xml_child_node(child, parent)
        {
            if (xmlNameEqual(child, name))
                return child;
        }
 
        return nullptr;
    }

References for_each_xml_child_node.

Referenced by Particle::addEffect(), and ParticleEngine::addEffect().

getBoolProperty()

bool XML::getBoolProperty	(	const xmlNodePtr	node,
		const char *const	name,
		const bool	def
	)

Gets a boolean property from an XmlNodePtr.

Definition at line 269 of file libxml.cpp.

    {
        xmlChar *const prop = XmlGetProp(node, name);
 
        if (XmlStrEqual(prop, "true"))
        {
            XmlFree(prop);
            return true;
        }
        if (XmlStrEqual(prop, "false"))
        {
            XmlFree(prop);
            return false;
        }
        XmlFree(prop);
        return def;
    }

Referenced by Particle::addEffect(), ParticleEngine::addEffect(), loadFields(), loadPermissions(), SkillDialog::loadSkill(), SkillDialog::loadSkillData(), GroupDb::loadXmlFile(), NPCDB::loadXmlFile(), NpcDialogDB::loadXmlFile(), PETDB::loadXmlFile(), SkillUnitDb::loadXmlFile(), TextDb::loadXmlFile(), ItemDB::loadXmlFile(), and ParticleEmitter::ParticleEmitter().

getDoubleProperty()

double XML::getDoubleProperty	(	const xmlNodePtr	node,
		const char *const	name,
		double	def
	)

Gets an double point property from an XmlNodePtr.

Definition at line 227 of file libxml.cpp.

    {
        double &ret = def;
 
        xmlChar *const prop = XmlGetProp(node, name);
        if (prop != nullptr)
        {
            ret = atof(reinterpret_cast<char*>(prop));
            xmlFree(prop);
        }
 
        return ret;
    }

Referenced by ParticleEmitter::readParticleEmitterProp().

getFloatProperty()

float XML::getFloatProperty	(	const xmlNodePtr	node,
		const char *const	name,
		float	def
	)

Gets an floating point property from an XmlNodePtr.

Definition at line 211 of file libxml.cpp.

    {
        float &ret = def;
 
        xmlChar *const prop = XmlGetProp(node, name);
        if (prop != nullptr)
        {
            ret = static_cast<float>(atof(reinterpret_cast<char*>(prop)));
            xmlFree(prop);
        }
 
        return ret;
    }

Referenced by Particle::addEffect(), ParticleEngine::addEffect(), SkillDialog::loadSkillData(), ItemDB::loadXmlFile(), and BeingCommon::readObjectNodes().

getIntProperty()

int XML::getIntProperty	(	const xmlNodePtr	node,
		const char *const	name,
		int	def,
		const int	min,
		const int	max
	)

Gets an integer property from an XmlNodePtr.

Definition at line 190 of file libxml.cpp.

    {
        int &ret = def;
 
        xmlChar *const prop = XmlGetProp(node, name);
        if (prop != nullptr)
        {
            ret = atoi(reinterpret_cast<char*>(prop));
            xmlFree(prop);
        }
        if (ret < min)
            ret = min;
        else if (ret > max)
            ret = max;
        return ret;
    }

Referenced by SimpleAnimation::initializeAnimation(), SpriteDef::loadAnimation(), loadNpcDialogInventory(), loadNpcDialogMenu(), loadQuest(), SkillDialog::loadSkill(), CommandsDB::loadXmlFile(), ItemDB::loadXmlFile(), and ParticleEmitter::ParticleEmitter().

getProperty() [1/2]

std::string XML::getProperty	(	const xmlNodePtr	node,
		const char *const	name,
		const std::string &	def
	)

Gets a string property from an XmlNodePtr.

Definition at line 243 of file libxml.cpp.

    {
        xmlChar *const prop = XmlGetProp(node, name);
        if (prop != nullptr)
        {
            std::string val = reinterpret_cast<char*>(prop);
            xmlFree(prop);
            return val;
        }
 
        return def;
    }

getProperty() [2/2]

int XML::getProperty	(	const xmlNodePtr	node,
		const char *const	name,
		int	def
	)

Gets an integer property from an XmlNodePtr.

Definition at line 174 of file libxml.cpp.

    {
        int &ret = def;
 
        xmlChar *const prop = XmlGetProp(node, name);
        if (prop != nullptr)
        {
            ret = atoi(reinterpret_cast<const char*>(prop));
            xmlFree(prop);
        }
 
        return ret;
    }

Referenced by Particle::addEffect(), ParticleEngine::addEffect(), addFieldByName(), MapReader::addLayerToList(), EquipmentWindow::fillBoxes(), ParticleEmitter::getImageSet(), SpriteDef::includeSprite(), ConfigurationObject::initFromXML(), SimpleAnimation::initializeAnimation(), langProperty(), CharDB::load(), SpriteDef::loadAction(), SpriteDef::loadAnimation(), loadBasicStats(), ColorDB::loadColorLists(), Theme::loadColors(), loadCommands(), loadCurrencies(), loadEffect(), loadFields(), loadFloorSprite(), ColorDB::loadHair(), SpriteDef::loadImageSet(), MapDB::loadInfo(), loadMenu(), CharDB::loadMinMax(), loadNpcDialogInventory(), loadNpcDialogMenu(), loadOffset(), loadOrderSprite(), loadPermissions(), EquipmentWindow::loadPlayerBox(), loadQuest(), MapDB::loadRemapXmlFile(), loadReplaceSprite(), loadRiderOffset(), ServerDialog::loadServers(), SkillDialog::loadSkill(), SkillDialog::loadSkillData(), EquipmentWindow::loadSlot(), loadSoundRef(), EmoteDB::loadSpecialXmlFile(), SpriteDef::loadSprite(), loadSpriteRef(), loadStats(), loadUnit(), 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(), ParticleEmitter::ParticleEmitter(), EquipmentWindow::prepareSlotNames(), BeingCommon::readAiAttributes(), MapDB::readAtlas(), BeingCommon::readBasicAttributes(), readField(), MapReader::readLayer(), MapDB::readMap(), BeingCommon::readObjectNodes(), ParticleEmitter::readParticleEmitterProp(), MapReader::readProperties(), Theme::readSkin(), MapReader::readTileset(), BeingCommon::readWalkingAttributes(), readXmlIntMap(), readXmlIntVector(), and readXmlStringMap().

initXML()

void XML::initXML

(

)

Definition at line 305 of file libxml.cpp.

    {
        xmlInitParser();
        LIBXML_TEST_VERSION
 
        // Suppress libxml2 error messages
        xmlSetGenericErrorFunc(nullptr, &xmlErrorLogger);
    }

References xmlErrorLogger().

Referenced by mainGui().

langProperty()

std::string XML::langProperty	(	const xmlNodePtr	node,
		const char *const	name,
		const std::string &	def
	)

Gets a translated string property from an XmlNodePtr.

Definition at line 258 of file libxml.cpp.

    {
        std::string str = getProperty(node, name, def);
        if (translator == nullptr)
            return str;
 
        return translator->getStr(str);
    }

References getProperty(), PoDict::getStr(), and translator.

Referenced by ColorDB::loadColorLists(), loadFields(), ColorDB::loadHair(), loadHostsGroup(), loadMenu(), EquipmentWindow::loadPage(), loadQuest(), ServerDialog::loadServers(), loadServerSourcesList(), SkillDialog::loadSkill(), SkillDialog::loadSkillData(), EmoteDB::loadSpecialXmlFile(), AvatarDB::loadXmlFile(), ClanDb::loadXmlFile(), CommandsDB::loadXmlFile(), EmoteDB::loadXmlFile(), GroupDb::loadXmlFile(), HomunculusDB::loadXmlFile(), MercenaryDB::loadXmlFile(), ModDB::loadXmlFile(), MonsterDB::loadXmlFile(), NPCDB::loadXmlFile(), PETDB::loadXmlFile(), SkillUnitDb::loadXmlFile(), StatDb::loadXmlFile(), StatusEffectDB::loadXmlFile(), ItemDB::loadXmlFile(), and parseInherit().