SWLocale Class Reference

#include <swlocale.h>

Collaboration diagram for SWLocale:

Classes
class	Private

Public Member Functions
virtual void	augment (SWLocale &addFrom)
virtual struct abbrev *	getBookAbbrevs (int *retSize)
virtual const char *	getDescription ()
virtual const char *	getEncoding ()
virtual const char *	getName ()
virtual SWLocale &	operator+= (SWLocale &addFrom)
	SWLocale (const char *ifilename)
virtual const char *	translate (const char *text)
virtual	~SWLocale ()

Static Public Attributes
static const char *	DEFAULT_LOCALE_NAME ="en"

Private Attributes
int	abbrevsCnt
struct abbrev *	bookAbbrevs
const char **	bookLongNames
const char **	bookPrefAbbrev
char *	description
char *	encoding
SWConfig *	localeSource
char *	name
Private *	p

Detailed Description

SWLocale is used for the localisation of the booknames The SWLocale is a class which holds the information of one language. Every language supported by SWORD has one SWLocale object, get the name of the Language using

See Also

getname of this class. Another functions useful for frontend developers is

getDescription.

Definition at line 39 of file swlocale.h.

Constructor & Destructor Documentation

SWLocale::SWLocale

(

const char *

ifilename

)

Definition at line 51 of file swlocale.cpp.

                                        {
    p = new Private;
    ConfigEntMap::iterator confEntry;

    name           = 0;
    description    = 0;
    encoding       = 0;
    bookAbbrevs    = 0;
    bookLongNames  = 0;
    bookPrefAbbrev = 0;
    if (ifilename) {
        localeSource   = new SWConfig(ifilename);
    }
    else {
        localeSource   = new SWConfig(0);
        (*localeSource)["Meta"]["Name"] = DEFAULT_LOCALE_NAME;
        (*localeSource)["Meta"]["Description"] = "English (US)";
        bookAbbrevs = (struct abbrev *)builtin_abbrevs;
        for (abbrevsCnt = 0; builtin_abbrevs[abbrevsCnt].osis[0]; abbrevsCnt++);
    }

    confEntry = localeSource->getSection("Meta").find("Name");
    if (confEntry != localeSource->getSection("Meta").end())
        stdstr(&name, (*confEntry).second.c_str());
    
    confEntry = localeSource->getSection("Meta").find("Description");
    if (confEntry != localeSource->getSection("Meta").end())
        stdstr(&description, (*confEntry).second.c_str());

    confEntry = localeSource->getSection("Meta").find("Encoding"); //Either empty (==Latin1) or UTF-8
    if (confEntry != localeSource->getSection("Meta").end())
        stdstr(&encoding, (*confEntry).second.c_str());
}

SWLocale::~SWLocale ( )

virtual

Definition at line 86 of file swlocale.cpp.

                    {

    delete localeSource;

    if (encoding)
        delete [] encoding;
    
    if (description)
        delete [] description;

    if (name)
        delete [] name;

    if (bookAbbrevs != builtin_abbrevs)
        delete [] bookAbbrevs;

    delete p;
}

Member Function Documentation

void SWLocale::augment ( SWLocale &  addFrom )

virtual

Definition at line 173 of file swlocale.cpp.

                                        {
    *localeSource += *addFrom.localeSource;
}

struct abbrev * SWLocale::getBookAbbrevs ( int *  retSize )

virtual

Definition at line 178 of file swlocale.cpp.

                                                          {
    static const char *nullstr = "";
    if (!bookAbbrevs) {
        // Assure all english abbrevs are present
        for (int j = 0; builtin_abbrevs[j].osis[0]; j++) {
            p->mergedAbbrevs[builtin_abbrevs[j].ab] = builtin_abbrevs[j].osis;
        }
        ConfigEntMap::iterator it = localeSource->getSection("Book Abbrevs").begin();
        ConfigEntMap::iterator end = localeSource->getSection("Book Abbrevs").end();
        for (; it != end; it++) {
            p->mergedAbbrevs[it->first.c_str()] = it->second.c_str();
        }
        int size = (int)p->mergedAbbrevs.size();
        bookAbbrevs = new struct abbrev[size + 1];
        int i = 0;
        for (LookupMap::iterator it = p->mergedAbbrevs.begin(); it != p->mergedAbbrevs.end(); it++, i++) {
            bookAbbrevs[i].ab = it->first.c_str();
            bookAbbrevs[i].osis = it->second.c_str();
        }

        bookAbbrevs[i].ab = nullstr;
        bookAbbrevs[i].osis = nullstr;
        abbrevsCnt = size;
    }
        
    *retSize = abbrevsCnt;
    return bookAbbrevs;
}

