Configuration Class Reference

#include <configuration.h>

Inheritance diagram for Configuration:

Public Member Functions
	Configuration ()
	~Configuration ()
void	init (const std::string &filename, const UseVirtFs useResManager, const SkipError skipError)
void	reInit ()
void	unload ()
DefaultsData &	getDefaultValues ()
void	write ()
void	addListener (const std::string &key, ConfigListener *const listener)
void	removeListener (const std::string &key, ConfigListener *const listener)
void	removeListeners (ConfigListener *const listener)
void	setValue (const std::string &key, const std::string &value)
void	incValue (const std::string &key)
void	setSilent (const std::string &key, const std::string &value)
void	setValue (const std::string &key, const char *const value)
void	setSilent (const std::string &key, const char *const value)
void	setValue (const std::string &key, const float value)
void	setValue (const std::string &key, const double value)
void	setValue (const std::string &key, const int value)
void	setValueInt (const std::string &key, const int value)
void	setValue (const std::string &key, const unsigned value)
void	setValue (const std::string &key, const bool value)
void	setSilent (const std::string &key, const bool value)
int	resetIntValue (const std::string &key)
bool	resetBoolValue (const std::string &key)
const std::string &	getConfigPath () const
int	getIntValue (const std::string &key) const
float	getFloatValue (const std::string &key) const
std::string	getStringValue (const std::string &key) const
bool	getBoolValue (const std::string &key) const
std::string	getDirectory () const
void	removeOldKeys ()
std::string	getFileName () const
void	writeUpdated ()
void	cleanDefaults ()
Public Member Functions inherited from ConfigurationObject
virtual	~ConfigurationObject ()
void	deleteKey (const std::string &key)
std::string	getValue (const std::string &key, const std::string &deflt) const
int	getValue (const std::string &key, const int deflt) const
int	getValueInt (const std::string &key, const int deflt) const
bool	getValueBool (const std::string &key, const bool deflt) const
unsigned	getValue (const std::string &key, const unsigned deflt) const
double	getValue (const std::string &key, const double deflt) const
void	clear ()
template<class IT , class T , class CONT >
void	setList (const std::string &name, IT begin, IT end, ConfigurationListManager< T, CONT > *manager)
template<class T , class CONT >
CONT	getList (const std::string &name, CONT empty, ConfigurationListManager< T, CONT > *manager)

Private Types
typedef std::list< ConfigListener * >	Listeners
typedef Listeners::iterator	ListenerIterator
typedef std::map< std::string, Listeners >	ListenerMap
typedef ListenerMap::iterator	ListenerMapIterator

Private Attributes
ListenerMap	mListenerMap
std::string	mConfigPath
DefaultsData	mDefaultsData
	Defaults of value for a given key. More...
std::string	mDirectory
std::string	mFilename
UseVirtFs	mUseResManager
bool	mUpdated

Additional Inherited Members
Protected Types inherited from ConfigurationObject
typedef std::map< std::string, std::string >	Options
typedef std::list< ConfigurationObject * >	ConfigurationList
Protected Member Functions inherited from ConfigurationObject
	ConfigurationObject ()
virtual void	initFromXML (const xmlNode *const parentNode)
virtual void	writeToXML (const xmlTextWriterPtr writer)
void	deleteList (const std::string &name)
Protected Attributes inherited from ConfigurationObject
Options	mOptions
std::map< std::string, ConfigurationList >	mContainerOptions

Detailed Description

Configuration handler for reading (and writing).

Definition at line 236 of file configuration.h.

Member Typedef Documentation

ListenerIterator

typedef Listeners::iterator Configuration::ListenerIterator

private

Definition at line 372 of file configuration.h.

ListenerMap

typedef std::map<std::string, Listeners> Configuration::ListenerMap

private

Definition at line 373 of file configuration.h.

ListenerMapIterator

typedef ListenerMap::iterator Configuration::ListenerMapIterator

private

Definition at line 374 of file configuration.h.

Listeners

typedef std::list<ConfigListener*> Configuration::Listeners

private

Definition at line 371 of file configuration.h.

Constructor & Destructor Documentation

Configuration()

Configuration::Configuration

(

)

Definition at line 362 of file configuration.cpp.

                             :
    ConfigurationObject(),
    mListenerMap(),
    mConfigPath(),
    mDefaultsData(),
    mDirectory(),
    mFilename(),
    mUseResManager(UseVirtFs_false),
    mUpdated(false)
{
#ifdef DEBUG_CONFIG
    mLogKeys = false;
    mIsMain = false;
#endif  // DEBUG_CONFIG
}

~Configuration()

Configuration::~Configuration

(

)

Definition at line 389 of file configuration.cpp.

{
    cleanDefaults();
}

References cleanDefaults().

Member Function Documentation

addListener()

void Configuration::addListener	(	const std::string &	key,
		ConfigListener *const	listener
	)

Adds a listener to the listen list of the specified config option.

Definition at line 906 of file configuration.cpp.

{
    mListenerMap[key].push_front(listener);
}

References anonymous_namespace{itemlinkhandler.cpp}::listener, and mListenerMap.

Referenced by ActorManager::ActorManager(), AvatarListBox::AvatarListBox(), ChatWindow::ChatWindow(), EmulateGuildTab::EmulateGuildTab(), GuildTab::GuildTab(), EventsManager::init(), TouchManager::init(), SoundManager::init(), Client::initConfigListeners(), LocalPlayer::LocalPlayer(), Map::Map(), MapLayer::MapLayer(), Minimap::Minimap(), PartyTab::PartyTab(), NpcDialog::postInit(), WhoIsOnline::postInit(), Being::postInit(), Gui::postInit(), Theme::Theme(), Viewport::Viewport(), and WindowMenu::WindowMenu().

