SWConfig Class Reference

#include <swconfig.h>

Collaboration diagram for SWConfig:

Public Member Functions
virtual void	augment (const SWConfig &addFrom)
SWBuf	getFileName () const
ConfigEntMap &	getSection (const char *section)
virtual SectionMap &	getSections ()
const SectionMap &	getSections () const
SWBuf	getValue (const char *section, const char *key)
virtual void	load ()
SWDEPRECATED void	Load ()
SWConfig &	operator+= (const SWConfig &addFrom)
ConfigEntMap &	operator[] (const char *section)
virtual void	save () const
SWDEPRECATED void	Save ()
void	setValue (const char *section, const char *key, const char *value)
	SWConfig (const char *fileName)
	SWConfig ()
virtual	~SWConfig ()

Public Attributes
SWDEPRECATED SWBuf	filename
SWDEPRECATED SectionMap	Sections

Detailed Description

The class to read and save settings using a file on disk.

Definition at line 41 of file swconfig.h.

Constructor & Destructor Documentation

SWConfig::SWConfig

(

const char *

fileName

)

Map of available sections The map of available sections. Constructor of SWConfig

Parameters

fileName

The storage path for this config.

Definition at line 41 of file swconfig.cpp.

                                        {
    filename = ifilename;
    load();
}

SWORD_NAMESPACE_START SWConfig::SWConfig

(

)

Definition at line 37 of file swconfig.cpp.

                   {
}

SWConfig::~SWConfig ( )

virtual

Definition at line 47 of file swconfig.cpp.

                    {
}

Member Function Documentation

void SWConfig::augment ( const SWConfig &  addFrom )

virtual

Merges into this config the values from addFrom

Parameters

addFrom

The config which values should be merged to this config object. Already existing values will be overwritten.

Definition at line 148 of file swconfig.cpp.

                                              {

    SectionMap::const_iterator section;
    ConfigEntMap::const_iterator entry, start, end;

    for (section = addFrom.getSections().begin(); section != addFrom.getSections().end(); ++section) {
        for (entry = (*section).second.begin(); entry != (*section).second.end(); ++entry) {
            start = getSections()[section->first].lower_bound(entry->first);
            end   = getSections()[section->first].upper_bound(entry->first);
            // do we have multiple instances of the same key?
            if (start != end) {
                // TODO: what is this?
                ConfigEntMap::const_iterator x = addFrom.getSections().find(section->first)->second.lower_bound(entry->first);
                ConfigEntMap::const_iterator y = addFrom.getSections().find(section->first)->second.upper_bound(entry->first);
                ++x;
                if (((++start) != end) || (x != y)) {
                    for (--start; start != end; ++start) {
                        if (!strcmp(start->second.c_str(), entry->second.c_str()))
                            break;
                    }
                    if (start == end)
                        getSections()[(*section).first].insert(ConfigEntMap::value_type((*entry).first, (*entry).second));
                }
                else    getSections()[section->first][entry->first.c_str()] = entry->second.c_str();
            }       
            else    getSections()[section->first][entry->first.c_str()] = entry->second.c_str();
        }
    }
}

SWBuf SWConfig::getFileName

(

)

const

The storage path used by this SWConfig object

Definition at line 191 of file swconfig.cpp.

{ return filename; }

ConfigEntMap& SWConfig::getSection ( const char *  section )

inline

Get a specified section from config, creating the section if needed There is no const version of this method because it returns a ConfigEntMap reference, creating the requested section if it doesn't exist.

Parameters

section

section name to retrieve

Definition at line 76 of file swconfig.h.

{ return getSections()[section]; }

SectionMap & SWConfig::getSections ( )

virtual

Get the section map for the config

Definition at line 186 of file swconfig.cpp.

{ return Sections; }

const SectionMap& SWConfig::getSections ( ) const

inline

Definition at line 57 of file swconfig.h.

{ return const_cast<SWConfig *>(this)->getSections(); }

SWBuf SWConfig::getValue ( const char *  section, const char *  key  )

inline

get a value from a [section] key=value

Parameters

section	the section name containing the key
key	the key to which the value is associated

Returns

the value associated with the key in the provided section

Definition at line 102 of file swconfig.h.

                                                         {
        return (*this)[section][key];
    }

void SWConfig::load ( )

virtual

Load the content from datastore

