LocaleMgr Class Reference

#include <localemgr.h>

Collaboration diagram for LocaleMgr:

Public Member Functions
virtual StringList	getAvailableLocales ()
virtual const char *	getDefaultLocaleName ()
virtual SWLocale *	getLocale (const char *name)
virtual void	loadConfigDir (const char *ipath)
	LocaleMgr (const char *iConfigPath=0)
virtual void	setDefaultLocaleName (const char *name)
virtual const char *	translate (const char *text, const char *localeName=0)
virtual	~LocaleMgr ()

Static Public Member Functions
static LocaleMgr *	getSystemLocaleMgr ()
static void	setSystemLocaleMgr (LocaleMgr *newLocaleMgr)

Protected Attributes
LocaleMap *	locales

Static Protected Attributes
static LocaleMgr *	systemLocaleMgr = 0

Private Member Functions
void	deleteLocales ()
	LocaleMgr (const LocaleMgr &)

Private Attributes
char *	defaultLocaleName

Friends
class	__staticsystemLocaleMgr

Detailed Description

The LocaleMgr class handles all the different locales of SWORD. It provides functions to get a list of all available locales, to get the default locale name and to get it. The other functions are not interesting for frontend programmers.

To get the default locale name use

See Also

getDefaultLocaleName To set the default locale name use

setDefaultLocaleName To get the locale for a language name use

getLocale To get a list of availble locales use

getAvailableLocales

Definition at line 50 of file localemgr.h.

Constructor & Destructor Documentation

LocaleMgr::LocaleMgr ( const LocaleMgr &  )

private

LocaleMgr::LocaleMgr

(

const char *

iConfigPath = 0

)

Default constructor of LocaleMgr You do not normally need this constructor; use LocaleMgr::getSystemLocaleMgr() instead.

Definition at line 72 of file localemgr.cpp.

                                            {
    locales = new LocaleMap();
    char *prefixPath = 0;
    char *configPath = 0;
    SWConfig *sysConf = 0;
    char configType = 0;
    SWBuf path;
    std::list<SWBuf> augPaths;
    ConfigEntMap::iterator entry;
    
    defaultLocaleName = 0;
    
    if (!iConfigPath) {
        SWLOGTI("LOOKING UP LOCALE DIRECTORY...");
        SWMgr::findConfig(&configType, &prefixPath, &configPath, &augPaths, &sysConf);
        if (sysConf) {
            if ((entry = sysConf->getSection("Install").find("LocalePath")) != sysConf->getSection("Install").end()) {
                configType = 9; // our own
                stdstr(&prefixPath, (char *)entry->second.c_str());
                SWLOGTI("LocalePath provided in sysConfig.");
            }
        }
        SWLOGTI("LOOKING UP LOCALE DIRECTORY COMPLETE.");
    }
    else {
        loadConfigDir(iConfigPath);
    }
    
    if (prefixPath) {
        switch (configType) {
        case 2:
            int i;
            for (i = (int)strlen(configPath)-1; ((i) && (configPath[i] != '/') && (configPath[i] != '\\')); i--);
            configPath[i] = 0;
            path = configPath;
            path += "/";
            break;
        default:
            path = prefixPath;
            if ((prefixPath[strlen(prefixPath)-1] != '\\') && (prefixPath[strlen(prefixPath)-1] != '/'))
                path += "/";

            break;
        }
        if (FileMgr::existsDir(path.c_str(), "locales.d")) {
            path += "locales.d";
            loadConfigDir(path.c_str());
        }
    }
    
    if (augPaths.size() && configType != 9) { //load locale files from all augmented paths
        std::list<SWBuf>::iterator it = augPaths.begin();
        std::list<SWBuf>::iterator end = augPaths.end();
        
        for (;it != end; ++it) {
            if (FileMgr::existsDir((*it).c_str(), "locales.d")) {
                SWBuf path = (*it) + "locales.d";
                loadConfigDir(path.c_str());
            }
        }
    }

    // Locales will be invalidated if you change the StringMgr
    // So only use the default hardcoded locale and let the
    // frontends change the locale if they want
    stdstr(&defaultLocaleName, SWLocale::DEFAULT_LOCALE_NAME);

    if (prefixPath)
        delete [] prefixPath;

    if (configPath)
        delete [] configPath;

    if (sysConf)
        delete sysConf;
}

LocaleMgr::~LocaleMgr ( )

virtual

Default destructor of LocaleMgr

Definition at line 150 of file localemgr.cpp.

                      {
    if (defaultLocaleName)
        delete [] defaultLocaleName;
        deleteLocales();
    delete locales;
}

Member Function Documentation

void LocaleMgr::deleteLocales ( )

private

Definition at line 199 of file localemgr.cpp.

                              {

    LocaleMap::iterator it;

    for (it = locales->begin(); it != locales->end(); it++)
        delete (*it).second;

    locales->erase(locales->begin(), locales->end());
}

std::list< SWBuf > LocaleMgr::getAvailableLocales ( )

virtual

Get the list of available locales.

Returns

Returns a list of strings, which contains the names of the available locales.

Definition at line 222 of file localemgr.cpp.

                                               {
    std::list <SWBuf> retVal;
    for (LocaleMap::iterator it = locales->begin(); it != locales->end(); it++) {
        if (strcmp(it->second->getName(), "locales")) {
            retVal.push_back((*it).second->getName());
        }
    }

    return retVal;
}