cleanDefaults()

void Configuration::cleanDefaults

(

)

Clean up the default values member.

Definition at line 378 of file configuration.cpp.

{
    for (DefaultsData::const_iterator iter = mDefaultsData.begin();
         iter != mDefaultsData.end();
         ++iter)
    {
        delete iter->second;
    }
    mDefaultsData.clear();
}

References mDefaultsData.

Referenced by init(), setBrandingDefaults(), setConfigDefaults(), setFeaturesDefaults(), setPathsDefaults(), unload(), and ~Configuration().

getBoolValue()

bool Configuration::getBoolValue

(

const std::string &

key

)

const

Definition at line 597 of file configuration.cpp.

{
    GETLOG();
    bool defaultValue = false;
    const Options::const_iterator iter = mOptions.find(key);
    if (iter == mOptions.end())
    {
        const DefaultsData::const_iterator itdef
            = mDefaultsData.find(key);
 
        if (itdef != mDefaultsData.end() &&
            (itdef->second != nullptr))
        {
            const VariableData *const data = itdef->second;
            const VariableData::DataType type = static_cast<
                VariableData::DataType>(data->getType());
            if (type == VariableData::DATA_BOOL)
            {
                defaultValue = (static_cast<const BoolData*>(
                    data))->getData();
            }
            else if (type == VariableData::DATA_INT)
            {
                if ((static_cast<const IntData*>(data))->getData() != 0)
                    defaultValue = true;
                else
                    defaultValue = false;
            }
            else if (type == VariableData::DATA_STRING)
            {
                if ((static_cast<const StringData*>(
                    data))->getData() != "0")
                {
                    defaultValue = true;
                }
                else
                {
                    defaultValue = false;
                }
            }
            if (type == VariableData::DATA_FLOAT)
            {
                if (CAST_S32((static_cast<const FloatData*>(
                    data))->getData()) != 0)
                {
                    defaultValue = true;
                }
                else
                {
                    defaultValue = false;
                }
            }
        }
        else
        {
            reportAlways(
                "%s: No boolean value in registry for key %s",
                mConfigPath.c_str(),
                key.c_str())
        }
    }
    else
    {
        defaultValue = getBoolFromString(iter->second);
    }
 
    return defaultValue;
}

References CAST_S32, data, VariableData::DATA_BOOL, VariableData::DATA_FLOAT, VariableData::DATA_INT, VariableData::DATA_STRING, getBoolFromString(), GETLOG, mConfigPath, mDefaultsData, ConfigurationObject::mOptions, and reportAlways.

Referenced by ChangeDisplay::action(), Setup_Video::action(), ChatWindow::action(), SkillDialog::action(), ChatWindow::addChannelTab(), PopupMenu::addFollow(), Game::addWatermark(), ChatWindow::addWhisper(), ChatWindow::addWhisperTab(), Game::adjustPerfomance(), ChatWindow::adjustTabSize(), Setup_Audio::apply(), Setup_Misc::apply(), Setup_Video::apply(), applyEffectByOption(), applyEffectByOption1(), WindowManager::applyGamma(), WindowManager::applyGrabMode(), DialogsManager::attributeChanged(), ChatWindow::attributeChanged(), BattleTab::BattleTab(), Ea::ChatHandler::ChatHandler(), ChatWindow::chatInput(), ChatTab::chatLog(), ChatWindow::ChatWindow(), Ea::LoginHandler::chooseServer(), Ea::ChatHandler::clear(), TradeWindow::completeTrade(), createGuiWindows(), GraphicsManager::createRenderers(), Game::createScreenshot(), Ea::PartyRecv::createTab(), EAthena::ClanRecv::createTab(), GuildManager::createTab(), EmulateGuildTab::EmulateGuildTab(), ActorManager::findNearestLivingBeing(), LocalPlayer::fixAttackTarget(), ChatInput::focusLost(), Game::Game(), Client::gameInit(), MobileOpenGLScreenshotHelper::getScreenshot(), OpenGLScreenshotHelper::getScreenshot(), GuildTab::GuildTab(), WhoIsOnline::handleLink(), EventsManager::init(), GameModifiers::init(), Joystick::init(), KeyboardConfig::init(), TouchManager::init(), Settings::init(), SoundManager::init(), Client::initFeatures(), GraphicsManager::initGraphics(), Client::initGraphics(), Map::initializeParticleEffects(), GraphicsManager::initOpenGLFunctions(), Dirs::initScreenshotDir(), Client::initSoundManager(), SetupItem::load(), WhoIsOnline::loadList(), WhoIsOnline::loadWebList(), LocalPlayer::LocalPlayer(), UpdaterWindow::logic(), Map::Map(), Joystick::open(), DialogsManager::openErrorDialog(), ActorManager::optionChanged(), EventsManager::optionChanged(), ChatWindow::optionChanged(), Minimap::optionChanged(), NpcDialog::optionChanged(), WhoIsOnline::optionChanged(), GuiConfigListener::optionChanged(), Viewport::optionChanged(), Client::optionChanged(), LocalPlayer::optionChanged(), AvatarListBox::optionChanged(), EmulateGuildTab::optionChanged(), GuildTab::optionChanged(), PartyTab::optionChanged(), TouchManager::optionChanged(), Map::optionChanged(), MapLayer::optionChanged(), SoundManager::optionChanged(), PartyTab::PartyTab(), LocalPlayer::pickedUp(), SocialWindow::postInit(), WhoIsOnline::postInit(), Gui::postInit(), MobileOpenGLScreenshotHelper::prepare(), OpenGLScreenshotHelper::prepare(), Ea::BeingRecv::processBeingRemove(), EAthena::CharServerRecv::processChangeMapServer(), TmwAthena::CharServerRecv::processChangeMapServer(), EAthena::CharServerRecv::processCharMapInfo(), TmwAthena::CharServerRecv::processCharMapInfo(), EAthena::GuildRecv::processGuildPositionInfo(), Ea::ChatRecv::processMVPEffect(), EAthena::PlayerRecv::processOnlineList(), TmwAthena::PlayerRecv::processOnlineList(), ShopWindow::processRequest(), ChatInput::processVisible(), TmwAthena::ChatRecv::processWhisperContinue(), MapReader::readTileset(), Map::reduce(), TmwAthena::BuySellHandler::requestBuyList(), TmwAthena::BuySellHandler::requestSellList(), Being::reReadConfig(), Game::resetAdjustLevel(), ChatTab::saveToLogFile(), TmwAthena::BuySellHandler::sendBuyRequest(), ShopWindow::sendMessage(), TmwAthena::BuySellHandler::sendSellRequest(), ServerDialog::ServerDialog(), Desktop::setBestFittingWallpaper(), Minimap::setMap(), TradeWindow::setMoney(), Graphics::setOpenGLMode(), ParticleEngine::setupEngine(), GraphicsManager::setVideoMode(), PopupMenu::showDropPopup(), ChatWindow::showGMTab(), PopupMenu::showItemPopup(), Being::showName(), PopupMenu::showPopup(), ConfigManager::storeSafeParameters(), SoundManager::testAudio(), updateEnv(), SocialNavigationTab::updateList(), GraphicsManager::updateTextureFormat(), and ItemShortcut::useItem().

