textdomain − set domain for future gettext() calls
#include <libintl.h>
char * textdomain (const char * domainname);
The textdomain function sets or retrieves the current message domain.
A message domain is a set of translatable msgid messages. Usually, every software package has its own message domain. The domain name is used to determine the message catalog where a translation is looked up; it must be a non-empty string.
The current message domain is used by the gettext, ngettext functions, and by the dgettext, dcgettext, dngettext and dcngettext functions when called with a NULL domainname argument.
If domainname is not NULL, the current message domain is set to domainname. The string the function stores internally is a copy of the domainname argument.
If domainname is NULL, the function returns the current message domain.
If successful, the textdomain function returns the current message domain, after possibly changing it. The resulting string is valid until the next textdomain call and must not be modified or freed. If a memory allocation failure occurs, it sets errno to ENOMEM and returns NULL.
The following error can occur, among others:
|
ENOMEM |
Not enough memory available. |
The return type ought to be const char *, but is char * to avoid warnings in C code predating ANSI C.
gettext(3), ngettext(3), bindtextdomain(3), bind_textdomain_codeset(3)
bind_textdomain_codeset − set encoding of message translations
#include <libintl.h>
char *
bind_textdomain_codeset (const char *
domainname,
const char * codeset);
The bind_textdomain_codeset function sets the output codeset for message catalogs for domain domainname.
A message domain is a set of translatable msgid messages. Usually, every software package has its own message domain.
By default, the gettext family of functions returns translated messages in the locale’s character encoding, which can be retrieved as nl_langinfo(CODESET). The need for calling bind_textdomain_codeset arises for programs which store strings in a locale independent way (e.g. UTF-8) and want to avoid an extra character set conversion on the returned translated messages.
domainname must be a non-empty string.
If codeset is not NULL, it must be a valid encoding name which can be used for the iconv_open function. The bind_textdomain_codeset function sets the output codeset for message catalogs belonging to domain domainname to codeset. The function makes copies of the argument strings as needed.
If codeset is NULL, the function returns the previously set codeset for domain domainname. The default is NULL, denoting the locale’s character encoding.
If successful, the bind_textdomain_codeset function returns the current codeset for domain domainname, after possibly changing it. The resulting string is valid until the next bind_textdomain_codeset call for the same domainname and must not be modified or freed. If a memory allocation failure occurs, it sets errno to ENOMEM and returns NULL. If no codeset has been set for domain domainname, it returns NULL.
The following error can occur, among others:
|
ENOMEM |
Not enough memory available. |
The return type ought to be const char *, but is char * to avoid warnings in C code predating ANSI C.
gettext(3), dgettext(3), dcgettext(3), ngettext(3), dngettext(3), dcngettext(3), textdomain(3), nl_langinfo(3), iconv_open(3)
|
|||||||
| PREV NEXT | FRAMES NO FRAMES | ||||||
|
|||||||
| PREV NEXT | FRAMES NO FRAMES | ||||||
|
|||||||
| PREV NEXT | FRAMES NO FRAMES | ||||||
Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain four categories:
- Interfaces (italic)
- Classes
- Exceptions
- Errors
Each class, interface, inner class and inner interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:
Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.
- Class inheritance diagram
- Direct Subclasses
- All Known Subinterfaces
- All Known Implementing Classes
- Class/interface declaration
- Class/interface description
- Inner Class Summary
- Field Summary
- Constructor Summary
- Method Summary
- Field Detail
- Constructor Detail
- Method Detail
There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting withjava.lang.Object. The interfaces do not inherit fromjava.lang.Object.
- When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
- When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.
This help file applies to API documentation generated using the standard doclet.
|
|||||||
| PREV NEXT | FRAMES NO FRAMES | ||||||
|
|||||||
| PREV NEXT | FRAMES NO FRAMES | ||||||
|
|||||||
| PREV NEXT | FRAMES NO FRAMES | ||||||
|
Classes
GettextResource |
|
||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||
|
||||||||
| PREV NEXT | FRAMES NO FRAMES | |||||||
|
|||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||
java.lang.Object
|
+--java.util.ResourceBundle
|
+--gnu.gettext.GettextResource
This class implements the main GNU libintl functions in Java.
Using the GNU gettext approach, compiled message catalogs are normal Java ResourceBundle classes and are thus interoperable with standard ResourceBundle based code.
The main differences between the Sun ResourceBundle approach and the GNU gettext approach are:
\unnnn syntax. Very few editors
can natively display international characters in this format. In the
GNU gettext approach, the translation files are called
"Resource.locale.po"
and are in the encoding the translator has chosen. Many editors
can be used. There are at least three GUI translating tools
(Emacs PO mode, KDE KBabel, GNOME gtranslator).
ResourceBundle.getString throws a
MissingResourceException when no translation is found.
In the GNU gettext approach, the gettext function
returns the (English) message key in that case.
ngettext function.
To compile GNU gettext message catalogs into Java ResourceBundle classes,
the msgfmt program can be used.
| Field Summary | |
static boolean |
verbose
|
| Fields inherited from class java.util.ResourceBundle |
parent |
| Constructor Summary | |
GettextResource()
|
|
| Method Summary | |
static java.lang.String |
gettext(java.util.ResourceBundle catalog,
java.lang.String msgid)
Returns the translation of msgid. |
static java.lang.String |
ngettext(java.util.ResourceBundle catalog,
java.lang.String msgid,
java.lang.String msgid_plural,
long n)
Returns the plural form for n of the translation of msgid. |
| Methods inherited from class java.util.ResourceBundle |
getBundle, getBundle, getBundle, getKeys, getLocale, getObject, getString, getStringArray, handleGetObject, setParent |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
public static boolean verbose
| Constructor Detail |
public GettextResource()
| Method Detail |
public static java.lang.String gettext(java.util.ResourceBundle catalog,
java.lang.String msgid)
catalog - a ResourceBundlemsgid - the key string to be translated, an ASCII string
public static java.lang.String ngettext(java.util.ResourceBundle catalog,
java.lang.String msgid,
java.lang.String msgid_plural,
long n)
catalog - a ResourceBundlemsgid - the key string to be translated, an ASCII stringmsgid_plural - its English plural form
|
|||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||
|
||||||||
| PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES | |||||||
| Class Summary | |
| GettextResource | This class implements the main GNU libintl functions in Java. |
|
||||||||
| PREV PACKAGE NEXT PACKAGE | FRAMES NO FRAMES | |||||||
|
|||||||
| PREV NEXT | FRAMES NO FRAMES | ||||||
|
|||||||
| PREV NEXT | FRAMES NO FRAMES | ||||||
|
|||||||
| PREV NEXT | FRAMES NO FRAMES | ||||||
|
|||||||
| PREV NEXT | FRAMES NO FRAMES | ||||||
| GettextResource
|
gettext, dgettext, dcgettext − translate message
#include <libintl.h>
char *
gettext (const char * msgid);
char * dgettext (const char * domainname,
const char * msgid);
char * dcgettext (const char * domainname,
const char * msgid,
int category);
The gettext, dgettext and dcgettext functions attempt to translate a text string into the user’s native language, by looking up the translation in a message catalog.
The msgid argument identifies the message to be translated. By convention, it is the English version of the message, with non-ASCII characters replaced by ASCII approximations. This choice allows the translators to work with message catalogs, called PO files, that contain both the English and the translated versions of each message, and can be installed using the msgfmt utility.
A message domain is a set of translatable msgid messages. Usually, every software package has its own message domain. The domain name is used to determine the message catalog where the translation is looked up; it must be a non-empty string. For the gettext function, it is specified through a preceding textdomain call. For the dgettext and dcgettext functions, it is passed as the domainname argument; if this argument is NULL, the domain name specified through a preceding textdomain call is used instead.
Translation lookup operates in the context of the current locale. For the gettext and dgettext functions, the LC_MESSAGES locale facet is used. It is determined by a preceding call to the setlocale function. setlocale(LC_ALL,"") initializes the LC_MESSAGES locale based on the first nonempty value of the three environment variables LC_ALL, LC_MESSAGES, LANG; see setlocale(3). For the dcgettext function, the locale facet is determined by the category argument, which should be one of the LC_xxx constants defined in the <locale.h> header, excluding LC_ALL. In both cases, the functions also use the LC_CTYPE locale facet in order to convert the translated message from the translator’s codeset to the current locale’s codeset, unless overridden by a prior call to the bind_textdomain_codeset function.
The message catalog used by the functions is at the pathname dirname/locale/category/domainname.mo. Here dirname is the directory specified through bindtextdomain. Its default is system and configuration dependent; typically it is prefix/share/locale, where prefix is the installation prefix of the package. locale is the name of the current locale facet; the GNU implementation also tries generalizations, such as the language name without the territory name. category is LC_MESSAGES for the gettext and dgettext functions, or the argument passed to the dcgettext function.
If the LANGUAGE environment variable is set to a nonempty value, and the locale is not the "C" locale, the value of LANGUAGE is assumed to contain a colon separated list of locale names. The functions will attempt to look up a translation of msgid in each of the locales in turn. This is a GNU extension.
In the "C" locale, or if none of the used catalogs contain a translation for msgid, the gettext, dgettext and dcgettext functions return msgid.
If a translation was found in one of the specified catalogs, it is converted to the locale’s codeset and returned. The resulting string is statically allocated and must not be modified or freed. Otherwise msgid is returned.
errno is not modified.
The return type ought to be const char *, but is char * to avoid warnings in C code predating ANSI C.
When an empty string is used for msgid, the functions may return a nonempty string.
ngettext(3), dngettext(3), dcngettext(3), setlocale(3), textdomain(3), bindtextdomain(3), bind_textdomain_codeset(3), msgfmt(1)
ngettext, dngettext, dcngettext − translate message and choose plural form
#include <libintl.h>
char *
ngettext (const char * msgid, const char *
msgid_plural,
unsigned long int n);
char * dngettext (const char * domainname,
const char * msgid, const char *
msgid_plural,
unsigned long int n);
char * dcngettext (const char * domainname,
const char * msgid, const char *
msgid_plural,
unsigned long int n, int
category);
The ngettext, dngettext and dcngettext functions attempt to translate a text string into the user’s native language, by looking up the appropriate plural form of the translation in a message catalog.
Plural forms are grammatical variants depending on the a number. Some languages have two forms, called singular and plural. Other languages have three forms, called singular, dual and plural. There are also languages with four forms.
The ngettext, dngettext and dcngettext functions work like the gettext, dgettext and dcgettext functions, respectively. Additionally, they choose the appropriate plural form, which depends on the number n and the language of the message catalog where the translation was found.
In the "C" locale, or if none of the used catalogs contain a translation for msgid, the ngettext, dngettext and dcngettext functions return msgid if n == 1, or msgid_plural if n != 1.
If a translation was found in one of the specified catalogs, the appropriate plural form is converted to the locale’s codeset and returned. The resulting string is statically allocated and must not be modified or freed. Otherwise msgid or msgid_plural is returned, as described above.
errno is not modified.
The return type ought to be const char *, but is char * to avoid warnings in C code predating ANSI C.
gettext(3), dgettext(3), dcgettext(3)
bindtextdomain − set directory containing message catalogs
#include <libintl.h>
char * bindtextdomain (const char * domainname, const char * dirname);
The bindtextdomain function sets the base directory of the hierarchy containing message catalogs for a given message domain.
A message domain is a set of translatable msgid messages. Usually, every software package has its own message domain. The need for calling bindtextdomain arises because packages are not always installed with the same prefix as the <libintl.h> header and the libc/libintl libraries.
Message catalogs will be expected at the pathnames dirname/locale/category/domainname.mo, where locale is a locale name and category is a locale facet such as LC_MESSAGES.
domainname must be a non-empty string.
If dirname is not NULL, the base directory for message catalogs belonging to domain domainname is set to dirname. The function makes copies of the argument strings as needed. If the program wishes to call the chdir function, it is important that dirname be an absolute pathname; otherwise it cannot be guaranteed that the message catalogs will be found.
If dirname is NULL, the function returns the previously set base directory for domain domainname.
If successful, the bindtextdomain function returns the current base directory for domain domainname, after possibly changing it. The resulting string is valid until the next bindtextdomain call for the same domainname and must not be modified or freed. If a memory allocation failure occurs, it sets errno to ENOMEM and returns NULL.
The following error can occur, among others:
|
ENOMEM |
Not enough memory available. |
The return type ought to be const char *, but is char * to avoid warnings in C code predating ANSI C.
gettext(3), dgettext(3), dcgettext(3), ngettext(3), dngettext(3), dcngettext(3), textdomain(3), realpath(3)