CI18nTranslator Class Reference

#include <CI18nTranslator.h>

List of all members.

Public Member Functions
bool	shouldBeTranslatedAttribute (string inAttribute) const
bool	shouldBeTranslatedText (string inContainingTag) const
void	setCurrentLanguage (const string &inLanguage)
string	getCurrentLanguage () const
void	setShouldBeTranslatedAttribute (string inString)
void	addTranslationPair (string inString, string inTranslatedString)
	CI18nTranslator (string inTranslationFileName)
const CXMLElement *	getLanguagesXML () const
bool	hasLanguage (string inLanguageCode) const
const pair< bool, string >	translateAttribute (string inLanguageCode, const string &inAttribute, const string &inValue) const
const pair< bool, string >	translateText (string inLanguageCode, const string &inContainingTag, const string &inText)
void	translateXMLTree (string inLanguageCode, CXMLElement &inoutToBeTranslated) const
Static Public Member Functions
static void	startXMLElement (void *inUserData, const char *inElementName, const char **inAttributes)
static void	endXMLElement (void *inUserData, const char *inElementName)
Private Types
typedef map< string, string >	CTranslatorMap
typedef map< string, bool >	CShouldBeTranslatedMap
typedef map< string, CTranslatorMap >	CLanguageMap
Private Attributes
CLanguageMap	mLanguageMap
CShouldBeTranslatedMap	mShouldBeTranslatedAttribute
string	mCurrentLanguage

---

Detailed Description

This class offers runtime translation of strings. In contrast to GNU gettext we can chose during runtime the language without additional overhead.

Definition at line 38 of file CI18nTranslator.h.

---

Member Typedef Documentation

typedef map<string,string> CI18nTranslator::CTranslatorMap [private]

a map that translates strings

Definition at line 40 of file CI18nTranslator.h.

typedef map<string,bool> CI18nTranslator::CShouldBeTranslatedMap [private]

a map that contains the decision if a given string is to be translated

Definition at line 43 of file CI18nTranslator.h.

typedef map<string,CTranslatorMap> CI18nTranslator::CLanguageMap [private]

a map that contains translators for a number of languages

Definition at line 45 of file CI18nTranslator.h.

---

Constructor & Destructor Documentation

CI18nTranslator::CI18nTranslator

(

string

inTranslationFileName

)

The constructor

This class offers runtime translation of strings. In contrast to GNU gettext we can chose during runtime the language without additional overhead. The constructor

Definition at line 34 of file CI18nTranslator.cc.

References endXMLElement(), and startXMLElement().

                                                            {
  ifstream inFile(inTranslationFileName.c_str());

  inFile.seekg(0,ios::end);
  int lFileSize(inFile.tellg());
  inFile.seekg(0,ios::beg);
  
  cout << "FileSize:" 
       << lFileSize 
       << " characters" 
       << endl;
  if(inFile){
    char* lBuffer=new char[lFileSize+1];
    inFile.read(lBuffer,lFileSize);
    lBuffer[lFileSize]=char(0);
    
    cout << "Read " << inTranslationFileName << endl;
    
    
  XML_Parser lParser = XML_ParserCreate(NULL);//default encoding
  
  XML_SetUserData(lParser,
      this);
  XML_SetElementHandler(lParser, 
      CI18nTranslator::startXMLElement,
      CI18nTranslator::endXMLElement);
  bool lDone=false;
  if (!XML_Parse(lParser, 
     lBuffer, 
     lFileSize, 
     lDone)) {
    cerr << __FILE__ <<":" << __LINE__ << ": XML ERROR: "
   << XML_ErrorString(XML_GetErrorCode(lParser))
   << " at line "
   << XML_GetCurrentLineNumber(lParser)
   << endl
   << "Internationalization will be disabled in this run of the GIFT"
   << endl;
  }
  XML_ParserFree(lParser);  
  }else{
    cerr << __FILE__ <<":" << __LINE__ << ": File unreadable."
   << endl << "Internationalization will be disabled in this run of the GIFT"
   << endl;

  }
};

---

Member Function Documentation

bool CI18nTranslator::shouldBeTranslatedAttribute

(

string

inString

)

const

should a given attribute string be translated?

Should the attribute be translated

Definition at line 126 of file CI18nTranslator.cc.

References mShouldBeTranslatedAttribute.

Referenced by CXEVI18nTranslator::startVisit().

                                                                     {
  return  
    mShouldBeTranslatedAttribute.find(inString)!=mShouldBeTranslatedAttribute.end() 
    && mShouldBeTranslatedAttribute.find(inString)->second;
};

bool CI18nTranslator::shouldBeTranslatedText

(

string

inContainingTag

)

const

should a given attribute string be translated?

void CI18nTranslator::setCurrentLanguage

(

const string &

inLanguage

)

set the current language during construction

Definition at line 115 of file CI18nTranslator.cc.

References mCurrentLanguage.

                                                                {
  mCurrentLanguage=inLanguage;
}

string CI18nTranslator::getCurrentLanguage

(

)

const

set the current language during construction

Definition at line 118 of file CI18nTranslator.cc.