getConfigPath()

const std::string& Configuration::getConfigPath ( ) const

inline

Definition at line 336 of file configuration.h.

        { return mConfigPath; }

References mConfigPath.

Referenced by Client::gameInit().

getDefaultValues()

DefaultsData& Configuration::getDefaultValues ( )

inline

Definition at line 259 of file configuration.h.

        { return mDefaultsData; }

References mDefaultsData.

Referenced by setBrandingDefaults(), setConfigDefaults(), setConfigDefaults2(), setFeaturesDefaults(), and setPathsDefaults().

getDirectory()

std::string Configuration::getDirectory ( ) const

inline

Definition at line 355 of file configuration.h.

        { return mDirectory; }

References mDirectory.

Referenced by Dirs::updateDataPath().

getFileName()

std::string Configuration::getFileName ( ) const

inline

Definition at line 360 of file configuration.h.

        { return mFilename; }

References mFilename.

Referenced by setBrandingDefaults(), setConfigDefaults(), setConfigDefaults2(), setFeaturesDefaults(), and setPathsDefaults().

getFloatValue()

float Configuration::getFloatValue

(

const std::string &

key

)

const

Definition at line 542 of file configuration.cpp.

{
    GETLOG();
    float defaultValue = 0.0F;
    const Options::const_iterator iter = mOptions.find(key);
    if (iter == mOptions.end())
    {
        const DefaultsData::const_iterator itdef
            = mDefaultsData.find(key);
 
        if (itdef != mDefaultsData.end() &&
            (itdef->second != nullptr))
        {
            const VariableData *const data = itdef->second;
            const VariableData::DataType type = static_cast<
                VariableData::DataType>(data->getType());
            if (type == VariableData::DATA_FLOAT)
            {
                defaultValue = static_cast<float>(
                    (static_cast<const FloatData*>(data))->getData());
            }
            else if (type == VariableData::DATA_STRING)
            {
                defaultValue = static_cast<float>(atof((
                    static_cast<const StringData*>(
                    data))->getData().c_str()));
            }
            else if (type == VariableData::DATA_BOOL)
            {
                if ((static_cast<const BoolData*>(data))->getData())
                    defaultValue = 1;
                else
                    defaultValue = 0;
            }
            else if (type == VariableData::DATA_INT)
            {
                defaultValue = static_cast<float>((
                    static_cast<const IntData*>(
                    data))->getData());
            }
        }
        else
        {
            reportAlways("%s: No float value in registry for key %s",
                mConfigPath.c_str(),
                key.c_str())
        }
    }
    else
    {
        defaultValue = static_cast<float>(atof(iter->second.c_str()));
    }
    return defaultValue;
}

References data, VariableData::DATA_BOOL, VariableData::DATA_FLOAT, VariableData::DATA_INT, VariableData::DATA_STRING, GETLOG, mConfigPath, mDefaultsData, ConfigurationObject::mOptions, and reportAlways.

Referenced by WindowManager::applyGamma(), GraphicsManager::initGraphics(), Client::optionChanged(), Map::optionChanged(), and Text::Text().

getIntValue()

int Configuration::getIntValue

(

const std::string &

key

)

const

returns a value corresponding to the given key. The default value returned in based on fallbacks registry.

See also

defaults.h

Definition at line 404 of file configuration.cpp.

{
    GETLOG();
    int defaultValue = 0;
    const Options::const_iterator iter = mOptions.find(key);
    if (iter == mOptions.end())
    {
        const DefaultsData::const_iterator itdef
            = mDefaultsData.find(key);
 
        if (itdef != mDefaultsData.end() && (itdef->second != nullptr))
        {
            const VariableData *const data = itdef->second;
            const VariableData::DataType type = static_cast<
                VariableData::DataType>(data->getType());
            if (type == VariableData::DATA_INT)
            {
                defaultValue = (static_cast<const IntData*>(
                    data))->getData();
            }
            else if (type == VariableData::DATA_STRING)
            {
                defaultValue = atoi((static_cast<const StringData*>(
                    data))->getData().c_str());
            }
            else if (type == VariableData::DATA_BOOL)
            {
                if ((static_cast<const BoolData*>(data))->getData())
                    defaultValue = 1;
                else
                    defaultValue = 0;
            }
            else if (type == VariableData::DATA_FLOAT)
            {
                defaultValue = CAST_S32(
                    (static_cast<const FloatData*>(data))->getData());
            }
        }
        else
        {
            reportAlways(
                "%s: No integer value in registry for key %s",
                mConfigPath.c_str(),
                key.c_str())
        }
    }
    else
    {
        defaultValue = atoi(iter->second.c_str());
    }
    return defaultValue;
}

