TinyGetText::Dictionary Class Reference

A simple dictionary class that mimics gettext() behaviour. More...

#include <tinygettext.hpp>

List of all members.

Public Member Functions
	Dictionary (const LanguageDef &language_, const std::string &charset="")
	Dictionary ()
std::string	get_charset () const
	Return the charset used for this dictionary.
void	set_charset (const std::string &charset)
	Set a charset for this dictionary, this will NOT convert stuff, it is for information only, you have to convert stuff yourself when you add it with add_translation().
void	set_language (const LanguageDef &lang)
	Set the language that is used for this dictionary, this is mainly needed to evaluate plural forms.
std::string	translate (const std::string &msgid, const std::string &msgid2, int num)
	Translate the string msgid to its correct plural form, based on the number of items given by num.
std::string	translate (const std::string &msgid)
	Translate the string msgid.
const char *	translate (const char *msgid)
	Translate the string msgid.
void	add_translation (const std::string &msgid, const std::string &msgid2, const std::map< int, std::string > &msgstrs)
	Add a translation from msgid to msgstr to the dictionary, where msgid is the singular form of the message, msgid2 the plural form and msgstrs a table of translations.
void	add_translation (const std::string &msgid, const std::string &msgstr)
	Add a translation from msgid to msgstr to the dictionary.
Private Types
typedef std::map< std::string, std::string >	Entries
typedef std::map< std::string, std::map< int, std::string > >	PluralEntries
Private Attributes
Entries	entries
PluralEntries	plural_entries
LanguageDef	language
std::string	charset

---

Detailed Description

A simple dictionary class that mimics gettext() behaviour.

Each Dictionary only works for a single language, for managing multiple languages and .po files at once use the DictionaryManager.

Definition at line 46 of file tinygettext.hpp.

---

Member Typedef Documentation

typedef std::map<std::string, std::string> TinyGetText::Dictionary::Entries [private]

Definition at line 49 of file tinygettext.hpp.

typedef std::map<std::string, std::map<int, std::string> > TinyGetText::Dictionary::PluralEntries [private]

Definition at line 52 of file tinygettext.hpp.

---

Constructor & Destructor Documentation

TinyGetText::Dictionary::Dictionary	(	const LanguageDef &	language_,
		const std::string &	charset = ""
	)

Definition at line 428 of file tinygettext.cpp.

  : language(language_), charset(charset_)
{
}

TinyGetText::Dictionary::Dictionary

(

)

Definition at line 433 of file tinygettext.cpp.

  : language(lang_en)
{
}

---

Member Function Documentation

std::string TinyGetText::Dictionary::get_charset

(

)

const

Return the charset used for this dictionary.

Definition at line 439 of file tinygettext.cpp.

References charset.

Referenced by TinyGetText::POFileReader::parse_header().

{
  return charset;
}

void TinyGetText::Dictionary::set_charset

(

const std::string &

charset

)

Set a charset for this dictionary, this will NOT convert stuff, it is for information only, you have to convert stuff yourself when you add it with add_translation().

Definition at line 445 of file tinygettext.cpp.

References charset.

Referenced by TinyGetText::DictionaryManager::get_dictionary(), and TinyGetText::POFileReader::parse_header().

{
  charset = charset_;
}

void TinyGetText::Dictionary::set_language

(

const LanguageDef &

lang

)

Set the language that is used for this dictionary, this is mainly needed to evaluate plural forms.

Definition at line 451 of file tinygettext.cpp.

References language.

Referenced by TinyGetText::DictionaryManager::get_dictionary().

{
  language = lang;
}

std::string TinyGetText::Dictionary::translate	(	const std::string &	msgid,
		const std::string &	msgid2,
		int	num
	)

Translate the string msgid to its correct plural form, based on the number of items given by num.

msgid2 is msgid in plural form.

Definition at line 457 of file tinygettext.cpp.

References language, log_debug, log_warning, TinyGetText::LanguageDef::plural, TinyGetText::plural2_1(), and plural_entries.

{
  PluralEntries::iterator i = plural_entries.find(msgid);
  std::map<int, std::string>& msgstrs = i->second;

  if (i != plural_entries.end() && !msgstrs.empty())
    {
      int g = language.plural(num);
      std::map<int, std::string>::iterator j = msgstrs.find(g);
      if (j != msgstrs.end())
        {
          return j->second;
        }
      else
        {
          // Return the first translation, in case we can't translate the specific number
          return msgstrs.begin()->second;
        }
    }
  else
    {
#ifdef TRANSLATION_DEBUG
      log_warning << "Couldn't translate: " << msgid << std::endl;
      log_warning << "Candidates: " << std::endl;
      for (PluralEntries::iterator i = plural_entries.begin(); i != plural_entries.end(); ++i)
        log_debug << "'" << i->first << "'" << std::endl;
#endif

      if (plural2_1(num)) // default to english rules
        return msgid2;
      else
        return msgid;
    }
}

std::string TinyGetText::Dictionary::translate

(

const std::string &

msgid

)

Translate the string msgid.

Definition at line 510 of file tinygettext.cpp.

References entries, and log_warning.

{
  Entries::iterator i = entries.find(msgid);
  if (i != entries.end() && !i->second.empty())
    {
      return i->second;
    }
  else
    {
#ifdef TRANSLATION_DEBUG
      log_warning << "Couldn't translate: " << msgid << std::endl;
#endif
      return msgid;
    }
}

const char * TinyGetText::Dictionary::translate

(

const char *

msgid

)

Translate the string msgid.

Definition at line 493 of file tinygettext.cpp.

References entries, and log_warning.

{
  Entries::iterator i = entries.find(msgid);
  if (i != entries.end() && !i->second.empty())
    {
      return i->second.c_str();
    }
  else
    {
#ifdef TRANSLATION_DEBUG
      log_warning << "Couldn't translate: " << msgid << std::endl;
#endif
      return msgid;
    }
}

void TinyGetText::Dictionary::add_translation	(	const std::string &	msgid,
		const std::string &	msgid2,
		const std::map< int, std::string > &	msgstrs
	)

Add a translation from msgid to msgstr to the dictionary, where msgid is the singular form of the message, msgid2 the plural form and msgstrs a table of translations.

The right translation will be calculated based on the num argument to translate().

Definition at line 527 of file tinygettext.cpp.

References plural_entries.

Referenced by TinyGetText::POFileReader::tokenize_po().

{
  // Do we need msgid2 for anything? its after all supplied to the
  // translate call, so we just throw it away
  plural_entries[msgid] = msgstrs;
}

void TinyGetText::Dictionary::add_translation	(	const std::string &	msgid,
		const std::string &	msgstr
	)

Add a translation from msgid to msgstr to the dictionary.

Definition at line 536 of file tinygettext.cpp.

References entries.

{
  entries[msgid] = msgstr;
}

---

Member Data Documentation

Entries TinyGetText::Dictionary::entries [private]

Definition at line 50 of file tinygettext.hpp.

Referenced by add_translation(), and translate().

PluralEntries TinyGetText::Dictionary::plural_entries [private]

Definition at line 53 of file tinygettext.hpp.

Referenced by add_translation(), and translate().

LanguageDef TinyGetText::Dictionary::language [private]

Definition at line 55 of file tinygettext.hpp.

Referenced by set_language(), and translate().

std::string TinyGetText::Dictionary::charset [private]

Definition at line 56 of file tinygettext.hpp.

Referenced by get_charset(), and set_charset().

---

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

• src/tinygettext/tinygettext.hpp
• src/tinygettext/tinygettext.cpp

---