ConfigurationObject Class Reference

#include <configuration.h>

Inheritance diagram for ConfigurationObject:

Public Member Functions
virtual	~ConfigurationObject ()
virtual void	setValue (const std::string &key, const std::string &value)
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)

Protected Types
typedef std::map< std::string, std::string >	Options
typedef std::list< ConfigurationObject * >	ConfigurationList

Protected Member Functions
	ConfigurationObject ()
virtual void	initFromXML (const xmlNode *const parentNode)
virtual void	writeToXML (const xmlTextWriterPtr writer)
void	deleteList (const std::string &name)

Protected Attributes
Options	mOptions
std::map< std::string, ConfigurationList >	mContainerOptions

Friends
class	Configuration

Detailed Description

Configuration object, mapping values to names and possibly containing lists of further configuration objects

Definition at line 88 of file configuration.h.

Member Typedef Documentation

ConfigurationList

typedef std::list<ConfigurationObject *> ConfigurationObject::ConfigurationList

protected

Definition at line 220 of file configuration.h.

Options

typedef std::map<std::string, std::string> ConfigurationObject::Options

protected

Definition at line 217 of file configuration.h.

Constructor & Destructor Documentation

~ConfigurationObject()

ConfigurationObject::~ConfigurationObject ( )

virtual

Definition at line 357 of file configuration.cpp.

{
    clear();
}

References clear().

ConfigurationObject()

ConfigurationObject::ConfigurationObject ( )

protected

Definition at line 344 of file configuration.cpp.

                                         :
    mOptions(),
#ifdef DEBUG_CONFIG
    mContainerOptions(),
    mLogKeys(false),
    mIsMain(false)
#else  // DEBUG_CONFIG
 
    mContainerOptions()
#endif  // DEBUG_CONFIG
{
}

Referenced by initFromXML(), and setList().

Member Function Documentation

clear()

void ConfigurationObject::clear

(

)

Re-sets all data in the configuration

Definition at line 332 of file configuration.cpp.

{
    for (std::map<std::string, ConfigurationList>::const_iterator
         it = mContainerOptions.begin();
         it != mContainerOptions.end(); ++it)
    {
        deleteList(it->first);
    }
    mOptions.clear();
    mContainerOptions.clear();
}

References deleteList(), mContainerOptions, and mOptions.

Referenced by Client::gameClear(), Configuration::init(), TestMain::initConfig(), initFromXML(), setList(), Configuration::unload(), and ~ConfigurationObject().

deleteKey()

void ConfigurationObject::deleteKey

(

const std::string &

key

)

Definition at line 234 of file configuration.cpp.

{
    mOptions.erase(key);
}

References mOptions.

Referenced by ConfigManager::checkConfigVersion(), Configuration::removeOldKeys(), ItemShortcut::save(), ShortcutBase::save(), OutfitWindow::save(), SpellManager::save(), MiniStatusWindow::saveBars(), WindowMenu::saveButtons(), ChatWindow::saveState(), and GraphicsManager::setVideoMode().

deleteList()

void ConfigurationObject::deleteList ( const std::string &  name )

protected

Definition at line 320 of file configuration.cpp.

{
    for (ConfigurationList::const_iterator
         it = mContainerOptions[name].begin();
         it != mContainerOptions[name].end(); ++it)
    {
        delete *it;
    }
 
    mContainerOptions[name].clear();
}

References mContainerOptions.

Referenced by clear(), and setList().

getList()

template<class T , class CONT >

CONT ConfigurationObject::getList ( const std::string &  name, CONT  empty, ConfigurationListManager< T, CONT > *  manager  )

inline

Serialises a container into a list of configuration options

Parameters

name	Name of the list the elements should be read from under
empty	Initial (empty) container to write to
manager	An object capable of deserialising items into CONT

Definition at line 182 of file configuration.h.

        {
            ConfigurationList *const list = &(mContainerOptions[name]);
            CONT container = empty;
 
            if (!manager)
                return container;
 
            for (ConfigurationList::const_iterator it = list->begin();
                 it != list->end();
                 ++ it)
            {
                container = manager->readConfigItem(*it, container);
            }
 
            return container;
        }

References empty, mContainerOptions, and ConfigurationListManager< T, CONT >::readConfigItem().

Referenced by PlayerRelationsManager::load().

getValue() [1/4]

double ConfigurationObject::getValue	(	const std::string &	key,
		const double	deflt
	)		const

Definition at line 312 of file configuration.cpp.