References CAST_S32, data, VariableData::DATA_BOOL, VariableData::DATA_FLOAT, VariableData::DATA_INT, VariableData::DATA_STRING, GETLOG, mConfigPath, mDefaultsData, ConfigurationObject::mOptions, and reportAlways.

Referenced by Setup_Video::action(), DidYouKnowWindow::action(), RegisterDialog::action(), Net::Download::addProxy(), Game::adjustPerfomance(), LocalPlayer::afkRespond(), Setup_Theme::apply(), Setup_Video::apply(), WindowManager::applyKeyRepeat(), WindowManager::applyScale(), WindowManager::applyVSync(), CharacterViewNormal::CharacterViewNormal(), CharCreateDialog::CharCreateDialog(), CharSelectDialog::CharSelectDialog(), ChatTab::chatLog(), ChatTab::ChatTab(), ConfigManager::checkConfigVersion(), GraphicsManager::createRenderers(), NpcDialog::createSkinControls(), GraphicsManager::detectPixelSize(), EquipmentWindow::EquipmentWindow(), TouchManager::executeAction(), Client::gameInit(), Being::getDefaultEffectId(), Being::getHitEffect(), EventsManager::handleActive(), Being::handleSkill(), Being::handleSkillCasting(), GameModifiers::init(), BuyDialog::init(), Joystick::init(), KeyboardConfig::init(), TouchManager::init(), BeingInfo::init(), SoundManager::init(), GraphicsManager::initGraphics(), Client::initSoundManager(), InventoryWindow::InventoryWindow(), SetupItem::load(), MiniStatusWindow::loadBars(), DidYouKnowWindow::loadData(), ItemDB::loadXmlFile(), LocalPlayer::LocalPlayer(), NpcDialog::NpcDialog(), Joystick::open(), WindowMenu::optionChanged(), Viewport::optionChanged(), Client::optionChanged(), Being::optionChanged(), LocalPlayer::optionChanged(), TouchManager::optionChanged(), Map::optionChanged(), SoundManager::optionChanged(), SkillDialog::playCastingDstTileEffect(), SkillDialog::playRemoveEffect(), SkillDialog::playUpdateEffect(), SetupWindow::postInit(), Being::postInit(), Gui::postInit(), BeingCommon::readObjectNodes(), RegisterDialog::RegisterDialog(), Being::reReadConfig(), Game::resetAdjustLevel(), ServerDialog::ServerDialog(), CharCreateDialog::setAttributes(), CharCreateDialog::setDefaultGender(), TmwAthena::setGm(), Being::setSpiritBalls(), Setup_Input::Setup_Input(), Setup_Joystick::Setup_Joystick(), Setup_Video::Setup_Video(), ParticleEngine::setupEngine(), GraphicsManager::setVideoMode(), ShopWindow::ShopWindow(), ChatWindow::showGMTab(), Game::slowLogic(), ConfigManager::storeSafeParameters(), SoundManager::testAudio(), ActorManager::updateBadges(), GraphicsManager::updateDebugLog(), updateEnv(), Gui::updateFonts(), Game::updateFrameRate(), GraphicsManager::updateTextureCompressionFormat(), and WindowMenu::WindowMenu().

getStringValue()

std::string Configuration::getStringValue

(

const std::string &

key

)

const

Definition at line 488 of file configuration.cpp.

{
    GETLOG();
    std::string defaultValue;
    const Options::const_iterator iter = mOptions.find(key);
    if (iter == mOptions.end())
    {
        const DefaultsData::const_iterator
            itdef = mDefaultsData.find(key);
 
        if (itdef != mDefaultsData.end() &&
            (itdef->second != nullptr))
        {
            const VariableData *const data = itdef->second;
            const VariableData::DataType type = static_cast<
                VariableData::DataType>(data->getType());
            if (type == VariableData::DATA_STRING)
            {
                defaultValue = (static_cast<const StringData*>(
                    data))->getData();
            }
            else if (type == VariableData::DATA_BOOL)
            {
                if ((static_cast<const BoolData*>(data))->getData())
                    defaultValue = "1";
                else
                    defaultValue = "0";
            }
            else if (type == VariableData::DATA_INT)
            {
                defaultValue = toString((static_cast<const IntData*>(
                    data))->getData());
            }
            else if (type == VariableData::DATA_FLOAT)
            {
                defaultValue = toString((static_cast<const FloatData*>(
                    data))->getData());
            }
        }
        else
        {
            reportAlways("%s: No string value in registry for key %s",
                mConfigPath.c_str(),
                key.c_str())
        }
    }
    else
    {
        defaultValue = iter->second;
    }
    return defaultValue;
}

References data, VariableData::DATA_BOOL, VariableData::DATA_FLOAT, VariableData::DATA_INT, VariableData::DATA_STRING, GETLOG, mConfigPath, mDefaultsData, ConfigurationObject::mOptions, reportAlways, and Catch::toString().