const char * LocaleMgr::getDefaultLocaleName ( )

virtual

Get the default locale name. To set it use

See Also

setDefaultLocaleName

Returns

Returns the default locale name

Definition at line 246 of file localemgr.cpp.

                                            {
    return defaultLocaleName;
}

SWLocale * LocaleMgr::getLocale ( const char *  name )

virtual

Get a locale object by name

Parameters

name	The name of the locale you want to have. For example use getLocale("de") to get the locale for the German language.

Returns

Returns the locale object if the locale with the name given as parameter was found. If it wasn't found return NULL.

Definition at line 210 of file localemgr.cpp.

                                               {
    LocaleMap::iterator it;

    it = locales->find(name);
    if (it != locales->end())
        return (*it).second;

    SWLog::getSystemLog()->logWarning("LocaleMgr::getLocale failed to find %s\n", name);
    return (*locales)[SWLocale::DEFAULT_LOCALE_NAME];
}

LocaleMgr * LocaleMgr::getSystemLocaleMgr ( )

static

The LocaleMgr object used globally in the SWORD world. Do not create your own LocaleMgr, use this static object instead.

Definition at line 54 of file localemgr.cpp.

                                         {
    if (!systemLocaleMgr) {
        setSystemLocaleMgr(new LocaleMgr());
    }

    return systemLocaleMgr;
}

void LocaleMgr::loadConfigDir ( const char *  ipath )

virtual

Augment this LocalMgr object with all locale.conf files in a directory

Definition at line 158 of file localemgr.cpp.

                                               {
    LocaleMap::iterator it;
    SWLOGD("LocaleMgr::loadConfigDir loading %s", ipath);
 
    SWBuf baseDir = ipath;
    if (!baseDir.endsWith('/') && !baseDir.endsWith('\\')) baseDir += '/';

    std::vector<DirEntry> dirList = FileMgr::getDirList(ipath);
    for (unsigned int i = 0; i < dirList.size(); ++i) {
        if (dirList[i].name.endsWith(".conf")) {
            SWBuf localeFile;
            localeFile = baseDir + dirList[i].name;
            SWLocale *locale = new SWLocale(localeFile);

            if (locale->getName()) {                    
                bool supported = false;
                if (StringMgr::hasUTF8Support()) {
                    supported = (locale->getEncoding() && (!strcmp(locale->getEncoding(), "UTF-8") || !strcmp(locale->getEncoding(), "ASCII")) );
                }
                else {
                    supported = !locale->getEncoding() || (locale->getEncoding() && (strcmp(locale->getEncoding(), "UTF-8") != 0)); //exclude UTF-8 locales
                }

                if (!supported) { //not supported
                    delete locale;
                    continue;
                }

                it = locales->find(locale->getName());
                if (it != locales->end()) { // already present
                    *((*it).second) += *locale;
                    delete locale;
                }
                else locales->insert(LocaleMap::value_type(locale->getName(), locale));
            }
            else    delete locale;
        }
    }
}

void LocaleMgr::setDefaultLocaleName ( const char *  name )

virtual

Set the new standard locale of SWORD.

Parameters

name	The name of the new default locale

Definition at line 251 of file localemgr.cpp.

                                                     {
    char *tmplang=0;
    stdstr(&tmplang, name);
    // discard everything after '.' usually encoding e.g. .UTF-8
    strtok(tmplang, ".");
    // also discard after '@' so e.g. @euro locales are found
    strtok(tmplang, "@");

    stdstr(&defaultLocaleName, tmplang);

    // First check for what we ask for
    if (locales->find(tmplang) == locales->end()) {
        // check for locale without country
        char *nocntry=0;
        stdstr(&nocntry, tmplang);
        strtok(nocntry, "_");
        if (locales->find(nocntry) != locales->end()) {
            stdstr(&defaultLocaleName, nocntry);
        }
        delete [] nocntry;
    }
    delete [] tmplang;
}

void LocaleMgr::setSystemLocaleMgr ( LocaleMgr *  newLocaleMgr )

static

Definition at line 63 of file localemgr.cpp.

                                                          {
    if (systemLocaleMgr)
        delete systemLocaleMgr;
    systemLocaleMgr = newLocaleMgr;
    SWLocale *locale = new SWLocale(0);
    systemLocaleMgr->locales->insert(LocaleMap::value_type(locale->getName(), locale));
}

const char * LocaleMgr::translate ( const char *  text, const char *  localeName = 0  )

virtual

Returns translated text. This function uses both parameters to return the translated version of the given text.

Parameters

text	The text to translate into the language given by the first parameter.
localeName	The name of the locale SWORD should use

Returns

Returns the translated text.

Definition at line 234 of file localemgr.cpp.

                                                                         {
    SWLocale *target;
    if (!localeName) {
        localeName = getDefaultLocaleName();
    }
    target = getLocale(localeName);
    if (target)
        return target->translate(text);
    return text;
}

Friends And Related Function Documentation

friend class __staticsystemLocaleMgr

friend

Definition at line 56 of file localemgr.h.

Member Data Documentation

char* LocaleMgr::defaultLocaleName

private

Definition at line 54 of file localemgr.h.

LocaleMap* LocaleMgr::locales

protected

Definition at line 59 of file localemgr.h.

SWORD_NAMESPACE_START LocaleMgr * LocaleMgr::systemLocaleMgr = 0

staticprotected

Definition at line 60 of file localemgr.h.

---

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

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