PhysicsFS-aware gettext implementation. More...

#include "gettext.h"
#include "array.h"
#include "env.h"
#include "log.h"
#include "msgcat.h"
#include "ndata.h"

Data Structures
struct	translation_t

Functions
static void	gettext_readStats (void)
	Read the GETTEXT_STATS_PATH data and compute gettext_nstrings. (Common case: just a "naev.txt" file with one number. But mods pulled in via PhysicsFS can have their own string counts.)

static const char *	gettext_matchLanguage (const char lang, size_t lang_len, char const *available)
	Pick the best match from "available" (a physfs listing) for the string-slice with address lang, length lang_len.

void	gettext_init (void)
	Initialize the translation system. There's no presumption that PhysicsFS is available, so this doesn't actually load translations. We loosely follow: https://www.gnu.org/software/gettext/manual/html_node/Locale-Environment-Variables.html.

void	gettext_exit (void)
	Free resources associated with the translation system. This invalidates previously returned pointers to translated strings; be sure to actually exit after calling!

const char *	gettext_getSystemLanguage (void)
	Gets the current system language as detected by Naev.

const char *	gettext_getLanguage (void)
	Gets the active (primary) translation language. Even in case of a complex locale, this will be the name of the first message catalog to be checked (or the "en" language code for untranslated English). The purpose is to provide a simple answer to things like libunibreak which ask which language we're using.

void	gettext_setLanguage (const char *lang)
	Set the translation language.

const char *	gettext_ngettext (const char msgid, const char msgid_plural, uint64_t n)
	Return a translated version of the input, using the current language catalogs.

const char *	gettext_pgettext_impl (const char lookup, const char msgid)
	Helper function for p_(): Return _(lookup) with a fallback of msgid rather than lookup.

LanguageOption *	gettext_languageOptions (void)
	List the available languages, with completeness statistics.

double	gettext_languageCoverage (const char *lang)
	Return the fraction of strings which have a translation into the given language.

const char *	pgettext_var (const char msgctxt, const char msgid)

Variables
static char *	gettext_systemLanguage = NULL

static translation_t *	gettext_translations = NULL

static translation_t *	gettext_activeTranslation = NULL

static uint32_t	gettext_nstrings = 0

Detailed Description

PhysicsFS-aware gettext implementation.

Definition in file gettext.c.

Function Documentation

◆ gettext_exit()

void gettext_exit ( void )

Free resources associated with the translation system. This invalidates previously returned pointers to translated strings; be sure to actually exit after calling!

Definition at line 81 of file gettext.c.

◆ gettext_getLanguage()

const char * gettext_getLanguage ( void )

Gets the active (primary) translation language. Even in case of a complex locale, this will be the name of the first message catalog to be checked (or the "en" language code for untranslated English). The purpose is to provide a simple answer to things like libunibreak which ask which language we're using.

Definition at line 112 of file gettext.c.

◆ gettext_getSystemLanguage()

const char * gettext_getSystemLanguage ( void )

Gets the current system language as detected by Naev.

Definition at line 102 of file gettext.c.

◆ gettext_init()

void gettext_init ( void )

Initialize the translation system. There's no presumption that PhysicsFS is available, so this doesn't actually load translations. We loosely follow: https://www.gnu.org/software/gettext/manual/html_node/Locale-Environment-Variables.html.

Definition at line 46 of file gettext.c.

◆ gettext_languageCoverage()

double gettext_languageCoverage ( const char * lang )

Return the fraction of strings which have a translation into the given language.

Parameters

lang	A single language code.

Definition at line 285 of file gettext.c.

◆ gettext_languageOptions()

LanguageOption * gettext_languageOptions ( void )

List the available languages, with completeness statistics.

Returns: Array (array.h) of LanguageOptions.

Definition at line 263 of file gettext.c.

◆ gettext_matchLanguage()

static const char * gettext_matchLanguage	(	const char *	lang,
		size_t	lang_len,
		char const	available )

static

Pick the best match from "available" (a physfs listing) for the string-slice with address lang, length lang_len.

Returns: The best match, if any, else NULL.

Definition at line 190 of file gettext.c.

◆ gettext_ngettext()

const char * gettext_ngettext	(	const char *	msgid,
		const char *	msgid_plural,
		uint64_t	n )

Return a translated version of the input, using the current language catalogs.

Parameters

msgid	The English singular form.
msgid_plural	The English plural form. (Pass NULL if simply translating `msgid1`.)
n	The number determining the plural form to use. (Pass 1 if simply translating `msgid1`.)

Returns: The translation in the message catalog, if it exists, else whichever of msgid1 or msgid2 is appropriate in English. The returned string must not be modified or freed.

Definition at line 217 of file gettext.c.

◆ gettext_pgettext_impl()

const char * gettext_pgettext_impl	(	const char *	lookup,
		const char *	msgid )

Helper function for p_(): Return _(lookup) with a fallback of msgid rather than lookup.

Definition at line 234 of file gettext.c.

◆ gettext_readStats()

static void gettext_readStats ( void )

static

Read the GETTEXT_STATS_PATH data and compute gettext_nstrings. (Common case: just a "naev.txt" file with one number. But mods pulled in via PhysicsFS can have their own string counts.)

Definition at line 244 of file gettext.c.

◆ gettext_setLanguage()

void gettext_setLanguage ( const char * lang )

Set the translation language.

Parameters

lang	Language code to use. If NULL, use the system default.

Definition at line 125 of file gettext.c.

◆ pgettext_var()

const char * pgettext_var	(	const char *	msgctxt,
		const char *	msgid )

The function is almost the same as p_() but msgctxt and msgid can be string variables.

Definition at line 318 of file gettext.c.

Variable Documentation

◆ gettext_activeTranslation

translation_t* gettext_activeTranslation = NULL

static

Active language's code.

Definition at line 35 of file gettext.c.

◆ gettext_nstrings

uint32_t gettext_nstrings = 0

static

Number of translatable strings in the game.

Definition at line 36 of file gettext.c.

◆ gettext_systemLanguage

char* gettext_systemLanguage = NULL

static

Language, or :-delimited list of them, from the system at startup.

Definition at line 33 of file gettext.c.

◆ gettext_translations

translation_t* gettext_translations = NULL

static

Linked list of loaded translation chains.

Definition at line 34 of file gettext.c.

Data Structures

Functions

Variables

Detailed Description

Function Documentation

◆ gettext_exit()

◆ gettext_getLanguage()

◆ gettext_getSystemLanguage()

◆ gettext_init()

◆ gettext_languageCoverage()

◆ gettext_languageOptions()

◆ gettext_matchLanguage()

◆ gettext_ngettext()

◆ gettext_pgettext_impl()

◆ gettext_readStats()

◆ gettext_setLanguage()

◆ pgettext_var()

Variable Documentation

◆ gettext_activeTranslation

◆ gettext_nstrings

◆ gettext_systemLanguage

◆ gettext_translations