Referenced by SetupItemSound::action(), Being::addEffect(), Net::Download::addProxy(), SkillDialog::addSkill(), Setup_Theme::apply(), Setup_Theme::cancel(), PlayerRelationsManager::checkName(), CrazyMoves::crazyMoveA(), UpdaterWindow::download(), ServerDialog::downloadServerList(), EffectManager::EffectManager(), EquipmentWindow::fillBoxes(), Theme::fillFontsList(), Theme::fillSkinsList(), Theme::fillSoundsList(), SkillDialog::getDefaultSkillIcon(), ShadersManager::getGles2Program(), StatusEffect::getIcon(), Item::getImage(), getLang(), getLangShort(), getLangSimple(), ShadersManager::getSimpleProgram(), SpriteDef::includeSprite(), initDefaultThemePath(), initDefaultWallpaperPaths(), Client::initFeatures(), GraphicsManager::initGraphics(), Dirs::initScreenshotDir(), WindowManager::initTitle(), Dirs::initUpdatesDir(), SetupItem::load(), AvatarDB::load(), CharDB::load(), ClanDb::load(), ColorDB::load(), CommandsDB::load(), DeadDB::load(), ElementalDb::load(), EmoteDB::load(), GroupDb::load(), HomunculusDB::load(), HorseDB::load(), ItemDB::load(), ItemFieldDb::load(), ItemOptionDb::load(), LanguageDb::load(), MapDB::load(), MercenaryDB::load(), ModDB::load(), MonsterDB::load(), NetworkDb::load(), NPCDB::load(), NpcDialogDB::load(), PETDB::load(), QuestDb::load(), SkillUnitDb::load(), SoundDB::load(), StatDb::load(), StatusEffectDB::load(), TextDb::load(), UnitsDb::load(), SpriteDef::load(), PlayerInfo::loadData(), Client::loadData(), loadDB(), MapReader::loadEmptyAtlas(), DidYouKnowWindow::loadFile(), HelpWindow::loadFile(), Net::loadIgnorePackets(), TextCommand::loadImage(), loadMusic(), PaletteDB::loadPalette(), UpdaterWindow::loadPatch(), ServerDialog::loadServers(), SkillDialog::loadSkillData(), SkillDialog::loadSkills(), EmoteDB::loadSpecialXmlFile(), HelpWindow::loadTags(), ClanDb::loadXmlFile(), DeadDB::loadXmlFile(), ElementalDb::loadXmlFile(), EmoteDB::loadXmlFile(), GroupDb::loadXmlFile(), HomunculusDB::loadXmlFile(), HorseDB::loadXmlFile(), MercenaryDB::loadXmlFile(), MonsterDB::loadXmlFile(), NPCDB::loadXmlFile(), PETDB::loadXmlFile(), SkillUnitDb::loadXmlFile(), StatusEffectDB::loadXmlFile(), UnitsDb::loadXmlFile(), ServerDialog::needUpdateServers(), ChatWindow::parseGlobalsFilter(), ChatWindow::parseHighlights(), NpcDialog::parseListItems(), SoundManager::playGuiSound(), SoundManager::playSfx(), Gui::postInit(), EquipmentWindow::prepareSlotNames(), Theme::prepareThemePath(), MapDB::readAtlas(), Theme::resolveThemePath(), Being::setGender(), Being::setHairTempSprite(), SkillData::setIcon(), Item::setId(), ItemPopup::setItem(), setLangEnv(), Being::setLanguageId(), Minimap::setMap(), ChatLogger::setServerName(), Being::setSpriteCards(), Being::setSpriteColor(), Being::setSpriteColorId(), Being::setSpriteId(), Being::setTempSprite(), Setup_Perfomance::Setup_Perfomance(), Setup_Theme::Setup_Theme(), ActorSprite::setupSpriteDisplay(), CutInWindow::show(), Being::showAwayBadge(), Being::showClanBadge(), Being::showGmBadge(), Being::showGuildBadge(), Being::showInactiveBadge(), Being::showNameBadge(), Being::showPartyBadge(), Being::showShopBadge(), Being::showTeamBadge(), ConfigManager::storeSafeParameters(), UserAgent::update(), Dirs::updateDataPath(), Gui::updateFonts(), MapReader::updateMusic(), and WindowManager::updateTitle().

incValue()

void Configuration::incValue

(

const std::string &

key

)

Definition at line 255 of file configuration.cpp.

{
    GETLOG();
    const Options::const_iterator iter = mOptions.find(key);
    setValue(key, (iter != mOptions.end())
        ? atoi(iter->second.c_str()) + 1 : 1);
}

References GETLOG, ConfigurationObject::mOptions, and setValue().

Referenced by Game::Game(), and Client::gameInit().

init()

void Configuration::init	(	const std::string &	filename,
		const UseVirtFs	useResManager,
		const SkipError	skipError
	)

Reads config file and parse all options into memory.

Parameters

filename	path to config file
useResManager	Make use of the resource manager.

Definition at line 739 of file configuration.cpp.

{
    cleanDefaults();
    clear();
    mFilename = filename;
    mUseResManager = useResManager;
 
    if (useResManager == UseVirtFs_true)
    {
        mConfigPath = "virtfs://" + filename;
        mDirectory.clear();
        if (VirtFs::exists(filename) == false)
        {
            logger->log("Warning: No configuration file (%s)",
                filename.c_str());
            return;
        }
    }
    else
    {
        mConfigPath = filename;
        logger->log1("init 1");
        mDirectory = getRealPath(getFileDir(filename));
        if (Files::existsLocal(filename) == false)
        {
            logger->log("Warning: No configuration file (%s)",
                filename.c_str());
            return;
        }
    }
 
    XML::Document doc(filename,
        useResManager,
        skipError);
    logger->log1("init 2");
    if (doc.rootNode() == nullptr)
    {
        logger->log("Couldn't open configuration file: %s", filename.c_str());
        return;
    }
 
    XmlNodeConstPtrConst rootNode = doc.rootNode();
 
    if ((rootNode == nullptr) || !xmlNameEqual(rootNode, "configuration"))
    {
        logger->log("Warning: No configuration file (%s)", filename.c_str());
        return;
    }
 
    initFromXML(rootNode);
}

