Update.
[glibc.git] / intl / libintl.h
blob7298852f79ecf31c4f4db88d9f9bac8cf53f547c
1 /* Message catalogs for internationalization.
2 Copyright (C) 1995-1999, 2000 Free Software Foundation, Inc.
3 This file is derived from the file libgettext.h in the GNU gettext package.
5 The GNU C Library is free software; you can redistribute it and/or
6 modify it under the terms of the GNU Library General Public License as
7 published by the Free Software Foundation; either version 2 of the
8 License, or (at your option) any later version.
10 The GNU C Library is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 Library General Public License for more details.
15 You should have received a copy of the GNU Library General Public
16 License along with the GNU C Library; see the file COPYING.LIB. If not,
17 write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
18 Boston, MA 02111-1307, USA. */
20 #ifndef _LIBINTL_H
21 #define _LIBINTL_H 1
23 #include <features.h>
25 /* We define an additional symbol to signal that we use the GNU
26 implementation of gettext. */
27 #define __USE_GNU_GETTEXT 1
29 __BEGIN_DECLS
31 /* Look up MSGID in the current default message catalog for the current
32 LC_MESSAGES locale. If not found, returns MSGID itself (the default
33 text). */
34 extern char *gettext (__const char *__msgid) __THROW;
36 /* Look up MSGID in the DOMAINNAME message catalog for the current
37 LC_MESSAGES locale. */
38 extern char *dgettext (__const char *__domainname, __const char *__msgid)
39 __THROW;
40 extern char *__dgettext (__const char *__domainname, __const char *__msgid)
41 __THROW __attribute_format_arg__ (2);
43 /* Look up MSGID in the DOMAINNAME message catalog for the current CATEGORY
44 locale. */
45 extern char *dcgettext (__const char *__domainname,
46 __const char *__msgid, int __category) __THROW;
47 extern char *__dcgettext (__const char *__domainname,
48 __const char *__msgid, int __category)
49 __THROW __attribute_format_arg__ (2);
52 /* Similar to `gettext' but select the plural form corresponding to the
53 number N. */
54 extern char *ngettext (__const char *__msgid1, __const char *__msgid2,
55 unsigned long int __n)
56 __THROW __attribute_format_arg__ (1);
58 /* Similar to `dgettext' but select the plural form corresponding to the
59 number N. */
60 extern char *dngettext (__const char *__domainname, __const char *__msgid1,
61 __const char *__msgid2, unsigned long int __n)
62 __THROW __attribute_format_arg__ (2);
64 /* Similar to `dcgettext' but select the plural form corresponding to the
65 number N. */
66 extern char *dcngettext (__const char *__domainname, __const char *__msgid1,
67 __const char *__msgid2, unsigned long int __n,
68 int __category)
69 __THROW __attribute_format_arg__ (2);
72 /* Set the current default message catalog to DOMAINNAME.
73 If DOMAINNAME is null, return the current default.
74 If DOMAINNAME is "", reset to the default of "messages". */
75 extern char *textdomain (__const char *__domainname) __THROW;
77 /* Specify that the DOMAINNAME message catalog will be found
78 in DIRNAME rather than in the system locale data base. */
79 extern char *bindtextdomain (__const char *__domainname,
80 __const char *__dirname) __THROW;
82 /* Specify the character encoding in which the messages from the
83 DOMAINNAME message catalog will be returned. */
84 extern char *bind_textdomain_codeset (__const char *__domainname,
85 __const char *__codeset) __THROW;
88 /* Optimized version of the function above. */
89 #if defined __OPTIMIZE__
91 /* We need NULL for `gettext'. */
92 # define __need_NULL
93 # include <stddef.h>
95 /* We need LC_MESSAGES for `dgettext'. */
96 # include <locale.h>
98 /* These must be macros. Inlined functions are useless because the
99 `__builtin_constant_p' predicate in dcgettext would always return
100 false. */
102 # define gettext(msgid) dgettext (NULL, msgid)
104 # define dgettext(domainname, msgid) \
105 dcgettext (domainname, msgid, LC_MESSAGES)
107 # define ngettext(msgid1, msgid2, n) dngettext (NULL, msgid1, msgid2, n)
109 # define dngettext(domainname, msgid1, msgid2, n) \
110 dcngettext (domainname, msgid1, msgid2, n, LC_MESSAGES)
112 #endif /* Optimizing. */
114 __END_DECLS
116 #endif /* libintl.h */