References mCurrentLanguage.

                                               {
  return mCurrentLanguage;
}

void CI18nTranslator::setShouldBeTranslatedAttribute

(

string

inString

)

Should the attribute be translated

Definition at line 122 of file CI18nTranslator.cc.

References mShouldBeTranslatedAttribute.

                                                                   {
  mShouldBeTranslatedAttribute[inString]=true;
};

void CI18nTranslator::addTranslationPair	(	string	inString,
		string	inTranslatedString
	)

Add one translation pair

Definition at line 132 of file CI18nTranslator.cc.

References mCurrentLanguage, and mLanguageMap.

                                                                                 {
  mLanguageMap[mCurrentLanguage][inString]=inTranslatedString;
};

const CXMLElement * CI18nTranslator::getLanguagesXML

(

)

const

Get an MRML tag containing all offered languages

Definition at line 83 of file CI18nTranslator.cc.

                                                        {
  return 0;
};

bool CI18nTranslator::hasLanguage

(

string

inLanguage

)

const

Get a string list containing all languages

Get an MRML tag containing all offered languages

Definition at line 87 of file CI18nTranslator.cc.

References mLanguageMap.

Referenced by CSession::commitLanguages().

                                                       {
  return mLanguageMap.find(inLanguage)!=mLanguageMap.end();
};

const pair< bool, string > CI18nTranslator::translateAttribute	(	string	inLanguageCode,
		const string &	inAttribute,
		const string &	inValue
	)			const

Translate an attribute given by its name and its value

Returns:

pair: first, if the string should be translated, second, its value

Translate an attribute given by its name and its value

Returns:

pair: first, if the string should be translated, second, its value

Definition at line 94 of file CI18nTranslator.cc.

Referenced by CXEVI18nTranslator::startVisit().

                                             {
  return make_pair(true, inValue);
};

const pair< bool, string > CI18nTranslator::translateText	(	string	inLanguageCode,
		const string &	inContainingTag,
		const string &	inText
	)

Translate an tag containing pdata given by its name and its value

Returns:

pair: first, if the string should be translated, second, its value

Translate an tag containing pdata given by its name and its value

Returns:

pair: first, if the string should be translated, second, its value

Definition at line 103 of file CI18nTranslator.cc.

                                        {
  return make_pair(true, inText);
};

void CI18nTranslator::translateXMLTree	(	string	inLanguageCode,
		CXMLElement &	inoutToBeTranslated
	)			const

Translate a complete XML Tree

Definition at line 109 of file CI18nTranslator.cc.

References CXMLElement::traverse().

Referenced by CSessionManager::translate().

                                                     {
  CXEVI18nTranslator lVisitor(*this,inLanguageCode);
  inoutToBeTranslated.traverse(lVisitor);
};

void CI18nTranslator::startXMLElement	(	void *	inUserData,
		const char *	inElementName,
		const char **	inAttributes
	)			[static]

for parsing the config file

Definition at line 136 of file CI18nTranslator.cc.

References CAttributeList::stringReadAttribute().

Referenced by CI18nTranslator().

                                     {

  CI18nTranslator* self=(CI18nTranslator*)inUserData;

  CAttributeList lAttributes(inAttributes);

  if(strcmp("attribute",inElementName) && lAttributes.stringReadAttribute("name").first){
    self->setShouldBeTranslatedAttribute(lAttributes.stringReadAttribute("name").second);
  }
  if(strcmp("translation-list",inElementName) && lAttributes.stringReadAttribute("language-code").first){
    self->setCurrentLanguage(lAttributes.stringReadAttribute("language-code").second);
  }
  if(strcmp("translate",inElementName) && lAttributes.stringReadAttribute("key").first && lAttributes.stringReadAttribute("to").first){
    self->addTranslationPair(lAttributes.stringReadAttribute("key").second,
           lAttributes.stringReadAttribute("to").second);
  }
}

void CI18nTranslator::endXMLElement	(	void *	inUserData,
		const char *	inElementName
	)			[static]

for parsing the config file

Definition at line 155 of file CI18nTranslator.cc.

Referenced by CI18nTranslator().

                                     {
  CI18nTranslator* self=(CI18nTranslator*)inUserData;
}

---

Member Data Documentation

CLanguageMap CI18nTranslator::mLanguageMap [private]

This map contains translators for each language given in the gift-i18n file.

Definition at line 51 of file CI18nTranslator.h.

Referenced by addTranslationPair(), and hasLanguage().

CShouldBeTranslatedMap CI18nTranslator::mShouldBeTranslatedAttribute [private]

This map contains information about which

Definition at line 55 of file CI18nTranslator.h.

Referenced by setShouldBeTranslatedAttribute(), and shouldBeTranslatedAttribute().

string CI18nTranslator::mCurrentLanguage [private]

the current language while parsing the config file

Definition at line 59 of file CI18nTranslator.h.

Referenced by addTranslationPair(), getCurrentLanguage(), and setCurrentLanguage().

---

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

• gift/libMRML/include/CI18nTranslator.h
• gift/libMRML/cc/CI18nTranslator.cc