References cleanDefaults(), ConfigurationObject::clear(), VirtFs::exists(), Files::existsLocal(), getFileDir(), getRealPath(), ConfigurationObject::initFromXML(), Logger::log(), Logger::log1(), logger, mConfigPath, mDirectory, mFilename, mUseResManager, XML::Document::rootNode(), and UseVirtFs_true.

Referenced by Client::gameExec(), Client::gameInit(), TestMain::initConfig(), ConfigManager::initConfiguration(), Client::initFeatures(), Dirs::initRootDir(), ConfigManager::initServerConfig(), Client::loadData(), and TestMain::writeConfig().

reInit()

void Configuration::reInit

(

)

Definition at line 793 of file configuration.cpp.

{
    XML::Document doc(mFilename, mUseResManager, SkipError_false);
    if (doc.rootNode() == nullptr)
    {
        logger->log("Couldn't open configuration file: %s", mFilename.c_str());
        return;
    }
 
    XmlNodeConstPtrConst rootNode = doc.rootNode();
 
    if ((rootNode == nullptr) || !xmlNameEqual(rootNode, "configuration"))
    {
        logger->log("Warning: No configuration file (%s)", mFilename.c_str());
        return;
    }
 
    initFromXML(rootNode);
}

References ConfigurationObject::initFromXML(), Logger::log(), logger, mFilename, mUseResManager, XML::Document::rootNode(), and SkipError_false.

removeListener()

void Configuration::removeListener	(	const std::string &	key,
		ConfigListener *const	listener
	)

Removes a listener from the listen list of the specified config option.

Definition at line 912 of file configuration.cpp.

{
    mListenerMap[key].remove(listener);
}

References anonymous_namespace{itemlinkhandler.cpp}::listener, and mListenerMap.

Referenced by Being::~Being(), LocalPlayer::~LocalPlayer(), MapLayer::~MapLayer(), Theme::~Theme(), and WindowMenu::~WindowMenu().

removeListeners()

void Configuration::removeListeners

(

ConfigListener *const

listener

)

Definition at line 939 of file configuration.cpp.

{
    FOR_EACH (ListenerMapIterator, it, mListenerMap)
        (it->second).remove(listener);
}

References FOR_EACH, anonymous_namespace{itemlinkhandler.cpp}::listener, mListenerMap, and VirtFs::remove().

Referenced by EventsManager::shutdown(), TouchManager::shutdown(), SoundManager::shutdown(), ActorManager::~ActorManager(), AvatarListBox::~AvatarListBox(), ChatWindow::~ChatWindow(), EmulateGuildTab::~EmulateGuildTab(), Gui::~Gui(), GuildTab::~GuildTab(), LocalPlayer::~LocalPlayer(), Map::~Map(), Minimap::~Minimap(), NpcDialog::~NpcDialog(), PartyTab::~PartyTab(), Viewport::~Viewport(), and WhoIsOnline::~WhoIsOnline().

removeOldKeys()

void Configuration::removeOldKeys

(

)

Definition at line 945 of file configuration.cpp.

{
    if (mOptions.find(unusedKeys[0]) != mOptions.end() ||
        mOptions.find(unusedKeys[1]) != mOptions.end() ||
        mOptions.find(unusedKeys[2]) != mOptions.end())
    {
        int f = 0;
        while (!unusedKeys[f].empty())
        {
            deleteKey(unusedKeys[f]);
            logger->log("remove unused key: " + unusedKeys[f]);
            f ++;
        }
        for (f = 0; f < 80; f ++)
        {
            const std::string str = toString(f);
            deleteKey("Outfit" + str);
            deleteKey("OutfitUnequip" + str);
            deleteKey("commandShortcutCmd" + str);
            deleteKey("commandShortcutFlags" + str);
            deleteKey("commandShortcutSymbol" + str);
            deleteKey("drop" + str);
            deleteKey("shortcut" + str);
        }
    }
}

References ConfigurationObject::deleteKey(), empty, Logger::log(), logger, ConfigurationObject::mOptions, Catch::toString(), and unusedKeys.

Referenced by Client::gameClear().

resetBoolValue()

bool Configuration::resetBoolValue

(

const std::string &

key

)

Definition at line 666 of file configuration.cpp.

{
    GETLOG();
    bool defaultValue = false;
    const DefaultsData::const_iterator itdef = mDefaultsData.find(key);
 
    if (itdef == mDefaultsData.end())
    {
        reportAlways("%s: No boolean value in registry for key %s",
            mConfigPath.c_str(),
            key.c_str())
    }
    else
    {
        const VariableData *const data = itdef->second;
        if (data != nullptr &&
            data->getType() == VariableData::DATA_BOOL)
        {
            defaultValue = (static_cast<const BoolData*>(data))->getData();
        }
        else
        {
            reportAlways("%s: No boolean value in registry for key %s",
                mConfigPath.c_str(),
                key.c_str())
        }
    }
 
    setValue(key, defaultValue);
    return defaultValue;
}

References data, VariableData::DATA_BOOL, GETLOG, mConfigPath, mDefaultsData, reportAlways, and setValue().

Referenced by GameModifiers::resetModifiers().

resetIntValue()

int Configuration::resetIntValue

(

const std::string &

key

)

Definition at line 457 of file configuration.cpp.