Definition at line 55 of file swconfig.cpp.

                    {

    if (!getFileName().size()) return;  // assert we have a filename

    FileDesc *cfile;
    char *buf, *data;
    SWBuf line;
    ConfigEntMap cursect;
    SWBuf sectname;
    bool first = true;
    
    getSections().erase(getSections().begin(), getSections().end());
    
    cfile = FileMgr::getSystemFileMgr()->open(getFileName().c_str(), FileMgr::RDONLY);
    if (cfile->getFd() > 0) {
        bool goodLine = FileMgr::getLine(cfile, line);

        // clean UTF encoding tags at start of file
        while (goodLine && line.length() && 
                ((((unsigned char)line[0]) == 0xEF) ||
                 (((unsigned char)line[0]) == 0xBB) ||
                 (((unsigned char)line[0]) == 0xBF))) {
            line << 1;
        }
        
        while (goodLine) {
            // ignore commented lines
            if (!line.startsWith("#")) {
                buf = new char [ line.length() + 1 ];
                strcpy(buf, line.c_str());
                if (*strstrip(buf) == '[') {
                    if (!first)
                        getSections().insert(SectionMap::value_type(sectname, cursect));
                    else first = false;
                    
                    cursect.erase(cursect.begin(), cursect.end());

                    strtok(buf, "]");
                    sectname = buf+1;
                }
                else {
                    strtok(buf, "=");
                    if ((*buf) && (*buf != '=')) {
                        if ((data = strtok(NULL, "")))
                            cursect.insert(ConfigEntMap::value_type(buf, strstrip(data)));
                        else cursect.insert(ConfigEntMap::value_type(buf, ""));
                    }
                }
                delete [] buf;
            }
            goodLine = FileMgr::getLine(cfile, line);
        }
        if (!first)
            getSections().insert(SectionMap::value_type(sectname, cursect));

        FileMgr::getSystemFileMgr()->close(cfile);
    }
}

SWDEPRECATED void SWConfig::Load ( )

inline

Deprecated:

Use load() instead.

Definition at line 135 of file swconfig.h.

{ load(); }

SWConfig& SWConfig::operator+= ( const SWConfig &  addFrom )

inline

shorthand operator for augment

Definition at line 95 of file swconfig.h.

{ augment(addFrom); return *this; }

ConfigEntMap& SWConfig::operator[] ( const char *  section )

inline

This operator provides a conventient syntax to get and store config values

config[section][key] = value; value = config[section][key];

The following will work:

SWConfig config("/home/user/.settings");
config["Colors"]["Background"] = "red";

Definition at line 91 of file swconfig.h.

{ return getSection(section); }

void SWConfig::save ( ) const

virtual

Save the content of this config object to the datastore

Definition at line 115 of file swconfig.cpp.

                          {

    if (!getFileName().size()) return;  // assert we have a filename

    FileDesc *cfile;
    SWBuf buf;
    SectionMap::const_iterator sit;
    ConfigEntMap::const_iterator entry;
    SWBuf sectname;
    
    cfile = FileMgr::getSystemFileMgr()->open(getFileName().c_str(), FileMgr::RDWR|FileMgr::CREAT|FileMgr::TRUNC);
    if (cfile->getFd() > 0) {
        
        for (sit = getSections().begin(); sit != getSections().end(); ++sit) {
            buf =  "\n[";
            buf += (*sit).first.c_str();
            buf += "]\n";
            cfile->write(buf.c_str(), buf.length());
            for (entry = (*sit).second.begin(); entry != (*sit).second.end(); ++entry) {
                buf = (*entry).first.c_str();
                buf += "=";
                buf += (*entry).second.c_str();
                buf += "\n";
                cfile->write(buf.c_str(), buf.length());
            }
        }
        buf = "\n";
        cfile->write(buf.c_str(), buf.length());
        FileMgr::getSystemFileMgr()->close(cfile);
    }
}

SWDEPRECATED void SWConfig::Save ( )

inline

Deprecated:

Use save() instead.

Definition at line 140 of file swconfig.h.

{ save(); }

void SWConfig::setValue ( const char *  section, const char *  key, const char *  value  )

inline

set a value for a specified key in a [section]

Parameters

section	the section name to contain the key
key	the key to which to associate the value
value	the value to associated with the key

Definition at line 111 of file swconfig.h.

                                                                           {
        (*this)[section][key] = value;
    }

Member Data Documentation

SWDEPRECATED SWBuf SWConfig::filename

Deprecated:

Use getFileName() instead.

Definition at line 130 of file swconfig.h.

SWDEPRECATED SectionMap SWConfig::Sections

Deprecated:

Use getSections() instead.

Definition at line 125 of file swconfig.h.

---

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

• include/swconfig.h
• src/mgr/swconfig.cpp