New file localcharset.h.
[gnulib.git] / lib / localcharset.c
1 /* Determine a canonical name for the current locale's character encoding.
2
3    Copyright (C) 2000-2002 Free Software Foundation, Inc.
4
5    This program is free software; you can redistribute it and/or modify it
6    under the terms of the GNU Library General Public License as published
7    by the Free Software Foundation; either version 2, or (at your option)
8    any later version.
9
10    This program 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 this program; if not, write to the Free Software
17    Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
18    USA.  */
19
20 /* Written by Bruno Haible <bruno@clisp.org>.  */
21
22 #ifdef HAVE_CONFIG_H
23 # include <config.h>
24 #endif
25
26 /* Specification.  */
27 #include "localcharset.h"
28
29 #if HAVE_STDDEF_H
30 # include <stddef.h>
31 #endif
32
33 #include <stdio.h>
34 #if HAVE_STRING_H
35 # include <string.h>
36 #else
37 # include <strings.h>
38 #endif
39 #if HAVE_STDLIB_H
40 # include <stdlib.h>
41 #endif
42
43 #if defined _WIN32 || defined __WIN32__
44 # undef WIN32   /* avoid warning on mingw32 */
45 # define WIN32
46 #endif
47
48 #if defined __EMX__
49 /* Assume EMX program runs on OS/2, even if compiled under DOS.  */
50 # define OS2
51 #endif
52
53 #if !defined WIN32
54 # if HAVE_LANGINFO_CODESET
55 #  include <langinfo.h>
56 # else
57 #  if HAVE_SETLOCALE
58 #   include <locale.h>
59 #  endif
60 # endif
61 #elif defined WIN32
62 # define WIN32_LEAN_AND_MEAN
63 # include <windows.h>
64 #endif
65 #if defined OS2
66 # define INCL_DOS
67 # include <os2.h>
68 #endif
69
70 #if defined _WIN32 || defined __WIN32__ || defined __EMX__ || defined __DJGPP__
71   /* Win32, OS/2, DOS */
72 # define ISSLASH(C) ((C) == '/' || (C) == '\\')
73 #endif
74
75 #ifndef DIRECTORY_SEPARATOR
76 # define DIRECTORY_SEPARATOR '/'
77 #endif
78
79 #ifndef ISSLASH
80 # define ISSLASH(C) ((C) == DIRECTORY_SEPARATOR)
81 #endif
82
83 #ifdef HAVE_GETC_UNLOCKED
84 # undef getc
85 # define getc getc_unlocked
86 #endif
87
88 #ifdef __cplusplus
89 /* When compiling with "gcc -x c++", produce a function with C linkage.  */
90 extern "C" const char * locale_charset (void);
91 #endif
92
93 /* The following static variable is declared 'volatile' to avoid a
94    possible multithread problem in the function get_charset_aliases. If we
95    are running in a threaded environment, and if two threads initialize
96    'charset_aliases' simultaneously, both will produce the same value,
97    and everything will be ok if the two assignments to 'charset_aliases'
98    are atomic. But I don't know what will happen if the two assignments mix.  */
99 #if __STDC__ != 1
100 # define volatile /* empty */
101 #endif
102 /* Pointer to the contents of the charset.alias file, if it has already been
103    read, else NULL.  Its format is:
104    ALIAS_1 '\0' CANONICAL_1 '\0' ... ALIAS_n '\0' CANONICAL_n '\0' '\0'  */
105 static const char * volatile charset_aliases;
106
107 /* Return a pointer to the contents of the charset.alias file.  */
108 static const char *
109 get_charset_aliases ()
110 {
111   const char *cp;
112
113   cp = charset_aliases;
114   if (cp == NULL)
115     {
116 #if !defined WIN32
117       FILE *fp;
118       const char *dir = LIBDIR;
119       const char *base = "charset.alias";
120       char *file_name;
121
122       /* Concatenate dir and base into freshly allocated file_name.  */
123       {
124         size_t dir_len = strlen (dir);
125         size_t base_len = strlen (base);
126         int add_slash = (dir_len > 0 && !ISSLASH (dir[dir_len - 1]));
127         file_name = (char *) malloc (dir_len + add_slash + base_len + 1);
128         if (file_name != NULL)
129           {
130             memcpy (file_name, dir, dir_len);
131             if (add_slash)
132               file_name[dir_len] = DIRECTORY_SEPARATOR;
133             memcpy (file_name + dir_len + add_slash, base, base_len + 1);
134           }
135       }
136
137       if (file_name == NULL || (fp = fopen (file_name, "r")) == NULL)
138         /* Out of memory or file not found, treat it as empty.  */
139         cp = "";
140       else
141         {
142           /* Parse the file's contents.  */
143           int c;
144           char buf1[50+1];
145           char buf2[50+1];
146           char *res_ptr = NULL;
147           size_t res_size = 0;
148           size_t l1, l2;
149
150           for (;;)
151             {
152               c = getc (fp);
153               if (c == EOF)
154                 break;
155               if (c == '\n' || c == ' ' || c == '\t')
156                 continue;
157               if (c == '#')
158                 {
159                   /* Skip comment, to end of line.  */
160                   do
161                     c = getc (fp);
162                   while (!(c == EOF || c == '\n'));
163                   if (c == EOF)
164                     break;
165                   continue;
166                 }
167               ungetc (c, fp);
168               if (fscanf (fp, "%50s %50s", buf1, buf2) < 2)
169                 break;
170               l1 = strlen (buf1);
171               l2 = strlen (buf2);
172               if (res_size == 0)
173                 {
174                   res_size = l1 + 1 + l2 + 1;
175                   res_ptr = (char *) malloc (res_size + 1);
176                 }
177               else
178                 {
179                   res_size += l1 + 1 + l2 + 1;
180                   res_ptr = (char *) realloc (res_ptr, res_size + 1);
181                 }
182               if (res_ptr == NULL)
183                 {
184                   /* Out of memory. */
185                   res_size = 0;
186                   break;
187                 }
188               strcpy (res_ptr + res_size - (l2 + 1) - (l1 + 1), buf1);
189               strcpy (res_ptr + res_size - (l2 + 1), buf2);
190             }
191           fclose (fp);
192           if (res_size == 0)
193             cp = "";
194           else
195             {
196               *(res_ptr + res_size) = '\0';
197               cp = res_ptr;
198             }
199         }
200
201       if (file_name != NULL)
202         free (file_name);
203
204 #else
205
206       /* To avoid the troubles of installing a separate file in the same
207          directory as the DLL and of retrieving the DLL's directory at
208          runtime, simply inline the aliases here.  */
209
210 # if defined WIN32
211       cp = "CP936" "\0" "GBK" "\0"
212            "CP1361" "\0" "JOHAB" "\0"
213            "CP20127" "\0" "ASCII" "\0"
214            "CP20866" "\0" "KOI8-R" "\0"
215            "CP21866" "\0" "KOI8-RU" "\0"
216            "CP28591" "\0" "ISO-8859-1" "\0"
217            "CP28592" "\0" "ISO-8859-2" "\0"
218            "CP28593" "\0" "ISO-8859-3" "\0"
219            "CP28594" "\0" "ISO-8859-4" "\0"
220            "CP28595" "\0" "ISO-8859-5" "\0"
221            "CP28596" "\0" "ISO-8859-6" "\0"
222            "CP28597" "\0" "ISO-8859-7" "\0"
223            "CP28598" "\0" "ISO-8859-8" "\0"
224            "CP28599" "\0" "ISO-8859-9" "\0"
225            "CP28605" "\0" "ISO-8859-15" "\0";
226 # endif
227 #endif
228
229       charset_aliases = cp;
230     }
231
232   return cp;
233 }
234
235 /* Determine the current locale's character encoding, and canonicalize it
236    into one of the canonical names listed in config.charset.
237    The result must not be freed; it is statically allocated.
238    If the canonical name cannot be determined, the result is a non-canonical
239    name.  */
240
241 #ifdef STATIC
242 STATIC
243 #endif
244 const char *
245 locale_charset ()
246 {
247   const char *codeset;
248   const char *aliases;
249
250 #if !(defined WIN32 || defined OS2)
251
252 # if HAVE_LANGINFO_CODESET
253
254   /* Most systems support nl_langinfo (CODESET) nowadays.  */
255   codeset = nl_langinfo (CODESET);
256
257 # else
258
259   /* On old systems which lack it, use setlocale or getenv.  */
260   const char *locale = NULL;
261
262   /* But most old systems don't have a complete set of locales.  Some
263      (like SunOS 4 or DJGPP) have only the C locale.  Therefore we don't
264      use setlocale here; it would return "C" when it doesn't support the
265      locale name the user has set.  */
266 #  if HAVE_SETLOCALE && 0
267   locale = setlocale (LC_CTYPE, NULL);
268 #  endif
269   if (locale == NULL || locale[0] == '\0')
270     {
271       locale = getenv ("LC_ALL");
272       if (locale == NULL || locale[0] == '\0')
273         {
274           locale = getenv ("LC_CTYPE");
275           if (locale == NULL || locale[0] == '\0')
276             locale = getenv ("LANG");
277         }
278     }
279
280   /* On some old systems, one used to set locale = "iso8859_1". On others,
281      you set it to "language_COUNTRY.charset". In any case, we resolve it
282      through the charset.alias file.  */
283   codeset = locale;
284
285 # endif
286
287 #elif defined WIN32
288
289   static char buf[2 + 10 + 1];
290
291   /* Woe32 has a function returning the locale's codepage as a number.  */
292   sprintf (buf, "CP%u", GetACP ());
293   codeset = buf;
294
295 #elif defined OS2
296
297   const char *locale;
298   static char buf[2 + 10 + 1];
299   ULONG cp[3];
300   ULONG cplen;
301
302   /* Allow user to override the codeset, as set in the operating system,
303      with standard language environment variables.  */
304   locale = getenv ("LC_ALL");
305   if (locale == NULL || locale[0] == '\0')
306     {
307       locale = getenv ("LC_CTYPE");
308       if (locale == NULL || locale[0] == '\0')
309         locale = getenv ("LANG");
310     }
311   if (locale != NULL && locale[0] != '\0')
312     {
313       /* If the locale name contains an encoding after the dot, return it.  */
314       const char *dot = strchr (locale, '.');
315
316       if (dot != NULL)
317         {
318           const char *modifier;
319
320           dot++;
321           /* Look for the possible @... trailer and remove it, if any.  */
322           modifier = strchr (dot, '@');
323           if (modifier == NULL)
324             return dot;
325           if (modifier - dot < sizeof (buf))
326             {
327               memcpy (buf, dot, modifier - dot);
328               buf [modifier - dot] = '\0';
329               return buf;
330             }
331         }
332
333       /* Resolve through the charset.alias file.  */
334       codeset = locale;
335     }
336   else
337     {
338       /* OS/2 has a function returning the locale's codepage as a number.  */
339       if (DosQueryCp (sizeof (cp), cp, &cplen))
340         codeset = "";
341       else
342         {
343           sprintf (buf, "CP%u", cp[0]);
344           codeset = buf;
345         }
346     }
347
348 #endif
349
350   if (codeset == NULL)
351     /* The canonical name cannot be determined.  */
352     codeset = "";
353
354   /* Resolve alias. */
355   for (aliases = get_charset_aliases ();
356        *aliases != '\0';
357        aliases += strlen (aliases) + 1, aliases += strlen (aliases) + 1)
358     if (strcmp (codeset, aliases) == 0
359         || (aliases[0] == '*' && aliases[1] == '\0'))
360       {
361         codeset = aliases + strlen (aliases) + 1;
362         break;
363       }
364
365   /* Don't return an empty string.  GNU libc and GNU libiconv interpret
366      the empty string as denoting "the locale's character encoding",
367      thus GNU libiconv would call this function a second time.  */
368   if (codeset[0] == '\0')
369     codeset = "ASCII";
370
371   return codeset;
372 }