{
    GETLOG();
    int defaultValue = 0;
    const DefaultsData::const_iterator itdef = mDefaultsData.find(key);
    if (itdef == mDefaultsData.end())
    {
        reportAlways("%s: No integer value in registry for key %s",
            mConfigPath.c_str(),
            key.c_str())
    }
    else
    {
        const VariableData *const data = itdef->second;
        if (data != nullptr &&
            data->getType() == VariableData::DATA_INT)
        {
            defaultValue = (static_cast<const IntData*>(
                data))->getData();
        }
        else
        {
            reportAlways("%s: No integer value in registry for key %s",
                mConfigPath.c_str(),
                key.c_str())
        }
    }
    setValue(key, defaultValue);
    return defaultValue;
}

References data, VariableData::DATA_INT, GETLOG, mConfigPath, mDefaultsData, reportAlways, and setValue().

Referenced by GameModifiers::resetModifiers().

setSilent() [1/3]

void Configuration::setSilent ( const std::string &  key, const bool  value  )

inline

Definition at line 328 of file configuration.h.

        { setSilent(key, value ? "1" : "0"); }

References setSilent().

setSilent() [2/3]

void Configuration::setSilent ( const std::string &  key, const char *const  value  )

inline

Definition at line 300 of file configuration.h.

        { if (value != nullptr) setSilent(key, std::string(value)); }

References setSilent().

setSilent() [3/3]

void Configuration::setSilent	(	const std::string &	key,
		const std::string &	value
	)

Definition at line 263 of file configuration.cpp.

{
    ConfigurationObject::setValue(key, value);
}

References ConfigurationObject::setValue().

Referenced by Game::adjustPerfomance(), and setSilent().

setValue() [1/7]

void Configuration::setValue ( const std::string &  key, const bool  value  )

inline

Definition at line 324 of file configuration.h.

        { setValue(key, value ? "1" : "0"); }

References setValue().

setValue() [2/7]

void Configuration::setValue ( const std::string &  key, const char *const  value  )

inline

Definition at line 296 of file configuration.h.

        { if (value != nullptr) setValue(key, std::string(value)); }

References setValue().

setValue() [3/7]

void Configuration::setValue ( const std::string &  key, const double  value  )

inline

Definition at line 308 of file configuration.h.

        { setValue(key, toString(value)); }

References setValue(), and Catch::toString().

setValue() [4/7]

void Configuration::setValue ( const std::string &  key, const float  value  )

inline

Definition at line 304 of file configuration.h.

        { setValue(key, toString(value)); }

References setValue(), and Catch::toString().

setValue() [5/7]

void Configuration::setValue ( const std::string &  key, const int  value  )

inline

Definition at line 312 of file configuration.h.

        { setValue(key, toString(value)); }

References setValue(), and Catch::toString().

setValue() [6/7]

void Configuration::setValue ( const std::string &  key, const std::string &  value  )

virtual

Sets an option using a string value.

Parameters

key	Option identifier.
value	Value.

Reimplemented from ConfigurationObject.

Definition at line 239 of file configuration.cpp.

{
    ConfigurationObject::setValue(key, value);
    mUpdated = true;
 
    // Notify listeners
    const ListenerMapIterator list = mListenerMap.find(key);
    if (list != mListenerMap.end())
    {
        Listeners listeners = list->second;
        FOR_EACH (ListenerIterator, i, listeners)
            (*i)->optionChanged(key);
    }
}

References FOR_EACH, mListenerMap, mUpdated, and ConfigurationObject::setValue().

Referenced by Setup_Video::action(), BuyDialog::action(), ChatWindow::action(), DidYouKnowWindow::action(), QuitDialog::action(), Game::adjustPerfomance(), Setup_Joystick::apply(), Setup_Theme::apply(), Setup_Video::apply(), Setup_Video::cancel(), GameModifiers::changeGameModifiers(), GameModifiers::changeMode(), ConfigManager::checkConfigVersion(), ServerDialog::connectToSelectedServer(), GraphicsManager::detectGraphics(), GraphicsManager::detectVideoSettings(), ServerDialog::downloadServerList(), Joystick::finishCalibration(), incValue(), GuildManager::init(), TestMain::initConfig(), ConfigManager::initConfiguration(), GraphicsManager::initGraphics(), GraphicsManager::initOpenGLFunctions(), Dirs::initScreenshotDir(), TestMain::invokeMobileOpenBatchTest(), TestMain::invokeModernOpenBatchTest(), TestMain::invokeModernOpenGLRenderTest(), TestMain::invokeNormalOpenBatchTest(), TestMain::invokeNormalOpenGLRenderTest(), TestMain::invokeSafeOpenBatchTest(), TestMain::invokeSafeOpenGLRenderTest(), TestMain::invokeSoftwareRenderTest(), TestMain::invokeTest(), TestMain::invokeTest4(), DidYouKnowWindow::loadData(), Ea::LoginHandler::loginOrRegister(), Joystick::open(), LoginDialog::prepareUpdate(), EAthena::LoginRecv::processLoginData(), TmwAthena::LoginRecv::processLoginData(), Game::resetAdjustLevel(), resetBoolValue(), resetIntValue(), WindowManager::resizeVideo(), SetupItem::save(), EmoteShortcut::save(), ItemShortcut::save(), ShortcutBase::save(), OutfitWindow::save(), SpellManager::save(), MiniStatusWindow::saveBars(), WindowMenu::saveButtons(), ServerDialog::saveCustomServers(), LocalPlayer::saveHomes(), Setup_Mods::saveMods(), PlayerInfo::saveProtectedItems(), ChatWindow::saveTab(), Window::saveWindowState(), LocalPlayer::setAfkMessage(), setDefaultOption(), GameModifiers::setQuickDropCounter(), ShopWindow::setShopName(), setValue(), setValueInt(), GraphicsManager::setVideoMode(), PlayerRelationsManager::store(), InputManager::store(), ActorManager::storeAttackList(), ConfigManager::storeSafeParameters(), InventoryWindow::storeSortOrder(), TestMain::writeConfig(), ChatWindow::~ChatWindow(), Minimap::~Minimap(), and UserPalette::~UserPalette().

