vdr 2.6.1
Macros | Functions
i18n.h File Reference
#include <stdio.h>
#include "tools.h"

Go to the source code of this file.

Macros

#define I18N_DEFAULT_LOCALE   "en_US"
 
#define I18N_MAX_LOCALE_LEN   16
 
#define I18N_MAX_LANGUAGES   256
 
#define tr(s)   I18nTranslate(s)
 
#define trNOOP(s)   (s)
 

Functions

void I18nInitialize (const char *LocaleDir=NULL)
 
void I18nRegister (const char *Plugin)
 
void I18nSetLocale (const char *Locale)
 
int I18nCurrentLanguage (void)
 
void I18nSetLanguage (int Language)
 
int I18nNumLanguagesWithLocale (void)
 
const cStringListI18nLanguages (void)
 
const char * I18nTranslate (const char *s, const char *Plugin=NULL) __attribute_format_arg__(1)
 
const char * I18nLocale (int Language)
 
const char * I18nLanguageCode (int Language)
 
int I18nLanguageIndex (const char *Code)
 
const char * I18nNormalizeLanguageCode (const char *Code)
 
bool I18nIsPreferredLanguage (int *PreferredLanguages, const char *LanguageCode, int &OldPreference, int *Position=NULL)
 

Macro Definition Documentation

◆ I18N_DEFAULT_LOCALE

#define I18N_DEFAULT_LOCALE   "en_US"

Definition at line 16 of file i18n.h.

◆ I18N_MAX_LANGUAGES

#define I18N_MAX_LANGUAGES   256

Definition at line 18 of file i18n.h.

◆ I18N_MAX_LOCALE_LEN

#define I18N_MAX_LOCALE_LEN   16

Definition at line 17 of file i18n.h.

◆ tr

#define tr (   s)    I18nTranslate(s)

Definition at line 85 of file i18n.h.

◆ trNOOP

#define trNOOP (   s)    (s)

Definition at line 88 of file i18n.h.

Function Documentation

◆ I18nCurrentLanguage()

int I18nCurrentLanguage ( void  )

Returns the index of the current language.

This number stays the same for any given language while the program is running, but may be different when the program is run again (for instance because a locale has been added or removed). The default locale ("en_US") always has a zero index.

Definition at line 230 of file i18n.c.

◆ I18nInitialize()

void I18nInitialize ( const char *  LocaleDir = NULL)

Detects all available locales and loads the language names and codes.

If LocaleDir is given, it must point to a static string that lives for the entire lifetime of the program.

Definition at line 141 of file i18n.c.

◆ I18nIsPreferredLanguage()

bool I18nIsPreferredLanguage ( int *  PreferredLanguages,
const char *  LanguageCode,
int &  OldPreference,
int *  Position = NULL 
)

Checks the given LanguageCode (which may be something like "eng" or "eng+deu") against the PreferredLanguages and returns true if one is found that has an index smaller than OldPreference (which should be initialized to -1 before the first call to this function in a sequence of checks).

If LanguageCode is not any of the PreferredLanguages, and OldPreference is less than zero, OldPreference will be set to a value higher than the highest language index. If Position is given, it will return 0 if this was a single language code (like "eng"), 1 if it was the first of two language codes (like "eng" out of "eng+deu") and 2 if it was the second one (like "deu" out of ""eng+deu").

Definition at line 316 of file i18n.c.

◆ I18nLanguageCode()

const char * I18nLanguageCode ( int  Language)

Returns the three letter language code of the given Language (which is an index as returned by I18nCurrentLanguage()).

If Language is outside the range of available languages, NULL is returned. The returned string may consist of several alternative three letter language codes, separated by commas (as in "deu,ger").

Definition at line 270 of file i18n.c.

◆ I18nLanguageIndex()

int I18nLanguageIndex ( const char *  Code)

Returns the index of the language with the given three letter language Code.

If no suitable language is found, -1 is returned.

Definition at line 275 of file i18n.c.

◆ I18nLanguages()

const cStringList * I18nLanguages ( void  )

Returns the list of available languages.

Values returned by I18nCurrentLanguage() are indexes into this list. Only the first I18nNumLanguagesWithLocale() entries in this list have an actual locale installed. The rest are just dummy entries to allow having three letter language codes for other languages that have no actual locale on this system.

Definition at line 248 of file i18n.c.

◆ I18nLocale()

const char * I18nLocale ( int  Language)

Returns the locale code of the given Language (which is an index as returned by I18nCurrentLanguage()).

If Language is outside the range of available languages, NULL is returned.

Definition at line 265 of file i18n.c.

◆ I18nNormalizeLanguageCode()

const char * I18nNormalizeLanguageCode ( const char *  Code)

Returns a 3 letter language code that may not be zero terminated.

If no normalized language code can be found, the given Code is returned. Make sure at most 3 characters are copied when using it!

Definition at line 285 of file i18n.c.

◆ I18nNumLanguagesWithLocale()

int I18nNumLanguagesWithLocale ( void  )

Returns the number of entries in the list returned by I18nLanguages() that actually have a locale.

Definition at line 243 of file i18n.c.

◆ I18nRegister()

void I18nRegister ( const char *  Plugin)

Registers the named plugin, so that it can use internationalized texts.

Definition at line 210 of file i18n.c.

◆ I18nSetLanguage()

void I18nSetLanguage ( int  Language)

Sets the current language index to Language.

If Language is outside the range of available languages, nothing happens.

Definition at line 235 of file i18n.c.

◆ I18nSetLocale()

void I18nSetLocale ( const char *  Locale)

Sets the current locale to Locale.

The default locale is "en_US". If no such locale has been found in the call to I18nInitialize(), nothing happens.

Definition at line 216 of file i18n.c.

◆ I18nTranslate()

const char * I18nTranslate ( const char *  s,
const char *  Plugin = NULL 
)

Translates the given string (with optional Plugin context) into the current language.

If no translation is available, the original string will be returned.

Definition at line 253 of file i18n.c.