const char * SWLocale::getDescription ( )

virtual

Returns

The description. A possible example is "German".

Definition at line 163 of file swlocale.cpp.

                                     {
    return description;
}

const char * SWLocale::getEncoding ( )

virtual

Definition at line 168 of file swlocale.cpp.

                                  {
    return encoding;
}

const char * SWLocale::getName ( )

virtual

This function is used to get the name of the languages which this object is handling.

Returns

The name of the managed language. A possible example is "de".

Definition at line 158 of file swlocale.cpp.

                              {
    return name;
}

virtual SWLocale& SWLocale::operator+= ( SWLocale &  addFrom )

inlinevirtual

Definition at line 73 of file swlocale.h.

{ augment(addFrom); return *this; }

const char * SWLocale::translate ( const char *  text )

virtual

Definition at line 106 of file swlocale.cpp.

                                                {
    LookupMap::iterator entry;

    entry = p->lookupTable.find(text);

    if (entry == p->lookupTable.end()) {
        ConfigEntMap::const_iterator confEntry;
        bool found = false;

        SWBuf textBuf = text;
        if (textBuf.startsWith("prefAbbr_")) {
            textBuf.stripPrefix('_');
            confEntry = localeSource->getSection("Pref Abbrevs").find(textBuf);
            found = (confEntry != localeSource->getSection("Pref Abbrevs").end());
        }
        if (!found) {
            confEntry = localeSource->getSection("Text").find(textBuf);
            found =  (confEntry != localeSource->getSection("Text").end());
        }

        if (!found) {
            p->lookupTable.insert(LookupMap::value_type(text, textBuf.c_str()));
        }
        else {//valid value found
            /*
            - If Encoding==Latin1 and we have a StringHelper, convert to UTF-8
            - If StringHelper present and Encoding is UTF-8, use UTF8
            - If StringHelper not present and Latin1, use Latin1
            - If StringHelper not present and UTF-8, no idea what to do. Should't happen
            */
/*          if (StringHelper::getSystemStringHelper()) {
                if (!strcmp(encoding, "UTF-8")) {
                    p->lookupTable.insert(LookupMap::value_type(text, (*confEntry).second.c_str()));
                }
                else { //latin1 expected, convert to UTF-8
                    SWBuf t((*confEntry).second.c_str());
                    t = StringHelper::getSystemStringHelper()->latin2unicode( t );
                    
                    p->lookupTable.insert(LookupMap::value_type(text, t.c_str()));
                }
            }
            else { //no stringhelper, just insert. Nothing we can do*/
                p->lookupTable.insert(LookupMap::value_type(text, (*confEntry).second.c_str()));
//          }
            
        }
        entry = p->lookupTable.find(text);
    }
    return (*entry).second.c_str();
}

Member Data Documentation

int SWLocale::abbrevsCnt

private

Definition at line 53 of file swlocale.h.

struct abbrev* SWLocale::bookAbbrevs

private

Definition at line 52 of file swlocale.h.

const char** SWLocale::bookLongNames

private

Definition at line 54 of file swlocale.h.

const char** SWLocale::bookPrefAbbrev

private

Definition at line 55 of file swlocale.h.

const char * SWLocale::DEFAULT_LOCALE_NAME ="en"

static

Definition at line 75 of file swlocale.h.

char* SWLocale::description

private

Definition at line 50 of file swlocale.h.

char* SWLocale::encoding

private

Definition at line 51 of file swlocale.h.

SWConfig* SWLocale::localeSource

private

Definition at line 47 of file swlocale.h.

char* SWLocale::name

private

Definition at line 49 of file swlocale.h.

Private* SWLocale::p

private

Definition at line 43 of file swlocale.h.

---

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

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