setValue() [7/7]

void Configuration::setValue ( const std::string &  key, const unsigned  value  )

inline

Definition at line 320 of file configuration.h.

        { setValue(key, toString(value)); }

References setValue(), and Catch::toString().

setValueInt()

void Configuration::setValueInt ( const std::string &  key, const int  value  )

inline

Definition at line 316 of file configuration.h.

        { setValue(key, toString(value)); }

References setValue(), and Catch::toString().

Referenced by GraphicsManager::setVideoMode().

unload()

void Configuration::unload

(

)

Definition at line 394 of file configuration.cpp.

{
    cleanDefaults();
    mConfigPath.clear();
    mDirectory.clear();
    mFilename.clear();
    mUseResManager = UseVirtFs_false;
    ConfigurationObject::clear();
}

References cleanDefaults(), ConfigurationObject::clear(), mConfigPath, mDirectory, mFilename, mUseResManager, and UseVirtFs_false.

write()

void Configuration::write

(

)

Writes the current settings back to the config file.

Definition at line 859 of file configuration.cpp.

{
    BLOCK_START("Configuration::write")
    if (mConfigPath.empty())
    {
        BLOCK_END("Configuration::write")
        return;
    }
 
    mUpdated = false;
    // Do not attempt to write to file that cannot be opened for writing
    FILE *const testFile = fopen(mConfigPath.c_str(), "w");
    if (testFile == nullptr)
    {
        reportAlways("Configuration::write() couldn't open %s for writing",
            mConfigPath.c_str())
        BLOCK_END("Configuration::write")
        return;
    }
    fclose(testFile);
 
    XmlTextWriterPtr writer = XmlNewTextWriterFilename(
        mConfigPath.c_str(), 0);
 
    if (writer == nullptr)
    {
        logger->log1("Configuration::write() error while creating writer");
        BLOCK_END("Configuration::write")
        return;
    }
 
    logger->log1("Configuration::write() writing configuration...");
 
    XmlTextWriterSetIndent(writer, 1);
    XmlTextWriterStartDocument(writer, nullptr, nullptr, nullptr);
//    xmlTextWriterStartDocument(writer, nullptr, "utf8", nullptr);
    XmlTextWriterStartRootElement(writer, "configuration");
 
    writeToXML(writer);
 
    XmlTextWriterEndDocument(writer);
    XmlSaveTextWriterFilename(writer,
        mConfigPath.c_str());
    XmlFreeTextWriter(writer);
    BLOCK_END("Configuration::write")
}

References BLOCK_END, BLOCK_START, Logger::log1(), logger, mConfigPath, mUpdated, reportAlways, and ConfigurationObject::writeToXML().

Referenced by QuitDialog::action(), SetupWindow::action(), GraphicsManager::detectGraphics(), Client::gameClear(), TestMain::invokeMobileOpenBatchTest(), TestMain::invokeModernOpenBatchTest(), TestMain::invokeModernOpenGLRenderTest(), TestMain::invokeNormalOpenBatchTest(), TestMain::invokeNormalOpenGLRenderTest(), TestMain::invokeSafeOpenBatchTest(), TestMain::invokeSafeOpenGLRenderTest(), TestMain::invokeSoftwareRenderTest(), TestMain::invokeTest(), PlayerInfo::saveProtectedItems(), Client::stateConnectServer1(), PlayerRelationsManager::store(), ConfigManager::storeSafeParameters(), TestMain::writeConfig(), writeUpdated(), and Game::~Game().

writeUpdated()

void Configuration::writeUpdated

(

)

Definition at line 853 of file configuration.cpp.

{
    if (mUpdated)
        write();
}

References mUpdated, and write().

Referenced by Game::slowLogic().

Field Documentation

mConfigPath

std::string Configuration::mConfigPath

private

Definition at line 378 of file configuration.h.

Referenced by getBoolValue(), getConfigPath(), getFloatValue(), getIntValue(), getStringValue(), init(), resetBoolValue(), resetIntValue(), unload(), and write().

mDefaultsData

DefaultsData Configuration::mDefaultsData

private

Defaults of value for a given key.

Definition at line 380 of file configuration.h.

Referenced by cleanDefaults(), getBoolValue(), getDefaultValues(), getFloatValue(), getIntValue(), getStringValue(), resetBoolValue(), and resetIntValue().

mDirectory

std::string Configuration::mDirectory

private

Definition at line 381 of file configuration.h.

Referenced by getDirectory(), init(), and unload().

mFilename

std::string Configuration::mFilename

private

Definition at line 382 of file configuration.h.

Referenced by getFileName(), init(), reInit(), and unload().

mListenerMap

ListenerMap Configuration::mListenerMap

private

Definition at line 375 of file configuration.h.

Referenced by addListener(), removeListener(), removeListeners(), and setValue().

mUpdated

bool Configuration::mUpdated

private

Definition at line 384 of file configuration.h.

Referenced by setValue(), write(), and writeUpdated().

mUseResManager

UseVirtFs Configuration::mUseResManager

private

Definition at line 383 of file configuration.h.

Referenced by init(), reInit(), and unload().

---

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

• src/configuration.h (986a3bf)
• src/configuration.cpp (986a3bf)