Update copyright.
[kopensolaris-gnu/glibc.git] / intl / libintl.h
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.
4
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.
9
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.
14
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.  */
19
20 #ifndef _LIBINTL_H
21 #define _LIBINTL_H      1
22
23 #include <features.h>
24
25 /* We define an additional symbol to signal that we use the GNU
26    implementation of gettext.  */
27 #define __USE_GNU_GETTEXT 1
28
29 __BEGIN_DECLS
30
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;
35
36 /* Look up MSGID in the DOMAINNAME message catalog for the current
37    LC_MESSAGES locale.  */
38 extern char *dgettext (__const char *__domainname,
39                        __const char *__msgid) __THROW;
40 extern char *__dgettext (__const char *__domainname,
41                          __const char *__msgid) __THROW;
42
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) __THROW;
49
50
51 /* Similar to `gettext' but select the plural form corresponding to the
52    number N.  */
53 extern char *ngettext (__const char *__msgid1, __const char *__msgid2,
54                        unsigned long int __n)
55      __THROW __attribute__ ((__format_arg__ (1)));
56
57 /* Similar to `dgettext' but select the plural form corresponding to the
58    number N.  */
59 extern char *dngettext (__const char *__domainname, __const char *__msgid1,
60                         __const char *__msgid2, unsigned long int __n)
61      __THROW __attribute__ ((__format_arg__ (2)));
62
63 /* Similar to `dxgettext' but select the plural form corresponding to the
64    number N.  */
65 extern char *dcngettext (__const char *__domainname, __const char *__msgid1,
66                          __const char *__msgid2, unsigned long int __n,
67                          int __category)
68      __THROW __attribute__ ((__format_arg__ (2)));
69
70
71 /* Set the current default message catalog to DOMAINNAME.
72    If DOMAINNAME is null, return the current default.
73    If DOMAINNAME is "", reset to the default of "messages".  */
74 extern char *textdomain (__const char *__domainname) __THROW;
75
76 /* Specify that the DOMAINNAME message catalog will be found
77    in DIRNAME rather than in the system locale data base.  */
78 extern char *bindtextdomain (__const char *__domainname,
79                              __const char *__dirname) __THROW;
80
81
82 /* Optimized version of the function above.  */
83 #if defined __OPTIMIZE__
84
85 /* We need NULL for `gettext'.  */
86 # define __need_NULL
87 # include <stddef.h>
88
89 /* We need LC_MESSAGES for `dgettext'.  */
90 # include <locale.h>
91
92 /* These must be macros.  Inlined functions are useless because the
93    `__builtin_constant_p' predicate in dcgettext would always return
94    false.  */
95
96 # define gettext(msgid) dgettext (NULL, msgid)
97
98 # define dgettext(domainname, msgid)                                          \
99   dcgettext (domainname, msgid, LC_MESSAGES)
100
101 # define ngettext(msgid, n) dngettext (NULL, msgid, n)
102
103 # define dngettext(domainname, msgid, n)                                      \
104   dcngettext (domainname, msgid, n, LC_MESSAGES)
105
106 #endif  /* Optimizing.  */
107
108 __END_DECLS
109
110 #endif /* libintl.h */