{
    GETLOG();
    const Options::const_iterator iter = mOptions.find(key);
    return (iter != mOptions.end()) ? atof(iter->second.c_str()) : deflt;
}

References GETLOG, and mOptions.

getValue() [2/4]

int ConfigurationObject::getValue	(	const std::string &	key,
		const int	deflt
	)		const

Definition at line 277 of file configuration.cpp.

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

References GETLOG, and mOptions.

getValue() [3/4]

std::string ConfigurationObject::getValue	(	const std::string &	key,
		const std::string &	deflt
	)		const

Gets a value as string.

Parameters

key	Option identifier.
deflt	Default option if not there or error.

Definition at line 269 of file configuration.cpp.

{
    GETLOG();
    const Options::const_iterator iter = mOptions.find(key);
    return ((iter != mOptions.end()) ? iter->second : deflt);
}

References GETLOG, and mOptions.

Referenced by Setup_Video::action(), UserPalette::addColor(), LocalPlayer::afkRespond(), Setup_Audio::apply(), Setup_Players::apply(), Setup_Theme::apply(), GameModifiers::changeAwayMode(), Game::changeMap(), Ea::ChatHandler::ChatHandler(), Desktop::Desktop(), GraphicsManager::detectVideoSettings(), GuildManager::init(), Dirs::initConfigDir(), ConfigManager::initConfiguration(), initDefaultWallpaperPaths(), Dirs::initLocalDataDir(), Dirs::initRootDir(), Dirs::initScreenshotDir(), Client::initSoundManager(), PlayerRelationsManager::load(), ItemShortcut::load(), ShortcutBase::load(), SetupItem::load(), OutfitWindow::load(), SpellManager::load(), MiniStatusWindow::loadBars(), WindowMenu::loadButtons(), ServerDialog::loadCustomServers(), UpdaterWindow::loadDirMods(), LocalPlayer::loadHomes(), Setup_Mods::loadMods(), UpdaterWindow::loadMods(), ChatWindow::loadState(), LoginDialog::LoginDialog(), SoundManager::playGuiSfx(), Gui::postInit(), InputManager::retrieve(), Game::saveScreenshot(), setDefaultOption(), WindowManager::setIcon(), Item::setId(), Client::stateConnectServer1(), UpdaterWindow::unloadMods(), and Gui::updateFonts().

getValue() [4/4]

unsigned ConfigurationObject::getValue	(	const std::string &	key,
		const unsigned	deflt
	)		const

Definition at line 303 of file configuration.cpp.

{
    GETLOG();
    const Options::const_iterator iter = mOptions.find(key);
    return (iter != mOptions.end()) ? CAST_U32(
            atol(iter->second.c_str())) : deflt;
}

References CAST_U32, GETLOG, and mOptions.

getValueBool()

bool ConfigurationObject::getValueBool	(	const std::string &	key,
		const bool	deflt
	)		const

Definition at line 293 of file configuration.cpp.

{
    GETLOG();
    const Options::const_iterator iter = mOptions.find(key);
    if (iter != mOptions.end())
        return atoi(iter->second.c_str()) != 0 ? true : false;
    return deflt;
}

References GETLOG, and mOptions.

Referenced by PacketLimiter::checkPackets(), PacketLimiter::limitPackets(), OutfitWindow::load(), Window::loadWindowState(), Minimap::Minimap(), MiniStatusWindow::MiniStatusWindow(), Joystick::open(), and StatusWindow::StatusWindow().

getValueInt()

int ConfigurationObject::getValueInt	(	const std::string &	key,
		const int	deflt
	)		const

Definition at line 285 of file configuration.cpp.

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

References GETLOG, and mOptions.

Referenced by Setup_Video::action(), UserPalette::addColor(), GraphicsManager::detectVideoSettings(), Window::loadWindowState(), and GraphicsManager::setVideoMode().

initFromXML()

void ConfigurationObject::initFromXML ( const xmlNode *const  parentNode )

protectedvirtual

Definition at line 699 of file configuration.cpp.

{
    clear();
 
    if (parentNode == nullptr)
        return;
 
    for_each_xml_child_node(node, parentNode)
    {
        if (xmlNameEqual(node, "list"))
        {
            // list option handling
            const std::string name = XML::getProperty(node,
                "name", std::string());
 
            for_each_xml_child_node(subnode, node)
            {
                if (xmlNameEqual(subnode, name.c_str()) &&
                    xmlTypeEqual(subnode, XML_ELEMENT_NODE))
                {
                    ConfigurationObject *const cobj = new ConfigurationObject;
                    cobj->initFromXML(subnode);  // recurse
                    mContainerOptions[name].push_back(cobj);
                }
            }
        }
        else if (xmlNameEqual(node, "option"))
        {
            // single option handling
            const std::string name = XML::getProperty(node,
                "name", std::string());
            if (!name.empty())
            {
                mOptions[name] = XML::getProperty(node,
                    "value", std::string());
            }
        }  // otherwise ignore
    }
}

