c0f453cd9410fc2f64eb355c8de843514493eaf0
[kopensolaris-gnu/glibc.git] / locale / setlocale.c
1 /* Copyright (C) 1991, 92, 95, 96, 97, 98, 99 Free Software Foundation, Inc.
2    This file is part of the GNU C Library.
3
4    The GNU C Library is free software; you can redistribute it and/or
5    modify it under the terms of the GNU Library General Public License as
6    published by the Free Software Foundation; either version 2 of the
7    License, or (at your option) any later version.
8
9    The GNU C Library is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12    Library General Public License for more details.
13
14    You should have received a copy of the GNU Library General Public
15    License along with the GNU C Library; see the file COPYING.LIB.  If not,
16    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17    Boston, MA 02111-1307, USA.  */
18
19 #include <alloca.h>
20 #include <argz.h>
21 #include <errno.h>
22 #include <bits/libc-lock.h>
23 #include <locale.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <unistd.h>
27
28 #include "localeinfo.h"
29
30 /* For each category declare two external variables (with weak references):
31      extern const struct locale_data *_nl_current_CATEGORY;
32    This points to the current locale's in-core data for CATEGORY.
33      extern const struct locale_data _nl_C_CATEGORY;
34    This contains the built-in "C"/"POSIX" locale's data for CATEGORY.
35    Both are weak references; if &_nl_current_CATEGORY is zero,
36    then nothing is using the locale data.  */
37 #define DEFINE_CATEGORY(category, category_name, items, a) \
38 extern struct locale_data *_nl_current_##category;                            \
39 extern struct locale_data _nl_C_##category;
40 #include "categories.def"
41 #undef  DEFINE_CATEGORY
42
43 /* Array indexed by category of pointers to _nl_current_CATEGORY slots.
44    Elements are zero for categories whose data is never used.  */
45 struct locale_data * *const _nl_current[] =
46   {
47 #define DEFINE_CATEGORY(category, category_name, items, a) \
48     [category] = &_nl_current_##category,
49 #include "categories.def"
50 #undef  DEFINE_CATEGORY
51     /* We need this additional element to simplify the code.  It must
52        simply be != NULL.  */
53     [LC_ALL] = (struct locale_data **) ~0ul
54   };
55
56 /* Array indexed by category of pointers to _nl_C_CATEGORY slots.
57    Elements are zero for categories whose data is never used.  */
58 struct locale_data *const _nl_C[] =
59   {
60 #define DEFINE_CATEGORY(category, category_name, items, a) \
61     [category] = &_nl_C_##category,
62 #include "categories.def"
63 #undef  DEFINE_CATEGORY
64   };
65
66
67 /* Define an array of category names (also the environment variable names),
68    indexed by integral category.  */
69 const char *const _nl_category_names[] =
70   {
71 #define DEFINE_CATEGORY(category, category_name, items, a) \
72     [category] = category_name,
73 #include "categories.def"
74 #undef  DEFINE_CATEGORY
75     [LC_ALL] = "LC_ALL"
76   };
77 /* An array of their lengths, for convenience.  */
78 const size_t _nl_category_name_sizes[] =
79   {
80 #define DEFINE_CATEGORY(category, category_name, items, a) \
81     [category] = sizeof (category_name) - 1,
82 #include "categories.def"
83 #undef  DEFINE_CATEGORY
84     [LC_ALL] = sizeof ("LC_ALL") - 1
85   };
86
87
88 /* Declare the postload functions used below.  */
89 #undef  NO_POSTLOAD
90 #define NO_POSTLOAD _nl_postload_ctype /* Harmless thing known to exist.  */
91 #define DEFINE_CATEGORY(category, category_name, items, postload) \
92 extern void postload (void);
93 #include "categories.def"
94 #undef  DEFINE_CATEGORY
95 #undef  NO_POSTLOAD
96
97 /* Define an array indexed by category of postload functions to call after
98    loading and installing that category's data.  */
99 static void (*const _nl_category_postload[]) (void) =
100   {
101 #define DEFINE_CATEGORY(category, category_name, items, postload) \
102     [category] = postload,
103 #include "categories.def"
104 #undef  DEFINE_CATEGORY
105   };
106
107
108 /* Name of current locale for each individual category.
109    Each is malloc'd unless it is nl_C_name.  */
110 static const char *_nl_current_names[] =
111   {
112 #define DEFINE_CATEGORY(category, category_name, items, a) \
113     [category] = _nl_C_name,
114 #include "categories.def"
115 #undef  DEFINE_CATEGORY
116     [LC_ALL] = _nl_C_name               /* For LC_ALL.  */
117   };
118
119
120 /* Lock for protecting global data.  */
121 __libc_lock_define_initialized (, __libc_setlocale_lock)
122
123
124 /* Use this when we come along an error.  */
125 #define ERROR_RETURN                                                          \
126   do {                                                                        \
127     __set_errno (EINVAL);                                                     \
128     return NULL;                                                              \
129   } while (0)
130
131
132 /* Construct a new composite name.  */
133 static inline char *
134 new_composite_name (int category, const char *newnames[__LC_LAST])
135 {
136   size_t last_len = 0;
137   size_t cumlen = 0;
138   int i;
139   char *new, *p;
140   int same = 1;
141
142   for (i = 0; i < __LC_LAST; ++i)
143     if (i != LC_ALL)
144       {
145         const char *name = (category == LC_ALL ? newnames[i] :
146                             category == i ? newnames[0] :
147                             _nl_current_names[i]);
148         last_len = strlen (name);
149         cumlen += _nl_category_name_sizes[i] + 1 + last_len + 1;
150         if (i > 0 && same && strcmp (name, newnames[0]) != 0)
151           same = 0;
152       }
153
154   if (same)
155     {
156       /* All the categories use the same name.  */
157       if (strcmp (newnames[0], "C") == 0
158           || strcmp (newnames[0], "POSIX") == 0)
159         return (char *) _nl_C_name;
160
161       new = malloc (last_len + 1);
162
163       return new == NULL ? NULL : memcpy (new, newnames[0], last_len + 1);
164     }
165
166   new = malloc (cumlen);
167   if (new == NULL)
168     return NULL;
169   p = new;
170   for (i = 0; i < __LC_LAST; ++i)
171     if (i != LC_ALL)
172       {
173         /* Add "CATEGORY=NAME;" to the string.  */
174         const char *name = (category == LC_ALL ? newnames[i] :
175                             category == i ? newnames[0] :
176                             _nl_current_names[i]);
177         p = __stpcpy (p, _nl_category_names[i]);
178         *p++ = '=';
179         p = __stpcpy (p, name);
180         *p++ = ';';
181       }
182   p[-1] = '\0';         /* Clobber the last ';'.  */
183   return new;
184 }
185
186
187 /* Put NAME in _nl_current_names.  */
188 static inline void
189 setname (int category, const char *name)
190 {
191   if (_nl_current_names[category] == name)
192     return;
193
194   if (category == LC_ALL && _nl_current_names[category] != _nl_C_name)
195     free ((char *) _nl_current_names[category]);
196
197   _nl_current_names[category] = name;
198 }
199
200
201 /* Put DATA in *_nl_current[CATEGORY].  */
202 static inline void
203 setdata (int category, struct locale_data *data)
204 {
205   if (_nl_current[category] != NULL)
206     {
207       *_nl_current[category] = data;
208       if (_nl_category_postload[category])
209         (*_nl_category_postload[category]) ();
210     }
211 }
212
213
214 char *
215 setlocale (int category, const char *locale)
216 {
217   char *locale_path;
218   size_t locale_path_len;
219   const char *locpath_var;
220   char *composite;
221
222   /* Sanity check for CATEGORY argument.  */
223   if (category < 0 || category >= __LC_LAST)
224     ERROR_RETURN;
225
226   /* Does user want name of current locale?  */
227   if (locale == NULL)
228     return (char *) _nl_current_names[category];
229
230   if (strcmp (locale, _nl_current_names[category]) == 0)
231     /* Changing to the same thing.  */
232     return (char *) _nl_current_names[category];
233
234   /* We perhaps really have to load some data.  So we determine the
235      path in which to look for the data now.  The environment variable
236      `LOCPATH' must only be used when the binary has no SUID or SGID
237      bit set.  */
238   locale_path = NULL;
239   locale_path_len = 0;
240
241   locpath_var = __secure_getenv ("LOCPATH");
242   if (locpath_var != NULL && locpath_var[0] != '\0')
243     if (__argz_create_sep (locpath_var, ':',
244                            &locale_path, &locale_path_len) != 0)
245       return NULL;
246
247   if (__argz_add_sep (&locale_path, &locale_path_len, LOCALE_PATH, ':') != 0)
248     return NULL;
249
250   if (category == LC_ALL)
251     {
252       /* The user wants to set all categories.  The desired locales
253          for the individual categories can be selected by using a
254          composite locale name.  This is a semi-colon separated list
255          of entries of the form `CATEGORY=VALUE'.  */
256       const char *newnames[__LC_LAST];
257       struct locale_data *newdata[__LC_LAST];
258
259       /* Set all name pointers to the argument name.  */
260       for (category = 0; category < __LC_LAST; ++category)
261         if (category != LC_ALL)
262           newnames[category] = (char *) locale;
263
264       if (strchr (locale, ';') != NULL)
265         {
266           /* This is a composite name.  Make a copy and split it up.  */
267           char *np = strdupa (locale);
268           char *cp;
269           int cnt;
270
271           while ((cp = strchr (np, '=')) != NULL)
272             {
273               for (cnt = 0; cnt < __LC_LAST; ++cnt)
274                 if (cnt != LC_ALL
275                     && (size_t) (cp - np) == _nl_category_name_sizes[cnt]
276                     && memcmp (np, _nl_category_names[cnt], cp - np) == 0)
277                   break;
278
279               if (cnt == __LC_LAST)
280                 /* Bogus category name.  */
281                 ERROR_RETURN;
282
283               /* Found the category this clause sets.  */
284               newnames[cnt] = ++cp;
285               cp = strchr (cp, ';');
286               if (cp != NULL)
287                 {
288                   /* Examine the next clause.  */
289                   *cp = '\0';
290                   np = cp + 1;
291                 }
292               else
293                 /* This was the last clause.  We are done.  */
294                 break;
295             }
296
297           for (cnt = 0; cnt < __LC_LAST; ++cnt)
298             if (cnt != LC_ALL && newnames[cnt] == locale)
299               /* The composite name did not specify all categories.  */
300               ERROR_RETURN;
301         }
302
303       /* Protect global data.  */
304       __libc_lock_lock (__libc_setlocale_lock);
305
306       /* Load the new data for each category.  */
307       while (category-- > 0)
308         {
309           /* XXX hack.  Remove when collation works.  */
310           if (category == LC_COLLATE)
311             {
312               newdata[category] = NULL;
313               continue;
314             }
315
316           newdata[category] = _nl_find_locale (locale_path, locale_path_len,
317                                                category,
318                                                &newnames[category]);
319
320           if (newdata[category] == NULL)
321             break;
322
323           /* We must not simply free a global locale since we have no
324              control over the usage.  So we mark it as un-deletable.  */
325           if (newdata[category]->usage_count != UNDELETABLE)
326             newdata[category]->usage_count = UNDELETABLE;
327         }
328
329       /* Create new composite name.  */
330       composite = (category >= 0
331                    ? NULL : new_composite_name (LC_ALL, newnames));
332       if (composite != NULL)
333         {
334           /* Now we have loaded all the new data.  Put it in place.  */
335           for (category = 0; category < __LC_LAST; ++category)
336             if (category != LC_ALL)
337               {
338                 setdata (category, newdata[category]);
339                 setname (category, newnames[category]);
340               }
341           setname (LC_ALL, composite);
342         }
343
344       /* Critical section left.  */
345       __libc_lock_unlock (__libc_setlocale_lock);
346
347       /* Free the resources (the locale path variable.  */
348       free (locale_path);
349
350       return composite;
351     }
352   else if (category == LC_COLLATE)
353     {
354       /* XXX Remove when LC_COLLATE works.  */
355       return NULL;
356     }
357   else
358     {
359       struct locale_data *newdata = NULL;
360       const char *newname[1] = { locale };
361
362       /* Protect global data.  */
363       __libc_lock_lock (__libc_setlocale_lock);
364
365       if (_nl_current[category] != NULL)
366         {
367           /* Only actually load the data if anything will use it.  */
368           newdata = _nl_find_locale (locale_path, locale_path_len, category,
369                                      &newname[0]);
370           if (newdata == NULL)
371             goto abort_single;
372
373           /* We must not simply free a global locale since we have no
374              control over the usage.  So we mark it as un-deletable.
375
376              Note: do not remove the `if', it's necessary to copy with
377              the builtin locale data.  */
378           if (newdata->usage_count != UNDELETABLE)
379             newdata->usage_count = UNDELETABLE;
380         }
381
382       /* Create new composite name.  */
383       composite = new_composite_name (category, newname);
384       if (composite == NULL)
385         {
386           /* Say that we don't have any data loaded.  */
387         abort_single:
388           newname[0] = NULL;
389         }
390       else
391         {
392           if (_nl_current[category] != NULL)
393             setdata (category, newdata);
394
395           setname (category, newname[0]);
396           setname (LC_ALL, composite);
397         }
398
399       /* Critical section left.  */
400       __libc_lock_unlock (__libc_setlocale_lock);
401
402       /* Free the resources (the locale path variable.  */
403       free (locale_path);
404
405       return (char *) newname[0];
406     }
407 }
408
409
410 static void __attribute__ ((unused))
411 free_mem (void)
412 {
413   int category;
414
415   for (category = 0; category < __LC_LAST; ++category)
416     if (category != LC_ALL)
417       {
418         struct locale_data *here = *_nl_current[category];
419
420         /* If this category is already "C" don't do anything.  */
421         if (here == _nl_C[category])
422           continue;
423
424         /* We have to be prepared that sometime later me still might
425            need the locale information.  */
426         setdata (category, _nl_C[category]);
427         setname (category, _nl_C_name);
428
429         _nl_unload_locale (here);
430       }
431
432   setname (LC_ALL, _nl_C_name);
433 }
434 text_set_element (__libc_subfreeres, free_mem);