Use strdup in glibc. Correct comment.
[kopensolaris-gnu/glibc.git] / intl / dcgettext.c
1 /* Implementation of the dcgettext(3) function.
2    Copyright (C) 1995, 1996, 1997 Free Software Foundation, Inc.
3
4    This file is part of the GNU C Library.  Its master source is NOT part of
5    the C library, however.
6
7    The GNU C Library is free software; you can redistribute it and/or
8    modify it under the terms of the GNU Library General Public License as
9    published by the Free Software Foundation; either version 2 of the
10    License, or (at your option) any later version.
11
12    The GNU C Library is distributed in the hope that it will be useful,
13    but WITHOUT ANY WARRANTY; without even the implied warranty of
14    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15    Library General Public License for more details.
16
17    You should have received a copy of the GNU Library General Public
18    License along with the GNU C Library; see the file COPYING.LIB.  If not,
19    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20    Boston, MA 02111-1307, USA.  */
21
22 #ifdef HAVE_CONFIG_H
23 # include <config.h>
24 #endif
25
26 #include <sys/types.h>
27
28 #ifdef __GNUC__
29 # define alloca __builtin_alloca
30 # define HAVE_ALLOCA 1
31 #else
32 # if defined HAVE_ALLOCA_H || defined _LIBC
33 #  include <alloca.h>
34 # else
35 #  ifdef _AIX
36  #pragma alloca
37 #  else
38 #   ifndef alloca
39 char *alloca ();
40 #   endif
41 #  endif
42 # endif
43 #endif
44
45 #include <errno.h>
46 #ifndef errno
47 extern int errno;
48 #endif
49 #ifndef __set_errno
50 # define __set_errno(val) errno = (val)
51 #endif
52
53 #if defined STDC_HEADERS || defined _LIBC
54 # include <stdlib.h>
55 #else
56 char *getenv ();
57 # ifdef HAVE_MALLOC_H
58 #  include <malloc.h>
59 # else
60 void free ();
61 # endif
62 #endif
63
64 #if defined HAVE_STRING_H || defined _LIBC
65 # ifndef _GNU_SOURCE
66 #  define _GNU_SOURCE   1
67 # endif
68 # include <string.h>
69 #else
70 # include <strings.h>
71 #endif
72 #if !HAVE_STRCHR && !defined _LIBC
73 # ifndef strchr
74 #  define strchr index
75 # endif
76 #endif
77
78 #if defined HAVE_UNISTD_H || defined _LIBC
79 # include <unistd.h>
80 #endif
81
82 #include "gettext.h"
83 #include "gettextP.h"
84 #ifdef _LIBC
85 # include <libintl.h>
86 #else
87 # include "libgettext.h"
88 #endif
89 #include "hash-string.h"
90
91 /* @@ end of prolog @@ */
92
93 #ifdef _LIBC
94 /* Rename the non ANSI C functions.  This is required by the standard
95    because some ANSI C functions will require linking with this object
96    file and the name space must not be polluted.  */
97 # define getcwd __getcwd
98 # define stpcpy __stpcpy
99 #else
100 # if !defined HAVE_GETCWD
101 char *getwd ();
102 #  define getcwd(buf, max) getwd (buf)
103 # else
104 char *getcwd ();
105 # endif
106 # ifndef HAVE_STPCPY
107 static char *stpcpy PARAMS ((char *dest, const char *src));
108 # endif
109 #endif
110
111 /* Amount to increase buffer size by in each try.  */
112 #define PATH_INCR 32
113
114 /* The following is from pathmax.h.  */
115 /* Non-POSIX BSD systems might have gcc's limits.h, which doesn't define
116    PATH_MAX but might cause redefinition warnings when sys/param.h is
117    later included (as on MORE/BSD 4.3).  */
118 #if defined(_POSIX_VERSION) || (defined(HAVE_LIMITS_H) && !defined(__GNUC__))
119 # include <limits.h>
120 #endif
121
122 #ifndef _POSIX_PATH_MAX
123 # define _POSIX_PATH_MAX 255
124 #endif
125
126 #if !defined(PATH_MAX) && defined(_PC_PATH_MAX)
127 # define PATH_MAX (pathconf ("/", _PC_PATH_MAX) < 1 ? 1024 : pathconf ("/", _PC_PATH_MAX))
128 #endif
129
130 /* Don't include sys/param.h if it already has been.  */
131 #if defined(HAVE_SYS_PARAM_H) && !defined(PATH_MAX) && !defined(MAXPATHLEN)
132 # include <sys/param.h>
133 #endif
134
135 #if !defined(PATH_MAX) && defined(MAXPATHLEN)
136 # define PATH_MAX MAXPATHLEN
137 #endif
138
139 #ifndef PATH_MAX
140 # define PATH_MAX _POSIX_PATH_MAX
141 #endif
142
143 /* XPG3 defines the result of `setlocale (category, NULL)' as:
144    ``Directs `setlocale()' to query `category' and return the current
145      setting of `local'.''
146    However it does not specify the exact format.  And even worse: POSIX
147    defines this not at all.  So we can use this feature only on selected
148    system (e.g. those using GNU C Library).  */
149 #ifdef _LIBC
150 # define HAVE_LOCALE_NULL
151 #endif
152
153 /* Name of the default domain used for gettext(3) prior any call to
154    textdomain(3).  The default value for this is "messages".  */
155 const char _nl_default_default_domain[] = "messages";
156
157 /* Value used as the default domain for gettext(3).  */
158 const char *_nl_current_default_domain = _nl_default_default_domain;
159
160 /* Contains the default location of the message catalogs.  */
161 const char _nl_default_dirname[] = GNULOCALEDIR;
162
163 /* List with bindings of specific domains created by bindtextdomain()
164    calls.  */
165 struct binding *_nl_domain_bindings;
166
167 /* Prototypes for local functions.  */
168 static char *find_msg PARAMS ((struct loaded_l10nfile *domain_file,
169                                const char *msgid));
170 static const char *category_to_name PARAMS ((int category));
171 static const char *guess_category_value PARAMS ((int category,
172                                                  const char *categoryname));
173
174
175 /* For those loosing systems which don't have `alloca' we have to add
176    some additional code emulating it.  */
177 #ifdef HAVE_ALLOCA
178 /* Nothing has to be done.  */
179 # define ADD_BLOCK(list, address) /* nothing */
180 # define FREE_BLOCKS(list) /* nothing */
181 #else
182 struct block_list
183 {
184   void *address;
185   struct block_list *next;
186 };
187 # define ADD_BLOCK(list, addr)                                                \
188   do {                                                                        \
189     struct block_list *newp = (struct block_list *) malloc (sizeof (*newp));  \
190     /* If we cannot get a free block we cannot add the new element to         \
191        the list.  */                                                          \
192     if (newp != NULL) {                                                       \
193       newp->address = (addr);                                                 \
194       newp->next = (list);                                                    \
195       (list) = newp;                                                          \
196     }                                                                         \
197   } while (0)
198 # define FREE_BLOCKS(list)                                                    \
199   do {                                                                        \
200     while (list != NULL) {                                                    \
201       struct block_list *old = list;                                          \
202       list = list->next;                                                      \
203       free (old);                                                             \
204     }                                                                         \
205   } while (0)
206 # undef alloca
207 # define alloca(size) (malloc (size))
208 #endif  /* have alloca */
209
210
211 /* Names for the libintl functions are a problem.  They must not clash
212    with existing names and they should follow ANSI C.  But this source
213    code is also used in GNU C Library where the names have a __
214    prefix.  So we have to make a difference here.  */
215 #ifdef _LIBC
216 # define DCGETTEXT __dcgettext
217 #else
218 # define DCGETTEXT dcgettext__
219 #endif
220
221 /* Look up MSGID in the DOMAINNAME message catalog for the current CATEGORY
222    locale.  */
223 char *
224 DCGETTEXT (domainname, msgid, category)
225      const char *domainname;
226      const char *msgid;
227      int category;
228 {
229 #ifndef HAVE_ALLOCA
230   struct block_list *block_list = NULL;
231 #endif
232   struct loaded_l10nfile *domain;
233   struct binding *binding;
234   const char *categoryname;
235   const char *categoryvalue;
236   char *dirname, *xdomainname;
237   char *single_locale;
238   char *retval;
239   int saved_errno = errno;
240
241   /* If no real MSGID is given return NULL.  */
242   if (msgid == NULL)
243     return NULL;
244
245   /* If DOMAINNAME is NULL, we are interested in the default domain.  If
246      CATEGORY is not LC_MESSAGES this might not make much sense but the
247      defintion left this undefined.  */
248   if (domainname == NULL)
249     domainname = _nl_current_default_domain;
250
251   /* First find matching binding.  */
252   for (binding = _nl_domain_bindings; binding != NULL; binding = binding->next)
253     {
254       int compare = strcmp (domainname, binding->domainname);
255       if (compare == 0)
256         /* We found it!  */
257         break;
258       if (compare < 0)
259         {
260           /* It is not in the list.  */
261           binding = NULL;
262           break;
263         }
264     }
265
266   if (binding == NULL)
267     dirname = (char *) _nl_default_dirname;
268   else if (binding->dirname[0] == '/')
269     dirname = binding->dirname;
270   else
271     {
272       /* We have a relative path.  Make it absolute now.  */
273       size_t dirname_len = strlen (binding->dirname) + 1;
274       size_t path_max;
275       char *ret;
276
277       path_max = (unsigned) PATH_MAX;
278       path_max += 2;            /* The getcwd docs say to do this.  */
279
280       dirname = (char *) alloca (path_max + dirname_len);
281       ADD_BLOCK (block_list, dirname);
282
283       __set_errno (0);
284       while ((ret = getcwd (dirname, path_max)) == NULL && errno == ERANGE)
285         {
286           path_max += PATH_INCR;
287           dirname = (char *) alloca (path_max + dirname_len);
288           ADD_BLOCK (block_list, dirname);
289           __set_errno (0);
290         }
291
292       if (ret == NULL)
293         {
294           /* We cannot get the current working directory.  Don't signal an
295              error but simply return the default string.  */
296           FREE_BLOCKS (block_list);
297           __set_errno (saved_errno);
298           return (char *) msgid;
299         }
300
301       stpcpy (stpcpy (strchr (dirname, '\0'), "/"), binding->dirname);
302     }
303
304   /* Now determine the symbolic name of CATEGORY and its value.  */
305   categoryname = category_to_name (category);
306   categoryvalue = guess_category_value (category, categoryname);
307
308   xdomainname = (char *) alloca (strlen (categoryname)
309                                  + strlen (domainname) + 5);
310   ADD_BLOCK (block_list, xdomainname);
311
312   stpcpy (stpcpy (stpcpy (stpcpy (xdomainname, categoryname), "/"),
313                   domainname),
314           ".mo");
315
316   /* Creating working area.  */
317   single_locale = (char *) alloca (strlen (categoryvalue) + 1);
318   ADD_BLOCK (block_list, single_locale);
319
320
321   /* Search for the given string.  This is a loop because we perhaps
322      got an ordered list of languages to consider for th translation.  */
323   while (1)
324     {
325       /* Make CATEGORYVALUE point to the next element of the list.  */
326       while (categoryvalue[0] != '\0' && categoryvalue[0] == ':')
327         ++categoryvalue;
328       if (categoryvalue[0] == '\0')
329         {
330           /* The whole contents of CATEGORYVALUE has been searched but
331              no valid entry has been found.  We solve this situation
332              by implicitly appending a "C" entry, i.e. no translation
333              will take place.  */
334           single_locale[0] = 'C';
335           single_locale[1] = '\0';
336         }
337       else
338         {
339           char *cp = single_locale;
340           while (categoryvalue[0] != '\0' && categoryvalue[0] != ':')
341             *cp++ = *categoryvalue++;
342           *cp = '\0';
343         }
344
345       /* If the current locale value is C (or POSIX) we don't load a
346          domain.  Return the MSGID.  */
347       if (strcmp (single_locale, "C") == 0
348           || strcmp (single_locale, "POSIX") == 0)
349         {
350           FREE_BLOCKS (block_list);
351           __set_errno (saved_errno);
352           return (char *) msgid;
353         }
354
355
356       /* Find structure describing the message catalog matching the
357          DOMAINNAME and CATEGORY.  */
358       domain = _nl_find_domain (dirname, single_locale, xdomainname);
359
360       if (domain != NULL)
361         {
362           retval = find_msg (domain, msgid);
363
364           if (retval == NULL)
365             {
366               int cnt;
367
368               for (cnt = 0; domain->successor[cnt] != NULL; ++cnt)
369                 {
370                   retval = find_msg (domain->successor[cnt], msgid);
371
372                   if (retval != NULL)
373                     break;
374                 }
375             }
376
377           if (retval != NULL)
378             {
379               FREE_BLOCKS (block_list);
380               __set_errno (saved_errno);
381               return retval;
382             }
383         }
384     }
385   /* NOTREACHED */
386 }
387
388 #ifdef _LIBC
389 /* Alias for function name in GNU C Library.  */
390 weak_alias (__dcgettext, dcgettext);
391 #endif
392
393
394 static char *
395 find_msg (domain_file, msgid)
396      struct loaded_l10nfile *domain_file;
397      const char *msgid;
398 {
399   size_t top, act, bottom;
400   struct loaded_domain *domain;
401
402   if (domain_file->decided == 0)
403     _nl_load_domain (domain_file);
404
405   if (domain_file->data == NULL)
406     return NULL;
407
408   domain = (struct loaded_domain *) domain_file->data;
409
410   /* Locate the MSGID and its translation.  */
411   if (domain->hash_size > 2 && domain->hash_tab != NULL)
412     {
413       /* Use the hashing table.  */
414       nls_uint32 len = strlen (msgid);
415       nls_uint32 hash_val = hash_string (msgid);
416       nls_uint32 idx = hash_val % domain->hash_size;
417       nls_uint32 incr = 1 + (hash_val % (domain->hash_size - 2));
418       nls_uint32 nstr = W (domain->must_swap, domain->hash_tab[idx]);
419
420       if (nstr == 0)
421         /* Hash table entry is empty.  */
422         return NULL;
423
424       if (W (domain->must_swap, domain->orig_tab[nstr - 1].length) == len
425           && strcmp (msgid,
426                      domain->data + W (domain->must_swap,
427                                        domain->orig_tab[nstr - 1].offset)) == 0)
428         return (char *) domain->data + W (domain->must_swap,
429                                           domain->trans_tab[nstr - 1].offset);
430
431       while (1)
432         {
433           if (idx >= domain->hash_size - incr)
434             idx -= domain->hash_size - incr;
435           else
436             idx += incr;
437
438           nstr = W (domain->must_swap, domain->hash_tab[idx]);
439           if (nstr == 0)
440             /* Hash table entry is empty.  */
441             return NULL;
442
443           if (W (domain->must_swap, domain->orig_tab[nstr - 1].length) == len
444               && strcmp (msgid,
445                          domain->data + W (domain->must_swap,
446                                            domain->orig_tab[nstr - 1].offset))
447                  == 0)
448             return (char *) domain->data
449               + W (domain->must_swap, domain->trans_tab[nstr - 1].offset);
450         }
451       /* NOTREACHED */
452     }
453
454   /* Now we try the default method:  binary search in the sorted
455      array of messages.  */
456   bottom = 0;
457   top = domain->nstrings;
458   while (bottom < top)
459     {
460       int cmp_val;
461
462       act = (bottom + top) / 2;
463       cmp_val = strcmp (msgid, domain->data
464                                + W (domain->must_swap,
465                                     domain->orig_tab[act].offset));
466       if (cmp_val < 0)
467         top = act;
468       else if (cmp_val > 0)
469         bottom = act + 1;
470       else
471         break;
472     }
473
474   /* If an translation is found return this.  */
475   return bottom >= top ? NULL : (char *) domain->data
476                                 + W (domain->must_swap,
477                                      domain->trans_tab[act].offset);
478 }
479
480
481 /* Return string representation of locale CATEGORY.  */
482 static const char *
483 category_to_name (category)
484      int category;
485 {
486   const char *retval;
487
488   switch (category)
489   {
490 #ifdef LC_COLLATE
491   case LC_COLLATE:
492     retval = "LC_COLLATE";
493     break;
494 #endif
495 #ifdef LC_CTYPE
496   case LC_CTYPE:
497     retval = "LC_CTYPE";
498     break;
499 #endif
500 #ifdef LC_MONETARY
501   case LC_MONETARY:
502     retval = "LC_MONETARY";
503     break;
504 #endif
505 #ifdef LC_NUMERIC
506   case LC_NUMERIC:
507     retval = "LC_NUMERIC";
508     break;
509 #endif
510 #ifdef LC_TIME
511   case LC_TIME:
512     retval = "LC_TIME";
513     break;
514 #endif
515 #ifdef LC_MESSAGES
516   case LC_MESSAGES:
517     retval = "LC_MESSAGES";
518     break;
519 #endif
520 #ifdef LC_RESPONSE
521   case LC_RESPONSE:
522     retval = "LC_RESPONSE";
523     break;
524 #endif
525 #ifdef LC_ALL
526   case LC_ALL:
527     /* This might not make sense but is perhaps better than any other
528        value.  */
529     retval = "LC_ALL";
530     break;
531 #endif
532   default:
533     /* If you have a better idea for a default value let me know.  */
534     retval = "LC_XXX";
535   }
536
537   return retval;
538 }
539
540 /* Guess value of current locale from value of the environment variables.  */
541 static const char *
542 guess_category_value (category, categoryname)
543      int category;
544      const char *categoryname;
545 {
546   const char *retval;
547
548   /* The highest priority value is the `LANGUAGE' environment
549      variable.  This is a GNU extension.  */
550   retval = getenv ("LANGUAGE");
551   if (retval != NULL && retval[0] != '\0')
552     return retval;
553
554   /* `LANGUAGE' is not set.  So we have to proceed with the POSIX
555      methods of looking to `LC_ALL', `LC_xxx', and `LANG'.  On some
556      systems this can be done by the `setlocale' function itself.  */
557 #if defined HAVE_SETLOCALE && defined HAVE_LC_MESSAGES && defined HAVE_LOCALE_NULL
558   return setlocale (category, NULL);
559 #else
560   /* Setting of LC_ALL overwrites all other.  */
561   retval = getenv ("LC_ALL");
562   if (retval != NULL && retval[0] != '\0')
563     return retval;
564
565   /* Next comes the name of the desired category.  */
566   retval = getenv (categoryname);
567   if (retval != NULL && retval[0] != '\0')
568     return retval;
569
570   /* Last possibility is the LANG environment variable.  */
571   retval = getenv ("LANG");
572   if (retval != NULL && retval[0] != '\0')
573     return retval;
574
575   /* We use C as the default domain.  POSIX says this is implementation
576      defined.  */
577   return "C";
578 #endif
579 }
580
581 /* @@ begin of epilog @@ */
582
583 /* We don't want libintl.a to depend on any other library.  So we
584    avoid the non-standard function stpcpy.  In GNU C Library this
585    function is available, though.  Also allow the symbol HAVE_STPCPY
586    to be defined.  */
587 #if !_LIBC && !HAVE_STPCPY
588 static char *
589 stpcpy (dest, src)
590      char *dest;
591      const char *src;
592 {
593   while ((*dest++ = *src++) != '\0')
594     /* Do nothing. */ ;
595   return dest - 1;
596 }
597 #endif