References clear(), ConfigurationObject(), for_each_xml_child_node, XML::getProperty(), initFromXML(), mContainerOptions, and mOptions.

Referenced by Configuration::init(), initFromXML(), and Configuration::reInit().

setList()

template<class IT , class T , class CONT >

void ConfigurationObject::setList ( const std::string &  name, IT  begin, IT  end, ConfigurationListManager< T, CONT > *  manager  )

inline

Serialises a container into a list of configuration options

Parameters

name	Name of the list the elements should be stored under
begin	Iterator start
end	Iterator end
manager	An object capable of serialising T items

Definition at line 146 of file configuration.h.

        {
            if (!manager)
                return;
 
            ConfigurationObject *nextobj = new ConfigurationObject;
            deleteList(name);
            ConfigurationList *list = &(mContainerOptions[name]);
 
            for (IT it = begin; it != end; it++)
            {
                ConfigurationObject *const wrobj
                    = manager->writeConfigItem(*it, nextobj);
                if (wrobj)
                {   // wrote something
                    nextobj = new ConfigurationObject;
                    list->push_back(wrobj);
                }
                else
                {
                    nextobj->clear();  // you never know...
                }
            }
 
            delete nextobj;
        }

References clear(), ConfigurationObject(), deleteList(), mContainerOptions, and ConfigurationListManager< T, CONT >::writeConfigItem().

Referenced by PlayerRelationsManager::store().

setValue()

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

virtual

Sets an option using a string value.

Parameters

key	Option identifier.
value	Value.

Reimplemented in Configuration.

Definition at line 228 of file configuration.cpp.

{
    mOptions[key] = value;
}

References mOptions.

Referenced by Configuration::setSilent(), and Configuration::setValue().

writeToXML()

void ConfigurationObject::writeToXML ( const xmlTextWriterPtr  writer )

protectedvirtual

Definition at line 813 of file configuration.cpp.

{
    FOR_EACH (Options::const_iterator, i, mOptions)
    {
#ifdef DEBUG_CONFIG
        if (mLogKeys)
        {
            if (optionsCount.find(i->first) == optionsCount.end())
                logger->log("unused configuration option: " + i->first);
        }
#endif  // DEBUG_CONFIG
 
        XmlTextWriterStartElement(writer, "option");
        XmlTextWriterWriteAttribute(writer, "name", i->first.c_str());
        XmlTextWriterWriteAttribute(writer, "value", i->second.c_str());
        XmlTextWriterEndElement(writer);
    }
 
    for (std::map<std::string, ConfigurationList>::const_iterator
         it = mContainerOptions.begin(), it_fend = mContainerOptions.end();
         it != it_fend; ++ it)
    {
        const char *const name = it->first.c_str();
 
        XmlTextWriterStartElement(writer, "list");
        XmlTextWriterWriteAttribute(writer, "name", name);
 
        // recurse on all elements
        FOR_EACH (ConfigurationList::const_iterator, elt_it, it->second)
        {
            XmlTextWriterStartElement(writer, name);
            if (*elt_it != nullptr)
                (*elt_it)->writeToXML(writer);
            XmlTextWriterEndElement(writer);
        }
 
        XmlTextWriterEndElement(writer);
    }
}

References FOR_EACH, Logger::log(), logger, mContainerOptions, and mOptions.

Referenced by Configuration::write().

Friends And Related Function Documentation

Configuration

friend class Configuration

friend

Definition at line 90 of file configuration.h.

Field Documentation

mContainerOptions

std::map<std::string, ConfigurationList> ConfigurationObject::mContainerOptions

protected

Definition at line 221 of file configuration.h.

Referenced by clear(), deleteList(), getList(), initFromXML(), setList(), and writeToXML().

mOptions

Options ConfigurationObject::mOptions

protected

Definition at line 218 of file configuration.h.

Referenced by clear(), deleteKey(), Configuration::getBoolValue(), Configuration::getFloatValue(), Configuration::getIntValue(), Configuration::getStringValue(), getValue(), getValueBool(), getValueInt(), Configuration::incValue(), initFromXML(), Configuration::removeOldKeys(), setValue(), and writeToXML().

---

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

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